root/sbin/dumpfs/dumpfs.c
/*
 * Copyright (c) 1983, 1992, 1993
 *      The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * @(#) Copyright (c) 1983, 1992, 1993 The Regents of the University of California.  All rights reserved.
 * @(#)dumpfs.c 8.5 (Berkeley) 4/29/95
 * $FreeBSD: src/sbin/dumpfs/dumpfs.c,v 1.13.2.1 2001/01/22 18:10:11 iedowse Exp $
 */

#include <sys/param.h>
#include <sys/time.h>

#include <vfs/ufs/dinode.h>
#include <vfs/ufs/fs.h>

#include <err.h>
#include <fcntl.h>
#include <fstab.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>

static union {
        struct fs fs;
        char pad[MAXBSIZE];
} fsun;
#define afs     fsun.fs

static union {
        struct cg cg;
        char pad[MAXBSIZE];
} cgun;
#define acg     cgun.cg

static long     dev_bsize = 1;

static int      dumpfs(char *);
static int      dumpcg(char *, int, int);
static int      marshal(const char*);
static void     pbits(void *, int);
static void     usage(void) __dead2;

int
main(int argc, char **argv)
{
        struct fstab *fs;
        int ch, domarshal, eval;

        domarshal = 0;

        while ((ch = getopt(argc, argv, "m")) != -1)
                switch(ch) {
                case 'm':
                        domarshal = 1;
                        break;
                case '?':
                default:
                        usage();
                }
        argc -= optind;
        argv += optind;

        if (argc < 1)
                usage();

        for (eval = 0; *argv; ++argv)
                if ((fs = getfsfile(*argv)) == NULL)
                        if (domarshal)
                                eval |= marshal(*argv);
                        else
                                eval |= dumpfs(*argv);
                else
                        if (domarshal)
                                eval |= marshal(fs->fs_spec);
                        else
                                eval |= dumpfs(fs->fs_spec);
        exit(eval);
}

