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