summaryrefslogtreecommitdiff
path: root/cmds-inspect-dump-tree.c
diff options
context:
space:
mode:
Diffstat (limited to 'cmds-inspect-dump-tree.c')
-rw-r--r--cmds-inspect-dump-tree.c551
1 files changed, 551 insertions, 0 deletions
diff --git a/cmds-inspect-dump-tree.c b/cmds-inspect-dump-tree.c
new file mode 100644
index 00000000..5e206345
--- /dev/null
+++ b/cmds-inspect-dump-tree.c
@@ -0,0 +1,551 @@
+/*
+ * Copyright (C) 2007 Oracle. All rights reserved.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public
+ * License v2 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public
+ * License along with this program; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 021110-1307, USA.
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <unistd.h>
+#include <uuid/uuid.h>
+#include <getopt.h>
+
+#include "kerncompat.h"
+#include "radix-tree.h"
+#include "ctree.h"
+#include "disk-io.h"
+#include "print-tree.h"
+#include "transaction.h"
+#include "volumes.h"
+#include "commands.h"
+#include "utils.h"
+#include "cmds-inspect-dump-tree.h"
+
+static void print_extents(struct btrfs_root *root, struct extent_buffer *eb)
+{
+ int i;
+ u32 nr;
+ u32 size;
+
+ if (!eb)
+ return;
+
+ if (btrfs_is_leaf(eb)) {
+ btrfs_print_leaf(root, eb);
+ return;
+ }
+
+ size = root->nodesize;
+ nr = btrfs_header_nritems(eb);
+ for (i = 0; i < nr; i++) {
+ struct extent_buffer *next = read_tree_block(root,
+ btrfs_node_blockptr(eb, i),
+ size,
+ btrfs_node_ptr_generation(eb, i));
+ if (!extent_buffer_uptodate(next))
+ continue;
+ if (btrfs_is_leaf(next) &&
+ btrfs_header_level(eb) != 1)
+ BUG();
+ if (btrfs_header_level(next) !=
+ btrfs_header_level(eb) - 1)
+ BUG();
+ print_extents(root, next);
+ free_extent_buffer(next);
+ }
+}
+
+static void print_old_roots(struct btrfs_super_block *super)
+{
+ struct btrfs_root_backup *backup;
+ int i;
+
+ for (i = 0; i < BTRFS_NUM_BACKUP_ROOTS; i++) {
+ backup = super->super_roots + i;
+ printf("btrfs root backup slot %d\n", i);
+ printf("\ttree root gen %llu block %llu\n",
+ (unsigned long long)btrfs_backup_tree_root_gen(backup),
+ (unsigned long long)btrfs_backup_tree_root(backup));
+
+ printf("\t\textent root gen %llu block %llu\n",
+ (unsigned long long)btrfs_backup_extent_root_gen(backup),
+ (unsigned long long)btrfs_backup_extent_root(backup));
+
+ printf("\t\tchunk root gen %llu block %llu\n",
+ (unsigned long long)btrfs_backup_chunk_root_gen(backup),
+ (unsigned long long)btrfs_backup_chunk_root(backup));
+
+ printf("\t\tdevice root gen %llu block %llu\n",
+ (unsigned long long)btrfs_backup_dev_root_gen(backup),
+ (unsigned long long)btrfs_backup_dev_root(backup));
+
+ printf("\t\tcsum root gen %llu block %llu\n",
+ (unsigned long long)btrfs_backup_csum_root_gen(backup),
+ (unsigned long long)btrfs_backup_csum_root(backup));
+
+ printf("\t\tfs root gen %llu block %llu\n",
+ (unsigned long long)btrfs_backup_fs_root_gen(backup),
+ (unsigned long long)btrfs_backup_fs_root(backup));
+
+ printf("\t\t%llu used %llu total %llu devices\n",
+ (unsigned long long)btrfs_backup_bytes_used(backup),
+ (unsigned long long)btrfs_backup_total_bytes(backup),
+ (unsigned long long)btrfs_backup_num_devices(backup));
+ }
+}
+
+/*
+ * Convert a tree name from various forms to the numerical id if possible
+ * Accepted forms:
+ * - case does not matter
+ * - same as the key name, BTRFS_ROOT_TREE_OBJECTID
+ * - dtto shortened, BTRFS_ROOT_TREE
+ * - dtto without prefix, ROOT_TREE
+ * - common name, ROOT, CHUNK, EXTENT, ...
+ * - dtto alias, DEVICE for DEV, CHECKSUM for CSUM
+ *
+ * Returns 0 if the tree id was not recognized.
+ */
+static u64 treeid_from_string(const char *str, const char **end)
+{
+ int match = 0;
+ int i;
+ u64 id;
+ static struct treename {
+ const char *name;
+ u64 id;
+ } tn[] = {
+ { "ROOT", BTRFS_ROOT_TREE_OBJECTID },
+ { "EXTENT", BTRFS_EXTENT_TREE_OBJECTID },
+ { "CHUNK", BTRFS_CHUNK_TREE_OBJECTID },
+ { "DEVICE", BTRFS_DEV_TREE_OBJECTID },
+ { "DEV", BTRFS_DEV_TREE_OBJECTID },
+ { "FS_TREE", BTRFS_FS_TREE_OBJECTID },
+ { "CSUM", BTRFS_CSUM_TREE_OBJECTID },
+ { "CHECKSUM", BTRFS_CSUM_TREE_OBJECTID },
+ { "QUOTA", BTRFS_QUOTA_TREE_OBJECTID },
+ { "UUID", BTRFS_UUID_TREE_OBJECTID },
+ { "FREE_SPACE", BTRFS_FREE_SPACE_TREE_OBJECTID },
+ { "TREE_LOG_FIXUP", BTRFS_TREE_LOG_FIXUP_OBJECTID },
+ { "TREE_LOG", BTRFS_TREE_LOG_OBJECTID },
+ { "TREE_RELOC", BTRFS_TREE_RELOC_OBJECTID },
+ { "DATA_RELOC", BTRFS_DATA_RELOC_TREE_OBJECTID }
+ };
+
+ if (strncasecmp("BTRFS_", str, strlen("BTRFS_")) == 0)
+ str += strlen("BTRFS_");
+
+ for (i = 0; i < ARRAY_SIZE(tn); i++) {
+ int len = strlen(tn[i].name);
+
+ if (strncasecmp(tn[i].name, str, len) == 0) {
+ id = tn[i].id;
+ match = 1;
+ str += len;
+ break;
+ }
+ }
+
+ if (!match)
+ return 0;
+
+ if (strncasecmp("_TREE", str, strlen("_TREE")) == 0)
+ str += strlen("_TREE");
+
+ if (strncasecmp("_OBJECTID", str, strlen("_OBJECTID")) == 0)
+ str += strlen("_OBJECTID");
+
+ *end = str;
+
+ return id;
+}
+
+const char * const cmd_inspect_dump_tree_usage[] = {
+ "btrfs inspect-internal dump-tree [options] device",
+ "Dump tree structures from a given device",
+ "Dump tree structures from a given device in textual form, expand keys to human",
+ "readable equivalents where possible.",
+ "Note: contains file names, consider that if you're asked to send the dump",
+ "for analysis.",
+ "",
+ "-e|--extents print only extent info: extent and device trees",
+ "-d|--device print only device info: tree root, chunk and device trees",
+ "-r|--roots print only short root node info",
+ "-R|--backups same as --roots plus print backup root info",
+ "-u|--uuid print only the uuid tree",
+ "-b|--block <block_num> print info from the specified block only",
+ "-t|--tree <tree_id> print only tree with the given id (string or number)",
+ NULL
+};
+
+int cmd_inspect_dump_tree(int argc, char **argv)
+{
+ struct btrfs_root *root;
+ struct btrfs_fs_info *info;
+ struct btrfs_path path;
+ struct btrfs_key key;
+ struct btrfs_root_item ri;
+ struct extent_buffer *leaf;
+ struct btrfs_disk_key disk_key;
+ struct btrfs_key found_key;
+ char uuidbuf[BTRFS_UUID_UNPARSED_SIZE];
+ int ret;
+ int slot;
+ int extent_only = 0;
+ int device_only = 0;
+ int uuid_tree_only = 0;
+ int roots_only = 0;
+ int root_backups = 0;
+ u64 block_only = 0;
+ struct btrfs_root *tree_root_scan;
+ u64 tree_id = 0;
+
+ while (1) {
+ int c;
+ static const struct option long_options[] = {
+ { "extents", no_argument, NULL, 'e'},
+ { "device", no_argument, NULL, 'd'},
+ { "roots", no_argument, NULL, 'r'},
+ { "backups", no_argument, NULL, 'R'},
+ { "uuid", no_argument, NULL, 'u'},
+ { "block", required_argument, NULL, 'b'},
+ { "tree", required_argument, NULL, 't'},
+ { NULL, 0, NULL, 0 }
+ };
+
+ c = getopt_long(argc, argv, "deb:rRut:", long_options, NULL);
+ if (c < 0)
+ break;
+ switch (c) {
+ case 'e':
+ extent_only = 1;
+ break;
+ case 'd':
+ device_only = 1;
+ break;
+ case 'r':
+ roots_only = 1;
+ break;
+ case 'u':
+ uuid_tree_only = 1;
+ break;
+ case 'R':
+ roots_only = 1;
+ root_backups = 1;
+ break;
+ case 'b':
+ block_only = arg_strtou64(optarg);
+ break;
+ case 't':
+ if (string_is_numerical(optarg)) {
+ tree_id = arg_strtou64(optarg);
+ } else {
+ const char *end = NULL;
+
+ tree_id = treeid_from_string(optarg, &end);
+
+ if (*end) {
+ error("unexpected tree id suffix of '%s': %s\n",
+ optarg, end);
+ exit(1);
+ }
+ }
+ if (!tree_id) {
+ error("unrecognized tree id: %s\n",
+ optarg);
+ exit(1);
+ }
+ break;
+ default:
+ usage(cmd_inspect_dump_tree_usage);
+ }
+ }
+
+ if (check_argc_exact(argc - optind, 1))
+ usage(cmd_inspect_dump_tree_usage);
+
+ ret = check_arg_type(argv[optind]);
+ if (ret != BTRFS_ARG_BLKDEV && ret != BTRFS_ARG_REG) {
+ error("not a block device or regular file: %s", argv[optind]);
+ goto out;
+ }
+
+ printf("%s\n", PACKAGE_STRING);
+
+ info = open_ctree_fs_info(argv[optind], 0, 0, 0, OPEN_CTREE_PARTIAL);
+ if (!info) {
+ error("unable to open %s", argv[optind]);
+ goto out;
+ }
+
+ root = info->fs_root;
+ if (!root) {
+ error("unable to open %s", argv[optind]);
+ goto out;
+ }
+
+ if (block_only) {
+ leaf = read_tree_block(root,
+ block_only,
+ root->nodesize, 0);
+
+ if (extent_buffer_uptodate(leaf) &&
+ btrfs_header_level(leaf) != 0) {
+ free_extent_buffer(leaf);
+ leaf = NULL;
+ }
+
+ if (!leaf) {
+ leaf = read_tree_block(root,
+ block_only,
+ root->nodesize, 0);
+ }
+ if (!extent_buffer_uptodate(leaf)) {
+ error("failed to read %llu",
+ (unsigned long long)block_only);
+ goto close_root;
+ }
+ btrfs_print_tree(root, leaf, 0);
+ free_extent_buffer(leaf);
+ goto close_root;
+ }
+
+ if (!(extent_only || uuid_tree_only || tree_id)) {
+ if (roots_only) {
+ printf("root tree: %llu level %d\n",
+ (unsigned long long)info->tree_root->node->start,
+ btrfs_header_level(info->tree_root->node));
+ printf("chunk tree: %llu level %d\n",
+ (unsigned long long)info->chunk_root->node->start,
+ btrfs_header_level(info->chunk_root->node));
+ } else {
+ if (info->tree_root->node) {
+ printf("root tree\n");
+ btrfs_print_tree(info->tree_root,
+ info->tree_root->node, 1);
+ }
+
+ if (info->chunk_root->node) {
+ printf("chunk tree\n");
+ btrfs_print_tree(info->chunk_root,
+ info->chunk_root->node, 1);
+ }
+ }
+ }
+ tree_root_scan = info->tree_root;
+
+ btrfs_init_path(&path);
+again:
+ if (!extent_buffer_uptodate(tree_root_scan->node))
+ goto no_node;
+
+ /*
+ * Tree's that are not pointed by the tree of tree roots
+ */
+ if (tree_id && tree_id == BTRFS_ROOT_TREE_OBJECTID) {
+ if (!info->tree_root->node) {
+ error("cannot print root tree, invalid pointer");
+ goto no_node;
+ }
+ printf("root tree\n");
+ btrfs_print_tree(info->tree_root, info->tree_root->node, 1);
+ goto no_node;
+ }
+
+ if (tree_id && tree_id == BTRFS_CHUNK_TREE_OBJECTID) {
+ if (!info->chunk_root->node) {
+ error("cannot print chunk tree, invalid pointer");
+ goto no_node;
+ }
+ printf("chunk tree\n");
+ btrfs_print_tree(info->chunk_root, info->chunk_root->node, 1);
+ goto no_node;
+ }
+
+ key.offset = 0;
+ key.objectid = 0;
+ btrfs_set_key_type(&key, BTRFS_ROOT_ITEM_KEY);
+ ret = btrfs_search_slot(NULL, tree_root_scan, &key, &path, 0, 0);
+ BUG_ON(ret < 0);
+ while (1) {
+ leaf = path.nodes[0];
+ slot = path.slots[0];
+ if (slot >= btrfs_header_nritems(leaf)) {
+ ret = btrfs_next_leaf(tree_root_scan, &path);
+ if (ret != 0)
+ break;
+ leaf = path.nodes[0];
+ slot = path.slots[0];
+ }
+ btrfs_item_key(leaf, &disk_key, path.slots[0]);
+ btrfs_disk_key_to_cpu(&found_key, &disk_key);
+ if (btrfs_key_type(&found_key) == BTRFS_ROOT_ITEM_KEY) {
+ unsigned long offset;
+ struct extent_buffer *buf;
+ int skip = extent_only | device_only | uuid_tree_only;
+
+ offset = btrfs_item_ptr_offset(leaf, slot);
+ read_extent_buffer(leaf, &ri, offset, sizeof(ri));
+ buf = read_tree_block(tree_root_scan,
+ btrfs_root_bytenr(&ri),
+ tree_root_scan->nodesize,
+ 0);
+ if (!extent_buffer_uptodate(buf))
+ goto next;
+ if (tree_id && found_key.objectid != tree_id) {
+ free_extent_buffer(buf);
+ goto next;
+ }
+
+ switch (found_key.objectid) {
+ case BTRFS_ROOT_TREE_OBJECTID:
+ if (!skip)
+ printf("root");
+ break;
+ case BTRFS_EXTENT_TREE_OBJECTID:
+ if (!device_only && !uuid_tree_only)
+ skip = 0;
+ if (!skip)
+ printf("extent");
+ break;
+ case BTRFS_CHUNK_TREE_OBJECTID:
+ if (!skip) {
+ printf("chunk");
+ }
+ break;
+ case BTRFS_DEV_TREE_OBJECTID:
+ if (!uuid_tree_only)
+ skip = 0;
+ if (!skip)
+ printf("device");
+ break;
+ case BTRFS_FS_TREE_OBJECTID:
+ if (!skip) {
+ printf("fs");
+ }
+ break;
+ case BTRFS_ROOT_TREE_DIR_OBJECTID:
+ skip = 0;
+ printf("directory");
+ break;
+ case BTRFS_CSUM_TREE_OBJECTID:
+ if (!skip) {
+ printf("checksum");
+ }
+ break;
+ case BTRFS_ORPHAN_OBJECTID:
+ if (!skip) {
+ printf("orphan");
+ }
+ break;
+ case BTRFS_TREE_LOG_OBJECTID:
+ if (!skip) {
+ printf("log");
+ }
+ break;
+ case BTRFS_TREE_LOG_FIXUP_OBJECTID:
+ if (!skip) {
+ printf("log fixup");
+ }
+ break;
+ case BTRFS_TREE_RELOC_OBJECTID:
+ if (!skip) {
+ printf("reloc");
+ }
+ break;
+ case BTRFS_DATA_RELOC_TREE_OBJECTID:
+ if (!skip) {
+ printf("data reloc");
+ }
+ break;
+ case BTRFS_EXTENT_CSUM_OBJECTID:
+ if (!skip) {
+ printf("extent checksum");
+ }
+ break;
+ case BTRFS_QUOTA_TREE_OBJECTID:
+ if (!skip) {
+ printf("quota");
+ }
+ break;
+ case BTRFS_UUID_TREE_OBJECTID:
+ if (!extent_only && !device_only)
+ skip = 0;
+ if (!skip)
+ printf("uuid");
+ break;
+ case BTRFS_FREE_SPACE_TREE_OBJECTID:
+ if (!skip)
+ printf("free space");
+ break;
+ case BTRFS_MULTIPLE_OBJECTIDS:
+ if (!skip) {
+ printf("multiple");
+ }
+ break;
+ default:
+ if (!skip) {
+ printf("file");
+ }
+ }
+ if (extent_only && !skip) {
+ printf(" tree ");
+ btrfs_print_key(&disk_key);
+ printf("\n");
+ print_extents(tree_root_scan, buf);
+ } else if (!skip) {
+ printf(" tree ");
+ btrfs_print_key(&disk_key);
+ if (roots_only) {
+ printf(" %llu level %d\n",
+ (unsigned long long)buf->start,
+ btrfs_header_level(buf));
+ } else {
+ printf(" \n");
+ btrfs_print_tree(tree_root_scan, buf, 1);
+ }
+ }
+ free_extent_buffer(buf);
+ }
+next:
+ path.slots[0]++;
+ }
+no_node:
+ btrfs_release_path(&path);
+
+ if (tree_root_scan == info->tree_root &&
+ info->log_root_tree) {
+ tree_root_scan = info->log_root_tree;
+ goto again;
+ }
+
+ if (extent_only || device_only || uuid_tree_only)
+ goto close_root;
+
+ if (root_backups)
+ print_old_roots(info->super_copy);
+
+ printf("total bytes %llu\n",
+ (unsigned long long)btrfs_super_total_bytes(info->super_copy));
+ printf("bytes used %llu\n",
+ (unsigned long long)btrfs_super_bytes_used(info->super_copy));
+ uuidbuf[BTRFS_UUID_UNPARSED_SIZE - 1] = '\0';
+ uuid_unparse(info->super_copy->fsid, uuidbuf);
+ printf("uuid %s\n", uuidbuf);
+close_root:
+ ret = close_ctree(root);
+out:
+ return !!ret;
+}