1 // SPDX-License-Identifier: GPL-2.0
4 #include "btree_update_interior.h"
7 #include "disk_groups.h"
12 #include "journal_io.h"
13 #include "journal_seq_blacklist.h"
20 #include <linux/backing-dev.h>
21 #include <linux/sort.h>
23 const char * const bch2_sb_fields[] = {
24 #define x(name, nr) #name,
30 static const char *bch2_sb_field_validate(struct bch_sb *,
31 struct bch_sb_field *);
33 struct bch_sb_field *bch2_sb_field_get(struct bch_sb *sb,
34 enum bch_sb_field_type type)
36 struct bch_sb_field *f;
38 /* XXX: need locking around superblock to access optional fields */
40 vstruct_for_each(sb, f)
41 if (le32_to_cpu(f->type) == type)
46 static struct bch_sb_field *__bch2_sb_field_resize(struct bch_sb_handle *sb,
47 struct bch_sb_field *f,
50 unsigned old_u64s = f ? le32_to_cpu(f->u64s) : 0;
51 unsigned sb_u64s = le32_to_cpu(sb->sb->u64s) + u64s - old_u64s;
53 BUG_ON(get_order(__vstruct_bytes(struct bch_sb, sb_u64s)) >
59 f = vstruct_last(sb->sb);
60 memset(f, 0, sizeof(u64) * u64s);
61 f->u64s = cpu_to_le32(u64s);
69 f->u64s = cpu_to_le32(u64s);
75 memmove(dst, src, vstruct_end(sb->sb) - src);
78 memset(src, 0, dst - src);
81 sb->sb->u64s = cpu_to_le32(sb_u64s);
83 return u64s ? f : NULL;
86 void bch2_sb_field_delete(struct bch_sb_handle *sb,
87 enum bch_sb_field_type type)
89 struct bch_sb_field *f = bch2_sb_field_get(sb->sb, type);
92 __bch2_sb_field_resize(sb, f, 0);
95 /* Superblock realloc/free: */
97 void bch2_free_super(struct bch_sb_handle *sb)
101 if (!IS_ERR_OR_NULL(sb->bdev))
102 blkdev_put(sb->bdev, sb->mode);
104 free_pages((unsigned long) sb->sb, sb->page_order);
105 memset(sb, 0, sizeof(*sb));
108 int bch2_sb_realloc(struct bch_sb_handle *sb, unsigned u64s)
110 size_t new_bytes = __vstruct_bytes(struct bch_sb, u64s);
111 unsigned order = get_order(new_bytes);
112 struct bch_sb *new_sb;
115 if (sb->sb && sb->page_order >= order)
118 if (sb->have_layout) {
119 u64 max_bytes = 512 << sb->sb->layout.sb_max_size_bits;
121 if (new_bytes > max_bytes) {
122 char buf[BDEVNAME_SIZE];
124 pr_err("%s: superblock too big: want %zu but have %llu",
125 bdevname(sb->bdev, buf), new_bytes, max_bytes);
130 if (sb->page_order >= order && sb->sb)
133 if (dynamic_fault("bcachefs:add:super_realloc"))
137 bio = bio_kmalloc(GFP_KERNEL, 1 << order);
146 new_sb = (void *) __get_free_pages(GFP_NOFS|__GFP_ZERO, order);
151 memcpy(new_sb, sb->sb, PAGE_SIZE << sb->page_order);
153 free_pages((unsigned long) sb->sb, sb->page_order);
156 sb->page_order = order;
161 struct bch_sb_field *bch2_sb_field_resize(struct bch_sb_handle *sb,
162 enum bch_sb_field_type type,
165 struct bch_sb_field *f = bch2_sb_field_get(sb->sb, type);
166 ssize_t old_u64s = f ? le32_to_cpu(f->u64s) : 0;
167 ssize_t d = -old_u64s + u64s;
169 if (bch2_sb_realloc(sb, le32_to_cpu(sb->sb->u64s) + d))
173 struct bch_fs *c = container_of(sb, struct bch_fs, disk_sb);
177 lockdep_assert_held(&c->sb_lock);
179 /* XXX: we're not checking that offline device have enough space */
181 for_each_online_member(ca, c, i) {
182 struct bch_sb_handle *sb = &ca->disk_sb;
184 if (bch2_sb_realloc(sb, le32_to_cpu(sb->sb->u64s) + d)) {
185 percpu_ref_put(&ca->ref);
191 f = bch2_sb_field_get(sb->sb, type);
192 f = __bch2_sb_field_resize(sb, f, u64s);
194 f->type = cpu_to_le32(type);
198 /* Superblock validate: */
200 static inline void __bch2_sb_layout_size_assert(void)
202 BUILD_BUG_ON(sizeof(struct bch_sb_layout) != 512);
205 static const char *validate_sb_layout(struct bch_sb_layout *layout)
207 u64 offset, prev_offset, max_sectors;
210 if (uuid_le_cmp(layout->magic, BCACHE_MAGIC))
211 return "Not a bcachefs superblock layout";
213 if (layout->layout_type != 0)
214 return "Invalid superblock layout type";
216 if (!layout->nr_superblocks)
217 return "Invalid superblock layout: no superblocks";
219 if (layout->nr_superblocks > ARRAY_SIZE(layout->sb_offset))
220 return "Invalid superblock layout: too many superblocks";
222 max_sectors = 1 << layout->sb_max_size_bits;
224 prev_offset = le64_to_cpu(layout->sb_offset[0]);
226 for (i = 1; i < layout->nr_superblocks; i++) {
227 offset = le64_to_cpu(layout->sb_offset[i]);
229 if (offset < prev_offset + max_sectors)
230 return "Invalid superblock layout: superblocks overlap";
231 prev_offset = offset;
237 const char *bch2_sb_validate(struct bch_sb_handle *disk_sb)
239 struct bch_sb *sb = disk_sb->sb;
240 struct bch_sb_field *f;
241 struct bch_sb_field_members *mi;
243 u32 version, version_min;
246 version = le16_to_cpu(sb->version);
247 version_min = version >= bcachefs_metadata_version_new_versioning
248 ? le16_to_cpu(sb->version_min)
251 if (version >= bcachefs_metadata_version_max ||
252 version_min < bcachefs_metadata_version_min)
253 return "Unsupported superblock version";
255 if (version_min > version)
256 return "Bad minimum version";
258 if (sb->features[1] ||
259 (le64_to_cpu(sb->features[0]) & (~0ULL << BCH_FEATURE_NR)))
260 return "Filesystem has incompatible features";
262 block_size = le16_to_cpu(sb->block_size);
264 if (!is_power_of_2(block_size) ||
265 block_size > PAGE_SECTORS)
266 return "Bad block size";
268 if (bch2_is_zero(sb->user_uuid.b, sizeof(uuid_le)))
269 return "Bad user UUID";
271 if (bch2_is_zero(sb->uuid.b, sizeof(uuid_le)))
272 return "Bad internal UUID";
274 if (!sb->nr_devices ||
275 sb->nr_devices <= sb->dev_idx ||
276 sb->nr_devices > BCH_SB_MEMBERS_MAX)
277 return "Bad number of member devices";
279 if (!BCH_SB_META_REPLICAS_WANT(sb) ||
280 BCH_SB_META_REPLICAS_WANT(sb) > BCH_REPLICAS_MAX)
281 return "Invalid number of metadata replicas";
283 if (!BCH_SB_META_REPLICAS_REQ(sb) ||
284 BCH_SB_META_REPLICAS_REQ(sb) > BCH_REPLICAS_MAX)
285 return "Invalid number of metadata replicas";
287 if (!BCH_SB_DATA_REPLICAS_WANT(sb) ||
288 BCH_SB_DATA_REPLICAS_WANT(sb) > BCH_REPLICAS_MAX)
289 return "Invalid number of data replicas";
291 if (!BCH_SB_DATA_REPLICAS_REQ(sb) ||
292 BCH_SB_DATA_REPLICAS_REQ(sb) > BCH_REPLICAS_MAX)
293 return "Invalid number of data replicas";
295 if (BCH_SB_META_CSUM_TYPE(sb) >= BCH_CSUM_OPT_NR)
296 return "Invalid metadata checksum type";
298 if (BCH_SB_DATA_CSUM_TYPE(sb) >= BCH_CSUM_OPT_NR)
299 return "Invalid metadata checksum type";
301 if (BCH_SB_COMPRESSION_TYPE(sb) >= BCH_COMPRESSION_OPT_NR)
302 return "Invalid compression type";
304 if (!BCH_SB_BTREE_NODE_SIZE(sb))
305 return "Btree node size not set";
307 if (!is_power_of_2(BCH_SB_BTREE_NODE_SIZE(sb)))
308 return "Btree node size not a power of two";
310 if (BCH_SB_GC_RESERVE(sb) < 5)
311 return "gc reserve percentage too small";
313 if (!sb->time_precision ||
314 le32_to_cpu(sb->time_precision) > NSEC_PER_SEC)
315 return "invalid time precision";
317 /* validate layout */
318 err = validate_sb_layout(&sb->layout);
322 vstruct_for_each(sb, f) {
324 return "Invalid superblock: invalid optional field";
326 if (vstruct_next(f) > vstruct_last(sb))
327 return "Invalid superblock: invalid optional field";
330 /* members must be validated first: */
331 mi = bch2_sb_get_members(sb);
333 return "Invalid superblock: member info area missing";
335 err = bch2_sb_field_validate(sb, &mi->field);
339 vstruct_for_each(sb, f) {
340 if (le32_to_cpu(f->type) == BCH_SB_FIELD_members)
343 err = bch2_sb_field_validate(sb, f);
353 static void bch2_sb_update(struct bch_fs *c)
355 struct bch_sb *src = c->disk_sb.sb;
356 struct bch_sb_field_members *mi = bch2_sb_get_members(src);
360 lockdep_assert_held(&c->sb_lock);
362 c->sb.uuid = src->uuid;
363 c->sb.user_uuid = src->user_uuid;
364 c->sb.version = le16_to_cpu(src->version);
365 c->sb.version_min = le16_to_cpu(src->version_min);
366 c->sb.nr_devices = src->nr_devices;
367 c->sb.clean = BCH_SB_CLEAN(src);
368 c->sb.encryption_type = BCH_SB_ENCRYPTION_TYPE(src);
369 c->sb.encoded_extent_max= 1 << BCH_SB_ENCODED_EXTENT_MAX_BITS(src);
370 c->sb.time_base_lo = le64_to_cpu(src->time_base_lo);
371 c->sb.time_base_hi = le32_to_cpu(src->time_base_hi);
372 c->sb.time_precision = le32_to_cpu(src->time_precision);
373 c->sb.features = le64_to_cpu(src->features[0]);
374 c->sb.compat = le64_to_cpu(src->compat[0]);
376 for_each_member_device(ca, c, i)
377 ca->mi = bch2_mi_to_cpu(mi->members + i);
380 /* doesn't copy member info */
381 static void __copy_super(struct bch_sb_handle *dst_handle, struct bch_sb *src)
383 struct bch_sb_field *src_f, *dst_f;
384 struct bch_sb *dst = dst_handle->sb;
387 dst->version = src->version;
388 dst->version_min = src->version_min;
390 dst->uuid = src->uuid;
391 dst->user_uuid = src->user_uuid;
392 memcpy(dst->label, src->label, sizeof(dst->label));
394 dst->block_size = src->block_size;
395 dst->nr_devices = src->nr_devices;
397 dst->time_base_lo = src->time_base_lo;
398 dst->time_base_hi = src->time_base_hi;
399 dst->time_precision = src->time_precision;
401 memcpy(dst->flags, src->flags, sizeof(dst->flags));
402 memcpy(dst->features, src->features, sizeof(dst->features));
403 memcpy(dst->compat, src->compat, sizeof(dst->compat));
405 for (i = 0; i < BCH_SB_FIELD_NR; i++) {
406 if (i == BCH_SB_FIELD_journal)
409 src_f = bch2_sb_field_get(src, i);
410 dst_f = bch2_sb_field_get(dst, i);
411 dst_f = __bch2_sb_field_resize(dst_handle, dst_f,
412 src_f ? le32_to_cpu(src_f->u64s) : 0);
415 memcpy(dst_f, src_f, vstruct_bytes(src_f));
419 int bch2_sb_to_fs(struct bch_fs *c, struct bch_sb *src)
421 struct bch_sb_field_journal *journal_buckets =
422 bch2_sb_get_journal(src);
423 unsigned journal_u64s = journal_buckets
424 ? le32_to_cpu(journal_buckets->field.u64s)
428 lockdep_assert_held(&c->sb_lock);
430 ret = bch2_sb_realloc(&c->disk_sb,
431 le32_to_cpu(src->u64s) - journal_u64s);
435 __copy_super(&c->disk_sb, src);
437 ret = bch2_sb_replicas_to_cpu_replicas(c);
441 ret = bch2_sb_disk_groups_to_cpu(c);
449 int bch2_sb_from_fs(struct bch_fs *c, struct bch_dev *ca)
451 struct bch_sb *src = c->disk_sb.sb, *dst = ca->disk_sb.sb;
452 struct bch_sb_field_journal *journal_buckets =
453 bch2_sb_get_journal(dst);
454 unsigned journal_u64s = journal_buckets
455 ? le32_to_cpu(journal_buckets->field.u64s)
457 unsigned u64s = le32_to_cpu(src->u64s) + journal_u64s;
460 ret = bch2_sb_realloc(&ca->disk_sb, u64s);
464 __copy_super(&ca->disk_sb, src);
468 /* read superblock: */
470 static const char *read_one_super(struct bch_sb_handle *sb, u64 offset)
472 struct bch_csum csum;
476 bio_set_dev(sb->bio, sb->bdev);
477 sb->bio->bi_iter.bi_sector = offset;
478 bio_set_op_attrs(sb->bio, REQ_OP_READ, REQ_SYNC|REQ_META);
479 bch2_bio_map(sb->bio, sb->sb, PAGE_SIZE << sb->page_order);
481 if (submit_bio_wait(sb->bio))
484 if (uuid_le_cmp(sb->sb->magic, BCACHE_MAGIC))
485 return "Not a bcachefs superblock";
487 if (le16_to_cpu(sb->sb->version) < bcachefs_metadata_version_min ||
488 le16_to_cpu(sb->sb->version) >= bcachefs_metadata_version_max)
489 return "Unsupported superblock version";
491 bytes = vstruct_bytes(sb->sb);
493 if (bytes > 512 << sb->sb->layout.sb_max_size_bits)
494 return "Bad superblock: too big";
496 if (get_order(bytes) > sb->page_order) {
497 if (bch2_sb_realloc(sb, le32_to_cpu(sb->sb->u64s)))
498 return "cannot allocate memory";
502 if (BCH_SB_CSUM_TYPE(sb->sb) >= BCH_CSUM_NR)
503 return "unknown csum type";
505 /* XXX: verify MACs */
506 csum = csum_vstruct(NULL, BCH_SB_CSUM_TYPE(sb->sb),
507 null_nonce(), sb->sb);
509 if (bch2_crc_cmp(csum, sb->sb->csum))
510 return "bad checksum reading superblock";
512 sb->seq = le64_to_cpu(sb->sb->seq);
517 int bch2_read_super(const char *path, struct bch_opts *opts,
518 struct bch_sb_handle *sb)
520 u64 offset = opt_get(*opts, sb);
521 struct bch_sb_layout layout;
526 pr_verbose_init(*opts, "");
528 memset(sb, 0, sizeof(*sb));
529 sb->mode = FMODE_READ;
532 if (!opt_get(*opts, noexcl))
533 sb->mode |= FMODE_EXCL;
535 if (!opt_get(*opts, nochanges))
536 sb->mode |= FMODE_WRITE;
538 sb->bdev = blkdev_get_by_path(path, sb->mode, sb);
539 if (IS_ERR(sb->bdev) &&
540 PTR_ERR(sb->bdev) == -EACCES &&
541 opt_get(*opts, read_only)) {
542 sb->mode &= ~FMODE_WRITE;
544 sb->bdev = blkdev_get_by_path(path, sb->mode, sb);
545 if (!IS_ERR(sb->bdev))
546 opt_set(*opts, nochanges, true);
549 if (IS_ERR(sb->bdev)) {
550 ret = PTR_ERR(sb->bdev);
554 err = "cannot allocate memory";
555 ret = bch2_sb_realloc(sb, 0);
560 err = "dynamic fault";
561 if (bch2_fs_init_fault("read_super"))
565 err = read_one_super(sb, offset);
569 if (opt_defined(*opts, sb))
572 pr_err("error reading default superblock: %s", err);
575 * Error reading primary superblock - read location of backup
579 bio_set_dev(sb->bio, sb->bdev);
580 sb->bio->bi_iter.bi_sector = BCH_SB_LAYOUT_SECTOR;
581 bio_set_op_attrs(sb->bio, REQ_OP_READ, REQ_SYNC|REQ_META);
583 * use sb buffer to read layout, since sb buffer is page aligned but
586 bch2_bio_map(sb->bio, sb->sb, sizeof(struct bch_sb_layout));
589 if (submit_bio_wait(sb->bio))
592 memcpy(&layout, sb->sb, sizeof(layout));
593 err = validate_sb_layout(&layout);
597 for (i = layout.sb_offset;
598 i < layout.sb_offset + layout.nr_superblocks; i++) {
599 offset = le64_to_cpu(*i);
601 if (offset == opt_get(*opts, sb))
604 err = read_one_super(sb, offset);
613 err = "Superblock block size smaller than device block size";
615 if (le16_to_cpu(sb->sb->block_size) << 9 <
616 bdev_logical_block_size(sb->bdev))
620 sb->have_layout = true;
622 pr_verbose_init(*opts, "ret %i", ret);
626 pr_err("error reading superblock: %s", err);
630 /* write superblock: */
632 static void write_super_endio(struct bio *bio)
634 struct bch_dev *ca = bio->bi_private;
636 /* XXX: return errors directly */
638 if (bch2_dev_io_err_on(bio->bi_status, ca, "superblock write error: %s",
639 bch2_blk_status_to_str(bio->bi_status)))
640 ca->sb_write_error = 1;
642 closure_put(&ca->fs->sb_write);
643 percpu_ref_put(&ca->io_ref);
646 static void read_back_super(struct bch_fs *c, struct bch_dev *ca)
648 struct bch_sb *sb = ca->disk_sb.sb;
649 struct bio *bio = ca->disk_sb.bio;
652 bio_set_dev(bio, ca->disk_sb.bdev);
653 bio->bi_iter.bi_sector = le64_to_cpu(sb->layout.sb_offset[0]);
654 bio->bi_end_io = write_super_endio;
655 bio->bi_private = ca;
656 bio_set_op_attrs(bio, REQ_OP_READ, REQ_SYNC|REQ_META);
657 bch2_bio_map(bio, ca->sb_read_scratch, PAGE_SIZE);
659 this_cpu_add(ca->io_done->sectors[READ][BCH_DATA_sb],
662 percpu_ref_get(&ca->io_ref);
663 closure_bio_submit(bio, &c->sb_write);
666 static void write_one_super(struct bch_fs *c, struct bch_dev *ca, unsigned idx)
668 struct bch_sb *sb = ca->disk_sb.sb;
669 struct bio *bio = ca->disk_sb.bio;
671 sb->offset = sb->layout.sb_offset[idx];
673 SET_BCH_SB_CSUM_TYPE(sb, c->opts.metadata_checksum);
674 sb->csum = csum_vstruct(c, BCH_SB_CSUM_TYPE(sb),
678 bio_set_dev(bio, ca->disk_sb.bdev);
679 bio->bi_iter.bi_sector = le64_to_cpu(sb->offset);
680 bio->bi_end_io = write_super_endio;
681 bio->bi_private = ca;
682 bio_set_op_attrs(bio, REQ_OP_WRITE, REQ_SYNC|REQ_META);
683 bch2_bio_map(bio, sb,
684 roundup((size_t) vstruct_bytes(sb),
685 bdev_logical_block_size(ca->disk_sb.bdev)));
687 this_cpu_add(ca->io_done->sectors[WRITE][BCH_DATA_sb],
690 percpu_ref_get(&ca->io_ref);
691 closure_bio_submit(bio, &c->sb_write);
694 int bch2_write_super(struct bch_fs *c)
696 struct closure *cl = &c->sb_write;
698 unsigned i, sb = 0, nr_wrote;
700 struct bch_devs_mask sb_written;
701 bool wrote, can_mount_without_written, can_mount_with_written;
704 lockdep_assert_held(&c->sb_lock);
706 closure_init_stack(cl);
707 memset(&sb_written, 0, sizeof(sb_written));
709 le64_add_cpu(&c->disk_sb.sb->seq, 1);
711 if (test_bit(BCH_FS_ERROR, &c->flags))
712 SET_BCH_SB_HAS_ERRORS(c->disk_sb.sb, 1);
714 SET_BCH_SB_BIG_ENDIAN(c->disk_sb.sb, CPU_BIG_ENDIAN);
716 for_each_online_member(ca, c, i)
717 bch2_sb_from_fs(c, ca);
719 for_each_online_member(ca, c, i) {
720 err = bch2_sb_validate(&ca->disk_sb);
722 bch2_fs_inconsistent(c, "sb invalid before write: %s", err);
728 if (c->opts.nochanges)
731 for_each_online_member(ca, c, i) {
732 __set_bit(ca->dev_idx, sb_written.d);
733 ca->sb_write_error = 0;
736 for_each_online_member(ca, c, i)
737 read_back_super(c, ca);
740 for_each_online_member(ca, c, i) {
741 if (!ca->sb_write_error &&
743 le64_to_cpu(ca->sb_read_scratch->seq)) {
744 bch2_fs_fatal_error(c,
745 "Superblock modified by another process");
746 percpu_ref_put(&ca->io_ref);
754 for_each_online_member(ca, c, i)
755 if (!ca->sb_write_error &&
756 sb < ca->disk_sb.sb->layout.nr_superblocks) {
757 write_one_super(c, ca, sb);
764 for_each_online_member(ca, c, i) {
765 if (ca->sb_write_error)
766 __clear_bit(ca->dev_idx, sb_written.d);
768 ca->disk_sb.seq = le64_to_cpu(ca->disk_sb.sb->seq);
771 nr_wrote = dev_mask_nr(&sb_written);
773 can_mount_with_written =
774 bch2_have_enough_devs(c, sb_written, BCH_FORCE_IF_DEGRADED, false);
776 for (i = 0; i < ARRAY_SIZE(sb_written.d); i++)
777 sb_written.d[i] = ~sb_written.d[i];
779 can_mount_without_written =
780 bch2_have_enough_devs(c, sb_written, BCH_FORCE_IF_DEGRADED, false);
783 * If we would be able to mount _without_ the devices we successfully
784 * wrote superblocks to, we weren't able to write to enough devices:
786 * Exception: if we can mount without the successes because we haven't
787 * written anything (new filesystem), we continue if we'd be able to
788 * mount with the devices we did successfully write to:
790 if (bch2_fs_fatal_err_on(!nr_wrote ||
791 !can_mount_with_written ||
792 (can_mount_without_written &&
793 !can_mount_with_written), c,
794 "Unable to write superblock to sufficient devices"))
797 /* Make new options visible after they're persistent: */
802 void __bch2_check_set_feature(struct bch_fs *c, unsigned feat)
804 mutex_lock(&c->sb_lock);
805 if (!(c->sb.features & (1ULL << feat))) {
806 c->disk_sb.sb->features[0] |= cpu_to_le64(1ULL << feat);
810 mutex_unlock(&c->sb_lock);
813 /* BCH_SB_FIELD_journal: */
815 static int u64_cmp(const void *_l, const void *_r)
817 u64 l = *((const u64 *) _l), r = *((const u64 *) _r);
819 return l < r ? -1 : l > r ? 1 : 0;
822 static const char *bch2_sb_validate_journal(struct bch_sb *sb,
823 struct bch_sb_field *f)
825 struct bch_sb_field_journal *journal = field_to_type(f, journal);
826 struct bch_member *m = bch2_sb_get_members(sb)->members + sb->dev_idx;
832 journal = bch2_sb_get_journal(sb);
836 nr = bch2_nr_journal_buckets(journal);
840 b = kmalloc_array(sizeof(u64), nr, GFP_KERNEL);
842 return "cannot allocate memory";
844 for (i = 0; i < nr; i++)
845 b[i] = le64_to_cpu(journal->buckets[i]);
847 sort(b, nr, sizeof(u64), u64_cmp, NULL);
849 err = "journal bucket at sector 0";
853 err = "journal bucket before first bucket";
854 if (m && b[0] < le16_to_cpu(m->first_bucket))
857 err = "journal bucket past end of device";
858 if (m && b[nr - 1] >= le64_to_cpu(m->nbuckets))
861 err = "duplicate journal buckets";
862 for (i = 0; i + 1 < nr; i++)
863 if (b[i] == b[i + 1])
872 static const struct bch_sb_field_ops bch_sb_field_ops_journal = {
873 .validate = bch2_sb_validate_journal,
876 /* BCH_SB_FIELD_members: */
878 static const char *bch2_sb_validate_members(struct bch_sb *sb,
879 struct bch_sb_field *f)
881 struct bch_sb_field_members *mi = field_to_type(f, members);
882 struct bch_member *m;
884 if ((void *) (mi->members + sb->nr_devices) >
885 vstruct_end(&mi->field))
886 return "Invalid superblock: bad member info";
888 for (m = mi->members;
889 m < mi->members + sb->nr_devices;
891 if (!bch2_member_exists(m))
894 if (le64_to_cpu(m->nbuckets) > LONG_MAX)
895 return "Too many buckets";
897 if (le64_to_cpu(m->nbuckets) -
898 le16_to_cpu(m->first_bucket) < BCH_MIN_NR_NBUCKETS)
899 return "Not enough buckets";
901 if (le16_to_cpu(m->bucket_size) <
902 le16_to_cpu(sb->block_size))
903 return "bucket size smaller than block size";
905 if (le16_to_cpu(m->bucket_size) <
906 BCH_SB_BTREE_NODE_SIZE(sb))
907 return "bucket size smaller than btree node size";
913 static const struct bch_sb_field_ops bch_sb_field_ops_members = {
914 .validate = bch2_sb_validate_members,
917 /* BCH_SB_FIELD_crypt: */
919 static const char *bch2_sb_validate_crypt(struct bch_sb *sb,
920 struct bch_sb_field *f)
922 struct bch_sb_field_crypt *crypt = field_to_type(f, crypt);
924 if (vstruct_bytes(&crypt->field) != sizeof(*crypt))
925 return "invalid field crypt: wrong size";
927 if (BCH_CRYPT_KDF_TYPE(crypt))
928 return "invalid field crypt: bad kdf type";
933 static const struct bch_sb_field_ops bch_sb_field_ops_crypt = {
934 .validate = bch2_sb_validate_crypt,
937 /* BCH_SB_FIELD_clean: */
939 int bch2_sb_clean_validate(struct bch_fs *c, struct bch_sb_field_clean *clean, int write)
941 struct jset_entry *entry;
944 for (entry = clean->start;
945 entry < (struct jset_entry *) vstruct_end(&clean->field);
946 entry = vstruct_next(entry)) {
947 ret = bch2_journal_entry_validate(c, "superblock", entry,
948 le16_to_cpu(c->disk_sb.sb->version),
949 BCH_SB_BIG_ENDIAN(c->disk_sb.sb),
958 int bch2_fs_mark_dirty(struct bch_fs *c)
963 * Unconditionally write superblock, to verify it hasn't changed before
967 mutex_lock(&c->sb_lock);
968 if (c->opts.version_upgrade) {
969 c->disk_sb.sb->version = le16_to_cpu(bcachefs_metadata_version_current);
970 c->disk_sb.sb->features[0] |= BCH_SB_FEATURES_ALL;
973 SET_BCH_SB_CLEAN(c->disk_sb.sb, false);
974 c->disk_sb.sb->features[0] |= BCH_SB_FEATURES_ALWAYS;
975 ret = bch2_write_super(c);
976 mutex_unlock(&c->sb_lock);
981 static struct jset_entry *jset_entry_init(struct jset_entry **end, size_t size)
983 struct jset_entry *entry = *end;
984 unsigned u64s = DIV_ROUND_UP(size, sizeof(u64));
986 memset(entry, 0, u64s * sizeof(u64));
988 * The u64s field counts from the start of data, ignoring the shared
991 entry->u64s = u64s - 1;
993 *end = vstruct_next(*end);
997 void bch2_journal_super_entries_add_common(struct bch_fs *c,
998 struct jset_entry **end,
1004 percpu_down_write(&c->mark_lock);
1007 for (i = 0; i < ARRAY_SIZE(c->usage); i++)
1008 bch2_fs_usage_acc_to_base(c, i);
1010 bch2_fs_usage_acc_to_base(c, journal_seq & JOURNAL_BUF_MASK);
1014 struct jset_entry_usage *u =
1015 container_of(jset_entry_init(end, sizeof(*u)),
1016 struct jset_entry_usage, entry);
1018 u->entry.type = BCH_JSET_ENTRY_usage;
1019 u->entry.btree_id = FS_USAGE_INODES;
1020 u->v = cpu_to_le64(c->usage_base->nr_inodes);
1024 struct jset_entry_usage *u =
1025 container_of(jset_entry_init(end, sizeof(*u)),
1026 struct jset_entry_usage, entry);
1028 u->entry.type = BCH_JSET_ENTRY_usage;
1029 u->entry.btree_id = FS_USAGE_KEY_VERSION;
1030 u->v = cpu_to_le64(atomic64_read(&c->key_version));
1033 for (i = 0; i < BCH_REPLICAS_MAX; i++) {
1034 struct jset_entry_usage *u =
1035 container_of(jset_entry_init(end, sizeof(*u)),
1036 struct jset_entry_usage, entry);
1038 u->entry.type = BCH_JSET_ENTRY_usage;
1039 u->entry.btree_id = FS_USAGE_RESERVED;
1041 u->v = cpu_to_le64(c->usage_base->persistent_reserved[i]);
1044 for (i = 0; i < c->replicas.nr; i++) {
1045 struct bch_replicas_entry *e =
1046 cpu_replicas_entry(&c->replicas, i);
1047 struct jset_entry_data_usage *u =
1048 container_of(jset_entry_init(end, sizeof(*u) + e->nr_devs),
1049 struct jset_entry_data_usage, entry);
1051 u->entry.type = BCH_JSET_ENTRY_data_usage;
1052 u->v = cpu_to_le64(c->usage_base->replicas[i]);
1053 memcpy(&u->r, e, replicas_entry_bytes(e));
1056 for_each_member_device(ca, c, dev) {
1057 unsigned b = sizeof(struct jset_entry_dev_usage) +
1058 sizeof(struct jset_entry_dev_usage_type) * BCH_DATA_NR;
1059 struct jset_entry_dev_usage *u =
1060 container_of(jset_entry_init(end, b),
1061 struct jset_entry_dev_usage, entry);
1063 u->entry.type = BCH_JSET_ENTRY_dev_usage;
1064 u->dev = cpu_to_le32(dev);
1065 u->buckets_ec = cpu_to_le64(ca->usage_base->buckets_ec);
1066 u->buckets_unavailable = cpu_to_le64(ca->usage_base->buckets_unavailable);
1068 for (i = 0; i < BCH_DATA_NR; i++) {
1069 u->d[i].buckets = cpu_to_le64(ca->usage_base->d[i].buckets);
1070 u->d[i].sectors = cpu_to_le64(ca->usage_base->d[i].sectors);
1071 u->d[i].fragmented = cpu_to_le64(ca->usage_base->d[i].fragmented);
1075 percpu_up_write(&c->mark_lock);
1077 for (i = 0; i < 2; i++) {
1078 struct jset_entry_clock *clock =
1079 container_of(jset_entry_init(end, sizeof(*clock)),
1080 struct jset_entry_clock, entry);
1082 clock->entry.type = BCH_JSET_ENTRY_clock;
1084 clock->time = atomic64_read(&c->io_clock[i].now);
1088 void bch2_fs_mark_clean(struct bch_fs *c)
1090 struct bch_sb_field_clean *sb_clean;
1091 struct jset_entry *entry;
1095 mutex_lock(&c->sb_lock);
1096 if (BCH_SB_CLEAN(c->disk_sb.sb))
1099 SET_BCH_SB_CLEAN(c->disk_sb.sb, true);
1101 c->disk_sb.sb->compat[0] |= 1ULL << BCH_COMPAT_FEAT_ALLOC_INFO;
1102 c->disk_sb.sb->compat[0] |= 1ULL << BCH_COMPAT_FEAT_ALLOC_METADATA;
1103 c->disk_sb.sb->features[0] &= ~(1ULL << BCH_FEATURE_extents_above_btree_updates);
1104 c->disk_sb.sb->features[0] &= ~(1ULL << BCH_FEATURE_btree_updates_journalled);
1106 u64s = sizeof(*sb_clean) / sizeof(u64) + c->journal.entry_u64s_reserved;
1108 sb_clean = bch2_sb_resize_clean(&c->disk_sb, u64s);
1110 bch_err(c, "error resizing superblock while setting filesystem clean");
1114 sb_clean->flags = 0;
1115 sb_clean->journal_seq = cpu_to_le64(journal_cur_seq(&c->journal) - 1);
1117 /* Trying to catch outstanding bug: */
1118 BUG_ON(le64_to_cpu(sb_clean->journal_seq) > S64_MAX);
1120 entry = sb_clean->start;
1121 bch2_journal_super_entries_add_common(c, &entry, 0);
1122 entry = bch2_btree_roots_to_journal_entries(c, entry, entry);
1123 BUG_ON((void *) entry > vstruct_end(&sb_clean->field));
1126 vstruct_end(&sb_clean->field) - (void *) entry);
1129 * this should be in the write path, and we should be validating every
1130 * superblock section:
1132 ret = bch2_sb_clean_validate(c, sb_clean, WRITE);
1134 bch_err(c, "error writing marking filesystem clean: validate error");
1138 bch2_write_super(c);
1140 mutex_unlock(&c->sb_lock);
1143 static const char *bch2_sb_validate_clean(struct bch_sb *sb,
1144 struct bch_sb_field *f)
1146 struct bch_sb_field_clean *clean = field_to_type(f, clean);
1148 if (vstruct_bytes(&clean->field) < sizeof(*clean))
1149 return "invalid field crypt: wrong size";
1154 static const struct bch_sb_field_ops bch_sb_field_ops_clean = {
1155 .validate = bch2_sb_validate_clean,
1158 static const struct bch_sb_field_ops *bch2_sb_field_ops[] = {
1160 [BCH_SB_FIELD_##f] = &bch_sb_field_ops_##f,
1165 static const char *bch2_sb_field_validate(struct bch_sb *sb,
1166 struct bch_sb_field *f)
1168 unsigned type = le32_to_cpu(f->type);
1170 return type < BCH_SB_FIELD_NR
1171 ? bch2_sb_field_ops[type]->validate(sb, f)
1175 void bch2_sb_field_to_text(struct printbuf *out, struct bch_sb *sb,
1176 struct bch_sb_field *f)
1178 unsigned type = le32_to_cpu(f->type);
1179 const struct bch_sb_field_ops *ops = type < BCH_SB_FIELD_NR
1180 ? bch2_sb_field_ops[type] : NULL;
1183 pr_buf(out, "%s", bch2_sb_fields[type]);
1185 pr_buf(out, "(unknown field %u)", type);
1187 pr_buf(out, " (size %llu):", vstruct_bytes(f));
1189 if (ops && ops->to_text)
1190 bch2_sb_field_ops[type]->to_text(out, sb, f);