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