cmds-inspect-dump-tree.c

   1 /*
   2  * Copyright (C) 2007 Oracle.  All rights reserved.
   3  *
   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.
   7  *
   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.
  12  *
  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.
  17  */
  18
  19 #include <stdio.h>
  20 #include <stdlib.h>
  21 #include <unistd.h>
  22 #include <uuid/uuid.h>
  23 #include <getopt.h>
  24
  25 #include "kerncompat.h"
  26 #include "radix-tree.h"
  27 #include "ctree.h"
  28 #include "disk-io.h"
  29 #include "print-tree.h"
  30 #include "transaction.h"
  31 #include "volumes.h"
  32 #include "commands.h"
  33 #include "utils.h"
  34 #include "help.h"
  35
  36 static void print_extents(struct extent_buffer *eb)
  37 {
  38         struct btrfs_fs_info *fs_info = eb->fs_info;
  39         struct extent_buffer *next;
  40         int i;
  41         u32 nr;
  42
  43         if (!eb)
  44                 return;
  45
  46         if (btrfs_is_leaf(eb)) {
  47                 btrfs_print_leaf(eb);
  48                 return;
  49         }
  50
  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))
  57                         continue;
  58                 if (btrfs_is_leaf(next) && btrfs_header_level(eb) != 1) {
  59                         warning(
  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));
  63                         goto out;
  64                 }
  65                 if (btrfs_header_level(next) != btrfs_header_level(eb) - 1) {
  66                         warning(
  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));
  70                         goto out;
  71                 }
  72                 print_extents(next);
  73                 free_extent_buffer(next);
  74         }
  75
  76         return;
  77
  78 out:
  79         free_extent_buffer(next);
  80 }
  81
  82 static void print_old_roots(struct btrfs_super_block *super)
  83 {
  84         struct btrfs_root_backup *backup;
  85         int i;
  86
  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));
  93
  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));
  97
  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));
 101
 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));
 105
 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));
 109
 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));
 113
 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));
 118         }
 119 }
 120
 121 /*
 122  * Convert a tree name from various forms to the numerical id if possible
 123  * Accepted forms:
 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
 130  *
 131  * Returns 0 if the tree id was not recognized.
 132  */
 133 static u64 treeid_from_string(const char *str, const char **end)
 134 {
 135         int match = 0;
 136         int i;
 137         u64 id;
 138         static struct treename {
 139                 const char *name;
 140                 u64 id;
 141         } tn[] = {
 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 }
 157         };
 158
 159         if (strncasecmp("BTRFS_", str, strlen("BTRFS_")) == 0)
 160                 str += strlen("BTRFS_");
 161
 162         for (i = 0; i < ARRAY_SIZE(tn); i++) {
 163                 int len = strlen(tn[i].name);
 164
 165                 if (strncasecmp(tn[i].name, str, len) == 0) {
 166                         id = tn[i].id;
 167                         match = 1;
 168                         str += len;
 169                         break;
 170                 }
 171         }
 172
 173         if (!match)
 174                 return 0;
 175
 176         if (strncasecmp("_TREE", str, strlen("_TREE")) == 0)
 177                 str += strlen("_TREE");
 178
 179         if (strncasecmp("_OBJECTID", str, strlen("_OBJECTID")) == 0)
 180                 str += strlen("_OBJECTID");
 181
 182         *end = str;
 183
 184         return id;
 185 }
 186
 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",
 193         "for analysis.",
 194         "",
 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>",
 203         NULL
 204 };
 205
 206 int cmd_inspect_dump_tree(int argc, char **argv)
 207 {
 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];
 217         int ret;
 218         int slot;
 219         int extent_only = 0;
 220         int device_only = 0;
 221         int uuid_tree_only = 0;
 222         int roots_only = 0;
 223         int root_backups = 0;
 224         unsigned open_ctree_flags;
 225         u64 block_only = 0;
 226         struct btrfs_root *tree_root_scan;
 227         u64 tree_id = 0;
 228         bool follow = false;
 229
 230         /*
 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.
 236          */
 237         open_ctree_flags = OPEN_CTREE_PARTIAL | OPEN_CTREE_NO_BLOCK_GROUPS;
 238         while (1) {
 239                 int c;
 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 },
 250                         { NULL, 0, NULL, 0 }
 251                 };
 252
 253                 c = getopt_long(argc, argv, "deb:rRut:", long_options, NULL);
 254                 if (c < 0)
 255                         break;
 256                 switch (c) {
 257                 case 'e':
 258                         extent_only = 1;
 259                         break;
 260                 case 'd':
 261                         device_only = 1;
 262                         break;
 263                 case 'r':
 264                         roots_only = 1;
 265                         break;
 266                 case 'u':
 267                         uuid_tree_only = 1;
 268                         break;
 269                 case 'R':
 270                         roots_only = 1;
 271                         root_backups = 1;
 272                         break;
 273                 case 'b':
 274                         /*
 275                          * If only showing one block, no need to fill roots
 276                          * other than chunk root
 277                          */
 278                         open_ctree_flags |= __OPEN_CTREE_RETURN_CHUNK_ROOT;
 279                         block_only = arg_strtou64(optarg);
 280                         break;
 281                 case 't': {
 282                         const char *end = NULL;
 283
 284                         if (string_is_numerical(optarg))
 285                                 tree_id = arg_strtou64(optarg);
 286                         else
 287                                 tree_id = treeid_from_string(optarg, &end);
 288
 289                         if (!tree_id) {
 290                                 error("unrecognized tree id: %s",
 291                                                 optarg);
 292                                 exit(1);
 293                         }
 294
 295                         if (end && *end) {
 296                                 error("unexpected tree id suffix of '%s': %s",
 297                                                 optarg, end);
 298                                 exit(1);
 299                         }
 300                         break;
 301                         }
 302                 case GETOPT_VAL_FOLLOW:
 303                         follow = true;
 304                         break;
 305                 default:
 306                         usage(cmd_inspect_dump_tree_usage);
 307                 }
 308         }
 309
 310         if (check_argc_exact(argc - optind, 1))
 311                 usage(cmd_inspect_dump_tree_usage);
 312
 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]);
 316                 goto out;
 317         }
 318
 319         printf("%s\n", PACKAGE_STRING);
 320
 321         info = open_ctree_fs_info(argv[optind], 0, 0, 0, open_ctree_flags);
 322         if (!info) {
 323                 error("unable to open %s", argv[optind]);
 324                 goto out;
 325         }
 326
 327         if (block_only) {
 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);
 333                         leaf = NULL;
 334                 }
 335
 336                 if (!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);
 341                         goto close_root;
 342                 }
 343                 btrfs_print_tree(leaf, follow);
 344                 free_extent_buffer(leaf);
 345                 goto close_root;
 346         }
 347
 348         root = info->fs_root;
 349         if (!root) {
 350                 error("unable to open %s", argv[optind]);
 351                 goto out;
 352         }
 353
 354         if (!(extent_only || uuid_tree_only || tree_id)) {
 355                 if (roots_only) {
 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,
 365                                         btrfs_header_level(
 366                                                 info->log_root_tree->node));
 367                 } else {
 368                         if (info->tree_root->node) {
 369                                 printf("root tree\n");
 370                                 btrfs_print_tree(info->tree_root->node, 1);
 371                         }
 372
 373                         if (info->chunk_root->node) {
 374                                 printf("chunk tree\n");
 375                                 btrfs_print_tree(info->chunk_root->node, 1);
 376                         }
 377
 378                         if (info->log_root_tree) {
 379                                 printf("log root tree\n");
 380                                 btrfs_print_tree(info->log_root_tree->node, 1);
 381                         }
 382                 }
 383         }
 384         tree_root_scan = info->tree_root;
 385
 386         btrfs_init_path(&path);
 387 again:
 388         if (!extent_buffer_uptodate(tree_root_scan->node))
 389                 goto no_node;
 390
 391         /*
 392          * Tree's that are not pointed by the tree of tree roots
 393          */
 394         if (tree_id && tree_id == BTRFS_ROOT_TREE_OBJECTID) {
 395                 if (!info->tree_root->node) {
 396                         error("cannot print root tree, invalid pointer");
 397                         goto close_root;
 398                 }
 399                 printf("root tree\n");
 400                 btrfs_print_tree(info->tree_root->node, 1);
 401                 goto close_root;
 402         }
 403
 404         if (tree_id && tree_id == BTRFS_CHUNK_TREE_OBJECTID) {
 405                 if (!info->chunk_root->node) {
 406                         error("cannot print chunk tree, invalid pointer");
 407                         goto close_root;
 408                 }
 409                 printf("chunk tree\n");
 410                 btrfs_print_tree(info->chunk_root->node, 1);
 411                 goto close_root;
 412         }
 413
 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");
 417                         goto close_root;
 418                 }
 419                 printf("log root tree\n");
 420                 btrfs_print_tree(info->log_root_tree->node, 1);
 421                 goto close_root;
 422         }
 423
 424         key.offset = 0;
 425         key.objectid = 0;
 426         key.type = BTRFS_ROOT_ITEM_KEY;
 427         ret = btrfs_search_slot(NULL, tree_root_scan, &key, &path, 0, 0);
 428         if (ret < 0) {
 429                 error("cannot read ROOT_ITEM from tree %llu: %s",
 430                         (unsigned long long)tree_root_scan->root_key.objectid,
 431                         strerror(-ret));
 432                 goto close_root;
 433         }
 434         while (1) {
 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);
 439                         if (ret != 0)
 440                                 break;
 441                         leaf = path.nodes[0];
 442                         slot = path.slots[0];
 443                 }
 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;
 450
 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))
 455                                 goto next;
 456                         if (tree_id && found_key.objectid != tree_id) {
 457                                 free_extent_buffer(buf);
 458                                 goto next;
 459                         }
 460
 461                         switch (found_key.objectid) {
 462                         case BTRFS_ROOT_TREE_OBJECTID:
 463                                 if (!skip)
 464                                         printf("root");
 465                                 break;
 466                         case BTRFS_EXTENT_TREE_OBJECTID:
 467                                 if (!device_only && !uuid_tree_only)
 468                                         skip = 0;
 469                                 if (!skip)
 470                                         printf("extent");
 471                                 break;
 472                         case BTRFS_CHUNK_TREE_OBJECTID:
 473                                 if (!skip) {
 474                                         printf("chunk");
 475                                 }
 476                                 break;
 477                         case BTRFS_DEV_TREE_OBJECTID:
 478                                 if (!uuid_tree_only)
 479                                         skip = 0;
 480                                 if (!skip)
 481                                         printf("device");
 482                                 break;
 483                         case BTRFS_FS_TREE_OBJECTID:
 484                                 if (!skip) {
 485                                         printf("fs");
 486                                 }
 487                                 break;
 488                         case BTRFS_ROOT_TREE_DIR_OBJECTID:
 489                                 skip = 0;
 490                                 printf("directory");
 491                                 break;
 492                         case BTRFS_CSUM_TREE_OBJECTID:
 493                                 if (!skip) {
 494                                         printf("checksum");
 495                                 }
 496                                 break;
 497                         case BTRFS_ORPHAN_OBJECTID:
 498                                 if (!skip) {
 499                                         printf("orphan");
 500                                 }
 501                                 break;
 502                         case BTRFS_TREE_LOG_OBJECTID:
 503                                 if (!skip) {
 504                                         printf("log");
 505                                 }
 506                                 break;
 507                         case BTRFS_TREE_LOG_FIXUP_OBJECTID:
 508                                 if (!skip) {
 509                                         printf("log fixup");
 510                                 }
 511                                 break;
 512                         case BTRFS_TREE_RELOC_OBJECTID:
 513                                 if (!skip) {
 514                                         printf("reloc");
 515                                 }
 516                                 break;
 517                         case BTRFS_DATA_RELOC_TREE_OBJECTID:
 518                                 if (!skip) {
 519                                         printf("data reloc");
 520                                 }
 521                                 break;
 522                         case BTRFS_EXTENT_CSUM_OBJECTID:
 523                                 if (!skip) {
 524                                         printf("extent checksum");
 525                                 }
 526                                 break;
 527                         case BTRFS_QUOTA_TREE_OBJECTID:
 528                                 if (!skip) {
 529                                         printf("quota");
 530                                 }
 531                                 break;
 532                         case BTRFS_UUID_TREE_OBJECTID:
 533                                 if (!extent_only && !device_only)
 534                                         skip = 0;
 535                                 if (!skip)
 536                                         printf("uuid");
 537                                 break;
 538                         case BTRFS_FREE_SPACE_TREE_OBJECTID:
 539                                 if (!skip)
 540                                         printf("free space");
 541                                 break;
 542                         case BTRFS_MULTIPLE_OBJECTIDS:
 543                                 if (!skip) {
 544                                         printf("multiple");
 545                                 }
 546                                 break;
 547                         default:
 548                                 if (!skip) {
 549                                         printf("file");
 550                                 }
 551                         }
 552                         if (extent_only && !skip) {
 553                                 printf(" tree ");
 554                                 btrfs_print_key(&disk_key);
 555                                 printf("\n");
 556                                 print_extents(buf);
 557                         } else if (!skip) {
 558                                 printf(" tree ");
 559                                 btrfs_print_key(&disk_key);
 560                                 if (roots_only) {
 561                                         printf(" %llu level %d\n",
 562                                                (unsigned long long)buf->start,
 563                                                btrfs_header_level(buf));
 564                                 } else {
 565                                         printf(" \n");
 566                                         btrfs_print_tree(buf, 1);
 567                                 }
 568                         }
 569                         free_extent_buffer(buf);
 570                 }
 571 next:
 572                 path.slots[0]++;
 573         }
 574 no_node:
 575         btrfs_release_path(&path);
 576
 577         if (tree_root_scan == info->tree_root && info->log_root_tree) {
 578                 tree_root_scan = info->log_root_tree;
 579                 goto again;
 580         }
 581
 582         if (extent_only || device_only || uuid_tree_only)
 583                 goto close_root;
 584
 585         if (root_backups)
 586                 print_old_roots(info->super_copy);
 587
 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);
 595 close_root:
 596         ret = close_ctree(root);
 597 out:
 598         return !!ret;
 599 }