sbin/dumpfs/dumpfs.c

   1 /*
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 2009 Robert N. M. Watson
   5  * All rights reserved.
   6  *
   7  * This software was developed at the University of Cambridge Computer
   8  * Laboratory with support from a grant from Google, Inc.
   9  *
  10  * Copyright (c) 2002 Networks Associates Technology, Inc.
  11  * All rights reserved.
  12  *
  13  * This software was developed for the FreeBSD Project by Marshall
  14  * Kirk McKusick and Network Associates Laboratories, the Security
  15  * Research Division of Network Associates, Inc. under DARPA/SPAWAR
  16  * contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA CHATS
  17  * research program.
  18  *
  19  * Copyright (c) 1983, 1992, 1993
  20  *      The Regents of the University of California.  All rights reserved.
  21  *
  22  * Redistribution and use in source and binary forms, with or without
  23  * modification, are permitted provided that the following conditions
  24  * are met:
  25  * 1. Redistributions of source code must retain the above copyright
  26  *    notice, this list of conditions and the following disclaimer.
  27  * 2. Redistributions in binary form must reproduce the above copyright
  28  *    notice, this list of conditions and the following disclaimer in the
  29  *    documentation and/or other materials provided with the distribution.
  30  * 3. Neither the name of the University nor the names of its contributors
  31  *    may be used to endorse or promote products derived from this software
  32  *    without specific prior written permission.
  33  *
  34  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  35  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  36  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  37  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  38  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  39  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  40  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  41  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  42  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  43  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  44  * SUCH DAMAGE.
  45  */
  46
  47 #ifndef lint
  48 static const char copyright[] =
  49 "@(#) Copyright (c) 1983, 1992, 1993\n\
  50         The Regents of the University of California.  All rights reserved.\n";
  51 #endif /* not lint */
  52
  53 #ifndef lint
  54 #if 0
  55 static char sccsid[] = "@(#)dumpfs.c    8.5 (Berkeley) 4/29/95";
  56 #endif
  57 static const char rcsid[] =
  58   "$FreeBSD$";
  59 #endif /* not lint */
  60
  61 #include <sys/param.h>
  62 #include <sys/time.h>
  63 #include <sys/disklabel.h>
  64
  65 #include <ufs/ufs/dinode.h>
  66 #include <ufs/ffs/fs.h>
  67
  68 #include <err.h>
  69 #include <errno.h>
  70 #include <fcntl.h>
  71 #include <fstab.h>
  72 #include <libufs.h>
  73 #include <paths.h>
  74 #include <stdint.h>
  75 #include <stdio.h>
  76 #include <stdlib.h>
  77 #include <unistd.h>
  78
  79 #define afs     disk.d_fs
  80 #define acg     disk.d_cg
  81
  82 static struct uufsd disk;
  83
  84 static int      dumpfs(const char *);
  85 static int      dumpfsid(void);
  86 static int      dumpcg(void);
  87 static int      dumpfreespace(const char *, int);
  88 static void     dumpfreespacecg(int);
  89 static int      marshal(const char *);
  90 static void     pbits(void *, int);
  91 static void     pblklist(void *, int, off_t, int);
  92 static void     ufserr(const char *);
  93 static void     usage(void) __dead2;
  94
  95 int
  96 main(int argc, char *argv[])
  97 {
  98         const char *name;
  99         int ch, dofreespace, domarshal, dolabel, eval;
 100
 101         dofreespace = domarshal = dolabel = eval = 0;
 102
 103         while ((ch = getopt(argc, argv, "lfm")) != -1) {
 104                 switch (ch) {
 105                 case 'f':
 106                         dofreespace++;
 107                         break;
 108                 case 'm':
 109                         domarshal = 1;
 110                         break;
 111                 case 'l':
 112                         dolabel = 1;
 113                         break;
 114                 case '?':
 115                 default:
 116                         usage();
 117                 }
 118         }
 119         argc -= optind;
 120         argv += optind;
 121
 122         if (argc < 1)
 123                 usage();
 124         if (dofreespace && domarshal)
 125                 usage();
 126         if (dofreespace > 2)
 127                 usage();
 128
 129         while ((name = *argv++) != NULL) {
 130                 if (ufs_disk_fillout(&disk, name) == -1) {
 131                         ufserr(name);
 132                         eval |= 1;
 133                         continue;
 134                 }
 135                 if (dofreespace)
 136                         eval |= dumpfreespace(name, dofreespace);
 137                 else if (domarshal)
 138                         eval |= marshal(name);
 139                 else if (dolabel)
 140                         eval |= dumpfsid();
 141                 else
 142                         eval |= dumpfs(name);
 143                 ufs_disk_close(&disk);
 144         }
 145         exit(eval);
 146 }
 147
 148 static int
 149 dumpfsid(void)
 150 {
 151
 152         printf("%sufsid/%08x%08x\n", _PATH_DEV, afs.fs_id[0], afs.fs_id[1]);
 153         return 0;
 154 }
 155
 156 static int
 157 dumpfs(const char *name)
 158 {
 159         time_t fstime;
 160         int64_t fssize;
 161         int32_t fsflags;
 162         int i;
 163
 164         switch (disk.d_ufs) {
 165         case 2:
 166                 fssize = afs.fs_size;
 167                 fstime = afs.fs_time;
 168                 printf("magic\t%x (UFS2)\ttime\t%s",
 169                     afs.fs_magic, ctime(&fstime));
 170                 printf("superblock location\t%jd\tid\t[ %08x %08x ]\n",
 171                     (intmax_t)afs.fs_sblockloc, afs.fs_id[0], afs.fs_id[1]);
 172                 printf("ncg\t%d\tsize\t%jd\tblocks\t%jd\n",
 173                     afs.fs_ncg, (intmax_t)fssize, (intmax_t)afs.fs_dsize);
 174                 break;
 175         case 1:
 176                 fssize = afs.fs_old_size;
 177                 fstime = afs.fs_old_time;
 178                 printf("magic\t%x (UFS1)\ttime\t%s",
 179                     afs.fs_magic, ctime(&fstime));
 180                 printf("id\t[ %08x %08x ]\n", afs.fs_id[0], afs.fs_id[1]);
 181                 printf("ncg\t%d\tsize\t%jd\tblocks\t%jd\n",
 182                     afs.fs_ncg, (intmax_t)fssize, (intmax_t)afs.fs_dsize);
 183                 break;
 184         default:
 185                 goto err;
 186         }
 187         printf("bsize\t%d\tshift\t%d\tmask\t0x%08x\n",
 188             afs.fs_bsize, afs.fs_bshift, afs.fs_bmask);
 189         printf("fsize\t%d\tshift\t%d\tmask\t0x%08x\n",
 190             afs.fs_fsize, afs.fs_fshift, afs.fs_fmask);
 191         printf("frag\t%d\tshift\t%d\tfsbtodb\t%d\n",
 192             afs.fs_frag, afs.fs_fragshift, afs.fs_fsbtodb);
 193         printf("minfree\t%d%%\toptim\t%s\tsymlinklen %d\n",
 194             afs.fs_minfree, afs.fs_optim == FS_OPTSPACE ? "space" : "time",
 195             afs.fs_maxsymlinklen);
 196         switch (disk.d_ufs) {
 197         case 2:
 198                 printf("%s %d\tmaxbpg\t%d\tmaxcontig %d\tcontigsumsize %d\n",
 199                     "maxbsize", afs.fs_maxbsize, afs.fs_maxbpg,
 200                     afs.fs_maxcontig, afs.fs_contigsumsize);
 201                 printf("nbfree\t%jd\tndir\t%jd\tnifree\t%jd\tnffree\t%jd\n",
 202                     (intmax_t)afs.fs_cstotal.cs_nbfree,
 203                     (intmax_t)afs.fs_cstotal.cs_ndir,
 204                     (intmax_t)afs.fs_cstotal.cs_nifree,
 205                     (intmax_t)afs.fs_cstotal.cs_nffree);
 206                 printf("bpg\t%d\tfpg\t%d\tipg\t%d\tunrefs\t%jd\n",
 207                     afs.fs_fpg / afs.fs_frag, afs.fs_fpg, afs.fs_ipg,
 208                     (intmax_t)afs.fs_unrefs);
 209                 printf("nindir\t%d\tinopb\t%d\tmaxfilesize\t%ju\n",
 210                     afs.fs_nindir, afs.fs_inopb,
 211                     (uintmax_t)afs.fs_maxfilesize);
 212                 printf("sbsize\t%d\tcgsize\t%d\tcsaddr\t%jd\tcssize\t%d\n",
 213                     afs.fs_sbsize, afs.fs_cgsize, (intmax_t)afs.fs_csaddr,
 214                     afs.fs_cssize);
 215                 break;
 216         case 1:
 217                 printf("maxbpg\t%d\tmaxcontig %d\tcontigsumsize %d\n",
 218                     afs.fs_maxbpg, afs.fs_maxcontig, afs.fs_contigsumsize);
 219                 printf("nbfree\t%d\tndir\t%d\tnifree\t%d\tnffree\t%d\n",
 220                     afs.fs_old_cstotal.cs_nbfree, afs.fs_old_cstotal.cs_ndir,
 221                     afs.fs_old_cstotal.cs_nifree, afs.fs_old_cstotal.cs_nffree);
 222                 printf("cpg\t%d\tbpg\t%d\tfpg\t%d\tipg\t%d\n",
 223                     afs.fs_old_cpg, afs.fs_fpg / afs.fs_frag, afs.fs_fpg,
 224                     afs.fs_ipg);
 225                 printf("nindir\t%d\tinopb\t%d\tnspf\t%d\tmaxfilesize\t%ju\n",
 226                     afs.fs_nindir, afs.fs_inopb, afs.fs_old_nspf,
 227                     (uintmax_t)afs.fs_maxfilesize);
 228                 printf("sbsize\t%d\tcgsize\t%d\tcgoffset %d\tcgmask\t0x%08x\n",
 229                     afs.fs_sbsize, afs.fs_cgsize, afs.fs_old_cgoffset,
 230                     afs.fs_old_cgmask);
 231                 printf("csaddr\t%d\tcssize\t%d\n",
 232                     afs.fs_old_csaddr, afs.fs_cssize);
 233                 printf("rotdelay %dms\trps\t%d\ttrackskew %d\tinterleave %d\n",
 234                     afs.fs_old_rotdelay, afs.fs_old_rps, afs.fs_old_trackskew,
 235                     afs.fs_old_interleave);
 236                 printf("nsect\t%d\tnpsect\t%d\tspc\t%d\n",
 237                     afs.fs_old_nsect, afs.fs_old_npsect, afs.fs_old_spc);
 238                 break;
 239         default:
 240                 goto err;
 241         }
 242         printf("sblkno\t%d\tcblkno\t%d\tiblkno\t%d\tdblkno\t%d\n",
 243             afs.fs_sblkno, afs.fs_cblkno, afs.fs_iblkno, afs.fs_dblkno);
 244         printf("cgrotor\t%d\tfmod\t%d\tronly\t%d\tclean\t%d\n",
 245             afs.fs_cgrotor, afs.fs_fmod, afs.fs_ronly, afs.fs_clean);
 246         printf("metaspace %jd\tavgfpdir %d\tavgfilesize %d\n",
 247             afs.fs_metaspace, afs.fs_avgfpdir, afs.fs_avgfilesize);
 248         printf("flags\t");
 249         if (afs.fs_old_flags & FS_FLAGS_UPDATED)
 250                 fsflags = afs.fs_flags;
 251         else
 252                 fsflags = afs.fs_old_flags;
 253         if (fsflags == 0)
 254                 printf("none");
 255         if (fsflags & FS_UNCLEAN)
 256                 printf("unclean ");
 257         if (fsflags & FS_DOSOFTDEP)
 258                 printf("soft-updates%s ", (fsflags & FS_SUJ) ? "+journal" : "");
 259         if (fsflags & FS_NEEDSFSCK)
 260                 printf("needs fsck run ");
 261         if (fsflags & FS_INDEXDIRS)
 262                 printf("indexed directories ");
 263         if (fsflags & FS_ACLS)
 264                 printf("acls ");
 265         if (fsflags & FS_MULTILABEL)
 266                 printf("multilabel ");
 267         if (fsflags & FS_GJOURNAL)
 268                 printf("gjournal ");
 269         if (fsflags & FS_FLAGS_UPDATED)
 270                 printf("fs_flags expanded ");
 271         if (fsflags & FS_NFS4ACLS)
 272                 printf("nfsv4acls ");
 273         if (fsflags & FS_TRIM)
 274                 printf("trim ");
 275         fsflags &= ~(FS_UNCLEAN | FS_DOSOFTDEP | FS_NEEDSFSCK | FS_INDEXDIRS |
 276                      FS_ACLS | FS_MULTILABEL | FS_GJOURNAL | FS_FLAGS_UPDATED |
 277                      FS_NFS4ACLS | FS_SUJ | FS_TRIM);
 278         if (fsflags != 0)
 279                 printf("unknown flags (%#x)", fsflags);
 280         putchar('\n');
 281         printf("check hashes\t");
 282         fsflags = afs.fs_metackhash;
 283         if (fsflags == 0)
 284                 printf("none");
 285         if (fsflags & CK_SUPERBLOCK)
 286                 printf("superblock ");
 287         if (fsflags & CK_CYLGRP)
 288                 printf("cylinder-groups ");
 289         if (fsflags & CK_INODE)
 290                 printf("inodes ");
 291         if (fsflags & CK_INDIR)
 292                 printf("indirect-blocks ");
 293         if (fsflags & CK_DIR)
 294                 printf("directories ");
 295         fsflags &= ~(CK_SUPERBLOCK | CK_CYLGRP | CK_INODE | CK_INDIR | CK_DIR);
 296         if (fsflags != 0)
 297                 printf("unknown flags (%#x)", fsflags);
 298         putchar('\n');
 299         printf("fsmnt\t%s\n", afs.fs_fsmnt);
 300         printf("volname\t%s\tswuid\t%ju\tprovidersize\t%ju\n",
 301                 afs.fs_volname, (uintmax_t)afs.fs_swuid,
 302                 (uintmax_t)afs.fs_providersize);
 303         printf("\ncs[].cs_(nbfree,ndir,nifree,nffree):\n\t");
 304         afs.fs_csp = calloc(1, afs.fs_cssize);
 305         if (bread(&disk, fsbtodb(&afs, afs.fs_csaddr), afs.fs_csp, afs.fs_cssize) == -1)
 306                 goto err;
 307         for (i = 0; i < afs.fs_ncg; i++) {
 308                 struct csum *cs = &afs.fs_cs(&afs, i);
 309                 if (i && i % 4 == 0)
 310                         printf("\n\t");
 311                 printf("(%d,%d,%d,%d) ",
 312                     cs->cs_nbfree, cs->cs_ndir, cs->cs_nifree, cs->cs_nffree);
 313         }
 314         printf("\n");
 315         if (fssize % afs.fs_fpg) {
 316                 if (disk.d_ufs == 1)
 317                         printf("cylinders in last group %d\n",
 318                             howmany(afs.fs_old_size % afs.fs_fpg,
 319                             afs.fs_old_spc / afs.fs_old_nspf));
 320                 printf("blocks in last group %ld\n\n",
 321                     (long)((fssize % afs.fs_fpg) / afs.fs_frag));
 322         }
 323         while ((i = cgread(&disk)) != 0) {
 324                 if (i == -1 || dumpcg())
 325                         goto err;
 326         }
 327         return (0);
 328
 329 err:    ufserr(name);
 330         return (1);
 331 }
 332
 333 static int
 334 dumpcg(void)
 335 {
 336         time_t cgtime;
 337         off_t cur;
 338         int i, j;
 339
 340         printf("\ncg %d:\n", disk.d_lcg);
 341         cur = fsbtodb(&afs, cgtod(&afs, disk.d_lcg)) * disk.d_bsize;
 342         switch (disk.d_ufs) {
 343         case 2:
 344                 cgtime = acg.cg_time;
 345                 printf("magic\t%x\ttell\t%jx\ttime\t%s",
 346                     acg.cg_magic, (intmax_t)cur, ctime(&cgtime));
 347                 printf("cgx\t%d\tndblk\t%d\tniblk\t%d\tinitiblk %d\tunrefs %d\n",
 348                     acg.cg_cgx, acg.cg_ndblk, acg.cg_niblk, acg.cg_initediblk,
 349                     acg.cg_unrefs);
 350                 break;
 351         case 1:
 352                 cgtime = acg.cg_old_time;
 353                 printf("magic\t%x\ttell\t%jx\ttime\t%s",
 354                     acg.cg_magic, (intmax_t)cur, ctime(&cgtime));
 355                 printf("cgx\t%d\tncyl\t%d\tniblk\t%d\tndblk\t%d\n",
 356                     acg.cg_cgx, acg.cg_old_ncyl, acg.cg_old_niblk,
 357                     acg.cg_ndblk);
 358                 break;
 359         default:
 360                 break;
 361         }
 362         printf("nbfree\t%d\tndir\t%d\tnifree\t%d\tnffree\t%d\n",
 363             acg.cg_cs.cs_nbfree, acg.cg_cs.cs_ndir,
 364             acg.cg_cs.cs_nifree, acg.cg_cs.cs_nffree);
 365         printf("rotor\t%d\tirotor\t%d\tfrotor\t%d\nfrsum",
 366             acg.cg_rotor, acg.cg_irotor, acg.cg_frotor);
 367         for (i = 1, j = 0; i < afs.fs_frag; i++) {
 368                 printf("\t%d", acg.cg_frsum[i]);
 369                 j += i * acg.cg_frsum[i];
 370         }
 371         printf("\nsum of frsum: %d", j);
 372         if (afs.fs_contigsumsize > 0) {
 373                 for (i = 1; i < afs.fs_contigsumsize; i++) {
 374                         if ((i - 1) % 8 == 0)
 375                                 printf("\nclusters %d-%d:", i,
 376                                     MIN(afs.fs_contigsumsize - 1, i + 7));
 377                         printf("\t%d", cg_clustersum(&acg)[i]);
 378                 }
 379                 printf("\nclusters size %d and over: %d\n",
 380                     afs.fs_contigsumsize,
 381                     cg_clustersum(&acg)[afs.fs_contigsumsize]);
 382                 printf("clusters free:\t");
 383                 pbits(cg_clustersfree(&acg), acg.cg_nclusterblks);
 384         } else
 385                 printf("\n");
 386         printf("inodes used:\t");
 387         pbits(cg_inosused(&acg), afs.fs_ipg);
 388         printf("blks free:\t");
 389         pbits(cg_blksfree(&acg), afs.fs_fpg);
 390         return (0);
 391 }
 392
 393 static int
 394 dumpfreespace(const char *name, int fflag)
 395 {
 396         int i;
 397
 398         while ((i = cgread(&disk)) != 0) {
 399                 if (i == -1)
 400                         goto err;
 401                 dumpfreespacecg(fflag);
 402         }
 403         return (0);
 404 err:
 405         ufserr(name);
 406         return (1);
 407 }
 408
 409 static void
 410 dumpfreespacecg(int fflag)
 411 {
 412
 413         pblklist(cg_blksfree(&acg), afs.fs_fpg, disk.d_lcg * afs.fs_fpg,
 414             fflag);
 415 }
 416
 417 static int
 418 marshal(const char *name)
 419 {
 420         struct fs *fs;
 421
 422         fs = &disk.d_fs;
 423
 424         printf("# newfs command for %s (%s)\n", name, disk.d_name);
 425         printf("newfs ");
 426         if (fs->fs_volname[0] != '\0')
 427                 printf("-L %s ", fs->fs_volname);
 428         printf("-O %d ", disk.d_ufs);
 429         if (fs->fs_flags & FS_DOSOFTDEP)
 430                 printf("-U ");
 431         printf("-a %d ", fs->fs_maxcontig);
 432         printf("-b %d ", fs->fs_bsize);
 433         /* -c is dumb */
 434         printf("-d %d ", fs->fs_maxbsize);
 435         printf("-e %d ", fs->fs_maxbpg);
 436         printf("-f %d ", fs->fs_fsize);
 437         printf("-g %d ", fs->fs_avgfilesize);
 438         printf("-h %d ", fs->fs_avgfpdir);
 439         printf("-i %jd ", fragroundup(fs, lblktosize(fs, fragstoblks(fs,
 440             fs->fs_fpg)) / fs->fs_ipg));
 441         if (fs->fs_flags & FS_SUJ)
 442                 printf("-j ");
 443         if (fs->fs_flags & FS_GJOURNAL)
 444                 printf("-J ");
 445         printf("-k %jd ", fs->fs_metaspace);
 446         if (fs->fs_flags & FS_MULTILABEL)
 447                 printf("-l ");
 448         printf("-m %d ", fs->fs_minfree);
 449         /* -n unimplemented */
 450         printf("-o ");
 451         switch (fs->fs_optim) {
 452         case FS_OPTSPACE:
 453                 printf("space ");
 454                 break;
 455         case FS_OPTTIME:
 456                 printf("time ");
 457                 break;
 458         default:
 459                 printf("unknown ");
 460                 break;
 461         }
 462         /* -p..r unimplemented */
 463         printf("-s %jd ", (intmax_t)fsbtodb(fs, fs->fs_size));
 464         if (fs->fs_flags & FS_TRIM)
 465                 printf("-t ");
 466         printf("%s ", disk.d_name);
 467         printf("\n");
 468
 469         return 0;
 470 }
 471
 472 static void
 473 pbits(void *vp, int max)
 474 {
 475         int i;
 476         char *p;
 477         int count, j;
 478
 479         for (count = i = 0, p = vp; i < max; i++)
 480                 if (isset(p, i)) {
 481                         if (count)
 482                                 printf(",%s", count % 6 ? " " : "\n\t");
 483                         count++;
 484                         printf("%d", i);
 485                         j = i;
 486                         while ((i+1)<max && isset(p, i+1))
 487                                 i++;
 488                         if (i != j)
 489                                 printf("-%d", i);
 490                 }
 491         printf("\n");
 492 }
 493
 494 static void
 495 pblklist(void *vp, int max, off_t offset, int fflag)
 496 {
 497         int i, j;
 498         char *p;
 499
 500         for (i = 0, p = vp; i < max; i++) {
 501                 if (isset(p, i)) {
 502                         printf("%jd", (intmax_t)(i + offset));
 503                         if (fflag < 2) {
 504                                 j = i;
 505                                 while ((i+1)<max && isset(p, i+1))
 506                                         i++;
 507                                 if (i != j)
 508                                         printf("-%jd", (intmax_t)(i + offset));
 509                         }
 510                         printf("\n");
 511                 }
 512         }
 513 }
 514
 515 static void
 516 ufserr(const char *name)
 517 {
 518         if (disk.d_error != NULL)
 519                 warnx("%s: %s", name, disk.d_error);
 520         else if (errno)
 521                 warn("%s", name);
 522 }
 523
 524 static void
 525 usage(void)
 526 {
 527         (void)fprintf(stderr, "usage: dumpfs [-flm] filesys | device\n");
 528         exit(1);
 529 }