]> git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/super-io.h
Update bcachefs sources to 0b8c5d0fb7 bcachefs: refactor superblock validation
[bcachefs-tools-debian] / libbcachefs / super-io.h
1 #ifndef _BCACHEFS_SUPER_IO_H
2 #define _BCACHEFS_SUPER_IO_H
3
4 #include "extents.h"
5 #include "eytzinger.h"
6 #include "super_types.h"
7 #include "super.h"
8
9 #include <asm/byteorder.h>
10
11 struct bch_sb_field *bch2_sb_field_get(struct bch_sb *, enum bch_sb_field_type);
12 struct bch_sb_field *bch2_sb_field_resize(struct bch_sb_handle *,
13                                           enum bch_sb_field_type, unsigned);
14 struct bch_sb_field *bch2_fs_sb_field_resize(struct bch_fs *,
15                                          enum bch_sb_field_type, unsigned);
16
17 #define field_to_type(_f, _name)                                        \
18         container_of_or_null(_f, struct bch_sb_field_##_name, field)
19
20 #define x(_name, _nr)                                                   \
21 static inline struct bch_sb_field_##_name *                             \
22 bch2_sb_get_##_name(struct bch_sb *sb)                                  \
23 {                                                                       \
24         return field_to_type(bch2_sb_field_get(sb,                      \
25                                 BCH_SB_FIELD_##_name), _name);          \
26 }                                                                       \
27                                                                         \
28 static inline struct bch_sb_field_##_name *                             \
29 bch2_sb_resize_##_name(struct bch_sb_handle *sb, unsigned u64s) \
30 {                                                                       \
31         return field_to_type(bch2_sb_field_resize(sb,                   \
32                                 BCH_SB_FIELD_##_name, u64s), _name);    \
33 }                                                                       \
34                                                                         \
35 static inline struct bch_sb_field_##_name *                             \
36 bch2_fs_sb_resize_##_name(struct bch_fs *c, unsigned u64s)              \
37 {                                                                       \
38         return field_to_type(bch2_fs_sb_field_resize(c,                 \
39                                 BCH_SB_FIELD_##_name, u64s), _name);    \
40 }
41
42 BCH_SB_FIELDS()
43 #undef x
44
45 extern const char * const bch2_sb_fields[];
46
47 static inline bool bch2_sb_test_feature(struct bch_sb *sb,
48                                         enum bch_sb_features f)
49 {
50         unsigned w = f / 64;
51         unsigned b = f % 64;
52
53         return le64_to_cpu(sb->features[w]) & (1ULL << b);
54 }
55
56 static inline void bch2_sb_set_feature(struct bch_sb *sb,
57                                        enum bch_sb_features f)
58 {
59         if (!bch2_sb_test_feature(sb, f)) {
60                 unsigned w = f / 64;
61                 unsigned b = f % 64;
62
63                 le64_add_cpu(&sb->features[w], 1ULL << b);
64         }
65 }
66
67 static inline __le64 bch2_sb_magic(struct bch_fs *c)
68 {
69         __le64 ret;
70         memcpy(&ret, &c->sb.uuid, sizeof(ret));
71         return ret;
72 }
73
74 static inline __u64 jset_magic(struct bch_fs *c)
75 {
76         return __le64_to_cpu(bch2_sb_magic(c) ^ JSET_MAGIC);
77 }
78
79 static inline __u64 pset_magic(struct bch_fs *c)
80 {
81         return __le64_to_cpu(bch2_sb_magic(c) ^ PSET_MAGIC);
82 }
83
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_super_realloc(struct bch_sb_handle *, unsigned);
94
95 const char *bch2_sb_validate(struct bch_sb_handle *);
96
97 const char *bch2_read_super(const char *, struct bch_opts,
98                             struct bch_sb_handle *);
99 void bch2_write_super(struct bch_fs *);
100
101 /* BCH_SB_FIELD_journal: */
102
103 static inline unsigned bch2_nr_journal_buckets(struct bch_sb_field_journal *j)
104 {
105         return j
106                 ? (__le64 *) vstruct_end(&j->field) - j->buckets
107                 : 0;
108 }
109
110 /* BCH_SB_FIELD_members: */
111
112 static inline bool bch2_member_exists(struct bch_member *m)
113 {
114         return !bch2_is_zero(m->uuid.b, sizeof(uuid_le));
115 }
116
117 static inline bool bch2_dev_exists(struct bch_sb *sb,
118                                    struct bch_sb_field_members *mi,
119                                    unsigned dev)
120 {
121         return dev < sb->nr_devices &&
122                 bch2_member_exists(&mi->members[dev]);
123 }
124
125 static inline struct bch_member_cpu bch2_mi_to_cpu(struct bch_member *mi)
126 {
127         return (struct bch_member_cpu) {
128                 .nbuckets       = le64_to_cpu(mi->nbuckets),
129                 .first_bucket   = le16_to_cpu(mi->first_bucket),
130                 .bucket_size    = le16_to_cpu(mi->bucket_size),
131                 .state          = BCH_MEMBER_STATE(mi),
132                 .tier           = BCH_MEMBER_TIER(mi),
133                 .replacement    = BCH_MEMBER_REPLACEMENT(mi),
134                 .discard        = BCH_MEMBER_DISCARD(mi),
135                 .data_allowed   = BCH_MEMBER_DATA_ALLOWED(mi),
136                 .valid          = !bch2_is_zero(mi->uuid.b, sizeof(uuid_le)),
137         };
138 }
139
140 /* BCH_SB_FIELD_replicas: */
141
142 bool bch2_sb_has_replicas(struct bch_fs *, struct bkey_s_c_extent,
143                           enum bch_data_type);
144 bool bch2_sb_has_replicas_devlist(struct bch_fs *, struct bch_devs_list *,
145                                   enum bch_data_type);
146 int bch2_check_mark_super(struct bch_fs *, struct bkey_s_c_extent,
147                           enum bch_data_type);
148 int bch2_check_mark_super_devlist(struct bch_fs *, struct bch_devs_list *,
149                                   enum bch_data_type);
150
151 int bch2_cpu_replicas_to_text(struct bch_replicas_cpu *, char *, size_t);
152 int bch2_sb_replicas_to_text(struct bch_sb_field_replicas *, char *, size_t);
153
154 struct replicas_status {
155         struct {
156                 unsigned        nr_online;
157                 unsigned        nr_offline;
158         }                       replicas[BCH_DATA_NR];
159 };
160
161 struct replicas_status __bch2_replicas_status(struct bch_fs *,
162                                               struct bch_devs_mask);
163 struct replicas_status bch2_replicas_status(struct bch_fs *);
164 bool bch2_have_enough_devs(struct bch_fs *, struct replicas_status, unsigned);
165
166 unsigned bch2_replicas_online(struct bch_fs *, bool);
167 unsigned bch2_dev_has_data(struct bch_fs *, struct bch_dev *);
168
169 int bch2_replicas_gc_end(struct bch_fs *, int);
170 int bch2_replicas_gc_start(struct bch_fs *, unsigned);
171
172 /* iterate over superblock replicas - used by userspace tools: */
173
174 static inline struct bch_replicas_entry *
175 replicas_entry_next(struct bch_replicas_entry *i)
176 {
177         return (void *) i + offsetof(struct bch_replicas_entry, devs) + i->nr;
178 }
179
180 #define for_each_replicas_entry(_r, _i)                                 \
181         for (_i = (_r)->entries;                                        \
182              (void *) (_i) < vstruct_end(&(_r)->field) && (_i)->data_type;\
183              (_i) = replicas_entry_next(_i))
184
185 #endif /* _BCACHEFS_SUPER_IO_H */