]> git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/bcachefs.h
Update bcachefs sources to 6406e05835 bcachefs: Nocow support
[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 can't arbitrarily allocate and
111  * free smaller than a bucket - so, that's how big our btree nodes are.
112  *
113  * (If buckets are really big we'll only use part of the bucket for a btree node
114  * - no less than 1/4th - but a bucket still contains no more than a single
115  * btree node. I'd actually like to change this, but for now we rely on the
116  * bucket's gen for deleting btree nodes when we rewrite/split a node.)
117  *
118  * Anyways, btree nodes are big - big enough to be inefficient with a textbook
119  * btree implementation.
120  *
121  * The way this is solved is that btree nodes are internally log structured; we
122  * can append new keys to an existing btree node without rewriting it. This
123  * means each set of keys we write is sorted, but the node is not.
124  *
125  * We maintain this log structure in memory - keeping 1Mb of keys sorted would
126  * be expensive, and we have to distinguish between the keys we have written and
127  * the keys we haven't. So to do a lookup in a btree node, we have to search
128  * each sorted set. But we do merge written sets together lazily, so the cost of
129  * these extra searches is quite low (normally most of the keys in a btree node
130  * will be in one big set, and then there'll be one or two sets that are much
131  * smaller).
132  *
133  * This log structure makes bcache's btree more of a hybrid between a
134  * conventional btree and a compacting data structure, with some of the
135  * advantages of both.
136  *
137  * GARBAGE COLLECTION:
138  *
139  * We can't just invalidate any bucket - it might contain dirty data or
140  * metadata. If it once contained dirty data, other writes might overwrite it
141  * later, leaving no valid pointers into that bucket in the index.
142  *
143  * Thus, the primary purpose of garbage collection is to find buckets to reuse.
144  * It also counts how much valid data it each bucket currently contains, so that
145  * allocation can reuse buckets sooner when they've been mostly overwritten.
146  *
147  * It also does some things that are really internal to the btree
148  * implementation. If a btree node contains pointers that are stale by more than
149  * some threshold, it rewrites the btree node to avoid the bucket's generation
150  * wrapping around. It also merges adjacent btree nodes if they're empty enough.
151  *
152  * THE JOURNAL:
153  *
154  * Bcache's journal is not necessary for consistency; we always strictly
155  * order metadata writes so that the btree and everything else is consistent on
156  * disk in the event of an unclean shutdown, and in fact bcache had writeback
157  * caching (with recovery from unclean shutdown) before journalling was
158  * implemented.
159  *
160  * Rather, the journal is purely a performance optimization; we can't complete a
161  * write until we've updated the index on disk, otherwise the cache would be
162  * inconsistent in the event of an unclean shutdown. This means that without the
163  * journal, on random write workloads we constantly have to update all the leaf
164  * nodes in the btree, and those writes will be mostly empty (appending at most
165  * a few keys each) - highly inefficient in terms of amount of metadata writes,
166  * and it puts more strain on the various btree resorting/compacting code.
167  *
168  * The journal is just a log of keys we've inserted; on startup we just reinsert
169  * all the keys in the open journal entries. That means that when we're updating
170  * a node in the btree, we can wait until a 4k block of keys fills up before
171  * writing them out.
172  *
173  * For simplicity, we only journal updates to leaf nodes; updates to parent
174  * nodes are rare enough (since our leaf nodes are huge) that it wasn't worth
175  * the complexity to deal with journalling them (in particular, journal replay)
176  * - updates to non leaf nodes just happen synchronously (see btree_split()).
177  */
178
179 #undef pr_fmt
180 #ifdef __KERNEL__
181 #define pr_fmt(fmt) "bcachefs: %s() " fmt "\n", __func__
182 #else
183 #define pr_fmt(fmt) "%s() " fmt "\n", __func__
184 #endif
185
186 #include <linux/backing-dev-defs.h>
187 #include <linux/bug.h>
188 #include <linux/bio.h>
189 #include <linux/closure.h>
190 #include <linux/kobject.h>
191 #include <linux/list.h>
192 #include <linux/math64.h>
193 #include <linux/mutex.h>
194 #include <linux/percpu-refcount.h>
195 #include <linux/percpu-rwsem.h>
196 #include <linux/rhashtable.h>
197 #include <linux/rwsem.h>
198 #include <linux/semaphore.h>
199 #include <linux/seqlock.h>
200 #include <linux/shrinker.h>
201 #include <linux/srcu.h>
202 #include <linux/types.h>
203 #include <linux/workqueue.h>
204 #include <linux/zstd.h>
205
206 #include "bcachefs_format.h"
207 #include "errcode.h"
208 #include "fifo.h"
209 #include "nocow_locking.h"
210 #include "opts.h"
211 #include "util.h"
212
213 #define dynamic_fault(...)              0
214 #define race_fault(...)                 0
215
216 #define trace_and_count(_c, _name, ...)                                 \
217 do {                                                                    \
218         this_cpu_inc((_c)->counters[BCH_COUNTER_##_name]);              \
219         trace_##_name(__VA_ARGS__);                                     \
220 } while (0)
221
222 #define bch2_fs_init_fault(name)                                        \
223         dynamic_fault("bcachefs:bch_fs_init:" name)
224 #define bch2_meta_read_fault(name)                                      \
225          dynamic_fault("bcachefs:meta:read:" name)
226 #define bch2_meta_write_fault(name)                                     \
227          dynamic_fault("bcachefs:meta:write:" name)
228
229 #ifdef __KERNEL__
230 #define BCACHEFS_LOG_PREFIX
231 #endif
232
233 #ifdef BCACHEFS_LOG_PREFIX
234
235 #define bch2_log_msg(_c, fmt)                   "bcachefs (%s): " fmt, ((_c)->name)
236 #define bch2_fmt_dev(_ca, fmt)                  "bcachefs (%s): " fmt "\n", ((_ca)->name)
237 #define bch2_fmt_dev_offset(_ca, _offset, fmt)  "bcachefs (%s sector %llu): " fmt "\n", ((_ca)->name), (_offset)
238 #define bch2_fmt_inum(_c, _inum, fmt)           "bcachefs (%s inum %llu): " fmt "\n", ((_c)->name), (_inum)
239 #define bch2_fmt_inum_offset(_c, _inum, _offset, fmt)                   \
240          "bcachefs (%s inum %llu offset %llu): " fmt "\n", ((_c)->name), (_inum), (_offset)
241
242 #else
243
244 #define bch2_log_msg(_c, fmt)                   fmt
245 #define bch2_fmt_dev(_ca, fmt)                  "%s: " fmt "\n", ((_ca)->name)
246 #define bch2_fmt_dev_offset(_ca, _offset, fmt)  "%s sector %llu: " fmt "\n", ((_ca)->name), (_offset)
247 #define bch2_fmt_inum(_c, _inum, fmt)           "inum %llu: " fmt "\n", (_inum)
248 #define bch2_fmt_inum_offset(_c, _inum, _offset, fmt)                           \
249          "inum %llu offset %llu: " fmt "\n", (_inum), (_offset)
250
251 #endif
252
253 #define bch2_fmt(_c, fmt)               bch2_log_msg(_c, fmt "\n")
254
255 #define bch_info(c, fmt, ...) \
256         printk(KERN_INFO bch2_fmt(c, fmt), ##__VA_ARGS__)
257 #define bch_notice(c, fmt, ...) \
258         printk(KERN_NOTICE bch2_fmt(c, fmt), ##__VA_ARGS__)
259 #define bch_warn(c, fmt, ...) \
260         printk(KERN_WARNING bch2_fmt(c, fmt), ##__VA_ARGS__)
261 #define bch_warn_ratelimited(c, fmt, ...) \
262         printk_ratelimited(KERN_WARNING bch2_fmt(c, fmt), ##__VA_ARGS__)
263
264 #define bch_err(c, fmt, ...) \
265         printk(KERN_ERR bch2_fmt(c, fmt), ##__VA_ARGS__)
266 #define bch_err_dev(ca, fmt, ...) \
267         printk(KERN_ERR bch2_fmt_dev(ca, fmt), ##__VA_ARGS__)
268 #define bch_err_dev_offset(ca, _offset, fmt, ...) \
269         printk(KERN_ERR bch2_fmt_dev_offset(ca, _offset, fmt), ##__VA_ARGS__)
270 #define bch_err_inum(c, _inum, fmt, ...) \
271         printk(KERN_ERR bch2_fmt_inum(c, _inum, fmt), ##__VA_ARGS__)
272 #define bch_err_inum_offset(c, _inum, _offset, fmt, ...) \
273         printk(KERN_ERR bch2_fmt_inum_offset(c, _inum, _offset, fmt), ##__VA_ARGS__)
274
275 #define bch_err_ratelimited(c, fmt, ...) \
276         printk_ratelimited(KERN_ERR bch2_fmt(c, fmt), ##__VA_ARGS__)
277 #define bch_err_dev_ratelimited(ca, fmt, ...) \
278         printk_ratelimited(KERN_ERR bch2_fmt_dev(ca, fmt), ##__VA_ARGS__)
279 #define bch_err_dev_offset_ratelimited(ca, _offset, fmt, ...) \
280         printk_ratelimited(KERN_ERR bch2_fmt_dev_offset(ca, _offset, fmt), ##__VA_ARGS__)
281 #define bch_err_inum_ratelimited(c, _inum, fmt, ...) \
282         printk_ratelimited(KERN_ERR bch2_fmt_inum(c, _inum, fmt), ##__VA_ARGS__)
283 #define bch_err_inum_offset_ratelimited(c, _inum, _offset, fmt, ...) \
284         printk_ratelimited(KERN_ERR bch2_fmt_inum_offset(c, _inum, _offset, fmt), ##__VA_ARGS__)
285
286 #define bch_verbose(c, fmt, ...)                                        \
287 do {                                                                    \
288         if ((c)->opts.verbose)                                          \
289                 bch_info(c, fmt, ##__VA_ARGS__);                        \
290 } while (0)
291
292 #define pr_verbose_init(opts, fmt, ...)                                 \
293 do {                                                                    \
294         if (opt_get(opts, verbose))                                     \
295                 pr_info(fmt, ##__VA_ARGS__);                            \
296 } while (0)
297
298 /* Parameters that are useful for debugging, but should always be compiled in: */
299 #define BCH_DEBUG_PARAMS_ALWAYS()                                       \
300         BCH_DEBUG_PARAM(key_merging_disabled,                           \
301                 "Disables merging of extents")                          \
302         BCH_DEBUG_PARAM(btree_gc_always_rewrite,                        \
303                 "Causes mark and sweep to compact and rewrite every "   \
304                 "btree node it traverses")                              \
305         BCH_DEBUG_PARAM(btree_gc_rewrite_disabled,                      \
306                 "Disables rewriting of btree nodes during mark and sweep")\
307         BCH_DEBUG_PARAM(btree_shrinker_disabled,                        \
308                 "Disables the shrinker callback for the btree node cache")\
309         BCH_DEBUG_PARAM(verify_btree_ondisk,                            \
310                 "Reread btree nodes at various points to verify the "   \
311                 "mergesort in the read path against modifications "     \
312                 "done in memory")                                       \
313         BCH_DEBUG_PARAM(verify_all_btree_replicas,                      \
314                 "When reading btree nodes, read all replicas and "      \
315                 "compare them")
316
317 /* Parameters that should only be compiled in debug mode: */
318 #define BCH_DEBUG_PARAMS_DEBUG()                                        \
319         BCH_DEBUG_PARAM(expensive_debug_checks,                         \
320                 "Enables various runtime debugging checks that "        \
321                 "significantly affect performance")                     \
322         BCH_DEBUG_PARAM(debug_check_iterators,                          \
323                 "Enables extra verification for btree iterators")       \
324         BCH_DEBUG_PARAM(debug_check_btree_accounting,                   \
325                 "Verify btree accounting for keys within a node")       \
326         BCH_DEBUG_PARAM(journal_seq_verify,                             \
327                 "Store the journal sequence number in the version "     \
328                 "number of every btree key, and verify that btree "     \
329                 "update ordering is preserved during recovery")         \
330         BCH_DEBUG_PARAM(inject_invalid_keys,                            \
331                 "Store the journal sequence number in the version "     \
332                 "number of every btree key, and verify that btree "     \
333                 "update ordering is preserved during recovery")         \
334         BCH_DEBUG_PARAM(test_alloc_startup,                             \
335                 "Force allocator startup to use the slowpath where it"  \
336                 "can't find enough free buckets without invalidating"   \
337                 "cached data")                                          \
338         BCH_DEBUG_PARAM(force_reconstruct_read,                         \
339                 "Force reads to use the reconstruct path, when reading" \
340                 "from erasure coded extents")                           \
341         BCH_DEBUG_PARAM(test_restart_gc,                                \
342                 "Test restarting mark and sweep gc when bucket gens change")
343
344 #define BCH_DEBUG_PARAMS_ALL() BCH_DEBUG_PARAMS_ALWAYS() BCH_DEBUG_PARAMS_DEBUG()
345
346 #ifdef CONFIG_BCACHEFS_DEBUG
347 #define BCH_DEBUG_PARAMS() BCH_DEBUG_PARAMS_ALL()
348 #else
349 #define BCH_DEBUG_PARAMS() BCH_DEBUG_PARAMS_ALWAYS()
350 #endif
351
352 #define BCH_DEBUG_PARAM(name, description) extern bool bch2_##name;
353 BCH_DEBUG_PARAMS()
354 #undef BCH_DEBUG_PARAM
355
356 #ifndef CONFIG_BCACHEFS_DEBUG
357 #define BCH_DEBUG_PARAM(name, description) static const bool bch2_##name;
358 BCH_DEBUG_PARAMS_DEBUG()
359 #undef BCH_DEBUG_PARAM
360 #endif
361
362 #define BCH_TIME_STATS()                        \
363         x(btree_node_mem_alloc)                 \
364         x(btree_node_split)                     \
365         x(btree_node_compact)                   \
366         x(btree_node_merge)                     \
367         x(btree_node_sort)                      \
368         x(btree_node_read)                      \
369         x(btree_interior_update_foreground)     \
370         x(btree_interior_update_total)          \
371         x(btree_gc)                             \
372         x(data_write)                           \
373         x(data_read)                            \
374         x(data_promote)                         \
375         x(journal_flush_write)                  \
376         x(journal_noflush_write)                \
377         x(journal_flush_seq)                    \
378         x(blocked_journal)                      \
379         x(blocked_allocate)                     \
380         x(blocked_allocate_open_bucket)         \
381         x(nocow_lock_contended)
382
383 enum bch_time_stats {
384 #define x(name) BCH_TIME_##name,
385         BCH_TIME_STATS()
386 #undef x
387         BCH_TIME_STAT_NR
388 };
389
390 #include "alloc_types.h"
391 #include "btree_types.h"
392 #include "buckets_types.h"
393 #include "buckets_waiting_for_journal_types.h"
394 #include "clock_types.h"
395 #include "ec_types.h"
396 #include "journal_types.h"
397 #include "keylist_types.h"
398 #include "quota_types.h"
399 #include "rebalance_types.h"
400 #include "replicas_types.h"
401 #include "subvolume_types.h"
402 #include "super_types.h"
403
404 /* Number of nodes btree coalesce will try to coalesce at once */
405 #define GC_MERGE_NODES          4U
406
407 /* Maximum number of nodes we might need to allocate atomically: */
408 #define BTREE_RESERVE_MAX       (BTREE_MAX_DEPTH + (BTREE_MAX_DEPTH - 1))
409
410 /* Size of the freelist we allocate btree nodes from: */
411 #define BTREE_NODE_RESERVE      (BTREE_RESERVE_MAX * 4)
412
413 #define BTREE_NODE_OPEN_BUCKET_RESERVE  (BTREE_RESERVE_MAX * BCH_REPLICAS_MAX)
414
415 struct btree;
416
417 enum gc_phase {
418         GC_PHASE_NOT_RUNNING,
419         GC_PHASE_START,
420         GC_PHASE_SB,
421
422         GC_PHASE_BTREE_stripes,
423         GC_PHASE_BTREE_extents,
424         GC_PHASE_BTREE_inodes,
425         GC_PHASE_BTREE_dirents,
426         GC_PHASE_BTREE_xattrs,
427         GC_PHASE_BTREE_alloc,
428         GC_PHASE_BTREE_quotas,
429         GC_PHASE_BTREE_reflink,
430         GC_PHASE_BTREE_subvolumes,
431         GC_PHASE_BTREE_snapshots,
432         GC_PHASE_BTREE_lru,
433         GC_PHASE_BTREE_freespace,
434         GC_PHASE_BTREE_need_discard,
435         GC_PHASE_BTREE_backpointers,
436
437         GC_PHASE_PENDING_DELETE,
438 };
439
440 struct gc_pos {
441         enum gc_phase           phase;
442         struct bpos             pos;
443         unsigned                level;
444 };
445
446 struct reflink_gc {
447         u64             offset;
448         u32             size;
449         u32             refcount;
450 };
451
452 typedef GENRADIX(struct reflink_gc) reflink_gc_table;
453
454 struct io_count {
455         u64                     sectors[2][BCH_DATA_NR];
456 };
457
458 struct bch_dev {
459         struct kobject          kobj;
460         struct percpu_ref       ref;
461         struct completion       ref_completion;
462         struct percpu_ref       io_ref;
463         struct completion       io_ref_completion;
464
465         struct bch_fs           *fs;
466
467         u8                      dev_idx;
468         /*
469          * Cached version of this device's member info from superblock
470          * Committed by bch2_write_super() -> bch_fs_mi_update()
471          */
472         struct bch_member_cpu   mi;
473         uuid_le                 uuid;
474         char                    name[BDEVNAME_SIZE];
475
476         struct bch_sb_handle    disk_sb;
477         struct bch_sb           *sb_read_scratch;
478         int                     sb_write_error;
479         dev_t                   dev;
480         atomic_t                flush_seq;
481
482         struct bch_devs_mask    self;
483
484         /* biosets used in cloned bios for writing multiple replicas */
485         struct bio_set          replica_set;
486
487         /*
488          * Buckets:
489          * Per-bucket arrays are protected by c->mark_lock, bucket_lock and
490          * gc_lock, for device resize - holding any is sufficient for access:
491          * Or rcu_read_lock(), but only for ptr_stale():
492          */
493         struct bucket_array __rcu *buckets_gc;
494         struct bucket_gens __rcu *bucket_gens;
495         u8                      *oldest_gen;
496         unsigned long           *buckets_nouse;
497         struct rw_semaphore     bucket_lock;
498
499         struct bch_dev_usage            *usage_base;
500         struct bch_dev_usage __percpu   *usage[JOURNAL_BUF_NR];
501         struct bch_dev_usage __percpu   *usage_gc;
502
503         /* Allocator: */
504         u64                     new_fs_bucket_idx;
505         u64                     bucket_alloc_trans_early_cursor;
506
507         unsigned                nr_open_buckets;
508         unsigned                nr_btree_reserve;
509
510         open_bucket_idx_t       open_buckets_partial[OPEN_BUCKETS_COUNT];
511         open_bucket_idx_t       open_buckets_partial_nr;
512
513         size_t                  inc_gen_needs_gc;
514         size_t                  inc_gen_really_needs_gc;
515         size_t                  buckets_waiting_on_journal;
516
517         atomic64_t              rebalance_work;
518
519         struct journal_device   journal;
520         u64                     prev_journal_sector;
521
522         struct work_struct      io_error_work;
523
524         /* The rest of this all shows up in sysfs */
525         atomic64_t              cur_latency[2];
526         struct time_stats       io_latency[2];
527
528 #define CONGESTED_MAX           1024
529         atomic_t                congested;
530         u64                     congested_last;
531
532         struct io_count __percpu *io_done;
533 };
534
535 enum {
536         /* startup: */
537         BCH_FS_STARTED,
538         BCH_FS_MAY_GO_RW,
539         BCH_FS_RW,
540         BCH_FS_WAS_RW,
541
542         /* shutdown: */
543         BCH_FS_STOPPING,
544         BCH_FS_EMERGENCY_RO,
545         BCH_FS_WRITE_DISABLE_COMPLETE,
546         BCH_FS_CLEAN_SHUTDOWN,
547
548         /* fsck passes: */
549         BCH_FS_TOPOLOGY_REPAIR_DONE,
550         BCH_FS_INITIAL_GC_DONE,         /* kill when we enumerate fsck passes */
551         BCH_FS_CHECK_LRUS_DONE,
552         BCH_FS_CHECK_BACKPOINTERS_DONE,
553         BCH_FS_CHECK_ALLOC_TO_LRU_REFS_DONE,
554         BCH_FS_FSCK_DONE,
555         BCH_FS_INITIAL_GC_UNFIXED,      /* kill when we enumerate fsck errors */
556         BCH_FS_NEED_ANOTHER_GC,
557
558         BCH_FS_HAVE_DELETED_SNAPSHOTS,
559
560         /* errors: */
561         BCH_FS_ERROR,
562         BCH_FS_TOPOLOGY_ERROR,
563         BCH_FS_ERRORS_FIXED,
564         BCH_FS_ERRORS_NOT_FIXED,
565 };
566
567 struct btree_debug {
568         unsigned                id;
569 };
570
571 #define BCH_TRANSACTIONS_NR 128
572
573 struct btree_transaction_stats {
574         struct mutex            lock;
575         struct time_stats       lock_hold_times;
576         unsigned                nr_max_paths;
577         unsigned                max_mem;
578         char                    *max_paths_text;
579 };
580
581 struct bch_fs_pcpu {
582         u64                     sectors_available;
583 };
584
585 struct journal_seq_blacklist_table {
586         size_t                  nr;
587         struct journal_seq_blacklist_table_entry {
588                 u64             start;
589                 u64             end;
590                 bool            dirty;
591         }                       entries[0];
592 };
593
594 struct journal_keys {
595         struct journal_key {
596                 u64             journal_seq;
597                 u32             journal_offset;
598                 enum btree_id   btree_id:8;
599                 unsigned        level:8;
600                 bool            allocated;
601                 bool            overwritten;
602                 struct bkey_i   *k;
603         }                       *d;
604         /*
605          * Gap buffer: instead of all the empty space in the array being at the
606          * end of the buffer - from @nr to @size - the empty space is at @gap.
607          * This means that sequential insertions are O(n) instead of O(n^2).
608          */
609         size_t                  gap;
610         size_t                  nr;
611         size_t                  size;
612 };
613
614 struct btree_path_buf {
615         struct btree_path       *path;
616 };
617
618 #define REPLICAS_DELTA_LIST_MAX (1U << 16)
619
620 struct snapshot_t {
621         u32                     parent;
622         u32                     children[2];
623         u32                     subvol; /* Nonzero only if a subvolume points to this node: */
624         u32                     equiv;
625 };
626
627 typedef struct {
628         u32             subvol;
629         u64             inum;
630 } subvol_inum;
631
632 #define BCACHEFS_ROOT_SUBVOL_INUM                                       \
633         ((subvol_inum) { BCACHEFS_ROOT_SUBVOL,  BCACHEFS_ROOT_INO })
634
635 struct bch_fs {
636         struct closure          cl;
637
638         struct list_head        list;
639         struct kobject          kobj;
640         struct kobject          counters_kobj;
641         struct kobject          internal;
642         struct kobject          opts_dir;
643         struct kobject          time_stats;
644         unsigned long           flags;
645
646         int                     minor;
647         struct device           *chardev;
648         struct super_block      *vfs_sb;
649         dev_t                   dev;
650         char                    name[40];
651
652         /* ro/rw, add/remove/resize devices: */
653         struct rw_semaphore     state_lock;
654
655         /* Counts outstanding writes, for clean transition to read-only */
656         struct percpu_ref       writes;
657         struct work_struct      read_only_work;
658
659         struct bch_dev __rcu    *devs[BCH_SB_MEMBERS_MAX];
660
661         struct bch_replicas_cpu replicas;
662         struct bch_replicas_cpu replicas_gc;
663         struct mutex            replicas_gc_lock;
664         mempool_t               replicas_delta_pool;
665
666         struct journal_entry_res btree_root_journal_res;
667         struct journal_entry_res replicas_journal_res;
668         struct journal_entry_res clock_journal_res;
669         struct journal_entry_res dev_usage_journal_res;
670
671         struct bch_disk_groups_cpu __rcu *disk_groups;
672
673         struct bch_opts         opts;
674
675         /* Updated by bch2_sb_update():*/
676         struct {
677                 uuid_le         uuid;
678                 uuid_le         user_uuid;
679
680                 u16             version;
681                 u16             version_min;
682
683                 u8              nr_devices;
684                 u8              clean;
685
686                 u8              encryption_type;
687
688                 u64             time_base_lo;
689                 u32             time_base_hi;
690                 unsigned        time_units_per_sec;
691                 unsigned        nsec_per_time_unit;
692                 u64             features;
693                 u64             compat;
694         }                       sb;
695
696
697         struct bch_sb_handle    disk_sb;
698
699         unsigned short          block_bits;     /* ilog2(block_size) */
700
701         u16                     btree_foreground_merge_threshold;
702
703         struct closure          sb_write;
704         struct mutex            sb_lock;
705
706         /* snapshot.c: */
707         GENRADIX(struct snapshot_t) snapshots;
708         struct bch_snapshot_table __rcu *snapshot_table;
709         struct mutex            snapshot_table_lock;
710         struct work_struct      snapshot_delete_work;
711         struct work_struct      snapshot_wait_for_pagecache_and_delete_work;
712         snapshot_id_list        snapshots_unlinked;
713         struct mutex            snapshots_unlinked_lock;
714
715         /* BTREE CACHE */
716         struct bio_set          btree_bio;
717         struct workqueue_struct *io_complete_wq;
718
719         struct btree_root       btree_roots[BTREE_ID_NR];
720         struct mutex            btree_root_lock;
721
722         struct btree_cache      btree_cache;
723
724         /*
725          * Cache of allocated btree nodes - if we allocate a btree node and
726          * don't use it, if we free it that space can't be reused until going
727          * _all_ the way through the allocator (which exposes us to a livelock
728          * when allocating btree reserves fail halfway through) - instead, we
729          * can stick them here:
730          */
731         struct btree_alloc      btree_reserve_cache[BTREE_NODE_RESERVE * 2];
732         unsigned                btree_reserve_cache_nr;
733         struct mutex            btree_reserve_cache_lock;
734
735         mempool_t               btree_interior_update_pool;
736         struct list_head        btree_interior_update_list;
737         struct list_head        btree_interior_updates_unwritten;
738         struct mutex            btree_interior_update_lock;
739         struct closure_waitlist btree_interior_update_wait;
740
741         struct workqueue_struct *btree_interior_update_worker;
742         struct work_struct      btree_interior_update_work;
743
744         /* btree_io.c: */
745         spinlock_t              btree_write_error_lock;
746         struct btree_write_stats {
747                 atomic64_t      nr;
748                 atomic64_t      bytes;
749         }                       btree_write_stats[BTREE_WRITE_TYPE_NR];
750
751         /* btree_iter.c: */
752         struct mutex            btree_trans_lock;
753         struct list_head        btree_trans_list;
754         mempool_t               btree_paths_pool;
755         mempool_t               btree_trans_mem_pool;
756         struct btree_path_buf  __percpu *btree_paths_bufs;
757
758         struct srcu_struct      btree_trans_barrier;
759         bool                    btree_trans_barrier_initialized;
760
761         struct btree_key_cache  btree_key_cache;
762         unsigned                btree_key_cache_btrees;
763
764         struct workqueue_struct *btree_update_wq;
765         struct workqueue_struct *btree_io_complete_wq;
766         /* copygc needs its own workqueue for index updates.. */
767         struct workqueue_struct *copygc_wq;
768
769         /* ALLOCATION */
770         struct bch_devs_mask    rw_devs[BCH_DATA_NR];
771
772         u64                     capacity; /* sectors */
773
774         /*
775          * When capacity _decreases_ (due to a disk being removed), we
776          * increment capacity_gen - this invalidates outstanding reservations
777          * and forces them to be revalidated
778          */
779         u32                     capacity_gen;
780         unsigned                bucket_size_max;
781
782         atomic64_t              sectors_available;
783         struct mutex            sectors_available_lock;
784
785         struct bch_fs_pcpu __percpu     *pcpu;
786
787         struct percpu_rw_semaphore      mark_lock;
788
789         seqcount_t                      usage_lock;
790         struct bch_fs_usage             *usage_base;
791         struct bch_fs_usage __percpu    *usage[JOURNAL_BUF_NR];
792         struct bch_fs_usage __percpu    *usage_gc;
793         u64 __percpu            *online_reserved;
794
795         /* single element mempool: */
796         struct mutex            usage_scratch_lock;
797         struct bch_fs_usage_online *usage_scratch;
798
799         struct io_clock         io_clock[2];
800
801         /* JOURNAL SEQ BLACKLIST */
802         struct journal_seq_blacklist_table *
803                                 journal_seq_blacklist_table;
804         struct work_struct      journal_seq_blacklist_gc_work;
805
806         /* ALLOCATOR */
807         spinlock_t              freelist_lock;
808         struct closure_waitlist freelist_wait;
809         u64                     blocked_allocate;
810         u64                     blocked_allocate_open_bucket;
811
812         open_bucket_idx_t       open_buckets_freelist;
813         open_bucket_idx_t       open_buckets_nr_free;
814         struct closure_waitlist open_buckets_wait;
815         struct open_bucket      open_buckets[OPEN_BUCKETS_COUNT];
816         open_bucket_idx_t       open_buckets_hash[OPEN_BUCKETS_COUNT];
817
818         struct write_point      btree_write_point;
819         struct write_point      rebalance_write_point;
820
821         struct write_point      write_points[WRITE_POINT_MAX];
822         struct hlist_head       write_points_hash[WRITE_POINT_HASH_NR];
823         struct mutex            write_points_hash_lock;
824         unsigned                write_points_nr;
825
826         struct buckets_waiting_for_journal buckets_waiting_for_journal;
827         struct work_struct      discard_work;
828         struct work_struct      invalidate_work;
829
830         /* GARBAGE COLLECTION */
831         struct task_struct      *gc_thread;
832         atomic_t                kick_gc;
833         unsigned long           gc_count;
834
835         enum btree_id           gc_gens_btree;
836         struct bpos             gc_gens_pos;
837
838         /*
839          * Tracks GC's progress - everything in the range [ZERO_KEY..gc_cur_pos]
840          * has been marked by GC.
841          *
842          * gc_cur_phase is a superset of btree_ids (BTREE_ID_extents etc.)
843          *
844          * Protected by gc_pos_lock. Only written to by GC thread, so GC thread
845          * can read without a lock.
846          */
847         seqcount_t              gc_pos_lock;
848         struct gc_pos           gc_pos;
849
850         /*
851          * The allocation code needs gc_mark in struct bucket to be correct, but
852          * it's not while a gc is in progress.
853          */
854         struct rw_semaphore     gc_lock;
855         struct mutex            gc_gens_lock;
856
857         /* IO PATH */
858         struct bio_set          bio_read;
859         struct bio_set          bio_read_split;
860         struct bio_set          bio_write;
861         struct mutex            bio_bounce_pages_lock;
862         mempool_t               bio_bounce_pages;
863         struct bucket_nocow_lock_table
864                                 nocow_locks;
865         struct rhashtable       promote_table;
866
867         mempool_t               compression_bounce[2];
868         mempool_t               compress_workspace[BCH_COMPRESSION_TYPE_NR];
869         mempool_t               decompress_workspace;
870         ZSTD_parameters         zstd_params;
871
872         struct crypto_shash     *sha256;
873         struct crypto_sync_skcipher *chacha20;
874         struct crypto_shash     *poly1305;
875
876         atomic64_t              key_version;
877
878         mempool_t               large_bkey_pool;
879
880         /* REBALANCE */
881         struct bch_fs_rebalance rebalance;
882
883         /* COPYGC */
884         struct task_struct      *copygc_thread;
885         copygc_heap             copygc_heap;
886         struct write_point      copygc_write_point;
887         s64                     copygc_wait;
888         bool                    copygc_running;
889         wait_queue_head_t       copygc_running_wq;
890
891         /* DATA PROGRESS STATS */
892         struct list_head        data_progress_list;
893         struct mutex            data_progress_lock;
894
895         /* STRIPES: */
896         GENRADIX(struct stripe) stripes;
897         GENRADIX(struct gc_stripe) gc_stripes;
898
899         ec_stripes_heap         ec_stripes_heap;
900         spinlock_t              ec_stripes_heap_lock;
901
902         /* ERASURE CODING */
903         struct list_head        ec_stripe_head_list;
904         struct mutex            ec_stripe_head_lock;
905
906         struct list_head        ec_stripe_new_list;
907         struct mutex            ec_stripe_new_lock;
908
909         struct work_struct      ec_stripe_create_work;
910         u64                     ec_stripe_hint;
911
912         struct bio_set          ec_bioset;
913
914         struct work_struct      ec_stripe_delete_work;
915         struct llist_head       ec_stripe_delete_list;
916
917         /* REFLINK */
918         u64                     reflink_hint;
919         reflink_gc_table        reflink_gc_table;
920         size_t                  reflink_gc_nr;
921
922         /* VFS IO PATH - fs-io.c */
923         struct bio_set          writepage_bioset;
924         struct bio_set          dio_write_bioset;
925         struct bio_set          dio_read_bioset;
926         struct bio_set          nocow_flush_bioset;
927
928         /* ERRORS */
929         struct list_head        fsck_errors;
930         struct mutex            fsck_error_lock;
931         bool                    fsck_alloc_err;
932
933         /* QUOTAS */
934         struct bch_memquota_type quotas[QTYP_NR];
935
936         /* DEBUG JUNK */
937         struct dentry           *fs_debug_dir;
938         struct dentry           *btree_debug_dir;
939         struct btree_debug      btree_debug[BTREE_ID_NR];
940         struct btree            *verify_data;
941         struct btree_node       *verify_ondisk;
942         struct mutex            verify_lock;
943
944         u64                     *unused_inode_hints;
945         unsigned                inode_shard_bits;
946
947         /*
948          * A btree node on disk could have too many bsets for an iterator to fit
949          * on the stack - have to dynamically allocate them
950          */
951         mempool_t               fill_iter;
952
953         mempool_t               btree_bounce_pool;
954
955         struct journal          journal;
956         GENRADIX(struct journal_replay *) journal_entries;
957         u64                     journal_entries_base_seq;
958         struct journal_keys     journal_keys;
959         struct list_head        journal_iters;
960
961         u64                     last_bucket_seq_cleanup;
962
963         u64                     counters_on_mount[BCH_COUNTER_NR];
964         u64 __percpu            *counters;
965
966         unsigned                btree_gc_periodic:1;
967         unsigned                copy_gc_enabled:1;
968         bool                    promote_whole_extents;
969
970         struct time_stats       times[BCH_TIME_STAT_NR];
971
972         struct btree_transaction_stats btree_transaction_stats[BCH_TRANSACTIONS_NR];
973 };
974
975 static inline void bch2_set_ra_pages(struct bch_fs *c, unsigned ra_pages)
976 {
977 #ifndef NO_BCACHEFS_FS
978         if (c->vfs_sb)
979                 c->vfs_sb->s_bdi->ra_pages = ra_pages;
980 #endif
981 }
982
983 static inline unsigned bucket_bytes(const struct bch_dev *ca)
984 {
985         return ca->mi.bucket_size << 9;
986 }
987
988 static inline unsigned block_bytes(const struct bch_fs *c)
989 {
990         return c->opts.block_size;
991 }
992
993 static inline unsigned block_sectors(const struct bch_fs *c)
994 {
995         return c->opts.block_size >> 9;
996 }
997
998 static inline size_t btree_sectors(const struct bch_fs *c)
999 {
1000         return c->opts.btree_node_size >> 9;
1001 }
1002
1003 static inline bool btree_id_cached(const struct bch_fs *c, enum btree_id btree)
1004 {
1005         return c->btree_key_cache_btrees & (1U << btree);
1006 }
1007
1008 static inline struct timespec64 bch2_time_to_timespec(const struct bch_fs *c, s64 time)
1009 {
1010         struct timespec64 t;
1011         s32 rem;
1012
1013         time += c->sb.time_base_lo;
1014
1015         t.tv_sec = div_s64_rem(time, c->sb.time_units_per_sec, &rem);
1016         t.tv_nsec = rem * c->sb.nsec_per_time_unit;
1017         return t;
1018 }
1019
1020 static inline s64 timespec_to_bch2_time(const struct bch_fs *c, struct timespec64 ts)
1021 {
1022         return (ts.tv_sec * c->sb.time_units_per_sec +
1023                 (int) ts.tv_nsec / c->sb.nsec_per_time_unit) - c->sb.time_base_lo;
1024 }
1025
1026 static inline s64 bch2_current_time(const struct bch_fs *c)
1027 {
1028         struct timespec64 now;
1029
1030         ktime_get_coarse_real_ts64(&now);
1031         return timespec_to_bch2_time(c, now);
1032 }
1033
1034 static inline bool bch2_dev_exists2(const struct bch_fs *c, unsigned dev)
1035 {
1036         return dev < c->sb.nr_devices && c->devs[dev];
1037 }
1038
1039 #endif /* _BCACHEFS_H */