]> git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/btree_types.h
5382f2b85e194aeab13e361f45061c4cc95e40da
[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 "darray.h"
12 #include "journal_types.h"
13
14 struct open_bucket;
15 struct btree_update;
16 struct btree_trans;
17
18 #define MAX_BSETS               3U
19
20 struct btree_nr_keys {
21
22         /*
23          * Amount of live metadata (i.e. size of node after a compaction) in
24          * units of u64s
25          */
26         u16                     live_u64s;
27         u16                     bset_u64s[MAX_BSETS];
28
29         /* live keys only: */
30         u16                     packed_keys;
31         u16                     unpacked_keys;
32 };
33
34 struct bset_tree {
35         /*
36          * We construct a binary tree in an array as if the array
37          * started at 1, so that things line up on the same cachelines
38          * better: see comments in bset.c at cacheline_to_bkey() for
39          * details
40          */
41
42         /* size of the binary tree and prev array */
43         u16                     size;
44
45         /* function of size - precalculated for to_inorder() */
46         u16                     extra;
47
48         u16                     data_offset;
49         u16                     aux_data_offset;
50         u16                     end_offset;
51 };
52
53 struct btree_write {
54         struct journal_entry_pin        journal;
55 };
56
57 struct btree_alloc {
58         struct open_buckets     ob;
59         __BKEY_PADDED(k, BKEY_BTREE_PTR_VAL_U64s_MAX);
60 };
61
62 struct btree_bkey_cached_common {
63         struct six_lock         lock;
64         u8                      level;
65         u8                      btree_id;
66 };
67
68 struct btree {
69         struct btree_bkey_cached_common c;
70
71         struct rhash_head       hash;
72         u64                     hash_val;
73
74         unsigned long           flags;
75         u16                     written;
76         u8                      nsets;
77         u8                      nr_key_bits;
78         u16                     version_ondisk;
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         struct btree_write      writes[2];
101
102         /* Key/pointer for this btree node */
103         __BKEY_PADDED(key, BKEY_BTREE_PTR_VAL_U64s_MAX);
104
105         /*
106          * XXX: add a delete sequence number, so when bch2_btree_node_relock()
107          * fails because the lock sequence number has changed - i.e. the
108          * contents were modified - we can still relock the node if it's still
109          * the one we want, without redoing the traversal
110          */
111
112         /*
113          * For asynchronous splits/interior node updates:
114          * When we do a split, we allocate new child nodes and update the parent
115          * node to point to them: we update the parent in memory immediately,
116          * but then we must wait until the children have been written out before
117          * the update to the parent can be written - this is a list of the
118          * btree_updates that are blocking this node from being
119          * written:
120          */
121         struct list_head        write_blocked;
122
123         /*
124          * Also for asynchronous splits/interior node updates:
125          * If a btree node isn't reachable yet, we don't want to kick off
126          * another write - because that write also won't yet be reachable and
127          * marking it as completed before it's reachable would be incorrect:
128          */
129         unsigned long           will_make_reachable;
130
131         struct open_buckets     ob;
132
133         /* lru list */
134         struct list_head        list;
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_pcpu;
157         struct list_head        freed_nonpcpu;
158
159         /* Number of elements in live + freeable lists */
160         unsigned                used;
161         unsigned                reserve;
162         atomic_t                dirty;
163         struct shrinker         shrink;
164
165         /*
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
169          * this at a time:
170          */
171         struct task_struct      *alloc_lock;
172         struct closure_waitlist alloc_wait;
173 };
174
175 struct btree_node_iter {
176         struct btree_node_iter_set {
177                 u16     k, end;
178         } data[MAX_BSETS];
179 };
180
181 /*
182  * Iterate over all possible positions, synthesizing deleted keys for holes:
183  */
184 #define BTREE_ITER_SLOTS                (1 << 0)
185 #define BTREE_ITER_ALL_LEVELS           (1 << 1)
186 /*
187  * Indicates that intent locks should be taken on leaf nodes, because we expect
188  * to be doing updates:
189  */
190 #define BTREE_ITER_INTENT               (1 << 2)
191 /*
192  * Causes the btree iterator code to prefetch additional btree nodes from disk:
193  */
194 #define BTREE_ITER_PREFETCH             (1 << 3)
195 /*
196  * Used in bch2_btree_iter_traverse(), to indicate whether we're searching for
197  * @pos or the first key strictly greater than @pos
198  */
199 #define BTREE_ITER_IS_EXTENTS           (1 << 4)
200 #define BTREE_ITER_NOT_EXTENTS          (1 << 5)
201 #define BTREE_ITER_CACHED               (1 << 6)
202 #define BTREE_ITER_CACHED_NOFILL        (1 << 7)
203 #define BTREE_ITER_CACHED_NOCREATE      (1 << 8)
204 #define BTREE_ITER_WITH_KEY_CACHE       (1 << 9)
205 #define BTREE_ITER_WITH_UPDATES         (1 << 10)
206 #define BTREE_ITER_WITH_JOURNAL         (1 << 11)
207 #define __BTREE_ITER_ALL_SNAPSHOTS      (1 << 12)
208 #define BTREE_ITER_ALL_SNAPSHOTS        (1 << 13)
209 #define BTREE_ITER_FILTER_SNAPSHOTS     (1 << 14)
210 #define BTREE_ITER_NOPRESERVE           (1 << 15)
211
212 enum btree_path_uptodate {
213         BTREE_ITER_UPTODATE             = 0,
214         BTREE_ITER_NEED_RELOCK          = 1,
215         BTREE_ITER_NEED_TRAVERSE        = 2,
216 };
217
218 #define BTREE_ITER_NO_NODE_GET_LOCKS    ((struct btree *) 1)
219 #define BTREE_ITER_NO_NODE_DROP         ((struct btree *) 2)
220 #define BTREE_ITER_NO_NODE_LOCK_ROOT    ((struct btree *) 3)
221 #define BTREE_ITER_NO_NODE_UP           ((struct btree *) 4)
222 #define BTREE_ITER_NO_NODE_DOWN         ((struct btree *) 5)
223 #define BTREE_ITER_NO_NODE_INIT         ((struct btree *) 6)
224 #define BTREE_ITER_NO_NODE_ERROR        ((struct btree *) 7)
225 #define BTREE_ITER_NO_NODE_CACHED       ((struct btree *) 8)
226
227 struct btree_path {
228         u8                      idx;
229         u8                      sorted_idx;
230         u8                      ref;
231         u8                      intent_ref;
232
233         /* btree_iter_copy starts here: */
234         struct bpos             pos;
235
236         enum btree_id           btree_id:4;
237         bool                    cached:1;
238         bool                    preserve:1;
239         enum btree_path_uptodate uptodate:2;
240         /*
241          * When true, failing to relock this path will cause the transaction to
242          * restart:
243          */
244         bool                    should_be_locked:1;
245         unsigned                level:3,
246                                 locks_want:4,
247                                 nodes_locked:4,
248                                 nodes_intent_locked:4;
249
250         struct btree_path_level {
251                 struct btree    *b;
252                 struct btree_node_iter iter;
253                 u32             lock_seq;
254         }                       l[BTREE_MAX_DEPTH];
255 #ifdef CONFIG_BCACHEFS_DEBUG
256         unsigned long           ip_allocated;
257 #endif
258 };
259
260 static inline struct btree_path_level *path_l(struct btree_path *path)
261 {
262         return path->l + path->level;
263 }
264
265 /*
266  * @pos                 - iterator's current position
267  * @level               - current btree depth
268  * @locks_want          - btree level below which we start taking intent locks
269  * @nodes_locked        - bitmask indicating which nodes in @nodes are locked
270  * @nodes_intent_locked - bitmask indicating which locks are intent locks
271  */
272 struct btree_iter {
273         struct btree_trans      *trans;
274         struct btree_path       *path;
275         struct btree_path       *update_path;
276         struct btree_path       *key_cache_path;
277
278         enum btree_id           btree_id:4;
279         unsigned                min_depth:3;
280         unsigned                advanced:1;
281
282         /* btree_iter_copy starts here: */
283         u16                     flags;
284
285         /* When we're filtering by snapshot, the snapshot ID we're looking for: */
286         unsigned                snapshot;
287
288         struct bpos             pos;
289         struct bpos             pos_after_commit;
290         /*
291          * Current unpacked key - so that bch2_btree_iter_next()/
292          * bch2_btree_iter_next_slot() can correctly advance pos.
293          */
294         struct bkey             k;
295
296         /* BTREE_ITER_WITH_JOURNAL: */
297         size_t                  journal_idx;
298         struct bpos             journal_pos;
299 #ifdef CONFIG_BCACHEFS_DEBUG
300         unsigned long           ip_allocated;
301 #endif
302 };
303
304 struct btree_key_cache {
305         struct mutex            lock;
306         struct rhashtable       table;
307         bool                    table_init_done;
308         struct list_head        freed;
309         struct shrinker         shrink;
310         unsigned                shrink_iter;
311
312         size_t                  nr_freed;
313         atomic_long_t           nr_keys;
314         atomic_long_t           nr_dirty;
315 };
316
317 struct bkey_cached_key {
318         u32                     btree_id;
319         struct bpos             pos;
320 } __attribute__((packed, aligned(4)));
321
322 #define BKEY_CACHED_ACCESSED            0
323 #define BKEY_CACHED_DIRTY               1
324
325 struct bkey_cached {
326         struct btree_bkey_cached_common c;
327
328         unsigned long           flags;
329         u16                     u64s;
330         bool                    valid;
331         u32                     btree_trans_barrier_seq;
332         struct bkey_cached_key  key;
333
334         struct rhash_head       hash;
335         struct list_head        list;
336
337         struct journal_preres   res;
338         struct journal_entry_pin journal;
339
340         struct bkey_i           *k;
341 };
342
343 struct btree_insert_entry {
344         unsigned                flags;
345         u8                      bkey_type;
346         enum btree_id           btree_id:8;
347         u8                      level:4;
348         bool                    cached:1;
349         bool                    insert_trigger_run:1;
350         bool                    overwrite_trigger_run:1;
351         bool                    key_cache_already_flushed:1;
352         /*
353          * @old_k may be a key from the journal; @old_btree_u64s always refers
354          * to the size of the key being overwritten in the btree:
355          */
356         u8                      old_btree_u64s;
357         struct bkey_i           *k;
358         struct btree_path       *path;
359         /* key being overwritten: */
360         struct bkey             old_k;
361         const struct bch_val    *old_v;
362         unsigned long           ip_allocated;
363 };
364
365 #ifndef CONFIG_LOCKDEP
366 #define BTREE_ITER_MAX          64
367 #else
368 #define BTREE_ITER_MAX          32
369 #endif
370
371 struct btree_trans_commit_hook;
372 typedef int (btree_trans_commit_hook_fn)(struct btree_trans *, struct btree_trans_commit_hook *);
373
374 struct btree_trans_commit_hook {
375         btree_trans_commit_hook_fn      *fn;
376         struct btree_trans_commit_hook  *next;
377 };
378
379 #define BTREE_TRANS_MEM_MAX     (1U << 16)
380
381 struct btree_trans {
382         struct bch_fs           *c;
383         const char              *fn;
384         struct list_head        list;
385         struct btree            *locking;
386         unsigned                locking_path_idx;
387         struct bpos             locking_pos;
388         u8                      locking_btree_id;
389         u8                      locking_level;
390         u8                      locking_lock_type;
391         pid_t                   pid;
392         int                     srcu_idx;
393
394         u8                      nr_sorted;
395         u8                      nr_updates;
396         u8                      traverse_all_idx;
397         bool                    used_mempool:1;
398         bool                    in_traverse_all:1;
399         bool                    restarted:1;
400         bool                    memory_allocation_failure:1;
401         bool                    is_initial_gc:1;
402         /*
403          * For when bch2_trans_update notices we'll be splitting a compressed
404          * extent:
405          */
406         unsigned                extra_journal_res;
407
408         u64                     paths_allocated;
409
410         unsigned                mem_top;
411         unsigned                mem_bytes;
412         void                    *mem;
413
414         u8                      sorted[BTREE_ITER_MAX];
415         struct btree_path       *paths;
416         struct btree_insert_entry *updates;
417
418         /* update path: */
419         struct btree_trans_commit_hook *hooks;
420         DARRAY(u64)             extra_journal_entries;
421         struct journal_entry_pin *journal_pin;
422
423         struct journal_res      journal_res;
424         struct journal_preres   journal_preres;
425         u64                     *journal_seq;
426         struct disk_reservation *disk_res;
427         unsigned                flags;
428         unsigned                journal_u64s;
429         unsigned                journal_preres_u64s;
430         struct replicas_delta_list *fs_usage_deltas;
431 };
432
433 #define BTREE_FLAGS()                                                   \
434         x(read_in_flight)                                               \
435         x(read_error)                                                   \
436         x(dirty)                                                        \
437         x(need_write)                                                   \
438         x(write_blocked)                                                \
439         x(will_make_reachable)                                          \
440         x(noevict)                                                      \
441         x(write_idx)                                                    \
442         x(accessed)                                                     \
443         x(write_in_flight)                                              \
444         x(write_in_flight_inner)                                        \
445         x(just_written)                                                 \
446         x(dying)                                                        \
447         x(fake)                                                         \
448         x(need_rewrite)                                                 \
449         x(never_write)
450
451 enum btree_flags {
452 #define x(flag) BTREE_NODE_##flag,
453         BTREE_FLAGS()
454 #undef x
455 };
456
457 #define x(flag)                                                         \
458 static inline bool btree_node_ ## flag(struct btree *b)                 \
459 {       return test_bit(BTREE_NODE_ ## flag, &b->flags); }              \
460                                                                         \
461 static inline void set_btree_node_ ## flag(struct btree *b)             \
462 {       set_bit(BTREE_NODE_ ## flag, &b->flags); }                      \
463                                                                         \
464 static inline void clear_btree_node_ ## flag(struct btree *b)           \
465 {       clear_bit(BTREE_NODE_ ## flag, &b->flags); }
466
467 BTREE_FLAGS()
468 #undef x
469
470 static inline struct btree_write *btree_current_write(struct btree *b)
471 {
472         return b->writes + btree_node_write_idx(b);
473 }
474
475 static inline struct btree_write *btree_prev_write(struct btree *b)
476 {
477         return b->writes + (btree_node_write_idx(b) ^ 1);
478 }
479
480 static inline struct bset_tree *bset_tree_last(struct btree *b)
481 {
482         EBUG_ON(!b->nsets);
483         return b->set + b->nsets - 1;
484 }
485
486 static inline void *
487 __btree_node_offset_to_ptr(const struct btree *b, u16 offset)
488 {
489         return (void *) ((u64 *) b->data + 1 + offset);
490 }
491
492 static inline u16
493 __btree_node_ptr_to_offset(const struct btree *b, const void *p)
494 {
495         u16 ret = (u64 *) p - 1 - (u64 *) b->data;
496
497         EBUG_ON(__btree_node_offset_to_ptr(b, ret) != p);
498         return ret;
499 }
500
501 static inline struct bset *bset(const struct btree *b,
502                                 const struct bset_tree *t)
503 {
504         return __btree_node_offset_to_ptr(b, t->data_offset);
505 }
506
507 static inline void set_btree_bset_end(struct btree *b, struct bset_tree *t)
508 {
509         t->end_offset =
510                 __btree_node_ptr_to_offset(b, vstruct_last(bset(b, t)));
511 }
512
513 static inline void set_btree_bset(struct btree *b, struct bset_tree *t,
514                                   const struct bset *i)
515 {
516         t->data_offset = __btree_node_ptr_to_offset(b, i);
517         set_btree_bset_end(b, t);
518 }
519
520 static inline struct bset *btree_bset_first(struct btree *b)
521 {
522         return bset(b, b->set);
523 }
524
525 static inline struct bset *btree_bset_last(struct btree *b)
526 {
527         return bset(b, bset_tree_last(b));
528 }
529
530 static inline u16
531 __btree_node_key_to_offset(const struct btree *b, const struct bkey_packed *k)
532 {
533         return __btree_node_ptr_to_offset(b, k);
534 }
535
536 static inline struct bkey_packed *
537 __btree_node_offset_to_key(const struct btree *b, u16 k)
538 {
539         return __btree_node_offset_to_ptr(b, k);
540 }
541
542 static inline unsigned btree_bkey_first_offset(const struct bset_tree *t)
543 {
544         return t->data_offset + offsetof(struct bset, _data) / sizeof(u64);
545 }
546
547 #define btree_bkey_first(_b, _t)                                        \
548 ({                                                                      \
549         EBUG_ON(bset(_b, _t)->start !=                                  \
550                 __btree_node_offset_to_key(_b, btree_bkey_first_offset(_t)));\
551                                                                         \
552         bset(_b, _t)->start;                                            \
553 })
554
555 #define btree_bkey_last(_b, _t)                                         \
556 ({                                                                      \
557         EBUG_ON(__btree_node_offset_to_key(_b, (_t)->end_offset) !=     \
558                 vstruct_last(bset(_b, _t)));                            \
559                                                                         \
560         __btree_node_offset_to_key(_b, (_t)->end_offset);               \
561 })
562
563 static inline unsigned bset_u64s(struct bset_tree *t)
564 {
565         return t->end_offset - t->data_offset -
566                 sizeof(struct bset) / sizeof(u64);
567 }
568
569 static inline unsigned bset_dead_u64s(struct btree *b, struct bset_tree *t)
570 {
571         return bset_u64s(t) - b->nr.bset_u64s[t - b->set];
572 }
573
574 static inline unsigned bset_byte_offset(struct btree *b, void *i)
575 {
576         return i - (void *) b->data;
577 }
578
579 enum btree_node_type {
580 #define x(kwd, val) BKEY_TYPE_##kwd = val,
581         BCH_BTREE_IDS()
582 #undef x
583         BKEY_TYPE_btree,
584 };
585
586 /* Type of a key in btree @id at level @level: */
587 static inline enum btree_node_type __btree_node_type(unsigned level, enum btree_id id)
588 {
589         return level ? BKEY_TYPE_btree : (enum btree_node_type) id;
590 }
591
592 /* Type of keys @b contains: */
593 static inline enum btree_node_type btree_node_type(struct btree *b)
594 {
595         return __btree_node_type(b->c.level, b->c.btree_id);
596 }
597
598 #define BTREE_NODE_TYPE_HAS_TRANS_TRIGGERS              \
599         ((1U << BKEY_TYPE_extents)|                     \
600          (1U << BKEY_TYPE_alloc)|                       \
601          (1U << BKEY_TYPE_inodes)|                      \
602          (1U << BKEY_TYPE_stripes)|                     \
603          (1U << BKEY_TYPE_reflink)|                     \
604          (1U << BKEY_TYPE_btree))
605
606 #define BTREE_NODE_TYPE_HAS_MEM_TRIGGERS                \
607         ((1U << BKEY_TYPE_alloc)|                       \
608          (1U << BKEY_TYPE_inodes)|                      \
609          (1U << BKEY_TYPE_stripes)|                     \
610          (1U << BKEY_TYPE_snapshots))
611
612 #define BTREE_NODE_TYPE_HAS_TRIGGERS                    \
613         (BTREE_NODE_TYPE_HAS_TRANS_TRIGGERS|            \
614          BTREE_NODE_TYPE_HAS_MEM_TRIGGERS)
615
616 #define BTREE_ID_IS_EXTENTS                             \
617         ((1U << BTREE_ID_extents)|                      \
618          (1U << BTREE_ID_reflink)|                      \
619          (1U << BTREE_ID_freespace))
620
621 static inline bool btree_node_type_is_extents(enum btree_node_type type)
622 {
623         return (1U << type) & BTREE_ID_IS_EXTENTS;
624 }
625
626 #define BTREE_ID_HAS_SNAPSHOTS                          \
627         ((1U << BTREE_ID_extents)|                      \
628          (1U << BTREE_ID_inodes)|                       \
629          (1U << BTREE_ID_dirents)|                      \
630          (1U << BTREE_ID_xattrs))
631
632 #define BTREE_ID_HAS_PTRS                               \
633         ((1U << BTREE_ID_extents)|                      \
634          (1U << BTREE_ID_reflink))
635
636 static inline bool btree_type_has_snapshots(enum btree_id id)
637 {
638         return (1 << id) & BTREE_ID_HAS_SNAPSHOTS;
639 }
640
641 static inline bool btree_type_has_ptrs(enum btree_id id)
642 {
643         return (1 << id) & BTREE_ID_HAS_PTRS;
644 }
645
646 static inline bool btree_node_type_needs_gc(enum btree_node_type type)
647 {
648         return BTREE_NODE_TYPE_HAS_TRIGGERS & (1U << type);
649 }
650
651 struct btree_root {
652         struct btree            *b;
653
654         /* On disk root - see async splits: */
655         __BKEY_PADDED(key, BKEY_BTREE_PTR_VAL_U64s_MAX);
656         u8                      level;
657         u8                      alive;
658         s8                      error;
659 };
660
661 enum btree_insert_ret {
662         BTREE_INSERT_OK,
663         /* leaf node needs to be split */
664         BTREE_INSERT_BTREE_NODE_FULL,
665         BTREE_INSERT_NEED_MARK_REPLICAS,
666         BTREE_INSERT_NEED_JOURNAL_RES,
667         BTREE_INSERT_NEED_JOURNAL_RECLAIM,
668 };
669
670 enum btree_gc_coalesce_fail_reason {
671         BTREE_GC_COALESCE_FAIL_RESERVE_GET,
672         BTREE_GC_COALESCE_FAIL_KEYLIST_REALLOC,
673         BTREE_GC_COALESCE_FAIL_FORMAT_FITS,
674 };
675
676 enum btree_node_sibling {
677         btree_prev_sib,
678         btree_next_sib,
679 };
680
681 #endif /* _BCACHEFS_BTREE_TYPES_H */