]> git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/btree_types.h
f0b85d5c12d68f3a7aec126a4b6f09e6ad8b7127
[bcachefs-tools-debian] / libbcachefs / btree_types.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _BCACHEFS_BTREE_TYPES_H
3 #define _BCACHEFS_BTREE_TYPES_H
4
5 #include <linux/list.h>
6 #include <linux/rhashtable.h>
7 #include <linux/six.h>
8
9 #include "bkey_methods.h"
10 #include "buckets_types.h"
11 #include "journal_types.h"
12
13 struct open_bucket;
14 struct btree_update;
15 struct btree_trans;
16
17 #define MAX_BSETS               3U
18
19 struct btree_nr_keys {
20
21         /*
22          * Amount of live metadata (i.e. size of node after a compaction) in
23          * units of u64s
24          */
25         u16                     live_u64s;
26         u16                     bset_u64s[MAX_BSETS];
27
28         /* live keys only: */
29         u16                     packed_keys;
30         u16                     unpacked_keys;
31 };
32
33 struct bset_tree {
34         /*
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
38          * details
39          */
40
41         /* size of the binary tree and prev array */
42         u16                     size;
43
44         /* function of size - precalculated for to_inorder() */
45         u16                     extra;
46
47         u16                     data_offset;
48         u16                     aux_data_offset;
49         u16                     end_offset;
50
51         struct bpos             max_key;
52 };
53
54 struct btree_write {
55         struct journal_entry_pin        journal;
56 };
57
58 struct btree_alloc {
59         struct open_buckets     ob;
60         __BKEY_PADDED(k, BKEY_BTREE_PTR_VAL_U64s_MAX);
61 };
62
63 struct btree_bkey_cached_common {
64         struct six_lock         lock;
65         u8                      level;
66         u8                      btree_id;
67 };
68
69 struct btree {
70         struct btree_bkey_cached_common c;
71
72         struct rhash_head       hash;
73         u64                     hash_val;
74
75         unsigned long           flags;
76         u16                     written;
77         u8                      nsets;
78         u8                      nr_key_bits;
79
80         struct bkey_format      format;
81
82         struct btree_node       *data;
83         void                    *aux_data;
84
85         /*
86          * Sets of sorted keys - the real btree node - plus a binary search tree
87          *
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.
91          */
92         struct bset_tree        set[MAX_BSETS];
93
94         struct btree_nr_keys    nr;
95         u16                     sib_u64s[2];
96         u16                     whiteout_u64s;
97         u8                      byte_order;
98         u8                      unpack_fn_len;
99
100         /*
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
105          */
106
107         /*
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
114          * written:
115          */
116         struct list_head        write_blocked;
117
118         /*
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:
123          */
124         unsigned long           will_make_reachable;
125
126         struct open_buckets     ob;
127
128         /* lru list */
129         struct list_head        list;
130
131         struct btree_write      writes[2];
132
133         /* Key/pointer for this btree node */
134         __BKEY_PADDED(key, BKEY_BTREE_PTR_VAL_U64s_MAX);
135 };
136
137 struct btree_cache {
138         struct rhashtable       table;
139         bool                    table_init_done;
140         /*
141          * We never free a struct btree, except on shutdown - we just put it on
142          * the btree_cache_freed list and reuse it later. This simplifies the
143          * code, and it doesn't cost us much memory as the memory usage is
144          * dominated by buffers that hold the actual btree node data and those
145          * can be freed - and the number of struct btrees allocated is
146          * effectively bounded.
147          *
148          * btree_cache_freeable effectively is a small cache - we use it because
149          * high order page allocations can be rather expensive, and it's quite
150          * common to delete and allocate btree nodes in quick succession. It
151          * should never grow past ~2-3 nodes in practice.
152          */
153         struct mutex            lock;
154         struct list_head        live;
155         struct list_head        freeable;
156         struct list_head        freed;
157
158         /* Number of elements in live + freeable lists */
159         unsigned                used;
160         unsigned                reserve;
161         atomic_t                dirty;
162         struct shrinker         shrink;
163
164         /*
165          * If we need to allocate memory for a new btree node and that
166          * allocation fails, we can cannibalize another node in the btree cache
167          * to satisfy the allocation - lock to guarantee only one thread does
168          * this at a time:
169          */
170         struct task_struct      *alloc_lock;
171         struct closure_waitlist alloc_wait;
172 };
173
174 struct btree_node_iter {
175         struct btree_node_iter_set {
176                 u16     k, end;
177         } data[MAX_BSETS];
178 };
179
180 enum btree_iter_type {
181         BTREE_ITER_KEYS,
182         BTREE_ITER_NODES,
183         BTREE_ITER_CACHED,
184 };
185
186 #define BTREE_ITER_TYPE                 ((1 << 2) - 1)
187
188 /*
189  * Iterate over all possible positions, synthesizing deleted keys for holes:
190  */
191 #define BTREE_ITER_SLOTS                (1 << 2)
192 /*
193  * Indicates that intent locks should be taken on leaf nodes, because we expect
194  * to be doing updates:
195  */
196 #define BTREE_ITER_INTENT               (1 << 3)
197 /*
198  * Causes the btree iterator code to prefetch additional btree nodes from disk:
199  */
200 #define BTREE_ITER_PREFETCH             (1 << 4)
201 /*
202  * Indicates that this iterator should not be reused until transaction commit,
203  * either because a pending update references it or because the update depends
204  * on that particular key being locked (e.g. by the str_hash code, for hash
205  * table consistency)
206  */
207 #define BTREE_ITER_KEEP_UNTIL_COMMIT    (1 << 5)
208 /*
209  * Used in bch2_btree_iter_traverse(), to indicate whether we're searching for
210  * @pos or the first key strictly greater than @pos
211  */
212 #define BTREE_ITER_IS_EXTENTS           (1 << 6)
213 #define BTREE_ITER_ERROR                (1 << 7)
214 #define BTREE_ITER_SET_POS_AFTER_COMMIT (1 << 8)
215 #define BTREE_ITER_CACHED_NOFILL        (1 << 9)
216 #define BTREE_ITER_CACHED_NOCREATE      (1 << 10)
217
218 #define BTREE_ITER_USER_FLAGS                           \
219         (BTREE_ITER_SLOTS                               \
220         |BTREE_ITER_INTENT                              \
221         |BTREE_ITER_PREFETCH                            \
222         |BTREE_ITER_CACHED_NOFILL                       \
223         |BTREE_ITER_CACHED_NOCREATE)
224
225 enum btree_iter_uptodate {
226         BTREE_ITER_UPTODATE             = 0,
227         BTREE_ITER_NEED_PEEK            = 1,
228         BTREE_ITER_NEED_RELOCK          = 2,
229         BTREE_ITER_NEED_TRAVERSE        = 3,
230 };
231
232 #define BTREE_ITER_NO_NODE_GET_LOCKS    ((struct btree *) 1)
233 #define BTREE_ITER_NO_NODE_DROP         ((struct btree *) 2)
234 #define BTREE_ITER_NO_NODE_LOCK_ROOT    ((struct btree *) 3)
235 #define BTREE_ITER_NO_NODE_UP           ((struct btree *) 4)
236 #define BTREE_ITER_NO_NODE_DOWN         ((struct btree *) 5)
237 #define BTREE_ITER_NO_NODE_INIT         ((struct btree *) 6)
238 #define BTREE_ITER_NO_NODE_ERROR        ((struct btree *) 7)
239
240 /*
241  * @pos                 - iterator's current position
242  * @level               - current btree depth
243  * @locks_want          - btree level below which we start taking intent locks
244  * @nodes_locked        - bitmask indicating which nodes in @nodes are locked
245  * @nodes_intent_locked - bitmask indicating which locks are intent locks
246  */
247 struct btree_iter {
248         struct btree_trans      *trans;
249         struct bpos             pos;
250         /* what we're searching for/what the iterator actually points to: */
251         struct bpos             real_pos;
252         struct bpos             pos_after_commit;
253
254         u16                     flags;
255         u8                      idx;
256
257         enum btree_id           btree_id:4;
258         enum btree_iter_uptodate uptodate:4;
259         unsigned                level:4,
260                                 min_depth:4,
261                                 locks_want:4,
262                                 nodes_locked:4,
263                                 nodes_intent_locked:4;
264
265         struct btree_iter_level {
266                 struct btree    *b;
267                 struct btree_node_iter iter;
268                 u32             lock_seq;
269         }                       l[BTREE_MAX_DEPTH];
270
271         /*
272          * Current unpacked key - so that bch2_btree_iter_next()/
273          * bch2_btree_iter_next_slot() can correctly advance pos.
274          */
275         struct bkey             k;
276         unsigned long           ip_allocated;
277 };
278
279 static inline enum btree_iter_type
280 btree_iter_type(const struct btree_iter *iter)
281 {
282         return iter->flags & BTREE_ITER_TYPE;
283 }
284
285 static inline bool btree_iter_is_cached(const struct btree_iter *iter)
286 {
287         return btree_iter_type(iter) == BTREE_ITER_CACHED;
288 }
289
290 static inline struct btree_iter_level *iter_l(struct btree_iter *iter)
291 {
292         return iter->l + iter->level;
293 }
294
295 struct btree_key_cache {
296         struct mutex            lock;
297         struct rhashtable       table;
298         bool                    table_init_done;
299         struct list_head        freed;
300         struct list_head        clean;
301         struct list_head        dirty;
302         struct shrinker         shrink;
303
304         size_t                  nr_freed;
305         size_t                  nr_keys;
306         size_t                  nr_dirty;
307 };
308
309 struct bkey_cached_key {
310         u32                     btree_id;
311         struct bpos             pos;
312 } __attribute__((packed, aligned(4)));
313
314 #define BKEY_CACHED_ACCESSED            0
315 #define BKEY_CACHED_DIRTY               1
316
317 struct bkey_cached {
318         struct btree_bkey_cached_common c;
319
320         unsigned long           flags;
321         u8                      u64s;
322         bool                    valid;
323         u32                     btree_trans_barrier_seq;
324         struct bkey_cached_key  key;
325
326         struct rhash_head       hash;
327         struct list_head        list;
328
329         struct journal_preres   res;
330         struct journal_entry_pin journal;
331
332         struct bkey_i           *k;
333 };
334
335 struct btree_insert_entry {
336         unsigned                trigger_flags;
337         unsigned                trans_triggers_run:1;
338         struct bkey_i           *k;
339         struct btree_iter       *iter;
340 };
341
342 #ifndef CONFIG_LOCKDEP
343 #define BTREE_ITER_MAX          64
344 #else
345 #define BTREE_ITER_MAX          32
346 #endif
347
348 struct btree_trans {
349         struct bch_fs           *c;
350 #ifdef CONFIG_BCACHEFS_DEBUG
351         struct list_head        list;
352         struct btree            *locking;
353         unsigned                locking_iter_idx;
354         struct bpos             locking_pos;
355         u8                      locking_btree_id;
356         u8                      locking_level;
357         pid_t                   pid;
358 #endif
359         unsigned long           ip;
360         int                     srcu_idx;
361
362         u8                      nr_updates;
363         u8                      nr_updates2;
364         unsigned                used_mempool:1;
365         unsigned                error:1;
366         unsigned                nounlock:1;
367         unsigned                in_traverse_all:1;
368
369         u64                     iters_linked;
370         u64                     iters_live;
371         u64                     iters_touched;
372
373         unsigned                mem_top;
374         unsigned                mem_bytes;
375         void                    *mem;
376
377         struct btree_iter       *iters;
378         struct btree_insert_entry *updates;
379         struct btree_insert_entry *updates2;
380
381         /* update path: */
382         struct jset_entry       *extra_journal_entries;
383         unsigned                extra_journal_entry_u64s;
384         struct journal_entry_pin *journal_pin;
385
386         struct journal_res      journal_res;
387         struct journal_preres   journal_preres;
388         u64                     *journal_seq;
389         struct disk_reservation *disk_res;
390         unsigned                flags;
391         unsigned                journal_u64s;
392         unsigned                journal_preres_u64s;
393         struct replicas_delta_list *fs_usage_deltas;
394 };
395
396 #define BTREE_FLAG(flag)                                                \
397 static inline bool btree_node_ ## flag(struct btree *b)                 \
398 {       return test_bit(BTREE_NODE_ ## flag, &b->flags); }              \
399                                                                         \
400 static inline void set_btree_node_ ## flag(struct btree *b)             \
401 {       set_bit(BTREE_NODE_ ## flag, &b->flags); }                      \
402                                                                         \
403 static inline void clear_btree_node_ ## flag(struct btree *b)           \
404 {       clear_bit(BTREE_NODE_ ## flag, &b->flags); }
405
406 enum btree_flags {
407         BTREE_NODE_read_in_flight,
408         BTREE_NODE_read_error,
409         BTREE_NODE_dirty,
410         BTREE_NODE_need_write,
411         BTREE_NODE_noevict,
412         BTREE_NODE_write_idx,
413         BTREE_NODE_accessed,
414         BTREE_NODE_write_in_flight,
415         BTREE_NODE_just_written,
416         BTREE_NODE_dying,
417         BTREE_NODE_fake,
418         BTREE_NODE_need_rewrite,
419         BTREE_NODE_never_write,
420 };
421
422 BTREE_FLAG(read_in_flight);
423 BTREE_FLAG(read_error);
424 BTREE_FLAG(need_write);
425 BTREE_FLAG(noevict);
426 BTREE_FLAG(write_idx);
427 BTREE_FLAG(accessed);
428 BTREE_FLAG(write_in_flight);
429 BTREE_FLAG(just_written);
430 BTREE_FLAG(dying);
431 BTREE_FLAG(fake);
432 BTREE_FLAG(need_rewrite);
433 BTREE_FLAG(never_write);
434
435 static inline struct btree_write *btree_current_write(struct btree *b)
436 {
437         return b->writes + btree_node_write_idx(b);
438 }
439
440 static inline struct btree_write *btree_prev_write(struct btree *b)
441 {
442         return b->writes + (btree_node_write_idx(b) ^ 1);
443 }
444
445 static inline struct bset_tree *bset_tree_last(struct btree *b)
446 {
447         EBUG_ON(!b->nsets);
448         return b->set + b->nsets - 1;
449 }
450
451 static inline void *
452 __btree_node_offset_to_ptr(const struct btree *b, u16 offset)
453 {
454         return (void *) ((u64 *) b->data + 1 + offset);
455 }
456
457 static inline u16
458 __btree_node_ptr_to_offset(const struct btree *b, const void *p)
459 {
460         u16 ret = (u64 *) p - 1 - (u64 *) b->data;
461
462         EBUG_ON(__btree_node_offset_to_ptr(b, ret) != p);
463         return ret;
464 }
465
466 static inline struct bset *bset(const struct btree *b,
467                                 const struct bset_tree *t)
468 {
469         return __btree_node_offset_to_ptr(b, t->data_offset);
470 }
471
472 static inline void set_btree_bset_end(struct btree *b, struct bset_tree *t)
473 {
474         t->end_offset =
475                 __btree_node_ptr_to_offset(b, vstruct_last(bset(b, t)));
476 }
477
478 static inline void set_btree_bset(struct btree *b, struct bset_tree *t,
479                                   const struct bset *i)
480 {
481         t->data_offset = __btree_node_ptr_to_offset(b, i);
482         set_btree_bset_end(b, t);
483 }
484
485 static inline struct bset *btree_bset_first(struct btree *b)
486 {
487         return bset(b, b->set);
488 }
489
490 static inline struct bset *btree_bset_last(struct btree *b)
491 {
492         return bset(b, bset_tree_last(b));
493 }
494
495 static inline u16
496 __btree_node_key_to_offset(const struct btree *b, const struct bkey_packed *k)
497 {
498         return __btree_node_ptr_to_offset(b, k);
499 }
500
501 static inline struct bkey_packed *
502 __btree_node_offset_to_key(const struct btree *b, u16 k)
503 {
504         return __btree_node_offset_to_ptr(b, k);
505 }
506
507 static inline unsigned btree_bkey_first_offset(const struct bset_tree *t)
508 {
509         return t->data_offset + offsetof(struct bset, _data) / sizeof(u64);
510 }
511
512 #define btree_bkey_first(_b, _t)                                        \
513 ({                                                                      \
514         EBUG_ON(bset(_b, _t)->start !=                                  \
515                 __btree_node_offset_to_key(_b, btree_bkey_first_offset(_t)));\
516                                                                         \
517         bset(_b, _t)->start;                                            \
518 })
519
520 #define btree_bkey_last(_b, _t)                                         \
521 ({                                                                      \
522         EBUG_ON(__btree_node_offset_to_key(_b, (_t)->end_offset) !=     \
523                 vstruct_last(bset(_b, _t)));                            \
524                                                                         \
525         __btree_node_offset_to_key(_b, (_t)->end_offset);               \
526 })
527
528 static inline unsigned bset_u64s(struct bset_tree *t)
529 {
530         return t->end_offset - t->data_offset -
531                 sizeof(struct bset) / sizeof(u64);
532 }
533
534 static inline unsigned bset_dead_u64s(struct btree *b, struct bset_tree *t)
535 {
536         return bset_u64s(t) - b->nr.bset_u64s[t - b->set];
537 }
538
539 static inline unsigned bset_byte_offset(struct btree *b, void *i)
540 {
541         return i - (void *) b->data;
542 }
543
544 enum btree_node_type {
545 #define x(kwd, val) BKEY_TYPE_##kwd = val,
546         BCH_BTREE_IDS()
547 #undef x
548         BKEY_TYPE_btree,
549 };
550
551 /* Type of a key in btree @id at level @level: */
552 static inline enum btree_node_type __btree_node_type(unsigned level, enum btree_id id)
553 {
554         return level ? BKEY_TYPE_btree : (enum btree_node_type) id;
555 }
556
557 /* Type of keys @b contains: */
558 static inline enum btree_node_type btree_node_type(struct btree *b)
559 {
560         return __btree_node_type(b->c.level, b->c.btree_id);
561 }
562
563 static inline bool btree_node_type_is_extents(enum btree_node_type type)
564 {
565         switch (type) {
566         case BKEY_TYPE_extents:
567         case BKEY_TYPE_reflink:
568                 return true;
569         default:
570                 return false;
571         }
572 }
573
574 static inline bool btree_node_is_extents(struct btree *b)
575 {
576         return btree_node_type_is_extents(btree_node_type(b));
577 }
578
579 static inline enum btree_node_type btree_iter_key_type(struct btree_iter *iter)
580 {
581         return __btree_node_type(iter->level, iter->btree_id);
582 }
583
584 static inline bool btree_iter_is_extents(struct btree_iter *iter)
585 {
586         return btree_node_type_is_extents(btree_iter_key_type(iter));
587 }
588
589 #define BTREE_NODE_TYPE_HAS_TRIGGERS                    \
590         ((1U << BKEY_TYPE_extents)|                     \
591          (1U << BKEY_TYPE_alloc)|                       \
592          (1U << BKEY_TYPE_inodes)|                      \
593          (1U << BKEY_TYPE_reflink)|                     \
594          (1U << BKEY_TYPE_stripes)|                     \
595          (1U << BKEY_TYPE_btree))
596
597 #define BTREE_NODE_TYPE_HAS_TRANS_TRIGGERS              \
598         ((1U << BKEY_TYPE_extents)|                     \
599          (1U << BKEY_TYPE_inodes)|                      \
600          (1U << BKEY_TYPE_stripes)|                     \
601          (1U << BKEY_TYPE_reflink))
602
603 enum btree_trigger_flags {
604         __BTREE_TRIGGER_NORUN,          /* Don't run triggers at all */
605
606         __BTREE_TRIGGER_INSERT,
607         __BTREE_TRIGGER_OVERWRITE,
608         __BTREE_TRIGGER_OVERWRITE_SPLIT,
609
610         __BTREE_TRIGGER_GC,
611         __BTREE_TRIGGER_BUCKET_INVALIDATE,
612         __BTREE_TRIGGER_NOATOMIC,
613 };
614
615 #define BTREE_TRIGGER_NORUN             (1U << __BTREE_TRIGGER_NORUN)
616
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)
620
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)
624
625 static inline bool btree_node_type_needs_gc(enum btree_node_type type)
626 {
627         return BTREE_NODE_TYPE_HAS_TRIGGERS & (1U << type);
628 }
629
630 struct btree_root {
631         struct btree            *b;
632
633         /* On disk root - see async splits: */
634         __BKEY_PADDED(key, BKEY_BTREE_PTR_VAL_U64s_MAX);
635         u8                      level;
636         u8                      alive;
637         s8                      error;
638 };
639
640 /*
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:
643  */
644
645 enum btree_insert_ret {
646         BTREE_INSERT_OK,
647         /* leaf node needs to be split */
648         BTREE_INSERT_BTREE_NODE_FULL,
649         BTREE_INSERT_ENOSPC,
650         BTREE_INSERT_NEED_MARK_REPLICAS,
651         BTREE_INSERT_NEED_JOURNAL_RES,
652         BTREE_INSERT_NEED_JOURNAL_RECLAIM,
653 };
654
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,
659 };
660
661 enum btree_node_sibling {
662         btree_prev_sib,
663         btree_next_sib,
664 };
665
666 typedef struct btree_nr_keys (*sort_fix_overlapping_fn)(struct bset *,
667                                                         struct btree *,
668                                                         struct btree_node_iter *);
669
670 #endif /* _BCACHEFS_BTREE_TYPES_H */