1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _BCACHEFS_BTREE_TYPES_H
3 #define _BCACHEFS_BTREE_TYPES_H
5 #include <linux/list.h>
6 #include <linux/rhashtable.h>
9 #include "bkey_methods.h"
10 #include "buckets_types.h"
11 #include "journal_types.h"
19 struct btree_nr_keys {
22 * Amount of live metadata (i.e. size of node after a compaction) in
26 u16 bset_u64s[MAX_BSETS];
35 * We construct a binary tree in an array as if the array
36 * started at 1, so that things line up on the same cachelines
37 * better: see comments in bset.c at cacheline_to_bkey() for
41 /* size of the binary tree and prev array */
44 /* function of size - precalculated for to_inorder() */
53 struct journal_entry_pin journal;
57 struct open_buckets ob;
58 __BKEY_PADDED(k, BKEY_BTREE_PTR_VAL_U64s_MAX);
61 struct btree_bkey_cached_common {
68 struct btree_bkey_cached_common c;
70 struct rhash_head hash;
79 struct bkey_format format;
81 struct btree_node *data;
85 * Sets of sorted keys - the real btree node - plus a binary search tree
87 * set[0] is special; set[0]->tree, set[0]->prev and set[0]->data point
88 * to the memory we have allocated for this btree node. Additionally,
89 * set[0]->data points to the entire btree node as it exists on disk.
91 struct bset_tree set[MAX_BSETS];
93 struct btree_nr_keys nr;
99 struct btree_write writes[2];
101 /* Key/pointer for this btree node */
102 __BKEY_PADDED(key, BKEY_BTREE_PTR_VAL_U64s_MAX);
105 * XXX: add a delete sequence number, so when bch2_btree_node_relock()
106 * fails because the lock sequence number has changed - i.e. the
107 * contents were modified - we can still relock the node if it's still
108 * the one we want, without redoing the traversal
112 * For asynchronous splits/interior node updates:
113 * When we do a split, we allocate new child nodes and update the parent
114 * node to point to them: we update the parent in memory immediately,
115 * but then we must wait until the children have been written out before
116 * the update to the parent can be written - this is a list of the
117 * btree_updates that are blocking this node from being
120 struct list_head write_blocked;
123 * Also for asynchronous splits/interior node updates:
124 * If a btree node isn't reachable yet, we don't want to kick off
125 * another write - because that write also won't yet be reachable and
126 * marking it as completed before it's reachable would be incorrect:
128 unsigned long will_make_reachable;
130 struct open_buckets ob;
133 struct list_head list;
137 struct rhashtable table;
138 bool table_init_done;
140 * We never free a struct btree, except on shutdown - we just put it on
141 * the btree_cache_freed list and reuse it later. This simplifies the
142 * code, and it doesn't cost us much memory as the memory usage is
143 * dominated by buffers that hold the actual btree node data and those
144 * can be freed - and the number of struct btrees allocated is
145 * effectively bounded.
147 * btree_cache_freeable effectively is a small cache - we use it because
148 * high order page allocations can be rather expensive, and it's quite
149 * common to delete and allocate btree nodes in quick succession. It
150 * should never grow past ~2-3 nodes in practice.
153 struct list_head live;
154 struct list_head freeable;
155 struct list_head freed;
157 /* Number of elements in live + freeable lists */
161 struct shrinker shrink;
164 * If we need to allocate memory for a new btree node and that
165 * allocation fails, we can cannibalize another node in the btree cache
166 * to satisfy the allocation - lock to guarantee only one thread does
169 struct task_struct *alloc_lock;
170 struct closure_waitlist alloc_wait;
173 struct btree_node_iter {
174 struct btree_node_iter_set {
179 enum btree_iter_type {
185 #define BTREE_ITER_TYPE ((1 << 2) - 1)
188 * Iterate over all possible positions, synthesizing deleted keys for holes:
190 #define BTREE_ITER_SLOTS (1 << 2)
192 * Indicates that intent locks should be taken on leaf nodes, because we expect
193 * to be doing updates:
195 #define BTREE_ITER_INTENT (1 << 3)
197 * Causes the btree iterator code to prefetch additional btree nodes from disk:
199 #define BTREE_ITER_PREFETCH (1 << 4)
201 * Indicates that this iterator should not be reused until transaction commit,
202 * either because a pending update references it or because the update depends
203 * on that particular key being locked (e.g. by the str_hash code, for hash
206 #define BTREE_ITER_KEEP_UNTIL_COMMIT (1 << 5)
208 * Used in bch2_btree_iter_traverse(), to indicate whether we're searching for
209 * @pos or the first key strictly greater than @pos
211 #define BTREE_ITER_IS_EXTENTS (1 << 6)
212 #define BTREE_ITER_NOT_EXTENTS (1 << 7)
213 #define BTREE_ITER_ERROR (1 << 8)
214 #define BTREE_ITER_SET_POS_AFTER_COMMIT (1 << 9)
215 #define BTREE_ITER_CACHED_NOFILL (1 << 10)
216 #define BTREE_ITER_CACHED_NOCREATE (1 << 11)
217 #define BTREE_ITER_WITH_UPDATES (1 << 12)
218 #define BTREE_ITER_ALL_SNAPSHOTS (1 << 13)
220 enum btree_iter_uptodate {
221 BTREE_ITER_UPTODATE = 0,
222 BTREE_ITER_NEED_PEEK = 1,
223 BTREE_ITER_NEED_RELOCK = 2,
224 BTREE_ITER_NEED_TRAVERSE = 3,
227 #define BTREE_ITER_NO_NODE_GET_LOCKS ((struct btree *) 1)
228 #define BTREE_ITER_NO_NODE_DROP ((struct btree *) 2)
229 #define BTREE_ITER_NO_NODE_LOCK_ROOT ((struct btree *) 3)
230 #define BTREE_ITER_NO_NODE_UP ((struct btree *) 4)
231 #define BTREE_ITER_NO_NODE_DOWN ((struct btree *) 5)
232 #define BTREE_ITER_NO_NODE_INIT ((struct btree *) 6)
233 #define BTREE_ITER_NO_NODE_ERROR ((struct btree *) 7)
234 #define BTREE_ITER_NO_NODE_CACHED ((struct btree *) 8)
237 * @pos - iterator's current position
238 * @level - current btree depth
239 * @locks_want - btree level below which we start taking intent locks
240 * @nodes_locked - bitmask indicating which nodes in @nodes are locked
241 * @nodes_intent_locked - bitmask indicating which locks are intent locks
244 struct btree_trans *trans;
245 unsigned long ip_allocated;
250 /* btree_iter_copy starts here: */
253 /* When we're filtering by snapshot, the snapshot ID we're looking for: */
257 struct bpos real_pos;
258 struct bpos pos_after_commit;
260 enum btree_id btree_id:4;
261 enum btree_iter_uptodate uptodate:3;
263 * True if we've returned a key (and thus are expected to keep it
264 * locked), false after set_pos - for avoiding spurious transaction
265 * restarts in bch2_trans_relock():
267 bool should_be_locked:1;
272 nodes_intent_locked:4;
274 struct btree_iter_level {
276 struct btree_node_iter iter;
278 } l[BTREE_MAX_DEPTH];
281 * Current unpacked key - so that bch2_btree_iter_next()/
282 * bch2_btree_iter_next_slot() can correctly advance pos.
287 static inline enum btree_iter_type
288 btree_iter_type(const struct btree_iter *iter)
290 return iter->flags & BTREE_ITER_TYPE;
293 static inline bool btree_iter_is_cached(const struct btree_iter *iter)
295 return btree_iter_type(iter) == BTREE_ITER_CACHED;
298 static inline struct btree_iter_level *iter_l(struct btree_iter *iter)
300 return iter->l + iter->level;
303 struct btree_key_cache {
305 struct rhashtable table;
306 bool table_init_done;
307 struct list_head freed;
308 struct shrinker shrink;
309 unsigned shrink_iter;
312 atomic_long_t nr_keys;
313 atomic_long_t nr_dirty;
316 struct bkey_cached_key {
319 } __attribute__((packed, aligned(4)));
321 #define BKEY_CACHED_ACCESSED 0
322 #define BKEY_CACHED_DIRTY 1
325 struct btree_bkey_cached_common c;
330 u32 btree_trans_barrier_seq;
331 struct bkey_cached_key key;
333 struct rhash_head hash;
334 struct list_head list;
336 struct journal_preres res;
337 struct journal_entry_pin journal;
342 struct btree_insert_entry {
343 unsigned trigger_flags;
345 enum btree_id btree_id:8;
347 unsigned trans_triggers_run:1;
349 struct btree_iter *iter;
352 #ifndef CONFIG_LOCKDEP
353 #define BTREE_ITER_MAX 64
355 #define BTREE_ITER_MAX 32
358 struct btree_trans_commit_hook;
359 typedef int (btree_trans_commit_hook_fn)(struct btree_trans *, struct btree_trans_commit_hook *);
361 struct btree_trans_commit_hook {
362 btree_trans_commit_hook_fn *fn;
363 struct btree_trans_commit_hook *next;
366 #define BTREE_TRANS_MEM_MAX 4096
370 #ifdef CONFIG_BCACHEFS_DEBUG
371 struct list_head list;
372 struct btree *locking;
373 unsigned locking_iter_idx;
374 struct bpos locking_pos;
383 unsigned used_mempool:1;
385 unsigned in_traverse_all:1;
395 struct btree_iter *iters;
396 struct btree_insert_entry *updates;
399 struct btree_trans_commit_hook *hooks;
400 struct jset_entry *extra_journal_entries;
401 unsigned extra_journal_entry_u64s;
402 struct journal_entry_pin *journal_pin;
404 struct journal_res journal_res;
405 struct journal_preres journal_preres;
407 struct disk_reservation *disk_res;
409 unsigned journal_u64s;
410 unsigned journal_preres_u64s;
411 struct replicas_delta_list *fs_usage_deltas;
414 #define BTREE_FLAG(flag) \
415 static inline bool btree_node_ ## flag(struct btree *b) \
416 { return test_bit(BTREE_NODE_ ## flag, &b->flags); } \
418 static inline void set_btree_node_ ## flag(struct btree *b) \
419 { set_bit(BTREE_NODE_ ## flag, &b->flags); } \
421 static inline void clear_btree_node_ ## flag(struct btree *b) \
422 { clear_bit(BTREE_NODE_ ## flag, &b->flags); }
425 BTREE_NODE_read_in_flight,
426 BTREE_NODE_read_error,
428 BTREE_NODE_need_write,
430 BTREE_NODE_write_idx,
432 BTREE_NODE_write_in_flight,
433 BTREE_NODE_just_written,
436 BTREE_NODE_need_rewrite,
437 BTREE_NODE_never_write,
440 BTREE_FLAG(read_in_flight);
441 BTREE_FLAG(read_error);
442 BTREE_FLAG(need_write);
444 BTREE_FLAG(write_idx);
445 BTREE_FLAG(accessed);
446 BTREE_FLAG(write_in_flight);
447 BTREE_FLAG(just_written);
450 BTREE_FLAG(need_rewrite);
451 BTREE_FLAG(never_write);
453 static inline struct btree_write *btree_current_write(struct btree *b)
455 return b->writes + btree_node_write_idx(b);
458 static inline struct btree_write *btree_prev_write(struct btree *b)
460 return b->writes + (btree_node_write_idx(b) ^ 1);
463 static inline struct bset_tree *bset_tree_last(struct btree *b)
466 return b->set + b->nsets - 1;
470 __btree_node_offset_to_ptr(const struct btree *b, u16 offset)
472 return (void *) ((u64 *) b->data + 1 + offset);
476 __btree_node_ptr_to_offset(const struct btree *b, const void *p)
478 u16 ret = (u64 *) p - 1 - (u64 *) b->data;
480 EBUG_ON(__btree_node_offset_to_ptr(b, ret) != p);
484 static inline struct bset *bset(const struct btree *b,
485 const struct bset_tree *t)
487 return __btree_node_offset_to_ptr(b, t->data_offset);
490 static inline void set_btree_bset_end(struct btree *b, struct bset_tree *t)
493 __btree_node_ptr_to_offset(b, vstruct_last(bset(b, t)));
496 static inline void set_btree_bset(struct btree *b, struct bset_tree *t,
497 const struct bset *i)
499 t->data_offset = __btree_node_ptr_to_offset(b, i);
500 set_btree_bset_end(b, t);
503 static inline struct bset *btree_bset_first(struct btree *b)
505 return bset(b, b->set);
508 static inline struct bset *btree_bset_last(struct btree *b)
510 return bset(b, bset_tree_last(b));
514 __btree_node_key_to_offset(const struct btree *b, const struct bkey_packed *k)
516 return __btree_node_ptr_to_offset(b, k);
519 static inline struct bkey_packed *
520 __btree_node_offset_to_key(const struct btree *b, u16 k)
522 return __btree_node_offset_to_ptr(b, k);
525 static inline unsigned btree_bkey_first_offset(const struct bset_tree *t)
527 return t->data_offset + offsetof(struct bset, _data) / sizeof(u64);
530 #define btree_bkey_first(_b, _t) \
532 EBUG_ON(bset(_b, _t)->start != \
533 __btree_node_offset_to_key(_b, btree_bkey_first_offset(_t)));\
535 bset(_b, _t)->start; \
538 #define btree_bkey_last(_b, _t) \
540 EBUG_ON(__btree_node_offset_to_key(_b, (_t)->end_offset) != \
541 vstruct_last(bset(_b, _t))); \
543 __btree_node_offset_to_key(_b, (_t)->end_offset); \
546 static inline unsigned bset_u64s(struct bset_tree *t)
548 return t->end_offset - t->data_offset -
549 sizeof(struct bset) / sizeof(u64);
552 static inline unsigned bset_dead_u64s(struct btree *b, struct bset_tree *t)
554 return bset_u64s(t) - b->nr.bset_u64s[t - b->set];
557 static inline unsigned bset_byte_offset(struct btree *b, void *i)
559 return i - (void *) b->data;
562 enum btree_node_type {
563 #define x(kwd, val) BKEY_TYPE_##kwd = val,
569 /* Type of a key in btree @id at level @level: */
570 static inline enum btree_node_type __btree_node_type(unsigned level, enum btree_id id)
572 return level ? BKEY_TYPE_btree : (enum btree_node_type) id;
575 /* Type of keys @b contains: */
576 static inline enum btree_node_type btree_node_type(struct btree *b)
578 return __btree_node_type(b->c.level, b->c.btree_id);
581 static inline bool btree_node_type_is_extents(enum btree_node_type type)
584 case BKEY_TYPE_extents:
585 case BKEY_TYPE_reflink:
592 static inline bool btree_node_is_extents(struct btree *b)
594 return btree_node_type_is_extents(btree_node_type(b));
597 static inline enum btree_node_type btree_iter_key_type(struct btree_iter *iter)
599 return __btree_node_type(iter->level, iter->btree_id);
602 static inline bool btree_iter_is_extents(struct btree_iter *iter)
604 return btree_node_type_is_extents(btree_iter_key_type(iter));
607 #define BTREE_NODE_TYPE_HAS_TRANS_TRIGGERS \
608 ((1U << BKEY_TYPE_extents)| \
609 (1U << BKEY_TYPE_inodes)| \
610 (1U << BKEY_TYPE_stripes)| \
611 (1U << BKEY_TYPE_reflink)| \
612 (1U << BKEY_TYPE_btree))
614 #define BTREE_NODE_TYPE_HAS_MEM_TRIGGERS \
615 ((1U << BKEY_TYPE_alloc)| \
616 (1U << BKEY_TYPE_stripes))
618 #define BTREE_NODE_TYPE_HAS_TRIGGERS \
619 (BTREE_NODE_TYPE_HAS_TRANS_TRIGGERS| \
620 BTREE_NODE_TYPE_HAS_MEM_TRIGGERS)
622 #define BTREE_ID_HAS_SNAPSHOTS \
623 ((1U << BTREE_ID_extents)| \
624 (1U << BTREE_ID_inodes)| \
625 (1U << BTREE_ID_dirents)| \
626 (1U << BTREE_ID_xattrs))
628 #define BTREE_ID_HAS_PTRS \
629 ((1U << BTREE_ID_extents)| \
630 (1U << BTREE_ID_reflink))
632 static inline bool btree_type_has_snapshots(enum btree_id id)
634 return (1 << id) & BTREE_ID_HAS_SNAPSHOTS;
637 enum btree_trigger_flags {
638 __BTREE_TRIGGER_NORUN, /* Don't run triggers at all */
640 __BTREE_TRIGGER_INSERT,
641 __BTREE_TRIGGER_OVERWRITE,
642 __BTREE_TRIGGER_OVERWRITE_SPLIT,
645 __BTREE_TRIGGER_BUCKET_INVALIDATE,
646 __BTREE_TRIGGER_NOATOMIC,
649 #define BTREE_TRIGGER_NORUN (1U << __BTREE_TRIGGER_NORUN)
651 #define BTREE_TRIGGER_INSERT (1U << __BTREE_TRIGGER_INSERT)
652 #define BTREE_TRIGGER_OVERWRITE (1U << __BTREE_TRIGGER_OVERWRITE)
653 #define BTREE_TRIGGER_OVERWRITE_SPLIT (1U << __BTREE_TRIGGER_OVERWRITE_SPLIT)
655 #define BTREE_TRIGGER_GC (1U << __BTREE_TRIGGER_GC)
656 #define BTREE_TRIGGER_BUCKET_INVALIDATE (1U << __BTREE_TRIGGER_BUCKET_INVALIDATE)
657 #define BTREE_TRIGGER_NOATOMIC (1U << __BTREE_TRIGGER_NOATOMIC)
659 static inline bool btree_node_type_needs_gc(enum btree_node_type type)
661 return BTREE_NODE_TYPE_HAS_TRIGGERS & (1U << type);
667 /* On disk root - see async splits: */
668 __BKEY_PADDED(key, BKEY_BTREE_PTR_VAL_U64s_MAX);
675 * Optional hook that will be called just prior to a btree node update, when
676 * we're holding the write lock and we know what key is about to be overwritten:
679 enum btree_insert_ret {
681 /* leaf node needs to be split */
682 BTREE_INSERT_BTREE_NODE_FULL,
684 BTREE_INSERT_NEED_MARK_REPLICAS,
685 BTREE_INSERT_NEED_JOURNAL_RES,
686 BTREE_INSERT_NEED_JOURNAL_RECLAIM,
689 enum btree_gc_coalesce_fail_reason {
690 BTREE_GC_COALESCE_FAIL_RESERVE_GET,
691 BTREE_GC_COALESCE_FAIL_KEYLIST_REALLOC,
692 BTREE_GC_COALESCE_FAIL_FORMAT_FITS,
695 enum btree_node_sibling {
700 typedef struct btree_nr_keys (*sort_fix_overlapping_fn)(struct bset *,
702 struct btree_node_iter *);
704 #endif /* _BCACHEFS_BTREE_TYPES_H */