2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1980, 1986, 1993
5 * The Regents of the University of California. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 static const char copyright[] =
35 "@(#) Copyright (c) 1980, 1986, 1993\n\
36 The Regents of the University of California. All rights reserved.\n";
40 static char sccsid[] = "@(#)main.c 8.6 (Berkeley) 5/14/95";
43 #include <sys/cdefs.h>
44 __FBSDID("$FreeBSD$");
47 #include <sys/param.h>
49 #include <sys/mount.h>
50 #include <sys/resource.h>
52 #include <sys/sysctl.h>
54 #include <sys/disklabel.h>
56 #include <ufs/ufs/dinode.h>
57 #include <ufs/ffs/fs.h>
75 static void usage(void) __dead2;
76 static intmax_t argtoimax(int flag, const char *req, const char *str, int base);
77 static int checkfilesys(char *filesys);
78 static int setup_bkgrdchk(struct statfs *mntp, int sbrdfailed, char **filesys);
81 main(int argc, char *argv[])
85 struct itimerval itimerval;
92 while ((ch = getopt(argc, argv, "b:Bc:CdEfFm:npRrSyZz")) != -1) {
96 bflag = argtoimax('b', "number", optarg, 10);
97 printf("Alternate super block location: %jd\n", bflag);
106 cvtlevel = argtoimax('c', "conversion level", optarg,
109 errx(EEXIT, "cannot do level %d conversion",
130 lfmode = argtoimax('m', "mode", optarg, 8);
132 errx(EEXIT, "bad mode to -m: %o", lfmode);
133 printf("** lost+found creation mode %o\n", lfmode);
183 if (bkgrdflag && cvtlevel > 0) {
184 pfatal("CANNOT CONVERT A SNAPSHOT\n");
188 if (signal(SIGINT, SIG_IGN) != SIG_IGN)
189 (void)signal(SIGINT, catch);
191 (void)signal(SIGQUIT, catchquit);
192 signal(SIGINFO, infohandler);
194 signal(SIGALRM, alarmhandler);
195 itimerval.it_interval.tv_sec = 5;
196 itimerval.it_interval.tv_usec = 0;
197 itimerval.it_value.tv_sec = 5;
198 itimerval.it_value.tv_usec = 0;
199 setitimer(ITIMER_REAL, &itimerval, NULL);
202 * Push up our allowed memory limit so we can cope
203 * with huge file systems.
205 if (getrlimit(RLIMIT_DATA, &rlimit) == 0) {
206 rlimit.rlim_cur = rlimit.rlim_max;
207 (void)setrlimit(RLIMIT_DATA, &rlimit);
210 if ((fsret = checkfilesys(*argv)) == ERESTART)
223 argtoimax(int flag, const char *req, const char *str, int base)
228 ret = strtoimax(str, &cp, base);
229 if (cp == str || *cp)
230 errx(EEXIT, "-%c flag requires a %s", flag, req);
235 * Check the specified file system.
239 checkfilesys(char *filesys)
241 ufs2_daddr_t n_ffree, n_bfree;
244 intmax_t blks, files;
246 int sbreadfailed, ofsmodified;
252 if (debug && ckclean)
255 * Make best effort to get the disk name. Check first to see
256 * if it is listed among the mounted file systems. Failing that
257 * check to see if it is listed in /etc/fstab.
259 mntp = getmntpoint(filesys);
261 filesys = mntp->f_mntfromname;
263 filesys = blockcheck(filesys);
265 * If -F flag specified, check to see whether a background check
266 * is possible and needed. If possible and needed, exit with
267 * status zero. Otherwise exit with status non-zero. A non-zero
268 * exit status will cause a foreground check to be run.
272 if (openfilesys(filesys) == 0 || readsb() == 0)
276 exit(3); /* Cannot read superblock */
277 if ((sblock.fs_flags & FS_NEEDSFSCK) == FS_NEEDSFSCK)
278 exit(4); /* Earlier background failed */
279 if ((sblock.fs_flags & FS_SUJ) == FS_SUJ) {
280 maxino = sblock.fs_ncg * sblock.fs_ipg;
281 maxfsblock = sblock.fs_size;
284 if (suj_check(filesys) == 0)
285 exit(4); /* Journal good, run it now */
287 if ((sblock.fs_flags & FS_DOSOFTDEP) == 0)
288 exit(5); /* Not running soft updates */
290 if (sysctlnametomib("vfs.ffs.adjrefcnt", adjrefcnt, &size) < 0)
291 exit(6); /* Lacks kernel support */
292 if ((mntp == NULL && sblock.fs_clean == 1) ||
293 (mntp != NULL && (sblock.fs_flags & FS_UNCLEAN) == 0))
294 exit(7); /* Filesystem clean, report it now */
297 if (ckclean && skipclean) {
299 * If file system is gjournaled, check it here.
302 exit(3); /* Cannot read superblock */
303 if (bkgrdflag == 0 &&
304 (nflag || (fswritefd = open(filesys, O_WRONLY)) < 0)) {
307 pfatal("NO WRITE ACCESS");
308 printf(" (NO WRITE)");
310 if ((sblock.fs_flags & FS_GJOURNAL) != 0) {
311 if (sblock.fs_clean == 1) {
312 pwarn("FILE SYSTEM CLEAN; SKIPPING CHECKS\n");
315 if ((sblock.fs_flags &
316 (FS_UNCLEAN | FS_NEEDSFSCK)) == 0) {
318 gjournal_check(filesys);
319 if (chkdoreload(mntp, pwarn) == 0)
323 pfatal("FULL FSCK NEEDED, CANNOT RUN FAST "
331 switch (setup_bkgrdchk(mntp, sbreadfailed, &filesys)) {
332 case -1: /* filesystem clean */
334 case 0: /* cannot do background, give up */
336 case 1: /* doing background check, preen rules apply */
342 switch (setup(filesys)) {
345 pfatal("CAN'T CHECK FILE SYSTEM.");
349 pwarn("clean, %ld free ", (long)(sblock.fs_cstotal.cs_nffree +
350 sblock.fs_frag * sblock.fs_cstotal.cs_nbfree));
351 printf("(%jd frags, %jd blocks, %.1f%% fragmentation)\n",
352 (intmax_t)sblock.fs_cstotal.cs_nffree,
353 (intmax_t)sblock.fs_cstotal.cs_nbfree,
354 sblock.fs_cstotal.cs_nffree * 100.0 / sblock.fs_dsize);
358 * Determine if we can and should do journal recovery.
360 if (bkgrdflag == 0 && (sblock.fs_flags & FS_SUJ) == FS_SUJ) {
361 if ((sblock.fs_flags & FS_NEEDSFSCK) != FS_NEEDSFSCK &&
364 if (suj_check(filesys) == 0) {
365 pwarn("\n**** FILE SYSTEM MARKED CLEAN ****\n");
366 if (chkdoreload(mntp, pwarn) == 0)
371 pwarn("Skipping journal, "
372 "falling through to full fsck\n");
374 if (fswritefd != -1) {
376 * Write the superblock so we don't try to recover the
377 * journal on another pass. If this is the only change
378 * to the filesystem, we do not want it to be called
381 sblock.fs_mtime = time(NULL);
383 ofsmodified = fsmodified;
384 flush(fswritefd, &sblk);
385 fsmodified = ofsmodified;
389 * If the filesystem was run on an old kernel that did not
390 * support check hashes, clear the check-hash flags so that
391 * we do not try to verify them.
393 if ((sblock.fs_flags & FS_METACKHASH) == 0)
394 sblock.fs_metackhash = 0;
396 * If we are running on a kernel that can provide check hashes
397 * that are not yet enabled for the filesystem and we are
398 * running manually without the -y flag, offer to add any
399 * supported check hashes that are not already enabled.
402 if (preen == 0 && yflag == 0 && sblock.fs_magic != FS_UFS1_MAGIC &&
403 fswritefd != -1 && getosreldate() >= P_OSREL_CK_CYLGRP) {
404 if ((sblock.fs_metackhash & CK_CYLGRP) == 0 &&
405 reply("ADD CYLINDER GROUP CHECK-HASH PROTECTION") != 0) {
406 ckhashadd |= CK_CYLGRP;
407 sblock.fs_metackhash |= CK_CYLGRP;
409 if ((sblock.fs_metackhash & CK_SUPERBLOCK) == 0 &&
410 getosreldate() >= P_OSREL_CK_SUPERBLOCK &&
411 reply("ADD SUPERBLOCK CHECK-HASH PROTECTION") != 0) {
412 ckhashadd |= CK_SUPERBLOCK;
413 sblock.fs_metackhash |= CK_SUPERBLOCK;
415 if ((sblock.fs_metackhash & CK_INODE) == 0 &&
416 getosreldate() >= P_OSREL_CK_INODE &&
417 reply("ADD INODE CHECK-HASH PROTECTION") != 0) {
418 ckhashadd |= CK_INODE;
419 sblock.fs_metackhash |= CK_INODE;
422 if ((sblock.fs_metackhash & CK_INDIR) == 0 &&
423 getosreldate() >= P_OSREL_CK_INDIR &&
424 reply("ADD INDIRECT BLOCK CHECK-HASH PROTECTION") != 0) {
425 ckhashadd |= CK_INDIR;
426 sblock.fs_metackhash |= CK_INDIR;
428 if ((sblock.fs_metackhash & CK_DIR) == 0 &&
429 getosreldate() >= P_OSREL_CK_DIR &&
430 reply("ADD DIRECTORY CHECK-HASH PROTECTION") != 0) {
432 sblock.fs_metackhash |= CK_DIR;
435 if (ckhashadd != 0) {
436 sblock.fs_flags |= FS_METACKHASH;
441 * Cleared if any questions answered no. Used to decide if
442 * the superblock should be marked clean.
446 * 1: scan inodes tallying blocks used
448 if (preen == 0 || debug) {
449 printf("** Last Mounted on %s\n", sblock.fs_fsmnt);
450 if (mntp != NULL && mntp->f_flags & MNT_ROOTFS)
451 printf("** Root file system\n");
452 printf("** Phase 1 - Check Blocks and Sizes\n");
454 clock_gettime(CLOCK_REALTIME_PRECISE, &startprog);
459 * 1b: locate first references to duplicates, if any
462 if (preen || usedsoftdep)
463 pfatal("INTERNAL ERROR: DUPS WITH %s%s%s",
465 (preen && usedsoftdep) ? " AND " : "",
466 usedsoftdep ? "SOFTUPDATES" : "");
467 if (preen == 0 || debug)
468 printf("** Phase 1b - Rescan For More DUPS\n");
474 * 2: traverse directories from root to mark all connected directories
476 if (preen == 0 || debug)
477 printf("** Phase 2 - Check Pathnames\n");
482 * 3: scan inodes looking for disconnected directories
484 if (preen == 0 || debug)
485 printf("** Phase 3 - Check Connectivity\n");
490 * 4: scan inodes looking for disconnected files; check reference counts
492 if (preen == 0 || debug)
493 printf("** Phase 4 - Check Reference Counts\n");
498 * 5: check and repair resource counts in cylinder groups
500 if (preen == 0 || debug)
501 printf("** Phase 5 - Check Cyl groups\n");
502 snapflush(std_checkblkavail);
503 if (cgheader_corrupt) {
504 printf("PHASE 5 SKIPPED DUE TO CORRUPT CYLINDER GROUP "
512 * print out summary statistics
514 n_ffree = sblock.fs_cstotal.cs_nffree;
515 n_bfree = sblock.fs_cstotal.cs_nbfree;
516 files = maxino - UFS_ROOTINO - sblock.fs_cstotal.cs_nifree - n_files;
518 sblock.fs_ncg * (cgdmin(&sblock, 0) - cgsblock(&sblock, 0));
519 blks += cgsblock(&sblock, 0) - cgbase(&sblock, 0);
520 blks += howmany(sblock.fs_cssize, sblock.fs_fsize);
521 blks = maxfsblock - (n_ffree + sblock.fs_frag * n_bfree) - blks;
522 if (bkgrdflag && (files > 0 || blks > 0)) {
523 countdirs = sblock.fs_cstotal.cs_ndir - countdirs;
524 pwarn("Reclaimed: %ld directories, %jd files, %jd fragments\n",
525 countdirs, files - countdirs, blks);
527 pwarn("%ld files, %jd used, %ju free ",
528 (long)n_files, (intmax_t)n_blks,
529 (uintmax_t)n_ffree + sblock.fs_frag * n_bfree);
530 printf("(%ju frags, %ju blocks, %.1f%% fragmentation)\n",
531 (uintmax_t)n_ffree, (uintmax_t)n_bfree,
532 n_ffree * 100.0 / sblock.fs_dsize);
535 printf("%jd inodes missing\n", -files);
537 printf("%jd blocks missing\n", -blks);
538 if (duplist != NULL) {
539 printf("The following duplicate blocks remain:");
540 for (dp = duplist; dp; dp = dp->next)
541 printf(" %jd,", (intmax_t)dp->dup);
545 duplist = (struct dups *)0;
546 muldup = (struct dups *)0;
549 sblock.fs_time = time(NULL);
552 if (cvtlevel && (sblk.b_flags & B_DIRTY) != 0) {
554 * Write out the duplicate super blocks
556 if (sbput(fswritefd, &sblock, sblock.fs_ncg) == 0)
563 * Check to see if the file system is mounted read-write.
565 if (bkgrdflag == 0 && mntp != NULL && (mntp->f_flags & MNT_RDONLY) == 0)
569 if (fsmodified && !preen)
570 printf("\n***** FILE SYSTEM WAS MODIFIED *****\n");
572 if (wantrestart && (restarts++ < 10) &&
573 (preen || reply("RESTART")))
575 printf("\n***** PLEASE RERUN FSCK *****\n");
577 if (chkdoreload(mntp, pwarn) != 0) {
581 printf("\n***** REBOOT NOW *****\n");
585 return (rerun ? ERERUN : 0);
589 * If we are to do a background check:
590 * Get the mount point information of the file system
591 * If already clean, return -1
592 * Check that kernel supports background fsck
593 * Find or create the snapshot directory
594 * Create the snapshot file
596 * If anything fails print reason and return 0 which exits
599 setup_bkgrdchk(struct statfs *mntp, int sbreadfailed, char **filesys)
608 /* Get the mount point information of the file system */
610 pwarn("NOT MOUNTED, CANNOT RUN IN BACKGROUND\n");
613 if ((mntp->f_flags & MNT_RDONLY) != 0) {
614 pwarn("MOUNTED READ-ONLY, CANNOT RUN IN BACKGROUND\n");
617 if ((mntp->f_flags & MNT_SOFTDEP) == 0) {
618 pwarn("NOT USING SOFT UPDATES, CANNOT RUN IN BACKGROUND\n");
622 pwarn("SUPERBLOCK READ FAILED, CANNOT RUN IN BACKGROUND\n");
625 if ((sblock.fs_flags & FS_NEEDSFSCK) != 0) {
626 pwarn("FULL FSCK NEEDED, CANNOT RUN IN BACKGROUND\n");
629 if (skipclean && ckclean &&
630 (sblock.fs_flags & (FS_UNCLEAN|FS_NEEDSFSCK)) == 0) {
632 * file system is clean;
633 * skip snapshot and report it clean
635 pwarn("FILE SYSTEM CLEAN; SKIPPING CHECKS\n");
638 /* Check that kernel supports background fsck */
640 if (sysctlnametomib("vfs.ffs.adjrefcnt", adjrefcnt, &size) < 0||
641 sysctlnametomib("vfs.ffs.adjblkcnt", adjblkcnt, &size) < 0||
642 sysctlnametomib("vfs.ffs.setsize", setsize, &size) < 0 ||
643 sysctlnametomib("vfs.ffs.freefiles", freefiles, &size) < 0||
644 sysctlnametomib("vfs.ffs.freedirs", freedirs, &size) < 0 ||
645 sysctlnametomib("vfs.ffs.freeblks", freeblks, &size) < 0) {
646 pwarn("KERNEL LACKS BACKGROUND FSCK SUPPORT\n");
650 * When kernel lacks runtime bgfsck superblock summary
651 * adjustment functionality, it does not mean we can not
652 * continue, as old kernels will recompute the summary at
653 * mount time. However, it will be an unexpected softupdates
654 * inconsistency if it turns out that the summary is still
655 * incorrect. Set a flag so subsequent operation can know this.
658 if (sysctlnametomib("vfs.ffs.adjndir", adjndir, &size) < 0 ||
659 sysctlnametomib("vfs.ffs.adjnbfree", adjnbfree, &size) < 0 ||
660 sysctlnametomib("vfs.ffs.adjnifree", adjnifree, &size) < 0 ||
661 sysctlnametomib("vfs.ffs.adjnffree", adjnffree, &size) < 0 ||
662 sysctlnametomib("vfs.ffs.adjnumclusters", adjnumclusters,
665 pwarn("KERNEL LACKS RUNTIME SUPERBLOCK SUMMARY ADJUSTMENT "
668 /* Find or create the snapshot directory */
669 snprintf(snapname, sizeof snapname, "%s/.snap",
671 if (stat(snapname, &snapdir) < 0) {
672 if (errno != ENOENT) {
673 pwarn("CANNOT FIND SNAPSHOT DIRECTORY %s: %s, CANNOT "
674 "RUN IN BACKGROUND\n", snapname, strerror(errno));
677 if ((grp = getgrnam("operator")) == NULL ||
678 mkdir(snapname, 0770) < 0 ||
679 chown(snapname, -1, grp->gr_gid) < 0 ||
680 chmod(snapname, 0770) < 0) {
681 pwarn("CANNOT CREATE SNAPSHOT DIRECTORY %s: %s, "
682 "CANNOT RUN IN BACKGROUND\n", snapname,
686 } else if (!S_ISDIR(snapdir.st_mode)) {
687 pwarn("%s IS NOT A DIRECTORY, CANNOT RUN IN BACKGROUND\n",
691 /* Create the snapshot file */
695 snprintf(snapname, sizeof snapname, "%s/.snap/fsck_snapshot",
697 build_iovec(&iov, &iovlen, "fstype", "ffs", 4);
698 build_iovec(&iov, &iovlen, "from", snapname, (size_t)-1);
699 build_iovec(&iov, &iovlen, "fspath", mntp->f_mntonname, (size_t)-1);
700 build_iovec(&iov, &iovlen, "errmsg", errmsg, sizeof(errmsg));
701 build_iovec(&iov, &iovlen, "update", NULL, 0);
702 build_iovec(&iov, &iovlen, "snapshot", NULL, 0);
703 /* Create snapshot, removing old snapshot if it exists */
704 while (nmount(iov, iovlen, mntp->f_flags) < 0) {
705 if (errno == EEXIST && unlink(snapname) == 0)
707 pwarn("CANNOT CREATE SNAPSHOT %s: %s %s\n", snapname,
708 strerror(errno), errmsg);
712 if (openfilesys(snapname) == 0) {
714 pwarn("CANNOT OPEN SNAPSHOT %s: %s, CANNOT RUN IN "
715 "BACKGROUND\n", snapname, strerror(errno));
721 pwarn("CANNOT READ SNAPSHOT SUPERBLOCK\n");
725 cmd.version = FFS_CMD_VERSION;
726 cmd.handle = fsreadfd;
733 (void) fprintf(stderr,
734 "usage: %s [-BCdEFfnpRrSyZ] [-b block] [-c level] [-m mode] filesystem ...\n",
740 infohandler(int sig __unused)
746 alarmhandler(int sig __unused)