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() */
55 struct journal_entry_pin journal;
59 struct open_buckets ob;
63 struct btree_bkey_cached_common {
70 struct btree_bkey_cached_common c;
72 struct rhash_head hash;
80 struct bkey_format format;
82 struct btree_node *data;
86 * Sets of sorted keys - the real btree node - plus a binary search tree
88 * set[0] is special; set[0]->tree, set[0]->prev and set[0]->data point
89 * to the memory we have allocated for this btree node. Additionally,
90 * set[0]->data points to the entire btree node as it exists on disk.
92 struct bset_tree set[MAX_BSETS];
94 struct btree_nr_keys nr;
101 * XXX: add a delete sequence number, so when bch2_btree_node_relock()
102 * fails because the lock sequence number has changed - i.e. the
103 * contents were modified - we can still relock the node if it's still
104 * the one we want, without redoing the traversal
108 * For asynchronous splits/interior node updates:
109 * When we do a split, we allocate new child nodes and update the parent
110 * node to point to them: we update the parent in memory immediately,
111 * but then we must wait until the children have been written out before
112 * the update to the parent can be written - this is a list of the
113 * btree_updates that are blocking this node from being
116 struct list_head write_blocked;
119 * Also for asynchronous splits/interior node updates:
120 * If a btree node isn't reachable yet, we don't want to kick off
121 * another write - because that write also won't yet be reachable and
122 * marking it as completed before it's reachable would be incorrect:
124 unsigned long will_make_reachable;
126 struct open_buckets ob;
129 struct list_head list;
131 struct btree_write writes[2];
133 #ifdef CONFIG_BCACHEFS_DEBUG
134 bool *expensive_debug_checks;
137 /* Key/pointer for this btree node */
138 __BKEY_PADDED(key, BKEY_BTREE_PTR_VAL_U64s_MAX);
142 struct rhashtable table;
143 bool table_init_done;
145 * We never free a struct btree, except on shutdown - we just put it on
146 * the btree_cache_freed list and reuse it later. This simplifies the
147 * code, and it doesn't cost us much memory as the memory usage is
148 * dominated by buffers that hold the actual btree node data and those
149 * can be freed - and the number of struct btrees allocated is
150 * effectively bounded.
152 * btree_cache_freeable effectively is a small cache - we use it because
153 * high order page allocations can be rather expensive, and it's quite
154 * common to delete and allocate btree nodes in quick succession. It
155 * should never grow past ~2-3 nodes in practice.
158 struct list_head live;
159 struct list_head freeable;
160 struct list_head freed;
162 /* Number of elements in live + freeable lists */
165 struct shrinker shrink;
168 * If we need to allocate memory for a new btree node and that
169 * allocation fails, we can cannibalize another node in the btree cache
170 * to satisfy the allocation - lock to guarantee only one thread does
173 struct task_struct *alloc_lock;
174 struct closure_waitlist alloc_wait;
177 struct btree_node_iter {
178 struct btree_node_iter_set {
183 enum btree_iter_type {
189 #define BTREE_ITER_TYPE ((1 << 2) - 1)
192 * Iterate over all possible positions, synthesizing deleted keys for holes:
194 #define BTREE_ITER_SLOTS (1 << 2)
196 * Indicates that intent locks should be taken on leaf nodes, because we expect
197 * to be doing updates:
199 #define BTREE_ITER_INTENT (1 << 3)
201 * Causes the btree iterator code to prefetch additional btree nodes from disk:
203 #define BTREE_ITER_PREFETCH (1 << 4)
205 * Indicates that this iterator should not be reused until transaction commit,
206 * either because a pending update references it or because the update depends
207 * on that particular key being locked (e.g. by the str_hash code, for hash
210 #define BTREE_ITER_KEEP_UNTIL_COMMIT (1 << 5)
212 * Used in bch2_btree_iter_traverse(), to indicate whether we're searching for
213 * @pos or the first key strictly greater than @pos
215 #define BTREE_ITER_IS_EXTENTS (1 << 6)
216 #define BTREE_ITER_ERROR (1 << 7)
217 #define BTREE_ITER_SET_POS_AFTER_COMMIT (1 << 8)
218 #define BTREE_ITER_CACHED_NOFILL (1 << 9)
219 #define BTREE_ITER_CACHED_NOCREATE (1 << 10)
221 #define BTREE_ITER_USER_FLAGS \
224 |BTREE_ITER_PREFETCH \
225 |BTREE_ITER_CACHED_NOFILL \
226 |BTREE_ITER_CACHED_NOCREATE)
228 enum btree_iter_uptodate {
229 BTREE_ITER_UPTODATE = 0,
230 BTREE_ITER_NEED_PEEK = 1,
231 BTREE_ITER_NEED_RELOCK = 2,
232 BTREE_ITER_NEED_TRAVERSE = 3,
235 #define BTREE_ITER_NO_NODE_GET_LOCKS ((struct btree *) 1)
236 #define BTREE_ITER_NO_NODE_DROP ((struct btree *) 2)
237 #define BTREE_ITER_NO_NODE_LOCK_ROOT ((struct btree *) 3)
238 #define BTREE_ITER_NO_NODE_UP ((struct btree *) 4)
239 #define BTREE_ITER_NO_NODE_DOWN ((struct btree *) 5)
240 #define BTREE_ITER_NO_NODE_INIT ((struct btree *) 6)
241 #define BTREE_ITER_NO_NODE_ERROR ((struct btree *) 7)
244 * @pos - iterator's current position
245 * @level - current btree depth
246 * @locks_want - btree level below which we start taking intent locks
247 * @nodes_locked - bitmask indicating which nodes in @nodes are locked
248 * @nodes_intent_locked - bitmask indicating which locks are intent locks
251 struct btree_trans *trans;
253 struct bpos pos_after_commit;
258 enum btree_id btree_id:4;
259 enum btree_iter_uptodate uptodate:4;
264 nodes_intent_locked:4;
266 struct btree_iter_level {
268 struct btree_node_iter iter;
270 } l[BTREE_MAX_DEPTH];
273 * Current unpacked key - so that bch2_btree_iter_next()/
274 * bch2_btree_iter_next_slot() can correctly advance pos.
277 unsigned long ip_allocated;
280 static inline enum btree_iter_type
281 btree_iter_type(const struct btree_iter *iter)
283 return iter->flags & BTREE_ITER_TYPE;
286 static inline struct btree_iter_level *iter_l(struct btree_iter *iter)
288 return iter->l + iter->level;
291 struct btree_key_cache {
293 struct rhashtable table;
294 struct list_head freed;
295 struct list_head clean;
298 struct bkey_cached_key {
301 } __attribute__((packed, aligned(4)));
303 #define BKEY_CACHED_DIRTY 0
306 struct btree_bkey_cached_common c;
311 struct bkey_cached_key key;
313 struct rhash_head hash;
314 struct list_head list;
316 struct journal_preres res;
317 struct journal_entry_pin journal;
322 struct btree_insert_entry {
323 unsigned trigger_flags;
324 unsigned trans_triggers_run:1;
326 struct btree_iter *iter;
329 #ifndef CONFIG_LOCKDEP
330 #define BTREE_ITER_MAX 64
332 #define BTREE_ITER_MAX 32
337 #ifdef CONFIG_BCACHEFS_DEBUG
338 struct list_head list;
339 struct btree *locking;
340 unsigned locking_iter_idx;
341 struct bpos locking_pos;
356 unsigned used_mempool:1;
359 unsigned need_reset:1;
360 unsigned in_traverse_all:1;
366 struct btree_iter *iters;
367 struct btree_insert_entry *updates;
368 struct btree_insert_entry *updates2;
371 struct jset_entry *extra_journal_entries;
372 unsigned extra_journal_entry_u64s;
373 struct journal_entry_pin *journal_pin;
375 struct journal_res journal_res;
376 struct journal_preres journal_preres;
378 struct disk_reservation *disk_res;
380 unsigned journal_u64s;
381 unsigned journal_preres_u64s;
382 struct replicas_delta_list *fs_usage_deltas;
384 struct btree_iter iters_onstack[2];
385 struct btree_insert_entry updates_onstack[2];
386 struct btree_insert_entry updates2_onstack[2];
389 #define BTREE_FLAG(flag) \
390 static inline bool btree_node_ ## flag(struct btree *b) \
391 { return test_bit(BTREE_NODE_ ## flag, &b->flags); } \
393 static inline void set_btree_node_ ## flag(struct btree *b) \
394 { set_bit(BTREE_NODE_ ## flag, &b->flags); } \
396 static inline void clear_btree_node_ ## flag(struct btree *b) \
397 { clear_bit(BTREE_NODE_ ## flag, &b->flags); }
400 BTREE_NODE_read_in_flight,
401 BTREE_NODE_read_error,
403 BTREE_NODE_need_write,
405 BTREE_NODE_write_idx,
407 BTREE_NODE_write_in_flight,
408 BTREE_NODE_just_written,
411 BTREE_NODE_old_extent_overwrite,
412 BTREE_NODE_need_rewrite,
415 BTREE_FLAG(read_in_flight);
416 BTREE_FLAG(read_error);
418 BTREE_FLAG(need_write);
420 BTREE_FLAG(write_idx);
421 BTREE_FLAG(accessed);
422 BTREE_FLAG(write_in_flight);
423 BTREE_FLAG(just_written);
426 BTREE_FLAG(old_extent_overwrite);
427 BTREE_FLAG(need_rewrite);
429 static inline struct btree_write *btree_current_write(struct btree *b)
431 return b->writes + btree_node_write_idx(b);
434 static inline struct btree_write *btree_prev_write(struct btree *b)
436 return b->writes + (btree_node_write_idx(b) ^ 1);
439 static inline struct bset_tree *bset_tree_last(struct btree *b)
442 return b->set + b->nsets - 1;
446 __btree_node_offset_to_ptr(const struct btree *b, u16 offset)
448 return (void *) ((u64 *) b->data + 1 + offset);
452 __btree_node_ptr_to_offset(const struct btree *b, const void *p)
454 u16 ret = (u64 *) p - 1 - (u64 *) b->data;
456 EBUG_ON(__btree_node_offset_to_ptr(b, ret) != p);
460 static inline struct bset *bset(const struct btree *b,
461 const struct bset_tree *t)
463 return __btree_node_offset_to_ptr(b, t->data_offset);
466 static inline void set_btree_bset_end(struct btree *b, struct bset_tree *t)
469 __btree_node_ptr_to_offset(b, vstruct_last(bset(b, t)));
472 static inline void set_btree_bset(struct btree *b, struct bset_tree *t,
473 const struct bset *i)
475 t->data_offset = __btree_node_ptr_to_offset(b, i);
476 set_btree_bset_end(b, t);
479 static inline struct bset *btree_bset_first(struct btree *b)
481 return bset(b, b->set);
484 static inline struct bset *btree_bset_last(struct btree *b)
486 return bset(b, bset_tree_last(b));
490 __btree_node_key_to_offset(const struct btree *b, const struct bkey_packed *k)
492 return __btree_node_ptr_to_offset(b, k);
495 static inline struct bkey_packed *
496 __btree_node_offset_to_key(const struct btree *b, u16 k)
498 return __btree_node_offset_to_ptr(b, k);
501 static inline unsigned btree_bkey_first_offset(const struct bset_tree *t)
503 return t->data_offset + offsetof(struct bset, _data) / sizeof(u64);
506 #define btree_bkey_first(_b, _t) \
508 EBUG_ON(bset(_b, _t)->start != \
509 __btree_node_offset_to_key(_b, btree_bkey_first_offset(_t)));\
511 bset(_b, _t)->start; \
514 #define btree_bkey_last(_b, _t) \
516 EBUG_ON(__btree_node_offset_to_key(_b, (_t)->end_offset) != \
517 vstruct_last(bset(_b, _t))); \
519 __btree_node_offset_to_key(_b, (_t)->end_offset); \
522 static inline unsigned bset_u64s(struct bset_tree *t)
524 return t->end_offset - t->data_offset -
525 sizeof(struct bset) / sizeof(u64);
528 static inline unsigned bset_dead_u64s(struct btree *b, struct bset_tree *t)
530 return bset_u64s(t) - b->nr.bset_u64s[t - b->set];
533 static inline unsigned bset_byte_offset(struct btree *b, void *i)
535 return i - (void *) b->data;
538 enum btree_node_type {
539 #define x(kwd, val, name) BKEY_TYPE_##kwd = val,
545 /* Type of a key in btree @id at level @level: */
546 static inline enum btree_node_type __btree_node_type(unsigned level, enum btree_id id)
548 return level ? BKEY_TYPE_BTREE : (enum btree_node_type) id;
551 /* Type of keys @b contains: */
552 static inline enum btree_node_type btree_node_type(struct btree *b)
554 return __btree_node_type(b->c.level, b->c.btree_id);
557 static inline bool btree_node_type_is_extents(enum btree_node_type type)
560 case BKEY_TYPE_EXTENTS:
561 case BKEY_TYPE_REFLINK:
568 static inline bool btree_node_is_extents(struct btree *b)
570 return btree_node_type_is_extents(btree_node_type(b));
573 static inline enum btree_node_type btree_iter_key_type(struct btree_iter *iter)
575 return __btree_node_type(iter->level, iter->btree_id);
578 static inline bool btree_iter_is_extents(struct btree_iter *iter)
580 return btree_node_type_is_extents(btree_iter_key_type(iter));
583 #define BTREE_NODE_TYPE_HAS_TRIGGERS \
584 ((1U << BKEY_TYPE_EXTENTS)| \
585 (1U << BKEY_TYPE_ALLOC)| \
586 (1U << BKEY_TYPE_INODES)| \
587 (1U << BKEY_TYPE_REFLINK)| \
588 (1U << BKEY_TYPE_EC)| \
589 (1U << BKEY_TYPE_BTREE))
591 #define BTREE_NODE_TYPE_HAS_TRANS_TRIGGERS \
592 ((1U << BKEY_TYPE_EXTENTS)| \
593 (1U << BKEY_TYPE_INODES)| \
594 (1U << BKEY_TYPE_EC)| \
595 (1U << BKEY_TYPE_REFLINK))
597 enum btree_trigger_flags {
598 __BTREE_TRIGGER_NORUN, /* Don't run triggers at all */
600 __BTREE_TRIGGER_INSERT,
601 __BTREE_TRIGGER_OVERWRITE,
602 __BTREE_TRIGGER_OVERWRITE_SPLIT,
605 __BTREE_TRIGGER_BUCKET_INVALIDATE,
606 __BTREE_TRIGGER_NOATOMIC,
609 #define BTREE_TRIGGER_NORUN (1U << __BTREE_TRIGGER_NORUN)
611 #define BTREE_TRIGGER_INSERT (1U << __BTREE_TRIGGER_INSERT)
612 #define BTREE_TRIGGER_OVERWRITE (1U << __BTREE_TRIGGER_OVERWRITE)
613 #define BTREE_TRIGGER_OVERWRITE_SPLIT (1U << __BTREE_TRIGGER_OVERWRITE_SPLIT)
615 #define BTREE_TRIGGER_GC (1U << __BTREE_TRIGGER_GC)
616 #define BTREE_TRIGGER_BUCKET_INVALIDATE (1U << __BTREE_TRIGGER_BUCKET_INVALIDATE)
617 #define BTREE_TRIGGER_NOATOMIC (1U << __BTREE_TRIGGER_NOATOMIC)
619 static inline bool btree_node_type_needs_gc(enum btree_node_type type)
621 return BTREE_NODE_TYPE_HAS_TRIGGERS & (1U << type);
627 /* On disk root - see async splits: */
628 __BKEY_PADDED(key, BKEY_BTREE_PTR_VAL_U64s_MAX);
635 * Optional hook that will be called just prior to a btree node update, when
636 * we're holding the write lock and we know what key is about to be overwritten:
639 enum btree_insert_ret {
641 /* leaf node needs to be split */
642 BTREE_INSERT_BTREE_NODE_FULL,
644 BTREE_INSERT_NEED_MARK_REPLICAS,
645 BTREE_INSERT_NEED_JOURNAL_RES,
648 enum btree_gc_coalesce_fail_reason {
649 BTREE_GC_COALESCE_FAIL_RESERVE_GET,
650 BTREE_GC_COALESCE_FAIL_KEYLIST_REALLOC,
651 BTREE_GC_COALESCE_FAIL_FORMAT_FITS,
654 enum btree_node_sibling {
659 typedef struct btree_nr_keys (*sort_fix_overlapping_fn)(struct bset *,
661 struct btree_node_iter *);
663 #endif /* _BCACHEFS_BTREE_TYPES_H */