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