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_CACHED               (1 << 6)
 206 #define BTREE_ITER_CACHED_NOFILL        (1 << 7)
 207 #define BTREE_ITER_CACHED_NOCREATE      (1 << 8)
 208 #define BTREE_ITER_WITH_KEY_CACHE       (1 << 9)
 209 #define BTREE_ITER_WITH_UPDATES         (1 << 10)
 210 #define BTREE_ITER_WITH_JOURNAL         (1 << 11)
 211 #define __BTREE_ITER_ALL_SNAPSHOTS      (1 << 12)
 212 #define BTREE_ITER_ALL_SNAPSHOTS        (1 << 13)
 213 #define BTREE_ITER_FILTER_SNAPSHOTS     (1 << 14)
 214 #define BTREE_ITER_NOPRESERVE           (1 << 15)
 215
 216 enum btree_path_uptodate {
 217         BTREE_ITER_UPTODATE             = 0,
 218         BTREE_ITER_NEED_RELOCK          = 1,
 219         BTREE_ITER_NEED_TRAVERSE        = 2,
 220 };
 221
 222 #define BTREE_ITER_NO_NODE_GET_LOCKS    ((struct btree *) 1)
 223 #define BTREE_ITER_NO_NODE_DROP         ((struct btree *) 2)
 224 #define BTREE_ITER_NO_NODE_LOCK_ROOT    ((struct btree *) 3)
 225 #define BTREE_ITER_NO_NODE_UP           ((struct btree *) 4)
 226 #define BTREE_ITER_NO_NODE_DOWN         ((struct btree *) 5)
 227 #define BTREE_ITER_NO_NODE_INIT         ((struct btree *) 6)
 228 #define BTREE_ITER_NO_NODE_ERROR        ((struct btree *) 7)
 229 #define BTREE_ITER_NO_NODE_CACHED       ((struct btree *) 8)
 230
 231 struct btree_path {
 232         u8                      idx;
 233         u8                      sorted_idx;
 234         u8                      ref;
 235         u8                      intent_ref;
 236
 237         /* btree_iter_copy starts here: */
 238         struct bpos             pos;
 239
 240         enum btree_id           btree_id:4;
 241         bool                    cached:1;
 242         bool                    preserve:1;
 243         enum btree_path_uptodate uptodate:2;
 244         /*
 245          * When true, failing to relock this path will cause the transaction to
 246          * restart:
 247          */
 248         bool                    should_be_locked:1;
 249         unsigned                level:3,
 250                                 locks_want:4,
 251                                 nodes_locked:4,
 252                                 nodes_intent_locked:4;
 253
 254         struct btree_path_level {
 255                 struct btree    *b;
 256                 struct btree_node_iter iter;
 257                 u32             lock_seq;
 258         }                       l[BTREE_MAX_DEPTH];
 259 #ifdef CONFIG_BCACHEFS_DEBUG
 260         unsigned long           ip_allocated;
 261 #endif
 262 };
 263
 264 static inline struct btree_path_level *path_l(struct btree_path *path)
 265 {
 266         return path->l + path->level;
 267 }
 268
 269 /*
 270  * @pos                 - iterator's current position
 271  * @level               - current btree depth
 272  * @locks_want          - btree level below which we start taking intent locks
 273  * @nodes_locked        - bitmask indicating which nodes in @nodes are locked
 274  * @nodes_intent_locked - bitmask indicating which locks are intent locks
 275  */
 276 struct btree_iter {
 277         struct btree_trans      *trans;
 278         struct btree_path       *path;
 279         struct btree_path       *update_path;
 280         struct btree_path       *key_cache_path;
 281
 282         enum btree_id           btree_id:4;
 283         unsigned                min_depth:4;
 284
 285         /* btree_iter_copy starts here: */
 286         u16                     flags;
 287
 288         /* When we're filtering by snapshot, the snapshot ID we're looking for: */
 289         unsigned                snapshot;
 290
 291         struct bpos             pos;
 292         struct bpos             pos_after_commit;
 293         /*
 294          * Current unpacked key - so that bch2_btree_iter_next()/
 295          * bch2_btree_iter_next_slot() can correctly advance pos.
 296          */
 297         struct bkey             k;
 298 #ifdef CONFIG_BCACHEFS_DEBUG
 299         unsigned long           ip_allocated;
 300 #endif
 301 };
 302
 303 struct btree_key_cache {
 304         struct mutex            lock;
 305         struct rhashtable       table;
 306         bool                    table_init_done;
 307         struct list_head        freed;
 308         struct shrinker         shrink;
 309         unsigned                shrink_iter;
 310
 311         size_t                  nr_freed;
 312         atomic_long_t           nr_keys;
 313         atomic_long_t           nr_dirty;
 314 };
 315
 316 struct bkey_cached_key {
 317         u32                     btree_id;
 318         struct bpos             pos;
 319 } __attribute__((packed, aligned(4)));
 320
 321 #define BKEY_CACHED_ACCESSED            0
 322 #define BKEY_CACHED_DIRTY               1
 323
 324 struct bkey_cached {
 325         struct btree_bkey_cached_common c;
 326
 327         unsigned long           flags;
 328         u8                      u64s;
 329         bool                    valid;
 330         u32                     btree_trans_barrier_seq;
 331         struct bkey_cached_key  key;
 332
 333         struct rhash_head       hash;
 334         struct list_head        list;
 335
 336         struct journal_preres   res;
 337         struct journal_entry_pin journal;
 338
 339         struct bkey_i           *k;
 340 };
 341
 342 struct btree_insert_entry {
 343         unsigned                flags;
 344         u8                      bkey_type;
 345         enum btree_id           btree_id:8;
 346         u8                      level:4;
 347         bool                    cached:1;
 348         bool                    insert_trigger_run:1;
 349         bool                    overwrite_trigger_run:1;
 350         /*
 351          * @old_k may be a key from the journal; @old_btree_u64s always refers
 352          * to the size of the key being overwritten in the btree:
 353          */
 354         u8                      old_btree_u64s;
 355         struct bkey_i           *k;
 356         struct btree_path       *path;
 357         /* key being overwritten: */
 358         struct bkey             old_k;
 359         const struct bch_val    *old_v;
 360         unsigned long           ip_allocated;
 361 };
 362
 363 #define BTREE_ITER_MAX          64
 364
 365 struct btree_trans_commit_hook;
 366 typedef int (btree_trans_commit_hook_fn)(struct btree_trans *, struct btree_trans_commit_hook *);
 367
 368 struct btree_trans_commit_hook {
 369         btree_trans_commit_hook_fn      *fn;
 370         struct btree_trans_commit_hook  *next;
 371 };
 372
 373 #define BTREE_TRANS_MEM_MAX     (1U << 14)
 374
 375 struct btree_trans {
 376         struct bch_fs           *c;
 377         const char              *fn;
 378         struct list_head        list;
 379         struct btree            *locking;
 380         unsigned                locking_path_idx;
 381         struct bpos             locking_pos;
 382         u8                      locking_btree_id;
 383         u8                      locking_level;
 384         u8                      locking_lock_type;
 385         pid_t                   pid;
 386         int                     srcu_idx;
 387
 388         u8                      nr_sorted;
 389         u8                      nr_updates;
 390         bool                    used_mempool:1;
 391         bool                    in_traverse_all:1;
 392         bool                    restarted:1;
 393         bool                    memory_allocation_failure:1;
 394         bool                    journal_transaction_names:1;
 395         bool                    is_initial_gc:1;
 396         /*
 397          * For when bch2_trans_update notices we'll be splitting a compressed
 398          * extent:
 399          */
 400         unsigned                extra_journal_res;
 401
 402         u64                     paths_allocated;
 403
 404         unsigned                mem_top;
 405         unsigned                mem_bytes;
 406         void                    *mem;
 407
 408         u8                      sorted[BTREE_ITER_MAX];
 409         struct btree_path       *paths;
 410         struct btree_insert_entry *updates;
 411
 412         /* update path: */
 413         struct btree_trans_commit_hook *hooks;
 414         struct jset_entry       *extra_journal_entries;
 415         unsigned                extra_journal_entry_u64s;
 416         struct journal_entry_pin *journal_pin;
 417
 418         struct journal_res      journal_res;
 419         struct journal_preres   journal_preres;
 420         u64                     *journal_seq;
 421         struct disk_reservation *disk_res;
 422         unsigned                flags;
 423         unsigned                journal_u64s;
 424         unsigned                journal_preres_u64s;
 425         struct replicas_delta_list *fs_usage_deltas;
 426 };
 427
 428 #define BTREE_FLAGS()                                                   \
 429         x(read_in_flight)                                               \
 430         x(read_error)                                                   \
 431         x(dirty)                                                        \
 432         x(need_write)                                                   \
 433         x(write_blocked)                                                \
 434         x(will_make_reachable)                                          \
 435         x(noevict)                                                      \
 436         x(write_idx)                                                    \
 437         x(accessed)                                                     \
 438         x(write_in_flight)                                              \
 439         x(write_in_flight_inner)                                        \
 440         x(just_written)                                                 \
 441         x(dying)                                                        \
 442         x(fake)                                                         \
 443         x(need_rewrite)                                                 \
 444         x(never_write)
 445
 446 enum btree_flags {
 447 #define x(flag) BTREE_NODE_##flag,
 448         BTREE_FLAGS()
 449 #undef x
 450 };
 451
 452 #define x(flag)                                                         \
 453 static inline bool btree_node_ ## flag(struct btree *b)                 \
 454 {       return test_bit(BTREE_NODE_ ## flag, &b->flags); }              \
 455                                                                         \
 456 static inline void set_btree_node_ ## flag(struct btree *b)             \
 457 {       set_bit(BTREE_NODE_ ## flag, &b->flags); }                      \
 458                                                                         \
 459 static inline void clear_btree_node_ ## flag(struct btree *b)           \
 460 {       clear_bit(BTREE_NODE_ ## flag, &b->flags); }
 461
 462 BTREE_FLAGS()
 463 #undef x
 464
 465 static inline struct btree_write *btree_current_write(struct btree *b)
 466 {
 467         return b->writes + btree_node_write_idx(b);
 468 }
 469
 470 static inline struct btree_write *btree_prev_write(struct btree *b)
 471 {
 472         return b->writes + (btree_node_write_idx(b) ^ 1);
 473 }
 474
 475 static inline struct bset_tree *bset_tree_last(struct btree *b)
 476 {
 477         EBUG_ON(!b->nsets);
 478         return b->set + b->nsets - 1;
 479 }
 480
 481 static inline void *
 482 __btree_node_offset_to_ptr(const struct btree *b, u16 offset)
 483 {
 484         return (void *) ((u64 *) b->data + 1 + offset);
 485 }
 486
 487 static inline u16
 488 __btree_node_ptr_to_offset(const struct btree *b, const void *p)
 489 {
 490         u16 ret = (u64 *) p - 1 - (u64 *) b->data;
 491
 492         EBUG_ON(__btree_node_offset_to_ptr(b, ret) != p);
 493         return ret;
 494 }
 495
 496 static inline struct bset *bset(const struct btree *b,
 497                                 const struct bset_tree *t)
 498 {
 499         return __btree_node_offset_to_ptr(b, t->data_offset);
 500 }
 501
 502 static inline void set_btree_bset_end(struct btree *b, struct bset_tree *t)
 503 {
 504         t->end_offset =
 505                 __btree_node_ptr_to_offset(b, vstruct_last(bset(b, t)));
 506 }
 507
 508 static inline void set_btree_bset(struct btree *b, struct bset_tree *t,
 509                                   const struct bset *i)
 510 {
 511         t->data_offset = __btree_node_ptr_to_offset(b, i);
 512         set_btree_bset_end(b, t);
 513 }
 514
 515 static inline struct bset *btree_bset_first(struct btree *b)
 516 {
 517         return bset(b, b->set);
 518 }
 519
 520 static inline struct bset *btree_bset_last(struct btree *b)
 521 {
 522         return bset(b, bset_tree_last(b));
 523 }
 524
 525 static inline u16
 526 __btree_node_key_to_offset(const struct btree *b, const struct bkey_packed *k)
 527 {
 528         return __btree_node_ptr_to_offset(b, k);
 529 }
 530
 531 static inline struct bkey_packed *
 532 __btree_node_offset_to_key(const struct btree *b, u16 k)
 533 {
 534         return __btree_node_offset_to_ptr(b, k);
 535 }
 536
 537 static inline unsigned btree_bkey_first_offset(const struct bset_tree *t)
 538 {
 539         return t->data_offset + offsetof(struct bset, _data) / sizeof(u64);
 540 }
 541
 542 #define btree_bkey_first(_b, _t)                                        \
 543 ({                                                                      \
 544         EBUG_ON(bset(_b, _t)->start !=                                  \
 545                 __btree_node_offset_to_key(_b, btree_bkey_first_offset(_t)));\
 546                                                                         \
 547         bset(_b, _t)->start;                                            \
 548 })
 549
 550 #define btree_bkey_last(_b, _t)                                         \
 551 ({                                                                      \
 552         EBUG_ON(__btree_node_offset_to_key(_b, (_t)->end_offset) !=     \
 553                 vstruct_last(bset(_b, _t)));                            \
 554                                                                         \
 555         __btree_node_offset_to_key(_b, (_t)->end_offset);               \
 556 })
 557
 558 static inline unsigned bset_u64s(struct bset_tree *t)
 559 {
 560         return t->end_offset - t->data_offset -
 561                 sizeof(struct bset) / sizeof(u64);
 562 }
 563
 564 static inline unsigned bset_dead_u64s(struct btree *b, struct bset_tree *t)
 565 {
 566         return bset_u64s(t) - b->nr.bset_u64s[t - b->set];
 567 }
 568
 569 static inline unsigned bset_byte_offset(struct btree *b, void *i)
 570 {
 571         return i - (void *) b->data;
 572 }
 573
 574 enum btree_node_type {
 575 #define x(kwd, val) BKEY_TYPE_##kwd = val,
 576         BCH_BTREE_IDS()
 577 #undef x
 578         BKEY_TYPE_btree,
 579 };
 580
 581 /* Type of a key in btree @id at level @level: */
 582 static inline enum btree_node_type __btree_node_type(unsigned level, enum btree_id id)
 583 {
 584         return level ? BKEY_TYPE_btree : (enum btree_node_type) id;
 585 }
 586
 587 /* Type of keys @b contains: */
 588 static inline enum btree_node_type btree_node_type(struct btree *b)
 589 {
 590         return __btree_node_type(b->c.level, b->c.btree_id);
 591 }
 592
 593 static inline bool btree_node_type_is_extents(enum btree_node_type type)
 594 {
 595         switch (type) {
 596         case BKEY_TYPE_extents:
 597         case BKEY_TYPE_reflink:
 598                 return true;
 599         default:
 600                 return false;
 601         }
 602 }
 603
 604 static inline bool btree_node_is_extents(struct btree *b)
 605 {
 606         return btree_node_type_is_extents(btree_node_type(b));
 607 }
 608
 609 #define BTREE_NODE_TYPE_HAS_TRANS_TRIGGERS              \
 610         ((1U << BKEY_TYPE_extents)|                     \
 611          (1U << BKEY_TYPE_inodes)|                      \
 612          (1U << BKEY_TYPE_stripes)|                     \
 613          (1U << BKEY_TYPE_reflink)|                     \
 614          (1U << BKEY_TYPE_btree))
 615
 616 #define BTREE_NODE_TYPE_HAS_MEM_TRIGGERS                \
 617         ((1U << BKEY_TYPE_alloc)|                       \
 618          (1U << BKEY_TYPE_inodes)|                      \
 619          (1U << BKEY_TYPE_stripes)|                     \
 620          (1U << BKEY_TYPE_snapshots))
 621
 622 #define BTREE_NODE_TYPE_HAS_TRIGGERS                    \
 623         (BTREE_NODE_TYPE_HAS_TRANS_TRIGGERS|            \
 624          BTREE_NODE_TYPE_HAS_MEM_TRIGGERS)
 625
 626 #define BTREE_ID_HAS_SNAPSHOTS                          \
 627         ((1U << BTREE_ID_extents)|                      \
 628          (1U << BTREE_ID_inodes)|                       \
 629          (1U << BTREE_ID_dirents)|                      \
 630          (1U << BTREE_ID_xattrs))
 631
 632 #define BTREE_ID_HAS_PTRS                               \
 633         ((1U << BTREE_ID_extents)|                      \
 634          (1U << BTREE_ID_reflink))
 635
 636 static inline bool btree_type_has_snapshots(enum btree_id id)
 637 {
 638         return (1 << id) & BTREE_ID_HAS_SNAPSHOTS;
 639 }
 640
 641 enum btree_update_flags {
 642         __BTREE_UPDATE_INTERNAL_SNAPSHOT_NODE,
 643         __BTREE_UPDATE_KEY_CACHE_RECLAIM,
 644
 645         __BTREE_TRIGGER_NORUN,          /* Don't run triggers at all */
 646
 647         __BTREE_TRIGGER_INSERT,
 648         __BTREE_TRIGGER_OVERWRITE,
 649
 650         __BTREE_TRIGGER_GC,
 651         __BTREE_TRIGGER_BUCKET_INVALIDATE,
 652         __BTREE_TRIGGER_NOATOMIC,
 653 };
 654
 655 #define BTREE_UPDATE_INTERNAL_SNAPSHOT_NODE (1U << __BTREE_UPDATE_INTERNAL_SNAPSHOT_NODE)
 656 #define BTREE_UPDATE_KEY_CACHE_RECLAIM  (1U << __BTREE_UPDATE_KEY_CACHE_RECLAIM)
 657
 658 #define BTREE_TRIGGER_NORUN             (1U << __BTREE_TRIGGER_NORUN)
 659
 660 #define BTREE_TRIGGER_INSERT            (1U << __BTREE_TRIGGER_INSERT)
 661 #define BTREE_TRIGGER_OVERWRITE         (1U << __BTREE_TRIGGER_OVERWRITE)
 662
 663 #define BTREE_TRIGGER_GC                (1U << __BTREE_TRIGGER_GC)
 664 #define BTREE_TRIGGER_BUCKET_INVALIDATE (1U << __BTREE_TRIGGER_BUCKET_INVALIDATE)
 665 #define BTREE_TRIGGER_NOATOMIC          (1U << __BTREE_TRIGGER_NOATOMIC)
 666
 667 #define BTREE_TRIGGER_WANTS_OLD_AND_NEW         \
 668         ((1U << KEY_TYPE_alloc)|                \
 669          (1U << KEY_TYPE_alloc_v2)|             \
 670          (1U << KEY_TYPE_alloc_v3)|             \
 671          (1U << KEY_TYPE_stripe)|               \
 672          (1U << KEY_TYPE_inode)|                \
 673          (1U << KEY_TYPE_inode_v2)|             \
 674          (1U << KEY_TYPE_snapshot))
 675
 676 static inline bool btree_node_type_needs_gc(enum btree_node_type type)
 677 {
 678         return BTREE_NODE_TYPE_HAS_TRIGGERS & (1U << type);
 679 }
 680
 681 struct btree_root {
 682         struct btree            *b;
 683
 684         /* On disk root - see async splits: */
 685         __BKEY_PADDED(key, BKEY_BTREE_PTR_VAL_U64s_MAX);
 686         u8                      level;
 687         u8                      alive;
 688         s8                      error;
 689 };
 690
 691 enum btree_insert_ret {
 692         BTREE_INSERT_OK,
 693         /* leaf node needs to be split */
 694         BTREE_INSERT_BTREE_NODE_FULL,
 695         BTREE_INSERT_NEED_MARK_REPLICAS,
 696         BTREE_INSERT_NEED_JOURNAL_RES,
 697         BTREE_INSERT_NEED_JOURNAL_RECLAIM,
 698 };
 699
 700 enum btree_gc_coalesce_fail_reason {
 701         BTREE_GC_COALESCE_FAIL_RESERVE_GET,
 702         BTREE_GC_COALESCE_FAIL_KEYLIST_REALLOC,
 703         BTREE_GC_COALESCE_FAIL_FORMAT_FITS,
 704 };
 705
 706 enum btree_node_sibling {
 707         btree_prev_sib,
 708         btree_next_sib,
 709 };
 710
 711 #endif /* _BCACHEFS_BTREE_TYPES_H */