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