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 $
39 * $FreeBSD: src/sbin/ffsinfo/ffsinfo.c,v 1.3.2.1 2001/07/16 15:01:56 tomsoft Exp $
40 * $DragonFly: src/sbin/ffsinfo/ffsinfo.c,v 1.4 2006/08/13 20:16:04 swildner Exp $
42 * @(#) Copyright (c) 2000 Christoph Herrmann, Thomas-Henning von Kamptz Copyright (c) 1980, 1989, 1993 The Regents of the University of California. All rights reserved.
43 * $FreeBSD: src/sbin/ffsinfo/ffsinfo.c,v 1.3.2.1 2001/07/16 15:01:56 tomsoft Exp $
46 /* ********************************************************** INCLUDES ***** */
47 #include <sys/param.h>
48 #include <sys/disklabel.h>
62 /* *********************************************************** GLOBALS ***** */
64 int _dbg_lvl_
= (DL_INFO
); /* DL_TRC */
71 #define sblock fsun1.fs
72 #define osblock fsun2.fs
80 static char ablk
[MAXBSIZE
];
81 static char i1blk
[MAXBSIZE
];
82 static char i2blk
[MAXBSIZE
];
83 static char i3blk
[MAXBSIZE
];
85 static struct csum
*fscs
;
87 /* ******************************************************** PROTOTYPES ***** */
88 static void rdfs(daddr_t
, size_t, void *, int);
89 static void usage(void);
90 static struct disklabel
*get_disklabel(int);
91 static struct ufs1_dinode
*ginode(ino_t
, int);
92 static void dump_whole_inode(ino_t
, int, int);
94 /* ************************************************************** rdfs ***** */
96 * Here we read some block(s) from disk.
99 rdfs(daddr_t bno
, size_t size
, void *bf
, int fsi
)
106 if (lseek(fsi
, (off_t
)bno
* DEV_BSIZE
, 0) < 0) {
107 err(33, "rdfs: seek error: %ld", (long)bno
);
109 n
= read(fsi
, bf
, size
);
110 if (n
!= (ssize_t
)size
) {
111 err(34, "rdfs: read error: %ld", (long)bno
);
118 /* ************************************************************** main ***** */
120 * ffsinfo(8) is a tool to dump all metadata of a filesystem. It helps to find
121 * errors is the filesystem much easier. You can run ffsinfo before and after
122 * an fsck(8), and compare the two ascii dumps easy with diff, and you see
123 * directly where the problem is. You can control how much detail you want to
124 * see with some command line arguments. You can also easy check the status
125 * of a filesystem, like is there is enough space for growing a filesystem,
126 * or how many active snapshots do we have. It provides much more detailed
127 * information then dumpfs. Snapshots, as they are very new, are not really
128 * supported. They are just mentioned currently, but it is planned to run
129 * also over active snapshots, to even get that output.
132 main(int argc
, char **argv
)
135 char *device
, *special
, *cp
;
139 struct disklabel
*lp
;
140 struct partition
*pp
;
142 struct csum
*dbg_csp
;
146 int cfg_cg
, cfg_in
, cfg_lv
;
147 int cg_start
, cg_stop
;
157 out_file
=strdup("/var/tmp/ffsinfo");
158 if(out_file
== NULL
) {
159 errx(1, "strdup failed");
162 while ((ch
=getopt(argc
, argv
, "Lg:i:l:o:")) != -1) {
181 if(cfg_lv
< 0x1||cfg_lv
> 0x3ff) {
187 out_file
=strdup(optarg
);
188 if(out_file
== NULL
) {
189 errx(1, "strdup failed");
207 * Now we try to guess the (raw)device name.
209 if (0 == strrchr(device
, '/') && (stat(device
, &st
) == -1)) {
211 * No path prefix was given, so try in that order:
217 * FreeBSD now doesn't distinguish between raw and block
218 * devices any longer, but it should still work this way.
220 len
=strlen(device
)+strlen(_PATH_DEV
)+2+strlen("vinum/");
221 special
=(char *)malloc(len
);
222 if(special
== NULL
) {
223 errx(1, "malloc failed");
225 snprintf(special
, len
, "%sr%s", _PATH_DEV
, device
);
226 if (stat(special
, &st
) == -1) {
227 snprintf(special
, len
, "%s%s", _PATH_DEV
, device
);
228 if (stat(special
, &st
) == -1) {
229 snprintf(special
, len
, "%svinum/r%s",
231 if (stat(special
, &st
) == -1) {
233 * For now this is the 'last resort'.
235 snprintf(special
, len
, "%svinum/%s",
244 * Open our device for reading.
246 fsi
= open(device
, O_RDONLY
);
248 err(1, "%s", device
);
253 if(S_ISREG(st
.st_mode
)) { /* label check not supported for files */
259 * Try to read a label and gess the slice if not specified.
260 * This code should guess the right thing and avaid to bother
261 * the user user with the task of specifying the option -v on
264 cp
=device
+strlen(device
)-1;
265 lp
= get_disklabel(fsi
);
266 if(lp
->d_type
== DTYPE_VINUM
) {
267 pp
= &lp
->d_partitions
[0];
268 } else if (isdigit(*cp
)) {
269 pp
= &lp
->d_partitions
[2];
270 } else if (*cp
>='a' && *cp
<='h') {
271 pp
= &lp
->d_partitions
[*cp
- 'a'];
273 errx(1, "unknown device");
277 * Check if that partition looks suited for dumping.
279 if (pp
->p_size
< 1) {
280 errx(1, "partition is unavailable");
282 if (pp
->p_fstype
!= FS_BSDFFS
) {
283 errx(1, "partition not 4.2BSD");
288 * Read the current superblock.
290 rdfs((daddr_t
)(SBOFF
/DEV_BSIZE
), (size_t)SBSIZE
, (void *)&sblock
, fsi
);
291 if (sblock
.fs_magic
!= FS_MAGIC
) {
292 errx(1, "superblock not recognized");
295 DBG_OPEN(out_file
); /* already here we need a superblock */
303 * Determine here what cylinder groups to dump.
307 cg_stop
=sblock
.fs_ncg
;
308 } else if (cfg_cg
==-1) {
309 cg_start
=sblock
.fs_ncg
-1;
310 cg_stop
=sblock
.fs_ncg
;
311 } else if (cfg_cg
<sblock
.fs_ncg
) {
315 cg_start
=sblock
.fs_ncg
;
316 cg_stop
=sblock
.fs_ncg
;
319 if (cfg_lv
& 0x004) {
320 fscs
= (struct csum
*)calloc((size_t)1,
321 (size_t)sblock
.fs_cssize
);
323 errx(1, "calloc failed");
327 * Get the cylinder summary into the memory ...
329 for (i
= 0; i
< sblock
.fs_cssize
; i
+= sblock
.fs_bsize
) {
330 rdfs(fsbtodb(&sblock
, sblock
.fs_csaddr
+
331 numfrags(&sblock
, i
)), (size_t)(sblock
.fs_cssize
-i
<
332 sblock
.fs_bsize
? sblock
.fs_cssize
- i
:
333 sblock
.fs_bsize
), (void *)(((char *)fscs
)+i
), fsi
);
340 for(dbg_csc
=0; dbg_csc
<sblock
.fs_ncg
; dbg_csc
++) {
341 snprintf(dbg_line
, sizeof(dbg_line
),
342 "%d. csum in fscs", dbg_csc
);
343 DBG_DUMP_CSUM(&sblock
,
350 * For each requested cylinder group ...
352 for(cylno
=cg_start
; cylno
<cg_stop
; cylno
++) {
353 snprintf(dbg_line
, sizeof(dbg_line
), "cgr %d", cylno
);
356 * ... dump the superblock copies ...
358 rdfs(fsbtodb(&sblock
, cgsblock(&sblock
, cylno
)),
359 (size_t)SBSIZE
, (void *)&osblock
, fsi
);
360 DBG_DUMP_FS(&osblock
,
364 * ... read the cylinder group and dump whatever was requested.
366 rdfs(fsbtodb(&sblock
, cgtod(&sblock
, cylno
)),
367 (size_t)sblock
.fs_cgsize
, (void *)&acg
, fsi
);
374 DBG_DUMP_INMAP(&sblock
,
379 DBG_DUMP_FRMAP(&sblock
,
384 DBG_DUMP_CLMAP(&sblock
,
387 DBG_DUMP_CLSUM(&sblock
,
392 DBG_DUMP_SPTBL(&sblock
,
398 * Dump the requested inode(s).
401 dump_whole_inode((ino_t
)cfg_in
, fsi
, cfg_lv
);
403 for(in
=cg_start
*sblock
.fs_ipg
; in
<(ino_t
)cg_stop
*sblock
.fs_ipg
;
405 dump_whole_inode(in
, fsi
, cfg_lv
);
417 /* ************************************************** dump_whole_inode ***** */
419 * Here we dump a list of all blocks allocated by this inode. We follow
420 * all indirect blocks.
423 dump_whole_inode(ino_t inode
, int fsi
, int level
)
425 DBG_FUNC("dump_whole_inode")
426 struct ufs1_dinode
*ino
;
428 unsigned int ind2ctr
, ind3ctr
;
429 ufs_daddr_t
*ind2ptr
, *ind3ptr
;
435 * Read the inode from disk/cache.
437 ino
=ginode(inode
, fsi
);
439 if(ino
->di_nlink
==0) {
441 return; /* inode not in use */
445 * Dump the main inode structure.
447 snprintf(comment
, sizeof(comment
), "Inode 0x%08jx", (uintmax_t)inode
);
449 DBG_DUMP_INO(&sblock
,
454 if (!(level
& 0x200)) {
460 * Ok, now prepare for dumping all direct and indirect pointers.
462 rb
=howmany(ino
->di_size
, sblock
.fs_bsize
)-NDADDR
;
465 * Dump single indirect block.
467 rdfs(fsbtodb(&sblock
, ino
->di_ib
[0]), (size_t)sblock
.fs_bsize
,
468 (void *)&i1blk
, fsi
);
469 snprintf(comment
, sizeof(comment
), "Inode 0x%08jx: indirect 0",
471 DBG_DUMP_IBLK(&sblock
,
475 rb
-=howmany(sblock
.fs_bsize
, sizeof(ufs_daddr_t
));
479 * Dump double indirect blocks.
481 rdfs(fsbtodb(&sblock
, ino
->di_ib
[1]), (size_t)sblock
.fs_bsize
,
482 (void *)&i2blk
, fsi
);
483 snprintf(comment
, sizeof(comment
), "Inode 0x%08jx: indirect 1",
485 DBG_DUMP_IBLK(&sblock
,
488 howmany(rb
, howmany(sblock
.fs_bsize
, sizeof(ufs_daddr_t
))));
489 for(ind2ctr
=0; ((ind2ctr
< howmany(sblock
.fs_bsize
,
490 sizeof(ufs_daddr_t
)))&&(rb
>0)); ind2ctr
++) {
491 ind2ptr
=&((ufs_daddr_t
*)(void *)&i2blk
)[ind2ctr
];
493 rdfs(fsbtodb(&sblock
, *ind2ptr
),
494 (size_t)sblock
.fs_bsize
, (void *)&i1blk
, fsi
);
495 snprintf(comment
, sizeof(comment
),
496 "Inode 0x%08jx: indirect 1->%d", (uintmax_t)inode
,
498 DBG_DUMP_IBLK(&sblock
,
502 rb
-=howmany(sblock
.fs_bsize
, sizeof(ufs_daddr_t
));
507 * Dump triple indirect blocks.
509 rdfs(fsbtodb(&sblock
, ino
->di_ib
[2]), (size_t)sblock
.fs_bsize
,
510 (void *)&i3blk
, fsi
);
511 snprintf(comment
, sizeof(comment
), "Inode 0x%08jx: indirect 2",
513 #define SQUARE(a) ((a)*(a))
514 DBG_DUMP_IBLK(&sblock
,
518 SQUARE(howmany(sblock
.fs_bsize
, sizeof(ufs_daddr_t
)))));
520 for(ind3ctr
=0; ((ind3ctr
< howmany(sblock
.fs_bsize
,
521 sizeof(ufs_daddr_t
)))&&(rb
>0)); ind3ctr
++) {
522 ind3ptr
=&((ufs_daddr_t
*)(void *)&i3blk
)[ind3ctr
];
524 rdfs(fsbtodb(&sblock
, *ind3ptr
),
525 (size_t)sblock
.fs_bsize
, (void *)&i2blk
, fsi
);
526 snprintf(comment
, sizeof(comment
),
527 "Inode 0x%08jx: indirect 2->%d", (uintmax_t)inode
,
529 DBG_DUMP_IBLK(&sblock
,
533 howmany(sblock
.fs_bsize
, sizeof(ufs_daddr_t
))));
534 for(ind2ctr
=0; ((ind2ctr
< howmany(sblock
.fs_bsize
,
535 sizeof(ufs_daddr_t
)))&&(rb
>0)); ind2ctr
++) {
536 ind2ptr
=&((ufs_daddr_t
*)(void *)&i2blk
)
538 rdfs(fsbtodb(&sblock
, *ind2ptr
),
539 (size_t)sblock
.fs_bsize
, (void *)&i1blk
,
541 snprintf(comment
, sizeof(comment
),
542 "Inode 0x%08jx: indirect 2->%d->%d",
543 (uintmax_t)inode
, ind3ctr
, ind3ctr
);
544 DBG_DUMP_IBLK(&sblock
,
548 rb
-=howmany(sblock
.fs_bsize
,
549 sizeof(ufs_daddr_t
));
558 /* ***************************************************** get_disklabel ***** */
560 * Read the disklabel from disk.
563 get_disklabel(int fd
)
565 DBG_FUNC("get_disklabel")
566 static struct disklabel
*lab
;
570 lab
=(struct disklabel
*)malloc(sizeof(struct disklabel
));
572 errx(1, "malloc failed");
574 if (ioctl(fd
, DIOCGDINFO
, (char *)lab
) < 0) {
575 errx(1, "DIOCGDINFO failed");
584 /* ************************************************************* usage ***** */
586 * Dump a line of usage.
596 "usage: ffsinfo [-L] [-g cylgrp] [-i inode] [-l level] "
598 " special | file\n");
604 /* ************************************************************ ginode ***** */
606 * This function provides access to an individual inode. We find out in which
607 * block the requested inode is located, read it from disk if needed, and
608 * return the pointer into that block. We maintain a cache of one block to
609 * not read the same block again and again if we iterate linearly over all
613 ginode(ino_t inumber
, int fsi
)
617 static ino_t startinum
=0; /* first inode in cached block */
618 struct ufs1_dinode
*pi
;
622 pi
=(struct ufs1_dinode
*)(void *)ablk
;
623 if (startinum
== 0 || inumber
< startinum
||
624 inumber
>= startinum
+ INOPB(&sblock
)) {
626 * The block needed is not cached, so we have to read it from
629 iblk
= ino_to_fsba(&sblock
, inumber
);
630 rdfs(fsbtodb(&sblock
, iblk
), (size_t)sblock
.fs_bsize
,
632 startinum
= (inumber
/ INOPB(&sblock
)) * INOPB(&sblock
);
636 return (&(pi
[inumber
% INOPB(&sblock
)]));