7 #include "libbcachefs.h"
9 #include "tools-util.h"
11 #include "libbcachefs/bcachefs.h"
12 #include "libbcachefs/bset.h"
13 #include "libbcachefs/btree_cache.h"
14 #include "libbcachefs/btree_io.h"
15 #include "libbcachefs/btree_iter.h"
16 #include "libbcachefs/buckets.h"
17 #include "libbcachefs/checksum.h"
18 #include "libbcachefs/error.h"
19 #include "libbcachefs/journal.h"
20 #include "libbcachefs/journal_io.h"
21 #include "libbcachefs/super.h"
23 static void dump_usage(void)
25 puts("bcachefs dump - dump filesystem metadata\n"
26 "Usage: bcachefs dump [OPTION]... <devices>\n"
29 " -o output Output qcow2 image(s)\n"
30 " -f Force; overwrite when needed\n"
31 " -h Display this help and exit\n"
32 "Report bugs to <linux-bcache@vger.kernel.org>");
35 static void dump_one_device(struct bch_fs *c, struct bch_dev *ca, int fd)
37 struct bch_sb *sb = ca->disk_sb.sb;
44 range_add(&data, BCH_SB_LAYOUT_SECTOR << 9,
45 sizeof(struct bch_sb_layout));
47 for (i = 0; i < sb->layout.nr_superblocks; i++)
49 le64_to_cpu(sb->layout.sb_offset[i]) << 9,
53 for (i = 0; i < ca->journal.nr; i++)
54 if (ca->journal.bucket_seq[i] >= c->journal.last_seq_ondisk) {
55 u64 bucket = ca->journal.buckets[i];
58 bucket_bytes(ca) * bucket,
63 for (i = 0; i < BTREE_ID_NR; i++) {
64 const struct bch_extent_ptr *ptr;
65 struct bkey_ptrs_c ptrs;
66 struct btree_trans trans;
67 struct btree_iter *iter;
70 bch2_trans_init(&trans, c, 0, 0);
72 __for_each_btree_node(&trans, iter, i, POS_MIN, 0, 1, 0, b) {
73 struct btree_node_iter iter;
77 for_each_btree_node_key_unpack(b, k, &iter, &u) {
78 ptrs = bch2_bkey_ptrs_c(k);
80 bkey_for_each_ptr(ptrs, ptr)
81 if (ptr->dev == ca->dev_idx)
88 b = c->btree_roots[i].b;
89 if (!btree_node_fake(b)) {
90 ptrs = bch2_bkey_ptrs_c(bkey_i_to_s_c(&b->key));
92 bkey_for_each_ptr(ptrs, ptr)
93 if (ptr->dev == ca->dev_idx)
98 bch2_trans_exit(&trans);
101 qcow2_write_image(ca->disk_sb.bdev->bd_fd, fd, &data,
102 max_t(unsigned, btree_bytes(c) / 8, block_bytes(c)));
106 int cmd_dump(int argc, char *argv[])
108 struct bch_opts opts = bch2_opts_empty();
111 unsigned i, nr_devices = 0;
115 opt_set(opts, nochanges, true);
116 opt_set(opts, norecovery, true);
117 opt_set(opts, degraded, true);
118 opt_set(opts, errors, BCH_ON_ERROR_continue);
119 opt_set(opts, fix_errors, FSCK_OPT_NO);
121 while ((opt = getopt(argc, argv, "o:fvh")) != -1)
130 opt_set(opts, verbose, true);
139 die("Please supply output filename");
142 die("Please supply device(s) to check");
144 struct bch_fs *c = bch2_fs_open(argv, argc, opts);
146 die("error opening %s: %s", argv[0], strerror(-PTR_ERR(c)));
148 down_read(&c->gc_lock);
150 for_each_online_member(ca, c, i)
155 for_each_online_member(ca, c, i) {
156 int flags = O_WRONLY|O_CREAT|O_TRUNC;
164 char *path = nr_devices > 1
165 ? mprintf("%s.%u", out, i)
167 fd = xopen(path, flags, 0600);
170 dump_one_device(c, ca, fd);
174 up_read(&c->gc_lock);
180 static void list_keys(struct bch_fs *c, enum btree_id btree_id,
181 struct bpos start, struct bpos end)
183 struct btree_trans trans;
184 struct btree_iter *iter;
189 bch2_trans_init(&trans, c, 0, 0);
191 for_each_btree_key(&trans, iter, btree_id, start,
192 BTREE_ITER_PREFETCH, k, ret) {
193 if (bkey_cmp(k.k->p, end) > 0)
196 bch2_bkey_val_to_text(&PBUF(buf), c, k);
199 bch2_trans_iter_put(&trans, iter);
201 bch2_trans_exit(&trans);
204 static void list_btree_formats(struct bch_fs *c, enum btree_id btree_id, unsigned level,
205 struct bpos start, struct bpos end)
207 struct btree_trans trans;
208 struct btree_iter *iter;
212 bch2_trans_init(&trans, c, 0, 0);
214 __for_each_btree_node(&trans, iter, btree_id, start, 0, level, 0, b) {
215 if (bkey_cmp(b->key.k.p, end) > 0)
218 bch2_btree_node_to_text(&PBUF(buf), c, b);
221 bch2_trans_iter_put(&trans, iter);
223 bch2_trans_exit(&trans);
226 static void list_nodes(struct bch_fs *c, enum btree_id btree_id, unsigned level,
227 struct bpos start, struct bpos end)
229 struct btree_trans trans;
230 struct btree_iter *iter;
234 bch2_trans_init(&trans, c, 0, 0);
236 __for_each_btree_node(&trans, iter, btree_id, start, 0, level, 0, b) {
237 if (bkey_cmp(b->key.k.p, end) > 0)
240 bch2_bkey_val_to_text(&PBUF(buf), c, bkey_i_to_s_c(&b->key));
244 bch2_trans_iter_put(&trans, iter);
246 bch2_trans_exit(&trans);
249 static void print_node_ondisk(struct bch_fs *c, struct btree *b)
251 struct btree_node *n_ondisk;
252 struct extent_ptr_decoded pick;
257 if (bch2_bkey_pick_read_device(c, bkey_i_to_s_c(&b->key), NULL, &pick) <= 0) {
258 printf("error getting device to read from\n");
262 ca = bch_dev_bkey_exists(c, pick.ptr.dev);
263 if (!bch2_dev_get_ioref(ca, READ)) {
264 printf("error getting device to read from\n");
268 n_ondisk = malloc(btree_bytes(c));
270 bio = bio_alloc_bioset(GFP_NOIO,
271 buf_pages(n_ondisk, btree_bytes(c)),
273 bio_set_dev(bio, ca->disk_sb.bdev);
274 bio->bi_opf = REQ_OP_READ|REQ_META;
275 bio->bi_iter.bi_sector = pick.ptr.offset;
276 bch2_bio_map(bio, n_ondisk, btree_bytes(c));
278 submit_bio_wait(bio);
281 percpu_ref_put(&ca->io_ref);
283 while (offset < c->opts.btree_node_size) {
286 struct bch_csum csum;
287 struct bkey_packed *k;
293 if (!bch2_checksum_type_valid(c, BSET_CSUM_TYPE(i)))
294 die("unknown checksum type");
296 nonce = btree_nonce(i, offset << 9);
297 csum = csum_vstruct(c, BSET_CSUM_TYPE(i), nonce, n_ondisk);
299 if (bch2_crc_cmp(csum, n_ondisk->csum))
300 die("invalid checksum\n");
302 bset_encrypt(c, i, offset << 9);
304 sectors = vstruct_sectors(n_ondisk, c->block_bits);
306 struct btree_node_entry *bne = (void *) n_ondisk + (offset << 9);
310 if (i->seq != n_ondisk->keys.seq)
313 if (!bch2_checksum_type_valid(c, BSET_CSUM_TYPE(i)))
314 die("unknown checksum type");
316 nonce = btree_nonce(i, offset << 9);
317 csum = csum_vstruct(c, BSET_CSUM_TYPE(i), nonce, bne);
319 if (bch2_crc_cmp(csum, bne->csum))
320 die("invalid checksum");
322 bset_encrypt(c, i, offset << 9);
324 sectors = vstruct_sectors(bne, c->block_bits);
327 fprintf(stdout, " offset %u version %u, journal seq %llu\n",
329 le16_to_cpu(i->version),
330 le64_to_cpu(i->journal_seq));
333 for (k = i->start; k != vstruct_last(i); k = bkey_next(k)) {
337 bch2_bkey_val_to_text(&PBUF(buf), c, bkey_disassemble(b, k, &u));
338 fprintf(stdout, " %s\n", buf);
345 static void list_nodes_ondisk(struct bch_fs *c, enum btree_id btree_id, unsigned level,
346 struct bpos start, struct bpos end)
348 struct btree_trans trans;
349 struct btree_iter *iter;
353 bch2_trans_init(&trans, c, 0, 0);
355 __for_each_btree_node(&trans, iter, btree_id, start, 0, level, 0, b) {
356 if (bkey_cmp(b->key.k.p, end) > 0)
359 bch2_bkey_val_to_text(&PBUF(buf), c, bkey_i_to_s_c(&b->key));
363 print_node_ondisk(c, b);
365 bch2_trans_iter_put(&trans, iter);
367 bch2_trans_exit(&trans);
370 static void list_nodes_keys(struct bch_fs *c, enum btree_id btree_id, unsigned level,
371 struct bpos start, struct bpos end)
373 struct btree_trans trans;
374 struct btree_iter *iter;
375 struct btree_node_iter node_iter;
376 struct bkey unpacked;
381 bch2_trans_init(&trans, c, 0, 0);
383 __for_each_btree_node(&trans, iter, btree_id, start, 0, level, 0, b) {
384 if (bkey_cmp(b->key.k.p, end) > 0)
387 bch2_btree_node_to_text(&PBUF(buf), c, b);
390 for_each_btree_node_key_unpack(b, k, &node_iter, &unpacked) {
391 bch2_bkey_val_to_text(&PBUF(buf), c, k);
396 bch2_trans_iter_put(&trans, iter);
398 bch2_trans_exit(&trans);
401 static void list_keys_usage(void)
403 puts("bcachefs list - list filesystem metadata to stdout\n"
404 "Usage: bcachefs list [OPTION]... <devices>\n"
407 " -b (extents|inodes|dirents|xattrs) Btree to list from\n"
408 " -l level Btree depth to descend to (0 == leaves)\n"
409 " -s inode:offset Start position to list from\n"
410 " -e inode:offset End position\n"
411 " -i inode List keys for a given inode number\n"
412 " -m (keys|formats|nodes|nodes_ondisk|nodes_keys)\n"
414 " -f Check (fsck) the filesystem first\n"
416 " -h Display this help and exit\n"
417 "Report bugs to <linux-bcache@vger.kernel.org>");
420 #define LIST_MODES() \
428 #define x(n) LIST_MODE_##n,
433 static const char * const list_modes[] = {
440 int cmd_list(int argc, char *argv[])
442 struct bch_opts opts = bch2_opts_empty();
443 enum btree_id btree_id_start = 0;
444 enum btree_id btree_id_end = BTREE_ID_NR;
445 enum btree_id btree_id;
447 struct bpos start = POS_MIN, end = POS_MAX;
451 opt_set(opts, nochanges, true);
452 opt_set(opts, norecovery, true);
453 opt_set(opts, degraded, true);
454 opt_set(opts, errors, BCH_ON_ERROR_continue);
456 while ((opt = getopt(argc, argv, "b:l:s:e:i:m:fvh")) != -1)
459 btree_id_start = read_string_list_or_die(optarg,
460 bch2_btree_ids, "btree id");
461 btree_id_end = btree_id_start + 1;
464 if (kstrtouint(optarg, 10, &level) || level >= BTREE_MAX_DEPTH)
465 die("invalid level");
468 start = bpos_parse(optarg);
471 end = bpos_parse(optarg);
474 if (kstrtoull(optarg, 10, &inum))
475 die("invalid inode %s", optarg);
476 start = POS(inum, 0);
477 end = POS(inum + 1, 0);
480 mode = read_string_list_or_die(optarg,
481 list_modes, "list mode");
484 opt_set(opts, fix_errors, FSCK_OPT_YES);
485 opt_set(opts, norecovery, false);
488 opt_set(opts, verbose, true);
497 die("Please supply device(s)");
499 struct bch_fs *c = bch2_fs_open(argv, argc, opts);
501 die("error opening %s: %s", argv[0], strerror(-PTR_ERR(c)));
504 for (btree_id = btree_id_start;
505 btree_id < btree_id_end;
509 list_keys(c, btree_id, start, end);
511 case LIST_MODE_formats:
512 list_btree_formats(c, btree_id, level, start, end);
514 case LIST_MODE_nodes:
515 list_nodes(c, btree_id, level, start, end);
517 case LIST_MODE_nodes_ondisk:
518 list_nodes_ondisk(c, btree_id, level, start, end);
520 case LIST_MODE_nodes_keys:
521 list_nodes_keys(c, btree_id, level, start, end);
532 static void list_journal_usage(void)
534 puts("bcachefs list_journal - print contents of journal\n"
535 "Usage: bcachefs list_journal [OPTION]... <devices>\n"
538 " -a Read entire journal, not just dirty entries\n"
539 " -h Display this help and exit\n"
540 "Report bugs to <linux-bcache@vger.kernel.org>");
543 int cmd_list_journal(int argc, char *argv[])
545 struct bch_opts opts = bch2_opts_empty();
548 opt_set(opts, nochanges, true);
549 opt_set(opts, norecovery, true);
550 opt_set(opts, degraded, true);
551 opt_set(opts, errors, BCH_ON_ERROR_continue);
552 opt_set(opts, fix_errors, FSCK_OPT_YES);
553 opt_set(opts, keep_journal, true);
555 while ((opt = getopt(argc, argv, "ah")) != -1)
558 opt_set(opts, read_entire_journal, true);
561 list_journal_usage();
567 die("Please supply device(s) to open");
569 struct bch_fs *c = bch2_fs_open(argv, argc, opts);
571 die("error opening %s: %s", argv[0], strerror(-PTR_ERR(c)));
573 struct journal_replay *p;
574 struct jset_entry *entry;
575 struct bkey_i *k, *_n;
577 /* This could be greatly expanded: */
579 list_for_each_entry(p, &c->journal_entries, list) {
580 printf("journal entry %8llu\n"
584 le64_to_cpu(p->j.seq),
585 le32_to_cpu(p->j.version),
586 le64_to_cpu(p->j.last_seq));
588 for_each_jset_key(k, _n, entry, &p->j) {
591 bch2_bkey_val_to_text(&PBUF(buf), c, bkey_i_to_s_c(k));
592 printf("btree %s l %u: %s\n",
593 bch2_btree_ids[entry->btree_id],