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
   8 #include "btree_key_cache_types.h"
   9 #include "buckets_types.h"
  10 #include "darray.h"
  11 #include "errcode.h"
  12 #include "journal_types.h"
  13 #include "replicas_types.h"
  14 #include "six.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 static const __maybe_unused u16 BTREE_ITER_SLOTS                = 1 << 0;
 198 /*
 199  * Indicates that intent locks should be taken on leaf nodes, because we expect
 200  * to be doing updates:
 201  */
 202 static const __maybe_unused u16 BTREE_ITER_INTENT               = 1 << 1;
 203 /*
 204  * Causes the btree iterator code to prefetch additional btree nodes from disk:
 205  */
 206 static const __maybe_unused u16 BTREE_ITER_PREFETCH             = 1 << 2;
 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 static const __maybe_unused u16 BTREE_ITER_IS_EXTENTS           = 1 << 3;
 212 static const __maybe_unused u16 BTREE_ITER_NOT_EXTENTS          = 1 << 4;
 213 static const __maybe_unused u16 BTREE_ITER_CACHED               = 1 << 5;
 214 static const __maybe_unused u16 BTREE_ITER_WITH_KEY_CACHE       = 1 << 6;
 215 static const __maybe_unused u16 BTREE_ITER_WITH_UPDATES         = 1 << 7;
 216 static const __maybe_unused u16 BTREE_ITER_WITH_JOURNAL         = 1 << 8;
 217 static const __maybe_unused u16 __BTREE_ITER_ALL_SNAPSHOTS      = 1 << 9;
 218 static const __maybe_unused u16 BTREE_ITER_ALL_SNAPSHOTS        = 1 << 10;
 219 static const __maybe_unused u16 BTREE_ITER_FILTER_SNAPSHOTS     = 1 << 11;
 220 static const __maybe_unused u16 BTREE_ITER_NOPRESERVE           = 1 << 12;
 221 static const __maybe_unused u16 BTREE_ITER_CACHED_NOFILL        = 1 << 13;
 222 static const __maybe_unused u16 BTREE_ITER_KEY_CACHE_FILL       = 1 << 14;
 223 #define __BTREE_ITER_FLAGS_END                                         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         u32                     alloc_seq;
 241         u32                     downgrade_seq;
 242
 243         /* btree_iter_copy starts here: */
 244         struct bpos             pos;
 245
 246         enum btree_id           btree_id:5;
 247         bool                    cached:1;
 248         bool                    preserve:1;
 249         enum btree_path_uptodate uptodate:2;
 250         /*
 251          * When true, failing to relock this path will cause the transaction to
 252          * restart:
 253          */
 254         bool                    should_be_locked:1;
 255         unsigned                level:3,
 256                                 locks_want:3;
 257         u8                      nodes_locked;
 258
 259         struct btree_path_level {
 260                 struct btree    *b;
 261                 struct btree_node_iter iter;
 262                 u32             lock_seq;
 263 #ifdef CONFIG_BCACHEFS_LOCK_TIME_STATS
 264                 u64             lock_taken_time;
 265 #endif
 266         }                       l[BTREE_MAX_DEPTH];
 267 #ifdef TRACK_PATH_ALLOCATED
 268         unsigned long           ip_allocated;
 269 #endif
 270 };
 271
 272 static inline struct btree_path_level *path_l(struct btree_path *path)
 273 {
 274         return path->l + path->level;
 275 }
 276
 277 static inline unsigned long btree_path_ip_allocated(struct btree_path *path)
 278 {
 279 #ifdef TRACK_PATH_ALLOCATED
 280         return path->ip_allocated;
 281 #else
 282         return _THIS_IP_;
 283 #endif
 284 }
 285
 286 /*
 287  * @pos                 - iterator's current position
 288  * @level               - current btree depth
 289  * @locks_want          - btree level below which we start taking intent locks
 290  * @nodes_locked        - bitmask indicating which nodes in @nodes are locked
 291  * @nodes_intent_locked - bitmask indicating which locks are intent locks
 292  */
 293 struct btree_iter {
 294         struct btree_trans      *trans;
 295         struct btree_path       *path;
 296         struct btree_path       *update_path;
 297         struct btree_path       *key_cache_path;
 298
 299         enum btree_id           btree_id:8;
 300         unsigned                min_depth:3;
 301         unsigned                advanced:1;
 302
 303         /* btree_iter_copy starts here: */
 304         u16                     flags;
 305
 306         /* When we're filtering by snapshot, the snapshot ID we're looking for: */
 307         unsigned                snapshot;
 308
 309         struct bpos             pos;
 310         /*
 311          * Current unpacked key - so that bch2_btree_iter_next()/
 312          * bch2_btree_iter_next_slot() can correctly advance pos.
 313          */
 314         struct bkey             k;
 315
 316         /* BTREE_ITER_WITH_JOURNAL: */
 317         size_t                  journal_idx;
 318         struct bpos             journal_pos;
 319 #ifdef TRACK_PATH_ALLOCATED
 320         unsigned long           ip_allocated;
 321 #endif
 322 };
 323
 324 #define BKEY_CACHED_ACCESSED            0
 325 #define BKEY_CACHED_DIRTY               1
 326
 327 struct bkey_cached {
 328         struct btree_bkey_cached_common c;
 329
 330         unsigned long           flags;
 331         u16                     u64s;
 332         bool                    valid;
 333         u32                     btree_trans_barrier_seq;
 334         struct bkey_cached_key  key;
 335
 336         struct rhash_head       hash;
 337         struct list_head        list;
 338
 339         struct journal_entry_pin journal;
 340         u64                     seq;
 341
 342         struct bkey_i           *k;
 343 };
 344
 345 static inline struct bpos btree_node_pos(struct btree_bkey_cached_common *b)
 346 {
 347         return !b->cached
 348                 ? container_of(b, struct btree, c)->key.k.p
 349                 : container_of(b, struct bkey_cached, c)->key.pos;
 350 }
 351
 352 struct btree_insert_entry {
 353         unsigned                flags;
 354         u8                      bkey_type;
 355         enum btree_id           btree_id:8;
 356         u8                      level:4;
 357         bool                    cached:1;
 358         bool                    insert_trigger_run:1;
 359         bool                    overwrite_trigger_run:1;
 360         bool                    key_cache_already_flushed:1;
 361         /*
 362          * @old_k may be a key from the journal; @old_btree_u64s always refers
 363          * to the size of the key being overwritten in the btree:
 364          */
 365         u8                      old_btree_u64s;
 366         struct bkey_i           *k;
 367         struct btree_path       *path;
 368         /* key being overwritten: */
 369         struct bkey             old_k;
 370         const struct bch_val    *old_v;
 371         unsigned long           ip_allocated;
 372 };
 373
 374 #define BTREE_ITER_MAX          64
 375
 376 struct btree_trans_commit_hook;
 377 typedef int (btree_trans_commit_hook_fn)(struct btree_trans *, struct btree_trans_commit_hook *);
 378
 379 struct btree_trans_commit_hook {
 380         btree_trans_commit_hook_fn      *fn;
 381         struct btree_trans_commit_hook  *next;
 382 };
 383
 384 #define BTREE_TRANS_MEM_MAX     (1U << 16)
 385
 386 #define BTREE_TRANS_MAX_LOCK_HOLD_TIME_NS       10000
 387
 388 struct btree_trans {
 389         struct bch_fs           *c;
 390         const char              *fn;
 391         struct closure          ref;
 392         struct list_head        list;
 393         u64                     last_begin_time;
 394
 395         u8                      lock_may_not_fail;
 396         u8                      lock_must_abort;
 397         struct btree_bkey_cached_common *locking;
 398         struct six_lock_waiter  locking_wait;
 399
 400         int                     srcu_idx;
 401
 402         u8                      fn_idx;
 403         u8                      nr_sorted;
 404         u8                      nr_updates;
 405         u8                      nr_wb_updates;
 406         u8                      wb_updates_size;
 407         bool                    srcu_held:1;
 408         bool                    used_mempool:1;
 409         bool                    in_traverse_all:1;
 410         bool                    paths_sorted:1;
 411         bool                    memory_allocation_failure:1;
 412         bool                    journal_transaction_names:1;
 413         bool                    journal_replay_not_finished:1;
 414         bool                    is_initial_gc:1;
 415         bool                    notrace_relock_fail:1;
 416         bool                    write_locked:1;
 417         enum bch_errcode        restarted:16;
 418         u32                     restart_count;
 419         unsigned long           last_begin_ip;
 420         unsigned long           last_restarted_ip;
 421         unsigned long           srcu_lock_time;
 422
 423         /*
 424          * For when bch2_trans_update notices we'll be splitting a compressed
 425          * extent:
 426          */
 427         unsigned                extra_journal_res;
 428         unsigned                nr_max_paths;
 429
 430         u64                     paths_allocated;
 431
 432         unsigned                mem_top;
 433         unsigned                mem_max;
 434         unsigned                mem_bytes;
 435         void                    *mem;
 436
 437         u8                      sorted[BTREE_ITER_MAX + 8];
 438         struct btree_path       paths[BTREE_ITER_MAX];
 439         struct btree_insert_entry updates[BTREE_ITER_MAX];
 440         struct btree_write_buffered_key *wb_updates;
 441
 442         /* update path: */
 443         struct btree_trans_commit_hook *hooks;
 444         darray_u64              extra_journal_entries;
 445         struct journal_entry_pin *journal_pin;
 446
 447         struct journal_res      journal_res;
 448         u64                     *journal_seq;
 449         struct disk_reservation *disk_res;
 450         unsigned                journal_u64s;
 451         struct replicas_delta_list *fs_usage_deltas;
 452 };
 453
 454 #define BCH_BTREE_WRITE_TYPES()                                         \
 455         x(initial,              0)                                      \
 456         x(init_next_bset,       1)                                      \
 457         x(cache_reclaim,        2)                                      \
 458         x(journal_reclaim,      3)                                      \
 459         x(interior,             4)
 460
 461 enum btree_write_type {
 462 #define x(t, n) BTREE_WRITE_##t,
 463         BCH_BTREE_WRITE_TYPES()
 464 #undef x
 465         BTREE_WRITE_TYPE_NR,
 466 };
 467
 468 #define BTREE_WRITE_TYPE_MASK   (roundup_pow_of_two(BTREE_WRITE_TYPE_NR) - 1)
 469 #define BTREE_WRITE_TYPE_BITS   ilog2(roundup_pow_of_two(BTREE_WRITE_TYPE_NR))
 470
 471 #define BTREE_FLAGS()                                                   \
 472         x(read_in_flight)                                               \
 473         x(read_error)                                                   \
 474         x(dirty)                                                        \
 475         x(need_write)                                                   \
 476         x(write_blocked)                                                \
 477         x(will_make_reachable)                                          \
 478         x(noevict)                                                      \
 479         x(write_idx)                                                    \
 480         x(accessed)                                                     \
 481         x(write_in_flight)                                              \
 482         x(write_in_flight_inner)                                        \
 483         x(just_written)                                                 \
 484         x(dying)                                                        \
 485         x(fake)                                                         \
 486         x(need_rewrite)                                                 \
 487         x(never_write)
 488
 489 enum btree_flags {
 490         /* First bits for btree node write type */
 491         BTREE_NODE_FLAGS_START = BTREE_WRITE_TYPE_BITS - 1,
 492 #define x(flag) BTREE_NODE_##flag,
 493         BTREE_FLAGS()
 494 #undef x
 495 };
 496
 497 #define x(flag)                                                         \
 498 static inline bool btree_node_ ## flag(struct btree *b)                 \
 499 {       return test_bit(BTREE_NODE_ ## flag, &b->flags); }              \
 500                                                                         \
 501 static inline void set_btree_node_ ## flag(struct btree *b)             \
 502 {       set_bit(BTREE_NODE_ ## flag, &b->flags); }                      \
 503                                                                         \
 504 static inline void clear_btree_node_ ## flag(struct btree *b)           \
 505 {       clear_bit(BTREE_NODE_ ## flag, &b->flags); }
 506
 507 BTREE_FLAGS()
 508 #undef x
 509
 510 static inline struct btree_write *btree_current_write(struct btree *b)
 511 {
 512         return b->writes + btree_node_write_idx(b);
 513 }
 514
 515 static inline struct btree_write *btree_prev_write(struct btree *b)
 516 {
 517         return b->writes + (btree_node_write_idx(b) ^ 1);
 518 }
 519
 520 static inline struct bset_tree *bset_tree_last(struct btree *b)
 521 {
 522         EBUG_ON(!b->nsets);
 523         return b->set + b->nsets - 1;
 524 }
 525
 526 static inline void *
 527 __btree_node_offset_to_ptr(const struct btree *b, u16 offset)
 528 {
 529         return (void *) ((u64 *) b->data + 1 + offset);
 530 }
 531
 532 static inline u16
 533 __btree_node_ptr_to_offset(const struct btree *b, const void *p)
 534 {
 535         u16 ret = (u64 *) p - 1 - (u64 *) b->data;
 536
 537         EBUG_ON(__btree_node_offset_to_ptr(b, ret) != p);
 538         return ret;
 539 }
 540
 541 static inline struct bset *bset(const struct btree *b,
 542                                 const struct bset_tree *t)
 543 {
 544         return __btree_node_offset_to_ptr(b, t->data_offset);
 545 }
 546
 547 static inline void set_btree_bset_end(struct btree *b, struct bset_tree *t)
 548 {
 549         t->end_offset =
 550                 __btree_node_ptr_to_offset(b, vstruct_last(bset(b, t)));
 551 }
 552
 553 static inline void set_btree_bset(struct btree *b, struct bset_tree *t,
 554                                   const struct bset *i)
 555 {
 556         t->data_offset = __btree_node_ptr_to_offset(b, i);
 557         set_btree_bset_end(b, t);
 558 }
 559
 560 static inline struct bset *btree_bset_first(struct btree *b)
 561 {
 562         return bset(b, b->set);
 563 }
 564
 565 static inline struct bset *btree_bset_last(struct btree *b)
 566 {
 567         return bset(b, bset_tree_last(b));
 568 }
 569
 570 static inline u16
 571 __btree_node_key_to_offset(const struct btree *b, const struct bkey_packed *k)
 572 {
 573         return __btree_node_ptr_to_offset(b, k);
 574 }
 575
 576 static inline struct bkey_packed *
 577 __btree_node_offset_to_key(const struct btree *b, u16 k)
 578 {
 579         return __btree_node_offset_to_ptr(b, k);
 580 }
 581
 582 static inline unsigned btree_bkey_first_offset(const struct bset_tree *t)
 583 {
 584         return t->data_offset + offsetof(struct bset, _data) / sizeof(u64);
 585 }
 586
 587 #define btree_bkey_first(_b, _t)                                        \
 588 ({                                                                      \
 589         EBUG_ON(bset(_b, _t)->start !=                                  \
 590                 __btree_node_offset_to_key(_b, btree_bkey_first_offset(_t)));\
 591                                                                         \
 592         bset(_b, _t)->start;                                            \
 593 })
 594
 595 #define btree_bkey_last(_b, _t)                                         \
 596 ({                                                                      \
 597         EBUG_ON(__btree_node_offset_to_key(_b, (_t)->end_offset) !=     \
 598                 vstruct_last(bset(_b, _t)));                            \
 599                                                                         \
 600         __btree_node_offset_to_key(_b, (_t)->end_offset);               \
 601 })
 602
 603 static inline unsigned bset_u64s(struct bset_tree *t)
 604 {
 605         return t->end_offset - t->data_offset -
 606                 sizeof(struct bset) / sizeof(u64);
 607 }
 608
 609 static inline unsigned bset_dead_u64s(struct btree *b, struct bset_tree *t)
 610 {
 611         return bset_u64s(t) - b->nr.bset_u64s[t - b->set];
 612 }
 613
 614 static inline unsigned bset_byte_offset(struct btree *b, void *i)
 615 {
 616         return i - (void *) b->data;
 617 }
 618
 619 enum btree_node_type {
 620         BKEY_TYPE_btree,
 621 #define x(kwd, val, ...) BKEY_TYPE_##kwd = val + 1,
 622         BCH_BTREE_IDS()
 623 #undef x
 624         BKEY_TYPE_NR
 625 };
 626
 627 /* Type of a key in btree @id at level @level: */
 628 static inline enum btree_node_type __btree_node_type(unsigned level, enum btree_id id)
 629 {
 630         return level ? BKEY_TYPE_btree : (unsigned) id + 1;
 631 }
 632
 633 /* Type of keys @b contains: */
 634 static inline enum btree_node_type btree_node_type(struct btree *b)
 635 {
 636         return __btree_node_type(b->c.level, b->c.btree_id);
 637 }
 638
 639 const char *bch2_btree_node_type_str(enum btree_node_type);
 640
 641 #define BTREE_NODE_TYPE_HAS_TRANS_TRIGGERS              \
 642         (BIT_ULL(BKEY_TYPE_extents)|                    \
 643          BIT_ULL(BKEY_TYPE_alloc)|                      \
 644          BIT_ULL(BKEY_TYPE_inodes)|                     \
 645          BIT_ULL(BKEY_TYPE_stripes)|                    \
 646          BIT_ULL(BKEY_TYPE_reflink)|                    \
 647          BIT_ULL(BKEY_TYPE_btree))
 648
 649 #define BTREE_NODE_TYPE_HAS_MEM_TRIGGERS                \
 650         (BIT_ULL(BKEY_TYPE_alloc)|                      \
 651          BIT_ULL(BKEY_TYPE_inodes)|                     \
 652          BIT_ULL(BKEY_TYPE_stripes)|                    \
 653          BIT_ULL(BKEY_TYPE_snapshots))
 654
 655 #define BTREE_NODE_TYPE_HAS_TRIGGERS                    \
 656         (BTREE_NODE_TYPE_HAS_TRANS_TRIGGERS|            \
 657          BTREE_NODE_TYPE_HAS_MEM_TRIGGERS)
 658
 659 static inline bool btree_node_type_needs_gc(enum btree_node_type type)
 660 {
 661         return BTREE_NODE_TYPE_HAS_TRIGGERS & BIT_ULL(type);
 662 }
 663
 664 static inline bool btree_node_type_is_extents(enum btree_node_type type)
 665 {
 666         const unsigned mask = 0
 667 #define x(name, nr, flags, ...) |((!!((flags) & BTREE_ID_EXTENTS)) << (nr + 1))
 668         BCH_BTREE_IDS()
 669 #undef x
 670         ;
 671
 672         return (1U << type) & mask;
 673 }
 674
 675 static inline bool btree_id_is_extents(enum btree_id btree)
 676 {
 677         return btree_node_type_is_extents(__btree_node_type(0, btree));
 678 }
 679
 680 static inline bool btree_type_has_snapshots(enum btree_id id)
 681 {
 682         const unsigned mask = 0
 683 #define x(name, nr, flags, ...) |((!!((flags) & BTREE_ID_SNAPSHOTS)) << nr)
 684         BCH_BTREE_IDS()
 685 #undef x
 686         ;
 687
 688         return (1U << id) & mask;
 689 }
 690
 691 static inline bool btree_type_has_snapshot_field(enum btree_id id)
 692 {
 693         const unsigned mask = 0
 694 #define x(name, nr, flags, ...) |((!!((flags) & (BTREE_ID_SNAPSHOT_FIELD|BTREE_ID_SNAPSHOTS))) << nr)
 695         BCH_BTREE_IDS()
 696 #undef x
 697         ;
 698
 699         return (1U << id) & mask;
 700 }
 701
 702 static inline bool btree_type_has_ptrs(enum btree_id id)
 703 {
 704         const unsigned mask = 0
 705 #define x(name, nr, flags, ...) |((!!((flags) & BTREE_ID_DATA)) << nr)
 706         BCH_BTREE_IDS()
 707 #undef x
 708         ;
 709
 710         return (1U << id) & mask;
 711 }
 712
 713 struct btree_root {
 714         struct btree            *b;
 715
 716         /* On disk root - see async splits: */
 717         __BKEY_PADDED(key, BKEY_BTREE_PTR_VAL_U64s_MAX);
 718         u8                      level;
 719         u8                      alive;
 720         s8                      error;
 721 };
 722
 723 enum btree_gc_coalesce_fail_reason {
 724         BTREE_GC_COALESCE_FAIL_RESERVE_GET,
 725         BTREE_GC_COALESCE_FAIL_KEYLIST_REALLOC,
 726         BTREE_GC_COALESCE_FAIL_FORMAT_FITS,
 727 };
 728
 729 enum btree_node_sibling {
 730         btree_prev_sib,
 731         btree_next_sib,
 732 };
 733
 734 #endif /* _BCACHEFS_BTREE_TYPES_H */