static int
dumpfs(char *name)
{
        ssize_t n;
        int fd, c, i, j, k, size;
        time_t fs_time;

        if ((fd = open(name, O_RDONLY, 0)) < 0)
                goto err;
        if (lseek(fd, (off_t)SBOFF, SEEK_SET) == (off_t)-1)
                goto err;
        if ((n = read(fd, &afs, SBSIZE)) == -1)
                goto err;

        if (n != SBSIZE) {
                warnx("%s: non-existent or truncated superblock, skipped",
                    name);
                close(fd);
                return (1);
        }
        if (afs.fs_magic != FS_MAGIC) {
                warnx("%s: superblock has bad magic number, skipped", name);
                close(fd);
                return (1);
        }

        if (afs.fs_postblformat == FS_42POSTBLFMT)
                afs.fs_nrpos = 8;
        dev_bsize = afs.fs_fsize / fsbtodb(&afs, 1);
        fs_time = afs.fs_time;
        printf("magic\t%x\ttime\t%s", afs.fs_magic, ctime(&fs_time));
        printf("id\t[ %x %x ]\n", afs.fs_id[0], afs.fs_id[1]);
        printf("cylgrp\t%s\tinodes\t%s\n",
            afs.fs_postblformat == FS_42POSTBLFMT ? "static" : "dynamic",
            afs.fs_inodefmt < FS_44INODEFMT ? "4.2/4.3BSD" : "4.4BSD");
        printf("nbfree\t%d\tndir\t%d\tnifree\t%d\tnffree\t%d\n",
            afs.fs_cstotal.cs_nbfree, afs.fs_cstotal.cs_ndir,
            afs.fs_cstotal.cs_nifree, afs.fs_cstotal.cs_nffree);
        printf("ncg\t%d\tncyl\t%d\tsize\t%d\tblocks\t%d\n",
            afs.fs_ncg, afs.fs_ncyl, afs.fs_size, afs.fs_dsize);
        printf("bsize\t%d\tshift\t%d\tmask\t0x%08x\n",
            afs.fs_bsize, afs.fs_bshift, afs.fs_bmask);
        printf("fsize\t%d\tshift\t%d\tmask\t0x%08x\n",
            afs.fs_fsize, afs.fs_fshift, afs.fs_fmask);
        printf("frag\t%d\tshift\t%d\tfsbtodb\t%d\n",
            afs.fs_frag, afs.fs_fragshift, afs.fs_fsbtodb);
        printf("cpg\t%d\tbpg\t%d\tfpg\t%d\tipg\t%d\n",
            afs.fs_cpg, afs.fs_fpg / afs.fs_frag, afs.fs_fpg, afs.fs_ipg);
        printf("minfree\t%d%%\toptim\t%s\tmaxcontig %d\tmaxbpg\t%d\n",
            afs.fs_minfree, afs.fs_optim == FS_OPTSPACE ? "space" : "time",
            afs.fs_maxcontig, afs.fs_maxbpg);
        printf("rotdelay %dms\trps\t%d\n",
            afs.fs_rotdelay, afs.fs_rps);
        printf("ntrak\t%d\tnsect\t%d\tnpsect\t%d\tspc\t%d\n",
            afs.fs_ntrak, afs.fs_nsect, afs.fs_npsect, afs.fs_spc);
        printf("symlinklen %d\ttrackskew %d\tinterleave %d\tcontigsumsize %d\n",
            afs.fs_maxsymlinklen, afs.fs_trackskew, afs.fs_interleave,
            afs.fs_contigsumsize);
        printf("nindir\t%d\tinopb\t%d\tnspf\t%d\tmaxfilesize\t%ju\n",
            afs.fs_nindir, afs.fs_inopb, afs.fs_nspf,
            (uintmax_t)afs.fs_maxfilesize);
        printf("sblkno\t%d\tcblkno\t%d\tiblkno\t%d\tdblkno\t%d\n",
            afs.fs_sblkno, afs.fs_cblkno, afs.fs_iblkno, afs.fs_dblkno);
        printf("sbsize\t%d\tcgsize\t%d\tcgoffset %d\tcgmask\t0x%08x\n",
            afs.fs_sbsize, afs.fs_cgsize, afs.fs_cgoffset, afs.fs_cgmask);
        printf("csaddr\t%d\tcssize\t%d\tshift\t%d\tmask\t0x%08x\n",
            afs.fs_csaddr, afs.fs_cssize, afs.fs_csshift, afs.fs_csmask);
        printf("cgrotor\t%d\tfmod\t%d\tronly\t%d\tclean\t%d\n",
            afs.fs_cgrotor, afs.fs_fmod, afs.fs_ronly, afs.fs_clean);
        printf("flags\t");
        if (afs.fs_flags == 0)
                printf("none");
        if (afs.fs_flags & FS_UNCLEAN)
                        printf("unclean ");
        if (afs.fs_flags & FS_DOSOFTDEP)
                        printf("soft-updates ");
        if ((afs.fs_flags & ~(FS_UNCLEAN | FS_DOSOFTDEP)) != 0)
                        printf("unknown flags (%#x)", 
                            afs.fs_flags & ~(FS_UNCLEAN | FS_DOSOFTDEP));
        putchar('\n');
        if (afs.fs_cpc != 0)
                printf("blocks available in each of %d rotational positions",
                     afs.fs_nrpos);
        else
                printf("(no rotational position table)\n");
        for (c = 0; c < afs.fs_cpc; c++) {
                printf("\ncylinder number %d:", c);
                for (i = 0; i < afs.fs_nrpos; i++) {
                        if (fs_postbl(&afs, c)[i] == -1)
                                continue;
                        printf("\n   position %d:\t", i);
                        for (j = fs_postbl(&afs, c)[i], k = 1; ;
                             j += fs_rotbl(&afs)[j], k++) {
                                printf("%5d", j);
                                if (k % 12 == 0)
                                        printf("\n\t\t");
                                if (fs_rotbl(&afs)[j] == 0)
                                        break;
                        }
                }
        }
        printf("\ncs[].cs_(nbfree,ndir,nifree,nffree):\n\t");
        afs.fs_csp = calloc(1, afs.fs_cssize);
        for (i = 0, j = 0; i < afs.fs_cssize; i += afs.fs_bsize, j++) {
                size = afs.fs_cssize - i < afs.fs_bsize ?
                    afs.fs_cssize - i : afs.fs_bsize;
                if (lseek(fd,
                    (off_t)(fsbtodb(&afs, (afs.fs_csaddr + j * afs.fs_frag))) *
                    (off_t)dev_bsize, SEEK_SET) == (off_t)-1)
                        goto err;
                if (read(fd, (char *)afs.fs_csp + i, size) != size)
                        goto err;
        }
        for (i = 0; i < afs.fs_ncg; i++) {
                struct csum *cs = &afs.fs_cs(&afs, i);
                if (i && i % 4 == 0)
                        printf("\n\t");
                printf("(%d,%d,%d,%d) ",
                    cs->cs_nbfree, cs->cs_ndir, cs->cs_nifree, cs->cs_nffree);
        }
        printf("\n");
        if (afs.fs_ncyl % afs.fs_cpg) {
                printf("cylinders in last group %d\n",
                    i = afs.fs_ncyl % afs.fs_cpg);
                printf("blocks in last group %d\n",
                    i * afs.fs_spc / NSPB(&afs));
        }
        printf("\n");
        for (i = 0; i < afs.fs_ncg; i++)
                if (dumpcg(name, fd, i))
                        goto err;
        close(fd);
        return (0);

err:    if (fd != -1)
                close(fd);
        warn("%s", name);
        return (1);
};

