1 // SPDX-License-Identifier: GPL-2.0
4 #include "btree_key_cache.h"
5 #include "bkey_methods.h"
6 #include "btree_update.h"
10 #include "extent_update.h"
13 #include "subvolume.h"
16 #include <linux/random.h>
18 #include <asm/unaligned.h>
20 const char * const bch2_inode_opts[] = {
21 #define x(name, ...) #name,
27 static const u8 byte_table[8] = { 1, 2, 3, 4, 6, 8, 10, 13 };
29 static int inode_decode_field(const u8 *in, const u8 *end,
30 u64 out[2], unsigned *out_bits)
32 __be64 be[2] = { 0, 0 };
33 unsigned bytes, shift;
43 * position of highest set bit indicates number of bytes:
44 * shift = number of bits to remove in high byte:
46 shift = 8 - __fls(*in); /* 1 <= shift <= 8 */
47 bytes = byte_table[shift - 1];
52 p = (u8 *) be + 16 - bytes;
54 *p ^= (1 << 8) >> shift;
56 out[0] = be64_to_cpu(be[0]);
57 out[1] = be64_to_cpu(be[1]);
58 *out_bits = out[0] ? 64 + fls64(out[0]) : fls64(out[1]);
63 void bch2_inode_pack(struct bch_fs *c,
64 struct bkey_inode_buf *packed,
65 const struct bch_inode_unpacked *inode)
67 struct bkey_i_inode_v2 *k = &packed->inode;
68 u8 *out = k->v.fields;
69 u8 *end = (void *) &packed[1];
70 u8 *last_nonzero_field = out;
71 unsigned nr_fields = 0, last_nonzero_fieldnr = 0;
75 bkey_inode_v2_init(&packed->inode.k_i);
76 packed->inode.k.p.offset = inode->bi_inum;
77 packed->inode.v.bi_journal_seq = cpu_to_le64(inode->bi_journal_seq);
78 packed->inode.v.bi_hash_seed = inode->bi_hash_seed;
79 packed->inode.v.bi_flags = cpu_to_le64(inode->bi_flags);
80 packed->inode.v.bi_flags = cpu_to_le64(inode->bi_flags);
81 packed->inode.v.bi_mode = cpu_to_le16(inode->bi_mode);
83 #define x(_name, _bits) \
87 ret = bch2_varint_encode_fast(out, inode->_name); \
93 last_nonzero_field = out; \
94 last_nonzero_fieldnr = nr_fields; \
106 out = last_nonzero_field;
107 nr_fields = last_nonzero_fieldnr;
109 bytes = out - (u8 *) &packed->inode.v;
110 set_bkey_val_bytes(&packed->inode.k, bytes);
111 memset_u64s_tail(&packed->inode.v, 0, bytes);
113 SET_INODEv2_NR_FIELDS(&k->v, nr_fields);
115 if (IS_ENABLED(CONFIG_BCACHEFS_DEBUG)) {
116 struct bch_inode_unpacked unpacked;
118 int ret = bch2_inode_unpack(bkey_i_to_s_c(&packed->inode.k_i),
121 BUG_ON(unpacked.bi_inum != inode->bi_inum);
122 BUG_ON(unpacked.bi_hash_seed != inode->bi_hash_seed);
123 BUG_ON(unpacked.bi_mode != inode->bi_mode);
125 #define x(_name, _bits) if (unpacked._name != inode->_name) \
126 panic("unpacked %llu should be %llu", \
127 (u64) unpacked._name, (u64) inode->_name);
133 static noinline int bch2_inode_unpack_v1(struct bkey_s_c_inode inode,
134 struct bch_inode_unpacked *unpacked)
136 const u8 *in = inode.v->fields;
137 const u8 *end = bkey_val_end(inode);
139 unsigned fieldnr = 0, field_bits;
142 #define x(_name, _bits) \
143 if (fieldnr++ == INODE_NR_FIELDS(inode.v)) { \
144 memset(&unpacked->_name, 0, \
145 sizeof(*unpacked) - \
146 offsetof(struct bch_inode_unpacked, _name)); \
150 ret = inode_decode_field(in, end, field, &field_bits); \
154 if (field_bits > sizeof(unpacked->_name) * 8) \
157 unpacked->_name = field[1]; \
163 /* XXX: signal if there were more fields than expected? */
167 static int bch2_inode_unpack_v2(struct bch_inode_unpacked *unpacked,
168 const u8 *in, const u8 *end,
171 unsigned fieldnr = 0;
175 #define x(_name, _bits) \
176 if (fieldnr < nr_fields) { \
177 ret = bch2_varint_decode_fast(in, end, &v[0]); \
183 ret = bch2_varint_decode_fast(in, end, &v[1]); \
194 unpacked->_name = v[0]; \
195 if (v[1] || v[0] != unpacked->_name) \
202 /* XXX: signal if there were more fields than expected? */
206 int bch2_inode_unpack(struct bkey_s_c k,
207 struct bch_inode_unpacked *unpacked)
210 case KEY_TYPE_inode: {
211 struct bkey_s_c_inode inode = bkey_s_c_to_inode(k);
213 unpacked->bi_inum = inode.k->p.offset;
214 unpacked->bi_journal_seq= 0;
215 unpacked->bi_hash_seed = inode.v->bi_hash_seed;
216 unpacked->bi_flags = le32_to_cpu(inode.v->bi_flags);
217 unpacked->bi_mode = le16_to_cpu(inode.v->bi_mode);
219 if (INODE_NEW_VARINT(inode.v)) {
220 return bch2_inode_unpack_v2(unpacked, inode.v->fields,
222 INODE_NR_FIELDS(inode.v));
224 return bch2_inode_unpack_v1(inode, unpacked);
228 case KEY_TYPE_inode_v2: {
229 struct bkey_s_c_inode_v2 inode = bkey_s_c_to_inode_v2(k);
231 unpacked->bi_inum = inode.k->p.offset;
232 unpacked->bi_journal_seq= le64_to_cpu(inode.v->bi_journal_seq);
233 unpacked->bi_hash_seed = inode.v->bi_hash_seed;
234 unpacked->bi_flags = le64_to_cpu(inode.v->bi_flags);
235 unpacked->bi_mode = le16_to_cpu(inode.v->bi_mode);
237 return bch2_inode_unpack_v2(unpacked, inode.v->fields,
239 INODEv2_NR_FIELDS(inode.v));
246 int bch2_inode_peek(struct btree_trans *trans,
247 struct btree_iter *iter,
248 struct bch_inode_unpacked *inode,
249 subvol_inum inum, unsigned flags)
255 if (0 && trans->c->opts.inodes_use_key_cache)
256 flags |= BTREE_ITER_CACHED;
258 ret = bch2_subvolume_get_snapshot(trans, inum.subvol, &snapshot);
262 bch2_trans_iter_init(trans, iter, BTREE_ID_inodes,
263 SPOS(0, inum.inum, snapshot), flags);
264 k = bch2_btree_iter_peek_slot(iter);
269 ret = bkey_is_inode(k.k) ? 0 : -ENOENT;
273 ret = bch2_inode_unpack(k, inode);
279 bch2_trans_iter_exit(trans, iter);
283 int bch2_inode_write(struct btree_trans *trans,
284 struct btree_iter *iter,
285 struct bch_inode_unpacked *inode)
287 struct bkey_inode_buf *inode_p;
289 inode_p = bch2_trans_kmalloc(trans, sizeof(*inode_p));
291 return PTR_ERR(inode_p);
293 bch2_inode_pack(trans->c, inode_p, inode);
294 inode_p->inode.k.p.snapshot = iter->snapshot;
295 return bch2_trans_update(trans, iter, &inode_p->inode.k_i, 0);
298 const char *bch2_inode_invalid(const struct bch_fs *c, struct bkey_s_c k)
300 struct bkey_s_c_inode inode = bkey_s_c_to_inode(k);
301 struct bch_inode_unpacked unpacked;
304 return "nonzero k.p.inode";
306 if (bkey_val_bytes(k.k) < sizeof(struct bch_inode))
307 return "incorrect value size";
309 if (k.k->p.offset < BLOCKDEV_INODE_MAX)
310 return "fs inode in blockdev range";
312 if (INODE_STR_HASH(inode.v) >= BCH_STR_HASH_NR)
313 return "invalid str hash type";
315 if (bch2_inode_unpack(k, &unpacked))
316 return "invalid variable length fields";
318 if (unpacked.bi_data_checksum >= BCH_CSUM_OPT_NR + 1)
319 return "invalid data checksum type";
321 if (unpacked.bi_compression >= BCH_COMPRESSION_OPT_NR + 1)
322 return "invalid data checksum type";
324 if ((unpacked.bi_flags & BCH_INODE_UNLINKED) &&
325 unpacked.bi_nlink != 0)
326 return "flagged as unlinked but bi_nlink != 0";
328 if (unpacked.bi_subvol && !S_ISDIR(unpacked.bi_mode))
329 return "subvolume root but not a directory";
334 const char *bch2_inode_v2_invalid(const struct bch_fs *c, struct bkey_s_c k)
336 struct bkey_s_c_inode_v2 inode = bkey_s_c_to_inode_v2(k);
337 struct bch_inode_unpacked unpacked;
340 return "nonzero k.p.inode";
342 if (bkey_val_bytes(k.k) < sizeof(struct bch_inode))
343 return "incorrect value size";
345 if (k.k->p.offset < BLOCKDEV_INODE_MAX)
346 return "fs inode in blockdev range";
348 if (INODEv2_STR_HASH(inode.v) >= BCH_STR_HASH_NR)
349 return "invalid str hash type";
351 if (bch2_inode_unpack(k, &unpacked))
352 return "invalid variable length fields";
354 if (unpacked.bi_data_checksum >= BCH_CSUM_OPT_NR + 1)
355 return "invalid data checksum type";
357 if (unpacked.bi_compression >= BCH_COMPRESSION_OPT_NR + 1)
358 return "invalid data checksum type";
360 if ((unpacked.bi_flags & BCH_INODE_UNLINKED) &&
361 unpacked.bi_nlink != 0)
362 return "flagged as unlinked but bi_nlink != 0";
364 if (unpacked.bi_subvol && !S_ISDIR(unpacked.bi_mode))
365 return "subvolume root but not a directory";
370 static void __bch2_inode_unpacked_to_text(struct printbuf *out, struct bch_inode_unpacked *inode)
372 pr_buf(out, "mode %o flags %x journal_seq %llu",
373 inode->bi_mode, inode->bi_flags,
374 inode->bi_journal_seq);
376 #define x(_name, _bits) \
377 pr_buf(out, " "#_name " %llu", (u64) inode->_name);
382 void bch2_inode_unpacked_to_text(struct printbuf *out, struct bch_inode_unpacked *inode)
384 pr_buf(out, "inum: %llu ", inode->bi_inum);
385 __bch2_inode_unpacked_to_text(out, inode);
388 void bch2_inode_to_text(struct printbuf *out, struct bch_fs *c,
391 struct bch_inode_unpacked inode;
393 if (bch2_inode_unpack(k, &inode)) {
394 pr_buf(out, "(unpack error)");
398 __bch2_inode_unpacked_to_text(out, &inode);
401 const char *bch2_inode_generation_invalid(const struct bch_fs *c,
405 return "nonzero k.p.inode";
407 if (bkey_val_bytes(k.k) != sizeof(struct bch_inode_generation))
408 return "incorrect value size";
413 void bch2_inode_generation_to_text(struct printbuf *out, struct bch_fs *c,
416 struct bkey_s_c_inode_generation gen = bkey_s_c_to_inode_generation(k);
418 pr_buf(out, "generation: %u", le32_to_cpu(gen.v->bi_generation));
421 void bch2_inode_init_early(struct bch_fs *c,
422 struct bch_inode_unpacked *inode_u)
424 enum bch_str_hash_type str_hash =
425 bch2_str_hash_opt_to_type(c, c->opts.str_hash);
427 memset(inode_u, 0, sizeof(*inode_u));
430 inode_u->bi_flags |= str_hash << INODE_STR_HASH_OFFSET;
431 get_random_bytes(&inode_u->bi_hash_seed,
432 sizeof(inode_u->bi_hash_seed));
435 void bch2_inode_init_late(struct bch_inode_unpacked *inode_u, u64 now,
436 uid_t uid, gid_t gid, umode_t mode, dev_t rdev,
437 struct bch_inode_unpacked *parent)
439 inode_u->bi_mode = mode;
440 inode_u->bi_uid = uid;
441 inode_u->bi_gid = gid;
442 inode_u->bi_dev = rdev;
443 inode_u->bi_atime = now;
444 inode_u->bi_mtime = now;
445 inode_u->bi_ctime = now;
446 inode_u->bi_otime = now;
448 if (parent && parent->bi_mode & S_ISGID) {
449 inode_u->bi_gid = parent->bi_gid;
451 inode_u->bi_mode |= S_ISGID;
455 #define x(_name, ...) inode_u->bi_##_name = parent->bi_##_name;
461 void bch2_inode_init(struct bch_fs *c, struct bch_inode_unpacked *inode_u,
462 uid_t uid, gid_t gid, umode_t mode, dev_t rdev,
463 struct bch_inode_unpacked *parent)
465 bch2_inode_init_early(c, inode_u);
466 bch2_inode_init_late(inode_u, bch2_current_time(c),
467 uid, gid, mode, rdev, parent);
470 static inline u32 bkey_generation(struct bkey_s_c k)
474 case KEY_TYPE_inode_v2:
476 case KEY_TYPE_inode_generation:
477 return le32_to_cpu(bkey_s_c_to_inode_generation(k).v->bi_generation);
484 * This just finds an empty slot:
486 int bch2_inode_create(struct btree_trans *trans,
487 struct btree_iter *iter,
488 struct bch_inode_unpacked *inode_u,
489 u32 snapshot, u64 cpu)
491 struct bch_fs *c = trans->c;
493 u64 min, max, start, pos, *hint;
495 unsigned bits = (c->opts.inodes_32bit ? 31 : 63);
497 if (c->opts.shard_inode_numbers) {
498 bits -= c->inode_shard_bits;
501 max = (cpu << bits) | ~(ULLONG_MAX << bits);
503 min = max_t(u64, min, BLOCKDEV_INODE_MAX);
504 hint = c->unused_inode_hints + cpu;
506 min = BLOCKDEV_INODE_MAX;
507 max = ~(ULLONG_MAX << bits);
508 hint = c->unused_inode_hints;
511 start = READ_ONCE(*hint);
513 if (start >= max || start < min)
517 bch2_trans_iter_init(trans, iter, BTREE_ID_inodes, POS(0, pos),
518 BTREE_ITER_ALL_SNAPSHOTS|
521 while ((k = bch2_btree_iter_peek(iter)).k &&
522 !(ret = bkey_err(k)) &&
523 bkey_cmp(k.k->p, POS(0, max)) < 0) {
524 while (pos < iter->pos.offset) {
525 if (!bch2_btree_key_cache_find(c, BTREE_ID_inodes, POS(0, pos)))
531 if (k.k->p.snapshot == snapshot &&
532 !bkey_is_inode(k.k) &&
533 !bch2_btree_key_cache_find(c, BTREE_ID_inodes, SPOS(0, pos, snapshot))) {
534 bch2_btree_iter_advance(iter);
539 * We don't need to iterate over keys in every snapshot once
540 * we've found just one:
542 pos = iter->pos.offset + 1;
543 bch2_btree_iter_set_pos(iter, POS(0, pos));
546 while (!ret && pos < max) {
547 if (!bch2_btree_key_cache_find(c, BTREE_ID_inodes, POS(0, pos)))
553 if (!ret && start == min)
557 bch2_trans_iter_exit(trans, iter);
561 /* Retry from start */
563 bch2_btree_iter_set_pos(iter, POS(0, pos));
566 bch2_btree_iter_set_pos(iter, SPOS(0, pos, snapshot));
567 k = bch2_btree_iter_peek_slot(iter);
570 bch2_trans_iter_exit(trans, iter);
574 /* We may have raced while the iterator wasn't pointing at pos: */
575 if (bkey_is_inode(k.k) ||
576 bch2_btree_key_cache_find(c, BTREE_ID_inodes, k.k->p))
579 *hint = k.k->p.offset;
580 inode_u->bi_inum = k.k->p.offset;
581 inode_u->bi_generation = bkey_generation(k);
585 static int bch2_inode_delete_keys(struct btree_trans *trans,
586 subvol_inum inum, enum btree_id id)
588 struct btree_iter iter;
590 struct bkey_i delete;
595 * We're never going to be deleting extents, no need to use an extent
598 bch2_trans_iter_init(trans, &iter, id, POS(inum.inum, 0),
599 BTREE_ITER_NOT_EXTENTS|
603 bch2_trans_begin(trans);
605 ret = bch2_subvolume_get_snapshot(trans, inum.subvol, &snapshot);
609 bch2_btree_iter_set_snapshot(&iter, snapshot);
611 k = bch2_btree_iter_peek(&iter);
616 if (!k.k || iter.pos.inode != inum.inum)
619 bkey_init(&delete.k);
620 delete.k.p = iter.pos;
622 ret = bch2_trans_update(trans, &iter, &delete, 0) ?:
623 bch2_trans_commit(trans, NULL, NULL,
624 BTREE_INSERT_NOFAIL);
626 if (ret && ret != -EINTR)
630 bch2_trans_iter_exit(trans, &iter);
634 int bch2_inode_rm(struct bch_fs *c, subvol_inum inum, bool cached)
636 struct btree_trans trans;
637 struct btree_iter iter = { NULL };
638 struct bkey_i_inode_generation delete;
639 struct bch_inode_unpacked inode_u;
641 unsigned iter_flags = BTREE_ITER_INTENT;
645 if (0 && cached && c->opts.inodes_use_key_cache)
646 iter_flags |= BTREE_ITER_CACHED;
648 bch2_trans_init(&trans, c, 0, 1024);
651 * If this was a directory, there shouldn't be any real dirents left -
652 * but there could be whiteouts (from hash collisions) that we should
655 * XXX: the dirent could ideally would delete whiteouts when they're no
658 ret = bch2_inode_delete_keys(&trans, inum, BTREE_ID_extents) ?:
659 bch2_inode_delete_keys(&trans, inum, BTREE_ID_xattrs) ?:
660 bch2_inode_delete_keys(&trans, inum, BTREE_ID_dirents);
664 bch2_trans_begin(&trans);
666 ret = bch2_subvolume_get_snapshot(&trans, inum.subvol, &snapshot);
670 bch2_trans_iter_init(&trans, &iter, BTREE_ID_inodes,
671 SPOS(0, inum.inum, snapshot), iter_flags);
672 k = bch2_btree_iter_peek_slot(&iter);
678 if (!bkey_is_inode(k.k)) {
679 bch2_fs_inconsistent(trans.c,
680 "inode %llu not found when deleting",
686 bch2_inode_unpack(k, &inode_u);
688 /* Subvolume root? */
689 BUG_ON(inode_u.bi_subvol);
691 bkey_inode_generation_init(&delete.k_i);
692 delete.k.p = iter.pos;
693 delete.v.bi_generation = cpu_to_le32(inode_u.bi_generation + 1);
695 ret = bch2_trans_update(&trans, &iter, &delete.k_i, 0) ?:
696 bch2_trans_commit(&trans, NULL, NULL,
697 BTREE_INSERT_NOFAIL);
699 bch2_trans_iter_exit(&trans, &iter);
703 bch2_trans_exit(&trans);
707 int bch2_inode_find_by_inum_trans(struct btree_trans *trans,
709 struct bch_inode_unpacked *inode)
711 struct btree_iter iter;
714 ret = bch2_inode_peek(trans, &iter, inode, inum, 0);
716 bch2_trans_iter_exit(trans, &iter);
720 int bch2_inode_find_by_inum(struct bch_fs *c, subvol_inum inum,
721 struct bch_inode_unpacked *inode)
723 return bch2_trans_do(c, NULL, NULL, 0,
724 bch2_inode_find_by_inum_trans(&trans, inum, inode));