1 // SPDX-License-Identifier: GPL-2.0
4 #include "btree_key_cache.h"
5 #include "bkey_methods.h"
6 #include "btree_update.h"
9 #include "extent_update.h"
12 #include "subvolume.h"
15 #include <linux/random.h>
17 #include <asm/unaligned.h>
19 const char * const bch2_inode_opts[] = {
20 #define x(name, ...) #name,
26 static const u8 byte_table[8] = { 1, 2, 3, 4, 6, 8, 10, 13 };
27 static const u8 bits_table[8] = {
38 static int inode_encode_field(u8 *out, u8 *end, u64 hi, u64 lo)
40 __be64 in[2] = { cpu_to_be64(hi), cpu_to_be64(lo), };
41 unsigned shift, bytes, bits = likely(!hi)
45 for (shift = 1; shift <= 8; shift++)
46 if (bits < bits_table[shift - 1])
51 bytes = byte_table[shift - 1];
53 BUG_ON(out + bytes > end);
55 memcpy(out, (u8 *) in + 16 - bytes, bytes);
56 *out |= (1 << 8) >> shift;
61 static int inode_decode_field(const u8 *in, const u8 *end,
62 u64 out[2], unsigned *out_bits)
64 __be64 be[2] = { 0, 0 };
65 unsigned bytes, shift;
75 * position of highest set bit indicates number of bytes:
76 * shift = number of bits to remove in high byte:
78 shift = 8 - __fls(*in); /* 1 <= shift <= 8 */
79 bytes = byte_table[shift - 1];
84 p = (u8 *) be + 16 - bytes;
86 *p ^= (1 << 8) >> shift;
88 out[0] = be64_to_cpu(be[0]);
89 out[1] = be64_to_cpu(be[1]);
90 *out_bits = out[0] ? 64 + fls64(out[0]) : fls64(out[1]);
95 static noinline void bch2_inode_pack_v1(struct bkey_inode_buf *packed,
96 const struct bch_inode_unpacked *inode)
98 struct bkey_i_inode *k = &packed->inode;
99 u8 *out = k->v.fields;
100 u8 *end = (void *) &packed[1];
101 u8 *last_nonzero_field = out;
102 unsigned nr_fields = 0, last_nonzero_fieldnr = 0;
105 #define x(_name, _bits) \
106 out += inode_encode_field(out, end, 0, inode->_name); \
109 if (inode->_name) { \
110 last_nonzero_field = out; \
111 last_nonzero_fieldnr = nr_fields; \
117 out = last_nonzero_field;
118 nr_fields = last_nonzero_fieldnr;
120 bytes = out - (u8 *) &packed->inode.v;
121 set_bkey_val_bytes(&packed->inode.k, bytes);
122 memset_u64s_tail(&packed->inode.v, 0, bytes);
124 SET_INODE_NR_FIELDS(&k->v, nr_fields);
127 static void bch2_inode_pack_v2(struct bkey_inode_buf *packed,
128 const struct bch_inode_unpacked *inode)
130 struct bkey_i_inode *k = &packed->inode;
131 u8 *out = k->v.fields;
132 u8 *end = (void *) &packed[1];
133 u8 *last_nonzero_field = out;
134 unsigned nr_fields = 0, last_nonzero_fieldnr = 0;
138 #define x(_name, _bits) \
141 if (inode->_name) { \
142 ret = bch2_varint_encode_fast(out, inode->_name); \
148 last_nonzero_field = out; \
149 last_nonzero_fieldnr = nr_fields; \
161 out = last_nonzero_field;
162 nr_fields = last_nonzero_fieldnr;
164 bytes = out - (u8 *) &packed->inode.v;
165 set_bkey_val_bytes(&packed->inode.k, bytes);
166 memset_u64s_tail(&packed->inode.v, 0, bytes);
168 SET_INODE_NR_FIELDS(&k->v, nr_fields);
171 void bch2_inode_pack(struct bch_fs *c,
172 struct bkey_inode_buf *packed,
173 const struct bch_inode_unpacked *inode)
175 bkey_inode_init(&packed->inode.k_i);
176 packed->inode.k.p.offset = inode->bi_inum;
177 packed->inode.v.bi_hash_seed = inode->bi_hash_seed;
178 packed->inode.v.bi_flags = cpu_to_le32(inode->bi_flags);
179 packed->inode.v.bi_mode = cpu_to_le16(inode->bi_mode);
181 if (c->sb.features & (1ULL << BCH_FEATURE_new_varint)) {
182 SET_INODE_NEW_VARINT(&packed->inode.v, true);
183 bch2_inode_pack_v2(packed, inode);
185 bch2_inode_pack_v1(packed, inode);
188 if (IS_ENABLED(CONFIG_BCACHEFS_DEBUG)) {
189 struct bch_inode_unpacked unpacked;
191 int ret = bch2_inode_unpack(inode_i_to_s_c(&packed->inode),
194 BUG_ON(unpacked.bi_inum != inode->bi_inum);
195 BUG_ON(unpacked.bi_hash_seed != inode->bi_hash_seed);
196 BUG_ON(unpacked.bi_mode != inode->bi_mode);
198 #define x(_name, _bits) if (unpacked._name != inode->_name) \
199 panic("unpacked %llu should be %llu", \
200 (u64) unpacked._name, (u64) inode->_name);
206 static noinline int bch2_inode_unpack_v1(struct bkey_s_c_inode inode,
207 struct bch_inode_unpacked *unpacked)
209 const u8 *in = inode.v->fields;
210 const u8 *end = bkey_val_end(inode);
212 unsigned fieldnr = 0, field_bits;
215 #define x(_name, _bits) \
216 if (fieldnr++ == INODE_NR_FIELDS(inode.v)) { \
217 memset(&unpacked->_name, 0, \
218 sizeof(*unpacked) - \
219 offsetof(struct bch_inode_unpacked, _name)); \
223 ret = inode_decode_field(in, end, field, &field_bits); \
227 if (field_bits > sizeof(unpacked->_name) * 8) \
230 unpacked->_name = field[1]; \
236 /* XXX: signal if there were more fields than expected? */
240 static int bch2_inode_unpack_v2(struct bkey_s_c_inode inode,
241 struct bch_inode_unpacked *unpacked)
243 const u8 *in = inode.v->fields;
244 const u8 *end = bkey_val_end(inode);
245 unsigned fieldnr = 0;
249 #define x(_name, _bits) \
250 if (fieldnr < INODE_NR_FIELDS(inode.v)) { \
251 ret = bch2_varint_decode_fast(in, end, &v[0]); \
257 ret = bch2_varint_decode_fast(in, end, &v[1]); \
268 unpacked->_name = v[0]; \
269 if (v[1] || v[0] != unpacked->_name) \
276 /* XXX: signal if there were more fields than expected? */
280 int bch2_inode_unpack(struct bkey_s_c_inode inode,
281 struct bch_inode_unpacked *unpacked)
283 unpacked->bi_inum = inode.k->p.offset;
284 unpacked->bi_hash_seed = inode.v->bi_hash_seed;
285 unpacked->bi_flags = le32_to_cpu(inode.v->bi_flags);
286 unpacked->bi_mode = le16_to_cpu(inode.v->bi_mode);
288 if (INODE_NEW_VARINT(inode.v)) {
289 return bch2_inode_unpack_v2(inode, unpacked);
291 return bch2_inode_unpack_v1(inode, unpacked);
297 int bch2_inode_peek(struct btree_trans *trans,
298 struct btree_iter *iter,
299 struct bch_inode_unpacked *inode,
300 subvol_inum inum, unsigned flags)
306 if (0 && trans->c->opts.inodes_use_key_cache)
307 flags |= BTREE_ITER_CACHED;
309 ret = bch2_subvolume_get_snapshot(trans, inum.subvol, &snapshot);
313 bch2_trans_iter_init(trans, iter, BTREE_ID_inodes,
314 SPOS(0, inum.inum, snapshot), flags);
315 k = bch2_btree_iter_peek_slot(iter);
320 ret = k.k->type == KEY_TYPE_inode ? 0 : -ENOENT;
324 ret = bch2_inode_unpack(bkey_s_c_to_inode(k), inode);
330 bch2_trans_iter_exit(trans, iter);
334 int bch2_inode_write(struct btree_trans *trans,
335 struct btree_iter *iter,
336 struct bch_inode_unpacked *inode)
338 struct bkey_inode_buf *inode_p;
340 inode_p = bch2_trans_kmalloc(trans, sizeof(*inode_p));
342 return PTR_ERR(inode_p);
344 bch2_inode_pack(trans->c, inode_p, inode);
345 inode_p->inode.k.p.snapshot = iter->snapshot;
346 return bch2_trans_update(trans, iter, &inode_p->inode.k_i, 0);
349 const char *bch2_inode_invalid(const struct bch_fs *c, struct bkey_s_c k)
351 struct bkey_s_c_inode inode = bkey_s_c_to_inode(k);
352 struct bch_inode_unpacked unpacked;
355 return "nonzero k.p.inode";
357 if (bkey_val_bytes(k.k) < sizeof(struct bch_inode))
358 return "incorrect value size";
360 if (k.k->p.offset < BLOCKDEV_INODE_MAX)
361 return "fs inode in blockdev range";
363 if (INODE_STR_HASH(inode.v) >= BCH_STR_HASH_NR)
364 return "invalid str hash type";
366 if (bch2_inode_unpack(inode, &unpacked))
367 return "invalid variable length fields";
369 if (unpacked.bi_data_checksum >= BCH_CSUM_OPT_NR + 1)
370 return "invalid data checksum type";
372 if (unpacked.bi_compression >= BCH_COMPRESSION_OPT_NR + 1)
373 return "invalid data checksum type";
375 if ((unpacked.bi_flags & BCH_INODE_UNLINKED) &&
376 unpacked.bi_nlink != 0)
377 return "flagged as unlinked but bi_nlink != 0";
379 if (unpacked.bi_subvol && !S_ISDIR(unpacked.bi_mode))
380 return "subvolume root but not a directory";
385 static void __bch2_inode_unpacked_to_text(struct printbuf *out, struct bch_inode_unpacked *inode)
387 pr_buf(out, "mode %o flags %x ", inode->bi_mode, inode->bi_flags);
389 #define x(_name, _bits) \
390 pr_buf(out, #_name " %llu ", (u64) inode->_name);
395 void bch2_inode_unpacked_to_text(struct printbuf *out, struct bch_inode_unpacked *inode)
397 pr_buf(out, "inum: %llu ", inode->bi_inum);
398 __bch2_inode_unpacked_to_text(out, inode);
401 void bch2_inode_to_text(struct printbuf *out, struct bch_fs *c,
404 struct bkey_s_c_inode inode = bkey_s_c_to_inode(k);
405 struct bch_inode_unpacked unpacked;
407 if (bch2_inode_unpack(inode, &unpacked)) {
408 pr_buf(out, "(unpack error)");
412 __bch2_inode_unpacked_to_text(out, &unpacked);
415 const char *bch2_inode_generation_invalid(const struct bch_fs *c,
419 return "nonzero k.p.inode";
421 if (bkey_val_bytes(k.k) != sizeof(struct bch_inode_generation))
422 return "incorrect value size";
427 void bch2_inode_generation_to_text(struct printbuf *out, struct bch_fs *c,
430 struct bkey_s_c_inode_generation gen = bkey_s_c_to_inode_generation(k);
432 pr_buf(out, "generation: %u", le32_to_cpu(gen.v->bi_generation));
435 void bch2_inode_init_early(struct bch_fs *c,
436 struct bch_inode_unpacked *inode_u)
438 enum bch_str_hash_type str_hash =
439 bch2_str_hash_opt_to_type(c, c->opts.str_hash);
441 memset(inode_u, 0, sizeof(*inode_u));
444 inode_u->bi_flags |= str_hash << INODE_STR_HASH_OFFSET;
445 get_random_bytes(&inode_u->bi_hash_seed,
446 sizeof(inode_u->bi_hash_seed));
449 void bch2_inode_init_late(struct bch_inode_unpacked *inode_u, u64 now,
450 uid_t uid, gid_t gid, umode_t mode, dev_t rdev,
451 struct bch_inode_unpacked *parent)
453 inode_u->bi_mode = mode;
454 inode_u->bi_uid = uid;
455 inode_u->bi_gid = gid;
456 inode_u->bi_dev = rdev;
457 inode_u->bi_atime = now;
458 inode_u->bi_mtime = now;
459 inode_u->bi_ctime = now;
460 inode_u->bi_otime = now;
462 if (parent && parent->bi_mode & S_ISGID) {
463 inode_u->bi_gid = parent->bi_gid;
465 inode_u->bi_mode |= S_ISGID;
469 #define x(_name, ...) inode_u->bi_##_name = parent->bi_##_name;
475 void bch2_inode_init(struct bch_fs *c, struct bch_inode_unpacked *inode_u,
476 uid_t uid, gid_t gid, umode_t mode, dev_t rdev,
477 struct bch_inode_unpacked *parent)
479 bch2_inode_init_early(c, inode_u);
480 bch2_inode_init_late(inode_u, bch2_current_time(c),
481 uid, gid, mode, rdev, parent);
484 static inline u32 bkey_generation(struct bkey_s_c k)
489 case KEY_TYPE_inode_generation:
490 return le32_to_cpu(bkey_s_c_to_inode_generation(k).v->bi_generation);
497 * This just finds an empty slot:
499 int bch2_inode_create(struct btree_trans *trans,
500 struct btree_iter *iter,
501 struct bch_inode_unpacked *inode_u,
502 u32 snapshot, u64 cpu)
504 struct bch_fs *c = trans->c;
506 u64 min, max, start, pos, *hint;
508 unsigned bits = (c->opts.inodes_32bit ? 31 : 63);
510 if (c->opts.shard_inode_numbers) {
511 bits -= c->inode_shard_bits;
514 max = (cpu << bits) | ~(ULLONG_MAX << bits);
516 min = max_t(u64, min, BLOCKDEV_INODE_MAX);
517 hint = c->unused_inode_hints + cpu;
519 min = BLOCKDEV_INODE_MAX;
520 max = ~(ULLONG_MAX << bits);
521 hint = c->unused_inode_hints;
524 start = READ_ONCE(*hint);
526 if (start >= max || start < min)
530 bch2_trans_iter_init(trans, iter, BTREE_ID_inodes, POS(0, pos),
531 BTREE_ITER_ALL_SNAPSHOTS|
534 while ((k = bch2_btree_iter_peek(iter)).k &&
535 !(ret = bkey_err(k)) &&
536 bkey_cmp(k.k->p, POS(0, max)) < 0) {
537 while (pos < iter->pos.offset) {
538 if (!bch2_btree_key_cache_find(c, BTREE_ID_inodes, POS(0, pos)))
544 if (k.k->p.snapshot == snapshot &&
545 k.k->type != KEY_TYPE_inode &&
546 !bch2_btree_key_cache_find(c, BTREE_ID_inodes, SPOS(0, pos, snapshot))) {
547 bch2_btree_iter_advance(iter);
552 * We don't need to iterate over keys in every snapshot once
553 * we've found just one:
555 pos = iter->pos.offset + 1;
556 bch2_btree_iter_set_pos(iter, POS(0, pos));
559 while (!ret && pos < max) {
560 if (!bch2_btree_key_cache_find(c, BTREE_ID_inodes, POS(0, pos)))
566 if (!ret && start == min)
570 bch2_trans_iter_exit(trans, iter);
574 /* Retry from start */
576 bch2_btree_iter_set_pos(iter, POS(0, pos));
579 bch2_btree_iter_set_pos(iter, SPOS(0, pos, snapshot));
580 k = bch2_btree_iter_peek_slot(iter);
583 bch2_trans_iter_exit(trans, iter);
587 /* We may have raced while the iterator wasn't pointing at pos: */
588 if (k.k->type == KEY_TYPE_inode ||
589 bch2_btree_key_cache_find(c, BTREE_ID_inodes, k.k->p))
592 *hint = k.k->p.offset;
593 inode_u->bi_inum = k.k->p.offset;
594 inode_u->bi_generation = bkey_generation(k);
598 static int bch2_inode_delete_keys(struct btree_trans *trans,
599 subvol_inum inum, enum btree_id id)
604 while (!ret || ret == -EINTR) {
605 struct btree_iter iter;
607 struct bkey_i delete;
610 bch2_trans_begin(trans);
612 ret = bch2_subvolume_get_snapshot(trans, inum.subvol, &snapshot);
616 bch2_trans_iter_init(trans, &iter, id,
617 SPOS(inum.inum, offset, snapshot),
619 k = bch2_btree_iter_peek(&iter);
621 if (!k.k || iter.pos.inode != inum.inum) {
622 bch2_trans_iter_exit(trans, &iter);
630 bkey_init(&delete.k);
631 delete.k.p = iter.pos;
633 if (btree_node_type_is_extents(iter.btree_id)) {
634 unsigned max_sectors =
635 min_t(u64, U64_MAX - iter.pos.offset,
636 KEY_SIZE_MAX & (~0 << trans->c->block_bits));
638 /* create the biggest key we can */
639 bch2_key_resize(&delete.k, max_sectors);
641 ret = bch2_extent_trim_atomic(trans, &iter, &delete);
646 ret = bch2_trans_update(trans, &iter, &delete, 0) ?:
647 bch2_trans_commit(trans, NULL, NULL,
648 BTREE_INSERT_NOFAIL);
650 offset = iter.pos.offset;
651 bch2_trans_iter_exit(trans, &iter);
657 int bch2_inode_rm(struct bch_fs *c, subvol_inum inum, bool cached)
659 struct btree_trans trans;
660 struct btree_iter iter = { NULL };
661 struct bkey_i_inode_generation delete;
662 struct bch_inode_unpacked inode_u;
664 unsigned iter_flags = BTREE_ITER_INTENT;
668 if (0 && cached && c->opts.inodes_use_key_cache)
669 iter_flags |= BTREE_ITER_CACHED;
671 bch2_trans_init(&trans, c, 0, 1024);
674 * If this was a directory, there shouldn't be any real dirents left -
675 * but there could be whiteouts (from hash collisions) that we should
678 * XXX: the dirent could ideally would delete whiteouts when they're no
681 ret = bch2_inode_delete_keys(&trans, inum, BTREE_ID_extents) ?:
682 bch2_inode_delete_keys(&trans, inum, BTREE_ID_xattrs) ?:
683 bch2_inode_delete_keys(&trans, inum, BTREE_ID_dirents);
687 bch2_trans_begin(&trans);
689 ret = bch2_subvolume_get_snapshot(&trans, inum.subvol, &snapshot);
693 bch2_trans_iter_init(&trans, &iter, BTREE_ID_inodes,
694 SPOS(0, inum.inum, snapshot), iter_flags);
695 k = bch2_btree_iter_peek_slot(&iter);
701 if (k.k->type != KEY_TYPE_inode) {
702 bch2_fs_inconsistent(trans.c,
703 "inode %llu not found when deleting",
709 bch2_inode_unpack(bkey_s_c_to_inode(k), &inode_u);
711 /* Subvolume root? */
712 if (inode_u.bi_subvol) {
713 ret = bch2_subvolume_delete(&trans, inode_u.bi_subvol, -1);
718 bkey_inode_generation_init(&delete.k_i);
719 delete.k.p = iter.pos;
720 delete.v.bi_generation = cpu_to_le32(inode_u.bi_generation + 1);
722 ret = bch2_trans_update(&trans, &iter, &delete.k_i, 0) ?:
723 bch2_trans_commit(&trans, NULL, NULL,
724 BTREE_INSERT_NOFAIL);
726 bch2_trans_iter_exit(&trans, &iter);
730 bch2_trans_exit(&trans);
734 static int bch2_inode_find_by_inum_trans(struct btree_trans *trans,
736 struct bch_inode_unpacked *inode)
738 struct btree_iter iter;
741 ret = bch2_inode_peek(trans, &iter, inode, inum, 0);
743 bch2_trans_iter_exit(trans, &iter);
747 int bch2_inode_find_by_inum(struct bch_fs *c, subvol_inum inum,
748 struct bch_inode_unpacked *inode)
750 return bch2_trans_do(c, NULL, NULL, 0,
751 bch2_inode_find_by_inum_trans(&trans, inum, inode));