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 "seqmutex.h"
 212 #include "util.h"
 213
 214 #ifdef CONFIG_BCACHEFS_DEBUG
 215 #define BCH_WRITE_REF_DEBUG
 216 #endif
 217
 218 #ifndef dynamic_fault
 219 #define dynamic_fault(...)              0
 220 #endif
 221
 222 #define race_fault(...)                 dynamic_fault("bcachefs:race")
 223
 224 #define trace_and_count(_c, _name, ...)                                 \
 225 do {                                                                    \
 226         this_cpu_inc((_c)->counters[BCH_COUNTER_##_name]);              \
 227         trace_##_name(__VA_ARGS__);                                     \
 228 } while (0)
 229
 230 #define bch2_fs_init_fault(name)                                        \
 231         dynamic_fault("bcachefs:bch_fs_init:" name)
 232 #define bch2_meta_read_fault(name)                                      \
 233          dynamic_fault("bcachefs:meta:read:" name)
 234 #define bch2_meta_write_fault(name)                                     \
 235          dynamic_fault("bcachefs:meta:write:" name)
 236
 237 #ifdef __KERNEL__
 238 #define BCACHEFS_LOG_PREFIX
 239 #endif
 240
 241 #ifdef BCACHEFS_LOG_PREFIX
 242
 243 #define bch2_log_msg(_c, fmt)                   "bcachefs (%s): " fmt, ((_c)->name)
 244 #define bch2_fmt_dev(_ca, fmt)                  "bcachefs (%s): " fmt "\n", ((_ca)->name)
 245 #define bch2_fmt_dev_offset(_ca, _offset, fmt)  "bcachefs (%s sector %llu): " fmt "\n", ((_ca)->name), (_offset)
 246 #define bch2_fmt_inum(_c, _inum, fmt)           "bcachefs (%s inum %llu): " fmt "\n", ((_c)->name), (_inum)
 247 #define bch2_fmt_inum_offset(_c, _inum, _offset, fmt)                   \
 248          "bcachefs (%s inum %llu offset %llu): " fmt "\n", ((_c)->name), (_inum), (_offset)
 249
 250 #else
 251
 252 #define bch2_log_msg(_c, fmt)                   fmt
 253 #define bch2_fmt_dev(_ca, fmt)                  "%s: " fmt "\n", ((_ca)->name)
 254 #define bch2_fmt_dev_offset(_ca, _offset, fmt)  "%s sector %llu: " fmt "\n", ((_ca)->name), (_offset)
 255 #define bch2_fmt_inum(_c, _inum, fmt)           "inum %llu: " fmt "\n", (_inum)
 256 #define bch2_fmt_inum_offset(_c, _inum, _offset, fmt)                           \
 257          "inum %llu offset %llu: " fmt "\n", (_inum), (_offset)
 258
 259 #endif
 260
 261 #define bch2_fmt(_c, fmt)               bch2_log_msg(_c, fmt "\n")
 262
 263 #define bch_info(c, fmt, ...) \
 264         printk(KERN_INFO bch2_fmt(c, fmt), ##__VA_ARGS__)
 265 #define bch_notice(c, fmt, ...) \
 266         printk(KERN_NOTICE bch2_fmt(c, fmt), ##__VA_ARGS__)
 267 #define bch_warn(c, fmt, ...) \
 268         printk(KERN_WARNING bch2_fmt(c, fmt), ##__VA_ARGS__)
 269 #define bch_warn_ratelimited(c, fmt, ...) \
 270         printk_ratelimited(KERN_WARNING bch2_fmt(c, fmt), ##__VA_ARGS__)
 271
 272 #define bch_err(c, fmt, ...) \
 273         printk(KERN_ERR bch2_fmt(c, fmt), ##__VA_ARGS__)
 274 #define bch_err_dev(ca, fmt, ...) \
 275         printk(KERN_ERR bch2_fmt_dev(ca, fmt), ##__VA_ARGS__)
 276 #define bch_err_dev_offset(ca, _offset, fmt, ...) \
 277         printk(KERN_ERR bch2_fmt_dev_offset(ca, _offset, fmt), ##__VA_ARGS__)
 278 #define bch_err_inum(c, _inum, fmt, ...) \
 279         printk(KERN_ERR bch2_fmt_inum(c, _inum, fmt), ##__VA_ARGS__)
 280 #define bch_err_inum_offset(c, _inum, _offset, fmt, ...) \
 281         printk(KERN_ERR bch2_fmt_inum_offset(c, _inum, _offset, fmt), ##__VA_ARGS__)
 282
 283 #define bch_err_ratelimited(c, fmt, ...) \
 284         printk_ratelimited(KERN_ERR bch2_fmt(c, fmt), ##__VA_ARGS__)
 285 #define bch_err_dev_ratelimited(ca, fmt, ...) \
 286         printk_ratelimited(KERN_ERR bch2_fmt_dev(ca, fmt), ##__VA_ARGS__)
 287 #define bch_err_dev_offset_ratelimited(ca, _offset, fmt, ...) \
 288         printk_ratelimited(KERN_ERR bch2_fmt_dev_offset(ca, _offset, fmt), ##__VA_ARGS__)
 289 #define bch_err_inum_ratelimited(c, _inum, fmt, ...) \
 290         printk_ratelimited(KERN_ERR bch2_fmt_inum(c, _inum, fmt), ##__VA_ARGS__)
 291 #define bch_err_inum_offset_ratelimited(c, _inum, _offset, fmt, ...) \
 292         printk_ratelimited(KERN_ERR bch2_fmt_inum_offset(c, _inum, _offset, fmt), ##__VA_ARGS__)
 293
 294 #define bch_err_fn(_c, _ret)                                            \
 295          bch_err(_c, "%s(): error %s", __func__, bch2_err_str(_ret))
 296 #define bch_err_msg(_c, _ret, _msg)                                     \
 297          bch_err(_c, "%s(): error " _msg " %s", __func__, bch2_err_str(_ret))
 298
 299 #define bch_verbose(c, fmt, ...)                                        \
 300 do {                                                                    \
 301         if ((c)->opts.verbose)                                          \
 302                 bch_info(c, fmt, ##__VA_ARGS__);                        \
 303 } while (0)
 304
 305 #define pr_verbose_init(opts, fmt, ...)                                 \
 306 do {                                                                    \
 307         if (opt_get(opts, verbose))                                     \
 308                 pr_info(fmt, ##__VA_ARGS__);                            \
 309 } while (0)
 310
 311 /* Parameters that are useful for debugging, but should always be compiled in: */
 312 #define BCH_DEBUG_PARAMS_ALWAYS()                                       \
 313         BCH_DEBUG_PARAM(key_merging_disabled,                           \
 314                 "Disables merging of extents")                          \
 315         BCH_DEBUG_PARAM(btree_gc_always_rewrite,                        \
 316                 "Causes mark and sweep to compact and rewrite every "   \
 317                 "btree node it traverses")                              \
 318         BCH_DEBUG_PARAM(btree_gc_rewrite_disabled,                      \
 319                 "Disables rewriting of btree nodes during mark and sweep")\
 320         BCH_DEBUG_PARAM(btree_shrinker_disabled,                        \
 321                 "Disables the shrinker callback for the btree node cache")\
 322         BCH_DEBUG_PARAM(verify_btree_ondisk,                            \
 323                 "Reread btree nodes at various points to verify the "   \
 324                 "mergesort in the read path against modifications "     \
 325                 "done in memory")                                       \
 326         BCH_DEBUG_PARAM(verify_all_btree_replicas,                      \
 327                 "When reading btree nodes, read all replicas and "      \
 328                 "compare them")                                         \
 329         BCH_DEBUG_PARAM(backpointers_no_use_write_buffer,               \
 330                 "Don't use the write buffer for backpointers, enabling "\
 331                 "extra runtime checks")
 332
 333 /* Parameters that should only be compiled in debug mode: */
 334 #define BCH_DEBUG_PARAMS_DEBUG()                                        \
 335         BCH_DEBUG_PARAM(expensive_debug_checks,                         \
 336                 "Enables various runtime debugging checks that "        \
 337                 "significantly affect performance")                     \
 338         BCH_DEBUG_PARAM(debug_check_iterators,                          \
 339                 "Enables extra verification for btree iterators")       \
 340         BCH_DEBUG_PARAM(debug_check_btree_accounting,                   \
 341                 "Verify btree accounting for keys within a node")       \
 342         BCH_DEBUG_PARAM(journal_seq_verify,                             \
 343                 "Store the journal sequence number in the version "     \
 344                 "number of every btree key, and verify that btree "     \
 345                 "update ordering is preserved during recovery")         \
 346         BCH_DEBUG_PARAM(inject_invalid_keys,                            \
 347                 "Store the journal sequence number in the version "     \
 348                 "number of every btree key, and verify that btree "     \
 349                 "update ordering is preserved during recovery")         \
 350         BCH_DEBUG_PARAM(test_alloc_startup,                             \
 351                 "Force allocator startup to use the slowpath where it"  \
 352                 "can't find enough free buckets without invalidating"   \
 353                 "cached data")                                          \
 354         BCH_DEBUG_PARAM(force_reconstruct_read,                         \
 355                 "Force reads to use the reconstruct path, when reading" \
 356                 "from erasure coded extents")                           \
 357         BCH_DEBUG_PARAM(test_restart_gc,                                \
 358                 "Test restarting mark and sweep gc when bucket gens change")
 359
 360 #define BCH_DEBUG_PARAMS_ALL() BCH_DEBUG_PARAMS_ALWAYS() BCH_DEBUG_PARAMS_DEBUG()
 361
 362 #ifdef CONFIG_BCACHEFS_DEBUG
 363 #define BCH_DEBUG_PARAMS() BCH_DEBUG_PARAMS_ALL()
 364 #else
 365 #define BCH_DEBUG_PARAMS() BCH_DEBUG_PARAMS_ALWAYS()
 366 #endif
 367
 368 #define BCH_DEBUG_PARAM(name, description) extern bool bch2_##name;
 369 BCH_DEBUG_PARAMS()
 370 #undef BCH_DEBUG_PARAM
 371
 372 #ifndef CONFIG_BCACHEFS_DEBUG
 373 #define BCH_DEBUG_PARAM(name, description) static const bool bch2_##name;
 374 BCH_DEBUG_PARAMS_DEBUG()
 375 #undef BCH_DEBUG_PARAM
 376 #endif
 377
 378 #define BCH_TIME_STATS()                        \
 379         x(btree_node_mem_alloc)                 \
 380         x(btree_node_split)                     \
 381         x(btree_node_compact)                   \
 382         x(btree_node_merge)                     \
 383         x(btree_node_sort)                      \
 384         x(btree_node_read)                      \
 385         x(btree_interior_update_foreground)     \
 386         x(btree_interior_update_total)          \
 387         x(btree_gc)                             \
 388         x(data_write)                           \
 389         x(data_read)                            \
 390         x(data_promote)                         \
 391         x(journal_flush_write)                  \
 392         x(journal_noflush_write)                \
 393         x(journal_flush_seq)                    \
 394         x(blocked_journal)                      \
 395         x(blocked_allocate)                     \
 396         x(blocked_allocate_open_bucket)         \
 397         x(nocow_lock_contended)
 398
 399 enum bch_time_stats {
 400 #define x(name) BCH_TIME_##name,
 401         BCH_TIME_STATS()
 402 #undef x
 403         BCH_TIME_STAT_NR
 404 };
 405
 406 #include "alloc_types.h"
 407 #include "btree_types.h"
 408 #include "btree_write_buffer_types.h"
 409 #include "buckets_types.h"
 410 #include "buckets_waiting_for_journal_types.h"
 411 #include "clock_types.h"
 412 #include "ec_types.h"
 413 #include "journal_types.h"
 414 #include "keylist_types.h"
 415 #include "quota_types.h"
 416 #include "rebalance_types.h"
 417 #include "replicas_types.h"
 418 #include "subvolume_types.h"
 419 #include "super_types.h"
 420
 421 /* Number of nodes btree coalesce will try to coalesce at once */
 422 #define GC_MERGE_NODES          4U
 423
 424 /* Maximum number of nodes we might need to allocate atomically: */
 425 #define BTREE_RESERVE_MAX       (BTREE_MAX_DEPTH + (BTREE_MAX_DEPTH - 1))
 426
 427 /* Size of the freelist we allocate btree nodes from: */
 428 #define BTREE_NODE_RESERVE      (BTREE_RESERVE_MAX * 4)
 429
 430 #define BTREE_NODE_OPEN_BUCKET_RESERVE  (BTREE_RESERVE_MAX * BCH_REPLICAS_MAX)
 431
 432 struct btree;
 433
 434 enum gc_phase {
 435         GC_PHASE_NOT_RUNNING,
 436         GC_PHASE_START,
 437         GC_PHASE_SB,
 438
 439         GC_PHASE_BTREE_stripes,
 440         GC_PHASE_BTREE_extents,
 441         GC_PHASE_BTREE_inodes,
 442         GC_PHASE_BTREE_dirents,
 443         GC_PHASE_BTREE_xattrs,
 444         GC_PHASE_BTREE_alloc,
 445         GC_PHASE_BTREE_quotas,
 446         GC_PHASE_BTREE_reflink,
 447         GC_PHASE_BTREE_subvolumes,
 448         GC_PHASE_BTREE_snapshots,
 449         GC_PHASE_BTREE_lru,
 450         GC_PHASE_BTREE_freespace,
 451         GC_PHASE_BTREE_need_discard,
 452         GC_PHASE_BTREE_backpointers,
 453         GC_PHASE_BTREE_bucket_gens,
 454         GC_PHASE_BTREE_snapshot_trees,
 455
 456         GC_PHASE_PENDING_DELETE,
 457 };
 458
 459 struct gc_pos {
 460         enum gc_phase           phase;
 461         struct bpos             pos;
 462         unsigned                level;
 463 };
 464
 465 struct reflink_gc {
 466         u64             offset;
 467         u32             size;
 468         u32             refcount;
 469 };
 470
 471 typedef GENRADIX(struct reflink_gc) reflink_gc_table;
 472
 473 struct io_count {
 474         u64                     sectors[2][BCH_DATA_NR];
 475 };
 476
 477 struct bch_dev {
 478         struct kobject          kobj;
 479         struct percpu_ref       ref;
 480         struct completion       ref_completion;
 481         struct percpu_ref       io_ref;
 482         struct completion       io_ref_completion;
 483
 484         struct bch_fs           *fs;
 485
 486         u8                      dev_idx;
 487         /*
 488          * Cached version of this device's member info from superblock
 489          * Committed by bch2_write_super() -> bch_fs_mi_update()
 490          */
 491         struct bch_member_cpu   mi;
 492         __uuid_t                uuid;
 493         char                    name[BDEVNAME_SIZE];
 494
 495         struct bch_sb_handle    disk_sb;
 496         struct bch_sb           *sb_read_scratch;
 497         int                     sb_write_error;
 498         dev_t                   dev;
 499         atomic_t                flush_seq;
 500
 501         struct bch_devs_mask    self;
 502
 503         /* biosets used in cloned bios for writing multiple replicas */
 504         struct bio_set          replica_set;
 505
 506         /*
 507          * Buckets:
 508          * Per-bucket arrays are protected by c->mark_lock, bucket_lock and
 509          * gc_lock, for device resize - holding any is sufficient for access:
 510          * Or rcu_read_lock(), but only for ptr_stale():
 511          */
 512         struct bucket_array __rcu *buckets_gc;
 513         struct bucket_gens __rcu *bucket_gens;
 514         u8                      *oldest_gen;
 515         unsigned long           *buckets_nouse;
 516         struct rw_semaphore     bucket_lock;
 517
 518         struct bch_dev_usage            *usage_base;
 519         struct bch_dev_usage __percpu   *usage[JOURNAL_BUF_NR];
 520         struct bch_dev_usage __percpu   *usage_gc;
 521
 522         /* Allocator: */
 523         u64                     new_fs_bucket_idx;
 524         u64                     alloc_cursor;
 525
 526         unsigned                nr_open_buckets;
 527         unsigned                nr_btree_reserve;
 528
 529         size_t                  inc_gen_needs_gc;
 530         size_t                  inc_gen_really_needs_gc;
 531         size_t                  buckets_waiting_on_journal;
 532
 533         atomic64_t              rebalance_work;
 534
 535         struct journal_device   journal;
 536         u64                     prev_journal_sector;
 537
 538         struct work_struct      io_error_work;
 539
 540         /* The rest of this all shows up in sysfs */
 541         atomic64_t              cur_latency[2];
 542         struct bch2_time_stats  io_latency[2];
 543
 544 #define CONGESTED_MAX           1024
 545         atomic_t                congested;
 546         u64                     congested_last;
 547
 548         struct io_count __percpu *io_done;
 549 };
 550
 551 enum {
 552         /* startup: */
 553         BCH_FS_STARTED,
 554         BCH_FS_MAY_GO_RW,
 555         BCH_FS_RW,
 556         BCH_FS_WAS_RW,
 557
 558         /* shutdown: */
 559         BCH_FS_STOPPING,
 560         BCH_FS_EMERGENCY_RO,
 561         BCH_FS_GOING_RO,
 562         BCH_FS_WRITE_DISABLE_COMPLETE,
 563         BCH_FS_CLEAN_SHUTDOWN,
 564
 565         /* fsck passes: */
 566         BCH_FS_TOPOLOGY_REPAIR_DONE,
 567         BCH_FS_INITIAL_GC_DONE,         /* kill when we enumerate fsck passes */
 568         BCH_FS_CHECK_ALLOC_DONE,
 569         BCH_FS_CHECK_LRUS_DONE,
 570         BCH_FS_CHECK_BACKPOINTERS_DONE,
 571         BCH_FS_CHECK_ALLOC_TO_LRU_REFS_DONE,
 572         BCH_FS_FSCK_DONE,
 573         BCH_FS_INITIAL_GC_UNFIXED,      /* kill when we enumerate fsck errors */
 574         BCH_FS_NEED_ANOTHER_GC,
 575
 576         BCH_FS_HAVE_DELETED_SNAPSHOTS,
 577
 578         /* errors: */
 579         BCH_FS_ERROR,
 580         BCH_FS_TOPOLOGY_ERROR,
 581         BCH_FS_ERRORS_FIXED,
 582         BCH_FS_ERRORS_NOT_FIXED,
 583 };
 584
 585 struct btree_debug {
 586         unsigned                id;
 587 };
 588
 589 #define BCH_TRANSACTIONS_NR 128
 590
 591 struct btree_transaction_stats {
 592         struct bch2_time_stats  lock_hold_times;
 593         struct mutex            lock;
 594         unsigned                nr_max_paths;
 595         unsigned                wb_updates_size;
 596         unsigned                max_mem;
 597         char                    *max_paths_text;
 598 };
 599
 600 struct bch_fs_pcpu {
 601         u64                     sectors_available;
 602 };
 603
 604 struct journal_seq_blacklist_table {
 605         size_t                  nr;
 606         struct journal_seq_blacklist_table_entry {
 607                 u64             start;
 608                 u64             end;
 609                 bool            dirty;
 610         }                       entries[0];
 611 };
 612
 613 struct journal_keys {
 614         struct journal_key {
 615                 u64             journal_seq;
 616                 u32             journal_offset;
 617                 enum btree_id   btree_id:8;
 618                 unsigned        level:8;
 619                 bool            allocated;
 620                 bool            overwritten;
 621                 struct bkey_i   *k;
 622         }                       *d;
 623         /*
 624          * Gap buffer: instead of all the empty space in the array being at the
 625          * end of the buffer - from @nr to @size - the empty space is at @gap.
 626          * This means that sequential insertions are O(n) instead of O(n^2).
 627          */
 628         size_t                  gap;
 629         size_t                  nr;
 630         size_t                  size;
 631 };
 632
 633 struct btree_path_buf {
 634         struct btree_path       *path;
 635 };
 636
 637 #define REPLICAS_DELTA_LIST_MAX (1U << 16)
 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(delete_dead_snapshots)                                        \
 654         x(snapshot_delete_pagecache)                                    \
 655         x(sysfs)
 656
 657 enum bch_write_ref {
 658 #define x(n) BCH_WRITE_REF_##n,
 659         BCH_WRITE_REFS()
 660 #undef x
 661         BCH_WRITE_REF_NR,
 662 };
 663
 664 struct bch_fs {
 665         struct closure          cl;
 666
 667         struct list_head        list;
 668         struct kobject          kobj;
 669         struct kobject          counters_kobj;
 670         struct kobject          internal;
 671         struct kobject          opts_dir;
 672         struct kobject          time_stats;
 673         unsigned long           flags;
 674
 675         int                     minor;
 676         struct device           *chardev;
 677         struct super_block      *vfs_sb;
 678         dev_t                   dev;
 679         char                    name[40];
 680
 681         /* ro/rw, add/remove/resize devices: */
 682         struct rw_semaphore     state_lock;
 683
 684         /* Counts outstanding writes, for clean transition to read-only */
 685 #ifdef BCH_WRITE_REF_DEBUG
 686         atomic_long_t           writes[BCH_WRITE_REF_NR];
 687 #else
 688         struct percpu_ref       writes;
 689 #endif
 690         struct work_struct      read_only_work;
 691
 692         struct bch_dev __rcu    *devs[BCH_SB_MEMBERS_MAX];
 693
 694         struct bch_replicas_cpu replicas;
 695         struct bch_replicas_cpu replicas_gc;
 696         struct mutex            replicas_gc_lock;
 697         mempool_t               replicas_delta_pool;
 698
 699         struct journal_entry_res btree_root_journal_res;
 700         struct journal_entry_res replicas_journal_res;
 701         struct journal_entry_res clock_journal_res;
 702         struct journal_entry_res dev_usage_journal_res;
 703
 704         struct bch_disk_groups_cpu __rcu *disk_groups;
 705
 706         struct bch_opts         opts;
 707
 708         /* Updated by bch2_sb_update():*/
 709         struct {
 710                 __uuid_t        uuid;
 711                 __uuid_t        user_uuid;
 712
 713                 u16             version;
 714                 u16             version_min;
 715
 716                 u8              nr_devices;
 717                 u8              clean;
 718
 719                 u8              encryption_type;
 720
 721                 u64             time_base_lo;
 722                 u32             time_base_hi;
 723                 unsigned        time_units_per_sec;
 724                 unsigned        nsec_per_time_unit;
 725                 u64             features;
 726                 u64             compat;
 727         }                       sb;
 728
 729
 730         struct bch_sb_handle    disk_sb;
 731
 732         unsigned short          block_bits;     /* ilog2(block_size) */
 733
 734         u16                     btree_foreground_merge_threshold;
 735
 736         struct closure          sb_write;
 737         struct mutex            sb_lock;
 738
 739         /* snapshot.c: */
 740         GENRADIX(struct snapshot_t) snapshots;
 741         struct bch_snapshot_table __rcu *snapshot_table;
 742         struct mutex            snapshot_table_lock;
 743         struct work_struct      snapshot_delete_work;
 744         struct work_struct      snapshot_wait_for_pagecache_and_delete_work;
 745         snapshot_id_list        snapshots_unlinked;
 746         struct mutex            snapshots_unlinked_lock;
 747
 748         /* BTREE CACHE */
 749         struct bio_set          btree_bio;
 750         struct workqueue_struct *io_complete_wq;
 751
 752         struct btree_root       btree_roots_known[BTREE_ID_NR];
 753         DARRAY(struct btree_root) btree_roots_extra;
 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         struct list_head        pending_node_rewrites;
 779         struct mutex            pending_node_rewrites_lock;
 780
 781         /* btree_io.c: */
 782         spinlock_t              btree_write_error_lock;
 783         struct btree_write_stats {
 784                 atomic64_t      nr;
 785                 atomic64_t      bytes;
 786         }                       btree_write_stats[BTREE_WRITE_TYPE_NR];
 787
 788         /* btree_iter.c: */
 789         struct seqmutex         btree_trans_lock;
 790         struct list_head        btree_trans_list;
 791         mempool_t               btree_paths_pool;
 792         mempool_t               btree_trans_mem_pool;
 793         struct btree_path_buf  __percpu *btree_paths_bufs;
 794
 795         struct srcu_struct      btree_trans_barrier;
 796         bool                    btree_trans_barrier_initialized;
 797
 798         struct btree_key_cache  btree_key_cache;
 799         unsigned                btree_key_cache_btrees;
 800
 801         struct btree_write_buffer btree_write_buffer;
 802
 803         struct workqueue_struct *btree_update_wq;
 804         struct workqueue_struct *btree_io_complete_wq;
 805         /* copygc needs its own workqueue for index updates.. */
 806         struct workqueue_struct *copygc_wq;
 807         /*
 808          * Use a dedicated wq for write ref holder tasks. Required to avoid
 809          * dependency problems with other wq tasks that can block on ref
 810          * draining, such as read-only transition.
 811          */
 812         struct workqueue_struct *write_ref_wq;
 813
 814         /* ALLOCATION */
 815         struct bch_devs_mask    rw_devs[BCH_DATA_NR];
 816
 817         u64                     capacity; /* sectors */
 818
 819         /*
 820          * When capacity _decreases_ (due to a disk being removed), we
 821          * increment capacity_gen - this invalidates outstanding reservations
 822          * and forces them to be revalidated
 823          */
 824         u32                     capacity_gen;
 825         unsigned                bucket_size_max;
 826
 827         atomic64_t              sectors_available;
 828         struct mutex            sectors_available_lock;
 829
 830         struct bch_fs_pcpu __percpu     *pcpu;
 831
 832         struct percpu_rw_semaphore      mark_lock;
 833
 834         seqcount_t                      usage_lock;
 835         struct bch_fs_usage             *usage_base;
 836         struct bch_fs_usage __percpu    *usage[JOURNAL_BUF_NR];
 837         struct bch_fs_usage __percpu    *usage_gc;
 838         u64 __percpu            *online_reserved;
 839
 840         /* single element mempool: */
 841         struct mutex            usage_scratch_lock;
 842         struct bch_fs_usage_online *usage_scratch;
 843
 844         struct io_clock         io_clock[2];
 845
 846         /* JOURNAL SEQ BLACKLIST */
 847         struct journal_seq_blacklist_table *
 848                                 journal_seq_blacklist_table;
 849         struct work_struct      journal_seq_blacklist_gc_work;
 850
 851         /* ALLOCATOR */
 852         spinlock_t              freelist_lock;
 853         struct closure_waitlist freelist_wait;
 854         u64                     blocked_allocate;
 855         u64                     blocked_allocate_open_bucket;
 856
 857         open_bucket_idx_t       open_buckets_freelist;
 858         open_bucket_idx_t       open_buckets_nr_free;
 859         struct closure_waitlist open_buckets_wait;
 860         struct open_bucket      open_buckets[OPEN_BUCKETS_COUNT];
 861         open_bucket_idx_t       open_buckets_hash[OPEN_BUCKETS_COUNT];
 862
 863         open_bucket_idx_t       open_buckets_partial[OPEN_BUCKETS_COUNT];
 864         open_bucket_idx_t       open_buckets_partial_nr;
 865
 866         struct write_point      btree_write_point;
 867         struct write_point      rebalance_write_point;
 868
 869         struct write_point      write_points[WRITE_POINT_MAX];
 870         struct hlist_head       write_points_hash[WRITE_POINT_HASH_NR];
 871         struct mutex            write_points_hash_lock;
 872         unsigned                write_points_nr;
 873
 874         struct buckets_waiting_for_journal buckets_waiting_for_journal;
 875         struct work_struct      discard_work;
 876         struct work_struct      invalidate_work;
 877
 878         /* GARBAGE COLLECTION */
 879         struct task_struct      *gc_thread;
 880         atomic_t                kick_gc;
 881         unsigned long           gc_count;
 882
 883         enum btree_id           gc_gens_btree;
 884         struct bpos             gc_gens_pos;
 885
 886         /*
 887          * Tracks GC's progress - everything in the range [ZERO_KEY..gc_cur_pos]
 888          * has been marked by GC.
 889          *
 890          * gc_cur_phase is a superset of btree_ids (BTREE_ID_extents etc.)
 891          *
 892          * Protected by gc_pos_lock. Only written to by GC thread, so GC thread
 893          * can read without a lock.
 894          */
 895         seqcount_t              gc_pos_lock;
 896         struct gc_pos           gc_pos;
 897
 898         /*
 899          * The allocation code needs gc_mark in struct bucket to be correct, but
 900          * it's not while a gc is in progress.
 901          */
 902         struct rw_semaphore     gc_lock;
 903         struct mutex            gc_gens_lock;
 904
 905         /* IO PATH */
 906         struct semaphore        io_in_flight;
 907         struct bio_set          bio_read;
 908         struct bio_set          bio_read_split;
 909         struct bio_set          bio_write;
 910         struct mutex            bio_bounce_pages_lock;
 911         mempool_t               bio_bounce_pages;
 912         struct bucket_nocow_lock_table
 913                                 nocow_locks;
 914         struct rhashtable       promote_table;
 915
 916         mempool_t               compression_bounce[2];
 917         mempool_t               compress_workspace[BCH_COMPRESSION_TYPE_NR];
 918         mempool_t               decompress_workspace;
 919         ZSTD_parameters         zstd_params;
 920
 921         struct crypto_shash     *sha256;
 922         struct crypto_sync_skcipher *chacha20;
 923         struct crypto_shash     *poly1305;
 924
 925         atomic64_t              key_version;
 926
 927         mempool_t               large_bkey_pool;
 928
 929         /* MOVE.C */
 930         struct list_head        moving_context_list;
 931         struct mutex            moving_context_lock;
 932
 933         struct list_head        data_progress_list;
 934         struct mutex            data_progress_lock;
 935
 936         /* REBALANCE */
 937         struct bch_fs_rebalance rebalance;
 938
 939         /* COPYGC */
 940         struct task_struct      *copygc_thread;
 941         struct write_point      copygc_write_point;
 942         s64                     copygc_wait_at;
 943         s64                     copygc_wait;
 944         bool                    copygc_running;
 945         wait_queue_head_t       copygc_running_wq;
 946
 947         /* STRIPES: */
 948         GENRADIX(struct stripe) stripes;
 949         GENRADIX(struct gc_stripe) gc_stripes;
 950
 951         struct hlist_head       ec_stripes_new[32];
 952         spinlock_t              ec_stripes_new_lock;
 953
 954         ec_stripes_heap         ec_stripes_heap;
 955         struct mutex            ec_stripes_heap_lock;
 956
 957         /* ERASURE CODING */
 958         struct list_head        ec_stripe_head_list;
 959         struct mutex            ec_stripe_head_lock;
 960
 961         struct list_head        ec_stripe_new_list;
 962         struct mutex            ec_stripe_new_lock;
 963         wait_queue_head_t       ec_stripe_new_wait;
 964
 965         struct work_struct      ec_stripe_create_work;
 966         u64                     ec_stripe_hint;
 967
 968         struct work_struct      ec_stripe_delete_work;
 969
 970         struct bio_set          ec_bioset;
 971
 972         /* REFLINK */
 973         reflink_gc_table        reflink_gc_table;
 974         size_t                  reflink_gc_nr;
 975
 976         /* fs.c */
 977         struct list_head        vfs_inodes_list;
 978         struct mutex            vfs_inodes_lock;
 979
 980         /* VFS IO PATH - fs-io.c */
 981         struct bio_set          writepage_bioset;
 982         struct bio_set          dio_write_bioset;
 983         struct bio_set          dio_read_bioset;
 984         struct bio_set          nocow_flush_bioset;
 985
 986         /* ERRORS */
 987         struct list_head        fsck_errors;
 988         struct mutex            fsck_error_lock;
 989         bool                    fsck_alloc_err;
 990
 991         /* QUOTAS */
 992         struct bch_memquota_type quotas[QTYP_NR];
 993
 994         /* DEBUG JUNK */
 995         struct dentry           *fs_debug_dir;
 996         struct dentry           *btree_debug_dir;
 997         struct btree_debug      btree_debug[BTREE_ID_NR];
 998         struct btree            *verify_data;
 999         struct btree_node       *verify_ondisk;
1000         struct mutex            verify_lock;
1001
1002         u64                     *unused_inode_hints;
1003         unsigned                inode_shard_bits;
1004
1005         /*
1006          * A btree node on disk could have too many bsets for an iterator to fit
1007          * on the stack - have to dynamically allocate them
1008          */
1009         mempool_t               fill_iter;
1010
1011         mempool_t               btree_bounce_pool;
1012
1013         struct journal          journal;
1014         GENRADIX(struct journal_replay *) journal_entries;
1015         u64                     journal_entries_base_seq;
1016         struct journal_keys     journal_keys;
1017         struct list_head        journal_iters;
1018
1019         u64                     last_bucket_seq_cleanup;
1020
1021         u64                     counters_on_mount[BCH_COUNTER_NR];
1022         u64 __percpu            *counters;
1023
1024         unsigned                btree_gc_periodic:1;
1025         unsigned                copy_gc_enabled:1;
1026         bool                    promote_whole_extents;
1027
1028         struct bch2_time_stats  times[BCH_TIME_STAT_NR];
1029
1030         struct btree_transaction_stats btree_transaction_stats[BCH_TRANSACTIONS_NR];
1031 };
1032
1033 extern struct wait_queue_head bch2_read_only_wait;
1034
1035 static inline void bch2_write_ref_get(struct bch_fs *c, enum bch_write_ref ref)
1036 {
1037 #ifdef BCH_WRITE_REF_DEBUG
1038         atomic_long_inc(&c->writes[ref]);
1039 #else
1040         percpu_ref_get(&c->writes);
1041 #endif
1042 }
1043
1044 static inline bool bch2_write_ref_tryget(struct bch_fs *c, enum bch_write_ref ref)
1045 {
1046 #ifdef BCH_WRITE_REF_DEBUG
1047         return !test_bit(BCH_FS_GOING_RO, &c->flags) &&
1048                 atomic_long_inc_not_zero(&c->writes[ref]);
1049 #else
1050         return percpu_ref_tryget_live(&c->writes);
1051 #endif
1052 }
1053
1054 static inline void bch2_write_ref_put(struct bch_fs *c, enum bch_write_ref ref)
1055 {
1056 #ifdef BCH_WRITE_REF_DEBUG
1057         long v = atomic_long_dec_return(&c->writes[ref]);
1058
1059         BUG_ON(v < 0);
1060         if (v)
1061                 return;
1062         for (unsigned i = 0; i < BCH_WRITE_REF_NR; i++)
1063                 if (atomic_long_read(&c->writes[i]))
1064                         return;
1065
1066         set_bit(BCH_FS_WRITE_DISABLE_COMPLETE, &c->flags);
1067         wake_up(&bch2_read_only_wait);
1068 #else
1069         percpu_ref_put(&c->writes);
1070 #endif
1071 }
1072
1073 static inline void bch2_set_ra_pages(struct bch_fs *c, unsigned ra_pages)
1074 {
1075 #ifndef NO_BCACHEFS_FS
1076         if (c->vfs_sb)
1077                 c->vfs_sb->s_bdi->ra_pages = ra_pages;
1078 #endif
1079 }
1080
1081 static inline unsigned bucket_bytes(const struct bch_dev *ca)
1082 {
1083         return ca->mi.bucket_size << 9;
1084 }
1085
1086 static inline unsigned block_bytes(const struct bch_fs *c)
1087 {
1088         return c->opts.block_size;
1089 }
1090
1091 static inline unsigned block_sectors(const struct bch_fs *c)
1092 {
1093         return c->opts.block_size >> 9;
1094 }
1095
1096 static inline size_t btree_sectors(const struct bch_fs *c)
1097 {
1098         return c->opts.btree_node_size >> 9;
1099 }
1100
1101 static inline bool btree_id_cached(const struct bch_fs *c, enum btree_id btree)
1102 {
1103         return c->btree_key_cache_btrees & (1U << btree);
1104 }
1105
1106 static inline struct timespec64 bch2_time_to_timespec(const struct bch_fs *c, s64 time)
1107 {
1108         struct timespec64 t;
1109         s32 rem;
1110
1111         time += c->sb.time_base_lo;
1112
1113         t.tv_sec = div_s64_rem(time, c->sb.time_units_per_sec, &rem);
1114         t.tv_nsec = rem * c->sb.nsec_per_time_unit;
1115         return t;
1116 }
1117
1118 static inline s64 timespec_to_bch2_time(const struct bch_fs *c, struct timespec64 ts)
1119 {
1120         return (ts.tv_sec * c->sb.time_units_per_sec +
1121                 (int) ts.tv_nsec / c->sb.nsec_per_time_unit) - c->sb.time_base_lo;
1122 }
1123
1124 static inline s64 bch2_current_time(const struct bch_fs *c)
1125 {
1126         struct timespec64 now;
1127
1128         ktime_get_coarse_real_ts64(&now);
1129         return timespec_to_bch2_time(c, now);
1130 }
1131
1132 static inline bool bch2_dev_exists2(const struct bch_fs *c, unsigned dev)
1133 {
1134         return dev < c->sb.nr_devices && c->devs[dev];
1135 }
1136
1137 #define BKEY_PADDED_ONSTACK(key, pad)                           \
1138         struct { struct bkey_i key; __u64 key ## _pad[pad]; }
1139
1140 #endif /* _BCACHEFS_H */