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

   1 #include <ctype.h>
   2 #include <dirent.h>
   3 #include <errno.h>
   4 #include <fcntl.h>
   5 #include <stdbool.h>
   6 #include <stdint.h>
   7 #include <stdio.h>
   8 #include <stdlib.h>
   9 #include <string.h>
  10 #include <sys/stat.h>
  11 #include <sys/sysmacros.h>
  12 #include <sys/types.h>
  13 #include <time.h>
  14 #include <unistd.h>
  15
  16 #include <uuid/uuid.h>
  17
  18 #include "libbcachefs.h"
  19 #include "crypto.h"
  20 #include "libbcachefs/bcachefs_format.h"
  21 #include "libbcachefs/btree_cache.h"
  22 #include "libbcachefs/checksum.h"
  23 #include "libbcachefs/disk_groups.h"
  24 #include "libbcachefs/journal_seq_blacklist.h"
  25 #include "libbcachefs/opts.h"
  26 #include "libbcachefs/replicas.h"
  27 #include "libbcachefs/super-io.h"
  28 #include "tools-util.h"
  29
  30 #define NSEC_PER_SEC    1000000000L
  31
  32 /* minimum size filesystem we can create, given a bucket size: */
  33 static u64 min_size(unsigned bucket_size)
  34 {
  35         return BCH_MIN_NR_NBUCKETS * bucket_size;
  36 }
  37
  38 static void init_layout(struct bch_sb_layout *l, unsigned block_size,
  39                         u64 start, u64 end)
  40 {
  41         unsigned sb_size;
  42         u64 backup; /* offset of 2nd sb */
  43
  44         memset(l, 0, sizeof(*l));
  45
  46         if (start != BCH_SB_SECTOR)
  47                 start = round_up(start, block_size);
  48         end = round_down(end, block_size);
  49
  50         if (start >= end)
  51                 die("insufficient space for superblocks");
  52
  53         /*
  54          * Create two superblocks in the allowed range: reserve a maximum of 64k
  55          */
  56         sb_size = min_t(u64, 128, end - start / 2);
  57
  58         backup = start + sb_size;
  59         backup = round_up(backup, block_size);
  60
  61         backup = min(backup, end);
  62
  63         sb_size = min(end - backup, backup- start);
  64         sb_size = rounddown_pow_of_two(sb_size);
  65
  66         if (sb_size < 8)
  67                 die("insufficient space for superblocks");
  68
  69         l->magic                = BCACHE_MAGIC;
  70         l->layout_type          = 0;
  71         l->nr_superblocks       = 2;
  72         l->sb_max_size_bits     = ilog2(sb_size);
  73         l->sb_offset[0]         = cpu_to_le64(start);
  74         l->sb_offset[1]         = cpu_to_le64(backup);
  75 }
  76
  77 void bch2_pick_bucket_size(struct bch_opts opts, struct dev_opts *dev)
  78 {
  79         if (!dev->sb_offset) {
  80                 dev->sb_offset  = BCH_SB_SECTOR;
  81                 dev->sb_end     = BCH_SB_SECTOR + 256;
  82         }
  83
  84         if (!dev->size)
  85                 dev->size = get_size(dev->path, dev->fd) >> 9;
  86
  87         if (!dev->bucket_size) {
  88                 if (dev->size < min_size(opts.block_size))
  89                         die("cannot format %s, too small (%llu sectors, min %llu)",
  90                             dev->path, dev->size, min_size(opts.block_size));
  91
  92                 /* Bucket size must be >= block size: */
  93                 dev->bucket_size = opts.block_size;
  94
  95                 /* Bucket size must be >= btree node size: */
  96                 if (opt_defined(opts, btree_node_size))
  97                         dev->bucket_size = max_t(unsigned, dev->bucket_size,
  98                                                  opts.btree_node_size);
  99
 100                 /* Want a bucket size of at least 128k, if possible: */
 101                 dev->bucket_size = max(dev->bucket_size, 256U);
 102
 103                 if (dev->size >= min_size(dev->bucket_size)) {
 104                         unsigned scale = max(1,
 105                                              ilog2(dev->size / min_size(dev->bucket_size)) / 4);
 106
 107                         scale = rounddown_pow_of_two(scale);
 108
 109                         /* max bucket size 1 mb */
 110                         dev->bucket_size = min(dev->bucket_size * scale, 1U << 11);
 111                 } else {
 112                         do {
 113                                 dev->bucket_size /= 2;
 114                         } while (dev->size < min_size(dev->bucket_size));
 115                 }
 116         }
 117
 118         dev->nbuckets   = dev->size / dev->bucket_size;
 119
 120         if (dev->bucket_size < opts.block_size)
 121                 die("Bucket size cannot be smaller than block size");
 122
 123         if (opt_defined(opts, btree_node_size) &&
 124             dev->bucket_size < opts.btree_node_size)
 125                 die("Bucket size cannot be smaller than btree node size");
 126
 127         if (dev->nbuckets < BCH_MIN_NR_NBUCKETS)
 128                 die("Not enough buckets: %llu, need %u (bucket size %u)",
 129                     dev->nbuckets, BCH_MIN_NR_NBUCKETS, dev->bucket_size);
 130
 131 }
 132
 133 static unsigned parse_target(struct bch_sb_handle *sb,
 134                              struct dev_opts *devs, size_t nr_devs,
 135                              const char *s)
 136 {
 137         struct dev_opts *i;
 138         int idx;
 139
 140         if (!s)
 141                 return 0;
 142
 143         for (i = devs; i < devs + nr_devs; i++)
 144                 if (!strcmp(s, i->path))
 145                         return dev_to_target(i - devs);
 146
 147         idx = bch2_disk_path_find(sb, s);
 148         if (idx >= 0)
 149                 return group_to_target(idx);
 150
 151         die("Invalid target %s", s);
 152         return 0;
 153 }
 154
 155 struct bch_sb *bch2_format(struct bch_opt_strs  fs_opt_strs,
 156                            struct bch_opts      fs_opts,
 157                            struct format_opts   opts,
 158                            struct dev_opts      *devs,
 159                            size_t               nr_devs)
 160 {
 161         struct bch_sb_handle sb = { NULL };
 162         struct dev_opts *i;
 163         struct bch_sb_field_members *mi;
 164         unsigned max_dev_block_size = 0;
 165         unsigned opt_id;
 166
 167         for (i = devs; i < devs + nr_devs; i++)
 168                 max_dev_block_size = max(max_dev_block_size,
 169                                          get_blocksize(i->path, i->fd));
 170
 171         /* calculate block size: */
 172         if (!opt_defined(fs_opts, block_size)) {
 173                 opt_set(fs_opts, block_size, max_dev_block_size);
 174         } else if (fs_opts.block_size < max_dev_block_size)
 175                 die("blocksize too small: %u, must be greater than device blocksize %u",
 176                     fs_opts.block_size, max_dev_block_size);
 177
 178         /* calculate bucket sizes: */
 179         for (i = devs; i < devs + nr_devs; i++)
 180                 bch2_pick_bucket_size(fs_opts, i);
 181
 182         /* calculate btree node size: */
 183         if (!opt_defined(fs_opts, btree_node_size)) {
 184                 /* 256k default btree node size */
 185                 opt_set(fs_opts, btree_node_size, 512);
 186
 187                 for (i = devs; i < devs + nr_devs; i++)
 188                         fs_opts.btree_node_size =
 189                                 min_t(unsigned, fs_opts.btree_node_size,
 190                                       i->bucket_size);
 191         }
 192
 193         if (!is_power_of_2(fs_opts.block_size))
 194                 die("block size must be power of 2");
 195
 196         if (!is_power_of_2(fs_opts.btree_node_size))
 197                 die("btree node size must be power of 2");
 198
 199         if (uuid_is_null(opts.uuid.b))
 200                 uuid_generate(opts.uuid.b);
 201
 202         if (bch2_sb_realloc(&sb, 0))
 203                 die("insufficient memory");
 204
 205         sb.sb->version          = le16_to_cpu(bcachefs_metadata_version_current);
 206         sb.sb->version_min      = le16_to_cpu(bcachefs_metadata_version_current);
 207         sb.sb->magic            = BCACHE_MAGIC;
 208         sb.sb->block_size       = cpu_to_le16(fs_opts.block_size);
 209         sb.sb->user_uuid        = opts.uuid;
 210         sb.sb->nr_devices       = nr_devs;
 211
 212         uuid_generate(sb.sb->uuid.b);
 213
 214         if (opts.label)
 215                 memcpy(sb.sb->label,
 216                        opts.label,
 217                        min(strlen(opts.label), sizeof(sb.sb->label)));
 218
 219         for (opt_id = 0;
 220              opt_id < bch2_opts_nr;
 221              opt_id++) {
 222                 const struct bch_option *opt = &bch2_opt_table[opt_id];
 223                 u64 v;
 224
 225                 if (opt->set_sb == SET_NO_SB_OPT)
 226                         continue;
 227
 228                 v = bch2_opt_defined_by_id(&fs_opts, opt_id)
 229                         ? bch2_opt_get_by_id(&fs_opts, opt_id)
 230                         : bch2_opt_get_by_id(&bch2_opts_default, opt_id);
 231
 232                 opt->set_sb(sb.sb, v);
 233         }
 234
 235         SET_BCH_SB_ENCODED_EXTENT_MAX_BITS(sb.sb,
 236                                 ilog2(opts.encoded_extent_max));
 237
 238         struct timespec now;
 239         if (clock_gettime(CLOCK_REALTIME, &now))
 240                 die("error getting current time: %m");
 241
 242         sb.sb->time_base_lo     = cpu_to_le64(now.tv_sec * NSEC_PER_SEC + now.tv_nsec);
 243         sb.sb->time_precision   = cpu_to_le32(1);
 244
 245         /* Member info: */
 246         mi = bch2_sb_resize_members(&sb,
 247                         (sizeof(*mi) + sizeof(struct bch_member) *
 248                          nr_devs) / sizeof(u64));
 249
 250         for (i = devs; i < devs + nr_devs; i++) {
 251                 struct bch_member *m = mi->members + (i - devs);
 252
 253                 uuid_generate(m->uuid.b);
 254                 m->nbuckets     = cpu_to_le64(i->nbuckets);
 255                 m->first_bucket = 0;
 256                 m->bucket_size  = cpu_to_le16(i->bucket_size);
 257
 258                 SET_BCH_MEMBER_REPLACEMENT(m,   CACHE_REPLACEMENT_LRU);
 259                 SET_BCH_MEMBER_DISCARD(m,       i->discard);
 260                 SET_BCH_MEMBER_DATA_ALLOWED(m,  i->data_allowed);
 261                 SET_BCH_MEMBER_DURABILITY(m,    i->durability + 1);
 262         }
 263
 264         /* Disk groups */
 265         for (i = devs; i < devs + nr_devs; i++) {
 266                 struct bch_member *m = mi->members + (i - devs);
 267                 int idx;
 268
 269                 if (!i->group)
 270                         continue;
 271
 272                 idx = bch2_disk_path_find_or_create(&sb, i->group);
 273                 if (idx < 0)
 274                         die("error creating disk path: %s", idx);
 275
 276                 SET_BCH_MEMBER_GROUP(m, idx + 1);
 277         }
 278
 279         SET_BCH_SB_FOREGROUND_TARGET(sb.sb,
 280                 parse_target(&sb, devs, nr_devs, fs_opt_strs.foreground_target));
 281         SET_BCH_SB_BACKGROUND_TARGET(sb.sb,
 282                 parse_target(&sb, devs, nr_devs, fs_opt_strs.background_target));
 283         SET_BCH_SB_PROMOTE_TARGET(sb.sb,
 284                 parse_target(&sb, devs, nr_devs, fs_opt_strs.promote_target));
 285
 286         /* Crypt: */
 287         if (opts.encrypted) {
 288                 struct bch_sb_field_crypt *crypt =
 289                         bch2_sb_resize_crypt(&sb, sizeof(*crypt) / sizeof(u64));
 290
 291                 bch_sb_crypt_init(sb.sb, crypt, opts.passphrase);
 292                 SET_BCH_SB_ENCRYPTION_TYPE(sb.sb, 1);
 293         }
 294
 295         for (i = devs; i < devs + nr_devs; i++) {
 296                 sb.sb->dev_idx = i - devs;
 297
 298                 init_layout(&sb.sb->layout, fs_opts.block_size,
 299                             i->sb_offset, i->sb_end);
 300
 301                 if (i->sb_offset == BCH_SB_SECTOR) {
 302                         /* Zero start of disk */
 303                         static const char zeroes[BCH_SB_SECTOR << 9];
 304
 305                         xpwrite(i->fd, zeroes, BCH_SB_SECTOR << 9, 0);
 306                 }
 307
 308                 bch2_super_write(i->fd, sb.sb);
 309                 close(i->fd);
 310         }
 311
 312         return sb.sb;
 313 }
 314
 315 void bch2_super_write(int fd, struct bch_sb *sb)
 316 {
 317         struct nonce nonce = { 0 };
 318
 319         unsigned i;
 320         for (i = 0; i < sb->layout.nr_superblocks; i++) {
 321                 sb->offset = sb->layout.sb_offset[i];
 322
 323                 if (sb->offset == BCH_SB_SECTOR) {
 324                         /* Write backup layout */
 325                         xpwrite(fd, &sb->layout, sizeof(sb->layout),
 326                                 BCH_SB_LAYOUT_SECTOR << 9);
 327                 }
 328
 329                 sb->csum = csum_vstruct(NULL, BCH_SB_CSUM_TYPE(sb), nonce, sb);
 330                 xpwrite(fd, sb, vstruct_bytes(sb),
 331                         le64_to_cpu(sb->offset) << 9);
 332         }
 333
 334         fsync(fd);
 335 }
 336
 337 struct bch_sb *__bch2_super_read(int fd, u64 sector)
 338 {
 339         struct bch_sb sb, *ret;
 340
 341         xpread(fd, &sb, sizeof(sb), sector << 9);
 342
 343         if (memcmp(&sb.magic, &BCACHE_MAGIC, sizeof(sb.magic)))
 344                 die("not a bcachefs superblock");
 345
 346         size_t bytes = vstruct_bytes(&sb);
 347
 348         ret = malloc(bytes);
 349
 350         xpread(fd, ret, bytes, sector << 9);
 351
 352         return ret;
 353 }
 354
 355 static unsigned get_dev_has_data(struct bch_sb *sb, unsigned dev)
 356 {
 357         struct bch_sb_field_replicas *replicas;
 358         struct bch_replicas_entry *r;
 359         unsigned i, data_has = 0;
 360
 361         replicas = bch2_sb_get_replicas(sb);
 362
 363         if (replicas)
 364                 for_each_replicas_entry(replicas, r)
 365                         for (i = 0; i < r->nr_devs; i++)
 366                                 if (r->devs[i] == dev)
 367                                         data_has |= 1 << r->data_type;
 368
 369         return data_has;
 370 }
 371
 372 static int bch2_sb_get_target(struct bch_sb *sb, char *buf, size_t len, u64 v)
 373 {
 374         struct target t = target_decode(v);
 375         int ret;
 376
 377         switch (t.type) {
 378         case TARGET_NULL:
 379                 return scnprintf(buf, len, "none");
 380         case TARGET_DEV: {
 381                 struct bch_sb_field_members *mi = bch2_sb_get_members(sb);
 382                 struct bch_member *m = mi->members + t.dev;
 383
 384                 if (bch2_dev_exists(sb, mi, t.dev)) {
 385                         char uuid_str[40];
 386
 387                         uuid_unparse(m->uuid.b, uuid_str);
 388
 389                         ret = scnprintf(buf, len, "Device %u (%s)", t.dev,
 390                                 uuid_str);
 391                 } else {
 392                         ret = scnprintf(buf, len, "Bad device %u", t.dev);
 393                 }
 394
 395                 break;
 396         }
 397         case TARGET_GROUP: {
 398                 struct bch_sb_field_disk_groups *gi;
 399                 gi = bch2_sb_get_disk_groups(sb);
 400
 401                 struct bch_disk_group *g = gi->entries + t.group;
 402
 403                 if (t.group < disk_groups_nr(gi) && !BCH_GROUP_DELETED(g)) {
 404                         ret = scnprintf(buf, len, "Group %u (%.*s)", t.group,
 405                                 BCH_SB_LABEL_SIZE, g->label);
 406                 } else {
 407                         ret = scnprintf(buf, len, "Bad group %u", t.group);
 408                 }
 409                 break;
 410         }
 411         default:
 412                 BUG();
 413         }
 414
 415         return ret;
 416 }
 417
 418 /* superblock printing: */
 419
 420 static void bch2_sb_print_layout(struct bch_sb *sb, enum units units)
 421 {
 422         struct bch_sb_layout *l = &sb->layout;
 423         unsigned i;
 424
 425         printf("  type:                         %u\n"
 426                "  superblock max size:          %s\n"
 427                "  nr superblocks:               %u\n"
 428                "  Offsets:                      ",
 429                l->layout_type,
 430                pr_units(1 << l->sb_max_size_bits, units),
 431                l->nr_superblocks);
 432
 433         for (i = 0; i < l->nr_superblocks; i++) {
 434                 if (i)
 435                         printf(", ");
 436                 printf("%llu", le64_to_cpu(l->sb_offset[i]));
 437         }
 438         putchar('\n');
 439 }
 440
 441 static void bch2_sb_print_journal(struct bch_sb *sb, struct bch_sb_field *f,
 442                                   enum units units)
 443 {
 444         struct bch_sb_field_journal *journal = field_to_type(f, journal);
 445         unsigned i, nr = bch2_nr_journal_buckets(journal);
 446
 447         printf("  Buckets:                      ");
 448         for (i = 0; i < nr; i++) {
 449                 if (i)
 450                         putchar(' ');
 451                 printf("%llu", le64_to_cpu(journal->buckets[i]));
 452         }
 453         putchar('\n');
 454 }
 455
 456 static void bch2_sb_print_members(struct bch_sb *sb, struct bch_sb_field *f,
 457                                   enum units units)
 458 {
 459         struct bch_sb_field_members *mi = field_to_type(f, members);
 460         struct bch_sb_field_disk_groups *gi = bch2_sb_get_disk_groups(sb);
 461         unsigned i;
 462
 463         for (i = 0; i < sb->nr_devices; i++) {
 464                 struct bch_member *m = mi->members + i;
 465                 time_t last_mount = le64_to_cpu(m->last_mount);
 466                 char member_uuid_str[40];
 467                 char data_allowed_str[100];
 468                 char data_has_str[100];
 469                 char group[BCH_SB_LABEL_SIZE+10];
 470                 char time_str[64];
 471
 472                 if (!bch2_member_exists(m))
 473                         continue;
 474
 475                 uuid_unparse(m->uuid.b, member_uuid_str);
 476
 477                 if (BCH_MEMBER_GROUP(m)) {
 478                         unsigned idx = BCH_MEMBER_GROUP(m) - 1;
 479
 480                         if (idx < disk_groups_nr(gi)) {
 481                                 snprintf(group, sizeof(group), "%.*s (%u)",
 482                                         BCH_SB_LABEL_SIZE,
 483                                         gi->entries[idx].label, idx);
 484                         } else {
 485                                 strcpy(group, "(bad disk groups section)");
 486                         }
 487                 } else {
 488                         strcpy(group, "(none)");
 489                 }
 490
 491                 bch2_flags_to_text(&PBUF(data_allowed_str),
 492                                    bch2_data_types,
 493                                    BCH_MEMBER_DATA_ALLOWED(m));
 494                 if (!data_allowed_str[0])
 495                         strcpy(data_allowed_str, "(none)");
 496
 497                 bch2_flags_to_text(&PBUF(data_has_str),
 498                                    bch2_data_types,
 499                                    get_dev_has_data(sb, i));
 500                 if (!data_has_str[0])
 501                         strcpy(data_has_str, "(none)");
 502
 503                 if (last_mount) {
 504                         struct tm *tm = localtime(&last_mount);
 505                         size_t err = strftime(time_str, sizeof(time_str), "%c", tm);
 506                         if (!err)
 507                                 strcpy(time_str, "(formatting error)");
 508                 } else {
 509                         strcpy(time_str, "(never)");
 510                 }
 511
 512                 printf("  Device %u:\n"
 513                        "    UUID:                       %s\n"
 514                        "    Size:                       %s\n"
 515                        "    Bucket size:                %s\n"
 516                        "    First bucket:               %u\n"
 517                        "    Buckets:                    %llu\n"
 518                        "    Last mount:                 %s\n"
 519                        "    State:                      %s\n"
 520                        "    Group:                      %s\n"
 521                        "    Data allowed:               %s\n"
 522
 523                        "    Has data:                   %s\n"
 524
 525                        "    Replacement policy:         %s\n"
 526                        "    Discard:                    %llu\n",
 527                        i, member_uuid_str,
 528                        pr_units(le16_to_cpu(m->bucket_size) *
 529                                 le64_to_cpu(m->nbuckets), units),
 530                        pr_units(le16_to_cpu(m->bucket_size), units),
 531                        le16_to_cpu(m->first_bucket),
 532                        le64_to_cpu(m->nbuckets),
 533                        time_str,
 534
 535                        BCH_MEMBER_STATE(m) < BCH_MEMBER_STATE_NR
 536                        ? bch2_dev_state[BCH_MEMBER_STATE(m)]
 537                        : "unknown",
 538
 539                        group,
 540                        data_allowed_str,
 541                        data_has_str,
 542
 543                        BCH_MEMBER_REPLACEMENT(m) < CACHE_REPLACEMENT_NR
 544                        ? bch2_cache_replacement_policies[BCH_MEMBER_REPLACEMENT(m)]
 545                        : "unknown",
 546
 547                        BCH_MEMBER_DISCARD(m));
 548         }
 549 }
 550
 551 static void bch2_sb_print_crypt(struct bch_sb *sb, struct bch_sb_field *f,
 552                                 enum units units)
 553 {
 554         struct bch_sb_field_crypt *crypt = field_to_type(f, crypt);
 555
 556         printf("  KFD:                  %llu\n"
 557                "  scrypt n:             %llu\n"
 558                "  scrypt r:             %llu\n"
 559                "  scrypt p:             %llu\n",
 560                BCH_CRYPT_KDF_TYPE(crypt),
 561                BCH_KDF_SCRYPT_N(crypt),
 562                BCH_KDF_SCRYPT_R(crypt),
 563                BCH_KDF_SCRYPT_P(crypt));
 564 }
 565
 566 static void bch2_sb_print_replicas_v0(struct bch_sb *sb, struct bch_sb_field *f,
 567                                    enum units units)
 568 {
 569         struct bch_sb_field_replicas_v0 *replicas = field_to_type(f, replicas_v0);
 570         struct bch_replicas_entry_v0 *e;
 571         unsigned i;
 572
 573         for_each_replicas_entry(replicas, e) {
 574                 printf_pad(32, "  %s:", bch2_data_types[e->data_type]);
 575
 576                 putchar('[');
 577                 for (i = 0; i < e->nr_devs; i++) {
 578                         if (i)
 579                                 putchar(' ');
 580                         printf("%u", e->devs[i]);
 581                 }
 582                 printf("]\n");
 583         }
 584 }
 585
 586 static void bch2_sb_print_replicas(struct bch_sb *sb, struct bch_sb_field *f,
 587                                    enum units units)
 588 {
 589         struct bch_sb_field_replicas *replicas = field_to_type(f, replicas);
 590         struct bch_replicas_entry *e;
 591         unsigned i;
 592
 593         for_each_replicas_entry(replicas, e) {
 594                 printf_pad(32, "  %s: %u/%u",
 595                            bch2_data_types[e->data_type],
 596                            e->nr_required,
 597                            e->nr_devs);
 598
 599                 putchar('[');
 600                 for (i = 0; i < e->nr_devs; i++) {
 601                         if (i)
 602                                 putchar(' ');
 603                         printf("%u", e->devs[i]);
 604                 }
 605                 printf("]\n");
 606         }
 607 }
 608
 609 static void bch2_sb_print_quota(struct bch_sb *sb, struct bch_sb_field *f,
 610                                 enum units units)
 611 {
 612 }
 613
 614 static void bch2_sb_print_disk_groups(struct bch_sb *sb, struct bch_sb_field *f,
 615                                       enum units units)
 616 {
 617 }
 618
 619 static void bch2_sb_print_clean(struct bch_sb *sb, struct bch_sb_field *f,
 620                                 enum units units)
 621 {
 622         struct bch_sb_field_clean *clean = field_to_type(f, clean);
 623
 624
 625         printf("  flags:       %x", le32_to_cpu(clean->flags));
 626         printf("  read clock:  %x", le16_to_cpu(clean->read_clock));
 627         printf("  write clock: %x", le16_to_cpu(clean->write_clock));
 628         printf("  journal seq: %llx", le64_to_cpu(clean->journal_seq));
 629 }
 630
 631 static void bch2_sb_print_journal_seq_blacklist(struct bch_sb *sb, struct bch_sb_field *f,
 632                                 enum units units)
 633 {
 634         struct bch_sb_field_journal_seq_blacklist *bl = field_to_type(f, journal_seq_blacklist);
 635         unsigned i, nr = blacklist_nr_entries(bl);
 636
 637         for (i = 0; i < nr; i++) {
 638                 struct journal_seq_blacklist_entry *e =
 639                         bl->start + i;
 640
 641                 printf("  %llu-%llu\n",
 642                        le64_to_cpu(e->start),
 643                        le64_to_cpu(e->end));
 644         }
 645 }
 646
 647 typedef void (*sb_field_print_fn)(struct bch_sb *, struct bch_sb_field *, enum units);
 648
 649 struct bch_sb_field_toolops {
 650         sb_field_print_fn       print;
 651 };
 652
 653 static const struct bch_sb_field_toolops bch2_sb_field_ops[] = {
 654 #define x(f, nr)                                        \
 655         [BCH_SB_FIELD_##f] = {                          \
 656                 .print  = bch2_sb_print_##f,            \
 657         },
 658         BCH_SB_FIELDS()
 659 #undef x
 660 };
 661
 662 static inline void bch2_sb_field_print(struct bch_sb *sb,
 663                                        struct bch_sb_field *f,
 664                                        enum units units)
 665 {
 666         unsigned type = le32_to_cpu(f->type);
 667
 668         if (type < BCH_SB_FIELD_NR)
 669                 bch2_sb_field_ops[type].print(sb, f, units);
 670         else
 671                 printf("(unknown field %u)\n", type);
 672 }
 673
 674 void bch2_sb_print(struct bch_sb *sb, bool print_layout,
 675                    unsigned fields, enum units units)
 676 {
 677         struct bch_sb_field_members *mi;
 678         char user_uuid_str[40], internal_uuid_str[40];
 679         char features_str[500];
 680         char fields_have_str[200];
 681         char label[BCH_SB_LABEL_SIZE + 1];
 682         char time_str[64];
 683         char foreground_str[64];
 684         char background_str[64];
 685         char promote_str[64];
 686         struct bch_sb_field *f;
 687         u64 fields_have = 0;
 688         unsigned nr_devices = 0;
 689         time_t time_base = le64_to_cpu(sb->time_base_lo) / NSEC_PER_SEC;
 690
 691         memcpy(label, sb->label, BCH_SB_LABEL_SIZE);
 692         label[BCH_SB_LABEL_SIZE] = '\0';
 693
 694         uuid_unparse(sb->user_uuid.b, user_uuid_str);
 695         uuid_unparse(sb->uuid.b, internal_uuid_str);
 696
 697         if (time_base) {
 698                 struct tm *tm = localtime(&time_base);
 699                 size_t err = strftime(time_str, sizeof(time_str), "%c", tm);
 700                 if (!err)
 701                         strcpy(time_str, "(formatting error)");
 702         } else {
 703                 strcpy(time_str, "(not set)");
 704         }
 705
 706         mi = bch2_sb_get_members(sb);
 707         if (mi) {
 708                 struct bch_member *m;
 709
 710                 for (m = mi->members;
 711                      m < mi->members + sb->nr_devices;
 712                      m++)
 713                         nr_devices += bch2_member_exists(m);
 714         }
 715
 716         bch2_sb_get_target(sb, foreground_str, sizeof(foreground_str),
 717                 BCH_SB_FOREGROUND_TARGET(sb));
 718
 719         bch2_sb_get_target(sb, background_str, sizeof(background_str),
 720                 BCH_SB_BACKGROUND_TARGET(sb));
 721
 722         bch2_sb_get_target(sb, promote_str, sizeof(promote_str),
 723                 BCH_SB_PROMOTE_TARGET(sb));
 724
 725         bch2_flags_to_text(&PBUF(features_str),
 726                            bch2_sb_features,
 727                            le64_to_cpu(sb->features[0]));
 728
 729         vstruct_for_each(sb, f)
 730                 fields_have |= 1 << le32_to_cpu(f->type);
 731         bch2_flags_to_text(&PBUF(fields_have_str),
 732                            bch2_sb_fields, fields_have);
 733
 734         printf("External UUID:                  %s\n"
 735                "Internal UUID:                  %s\n"
 736                "Label:                          %s\n"
 737                "Version:                        %llu\n"
 738                "Created:                        %s\n"
 739                "Squence number:                 %llu\n"
 740                "Block_size:                     %s\n"
 741                "Btree node size:                %s\n"
 742                "Error action:                   %s\n"
 743                "Clean:                          %llu\n"
 744                "Features:                       %s\n"
 745
 746                "Metadata replicas:              %llu\n"
 747                "Data replicas:                  %llu\n"
 748
 749                "Metadata checksum type:         %s (%llu)\n"
 750                "Data checksum type:             %s (%llu)\n"
 751                "Compression type:               %s (%llu)\n"
 752
 753                "Foreground write target:        %s\n"
 754                "Background write target:        %s\n"
 755                "Promote target:                 %s\n"
 756
 757                "String hash type:               %s (%llu)\n"
 758                "32 bit inodes:                  %llu\n"
 759                "GC reserve percentage:          %llu%%\n"
 760                "Root reserve percentage:        %llu%%\n"
 761
 762                "Devices:                        %u live, %u total\n"
 763                "Sections:                       %s\n"
 764                "Superblock size:                %llu\n",
 765                user_uuid_str,
 766                internal_uuid_str,
 767                label,
 768                le64_to_cpu(sb->version),
 769                time_str,
 770                le64_to_cpu(sb->seq),
 771                pr_units(le16_to_cpu(sb->block_size), units),
 772                pr_units(BCH_SB_BTREE_NODE_SIZE(sb), units),
 773
 774                BCH_SB_ERROR_ACTION(sb) < BCH_NR_ERROR_ACTIONS
 775                ? bch2_error_actions[BCH_SB_ERROR_ACTION(sb)]
 776                : "unknown",
 777
 778                BCH_SB_CLEAN(sb),
 779                features_str,
 780
 781                BCH_SB_META_REPLICAS_WANT(sb),
 782                BCH_SB_DATA_REPLICAS_WANT(sb),
 783
 784                BCH_SB_META_CSUM_TYPE(sb) < BCH_CSUM_OPT_NR
 785                ? bch2_csum_opts[BCH_SB_META_CSUM_TYPE(sb)]
 786                : "unknown",
 787                BCH_SB_META_CSUM_TYPE(sb),
 788
 789                BCH_SB_DATA_CSUM_TYPE(sb) < BCH_CSUM_OPT_NR
 790                ? bch2_csum_opts[BCH_SB_DATA_CSUM_TYPE(sb)]
 791                : "unknown",
 792                BCH_SB_DATA_CSUM_TYPE(sb),
 793
 794                BCH_SB_COMPRESSION_TYPE(sb) < BCH_COMPRESSION_OPT_NR
 795                ? bch2_compression_opts[BCH_SB_COMPRESSION_TYPE(sb)]
 796                : "unknown",
 797                BCH_SB_COMPRESSION_TYPE(sb),
 798
 799                foreground_str,
 800                background_str,
 801                promote_str,
 802
 803                BCH_SB_STR_HASH_TYPE(sb) < BCH_STR_HASH_NR
 804                ? bch2_str_hash_types[BCH_SB_STR_HASH_TYPE(sb)]
 805                : "unknown",
 806                BCH_SB_STR_HASH_TYPE(sb),
 807
 808                BCH_SB_INODE_32BIT(sb),
 809                BCH_SB_GC_RESERVE(sb),
 810                BCH_SB_ROOT_RESERVE(sb),
 811
 812                nr_devices, sb->nr_devices,
 813                fields_have_str,
 814                vstruct_bytes(sb));
 815
 816         if (print_layout) {
 817                 printf("\n"
 818                        "Layout:\n");
 819                 bch2_sb_print_layout(sb, units);
 820         }
 821
 822         vstruct_for_each(sb, f) {
 823                 unsigned type = le32_to_cpu(f->type);
 824                 char name[60];
 825
 826                 if (!(fields & (1 << type)))
 827                         continue;
 828
 829                 if (type < BCH_SB_FIELD_NR) {
 830                         scnprintf(name, sizeof(name), "%s", bch2_sb_fields[type]);
 831                         name[0] = toupper(name[0]);
 832                 } else {
 833                         scnprintf(name, sizeof(name), "(unknown field %u)", type);
 834                 }
 835
 836                 printf("\n%s (size %llu):\n", name, vstruct_bytes(f));
 837                 if (type < BCH_SB_FIELD_NR)
 838                         bch2_sb_field_print(sb, f, units);
 839         }
 840 }
 841
 842 /* ioctl interface: */
 843
 844 /* Global control device: */
 845 int bcachectl_open(void)
 846 {
 847         return xopen("/dev/bcachefs-ctl", O_RDWR);
 848 }
 849
 850 /* Filesystem handles (ioctl, sysfs dir): */
 851
 852 #define SYSFS_BASE "/sys/fs/bcachefs/"
 853
 854 void bcache_fs_close(struct bchfs_handle fs)
 855 {
 856         close(fs.ioctl_fd);
 857         close(fs.sysfs_fd);
 858 }
 859
 860 struct bchfs_handle bcache_fs_open(const char *path)
 861 {
 862         struct bchfs_handle ret;
 863
 864         if (!uuid_parse(path, ret.uuid.b)) {
 865                 /* It's a UUID, look it up in sysfs: */
 866                 char *sysfs = mprintf(SYSFS_BASE "%s", path);
 867                 ret.sysfs_fd = xopen(sysfs, O_RDONLY);
 868
 869                 char *minor = read_file_str(ret.sysfs_fd, "minor");
 870                 char *ctl = mprintf("/dev/bcachefs%s-ctl", minor);
 871                 ret.ioctl_fd = xopen(ctl, O_RDWR);
 872
 873                 free(sysfs);
 874                 free(minor);
 875                 free(ctl);
 876         } else {
 877                 /* It's a path: */
 878                 ret.ioctl_fd = xopen(path, O_RDONLY);
 879
 880                 struct bch_ioctl_query_uuid uuid;
 881                 if (ioctl(ret.ioctl_fd, BCH_IOCTL_QUERY_UUID, &uuid) < 0)
 882                         die("error opening %s: not a bcachefs filesystem", path);
 883
 884                 ret.uuid = uuid.uuid;
 885
 886                 char uuid_str[40];
 887                 uuid_unparse(uuid.uuid.b, uuid_str);
 888
 889                 char *sysfs = mprintf(SYSFS_BASE "%s", uuid_str);
 890                 ret.sysfs_fd = xopen(sysfs, O_RDONLY);
 891                 free(sysfs);
 892         }
 893
 894         return ret;
 895 }
 896
 897 /*
 898  * Given a path to a block device, open the filesystem it belongs to; also
 899  * return the device's idx:
 900  */
 901 struct bchfs_handle bchu_fs_open_by_dev(const char *path, unsigned *idx)
 902 {
 903         char buf[1024], *uuid_str;
 904
 905         struct stat stat = xstat(path);
 906
 907         if (!S_ISBLK(stat.st_mode))
 908                 die("%s is not a block device", path);
 909
 910         char *sysfs = mprintf("/sys/dev/block/%u:%u/bcachefs",
 911                               major(stat.st_dev),
 912                               minor(stat.st_dev));
 913         ssize_t len = readlink(sysfs, buf, sizeof(buf));
 914         free(sysfs);
 915
 916         if (len > 0) {
 917                 char *p = strrchr(buf, '/');
 918                 if (!p || sscanf(p + 1, "dev-%u", idx) != 1)
 919                         die("error parsing sysfs");
 920
 921                 *p = '\0';
 922                 p = strrchr(buf, '/');
 923                 uuid_str = p + 1;
 924         } else {
 925                 struct bch_opts opts = bch2_opts_empty();
 926
 927                 opt_set(opts, noexcl,   true);
 928                 opt_set(opts, nochanges, true);
 929
 930                 struct bch_sb_handle sb;
 931                 int ret = bch2_read_super(path, &opts, &sb);
 932                 if (ret)
 933                         die("Error opening %s: %s", path, strerror(-ret));
 934
 935                 *idx = sb.sb->dev_idx;
 936                 uuid_str = buf;
 937                 uuid_unparse(sb.sb->user_uuid.b, uuid_str);
 938
 939                 bch2_free_super(&sb);
 940         }
 941
 942         return bcache_fs_open(uuid_str);
 943 }
 944
 945 int bchu_data(struct bchfs_handle fs, struct bch_ioctl_data cmd)
 946 {
 947         int progress_fd = xioctl(fs.ioctl_fd, BCH_IOCTL_DATA, &cmd);
 948
 949         while (1) {
 950                 struct bch_ioctl_data_event e;
 951
 952                 if (read(progress_fd, &e, sizeof(e)) != sizeof(e))
 953                         die("error reading from progress fd %m");
 954
 955                 if (e.type)
 956                         continue;
 957
 958                 if (e.p.data_type == U8_MAX)
 959                         break;
 960
 961                 printf("\33[2K\r");
 962
 963                 printf("%llu%% complete: current position %s",
 964                        e.p.sectors_total
 965                        ? e.p.sectors_done * 100 / e.p.sectors_total
 966                        : 0,
 967                        bch2_data_types[e.p.data_type]);
 968
 969                 switch (e.p.data_type) {
 970                 case BCH_DATA_btree:
 971                 case BCH_DATA_user:
 972                         printf(" %s:%llu:%llu",
 973                                bch2_btree_ids[e.p.btree_id],
 974                                e.p.pos.inode,
 975                                e.p.pos.offset);
 976                 }
 977
 978                 fflush(stdout);
 979                 sleep(1);
 980         }
 981         printf("\nDone\n");
 982
 983         close(progress_fd);
 984         return 0;
 985 }
 986
 987 /* option parsing */
 988
 989 struct bch_opt_strs bch2_cmdline_opts_get(int *argc, char *argv[],
 990                                           unsigned opt_types)
 991 {
 992         struct bch_opt_strs opts;
 993         unsigned i = 1;
 994
 995         memset(&opts, 0, sizeof(opts));
 996
 997         while (i < *argc) {
 998                 char *optstr = strcmp_prefix(argv[i], "--");
 999                 char *valstr = NULL, *p;
1000                 int optid, nr_args = 1;
1001
1002                 if (!optstr) {
1003                         i++;
1004                         continue;
1005                 }
1006
1007                 optstr = strdup(optstr);
1008
1009                 p = optstr;
1010                 while (isalpha(*p) || *p == '_')
1011                         p++;
1012
1013                 if (*p == '=') {
1014                         *p = '\0';
1015                         valstr = p + 1;
1016                 }
1017
1018                 optid = bch2_opt_lookup(optstr);
1019                 if (optid < 0 ||
1020                     !(bch2_opt_table[optid].mode & opt_types)) {
1021                         free(optstr);
1022                         i++;
1023                         continue;
1024                 }
1025
1026                 if (!valstr &&
1027                     bch2_opt_table[optid].type != BCH_OPT_BOOL) {
1028                         nr_args = 2;
1029                         valstr = argv[i + 1];
1030                 }
1031
1032                 if (!valstr)
1033                         valstr = "1";
1034
1035                 opts.by_id[optid] = valstr;
1036
1037                 *argc -= nr_args;
1038                 memmove(&argv[i],
1039                         &argv[i + nr_args],
1040                         sizeof(char *) * (*argc - i));
1041                 argv[*argc] = NULL;
1042         }
1043
1044         return opts;
1045 }
1046
1047 struct bch_opts bch2_parse_opts(struct bch_opt_strs strs)
1048 {
1049         struct bch_opts opts = bch2_opts_empty();
1050         unsigned i;
1051         int ret;
1052         u64 v;
1053
1054         for (i = 0; i < bch2_opts_nr; i++) {
1055                 if (!strs.by_id[i] ||
1056                     bch2_opt_table[i].type == BCH_OPT_FN)
1057                         continue;
1058
1059                 ret = bch2_opt_parse(NULL, &bch2_opt_table[i],
1060                                      strs.by_id[i], &v);
1061                 if (ret < 0)
1062                         die("Invalid %s: %s",
1063                             bch2_opt_table[i].attr.name,
1064                             strerror(-ret));
1065
1066                 bch2_opt_set_by_id(&opts, i, v);
1067         }
1068
1069         return opts;
1070 }
1071
1072 void bch2_opts_usage(unsigned opt_types)
1073 {
1074         const struct bch_option *opt;
1075         unsigned i, c = 0, helpcol = 30;
1076
1077         void tabalign() {
1078                 while (c < helpcol) {
1079                         putchar(' ');
1080                         c++;
1081                 }
1082         }
1083
1084         void newline() {
1085                 printf("\n");
1086                 c = 0;
1087         }
1088
1089         for (opt = bch2_opt_table;
1090              opt < bch2_opt_table + bch2_opts_nr;
1091              opt++) {
1092                 if (!(opt->mode & opt_types))
1093                         continue;
1094
1095                 c += printf("      --%s", opt->attr.name);
1096
1097                 switch (opt->type) {
1098                 case BCH_OPT_BOOL:
1099                         break;
1100                 case BCH_OPT_STR:
1101                         c += printf("=(");
1102                         for (i = 0; opt->choices[i]; i++) {
1103                                 if (i)
1104                                         c += printf("|");
1105                                 c += printf("%s", opt->choices[i]);
1106                         }
1107                         c += printf(")");
1108                         break;
1109                 default:
1110                         c += printf("=%s", opt->hint);
1111                         break;
1112                 }
1113
1114                 if (opt->help) {
1115                         const char *l = opt->help;
1116
1117                         if (c >= helpcol)
1118                                 newline();
1119
1120                         while (1) {
1121                                 const char *n = strchrnul(l, '\n');
1122
1123                                 tabalign();
1124                                 printf("%.*s", (int) (n - l), l);
1125                                 newline();
1126
1127                                 if (!*n)
1128                                         break;
1129                                 l = n + 1;
1130                         }
1131                 } else {
1132                         newline();
1133                 }
1134         }
1135 }
1136
1137 dev_names bchu_fs_get_devices(struct bchfs_handle fs)
1138 {
1139         DIR *dir = fdopendir(fs.sysfs_fd);
1140         struct dirent *d;
1141         dev_names devs;
1142
1143         darray_init(devs);
1144
1145         while ((errno = 0), (d = readdir(dir))) {
1146                 struct dev_name n = { 0, NULL, NULL };
1147
1148                 if (sscanf(d->d_name, "dev-%u", &n.idx) != 1)
1149                         continue;
1150
1151                 char *block_attr = mprintf("dev-%u/block", n.idx);
1152
1153                 char sysfs_block_buf[4096];
1154                 ssize_t r = readlinkat(fs.sysfs_fd, block_attr,
1155                                        sysfs_block_buf, sizeof(sysfs_block_buf));
1156                 if (r > 0) {
1157                         sysfs_block_buf[r] = '\0';
1158                         n.dev = strdup(basename(sysfs_block_buf));
1159                 }
1160
1161                 free(block_attr);
1162
1163                 char *label_attr = mprintf("dev-%u/label", n.idx);
1164                 n.label = read_file_str(fs.sysfs_fd, label_attr);
1165                 free(label_attr);
1166
1167                 darray_append(devs, n);
1168         }
1169
1170         closedir(dir);
1171
1172         return devs;
1173 }