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