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 "extents.h"
  13 #include "super.h"
  14
  15 #define for_each_bucket(_b, _buckets)                           \
  16         for (_b = (_buckets)->b + (_buckets)->first_bucket;     \
  17              _b < (_buckets)->b + (_buckets)->nbuckets; _b++)
  18
  19 static inline void bucket_unlock(struct bucket *b)
  20 {
  21         smp_store_release(&b->lock, 0);
  22 }
  23
  24 static inline void bucket_lock(struct bucket *b)
  25 {
  26         while (xchg(&b->lock, 1))
  27                 cpu_relax();
  28 }
  29
  30 static inline struct bucket_array *gc_bucket_array(struct bch_dev *ca)
  31 {
  32         return rcu_dereference_check(ca->buckets_gc,
  33                                      !ca->fs ||
  34                                      percpu_rwsem_is_held(&ca->fs->mark_lock) ||
  35                                      lockdep_is_held(&ca->fs->gc_lock) ||
  36                                      lockdep_is_held(&ca->bucket_lock));
  37 }
  38
  39 static inline struct bucket *gc_bucket(struct bch_dev *ca, size_t b)
  40 {
  41         struct bucket_array *buckets = gc_bucket_array(ca);
  42
  43         BUG_ON(b < buckets->first_bucket || b >= buckets->nbuckets);
  44         return buckets->b + b;
  45 }
  46
  47 static inline struct bucket_gens *bucket_gens(struct bch_dev *ca)
  48 {
  49         return rcu_dereference_check(ca->bucket_gens,
  50                                      !ca->fs ||
  51                                      percpu_rwsem_is_held(&ca->fs->mark_lock) ||
  52                                      lockdep_is_held(&ca->fs->gc_lock) ||
  53                                      lockdep_is_held(&ca->bucket_lock));
  54 }
  55
  56 static inline u8 *bucket_gen(struct bch_dev *ca, size_t b)
  57 {
  58         struct bucket_gens *gens = bucket_gens(ca);
  59
  60         BUG_ON(b < gens->first_bucket || b >= gens->nbuckets);
  61         return gens->b + b;
  62 }
  63
  64 static inline size_t PTR_BUCKET_NR(const struct bch_dev *ca,
  65                                    const struct bch_extent_ptr *ptr)
  66 {
  67         return sector_to_bucket(ca, ptr->offset);
  68 }
  69
  70 static inline struct bpos PTR_BUCKET_POS(const struct bch_fs *c,
  71                                    const struct bch_extent_ptr *ptr)
  72 {
  73         struct bch_dev *ca = bch_dev_bkey_exists(c, ptr->dev);
  74
  75         return POS(ptr->dev, PTR_BUCKET_NR(ca, ptr));
  76 }
  77
  78 static inline struct bpos PTR_BUCKET_POS_OFFSET(const struct bch_fs *c,
  79                                                 const struct bch_extent_ptr *ptr,
  80                                                 u32 *bucket_offset)
  81 {
  82         struct bch_dev *ca = bch_dev_bkey_exists(c, ptr->dev);
  83
  84         return POS(ptr->dev, sector_to_bucket_and_offset(ca, ptr->offset, bucket_offset));
  85 }
  86
  87 static inline struct bucket *PTR_GC_BUCKET(struct bch_dev *ca,
  88                                            const struct bch_extent_ptr *ptr)
  89 {
  90         return gc_bucket(ca, PTR_BUCKET_NR(ca, ptr));
  91 }
  92
  93 static inline enum bch_data_type ptr_data_type(const struct bkey *k,
  94                                                const struct bch_extent_ptr *ptr)
  95 {
  96         if (bkey_is_btree_ptr(k))
  97                 return BCH_DATA_btree;
  98
  99         return ptr->cached ? BCH_DATA_cached : BCH_DATA_user;
 100 }
 101
 102 static inline s64 ptr_disk_sectors(s64 sectors, struct extent_ptr_decoded p)
 103 {
 104         EBUG_ON(sectors < 0);
 105
 106         return crc_is_compressed(p.crc)
 107                 ? DIV_ROUND_UP_ULL(sectors * p.crc.compressed_size,
 108                                    p.crc.uncompressed_size)
 109                 : sectors;
 110 }
 111
 112 static inline int gen_cmp(u8 a, u8 b)
 113 {
 114         return (s8) (a - b);
 115 }
 116
 117 static inline int gen_after(u8 a, u8 b)
 118 {
 119         int r = gen_cmp(a, b);
 120
 121         return r > 0 ? r : 0;
 122 }
 123
 124 /**
 125  * ptr_stale() - check if a pointer points into a bucket that has been
 126  * invalidated.
 127  */
 128 static inline u8 ptr_stale(struct bch_dev *ca,
 129                            const struct bch_extent_ptr *ptr)
 130 {
 131         u8 ret;
 132
 133         rcu_read_lock();
 134         ret = gen_after(*bucket_gen(ca, PTR_BUCKET_NR(ca, ptr)), ptr->gen);
 135         rcu_read_unlock();
 136
 137         return ret;
 138 }
 139
 140 /* Device usage: */
 141
 142 void bch2_dev_usage_read_fast(struct bch_dev *, struct bch_dev_usage *);
 143 static inline struct bch_dev_usage bch2_dev_usage_read(struct bch_dev *ca)
 144 {
 145         struct bch_dev_usage ret;
 146
 147         bch2_dev_usage_read_fast(ca, &ret);
 148         return ret;
 149 }
 150
 151 void bch2_dev_usage_init(struct bch_dev *);
 152
 153 static inline u64 bch2_dev_buckets_reserved(struct bch_dev *ca, enum alloc_reserve reserve)
 154 {
 155         s64 reserved = 0;
 156
 157         switch (reserve) {
 158         case RESERVE_none:
 159                 reserved += ca->mi.nbuckets >> 6;
 160                 fallthrough;
 161         case RESERVE_movinggc:
 162                 reserved += ca->nr_btree_reserve;
 163                 fallthrough;
 164         case RESERVE_btree:
 165                 reserved += ca->nr_btree_reserve;
 166                 fallthrough;
 167         case RESERVE_btree_movinggc:
 168                 break;
 169         }
 170
 171         return reserved;
 172 }
 173
 174 static inline u64 dev_buckets_free(struct bch_dev *ca,
 175                                    struct bch_dev_usage usage,
 176                                    enum alloc_reserve reserve)
 177 {
 178         return max_t(s64, 0,
 179                      usage.d[BCH_DATA_free].buckets -
 180                      ca->nr_open_buckets -
 181                      bch2_dev_buckets_reserved(ca, reserve));
 182 }
 183
 184 static inline u64 __dev_buckets_available(struct bch_dev *ca,
 185                                           struct bch_dev_usage usage,
 186                                           enum alloc_reserve reserve)
 187 {
 188         return max_t(s64, 0,
 189                        usage.d[BCH_DATA_free].buckets
 190                      + usage.d[BCH_DATA_cached].buckets
 191                      + usage.d[BCH_DATA_need_gc_gens].buckets
 192                      + usage.d[BCH_DATA_need_discard].buckets
 193                      - ca->nr_open_buckets
 194                      - bch2_dev_buckets_reserved(ca, reserve));
 195 }
 196
 197 static inline u64 dev_buckets_available(struct bch_dev *ca,
 198                                         enum alloc_reserve reserve)
 199 {
 200         return __dev_buckets_available(ca, bch2_dev_usage_read(ca), reserve);
 201 }
 202
 203 /* Filesystem usage: */
 204
 205 static inline unsigned fs_usage_u64s(struct bch_fs *c)
 206 {
 207         return sizeof(struct bch_fs_usage) / sizeof(u64) +
 208                 READ_ONCE(c->replicas.nr);
 209 }
 210
 211 static inline unsigned dev_usage_u64s(void)
 212 {
 213         return sizeof(struct bch_dev_usage) / sizeof(u64);
 214 }
 215
 216 u64 bch2_fs_usage_read_one(struct bch_fs *, u64 *);
 217
 218 struct bch_fs_usage_online *bch2_fs_usage_read(struct bch_fs *);
 219
 220 void bch2_fs_usage_acc_to_base(struct bch_fs *, unsigned);
 221
 222 void bch2_fs_usage_to_text(struct printbuf *,
 223                            struct bch_fs *, struct bch_fs_usage_online *);
 224
 225 u64 bch2_fs_sectors_used(struct bch_fs *, struct bch_fs_usage_online *);
 226
 227 struct bch_fs_usage_short
 228 bch2_fs_usage_read_short(struct bch_fs *);
 229
 230 /* key/bucket marking: */
 231
 232 void bch2_fs_usage_initialize(struct bch_fs *);
 233
 234 int bch2_mark_metadata_bucket(struct bch_fs *, struct bch_dev *,
 235                               size_t, enum bch_data_type, unsigned,
 236                               struct gc_pos, unsigned);
 237
 238 int bch2_mark_alloc(struct btree_trans *, struct bkey_s_c, struct bkey_s_c, unsigned);
 239 int bch2_mark_extent(struct btree_trans *, struct bkey_s_c, struct bkey_s_c, unsigned);
 240 int bch2_mark_stripe(struct btree_trans *, struct bkey_s_c, struct bkey_s_c, unsigned);
 241 int bch2_mark_inode(struct btree_trans *, struct bkey_s_c, struct bkey_s_c, unsigned);
 242 int bch2_mark_reservation(struct btree_trans *, struct bkey_s_c, struct bkey_s_c, unsigned);
 243 int bch2_mark_reflink_p(struct btree_trans *, struct bkey_s_c, struct bkey_s_c, unsigned);
 244
 245 int bch2_trans_mark_extent(struct btree_trans *, enum btree_id, unsigned, struct bkey_s_c, struct bkey_i *, unsigned);
 246 int bch2_trans_mark_stripe(struct btree_trans *, enum btree_id, unsigned, struct bkey_s_c, struct bkey_i *, unsigned);
 247 int bch2_trans_mark_inode(struct btree_trans *, enum btree_id, unsigned, struct bkey_s_c, struct bkey_i *, unsigned);
 248 int bch2_trans_mark_reservation(struct btree_trans *, enum btree_id, unsigned, struct bkey_s_c, struct bkey_i *, unsigned);
 249 int bch2_trans_mark_reflink_p(struct btree_trans *, enum btree_id, unsigned, struct bkey_s_c, struct bkey_i *, unsigned);
 250
 251 int bch2_trans_fs_usage_apply(struct btree_trans *, struct replicas_delta_list *);
 252
 253 int bch2_trans_mark_metadata_bucket(struct btree_trans *, struct bch_dev *,
 254                                     size_t, enum bch_data_type, unsigned);
 255 int bch2_trans_mark_dev_sb(struct bch_fs *, struct bch_dev *);
 256
 257 /* disk reservations: */
 258
 259 static inline void bch2_disk_reservation_put(struct bch_fs *c,
 260                                              struct disk_reservation *res)
 261 {
 262         if (res->sectors) {
 263                 this_cpu_sub(*c->online_reserved, res->sectors);
 264                 res->sectors = 0;
 265         }
 266 }
 267
 268 #define BCH_DISK_RESERVATION_NOFAIL             (1 << 0)
 269
 270 int __bch2_disk_reservation_add(struct bch_fs *,
 271                                 struct disk_reservation *,
 272                                 u64, int);
 273
 274 static inline int bch2_disk_reservation_add(struct bch_fs *c, struct disk_reservation *res,
 275                                             u64 sectors, int flags)
 276 {
 277 #ifdef __KERNEL__
 278         u64 old, new;
 279
 280         do {
 281                 old = this_cpu_read(c->pcpu->sectors_available);
 282                 if (sectors > old)
 283                         return __bch2_disk_reservation_add(c, res, sectors, flags);
 284
 285                 new = old - sectors;
 286         } while (this_cpu_cmpxchg(c->pcpu->sectors_available, old, new) != old);
 287
 288         this_cpu_add(*c->online_reserved, sectors);
 289         res->sectors                    += sectors;
 290         return 0;
 291 #else
 292         return __bch2_disk_reservation_add(c, res, sectors, flags);
 293 #endif
 294 }
 295
 296 static inline struct disk_reservation
 297 bch2_disk_reservation_init(struct bch_fs *c, unsigned nr_replicas)
 298 {
 299         return (struct disk_reservation) {
 300                 .sectors        = 0,
 301 #if 0
 302                 /* not used yet: */
 303                 .gen            = c->capacity_gen,
 304 #endif
 305                 .nr_replicas    = nr_replicas,
 306         };
 307 }
 308
 309 static inline int bch2_disk_reservation_get(struct bch_fs *c,
 310                                             struct disk_reservation *res,
 311                                             u64 sectors, unsigned nr_replicas,
 312                                             int flags)
 313 {
 314         *res = bch2_disk_reservation_init(c, nr_replicas);
 315
 316         return bch2_disk_reservation_add(c, res, sectors * nr_replicas, flags);
 317 }
 318
 319 #define RESERVE_FACTOR  6
 320
 321 static inline u64 avail_factor(u64 r)
 322 {
 323         return div_u64(r << RESERVE_FACTOR, (1 << RESERVE_FACTOR) + 1);
 324 }
 325
 326 int bch2_dev_buckets_resize(struct bch_fs *, struct bch_dev *, u64);
 327 void bch2_dev_buckets_free(struct bch_dev *);
 328 int bch2_dev_buckets_alloc(struct bch_fs *, struct bch_dev *);
 329
 330 #endif /* _BUCKETS_H */