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