cmds-inspect-dump-super.c

   1 /*
   2  * This program is free software; you can redistribute it and/or
   3  * modify it under the terms of the GNU General Public
   4  * License v2 as published by the Free Software Foundation.
   5  *
   6  * This program is distributed in the hope that it will be useful,
   7  * but WITHOUT ANY WARRANTY; without even the implied warranty of
   8  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   9  * General Public License for more details.
  10  *
  11  * You should have received a copy of the GNU General Public
  12  * License along with this program; if not, write to the
  13  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  14  * Boston, MA 021110-1307, USA.
  15  */
  16
  17 #include "kerncompat.h"
  18 #include <stdio.h>
  19 #include <stdlib.h>
  20 #include <unistd.h>
  21 #include <fcntl.h>
  22 #include <sys/stat.h>
  23 #include <ctype.h>
  24 #include <uuid/uuid.h>
  25 #include <errno.h>
  26
  27 #include "ctree.h"
  28 #include "disk-io.h"
  29 #include "print-tree.h"
  30 #include "transaction.h"
  31 #include "list.h"
  32 #include "utils.h"
  33 #include "commands.h"
  34 #include "crc32c.h"
  35 #include "cmds-inspect-dump-super.h"
  36
  37 static int check_csum_sblock(void *sb, int csum_size)
  38 {
  39         char result[BTRFS_CSUM_SIZE];
  40         u32 crc = ~(u32)0;
  41
  42         crc = btrfs_csum_data(NULL, (char *)sb + BTRFS_CSUM_SIZE,
  43                                 crc, BTRFS_SUPER_INFO_SIZE - BTRFS_CSUM_SIZE);
  44         btrfs_csum_final(crc, result);
  45
  46         return !memcmp(sb, &result, csum_size);
  47 }
  48
  49 static void print_sys_chunk_array(struct btrfs_super_block *sb)
  50 {
  51         struct extent_buffer *buf;
  52         struct btrfs_disk_key *disk_key;
  53         struct btrfs_chunk *chunk;
  54         u8 *array_ptr;
  55         unsigned long sb_array_offset;
  56         u32 num_stripes;
  57         u32 array_size;
  58         u32 len = 0;
  59         u32 cur_offset;
  60         struct btrfs_key key;
  61         int item;
  62
  63         buf = malloc(sizeof(*buf) + sizeof(*sb));
  64         if (!buf) {
  65                 fprintf(stderr, "%s\n", strerror(ENOMEM));
  66                 goto out;
  67         }
  68         write_extent_buffer(buf, sb, 0, sizeof(*sb));
  69         array_size = btrfs_super_sys_array_size(sb);
  70
  71         array_ptr = sb->sys_chunk_array;
  72         sb_array_offset = offsetof(struct btrfs_super_block, sys_chunk_array);
  73         cur_offset = 0;
  74         item = 0;
  75
  76         while (cur_offset < array_size) {
  77                 disk_key = (struct btrfs_disk_key *)array_ptr;
  78                 len = sizeof(*disk_key);
  79                 if (cur_offset + len > array_size)
  80                         goto out_short_read;
  81
  82                 btrfs_disk_key_to_cpu(&key, disk_key);
  83
  84                 array_ptr += len;
  85                 sb_array_offset += len;
  86                 cur_offset += len;
  87
  88                 printf("\titem %d ", item);
  89                 btrfs_print_key(disk_key);
  90                 putchar('\n');
  91
  92                 if (key.type == BTRFS_CHUNK_ITEM_KEY) {
  93                         chunk = (struct btrfs_chunk *)sb_array_offset;
  94                         /*
  95                          * At least one btrfs_chunk with one stripe must be
  96                          * present, exact stripe count check comes afterwards
  97                          */
  98                         len = btrfs_chunk_item_size(1);
  99                         if (cur_offset + len > array_size)
 100                                 goto out_short_read;
 101
 102                         print_chunk(buf, chunk);
 103                         num_stripes = btrfs_chunk_num_stripes(buf, chunk);
 104                         if (!num_stripes) {
 105                                 printk(
 106             "ERROR: invalid number of stripes %u in sys_array at offset %u\n",
 107                                         num_stripes, cur_offset);
 108                                 break;
 109                         }
 110                         len = btrfs_chunk_item_size(num_stripes);
 111                         if (cur_offset + len > array_size)
 112                                 goto out_short_read;
 113                 } else {
 114                         printk(
 115                 "ERROR: unexpected item type %u in sys_array at offset %u\n",
 116                                 (u32)key.type, cur_offset);
 117                         break;
 118                 }
 119                 array_ptr += len;
 120                 sb_array_offset += len;
 121                 cur_offset += len;
 122
 123                 item++;
 124         }
 125
 126         free(buf);
 127 out:
 128         return;
 129
 130 out_short_read:
 131         printk("ERROR: sys_array too short to read %u bytes at offset %u\n",
 132                         len, cur_offset);
 133         free(buf);
 134 }
 135
 136 static int empty_backup(struct btrfs_root_backup *backup)
 137 {
 138         if (backup == NULL ||
 139                 (backup->tree_root == 0 &&
 140                  backup->tree_root_gen == 0))
 141                 return 1;
 142         return 0;
 143 }
 144
 145 static void print_root_backup(struct btrfs_root_backup *backup)
 146 {
 147         printf("\t\tbackup_tree_root:\t%llu\tgen: %llu\tlevel: %d\n",
 148                         btrfs_backup_tree_root(backup),
 149                         btrfs_backup_tree_root_gen(backup),
 150                         btrfs_backup_tree_root_level(backup));
 151         printf("\t\tbackup_chunk_root:\t%llu\tgen: %llu\tlevel: %d\n",
 152                         btrfs_backup_chunk_root(backup),
 153                         btrfs_backup_chunk_root_gen(backup),
 154                         btrfs_backup_chunk_root_level(backup));
 155         printf("\t\tbackup_extent_root:\t%llu\tgen: %llu\tlevel: %d\n",
 156                         btrfs_backup_extent_root(backup),
 157                         btrfs_backup_extent_root_gen(backup),
 158                         btrfs_backup_extent_root_level(backup));
 159         printf("\t\tbackup_fs_root:\t\t%llu\tgen: %llu\tlevel: %d\n",
 160                         btrfs_backup_fs_root(backup),
 161                         btrfs_backup_fs_root_gen(backup),
 162                         btrfs_backup_fs_root_level(backup));
 163         printf("\t\tbackup_dev_root:\t%llu\tgen: %llu\tlevel: %d\n",
 164                         btrfs_backup_dev_root(backup),
 165                         btrfs_backup_dev_root_gen(backup),
 166                         btrfs_backup_dev_root_level(backup));
 167         printf("\t\tbackup_csum_root:\t%llu\tgen: %llu\tlevel: %d\n",
 168                         btrfs_backup_csum_root(backup),
 169                         btrfs_backup_csum_root_gen(backup),
 170                         btrfs_backup_csum_root_level(backup));
 171
 172         printf("\t\tbackup_total_bytes:\t%llu\n",
 173                                         btrfs_backup_total_bytes(backup));
 174         printf("\t\tbackup_bytes_used:\t%llu\n",
 175                                         btrfs_backup_bytes_used(backup));
 176         printf("\t\tbackup_num_devices:\t%llu\n",
 177                                         btrfs_backup_num_devices(backup));
 178         putchar('\n');
 179 }
 180
 181 static void print_backup_roots(struct btrfs_super_block *sb)
 182 {
 183         struct btrfs_root_backup *backup;
 184         int i;
 185
 186         for (i = 0; i < BTRFS_NUM_BACKUP_ROOTS; i++) {
 187                 backup = sb->super_roots + i;
 188                 if (!empty_backup(backup)) {
 189                         printf("\tbackup %d:\n", i);
 190                         print_root_backup(backup);
 191                 }
 192         }
 193 }
 194
 195 struct readable_flag_entry {
 196         u64 bit;
 197         char *output;
 198 };
 199
 200 #define DEF_INCOMPAT_FLAG_ENTRY(bit_name)               \
 201         {BTRFS_FEATURE_INCOMPAT_##bit_name, #bit_name}
 202
 203 static struct readable_flag_entry incompat_flags_array[] = {
 204         DEF_INCOMPAT_FLAG_ENTRY(MIXED_BACKREF),
 205         DEF_INCOMPAT_FLAG_ENTRY(DEFAULT_SUBVOL),
 206         DEF_INCOMPAT_FLAG_ENTRY(MIXED_GROUPS),
 207         DEF_INCOMPAT_FLAG_ENTRY(COMPRESS_LZO),
 208         DEF_INCOMPAT_FLAG_ENTRY(COMPRESS_LZOv2),
 209         DEF_INCOMPAT_FLAG_ENTRY(BIG_METADATA),
 210         DEF_INCOMPAT_FLAG_ENTRY(EXTENDED_IREF),
 211         DEF_INCOMPAT_FLAG_ENTRY(RAID56),
 212         DEF_INCOMPAT_FLAG_ENTRY(SKINNY_METADATA),
 213         DEF_INCOMPAT_FLAG_ENTRY(NO_HOLES)
 214 };
 215 static const int incompat_flags_num = sizeof(incompat_flags_array) /
 216                                       sizeof(struct readable_flag_entry);
 217
 218 #define DEF_HEADER_FLAG_ENTRY(bit_name)                 \
 219         {BTRFS_HEADER_FLAG_##bit_name, #bit_name}
 220 #define DEF_SUPER_FLAG_ENTRY(bit_name)                  \
 221         {BTRFS_SUPER_FLAG_##bit_name, #bit_name}
 222
 223 static struct readable_flag_entry super_flags_array[] = {
 224         DEF_HEADER_FLAG_ENTRY(WRITTEN),
 225         DEF_HEADER_FLAG_ENTRY(RELOC),
 226         DEF_SUPER_FLAG_ENTRY(CHANGING_FSID),
 227         DEF_SUPER_FLAG_ENTRY(SEEDING),
 228         DEF_SUPER_FLAG_ENTRY(METADUMP),
 229         DEF_SUPER_FLAG_ENTRY(METADUMP_V2)
 230 };
 231 static const int super_flags_num = ARRAY_SIZE(super_flags_array);
 232
 233 #define BTRFS_SUPER_FLAG_SUPP   (BTRFS_HEADER_FLAG_WRITTEN |\
 234                                  BTRFS_HEADER_FLAG_RELOC |\
 235                                  BTRFS_SUPER_FLAG_CHANGING_FSID |\
 236                                  BTRFS_SUPER_FLAG_SEEDING |\
 237                                  BTRFS_SUPER_FLAG_METADUMP |\
 238                                  BTRFS_SUPER_FLAG_METADUMP_V2)
 239
 240 static void __print_readable_flag(u64 flag, struct readable_flag_entry *array,
 241                                   int array_size, u64 supported_flags)
 242 {
 243         int i;
 244         int first = 1;
 245         struct readable_flag_entry *entry;
 246
 247         if (!flag)
 248                 return;
 249
 250         printf("\t\t\t( ");
 251         for (i = 0; i < array_size; i++) {
 252                 entry = array + i;
 253                 if (flag & entry->bit) {
 254                         if (first)
 255                                 printf("%s ", entry->output);
 256                         else
 257                                 printf("|\n\t\t\t  %s ", entry->output);
 258                         first = 0;
 259                 }
 260         }
 261         flag &= ~supported_flags;
 262         if (flag) {
 263                 if (first)
 264                         printf("unknown flag: 0x%llx ", flag);
 265                 else
 266                         printf("|\n\t\t\t  unknown flag: 0x%llx ", flag);
 267         }
 268         printf(")\n");
 269 }
 270
 271 static void print_readable_incompat_flag(u64 flag)
 272 {
 273         return __print_readable_flag(flag, incompat_flags_array,
 274                                      incompat_flags_num,
 275                                      BTRFS_FEATURE_INCOMPAT_SUPP);
 276 }
 277
 278 static void print_readable_super_flag(u64 flag)
 279 {
 280         return __print_readable_flag(flag, super_flags_array,
 281                                      super_flags_num, BTRFS_SUPER_FLAG_SUPP);
 282 }
 283
 284 static void dump_superblock(struct btrfs_super_block *sb, int full)
 285 {
 286         int i;
 287         char *s, buf[BTRFS_UUID_UNPARSED_SIZE];
 288         u8 *p;
 289
 290         printf("csum\t\t\t0x");
 291         for (i = 0, p = sb->csum; i < btrfs_super_csum_size(sb); i++)
 292                 printf("%02x", p[i]);
 293         if (check_csum_sblock(sb, btrfs_super_csum_size(sb)))
 294                 printf(" [match]");
 295         else
 296                 printf(" [DON'T MATCH]");
 297         putchar('\n');
 298
 299         printf("bytenr\t\t\t%llu\n",
 300                 (unsigned long long)btrfs_super_bytenr(sb));
 301         printf("flags\t\t\t0x%llx\n",
 302                 (unsigned long long)btrfs_super_flags(sb));
 303         print_readable_super_flag(btrfs_super_flags(sb));
 304
 305         printf("magic\t\t\t");
 306         s = (char *) &sb->magic;
 307         for (i = 0; i < 8; i++)
 308                 putchar(isprint(s[i]) ? s[i] : '.');
 309         if (btrfs_super_magic(sb) == BTRFS_MAGIC)
 310                 printf(" [match]\n");
 311         else
 312                 printf(" [DON'T MATCH]\n");
 313
 314         uuid_unparse(sb->fsid, buf);
 315         printf("fsid\t\t\t%s\n", buf);
 316
 317         printf("label\t\t\t");
 318         s = sb->label;
 319         for (i = 0; i < BTRFS_LABEL_SIZE && s[i]; i++)
 320                 putchar(isprint(s[i]) ? s[i] : '.');
 321         putchar('\n');
 322
 323         printf("generation\t\t%llu\n",
 324                (unsigned long long)btrfs_super_generation(sb));
 325         printf("root\t\t\t%llu\n", (unsigned long long)btrfs_super_root(sb));
 326         printf("sys_array_size\t\t%llu\n",
 327                (unsigned long long)btrfs_super_sys_array_size(sb));
 328         printf("chunk_root_generation\t%llu\n",
 329                (unsigned long long)btrfs_super_chunk_root_generation(sb));
 330         printf("root_level\t\t%llu\n",
 331                (unsigned long long)btrfs_super_root_level(sb));
 332         printf("chunk_root\t\t%llu\n",
 333                (unsigned long long)btrfs_super_chunk_root(sb));
 334         printf("chunk_root_level\t%llu\n",
 335                (unsigned long long)btrfs_super_chunk_root_level(sb));
 336         printf("log_root\t\t%llu\n",
 337                (unsigned long long)btrfs_super_log_root(sb));
 338         printf("log_root_transid\t%llu\n",
 339                (unsigned long long)btrfs_super_log_root_transid(sb));
 340         printf("log_root_level\t\t%llu\n",
 341                (unsigned long long)btrfs_super_log_root_level(sb));
 342         printf("total_bytes\t\t%llu\n",
 343                (unsigned long long)btrfs_super_total_bytes(sb));
 344         printf("bytes_used\t\t%llu\n",
 345                (unsigned long long)btrfs_super_bytes_used(sb));
 346         printf("sectorsize\t\t%llu\n",
 347                (unsigned long long)btrfs_super_sectorsize(sb));
 348         printf("nodesize\t\t%llu\n",
 349                (unsigned long long)btrfs_super_nodesize(sb));
 350         printf("leafsize\t\t%llu\n",
 351                (unsigned long long)btrfs_super_leafsize(sb));
 352         printf("stripesize\t\t%llu\n",
 353                (unsigned long long)btrfs_super_stripesize(sb));
 354         printf("root_dir\t\t%llu\n",
 355                (unsigned long long)btrfs_super_root_dir(sb));
 356         printf("num_devices\t\t%llu\n",
 357                (unsigned long long)btrfs_super_num_devices(sb));
 358         printf("compat_flags\t\t0x%llx\n",
 359                (unsigned long long)btrfs_super_compat_flags(sb));
 360         printf("compat_ro_flags\t\t0x%llx\n",
 361                (unsigned long long)btrfs_super_compat_ro_flags(sb));
 362         printf("incompat_flags\t\t0x%llx\n",
 363                (unsigned long long)btrfs_super_incompat_flags(sb));
 364         print_readable_incompat_flag(btrfs_super_incompat_flags(sb));
 365         printf("csum_type\t\t%llu\n",
 366                (unsigned long long)btrfs_super_csum_type(sb));
 367         printf("csum_size\t\t%llu\n",
 368                (unsigned long long)btrfs_super_csum_size(sb));
 369         printf("cache_generation\t%llu\n",
 370                (unsigned long long)btrfs_super_cache_generation(sb));
 371         printf("uuid_tree_generation\t%llu\n",
 372                (unsigned long long)btrfs_super_uuid_tree_generation(sb));
 373
 374         uuid_unparse(sb->dev_item.uuid, buf);
 375         printf("dev_item.uuid\t\t%s\n", buf);
 376
 377         uuid_unparse(sb->dev_item.fsid, buf);
 378         printf("dev_item.fsid\t\t%s %s\n", buf,
 379                 !memcmp(sb->dev_item.fsid, sb->fsid, BTRFS_FSID_SIZE) ?
 380                         "[match]" : "[DON'T MATCH]");
 381
 382         printf("dev_item.type\t\t%llu\n", (unsigned long long)
 383                btrfs_stack_device_type(&sb->dev_item));
 384         printf("dev_item.total_bytes\t%llu\n", (unsigned long long)
 385                btrfs_stack_device_total_bytes(&sb->dev_item));
 386         printf("dev_item.bytes_used\t%llu\n", (unsigned long long)
 387                btrfs_stack_device_bytes_used(&sb->dev_item));
 388         printf("dev_item.io_align\t%u\n", (unsigned int)
 389                btrfs_stack_device_io_align(&sb->dev_item));
 390         printf("dev_item.io_width\t%u\n", (unsigned int)
 391                btrfs_stack_device_io_width(&sb->dev_item));
 392         printf("dev_item.sector_size\t%u\n", (unsigned int)
 393                btrfs_stack_device_sector_size(&sb->dev_item));
 394         printf("dev_item.devid\t\t%llu\n",
 395                btrfs_stack_device_id(&sb->dev_item));
 396         printf("dev_item.dev_group\t%u\n", (unsigned int)
 397                btrfs_stack_device_group(&sb->dev_item));
 398         printf("dev_item.seek_speed\t%u\n", (unsigned int)
 399                btrfs_stack_device_seek_speed(&sb->dev_item));
 400         printf("dev_item.bandwidth\t%u\n", (unsigned int)
 401                btrfs_stack_device_bandwidth(&sb->dev_item));
 402         printf("dev_item.generation\t%llu\n", (unsigned long long)
 403                btrfs_stack_device_generation(&sb->dev_item));
 404         if (full) {
 405                 printf("sys_chunk_array[%d]:\n", BTRFS_SYSTEM_CHUNK_ARRAY_SIZE);
 406                 print_sys_chunk_array(sb);
 407                 printf("backup_roots[%d]:\n", BTRFS_NUM_BACKUP_ROOTS);
 408                 print_backup_roots(sb);
 409         }
 410 }
 411
 412 static int load_and_dump_sb(char *filename, int fd, u64 sb_bytenr, int full,
 413                 int force)
 414 {
 415         u8 super_block_data[BTRFS_SUPER_INFO_SIZE];
 416         struct btrfs_super_block *sb;
 417         u64 ret;
 418
 419         sb = (struct btrfs_super_block *)super_block_data;
 420
 421         ret = pread64(fd, super_block_data, BTRFS_SUPER_INFO_SIZE, sb_bytenr);
 422         if (ret != BTRFS_SUPER_INFO_SIZE) {
 423                 /* check if the disk if too short for further superblock */
 424                 if (ret == 0 && errno == 0)
 425                         return 0;
 426
 427                 fprintf(stderr,
 428                    "ERROR: Failed to read the superblock on %s at %llu\n",
 429                    filename, (unsigned long long)sb_bytenr);
 430                 fprintf(stderr,
 431                    "ERROR: error = '%s', errno = %d\n", strerror(errno), errno);
 432                 return 1;
 433         }
 434         printf("superblock: bytenr=%llu, device=%s\n", sb_bytenr, filename);
 435         printf("---------------------------------------------------------\n");
 436         if (btrfs_super_magic(sb) != BTRFS_MAGIC && !force) {
 437                 fprintf(stderr,
 438                     "ERROR: bad magic on superblock on %s at %llu\n",
 439                     filename, (unsigned long long)sb_bytenr);
 440         } else {
 441                 dump_superblock(sb, full);
 442         }
 443         return 0;
 444 }
 445
 446 const char * const cmd_inspect_dump_super_usage[] = {
 447         "btrfs inspect-internal dump-super [options] device [device...]",
 448         "Dump superblock from a device",
 449         "-f                  print full superblock information",
 450         "-a                  print information of all superblocks",
 451         "-i <super_mirror>   specify which mirror to print out",
 452         "-F                  attempt to dump superblocks with bad magic",
 453         "-s <bytenr>         specify alternate superblock offset",
 454         NULL
 455 };
 456
 457 int cmd_inspect_dump_super(int argc, char **argv)
 458 {
 459         int opt;
 460         int all = 0;
 461         int full = 0;
 462         int force = 0;
 463         char *filename;
 464         int fd = -1;
 465         int i;
 466         int ret = 0;
 467         u64 arg;
 468         u64 sb_bytenr = btrfs_sb_offset(0);
 469
 470         while ((opt = getopt(argc, argv, "fFai:s:")) != -1) {
 471                 switch (opt) {
 472                 case 'i':
 473                         arg = arg_strtou64(optarg);
 474                         if (arg >= BTRFS_SUPER_MIRROR_MAX) {
 475                                 fprintf(stderr,
 476                                         "Illegal super_mirror %llu\n",
 477                                         arg);
 478                                 usage(cmd_inspect_dump_super_usage);
 479                         }
 480                         sb_bytenr = btrfs_sb_offset(arg);
 481                         break;
 482
 483                 case 'a':
 484                         all = 1;
 485                         break;
 486                 case 'f':
 487                         full = 1;
 488                         break;
 489                 case 'F':
 490                         force = 1;
 491                         break;
 492                 case 's':
 493                         sb_bytenr = arg_strtou64(optarg);
 494                         all = 0;
 495                         break;
 496                 default:
 497                         usage(cmd_inspect_dump_super_usage);
 498                 }
 499         }
 500
 501         if (check_argc_min(argc - optind, 1))
 502                 usage(cmd_inspect_dump_super_usage);
 503
 504         for (i = optind; i < argc; i++) {
 505                 filename = argv[i];
 506                 fd = open(filename, O_RDONLY, 0666);
 507                 if (fd < 0) {
 508                         fprintf(stderr, "Could not open %s\n", filename);
 509                         ret = 1;
 510                         goto out;
 511                 }
 512
 513                 if (all) {
 514                         int idx;
 515
 516                         for (idx = 0; idx < BTRFS_SUPER_MIRROR_MAX; idx++) {
 517                                 sb_bytenr = btrfs_sb_offset(idx);
 518                                 if (load_and_dump_sb(filename, fd,
 519                                                 sb_bytenr, full, force)) {
 520                                         close(fd);
 521                                         ret = 1;
 522                                         goto out;
 523                                 }
 524
 525                                 putchar('\n');
 526                         }
 527                 } else {
 528                         load_and_dump_sb(filename, fd, sb_bytenr, full, force);
 529                         putchar('\n');
 530                 }
 531                 close(fd);
 532         }
 533
 534 out:
 535         return ret;
 536 }