1 // SPDX-License-Identifier: GPL-2.0
4 #include "backpointers.h"
5 #include "bkey_methods.h"
6 #include "btree_types.h"
7 #include "alloc_background.h"
16 #include "subvolume.h"
19 const char * const bch2_bkey_types[] = {
20 #define x(name, nr) #name,
26 static int deleted_key_invalid(const struct bch_fs *c, struct bkey_s_c k,
27 int rw, struct printbuf *err)
32 #define bch2_bkey_ops_deleted ((struct bkey_ops) { \
33 .key_invalid = deleted_key_invalid, \
36 #define bch2_bkey_ops_whiteout ((struct bkey_ops) { \
37 .key_invalid = deleted_key_invalid, \
40 static int empty_val_key_invalid(const struct bch_fs *c, struct bkey_s_c k,
41 int rw, struct printbuf *err)
43 if (bkey_val_bytes(k.k)) {
44 prt_printf(err, "incorrect value size (%zu != 0)",
46 return -BCH_ERR_invalid_bkey;
52 #define bch2_bkey_ops_error ((struct bkey_ops) { \
53 .key_invalid = empty_val_key_invalid, \
56 static int key_type_cookie_invalid(const struct bch_fs *c, struct bkey_s_c k,
57 int rw, struct printbuf *err)
59 if (bkey_val_bytes(k.k) != sizeof(struct bch_cookie)) {
60 prt_printf(err, "incorrect value size (%zu != %zu)",
61 bkey_val_bytes(k.k), sizeof(struct bch_cookie));
62 return -BCH_ERR_invalid_bkey;
68 #define bch2_bkey_ops_cookie ((struct bkey_ops) { \
69 .key_invalid = key_type_cookie_invalid, \
72 #define bch2_bkey_ops_hash_whiteout ((struct bkey_ops) {\
73 .key_invalid = empty_val_key_invalid, \
76 static int key_type_inline_data_invalid(const struct bch_fs *c, struct bkey_s_c k,
77 int rw, struct printbuf *err)
82 static void key_type_inline_data_to_text(struct printbuf *out, struct bch_fs *c,
85 struct bkey_s_c_inline_data d = bkey_s_c_to_inline_data(k);
86 unsigned datalen = bkey_inline_data_bytes(k.k);
88 prt_printf(out, "datalen %u: %*phN",
89 datalen, min(datalen, 32U), d.v->data);
92 #define bch2_bkey_ops_inline_data ((struct bkey_ops) { \
93 .key_invalid = key_type_inline_data_invalid, \
94 .val_to_text = key_type_inline_data_to_text, \
97 static int key_type_set_invalid(const struct bch_fs *c, struct bkey_s_c k,
98 int rw, struct printbuf *err)
100 if (bkey_val_bytes(k.k)) {
101 prt_printf(err, "incorrect value size (%zu != %zu)",
102 bkey_val_bytes(k.k), sizeof(struct bch_cookie));
103 return -BCH_ERR_invalid_bkey;
109 static bool key_type_set_merge(struct bch_fs *c, struct bkey_s l, struct bkey_s_c r)
111 bch2_key_resize(l.k, l.k->size + r.k->size);
115 #define bch2_bkey_ops_set ((struct bkey_ops) { \
116 .key_invalid = key_type_set_invalid, \
117 .key_merge = key_type_set_merge, \
120 const struct bkey_ops bch2_bkey_ops[] = {
121 #define x(name, nr) [KEY_TYPE_##name] = bch2_bkey_ops_##name,
126 int bch2_bkey_val_invalid(struct bch_fs *c, struct bkey_s_c k,
127 int rw, struct printbuf *err)
129 if (k.k->type >= KEY_TYPE_MAX) {
130 prt_printf(err, "invalid type (%u >= %u)", k.k->type, KEY_TYPE_MAX);
131 return -BCH_ERR_invalid_bkey;
134 return bch2_bkey_ops[k.k->type].key_invalid(c, k, rw, err);
137 static unsigned bch2_key_types_allowed[] = {
138 [BKEY_TYPE_extents] =
139 (1U << KEY_TYPE_deleted)|
140 (1U << KEY_TYPE_whiteout)|
141 (1U << KEY_TYPE_error)|
142 (1U << KEY_TYPE_cookie)|
143 (1U << KEY_TYPE_extent)|
144 (1U << KEY_TYPE_reservation)|
145 (1U << KEY_TYPE_reflink_p)|
146 (1U << KEY_TYPE_inline_data),
148 (1U << KEY_TYPE_deleted)|
149 (1U << KEY_TYPE_whiteout)|
150 (1U << KEY_TYPE_inode)|
151 (1U << KEY_TYPE_inode_v2)|
152 (1U << KEY_TYPE_inode_v3)|
153 (1U << KEY_TYPE_inode_generation),
154 [BKEY_TYPE_dirents] =
155 (1U << KEY_TYPE_deleted)|
156 (1U << KEY_TYPE_whiteout)|
157 (1U << KEY_TYPE_hash_whiteout)|
158 (1U << KEY_TYPE_dirent),
160 (1U << KEY_TYPE_deleted)|
161 (1U << KEY_TYPE_whiteout)|
162 (1U << KEY_TYPE_cookie)|
163 (1U << KEY_TYPE_hash_whiteout)|
164 (1U << KEY_TYPE_xattr),
166 (1U << KEY_TYPE_deleted)|
167 (1U << KEY_TYPE_alloc)|
168 (1U << KEY_TYPE_alloc_v2)|
169 (1U << KEY_TYPE_alloc_v3)|
170 (1U << KEY_TYPE_alloc_v4),
172 (1U << KEY_TYPE_deleted)|
173 (1U << KEY_TYPE_quota),
174 [BKEY_TYPE_stripes] =
175 (1U << KEY_TYPE_deleted)|
176 (1U << KEY_TYPE_stripe),
177 [BKEY_TYPE_reflink] =
178 (1U << KEY_TYPE_deleted)|
179 (1U << KEY_TYPE_reflink_v)|
180 (1U << KEY_TYPE_indirect_inline_data),
181 [BKEY_TYPE_subvolumes] =
182 (1U << KEY_TYPE_deleted)|
183 (1U << KEY_TYPE_subvolume),
184 [BKEY_TYPE_snapshots] =
185 (1U << KEY_TYPE_deleted)|
186 (1U << KEY_TYPE_snapshot),
188 (1U << KEY_TYPE_deleted)|
189 (1U << KEY_TYPE_lru),
190 [BKEY_TYPE_freespace] =
191 (1U << KEY_TYPE_deleted)|
192 (1U << KEY_TYPE_set),
193 [BKEY_TYPE_need_discard] =
194 (1U << KEY_TYPE_deleted)|
195 (1U << KEY_TYPE_set),
196 [BKEY_TYPE_backpointers] =
197 (1U << KEY_TYPE_deleted)|
198 (1U << KEY_TYPE_backpointer),
200 (1U << KEY_TYPE_deleted)|
201 (1U << KEY_TYPE_btree_ptr)|
202 (1U << KEY_TYPE_btree_ptr_v2),
205 int __bch2_bkey_invalid(struct bch_fs *c, struct bkey_s_c k,
206 enum btree_node_type type,
207 int rw, struct printbuf *err)
209 if (k.k->u64s < BKEY_U64s) {
210 prt_printf(err, "u64s too small (%u < %zu)", k.k->u64s, BKEY_U64s);
211 return -BCH_ERR_invalid_bkey;
214 if (!(bch2_key_types_allowed[type] & (1U << k.k->type))) {
215 prt_printf(err, "invalid key type for btree %s (%s)",
216 bch2_btree_ids[type], bch2_bkey_types[type]);
217 return -BCH_ERR_invalid_bkey;
220 if (btree_node_type_is_extents(type) && !bkey_whiteout(k.k)) {
221 if (k.k->size == 0) {
222 prt_printf(err, "size == 0");
223 return -BCH_ERR_invalid_bkey;
226 if (k.k->size > k.k->p.offset) {
227 prt_printf(err, "size greater than offset (%u > %llu)",
228 k.k->size, k.k->p.offset);
229 return -BCH_ERR_invalid_bkey;
233 prt_printf(err, "size != 0");
234 return -BCH_ERR_invalid_bkey;
238 if (type != BKEY_TYPE_btree &&
239 !btree_type_has_snapshots(type) &&
241 prt_printf(err, "nonzero snapshot");
242 return -BCH_ERR_invalid_bkey;
245 if (type != BKEY_TYPE_btree &&
246 btree_type_has_snapshots(type) &&
248 prt_printf(err, "snapshot == 0");
249 return -BCH_ERR_invalid_bkey;
252 if (type != BKEY_TYPE_btree &&
253 bkey_eq(k.k->p, POS_MAX)) {
254 prt_printf(err, "key at POS_MAX");
255 return -BCH_ERR_invalid_bkey;
261 int bch2_bkey_invalid(struct bch_fs *c, struct bkey_s_c k,
262 enum btree_node_type type,
263 int rw, struct printbuf *err)
265 return __bch2_bkey_invalid(c, k, type, rw, err) ?:
266 bch2_bkey_val_invalid(c, k, rw, err);
269 int bch2_bkey_in_btree_node(struct btree *b, struct bkey_s_c k,
270 struct printbuf *err)
272 if (bpos_lt(k.k->p, b->data->min_key)) {
273 prt_printf(err, "key before start of btree node");
274 return -BCH_ERR_invalid_bkey;
277 if (bpos_gt(k.k->p, b->data->max_key)) {
278 prt_printf(err, "key past end of btree node");
279 return -BCH_ERR_invalid_bkey;
285 void bch2_bpos_to_text(struct printbuf *out, struct bpos pos)
287 if (bpos_eq(pos, POS_MIN))
288 prt_printf(out, "POS_MIN");
289 else if (bpos_eq(pos, POS_MAX))
290 prt_printf(out, "POS_MAX");
291 else if (bpos_eq(pos, SPOS_MAX))
292 prt_printf(out, "SPOS_MAX");
294 if (pos.inode == U64_MAX)
295 prt_printf(out, "U64_MAX");
297 prt_printf(out, "%llu", pos.inode);
298 prt_printf(out, ":");
299 if (pos.offset == U64_MAX)
300 prt_printf(out, "U64_MAX");
302 prt_printf(out, "%llu", pos.offset);
303 prt_printf(out, ":");
304 if (pos.snapshot == U32_MAX)
305 prt_printf(out, "U32_MAX");
307 prt_printf(out, "%u", pos.snapshot);
311 void bch2_bkey_to_text(struct printbuf *out, const struct bkey *k)
314 prt_printf(out, "u64s %u type ", k->u64s);
316 if (k->type < KEY_TYPE_MAX)
317 prt_printf(out, "%s ", bch2_bkey_types[k->type]);
319 prt_printf(out, "%u ", k->type);
321 bch2_bpos_to_text(out, k->p);
323 prt_printf(out, " len %u ver %llu", k->size, k->version.lo);
325 prt_printf(out, "(null)");
329 void bch2_val_to_text(struct printbuf *out, struct bch_fs *c,
332 if (k.k->type < KEY_TYPE_MAX) {
333 const struct bkey_ops *ops = &bch2_bkey_ops[k.k->type];
335 if (likely(ops->val_to_text))
336 ops->val_to_text(out, c, k);
338 prt_printf(out, "(invalid type %u)", k.k->type);
342 void bch2_bkey_val_to_text(struct printbuf *out, struct bch_fs *c,
345 bch2_bkey_to_text(out, k.k);
347 if (bkey_val_bytes(k.k)) {
348 prt_printf(out, ": ");
349 bch2_val_to_text(out, c, k);
353 void bch2_bkey_swab_val(struct bkey_s k)
355 const struct bkey_ops *ops = &bch2_bkey_ops[k.k->type];
361 bool bch2_bkey_normalize(struct bch_fs *c, struct bkey_s k)
363 const struct bkey_ops *ops = &bch2_bkey_ops[k.k->type];
365 return ops->key_normalize
366 ? ops->key_normalize(c, k)
370 bool bch2_bkey_merge(struct bch_fs *c, struct bkey_s l, struct bkey_s_c r)
372 const struct bkey_ops *ops = &bch2_bkey_ops[l.k->type];
374 return bch2_bkey_maybe_mergable(l.k, r.k) && ops->key_merge(c, l, r);
377 static const struct old_bkey_type {
381 } bkey_renumber_table[] = {
382 {BKEY_TYPE_btree, 128, KEY_TYPE_btree_ptr },
383 {BKEY_TYPE_extents, 128, KEY_TYPE_extent },
384 {BKEY_TYPE_extents, 129, KEY_TYPE_extent },
385 {BKEY_TYPE_extents, 130, KEY_TYPE_reservation },
386 {BKEY_TYPE_inodes, 128, KEY_TYPE_inode },
387 {BKEY_TYPE_inodes, 130, KEY_TYPE_inode_generation },
388 {BKEY_TYPE_dirents, 128, KEY_TYPE_dirent },
389 {BKEY_TYPE_dirents, 129, KEY_TYPE_hash_whiteout },
390 {BKEY_TYPE_xattrs, 128, KEY_TYPE_xattr },
391 {BKEY_TYPE_xattrs, 129, KEY_TYPE_hash_whiteout },
392 {BKEY_TYPE_alloc, 128, KEY_TYPE_alloc },
393 {BKEY_TYPE_quotas, 128, KEY_TYPE_quota },
396 void bch2_bkey_renumber(enum btree_node_type btree_node_type,
397 struct bkey_packed *k,
400 const struct old_bkey_type *i;
402 for (i = bkey_renumber_table;
403 i < bkey_renumber_table + ARRAY_SIZE(bkey_renumber_table);
405 if (btree_node_type == i->btree_node_type &&
406 k->type == (write ? i->new : i->old)) {
407 k->type = write ? i->old : i->new;
412 void __bch2_bkey_compat(unsigned level, enum btree_id btree_id,
413 unsigned version, unsigned big_endian,
415 struct bkey_format *f,
416 struct bkey_packed *k)
418 const struct bkey_ops *ops;
421 unsigned nr_compat = 5;
425 * Do these operations in reverse order in the write path:
428 for (i = 0; i < nr_compat; i++)
429 switch (!write ? i : nr_compat - 1 - i) {
431 if (big_endian != CPU_BIG_ENDIAN)
432 bch2_bkey_swab_key(f, k);
435 if (version < bcachefs_metadata_version_bkey_renumber)
436 bch2_bkey_renumber(__btree_node_type(level, btree_id), k, write);
439 if (version < bcachefs_metadata_version_inode_btree_change &&
440 btree_id == BTREE_ID_inodes) {
441 if (!bkey_packed(k)) {
442 struct bkey_i *u = packed_to_bkey(k);
444 swap(u->k.p.inode, u->k.p.offset);
445 } else if (f->bits_per_field[BKEY_FIELD_INODE] &&
446 f->bits_per_field[BKEY_FIELD_OFFSET]) {
447 struct bkey_format tmp = *f, *in = f, *out = &tmp;
449 swap(tmp.bits_per_field[BKEY_FIELD_INODE],
450 tmp.bits_per_field[BKEY_FIELD_OFFSET]);
451 swap(tmp.field_offset[BKEY_FIELD_INODE],
452 tmp.field_offset[BKEY_FIELD_OFFSET]);
457 uk = __bch2_bkey_unpack_key(in, k);
458 swap(uk.p.inode, uk.p.offset);
459 BUG_ON(!bch2_bkey_pack_key(k, &uk, out));
464 if (version < bcachefs_metadata_version_snapshot &&
465 (level || btree_type_has_snapshots(btree_id))) {
466 struct bkey_i *u = packed_to_bkey(k);
469 u->k.p.snapshot = write
472 u64 min_packed = f->field_offset[BKEY_FIELD_SNAPSHOT];
473 u64 max_packed = min_packed +
474 ~(~0ULL << f->bits_per_field[BKEY_FIELD_SNAPSHOT]);
476 uk = __bch2_bkey_unpack_key(f, k);
477 uk.p.snapshot = write
478 ? min_packed : min_t(u64, U32_MAX, max_packed);
480 BUG_ON(!bch2_bkey_pack_key(k, &uk, f));
486 if (!bkey_packed(k)) {
487 u = bkey_i_to_s(packed_to_bkey(k));
489 uk = __bch2_bkey_unpack_key(f, k);
491 u.v = bkeyp_val(f, k);
494 if (big_endian != CPU_BIG_ENDIAN)
495 bch2_bkey_swab_val(u);
497 ops = &bch2_bkey_ops[k->type];
500 ops->compat(btree_id, version, big_endian, write, u);