?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
btrfs-progs: format FREE_SPACE_TREE{,_VALID} nicely in dump-super
[btrfs-progs-unstable/devel.git] / cmds-inspect-dump-super.c
blobba0d708ee1b78846bd5ab6dc018dbbefd058abf1
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 #include <getopt.h>
27
28 #include "ctree.h"
29 #include "disk-io.h"
30 #include "print-tree.h"
31 #include "transaction.h"
32 #include "list.h"
33 #include "utils.h"
34 #include "commands.h"
35 #include "crc32c.h"
36 #include "cmds-inspect-dump-super.h"
37
38 static int check_csum_sblock(void *sb, int csum_size)
39 {
40 u8 result[BTRFS_CSUM_SIZE];
41 u32 crc = ~(u32)0;
42
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);
46
47 return !memcmp(sb, &result, csum_size);
48 }
49
50 static void print_sys_chunk_array(struct btrfs_super_block *sb)
51 {
52 struct extent_buffer *buf;
53 struct btrfs_disk_key *disk_key;
54 struct btrfs_chunk *chunk;
55 u8 *array_ptr;
56 unsigned long sb_array_offset;
57 u32 num_stripes;
58 u32 array_size;
59 u32 len = 0;
60 u32 cur_offset;
61 struct btrfs_key key;
62 int item;
63
64 buf = malloc(sizeof(*buf) + sizeof(*sb));
65 if (!buf) {
66 error("not enough memory");
67 goto out;
68 }
69 write_extent_buffer(buf, sb, 0, sizeof(*sb));
70 array_size = btrfs_super_sys_array_size(sb);
71
72 array_ptr = sb->sys_chunk_array;
73 sb_array_offset = offsetof(struct btrfs_super_block, sys_chunk_array);
74 cur_offset = 0;
75 item = 0;
76
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)
81 goto out_short_read;
82
83 btrfs_disk_key_to_cpu(&key, disk_key);
84
85 array_ptr += len;
86 sb_array_offset += len;
87 cur_offset += len;
88
89 printf("\titem %d ", item);
90 btrfs_print_key(disk_key);
91 putchar('\n');
92
93 if (key.type == BTRFS_CHUNK_ITEM_KEY) {
94 chunk = (struct btrfs_chunk *)sb_array_offset;
95 /*
96 * At least one btrfs_chunk with one stripe must be
97 * present, exact stripe count check comes afterwards
98 */
99 len = btrfs_chunk_item_size(1);
100 if (cur_offset + len > array_size)
101 goto out_short_read;
102
103 num_stripes = btrfs_chunk_num_stripes(buf, chunk);
104 if (!num_stripes) {
105 error(
106 "invalid number of stripes %u in sys_array at offset %u",
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 print_chunk(buf, chunk);
114 } else {
115 error("unexpected item type %u in sys_array at offset %u",
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 error("sys_array too short to read %u bytes at offset %u",
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_COMPAT_RO_FLAG_ENTRY(bit_name) \
201 {BTRFS_FEATURE_COMPAT_RO_##bit_name, #bit_name}
202
203 static struct readable_flag_entry compat_ro_flags_array[] = {
204 DEF_COMPAT_RO_FLAG_ENTRY(FREE_SPACE_TREE),
205 DEF_COMPAT_RO_FLAG_ENTRY(FREE_SPACE_TREE_VALID),
206 };
207 static const int compat_ro_flags_num = sizeof(compat_ro_flags_array) /
208 sizeof(struct readable_flag_entry);
209
210 #define DEF_INCOMPAT_FLAG_ENTRY(bit_name) \
211 {BTRFS_FEATURE_INCOMPAT_##bit_name, #bit_name}
212
213 static struct readable_flag_entry incompat_flags_array[] = {
214 DEF_INCOMPAT_FLAG_ENTRY(MIXED_BACKREF),
215 DEF_INCOMPAT_FLAG_ENTRY(DEFAULT_SUBVOL),
216 DEF_INCOMPAT_FLAG_ENTRY(MIXED_GROUPS),
217 DEF_INCOMPAT_FLAG_ENTRY(COMPRESS_LZO),
218 DEF_INCOMPAT_FLAG_ENTRY(COMPRESS_LZOv2),
219 DEF_INCOMPAT_FLAG_ENTRY(BIG_METADATA),
220 DEF_INCOMPAT_FLAG_ENTRY(EXTENDED_IREF),
221 DEF_INCOMPAT_FLAG_ENTRY(RAID56),
222 DEF_INCOMPAT_FLAG_ENTRY(SKINNY_METADATA),
223 DEF_INCOMPAT_FLAG_ENTRY(NO_HOLES)
224 };
225 static const int incompat_flags_num = sizeof(incompat_flags_array) /
226 sizeof(struct readable_flag_entry);
227
228 #define DEF_HEADER_FLAG_ENTRY(bit_name) \
229 {BTRFS_HEADER_FLAG_##bit_name, #bit_name}
230 #define DEF_SUPER_FLAG_ENTRY(bit_name) \
231 {BTRFS_SUPER_FLAG_##bit_name, #bit_name}
232
233 static struct readable_flag_entry super_flags_array[] = {
234 DEF_HEADER_FLAG_ENTRY(WRITTEN),
235 DEF_HEADER_FLAG_ENTRY(RELOC),
236 DEF_SUPER_FLAG_ENTRY(CHANGING_FSID),
237 DEF_SUPER_FLAG_ENTRY(SEEDING),
238 DEF_SUPER_FLAG_ENTRY(METADUMP),
239 DEF_SUPER_FLAG_ENTRY(METADUMP_V2)
240 };
241 static const int super_flags_num = ARRAY_SIZE(super_flags_array);
242
243 #define BTRFS_SUPER_FLAG_SUPP (BTRFS_HEADER_FLAG_WRITTEN |\
244 BTRFS_HEADER_FLAG_RELOC |\
245 BTRFS_SUPER_FLAG_CHANGING_FSID |\
246 BTRFS_SUPER_FLAG_SEEDING |\
247 BTRFS_SUPER_FLAG_METADUMP |\
248 BTRFS_SUPER_FLAG_METADUMP_V2)
249
250 static void __print_readable_flag(u64 flag, struct readable_flag_entry *array,
251 int array_size, u64 supported_flags)
252 {
253 int i;
254 int first = 1;
255 struct readable_flag_entry *entry;
256
257 if (!flag)
258 return;
259
260 printf("\t\t\t( ");
261 for (i = 0; i < array_size; i++) {
262 entry = array + i;
263 if (flag & entry->bit) {
264 if (first)
265 printf("%s ", entry->output);
266 else
267 printf("|\n\t\t\t %s ", entry->output);
268 first = 0;
269 }
270 }
271 flag &= ~supported_flags;
272 if (flag) {
273 if (first)
274 printf("unknown flag: 0x%llx ", flag);
275 else
276 printf("|\n\t\t\t unknown flag: 0x%llx ", flag);
277 }
278 printf(")\n");
279 }
280
281 static void print_readable_compat_ro_flag(u64 flag)
282 {
283 /*
284 * We know about the FREE_SPACE_TREE{,_VALID} bits, but we don't
285 * actually support them yet.
286 */
287 return __print_readable_flag(flag, compat_ro_flags_array,
288 compat_ro_flags_num,
289 BTRFS_FEATURE_COMPAT_RO_SUPP |
290 BTRFS_FEATURE_COMPAT_RO_FREE_SPACE_TREE |
291 BTRFS_FEATURE_COMPAT_RO_FREE_SPACE_TREE_VALID);
292 }
293
294 static void print_readable_incompat_flag(u64 flag)
295 {
296 return __print_readable_flag(flag, incompat_flags_array,
297 incompat_flags_num,
298 BTRFS_FEATURE_INCOMPAT_SUPP);
299 }
300
301 static void print_readable_super_flag(u64 flag)
302 {
303 return __print_readable_flag(flag, super_flags_array,
304 super_flags_num, BTRFS_SUPER_FLAG_SUPP);
305 }
306
307 static void dump_superblock(struct btrfs_super_block *sb, int full)
308 {
309 int i;
310 char *s, buf[BTRFS_UUID_UNPARSED_SIZE];
311 u8 *p;
312 u32 csum_size;
313 u16 csum_type;
314
315 csum_type = btrfs_super_csum_type(sb);
316 csum_size = BTRFS_CSUM_SIZE;
317 printf("csum_type\t\t%hu (", csum_type);
318 if (csum_type >= ARRAY_SIZE(btrfs_csum_sizes)) {
319 printf("INVALID");
320 } else {
321 if (csum_type == BTRFS_CSUM_TYPE_CRC32) {
322 printf("crc32c");
323 csum_size = btrfs_csum_sizes[csum_type];
324 } else {
325 printf("unknown");
326 }
327 }
328 printf(")\n");
329 printf("csum_size\t\t%llu\n", (unsigned long long)csum_size);
330
331 printf("csum\t\t\t0x");
332 for (i = 0, p = sb->csum; i < csum_size; i++)
333 printf("%02x", p[i]);
334 if (check_csum_sblock(sb, csum_size))
335 printf(" [match]");
336 else
337 printf(" [DON'T MATCH]");
338 putchar('\n');
339
340 printf("bytenr\t\t\t%llu\n",
341 (unsigned long long)btrfs_super_bytenr(sb));
342 printf("flags\t\t\t0x%llx\n",
343 (unsigned long long)btrfs_super_flags(sb));
344 print_readable_super_flag(btrfs_super_flags(sb));
345
346 printf("magic\t\t\t");
347 s = (char *) &sb->magic;
348 for (i = 0; i < 8; i++)
349 putchar(isprint(s[i]) ? s[i] : '.');
350 if (btrfs_super_magic(sb) == BTRFS_MAGIC)
351 printf(" [match]\n");
352 else
353 printf(" [DON'T MATCH]\n");
354
355 uuid_unparse(sb->fsid, buf);
356 printf("fsid\t\t\t%s\n", buf);
357
358 printf("label\t\t\t");
359 s = sb->label;
360 for (i = 0; i < BTRFS_LABEL_SIZE && s[i]; i++)
361 putchar(isprint(s[i]) ? s[i] : '.');
362 putchar('\n');
363
364 printf("generation\t\t%llu\n",
365 (unsigned long long)btrfs_super_generation(sb));
366 printf("root\t\t\t%llu\n", (unsigned long long)btrfs_super_root(sb));
367 printf("sys_array_size\t\t%llu\n",
368 (unsigned long long)btrfs_super_sys_array_size(sb));
369 printf("chunk_root_generation\t%llu\n",
370 (unsigned long long)btrfs_super_chunk_root_generation(sb));
371 printf("root_level\t\t%llu\n",
372 (unsigned long long)btrfs_super_root_level(sb));
373 printf("chunk_root\t\t%llu\n",
374 (unsigned long long)btrfs_super_chunk_root(sb));
375 printf("chunk_root_level\t%llu\n",
376 (unsigned long long)btrfs_super_chunk_root_level(sb));
377 printf("log_root\t\t%llu\n",
378 (unsigned long long)btrfs_super_log_root(sb));
379 printf("log_root_transid\t%llu\n",
380 (unsigned long long)btrfs_super_log_root_transid(sb));
381 printf("log_root_level\t\t%llu\n",
382 (unsigned long long)btrfs_super_log_root_level(sb));
383 printf("total_bytes\t\t%llu\n",
384 (unsigned long long)btrfs_super_total_bytes(sb));
385 printf("bytes_used\t\t%llu\n",
386 (unsigned long long)btrfs_super_bytes_used(sb));
387 printf("sectorsize\t\t%llu\n",
388 (unsigned long long)btrfs_super_sectorsize(sb));
389 printf("nodesize\t\t%llu\n",
390 (unsigned long long)btrfs_super_nodesize(sb));
391 printf("leafsize\t\t%llu\n",
392 (unsigned long long)btrfs_super_leafsize(sb));
393 printf("stripesize\t\t%llu\n",
394 (unsigned long long)btrfs_super_stripesize(sb));
395 printf("root_dir\t\t%llu\n",
396 (unsigned long long)btrfs_super_root_dir(sb));
397 printf("num_devices\t\t%llu\n",
398 (unsigned long long)btrfs_super_num_devices(sb));
399 printf("compat_flags\t\t0x%llx\n",
400 (unsigned long long)btrfs_super_compat_flags(sb));
401 printf("compat_ro_flags\t\t0x%llx\n",
402 (unsigned long long)btrfs_super_compat_ro_flags(sb));
403 print_readable_compat_ro_flag(btrfs_super_compat_ro_flags(sb));
404 printf("incompat_flags\t\t0x%llx\n",
405 (unsigned long long)btrfs_super_incompat_flags(sb));
406 print_readable_incompat_flag(btrfs_super_incompat_flags(sb));
407 printf("cache_generation\t%llu\n",
408 (unsigned long long)btrfs_super_cache_generation(sb));
409 printf("uuid_tree_generation\t%llu\n",
410 (unsigned long long)btrfs_super_uuid_tree_generation(sb));
411
412 uuid_unparse(sb->dev_item.uuid, buf);
413 printf("dev_item.uuid\t\t%s\n", buf);
414
415 uuid_unparse(sb->dev_item.fsid, buf);
416 printf("dev_item.fsid\t\t%s %s\n", buf,
417 !memcmp(sb->dev_item.fsid, sb->fsid, BTRFS_FSID_SIZE) ?
418 "[match]" : "[DON'T MATCH]");
419
420 printf("dev_item.type\t\t%llu\n", (unsigned long long)
421 btrfs_stack_device_type(&sb->dev_item));
422 printf("dev_item.total_bytes\t%llu\n", (unsigned long long)
423 btrfs_stack_device_total_bytes(&sb->dev_item));
424 printf("dev_item.bytes_used\t%llu\n", (unsigned long long)
425 btrfs_stack_device_bytes_used(&sb->dev_item));
426 printf("dev_item.io_align\t%u\n", (unsigned int)
427 btrfs_stack_device_io_align(&sb->dev_item));
428 printf("dev_item.io_width\t%u\n", (unsigned int)
429 btrfs_stack_device_io_width(&sb->dev_item));
430 printf("dev_item.sector_size\t%u\n", (unsigned int)
431 btrfs_stack_device_sector_size(&sb->dev_item));
432 printf("dev_item.devid\t\t%llu\n",
433 btrfs_stack_device_id(&sb->dev_item));
434 printf("dev_item.dev_group\t%u\n", (unsigned int)
435 btrfs_stack_device_group(&sb->dev_item));
436 printf("dev_item.seek_speed\t%u\n", (unsigned int)
437 btrfs_stack_device_seek_speed(&sb->dev_item));
438 printf("dev_item.bandwidth\t%u\n", (unsigned int)
439 btrfs_stack_device_bandwidth(&sb->dev_item));
440 printf("dev_item.generation\t%llu\n", (unsigned long long)
441 btrfs_stack_device_generation(&sb->dev_item));
442 if (full) {
443 printf("sys_chunk_array[%d]:\n", BTRFS_SYSTEM_CHUNK_ARRAY_SIZE);
444 print_sys_chunk_array(sb);
445 printf("backup_roots[%d]:\n", BTRFS_NUM_BACKUP_ROOTS);
446 print_backup_roots(sb);
447 }
448 }
449
450 static int load_and_dump_sb(char *filename, int fd, u64 sb_bytenr, int full,
451 int force)
452 {
453 u8 super_block_data[BTRFS_SUPER_INFO_SIZE];
454 struct btrfs_super_block *sb;
455 u64 ret;
456
457 sb = (struct btrfs_super_block *)super_block_data;
458
459 ret = pread64(fd, super_block_data, BTRFS_SUPER_INFO_SIZE, sb_bytenr);
460 if (ret != BTRFS_SUPER_INFO_SIZE) {
461 /* check if the disk if too short for further superblock */
462 if (ret == 0 && errno == 0)
463 return 0;
464
465 error("failed to read the superblock on %s at %llu",
466 filename, (unsigned long long)sb_bytenr);
467 error("error = '%s', errno = %d", strerror(errno), errno);
468 return 1;
469 }
470 printf("superblock: bytenr=%llu, device=%s\n", sb_bytenr, filename);
471 printf("---------------------------------------------------------\n");
472 if (btrfs_super_magic(sb) != BTRFS_MAGIC && !force) {
473 error("bad magic on superblock on %s at %llu",
474 filename, (unsigned long long)sb_bytenr);
475 } else {
476 dump_superblock(sb, full);
477 }
478 return 0;
479 }
480
481 const char * const cmd_inspect_dump_super_usage[] = {
482 "btrfs inspect-internal dump-super [options] device [device...]",
483 "Dump superblock from a device in a textual form",
484 "-f|--full print full superblock information, backup roots etc.",
485 "-a|--all print information about all superblocks",
486 "-s|--super <super> specify which copy to print out (values: 0, 1, 2)",
487 "-F|--force attempt to dump superblocks with bad magic",
488 "--bytenr <offset> specify alternate superblock offset",
489 "",
490 "Deprecated syntax:",
491 "-s <bytenr> specify alternate superblock offset, values other than 0, 1, 2",
492 " will be interpreted as --bytenr for backward compatibility,",
493 " option renamed for consistency with other tools (eg. check)",
494 "-i <super> specify which copy to print out (values: 0, 1, 2), now moved",
495 " to -s|--super",
496 NULL
497 };
498
499 int cmd_inspect_dump_super(int argc, char **argv)
500 {
501 int all = 0;
502 int full = 0;
503 int force = 0;
504 char *filename;
505 int fd = -1;
506 int i;
507 int ret = 0;
508 u64 arg;
509 u64 sb_bytenr = btrfs_sb_offset(0);
510
511 while (1) {
512 int c;
513 static const struct option long_options[] = {
514 {"all", no_argument, NULL, 'a'},
515 {"full", no_argument, NULL, 'f'},
516 {"force", no_argument, NULL, 'F'},
517 {"super", required_argument, NULL, 's' },
518 {NULL, 0, NULL, 0}
519 };
520
521 c = getopt_long(argc, argv, "fFai:s:", long_options, NULL);
522 if (c < 0)
523 break;
524
525 switch (c) {
526 case 'i':
527 warning(
528 "option -i is deprecated, please use -s or --super");
529 arg = arg_strtou64(optarg);
530 if (arg >= BTRFS_SUPER_MIRROR_MAX) {
531 error("super mirror too big: %llu >= %d",
532 arg, BTRFS_SUPER_MIRROR_MAX);
533 return 1;
534 }
535 sb_bytenr = btrfs_sb_offset(arg);
536 break;
537
538 case 'a':
539 all = 1;
540 break;
541 case 'f':
542 full = 1;
543 break;
544 case 'F':
545 force = 1;
546 break;
547 case 's':
548 arg = arg_strtou64(optarg);
549 if (BTRFS_SUPER_MIRROR_MAX <= arg) {
550 warning(
551 "deprecated use of -s <bytenr> with %llu, assuming --bytenr",
552 (unsigned long long)arg);
553 sb_bytenr = arg;
554 } else {
555 sb_bytenr = btrfs_sb_offset(arg);
556 }
557 all = 0;
558 break;
559 default:
560 usage(cmd_inspect_dump_super_usage);
561 }
562 }
563
564 if (check_argc_min(argc - optind, 1))
565 usage(cmd_inspect_dump_super_usage);
566
567 for (i = optind; i < argc; i++) {
568 filename = argv[i];
569 fd = open(filename, O_RDONLY);
570 if (fd < 0) {
571 error("cannot open %s: %s", filename, strerror(errno));
572 ret = 1;
573 goto out;
574 }
575
576 if (all) {
577 int idx;
578
579 for (idx = 0; idx < BTRFS_SUPER_MIRROR_MAX; idx++) {
580 sb_bytenr = btrfs_sb_offset(idx);
581 if (load_and_dump_sb(filename, fd,
582 sb_bytenr, full, force)) {
583 close(fd);
584 ret = 1;
585 goto out;
586 }
587
588 putchar('\n');
589 }
590 } else {
591 load_and_dump_sb(filename, fd, sb_bytenr, full, force);
592 putchar('\n');
593 }
594 close(fd);
595 }
596
597 out:
598 return ret;
599 }
(deprecated) Btrfs progs developments and patch integration