static int
dumpcg(char *name, int fd, int c)
{
        off_t cur;
        int i, j;
        time_t cg_time;

        printf("\ncg %d:\n", c);
        if ((cur = lseek(fd, (off_t)(fsbtodb(&afs, cgtod(&afs, c))) *
            (off_t)dev_bsize, SEEK_SET)) == (off_t)-1)
                return (1);
        if (read(fd, &acg, afs.fs_bsize) != afs.fs_bsize) {
                warnx("%s: error reading cg", name);
                return (1);
        }
        cg_time = acg.cg_time;
        printf("magic\t%x\ttell\t%jx\ttime\t%s",
            afs.fs_postblformat == FS_42POSTBLFMT ?
            ((struct ocg *)&acg)->cg_magic : acg.cg_magic,
            (uintmax_t)cur, ctime(&cg_time));
        printf("cgx\t%d\tncyl\t%d\tniblk\t%d\tndblk\t%d\n",
            acg.cg_cgx, acg.cg_ncyl, acg.cg_niblk, acg.cg_ndblk);
        printf("nbfree\t%d\tndir\t%d\tnifree\t%d\tnffree\t%d\n",
            acg.cg_cs.cs_nbfree, acg.cg_cs.cs_ndir,
            acg.cg_cs.cs_nifree, acg.cg_cs.cs_nffree);
        printf("rotor\t%d\tirotor\t%d\tfrotor\t%d\nfrsum",
            acg.cg_rotor, acg.cg_irotor, acg.cg_frotor);
        for (i = 1, j = 0; i < afs.fs_frag; i++) {
                printf("\t%d", acg.cg_frsum[i]);
                j += i * acg.cg_frsum[i];
        }
        printf("\nsum of frsum: %d", j);
        if (afs.fs_contigsumsize > 0) {
                for (i = 1; i < afs.fs_contigsumsize; i++) {
                        if ((i - 1) % 8 == 0)
                                printf("\nclusters %d-%d:", i,
                                    afs.fs_contigsumsize - 1 < i + 7 ?
                                    afs.fs_contigsumsize - 1 : i + 7);
                        printf("\t%d", cg_clustersum(&acg)[i]);
                }
                printf("\nclusters size %d and over: %d\n",
                    afs.fs_contigsumsize,
                    cg_clustersum(&acg)[afs.fs_contigsumsize]);
                printf("clusters free:\t");
                pbits(cg_clustersfree(&acg), acg.cg_nclusterblks);
        } else
                printf("\n");
        printf("iused:\t");
        pbits(cg_inosused(&acg), afs.fs_ipg);
        printf("free:\t");
        pbits(cg_blksfree(&acg), afs.fs_fpg);
        printf("b:\n");
        for (i = 0; i < afs.fs_cpg; i++) {
                if (cg_blktot(&acg)[i] == 0)
                        continue;
                printf("   c%d:\t(%d)\t", i, cg_blktot(&acg)[i]);
                for (j = 0; j < afs.fs_nrpos; j++) {
                        if (afs.fs_cpc > 0 &&
                            fs_postbl(&afs, i % afs.fs_cpc)[j] == -1)
                                continue;
                        printf(" %d", cg_blks(&afs, &acg, i)[j]);
                }
                printf("\n");
        }
        return (0);
};

