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.
43 #define EXIT_NONDESTRUCT 1
44 #define EXIT_DESTRUCT 2
45 #define EXIT_UNCORRECTED 4
48 #define FSCK_CANCELED 32 /* Aborted with a signal or ^C */
51 * Internal structure for mount table entries.
66 #define FLAG_PROGRESS 2
68 * Structure to allow exit codes to be stored
70 struct fsck_instance {
71 struct fsck_instance *next;
79 char *base_device; /* /dev/hda for /dev/hdaN etc */
82 static const char ignored_types[] ALIGN1 =
93 static const char really_wanted[] ALIGN1 =
103 #define BASE_MD "/dev/md"
105 static char **devices;
107 static int num_devices;
111 #define FS_TYPE_FLAG_NORMAL 0
112 #define FS_TYPE_FLAG_OPT 1
113 #define FS_TYPE_FLAG_NEGOPT 2
114 static char **fs_type_list;
115 static uint8_t *fs_type_flag;
116 static smallint fs_type_negated;
118 static volatile smallint cancel_requested;
119 static smallint doall;
120 static smallint noexecute;
121 static smallint serialize;
122 static smallint skip_root;
123 /* static smallint like_mount; */
124 static smallint notitle;
125 static smallint parallel_root;
126 static smallint force_all_parallel;
128 /* "progress indicator" code is somewhat buggy and ext[23] specific.
129 * We should be filesystem agnostic. IOW: there should be a well-defined
130 * API for fsck.something, NOT ad-hoc hacks in generic fsck. */
131 #define DO_PROGRESS_INDICATOR 0
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,
276 int freq, int passno)
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 : "");
288 /*fs->next = NULL; */
293 filesys_last->next = fs;
299 static void strip_line(char *line)
301 char *p = line + strlen(line) - 1;
304 if (*p != '\n' && *p != '\r')
310 static char *parse_word(char **buf)
318 word = skip_whitespace(word);
319 next = skip_non_whitespace(word);
326 static void parse_escape(char *word)
334 for (p = q = word; *p; q++) {
339 *q = bb_process_escape_sequence(&p);
345 static int parse_fstab_line(char *line, struct fs_info **ret_fs)
347 char *device, *mntpnt, *type, *opts, *freq, *passno, *cp;
352 cp = strchr(line, '#');
354 *cp = '\0'; /* Ignore everything after the comment char */
357 device = parse_word(&cp);
358 if (!device) return 0; /* Allow blank lines */
359 mntpnt = parse_word(&cp);
360 type = parse_word(&cp);
361 opts = parse_word(&cp);
362 freq = parse_word(&cp);
363 passno = parse_word(&cp);
365 if (!mntpnt || !type)
368 parse_escape(device);
369 parse_escape(mntpnt);
373 parse_escape(passno);
375 if (strchr(type, ','))
378 fs = create_fs_device(device, mntpnt, type ? type : "auto", opts,
379 freq ? atoi(freq) : -1,
380 passno ? atoi(passno) : -1);
385 /* Load the filesystem database from /etc/fstab */
386 static void load_fs_info(const char *filename)
393 f = fopen_or_warn(filename, "r");
399 char *buf = xmalloc_getline(f);
401 r = parse_fstab_line(buf, &fs);
405 bb_error_msg("WARNING: bad format "
406 "on line %d of %s", lineno, filename);
420 "WARNING: Your /etc/fstab does not contain the fsck passno field.\n"
421 "I will kludge around things for you, but you should fix\n"
422 "your /etc/fstab file as soon as you can.\n\n", stderr);
423 for (fs = filesys_info; fs; fs = fs->next) {
429 /* Lookup filesys in /etc/fstab and return the corresponding entry. */
430 static struct fs_info *lookup(char *filesys)
434 for (fs = filesys_info; fs; fs = fs->next) {
435 if (strcmp(filesys, fs->device) == 0
436 || (fs->mountpt && strcmp(filesys, fs->mountpt) == 0)
444 #if DO_PROGRESS_INDICATOR
445 static int progress_active(void)
447 struct fsck_instance *inst;
449 for (inst = instance_list; inst; inst = inst->next) {
450 if (inst->flags & FLAG_DONE)
452 if (inst->flags & FLAG_PROGRESS)
461 * Send a signal to all outstanding fsck child processes
463 static void kill_all_if_cancel_requested(void)
465 static smallint kill_sent;
467 struct fsck_instance *inst;
469 if (!cancel_requested || kill_sent)
472 for (inst = instance_list; inst; inst = inst->next) {
473 if (inst->flags & FLAG_DONE)
475 kill(inst->pid, SIGTERM);
481 * Wait for one child process to exit; when it does, unlink it from
482 * the list of executing child processes, and return it.
484 static struct fsck_instance *wait_one(int flags)
488 struct fsck_instance *inst, *prev;
495 inst = instance_list;
498 while (inst->next && (random() & 1)) {
503 inst->exit_status = 0;
507 inst = prev = NULL; /* for gcc */
509 pid = waitpid(-1, &status, flags);
510 kill_all_if_cancel_requested();
511 if (pid == 0 && (flags & WNOHANG))
514 if (errno == EINTR || errno == EAGAIN)
516 if (errno == ECHILD) {
517 bb_error_msg("wait: no more child process?!?");
520 bb_perror_msg("wait");
524 inst = instance_list;
526 if (inst->pid == pid)
533 if (WIFEXITED(status))
534 status = WEXITSTATUS(status);
535 else if (WIFSIGNALED(status)) {
536 sig = WTERMSIG(status);
537 status = EXIT_UNCORRECTED;
539 printf("Warning... %s %s exited "
541 inst->prog, inst->device, sig);
545 printf("%s %s: status is %x, should never happen\n",
546 inst->prog, inst->device, status);
549 inst->exit_status = status;
551 #if DO_PROGRESS_INDICATOR
552 if (progress && (inst->flags & FLAG_PROGRESS) && !progress_active()) {
553 struct fsck_instance *inst2;
554 for (inst2 = instance_list; inst2; inst2 = inst2->next) {
555 if (inst2->flags & FLAG_DONE)
557 if (strcmp(inst2->type, "ext2") != 0
558 && strcmp(inst2->type, "ext3") != 0
562 /* ext[23], we will send USR1
563 * (request to start displaying progress bar)
565 * If we've just started the fsck, wait a tiny
566 * bit before sending the kill, to give it
567 * time to set up the signal handler
569 if (inst2->start_time >= time(NULL) - 1)
571 kill(inst2->pid, SIGUSR1);
572 inst2->flags |= FLAG_PROGRESS;
580 prev->next = inst->next;
582 instance_list = inst->next;
584 printf("Finished with %s (exit status %d)\n",
585 inst->device, inst->exit_status);
590 #define FLAG_WAIT_ALL 0
591 #define FLAG_WAIT_ATLEAST_ONE 1
593 * Wait until all executing child processes have exited; return the
594 * logical OR of all of their exit code values.
596 static int wait_many(int flags)
598 struct fsck_instance *inst;
599 int global_status = 0;
602 while ((inst = wait_one(wait_flags))) {
603 global_status |= inst->exit_status;
606 if (noexecute && (flags & WNOHANG) && !(random() % 3))
609 if (flags & FLAG_WAIT_ATLEAST_ONE)
610 wait_flags = WNOHANG;
612 return global_status;
616 * Execute a particular fsck program, and link it into the list of
617 * child processes we are waiting for.
619 static void execute(const char *type, const char *device, const char *mntpt,
622 char *argv[num_args + 4]; /* see count below: */
625 struct fsck_instance *inst;
628 inst = xzalloc(sizeof(*inst));
630 argv[0] = xasprintf("fsck.%s", type); /* 1 */
631 for (i = 0; i < num_args; i++)
632 argv[i+1] = args[i]; /* num_args */
635 #if DO_PROGRESS_INDICATOR
636 if (progress && !progress_active()) {
637 if (strcmp(type, "ext2") == 0
638 || strcmp(type, "ext3") == 0
640 argv[argc++] = xasprintf("-C%d", progress_fd); /* 1 */
641 inst->flags |= FLAG_PROGRESS;
646 argv[argc++] = xstrdup(device); /* 1 */
647 argv[argc] = NULL; /* 1 */
649 if (verbose || noexecute) {
650 printf("[%s (%d) -- %s]", argv[0], num_running,
651 mntpt ? mntpt : device);
652 for (i = 0; i < argc; i++)
653 printf(" %s", argv[i]);
657 /* Fork and execute the correct program. */
662 bb_perror_msg("%s", argv[0]);
665 for (i = num_args+1; i < argc; i++)
669 inst->prog = argv[0];
670 inst->type = xstrdup(type);
671 inst->device = xstrdup(device);
672 inst->base_device = base_device(device);
673 inst->start_time = time(NULL);
675 /* Add to the list of running fsck's.
676 * (was adding to the end, but adding to the front is simpler...) */
677 inst->next = instance_list;
678 instance_list = inst;
682 * Run the fsck program on a particular device
684 * If the type is specified using -t, and it isn't prefixed with "no"
685 * (as in "noext2") and only one filesystem type is specified, then
686 * use that type regardless of what is specified in /etc/fstab.
688 * If the type isn't specified by the user, then use either the type
689 * specified in /etc/fstab, or "auto".
691 static void fsck_device(struct fs_info *fs, int interactive)
695 if (strcmp(fs->type, "auto") != 0) {
698 bb_info_msg("using filesystem type '%s' %s",
701 && (fstype[0] != 'n' || fstype[1] != 'o') /* != "no" */
702 && strncmp(fstype, "opts=", 5) != 0
703 && strncmp(fstype, "loop", 4) != 0
704 && !strchr(fstype, ',')
708 bb_info_msg("using filesystem type '%s' %s",
713 bb_info_msg("using filesystem type '%s' %s",
718 execute(type, fs->device, fs->mountpt, interactive);
722 * Returns TRUE if a partition on the same disk is already being
725 static int device_already_active(char *device)
727 struct fsck_instance *inst;
730 if (force_all_parallel)
734 /* Don't check a soft raid disk with any other disk */
736 && (!strncmp(instance_list->device, BASE_MD, sizeof(BASE_MD)-1)
737 || !strncmp(device, BASE_MD, sizeof(BASE_MD)-1))
743 base = base_device(device);
745 * If we don't know the base device, assume that the device is
746 * already active if there are any fsck instances running.
749 return (instance_list != NULL);
751 for (inst = instance_list; inst; inst = inst->next) {
752 if (!inst->base_device || !strcmp(base, inst->base_device)) {
763 * This function returns true if a particular option appears in a
764 * comma-delimited options list
766 static int opt_in_list(char *opt, char *optlist)
777 s = strstr(s + 1, opt);
780 /* neither "opt.." nor "xxx,opt.."? */
781 if (s != optlist && s[-1] != ',')
783 /* neither "..opt" nor "..opt,xxx"? */
784 if (s[len] != '\0' && s[len] != ',')
790 /* See if the filesystem matches the criteria given by the -t option */
791 static int fs_match(struct fs_info *fs)
793 int n, ret, checked_type;
803 cp = fs_type_list[n];
806 switch (fs_type_flag[n]) {
807 case FS_TYPE_FLAG_NORMAL:
809 if (strcmp(cp, fs->type) == 0)
812 case FS_TYPE_FLAG_NEGOPT:
813 if (opt_in_list(cp, fs->opts))
816 case FS_TYPE_FLAG_OPT:
817 if (!opt_in_list(cp, fs->opts))
823 if (checked_type == 0)
826 return (fs_type_negated ? !ret : ret);
829 /* Check if we should ignore this filesystem. */
830 static int ignore(struct fs_info *fs)
833 * If the pass number is 0, ignore it.
839 * If a specific fstype is specified, and it doesn't match,
845 /* Are we ignoring this type? */
846 if (index_in_strings(ignored_types, fs->type) >= 0)
849 /* We can and want to check this file system type. */
853 /* Check all file systems, using the /etc/fstab table. */
854 static int check_all(void)
857 int status = EXIT_OK;
858 smallint not_done_yet;
863 puts("Checking all filesystems");
866 * Do an initial scan over the filesystem; mark filesystems
867 * which should be ignored as done, and resolve any "auto"
868 * filesystem types (done as a side-effect of calling ignore()).
870 for (fs = filesys_info; fs; fs = fs->next) {
872 fs->flags |= FLAG_DONE;
876 * Find and check the root filesystem.
878 if (!parallel_root) {
879 for (fs = filesys_info; fs; fs = fs->next) {
880 if (LONE_CHAR(fs->mountpt, '/'))
884 if (!skip_root && !ignore(fs)) {
886 status |= wait_many(FLAG_WAIT_ALL);
887 if (status > EXIT_NONDESTRUCT)
890 fs->flags |= FLAG_DONE;
894 * This is for the bone-headed user who enters the root
895 * filesystem twice. Skip root will skip all root entries.
898 for (fs = filesys_info; fs; fs = fs->next)
899 if (LONE_CHAR(fs->mountpt, '/'))
900 fs->flags |= FLAG_DONE;
904 while (not_done_yet) {
908 for (fs = filesys_info; fs; fs = fs->next) {
909 if (cancel_requested)
911 if (fs->flags & FLAG_DONE)
914 * If the filesystem's pass number is higher
915 * than the current pass number, then we don't
918 if (fs->passno > passno) {
923 * If a filesystem on a particular device has
924 * already been spawned, then we need to defer
925 * this to another pass.
927 if (device_already_active(fs->device)) {
932 * Spawn off the fsck process
934 fsck_device(fs, serialize);
935 fs->flags |= FLAG_DONE;
938 * Only do one filesystem at a time, or if we
939 * have a limit on the number of fsck's extant
940 * at one time, apply that limit.
943 || (max_running && (num_running >= max_running))
949 if (cancel_requested)
952 printf("--waiting-- (pass %d)\n", passno);
953 status |= wait_many(pass_done ? FLAG_WAIT_ALL :
954 FLAG_WAIT_ATLEAST_ONE);
957 puts("----------------------------------");
962 kill_all_if_cancel_requested();
963 status |= wait_many(FLAG_WAIT_ATLEAST_ONE);
968 * Deal with the fsck -t argument.
969 * Huh, for mount "-t novfat,nfs" means "neither vfat nor nfs"!
970 * Why here we require "-t novfat,nonfs" ??
972 static void compile_fs_type(char *fs_type)
980 while ((s = strchr(s, ','))) {
986 fs_type_list = xzalloc(num * sizeof(fs_type_list[0]));
987 fs_type_flag = xzalloc(num * sizeof(fs_type_flag[0]));
988 fs_type_negated = -1; /* not yet known is it negated or not */
999 if (s[0] == 'n' && s[1] == 'o') { /* "no.." */
1002 } else if (s[0] == '!') {
1007 if (strcmp(s, "loop") == 0)
1008 /* loop is really short-hand for opts=loop */
1009 goto loop_special_case;
1010 if (strncmp(s, "opts=", 5) == 0) {
1013 fs_type_flag[num] = negate ? FS_TYPE_FLAG_NEGOPT : FS_TYPE_FLAG_OPT;
1015 if (fs_type_negated == -1)
1016 fs_type_negated = negate;
1017 if (fs_type_negated != negate)
1018 bb_error_msg_and_die(
1019 "either all or none of the filesystem types passed to -t must be prefixed "
1020 "with 'no' or '!'");
1022 comma = strchr(s, ',');
1023 fs_type_list[num++] = comma ? xstrndup(s, comma-s) : xstrdup(s);
1030 static void parse_args(int argc, char **argv)
1034 char *options = NULL;
1036 int opts_for_fsck = 0;
1038 /* in bss, so already zeroed
1041 instance_list = NULL;
1044 /* TODO: getopt32 */
1045 for (i = 1; i < argc; i++) {
1048 /* "/dev/blk" or "/path" or "UUID=xxx" or "LABEL=xxx" */
1049 if ((arg[0] == '/' && !opts_for_fsck) || strchr(arg, '=')) {
1050 // FIXME: must check that arg is a blkdev, or resolve
1051 // "/path", "UUID=xxx" or "LABEL=xxx" into block device name
1052 // ("UUID=xxx"/"LABEL=xxx" can probably shifted to fsck.auto duties)
1053 devices = xrealloc(devices, (num_devices+1) * sizeof(devices[0]));
1054 devices[num_devices++] = xstrdup(arg);
1058 if (arg[0] != '-' || opts_for_fsck) {
1059 args = xrealloc(args, (num_args+1) * sizeof(args[0]));
1060 args[num_args++] = xstrdup(arg);
1064 for (j = 1; arg[j]; j++) {
1065 if (opts_for_fsck) {
1067 /* one extra for '\0' */
1068 options = xrealloc(options, optpos + 2);
1069 options[optpos] = arg[j];
1076 #if DO_PROGRESS_INDICATOR
1079 if (arg[++j]) { /* -Cn */
1080 progress_fd = xatoi_u(&arg[j]);
1084 progress_fd = xatoi_u(argv[++i]);
1113 else if (++i < argc)
1117 fstype = xstrdup(tmp);
1118 compile_fs_type(fstype);
1128 /* one extra for '\0' */
1129 options = xrealloc(options, optpos + 2);
1130 options[optpos] = arg[j];
1137 options[optpos + 1] = '\0';
1138 args = xrealloc(args, (num_args+1) * sizeof(args[0]));
1139 args[num_args++] = options;
1144 if (getenv("FSCK_FORCE_ALL_PARALLEL"))
1145 force_all_parallel = 1;
1146 tmp = getenv("FSCK_MAX_INST");
1148 max_running = xatoi(tmp);
1151 static void signal_cancel(int sig ATTRIBUTE_UNUSED)
1153 cancel_requested = 1;
1156 int fsck_main(int argc, char **argv);
1157 int fsck_main(int argc, char **argv)
1163 struct sigaction sa;
1165 memset(&sa, 0, sizeof(sa));
1166 sa.sa_handler = signal_cancel;
1167 sigaction(SIGINT, &sa, 0);
1168 sigaction(SIGTERM, &sa, 0);
1170 setbuf(stdout, NULL);
1172 parse_args(argc, argv);
1175 puts("fsck (busybox "BB_VER", "BB_BT")");
1177 /* Even plain "fsck /dev/hda1" needs fstab to get fs type,
1178 * so we are scanning it anyway */
1179 fstab = getenv("FSTAB_FILE");
1181 fstab = "/etc/fstab";
1182 load_fs_info(fstab);
1184 interactive = (num_devices == 1) | serialize;
1186 /* If -A was specified ("check all"), do that! */
1190 if (num_devices == 0) {
1196 for (i = 0; i < num_devices; i++) {
1197 if (cancel_requested) {
1198 kill_all_if_cancel_requested();
1202 fs = lookup(devices[i]);
1204 fs = create_fs_device(devices[i], 0, "auto", 0, -1, -1);
1205 fsck_device(fs, interactive);
1208 || (max_running && (num_running >= max_running))
1210 struct fsck_instance *inst;
1214 status |= inst->exit_status;
1215 free_instance(inst);
1218 puts("----------------------------------");
1221 status |= wait_many(FLAG_WAIT_ALL);