git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/inode.c

   1
   2 #include "bcachefs.h"
   3 #include "bkey_methods.h"
   4 #include "btree_update.h"
   5 #include "error.h"
   6 #include "extents.h"
   7 #include "inode.h"
   8 #include "io.h"
   9 #include "keylist.h"
  10
  11 #include <linux/random.h>
  12
  13 #include <asm/unaligned.h>
  14
  15 #define FIELD_BYTES()                                           \
  16
  17 static const u8 byte_table[8] = { 1, 2, 3, 4, 6, 8, 10, 13 };
  18 static const u8 bits_table[8] = {
  19         1  * 8 - 1,
  20         2  * 8 - 2,
  21         3  * 8 - 3,
  22         4  * 8 - 4,
  23         6  * 8 - 5,
  24         8  * 8 - 6,
  25         10 * 8 - 7,
  26         13 * 8 - 8,
  27 };
  28
  29 static int inode_encode_field(u8 *out, u8 *end, u64 hi, u64 lo)
  30 {
  31         __be64 in[2] = { cpu_to_be64(hi), cpu_to_be64(lo), };
  32         unsigned shift, bytes, bits = likely(!hi)
  33                 ? fls64(lo)
  34                 : fls64(hi) + 64;
  35
  36         for (shift = 1; shift <= 8; shift++)
  37                 if (bits < bits_table[shift - 1])
  38                         goto got_shift;
  39
  40         BUG();
  41 got_shift:
  42         bytes = byte_table[shift - 1];
  43
  44         BUG_ON(out + bytes > end);
  45
  46         memcpy(out, (u8 *) in + 16 - bytes, bytes);
  47         *out |= (1 << 8) >> shift;
  48
  49         return bytes;
  50 }
  51
  52 static int inode_decode_field(const u8 *in, const u8 *end,
  53                               u64 out[2], unsigned *out_bits)
  54 {
  55         __be64 be[2] = { 0, 0 };
  56         unsigned bytes, shift;
  57         u8 *p;
  58
  59         if (in >= end)
  60                 return -1;
  61
  62         if (!*in)
  63                 return -1;
  64
  65         /*
  66          * position of highest set bit indicates number of bytes:
  67          * shift = number of bits to remove in high byte:
  68          */
  69         shift   = 8 - __fls(*in); /* 1 <= shift <= 8 */
  70         bytes   = byte_table[shift - 1];
  71
  72         if (in + bytes > end)
  73                 return -1;
  74
  75         p = (u8 *) be + 16 - bytes;
  76         memcpy(p, in, bytes);
  77         *p ^= (1 << 8) >> shift;
  78
  79         out[0] = be64_to_cpu(be[0]);
  80         out[1] = be64_to_cpu(be[1]);
  81         *out_bits = out[0] ? 64 + fls64(out[0]) : fls64(out[1]);
  82
  83         return bytes;
  84 }
  85
  86 void bch2_inode_pack(struct bkey_inode_buf *packed,
  87                      const struct bch_inode_unpacked *inode)
  88 {
  89         u8 *out = packed->inode.v.fields;
  90         u8 *end = (void *) &packed[1];
  91         u8 *last_nonzero_field = out;
  92         unsigned nr_fields = 0, last_nonzero_fieldnr = 0;
  93
  94         bkey_inode_init(&packed->inode.k_i);
  95         packed->inode.k.p.inode         = inode->bi_inum;
  96         packed->inode.v.bi_hash_seed    = inode->bi_hash_seed;
  97         packed->inode.v.bi_flags        = cpu_to_le32(inode->bi_flags);
  98         packed->inode.v.bi_mode         = cpu_to_le16(inode->bi_mode);
  99
 100 #define BCH_INODE_FIELD(_name, _bits)                                   \
 101         out += inode_encode_field(out, end, 0, inode->_name);           \
 102         nr_fields++;                                                    \
 103                                                                         \
 104         if (inode->_name) {                                             \
 105                 last_nonzero_field = out;                               \
 106                 last_nonzero_fieldnr = nr_fields;                       \
 107         }
 108
 109         BCH_INODE_FIELDS()
 110 #undef  BCH_INODE_FIELD
 111
 112         out = last_nonzero_field;
 113         nr_fields = last_nonzero_fieldnr;
 114
 115         set_bkey_val_bytes(&packed->inode.k, out - (u8 *) &packed->inode.v);
 116         memset(out, 0,
 117                (u8 *) &packed->inode.v +
 118                bkey_val_bytes(&packed->inode.k) - out);
 119
 120         SET_INODE_NR_FIELDS(&packed->inode.v, nr_fields);
 121
 122         if (IS_ENABLED(CONFIG_BCACHEFS_DEBUG)) {
 123                 struct bch_inode_unpacked unpacked;
 124
 125                 int ret = bch2_inode_unpack(inode_i_to_s_c(&packed->inode),
 126                                            &unpacked);
 127                 BUG_ON(ret);
 128                 BUG_ON(unpacked.bi_inum         != inode->bi_inum);
 129                 BUG_ON(unpacked.bi_hash_seed    != inode->bi_hash_seed);
 130                 BUG_ON(unpacked.bi_mode         != inode->bi_mode);
 131
 132 #define BCH_INODE_FIELD(_name, _bits)   BUG_ON(unpacked._name != inode->_name);
 133                 BCH_INODE_FIELDS()
 134 #undef  BCH_INODE_FIELD
 135         }
 136 }
 137
 138 int bch2_inode_unpack(struct bkey_s_c_inode inode,
 139                       struct bch_inode_unpacked *unpacked)
 140 {
 141         const u8 *in = inode.v->fields;
 142         const u8 *end = (void *) inode.v + bkey_val_bytes(inode.k);
 143         u64 field[2];
 144         unsigned fieldnr = 0, field_bits;
 145         int ret;
 146
 147         unpacked->bi_inum       = inode.k->p.inode;
 148         unpacked->bi_hash_seed  = inode.v->bi_hash_seed;
 149         unpacked->bi_flags      = le32_to_cpu(inode.v->bi_flags);
 150         unpacked->bi_mode       = le16_to_cpu(inode.v->bi_mode);
 151
 152 #define BCH_INODE_FIELD(_name, _bits)                                   \
 153         if (fieldnr++ == INODE_NR_FIELDS(inode.v)) {                    \
 154                 memset(&unpacked->_name, 0,                             \
 155                        sizeof(*unpacked) -                              \
 156                        offsetof(struct bch_inode_unpacked, _name));     \
 157                 return 0;                                               \
 158         }                                                               \
 159                                                                         \
 160         ret = inode_decode_field(in, end, field, &field_bits);          \
 161         if (ret < 0)                                                    \
 162                 return ret;                                             \
 163                                                                         \
 164         if (field_bits > sizeof(unpacked->_name) * 8)                   \
 165                 return -1;                                              \
 166                                                                         \
 167         unpacked->_name = field[1];                                     \
 168         in += ret;
 169
 170         BCH_INODE_FIELDS()
 171 #undef  BCH_INODE_FIELD
 172
 173         /* XXX: signal if there were more fields than expected? */
 174
 175         return 0;
 176 }
 177
 178 const char *bch2_inode_invalid(const struct bch_fs *c, struct bkey_s_c k)
 179 {
 180         if (k.k->p.offset)
 181                 return "nonzero offset";
 182
 183         switch (k.k->type) {
 184         case BCH_INODE_FS: {
 185                 struct bkey_s_c_inode inode = bkey_s_c_to_inode(k);
 186                 struct bch_inode_unpacked unpacked;
 187
 188                 if (bkey_val_bytes(k.k) < sizeof(struct bch_inode))
 189                         return "incorrect value size";
 190
 191                 if (k.k->p.inode < BLOCKDEV_INODE_MAX)
 192                         return "fs inode in blockdev range";
 193
 194                 if (INODE_STR_HASH(inode.v) >= BCH_STR_HASH_NR)
 195                         return "invalid str hash type";
 196
 197                 if (bch2_inode_unpack(inode, &unpacked))
 198                         return "invalid variable length fields";
 199
 200                 if (unpacked.bi_data_checksum >= BCH_CSUM_OPT_NR + 1)
 201                         return "invalid data checksum type";
 202
 203                 if (unpacked.bi_compression >= BCH_COMPRESSION_OPT_NR + 1)
 204                         return "invalid data checksum type";
 205
 206                 if ((unpacked.bi_flags & BCH_INODE_UNLINKED) &&
 207                     unpacked.bi_nlink != 0)
 208                         return "flagged as unlinked but bi_nlink != 0";
 209
 210                 return NULL;
 211         }
 212         case BCH_INODE_BLOCKDEV:
 213                 if (bkey_val_bytes(k.k) != sizeof(struct bch_inode_blockdev))
 214                         return "incorrect value size";
 215
 216                 if (k.k->p.inode >= BLOCKDEV_INODE_MAX)
 217                         return "blockdev inode in fs range";
 218
 219                 return NULL;
 220         case BCH_INODE_GENERATION:
 221                 if (bkey_val_bytes(k.k) != sizeof(struct bch_inode_generation))
 222                         return "incorrect value size";
 223
 224                 return NULL;
 225         default:
 226                 return "invalid type";
 227         }
 228 }
 229
 230 void bch2_inode_to_text(struct printbuf *out, struct bch_fs *c,
 231                        struct bkey_s_c k)
 232 {
 233         struct bkey_s_c_inode inode;
 234         struct bch_inode_unpacked unpacked;
 235
 236         switch (k.k->type) {
 237         case BCH_INODE_FS:
 238                 inode = bkey_s_c_to_inode(k);
 239                 if (bch2_inode_unpack(inode, &unpacked)) {
 240                         pr_buf(out, "(unpack error)");
 241                         break;
 242                 }
 243
 244 #define BCH_INODE_FIELD(_name, _bits)                                           \
 245                 pr_buf(out, #_name ": %llu ", (u64) unpacked._name);
 246                 BCH_INODE_FIELDS()
 247 #undef  BCH_INODE_FIELD
 248                 break;
 249         }
 250 }
 251
 252 void bch2_inode_init(struct bch_fs *c, struct bch_inode_unpacked *inode_u,
 253                      uid_t uid, gid_t gid, umode_t mode, dev_t rdev,
 254                      struct bch_inode_unpacked *parent)
 255 {
 256         s64 now = timespec_to_bch2_time(c,
 257                 timespec64_trunc(current_kernel_time64(),
 258                                  c->sb.time_precision));
 259
 260         memset(inode_u, 0, sizeof(*inode_u));
 261
 262         /* ick */
 263         inode_u->bi_flags |= c->opts.str_hash << INODE_STR_HASH_OFFSET;
 264         get_random_bytes(&inode_u->bi_hash_seed, sizeof(inode_u->bi_hash_seed));
 265
 266         inode_u->bi_mode        = mode;
 267         inode_u->bi_uid         = uid;
 268         inode_u->bi_gid         = gid;
 269         inode_u->bi_dev         = rdev;
 270         inode_u->bi_atime       = now;
 271         inode_u->bi_mtime       = now;
 272         inode_u->bi_ctime       = now;
 273         inode_u->bi_otime       = now;
 274
 275         if (parent) {
 276 #define BCH_INODE_FIELD(_name)  inode_u->_name = parent->_name;
 277                 BCH_INODE_FIELDS_INHERIT()
 278 #undef BCH_INODE_FIELD
 279         }
 280 }
 281
 282 static inline u32 bkey_generation(struct bkey_s_c k)
 283 {
 284         switch (k.k->type) {
 285         case BCH_INODE_BLOCKDEV:
 286         case BCH_INODE_FS:
 287                 BUG();
 288         case BCH_INODE_GENERATION:
 289                 return le32_to_cpu(bkey_s_c_to_inode_generation(k).v->bi_generation);
 290         default:
 291                 return 0;
 292         }
 293 }
 294
 295 int __bch2_inode_create(struct btree_trans *trans,
 296                         struct bch_inode_unpacked *inode_u,
 297                         u64 min, u64 max, u64 *hint)
 298 {
 299         struct bch_fs *c = trans->c;
 300         struct bkey_inode_buf *inode_p;
 301         struct btree_iter *iter;
 302         u64 start;
 303         int ret;
 304
 305         if (!max)
 306                 max = ULLONG_MAX;
 307
 308         if (c->opts.inodes_32bit)
 309                 max = min_t(u64, max, U32_MAX);
 310
 311         start = READ_ONCE(*hint);
 312
 313         if (start >= max || start < min)
 314                 start = min;
 315
 316         inode_p = bch2_trans_kmalloc(trans, sizeof(*inode_p));
 317         if (IS_ERR(inode_p))
 318                 return PTR_ERR(inode_p);
 319
 320         iter = bch2_trans_get_iter(trans,
 321                         BTREE_ID_INODES, POS(start, 0),
 322                         BTREE_ITER_SLOTS|BTREE_ITER_INTENT);
 323         if (IS_ERR(iter))
 324                 return PTR_ERR(iter);
 325 again:
 326         while (1) {
 327                 struct bkey_s_c k = bch2_btree_iter_peek_slot(iter);
 328
 329                 ret = btree_iter_err(k);
 330                 if (ret)
 331                         return ret;
 332
 333                 switch (k.k->type) {
 334                 case BCH_INODE_BLOCKDEV:
 335                 case BCH_INODE_FS:
 336                         /* slot used */
 337                         if (iter->pos.inode >= max)
 338                                 goto out;
 339
 340                         bch2_btree_iter_next_slot(iter);
 341                         break;
 342
 343                 default:
 344                         *hint                   = k.k->p.inode;
 345                         inode_u->bi_inum        = k.k->p.inode;
 346                         inode_u->bi_generation  = bkey_generation(k);
 347
 348                         bch2_inode_pack(inode_p, inode_u);
 349                         bch2_trans_update(trans,
 350                                 BTREE_INSERT_ENTRY(iter, &inode_p->inode.k_i));
 351                         return 0;
 352                 }
 353         }
 354 out:
 355         if (start != min) {
 356                 /* Retry from start */
 357                 start = min;
 358                 bch2_btree_iter_set_pos(iter, POS(start, 0));
 359                 goto again;
 360         }
 361
 362         return -ENOSPC;
 363 }
 364
 365 int bch2_inode_create(struct bch_fs *c, struct bch_inode_unpacked *inode_u,
 366                       u64 min, u64 max, u64 *hint)
 367 {
 368         return bch2_trans_do(c, NULL, BTREE_INSERT_ATOMIC,
 369                         __bch2_inode_create(&trans, inode_u, min, max, hint));
 370 }
 371
 372 int bch2_inode_rm(struct bch_fs *c, u64 inode_nr)
 373 {
 374         struct btree_iter iter;
 375         struct bkey_i_inode_generation delete;
 376         struct bpos start = POS(inode_nr, 0);
 377         struct bpos end = POS(inode_nr + 1, 0);
 378         int ret;
 379
 380         /*
 381          * If this was a directory, there shouldn't be any real dirents left -
 382          * but there could be whiteouts (from hash collisions) that we should
 383          * delete:
 384          *
 385          * XXX: the dirent could ideally would delete whiteouts when they're no
 386          * longer needed
 387          */
 388         ret   = bch2_btree_delete_range(c, BTREE_ID_EXTENTS,
 389                                         start, end, NULL) ?:
 390                 bch2_btree_delete_range(c, BTREE_ID_XATTRS,
 391                                         start, end, NULL) ?:
 392                 bch2_btree_delete_range(c, BTREE_ID_DIRENTS,
 393                                         start, end, NULL);
 394         if (ret)
 395                 return ret;
 396
 397         bch2_btree_iter_init(&iter, c, BTREE_ID_INODES, POS(inode_nr, 0),
 398                              BTREE_ITER_SLOTS|BTREE_ITER_INTENT);
 399         do {
 400                 struct bkey_s_c k = bch2_btree_iter_peek_slot(&iter);
 401                 u32 bi_generation = 0;
 402
 403                 ret = btree_iter_err(k);
 404                 if (ret) {
 405                         bch2_btree_iter_unlock(&iter);
 406                         return ret;
 407                 }
 408
 409                 bch2_fs_inconsistent_on(k.k->type != BCH_INODE_FS, c,
 410                                         "inode %llu not found when deleting",
 411                                         inode_nr);
 412
 413                 switch (k.k->type) {
 414                 case BCH_INODE_FS: {
 415                         struct bch_inode_unpacked inode_u;
 416
 417                         if (!bch2_inode_unpack(bkey_s_c_to_inode(k), &inode_u))
 418                                 bi_generation = inode_u.bi_generation + 1;
 419                         break;
 420                 }
 421                 case BCH_INODE_GENERATION: {
 422                         struct bkey_s_c_inode_generation g =
 423                                 bkey_s_c_to_inode_generation(k);
 424                         bi_generation = le32_to_cpu(g.v->bi_generation);
 425                         break;
 426                 }
 427                 }
 428
 429                 if (!bi_generation) {
 430                         bkey_init(&delete.k);
 431                         delete.k.p.inode = inode_nr;
 432                 } else {
 433                         bkey_inode_generation_init(&delete.k_i);
 434                         delete.k.p.inode = inode_nr;
 435                         delete.v.bi_generation = cpu_to_le32(bi_generation);
 436                 }
 437
 438                 ret = bch2_btree_insert_at(c, NULL, NULL,
 439                                 BTREE_INSERT_ATOMIC|
 440                                 BTREE_INSERT_NOFAIL,
 441                                 BTREE_INSERT_ENTRY(&iter, &delete.k_i));
 442         } while (ret == -EINTR);
 443
 444         bch2_btree_iter_unlock(&iter);
 445         return ret;
 446 }
 447
 448 int bch2_inode_find_by_inum(struct bch_fs *c, u64 inode_nr,
 449                             struct bch_inode_unpacked *inode)
 450 {
 451         struct btree_iter iter;
 452         struct bkey_s_c k;
 453         int ret = -ENOENT;
 454
 455         for_each_btree_key(&iter, c, BTREE_ID_INODES,
 456                            POS(inode_nr, 0),
 457                            BTREE_ITER_SLOTS, k) {
 458                 switch (k.k->type) {
 459                 case BCH_INODE_FS:
 460                         ret = bch2_inode_unpack(bkey_s_c_to_inode(k), inode);
 461                         break;
 462                 default:
 463                         /* hole, not found */
 464                         break;
 465                 }
 466
 467                 break;
 468
 469         }
 470
 471         return bch2_btree_iter_unlock(&iter) ?: ret;
 472 }
 473
 474 #ifdef CONFIG_BCACHEFS_DEBUG
 475 void bch2_inode_pack_test(void)
 476 {
 477         struct bch_inode_unpacked *u, test_inodes[] = {
 478                 {
 479                         .bi_atime       = U64_MAX,
 480                         .bi_ctime       = U64_MAX,
 481                         .bi_mtime       = U64_MAX,
 482                         .bi_otime       = U64_MAX,
 483                         .bi_size        = U64_MAX,
 484                         .bi_sectors     = U64_MAX,
 485                         .bi_uid         = U32_MAX,
 486                         .bi_gid         = U32_MAX,
 487                         .bi_nlink       = U32_MAX,
 488                         .bi_generation  = U32_MAX,
 489                         .bi_dev         = U32_MAX,
 490                 },
 491         };
 492
 493         for (u = test_inodes;
 494              u < test_inodes + ARRAY_SIZE(test_inodes);
 495              u++) {
 496                 struct bkey_inode_buf p;
 497
 498                 bch2_inode_pack(&p, u);
 499         }
 500 }
 501 #endif