2 * Copyright (C) 2007 Oracle. All rights reserved.
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public
6 * License v2 as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
13 * You should have received a copy of the GNU General Public
14 * License along with this program; if not, write to the
15 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
16 * Boston, MA 021110-1307, USA.
22 #include <uuid/uuid.h>
25 #include "kerncompat.h"
26 #include "radix-tree.h"
29 #include "print-tree.h"
30 #include "transaction.h"
34 #include "cmds-inspect-dump-tree.h"
37 static void print_extents(struct btrfs_root *root, struct extent_buffer *eb)
39 struct extent_buffer *next;
47 if (btrfs_is_leaf(eb)) {
48 btrfs_print_leaf(root, eb);
52 size = root->fs_info->nodesize;
53 nr = btrfs_header_nritems(eb);
54 for (i = 0; i < nr; i++) {
55 next = read_tree_block(root->fs_info,
56 btrfs_node_blockptr(eb, i),
57 size, btrfs_node_ptr_generation(eb, i));
58 if (!extent_buffer_uptodate(next))
60 if (btrfs_is_leaf(next) && btrfs_header_level(eb) != 1) {
62 "eb corrupted: item %d eb level %d next level %d, skipping the rest",
63 i, btrfs_header_level(next),
64 btrfs_header_level(eb));
67 if (btrfs_header_level(next) != btrfs_header_level(eb) - 1) {
69 "eb corrupted: item %d eb level %d next level %d, skipping the rest",
70 i, btrfs_header_level(next),
71 btrfs_header_level(eb));
74 print_extents(root, next);
75 free_extent_buffer(next);
81 free_extent_buffer(next);
84 static void print_old_roots(struct btrfs_super_block *super)
86 struct btrfs_root_backup *backup;
89 for (i = 0; i < BTRFS_NUM_BACKUP_ROOTS; i++) {
90 backup = super->super_roots + i;
91 printf("btrfs root backup slot %d\n", i);
92 printf("\ttree root gen %llu block %llu\n",
93 (unsigned long long)btrfs_backup_tree_root_gen(backup),
94 (unsigned long long)btrfs_backup_tree_root(backup));
96 printf("\t\textent root gen %llu block %llu\n",
97 (unsigned long long)btrfs_backup_extent_root_gen(backup),
98 (unsigned long long)btrfs_backup_extent_root(backup));
100 printf("\t\tchunk root gen %llu block %llu\n",
101 (unsigned long long)btrfs_backup_chunk_root_gen(backup),
102 (unsigned long long)btrfs_backup_chunk_root(backup));
104 printf("\t\tdevice root gen %llu block %llu\n",
105 (unsigned long long)btrfs_backup_dev_root_gen(backup),
106 (unsigned long long)btrfs_backup_dev_root(backup));
108 printf("\t\tcsum root gen %llu block %llu\n",
109 (unsigned long long)btrfs_backup_csum_root_gen(backup),
110 (unsigned long long)btrfs_backup_csum_root(backup));
112 printf("\t\tfs root gen %llu block %llu\n",
113 (unsigned long long)btrfs_backup_fs_root_gen(backup),
114 (unsigned long long)btrfs_backup_fs_root(backup));
116 printf("\t\t%llu used %llu total %llu devices\n",
117 (unsigned long long)btrfs_backup_bytes_used(backup),
118 (unsigned long long)btrfs_backup_total_bytes(backup),
119 (unsigned long long)btrfs_backup_num_devices(backup));
124 * Convert a tree name from various forms to the numerical id if possible
126 * - case does not matter
127 * - same as the key name, BTRFS_ROOT_TREE_OBJECTID
128 * - dtto shortened, BTRFS_ROOT_TREE
129 * - dtto without prefix, ROOT_TREE
130 * - common name, ROOT, CHUNK, EXTENT, ...
131 * - dtto alias, DEVICE for DEV, CHECKSUM for CSUM
133 * Returns 0 if the tree id was not recognized.
135 static u64 treeid_from_string(const char *str, const char **end)
140 static struct treename {
144 { "ROOT", BTRFS_ROOT_TREE_OBJECTID },
145 { "EXTENT", BTRFS_EXTENT_TREE_OBJECTID },
146 { "CHUNK", BTRFS_CHUNK_TREE_OBJECTID },
147 { "DEVICE", BTRFS_DEV_TREE_OBJECTID },
148 { "DEV", BTRFS_DEV_TREE_OBJECTID },
149 { "FS_TREE", BTRFS_FS_TREE_OBJECTID },
150 { "CSUM", BTRFS_CSUM_TREE_OBJECTID },
151 { "CHECKSUM", BTRFS_CSUM_TREE_OBJECTID },
152 { "QUOTA", BTRFS_QUOTA_TREE_OBJECTID },
153 { "UUID", BTRFS_UUID_TREE_OBJECTID },
154 { "FREE_SPACE", BTRFS_FREE_SPACE_TREE_OBJECTID },
155 { "TREE_LOG_FIXUP", BTRFS_TREE_LOG_FIXUP_OBJECTID },
156 { "TREE_LOG", BTRFS_TREE_LOG_OBJECTID },
157 { "TREE_RELOC", BTRFS_TREE_RELOC_OBJECTID },
158 { "DATA_RELOC", BTRFS_DATA_RELOC_TREE_OBJECTID }
161 if (strncasecmp("BTRFS_", str, strlen("BTRFS_")) == 0)
162 str += strlen("BTRFS_");
164 for (i = 0; i < ARRAY_SIZE(tn); i++) {
165 int len = strlen(tn[i].name);
167 if (strncasecmp(tn[i].name, str, len) == 0) {
178 if (strncasecmp("_TREE", str, strlen("_TREE")) == 0)
179 str += strlen("_TREE");
181 if (strncasecmp("_OBJECTID", str, strlen("_OBJECTID")) == 0)
182 str += strlen("_OBJECTID");
189 const char * const cmd_inspect_dump_tree_usage[] = {
190 "btrfs inspect-internal dump-tree [options] device",
191 "Dump tree structures from a given device",
192 "Dump tree structures from a given device in textual form, expand keys to human",
193 "readable equivalents where possible.",
194 "Note: contains file names, consider that if you're asked to send the dump",
197 "-e|--extents print only extent info: extent and device trees",
198 "-d|--device print only device info: tree root, chunk and device trees",
199 "-r|--roots print only short root node info",
200 "-R|--backups same as --roots plus print backup root info",
201 "-u|--uuid print only the uuid tree",
202 "-b|--block <block_num> print info from the specified block only",
203 "-t|--tree <tree_id> print only tree with the given id (string or number)",
207 int cmd_inspect_dump_tree(int argc, char **argv)
209 struct btrfs_root *root;
210 struct btrfs_fs_info *info;
211 struct btrfs_path path;
212 struct btrfs_key key;
213 struct btrfs_root_item ri;
214 struct extent_buffer *leaf;
215 struct btrfs_disk_key disk_key;
216 struct btrfs_key found_key;
217 char uuidbuf[BTRFS_UUID_UNPARSED_SIZE];
222 int uuid_tree_only = 0;
224 int root_backups = 0;
225 unsigned open_ctree_flags = OPEN_CTREE_FS_PARTIAL;
227 struct btrfs_root *tree_root_scan;
232 static const struct option long_options[] = {
233 { "extents", no_argument, NULL, 'e'},
234 { "device", no_argument, NULL, 'd'},
235 { "roots", no_argument, NULL, 'r'},
236 { "backups", no_argument, NULL, 'R'},
237 { "uuid", no_argument, NULL, 'u'},
238 { "block", required_argument, NULL, 'b'},
239 { "tree", required_argument, NULL, 't'},
243 c = getopt_long(argc, argv, "deb:rRut:", long_options, NULL);
265 * If only showing one block, no need to fill roots
266 * other than chunk root
268 open_ctree_flags |= __OPEN_CTREE_RETURN_CHUNK_ROOT;
269 block_only = arg_strtou64(optarg);
272 const char *end = NULL;
274 if (string_is_numerical(optarg))
275 tree_id = arg_strtou64(optarg);
277 tree_id = treeid_from_string(optarg, &end);
280 error("unrecognized tree id: %s",
286 error("unexpected tree id suffix of '%s': %s",
293 usage(cmd_inspect_dump_tree_usage);
297 if (check_argc_exact(argc - optind, 1))
298 usage(cmd_inspect_dump_tree_usage);
300 ret = check_arg_type(argv[optind]);
301 if (ret != BTRFS_ARG_BLKDEV && ret != BTRFS_ARG_REG) {
302 error("not a block device or regular file: %s", argv[optind]);
306 printf("%s\n", PACKAGE_STRING);
308 info = open_ctree_fs_info(argv[optind], 0, 0, 0, open_ctree_flags);
310 error("unable to open %s", argv[optind]);
315 root = info->chunk_root;
316 leaf = read_tree_block(info,
320 if (extent_buffer_uptodate(leaf) &&
321 btrfs_header_level(leaf) != 0) {
322 free_extent_buffer(leaf);
327 leaf = read_tree_block(info,
331 if (!extent_buffer_uptodate(leaf)) {
332 error("failed to read %llu",
333 (unsigned long long)block_only);
336 btrfs_print_tree(root, leaf, 0);
337 free_extent_buffer(leaf);
341 root = info->fs_root;
343 error("unable to open %s", argv[optind]);
347 if (!(extent_only || uuid_tree_only || tree_id)) {
349 printf("root tree: %llu level %d\n",
350 (unsigned long long)info->tree_root->node->start,
351 btrfs_header_level(info->tree_root->node));
352 printf("chunk tree: %llu level %d\n",
353 (unsigned long long)info->chunk_root->node->start,
354 btrfs_header_level(info->chunk_root->node));
355 if (info->log_root_tree)
356 printf("log root tree: %llu level %d\n",
357 info->log_root_tree->node->start,
359 info->log_root_tree->node));
361 if (info->tree_root->node) {
362 printf("root tree\n");
363 btrfs_print_tree(info->tree_root,
364 info->tree_root->node, 1);
367 if (info->chunk_root->node) {
368 printf("chunk tree\n");
369 btrfs_print_tree(info->chunk_root,
370 info->chunk_root->node, 1);
373 if (info->log_root_tree) {
374 printf("log root tree\n");
375 btrfs_print_tree(info->log_root_tree,
376 info->log_root_tree->node, 1);
380 tree_root_scan = info->tree_root;
382 btrfs_init_path(&path);
384 if (!extent_buffer_uptodate(tree_root_scan->node))
388 * Tree's that are not pointed by the tree of tree roots
390 if (tree_id && tree_id == BTRFS_ROOT_TREE_OBJECTID) {
391 if (!info->tree_root->node) {
392 error("cannot print root tree, invalid pointer");
395 printf("root tree\n");
396 btrfs_print_tree(info->tree_root, info->tree_root->node, 1);
400 if (tree_id && tree_id == BTRFS_CHUNK_TREE_OBJECTID) {
401 if (!info->chunk_root->node) {
402 error("cannot print chunk tree, invalid pointer");
405 printf("chunk tree\n");
406 btrfs_print_tree(info->chunk_root, info->chunk_root->node, 1);
410 if (tree_id && tree_id == BTRFS_TREE_LOG_OBJECTID) {
411 if (!info->log_root_tree) {
412 error("cannot print log root tree, invalid pointer");
415 printf("log root tree\n");
416 btrfs_print_tree(info->log_root_tree, info->log_root_tree->node,
423 key.type = BTRFS_ROOT_ITEM_KEY;
424 ret = btrfs_search_slot(NULL, tree_root_scan, &key, &path, 0, 0);
426 error("cannot read ROOT_ITEM from tree %llu: %s",
427 (unsigned long long)tree_root_scan->root_key.objectid,
432 leaf = path.nodes[0];
433 slot = path.slots[0];
434 if (slot >= btrfs_header_nritems(leaf)) {
435 ret = btrfs_next_leaf(tree_root_scan, &path);
438 leaf = path.nodes[0];
439 slot = path.slots[0];
441 btrfs_item_key(leaf, &disk_key, path.slots[0]);
442 btrfs_disk_key_to_cpu(&found_key, &disk_key);
443 if (found_key.type == BTRFS_ROOT_ITEM_KEY) {
444 unsigned long offset;
445 struct extent_buffer *buf;
446 int skip = extent_only | device_only | uuid_tree_only;
448 offset = btrfs_item_ptr_offset(leaf, slot);
449 read_extent_buffer(leaf, &ri, offset, sizeof(ri));
450 buf = read_tree_block(info, btrfs_root_bytenr(&ri),
452 if (!extent_buffer_uptodate(buf))
454 if (tree_id && found_key.objectid != tree_id) {
455 free_extent_buffer(buf);
459 switch (found_key.objectid) {
460 case BTRFS_ROOT_TREE_OBJECTID:
464 case BTRFS_EXTENT_TREE_OBJECTID:
465 if (!device_only && !uuid_tree_only)
470 case BTRFS_CHUNK_TREE_OBJECTID:
475 case BTRFS_DEV_TREE_OBJECTID:
481 case BTRFS_FS_TREE_OBJECTID:
486 case BTRFS_ROOT_TREE_DIR_OBJECTID:
490 case BTRFS_CSUM_TREE_OBJECTID:
495 case BTRFS_ORPHAN_OBJECTID:
500 case BTRFS_TREE_LOG_OBJECTID:
505 case BTRFS_TREE_LOG_FIXUP_OBJECTID:
510 case BTRFS_TREE_RELOC_OBJECTID:
515 case BTRFS_DATA_RELOC_TREE_OBJECTID:
517 printf("data reloc");
520 case BTRFS_EXTENT_CSUM_OBJECTID:
522 printf("extent checksum");
525 case BTRFS_QUOTA_TREE_OBJECTID:
530 case BTRFS_UUID_TREE_OBJECTID:
531 if (!extent_only && !device_only)
536 case BTRFS_FREE_SPACE_TREE_OBJECTID:
538 printf("free space");
540 case BTRFS_MULTIPLE_OBJECTIDS:
550 if (extent_only && !skip) {
552 btrfs_print_key(&disk_key);
554 print_extents(tree_root_scan, buf);
557 btrfs_print_key(&disk_key);
559 printf(" %llu level %d\n",
560 (unsigned long long)buf->start,
561 btrfs_header_level(buf));
564 btrfs_print_tree(tree_root_scan, buf, 1);
567 free_extent_buffer(buf);
573 btrfs_release_path(&path);
575 if (tree_root_scan == info->tree_root && info->log_root_tree) {
576 tree_root_scan = info->log_root_tree;
580 if (extent_only || device_only || uuid_tree_only)
584 print_old_roots(info->super_copy);
586 printf("total bytes %llu\n",
587 (unsigned long long)btrfs_super_total_bytes(info->super_copy));
588 printf("bytes used %llu\n",
589 (unsigned long long)btrfs_super_bytes_used(info->super_copy));
590 uuidbuf[BTRFS_UUID_UNPARSED_SIZE - 1] = '\0';
591 uuid_unparse(info->super_copy->fsid, uuidbuf);
592 printf("uuid %s\n", uuidbuf);
594 ret = close_ctree(root);