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 "sb-members.h"
  14
  15 static inline size_t sector_to_bucket(const struct bch_dev *ca, sector_t s)
  16 {
  17         return div_u64(s, ca->mi.bucket_size);
  18 }
  19
  20 static inline sector_t bucket_to_sector(const struct bch_dev *ca, size_t b)
  21 {
  22         return ((sector_t) b) * ca->mi.bucket_size;
  23 }
  24
  25 static inline sector_t bucket_remainder(const struct bch_dev *ca, sector_t s)
  26 {
  27         u32 remainder;
  28
  29         div_u64_rem(s, ca->mi.bucket_size, &remainder);
  30         return remainder;
  31 }
  32
  33 static inline size_t sector_to_bucket_and_offset(const struct bch_dev *ca, sector_t s,
  34                                                  u32 *offset)
  35 {
  36         return div_u64_rem(s, ca->mi.bucket_size, offset);
  37 }
  38
  39 #define for_each_bucket(_b, _buckets)                           \
  40         for (_b = (_buckets)->b + (_buckets)->first_bucket;     \
  41              _b < (_buckets)->b + (_buckets)->nbuckets; _b++)
  42
  43 static inline void bucket_unlock(struct bucket *b)
  44 {
  45         smp_store_release(&b->lock, 0);
  46 }
  47
  48 static inline void bucket_lock(struct bucket *b)
  49 {
  50         while (xchg(&b->lock, 1))
  51                 cpu_relax();
  52 }
  53
  54 static inline struct bucket_array *gc_bucket_array(struct bch_dev *ca)
  55 {
  56         return rcu_dereference_check(ca->buckets_gc,
  57                                      !ca->fs ||
  58                                      percpu_rwsem_is_held(&ca->fs->mark_lock) ||
  59                                      lockdep_is_held(&ca->fs->gc_lock) ||
  60                                      lockdep_is_held(&ca->bucket_lock));
  61 }
  62
  63 static inline struct bucket *gc_bucket(struct bch_dev *ca, size_t b)
  64 {
  65         struct bucket_array *buckets = gc_bucket_array(ca);
  66
  67         BUG_ON(b < buckets->first_bucket || b >= buckets->nbuckets);
  68         return buckets->b + b;
  69 }
  70
  71 static inline struct bucket_gens *bucket_gens(struct bch_dev *ca)
  72 {
  73         return rcu_dereference_check(ca->bucket_gens,
  74                                      !ca->fs ||
  75                                      percpu_rwsem_is_held(&ca->fs->mark_lock) ||
  76                                      lockdep_is_held(&ca->fs->gc_lock) ||
  77                                      lockdep_is_held(&ca->bucket_lock));
  78 }
  79
  80 static inline u8 *bucket_gen(struct bch_dev *ca, size_t b)
  81 {
  82         struct bucket_gens *gens = bucket_gens(ca);
  83
  84         BUG_ON(b < gens->first_bucket || b >= gens->nbuckets);
  85         return gens->b + b;
  86 }
  87
  88 static inline size_t PTR_BUCKET_NR(const struct bch_dev *ca,
  89                                    const struct bch_extent_ptr *ptr)
  90 {
  91         return sector_to_bucket(ca, ptr->offset);
  92 }
  93
  94 static inline struct bpos PTR_BUCKET_POS(const struct bch_fs *c,
  95                                    const struct bch_extent_ptr *ptr)
  96 {
  97         struct bch_dev *ca = bch_dev_bkey_exists(c, ptr->dev);
  98
  99         return POS(ptr->dev, PTR_BUCKET_NR(ca, ptr));
 100 }
 101
 102 static inline struct bpos PTR_BUCKET_POS_OFFSET(const struct bch_fs *c,
 103                                                 const struct bch_extent_ptr *ptr,
 104                                                 u32 *bucket_offset)
 105 {
 106         struct bch_dev *ca = bch_dev_bkey_exists(c, ptr->dev);
 107
 108         return POS(ptr->dev, sector_to_bucket_and_offset(ca, ptr->offset, bucket_offset));
 109 }
 110
 111 static inline struct bucket *PTR_GC_BUCKET(struct bch_dev *ca,
 112                                            const struct bch_extent_ptr *ptr)
 113 {
 114         return gc_bucket(ca, PTR_BUCKET_NR(ca, ptr));
 115 }
 116
 117 static inline enum bch_data_type ptr_data_type(const struct bkey *k,
 118                                                const struct bch_extent_ptr *ptr)
 119 {
 120         if (bkey_is_btree_ptr(k))
 121                 return BCH_DATA_btree;
 122
 123         return ptr->cached ? BCH_DATA_cached : BCH_DATA_user;
 124 }
 125
 126 static inline s64 ptr_disk_sectors(s64 sectors, struct extent_ptr_decoded p)
 127 {
 128         EBUG_ON(sectors < 0);
 129
 130         return crc_is_compressed(p.crc)
 131                 ? DIV_ROUND_UP_ULL(sectors * p.crc.compressed_size,
 132                                    p.crc.uncompressed_size)
 133                 : sectors;
 134 }
 135
 136 static inline int gen_cmp(u8 a, u8 b)
 137 {
 138         return (s8) (a - b);
 139 }
 140
 141 static inline int gen_after(u8 a, u8 b)
 142 {
 143         int r = gen_cmp(a, b);
 144
 145         return r > 0 ? r : 0;
 146 }
 147
 148 /**
 149  * ptr_stale() - check if a pointer points into a bucket that has been
 150  * invalidated.
 151  */
 152 static inline u8 ptr_stale(struct bch_dev *ca,
 153                            const struct bch_extent_ptr *ptr)
 154 {
 155         u8 ret;
 156
 157         rcu_read_lock();
 158         ret = gen_after(*bucket_gen(ca, PTR_BUCKET_NR(ca, ptr)), ptr->gen);
 159         rcu_read_unlock();
 160
 161         return ret;
 162 }
 163
 164 /* Device usage: */
 165
 166 void bch2_dev_usage_read_fast(struct bch_dev *, struct bch_dev_usage *);
 167 static inline struct bch_dev_usage bch2_dev_usage_read(struct bch_dev *ca)
 168 {
 169         struct bch_dev_usage ret;
 170
 171         bch2_dev_usage_read_fast(ca, &ret);
 172         return ret;
 173 }
 174
 175 void bch2_dev_usage_init(struct bch_dev *);
 176
 177 static inline u64 bch2_dev_buckets_reserved(struct bch_dev *ca, enum bch_watermark watermark)
 178 {
 179         s64 reserved = 0;
 180
 181         switch (watermark) {
 182         case BCH_WATERMARK_NR:
 183                 unreachable();
 184         case BCH_WATERMARK_stripe:
 185                 reserved += ca->mi.nbuckets >> 6;
 186                 fallthrough;
 187         case BCH_WATERMARK_normal:
 188                 reserved += ca->mi.nbuckets >> 6;
 189                 fallthrough;
 190         case BCH_WATERMARK_copygc:
 191                 reserved += ca->nr_btree_reserve;
 192                 fallthrough;
 193         case BCH_WATERMARK_btree:
 194                 reserved += ca->nr_btree_reserve;
 195                 fallthrough;
 196         case BCH_WATERMARK_btree_copygc:
 197         case BCH_WATERMARK_reclaim:
 198                 break;
 199         }
 200
 201         return reserved;
 202 }
 203
 204 static inline u64 dev_buckets_free(struct bch_dev *ca,
 205                                    struct bch_dev_usage usage,
 206                                    enum bch_watermark watermark)
 207 {
 208         return max_t(s64, 0,
 209                      usage.d[BCH_DATA_free].buckets -
 210                      ca->nr_open_buckets -
 211                      bch2_dev_buckets_reserved(ca, watermark));
 212 }
 213
 214 static inline u64 __dev_buckets_available(struct bch_dev *ca,
 215                                           struct bch_dev_usage usage,
 216                                           enum bch_watermark watermark)
 217 {
 218         return max_t(s64, 0,
 219                        usage.d[BCH_DATA_free].buckets
 220                      + usage.d[BCH_DATA_cached].buckets
 221                      + usage.d[BCH_DATA_need_gc_gens].buckets
 222                      + usage.d[BCH_DATA_need_discard].buckets
 223                      - ca->nr_open_buckets
 224                      - bch2_dev_buckets_reserved(ca, watermark));
 225 }
 226
 227 static inline u64 dev_buckets_available(struct bch_dev *ca,
 228                                         enum bch_watermark watermark)
 229 {
 230         return __dev_buckets_available(ca, bch2_dev_usage_read(ca), watermark);
 231 }
 232
 233 /* Filesystem usage: */
 234
 235 static inline unsigned __fs_usage_u64s(unsigned nr_replicas)
 236 {
 237         return sizeof(struct bch_fs_usage) / sizeof(u64) + nr_replicas;
 238 }
 239
 240 static inline unsigned fs_usage_u64s(struct bch_fs *c)
 241 {
 242         return __fs_usage_u64s(READ_ONCE(c->replicas.nr));
 243 }
 244
 245 static inline unsigned __fs_usage_online_u64s(unsigned nr_replicas)
 246 {
 247         return sizeof(struct bch_fs_usage_online) / sizeof(u64) + nr_replicas;
 248 }
 249
 250 static inline unsigned fs_usage_online_u64s(struct bch_fs *c)
 251 {
 252         return __fs_usage_online_u64s(READ_ONCE(c->replicas.nr));
 253 }
 254
 255 static inline unsigned dev_usage_u64s(void)
 256 {
 257         return sizeof(struct bch_dev_usage) / sizeof(u64);
 258 }
 259
 260 u64 bch2_fs_usage_read_one(struct bch_fs *, u64 *);
 261
 262 struct bch_fs_usage_online *bch2_fs_usage_read(struct bch_fs *);
 263
 264 void bch2_fs_usage_acc_to_base(struct bch_fs *, unsigned);
 265
 266 void bch2_fs_usage_to_text(struct printbuf *,
 267                            struct bch_fs *, struct bch_fs_usage_online *);
 268
 269 u64 bch2_fs_sectors_used(struct bch_fs *, struct bch_fs_usage_online *);
 270
 271 struct bch_fs_usage_short
 272 bch2_fs_usage_read_short(struct bch_fs *);
 273
 274 /* key/bucket marking: */
 275
 276 static inline struct bch_fs_usage *fs_usage_ptr(struct bch_fs *c,
 277                                                 unsigned journal_seq,
 278                                                 bool gc)
 279 {
 280         percpu_rwsem_assert_held(&c->mark_lock);
 281         BUG_ON(!gc && !journal_seq);
 282
 283         return this_cpu_ptr(gc
 284                             ? c->usage_gc
 285                             : c->usage[journal_seq & JOURNAL_BUF_MASK]);
 286 }
 287
 288 int bch2_replicas_deltas_realloc(struct btree_trans *, unsigned);
 289
 290 void bch2_fs_usage_initialize(struct bch_fs *);
 291
 292 int bch2_mark_metadata_bucket(struct bch_fs *, struct bch_dev *,
 293                               size_t, enum bch_data_type, unsigned,
 294                               struct gc_pos, unsigned);
 295
 296 int bch2_mark_alloc(struct btree_trans *, enum btree_id, unsigned,
 297                     struct bkey_s_c, struct bkey_s_c, unsigned);
 298 int bch2_mark_extent(struct btree_trans *, enum btree_id, unsigned,
 299                      struct bkey_s_c, struct bkey_s_c, unsigned);
 300 int bch2_mark_stripe(struct btree_trans *, enum btree_id, unsigned,
 301                      struct bkey_s_c, struct bkey_s_c, unsigned);
 302 int bch2_mark_reservation(struct btree_trans *, enum btree_id, unsigned,
 303                           struct bkey_s_c, struct bkey_s_c, unsigned);
 304 int bch2_mark_reflink_p(struct btree_trans *, enum btree_id, unsigned,
 305                         struct bkey_s_c, struct bkey_s_c, unsigned);
 306
 307 int bch2_trans_mark_extent(struct btree_trans *, enum btree_id, unsigned, struct bkey_s_c, struct bkey_i *, unsigned);
 308 int bch2_trans_mark_stripe(struct btree_trans *, enum btree_id, unsigned, struct bkey_s_c, struct bkey_i *, unsigned);
 309 int bch2_trans_mark_reservation(struct btree_trans *, enum btree_id, unsigned, struct bkey_s_c, struct bkey_i *, unsigned);
 310 int bch2_trans_mark_reflink_p(struct btree_trans *, enum btree_id, unsigned, struct bkey_s_c, struct bkey_i *, unsigned);
 311
 312 void bch2_trans_fs_usage_revert(struct btree_trans *, struct replicas_delta_list *);
 313 int bch2_trans_fs_usage_apply(struct btree_trans *, struct replicas_delta_list *);
 314
 315 int bch2_trans_mark_metadata_bucket(struct btree_trans *, struct bch_dev *,
 316                                     size_t, enum bch_data_type, unsigned);
 317 int bch2_trans_mark_dev_sb(struct bch_fs *, struct bch_dev *);
 318
 319 static inline bool is_superblock_bucket(struct bch_dev *ca, u64 b)
 320 {
 321         struct bch_sb_layout *layout = &ca->disk_sb.sb->layout;
 322         u64 b_offset    = bucket_to_sector(ca, b);
 323         u64 b_end       = bucket_to_sector(ca, b + 1);
 324         unsigned i;
 325
 326         if (!b)
 327                 return true;
 328
 329         for (i = 0; i < layout->nr_superblocks; i++) {
 330                 u64 offset = le64_to_cpu(layout->sb_offset[i]);
 331                 u64 end = offset + (1 << layout->sb_max_size_bits);
 332
 333                 if (!(offset >= b_end || end <= b_offset))
 334                         return true;
 335         }
 336
 337         return false;
 338 }
 339
 340 /* disk reservations: */
 341
 342 static inline void bch2_disk_reservation_put(struct bch_fs *c,
 343                                              struct disk_reservation *res)
 344 {
 345         if (res->sectors) {
 346                 this_cpu_sub(*c->online_reserved, res->sectors);
 347                 res->sectors = 0;
 348         }
 349 }
 350
 351 #define BCH_DISK_RESERVATION_NOFAIL             (1 << 0)
 352
 353 int __bch2_disk_reservation_add(struct bch_fs *,
 354                                 struct disk_reservation *,
 355                                 u64, int);
 356
 357 static inline int bch2_disk_reservation_add(struct bch_fs *c, struct disk_reservation *res,
 358                                             u64 sectors, int flags)
 359 {
 360 #ifdef __KERNEL__
 361         u64 old, new;
 362
 363         do {
 364                 old = this_cpu_read(c->pcpu->sectors_available);
 365                 if (sectors > old)
 366                         return __bch2_disk_reservation_add(c, res, sectors, flags);
 367
 368                 new = old - sectors;
 369         } while (this_cpu_cmpxchg(c->pcpu->sectors_available, old, new) != old);
 370
 371         this_cpu_add(*c->online_reserved, sectors);
 372         res->sectors                    += sectors;
 373         return 0;
 374 #else
 375         return __bch2_disk_reservation_add(c, res, sectors, flags);
 376 #endif
 377 }
 378
 379 static inline struct disk_reservation
 380 bch2_disk_reservation_init(struct bch_fs *c, unsigned nr_replicas)
 381 {
 382         return (struct disk_reservation) {
 383                 .sectors        = 0,
 384 #if 0
 385                 /* not used yet: */
 386                 .gen            = c->capacity_gen,
 387 #endif
 388                 .nr_replicas    = nr_replicas,
 389         };
 390 }
 391
 392 static inline int bch2_disk_reservation_get(struct bch_fs *c,
 393                                             struct disk_reservation *res,
 394                                             u64 sectors, unsigned nr_replicas,
 395                                             int flags)
 396 {
 397         *res = bch2_disk_reservation_init(c, nr_replicas);
 398
 399         return bch2_disk_reservation_add(c, res, sectors * nr_replicas, flags);
 400 }
 401
 402 #define RESERVE_FACTOR  6
 403
 404 static inline u64 avail_factor(u64 r)
 405 {
 406         return div_u64(r << RESERVE_FACTOR, (1 << RESERVE_FACTOR) + 1);
 407 }
 408
 409 int bch2_dev_buckets_resize(struct bch_fs *, struct bch_dev *, u64);
 410 void bch2_dev_buckets_free(struct bch_dev *);
 411 int bch2_dev_buckets_alloc(struct bch_fs *, struct bch_dev *);
 412
 413 #endif /* _BUCKETS_H */