From a232478f355c112c775c734182363f9e9b1688f8 Mon Sep 17 00:00:00 2001 From: Kent Overstreet <kent.overstreet@gmail.com> Date: Sat, 18 Jun 2022 18:25:19 -0400 Subject: [PATCH] Break up cmd_debug.c into multiple files In the future, let's have one cmd_foo.c file per subcommand. Signed-off-by: Kent Overstreet <kent.overstreet@gmail.com> --- cmd_debug.c | 802 --------------------------------------------- cmd_dump.c | 182 ++++++++++ cmd_list.c | 401 +++++++++++++++++++++++ cmd_list_journal.c | 246 ++++++++++++++ 4 files changed, 829 insertions(+), 802 deletions(-) delete mode 100644 cmd_debug.c create mode 100644 cmd_dump.c create mode 100644 cmd_list.c create mode 100644 cmd_list_journal.c diff --git a/cmd_debug.c b/cmd_debug.c deleted file mode 100644 index a7f70ed3..00000000 --- a/cmd_debug.c +++ /dev/null @@ -1,802 +0,0 @@ -#include <fcntl.h> -#include <string.h> -#include <sys/stat.h> -#include <sys/types.h> - -#include "cmds.h" -#include "libbcachefs.h" -#include "qcow2.h" -#include "tools-util.h" - -#include "libbcachefs/bcachefs.h" -#include "libbcachefs/bset.h" -#include "libbcachefs/btree_cache.h" -#include "libbcachefs/btree_io.h" -#include "libbcachefs/btree_iter.h" -#include "libbcachefs/buckets.h" -#include "libbcachefs/checksum.h" -#include "libbcachefs/error.h" -#include "libbcachefs/journal.h" -#include "libbcachefs/journal_io.h" -#include "libbcachefs/journal_seq_blacklist.h" -#include "libbcachefs/super.h" - -static void dump_usage(void) -{ - puts("bcachefs dump - dump filesystem metadata\n" - "Usage: bcachefs dump [OPTION]... <devices>\n" - "\n" - "Options:\n" - " -o output Output qcow2 image(s)\n" - " -f Force; overwrite when needed\n" - " -j Dump entire journal, not just dirty entries\n" - " -h Display this help and exit\n" - "Report bugs to <linux-bcachefs@vger.kernel.org>"); -} - -static void dump_one_device(struct bch_fs *c, struct bch_dev *ca, int fd, - bool entire_journal) -{ - struct bch_sb *sb = ca->disk_sb.sb; - ranges data = { 0 }; - unsigned i; - int ret; - - /* Superblock: */ - range_add(&data, BCH_SB_LAYOUT_SECTOR << 9, - sizeof(struct bch_sb_layout)); - - for (i = 0; i < sb->layout.nr_superblocks; i++) - range_add(&data, - le64_to_cpu(sb->layout.sb_offset[i]) << 9, - vstruct_bytes(sb)); - - /* Journal: */ - for (i = 0; i < ca->journal.nr; i++) - if (entire_journal || - ca->journal.bucket_seq[i] >= c->journal.last_seq_ondisk) { - u64 bucket = ca->journal.buckets[i]; - - range_add(&data, - bucket_bytes(ca) * bucket, - bucket_bytes(ca)); - } - - /* Btree: */ - for (i = 0; i < BTREE_ID_NR; i++) { - const struct bch_extent_ptr *ptr; - struct bkey_ptrs_c ptrs; - struct btree_trans trans; - struct btree_iter iter; - struct btree *b; - - bch2_trans_init(&trans, c, 0, 0); - - __for_each_btree_node(&trans, iter, i, POS_MIN, 0, 1, 0, b, ret) { - struct btree_node_iter iter; - struct bkey u; - struct bkey_s_c k; - - for_each_btree_node_key_unpack(b, k, &iter, &u) { - ptrs = bch2_bkey_ptrs_c(k); - - bkey_for_each_ptr(ptrs, ptr) - if (ptr->dev == ca->dev_idx) - range_add(&data, - ptr->offset << 9, - btree_bytes(c)); - } - } - - if (ret) - die("error %s walking btree nodes", strerror(-ret)); - - b = c->btree_roots[i].b; - if (!btree_node_fake(b)) { - ptrs = bch2_bkey_ptrs_c(bkey_i_to_s_c(&b->key)); - - bkey_for_each_ptr(ptrs, ptr) - if (ptr->dev == ca->dev_idx) - range_add(&data, - ptr->offset << 9, - btree_bytes(c)); - } - - bch2_trans_iter_exit(&trans, &iter); - bch2_trans_exit(&trans); - } - - qcow2_write_image(ca->disk_sb.bdev->bd_fd, fd, &data, - max_t(unsigned, btree_bytes(c) / 8, block_bytes(c))); - darray_exit(&data); -} - -int cmd_dump(int argc, char *argv[]) -{ - struct bch_opts opts = bch2_opts_empty(); - struct bch_dev *ca; - char *out = NULL; - unsigned i, nr_devices = 0; - bool force = false, entire_journal = false; - int fd, opt; - - opt_set(opts, nochanges, true); - opt_set(opts, norecovery, true); - opt_set(opts, degraded, true); - opt_set(opts, errors, BCH_ON_ERROR_continue); - opt_set(opts, fix_errors, FSCK_OPT_NO); - - while ((opt = getopt(argc, argv, "o:fjvh")) != -1) - switch (opt) { - case 'o': - out = optarg; - break; - case 'f': - force = true; - break; - case 'j': - entire_journal = true; - break; - case 'v': - opt_set(opts, verbose, true); - break; - case 'h': - dump_usage(); - exit(EXIT_SUCCESS); - } - args_shift(optind); - - if (!out) - die("Please supply output filename"); - - if (!argc) - die("Please supply device(s) to check"); - - struct bch_fs *c = bch2_fs_open(argv, argc, opts); - if (IS_ERR(c)) - die("error opening %s: %s", argv[0], strerror(-PTR_ERR(c))); - - down_read(&c->gc_lock); - - for_each_online_member(ca, c, i) - nr_devices++; - - BUG_ON(!nr_devices); - - for_each_online_member(ca, c, i) { - int flags = O_WRONLY|O_CREAT|O_TRUNC; - - if (!force) - flags |= O_EXCL; - - if (!c->devs[i]) - continue; - - char *path = nr_devices > 1 - ? mprintf("%s.%u", out, i) - : strdup(out); - fd = xopen(path, flags, 0600); - free(path); - - dump_one_device(c, ca, fd, entire_journal); - close(fd); - } - - up_read(&c->gc_lock); - - bch2_fs_stop(c); - return 0; -} - -static void list_keys(struct bch_fs *c, enum btree_id btree_id, - struct bpos start, struct bpos end) -{ - struct btree_trans trans; - struct btree_iter iter; - struct bkey_s_c k; - struct printbuf buf = PRINTBUF; - int ret; - - bch2_trans_init(&trans, c, 0, 0); - - for_each_btree_key(&trans, iter, btree_id, start, - BTREE_ITER_ALL_SNAPSHOTS| - BTREE_ITER_PREFETCH, k, ret) { - if (bkey_cmp(k.k->p, end) > 0) - break; - - printbuf_reset(&buf); - bch2_bkey_val_to_text(&buf, c, k); - puts(buf.buf); - } - bch2_trans_iter_exit(&trans, &iter); - - bch2_trans_exit(&trans); - - printbuf_exit(&buf); -} - -static void list_btree_formats(struct bch_fs *c, enum btree_id btree_id, unsigned level, - struct bpos start, struct bpos end) -{ - struct btree_trans trans; - struct btree_iter iter; - struct btree *b; - struct printbuf buf = PRINTBUF; - int ret; - - bch2_trans_init(&trans, c, 0, 0); - - __for_each_btree_node(&trans, iter, btree_id, start, 0, level, 0, b, ret) { - if (bkey_cmp(b->key.k.p, end) > 0) - break; - - printbuf_reset(&buf); - bch2_btree_node_to_text(&buf, c, b); - puts(buf.buf); - } - bch2_trans_iter_exit(&trans, &iter); - - if (ret) - die("error %s walking btree nodes", strerror(-ret)); - - bch2_trans_exit(&trans); - printbuf_exit(&buf); -} - -static void list_nodes(struct bch_fs *c, enum btree_id btree_id, unsigned level, - struct bpos start, struct bpos end) -{ - struct btree_trans trans; - struct btree_iter iter; - struct btree *b; - struct printbuf buf = PRINTBUF; - int ret; - - bch2_trans_init(&trans, c, 0, 0); - - __for_each_btree_node(&trans, iter, btree_id, start, 0, level, 0, b, ret) { - if (bkey_cmp(b->key.k.p, end) > 0) - break; - - printbuf_reset(&buf); - bch2_bkey_val_to_text(&buf, c, bkey_i_to_s_c(&b->key)); - fputs(buf.buf, stdout); - putchar('\n'); - } - bch2_trans_iter_exit(&trans, &iter); - - if (ret) - die("error %s walking btree nodes", strerror(-ret)); - - bch2_trans_exit(&trans); - printbuf_exit(&buf); -} - -static void print_node_ondisk(struct bch_fs *c, struct btree *b) -{ - struct btree_node *n_ondisk; - struct extent_ptr_decoded pick; - struct bch_dev *ca; - struct bio *bio; - unsigned offset = 0; - - if (bch2_bkey_pick_read_device(c, bkey_i_to_s_c(&b->key), NULL, &pick) <= 0) { - printf("error getting device to read from\n"); - return; - } - - ca = bch_dev_bkey_exists(c, pick.ptr.dev); - if (!bch2_dev_get_ioref(ca, READ)) { - printf("error getting device to read from\n"); - return; - } - - n_ondisk = malloc(btree_bytes(c)); - - bio = bio_alloc_bioset(ca->disk_sb.bdev, - buf_pages(n_ondisk, btree_bytes(c)), - REQ_OP_READ|REQ_META, - GFP_NOIO, - &c->btree_bio); - bio->bi_iter.bi_sector = pick.ptr.offset; - bch2_bio_map(bio, n_ondisk, btree_bytes(c)); - - submit_bio_wait(bio); - - bio_put(bio); - percpu_ref_put(&ca->io_ref); - - while (offset < btree_sectors(c)) { - struct bset *i; - struct nonce nonce; - struct bch_csum csum; - struct bkey_packed *k; - unsigned sectors; - - if (!offset) { - i = &n_ondisk->keys; - - if (!bch2_checksum_type_valid(c, BSET_CSUM_TYPE(i))) - die("unknown checksum type"); - - nonce = btree_nonce(i, offset << 9); - csum = csum_vstruct(c, BSET_CSUM_TYPE(i), nonce, n_ondisk); - - if (bch2_crc_cmp(csum, n_ondisk->csum)) - die("invalid checksum\n"); - - bset_encrypt(c, i, offset << 9); - - sectors = vstruct_sectors(n_ondisk, c->block_bits); - } else { - struct btree_node_entry *bne = (void *) n_ondisk + (offset << 9); - - i = &bne->keys; - - if (i->seq != n_ondisk->keys.seq) - break; - - if (!bch2_checksum_type_valid(c, BSET_CSUM_TYPE(i))) - die("unknown checksum type"); - - nonce = btree_nonce(i, offset << 9); - csum = csum_vstruct(c, BSET_CSUM_TYPE(i), nonce, bne); - - if (bch2_crc_cmp(csum, bne->csum)) - die("invalid checksum"); - - bset_encrypt(c, i, offset << 9); - - sectors = vstruct_sectors(bne, c->block_bits); - } - - fprintf(stdout, " offset %u version %u, journal seq %llu\n", - offset, - le16_to_cpu(i->version), - le64_to_cpu(i->journal_seq)); - offset += sectors; - - for (k = i->start; k != vstruct_last(i); k = bkey_next(k)) { - struct bkey u; - struct printbuf buf = PRINTBUF; - - bch2_bkey_val_to_text(&buf, c, bkey_disassemble(b, k, &u)); - fprintf(stdout, " %s\n", buf.buf); - - printbuf_exit(&buf); - } - } - - free(n_ondisk); -} - -static void list_nodes_ondisk(struct bch_fs *c, enum btree_id btree_id, unsigned level, - struct bpos start, struct bpos end) -{ - struct btree_trans trans; - struct btree_iter iter; - struct btree *b; - struct printbuf buf = PRINTBUF; - int ret; - - bch2_trans_init(&trans, c, 0, 0); - - __for_each_btree_node(&trans, iter, btree_id, start, 0, level, 0, b, ret) { - if (bkey_cmp(b->key.k.p, end) > 0) - break; - - printbuf_reset(&buf); - bch2_bkey_val_to_text(&buf, c, bkey_i_to_s_c(&b->key)); - fputs(buf.buf, stdout); - putchar('\n'); - - print_node_ondisk(c, b); - } - bch2_trans_iter_exit(&trans, &iter); - - if (ret) - die("error %s walking btree nodes", strerror(-ret)); - - bch2_trans_exit(&trans); - printbuf_exit(&buf); -} - -static void list_nodes_keys(struct bch_fs *c, enum btree_id btree_id, unsigned level, - struct bpos start, struct bpos end) -{ - struct btree_trans trans; - struct btree_iter iter; - struct btree_node_iter node_iter; - struct bkey unpacked; - struct bkey_s_c k; - struct btree *b; - struct printbuf buf = PRINTBUF; - int ret; - - bch2_trans_init(&trans, c, 0, 0); - - __for_each_btree_node(&trans, iter, btree_id, start, 0, level, 0, b, ret) { - if (bkey_cmp(b->key.k.p, end) > 0) - break; - - printbuf_reset(&buf); - bch2_btree_node_to_text(&buf, c, b); - fputs(buf.buf, stdout); - - for_each_btree_node_key_unpack(b, k, &node_iter, &unpacked) { - printbuf_reset(&buf); - bch2_bkey_val_to_text(&buf, c, k); - putchar('\t'); - puts(buf.buf); - } - } - bch2_trans_iter_exit(&trans, &iter); - - if (ret) - die("error %s walking btree nodes", strerror(-ret)); - - bch2_trans_exit(&trans); - printbuf_exit(&buf); -} - -static void list_keys_usage(void) -{ - puts("bcachefs list - list filesystem metadata to stdout\n" - "Usage: bcachefs list [OPTION]... <devices>\n" - "\n" - "Options:\n" - " -b (extents|inodes|dirents|xattrs) Btree to list from\n" - " -l level Btree depth to descend to (0 == leaves)\n" - " -s inode:offset Start position to list from\n" - " -e inode:offset End position\n" - " -i inode List keys for a given inode number\n" - " -m (keys|formats|nodes|nodes_ondisk|nodes_keys)\n" - " List mode\n" - " -f Check (fsck) the filesystem first\n" - " -v Verbose mode\n" - " -h Display this help and exit\n" - "Report bugs to <linux-bcachefs@vger.kernel.org>"); -} - -#define LIST_MODES() \ - x(keys) \ - x(formats) \ - x(nodes) \ - x(nodes_ondisk) \ - x(nodes_keys) - -enum list_modes { -#define x(n) LIST_MODE_##n, - LIST_MODES() -#undef x -}; - -static const char * const list_modes[] = { -#define x(n) #n, - LIST_MODES() -#undef x - NULL -}; - -int cmd_list(int argc, char *argv[]) -{ - struct bch_opts opts = bch2_opts_empty(); - enum btree_id btree_id_start = 0; - enum btree_id btree_id_end = BTREE_ID_NR; - enum btree_id btree_id; - unsigned level = 0; - struct bpos start = POS_MIN, end = POS_MAX; - u64 inum = 0; - int mode = 0, opt; - - opt_set(opts, nochanges, true); - opt_set(opts, norecovery, true); - opt_set(opts, degraded, true); - opt_set(opts, errors, BCH_ON_ERROR_continue); - - while ((opt = getopt(argc, argv, "b:l:s:e:i:m:fvh")) != -1) - switch (opt) { - case 'b': - btree_id_start = read_string_list_or_die(optarg, - bch2_btree_ids, "btree id"); - btree_id_end = btree_id_start + 1; - break; - case 'l': - if (kstrtouint(optarg, 10, &level) || level >= BTREE_MAX_DEPTH) - die("invalid level"); - break; - case 's': - start = bpos_parse(optarg); - break; - case 'e': - end = bpos_parse(optarg); - break; - case 'i': - if (kstrtoull(optarg, 10, &inum)) - die("invalid inode %s", optarg); - start = POS(inum, 0); - end = POS(inum + 1, 0); - break; - case 'm': - mode = read_string_list_or_die(optarg, - list_modes, "list mode"); - break; - case 'f': - opt_set(opts, fix_errors, FSCK_OPT_YES); - opt_set(opts, norecovery, false); - break; - case 'v': - opt_set(opts, verbose, true); - break; - case 'h': - list_keys_usage(); - exit(EXIT_SUCCESS); - } - args_shift(optind); - - if (!argc) - die("Please supply device(s)"); - - struct bch_fs *c = bch2_fs_open(argv, argc, opts); - if (IS_ERR(c)) - die("error opening %s: %s", argv[0], strerror(-PTR_ERR(c))); - - - for (btree_id = btree_id_start; - btree_id < btree_id_end; - btree_id++) { - switch (mode) { - case LIST_MODE_keys: - list_keys(c, btree_id, start, end); - break; - case LIST_MODE_formats: - list_btree_formats(c, btree_id, level, start, end); - break; - case LIST_MODE_nodes: - list_nodes(c, btree_id, level, start, end); - break; - case LIST_MODE_nodes_ondisk: - list_nodes_ondisk(c, btree_id, level, start, end); - break; - case LIST_MODE_nodes_keys: - list_nodes_keys(c, btree_id, level, start, end); - break; - default: - die("Invalid mode"); - } - } - - bch2_fs_stop(c); - return 0; -} - -static void list_journal_usage(void) -{ - puts("bcachefs list_journal - print contents of journal\n" - "Usage: bcachefs list_journal [OPTION]... <devices>\n" - "\n" - "Options:\n" - " -a Read entire journal, not just dirty entries\n" - " -n Number of journal entries to print, starting from the most recent\n" - " -v Verbose mode\n" - " -h Display this help and exit\n" - "Report bugs to <linux-bcachefs@vger.kernel.org>"); -} - -static void star_start_of_lines(char *buf) -{ - char *p = buf; - - if (*p == ' ') - *p = '*'; - - while ((p = strstr(p, "\n "))) - p[1] = '*'; -} - -int cmd_list_journal(int argc, char *argv[]) -{ - struct bch_opts opts = bch2_opts_empty(); - u32 nr_entries = U32_MAX; - int opt; - - opt_set(opts, nochanges, true); - opt_set(opts, norecovery, true); - opt_set(opts, degraded, true); - opt_set(opts, errors, BCH_ON_ERROR_continue); - opt_set(opts, fix_errors, FSCK_OPT_YES); - opt_set(opts, keep_journal, true); - opt_set(opts, read_journal_only,true); - - while ((opt = getopt(argc, argv, "an:vh")) != -1) - switch (opt) { - case 'a': - opt_set(opts, read_entire_journal, true); - break; - case 'n': - nr_entries = kstrtouint(optarg, 10, &nr_entries); - opt_set(opts, read_entire_journal, true); - break; - case 'v': - opt_set(opts, verbose, true); - break; - case 'h': - list_journal_usage(); - exit(EXIT_SUCCESS); - } - args_shift(optind); - - if (!argc) - die("Please supply device(s) to open"); - - struct bch_fs *c = bch2_fs_open(argv, argc, opts); - if (IS_ERR(c)) - die("error opening %s: %s", argv[0], strerror(-PTR_ERR(c))); - - struct journal_replay *p, **_p; - struct genradix_iter iter; - struct jset_entry *entry; - struct printbuf buf = PRINTBUF; - - genradix_for_each(&c->journal_entries, iter, _p) { - p = *_p; - if (!p) - continue; - - if (le64_to_cpu(p->j.seq) + nr_entries < atomic64_read(&c->journal.seq)) - continue; - - bool blacklisted = - bch2_journal_seq_is_blacklisted(c, - le64_to_cpu(p->j.seq), false); - - if (blacklisted) - printf("blacklisted "); - - printf("journal entry %llu\n", le64_to_cpu(p->j.seq)); - - printbuf_reset(&buf); - - prt_printf(&buf, - " version %u\n" - " last seq %llu\n" - " flush %u\n" - " written at ", - le32_to_cpu(p->j.version), - le64_to_cpu(p->j.last_seq), - !JSET_NO_FLUSH(&p->j)); - bch2_journal_ptrs_to_text(&buf, c, p); - - if (blacklisted) - star_start_of_lines(buf.buf); - printf("%s\n", buf.buf); - - vstruct_for_each(&p->j, entry) { - printbuf_reset(&buf); - - /* - * log entries denote the start of a new transaction - * commit: - */ - if (entry->type == BCH_JSET_ENTRY_log && !entry->level) - prt_newline(&buf); - printbuf_indent_add(&buf, 4); - bch2_journal_entry_to_text(&buf, c, entry); - - if (blacklisted) - star_start_of_lines(buf.buf); - printf("%s\n", buf.buf); - } - } - - printbuf_exit(&buf); - bch2_fs_stop(c); - return 0; -} - -static void kill_btree_node_usage(void) -{ - puts("bcachefs kill_btree_node - make btree nodes unreadable\n" - "Usage: bcachefs kill_btree_node [OPTION]... <devices>\n" - "\n" - "Options:\n" - " -b (extents|inodes|dirents|xattrs) Btree to delete from\n" - " -l level Levle to delete from (0 == leaves)\n" - " -i index Index of btree node to kill\n" - " -h Display this help and exit\n" - "Report bugs to <linux-bcachefs@vger.kernel.org>"); -} - -int cmd_kill_btree_node(int argc, char *argv[]) -{ - struct bch_opts opts = bch2_opts_empty(); - enum btree_id btree_id = 0; - unsigned level = 0; - u64 node_index = 0; - int opt; - - opt_set(opts, read_only, true); - - while ((opt = getopt(argc, argv, "b:l:i:h")) != -1) - switch (opt) { - case 'b': - btree_id = read_string_list_or_die(optarg, - bch2_btree_ids, "btree id"); - break; - case 'l': - if (kstrtouint(optarg, 10, &level) || level >= BTREE_MAX_DEPTH) - die("invalid level"); - break; - case 'i': - if (kstrtoull(optarg, 10, &node_index)) - die("invalid index %s", optarg); - break; - case 'h': - kill_btree_node_usage(); - exit(EXIT_SUCCESS); - } - args_shift(optind); - - if (!argc) - die("Please supply device(s)"); - - struct bch_fs *c = bch2_fs_open(argv, argc, opts); - if (IS_ERR(c)) - die("error opening %s: %s", argv[0], strerror(-PTR_ERR(c))); - - struct btree_trans trans; - struct btree_iter iter; - struct btree *b; - int ret; - void *zeroes; - - ret = posix_memalign(&zeroes, c->opts.block_size, c->opts.block_size); - if (ret) - die("error %s from posix_memalign", strerror(ret)); - - bch2_trans_init(&trans, c, 0, 0); - - __for_each_btree_node(&trans, iter, btree_id, POS_MIN, 0, level, 0, b, ret) { - if (b->c.level != level) - continue; - - if (!node_index) { - struct bkey_ptrs_c ptrs = bch2_bkey_ptrs_c(bkey_i_to_s_c(&b->key)); - const struct bch_extent_ptr *ptr; - - struct printbuf buf = PRINTBUF; - - bch2_bkey_val_to_text(&buf, c, bkey_i_to_s_c(&b->key)); - bch_info(c, "killing btree node %s", buf.buf); - printbuf_exit(&buf); - - bkey_for_each_ptr(ptrs, ptr) { - struct bch_dev *ca = bch_dev_bkey_exists(c, ptr->dev); - - ret = pwrite(ca->disk_sb.bdev->bd_fd, zeroes, - c->opts.block_size, ptr->offset << 9); - if (ret != c->opts.block_size) { - bch_err(c, "pwrite error: expected %u got %i %s", - c->opts.block_size, ret, strerror(errno)); - ret = EXIT_FAILURE; - goto done; - } - } - goto done; - } - - node_index--; - } - if (ret) - bch_err(c, "error %i walking btree nodes", ret); - else - bch_err(c, "node at specified index not found"); - ret = EXIT_FAILURE; -done: - bch2_trans_iter_exit(&trans, &iter); - bch2_trans_exit(&trans); - - bch2_fs_stop(c); - return ret; -} diff --git a/cmd_dump.c b/cmd_dump.c new file mode 100644 index 00000000..895e0cd0 --- /dev/null +++ b/cmd_dump.c @@ -0,0 +1,182 @@ +#include <fcntl.h> +#include <string.h> +#include <sys/stat.h> +#include <sys/types.h> + +#include "cmds.h" +#include "libbcachefs.h" +#include "qcow2.h" + +#include "libbcachefs/bcachefs.h" +#include "libbcachefs/btree_cache.h" +#include "libbcachefs/btree_iter.h" +#include "libbcachefs/error.h" +#include "libbcachefs/extents.h" +#include "libbcachefs/super.h" + +static void dump_usage(void) +{ + puts("bcachefs dump - dump filesystem metadata\n" + "Usage: bcachefs dump [OPTION]... <devices>\n" + "\n" + "Options:\n" + " -o output Output qcow2 image(s)\n" + " -f Force; overwrite when needed\n" + " -j Dump entire journal, not just dirty entries\n" + " -h Display this help and exit\n" + "Report bugs to <linux-bcachefs@vger.kernel.org>"); +} + +static void dump_one_device(struct bch_fs *c, struct bch_dev *ca, int fd, + bool entire_journal) +{ + struct bch_sb *sb = ca->disk_sb.sb; + ranges data = { 0 }; + unsigned i; + int ret; + + /* Superblock: */ + range_add(&data, BCH_SB_LAYOUT_SECTOR << 9, + sizeof(struct bch_sb_layout)); + + for (i = 0; i < sb->layout.nr_superblocks; i++) + range_add(&data, + le64_to_cpu(sb->layout.sb_offset[i]) << 9, + vstruct_bytes(sb)); + + /* Journal: */ + for (i = 0; i < ca->journal.nr; i++) + if (entire_journal || + ca->journal.bucket_seq[i] >= c->journal.last_seq_ondisk) { + u64 bucket = ca->journal.buckets[i]; + + range_add(&data, + bucket_bytes(ca) * bucket, + bucket_bytes(ca)); + } + + /* Btree: */ + for (i = 0; i < BTREE_ID_NR; i++) { + const struct bch_extent_ptr *ptr; + struct bkey_ptrs_c ptrs; + struct btree_trans trans; + struct btree_iter iter; + struct btree *b; + + bch2_trans_init(&trans, c, 0, 0); + + __for_each_btree_node(&trans, iter, i, POS_MIN, 0, 1, 0, b, ret) { + struct btree_node_iter iter; + struct bkey u; + struct bkey_s_c k; + + for_each_btree_node_key_unpack(b, k, &iter, &u) { + ptrs = bch2_bkey_ptrs_c(k); + + bkey_for_each_ptr(ptrs, ptr) + if (ptr->dev == ca->dev_idx) + range_add(&data, + ptr->offset << 9, + btree_bytes(c)); + } + } + + if (ret) + die("error %s walking btree nodes", strerror(-ret)); + + b = c->btree_roots[i].b; + if (!btree_node_fake(b)) { + ptrs = bch2_bkey_ptrs_c(bkey_i_to_s_c(&b->key)); + + bkey_for_each_ptr(ptrs, ptr) + if (ptr->dev == ca->dev_idx) + range_add(&data, + ptr->offset << 9, + btree_bytes(c)); + } + + bch2_trans_iter_exit(&trans, &iter); + bch2_trans_exit(&trans); + } + + qcow2_write_image(ca->disk_sb.bdev->bd_fd, fd, &data, + max_t(unsigned, btree_bytes(c) / 8, block_bytes(c))); + darray_exit(&data); +} + +int cmd_dump(int argc, char *argv[]) +{ + struct bch_opts opts = bch2_opts_empty(); + struct bch_dev *ca; + char *out = NULL; + unsigned i, nr_devices = 0; + bool force = false, entire_journal = false; + int fd, opt; + + opt_set(opts, nochanges, true); + opt_set(opts, norecovery, true); + opt_set(opts, degraded, true); + opt_set(opts, errors, BCH_ON_ERROR_continue); + opt_set(opts, fix_errors, FSCK_OPT_NO); + + while ((opt = getopt(argc, argv, "o:fjvh")) != -1) + switch (opt) { + case 'o': + out = optarg; + break; + case 'f': + force = true; + break; + case 'j': + entire_journal = true; + break; + case 'v': + opt_set(opts, verbose, true); + break; + case 'h': + dump_usage(); + exit(EXIT_SUCCESS); + } + args_shift(optind); + + if (!out) + die("Please supply output filename"); + + if (!argc) + die("Please supply device(s) to check"); + + struct bch_fs *c = bch2_fs_open(argv, argc, opts); + if (IS_ERR(c)) + die("error opening %s: %s", argv[0], strerror(-PTR_ERR(c))); + + down_read(&c->gc_lock); + + for_each_online_member(ca, c, i) + nr_devices++; + + BUG_ON(!nr_devices); + + for_each_online_member(ca, c, i) { + int flags = O_WRONLY|O_CREAT|O_TRUNC; + + if (!force) + flags |= O_EXCL; + + if (!c->devs[i]) + continue; + + char *path = nr_devices > 1 + ? mprintf("%s.%u", out, i) + : strdup(out); + fd = xopen(path, flags, 0600); + free(path); + + dump_one_device(c, ca, fd, entire_journal); + close(fd); + } + + up_read(&c->gc_lock); + + bch2_fs_stop(c); + return 0; +} diff --git a/cmd_list.c b/cmd_list.c new file mode 100644 index 00000000..f506e422 --- /dev/null +++ b/cmd_list.c @@ -0,0 +1,401 @@ +#include <fcntl.h> +#include <string.h> +#include <sys/stat.h> +#include <sys/types.h> + +#include "cmds.h" +#include "libbcachefs.h" +#include "qcow2.h" +#include "tools-util.h" + +#include "libbcachefs/bcachefs.h" +#include "libbcachefs/btree_cache.h" +#include "libbcachefs/btree_io.h" +#include "libbcachefs/btree_iter.h" +#include "libbcachefs/checksum.h" +#include "libbcachefs/error.h" +#include "libbcachefs/extents.h" +#include "libbcachefs/super.h" + +static void list_keys(struct bch_fs *c, enum btree_id btree_id, + struct bpos start, struct bpos end) +{ + struct btree_trans trans; + struct btree_iter iter; + struct bkey_s_c k; + struct printbuf buf = PRINTBUF; + int ret; + + bch2_trans_init(&trans, c, 0, 0); + + for_each_btree_key(&trans, iter, btree_id, start, + BTREE_ITER_ALL_SNAPSHOTS| + BTREE_ITER_PREFETCH, k, ret) { + if (bkey_cmp(k.k->p, end) > 0) + break; + + printbuf_reset(&buf); + bch2_bkey_val_to_text(&buf, c, k); + puts(buf.buf); + } + bch2_trans_iter_exit(&trans, &iter); + + bch2_trans_exit(&trans); + + printbuf_exit(&buf); +} + +static void list_btree_formats(struct bch_fs *c, enum btree_id btree_id, unsigned level, + struct bpos start, struct bpos end) +{ + struct btree_trans trans; + struct btree_iter iter; + struct btree *b; + struct printbuf buf = PRINTBUF; + int ret; + + bch2_trans_init(&trans, c, 0, 0); + + __for_each_btree_node(&trans, iter, btree_id, start, 0, level, 0, b, ret) { + if (bkey_cmp(b->key.k.p, end) > 0) + break; + + printbuf_reset(&buf); + bch2_btree_node_to_text(&buf, c, b); + puts(buf.buf); + } + bch2_trans_iter_exit(&trans, &iter); + + if (ret) + die("error %s walking btree nodes", strerror(-ret)); + + bch2_trans_exit(&trans); + printbuf_exit(&buf); +} + +static void list_nodes(struct bch_fs *c, enum btree_id btree_id, unsigned level, + struct bpos start, struct bpos end) +{ + struct btree_trans trans; + struct btree_iter iter; + struct btree *b; + struct printbuf buf = PRINTBUF; + int ret; + + bch2_trans_init(&trans, c, 0, 0); + + __for_each_btree_node(&trans, iter, btree_id, start, 0, level, 0, b, ret) { + if (bkey_cmp(b->key.k.p, end) > 0) + break; + + printbuf_reset(&buf); + bch2_bkey_val_to_text(&buf, c, bkey_i_to_s_c(&b->key)); + fputs(buf.buf, stdout); + putchar('\n'); + } + bch2_trans_iter_exit(&trans, &iter); + + if (ret) + die("error %s walking btree nodes", strerror(-ret)); + + bch2_trans_exit(&trans); + printbuf_exit(&buf); +} + +static void print_node_ondisk(struct bch_fs *c, struct btree *b) +{ + struct btree_node *n_ondisk; + struct extent_ptr_decoded pick; + struct bch_dev *ca; + struct bio *bio; + unsigned offset = 0; + + if (bch2_bkey_pick_read_device(c, bkey_i_to_s_c(&b->key), NULL, &pick) <= 0) { + printf("error getting device to read from\n"); + return; + } + + ca = bch_dev_bkey_exists(c, pick.ptr.dev); + if (!bch2_dev_get_ioref(ca, READ)) { + printf("error getting device to read from\n"); + return; + } + + n_ondisk = malloc(btree_bytes(c)); + + bio = bio_alloc_bioset(ca->disk_sb.bdev, + buf_pages(n_ondisk, btree_bytes(c)), + REQ_OP_READ|REQ_META, + GFP_NOIO, + &c->btree_bio); + bio->bi_iter.bi_sector = pick.ptr.offset; + bch2_bio_map(bio, n_ondisk, btree_bytes(c)); + + submit_bio_wait(bio); + + bio_put(bio); + percpu_ref_put(&ca->io_ref); + + while (offset < btree_sectors(c)) { + struct bset *i; + struct nonce nonce; + struct bch_csum csum; + struct bkey_packed *k; + unsigned sectors; + + if (!offset) { + i = &n_ondisk->keys; + + if (!bch2_checksum_type_valid(c, BSET_CSUM_TYPE(i))) + die("unknown checksum type"); + + nonce = btree_nonce(i, offset << 9); + csum = csum_vstruct(c, BSET_CSUM_TYPE(i), nonce, n_ondisk); + + if (bch2_crc_cmp(csum, n_ondisk->csum)) + die("invalid checksum\n"); + + bset_encrypt(c, i, offset << 9); + + sectors = vstruct_sectors(n_ondisk, c->block_bits); + } else { + struct btree_node_entry *bne = (void *) n_ondisk + (offset << 9); + + i = &bne->keys; + + if (i->seq != n_ondisk->keys.seq) + break; + + if (!bch2_checksum_type_valid(c, BSET_CSUM_TYPE(i))) + die("unknown checksum type"); + + nonce = btree_nonce(i, offset << 9); + csum = csum_vstruct(c, BSET_CSUM_TYPE(i), nonce, bne); + + if (bch2_crc_cmp(csum, bne->csum)) + die("invalid checksum"); + + bset_encrypt(c, i, offset << 9); + + sectors = vstruct_sectors(bne, c->block_bits); + } + + fprintf(stdout, " offset %u version %u, journal seq %llu\n", + offset, + le16_to_cpu(i->version), + le64_to_cpu(i->journal_seq)); + offset += sectors; + + for (k = i->start; k != vstruct_last(i); k = bkey_next(k)) { + struct bkey u; + struct printbuf buf = PRINTBUF; + + bch2_bkey_val_to_text(&buf, c, bkey_disassemble(b, k, &u)); + fprintf(stdout, " %s\n", buf.buf); + + printbuf_exit(&buf); + } + } + + free(n_ondisk); +} + +static void list_nodes_ondisk(struct bch_fs *c, enum btree_id btree_id, unsigned level, + struct bpos start, struct bpos end) +{ + struct btree_trans trans; + struct btree_iter iter; + struct btree *b; + struct printbuf buf = PRINTBUF; + int ret; + + bch2_trans_init(&trans, c, 0, 0); + + __for_each_btree_node(&trans, iter, btree_id, start, 0, level, 0, b, ret) { + if (bkey_cmp(b->key.k.p, end) > 0) + break; + + printbuf_reset(&buf); + bch2_bkey_val_to_text(&buf, c, bkey_i_to_s_c(&b->key)); + fputs(buf.buf, stdout); + putchar('\n'); + + print_node_ondisk(c, b); + } + bch2_trans_iter_exit(&trans, &iter); + + if (ret) + die("error %s walking btree nodes", strerror(-ret)); + + bch2_trans_exit(&trans); + printbuf_exit(&buf); +} + +static void list_nodes_keys(struct bch_fs *c, enum btree_id btree_id, unsigned level, + struct bpos start, struct bpos end) +{ + struct btree_trans trans; + struct btree_iter iter; + struct btree_node_iter node_iter; + struct bkey unpacked; + struct bkey_s_c k; + struct btree *b; + struct printbuf buf = PRINTBUF; + int ret; + + bch2_trans_init(&trans, c, 0, 0); + + __for_each_btree_node(&trans, iter, btree_id, start, 0, level, 0, b, ret) { + if (bkey_cmp(b->key.k.p, end) > 0) + break; + + printbuf_reset(&buf); + bch2_btree_node_to_text(&buf, c, b); + fputs(buf.buf, stdout); + + for_each_btree_node_key_unpack(b, k, &node_iter, &unpacked) { + printbuf_reset(&buf); + bch2_bkey_val_to_text(&buf, c, k); + putchar('\t'); + puts(buf.buf); + } + } + bch2_trans_iter_exit(&trans, &iter); + + if (ret) + die("error %s walking btree nodes", strerror(-ret)); + + bch2_trans_exit(&trans); + printbuf_exit(&buf); +} + +static void list_keys_usage(void) +{ + puts("bcachefs list - list filesystem metadata to stdout\n" + "Usage: bcachefs list [OPTION]... <devices>\n" + "\n" + "Options:\n" + " -b (extents|inodes|dirents|xattrs) Btree to list from\n" + " -l level Btree depth to descend to (0 == leaves)\n" + " -s inode:offset Start position to list from\n" + " -e inode:offset End position\n" + " -i inode List keys for a given inode number\n" + " -m (keys|formats|nodes|nodes_ondisk|nodes_keys)\n" + " List mode\n" + " -f Check (fsck) the filesystem first\n" + " -v Verbose mode\n" + " -h Display this help and exit\n" + "Report bugs to <linux-bcachefs@vger.kernel.org>"); +} + +#define LIST_MODES() \ + x(keys) \ + x(formats) \ + x(nodes) \ + x(nodes_ondisk) \ + x(nodes_keys) + +enum list_modes { +#define x(n) LIST_MODE_##n, + LIST_MODES() +#undef x +}; + +static const char * const list_modes[] = { +#define x(n) #n, + LIST_MODES() +#undef x + NULL +}; + +int cmd_list(int argc, char *argv[]) +{ + struct bch_opts opts = bch2_opts_empty(); + enum btree_id btree_id_start = 0; + enum btree_id btree_id_end = BTREE_ID_NR; + enum btree_id btree_id; + unsigned level = 0; + struct bpos start = POS_MIN, end = POS_MAX; + u64 inum = 0; + int mode = 0, opt; + + opt_set(opts, nochanges, true); + opt_set(opts, norecovery, true); + opt_set(opts, degraded, true); + opt_set(opts, errors, BCH_ON_ERROR_continue); + + while ((opt = getopt(argc, argv, "b:l:s:e:i:m:fvh")) != -1) + switch (opt) { + case 'b': + btree_id_start = read_string_list_or_die(optarg, + bch2_btree_ids, "btree id"); + btree_id_end = btree_id_start + 1; + break; + case 'l': + if (kstrtouint(optarg, 10, &level) || level >= BTREE_MAX_DEPTH) + die("invalid level"); + break; + case 's': + start = bpos_parse(optarg); + break; + case 'e': + end = bpos_parse(optarg); + break; + case 'i': + if (kstrtoull(optarg, 10, &inum)) + die("invalid inode %s", optarg); + start = POS(inum, 0); + end = POS(inum + 1, 0); + break; + case 'm': + mode = read_string_list_or_die(optarg, + list_modes, "list mode"); + break; + case 'f': + opt_set(opts, fix_errors, FSCK_OPT_YES); + opt_set(opts, norecovery, false); + break; + case 'v': + opt_set(opts, verbose, true); + break; + case 'h': + list_keys_usage(); + exit(EXIT_SUCCESS); + } + args_shift(optind); + + if (!argc) + die("Please supply device(s)"); + + struct bch_fs *c = bch2_fs_open(argv, argc, opts); + if (IS_ERR(c)) + die("error opening %s: %s", argv[0], strerror(-PTR_ERR(c))); + + + for (btree_id = btree_id_start; + btree_id < btree_id_end; + btree_id++) { + switch (mode) { + case LIST_MODE_keys: + list_keys(c, btree_id, start, end); + break; + case LIST_MODE_formats: + list_btree_formats(c, btree_id, level, start, end); + break; + case LIST_MODE_nodes: + list_nodes(c, btree_id, level, start, end); + break; + case LIST_MODE_nodes_ondisk: + list_nodes_ondisk(c, btree_id, level, start, end); + break; + case LIST_MODE_nodes_keys: + list_nodes_keys(c, btree_id, level, start, end); + break; + default: + die("Invalid mode"); + } + } + + bch2_fs_stop(c); + return 0; +} diff --git a/cmd_list_journal.c b/cmd_list_journal.c new file mode 100644 index 00000000..869d3341 --- /dev/null +++ b/cmd_list_journal.c @@ -0,0 +1,246 @@ +#include <fcntl.h> +#include <string.h> +#include <sys/stat.h> +#include <sys/types.h> + +#include "cmds.h" +#include "libbcachefs.h" +#include "qcow2.h" +#include "tools-util.h" + +#include "libbcachefs/bcachefs.h" +#include "libbcachefs/btree_iter.h" +#include "libbcachefs/error.h" +#include "libbcachefs/journal_io.h" +#include "libbcachefs/journal_seq_blacklist.h" +#include "libbcachefs/super.h" + +static void list_journal_usage(void) +{ + puts("bcachefs list_journal - print contents of journal\n" + "Usage: bcachefs list_journal [OPTION]... <devices>\n" + "\n" + "Options:\n" + " -a Read entire journal, not just dirty entries\n" + " -n Number of journal entries to print, starting from the most recent\n" + " -v Verbose mode\n" + " -h Display this help and exit\n" + "Report bugs to <linux-bcachefs@vger.kernel.org>"); +} + +static void star_start_of_lines(char *buf) +{ + char *p = buf; + + if (*p == ' ') + *p = '*'; + + while ((p = strstr(p, "\n "))) + p[1] = '*'; +} + +int cmd_list_journal(int argc, char *argv[]) +{ + struct bch_opts opts = bch2_opts_empty(); + u32 nr_entries = U32_MAX; + int opt; + + opt_set(opts, nochanges, true); + opt_set(opts, norecovery, true); + opt_set(opts, degraded, true); + opt_set(opts, errors, BCH_ON_ERROR_continue); + opt_set(opts, fix_errors, FSCK_OPT_YES); + opt_set(opts, keep_journal, true); + opt_set(opts, read_journal_only,true); + + while ((opt = getopt(argc, argv, "an:vh")) != -1) + switch (opt) { + case 'a': + opt_set(opts, read_entire_journal, true); + break; + case 'n': + nr_entries = kstrtouint(optarg, 10, &nr_entries); + opt_set(opts, read_entire_journal, true); + break; + case 'v': + opt_set(opts, verbose, true); + break; + case 'h': + list_journal_usage(); + exit(EXIT_SUCCESS); + } + args_shift(optind); + + if (!argc) + die("Please supply device(s) to open"); + + struct bch_fs *c = bch2_fs_open(argv, argc, opts); + if (IS_ERR(c)) + die("error opening %s: %s", argv[0], strerror(-PTR_ERR(c))); + + struct journal_replay *p, **_p; + struct genradix_iter iter; + struct jset_entry *entry; + struct printbuf buf = PRINTBUF; + + genradix_for_each(&c->journal_entries, iter, _p) { + p = *_p; + if (!p) + continue; + + if (le64_to_cpu(p->j.seq) + nr_entries < atomic64_read(&c->journal.seq)) + continue; + + bool blacklisted = + bch2_journal_seq_is_blacklisted(c, + le64_to_cpu(p->j.seq), false); + + if (blacklisted) + printf("blacklisted "); + + printf("journal entry %llu\n", le64_to_cpu(p->j.seq)); + + printbuf_reset(&buf); + + prt_printf(&buf, + " version %u\n" + " last seq %llu\n" + " flush %u\n" + " written at ", + le32_to_cpu(p->j.version), + le64_to_cpu(p->j.last_seq), + !JSET_NO_FLUSH(&p->j)); + bch2_journal_ptrs_to_text(&buf, c, p); + + if (blacklisted) + star_start_of_lines(buf.buf); + printf("%s\n", buf.buf); + + vstruct_for_each(&p->j, entry) { + printbuf_reset(&buf); + + /* + * log entries denote the start of a new transaction + * commit: + */ + if (entry->type == BCH_JSET_ENTRY_log && !entry->level) + prt_newline(&buf); + printbuf_indent_add(&buf, 4); + bch2_journal_entry_to_text(&buf, c, entry); + + if (blacklisted) + star_start_of_lines(buf.buf); + printf("%s\n", buf.buf); + } + } + + printbuf_exit(&buf); + bch2_fs_stop(c); + return 0; +} + +static void kill_btree_node_usage(void) +{ + puts("bcachefs kill_btree_node - make btree nodes unreadable\n" + "Usage: bcachefs kill_btree_node [OPTION]... <devices>\n" + "\n" + "Options:\n" + " -b (extents|inodes|dirents|xattrs) Btree to delete from\n" + " -l level Levle to delete from (0 == leaves)\n" + " -i index Index of btree node to kill\n" + " -h Display this help and exit\n" + "Report bugs to <linux-bcachefs@vger.kernel.org>"); +} + +int cmd_kill_btree_node(int argc, char *argv[]) +{ + struct bch_opts opts = bch2_opts_empty(); + enum btree_id btree_id = 0; + unsigned level = 0; + u64 node_index = 0; + int opt; + + opt_set(opts, read_only, true); + + while ((opt = getopt(argc, argv, "b:l:i:h")) != -1) + switch (opt) { + case 'b': + btree_id = read_string_list_or_die(optarg, + bch2_btree_ids, "btree id"); + break; + case 'l': + if (kstrtouint(optarg, 10, &level) || level >= BTREE_MAX_DEPTH) + die("invalid level"); + break; + case 'i': + if (kstrtoull(optarg, 10, &node_index)) + die("invalid index %s", optarg); + break; + case 'h': + kill_btree_node_usage(); + exit(EXIT_SUCCESS); + } + args_shift(optind); + + if (!argc) + die("Please supply device(s)"); + + struct bch_fs *c = bch2_fs_open(argv, argc, opts); + if (IS_ERR(c)) + die("error opening %s: %s", argv[0], strerror(-PTR_ERR(c))); + + struct btree_trans trans; + struct btree_iter iter; + struct btree *b; + int ret; + void *zeroes; + + ret = posix_memalign(&zeroes, c->opts.block_size, c->opts.block_size); + if (ret) + die("error %s from posix_memalign", strerror(ret)); + + bch2_trans_init(&trans, c, 0, 0); + + __for_each_btree_node(&trans, iter, btree_id, POS_MIN, 0, level, 0, b, ret) { + if (b->c.level != level) + continue; + + if (!node_index) { + struct bkey_ptrs_c ptrs = bch2_bkey_ptrs_c(bkey_i_to_s_c(&b->key)); + const struct bch_extent_ptr *ptr; + + struct printbuf buf = PRINTBUF; + + bch2_bkey_val_to_text(&buf, c, bkey_i_to_s_c(&b->key)); + bch_info(c, "killing btree node %s", buf.buf); + printbuf_exit(&buf); + + bkey_for_each_ptr(ptrs, ptr) { + struct bch_dev *ca = bch_dev_bkey_exists(c, ptr->dev); + + ret = pwrite(ca->disk_sb.bdev->bd_fd, zeroes, + c->opts.block_size, ptr->offset << 9); + if (ret != c->opts.block_size) { + bch_err(c, "pwrite error: expected %u got %i %s", + c->opts.block_size, ret, strerror(errno)); + ret = EXIT_FAILURE; + goto done; + } + } + goto done; + } + + node_index--; + } + if (ret) + bch_err(c, "error %i walking btree nodes", ret); + else + bch_err(c, "node at specified index not found"); + ret = EXIT_FAILURE; +done: + bch2_trans_iter_exit(&trans, &iter); + bch2_trans_exit(&trans); + + bch2_fs_stop(c); + return ret; +}