git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/bcachefs_format.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _BCACHEFS_FORMAT_H
   3 #define _BCACHEFS_FORMAT_H
   4
   5 /*
   6  * bcachefs on disk data structures
   7  *
   8  * OVERVIEW:
   9  *
  10  * There are three main types of on disk data structures in bcachefs (this is
  11  * reduced from 5 in bcache)
  12  *
  13  *  - superblock
  14  *  - journal
  15  *  - btree
  16  *
  17  * The btree is the primary structure; most metadata exists as keys in the
  18  * various btrees. There are only a small number of btrees, they're not
  19  * sharded - we have one btree for extents, another for inodes, et cetera.
  20  *
  21  * SUPERBLOCK:
  22  *
  23  * The superblock contains the location of the journal, the list of devices in
  24  * the filesystem, and in general any metadata we need in order to decide
  25  * whether we can start a filesystem or prior to reading the journal/btree
  26  * roots.
  27  *
  28  * The superblock is extensible, and most of the contents of the superblock are
  29  * in variable length, type tagged fields; see struct bch_sb_field.
  30  *
  31  * Backup superblocks do not reside in a fixed location; also, superblocks do
  32  * not have a fixed size. To locate backup superblocks we have struct
  33  * bch_sb_layout; we store a copy of this inside every superblock, and also
  34  * before the first superblock.
  35  *
  36  * JOURNAL:
  37  *
  38  * The journal primarily records btree updates in the order they occurred;
  39  * journal replay consists of just iterating over all the keys in the open
  40  * journal entries and re-inserting them into the btrees.
  41  *
  42  * The journal also contains entry types for the btree roots, and blacklisted
  43  * journal sequence numbers (see journal_seq_blacklist.c).
  44  *
  45  * BTREE:
  46  *
  47  * bcachefs btrees are copy on write b+ trees, where nodes are big (typically
  48  * 128k-256k) and log structured. We use struct btree_node for writing the first
  49  * entry in a given node (offset 0), and struct btree_node_entry for all
  50  * subsequent writes.
  51  *
  52  * After the header, btree node entries contain a list of keys in sorted order.
  53  * Values are stored inline with the keys; since values are variable length (and
  54  * keys effectively are variable length too, due to packing) we can't do random
  55  * access without building up additional in memory tables in the btree node read
  56  * path.
  57  *
  58  * BTREE KEYS (struct bkey):
  59  *
  60  * The various btrees share a common format for the key - so as to avoid
  61  * switching in fastpath lookup/comparison code - but define their own
  62  * structures for the key values.
  63  *
  64  * The size of a key/value pair is stored as a u8 in units of u64s, so the max
  65  * size is just under 2k. The common part also contains a type tag for the
  66  * value, and a format field indicating whether the key is packed or not (and
  67  * also meant to allow adding new key fields in the future, if desired).
  68  *
  69  * bkeys, when stored within a btree node, may also be packed. In that case, the
  70  * bkey_format in that node is used to unpack it. Packed bkeys mean that we can
  71  * be generous with field sizes in the common part of the key format (64 bit
  72  * inode number, 64 bit offset, 96 bit version field, etc.) for negligible cost.
  73  */
  74
  75 #include <asm/types.h>
  76 #include <asm/byteorder.h>
  77 #include <linux/kernel.h>
  78 #include <linux/uuid.h>
  79
  80 #define LE_BITMASK(_bits, name, type, field, offset, end)               \
  81 static const unsigned   name##_OFFSET = offset;                         \
  82 static const unsigned   name##_BITS = (end - offset);                   \
  83 static const __u##_bits name##_MAX = (1ULL << (end - offset)) - 1;      \
  84                                                                         \
  85 static inline __u64 name(const type *k)                                 \
  86 {                                                                       \
  87         return (__le##_bits##_to_cpu(k->field) >> offset) &             \
  88                 ~(~0ULL << (end - offset));                             \
  89 }                                                                       \
  90                                                                         \
  91 static inline void SET_##name(type *k, __u64 v)                         \
  92 {                                                                       \
  93         __u##_bits new = __le##_bits##_to_cpu(k->field);                \
  94                                                                         \
  95         new &= ~(~(~0ULL << (end - offset)) << offset);                 \
  96         new |= (v & ~(~0ULL << (end - offset))) << offset;              \
  97         k->field = __cpu_to_le##_bits(new);                             \
  98 }
  99
 100 #define LE16_BITMASK(n, t, f, o, e)     LE_BITMASK(16, n, t, f, o, e)
 101 #define LE32_BITMASK(n, t, f, o, e)     LE_BITMASK(32, n, t, f, o, e)
 102 #define LE64_BITMASK(n, t, f, o, e)     LE_BITMASK(64, n, t, f, o, e)
 103
 104 struct bkey_format {
 105         __u8            key_u64s;
 106         __u8            nr_fields;
 107         /* One unused slot for now: */
 108         __u8            bits_per_field[6];
 109         __le64          field_offset[6];
 110 };
 111
 112 /* Btree keys - all units are in sectors */
 113
 114 struct bpos {
 115         /*
 116          * Word order matches machine byte order - btree code treats a bpos as a
 117          * single large integer, for search/comparison purposes
 118          *
 119          * Note that wherever a bpos is embedded in another on disk data
 120          * structure, it has to be byte swabbed when reading in metadata that
 121          * wasn't written in native endian order:
 122          */
 123 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
 124         __u32           snapshot;
 125         __u64           offset;
 126         __u64           inode;
 127 #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 128         __u64           inode;
 129         __u64           offset;         /* Points to end of extent - sectors */
 130         __u32           snapshot;
 131 #else
 132 #error edit for your odd byteorder.
 133 #endif
 134 } __attribute__((packed, aligned(4)));
 135
 136 #define KEY_INODE_MAX                   ((__u64)~0ULL)
 137 #define KEY_OFFSET_MAX                  ((__u64)~0ULL)
 138 #define KEY_SNAPSHOT_MAX                ((__u32)~0U)
 139 #define KEY_SIZE_MAX                    ((__u32)~0U)
 140
 141 static inline struct bpos POS(__u64 inode, __u64 offset)
 142 {
 143         struct bpos ret;
 144
 145         ret.inode       = inode;
 146         ret.offset      = offset;
 147         ret.snapshot    = 0;
 148
 149         return ret;
 150 }
 151
 152 #define POS_MIN                         POS(0, 0)
 153 #define POS_MAX                         POS(KEY_INODE_MAX, KEY_OFFSET_MAX)
 154
 155 /* Empty placeholder struct, for container_of() */
 156 struct bch_val {
 157         __u64           __nothing[0];
 158 };
 159
 160 struct bversion {
 161 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
 162         __u64           lo;
 163         __u32           hi;
 164 #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 165         __u32           hi;
 166         __u64           lo;
 167 #endif
 168 } __attribute__((packed, aligned(4)));
 169
 170 struct bkey {
 171         /* Size of combined key and value, in u64s */
 172         __u8            u64s;
 173
 174         /* Format of key (0 for format local to btree node) */
 175 #if defined(__LITTLE_ENDIAN_BITFIELD)
 176         __u8            format:7,
 177                         needs_whiteout:1;
 178 #elif defined (__BIG_ENDIAN_BITFIELD)
 179         __u8            needs_whiteout:1,
 180                         format:7;
 181 #else
 182 #error edit for your odd byteorder.
 183 #endif
 184
 185         /* Type of the value */
 186         __u8            type;
 187
 188 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
 189         __u8            pad[1];
 190
 191         struct bversion version;
 192         __u32           size;           /* extent size, in sectors */
 193         struct bpos     p;
 194 #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
 195         struct bpos     p;
 196         __u32           size;           /* extent size, in sectors */
 197         struct bversion version;
 198
 199         __u8            pad[1];
 200 #endif
 201 } __attribute__((packed, aligned(8)));
 202
 203 struct bkey_packed {
 204         __u64           _data[0];
 205
 206         /* Size of combined key and value, in u64s */
 207         __u8            u64s;
 208
 209         /* Format of key (0 for format local to btree node) */
 210
 211         /*
 212          * XXX: next incompat on disk format change, switch format and
 213          * needs_whiteout - bkey_packed() will be cheaper if format is the high
 214          * bits of the bitfield
 215          */
 216 #if defined(__LITTLE_ENDIAN_BITFIELD)
 217         __u8            format:7,
 218                         needs_whiteout:1;
 219 #elif defined (__BIG_ENDIAN_BITFIELD)
 220         __u8            needs_whiteout:1,
 221                         format:7;
 222 #endif
 223
 224         /* Type of the value */
 225         __u8            type;
 226         __u8            key_start[0];
 227
 228         /*
 229          * We copy bkeys with struct assignment in various places, and while
 230          * that shouldn't be done with packed bkeys we can't disallow it in C,
 231          * and it's legal to cast a bkey to a bkey_packed  - so padding it out
 232          * to the same size as struct bkey should hopefully be safest.
 233          */
 234         __u8            pad[sizeof(struct bkey) - 3];
 235 } __attribute__((packed, aligned(8)));
 236
 237 #define BKEY_U64s                       (sizeof(struct bkey) / sizeof(__u64))
 238 #define BKEY_U64s_MAX                   U8_MAX
 239 #define BKEY_VAL_U64s_MAX               (BKEY_U64s_MAX - BKEY_U64s)
 240
 241 #define KEY_PACKED_BITS_START           24
 242
 243 #define KEY_FORMAT_LOCAL_BTREE          0
 244 #define KEY_FORMAT_CURRENT              1
 245
 246 enum bch_bkey_fields {
 247         BKEY_FIELD_INODE,
 248         BKEY_FIELD_OFFSET,
 249         BKEY_FIELD_SNAPSHOT,
 250         BKEY_FIELD_SIZE,
 251         BKEY_FIELD_VERSION_HI,
 252         BKEY_FIELD_VERSION_LO,
 253         BKEY_NR_FIELDS,
 254 };
 255
 256 #define bkey_format_field(name, field)                                  \
 257         [BKEY_FIELD_##name] = (sizeof(((struct bkey *) NULL)->field) * 8)
 258
 259 #define BKEY_FORMAT_CURRENT                                             \
 260 ((struct bkey_format) {                                                 \
 261         .key_u64s       = BKEY_U64s,                                    \
 262         .nr_fields      = BKEY_NR_FIELDS,                               \
 263         .bits_per_field = {                                             \
 264                 bkey_format_field(INODE,        p.inode),               \
 265                 bkey_format_field(OFFSET,       p.offset),              \
 266                 bkey_format_field(SNAPSHOT,     p.snapshot),            \
 267                 bkey_format_field(SIZE,         size),                  \
 268                 bkey_format_field(VERSION_HI,   version.hi),            \
 269                 bkey_format_field(VERSION_LO,   version.lo),            \
 270         },                                                              \
 271 })
 272
 273 /* bkey with inline value */
 274 struct bkey_i {
 275         __u64                   _data[0];
 276
 277         union {
 278         struct {
 279                 /* Size of combined key and value, in u64s */
 280                 __u8            u64s;
 281         };
 282         struct {
 283                 struct bkey     k;
 284                 struct bch_val  v;
 285         };
 286         };
 287 };
 288
 289 #define KEY(_inode, _offset, _size)                                     \
 290 ((struct bkey) {                                                        \
 291         .u64s           = BKEY_U64s,                                    \
 292         .format         = KEY_FORMAT_CURRENT,                           \
 293         .p              = POS(_inode, _offset),                         \
 294         .size           = _size,                                        \
 295 })
 296
 297 static inline void bkey_init(struct bkey *k)
 298 {
 299         *k = KEY(0, 0, 0);
 300 }
 301
 302 #define bkey_bytes(_k)          ((_k)->u64s * sizeof(__u64))
 303
 304 #define __BKEY_PADDED(key, pad)                                 \
 305         struct { struct bkey_i key; __u64 key ## _pad[pad]; }
 306
 307 /*
 308  * - DELETED keys are used internally to mark keys that should be ignored but
 309  *   override keys in composition order.  Their version number is ignored.
 310  *
 311  * - DISCARDED keys indicate that the data is all 0s because it has been
 312  *   discarded. DISCARDs may have a version; if the version is nonzero the key
 313  *   will be persistent, otherwise the key will be dropped whenever the btree
 314  *   node is rewritten (like DELETED keys).
 315  *
 316  * - ERROR: any read of the data returns a read error, as the data was lost due
 317  *   to a failing device. Like DISCARDED keys, they can be removed (overridden)
 318  *   by new writes or cluster-wide GC. Node repair can also overwrite them with
 319  *   the same or a more recent version number, but not with an older version
 320  *   number.
 321  *
 322  * - WHITEOUT: for hash table btrees
 323 */
 324 #define BCH_BKEY_TYPES()                                \
 325         x(deleted,              0)                      \
 326         x(discard,              1)                      \
 327         x(error,                2)                      \
 328         x(cookie,               3)                      \
 329         x(whiteout,             4)                      \
 330         x(btree_ptr,            5)                      \
 331         x(extent,               6)                      \
 332         x(reservation,          7)                      \
 333         x(inode,                8)                      \
 334         x(inode_generation,     9)                      \
 335         x(dirent,               10)                     \
 336         x(xattr,                11)                     \
 337         x(alloc,                12)                     \
 338         x(quota,                13)                     \
 339         x(stripe,               14)                     \
 340         x(reflink_p,            15)                     \
 341         x(reflink_v,            16)                     \
 342         x(inline_data,          17)                     \
 343         x(btree_ptr_v2,         18)                     \
 344         x(indirect_inline_data, 19)
 345
 346 enum bch_bkey_type {
 347 #define x(name, nr) KEY_TYPE_##name     = nr,
 348         BCH_BKEY_TYPES()
 349 #undef x
 350         KEY_TYPE_MAX,
 351 };
 352
 353 struct bch_cookie {
 354         struct bch_val          v;
 355         __le64                  cookie;
 356 };
 357
 358 /* Extents */
 359
 360 /*
 361  * In extent bkeys, the value is a list of pointers (bch_extent_ptr), optionally
 362  * preceded by checksum/compression information (bch_extent_crc32 or
 363  * bch_extent_crc64).
 364  *
 365  * One major determining factor in the format of extents is how we handle and
 366  * represent extents that have been partially overwritten and thus trimmed:
 367  *
 368  * If an extent is not checksummed or compressed, when the extent is trimmed we
 369  * don't have to remember the extent we originally allocated and wrote: we can
 370  * merely adjust ptr->offset to point to the start of the data that is currently
 371  * live. The size field in struct bkey records the current (live) size of the
 372  * extent, and is also used to mean "size of region on disk that we point to" in
 373  * this case.
 374  *
 375  * Thus an extent that is not checksummed or compressed will consist only of a
 376  * list of bch_extent_ptrs, with none of the fields in
 377  * bch_extent_crc32/bch_extent_crc64.
 378  *
 379  * When an extent is checksummed or compressed, it's not possible to read only
 380  * the data that is currently live: we have to read the entire extent that was
 381  * originally written, and then return only the part of the extent that is
 382  * currently live.
 383  *
 384  * Thus, in addition to the current size of the extent in struct bkey, we need
 385  * to store the size of the originally allocated space - this is the
 386  * compressed_size and uncompressed_size fields in bch_extent_crc32/64. Also,
 387  * when the extent is trimmed, instead of modifying the offset field of the
 388  * pointer, we keep a second smaller offset field - "offset into the original
 389  * extent of the currently live region".
 390  *
 391  * The other major determining factor is replication and data migration:
 392  *
 393  * Each pointer may have its own bch_extent_crc32/64. When doing a replicated
 394  * write, we will initially write all the replicas in the same format, with the
 395  * same checksum type and compression format - however, when copygc runs later (or
 396  * tiering/cache promotion, anything that moves data), it is not in general
 397  * going to rewrite all the pointers at once - one of the replicas may be in a
 398  * bucket on one device that has very little fragmentation while another lives
 399  * in a bucket that has become heavily fragmented, and thus is being rewritten
 400  * sooner than the rest.
 401  *
 402  * Thus it will only move a subset of the pointers (or in the case of
 403  * tiering/cache promotion perhaps add a single pointer without dropping any
 404  * current pointers), and if the extent has been partially overwritten it must
 405  * write only the currently live portion (or copygc would not be able to reduce
 406  * fragmentation!) - which necessitates a different bch_extent_crc format for
 407  * the new pointer.
 408  *
 409  * But in the interests of space efficiency, we don't want to store one
 410  * bch_extent_crc for each pointer if we don't have to.
 411  *
 412  * Thus, a bch_extent consists of bch_extent_crc32s, bch_extent_crc64s, and
 413  * bch_extent_ptrs appended arbitrarily one after the other. We determine the
 414  * type of a given entry with a scheme similar to utf8 (except we're encoding a
 415  * type, not a size), encoding the type in the position of the first set bit:
 416  *
 417  * bch_extent_crc32     - 0b1
 418  * bch_extent_ptr       - 0b10
 419  * bch_extent_crc64     - 0b100
 420  *
 421  * We do it this way because bch_extent_crc32 is _very_ constrained on bits (and
 422  * bch_extent_crc64 is the least constrained).
 423  *
 424  * Then, each bch_extent_crc32/64 applies to the pointers that follow after it,
 425  * until the next bch_extent_crc32/64.
 426  *
 427  * If there are no bch_extent_crcs preceding a bch_extent_ptr, then that pointer
 428  * is neither checksummed nor compressed.
 429  */
 430
 431 /* 128 bits, sufficient for cryptographic MACs: */
 432 struct bch_csum {
 433         __le64                  lo;
 434         __le64                  hi;
 435 } __attribute__((packed, aligned(8)));
 436
 437 #define BCH_EXTENT_ENTRY_TYPES()                \
 438         x(ptr,                  0)              \
 439         x(crc32,                1)              \
 440         x(crc64,                2)              \
 441         x(crc128,               3)              \
 442         x(stripe_ptr,           4)
 443 #define BCH_EXTENT_ENTRY_MAX    5
 444
 445 enum bch_extent_entry_type {
 446 #define x(f, n) BCH_EXTENT_ENTRY_##f = n,
 447         BCH_EXTENT_ENTRY_TYPES()
 448 #undef x
 449 };
 450
 451 /* Compressed/uncompressed size are stored biased by 1: */
 452 struct bch_extent_crc32 {
 453 #if defined(__LITTLE_ENDIAN_BITFIELD)
 454         __u32                   type:2,
 455                                 _compressed_size:7,
 456                                 _uncompressed_size:7,
 457                                 offset:7,
 458                                 _unused:1,
 459                                 csum_type:4,
 460                                 compression_type:4;
 461         __u32                   csum;
 462 #elif defined (__BIG_ENDIAN_BITFIELD)
 463         __u32                   csum;
 464         __u32                   compression_type:4,
 465                                 csum_type:4,
 466                                 _unused:1,
 467                                 offset:7,
 468                                 _uncompressed_size:7,
 469                                 _compressed_size:7,
 470                                 type:2;
 471 #endif
 472 } __attribute__((packed, aligned(8)));
 473
 474 #define CRC32_SIZE_MAX          (1U << 7)
 475 #define CRC32_NONCE_MAX         0
 476
 477 struct bch_extent_crc64 {
 478 #if defined(__LITTLE_ENDIAN_BITFIELD)
 479         __u64                   type:3,
 480                                 _compressed_size:9,
 481                                 _uncompressed_size:9,
 482                                 offset:9,
 483                                 nonce:10,
 484                                 csum_type:4,
 485                                 compression_type:4,
 486                                 csum_hi:16;
 487 #elif defined (__BIG_ENDIAN_BITFIELD)
 488         __u64                   csum_hi:16,
 489                                 compression_type:4,
 490                                 csum_type:4,
 491                                 nonce:10,
 492                                 offset:9,
 493                                 _uncompressed_size:9,
 494                                 _compressed_size:9,
 495                                 type:3;
 496 #endif
 497         __u64                   csum_lo;
 498 } __attribute__((packed, aligned(8)));
 499
 500 #define CRC64_SIZE_MAX          (1U << 9)
 501 #define CRC64_NONCE_MAX         ((1U << 10) - 1)
 502
 503 struct bch_extent_crc128 {
 504 #if defined(__LITTLE_ENDIAN_BITFIELD)
 505         __u64                   type:4,
 506                                 _compressed_size:13,
 507                                 _uncompressed_size:13,
 508                                 offset:13,
 509                                 nonce:13,
 510                                 csum_type:4,
 511                                 compression_type:4;
 512 #elif defined (__BIG_ENDIAN_BITFIELD)
 513         __u64                   compression_type:4,
 514                                 csum_type:4,
 515                                 nonce:13,
 516                                 offset:13,
 517                                 _uncompressed_size:13,
 518                                 _compressed_size:13,
 519                                 type:4;
 520 #endif
 521         struct bch_csum         csum;
 522 } __attribute__((packed, aligned(8)));
 523
 524 #define CRC128_SIZE_MAX         (1U << 13)
 525 #define CRC128_NONCE_MAX        ((1U << 13) - 1)
 526
 527 /*
 528  * @reservation - pointer hasn't been written to, just reserved
 529  */
 530 struct bch_extent_ptr {
 531 #if defined(__LITTLE_ENDIAN_BITFIELD)
 532         __u64                   type:1,
 533                                 cached:1,
 534                                 unused:1,
 535                                 reservation:1,
 536                                 offset:44, /* 8 petabytes */
 537                                 dev:8,
 538                                 gen:8;
 539 #elif defined (__BIG_ENDIAN_BITFIELD)
 540         __u64                   gen:8,
 541                                 dev:8,
 542                                 offset:44,
 543                                 reservation:1,
 544                                 unused:1,
 545                                 cached:1,
 546                                 type:1;
 547 #endif
 548 } __attribute__((packed, aligned(8)));
 549
 550 struct bch_extent_stripe_ptr {
 551 #if defined(__LITTLE_ENDIAN_BITFIELD)
 552         __u64                   type:5,
 553                                 block:8,
 554                                 idx:51;
 555 #elif defined (__BIG_ENDIAN_BITFIELD)
 556         __u64                   idx:51,
 557                                 block:8,
 558                                 type:5;
 559 #endif
 560 };
 561
 562 struct bch_extent_reservation {
 563 #if defined(__LITTLE_ENDIAN_BITFIELD)
 564         __u64                   type:6,
 565                                 unused:22,
 566                                 replicas:4,
 567                                 generation:32;
 568 #elif defined (__BIG_ENDIAN_BITFIELD)
 569         __u64                   generation:32,
 570                                 replicas:4,
 571                                 unused:22,
 572                                 type:6;
 573 #endif
 574 };
 575
 576 union bch_extent_entry {
 577 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ ||  __BITS_PER_LONG == 64
 578         unsigned long                   type;
 579 #elif __BITS_PER_LONG == 32
 580         struct {
 581                 unsigned long           pad;
 582                 unsigned long           type;
 583         };
 584 #else
 585 #error edit for your odd byteorder.
 586 #endif
 587
 588 #define x(f, n) struct bch_extent_##f   f;
 589         BCH_EXTENT_ENTRY_TYPES()
 590 #undef x
 591 };
 592
 593 struct bch_btree_ptr {
 594         struct bch_val          v;
 595
 596         struct bch_extent_ptr   start[0];
 597         __u64                   _data[0];
 598 } __attribute__((packed, aligned(8)));
 599
 600 struct bch_btree_ptr_v2 {
 601         struct bch_val          v;
 602
 603         __u64                   mem_ptr;
 604         __le64                  seq;
 605         __le16                  sectors_written;
 606         /* In case we ever decide to do variable size btree nodes: */
 607         __le16                  sectors;
 608         struct bpos             min_key;
 609         struct bch_extent_ptr   start[0];
 610         __u64                   _data[0];
 611 } __attribute__((packed, aligned(8)));
 612
 613 struct bch_extent {
 614         struct bch_val          v;
 615
 616         union bch_extent_entry  start[0];
 617         __u64                   _data[0];
 618 } __attribute__((packed, aligned(8)));
 619
 620 struct bch_reservation {
 621         struct bch_val          v;
 622
 623         __le32                  generation;
 624         __u8                    nr_replicas;
 625         __u8                    pad[3];
 626 } __attribute__((packed, aligned(8)));
 627
 628 /* Maximum size (in u64s) a single pointer could be: */
 629 #define BKEY_EXTENT_PTR_U64s_MAX\
 630         ((sizeof(struct bch_extent_crc128) +                    \
 631           sizeof(struct bch_extent_ptr)) / sizeof(u64))
 632
 633 /* Maximum possible size of an entire extent value: */
 634 #define BKEY_EXTENT_VAL_U64s_MAX                                \
 635         (1 + BKEY_EXTENT_PTR_U64s_MAX * (BCH_REPLICAS_MAX + 1))
 636
 637 #define BKEY_PADDED(key)        __BKEY_PADDED(key, BKEY_EXTENT_VAL_U64s_MAX)
 638
 639 /* * Maximum possible size of an entire extent, key + value: */
 640 #define BKEY_EXTENT_U64s_MAX            (BKEY_U64s + BKEY_EXTENT_VAL_U64s_MAX)
 641
 642 /* Btree pointers don't carry around checksums: */
 643 #define BKEY_BTREE_PTR_VAL_U64s_MAX                             \
 644         ((sizeof(struct bch_btree_ptr_v2) +                     \
 645           sizeof(struct bch_extent_ptr) * BCH_REPLICAS_MAX) / sizeof(u64))
 646 #define BKEY_BTREE_PTR_U64s_MAX                                 \
 647         (BKEY_U64s + BKEY_BTREE_PTR_VAL_U64s_MAX)
 648
 649 /* Inodes */
 650
 651 #define BLOCKDEV_INODE_MAX      4096
 652
 653 #define BCACHEFS_ROOT_INO       4096
 654
 655 struct bch_inode {
 656         struct bch_val          v;
 657
 658         __le64                  bi_hash_seed;
 659         __le32                  bi_flags;
 660         __le16                  bi_mode;
 661         __u8                    fields[0];
 662 } __attribute__((packed, aligned(8)));
 663
 664 struct bch_inode_generation {
 665         struct bch_val          v;
 666
 667         __le32                  bi_generation;
 668         __le32                  pad;
 669 } __attribute__((packed, aligned(8)));
 670
 671 #define BCH_INODE_FIELDS()                      \
 672         x(bi_atime,                     96)     \
 673         x(bi_ctime,                     96)     \
 674         x(bi_mtime,                     96)     \
 675         x(bi_otime,                     96)     \
 676         x(bi_size,                      64)     \
 677         x(bi_sectors,                   64)     \
 678         x(bi_uid,                       32)     \
 679         x(bi_gid,                       32)     \
 680         x(bi_nlink,                     32)     \
 681         x(bi_generation,                32)     \
 682         x(bi_dev,                       32)     \
 683         x(bi_data_checksum,             8)      \
 684         x(bi_compression,               8)      \
 685         x(bi_project,                   32)     \
 686         x(bi_background_compression,    8)      \
 687         x(bi_data_replicas,             8)      \
 688         x(bi_promote_target,            16)     \
 689         x(bi_foreground_target,         16)     \
 690         x(bi_background_target,         16)     \
 691         x(bi_erasure_code,              16)     \
 692         x(bi_fields_set,                16)
 693
 694 /* subset of BCH_INODE_FIELDS */
 695 #define BCH_INODE_OPTS()                        \
 696         x(data_checksum,                8)      \
 697         x(compression,                  8)      \
 698         x(project,                      32)     \
 699         x(background_compression,       8)      \
 700         x(data_replicas,                8)      \
 701         x(promote_target,               16)     \
 702         x(foreground_target,            16)     \
 703         x(background_target,            16)     \
 704         x(erasure_code,                 16)
 705
 706 enum inode_opt_id {
 707 #define x(name, ...)                            \
 708         Inode_opt_##name,
 709         BCH_INODE_OPTS()
 710 #undef  x
 711         Inode_opt_nr,
 712 };
 713
 714 enum {
 715         /*
 716          * User flags (get/settable with FS_IOC_*FLAGS, correspond to FS_*_FL
 717          * flags)
 718          */
 719         __BCH_INODE_SYNC        = 0,
 720         __BCH_INODE_IMMUTABLE   = 1,
 721         __BCH_INODE_APPEND      = 2,
 722         __BCH_INODE_NODUMP      = 3,
 723         __BCH_INODE_NOATIME     = 4,
 724
 725         __BCH_INODE_I_SIZE_DIRTY= 5,
 726         __BCH_INODE_I_SECTORS_DIRTY= 6,
 727         __BCH_INODE_UNLINKED    = 7,
 728
 729         /* bits 20+ reserved for packed fields below: */
 730 };
 731
 732 #define BCH_INODE_SYNC          (1 << __BCH_INODE_SYNC)
 733 #define BCH_INODE_IMMUTABLE     (1 << __BCH_INODE_IMMUTABLE)
 734 #define BCH_INODE_APPEND        (1 << __BCH_INODE_APPEND)
 735 #define BCH_INODE_NODUMP        (1 << __BCH_INODE_NODUMP)
 736 #define BCH_INODE_NOATIME       (1 << __BCH_INODE_NOATIME)
 737 #define BCH_INODE_I_SIZE_DIRTY  (1 << __BCH_INODE_I_SIZE_DIRTY)
 738 #define BCH_INODE_I_SECTORS_DIRTY (1 << __BCH_INODE_I_SECTORS_DIRTY)
 739 #define BCH_INODE_UNLINKED      (1 << __BCH_INODE_UNLINKED)
 740
 741 LE32_BITMASK(INODE_STR_HASH,    struct bch_inode, bi_flags, 20, 24);
 742 LE32_BITMASK(INODE_NR_FIELDS,   struct bch_inode, bi_flags, 24, 31);
 743 LE32_BITMASK(INODE_NEW_VARINT,  struct bch_inode, bi_flags, 31, 32);
 744
 745 /* Dirents */
 746
 747 /*
 748  * Dirents (and xattrs) have to implement string lookups; since our b-tree
 749  * doesn't support arbitrary length strings for the key, we instead index by a
 750  * 64 bit hash (currently truncated sha1) of the string, stored in the offset
 751  * field of the key - using linear probing to resolve hash collisions. This also
 752  * provides us with the readdir cookie posix requires.
 753  *
 754  * Linear probing requires us to use whiteouts for deletions, in the event of a
 755  * collision:
 756  */
 757
 758 struct bch_dirent {
 759         struct bch_val          v;
 760
 761         /* Target inode number: */
 762         __le64                  d_inum;
 763
 764         /*
 765          * Copy of mode bits 12-15 from the target inode - so userspace can get
 766          * the filetype without having to do a stat()
 767          */
 768         __u8                    d_type;
 769
 770         __u8                    d_name[];
 771 } __attribute__((packed, aligned(8)));
 772
 773 #define BCH_NAME_MAX    (U8_MAX * sizeof(u64) -                         \
 774                          sizeof(struct bkey) -                          \
 775                          offsetof(struct bch_dirent, d_name))
 776
 777
 778 /* Xattrs */
 779
 780 #define KEY_TYPE_XATTR_INDEX_USER                       0
 781 #define KEY_TYPE_XATTR_INDEX_POSIX_ACL_ACCESS   1
 782 #define KEY_TYPE_XATTR_INDEX_POSIX_ACL_DEFAULT  2
 783 #define KEY_TYPE_XATTR_INDEX_TRUSTED                    3
 784 #define KEY_TYPE_XATTR_INDEX_SECURITY           4
 785
 786 struct bch_xattr {
 787         struct bch_val          v;
 788         __u8                    x_type;
 789         __u8                    x_name_len;
 790         __le16                  x_val_len;
 791         __u8                    x_name[];
 792 } __attribute__((packed, aligned(8)));
 793
 794 /* Bucket/allocation information: */
 795
 796 struct bch_alloc {
 797         struct bch_val          v;
 798         __u8                    fields;
 799         __u8                    gen;
 800         __u8                    data[];
 801 } __attribute__((packed, aligned(8)));
 802
 803 #define BCH_ALLOC_FIELDS()                      \
 804         x(read_time,            16)             \
 805         x(write_time,           16)             \
 806         x(data_type,            8)              \
 807         x(dirty_sectors,        16)             \
 808         x(cached_sectors,       16)             \
 809         x(oldest_gen,           8)
 810
 811 enum {
 812 #define x(name, bytes) BCH_ALLOC_FIELD_##name,
 813         BCH_ALLOC_FIELDS()
 814 #undef x
 815         BCH_ALLOC_FIELD_NR
 816 };
 817
 818 static const unsigned BCH_ALLOC_FIELD_BYTES[] = {
 819 #define x(name, bits) [BCH_ALLOC_FIELD_##name] = bits / 8,
 820         BCH_ALLOC_FIELDS()
 821 #undef x
 822 };
 823
 824 #define x(name, bits) + (bits / 8)
 825 static const unsigned BKEY_ALLOC_VAL_U64s_MAX =
 826         DIV_ROUND_UP(offsetof(struct bch_alloc, data)
 827                      BCH_ALLOC_FIELDS(), sizeof(u64));
 828 #undef x
 829
 830 #define BKEY_ALLOC_U64s_MAX     (BKEY_U64s + BKEY_ALLOC_VAL_U64s_MAX)
 831
 832 /* Quotas: */
 833
 834 enum quota_types {
 835         QTYP_USR                = 0,
 836         QTYP_GRP                = 1,
 837         QTYP_PRJ                = 2,
 838         QTYP_NR                 = 3,
 839 };
 840
 841 enum quota_counters {
 842         Q_SPC                   = 0,
 843         Q_INO                   = 1,
 844         Q_COUNTERS              = 2,
 845 };
 846
 847 struct bch_quota_counter {
 848         __le64                  hardlimit;
 849         __le64                  softlimit;
 850 };
 851
 852 struct bch_quota {
 853         struct bch_val          v;
 854         struct bch_quota_counter c[Q_COUNTERS];
 855 } __attribute__((packed, aligned(8)));
 856
 857 /* Erasure coding */
 858
 859 struct bch_stripe {
 860         struct bch_val          v;
 861         __le16                  sectors;
 862         __u8                    algorithm;
 863         __u8                    nr_blocks;
 864         __u8                    nr_redundant;
 865
 866         __u8                    csum_granularity_bits;
 867         __u8                    csum_type;
 868         __u8                    pad;
 869
 870         struct bch_extent_ptr   ptrs[0];
 871 } __attribute__((packed, aligned(8)));
 872
 873 /* Reflink: */
 874
 875 struct bch_reflink_p {
 876         struct bch_val          v;
 877         __le64                  idx;
 878
 879         __le32                  reservation_generation;
 880         __u8                    nr_replicas;
 881         __u8                    pad[3];
 882 };
 883
 884 struct bch_reflink_v {
 885         struct bch_val          v;
 886         __le64                  refcount;
 887         union bch_extent_entry  start[0];
 888         __u64                   _data[0];
 889 };
 890
 891 struct bch_indirect_inline_data {
 892         struct bch_val          v;
 893         __le64                  refcount;
 894         u8                      data[0];
 895 };
 896
 897 /* Inline data */
 898
 899 struct bch_inline_data {
 900         struct bch_val          v;
 901         u8                      data[0];
 902 };
 903
 904 /* Optional/variable size superblock sections: */
 905
 906 struct bch_sb_field {
 907         __u64                   _data[0];
 908         __le32                  u64s;
 909         __le32                  type;
 910 };
 911
 912 #define BCH_SB_FIELDS()         \
 913         x(journal,      0)      \
 914         x(members,      1)      \
 915         x(crypt,        2)      \
 916         x(replicas_v0,  3)      \
 917         x(quota,        4)      \
 918         x(disk_groups,  5)      \
 919         x(clean,        6)      \
 920         x(replicas,     7)      \
 921         x(journal_seq_blacklist, 8)
 922
 923 enum bch_sb_field_type {
 924 #define x(f, nr)        BCH_SB_FIELD_##f = nr,
 925         BCH_SB_FIELDS()
 926 #undef x
 927         BCH_SB_FIELD_NR
 928 };
 929
 930 /* BCH_SB_FIELD_journal: */
 931
 932 struct bch_sb_field_journal {
 933         struct bch_sb_field     field;
 934         __le64                  buckets[0];
 935 };
 936
 937 /* BCH_SB_FIELD_members: */
 938
 939 #define BCH_MIN_NR_NBUCKETS     (1 << 6)
 940
 941 struct bch_member {
 942         uuid_le                 uuid;
 943         __le64                  nbuckets;       /* device size */
 944         __le16                  first_bucket;   /* index of first bucket used */
 945         __le16                  bucket_size;    /* sectors */
 946         __le32                  pad;
 947         __le64                  last_mount;     /* time_t */
 948
 949         __le64                  flags[2];
 950 };
 951
 952 LE64_BITMASK(BCH_MEMBER_STATE,          struct bch_member, flags[0],  0,  4)
 953 /* 4-10 unused, was TIER, HAS_(META)DATA */
 954 LE64_BITMASK(BCH_MEMBER_REPLACEMENT,    struct bch_member, flags[0], 10, 14)
 955 LE64_BITMASK(BCH_MEMBER_DISCARD,        struct bch_member, flags[0], 14, 15)
 956 LE64_BITMASK(BCH_MEMBER_DATA_ALLOWED,   struct bch_member, flags[0], 15, 20)
 957 LE64_BITMASK(BCH_MEMBER_GROUP,          struct bch_member, flags[0], 20, 28)
 958 LE64_BITMASK(BCH_MEMBER_DURABILITY,     struct bch_member, flags[0], 28, 30)
 959
 960 #define BCH_TIER_MAX                    4U
 961
 962 #if 0
 963 LE64_BITMASK(BCH_MEMBER_NR_READ_ERRORS, struct bch_member, flags[1], 0,  20);
 964 LE64_BITMASK(BCH_MEMBER_NR_WRITE_ERRORS,struct bch_member, flags[1], 20, 40);
 965 #endif
 966
 967 enum bch_member_state {
 968         BCH_MEMBER_STATE_RW             = 0,
 969         BCH_MEMBER_STATE_RO             = 1,
 970         BCH_MEMBER_STATE_FAILED         = 2,
 971         BCH_MEMBER_STATE_SPARE          = 3,
 972         BCH_MEMBER_STATE_NR             = 4,
 973 };
 974
 975 enum cache_replacement {
 976         CACHE_REPLACEMENT_LRU           = 0,
 977         CACHE_REPLACEMENT_FIFO          = 1,
 978         CACHE_REPLACEMENT_RANDOM        = 2,
 979         CACHE_REPLACEMENT_NR            = 3,
 980 };
 981
 982 struct bch_sb_field_members {
 983         struct bch_sb_field     field;
 984         struct bch_member       members[0];
 985 };
 986
 987 /* BCH_SB_FIELD_crypt: */
 988
 989 struct nonce {
 990         __le32                  d[4];
 991 };
 992
 993 struct bch_key {
 994         __le64                  key[4];
 995 };
 996
 997 #define BCH_KEY_MAGIC                                   \
 998         (((u64) 'b' <<  0)|((u64) 'c' <<  8)|           \
 999          ((u64) 'h' << 16)|((u64) '*' << 24)|           \
1000          ((u64) '*' << 32)|((u64) 'k' << 40)|           \
1001          ((u64) 'e' << 48)|((u64) 'y' << 56))
1002
1003 struct bch_encrypted_key {
1004         __le64                  magic;
1005         struct bch_key          key;
1006 };
1007
1008 /*
1009  * If this field is present in the superblock, it stores an encryption key which
1010  * is used encrypt all other data/metadata. The key will normally be encrypted
1011  * with the key userspace provides, but if encryption has been turned off we'll
1012  * just store the master key unencrypted in the superblock so we can access the
1013  * previously encrypted data.
1014  */
1015 struct bch_sb_field_crypt {
1016         struct bch_sb_field     field;
1017
1018         __le64                  flags;
1019         __le64                  kdf_flags;
1020         struct bch_encrypted_key key;
1021 };
1022
1023 LE64_BITMASK(BCH_CRYPT_KDF_TYPE,        struct bch_sb_field_crypt, flags, 0, 4);
1024
1025 enum bch_kdf_types {
1026         BCH_KDF_SCRYPT          = 0,
1027         BCH_KDF_NR              = 1,
1028 };
1029
1030 /* stored as base 2 log of scrypt params: */
1031 LE64_BITMASK(BCH_KDF_SCRYPT_N,  struct bch_sb_field_crypt, kdf_flags,  0, 16);
1032 LE64_BITMASK(BCH_KDF_SCRYPT_R,  struct bch_sb_field_crypt, kdf_flags, 16, 32);
1033 LE64_BITMASK(BCH_KDF_SCRYPT_P,  struct bch_sb_field_crypt, kdf_flags, 32, 48);
1034
1035 /* BCH_SB_FIELD_replicas: */
1036
1037 #define BCH_DATA_TYPES()                \
1038         x(none,         0)              \
1039         x(sb,           1)              \
1040         x(journal,      2)              \
1041         x(btree,        3)              \
1042         x(user,         4)              \
1043         x(cached,       5)              \
1044         x(parity,       6)
1045
1046 enum bch_data_type {
1047 #define x(t, n) BCH_DATA_##t,
1048         BCH_DATA_TYPES()
1049 #undef x
1050         BCH_DATA_NR
1051 };
1052
1053 struct bch_replicas_entry_v0 {
1054         __u8                    data_type;
1055         __u8                    nr_devs;
1056         __u8                    devs[0];
1057 } __attribute__((packed));
1058
1059 struct bch_sb_field_replicas_v0 {
1060         struct bch_sb_field     field;
1061         struct bch_replicas_entry_v0 entries[0];
1062 } __attribute__((packed, aligned(8)));
1063
1064 struct bch_replicas_entry {
1065         __u8                    data_type;
1066         __u8                    nr_devs;
1067         __u8                    nr_required;
1068         __u8                    devs[0];
1069 } __attribute__((packed));
1070
1071 #define replicas_entry_bytes(_i)                                        \
1072         (offsetof(typeof(*(_i)), devs) + (_i)->nr_devs)
1073
1074 struct bch_sb_field_replicas {
1075         struct bch_sb_field     field;
1076         struct bch_replicas_entry entries[0];
1077 } __attribute__((packed, aligned(8)));
1078
1079 /* BCH_SB_FIELD_quota: */
1080
1081 struct bch_sb_quota_counter {
1082         __le32                          timelimit;
1083         __le32                          warnlimit;
1084 };
1085
1086 struct bch_sb_quota_type {
1087         __le64                          flags;
1088         struct bch_sb_quota_counter     c[Q_COUNTERS];
1089 };
1090
1091 struct bch_sb_field_quota {
1092         struct bch_sb_field             field;
1093         struct bch_sb_quota_type        q[QTYP_NR];
1094 } __attribute__((packed, aligned(8)));
1095
1096 /* BCH_SB_FIELD_disk_groups: */
1097
1098 #define BCH_SB_LABEL_SIZE               32
1099
1100 struct bch_disk_group {
1101         __u8                    label[BCH_SB_LABEL_SIZE];
1102         __le64                  flags[2];
1103 } __attribute__((packed, aligned(8)));
1104
1105 LE64_BITMASK(BCH_GROUP_DELETED,         struct bch_disk_group, flags[0], 0,  1)
1106 LE64_BITMASK(BCH_GROUP_DATA_ALLOWED,    struct bch_disk_group, flags[0], 1,  6)
1107 LE64_BITMASK(BCH_GROUP_PARENT,          struct bch_disk_group, flags[0], 6, 24)
1108
1109 struct bch_sb_field_disk_groups {
1110         struct bch_sb_field     field;
1111         struct bch_disk_group   entries[0];
1112 } __attribute__((packed, aligned(8)));
1113
1114 /*
1115  * On clean shutdown, store btree roots and current journal sequence number in
1116  * the superblock:
1117  */
1118 struct jset_entry {
1119         __le16                  u64s;
1120         __u8                    btree_id;
1121         __u8                    level;
1122         __u8                    type; /* designates what this jset holds */
1123         __u8                    pad[3];
1124
1125         union {
1126                 struct bkey_i   start[0];
1127                 __u64           _data[0];
1128         };
1129 };
1130
1131 struct bch_sb_field_clean {
1132         struct bch_sb_field     field;
1133
1134         __le32                  flags;
1135         __le16                  read_clock;
1136         __le16                  write_clock;
1137         __le64                  journal_seq;
1138
1139         union {
1140                 struct jset_entry start[0];
1141                 __u64           _data[0];
1142         };
1143 };
1144
1145 struct journal_seq_blacklist_entry {
1146         __le64                  start;
1147         __le64                  end;
1148 };
1149
1150 struct bch_sb_field_journal_seq_blacklist {
1151         struct bch_sb_field     field;
1152
1153         union {
1154                 struct journal_seq_blacklist_entry start[0];
1155                 __u64           _data[0];
1156         };
1157 };
1158
1159 /* Superblock: */
1160
1161 /*
1162  * New versioning scheme:
1163  * One common version number for all on disk data structures - superblock, btree
1164  * nodes, journal entries
1165  */
1166 #define BCH_JSET_VERSION_OLD                    2
1167 #define BCH_BSET_VERSION_OLD                    3
1168
1169 enum bcachefs_metadata_version {
1170         bcachefs_metadata_version_min                   = 9,
1171         bcachefs_metadata_version_new_versioning        = 10,
1172         bcachefs_metadata_version_bkey_renumber         = 10,
1173         bcachefs_metadata_version_inode_btree_change    = 11,
1174         bcachefs_metadata_version_max                   = 12,
1175 };
1176
1177 #define bcachefs_metadata_version_current       (bcachefs_metadata_version_max - 1)
1178
1179 #define BCH_SB_SECTOR                   8
1180 #define BCH_SB_MEMBERS_MAX              64 /* XXX kill */
1181
1182 struct bch_sb_layout {
1183         uuid_le                 magic;  /* bcachefs superblock UUID */
1184         __u8                    layout_type;
1185         __u8                    sb_max_size_bits; /* base 2 of 512 byte sectors */
1186         __u8                    nr_superblocks;
1187         __u8                    pad[5];
1188         __le64                  sb_offset[61];
1189 } __attribute__((packed, aligned(8)));
1190
1191 #define BCH_SB_LAYOUT_SECTOR    7
1192
1193 /*
1194  * @offset      - sector where this sb was written
1195  * @version     - on disk format version
1196  * @version_min - Oldest metadata version this filesystem contains; so we can
1197  *                safely drop compatibility code and refuse to mount filesystems
1198  *                we'd need it for
1199  * @magic       - identifies as a bcachefs superblock (BCACHE_MAGIC)
1200  * @seq         - incremented each time superblock is written
1201  * @uuid        - used for generating various magic numbers and identifying
1202  *                member devices, never changes
1203  * @user_uuid   - user visible UUID, may be changed
1204  * @label       - filesystem label
1205  * @seq         - identifies most recent superblock, incremented each time
1206  *                superblock is written
1207  * @features    - enabled incompatible features
1208  */
1209 struct bch_sb {
1210         struct bch_csum         csum;
1211         __le16                  version;
1212         __le16                  version_min;
1213         __le16                  pad[2];
1214         uuid_le                 magic;
1215         uuid_le                 uuid;
1216         uuid_le                 user_uuid;
1217         __u8                    label[BCH_SB_LABEL_SIZE];
1218         __le64                  offset;
1219         __le64                  seq;
1220
1221         __le16                  block_size;
1222         __u8                    dev_idx;
1223         __u8                    nr_devices;
1224         __le32                  u64s;
1225
1226         __le64                  time_base_lo;
1227         __le32                  time_base_hi;
1228         __le32                  time_precision;
1229
1230         __le64                  flags[8];
1231         __le64                  features[2];
1232         __le64                  compat[2];
1233
1234         struct bch_sb_layout    layout;
1235
1236         union {
1237                 struct bch_sb_field start[0];
1238                 __le64          _data[0];
1239         };
1240 } __attribute__((packed, aligned(8)));
1241
1242 /*
1243  * Flags:
1244  * BCH_SB_INITALIZED    - set on first mount
1245  * BCH_SB_CLEAN         - did we shut down cleanly? Just a hint, doesn't affect
1246  *                        behaviour of mount/recovery path:
1247  * BCH_SB_INODE_32BIT   - limit inode numbers to 32 bits
1248  * BCH_SB_128_BIT_MACS  - 128 bit macs instead of 80
1249  * BCH_SB_ENCRYPTION_TYPE - if nonzero encryption is enabled; overrides
1250  *                         DATA/META_CSUM_TYPE. Also indicates encryption
1251  *                         algorithm in use, if/when we get more than one
1252  */
1253
1254 LE16_BITMASK(BCH_SB_BLOCK_SIZE,         struct bch_sb, block_size, 0, 16);
1255
1256 LE64_BITMASK(BCH_SB_INITIALIZED,        struct bch_sb, flags[0],  0,  1);
1257 LE64_BITMASK(BCH_SB_CLEAN,              struct bch_sb, flags[0],  1,  2);
1258 LE64_BITMASK(BCH_SB_CSUM_TYPE,          struct bch_sb, flags[0],  2,  8);
1259 LE64_BITMASK(BCH_SB_ERROR_ACTION,       struct bch_sb, flags[0],  8, 12);
1260
1261 LE64_BITMASK(BCH_SB_BTREE_NODE_SIZE,    struct bch_sb, flags[0], 12, 28);
1262
1263 LE64_BITMASK(BCH_SB_GC_RESERVE,         struct bch_sb, flags[0], 28, 33);
1264 LE64_BITMASK(BCH_SB_ROOT_RESERVE,       struct bch_sb, flags[0], 33, 40);
1265
1266 LE64_BITMASK(BCH_SB_META_CSUM_TYPE,     struct bch_sb, flags[0], 40, 44);
1267 LE64_BITMASK(BCH_SB_DATA_CSUM_TYPE,     struct bch_sb, flags[0], 44, 48);
1268
1269 LE64_BITMASK(BCH_SB_META_REPLICAS_WANT, struct bch_sb, flags[0], 48, 52);
1270 LE64_BITMASK(BCH_SB_DATA_REPLICAS_WANT, struct bch_sb, flags[0], 52, 56);
1271
1272 LE64_BITMASK(BCH_SB_POSIX_ACL,          struct bch_sb, flags[0], 56, 57);
1273 LE64_BITMASK(BCH_SB_USRQUOTA,           struct bch_sb, flags[0], 57, 58);
1274 LE64_BITMASK(BCH_SB_GRPQUOTA,           struct bch_sb, flags[0], 58, 59);
1275 LE64_BITMASK(BCH_SB_PRJQUOTA,           struct bch_sb, flags[0], 59, 60);
1276
1277 LE64_BITMASK(BCH_SB_HAS_ERRORS,         struct bch_sb, flags[0], 60, 61);
1278
1279 LE64_BITMASK(BCH_SB_REFLINK,            struct bch_sb, flags[0], 61, 62);
1280
1281 /* 61-64 unused */
1282
1283 LE64_BITMASK(BCH_SB_STR_HASH_TYPE,      struct bch_sb, flags[1],  0,  4);
1284 LE64_BITMASK(BCH_SB_COMPRESSION_TYPE,   struct bch_sb, flags[1],  4,  8);
1285 LE64_BITMASK(BCH_SB_INODE_32BIT,        struct bch_sb, flags[1],  8,  9);
1286
1287 LE64_BITMASK(BCH_SB_128_BIT_MACS,       struct bch_sb, flags[1],  9, 10);
1288 LE64_BITMASK(BCH_SB_ENCRYPTION_TYPE,    struct bch_sb, flags[1], 10, 14);
1289
1290 /*
1291  * Max size of an extent that may require bouncing to read or write
1292  * (checksummed, compressed): 64k
1293  */
1294 LE64_BITMASK(BCH_SB_ENCODED_EXTENT_MAX_BITS,
1295                                         struct bch_sb, flags[1], 14, 20);
1296
1297 LE64_BITMASK(BCH_SB_META_REPLICAS_REQ,  struct bch_sb, flags[1], 20, 24);
1298 LE64_BITMASK(BCH_SB_DATA_REPLICAS_REQ,  struct bch_sb, flags[1], 24, 28);
1299
1300 LE64_BITMASK(BCH_SB_PROMOTE_TARGET,     struct bch_sb, flags[1], 28, 40);
1301 LE64_BITMASK(BCH_SB_FOREGROUND_TARGET,  struct bch_sb, flags[1], 40, 52);
1302 LE64_BITMASK(BCH_SB_BACKGROUND_TARGET,  struct bch_sb, flags[1], 52, 64);
1303
1304 LE64_BITMASK(BCH_SB_BACKGROUND_COMPRESSION_TYPE,
1305                                         struct bch_sb, flags[2],  0,  4);
1306 LE64_BITMASK(BCH_SB_GC_RESERVE_BYTES,   struct bch_sb, flags[2],  4, 64);
1307
1308 LE64_BITMASK(BCH_SB_ERASURE_CODE,       struct bch_sb, flags[3],  0, 16);
1309
1310 /*
1311  * Features:
1312  *
1313  * journal_seq_blacklist_v3:    gates BCH_SB_FIELD_journal_seq_blacklist
1314  * reflink:                     gates KEY_TYPE_reflink
1315  * inline_data:                 gates KEY_TYPE_inline_data
1316  * new_siphash:                 gates BCH_STR_HASH_SIPHASH
1317  * new_extent_overwrite:        gates BTREE_NODE_NEW_EXTENT_OVERWRITE
1318  */
1319 #define BCH_SB_FEATURES()                       \
1320         x(lz4,                          0)      \
1321         x(gzip,                         1)      \
1322         x(zstd,                         2)      \
1323         x(atomic_nlink,                 3)      \
1324         x(ec,                           4)      \
1325         x(journal_seq_blacklist_v3,     5)      \
1326         x(reflink,                      6)      \
1327         x(new_siphash,                  7)      \
1328         x(inline_data,                  8)      \
1329         x(new_extent_overwrite,         9)      \
1330         x(incompressible,               10)     \
1331         x(btree_ptr_v2,                 11)     \
1332         x(extents_above_btree_updates,  12)     \
1333         x(btree_updates_journalled,     13)     \
1334         x(reflink_inline_data,          14)     \
1335         x(new_varint,                   15)     \
1336         x(journal_no_flush,             16)
1337
1338 #define BCH_SB_FEATURES_ALL                             \
1339         ((1ULL << BCH_FEATURE_new_siphash)|             \
1340          (1ULL << BCH_FEATURE_new_extent_overwrite)|    \
1341          (1ULL << BCH_FEATURE_btree_ptr_v2)|            \
1342          (1ULL << BCH_FEATURE_extents_above_btree_updates)|\
1343          (1ULL << BCH_FEATURE_new_varint)|              \
1344          (1ULL << BCH_FEATURE_journal_no_flush))
1345
1346 enum bch_sb_feature {
1347 #define x(f, n) BCH_FEATURE_##f,
1348         BCH_SB_FEATURES()
1349 #undef x
1350         BCH_FEATURE_NR,
1351 };
1352
1353 enum bch_sb_compat {
1354         BCH_COMPAT_FEAT_ALLOC_INFO      = 0,
1355         BCH_COMPAT_FEAT_ALLOC_METADATA  = 1,
1356 };
1357
1358 /* options: */
1359
1360 #define BCH_REPLICAS_MAX                4U
1361
1362 #define BCH_BKEY_PTRS_MAX               16U
1363
1364 enum bch_error_actions {
1365         BCH_ON_ERROR_CONTINUE           = 0,
1366         BCH_ON_ERROR_RO                 = 1,
1367         BCH_ON_ERROR_PANIC              = 2,
1368         BCH_NR_ERROR_ACTIONS            = 3,
1369 };
1370
1371 enum bch_str_hash_type {
1372         BCH_STR_HASH_CRC32C             = 0,
1373         BCH_STR_HASH_CRC64              = 1,
1374         BCH_STR_HASH_SIPHASH_OLD        = 2,
1375         BCH_STR_HASH_SIPHASH            = 3,
1376         BCH_STR_HASH_NR                 = 4,
1377 };
1378
1379 enum bch_str_hash_opts {
1380         BCH_STR_HASH_OPT_CRC32C         = 0,
1381         BCH_STR_HASH_OPT_CRC64          = 1,
1382         BCH_STR_HASH_OPT_SIPHASH        = 2,
1383         BCH_STR_HASH_OPT_NR             = 3,
1384 };
1385
1386 enum bch_csum_type {
1387         BCH_CSUM_NONE                   = 0,
1388         BCH_CSUM_CRC32C_NONZERO         = 1,
1389         BCH_CSUM_CRC64_NONZERO          = 2,
1390         BCH_CSUM_CHACHA20_POLY1305_80   = 3,
1391         BCH_CSUM_CHACHA20_POLY1305_128  = 4,
1392         BCH_CSUM_CRC32C                 = 5,
1393         BCH_CSUM_CRC64                  = 6,
1394         BCH_CSUM_NR                     = 7,
1395 };
1396
1397 static const unsigned bch_crc_bytes[] = {
1398         [BCH_CSUM_NONE]                         = 0,
1399         [BCH_CSUM_CRC32C_NONZERO]               = 4,
1400         [BCH_CSUM_CRC32C]                       = 4,
1401         [BCH_CSUM_CRC64_NONZERO]                = 8,
1402         [BCH_CSUM_CRC64]                        = 8,
1403         [BCH_CSUM_CHACHA20_POLY1305_80]         = 10,
1404         [BCH_CSUM_CHACHA20_POLY1305_128]        = 16,
1405 };
1406
1407 static inline _Bool bch2_csum_type_is_encryption(enum bch_csum_type type)
1408 {
1409         switch (type) {
1410         case BCH_CSUM_CHACHA20_POLY1305_80:
1411         case BCH_CSUM_CHACHA20_POLY1305_128:
1412                 return true;
1413         default:
1414                 return false;
1415         }
1416 }
1417
1418 enum bch_csum_opts {
1419         BCH_CSUM_OPT_NONE               = 0,
1420         BCH_CSUM_OPT_CRC32C             = 1,
1421         BCH_CSUM_OPT_CRC64              = 2,
1422         BCH_CSUM_OPT_NR                 = 3,
1423 };
1424
1425 #define BCH_COMPRESSION_TYPES()         \
1426         x(none,                 0)      \
1427         x(lz4_old,              1)      \
1428         x(gzip,                 2)      \
1429         x(lz4,                  3)      \
1430         x(zstd,                 4)      \
1431         x(incompressible,       5)
1432
1433 enum bch_compression_type {
1434 #define x(t, n) BCH_COMPRESSION_TYPE_##t,
1435         BCH_COMPRESSION_TYPES()
1436 #undef x
1437         BCH_COMPRESSION_TYPE_NR
1438 };
1439
1440 #define BCH_COMPRESSION_OPTS()          \
1441         x(none,         0)              \
1442         x(lz4,          1)              \
1443         x(gzip,         2)              \
1444         x(zstd,         3)
1445
1446 enum bch_compression_opts {
1447 #define x(t, n) BCH_COMPRESSION_OPT_##t,
1448         BCH_COMPRESSION_OPTS()
1449 #undef x
1450         BCH_COMPRESSION_OPT_NR
1451 };
1452
1453 /*
1454  * Magic numbers
1455  *
1456  * The various other data structures have their own magic numbers, which are
1457  * xored with the first part of the cache set's UUID
1458  */
1459
1460 #define BCACHE_MAGIC                                                    \
1461         UUID_LE(0xf67385c6, 0x1a4e, 0xca45,                             \
1462                 0x82, 0x65, 0xf5, 0x7f, 0x48, 0xba, 0x6d, 0x81)
1463
1464 #define BCACHEFS_STATFS_MAGIC           0xca451a4e
1465
1466 #define JSET_MAGIC              __cpu_to_le64(0x245235c1a3625032ULL)
1467 #define BSET_MAGIC              __cpu_to_le64(0x90135c78b99e07f5ULL)
1468
1469 static inline __le64 __bch2_sb_magic(struct bch_sb *sb)
1470 {
1471         __le64 ret;
1472         memcpy(&ret, &sb->uuid, sizeof(ret));
1473         return ret;
1474 }
1475
1476 static inline __u64 __jset_magic(struct bch_sb *sb)
1477 {
1478         return __le64_to_cpu(__bch2_sb_magic(sb) ^ JSET_MAGIC);
1479 }
1480
1481 static inline __u64 __bset_magic(struct bch_sb *sb)
1482 {
1483         return __le64_to_cpu(__bch2_sb_magic(sb) ^ BSET_MAGIC);
1484 }
1485
1486 /* Journal */
1487
1488 #define JSET_KEYS_U64s  (sizeof(struct jset_entry) / sizeof(__u64))
1489
1490 #define BCH_JSET_ENTRY_TYPES()                  \
1491         x(btree_keys,           0)              \
1492         x(btree_root,           1)              \
1493         x(prio_ptrs,            2)              \
1494         x(blacklist,            3)              \
1495         x(blacklist_v2,         4)              \
1496         x(usage,                5)              \
1497         x(data_usage,           6)
1498
1499 enum {
1500 #define x(f, nr)        BCH_JSET_ENTRY_##f      = nr,
1501         BCH_JSET_ENTRY_TYPES()
1502 #undef x
1503         BCH_JSET_ENTRY_NR
1504 };
1505
1506 /*
1507  * Journal sequence numbers can be blacklisted: bsets record the max sequence
1508  * number of all the journal entries they contain updates for, so that on
1509  * recovery we can ignore those bsets that contain index updates newer that what
1510  * made it into the journal.
1511  *
1512  * This means that we can't reuse that journal_seq - we have to skip it, and
1513  * then record that we skipped it so that the next time we crash and recover we
1514  * don't think there was a missing journal entry.
1515  */
1516 struct jset_entry_blacklist {
1517         struct jset_entry       entry;
1518         __le64                  seq;
1519 };
1520
1521 struct jset_entry_blacklist_v2 {
1522         struct jset_entry       entry;
1523         __le64                  start;
1524         __le64                  end;
1525 };
1526
1527 enum {
1528         FS_USAGE_RESERVED               = 0,
1529         FS_USAGE_INODES                 = 1,
1530         FS_USAGE_KEY_VERSION            = 2,
1531         FS_USAGE_NR                     = 3
1532 };
1533
1534 struct jset_entry_usage {
1535         struct jset_entry       entry;
1536         __le64                  v;
1537 } __attribute__((packed));
1538
1539 struct jset_entry_data_usage {
1540         struct jset_entry       entry;
1541         __le64                  v;
1542         struct bch_replicas_entry r;
1543 } __attribute__((packed));
1544
1545 /*
1546  * On disk format for a journal entry:
1547  * seq is monotonically increasing; every journal entry has its own unique
1548  * sequence number.
1549  *
1550  * last_seq is the oldest journal entry that still has keys the btree hasn't
1551  * flushed to disk yet.
1552  *
1553  * version is for on disk format changes.
1554  */
1555 struct jset {
1556         struct bch_csum         csum;
1557
1558         __le64                  magic;
1559         __le64                  seq;
1560         __le32                  version;
1561         __le32                  flags;
1562
1563         __le32                  u64s; /* size of d[] in u64s */
1564
1565         __u8                    encrypted_start[0];
1566
1567         __le16                  read_clock;
1568         __le16                  write_clock;
1569
1570         /* Sequence number of oldest dirty journal entry */
1571         __le64                  last_seq;
1572
1573
1574         union {
1575                 struct jset_entry start[0];
1576                 __u64           _data[0];
1577         };
1578 } __attribute__((packed, aligned(8)));
1579
1580 LE32_BITMASK(JSET_CSUM_TYPE,    struct jset, flags, 0, 4);
1581 LE32_BITMASK(JSET_BIG_ENDIAN,   struct jset, flags, 4, 5);
1582 LE32_BITMASK(JSET_NO_FLUSH,     struct jset, flags, 5, 6);
1583
1584 #define BCH_JOURNAL_BUCKETS_MIN         8
1585
1586 /* Btree: */
1587
1588 #define BCH_BTREE_IDS()                                 \
1589         x(EXTENTS,      0, "extents")                   \
1590         x(INODES,       1, "inodes")                    \
1591         x(DIRENTS,      2, "dirents")                   \
1592         x(XATTRS,       3, "xattrs")                    \
1593         x(ALLOC,        4, "alloc")                     \
1594         x(QUOTAS,       5, "quotas")                    \
1595         x(EC,           6, "stripes")                   \
1596         x(REFLINK,      7, "reflink")
1597
1598 enum btree_id {
1599 #define x(kwd, val, name) BTREE_ID_##kwd = val,
1600         BCH_BTREE_IDS()
1601 #undef x
1602         BTREE_ID_NR
1603 };
1604
1605 #define BTREE_MAX_DEPTH         4U
1606
1607 /* Btree nodes */
1608
1609 /*
1610  * Btree nodes
1611  *
1612  * On disk a btree node is a list/log of these; within each set the keys are
1613  * sorted
1614  */
1615 struct bset {
1616         __le64                  seq;
1617
1618         /*
1619          * Highest journal entry this bset contains keys for.
1620          * If on recovery we don't see that journal entry, this bset is ignored:
1621          * this allows us to preserve the order of all index updates after a
1622          * crash, since the journal records a total order of all index updates
1623          * and anything that didn't make it to the journal doesn't get used.
1624          */
1625         __le64                  journal_seq;
1626
1627         __le32                  flags;
1628         __le16                  version;
1629         __le16                  u64s; /* count of d[] in u64s */
1630
1631         union {
1632                 struct bkey_packed start[0];
1633                 __u64           _data[0];
1634         };
1635 } __attribute__((packed, aligned(8)));
1636
1637 LE32_BITMASK(BSET_CSUM_TYPE,    struct bset, flags, 0, 4);
1638
1639 LE32_BITMASK(BSET_BIG_ENDIAN,   struct bset, flags, 4, 5);
1640 LE32_BITMASK(BSET_SEPARATE_WHITEOUTS,
1641                                 struct bset, flags, 5, 6);
1642
1643 struct btree_node {
1644         struct bch_csum         csum;
1645         __le64                  magic;
1646
1647         /* this flags field is encrypted, unlike bset->flags: */
1648         __le64                  flags;
1649
1650         /* Closed interval: */
1651         struct bpos             min_key;
1652         struct bpos             max_key;
1653         struct bch_extent_ptr   ptr;
1654         struct bkey_format      format;
1655
1656         union {
1657         struct bset             keys;
1658         struct {
1659                 __u8            pad[22];
1660                 __le16          u64s;
1661                 __u64           _data[0];
1662
1663         };
1664         };
1665 } __attribute__((packed, aligned(8)));
1666
1667 LE64_BITMASK(BTREE_NODE_ID,     struct btree_node, flags,  0,  4);
1668 LE64_BITMASK(BTREE_NODE_LEVEL,  struct btree_node, flags,  4,  8);
1669 LE64_BITMASK(BTREE_NODE_NEW_EXTENT_OVERWRITE,
1670                                 struct btree_node, flags,  8,  9);
1671 /* 9-32 unused */
1672 LE64_BITMASK(BTREE_NODE_SEQ,    struct btree_node, flags, 32, 64);
1673
1674 struct btree_node_entry {
1675         struct bch_csum         csum;
1676
1677         union {
1678         struct bset             keys;
1679         struct {
1680                 __u8            pad[22];
1681                 __le16          u64s;
1682                 __u64           _data[0];
1683
1684         };
1685         };
1686 } __attribute__((packed, aligned(8)));
1687
1688 #endif /* _BCACHEFS_FORMAT_H */