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