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_decode_field(const u8 *in, const u8 *end,
39 u64 out[2], unsigned *out_bits)
41 __be64 be[2] = { 0, 0 };
42 unsigned bytes, shift;
52 * position of highest set bit indicates number of bytes:
53 * shift = number of bits to remove in high byte:
55 shift = 8 - __fls(*in); /* 1 <= shift <= 8 */
56 bytes = byte_table[shift - 1];
61 p = (u8 *) be + 16 - bytes;
63 *p ^= (1 << 8) >> shift;
65 out[0] = be64_to_cpu(be[0]);
66 out[1] = be64_to_cpu(be[1]);
67 *out_bits = out[0] ? 64 + fls64(out[0]) : fls64(out[1]);
72 void bch2_inode_pack(struct bch_fs *c,
73 struct bkey_inode_buf *packed,
74 const struct bch_inode_unpacked *inode)
76 struct bkey_i_inode_v2 *k = &packed->inode;
77 u8 *out = k->v.fields;
78 u8 *end = (void *) &packed[1];
79 u8 *last_nonzero_field = out;
80 unsigned nr_fields = 0, last_nonzero_fieldnr = 0;
84 bkey_inode_v2_init(&packed->inode.k_i);
85 packed->inode.k.p.offset = inode->bi_inum;
86 packed->inode.v.bi_journal_seq = cpu_to_le64(inode->bi_journal_seq);
87 packed->inode.v.bi_hash_seed = inode->bi_hash_seed;
88 packed->inode.v.bi_flags = cpu_to_le64(inode->bi_flags);
89 packed->inode.v.bi_flags = cpu_to_le64(inode->bi_flags);
90 packed->inode.v.bi_mode = cpu_to_le16(inode->bi_mode);
92 #define x(_name, _bits) \
96 ret = bch2_varint_encode_fast(out, inode->_name); \
102 last_nonzero_field = out; \
103 last_nonzero_fieldnr = nr_fields; \
115 out = last_nonzero_field;
116 nr_fields = last_nonzero_fieldnr;
118 bytes = out - (u8 *) &packed->inode.v;
119 set_bkey_val_bytes(&packed->inode.k, bytes);
120 memset_u64s_tail(&packed->inode.v, 0, bytes);
122 SET_INODEv2_NR_FIELDS(&k->v, nr_fields);
124 if (IS_ENABLED(CONFIG_BCACHEFS_DEBUG)) {
125 struct bch_inode_unpacked unpacked;
127 int ret = bch2_inode_unpack(bkey_i_to_s_c(&packed->inode.k_i),
130 BUG_ON(unpacked.bi_inum != inode->bi_inum);
131 BUG_ON(unpacked.bi_hash_seed != inode->bi_hash_seed);
132 BUG_ON(unpacked.bi_mode != inode->bi_mode);
134 #define x(_name, _bits) if (unpacked._name != inode->_name) \
135 panic("unpacked %llu should be %llu", \
136 (u64) unpacked._name, (u64) inode->_name);
142 static noinline int bch2_inode_unpack_v1(struct bkey_s_c_inode inode,
143 struct bch_inode_unpacked *unpacked)
145 const u8 *in = inode.v->fields;
146 const u8 *end = bkey_val_end(inode);
148 unsigned fieldnr = 0, field_bits;
151 #define x(_name, _bits) \
152 if (fieldnr++ == INODE_NR_FIELDS(inode.v)) { \
153 memset(&unpacked->_name, 0, \
154 sizeof(*unpacked) - \
155 offsetof(struct bch_inode_unpacked, _name)); \
159 ret = inode_decode_field(in, end, field, &field_bits); \
163 if (field_bits > sizeof(unpacked->_name) * 8) \
166 unpacked->_name = field[1]; \
172 /* XXX: signal if there were more fields than expected? */
176 static int bch2_inode_unpack_v2(struct bch_inode_unpacked *unpacked,
177 const u8 *in, const u8 *end,
180 unsigned fieldnr = 0;
184 #define x(_name, _bits) \
185 if (fieldnr < nr_fields) { \
186 ret = bch2_varint_decode_fast(in, end, &v[0]); \
192 ret = bch2_varint_decode_fast(in, end, &v[1]); \
203 unpacked->_name = v[0]; \
204 if (v[1] || v[0] != unpacked->_name) \
211 /* XXX: signal if there were more fields than expected? */
215 int bch2_inode_unpack(struct bkey_s_c k,
216 struct bch_inode_unpacked *unpacked)
219 case KEY_TYPE_inode: {
220 struct bkey_s_c_inode inode = bkey_s_c_to_inode(k);
222 unpacked->bi_inum = inode.k->p.offset;
223 unpacked->bi_hash_seed = inode.v->bi_hash_seed;
224 unpacked->bi_flags = le32_to_cpu(inode.v->bi_flags);
225 unpacked->bi_mode = le16_to_cpu(inode.v->bi_mode);
227 if (INODE_NEW_VARINT(inode.v)) {
228 return bch2_inode_unpack_v2(unpacked, inode.v->fields,
230 INODE_NR_FIELDS(inode.v));
232 return bch2_inode_unpack_v1(inode, unpacked);
236 case KEY_TYPE_inode_v2: {
237 struct bkey_s_c_inode_v2 inode = bkey_s_c_to_inode_v2(k);
239 unpacked->bi_inum = inode.k->p.offset;
240 unpacked->bi_journal_seq= le64_to_cpu(inode.v->bi_journal_seq);
241 unpacked->bi_hash_seed = inode.v->bi_hash_seed;
242 unpacked->bi_flags = le64_to_cpu(inode.v->bi_flags);
243 unpacked->bi_mode = le16_to_cpu(inode.v->bi_mode);
245 return bch2_inode_unpack_v2(unpacked, inode.v->fields,
247 INODEv2_NR_FIELDS(inode.v));
254 int bch2_inode_peek(struct btree_trans *trans,
255 struct btree_iter *iter,
256 struct bch_inode_unpacked *inode,
257 subvol_inum inum, unsigned flags)
263 if (0 && trans->c->opts.inodes_use_key_cache)
264 flags |= BTREE_ITER_CACHED;
266 ret = bch2_subvolume_get_snapshot(trans, inum.subvol, &snapshot);
270 bch2_trans_iter_init(trans, iter, BTREE_ID_inodes,
271 SPOS(0, inum.inum, snapshot), flags);
272 k = bch2_btree_iter_peek_slot(iter);
277 ret = bkey_is_inode(k.k) ? 0 : -ENOENT;
281 ret = bch2_inode_unpack(k, inode);
287 bch2_trans_iter_exit(trans, iter);
291 int bch2_inode_write(struct btree_trans *trans,
292 struct btree_iter *iter,
293 struct bch_inode_unpacked *inode)
295 struct bkey_inode_buf *inode_p;
297 inode_p = bch2_trans_kmalloc(trans, sizeof(*inode_p));
299 return PTR_ERR(inode_p);
301 bch2_inode_pack(trans->c, inode_p, inode);
302 inode_p->inode.k.p.snapshot = iter->snapshot;
303 return bch2_trans_update(trans, iter, &inode_p->inode.k_i, 0);
306 const char *bch2_inode_invalid(const struct bch_fs *c, struct bkey_s_c k)
308 struct bkey_s_c_inode inode = bkey_s_c_to_inode(k);
309 struct bch_inode_unpacked unpacked;
312 return "nonzero k.p.inode";
314 if (bkey_val_bytes(k.k) < sizeof(struct bch_inode))
315 return "incorrect value size";
317 if (k.k->p.offset < BLOCKDEV_INODE_MAX)
318 return "fs inode in blockdev range";
320 if (INODE_STR_HASH(inode.v) >= BCH_STR_HASH_NR)
321 return "invalid str hash type";
323 if (bch2_inode_unpack(k, &unpacked))
324 return "invalid variable length fields";
326 if (unpacked.bi_data_checksum >= BCH_CSUM_OPT_NR + 1)
327 return "invalid data checksum type";
329 if (unpacked.bi_compression >= BCH_COMPRESSION_OPT_NR + 1)
330 return "invalid data checksum type";
332 if ((unpacked.bi_flags & BCH_INODE_UNLINKED) &&
333 unpacked.bi_nlink != 0)
334 return "flagged as unlinked but bi_nlink != 0";
336 if (unpacked.bi_subvol && !S_ISDIR(unpacked.bi_mode))
337 return "subvolume root but not a directory";
342 const char *bch2_inode_v2_invalid(const struct bch_fs *c, struct bkey_s_c k)
344 struct bkey_s_c_inode_v2 inode = bkey_s_c_to_inode_v2(k);
345 struct bch_inode_unpacked unpacked;
348 return "nonzero k.p.inode";
350 if (bkey_val_bytes(k.k) < sizeof(struct bch_inode))
351 return "incorrect value size";
353 if (k.k->p.offset < BLOCKDEV_INODE_MAX)
354 return "fs inode in blockdev range";
356 if (INODEv2_STR_HASH(inode.v) >= BCH_STR_HASH_NR)
357 return "invalid str hash type";
359 if (bch2_inode_unpack(k, &unpacked))
360 return "invalid variable length fields";
362 if (unpacked.bi_data_checksum >= BCH_CSUM_OPT_NR + 1)
363 return "invalid data checksum type";
365 if (unpacked.bi_compression >= BCH_COMPRESSION_OPT_NR + 1)
366 return "invalid data checksum type";
368 if ((unpacked.bi_flags & BCH_INODE_UNLINKED) &&
369 unpacked.bi_nlink != 0)
370 return "flagged as unlinked but bi_nlink != 0";
372 if (unpacked.bi_subvol && !S_ISDIR(unpacked.bi_mode))
373 return "subvolume root but not a directory";
378 static void __bch2_inode_unpacked_to_text(struct printbuf *out, struct bch_inode_unpacked *inode)
380 pr_buf(out, "mode %o flags %x journal_seq %llu",
381 inode->bi_mode, inode->bi_flags,
382 inode->bi_journal_seq);
384 #define x(_name, _bits) \
385 pr_buf(out, " "#_name " %llu", (u64) inode->_name);
390 void bch2_inode_unpacked_to_text(struct printbuf *out, struct bch_inode_unpacked *inode)
392 pr_buf(out, "inum: %llu ", inode->bi_inum);
393 __bch2_inode_unpacked_to_text(out, inode);
396 void bch2_inode_to_text(struct printbuf *out, struct bch_fs *c,
399 struct bch_inode_unpacked inode;
401 if (bch2_inode_unpack(k, &inode)) {
402 pr_buf(out, "(unpack error)");
406 __bch2_inode_unpacked_to_text(out, &inode);
409 const char *bch2_inode_generation_invalid(const struct bch_fs *c,
413 return "nonzero k.p.inode";
415 if (bkey_val_bytes(k.k) != sizeof(struct bch_inode_generation))
416 return "incorrect value size";
421 void bch2_inode_generation_to_text(struct printbuf *out, struct bch_fs *c,
424 struct bkey_s_c_inode_generation gen = bkey_s_c_to_inode_generation(k);
426 pr_buf(out, "generation: %u", le32_to_cpu(gen.v->bi_generation));
429 void bch2_inode_init_early(struct bch_fs *c,
430 struct bch_inode_unpacked *inode_u)
432 enum bch_str_hash_type str_hash =
433 bch2_str_hash_opt_to_type(c, c->opts.str_hash);
435 memset(inode_u, 0, sizeof(*inode_u));
438 inode_u->bi_flags |= str_hash << INODE_STR_HASH_OFFSET;
439 get_random_bytes(&inode_u->bi_hash_seed,
440 sizeof(inode_u->bi_hash_seed));
443 void bch2_inode_init_late(struct bch_inode_unpacked *inode_u, u64 now,
444 uid_t uid, gid_t gid, umode_t mode, dev_t rdev,
445 struct bch_inode_unpacked *parent)
447 inode_u->bi_mode = mode;
448 inode_u->bi_uid = uid;
449 inode_u->bi_gid = gid;
450 inode_u->bi_dev = rdev;
451 inode_u->bi_atime = now;
452 inode_u->bi_mtime = now;
453 inode_u->bi_ctime = now;
454 inode_u->bi_otime = now;
456 if (parent && parent->bi_mode & S_ISGID) {
457 inode_u->bi_gid = parent->bi_gid;
459 inode_u->bi_mode |= S_ISGID;
463 #define x(_name, ...) inode_u->bi_##_name = parent->bi_##_name;
469 void bch2_inode_init(struct bch_fs *c, struct bch_inode_unpacked *inode_u,
470 uid_t uid, gid_t gid, umode_t mode, dev_t rdev,
471 struct bch_inode_unpacked *parent)
473 bch2_inode_init_early(c, inode_u);
474 bch2_inode_init_late(inode_u, bch2_current_time(c),
475 uid, gid, mode, rdev, parent);
478 static inline u32 bkey_generation(struct bkey_s_c k)
482 case KEY_TYPE_inode_v2:
484 case KEY_TYPE_inode_generation:
485 return le32_to_cpu(bkey_s_c_to_inode_generation(k).v->bi_generation);
492 * This just finds an empty slot:
494 int bch2_inode_create(struct btree_trans *trans,
495 struct btree_iter *iter,
496 struct bch_inode_unpacked *inode_u,
497 u32 snapshot, u64 cpu)
499 struct bch_fs *c = trans->c;
501 u64 min, max, start, pos, *hint;
503 unsigned bits = (c->opts.inodes_32bit ? 31 : 63);
505 if (c->opts.shard_inode_numbers) {
506 bits -= c->inode_shard_bits;
509 max = (cpu << bits) | ~(ULLONG_MAX << bits);
511 min = max_t(u64, min, BLOCKDEV_INODE_MAX);
512 hint = c->unused_inode_hints + cpu;
514 min = BLOCKDEV_INODE_MAX;
515 max = ~(ULLONG_MAX << bits);
516 hint = c->unused_inode_hints;
519 start = READ_ONCE(*hint);
521 if (start >= max || start < min)
525 bch2_trans_iter_init(trans, iter, BTREE_ID_inodes, POS(0, pos),
526 BTREE_ITER_ALL_SNAPSHOTS|
529 while ((k = bch2_btree_iter_peek(iter)).k &&
530 !(ret = bkey_err(k)) &&
531 bkey_cmp(k.k->p, POS(0, max)) < 0) {
532 while (pos < iter->pos.offset) {
533 if (!bch2_btree_key_cache_find(c, BTREE_ID_inodes, POS(0, pos)))
539 if (k.k->p.snapshot == snapshot &&
540 !bkey_is_inode(k.k) &&
541 !bch2_btree_key_cache_find(c, BTREE_ID_inodes, SPOS(0, pos, snapshot))) {
542 bch2_btree_iter_advance(iter);
547 * We don't need to iterate over keys in every snapshot once
548 * we've found just one:
550 pos = iter->pos.offset + 1;
551 bch2_btree_iter_set_pos(iter, POS(0, pos));
554 while (!ret && pos < max) {
555 if (!bch2_btree_key_cache_find(c, BTREE_ID_inodes, POS(0, pos)))
561 if (!ret && start == min)
565 bch2_trans_iter_exit(trans, iter);
569 /* Retry from start */
571 bch2_btree_iter_set_pos(iter, POS(0, pos));
574 bch2_btree_iter_set_pos(iter, SPOS(0, pos, snapshot));
575 k = bch2_btree_iter_peek_slot(iter);
578 bch2_trans_iter_exit(trans, iter);
582 /* We may have raced while the iterator wasn't pointing at pos: */
583 if (bkey_is_inode(k.k) ||
584 bch2_btree_key_cache_find(c, BTREE_ID_inodes, k.k->p))
587 *hint = k.k->p.offset;
588 inode_u->bi_inum = k.k->p.offset;
589 inode_u->bi_generation = bkey_generation(k);
593 static int bch2_inode_delete_keys(struct btree_trans *trans,
594 subvol_inum inum, enum btree_id id)
599 while (!ret || ret == -EINTR) {
600 struct btree_iter iter;
602 struct bkey_i delete;
605 bch2_trans_begin(trans);
607 ret = bch2_subvolume_get_snapshot(trans, inum.subvol, &snapshot);
611 bch2_trans_iter_init(trans, &iter, id,
612 SPOS(inum.inum, offset, snapshot),
614 k = bch2_btree_iter_peek(&iter);
616 if (!k.k || iter.pos.inode != inum.inum) {
617 bch2_trans_iter_exit(trans, &iter);
625 bkey_init(&delete.k);
626 delete.k.p = iter.pos;
628 if (btree_node_type_is_extents(iter.btree_id)) {
629 unsigned max_sectors =
630 min_t(u64, U64_MAX - iter.pos.offset,
631 KEY_SIZE_MAX & (~0 << trans->c->block_bits));
633 /* create the biggest key we can */
634 bch2_key_resize(&delete.k, max_sectors);
636 ret = bch2_extent_trim_atomic(trans, &iter, &delete);
641 ret = bch2_trans_update(trans, &iter, &delete, 0) ?:
642 bch2_trans_commit(trans, NULL, NULL,
643 BTREE_INSERT_NOFAIL);
645 offset = iter.pos.offset;
646 bch2_trans_iter_exit(trans, &iter);
652 int bch2_inode_rm(struct bch_fs *c, subvol_inum inum, bool cached)
654 struct btree_trans trans;
655 struct btree_iter iter = { NULL };
656 struct bkey_i_inode_generation delete;
657 struct bch_inode_unpacked inode_u;
659 unsigned iter_flags = BTREE_ITER_INTENT;
663 if (0 && cached && c->opts.inodes_use_key_cache)
664 iter_flags |= BTREE_ITER_CACHED;
666 bch2_trans_init(&trans, c, 0, 1024);
669 * If this was a directory, there shouldn't be any real dirents left -
670 * but there could be whiteouts (from hash collisions) that we should
673 * XXX: the dirent could ideally would delete whiteouts when they're no
676 ret = bch2_inode_delete_keys(&trans, inum, BTREE_ID_extents) ?:
677 bch2_inode_delete_keys(&trans, inum, BTREE_ID_xattrs) ?:
678 bch2_inode_delete_keys(&trans, inum, BTREE_ID_dirents);
682 bch2_trans_begin(&trans);
684 ret = bch2_subvolume_get_snapshot(&trans, inum.subvol, &snapshot);
688 bch2_trans_iter_init(&trans, &iter, BTREE_ID_inodes,
689 SPOS(0, inum.inum, snapshot), iter_flags);
690 k = bch2_btree_iter_peek_slot(&iter);
696 if (!bkey_is_inode(k.k)) {
697 bch2_fs_inconsistent(trans.c,
698 "inode %llu not found when deleting",
704 bch2_inode_unpack(k, &inode_u);
706 /* Subvolume root? */
707 BUG_ON(inode_u.bi_subvol);
709 bkey_inode_generation_init(&delete.k_i);
710 delete.k.p = iter.pos;
711 delete.v.bi_generation = cpu_to_le32(inode_u.bi_generation + 1);
713 ret = bch2_trans_update(&trans, &iter, &delete.k_i, 0) ?:
714 bch2_trans_commit(&trans, NULL, NULL,
715 BTREE_INSERT_NOFAIL);
717 bch2_trans_iter_exit(&trans, &iter);
721 bch2_trans_exit(&trans);
725 static int bch2_inode_find_by_inum_trans(struct btree_trans *trans,
727 struct bch_inode_unpacked *inode)
729 struct btree_iter iter;
732 ret = bch2_inode_peek(trans, &iter, inode, inum, 0);
734 bch2_trans_iter_exit(trans, &iter);
738 int bch2_inode_find_by_inum(struct bch_fs *c, subvol_inum inum,
739 struct bch_inode_unpacked *inode)
741 return bch2_trans_do(c, NULL, NULL, 0,
742 bch2_inode_find_by_inum_trans(&trans, inum, inode));