main.c revision 136281 
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 136281 2004-10-08 20:44:47Z truckman $");
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/disklabel.h>
52
53#include <ufs/ufs/dinode.h>
54#include <ufs/ufs/ufsmount.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 <paths.h>
62#include <stdint.h>
63#include <string.h>
64
65#include "fsck.h"
66
67static void usage(void) __dead2;
68static int argtoi(int flag, const char *req, const char *str, int base);
69static int checkfilesys(char *filesys);
70static struct statfs *getmntpt(const char *);
71
72int
73main(int argc, char *argv[])
74{
75	int ch;
76	struct rlimit rlimit;
77	struct itimerval itimerval;
78	int ret = 0;
79
80	sync();
81	skipclean = 1;
82	while ((ch = getopt(argc, argv, "b:Bc:dfFm:npy")) != -1) {
83		switch (ch) {
84		case 'b':
85			skipclean = 0;
86			bflag = argtoi('b', "number", optarg, 10);
87			printf("Alternate super block location: %d\n", bflag);
88			break;
89
90		case 'B':
91			bkgrdflag = 1;
92			break;
93
94		case 'c':
95			skipclean = 0;
96			cvtlevel = argtoi('c', "conversion level", optarg, 10);
97			if (cvtlevel < 3)
98				errx(EEXIT, "cannot do level %d conversion",
99				    cvtlevel);
100			break;
101
102		case 'd':
103			debug++;
104			break;
105
106		case 'f':
107			skipclean = 0;
108			break;
109
110		case 'F':
111			bkgrdcheck = 1;
112			break;
113
114		case 'm':
115			lfmode = argtoi('m', "mode", optarg, 8);
116			if (lfmode &~ 07777)
117				errx(EEXIT, "bad mode to -m: %o", lfmode);
118			printf("** lost+found creation mode %o\n", lfmode);
119			break;
120
121		case 'n':
122			nflag++;
123			yflag = 0;
124			break;
125
126		case 'p':
127			preen++;
128			break;
129
130		case 'y':
131			yflag++;
132			nflag = 0;
133			break;
134
135		default:
136			usage();
137		}
138	}
139	argc -= optind;
140	argv += optind;
141
142	if (!argc)
143		usage();
144
145	if (signal(SIGINT, SIG_IGN) != SIG_IGN)
146		(void)signal(SIGINT, catch);
147	if (preen)
148		(void)signal(SIGQUIT, catchquit);
149	signal(SIGINFO, infohandler);
150	if (bkgrdflag) {
151		signal(SIGALRM, alarmhandler);
152		itimerval.it_interval.tv_sec = 5;
153		itimerval.it_interval.tv_usec = 0;
154		itimerval.it_value.tv_sec = 5;
155		itimerval.it_value.tv_usec = 0;
156		setitimer(ITIMER_REAL, &itimerval, NULL);
157	}
158	/*
159	 * Push up our allowed memory limit so we can cope
160	 * with huge file systems.
161	 */
162	if (getrlimit(RLIMIT_DATA, &rlimit) == 0) {
163		rlimit.rlim_cur = rlimit.rlim_max;
164		(void)setrlimit(RLIMIT_DATA, &rlimit);
165	}
166	while (argc-- > 0)
167		(void)checkfilesys(*argv++);
168
169	if (returntosingle)
170		ret = 2;
171	exit(ret);
172}
173
174static int
175argtoi(int flag, const char *req, const char *str, int base)
176{
177	char *cp;
178	int ret;
179
180	ret = (int)strtol(str, &cp, base);
181	if (cp == str || *cp)
182		errx(EEXIT, "-%c flag requires a %s", flag, req);
183	return (ret);
184}
185
186/*
187 * Check the specified file system.
188 */
189/* ARGSUSED */
190static int
191checkfilesys(char *filesys)
192{
193	ufs2_daddr_t n_ffree, n_bfree;
194	struct ufs_args args;
195	struct dups *dp;
196	struct statfs *mntp;
197	struct stat snapdir;
198	struct group *grp;
199	ufs2_daddr_t blks;
200	int cylno, ret;
201	ino_t files;
202	size_t size;
203
204	cdevname = filesys;
205	if (debug && preen)
206		pwarn("starting\n");
207	/*
208	 * Make best effort to get the disk name. Check first to see
209	 * if it is listed among the mounted file systems. Failing that
210	 * check to see if it is listed in /etc/fstab.
211	 */
212	mntp = getmntpt(filesys);
213	if (mntp != NULL)
214		filesys = mntp->f_mntfromname;
215	else
216		filesys = blockcheck(filesys);
217	/*
218	 * If -F flag specified, check to see whether a background check
219	 * is possible and needed. If possible and needed, exit with
220	 * status zero. Otherwise exit with status non-zero. A non-zero
221	 * exit status will cause a foreground check to be run.
222	 */
223	sblock_init();
224	if (bkgrdcheck) {
225		if ((fsreadfd = open(filesys, O_RDONLY)) < 0 || readsb(0) == 0)
226			exit(3);	/* Cannot read superblock */
227		close(fsreadfd);
228		if (sblock.fs_flags & FS_NEEDSFSCK)
229			exit(4);	/* Earlier background failed */
230		if ((sblock.fs_flags & FS_DOSOFTDEP) == 0)
231			exit(5);	/* Not running soft updates */
232		size = MIBSIZE;
233		if (sysctlnametomib("vfs.ffs.adjrefcnt", adjrefcnt, &size) < 0)
234			exit(6);	/* Lacks kernel support */
235		if ((mntp == NULL && sblock.fs_clean == 1) ||
236		    (mntp != NULL && (sblock.fs_flags & FS_UNCLEAN) == 0))
237			exit(7);	/* Filesystem clean, report it now */
238		exit(0);
239	}
240	/*
241	 * If we are to do a background check:
242	 *	Get the mount point information of the file system
243	 *	create snapshot file
244	 *	return created snapshot file
245	 *	if not found, clear bkgrdflag and proceed with normal fsck
246	 */
247	if (bkgrdflag) {
248		if (mntp == NULL) {
249			bkgrdflag = 0;
250			pfatal("NOT MOUNTED, CANNOT RUN IN BACKGROUND\n");
251		} else if ((mntp->f_flags & MNT_SOFTDEP) == 0) {
252			bkgrdflag = 0;
253			pfatal("NOT USING SOFT UPDATES, %s\n",
254			    "CANNOT RUN IN BACKGROUND");
255		} else if ((mntp->f_flags & MNT_RDONLY) != 0) {
256			bkgrdflag = 0;
257			pfatal("MOUNTED READ-ONLY, CANNOT RUN IN BACKGROUND\n");
258		} else if ((fsreadfd = open(filesys, O_RDONLY)) >= 0) {
259			if (readsb(0) != 0) {
260				if (sblock.fs_flags & FS_NEEDSFSCK) {
261					bkgrdflag = 0;
262					pfatal("UNEXPECTED INCONSISTENCY, %s\n",
263					    "CANNOT RUN IN BACKGROUND\n");
264				}
265				if ((sblock.fs_flags & FS_UNCLEAN) == 0 &&
266				    skipclean && preen) {
267					/*
268					 * file system is clean;
269					 * skip snapshot and report it clean
270					 */
271					pwarn("FILE SYSTEM CLEAN; %s\n",
272					    "SKIPPING CHECKS");
273					goto clean;
274				}
275			}
276			close(fsreadfd);
277		}
278		if (bkgrdflag) {
279			snprintf(snapname, sizeof snapname, "%s/.snap",
280			    mntp->f_mntonname);
281			if (stat(snapname, &snapdir) < 0) {
282				if (errno != ENOENT) {
283					bkgrdflag = 0;
284					pfatal("CANNOT FIND %s %s: %s, %s\n",
285					    "SNAPSHOT DIRECTORY",
286					    snapname, strerror(errno),
287					    "CANNOT RUN IN BACKGROUND");
288				} else if ((grp = getgrnam("operator")) == 0 ||
289				    mkdir(snapname, 0770) < 0 ||
290				    chown(snapname, -1, grp->gr_gid) < 0 ||
291				    chmod(snapname, 0770) < 0) {
292					bkgrdflag = 0;
293					pfatal("CANNOT CREATE %s %s: %s, %s\n",
294					    "SNAPSHOT DIRECTORY",
295					    snapname, strerror(errno),
296					    "CANNOT RUN IN BACKGROUND");
297				}
298			} else if (!S_ISDIR(snapdir.st_mode)) {
299				bkgrdflag = 0;
300				pfatal("%s IS NOT A DIRECTORY, %s\n", snapname,
301				    "CANNOT RUN IN BACKGROUND");
302			}
303		}
304		if (bkgrdflag) {
305			snprintf(snapname, sizeof snapname,
306			    "%s/.snap/fsck_snapshot", mntp->f_mntonname);
307			args.fspec = snapname;
308			while (mount("ffs", mntp->f_mntonname,
309			    mntp->f_flags | MNT_UPDATE | MNT_SNAPSHOT,
310			    &args) < 0) {
311				if (errno == EEXIST && unlink(snapname) == 0)
312					continue;
313				bkgrdflag = 0;
314				pfatal("CANNOT CREATE SNAPSHOT %s: %s\n",
315				    snapname, strerror(errno));
316				break;
317			}
318			if (bkgrdflag != 0)
319				filesys = snapname;
320		}
321	}
322
323	switch (setup(filesys)) {
324	case 0:
325		if (preen)
326			pfatal("CAN'T CHECK FILE SYSTEM.");
327		return (0);
328	case -1:
329	clean:
330		pwarn("clean, %ld free ", (long)(sblock.fs_cstotal.cs_nffree +
331		    sblock.fs_frag * sblock.fs_cstotal.cs_nbfree));
332		printf("(%lld frags, %lld blocks, %.1f%% fragmentation)\n",
333		    (long long)sblock.fs_cstotal.cs_nffree,
334		    (long long)sblock.fs_cstotal.cs_nbfree,
335		    sblock.fs_cstotal.cs_nffree * 100.0 / sblock.fs_dsize);
336		return (0);
337	}
338
339	/*
340	 * Cleared if any questions answered no. Used to decide if
341	 * the superblock should be marked clean.
342	 */
343	resolved = 1;
344	/*
345	 * 1: scan inodes tallying blocks used
346	 */
347	if (preen == 0) {
348		printf("** Last Mounted on %s\n", sblock.fs_fsmnt);
349		if (mntp != NULL && mntp->f_flags & MNT_ROOTFS)
350			printf("** Root file system\n");
351		printf("** Phase 1 - Check Blocks and Sizes\n");
352	}
353	pass1();
354
355	/*
356	 * 1b: locate first references to duplicates, if any
357	 */
358	if (duplist) {
359		if (preen || usedsoftdep)
360			pfatal("INTERNAL ERROR: dups with -p");
361		printf("** Phase 1b - Rescan For More DUPS\n");
362		pass1b();
363	}
364
365	/*
366	 * 2: traverse directories from root to mark all connected directories
367	 */
368	if (preen == 0)
369		printf("** Phase 2 - Check Pathnames\n");
370	pass2();
371
372	/*
373	 * 3: scan inodes looking for disconnected directories
374	 */
375	if (preen == 0)
376		printf("** Phase 3 - Check Connectivity\n");
377	pass3();
378
379	/*
380	 * 4: scan inodes looking for disconnected files; check reference counts
381	 */
382	if (preen == 0)
383		printf("** Phase 4 - Check Reference Counts\n");
384	pass4();
385
386	/*
387	 * 5: check and repair resource counts in cylinder groups
388	 */
389	if (preen == 0)
390		printf("** Phase 5 - Check Cyl groups\n");
391	pass5();
392
393	/*
394	 * print out summary statistics
395	 */
396	n_ffree = sblock.fs_cstotal.cs_nffree;
397	n_bfree = sblock.fs_cstotal.cs_nbfree;
398	files = maxino - ROOTINO - sblock.fs_cstotal.cs_nifree - n_files;
399	blks = n_blks +
400	    sblock.fs_ncg * (cgdmin(&sblock, 0) - cgsblock(&sblock, 0));
401	blks += cgsblock(&sblock, 0) - cgbase(&sblock, 0);
402	blks += howmany(sblock.fs_cssize, sblock.fs_fsize);
403	blks = maxfsblock - (n_ffree + sblock.fs_frag * n_bfree) - blks;
404	if (bkgrdflag && (files > 0 || blks > 0)) {
405		countdirs = sblock.fs_cstotal.cs_ndir - countdirs;
406		pwarn("Reclaimed: %ld directories, %ld files, %lld fragments\n",
407		    countdirs, (long)files - countdirs, (long long)blks);
408	}
409	pwarn("%ld files, %jd used, %ju free ",
410	    (long)n_files, (intmax_t)n_blks,
411	    (uintmax_t)n_ffree + sblock.fs_frag * n_bfree);
412	printf("(%ju frags, %ju blocks, %.1f%% fragmentation)\n",
413	    (uintmax_t)n_ffree, (uintmax_t)n_bfree,
414	    n_ffree * 100.0 / sblock.fs_dsize);
415	if (debug) {
416		if (files < 0)
417			printf("%d inodes missing\n", -files);
418		if (blks < 0)
419			printf("%lld blocks missing\n", -(long long)blks);
420		if (duplist != NULL) {
421			printf("The following duplicate blocks remain:");
422			for (dp = duplist; dp; dp = dp->next)
423				printf(" %lld,", (long long)dp->dup);
424			printf("\n");
425		}
426	}
427	duplist = (struct dups *)0;
428	muldup = (struct dups *)0;
429	inocleanup();
430	if (fsmodified) {
431		sblock.fs_time = time(NULL);
432		sbdirty();
433	}
434	if (cvtlevel && sblk.b_dirty) {
435		/*
436		 * Write out the duplicate super blocks
437		 */
438		for (cylno = 0; cylno < sblock.fs_ncg; cylno++)
439			bwrite(fswritefd, (char *)&sblock,
440			    fsbtodb(&sblock, cgsblock(&sblock, cylno)),
441			    SBLOCKSIZE);
442	}
443	if (rerun)
444		resolved = 0;
445
446	/*
447	 * Check to see if the file system is mounted read-write.
448	 */
449	if (bkgrdflag == 0 && mntp != NULL && (mntp->f_flags & MNT_RDONLY) == 0)
450		resolved = 0;
451	ckfini(resolved);
452
453	for (cylno = 0; cylno < sblock.fs_ncg; cylno++)
454		if (inostathead[cylno].il_stat != NULL)
455			free((char *)inostathead[cylno].il_stat);
456	free((char *)inostathead);
457	inostathead = NULL;
458	if (fsmodified && !preen)
459		printf("\n***** FILE SYSTEM WAS MODIFIED *****\n");
460	if (rerun)
461		printf("\n***** PLEASE RERUN FSCK *****\n");
462	if (mntp != NULL) {
463		/*
464		 * We modified a mounted file system.  Do a mount update on
465		 * it unless it is read-write, so we can continue using it
466		 * as safely as possible.
467		 */
468		if (mntp->f_flags & MNT_RDONLY) {
469			args.fspec = 0;
470			args.export.ex_flags = 0;
471			args.export.ex_root = 0;
472			ret = mount("ufs", mntp->f_mntonname,
473			    mntp->f_flags | MNT_UPDATE | MNT_RELOAD, &args);
474			if (ret == 0)
475				return (0);
476			pwarn("mount reload of '%s' failed: %s\n\n",
477			    mntp->f_mntonname, strerror(errno));
478		}
479		if (!fsmodified)
480			return (0);
481		if (!preen)
482			printf("\n***** REBOOT NOW *****\n");
483		sync();
484		return (4);
485	}
486	return (0);
487}
488
489/*
490 * Get the mount point information for name.
491 */
492static struct statfs *
493getmntpt(const char *name)
494{
495	struct stat devstat, mntdevstat;
496	char device[sizeof(_PATH_DEV) - 1 + MNAMELEN];
497	char *ddevname;
498	struct statfs *mntbuf, *statfsp;
499	int i, mntsize, isdev;
500
501	if (stat(name, &devstat) != 0)
502		return (NULL);
503	if (S_ISCHR(devstat.st_mode) || S_ISBLK(devstat.st_mode))
504		isdev = 1;
505	else
506		isdev = 0;
507	mntsize = getmntinfo(&mntbuf, MNT_NOWAIT);
508	for (i = 0; i < mntsize; i++) {
509		statfsp = &mntbuf[i];
510		ddevname = statfsp->f_mntfromname;
511		if (*ddevname != '/') {
512			strcpy(device, _PATH_DEV);
513			strcat(device, ddevname);
514			strcpy(statfsp->f_mntfromname, device);
515		}
516		if (isdev == 0) {
517			if (strcmp(name, statfsp->f_mntonname))
518				continue;
519			return (statfsp);
520		}
521		if (stat(ddevname, &mntdevstat) == 0 &&
522		    mntdevstat.st_rdev == devstat.st_rdev)
523			return (statfsp);
524	}
525	statfsp = NULL;
526	return (statfsp);
527}
528
529static void
530usage(void)
531{
532        (void) fprintf(stderr,
533            "usage: %s [-BFpfny] [-b block] [-c level] [-m mode] "
534                        "file system ...\n",
535            getprogname());
536        exit(1);
537}
538