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