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:5;
 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:3;
 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:8;
 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         /*
 292          * Current unpacked key - so that bch2_btree_iter_next()/
 293          * bch2_btree_iter_next_slot() can correctly advance pos.
 294          */
 295         struct bkey             k;
 296
 297         /* BTREE_ITER_WITH_JOURNAL: */
 298         size_t                  journal_idx;
 299         struct bpos             journal_pos;
 300 #ifdef CONFIG_BCACHEFS_DEBUG
 301         unsigned long           ip_allocated;
 302 #endif
 303 };
 304
 305 struct btree_key_cache_freelist {
 306         struct bkey_cached      *objs[16];
 307         unsigned                nr;
 308 };
 309
 310 struct btree_key_cache {
 311         struct mutex            lock;
 312         struct rhashtable       table;
 313         bool                    table_init_done;
 314         struct list_head        freed_pcpu;
 315         struct list_head        freed_nonpcpu;
 316         struct shrinker         shrink;
 317         unsigned                shrink_iter;
 318         struct btree_key_cache_freelist __percpu *pcpu_freed;
 319
 320         atomic_long_t           nr_freed;
 321         atomic_long_t           nr_keys;
 322         atomic_long_t           nr_dirty;
 323 };
 324
 325 struct bkey_cached_key {
 326         u32                     btree_id;
 327         struct bpos             pos;
 328 } __packed __aligned(4);
 329
 330 #define BKEY_CACHED_ACCESSED            0
 331 #define BKEY_CACHED_DIRTY               1
 332
 333 struct bkey_cached {
 334         struct btree_bkey_cached_common c;
 335
 336         unsigned long           flags;
 337         u16                     u64s;
 338         bool                    valid;
 339         u32                     btree_trans_barrier_seq;
 340         struct bkey_cached_key  key;
 341
 342         struct rhash_head       hash;
 343         struct list_head        list;
 344
 345         struct journal_preres   res;
 346         struct journal_entry_pin journal;
 347
 348         struct bkey_i           *k;
 349 };
 350
 351 static inline struct bpos btree_node_pos(struct btree_bkey_cached_common *b)
 352 {
 353         return !b->cached
 354                 ? container_of(b, struct btree, c)->key.k.p
 355                 : container_of(b, struct bkey_cached, c)->key.pos;
 356 }
 357
 358 struct btree_insert_entry {
 359         unsigned                flags;
 360         u8                      bkey_type;
 361         enum btree_id           btree_id:8;
 362         u8                      level:4;
 363         bool                    cached:1;
 364         bool                    insert_trigger_run:1;
 365         bool                    overwrite_trigger_run:1;
 366         bool                    key_cache_already_flushed:1;
 367         /*
 368          * @old_k may be a key from the journal; @old_btree_u64s always refers
 369          * to the size of the key being overwritten in the btree:
 370          */
 371         u8                      old_btree_u64s;
 372         struct bkey_i           *k;
 373         struct btree_path       *path;
 374         /* key being overwritten: */
 375         struct bkey             old_k;
 376         const struct bch_val    *old_v;
 377         unsigned long           ip_allocated;
 378 };
 379
 380 #ifndef CONFIG_LOCKDEP
 381 #define BTREE_ITER_MAX          64
 382 #else
 383 #define BTREE_ITER_MAX          32
 384 #endif
 385
 386 struct btree_trans_commit_hook;
 387 typedef int (btree_trans_commit_hook_fn)(struct btree_trans *, struct btree_trans_commit_hook *);
 388
 389 struct btree_trans_commit_hook {
 390         btree_trans_commit_hook_fn      *fn;
 391         struct btree_trans_commit_hook  *next;
 392 };
 393
 394 #define BTREE_TRANS_MEM_MAX     (1U << 16)
 395
 396 #define BTREE_TRANS_MAX_LOCK_HOLD_TIME_NS       10000
 397
 398 struct btree_trans {
 399         struct bch_fs           *c;
 400         const char              *fn;
 401         struct closure          ref;
 402         struct list_head        list;
 403         u64                     last_begin_time;
 404
 405         u8                      lock_may_not_fail;
 406         u8                      lock_must_abort;
 407         struct btree_bkey_cached_common *locking;
 408         struct six_lock_waiter  locking_wait;
 409
 410         int                     srcu_idx;
 411
 412         u8                      fn_idx;
 413         u8                      nr_sorted;
 414         u8                      nr_updates;
 415         u8                      traverse_all_idx;
 416         bool                    used_mempool:1;
 417         bool                    in_traverse_all:1;
 418         bool                    memory_allocation_failure:1;
 419         bool                    is_initial_gc:1;
 420         bool                    journal_replay_not_finished:1;
 421         enum bch_errcode        restarted:16;
 422         u32                     restart_count;
 423         unsigned long           last_restarted_ip;
 424
 425         /*
 426          * For when bch2_trans_update notices we'll be splitting a compressed
 427          * extent:
 428          */
 429         unsigned                extra_journal_res;
 430         unsigned                nr_max_paths;
 431
 432         u64                     paths_allocated;
 433
 434         unsigned                mem_top;
 435         unsigned                mem_max;
 436         unsigned                mem_bytes;
 437         void                    *mem;
 438
 439         u8                      sorted[BTREE_ITER_MAX];
 440         struct btree_path       *paths;
 441         struct btree_insert_entry *updates;
 442
 443         /* update path: */
 444         struct btree_trans_commit_hook *hooks;
 445         DARRAY(u64)             extra_journal_entries;
 446         struct journal_entry_pin *journal_pin;
 447
 448         struct journal_res      journal_res;
 449         struct journal_preres   journal_preres;
 450         u64                     *journal_seq;
 451         struct disk_reservation *disk_res;
 452         unsigned                flags;
 453         unsigned                journal_u64s;
 454         unsigned                journal_preres_u64s;
 455         struct replicas_delta_list *fs_usage_deltas;
 456 };
 457
 458 #define BCH_BTREE_WRITE_TYPES()                                         \
 459         x(initial,              0)                                      \
 460         x(init_next_bset,       1)                                      \
 461         x(cache_reclaim,        2)                                      \
 462         x(journal_reclaim,      3)                                      \
 463         x(interior,             4)
 464
 465 enum btree_write_type {
 466 #define x(t, n) BTREE_WRITE_##t,
 467         BCH_BTREE_WRITE_TYPES()
 468 #undef x
 469         BTREE_WRITE_TYPE_NR,
 470 };
 471
 472 #define BTREE_WRITE_TYPE_MASK   (roundup_pow_of_two(BTREE_WRITE_TYPE_NR) - 1)
 473 #define BTREE_WRITE_TYPE_BITS   ilog2(roundup_pow_of_two(BTREE_WRITE_TYPE_NR))
 474
 475 #define BTREE_FLAGS()                                                   \
 476         x(read_in_flight)                                               \
 477         x(read_error)                                                   \
 478         x(dirty)                                                        \
 479         x(need_write)                                                   \
 480         x(write_blocked)                                                \
 481         x(will_make_reachable)                                          \
 482         x(noevict)                                                      \
 483         x(write_idx)                                                    \
 484         x(accessed)                                                     \
 485         x(write_in_flight)                                              \
 486         x(write_in_flight_inner)                                        \
 487         x(just_written)                                                 \
 488         x(dying)                                                        \
 489         x(fake)                                                         \
 490         x(need_rewrite)                                                 \
 491         x(never_write)
 492
 493 enum btree_flags {
 494         /* First bits for btree node write type */
 495         BTREE_NODE_FLAGS_START = BTREE_WRITE_TYPE_BITS - 1,
 496 #define x(flag) BTREE_NODE_##flag,
 497         BTREE_FLAGS()
 498 #undef x
 499 };
 500
 501 #define x(flag)                                                         \
 502 static inline bool btree_node_ ## flag(struct btree *b)                 \
 503 {       return test_bit(BTREE_NODE_ ## flag, &b->flags); }              \
 504                                                                         \
 505 static inline void set_btree_node_ ## flag(struct btree *b)             \
 506 {       set_bit(BTREE_NODE_ ## flag, &b->flags); }                      \
 507                                                                         \
 508 static inline void clear_btree_node_ ## flag(struct btree *b)           \
 509 {       clear_bit(BTREE_NODE_ ## flag, &b->flags); }
 510
 511 BTREE_FLAGS()
 512 #undef x
 513
 514 static inline struct btree_write *btree_current_write(struct btree *b)
 515 {
 516         return b->writes + btree_node_write_idx(b);
 517 }
 518
 519 static inline struct btree_write *btree_prev_write(struct btree *b)
 520 {
 521         return b->writes + (btree_node_write_idx(b) ^ 1);
 522 }
 523
 524 static inline struct bset_tree *bset_tree_last(struct btree *b)
 525 {
 526         EBUG_ON(!b->nsets);
 527         return b->set + b->nsets - 1;
 528 }
 529
 530 static inline void *
 531 __btree_node_offset_to_ptr(const struct btree *b, u16 offset)
 532 {
 533         return (void *) ((u64 *) b->data + 1 + offset);
 534 }
 535
 536 static inline u16
 537 __btree_node_ptr_to_offset(const struct btree *b, const void *p)
 538 {
 539         u16 ret = (u64 *) p - 1 - (u64 *) b->data;
 540
 541         EBUG_ON(__btree_node_offset_to_ptr(b, ret) != p);
 542         return ret;
 543 }
 544
 545 static inline struct bset *bset(const struct btree *b,
 546                                 const struct bset_tree *t)
 547 {
 548         return __btree_node_offset_to_ptr(b, t->data_offset);
 549 }
 550
 551 static inline void set_btree_bset_end(struct btree *b, struct bset_tree *t)
 552 {
 553         t->end_offset =
 554                 __btree_node_ptr_to_offset(b, vstruct_last(bset(b, t)));
 555 }
 556
 557 static inline void set_btree_bset(struct btree *b, struct bset_tree *t,
 558                                   const struct bset *i)
 559 {
 560         t->data_offset = __btree_node_ptr_to_offset(b, i);
 561         set_btree_bset_end(b, t);
 562 }
 563
 564 static inline struct bset *btree_bset_first(struct btree *b)
 565 {
 566         return bset(b, b->set);
 567 }
 568
 569 static inline struct bset *btree_bset_last(struct btree *b)
 570 {
 571         return bset(b, bset_tree_last(b));
 572 }
 573
 574 static inline u16
 575 __btree_node_key_to_offset(const struct btree *b, const struct bkey_packed *k)
 576 {
 577         return __btree_node_ptr_to_offset(b, k);
 578 }
 579
 580 static inline struct bkey_packed *
 581 __btree_node_offset_to_key(const struct btree *b, u16 k)
 582 {
 583         return __btree_node_offset_to_ptr(b, k);
 584 }
 585
 586 static inline unsigned btree_bkey_first_offset(const struct bset_tree *t)
 587 {
 588         return t->data_offset + offsetof(struct bset, _data) / sizeof(u64);
 589 }
 590
 591 #define btree_bkey_first(_b, _t)                                        \
 592 ({                                                                      \
 593         EBUG_ON(bset(_b, _t)->start !=                                  \
 594                 __btree_node_offset_to_key(_b, btree_bkey_first_offset(_t)));\
 595                                                                         \
 596         bset(_b, _t)->start;                                            \
 597 })
 598
 599 #define btree_bkey_last(_b, _t)                                         \
 600 ({                                                                      \
 601         EBUG_ON(__btree_node_offset_to_key(_b, (_t)->end_offset) !=     \
 602                 vstruct_last(bset(_b, _t)));                            \
 603                                                                         \
 604         __btree_node_offset_to_key(_b, (_t)->end_offset);               \
 605 })
 606
 607 static inline unsigned bset_u64s(struct bset_tree *t)
 608 {
 609         return t->end_offset - t->data_offset -
 610                 sizeof(struct bset) / sizeof(u64);
 611 }
 612
 613 static inline unsigned bset_dead_u64s(struct btree *b, struct bset_tree *t)
 614 {
 615         return bset_u64s(t) - b->nr.bset_u64s[t - b->set];
 616 }
 617
 618 static inline unsigned bset_byte_offset(struct btree *b, void *i)
 619 {
 620         return i - (void *) b->data;
 621 }
 622
 623 enum btree_node_type {
 624 #define x(kwd, val) BKEY_TYPE_##kwd = val,
 625         BCH_BTREE_IDS()
 626 #undef x
 627         BKEY_TYPE_btree,
 628 };
 629
 630 /* Type of a key in btree @id at level @level: */
 631 static inline enum btree_node_type __btree_node_type(unsigned level, enum btree_id id)
 632 {
 633         return level ? BKEY_TYPE_btree : (enum btree_node_type) id;
 634 }
 635
 636 /* Type of keys @b contains: */
 637 static inline enum btree_node_type btree_node_type(struct btree *b)
 638 {
 639         return __btree_node_type(b->c.level, b->c.btree_id);
 640 }
 641
 642 #define BTREE_NODE_TYPE_HAS_TRANS_TRIGGERS              \
 643         ((1U << BKEY_TYPE_extents)|                     \
 644          (1U << BKEY_TYPE_alloc)|                       \
 645          (1U << BKEY_TYPE_inodes)|                      \
 646          (1U << BKEY_TYPE_stripes)|                     \
 647          (1U << BKEY_TYPE_reflink)|                     \
 648          (1U << BKEY_TYPE_btree))
 649
 650 #define BTREE_NODE_TYPE_HAS_MEM_TRIGGERS                \
 651         ((1U << BKEY_TYPE_alloc)|                       \
 652          (1U << BKEY_TYPE_inodes)|                      \
 653          (1U << BKEY_TYPE_stripes)|                     \
 654          (1U << BKEY_TYPE_snapshots))
 655
 656 #define BTREE_NODE_TYPE_HAS_TRIGGERS                    \
 657         (BTREE_NODE_TYPE_HAS_TRANS_TRIGGERS|            \
 658          BTREE_NODE_TYPE_HAS_MEM_TRIGGERS)
 659
 660 #define BTREE_ID_IS_EXTENTS                             \
 661         ((1U << BTREE_ID_extents)|                      \
 662          (1U << BTREE_ID_reflink)|                      \
 663          (1U << BTREE_ID_freespace))
 664
 665 static inline bool btree_node_type_is_extents(enum btree_node_type type)
 666 {
 667         return (1U << type) & BTREE_ID_IS_EXTENTS;
 668 }
 669
 670 #define BTREE_ID_HAS_SNAPSHOTS                          \
 671         ((1U << BTREE_ID_extents)|                      \
 672          (1U << BTREE_ID_inodes)|                       \
 673          (1U << BTREE_ID_dirents)|                      \
 674          (1U << BTREE_ID_xattrs))
 675
 676 #define BTREE_ID_HAS_PTRS                               \
 677         ((1U << BTREE_ID_extents)|                      \
 678          (1U << BTREE_ID_reflink))
 679
 680 static inline bool btree_type_has_snapshots(enum btree_id id)
 681 {
 682         return (1 << id) & BTREE_ID_HAS_SNAPSHOTS;
 683 }
 684
 685 static inline bool btree_type_has_ptrs(enum btree_id id)
 686 {
 687         return (1 << id) & BTREE_ID_HAS_PTRS;
 688 }
 689
 690 static inline bool btree_node_type_needs_gc(enum btree_node_type type)
 691 {
 692         return BTREE_NODE_TYPE_HAS_TRIGGERS & (1U << type);
 693 }
 694
 695 struct btree_root {
 696         struct btree            *b;
 697
 698         /* On disk root - see async splits: */
 699         __BKEY_PADDED(key, BKEY_BTREE_PTR_VAL_U64s_MAX);
 700         u8                      level;
 701         u8                      alive;
 702         s8                      error;
 703 };
 704
 705 enum btree_gc_coalesce_fail_reason {
 706         BTREE_GC_COALESCE_FAIL_RESERVE_GET,
 707         BTREE_GC_COALESCE_FAIL_KEYLIST_REALLOC,
 708         BTREE_GC_COALESCE_FAIL_FORMAT_FITS,
 709 };
 710
 711 enum btree_node_sibling {
 712         btree_prev_sib,
 713         btree_next_sib,
 714 };
 715
 716 #endif /* _BCACHEFS_BTREE_TYPES_H */