]> git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/inode.c
Update bcachefs sources to d1fd471830 bcachefs: Add more debug checks
[bcachefs-tools-debian] / libbcachefs / inode.c
1 // SPDX-License-Identifier: GPL-2.0
2
3 #include "bcachefs.h"
4 #include "btree_key_cache.h"
5 #include "bkey_methods.h"
6 #include "btree_update.h"
7 #include "error.h"
8 #include "extents.h"
9 #include "inode.h"
10 #include "str_hash.h"
11 #include "varint.h"
12
13 #include <linux/random.h>
14
15 #include <asm/unaligned.h>
16
17 const char * const bch2_inode_opts[] = {
18 #define x(name, ...)    #name,
19         BCH_INODE_OPTS()
20 #undef  x
21         NULL,
22 };
23
24 static const u8 byte_table[8] = { 1, 2, 3, 4, 6, 8, 10, 13 };
25 static const u8 bits_table[8] = {
26         1  * 8 - 1,
27         2  * 8 - 2,
28         3  * 8 - 3,
29         4  * 8 - 4,
30         6  * 8 - 5,
31         8  * 8 - 6,
32         10 * 8 - 7,
33         13 * 8 - 8,
34 };
35
36 static int inode_encode_field(u8 *out, u8 *end, u64 hi, u64 lo)
37 {
38         __be64 in[2] = { cpu_to_be64(hi), cpu_to_be64(lo), };
39         unsigned shift, bytes, bits = likely(!hi)
40                 ? fls64(lo)
41                 : fls64(hi) + 64;
42
43         for (shift = 1; shift <= 8; shift++)
44                 if (bits < bits_table[shift - 1])
45                         goto got_shift;
46
47         BUG();
48 got_shift:
49         bytes = byte_table[shift - 1];
50
51         BUG_ON(out + bytes > end);
52
53         memcpy(out, (u8 *) in + 16 - bytes, bytes);
54         *out |= (1 << 8) >> shift;
55
56         return bytes;
57 }
58
59 static int inode_decode_field(const u8 *in, const u8 *end,
60                               u64 out[2], unsigned *out_bits)
61 {
62         __be64 be[2] = { 0, 0 };
63         unsigned bytes, shift;
64         u8 *p;
65
66         if (in >= end)
67                 return -1;
68
69         if (!*in)
70                 return -1;
71
72         /*
73          * position of highest set bit indicates number of bytes:
74          * shift = number of bits to remove in high byte:
75          */
76         shift   = 8 - __fls(*in); /* 1 <= shift <= 8 */
77         bytes   = byte_table[shift - 1];
78
79         if (in + bytes > end)
80                 return -1;
81
82         p = (u8 *) be + 16 - bytes;
83         memcpy(p, in, bytes);
84         *p ^= (1 << 8) >> shift;
85
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]);
89
90         return bytes;
91 }
92
93 static noinline void bch2_inode_pack_v1(struct bkey_inode_buf *packed,
94                                         const struct bch_inode_unpacked *inode)
95 {
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;
101         unsigned bytes;
102
103 #define x(_name, _bits)                                                 \
104         out += inode_encode_field(out, end, 0, inode->_name);           \
105         nr_fields++;                                                    \
106                                                                         \
107         if (inode->_name) {                                             \
108                 last_nonzero_field = out;                               \
109                 last_nonzero_fieldnr = nr_fields;                       \
110         }
111
112         BCH_INODE_FIELDS()
113 #undef  x
114
115         out = last_nonzero_field;
116         nr_fields = last_nonzero_fieldnr;
117
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);
121
122         SET_INODE_NR_FIELDS(&k->v, nr_fields);
123 }
124
125 static void bch2_inode_pack_v2(struct bkey_inode_buf *packed,
126                                const struct bch_inode_unpacked *inode)
127 {
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;
133         unsigned bytes;
134         int ret;
135
136 #define x(_name, _bits)                                                 \
137         nr_fields++;                                                    \
138                                                                         \
139         if (inode->_name) {                                             \
140                 ret = bch2_varint_encode(out, inode->_name);            \
141                 out += ret;                                             \
142                                                                         \
143                 if (_bits > 64)                                         \
144                         *out++ = 0;                                     \
145                                                                         \
146                 last_nonzero_field = out;                               \
147                 last_nonzero_fieldnr = nr_fields;                       \
148         } else {                                                        \
149                 *out++ = 0;                                             \
150                                                                         \
151                 if (_bits > 64)                                         \
152                         *out++ = 0;                                     \
153         }
154
155         BCH_INODE_FIELDS()
156 #undef  x
157         BUG_ON(out > end);
158
159         out = last_nonzero_field;
160         nr_fields = last_nonzero_fieldnr;
161
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);
165
166         SET_INODE_NR_FIELDS(&k->v, nr_fields);
167 }
168
169 void bch2_inode_pack(struct bch_fs *c,
170                      struct bkey_inode_buf *packed,
171                      const struct bch_inode_unpacked *inode)
172 {
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);
178
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);
182         } else {
183                 bch2_inode_pack_v1(packed, inode);
184         }
185
186         if (IS_ENABLED(CONFIG_BCACHEFS_DEBUG)) {
187                 struct bch_inode_unpacked unpacked;
188
189                 int ret = bch2_inode_unpack(inode_i_to_s_c(&packed->inode),
190                                            &unpacked);
191                 BUG_ON(ret);
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);
195
196 #define x(_name, _bits) if (unpacked._name != inode->_name)             \
197                         panic("unpacked %llu should be %llu",           \
198                               (u64) unpacked._name, (u64) inode->_name);
199                 BCH_INODE_FIELDS()
200 #undef  x
201         }
202 }
203
204 static noinline int bch2_inode_unpack_v1(struct bkey_s_c_inode inode,
205                                 struct bch_inode_unpacked *unpacked)
206 {
207         const u8 *in = inode.v->fields;
208         const u8 *end = bkey_val_end(inode);
209         u64 field[2];
210         unsigned fieldnr = 0, field_bits;
211         int ret;
212
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));     \
218                 return 0;                                               \
219         }                                                               \
220                                                                         \
221         ret = inode_decode_field(in, end, field, &field_bits);          \
222         if (ret < 0)                                                    \
223                 return ret;                                             \
224                                                                         \
225         if (field_bits > sizeof(unpacked->_name) * 8)                   \
226                 return -1;                                              \
227                                                                         \
228         unpacked->_name = field[1];                                     \
229         in += ret;
230
231         BCH_INODE_FIELDS()
232 #undef  x
233
234         /* XXX: signal if there were more fields than expected? */
235         return 0;
236 }
237
238 static int bch2_inode_unpack_v2(struct bkey_s_c_inode inode,
239                                 struct bch_inode_unpacked *unpacked)
240 {
241         const u8 *in = inode.v->fields;
242         const u8 *end = bkey_val_end(inode);
243         unsigned fieldnr = 0;
244         int ret;
245         u64 v[2];
246
247 #define x(_name, _bits)                                                 \
248         if (fieldnr < INODE_NR_FIELDS(inode.v)) {                       \
249                 ret = bch2_varint_decode(in, end, &v[0]);               \
250                 if (ret < 0)                                            \
251                         return ret;                                     \
252                 in += ret;                                              \
253                                                                         \
254                 if (_bits > 64) {                                       \
255                         ret = bch2_varint_decode(in, end, &v[1]);       \
256                         if (ret < 0)                                    \
257                                 return ret;                             \
258                         in += ret;                                      \
259                 } else {                                                \
260                         v[1] = 0;                                       \
261                 }                                                       \
262         } else {                                                        \
263                 v[0] = v[1] = 0;                                        \
264         }                                                               \
265                                                                         \
266         unpacked->_name = v[0];                                         \
267         if (v[1] || v[0] != unpacked->_name)                            \
268                 return -1;                                              \
269         fieldnr++;
270
271         BCH_INODE_FIELDS()
272 #undef  x
273
274         /* XXX: signal if there were more fields than expected? */
275         return 0;
276 }
277
278 int bch2_inode_unpack(struct bkey_s_c_inode inode,
279                       struct bch_inode_unpacked *unpacked)
280 {
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);
285
286         if (INODE_NEW_VARINT(inode.v)) {
287                 return bch2_inode_unpack_v2(inode, unpacked);
288         } else {
289                 return bch2_inode_unpack_v1(inode, unpacked);
290         }
291
292         return 0;
293 }
294
295 struct btree_iter *bch2_inode_peek(struct btree_trans *trans,
296                                    struct bch_inode_unpacked *inode,
297                                    u64 inum, unsigned flags)
298 {
299         struct btree_iter *iter;
300         struct bkey_s_c k;
301         int ret;
302
303         iter = bch2_trans_get_iter(trans, BTREE_ID_INODES, POS(0, inum),
304                                    BTREE_ITER_CACHED|flags);
305         if (IS_ERR(iter))
306                 return iter;
307
308         k = bch2_btree_iter_peek_cached(iter);
309         ret = bkey_err(k);
310         if (ret)
311                 goto err;
312
313         ret = k.k->type == KEY_TYPE_inode ? 0 : -EIO;
314         if (ret)
315                 goto err;
316
317         ret = bch2_inode_unpack(bkey_s_c_to_inode(k), inode);
318         if (ret)
319                 goto err;
320
321         return iter;
322 err:
323         bch2_trans_iter_put(trans, iter);
324         return ERR_PTR(ret);
325 }
326
327 int bch2_inode_write(struct btree_trans *trans,
328                      struct btree_iter *iter,
329                      struct bch_inode_unpacked *inode)
330 {
331         struct bkey_inode_buf *inode_p;
332
333         inode_p = bch2_trans_kmalloc(trans, sizeof(*inode_p));
334         if (IS_ERR(inode_p))
335                 return PTR_ERR(inode_p);
336
337         bch2_inode_pack(trans->c, inode_p, inode);
338         bch2_trans_update(trans, iter, &inode_p->inode.k_i, 0);
339         return 0;
340 }
341
342 const char *bch2_inode_invalid(const struct bch_fs *c, struct bkey_s_c k)
343 {
344                 struct bkey_s_c_inode inode = bkey_s_c_to_inode(k);
345                 struct bch_inode_unpacked unpacked;
346
347         if (k.k->p.inode)
348                 return "nonzero k.p.inode";
349
350         if (bkey_val_bytes(k.k) < sizeof(struct bch_inode))
351                 return "incorrect value size";
352
353         if (k.k->p.offset < BLOCKDEV_INODE_MAX)
354                 return "fs inode in blockdev range";
355
356         if (INODE_STR_HASH(inode.v) >= BCH_STR_HASH_NR)
357                 return "invalid str hash type";
358
359         if (bch2_inode_unpack(inode, &unpacked))
360                 return "invalid variable length fields";
361
362         if (unpacked.bi_data_checksum >= BCH_CSUM_OPT_NR + 1)
363                 return "invalid data checksum type";
364
365         if (unpacked.bi_compression >= BCH_COMPRESSION_OPT_NR + 1)
366                 return "invalid data checksum type";
367
368         if ((unpacked.bi_flags & BCH_INODE_UNLINKED) &&
369             unpacked.bi_nlink != 0)
370                 return "flagged as unlinked but bi_nlink != 0";
371
372         return NULL;
373 }
374
375 void bch2_inode_to_text(struct printbuf *out, struct bch_fs *c,
376                        struct bkey_s_c k)
377 {
378         struct bkey_s_c_inode inode = bkey_s_c_to_inode(k);
379         struct bch_inode_unpacked unpacked;
380
381         if (bch2_inode_unpack(inode, &unpacked)) {
382                 pr_buf(out, "(unpack error)");
383                 return;
384         }
385
386         pr_buf(out, "mode: %o ", unpacked.bi_mode);
387
388 #define x(_name, _bits)                                         \
389         pr_buf(out, #_name ": %llu ", (u64) unpacked._name);
390         BCH_INODE_FIELDS()
391 #undef  x
392 }
393
394 const char *bch2_inode_generation_invalid(const struct bch_fs *c,
395                                           struct bkey_s_c k)
396 {
397         if (k.k->p.inode)
398                 return "nonzero k.p.inode";
399
400         if (bkey_val_bytes(k.k) != sizeof(struct bch_inode_generation))
401                 return "incorrect value size";
402
403         return NULL;
404 }
405
406 void bch2_inode_generation_to_text(struct printbuf *out, struct bch_fs *c,
407                                    struct bkey_s_c k)
408 {
409         struct bkey_s_c_inode_generation gen = bkey_s_c_to_inode_generation(k);
410
411         pr_buf(out, "generation: %u", le32_to_cpu(gen.v->bi_generation));
412 }
413
414 void bch2_inode_init_early(struct bch_fs *c,
415                            struct bch_inode_unpacked *inode_u)
416 {
417         enum bch_str_hash_type str_hash =
418                 bch2_str_hash_opt_to_type(c, c->opts.str_hash);
419
420         memset(inode_u, 0, sizeof(*inode_u));
421
422         /* ick */
423         inode_u->bi_flags |= str_hash << INODE_STR_HASH_OFFSET;
424         get_random_bytes(&inode_u->bi_hash_seed,
425                          sizeof(inode_u->bi_hash_seed));
426 }
427
428 void bch2_inode_init_late(struct bch_inode_unpacked *inode_u, u64 now,
429                           uid_t uid, gid_t gid, umode_t mode, dev_t rdev,
430                           struct bch_inode_unpacked *parent)
431 {
432         inode_u->bi_mode        = mode;
433         inode_u->bi_uid         = uid;
434         inode_u->bi_gid         = gid;
435         inode_u->bi_dev         = rdev;
436         inode_u->bi_atime       = now;
437         inode_u->bi_mtime       = now;
438         inode_u->bi_ctime       = now;
439         inode_u->bi_otime       = now;
440
441         if (parent && parent->bi_mode & S_ISGID) {
442                 inode_u->bi_gid = parent->bi_gid;
443                 if (S_ISDIR(mode))
444                         inode_u->bi_mode |= S_ISGID;
445         }
446
447         if (parent) {
448 #define x(_name, ...)   inode_u->bi_##_name = parent->bi_##_name;
449                 BCH_INODE_OPTS()
450 #undef x
451         }
452 }
453
454 void bch2_inode_init(struct bch_fs *c, struct bch_inode_unpacked *inode_u,
455                      uid_t uid, gid_t gid, umode_t mode, dev_t rdev,
456                      struct bch_inode_unpacked *parent)
457 {
458         bch2_inode_init_early(c, inode_u);
459         bch2_inode_init_late(inode_u, bch2_current_time(c),
460                              uid, gid, mode, rdev, parent);
461 }
462
463 static inline u32 bkey_generation(struct bkey_s_c k)
464 {
465         switch (k.k->type) {
466         case KEY_TYPE_inode:
467                 BUG();
468         case KEY_TYPE_inode_generation:
469                 return le32_to_cpu(bkey_s_c_to_inode_generation(k).v->bi_generation);
470         default:
471                 return 0;
472         }
473 }
474
475 int bch2_inode_create(struct btree_trans *trans,
476                       struct bch_inode_unpacked *inode_u)
477 {
478         struct bch_fs *c = trans->c;
479         struct bkey_inode_buf *inode_p;
480         struct btree_iter *iter = NULL;
481         struct bkey_s_c k;
482         u64 min, max, start, *hint;
483         int ret;
484
485         unsigned cpu = raw_smp_processor_id();
486         unsigned bits = (c->opts.inodes_32bit
487                 ? 31 : 63) - c->inode_shard_bits;
488
489         min = (cpu << bits);
490         max = (cpu << bits) | ~(ULLONG_MAX << bits);
491
492         min = max_t(u64, min, BLOCKDEV_INODE_MAX);
493         hint = c->unused_inode_hints + cpu;
494
495         start = READ_ONCE(*hint);
496
497         if (start >= max || start < min)
498                 start = min;
499
500         inode_p = bch2_trans_kmalloc(trans, sizeof(*inode_p));
501         if (IS_ERR(inode_p))
502                 return PTR_ERR(inode_p);
503 again:
504         for_each_btree_key(trans, iter, BTREE_ID_INODES, POS(0, start),
505                            BTREE_ITER_SLOTS|BTREE_ITER_INTENT, k, ret) {
506                 if (bkey_cmp(iter->pos, POS(0, max)) > 0)
507                         break;
508
509                 /*
510                  * There's a potential cache coherency issue with the btree key
511                  * cache code here - we're iterating over the btree, skipping
512                  * that cache. We should never see an empty slot that isn't
513                  * actually empty due to a pending update in the key cache
514                  * because the update that creates the inode isn't done with a
515                  * cached iterator, but - better safe than sorry, check the
516                  * cache before using a slot:
517                  */
518                 if (k.k->type != KEY_TYPE_inode &&
519                     !bch2_btree_key_cache_find(c, BTREE_ID_INODES, iter->pos))
520                         goto found_slot;
521         }
522
523         bch2_trans_iter_put(trans, iter);
524
525         if (ret)
526                 return ret;
527
528         if (start != min) {
529                 /* Retry from start */
530                 start = min;
531                 goto again;
532         }
533
534         return -ENOSPC;
535 found_slot:
536         *hint                   = k.k->p.offset;
537         inode_u->bi_inum        = k.k->p.offset;
538         inode_u->bi_generation  = bkey_generation(k);
539
540         ret = bch2_inode_write(trans, iter, inode_u);
541         bch2_trans_iter_put(trans, iter);
542         return ret;
543 }
544
545 int bch2_inode_rm(struct bch_fs *c, u64 inode_nr)
546 {
547         struct btree_trans trans;
548         struct btree_iter *iter;
549         struct bkey_i_inode_generation delete;
550         struct bpos start = POS(inode_nr, 0);
551         struct bpos end = POS(inode_nr + 1, 0);
552         struct bkey_s_c k;
553         u64 bi_generation;
554         int ret;
555
556         /*
557          * If this was a directory, there shouldn't be any real dirents left -
558          * but there could be whiteouts (from hash collisions) that we should
559          * delete:
560          *
561          * XXX: the dirent could ideally would delete whiteouts when they're no
562          * longer needed
563          */
564         ret   = bch2_btree_delete_range(c, BTREE_ID_EXTENTS,
565                                         start, end, NULL) ?:
566                 bch2_btree_delete_range(c, BTREE_ID_XATTRS,
567                                         start, end, NULL) ?:
568                 bch2_btree_delete_range(c, BTREE_ID_DIRENTS,
569                                         start, end, NULL);
570         if (ret)
571                 return ret;
572
573         bch2_trans_init(&trans, c, 0, 0);
574 retry:
575         bch2_trans_begin(&trans);
576
577         bi_generation = 0;
578
579         iter = bch2_trans_get_iter(&trans, BTREE_ID_INODES, POS(0, inode_nr),
580                                    BTREE_ITER_CACHED|BTREE_ITER_INTENT);
581         k = bch2_btree_iter_peek_cached(iter);
582
583         ret = bkey_err(k);
584         if (ret)
585                 goto err;
586
587         bch2_fs_inconsistent_on(k.k->type != KEY_TYPE_inode, c,
588                                 "inode %llu not found when deleting",
589                                 inode_nr);
590
591         switch (k.k->type) {
592         case KEY_TYPE_inode: {
593                 struct bch_inode_unpacked inode_u;
594
595                 if (!bch2_inode_unpack(bkey_s_c_to_inode(k), &inode_u))
596                         bi_generation = inode_u.bi_generation + 1;
597                 break;
598         }
599         case KEY_TYPE_inode_generation: {
600                 struct bkey_s_c_inode_generation g =
601                         bkey_s_c_to_inode_generation(k);
602                 bi_generation = le32_to_cpu(g.v->bi_generation);
603                 break;
604         }
605         }
606
607         if (!bi_generation) {
608                 bkey_init(&delete.k);
609                 delete.k.p.offset = inode_nr;
610         } else {
611                 bkey_inode_generation_init(&delete.k_i);
612                 delete.k.p.offset = inode_nr;
613                 delete.v.bi_generation = cpu_to_le32(bi_generation);
614         }
615
616         bch2_trans_update(&trans, iter, &delete.k_i, 0);
617
618         ret = bch2_trans_commit(&trans, NULL, NULL,
619                                 BTREE_INSERT_NOFAIL);
620 err:
621         if (ret == -EINTR)
622                 goto retry;
623
624         bch2_trans_exit(&trans);
625         return ret;
626 }
627
628 int bch2_inode_find_by_inum_trans(struct btree_trans *trans, u64 inode_nr,
629                                   struct bch_inode_unpacked *inode)
630 {
631         struct btree_iter *iter;
632         struct bkey_s_c k;
633         int ret;
634
635         iter = bch2_trans_get_iter(trans, BTREE_ID_INODES,
636                         POS(0, inode_nr), BTREE_ITER_CACHED);
637         if (IS_ERR(iter))
638                 return PTR_ERR(iter);
639
640         k = bch2_btree_iter_peek_cached(iter);
641         ret = bkey_err(k);
642         if (ret)
643                 goto err;
644
645         ret = k.k->type == KEY_TYPE_inode
646                 ? bch2_inode_unpack(bkey_s_c_to_inode(k), inode)
647                 : -ENOENT;
648 err:
649         bch2_trans_iter_put(trans, iter);
650         return ret;
651 }
652
653 int bch2_inode_find_by_inum(struct bch_fs *c, u64 inode_nr,
654                             struct bch_inode_unpacked *inode)
655 {
656         return bch2_trans_do(c, NULL, NULL, 0,
657                 bch2_inode_find_by_inum_trans(&trans, inode_nr, inode));
658 }