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

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