sbin/fsck_hammer2: Print blockref data on failure if possible
[dragonfly.git] / sbin / fsck_hammer2 / test.c
1 /*
2  * Copyright (c) 2019 Tomohiro Kusumi <tkusumi@netbsd.org>
3  * Copyright (c) 2019 The DragonFly Project
4  * All rights reserved.
5  *
6  * This code is derived from software contributed to The DragonFly Project
7  * by Matthew Dillon <dillon@dragonflybsd.org>
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in
17  *    the documentation and/or other materials provided with the
18  *    distribution.
19  * 3. Neither the name of The DragonFly Project nor the names of its
20  *    contributors may be used to endorse or promote products derived
21  *    from this software without specific, prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
27  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
29  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
31  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
32  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
33  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  */
36
37 #include <sys/types.h>
38 #include <sys/stat.h>
39 #include <sys/tree.h>
40 #include <sys/queue.h>
41 #include <sys/ttycom.h>
42 #include <unistd.h>
43 #include <fcntl.h>
44 #include <stdio.h>
45 #include <stdlib.h>
46 #include <stdarg.h>
47 #include <stdbool.h>
48 #include <string.h>
49 #include <assert.h>
50
51 #include <openssl/sha.h>
52
53 #include <vfs/hammer2/hammer2_disk.h>
54 #include <vfs/hammer2/hammer2_xxhash.h>
55
56 #include "hammer2_subs.h"
57 #include "fsck_hammer2.h"
58
59 struct blockref_msg {
60         TAILQ_ENTRY(blockref_msg) entry;
61         hammer2_blockref_t bref;
62         char *msg;
63 };
64
65 TAILQ_HEAD(blockref_list, blockref_msg);
66
67 struct blockref_entry {
68         RB_ENTRY(blockref_entry) entry;
69         hammer2_off_t data_off;
70         struct blockref_list head;
71 };
72
73 static int
74 blockref_cmp(struct blockref_entry *b1, struct blockref_entry *b2)
75 {
76         if (b1->data_off < b2->data_off)
77                 return -1;
78         if (b1->data_off > b2->data_off)
79                 return 1;
80         return 0;
81 }
82
83 RB_HEAD(blockref_tree, blockref_entry);
84 RB_PROTOTYPE2(blockref_tree, blockref_entry, entry, blockref_cmp,
85     hammer2_off_t);
86 RB_GENERATE2(blockref_tree, blockref_entry, entry, blockref_cmp, hammer2_off_t,
87     data_off);
88
89 typedef struct {
90         struct blockref_tree root;
91         uint8_t type; /* HAMMER2_BREF_TYPE_VOLUME or FREEMAP */
92         uint64_t total_blockref;
93         uint64_t total_empty;
94         uint64_t total_invalid;
95         uint64_t total_bytes;
96         union {
97                 /* use volume or freemap depending on type value */
98                 struct {
99                         uint64_t total_inode;
100                         uint64_t total_indirect;
101                         uint64_t total_data;
102                         uint64_t total_dirent;
103                 } volume;
104                 struct {
105                         uint64_t total_freemap_node;
106                         uint64_t total_freemap_leaf;
107                 } freemap;
108         };
109 } blockref_stats_t;
110
111 static void print_blockref_entry(int, struct blockref_tree *);
112 static void init_blockref_stats(blockref_stats_t *, uint8_t);
113 static void cleanup_blockref_stats(blockref_stats_t *);
114 static void print_blockref_stats(const blockref_stats_t *, bool);
115 static int verify_volume_header(const hammer2_volume_data_t *);
116 static int read_media(int, const hammer2_blockref_t *, hammer2_media_data_t *,
117     size_t *);
118 static int verify_blockref(int, const hammer2_volume_data_t *,
119     const hammer2_blockref_t *, bool, blockref_stats_t *);
120 static int init_pfs_blockref(int, const hammer2_volume_data_t *,
121     const hammer2_blockref_t *, struct blockref_list *);
122 static void cleanup_pfs_blockref(struct blockref_list *);
123 static void print_media(FILE *, int, const hammer2_blockref_t *,
124     hammer2_media_data_t *);
125 static const char* hammer2_blockref_to_str(uint8_t);
126
127 static int best_zone = -1;
128
129 #define TAB 8
130
131 static void
132 tfprintf(FILE *fp, int tab, const char *ctl, ...)
133 {
134         va_list va;
135         int ret;
136
137         ret = fprintf(fp, "%*s", tab * TAB, "");
138         if (ret < 0)
139                 return;
140
141         va_start(va, ctl);
142         vfprintf(fp, ctl, va);
143         va_end(va);
144 }
145
146 static void
147 tsnprintf(char *str, size_t siz, int tab, const char *ctl, ...)
148 {
149         va_list va;
150         int ret;
151
152         ret = snprintf(str, siz, "%*s", tab * TAB, "");
153         if (ret < 0 || ret >= (int)siz)
154                 return;
155
156         va_start(va, ctl);
157         vsnprintf(str + ret, siz, ctl, va);
158         va_end(va);
159 }
160
161 static void
162 tprintf_zone(int tab, int i, const hammer2_blockref_t *bref)
163 {
164         tfprintf(stdout, tab, "zone.%d %016jx%s\n",
165             i, (uintmax_t)bref->data_off,
166             (!ScanBest && i == best_zone) ? " (best)" : "");
167 }
168
169 static void
170 init_root_blockref(int fd, int i, uint8_t type, hammer2_blockref_t *bref)
171 {
172         assert(type == HAMMER2_BREF_TYPE_EMPTY ||
173                 type == HAMMER2_BREF_TYPE_VOLUME ||
174                 type == HAMMER2_BREF_TYPE_FREEMAP);
175         memset(bref, 0, sizeof(*bref));
176         bref->type = type;
177         bref->data_off = (i * HAMMER2_ZONE_BYTES64) | HAMMER2_PBUFRADIX;
178
179         lseek(fd, bref->data_off & ~HAMMER2_OFF_MASK_RADIX, SEEK_SET);
180 }
181
182 static int
183 find_best_zone(int fd)
184 {
185         hammer2_blockref_t best;
186         int i, best_i = -1;
187
188         memset(&best, 0, sizeof(best));
189
190         for (i = 0; i < HAMMER2_NUM_VOLHDRS; ++i) {
191                 hammer2_volume_data_t voldata;
192                 hammer2_blockref_t broot;
193                 ssize_t ret;
194
195                 init_root_blockref(fd, i, HAMMER2_BREF_TYPE_EMPTY, &broot);
196                 ret = read(fd, &voldata, HAMMER2_PBUFSIZE);
197                 if (ret == HAMMER2_PBUFSIZE) {
198                         if ((voldata.magic != HAMMER2_VOLUME_ID_HBO) &&
199                             (voldata.magic != HAMMER2_VOLUME_ID_ABO))
200                                 continue;
201                         broot.mirror_tid = voldata.mirror_tid;
202                         if (best_i < 0 || best.mirror_tid < broot.mirror_tid) {
203                                 best_i = i;
204                                 best = broot;
205                         }
206                 } else if (ret == -1) {
207                         perror("read");
208                         return -1;
209                 } else {
210                         tfprintf(stderr, 1, "Failed to read volume header\n");
211                         return -1;
212                 }
213         }
214
215         return best_i;
216 }
217
218 static int
219 test_volume_header(int fd)
220 {
221         bool failed = false;
222         int i;
223
224         for (i = 0; i < HAMMER2_NUM_VOLHDRS; ++i) {
225                 hammer2_volume_data_t voldata;
226                 hammer2_blockref_t broot;
227                 ssize_t ret;
228
229                 if (ScanBest && i != best_zone)
230                         continue;
231                 init_root_blockref(fd, i, HAMMER2_BREF_TYPE_EMPTY, &broot);
232                 ret = read(fd, &voldata, HAMMER2_PBUFSIZE);
233                 if (ret == HAMMER2_PBUFSIZE) {
234                         tprintf_zone(0, i, &broot);
235                         if (verify_volume_header(&voldata) == -1)
236                                 failed = true;
237                 } else if (ret == -1) {
238                         perror("read");
239                         return -1;
240                 } else {
241                         tfprintf(stderr, 1, "Failed to read volume header\n");
242                         return -1;
243                 }
244         }
245
246         return failed ? -1 : 0;
247 }
248
249 static int
250 test_blockref(int fd, uint8_t type)
251 {
252         bool failed = false;
253         int i;
254
255         for (i = 0; i < HAMMER2_NUM_VOLHDRS; ++i) {
256                 hammer2_volume_data_t voldata;
257                 hammer2_blockref_t broot;
258                 ssize_t ret;
259
260                 if (ScanBest && i != best_zone)
261                         continue;
262                 init_root_blockref(fd, i, type, &broot);
263                 ret = read(fd, &voldata, HAMMER2_PBUFSIZE);
264                 if (ret == HAMMER2_PBUFSIZE) {
265                         blockref_stats_t bstats;
266                         init_blockref_stats(&bstats, type);
267                         tprintf_zone(0, i, &broot);
268                         if (verify_blockref(fd, &voldata, &broot, false,
269                             &bstats) == -1)
270                                 failed = true;
271                         print_blockref_stats(&bstats, true);
272                         print_blockref_entry(fd, &bstats.root);
273                         cleanup_blockref_stats(&bstats);
274                 } else if (ret == -1) {
275                         perror("read");
276                         return -1;
277                 } else {
278                         tfprintf(stderr, 1, "Failed to read volume header\n");
279                         return -1;
280                 }
281         }
282
283         return failed ? -1 : 0;
284 }
285
286 static int
287 test_pfs_blockref(int fd, const char *name)
288 {
289         uint8_t type = HAMMER2_BREF_TYPE_VOLUME;
290         bool failed = false;
291         int i;
292
293         for (i = 0; i < HAMMER2_NUM_VOLHDRS; ++i) {
294                 hammer2_volume_data_t voldata;
295                 hammer2_blockref_t broot;
296                 ssize_t ret;
297
298                 if (ScanBest && i != best_zone)
299                         continue;
300                 init_root_blockref(fd, i, type, &broot);
301                 ret = read(fd, &voldata, HAMMER2_PBUFSIZE);
302                 if (ret == HAMMER2_PBUFSIZE) {
303                         struct blockref_list blist;
304                         struct blockref_msg *p;
305                         int count = 0;
306
307                         tprintf_zone(0, i, &broot);
308                         TAILQ_INIT(&blist);
309                         if (init_pfs_blockref(fd, &voldata, &broot, &blist) ==
310                             -1) {
311                                 tfprintf(stderr, 1, "Failed to read PFS "
312                                     "blockref\n");
313                                 failed = true;
314                                 continue;
315                         }
316                         if (TAILQ_EMPTY(&blist)) {
317                                 tfprintf(stderr, 1, "Failed to find PFS "
318                                     "blockref\n");
319                                 failed = true;
320                                 continue;
321                         }
322                         TAILQ_FOREACH(p, &blist, entry) {
323                                 blockref_stats_t bstats;
324                                 if (name && strcmp(name, p->msg))
325                                         continue;
326                                 count++;
327                                 tfprintf(stdout, 1, "%s\n", p->msg);
328                                 init_blockref_stats(&bstats, type);
329                                 if (verify_blockref(fd, &voldata, &p->bref,
330                                     false, &bstats) == -1)
331                                         failed = true;
332                                 print_blockref_stats(&bstats, true);
333                                 print_blockref_entry(fd, &bstats.root);
334                                 cleanup_blockref_stats(&bstats);
335                         }
336                         cleanup_pfs_blockref(&blist);
337                         if (name && !count) {
338                                 tfprintf(stderr, 1, "PFS \"%s\" not found\n",
339                                     name);
340                                 failed = true;
341                         }
342                 } else if (ret == -1) {
343                         perror("read");
344                         return -1;
345                 } else {
346                         tfprintf(stderr, 1, "Failed to read volume header\n");
347                         return -1;
348                 }
349         }
350
351         return failed ? -1 : 0;
352 }
353
354 static int
355 charsperline(void)
356 {
357         int columns;
358         char *cp;
359         struct winsize ws;
360
361         columns = 0;
362         if (ioctl(0, TIOCGWINSZ, &ws) != -1)
363                 columns = ws.ws_col;
364         if (columns == 0 && (cp = getenv("COLUMNS")))
365                 columns = atoi(cp);
366         if (columns == 0)
367                 columns = 80;   /* last resort */
368
369         return columns;
370 }
371
372 static void
373 cleanup_blockref_msg(struct blockref_list *head)
374 {
375         struct blockref_msg *p;
376
377         while ((p = TAILQ_FIRST(head)) != NULL) {
378                 TAILQ_REMOVE(head, p, entry);
379                 free(p->msg);
380                 free(p);
381         }
382         assert(TAILQ_EMPTY(head));
383 }
384
385 static void
386 cleanup_blockref_entry(struct blockref_tree *root)
387 {
388         struct blockref_entry *e;
389
390         while ((e = RB_ROOT(root)) != NULL) {
391                 RB_REMOVE(blockref_tree, root, e);
392                 cleanup_blockref_msg(&e->head);
393                 free(e);
394         }
395         assert(RB_EMPTY(root));
396 }
397
398 static void
399 add_blockref_msg(struct blockref_list *head, const hammer2_blockref_t *bref,
400     const char *msg)
401 {
402         struct blockref_msg *m;
403
404         m = calloc(1, sizeof(*m));
405         assert(m);
406         m->bref = *bref;
407         m->msg = strdup(msg);
408
409         TAILQ_INSERT_TAIL(head, m, entry);
410 }
411
412 static void
413 add_blockref_entry(struct blockref_tree *root, const hammer2_blockref_t *bref,
414     const char *msg)
415 {
416         struct blockref_entry *e;
417
418         e = RB_LOOKUP(blockref_tree, root, bref->data_off);
419         if (!e) {
420                 e = calloc(1, sizeof(*e));
421                 assert(e);
422                 TAILQ_INIT(&e->head);
423                 e->data_off = bref->data_off;
424         }
425
426         add_blockref_msg(&e->head, bref, msg);
427
428         RB_INSERT(blockref_tree, root, e);
429 }
430
431 static void
432 print_blockref_msg(int fd, struct blockref_list *head)
433 {
434         struct blockref_msg *m;
435
436         TAILQ_FOREACH(m, head, entry) {
437                 hammer2_blockref_t *bref = &m->bref;
438                 hammer2_media_data_t media;
439
440                 tfprintf(stderr, 1, "%016jx %-12s %016jx/%-2d \"%s\"\n",
441                     (uintmax_t)bref->data_off,
442                     hammer2_blockref_to_str(bref->type),
443                     (uintmax_t)bref->key,
444                     bref->keybits,
445                     m->msg);
446
447                 if (fd != -1 && VerboseOpt > 0) {
448                         if (!read_media(fd, bref, &media, NULL))
449                                 print_media(stderr, 2, bref, &media);
450                         else
451                                 tfprintf(stderr, 2, "Failed to read media\n");
452                 }
453         }
454 }
455
456 static void
457 print_blockref_entry(int fd, struct blockref_tree *root)
458 {
459         struct blockref_entry *e;
460
461         RB_FOREACH(e, blockref_tree, root)
462                 print_blockref_msg(fd, &e->head);
463 }
464
465 static void
466 init_blockref_stats(blockref_stats_t *bstats, uint8_t type)
467 {
468         memset(bstats, 0, sizeof(*bstats));
469         RB_INIT(&bstats->root);
470         bstats->type = type;
471 }
472
473 static void
474 cleanup_blockref_stats(blockref_stats_t *bstats)
475 {
476         cleanup_blockref_entry(&bstats->root);
477 }
478
479 static void
480 print_blockref_stats(const blockref_stats_t *bstats, bool newline)
481 {
482         size_t siz = charsperline();
483         char *buf = calloc(1, siz);
484
485         assert(buf);
486
487         switch (bstats->type) {
488         case HAMMER2_BREF_TYPE_VOLUME:
489                 tsnprintf(buf, siz, 1, "%ju blockref (%ju inode, %ju indirect, "
490                     "%ju data, %ju dirent, %ju empty), %s",
491                     (uintmax_t)bstats->total_blockref,
492                     (uintmax_t)bstats->volume.total_inode,
493                     (uintmax_t)bstats->volume.total_indirect,
494                     (uintmax_t)bstats->volume.total_data,
495                     (uintmax_t)bstats->volume.total_dirent,
496                     (uintmax_t)bstats->total_empty,
497                     sizetostr(bstats->total_bytes));
498                 break;
499         case HAMMER2_BREF_TYPE_FREEMAP:
500                 tsnprintf(buf, siz, 1, "%ju blockref (%ju node, %ju leaf, "
501                     "%ju empty), %s",
502                     (uintmax_t)bstats->total_blockref,
503                     (uintmax_t)bstats->freemap.total_freemap_node,
504                     (uintmax_t)bstats->freemap.total_freemap_leaf,
505                     (uintmax_t)bstats->total_empty,
506                     sizetostr(bstats->total_bytes));
507                 break;
508         default:
509                 assert(0);
510                 break;
511         }
512
513         if (newline) {
514                 printf("%s\n", buf);
515         } else {
516                 printf("%s\r", buf);
517                 fflush(stdout);
518         }
519         free(buf);
520 }
521
522 static int
523 verify_volume_header(const hammer2_volume_data_t *voldata)
524 {
525         hammer2_crc32_t crc0, crc1;
526         const char *p = (const char*)voldata;
527
528         if ((voldata->magic != HAMMER2_VOLUME_ID_HBO) &&
529             (voldata->magic != HAMMER2_VOLUME_ID_ABO)) {
530                 tfprintf(stderr, 1, "Bad magic %jX\n", voldata->magic);
531                 return -1;
532         }
533
534         if (voldata->magic == HAMMER2_VOLUME_ID_ABO)
535                 tfprintf(stderr, 1, "Reverse endian\n");
536
537         crc0 = voldata->icrc_sects[HAMMER2_VOL_ICRC_SECT0];
538         crc1 = hammer2_icrc32(p + HAMMER2_VOLUME_ICRC0_OFF,
539             HAMMER2_VOLUME_ICRC0_SIZE);
540         if (crc0 != crc1) {
541                 tfprintf(stderr, 1, "Bad HAMMER2_VOL_ICRC_SECT0 CRC\n");
542                 return -1;
543         }
544
545         crc0 = voldata->icrc_sects[HAMMER2_VOL_ICRC_SECT1];
546         crc1 = hammer2_icrc32(p + HAMMER2_VOLUME_ICRC1_OFF,
547             HAMMER2_VOLUME_ICRC1_SIZE);
548         if (crc0 != crc1) {
549                 tfprintf(stderr, 1, "Bad HAMMER2_VOL_ICRC_SECT1 CRC\n");
550                 return -1;
551         }
552
553         crc0 = voldata->icrc_volheader;
554         crc1 = hammer2_icrc32(p + HAMMER2_VOLUME_ICRCVH_OFF,
555             HAMMER2_VOLUME_ICRCVH_SIZE);
556         if (crc0 != crc1) {
557                 tfprintf(stderr, 1, "Bad volume header CRC\n");
558                 return -1;
559         }
560
561         return 0;
562 }
563
564 static int
565 read_media(int fd, const hammer2_blockref_t *bref, hammer2_media_data_t *media,
566     size_t *media_bytes)
567 {
568         hammer2_off_t io_off, io_base;
569         size_t bytes, io_bytes, boff;
570
571         bytes = (bref->data_off & HAMMER2_OFF_MASK_RADIX);
572         if (bytes)
573                 bytes = (size_t)1 << bytes;
574         if (media_bytes)
575                 *media_bytes = bytes;
576
577         if (!bytes)
578                 return 0;
579
580         io_off = bref->data_off & ~HAMMER2_OFF_MASK_RADIX;
581         io_base = io_off & ~(hammer2_off_t)(HAMMER2_MINIOSIZE - 1);
582         boff = io_off - io_base;
583
584         io_bytes = HAMMER2_MINIOSIZE;
585         while (io_bytes + boff < bytes)
586                 io_bytes <<= 1;
587
588         if (io_bytes > sizeof(*media))
589                 return -1;
590         lseek(fd, io_base, SEEK_SET);
591         if (read(fd, media, io_bytes) != (ssize_t)io_bytes)
592                 return -2;
593         if (boff)
594                 memcpy(media, (char *)media + boff, bytes);
595
596         return 0;
597 }
598
599 static int
600 verify_blockref(int fd, const hammer2_volume_data_t *voldata,
601     const hammer2_blockref_t *bref, bool norecurse, blockref_stats_t *bstats)
602 {
603         hammer2_media_data_t media;
604         hammer2_blockref_t *bscan;
605         int i, bcount;
606         bool failed = false;
607         size_t bytes;
608         uint32_t cv;
609         uint64_t cv64;
610         char msg[256];
611
612         SHA256_CTX hash_ctx;
613         union {
614                 uint8_t digest[SHA256_DIGEST_LENGTH];
615                 uint64_t digest64[SHA256_DIGEST_LENGTH/8];
616         } u;
617
618         bstats->total_blockref++;
619
620         switch (bref->type) {
621         case HAMMER2_BREF_TYPE_EMPTY:
622                 bstats->total_empty++;
623                 break;
624         case HAMMER2_BREF_TYPE_INODE:
625                 bstats->volume.total_inode++;
626                 break;
627         case HAMMER2_BREF_TYPE_INDIRECT:
628                 bstats->volume.total_indirect++;
629                 break;
630         case HAMMER2_BREF_TYPE_DATA:
631                 bstats->volume.total_data++;
632                 break;
633         case HAMMER2_BREF_TYPE_DIRENT:
634                 bstats->volume.total_dirent++;
635                 break;
636         case HAMMER2_BREF_TYPE_FREEMAP_NODE:
637                 bstats->freemap.total_freemap_node++;
638                 break;
639         case HAMMER2_BREF_TYPE_FREEMAP_LEAF:
640                 bstats->freemap.total_freemap_leaf++;
641                 break;
642         case HAMMER2_BREF_TYPE_VOLUME:
643                 bstats->total_blockref--;
644                 break;
645         case HAMMER2_BREF_TYPE_FREEMAP:
646                 bstats->total_blockref--;
647                 break;
648         default:
649                 bstats->total_invalid++;
650                 snprintf(msg, sizeof(msg), "Invalid blockref type %d",
651                     bref->type);
652                 add_blockref_entry(&bstats->root, bref, msg);
653                 failed = true;
654                 break;
655         }
656
657         switch (read_media(fd, bref, &media, &bytes)) {
658         case -1:
659                 add_blockref_entry(&bstats->root, bref, "Bad I/O bytes");
660                 return -1;
661         case -2:
662                 add_blockref_entry(&bstats->root, bref, "Failed to read media");
663                 return -1;
664         default:
665                 break;
666         }
667
668         if (bref->type != HAMMER2_BREF_TYPE_VOLUME &&
669             bref->type != HAMMER2_BREF_TYPE_FREEMAP)
670                 bstats->total_bytes += bytes;
671
672         if (QuietOpt <= 0 && (bstats->total_blockref % 100) == 0)
673                 print_blockref_stats(bstats, false);
674
675         if (!bytes)
676                 return 0;
677
678         switch (HAMMER2_DEC_CHECK(bref->methods)) {
679         case HAMMER2_CHECK_ISCSI32:
680                 cv = hammer2_icrc32(&media, bytes);
681                 if (bref->check.iscsi32.value != cv) {
682                         add_blockref_entry(&bstats->root, bref,
683                             "Bad HAMMER2_CHECK_ISCSI32");
684                         failed = true;
685                 }
686                 break;
687         case HAMMER2_CHECK_XXHASH64:
688                 cv64 = XXH64(&media, bytes, XXH_HAMMER2_SEED);
689                 if (bref->check.xxhash64.value != cv64) {
690                         add_blockref_entry(&bstats->root, bref,
691                             "Bad HAMMER2_CHECK_XXHASH64");
692                         failed = true;
693                 }
694                 break;
695         case HAMMER2_CHECK_SHA192:
696                 SHA256_Init(&hash_ctx);
697                 SHA256_Update(&hash_ctx, &media, bytes);
698                 SHA256_Final(u.digest, &hash_ctx);
699                 u.digest64[2] ^= u.digest64[3];
700                 if (memcmp(u.digest, bref->check.sha192.data,
701                     sizeof(bref->check.sha192.data))) {
702                         add_blockref_entry(&bstats->root, bref,
703                             "Bad HAMMER2_CHECK_SHA192");
704                         failed = true;
705                 }
706                 break;
707         case HAMMER2_CHECK_FREEMAP:
708                 cv = hammer2_icrc32(&media, bytes);
709                 if (bref->check.freemap.icrc32 != cv) {
710                         add_blockref_entry(&bstats->root, bref,
711                             "Bad HAMMER2_CHECK_FREEMAP");
712                         failed = true;
713                 }
714                 break;
715         }
716
717         switch (bref->type) {
718         case HAMMER2_BREF_TYPE_INODE:
719                 if (!(media.ipdata.meta.op_flags & HAMMER2_OPFLAG_DIRECTDATA)) {
720                         bscan = &media.ipdata.u.blockset.blockref[0];
721                         bcount = HAMMER2_SET_COUNT;
722                 } else {
723                         bscan = NULL;
724                         bcount = 0;
725                 }
726                 break;
727         case HAMMER2_BREF_TYPE_INDIRECT:
728                 bscan = &media.npdata[0];
729                 bcount = bytes / sizeof(hammer2_blockref_t);
730                 break;
731         case HAMMER2_BREF_TYPE_FREEMAP_NODE:
732                 bscan = &media.npdata[0];
733                 bcount = bytes / sizeof(hammer2_blockref_t);
734                 break;
735         case HAMMER2_BREF_TYPE_VOLUME:
736                 bscan = &media.voldata.sroot_blockset.blockref[0];
737                 bcount = HAMMER2_SET_COUNT;
738                 break;
739         case HAMMER2_BREF_TYPE_FREEMAP:
740                 bscan = &media.voldata.freemap_blockset.blockref[0];
741                 bcount = HAMMER2_SET_COUNT;
742                 break;
743         default:
744                 bscan = NULL;
745                 bcount = 0;
746                 break;
747         }
748
749         if (ForceOpt)
750                 norecurse = false;
751         /*
752          * If failed, no recurse, but still verify its direct children.
753          * Beyond that is probably garbage.
754          */
755         for (i = 0; norecurse == false && i < bcount; ++i)
756                 if (bscan[i].type != HAMMER2_BREF_TYPE_EMPTY)
757                         if (verify_blockref(fd, voldata, &bscan[i], failed,
758                             bstats) == -1)
759                                 return -1;
760         return failed ? -1 : 0;
761 }
762
763 static int
764 init_pfs_blockref(int fd, const hammer2_volume_data_t *voldata,
765     const hammer2_blockref_t *bref, struct blockref_list *blist)
766 {
767         hammer2_media_data_t media;
768         hammer2_inode_data_t ipdata;
769         hammer2_blockref_t *bscan;
770         int i, bcount;
771         size_t bytes;
772
773         if (read_media(fd, bref, &media, &bytes))
774                 return -1;
775         if (!bytes)
776                 return 0;
777
778         switch (bref->type) {
779         case HAMMER2_BREF_TYPE_INODE:
780                 ipdata = media.ipdata;
781                 if (ipdata.meta.pfs_type & HAMMER2_PFSTYPE_SUPROOT) {
782                         bscan = &ipdata.u.blockset.blockref[0];
783                         bcount = HAMMER2_SET_COUNT;
784                 } else {
785                         bscan = NULL;
786                         bcount = 0;
787                         if (ipdata.meta.op_flags & HAMMER2_OPFLAG_PFSROOT) {
788                                 struct blockref_msg *p;
789                                 p = calloc(1, sizeof(*p));
790                                 assert(p);
791                                 p->bref = *bref;
792                                 p->msg = strdup(ipdata.filename);
793                                 TAILQ_INSERT_TAIL(blist, p, entry);
794                         } else
795                                 assert(0); /* should only see SUPROOT or PFS */
796                 }
797                 break;
798         case HAMMER2_BREF_TYPE_INDIRECT:
799                 bscan = &media.npdata[0];
800                 bcount = bytes / sizeof(hammer2_blockref_t);
801                 break;
802         case HAMMER2_BREF_TYPE_VOLUME:
803                 bscan = &media.voldata.sroot_blockset.blockref[0];
804                 bcount = HAMMER2_SET_COUNT;
805                 break;
806         default:
807                 bscan = NULL;
808                 bcount = 0;
809                 break;
810         }
811
812         for (i = 0; i < bcount; ++i)
813                 if (bscan[i].type != HAMMER2_BREF_TYPE_EMPTY)
814                         if (init_pfs_blockref(fd, voldata, &bscan[i], blist)
815                             == -1)
816                                 return -1;
817         return 0;
818 }
819
820 static void
821 cleanup_pfs_blockref(struct blockref_list *blist)
822 {
823         cleanup_blockref_msg(blist);
824 }
825
826 static void
827 print_media(FILE *fp, int tab, const hammer2_blockref_t *bref,
828     hammer2_media_data_t *media)
829 {
830         hammer2_inode_data_t *ipdata;
831         int i, namelen;
832         char *str = NULL;
833
834         switch (bref->type) {
835         case HAMMER2_BREF_TYPE_INODE:
836                 ipdata = &media->ipdata;
837                 namelen = ipdata->meta.name_len;
838                 if (namelen > HAMMER2_INODE_MAXNAME)
839                         namelen = 0;
840                 tfprintf(fp, tab, "filename \"%*.*s\"\n", namelen, namelen,
841                     ipdata->filename);
842                 tfprintf(fp, tab, "version %d\n", ipdata->meta.version);
843                 tfprintf(fp, tab, "pfs_subtype %d\n", ipdata->meta.pfs_subtype);
844                 tfprintf(fp, tab, "uflags 0x%08x\n", ipdata->meta.uflags);
845                 if (ipdata->meta.rmajor || ipdata->meta.rminor) {
846                         tfprintf(fp, tab, "rmajor %d\n", ipdata->meta.rmajor);
847                         tfprintf(fp, tab, "rminor %d\n", ipdata->meta.rminor);
848                 }
849                 tfprintf(fp, tab, "ctime %s\n",
850                     hammer2_time64_to_str(ipdata->meta.ctime, &str));
851                 tfprintf(fp, tab, "mtime %s\n",
852                     hammer2_time64_to_str(ipdata->meta.mtime, &str));
853                 tfprintf(fp, tab, "atime %s\n",
854                     hammer2_time64_to_str(ipdata->meta.atime, &str));
855                 tfprintf(fp, tab, "btime %s\n",
856                     hammer2_time64_to_str(ipdata->meta.btime, &str));
857                 tfprintf(fp, tab, "uid %s\n",
858                     hammer2_uuid_to_str(&ipdata->meta.uid, &str));
859                 tfprintf(fp, tab, "gid %s\n",
860                     hammer2_uuid_to_str(&ipdata->meta.gid, &str));
861                 tfprintf(fp, tab, "type %s\n",
862                     hammer2_iptype_to_str(ipdata->meta.type));
863                 tfprintf(fp, tab, "op_flags 0x%02x\n", ipdata->meta.op_flags);
864                 tfprintf(fp, tab, "cap_flags 0x%04x\n", ipdata->meta.cap_flags);
865                 tfprintf(fp, tab, "mode %-7o\n", ipdata->meta.mode);
866                 tfprintf(fp, tab, "inum 0x%016jx\n", ipdata->meta.inum);
867                 tfprintf(fp, tab, "size %ju ", (uintmax_t)ipdata->meta.size);
868                 if (ipdata->meta.op_flags & HAMMER2_OPFLAG_DIRECTDATA &&
869                     ipdata->meta.size <= HAMMER2_EMBEDDED_BYTES)
870                         printf("(embedded data)\n");
871                 else
872                         printf("\n");
873                 tfprintf(fp, tab, "nlinks %ju\n",
874                     (uintmax_t)ipdata->meta.nlinks);
875                 tfprintf(fp, tab, "iparent 0x%016jx\n",
876                     (uintmax_t)ipdata->meta.iparent);
877                 tfprintf(fp, tab, "name_key 0x%016jx\n",
878                     (uintmax_t)ipdata->meta.name_key);
879                 tfprintf(fp, tab, "name_len %u\n", ipdata->meta.name_len);
880                 tfprintf(fp, tab, "ncopies %u\n", ipdata->meta.ncopies);
881                 tfprintf(fp, tab, "comp_algo %u\n", ipdata->meta.comp_algo);
882                 tfprintf(fp, tab, "target_type %u\n", ipdata->meta.target_type);
883                 tfprintf(fp, tab, "check_algo %u\n", ipdata->meta.check_algo);
884                 if ((ipdata->meta.op_flags & HAMMER2_OPFLAG_PFSROOT) ||
885                     ipdata->meta.pfs_type == HAMMER2_PFSTYPE_SUPROOT) {
886                         tfprintf(fp, tab, "pfs_nmasters %u\n",
887                             ipdata->meta.pfs_nmasters);
888                         tfprintf(fp, tab, "pfs_type %u (%s)\n",
889                             ipdata->meta.pfs_type,
890                             hammer2_pfstype_to_str(ipdata->meta.pfs_type));
891                         tfprintf(fp, tab, "pfs_inum 0x%016jx\n",
892                             (uintmax_t)ipdata->meta.pfs_inum);
893                         tfprintf(fp, tab, "pfs_clid %s\n",
894                             hammer2_uuid_to_str(&ipdata->meta.pfs_clid, &str));
895                         tfprintf(fp, tab, "pfs_fsid %s\n",
896                             hammer2_uuid_to_str(&ipdata->meta.pfs_fsid, &str));
897                         tfprintf(fp, tab, "pfs_lsnap_tid 0x%016jx\n",
898                             (uintmax_t)ipdata->meta.pfs_lsnap_tid);
899                 }
900                 tfprintf(fp, tab, "data_quota %ju\n",
901                     (uintmax_t)ipdata->meta.data_quota);
902                 tfprintf(fp, tab, "data_count %ju\n",
903                     (uintmax_t)bref->embed.stats.data_count);
904                 tfprintf(fp, tab, "inode_quota %ju\n",
905                     (uintmax_t)ipdata->meta.inode_quota);
906                 tfprintf(fp, tab, "inode_count %ju\n",
907                     (uintmax_t)bref->embed.stats.inode_count);
908                 break;
909         case HAMMER2_BREF_TYPE_DIRENT:
910                 if (bref->embed.dirent.namlen <= sizeof(bref->check.buf)) {
911                         tfprintf(fp, tab, "filename \"%*.*s\"\n",
912                             bref->embed.dirent.namlen,
913                             bref->embed.dirent.namlen,
914                             bref->check.buf);
915                 } else {
916                         tfprintf(fp, tab, "filename \"%*.*s\"\n",
917                             bref->embed.dirent.namlen,
918                             bref->embed.dirent.namlen,
919                             media->buf);
920                 }
921                 tfprintf(fp, tab, "inum 0x%016jx\n",
922                     (uintmax_t)bref->embed.dirent.inum);
923                 tfprintf(fp, tab, "namlen %d\n",
924                     (uintmax_t)bref->embed.dirent.namlen);
925                 tfprintf(fp, tab, "type %s\n",
926                     hammer2_iptype_to_str(bref->embed.dirent.type));
927                 break;
928         case HAMMER2_BREF_TYPE_FREEMAP_LEAF:
929                 for (i = 0; i < HAMMER2_FREEMAP_COUNT; ++i) {
930                         hammer2_off_t data_off = bref->key +
931                                 i * HAMMER2_FREEMAP_LEVEL0_SIZE;
932 #if HAMMER2_BMAP_ELEMENTS != 8
933 #error "HAMMER2_BMAP_ELEMENTS != 8"
934 #endif
935                         tfprintf(fp, tab, "%016jx %04d.%04x (avail=%7d) "
936                             "%016jx %016jx %016jx %016jx "
937                             "%016jx %016jx %016jx %016jx\n",
938                             data_off, i, media->bmdata[i].class,
939                             media->bmdata[i].avail,
940                             media->bmdata[i].bitmapq[0],
941                             media->bmdata[i].bitmapq[1],
942                             media->bmdata[i].bitmapq[2],
943                             media->bmdata[i].bitmapq[3],
944                             media->bmdata[i].bitmapq[4],
945                             media->bmdata[i].bitmapq[5],
946                             media->bmdata[i].bitmapq[6],
947                             media->bmdata[i].bitmapq[7]);
948                 }
949                 break;
950         default:
951                 break;
952         }
953         if (str)
954                 free(str);
955 }
956
957 static const char*
958 hammer2_blockref_to_str(uint8_t type)
959 {
960         switch (type) {
961         case HAMMER2_BREF_TYPE_EMPTY:
962                 return "empty";
963         case HAMMER2_BREF_TYPE_INODE:
964                 return "inode";
965         case HAMMER2_BREF_TYPE_INDIRECT:
966                 return "indirect";
967         case HAMMER2_BREF_TYPE_DATA:
968                 return "data";
969         case HAMMER2_BREF_TYPE_DIRENT:
970                 return "dirent";
971         case HAMMER2_BREF_TYPE_FREEMAP_NODE:
972                 return "freemap_node";
973         case HAMMER2_BREF_TYPE_FREEMAP_LEAF:
974                 return "freemap_leaf";
975         case HAMMER2_BREF_TYPE_FREEMAP:
976                 return "freemap";
977         case HAMMER2_BREF_TYPE_VOLUME:
978                 return "volume";
979         default:
980                 return NULL;
981         }
982         return NULL;
983 }
984
985 int
986 test_hammer2(const char *devpath)
987 {
988         struct stat st;
989         bool failed = false;
990         int fd;
991
992         fd = open(devpath, O_RDONLY);
993         if (fd == -1) {
994                 perror("open");
995                 return -1;
996         }
997
998         if (fstat(fd, &st) == -1) {
999                 perror("fstat");
1000                 failed = true;
1001                 goto end;
1002         }
1003         if (!S_ISCHR(st.st_mode)) {
1004                 fprintf(stderr, "%s is not a block device\n", devpath);
1005                 failed = true;
1006                 goto end;
1007         }
1008
1009         best_zone = find_best_zone(fd);
1010         if (best_zone == -1)
1011                 fprintf(stderr, "Failed to find best zone\n");
1012
1013         printf("volume header\n");
1014         if (test_volume_header(fd) == -1) {
1015                 failed = true;
1016                 if (!ForceOpt)
1017                         goto end;
1018         }
1019
1020         printf("freemap\n");
1021         if (test_blockref(fd, HAMMER2_BREF_TYPE_FREEMAP) == -1) {
1022                 failed = true;
1023                 if (!ForceOpt)
1024                         goto end;
1025         }
1026         printf("volume\n");
1027         if (!ScanPFS) {
1028                 if (test_blockref(fd, HAMMER2_BREF_TYPE_VOLUME) == -1) {
1029                         failed = true;
1030                         if (!ForceOpt)
1031                                 goto end;
1032                 }
1033         } else {
1034                 if (test_pfs_blockref(fd, PFSName) == -1) {
1035                         failed = true;
1036                         if (!ForceOpt)
1037                                 goto end;
1038                 }
1039         }
1040 end:
1041         close(fd);
1042
1043         return failed ? -1 : 0;
1044 }