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(hash_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         x(alloc_v2,             20)
 346
 347 enum bch_bkey_type {
 348 #define x(name, nr) KEY_TYPE_##name     = nr,
 349         BCH_BKEY_TYPES()
 350 #undef x
 351         KEY_TYPE_MAX,
 352 };
 353
 354 struct bch_deleted {
 355         struct bch_val          v;
 356 };
 357
 358 struct bch_discard {
 359         struct bch_val          v;
 360 };
 361
 362 struct bch_error {
 363         struct bch_val          v;
 364 };
 365
 366 struct bch_cookie {
 367         struct bch_val          v;
 368         __le64                  cookie;
 369 };
 370
 371 struct bch_hash_whiteout {
 372         struct bch_val          v;
 373 };
 374
 375 /* Extents */
 376
 377 /*
 378  * In extent bkeys, the value is a list of pointers (bch_extent_ptr), optionally
 379  * preceded by checksum/compression information (bch_extent_crc32 or
 380  * bch_extent_crc64).
 381  *
 382  * One major determining factor in the format of extents is how we handle and
 383  * represent extents that have been partially overwritten and thus trimmed:
 384  *
 385  * If an extent is not checksummed or compressed, when the extent is trimmed we
 386  * don't have to remember the extent we originally allocated and wrote: we can
 387  * merely adjust ptr->offset to point to the start of the data that is currently
 388  * live. The size field in struct bkey records the current (live) size of the
 389  * extent, and is also used to mean "size of region on disk that we point to" in
 390  * this case.
 391  *
 392  * Thus an extent that is not checksummed or compressed will consist only of a
 393  * list of bch_extent_ptrs, with none of the fields in
 394  * bch_extent_crc32/bch_extent_crc64.
 395  *
 396  * When an extent is checksummed or compressed, it's not possible to read only
 397  * the data that is currently live: we have to read the entire extent that was
 398  * originally written, and then return only the part of the extent that is
 399  * currently live.
 400  *
 401  * Thus, in addition to the current size of the extent in struct bkey, we need
 402  * to store the size of the originally allocated space - this is the
 403  * compressed_size and uncompressed_size fields in bch_extent_crc32/64. Also,
 404  * when the extent is trimmed, instead of modifying the offset field of the
 405  * pointer, we keep a second smaller offset field - "offset into the original
 406  * extent of the currently live region".
 407  *
 408  * The other major determining factor is replication and data migration:
 409  *
 410  * Each pointer may have its own bch_extent_crc32/64. When doing a replicated
 411  * write, we will initially write all the replicas in the same format, with the
 412  * same checksum type and compression format - however, when copygc runs later (or
 413  * tiering/cache promotion, anything that moves data), it is not in general
 414  * going to rewrite all the pointers at once - one of the replicas may be in a
 415  * bucket on one device that has very little fragmentation while another lives
 416  * in a bucket that has become heavily fragmented, and thus is being rewritten
 417  * sooner than the rest.
 418  *
 419  * Thus it will only move a subset of the pointers (or in the case of
 420  * tiering/cache promotion perhaps add a single pointer without dropping any
 421  * current pointers), and if the extent has been partially overwritten it must
 422  * write only the currently live portion (or copygc would not be able to reduce
 423  * fragmentation!) - which necessitates a different bch_extent_crc format for
 424  * the new pointer.
 425  *
 426  * But in the interests of space efficiency, we don't want to store one
 427  * bch_extent_crc for each pointer if we don't have to.
 428  *
 429  * Thus, a bch_extent consists of bch_extent_crc32s, bch_extent_crc64s, and
 430  * bch_extent_ptrs appended arbitrarily one after the other. We determine the
 431  * type of a given entry with a scheme similar to utf8 (except we're encoding a
 432  * type, not a size), encoding the type in the position of the first set bit:
 433  *
 434  * bch_extent_crc32     - 0b1
 435  * bch_extent_ptr       - 0b10
 436  * bch_extent_crc64     - 0b100
 437  *
 438  * We do it this way because bch_extent_crc32 is _very_ constrained on bits (and
 439  * bch_extent_crc64 is the least constrained).
 440  *
 441  * Then, each bch_extent_crc32/64 applies to the pointers that follow after it,
 442  * until the next bch_extent_crc32/64.
 443  *
 444  * If there are no bch_extent_crcs preceding a bch_extent_ptr, then that pointer
 445  * is neither checksummed nor compressed.
 446  */
 447
 448 /* 128 bits, sufficient for cryptographic MACs: */
 449 struct bch_csum {
 450         __le64                  lo;
 451         __le64                  hi;
 452 } __attribute__((packed, aligned(8)));
 453
 454 #define BCH_EXTENT_ENTRY_TYPES()                \
 455         x(ptr,                  0)              \
 456         x(crc32,                1)              \
 457         x(crc64,                2)              \
 458         x(crc128,               3)              \
 459         x(stripe_ptr,           4)
 460 #define BCH_EXTENT_ENTRY_MAX    5
 461
 462 enum bch_extent_entry_type {
 463 #define x(f, n) BCH_EXTENT_ENTRY_##f = n,
 464         BCH_EXTENT_ENTRY_TYPES()
 465 #undef x
 466 };
 467
 468 /* Compressed/uncompressed size are stored biased by 1: */
 469 struct bch_extent_crc32 {
 470 #if defined(__LITTLE_ENDIAN_BITFIELD)
 471         __u32                   type:2,
 472                                 _compressed_size:7,
 473                                 _uncompressed_size:7,
 474                                 offset:7,
 475                                 _unused:1,
 476                                 csum_type:4,
 477                                 compression_type:4;
 478         __u32                   csum;
 479 #elif defined (__BIG_ENDIAN_BITFIELD)
 480         __u32                   csum;
 481         __u32                   compression_type:4,
 482                                 csum_type:4,
 483                                 _unused:1,
 484                                 offset:7,
 485                                 _uncompressed_size:7,
 486                                 _compressed_size:7,
 487                                 type:2;
 488 #endif
 489 } __attribute__((packed, aligned(8)));
 490
 491 #define CRC32_SIZE_MAX          (1U << 7)
 492 #define CRC32_NONCE_MAX         0
 493
 494 struct bch_extent_crc64 {
 495 #if defined(__LITTLE_ENDIAN_BITFIELD)
 496         __u64                   type:3,
 497                                 _compressed_size:9,
 498                                 _uncompressed_size:9,
 499                                 offset:9,
 500                                 nonce:10,
 501                                 csum_type:4,
 502                                 compression_type:4,
 503                                 csum_hi:16;
 504 #elif defined (__BIG_ENDIAN_BITFIELD)
 505         __u64                   csum_hi:16,
 506                                 compression_type:4,
 507                                 csum_type:4,
 508                                 nonce:10,
 509                                 offset:9,
 510                                 _uncompressed_size:9,
 511                                 _compressed_size:9,
 512                                 type:3;
 513 #endif
 514         __u64                   csum_lo;
 515 } __attribute__((packed, aligned(8)));
 516
 517 #define CRC64_SIZE_MAX          (1U << 9)
 518 #define CRC64_NONCE_MAX         ((1U << 10) - 1)
 519
 520 struct bch_extent_crc128 {
 521 #if defined(__LITTLE_ENDIAN_BITFIELD)
 522         __u64                   type:4,
 523                                 _compressed_size:13,
 524                                 _uncompressed_size:13,
 525                                 offset:13,
 526                                 nonce:13,
 527                                 csum_type:4,
 528                                 compression_type:4;
 529 #elif defined (__BIG_ENDIAN_BITFIELD)
 530         __u64                   compression_type:4,
 531                                 csum_type:4,
 532                                 nonce:13,
 533                                 offset:13,
 534                                 _uncompressed_size:13,
 535                                 _compressed_size:13,
 536                                 type:4;
 537 #endif
 538         struct bch_csum         csum;
 539 } __attribute__((packed, aligned(8)));
 540
 541 #define CRC128_SIZE_MAX         (1U << 13)
 542 #define CRC128_NONCE_MAX        ((1U << 13) - 1)
 543
 544 /*
 545  * @reservation - pointer hasn't been written to, just reserved
 546  */
 547 struct bch_extent_ptr {
 548 #if defined(__LITTLE_ENDIAN_BITFIELD)
 549         __u64                   type:1,
 550                                 cached:1,
 551                                 unused:1,
 552                                 reservation:1,
 553                                 offset:44, /* 8 petabytes */
 554                                 dev:8,
 555                                 gen:8;
 556 #elif defined (__BIG_ENDIAN_BITFIELD)
 557         __u64                   gen:8,
 558                                 dev:8,
 559                                 offset:44,
 560                                 reservation:1,
 561                                 unused:1,
 562                                 cached:1,
 563                                 type:1;
 564 #endif
 565 } __attribute__((packed, aligned(8)));
 566
 567 struct bch_extent_stripe_ptr {
 568 #if defined(__LITTLE_ENDIAN_BITFIELD)
 569         __u64                   type:5,
 570                                 block:8,
 571                                 redundancy:4,
 572                                 idx:47;
 573 #elif defined (__BIG_ENDIAN_BITFIELD)
 574         __u64                   idx:47,
 575                                 redundancy:4,
 576                                 block:8,
 577                                 type:5;
 578 #endif
 579 };
 580
 581 struct bch_extent_reservation {
 582 #if defined(__LITTLE_ENDIAN_BITFIELD)
 583         __u64                   type:6,
 584                                 unused:22,
 585                                 replicas:4,
 586                                 generation:32;
 587 #elif defined (__BIG_ENDIAN_BITFIELD)
 588         __u64                   generation:32,
 589                                 replicas:4,
 590                                 unused:22,
 591                                 type:6;
 592 #endif
 593 };
 594
 595 union bch_extent_entry {
 596 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ ||  __BITS_PER_LONG == 64
 597         unsigned long                   type;
 598 #elif __BITS_PER_LONG == 32
 599         struct {
 600                 unsigned long           pad;
 601                 unsigned long           type;
 602         };
 603 #else
 604 #error edit for your odd byteorder.
 605 #endif
 606
 607 #define x(f, n) struct bch_extent_##f   f;
 608         BCH_EXTENT_ENTRY_TYPES()
 609 #undef x
 610 };
 611
 612 struct bch_btree_ptr {
 613         struct bch_val          v;
 614
 615         struct bch_extent_ptr   start[0];
 616         __u64                   _data[0];
 617 } __attribute__((packed, aligned(8)));
 618
 619 struct bch_btree_ptr_v2 {
 620         struct bch_val          v;
 621
 622         __u64                   mem_ptr;
 623         __le64                  seq;
 624         __le16                  sectors_written;
 625         __le16                  flags;
 626         struct bpos             min_key;
 627         struct bch_extent_ptr   start[0];
 628         __u64                   _data[0];
 629 } __attribute__((packed, aligned(8)));
 630
 631 LE16_BITMASK(BTREE_PTR_RANGE_UPDATED,   struct bch_btree_ptr_v2, flags, 0, 1);
 632
 633 struct bch_extent {
 634         struct bch_val          v;
 635
 636         union bch_extent_entry  start[0];
 637         __u64                   _data[0];
 638 } __attribute__((packed, aligned(8)));
 639
 640 struct bch_reservation {
 641         struct bch_val          v;
 642
 643         __le32                  generation;
 644         __u8                    nr_replicas;
 645         __u8                    pad[3];
 646 } __attribute__((packed, aligned(8)));
 647
 648 /* Maximum size (in u64s) a single pointer could be: */
 649 #define BKEY_EXTENT_PTR_U64s_MAX\
 650         ((sizeof(struct bch_extent_crc128) +                    \
 651           sizeof(struct bch_extent_ptr)) / sizeof(u64))
 652
 653 /* Maximum possible size of an entire extent value: */
 654 #define BKEY_EXTENT_VAL_U64s_MAX                                \
 655         (1 + BKEY_EXTENT_PTR_U64s_MAX * (BCH_REPLICAS_MAX + 1))
 656
 657 /* * Maximum possible size of an entire extent, key + value: */
 658 #define BKEY_EXTENT_U64s_MAX            (BKEY_U64s + BKEY_EXTENT_VAL_U64s_MAX)
 659
 660 /* Btree pointers don't carry around checksums: */
 661 #define BKEY_BTREE_PTR_VAL_U64s_MAX                             \
 662         ((sizeof(struct bch_btree_ptr_v2) +                     \
 663           sizeof(struct bch_extent_ptr) * BCH_REPLICAS_MAX) / sizeof(u64))
 664 #define BKEY_BTREE_PTR_U64s_MAX                                 \
 665         (BKEY_U64s + BKEY_BTREE_PTR_VAL_U64s_MAX)
 666
 667 /* Inodes */
 668
 669 #define BLOCKDEV_INODE_MAX      4096
 670
 671 #define BCACHEFS_ROOT_INO       4096
 672
 673 struct bch_inode {
 674         struct bch_val          v;
 675
 676         __le64                  bi_hash_seed;
 677         __le32                  bi_flags;
 678         __le16                  bi_mode;
 679         __u8                    fields[0];
 680 } __attribute__((packed, aligned(8)));
 681
 682 struct bch_inode_generation {
 683         struct bch_val          v;
 684
 685         __le32                  bi_generation;
 686         __le32                  pad;
 687 } __attribute__((packed, aligned(8)));
 688
 689 #define BCH_INODE_FIELDS()                      \
 690         x(bi_atime,                     96)     \
 691         x(bi_ctime,                     96)     \
 692         x(bi_mtime,                     96)     \
 693         x(bi_otime,                     96)     \
 694         x(bi_size,                      64)     \
 695         x(bi_sectors,                   64)     \
 696         x(bi_uid,                       32)     \
 697         x(bi_gid,                       32)     \
 698         x(bi_nlink,                     32)     \
 699         x(bi_generation,                32)     \
 700         x(bi_dev,                       32)     \
 701         x(bi_data_checksum,             8)      \
 702         x(bi_compression,               8)      \
 703         x(bi_project,                   32)     \
 704         x(bi_background_compression,    8)      \
 705         x(bi_data_replicas,             8)      \
 706         x(bi_promote_target,            16)     \
 707         x(bi_foreground_target,         16)     \
 708         x(bi_background_target,         16)     \
 709         x(bi_erasure_code,              16)     \
 710         x(bi_fields_set,                16)
 711
 712 /* subset of BCH_INODE_FIELDS */
 713 #define BCH_INODE_OPTS()                        \
 714         x(data_checksum,                8)      \
 715         x(compression,                  8)      \
 716         x(project,                      32)     \
 717         x(background_compression,       8)      \
 718         x(data_replicas,                8)      \
 719         x(promote_target,               16)     \
 720         x(foreground_target,            16)     \
 721         x(background_target,            16)     \
 722         x(erasure_code,                 16)
 723
 724 enum inode_opt_id {
 725 #define x(name, ...)                            \
 726         Inode_opt_##name,
 727         BCH_INODE_OPTS()
 728 #undef  x
 729         Inode_opt_nr,
 730 };
 731
 732 enum {
 733         /*
 734          * User flags (get/settable with FS_IOC_*FLAGS, correspond to FS_*_FL
 735          * flags)
 736          */
 737         __BCH_INODE_SYNC        = 0,
 738         __BCH_INODE_IMMUTABLE   = 1,
 739         __BCH_INODE_APPEND      = 2,
 740         __BCH_INODE_NODUMP      = 3,
 741         __BCH_INODE_NOATIME     = 4,
 742
 743         __BCH_INODE_I_SIZE_DIRTY= 5,
 744         __BCH_INODE_I_SECTORS_DIRTY= 6,
 745         __BCH_INODE_UNLINKED    = 7,
 746
 747         /* bits 20+ reserved for packed fields below: */
 748 };
 749
 750 #define BCH_INODE_SYNC          (1 << __BCH_INODE_SYNC)
 751 #define BCH_INODE_IMMUTABLE     (1 << __BCH_INODE_IMMUTABLE)
 752 #define BCH_INODE_APPEND        (1 << __BCH_INODE_APPEND)
 753 #define BCH_INODE_NODUMP        (1 << __BCH_INODE_NODUMP)
 754 #define BCH_INODE_NOATIME       (1 << __BCH_INODE_NOATIME)
 755 #define BCH_INODE_I_SIZE_DIRTY  (1 << __BCH_INODE_I_SIZE_DIRTY)
 756 #define BCH_INODE_I_SECTORS_DIRTY (1 << __BCH_INODE_I_SECTORS_DIRTY)
 757 #define BCH_INODE_UNLINKED      (1 << __BCH_INODE_UNLINKED)
 758
 759 LE32_BITMASK(INODE_STR_HASH,    struct bch_inode, bi_flags, 20, 24);
 760 LE32_BITMASK(INODE_NR_FIELDS,   struct bch_inode, bi_flags, 24, 31);
 761 LE32_BITMASK(INODE_NEW_VARINT,  struct bch_inode, bi_flags, 31, 32);
 762
 763 /* Dirents */
 764
 765 /*
 766  * Dirents (and xattrs) have to implement string lookups; since our b-tree
 767  * doesn't support arbitrary length strings for the key, we instead index by a
 768  * 64 bit hash (currently truncated sha1) of the string, stored in the offset
 769  * field of the key - using linear probing to resolve hash collisions. This also
 770  * provides us with the readdir cookie posix requires.
 771  *
 772  * Linear probing requires us to use whiteouts for deletions, in the event of a
 773  * collision:
 774  */
 775
 776 struct bch_dirent {
 777         struct bch_val          v;
 778
 779         /* Target inode number: */
 780         __le64                  d_inum;
 781
 782         /*
 783          * Copy of mode bits 12-15 from the target inode - so userspace can get
 784          * the filetype without having to do a stat()
 785          */
 786         __u8                    d_type;
 787
 788         __u8                    d_name[];
 789 } __attribute__((packed, aligned(8)));
 790
 791 #define BCH_NAME_MAX    (U8_MAX * sizeof(u64) -                         \
 792                          sizeof(struct bkey) -                          \
 793                          offsetof(struct bch_dirent, d_name))
 794
 795
 796 /* Xattrs */
 797
 798 #define KEY_TYPE_XATTR_INDEX_USER                       0
 799 #define KEY_TYPE_XATTR_INDEX_POSIX_ACL_ACCESS   1
 800 #define KEY_TYPE_XATTR_INDEX_POSIX_ACL_DEFAULT  2
 801 #define KEY_TYPE_XATTR_INDEX_TRUSTED                    3
 802 #define KEY_TYPE_XATTR_INDEX_SECURITY           4
 803
 804 struct bch_xattr {
 805         struct bch_val          v;
 806         __u8                    x_type;
 807         __u8                    x_name_len;
 808         __le16                  x_val_len;
 809         __u8                    x_name[];
 810 } __attribute__((packed, aligned(8)));
 811
 812 /* Bucket/allocation information: */
 813
 814 struct bch_alloc {
 815         struct bch_val          v;
 816         __u8                    fields;
 817         __u8                    gen;
 818         __u8                    data[];
 819 } __attribute__((packed, aligned(8)));
 820
 821 #define BCH_ALLOC_FIELDS_V1()                   \
 822         x(read_time,            16)             \
 823         x(write_time,           16)             \
 824         x(data_type,            8)              \
 825         x(dirty_sectors,        16)             \
 826         x(cached_sectors,       16)             \
 827         x(oldest_gen,           8)              \
 828         x(stripe,               32)             \
 829         x(stripe_redundancy,    8)
 830
 831 struct bch_alloc_v2 {
 832         struct bch_val          v;
 833         __u8                    nr_fields;
 834         __u8                    gen;
 835         __u8                    oldest_gen;
 836         __u8                    data_type;
 837         __u8                    data[];
 838 } __attribute__((packed, aligned(8)));
 839
 840 #define BCH_ALLOC_FIELDS_V2()                   \
 841         x(read_time,            64)             \
 842         x(write_time,           64)             \
 843         x(dirty_sectors,        16)             \
 844         x(cached_sectors,       16)             \
 845         x(stripe,               32)             \
 846         x(stripe_redundancy,    8)
 847
 848 enum {
 849 #define x(name, _bits) BCH_ALLOC_FIELD_V1_##name,
 850         BCH_ALLOC_FIELDS_V1()
 851 #undef x
 852         BCH_ALLOC_FIELD_NR
 853 };
 854
 855 /* Quotas: */
 856
 857 enum quota_types {
 858         QTYP_USR                = 0,
 859         QTYP_GRP                = 1,
 860         QTYP_PRJ                = 2,
 861         QTYP_NR                 = 3,
 862 };
 863
 864 enum quota_counters {
 865         Q_SPC                   = 0,
 866         Q_INO                   = 1,
 867         Q_COUNTERS              = 2,
 868 };
 869
 870 struct bch_quota_counter {
 871         __le64                  hardlimit;
 872         __le64                  softlimit;
 873 };
 874
 875 struct bch_quota {
 876         struct bch_val          v;
 877         struct bch_quota_counter c[Q_COUNTERS];
 878 } __attribute__((packed, aligned(8)));
 879
 880 /* Erasure coding */
 881
 882 struct bch_stripe {
 883         struct bch_val          v;
 884         __le16                  sectors;
 885         __u8                    algorithm;
 886         __u8                    nr_blocks;
 887         __u8                    nr_redundant;
 888
 889         __u8                    csum_granularity_bits;
 890         __u8                    csum_type;
 891         __u8                    pad;
 892
 893         struct bch_extent_ptr   ptrs[0];
 894 } __attribute__((packed, aligned(8)));
 895
 896 /* Reflink: */
 897
 898 struct bch_reflink_p {
 899         struct bch_val          v;
 900         __le64                  idx;
 901
 902         __le32                  reservation_generation;
 903         __u8                    nr_replicas;
 904         __u8                    pad[3];
 905 };
 906
 907 struct bch_reflink_v {
 908         struct bch_val          v;
 909         __le64                  refcount;
 910         union bch_extent_entry  start[0];
 911         __u64                   _data[0];
 912 };
 913
 914 struct bch_indirect_inline_data {
 915         struct bch_val          v;
 916         __le64                  refcount;
 917         u8                      data[0];
 918 };
 919
 920 /* Inline data */
 921
 922 struct bch_inline_data {
 923         struct bch_val          v;
 924         u8                      data[0];
 925 };
 926
 927 /* Optional/variable size superblock sections: */
 928
 929 struct bch_sb_field {
 930         __u64                   _data[0];
 931         __le32                  u64s;
 932         __le32                  type;
 933 };
 934
 935 #define BCH_SB_FIELDS()         \
 936         x(journal,      0)      \
 937         x(members,      1)      \
 938         x(crypt,        2)      \
 939         x(replicas_v0,  3)      \
 940         x(quota,        4)      \
 941         x(disk_groups,  5)      \
 942         x(clean,        6)      \
 943         x(replicas,     7)      \
 944         x(journal_seq_blacklist, 8)
 945
 946 enum bch_sb_field_type {
 947 #define x(f, nr)        BCH_SB_FIELD_##f = nr,
 948         BCH_SB_FIELDS()
 949 #undef x
 950         BCH_SB_FIELD_NR
 951 };
 952
 953 /* BCH_SB_FIELD_journal: */
 954
 955 struct bch_sb_field_journal {
 956         struct bch_sb_field     field;
 957         __le64                  buckets[0];
 958 };
 959
 960 /* BCH_SB_FIELD_members: */
 961
 962 #define BCH_MIN_NR_NBUCKETS     (1 << 6)
 963
 964 struct bch_member {
 965         uuid_le                 uuid;
 966         __le64                  nbuckets;       /* device size */
 967         __le16                  first_bucket;   /* index of first bucket used */
 968         __le16                  bucket_size;    /* sectors */
 969         __le32                  pad;
 970         __le64                  last_mount;     /* time_t */
 971
 972         __le64                  flags[2];
 973 };
 974
 975 LE64_BITMASK(BCH_MEMBER_STATE,          struct bch_member, flags[0],  0,  4)
 976 /* 4-10 unused, was TIER, HAS_(META)DATA */
 977 LE64_BITMASK(BCH_MEMBER_REPLACEMENT,    struct bch_member, flags[0], 10, 14)
 978 LE64_BITMASK(BCH_MEMBER_DISCARD,        struct bch_member, flags[0], 14, 15)
 979 LE64_BITMASK(BCH_MEMBER_DATA_ALLOWED,   struct bch_member, flags[0], 15, 20)
 980 LE64_BITMASK(BCH_MEMBER_GROUP,          struct bch_member, flags[0], 20, 28)
 981 LE64_BITMASK(BCH_MEMBER_DURABILITY,     struct bch_member, flags[0], 28, 30)
 982
 983 #define BCH_TIER_MAX                    4U
 984
 985 #if 0
 986 LE64_BITMASK(BCH_MEMBER_NR_READ_ERRORS, struct bch_member, flags[1], 0,  20);
 987 LE64_BITMASK(BCH_MEMBER_NR_WRITE_ERRORS,struct bch_member, flags[1], 20, 40);
 988 #endif
 989
 990 #define BCH_MEMBER_STATES()                     \
 991         x(rw,           0)                      \
 992         x(ro,           1)                      \
 993         x(failed,       2)                      \
 994         x(spare,        3)
 995
 996 enum bch_member_state {
 997 #define x(t, n) BCH_MEMBER_STATE_##t = n,
 998         BCH_MEMBER_STATES()
 999 #undef x
1000         BCH_MEMBER_STATE_NR
1001 };
1002
1003 #define BCH_CACHE_REPLACEMENT_POLICIES()        \
1004         x(lru,          0)                      \
1005         x(fifo,         1)                      \
1006         x(random,       2)
1007
1008 enum bch_cache_replacement_policies {
1009 #define x(t, n) BCH_CACHE_REPLACEMENT_##t = n,
1010         BCH_CACHE_REPLACEMENT_POLICIES()
1011 #undef x
1012         BCH_CACHE_REPLACEMENT_NR
1013 };
1014
1015 struct bch_sb_field_members {
1016         struct bch_sb_field     field;
1017         struct bch_member       members[0];
1018 };
1019
1020 /* BCH_SB_FIELD_crypt: */
1021
1022 struct nonce {
1023         __le32                  d[4];
1024 };
1025
1026 struct bch_key {
1027         __le64                  key[4];
1028 };
1029
1030 #define BCH_KEY_MAGIC                                   \
1031         (((u64) 'b' <<  0)|((u64) 'c' <<  8)|           \
1032          ((u64) 'h' << 16)|((u64) '*' << 24)|           \
1033          ((u64) '*' << 32)|((u64) 'k' << 40)|           \
1034          ((u64) 'e' << 48)|((u64) 'y' << 56))
1035
1036 struct bch_encrypted_key {
1037         __le64                  magic;
1038         struct bch_key          key;
1039 };
1040
1041 /*
1042  * If this field is present in the superblock, it stores an encryption key which
1043  * is used encrypt all other data/metadata. The key will normally be encrypted
1044  * with the key userspace provides, but if encryption has been turned off we'll
1045  * just store the master key unencrypted in the superblock so we can access the
1046  * previously encrypted data.
1047  */
1048 struct bch_sb_field_crypt {
1049         struct bch_sb_field     field;
1050
1051         __le64                  flags;
1052         __le64                  kdf_flags;
1053         struct bch_encrypted_key key;
1054 };
1055
1056 LE64_BITMASK(BCH_CRYPT_KDF_TYPE,        struct bch_sb_field_crypt, flags, 0, 4);
1057
1058 enum bch_kdf_types {
1059         BCH_KDF_SCRYPT          = 0,
1060         BCH_KDF_NR              = 1,
1061 };
1062
1063 /* stored as base 2 log of scrypt params: */
1064 LE64_BITMASK(BCH_KDF_SCRYPT_N,  struct bch_sb_field_crypt, kdf_flags,  0, 16);
1065 LE64_BITMASK(BCH_KDF_SCRYPT_R,  struct bch_sb_field_crypt, kdf_flags, 16, 32);
1066 LE64_BITMASK(BCH_KDF_SCRYPT_P,  struct bch_sb_field_crypt, kdf_flags, 32, 48);
1067
1068 /* BCH_SB_FIELD_replicas: */
1069
1070 #define BCH_DATA_TYPES()                \
1071         x(none,         0)              \
1072         x(sb,           1)              \
1073         x(journal,      2)              \
1074         x(btree,        3)              \
1075         x(user,         4)              \
1076         x(cached,       5)              \
1077         x(parity,       6)
1078
1079 enum bch_data_type {
1080 #define x(t, n) BCH_DATA_##t,
1081         BCH_DATA_TYPES()
1082 #undef x
1083         BCH_DATA_NR
1084 };
1085
1086 struct bch_replicas_entry_v0 {
1087         __u8                    data_type;
1088         __u8                    nr_devs;
1089         __u8                    devs[0];
1090 } __attribute__((packed));
1091
1092 struct bch_sb_field_replicas_v0 {
1093         struct bch_sb_field     field;
1094         struct bch_replicas_entry_v0 entries[0];
1095 } __attribute__((packed, aligned(8)));
1096
1097 struct bch_replicas_entry {
1098         __u8                    data_type;
1099         __u8                    nr_devs;
1100         __u8                    nr_required;
1101         __u8                    devs[0];
1102 } __attribute__((packed));
1103
1104 #define replicas_entry_bytes(_i)                                        \
1105         (offsetof(typeof(*(_i)), devs) + (_i)->nr_devs)
1106
1107 struct bch_sb_field_replicas {
1108         struct bch_sb_field     field;
1109         struct bch_replicas_entry entries[0];
1110 } __attribute__((packed, aligned(8)));
1111
1112 /* BCH_SB_FIELD_quota: */
1113
1114 struct bch_sb_quota_counter {
1115         __le32                          timelimit;
1116         __le32                          warnlimit;
1117 };
1118
1119 struct bch_sb_quota_type {
1120         __le64                          flags;
1121         struct bch_sb_quota_counter     c[Q_COUNTERS];
1122 };
1123
1124 struct bch_sb_field_quota {
1125         struct bch_sb_field             field;
1126         struct bch_sb_quota_type        q[QTYP_NR];
1127 } __attribute__((packed, aligned(8)));
1128
1129 /* BCH_SB_FIELD_disk_groups: */
1130
1131 #define BCH_SB_LABEL_SIZE               32
1132
1133 struct bch_disk_group {
1134         __u8                    label[BCH_SB_LABEL_SIZE];
1135         __le64                  flags[2];
1136 } __attribute__((packed, aligned(8)));
1137
1138 LE64_BITMASK(BCH_GROUP_DELETED,         struct bch_disk_group, flags[0], 0,  1)
1139 LE64_BITMASK(BCH_GROUP_DATA_ALLOWED,    struct bch_disk_group, flags[0], 1,  6)
1140 LE64_BITMASK(BCH_GROUP_PARENT,          struct bch_disk_group, flags[0], 6, 24)
1141
1142 struct bch_sb_field_disk_groups {
1143         struct bch_sb_field     field;
1144         struct bch_disk_group   entries[0];
1145 } __attribute__((packed, aligned(8)));
1146
1147 /*
1148  * On clean shutdown, store btree roots and current journal sequence number in
1149  * the superblock:
1150  */
1151 struct jset_entry {
1152         __le16                  u64s;
1153         __u8                    btree_id;
1154         __u8                    level;
1155         __u8                    type; /* designates what this jset holds */
1156         __u8                    pad[3];
1157
1158         union {
1159                 struct bkey_i   start[0];
1160                 __u64           _data[0];
1161         };
1162 };
1163
1164 struct bch_sb_field_clean {
1165         struct bch_sb_field     field;
1166
1167         __le32                  flags;
1168         __le16                  _read_clock; /* no longer used */
1169         __le16                  _write_clock;
1170         __le64                  journal_seq;
1171
1172         union {
1173                 struct jset_entry start[0];
1174                 __u64           _data[0];
1175         };
1176 };
1177
1178 struct journal_seq_blacklist_entry {
1179         __le64                  start;
1180         __le64                  end;
1181 };
1182
1183 struct bch_sb_field_journal_seq_blacklist {
1184         struct bch_sb_field     field;
1185
1186         union {
1187                 struct journal_seq_blacklist_entry start[0];
1188                 __u64           _data[0];
1189         };
1190 };
1191
1192 /* Superblock: */
1193
1194 /*
1195  * New versioning scheme:
1196  * One common version number for all on disk data structures - superblock, btree
1197  * nodes, journal entries
1198  */
1199 #define BCH_JSET_VERSION_OLD                    2
1200 #define BCH_BSET_VERSION_OLD                    3
1201
1202 enum bcachefs_metadata_version {
1203         bcachefs_metadata_version_min                   = 9,
1204         bcachefs_metadata_version_new_versioning        = 10,
1205         bcachefs_metadata_version_bkey_renumber         = 10,
1206         bcachefs_metadata_version_inode_btree_change    = 11,
1207         bcachefs_metadata_version_max                   = 12,
1208 };
1209
1210 #define bcachefs_metadata_version_current       (bcachefs_metadata_version_max - 1)
1211
1212 #define BCH_SB_SECTOR                   8
1213 #define BCH_SB_MEMBERS_MAX              64 /* XXX kill */
1214
1215 struct bch_sb_layout {
1216         uuid_le                 magic;  /* bcachefs superblock UUID */
1217         __u8                    layout_type;
1218         __u8                    sb_max_size_bits; /* base 2 of 512 byte sectors */
1219         __u8                    nr_superblocks;
1220         __u8                    pad[5];
1221         __le64                  sb_offset[61];
1222 } __attribute__((packed, aligned(8)));
1223
1224 #define BCH_SB_LAYOUT_SECTOR    7
1225
1226 /*
1227  * @offset      - sector where this sb was written
1228  * @version     - on disk format version
1229  * @version_min - Oldest metadata version this filesystem contains; so we can
1230  *                safely drop compatibility code and refuse to mount filesystems
1231  *                we'd need it for
1232  * @magic       - identifies as a bcachefs superblock (BCACHE_MAGIC)
1233  * @seq         - incremented each time superblock is written
1234  * @uuid        - used for generating various magic numbers and identifying
1235  *                member devices, never changes
1236  * @user_uuid   - user visible UUID, may be changed
1237  * @label       - filesystem label
1238  * @seq         - identifies most recent superblock, incremented each time
1239  *                superblock is written
1240  * @features    - enabled incompatible features
1241  */
1242 struct bch_sb {
1243         struct bch_csum         csum;
1244         __le16                  version;
1245         __le16                  version_min;
1246         __le16                  pad[2];
1247         uuid_le                 magic;
1248         uuid_le                 uuid;
1249         uuid_le                 user_uuid;
1250         __u8                    label[BCH_SB_LABEL_SIZE];
1251         __le64                  offset;
1252         __le64                  seq;
1253
1254         __le16                  block_size;
1255         __u8                    dev_idx;
1256         __u8                    nr_devices;
1257         __le32                  u64s;
1258
1259         __le64                  time_base_lo;
1260         __le32                  time_base_hi;
1261         __le32                  time_precision;
1262
1263         __le64                  flags[8];
1264         __le64                  features[2];
1265         __le64                  compat[2];
1266
1267         struct bch_sb_layout    layout;
1268
1269         union {
1270                 struct bch_sb_field start[0];
1271                 __le64          _data[0];
1272         };
1273 } __attribute__((packed, aligned(8)));
1274
1275 /*
1276  * Flags:
1277  * BCH_SB_INITALIZED    - set on first mount
1278  * BCH_SB_CLEAN         - did we shut down cleanly? Just a hint, doesn't affect
1279  *                        behaviour of mount/recovery path:
1280  * BCH_SB_INODE_32BIT   - limit inode numbers to 32 bits
1281  * BCH_SB_128_BIT_MACS  - 128 bit macs instead of 80
1282  * BCH_SB_ENCRYPTION_TYPE - if nonzero encryption is enabled; overrides
1283  *                         DATA/META_CSUM_TYPE. Also indicates encryption
1284  *                         algorithm in use, if/when we get more than one
1285  */
1286
1287 LE16_BITMASK(BCH_SB_BLOCK_SIZE,         struct bch_sb, block_size, 0, 16);
1288
1289 LE64_BITMASK(BCH_SB_INITIALIZED,        struct bch_sb, flags[0],  0,  1);
1290 LE64_BITMASK(BCH_SB_CLEAN,              struct bch_sb, flags[0],  1,  2);
1291 LE64_BITMASK(BCH_SB_CSUM_TYPE,          struct bch_sb, flags[0],  2,  8);
1292 LE64_BITMASK(BCH_SB_ERROR_ACTION,       struct bch_sb, flags[0],  8, 12);
1293
1294 LE64_BITMASK(BCH_SB_BTREE_NODE_SIZE,    struct bch_sb, flags[0], 12, 28);
1295
1296 LE64_BITMASK(BCH_SB_GC_RESERVE,         struct bch_sb, flags[0], 28, 33);
1297 LE64_BITMASK(BCH_SB_ROOT_RESERVE,       struct bch_sb, flags[0], 33, 40);
1298
1299 LE64_BITMASK(BCH_SB_META_CSUM_TYPE,     struct bch_sb, flags[0], 40, 44);
1300 LE64_BITMASK(BCH_SB_DATA_CSUM_TYPE,     struct bch_sb, flags[0], 44, 48);
1301
1302 LE64_BITMASK(BCH_SB_META_REPLICAS_WANT, struct bch_sb, flags[0], 48, 52);
1303 LE64_BITMASK(BCH_SB_DATA_REPLICAS_WANT, struct bch_sb, flags[0], 52, 56);
1304
1305 LE64_BITMASK(BCH_SB_POSIX_ACL,          struct bch_sb, flags[0], 56, 57);
1306 LE64_BITMASK(BCH_SB_USRQUOTA,           struct bch_sb, flags[0], 57, 58);
1307 LE64_BITMASK(BCH_SB_GRPQUOTA,           struct bch_sb, flags[0], 58, 59);
1308 LE64_BITMASK(BCH_SB_PRJQUOTA,           struct bch_sb, flags[0], 59, 60);
1309
1310 LE64_BITMASK(BCH_SB_HAS_ERRORS,         struct bch_sb, flags[0], 60, 61);
1311
1312 LE64_BITMASK(BCH_SB_REFLINK,            struct bch_sb, flags[0], 61, 62);
1313
1314 /* 61-64 unused */
1315
1316 LE64_BITMASK(BCH_SB_STR_HASH_TYPE,      struct bch_sb, flags[1],  0,  4);
1317 LE64_BITMASK(BCH_SB_COMPRESSION_TYPE,   struct bch_sb, flags[1],  4,  8);
1318 LE64_BITMASK(BCH_SB_INODE_32BIT,        struct bch_sb, flags[1],  8,  9);
1319
1320 LE64_BITMASK(BCH_SB_128_BIT_MACS,       struct bch_sb, flags[1],  9, 10);
1321 LE64_BITMASK(BCH_SB_ENCRYPTION_TYPE,    struct bch_sb, flags[1], 10, 14);
1322
1323 /*
1324  * Max size of an extent that may require bouncing to read or write
1325  * (checksummed, compressed): 64k
1326  */
1327 LE64_BITMASK(BCH_SB_ENCODED_EXTENT_MAX_BITS,
1328                                         struct bch_sb, flags[1], 14, 20);
1329
1330 LE64_BITMASK(BCH_SB_META_REPLICAS_REQ,  struct bch_sb, flags[1], 20, 24);
1331 LE64_BITMASK(BCH_SB_DATA_REPLICAS_REQ,  struct bch_sb, flags[1], 24, 28);
1332
1333 LE64_BITMASK(BCH_SB_PROMOTE_TARGET,     struct bch_sb, flags[1], 28, 40);
1334 LE64_BITMASK(BCH_SB_FOREGROUND_TARGET,  struct bch_sb, flags[1], 40, 52);
1335 LE64_BITMASK(BCH_SB_BACKGROUND_TARGET,  struct bch_sb, flags[1], 52, 64);
1336
1337 LE64_BITMASK(BCH_SB_BACKGROUND_COMPRESSION_TYPE,
1338                                         struct bch_sb, flags[2],  0,  4);
1339 LE64_BITMASK(BCH_SB_GC_RESERVE_BYTES,   struct bch_sb, flags[2],  4, 64);
1340
1341 LE64_BITMASK(BCH_SB_ERASURE_CODE,       struct bch_sb, flags[3],  0, 16);
1342 LE64_BITMASK(BCH_SB_METADATA_TARGET,    struct bch_sb, flags[3], 16, 28);
1343
1344 /*
1345  * Features:
1346  *
1347  * journal_seq_blacklist_v3:    gates BCH_SB_FIELD_journal_seq_blacklist
1348  * reflink:                     gates KEY_TYPE_reflink
1349  * inline_data:                 gates KEY_TYPE_inline_data
1350  * new_siphash:                 gates BCH_STR_HASH_SIPHASH
1351  * new_extent_overwrite:        gates BTREE_NODE_NEW_EXTENT_OVERWRITE
1352  */
1353 #define BCH_SB_FEATURES()                       \
1354         x(lz4,                          0)      \
1355         x(gzip,                         1)      \
1356         x(zstd,                         2)      \
1357         x(atomic_nlink,                 3)      \
1358         x(ec,                           4)      \
1359         x(journal_seq_blacklist_v3,     5)      \
1360         x(reflink,                      6)      \
1361         x(new_siphash,                  7)      \
1362         x(inline_data,                  8)      \
1363         x(new_extent_overwrite,         9)      \
1364         x(incompressible,               10)     \
1365         x(btree_ptr_v2,                 11)     \
1366         x(extents_above_btree_updates,  12)     \
1367         x(btree_updates_journalled,     13)     \
1368         x(reflink_inline_data,          14)     \
1369         x(new_varint,                   15)     \
1370         x(journal_no_flush,             16)     \
1371         x(alloc_v2,                     17)     \
1372         x(extents_across_btree_nodes,   18)
1373
1374 #define BCH_SB_FEATURES_ALWAYS                          \
1375         ((1ULL << BCH_FEATURE_new_extent_overwrite)|    \
1376          (1ULL << BCH_FEATURE_extents_above_btree_updates)|\
1377          (1ULL << BCH_FEATURE_btree_updates_journalled)|\
1378          (1ULL << BCH_FEATURE_extents_across_btree_nodes))
1379
1380 #define BCH_SB_FEATURES_ALL                             \
1381         (BCH_SB_FEATURES_ALWAYS|                        \
1382          (1ULL << BCH_FEATURE_new_siphash)|             \
1383          (1ULL << BCH_FEATURE_btree_ptr_v2)|            \
1384          (1ULL << BCH_FEATURE_new_varint)|              \
1385          (1ULL << BCH_FEATURE_journal_no_flush)|        \
1386          (1ULL << BCH_FEATURE_alloc_v2))
1387
1388 enum bch_sb_feature {
1389 #define x(f, n) BCH_FEATURE_##f,
1390         BCH_SB_FEATURES()
1391 #undef x
1392         BCH_FEATURE_NR,
1393 };
1394
1395 enum bch_sb_compat {
1396         BCH_COMPAT_FEAT_ALLOC_INFO      = 0,
1397         BCH_COMPAT_FEAT_ALLOC_METADATA  = 1,
1398 };
1399
1400 /* options: */
1401
1402 #define BCH_REPLICAS_MAX                4U
1403
1404 #define BCH_BKEY_PTRS_MAX               16U
1405
1406 #define BCH_ERROR_ACTIONS()             \
1407         x(continue,             0)      \
1408         x(ro,                   1)      \
1409         x(panic,                2)
1410
1411 enum bch_error_actions {
1412 #define x(t, n) BCH_ON_ERROR_##t = n,
1413         BCH_ERROR_ACTIONS()
1414 #undef x
1415         BCH_ON_ERROR_NR
1416 };
1417
1418 enum bch_str_hash_type {
1419         BCH_STR_HASH_CRC32C             = 0,
1420         BCH_STR_HASH_CRC64              = 1,
1421         BCH_STR_HASH_SIPHASH_OLD        = 2,
1422         BCH_STR_HASH_SIPHASH            = 3,
1423         BCH_STR_HASH_NR                 = 4,
1424 };
1425
1426 #define BCH_STR_HASH_OPTS()             \
1427         x(crc32c,               0)      \
1428         x(crc64,                1)      \
1429         x(siphash,              2)
1430
1431 enum bch_str_hash_opts {
1432 #define x(t, n) BCH_STR_HASH_OPT_##t = n,
1433         BCH_STR_HASH_OPTS()
1434 #undef x
1435         BCH_STR_HASH_OPT_NR
1436 };
1437
1438 enum bch_csum_type {
1439         BCH_CSUM_NONE                   = 0,
1440         BCH_CSUM_CRC32C_NONZERO         = 1,
1441         BCH_CSUM_CRC64_NONZERO          = 2,
1442         BCH_CSUM_CHACHA20_POLY1305_80   = 3,
1443         BCH_CSUM_CHACHA20_POLY1305_128  = 4,
1444         BCH_CSUM_CRC32C                 = 5,
1445         BCH_CSUM_CRC64                  = 6,
1446         BCH_CSUM_NR                     = 7,
1447 };
1448
1449 static const unsigned bch_crc_bytes[] = {
1450         [BCH_CSUM_NONE]                         = 0,
1451         [BCH_CSUM_CRC32C_NONZERO]               = 4,
1452         [BCH_CSUM_CRC32C]                       = 4,
1453         [BCH_CSUM_CRC64_NONZERO]                = 8,
1454         [BCH_CSUM_CRC64]                        = 8,
1455         [BCH_CSUM_CHACHA20_POLY1305_80]         = 10,
1456         [BCH_CSUM_CHACHA20_POLY1305_128]        = 16,
1457 };
1458
1459 static inline _Bool bch2_csum_type_is_encryption(enum bch_csum_type type)
1460 {
1461         switch (type) {
1462         case BCH_CSUM_CHACHA20_POLY1305_80:
1463         case BCH_CSUM_CHACHA20_POLY1305_128:
1464                 return true;
1465         default:
1466                 return false;
1467         }
1468 }
1469
1470 #define BCH_CSUM_OPTS()                 \
1471         x(none,                 0)      \
1472         x(crc32c,               1)      \
1473         x(crc64,                2)
1474
1475 enum bch_csum_opts {
1476 #define x(t, n) BCH_CSUM_OPT_##t = n,
1477         BCH_CSUM_OPTS()
1478 #undef x
1479         BCH_CSUM_OPT_NR
1480 };
1481
1482 #define BCH_COMPRESSION_TYPES()         \
1483         x(none,                 0)      \
1484         x(lz4_old,              1)      \
1485         x(gzip,                 2)      \
1486         x(lz4,                  3)      \
1487         x(zstd,                 4)      \
1488         x(incompressible,       5)
1489
1490 enum bch_compression_type {
1491 #define x(t, n) BCH_COMPRESSION_TYPE_##t = n,
1492         BCH_COMPRESSION_TYPES()
1493 #undef x
1494         BCH_COMPRESSION_TYPE_NR
1495 };
1496
1497 #define BCH_COMPRESSION_OPTS()          \
1498         x(none,         0)              \
1499         x(lz4,          1)              \
1500         x(gzip,         2)              \
1501         x(zstd,         3)
1502
1503 enum bch_compression_opts {
1504 #define x(t, n) BCH_COMPRESSION_OPT_##t = n,
1505         BCH_COMPRESSION_OPTS()
1506 #undef x
1507         BCH_COMPRESSION_OPT_NR
1508 };
1509
1510 /*
1511  * Magic numbers
1512  *
1513  * The various other data structures have their own magic numbers, which are
1514  * xored with the first part of the cache set's UUID
1515  */
1516
1517 #define BCACHE_MAGIC                                                    \
1518         UUID_LE(0xf67385c6, 0x1a4e, 0xca45,                             \
1519                 0x82, 0x65, 0xf5, 0x7f, 0x48, 0xba, 0x6d, 0x81)
1520
1521 #define BCACHEFS_STATFS_MAGIC           0xca451a4e
1522
1523 #define JSET_MAGIC              __cpu_to_le64(0x245235c1a3625032ULL)
1524 #define BSET_MAGIC              __cpu_to_le64(0x90135c78b99e07f5ULL)
1525
1526 static inline __le64 __bch2_sb_magic(struct bch_sb *sb)
1527 {
1528         __le64 ret;
1529         memcpy(&ret, &sb->uuid, sizeof(ret));
1530         return ret;
1531 }
1532
1533 static inline __u64 __jset_magic(struct bch_sb *sb)
1534 {
1535         return __le64_to_cpu(__bch2_sb_magic(sb) ^ JSET_MAGIC);
1536 }
1537
1538 static inline __u64 __bset_magic(struct bch_sb *sb)
1539 {
1540         return __le64_to_cpu(__bch2_sb_magic(sb) ^ BSET_MAGIC);
1541 }
1542
1543 /* Journal */
1544
1545 #define JSET_KEYS_U64s  (sizeof(struct jset_entry) / sizeof(__u64))
1546
1547 #define BCH_JSET_ENTRY_TYPES()                  \
1548         x(btree_keys,           0)              \
1549         x(btree_root,           1)              \
1550         x(prio_ptrs,            2)              \
1551         x(blacklist,            3)              \
1552         x(blacklist_v2,         4)              \
1553         x(usage,                5)              \
1554         x(data_usage,           6)              \
1555         x(clock,                7)              \
1556         x(dev_usage,            8)
1557
1558 enum {
1559 #define x(f, nr)        BCH_JSET_ENTRY_##f      = nr,
1560         BCH_JSET_ENTRY_TYPES()
1561 #undef x
1562         BCH_JSET_ENTRY_NR
1563 };
1564
1565 /*
1566  * Journal sequence numbers can be blacklisted: bsets record the max sequence
1567  * number of all the journal entries they contain updates for, so that on
1568  * recovery we can ignore those bsets that contain index updates newer that what
1569  * made it into the journal.
1570  *
1571  * This means that we can't reuse that journal_seq - we have to skip it, and
1572  * then record that we skipped it so that the next time we crash and recover we
1573  * don't think there was a missing journal entry.
1574  */
1575 struct jset_entry_blacklist {
1576         struct jset_entry       entry;
1577         __le64                  seq;
1578 };
1579
1580 struct jset_entry_blacklist_v2 {
1581         struct jset_entry       entry;
1582         __le64                  start;
1583         __le64                  end;
1584 };
1585
1586 enum {
1587         FS_USAGE_RESERVED               = 0,
1588         FS_USAGE_INODES                 = 1,
1589         FS_USAGE_KEY_VERSION            = 2,
1590         FS_USAGE_NR                     = 3
1591 };
1592
1593 struct jset_entry_usage {
1594         struct jset_entry       entry;
1595         __le64                  v;
1596 } __attribute__((packed));
1597
1598 struct jset_entry_data_usage {
1599         struct jset_entry       entry;
1600         __le64                  v;
1601         struct bch_replicas_entry r;
1602 } __attribute__((packed));
1603
1604 struct jset_entry_clock {
1605         struct jset_entry       entry;
1606         __u8                    rw;
1607         __u8                    pad[7];
1608         __le64                  time;
1609 } __attribute__((packed));
1610
1611 struct jset_entry_dev_usage_type {
1612         __le64                  buckets;
1613         __le64                  sectors;
1614         __le64                  fragmented;
1615 } __attribute__((packed));
1616
1617 struct jset_entry_dev_usage {
1618         struct jset_entry       entry;
1619         __le32                  dev;
1620         __u32                   pad;
1621
1622         __le64                  buckets_ec;
1623         __le64                  buckets_unavailable;
1624
1625         struct jset_entry_dev_usage_type d[];
1626 } __attribute__((packed));
1627
1628 /*
1629  * On disk format for a journal entry:
1630  * seq is monotonically increasing; every journal entry has its own unique
1631  * sequence number.
1632  *
1633  * last_seq is the oldest journal entry that still has keys the btree hasn't
1634  * flushed to disk yet.
1635  *
1636  * version is for on disk format changes.
1637  */
1638 struct jset {
1639         struct bch_csum         csum;
1640
1641         __le64                  magic;
1642         __le64                  seq;
1643         __le32                  version;
1644         __le32                  flags;
1645
1646         __le32                  u64s; /* size of d[] in u64s */
1647
1648         __u8                    encrypted_start[0];
1649
1650         __le16                  _read_clock; /* no longer used */
1651         __le16                  _write_clock;
1652
1653         /* Sequence number of oldest dirty journal entry */
1654         __le64                  last_seq;
1655
1656
1657         union {
1658                 struct jset_entry start[0];
1659                 __u64           _data[0];
1660         };
1661 } __attribute__((packed, aligned(8)));
1662
1663 LE32_BITMASK(JSET_CSUM_TYPE,    struct jset, flags, 0, 4);
1664 LE32_BITMASK(JSET_BIG_ENDIAN,   struct jset, flags, 4, 5);
1665 LE32_BITMASK(JSET_NO_FLUSH,     struct jset, flags, 5, 6);
1666
1667 #define BCH_JOURNAL_BUCKETS_MIN         8
1668
1669 /* Btree: */
1670
1671 #define BCH_BTREE_IDS()                         \
1672         x(extents,      0)                      \
1673         x(inodes,       1)                      \
1674         x(dirents,      2)                      \
1675         x(xattrs,       3)                      \
1676         x(alloc,        4)                      \
1677         x(quotas,       5)                      \
1678         x(stripes,      6)                      \
1679         x(reflink,      7)
1680
1681 enum btree_id {
1682 #define x(kwd, val) BTREE_ID_##kwd = val,
1683         BCH_BTREE_IDS()
1684 #undef x
1685         BTREE_ID_NR
1686 };
1687
1688 #define BTREE_MAX_DEPTH         4U
1689
1690 /* Btree nodes */
1691
1692 /*
1693  * Btree nodes
1694  *
1695  * On disk a btree node is a list/log of these; within each set the keys are
1696  * sorted
1697  */
1698 struct bset {
1699         __le64                  seq;
1700
1701         /*
1702          * Highest journal entry this bset contains keys for.
1703          * If on recovery we don't see that journal entry, this bset is ignored:
1704          * this allows us to preserve the order of all index updates after a
1705          * crash, since the journal records a total order of all index updates
1706          * and anything that didn't make it to the journal doesn't get used.
1707          */
1708         __le64                  journal_seq;
1709
1710         __le32                  flags;
1711         __le16                  version;
1712         __le16                  u64s; /* count of d[] in u64s */
1713
1714         union {
1715                 struct bkey_packed start[0];
1716                 __u64           _data[0];
1717         };
1718 } __attribute__((packed, aligned(8)));
1719
1720 LE32_BITMASK(BSET_CSUM_TYPE,    struct bset, flags, 0, 4);
1721
1722 LE32_BITMASK(BSET_BIG_ENDIAN,   struct bset, flags, 4, 5);
1723 LE32_BITMASK(BSET_SEPARATE_WHITEOUTS,
1724                                 struct bset, flags, 5, 6);
1725
1726 struct btree_node {
1727         struct bch_csum         csum;
1728         __le64                  magic;
1729
1730         /* this flags field is encrypted, unlike bset->flags: */
1731         __le64                  flags;
1732
1733         /* Closed interval: */
1734         struct bpos             min_key;
1735         struct bpos             max_key;
1736         struct bch_extent_ptr   ptr;
1737         struct bkey_format      format;
1738
1739         union {
1740         struct bset             keys;
1741         struct {
1742                 __u8            pad[22];
1743                 __le16          u64s;
1744                 __u64           _data[0];
1745
1746         };
1747         };
1748 } __attribute__((packed, aligned(8)));
1749
1750 LE64_BITMASK(BTREE_NODE_ID,     struct btree_node, flags,  0,  4);
1751 LE64_BITMASK(BTREE_NODE_LEVEL,  struct btree_node, flags,  4,  8);
1752 LE64_BITMASK(BTREE_NODE_NEW_EXTENT_OVERWRITE,
1753                                 struct btree_node, flags,  8,  9);
1754 /* 9-32 unused */
1755 LE64_BITMASK(BTREE_NODE_SEQ,    struct btree_node, flags, 32, 64);
1756
1757 struct btree_node_entry {
1758         struct bch_csum         csum;
1759
1760         union {
1761         struct bset             keys;
1762         struct {
1763                 __u8            pad[22];
1764                 __le16          u64s;
1765                 __u64           _data[0];
1766
1767         };
1768         };
1769 } __attribute__((packed, aligned(8)));
1770
1771 #endif /* _BCACHEFS_FORMAT_H */