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;
60 __BKEY_PADDED(k, BKEY_BTREE_PTR_VAL_U64s_MAX);
63 struct btree_bkey_cached_common {
70 struct btree_bkey_cached_common c;
72 struct rhash_head hash;
81 struct bkey_format format;
83 struct btree_node *data;
87 * Sets of sorted keys - the real btree node - plus a binary search tree
89 * set[0] is special; set[0]->tree, set[0]->prev and set[0]->data point
90 * to the memory we have allocated for this btree node. Additionally,
91 * set[0]->data points to the entire btree node as it exists on disk.
93 struct bset_tree set[MAX_BSETS];
95 struct btree_nr_keys nr;
102 * XXX: add a delete sequence number, so when bch2_btree_node_relock()
103 * fails because the lock sequence number has changed - i.e. the
104 * contents were modified - we can still relock the node if it's still
105 * the one we want, without redoing the traversal
109 * For asynchronous splits/interior node updates:
110 * When we do a split, we allocate new child nodes and update the parent
111 * node to point to them: we update the parent in memory immediately,
112 * but then we must wait until the children have been written out before
113 * the update to the parent can be written - this is a list of the
114 * btree_updates that are blocking this node from being
117 struct list_head write_blocked;
120 * Also for asynchronous splits/interior node updates:
121 * If a btree node isn't reachable yet, we don't want to kick off
122 * another write - because that write also won't yet be reachable and
123 * marking it as completed before it's reachable would be incorrect:
125 unsigned long will_make_reachable;
127 struct open_buckets ob;
130 struct list_head list;
132 struct btree_write writes[2];
134 /* Key/pointer for this btree node */
135 __BKEY_PADDED(key, BKEY_BTREE_PTR_VAL_U64s_MAX);
139 struct rhashtable table;
140 bool table_init_done;
142 * We never free a struct btree, except on shutdown - we just put it on
143 * the btree_cache_freed list and reuse it later. This simplifies the
144 * code, and it doesn't cost us much memory as the memory usage is
145 * dominated by buffers that hold the actual btree node data and those
146 * can be freed - and the number of struct btrees allocated is
147 * effectively bounded.
149 * btree_cache_freeable effectively is a small cache - we use it because
150 * high order page allocations can be rather expensive, and it's quite
151 * common to delete and allocate btree nodes in quick succession. It
152 * should never grow past ~2-3 nodes in practice.
155 struct list_head live;
156 struct list_head freeable;
157 struct list_head freed;
159 /* Number of elements in live + freeable lists */
163 struct shrinker shrink;
166 * If we need to allocate memory for a new btree node and that
167 * allocation fails, we can cannibalize another node in the btree cache
168 * to satisfy the allocation - lock to guarantee only one thread does
171 struct task_struct *alloc_lock;
172 struct closure_waitlist alloc_wait;
175 struct btree_node_iter {
176 struct btree_node_iter_set {
181 enum btree_iter_type {
187 #define BTREE_ITER_TYPE ((1 << 2) - 1)
190 * Iterate over all possible positions, synthesizing deleted keys for holes:
192 #define BTREE_ITER_SLOTS (1 << 2)
194 * Indicates that intent locks should be taken on leaf nodes, because we expect
195 * to be doing updates:
197 #define BTREE_ITER_INTENT (1 << 3)
199 * Causes the btree iterator code to prefetch additional btree nodes from disk:
201 #define BTREE_ITER_PREFETCH (1 << 4)
203 * Indicates that this iterator should not be reused until transaction commit,
204 * either because a pending update references it or because the update depends
205 * on that particular key being locked (e.g. by the str_hash code, for hash
208 #define BTREE_ITER_KEEP_UNTIL_COMMIT (1 << 5)
210 * Used in bch2_btree_iter_traverse(), to indicate whether we're searching for
211 * @pos or the first key strictly greater than @pos
213 #define BTREE_ITER_IS_EXTENTS (1 << 6)
214 #define BTREE_ITER_ERROR (1 << 7)
215 #define BTREE_ITER_SET_POS_AFTER_COMMIT (1 << 8)
216 #define BTREE_ITER_CACHED_NOFILL (1 << 9)
217 #define BTREE_ITER_CACHED_NOCREATE (1 << 10)
218 #define BTREE_ITER_NOT_EXTENTS (1 << 11)
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)
236 * @pos - iterator's current position
237 * @level - current btree depth
238 * @locks_want - btree level below which we start taking intent locks
239 * @nodes_locked - bitmask indicating which nodes in @nodes are locked
240 * @nodes_intent_locked - bitmask indicating which locks are intent locks
243 struct btree_trans *trans;
245 /* what we're searching for/what the iterator actually points to: */
246 struct bpos real_pos;
247 struct bpos pos_after_commit;
252 enum btree_id btree_id:4;
253 enum btree_iter_uptodate uptodate:4;
258 nodes_intent_locked:4;
260 struct btree_iter_level {
262 struct btree_node_iter iter;
264 } l[BTREE_MAX_DEPTH];
267 * Current unpacked key - so that bch2_btree_iter_next()/
268 * bch2_btree_iter_next_slot() can correctly advance pos.
271 unsigned long ip_allocated;
274 static inline enum btree_iter_type
275 btree_iter_type(const struct btree_iter *iter)
277 return iter->flags & BTREE_ITER_TYPE;
280 static inline bool btree_iter_is_cached(const struct btree_iter *iter)
282 return btree_iter_type(iter) == BTREE_ITER_CACHED;
285 static inline struct btree_iter_level *iter_l(struct btree_iter *iter)
287 return iter->l + iter->level;
290 struct btree_key_cache {
292 struct rhashtable table;
293 bool table_init_done;
294 struct list_head freed;
295 struct list_head clean;
296 struct list_head dirty;
297 struct shrinker shrink;
304 struct bkey_cached_key {
307 } __attribute__((packed, aligned(4)));
309 #define BKEY_CACHED_ACCESSED 0
310 #define BKEY_CACHED_DIRTY 1
313 struct btree_bkey_cached_common c;
318 u32 btree_trans_barrier_seq;
319 struct bkey_cached_key key;
321 struct rhash_head hash;
322 struct list_head list;
324 struct journal_preres res;
325 struct journal_entry_pin journal;
330 struct btree_insert_entry {
331 unsigned trigger_flags;
335 unsigned trans_triggers_run:1;
336 unsigned is_extent:1;
338 struct btree_iter *iter;
341 #ifndef CONFIG_LOCKDEP
342 #define BTREE_ITER_MAX 64
344 #define BTREE_ITER_MAX 32
349 #ifdef CONFIG_BCACHEFS_DEBUG
350 struct list_head list;
351 struct btree *locking;
352 unsigned locking_iter_idx;
353 struct bpos locking_pos;
363 unsigned used_mempool:1;
366 unsigned in_traverse_all:1;
376 struct btree_iter *iters;
377 struct btree_insert_entry *updates;
378 struct btree_insert_entry *updates2;
381 struct jset_entry *extra_journal_entries;
382 unsigned extra_journal_entry_u64s;
383 struct journal_entry_pin *journal_pin;
385 struct journal_res journal_res;
386 struct journal_preres journal_preres;
388 struct disk_reservation *disk_res;
390 unsigned journal_u64s;
391 unsigned journal_preres_u64s;
392 struct replicas_delta_list *fs_usage_deltas;
395 #define BTREE_FLAG(flag) \
396 static inline bool btree_node_ ## flag(struct btree *b) \
397 { return test_bit(BTREE_NODE_ ## flag, &b->flags); } \
399 static inline void set_btree_node_ ## flag(struct btree *b) \
400 { set_bit(BTREE_NODE_ ## flag, &b->flags); } \
402 static inline void clear_btree_node_ ## flag(struct btree *b) \
403 { clear_bit(BTREE_NODE_ ## flag, &b->flags); }
406 BTREE_NODE_read_in_flight,
407 BTREE_NODE_read_error,
409 BTREE_NODE_need_write,
411 BTREE_NODE_write_idx,
413 BTREE_NODE_write_in_flight,
414 BTREE_NODE_just_written,
417 BTREE_NODE_need_rewrite,
418 BTREE_NODE_never_write,
421 BTREE_FLAG(read_in_flight);
422 BTREE_FLAG(read_error);
423 BTREE_FLAG(need_write);
425 BTREE_FLAG(write_idx);
426 BTREE_FLAG(accessed);
427 BTREE_FLAG(write_in_flight);
428 BTREE_FLAG(just_written);
431 BTREE_FLAG(need_rewrite);
432 BTREE_FLAG(never_write);
434 static inline struct btree_write *btree_current_write(struct btree *b)
436 return b->writes + btree_node_write_idx(b);
439 static inline struct btree_write *btree_prev_write(struct btree *b)
441 return b->writes + (btree_node_write_idx(b) ^ 1);
444 static inline struct bset_tree *bset_tree_last(struct btree *b)
447 return b->set + b->nsets - 1;
451 __btree_node_offset_to_ptr(const struct btree *b, u16 offset)
453 return (void *) ((u64 *) b->data + 1 + offset);
457 __btree_node_ptr_to_offset(const struct btree *b, const void *p)
459 u16 ret = (u64 *) p - 1 - (u64 *) b->data;
461 EBUG_ON(__btree_node_offset_to_ptr(b, ret) != p);
465 static inline struct bset *bset(const struct btree *b,
466 const struct bset_tree *t)
468 return __btree_node_offset_to_ptr(b, t->data_offset);
471 static inline void set_btree_bset_end(struct btree *b, struct bset_tree *t)
474 __btree_node_ptr_to_offset(b, vstruct_last(bset(b, t)));
477 static inline void set_btree_bset(struct btree *b, struct bset_tree *t,
478 const struct bset *i)
480 t->data_offset = __btree_node_ptr_to_offset(b, i);
481 set_btree_bset_end(b, t);
484 static inline struct bset *btree_bset_first(struct btree *b)
486 return bset(b, b->set);
489 static inline struct bset *btree_bset_last(struct btree *b)
491 return bset(b, bset_tree_last(b));
495 __btree_node_key_to_offset(const struct btree *b, const struct bkey_packed *k)
497 return __btree_node_ptr_to_offset(b, k);
500 static inline struct bkey_packed *
501 __btree_node_offset_to_key(const struct btree *b, u16 k)
503 return __btree_node_offset_to_ptr(b, k);
506 static inline unsigned btree_bkey_first_offset(const struct bset_tree *t)
508 return t->data_offset + offsetof(struct bset, _data) / sizeof(u64);
511 #define btree_bkey_first(_b, _t) \
513 EBUG_ON(bset(_b, _t)->start != \
514 __btree_node_offset_to_key(_b, btree_bkey_first_offset(_t)));\
516 bset(_b, _t)->start; \
519 #define btree_bkey_last(_b, _t) \
521 EBUG_ON(__btree_node_offset_to_key(_b, (_t)->end_offset) != \
522 vstruct_last(bset(_b, _t))); \
524 __btree_node_offset_to_key(_b, (_t)->end_offset); \
527 static inline unsigned bset_u64s(struct bset_tree *t)
529 return t->end_offset - t->data_offset -
530 sizeof(struct bset) / sizeof(u64);
533 static inline unsigned bset_dead_u64s(struct btree *b, struct bset_tree *t)
535 return bset_u64s(t) - b->nr.bset_u64s[t - b->set];
538 static inline unsigned bset_byte_offset(struct btree *b, void *i)
540 return i - (void *) b->data;
543 enum btree_node_type {
544 #define x(kwd, val) BKEY_TYPE_##kwd = val,
550 /* Type of a key in btree @id at level @level: */
551 static inline enum btree_node_type __btree_node_type(unsigned level, enum btree_id id)
553 return level ? BKEY_TYPE_btree : (enum btree_node_type) id;
556 /* Type of keys @b contains: */
557 static inline enum btree_node_type btree_node_type(struct btree *b)
559 return __btree_node_type(b->c.level, b->c.btree_id);
562 static inline bool btree_node_type_is_extents(enum btree_node_type type)
565 case BKEY_TYPE_extents:
566 case BKEY_TYPE_reflink:
573 static inline bool btree_node_is_extents(struct btree *b)
575 return btree_node_type_is_extents(btree_node_type(b));
578 static inline enum btree_node_type btree_iter_key_type(struct btree_iter *iter)
580 return __btree_node_type(iter->level, iter->btree_id);
583 static inline bool btree_iter_is_extents(struct btree_iter *iter)
585 return btree_node_type_is_extents(btree_iter_key_type(iter));
588 #define BTREE_NODE_TYPE_HAS_TRANS_TRIGGERS \
589 ((1U << BKEY_TYPE_extents)| \
590 (1U << BKEY_TYPE_inodes)| \
591 (1U << BKEY_TYPE_stripes)| \
592 (1U << BKEY_TYPE_reflink)| \
593 (1U << BKEY_TYPE_btree))
595 #define BTREE_NODE_TYPE_HAS_MEM_TRIGGERS \
596 ((1U << BKEY_TYPE_alloc)| \
597 (1U << BKEY_TYPE_stripes))
599 #define BTREE_NODE_TYPE_HAS_TRIGGERS \
600 (BTREE_NODE_TYPE_HAS_TRANS_TRIGGERS| \
601 BTREE_NODE_TYPE_HAS_MEM_TRIGGERS)
603 enum btree_trigger_flags {
604 __BTREE_TRIGGER_NORUN, /* Don't run triggers at all */
606 __BTREE_TRIGGER_INSERT,
607 __BTREE_TRIGGER_OVERWRITE,
608 __BTREE_TRIGGER_OVERWRITE_SPLIT,
611 __BTREE_TRIGGER_BUCKET_INVALIDATE,
612 __BTREE_TRIGGER_NOATOMIC,
615 #define BTREE_TRIGGER_NORUN (1U << __BTREE_TRIGGER_NORUN)
617 #define BTREE_TRIGGER_INSERT (1U << __BTREE_TRIGGER_INSERT)
618 #define BTREE_TRIGGER_OVERWRITE (1U << __BTREE_TRIGGER_OVERWRITE)
619 #define BTREE_TRIGGER_OVERWRITE_SPLIT (1U << __BTREE_TRIGGER_OVERWRITE_SPLIT)
621 #define BTREE_TRIGGER_GC (1U << __BTREE_TRIGGER_GC)
622 #define BTREE_TRIGGER_BUCKET_INVALIDATE (1U << __BTREE_TRIGGER_BUCKET_INVALIDATE)
623 #define BTREE_TRIGGER_NOATOMIC (1U << __BTREE_TRIGGER_NOATOMIC)
625 static inline bool btree_node_type_needs_gc(enum btree_node_type type)
627 return BTREE_NODE_TYPE_HAS_TRIGGERS & (1U << type);
633 /* On disk root - see async splits: */
634 __BKEY_PADDED(key, BKEY_BTREE_PTR_VAL_U64s_MAX);
641 * Optional hook that will be called just prior to a btree node update, when
642 * we're holding the write lock and we know what key is about to be overwritten:
645 enum btree_insert_ret {
647 /* leaf node needs to be split */
648 BTREE_INSERT_BTREE_NODE_FULL,
650 BTREE_INSERT_NEED_MARK_REPLICAS,
651 BTREE_INSERT_NEED_JOURNAL_RES,
652 BTREE_INSERT_NEED_JOURNAL_RECLAIM,
655 enum btree_gc_coalesce_fail_reason {
656 BTREE_GC_COALESCE_FAIL_RESERVE_GET,
657 BTREE_GC_COALESCE_FAIL_KEYLIST_REALLOC,
658 BTREE_GC_COALESCE_FAIL_FORMAT_FITS,
661 enum btree_node_sibling {
666 typedef struct btree_nr_keys (*sort_fix_overlapping_fn)(struct bset *,
668 struct btree_node_iter *);
670 #endif /* _BCACHEFS_BTREE_TYPES_H */