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 extent_buffer *eb)
38 struct btrfs_fs_info *fs_info = eb->fs_info;
39 struct extent_buffer *next;
46 if (btrfs_is_leaf(eb)) {
51 nr = btrfs_header_nritems(eb);
52 for (i = 0; i < nr; i++) {
53 next = read_tree_block(fs_info,
54 btrfs_node_blockptr(eb, i),
55 btrfs_node_ptr_generation(eb, i));
56 if (!extent_buffer_uptodate(next))
58 if (btrfs_is_leaf(next) && btrfs_header_level(eb) != 1) {
60 "eb corrupted: item %d eb level %d next level %d, skipping the rest",
61 i, btrfs_header_level(next),
62 btrfs_header_level(eb));
65 if (btrfs_header_level(next) != btrfs_header_level(eb) - 1) {
67 "eb corrupted: item %d eb level %d next level %d, skipping the rest",
68 i, btrfs_header_level(next),
69 btrfs_header_level(eb));
73 free_extent_buffer(next);
79 free_extent_buffer(next);
82 static void print_old_roots(struct btrfs_super_block *super)
84 struct btrfs_root_backup *backup;
87 for (i = 0; i < BTRFS_NUM_BACKUP_ROOTS; i++) {
88 backup = super->super_roots + i;
89 printf("btrfs root backup slot %d\n", i);
90 printf("\ttree root gen %llu block %llu\n",
91 (unsigned long long)btrfs_backup_tree_root_gen(backup),
92 (unsigned long long)btrfs_backup_tree_root(backup));
94 printf("\t\textent root gen %llu block %llu\n",
95 (unsigned long long)btrfs_backup_extent_root_gen(backup),
96 (unsigned long long)btrfs_backup_extent_root(backup));
98 printf("\t\tchunk root gen %llu block %llu\n",
99 (unsigned long long)btrfs_backup_chunk_root_gen(backup),
100 (unsigned long long)btrfs_backup_chunk_root(backup));
102 printf("\t\tdevice root gen %llu block %llu\n",
103 (unsigned long long)btrfs_backup_dev_root_gen(backup),
104 (unsigned long long)btrfs_backup_dev_root(backup));
106 printf("\t\tcsum root gen %llu block %llu\n",
107 (unsigned long long)btrfs_backup_csum_root_gen(backup),
108 (unsigned long long)btrfs_backup_csum_root(backup));
110 printf("\t\tfs root gen %llu block %llu\n",
111 (unsigned long long)btrfs_backup_fs_root_gen(backup),
112 (unsigned long long)btrfs_backup_fs_root(backup));
114 printf("\t\t%llu used %llu total %llu devices\n",
115 (unsigned long long)btrfs_backup_bytes_used(backup),
116 (unsigned long long)btrfs_backup_total_bytes(backup),
117 (unsigned long long)btrfs_backup_num_devices(backup));
122 * Convert a tree name from various forms to the numerical id if possible
124 * - case does not matter
125 * - same as the key name, BTRFS_ROOT_TREE_OBJECTID
126 * - dtto shortened, BTRFS_ROOT_TREE
127 * - dtto without prefix, ROOT_TREE
128 * - common name, ROOT, CHUNK, EXTENT, ...
129 * - dtto alias, DEVICE for DEV, CHECKSUM for CSUM
131 * Returns 0 if the tree id was not recognized.
133 static u64 treeid_from_string(const char *str, const char **end)
138 static struct treename {
142 { "ROOT", BTRFS_ROOT_TREE_OBJECTID },
143 { "EXTENT", BTRFS_EXTENT_TREE_OBJECTID },
144 { "CHUNK", BTRFS_CHUNK_TREE_OBJECTID },
145 { "DEVICE", BTRFS_DEV_TREE_OBJECTID },
146 { "DEV", BTRFS_DEV_TREE_OBJECTID },
147 { "FS", BTRFS_FS_TREE_OBJECTID },
148 { "CSUM", BTRFS_CSUM_TREE_OBJECTID },
149 { "CHECKSUM", BTRFS_CSUM_TREE_OBJECTID },
150 { "QUOTA", BTRFS_QUOTA_TREE_OBJECTID },
151 { "UUID", BTRFS_UUID_TREE_OBJECTID },
152 { "FREE_SPACE", BTRFS_FREE_SPACE_TREE_OBJECTID },
153 { "TREE_LOG_FIXUP", BTRFS_TREE_LOG_FIXUP_OBJECTID },
154 { "TREE_LOG", BTRFS_TREE_LOG_OBJECTID },
155 { "TREE_RELOC", BTRFS_TREE_RELOC_OBJECTID },
156 { "DATA_RELOC", BTRFS_DATA_RELOC_TREE_OBJECTID }
159 if (strncasecmp("BTRFS_", str, strlen("BTRFS_")) == 0)
160 str += strlen("BTRFS_");
162 for (i = 0; i < ARRAY_SIZE(tn); i++) {
163 int len = strlen(tn[i].name);
165 if (strncasecmp(tn[i].name, str, len) == 0) {
176 if (strncasecmp("_TREE", str, strlen("_TREE")) == 0)
177 str += strlen("_TREE");
179 if (strncasecmp("_OBJECTID", str, strlen("_OBJECTID")) == 0)
180 str += strlen("_OBJECTID");
187 const char * const cmd_inspect_dump_tree_usage[] = {
188 "btrfs inspect-internal dump-tree [options] device",
189 "Dump tree structures from a given device",
190 "Dump tree structures from a given device in textual form, expand keys to human",
191 "readable equivalents where possible.",
192 "Note: contains file names, consider that if you're asked to send the dump",
195 "-e|--extents print only extent info: extent and device trees",
196 "-d|--device print only device info: tree root, chunk and device trees",
197 "-r|--roots print only short root node info",
198 "-R|--backups same as --roots plus print backup root info",
199 "-u|--uuid print only the uuid tree",
200 "-b|--block <block_num> print info from the specified block only",
201 "-t|--tree <tree_id> print only tree with the given id (string or number)",
202 "--follow use with -b, to show all children tree blocks of <block_num>",
206 int cmd_inspect_dump_tree(int argc, char **argv)
208 struct btrfs_root *root;
209 struct btrfs_fs_info *info;
210 struct btrfs_path path;
211 struct btrfs_key key;
212 struct btrfs_root_item ri;
213 struct extent_buffer *leaf;
214 struct btrfs_disk_key disk_key;
215 struct btrfs_key found_key;
216 char uuidbuf[BTRFS_UUID_UNPARSED_SIZE];
221 int uuid_tree_only = 0;
223 int root_backups = 0;
224 unsigned open_ctree_flags;
226 struct btrfs_root *tree_root_scan;
231 * For debug-tree, we care nothing about extent tree (it's just backref
232 * and usage accounting, only makes sense for RW operations).
233 * Use NO_BLOCK_GROUPS here could also speedup open_ctree() and allow us
234 * to inspect fs with corrupted extent tree blocks, and show as many good
235 * tree blocks as possible.
237 open_ctree_flags = OPEN_CTREE_PARTIAL | OPEN_CTREE_NO_BLOCK_GROUPS;
240 enum { GETOPT_VAL_FOLLOW = 256 };
241 static const struct option long_options[] = {
242 { "extents", no_argument, NULL, 'e'},
243 { "device", no_argument, NULL, 'd'},
244 { "roots", no_argument, NULL, 'r'},
245 { "backups", no_argument, NULL, 'R'},
246 { "uuid", no_argument, NULL, 'u'},
247 { "block", required_argument, NULL, 'b'},
248 { "tree", required_argument, NULL, 't'},
249 { "follow", no_argument, NULL, GETOPT_VAL_FOLLOW },
253 c = getopt_long(argc, argv, "deb:rRut:", long_options, NULL);
275 * If only showing one block, no need to fill roots
276 * other than chunk root
278 open_ctree_flags |= __OPEN_CTREE_RETURN_CHUNK_ROOT;
279 block_only = arg_strtou64(optarg);
282 const char *end = NULL;
284 if (string_is_numerical(optarg))
285 tree_id = arg_strtou64(optarg);
287 tree_id = treeid_from_string(optarg, &end);
290 error("unrecognized tree id: %s",
296 error("unexpected tree id suffix of '%s': %s",
302 case GETOPT_VAL_FOLLOW:
306 usage(cmd_inspect_dump_tree_usage);
310 if (check_argc_exact(argc - optind, 1))
311 usage(cmd_inspect_dump_tree_usage);
313 ret = check_arg_type(argv[optind]);
314 if (ret != BTRFS_ARG_BLKDEV && ret != BTRFS_ARG_REG) {
315 error("not a block device or regular file: %s", argv[optind]);
319 printf("%s\n", PACKAGE_STRING);
321 info = open_ctree_fs_info(argv[optind], 0, 0, 0, open_ctree_flags);
323 error("unable to open %s", argv[optind]);
328 root = info->chunk_root;
329 leaf = read_tree_block(info, block_only, 0);
330 if (extent_buffer_uptodate(leaf) &&
331 btrfs_header_level(leaf) != 0) {
332 free_extent_buffer(leaf);
337 leaf = read_tree_block(info, block_only, 0);
338 if (!extent_buffer_uptodate(leaf)) {
339 error("failed to read %llu",
340 (unsigned long long)block_only);
343 btrfs_print_tree(leaf, follow);
344 free_extent_buffer(leaf);
348 root = info->fs_root;
350 error("unable to open %s", argv[optind]);
354 if (!(extent_only || uuid_tree_only || tree_id)) {
356 printf("root tree: %llu level %d\n",
357 (unsigned long long)info->tree_root->node->start,
358 btrfs_header_level(info->tree_root->node));
359 printf("chunk tree: %llu level %d\n",
360 (unsigned long long)info->chunk_root->node->start,
361 btrfs_header_level(info->chunk_root->node));
362 if (info->log_root_tree)
363 printf("log root tree: %llu level %d\n",
364 info->log_root_tree->node->start,
366 info->log_root_tree->node));
368 if (info->tree_root->node) {
369 printf("root tree\n");
370 btrfs_print_tree(info->tree_root->node, 1);
373 if (info->chunk_root->node) {
374 printf("chunk tree\n");
375 btrfs_print_tree(info->chunk_root->node, 1);
378 if (info->log_root_tree) {
379 printf("log root tree\n");
380 btrfs_print_tree(info->log_root_tree->node, 1);
384 tree_root_scan = info->tree_root;
386 btrfs_init_path(&path);
388 if (!extent_buffer_uptodate(tree_root_scan->node))
392 * Tree's that are not pointed by the tree of tree roots
394 if (tree_id && tree_id == BTRFS_ROOT_TREE_OBJECTID) {
395 if (!info->tree_root->node) {
396 error("cannot print root tree, invalid pointer");
399 printf("root tree\n");
400 btrfs_print_tree(info->tree_root->node, 1);
404 if (tree_id && tree_id == BTRFS_CHUNK_TREE_OBJECTID) {
405 if (!info->chunk_root->node) {
406 error("cannot print chunk tree, invalid pointer");
409 printf("chunk tree\n");
410 btrfs_print_tree(info->chunk_root->node, 1);
414 if (tree_id && tree_id == BTRFS_TREE_LOG_OBJECTID) {
415 if (!info->log_root_tree) {
416 error("cannot print log root tree, invalid pointer");
419 printf("log root tree\n");
420 btrfs_print_tree(info->log_root_tree->node, 1);
426 key.type = BTRFS_ROOT_ITEM_KEY;
427 ret = btrfs_search_slot(NULL, tree_root_scan, &key, &path, 0, 0);
429 error("cannot read ROOT_ITEM from tree %llu: %s",
430 (unsigned long long)tree_root_scan->root_key.objectid,
435 leaf = path.nodes[0];
436 slot = path.slots[0];
437 if (slot >= btrfs_header_nritems(leaf)) {
438 ret = btrfs_next_leaf(tree_root_scan, &path);
441 leaf = path.nodes[0];
442 slot = path.slots[0];
444 btrfs_item_key(leaf, &disk_key, path.slots[0]);
445 btrfs_disk_key_to_cpu(&found_key, &disk_key);
446 if (found_key.type == BTRFS_ROOT_ITEM_KEY) {
447 unsigned long offset;
448 struct extent_buffer *buf;
449 int skip = extent_only | device_only | uuid_tree_only;
451 offset = btrfs_item_ptr_offset(leaf, slot);
452 read_extent_buffer(leaf, &ri, offset, sizeof(ri));
453 buf = read_tree_block(info, btrfs_root_bytenr(&ri), 0);
454 if (!extent_buffer_uptodate(buf))
456 if (tree_id && found_key.objectid != tree_id) {
457 free_extent_buffer(buf);
461 switch (found_key.objectid) {
462 case BTRFS_ROOT_TREE_OBJECTID:
466 case BTRFS_EXTENT_TREE_OBJECTID:
467 if (!device_only && !uuid_tree_only)
472 case BTRFS_CHUNK_TREE_OBJECTID:
477 case BTRFS_DEV_TREE_OBJECTID:
483 case BTRFS_FS_TREE_OBJECTID:
488 case BTRFS_ROOT_TREE_DIR_OBJECTID:
492 case BTRFS_CSUM_TREE_OBJECTID:
497 case BTRFS_ORPHAN_OBJECTID:
502 case BTRFS_TREE_LOG_OBJECTID:
507 case BTRFS_TREE_LOG_FIXUP_OBJECTID:
512 case BTRFS_TREE_RELOC_OBJECTID:
517 case BTRFS_DATA_RELOC_TREE_OBJECTID:
519 printf("data reloc");
522 case BTRFS_EXTENT_CSUM_OBJECTID:
524 printf("extent checksum");
527 case BTRFS_QUOTA_TREE_OBJECTID:
532 case BTRFS_UUID_TREE_OBJECTID:
533 if (!extent_only && !device_only)
538 case BTRFS_FREE_SPACE_TREE_OBJECTID:
540 printf("free space");
542 case BTRFS_MULTIPLE_OBJECTIDS:
552 if (extent_only && !skip) {
554 btrfs_print_key(&disk_key);
559 btrfs_print_key(&disk_key);
561 printf(" %llu level %d\n",
562 (unsigned long long)buf->start,
563 btrfs_header_level(buf));
566 btrfs_print_tree(buf, 1);
569 free_extent_buffer(buf);
575 btrfs_release_path(&path);
577 if (tree_root_scan == info->tree_root && info->log_root_tree) {
578 tree_root_scan = info->log_root_tree;
582 if (extent_only || device_only || uuid_tree_only)
586 print_old_roots(info->super_copy);
588 printf("total bytes %llu\n",
589 (unsigned long long)btrfs_super_total_bytes(info->super_copy));
590 printf("bytes used %llu\n",
591 (unsigned long long)btrfs_super_bytes_used(info->super_copy));
592 uuidbuf[BTRFS_UUID_UNPARSED_SIZE - 1] = '\0';
593 uuid_unparse(info->super_copy->fsid, uuidbuf);
594 printf("uuid %s\n", uuidbuf);
596 ret = close_ctree(root);