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

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _BCACHEFS_H
   3 #define _BCACHEFS_H
   4
   5 /*
   6  * SOME HIGH LEVEL CODE DOCUMENTATION:
   7  *
   8  * Bcache mostly works with cache sets, cache devices, and backing devices.
   9  *
  10  * Support for multiple cache devices hasn't quite been finished off yet, but
  11  * it's about 95% plumbed through. A cache set and its cache devices is sort of
  12  * like a md raid array and its component devices. Most of the code doesn't care
  13  * about individual cache devices, the main abstraction is the cache set.
  14  *
  15  * Multiple cache devices is intended to give us the ability to mirror dirty
  16  * cached data and metadata, without mirroring clean cached data.
  17  *
  18  * Backing devices are different, in that they have a lifetime independent of a
  19  * cache set. When you register a newly formatted backing device it'll come up
  20  * in passthrough mode, and then you can attach and detach a backing device from
  21  * a cache set at runtime - while it's mounted and in use. Detaching implicitly
  22  * invalidates any cached data for that backing device.
  23  *
  24  * A cache set can have multiple (many) backing devices attached to it.
  25  *
  26  * There's also flash only volumes - this is the reason for the distinction
  27  * between struct cached_dev and struct bcache_device. A flash only volume
  28  * works much like a bcache device that has a backing device, except the
  29  * "cached" data is always dirty. The end result is that we get thin
  30  * provisioning with very little additional code.
  31  *
  32  * Flash only volumes work but they're not production ready because the moving
  33  * garbage collector needs more work. More on that later.
  34  *
  35  * BUCKETS/ALLOCATION:
  36  *
  37  * Bcache is primarily designed for caching, which means that in normal
  38  * operation all of our available space will be allocated. Thus, we need an
  39  * efficient way of deleting things from the cache so we can write new things to
  40  * it.
  41  *
  42  * To do this, we first divide the cache device up into buckets. A bucket is the
  43  * unit of allocation; they're typically around 1 mb - anywhere from 128k to 2M+
  44  * works efficiently.
  45  *
  46  * Each bucket has a 16 bit priority, and an 8 bit generation associated with
  47  * it. The gens and priorities for all the buckets are stored contiguously and
  48  * packed on disk (in a linked list of buckets - aside from the superblock, all
  49  * of bcache's metadata is stored in buckets).
  50  *
  51  * The priority is used to implement an LRU. We reset a bucket's priority when
  52  * we allocate it or on cache it, and every so often we decrement the priority
  53  * of each bucket. It could be used to implement something more sophisticated,
  54  * if anyone ever gets around to it.
  55  *
  56  * The generation is used for invalidating buckets. Each pointer also has an 8
  57  * bit generation embedded in it; for a pointer to be considered valid, its gen
  58  * must match the gen of the bucket it points into.  Thus, to reuse a bucket all
  59  * we have to do is increment its gen (and write its new gen to disk; we batch
  60  * this up).
  61  *
  62  * Bcache is entirely COW - we never write twice to a bucket, even buckets that
  63  * contain metadata (including btree nodes).
  64  *
  65  * THE BTREE:
  66  *
  67  * Bcache is in large part design around the btree.
  68  *
  69  * At a high level, the btree is just an index of key -> ptr tuples.
  70  *
  71  * Keys represent extents, and thus have a size field. Keys also have a variable
  72  * number of pointers attached to them (potentially zero, which is handy for
  73  * invalidating the cache).
  74  *
  75  * The key itself is an inode:offset pair. The inode number corresponds to a
  76  * backing device or a flash only volume. The offset is the ending offset of the
  77  * extent within the inode - not the starting offset; this makes lookups
  78  * slightly more convenient.
  79  *
  80  * Pointers contain the cache device id, the offset on that device, and an 8 bit
  81  * generation number. More on the gen later.
  82  *
  83  * Index lookups are not fully abstracted - cache lookups in particular are
  84  * still somewhat mixed in with the btree code, but things are headed in that
  85  * direction.
  86  *
  87  * Updates are fairly well abstracted, though. There are two different ways of
  88  * updating the btree; insert and replace.
  89  *
  90  * BTREE_INSERT will just take a list of keys and insert them into the btree -
  91  * overwriting (possibly only partially) any extents they overlap with. This is
  92  * used to update the index after a write.
  93  *
  94  * BTREE_REPLACE is really cmpxchg(); it inserts a key into the btree iff it is
  95  * overwriting a key that matches another given key. This is used for inserting
  96  * data into the cache after a cache miss, and for background writeback, and for
  97  * the moving garbage collector.
  98  *
  99  * There is no "delete" operation; deleting things from the index is
 100  * accomplished by either by invalidating pointers (by incrementing a bucket's
 101  * gen) or by inserting a key with 0 pointers - which will overwrite anything
 102  * previously present at that location in the index.
 103  *
 104  * This means that there are always stale/invalid keys in the btree. They're
 105  * filtered out by the code that iterates through a btree node, and removed when
 106  * a btree node is rewritten.
 107  *
 108  * BTREE NODES:
 109  *
 110  * Our unit of allocation is a bucket, and we can't arbitrarily allocate and
 111  * free smaller than a bucket - so, that's how big our btree nodes are.
 112  *
 113  * (If buckets are really big we'll only use part of the bucket for a btree node
 114  * - no less than 1/4th - but a bucket still contains no more than a single
 115  * btree node. I'd actually like to change this, but for now we rely on the
 116  * bucket's gen for deleting btree nodes when we rewrite/split a node.)
 117  *
 118  * Anyways, btree nodes are big - big enough to be inefficient with a textbook
 119  * btree implementation.
 120  *
 121  * The way this is solved is that btree nodes are internally log structured; we
 122  * can append new keys to an existing btree node without rewriting it. This
 123  * means each set of keys we write is sorted, but the node is not.
 124  *
 125  * We maintain this log structure in memory - keeping 1Mb of keys sorted would
 126  * be expensive, and we have to distinguish between the keys we have written and
 127  * the keys we haven't. So to do a lookup in a btree node, we have to search
 128  * each sorted set. But we do merge written sets together lazily, so the cost of
 129  * these extra searches is quite low (normally most of the keys in a btree node
 130  * will be in one big set, and then there'll be one or two sets that are much
 131  * smaller).
 132  *
 133  * This log structure makes bcache's btree more of a hybrid between a
 134  * conventional btree and a compacting data structure, with some of the
 135  * advantages of both.
 136  *
 137  * GARBAGE COLLECTION:
 138  *
 139  * We can't just invalidate any bucket - it might contain dirty data or
 140  * metadata. If it once contained dirty data, other writes might overwrite it
 141  * later, leaving no valid pointers into that bucket in the index.
 142  *
 143  * Thus, the primary purpose of garbage collection is to find buckets to reuse.
 144  * It also counts how much valid data it each bucket currently contains, so that
 145  * allocation can reuse buckets sooner when they've been mostly overwritten.
 146  *
 147  * It also does some things that are really internal to the btree
 148  * implementation. If a btree node contains pointers that are stale by more than
 149  * some threshold, it rewrites the btree node to avoid the bucket's generation
 150  * wrapping around. It also merges adjacent btree nodes if they're empty enough.
 151  *
 152  * THE JOURNAL:
 153  *
 154  * Bcache's journal is not necessary for consistency; we always strictly
 155  * order metadata writes so that the btree and everything else is consistent on
 156  * disk in the event of an unclean shutdown, and in fact bcache had writeback
 157  * caching (with recovery from unclean shutdown) before journalling was
 158  * implemented.
 159  *
 160  * Rather, the journal is purely a performance optimization; we can't complete a
 161  * write until we've updated the index on disk, otherwise the cache would be
 162  * inconsistent in the event of an unclean shutdown. This means that without the
 163  * journal, on random write workloads we constantly have to update all the leaf
 164  * nodes in the btree, and those writes will be mostly empty (appending at most
 165  * a few keys each) - highly inefficient in terms of amount of metadata writes,
 166  * and it puts more strain on the various btree resorting/compacting code.
 167  *
 168  * The journal is just a log of keys we've inserted; on startup we just reinsert
 169  * all the keys in the open journal entries. That means that when we're updating
 170  * a node in the btree, we can wait until a 4k block of keys fills up before
 171  * writing them out.
 172  *
 173  * For simplicity, we only journal updates to leaf nodes; updates to parent
 174  * nodes are rare enough (since our leaf nodes are huge) that it wasn't worth
 175  * the complexity to deal with journalling them (in particular, journal replay)
 176  * - updates to non leaf nodes just happen synchronously (see btree_split()).
 177  */
 178
 179 #undef pr_fmt
 180 #ifdef __KERNEL__
 181 #define pr_fmt(fmt) "bcachefs: %s() " fmt "\n", __func__
 182 #else
 183 #define pr_fmt(fmt) "%s() " fmt "\n", __func__
 184 #endif
 185
 186 #include <linux/backing-dev-defs.h>
 187 #include <linux/bug.h>
 188 #include <linux/bio.h>
 189 #include <linux/closure.h>
 190 #include <linux/kobject.h>
 191 #include <linux/list.h>
 192 #include <linux/math64.h>
 193 #include <linux/mutex.h>
 194 #include <linux/percpu-refcount.h>
 195 #include <linux/percpu-rwsem.h>
 196 #include <linux/rhashtable.h>
 197 #include <linux/rwsem.h>
 198 #include <linux/semaphore.h>
 199 #include <linux/seqlock.h>
 200 #include <linux/shrinker.h>
 201 #include <linux/srcu.h>
 202 #include <linux/types.h>
 203 #include <linux/workqueue.h>
 204 #include <linux/zstd.h>
 205
 206 #include "bcachefs_format.h"
 207 #include "errcode.h"
 208 #include "fifo.h"
 209 #include "nocow_locking_types.h"
 210 #include "opts.h"
 211 #include "util.h"
 212
 213 #ifdef CONFIG_BCACHEFS_DEBUG
 214 #define BCH_WRITE_REF_DEBUG
 215 #endif
 216
 217 #define dynamic_fault(...)              0
 218 #define race_fault(...)                 0
 219
 220 #define trace_and_count(_c, _name, ...)                                 \
 221 do {                                                                    \
 222         this_cpu_inc((_c)->counters[BCH_COUNTER_##_name]);              \
 223         trace_##_name(__VA_ARGS__);                                     \
 224 } while (0)
 225
 226 #define bch2_fs_init_fault(name)                                        \
 227         dynamic_fault("bcachefs:bch_fs_init:" name)
 228 #define bch2_meta_read_fault(name)                                      \
 229          dynamic_fault("bcachefs:meta:read:" name)
 230 #define bch2_meta_write_fault(name)                                     \
 231          dynamic_fault("bcachefs:meta:write:" name)
 232
 233 #ifdef __KERNEL__
 234 #define BCACHEFS_LOG_PREFIX
 235 #endif
 236
 237 #ifdef BCACHEFS_LOG_PREFIX
 238
 239 #define bch2_log_msg(_c, fmt)                   "bcachefs (%s): " fmt, ((_c)->name)
 240 #define bch2_fmt_dev(_ca, fmt)                  "bcachefs (%s): " fmt "\n", ((_ca)->name)
 241 #define bch2_fmt_dev_offset(_ca, _offset, fmt)  "bcachefs (%s sector %llu): " fmt "\n", ((_ca)->name), (_offset)
 242 #define bch2_fmt_inum(_c, _inum, fmt)           "bcachefs (%s inum %llu): " fmt "\n", ((_c)->name), (_inum)
 243 #define bch2_fmt_inum_offset(_c, _inum, _offset, fmt)                   \
 244          "bcachefs (%s inum %llu offset %llu): " fmt "\n", ((_c)->name), (_inum), (_offset)
 245
 246 #else
 247
 248 #define bch2_log_msg(_c, fmt)                   fmt
 249 #define bch2_fmt_dev(_ca, fmt)                  "%s: " fmt "\n", ((_ca)->name)
 250 #define bch2_fmt_dev_offset(_ca, _offset, fmt)  "%s sector %llu: " fmt "\n", ((_ca)->name), (_offset)
 251 #define bch2_fmt_inum(_c, _inum, fmt)           "inum %llu: " fmt "\n", (_inum)
 252 #define bch2_fmt_inum_offset(_c, _inum, _offset, fmt)                           \
 253          "inum %llu offset %llu: " fmt "\n", (_inum), (_offset)
 254
 255 #endif
 256
 257 #define bch2_fmt(_c, fmt)               bch2_log_msg(_c, fmt "\n")
 258
 259 #define bch_info(c, fmt, ...) \
 260         printk(KERN_INFO bch2_fmt(c, fmt), ##__VA_ARGS__)
 261 #define bch_notice(c, fmt, ...) \
 262         printk(KERN_NOTICE bch2_fmt(c, fmt), ##__VA_ARGS__)
 263 #define bch_warn(c, fmt, ...) \
 264         printk(KERN_WARNING bch2_fmt(c, fmt), ##__VA_ARGS__)
 265 #define bch_warn_ratelimited(c, fmt, ...) \
 266         printk_ratelimited(KERN_WARNING bch2_fmt(c, fmt), ##__VA_ARGS__)
 267
 268 #define bch_err(c, fmt, ...) \
 269         printk(KERN_ERR bch2_fmt(c, fmt), ##__VA_ARGS__)
 270 #define bch_err_dev(ca, fmt, ...) \
 271         printk(KERN_ERR bch2_fmt_dev(ca, fmt), ##__VA_ARGS__)
 272 #define bch_err_dev_offset(ca, _offset, fmt, ...) \
 273         printk(KERN_ERR bch2_fmt_dev_offset(ca, _offset, fmt), ##__VA_ARGS__)
 274 #define bch_err_inum(c, _inum, fmt, ...) \
 275         printk(KERN_ERR bch2_fmt_inum(c, _inum, fmt), ##__VA_ARGS__)
 276 #define bch_err_inum_offset(c, _inum, _offset, fmt, ...) \
 277         printk(KERN_ERR bch2_fmt_inum_offset(c, _inum, _offset, fmt), ##__VA_ARGS__)
 278
 279 #define bch_err_ratelimited(c, fmt, ...) \
 280         printk_ratelimited(KERN_ERR bch2_fmt(c, fmt), ##__VA_ARGS__)
 281 #define bch_err_dev_ratelimited(ca, fmt, ...) \
 282         printk_ratelimited(KERN_ERR bch2_fmt_dev(ca, fmt), ##__VA_ARGS__)
 283 #define bch_err_dev_offset_ratelimited(ca, _offset, fmt, ...) \
 284         printk_ratelimited(KERN_ERR bch2_fmt_dev_offset(ca, _offset, fmt), ##__VA_ARGS__)
 285 #define bch_err_inum_ratelimited(c, _inum, fmt, ...) \
 286         printk_ratelimited(KERN_ERR bch2_fmt_inum(c, _inum, fmt), ##__VA_ARGS__)
 287 #define bch_err_inum_offset_ratelimited(c, _inum, _offset, fmt, ...) \
 288         printk_ratelimited(KERN_ERR bch2_fmt_inum_offset(c, _inum, _offset, fmt), ##__VA_ARGS__)
 289
 290 #define bch_verbose(c, fmt, ...)                                        \
 291 do {                                                                    \
 292         if ((c)->opts.verbose)                                          \
 293                 bch_info(c, fmt, ##__VA_ARGS__);                        \
 294 } while (0)
 295
 296 #define pr_verbose_init(opts, fmt, ...)                                 \
 297 do {                                                                    \
 298         if (opt_get(opts, verbose))                                     \
 299                 pr_info(fmt, ##__VA_ARGS__);                            \
 300 } while (0)
 301
 302 /* Parameters that are useful for debugging, but should always be compiled in: */
 303 #define BCH_DEBUG_PARAMS_ALWAYS()                                       \
 304         BCH_DEBUG_PARAM(key_merging_disabled,                           \
 305                 "Disables merging of extents")                          \
 306         BCH_DEBUG_PARAM(btree_gc_always_rewrite,                        \
 307                 "Causes mark and sweep to compact and rewrite every "   \
 308                 "btree node it traverses")                              \
 309         BCH_DEBUG_PARAM(btree_gc_rewrite_disabled,                      \
 310                 "Disables rewriting of btree nodes during mark and sweep")\
 311         BCH_DEBUG_PARAM(btree_shrinker_disabled,                        \
 312                 "Disables the shrinker callback for the btree node cache")\
 313         BCH_DEBUG_PARAM(verify_btree_ondisk,                            \
 314                 "Reread btree nodes at various points to verify the "   \
 315                 "mergesort in the read path against modifications "     \
 316                 "done in memory")                                       \
 317         BCH_DEBUG_PARAM(verify_all_btree_replicas,                      \
 318                 "When reading btree nodes, read all replicas and "      \
 319                 "compare them")
 320
 321 /* Parameters that should only be compiled in debug mode: */
 322 #define BCH_DEBUG_PARAMS_DEBUG()                                        \
 323         BCH_DEBUG_PARAM(expensive_debug_checks,                         \
 324                 "Enables various runtime debugging checks that "        \
 325                 "significantly affect performance")                     \
 326         BCH_DEBUG_PARAM(debug_check_iterators,                          \
 327                 "Enables extra verification for btree iterators")       \
 328         BCH_DEBUG_PARAM(debug_check_btree_accounting,                   \
 329                 "Verify btree accounting for keys within a node")       \
 330         BCH_DEBUG_PARAM(journal_seq_verify,                             \
 331                 "Store the journal sequence number in the version "     \
 332                 "number of every btree key, and verify that btree "     \
 333                 "update ordering is preserved during recovery")         \
 334         BCH_DEBUG_PARAM(inject_invalid_keys,                            \
 335                 "Store the journal sequence number in the version "     \
 336                 "number of every btree key, and verify that btree "     \
 337                 "update ordering is preserved during recovery")         \
 338         BCH_DEBUG_PARAM(test_alloc_startup,                             \
 339                 "Force allocator startup to use the slowpath where it"  \
 340                 "can't find enough free buckets without invalidating"   \
 341                 "cached data")                                          \
 342         BCH_DEBUG_PARAM(force_reconstruct_read,                         \
 343                 "Force reads to use the reconstruct path, when reading" \
 344                 "from erasure coded extents")                           \
 345         BCH_DEBUG_PARAM(test_restart_gc,                                \
 346                 "Test restarting mark and sweep gc when bucket gens change")
 347
 348 #define BCH_DEBUG_PARAMS_ALL() BCH_DEBUG_PARAMS_ALWAYS() BCH_DEBUG_PARAMS_DEBUG()
 349
 350 #ifdef CONFIG_BCACHEFS_DEBUG
 351 #define BCH_DEBUG_PARAMS() BCH_DEBUG_PARAMS_ALL()
 352 #else
 353 #define BCH_DEBUG_PARAMS() BCH_DEBUG_PARAMS_ALWAYS()
 354 #endif
 355
 356 #define BCH_DEBUG_PARAM(name, description) extern bool bch2_##name;
 357 BCH_DEBUG_PARAMS()
 358 #undef BCH_DEBUG_PARAM
 359
 360 #ifndef CONFIG_BCACHEFS_DEBUG
 361 #define BCH_DEBUG_PARAM(name, description) static const bool bch2_##name;
 362 BCH_DEBUG_PARAMS_DEBUG()
 363 #undef BCH_DEBUG_PARAM
 364 #endif
 365
 366 #define BCH_TIME_STATS()                        \
 367         x(btree_node_mem_alloc)                 \
 368         x(btree_node_split)                     \
 369         x(btree_node_compact)                   \
 370         x(btree_node_merge)                     \
 371         x(btree_node_sort)                      \
 372         x(btree_node_read)                      \
 373         x(btree_interior_update_foreground)     \
 374         x(btree_interior_update_total)          \
 375         x(btree_gc)                             \
 376         x(data_write)                           \
 377         x(data_read)                            \
 378         x(data_promote)                         \
 379         x(journal_flush_write)                  \
 380         x(journal_noflush_write)                \
 381         x(journal_flush_seq)                    \
 382         x(blocked_journal)                      \
 383         x(blocked_allocate)                     \
 384         x(blocked_allocate_open_bucket)         \
 385         x(nocow_lock_contended)
 386
 387 enum bch_time_stats {
 388 #define x(name) BCH_TIME_##name,
 389         BCH_TIME_STATS()
 390 #undef x
 391         BCH_TIME_STAT_NR
 392 };
 393
 394 #include "alloc_types.h"
 395 #include "btree_types.h"
 396 #include "buckets_types.h"
 397 #include "buckets_waiting_for_journal_types.h"
 398 #include "clock_types.h"
 399 #include "ec_types.h"
 400 #include "journal_types.h"
 401 #include "keylist_types.h"
 402 #include "quota_types.h"
 403 #include "rebalance_types.h"
 404 #include "replicas_types.h"
 405 #include "subvolume_types.h"
 406 #include "super_types.h"
 407
 408 /* Number of nodes btree coalesce will try to coalesce at once */
 409 #define GC_MERGE_NODES          4U
 410
 411 /* Maximum number of nodes we might need to allocate atomically: */
 412 #define BTREE_RESERVE_MAX       (BTREE_MAX_DEPTH + (BTREE_MAX_DEPTH - 1))
 413
 414 /* Size of the freelist we allocate btree nodes from: */
 415 #define BTREE_NODE_RESERVE      (BTREE_RESERVE_MAX * 4)
 416
 417 #define BTREE_NODE_OPEN_BUCKET_RESERVE  (BTREE_RESERVE_MAX * BCH_REPLICAS_MAX)
 418
 419 struct btree;
 420
 421 enum gc_phase {
 422         GC_PHASE_NOT_RUNNING,
 423         GC_PHASE_START,
 424         GC_PHASE_SB,
 425
 426         GC_PHASE_BTREE_stripes,
 427         GC_PHASE_BTREE_extents,
 428         GC_PHASE_BTREE_inodes,
 429         GC_PHASE_BTREE_dirents,
 430         GC_PHASE_BTREE_xattrs,
 431         GC_PHASE_BTREE_alloc,
 432         GC_PHASE_BTREE_quotas,
 433         GC_PHASE_BTREE_reflink,
 434         GC_PHASE_BTREE_subvolumes,
 435         GC_PHASE_BTREE_snapshots,
 436         GC_PHASE_BTREE_lru,
 437         GC_PHASE_BTREE_freespace,
 438         GC_PHASE_BTREE_need_discard,
 439         GC_PHASE_BTREE_backpointers,
 440         GC_PHASE_BTREE_bucket_gens,
 441
 442         GC_PHASE_PENDING_DELETE,
 443 };
 444
 445 struct gc_pos {
 446         enum gc_phase           phase;
 447         struct bpos             pos;
 448         unsigned                level;
 449 };
 450
 451 struct reflink_gc {
 452         u64             offset;
 453         u32             size;
 454         u32             refcount;
 455 };
 456
 457 typedef GENRADIX(struct reflink_gc) reflink_gc_table;
 458
 459 struct io_count {
 460         u64                     sectors[2][BCH_DATA_NR];
 461 };
 462
 463 struct bch_dev {
 464         struct kobject          kobj;
 465         struct percpu_ref       ref;
 466         struct completion       ref_completion;
 467         struct percpu_ref       io_ref;
 468         struct completion       io_ref_completion;
 469
 470         struct bch_fs           *fs;
 471
 472         u8                      dev_idx;
 473         /*
 474          * Cached version of this device's member info from superblock
 475          * Committed by bch2_write_super() -> bch_fs_mi_update()
 476          */
 477         struct bch_member_cpu   mi;
 478         uuid_le                 uuid;
 479         char                    name[BDEVNAME_SIZE];
 480
 481         struct bch_sb_handle    disk_sb;
 482         struct bch_sb           *sb_read_scratch;
 483         int                     sb_write_error;
 484         dev_t                   dev;
 485         atomic_t                flush_seq;
 486
 487         struct bch_devs_mask    self;
 488
 489         /* biosets used in cloned bios for writing multiple replicas */
 490         struct bio_set          replica_set;
 491
 492         /*
 493          * Buckets:
 494          * Per-bucket arrays are protected by c->mark_lock, bucket_lock and
 495          * gc_lock, for device resize - holding any is sufficient for access:
 496          * Or rcu_read_lock(), but only for ptr_stale():
 497          */
 498         struct bucket_array __rcu *buckets_gc;
 499         struct bucket_gens __rcu *bucket_gens;
 500         u8                      *oldest_gen;
 501         unsigned long           *buckets_nouse;
 502         struct rw_semaphore     bucket_lock;
 503
 504         struct bch_dev_usage            *usage_base;
 505         struct bch_dev_usage __percpu   *usage[JOURNAL_BUF_NR];
 506         struct bch_dev_usage __percpu   *usage_gc;
 507
 508         /* Allocator: */
 509         u64                     new_fs_bucket_idx;
 510         u64                     alloc_cursor;
 511
 512         unsigned                nr_open_buckets;
 513         unsigned                nr_btree_reserve;
 514
 515         open_bucket_idx_t       open_buckets_partial[OPEN_BUCKETS_COUNT];
 516         open_bucket_idx_t       open_buckets_partial_nr;
 517
 518         size_t                  inc_gen_needs_gc;
 519         size_t                  inc_gen_really_needs_gc;
 520         size_t                  buckets_waiting_on_journal;
 521
 522         atomic64_t              rebalance_work;
 523
 524         struct journal_device   journal;
 525         u64                     prev_journal_sector;
 526
 527         struct work_struct      io_error_work;
 528
 529         /* The rest of this all shows up in sysfs */
 530         atomic64_t              cur_latency[2];
 531         struct bch2_time_stats  io_latency[2];
 532
 533 #define CONGESTED_MAX           1024
 534         atomic_t                congested;
 535         u64                     congested_last;
 536
 537         struct io_count __percpu *io_done;
 538 };
 539
 540 enum {
 541         /* startup: */
 542         BCH_FS_STARTED,
 543         BCH_FS_MAY_GO_RW,
 544         BCH_FS_RW,
 545         BCH_FS_WAS_RW,
 546
 547         /* shutdown: */
 548         BCH_FS_STOPPING,
 549         BCH_FS_EMERGENCY_RO,
 550         BCH_FS_GOING_RO,
 551         BCH_FS_WRITE_DISABLE_COMPLETE,
 552         BCH_FS_CLEAN_SHUTDOWN,
 553
 554         /* fsck passes: */
 555         BCH_FS_TOPOLOGY_REPAIR_DONE,
 556         BCH_FS_INITIAL_GC_DONE,         /* kill when we enumerate fsck passes */
 557         BCH_FS_CHECK_ALLOC_DONE,
 558         BCH_FS_CHECK_LRUS_DONE,
 559         BCH_FS_CHECK_BACKPOINTERS_DONE,
 560         BCH_FS_CHECK_ALLOC_TO_LRU_REFS_DONE,
 561         BCH_FS_FSCK_DONE,
 562         BCH_FS_INITIAL_GC_UNFIXED,      /* kill when we enumerate fsck errors */
 563         BCH_FS_NEED_ANOTHER_GC,
 564
 565         BCH_FS_HAVE_DELETED_SNAPSHOTS,
 566
 567         /* errors: */
 568         BCH_FS_ERROR,
 569         BCH_FS_TOPOLOGY_ERROR,
 570         BCH_FS_ERRORS_FIXED,
 571         BCH_FS_ERRORS_NOT_FIXED,
 572 };
 573
 574 struct btree_debug {
 575         unsigned                id;
 576 };
 577
 578 #define BCH_TRANSACTIONS_NR 128
 579
 580 struct btree_transaction_stats {
 581         struct bch2_time_stats  lock_hold_times;
 582         struct mutex            lock;
 583         unsigned                nr_max_paths;
 584         unsigned                max_mem;
 585         char                    *max_paths_text;
 586 };
 587
 588 struct bch_fs_pcpu {
 589         u64                     sectors_available;
 590 };
 591
 592 struct journal_seq_blacklist_table {
 593         size_t                  nr;
 594         struct journal_seq_blacklist_table_entry {
 595                 u64             start;
 596                 u64             end;
 597                 bool            dirty;
 598         }                       entries[0];
 599 };
 600
 601 struct journal_keys {
 602         struct journal_key {
 603                 u64             journal_seq;
 604                 u32             journal_offset;
 605                 enum btree_id   btree_id:8;
 606                 unsigned        level:8;
 607                 bool            allocated;
 608                 bool            overwritten;
 609                 struct bkey_i   *k;
 610         }                       *d;
 611         /*
 612          * Gap buffer: instead of all the empty space in the array being at the
 613          * end of the buffer - from @nr to @size - the empty space is at @gap.
 614          * This means that sequential insertions are O(n) instead of O(n^2).
 615          */
 616         size_t                  gap;
 617         size_t                  nr;
 618         size_t                  size;
 619 };
 620
 621 struct btree_path_buf {
 622         struct btree_path       *path;
 623 };
 624
 625 #define REPLICAS_DELTA_LIST_MAX (1U << 16)
 626
 627 struct snapshot_t {
 628         u32                     parent;
 629         u32                     children[2];
 630         u32                     subvol; /* Nonzero only if a subvolume points to this node: */
 631         u32                     equiv;
 632 };
 633
 634 typedef struct {
 635         u32             subvol;
 636         u64             inum;
 637 } subvol_inum;
 638
 639 #define BCACHEFS_ROOT_SUBVOL_INUM                                       \
 640         ((subvol_inum) { BCACHEFS_ROOT_SUBVOL,  BCACHEFS_ROOT_INO })
 641
 642 #define BCH_WRITE_REFS()                                                \
 643         x(trans)                                                        \
 644         x(write)                                                        \
 645         x(promote)                                                      \
 646         x(node_rewrite)                                                 \
 647         x(stripe_create)                                                \
 648         x(stripe_delete)                                                \
 649         x(reflink)                                                      \
 650         x(fallocate)                                                    \
 651         x(discard)                                                      \
 652         x(invalidate)                                                   \
 653         x(move)                                                         \
 654         x(delete_dead_snapshots)                                        \
 655         x(snapshot_delete_pagecache)                                    \
 656         x(sysfs)
 657
 658 enum bch_write_ref {
 659 #define x(n) BCH_WRITE_REF_##n,
 660         BCH_WRITE_REFS()
 661 #undef x
 662         BCH_WRITE_REF_NR,
 663 };
 664
 665 struct bch_fs {
 666         struct closure          cl;
 667
 668         struct list_head        list;
 669         struct kobject          kobj;
 670         struct kobject          counters_kobj;
 671         struct kobject          internal;
 672         struct kobject          opts_dir;
 673         struct kobject          time_stats;
 674         unsigned long           flags;
 675
 676         int                     minor;
 677         struct device           *chardev;
 678         struct super_block      *vfs_sb;
 679         dev_t                   dev;
 680         char                    name[40];
 681
 682         /* ro/rw, add/remove/resize devices: */
 683         struct rw_semaphore     state_lock;
 684
 685         /* Counts outstanding writes, for clean transition to read-only */
 686 #ifdef BCH_WRITE_REF_DEBUG
 687         atomic_long_t           writes[BCH_WRITE_REF_NR];
 688 #else
 689         struct percpu_ref       writes;
 690 #endif
 691         struct work_struct      read_only_work;
 692
 693         struct bch_dev __rcu    *devs[BCH_SB_MEMBERS_MAX];
 694
 695         struct bch_replicas_cpu replicas;
 696         struct bch_replicas_cpu replicas_gc;
 697         struct mutex            replicas_gc_lock;
 698         mempool_t               replicas_delta_pool;
 699
 700         struct journal_entry_res btree_root_journal_res;
 701         struct journal_entry_res replicas_journal_res;
 702         struct journal_entry_res clock_journal_res;
 703         struct journal_entry_res dev_usage_journal_res;
 704
 705         struct bch_disk_groups_cpu __rcu *disk_groups;
 706
 707         struct bch_opts         opts;
 708
 709         /* Updated by bch2_sb_update():*/
 710         struct {
 711                 uuid_le         uuid;
 712                 uuid_le         user_uuid;
 713
 714                 u16             version;
 715                 u16             version_min;
 716
 717                 u8              nr_devices;
 718                 u8              clean;
 719
 720                 u8              encryption_type;
 721
 722                 u64             time_base_lo;
 723                 u32             time_base_hi;
 724                 unsigned        time_units_per_sec;
 725                 unsigned        nsec_per_time_unit;
 726                 u64             features;
 727                 u64             compat;
 728         }                       sb;
 729
 730
 731         struct bch_sb_handle    disk_sb;
 732
 733         unsigned short          block_bits;     /* ilog2(block_size) */
 734
 735         u16                     btree_foreground_merge_threshold;
 736
 737         struct closure          sb_write;
 738         struct mutex            sb_lock;
 739
 740         /* snapshot.c: */
 741         GENRADIX(struct snapshot_t) snapshots;
 742         struct bch_snapshot_table __rcu *snapshot_table;
 743         struct mutex            snapshot_table_lock;
 744         struct work_struct      snapshot_delete_work;
 745         struct work_struct      snapshot_wait_for_pagecache_and_delete_work;
 746         snapshot_id_list        snapshots_unlinked;
 747         struct mutex            snapshots_unlinked_lock;
 748
 749         /* BTREE CACHE */
 750         struct bio_set          btree_bio;
 751         struct workqueue_struct *io_complete_wq;
 752
 753         struct btree_root       btree_roots[BTREE_ID_NR];
 754         struct mutex            btree_root_lock;
 755
 756         struct btree_cache      btree_cache;
 757
 758         /*
 759          * Cache of allocated btree nodes - if we allocate a btree node and
 760          * don't use it, if we free it that space can't be reused until going
 761          * _all_ the way through the allocator (which exposes us to a livelock
 762          * when allocating btree reserves fail halfway through) - instead, we
 763          * can stick them here:
 764          */
 765         struct btree_alloc      btree_reserve_cache[BTREE_NODE_RESERVE * 2];
 766         unsigned                btree_reserve_cache_nr;
 767         struct mutex            btree_reserve_cache_lock;
 768
 769         mempool_t               btree_interior_update_pool;
 770         struct list_head        btree_interior_update_list;
 771         struct list_head        btree_interior_updates_unwritten;
 772         struct mutex            btree_interior_update_lock;
 773         struct closure_waitlist btree_interior_update_wait;
 774
 775         struct workqueue_struct *btree_interior_update_worker;
 776         struct work_struct      btree_interior_update_work;
 777
 778         /* btree_io.c: */
 779         spinlock_t              btree_write_error_lock;
 780         struct btree_write_stats {
 781                 atomic64_t      nr;
 782                 atomic64_t      bytes;
 783         }                       btree_write_stats[BTREE_WRITE_TYPE_NR];
 784
 785         /* btree_iter.c: */
 786         struct mutex            btree_trans_lock;
 787         struct list_head        btree_trans_list;
 788         mempool_t               btree_paths_pool;
 789         mempool_t               btree_trans_mem_pool;
 790         struct btree_path_buf  __percpu *btree_paths_bufs;
 791
 792         struct srcu_struct      btree_trans_barrier;
 793         bool                    btree_trans_barrier_initialized;
 794
 795         struct btree_key_cache  btree_key_cache;
 796         unsigned                btree_key_cache_btrees;
 797
 798         struct workqueue_struct *btree_update_wq;
 799         struct workqueue_struct *btree_io_complete_wq;
 800         /* copygc needs its own workqueue for index updates.. */
 801         struct workqueue_struct *copygc_wq;
 802
 803         /* ALLOCATION */
 804         struct bch_devs_mask    rw_devs[BCH_DATA_NR];
 805
 806         u64                     capacity; /* sectors */
 807
 808         /*
 809          * When capacity _decreases_ (due to a disk being removed), we
 810          * increment capacity_gen - this invalidates outstanding reservations
 811          * and forces them to be revalidated
 812          */
 813         u32                     capacity_gen;
 814         unsigned                bucket_size_max;
 815
 816         atomic64_t              sectors_available;
 817         struct mutex            sectors_available_lock;
 818
 819         struct bch_fs_pcpu __percpu     *pcpu;
 820
 821         struct percpu_rw_semaphore      mark_lock;
 822
 823         seqcount_t                      usage_lock;
 824         struct bch_fs_usage             *usage_base;
 825         struct bch_fs_usage __percpu    *usage[JOURNAL_BUF_NR];
 826         struct bch_fs_usage __percpu    *usage_gc;
 827         u64 __percpu            *online_reserved;
 828
 829         /* single element mempool: */
 830         struct mutex            usage_scratch_lock;
 831         struct bch_fs_usage_online *usage_scratch;
 832
 833         struct io_clock         io_clock[2];
 834
 835         /* JOURNAL SEQ BLACKLIST */
 836         struct journal_seq_blacklist_table *
 837                                 journal_seq_blacklist_table;
 838         struct work_struct      journal_seq_blacklist_gc_work;
 839
 840         /* ALLOCATOR */
 841         spinlock_t              freelist_lock;
 842         struct closure_waitlist freelist_wait;
 843         u64                     blocked_allocate;
 844         u64                     blocked_allocate_open_bucket;
 845
 846         open_bucket_idx_t       open_buckets_freelist;
 847         open_bucket_idx_t       open_buckets_nr_free;
 848         struct closure_waitlist open_buckets_wait;
 849         struct open_bucket      open_buckets[OPEN_BUCKETS_COUNT];
 850         open_bucket_idx_t       open_buckets_hash[OPEN_BUCKETS_COUNT];
 851
 852         struct write_point      btree_write_point;
 853         struct write_point      rebalance_write_point;
 854
 855         struct write_point      write_points[WRITE_POINT_MAX];
 856         struct hlist_head       write_points_hash[WRITE_POINT_HASH_NR];
 857         struct mutex            write_points_hash_lock;
 858         unsigned                write_points_nr;
 859
 860         struct buckets_waiting_for_journal buckets_waiting_for_journal;
 861         struct work_struct      discard_work;
 862         struct work_struct      invalidate_work;
 863
 864         /* GARBAGE COLLECTION */
 865         struct task_struct      *gc_thread;
 866         atomic_t                kick_gc;
 867         unsigned long           gc_count;
 868
 869         enum btree_id           gc_gens_btree;
 870         struct bpos             gc_gens_pos;
 871
 872         /*
 873          * Tracks GC's progress - everything in the range [ZERO_KEY..gc_cur_pos]
 874          * has been marked by GC.
 875          *
 876          * gc_cur_phase is a superset of btree_ids (BTREE_ID_extents etc.)
 877          *
 878          * Protected by gc_pos_lock. Only written to by GC thread, so GC thread
 879          * can read without a lock.
 880          */
 881         seqcount_t              gc_pos_lock;
 882         struct gc_pos           gc_pos;
 883
 884         /*
 885          * The allocation code needs gc_mark in struct bucket to be correct, but
 886          * it's not while a gc is in progress.
 887          */
 888         struct rw_semaphore     gc_lock;
 889         struct mutex            gc_gens_lock;
 890
 891         /* IO PATH */
 892         struct semaphore        io_in_flight;
 893         struct bio_set          bio_read;
 894         struct bio_set          bio_read_split;
 895         struct bio_set          bio_write;
 896         struct mutex            bio_bounce_pages_lock;
 897         mempool_t               bio_bounce_pages;
 898         struct bucket_nocow_lock_table
 899                                 nocow_locks;
 900         struct rhashtable       promote_table;
 901
 902         mempool_t               compression_bounce[2];
 903         mempool_t               compress_workspace[BCH_COMPRESSION_TYPE_NR];
 904         mempool_t               decompress_workspace;
 905         ZSTD_parameters         zstd_params;
 906
 907         struct crypto_shash     *sha256;
 908         struct crypto_sync_skcipher *chacha20;
 909         struct crypto_shash     *poly1305;
 910
 911         atomic64_t              key_version;
 912
 913         mempool_t               large_bkey_pool;
 914
 915         /* REBALANCE */
 916         struct bch_fs_rebalance rebalance;
 917
 918         /* COPYGC */
 919         struct task_struct      *copygc_thread;
 920         copygc_heap             copygc_heap;
 921         struct write_point      copygc_write_point;
 922         s64                     copygc_wait;
 923         bool                    copygc_running;
 924         wait_queue_head_t       copygc_running_wq;
 925
 926         /* DATA PROGRESS STATS */
 927         struct list_head        data_progress_list;
 928         struct mutex            data_progress_lock;
 929
 930         /* STRIPES: */
 931         GENRADIX(struct stripe) stripes;
 932         GENRADIX(struct gc_stripe) gc_stripes;
 933
 934         ec_stripes_heap         ec_stripes_heap;
 935         spinlock_t              ec_stripes_heap_lock;
 936
 937         /* ERASURE CODING */
 938         struct list_head        ec_stripe_head_list;
 939         struct mutex            ec_stripe_head_lock;
 940
 941         struct list_head        ec_stripe_new_list;
 942         struct mutex            ec_stripe_new_lock;
 943
 944         struct work_struct      ec_stripe_create_work;
 945         u64                     ec_stripe_hint;
 946
 947         struct bio_set          ec_bioset;
 948
 949         struct work_struct      ec_stripe_delete_work;
 950         struct llist_head       ec_stripe_delete_list;
 951
 952         /* REFLINK */
 953         u64                     reflink_hint;
 954         reflink_gc_table        reflink_gc_table;
 955         size_t                  reflink_gc_nr;
 956
 957         /* VFS IO PATH - fs-io.c */
 958         struct bio_set          writepage_bioset;
 959         struct bio_set          dio_write_bioset;
 960         struct bio_set          dio_read_bioset;
 961         struct bio_set          nocow_flush_bioset;
 962
 963         /* ERRORS */
 964         struct list_head        fsck_errors;
 965         struct mutex            fsck_error_lock;
 966         bool                    fsck_alloc_err;
 967
 968         /* QUOTAS */
 969         struct bch_memquota_type quotas[QTYP_NR];
 970
 971         /* DEBUG JUNK */
 972         struct dentry           *fs_debug_dir;
 973         struct dentry           *btree_debug_dir;
 974         struct btree_debug      btree_debug[BTREE_ID_NR];
 975         struct btree            *verify_data;
 976         struct btree_node       *verify_ondisk;
 977         struct mutex            verify_lock;
 978
 979         u64                     *unused_inode_hints;
 980         unsigned                inode_shard_bits;
 981
 982         /*
 983          * A btree node on disk could have too many bsets for an iterator to fit
 984          * on the stack - have to dynamically allocate them
 985          */
 986         mempool_t               fill_iter;
 987
 988         mempool_t               btree_bounce_pool;
 989
 990         struct journal          journal;
 991         GENRADIX(struct journal_replay *) journal_entries;
 992         u64                     journal_entries_base_seq;
 993         struct journal_keys     journal_keys;
 994         struct list_head        journal_iters;
 995
 996         u64                     last_bucket_seq_cleanup;
 997
 998         u64                     counters_on_mount[BCH_COUNTER_NR];
 999         u64 __percpu            *counters;
1000
1001         unsigned                btree_gc_periodic:1;
1002         unsigned                copy_gc_enabled:1;
1003         bool                    promote_whole_extents;
1004
1005         struct bch2_time_stats  times[BCH_TIME_STAT_NR];
1006
1007         struct btree_transaction_stats btree_transaction_stats[BCH_TRANSACTIONS_NR];
1008 };
1009
1010 extern struct wait_queue_head bch2_read_only_wait;
1011
1012 static inline void bch2_write_ref_get(struct bch_fs *c, enum bch_write_ref ref)
1013 {
1014 #ifdef BCH_WRITE_REF_DEBUG
1015         atomic_long_inc(&c->writes[ref]);
1016 #else
1017         percpu_ref_get(&c->writes);
1018 #endif
1019 }
1020
1021 static inline bool bch2_write_ref_tryget(struct bch_fs *c, enum bch_write_ref ref)
1022 {
1023 #ifdef BCH_WRITE_REF_DEBUG
1024         return !test_bit(BCH_FS_GOING_RO, &c->flags) &&
1025                 atomic_long_inc_not_zero(&c->writes[ref]);
1026 #else
1027         return percpu_ref_tryget_live(&c->writes);
1028 #endif
1029 }
1030
1031 static inline void bch2_write_ref_put(struct bch_fs *c, enum bch_write_ref ref)
1032 {
1033 #ifdef BCH_WRITE_REF_DEBUG
1034         long v = atomic_long_dec_return(&c->writes[ref]);
1035
1036         BUG_ON(v < 0);
1037         if (v)
1038                 return;
1039         for (unsigned i = 0; i < BCH_WRITE_REF_NR; i++)
1040                 if (atomic_long_read(&c->writes[i]))
1041                         return;
1042
1043         set_bit(BCH_FS_WRITE_DISABLE_COMPLETE, &c->flags);
1044         wake_up(&bch2_read_only_wait);
1045 #else
1046         percpu_ref_put(&c->writes);
1047 #endif
1048 }
1049
1050 static inline void bch2_set_ra_pages(struct bch_fs *c, unsigned ra_pages)
1051 {
1052 #ifndef NO_BCACHEFS_FS
1053         if (c->vfs_sb)
1054                 c->vfs_sb->s_bdi->ra_pages = ra_pages;
1055 #endif
1056 }
1057
1058 static inline unsigned bucket_bytes(const struct bch_dev *ca)
1059 {
1060         return ca->mi.bucket_size << 9;
1061 }
1062
1063 static inline unsigned block_bytes(const struct bch_fs *c)
1064 {
1065         return c->opts.block_size;
1066 }
1067
1068 static inline unsigned block_sectors(const struct bch_fs *c)
1069 {
1070         return c->opts.block_size >> 9;
1071 }
1072
1073 static inline size_t btree_sectors(const struct bch_fs *c)
1074 {
1075         return c->opts.btree_node_size >> 9;
1076 }
1077
1078 static inline bool btree_id_cached(const struct bch_fs *c, enum btree_id btree)
1079 {
1080         return c->btree_key_cache_btrees & (1U << btree);
1081 }
1082
1083 static inline struct timespec64 bch2_time_to_timespec(const struct bch_fs *c, s64 time)
1084 {
1085         struct timespec64 t;
1086         s32 rem;
1087
1088         time += c->sb.time_base_lo;
1089
1090         t.tv_sec = div_s64_rem(time, c->sb.time_units_per_sec, &rem);
1091         t.tv_nsec = rem * c->sb.nsec_per_time_unit;
1092         return t;
1093 }
1094
1095 static inline s64 timespec_to_bch2_time(const struct bch_fs *c, struct timespec64 ts)
1096 {
1097         return (ts.tv_sec * c->sb.time_units_per_sec +
1098                 (int) ts.tv_nsec / c->sb.nsec_per_time_unit) - c->sb.time_base_lo;
1099 }
1100
1101 static inline s64 bch2_current_time(const struct bch_fs *c)
1102 {
1103         struct timespec64 now;
1104
1105         ktime_get_coarse_real_ts64(&now);
1106         return timespec_to_bch2_time(c, now);
1107 }
1108
1109 static inline bool bch2_dev_exists2(const struct bch_fs *c, unsigned dev)
1110 {
1111         return dev < c->sb.nr_devices && c->devs[dev];
1112 }
1113
1114 #endif /* _BCACHEFS_H */