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 enum btree_iter_type {
 180         BTREE_ITER_KEYS,
 181         BTREE_ITER_NODES,
 182         BTREE_ITER_CACHED,
 183 };
 184
 185 #define BTREE_ITER_TYPE                 ((1 << 2) - 1)
 186
 187 /*
 188  * Iterate over all possible positions, synthesizing deleted keys for holes:
 189  */
 190 #define BTREE_ITER_SLOTS                (1 << 2)
 191 /*
 192  * Indicates that intent locks should be taken on leaf nodes, because we expect
 193  * to be doing updates:
 194  */
 195 #define BTREE_ITER_INTENT               (1 << 3)
 196 /*
 197  * Causes the btree iterator code to prefetch additional btree nodes from disk:
 198  */
 199 #define BTREE_ITER_PREFETCH             (1 << 4)
 200 /*
 201  * Indicates that this iterator should not be reused until transaction commit,
 202  * either because a pending update references it or because the update depends
 203  * on that particular key being locked (e.g. by the str_hash code, for hash
 204  * table consistency)
 205  */
 206 #define BTREE_ITER_KEEP_UNTIL_COMMIT    (1 << 5)
 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 << 6)
 212 #define BTREE_ITER_NOT_EXTENTS          (1 << 7)
 213 #define BTREE_ITER_ERROR                (1 << 8)
 214 #define BTREE_ITER_SET_POS_AFTER_COMMIT (1 << 9)
 215 #define BTREE_ITER_CACHED_NOFILL        (1 << 10)
 216 #define BTREE_ITER_CACHED_NOCREATE      (1 << 11)
 217 #define BTREE_ITER_WITH_UPDATES         (1 << 12)
 218 #define BTREE_ITER_ALL_SNAPSHOTS        (1 << 13)
 219
 220 enum btree_iter_uptodate {
 221         BTREE_ITER_UPTODATE             = 0,
 222         BTREE_ITER_NEED_PEEK            = 1,
 223         BTREE_ITER_NEED_RELOCK          = 2,
 224         BTREE_ITER_NEED_TRAVERSE        = 3,
 225 };
 226
 227 #define BTREE_ITER_NO_NODE_GET_LOCKS    ((struct btree *) 1)
 228 #define BTREE_ITER_NO_NODE_DROP         ((struct btree *) 2)
 229 #define BTREE_ITER_NO_NODE_LOCK_ROOT    ((struct btree *) 3)
 230 #define BTREE_ITER_NO_NODE_UP           ((struct btree *) 4)
 231 #define BTREE_ITER_NO_NODE_DOWN         ((struct btree *) 5)
 232 #define BTREE_ITER_NO_NODE_INIT         ((struct btree *) 6)
 233 #define BTREE_ITER_NO_NODE_ERROR        ((struct btree *) 7)
 234 #define BTREE_ITER_NO_NODE_CACHED       ((struct btree *) 8)
 235
 236 /*
 237  * @pos                 - iterator's current position
 238  * @level               - current btree depth
 239  * @locks_want          - btree level below which we start taking intent locks
 240  * @nodes_locked        - bitmask indicating which nodes in @nodes are locked
 241  * @nodes_intent_locked - bitmask indicating which locks are intent locks
 242  */
 243 struct btree_iter {
 244         struct btree_trans      *trans;
 245         unsigned long           ip_allocated;
 246
 247         u8                      idx;
 248         u8                      child_idx;
 249         u8                      sorted_idx;
 250
 251         /* btree_iter_copy starts here: */
 252         u16                     flags;
 253
 254         /* When we're filtering by snapshot, the snapshot ID we're looking for: */
 255         unsigned                snapshot;
 256
 257         struct bpos             pos;
 258         struct bpos             real_pos;
 259         struct bpos             pos_after_commit;
 260
 261         enum btree_id           btree_id:4;
 262         enum btree_iter_uptodate uptodate:3;
 263         /*
 264          * True if we've returned a key (and thus are expected to keep it
 265          * locked), false after set_pos - for avoiding spurious transaction
 266          * restarts in bch2_trans_relock():
 267          */
 268         bool                    should_be_locked:1;
 269         unsigned                level:4,
 270                                 min_depth:4,
 271                                 locks_want:4,
 272                                 nodes_locked:4,
 273                                 nodes_intent_locked:4;
 274
 275         struct btree_iter_level {
 276                 struct btree    *b;
 277                 struct btree_node_iter iter;
 278                 u32             lock_seq;
 279         }                       l[BTREE_MAX_DEPTH];
 280
 281         /*
 282          * Current unpacked key - so that bch2_btree_iter_next()/
 283          * bch2_btree_iter_next_slot() can correctly advance pos.
 284          */
 285         struct bkey             k;
 286 };
 287
 288 static inline enum btree_iter_type
 289 btree_iter_type(const struct btree_iter *iter)
 290 {
 291         return iter->flags & BTREE_ITER_TYPE;
 292 }
 293
 294 static inline bool btree_iter_is_cached(const struct btree_iter *iter)
 295 {
 296         return btree_iter_type(iter) == BTREE_ITER_CACHED;
 297 }
 298
 299 static inline struct btree_iter_level *iter_l(struct btree_iter *iter)
 300 {
 301         return iter->l + iter->level;
 302 }
 303
 304 struct btree_key_cache {
 305         struct mutex            lock;
 306         struct rhashtable       table;
 307         bool                    table_init_done;
 308         struct list_head        freed;
 309         struct shrinker         shrink;
 310         unsigned                shrink_iter;
 311
 312         size_t                  nr_freed;
 313         atomic_long_t           nr_keys;
 314         atomic_long_t           nr_dirty;
 315 };
 316
 317 struct bkey_cached_key {
 318         u32                     btree_id;
 319         struct bpos             pos;
 320 } __attribute__((packed, aligned(4)));
 321
 322 #define BKEY_CACHED_ACCESSED            0
 323 #define BKEY_CACHED_DIRTY               1
 324
 325 struct bkey_cached {
 326         struct btree_bkey_cached_common c;
 327
 328         unsigned long           flags;
 329         u8                      u64s;
 330         bool                    valid;
 331         u32                     btree_trans_barrier_seq;
 332         struct bkey_cached_key  key;
 333
 334         struct rhash_head       hash;
 335         struct list_head        list;
 336
 337         struct journal_preres   res;
 338         struct journal_entry_pin journal;
 339
 340         struct bkey_i           *k;
 341 };
 342
 343 struct btree_insert_entry {
 344         unsigned                flags;
 345         u8                      bkey_type;
 346         enum btree_id           btree_id:8;
 347         u8                      level;
 348         unsigned                trans_triggers_run:1;
 349         struct bkey_i           *k;
 350         struct btree_iter       *iter;
 351 };
 352
 353 #ifndef CONFIG_LOCKDEP
 354 #define BTREE_ITER_MAX          64
 355 #else
 356 #define BTREE_ITER_MAX          32
 357 #endif
 358
 359 struct btree_trans_commit_hook;
 360 typedef int (btree_trans_commit_hook_fn)(struct btree_trans *, struct btree_trans_commit_hook *);
 361
 362 struct btree_trans_commit_hook {
 363         btree_trans_commit_hook_fn      *fn;
 364         struct btree_trans_commit_hook  *next;
 365 };
 366
 367 #define BTREE_TRANS_MEM_MAX     (1U << 14)
 368
 369 struct btree_trans {
 370         struct bch_fs           *c;
 371 #ifdef CONFIG_BCACHEFS_DEBUG
 372         struct list_head        list;
 373         struct btree            *locking;
 374         unsigned                locking_iter_idx;
 375         struct bpos             locking_pos;
 376         u8                      locking_btree_id;
 377         u8                      locking_level;
 378         pid_t                   pid;
 379 #endif
 380         unsigned long           ip;
 381         int                     srcu_idx;
 382
 383         u8                      nr_sorted;
 384         u8                      nr_updates;
 385         bool                    used_mempool:1;
 386         bool                    error:1;
 387         bool                    in_traverse_all:1;
 388         bool                    restarted:1;
 389         /*
 390          * For when bch2_trans_update notices we'll be splitting a compressed
 391          * extent:
 392          */
 393         unsigned                extra_journal_res;
 394
 395         u64                     iters_linked;
 396         u64                     iters_live;
 397         u64                     iters_touched;
 398
 399         unsigned                mem_top;
 400         unsigned                mem_bytes;
 401         void                    *mem;
 402
 403         u8                      *sorted;
 404         struct btree_iter       *iters;
 405         struct btree_insert_entry *updates;
 406
 407         /* update path: */
 408         struct btree_trans_commit_hook *hooks;
 409         struct jset_entry       *extra_journal_entries;
 410         unsigned                extra_journal_entry_u64s;
 411         struct journal_entry_pin *journal_pin;
 412
 413         struct journal_res      journal_res;
 414         struct journal_preres   journal_preres;
 415         u64                     *journal_seq;
 416         struct disk_reservation *disk_res;
 417         unsigned                flags;
 418         unsigned                journal_u64s;
 419         unsigned                journal_preres_u64s;
 420         struct replicas_delta_list *fs_usage_deltas;
 421 };
 422
 423 #define BTREE_FLAG(flag)                                                \
 424 static inline bool btree_node_ ## flag(struct btree *b)                 \
 425 {       return test_bit(BTREE_NODE_ ## flag, &b->flags); }              \
 426                                                                         \
 427 static inline void set_btree_node_ ## flag(struct btree *b)             \
 428 {       set_bit(BTREE_NODE_ ## flag, &b->flags); }                      \
 429                                                                         \
 430 static inline void clear_btree_node_ ## flag(struct btree *b)           \
 431 {       clear_bit(BTREE_NODE_ ## flag, &b->flags); }
 432
 433 enum btree_flags {
 434         BTREE_NODE_read_in_flight,
 435         BTREE_NODE_read_error,
 436         BTREE_NODE_dirty,
 437         BTREE_NODE_need_write,
 438         BTREE_NODE_noevict,
 439         BTREE_NODE_write_idx,
 440         BTREE_NODE_accessed,
 441         BTREE_NODE_write_in_flight,
 442         BTREE_NODE_write_in_flight_inner,
 443         BTREE_NODE_just_written,
 444         BTREE_NODE_dying,
 445         BTREE_NODE_fake,
 446         BTREE_NODE_need_rewrite,
 447         BTREE_NODE_never_write,
 448 };
 449
 450 BTREE_FLAG(read_in_flight);
 451 BTREE_FLAG(read_error);
 452 BTREE_FLAG(need_write);
 453 BTREE_FLAG(noevict);
 454 BTREE_FLAG(write_idx);
 455 BTREE_FLAG(accessed);
 456 BTREE_FLAG(write_in_flight);
 457 BTREE_FLAG(write_in_flight_inner);
 458 BTREE_FLAG(just_written);
 459 BTREE_FLAG(dying);
 460 BTREE_FLAG(fake);
 461 BTREE_FLAG(need_rewrite);
 462 BTREE_FLAG(never_write);
 463
 464 static inline struct btree_write *btree_current_write(struct btree *b)
 465 {
 466         return b->writes + btree_node_write_idx(b);
 467 }
 468
 469 static inline struct btree_write *btree_prev_write(struct btree *b)
 470 {
 471         return b->writes + (btree_node_write_idx(b) ^ 1);
 472 }
 473
 474 static inline struct bset_tree *bset_tree_last(struct btree *b)
 475 {
 476         EBUG_ON(!b->nsets);
 477         return b->set + b->nsets - 1;
 478 }
 479
 480 static inline void *
 481 __btree_node_offset_to_ptr(const struct btree *b, u16 offset)
 482 {
 483         return (void *) ((u64 *) b->data + 1 + offset);
 484 }
 485
 486 static inline u16
 487 __btree_node_ptr_to_offset(const struct btree *b, const void *p)
 488 {
 489         u16 ret = (u64 *) p - 1 - (u64 *) b->data;
 490
 491         EBUG_ON(__btree_node_offset_to_ptr(b, ret) != p);
 492         return ret;
 493 }
 494
 495 static inline struct bset *bset(const struct btree *b,
 496                                 const struct bset_tree *t)
 497 {
 498         return __btree_node_offset_to_ptr(b, t->data_offset);
 499 }
 500
 501 static inline void set_btree_bset_end(struct btree *b, struct bset_tree *t)
 502 {
 503         t->end_offset =
 504                 __btree_node_ptr_to_offset(b, vstruct_last(bset(b, t)));
 505 }
 506
 507 static inline void set_btree_bset(struct btree *b, struct bset_tree *t,
 508                                   const struct bset *i)
 509 {
 510         t->data_offset = __btree_node_ptr_to_offset(b, i);
 511         set_btree_bset_end(b, t);
 512 }
 513
 514 static inline struct bset *btree_bset_first(struct btree *b)
 515 {
 516         return bset(b, b->set);
 517 }
 518
 519 static inline struct bset *btree_bset_last(struct btree *b)
 520 {
 521         return bset(b, bset_tree_last(b));
 522 }
 523
 524 static inline u16
 525 __btree_node_key_to_offset(const struct btree *b, const struct bkey_packed *k)
 526 {
 527         return __btree_node_ptr_to_offset(b, k);
 528 }
 529
 530 static inline struct bkey_packed *
 531 __btree_node_offset_to_key(const struct btree *b, u16 k)
 532 {
 533         return __btree_node_offset_to_ptr(b, k);
 534 }
 535
 536 static inline unsigned btree_bkey_first_offset(const struct bset_tree *t)
 537 {
 538         return t->data_offset + offsetof(struct bset, _data) / sizeof(u64);
 539 }
 540
 541 #define btree_bkey_first(_b, _t)                                        \
 542 ({                                                                      \
 543         EBUG_ON(bset(_b, _t)->start !=                                  \
 544                 __btree_node_offset_to_key(_b, btree_bkey_first_offset(_t)));\
 545                                                                         \
 546         bset(_b, _t)->start;                                            \
 547 })
 548
 549 #define btree_bkey_last(_b, _t)                                         \
 550 ({                                                                      \
 551         EBUG_ON(__btree_node_offset_to_key(_b, (_t)->end_offset) !=     \
 552                 vstruct_last(bset(_b, _t)));                            \
 553                                                                         \
 554         __btree_node_offset_to_key(_b, (_t)->end_offset);               \
 555 })
 556
 557 static inline unsigned bset_u64s(struct bset_tree *t)
 558 {
 559         return t->end_offset - t->data_offset -
 560                 sizeof(struct bset) / sizeof(u64);
 561 }
 562
 563 static inline unsigned bset_dead_u64s(struct btree *b, struct bset_tree *t)
 564 {
 565         return bset_u64s(t) - b->nr.bset_u64s[t - b->set];
 566 }
 567
 568 static inline unsigned bset_byte_offset(struct btree *b, void *i)
 569 {
 570         return i - (void *) b->data;
 571 }
 572
 573 enum btree_node_type {
 574 #define x(kwd, val) BKEY_TYPE_##kwd = val,
 575         BCH_BTREE_IDS()
 576 #undef x
 577         BKEY_TYPE_btree,
 578 };
 579
 580 /* Type of a key in btree @id at level @level: */
 581 static inline enum btree_node_type __btree_node_type(unsigned level, enum btree_id id)
 582 {
 583         return level ? BKEY_TYPE_btree : (enum btree_node_type) id;
 584 }
 585
 586 /* Type of keys @b contains: */
 587 static inline enum btree_node_type btree_node_type(struct btree *b)
 588 {
 589         return __btree_node_type(b->c.level, b->c.btree_id);
 590 }
 591
 592 static inline bool btree_node_type_is_extents(enum btree_node_type type)
 593 {
 594         switch (type) {
 595         case BKEY_TYPE_extents:
 596         case BKEY_TYPE_reflink:
 597                 return true;
 598         default:
 599                 return false;
 600         }
 601 }
 602
 603 static inline bool btree_node_is_extents(struct btree *b)
 604 {
 605         return btree_node_type_is_extents(btree_node_type(b));
 606 }
 607
 608 static inline enum btree_node_type btree_iter_key_type(struct btree_iter *iter)
 609 {
 610         return __btree_node_type(iter->level, iter->btree_id);
 611 }
 612
 613 static inline bool btree_iter_is_extents(struct btree_iter *iter)
 614 {
 615         return btree_node_type_is_extents(btree_iter_key_type(iter));
 616 }
 617
 618 #define BTREE_NODE_TYPE_HAS_TRANS_TRIGGERS              \
 619         ((1U << BKEY_TYPE_extents)|                     \
 620          (1U << BKEY_TYPE_inodes)|                      \
 621          (1U << BKEY_TYPE_stripes)|                     \
 622          (1U << BKEY_TYPE_reflink)|                     \
 623          (1U << BKEY_TYPE_btree))
 624
 625 #define BTREE_NODE_TYPE_HAS_MEM_TRIGGERS                \
 626         ((1U << BKEY_TYPE_alloc)|                       \
 627          (1U << BKEY_TYPE_stripes))
 628
 629 #define BTREE_NODE_TYPE_HAS_TRIGGERS                    \
 630         (BTREE_NODE_TYPE_HAS_TRANS_TRIGGERS|            \
 631          BTREE_NODE_TYPE_HAS_MEM_TRIGGERS)
 632
 633 #define BTREE_ID_HAS_SNAPSHOTS                          \
 634         ((1U << BTREE_ID_extents)|                      \
 635          (1U << BTREE_ID_inodes)|                       \
 636          (1U << BTREE_ID_dirents)|                      \
 637          (1U << BTREE_ID_xattrs))
 638
 639 #define BTREE_ID_HAS_PTRS                               \
 640         ((1U << BTREE_ID_extents)|                      \
 641          (1U << BTREE_ID_reflink))
 642
 643 static inline bool btree_type_has_snapshots(enum btree_id id)
 644 {
 645         return (1 << id) & BTREE_ID_HAS_SNAPSHOTS;
 646 }
 647
 648 enum btree_update_flags {
 649         __BTREE_UPDATE_INTERNAL_SNAPSHOT_NODE,
 650
 651         __BTREE_TRIGGER_NORUN,          /* Don't run triggers at all */
 652
 653         __BTREE_TRIGGER_INSERT,
 654         __BTREE_TRIGGER_OVERWRITE,
 655
 656         __BTREE_TRIGGER_GC,
 657         __BTREE_TRIGGER_BUCKET_INVALIDATE,
 658         __BTREE_TRIGGER_NOATOMIC,
 659 };
 660
 661 #define BTREE_UPDATE_INTERNAL_SNAPSHOT_NODE (1U << __BTREE_UPDATE_INTERNAL_SNAPSHOT_NODE)
 662
 663 #define BTREE_TRIGGER_NORUN             (1U << __BTREE_TRIGGER_NORUN)
 664
 665 #define BTREE_TRIGGER_INSERT            (1U << __BTREE_TRIGGER_INSERT)
 666 #define BTREE_TRIGGER_OVERWRITE         (1U << __BTREE_TRIGGER_OVERWRITE)
 667
 668 #define BTREE_TRIGGER_GC                (1U << __BTREE_TRIGGER_GC)
 669 #define BTREE_TRIGGER_BUCKET_INVALIDATE (1U << __BTREE_TRIGGER_BUCKET_INVALIDATE)
 670 #define BTREE_TRIGGER_NOATOMIC          (1U << __BTREE_TRIGGER_NOATOMIC)
 671
 672 #define BTREE_TRIGGER_WANTS_OLD_AND_NEW         \
 673         ((1U << KEY_TYPE_stripe)|               \
 674          (1U << KEY_TYPE_inode))
 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 /*
 692  * Optional hook that will be called just prior to a btree node update, when
 693  * we're holding the write lock and we know what key is about to be overwritten:
 694  */
 695
 696 enum btree_insert_ret {
 697         BTREE_INSERT_OK,
 698         /* leaf node needs to be split */
 699         BTREE_INSERT_BTREE_NODE_FULL,
 700         BTREE_INSERT_NEED_MARK_REPLICAS,
 701         BTREE_INSERT_NEED_JOURNAL_RES,
 702         BTREE_INSERT_NEED_JOURNAL_RECLAIM,
 703 };
 704
 705 enum btree_gc_coalesce_fail_reason {
 706         BTREE_GC_COALESCE_FAIL_RESERVE_GET,
 707         BTREE_GC_COALESCE_FAIL_KEYLIST_REALLOC,
 708         BTREE_GC_COALESCE_FAIL_FORMAT_FITS,
 709 };
 710
 711 enum btree_node_sibling {
 712         btree_prev_sib,
 713         btree_next_sib,
 714 };
 715
 716 typedef struct btree_nr_keys (*sort_fix_overlapping_fn)(struct bset *,
 717                                                         struct btree *,
 718                                                         struct btree_node_iter *);
 719
 720 #endif /* _BCACHEFS_BTREE_TYPES_H */