git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/btree_gc.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _BCACHEFS_BTREE_GC_H
   3 #define _BCACHEFS_BTREE_GC_H
   4
   5 #include "btree_types.h"
   6
   7 int bch2_check_topology(struct bch_fs *);
   8 int bch2_gc(struct bch_fs *, bool, bool);
   9 int bch2_gc_gens(struct bch_fs *);
  10 void bch2_gc_thread_stop(struct bch_fs *);
  11 int bch2_gc_thread_start(struct bch_fs *);
  12
  13 /*
  14  * For concurrent mark and sweep (with other index updates), we define a total
  15  * ordering of _all_ references GC walks:
  16  *
  17  * Note that some references will have the same GC position as others - e.g.
  18  * everything within the same btree node; in those cases we're relying on
  19  * whatever locking exists for where those references live, i.e. the write lock
  20  * on a btree node.
  21  *
  22  * That locking is also required to ensure GC doesn't pass the updater in
  23  * between the updater adding/removing the reference and updating the GC marks;
  24  * without that, we would at best double count sometimes.
  25  *
  26  * That part is important - whenever calling bch2_mark_pointers(), a lock _must_
  27  * be held that prevents GC from passing the position the updater is at.
  28  *
  29  * (What about the start of gc, when we're clearing all the marks? GC clears the
  30  * mark with the gc pos seqlock held, and bch_mark_bucket checks against the gc
  31  * position inside its cmpxchg loop, so crap magically works).
  32  */
  33
  34 /* Position of (the start of) a gc phase: */
  35 static inline struct gc_pos gc_phase(enum gc_phase phase)
  36 {
  37         return (struct gc_pos) {
  38                 .phase  = phase,
  39                 .pos    = POS_MIN,
  40                 .level  = 0,
  41         };
  42 }
  43
  44 static inline int gc_pos_cmp(struct gc_pos l, struct gc_pos r)
  45 {
  46         return  cmp_int(l.phase, r.phase) ?:
  47                 bpos_cmp(l.pos, r.pos) ?:
  48                 cmp_int(l.level, r.level);
  49 }
  50
  51 static inline enum gc_phase btree_id_to_gc_phase(enum btree_id id)
  52 {
  53         switch (id) {
  54 #define x(name, v, ...) case BTREE_ID_##name: return GC_PHASE_BTREE_##name;
  55         BCH_BTREE_IDS()
  56 #undef x
  57         default:
  58                 BUG();
  59         }
  60 }
  61
  62 static inline struct gc_pos gc_pos_btree(enum btree_id id,
  63                                          struct bpos pos, unsigned level)
  64 {
  65         return (struct gc_pos) {
  66                 .phase  = btree_id_to_gc_phase(id),
  67                 .pos    = pos,
  68                 .level  = level,
  69         };
  70 }
  71
  72 /*
  73  * GC position of the pointers within a btree node: note, _not_ for &b->key
  74  * itself, that lives in the parent node:
  75  */
  76 static inline struct gc_pos gc_pos_btree_node(struct btree *b)
  77 {
  78         return gc_pos_btree(b->c.btree_id, b->key.k.p, b->c.level);
  79 }
  80
  81 /*
  82  * GC position of the pointer to a btree root: we don't use
  83  * gc_pos_pointer_to_btree_node() here to avoid a potential race with
  84  * btree_split() increasing the tree depth - the new root will have level > the
  85  * old root and thus have a greater gc position than the old root, but that
  86  * would be incorrect since once gc has marked the root it's not coming back.
  87  */
  88 static inline struct gc_pos gc_pos_btree_root(enum btree_id id)
  89 {
  90         return gc_pos_btree(id, SPOS_MAX, BTREE_MAX_DEPTH);
  91 }
  92
  93 static inline bool gc_visited(struct bch_fs *c, struct gc_pos pos)
  94 {
  95         unsigned seq;
  96         bool ret;
  97
  98         do {
  99                 seq = read_seqcount_begin(&c->gc_pos_lock);
 100                 ret = gc_pos_cmp(pos, c->gc_pos) <= 0;
 101         } while (read_seqcount_retry(&c->gc_pos_lock, seq));
 102
 103         return ret;
 104 }
 105
 106 static inline void bch2_do_gc_gens(struct bch_fs *c)
 107 {
 108         atomic_inc(&c->kick_gc);
 109         if (c->gc_thread)
 110                 wake_up_process(c->gc_thread);
 111 }
 112
 113 #endif /* _BCACHEFS_BTREE_GC_H */