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 $
41 * @(#) Copyright (c) 2000 Christoph Herrmann, Thomas-Henning von Kamptz Copyright (c) 1980, 1989, 1993 The Regents of the University of California. All rights reserved.
42 * $FreeBSD: src/sbin/ffsinfo/ffsinfo.c,v 1.3.2.1 2001/07/16 15:01:56 tomsoft Exp $
45 /* ********************************************************** INCLUDES ***** */
46 #include <sys/param.h>
47 #include <sys/diskslice.h>
61 /* *********************************************************** GLOBALS ***** */
63 int _dbg_lvl_ = (DL_INFO); /* DL_TRC */
70 #define sblock fsun1.fs
71 #define osblock fsun2.fs
79 static char ablk[MAXBSIZE];
80 static char i1blk[MAXBSIZE];
81 static char i2blk[MAXBSIZE];
82 static char i3blk[MAXBSIZE];
84 static struct csum *fscs;
86 /* ******************************************************** PROTOTYPES ***** */
87 static void rdfs(daddr_t, size_t, void *, int);
88 static void usage(void);
89 static struct ufs1_dinode *ginode(ino_t, int);
90 static void dump_whole_inode(ino_t, int, int);
92 /* ************************************************************** rdfs ***** */
94 * Here we read some block(s) from disk.
97 rdfs(daddr_t bno, size_t size, void *bf, int fsi)
103 if (lseek(fsi, (off_t)bno * DEV_BSIZE, 0) < 0) {
104 err(33, "rdfs: seek error: %ld", (long)bno);
106 n = read(fsi, bf, size);
107 if (n != (ssize_t)size) {
108 err(34, "rdfs: read error: %ld", (long)bno);
115 /* ************************************************************** main ***** */
117 * ffsinfo(8) is a tool to dump all metadata of a filesystem. It helps to find
118 * errors is the filesystem much easier. You can run ffsinfo before and after
119 * an fsck(8), and compare the two ascii dumps easy with diff, and you see
120 * directly where the problem is. You can control how much detail you want to
121 * see with some command line arguments. You can also easy check the status
122 * of a filesystem, like is there is enough space for growing a filesystem,
123 * or how many active snapshots do we have. It provides much more detailed
124 * information then dumpfs. Snapshots, as they are very new, are not really
125 * supported. They are just mentioned currently, but it is planned to run
126 * also over active snapshots, to even get that output.
129 main(int argc, char **argv)
131 char *device, *special;
135 struct partinfo pinfo;
137 struct csum *dbg_csp;
141 int cfg_cg, cfg_in, cfg_lv;
142 int cg_start, cg_stop;
144 char *out_file = NULL;
153 while ((ch=getopt(argc, argv, "Lg:i:l:o:")) != -1) {
172 if(cfg_lv < 0x1||cfg_lv > 0x3ff) {
179 out_file = strdup(optarg);
196 * Now we try to guess the (raw)device name.
198 if (0 == strrchr(device, '/') && (stat(device, &st) == -1)) {
200 * No path prefix was given, so try in that order:
206 * FreeBSD now doesn't distinguish between raw and block
207 * devices any longer, but it should still work this way.
209 len=strlen(device)+strlen(_PATH_DEV)+2+strlen("vinum/");
210 special=(char *)malloc(len);
211 if(special == NULL) {
212 errx(1, "malloc failed");
214 snprintf(special, len, "%sr%s", _PATH_DEV, device);
215 if (stat(special, &st) == -1) {
216 snprintf(special, len, "%s%s", _PATH_DEV, device);
217 if (stat(special, &st) == -1) {
218 snprintf(special, len, "%svinum/r%s",
220 if (stat(special, &st) == -1) {
222 * For now this is the 'last resort'.
224 snprintf(special, len, "%svinum/%s",
233 * Open our device for reading.
235 fsi = open(device, O_RDONLY);
237 err(1, "%s", device);
242 if(S_ISREG(st.st_mode)) { /* label check not supported for files */
248 * Try to read a label and gess the slice if not specified.
249 * This code should guess the right thing and avaid to bother
250 * the user user with the task of specifying the option -v on
253 if (ioctl(fsi, DIOCGPART, &pinfo) < 0) {
254 pinfo.media_size = st.st_size;
255 pinfo.media_blksize = DEV_BSIZE;
256 pinfo.media_blocks = pinfo.media_size / DEV_BSIZE;
260 * Check if that partition looks suited for dumping.
262 if (pinfo.media_size == 0) {
263 errx(1, "partition is unavailable");
268 * Read the current superblock.
270 rdfs((daddr_t)(SBOFF/DEV_BSIZE), (size_t)SBSIZE, &sblock, fsi);
271 if (sblock.fs_magic != FS_MAGIC) {
272 errx(1, "superblock not recognized");
275 DBG_OPEN(out_file); /* already here we need a superblock */
283 * Determine here what cylinder groups to dump.
287 cg_stop=sblock.fs_ncg;
288 } else if (cfg_cg==-1) {
289 cg_start=sblock.fs_ncg-1;
290 cg_stop=sblock.fs_ncg;
291 } else if (cfg_cg<sblock.fs_ncg) {
295 cg_start=sblock.fs_ncg;
296 cg_stop=sblock.fs_ncg;
299 if (cfg_lv & 0x004) {
300 fscs = (struct csum *)calloc((size_t)1,
301 (size_t)sblock.fs_cssize);
303 errx(1, "calloc failed");
307 * Get the cylinder summary into the memory ...
309 for (i = 0; i < sblock.fs_cssize; i += sblock.fs_bsize) {
310 rdfs(fsbtodb(&sblock, sblock.fs_csaddr +
311 numfrags(&sblock, i)), (size_t)(sblock.fs_cssize-i<
312 sblock.fs_bsize ? sblock.fs_cssize - i :
313 sblock.fs_bsize), (void *)(((char *)fscs)+i), fsi);
320 for(dbg_csc=0; dbg_csc<sblock.fs_ncg; dbg_csc++) {
321 snprintf(dbg_line, sizeof(dbg_line),
322 "%d. csum in fscs", dbg_csc);
323 DBG_DUMP_CSUM(&sblock,
330 * For each requested cylinder group ...
332 for(cylno=cg_start; cylno<cg_stop; cylno++) {
333 snprintf(dbg_line, sizeof(dbg_line), "cgr %d", cylno);
336 * ... dump the superblock copies ...
338 rdfs(fsbtodb(&sblock, cgsblock(&sblock, cylno)),
339 (size_t)SBSIZE, &osblock, fsi);
340 DBG_DUMP_FS(&osblock,
344 * ... read the cylinder group and dump whatever was requested.
346 rdfs(fsbtodb(&sblock, cgtod(&sblock, cylno)),
347 (size_t)sblock.fs_cgsize, &acg, fsi);
354 DBG_DUMP_INMAP(&sblock,
359 DBG_DUMP_FRMAP(&sblock,
364 DBG_DUMP_CLMAP(&sblock,
367 DBG_DUMP_CLSUM(&sblock,
372 DBG_DUMP_SPTBL(&sblock,
378 * Dump the requested inode(s).
381 dump_whole_inode((ino_t)cfg_in, fsi, cfg_lv);
383 for(in=cg_start*sblock.fs_ipg; in<(ino_t)cg_stop*sblock.fs_ipg;
385 dump_whole_inode(in, fsi, cfg_lv);
397 /* ************************************************** dump_whole_inode ***** */
399 * Here we dump a list of all blocks allocated by this inode. We follow
400 * all indirect blocks.
403 dump_whole_inode(ino_t inode, int fsi, int level)
405 struct ufs1_dinode *ino;
407 unsigned int ind2ctr, ind3ctr;
408 ufs_daddr_t *ind2ptr, *ind3ptr;
414 * Read the inode from disk/cache.
416 ino=ginode(inode, fsi);
418 if(ino->di_nlink==0) {
420 return; /* inode not in use */
424 * Dump the main inode structure.
426 snprintf(comment, sizeof(comment), "Inode 0x%08jx", (uintmax_t)inode);
428 DBG_DUMP_INO(&sblock,
433 if (!(level & 0x200)) {
439 * Ok, now prepare for dumping all direct and indirect pointers.
441 rb=howmany(ino->di_size, sblock.fs_bsize)-NDADDR;
444 * Dump single indirect block.
446 rdfs(fsbtodb(&sblock, ino->di_ib[0]), (size_t)sblock.fs_bsize,
448 snprintf(comment, sizeof(comment), "Inode 0x%08jx: indirect 0",
450 DBG_DUMP_IBLK(&sblock,
454 rb-=howmany(sblock.fs_bsize, sizeof(ufs_daddr_t));
458 * Dump double indirect blocks.
460 rdfs(fsbtodb(&sblock, ino->di_ib[1]), (size_t)sblock.fs_bsize,
462 snprintf(comment, sizeof(comment), "Inode 0x%08jx: indirect 1",
464 DBG_DUMP_IBLK(&sblock,
467 howmany(rb, howmany(sblock.fs_bsize, sizeof(ufs_daddr_t))));
468 for(ind2ctr=0; ((ind2ctr < howmany(sblock.fs_bsize,
469 sizeof(ufs_daddr_t)))&&(rb>0)); ind2ctr++) {
470 ind2ptr=&((ufs_daddr_t *)(void *)&i2blk)[ind2ctr];
472 rdfs(fsbtodb(&sblock, *ind2ptr),
473 (size_t)sblock.fs_bsize, &i1blk, fsi);
474 snprintf(comment, sizeof(comment),
475 "Inode 0x%08jx: indirect 1->%d", (uintmax_t)inode,
477 DBG_DUMP_IBLK(&sblock,
481 rb-=howmany(sblock.fs_bsize, sizeof(ufs_daddr_t));
486 * Dump triple indirect blocks.
488 rdfs(fsbtodb(&sblock, ino->di_ib[2]), (size_t)sblock.fs_bsize,
490 snprintf(comment, sizeof(comment), "Inode 0x%08jx: indirect 2",
492 #define SQUARE(a) ((a)*(a))
493 DBG_DUMP_IBLK(&sblock,
497 SQUARE(howmany(sblock.fs_bsize, sizeof(ufs_daddr_t)))));
499 for(ind3ctr=0; ((ind3ctr < howmany(sblock.fs_bsize,
500 sizeof(ufs_daddr_t)))&&(rb>0)); ind3ctr ++) {
501 ind3ptr=&((ufs_daddr_t *)(void *)&i3blk)[ind3ctr];
503 rdfs(fsbtodb(&sblock, *ind3ptr),
504 (size_t)sblock.fs_bsize, &i2blk, fsi);
505 snprintf(comment, sizeof(comment),
506 "Inode 0x%08jx: indirect 2->%d", (uintmax_t)inode,
508 DBG_DUMP_IBLK(&sblock,
512 howmany(sblock.fs_bsize, sizeof(ufs_daddr_t))));
513 for(ind2ctr=0; ((ind2ctr < howmany(sblock.fs_bsize,
514 sizeof(ufs_daddr_t)))&&(rb>0)); ind2ctr ++) {
515 ind2ptr=&((ufs_daddr_t *)(void *)&i2blk)
517 rdfs(fsbtodb(&sblock, *ind2ptr),
518 (size_t)sblock.fs_bsize, &i1blk, fsi);
519 snprintf(comment, sizeof(comment),
520 "Inode 0x%08jx: indirect 2->%d->%d",
521 (uintmax_t)inode, ind3ctr, ind3ctr);
522 DBG_DUMP_IBLK(&sblock,
526 rb-=howmany(sblock.fs_bsize,
527 sizeof(ufs_daddr_t));
536 /* ************************************************************* usage ***** */
538 * Dump a line of usage.
546 "usage: ffsinfo [-L] [-g cylgrp] [-i inode] [-l level] "
548 " special | file\n");
554 /* ************************************************************ ginode ***** */
556 * This function provides access to an individual inode. We find out in which
557 * block the requested inode is located, read it from disk if needed, and
558 * return the pointer into that block. We maintain a cache of one block to
559 * not read the same block again and again if we iterate linearly over all
563 ginode(ino_t inumber, int fsi)
566 static ino_t startinum=0; /* first inode in cached block */
567 struct ufs1_dinode *pi;
571 pi=(struct ufs1_dinode *)(void *)ablk;
572 if (startinum == 0 || inumber < startinum ||
573 inumber >= startinum + INOPB(&sblock)) {
575 * The block needed is not cached, so we have to read it from
578 iblk = ino_to_fsba(&sblock, inumber);
579 rdfs(fsbtodb(&sblock, iblk), (size_t)sblock.fs_bsize,
581 startinum = (inumber / INOPB(&sblock)) * INOPB(&sblock);
585 return (&(pi[inumber % INOPB(&sblock)]));