]> git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/super-io.c
Update bcachefs sources to a1b6677dca57 bcachefs: Fix looping around bch2_propagate_k...
[bcachefs-tools-debian] / libbcachefs / super-io.c
1 // SPDX-License-Identifier: GPL-2.0
2
3 #include "bcachefs.h"
4 #include "checksum.h"
5 #include "counters.h"
6 #include "disk_groups.h"
7 #include "ec.h"
8 #include "error.h"
9 #include "journal.h"
10 #include "journal_sb.h"
11 #include "journal_seq_blacklist.h"
12 #include "recovery.h"
13 #include "replicas.h"
14 #include "quota.h"
15 #include "sb-clean.h"
16 #include "sb-members.h"
17 #include "super-io.h"
18 #include "super.h"
19 #include "trace.h"
20 #include "vstructs.h"
21
22 #include <linux/backing-dev.h>
23 #include <linux/sort.h>
24
25 static const struct blk_holder_ops bch2_sb_handle_bdev_ops = {
26 };
27
28 struct bch2_metadata_version {
29         u16             version;
30         const char      *name;
31         u64             recovery_passes;
32 };
33
34 static const struct bch2_metadata_version bch2_metadata_versions[] = {
35 #define x(n, v, _recovery_passes) {             \
36         .version = v,                           \
37         .name = #n,                             \
38         .recovery_passes = _recovery_passes,    \
39 },
40         BCH_METADATA_VERSIONS()
41 #undef x
42 };
43
44 void bch2_version_to_text(struct printbuf *out, unsigned v)
45 {
46         const char *str = "(unknown version)";
47
48         for (unsigned i = 0; i < ARRAY_SIZE(bch2_metadata_versions); i++)
49                 if (bch2_metadata_versions[i].version == v) {
50                         str = bch2_metadata_versions[i].name;
51                         break;
52                 }
53
54         prt_printf(out, "%u.%u: %s", BCH_VERSION_MAJOR(v), BCH_VERSION_MINOR(v), str);
55 }
56
57 unsigned bch2_latest_compatible_version(unsigned v)
58 {
59         if (!BCH_VERSION_MAJOR(v))
60                 return v;
61
62         for (unsigned i = 0; i < ARRAY_SIZE(bch2_metadata_versions); i++)
63                 if (bch2_metadata_versions[i].version > v &&
64                     BCH_VERSION_MAJOR(bch2_metadata_versions[i].version) ==
65                     BCH_VERSION_MAJOR(v))
66                         v = bch2_metadata_versions[i].version;
67
68         return v;
69 }
70
71 u64 bch2_upgrade_recovery_passes(struct bch_fs *c,
72                                  unsigned old_version,
73                                  unsigned new_version)
74 {
75         u64 ret = 0;
76
77         for (const struct bch2_metadata_version *i = bch2_metadata_versions;
78              i < bch2_metadata_versions + ARRAY_SIZE(bch2_metadata_versions);
79              i++)
80                 if (i->version > old_version && i->version <= new_version) {
81                         if (i->recovery_passes & RECOVERY_PASS_ALL_FSCK)
82                                 ret |= bch2_fsck_recovery_passes();
83                         ret |= i->recovery_passes;
84                 }
85
86         return ret &= ~RECOVERY_PASS_ALL_FSCK;
87 }
88
89 const char * const bch2_sb_fields[] = {
90 #define x(name, nr)     #name,
91         BCH_SB_FIELDS()
92 #undef x
93         NULL
94 };
95
96 static int bch2_sb_field_validate(struct bch_sb *, struct bch_sb_field *,
97                                   struct printbuf *);
98
99 struct bch_sb_field *bch2_sb_field_get(struct bch_sb *sb,
100                                       enum bch_sb_field_type type)
101 {
102         struct bch_sb_field *f;
103
104         /* XXX: need locking around superblock to access optional fields */
105
106         vstruct_for_each(sb, f)
107                 if (le32_to_cpu(f->type) == type)
108                         return f;
109         return NULL;
110 }
111
112 static struct bch_sb_field *__bch2_sb_field_resize(struct bch_sb_handle *sb,
113                                                    struct bch_sb_field *f,
114                                                    unsigned u64s)
115 {
116         unsigned old_u64s = f ? le32_to_cpu(f->u64s) : 0;
117         unsigned sb_u64s = le32_to_cpu(sb->sb->u64s) + u64s - old_u64s;
118
119         BUG_ON(__vstruct_bytes(struct bch_sb, sb_u64s) > sb->buffer_size);
120
121         if (!f && !u64s) {
122                 /* nothing to do: */
123         } else if (!f) {
124                 f = vstruct_last(sb->sb);
125                 memset(f, 0, sizeof(u64) * u64s);
126                 f->u64s = cpu_to_le32(u64s);
127                 f->type = 0;
128         } else {
129                 void *src, *dst;
130
131                 src = vstruct_end(f);
132
133                 if (u64s) {
134                         f->u64s = cpu_to_le32(u64s);
135                         dst = vstruct_end(f);
136                 } else {
137                         dst = f;
138                 }
139
140                 memmove(dst, src, vstruct_end(sb->sb) - src);
141
142                 if (dst > src)
143                         memset(src, 0, dst - src);
144         }
145
146         sb->sb->u64s = cpu_to_le32(sb_u64s);
147
148         return u64s ? f : NULL;
149 }
150
151 void bch2_sb_field_delete(struct bch_sb_handle *sb,
152                           enum bch_sb_field_type type)
153 {
154         struct bch_sb_field *f = bch2_sb_field_get(sb->sb, type);
155
156         if (f)
157                 __bch2_sb_field_resize(sb, f, 0);
158 }
159
160 /* Superblock realloc/free: */
161
162 void bch2_free_super(struct bch_sb_handle *sb)
163 {
164         kfree(sb->bio);
165         if (!IS_ERR_OR_NULL(sb->bdev))
166                 blkdev_put(sb->bdev, sb->holder);
167         kfree(sb->holder);
168
169         kfree(sb->sb);
170         memset(sb, 0, sizeof(*sb));
171 }
172
173 int bch2_sb_realloc(struct bch_sb_handle *sb, unsigned u64s)
174 {
175         size_t new_bytes = __vstruct_bytes(struct bch_sb, u64s);
176         size_t new_buffer_size;
177         struct bch_sb *new_sb;
178         struct bio *bio;
179
180         if (sb->bdev)
181                 new_bytes = max_t(size_t, new_bytes, bdev_logical_block_size(sb->bdev));
182
183         new_buffer_size = roundup_pow_of_two(new_bytes);
184
185         if (sb->sb && sb->buffer_size >= new_buffer_size)
186                 return 0;
187
188         if (sb->sb && sb->have_layout) {
189                 u64 max_bytes = 512 << sb->sb->layout.sb_max_size_bits;
190
191                 if (new_bytes > max_bytes) {
192                         pr_err("%pg: superblock too big: want %zu but have %llu",
193                                sb->bdev, new_bytes, max_bytes);
194                         return -BCH_ERR_ENOSPC_sb;
195                 }
196         }
197
198         if (sb->buffer_size >= new_buffer_size && sb->sb)
199                 return 0;
200
201         if (dynamic_fault("bcachefs:add:super_realloc"))
202                 return -BCH_ERR_ENOMEM_sb_realloc_injected;
203
204         new_sb = krealloc(sb->sb, new_buffer_size, GFP_NOFS|__GFP_ZERO);
205         if (!new_sb)
206                 return -BCH_ERR_ENOMEM_sb_buf_realloc;
207
208         sb->sb = new_sb;
209
210         if (sb->have_bio) {
211                 unsigned nr_bvecs = buf_pages(sb->sb, new_buffer_size);
212
213                 bio = bio_kmalloc(nr_bvecs, GFP_KERNEL);
214                 if (!bio)
215                         return -BCH_ERR_ENOMEM_sb_bio_realloc;
216
217                 bio_init(bio, NULL, bio->bi_inline_vecs, nr_bvecs, 0);
218
219                 kfree(sb->bio);
220                 sb->bio = bio;
221         }
222
223         sb->buffer_size = new_buffer_size;
224
225         return 0;
226 }
227
228 struct bch_sb_field *bch2_sb_field_resize(struct bch_sb_handle *sb,
229                                           enum bch_sb_field_type type,
230                                           unsigned u64s)
231 {
232         struct bch_sb_field *f = bch2_sb_field_get(sb->sb, type);
233         ssize_t old_u64s = f ? le32_to_cpu(f->u64s) : 0;
234         ssize_t d = -old_u64s + u64s;
235
236         if (bch2_sb_realloc(sb, le32_to_cpu(sb->sb->u64s) + d))
237                 return NULL;
238
239         if (sb->fs_sb) {
240                 struct bch_fs *c = container_of(sb, struct bch_fs, disk_sb);
241                 struct bch_dev *ca;
242                 unsigned i;
243
244                 lockdep_assert_held(&c->sb_lock);
245
246                 /* XXX: we're not checking that offline device have enough space */
247
248                 for_each_online_member(ca, c, i) {
249                         struct bch_sb_handle *dev_sb = &ca->disk_sb;
250
251                         if (bch2_sb_realloc(dev_sb, le32_to_cpu(dev_sb->sb->u64s) + d)) {
252                                 percpu_ref_put(&ca->ref);
253                                 return NULL;
254                         }
255                 }
256         }
257
258         f = bch2_sb_field_get(sb->sb, type);
259         f = __bch2_sb_field_resize(sb, f, u64s);
260         if (f)
261                 f->type = cpu_to_le32(type);
262         return f;
263 }
264
265 /* Superblock validate: */
266
267 static int validate_sb_layout(struct bch_sb_layout *layout, struct printbuf *out)
268 {
269         u64 offset, prev_offset, max_sectors;
270         unsigned i;
271
272         BUILD_BUG_ON(sizeof(struct bch_sb_layout) != 512);
273
274         if (!uuid_equal(&layout->magic, &BCACHE_MAGIC) &&
275             !uuid_equal(&layout->magic, &BCHFS_MAGIC)) {
276                 prt_printf(out, "Not a bcachefs superblock layout");
277                 return -BCH_ERR_invalid_sb_layout;
278         }
279
280         if (layout->layout_type != 0) {
281                 prt_printf(out, "Invalid superblock layout type %u",
282                        layout->layout_type);
283                 return -BCH_ERR_invalid_sb_layout_type;
284         }
285
286         if (!layout->nr_superblocks) {
287                 prt_printf(out, "Invalid superblock layout: no superblocks");
288                 return -BCH_ERR_invalid_sb_layout_nr_superblocks;
289         }
290
291         if (layout->nr_superblocks > ARRAY_SIZE(layout->sb_offset)) {
292                 prt_printf(out, "Invalid superblock layout: too many superblocks");
293                 return -BCH_ERR_invalid_sb_layout_nr_superblocks;
294         }
295
296         max_sectors = 1 << layout->sb_max_size_bits;
297
298         prev_offset = le64_to_cpu(layout->sb_offset[0]);
299
300         for (i = 1; i < layout->nr_superblocks; i++) {
301                 offset = le64_to_cpu(layout->sb_offset[i]);
302
303                 if (offset < prev_offset + max_sectors) {
304                         prt_printf(out, "Invalid superblock layout: superblocks overlap\n"
305                                "  (sb %u ends at %llu next starts at %llu",
306                                i - 1, prev_offset + max_sectors, offset);
307                         return -BCH_ERR_invalid_sb_layout_superblocks_overlap;
308                 }
309                 prev_offset = offset;
310         }
311
312         return 0;
313 }
314
315 static int bch2_sb_compatible(struct bch_sb *sb, struct printbuf *out)
316 {
317         u16 version             = le16_to_cpu(sb->version);
318         u16 version_min         = le16_to_cpu(sb->version_min);
319
320         if (!bch2_version_compatible(version)) {
321                 prt_str(out, "Unsupported superblock version ");
322                 bch2_version_to_text(out, version);
323                 prt_str(out, " (min ");
324                 bch2_version_to_text(out, bcachefs_metadata_version_min);
325                 prt_str(out, ", max ");
326                 bch2_version_to_text(out, bcachefs_metadata_version_current);
327                 prt_str(out, ")");
328                 return -BCH_ERR_invalid_sb_version;
329         }
330
331         if (!bch2_version_compatible(version_min)) {
332                 prt_str(out, "Unsupported superblock version_min ");
333                 bch2_version_to_text(out, version_min);
334                 prt_str(out, " (min ");
335                 bch2_version_to_text(out, bcachefs_metadata_version_min);
336                 prt_str(out, ", max ");
337                 bch2_version_to_text(out, bcachefs_metadata_version_current);
338                 prt_str(out, ")");
339                 return -BCH_ERR_invalid_sb_version;
340         }
341
342         if (version_min > version) {
343                 prt_str(out, "Bad minimum version ");
344                 bch2_version_to_text(out, version_min);
345                 prt_str(out, ", greater than version field ");
346                 bch2_version_to_text(out, version);
347                 return -BCH_ERR_invalid_sb_version;
348         }
349
350         return 0;
351 }
352
353 static int bch2_sb_validate(struct bch_sb_handle *disk_sb, struct printbuf *out,
354                             int rw)
355 {
356         struct bch_sb *sb = disk_sb->sb;
357         struct bch_sb_field *f;
358         struct bch_sb_field_members *mi;
359         enum bch_opt_id opt_id;
360         u16 block_size;
361         int ret;
362
363         ret = bch2_sb_compatible(sb, out);
364         if (ret)
365                 return ret;
366
367         if (sb->features[1] ||
368             (le64_to_cpu(sb->features[0]) & (~0ULL << BCH_FEATURE_NR))) {
369                 prt_printf(out, "Filesystem has incompatible features");
370                 return -BCH_ERR_invalid_sb_features;
371         }
372
373         block_size = le16_to_cpu(sb->block_size);
374
375         if (block_size > PAGE_SECTORS) {
376                 prt_printf(out, "Block size too big (got %u, max %u)",
377                        block_size, PAGE_SECTORS);
378                 return -BCH_ERR_invalid_sb_block_size;
379         }
380
381         if (bch2_is_zero(sb->user_uuid.b, sizeof(sb->user_uuid))) {
382                 prt_printf(out, "Bad user UUID (got zeroes)");
383                 return -BCH_ERR_invalid_sb_uuid;
384         }
385
386         if (bch2_is_zero(sb->uuid.b, sizeof(sb->uuid))) {
387                 prt_printf(out, "Bad internal UUID (got zeroes)");
388                 return -BCH_ERR_invalid_sb_uuid;
389         }
390
391         if (!sb->nr_devices ||
392             sb->nr_devices > BCH_SB_MEMBERS_MAX) {
393                 prt_printf(out, "Bad number of member devices %u (max %u)",
394                        sb->nr_devices, BCH_SB_MEMBERS_MAX);
395                 return -BCH_ERR_invalid_sb_too_many_members;
396         }
397
398         if (sb->dev_idx >= sb->nr_devices) {
399                 prt_printf(out, "Bad dev_idx (got %u, nr_devices %u)",
400                        sb->dev_idx, sb->nr_devices);
401                 return -BCH_ERR_invalid_sb_dev_idx;
402         }
403
404         if (!sb->time_precision ||
405             le32_to_cpu(sb->time_precision) > NSEC_PER_SEC) {
406                 prt_printf(out, "Invalid time precision: %u (min 1, max %lu)",
407                        le32_to_cpu(sb->time_precision), NSEC_PER_SEC);
408                 return -BCH_ERR_invalid_sb_time_precision;
409         }
410
411         if (rw == READ) {
412                 /*
413                  * Been seeing a bug where these are getting inexplicably
414                  * zeroed, so we're now validating them, but we have to be
415                  * careful not to preven people's filesystems from mounting:
416                  */
417                 if (!BCH_SB_JOURNAL_FLUSH_DELAY(sb))
418                         SET_BCH_SB_JOURNAL_FLUSH_DELAY(sb, 1000);
419                 if (!BCH_SB_JOURNAL_RECLAIM_DELAY(sb))
420                         SET_BCH_SB_JOURNAL_RECLAIM_DELAY(sb, 1000);
421
422                 if (!BCH_SB_VERSION_UPGRADE_COMPLETE(sb))
423                         SET_BCH_SB_VERSION_UPGRADE_COMPLETE(sb, le16_to_cpu(sb->version));
424         }
425
426         for (opt_id = 0; opt_id < bch2_opts_nr; opt_id++) {
427                 const struct bch_option *opt = bch2_opt_table + opt_id;
428
429                 if (opt->get_sb != BCH2_NO_SB_OPT) {
430                         u64 v = bch2_opt_from_sb(sb, opt_id);
431
432                         prt_printf(out, "Invalid option ");
433                         ret = bch2_opt_validate(opt, v, out);
434                         if (ret)
435                                 return ret;
436
437                         printbuf_reset(out);
438                 }
439         }
440
441         /* validate layout */
442         ret = validate_sb_layout(&sb->layout, out);
443         if (ret)
444                 return ret;
445
446         vstruct_for_each(sb, f) {
447                 if (!f->u64s) {
448                         prt_printf(out, "Invalid superblock: optional field with size 0 (type %u)",
449                                le32_to_cpu(f->type));
450                         return -BCH_ERR_invalid_sb_field_size;
451                 }
452
453                 if (vstruct_next(f) > vstruct_last(sb)) {
454                         prt_printf(out, "Invalid superblock: optional field extends past end of superblock (type %u)",
455                                le32_to_cpu(f->type));
456                         return -BCH_ERR_invalid_sb_field_size;
457                 }
458         }
459
460         /* members must be validated first: */
461         mi = bch2_sb_get_members(sb);
462         if (!mi) {
463                 prt_printf(out, "Invalid superblock: member info area missing");
464                 return -BCH_ERR_invalid_sb_members_missing;
465         }
466
467         ret = bch2_sb_field_validate(sb, &mi->field, out);
468         if (ret)
469                 return ret;
470
471         vstruct_for_each(sb, f) {
472                 if (le32_to_cpu(f->type) == BCH_SB_FIELD_members)
473                         continue;
474
475                 ret = bch2_sb_field_validate(sb, f, out);
476                 if (ret)
477                         return ret;
478         }
479
480         return 0;
481 }
482
483 /* device open: */
484
485 static void bch2_sb_update(struct bch_fs *c)
486 {
487         struct bch_sb *src = c->disk_sb.sb;
488         struct bch_sb_field_members *mi = bch2_sb_get_members(src);
489         struct bch_dev *ca;
490         unsigned i;
491
492         lockdep_assert_held(&c->sb_lock);
493
494         c->sb.uuid              = src->uuid;
495         c->sb.user_uuid         = src->user_uuid;
496         c->sb.version           = le16_to_cpu(src->version);
497         c->sb.version_min       = le16_to_cpu(src->version_min);
498         c->sb.version_upgrade_complete = BCH_SB_VERSION_UPGRADE_COMPLETE(src);
499         c->sb.nr_devices        = src->nr_devices;
500         c->sb.clean             = BCH_SB_CLEAN(src);
501         c->sb.encryption_type   = BCH_SB_ENCRYPTION_TYPE(src);
502
503         c->sb.nsec_per_time_unit = le32_to_cpu(src->time_precision);
504         c->sb.time_units_per_sec = NSEC_PER_SEC / c->sb.nsec_per_time_unit;
505
506         /* XXX this is wrong, we need a 96 or 128 bit integer type */
507         c->sb.time_base_lo      = div_u64(le64_to_cpu(src->time_base_lo),
508                                           c->sb.nsec_per_time_unit);
509         c->sb.time_base_hi      = le32_to_cpu(src->time_base_hi);
510
511         c->sb.features          = le64_to_cpu(src->features[0]);
512         c->sb.compat            = le64_to_cpu(src->compat[0]);
513
514         for_each_member_device(ca, c, i)
515                 ca->mi = bch2_mi_to_cpu(mi->members + i);
516 }
517
518 static int __copy_super(struct bch_sb_handle *dst_handle, struct bch_sb *src)
519 {
520         struct bch_sb_field *src_f, *dst_f;
521         struct bch_sb *dst = dst_handle->sb;
522         unsigned i;
523
524         dst->version            = src->version;
525         dst->version_min        = src->version_min;
526         dst->seq                = src->seq;
527         dst->uuid               = src->uuid;
528         dst->user_uuid          = src->user_uuid;
529         memcpy(dst->label,      src->label, sizeof(dst->label));
530
531         dst->block_size         = src->block_size;
532         dst->nr_devices         = src->nr_devices;
533
534         dst->time_base_lo       = src->time_base_lo;
535         dst->time_base_hi       = src->time_base_hi;
536         dst->time_precision     = src->time_precision;
537
538         memcpy(dst->flags,      src->flags,     sizeof(dst->flags));
539         memcpy(dst->features,   src->features,  sizeof(dst->features));
540         memcpy(dst->compat,     src->compat,    sizeof(dst->compat));
541
542         for (i = 0; i < BCH_SB_FIELD_NR; i++) {
543                 int d;
544
545                 if ((1U << i) & BCH_SINGLE_DEVICE_SB_FIELDS)
546                         continue;
547
548                 src_f = bch2_sb_field_get(src, i);
549                 dst_f = bch2_sb_field_get(dst, i);
550
551                 d = (src_f ? le32_to_cpu(src_f->u64s) : 0) -
552                     (dst_f ? le32_to_cpu(dst_f->u64s) : 0);
553                 if (d > 0) {
554                         int ret = bch2_sb_realloc(dst_handle,
555                                         le32_to_cpu(dst_handle->sb->u64s) + d);
556
557                         if (ret)
558                                 return ret;
559
560                         dst = dst_handle->sb;
561                         dst_f = bch2_sb_field_get(dst, i);
562                 }
563
564                 dst_f = __bch2_sb_field_resize(dst_handle, dst_f,
565                                 src_f ? le32_to_cpu(src_f->u64s) : 0);
566
567                 if (src_f)
568                         memcpy(dst_f, src_f, vstruct_bytes(src_f));
569         }
570
571         return 0;
572 }
573
574 int bch2_sb_to_fs(struct bch_fs *c, struct bch_sb *src)
575 {
576         int ret;
577
578         lockdep_assert_held(&c->sb_lock);
579
580         ret =   bch2_sb_realloc(&c->disk_sb, 0) ?:
581                 __copy_super(&c->disk_sb, src) ?:
582                 bch2_sb_replicas_to_cpu_replicas(c) ?:
583                 bch2_sb_disk_groups_to_cpu(c);
584         if (ret)
585                 return ret;
586
587         bch2_sb_update(c);
588         return 0;
589 }
590
591 int bch2_sb_from_fs(struct bch_fs *c, struct bch_dev *ca)
592 {
593         return __copy_super(&ca->disk_sb, c->disk_sb.sb);
594 }
595
596 /* read superblock: */
597
598 static int read_one_super(struct bch_sb_handle *sb, u64 offset, struct printbuf *err)
599 {
600         struct bch_csum csum;
601         size_t bytes;
602         int ret;
603 reread:
604         bio_reset(sb->bio, sb->bdev, REQ_OP_READ|REQ_SYNC|REQ_META);
605         sb->bio->bi_iter.bi_sector = offset;
606         bch2_bio_map(sb->bio, sb->sb, sb->buffer_size);
607
608         ret = submit_bio_wait(sb->bio);
609         if (ret) {
610                 prt_printf(err, "IO error: %i", ret);
611                 return ret;
612         }
613
614         if (!uuid_equal(&sb->sb->magic, &BCACHE_MAGIC) &&
615             !uuid_equal(&sb->sb->magic, &BCHFS_MAGIC)) {
616                 prt_printf(err, "Not a bcachefs superblock");
617                 return -BCH_ERR_invalid_sb_magic;
618         }
619
620         ret = bch2_sb_compatible(sb->sb, err);
621         if (ret)
622                 return ret;
623
624         bytes = vstruct_bytes(sb->sb);
625
626         if (bytes > 512 << sb->sb->layout.sb_max_size_bits) {
627                 prt_printf(err, "Invalid superblock: too big (got %zu bytes, layout max %lu)",
628                        bytes, 512UL << sb->sb->layout.sb_max_size_bits);
629                 return -BCH_ERR_invalid_sb_too_big;
630         }
631
632         if (bytes > sb->buffer_size) {
633                 ret = bch2_sb_realloc(sb, le32_to_cpu(sb->sb->u64s));
634                 if (ret)
635                         return ret;
636                 goto reread;
637         }
638
639         if (BCH_SB_CSUM_TYPE(sb->sb) >= BCH_CSUM_NR) {
640                 prt_printf(err, "unknown checksum type %llu", BCH_SB_CSUM_TYPE(sb->sb));
641                 return -BCH_ERR_invalid_sb_csum_type;
642         }
643
644         /* XXX: verify MACs */
645         csum = csum_vstruct(NULL, BCH_SB_CSUM_TYPE(sb->sb),
646                             null_nonce(), sb->sb);
647
648         if (bch2_crc_cmp(csum, sb->sb->csum)) {
649                 prt_printf(err, "bad checksum");
650                 return -BCH_ERR_invalid_sb_csum;
651         }
652
653         sb->seq = le64_to_cpu(sb->sb->seq);
654
655         return 0;
656 }
657
658 int bch2_read_super(const char *path, struct bch_opts *opts,
659                     struct bch_sb_handle *sb)
660 {
661         u64 offset = opt_get(*opts, sb);
662         struct bch_sb_layout layout;
663         struct printbuf err = PRINTBUF;
664         __le64 *i;
665         int ret;
666 #ifndef __KERNEL__
667 retry:
668 #endif
669         memset(sb, 0, sizeof(*sb));
670         sb->mode        = BLK_OPEN_READ;
671         sb->have_bio    = true;
672         sb->holder      = kmalloc(1, GFP_KERNEL);
673         if (!sb->holder)
674                 return -ENOMEM;
675
676 #ifndef __KERNEL__
677         if (opt_get(*opts, direct_io) == false)
678                 sb->mode |= BLK_OPEN_BUFFERED;
679 #endif
680
681         if (!opt_get(*opts, noexcl))
682                 sb->mode |= BLK_OPEN_EXCL;
683
684         if (!opt_get(*opts, nochanges))
685                 sb->mode |= BLK_OPEN_WRITE;
686
687         sb->bdev = blkdev_get_by_path(path, sb->mode, sb->holder, &bch2_sb_handle_bdev_ops);
688         if (IS_ERR(sb->bdev) &&
689             PTR_ERR(sb->bdev) == -EACCES &&
690             opt_get(*opts, read_only)) {
691                 sb->mode &= ~BLK_OPEN_WRITE;
692
693                 sb->bdev = blkdev_get_by_path(path, sb->mode, sb->holder, &bch2_sb_handle_bdev_ops);
694                 if (!IS_ERR(sb->bdev))
695                         opt_set(*opts, nochanges, true);
696         }
697
698         if (IS_ERR(sb->bdev)) {
699                 ret = PTR_ERR(sb->bdev);
700                 goto out;
701         }
702
703         ret = bch2_sb_realloc(sb, 0);
704         if (ret) {
705                 prt_printf(&err, "error allocating memory for superblock");
706                 goto err;
707         }
708
709         if (bch2_fs_init_fault("read_super")) {
710                 prt_printf(&err, "dynamic fault");
711                 ret = -EFAULT;
712                 goto err;
713         }
714
715         ret = read_one_super(sb, offset, &err);
716         if (!ret)
717                 goto got_super;
718
719         if (opt_defined(*opts, sb))
720                 goto err;
721
722         printk(KERN_ERR "bcachefs (%s): error reading default superblock: %s",
723                path, err.buf);
724         printbuf_reset(&err);
725
726         /*
727          * Error reading primary superblock - read location of backup
728          * superblocks:
729          */
730         bio_reset(sb->bio, sb->bdev, REQ_OP_READ|REQ_SYNC|REQ_META);
731         sb->bio->bi_iter.bi_sector = BCH_SB_LAYOUT_SECTOR;
732         /*
733          * use sb buffer to read layout, since sb buffer is page aligned but
734          * layout won't be:
735          */
736         bch2_bio_map(sb->bio, sb->sb, sizeof(struct bch_sb_layout));
737
738         ret = submit_bio_wait(sb->bio);
739         if (ret) {
740                 prt_printf(&err, "IO error: %i", ret);
741                 goto err;
742         }
743
744         memcpy(&layout, sb->sb, sizeof(layout));
745         ret = validate_sb_layout(&layout, &err);
746         if (ret)
747                 goto err;
748
749         for (i = layout.sb_offset;
750              i < layout.sb_offset + layout.nr_superblocks; i++) {
751                 offset = le64_to_cpu(*i);
752
753                 if (offset == opt_get(*opts, sb))
754                         continue;
755
756                 ret = read_one_super(sb, offset, &err);
757                 if (!ret)
758                         goto got_super;
759         }
760
761         goto err;
762
763 got_super:
764         if (le16_to_cpu(sb->sb->block_size) << 9 <
765             bdev_logical_block_size(sb->bdev) &&
766             opt_get(*opts, direct_io)) {
767 #ifndef __KERNEL__
768                 opt_set(*opts, direct_io, false);
769                 bch2_free_super(sb);
770                 goto retry;
771 #endif
772                 prt_printf(&err, "block size (%u) smaller than device block size (%u)",
773                        le16_to_cpu(sb->sb->block_size) << 9,
774                        bdev_logical_block_size(sb->bdev));
775                 ret = -BCH_ERR_block_size_too_small;
776                 goto err;
777         }
778
779         ret = 0;
780         sb->have_layout = true;
781
782         ret = bch2_sb_validate(sb, &err, READ);
783         if (ret) {
784                 printk(KERN_ERR "bcachefs (%s): error validating superblock: %s",
785                        path, err.buf);
786                 goto err_no_print;
787         }
788 out:
789         printbuf_exit(&err);
790         return ret;
791 err:
792         printk(KERN_ERR "bcachefs (%s): error reading superblock: %s",
793                path, err.buf);
794 err_no_print:
795         bch2_free_super(sb);
796         goto out;
797 }
798
799 /* write superblock: */
800
801 static void write_super_endio(struct bio *bio)
802 {
803         struct bch_dev *ca = bio->bi_private;
804
805         /* XXX: return errors directly */
806
807         if (bch2_dev_io_err_on(bio->bi_status, ca, "superblock write error: %s",
808                                bch2_blk_status_to_str(bio->bi_status)))
809                 ca->sb_write_error = 1;
810
811         closure_put(&ca->fs->sb_write);
812         percpu_ref_put(&ca->io_ref);
813 }
814
815 static void read_back_super(struct bch_fs *c, struct bch_dev *ca)
816 {
817         struct bch_sb *sb = ca->disk_sb.sb;
818         struct bio *bio = ca->disk_sb.bio;
819
820         bio_reset(bio, ca->disk_sb.bdev, REQ_OP_READ|REQ_SYNC|REQ_META);
821         bio->bi_iter.bi_sector  = le64_to_cpu(sb->layout.sb_offset[0]);
822         bio->bi_end_io          = write_super_endio;
823         bio->bi_private         = ca;
824         bch2_bio_map(bio, ca->sb_read_scratch, PAGE_SIZE);
825
826         this_cpu_add(ca->io_done->sectors[READ][BCH_DATA_sb],
827                      bio_sectors(bio));
828
829         percpu_ref_get(&ca->io_ref);
830         closure_bio_submit(bio, &c->sb_write);
831 }
832
833 static void write_one_super(struct bch_fs *c, struct bch_dev *ca, unsigned idx)
834 {
835         struct bch_sb *sb = ca->disk_sb.sb;
836         struct bio *bio = ca->disk_sb.bio;
837
838         sb->offset = sb->layout.sb_offset[idx];
839
840         SET_BCH_SB_CSUM_TYPE(sb, bch2_csum_opt_to_type(c->opts.metadata_checksum, false));
841         sb->csum = csum_vstruct(c, BCH_SB_CSUM_TYPE(sb),
842                                 null_nonce(), sb);
843
844         bio_reset(bio, ca->disk_sb.bdev, REQ_OP_WRITE|REQ_SYNC|REQ_META);
845         bio->bi_iter.bi_sector  = le64_to_cpu(sb->offset);
846         bio->bi_end_io          = write_super_endio;
847         bio->bi_private         = ca;
848         bch2_bio_map(bio, sb,
849                      roundup((size_t) vstruct_bytes(sb),
850                              bdev_logical_block_size(ca->disk_sb.bdev)));
851
852         this_cpu_add(ca->io_done->sectors[WRITE][BCH_DATA_sb],
853                      bio_sectors(bio));
854
855         percpu_ref_get(&ca->io_ref);
856         closure_bio_submit(bio, &c->sb_write);
857 }
858
859 int bch2_write_super(struct bch_fs *c)
860 {
861         struct closure *cl = &c->sb_write;
862         struct bch_dev *ca;
863         struct printbuf err = PRINTBUF;
864         unsigned i, sb = 0, nr_wrote;
865         struct bch_devs_mask sb_written;
866         bool wrote, can_mount_without_written, can_mount_with_written;
867         unsigned degraded_flags = BCH_FORCE_IF_DEGRADED;
868         int ret = 0;
869
870         trace_and_count(c, write_super, c, _RET_IP_);
871
872         if (c->opts.very_degraded)
873                 degraded_flags |= BCH_FORCE_IF_LOST;
874
875         lockdep_assert_held(&c->sb_lock);
876
877         closure_init_stack(cl);
878         memset(&sb_written, 0, sizeof(sb_written));
879
880         /* Make sure we're using the new magic numbers: */
881         c->disk_sb.sb->magic = BCHFS_MAGIC;
882         c->disk_sb.sb->layout.magic = BCHFS_MAGIC;
883
884         le64_add_cpu(&c->disk_sb.sb->seq, 1);
885
886         if (test_bit(BCH_FS_ERROR, &c->flags))
887                 SET_BCH_SB_HAS_ERRORS(c->disk_sb.sb, 1);
888         if (test_bit(BCH_FS_TOPOLOGY_ERROR, &c->flags))
889                 SET_BCH_SB_HAS_TOPOLOGY_ERRORS(c->disk_sb.sb, 1);
890
891         SET_BCH_SB_BIG_ENDIAN(c->disk_sb.sb, CPU_BIG_ENDIAN);
892
893         bch2_sb_counters_from_cpu(c);
894
895         for_each_online_member(ca, c, i)
896                 bch2_sb_from_fs(c, ca);
897
898         for_each_online_member(ca, c, i) {
899                 printbuf_reset(&err);
900
901                 ret = bch2_sb_validate(&ca->disk_sb, &err, WRITE);
902                 if (ret) {
903                         bch2_fs_inconsistent(c, "sb invalid before write: %s", err.buf);
904                         percpu_ref_put(&ca->io_ref);
905                         goto out;
906                 }
907         }
908
909         if (c->opts.nochanges)
910                 goto out;
911
912         /*
913          * Defer writing the superblock until filesystem initialization is
914          * complete - don't write out a partly initialized superblock:
915          */
916         if (!BCH_SB_INITIALIZED(c->disk_sb.sb))
917                 goto out;
918
919         for_each_online_member(ca, c, i) {
920                 __set_bit(ca->dev_idx, sb_written.d);
921                 ca->sb_write_error = 0;
922         }
923
924         for_each_online_member(ca, c, i)
925                 read_back_super(c, ca);
926         closure_sync(cl);
927
928         for_each_online_member(ca, c, i) {
929                 if (ca->sb_write_error)
930                         continue;
931
932                 if (le64_to_cpu(ca->sb_read_scratch->seq) < ca->disk_sb.seq) {
933                         bch2_fs_fatal_error(c,
934                                 "Superblock write was silently dropped! (seq %llu expected %llu)",
935                                 le64_to_cpu(ca->sb_read_scratch->seq),
936                                 ca->disk_sb.seq);
937                         percpu_ref_put(&ca->io_ref);
938                         ret = -BCH_ERR_erofs_sb_err;
939                         goto out;
940                 }
941
942                 if (le64_to_cpu(ca->sb_read_scratch->seq) > ca->disk_sb.seq) {
943                         bch2_fs_fatal_error(c,
944                                 "Superblock modified by another process (seq %llu expected %llu)",
945                                 le64_to_cpu(ca->sb_read_scratch->seq),
946                                 ca->disk_sb.seq);
947                         percpu_ref_put(&ca->io_ref);
948                         ret = -BCH_ERR_erofs_sb_err;
949                         goto out;
950                 }
951         }
952
953         do {
954                 wrote = false;
955                 for_each_online_member(ca, c, i)
956                         if (!ca->sb_write_error &&
957                             sb < ca->disk_sb.sb->layout.nr_superblocks) {
958                                 write_one_super(c, ca, sb);
959                                 wrote = true;
960                         }
961                 closure_sync(cl);
962                 sb++;
963         } while (wrote);
964
965         for_each_online_member(ca, c, i) {
966                 if (ca->sb_write_error)
967                         __clear_bit(ca->dev_idx, sb_written.d);
968                 else
969                         ca->disk_sb.seq = le64_to_cpu(ca->disk_sb.sb->seq);
970         }
971
972         nr_wrote = dev_mask_nr(&sb_written);
973
974         can_mount_with_written =
975                 bch2_have_enough_devs(c, sb_written, degraded_flags, false);
976
977         for (i = 0; i < ARRAY_SIZE(sb_written.d); i++)
978                 sb_written.d[i] = ~sb_written.d[i];
979
980         can_mount_without_written =
981                 bch2_have_enough_devs(c, sb_written, degraded_flags, false);
982
983         /*
984          * If we would be able to mount _without_ the devices we successfully
985          * wrote superblocks to, we weren't able to write to enough devices:
986          *
987          * Exception: if we can mount without the successes because we haven't
988          * written anything (new filesystem), we continue if we'd be able to
989          * mount with the devices we did successfully write to:
990          */
991         if (bch2_fs_fatal_err_on(!nr_wrote ||
992                                  !can_mount_with_written ||
993                                  (can_mount_without_written &&
994                                   !can_mount_with_written), c,
995                 "Unable to write superblock to sufficient devices (from %ps)",
996                 (void *) _RET_IP_))
997                 ret = -1;
998 out:
999         /* Make new options visible after they're persistent: */
1000         bch2_sb_update(c);
1001         printbuf_exit(&err);
1002         return ret;
1003 }
1004
1005 void __bch2_check_set_feature(struct bch_fs *c, unsigned feat)
1006 {
1007         mutex_lock(&c->sb_lock);
1008         if (!(c->sb.features & (1ULL << feat))) {
1009                 c->disk_sb.sb->features[0] |= cpu_to_le64(1ULL << feat);
1010
1011                 bch2_write_super(c);
1012         }
1013         mutex_unlock(&c->sb_lock);
1014 }
1015
1016 /* Downgrade if superblock is at a higher version than currently supported: */
1017 void bch2_sb_maybe_downgrade(struct bch_fs *c)
1018 {
1019         lockdep_assert_held(&c->sb_lock);
1020
1021         /*
1022          * Downgrade, if superblock is at a higher version than currently
1023          * supported:
1024          */
1025         if (BCH_SB_VERSION_UPGRADE_COMPLETE(c->disk_sb.sb) > bcachefs_metadata_version_current)
1026                 SET_BCH_SB_VERSION_UPGRADE_COMPLETE(c->disk_sb.sb, bcachefs_metadata_version_current);
1027         if (c->sb.version > bcachefs_metadata_version_current)
1028                 c->disk_sb.sb->version = cpu_to_le16(bcachefs_metadata_version_current);
1029         if (c->sb.version_min > bcachefs_metadata_version_current)
1030                 c->disk_sb.sb->version_min = cpu_to_le16(bcachefs_metadata_version_current);
1031         c->disk_sb.sb->compat[0] &= cpu_to_le64((1ULL << BCH_COMPAT_NR) - 1);
1032 }
1033
1034 void bch2_sb_upgrade(struct bch_fs *c, unsigned new_version)
1035 {
1036         lockdep_assert_held(&c->sb_lock);
1037
1038         c->disk_sb.sb->version = cpu_to_le16(new_version);
1039         c->disk_sb.sb->features[0] |= cpu_to_le64(BCH_SB_FEATURES_ALL);
1040 }
1041
1042 static const struct bch_sb_field_ops *bch2_sb_field_ops[] = {
1043 #define x(f, nr)                                        \
1044         [BCH_SB_FIELD_##f] = &bch_sb_field_ops_##f,
1045         BCH_SB_FIELDS()
1046 #undef x
1047 };
1048
1049 static const struct bch_sb_field_ops bch2_sb_field_null_ops;
1050
1051 static const struct bch_sb_field_ops *bch2_sb_field_type_ops(unsigned type)
1052 {
1053         return likely(type < ARRAY_SIZE(bch2_sb_field_ops))
1054                 ? bch2_sb_field_ops[type]
1055                 : &bch2_sb_field_null_ops;
1056 }
1057
1058 static int bch2_sb_field_validate(struct bch_sb *sb, struct bch_sb_field *f,
1059                                   struct printbuf *err)
1060 {
1061         unsigned type = le32_to_cpu(f->type);
1062         struct printbuf field_err = PRINTBUF;
1063         const struct bch_sb_field_ops *ops = bch2_sb_field_type_ops(type);
1064         int ret;
1065
1066         ret = ops->validate ? ops->validate(sb, f, &field_err) : 0;
1067         if (ret) {
1068                 prt_printf(err, "Invalid superblock section %s: %s",
1069                            bch2_sb_fields[type], field_err.buf);
1070                 prt_newline(err);
1071                 bch2_sb_field_to_text(err, sb, f);
1072         }
1073
1074         printbuf_exit(&field_err);
1075         return ret;
1076 }
1077
1078 void bch2_sb_field_to_text(struct printbuf *out, struct bch_sb *sb,
1079                            struct bch_sb_field *f)
1080 {
1081         unsigned type = le32_to_cpu(f->type);
1082         const struct bch_sb_field_ops *ops = bch2_sb_field_type_ops(type);
1083
1084         if (!out->nr_tabstops)
1085                 printbuf_tabstop_push(out, 32);
1086
1087         if (type < BCH_SB_FIELD_NR)
1088                 prt_printf(out, "%s", bch2_sb_fields[type]);
1089         else
1090                 prt_printf(out, "(unknown field %u)", type);
1091
1092         prt_printf(out, " (size %zu):", vstruct_bytes(f));
1093         prt_newline(out);
1094
1095         if (ops->to_text) {
1096                 printbuf_indent_add(out, 2);
1097                 ops->to_text(out, sb, f);
1098                 printbuf_indent_sub(out, 2);
1099         }
1100 }
1101
1102 void bch2_sb_layout_to_text(struct printbuf *out, struct bch_sb_layout *l)
1103 {
1104         unsigned i;
1105
1106         prt_printf(out, "Type:                    %u", l->layout_type);
1107         prt_newline(out);
1108
1109         prt_str(out, "Superblock max size:     ");
1110         prt_units_u64(out, 512 << l->sb_max_size_bits);
1111         prt_newline(out);
1112
1113         prt_printf(out, "Nr superblocks:          %u", l->nr_superblocks);
1114         prt_newline(out);
1115
1116         prt_str(out, "Offsets:                 ");
1117         for (i = 0; i < l->nr_superblocks; i++) {
1118                 if (i)
1119                         prt_str(out, ", ");
1120                 prt_printf(out, "%llu", le64_to_cpu(l->sb_offset[i]));
1121         }
1122         prt_newline(out);
1123 }
1124
1125 void bch2_sb_to_text(struct printbuf *out, struct bch_sb *sb,
1126                      bool print_layout, unsigned fields)
1127 {
1128         struct bch_sb_field_members *mi;
1129         struct bch_sb_field *f;
1130         u64 fields_have = 0;
1131         unsigned nr_devices = 0;
1132
1133         if (!out->nr_tabstops)
1134                 printbuf_tabstop_push(out, 44);
1135
1136         mi = bch2_sb_get_members(sb);
1137         if (mi) {
1138                 struct bch_member *m;
1139
1140                 for (m = mi->members;
1141                      m < mi->members + sb->nr_devices;
1142                      m++)
1143                         nr_devices += bch2_member_exists(m);
1144         }
1145
1146         prt_printf(out, "External UUID:");
1147         prt_tab(out);
1148         pr_uuid(out, sb->user_uuid.b);
1149         prt_newline(out);
1150
1151         prt_printf(out, "Internal UUID:");
1152         prt_tab(out);
1153         pr_uuid(out, sb->uuid.b);
1154         prt_newline(out);
1155
1156         prt_str(out, "Device index:");
1157         prt_tab(out);
1158         prt_printf(out, "%u", sb->dev_idx);
1159         prt_newline(out);
1160
1161         prt_str(out, "Label:");
1162         prt_tab(out);
1163         prt_printf(out, "%.*s", (int) sizeof(sb->label), sb->label);
1164         prt_newline(out);
1165
1166         prt_str(out, "Version:");
1167         prt_tab(out);
1168         bch2_version_to_text(out, le16_to_cpu(sb->version));
1169         prt_newline(out);
1170
1171         prt_str(out, "Version upgrade complete:");
1172         prt_tab(out);
1173         bch2_version_to_text(out, BCH_SB_VERSION_UPGRADE_COMPLETE(sb));
1174         prt_newline(out);
1175
1176         prt_printf(out, "Oldest version on disk:");
1177         prt_tab(out);
1178         bch2_version_to_text(out, le16_to_cpu(sb->version_min));
1179         prt_newline(out);
1180
1181         prt_printf(out, "Created:");
1182         prt_tab(out);
1183         if (sb->time_base_lo)
1184                 pr_time(out, div_u64(le64_to_cpu(sb->time_base_lo), NSEC_PER_SEC));
1185         else
1186                 prt_printf(out, "(not set)");
1187         prt_newline(out);
1188
1189         prt_printf(out, "Sequence number:");
1190         prt_tab(out);
1191         prt_printf(out, "%llu", le64_to_cpu(sb->seq));
1192         prt_newline(out);
1193
1194         prt_printf(out, "Superblock size:");
1195         prt_tab(out);
1196         prt_printf(out, "%zu", vstruct_bytes(sb));
1197         prt_newline(out);
1198
1199         prt_printf(out, "Clean:");
1200         prt_tab(out);
1201         prt_printf(out, "%llu", BCH_SB_CLEAN(sb));
1202         prt_newline(out);
1203
1204         prt_printf(out, "Devices:");
1205         prt_tab(out);
1206         prt_printf(out, "%u", nr_devices);
1207         prt_newline(out);
1208
1209         prt_printf(out, "Sections:");
1210         vstruct_for_each(sb, f)
1211                 fields_have |= 1 << le32_to_cpu(f->type);
1212         prt_tab(out);
1213         prt_bitflags(out, bch2_sb_fields, fields_have);
1214         prt_newline(out);
1215
1216         prt_printf(out, "Features:");
1217         prt_tab(out);
1218         prt_bitflags(out, bch2_sb_features, le64_to_cpu(sb->features[0]));
1219         prt_newline(out);
1220
1221         prt_printf(out, "Compat features:");
1222         prt_tab(out);
1223         prt_bitflags(out, bch2_sb_compat, le64_to_cpu(sb->compat[0]));
1224         prt_newline(out);
1225
1226         prt_newline(out);
1227         prt_printf(out, "Options:");
1228         prt_newline(out);
1229         printbuf_indent_add(out, 2);
1230         {
1231                 enum bch_opt_id id;
1232
1233                 for (id = 0; id < bch2_opts_nr; id++) {
1234                         const struct bch_option *opt = bch2_opt_table + id;
1235
1236                         if (opt->get_sb != BCH2_NO_SB_OPT) {
1237                                 u64 v = bch2_opt_from_sb(sb, id);
1238
1239                                 prt_printf(out, "%s:", opt->attr.name);
1240                                 prt_tab(out);
1241                                 bch2_opt_to_text(out, NULL, sb, opt, v,
1242                                                  OPT_HUMAN_READABLE|OPT_SHOW_FULL_LIST);
1243                                 prt_newline(out);
1244                         }
1245                 }
1246         }
1247
1248         printbuf_indent_sub(out, 2);
1249
1250         if (print_layout) {
1251                 prt_newline(out);
1252                 prt_printf(out, "layout:");
1253                 prt_newline(out);
1254                 printbuf_indent_add(out, 2);
1255                 bch2_sb_layout_to_text(out, &sb->layout);
1256                 printbuf_indent_sub(out, 2);
1257         }
1258
1259         vstruct_for_each(sb, f)
1260                 if (fields & (1 << le32_to_cpu(f->type))) {
1261                         prt_newline(out);
1262                         bch2_sb_field_to_text(out, sb, f);
1263                 }
1264 }