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