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.
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.
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.
17 #include "kerncompat.h"
24 #include <uuid/uuid.h>
30 #include "print-tree.h"
31 #include "transaction.h"
38 static int check_csum_sblock(void *sb, int csum_size)
40 u8 result[BTRFS_CSUM_SIZE];
43 crc = btrfs_csum_data((char *)sb + BTRFS_CSUM_SIZE,
44 crc, BTRFS_SUPER_INFO_SIZE - BTRFS_CSUM_SIZE);
45 btrfs_csum_final(crc, result);
47 return !memcmp(sb, &result, csum_size);
50 static void print_sys_chunk_array(struct btrfs_super_block *sb)
52 struct extent_buffer *buf;
53 struct btrfs_disk_key *disk_key;
54 struct btrfs_chunk *chunk;
56 unsigned long sb_array_offset;
64 buf = malloc(sizeof(*buf) + sizeof(*sb));
66 error("not enough memory");
69 write_extent_buffer(buf, sb, 0, sizeof(*sb));
70 buf->len = sizeof(*sb);
71 array_size = btrfs_super_sys_array_size(sb);
73 array_ptr = sb->sys_chunk_array;
74 sb_array_offset = offsetof(struct btrfs_super_block, sys_chunk_array);
76 if (array_size > BTRFS_SYSTEM_CHUNK_ARRAY_SIZE) {
77 error("sys_array_size %u shouldn't exceed %u bytes",
78 array_size, BTRFS_SYSTEM_CHUNK_ARRAY_SIZE);
85 while (cur_offset < array_size) {
86 disk_key = (struct btrfs_disk_key *)array_ptr;
87 len = sizeof(*disk_key);
88 if (cur_offset + len > array_size)
91 btrfs_disk_key_to_cpu(&key, disk_key);
94 sb_array_offset += len;
97 printf("\titem %d ", item);
98 btrfs_print_key(disk_key);
101 if (key.type == BTRFS_CHUNK_ITEM_KEY) {
102 chunk = (struct btrfs_chunk *)sb_array_offset;
104 * At least one btrfs_chunk with one stripe must be
105 * present, exact stripe count check comes afterwards
107 len = btrfs_chunk_item_size(1);
108 if (cur_offset + len > array_size)
111 num_stripes = btrfs_chunk_num_stripes(buf, chunk);
114 "invalid number of stripes %u in sys_array at offset %u",
115 num_stripes, cur_offset);
118 len = btrfs_chunk_item_size(num_stripes);
119 if (cur_offset + len > array_size)
121 print_chunk_item(buf, chunk);
123 error("unexpected item type %u in sys_array at offset %u",
124 (u32)key.type, cur_offset);
128 sb_array_offset += len;
139 error("sys_array too short to read %u bytes at offset %u",
144 static int empty_backup(struct btrfs_root_backup *backup)
146 if (backup == NULL ||
147 (backup->tree_root == 0 &&
148 backup->tree_root_gen == 0))
153 static void print_root_backup(struct btrfs_root_backup *backup)
155 printf("\t\tbackup_tree_root:\t%llu\tgen: %llu\tlevel: %d\n",
156 btrfs_backup_tree_root(backup),
157 btrfs_backup_tree_root_gen(backup),
158 btrfs_backup_tree_root_level(backup));
159 printf("\t\tbackup_chunk_root:\t%llu\tgen: %llu\tlevel: %d\n",
160 btrfs_backup_chunk_root(backup),
161 btrfs_backup_chunk_root_gen(backup),
162 btrfs_backup_chunk_root_level(backup));
163 printf("\t\tbackup_extent_root:\t%llu\tgen: %llu\tlevel: %d\n",
164 btrfs_backup_extent_root(backup),
165 btrfs_backup_extent_root_gen(backup),
166 btrfs_backup_extent_root_level(backup));
167 printf("\t\tbackup_fs_root:\t\t%llu\tgen: %llu\tlevel: %d\n",
168 btrfs_backup_fs_root(backup),
169 btrfs_backup_fs_root_gen(backup),
170 btrfs_backup_fs_root_level(backup));
171 printf("\t\tbackup_dev_root:\t%llu\tgen: %llu\tlevel: %d\n",
172 btrfs_backup_dev_root(backup),
173 btrfs_backup_dev_root_gen(backup),
174 btrfs_backup_dev_root_level(backup));
175 printf("\t\tbackup_csum_root:\t%llu\tgen: %llu\tlevel: %d\n",
176 btrfs_backup_csum_root(backup),
177 btrfs_backup_csum_root_gen(backup),
178 btrfs_backup_csum_root_level(backup));
180 printf("\t\tbackup_total_bytes:\t%llu\n",
181 btrfs_backup_total_bytes(backup));
182 printf("\t\tbackup_bytes_used:\t%llu\n",
183 btrfs_backup_bytes_used(backup));
184 printf("\t\tbackup_num_devices:\t%llu\n",
185 btrfs_backup_num_devices(backup));
189 static void print_backup_roots(struct btrfs_super_block *sb)
191 struct btrfs_root_backup *backup;
194 for (i = 0; i < BTRFS_NUM_BACKUP_ROOTS; i++) {
195 backup = sb->super_roots + i;
196 if (!empty_backup(backup)) {
197 printf("\tbackup %d:\n", i);
198 print_root_backup(backup);
203 struct readable_flag_entry {
208 #define DEF_COMPAT_RO_FLAG_ENTRY(bit_name) \
209 {BTRFS_FEATURE_COMPAT_RO_##bit_name, #bit_name}
211 static struct readable_flag_entry compat_ro_flags_array[] = {
212 DEF_COMPAT_RO_FLAG_ENTRY(FREE_SPACE_TREE),
213 DEF_COMPAT_RO_FLAG_ENTRY(FREE_SPACE_TREE_VALID),
215 static const int compat_ro_flags_num = sizeof(compat_ro_flags_array) /
216 sizeof(struct readable_flag_entry);
218 #define DEF_INCOMPAT_FLAG_ENTRY(bit_name) \
219 {BTRFS_FEATURE_INCOMPAT_##bit_name, #bit_name}
221 static struct readable_flag_entry incompat_flags_array[] = {
222 DEF_INCOMPAT_FLAG_ENTRY(MIXED_BACKREF),
223 DEF_INCOMPAT_FLAG_ENTRY(DEFAULT_SUBVOL),
224 DEF_INCOMPAT_FLAG_ENTRY(MIXED_GROUPS),
225 DEF_INCOMPAT_FLAG_ENTRY(COMPRESS_LZO),
226 DEF_INCOMPAT_FLAG_ENTRY(COMPRESS_ZSTD),
227 DEF_INCOMPAT_FLAG_ENTRY(BIG_METADATA),
228 DEF_INCOMPAT_FLAG_ENTRY(EXTENDED_IREF),
229 DEF_INCOMPAT_FLAG_ENTRY(RAID56),
230 DEF_INCOMPAT_FLAG_ENTRY(SKINNY_METADATA),
231 DEF_INCOMPAT_FLAG_ENTRY(NO_HOLES)
233 static const int incompat_flags_num = sizeof(incompat_flags_array) /
234 sizeof(struct readable_flag_entry);
236 #define DEF_HEADER_FLAG_ENTRY(bit_name) \
237 {BTRFS_HEADER_FLAG_##bit_name, #bit_name}
238 #define DEF_SUPER_FLAG_ENTRY(bit_name) \
239 {BTRFS_SUPER_FLAG_##bit_name, #bit_name}
241 static struct readable_flag_entry super_flags_array[] = {
242 DEF_HEADER_FLAG_ENTRY(WRITTEN),
243 DEF_HEADER_FLAG_ENTRY(RELOC),
244 DEF_SUPER_FLAG_ENTRY(CHANGING_FSID),
245 DEF_SUPER_FLAG_ENTRY(SEEDING),
246 DEF_SUPER_FLAG_ENTRY(METADUMP),
247 DEF_SUPER_FLAG_ENTRY(METADUMP_V2)
249 static const int super_flags_num = ARRAY_SIZE(super_flags_array);
251 #define BTRFS_SUPER_FLAG_SUPP (BTRFS_HEADER_FLAG_WRITTEN |\
252 BTRFS_HEADER_FLAG_RELOC |\
253 BTRFS_SUPER_FLAG_CHANGING_FSID |\
254 BTRFS_SUPER_FLAG_SEEDING |\
255 BTRFS_SUPER_FLAG_METADUMP |\
256 BTRFS_SUPER_FLAG_METADUMP_V2)
258 static void __print_readable_flag(u64 flag, struct readable_flag_entry *array,
259 int array_size, u64 supported_flags)
263 struct readable_flag_entry *entry;
269 for (i = 0; i < array_size; i++) {
271 if (flag & entry->bit) {
273 printf("%s ", entry->output);
275 printf("|\n\t\t\t %s ", entry->output);
279 flag &= ~supported_flags;
282 printf("unknown flag: 0x%llx ", flag);
284 printf("|\n\t\t\t unknown flag: 0x%llx ", flag);
289 static void print_readable_compat_ro_flag(u64 flag)
292 * We know about the FREE_SPACE_TREE{,_VALID} bits, but we don't
293 * actually support them yet.
295 return __print_readable_flag(flag, compat_ro_flags_array,
297 BTRFS_FEATURE_COMPAT_RO_SUPP |
298 BTRFS_FEATURE_COMPAT_RO_FREE_SPACE_TREE |
299 BTRFS_FEATURE_COMPAT_RO_FREE_SPACE_TREE_VALID);
302 static void print_readable_incompat_flag(u64 flag)
304 return __print_readable_flag(flag, incompat_flags_array,
306 BTRFS_FEATURE_INCOMPAT_SUPP);
309 static void print_readable_super_flag(u64 flag)
311 return __print_readable_flag(flag, super_flags_array,
312 super_flags_num, BTRFS_SUPER_FLAG_SUPP);
315 static void dump_superblock(struct btrfs_super_block *sb, int full)
318 char *s, buf[BTRFS_UUID_UNPARSED_SIZE];
323 csum_type = btrfs_super_csum_type(sb);
324 csum_size = BTRFS_CSUM_SIZE;
325 printf("csum_type\t\t%hu (", csum_type);
326 if (csum_type >= ARRAY_SIZE(btrfs_csum_sizes)) {
329 if (csum_type == BTRFS_CSUM_TYPE_CRC32) {
331 csum_size = btrfs_csum_sizes[csum_type];
337 printf("csum_size\t\t%llu\n", (unsigned long long)csum_size);
339 printf("csum\t\t\t0x");
340 for (i = 0, p = sb->csum; i < csum_size; i++)
341 printf("%02x", p[i]);
342 if (csum_type != BTRFS_CSUM_TYPE_CRC32 || csum_size != BTRFS_CRC32_SIZE)
343 printf(" [UNKNOWN CSUM TYPE OR SIZE]");
344 else if (check_csum_sblock(sb, csum_size))
347 printf(" [DON'T MATCH]");
350 printf("bytenr\t\t\t%llu\n",
351 (unsigned long long)btrfs_super_bytenr(sb));
352 printf("flags\t\t\t0x%llx\n",
353 (unsigned long long)btrfs_super_flags(sb));
354 print_readable_super_flag(btrfs_super_flags(sb));
356 printf("magic\t\t\t");
357 s = (char *) &sb->magic;
358 for (i = 0; i < 8; i++)
359 putchar(isprint(s[i]) ? s[i] : '.');
360 if (btrfs_super_magic(sb) == BTRFS_MAGIC)
361 printf(" [match]\n");
363 printf(" [DON'T MATCH]\n");
365 uuid_unparse(sb->fsid, buf);
366 printf("fsid\t\t\t%s\n", buf);
368 printf("label\t\t\t");
370 for (i = 0; i < BTRFS_LABEL_SIZE && s[i]; i++)
371 putchar(isprint(s[i]) ? s[i] : '.');
374 printf("generation\t\t%llu\n",
375 (unsigned long long)btrfs_super_generation(sb));
376 printf("root\t\t\t%llu\n", (unsigned long long)btrfs_super_root(sb));
377 printf("sys_array_size\t\t%llu\n",
378 (unsigned long long)btrfs_super_sys_array_size(sb));
379 printf("chunk_root_generation\t%llu\n",
380 (unsigned long long)btrfs_super_chunk_root_generation(sb));
381 printf("root_level\t\t%llu\n",
382 (unsigned long long)btrfs_super_root_level(sb));
383 printf("chunk_root\t\t%llu\n",
384 (unsigned long long)btrfs_super_chunk_root(sb));
385 printf("chunk_root_level\t%llu\n",
386 (unsigned long long)btrfs_super_chunk_root_level(sb));
387 printf("log_root\t\t%llu\n",
388 (unsigned long long)btrfs_super_log_root(sb));
389 printf("log_root_transid\t%llu\n",
390 (unsigned long long)btrfs_super_log_root_transid(sb));
391 printf("log_root_level\t\t%llu\n",
392 (unsigned long long)btrfs_super_log_root_level(sb));
393 printf("total_bytes\t\t%llu\n",
394 (unsigned long long)btrfs_super_total_bytes(sb));
395 printf("bytes_used\t\t%llu\n",
396 (unsigned long long)btrfs_super_bytes_used(sb));
397 printf("sectorsize\t\t%llu\n",
398 (unsigned long long)btrfs_super_sectorsize(sb));
399 printf("nodesize\t\t%llu\n",
400 (unsigned long long)btrfs_super_nodesize(sb));
401 printf("leafsize (deprecated)\t\t%u\n",
402 le32_to_cpu(sb->__unused_leafsize));
403 printf("stripesize\t\t%llu\n",
404 (unsigned long long)btrfs_super_stripesize(sb));
405 printf("root_dir\t\t%llu\n",
406 (unsigned long long)btrfs_super_root_dir(sb));
407 printf("num_devices\t\t%llu\n",
408 (unsigned long long)btrfs_super_num_devices(sb));
409 printf("compat_flags\t\t0x%llx\n",
410 (unsigned long long)btrfs_super_compat_flags(sb));
411 printf("compat_ro_flags\t\t0x%llx\n",
412 (unsigned long long)btrfs_super_compat_ro_flags(sb));
413 print_readable_compat_ro_flag(btrfs_super_compat_ro_flags(sb));
414 printf("incompat_flags\t\t0x%llx\n",
415 (unsigned long long)btrfs_super_incompat_flags(sb));
416 print_readable_incompat_flag(btrfs_super_incompat_flags(sb));
417 printf("cache_generation\t%llu\n",
418 (unsigned long long)btrfs_super_cache_generation(sb));
419 printf("uuid_tree_generation\t%llu\n",
420 (unsigned long long)btrfs_super_uuid_tree_generation(sb));
422 uuid_unparse(sb->dev_item.uuid, buf);
423 printf("dev_item.uuid\t\t%s\n", buf);
425 uuid_unparse(sb->dev_item.fsid, buf);
426 printf("dev_item.fsid\t\t%s %s\n", buf,
427 !memcmp(sb->dev_item.fsid, sb->fsid, BTRFS_FSID_SIZE) ?
428 "[match]" : "[DON'T MATCH]");
430 printf("dev_item.type\t\t%llu\n", (unsigned long long)
431 btrfs_stack_device_type(&sb->dev_item));
432 printf("dev_item.total_bytes\t%llu\n", (unsigned long long)
433 btrfs_stack_device_total_bytes(&sb->dev_item));
434 printf("dev_item.bytes_used\t%llu\n", (unsigned long long)
435 btrfs_stack_device_bytes_used(&sb->dev_item));
436 printf("dev_item.io_align\t%u\n", (unsigned int)
437 btrfs_stack_device_io_align(&sb->dev_item));
438 printf("dev_item.io_width\t%u\n", (unsigned int)
439 btrfs_stack_device_io_width(&sb->dev_item));
440 printf("dev_item.sector_size\t%u\n", (unsigned int)
441 btrfs_stack_device_sector_size(&sb->dev_item));
442 printf("dev_item.devid\t\t%llu\n",
443 btrfs_stack_device_id(&sb->dev_item));
444 printf("dev_item.dev_group\t%u\n", (unsigned int)
445 btrfs_stack_device_group(&sb->dev_item));
446 printf("dev_item.seek_speed\t%u\n", (unsigned int)
447 btrfs_stack_device_seek_speed(&sb->dev_item));
448 printf("dev_item.bandwidth\t%u\n", (unsigned int)
449 btrfs_stack_device_bandwidth(&sb->dev_item));
450 printf("dev_item.generation\t%llu\n", (unsigned long long)
451 btrfs_stack_device_generation(&sb->dev_item));
453 printf("sys_chunk_array[%d]:\n", BTRFS_SYSTEM_CHUNK_ARRAY_SIZE);
454 print_sys_chunk_array(sb);
455 printf("backup_roots[%d]:\n", BTRFS_NUM_BACKUP_ROOTS);
456 print_backup_roots(sb);
460 static int load_and_dump_sb(char *filename, int fd, u64 sb_bytenr, int full,
463 u8 super_block_data[BTRFS_SUPER_INFO_SIZE];
464 struct btrfs_super_block *sb;
467 sb = (struct btrfs_super_block *)super_block_data;
469 ret = pread64(fd, super_block_data, BTRFS_SUPER_INFO_SIZE, sb_bytenr);
470 if (ret != BTRFS_SUPER_INFO_SIZE) {
471 /* check if the disk if too short for further superblock */
472 if (ret == 0 && errno == 0)
475 error("failed to read the superblock on %s at %llu",
476 filename, (unsigned long long)sb_bytenr);
477 error("error = '%m', errno = %d", errno);
480 printf("superblock: bytenr=%llu, device=%s\n", sb_bytenr, filename);
481 printf("---------------------------------------------------------\n");
482 if (btrfs_super_magic(sb) != BTRFS_MAGIC && !force) {
483 error("bad magic on superblock on %s at %llu",
484 filename, (unsigned long long)sb_bytenr);
486 dump_superblock(sb, full);
491 const char * const cmd_inspect_dump_super_usage[] = {
492 "btrfs inspect-internal dump-super [options] device [device...]",
493 "Dump superblock from a device in a textual form",
494 "-f|--full print full superblock information, backup roots etc.",
495 "-a|--all print information about all superblocks",
496 "-s|--super <super> specify which copy to print out (values: 0, 1, 2)",
497 "-F|--force attempt to dump superblocks with bad magic",
498 "--bytenr <offset> specify alternate superblock offset",
500 "Deprecated syntax:",
501 "-s <bytenr> specify alternate superblock offset, values other than 0, 1, 2",
502 " will be interpreted as --bytenr for backward compatibility,",
503 " option renamed for consistency with other tools (eg. check)",
504 "-i <super> specify which copy to print out (values: 0, 1, 2), now moved",
509 int cmd_inspect_dump_super(int argc, char **argv)
519 u64 sb_bytenr = btrfs_sb_offset(0);
523 enum { GETOPT_VAL_BYTENR = 257 };
524 static const struct option long_options[] = {
525 {"all", no_argument, NULL, 'a'},
526 {"bytenr", required_argument, NULL, GETOPT_VAL_BYTENR },
527 {"full", no_argument, NULL, 'f'},
528 {"force", no_argument, NULL, 'F'},
529 {"super", required_argument, NULL, 's' },
533 c = getopt_long(argc, argv, "fFai:s:", long_options, NULL);
540 "option -i is deprecated, please use -s or --super");
541 arg = arg_strtou64(optarg);
542 if (arg >= BTRFS_SUPER_MIRROR_MAX) {
543 error("super mirror too big: %llu >= %d",
544 arg, BTRFS_SUPER_MIRROR_MAX);
547 sb_bytenr = btrfs_sb_offset(arg);
560 arg = arg_strtou64(optarg);
561 if (BTRFS_SUPER_MIRROR_MAX <= arg) {
563 "deprecated use of -s <bytenr> with %llu, assuming --bytenr",
564 (unsigned long long)arg);
567 sb_bytenr = btrfs_sb_offset(arg);
571 case GETOPT_VAL_BYTENR:
572 arg = arg_strtou64(optarg);
577 usage(cmd_inspect_dump_super_usage);
581 if (check_argc_min(argc - optind, 1))
582 usage(cmd_inspect_dump_super_usage);
584 for (i = optind; i < argc; i++) {
586 fd = open(filename, O_RDONLY);
588 error("cannot open %s: %m", filename);
596 for (idx = 0; idx < BTRFS_SUPER_MIRROR_MAX; idx++) {
597 sb_bytenr = btrfs_sb_offset(idx);
598 if (load_and_dump_sb(filename, fd,
599 sb_bytenr, full, force)) {
608 load_and_dump_sb(filename, fd, sb_bytenr, full, force);