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 static void init_layout(struct bch_sb_layout *l,
35 u64 sb_start, u64 sb_end)
37 u64 sb_pos = sb_start;
40 memset(l, 0, sizeof(*l));
42 l->magic = BCHFS_MAGIC;
44 l->nr_superblocks = 2;
45 l->sb_max_size_bits = ilog2(sb_size);
47 /* Create two superblocks in the allowed range: */
48 for (i = 0; i < l->nr_superblocks; i++) {
49 if (sb_pos != BCH_SB_SECTOR)
50 sb_pos = round_up(sb_pos, block_size);
52 l->sb_offset[i] = cpu_to_le64(sb_pos);
57 die("insufficient space for superblocks: start %llu end %llu > %llu size %u",
58 sb_start, sb_pos, sb_end, sb_size);
61 /* minimum size filesystem we can create, given a bucket size: */
62 static u64 min_size(unsigned bucket_size)
64 return BCH_MIN_NR_NBUCKETS * bucket_size;
67 u64 bch2_pick_bucket_size(struct bch_opts opts, struct dev_opts *dev)
71 if (dev->size < min_size(opts.block_size))
72 die("cannot format %s, too small (%llu bytes, min %llu)",
73 dev->path, dev->size, min_size(opts.block_size));
75 /* Bucket size must be >= block size: */
76 bucket_size = opts.block_size;
78 /* Bucket size must be >= btree node size: */
79 if (opt_defined(opts, btree_node_size))
80 bucket_size = max_t(unsigned, bucket_size,
81 opts.btree_node_size);
83 /* Want a bucket size of at least 128k, if possible: */
84 bucket_size = max(bucket_size, 128ULL << 10);
86 if (dev->size >= min_size(bucket_size)) {
87 unsigned scale = max(1,
88 ilog2(dev->size / min_size(bucket_size)) / 4);
90 scale = rounddown_pow_of_two(scale);
92 /* max bucket size 1 mb */
93 bucket_size = min(bucket_size * scale, 1ULL << 20);
97 } while (dev->size < min_size(bucket_size));
103 void bch2_check_bucket_size(struct bch_opts opts, struct dev_opts *dev)
105 if (dev->bucket_size < opts.block_size)
106 die("Bucket size (%llu) cannot be smaller than block size (%u)",
107 dev->bucket_size, opts.block_size);
109 if (opt_defined(opts, btree_node_size) &&
110 dev->bucket_size < opts.btree_node_size)
111 die("Bucket size (%llu) cannot be smaller than btree node size (%u)",
112 dev->bucket_size, opts.btree_node_size);
114 if (dev->nbuckets < BCH_MIN_NR_NBUCKETS)
115 die("Not enough buckets: %llu, need %u (bucket size %llu)",
116 dev->nbuckets, BCH_MIN_NR_NBUCKETS, dev->bucket_size);
118 if (dev->bucket_size > (u32) U16_MAX << 9)
119 die("Bucket size (%llu) too big (max %u)",
120 dev->bucket_size, (u32) U16_MAX << 9);
123 static unsigned parse_target(struct bch_sb_handle *sb,
124 struct dev_opts *devs, size_t nr_devs,
133 for (i = devs; i < devs + nr_devs; i++)
134 if (!strcmp(s, i->path))
135 return dev_to_target(i - devs);
137 idx = bch2_disk_path_find(sb, s);
139 return group_to_target(idx);
141 die("Invalid target %s", s);
145 struct bch_sb *bch2_format(struct bch_opt_strs fs_opt_strs,
146 struct bch_opts fs_opts,
147 struct format_opts opts,
148 struct dev_opts *devs,
151 struct bch_sb_handle sb = { NULL };
153 unsigned max_dev_block_size = 0;
155 u64 min_bucket_size = U64_MAX;
157 for (i = devs; i < devs + nr_devs; i++)
158 max_dev_block_size = max(max_dev_block_size, get_blocksize(i->bdev->bd_buffered_fd));
160 /* calculate block size: */
161 if (!opt_defined(fs_opts, block_size)) {
162 opt_set(fs_opts, block_size, max_dev_block_size);
163 } else if (fs_opts.block_size < max_dev_block_size)
164 die("blocksize too small: %u, must be greater than device blocksize %u",
165 fs_opts.block_size, max_dev_block_size);
167 /* get device size, if it wasn't specified: */
168 for (i = devs; i < devs + nr_devs; i++)
170 i->size = get_size(i->bdev->bd_buffered_fd);
172 /* calculate bucket sizes: */
173 for (i = devs; i < devs + nr_devs; i++)
174 min_bucket_size = min(min_bucket_size,
175 i->bucket_size ?: bch2_pick_bucket_size(fs_opts, i));
177 for (i = devs; i < devs + nr_devs; i++)
179 i->bucket_size = min_bucket_size;
181 for (i = devs; i < devs + nr_devs; i++) {
182 i->nbuckets = i->size / i->bucket_size;
183 bch2_check_bucket_size(fs_opts, i);
186 /* calculate btree node size: */
187 if (!opt_defined(fs_opts, btree_node_size)) {
188 /* 256k default btree node size */
189 opt_set(fs_opts, btree_node_size, 256 << 10);
191 for (i = devs; i < devs + nr_devs; i++)
192 fs_opts.btree_node_size =
193 min_t(unsigned, fs_opts.btree_node_size,
197 if (uuid_is_null(opts.uuid.b))
198 uuid_generate(opts.uuid.b);
200 if (bch2_sb_realloc(&sb, 0))
201 die("insufficient memory");
203 sb.sb->version = le16_to_cpu(opts.version);
204 sb.sb->version_min = le16_to_cpu(opts.version);
205 sb.sb->magic = BCHFS_MAGIC;
206 sb.sb->user_uuid = opts.uuid;
207 sb.sb->nr_devices = nr_devs;
209 if (opts.version == bcachefs_metadata_version_current)
210 sb.sb->features[0] |= cpu_to_le64(BCH_SB_FEATURES_ALL);
212 uuid_generate(sb.sb->uuid.b);
217 min(strlen(opts.label), sizeof(sb.sb->label)));
220 opt_id < bch2_opts_nr;
224 v = bch2_opt_defined_by_id(&fs_opts, opt_id)
225 ? bch2_opt_get_by_id(&fs_opts, opt_id)
226 : bch2_opt_get_by_id(&bch2_opts_default, opt_id);
228 __bch2_opt_set_sb(sb.sb, &bch2_opt_table[opt_id], v);
232 if (clock_gettime(CLOCK_REALTIME, &now))
233 die("error getting current time: %m");
235 sb.sb->time_base_lo = cpu_to_le64(now.tv_sec * NSEC_PER_SEC + now.tv_nsec);
236 sb.sb->time_precision = cpu_to_le32(1);
239 struct bch_sb_field_members_v2 *mi =
240 bch2_sb_field_resize(&sb, members_v2,
241 (sizeof(*mi) + sizeof(struct bch_member) *
242 nr_devs) / sizeof(u64));
243 mi->member_bytes = cpu_to_le16(sizeof(struct bch_member));
244 for (i = devs; i < devs + nr_devs; i++) {
245 struct bch_member *m = bch2_members_v2_get_mut(sb.sb, (i - devs));
247 uuid_generate(m->uuid.b);
248 m->nbuckets = cpu_to_le64(i->nbuckets);
250 m->bucket_size = cpu_to_le16(i->bucket_size >> 9);
252 SET_BCH_MEMBER_DISCARD(m, i->discard);
253 SET_BCH_MEMBER_DATA_ALLOWED(m, i->data_allowed);
254 SET_BCH_MEMBER_DURABILITY(m, i->durability + 1);
258 for (i = devs; i < devs + nr_devs; i++) {
259 struct bch_member *m;
265 idx = bch2_disk_path_find_or_create(&sb, i->label);
267 die("error creating disk path: %s", strerror(-idx));
270 * Recompute mi and m after each sb modification: its location
271 * in memory may have changed due to reallocation.
273 m = bch2_members_v2_get_mut(sb.sb, (i - devs));
274 SET_BCH_MEMBER_GROUP(m, idx + 1);
277 SET_BCH_SB_FOREGROUND_TARGET(sb.sb,
278 parse_target(&sb, devs, nr_devs, fs_opt_strs.foreground_target));
279 SET_BCH_SB_BACKGROUND_TARGET(sb.sb,
280 parse_target(&sb, devs, nr_devs, fs_opt_strs.background_target));
281 SET_BCH_SB_PROMOTE_TARGET(sb.sb,
282 parse_target(&sb, devs, nr_devs, fs_opt_strs.promote_target));
283 SET_BCH_SB_METADATA_TARGET(sb.sb,
284 parse_target(&sb, devs, nr_devs, fs_opt_strs.metadata_target));
287 if (opts.encrypted) {
288 struct bch_sb_field_crypt *crypt =
289 bch2_sb_field_resize(&sb, crypt, sizeof(*crypt) / sizeof(u64));
291 bch_sb_crypt_init(sb.sb, crypt, opts.passphrase);
292 SET_BCH_SB_ENCRYPTION_TYPE(sb.sb, 1);
295 bch2_sb_members_cpy_v2_v1(&sb);
297 for (i = devs; i < devs + nr_devs; i++) {
298 u64 size_sectors = i->size >> 9;
300 sb.sb->dev_idx = i - devs;
303 i->sb_offset = BCH_SB_SECTOR;
304 i->sb_end = size_sectors;
307 init_layout(&sb.sb->layout, fs_opts.block_size,
308 opts.superblock_size,
309 i->sb_offset, i->sb_end);
312 * Also create a backup superblock at the end of the disk:
314 * If we're not creating a superblock at the default offset, it
315 * means we're being run from the migrate tool and we could be
316 * overwriting existing data if we write to the end of the disk:
318 if (i->sb_offset == BCH_SB_SECTOR) {
319 struct bch_sb_layout *l = &sb.sb->layout;
320 u64 backup_sb = size_sectors - (1 << l->sb_max_size_bits);
322 backup_sb = rounddown(backup_sb, i->bucket_size >> 9);
323 l->sb_offset[l->nr_superblocks++] = cpu_to_le64(backup_sb);
326 if (i->sb_offset == BCH_SB_SECTOR) {
327 /* Zero start of disk */
328 static const char zeroes[BCH_SB_SECTOR << 9];
330 xpwrite(i->bdev->bd_buffered_fd, zeroes, BCH_SB_SECTOR << 9, 0,
331 "zeroing start of disk");
334 bch2_super_write(i->bdev->bd_buffered_fd, sb.sb);
335 close(i->bdev->bd_buffered_fd);
341 void bch2_super_write(int fd, struct bch_sb *sb)
343 struct nonce nonce = { 0 };
346 for (i = 0; i < sb->layout.nr_superblocks; i++) {
347 sb->offset = sb->layout.sb_offset[i];
349 if (sb->offset == BCH_SB_SECTOR) {
350 /* Write backup layout */
351 xpwrite(fd, &sb->layout, sizeof(sb->layout),
352 BCH_SB_LAYOUT_SECTOR << 9,
356 sb->csum = csum_vstruct(NULL, BCH_SB_CSUM_TYPE(sb), nonce, sb);
357 xpwrite(fd, sb, vstruct_bytes(sb),
358 le64_to_cpu(sb->offset) << 9,
365 struct bch_sb *__bch2_super_read(int fd, u64 sector)
367 struct bch_sb sb, *ret;
369 xpread(fd, &sb, sizeof(sb), sector << 9);
371 if (memcmp(&sb.magic, &BCACHE_MAGIC, sizeof(sb.magic)) &&
372 memcmp(&sb.magic, &BCHFS_MAGIC, sizeof(sb.magic)))
373 die("not a bcachefs superblock");
375 size_t bytes = vstruct_bytes(&sb);
379 xpread(fd, ret, bytes, sector << 9);
384 /* ioctl interface: */
386 /* Global control device: */
387 int bcachectl_open(void)
389 return xopen("/dev/bcachefs-ctl", O_RDWR);
392 /* Filesystem handles (ioctl, sysfs dir): */
394 #define SYSFS_BASE "/sys/fs/bcachefs/"
396 void bcache_fs_close(struct bchfs_handle fs)
402 struct bchfs_handle bcache_fs_open(const char *path)
404 struct bchfs_handle ret;
406 if (!uuid_parse(path, ret.uuid.b)) {
407 /* It's a UUID, look it up in sysfs: */
408 char *sysfs = mprintf(SYSFS_BASE "%s", path);
409 ret.sysfs_fd = xopen(sysfs, O_RDONLY);
411 char *minor = read_file_str(ret.sysfs_fd, "minor");
412 char *ctl = mprintf("/dev/bcachefs%s-ctl", minor);
413 ret.ioctl_fd = xopen(ctl, O_RDWR);
420 ret.ioctl_fd = open(path, O_RDONLY);
421 if (ret.ioctl_fd < 0)
422 die("Error opening filesystem at %s: %m", path);
424 struct bch_ioctl_query_uuid uuid;
425 if (ioctl(ret.ioctl_fd, BCH_IOCTL_QUERY_UUID, &uuid) < 0)
426 die("error opening %s: not a bcachefs filesystem", path);
428 ret.uuid = uuid.uuid;
431 uuid_unparse(uuid.uuid.b, uuid_str);
433 char *sysfs = mprintf(SYSFS_BASE "%s", uuid_str);
434 ret.sysfs_fd = xopen(sysfs, O_RDONLY);
442 * Given a path to a block device, open the filesystem it belongs to; also
443 * return the device's idx:
445 struct bchfs_handle bchu_fs_open_by_dev(const char *path, int *idx)
447 char buf[1024], *uuid_str;
449 struct stat stat = xstat(path);
451 if (!S_ISBLK(stat.st_mode))
452 die("%s is not a block device", path);
454 char *sysfs = mprintf("/sys/dev/block/%u:%u/bcachefs",
457 ssize_t len = readlink(sysfs, buf, sizeof(buf));
461 char *p = strrchr(buf, '/');
462 if (!p || sscanf(p + 1, "dev-%u", idx) != 1)
463 die("error parsing sysfs");
466 p = strrchr(buf, '/');
469 struct bch_opts opts = bch2_opts_empty();
471 opt_set(opts, noexcl, true);
472 opt_set(opts, nochanges, true);
474 struct bch_sb_handle sb;
475 int ret = bch2_read_super(path, &opts, &sb);
477 die("Error opening %s: %s", path, strerror(-ret));
479 *idx = sb.sb->dev_idx;
481 uuid_unparse(sb.sb->user_uuid.b, uuid_str);
483 bch2_free_super(&sb);
486 return bcache_fs_open(uuid_str);
489 int bchu_dev_path_to_idx(struct bchfs_handle fs, const char *dev_path)
492 struct bchfs_handle fs2 = bchu_fs_open_by_dev(dev_path, &idx);
494 if (memcmp(&fs.uuid, &fs2.uuid, sizeof(fs.uuid)))
496 bcache_fs_close(fs2);
500 int bchu_data(struct bchfs_handle fs, struct bch_ioctl_data cmd)
502 int progress_fd = xioctl(fs.ioctl_fd, BCH_IOCTL_DATA, &cmd);
505 struct bch_ioctl_data_event e;
507 if (read(progress_fd, &e, sizeof(e)) != sizeof(e))
508 die("error reading from progress fd %m");
513 if (e.p.data_type == U8_MAX)
518 printf("%llu%% complete: current position %s",
520 ? e.p.sectors_done * 100 / e.p.sectors_total
522 bch2_data_types[e.p.data_type]);
524 switch (e.p.data_type) {
527 printf(" %s:%llu:%llu",
528 bch2_btree_id_str(e.p.btree_id),
544 void bch2_opt_strs_free(struct bch_opt_strs *opts)
548 for (i = 0; i < bch2_opts_nr; i++) {
549 free(opts->by_id[i]);
550 opts->by_id[i] = NULL;
554 struct bch_opt_strs bch2_cmdline_opts_get(int *argc, char *argv[],
557 struct bch_opt_strs opts;
560 memset(&opts, 0, sizeof(opts));
563 char *optstr = strcmp_prefix(argv[i], "--");
564 char *valstr = NULL, *p;
565 int optid, nr_args = 1;
572 optstr = strdup(optstr);
575 while (isalpha(*p) || *p == '_')
583 optid = bch2_opt_lookup(optstr);
585 !(bch2_opt_table[optid].flags & opt_types)) {
591 bch2_opt_table[optid].type != BCH_OPT_BOOL) {
593 valstr = argv[i + 1];
599 opts.by_id[optid] = strdup(valstr);
604 sizeof(char *) * (*argc - i));
613 struct bch_opts bch2_parse_opts(struct bch_opt_strs strs)
615 struct bch_opts opts = bch2_opts_empty();
616 struct printbuf err = PRINTBUF;
621 for (i = 0; i < bch2_opts_nr; i++) {
625 ret = bch2_opt_parse(NULL,
627 strs.by_id[i], &v, &err);
629 die("Invalid option %s", err.buf);
631 bch2_opt_set_by_id(&opts, i, v);
643 void bch2_opts_usage(unsigned opt_types)
645 const struct bch_option *opt;
646 unsigned i, c = 0, helpcol = 30;
650 for (opt = bch2_opt_table;
651 opt < bch2_opt_table + bch2_opts_nr;
653 if (!(opt->flags & opt_types))
656 c += printf(" --%s", opt->attr.name);
663 for (i = 0; opt->choices[i]; i++) {
666 c += printf("%s", opt->choices[i]);
671 c += printf("=%s", opt->hint);
676 const char *l = opt->help;
682 const char *n = strchrnul(l, '\n');
684 while (c < helpcol) {
688 printf("%.*s", (int) (n - l), l);
701 dev_names bchu_fs_get_devices(struct bchfs_handle fs)
703 DIR *dir = fdopendir(fs.sysfs_fd);
709 while ((errno = 0), (d = readdir(dir))) {
710 struct dev_name n = { 0, NULL, NULL };
712 if (sscanf(d->d_name, "dev-%u", &n.idx) != 1)
715 char *block_attr = mprintf("dev-%u/block", n.idx);
717 char sysfs_block_buf[4096];
718 ssize_t r = readlinkat(fs.sysfs_fd, block_attr,
719 sysfs_block_buf, sizeof(sysfs_block_buf));
721 sysfs_block_buf[r] = '\0';
722 n.dev = strdup(basename(sysfs_block_buf));
727 char *label_attr = mprintf("dev-%u/label", n.idx);
728 n.label = read_file_str(fs.sysfs_fd, label_attr);
731 char *durability_attr = mprintf("dev-%u/durability", n.idx);
732 n.durability = read_file_u64(fs.sysfs_fd, durability_attr);
733 free(durability_attr);
735 darray_push(&devs, n);