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)
99 bch2_trans_iter_exit(&trans, &iter);
100 bch2_trans_exit(&trans);
103 qcow2_write_image(ca->disk_sb.bdev->bd_fd, fd, &data,
104 max_t(unsigned, btree_bytes(c) / 8, block_bytes(c)));
108 int cmd_dump(int argc, char *argv[])
110 struct bch_opts opts = bch2_opts_empty();
113 unsigned i, nr_devices = 0;
117 opt_set(opts, nochanges, true);
118 opt_set(opts, norecovery, true);
119 opt_set(opts, degraded, true);
120 opt_set(opts, errors, BCH_ON_ERROR_continue);
121 opt_set(opts, fix_errors, FSCK_OPT_NO);
123 while ((opt = getopt(argc, argv, "o:fvh")) != -1)
132 opt_set(opts, verbose, true);
141 die("Please supply output filename");
144 die("Please supply device(s) to check");
146 struct bch_fs *c = bch2_fs_open(argv, argc, opts);
148 die("error opening %s: %s", argv[0], strerror(-PTR_ERR(c)));
150 down_read(&c->gc_lock);
152 for_each_online_member(ca, c, i)
157 for_each_online_member(ca, c, i) {
158 int flags = O_WRONLY|O_CREAT|O_TRUNC;
166 char *path = nr_devices > 1
167 ? mprintf("%s.%u", out, i)
169 fd = xopen(path, flags, 0600);
172 dump_one_device(c, ca, fd);
176 up_read(&c->gc_lock);
182 static void list_keys(struct bch_fs *c, enum btree_id btree_id,
183 struct bpos start, struct bpos end)
185 struct btree_trans trans;
186 struct btree_iter iter;
191 bch2_trans_init(&trans, c, 0, 0);
193 for_each_btree_key(&trans, iter, btree_id, start,
194 BTREE_ITER_ALL_SNAPSHOTS|
195 BTREE_ITER_PREFETCH, k, ret) {
196 if (bkey_cmp(k.k->p, end) > 0)
199 bch2_bkey_val_to_text(&PBUF(buf), c, k);
202 bch2_trans_iter_exit(&trans, &iter);
204 bch2_trans_exit(&trans);
207 static void list_btree_formats(struct bch_fs *c, enum btree_id btree_id, unsigned level,
208 struct bpos start, struct bpos end)
210 struct btree_trans trans;
211 struct btree_iter iter;
215 bch2_trans_init(&trans, c, 0, 0);
217 __for_each_btree_node(&trans, iter, btree_id, start, 0, level, 0, b) {
218 if (bkey_cmp(b->key.k.p, end) > 0)
221 bch2_btree_node_to_text(&PBUF(buf), c, b);
224 bch2_trans_iter_exit(&trans, &iter);
226 bch2_trans_exit(&trans);
229 static void list_nodes(struct bch_fs *c, enum btree_id btree_id, unsigned level,
230 struct bpos start, struct bpos end)
232 struct btree_trans trans;
233 struct btree_iter iter;
237 bch2_trans_init(&trans, c, 0, 0);
239 __for_each_btree_node(&trans, iter, btree_id, start, 0, level, 0, b) {
240 if (bkey_cmp(b->key.k.p, end) > 0)
243 bch2_bkey_val_to_text(&PBUF(buf), c, bkey_i_to_s_c(&b->key));
247 bch2_trans_iter_exit(&trans, &iter);
249 bch2_trans_exit(&trans);
252 static void print_node_ondisk(struct bch_fs *c, struct btree *b)
254 struct btree_node *n_ondisk;
255 struct extent_ptr_decoded pick;
260 if (bch2_bkey_pick_read_device(c, bkey_i_to_s_c(&b->key), NULL, &pick) <= 0) {
261 printf("error getting device to read from\n");
265 ca = bch_dev_bkey_exists(c, pick.ptr.dev);
266 if (!bch2_dev_get_ioref(ca, READ)) {
267 printf("error getting device to read from\n");
271 n_ondisk = malloc(btree_bytes(c));
273 bio = bio_alloc_bioset(GFP_NOIO,
274 buf_pages(n_ondisk, btree_bytes(c)),
276 bio_set_dev(bio, ca->disk_sb.bdev);
277 bio->bi_opf = REQ_OP_READ|REQ_META;
278 bio->bi_iter.bi_sector = pick.ptr.offset;
279 bch2_bio_map(bio, n_ondisk, btree_bytes(c));
281 submit_bio_wait(bio);
284 percpu_ref_put(&ca->io_ref);
286 while (offset < c->opts.btree_node_size) {
289 struct bch_csum csum;
290 struct bkey_packed *k;
296 if (!bch2_checksum_type_valid(c, BSET_CSUM_TYPE(i)))
297 die("unknown checksum type");
299 nonce = btree_nonce(i, offset << 9);
300 csum = csum_vstruct(c, BSET_CSUM_TYPE(i), nonce, n_ondisk);
302 if (bch2_crc_cmp(csum, n_ondisk->csum))
303 die("invalid checksum\n");
305 bset_encrypt(c, i, offset << 9);
307 sectors = vstruct_sectors(n_ondisk, c->block_bits);
309 struct btree_node_entry *bne = (void *) n_ondisk + (offset << 9);
313 if (i->seq != n_ondisk->keys.seq)
316 if (!bch2_checksum_type_valid(c, BSET_CSUM_TYPE(i)))
317 die("unknown checksum type");
319 nonce = btree_nonce(i, offset << 9);
320 csum = csum_vstruct(c, BSET_CSUM_TYPE(i), nonce, bne);
322 if (bch2_crc_cmp(csum, bne->csum))
323 die("invalid checksum");
325 bset_encrypt(c, i, offset << 9);
327 sectors = vstruct_sectors(bne, c->block_bits);
330 fprintf(stdout, " offset %u version %u, journal seq %llu\n",
332 le16_to_cpu(i->version),
333 le64_to_cpu(i->journal_seq));
336 for (k = i->start; k != vstruct_last(i); k = bkey_next(k)) {
340 bch2_bkey_val_to_text(&PBUF(buf), c, bkey_disassemble(b, k, &u));
341 fprintf(stdout, " %s\n", buf);
348 static void list_nodes_ondisk(struct bch_fs *c, enum btree_id btree_id, unsigned level,
349 struct bpos start, struct bpos end)
351 struct btree_trans trans;
352 struct btree_iter iter;
356 bch2_trans_init(&trans, c, 0, 0);
358 __for_each_btree_node(&trans, iter, btree_id, start, 0, level, 0, b) {
359 if (bkey_cmp(b->key.k.p, end) > 0)
362 bch2_bkey_val_to_text(&PBUF(buf), c, bkey_i_to_s_c(&b->key));
366 print_node_ondisk(c, b);
368 bch2_trans_iter_exit(&trans, &iter);
370 bch2_trans_exit(&trans);
373 static void list_nodes_keys(struct bch_fs *c, enum btree_id btree_id, unsigned level,
374 struct bpos start, struct bpos end)
376 struct btree_trans trans;
377 struct btree_iter iter;
378 struct btree_node_iter node_iter;
379 struct bkey unpacked;
384 bch2_trans_init(&trans, c, 0, 0);
386 __for_each_btree_node(&trans, iter, btree_id, start, 0, level, 0, b) {
387 if (bkey_cmp(b->key.k.p, end) > 0)
390 bch2_btree_node_to_text(&PBUF(buf), c, b);
393 for_each_btree_node_key_unpack(b, k, &node_iter, &unpacked) {
394 bch2_bkey_val_to_text(&PBUF(buf), c, k);
399 bch2_trans_iter_exit(&trans, &iter);
401 bch2_trans_exit(&trans);
404 static void list_keys_usage(void)
406 puts("bcachefs list - list filesystem metadata to stdout\n"
407 "Usage: bcachefs list [OPTION]... <devices>\n"
410 " -b (extents|inodes|dirents|xattrs) Btree to list from\n"
411 " -l level Btree depth to descend to (0 == leaves)\n"
412 " -s inode:offset Start position to list from\n"
413 " -e inode:offset End position\n"
414 " -i inode List keys for a given inode number\n"
415 " -m (keys|formats|nodes|nodes_ondisk|nodes_keys)\n"
417 " -f Check (fsck) the filesystem first\n"
419 " -h Display this help and exit\n"
420 "Report bugs to <linux-bcache@vger.kernel.org>");
423 #define LIST_MODES() \
431 #define x(n) LIST_MODE_##n,
436 static const char * const list_modes[] = {
443 int cmd_list(int argc, char *argv[])
445 struct bch_opts opts = bch2_opts_empty();
446 enum btree_id btree_id_start = 0;
447 enum btree_id btree_id_end = BTREE_ID_NR;
448 enum btree_id btree_id;
450 struct bpos start = POS_MIN, end = POS_MAX;
454 opt_set(opts, nochanges, true);
455 opt_set(opts, norecovery, true);
456 opt_set(opts, degraded, true);
457 opt_set(opts, errors, BCH_ON_ERROR_continue);
459 while ((opt = getopt(argc, argv, "b:l:s:e:i:m:fvh")) != -1)
462 btree_id_start = read_string_list_or_die(optarg,
463 bch2_btree_ids, "btree id");
464 btree_id_end = btree_id_start + 1;
467 if (kstrtouint(optarg, 10, &level) || level >= BTREE_MAX_DEPTH)
468 die("invalid level");
471 start = bpos_parse(optarg);
474 end = bpos_parse(optarg);
477 if (kstrtoull(optarg, 10, &inum))
478 die("invalid inode %s", optarg);
479 start = POS(inum, 0);
480 end = POS(inum + 1, 0);
483 mode = read_string_list_or_die(optarg,
484 list_modes, "list mode");
487 opt_set(opts, fix_errors, FSCK_OPT_YES);
488 opt_set(opts, norecovery, false);
491 opt_set(opts, verbose, true);
500 die("Please supply device(s)");
502 struct bch_fs *c = bch2_fs_open(argv, argc, opts);
504 die("error opening %s: %s", argv[0], strerror(-PTR_ERR(c)));
507 for (btree_id = btree_id_start;
508 btree_id < btree_id_end;
512 list_keys(c, btree_id, start, end);
514 case LIST_MODE_formats:
515 list_btree_formats(c, btree_id, level, start, end);
517 case LIST_MODE_nodes:
518 list_nodes(c, btree_id, level, start, end);
520 case LIST_MODE_nodes_ondisk:
521 list_nodes_ondisk(c, btree_id, level, start, end);
523 case LIST_MODE_nodes_keys:
524 list_nodes_keys(c, btree_id, level, start, end);
535 static void list_journal_usage(void)
537 puts("bcachefs list_journal - print contents of journal\n"
538 "Usage: bcachefs list_journal [OPTION]... <devices>\n"
541 " -a Read entire journal, not just dirty entries\n"
542 " -h Display this help and exit\n"
543 "Report bugs to <linux-bcache@vger.kernel.org>");
546 int cmd_list_journal(int argc, char *argv[])
548 struct bch_opts opts = bch2_opts_empty();
551 opt_set(opts, nochanges, true);
552 opt_set(opts, norecovery, true);
553 opt_set(opts, degraded, true);
554 opt_set(opts, errors, BCH_ON_ERROR_continue);
555 opt_set(opts, fix_errors, FSCK_OPT_YES);
556 opt_set(opts, keep_journal, true);
558 while ((opt = getopt(argc, argv, "ah")) != -1)
561 opt_set(opts, read_entire_journal, true);
564 list_journal_usage();
570 die("Please supply device(s) to open");
572 struct bch_fs *c = bch2_fs_open(argv, argc, opts);
574 die("error opening %s: %s", argv[0], strerror(-PTR_ERR(c)));
576 struct journal_replay *p;
577 struct jset_entry *entry;
578 struct bkey_i *k, *_n;
580 /* This could be greatly expanded: */
582 list_for_each_entry(p, &c->journal_entries, list) {
583 printf("journal entry %8llu\n"
587 le64_to_cpu(p->j.seq),
588 le32_to_cpu(p->j.version),
589 le64_to_cpu(p->j.last_seq));
591 for_each_jset_key(k, _n, entry, &p->j) {
594 bch2_bkey_val_to_text(&PBUF(buf), c, bkey_i_to_s_c(k));
595 printf("btree %s l %u: %s\n",
596 bch2_btree_ids[entry->btree_id],