11 #include <sys/sysmacros.h>
12 #include <sys/types.h>
16 #include <uuid/uuid.h>
18 #include "libbcachefs.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"
30 #define NSEC_PER_SEC 1000000000L
32 /* minimum size filesystem we can create, given a bucket size: */
33 static u64 min_size(unsigned bucket_size)
35 return BCH_MIN_NR_NBUCKETS * bucket_size;
38 static void init_layout(struct bch_sb_layout *l, unsigned block_size,
42 u64 backup; /* offset of 2nd sb */
44 memset(l, 0, sizeof(*l));
46 if (start != BCH_SB_SECTOR)
47 start = round_up(start, block_size);
48 end = round_down(end, block_size);
51 die("insufficient space for superblocks");
54 * Create two superblocks in the allowed range: reserve a maximum of 64k
56 sb_size = min_t(u64, 128, end - start / 2);
58 backup = start + sb_size;
59 backup = round_up(backup, block_size);
61 backup = min(backup, end);
63 sb_size = min(end - backup, backup- start);
64 sb_size = rounddown_pow_of_two(sb_size);
67 die("insufficient space for superblocks");
69 l->magic = BCACHE_MAGIC;
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);
77 void bch2_pick_bucket_size(struct bch_opts opts, struct dev_opts *dev)
79 if (!dev->sb_offset) {
80 dev->sb_offset = BCH_SB_SECTOR;
81 dev->sb_end = BCH_SB_SECTOR + 256;
85 dev->size = get_size(dev->path, dev->fd) >> 9;
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));
92 /* Bucket size must be >= block size: */
93 dev->bucket_size = opts.block_size;
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);
100 /* Want a bucket size of at least 128k, if possible: */
101 dev->bucket_size = max(dev->bucket_size, 256U);
103 if (dev->size >= min_size(dev->bucket_size)) {
104 unsigned scale = max(1,
105 ilog2(dev->size / min_size(dev->bucket_size)) / 4);
107 scale = rounddown_pow_of_two(scale);
109 /* max bucket size 1 mb */
110 dev->bucket_size = min(dev->bucket_size * scale, 1U << 11);
113 dev->bucket_size /= 2;
114 } while (dev->size < min_size(dev->bucket_size));
118 dev->nbuckets = dev->size / dev->bucket_size;
120 if (dev->bucket_size < opts.block_size)
121 die("Bucket size cannot be smaller than block size");
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");
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);
133 static unsigned parse_target(struct bch_sb_handle *sb,
134 struct dev_opts *devs, size_t nr_devs,
143 for (i = devs; i < devs + nr_devs; i++)
144 if (!strcmp(s, i->path))
145 return dev_to_target(i - devs);
147 idx = bch2_disk_path_find(sb, s);
149 return group_to_target(idx);
151 die("Invalid target %s", s);
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,
161 struct bch_sb_handle sb = { NULL };
163 struct bch_sb_field_members *mi;
164 unsigned max_dev_block_size = 0;
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));
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);
178 /* calculate bucket sizes: */
179 for (i = devs; i < devs + nr_devs; i++)
180 bch2_pick_bucket_size(fs_opts, i);
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);
187 for (i = devs; i < devs + nr_devs; i++)
188 fs_opts.btree_node_size =
189 min_t(unsigned, fs_opts.btree_node_size,
193 if (!is_power_of_2(fs_opts.block_size))
194 die("block size must be power of 2");
196 if (!is_power_of_2(fs_opts.btree_node_size))
197 die("btree node size must be power of 2");
199 if (uuid_is_null(opts.uuid.b))
200 uuid_generate(opts.uuid.b);
202 if (bch2_sb_realloc(&sb, 0))
203 die("insufficient memory");
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;
212 uuid_generate(sb.sb->uuid.b);
217 min(strlen(opts.label), sizeof(sb.sb->label)));
220 opt_id < bch2_opts_nr;
222 const struct bch_option *opt = &bch2_opt_table[opt_id];
225 if (opt->set_sb == SET_NO_SB_OPT)
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);
232 opt->set_sb(sb.sb, v);
235 SET_BCH_SB_ENCODED_EXTENT_MAX_BITS(sb.sb,
236 ilog2(opts.encoded_extent_max));
239 if (clock_gettime(CLOCK_REALTIME, &now))
240 die("error getting current time: %m");
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);
246 mi = bch2_sb_resize_members(&sb,
247 (sizeof(*mi) + sizeof(struct bch_member) *
248 nr_devs) / sizeof(u64));
250 for (i = devs; i < devs + nr_devs; i++) {
251 struct bch_member *m = mi->members + (i - devs);
253 uuid_generate(m->uuid.b);
254 m->nbuckets = cpu_to_le64(i->nbuckets);
256 m->bucket_size = cpu_to_le16(i->bucket_size);
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);
265 for (i = devs; i < devs + nr_devs; i++) {
266 struct bch_member *m = mi->members + (i - devs);
272 idx = bch2_disk_path_find_or_create(&sb, i->group);
274 die("error creating disk path: %s", idx);
276 SET_BCH_MEMBER_GROUP(m, idx + 1);
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 SET_BCH_SB_METADATA_TARGET(sb.sb,
286 parse_target(&sb, devs, nr_devs, fs_opt_strs.metadata_target));
289 if (opts.encrypted) {
290 struct bch_sb_field_crypt *crypt =
291 bch2_sb_resize_crypt(&sb, sizeof(*crypt) / sizeof(u64));
293 bch_sb_crypt_init(sb.sb, crypt, opts.passphrase);
294 SET_BCH_SB_ENCRYPTION_TYPE(sb.sb, 1);
297 for (i = devs; i < devs + nr_devs; i++) {
298 sb.sb->dev_idx = i - devs;
300 init_layout(&sb.sb->layout, fs_opts.block_size,
301 i->sb_offset, i->sb_end);
303 if (i->sb_offset == BCH_SB_SECTOR) {
304 /* Zero start of disk */
305 static const char zeroes[BCH_SB_SECTOR << 9];
307 xpwrite(i->fd, zeroes, BCH_SB_SECTOR << 9, 0);
310 bch2_super_write(i->fd, sb.sb);
317 void bch2_super_write(int fd, struct bch_sb *sb)
319 struct nonce nonce = { 0 };
322 for (i = 0; i < sb->layout.nr_superblocks; i++) {
323 sb->offset = sb->layout.sb_offset[i];
325 if (sb->offset == BCH_SB_SECTOR) {
326 /* Write backup layout */
327 xpwrite(fd, &sb->layout, sizeof(sb->layout),
328 BCH_SB_LAYOUT_SECTOR << 9);
331 sb->csum = csum_vstruct(NULL, BCH_SB_CSUM_TYPE(sb), nonce, sb);
332 xpwrite(fd, sb, vstruct_bytes(sb),
333 le64_to_cpu(sb->offset) << 9);
339 struct bch_sb *__bch2_super_read(int fd, u64 sector)
341 struct bch_sb sb, *ret;
343 xpread(fd, &sb, sizeof(sb), sector << 9);
345 if (memcmp(&sb.magic, &BCACHE_MAGIC, sizeof(sb.magic)))
346 die("not a bcachefs superblock");
348 size_t bytes = vstruct_bytes(&sb);
352 xpread(fd, ret, bytes, sector << 9);
357 static unsigned get_dev_has_data(struct bch_sb *sb, unsigned dev)
359 struct bch_sb_field_replicas *replicas;
360 struct bch_replicas_entry *r;
361 unsigned i, data_has = 0;
363 replicas = bch2_sb_get_replicas(sb);
366 for_each_replicas_entry(replicas, r)
367 for (i = 0; i < r->nr_devs; i++)
368 if (r->devs[i] == dev)
369 data_has |= 1 << r->data_type;
374 static int bch2_sb_get_target(struct bch_sb *sb, char *buf, size_t len, u64 v)
376 struct target t = target_decode(v);
381 return scnprintf(buf, len, "none");
383 struct bch_sb_field_members *mi = bch2_sb_get_members(sb);
384 struct bch_member *m = mi->members + t.dev;
386 if (bch2_dev_exists(sb, mi, t.dev)) {
389 uuid_unparse(m->uuid.b, uuid_str);
391 ret = scnprintf(buf, len, "Device %u (%s)", t.dev,
394 ret = scnprintf(buf, len, "Bad device %u", t.dev);
400 struct bch_sb_field_disk_groups *gi;
401 gi = bch2_sb_get_disk_groups(sb);
403 struct bch_disk_group *g = gi->entries + t.group;
405 if (t.group < disk_groups_nr(gi) && !BCH_GROUP_DELETED(g)) {
406 ret = scnprintf(buf, len, "Group %u (%.*s)", t.group,
407 BCH_SB_LABEL_SIZE, g->label);
409 ret = scnprintf(buf, len, "Bad group %u", t.group);
420 /* superblock printing: */
422 static void bch2_sb_print_layout(struct bch_sb *sb, enum units units)
424 struct bch_sb_layout *l = &sb->layout;
428 " superblock max size: %s\n"
429 " nr superblocks: %u\n"
432 pr_units(1 << l->sb_max_size_bits, units),
435 for (i = 0; i < l->nr_superblocks; i++) {
438 printf("%llu", le64_to_cpu(l->sb_offset[i]));
443 static void bch2_sb_print_journal(struct bch_sb *sb, struct bch_sb_field *f,
446 struct bch_sb_field_journal *journal = field_to_type(f, journal);
447 unsigned i, nr = bch2_nr_journal_buckets(journal);
449 printf(" Buckets: ");
450 for (i = 0; i < nr; i++) {
453 printf("%llu", le64_to_cpu(journal->buckets[i]));
458 static void bch2_sb_print_members(struct bch_sb *sb, struct bch_sb_field *f,
461 struct bch_sb_field_members *mi = field_to_type(f, members);
462 struct bch_sb_field_disk_groups *gi = bch2_sb_get_disk_groups(sb);
465 for (i = 0; i < sb->nr_devices; i++) {
466 struct bch_member *m = mi->members + i;
467 time_t last_mount = le64_to_cpu(m->last_mount);
468 char member_uuid_str[40];
469 char data_allowed_str[100];
470 char data_has_str[100];
471 char group[BCH_SB_LABEL_SIZE+10];
474 if (!bch2_member_exists(m))
477 uuid_unparse(m->uuid.b, member_uuid_str);
479 if (BCH_MEMBER_GROUP(m)) {
480 unsigned idx = BCH_MEMBER_GROUP(m) - 1;
482 if (idx < disk_groups_nr(gi)) {
483 snprintf(group, sizeof(group), "%.*s (%u)",
485 gi->entries[idx].label, idx);
487 strcpy(group, "(bad disk groups section)");
490 strcpy(group, "(none)");
493 bch2_flags_to_text(&PBUF(data_allowed_str),
495 BCH_MEMBER_DATA_ALLOWED(m));
496 if (!data_allowed_str[0])
497 strcpy(data_allowed_str, "(none)");
499 bch2_flags_to_text(&PBUF(data_has_str),
501 get_dev_has_data(sb, i));
502 if (!data_has_str[0])
503 strcpy(data_has_str, "(none)");
506 struct tm *tm = localtime(&last_mount);
507 size_t err = strftime(time_str, sizeof(time_str), "%c", tm);
509 strcpy(time_str, "(formatting error)");
511 strcpy(time_str, "(never)");
514 printf(" Device %u:\n"
518 " First bucket: %u\n"
523 " Data allowed: %s\n"
527 " Replacement policy: %s\n"
530 pr_units(le16_to_cpu(m->bucket_size) *
531 le64_to_cpu(m->nbuckets), units),
532 pr_units(le16_to_cpu(m->bucket_size), units),
533 le16_to_cpu(m->first_bucket),
534 le64_to_cpu(m->nbuckets),
537 BCH_MEMBER_STATE(m) < BCH_MEMBER_STATE_NR
538 ? bch2_dev_state[BCH_MEMBER_STATE(m)]
545 BCH_MEMBER_REPLACEMENT(m) < CACHE_REPLACEMENT_NR
546 ? bch2_cache_replacement_policies[BCH_MEMBER_REPLACEMENT(m)]
549 BCH_MEMBER_DISCARD(m));
553 static void bch2_sb_print_crypt(struct bch_sb *sb, struct bch_sb_field *f,
556 struct bch_sb_field_crypt *crypt = field_to_type(f, crypt);
558 printf(" KFD: %llu\n"
562 BCH_CRYPT_KDF_TYPE(crypt),
563 BCH_KDF_SCRYPT_N(crypt),
564 BCH_KDF_SCRYPT_R(crypt),
565 BCH_KDF_SCRYPT_P(crypt));
568 static void bch2_sb_print_replicas_v0(struct bch_sb *sb, struct bch_sb_field *f,
571 struct bch_sb_field_replicas_v0 *replicas = field_to_type(f, replicas_v0);
572 struct bch_replicas_entry_v0 *e;
575 for_each_replicas_entry(replicas, e) {
576 printf_pad(32, " %s:", bch2_data_types[e->data_type]);
579 for (i = 0; i < e->nr_devs; i++) {
582 printf("%u", e->devs[i]);
588 static void bch2_sb_print_replicas(struct bch_sb *sb, struct bch_sb_field *f,
591 struct bch_sb_field_replicas *replicas = field_to_type(f, replicas);
592 struct bch_replicas_entry *e;
595 for_each_replicas_entry(replicas, e) {
596 printf_pad(32, " %s: %u/%u",
597 bch2_data_types[e->data_type],
602 for (i = 0; i < e->nr_devs; i++) {
605 printf("%u", e->devs[i]);
611 static void bch2_sb_print_quota(struct bch_sb *sb, struct bch_sb_field *f,
616 static void bch2_sb_print_disk_groups(struct bch_sb *sb, struct bch_sb_field *f,
621 static void bch2_sb_print_clean(struct bch_sb *sb, struct bch_sb_field *f,
624 struct bch_sb_field_clean *clean = field_to_type(f, clean);
627 printf(" flags: %x", le32_to_cpu(clean->flags));
628 printf(" journal seq: %llx", le64_to_cpu(clean->journal_seq));
631 static void bch2_sb_print_journal_seq_blacklist(struct bch_sb *sb, struct bch_sb_field *f,
634 struct bch_sb_field_journal_seq_blacklist *bl = field_to_type(f, journal_seq_blacklist);
635 unsigned i, nr = blacklist_nr_entries(bl);
637 for (i = 0; i < nr; i++) {
638 struct journal_seq_blacklist_entry *e =
641 printf(" %llu-%llu\n",
642 le64_to_cpu(e->start),
643 le64_to_cpu(e->end));
647 typedef void (*sb_field_print_fn)(struct bch_sb *, struct bch_sb_field *, enum units);
649 struct bch_sb_field_toolops {
650 sb_field_print_fn print;
653 static const struct bch_sb_field_toolops bch2_sb_field_ops[] = {
655 [BCH_SB_FIELD_##f] = { \
656 .print = bch2_sb_print_##f, \
662 static inline void bch2_sb_field_print(struct bch_sb *sb,
663 struct bch_sb_field *f,
666 unsigned type = le32_to_cpu(f->type);
668 if (type < BCH_SB_FIELD_NR)
669 bch2_sb_field_ops[type].print(sb, f, units);
671 printf("(unknown field %u)\n", type);
674 void bch2_sb_print(struct bch_sb *sb, bool print_layout,
675 unsigned fields, enum units units)
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];
683 char foreground_str[64];
684 char background_str[64];
685 char promote_str[64];
686 char metadata_str[64];
687 struct bch_sb_field *f;
689 unsigned nr_devices = 0;
690 time_t time_base = le64_to_cpu(sb->time_base_lo) / NSEC_PER_SEC;
692 memcpy(label, sb->label, BCH_SB_LABEL_SIZE);
693 label[BCH_SB_LABEL_SIZE] = '\0';
695 uuid_unparse(sb->user_uuid.b, user_uuid_str);
696 uuid_unparse(sb->uuid.b, internal_uuid_str);
699 struct tm *tm = localtime(&time_base);
700 size_t err = strftime(time_str, sizeof(time_str), "%c", tm);
702 strcpy(time_str, "(formatting error)");
704 strcpy(time_str, "(not set)");
707 mi = bch2_sb_get_members(sb);
709 struct bch_member *m;
711 for (m = mi->members;
712 m < mi->members + sb->nr_devices;
714 nr_devices += bch2_member_exists(m);
717 bch2_sb_get_target(sb, foreground_str, sizeof(foreground_str),
718 BCH_SB_FOREGROUND_TARGET(sb));
720 bch2_sb_get_target(sb, background_str, sizeof(background_str),
721 BCH_SB_BACKGROUND_TARGET(sb));
723 bch2_sb_get_target(sb, promote_str, sizeof(promote_str),
724 BCH_SB_PROMOTE_TARGET(sb));
726 bch2_sb_get_target(sb, metadata_str, sizeof(metadata_str),
727 BCH_SB_METADATA_TARGET(sb));
729 bch2_flags_to_text(&PBUF(features_str),
731 le64_to_cpu(sb->features[0]));
733 vstruct_for_each(sb, f)
734 fields_have |= 1 << le32_to_cpu(f->type);
735 bch2_flags_to_text(&PBUF(fields_have_str),
736 bch2_sb_fields, fields_have);
738 printf("External UUID: %s\n"
739 "Internal UUID: %s\n"
744 "Squence number: %llu\n"
746 "Btree node size: %s\n"
751 "Metadata replicas: %llu\n"
752 "Data replicas: %llu\n"
754 "Metadata checksum type: %s (%llu)\n"
755 "Data checksum type: %s (%llu)\n"
756 "Compression type: %s (%llu)\n"
758 "Foreground write target: %s\n"
759 "Background write target: %s\n"
760 "Promote target: %s\n"
761 "Metadata target: %s\n"
763 "String hash type: %s (%llu)\n"
764 "32 bit inodes: %llu\n"
765 "GC reserve percentage: %llu%%\n"
766 "Root reserve percentage: %llu%%\n"
768 "Devices: %u live, %u total\n"
770 "Superblock size: %llu\n",
775 le64_to_cpu(sb->version),
777 le64_to_cpu(sb->seq),
778 pr_units(le16_to_cpu(sb->block_size), units),
779 pr_units(BCH_SB_BTREE_NODE_SIZE(sb), units),
781 BCH_SB_ERROR_ACTION(sb) < BCH_NR_ERROR_ACTIONS
782 ? bch2_error_actions[BCH_SB_ERROR_ACTION(sb)]
788 BCH_SB_META_REPLICAS_WANT(sb),
789 BCH_SB_DATA_REPLICAS_WANT(sb),
791 BCH_SB_META_CSUM_TYPE(sb) < BCH_CSUM_OPT_NR
792 ? bch2_csum_opts[BCH_SB_META_CSUM_TYPE(sb)]
794 BCH_SB_META_CSUM_TYPE(sb),
796 BCH_SB_DATA_CSUM_TYPE(sb) < BCH_CSUM_OPT_NR
797 ? bch2_csum_opts[BCH_SB_DATA_CSUM_TYPE(sb)]
799 BCH_SB_DATA_CSUM_TYPE(sb),
801 BCH_SB_COMPRESSION_TYPE(sb) < BCH_COMPRESSION_OPT_NR
802 ? bch2_compression_opts[BCH_SB_COMPRESSION_TYPE(sb)]
804 BCH_SB_COMPRESSION_TYPE(sb),
811 BCH_SB_STR_HASH_TYPE(sb) < BCH_STR_HASH_NR
812 ? bch2_str_hash_types[BCH_SB_STR_HASH_TYPE(sb)]
814 BCH_SB_STR_HASH_TYPE(sb),
816 BCH_SB_INODE_32BIT(sb),
817 BCH_SB_GC_RESERVE(sb),
818 BCH_SB_ROOT_RESERVE(sb),
820 nr_devices, sb->nr_devices,
827 bch2_sb_print_layout(sb, units);
830 vstruct_for_each(sb, f) {
831 unsigned type = le32_to_cpu(f->type);
834 if (!(fields & (1 << type)))
837 if (type < BCH_SB_FIELD_NR) {
838 scnprintf(name, sizeof(name), "%s", bch2_sb_fields[type]);
839 name[0] = toupper(name[0]);
841 scnprintf(name, sizeof(name), "(unknown field %u)", type);
844 printf("\n%s (size %llu):\n", name, vstruct_bytes(f));
845 if (type < BCH_SB_FIELD_NR)
846 bch2_sb_field_print(sb, f, units);
850 /* ioctl interface: */
852 /* Global control device: */
853 int bcachectl_open(void)
855 return xopen("/dev/bcachefs-ctl", O_RDWR);
858 /* Filesystem handles (ioctl, sysfs dir): */
860 #define SYSFS_BASE "/sys/fs/bcachefs/"
862 void bcache_fs_close(struct bchfs_handle fs)
868 struct bchfs_handle bcache_fs_open(const char *path)
870 struct bchfs_handle ret;
872 if (!uuid_parse(path, ret.uuid.b)) {
873 /* It's a UUID, look it up in sysfs: */
874 char *sysfs = mprintf(SYSFS_BASE "%s", path);
875 ret.sysfs_fd = xopen(sysfs, O_RDONLY);
877 char *minor = read_file_str(ret.sysfs_fd, "minor");
878 char *ctl = mprintf("/dev/bcachefs%s-ctl", minor);
879 ret.ioctl_fd = xopen(ctl, O_RDWR);
886 ret.ioctl_fd = xopen(path, O_RDONLY);
888 struct bch_ioctl_query_uuid uuid;
889 if (ioctl(ret.ioctl_fd, BCH_IOCTL_QUERY_UUID, &uuid) < 0)
890 die("error opening %s: not a bcachefs filesystem", path);
892 ret.uuid = uuid.uuid;
895 uuid_unparse(uuid.uuid.b, uuid_str);
897 char *sysfs = mprintf(SYSFS_BASE "%s", uuid_str);
898 ret.sysfs_fd = xopen(sysfs, O_RDONLY);
906 * Given a path to a block device, open the filesystem it belongs to; also
907 * return the device's idx:
909 struct bchfs_handle bchu_fs_open_by_dev(const char *path, unsigned *idx)
911 char buf[1024], *uuid_str;
913 struct stat stat = xstat(path);
915 if (!S_ISBLK(stat.st_mode))
916 die("%s is not a block device", path);
918 char *sysfs = mprintf("/sys/dev/block/%u:%u/bcachefs",
921 ssize_t len = readlink(sysfs, buf, sizeof(buf));
925 char *p = strrchr(buf, '/');
926 if (!p || sscanf(p + 1, "dev-%u", idx) != 1)
927 die("error parsing sysfs");
930 p = strrchr(buf, '/');
933 struct bch_opts opts = bch2_opts_empty();
935 opt_set(opts, noexcl, true);
936 opt_set(opts, nochanges, true);
938 struct bch_sb_handle sb;
939 int ret = bch2_read_super(path, &opts, &sb);
941 die("Error opening %s: %s", path, strerror(-ret));
943 *idx = sb.sb->dev_idx;
945 uuid_unparse(sb.sb->user_uuid.b, uuid_str);
947 bch2_free_super(&sb);
950 return bcache_fs_open(uuid_str);
953 int bchu_data(struct bchfs_handle fs, struct bch_ioctl_data cmd)
955 int progress_fd = xioctl(fs.ioctl_fd, BCH_IOCTL_DATA, &cmd);
958 struct bch_ioctl_data_event e;
960 if (read(progress_fd, &e, sizeof(e)) != sizeof(e))
961 die("error reading from progress fd %m");
966 if (e.p.data_type == U8_MAX)
971 printf("%llu%% complete: current position %s",
973 ? e.p.sectors_done * 100 / e.p.sectors_total
975 bch2_data_types[e.p.data_type]);
977 switch (e.p.data_type) {
980 printf(" %s:%llu:%llu",
981 bch2_btree_ids[e.p.btree_id],
997 struct bch_opt_strs bch2_cmdline_opts_get(int *argc, char *argv[],
1000 struct bch_opt_strs opts;
1003 memset(&opts, 0, sizeof(opts));
1006 char *optstr = strcmp_prefix(argv[i], "--");
1007 char *valstr = NULL, *p;
1008 int optid, nr_args = 1;
1015 optstr = strdup(optstr);
1018 while (isalpha(*p) || *p == '_')
1026 optid = bch2_opt_lookup(optstr);
1028 !(bch2_opt_table[optid].mode & opt_types)) {
1035 bch2_opt_table[optid].type != BCH_OPT_BOOL) {
1037 valstr = argv[i + 1];
1043 opts.by_id[optid] = valstr;
1048 sizeof(char *) * (*argc - i));
1055 struct bch_opts bch2_parse_opts(struct bch_opt_strs strs)
1057 struct bch_opts opts = bch2_opts_empty();
1062 for (i = 0; i < bch2_opts_nr; i++) {
1063 if (!strs.by_id[i] ||
1064 bch2_opt_table[i].type == BCH_OPT_FN)
1067 ret = bch2_opt_parse(NULL, &bch2_opt_table[i],
1070 die("Invalid %s: %s",
1071 bch2_opt_table[i].attr.name,
1074 bch2_opt_set_by_id(&opts, i, v);
1080 void bch2_opts_usage(unsigned opt_types)
1082 const struct bch_option *opt;
1083 unsigned i, c = 0, helpcol = 30;
1086 while (c < helpcol) {
1097 for (opt = bch2_opt_table;
1098 opt < bch2_opt_table + bch2_opts_nr;
1100 if (!(opt->mode & opt_types))
1103 c += printf(" --%s", opt->attr.name);
1105 switch (opt->type) {
1110 for (i = 0; opt->choices[i]; i++) {
1113 c += printf("%s", opt->choices[i]);
1118 c += printf("=%s", opt->hint);
1123 const char *l = opt->help;
1129 const char *n = strchrnul(l, '\n');
1132 printf("%.*s", (int) (n - l), l);
1145 dev_names bchu_fs_get_devices(struct bchfs_handle fs)
1147 DIR *dir = fdopendir(fs.sysfs_fd);
1153 while ((errno = 0), (d = readdir(dir))) {
1154 struct dev_name n = { 0, NULL, NULL };
1156 if (sscanf(d->d_name, "dev-%u", &n.idx) != 1)
1159 char *block_attr = mprintf("dev-%u/block", n.idx);
1161 char sysfs_block_buf[4096];
1162 ssize_t r = readlinkat(fs.sysfs_fd, block_attr,
1163 sysfs_block_buf, sizeof(sysfs_block_buf));
1165 sysfs_block_buf[r] = '\0';
1166 n.dev = strdup(basename(sysfs_block_buf));
1171 char *label_attr = mprintf("dev-%u/label", n.idx);
1172 n.label = read_file_str(fs.sysfs_fd, label_attr);
1175 darray_append(devs, n);