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"
36 #include "cmds-inspect-dump-super.h"
38 static int check_csum_sblock(void *sb, int csum_size)
40 char result[BTRFS_CSUM_SIZE];
43 crc = btrfs_csum_data(NULL, (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 array_size = btrfs_super_sys_array_size(sb);
72 array_ptr = sb->sys_chunk_array;
73 sb_array_offset = offsetof(struct btrfs_super_block, sys_chunk_array);
77 while (cur_offset < array_size) {
78 disk_key = (struct btrfs_disk_key *)array_ptr;
79 len = sizeof(*disk_key);
80 if (cur_offset + len > array_size)
83 btrfs_disk_key_to_cpu(&key, disk_key);
86 sb_array_offset += len;
89 printf("\titem %d ", item);
90 btrfs_print_key(disk_key);
93 if (key.type == BTRFS_CHUNK_ITEM_KEY) {
94 chunk = (struct btrfs_chunk *)sb_array_offset;
96 * At least one btrfs_chunk with one stripe must be
97 * present, exact stripe count check comes afterwards
99 len = btrfs_chunk_item_size(1);
100 if (cur_offset + len > array_size)
103 print_chunk(buf, chunk);
104 num_stripes = btrfs_chunk_num_stripes(buf, chunk);
107 "invalid number of stripes %u in sys_array at offset %u",
108 num_stripes, cur_offset);
111 len = btrfs_chunk_item_size(num_stripes);
112 if (cur_offset + len > array_size)
115 error("unexpected item type %u in sys_array at offset %u",
116 (u32)key.type, cur_offset);
120 sb_array_offset += len;
131 error("sys_array too short to read %u bytes at offset %u",
136 static int empty_backup(struct btrfs_root_backup *backup)
138 if (backup == NULL ||
139 (backup->tree_root == 0 &&
140 backup->tree_root_gen == 0))
145 static void print_root_backup(struct btrfs_root_backup *backup)
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));
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));
181 static void print_backup_roots(struct btrfs_super_block *sb)
183 struct btrfs_root_backup *backup;
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);
195 struct readable_flag_entry {
200 #define DEF_INCOMPAT_FLAG_ENTRY(bit_name) \
201 {BTRFS_FEATURE_INCOMPAT_##bit_name, #bit_name}
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)
215 static const int incompat_flags_num = sizeof(incompat_flags_array) /
216 sizeof(struct readable_flag_entry);
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}
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)
231 static const int super_flags_num = ARRAY_SIZE(super_flags_array);
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)
240 static void __print_readable_flag(u64 flag, struct readable_flag_entry *array,
241 int array_size, u64 supported_flags)
245 struct readable_flag_entry *entry;
251 for (i = 0; i < array_size; i++) {
253 if (flag & entry->bit) {
255 printf("%s ", entry->output);
257 printf("|\n\t\t\t %s ", entry->output);
261 flag &= ~supported_flags;
264 printf("unknown flag: 0x%llx ", flag);
266 printf("|\n\t\t\t unknown flag: 0x%llx ", flag);
271 static void print_readable_incompat_flag(u64 flag)
273 return __print_readable_flag(flag, incompat_flags_array,
275 BTRFS_FEATURE_INCOMPAT_SUPP);
278 static void print_readable_super_flag(u64 flag)
280 return __print_readable_flag(flag, super_flags_array,
281 super_flags_num, BTRFS_SUPER_FLAG_SUPP);
284 static void dump_superblock(struct btrfs_super_block *sb, int full)
287 char *s, buf[BTRFS_UUID_UNPARSED_SIZE];
292 csum_type = btrfs_super_csum_type(sb);
293 csum_size = BTRFS_CSUM_SIZE;
294 printf("csum_type\t\t%hu (", csum_type);
295 if (csum_type >= ARRAY_SIZE(btrfs_csum_sizes)) {
298 if (csum_type == BTRFS_CSUM_TYPE_CRC32) {
300 csum_size = btrfs_csum_sizes[csum_type];
306 printf("csum_size\t\t%llu\n", (unsigned long long)csum_size);
308 printf("csum\t\t\t0x");
309 for (i = 0, p = sb->csum; i < csum_size; i++)
310 printf("%02x", p[i]);
311 if (check_csum_sblock(sb, csum_size))
314 printf(" [DON'T MATCH]");
317 printf("bytenr\t\t\t%llu\n",
318 (unsigned long long)btrfs_super_bytenr(sb));
319 printf("flags\t\t\t0x%llx\n",
320 (unsigned long long)btrfs_super_flags(sb));
321 print_readable_super_flag(btrfs_super_flags(sb));
323 printf("magic\t\t\t");
324 s = (char *) &sb->magic;
325 for (i = 0; i < 8; i++)
326 putchar(isprint(s[i]) ? s[i] : '.');
327 if (btrfs_super_magic(sb) == BTRFS_MAGIC)
328 printf(" [match]\n");
330 printf(" [DON'T MATCH]\n");
332 uuid_unparse(sb->fsid, buf);
333 printf("fsid\t\t\t%s\n", buf);
335 printf("label\t\t\t");
337 for (i = 0; i < BTRFS_LABEL_SIZE && s[i]; i++)
338 putchar(isprint(s[i]) ? s[i] : '.');
341 printf("generation\t\t%llu\n",
342 (unsigned long long)btrfs_super_generation(sb));
343 printf("root\t\t\t%llu\n", (unsigned long long)btrfs_super_root(sb));
344 printf("sys_array_size\t\t%llu\n",
345 (unsigned long long)btrfs_super_sys_array_size(sb));
346 printf("chunk_root_generation\t%llu\n",
347 (unsigned long long)btrfs_super_chunk_root_generation(sb));
348 printf("root_level\t\t%llu\n",
349 (unsigned long long)btrfs_super_root_level(sb));
350 printf("chunk_root\t\t%llu\n",
351 (unsigned long long)btrfs_super_chunk_root(sb));
352 printf("chunk_root_level\t%llu\n",
353 (unsigned long long)btrfs_super_chunk_root_level(sb));
354 printf("log_root\t\t%llu\n",
355 (unsigned long long)btrfs_super_log_root(sb));
356 printf("log_root_transid\t%llu\n",
357 (unsigned long long)btrfs_super_log_root_transid(sb));
358 printf("log_root_level\t\t%llu\n",
359 (unsigned long long)btrfs_super_log_root_level(sb));
360 printf("total_bytes\t\t%llu\n",
361 (unsigned long long)btrfs_super_total_bytes(sb));
362 printf("bytes_used\t\t%llu\n",
363 (unsigned long long)btrfs_super_bytes_used(sb));
364 printf("sectorsize\t\t%llu\n",
365 (unsigned long long)btrfs_super_sectorsize(sb));
366 printf("nodesize\t\t%llu\n",
367 (unsigned long long)btrfs_super_nodesize(sb));
368 printf("leafsize\t\t%llu\n",
369 (unsigned long long)btrfs_super_leafsize(sb));
370 printf("stripesize\t\t%llu\n",
371 (unsigned long long)btrfs_super_stripesize(sb));
372 printf("root_dir\t\t%llu\n",
373 (unsigned long long)btrfs_super_root_dir(sb));
374 printf("num_devices\t\t%llu\n",
375 (unsigned long long)btrfs_super_num_devices(sb));
376 printf("compat_flags\t\t0x%llx\n",
377 (unsigned long long)btrfs_super_compat_flags(sb));
378 printf("compat_ro_flags\t\t0x%llx\n",
379 (unsigned long long)btrfs_super_compat_ro_flags(sb));
380 printf("incompat_flags\t\t0x%llx\n",
381 (unsigned long long)btrfs_super_incompat_flags(sb));
382 print_readable_incompat_flag(btrfs_super_incompat_flags(sb));
383 printf("cache_generation\t%llu\n",
384 (unsigned long long)btrfs_super_cache_generation(sb));
385 printf("uuid_tree_generation\t%llu\n",
386 (unsigned long long)btrfs_super_uuid_tree_generation(sb));
388 uuid_unparse(sb->dev_item.uuid, buf);
389 printf("dev_item.uuid\t\t%s\n", buf);
391 uuid_unparse(sb->dev_item.fsid, buf);
392 printf("dev_item.fsid\t\t%s %s\n", buf,
393 !memcmp(sb->dev_item.fsid, sb->fsid, BTRFS_FSID_SIZE) ?
394 "[match]" : "[DON'T MATCH]");
396 printf("dev_item.type\t\t%llu\n", (unsigned long long)
397 btrfs_stack_device_type(&sb->dev_item));
398 printf("dev_item.total_bytes\t%llu\n", (unsigned long long)
399 btrfs_stack_device_total_bytes(&sb->dev_item));
400 printf("dev_item.bytes_used\t%llu\n", (unsigned long long)
401 btrfs_stack_device_bytes_used(&sb->dev_item));
402 printf("dev_item.io_align\t%u\n", (unsigned int)
403 btrfs_stack_device_io_align(&sb->dev_item));
404 printf("dev_item.io_width\t%u\n", (unsigned int)
405 btrfs_stack_device_io_width(&sb->dev_item));
406 printf("dev_item.sector_size\t%u\n", (unsigned int)
407 btrfs_stack_device_sector_size(&sb->dev_item));
408 printf("dev_item.devid\t\t%llu\n",
409 btrfs_stack_device_id(&sb->dev_item));
410 printf("dev_item.dev_group\t%u\n", (unsigned int)
411 btrfs_stack_device_group(&sb->dev_item));
412 printf("dev_item.seek_speed\t%u\n", (unsigned int)
413 btrfs_stack_device_seek_speed(&sb->dev_item));
414 printf("dev_item.bandwidth\t%u\n", (unsigned int)
415 btrfs_stack_device_bandwidth(&sb->dev_item));
416 printf("dev_item.generation\t%llu\n", (unsigned long long)
417 btrfs_stack_device_generation(&sb->dev_item));
419 printf("sys_chunk_array[%d]:\n", BTRFS_SYSTEM_CHUNK_ARRAY_SIZE);
420 print_sys_chunk_array(sb);
421 printf("backup_roots[%d]:\n", BTRFS_NUM_BACKUP_ROOTS);
422 print_backup_roots(sb);
426 static int load_and_dump_sb(char *filename, int fd, u64 sb_bytenr, int full,
429 u8 super_block_data[BTRFS_SUPER_INFO_SIZE];
430 struct btrfs_super_block *sb;
433 sb = (struct btrfs_super_block *)super_block_data;
435 ret = pread64(fd, super_block_data, BTRFS_SUPER_INFO_SIZE, sb_bytenr);
436 if (ret != BTRFS_SUPER_INFO_SIZE) {
437 /* check if the disk if too short for further superblock */
438 if (ret == 0 && errno == 0)
441 error("failed to read the superblock on %s at %llu",
442 filename, (unsigned long long)sb_bytenr);
443 error("error = '%s', errno = %d", strerror(errno), errno);
446 printf("superblock: bytenr=%llu, device=%s\n", sb_bytenr, filename);
447 printf("---------------------------------------------------------\n");
448 if (btrfs_super_magic(sb) != BTRFS_MAGIC && !force) {
449 error("bad magic on superblock on %s at %llu",
450 filename, (unsigned long long)sb_bytenr);
452 dump_superblock(sb, full);
457 const char * const cmd_inspect_dump_super_usage[] = {
458 "btrfs inspect-internal dump-super [options] device [device...]",
459 "Dump superblock from a device in a textual form",
460 "-f|--full print full superblock information, backup roots etc.",
461 "-a|--all print information about all superblocks",
462 "-s|--super <super> specify which copy to print out (values: 0, 1, 2)",
463 "-F|--force attempt to dump superblocks with bad magic",
464 "--bytenr <offset> specify alternate superblock offset",
466 "Deprecated syntax:",
467 "-s <bytenr> specify alternate superblock offset, values other than 0, 1, 2",
468 " will be interpreted as --bytenr for backward compatibility,",
469 " option renamed for consistency with other tools (eg. check)",
470 "-i <super> specify which copy to print out (values: 0, 1, 2), now moved",
475 int cmd_inspect_dump_super(int argc, char **argv)
485 u64 sb_bytenr = btrfs_sb_offset(0);
489 static const struct option long_options[] = {
490 {"all", no_argument, NULL, 'a'},
491 {"full", no_argument, NULL, 'f'},
492 {"force", no_argument, NULL, 'F'},
493 {"super", required_argument, NULL, 's' },
497 c = getopt_long(argc, argv, "fFai:s:", long_options, NULL);
504 "option -i is deprecated, please use -s or --super");
505 arg = arg_strtou64(optarg);
506 if (arg >= BTRFS_SUPER_MIRROR_MAX) {
507 error("super mirror too big: %llu >= %d",
508 arg, BTRFS_SUPER_MIRROR_MAX);
511 sb_bytenr = btrfs_sb_offset(arg);
524 arg = arg_strtou64(optarg);
525 if (BTRFS_SUPER_MIRROR_MAX <= arg) {
527 "deprecated use of -s <bytenr> with %llu, assuming --bytenr",
528 (unsigned long long)arg);
531 sb_bytenr = btrfs_sb_offset(arg);
536 usage(cmd_inspect_dump_super_usage);
540 if (check_argc_min(argc - optind, 1))
541 usage(cmd_inspect_dump_super_usage);
543 for (i = optind; i < argc; i++) {
545 fd = open(filename, O_RDONLY);
547 error("cannot open %s: %s", filename, strerror(errno));
555 for (idx = 0; idx < BTRFS_SUPER_MIRROR_MAX; idx++) {
556 sb_bytenr = btrfs_sb_offset(idx);
557 if (load_and_dump_sb(filename, fd,
558 sb_bytenr, full, force)) {
567 load_and_dump_sb(filename, fd, sb_bytenr, full, force);