sbin/fsck_ffs/main.c

   1 /*
   2  * Copyright (c) 1980, 1986, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 4. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29
  30 #if 0
  31 #ifndef lint
  32 static const char copyright[] =
  33 "@(#) Copyright (c) 1980, 1986, 1993\n\
  34         The Regents of the University of California.  All rights reserved.\n";
  35 #endif /* not lint */
  36
  37 #ifndef lint
  38 static char sccsid[] = "@(#)main.c      8.6 (Berkeley) 5/14/95";
  39 #endif /* not lint */
  40 #endif
  41 #include <sys/cdefs.h>
  42 __FBSDID("$FreeBSD$");
  43
  44 #include <sys/param.h>
  45 #include <sys/stat.h>
  46 #include <sys/file.h>
  47 #include <sys/time.h>
  48 #include <sys/mount.h>
  49 #include <sys/resource.h>
  50 #include <sys/sysctl.h>
  51 #include <sys/uio.h>
  52 #include <sys/disklabel.h>
  53
  54 #include <ufs/ufs/dinode.h>
  55 #include <ufs/ffs/fs.h>
  56
  57 #include <err.h>
  58 #include <errno.h>
  59 #include <fstab.h>
  60 #include <grp.h>
  61 #include <mntopts.h>
  62 #include <paths.h>
  63 #include <stdint.h>
  64 #include <string.h>
  65
  66 #include "fsck.h"
  67
  68 static void usage(void) __dead2;
  69 static int argtoi(int flag, const char *req, const char *str, int base);
  70 static int checkfilesys(char *filesys);
  71 static int chkdoreload(struct statfs *mntp);
  72 static struct statfs *getmntpt(const char *);
  73
  74 int
  75 main(int argc, char *argv[])
  76 {
  77         int ch;
  78         struct rlimit rlimit;
  79         struct itimerval itimerval;
  80         int ret = 0;
  81
  82         sync();
  83         skipclean = 1;
  84         while ((ch = getopt(argc, argv, "b:Bc:dfFm:npy")) != -1) {
  85                 switch (ch) {
  86                 case 'b':
  87                         skipclean = 0;
  88                         bflag = argtoi('b', "number", optarg, 10);
  89                         printf("Alternate super block location: %d\n", bflag);
  90                         break;
  91
  92                 case 'B':
  93                         bkgrdflag = 1;
  94                         break;
  95
  96                 case 'c':
  97                         skipclean = 0;
  98                         cvtlevel = argtoi('c', "conversion level", optarg, 10);
  99                         if (cvtlevel < 3)
 100                                 errx(EEXIT, "cannot do level %d conversion",
 101                                     cvtlevel);
 102                         break;
 103
 104                 case 'd':
 105                         debug++;
 106                         break;
 107
 108                 case 'f':
 109                         skipclean = 0;
 110                         break;
 111
 112                 case 'F':
 113                         bkgrdcheck = 1;
 114                         break;
 115
 116                 case 'm':
 117                         lfmode = argtoi('m', "mode", optarg, 8);
 118                         if (lfmode &~ 07777)
 119                                 errx(EEXIT, "bad mode to -m: %o", lfmode);
 120                         printf("** lost+found creation mode %o\n", lfmode);
 121                         break;
 122
 123                 case 'n':
 124                         nflag++;
 125                         yflag = 0;
 126                         break;
 127
 128                 case 'p':
 129                         preen++;
 130                         break;
 131
 132                 case 'y':
 133                         yflag++;
 134                         nflag = 0;
 135                         break;
 136
 137                 default:
 138                         usage();
 139                 }
 140         }
 141         argc -= optind;
 142         argv += optind;
 143
 144         if (!argc)
 145                 usage();
 146
 147         if (signal(SIGINT, SIG_IGN) != SIG_IGN)
 148                 (void)signal(SIGINT, catch);
 149         if (preen)
 150                 (void)signal(SIGQUIT, catchquit);
 151         signal(SIGINFO, infohandler);
 152         if (bkgrdflag) {
 153                 signal(SIGALRM, alarmhandler);
 154                 itimerval.it_interval.tv_sec = 5;
 155                 itimerval.it_interval.tv_usec = 0;
 156                 itimerval.it_value.tv_sec = 5;
 157                 itimerval.it_value.tv_usec = 0;
 158                 setitimer(ITIMER_REAL, &itimerval, NULL);
 159         }
 160         /*
 161          * Push up our allowed memory limit so we can cope
 162          * with huge file systems.
 163          */
 164         if (getrlimit(RLIMIT_DATA, &rlimit) == 0) {
 165                 rlimit.rlim_cur = rlimit.rlim_max;
 166                 (void)setrlimit(RLIMIT_DATA, &rlimit);
 167         }
 168         while (argc-- > 0)
 169                 (void)checkfilesys(*argv++);
 170
 171         if (returntosingle)
 172                 ret = 2;
 173         exit(ret);
 174 }
 175
 176 static int
 177 argtoi(int flag, const char *req, const char *str, int base)
 178 {
 179         char *cp;
 180         int ret;
 181
 182         ret = (int)strtol(str, &cp, base);
 183         if (cp == str || *cp)
 184                 errx(EEXIT, "-%c flag requires a %s", flag, req);
 185         return (ret);
 186 }
 187
 188 /*
 189  * Check the specified file system.
 190  */
 191 /* ARGSUSED */
 192 static int
 193 checkfilesys(char *filesys)
 194 {
 195         ufs2_daddr_t n_ffree, n_bfree;
 196         struct dups *dp;
 197         struct statfs *mntp;
 198         struct stat snapdir;
 199         struct group *grp;
 200         ufs2_daddr_t blks;
 201         struct iovec *iov;
 202         char errmsg[255];
 203         int iovlen;
 204         int fflags;
 205         int cylno;
 206         ino_t files;
 207         size_t size;
 208
 209         iov = NULL;
 210         iovlen = 0;
 211         errmsg[0] = '\0';
 212
 213         cdevname = filesys;
 214         if (debug && preen)
 215                 pwarn("starting\n");
 216         /*
 217          * Make best effort to get the disk name. Check first to see
 218          * if it is listed among the mounted file systems. Failing that
 219          * check to see if it is listed in /etc/fstab.
 220          */
 221         mntp = getmntpt(filesys);
 222         if (mntp != NULL)
 223                 filesys = mntp->f_mntfromname;
 224         else
 225                 filesys = blockcheck(filesys);
 226         /*
 227          * If -F flag specified, check to see whether a background check
 228          * is possible and needed. If possible and needed, exit with
 229          * status zero. Otherwise exit with status non-zero. A non-zero
 230          * exit status will cause a foreground check to be run.
 231          */
 232         sblock_init();
 233         if (bkgrdcheck) {
 234                 if ((fsreadfd = open(filesys, O_RDONLY)) < 0 || readsb(0) == 0)
 235                         exit(3);        /* Cannot read superblock */
 236                 close(fsreadfd);
 237                 if (sblock.fs_flags & FS_NEEDSFSCK)
 238                         exit(4);        /* Earlier background failed */
 239                 if ((sblock.fs_flags & FS_DOSOFTDEP) == 0)
 240                         exit(5);        /* Not running soft updates */
 241                 size = MIBSIZE;
 242                 if (sysctlnametomib("vfs.ffs.adjrefcnt", adjrefcnt, &size) < 0)
 243                         exit(6);        /* Lacks kernel support */
 244                 if ((mntp == NULL && sblock.fs_clean == 1) ||
 245                     (mntp != NULL && (sblock.fs_flags & FS_UNCLEAN) == 0))
 246                         exit(7);        /* Filesystem clean, report it now */
 247                 exit(0);
 248         }
 249         if (preen && skipclean) {
 250                 /*
 251                  * If file system is gjournaled, check it here.
 252                  */
 253                 if ((fsreadfd = open(filesys, O_RDONLY)) < 0 || readsb(0) == 0)
 254                         exit(3);        /* Cannot read superblock */
 255                 close(fsreadfd);
 256                 if ((sblock.fs_flags & FS_GJOURNAL) != 0) {
 257                         //printf("GJournaled file system detected on %s.\n",
 258                         //    filesys);
 259                         if (sblock.fs_clean == 1) {
 260                                 pwarn("FILE SYSTEM CLEAN; SKIPPING CHECKS\n");
 261                                 exit(0);
 262                         }
 263                         if ((sblock.fs_flags & (FS_UNCLEAN | FS_NEEDSFSCK)) == 0) {
 264                                 gjournal_check(filesys);
 265                                 if (chkdoreload(mntp) == 0)
 266                                         exit(0);
 267                                 exit(4);
 268                         } else {
 269                                 pfatal("UNEXPECTED INCONSISTENCY, %s\n",
 270                                     "CANNOT RUN FAST FSCK\n");
 271                         }
 272                 }
 273         }
 274         /*
 275          * If we are to do a background check:
 276          *      Get the mount point information of the file system
 277          *      create snapshot file
 278          *      return created snapshot file
 279          *      if not found, clear bkgrdflag and proceed with normal fsck
 280          */
 281         if (bkgrdflag) {
 282                 if (mntp == NULL) {
 283                         bkgrdflag = 0;
 284                         pfatal("NOT MOUNTED, CANNOT RUN IN BACKGROUND\n");
 285                 } else if ((mntp->f_flags & MNT_SOFTDEP) == 0) {
 286                         bkgrdflag = 0;
 287                         pfatal("NOT USING SOFT UPDATES, %s\n",
 288                             "CANNOT RUN IN BACKGROUND");
 289                 } else if ((mntp->f_flags & MNT_RDONLY) != 0) {
 290                         bkgrdflag = 0;
 291                         pfatal("MOUNTED READ-ONLY, CANNOT RUN IN BACKGROUND\n");
 292                 } else if ((fsreadfd = open(filesys, O_RDONLY)) >= 0) {
 293                         if (readsb(0) != 0) {
 294                                 if (sblock.fs_flags & FS_NEEDSFSCK) {
 295                                         bkgrdflag = 0;
 296                                         pfatal("UNEXPECTED INCONSISTENCY, %s\n",
 297                                             "CANNOT RUN IN BACKGROUND\n");
 298                                 }
 299                                 if ((sblock.fs_flags & FS_UNCLEAN) == 0 &&
 300                                     skipclean && preen) {
 301                                         /*
 302                                          * file system is clean;
 303                                          * skip snapshot and report it clean
 304                                          */
 305                                         pwarn("FILE SYSTEM CLEAN; %s\n",
 306                                             "SKIPPING CHECKS");
 307                                         goto clean;
 308                                 }
 309                         }
 310                         close(fsreadfd);
 311                 }
 312                 if (bkgrdflag) {
 313                         snprintf(snapname, sizeof snapname, "%s/.snap",
 314                             mntp->f_mntonname);
 315                         if (stat(snapname, &snapdir) < 0) {
 316                                 if (errno != ENOENT) {
 317                                         bkgrdflag = 0;
 318                                         pfatal("CANNOT FIND %s %s: %s, %s\n",
 319                                             "SNAPSHOT DIRECTORY",
 320                                             snapname, strerror(errno),
 321                                             "CANNOT RUN IN BACKGROUND");
 322                                 } else if ((grp = getgrnam("operator")) == 0 ||
 323                                     mkdir(snapname, 0770) < 0 ||
 324                                     chown(snapname, -1, grp->gr_gid) < 0 ||
 325                                     chmod(snapname, 0770) < 0) {
 326                                         bkgrdflag = 0;
 327                                         pfatal("CANNOT CREATE %s %s: %s, %s\n",
 328                                             "SNAPSHOT DIRECTORY",
 329                                             snapname, strerror(errno),
 330                                             "CANNOT RUN IN BACKGROUND");
 331                                 }
 332                         } else if (!S_ISDIR(snapdir.st_mode)) {
 333                                 bkgrdflag = 0;
 334                                 pfatal("%s IS NOT A DIRECTORY, %s\n", snapname,
 335                                     "CANNOT RUN IN BACKGROUND");
 336                         }
 337                 }
 338                 if (bkgrdflag) {
 339                         snprintf(snapname, sizeof snapname,
 340                             "%s/.snap/fsck_snapshot", mntp->f_mntonname);
 341                         fflags = mntp->f_flags;
 342                         /*
 343                          * XXX: Need to kick out MNT_ROOTFS until we fix
 344                          * nmount().
 345                          */
 346                         fflags &= ~MNT_ROOTFS;
 347                         fflags = fflags | MNT_UPDATE | MNT_SNAPSHOT;
 348                         build_iovec(&iov, &iovlen, "fstype", "ffs", 4);
 349                         build_iovec(&iov, &iovlen, "from", snapname,
 350                             (size_t)-1);
 351                         build_iovec(&iov, &iovlen, "fspath", mntp->f_mntonname,
 352                             (size_t)-1);
 353                         build_iovec(&iov, &iovlen, "errmsg", errmsg,
 354                             sizeof(errmsg));
 355
 356                         while (nmount(iov, iovlen, fflags) < 0) {
 357                                 if (errno == EEXIST && unlink(snapname) == 0)
 358                                         continue;
 359                                 bkgrdflag = 0;
 360                                 pfatal("CANNOT CREATE SNAPSHOT %s: %s %s\n",
 361                                     snapname, strerror(errno), errmsg);
 362                                 break;
 363                         }
 364                         if (bkgrdflag != 0)
 365                                 filesys = snapname;
 366                 }
 367         }
 368
 369         switch (setup(filesys)) {
 370         case 0:
 371                 if (preen)
 372                         pfatal("CAN'T CHECK FILE SYSTEM.");
 373                 return (0);
 374         case -1:
 375         clean:
 376                 pwarn("clean, %ld free ", (long)(sblock.fs_cstotal.cs_nffree +
 377                     sblock.fs_frag * sblock.fs_cstotal.cs_nbfree));
 378                 printf("(%lld frags, %lld blocks, %.1f%% fragmentation)\n",
 379                     (long long)sblock.fs_cstotal.cs_nffree,
 380                     (long long)sblock.fs_cstotal.cs_nbfree,
 381                     sblock.fs_cstotal.cs_nffree * 100.0 / sblock.fs_dsize);
 382                 return (0);
 383         }
 384
 385         /*
 386          * Cleared if any questions answered no. Used to decide if
 387          * the superblock should be marked clean.
 388          */
 389         resolved = 1;
 390         /*
 391          * 1: scan inodes tallying blocks used
 392          */
 393         if (preen == 0) {
 394                 printf("** Last Mounted on %s\n", sblock.fs_fsmnt);
 395                 if (mntp != NULL && mntp->f_flags & MNT_ROOTFS)
 396                         printf("** Root file system\n");
 397                 printf("** Phase 1 - Check Blocks and Sizes\n");
 398         }
 399         pass1();
 400
 401         /*
 402          * 1b: locate first references to duplicates, if any
 403          */
 404         if (duplist) {
 405                 if (preen || usedsoftdep)
 406                         pfatal("INTERNAL ERROR: dups with -p");
 407                 printf("** Phase 1b - Rescan For More DUPS\n");
 408                 pass1b();
 409         }
 410
 411         /*
 412          * 2: traverse directories from root to mark all connected directories
 413          */
 414         if (preen == 0)
 415                 printf("** Phase 2 - Check Pathnames\n");
 416         pass2();
 417
 418         /*
 419          * 3: scan inodes looking for disconnected directories
 420          */
 421         if (preen == 0)
 422                 printf("** Phase 3 - Check Connectivity\n");
 423         pass3();
 424
 425         /*
 426          * 4: scan inodes looking for disconnected files; check reference counts
 427          */
 428         if (preen == 0)
 429                 printf("** Phase 4 - Check Reference Counts\n");
 430         pass4();
 431
 432         /*
 433          * 5: check and repair resource counts in cylinder groups
 434          */
 435         if (preen == 0)
 436                 printf("** Phase 5 - Check Cyl groups\n");
 437         pass5();
 438
 439         /*
 440          * print out summary statistics
 441          */
 442         n_ffree = sblock.fs_cstotal.cs_nffree;
 443         n_bfree = sblock.fs_cstotal.cs_nbfree;
 444         files = maxino - ROOTINO - sblock.fs_cstotal.cs_nifree - n_files;
 445         blks = n_blks +
 446             sblock.fs_ncg * (cgdmin(&sblock, 0) - cgsblock(&sblock, 0));
 447         blks += cgsblock(&sblock, 0) - cgbase(&sblock, 0);
 448         blks += howmany(sblock.fs_cssize, sblock.fs_fsize);
 449         blks = maxfsblock - (n_ffree + sblock.fs_frag * n_bfree) - blks;
 450         if (bkgrdflag && (files > 0 || blks > 0)) {
 451                 countdirs = sblock.fs_cstotal.cs_ndir - countdirs;
 452                 pwarn("Reclaimed: %ld directories, %ld files, %lld fragments\n",
 453                     countdirs, (long)files - countdirs, (long long)blks);
 454         }
 455         pwarn("%ld files, %jd used, %ju free ",
 456             (long)n_files, (intmax_t)n_blks,
 457             (uintmax_t)n_ffree + sblock.fs_frag * n_bfree);
 458         printf("(%ju frags, %ju blocks, %.1f%% fragmentation)\n",
 459             (uintmax_t)n_ffree, (uintmax_t)n_bfree,
 460             n_ffree * 100.0 / sblock.fs_dsize);
 461         if (debug) {
 462                 if (files < 0)
 463                         printf("%d inodes missing\n", -files);
 464                 if (blks < 0)
 465                         printf("%lld blocks missing\n", -(long long)blks);
 466                 if (duplist != NULL) {
 467                         printf("The following duplicate blocks remain:");
 468                         for (dp = duplist; dp; dp = dp->next)
 469                                 printf(" %lld,", (long long)dp->dup);
 470                         printf("\n");
 471                 }
 472         }
 473         duplist = (struct dups *)0;
 474         muldup = (struct dups *)0;
 475         inocleanup();
 476         if (fsmodified) {
 477                 sblock.fs_time = time(NULL);
 478                 sbdirty();
 479         }
 480         if (cvtlevel && sblk.b_dirty) {
 481                 /*
 482                  * Write out the duplicate super blocks
 483                  */
 484                 for (cylno = 0; cylno < sblock.fs_ncg; cylno++)
 485                         blwrite(fswritefd, (char *)&sblock,
 486                             fsbtodb(&sblock, cgsblock(&sblock, cylno)),
 487                             SBLOCKSIZE);
 488         }
 489         if (rerun)
 490                 resolved = 0;
 491
 492         /*
 493          * Check to see if the file system is mounted read-write.
 494          */
 495         if (bkgrdflag == 0 && mntp != NULL && (mntp->f_flags & MNT_RDONLY) == 0)
 496                 resolved = 0;
 497         ckfini(resolved);
 498
 499         for (cylno = 0; cylno < sblock.fs_ncg; cylno++)
 500                 if (inostathead[cylno].il_stat != NULL)
 501                         free((char *)inostathead[cylno].il_stat);
 502         free((char *)inostathead);
 503         inostathead = NULL;
 504         if (fsmodified && !preen)
 505                 printf("\n***** FILE SYSTEM WAS MODIFIED *****\n");
 506         if (rerun)
 507                 printf("\n***** PLEASE RERUN FSCK *****\n");
 508         if (chkdoreload(mntp) != 0) {
 509                 if (!fsmodified)
 510                         return (0);
 511                 if (!preen)
 512                         printf("\n***** REBOOT NOW *****\n");
 513                 sync();
 514                 return (4);
 515         }
 516         return (0);
 517 }
 518
 519 static int
 520 chkdoreload(struct statfs *mntp)
 521 {
 522         struct iovec *iov;
 523         int iovlen;
 524         int fflags;
 525         char errmsg[255];
 526
 527         if (mntp == NULL)
 528                 return (0);
 529
 530         iov = NULL;
 531         iovlen = 0;
 532         errmsg[0] = '\0';
 533         fflags = mntp->f_flags;
 534         /*
 535          * We modified a mounted file system.  Do a mount update on
 536          * it unless it is read-write, so we can continue using it
 537          * as safely as possible.
 538          */
 539         if (mntp->f_flags & MNT_RDONLY) {
 540                 /*
 541                  * XXX: Need to kick out MNT_ROOTFS until we fix
 542                  * nmount().
 543                  */
 544                 fflags &= ~MNT_ROOTFS;
 545                 fflags = fflags | MNT_UPDATE | MNT_RELOAD;
 546                 build_iovec(&iov, &iovlen, "fstype", "ffs", 4);
 547                 build_iovec(&iov, &iovlen, "from", mntp->f_mntfromname,
 548                     (size_t)-1);
 549                 build_iovec(&iov, &iovlen, "fspath", mntp->f_mntonname,
 550                     (size_t)-1);
 551                 build_iovec(&iov, &iovlen, "errmsg", errmsg,
 552                     sizeof(errmsg));
 553                 if (nmount(iov, iovlen, fflags) == 0) {
 554                         return (0);
 555                 }
 556                 pwarn("mount reload of '%s' failed: %s %s\n\n",
 557                     mntp->f_mntonname, strerror(errno), errmsg);
 558                 return (1);
 559         }
 560         return (0);
 561 }
 562
 563 /*
 564  * Get the mount point information for name.
 565  */
 566 static struct statfs *
 567 getmntpt(const char *name)
 568 {
 569         struct stat devstat, mntdevstat;
 570         char device[sizeof(_PATH_DEV) - 1 + MNAMELEN];
 571         char *ddevname;
 572         struct statfs *mntbuf, *statfsp;
 573         int i, mntsize, isdev;
 574
 575         if (stat(name, &devstat) != 0)
 576                 return (NULL);
 577         if (S_ISCHR(devstat.st_mode) || S_ISBLK(devstat.st_mode))
 578                 isdev = 1;
 579         else
 580                 isdev = 0;
 581         mntsize = getmntinfo(&mntbuf, MNT_NOWAIT);
 582         for (i = 0; i < mntsize; i++) {
 583                 statfsp = &mntbuf[i];
 584                 ddevname = statfsp->f_mntfromname;
 585                 if (*ddevname != '/') {
 586                         strcpy(device, _PATH_DEV);
 587                         strcat(device, ddevname);
 588                         strcpy(statfsp->f_mntfromname, device);
 589                 }
 590                 if (isdev == 0) {
 591                         if (strcmp(name, statfsp->f_mntonname))
 592                                 continue;
 593                         return (statfsp);
 594                 }
 595                 if (stat(ddevname, &mntdevstat) == 0 &&
 596                     mntdevstat.st_rdev == devstat.st_rdev)
 597                         return (statfsp);
 598         }
 599         statfsp = NULL;
 600         return (statfsp);
 601 }
 602
 603 static void
 604 usage(void)
 605 {
 606         (void) fprintf(stderr,
 607             "usage: %s [-BFpfny] [-b block] [-c level] [-m mode] "
 608                         "filesystem ...\n",
 609             getprogname());
 610         exit(1);
 611 }