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