2 * Copyright (C) 2012 STRATO AG. 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.
25 #include <uuid/uuid.h>
28 #include "kerncompat.h"
31 #include "print-tree.h"
32 #include "transaction.h"
37 static void print_usage(void);
38 static void dump_superblock(struct btrfs_super_block *sb, int full);
39 int main(int argc, char **argv);
40 static int load_and_dump_sb(char *, int fd, u64 sb_bytenr, int full, int force);
43 static void print_usage(void)
46 "usage: btrfs-show-super [-i super_mirror|-a|-f|-F] dev [dev..]\n");
47 fprintf(stderr, "\t-f : print full superblock information\n");
48 fprintf(stderr, "\t-a : print information of all superblocks\n");
49 fprintf(stderr, "\t-i <super_mirror> : specify which mirror to print out\n");
50 fprintf(stderr, "\t-F : attempt to dump superblocks with bad magic\n");
51 fprintf(stderr, "\t-s <bytenr> : specify alternate superblock offset\n");
52 fprintf(stderr, "%s\n", PACKAGE_STRING);
55 int main(int argc, char **argv)
65 u64 sb_bytenr = btrfs_sb_offset(0);
67 while ((opt = getopt(argc, argv, "fFai:s:")) != -1) {
70 arg = arg_strtou64(optarg);
71 if (arg >= BTRFS_SUPER_MIRROR_MAX) {
73 "Illegal super_mirror %llu\n",
78 sb_bytenr = btrfs_sb_offset(arg);
91 sb_bytenr = arg_strtou64(optarg);
101 if (check_argc_min(argc - optind, 1)) {
106 for (i = optind; i < argc; i++) {
108 fd = open(filename, O_RDONLY, 0666);
110 fprintf(stderr, "Could not open %s\n", filename);
116 for (idx = 0; idx < BTRFS_SUPER_MIRROR_MAX; idx++) {
117 sb_bytenr = btrfs_sb_offset(idx);
118 if (load_and_dump_sb(filename, fd,
119 sb_bytenr, full, force)) {
127 load_and_dump_sb(filename, fd, sb_bytenr, full, force);
136 static int load_and_dump_sb(char *filename, int fd, u64 sb_bytenr, int full,
139 u8 super_block_data[BTRFS_SUPER_INFO_SIZE];
140 struct btrfs_super_block *sb;
143 sb = (struct btrfs_super_block *)super_block_data;
145 ret = pread64(fd, super_block_data, BTRFS_SUPER_INFO_SIZE, sb_bytenr);
146 if (ret != BTRFS_SUPER_INFO_SIZE) {
147 /* check if the disk if too short for further superblock */
148 if (ret == 0 && errno == 0)
152 "ERROR: Failed to read the superblock on %s at %llu\n",
153 filename, (unsigned long long)sb_bytenr);
155 "ERROR: error = '%s', errno = %d\n", strerror(errno), errno);
158 printf("superblock: bytenr=%llu, device=%s\n", sb_bytenr, filename);
159 printf("---------------------------------------------------------\n");
160 if (btrfs_super_magic(sb) != BTRFS_MAGIC && !force) {
162 "ERROR: bad magic on superblock on %s at %llu\n",
163 filename, (unsigned long long)sb_bytenr);
165 dump_superblock(sb, full);
170 static int check_csum_sblock(void *sb, int csum_size)
172 char result[BTRFS_CSUM_SIZE];
175 crc = btrfs_csum_data(NULL, (char *)sb + BTRFS_CSUM_SIZE,
176 crc, BTRFS_SUPER_INFO_SIZE - BTRFS_CSUM_SIZE);
177 btrfs_csum_final(crc, result);
179 return !memcmp(sb, &result, csum_size);
182 static void print_sys_chunk_array(struct btrfs_super_block *sb)
184 struct extent_buffer *buf;
185 struct btrfs_disk_key *disk_key;
186 struct btrfs_chunk *chunk;
188 unsigned long sb_array_offset;
193 struct btrfs_key key;
196 buf = malloc(sizeof(*buf) + sizeof(*sb));
198 fprintf(stderr, "%s\n", strerror(ENOMEM));
201 write_extent_buffer(buf, sb, 0, sizeof(*sb));
202 array_size = btrfs_super_sys_array_size(sb);
204 array_ptr = sb->sys_chunk_array;
205 sb_array_offset = offsetof(struct btrfs_super_block, sys_chunk_array);
209 while (cur_offset < array_size) {
210 disk_key = (struct btrfs_disk_key *)array_ptr;
211 len = sizeof(*disk_key);
212 if (cur_offset + len > array_size)
215 btrfs_disk_key_to_cpu(&key, disk_key);
218 sb_array_offset += len;
221 printf("\titem %d ", item);
222 btrfs_print_key(disk_key);
225 if (key.type == BTRFS_CHUNK_ITEM_KEY) {
226 chunk = (struct btrfs_chunk *)sb_array_offset;
228 * At least one btrfs_chunk with one stripe must be
229 * present, exact stripe count check comes afterwards
231 len = btrfs_chunk_item_size(1);
232 if (cur_offset + len > array_size)
235 print_chunk(buf, chunk);
236 num_stripes = btrfs_chunk_num_stripes(buf, chunk);
239 "ERROR: invalid number of stripes %u in sys_array at offset %u\n",
240 num_stripes, cur_offset);
243 len = btrfs_chunk_item_size(num_stripes);
244 if (cur_offset + len > array_size)
248 "ERROR: unexpected item type %u in sys_array at offset %u\n",
249 (u32)key.type, cur_offset);
253 sb_array_offset += len;
263 printk("ERROR: sys_array too short to read %u bytes at offset %u\n",
268 static int empty_backup(struct btrfs_root_backup *backup)
270 if (backup == NULL ||
271 (backup->tree_root == 0 &&
272 backup->tree_root_gen == 0))
277 static void print_root_backup(struct btrfs_root_backup *backup)
279 printf("\t\tbackup_tree_root:\t%llu\tgen: %llu\tlevel: %d\n",
280 btrfs_backup_tree_root(backup),
281 btrfs_backup_tree_root_gen(backup),
282 btrfs_backup_tree_root_level(backup));
283 printf("\t\tbackup_chunk_root:\t%llu\tgen: %llu\tlevel: %d\n",
284 btrfs_backup_chunk_root(backup),
285 btrfs_backup_chunk_root_gen(backup),
286 btrfs_backup_chunk_root_level(backup));
287 printf("\t\tbackup_extent_root:\t%llu\tgen: %llu\tlevel: %d\n",
288 btrfs_backup_extent_root(backup),
289 btrfs_backup_extent_root_gen(backup),
290 btrfs_backup_extent_root_level(backup));
291 printf("\t\tbackup_fs_root:\t\t%llu\tgen: %llu\tlevel: %d\n",
292 btrfs_backup_fs_root(backup),
293 btrfs_backup_fs_root_gen(backup),
294 btrfs_backup_fs_root_level(backup));
295 printf("\t\tbackup_dev_root:\t%llu\tgen: %llu\tlevel: %d\n",
296 btrfs_backup_dev_root(backup),
297 btrfs_backup_dev_root_gen(backup),
298 btrfs_backup_dev_root_level(backup));
299 printf("\t\tbackup_csum_root:\t%llu\tgen: %llu\tlevel: %d\n",
300 btrfs_backup_csum_root(backup),
301 btrfs_backup_csum_root_gen(backup),
302 btrfs_backup_csum_root_level(backup));
304 printf("\t\tbackup_total_bytes:\t%llu\n",
305 btrfs_backup_total_bytes(backup));
306 printf("\t\tbackup_bytes_used:\t%llu\n",
307 btrfs_backup_bytes_used(backup));
308 printf("\t\tbackup_num_devices:\t%llu\n",
309 btrfs_backup_num_devices(backup));
313 static void print_backup_roots(struct btrfs_super_block *sb)
315 struct btrfs_root_backup *backup;
318 for (i = 0; i < BTRFS_NUM_BACKUP_ROOTS; i++) {
319 backup = sb->super_roots + i;
320 if (!empty_backup(backup)) {
321 printf("\tbackup %d:\n", i);
322 print_root_backup(backup);
327 struct readable_flag_entry {
332 #define DEF_INCOMPAT_FLAG_ENTRY(bit_name) \
333 {BTRFS_FEATURE_INCOMPAT_##bit_name, #bit_name}
335 static struct readable_flag_entry incompat_flags_array[] = {
336 DEF_INCOMPAT_FLAG_ENTRY(MIXED_BACKREF),
337 DEF_INCOMPAT_FLAG_ENTRY(DEFAULT_SUBVOL),
338 DEF_INCOMPAT_FLAG_ENTRY(MIXED_GROUPS),
339 DEF_INCOMPAT_FLAG_ENTRY(COMPRESS_LZO),
340 DEF_INCOMPAT_FLAG_ENTRY(COMPRESS_LZOv2),
341 DEF_INCOMPAT_FLAG_ENTRY(BIG_METADATA),
342 DEF_INCOMPAT_FLAG_ENTRY(EXTENDED_IREF),
343 DEF_INCOMPAT_FLAG_ENTRY(RAID56),
344 DEF_INCOMPAT_FLAG_ENTRY(SKINNY_METADATA),
345 DEF_INCOMPAT_FLAG_ENTRY(NO_HOLES)
347 static const int incompat_flags_num = sizeof(incompat_flags_array) /
348 sizeof(struct readable_flag_entry);
350 #define DEF_HEADER_FLAG_ENTRY(bit_name) \
351 {BTRFS_HEADER_FLAG_##bit_name, #bit_name}
352 #define DEF_SUPER_FLAG_ENTRY(bit_name) \
353 {BTRFS_SUPER_FLAG_##bit_name, #bit_name}
355 static struct readable_flag_entry super_flags_array[] = {
356 DEF_HEADER_FLAG_ENTRY(WRITTEN),
357 DEF_HEADER_FLAG_ENTRY(RELOC),
358 DEF_SUPER_FLAG_ENTRY(CHANGING_FSID),
359 DEF_SUPER_FLAG_ENTRY(SEEDING),
360 DEF_SUPER_FLAG_ENTRY(METADUMP),
361 DEF_SUPER_FLAG_ENTRY(METADUMP_V2)
363 static const int super_flags_num = ARRAY_SIZE(super_flags_array);
365 #define BTRFS_SUPER_FLAG_SUPP (BTRFS_HEADER_FLAG_WRITTEN |\
366 BTRFS_HEADER_FLAG_RELOC |\
367 BTRFS_SUPER_FLAG_CHANGING_FSID |\
368 BTRFS_SUPER_FLAG_SEEDING |\
369 BTRFS_SUPER_FLAG_METADUMP |\
370 BTRFS_SUPER_FLAG_METADUMP_V2)
372 static void __print_readable_flag(u64 flag, struct readable_flag_entry *array,
373 int array_size, u64 supported_flags)
377 struct readable_flag_entry *entry;
383 for (i = 0; i < array_size; i++) {
385 if (flag & entry->bit) {
387 printf("%s ", entry->output);
389 printf("|\n\t\t\t %s ", entry->output);
393 flag &= ~supported_flags;
396 printf("unknown flag: 0x%llx ", flag);
398 printf("|\n\t\t\t unknown flag: 0x%llx ", flag);
403 static void print_readable_incompat_flag(u64 flag)
405 return __print_readable_flag(flag, incompat_flags_array,
407 BTRFS_FEATURE_INCOMPAT_SUPP);
410 static void print_readable_super_flag(u64 flag)
412 return __print_readable_flag(flag, super_flags_array,
413 super_flags_num, BTRFS_SUPER_FLAG_SUPP);
416 static void dump_superblock(struct btrfs_super_block *sb, int full)
419 char *s, buf[BTRFS_UUID_UNPARSED_SIZE];
422 printf("csum\t\t\t0x");
423 for (i = 0, p = sb->csum; i < btrfs_super_csum_size(sb); i++)
424 printf("%02x", p[i]);
425 if (check_csum_sblock(sb, btrfs_super_csum_size(sb)))
428 printf(" [DON'T MATCH]");
431 printf("bytenr\t\t\t%llu\n",
432 (unsigned long long)btrfs_super_bytenr(sb));
433 printf("flags\t\t\t0x%llx\n",
434 (unsigned long long)btrfs_super_flags(sb));
435 print_readable_super_flag(btrfs_super_flags(sb));
437 printf("magic\t\t\t");
438 s = (char *) &sb->magic;
439 for (i = 0; i < 8; i++)
440 putchar(isprint(s[i]) ? s[i] : '.');
441 if (btrfs_super_magic(sb) == BTRFS_MAGIC)
442 printf(" [match]\n");
444 printf(" [DON'T MATCH]\n");
446 uuid_unparse(sb->fsid, buf);
447 printf("fsid\t\t\t%s\n", buf);
449 printf("label\t\t\t");
451 for (i = 0; i < BTRFS_LABEL_SIZE && s[i]; i++)
452 putchar(isprint(s[i]) ? s[i] : '.');
455 printf("generation\t\t%llu\n",
456 (unsigned long long)btrfs_super_generation(sb));
457 printf("root\t\t\t%llu\n", (unsigned long long)btrfs_super_root(sb));
458 printf("sys_array_size\t\t%llu\n",
459 (unsigned long long)btrfs_super_sys_array_size(sb));
460 printf("chunk_root_generation\t%llu\n",
461 (unsigned long long)btrfs_super_chunk_root_generation(sb));
462 printf("root_level\t\t%llu\n",
463 (unsigned long long)btrfs_super_root_level(sb));
464 printf("chunk_root\t\t%llu\n",
465 (unsigned long long)btrfs_super_chunk_root(sb));
466 printf("chunk_root_level\t%llu\n",
467 (unsigned long long)btrfs_super_chunk_root_level(sb));
468 printf("log_root\t\t%llu\n",
469 (unsigned long long)btrfs_super_log_root(sb));
470 printf("log_root_transid\t%llu\n",
471 (unsigned long long)btrfs_super_log_root_transid(sb));
472 printf("log_root_level\t\t%llu\n",
473 (unsigned long long)btrfs_super_log_root_level(sb));
474 printf("total_bytes\t\t%llu\n",
475 (unsigned long long)btrfs_super_total_bytes(sb));
476 printf("bytes_used\t\t%llu\n",
477 (unsigned long long)btrfs_super_bytes_used(sb));
478 printf("sectorsize\t\t%llu\n",
479 (unsigned long long)btrfs_super_sectorsize(sb));
480 printf("nodesize\t\t%llu\n",
481 (unsigned long long)btrfs_super_nodesize(sb));
482 printf("leafsize\t\t%llu\n",
483 (unsigned long long)btrfs_super_leafsize(sb));
484 printf("stripesize\t\t%llu\n",
485 (unsigned long long)btrfs_super_stripesize(sb));
486 printf("root_dir\t\t%llu\n",
487 (unsigned long long)btrfs_super_root_dir(sb));
488 printf("num_devices\t\t%llu\n",
489 (unsigned long long)btrfs_super_num_devices(sb));
490 printf("compat_flags\t\t0x%llx\n",
491 (unsigned long long)btrfs_super_compat_flags(sb));
492 printf("compat_ro_flags\t\t0x%llx\n",
493 (unsigned long long)btrfs_super_compat_ro_flags(sb));
494 printf("incompat_flags\t\t0x%llx\n",
495 (unsigned long long)btrfs_super_incompat_flags(sb));
496 print_readable_incompat_flag(btrfs_super_incompat_flags(sb));
497 printf("csum_type\t\t%llu\n",
498 (unsigned long long)btrfs_super_csum_type(sb));
499 printf("csum_size\t\t%llu\n",
500 (unsigned long long)btrfs_super_csum_size(sb));
501 printf("cache_generation\t%llu\n",
502 (unsigned long long)btrfs_super_cache_generation(sb));
503 printf("uuid_tree_generation\t%llu\n",
504 (unsigned long long)btrfs_super_uuid_tree_generation(sb));
506 uuid_unparse(sb->dev_item.uuid, buf);
507 printf("dev_item.uuid\t\t%s\n", buf);
509 uuid_unparse(sb->dev_item.fsid, buf);
510 printf("dev_item.fsid\t\t%s %s\n", buf,
511 !memcmp(sb->dev_item.fsid, sb->fsid, BTRFS_FSID_SIZE) ?
512 "[match]" : "[DON'T MATCH]");
514 printf("dev_item.type\t\t%llu\n", (unsigned long long)
515 btrfs_stack_device_type(&sb->dev_item));
516 printf("dev_item.total_bytes\t%llu\n", (unsigned long long)
517 btrfs_stack_device_total_bytes(&sb->dev_item));
518 printf("dev_item.bytes_used\t%llu\n", (unsigned long long)
519 btrfs_stack_device_bytes_used(&sb->dev_item));
520 printf("dev_item.io_align\t%u\n", (unsigned int)
521 btrfs_stack_device_io_align(&sb->dev_item));
522 printf("dev_item.io_width\t%u\n", (unsigned int)
523 btrfs_stack_device_io_width(&sb->dev_item));
524 printf("dev_item.sector_size\t%u\n", (unsigned int)
525 btrfs_stack_device_sector_size(&sb->dev_item));
526 printf("dev_item.devid\t\t%llu\n",
527 btrfs_stack_device_id(&sb->dev_item));
528 printf("dev_item.dev_group\t%u\n", (unsigned int)
529 btrfs_stack_device_group(&sb->dev_item));
530 printf("dev_item.seek_speed\t%u\n", (unsigned int)
531 btrfs_stack_device_seek_speed(&sb->dev_item));
532 printf("dev_item.bandwidth\t%u\n", (unsigned int)
533 btrfs_stack_device_bandwidth(&sb->dev_item));
534 printf("dev_item.generation\t%llu\n", (unsigned long long)
535 btrfs_stack_device_generation(&sb->dev_item));
537 printf("sys_chunk_array[%d]:\n", BTRFS_SYSTEM_CHUNK_ARRAY_SIZE);
538 print_sys_chunk_array(sb);
539 printf("backup_roots[%d]:\n", BTRFS_NUM_BACKUP_ROOTS);
540 print_backup_roots(sb);