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

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Code for manipulating bucket marks for garbage collection.
   4  *
   5  * Copyright 2014 Datera, Inc.
   6  */
   7
   8 #ifndef _BUCKETS_H
   9 #define _BUCKETS_H
  10
  11 #include "buckets_types.h"
  12 #include "super.h"
  13
  14 #define for_each_bucket(_b, _buckets)                           \
  15         for (_b = (_buckets)->b + (_buckets)->first_bucket;     \
  16              _b < (_buckets)->b + (_buckets)->nbuckets; _b++)
  17
  18 #define bucket_cmpxchg(g, new, expr)                            \
  19 ({                                                              \
  20         struct bucket *_g = g;                                  \
  21         u64 _v = atomic64_read(&(g)->_mark.v);                  \
  22         struct bucket_mark _old;                                \
  23                                                                 \
  24         do {                                                    \
  25                 (new).v.counter = _old.v.counter = _v;          \
  26                 expr;                                           \
  27         } while ((_v = atomic64_cmpxchg(&(_g)->_mark.v,         \
  28                                _old.v.counter,                  \
  29                                (new).v.counter)) != _old.v.counter);\
  30         _old;                                                   \
  31 })
  32
  33 static inline struct bucket_array *__bucket_array(struct bch_dev *ca,
  34                                                   bool gc)
  35 {
  36         return rcu_dereference_check(ca->buckets[gc],
  37                                      !ca->fs ||
  38                                      percpu_rwsem_is_held(&ca->fs->mark_lock) ||
  39                                      lockdep_is_held(&ca->fs->gc_lock) ||
  40                                      lockdep_is_held(&ca->bucket_lock));
  41 }
  42
  43 static inline struct bucket_array *bucket_array(struct bch_dev *ca)
  44 {
  45         return __bucket_array(ca, false);
  46 }
  47
  48 static inline struct bucket *__bucket(struct bch_dev *ca, size_t b, bool gc)
  49 {
  50         struct bucket_array *buckets = __bucket_array(ca, gc);
  51
  52         BUG_ON(b < buckets->first_bucket || b >= buckets->nbuckets);
  53         return buckets->b + b;
  54 }
  55
  56 static inline struct bucket *bucket(struct bch_dev *ca, size_t b)
  57 {
  58         return __bucket(ca, b, false);
  59 }
  60
  61 /*
  62  * bucket_gc_gen() returns the difference between the bucket's current gen and
  63  * the oldest gen of any pointer into that bucket in the btree.
  64  */
  65
  66 static inline u8 bucket_gc_gen(struct bucket *g)
  67 {
  68         return g->mark.gen - g->oldest_gen;
  69 }
  70
  71 static inline size_t PTR_BUCKET_NR(const struct bch_dev *ca,
  72                                    const struct bch_extent_ptr *ptr)
  73 {
  74         return sector_to_bucket(ca, ptr->offset);
  75 }
  76
  77 static inline struct bucket *PTR_BUCKET(struct bch_dev *ca,
  78                                         const struct bch_extent_ptr *ptr,
  79                                         bool gc)
  80 {
  81         return __bucket(ca, PTR_BUCKET_NR(ca, ptr), gc);
  82 }
  83
  84 static inline enum bch_data_type ptr_data_type(const struct bkey *k,
  85                                                const struct bch_extent_ptr *ptr)
  86 {
  87         if (k->type == KEY_TYPE_btree_ptr ||
  88             k->type == KEY_TYPE_btree_ptr_v2)
  89                 return BCH_DATA_btree;
  90
  91         return ptr->cached ? BCH_DATA_cached : BCH_DATA_user;
  92 }
  93
  94 static inline struct bucket_mark ptr_bucket_mark(struct bch_dev *ca,
  95                                                  const struct bch_extent_ptr *ptr)
  96 {
  97         struct bucket_mark m;
  98
  99         rcu_read_lock();
 100         m = READ_ONCE(PTR_BUCKET(ca, ptr, 0)->mark);
 101         rcu_read_unlock();
 102
 103         return m;
 104 }
 105
 106 static inline int gen_cmp(u8 a, u8 b)
 107 {
 108         return (s8) (a - b);
 109 }
 110
 111 static inline int gen_after(u8 a, u8 b)
 112 {
 113         int r = gen_cmp(a, b);
 114
 115         return r > 0 ? r : 0;
 116 }
 117
 118 /**
 119  * ptr_stale() - check if a pointer points into a bucket that has been
 120  * invalidated.
 121  */
 122 static inline u8 ptr_stale(struct bch_dev *ca,
 123                            const struct bch_extent_ptr *ptr)
 124 {
 125         return gen_after(ptr_bucket_mark(ca, ptr).gen, ptr->gen);
 126 }
 127
 128 /* bucket gc marks */
 129
 130 static inline unsigned bucket_sectors_used(struct bucket_mark mark)
 131 {
 132         return mark.dirty_sectors + mark.cached_sectors;
 133 }
 134
 135 static inline bool is_available_bucket(struct bucket_mark mark)
 136 {
 137         return !mark.dirty_sectors && !mark.stripe;
 138 }
 139
 140 static inline bool bucket_needs_journal_commit(struct bucket_mark m,
 141                                                u16 last_seq_ondisk)
 142 {
 143         return m.journal_seq_valid &&
 144                 ((s16) m.journal_seq - (s16) last_seq_ondisk > 0);
 145 }
 146
 147 /* Device usage: */
 148
 149 struct bch_dev_usage bch2_dev_usage_read(struct bch_dev *);
 150
 151 static inline u64 __dev_buckets_available(struct bch_dev *ca,
 152                                           struct bch_dev_usage stats)
 153 {
 154         u64 total = ca->mi.nbuckets - ca->mi.first_bucket;
 155
 156         if (WARN_ONCE(stats.buckets_unavailable > total,
 157                       "buckets_unavailable overflow (%llu > %llu)\n",
 158                       stats.buckets_unavailable, total))
 159                 return 0;
 160
 161         return total - stats.buckets_unavailable;
 162 }
 163
 164 static inline u64 dev_buckets_available(struct bch_dev *ca)
 165 {
 166         return __dev_buckets_available(ca, bch2_dev_usage_read(ca));
 167 }
 168
 169 static inline u64 __dev_buckets_reclaimable(struct bch_dev *ca,
 170                                             struct bch_dev_usage stats)
 171 {
 172         struct bch_fs *c = ca->fs;
 173         s64 available = __dev_buckets_available(ca, stats);
 174         unsigned i;
 175
 176         spin_lock(&c->freelist_lock);
 177         for (i = 0; i < RESERVE_NR; i++)
 178                 available -= fifo_used(&ca->free[i]);
 179         available -= fifo_used(&ca->free_inc);
 180         available -= ca->nr_open_buckets;
 181         spin_unlock(&c->freelist_lock);
 182
 183         return max(available, 0LL);
 184 }
 185
 186 static inline u64 dev_buckets_reclaimable(struct bch_dev *ca)
 187 {
 188         return __dev_buckets_reclaimable(ca, bch2_dev_usage_read(ca));
 189 }
 190
 191 /* Filesystem usage: */
 192
 193 static inline unsigned fs_usage_u64s(struct bch_fs *c)
 194 {
 195
 196         return sizeof(struct bch_fs_usage) / sizeof(u64) +
 197                 READ_ONCE(c->replicas.nr);
 198 }
 199
 200 static inline unsigned dev_usage_u64s(void)
 201 {
 202         return sizeof(struct bch_dev_usage) / sizeof(u64);
 203 }
 204
 205 u64 bch2_fs_usage_read_one(struct bch_fs *, u64 *);
 206
 207 struct bch_fs_usage_online *bch2_fs_usage_read(struct bch_fs *);
 208
 209 void bch2_fs_usage_acc_to_base(struct bch_fs *, unsigned);
 210
 211 void bch2_fs_usage_to_text(struct printbuf *,
 212                            struct bch_fs *, struct bch_fs_usage_online *);
 213
 214 u64 bch2_fs_sectors_used(struct bch_fs *, struct bch_fs_usage_online *);
 215
 216 struct bch_fs_usage_short
 217 bch2_fs_usage_read_short(struct bch_fs *);
 218
 219 /* key/bucket marking: */
 220
 221 void bch2_bucket_seq_cleanup(struct bch_fs *);
 222 void bch2_fs_usage_initialize(struct bch_fs *);
 223
 224 void bch2_mark_alloc_bucket(struct bch_fs *, struct bch_dev *, size_t, bool);
 225 void bch2_mark_metadata_bucket(struct bch_fs *, struct bch_dev *,
 226                                size_t, enum bch_data_type, unsigned,
 227                                struct gc_pos, unsigned);
 228
 229 int bch2_mark_key(struct bch_fs *, struct bkey_s_c, unsigned);
 230
 231 int bch2_mark_update(struct btree_trans *, struct btree_iter *,
 232                      struct bkey_i *, unsigned);
 233
 234 int bch2_trans_mark_key(struct btree_trans *, struct bkey_s_c,
 235                         struct bkey_s_c, unsigned);
 236 int bch2_trans_mark_update(struct btree_trans *, struct btree_iter *iter,
 237                            struct bkey_i *insert, unsigned);
 238 void bch2_trans_fs_usage_apply(struct btree_trans *, struct replicas_delta_list *);
 239
 240 int bch2_trans_mark_metadata_bucket(struct btree_trans *, struct bch_dev *,
 241                                     size_t, enum bch_data_type, unsigned);
 242 int bch2_trans_mark_dev_sb(struct bch_fs *, struct bch_dev *);
 243
 244 /* disk reservations: */
 245
 246 static inline void bch2_disk_reservation_put(struct bch_fs *c,
 247                                              struct disk_reservation *res)
 248 {
 249         this_cpu_sub(*c->online_reserved, res->sectors);
 250         res->sectors = 0;
 251 }
 252
 253 #define BCH_DISK_RESERVATION_NOFAIL             (1 << 0)
 254
 255 int bch2_disk_reservation_add(struct bch_fs *,
 256                               struct disk_reservation *,
 257                               u64, int);
 258
 259 static inline struct disk_reservation
 260 bch2_disk_reservation_init(struct bch_fs *c, unsigned nr_replicas)
 261 {
 262         return (struct disk_reservation) {
 263                 .sectors        = 0,
 264 #if 0
 265                 /* not used yet: */
 266                 .gen            = c->capacity_gen,
 267 #endif
 268                 .nr_replicas    = nr_replicas,
 269         };
 270 }
 271
 272 static inline int bch2_disk_reservation_get(struct bch_fs *c,
 273                                             struct disk_reservation *res,
 274                                             u64 sectors, unsigned nr_replicas,
 275                                             int flags)
 276 {
 277         *res = bch2_disk_reservation_init(c, nr_replicas);
 278
 279         return bch2_disk_reservation_add(c, res, sectors * nr_replicas, flags);
 280 }
 281
 282 #define RESERVE_FACTOR  6
 283
 284 static inline u64 avail_factor(u64 r)
 285 {
 286         return div_u64(r << RESERVE_FACTOR, (1 << RESERVE_FACTOR) + 1);
 287 }
 288
 289 int bch2_dev_buckets_resize(struct bch_fs *, struct bch_dev *, u64);
 290 void bch2_dev_buckets_free(struct bch_dev *);
 291 int bch2_dev_buckets_alloc(struct bch_fs *, struct bch_dev *);
 292
 293 #endif /* _BUCKETS_H */