1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _BCACHEFS_SUPER_IO_H
3 #define _BCACHEFS_SUPER_IO_H
4
5 #include "extents.h"
6 #include "eytzinger.h"
7 #include "super_types.h"
8 #include "super.h"
9 #include "sb-members.h"
10
11 #include <asm/byteorder.h>
12
13 #define BCH_SB_READ_SCRATCH_BUF_SIZE 4096
14
bch2_version_compatible(u16 version)15 static inline bool bch2_version_compatible(u16 version)
16 {
17 return BCH_VERSION_MAJOR(version) <= BCH_VERSION_MAJOR(bcachefs_metadata_version_current) &&
18 version >= bcachefs_metadata_version_min;
19 }
20
21 void bch2_version_to_text(struct printbuf *, enum bcachefs_metadata_version);
22 enum bcachefs_metadata_version bch2_latest_compatible_version(enum bcachefs_metadata_version);
23
24 int bch2_set_version_incompat(struct bch_fs *, enum bcachefs_metadata_version);
25
bch2_request_incompat_feature(struct bch_fs * c,enum bcachefs_metadata_version version)26 static inline int bch2_request_incompat_feature(struct bch_fs *c,
27 enum bcachefs_metadata_version version)
28 {
29 return likely(version <= c->sb.version_incompat)
30 ? 0
31 : bch2_set_version_incompat(c, version);
32 }
33
bch2_sb_field_bytes(struct bch_sb_field * f)34 static inline size_t bch2_sb_field_bytes(struct bch_sb_field *f)
35 {
36 return le32_to_cpu(f->u64s) * sizeof(u64);
37 }
38
39 #define field_to_type(_f, _name) \
40 container_of_or_null(_f, struct bch_sb_field_##_name, field)
41
42 struct bch_sb_field *bch2_sb_field_get_id(struct bch_sb *, enum bch_sb_field_type);
43 #define bch2_sb_field_get(_sb, _name) \
44 field_to_type(bch2_sb_field_get_id(_sb, BCH_SB_FIELD_##_name), _name)
45
46 struct bch_sb_field *bch2_sb_field_resize_id(struct bch_sb_handle *,
47 enum bch_sb_field_type, unsigned);
48 #define bch2_sb_field_resize(_sb, _name, _u64s) \
49 field_to_type(bch2_sb_field_resize_id(_sb, BCH_SB_FIELD_##_name, _u64s), _name)
50
51 struct bch_sb_field *bch2_sb_field_get_minsize_id(struct bch_sb_handle *,
52 enum bch_sb_field_type, unsigned);
53 #define bch2_sb_field_get_minsize(_sb, _name, _u64s) \
54 field_to_type(bch2_sb_field_get_minsize_id(_sb, BCH_SB_FIELD_##_name, _u64s), _name)
55
56 #define bch2_sb_field_nr_entries(_f) \
57 (_f ? ((bch2_sb_field_bytes(&_f->field) - sizeof(*_f)) / \
58 sizeof(_f->entries[0])) \
59 : 0)
60
61 void bch2_sb_field_delete(struct bch_sb_handle *, enum bch_sb_field_type);
62
63 extern const char * const bch2_sb_fields[];
64
65 struct bch_sb_field_ops {
66 int (*validate)(struct bch_sb *, struct bch_sb_field *,
67 enum bch_validate_flags, struct printbuf *);
68 void (*to_text)(struct printbuf *, struct bch_sb *, struct bch_sb_field *);
69 };
70
bch2_sb_magic(struct bch_fs * c)71 static inline __le64 bch2_sb_magic(struct bch_fs *c)
72 {
73 __le64 ret;
74
75 memcpy(&ret, &c->sb.uuid, sizeof(ret));
76 return ret;
77 }
78
jset_magic(struct bch_fs * c)79 static inline __u64 jset_magic(struct bch_fs *c)
80 {
81 return __le64_to_cpu(bch2_sb_magic(c) ^ JSET_MAGIC);
82 }
83
bset_magic(struct bch_fs * c)84 static inline __u64 bset_magic(struct bch_fs *c)
85 {
86 return __le64_to_cpu(bch2_sb_magic(c) ^ BSET_MAGIC);
87 }
88
89 int bch2_sb_to_fs(struct bch_fs *, struct bch_sb *);
90 int bch2_sb_from_fs(struct bch_fs *, struct bch_dev *);
91
92 void bch2_free_super(struct bch_sb_handle *);
93 int bch2_sb_realloc(struct bch_sb_handle *, unsigned);
94
95 int bch2_sb_validate(struct bch_sb *, u64, enum bch_validate_flags, struct printbuf *);
96
97 int bch2_read_super(const char *, struct bch_opts *, struct bch_sb_handle *);
98 int bch2_read_super_silent(const char *, struct bch_opts *, struct bch_sb_handle *);
99 int bch2_write_super(struct bch_fs *);
100 void __bch2_check_set_feature(struct bch_fs *, unsigned);
101
bch2_check_set_feature(struct bch_fs * c,unsigned feat)102 static inline void bch2_check_set_feature(struct bch_fs *c, unsigned feat)
103 {
104 if (!(c->sb.features & (1ULL << feat)))
105 __bch2_check_set_feature(c, feat);
106 }
107
108 bool bch2_check_version_downgrade(struct bch_fs *);
109 void bch2_sb_upgrade(struct bch_fs *, unsigned, bool);
110
111 void __bch2_sb_field_to_text(struct printbuf *, struct bch_sb *,
112 struct bch_sb_field *);
113 void bch2_sb_field_to_text(struct printbuf *, struct bch_sb *,
114 struct bch_sb_field *);
115 void bch2_sb_layout_to_text(struct printbuf *, struct bch_sb_layout *);
116 void bch2_sb_to_text(struct printbuf *, struct bch_sb *, bool, unsigned);
117
118 #endif /* _BCACHEFS_SUPER_IO_H */
119