1 // SPDX-License-Identifier: GPL-2.0
6 #include "disk_groups.h"
10 #include "journal_sb.h"
11 #include "journal_seq_blacklist.h"
16 #include "sb-downgrade.h"
17 #include "sb-errors.h"
18 #include "sb-members.h"
24 #include <linux/backing-dev.h>
25 #include <linux/sort.h>
27 static const struct blk_holder_ops bch2_sb_handle_bdev_ops = {
30 struct bch2_metadata_version {
36 static const struct bch2_metadata_version bch2_metadata_versions[] = {
37 #define x(n, v, _recovery_passes) { \
40 .recovery_passes = _recovery_passes, \
42 BCH_METADATA_VERSIONS()
46 void bch2_version_to_text(struct printbuf *out, unsigned v)
48 const char *str = "(unknown version)";
50 for (unsigned i = 0; i < ARRAY_SIZE(bch2_metadata_versions); i++)
51 if (bch2_metadata_versions[i].version == v) {
52 str = bch2_metadata_versions[i].name;
56 prt_printf(out, "%u.%u: %s", BCH_VERSION_MAJOR(v), BCH_VERSION_MINOR(v), str);
59 unsigned bch2_latest_compatible_version(unsigned v)
61 if (!BCH_VERSION_MAJOR(v))
64 for (unsigned i = 0; i < ARRAY_SIZE(bch2_metadata_versions); i++)
65 if (bch2_metadata_versions[i].version > v &&
66 BCH_VERSION_MAJOR(bch2_metadata_versions[i].version) ==
68 v = bch2_metadata_versions[i].version;
73 u64 bch2_upgrade_recovery_passes(struct bch_fs *c,
79 for (const struct bch2_metadata_version *i = bch2_metadata_versions;
80 i < bch2_metadata_versions + ARRAY_SIZE(bch2_metadata_versions);
82 if (i->version > old_version && i->version <= new_version) {
83 if (i->recovery_passes & RECOVERY_PASS_ALL_FSCK)
84 ret |= bch2_fsck_recovery_passes();
85 ret |= i->recovery_passes;
88 return ret &= ~RECOVERY_PASS_ALL_FSCK;
91 const char * const bch2_sb_fields[] = {
92 #define x(name, nr) #name,
98 static int bch2_sb_field_validate(struct bch_sb *, struct bch_sb_field *,
101 struct bch_sb_field *bch2_sb_field_get_id(struct bch_sb *sb,
102 enum bch_sb_field_type type)
104 struct bch_sb_field *f;
106 /* XXX: need locking around superblock to access optional fields */
108 vstruct_for_each(sb, f)
109 if (le32_to_cpu(f->type) == type)
114 static struct bch_sb_field *__bch2_sb_field_resize(struct bch_sb_handle *sb,
115 struct bch_sb_field *f,
118 unsigned old_u64s = f ? le32_to_cpu(f->u64s) : 0;
119 unsigned sb_u64s = le32_to_cpu(sb->sb->u64s) + u64s - old_u64s;
121 BUG_ON(__vstruct_bytes(struct bch_sb, sb_u64s) > sb->buffer_size);
126 f = vstruct_last(sb->sb);
127 memset(f, 0, sizeof(u64) * u64s);
128 f->u64s = cpu_to_le32(u64s);
133 src = vstruct_end(f);
136 f->u64s = cpu_to_le32(u64s);
137 dst = vstruct_end(f);
142 memmove(dst, src, vstruct_end(sb->sb) - src);
145 memset(src, 0, dst - src);
148 sb->sb->u64s = cpu_to_le32(sb_u64s);
150 return u64s ? f : NULL;
153 void bch2_sb_field_delete(struct bch_sb_handle *sb,
154 enum bch_sb_field_type type)
156 struct bch_sb_field *f = bch2_sb_field_get_id(sb->sb, type);
159 __bch2_sb_field_resize(sb, f, 0);
162 /* Superblock realloc/free: */
164 void bch2_free_super(struct bch_sb_handle *sb)
167 if (!IS_ERR_OR_NULL(sb->bdev_handle))
168 bdev_release(sb->bdev_handle);
173 memset(sb, 0, sizeof(*sb));
176 int bch2_sb_realloc(struct bch_sb_handle *sb, unsigned u64s)
178 size_t new_bytes = __vstruct_bytes(struct bch_sb, u64s);
179 size_t new_buffer_size;
180 struct bch_sb *new_sb;
184 new_bytes = max_t(size_t, new_bytes, bdev_logical_block_size(sb->bdev));
186 new_buffer_size = roundup_pow_of_two(new_bytes);
188 if (sb->sb && sb->buffer_size >= new_buffer_size)
191 if (sb->sb && sb->have_layout) {
192 u64 max_bytes = 512 << sb->sb->layout.sb_max_size_bits;
194 if (new_bytes > max_bytes) {
195 pr_err("%pg: superblock too big: want %zu but have %llu",
196 sb->bdev, new_bytes, max_bytes);
197 return -BCH_ERR_ENOSPC_sb;
201 if (sb->buffer_size >= new_buffer_size && sb->sb)
204 if (dynamic_fault("bcachefs:add:super_realloc"))
205 return -BCH_ERR_ENOMEM_sb_realloc_injected;
207 new_sb = krealloc(sb->sb, new_buffer_size, GFP_NOFS|__GFP_ZERO);
209 return -BCH_ERR_ENOMEM_sb_buf_realloc;
214 unsigned nr_bvecs = buf_pages(sb->sb, new_buffer_size);
216 bio = bio_kmalloc(nr_bvecs, GFP_KERNEL);
218 return -BCH_ERR_ENOMEM_sb_bio_realloc;
220 bio_init(bio, NULL, bio->bi_inline_vecs, nr_bvecs, 0);
226 sb->buffer_size = new_buffer_size;
231 struct bch_sb_field *bch2_sb_field_resize_id(struct bch_sb_handle *sb,
232 enum bch_sb_field_type type,
235 struct bch_sb_field *f = bch2_sb_field_get_id(sb->sb, type);
236 ssize_t old_u64s = f ? le32_to_cpu(f->u64s) : 0;
237 ssize_t d = -old_u64s + u64s;
239 if (bch2_sb_realloc(sb, le32_to_cpu(sb->sb->u64s) + d))
243 struct bch_fs *c = container_of(sb, struct bch_fs, disk_sb);
247 lockdep_assert_held(&c->sb_lock);
249 /* XXX: we're not checking that offline device have enough space */
251 for_each_online_member(ca, c, i) {
252 struct bch_sb_handle *dev_sb = &ca->disk_sb;
254 if (bch2_sb_realloc(dev_sb, le32_to_cpu(dev_sb->sb->u64s) + d)) {
255 percpu_ref_put(&ca->ref);
261 f = bch2_sb_field_get_id(sb->sb, type);
262 f = __bch2_sb_field_resize(sb, f, u64s);
264 f->type = cpu_to_le32(type);
268 struct bch_sb_field *bch2_sb_field_get_minsize_id(struct bch_sb_handle *sb,
269 enum bch_sb_field_type type,
272 struct bch_sb_field *f = bch2_sb_field_get_id(sb->sb, type);
274 if (!f || le32_to_cpu(f->u64s) < u64s)
275 f = bch2_sb_field_resize_id(sb, type, u64s);
279 /* Superblock validate: */
281 static int validate_sb_layout(struct bch_sb_layout *layout, struct printbuf *out)
283 u64 offset, prev_offset, max_sectors;
286 BUILD_BUG_ON(sizeof(struct bch_sb_layout) != 512);
288 if (!uuid_equal(&layout->magic, &BCACHE_MAGIC) &&
289 !uuid_equal(&layout->magic, &BCHFS_MAGIC)) {
290 prt_printf(out, "Not a bcachefs superblock layout");
291 return -BCH_ERR_invalid_sb_layout;
294 if (layout->layout_type != 0) {
295 prt_printf(out, "Invalid superblock layout type %u",
296 layout->layout_type);
297 return -BCH_ERR_invalid_sb_layout_type;
300 if (!layout->nr_superblocks) {
301 prt_printf(out, "Invalid superblock layout: no superblocks");
302 return -BCH_ERR_invalid_sb_layout_nr_superblocks;
305 if (layout->nr_superblocks > ARRAY_SIZE(layout->sb_offset)) {
306 prt_printf(out, "Invalid superblock layout: too many superblocks");
307 return -BCH_ERR_invalid_sb_layout_nr_superblocks;
310 max_sectors = 1 << layout->sb_max_size_bits;
312 prev_offset = le64_to_cpu(layout->sb_offset[0]);
314 for (i = 1; i < layout->nr_superblocks; i++) {
315 offset = le64_to_cpu(layout->sb_offset[i]);
317 if (offset < prev_offset + max_sectors) {
318 prt_printf(out, "Invalid superblock layout: superblocks overlap\n"
319 " (sb %u ends at %llu next starts at %llu",
320 i - 1, prev_offset + max_sectors, offset);
321 return -BCH_ERR_invalid_sb_layout_superblocks_overlap;
323 prev_offset = offset;
329 static int bch2_sb_compatible(struct bch_sb *sb, struct printbuf *out)
331 u16 version = le16_to_cpu(sb->version);
332 u16 version_min = le16_to_cpu(sb->version_min);
334 if (!bch2_version_compatible(version)) {
335 prt_str(out, "Unsupported superblock version ");
336 bch2_version_to_text(out, version);
337 prt_str(out, " (min ");
338 bch2_version_to_text(out, bcachefs_metadata_version_min);
339 prt_str(out, ", max ");
340 bch2_version_to_text(out, bcachefs_metadata_version_current);
342 return -BCH_ERR_invalid_sb_version;
345 if (!bch2_version_compatible(version_min)) {
346 prt_str(out, "Unsupported superblock version_min ");
347 bch2_version_to_text(out, version_min);
348 prt_str(out, " (min ");
349 bch2_version_to_text(out, bcachefs_metadata_version_min);
350 prt_str(out, ", max ");
351 bch2_version_to_text(out, bcachefs_metadata_version_current);
353 return -BCH_ERR_invalid_sb_version;
356 if (version_min > version) {
357 prt_str(out, "Bad minimum version ");
358 bch2_version_to_text(out, version_min);
359 prt_str(out, ", greater than version field ");
360 bch2_version_to_text(out, version);
361 return -BCH_ERR_invalid_sb_version;
367 static int bch2_sb_validate(struct bch_sb_handle *disk_sb, struct printbuf *out,
370 struct bch_sb *sb = disk_sb->sb;
371 struct bch_sb_field *f;
372 struct bch_sb_field_members_v1 *mi;
373 enum bch_opt_id opt_id;
377 ret = bch2_sb_compatible(sb, out);
381 if (sb->features[1] ||
382 (le64_to_cpu(sb->features[0]) & (~0ULL << BCH_FEATURE_NR))) {
383 prt_printf(out, "Filesystem has incompatible features");
384 return -BCH_ERR_invalid_sb_features;
387 block_size = le16_to_cpu(sb->block_size);
389 if (block_size > PAGE_SECTORS) {
390 prt_printf(out, "Block size too big (got %u, max %u)",
391 block_size, PAGE_SECTORS);
392 return -BCH_ERR_invalid_sb_block_size;
395 if (bch2_is_zero(sb->user_uuid.b, sizeof(sb->user_uuid))) {
396 prt_printf(out, "Bad user UUID (got zeroes)");
397 return -BCH_ERR_invalid_sb_uuid;
400 if (bch2_is_zero(sb->uuid.b, sizeof(sb->uuid))) {
401 prt_printf(out, "Bad internal UUID (got zeroes)");
402 return -BCH_ERR_invalid_sb_uuid;
405 if (!sb->nr_devices ||
406 sb->nr_devices > BCH_SB_MEMBERS_MAX) {
407 prt_printf(out, "Bad number of member devices %u (max %u)",
408 sb->nr_devices, BCH_SB_MEMBERS_MAX);
409 return -BCH_ERR_invalid_sb_too_many_members;
412 if (sb->dev_idx >= sb->nr_devices) {
413 prt_printf(out, "Bad dev_idx (got %u, nr_devices %u)",
414 sb->dev_idx, sb->nr_devices);
415 return -BCH_ERR_invalid_sb_dev_idx;
418 if (!sb->time_precision ||
419 le32_to_cpu(sb->time_precision) > NSEC_PER_SEC) {
420 prt_printf(out, "Invalid time precision: %u (min 1, max %lu)",
421 le32_to_cpu(sb->time_precision), NSEC_PER_SEC);
422 return -BCH_ERR_invalid_sb_time_precision;
427 * Been seeing a bug where these are getting inexplicably
428 * zeroed, so we're now validating them, but we have to be
429 * careful not to preven people's filesystems from mounting:
431 if (!BCH_SB_JOURNAL_FLUSH_DELAY(sb))
432 SET_BCH_SB_JOURNAL_FLUSH_DELAY(sb, 1000);
433 if (!BCH_SB_JOURNAL_RECLAIM_DELAY(sb))
434 SET_BCH_SB_JOURNAL_RECLAIM_DELAY(sb, 1000);
436 if (!BCH_SB_VERSION_UPGRADE_COMPLETE(sb))
437 SET_BCH_SB_VERSION_UPGRADE_COMPLETE(sb, le16_to_cpu(sb->version));
440 for (opt_id = 0; opt_id < bch2_opts_nr; opt_id++) {
441 const struct bch_option *opt = bch2_opt_table + opt_id;
443 if (opt->get_sb != BCH2_NO_SB_OPT) {
444 u64 v = bch2_opt_from_sb(sb, opt_id);
446 prt_printf(out, "Invalid option ");
447 ret = bch2_opt_validate(opt, v, out);
455 /* validate layout */
456 ret = validate_sb_layout(&sb->layout, out);
460 vstruct_for_each(sb, f) {
462 prt_printf(out, "Invalid superblock: optional field with size 0 (type %u)",
463 le32_to_cpu(f->type));
464 return -BCH_ERR_invalid_sb_field_size;
467 if (vstruct_next(f) > vstruct_last(sb)) {
468 prt_printf(out, "Invalid superblock: optional field extends past end of superblock (type %u)",
469 le32_to_cpu(f->type));
470 return -BCH_ERR_invalid_sb_field_size;
474 /* members must be validated first: */
475 mi = bch2_sb_field_get(sb, members_v1);
477 prt_printf(out, "Invalid superblock: member info area missing");
478 return -BCH_ERR_invalid_sb_members_missing;
481 ret = bch2_sb_field_validate(sb, &mi->field, out);
485 vstruct_for_each(sb, f) {
486 if (le32_to_cpu(f->type) == BCH_SB_FIELD_members_v1)
489 ret = bch2_sb_field_validate(sb, f, out);
499 static unsigned long le_ulong_to_cpu(unsigned long v)
501 return sizeof(unsigned long) == 8
506 static void le_bitvector_to_cpu(unsigned long *dst, unsigned long *src, unsigned nr)
508 BUG_ON(nr & (BITS_PER_TYPE(long) - 1));
510 for (unsigned i = 0; i < BITS_TO_LONGS(nr); i++)
511 dst[i] = le_ulong_to_cpu(src[i]);
514 static void bch2_sb_update(struct bch_fs *c)
516 struct bch_sb *src = c->disk_sb.sb;
520 lockdep_assert_held(&c->sb_lock);
522 c->sb.uuid = src->uuid;
523 c->sb.user_uuid = src->user_uuid;
524 c->sb.version = le16_to_cpu(src->version);
525 c->sb.version_min = le16_to_cpu(src->version_min);
526 c->sb.version_upgrade_complete = BCH_SB_VERSION_UPGRADE_COMPLETE(src);
527 c->sb.nr_devices = src->nr_devices;
528 c->sb.clean = BCH_SB_CLEAN(src);
529 c->sb.encryption_type = BCH_SB_ENCRYPTION_TYPE(src);
531 c->sb.nsec_per_time_unit = le32_to_cpu(src->time_precision);
532 c->sb.time_units_per_sec = NSEC_PER_SEC / c->sb.nsec_per_time_unit;
534 /* XXX this is wrong, we need a 96 or 128 bit integer type */
535 c->sb.time_base_lo = div_u64(le64_to_cpu(src->time_base_lo),
536 c->sb.nsec_per_time_unit);
537 c->sb.time_base_hi = le32_to_cpu(src->time_base_hi);
539 c->sb.features = le64_to_cpu(src->features[0]);
540 c->sb.compat = le64_to_cpu(src->compat[0]);
542 memset(c->sb.errors_silent, 0, sizeof(c->sb.errors_silent));
544 struct bch_sb_field_ext *ext = bch2_sb_field_get(src, ext);
546 le_bitvector_to_cpu(c->sb.errors_silent, (void *) ext->errors_silent,
547 sizeof(c->sb.errors_silent) * 8);
549 for_each_member_device(ca, c, i) {
550 struct bch_member m = bch2_sb_member_get(src, ca->dev_idx);
551 ca->mi = bch2_mi_to_cpu(&m);
555 static int __copy_super(struct bch_sb_handle *dst_handle, struct bch_sb *src)
557 struct bch_sb_field *src_f, *dst_f;
558 struct bch_sb *dst = dst_handle->sb;
561 dst->version = src->version;
562 dst->version_min = src->version_min;
564 dst->uuid = src->uuid;
565 dst->user_uuid = src->user_uuid;
566 memcpy(dst->label, src->label, sizeof(dst->label));
568 dst->block_size = src->block_size;
569 dst->nr_devices = src->nr_devices;
571 dst->time_base_lo = src->time_base_lo;
572 dst->time_base_hi = src->time_base_hi;
573 dst->time_precision = src->time_precision;
575 memcpy(dst->flags, src->flags, sizeof(dst->flags));
576 memcpy(dst->features, src->features, sizeof(dst->features));
577 memcpy(dst->compat, src->compat, sizeof(dst->compat));
579 for (i = 0; i < BCH_SB_FIELD_NR; i++) {
582 if ((1U << i) & BCH_SINGLE_DEVICE_SB_FIELDS)
585 src_f = bch2_sb_field_get_id(src, i);
586 dst_f = bch2_sb_field_get_id(dst, i);
588 d = (src_f ? le32_to_cpu(src_f->u64s) : 0) -
589 (dst_f ? le32_to_cpu(dst_f->u64s) : 0);
591 int ret = bch2_sb_realloc(dst_handle,
592 le32_to_cpu(dst_handle->sb->u64s) + d);
597 dst = dst_handle->sb;
598 dst_f = bch2_sb_field_get_id(dst, i);
601 dst_f = __bch2_sb_field_resize(dst_handle, dst_f,
602 src_f ? le32_to_cpu(src_f->u64s) : 0);
605 memcpy(dst_f, src_f, vstruct_bytes(src_f));
611 int bch2_sb_to_fs(struct bch_fs *c, struct bch_sb *src)
615 lockdep_assert_held(&c->sb_lock);
617 ret = bch2_sb_realloc(&c->disk_sb, 0) ?:
618 __copy_super(&c->disk_sb, src) ?:
619 bch2_sb_replicas_to_cpu_replicas(c) ?:
620 bch2_sb_disk_groups_to_cpu(c);
628 int bch2_sb_from_fs(struct bch_fs *c, struct bch_dev *ca)
630 return __copy_super(&ca->disk_sb, c->disk_sb.sb);
633 /* read superblock: */
635 static int read_one_super(struct bch_sb_handle *sb, u64 offset, struct printbuf *err)
637 struct bch_csum csum;
641 bio_reset(sb->bio, sb->bdev, REQ_OP_READ|REQ_SYNC|REQ_META);
642 sb->bio->bi_iter.bi_sector = offset;
643 bch2_bio_map(sb->bio, sb->sb, sb->buffer_size);
645 ret = submit_bio_wait(sb->bio);
647 prt_printf(err, "IO error: %i", ret);
651 if (!uuid_equal(&sb->sb->magic, &BCACHE_MAGIC) &&
652 !uuid_equal(&sb->sb->magic, &BCHFS_MAGIC)) {
653 prt_printf(err, "Not a bcachefs superblock");
654 return -BCH_ERR_invalid_sb_magic;
657 ret = bch2_sb_compatible(sb->sb, err);
661 bytes = vstruct_bytes(sb->sb);
663 if (bytes > 512 << sb->sb->layout.sb_max_size_bits) {
664 prt_printf(err, "Invalid superblock: too big (got %zu bytes, layout max %lu)",
665 bytes, 512UL << sb->sb->layout.sb_max_size_bits);
666 return -BCH_ERR_invalid_sb_too_big;
669 if (bytes > sb->buffer_size) {
670 ret = bch2_sb_realloc(sb, le32_to_cpu(sb->sb->u64s));
676 if (BCH_SB_CSUM_TYPE(sb->sb) >= BCH_CSUM_NR) {
677 prt_printf(err, "unknown checksum type %llu", BCH_SB_CSUM_TYPE(sb->sb));
678 return -BCH_ERR_invalid_sb_csum_type;
681 /* XXX: verify MACs */
682 csum = csum_vstruct(NULL, BCH_SB_CSUM_TYPE(sb->sb),
683 null_nonce(), sb->sb);
685 if (bch2_crc_cmp(csum, sb->sb->csum)) {
686 prt_printf(err, "bad checksum");
687 return -BCH_ERR_invalid_sb_csum;
690 sb->seq = le64_to_cpu(sb->sb->seq);
695 int bch2_read_super(const char *path, struct bch_opts *opts,
696 struct bch_sb_handle *sb)
698 u64 offset = opt_get(*opts, sb);
699 struct bch_sb_layout layout;
700 struct printbuf err = PRINTBUF;
706 memset(sb, 0, sizeof(*sb));
707 sb->mode = BLK_OPEN_READ;
709 sb->holder = kmalloc(1, GFP_KERNEL);
713 sb->sb_name = kstrdup(path, GFP_KERNEL);
718 if (opt_get(*opts, direct_io) == false)
719 sb->mode |= BLK_OPEN_BUFFERED;
722 if (!opt_get(*opts, noexcl))
723 sb->mode |= BLK_OPEN_EXCL;
725 if (!opt_get(*opts, nochanges))
726 sb->mode |= BLK_OPEN_WRITE;
728 sb->bdev_handle = bdev_open_by_path(path, sb->mode, sb->holder, &bch2_sb_handle_bdev_ops);
729 if (IS_ERR(sb->bdev_handle) &&
730 PTR_ERR(sb->bdev_handle) == -EACCES &&
731 opt_get(*opts, read_only)) {
732 sb->mode &= ~BLK_OPEN_WRITE;
734 sb->bdev_handle = bdev_open_by_path(path, sb->mode, sb->holder, &bch2_sb_handle_bdev_ops);
735 if (!IS_ERR(sb->bdev_handle))
736 opt_set(*opts, nochanges, true);
739 if (IS_ERR(sb->bdev_handle)) {
740 ret = PTR_ERR(sb->bdev_handle);
743 sb->bdev = sb->bdev_handle->bdev;
745 ret = bch2_sb_realloc(sb, 0);
747 prt_printf(&err, "error allocating memory for superblock");
751 if (bch2_fs_init_fault("read_super")) {
752 prt_printf(&err, "dynamic fault");
757 ret = read_one_super(sb, offset, &err);
761 if (opt_defined(*opts, sb))
764 printk(KERN_ERR "bcachefs (%s): error reading default superblock: %s\n",
766 printbuf_reset(&err);
769 * Error reading primary superblock - read location of backup
772 bio_reset(sb->bio, sb->bdev, REQ_OP_READ|REQ_SYNC|REQ_META);
773 sb->bio->bi_iter.bi_sector = BCH_SB_LAYOUT_SECTOR;
775 * use sb buffer to read layout, since sb buffer is page aligned but
778 bch2_bio_map(sb->bio, sb->sb, sizeof(struct bch_sb_layout));
780 ret = submit_bio_wait(sb->bio);
782 prt_printf(&err, "IO error: %i", ret);
786 memcpy(&layout, sb->sb, sizeof(layout));
787 ret = validate_sb_layout(&layout, &err);
791 for (i = layout.sb_offset;
792 i < layout.sb_offset + layout.nr_superblocks; i++) {
793 offset = le64_to_cpu(*i);
795 if (offset == opt_get(*opts, sb))
798 ret = read_one_super(sb, offset, &err);
806 if (le16_to_cpu(sb->sb->block_size) << 9 <
807 bdev_logical_block_size(sb->bdev) &&
808 opt_get(*opts, direct_io)) {
810 opt_set(*opts, direct_io, false);
814 prt_printf(&err, "block size (%u) smaller than device block size (%u)",
815 le16_to_cpu(sb->sb->block_size) << 9,
816 bdev_logical_block_size(sb->bdev));
817 ret = -BCH_ERR_block_size_too_small;
822 sb->have_layout = true;
824 ret = bch2_sb_validate(sb, &err, READ);
826 printk(KERN_ERR "bcachefs (%s): error validating superblock: %s\n",
834 printk(KERN_ERR "bcachefs (%s): error reading superblock: %s\n",
841 /* write superblock: */
843 static void write_super_endio(struct bio *bio)
845 struct bch_dev *ca = bio->bi_private;
847 /* XXX: return errors directly */
849 if (bch2_dev_io_err_on(bio->bi_status, ca,
851 ? BCH_MEMBER_ERROR_write
852 : BCH_MEMBER_ERROR_read,
853 "superblock %s error: %s",
854 bio_data_dir(bio) ? "write" : "read",
855 bch2_blk_status_to_str(bio->bi_status)))
856 ca->sb_write_error = 1;
858 closure_put(&ca->fs->sb_write);
859 percpu_ref_put(&ca->io_ref);
862 static void read_back_super(struct bch_fs *c, struct bch_dev *ca)
864 struct bch_sb *sb = ca->disk_sb.sb;
865 struct bio *bio = ca->disk_sb.bio;
867 bio_reset(bio, ca->disk_sb.bdev, REQ_OP_READ|REQ_SYNC|REQ_META);
868 bio->bi_iter.bi_sector = le64_to_cpu(sb->layout.sb_offset[0]);
869 bio->bi_end_io = write_super_endio;
870 bio->bi_private = ca;
871 bch2_bio_map(bio, ca->sb_read_scratch, PAGE_SIZE);
873 this_cpu_add(ca->io_done->sectors[READ][BCH_DATA_sb],
876 percpu_ref_get(&ca->io_ref);
877 closure_bio_submit(bio, &c->sb_write);
880 static void write_one_super(struct bch_fs *c, struct bch_dev *ca, unsigned idx)
882 struct bch_sb *sb = ca->disk_sb.sb;
883 struct bio *bio = ca->disk_sb.bio;
885 sb->offset = sb->layout.sb_offset[idx];
887 SET_BCH_SB_CSUM_TYPE(sb, bch2_csum_opt_to_type(c->opts.metadata_checksum, false));
888 sb->csum = csum_vstruct(c, BCH_SB_CSUM_TYPE(sb),
891 bio_reset(bio, ca->disk_sb.bdev, REQ_OP_WRITE|REQ_SYNC|REQ_META);
892 bio->bi_iter.bi_sector = le64_to_cpu(sb->offset);
893 bio->bi_end_io = write_super_endio;
894 bio->bi_private = ca;
895 bch2_bio_map(bio, sb,
896 roundup((size_t) vstruct_bytes(sb),
897 bdev_logical_block_size(ca->disk_sb.bdev)));
899 this_cpu_add(ca->io_done->sectors[WRITE][BCH_DATA_sb],
902 percpu_ref_get(&ca->io_ref);
903 closure_bio_submit(bio, &c->sb_write);
906 int bch2_write_super(struct bch_fs *c)
908 struct closure *cl = &c->sb_write;
910 struct printbuf err = PRINTBUF;
911 unsigned i, sb = 0, nr_wrote;
912 struct bch_devs_mask sb_written;
913 bool wrote, can_mount_without_written, can_mount_with_written;
914 unsigned degraded_flags = BCH_FORCE_IF_DEGRADED;
917 trace_and_count(c, write_super, c, _RET_IP_);
919 if (c->opts.very_degraded)
920 degraded_flags |= BCH_FORCE_IF_LOST;
922 lockdep_assert_held(&c->sb_lock);
924 closure_init_stack(cl);
925 memset(&sb_written, 0, sizeof(sb_written));
927 /* Make sure we're using the new magic numbers: */
928 c->disk_sb.sb->magic = BCHFS_MAGIC;
929 c->disk_sb.sb->layout.magic = BCHFS_MAGIC;
931 le64_add_cpu(&c->disk_sb.sb->seq, 1);
933 if (test_bit(BCH_FS_ERROR, &c->flags))
934 SET_BCH_SB_HAS_ERRORS(c->disk_sb.sb, 1);
935 if (test_bit(BCH_FS_TOPOLOGY_ERROR, &c->flags))
936 SET_BCH_SB_HAS_TOPOLOGY_ERRORS(c->disk_sb.sb, 1);
938 SET_BCH_SB_BIG_ENDIAN(c->disk_sb.sb, CPU_BIG_ENDIAN);
940 bch2_sb_counters_from_cpu(c);
941 bch2_sb_members_from_cpu(c);
942 bch2_sb_members_cpy_v2_v1(&c->disk_sb);
943 bch2_sb_errors_from_cpu(c);
944 bch2_sb_downgrade_update(c);
946 for_each_online_member(ca, c, i)
947 bch2_sb_from_fs(c, ca);
949 for_each_online_member(ca, c, i) {
950 printbuf_reset(&err);
952 ret = bch2_sb_validate(&ca->disk_sb, &err, WRITE);
954 bch2_fs_inconsistent(c, "sb invalid before write: %s", err.buf);
955 percpu_ref_put(&ca->io_ref);
960 if (c->opts.nochanges)
964 * Defer writing the superblock until filesystem initialization is
965 * complete - don't write out a partly initialized superblock:
967 if (!BCH_SB_INITIALIZED(c->disk_sb.sb))
970 for_each_online_member(ca, c, i) {
971 __set_bit(ca->dev_idx, sb_written.d);
972 ca->sb_write_error = 0;
975 for_each_online_member(ca, c, i)
976 read_back_super(c, ca);
979 for_each_online_member(ca, c, i) {
980 if (ca->sb_write_error)
983 if (le64_to_cpu(ca->sb_read_scratch->seq) < ca->disk_sb.seq) {
984 bch2_fs_fatal_error(c,
985 "Superblock write was silently dropped! (seq %llu expected %llu)",
986 le64_to_cpu(ca->sb_read_scratch->seq),
988 percpu_ref_put(&ca->io_ref);
989 ret = -BCH_ERR_erofs_sb_err;
993 if (le64_to_cpu(ca->sb_read_scratch->seq) > ca->disk_sb.seq) {
994 bch2_fs_fatal_error(c,
995 "Superblock modified by another process (seq %llu expected %llu)",
996 le64_to_cpu(ca->sb_read_scratch->seq),
998 percpu_ref_put(&ca->io_ref);
999 ret = -BCH_ERR_erofs_sb_err;
1006 for_each_online_member(ca, c, i)
1007 if (!ca->sb_write_error &&
1008 sb < ca->disk_sb.sb->layout.nr_superblocks) {
1009 write_one_super(c, ca, sb);
1016 for_each_online_member(ca, c, i) {
1017 if (ca->sb_write_error)
1018 __clear_bit(ca->dev_idx, sb_written.d);
1020 ca->disk_sb.seq = le64_to_cpu(ca->disk_sb.sb->seq);
1023 nr_wrote = dev_mask_nr(&sb_written);
1025 can_mount_with_written =
1026 bch2_have_enough_devs(c, sb_written, degraded_flags, false);
1028 for (i = 0; i < ARRAY_SIZE(sb_written.d); i++)
1029 sb_written.d[i] = ~sb_written.d[i];
1031 can_mount_without_written =
1032 bch2_have_enough_devs(c, sb_written, degraded_flags, false);
1035 * If we would be able to mount _without_ the devices we successfully
1036 * wrote superblocks to, we weren't able to write to enough devices:
1038 * Exception: if we can mount without the successes because we haven't
1039 * written anything (new filesystem), we continue if we'd be able to
1040 * mount with the devices we did successfully write to:
1042 if (bch2_fs_fatal_err_on(!nr_wrote ||
1043 !can_mount_with_written ||
1044 (can_mount_without_written &&
1045 !can_mount_with_written), c,
1046 "Unable to write superblock to sufficient devices (from %ps)",
1050 /* Make new options visible after they're persistent: */
1052 printbuf_exit(&err);
1056 void __bch2_check_set_feature(struct bch_fs *c, unsigned feat)
1058 mutex_lock(&c->sb_lock);
1059 if (!(c->sb.features & (1ULL << feat))) {
1060 c->disk_sb.sb->features[0] |= cpu_to_le64(1ULL << feat);
1062 bch2_write_super(c);
1064 mutex_unlock(&c->sb_lock);
1067 /* Downgrade if superblock is at a higher version than currently supported: */
1068 bool bch2_check_version_downgrade(struct bch_fs *c)
1070 bool ret = bcachefs_metadata_version_current < c->sb.version;
1072 lockdep_assert_held(&c->sb_lock);
1075 * Downgrade, if superblock is at a higher version than currently
1078 if (BCH_SB_VERSION_UPGRADE_COMPLETE(c->disk_sb.sb) > bcachefs_metadata_version_current)
1079 SET_BCH_SB_VERSION_UPGRADE_COMPLETE(c->disk_sb.sb, bcachefs_metadata_version_current);
1080 if (c->sb.version > bcachefs_metadata_version_current)
1081 c->disk_sb.sb->version = cpu_to_le16(bcachefs_metadata_version_current);
1082 if (c->sb.version_min > bcachefs_metadata_version_current)
1083 c->disk_sb.sb->version_min = cpu_to_le16(bcachefs_metadata_version_current);
1084 c->disk_sb.sb->compat[0] &= cpu_to_le64((1ULL << BCH_COMPAT_NR) - 1);
1088 void bch2_sb_upgrade(struct bch_fs *c, unsigned new_version)
1090 lockdep_assert_held(&c->sb_lock);
1092 if (BCH_VERSION_MAJOR(new_version) >
1093 BCH_VERSION_MAJOR(le16_to_cpu(c->disk_sb.sb->version)))
1094 bch2_sb_field_resize(&c->disk_sb, downgrade, 0);
1096 c->disk_sb.sb->version = cpu_to_le16(new_version);
1097 c->disk_sb.sb->features[0] |= cpu_to_le64(BCH_SB_FEATURES_ALL);
1100 static int bch2_sb_ext_validate(struct bch_sb *sb, struct bch_sb_field *f,
1101 struct printbuf *err)
1103 if (vstruct_bytes(f) < 88) {
1104 prt_printf(err, "field too small (%zu < %u)", vstruct_bytes(f), 88);
1105 return -BCH_ERR_invalid_sb_ext;
1111 static void bch2_sb_ext_to_text(struct printbuf *out, struct bch_sb *sb,
1112 struct bch_sb_field *f)
1114 struct bch_sb_field_ext *e = field_to_type(f, ext);
1116 prt_printf(out, "Recovery passes required:");
1118 prt_bitflags(out, bch2_recovery_passes,
1119 bch2_recovery_passes_from_stable(le64_to_cpu(e->recovery_passes_required[0])));
1122 unsigned long *errors_silent = kmalloc(sizeof(e->errors_silent), GFP_KERNEL);
1123 if (errors_silent) {
1124 le_bitvector_to_cpu(errors_silent, (void *) e->errors_silent, sizeof(e->errors_silent) * 8);
1126 prt_printf(out, "Errors to silently fix:");
1128 prt_bitflags_vector(out, bch2_sb_error_strs, errors_silent, sizeof(e->errors_silent) * 8);
1131 kfree(errors_silent);
1135 static const struct bch_sb_field_ops bch_sb_field_ops_ext = {
1136 .validate = bch2_sb_ext_validate,
1137 .to_text = bch2_sb_ext_to_text,
1140 static const struct bch_sb_field_ops *bch2_sb_field_ops[] = {
1142 [BCH_SB_FIELD_##f] = &bch_sb_field_ops_##f,
1147 static const struct bch_sb_field_ops bch2_sb_field_null_ops;
1149 static const struct bch_sb_field_ops *bch2_sb_field_type_ops(unsigned type)
1151 return likely(type < ARRAY_SIZE(bch2_sb_field_ops))
1152 ? bch2_sb_field_ops[type]
1153 : &bch2_sb_field_null_ops;
1156 static int bch2_sb_field_validate(struct bch_sb *sb, struct bch_sb_field *f,
1157 struct printbuf *err)
1159 unsigned type = le32_to_cpu(f->type);
1160 struct printbuf field_err = PRINTBUF;
1161 const struct bch_sb_field_ops *ops = bch2_sb_field_type_ops(type);
1164 ret = ops->validate ? ops->validate(sb, f, &field_err) : 0;
1166 prt_printf(err, "Invalid superblock section %s: %s",
1167 bch2_sb_fields[type], field_err.buf);
1169 bch2_sb_field_to_text(err, sb, f);
1172 printbuf_exit(&field_err);
1176 void bch2_sb_field_to_text(struct printbuf *out, struct bch_sb *sb,
1177 struct bch_sb_field *f)
1179 unsigned type = le32_to_cpu(f->type);
1180 const struct bch_sb_field_ops *ops = bch2_sb_field_type_ops(type);
1182 if (!out->nr_tabstops)
1183 printbuf_tabstop_push(out, 32);
1185 if (type < BCH_SB_FIELD_NR)
1186 prt_printf(out, "%s", bch2_sb_fields[type]);
1188 prt_printf(out, "(unknown field %u)", type);
1190 prt_printf(out, " (size %zu):", vstruct_bytes(f));
1194 printbuf_indent_add(out, 2);
1195 ops->to_text(out, sb, f);
1196 printbuf_indent_sub(out, 2);
1200 void bch2_sb_layout_to_text(struct printbuf *out, struct bch_sb_layout *l)
1204 prt_printf(out, "Type: %u", l->layout_type);
1207 prt_str(out, "Superblock max size: ");
1208 prt_units_u64(out, 512 << l->sb_max_size_bits);
1211 prt_printf(out, "Nr superblocks: %u", l->nr_superblocks);
1214 prt_str(out, "Offsets: ");
1215 for (i = 0; i < l->nr_superblocks; i++) {
1218 prt_printf(out, "%llu", le64_to_cpu(l->sb_offset[i]));
1223 void bch2_sb_to_text(struct printbuf *out, struct bch_sb *sb,
1224 bool print_layout, unsigned fields)
1226 struct bch_sb_field *f;
1227 u64 fields_have = 0;
1228 unsigned nr_devices = 0;
1230 if (!out->nr_tabstops)
1231 printbuf_tabstop_push(out, 44);
1233 for (int i = 0; i < sb->nr_devices; i++)
1234 nr_devices += bch2_dev_exists(sb, i);
1236 prt_printf(out, "External UUID:");
1238 pr_uuid(out, sb->user_uuid.b);
1241 prt_printf(out, "Internal UUID:");
1243 pr_uuid(out, sb->uuid.b);
1246 prt_str(out, "Device index:");
1248 prt_printf(out, "%u", sb->dev_idx);
1251 prt_str(out, "Label:");
1253 prt_printf(out, "%.*s", (int) sizeof(sb->label), sb->label);
1256 prt_str(out, "Version:");
1258 bch2_version_to_text(out, le16_to_cpu(sb->version));
1261 prt_str(out, "Version upgrade complete:");
1263 bch2_version_to_text(out, BCH_SB_VERSION_UPGRADE_COMPLETE(sb));
1266 prt_printf(out, "Oldest version on disk:");
1268 bch2_version_to_text(out, le16_to_cpu(sb->version_min));
1271 prt_printf(out, "Created:");
1273 if (sb->time_base_lo)
1274 bch2_prt_datetime(out, div_u64(le64_to_cpu(sb->time_base_lo), NSEC_PER_SEC));
1276 prt_printf(out, "(not set)");
1279 prt_printf(out, "Sequence number:");
1281 prt_printf(out, "%llu", le64_to_cpu(sb->seq));
1284 prt_printf(out, "Superblock size:");
1286 prt_printf(out, "%zu", vstruct_bytes(sb));
1289 prt_printf(out, "Clean:");
1291 prt_printf(out, "%llu", BCH_SB_CLEAN(sb));
1294 prt_printf(out, "Devices:");
1296 prt_printf(out, "%u", nr_devices);
1299 prt_printf(out, "Sections:");
1300 vstruct_for_each(sb, f)
1301 fields_have |= 1 << le32_to_cpu(f->type);
1303 prt_bitflags(out, bch2_sb_fields, fields_have);
1306 prt_printf(out, "Features:");
1308 prt_bitflags(out, bch2_sb_features, le64_to_cpu(sb->features[0]));
1311 prt_printf(out, "Compat features:");
1313 prt_bitflags(out, bch2_sb_compat, le64_to_cpu(sb->compat[0]));
1317 prt_printf(out, "Options:");
1319 printbuf_indent_add(out, 2);
1323 for (id = 0; id < bch2_opts_nr; id++) {
1324 const struct bch_option *opt = bch2_opt_table + id;
1326 if (opt->get_sb != BCH2_NO_SB_OPT) {
1327 u64 v = bch2_opt_from_sb(sb, id);
1329 prt_printf(out, "%s:", opt->attr.name);
1331 bch2_opt_to_text(out, NULL, sb, opt, v,
1332 OPT_HUMAN_READABLE|OPT_SHOW_FULL_LIST);
1338 printbuf_indent_sub(out, 2);
1342 prt_printf(out, "layout:");
1344 printbuf_indent_add(out, 2);
1345 bch2_sb_layout_to_text(out, &sb->layout);
1346 printbuf_indent_sub(out, 2);
1349 vstruct_for_each(sb, f)
1350 if (fields & (1 << le32_to_cpu(f->type))) {
1352 bch2_sb_field_to_text(out, sb, f);