]> git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/bcachefs.h
Update bcachefs sources to 940d6ca657 bcachefs: acl code improvements
[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
226 #define bch_verbose(c, fmt, ...)                                        \
227 do {                                                                    \
228         if ((c)->opts.verbose_recovery)                                 \
229                 bch_info(c, fmt, ##__VA_ARGS__);                        \
230 } while (0)
231
232 #define pr_verbose_init(opts, fmt, ...)                                 \
233 do {                                                                    \
234         if (opt_get(opts, verbose_init))                                \
235                 pr_info(fmt, ##__VA_ARGS__);                            \
236 } while (0)
237
238 /* Parameters that are useful for debugging, but should always be compiled in: */
239 #define BCH_DEBUG_PARAMS_ALWAYS()                                       \
240         BCH_DEBUG_PARAM(key_merging_disabled,                           \
241                 "Disables merging of extents")                          \
242         BCH_DEBUG_PARAM(btree_gc_always_rewrite,                        \
243                 "Causes mark and sweep to compact and rewrite every "   \
244                 "btree node it traverses")                              \
245         BCH_DEBUG_PARAM(btree_gc_rewrite_disabled,                      \
246                 "Disables rewriting of btree nodes during mark and sweep")\
247         BCH_DEBUG_PARAM(btree_shrinker_disabled,                        \
248                 "Disables the shrinker callback for the btree node cache")
249
250 /* Parameters that should only be compiled in in debug mode: */
251 #define BCH_DEBUG_PARAMS_DEBUG()                                        \
252         BCH_DEBUG_PARAM(expensive_debug_checks,                         \
253                 "Enables various runtime debugging checks that "        \
254                 "significantly affect performance")                     \
255         BCH_DEBUG_PARAM(debug_check_bkeys,                              \
256                 "Run bkey_debugcheck (primarily checking GC/allocation "\
257                 "information) when iterating over keys")                \
258         BCH_DEBUG_PARAM(verify_btree_ondisk,                            \
259                 "Reread btree nodes at various points to verify the "   \
260                 "mergesort in the read path against modifications "     \
261                 "done in memory")                                       \
262         BCH_DEBUG_PARAM(journal_seq_verify,                             \
263                 "Store the journal sequence number in the version "     \
264                 "number of every btree key, and verify that btree "     \
265                 "update ordering is preserved during recovery")
266
267 #define BCH_DEBUG_PARAMS_ALL() BCH_DEBUG_PARAMS_ALWAYS() BCH_DEBUG_PARAMS_DEBUG()
268
269 #ifdef CONFIG_BCACHEFS_DEBUG
270 #define BCH_DEBUG_PARAMS() BCH_DEBUG_PARAMS_ALL()
271 #else
272 #define BCH_DEBUG_PARAMS() BCH_DEBUG_PARAMS_ALWAYS()
273 #endif
274
275 #define BCH_TIME_STATS()                        \
276         x(btree_node_mem_alloc)                 \
277         x(btree_gc)                             \
278         x(btree_split)                          \
279         x(btree_sort)                           \
280         x(btree_read)                           \
281         x(btree_lock_contended_read)            \
282         x(btree_lock_contended_intent)          \
283         x(btree_lock_contended_write)           \
284         x(data_write)                           \
285         x(data_read)                            \
286         x(data_promote)                         \
287         x(journal_write)                        \
288         x(journal_delay)                        \
289         x(journal_blocked)                      \
290         x(journal_flush_seq)
291
292 enum bch_time_stats {
293 #define x(name) BCH_TIME_##name,
294         BCH_TIME_STATS()
295 #undef x
296         BCH_TIME_STAT_NR
297 };
298
299 #include "alloc_types.h"
300 #include "btree_types.h"
301 #include "buckets_types.h"
302 #include "clock_types.h"
303 #include "journal_types.h"
304 #include "keylist_types.h"
305 #include "quota_types.h"
306 #include "rebalance_types.h"
307 #include "super_types.h"
308
309 /* Number of nodes btree coalesce will try to coalesce at once */
310 #define GC_MERGE_NODES          4U
311
312 /* Maximum number of nodes we might need to allocate atomically: */
313 #define BTREE_RESERVE_MAX       (BTREE_MAX_DEPTH + (BTREE_MAX_DEPTH - 1))
314
315 /* Size of the freelist we allocate btree nodes from: */
316 #define BTREE_NODE_RESERVE      (BTREE_RESERVE_MAX * 4)
317
318 struct btree;
319
320 enum gc_phase {
321         GC_PHASE_START,
322         GC_PHASE_SB,
323
324 #define DEF_BTREE_ID(kwd, val, name) GC_PHASE_BTREE_##kwd,
325         DEFINE_BCH_BTREE_IDS()
326 #undef DEF_BTREE_ID
327
328         GC_PHASE_PENDING_DELETE,
329         GC_PHASE_ALLOC,
330         GC_PHASE_DONE
331 };
332
333 struct gc_pos {
334         enum gc_phase           phase;
335         struct bpos             pos;
336         unsigned                level;
337 };
338
339 struct io_count {
340         u64                     sectors[2][BCH_DATA_NR];
341 };
342
343 struct bch_dev {
344         struct kobject          kobj;
345         struct percpu_ref       ref;
346         struct completion       ref_completion;
347         struct percpu_ref       io_ref;
348         struct completion       io_ref_completion;
349
350         struct bch_fs           *fs;
351
352         u8                      dev_idx;
353         /*
354          * Cached version of this device's member info from superblock
355          * Committed by bch2_write_super() -> bch_fs_mi_update()
356          */
357         struct bch_member_cpu   mi;
358         uuid_le                 uuid;
359         char                    name[BDEVNAME_SIZE];
360
361         struct bch_sb_handle    disk_sb;
362         int                     sb_write_error;
363
364         struct bch_devs_mask    self;
365
366         /* biosets used in cloned bios for writing multiple replicas */
367         struct bio_set          replica_set;
368
369         /*
370          * Buckets:
371          * Per-bucket arrays are protected by c->usage_lock, bucket_lock and
372          * gc_lock, for device resize - holding any is sufficient for access:
373          * Or rcu_read_lock(), but only for ptr_stale():
374          */
375         struct bucket_array __rcu *buckets;
376         unsigned long           *buckets_dirty;
377         /* most out of date gen in the btree */
378         u8                      *oldest_gens;
379         struct rw_semaphore     bucket_lock;
380
381         struct bch_dev_usage __percpu *usage_percpu;
382         struct bch_dev_usage    usage_cached;
383
384         /* Allocator: */
385         struct task_struct __rcu *alloc_thread;
386
387         /*
388          * free: Buckets that are ready to be used
389          *
390          * free_inc: Incoming buckets - these are buckets that currently have
391          * cached data in them, and we can't reuse them until after we write
392          * their new gen to disk. After prio_write() finishes writing the new
393          * gens/prios, they'll be moved to the free list (and possibly discarded
394          * in the process)
395          */
396         alloc_fifo              free[RESERVE_NR];
397         alloc_fifo              free_inc;
398         spinlock_t              freelist_lock;
399         size_t                  nr_invalidated;
400
401         u8                      open_buckets_partial[OPEN_BUCKETS_COUNT];
402         unsigned                open_buckets_partial_nr;
403
404         size_t                  fifo_last_bucket;
405
406         /* last calculated minimum prio */
407         u16                     max_last_bucket_io[2];
408
409         atomic_long_t           saturated_count;
410         size_t                  inc_gen_needs_gc;
411         size_t                  inc_gen_really_needs_gc;
412         u64                     allocator_journal_seq_flush;
413         bool                    allocator_invalidating_data;
414         bool                    allocator_blocked;
415
416         alloc_heap              alloc_heap;
417
418         /* Copying GC: */
419         struct task_struct      *copygc_thread;
420         copygc_heap             copygc_heap;
421         struct bch_pd_controller copygc_pd;
422         struct write_point      copygc_write_point;
423
424         atomic64_t              rebalance_work;
425
426         struct journal_device   journal;
427
428         struct work_struct      io_error_work;
429
430         /* The rest of this all shows up in sysfs */
431         atomic64_t              cur_latency[2];
432         struct time_stats       io_latency[2];
433
434 #define CONGESTED_MAX           1024
435         atomic_t                congested;
436         u64                     congested_last;
437
438         struct io_count __percpu *io_done;
439 };
440
441 /*
442  * Flag bits for what phase of startup/shutdown the cache set is at, how we're
443  * shutting down, etc.:
444  *
445  * BCH_FS_UNREGISTERING means we're not just shutting down, we're detaching
446  * all the backing devices first (their cached data gets invalidated, and they
447  * won't automatically reattach).
448  */
449 enum {
450         /* startup: */
451         BCH_FS_ALLOC_READ_DONE,
452         BCH_FS_ALLOCATOR_STARTED,
453         BCH_FS_INITIAL_GC_DONE,
454         BCH_FS_FSCK_DONE,
455         BCH_FS_STARTED,
456
457         /* shutdown: */
458         BCH_FS_EMERGENCY_RO,
459         BCH_FS_WRITE_DISABLE_COMPLETE,
460
461         /* errors: */
462         BCH_FS_ERROR,
463         BCH_FS_GC_FAILURE,
464
465         /* misc: */
466         BCH_FS_BDEV_MOUNTED,
467         BCH_FS_FSCK_FIXED_ERRORS,
468         BCH_FS_FIXED_GENS,
469         BCH_FS_REBUILD_REPLICAS,
470         BCH_FS_HOLD_BTREE_WRITES,
471 };
472
473 struct btree_debug {
474         unsigned                id;
475         struct dentry           *btree;
476         struct dentry           *btree_format;
477         struct dentry           *failed;
478 };
479
480 enum bch_fs_state {
481         BCH_FS_STARTING         = 0,
482         BCH_FS_STOPPING,
483         BCH_FS_RO,
484         BCH_FS_RW,
485 };
486
487 struct bch_fs {
488         struct closure          cl;
489
490         struct list_head        list;
491         struct kobject          kobj;
492         struct kobject          internal;
493         struct kobject          opts_dir;
494         struct kobject          time_stats;
495         unsigned long           flags;
496
497         int                     minor;
498         struct device           *chardev;
499         struct super_block      *vfs_sb;
500         char                    name[40];
501
502         /* ro/rw, add/remove devices: */
503         struct mutex            state_lock;
504         enum bch_fs_state       state;
505
506         /* Counts outstanding writes, for clean transition to read-only */
507         struct percpu_ref       writes;
508         struct work_struct      read_only_work;
509
510         struct bch_dev __rcu    *devs[BCH_SB_MEMBERS_MAX];
511
512         struct bch_replicas_cpu __rcu *replicas;
513         struct bch_replicas_cpu __rcu *replicas_gc;
514         struct mutex            replicas_gc_lock;
515
516         struct bch_disk_groups_cpu __rcu *disk_groups;
517
518         struct bch_opts         opts;
519
520         /* Updated by bch2_sb_update():*/
521         struct {
522                 uuid_le         uuid;
523                 uuid_le         user_uuid;
524
525                 u16             encoded_extent_max;
526
527                 u8              nr_devices;
528                 u8              clean;
529
530                 u8              encryption_type;
531
532                 u64             time_base_lo;
533                 u32             time_base_hi;
534                 u32             time_precision;
535                 u64             features;
536         }                       sb;
537
538         struct bch_sb_handle    disk_sb;
539
540         unsigned short          block_bits;     /* ilog2(block_size) */
541
542         u16                     btree_foreground_merge_threshold;
543
544         struct closure          sb_write;
545         struct mutex            sb_lock;
546
547         /* BTREE CACHE */
548         struct bio_set          btree_bio;
549
550         struct btree_root       btree_roots[BTREE_ID_NR];
551         bool                    btree_roots_dirty;
552         struct mutex            btree_root_lock;
553
554         struct btree_cache      btree_cache;
555
556         mempool_t               btree_reserve_pool;
557
558         /*
559          * Cache of allocated btree nodes - if we allocate a btree node and
560          * don't use it, if we free it that space can't be reused until going
561          * _all_ the way through the allocator (which exposes us to a livelock
562          * when allocating btree reserves fail halfway through) - instead, we
563          * can stick them here:
564          */
565         struct btree_alloc      btree_reserve_cache[BTREE_NODE_RESERVE * 2];
566         unsigned                btree_reserve_cache_nr;
567         struct mutex            btree_reserve_cache_lock;
568
569         mempool_t               btree_interior_update_pool;
570         struct list_head        btree_interior_update_list;
571         struct mutex            btree_interior_update_lock;
572         struct closure_waitlist btree_interior_update_wait;
573
574         struct workqueue_struct *wq;
575         /* copygc needs its own workqueue for index updates.. */
576         struct workqueue_struct *copygc_wq;
577
578         /* ALLOCATION */
579         struct delayed_work     pd_controllers_update;
580         unsigned                pd_controllers_update_seconds;
581
582         struct bch_devs_mask    rw_devs[BCH_DATA_NR];
583
584         u64                     capacity; /* sectors */
585
586         /*
587          * When capacity _decreases_ (due to a disk being removed), we
588          * increment capacity_gen - this invalidates outstanding reservations
589          * and forces them to be revalidated
590          */
591         u32                     capacity_gen;
592
593         atomic64_t              sectors_available;
594
595         struct bch_fs_usage __percpu *usage_percpu;
596         struct bch_fs_usage     usage_cached;
597         struct percpu_rw_semaphore usage_lock;
598
599         struct closure_waitlist freelist_wait;
600
601         /*
602          * When we invalidate buckets, we use both the priority and the amount
603          * of good data to determine which buckets to reuse first - to weight
604          * those together consistently we keep track of the smallest nonzero
605          * priority of any bucket.
606          */
607         struct bucket_clock     bucket_clock[2];
608
609         struct io_clock         io_clock[2];
610
611         /* ALLOCATOR */
612         spinlock_t              freelist_lock;
613         u8                      open_buckets_freelist;
614         u8                      open_buckets_nr_free;
615         struct closure_waitlist open_buckets_wait;
616         struct open_bucket      open_buckets[OPEN_BUCKETS_COUNT];
617
618         struct write_point      btree_write_point;
619         struct write_point      rebalance_write_point;
620
621         struct write_point      write_points[WRITE_POINT_COUNT];
622         struct hlist_head       write_points_hash[WRITE_POINT_COUNT];
623         struct mutex            write_points_hash_lock;
624
625         /* GARBAGE COLLECTION */
626         struct task_struct      *gc_thread;
627         atomic_t                kick_gc;
628         unsigned long           gc_count;
629
630         /*
631          * Tracks GC's progress - everything in the range [ZERO_KEY..gc_cur_pos]
632          * has been marked by GC.
633          *
634          * gc_cur_phase is a superset of btree_ids (BTREE_ID_EXTENTS etc.)
635          *
636          * gc_cur_phase == GC_PHASE_DONE indicates that gc is finished/not
637          * currently running, and gc marks are currently valid
638          *
639          * Protected by gc_pos_lock. Only written to by GC thread, so GC thread
640          * can read without a lock.
641          */
642         seqcount_t              gc_pos_lock;
643         struct gc_pos           gc_pos;
644
645         /*
646          * The allocation code needs gc_mark in struct bucket to be correct, but
647          * it's not while a gc is in progress.
648          */
649         struct rw_semaphore     gc_lock;
650
651         /* IO PATH */
652         struct bio_set          bio_read;
653         struct bio_set          bio_read_split;
654         struct bio_set          bio_write;
655         struct mutex            bio_bounce_pages_lock;
656         mempool_t               bio_bounce_pages;
657         struct rhashtable       promote_table;
658
659         mempool_t               compression_bounce[2];
660         mempool_t               compress_workspace[BCH_COMPRESSION_NR];
661         mempool_t               decompress_workspace;
662         ZSTD_parameters         zstd_params;
663
664         struct crypto_shash     *sha256;
665         struct crypto_skcipher  *chacha20;
666         struct crypto_shash     *poly1305;
667
668         atomic64_t              key_version;
669
670         /* REBALANCE */
671         struct bch_fs_rebalance rebalance;
672
673         /* VFS IO PATH - fs-io.c */
674         struct bio_set          writepage_bioset;
675         struct bio_set          dio_write_bioset;
676         struct bio_set          dio_read_bioset;
677
678         struct bio_list         btree_write_error_list;
679         struct work_struct      btree_write_error_work;
680         spinlock_t              btree_write_error_lock;
681
682         /* ERRORS */
683         struct list_head        fsck_errors;
684         struct mutex            fsck_error_lock;
685         bool                    fsck_alloc_err;
686
687         /* FILESYSTEM */
688         atomic_long_t           nr_inodes;
689
690         /* QUOTAS */
691         struct bch_memquota_type quotas[QTYP_NR];
692
693         /* DEBUG JUNK */
694         struct dentry           *debug;
695         struct btree_debug      btree_debug[BTREE_ID_NR];
696 #ifdef CONFIG_BCACHEFS_DEBUG
697         struct btree            *verify_data;
698         struct btree_node       *verify_ondisk;
699         struct mutex            verify_lock;
700 #endif
701
702         u64                     unused_inode_hint;
703
704         /*
705          * A btree node on disk could have too many bsets for an iterator to fit
706          * on the stack - have to dynamically allocate them
707          */
708         mempool_t               fill_iter;
709
710         mempool_t               btree_bounce_pool;
711
712         struct journal          journal;
713
714         unsigned                bucket_journal_seq;
715
716         /* The rest of this all shows up in sysfs */
717         atomic_long_t           read_realloc_races;
718         atomic_long_t           extent_migrate_done;
719         atomic_long_t           extent_migrate_raced;
720
721         unsigned                btree_gc_periodic:1;
722         unsigned                copy_gc_enabled:1;
723         bool                    promote_whole_extents;
724
725 #define BCH_DEBUG_PARAM(name, description) bool name;
726         BCH_DEBUG_PARAMS_ALL()
727 #undef BCH_DEBUG_PARAM
728
729         struct time_stats       times[BCH_TIME_STAT_NR];
730 };
731
732 static inline void bch2_set_ra_pages(struct bch_fs *c, unsigned ra_pages)
733 {
734 #ifndef NO_BCACHEFS_FS
735         if (c->vfs_sb)
736                 c->vfs_sb->s_bdi->ra_pages = ra_pages;
737 #endif
738 }
739
740 static inline bool bch2_fs_running(struct bch_fs *c)
741 {
742         return c->state == BCH_FS_RO || c->state == BCH_FS_RW;
743 }
744
745 static inline unsigned bucket_bytes(const struct bch_dev *ca)
746 {
747         return ca->mi.bucket_size << 9;
748 }
749
750 static inline unsigned block_bytes(const struct bch_fs *c)
751 {
752         return c->opts.block_size << 9;
753 }
754
755 #endif /* _BCACHEFS_H */