2 * Copyright (c) 2000 Christoph Herrmann, Thomas-Henning von Kamptz
3 * Copyright (c) 1980, 1989, 1993 The Regents of the University of California.
6 * This code is derived from software contributed to Berkeley by
7 * Christoph Herrmann and Thomas-Henning von Kamptz, Munich and Frankfurt.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. All advertising materials mentioning features or use of this software
18 * must display the following acknowledgment:
19 * This product includes software developed by the University of
20 * California, Berkeley and its contributors, as well as Christoph
21 * Herrmann and Thomas-Henning von Kamptz.
22 * 4. Neither the name of the University nor the names of its contributors
23 * may be used to endorse or promote products derived from this software
24 * without specific prior written permission.
26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 * $TSHeader: src/sbin/ffsinfo/ffsinfo.c,v 1.4 2000/12/12 19:30:55 tomsoft Exp $
43 static const char copyright[] =
44 "@(#) Copyright (c) 2000 Christoph Herrmann, Thomas-Henning von Kamptz\n\
45 Copyright (c) 1980, 1989, 1993 The Regents of the University of California.\n\
46 All rights reserved.\n";
50 static const char rcsid[] =
54 /* ********************************************************** INCLUDES ***** */
55 #include <sys/param.h>
56 #include <sys/disklabel.h>
70 /* *********************************************************** GLOBALS ***** */
72 int _dbg_lvl_ = (DL_INFO); /* DL_TRC */
79 #define sblock fsun1.fs
80 #define osblock fsun2.fs
88 static char ablk[MAXBSIZE];
89 static char i1blk[MAXBSIZE];
90 static char i2blk[MAXBSIZE];
91 static char i3blk[MAXBSIZE];
93 static struct csum *fscs;
95 /* ******************************************************** PROTOTYPES ***** */
96 static void rdfs(daddr_t, size_t, void *, int);
97 static void usage(void);
98 static struct disklabel *get_disklabel(int);
99 static struct dinode *ginode(ino_t, int);
100 static void dump_whole_inode(ino_t, int, int);
102 /* ************************************************************** rdfs ***** */
104 * Here we read some block(s) from disk.
107 rdfs(daddr_t bno, size_t size, void *bf, int fsi)
114 if (lseek(fsi, (off_t)bno * DEV_BSIZE, 0) < 0) {
115 err(33, "rdfs: seek error: %ld", (long)bno);
117 n = read(fsi, bf, size);
118 if (n != (ssize_t)size) {
119 err(34, "rdfs: read error: %ld", (long)bno);
126 /* ************************************************************** main ***** */
128 * ffsinfo(8) is a tool to dump all metadata of a file system. It helps to find
129 * errors is the file system much easier. You can run ffsinfo before and after
130 * an fsck(8), and compare the two ascii dumps easy with diff, and you see
131 * directly where the problem is. You can control how much detail you want to
132 * see with some command line arguments. You can also easy check the status
133 * of a file system, like is there is enough space for growing a file system,
134 * or how many active snapshots do we have. It provides much more detailed
135 * information then dumpfs. Snapshots, as they are very new, are not really
136 * supported. They are just mentioned currently, but it is planned to run
137 * also over active snapshots, to even get that output.
140 main(int argc, char **argv)
143 char *device, *special, *cp;
147 struct disklabel *lp;
148 struct partition *pp;
150 struct csum *dbg_csp;
154 int cfg_cg, cfg_in, cfg_lv;
155 int cg_start, cg_stop;
165 out_file=strdup("/var/tmp/ffsinfo");
166 if(out_file == NULL) {
167 errx(1, "strdup failed");
170 while ((ch=getopt(argc, argv, "Lg:i:l:o:")) != -1) {
189 if(cfg_lv < 0x1||cfg_lv > 0x3ff) {
195 out_file=strdup(optarg);
196 if(out_file == NULL) {
197 errx(1, "strdup failed");
215 * Now we try to guess the (raw)device name.
217 if (0 == strrchr(device, '/') && (stat(device, &st) == -1)) {
219 * No path prefix was given, so try in that order:
225 * FreeBSD now doesn't distinguish between raw and block
226 * devices any longer, but it should still work this way.
228 len=strlen(device)+strlen(_PATH_DEV)+2+strlen("vinum/");
229 special=(char *)malloc(len);
230 if(special == NULL) {
231 errx(1, "malloc failed");
233 snprintf(special, len, "%sr%s", _PATH_DEV, device);
234 if (stat(special, &st) == -1) {
235 snprintf(special, len, "%s%s", _PATH_DEV, device);
236 if (stat(special, &st) == -1) {
237 snprintf(special, len, "%svinum/r%s",
239 if (stat(special, &st) == -1) {
241 * For now this is the 'last resort'.
243 snprintf(special, len, "%svinum/%s",
252 * Open our device for reading.
254 fsi = open(device, O_RDONLY);
256 err(1, "%s", device);
261 if(S_ISREG(st.st_mode)) { /* label check not supported for files */
267 * Try to read a label and gess the slice if not specified.
268 * This code should guess the right thing and avaid to bother
269 * the user user with the task of specifying the option -v on
272 cp=device+strlen(device)-1;
273 lp = get_disklabel(fsi);
274 if(lp->d_type == DTYPE_VINUM) {
275 pp = &lp->d_partitions[0];
276 } else if (isdigit(*cp)) {
277 pp = &lp->d_partitions[2];
278 } else if (*cp>='a' && *cp<='h') {
279 pp = &lp->d_partitions[*cp - 'a'];
281 errx(1, "unknown device");
285 * Check if that partition looks suited for dumping.
287 if (pp->p_size < 1) {
288 errx(1, "partition is unavailable");
290 if (pp->p_fstype != FS_BSDFFS) {
291 errx(1, "partition not 4.2BSD");
296 * Read the current superblock.
298 rdfs((daddr_t)(SBOFF/DEV_BSIZE), (size_t)SBSIZE, (void *)&sblock, fsi);
299 if (sblock.fs_magic != FS_MAGIC) {
300 errx(1, "superblock not recognized");
303 DBG_OPEN(out_file); /* already here we need a superblock */
311 * Determine here what cylinder groups to dump.
315 cg_stop=sblock.fs_ncg;
316 } else if (cfg_cg==-1) {
317 cg_start=sblock.fs_ncg-1;
318 cg_stop=sblock.fs_ncg;
319 } else if (cfg_cg<sblock.fs_ncg) {
323 cg_start=sblock.fs_ncg;
324 cg_stop=sblock.fs_ncg;
327 if (cfg_lv & 0x004) {
328 fscs = (struct csum *)calloc((size_t)1,
329 (size_t)sblock.fs_cssize);
331 errx(1, "calloc failed");
335 * Get the cylinder summary into the memory ...
337 for (i = 0; i < sblock.fs_cssize; i += sblock.fs_bsize) {
338 rdfs(fsbtodb(&sblock, sblock.fs_csaddr +
339 numfrags(&sblock, i)), (size_t)(sblock.fs_cssize-i<
340 sblock.fs_bsize ? sblock.fs_cssize - i :
341 sblock.fs_bsize), (void *)(((char *)fscs)+i), fsi);
348 for(dbg_csc=0; dbg_csc<sblock.fs_ncg; dbg_csc++) {
349 snprintf(dbg_line, sizeof(dbg_line),
350 "%d. csum in fscs", dbg_csc);
351 DBG_DUMP_CSUM(&sblock,
358 * For each requested cylinder group ...
360 for(cylno=cg_start; cylno<cg_stop; cylno++) {
361 snprintf(dbg_line, sizeof(dbg_line), "cgr %d", cylno);
364 * ... dump the superblock copies ...
366 rdfs(fsbtodb(&sblock, cgsblock(&sblock, cylno)),
367 (size_t)SBSIZE, (void *)&osblock, fsi);
368 DBG_DUMP_FS(&osblock,
372 * ... read the cylinder group and dump whatever was requested.
374 rdfs(fsbtodb(&sblock, cgtod(&sblock, cylno)),
375 (size_t)sblock.fs_cgsize, (void *)&acg, fsi);
382 DBG_DUMP_INMAP(&sblock,
387 DBG_DUMP_FRMAP(&sblock,
392 DBG_DUMP_CLMAP(&sblock,
395 DBG_DUMP_CLSUM(&sblock,
400 DBG_DUMP_SPTBL(&sblock,
406 * Dump the requested inode(s).
409 dump_whole_inode((ino_t)cfg_in, fsi, cfg_lv);
411 for(in=cg_start*sblock.fs_ipg; in<(ino_t)cg_stop*sblock.fs_ipg;
413 dump_whole_inode(in, fsi, cfg_lv);
425 /* ************************************************** dump_whole_inode ***** */
427 * Here we dump a list of all blocks allocated by this inode. We follow
428 * all indirect blocks.
431 dump_whole_inode(ino_t inode, int fsi, int level)
433 DBG_FUNC("dump_whole_inode")
436 unsigned int ind2ctr, ind3ctr;
437 ufs_daddr_t *ind2ptr, *ind3ptr;
443 * Read the inode from disk/cache.
445 ino=ginode(inode, fsi);
447 if(ino->di_nlink==0) {
449 return; /* inode not in use */
453 * Dump the main inode structure.
455 snprintf(comment, sizeof(comment), "Inode 0x%08x", inode);
457 DBG_DUMP_INO(&sblock,
462 if (!(level & 0x200)) {
468 * Ok, now prepare for dumping all direct and indirect pointers.
470 rb=howmany(ino->di_size, sblock.fs_bsize)-NDADDR;
473 * Dump single indirect block.
475 rdfs(fsbtodb(&sblock, ino->di_ib[0]), (size_t)sblock.fs_bsize,
476 (void *)&i1blk, fsi);
477 snprintf(comment, sizeof(comment), "Inode 0x%08x: indirect 0",
479 DBG_DUMP_IBLK(&sblock,
483 rb-=howmany(sblock.fs_bsize, sizeof(ufs_daddr_t));
487 * Dump double indirect blocks.
489 rdfs(fsbtodb(&sblock, ino->di_ib[1]), (size_t)sblock.fs_bsize,
490 (void *)&i2blk, fsi);
491 snprintf(comment, sizeof(comment), "Inode 0x%08x: indirect 1",
493 DBG_DUMP_IBLK(&sblock,
496 howmany(rb, howmany(sblock.fs_bsize, sizeof(ufs_daddr_t))));
497 for(ind2ctr=0; ((ind2ctr < howmany(sblock.fs_bsize,
498 sizeof(ufs_daddr_t)))&&(rb>0)); ind2ctr++) {
499 ind2ptr=&((ufs_daddr_t *)(void *)&i2blk)[ind2ctr];
501 rdfs(fsbtodb(&sblock, *ind2ptr),
502 (size_t)sblock.fs_bsize, (void *)&i1blk, fsi);
503 snprintf(comment, sizeof(comment),
504 "Inode 0x%08x: indirect 1->%d", inode, ind2ctr);
505 DBG_DUMP_IBLK(&sblock,
509 rb-=howmany(sblock.fs_bsize, sizeof(ufs_daddr_t));
514 * Dump triple indirect blocks.
516 rdfs(fsbtodb(&sblock, ino->di_ib[2]), (size_t)sblock.fs_bsize,
517 (void *)&i3blk, fsi);
518 snprintf(comment, sizeof(comment), "Inode 0x%08x: indirect 2",
520 #define SQUARE(a) ((a)*(a))
521 DBG_DUMP_IBLK(&sblock,
525 SQUARE(howmany(sblock.fs_bsize, sizeof(ufs_daddr_t)))));
527 for(ind3ctr=0; ((ind3ctr < howmany(sblock.fs_bsize,
528 sizeof(ufs_daddr_t)))&&(rb>0)); ind3ctr ++) {
529 ind3ptr=&((ufs_daddr_t *)(void *)&i3blk)[ind3ctr];
531 rdfs(fsbtodb(&sblock, *ind3ptr),
532 (size_t)sblock.fs_bsize, (void *)&i2blk, fsi);
533 snprintf(comment, sizeof(comment),
534 "Inode 0x%08x: indirect 2->%d", inode, ind3ctr);
535 DBG_DUMP_IBLK(&sblock,
539 howmany(sblock.fs_bsize, sizeof(ufs_daddr_t))));
540 for(ind2ctr=0; ((ind2ctr < howmany(sblock.fs_bsize,
541 sizeof(ufs_daddr_t)))&&(rb>0)); ind2ctr ++) {
542 ind2ptr=&((ufs_daddr_t *)(void *)&i2blk)
544 rdfs(fsbtodb(&sblock, *ind2ptr),
545 (size_t)sblock.fs_bsize, (void *)&i1blk,
547 snprintf(comment, sizeof(comment),
548 "Inode 0x%08x: indirect 2->%d->%d", inode,
550 DBG_DUMP_IBLK(&sblock,
554 rb-=howmany(sblock.fs_bsize,
555 sizeof(ufs_daddr_t));
564 /* ***************************************************** get_disklabel ***** */
566 * Read the disklabel from disk.
569 get_disklabel(int fd)
571 DBG_FUNC("get_disklabel")
572 static struct disklabel *lab;
576 lab=(struct disklabel *)malloc(sizeof(struct disklabel));
578 errx(1, "malloc failed");
580 if (ioctl(fd, DIOCGDINFO, (char *)lab) < 0) {
581 errx(1, "DIOCGDINFO failed");
590 /* ************************************************************* usage ***** */
592 * Dump a line of usage.
602 "usage: ffsinfo [-L] [-g cylgrp] [-i inode] [-l level] "
604 " special | file\n");
610 /* ************************************************************ ginode ***** */
612 * This function provides access to an individual inode. We find out in which
613 * block the requested inode is located, read it from disk if needed, and
614 * return the pointer into that block. We maintain a cache of one block to
615 * not read the same block again and again if we iterate linearly over all
619 ginode(ino_t inumber, int fsi)
623 static ino_t startinum=0; /* first inode in cached block */
628 pi=(struct dinode *)(void *)ablk;
629 if (startinum == 0 || inumber < startinum ||
630 inumber >= startinum + INOPB(&sblock)) {
632 * The block needed is not cached, so we have to read it from
635 iblk = ino_to_fsba(&sblock, inumber);
636 rdfs(fsbtodb(&sblock, iblk), (size_t)sblock.fs_bsize,
638 startinum = (inumber / INOPB(&sblock)) * INOPB(&sblock);
642 return (&(pi[inumber % INOPB(&sblock)]));