1 /* SPDX-License-Identifier: GPL-2.0 */
6 * SOME HIGH LEVEL CODE DOCUMENTATION:
8 * Bcache mostly works with cache sets, cache devices, and backing devices.
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.
15 * Multiple cache devices is intended to give us the ability to mirror dirty
16 * cached data and metadata, without mirroring clean cached data.
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.
24 * A cache set can have multiple (many) backing devices attached to it.
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.
32 * Flash only volumes work but they're not production ready because the moving
33 * garbage collector needs more work. More on that later.
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
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+
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).
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.
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
62 * Bcache is entirely COW - we never write twice to a bucket, even buckets that
63 * contain metadata (including btree nodes).
67 * Bcache is in large part design around the btree.
69 * At a high level, the btree is just an index of key -> ptr tuples.
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).
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.
80 * Pointers contain the cache device id, the offset on that device, and an 8 bit
81 * generation number. More on the gen later.
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
87 * Updates are fairly well abstracted, though. There are two different ways of
88 * updating the btree; insert and replace.
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.
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.
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.
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.
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.
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.)
118 * Anyways, btree nodes are big - big enough to be inefficient with a textbook
119 * btree implementation.
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.
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
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.
137 * GARBAGE COLLECTION:
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.
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.
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.
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
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.
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
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()).
181 #define pr_fmt(fmt) "bcachefs: %s() " fmt "\n", __func__
183 #define pr_fmt(fmt) "%s() " fmt "\n", __func__
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>
206 #include "bcachefs_format.h"
212 #define dynamic_fault(...) 0
213 #define race_fault(...) 0
215 #define trace_and_count(_c, _name, ...) \
217 this_cpu_inc((_c)->counters[BCH_COUNTER_##_name]); \
218 trace_##_name(__VA_ARGS__); \
221 #define bch2_fs_init_fault(name) \
222 dynamic_fault("bcachefs:bch_fs_init:" name)
223 #define bch2_meta_read_fault(name) \
224 dynamic_fault("bcachefs:meta:read:" name)
225 #define bch2_meta_write_fault(name) \
226 dynamic_fault("bcachefs:meta:write:" name)
229 #define BCACHEFS_LOG_PREFIX
232 #ifdef BCACHEFS_LOG_PREFIX
233 #define bch2_log_msg(_c, fmt) "bcachefs (%s): " fmt, ((_c)->name)
234 #define bch2_fmt(_c, fmt) bch2_log_msg(_c, fmt "\n")
235 #define bch2_fmt_inum(_c, _inum, fmt) "bcachefs (%s inum %llu): " fmt "\n", ((_c)->name), (_inum)
237 #define bch2_log_msg(_c, fmt) fmt
238 #define bch2_fmt(_c, fmt) fmt "\n"
239 #define bch2_fmt_inum(_c, _inum, fmt) "inum %llu: " fmt "\n", (_inum)
242 #define bch_info(c, fmt, ...) \
243 printk(KERN_INFO bch2_fmt(c, fmt), ##__VA_ARGS__)
244 #define bch_notice(c, fmt, ...) \
245 printk(KERN_NOTICE bch2_fmt(c, fmt), ##__VA_ARGS__)
246 #define bch_warn(c, fmt, ...) \
247 printk(KERN_WARNING bch2_fmt(c, fmt), ##__VA_ARGS__)
248 #define bch_warn_ratelimited(c, fmt, ...) \
249 printk_ratelimited(KERN_WARNING bch2_fmt(c, fmt), ##__VA_ARGS__)
250 #define bch_err(c, fmt, ...) \
251 printk(KERN_ERR bch2_fmt(c, fmt), ##__VA_ARGS__)
253 #define bch_err_ratelimited(c, fmt, ...) \
254 printk_ratelimited(KERN_ERR bch2_fmt(c, fmt), ##__VA_ARGS__)
255 #define bch_err_inum_ratelimited(c, _inum, fmt, ...) \
256 printk_ratelimited(KERN_ERR bch2_fmt_inum(c, _inum, fmt), ##__VA_ARGS__)
258 #define bch_verbose(c, fmt, ...) \
260 if ((c)->opts.verbose) \
261 bch_info(c, fmt, ##__VA_ARGS__); \
264 #define pr_verbose_init(opts, fmt, ...) \
266 if (opt_get(opts, verbose)) \
267 pr_info(fmt, ##__VA_ARGS__); \
270 /* Parameters that are useful for debugging, but should always be compiled in: */
271 #define BCH_DEBUG_PARAMS_ALWAYS() \
272 BCH_DEBUG_PARAM(key_merging_disabled, \
273 "Disables merging of extents") \
274 BCH_DEBUG_PARAM(btree_gc_always_rewrite, \
275 "Causes mark and sweep to compact and rewrite every " \
276 "btree node it traverses") \
277 BCH_DEBUG_PARAM(btree_gc_rewrite_disabled, \
278 "Disables rewriting of btree nodes during mark and sweep")\
279 BCH_DEBUG_PARAM(btree_shrinker_disabled, \
280 "Disables the shrinker callback for the btree node cache")\
281 BCH_DEBUG_PARAM(verify_btree_ondisk, \
282 "Reread btree nodes at various points to verify the " \
283 "mergesort in the read path against modifications " \
285 BCH_DEBUG_PARAM(verify_all_btree_replicas, \
286 "When reading btree nodes, read all replicas and " \
289 /* Parameters that should only be compiled in debug mode: */
290 #define BCH_DEBUG_PARAMS_DEBUG() \
291 BCH_DEBUG_PARAM(expensive_debug_checks, \
292 "Enables various runtime debugging checks that " \
293 "significantly affect performance") \
294 BCH_DEBUG_PARAM(debug_check_iterators, \
295 "Enables extra verification for btree iterators") \
296 BCH_DEBUG_PARAM(debug_check_btree_accounting, \
297 "Verify btree accounting for keys within a node") \
298 BCH_DEBUG_PARAM(journal_seq_verify, \
299 "Store the journal sequence number in the version " \
300 "number of every btree key, and verify that btree " \
301 "update ordering is preserved during recovery") \
302 BCH_DEBUG_PARAM(inject_invalid_keys, \
303 "Store the journal sequence number in the version " \
304 "number of every btree key, and verify that btree " \
305 "update ordering is preserved during recovery") \
306 BCH_DEBUG_PARAM(test_alloc_startup, \
307 "Force allocator startup to use the slowpath where it" \
308 "can't find enough free buckets without invalidating" \
310 BCH_DEBUG_PARAM(force_reconstruct_read, \
311 "Force reads to use the reconstruct path, when reading" \
312 "from erasure coded extents") \
313 BCH_DEBUG_PARAM(test_restart_gc, \
314 "Test restarting mark and sweep gc when bucket gens change")
316 #define BCH_DEBUG_PARAMS_ALL() BCH_DEBUG_PARAMS_ALWAYS() BCH_DEBUG_PARAMS_DEBUG()
318 #ifdef CONFIG_BCACHEFS_DEBUG
319 #define BCH_DEBUG_PARAMS() BCH_DEBUG_PARAMS_ALL()
321 #define BCH_DEBUG_PARAMS() BCH_DEBUG_PARAMS_ALWAYS()
324 #define BCH_DEBUG_PARAM(name, description) extern bool bch2_##name;
326 #undef BCH_DEBUG_PARAM
328 #ifndef CONFIG_BCACHEFS_DEBUG
329 #define BCH_DEBUG_PARAM(name, description) static const bool bch2_##name;
330 BCH_DEBUG_PARAMS_DEBUG()
331 #undef BCH_DEBUG_PARAM
334 #define BCH_TIME_STATS() \
335 x(btree_node_mem_alloc) \
336 x(btree_node_split) \
337 x(btree_node_compact) \
338 x(btree_node_merge) \
341 x(btree_interior_update_foreground) \
342 x(btree_interior_update_total) \
347 x(journal_flush_write) \
348 x(journal_noflush_write) \
349 x(journal_flush_seq) \
351 x(blocked_allocate) \
352 x(blocked_allocate_open_bucket)
354 enum bch_time_stats {
355 #define x(name) BCH_TIME_##name,
361 #include "alloc_types.h"
362 #include "btree_types.h"
363 #include "buckets_types.h"
364 #include "buckets_waiting_for_journal_types.h"
365 #include "clock_types.h"
366 #include "ec_types.h"
367 #include "journal_types.h"
368 #include "keylist_types.h"
369 #include "quota_types.h"
370 #include "rebalance_types.h"
371 #include "replicas_types.h"
372 #include "subvolume_types.h"
373 #include "super_types.h"
375 /* Number of nodes btree coalesce will try to coalesce at once */
376 #define GC_MERGE_NODES 4U
378 /* Maximum number of nodes we might need to allocate atomically: */
379 #define BTREE_RESERVE_MAX (BTREE_MAX_DEPTH + (BTREE_MAX_DEPTH - 1))
381 /* Size of the freelist we allocate btree nodes from: */
382 #define BTREE_NODE_RESERVE (BTREE_RESERVE_MAX * 4)
384 #define BTREE_NODE_OPEN_BUCKET_RESERVE (BTREE_RESERVE_MAX * BCH_REPLICAS_MAX)
389 GC_PHASE_NOT_RUNNING,
393 GC_PHASE_BTREE_stripes,
394 GC_PHASE_BTREE_extents,
395 GC_PHASE_BTREE_inodes,
396 GC_PHASE_BTREE_dirents,
397 GC_PHASE_BTREE_xattrs,
398 GC_PHASE_BTREE_alloc,
399 GC_PHASE_BTREE_quotas,
400 GC_PHASE_BTREE_reflink,
401 GC_PHASE_BTREE_subvolumes,
402 GC_PHASE_BTREE_snapshots,
404 GC_PHASE_BTREE_freespace,
405 GC_PHASE_BTREE_need_discard,
406 GC_PHASE_BTREE_backpointers,
408 GC_PHASE_PENDING_DELETE,
423 typedef GENRADIX(struct reflink_gc) reflink_gc_table;
426 u64 sectors[2][BCH_DATA_NR];
431 struct percpu_ref ref;
432 struct completion ref_completion;
433 struct percpu_ref io_ref;
434 struct completion io_ref_completion;
440 * Cached version of this device's member info from superblock
441 * Committed by bch2_write_super() -> bch_fs_mi_update()
443 struct bch_member_cpu mi;
445 char name[BDEVNAME_SIZE];
447 struct bch_sb_handle disk_sb;
448 struct bch_sb *sb_read_scratch;
452 struct bch_devs_mask self;
454 /* biosets used in cloned bios for writing multiple replicas */
455 struct bio_set replica_set;
459 * Per-bucket arrays are protected by c->mark_lock, bucket_lock and
460 * gc_lock, for device resize - holding any is sufficient for access:
461 * Or rcu_read_lock(), but only for ptr_stale():
463 struct bucket_array __rcu *buckets_gc;
464 struct bucket_gens __rcu *bucket_gens;
466 unsigned long *buckets_nouse;
467 struct rw_semaphore bucket_lock;
469 struct bch_dev_usage *usage_base;
470 struct bch_dev_usage __percpu *usage[JOURNAL_BUF_NR];
471 struct bch_dev_usage __percpu *usage_gc;
474 u64 new_fs_bucket_idx;
475 u64 bucket_alloc_trans_early_cursor;
477 unsigned nr_open_buckets;
478 unsigned nr_btree_reserve;
480 open_bucket_idx_t open_buckets_partial[OPEN_BUCKETS_COUNT];
481 open_bucket_idx_t open_buckets_partial_nr;
483 size_t inc_gen_needs_gc;
484 size_t inc_gen_really_needs_gc;
485 size_t buckets_waiting_on_journal;
487 atomic64_t rebalance_work;
489 struct journal_device journal;
490 u64 prev_journal_sector;
492 struct work_struct io_error_work;
494 /* The rest of this all shows up in sysfs */
495 atomic64_t cur_latency[2];
496 struct time_stats io_latency[2];
498 #define CONGESTED_MAX 1024
502 struct io_count __percpu *io_done;
515 BCH_FS_WRITE_DISABLE_COMPLETE,
516 BCH_FS_CLEAN_SHUTDOWN,
519 BCH_FS_TOPOLOGY_REPAIR_DONE,
520 BCH_FS_INITIAL_GC_DONE, /* kill when we enumerate fsck passes */
521 BCH_FS_CHECK_LRUS_DONE,
522 BCH_FS_CHECK_BACKPOINTERS_DONE,
523 BCH_FS_CHECK_ALLOC_TO_LRU_REFS_DONE,
525 BCH_FS_INITIAL_GC_UNFIXED, /* kill when we enumerate fsck errors */
526 BCH_FS_NEED_ANOTHER_GC,
528 BCH_FS_HAVE_DELETED_SNAPSHOTS,
532 BCH_FS_TOPOLOGY_ERROR,
534 BCH_FS_ERRORS_NOT_FIXED,
541 #define BCH_TRANSACTIONS_NR 128
543 struct btree_transaction_stats {
545 struct time_stats lock_hold_times;
546 unsigned nr_max_paths;
548 char *max_paths_text;
552 u64 sectors_available;
555 struct journal_seq_blacklist_table {
557 struct journal_seq_blacklist_table_entry {
564 struct journal_keys {
568 enum btree_id btree_id:8;
575 * Gap buffer: instead of all the empty space in the array being at the
576 * end of the buffer - from @nr to @size - the empty space is at @gap.
577 * This means that sequential insertions are O(n) instead of O(n^2).
584 struct btree_path_buf {
585 struct btree_path *path;
588 #define REPLICAS_DELTA_LIST_MAX (1U << 16)
593 u32 subvol; /* Nonzero only if a subvolume points to this node: */
602 #define BCACHEFS_ROOT_SUBVOL_INUM \
603 ((subvol_inum) { BCACHEFS_ROOT_SUBVOL, BCACHEFS_ROOT_INO })
605 #define BCH_BTREE_WRITE_TYPES() \
607 x(init_next_bset, 1) \
608 x(cache_reclaim, 2) \
609 x(journal_reclaim, 3) \
612 enum btree_write_type {
613 #define x(t, n) BTREE_WRITE_##t,
614 BCH_BTREE_WRITE_TYPES()
619 #define BTREE_WRITE_TYPE_MASK (roundup_pow_of_two(BTREE_WRITE_TYPE_NR) - 1)
620 #define BTREE_WRITE_TYPE_BITS ilog2(BTREE_WRITE_TYPE_MASK)
625 struct list_head list;
627 struct kobject counters_kobj;
628 struct kobject internal;
629 struct kobject opts_dir;
630 struct kobject time_stats;
634 struct device *chardev;
635 struct super_block *vfs_sb;
639 /* ro/rw, add/remove/resize devices: */
640 struct rw_semaphore state_lock;
642 /* Counts outstanding writes, for clean transition to read-only */
643 struct percpu_ref writes;
644 struct work_struct read_only_work;
646 struct bch_dev __rcu *devs[BCH_SB_MEMBERS_MAX];
648 struct bch_replicas_cpu replicas;
649 struct bch_replicas_cpu replicas_gc;
650 struct mutex replicas_gc_lock;
651 mempool_t replicas_delta_pool;
653 struct journal_entry_res btree_root_journal_res;
654 struct journal_entry_res replicas_journal_res;
655 struct journal_entry_res clock_journal_res;
656 struct journal_entry_res dev_usage_journal_res;
658 struct bch_disk_groups_cpu __rcu *disk_groups;
660 struct bch_opts opts;
662 /* Updated by bch2_sb_update():*/
677 unsigned time_units_per_sec;
678 unsigned nsec_per_time_unit;
684 struct bch_sb_handle disk_sb;
686 unsigned short block_bits; /* ilog2(block_size) */
688 u16 btree_foreground_merge_threshold;
690 struct closure sb_write;
691 struct mutex sb_lock;
694 GENRADIX(struct snapshot_t) snapshots;
695 struct bch_snapshot_table __rcu *snapshot_table;
696 struct mutex snapshot_table_lock;
697 struct work_struct snapshot_delete_work;
698 struct work_struct snapshot_wait_for_pagecache_and_delete_work;
699 snapshot_id_list snapshots_unlinked;
700 struct mutex snapshots_unlinked_lock;
703 struct bio_set btree_bio;
704 struct workqueue_struct *io_complete_wq;
706 struct btree_root btree_roots[BTREE_ID_NR];
707 struct mutex btree_root_lock;
709 struct btree_cache btree_cache;
712 * Cache of allocated btree nodes - if we allocate a btree node and
713 * don't use it, if we free it that space can't be reused until going
714 * _all_ the way through the allocator (which exposes us to a livelock
715 * when allocating btree reserves fail halfway through) - instead, we
716 * can stick them here:
718 struct btree_alloc btree_reserve_cache[BTREE_NODE_RESERVE * 2];
719 unsigned btree_reserve_cache_nr;
720 struct mutex btree_reserve_cache_lock;
722 mempool_t btree_interior_update_pool;
723 struct list_head btree_interior_update_list;
724 struct list_head btree_interior_updates_unwritten;
725 struct mutex btree_interior_update_lock;
726 struct closure_waitlist btree_interior_update_wait;
728 struct workqueue_struct *btree_interior_update_worker;
729 struct work_struct btree_interior_update_work;
732 spinlock_t btree_write_error_lock;
733 struct btree_write_stats {
736 } btree_write_stats[BTREE_WRITE_TYPE_NR];
739 struct mutex btree_trans_lock;
740 struct list_head btree_trans_list;
741 mempool_t btree_paths_pool;
742 mempool_t btree_trans_mem_pool;
743 struct btree_path_buf __percpu *btree_paths_bufs;
745 struct srcu_struct btree_trans_barrier;
746 bool btree_trans_barrier_initialized;
748 struct btree_key_cache btree_key_cache;
749 unsigned btree_key_cache_btrees;
751 struct workqueue_struct *btree_update_wq;
752 struct workqueue_struct *btree_io_complete_wq;
753 /* copygc needs its own workqueue for index updates.. */
754 struct workqueue_struct *copygc_wq;
757 struct bch_devs_mask rw_devs[BCH_DATA_NR];
759 u64 capacity; /* sectors */
762 * When capacity _decreases_ (due to a disk being removed), we
763 * increment capacity_gen - this invalidates outstanding reservations
764 * and forces them to be revalidated
767 unsigned bucket_size_max;
769 atomic64_t sectors_available;
770 struct mutex sectors_available_lock;
772 struct bch_fs_pcpu __percpu *pcpu;
774 struct percpu_rw_semaphore mark_lock;
776 seqcount_t usage_lock;
777 struct bch_fs_usage *usage_base;
778 struct bch_fs_usage __percpu *usage[JOURNAL_BUF_NR];
779 struct bch_fs_usage __percpu *usage_gc;
780 u64 __percpu *online_reserved;
782 /* single element mempool: */
783 struct mutex usage_scratch_lock;
784 struct bch_fs_usage_online *usage_scratch;
786 struct io_clock io_clock[2];
788 /* JOURNAL SEQ BLACKLIST */
789 struct journal_seq_blacklist_table *
790 journal_seq_blacklist_table;
791 struct work_struct journal_seq_blacklist_gc_work;
794 spinlock_t freelist_lock;
795 struct closure_waitlist freelist_wait;
796 u64 blocked_allocate;
797 u64 blocked_allocate_open_bucket;
799 open_bucket_idx_t open_buckets_freelist;
800 open_bucket_idx_t open_buckets_nr_free;
801 struct closure_waitlist open_buckets_wait;
802 struct open_bucket open_buckets[OPEN_BUCKETS_COUNT];
803 open_bucket_idx_t open_buckets_hash[OPEN_BUCKETS_COUNT];
805 struct write_point btree_write_point;
806 struct write_point rebalance_write_point;
808 struct write_point write_points[WRITE_POINT_MAX];
809 struct hlist_head write_points_hash[WRITE_POINT_HASH_NR];
810 struct mutex write_points_hash_lock;
811 unsigned write_points_nr;
813 struct buckets_waiting_for_journal buckets_waiting_for_journal;
814 struct work_struct discard_work;
815 struct work_struct invalidate_work;
817 /* GARBAGE COLLECTION */
818 struct task_struct *gc_thread;
820 unsigned long gc_count;
822 enum btree_id gc_gens_btree;
823 struct bpos gc_gens_pos;
826 * Tracks GC's progress - everything in the range [ZERO_KEY..gc_cur_pos]
827 * has been marked by GC.
829 * gc_cur_phase is a superset of btree_ids (BTREE_ID_extents etc.)
831 * Protected by gc_pos_lock. Only written to by GC thread, so GC thread
832 * can read without a lock.
834 seqcount_t gc_pos_lock;
835 struct gc_pos gc_pos;
838 * The allocation code needs gc_mark in struct bucket to be correct, but
839 * it's not while a gc is in progress.
841 struct rw_semaphore gc_lock;
842 struct mutex gc_gens_lock;
845 struct bio_set bio_read;
846 struct bio_set bio_read_split;
847 struct bio_set bio_write;
848 struct mutex bio_bounce_pages_lock;
849 mempool_t bio_bounce_pages;
850 struct rhashtable promote_table;
852 mempool_t compression_bounce[2];
853 mempool_t compress_workspace[BCH_COMPRESSION_TYPE_NR];
854 mempool_t decompress_workspace;
855 ZSTD_parameters zstd_params;
857 struct crypto_shash *sha256;
858 struct crypto_sync_skcipher *chacha20;
859 struct crypto_shash *poly1305;
861 atomic64_t key_version;
863 mempool_t large_bkey_pool;
866 struct bch_fs_rebalance rebalance;
869 struct task_struct *copygc_thread;
870 copygc_heap copygc_heap;
871 struct write_point copygc_write_point;
874 wait_queue_head_t copygc_running_wq;
876 /* DATA PROGRESS STATS */
877 struct list_head data_progress_list;
878 struct mutex data_progress_lock;
881 GENRADIX(struct stripe) stripes;
882 GENRADIX(struct gc_stripe) gc_stripes;
884 ec_stripes_heap ec_stripes_heap;
885 spinlock_t ec_stripes_heap_lock;
888 struct list_head ec_stripe_head_list;
889 struct mutex ec_stripe_head_lock;
891 struct list_head ec_stripe_new_list;
892 struct mutex ec_stripe_new_lock;
894 struct work_struct ec_stripe_create_work;
897 struct bio_set ec_bioset;
899 struct work_struct ec_stripe_delete_work;
900 struct llist_head ec_stripe_delete_list;
904 reflink_gc_table reflink_gc_table;
905 size_t reflink_gc_nr;
907 /* VFS IO PATH - fs-io.c */
908 struct bio_set writepage_bioset;
909 struct bio_set dio_write_bioset;
910 struct bio_set dio_read_bioset;
913 struct list_head fsck_errors;
914 struct mutex fsck_error_lock;
918 struct bch_memquota_type quotas[QTYP_NR];
921 struct dentry *fs_debug_dir;
922 struct dentry *btree_debug_dir;
923 struct btree_debug btree_debug[BTREE_ID_NR];
924 struct btree *verify_data;
925 struct btree_node *verify_ondisk;
926 struct mutex verify_lock;
928 u64 *unused_inode_hints;
929 unsigned inode_shard_bits;
932 * A btree node on disk could have too many bsets for an iterator to fit
933 * on the stack - have to dynamically allocate them
937 mempool_t btree_bounce_pool;
939 struct journal journal;
940 GENRADIX(struct journal_replay *) journal_entries;
941 u64 journal_entries_base_seq;
942 struct journal_keys journal_keys;
943 struct list_head journal_iters;
945 u64 last_bucket_seq_cleanup;
947 u64 counters_on_mount[BCH_COUNTER_NR];
948 u64 __percpu *counters;
950 unsigned btree_gc_periodic:1;
951 unsigned copy_gc_enabled:1;
952 bool promote_whole_extents;
954 struct time_stats times[BCH_TIME_STAT_NR];
956 struct btree_transaction_stats btree_transaction_stats[BCH_TRANSACTIONS_NR];
959 static inline void bch2_set_ra_pages(struct bch_fs *c, unsigned ra_pages)
961 #ifndef NO_BCACHEFS_FS
963 c->vfs_sb->s_bdi->ra_pages = ra_pages;
967 static inline unsigned bucket_bytes(const struct bch_dev *ca)
969 return ca->mi.bucket_size << 9;
972 static inline unsigned block_bytes(const struct bch_fs *c)
974 return c->opts.block_size;
977 static inline unsigned block_sectors(const struct bch_fs *c)
979 return c->opts.block_size >> 9;
982 static inline size_t btree_sectors(const struct bch_fs *c)
984 return c->opts.btree_node_size >> 9;
987 static inline bool btree_id_cached(const struct bch_fs *c, enum btree_id btree)
989 return c->btree_key_cache_btrees & (1U << btree);
992 static inline struct timespec64 bch2_time_to_timespec(const struct bch_fs *c, s64 time)
997 time += c->sb.time_base_lo;
999 t.tv_sec = div_s64_rem(time, c->sb.time_units_per_sec, &rem);
1000 t.tv_nsec = rem * c->sb.nsec_per_time_unit;
1004 static inline s64 timespec_to_bch2_time(const struct bch_fs *c, struct timespec64 ts)
1006 return (ts.tv_sec * c->sb.time_units_per_sec +
1007 (int) ts.tv_nsec / c->sb.nsec_per_time_unit) - c->sb.time_base_lo;
1010 static inline s64 bch2_current_time(const struct bch_fs *c)
1012 struct timespec64 now;
1014 ktime_get_coarse_real_ts64(&now);
1015 return timespec_to_bch2_time(c, now);
1018 static inline bool bch2_dev_exists2(const struct bch_fs *c, unsigned dev)
1020 return dev < c->sb.nr_devices && c->devs[dev];
1023 #endif /* _BCACHEFS_H */