1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _BCACHEFS_FORMAT_H
3 #define _BCACHEFS_FORMAT_H
6 * bcachefs on disk data structures
10 * There are three main types of on disk data structures in bcachefs (this is
11 * reduced from 5 in bcache)
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.
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
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.
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.
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.
42 * The journal also contains entry types for the btree roots, and blacklisted
43 * journal sequence numbers (see journal_seq_blacklist.c).
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
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
58 * BTREE KEYS (struct bkey):
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.
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).
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.
75 #include <asm/types.h>
76 #include <asm/byteorder.h>
77 #include <linux/kernel.h>
78 #include <linux/uuid.h>
81 #define BITMASK(name, type, field, offset, end) \
82 static const unsigned name##_OFFSET = offset; \
83 static const unsigned name##_BITS = (end - offset); \
85 static inline __u64 name(const type *k) \
87 return (k->field >> offset) & ~(~0ULL << (end - offset)); \
90 static inline void SET_##name(type *k, __u64 v) \
92 k->field &= ~(~(~0ULL << (end - offset)) << offset); \
93 k->field |= (v & ~(~0ULL << (end - offset))) << offset; \
96 #define LE_BITMASK(_bits, name, type, field, offset, end) \
97 static const unsigned name##_OFFSET = offset; \
98 static const unsigned name##_BITS = (end - offset); \
99 static const __u##_bits name##_MAX = (1ULL << (end - offset)) - 1; \
101 static inline __u64 name(const type *k) \
103 return (__le##_bits##_to_cpu(k->field) >> offset) & \
104 ~(~0ULL << (end - offset)); \
107 static inline void SET_##name(type *k, __u64 v) \
109 __u##_bits new = __le##_bits##_to_cpu(k->field); \
111 new &= ~(~(~0ULL << (end - offset)) << offset); \
112 new |= (v & ~(~0ULL << (end - offset))) << offset; \
113 k->field = __cpu_to_le##_bits(new); \
116 #define LE16_BITMASK(n, t, f, o, e) LE_BITMASK(16, n, t, f, o, e)
117 #define LE32_BITMASK(n, t, f, o, e) LE_BITMASK(32, n, t, f, o, e)
118 #define LE64_BITMASK(n, t, f, o, e) LE_BITMASK(64, n, t, f, o, e)
123 /* One unused slot for now: */
124 __u8 bits_per_field[6];
125 __le64 field_offset[6];
128 /* Btree keys - all units are in sectors */
132 * Word order matches machine byte order - btree code treats a bpos as a
133 * single large integer, for search/comparison purposes
135 * Note that wherever a bpos is embedded in another on disk data
136 * structure, it has to be byte swabbed when reading in metadata that
137 * wasn't written in native endian order:
139 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
143 #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
145 __u64 offset; /* Points to end of extent - sectors */
148 #error edit for your odd byteorder.
150 } __packed __aligned(4);
152 #define KEY_INODE_MAX ((__u64)~0ULL)
153 #define KEY_OFFSET_MAX ((__u64)~0ULL)
154 #define KEY_SNAPSHOT_MAX ((__u32)~0U)
155 #define KEY_SIZE_MAX ((__u32)~0U)
157 static inline struct bpos SPOS(__u64 inode, __u64 offset, __u32 snapshot)
159 return (struct bpos) {
162 .snapshot = snapshot,
166 #define POS_MIN SPOS(0, 0, 0)
167 #define POS_MAX SPOS(KEY_INODE_MAX, KEY_OFFSET_MAX, 0)
168 #define SPOS_MAX SPOS(KEY_INODE_MAX, KEY_OFFSET_MAX, KEY_SNAPSHOT_MAX)
169 #define POS(_inode, _offset) SPOS(_inode, _offset, 0)
171 /* Empty placeholder struct, for container_of() */
177 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
180 #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
184 } __packed __aligned(4);
187 /* Size of combined key and value, in u64s */
190 /* Format of key (0 for format local to btree node) */
191 #if defined(__LITTLE_ENDIAN_BITFIELD)
194 #elif defined (__BIG_ENDIAN_BITFIELD)
195 __u8 needs_whiteout:1,
198 #error edit for your odd byteorder.
201 /* Type of the value */
204 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
207 struct bversion version;
208 __u32 size; /* extent size, in sectors */
210 #elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
212 __u32 size; /* extent size, in sectors */
213 struct bversion version;
217 } __packed __aligned(8);
222 /* Size of combined key and value, in u64s */
225 /* Format of key (0 for format local to btree node) */
228 * XXX: next incompat on disk format change, switch format and
229 * needs_whiteout - bkey_packed() will be cheaper if format is the high
230 * bits of the bitfield
232 #if defined(__LITTLE_ENDIAN_BITFIELD)
235 #elif defined (__BIG_ENDIAN_BITFIELD)
236 __u8 needs_whiteout:1,
240 /* Type of the value */
245 * We copy bkeys with struct assignment in various places, and while
246 * that shouldn't be done with packed bkeys we can't disallow it in C,
247 * and it's legal to cast a bkey to a bkey_packed - so padding it out
248 * to the same size as struct bkey should hopefully be safest.
250 __u8 pad[sizeof(struct bkey) - 3];
251 } __packed __aligned(8);
253 #define BKEY_U64s (sizeof(struct bkey) / sizeof(__u64))
254 #define BKEY_U64s_MAX U8_MAX
255 #define BKEY_VAL_U64s_MAX (BKEY_U64s_MAX - BKEY_U64s)
257 #define KEY_PACKED_BITS_START 24
259 #define KEY_FORMAT_LOCAL_BTREE 0
260 #define KEY_FORMAT_CURRENT 1
262 enum bch_bkey_fields {
267 BKEY_FIELD_VERSION_HI,
268 BKEY_FIELD_VERSION_LO,
272 #define bkey_format_field(name, field) \
273 [BKEY_FIELD_##name] = (sizeof(((struct bkey *) NULL)->field) * 8)
275 #define BKEY_FORMAT_CURRENT \
276 ((struct bkey_format) { \
277 .key_u64s = BKEY_U64s, \
278 .nr_fields = BKEY_NR_FIELDS, \
279 .bits_per_field = { \
280 bkey_format_field(INODE, p.inode), \
281 bkey_format_field(OFFSET, p.offset), \
282 bkey_format_field(SNAPSHOT, p.snapshot), \
283 bkey_format_field(SIZE, size), \
284 bkey_format_field(VERSION_HI, version.hi), \
285 bkey_format_field(VERSION_LO, version.lo), \
289 /* bkey with inline value */
295 /* Size of combined key and value, in u64s */
305 #define KEY(_inode, _offset, _size) \
308 .format = KEY_FORMAT_CURRENT, \
309 .p = POS(_inode, _offset), \
313 static inline void bkey_init(struct bkey *k)
318 #define bkey_bytes(_k) ((_k)->u64s * sizeof(__u64))
320 #define __BKEY_PADDED(key, pad) \
321 struct { struct bkey_i key; __u64 key ## _pad[pad]; }
324 * - DELETED keys are used internally to mark keys that should be ignored but
325 * override keys in composition order. Their version number is ignored.
327 * - DISCARDED keys indicate that the data is all 0s because it has been
328 * discarded. DISCARDs may have a version; if the version is nonzero the key
329 * will be persistent, otherwise the key will be dropped whenever the btree
330 * node is rewritten (like DELETED keys).
332 * - ERROR: any read of the data returns a read error, as the data was lost due
333 * to a failing device. Like DISCARDED keys, they can be removed (overridden)
334 * by new writes or cluster-wide GC. Node repair can also overwrite them with
335 * the same or a more recent version number, but not with an older version
338 * - WHITEOUT: for hash table btrees
340 #define BCH_BKEY_TYPES() \
345 x(hash_whiteout, 4) \
350 x(inode_generation, 9) \
359 x(btree_ptr_v2, 18) \
360 x(indirect_inline_data, 19) \
373 #define x(name, nr) KEY_TYPE_##name = nr,
383 struct bch_whiteout {
396 struct bch_hash_whiteout {
407 * In extent bkeys, the value is a list of pointers (bch_extent_ptr), optionally
408 * preceded by checksum/compression information (bch_extent_crc32 or
411 * One major determining factor in the format of extents is how we handle and
412 * represent extents that have been partially overwritten and thus trimmed:
414 * If an extent is not checksummed or compressed, when the extent is trimmed we
415 * don't have to remember the extent we originally allocated and wrote: we can
416 * merely adjust ptr->offset to point to the start of the data that is currently
417 * live. The size field in struct bkey records the current (live) size of the
418 * extent, and is also used to mean "size of region on disk that we point to" in
421 * Thus an extent that is not checksummed or compressed will consist only of a
422 * list of bch_extent_ptrs, with none of the fields in
423 * bch_extent_crc32/bch_extent_crc64.
425 * When an extent is checksummed or compressed, it's not possible to read only
426 * the data that is currently live: we have to read the entire extent that was
427 * originally written, and then return only the part of the extent that is
430 * Thus, in addition to the current size of the extent in struct bkey, we need
431 * to store the size of the originally allocated space - this is the
432 * compressed_size and uncompressed_size fields in bch_extent_crc32/64. Also,
433 * when the extent is trimmed, instead of modifying the offset field of the
434 * pointer, we keep a second smaller offset field - "offset into the original
435 * extent of the currently live region".
437 * The other major determining factor is replication and data migration:
439 * Each pointer may have its own bch_extent_crc32/64. When doing a replicated
440 * write, we will initially write all the replicas in the same format, with the
441 * same checksum type and compression format - however, when copygc runs later (or
442 * tiering/cache promotion, anything that moves data), it is not in general
443 * going to rewrite all the pointers at once - one of the replicas may be in a
444 * bucket on one device that has very little fragmentation while another lives
445 * in a bucket that has become heavily fragmented, and thus is being rewritten
446 * sooner than the rest.
448 * Thus it will only move a subset of the pointers (or in the case of
449 * tiering/cache promotion perhaps add a single pointer without dropping any
450 * current pointers), and if the extent has been partially overwritten it must
451 * write only the currently live portion (or copygc would not be able to reduce
452 * fragmentation!) - which necessitates a different bch_extent_crc format for
455 * But in the interests of space efficiency, we don't want to store one
456 * bch_extent_crc for each pointer if we don't have to.
458 * Thus, a bch_extent consists of bch_extent_crc32s, bch_extent_crc64s, and
459 * bch_extent_ptrs appended arbitrarily one after the other. We determine the
460 * type of a given entry with a scheme similar to utf8 (except we're encoding a
461 * type, not a size), encoding the type in the position of the first set bit:
463 * bch_extent_crc32 - 0b1
464 * bch_extent_ptr - 0b10
465 * bch_extent_crc64 - 0b100
467 * We do it this way because bch_extent_crc32 is _very_ constrained on bits (and
468 * bch_extent_crc64 is the least constrained).
470 * Then, each bch_extent_crc32/64 applies to the pointers that follow after it,
471 * until the next bch_extent_crc32/64.
473 * If there are no bch_extent_crcs preceding a bch_extent_ptr, then that pointer
474 * is neither checksummed nor compressed.
477 /* 128 bits, sufficient for cryptographic MACs: */
481 } __packed __aligned(8);
483 #define BCH_EXTENT_ENTRY_TYPES() \
489 #define BCH_EXTENT_ENTRY_MAX 5
491 enum bch_extent_entry_type {
492 #define x(f, n) BCH_EXTENT_ENTRY_##f = n,
493 BCH_EXTENT_ENTRY_TYPES()
497 /* Compressed/uncompressed size are stored biased by 1: */
498 struct bch_extent_crc32 {
499 #if defined(__LITTLE_ENDIAN_BITFIELD)
502 _uncompressed_size:7,
508 #elif defined (__BIG_ENDIAN_BITFIELD)
510 __u32 compression_type:4,
514 _uncompressed_size:7,
518 } __packed __aligned(8);
520 #define CRC32_SIZE_MAX (1U << 7)
521 #define CRC32_NONCE_MAX 0
523 struct bch_extent_crc64 {
524 #if defined(__LITTLE_ENDIAN_BITFIELD)
527 _uncompressed_size:9,
533 #elif defined (__BIG_ENDIAN_BITFIELD)
539 _uncompressed_size:9,
544 } __packed __aligned(8);
546 #define CRC64_SIZE_MAX (1U << 9)
547 #define CRC64_NONCE_MAX ((1U << 10) - 1)
549 struct bch_extent_crc128 {
550 #if defined(__LITTLE_ENDIAN_BITFIELD)
553 _uncompressed_size:13,
558 #elif defined (__BIG_ENDIAN_BITFIELD)
559 __u64 compression_type:4,
563 _uncompressed_size:13,
567 struct bch_csum csum;
568 } __packed __aligned(8);
570 #define CRC128_SIZE_MAX (1U << 13)
571 #define CRC128_NONCE_MAX ((1U << 13) - 1)
574 * @reservation - pointer hasn't been written to, just reserved
576 struct bch_extent_ptr {
577 #if defined(__LITTLE_ENDIAN_BITFIELD)
582 offset:44, /* 8 petabytes */
585 #elif defined (__BIG_ENDIAN_BITFIELD)
594 } __packed __aligned(8);
596 struct bch_extent_stripe_ptr {
597 #if defined(__LITTLE_ENDIAN_BITFIELD)
602 #elif defined (__BIG_ENDIAN_BITFIELD)
610 struct bch_extent_reservation {
611 #if defined(__LITTLE_ENDIAN_BITFIELD)
616 #elif defined (__BIG_ENDIAN_BITFIELD)
624 union bch_extent_entry {
625 #if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__ || __BITS_PER_LONG == 64
627 #elif __BITS_PER_LONG == 32
633 #error edit for your odd byteorder.
636 #define x(f, n) struct bch_extent_##f f;
637 BCH_EXTENT_ENTRY_TYPES()
641 struct bch_btree_ptr {
645 struct bch_extent_ptr start[];
646 } __packed __aligned(8);
648 struct bch_btree_ptr_v2 {
653 __le16 sectors_written;
657 struct bch_extent_ptr start[];
658 } __packed __aligned(8);
660 LE16_BITMASK(BTREE_PTR_RANGE_UPDATED, struct bch_btree_ptr_v2, flags, 0, 1);
666 union bch_extent_entry start[];
667 } __packed __aligned(8);
669 struct bch_reservation {
675 } __packed __aligned(8);
677 /* Maximum size (in u64s) a single pointer could be: */
678 #define BKEY_EXTENT_PTR_U64s_MAX\
679 ((sizeof(struct bch_extent_crc128) + \
680 sizeof(struct bch_extent_ptr)) / sizeof(u64))
682 /* Maximum possible size of an entire extent value: */
683 #define BKEY_EXTENT_VAL_U64s_MAX \
684 (1 + BKEY_EXTENT_PTR_U64s_MAX * (BCH_REPLICAS_MAX + 1))
686 /* * Maximum possible size of an entire extent, key + value: */
687 #define BKEY_EXTENT_U64s_MAX (BKEY_U64s + BKEY_EXTENT_VAL_U64s_MAX)
689 /* Btree pointers don't carry around checksums: */
690 #define BKEY_BTREE_PTR_VAL_U64s_MAX \
691 ((sizeof(struct bch_btree_ptr_v2) + \
692 sizeof(struct bch_extent_ptr) * BCH_REPLICAS_MAX) / sizeof(u64))
693 #define BKEY_BTREE_PTR_U64s_MAX \
694 (BKEY_U64s + BKEY_BTREE_PTR_VAL_U64s_MAX)
698 #define BLOCKDEV_INODE_MAX 4096
700 #define BCACHEFS_ROOT_INO 4096
709 } __packed __aligned(8);
711 struct bch_inode_v2 {
714 __le64 bi_journal_seq;
719 } __packed __aligned(8);
721 struct bch_inode_v3 {
724 __le64 bi_journal_seq;
731 } __packed __aligned(8);
733 #define INODEv3_FIELDS_START_INITIAL 6
734 #define INODEv3_FIELDS_START_CUR (offsetof(struct bch_inode_v3, fields) / sizeof(u64))
736 struct bch_inode_generation {
739 __le32 bi_generation;
741 } __packed __aligned(8);
744 * bi_subvol and bi_parent_subvol are only set for subvolume roots:
747 #define BCH_INODE_FIELDS_v2() \
757 x(bi_generation, 32) \
759 x(bi_data_checksum, 8) \
760 x(bi_compression, 8) \
762 x(bi_background_compression, 8) \
763 x(bi_data_replicas, 8) \
764 x(bi_promote_target, 16) \
765 x(bi_foreground_target, 16) \
766 x(bi_background_target, 16) \
767 x(bi_erasure_code, 16) \
768 x(bi_fields_set, 16) \
770 x(bi_dir_offset, 64) \
772 x(bi_parent_subvol, 32)
774 #define BCH_INODE_FIELDS_v3() \
782 x(bi_generation, 32) \
784 x(bi_data_checksum, 8) \
785 x(bi_compression, 8) \
787 x(bi_background_compression, 8) \
788 x(bi_data_replicas, 8) \
789 x(bi_promote_target, 16) \
790 x(bi_foreground_target, 16) \
791 x(bi_background_target, 16) \
792 x(bi_erasure_code, 16) \
793 x(bi_fields_set, 16) \
795 x(bi_dir_offset, 64) \
797 x(bi_parent_subvol, 32)
799 /* subset of BCH_INODE_FIELDS */
800 #define BCH_INODE_OPTS() \
801 x(data_checksum, 8) \
804 x(background_compression, 8) \
805 x(data_replicas, 8) \
806 x(promote_target, 16) \
807 x(foreground_target, 16) \
808 x(background_target, 16) \
812 #define x(name, ...) \
821 * User flags (get/settable with FS_IOC_*FLAGS, correspond to FS_*_FL
824 __BCH_INODE_SYNC = 0,
825 __BCH_INODE_IMMUTABLE = 1,
826 __BCH_INODE_APPEND = 2,
827 __BCH_INODE_NODUMP = 3,
828 __BCH_INODE_NOATIME = 4,
830 __BCH_INODE_I_SIZE_DIRTY = 5,
831 __BCH_INODE_I_SECTORS_DIRTY = 6,
832 __BCH_INODE_UNLINKED = 7,
833 __BCH_INODE_BACKPTR_UNTRUSTED = 8,
835 /* bits 20+ reserved for packed fields below: */
838 #define BCH_INODE_SYNC (1 << __BCH_INODE_SYNC)
839 #define BCH_INODE_IMMUTABLE (1 << __BCH_INODE_IMMUTABLE)
840 #define BCH_INODE_APPEND (1 << __BCH_INODE_APPEND)
841 #define BCH_INODE_NODUMP (1 << __BCH_INODE_NODUMP)
842 #define BCH_INODE_NOATIME (1 << __BCH_INODE_NOATIME)
843 #define BCH_INODE_I_SIZE_DIRTY (1 << __BCH_INODE_I_SIZE_DIRTY)
844 #define BCH_INODE_I_SECTORS_DIRTY (1 << __BCH_INODE_I_SECTORS_DIRTY)
845 #define BCH_INODE_UNLINKED (1 << __BCH_INODE_UNLINKED)
846 #define BCH_INODE_BACKPTR_UNTRUSTED (1 << __BCH_INODE_BACKPTR_UNTRUSTED)
848 LE32_BITMASK(INODE_STR_HASH, struct bch_inode, bi_flags, 20, 24);
849 LE32_BITMASK(INODE_NR_FIELDS, struct bch_inode, bi_flags, 24, 31);
850 LE32_BITMASK(INODE_NEW_VARINT, struct bch_inode, bi_flags, 31, 32);
852 LE64_BITMASK(INODEv2_STR_HASH, struct bch_inode_v2, bi_flags, 20, 24);
853 LE64_BITMASK(INODEv2_NR_FIELDS, struct bch_inode_v2, bi_flags, 24, 31);
855 LE64_BITMASK(INODEv3_STR_HASH, struct bch_inode_v3, bi_flags, 20, 24);
856 LE64_BITMASK(INODEv3_NR_FIELDS, struct bch_inode_v3, bi_flags, 24, 31);
858 LE64_BITMASK(INODEv3_FIELDS_START,
859 struct bch_inode_v3, bi_flags, 31, 36);
860 LE64_BITMASK(INODEv3_MODE, struct bch_inode_v3, bi_flags, 36, 52);
865 * Dirents (and xattrs) have to implement string lookups; since our b-tree
866 * doesn't support arbitrary length strings for the key, we instead index by a
867 * 64 bit hash (currently truncated sha1) of the string, stored in the offset
868 * field of the key - using linear probing to resolve hash collisions. This also
869 * provides us with the readdir cookie posix requires.
871 * Linear probing requires us to use whiteouts for deletions, in the event of a
878 /* Target inode number: */
881 struct { /* DT_SUBVOL */
882 __le32 d_child_subvol;
883 __le32 d_parent_subvol;
888 * Copy of mode bits 12-15 from the target inode - so userspace can get
889 * the filetype without having to do a stat()
894 } __packed __aligned(8);
897 #define BCH_DT_MAX 17
899 #define BCH_NAME_MAX ((unsigned) (U8_MAX * sizeof(u64) - \
900 sizeof(struct bkey) - \
901 offsetof(struct bch_dirent, d_name)))
905 #define KEY_TYPE_XATTR_INDEX_USER 0
906 #define KEY_TYPE_XATTR_INDEX_POSIX_ACL_ACCESS 1
907 #define KEY_TYPE_XATTR_INDEX_POSIX_ACL_DEFAULT 2
908 #define KEY_TYPE_XATTR_INDEX_TRUSTED 3
909 #define KEY_TYPE_XATTR_INDEX_SECURITY 4
917 } __packed __aligned(8);
919 /* Bucket/allocation information: */
926 } __packed __aligned(8);
928 #define BCH_ALLOC_FIELDS_V1() \
932 x(dirty_sectors, 16) \
933 x(cached_sectors, 16) \
936 x(stripe_redundancy, 8)
939 #define x(name, _bits) BCH_ALLOC_FIELD_V1_##name,
940 BCH_ALLOC_FIELDS_V1()
944 struct bch_alloc_v2 {
951 } __packed __aligned(8);
953 #define BCH_ALLOC_FIELDS_V2() \
956 x(dirty_sectors, 32) \
957 x(cached_sectors, 32) \
959 x(stripe_redundancy, 8)
961 struct bch_alloc_v3 {
970 } __packed __aligned(8);
972 LE32_BITMASK(BCH_ALLOC_V3_NEED_DISCARD,struct bch_alloc_v3, flags, 0, 1)
973 LE32_BITMASK(BCH_ALLOC_V3_NEED_INC_GEN,struct bch_alloc_v3, flags, 1, 2)
975 struct bch_alloc_v4 {
982 __u8 stripe_redundancy;
984 __u32 cached_sectors;
987 __u32 nr_external_backpointers;
988 } __packed __aligned(8);
990 #define BCH_ALLOC_V4_U64s_V0 6
991 #define BCH_ALLOC_V4_U64s (sizeof(struct bch_alloc_v4) / sizeof(u64))
993 BITMASK(BCH_ALLOC_V4_NEED_DISCARD, struct bch_alloc_v4, flags, 0, 1)
994 BITMASK(BCH_ALLOC_V4_NEED_INC_GEN, struct bch_alloc_v4, flags, 1, 2)
995 BITMASK(BCH_ALLOC_V4_BACKPOINTERS_START,struct bch_alloc_v4, flags, 2, 8)
996 BITMASK(BCH_ALLOC_V4_NR_BACKPOINTERS, struct bch_alloc_v4, flags, 8, 14)
998 #define BCH_ALLOC_V4_NR_BACKPOINTERS_MAX 40
1000 struct bch_backpointer {
1005 __u64 bucket_offset:40;
1008 } __packed __aligned(8);
1019 enum quota_counters {
1025 struct bch_quota_counter {
1032 struct bch_quota_counter c[Q_COUNTERS];
1033 } __packed __aligned(8);
1035 /* Erasure coding */
1044 __u8 csum_granularity_bits;
1048 struct bch_extent_ptr ptrs[];
1049 } __packed __aligned(8);
1053 struct bch_reflink_p {
1057 * A reflink pointer might point to an indirect extent which is then
1058 * later split (by copygc or rebalance). If we only pointed to part of
1059 * the original indirect extent, and then one of the fragments is
1060 * outside the range we point to, we'd leak a refcount: so when creating
1061 * reflink pointers, we need to store pad values to remember the full
1062 * range we were taking a reference on.
1066 } __packed __aligned(8);
1068 struct bch_reflink_v {
1071 union bch_extent_entry start[0];
1073 } __packed __aligned(8);
1075 struct bch_indirect_inline_data {
1083 struct bch_inline_data {
1090 #define SUBVOL_POS_MIN POS(0, 1)
1091 #define SUBVOL_POS_MAX POS(0, S32_MAX)
1092 #define BCACHEFS_ROOT_SUBVOL 1
1094 struct bch_subvolume {
1101 LE32_BITMASK(BCH_SUBVOLUME_RO, struct bch_subvolume, flags, 0, 1)
1103 * We need to know whether a subvolume is a snapshot so we can know whether we
1104 * can delete it (or whether it should just be rm -rf'd)
1106 LE32_BITMASK(BCH_SUBVOLUME_SNAP, struct bch_subvolume, flags, 1, 2)
1107 LE32_BITMASK(BCH_SUBVOLUME_UNLINKED, struct bch_subvolume, flags, 2, 3)
1111 struct bch_snapshot {
1120 LE32_BITMASK(BCH_SNAPSHOT_DELETED, struct bch_snapshot, flags, 0, 1)
1122 /* True if a subvolume points to this snapshot node: */
1123 LE32_BITMASK(BCH_SNAPSHOT_SUBVOL, struct bch_snapshot, flags, 1, 2)
1130 } __packed __aligned(8);
1132 #define LRU_ID_STRIPES (1U << 16)
1134 /* Optional/variable size superblock sections: */
1136 struct bch_sb_field {
1142 #define BCH_SB_FIELDS() \
1151 x(journal_seq_blacklist, 8) \
1155 enum bch_sb_field_type {
1156 #define x(f, nr) BCH_SB_FIELD_##f = nr,
1163 * Most superblock fields are replicated in all device's superblocks - a few are
1166 #define BCH_SINGLE_DEVICE_SB_FIELDS \
1167 ((1U << BCH_SB_FIELD_journal)| \
1168 (1U << BCH_SB_FIELD_journal_v2))
1170 /* BCH_SB_FIELD_journal: */
1172 struct bch_sb_field_journal {
1173 struct bch_sb_field field;
1177 struct bch_sb_field_journal_v2 {
1178 struct bch_sb_field field;
1180 struct bch_sb_field_journal_v2_entry {
1186 /* BCH_SB_FIELD_members: */
1188 #define BCH_MIN_NR_NBUCKETS (1 << 6)
1192 __le64 nbuckets; /* device size */
1193 __le16 first_bucket; /* index of first bucket used */
1194 __le16 bucket_size; /* sectors */
1196 __le64 last_mount; /* time_t */
1201 LE64_BITMASK(BCH_MEMBER_STATE, struct bch_member, flags[0], 0, 4)
1202 /* 4-14 unused, was TIER, HAS_(META)DATA, REPLACEMENT */
1203 LE64_BITMASK(BCH_MEMBER_DISCARD, struct bch_member, flags[0], 14, 15)
1204 LE64_BITMASK(BCH_MEMBER_DATA_ALLOWED, struct bch_member, flags[0], 15, 20)
1205 LE64_BITMASK(BCH_MEMBER_GROUP, struct bch_member, flags[0], 20, 28)
1206 LE64_BITMASK(BCH_MEMBER_DURABILITY, struct bch_member, flags[0], 28, 30)
1207 LE64_BITMASK(BCH_MEMBER_FREESPACE_INITIALIZED,
1208 struct bch_member, flags[0], 30, 31)
1211 LE64_BITMASK(BCH_MEMBER_NR_READ_ERRORS, struct bch_member, flags[1], 0, 20);
1212 LE64_BITMASK(BCH_MEMBER_NR_WRITE_ERRORS,struct bch_member, flags[1], 20, 40);
1215 #define BCH_MEMBER_STATES() \
1221 enum bch_member_state {
1222 #define x(t, n) BCH_MEMBER_STATE_##t = n,
1228 struct bch_sb_field_members {
1229 struct bch_sb_field field;
1230 struct bch_member members[0];
1233 /* BCH_SB_FIELD_crypt: */
1243 #define BCH_KEY_MAGIC \
1244 (((u64) 'b' << 0)|((u64) 'c' << 8)| \
1245 ((u64) 'h' << 16)|((u64) '*' << 24)| \
1246 ((u64) '*' << 32)|((u64) 'k' << 40)| \
1247 ((u64) 'e' << 48)|((u64) 'y' << 56))
1249 struct bch_encrypted_key {
1255 * If this field is present in the superblock, it stores an encryption key which
1256 * is used encrypt all other data/metadata. The key will normally be encrypted
1257 * with the key userspace provides, but if encryption has been turned off we'll
1258 * just store the master key unencrypted in the superblock so we can access the
1259 * previously encrypted data.
1261 struct bch_sb_field_crypt {
1262 struct bch_sb_field field;
1266 struct bch_encrypted_key key;
1269 LE64_BITMASK(BCH_CRYPT_KDF_TYPE, struct bch_sb_field_crypt, flags, 0, 4);
1271 enum bch_kdf_types {
1276 /* stored as base 2 log of scrypt params: */
1277 LE64_BITMASK(BCH_KDF_SCRYPT_N, struct bch_sb_field_crypt, kdf_flags, 0, 16);
1278 LE64_BITMASK(BCH_KDF_SCRYPT_R, struct bch_sb_field_crypt, kdf_flags, 16, 32);
1279 LE64_BITMASK(BCH_KDF_SCRYPT_P, struct bch_sb_field_crypt, kdf_flags, 32, 48);
1281 /* BCH_SB_FIELD_replicas: */
1283 #define BCH_DATA_TYPES() \
1292 x(need_gc_gens, 8) \
1295 enum bch_data_type {
1296 #define x(t, n) BCH_DATA_##t,
1302 static inline bool data_type_is_empty(enum bch_data_type type)
1306 case BCH_DATA_need_gc_gens:
1307 case BCH_DATA_need_discard:
1314 static inline bool data_type_is_hidden(enum bch_data_type type)
1318 case BCH_DATA_journal:
1325 struct bch_replicas_entry_v0 {
1331 struct bch_sb_field_replicas_v0 {
1332 struct bch_sb_field field;
1333 struct bch_replicas_entry_v0 entries[];
1334 } __packed __aligned(8);
1336 struct bch_replicas_entry {
1343 #define replicas_entry_bytes(_i) \
1344 (offsetof(typeof(*(_i)), devs) + (_i)->nr_devs)
1346 struct bch_sb_field_replicas {
1347 struct bch_sb_field field;
1348 struct bch_replicas_entry entries[0];
1349 } __packed __aligned(8);
1351 /* BCH_SB_FIELD_quota: */
1353 struct bch_sb_quota_counter {
1358 struct bch_sb_quota_type {
1360 struct bch_sb_quota_counter c[Q_COUNTERS];
1363 struct bch_sb_field_quota {
1364 struct bch_sb_field field;
1365 struct bch_sb_quota_type q[QTYP_NR];
1366 } __packed __aligned(8);
1368 /* BCH_SB_FIELD_disk_groups: */
1370 #define BCH_SB_LABEL_SIZE 32
1372 struct bch_disk_group {
1373 __u8 label[BCH_SB_LABEL_SIZE];
1375 } __packed __aligned(8);
1377 LE64_BITMASK(BCH_GROUP_DELETED, struct bch_disk_group, flags[0], 0, 1)
1378 LE64_BITMASK(BCH_GROUP_DATA_ALLOWED, struct bch_disk_group, flags[0], 1, 6)
1379 LE64_BITMASK(BCH_GROUP_PARENT, struct bch_disk_group, flags[0], 6, 24)
1381 struct bch_sb_field_disk_groups {
1382 struct bch_sb_field field;
1383 struct bch_disk_group entries[0];
1384 } __packed __aligned(8);
1386 /* BCH_SB_FIELD_counters */
1388 #define BCH_PERSISTENT_COUNTERS() \
1392 x(bucket_invalidate, 3) \
1393 x(bucket_discard, 4) \
1394 x(bucket_alloc, 5) \
1395 x(bucket_alloc_fail, 6) \
1396 x(btree_cache_scan, 7) \
1397 x(btree_cache_reap, 8) \
1398 x(btree_cache_cannibalize, 9) \
1399 x(btree_cache_cannibalize_lock, 10) \
1400 x(btree_cache_cannibalize_lock_fail, 11) \
1401 x(btree_cache_cannibalize_unlock, 12) \
1402 x(btree_node_write, 13) \
1403 x(btree_node_read, 14) \
1404 x(btree_node_compact, 15) \
1405 x(btree_node_merge, 16) \
1406 x(btree_node_split, 17) \
1407 x(btree_node_rewrite, 18) \
1408 x(btree_node_alloc, 19) \
1409 x(btree_node_free, 20) \
1410 x(btree_node_set_root, 21) \
1411 x(btree_path_relock_fail, 22) \
1412 x(btree_path_upgrade_fail, 23) \
1413 x(btree_reserve_get_fail, 24) \
1414 x(journal_entry_full, 25) \
1415 x(journal_full, 26) \
1416 x(journal_reclaim_finish, 27) \
1417 x(journal_reclaim_start, 28) \
1418 x(journal_write, 29) \
1419 x(read_promote, 30) \
1420 x(read_bounce, 31) \
1423 x(read_reuse_race, 34) \
1424 x(move_extent_read, 35) \
1425 x(move_extent_write, 36) \
1426 x(move_extent_finish, 37) \
1427 x(move_extent_race, 38) \
1428 x(move_extent_alloc_mem_fail, 39) \
1430 x(copygc_wait, 41) \
1431 x(gc_gens_end, 42) \
1432 x(gc_gens_start, 43) \
1433 x(trans_blocked_journal_reclaim, 44) \
1434 x(trans_restart_btree_node_reused, 45) \
1435 x(trans_restart_btree_node_split, 46) \
1436 x(trans_restart_fault_inject, 47) \
1437 x(trans_restart_iter_upgrade, 48) \
1438 x(trans_restart_journal_preres_get, 49) \
1439 x(trans_restart_journal_reclaim, 50) \
1440 x(trans_restart_journal_res_get, 51) \
1441 x(trans_restart_key_cache_key_realloced, 52) \
1442 x(trans_restart_key_cache_raced, 53) \
1443 x(trans_restart_mark_replicas, 54) \
1444 x(trans_restart_mem_realloced, 55) \
1445 x(trans_restart_memory_allocation_failure, 56) \
1446 x(trans_restart_relock, 57) \
1447 x(trans_restart_relock_after_fill, 58) \
1448 x(trans_restart_relock_key_cache_fill, 59) \
1449 x(trans_restart_relock_next_node, 60) \
1450 x(trans_restart_relock_parent_for_fill, 61) \
1451 x(trans_restart_relock_path, 62) \
1452 x(trans_restart_relock_path_intent, 63) \
1453 x(trans_restart_too_many_iters, 64) \
1454 x(trans_restart_traverse, 65) \
1455 x(trans_restart_upgrade, 66) \
1456 x(trans_restart_would_deadlock, 67) \
1457 x(trans_restart_would_deadlock_write, 68) \
1458 x(trans_restart_injected, 69) \
1459 x(trans_restart_key_cache_upgrade, 70) \
1460 x(trans_traverse_all, 71) \
1461 x(transaction_commit, 72) \
1462 x(write_super, 73) \
1463 x(trans_restart_would_deadlock_recursion_limit, 74)
1465 enum bch_persistent_counters {
1466 #define x(t, n, ...) BCH_COUNTER_##t,
1467 BCH_PERSISTENT_COUNTERS()
1472 struct bch_sb_field_counters {
1473 struct bch_sb_field field;
1478 * On clean shutdown, store btree roots and current journal sequence number in
1485 __u8 type; /* designates what this jset holds */
1489 struct bkey_i start[0];
1494 struct bch_sb_field_clean {
1495 struct bch_sb_field field;
1498 __le16 _read_clock; /* no longer used */
1499 __le16 _write_clock;
1503 struct jset_entry start[0];
1508 struct journal_seq_blacklist_entry {
1513 struct bch_sb_field_journal_seq_blacklist {
1514 struct bch_sb_field field;
1517 struct journal_seq_blacklist_entry start[0];
1525 * New versioning scheme:
1526 * One common version number for all on disk data structures - superblock, btree
1527 * nodes, journal entries
1529 #define BCH_JSET_VERSION_OLD 2
1530 #define BCH_BSET_VERSION_OLD 3
1532 #define BCH_METADATA_VERSIONS() \
1533 x(bkey_renumber, 10) \
1534 x(inode_btree_change, 11) \
1536 x(inode_backpointers, 13) \
1537 x(btree_ptr_sectors_written, 14) \
1539 x(reflink_p_fix, 16) \
1540 x(subvol_dirent, 17) \
1544 x(new_data_types, 21) \
1545 x(backpointers, 22) \
1548 enum bcachefs_metadata_version {
1549 bcachefs_metadata_version_min = 9,
1550 #define x(t, n) bcachefs_metadata_version_##t = n,
1551 BCH_METADATA_VERSIONS()
1553 bcachefs_metadata_version_max
1556 #define bcachefs_metadata_version_current (bcachefs_metadata_version_max - 1)
1558 #define BCH_SB_SECTOR 8
1559 #define BCH_SB_MEMBERS_MAX 64 /* XXX kill */
1561 struct bch_sb_layout {
1562 uuid_le magic; /* bcachefs superblock UUID */
1564 __u8 sb_max_size_bits; /* base 2 of 512 byte sectors */
1565 __u8 nr_superblocks;
1567 __le64 sb_offset[61];
1568 } __packed __aligned(8);
1570 #define BCH_SB_LAYOUT_SECTOR 7
1573 * @offset - sector where this sb was written
1574 * @version - on disk format version
1575 * @version_min - Oldest metadata version this filesystem contains; so we can
1576 * safely drop compatibility code and refuse to mount filesystems
1578 * @magic - identifies as a bcachefs superblock (BCACHE_MAGIC)
1579 * @seq - incremented each time superblock is written
1580 * @uuid - used for generating various magic numbers and identifying
1581 * member devices, never changes
1582 * @user_uuid - user visible UUID, may be changed
1583 * @label - filesystem label
1584 * @seq - identifies most recent superblock, incremented each time
1585 * superblock is written
1586 * @features - enabled incompatible features
1589 struct bch_csum csum;
1596 __u8 label[BCH_SB_LABEL_SIZE];
1605 __le64 time_base_lo;
1606 __le32 time_base_hi;
1607 __le32 time_precision;
1613 struct bch_sb_layout layout;
1616 struct bch_sb_field start[0];
1619 } __packed __aligned(8);
1623 * BCH_SB_INITALIZED - set on first mount
1624 * BCH_SB_CLEAN - did we shut down cleanly? Just a hint, doesn't affect
1625 * behaviour of mount/recovery path:
1626 * BCH_SB_INODE_32BIT - limit inode numbers to 32 bits
1627 * BCH_SB_128_BIT_MACS - 128 bit macs instead of 80
1628 * BCH_SB_ENCRYPTION_TYPE - if nonzero encryption is enabled; overrides
1629 * DATA/META_CSUM_TYPE. Also indicates encryption
1630 * algorithm in use, if/when we get more than one
1633 LE16_BITMASK(BCH_SB_BLOCK_SIZE, struct bch_sb, block_size, 0, 16);
1635 LE64_BITMASK(BCH_SB_INITIALIZED, struct bch_sb, flags[0], 0, 1);
1636 LE64_BITMASK(BCH_SB_CLEAN, struct bch_sb, flags[0], 1, 2);
1637 LE64_BITMASK(BCH_SB_CSUM_TYPE, struct bch_sb, flags[0], 2, 8);
1638 LE64_BITMASK(BCH_SB_ERROR_ACTION, struct bch_sb, flags[0], 8, 12);
1640 LE64_BITMASK(BCH_SB_BTREE_NODE_SIZE, struct bch_sb, flags[0], 12, 28);
1642 LE64_BITMASK(BCH_SB_GC_RESERVE, struct bch_sb, flags[0], 28, 33);
1643 LE64_BITMASK(BCH_SB_ROOT_RESERVE, struct bch_sb, flags[0], 33, 40);
1645 LE64_BITMASK(BCH_SB_META_CSUM_TYPE, struct bch_sb, flags[0], 40, 44);
1646 LE64_BITMASK(BCH_SB_DATA_CSUM_TYPE, struct bch_sb, flags[0], 44, 48);
1648 LE64_BITMASK(BCH_SB_META_REPLICAS_WANT, struct bch_sb, flags[0], 48, 52);
1649 LE64_BITMASK(BCH_SB_DATA_REPLICAS_WANT, struct bch_sb, flags[0], 52, 56);
1651 LE64_BITMASK(BCH_SB_POSIX_ACL, struct bch_sb, flags[0], 56, 57);
1652 LE64_BITMASK(BCH_SB_USRQUOTA, struct bch_sb, flags[0], 57, 58);
1653 LE64_BITMASK(BCH_SB_GRPQUOTA, struct bch_sb, flags[0], 58, 59);
1654 LE64_BITMASK(BCH_SB_PRJQUOTA, struct bch_sb, flags[0], 59, 60);
1656 LE64_BITMASK(BCH_SB_HAS_ERRORS, struct bch_sb, flags[0], 60, 61);
1657 LE64_BITMASK(BCH_SB_HAS_TOPOLOGY_ERRORS,struct bch_sb, flags[0], 61, 62);
1659 LE64_BITMASK(BCH_SB_BIG_ENDIAN, struct bch_sb, flags[0], 62, 63);
1661 LE64_BITMASK(BCH_SB_STR_HASH_TYPE, struct bch_sb, flags[1], 0, 4);
1662 LE64_BITMASK(BCH_SB_COMPRESSION_TYPE, struct bch_sb, flags[1], 4, 8);
1663 LE64_BITMASK(BCH_SB_INODE_32BIT, struct bch_sb, flags[1], 8, 9);
1665 LE64_BITMASK(BCH_SB_128_BIT_MACS, struct bch_sb, flags[1], 9, 10);
1666 LE64_BITMASK(BCH_SB_ENCRYPTION_TYPE, struct bch_sb, flags[1], 10, 14);
1669 * Max size of an extent that may require bouncing to read or write
1670 * (checksummed, compressed): 64k
1672 LE64_BITMASK(BCH_SB_ENCODED_EXTENT_MAX_BITS,
1673 struct bch_sb, flags[1], 14, 20);
1675 LE64_BITMASK(BCH_SB_META_REPLICAS_REQ, struct bch_sb, flags[1], 20, 24);
1676 LE64_BITMASK(BCH_SB_DATA_REPLICAS_REQ, struct bch_sb, flags[1], 24, 28);
1678 LE64_BITMASK(BCH_SB_PROMOTE_TARGET, struct bch_sb, flags[1], 28, 40);
1679 LE64_BITMASK(BCH_SB_FOREGROUND_TARGET, struct bch_sb, flags[1], 40, 52);
1680 LE64_BITMASK(BCH_SB_BACKGROUND_TARGET, struct bch_sb, flags[1], 52, 64);
1682 LE64_BITMASK(BCH_SB_BACKGROUND_COMPRESSION_TYPE,
1683 struct bch_sb, flags[2], 0, 4);
1684 LE64_BITMASK(BCH_SB_GC_RESERVE_BYTES, struct bch_sb, flags[2], 4, 64);
1686 LE64_BITMASK(BCH_SB_ERASURE_CODE, struct bch_sb, flags[3], 0, 16);
1687 LE64_BITMASK(BCH_SB_METADATA_TARGET, struct bch_sb, flags[3], 16, 28);
1688 LE64_BITMASK(BCH_SB_SHARD_INUMS, struct bch_sb, flags[3], 28, 29);
1689 LE64_BITMASK(BCH_SB_INODES_USE_KEY_CACHE,struct bch_sb, flags[3], 29, 30);
1690 LE64_BITMASK(BCH_SB_JOURNAL_FLUSH_DELAY,struct bch_sb, flags[3], 30, 62);
1691 LE64_BITMASK(BCH_SB_JOURNAL_FLUSH_DISABLED,struct bch_sb, flags[3], 62, 63);
1692 LE64_BITMASK(BCH_SB_JOURNAL_RECLAIM_DELAY,struct bch_sb, flags[4], 0, 32);
1693 /* Obsolete, always enabled: */
1694 LE64_BITMASK(BCH_SB_JOURNAL_TRANSACTION_NAMES,struct bch_sb, flags[4], 32, 33);
1699 * journal_seq_blacklist_v3: gates BCH_SB_FIELD_journal_seq_blacklist
1700 * reflink: gates KEY_TYPE_reflink
1701 * inline_data: gates KEY_TYPE_inline_data
1702 * new_siphash: gates BCH_STR_HASH_siphash
1703 * new_extent_overwrite: gates BTREE_NODE_NEW_EXTENT_OVERWRITE
1705 #define BCH_SB_FEATURES() \
1709 x(atomic_nlink, 3) \
1711 x(journal_seq_blacklist_v3, 5) \
1715 x(new_extent_overwrite, 9) \
1716 x(incompressible, 10) \
1717 x(btree_ptr_v2, 11) \
1718 x(extents_above_btree_updates, 12) \
1719 x(btree_updates_journalled, 13) \
1720 x(reflink_inline_data, 14) \
1722 x(journal_no_flush, 16) \
1724 x(extents_across_btree_nodes, 18)
1726 #define BCH_SB_FEATURES_ALWAYS \
1727 ((1ULL << BCH_FEATURE_new_extent_overwrite)| \
1728 (1ULL << BCH_FEATURE_extents_above_btree_updates)|\
1729 (1ULL << BCH_FEATURE_btree_updates_journalled)|\
1730 (1ULL << BCH_FEATURE_alloc_v2)|\
1731 (1ULL << BCH_FEATURE_extents_across_btree_nodes))
1733 #define BCH_SB_FEATURES_ALL \
1734 (BCH_SB_FEATURES_ALWAYS| \
1735 (1ULL << BCH_FEATURE_new_siphash)| \
1736 (1ULL << BCH_FEATURE_btree_ptr_v2)| \
1737 (1ULL << BCH_FEATURE_new_varint)| \
1738 (1ULL << BCH_FEATURE_journal_no_flush))
1740 enum bch_sb_feature {
1741 #define x(f, n) BCH_FEATURE_##f,
1747 #define BCH_SB_COMPAT() \
1749 x(alloc_metadata, 1) \
1750 x(extents_above_btree_updates_done, 2) \
1751 x(bformat_overflow_done, 3)
1753 enum bch_sb_compat {
1754 #define x(f, n) BCH_COMPAT_##f,
1762 #define BCH_REPLICAS_MAX 4U
1764 #define BCH_BKEY_PTRS_MAX 16U
1766 #define BCH_ERROR_ACTIONS() \
1771 enum bch_error_actions {
1772 #define x(t, n) BCH_ON_ERROR_##t = n,
1778 #define BCH_STR_HASH_TYPES() \
1784 enum bch_str_hash_type {
1785 #define x(t, n) BCH_STR_HASH_##t = n,
1786 BCH_STR_HASH_TYPES()
1791 #define BCH_STR_HASH_OPTS() \
1796 enum bch_str_hash_opts {
1797 #define x(t, n) BCH_STR_HASH_OPT_##t = n,
1803 #define BCH_CSUM_TYPES() \
1805 x(crc32c_nonzero, 1) \
1806 x(crc64_nonzero, 2) \
1807 x(chacha20_poly1305_80, 3) \
1808 x(chacha20_poly1305_128, 4) \
1813 enum bch_csum_type {
1814 #define x(t, n) BCH_CSUM_##t = n,
1820 static const unsigned bch_crc_bytes[] = {
1821 [BCH_CSUM_none] = 0,
1822 [BCH_CSUM_crc32c_nonzero] = 4,
1823 [BCH_CSUM_crc32c] = 4,
1824 [BCH_CSUM_crc64_nonzero] = 8,
1825 [BCH_CSUM_crc64] = 8,
1826 [BCH_CSUM_xxhash] = 8,
1827 [BCH_CSUM_chacha20_poly1305_80] = 10,
1828 [BCH_CSUM_chacha20_poly1305_128] = 16,
1831 static inline _Bool bch2_csum_type_is_encryption(enum bch_csum_type type)
1834 case BCH_CSUM_chacha20_poly1305_80:
1835 case BCH_CSUM_chacha20_poly1305_128:
1842 #define BCH_CSUM_OPTS() \
1848 enum bch_csum_opts {
1849 #define x(t, n) BCH_CSUM_OPT_##t = n,
1855 #define BCH_COMPRESSION_TYPES() \
1861 x(incompressible, 5)
1863 enum bch_compression_type {
1864 #define x(t, n) BCH_COMPRESSION_TYPE_##t = n,
1865 BCH_COMPRESSION_TYPES()
1867 BCH_COMPRESSION_TYPE_NR
1870 #define BCH_COMPRESSION_OPTS() \
1876 enum bch_compression_opts {
1877 #define x(t, n) BCH_COMPRESSION_OPT_##t = n,
1878 BCH_COMPRESSION_OPTS()
1880 BCH_COMPRESSION_OPT_NR
1886 * The various other data structures have their own magic numbers, which are
1887 * xored with the first part of the cache set's UUID
1890 #define BCACHE_MAGIC \
1891 UUID_LE(0xf67385c6, 0x1a4e, 0xca45, \
1892 0x82, 0x65, 0xf5, 0x7f, 0x48, 0xba, 0x6d, 0x81)
1894 #define BCACHEFS_STATFS_MAGIC 0xca451a4e
1896 #define JSET_MAGIC __cpu_to_le64(0x245235c1a3625032ULL)
1897 #define BSET_MAGIC __cpu_to_le64(0x90135c78b99e07f5ULL)
1899 static inline __le64 __bch2_sb_magic(struct bch_sb *sb)
1903 memcpy(&ret, &sb->uuid, sizeof(ret));
1907 static inline __u64 __jset_magic(struct bch_sb *sb)
1909 return __le64_to_cpu(__bch2_sb_magic(sb) ^ JSET_MAGIC);
1912 static inline __u64 __bset_magic(struct bch_sb *sb)
1914 return __le64_to_cpu(__bch2_sb_magic(sb) ^ BSET_MAGIC);
1919 #define JSET_KEYS_U64s (sizeof(struct jset_entry) / sizeof(__u64))
1921 #define BCH_JSET_ENTRY_TYPES() \
1926 x(blacklist_v2, 4) \
1935 #define x(f, nr) BCH_JSET_ENTRY_##f = nr,
1936 BCH_JSET_ENTRY_TYPES()
1942 * Journal sequence numbers can be blacklisted: bsets record the max sequence
1943 * number of all the journal entries they contain updates for, so that on
1944 * recovery we can ignore those bsets that contain index updates newer that what
1945 * made it into the journal.
1947 * This means that we can't reuse that journal_seq - we have to skip it, and
1948 * then record that we skipped it so that the next time we crash and recover we
1949 * don't think there was a missing journal entry.
1951 struct jset_entry_blacklist {
1952 struct jset_entry entry;
1956 struct jset_entry_blacklist_v2 {
1957 struct jset_entry entry;
1962 #define BCH_FS_USAGE_TYPES() \
1968 #define x(f, nr) BCH_FS_USAGE_##f = nr,
1969 BCH_FS_USAGE_TYPES()
1974 struct jset_entry_usage {
1975 struct jset_entry entry;
1979 struct jset_entry_data_usage {
1980 struct jset_entry entry;
1982 struct bch_replicas_entry r;
1985 struct jset_entry_clock {
1986 struct jset_entry entry;
1992 struct jset_entry_dev_usage_type {
1998 struct jset_entry_dev_usage {
1999 struct jset_entry entry;
2004 __le64 _buckets_unavailable; /* No longer used */
2006 struct jset_entry_dev_usage_type d[];
2009 static inline unsigned jset_entry_dev_usage_nr_types(struct jset_entry_dev_usage *u)
2011 return (vstruct_bytes(&u->entry) - sizeof(struct jset_entry_dev_usage)) /
2012 sizeof(struct jset_entry_dev_usage_type);
2015 struct jset_entry_log {
2016 struct jset_entry entry;
2021 * On disk format for a journal entry:
2022 * seq is monotonically increasing; every journal entry has its own unique
2025 * last_seq is the oldest journal entry that still has keys the btree hasn't
2026 * flushed to disk yet.
2028 * version is for on disk format changes.
2031 struct bch_csum csum;
2038 __le32 u64s; /* size of d[] in u64s */
2040 __u8 encrypted_start[0];
2042 __le16 _read_clock; /* no longer used */
2043 __le16 _write_clock;
2045 /* Sequence number of oldest dirty journal entry */
2050 struct jset_entry start[0];
2053 } __packed __aligned(8);
2055 LE32_BITMASK(JSET_CSUM_TYPE, struct jset, flags, 0, 4);
2056 LE32_BITMASK(JSET_BIG_ENDIAN, struct jset, flags, 4, 5);
2057 LE32_BITMASK(JSET_NO_FLUSH, struct jset, flags, 5, 6);
2059 #define BCH_JOURNAL_BUCKETS_MIN 8
2063 #define BCH_BTREE_IDS() \
2076 x(need_discard, 12) \
2080 #define x(kwd, val) BTREE_ID_##kwd = val,
2086 #define BTREE_MAX_DEPTH 4U
2093 * On disk a btree node is a list/log of these; within each set the keys are
2100 * Highest journal entry this bset contains keys for.
2101 * If on recovery we don't see that journal entry, this bset is ignored:
2102 * this allows us to preserve the order of all index updates after a
2103 * crash, since the journal records a total order of all index updates
2104 * and anything that didn't make it to the journal doesn't get used.
2110 __le16 u64s; /* count of d[] in u64s */
2113 struct bkey_packed start[0];
2116 } __packed __aligned(8);
2118 LE32_BITMASK(BSET_CSUM_TYPE, struct bset, flags, 0, 4);
2120 LE32_BITMASK(BSET_BIG_ENDIAN, struct bset, flags, 4, 5);
2121 LE32_BITMASK(BSET_SEPARATE_WHITEOUTS,
2122 struct bset, flags, 5, 6);
2124 /* Sector offset within the btree node: */
2125 LE32_BITMASK(BSET_OFFSET, struct bset, flags, 16, 32);
2128 struct bch_csum csum;
2131 /* this flags field is encrypted, unlike bset->flags: */
2134 /* Closed interval: */
2135 struct bpos min_key;
2136 struct bpos max_key;
2137 struct bch_extent_ptr _ptr; /* not used anymore */
2138 struct bkey_format format;
2149 } __packed __aligned(8);
2151 LE64_BITMASK(BTREE_NODE_ID, struct btree_node, flags, 0, 4);
2152 LE64_BITMASK(BTREE_NODE_LEVEL, struct btree_node, flags, 4, 8);
2153 LE64_BITMASK(BTREE_NODE_NEW_EXTENT_OVERWRITE,
2154 struct btree_node, flags, 8, 9);
2156 LE64_BITMASK(BTREE_NODE_SEQ, struct btree_node, flags, 32, 64);
2158 struct btree_node_entry {
2159 struct bch_csum csum;
2170 } __packed __aligned(8);
2172 #endif /* _BCACHEFS_FORMAT_H */