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.
24 * This file may be redistributed under the terms of the GNU Public
29 /* All filesystem specific hooks have been removed.
30 * If filesystem cannot be determined, we will execute
31 * "fsck.auto". Currently this also happens if you specify
32 * UUID=xxx or LABEL=xxx as an object to check.
33 * Detection code for that is also probably has to be in fsck.auto.
35 * In other words, this is _really_ is just a driver program which
36 * spawns actual fsck.something for each filesystem to check.
37 * It doesn't guess filesystem types from on-disk format.
42 /* "progress indicator" code is somewhat buggy and ext[23] specific.
43 * We should be filesystem agnostic. IOW: there should be a well-defined
44 * API for fsck.something, NOT ad-hoc hacks in generic fsck. */
45 #define DO_PROGRESS_INDICATOR 0
48 #define EXIT_NONDESTRUCT 1
49 #define EXIT_DESTRUCT 2
50 #define EXIT_UNCORRECTED 4
53 #define FSCK_CANCELED 32 /* Aborted with a signal or ^C */
56 * Internal structure for mount table entries.
70 #define FLAG_PROGRESS 2
72 * Structure to allow exit codes to be stored
74 struct fsck_instance {
75 struct fsck_instance *next;
78 #if DO_PROGRESS_INDICATOR
83 char *base_device; /* /dev/hda for /dev/hdaN etc */
86 static const char ignored_types[] ALIGN1 =
97 static const char really_wanted[] ALIGN1 =
107 #define BASE_MD "/dev/md"
109 static char **devices;
111 static int num_devices;
115 #define FS_TYPE_FLAG_NORMAL 0
116 #define FS_TYPE_FLAG_OPT 1
117 #define FS_TYPE_FLAG_NEGOPT 2
118 static char **fs_type_list;
119 static uint8_t *fs_type_flag;
120 static smallint fs_type_negated;
122 static volatile smallint cancel_requested;
123 static smallint doall;
124 static smallint noexecute;
125 static smallint serialize;
126 static smallint skip_root;
127 /* static smallint like_mount; */
128 static smallint notitle;
129 static smallint parallel_root;
130 static smallint force_all_parallel;
132 #if DO_PROGRESS_INDICATOR
133 static smallint progress;
134 static int progress_fd;
137 static int num_running;
138 static int max_running;
140 static struct fs_info *filesys_info;
141 static struct fs_info *filesys_last;
142 static struct fsck_instance *instance_list;
145 * Return the "base device" given a particular device; this is used to
146 * assure that we only fsck one partition on a particular drive at any
147 * one time. Otherwise, the disk heads will be seeking all over the
148 * place. If the base device cannot be determined, return NULL.
150 * The base_device() function returns an allocated string which must
153 #if ENABLE_FEATURE_DEVFS
155 * Required for the uber-silly devfs /dev/ide/host1/bus2/target3/lun3
158 static const char *const devfs_hier[] = {
159 "host", "bus", "target", "lun", NULL
163 static char *base_device(const char *device)
166 #if ENABLE_FEATURE_DEVFS
167 const char *const *hier;
171 cp = str = xstrdup(device);
173 /* Skip over /dev/; if it's not present, give up. */
174 if (strncmp(cp, "/dev/", 5) != 0)
179 * For md devices, we treat them all as if they were all
180 * on one disk, since we don't know how to parallelize them.
182 if (cp[0] == 'm' && cp[1] == 'd') {
187 /* Handle DAC 960 devices */
188 if (strncmp(cp, "rd/", 3) == 0) {
190 if (cp[0] != 'c' || !isdigit(cp[1])
191 || cp[2] != 'd' || !isdigit(cp[3]))
197 /* Now let's handle /dev/hd* and /dev/sd* devices.... */
198 if ((cp[0] == 'h' || cp[0] == 's') && cp[1] == 'd') {
200 /* If there's a single number after /dev/hd, skip it */
203 /* What follows must be an alpha char, or give up */
210 #if ENABLE_FEATURE_DEVFS
211 /* Now let's handle devfs (ugh) names */
213 if (strncmp(cp, "ide/", 4) == 0)
215 if (strncmp(cp, "scsi/", 5) == 0)
220 * Now we proceed down the expected devfs hierarchy.
221 * i.e., .../host1/bus2/target3/lun4/...
222 * If we don't find the expected token, followed by
223 * some number of digits at each level, abort.
225 for (hier = devfs_hier; *hier; hier++) {
227 if (strncmp(cp, *hier, len) != 0)
230 while (*cp != '/' && *cp != 0) {
241 /* Now handle devfs /dev/disc or /dev/disk names */
243 if (strncmp(cp, "discs/", 6) == 0)
245 else if (strncmp(cp, "disks/", 6) == 0)
249 if (strncmp(cp, disk, 4) != 0)
252 while (*cp != '/' && *cp != 0) {
266 static void free_instance(struct fsck_instance *p)
270 free(p->base_device);
274 static struct fs_info *create_fs_device(const char *device, const char *mntpnt,
275 const char *type, const char *opts,
280 fs = xzalloc(sizeof(*fs));
281 fs->device = xstrdup(device);
282 fs->mountpt = xstrdup(mntpnt);
283 fs->type = xstrdup(type);
284 fs->opts = xstrdup(opts ? opts : "");
287 /*fs->next = NULL; */
292 filesys_last->next = fs;
298 static void strip_line(char *line)
300 char *p = line + strlen(line) - 1;
303 if (*p != '\n' && *p != '\r')
309 static char *parse_word(char **buf)
317 word = skip_whitespace(word);
318 next = skip_non_whitespace(word);
325 static void parse_escape(char *word)
333 for (p = q = word; *p; q++) {
338 *q = bb_process_escape_sequence(&p);
344 static int parse_fstab_line(char *line, struct fs_info **ret_fs)
346 char *device, *mntpnt, *type, *opts, *passno, *cp;
351 *strchrnul(line, '#') = '\0'; /* Ignore everything after comment */
354 device = parse_word(&cp);
355 if (!device) return 0; /* Allow blank lines */
356 mntpnt = parse_word(&cp);
357 type = parse_word(&cp);
358 opts = parse_word(&cp);
359 /*freq =*/ parse_word(&cp);
360 passno = parse_word(&cp);
362 if (!mntpnt || !type)
365 parse_escape(device);
366 parse_escape(mntpnt);
369 parse_escape(passno);
371 if (strchr(type, ','))
374 fs = create_fs_device(device, mntpnt, type ? type : "auto", opts,
375 (passno ? atoi(passno) : -1));
380 /* Load the filesystem database from /etc/fstab */
381 static void load_fs_info(const char *filename)
388 f = fopen_or_warn(filename, "r");
394 char *buf = xmalloc_fgetline(f);
396 r = parse_fstab_line(buf, &fs);
400 bb_error_msg("WARNING: bad format "
401 "on line %d of %s", lineno, filename);
415 "WARNING: Your /etc/fstab does not contain the fsck passno field.\n"
416 "I will kludge around things for you, but you should fix\n"
417 "your /etc/fstab file as soon as you can.\n\n", stderr);
418 for (fs = filesys_info; fs; fs = fs->next) {
424 /* Lookup filesys in /etc/fstab and return the corresponding entry. */
425 static struct fs_info *lookup(char *filesys)
429 for (fs = filesys_info; fs; fs = fs->next) {
430 if (strcmp(filesys, fs->device) == 0
431 || (fs->mountpt && strcmp(filesys, fs->mountpt) == 0)
439 #if DO_PROGRESS_INDICATOR
440 static int progress_active(void)
442 struct fsck_instance *inst;
444 for (inst = instance_list; inst; inst = inst->next) {
445 if (inst->flags & FLAG_DONE)
447 if (inst->flags & FLAG_PROGRESS)
456 * Send a signal to all outstanding fsck child processes
458 static void kill_all_if_cancel_requested(void)
460 static smallint kill_sent;
462 struct fsck_instance *inst;
464 if (!cancel_requested || kill_sent)
467 for (inst = instance_list; inst; inst = inst->next) {
468 if (inst->flags & FLAG_DONE)
470 kill(inst->pid, SIGTERM);
476 * Wait for one child process to exit; when it does, unlink it from
477 * the list of executing child processes, free, and return its exit status.
478 * If there is no exited child, return -1.
480 static int wait_one(int flags)
484 struct fsck_instance *inst, *prev;
489 /* if (noexecute) { already returned -1; } */
492 pid = waitpid(-1, &status, flags);
493 kill_all_if_cancel_requested();
494 if (pid == 0) /* flags == WNOHANG and no children exited */
499 if (errno == ECHILD) { /* paranoia */
500 bb_error_msg("wait: no more children");
503 bb_perror_msg("wait");
507 inst = instance_list;
509 if (inst->pid == pid)
517 if (WIFEXITED(status))
518 status = WEXITSTATUS(status);
519 else if (WIFSIGNALED(status)) {
520 sig = WTERMSIG(status);
521 status = EXIT_UNCORRECTED;
523 printf("Warning: %s %s terminated "
525 inst->prog, inst->device, sig);
529 printf("%s %s: status is %x, should never happen\n",
530 inst->prog, inst->device, status);
534 #if DO_PROGRESS_INDICATOR
535 if (progress && (inst->flags & FLAG_PROGRESS) && !progress_active()) {
536 struct fsck_instance *inst2;
537 for (inst2 = instance_list; inst2; inst2 = inst2->next) {
538 if (inst2->flags & FLAG_DONE)
540 if (strcmp(inst2->type, "ext2") != 0
541 && strcmp(inst2->type, "ext3") != 0
545 /* ext[23], we will send USR1
546 * (request to start displaying progress bar)
548 * If we've just started the fsck, wait a tiny
549 * bit before sending the kill, to give it
550 * time to set up the signal handler
552 if (inst2->start_time >= time(NULL) - 1)
554 kill(inst2->pid, SIGUSR1);
555 inst2->flags |= FLAG_PROGRESS;
562 prev->next = inst->next;
564 instance_list = inst->next;
566 printf("Finished with %s (exit status %d)\n",
567 inst->device, status);
575 * Wait until all executing child processes have exited; return the
576 * logical OR of all of their exit code values.
578 #define FLAG_WAIT_ALL 0
579 #define FLAG_WAIT_ATLEAST_ONE WNOHANG
580 static int wait_many(int flags)
583 int global_status = 0;
586 while ((exit_status = wait_one(wait_flags)) != -1) {
587 global_status |= exit_status;
590 return global_status;
594 * Execute a particular fsck program, and link it into the list of
595 * child processes we are waiting for.
597 static void execute(const char *type, const char *device,
598 const char *mntpt /*, int interactive */)
600 char *argv[num_args + 4]; /* see count below: */
603 struct fsck_instance *inst;
606 argv[0] = xasprintf("fsck.%s", type); /* 1 */
607 for (i = 0; i < num_args; i++)
608 argv[i+1] = args[i]; /* num_args */
611 #if DO_PROGRESS_INDICATOR
612 if (progress && !progress_active()) {
613 if (strcmp(type, "ext2") == 0
614 || strcmp(type, "ext3") == 0
616 argv[argc++] = xasprintf("-C%d", progress_fd); /* 1 */
617 inst->flags |= FLAG_PROGRESS;
622 argv[argc++] = (char*)device; /* 1 */
623 argv[argc] = NULL; /* 1 */
625 if (verbose || noexecute) {
626 printf("[%s (%d) -- %s]", argv[0], num_running,
627 mntpt ? mntpt : device);
628 for (i = 0; i < argc; i++)
629 printf(" %s", argv[i]);
633 /* Fork and execute the correct program. */
638 bb_simple_perror_msg(argv[0]);
641 #if DO_PROGRESS_INDICATOR
642 free(argv[num_args + 1]);
645 /* No child, so don't record an instance */
651 inst = xzalloc(sizeof(*inst));
653 inst->prog = argv[0];
654 inst->device = xstrdup(device);
655 inst->base_device = base_device(device);
656 #if DO_PROGRESS_INDICATOR
657 inst->start_time = time(NULL);
660 /* Add to the list of running fsck's.
661 * (was adding to the end, but adding to the front is simpler...) */
662 inst->next = instance_list;
663 instance_list = inst;
667 * Run the fsck program on a particular device
669 * If the type is specified using -t, and it isn't prefixed with "no"
670 * (as in "noext2") and only one filesystem type is specified, then
671 * use that type regardless of what is specified in /etc/fstab.
673 * If the type isn't specified by the user, then use either the type
674 * specified in /etc/fstab, or "auto".
676 static void fsck_device(struct fs_info *fs /*, int interactive */)
680 if (strcmp(fs->type, "auto") != 0) {
683 bb_info_msg("using filesystem type '%s' %s",
686 && (fstype[0] != 'n' || fstype[1] != 'o') /* != "no" */
687 && strncmp(fstype, "opts=", 5) != 0
688 && strncmp(fstype, "loop", 4) != 0
689 && !strchr(fstype, ',')
693 bb_info_msg("using filesystem type '%s' %s",
698 bb_info_msg("using filesystem type '%s' %s",
703 execute(type, fs->device, fs->mountpt /*, interactive */);
707 * Returns TRUE if a partition on the same disk is already being
710 static int device_already_active(char *device)
712 struct fsck_instance *inst;
715 if (force_all_parallel)
719 /* Don't check a soft raid disk with any other disk */
721 && (!strncmp(instance_list->device, BASE_MD, sizeof(BASE_MD)-1)
722 || !strncmp(device, BASE_MD, sizeof(BASE_MD)-1))
728 base = base_device(device);
730 * If we don't know the base device, assume that the device is
731 * already active if there are any fsck instances running.
734 return (instance_list != NULL);
736 for (inst = instance_list; inst; inst = inst->next) {
737 if (!inst->base_device || !strcmp(base, inst->base_device)) {
748 * This function returns true if a particular option appears in a
749 * comma-delimited options list
751 static int opt_in_list(char *opt, char *optlist)
762 s = strstr(s + 1, opt);
765 /* neither "opt.." nor "xxx,opt.."? */
766 if (s != optlist && s[-1] != ',')
768 /* neither "..opt" nor "..opt,xxx"? */
769 if (s[len] != '\0' && s[len] != ',')
775 /* See if the filesystem matches the criteria given by the -t option */
776 static int fs_match(struct fs_info *fs)
778 int n, ret, checked_type;
788 cp = fs_type_list[n];
791 switch (fs_type_flag[n]) {
792 case FS_TYPE_FLAG_NORMAL:
794 if (strcmp(cp, fs->type) == 0)
797 case FS_TYPE_FLAG_NEGOPT:
798 if (opt_in_list(cp, fs->opts))
801 case FS_TYPE_FLAG_OPT:
802 if (!opt_in_list(cp, fs->opts))
808 if (checked_type == 0)
811 return (fs_type_negated ? !ret : ret);
814 /* Check if we should ignore this filesystem. */
815 static int ignore(struct fs_info *fs)
818 * If the pass number is 0, ignore it.
824 * If a specific fstype is specified, and it doesn't match,
830 /* Are we ignoring this type? */
831 if (index_in_strings(ignored_types, fs->type) >= 0)
834 /* We can and want to check this file system type. */
838 /* Check all file systems, using the /etc/fstab table. */
839 static int check_all(void)
842 int status = EXIT_OK;
843 smallint not_done_yet;
848 puts("Checking all filesystems");
851 * Do an initial scan over the filesystem; mark filesystems
852 * which should be ignored as done, and resolve any "auto"
853 * filesystem types (done as a side-effect of calling ignore()).
855 for (fs = filesys_info; fs; fs = fs->next)
857 fs->flags |= FLAG_DONE;
860 * Find and check the root filesystem.
862 if (!parallel_root) {
863 for (fs = filesys_info; fs; fs = fs->next) {
864 if (LONE_CHAR(fs->mountpt, '/')) {
865 if (!skip_root && !ignore(fs)) {
866 fsck_device(fs /*, 1*/);
867 status |= wait_many(FLAG_WAIT_ALL);
868 if (status > EXIT_NONDESTRUCT)
871 fs->flags |= FLAG_DONE;
877 * This is for the bone-headed user who has root
878 * filesystem listed twice.
879 * "Skip root" will skip _all_ root entries.
882 for (fs = filesys_info; fs; fs = fs->next)
883 if (LONE_CHAR(fs->mountpt, '/'))
884 fs->flags |= FLAG_DONE;
888 while (not_done_yet) {
892 for (fs = filesys_info; fs; fs = fs->next) {
893 if (cancel_requested)
895 if (fs->flags & FLAG_DONE)
898 * If the filesystem's pass number is higher
899 * than the current pass number, then we didn't
902 if (fs->passno > passno) {
907 * If a filesystem on a particular device has
908 * already been spawned, then we need to defer
909 * this to another pass.
911 if (device_already_active(fs->device)) {
916 * Spawn off the fsck process
918 fsck_device(fs /*, serialize*/);
919 fs->flags |= FLAG_DONE;
922 * Only do one filesystem at a time, or if we
923 * have a limit on the number of fsck's extant
924 * at one time, apply that limit.
927 || (max_running && (num_running >= max_running))
933 if (cancel_requested)
936 printf("--waiting-- (pass %d)\n", passno);
937 status |= wait_many(pass_done ? FLAG_WAIT_ALL :
938 FLAG_WAIT_ATLEAST_ONE);
941 puts("----------------------------------");
946 kill_all_if_cancel_requested();
947 status |= wait_many(FLAG_WAIT_ATLEAST_ONE);
952 * Deal with the fsck -t argument.
953 * Huh, for mount "-t novfat,nfs" means "neither vfat nor nfs"!
954 * Why here we require "-t novfat,nonfs" ??
956 static void compile_fs_type(char *fs_type)
963 while ((s = strchr(s, ','))) {
968 fs_type_list = xzalloc(num * sizeof(fs_type_list[0]));
969 fs_type_flag = xzalloc(num * sizeof(fs_type_flag[0]));
970 fs_type_negated = -1; /* not yet known is it negated or not */
978 if (s[0] == 'n' && s[1] == 'o') { /* "no.." */
981 } else if (s[0] == '!') {
986 if (strcmp(s, "loop") == 0)
987 /* loop is really short-hand for opts=loop */
988 goto loop_special_case;
989 if (strncmp(s, "opts=", 5) == 0) {
992 fs_type_flag[num] = negate ? FS_TYPE_FLAG_NEGOPT : FS_TYPE_FLAG_OPT;
994 if (fs_type_negated == -1)
995 fs_type_negated = negate;
996 if (fs_type_negated != negate)
997 bb_error_msg_and_die(
998 "either all or none of the filesystem types passed to -t must be prefixed "
1001 comma = strchr(s, ',');
1002 fs_type_list[num++] = comma ? xstrndup(s, comma-s) : xstrdup(s);
1009 static void parse_args(char **argv)
1015 int opts_for_fsck = 0;
1017 /* in bss, so already zeroed
1020 instance_list = NULL;
1023 for (i = 1; argv[i]; i++) {
1026 /* "/dev/blk" or "/path" or "UUID=xxx" or "LABEL=xxx" */
1027 if ((arg[0] == '/' && !opts_for_fsck) || strchr(arg, '=')) {
1028 // FIXME: must check that arg is a blkdev, or resolve
1029 // "/path", "UUID=xxx" or "LABEL=xxx" into block device name
1030 // ("UUID=xxx"/"LABEL=xxx" can probably shifted to fsck.auto duties)
1031 devices = xrealloc_vector(devices, 2, num_devices);
1032 devices[num_devices++] = xstrdup(arg);
1036 if (arg[0] != '-' || opts_for_fsck) {
1037 args = xrealloc_vector(args, 2, num_args);
1038 args[num_args++] = xstrdup(arg);
1042 if (LONE_CHAR(arg + 1, '-')) { /* "--" ? */
1049 for (j = 1; arg[j]; j++) {
1054 #if DO_PROGRESS_INDICATOR
1057 if (arg[++j]) { /* -Cn */
1058 progress_fd = xatoi_u(&arg[j]);
1062 if (!argv[++i]) bb_show_usage();
1063 progress_fd = xatoi_u(argv[i]);
1096 fstype = xstrdup(tmp);
1097 compile_fs_type(fstype);
1104 /* one extra for '\0' */
1105 options = xrealloc(options, optpos + 2);
1106 options[optpos] = arg[j];
1113 options[optpos + 1] = '\0';
1114 args = xrealloc_vector(args, 2, num_args);
1115 args[num_args++] = options;
1118 if (getenv("FSCK_FORCE_ALL_PARALLEL"))
1119 force_all_parallel = 1;
1120 tmp = getenv("FSCK_MAX_INST");
1122 max_running = xatoi(tmp);
1125 static void signal_cancel(int sig UNUSED_PARAM)
1127 cancel_requested = 1;
1130 int fsck_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
1131 int fsck_main(int argc UNUSED_PARAM, char **argv)
1134 /*int interactive;*/
1138 /* we want wait() to be interruptible */
1139 signal_no_SA_RESTART_empty_mask(SIGINT, signal_cancel);
1140 signal_no_SA_RESTART_empty_mask(SIGTERM, signal_cancel);
1142 setbuf(stdout, NULL);
1147 puts("fsck (busybox "BB_VER", "BB_BT")");
1149 /* Even plain "fsck /dev/hda1" needs fstab to get fs type,
1150 * so we are scanning it anyway */
1151 fstab = getenv("FSTAB_FILE");
1153 fstab = "/etc/fstab";
1154 load_fs_info(fstab);
1156 /*interactive = (num_devices == 1) | serialize;*/
1158 if (num_devices == 0)
1159 /*interactive =*/ serialize = doall = 1;
1164 for (i = 0; i < num_devices; i++) {
1165 if (cancel_requested) {
1166 kill_all_if_cancel_requested();
1170 fs = lookup(devices[i]);
1172 fs = create_fs_device(devices[i], "", "auto", NULL, -1);
1173 fsck_device(fs /*, interactive */);
1176 || (max_running && (num_running >= max_running))
1178 int exit_status = wait_one(0);
1179 if (exit_status >= 0)
1180 status |= exit_status;
1182 puts("----------------------------------");
1185 status |= wait_many(FLAG_WAIT_ALL);