1 /* vi: set sw=4 ts=4: */
3 * fsck --- A generic, parallelizing front-end for the fsck program.
4 * It will automatically try to run fsck programs in parallel if the
5 * devices are on separate spindles. It is based on the same ideas as
6 * the generic front end for fsck by David Engel and Fred van Kempen,
7 * but it has been completely rewritten from scratch to support
10 * Written by Theodore Ts'o, <tytso@mit.edu>
12 * Miquel van Smoorenburg (miquels@drinkel.ow.org) 20-Oct-1994:
13 * o Changed -t fstype to behave like with mount when -A (all file
14 * systems) or -M (like mount) is specified.
15 * o fsck looks if it can find the fsck.type program to decide
16 * if it should ignore the fs type. This way more fsck programs
17 * can be added without changing this front-end.
18 * o -R flag skip root file system.
20 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
21 * 2001, 2002, 2003, 2004, 2005 by Theodore Ts'o.
23 * Licensed under GPLv2, see file LICENSE in this source tree.
26 /* All filesystem specific hooks have been removed.
27 * If filesystem cannot be determined, we will execute
28 * "fsck.auto". Currently this also happens if you specify
29 * UUID=xxx or LABEL=xxx as an object to check.
30 * Detection code for that is also probably has to be in fsck.auto.
32 * In other words, this is _really_ is just a driver program which
33 * spawns actual fsck.something for each filesystem to check.
34 * It doesn't guess filesystem types from on-disk format.
40 //config: fsck is used to check and optionally repair one or more filesystems.
41 //config: In actuality, fsck is simply a front-end for the various file system
42 //config: checkers (fsck.fstype) available under Linux.
44 //applet:IF_FSCK(APPLET(fsck, BB_DIR_SBIN, BB_SUID_DROP))
46 //kbuild:lib-$(CONFIG_FSCK) += fsck.o
48 //usage:#define fsck_trivial_usage
49 //usage: "[-ANPRTV] [-t FSTYPE] [FS_OPTS] [BLOCKDEV]..."
50 //usage:#define fsck_full_usage "\n\n"
51 //usage: "Check and repair filesystems\n"
52 //usage: "\n -A Walk /etc/fstab and check all filesystems"
53 //usage: "\n -N Don't execute, just show what would be done"
54 //usage: "\n -P With -A, check filesystems in parallel"
55 //usage: "\n -R With -A, skip the root filesystem"
56 //usage: "\n -T Don't show title on startup"
57 //usage: "\n -V Verbose"
58 //DO_PROGRESS_INDICATOR is off:
59 ////usage: "\n -C FD Write status information to specified file descriptor"
60 //usage: "\n -t TYPE List of filesystem types to check"
63 #include "common_bufsiz.h"
65 /* "progress indicator" code is somewhat buggy and ext[23] specific.
66 * We should be filesystem agnostic. IOW: there should be a well-defined
67 * API for fsck.something, NOT ad-hoc hacks in generic fsck. */
68 #define DO_PROGRESS_INDICATOR 0
70 /* fsck 1.41.4 (27-Jan-2009) manpage says:
72 * 1 - File system errors corrected
73 * 2 - System should be rebooted
74 * 4 - File system errors left uncorrected
75 * 8 - Operational error
76 * 16 - Usage or syntax error
77 * 32 - Fsck canceled by user request
78 * 128 - Shared library error
81 #define EXIT_NONDESTRUCT 1
82 #define EXIT_DESTRUCT 2
83 #define EXIT_UNCORRECTED 4
86 #define FSCK_CANCELED 32 /* Aborted with a signal or ^C */
89 * Internal structure for mount table entries.
102 #define FLAG_PROGRESS 2
104 * Structure to allow exit codes to be stored
106 struct fsck_instance {
107 struct fsck_instance *next;
110 #if DO_PROGRESS_INDICATOR
115 char *base_device; /* /dev/hda for /dev/hdaN etc */
118 static const char ignored_types[] ALIGN1 =
129 static const char really_wanted[] ALIGN1 =
139 #define BASE_MD "/dev/md"
146 #define FS_TYPE_FLAG_NORMAL 0
147 #define FS_TYPE_FLAG_OPT 1
148 #define FS_TYPE_FLAG_NEGOPT 2
150 uint8_t *fs_type_flag;
151 smallint fs_type_negated;
156 /* smallint like_mount; */
157 smallint parallel_root;
158 smallint force_all_parallel;
161 #if DO_PROGRESS_INDICATOR
169 struct fs_info *filesys_info;
170 struct fs_info *filesys_last;
171 struct fsck_instance *instance_list;
173 #define G (*(struct globals*)bb_common_bufsiz1)
174 #define INIT_G() do { \
175 setup_common_bufsiz(); \
176 BUILD_BUG_ON(sizeof(G) > COMMON_BUFSIZE); \
180 * Return the "base device" given a particular device; this is used to
181 * assure that we only fsck one partition on a particular drive at any
182 * one time. Otherwise, the disk heads will be seeking all over the
183 * place. If the base device cannot be determined, return NULL.
185 * The base_device() function returns an allocated string which must
188 #if ENABLE_FEATURE_DEVFS
190 * Required for the uber-silly devfs /dev/ide/host1/bus2/target3/lun3
193 static const char *const devfs_hier[] = {
194 "host", "bus", "target", "lun", NULL
198 static char *base_device(const char *device)
201 #if ENABLE_FEATURE_DEVFS
202 const char *const *hier;
206 str = xstrdup(device);
208 /* Skip over "/dev/"; if it's not present, give up */
209 cp = skip_dev_pfx(str);
214 * For md devices, we treat them all as if they were all
215 * on one disk, since we don't know how to parallelize them.
217 if (cp[0] == 'm' && cp[1] == 'd') {
222 /* Handle DAC 960 devices */
223 if (is_prefixed_with(cp, "rd/")) {
225 if (cp[0] != 'c' || !isdigit(cp[1])
226 || cp[2] != 'd' || !isdigit(cp[3]))
232 /* Now let's handle /dev/hd* and /dev/sd* devices.... */
233 if ((cp[0] == 'h' || cp[0] == 's') && cp[1] == 'd') {
235 /* If there's a single number after /dev/hd, skip it */
238 /* What follows must be an alpha char, or give up */
245 #if ENABLE_FEATURE_DEVFS
246 /* Now let's handle devfs (ugh) names */
248 if (is_prefixed_with(cp, "ide/"))
250 if (is_prefixed_with(cp, "scsi/"))
255 * Now we proceed down the expected devfs hierarchy.
256 * i.e., .../host1/bus2/target3/lun4/...
257 * If we don't find the expected token, followed by
258 * some number of digits at each level, abort.
260 for (hier = devfs_hier; *hier; hier++) {
261 cp = is_prefixed_with(cp, *hier);
264 while (*cp != '/' && *cp != '\0') {
269 //FIXME: what if *cp = '\0' now? cp++ moves past it!!!
276 /* Now handle devfs /dev/disc or /dev/disk names */
278 if (is_prefixed_with(cp, "discs/"))
280 else if (is_prefixed_with(cp, "disks/"))
284 cp = is_prefixed_with(cp, disk);
287 while (*cp != '/' && *cp != '\0') {
301 static void free_instance(struct fsck_instance *p)
305 free(p->base_device);
309 static struct fs_info *create_fs_device(const char *device, const char *mntpnt,
310 const char *type, const char *opts,
315 fs = xzalloc(sizeof(*fs));
316 fs->device = xstrdup(device);
317 fs->mountpt = xstrdup(mntpnt);
318 if (strchr(type, ','))
319 type = (char *)"auto";
320 fs->type = xstrdup(type);
321 fs->opts = xstrdup(opts ? opts : "");
322 fs->passno = passno < 0 ? 1 : passno;
324 /*fs->next = NULL; */
329 G.filesys_last->next = fs;
335 /* Load the filesystem database from /etc/fstab */
336 static void load_fs_info(const char *filename)
342 fstab = setmntent(filename, "r");
344 bb_perror_msg("can't read '%s'", filename);
348 // Loop through entries
349 while (getmntent_r(fstab, &mte, buf, sizeof(buf))) {
350 //bb_error_msg("CREATE[%s][%s][%s][%s][%d]", mte.mnt_fsname, mte.mnt_dir,
351 // mte.mnt_type, mte.mnt_opts,
353 create_fs_device(mte.mnt_fsname, mte.mnt_dir,
354 mte.mnt_type, mte.mnt_opts,
360 /* Lookup filesys in /etc/fstab and return the corresponding entry. */
361 static struct fs_info *lookup(char *filesys)
365 for (fs = G.filesys_info; fs; fs = fs->next) {
366 if (strcmp(filesys, fs->device) == 0
367 || (fs->mountpt && strcmp(filesys, fs->mountpt) == 0)
375 #if DO_PROGRESS_INDICATOR
376 static int progress_active(void)
378 struct fsck_instance *inst;
380 for (inst = G.instance_list; inst; inst = inst->next) {
381 if (inst->flags & FLAG_DONE)
383 if (inst->flags & FLAG_PROGRESS)
392 * Send a signal to all outstanding fsck child processes
394 static void kill_all_if_got_signal(void)
396 struct fsck_instance *inst;
398 if (!bb_got_signal || G.kill_sent)
401 for (inst = G.instance_list; inst; inst = inst->next) {
402 if (inst->flags & FLAG_DONE)
404 kill(inst->pid, SIGTERM);
410 * Wait for one child process to exit; when it does, unlink it from
411 * the list of executing child processes, free, and return its exit status.
412 * If there is no exited child, return -1.
414 static int wait_one(int flags)
418 struct fsck_instance *inst, *prev;
421 if (!G.instance_list)
423 /* if (G.noexecute) { already returned -1; } */
426 pid = waitpid(-1, &status, flags);
427 kill_all_if_got_signal();
428 if (pid == 0) /* flags == WNOHANG and no children exited */
433 if (errno == ECHILD) { /* paranoia */
434 bb_error_msg("wait: no more children");
437 bb_perror_msg("wait");
441 inst = G.instance_list;
443 if (inst->pid == pid)
451 status = WEXITSTATUS(status);
452 if (WIFSIGNALED(status)) {
453 sig = WTERMSIG(status);
454 status = EXIT_UNCORRECTED;
456 printf("Warning: %s %s terminated "
458 inst->prog, inst->device, sig);
463 #if DO_PROGRESS_INDICATOR
464 if (progress && (inst->flags & FLAG_PROGRESS) && !progress_active()) {
465 struct fsck_instance *inst2;
466 for (inst2 = G.instance_list; inst2; inst2 = inst2->next) {
467 if (inst2->flags & FLAG_DONE)
469 if (strcmp(inst2->type, "ext2") != 0
470 && strcmp(inst2->type, "ext3") != 0
474 /* ext[23], we will send USR1
475 * (request to start displaying progress bar)
477 * If we've just started the fsck, wait a tiny
478 * bit before sending the kill, to give it
479 * time to set up the signal handler
481 if (inst2->start_time >= time(NULL) - 1)
483 kill(inst2->pid, SIGUSR1);
484 inst2->flags |= FLAG_PROGRESS;
491 prev->next = inst->next;
493 G.instance_list = inst->next;
495 printf("Finished with %s (exit status %d)\n",
496 inst->device, status);
504 * Wait until all executing child processes have exited; return the
505 * logical OR of all of their exit code values.
507 #define FLAG_WAIT_ALL 0
508 #define FLAG_WAIT_ATLEAST_ONE WNOHANG
509 static int wait_many(int flags)
512 int global_status = 0;
515 while ((exit_status = wait_one(wait_flags)) != -1) {
516 global_status |= exit_status;
519 return global_status;
523 * Execute a particular fsck program, and link it into the list of
524 * child processes we are waiting for.
526 static void execute(const char *type, const char *device,
527 const char *mntpt /*, int interactive */)
530 struct fsck_instance *inst;
533 G.args[0] = xasprintf("fsck.%s", type);
535 #if DO_PROGRESS_INDICATOR
536 if (progress && !progress_active()) {
537 if (strcmp(type, "ext2") == 0
538 || strcmp(type, "ext3") == 0
540 G.args[XXX] = xasprintf("-C%d", progress_fd); /* 1 */
541 inst->flags |= FLAG_PROGRESS;
546 G.args[G.num_args - 2] = (char*)device;
547 /* G.args[G.num_args - 1] = NULL; - already is */
549 if (G.verbose || G.noexecute) {
550 printf("[%s (%d) -- %s]", G.args[0], G.num_running,
551 mntpt ? mntpt : device);
552 for (i = 0; G.args[i]; i++)
553 printf(" %s", G.args[i]);
557 /* Fork and execute the correct program. */
562 bb_simple_perror_msg(G.args[0]);
565 #if DO_PROGRESS_INDICATOR
569 /* No child, so don't record an instance */
575 inst = xzalloc(sizeof(*inst));
577 inst->prog = G.args[0];
578 inst->device = xstrdup(device);
579 inst->base_device = base_device(device);
580 #if DO_PROGRESS_INDICATOR
581 inst->start_time = time(NULL);
584 /* Add to the list of running fsck's.
585 * (was adding to the end, but adding to the front is simpler...) */
586 inst->next = G.instance_list;
587 G.instance_list = inst;
591 * Run the fsck program on a particular device
593 * If the type is specified using -t, and it isn't prefixed with "no"
594 * (as in "noext2") and only one filesystem type is specified, then
595 * use that type regardless of what is specified in /etc/fstab.
597 * If the type isn't specified by the user, then use either the type
598 * specified in /etc/fstab, or "auto".
600 static void fsck_device(struct fs_info *fs /*, int interactive */)
604 if (strcmp(fs->type, "auto") != 0) {
607 printf("using filesystem type '%s' %s\n",
610 && (G.fstype[0] != 'n' || G.fstype[1] != 'o') /* != "no" */
611 && !is_prefixed_with(G.fstype, "opts=")
612 && !is_prefixed_with(G.fstype, "loop")
613 && !strchr(G.fstype, ',')
617 printf("using filesystem type '%s' %s\n",
622 printf("using filesystem type '%s' %s\n",
627 execute(type, fs->device, fs->mountpt /*, interactive */);
631 * Returns TRUE if a partition on the same disk is already being
634 static int device_already_active(char *device)
636 struct fsck_instance *inst;
639 if (G.force_all_parallel)
643 /* Don't check a soft raid disk with any other disk */
645 && (is_prefixed_with(G.instance_list->device, BASE_MD)
646 || is_prefixed_with(device, BASE_MD))
652 base = base_device(device);
654 * If we don't know the base device, assume that the device is
655 * already active if there are any fsck instances running.
658 return (G.instance_list != NULL);
660 for (inst = G.instance_list; inst; inst = inst->next) {
661 if (!inst->base_device || !strcmp(base, inst->base_device)) {
672 * This function returns true if a particular option appears in a
673 * comma-delimited options list
675 static int opt_in_list(char *opt, char *optlist)
686 s = strstr(s + 1, opt);
689 /* neither "opt.." nor "xxx,opt.."? */
690 if (s != optlist && s[-1] != ',')
692 /* neither "..opt" nor "..opt,xxx"? */
693 if (s[len] != '\0' && s[len] != ',')
699 /* See if the filesystem matches the criteria given by the -t option */
700 static int fs_match(struct fs_info *fs)
702 int n, ret, checked_type;
712 cp = G.fs_type_list[n];
715 switch (G.fs_type_flag[n]) {
716 case FS_TYPE_FLAG_NORMAL:
718 if (strcmp(cp, fs->type) == 0)
721 case FS_TYPE_FLAG_NEGOPT:
722 if (opt_in_list(cp, fs->opts))
725 case FS_TYPE_FLAG_OPT:
726 if (!opt_in_list(cp, fs->opts))
732 if (checked_type == 0)
735 return (G.fs_type_negated ? !ret : ret);
738 /* Check if we should ignore this filesystem. */
739 static int ignore(struct fs_info *fs)
742 * If the pass number is 0, ignore it.
748 * If a specific fstype is specified, and it doesn't match,
754 /* Are we ignoring this type? */
755 if (index_in_strings(ignored_types, fs->type) >= 0)
758 /* We can and want to check this file system type. */
762 /* Check all file systems, using the /etc/fstab table. */
763 static int check_all(void)
766 int status = EXIT_OK;
767 smallint not_done_yet;
772 puts("Checking all filesystems");
775 * Do an initial scan over the filesystem; mark filesystems
776 * which should be ignored as done, and resolve any "auto"
777 * filesystem types (done as a side-effect of calling ignore()).
779 for (fs = G.filesys_info; fs; fs = fs->next)
781 fs->flags |= FLAG_DONE;
784 * Find and check the root filesystem.
786 if (!G.parallel_root) {
787 for (fs = G.filesys_info; fs; fs = fs->next) {
788 if (LONE_CHAR(fs->mountpt, '/')) {
789 if (!G.skip_root && !ignore(fs)) {
790 fsck_device(fs /*, 1*/);
791 status |= wait_many(FLAG_WAIT_ALL);
792 if (status > EXIT_NONDESTRUCT)
795 fs->flags |= FLAG_DONE;
801 * This is for the bone-headed user who has root
802 * filesystem listed twice.
803 * "Skip root" will skip _all_ root entries.
806 for (fs = G.filesys_info; fs; fs = fs->next)
807 if (LONE_CHAR(fs->mountpt, '/'))
808 fs->flags |= FLAG_DONE;
812 while (not_done_yet) {
816 for (fs = G.filesys_info; fs; fs = fs->next) {
819 if (fs->flags & FLAG_DONE)
822 * If the filesystem's pass number is higher
823 * than the current pass number, then we didn't
826 if (fs->passno > passno) {
831 * If a filesystem on a particular device has
832 * already been spawned, then we need to defer
833 * this to another pass.
835 if (device_already_active(fs->device)) {
840 * Spawn off the fsck process
842 fsck_device(fs /*, G.serialize*/);
843 fs->flags |= FLAG_DONE;
846 * Only do one filesystem at a time, or if we
847 * have a limit on the number of fsck's extant
848 * at one time, apply that limit.
851 || (G.num_running >= G.max_running)
860 printf("--waiting-- (pass %d)\n", passno);
861 status |= wait_many(pass_done ? FLAG_WAIT_ALL :
862 FLAG_WAIT_ATLEAST_ONE);
865 puts("----------------------------------");
870 kill_all_if_got_signal();
871 status |= wait_many(FLAG_WAIT_ATLEAST_ONE);
876 * Deal with the fsck -t argument.
877 * Huh, for mount "-t novfat,nfs" means "neither vfat nor nfs"!
878 * Why here we require "-t novfat,nonfs" ??
880 static void compile_fs_type(char *fs_type)
887 while ((s = strchr(s, ','))) {
892 G.fs_type_list = xzalloc(num * sizeof(G.fs_type_list[0]));
893 G.fs_type_flag = xzalloc(num * sizeof(G.fs_type_flag[0]));
894 G.fs_type_negated = -1; /* not yet known is it negated or not */
902 if (s[0] == 'n' && s[1] == 'o') { /* "no.." */
905 } else if (s[0] == '!') {
910 if (strcmp(s, "loop") == 0)
911 /* loop is really short-hand for opts=loop */
912 goto loop_special_case;
913 if (is_prefixed_with(s, "opts=")) {
916 G.fs_type_flag[num] = negate ? FS_TYPE_FLAG_NEGOPT : FS_TYPE_FLAG_OPT;
918 if (G.fs_type_negated == -1)
919 G.fs_type_negated = negate;
920 if (G.fs_type_negated != negate)
921 bb_error_msg_and_die(
922 "either all or none of the filesystem types passed to -t must be prefixed "
925 comma = strchrnul(s, ',');
926 G.fs_type_list[num++] = xstrndup(s, comma-s);
933 static char **new_args(void)
935 G.args = xrealloc_vector(G.args, 2, G.num_args);
936 return &G.args[G.num_args++];
939 int fsck_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
940 int fsck_main(int argc UNUSED_PARAM, char **argv)
949 smallint opts_for_fsck;
955 /* we want wait() to be interruptible */
956 signal_no_SA_RESTART_empty_mask(SIGINT, record_signo);
957 signal_no_SA_RESTART_empty_mask(SIGTERM, record_signo);
959 setbuf(stdout, NULL);
961 opts_for_fsck = doall = notitle = 0;
964 new_args(); /* G.args[0] = NULL, will be replaced by fsck.<type> */
965 /* G.instance_list = NULL; - in bss, so already zeroed */
973 /* "/dev/blk" or "/path" or "UUID=xxx" or "LABEL=xxx" */
974 if ((arg[0] == '/' && !opts_for_fsck) || strchr(arg, '=')) {
975 // FIXME: must check that arg is a blkdev, or resolve
976 // "/path", "UUID=xxx" or "LABEL=xxx" into block device name
977 // ("UUID=xxx"/"LABEL=xxx" can probably shifted to fsck.auto duties)
978 devices = xrealloc_vector(devices, 2, num_devices);
979 devices[num_devices++] = arg;
983 if (arg[0] != '-' || opts_for_fsck) {
988 if (LONE_CHAR(arg + 1, '-')) { /* "--" ? */
995 for (j = 1; arg[j]; j++) {
1000 #if DO_PROGRESS_INDICATOR
1003 if (arg[++j]) { /* -Cn */
1004 progress_fd = xatoi_positive(&arg[j]);
1010 progress_fd = xatoi_positive(*argv);
1029 G.parallel_root = 1;
1043 G.fstype = xstrdup(tmp);
1044 compile_fs_type(G.fstype);
1051 /* one extra for '\0' */
1052 options = xrealloc(options, optpos + 2);
1053 options[optpos] = arg[j];
1060 options[optpos + 1] = '\0';
1061 *new_args() = options;
1064 if (getenv("FSCK_FORCE_ALL_PARALLEL"))
1065 G.force_all_parallel = 1;
1066 tmp = getenv("FSCK_MAX_INST");
1067 G.max_running = INT_MAX;
1069 G.max_running = xatoi(tmp);
1070 new_args(); /* G.args[G.num_args - 2] will be replaced by <device> */
1071 new_args(); /* G.args[G.num_args - 1] is the last, NULL element */
1074 puts("fsck (busybox "BB_VER", "BB_BT")");
1076 /* Even plain "fsck /dev/hda1" needs fstab to get fs type,
1077 * so we are scanning it anyway */
1078 fstab = getenv("FSTAB_FILE");
1080 fstab = "/etc/fstab";
1081 load_fs_info(fstab);
1083 /*interactive = (num_devices == 1) | G.serialize;*/
1085 if (num_devices == 0)
1086 /*interactive =*/ G.serialize = doall = 1;
1091 for (i = 0; i < num_devices; i++) {
1092 if (bb_got_signal) {
1093 kill_all_if_got_signal();
1097 fs = lookup(devices[i]);
1099 fs = create_fs_device(devices[i], "", "auto", NULL, -1);
1100 fsck_device(fs /*, interactive */);
1103 || (G.num_running >= G.max_running)
1105 int exit_status = wait_one(0);
1106 if (exit_status >= 0)
1107 status |= exit_status;
1109 puts("----------------------------------");
1112 status |= wait_many(FLAG_WAIT_ALL);