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