static int
marshal(const char *name)
{
        ssize_t n;
        int fd;
        static char realname[PATH_MAX];

        if ((fd = open(name, O_RDONLY, 0)) < 0)
                goto err;
        if (lseek(fd, (off_t)SBOFF, SEEK_SET) == (off_t)-1)
                goto err;
        if ((n = read(fd, &afs, SBSIZE)) == -1)
                goto err;

        if (n != SBSIZE) {
                warnx("%s: non-existent or truncated superblock, skipped",
                    name);
                close(fd);
                return (1);
        }
        if (afs.fs_magic != FS_MAGIC) {
                warnx("%s: superblock has bad magic number, skipped", name);
                close(fd);
                return (1);
        }

        if(strncmp(name, "/dev", 4) == 0) {
                snprintf(realname, PATH_MAX, "%s", name);
        } else {
                snprintf(realname, PATH_MAX, "/dev/%s", name);
        }

        printf("# newfs command for %s (%s)\n", name, realname);
        printf("newfs ");
        if (afs.fs_flags & FS_DOSOFTDEP)
                printf("-U ");
        printf("-a %d ", afs.fs_maxcontig);
        printf("-b %d ", afs.fs_bsize);
        /* -c calculated */
        /* -d should be 0 per manpage */
        printf("-e %d ", afs.fs_maxbpg);
        printf("-f %d ", afs.fs_fsize);
        printf("-g %d ", afs.fs_avgfilesize);
        printf("-h %d ", afs.fs_avgfpdir);
        /* -i calculated */
        /* -j..l not implemented */
        printf("-m %d ", afs.fs_minfree);
        /* -n not implemented */
        printf(" -o ");
        switch (afs.fs_optim) {
        case FS_OPTSPACE:
                printf("space ");
                break;
        case FS_OPTTIME:
                printf("time ");
                break;
        default:
                printf("unknown ");
                break;
        }
        /* -p..r not implemented */
        printf("-s %jd ", (intmax_t)afs.fs_size);
        printf("%s ", realname);
        printf("\n");

        return (0);

err:    if (fd != -1)
                close(fd);
        warn("%s", name);
        return (1);

}

static void
pbits(void *vp, int max)
{
        int i;
        char *p;
        int count, j;

        for (count = i = 0, p = vp; i < max; i++)
                if (isset(p, i)) {
                        if (count)
                                printf(",%s", count % 6 ? " " : "\n\t");
                        count++;
                        printf("%d", i);
                        j = i;
                        while ((i+1)<max && isset(p, i+1))
                                i++;
                        if (i != j)
                                printf("-%d", i);
                }
        printf("\n");
}

static void
usage(void)
{
        fprintf(stderr, "usage: dumpfs filesys | device\n");
        exit(1);
}