]> git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/bcachefs.h
9a90a68cdd7f86e2718895cf35c1f0a7390d47f4
[bcachefs-tools-debian] / libbcachefs / bcachefs.h
1 #ifndef _BCACHEFS_H
2 #define _BCACHEFS_H
3
4 /*
5  * SOME HIGH LEVEL CODE DOCUMENTATION:
6  *
7  * Bcache mostly works with cache sets, cache devices, and backing devices.
8  *
9  * Support for multiple cache devices hasn't quite been finished off yet, but
10  * it's about 95% plumbed through. A cache set and its cache devices is sort of
11  * like a md raid array and its component devices. Most of the code doesn't care
12  * about individual cache devices, the main abstraction is the cache set.
13  *
14  * Multiple cache devices is intended to give us the ability to mirror dirty
15  * cached data and metadata, without mirroring clean cached data.
16  *
17  * Backing devices are different, in that they have a lifetime independent of a
18  * cache set. When you register a newly formatted backing device it'll come up
19  * in passthrough mode, and then you can attach and detach a backing device from
20  * a cache set at runtime - while it's mounted and in use. Detaching implicitly
21  * invalidates any cached data for that backing device.
22  *
23  * A cache set can have multiple (many) backing devices attached to it.
24  *
25  * There's also flash only volumes - this is the reason for the distinction
26  * between struct cached_dev and struct bcache_device. A flash only volume
27  * works much like a bcache device that has a backing device, except the
28  * "cached" data is always dirty. The end result is that we get thin
29  * provisioning with very little additional code.
30  *
31  * Flash only volumes work but they're not production ready because the moving
32  * garbage collector needs more work. More on that later.
33  *
34  * BUCKETS/ALLOCATION:
35  *
36  * Bcache is primarily designed for caching, which means that in normal
37  * operation all of our available space will be allocated. Thus, we need an
38  * efficient way of deleting things from the cache so we can write new things to
39  * it.
40  *
41  * To do this, we first divide the cache device up into buckets. A bucket is the
42  * unit of allocation; they're typically around 1 mb - anywhere from 128k to 2M+
43  * works efficiently.
44  *
45  * Each bucket has a 16 bit priority, and an 8 bit generation associated with
46  * it. The gens and priorities for all the buckets are stored contiguously and
47  * packed on disk (in a linked list of buckets - aside from the superblock, all
48  * of bcache's metadata is stored in buckets).
49  *
50  * The priority is used to implement an LRU. We reset a bucket's priority when
51  * we allocate it or on cache it, and every so often we decrement the priority
52  * of each bucket. It could be used to implement something more sophisticated,
53  * if anyone ever gets around to it.
54  *
55  * The generation is used for invalidating buckets. Each pointer also has an 8
56  * bit generation embedded in it; for a pointer to be considered valid, its gen
57  * must match the gen of the bucket it points into.  Thus, to reuse a bucket all
58  * we have to do is increment its gen (and write its new gen to disk; we batch
59  * this up).
60  *
61  * Bcache is entirely COW - we never write twice to a bucket, even buckets that
62  * contain metadata (including btree nodes).
63  *
64  * THE BTREE:
65  *
66  * Bcache is in large part design around the btree.
67  *
68  * At a high level, the btree is just an index of key -> ptr tuples.
69  *
70  * Keys represent extents, and thus have a size field. Keys also have a variable
71  * number of pointers attached to them (potentially zero, which is handy for
72  * invalidating the cache).
73  *
74  * The key itself is an inode:offset pair. The inode number corresponds to a
75  * backing device or a flash only volume. The offset is the ending offset of the
76  * extent within the inode - not the starting offset; this makes lookups
77  * slightly more convenient.
78  *
79  * Pointers contain the cache device id, the offset on that device, and an 8 bit
80  * generation number. More on the gen later.
81  *
82  * Index lookups are not fully abstracted - cache lookups in particular are
83  * still somewhat mixed in with the btree code, but things are headed in that
84  * direction.
85  *
86  * Updates are fairly well abstracted, though. There are two different ways of
87  * updating the btree; insert and replace.
88  *
89  * BTREE_INSERT will just take a list of keys and insert them into the btree -
90  * overwriting (possibly only partially) any extents they overlap with. This is
91  * used to update the index after a write.
92  *
93  * BTREE_REPLACE is really cmpxchg(); it inserts a key into the btree iff it is
94  * overwriting a key that matches another given key. This is used for inserting
95  * data into the cache after a cache miss, and for background writeback, and for
96  * the moving garbage collector.
97  *
98  * There is no "delete" operation; deleting things from the index is
99  * accomplished by either by invalidating pointers (by incrementing a bucket's
100  * gen) or by inserting a key with 0 pointers - which will overwrite anything
101  * previously present at that location in the index.
102  *
103  * This means that there are always stale/invalid keys in the btree. They're
104  * filtered out by the code that iterates through a btree node, and removed when
105  * a btree node is rewritten.
106  *
107  * BTREE NODES:
108  *
109  * Our unit of allocation is a bucket, and we we can't arbitrarily allocate and
110  * free smaller than a bucket - so, that's how big our btree nodes are.
111  *
112  * (If buckets are really big we'll only use part of the bucket for a btree node
113  * - no less than 1/4th - but a bucket still contains no more than a single
114  * btree node. I'd actually like to change this, but for now we rely on the
115  * bucket's gen for deleting btree nodes when we rewrite/split a node.)
116  *
117  * Anyways, btree nodes are big - big enough to be inefficient with a textbook
118  * btree implementation.
119  *
120  * The way this is solved is that btree nodes are internally log structured; we
121  * can append new keys to an existing btree node without rewriting it. This
122  * means each set of keys we write is sorted, but the node is not.
123  *
124  * We maintain this log structure in memory - keeping 1Mb of keys sorted would
125  * be expensive, and we have to distinguish between the keys we have written and
126  * the keys we haven't. So to do a lookup in a btree node, we have to search
127  * each sorted set. But we do merge written sets together lazily, so the cost of
128  * these extra searches is quite low (normally most of the keys in a btree node
129  * will be in one big set, and then there'll be one or two sets that are much
130  * smaller).
131  *
132  * This log structure makes bcache's btree more of a hybrid between a
133  * conventional btree and a compacting data structure, with some of the
134  * advantages of both.
135  *
136  * GARBAGE COLLECTION:
137  *
138  * We can't just invalidate any bucket - it might contain dirty data or
139  * metadata. If it once contained dirty data, other writes might overwrite it
140  * later, leaving no valid pointers into that bucket in the index.
141  *
142  * Thus, the primary purpose of garbage collection is to find buckets to reuse.
143  * It also counts how much valid data it each bucket currently contains, so that
144  * allocation can reuse buckets sooner when they've been mostly overwritten.
145  *
146  * It also does some things that are really internal to the btree
147  * implementation. If a btree node contains pointers that are stale by more than
148  * some threshold, it rewrites the btree node to avoid the bucket's generation
149  * wrapping around. It also merges adjacent btree nodes if they're empty enough.
150  *
151  * THE JOURNAL:
152  *
153  * Bcache's journal is not necessary for consistency; we always strictly
154  * order metadata writes so that the btree and everything else is consistent on
155  * disk in the event of an unclean shutdown, and in fact bcache had writeback
156  * caching (with recovery from unclean shutdown) before journalling was
157  * implemented.
158  *
159  * Rather, the journal is purely a performance optimization; we can't complete a
160  * write until we've updated the index on disk, otherwise the cache would be
161  * inconsistent in the event of an unclean shutdown. This means that without the
162  * journal, on random write workloads we constantly have to update all the leaf
163  * nodes in the btree, and those writes will be mostly empty (appending at most
164  * a few keys each) - highly inefficient in terms of amount of metadata writes,
165  * and it puts more strain on the various btree resorting/compacting code.
166  *
167  * The journal is just a log of keys we've inserted; on startup we just reinsert
168  * all the keys in the open journal entries. That means that when we're updating
169  * a node in the btree, we can wait until a 4k block of keys fills up before
170  * writing them out.
171  *
172  * For simplicity, we only journal updates to leaf nodes; updates to parent
173  * nodes are rare enough (since our leaf nodes are huge) that it wasn't worth
174  * the complexity to deal with journalling them (in particular, journal replay)
175  * - updates to non leaf nodes just happen synchronously (see btree_split()).
176  */
177
178 #undef pr_fmt
179 #define pr_fmt(fmt) "bcachefs: %s() " fmt "\n", __func__
180
181 #include <linux/bug.h>
182 #include <linux/bio.h>
183 #include <linux/closure.h>
184 #include <linux/kobject.h>
185 #include <linux/list.h>
186 #include <linux/mutex.h>
187 #include <linux/percpu-refcount.h>
188 #include <linux/percpu-rwsem.h>
189 #include <linux/rhashtable.h>
190 #include <linux/rwsem.h>
191 #include <linux/seqlock.h>
192 #include <linux/shrinker.h>
193 #include <linux/types.h>
194 #include <linux/workqueue.h>
195 #include <linux/zstd.h>
196
197 #include "bcachefs_format.h"
198 #include "fifo.h"
199 #include "opts.h"
200 #include "util.h"
201
202 #include <linux/dynamic_fault.h>
203
204 #define bch2_fs_init_fault(name)                                        \
205         dynamic_fault("bcachefs:bch_fs_init:" name)
206 #define bch2_meta_read_fault(name)                                      \
207          dynamic_fault("bcachefs:meta:read:" name)
208 #define bch2_meta_write_fault(name)                                     \
209          dynamic_fault("bcachefs:meta:write:" name)
210
211 #ifdef __KERNEL__
212 #define bch2_fmt(_c, fmt)       "bcachefs (%s): " fmt "\n", ((_c)->name)
213 #else
214 #define bch2_fmt(_c, fmt)       fmt "\n"
215 #endif
216
217 #define bch_info(c, fmt, ...) \
218         printk(KERN_INFO bch2_fmt(c, fmt), ##__VA_ARGS__)
219 #define bch_notice(c, fmt, ...) \
220         printk(KERN_NOTICE bch2_fmt(c, fmt), ##__VA_ARGS__)
221 #define bch_warn(c, fmt, ...) \
222         printk(KERN_WARNING bch2_fmt(c, fmt), ##__VA_ARGS__)
223 #define bch_err(c, fmt, ...) \
224         printk(KERN_ERR bch2_fmt(c, fmt), ##__VA_ARGS__)
225 #define bch_err_ratelimited(c, fmt, ...) \
226         printk_ratelimited(KERN_ERR bch2_fmt(c, fmt), ##__VA_ARGS__)
227
228 #define bch_verbose(c, fmt, ...)                                        \
229 do {                                                                    \
230         if ((c)->opts.verbose)                                          \
231                 bch_info(c, fmt, ##__VA_ARGS__);                        \
232 } while (0)
233
234 #define pr_verbose_init(opts, fmt, ...)                                 \
235 do {                                                                    \
236         if (opt_get(opts, verbose))                                     \
237                 pr_info(fmt, ##__VA_ARGS__);                            \
238 } while (0)
239
240 /* Parameters that are useful for debugging, but should always be compiled in: */
241 #define BCH_DEBUG_PARAMS_ALWAYS()                                       \
242         BCH_DEBUG_PARAM(key_merging_disabled,                           \
243                 "Disables merging of extents")                          \
244         BCH_DEBUG_PARAM(btree_gc_always_rewrite,                        \
245                 "Causes mark and sweep to compact and rewrite every "   \
246                 "btree node it traverses")                              \
247         BCH_DEBUG_PARAM(btree_gc_rewrite_disabled,                      \
248                 "Disables rewriting of btree nodes during mark and sweep")\
249         BCH_DEBUG_PARAM(btree_shrinker_disabled,                        \
250                 "Disables the shrinker callback for the btree node cache")
251
252 /* Parameters that should only be compiled in in debug mode: */
253 #define BCH_DEBUG_PARAMS_DEBUG()                                        \
254         BCH_DEBUG_PARAM(expensive_debug_checks,                         \
255                 "Enables various runtime debugging checks that "        \
256                 "significantly affect performance")                     \
257         BCH_DEBUG_PARAM(debug_check_iterators,                          \
258                 "Enables extra verification for btree iterators")       \
259         BCH_DEBUG_PARAM(debug_check_bkeys,                              \
260                 "Run bkey_debugcheck (primarily checking GC/allocation "\
261                 "information) when iterating over keys")                \
262         BCH_DEBUG_PARAM(verify_btree_ondisk,                            \
263                 "Reread btree nodes at various points to verify the "   \
264                 "mergesort in the read path against modifications "     \
265                 "done in memory")                                       \
266         BCH_DEBUG_PARAM(journal_seq_verify,                             \
267                 "Store the journal sequence number in the version "     \
268                 "number of every btree key, and verify that btree "     \
269                 "update ordering is preserved during recovery")         \
270         BCH_DEBUG_PARAM(inject_invalid_keys,                            \
271                 "Store the journal sequence number in the version "     \
272                 "number of every btree key, and verify that btree "     \
273                 "update ordering is preserved during recovery")         \
274         BCH_DEBUG_PARAM(test_alloc_startup,                             \
275                 "Force allocator startup to use the slowpath where it"  \
276                 "can't find enough free buckets without invalidating"   \
277                 "cached data")                                          \
278         BCH_DEBUG_PARAM(force_reconstruct_read,                         \
279                 "Force reads to use the reconstruct path, when reading" \
280                 "from erasure coded extents")                           \
281         BCH_DEBUG_PARAM(test_restart_gc,                                \
282                 "Test restarting mark and sweep gc when bucket gens change")\
283         BCH_DEBUG_PARAM(test_reconstruct_alloc,                         \
284                 "Test reconstructing the alloc btree")
285
286 #define BCH_DEBUG_PARAMS_ALL() BCH_DEBUG_PARAMS_ALWAYS() BCH_DEBUG_PARAMS_DEBUG()
287
288 #ifdef CONFIG_BCACHEFS_DEBUG
289 #define BCH_DEBUG_PARAMS() BCH_DEBUG_PARAMS_ALL()
290 #else
291 #define BCH_DEBUG_PARAMS() BCH_DEBUG_PARAMS_ALWAYS()
292 #endif
293
294 #define BCH_TIME_STATS()                        \
295         x(btree_node_mem_alloc)                 \
296         x(btree_node_split)                     \
297         x(btree_node_sort)                      \
298         x(btree_node_read)                      \
299         x(btree_gc)                             \
300         x(btree_update)                         \
301         x(btree_lock_contended_read)            \
302         x(btree_lock_contended_intent)          \
303         x(btree_lock_contended_write)           \
304         x(data_write)                           \
305         x(data_read)                            \
306         x(data_promote)                         \
307         x(journal_write)                        \
308         x(journal_delay)                        \
309         x(journal_flush_seq)                    \
310         x(blocked_journal)                      \
311         x(blocked_allocate)                     \
312         x(blocked_allocate_open_bucket)
313
314 enum bch_time_stats {
315 #define x(name) BCH_TIME_##name,
316         BCH_TIME_STATS()
317 #undef x
318         BCH_TIME_STAT_NR
319 };
320
321 #include "alloc_types.h"
322 #include "btree_types.h"
323 #include "buckets_types.h"
324 #include "clock_types.h"
325 #include "ec_types.h"
326 #include "journal_types.h"
327 #include "keylist_types.h"
328 #include "quota_types.h"
329 #include "rebalance_types.h"
330 #include "replicas_types.h"
331 #include "super_types.h"
332
333 /* Number of nodes btree coalesce will try to coalesce at once */
334 #define GC_MERGE_NODES          4U
335
336 /* Maximum number of nodes we might need to allocate atomically: */
337 #define BTREE_RESERVE_MAX       (BTREE_MAX_DEPTH + (BTREE_MAX_DEPTH - 1))
338
339 /* Size of the freelist we allocate btree nodes from: */
340 #define BTREE_NODE_RESERVE      BTREE_RESERVE_MAX
341
342 #define BTREE_NODE_OPEN_BUCKET_RESERVE  (BTREE_RESERVE_MAX * BCH_REPLICAS_MAX)
343
344 struct btree;
345
346 enum gc_phase {
347         GC_PHASE_NOT_RUNNING,
348         GC_PHASE_START,
349         GC_PHASE_SB,
350
351         GC_PHASE_BTREE_EC,
352         GC_PHASE_BTREE_EXTENTS,
353         GC_PHASE_BTREE_INODES,
354         GC_PHASE_BTREE_DIRENTS,
355         GC_PHASE_BTREE_XATTRS,
356         GC_PHASE_BTREE_ALLOC,
357         GC_PHASE_BTREE_QUOTAS,
358
359         GC_PHASE_PENDING_DELETE,
360         GC_PHASE_ALLOC,
361 };
362
363 struct gc_pos {
364         enum gc_phase           phase;
365         struct bpos             pos;
366         unsigned                level;
367 };
368
369 struct io_count {
370         u64                     sectors[2][BCH_DATA_NR];
371 };
372
373 struct bch_dev {
374         struct kobject          kobj;
375         struct percpu_ref       ref;
376         struct completion       ref_completion;
377         struct percpu_ref       io_ref;
378         struct completion       io_ref_completion;
379
380         struct bch_fs           *fs;
381
382         u8                      dev_idx;
383         /*
384          * Cached version of this device's member info from superblock
385          * Committed by bch2_write_super() -> bch_fs_mi_update()
386          */
387         struct bch_member_cpu   mi;
388         uuid_le                 uuid;
389         char                    name[BDEVNAME_SIZE];
390
391         struct bch_sb_handle    disk_sb;
392         struct bch_sb           *sb_read_scratch;
393         int                     sb_write_error;
394
395         struct bch_devs_mask    self;
396
397         /* biosets used in cloned bios for writing multiple replicas */
398         struct bio_set          replica_set;
399
400         /*
401          * Buckets:
402          * Per-bucket arrays are protected by c->mark_lock, bucket_lock and
403          * gc_lock, for device resize - holding any is sufficient for access:
404          * Or rcu_read_lock(), but only for ptr_stale():
405          */
406         struct bucket_array __rcu *buckets[2];
407         unsigned long           *buckets_nouse;
408         unsigned long           *buckets_written;
409         struct rw_semaphore     bucket_lock;
410
411         struct bch_dev_usage __percpu *usage[2];
412
413         /* Allocator: */
414         struct task_struct __rcu *alloc_thread;
415
416         /*
417          * free: Buckets that are ready to be used
418          *
419          * free_inc: Incoming buckets - these are buckets that currently have
420          * cached data in them, and we can't reuse them until after we write
421          * their new gen to disk. After prio_write() finishes writing the new
422          * gens/prios, they'll be moved to the free list (and possibly discarded
423          * in the process)
424          */
425         alloc_fifo              free[RESERVE_NR];
426         alloc_fifo              free_inc;
427         spinlock_t              freelist_lock;
428
429         u8                      open_buckets_partial[OPEN_BUCKETS_COUNT];
430         unsigned                open_buckets_partial_nr;
431
432         size_t                  fifo_last_bucket;
433
434         /* last calculated minimum prio */
435         u16                     max_last_bucket_io[2];
436
437         size_t                  inc_gen_needs_gc;
438         size_t                  inc_gen_really_needs_gc;
439
440         /*
441          * XXX: this should be an enum for allocator state, so as to include
442          * error state
443          */
444         bool                    allocator_blocked;
445         bool                    allocator_blocked_full;
446
447         alloc_heap              alloc_heap;
448
449         /* Copying GC: */
450         struct task_struct      *copygc_thread;
451         copygc_heap             copygc_heap;
452         struct bch_pd_controller copygc_pd;
453         struct write_point      copygc_write_point;
454         u64                     copygc_threshold;
455
456         atomic64_t              rebalance_work;
457
458         struct journal_device   journal;
459
460         struct work_struct      io_error_work;
461
462         /* The rest of this all shows up in sysfs */
463         atomic64_t              cur_latency[2];
464         struct time_stats       io_latency[2];
465
466 #define CONGESTED_MAX           1024
467         atomic_t                congested;
468         u64                     congested_last;
469
470         struct io_count __percpu *io_done;
471 };
472
473 enum {
474         /* startup: */
475         BCH_FS_ALLOC_READ_DONE,
476         BCH_FS_ALLOCATOR_STARTED,
477         BCH_FS_ALLOCATOR_RUNNING,
478         BCH_FS_INITIAL_GC_DONE,
479         BCH_FS_FSCK_DONE,
480         BCH_FS_STARTED,
481         BCH_FS_RW,
482
483         /* shutdown: */
484         BCH_FS_EMERGENCY_RO,
485         BCH_FS_WRITE_DISABLE_COMPLETE,
486
487         /* errors: */
488         BCH_FS_ERROR,
489         BCH_FS_ERRORS_FIXED,
490
491         /* misc: */
492         BCH_FS_BDEV_MOUNTED,
493         BCH_FS_FIXED_GENS,
494         BCH_FS_REBUILD_REPLICAS,
495         BCH_FS_HOLD_BTREE_WRITES,
496 };
497
498 struct btree_debug {
499         unsigned                id;
500         struct dentry           *btree;
501         struct dentry           *btree_format;
502         struct dentry           *failed;
503 };
504
505 struct bch_fs_pcpu {
506         u64                     sectors_available;
507 };
508
509 struct bch_fs {
510         struct closure          cl;
511
512         struct list_head        list;
513         struct kobject          kobj;
514         struct kobject          internal;
515         struct kobject          opts_dir;
516         struct kobject          time_stats;
517         unsigned long           flags;
518
519         int                     minor;
520         struct device           *chardev;
521         struct super_block      *vfs_sb;
522         char                    name[40];
523
524         /* ro/rw, add/remove devices: */
525         struct mutex            state_lock;
526
527         /* Counts outstanding writes, for clean transition to read-only */
528         struct percpu_ref       writes;
529         struct work_struct      read_only_work;
530
531         struct bch_dev __rcu    *devs[BCH_SB_MEMBERS_MAX];
532
533         struct bch_replicas_cpu replicas;
534         struct bch_replicas_cpu replicas_gc;
535         struct mutex            replicas_gc_lock;
536
537         struct journal_entry_res replicas_journal_res;
538
539         struct bch_disk_groups_cpu __rcu *disk_groups;
540
541         struct bch_opts         opts;
542
543         /* Updated by bch2_sb_update():*/
544         struct {
545                 uuid_le         uuid;
546                 uuid_le         user_uuid;
547
548                 u16             version;
549                 u16             encoded_extent_max;
550
551                 u8              nr_devices;
552                 u8              clean;
553
554                 u8              encryption_type;
555
556                 u64             time_base_lo;
557                 u32             time_base_hi;
558                 u32             time_precision;
559                 u64             features;
560                 u64             compat;
561         }                       sb;
562
563         struct bch_sb_handle    disk_sb;
564
565         unsigned short          block_bits;     /* ilog2(block_size) */
566
567         u16                     btree_foreground_merge_threshold;
568
569         struct closure          sb_write;
570         struct mutex            sb_lock;
571
572         /* BTREE CACHE */
573         struct bio_set          btree_bio;
574
575         struct btree_root       btree_roots[BTREE_ID_NR];
576         bool                    btree_roots_dirty;
577         struct mutex            btree_root_lock;
578
579         struct btree_cache      btree_cache;
580
581         mempool_t               btree_reserve_pool;
582
583         /*
584          * Cache of allocated btree nodes - if we allocate a btree node and
585          * don't use it, if we free it that space can't be reused until going
586          * _all_ the way through the allocator (which exposes us to a livelock
587          * when allocating btree reserves fail halfway through) - instead, we
588          * can stick them here:
589          */
590         struct btree_alloc      btree_reserve_cache[BTREE_NODE_RESERVE * 2];
591         unsigned                btree_reserve_cache_nr;
592         struct mutex            btree_reserve_cache_lock;
593
594         mempool_t               btree_interior_update_pool;
595         struct list_head        btree_interior_update_list;
596         struct mutex            btree_interior_update_lock;
597         struct closure_waitlist btree_interior_update_wait;
598
599         mempool_t               btree_iters_pool;
600
601         struct workqueue_struct *wq;
602         /* copygc needs its own workqueue for index updates.. */
603         struct workqueue_struct *copygc_wq;
604         struct workqueue_struct *journal_reclaim_wq;
605
606         /* ALLOCATION */
607         struct delayed_work     pd_controllers_update;
608         unsigned                pd_controllers_update_seconds;
609
610         struct bch_devs_mask    rw_devs[BCH_DATA_NR];
611
612         u64                     capacity; /* sectors */
613
614         /*
615          * When capacity _decreases_ (due to a disk being removed), we
616          * increment capacity_gen - this invalidates outstanding reservations
617          * and forces them to be revalidated
618          */
619         u32                     capacity_gen;
620         unsigned                bucket_size_max;
621
622         atomic64_t              sectors_available;
623
624         struct bch_fs_pcpu __percpu     *pcpu;
625
626         struct percpu_rw_semaphore      mark_lock;
627
628         struct bch_fs_usage __percpu    *usage[2];
629
630         /* single element mempool: */
631         struct mutex            usage_scratch_lock;
632         struct bch_fs_usage     *usage_scratch;
633
634         /*
635          * When we invalidate buckets, we use both the priority and the amount
636          * of good data to determine which buckets to reuse first - to weight
637          * those together consistently we keep track of the smallest nonzero
638          * priority of any bucket.
639          */
640         struct bucket_clock     bucket_clock[2];
641
642         struct io_clock         io_clock[2];
643
644         /* ALLOCATOR */
645         spinlock_t              freelist_lock;
646         struct closure_waitlist freelist_wait;
647         u64                     blocked_allocate;
648         u64                     blocked_allocate_open_bucket;
649         u8                      open_buckets_freelist;
650         u8                      open_buckets_nr_free;
651         struct closure_waitlist open_buckets_wait;
652         struct open_bucket      open_buckets[OPEN_BUCKETS_COUNT];
653
654         struct write_point      btree_write_point;
655         struct write_point      rebalance_write_point;
656
657         struct write_point      write_points[WRITE_POINT_MAX];
658         struct hlist_head       write_points_hash[WRITE_POINT_HASH_NR];
659         struct mutex            write_points_hash_lock;
660         unsigned                write_points_nr;
661
662         /* GARBAGE COLLECTION */
663         struct task_struct      *gc_thread;
664         atomic_t                kick_gc;
665         unsigned long           gc_count;
666
667         /*
668          * Tracks GC's progress - everything in the range [ZERO_KEY..gc_cur_pos]
669          * has been marked by GC.
670          *
671          * gc_cur_phase is a superset of btree_ids (BTREE_ID_EXTENTS etc.)
672          *
673          * Protected by gc_pos_lock. Only written to by GC thread, so GC thread
674          * can read without a lock.
675          */
676         seqcount_t              gc_pos_lock;
677         struct gc_pos           gc_pos;
678
679         /*
680          * The allocation code needs gc_mark in struct bucket to be correct, but
681          * it's not while a gc is in progress.
682          */
683         struct rw_semaphore     gc_lock;
684
685         /* IO PATH */
686         struct bio_set          bio_read;
687         struct bio_set          bio_read_split;
688         struct bio_set          bio_write;
689         struct mutex            bio_bounce_pages_lock;
690         mempool_t               bio_bounce_pages;
691         struct rhashtable       promote_table;
692
693         mempool_t               compression_bounce[2];
694         mempool_t               compress_workspace[BCH_COMPRESSION_NR];
695         mempool_t               decompress_workspace;
696         ZSTD_parameters         zstd_params;
697
698         struct crypto_shash     *sha256;
699         struct crypto_sync_skcipher *chacha20;
700         struct crypto_shash     *poly1305;
701
702         atomic64_t              key_version;
703
704         /* REBALANCE */
705         struct bch_fs_rebalance rebalance;
706
707         /* STRIPES: */
708         GENRADIX(struct stripe) stripes[2];
709         struct mutex            ec_stripe_create_lock;
710
711         ec_stripes_heap         ec_stripes_heap;
712         spinlock_t              ec_stripes_heap_lock;
713
714         /* ERASURE CODING */
715         struct list_head        ec_new_stripe_list;
716         struct mutex            ec_new_stripe_lock;
717
718         struct bio_set          ec_bioset;
719
720         struct work_struct      ec_stripe_delete_work;
721         struct llist_head       ec_stripe_delete_list;
722
723         /* VFS IO PATH - fs-io.c */
724         struct bio_set          writepage_bioset;
725         struct bio_set          dio_write_bioset;
726         struct bio_set          dio_read_bioset;
727
728         struct bio_list         btree_write_error_list;
729         struct work_struct      btree_write_error_work;
730         spinlock_t              btree_write_error_lock;
731
732         /* ERRORS */
733         struct list_head        fsck_errors;
734         struct mutex            fsck_error_lock;
735         bool                    fsck_alloc_err;
736
737         /* QUOTAS */
738         struct bch_memquota_type quotas[QTYP_NR];
739
740         /* DEBUG JUNK */
741         struct dentry           *debug;
742         struct btree_debug      btree_debug[BTREE_ID_NR];
743 #ifdef CONFIG_BCACHEFS_DEBUG
744         struct btree            *verify_data;
745         struct btree_node       *verify_ondisk;
746         struct mutex            verify_lock;
747 #endif
748
749         u64                     unused_inode_hint;
750
751         /*
752          * A btree node on disk could have too many bsets for an iterator to fit
753          * on the stack - have to dynamically allocate them
754          */
755         mempool_t               fill_iter;
756
757         mempool_t               btree_bounce_pool;
758
759         struct journal          journal;
760
761         u64                     last_bucket_seq_cleanup;
762
763         /* The rest of this all shows up in sysfs */
764         atomic_long_t           read_realloc_races;
765         atomic_long_t           extent_migrate_done;
766         atomic_long_t           extent_migrate_raced;
767
768         unsigned                btree_gc_periodic:1;
769         unsigned                copy_gc_enabled:1;
770         bool                    promote_whole_extents;
771
772 #define BCH_DEBUG_PARAM(name, description) bool name;
773         BCH_DEBUG_PARAMS_ALL()
774 #undef BCH_DEBUG_PARAM
775
776         struct time_stats       times[BCH_TIME_STAT_NR];
777 };
778
779 static inline void bch2_set_ra_pages(struct bch_fs *c, unsigned ra_pages)
780 {
781 #ifndef NO_BCACHEFS_FS
782         if (c->vfs_sb)
783                 c->vfs_sb->s_bdi->ra_pages = ra_pages;
784 #endif
785 }
786
787 static inline unsigned bucket_bytes(const struct bch_dev *ca)
788 {
789         return ca->mi.bucket_size << 9;
790 }
791
792 static inline unsigned block_bytes(const struct bch_fs *c)
793 {
794         return c->opts.block_size << 9;
795 }
796
797 #endif /* _BCACHEFS_H */