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"
36 static void print_extents(struct btrfs_root *root, struct extent_buffer *eb)
38 struct extent_buffer *next;
45 if (btrfs_is_leaf(eb)) {
46 btrfs_print_leaf(root, eb);
50 nr = btrfs_header_nritems(eb);
51 for (i = 0; i < nr; i++) {
52 next = read_tree_block(root->fs_info,
53 btrfs_node_blockptr(eb, i),
54 btrfs_node_ptr_generation(eb, i));
55 if (!extent_buffer_uptodate(next))
57 if (btrfs_is_leaf(next) && btrfs_header_level(eb) != 1) {
59 "eb corrupted: item %d eb level %d next level %d, skipping the rest",
60 i, btrfs_header_level(next),
61 btrfs_header_level(eb));
64 if (btrfs_header_level(next) != btrfs_header_level(eb) - 1) {
66 "eb corrupted: item %d eb level %d next level %d, skipping the rest",
67 i, btrfs_header_level(next),
68 btrfs_header_level(eb));
71 print_extents(root, next);
72 free_extent_buffer(next);
78 free_extent_buffer(next);
81 static void print_old_roots(struct btrfs_super_block *super)
83 struct btrfs_root_backup *backup;
86 for (i = 0; i < BTRFS_NUM_BACKUP_ROOTS; i++) {
87 backup = super->super_roots + i;
88 printf("btrfs root backup slot %d\n", i);
89 printf("\ttree root gen %llu block %llu\n",
90 (unsigned long long)btrfs_backup_tree_root_gen(backup),
91 (unsigned long long)btrfs_backup_tree_root(backup));
93 printf("\t\textent root gen %llu block %llu\n",
94 (unsigned long long)btrfs_backup_extent_root_gen(backup),
95 (unsigned long long)btrfs_backup_extent_root(backup));
97 printf("\t\tchunk root gen %llu block %llu\n",
98 (unsigned long long)btrfs_backup_chunk_root_gen(backup),
99 (unsigned long long)btrfs_backup_chunk_root(backup));
101 printf("\t\tdevice root gen %llu block %llu\n",
102 (unsigned long long)btrfs_backup_dev_root_gen(backup),
103 (unsigned long long)btrfs_backup_dev_root(backup));
105 printf("\t\tcsum root gen %llu block %llu\n",
106 (unsigned long long)btrfs_backup_csum_root_gen(backup),
107 (unsigned long long)btrfs_backup_csum_root(backup));
109 printf("\t\tfs root gen %llu block %llu\n",
110 (unsigned long long)btrfs_backup_fs_root_gen(backup),
111 (unsigned long long)btrfs_backup_fs_root(backup));
113 printf("\t\t%llu used %llu total %llu devices\n",
114 (unsigned long long)btrfs_backup_bytes_used(backup),
115 (unsigned long long)btrfs_backup_total_bytes(backup),
116 (unsigned long long)btrfs_backup_num_devices(backup));
121 * Convert a tree name from various forms to the numerical id if possible
123 * - case does not matter
124 * - same as the key name, BTRFS_ROOT_TREE_OBJECTID
125 * - dtto shortened, BTRFS_ROOT_TREE
126 * - dtto without prefix, ROOT_TREE
127 * - common name, ROOT, CHUNK, EXTENT, ...
128 * - dtto alias, DEVICE for DEV, CHECKSUM for CSUM
130 * Returns 0 if the tree id was not recognized.
132 static u64 treeid_from_string(const char *str, const char **end)
137 static struct treename {
141 { "ROOT", BTRFS_ROOT_TREE_OBJECTID },
142 { "EXTENT", BTRFS_EXTENT_TREE_OBJECTID },
143 { "CHUNK", BTRFS_CHUNK_TREE_OBJECTID },
144 { "DEVICE", BTRFS_DEV_TREE_OBJECTID },
145 { "DEV", BTRFS_DEV_TREE_OBJECTID },
146 { "FS_TREE", BTRFS_FS_TREE_OBJECTID },
147 { "CSUM", BTRFS_CSUM_TREE_OBJECTID },
148 { "CHECKSUM", BTRFS_CSUM_TREE_OBJECTID },
149 { "QUOTA", BTRFS_QUOTA_TREE_OBJECTID },
150 { "UUID", BTRFS_UUID_TREE_OBJECTID },
151 { "FREE_SPACE", BTRFS_FREE_SPACE_TREE_OBJECTID },
152 { "TREE_LOG_FIXUP", BTRFS_TREE_LOG_FIXUP_OBJECTID },
153 { "TREE_LOG", BTRFS_TREE_LOG_OBJECTID },
154 { "TREE_RELOC", BTRFS_TREE_RELOC_OBJECTID },
155 { "DATA_RELOC", BTRFS_DATA_RELOC_TREE_OBJECTID }
158 if (strncasecmp("BTRFS_", str, strlen("BTRFS_")) == 0)
159 str += strlen("BTRFS_");
161 for (i = 0; i < ARRAY_SIZE(tn); i++) {
162 int len = strlen(tn[i].name);
164 if (strncasecmp(tn[i].name, str, len) == 0) {
175 if (strncasecmp("_TREE", str, strlen("_TREE")) == 0)
176 str += strlen("_TREE");
178 if (strncasecmp("_OBJECTID", str, strlen("_OBJECTID")) == 0)
179 str += strlen("_OBJECTID");
186 const char * const cmd_inspect_dump_tree_usage[] = {
187 "btrfs inspect-internal dump-tree [options] device",
188 "Dump tree structures from a given device",
189 "Dump tree structures from a given device in textual form, expand keys to human",
190 "readable equivalents where possible.",
191 "Note: contains file names, consider that if you're asked to send the dump",
194 "-e|--extents print only extent info: extent and device trees",
195 "-d|--device print only device info: tree root, chunk and device trees",
196 "-r|--roots print only short root node info",
197 "-R|--backups same as --roots plus print backup root info",
198 "-u|--uuid print only the uuid tree",
199 "-b|--block <block_num> print info from the specified block only",
200 "-t|--tree <tree_id> print only tree with the given id (string or number)",
204 int cmd_inspect_dump_tree(int argc, char **argv)
206 struct btrfs_root *root;
207 struct btrfs_fs_info *info;
208 struct btrfs_path path;
209 struct btrfs_key key;
210 struct btrfs_root_item ri;
211 struct extent_buffer *leaf;
212 struct btrfs_disk_key disk_key;
213 struct btrfs_key found_key;
214 char uuidbuf[BTRFS_UUID_UNPARSED_SIZE];
219 int uuid_tree_only = 0;
221 int root_backups = 0;
222 unsigned open_ctree_flags = OPEN_CTREE_FS_PARTIAL;
224 struct btrfs_root *tree_root_scan;
229 static const struct option long_options[] = {
230 { "extents", no_argument, NULL, 'e'},
231 { "device", no_argument, NULL, 'd'},
232 { "roots", no_argument, NULL, 'r'},
233 { "backups", no_argument, NULL, 'R'},
234 { "uuid", no_argument, NULL, 'u'},
235 { "block", required_argument, NULL, 'b'},
236 { "tree", required_argument, NULL, 't'},
240 c = getopt_long(argc, argv, "deb:rRut:", long_options, NULL);
262 * If only showing one block, no need to fill roots
263 * other than chunk root
265 open_ctree_flags |= __OPEN_CTREE_RETURN_CHUNK_ROOT;
266 block_only = arg_strtou64(optarg);
269 const char *end = NULL;
271 if (string_is_numerical(optarg))
272 tree_id = arg_strtou64(optarg);
274 tree_id = treeid_from_string(optarg, &end);
277 error("unrecognized tree id: %s",
283 error("unexpected tree id suffix of '%s': %s",
290 usage(cmd_inspect_dump_tree_usage);
294 if (check_argc_exact(argc - optind, 1))
295 usage(cmd_inspect_dump_tree_usage);
297 ret = check_arg_type(argv[optind]);
298 if (ret != BTRFS_ARG_BLKDEV && ret != BTRFS_ARG_REG) {
299 error("not a block device or regular file: %s", argv[optind]);
303 printf("%s\n", PACKAGE_STRING);
305 info = open_ctree_fs_info(argv[optind], 0, 0, 0, open_ctree_flags);
307 error("unable to open %s", argv[optind]);
312 root = info->chunk_root;
313 leaf = read_tree_block(info, block_only, 0);
314 if (extent_buffer_uptodate(leaf) &&
315 btrfs_header_level(leaf) != 0) {
316 free_extent_buffer(leaf);
321 leaf = read_tree_block(info, block_only, 0);
322 if (!extent_buffer_uptodate(leaf)) {
323 error("failed to read %llu",
324 (unsigned long long)block_only);
327 btrfs_print_tree(root, leaf, 0);
328 free_extent_buffer(leaf);
332 root = info->fs_root;
334 error("unable to open %s", argv[optind]);
338 if (!(extent_only || uuid_tree_only || tree_id)) {
340 printf("root tree: %llu level %d\n",
341 (unsigned long long)info->tree_root->node->start,
342 btrfs_header_level(info->tree_root->node));
343 printf("chunk tree: %llu level %d\n",
344 (unsigned long long)info->chunk_root->node->start,
345 btrfs_header_level(info->chunk_root->node));
346 if (info->log_root_tree)
347 printf("log root tree: %llu level %d\n",
348 info->log_root_tree->node->start,
350 info->log_root_tree->node));
352 if (info->tree_root->node) {
353 printf("root tree\n");
354 btrfs_print_tree(info->tree_root,
355 info->tree_root->node, 1);
358 if (info->chunk_root->node) {
359 printf("chunk tree\n");
360 btrfs_print_tree(info->chunk_root,
361 info->chunk_root->node, 1);
364 if (info->log_root_tree) {
365 printf("log root tree\n");
366 btrfs_print_tree(info->log_root_tree,
367 info->log_root_tree->node, 1);
371 tree_root_scan = info->tree_root;
373 btrfs_init_path(&path);
375 if (!extent_buffer_uptodate(tree_root_scan->node))
379 * Tree's that are not pointed by the tree of tree roots
381 if (tree_id && tree_id == BTRFS_ROOT_TREE_OBJECTID) {
382 if (!info->tree_root->node) {
383 error("cannot print root tree, invalid pointer");
386 printf("root tree\n");
387 btrfs_print_tree(info->tree_root, info->tree_root->node, 1);
391 if (tree_id && tree_id == BTRFS_CHUNK_TREE_OBJECTID) {
392 if (!info->chunk_root->node) {
393 error("cannot print chunk tree, invalid pointer");
396 printf("chunk tree\n");
397 btrfs_print_tree(info->chunk_root, info->chunk_root->node, 1);
401 if (tree_id && tree_id == BTRFS_TREE_LOG_OBJECTID) {
402 if (!info->log_root_tree) {
403 error("cannot print log root tree, invalid pointer");
406 printf("log root tree\n");
407 btrfs_print_tree(info->log_root_tree, info->log_root_tree->node,
414 key.type = BTRFS_ROOT_ITEM_KEY;
415 ret = btrfs_search_slot(NULL, tree_root_scan, &key, &path, 0, 0);
417 error("cannot read ROOT_ITEM from tree %llu: %s",
418 (unsigned long long)tree_root_scan->root_key.objectid,
423 leaf = path.nodes[0];
424 slot = path.slots[0];
425 if (slot >= btrfs_header_nritems(leaf)) {
426 ret = btrfs_next_leaf(tree_root_scan, &path);
429 leaf = path.nodes[0];
430 slot = path.slots[0];
432 btrfs_item_key(leaf, &disk_key, path.slots[0]);
433 btrfs_disk_key_to_cpu(&found_key, &disk_key);
434 if (found_key.type == BTRFS_ROOT_ITEM_KEY) {
435 unsigned long offset;
436 struct extent_buffer *buf;
437 int skip = extent_only | device_only | uuid_tree_only;
439 offset = btrfs_item_ptr_offset(leaf, slot);
440 read_extent_buffer(leaf, &ri, offset, sizeof(ri));
441 buf = read_tree_block(info, btrfs_root_bytenr(&ri), 0);
442 if (!extent_buffer_uptodate(buf))
444 if (tree_id && found_key.objectid != tree_id) {
445 free_extent_buffer(buf);
449 switch (found_key.objectid) {
450 case BTRFS_ROOT_TREE_OBJECTID:
454 case BTRFS_EXTENT_TREE_OBJECTID:
455 if (!device_only && !uuid_tree_only)
460 case BTRFS_CHUNK_TREE_OBJECTID:
465 case BTRFS_DEV_TREE_OBJECTID:
471 case BTRFS_FS_TREE_OBJECTID:
476 case BTRFS_ROOT_TREE_DIR_OBJECTID:
480 case BTRFS_CSUM_TREE_OBJECTID:
485 case BTRFS_ORPHAN_OBJECTID:
490 case BTRFS_TREE_LOG_OBJECTID:
495 case BTRFS_TREE_LOG_FIXUP_OBJECTID:
500 case BTRFS_TREE_RELOC_OBJECTID:
505 case BTRFS_DATA_RELOC_TREE_OBJECTID:
507 printf("data reloc");
510 case BTRFS_EXTENT_CSUM_OBJECTID:
512 printf("extent checksum");
515 case BTRFS_QUOTA_TREE_OBJECTID:
520 case BTRFS_UUID_TREE_OBJECTID:
521 if (!extent_only && !device_only)
526 case BTRFS_FREE_SPACE_TREE_OBJECTID:
528 printf("free space");
530 case BTRFS_MULTIPLE_OBJECTIDS:
540 if (extent_only && !skip) {
542 btrfs_print_key(&disk_key);
544 print_extents(tree_root_scan, buf);
547 btrfs_print_key(&disk_key);
549 printf(" %llu level %d\n",
550 (unsigned long long)buf->start,
551 btrfs_header_level(buf));
554 btrfs_print_tree(tree_root_scan, buf, 1);
557 free_extent_buffer(buf);
563 btrfs_release_path(&path);
565 if (tree_root_scan == info->tree_root && info->log_root_tree) {
566 tree_root_scan = info->log_root_tree;
570 if (extent_only || device_only || uuid_tree_only)
574 print_old_roots(info->super_copy);
576 printf("total bytes %llu\n",
577 (unsigned long long)btrfs_super_total_bytes(info->super_copy));
578 printf("bytes used %llu\n",
579 (unsigned long long)btrfs_super_bytes_used(info->super_copy));
580 uuidbuf[BTRFS_UUID_UNPARSED_SIZE - 1] = '\0';
581 uuid_unparse(info->super_copy->fsid, uuidbuf);
582 printf("uuid %s\n", uuidbuf);
584 ret = close_ctree(root);