10 #include <sys/types.h>
14 #include <uuid/uuid.h>
16 #include "libbcachefs/bcachefs_format.h"
17 #include "libbcachefs/checksum.h"
19 #include "libbcachefs.h"
20 #include "libbcachefs/opts.h"
21 #include "libbcachefs/super-io.h"
23 #define NSEC_PER_SEC 1000000000L
25 #define BCH_MIN_NR_NBUCKETS (1 << 10)
27 /* minimum size filesystem we can create, given a bucket size: */
28 static u64 min_size(unsigned bucket_size)
30 return BCH_MIN_NR_NBUCKETS * bucket_size;
33 static void init_layout(struct bch_sb_layout *l, unsigned block_size,
37 u64 backup; /* offset of 2nd sb */
39 memset(l, 0, sizeof(*l));
41 if (start != BCH_SB_SECTOR)
42 start = round_up(start, block_size);
43 end = round_down(end, block_size);
46 die("insufficient space for superblocks");
49 * Create two superblocks in the allowed range: reserve a maximum of 64k
51 sb_size = min_t(u64, 128, end - start / 2);
53 backup = start + sb_size;
54 backup = round_up(backup, block_size);
56 backup = min(backup, end);
58 sb_size = min(end - backup, backup- start);
59 sb_size = rounddown_pow_of_two(sb_size);
62 die("insufficient space for superblocks");
64 l->magic = BCACHE_MAGIC;
66 l->nr_superblocks = 2;
67 l->sb_max_size_bits = ilog2(sb_size);
68 l->sb_offset[0] = cpu_to_le64(start);
69 l->sb_offset[1] = cpu_to_le64(backup);
72 void bch2_pick_bucket_size(struct format_opts opts, struct dev_opts *dev)
74 if (!dev->sb_offset) {
75 dev->sb_offset = BCH_SB_SECTOR;
76 dev->sb_end = BCH_SB_SECTOR + 256;
80 dev->size = get_size(dev->path, dev->fd) >> 9;
82 if (!dev->bucket_size) {
83 if (dev->size < min_size(opts.block_size))
84 die("cannot format %s, too small (%llu sectors, min %llu)",
85 dev->path, dev->size, min_size(opts.block_size));
87 /* Bucket size must be >= block size: */
88 dev->bucket_size = opts.block_size;
90 /* Bucket size must be >= btree node size: */
91 dev->bucket_size = max(dev->bucket_size, opts.btree_node_size);
93 /* Want a bucket size of at least 128k, if possible: */
94 dev->bucket_size = max(dev->bucket_size, 256U);
96 if (dev->size >= min_size(dev->bucket_size)) {
97 unsigned scale = max(1,
98 ilog2(dev->size / min_size(dev->bucket_size)) / 4);
100 scale = rounddown_pow_of_two(scale);
102 /* max bucket size 1 mb */
103 dev->bucket_size = min(dev->bucket_size * scale, 1U << 11);
106 dev->bucket_size /= 2;
107 } while (dev->size < min_size(dev->bucket_size));
111 dev->nbuckets = dev->size / dev->bucket_size;
113 if (dev->bucket_size < opts.block_size)
114 die("Bucket size cannot be smaller than block size");
116 if (dev->bucket_size < opts.btree_node_size)
117 die("Bucket size cannot be smaller than btree node size");
119 if (dev->nbuckets < BCH_MIN_NR_NBUCKETS)
120 die("Not enough buckets: %llu, need %u (bucket size %u)",
121 dev->nbuckets, BCH_MIN_NR_NBUCKETS, dev->bucket_size);
125 struct bch_sb *bch2_format(struct format_opts opts,
126 struct dev_opts *devs, size_t nr_devs)
130 struct bch_sb_field_members *mi;
133 /* calculate block size: */
134 if (!opts.block_size)
135 for (i = devs; i < devs + nr_devs; i++)
136 opts.block_size = max(opts.block_size,
137 get_blocksize(i->path, i->fd));
139 /* calculate bucket sizes: */
140 for (i = devs; i < devs + nr_devs; i++)
141 bch2_pick_bucket_size(opts, i);
143 /* calculate btree node size: */
144 if (!opts.btree_node_size) {
145 /* 256k default btree node size */
146 opts.btree_node_size = 512;
148 for (i = devs; i < devs + nr_devs; i++)
149 opts.btree_node_size =
150 min(opts.btree_node_size, i->bucket_size);
153 if (!is_power_of_2(opts.block_size))
154 die("block size must be power of 2");
156 if (!is_power_of_2(opts.btree_node_size))
157 die("btree node size must be power of 2");
159 if (uuid_is_null(opts.uuid.b))
160 uuid_generate(opts.uuid.b);
162 sb = calloc(1, sizeof(*sb) +
163 sizeof(struct bch_sb_field_members) +
164 sizeof(struct bch_member) * nr_devs +
165 sizeof(struct bch_sb_field_crypt));
167 sb->version = cpu_to_le64(BCH_SB_VERSION_MAX);
168 sb->magic = BCACHE_MAGIC;
169 sb->block_size = cpu_to_le16(opts.block_size);
170 sb->user_uuid = opts.uuid;
171 sb->nr_devices = nr_devs;
173 uuid_generate(sb->uuid.b);
176 strncpy((char *) sb->label, opts.label, sizeof(sb->label));
178 SET_BCH_SB_CSUM_TYPE(sb, opts.meta_csum_type);
179 SET_BCH_SB_META_CSUM_TYPE(sb, opts.meta_csum_type);
180 SET_BCH_SB_DATA_CSUM_TYPE(sb, opts.data_csum_type);
181 SET_BCH_SB_COMPRESSION_TYPE(sb, opts.compression_type);
183 SET_BCH_SB_BTREE_NODE_SIZE(sb, opts.btree_node_size);
184 SET_BCH_SB_GC_RESERVE(sb, 8);
185 SET_BCH_SB_META_REPLICAS_WANT(sb, opts.meta_replicas);
186 SET_BCH_SB_META_REPLICAS_REQ(sb, opts.meta_replicas_required);
187 SET_BCH_SB_DATA_REPLICAS_WANT(sb, opts.data_replicas);
188 SET_BCH_SB_DATA_REPLICAS_REQ(sb, opts.data_replicas_required);
189 SET_BCH_SB_ERROR_ACTION(sb, opts.on_error_action);
190 SET_BCH_SB_STR_HASH_TYPE(sb, BCH_STR_HASH_SIPHASH);
191 SET_BCH_SB_ENCODED_EXTENT_MAX_BITS(sb, ilog2(opts.encoded_extent_max));
193 SET_BCH_SB_POSIX_ACL(sb, 1);
196 if (clock_gettime(CLOCK_REALTIME, &now))
197 die("error getting current time: %m");
199 sb->time_base_lo = cpu_to_le64(now.tv_sec * NSEC_PER_SEC + now.tv_nsec);
200 sb->time_precision = cpu_to_le32(1);
202 if (opts.encrypted) {
203 struct bch_sb_field_crypt *crypt = vstruct_end(sb);
205 u64s = sizeof(struct bch_sb_field_crypt) / sizeof(u64);
207 le32_add_cpu(&sb->u64s, u64s);
208 crypt->field.u64s = cpu_to_le32(u64s);
209 crypt->field.type = BCH_SB_FIELD_crypt;
211 bch_sb_crypt_init(sb, crypt, opts.passphrase);
212 SET_BCH_SB_ENCRYPTION_TYPE(sb, 1);
215 mi = vstruct_end(sb);
216 u64s = (sizeof(struct bch_sb_field_members) +
217 sizeof(struct bch_member) * nr_devs) / sizeof(u64);
219 le32_add_cpu(&sb->u64s, u64s);
220 mi->field.u64s = cpu_to_le32(u64s);
221 mi->field.type = BCH_SB_FIELD_members;
223 for (i = devs; i < devs + nr_devs; i++) {
224 struct bch_member *m = mi->members + (i - devs);
226 uuid_generate(m->uuid.b);
227 m->nbuckets = cpu_to_le64(i->nbuckets);
229 m->bucket_size = cpu_to_le16(i->bucket_size);
231 SET_BCH_MEMBER_TIER(m, i->tier);
232 SET_BCH_MEMBER_REPLACEMENT(m, CACHE_REPLACEMENT_LRU);
233 SET_BCH_MEMBER_DISCARD(m, i->discard);
234 SET_BCH_MEMBER_DATA_ALLOWED(m, i->data_allowed);
237 for (i = devs; i < devs + nr_devs; i++) {
238 sb->dev_idx = i - devs;
240 init_layout(&sb->layout, opts.block_size,
241 i->sb_offset, i->sb_end);
243 if (i->sb_offset == BCH_SB_SECTOR) {
244 /* Zero start of disk */
245 static const char zeroes[BCH_SB_SECTOR << 9];
247 xpwrite(i->fd, zeroes, BCH_SB_SECTOR << 9, 0);
250 bch2_super_write(i->fd, sb);
257 void bch2_super_write(int fd, struct bch_sb *sb)
259 struct nonce nonce = { 0 };
262 for (i = 0; i < sb->layout.nr_superblocks; i++) {
263 sb->offset = sb->layout.sb_offset[i];
265 if (sb->offset == BCH_SB_SECTOR) {
266 /* Write backup layout */
267 xpwrite(fd, &sb->layout, sizeof(sb->layout),
268 BCH_SB_LAYOUT_SECTOR << 9);
271 sb->csum = csum_vstruct(NULL, BCH_SB_CSUM_TYPE(sb), nonce, sb);
272 xpwrite(fd, sb, vstruct_bytes(sb),
273 le64_to_cpu(sb->offset) << 9);
279 struct bch_sb *__bch2_super_read(int fd, u64 sector)
281 struct bch_sb sb, *ret;
283 xpread(fd, &sb, sizeof(sb), sector << 9);
285 if (memcmp(&sb.magic, &BCACHE_MAGIC, sizeof(sb.magic)))
286 die("not a bcachefs superblock");
288 size_t bytes = vstruct_bytes(&sb);
292 xpread(fd, ret, bytes, sector << 9);
297 static unsigned get_dev_has_data(struct bch_sb *sb, unsigned dev)
299 struct bch_sb_field_replicas *replicas;
300 struct bch_replicas_entry *r;
301 unsigned i, data_has = 0;
303 replicas = bch2_sb_get_replicas(sb);
306 for_each_replicas_entry(replicas, r)
307 for (i = 0; i < r->nr; i++)
308 if (r->devs[i] == dev)
309 data_has |= 1 << r->data_type;
314 /* superblock printing: */
316 static void bch2_sb_print_layout(struct bch_sb *sb, enum units units)
318 struct bch_sb_layout *l = &sb->layout;
322 " superblock max size: %s\n"
323 " nr superblocks: %u\n"
326 pr_units(1 << l->sb_max_size_bits, units),
329 for (i = 0; i < l->nr_superblocks; i++) {
332 printf("%llu", le64_to_cpu(l->sb_offset[i]));
337 static void bch2_sb_print_journal(struct bch_sb *sb, struct bch_sb_field *f,
340 struct bch_sb_field_journal *journal = field_to_type(f, journal);
341 unsigned i, nr = bch2_nr_journal_buckets(journal);
343 printf(" Buckets: ");
344 for (i = 0; i < nr; i++) {
347 printf("%llu", le64_to_cpu(journal->buckets[i]));
352 static void bch2_sb_print_members(struct bch_sb *sb, struct bch_sb_field *f,
355 struct bch_sb_field_members *mi = field_to_type(f, members);
358 for (i = 0; i < sb->nr_devices; i++) {
359 struct bch_member *m = mi->members + i;
360 time_t last_mount = le64_to_cpu(m->last_mount);
361 char member_uuid_str[40];
362 char data_allowed_str[100];
363 char data_has_str[100];
365 if (!bch2_member_exists(m))
368 uuid_unparse(m->uuid.b, member_uuid_str);
369 bch2_scnprint_flag_list(data_allowed_str,
370 sizeof(data_allowed_str),
372 BCH_MEMBER_DATA_ALLOWED(m));
373 if (!data_allowed_str[0])
374 strcpy(data_allowed_str, "(none)");
376 bch2_scnprint_flag_list(data_has_str,
377 sizeof(data_has_str),
379 get_dev_has_data(sb, i));
380 if (!data_has_str[0])
381 strcpy(data_has_str, "(none)");
383 printf(" Device %u:\n"
387 " First bucket: %u\n"
392 " Data allowed: %s\n"
396 " Replacement policy: %s\n"
399 pr_units(le16_to_cpu(m->bucket_size) *
400 le64_to_cpu(m->nbuckets), units),
401 pr_units(le16_to_cpu(m->bucket_size), units),
402 le16_to_cpu(m->first_bucket),
403 le64_to_cpu(m->nbuckets),
404 last_mount ? ctime(&last_mount) : "(never)",
406 BCH_MEMBER_STATE(m) < BCH_MEMBER_STATE_NR
407 ? bch2_dev_state[BCH_MEMBER_STATE(m)]
414 BCH_MEMBER_REPLACEMENT(m) < CACHE_REPLACEMENT_NR
415 ? bch2_cache_replacement_policies[BCH_MEMBER_REPLACEMENT(m)]
418 BCH_MEMBER_DISCARD(m));
422 static void bch2_sb_print_crypt(struct bch_sb *sb, struct bch_sb_field *f,
425 struct bch_sb_field_crypt *crypt = field_to_type(f, crypt);
427 printf(" KFD: %llu\n"
431 BCH_CRYPT_KDF_TYPE(crypt),
432 BCH_KDF_SCRYPT_N(crypt),
433 BCH_KDF_SCRYPT_R(crypt),
434 BCH_KDF_SCRYPT_P(crypt));
437 static void bch2_sb_print_replicas(struct bch_sb *sb, struct bch_sb_field *f,
440 struct bch_sb_field_replicas *replicas = field_to_type(f, replicas);
441 struct bch_replicas_entry *e;
444 for_each_replicas_entry(replicas, e) {
445 printf_pad(32, " %s:", bch2_data_types[e->data_type]);
448 for (i = 0; i < e->nr; i++) {
451 printf("%u", e->devs[i]);
457 typedef void (*sb_field_print_fn)(struct bch_sb *, struct bch_sb_field *, enum units);
459 struct bch_sb_field_ops {
460 sb_field_print_fn print;
463 static const struct bch_sb_field_ops bch2_sb_field_ops[] = {
465 [BCH_SB_FIELD_##f] = { \
466 .print = bch2_sb_print_##f, \
472 static inline void bch2_sb_field_print(struct bch_sb *sb,
473 struct bch_sb_field *f,
476 unsigned type = le32_to_cpu(f->type);
478 if (type < BCH_SB_FIELD_NR)
479 bch2_sb_field_ops[type].print(sb, f, units);
481 printf("(unknown field %u)\n", type);
484 void bch2_sb_print(struct bch_sb *sb, bool print_layout,
485 unsigned fields, enum units units)
487 struct bch_sb_field_members *mi;
488 char user_uuid_str[40], internal_uuid_str[40];
489 char fields_have_str[200];
490 char label[BCH_SB_LABEL_SIZE + 1];
491 struct bch_sb_field *f;
493 unsigned nr_devices = 0;
495 memset(label, 0, sizeof(label));
496 memcpy(label, sb->label, sizeof(sb->label));
497 uuid_unparse(sb->user_uuid.b, user_uuid_str);
498 uuid_unparse(sb->uuid.b, internal_uuid_str);
500 mi = bch2_sb_get_members(sb);
502 struct bch_member *m;
504 for (m = mi->members;
505 m < mi->members + sb->nr_devices;
507 nr_devices += bch2_member_exists(m);
510 vstruct_for_each(sb, f)
511 fields_have |= 1 << le32_to_cpu(f->type);
512 bch2_scnprint_flag_list(fields_have_str, sizeof(fields_have_str),
513 bch2_sb_fields, fields_have);
515 printf("External UUID: %s\n"
516 "Internal UUID: %s\n"
520 "Btree node size: %s\n"
524 "Metadata replicas: %llu\n"
525 "Data replicas: %llu\n"
527 "Metadata checksum type: %s (%llu)\n"
528 "Data checksum type: %s (%llu)\n"
529 "Compression type: %s (%llu)\n"
531 "String hash type: %s (%llu)\n"
532 "32 bit inodes: %llu\n"
533 "GC reserve percentage: %llu%%\n"
534 "Root reserve percentage: %llu%%\n"
536 "Devices: %u live, %u total\n"
538 "Superblock size: %llu\n",
542 le64_to_cpu(sb->version),
543 pr_units(le16_to_cpu(sb->block_size), units),
544 pr_units(BCH_SB_BTREE_NODE_SIZE(sb), units),
546 BCH_SB_ERROR_ACTION(sb) < BCH_NR_ERROR_ACTIONS
547 ? bch2_error_actions[BCH_SB_ERROR_ACTION(sb)]
552 BCH_SB_META_REPLICAS_WANT(sb),
553 BCH_SB_DATA_REPLICAS_WANT(sb),
555 BCH_SB_META_CSUM_TYPE(sb) < BCH_CSUM_OPT_NR
556 ? bch2_csum_types[BCH_SB_META_CSUM_TYPE(sb)]
558 BCH_SB_META_CSUM_TYPE(sb),
560 BCH_SB_DATA_CSUM_TYPE(sb) < BCH_CSUM_OPT_NR
561 ? bch2_csum_types[BCH_SB_DATA_CSUM_TYPE(sb)]
563 BCH_SB_DATA_CSUM_TYPE(sb),
565 BCH_SB_COMPRESSION_TYPE(sb) < BCH_COMPRESSION_OPT_NR
566 ? bch2_compression_types[BCH_SB_COMPRESSION_TYPE(sb)]
568 BCH_SB_COMPRESSION_TYPE(sb),
570 BCH_SB_STR_HASH_TYPE(sb) < BCH_STR_HASH_NR
571 ? bch2_str_hash_types[BCH_SB_STR_HASH_TYPE(sb)]
573 BCH_SB_STR_HASH_TYPE(sb),
575 BCH_SB_INODE_32BIT(sb),
576 BCH_SB_GC_RESERVE(sb),
577 BCH_SB_ROOT_RESERVE(sb),
579 nr_devices, sb->nr_devices,
586 bch2_sb_print_layout(sb, units);
589 vstruct_for_each(sb, f) {
590 unsigned type = le32_to_cpu(f->type);
593 if (!(fields & (1 << type)))
596 if (type < BCH_SB_FIELD_NR) {
597 scnprintf(name, sizeof(name), "%s", bch2_sb_fields[type]);
598 name[0] = toupper(name[0]);
600 scnprintf(name, sizeof(name), "(unknown field %u)", type);
603 printf("\n%s (size %llu):\n", name, vstruct_bytes(f));
604 if (type < BCH_SB_FIELD_NR)
605 bch2_sb_field_print(sb, f, units);
609 /* ioctl interface: */
611 /* Global control device: */
612 int bcachectl_open(void)
614 return xopen("/dev/bcachefs-ctl", O_RDWR);
617 /* Filesystem handles (ioctl, sysfs dir): */
619 #define SYSFS_BASE "/sys/fs/bcachefs/"
621 void bcache_fs_close(struct bchfs_handle fs)
627 struct bchfs_handle bcache_fs_open(const char *path)
629 struct bchfs_handle ret;
631 if (!uuid_parse(path, ret.uuid.b)) {
632 /* It's a UUID, look it up in sysfs: */
633 char *sysfs = mprintf("%s%s", SYSFS_BASE, path);
634 ret.sysfs_fd = xopen(sysfs, O_RDONLY);
636 char *minor = read_file_str(ret.sysfs_fd, "minor");
637 char *ctl = mprintf("/dev/bcachefs%s-ctl", minor);
638 ret.ioctl_fd = xopen(ctl, O_RDWR);
645 ret.ioctl_fd = xopen(path, O_RDONLY);
647 struct bch_ioctl_query_uuid uuid;
648 xioctl(ret.ioctl_fd, BCH_IOCTL_QUERY_UUID, &uuid);
650 ret.uuid = uuid.uuid;
653 uuid_unparse(uuid.uuid.b, uuid_str);
655 char *sysfs = mprintf("%s%s", SYSFS_BASE, uuid_str);
656 ret.sysfs_fd = xopen(sysfs, O_RDONLY);