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