xref: /freebsd/sbin/fsck/fsck.c (revision 8a16b7a1) 
1 /*	$NetBSD: fsck.c,v 1.30 2003/08/07 10:04:15 agc Exp $	*/
2 
3 /*-
4  * SPDX-License-Identifier: BSD-3-Clause
5  *
6  * Copyright (c) 1996 Christos Zoulas. All rights reserved.
7  * Copyright (c) 1980, 1989, 1993, 1994
8  *	The Regents of the University of California.  All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  * From: @(#)mount.c	8.19 (Berkeley) 4/19/94
35  * From: $NetBSD: mount.c,v 1.24 1995/11/18 03:34:29 cgd Exp
36  * $NetBSD: fsck.c,v 1.30 2003/08/07 10:04:15 agc Exp $
37  */
38 
39 #include <sys/cdefs.h>
40 __FBSDID("$FreeBSD$");
41 
42 #include <sys/param.h>
43 #include <sys/mount.h>
44 #include <sys/queue.h>
45 #include <sys/wait.h>
46 #include <sys/disk.h>
47 #include <sys/ioctl.h>
48 
49 #include <ctype.h>
50 #include <err.h>
51 #include <errno.h>
52 #include <fstab.h>
53 #include <fcntl.h>
54 #include <paths.h>
55 #include <signal.h>
56 #include <stdio.h>
57 #include <stdlib.h>
58 #include <string.h>
59 #include <unistd.h>
60 
61 #include "fsutil.h"
62 
63 static enum { IN_LIST, NOT_IN_LIST } which = NOT_IN_LIST;
64 
65 static TAILQ_HEAD(fstypelist, entry) opthead, selhead;
66 
67 struct entry {
68 	char *type;
69 	char *options;
70 	TAILQ_ENTRY(entry) entries;
71 };
72 
73 static char *options = NULL;
74 static int flags = 0;
75 static int forceflag = 0;
76 
77 static int checkfs(const char *, const char *, const char *, const char *, pid_t *);
78 static int selected(const char *);
79 static void addoption(char *);
80 static const char *getoptions(const char *);
81 static void addentry(struct fstypelist *, const char *, const char *);
82 static void maketypelist(char *);
83 static void catopt(char **, const char *);
84 static void mangle(char *, int *, const char ** volatile *, int *);
85 static const char *getfstype(const char *);
86 static void usage(void) __dead2;
87 static int isok(struct fstab *);
88 
89 static struct {
90 	const char *ptype;
91 	const char *name;
92 } ptype_map[] = {
93 	{ "ufs",	"ffs" },
94 	{ "ffs",	"ffs" },
95 	{ "fat",	"msdosfs" },
96 	{ "efi",	"msdosfs" },
97 	{ NULL,		NULL },
98 };
99 
100 int
101 main(int argc, char *argv[])
102 {
103 	struct fstab *fs;
104 	int i, rval = 0;
105 	const char *vfstype = NULL;
106 	char globopt[3];
107 	const char *etc_fstab;
108 
109 	globopt[0] = '-';
110 	globopt[2] = '\0';
111 
112 	TAILQ_INIT(&selhead);
113 	TAILQ_INIT(&opthead);
114 
115 	etc_fstab = NULL;
116 	while ((i = getopt(argc, argv, "BCdvpfFnyl:t:T:c:")) != -1)
117 		switch (i) {
118 		case 'B':
119 			if (flags & CHECK_BACKGRD)
120 				errx(1, "Cannot specify -B and -F.");
121 			flags |= DO_BACKGRD;
122 			break;
123 
124 		case 'd':
125 			flags |= CHECK_DEBUG;
126 			break;
127 
128 		case 'v':
129 			flags |= CHECK_VERBOSE;
130 			break;
131 
132 		case 'F':
133 			if (flags & DO_BACKGRD)
134 				errx(1, "Cannot specify -B and -F.");
135 			flags |= CHECK_BACKGRD;
136 			break;
137 
138 		case 'p':
139 			flags |= CHECK_PREEN;
140 			/*FALLTHROUGH*/
141 		case 'C':
142 			flags |= CHECK_CLEAN;
143 			/*FALLTHROUGH*/
144 		case 'n':
145 		case 'y':
146 			globopt[1] = i;
147 			catopt(&options, globopt);
148 			break;
149 
150 		case 'f':
151 			forceflag = 1;
152 			globopt[1] = i;
153 			catopt(&options, globopt);
154 			break;
155 
156 		case 'l':
157 			warnx("Ignoring obsolete -l option\n");
158 			break;
159 
160 		case 'T':
161 			if (*optarg)
162 				addoption(optarg);
163 			break;
164 
165 		case 't':
166 			if (!TAILQ_EMPTY(&selhead))
167 				errx(1, "only one -t option may be specified.");
168 
169 			maketypelist(optarg);
170 			vfstype = optarg;
171 			break;
172 
173 		case 'c':
174 			etc_fstab = optarg;
175 			break;
176 
177 		case '?':
178 		default:
179 			usage();
180 			/* NOTREACHED */
181 		}
182 
183 	argc -= optind;
184 	argv += optind;
185 
186 	if (etc_fstab != NULL)
187 		setfstab(etc_fstab);
188 
189 	if (argc == 0)
190 		return checkfstab(flags, isok, checkfs);
191 
192 #define	BADTYPE(type)							\
193 	(strcmp(type, FSTAB_RO) &&					\
194 	    strcmp(type, FSTAB_RW) && strcmp(type, FSTAB_RQ))
195 
196 
197 	for (; argc--; argv++) {
198 		const char *spec, *mntpt, *type, *cp;
199 		char device[MAXPATHLEN];
200 		struct statfs *mntp;
201 
202 		mntpt = NULL;
203 		spec = *argv;
204 		cp = strrchr(spec, '/');
205 		if (cp == NULL) {
206 			(void)snprintf(device, sizeof(device), "%s%s",
207 				_PATH_DEV, spec);
208 			spec = device;
209 		}
210 		mntp = getmntpt(spec);
211 		if (mntp != NULL) {
212 			spec = mntp->f_mntfromname;
213 			mntpt = mntp->f_mntonname;
214 		}
215 		if ((fs = getfsfile(spec)) == NULL &&
216 		    (fs = getfsspec(spec)) == NULL) {
217 			if (vfstype == NULL)
218 				vfstype = getfstype(spec);
219 			if (vfstype == NULL)
220 				vfstype = "ufs";
221 			type = vfstype;
222 			devcheck(spec);
223 		} else {
224 			spec = fs->fs_spec;
225 			type = fs->fs_vfstype;
226 			mntpt = fs->fs_file;
227 			if (BADTYPE(fs->fs_type))
228 				errx(1, "%s has unknown file system type.",
229 				    spec);
230 		}
231 		if ((flags & CHECK_BACKGRD) &&
232 		    checkfs(type, spec, mntpt, "-F", NULL) == 0) {
233 			printf("%s: DEFER FOR BACKGROUND CHECKING\n", *argv);
234 			continue;
235 		}
236 		if ((flags & DO_BACKGRD) && forceflag == 0 &&
237 		    checkfs(type, spec, mntpt, "-F", NULL) != 0)
238 			continue;
239 
240 		rval |= checkfs(type, spec, mntpt, NULL, NULL);
241 	}
242 
243 	return rval;
244 }
245 
246 
247 static int
248 isok(struct fstab *fs)
249 {
250 	int i;
251 
252 	if (fs->fs_passno == 0)
253 		return (0);
254 	if (BADTYPE(fs->fs_type))
255 		return (0);
256 	if (!selected(fs->fs_vfstype))
257 		return (0);
258 	/*
259 	 * If the -B flag has been given, then process the needed
260 	 * background checks. Background checks cannot be run on
261 	 * file systems that will be mounted read-only or that were
262 	 * not mounted at boot time (typically those marked `noauto').
263 	 * If these basic tests are passed, check with the file system
264 	 * itself to see if it is willing to do background checking
265 	 * by invoking its check program with the -F flag.
266 	 */
267 	if (flags & DO_BACKGRD) {
268 		if (!strcmp(fs->fs_type, FSTAB_RO))
269 			return (0);
270 		if (getmntpt(fs->fs_spec) == NULL)
271 			return (0);
272 		if (checkfs(fs->fs_vfstype, fs->fs_spec, fs->fs_file, "-F", 0))
273 			return (0);
274 		return (1);
275 	}
276 	/*
277 	 * If the -F flag has been given, then consider deferring the
278 	 * check to background. Background checks cannot be run on
279 	 * file systems that will be mounted read-only or that will
280 	 * not be mounted at boot time (e.g., marked `noauto'). If
281 	 * these basic tests are passed, check with the file system
282 	 * itself to see if it is willing to defer to background
283 	 * checking by invoking its check program with the -F flag.
284 	 */
285 	if ((flags & CHECK_BACKGRD) == 0 || !strcmp(fs->fs_type, FSTAB_RO))
286 		return (1);
287 	for (i = strlen(fs->fs_mntops) - 6; i >= 0; i--)
288 		if (!strncmp(&fs->fs_mntops[i], "noauto", 6))
289 			break;
290 	if (i >= 0)
291 		return (1);
292 	if (checkfs(fs->fs_vfstype, fs->fs_spec, fs->fs_file, "-F", NULL) != 0)
293 		return (1);
294 	printf("%s: DEFER FOR BACKGROUND CHECKING\n", fs->fs_spec);
295 	return (0);
296 }
297 
298 
299 static int
300 checkfs(const char *pvfstype, const char *spec, const char *mntpt,
301     const char *auxopt, pid_t *pidp)
302 {
303 	const char ** volatile argv;
304 	pid_t pid;
305 	int argc, i, status, maxargc;
306 	char *optbuf, execbase[MAXPATHLEN];
307 	char *vfstype = NULL;
308 	const char *extra = NULL;
309 
310 #ifdef __GNUC__
311 	/* Avoid vfork clobbering */
312 	(void) &optbuf;
313 	(void) &vfstype;
314 #endif
315 	/*
316 	 * We convert the vfstype to lowercase and any spaces to underscores
317 	 * to not confuse the issue
318 	 *
319 	 * XXX This is a kludge to make automatic filesystem type guessing
320 	 * from the disklabel work for "4.2BSD" filesystems.  It does a
321 	 * very limited subset of transliteration to a normalised form of
322 	 * filesystem name, and we do not seem to enforce a filesystem
323 	 * name character set.
324 	 */
325 	vfstype = strdup(pvfstype);
326 	if (vfstype == NULL)
327 		perr("strdup(pvfstype)");
328 	for (i = 0; i < (int)strlen(vfstype); i++) {
329 		vfstype[i] = tolower(vfstype[i]);
330 		if (vfstype[i] == ' ')
331 			vfstype[i] = '_';
332 	}
333 
334 	extra = getoptions(vfstype);
335 	optbuf = NULL;
336 	if (options)
337 		catopt(&optbuf, options);
338 	if (extra)
339 		catopt(&optbuf, extra);
340 	if (auxopt)
341 		catopt(&optbuf, auxopt);
342 	else if (flags & DO_BACKGRD)
343 		catopt(&optbuf, "-B");
344 
345 	maxargc = 64;
346 	argv = emalloc(sizeof(char *) * maxargc);
347 
348 	(void) snprintf(execbase, sizeof(execbase), "fsck_%s", vfstype);
349 	argc = 0;
350 	argv[argc++] = execbase;
351 	if (optbuf)
352 		mangle(optbuf, &argc, &argv, &maxargc);
353 	argv[argc++] = spec;
354 	argv[argc] = NULL;
355 
356 	if (flags & (CHECK_DEBUG|CHECK_VERBOSE)) {
357 		(void)printf("start %s %swait", mntpt,
358 			pidp ? "no" : "");
359 		for (i = 0; i < argc; i++)
360 			(void)printf(" %s", argv[i]);
361 		(void)printf("\n");
362 	}
363 
364 	switch (pid = vfork()) {
365 	case -1:				/* Error. */
366 		warn("vfork");
367 		if (optbuf)
368 			free(optbuf);
369 		free(vfstype);
370 		return (1);
371 
372 	case 0:					/* Child. */
373 		if ((flags & CHECK_DEBUG) && auxopt == NULL)
374 			_exit(0);
375 
376 		/* Go find an executable. */
377 		execvP(execbase, _PATH_SYSPATH, __DECONST(char * const *, argv));
378 		if (spec)
379 			warn("exec %s for %s in %s", execbase, spec, _PATH_SYSPATH);
380 		else
381 			warn("exec %s in %s", execbase, _PATH_SYSPATH);
382 		_exit(1);
383 		/* NOTREACHED */
384 
385 	default:				/* Parent. */
386 		if (optbuf)
387 			free(optbuf);
388 
389 		free(vfstype);
390 
391 		if (pidp) {
392 			*pidp = pid;
393 			return 0;
394 		}
395 
396 		if (waitpid(pid, &status, 0) < 0) {
397 			warn("waitpid");
398 			return (1);
399 		}
400 
401 		if (WIFEXITED(status)) {
402 			if (WEXITSTATUS(status) != 0)
403 				return (WEXITSTATUS(status));
404 		}
405 		else if (WIFSIGNALED(status)) {
406 			warnx("%s: %s", spec, strsignal(WTERMSIG(status)));
407 			return (1);
408 		}
409 		break;
410 	}
411 
412 	return (0);
413 }
414 
415 
416 static int
417 selected(const char *type)
418 {
419 	struct entry *e;
420 
421 	/* If no type specified, it's always selected. */
422 	TAILQ_FOREACH(e, &selhead, entries)
423 		if (!strncmp(e->type, type, MFSNAMELEN))
424 			return which == IN_LIST ? 1 : 0;
425 
426 	return which == IN_LIST ? 0 : 1;
427 }
428 
429 
430 static const char *
431 getoptions(const char *type)
432 {
433 	struct entry *e;
434 
435 	TAILQ_FOREACH(e, &opthead, entries)
436 		if (!strncmp(e->type, type, MFSNAMELEN))
437 			return e->options;
438 	return "";
439 }
440 
441 
442 static void
443 addoption(char *optstr)
444 {
445 	char *newoptions;
446 	struct entry *e;
447 
448 	if ((newoptions = strchr(optstr, ':')) == NULL)
449 		errx(1, "Invalid option string");
450 
451 	*newoptions++ = '\0';
452 
453 	TAILQ_FOREACH(e, &opthead, entries)
454 		if (!strncmp(e->type, optstr, MFSNAMELEN)) {
455 			catopt(&e->options, newoptions);
456 			return;
457 		}
458 	addentry(&opthead, optstr, newoptions);
459 }
460 
461 
462 static void
463 addentry(struct fstypelist *list, const char *type, const char *opts)
464 {
465 	struct entry *e;
466 
467 	e = emalloc(sizeof(struct entry));
468 	e->type = estrdup(type);
469 	e->options = estrdup(opts);
470 	TAILQ_INSERT_TAIL(list, e, entries);
471 }
472 
473 
474 static void
475 maketypelist(char *fslist)
476 {
477 	char *ptr;
478 
479 	if ((fslist == NULL) || (fslist[0] == '\0'))
480 		errx(1, "empty type list");
481 
482 	if (fslist[0] == 'n' && fslist[1] == 'o') {
483 		fslist += 2;
484 		which = NOT_IN_LIST;
485 	}
486 	else
487 		which = IN_LIST;
488 
489 	while ((ptr = strsep(&fslist, ",")) != NULL)
490 		addentry(&selhead, ptr, "");
491 
492 }
493 
494 
495 static void
496 catopt(char **sp, const char *o)
497 {
498 	char *s;
499 	size_t i, j;
500 
501 	s = *sp;
502 	if (s) {
503 		i = strlen(s);
504 		j = i + 1 + strlen(o) + 1;
505 		s = erealloc(s, j);
506 		(void)snprintf(s + i, j, ",%s", o);
507 	} else
508 		s = estrdup(o);
509 	*sp = s;
510 }
511 
512 
513 static void
514 mangle(char *opts, int *argcp, const char ** volatile *argvp, int *maxargcp)
515 {
516 	char *p, *s;
517 	int argc, maxargc;
518 	const char **argv;
519 
520 	argc = *argcp;
521 	argv = *argvp;
522 	maxargc = *maxargcp;
523 
524 	for (s = opts; (p = strsep(&s, ",")) != NULL;) {
525 		/* Always leave space for one more argument and the NULL. */
526 		if (argc >= maxargc - 3) {
527 			maxargc <<= 1;
528 			argv = erealloc(argv, maxargc * sizeof(char *));
529 		}
530 		if (*p != '\0')  {
531 			if (*p == '-') {
532 				argv[argc++] = p;
533 				p = strchr(p, '=');
534 				if (p) {
535 					*p = '\0';
536 					argv[argc++] = p+1;
537 				}
538 			} else {
539 				argv[argc++] = "-o";
540 				argv[argc++] = p;
541 			}
542 		}
543 	}
544 
545 	*argcp = argc;
546 	*argvp = argv;
547 	*maxargcp = maxargc;
548 }
549 
550 static const char *
551 getfstype(const char *str)
552 {
553 	struct diocgattr_arg attr;
554 	int fd, i;
555 
556 	if ((fd = open(str, O_RDONLY)) == -1)
557 		err(1, "cannot open `%s'", str);
558 
559 	strncpy(attr.name, "PART::type", sizeof(attr.name));
560 	memset(&attr.value, 0, sizeof(attr.value));
561 	attr.len = sizeof(attr.value);
562 	if (ioctl(fd, DIOCGATTR, &attr) == -1) {
563 		(void) close(fd);
564 		return(NULL);
565 	}
566 	(void) close(fd);
567 	for (i = 0; ptype_map[i].ptype != NULL; i++)
568 		if (strstr(attr.value.str, ptype_map[i].ptype) != NULL)
569 			return (ptype_map[i].name);
570 	return (NULL);
571 }
572 
573 
574 static void
575 usage(void)
576 {
577 	static const char common[] =
578 	    "[-Cdfnpvy] [-B | -F] [-T fstype:fsoptions] [-t fstype] [-c fstab]";
579 
580 	(void)fprintf(stderr, "usage: %s %s [special | node] ...\n",
581 	    getprogname(), common);
582 	exit(1);
583 }
584