]> git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/bcachefs.h
Update bcachefs sources to ca3cfad39f fixup! bcachefs: Improve iter->should_be_locked
[bcachefs-tools-debian] / 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 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 #define pr_fmt(fmt) "bcachefs: %s() " fmt "\n", __func__
181
182 #include <linux/bug.h>
183 #include <linux/bio.h>
184 #include <linux/closure.h>
185 #include <linux/kobject.h>
186 #include <linux/list.h>
187 #include <linux/math64.h>
188 #include <linux/mutex.h>
189 #include <linux/percpu-refcount.h>
190 #include <linux/percpu-rwsem.h>
191 #include <linux/rhashtable.h>
192 #include <linux/rwsem.h>
193 #include <linux/semaphore.h>
194 #include <linux/seqlock.h>
195 #include <linux/shrinker.h>
196 #include <linux/srcu.h>
197 #include <linux/types.h>
198 #include <linux/workqueue.h>
199 #include <linux/zstd.h>
200
201 #include "bcachefs_format.h"
202 #include "fifo.h"
203 #include "opts.h"
204 #include "util.h"
205
206 #define dynamic_fault(...)              0
207 #define race_fault(...)                 0
208
209 #define bch2_fs_init_fault(name)                                        \
210         dynamic_fault("bcachefs:bch_fs_init:" name)
211 #define bch2_meta_read_fault(name)                                      \
212          dynamic_fault("bcachefs:meta:read:" name)
213 #define bch2_meta_write_fault(name)                                     \
214          dynamic_fault("bcachefs:meta:write:" name)
215
216 #ifdef __KERNEL__
217 #define bch2_fmt(_c, fmt)               "bcachefs (%s): " fmt "\n", ((_c)->name)
218 #define bch2_fmt_inum(_c, _inum, fmt)   "bcachefs (%s inum %llu): " fmt "\n", ((_c)->name), (_inum)
219 #else
220 #define bch2_fmt(_c, fmt)               fmt "\n"
221 #define bch2_fmt_inum(_c, _inum, fmt)   "inum %llu: " fmt "\n", (_inum)
222 #endif
223
224 #define bch_info(c, fmt, ...) \
225         printk(KERN_INFO bch2_fmt(c, fmt), ##__VA_ARGS__)
226 #define bch_notice(c, fmt, ...) \
227         printk(KERN_NOTICE bch2_fmt(c, fmt), ##__VA_ARGS__)
228 #define bch_warn(c, fmt, ...) \
229         printk(KERN_WARNING bch2_fmt(c, fmt), ##__VA_ARGS__)
230 #define bch_warn_ratelimited(c, fmt, ...) \
231         printk_ratelimited(KERN_WARNING bch2_fmt(c, fmt), ##__VA_ARGS__)
232 #define bch_err(c, fmt, ...) \
233         printk(KERN_ERR bch2_fmt(c, fmt), ##__VA_ARGS__)
234
235 #define bch_err_ratelimited(c, fmt, ...) \
236         printk_ratelimited(KERN_ERR bch2_fmt(c, fmt), ##__VA_ARGS__)
237 #define bch_err_inum_ratelimited(c, _inum, fmt, ...) \
238         printk_ratelimited(KERN_ERR bch2_fmt_inum(c, _inum, fmt), ##__VA_ARGS__)
239
240 #define bch_verbose(c, fmt, ...)                                        \
241 do {                                                                    \
242         if ((c)->opts.verbose)                                          \
243                 bch_info(c, fmt, ##__VA_ARGS__);                        \
244 } while (0)
245
246 #define pr_verbose_init(opts, fmt, ...)                                 \
247 do {                                                                    \
248         if (opt_get(opts, verbose))                                     \
249                 pr_info(fmt, ##__VA_ARGS__);                            \
250 } while (0)
251
252 /* Parameters that are useful for debugging, but should always be compiled in: */
253 #define BCH_DEBUG_PARAMS_ALWAYS()                                       \
254         BCH_DEBUG_PARAM(key_merging_disabled,                           \
255                 "Disables merging of extents")                          \
256         BCH_DEBUG_PARAM(btree_gc_always_rewrite,                        \
257                 "Causes mark and sweep to compact and rewrite every "   \
258                 "btree node it traverses")                              \
259         BCH_DEBUG_PARAM(btree_gc_rewrite_disabled,                      \
260                 "Disables rewriting of btree nodes during mark and sweep")\
261         BCH_DEBUG_PARAM(btree_shrinker_disabled,                        \
262                 "Disables the shrinker callback for the btree node cache")\
263         BCH_DEBUG_PARAM(verify_btree_ondisk,                            \
264                 "Reread btree nodes at various points to verify the "   \
265                 "mergesort in the read path against modifications "     \
266                 "done in memory")                                       \
267         BCH_DEBUG_PARAM(verify_all_btree_replicas,                      \
268                 "When reading btree nodes, read all replicas and "      \
269                 "compare them")
270
271 /* Parameters that should only be compiled in in debug mode: */
272 #define BCH_DEBUG_PARAMS_DEBUG()                                        \
273         BCH_DEBUG_PARAM(expensive_debug_checks,                         \
274                 "Enables various runtime debugging checks that "        \
275                 "significantly affect performance")                     \
276         BCH_DEBUG_PARAM(debug_check_iterators,                          \
277                 "Enables extra verification for btree iterators")       \
278         BCH_DEBUG_PARAM(debug_check_bkeys,                              \
279                 "Run bkey_debugcheck (primarily checking GC/allocation "\
280                 "information) when iterating over keys")                \
281         BCH_DEBUG_PARAM(debug_check_btree_accounting,                   \
282                 "Verify btree accounting for keys within a node")       \
283         BCH_DEBUG_PARAM(journal_seq_verify,                             \
284                 "Store the journal sequence number in the version "     \
285                 "number of every btree key, and verify that btree "     \
286                 "update ordering is preserved during recovery")         \
287         BCH_DEBUG_PARAM(inject_invalid_keys,                            \
288                 "Store the journal sequence number in the version "     \
289                 "number of every btree key, and verify that btree "     \
290                 "update ordering is preserved during recovery")         \
291         BCH_DEBUG_PARAM(test_alloc_startup,                             \
292                 "Force allocator startup to use the slowpath where it"  \
293                 "can't find enough free buckets without invalidating"   \
294                 "cached data")                                          \
295         BCH_DEBUG_PARAM(force_reconstruct_read,                         \
296                 "Force reads to use the reconstruct path, when reading" \
297                 "from erasure coded extents")                           \
298         BCH_DEBUG_PARAM(test_restart_gc,                                \
299                 "Test restarting mark and sweep gc when bucket gens change")
300
301 #define BCH_DEBUG_PARAMS_ALL() BCH_DEBUG_PARAMS_ALWAYS() BCH_DEBUG_PARAMS_DEBUG()
302
303 #ifdef CONFIG_BCACHEFS_DEBUG
304 #define BCH_DEBUG_PARAMS() BCH_DEBUG_PARAMS_ALL()
305 #else
306 #define BCH_DEBUG_PARAMS() BCH_DEBUG_PARAMS_ALWAYS()
307 #endif
308
309 #define BCH_DEBUG_PARAM(name, description) extern bool bch2_##name;
310 BCH_DEBUG_PARAMS()
311 #undef BCH_DEBUG_PARAM
312
313 #ifndef CONFIG_BCACHEFS_DEBUG
314 #define BCH_DEBUG_PARAM(name, description) static const bool bch2_##name;
315 BCH_DEBUG_PARAMS_DEBUG()
316 #undef BCH_DEBUG_PARAM
317 #endif
318
319 #define BCH_TIME_STATS()                        \
320         x(btree_node_mem_alloc)                 \
321         x(btree_node_split)                     \
322         x(btree_node_sort)                      \
323         x(btree_node_read)                      \
324         x(btree_gc)                             \
325         x(btree_lock_contended_read)            \
326         x(btree_lock_contended_intent)          \
327         x(btree_lock_contended_write)           \
328         x(data_write)                           \
329         x(data_read)                            \
330         x(data_promote)                         \
331         x(journal_write)                        \
332         x(journal_delay)                        \
333         x(journal_flush_seq)                    \
334         x(blocked_journal)                      \
335         x(blocked_allocate)                     \
336         x(blocked_allocate_open_bucket)
337
338 enum bch_time_stats {
339 #define x(name) BCH_TIME_##name,
340         BCH_TIME_STATS()
341 #undef x
342         BCH_TIME_STAT_NR
343 };
344
345 #include "alloc_types.h"
346 #include "btree_types.h"
347 #include "buckets_types.h"
348 #include "clock_types.h"
349 #include "ec_types.h"
350 #include "journal_types.h"
351 #include "keylist_types.h"
352 #include "quota_types.h"
353 #include "rebalance_types.h"
354 #include "replicas_types.h"
355 #include "super_types.h"
356
357 /* Number of nodes btree coalesce will try to coalesce at once */
358 #define GC_MERGE_NODES          4U
359
360 /* Maximum number of nodes we might need to allocate atomically: */
361 #define BTREE_RESERVE_MAX       (BTREE_MAX_DEPTH + (BTREE_MAX_DEPTH - 1))
362
363 /* Size of the freelist we allocate btree nodes from: */
364 #define BTREE_NODE_RESERVE      (BTREE_RESERVE_MAX * 4)
365
366 #define BTREE_NODE_OPEN_BUCKET_RESERVE  (BTREE_RESERVE_MAX * BCH_REPLICAS_MAX)
367
368 struct btree;
369
370 enum gc_phase {
371         GC_PHASE_NOT_RUNNING,
372         GC_PHASE_START,
373         GC_PHASE_SB,
374
375         GC_PHASE_BTREE_stripes,
376         GC_PHASE_BTREE_extents,
377         GC_PHASE_BTREE_inodes,
378         GC_PHASE_BTREE_dirents,
379         GC_PHASE_BTREE_xattrs,
380         GC_PHASE_BTREE_alloc,
381         GC_PHASE_BTREE_quotas,
382         GC_PHASE_BTREE_reflink,
383
384         GC_PHASE_PENDING_DELETE,
385 };
386
387 struct gc_pos {
388         enum gc_phase           phase;
389         struct bpos             pos;
390         unsigned                level;
391 };
392
393 struct reflink_gc {
394         u64             offset;
395         u32             size;
396         u32             refcount;
397 };
398
399 typedef GENRADIX(struct reflink_gc) reflink_gc_table;
400
401 struct io_count {
402         u64                     sectors[2][BCH_DATA_NR];
403 };
404
405 struct bch_dev {
406         struct kobject          kobj;
407         struct percpu_ref       ref;
408         struct completion       ref_completion;
409         struct percpu_ref       io_ref;
410         struct completion       io_ref_completion;
411
412         struct bch_fs           *fs;
413
414         u8                      dev_idx;
415         /*
416          * Cached version of this device's member info from superblock
417          * Committed by bch2_write_super() -> bch_fs_mi_update()
418          */
419         struct bch_member_cpu   mi;
420         uuid_le                 uuid;
421         char                    name[BDEVNAME_SIZE];
422
423         struct bch_sb_handle    disk_sb;
424         struct bch_sb           *sb_read_scratch;
425         int                     sb_write_error;
426
427         struct bch_devs_mask    self;
428
429         /* biosets used in cloned bios for writing multiple replicas */
430         struct bio_set          replica_set;
431
432         /*
433          * Buckets:
434          * Per-bucket arrays are protected by c->mark_lock, bucket_lock and
435          * gc_lock, for device resize - holding any is sufficient for access:
436          * Or rcu_read_lock(), but only for ptr_stale():
437          */
438         struct bucket_array __rcu *buckets[2];
439         unsigned long           *buckets_nouse;
440         struct rw_semaphore     bucket_lock;
441
442         struct bch_dev_usage            *usage_base;
443         struct bch_dev_usage __percpu   *usage[JOURNAL_BUF_NR];
444         struct bch_dev_usage __percpu   *usage_gc;
445
446         /* Allocator: */
447         struct task_struct __rcu *alloc_thread;
448
449         /*
450          * free: Buckets that are ready to be used
451          *
452          * free_inc: Incoming buckets - these are buckets that currently have
453          * cached data in them, and we can't reuse them until after we write
454          * their new gen to disk. After prio_write() finishes writing the new
455          * gens/prios, they'll be moved to the free list (and possibly discarded
456          * in the process)
457          */
458         alloc_fifo              free[RESERVE_NR];
459         alloc_fifo              free_inc;
460         unsigned                nr_open_buckets;
461
462         open_bucket_idx_t       open_buckets_partial[OPEN_BUCKETS_COUNT];
463         open_bucket_idx_t       open_buckets_partial_nr;
464
465         size_t                  fifo_last_bucket;
466
467         size_t                  inc_gen_needs_gc;
468         size_t                  inc_gen_really_needs_gc;
469
470         enum allocator_states   allocator_state;
471
472         alloc_heap              alloc_heap;
473
474         atomic64_t              rebalance_work;
475
476         struct journal_device   journal;
477         u64                     prev_journal_sector;
478
479         struct work_struct      io_error_work;
480
481         /* The rest of this all shows up in sysfs */
482         atomic64_t              cur_latency[2];
483         struct time_stats       io_latency[2];
484
485 #define CONGESTED_MAX           1024
486         atomic_t                congested;
487         u64                     congested_last;
488
489         struct io_count __percpu *io_done;
490 };
491
492 enum {
493         /* startup: */
494         BCH_FS_ALLOC_READ_DONE,
495         BCH_FS_ALLOC_CLEAN,
496         BCH_FS_ALLOCATOR_RUNNING,
497         BCH_FS_ALLOCATOR_STOPPING,
498         BCH_FS_INITIAL_GC_DONE,
499         BCH_FS_INITIAL_GC_UNFIXED,
500         BCH_FS_TOPOLOGY_REPAIR_DONE,
501         BCH_FS_BTREE_INTERIOR_REPLAY_DONE,
502         BCH_FS_FSCK_DONE,
503         BCH_FS_STARTED,
504         BCH_FS_RW,
505         BCH_FS_WAS_RW,
506
507         /* shutdown: */
508         BCH_FS_STOPPING,
509         BCH_FS_EMERGENCY_RO,
510         BCH_FS_WRITE_DISABLE_COMPLETE,
511
512         /* errors: */
513         BCH_FS_ERROR,
514         BCH_FS_TOPOLOGY_ERROR,
515         BCH_FS_ERRORS_FIXED,
516         BCH_FS_ERRORS_NOT_FIXED,
517
518         /* misc: */
519         BCH_FS_NEED_ANOTHER_GC,
520         BCH_FS_DELETED_NODES,
521         BCH_FS_NEED_ALLOC_WRITE,
522         BCH_FS_REBUILD_REPLICAS,
523         BCH_FS_HOLD_BTREE_WRITES,
524 };
525
526 struct btree_debug {
527         unsigned                id;
528         struct dentry           *btree;
529         struct dentry           *btree_format;
530         struct dentry           *failed;
531 };
532
533 struct bch_fs_pcpu {
534         u64                     sectors_available;
535 };
536
537 struct journal_seq_blacklist_table {
538         size_t                  nr;
539         struct journal_seq_blacklist_table_entry {
540                 u64             start;
541                 u64             end;
542                 bool            dirty;
543         }                       entries[0];
544 };
545
546 struct journal_keys {
547         struct journal_key {
548                 enum btree_id   btree_id:8;
549                 unsigned        level:8;
550                 bool            allocated;
551                 struct bkey_i   *k;
552                 u32             journal_seq;
553                 u32             journal_offset;
554         }                       *d;
555         size_t                  nr;
556         size_t                  size;
557         u64                     journal_seq_base;
558 };
559
560 struct btree_iter_buf {
561         struct btree_iter       *iter;
562 };
563
564 #define REPLICAS_DELTA_LIST_MAX (1U << 16)
565
566 struct bch_fs {
567         struct closure          cl;
568
569         struct list_head        list;
570         struct kobject          kobj;
571         struct kobject          internal;
572         struct kobject          opts_dir;
573         struct kobject          time_stats;
574         unsigned long           flags;
575
576         int                     minor;
577         struct device           *chardev;
578         struct super_block      *vfs_sb;
579         dev_t                   dev;
580         char                    name[40];
581
582         /* ro/rw, add/remove/resize devices: */
583         struct rw_semaphore     state_lock;
584
585         /* Counts outstanding writes, for clean transition to read-only */
586         struct percpu_ref       writes;
587         struct work_struct      read_only_work;
588
589         struct bch_dev __rcu    *devs[BCH_SB_MEMBERS_MAX];
590
591         struct bch_replicas_cpu replicas;
592         struct bch_replicas_cpu replicas_gc;
593         struct mutex            replicas_gc_lock;
594         mempool_t               replicas_delta_pool;
595
596         struct journal_entry_res btree_root_journal_res;
597         struct journal_entry_res replicas_journal_res;
598         struct journal_entry_res clock_journal_res;
599         struct journal_entry_res dev_usage_journal_res;
600
601         struct bch_disk_groups_cpu __rcu *disk_groups;
602
603         struct bch_opts         opts;
604
605         /* Updated by bch2_sb_update():*/
606         struct {
607                 uuid_le         uuid;
608                 uuid_le         user_uuid;
609
610                 u16             version;
611                 u16             version_min;
612                 u16             encoded_extent_max;
613
614                 u8              nr_devices;
615                 u8              clean;
616
617                 u8              encryption_type;
618
619                 u64             time_base_lo;
620                 u32             time_base_hi;
621                 unsigned        time_units_per_sec;
622                 unsigned        nsec_per_time_unit;
623                 u64             features;
624                 u64             compat;
625         }                       sb;
626
627
628         struct bch_sb_handle    disk_sb;
629
630         unsigned short          block_bits;     /* ilog2(block_size) */
631
632         u16                     btree_foreground_merge_threshold;
633
634         struct closure          sb_write;
635         struct mutex            sb_lock;
636
637         /* BTREE CACHE */
638         struct bio_set          btree_bio;
639         struct workqueue_struct *io_complete_wq;
640
641         struct btree_root       btree_roots[BTREE_ID_NR];
642         struct mutex            btree_root_lock;
643
644         struct btree_cache      btree_cache;
645
646         /*
647          * Cache of allocated btree nodes - if we allocate a btree node and
648          * don't use it, if we free it that space can't be reused until going
649          * _all_ the way through the allocator (which exposes us to a livelock
650          * when allocating btree reserves fail halfway through) - instead, we
651          * can stick them here:
652          */
653         struct btree_alloc      btree_reserve_cache[BTREE_NODE_RESERVE * 2];
654         unsigned                btree_reserve_cache_nr;
655         struct mutex            btree_reserve_cache_lock;
656
657         mempool_t               btree_interior_update_pool;
658         struct list_head        btree_interior_update_list;
659         struct list_head        btree_interior_updates_unwritten;
660         struct mutex            btree_interior_update_lock;
661         struct closure_waitlist btree_interior_update_wait;
662
663         struct workqueue_struct *btree_interior_update_worker;
664         struct work_struct      btree_interior_update_work;
665
666         /* btree_iter.c: */
667         struct mutex            btree_trans_lock;
668         struct list_head        btree_trans_list;
669         mempool_t               btree_iters_pool;
670         mempool_t               btree_trans_mem_pool;
671         struct btree_iter_buf  __percpu *btree_iters_bufs;
672
673         struct srcu_struct      btree_trans_barrier;
674
675         struct btree_key_cache  btree_key_cache;
676
677         struct workqueue_struct *btree_update_wq;
678         struct workqueue_struct *btree_error_wq;
679         /* copygc needs its own workqueue for index updates.. */
680         struct workqueue_struct *copygc_wq;
681
682         /* ALLOCATION */
683         struct bch_devs_mask    rw_devs[BCH_DATA_NR];
684
685         u64                     capacity; /* sectors */
686
687         /*
688          * When capacity _decreases_ (due to a disk being removed), we
689          * increment capacity_gen - this invalidates outstanding reservations
690          * and forces them to be revalidated
691          */
692         u32                     capacity_gen;
693         unsigned                bucket_size_max;
694
695         atomic64_t              sectors_available;
696         struct mutex            sectors_available_lock;
697
698         struct bch_fs_pcpu __percpu     *pcpu;
699
700         struct percpu_rw_semaphore      mark_lock;
701
702         seqcount_t                      usage_lock;
703         struct bch_fs_usage             *usage_base;
704         struct bch_fs_usage __percpu    *usage[JOURNAL_BUF_NR];
705         struct bch_fs_usage __percpu    *usage_gc;
706         u64 __percpu            *online_reserved;
707
708         /* single element mempool: */
709         struct mutex            usage_scratch_lock;
710         struct bch_fs_usage_online *usage_scratch;
711
712         struct io_clock         io_clock[2];
713
714         /* JOURNAL SEQ BLACKLIST */
715         struct journal_seq_blacklist_table *
716                                 journal_seq_blacklist_table;
717         struct work_struct      journal_seq_blacklist_gc_work;
718
719         /* ALLOCATOR */
720         spinlock_t              freelist_lock;
721         struct closure_waitlist freelist_wait;
722         u64                     blocked_allocate;
723         u64                     blocked_allocate_open_bucket;
724         open_bucket_idx_t       open_buckets_freelist;
725         open_bucket_idx_t       open_buckets_nr_free;
726         struct closure_waitlist open_buckets_wait;
727         struct open_bucket      open_buckets[OPEN_BUCKETS_COUNT];
728
729         struct write_point      btree_write_point;
730         struct write_point      rebalance_write_point;
731
732         struct write_point      write_points[WRITE_POINT_MAX];
733         struct hlist_head       write_points_hash[WRITE_POINT_HASH_NR];
734         struct mutex            write_points_hash_lock;
735         unsigned                write_points_nr;
736
737         /* GARBAGE COLLECTION */
738         struct task_struct      *gc_thread;
739         atomic_t                kick_gc;
740         unsigned long           gc_count;
741
742         enum btree_id           gc_gens_btree;
743         struct bpos             gc_gens_pos;
744
745         /*
746          * Tracks GC's progress - everything in the range [ZERO_KEY..gc_cur_pos]
747          * has been marked by GC.
748          *
749          * gc_cur_phase is a superset of btree_ids (BTREE_ID_extents etc.)
750          *
751          * Protected by gc_pos_lock. Only written to by GC thread, so GC thread
752          * can read without a lock.
753          */
754         seqcount_t              gc_pos_lock;
755         struct gc_pos           gc_pos;
756
757         /*
758          * The allocation code needs gc_mark in struct bucket to be correct, but
759          * it's not while a gc is in progress.
760          */
761         struct rw_semaphore     gc_lock;
762
763         /* IO PATH */
764         struct semaphore        io_in_flight;
765         struct bio_set          bio_read;
766         struct bio_set          bio_read_split;
767         struct bio_set          bio_write;
768         struct mutex            bio_bounce_pages_lock;
769         mempool_t               bio_bounce_pages;
770         struct rhashtable       promote_table;
771
772         mempool_t               compression_bounce[2];
773         mempool_t               compress_workspace[BCH_COMPRESSION_TYPE_NR];
774         mempool_t               decompress_workspace;
775         ZSTD_parameters         zstd_params;
776
777         struct crypto_shash     *sha256;
778         struct crypto_sync_skcipher *chacha20;
779         struct crypto_shash     *poly1305;
780
781         atomic64_t              key_version;
782
783         mempool_t               large_bkey_pool;
784
785         /* REBALANCE */
786         struct bch_fs_rebalance rebalance;
787
788         /* COPYGC */
789         struct task_struct      *copygc_thread;
790         copygc_heap             copygc_heap;
791         struct write_point      copygc_write_point;
792         s64                     copygc_wait;
793
794         /* STRIPES: */
795         GENRADIX(struct stripe) stripes[2];
796
797         ec_stripes_heap         ec_stripes_heap;
798         spinlock_t              ec_stripes_heap_lock;
799
800         /* ERASURE CODING */
801         struct list_head        ec_stripe_head_list;
802         struct mutex            ec_stripe_head_lock;
803
804         struct list_head        ec_stripe_new_list;
805         struct mutex            ec_stripe_new_lock;
806
807         struct work_struct      ec_stripe_create_work;
808         u64                     ec_stripe_hint;
809
810         struct bio_set          ec_bioset;
811
812         struct work_struct      ec_stripe_delete_work;
813         struct llist_head       ec_stripe_delete_list;
814
815         /* REFLINK */
816         u64                     reflink_hint;
817         reflink_gc_table        reflink_gc_table;
818         size_t                  reflink_gc_nr;
819         size_t                  reflink_gc_idx;
820
821         /* VFS IO PATH - fs-io.c */
822         struct bio_set          writepage_bioset;
823         struct bio_set          dio_write_bioset;
824         struct bio_set          dio_read_bioset;
825
826
827         atomic64_t              btree_writes_nr;
828         atomic64_t              btree_writes_sectors;
829         struct bio_list         btree_write_error_list;
830         struct work_struct      btree_write_error_work;
831         spinlock_t              btree_write_error_lock;
832
833         /* ERRORS */
834         struct list_head        fsck_errors;
835         struct mutex            fsck_error_lock;
836         bool                    fsck_alloc_err;
837
838         /* QUOTAS */
839         struct bch_memquota_type quotas[QTYP_NR];
840
841         /* DEBUG JUNK */
842         struct dentry           *debug;
843         struct btree_debug      btree_debug[BTREE_ID_NR];
844         struct btree            *verify_data;
845         struct btree_node       *verify_ondisk;
846         struct mutex            verify_lock;
847
848         u64                     *unused_inode_hints;
849         unsigned                inode_shard_bits;
850
851         /*
852          * A btree node on disk could have too many bsets for an iterator to fit
853          * on the stack - have to dynamically allocate them
854          */
855         mempool_t               fill_iter;
856
857         mempool_t               btree_bounce_pool;
858
859         struct journal          journal;
860         struct list_head        journal_entries;
861         struct journal_keys     journal_keys;
862         struct list_head        journal_iters;
863
864         u64                     last_bucket_seq_cleanup;
865
866         /* The rest of this all shows up in sysfs */
867         atomic_long_t           read_realloc_races;
868         atomic_long_t           extent_migrate_done;
869         atomic_long_t           extent_migrate_raced;
870
871         unsigned                btree_gc_periodic:1;
872         unsigned                copy_gc_enabled:1;
873         bool                    promote_whole_extents;
874
875         struct time_stats       times[BCH_TIME_STAT_NR];
876 };
877
878 static inline void bch2_set_ra_pages(struct bch_fs *c, unsigned ra_pages)
879 {
880 #ifndef NO_BCACHEFS_FS
881         if (c->vfs_sb)
882                 c->vfs_sb->s_bdi->ra_pages = ra_pages;
883 #endif
884 }
885
886 static inline unsigned bucket_bytes(const struct bch_dev *ca)
887 {
888         return ca->mi.bucket_size << 9;
889 }
890
891 static inline unsigned block_bytes(const struct bch_fs *c)
892 {
893         return c->opts.block_size << 9;
894 }
895
896 static inline struct timespec64 bch2_time_to_timespec(struct bch_fs *c, s64 time)
897 {
898         struct timespec64 t;
899         s32 rem;
900
901         time += c->sb.time_base_lo;
902
903         t.tv_sec = div_s64_rem(time, c->sb.time_units_per_sec, &rem);
904         t.tv_nsec = rem * c->sb.nsec_per_time_unit;
905         return t;
906 }
907
908 static inline s64 timespec_to_bch2_time(struct bch_fs *c, struct timespec64 ts)
909 {
910         return (ts.tv_sec * c->sb.time_units_per_sec +
911                 (int) ts.tv_nsec / c->sb.nsec_per_time_unit) - c->sb.time_base_lo;
912 }
913
914 static inline s64 bch2_current_time(struct bch_fs *c)
915 {
916         struct timespec64 now;
917
918         ktime_get_coarse_real_ts64(&now);
919         return timespec_to_bch2_time(c, now);
920 }
921
922 static inline bool bch2_dev_exists2(const struct bch_fs *c, unsigned dev)
923 {
924         return dev < c->sb.nr_devices && c->devs[dev];
925 }
926
927 #endif /* _BCACHEFS_H */