1 // SPDX-License-Identifier: GPL-2.0
4 #include "btree_key_cache.h"
5 #include "bkey_methods.h"
6 #include "btree_update.h"
13 #include <linux/random.h>
15 #include <asm/unaligned.h>
17 const char * const bch2_inode_opts[] = {
18 #define x(name, ...) #name,
24 static const u8 byte_table[8] = { 1, 2, 3, 4, 6, 8, 10, 13 };
25 static const u8 bits_table[8] = {
36 static int inode_encode_field(u8 *out, u8 *end, u64 hi, u64 lo)
38 __be64 in[2] = { cpu_to_be64(hi), cpu_to_be64(lo), };
39 unsigned shift, bytes, bits = likely(!hi)
43 for (shift = 1; shift <= 8; shift++)
44 if (bits < bits_table[shift - 1])
49 bytes = byte_table[shift - 1];
51 BUG_ON(out + bytes > end);
53 memcpy(out, (u8 *) in + 16 - bytes, bytes);
54 *out |= (1 << 8) >> shift;
59 static int inode_decode_field(const u8 *in, const u8 *end,
60 u64 out[2], unsigned *out_bits)
62 __be64 be[2] = { 0, 0 };
63 unsigned bytes, shift;
73 * position of highest set bit indicates number of bytes:
74 * shift = number of bits to remove in high byte:
76 shift = 8 - __fls(*in); /* 1 <= shift <= 8 */
77 bytes = byte_table[shift - 1];
82 p = (u8 *) be + 16 - bytes;
84 *p ^= (1 << 8) >> shift;
86 out[0] = be64_to_cpu(be[0]);
87 out[1] = be64_to_cpu(be[1]);
88 *out_bits = out[0] ? 64 + fls64(out[0]) : fls64(out[1]);
93 static noinline void bch2_inode_pack_v1(struct bkey_inode_buf *packed,
94 const struct bch_inode_unpacked *inode)
96 struct bkey_i_inode *k = &packed->inode;
97 u8 *out = k->v.fields;
98 u8 *end = (void *) &packed[1];
99 u8 *last_nonzero_field = out;
100 unsigned nr_fields = 0, last_nonzero_fieldnr = 0;
103 #define x(_name, _bits) \
104 out += inode_encode_field(out, end, 0, inode->_name); \
107 if (inode->_name) { \
108 last_nonzero_field = out; \
109 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_INODE_NR_FIELDS(&k->v, nr_fields);
125 static void bch2_inode_pack_v2(struct bkey_inode_buf *packed,
126 const struct bch_inode_unpacked *inode)
128 struct bkey_i_inode *k = &packed->inode;
129 u8 *out = k->v.fields;
130 u8 *end = (void *) &packed[1];
131 u8 *last_nonzero_field = out;
132 unsigned nr_fields = 0, last_nonzero_fieldnr = 0;
136 #define x(_name, _bits) \
139 if (inode->_name) { \
140 ret = bch2_varint_encode(out, inode->_name); \
146 last_nonzero_field = out; \
147 last_nonzero_fieldnr = nr_fields; \
159 out = last_nonzero_field;
160 nr_fields = last_nonzero_fieldnr;
162 bytes = out - (u8 *) &packed->inode.v;
163 set_bkey_val_bytes(&packed->inode.k, bytes);
164 memset_u64s_tail(&packed->inode.v, 0, bytes);
166 SET_INODE_NR_FIELDS(&k->v, nr_fields);
169 void bch2_inode_pack(struct bch_fs *c,
170 struct bkey_inode_buf *packed,
171 const struct bch_inode_unpacked *inode)
173 bkey_inode_init(&packed->inode.k_i);
174 packed->inode.k.p.offset = inode->bi_inum;
175 packed->inode.v.bi_hash_seed = inode->bi_hash_seed;
176 packed->inode.v.bi_flags = cpu_to_le32(inode->bi_flags);
177 packed->inode.v.bi_mode = cpu_to_le16(inode->bi_mode);
179 if (c->sb.features & (1ULL << BCH_FEATURE_new_varint)) {
180 SET_INODE_NEW_VARINT(&packed->inode.v, true);
181 bch2_inode_pack_v2(packed, inode);
183 bch2_inode_pack_v1(packed, inode);
186 if (IS_ENABLED(CONFIG_BCACHEFS_DEBUG)) {
187 struct bch_inode_unpacked unpacked;
189 int ret = bch2_inode_unpack(inode_i_to_s_c(&packed->inode),
192 BUG_ON(unpacked.bi_inum != inode->bi_inum);
193 BUG_ON(unpacked.bi_hash_seed != inode->bi_hash_seed);
194 BUG_ON(unpacked.bi_mode != inode->bi_mode);
196 #define x(_name, _bits) if (unpacked._name != inode->_name) \
197 panic("unpacked %llu should be %llu", \
198 (u64) unpacked._name, (u64) inode->_name);
204 static noinline int bch2_inode_unpack_v1(struct bkey_s_c_inode inode,
205 struct bch_inode_unpacked *unpacked)
207 const u8 *in = inode.v->fields;
208 const u8 *end = bkey_val_end(inode);
210 unsigned fieldnr = 0, field_bits;
213 #define x(_name, _bits) \
214 if (fieldnr++ == INODE_NR_FIELDS(inode.v)) { \
215 memset(&unpacked->_name, 0, \
216 sizeof(*unpacked) - \
217 offsetof(struct bch_inode_unpacked, _name)); \
221 ret = inode_decode_field(in, end, field, &field_bits); \
225 if (field_bits > sizeof(unpacked->_name) * 8) \
228 unpacked->_name = field[1]; \
234 /* XXX: signal if there were more fields than expected? */
238 static int bch2_inode_unpack_v2(struct bkey_s_c_inode inode,
239 struct bch_inode_unpacked *unpacked)
241 const u8 *in = inode.v->fields;
242 const u8 *end = bkey_val_end(inode);
243 unsigned fieldnr = 0;
247 #define x(_name, _bits) \
248 if (fieldnr < INODE_NR_FIELDS(inode.v)) { \
249 ret = bch2_varint_decode(in, end, &v[0]); \
255 ret = bch2_varint_decode(in, end, &v[1]); \
266 unpacked->_name = v[0]; \
267 if (v[1] || v[0] != unpacked->_name) \
274 /* XXX: signal if there were more fields than expected? */
278 int bch2_inode_unpack(struct bkey_s_c_inode inode,
279 struct bch_inode_unpacked *unpacked)
281 unpacked->bi_inum = inode.k->p.offset;
282 unpacked->bi_hash_seed = inode.v->bi_hash_seed;
283 unpacked->bi_flags = le32_to_cpu(inode.v->bi_flags);
284 unpacked->bi_mode = le16_to_cpu(inode.v->bi_mode);
286 if (INODE_NEW_VARINT(inode.v)) {
287 return bch2_inode_unpack_v2(inode, unpacked);
289 return bch2_inode_unpack_v1(inode, unpacked);
295 struct btree_iter *bch2_inode_peek(struct btree_trans *trans,
296 struct bch_inode_unpacked *inode,
297 u64 inum, unsigned flags)
299 struct btree_iter *iter;
303 iter = bch2_trans_get_iter(trans, BTREE_ID_INODES, POS(0, inum),
304 BTREE_ITER_CACHED|flags);
305 k = bch2_btree_iter_peek_cached(iter);
310 ret = k.k->type == KEY_TYPE_inode ? 0 : -EIO;
314 ret = bch2_inode_unpack(bkey_s_c_to_inode(k), inode);
320 bch2_trans_iter_put(trans, iter);
324 int bch2_inode_write(struct btree_trans *trans,
325 struct btree_iter *iter,
326 struct bch_inode_unpacked *inode)
328 struct bkey_inode_buf *inode_p;
330 inode_p = bch2_trans_kmalloc(trans, sizeof(*inode_p));
332 return PTR_ERR(inode_p);
334 bch2_inode_pack(trans->c, inode_p, inode);
335 bch2_trans_update(trans, iter, &inode_p->inode.k_i, 0);
339 const char *bch2_inode_invalid(const struct bch_fs *c, struct bkey_s_c k)
341 struct bkey_s_c_inode inode = bkey_s_c_to_inode(k);
342 struct bch_inode_unpacked unpacked;
345 return "nonzero k.p.inode";
347 if (bkey_val_bytes(k.k) < sizeof(struct bch_inode))
348 return "incorrect value size";
350 if (k.k->p.offset < BLOCKDEV_INODE_MAX)
351 return "fs inode in blockdev range";
353 if (INODE_STR_HASH(inode.v) >= BCH_STR_HASH_NR)
354 return "invalid str hash type";
356 if (bch2_inode_unpack(inode, &unpacked))
357 return "invalid variable length fields";
359 if (unpacked.bi_data_checksum >= BCH_CSUM_OPT_NR + 1)
360 return "invalid data checksum type";
362 if (unpacked.bi_compression >= BCH_COMPRESSION_OPT_NR + 1)
363 return "invalid data checksum type";
365 if ((unpacked.bi_flags & BCH_INODE_UNLINKED) &&
366 unpacked.bi_nlink != 0)
367 return "flagged as unlinked but bi_nlink != 0";
372 void bch2_inode_to_text(struct printbuf *out, struct bch_fs *c,
375 struct bkey_s_c_inode inode = bkey_s_c_to_inode(k);
376 struct bch_inode_unpacked unpacked;
378 if (bch2_inode_unpack(inode, &unpacked)) {
379 pr_buf(out, "(unpack error)");
383 pr_buf(out, "mode: %o ", unpacked.bi_mode);
385 #define x(_name, _bits) \
386 pr_buf(out, #_name ": %llu ", (u64) unpacked._name);
391 const char *bch2_inode_generation_invalid(const struct bch_fs *c,
395 return "nonzero k.p.inode";
397 if (bkey_val_bytes(k.k) != sizeof(struct bch_inode_generation))
398 return "incorrect value size";
403 void bch2_inode_generation_to_text(struct printbuf *out, struct bch_fs *c,
406 struct bkey_s_c_inode_generation gen = bkey_s_c_to_inode_generation(k);
408 pr_buf(out, "generation: %u", le32_to_cpu(gen.v->bi_generation));
411 void bch2_inode_init_early(struct bch_fs *c,
412 struct bch_inode_unpacked *inode_u)
414 enum bch_str_hash_type str_hash =
415 bch2_str_hash_opt_to_type(c, c->opts.str_hash);
417 memset(inode_u, 0, sizeof(*inode_u));
420 inode_u->bi_flags |= str_hash << INODE_STR_HASH_OFFSET;
421 get_random_bytes(&inode_u->bi_hash_seed,
422 sizeof(inode_u->bi_hash_seed));
425 void bch2_inode_init_late(struct bch_inode_unpacked *inode_u, u64 now,
426 uid_t uid, gid_t gid, umode_t mode, dev_t rdev,
427 struct bch_inode_unpacked *parent)
429 inode_u->bi_mode = mode;
430 inode_u->bi_uid = uid;
431 inode_u->bi_gid = gid;
432 inode_u->bi_dev = rdev;
433 inode_u->bi_atime = now;
434 inode_u->bi_mtime = now;
435 inode_u->bi_ctime = now;
436 inode_u->bi_otime = now;
438 if (parent && parent->bi_mode & S_ISGID) {
439 inode_u->bi_gid = parent->bi_gid;
441 inode_u->bi_mode |= S_ISGID;
445 #define x(_name, ...) inode_u->bi_##_name = parent->bi_##_name;
451 void bch2_inode_init(struct bch_fs *c, struct bch_inode_unpacked *inode_u,
452 uid_t uid, gid_t gid, umode_t mode, dev_t rdev,
453 struct bch_inode_unpacked *parent)
455 bch2_inode_init_early(c, inode_u);
456 bch2_inode_init_late(inode_u, bch2_current_time(c),
457 uid, gid, mode, rdev, parent);
460 static inline u32 bkey_generation(struct bkey_s_c k)
465 case KEY_TYPE_inode_generation:
466 return le32_to_cpu(bkey_s_c_to_inode_generation(k).v->bi_generation);
472 int bch2_inode_create(struct btree_trans *trans,
473 struct bch_inode_unpacked *inode_u)
475 struct bch_fs *c = trans->c;
476 struct bkey_inode_buf *inode_p;
477 struct btree_iter *iter = NULL;
479 u64 min, max, start, *hint;
482 u64 cpu = raw_smp_processor_id();
483 unsigned bits = (c->opts.inodes_32bit
484 ? 31 : 63) - c->inode_shard_bits;
487 max = (cpu << bits) | ~(ULLONG_MAX << bits);
489 min = max_t(u64, min, BLOCKDEV_INODE_MAX);
490 hint = c->unused_inode_hints + cpu;
492 start = READ_ONCE(*hint);
494 if (start >= max || start < min)
497 inode_p = bch2_trans_kmalloc(trans, sizeof(*inode_p));
499 return PTR_ERR(inode_p);
501 for_each_btree_key(trans, iter, BTREE_ID_INODES, POS(0, start),
502 BTREE_ITER_SLOTS|BTREE_ITER_INTENT, k, ret) {
503 if (bkey_cmp(iter->pos, POS(0, max)) > 0)
507 * There's a potential cache coherency issue with the btree key
508 * cache code here - we're iterating over the btree, skipping
509 * that cache. We should never see an empty slot that isn't
510 * actually empty due to a pending update in the key cache
511 * because the update that creates the inode isn't done with a
512 * cached iterator, but - better safe than sorry, check the
513 * cache before using a slot:
515 if (k.k->type != KEY_TYPE_inode &&
516 !bch2_btree_key_cache_find(c, BTREE_ID_INODES, iter->pos))
520 bch2_trans_iter_put(trans, iter);
526 /* Retry from start */
533 *hint = k.k->p.offset;
534 inode_u->bi_inum = k.k->p.offset;
535 inode_u->bi_generation = bkey_generation(k);
537 ret = bch2_inode_write(trans, iter, inode_u);
538 bch2_trans_iter_put(trans, iter);
542 int bch2_inode_rm(struct bch_fs *c, u64 inode_nr, bool cached)
544 struct btree_trans trans;
545 struct btree_iter *iter;
546 struct bkey_i_inode_generation delete;
547 struct bpos start = POS(inode_nr, 0);
548 struct bpos end = POS(inode_nr + 1, 0);
553 bch2_trans_init(&trans, c, 0, 0);
556 * If this was a directory, there shouldn't be any real dirents left -
557 * but there could be whiteouts (from hash collisions) that we should
560 * XXX: the dirent could ideally would delete whiteouts when they're no
563 ret = bch2_btree_delete_range_trans(&trans, BTREE_ID_EXTENTS,
565 bch2_btree_delete_range_trans(&trans, BTREE_ID_XATTRS,
567 bch2_btree_delete_range_trans(&trans, BTREE_ID_DIRENTS,
572 bch2_trans_begin(&trans);
577 iter = bch2_trans_get_iter(&trans, BTREE_ID_INODES, POS(0, inode_nr),
578 BTREE_ITER_CACHED|BTREE_ITER_INTENT);
579 k = bch2_btree_iter_peek_cached(iter);
581 iter = bch2_trans_get_iter(&trans, BTREE_ID_INODES, POS(0, inode_nr),
582 BTREE_ITER_SLOTS|BTREE_ITER_INTENT);
583 k = bch2_btree_iter_peek_slot(iter);
590 bch2_fs_inconsistent_on(k.k->type != KEY_TYPE_inode, trans.c,
591 "inode %llu not found when deleting",
595 case KEY_TYPE_inode: {
596 struct bch_inode_unpacked inode_u;
598 if (!bch2_inode_unpack(bkey_s_c_to_inode(k), &inode_u))
599 bi_generation = inode_u.bi_generation + 1;
602 case KEY_TYPE_inode_generation: {
603 struct bkey_s_c_inode_generation g =
604 bkey_s_c_to_inode_generation(k);
605 bi_generation = le32_to_cpu(g.v->bi_generation);
610 if (!bi_generation) {
611 bkey_init(&delete.k);
612 delete.k.p.offset = inode_nr;
614 bkey_inode_generation_init(&delete.k_i);
615 delete.k.p.offset = inode_nr;
616 delete.v.bi_generation = cpu_to_le32(bi_generation);
619 bch2_trans_update(&trans, iter, &delete.k_i, 0);
621 ret = bch2_trans_commit(&trans, NULL, NULL,
622 BTREE_INSERT_NOFAIL);
627 bch2_trans_exit(&trans);
631 int bch2_inode_find_by_inum_trans(struct btree_trans *trans, u64 inode_nr,
632 struct bch_inode_unpacked *inode)
634 struct btree_iter *iter;
638 iter = bch2_trans_get_iter(trans, BTREE_ID_INODES,
639 POS(0, inode_nr), BTREE_ITER_CACHED);
640 k = bch2_btree_iter_peek_cached(iter);
645 ret = k.k->type == KEY_TYPE_inode
646 ? bch2_inode_unpack(bkey_s_c_to_inode(k), inode)
649 bch2_trans_iter_put(trans, iter);
653 int bch2_inode_find_by_inum(struct bch_fs *c, u64 inode_nr,
654 struct bch_inode_unpacked *inode)
656 return bch2_trans_do(c, NULL, NULL, 0,
657 bch2_inode_find_by_inum_trans(&trans, inode_nr, inode));