git.sesse.net Git - bcachefs-tools-debian/blob - 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         bool                    cached;
  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         u16                     version_ondisk;
  80
  81         struct bkey_format      format;
  82
  83         struct btree_node       *data;
  84         void                    *aux_data;
  85
  86         /*
  87          * Sets of sorted keys - the real btree node - plus a binary search tree
  88          *
  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.
  92          */
  93         struct bset_tree        set[MAX_BSETS];
  94
  95         struct btree_nr_keys    nr;
  96         u16                     sib_u64s[2];
  97         u16                     whiteout_u64s;
  98         u8                      byte_order;
  99         u8                      unpack_fn_len;
 100
 101         struct btree_write      writes[2];
 102
 103         /* Key/pointer for this btree node */
 104         __BKEY_PADDED(key, BKEY_BTREE_PTR_VAL_U64s_MAX);
 105
 106         /*
 107          * XXX: add a delete sequence number, so when bch2_btree_node_relock()
 108          * fails because the lock sequence number has changed - i.e. the
 109          * contents were modified - we can still relock the node if it's still
 110          * the one we want, without redoing the traversal
 111          */
 112
 113         /*
 114          * For asynchronous splits/interior node updates:
 115          * When we do a split, we allocate new child nodes and update the parent
 116          * node to point to them: we update the parent in memory immediately,
 117          * but then we must wait until the children have been written out before
 118          * the update to the parent can be written - this is a list of the
 119          * btree_updates that are blocking this node from being
 120          * written:
 121          */
 122         struct list_head        write_blocked;
 123
 124         /*
 125          * Also for asynchronous splits/interior node updates:
 126          * If a btree node isn't reachable yet, we don't want to kick off
 127          * another write - because that write also won't yet be reachable and
 128          * marking it as completed before it's reachable would be incorrect:
 129          */
 130         unsigned long           will_make_reachable;
 131
 132         struct open_buckets     ob;
 133
 134         /* lru list */
 135         struct list_head        list;
 136 };
 137
 138 struct btree_cache {
 139         struct rhashtable       table;
 140         bool                    table_init_done;
 141         /*
 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.
 148          *
 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.
 153          */
 154         struct mutex            lock;
 155         struct list_head        live;
 156         struct list_head        freeable;
 157         struct list_head        freed_pcpu;
 158         struct list_head        freed_nonpcpu;
 159
 160         /* Number of elements in live + freeable lists */
 161         unsigned                used;
 162         unsigned                reserve;
 163         unsigned                freed;
 164         unsigned                not_freed_lock_intent;
 165         unsigned                not_freed_lock_write;
 166         unsigned                not_freed_dirty;
 167         unsigned                not_freed_read_in_flight;
 168         unsigned                not_freed_write_in_flight;
 169         unsigned                not_freed_noevict;
 170         unsigned                not_freed_write_blocked;
 171         unsigned                not_freed_will_make_reachable;
 172         unsigned                not_freed_access_bit;
 173         atomic_t                dirty;
 174         struct shrinker         shrink;
 175
 176         /*
 177          * If we need to allocate memory for a new btree node and that
 178          * allocation fails, we can cannibalize another node in the btree cache
 179          * to satisfy the allocation - lock to guarantee only one thread does
 180          * this at a time:
 181          */
 182         struct task_struct      *alloc_lock;
 183         struct closure_waitlist alloc_wait;
 184 };
 185
 186 struct btree_node_iter {
 187         struct btree_node_iter_set {
 188                 u16     k, end;
 189         } data[MAX_BSETS];
 190 };
 191
 192 /*
 193  * Iterate over all possible positions, synthesizing deleted keys for holes:
 194  */
 195 #define BTREE_ITER_SLOTS                (1 << 0)
 196 #define BTREE_ITER_ALL_LEVELS           (1 << 1)
 197 /*
 198  * Indicates that intent locks should be taken on leaf nodes, because we expect
 199  * to be doing updates:
 200  */
 201 #define BTREE_ITER_INTENT               (1 << 2)
 202 /*
 203  * Causes the btree iterator code to prefetch additional btree nodes from disk:
 204  */
 205 #define BTREE_ITER_PREFETCH             (1 << 3)
 206 /*
 207  * Used in bch2_btree_iter_traverse(), to indicate whether we're searching for
 208  * @pos or the first key strictly greater than @pos
 209  */
 210 #define BTREE_ITER_IS_EXTENTS           (1 << 4)
 211 #define BTREE_ITER_NOT_EXTENTS          (1 << 5)
 212 #define BTREE_ITER_CACHED               (1 << 6)
 213 #define BTREE_ITER_WITH_KEY_CACHE       (1 << 7)
 214 #define BTREE_ITER_WITH_UPDATES         (1 << 8)
 215 #define BTREE_ITER_WITH_JOURNAL         (1 << 9)
 216 #define __BTREE_ITER_ALL_SNAPSHOTS      (1 << 10)
 217 #define BTREE_ITER_ALL_SNAPSHOTS        (1 << 11)
 218 #define BTREE_ITER_FILTER_SNAPSHOTS     (1 << 12)
 219 #define BTREE_ITER_NOPRESERVE           (1 << 13)
 220
 221 enum btree_path_uptodate {
 222         BTREE_ITER_UPTODATE             = 0,
 223         BTREE_ITER_NEED_RELOCK          = 1,
 224         BTREE_ITER_NEED_TRAVERSE        = 2,
 225 };
 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         u8                      nodes_locked;
 248
 249         struct btree_path_level {
 250                 struct btree    *b;
 251                 struct btree_node_iter iter;
 252                 u32             lock_seq;
 253 #ifdef CONFIG_BCACHEFS_LOCK_TIME_STATS
 254                 u64             lock_taken_time;
 255 #endif
 256         }                       l[BTREE_MAX_DEPTH];
 257 #ifdef CONFIG_BCACHEFS_DEBUG
 258         unsigned long           ip_allocated;
 259 #endif
 260 };
 261
 262 static inline struct btree_path_level *path_l(struct btree_path *path)
 263 {
 264         return path->l + path->level;
 265 }
 266
 267 /*
 268  * @pos                 - iterator's current position
 269  * @level               - current btree depth
 270  * @locks_want          - btree level below which we start taking intent locks
 271  * @nodes_locked        - bitmask indicating which nodes in @nodes are locked
 272  * @nodes_intent_locked - bitmask indicating which locks are intent locks
 273  */
 274 struct btree_iter {
 275         struct btree_trans      *trans;
 276         struct btree_path       *path;
 277         struct btree_path       *update_path;
 278         struct btree_path       *key_cache_path;
 279
 280         enum btree_id           btree_id:4;
 281         unsigned                min_depth:3;
 282         unsigned                advanced:1;
 283
 284         /* btree_iter_copy starts here: */
 285         u16                     flags;
 286
 287         /* When we're filtering by snapshot, the snapshot ID we're looking for: */
 288         unsigned                snapshot;
 289
 290         struct bpos             pos;
 291         struct bpos             pos_after_commit;
 292         /*
 293          * Current unpacked key - so that bch2_btree_iter_next()/
 294          * bch2_btree_iter_next_slot() can correctly advance pos.
 295          */
 296         struct bkey             k;
 297
 298         /* BTREE_ITER_WITH_JOURNAL: */
 299         size_t                  journal_idx;
 300         struct bpos             journal_pos;
 301 #ifdef CONFIG_BCACHEFS_DEBUG
 302         unsigned long           ip_allocated;
 303 #endif
 304 };
 305
 306 struct btree_key_cache_freelist {
 307         struct bkey_cached      *objs[16];
 308         unsigned                nr;
 309 };
 310
 311 struct btree_key_cache {
 312         struct mutex            lock;
 313         struct rhashtable       table;
 314         bool                    table_init_done;
 315         struct list_head        freed_pcpu;
 316         struct list_head        freed_nonpcpu;
 317         struct shrinker         shrink;
 318         unsigned                shrink_iter;
 319         struct btree_key_cache_freelist __percpu *pcpu_freed;
 320
 321         atomic_long_t           nr_freed;
 322         atomic_long_t           nr_keys;
 323         atomic_long_t           nr_dirty;
 324 };
 325
 326 struct bkey_cached_key {
 327         u32                     btree_id;
 328         struct bpos             pos;
 329 } __packed __aligned(4);
 330
 331 #define BKEY_CACHED_ACCESSED            0
 332 #define BKEY_CACHED_DIRTY               1
 333
 334 struct bkey_cached {
 335         struct btree_bkey_cached_common c;
 336
 337         unsigned long           flags;
 338         u16                     u64s;
 339         bool                    valid;
 340         u32                     btree_trans_barrier_seq;
 341         struct bkey_cached_key  key;
 342
 343         struct rhash_head       hash;
 344         struct list_head        list;
 345
 346         struct journal_preres   res;
 347         struct journal_entry_pin journal;
 348
 349         struct bkey_i           *k;
 350 };
 351
 352 static inline struct bpos btree_node_pos(struct btree_bkey_cached_common *b)
 353 {
 354         return !b->cached
 355                 ? container_of(b, struct btree, c)->key.k.p
 356                 : container_of(b, struct bkey_cached, c)->key.pos;
 357 }
 358
 359 struct btree_insert_entry {
 360         unsigned                flags;
 361         u8                      bkey_type;
 362         enum btree_id           btree_id:8;
 363         u8                      level:4;
 364         bool                    cached:1;
 365         bool                    insert_trigger_run:1;
 366         bool                    overwrite_trigger_run:1;
 367         bool                    key_cache_already_flushed:1;
 368         /*
 369          * @old_k may be a key from the journal; @old_btree_u64s always refers
 370          * to the size of the key being overwritten in the btree:
 371          */
 372         u8                      old_btree_u64s;
 373         struct bkey_i           *k;
 374         struct btree_path       *path;
 375         /* key being overwritten: */
 376         struct bkey             old_k;
 377         const struct bch_val    *old_v;
 378         unsigned long           ip_allocated;
 379 };
 380
 381 #ifndef CONFIG_LOCKDEP
 382 #define BTREE_ITER_MAX          64
 383 #else
 384 #define BTREE_ITER_MAX          32
 385 #endif
 386
 387 struct btree_trans_commit_hook;
 388 typedef int (btree_trans_commit_hook_fn)(struct btree_trans *, struct btree_trans_commit_hook *);
 389
 390 struct btree_trans_commit_hook {
 391         btree_trans_commit_hook_fn      *fn;
 392         struct btree_trans_commit_hook  *next;
 393 };
 394
 395 #define BTREE_TRANS_MEM_MAX     (1U << 16)
 396
 397 #define BTREE_TRANS_MAX_LOCK_HOLD_TIME_NS       10000
 398
 399 struct btree_trans {
 400         struct bch_fs           *c;
 401         const char              *fn;
 402         struct closure          ref;
 403         struct list_head        list;
 404         u64                     last_begin_time;
 405
 406         u8                      lock_may_not_fail;
 407         u8                      lock_must_abort;
 408         struct btree_bkey_cached_common *locking;
 409         struct six_lock_waiter  locking_wait;
 410
 411         int                     srcu_idx;
 412
 413         u8                      fn_idx;
 414         u8                      nr_sorted;
 415         u8                      nr_updates;
 416         u8                      traverse_all_idx;
 417         bool                    used_mempool:1;
 418         bool                    in_traverse_all:1;
 419         bool                    memory_allocation_failure:1;
 420         bool                    is_initial_gc:1;
 421         bool                    journal_replay_not_finished:1;
 422         enum bch_errcode        restarted:16;
 423         u32                     restart_count;
 424         unsigned long           last_restarted_ip;
 425
 426         /*
 427          * For when bch2_trans_update notices we'll be splitting a compressed
 428          * extent:
 429          */
 430         unsigned                extra_journal_res;
 431         unsigned                nr_max_paths;
 432
 433         u64                     paths_allocated;
 434
 435         unsigned                mem_top;
 436         unsigned                mem_max;
 437         unsigned                mem_bytes;
 438         void                    *mem;
 439
 440         u8                      sorted[BTREE_ITER_MAX];
 441         struct btree_path       *paths;
 442         struct btree_insert_entry *updates;
 443
 444         /* update path: */
 445         struct btree_trans_commit_hook *hooks;
 446         DARRAY(u64)             extra_journal_entries;
 447         struct journal_entry_pin *journal_pin;
 448
 449         struct journal_res      journal_res;
 450         struct journal_preres   journal_preres;
 451         u64                     *journal_seq;
 452         struct disk_reservation *disk_res;
 453         unsigned                flags;
 454         unsigned                journal_u64s;
 455         unsigned                journal_preres_u64s;
 456         struct replicas_delta_list *fs_usage_deltas;
 457 };
 458
 459 #define BCH_BTREE_WRITE_TYPES()                                         \
 460         x(initial,              0)                                      \
 461         x(init_next_bset,       1)                                      \
 462         x(cache_reclaim,        2)                                      \
 463         x(journal_reclaim,      3)                                      \
 464         x(interior,             4)
 465
 466 enum btree_write_type {
 467 #define x(t, n) BTREE_WRITE_##t,
 468         BCH_BTREE_WRITE_TYPES()
 469 #undef x
 470         BTREE_WRITE_TYPE_NR,
 471 };
 472
 473 #define BTREE_WRITE_TYPE_MASK   (roundup_pow_of_two(BTREE_WRITE_TYPE_NR) - 1)
 474 #define BTREE_WRITE_TYPE_BITS   ilog2(roundup_pow_of_two(BTREE_WRITE_TYPE_NR))
 475
 476 #define BTREE_FLAGS()                                                   \
 477         x(read_in_flight)                                               \
 478         x(read_error)                                                   \
 479         x(dirty)                                                        \
 480         x(need_write)                                                   \
 481         x(write_blocked)                                                \
 482         x(will_make_reachable)                                          \
 483         x(noevict)                                                      \
 484         x(write_idx)                                                    \
 485         x(accessed)                                                     \
 486         x(write_in_flight)                                              \
 487         x(write_in_flight_inner)                                        \
 488         x(just_written)                                                 \
 489         x(dying)                                                        \
 490         x(fake)                                                         \
 491         x(need_rewrite)                                                 \
 492         x(never_write)
 493
 494 enum btree_flags {
 495         /* First bits for btree node write type */
 496         BTREE_NODE_FLAGS_START = BTREE_WRITE_TYPE_BITS - 1,
 497 #define x(flag) BTREE_NODE_##flag,
 498         BTREE_FLAGS()
 499 #undef x
 500 };
 501
 502 #define x(flag)                                                         \
 503 static inline bool btree_node_ ## flag(struct btree *b)                 \
 504 {       return test_bit(BTREE_NODE_ ## flag, &b->flags); }              \
 505                                                                         \
 506 static inline void set_btree_node_ ## flag(struct btree *b)             \
 507 {       set_bit(BTREE_NODE_ ## flag, &b->flags); }                      \
 508                                                                         \
 509 static inline void clear_btree_node_ ## flag(struct btree *b)           \
 510 {       clear_bit(BTREE_NODE_ ## flag, &b->flags); }
 511
 512 BTREE_FLAGS()
 513 #undef x
 514
 515 static inline struct btree_write *btree_current_write(struct btree *b)
 516 {
 517         return b->writes + btree_node_write_idx(b);
 518 }
 519
 520 static inline struct btree_write *btree_prev_write(struct btree *b)
 521 {
 522         return b->writes + (btree_node_write_idx(b) ^ 1);
 523 }
 524
 525 static inline struct bset_tree *bset_tree_last(struct btree *b)
 526 {
 527         EBUG_ON(!b->nsets);
 528         return b->set + b->nsets - 1;
 529 }
 530
 531 static inline void *
 532 __btree_node_offset_to_ptr(const struct btree *b, u16 offset)
 533 {
 534         return (void *) ((u64 *) b->data + 1 + offset);
 535 }
 536
 537 static inline u16
 538 __btree_node_ptr_to_offset(const struct btree *b, const void *p)
 539 {
 540         u16 ret = (u64 *) p - 1 - (u64 *) b->data;
 541
 542         EBUG_ON(__btree_node_offset_to_ptr(b, ret) != p);
 543         return ret;
 544 }
 545
 546 static inline struct bset *bset(const struct btree *b,
 547                                 const struct bset_tree *t)
 548 {
 549         return __btree_node_offset_to_ptr(b, t->data_offset);
 550 }
 551
 552 static inline void set_btree_bset_end(struct btree *b, struct bset_tree *t)
 553 {
 554         t->end_offset =
 555                 __btree_node_ptr_to_offset(b, vstruct_last(bset(b, t)));
 556 }
 557
 558 static inline void set_btree_bset(struct btree *b, struct bset_tree *t,
 559                                   const struct bset *i)
 560 {
 561         t->data_offset = __btree_node_ptr_to_offset(b, i);
 562         set_btree_bset_end(b, t);
 563 }
 564
 565 static inline struct bset *btree_bset_first(struct btree *b)
 566 {
 567         return bset(b, b->set);
 568 }
 569
 570 static inline struct bset *btree_bset_last(struct btree *b)
 571 {
 572         return bset(b, bset_tree_last(b));
 573 }
 574
 575 static inline u16
 576 __btree_node_key_to_offset(const struct btree *b, const struct bkey_packed *k)
 577 {
 578         return __btree_node_ptr_to_offset(b, k);
 579 }
 580
 581 static inline struct bkey_packed *
 582 __btree_node_offset_to_key(const struct btree *b, u16 k)
 583 {
 584         return __btree_node_offset_to_ptr(b, k);
 585 }
 586
 587 static inline unsigned btree_bkey_first_offset(const struct bset_tree *t)
 588 {
 589         return t->data_offset + offsetof(struct bset, _data) / sizeof(u64);
 590 }
 591
 592 #define btree_bkey_first(_b, _t)                                        \
 593 ({                                                                      \
 594         EBUG_ON(bset(_b, _t)->start !=                                  \
 595                 __btree_node_offset_to_key(_b, btree_bkey_first_offset(_t)));\
 596                                                                         \
 597         bset(_b, _t)->start;                                            \
 598 })
 599
 600 #define btree_bkey_last(_b, _t)                                         \
 601 ({                                                                      \
 602         EBUG_ON(__btree_node_offset_to_key(_b, (_t)->end_offset) !=     \
 603                 vstruct_last(bset(_b, _t)));                            \
 604                                                                         \
 605         __btree_node_offset_to_key(_b, (_t)->end_offset);               \
 606 })
 607
 608 static inline unsigned bset_u64s(struct bset_tree *t)
 609 {
 610         return t->end_offset - t->data_offset -
 611                 sizeof(struct bset) / sizeof(u64);
 612 }
 613
 614 static inline unsigned bset_dead_u64s(struct btree *b, struct bset_tree *t)
 615 {
 616         return bset_u64s(t) - b->nr.bset_u64s[t - b->set];
 617 }
 618
 619 static inline unsigned bset_byte_offset(struct btree *b, void *i)
 620 {
 621         return i - (void *) b->data;
 622 }
 623
 624 enum btree_node_type {
 625 #define x(kwd, val) BKEY_TYPE_##kwd = val,
 626         BCH_BTREE_IDS()
 627 #undef x
 628         BKEY_TYPE_btree,
 629 };
 630
 631 /* Type of a key in btree @id at level @level: */
 632 static inline enum btree_node_type __btree_node_type(unsigned level, enum btree_id id)
 633 {
 634         return level ? BKEY_TYPE_btree : (enum btree_node_type) id;
 635 }
 636
 637 /* Type of keys @b contains: */
 638 static inline enum btree_node_type btree_node_type(struct btree *b)
 639 {
 640         return __btree_node_type(b->c.level, b->c.btree_id);
 641 }
 642
 643 #define BTREE_NODE_TYPE_HAS_TRANS_TRIGGERS              \
 644         ((1U << BKEY_TYPE_extents)|                     \
 645          (1U << BKEY_TYPE_alloc)|                       \
 646          (1U << BKEY_TYPE_inodes)|                      \
 647          (1U << BKEY_TYPE_stripes)|                     \
 648          (1U << BKEY_TYPE_reflink)|                     \
 649          (1U << BKEY_TYPE_btree))
 650
 651 #define BTREE_NODE_TYPE_HAS_MEM_TRIGGERS                \
 652         ((1U << BKEY_TYPE_alloc)|                       \
 653          (1U << BKEY_TYPE_inodes)|                      \
 654          (1U << BKEY_TYPE_stripes)|                     \
 655          (1U << BKEY_TYPE_snapshots))
 656
 657 #define BTREE_NODE_TYPE_HAS_TRIGGERS                    \
 658         (BTREE_NODE_TYPE_HAS_TRANS_TRIGGERS|            \
 659          BTREE_NODE_TYPE_HAS_MEM_TRIGGERS)
 660
 661 #define BTREE_ID_IS_EXTENTS                             \
 662         ((1U << BTREE_ID_extents)|                      \
 663          (1U << BTREE_ID_reflink)|                      \
 664          (1U << BTREE_ID_freespace))
 665
 666 static inline bool btree_node_type_is_extents(enum btree_node_type type)
 667 {
 668         return (1U << type) & BTREE_ID_IS_EXTENTS;
 669 }
 670
 671 #define BTREE_ID_HAS_SNAPSHOTS                          \
 672         ((1U << BTREE_ID_extents)|                      \
 673          (1U << BTREE_ID_inodes)|                       \
 674          (1U << BTREE_ID_dirents)|                      \
 675          (1U << BTREE_ID_xattrs))
 676
 677 #define BTREE_ID_HAS_PTRS                               \
 678         ((1U << BTREE_ID_extents)|                      \
 679          (1U << BTREE_ID_reflink))
 680
 681 static inline bool btree_type_has_snapshots(enum btree_id id)
 682 {
 683         return (1 << id) & BTREE_ID_HAS_SNAPSHOTS;
 684 }
 685
 686 static inline bool btree_type_has_ptrs(enum btree_id id)
 687 {
 688         return (1 << id) & BTREE_ID_HAS_PTRS;
 689 }
 690
 691 static inline bool btree_node_type_needs_gc(enum btree_node_type type)
 692 {
 693         return BTREE_NODE_TYPE_HAS_TRIGGERS & (1U << type);
 694 }
 695
 696 struct btree_root {
 697         struct btree            *b;
 698
 699         /* On disk root - see async splits: */
 700         __BKEY_PADDED(key, BKEY_BTREE_PTR_VAL_U64s_MAX);
 701         u8                      level;
 702         u8                      alive;
 703         s8                      error;
 704 };
 705
 706 enum btree_insert_ret {
 707         BTREE_INSERT_OK,
 708         /* leaf node needs to be split */
 709         BTREE_INSERT_BTREE_NODE_FULL,
 710         BTREE_INSERT_NEED_MARK_REPLICAS,
 711         BTREE_INSERT_NEED_JOURNAL_RES,
 712         BTREE_INSERT_NEED_JOURNAL_RECLAIM,
 713 };
 714
 715 enum btree_gc_coalesce_fail_reason {
 716         BTREE_GC_COALESCE_FAIL_RESERVE_GET,
 717         BTREE_GC_COALESCE_FAIL_KEYLIST_REALLOC,
 718         BTREE_GC_COALESCE_FAIL_FORMAT_FITS,
 719 };
 720
 721 enum btree_node_sibling {
 722         btree_prev_sib,
 723         btree_next_sib,
 724 };
 725
 726 #endif /* _BCACHEFS_BTREE_TYPES_H */