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.
37 //usage:#define fsck_trivial_usage
38 //usage: "[-ANPRTV] [-C FD] [-t FSTYPE] [FS_OPTS] [BLOCKDEV]..."
39 //usage:#define fsck_full_usage "\n\n"
40 //usage: "Check and repair filesystems\n"
41 //usage: "\n -A Walk /etc/fstab and check all filesystems"
42 //usage: "\n -N Don't execute, just show what would be done"
43 //usage: "\n -P With -A, check filesystems in parallel"
44 //usage: "\n -R With -A, skip the root filesystem"
45 //usage: "\n -T Don't show title on startup"
46 //usage: "\n -V Verbose"
47 //usage: "\n -C n Write status information to specified filedescriptor"
48 //usage: "\n -t TYPE List of filesystem types to check"
52 /* "progress indicator" code is somewhat buggy and ext[23] specific.
53 * We should be filesystem agnostic. IOW: there should be a well-defined
54 * API for fsck.something, NOT ad-hoc hacks in generic fsck. */
55 #define DO_PROGRESS_INDICATOR 0
57 /* fsck 1.41.4 (27-Jan-2009) manpage says:
59 * 1 - File system errors corrected
60 * 2 - System should be rebooted
61 * 4 - File system errors left uncorrected
62 * 8 - Operational error
63 * 16 - Usage or syntax error
64 * 32 - Fsck canceled by user request
65 * 128 - Shared library error
68 #define EXIT_NONDESTRUCT 1
69 #define EXIT_DESTRUCT 2
70 #define EXIT_UNCORRECTED 4
73 #define FSCK_CANCELED 32 /* Aborted with a signal or ^C */
76 * Internal structure for mount table entries.
89 #define FLAG_PROGRESS 2
91 * Structure to allow exit codes to be stored
93 struct fsck_instance {
94 struct fsck_instance *next;
97 #if DO_PROGRESS_INDICATOR
102 char *base_device; /* /dev/hda for /dev/hdaN etc */
105 static const char ignored_types[] ALIGN1 =
116 static const char really_wanted[] ALIGN1 =
126 #define BASE_MD "/dev/md"
132 #define FS_TYPE_FLAG_NORMAL 0
133 #define FS_TYPE_FLAG_OPT 1
134 #define FS_TYPE_FLAG_NEGOPT 2
135 static char **fs_type_list;
136 static uint8_t *fs_type_flag;
137 static smallint fs_type_negated;
139 static smallint noexecute;
140 static smallint serialize;
141 static smallint skip_root;
142 /* static smallint like_mount; */
143 static smallint parallel_root;
144 static smallint force_all_parallel;
146 #if DO_PROGRESS_INDICATOR
147 static smallint progress;
148 static int progress_fd;
151 static int num_running;
152 static int max_running;
154 static struct fs_info *filesys_info;
155 static struct fs_info *filesys_last;
156 static struct fsck_instance *instance_list;
159 * Return the "base device" given a particular device; this is used to
160 * assure that we only fsck one partition on a particular drive at any
161 * one time. Otherwise, the disk heads will be seeking all over the
162 * place. If the base device cannot be determined, return NULL.
164 * The base_device() function returns an allocated string which must
167 #if ENABLE_FEATURE_DEVFS
169 * Required for the uber-silly devfs /dev/ide/host1/bus2/target3/lun3
172 static const char *const devfs_hier[] = {
173 "host", "bus", "target", "lun", NULL
177 static char *base_device(const char *device)
180 #if ENABLE_FEATURE_DEVFS
181 const char *const *hier;
185 str = xstrdup(device);
187 /* Skip over "/dev/"; if it's not present, give up */
188 cp = skip_dev_pfx(str);
193 * For md devices, we treat them all as if they were all
194 * on one disk, since we don't know how to parallelize them.
196 if (cp[0] == 'm' && cp[1] == 'd') {
201 /* Handle DAC 960 devices */
202 if (is_prefixed_with(cp, "rd/")) {
204 if (cp[0] != 'c' || !isdigit(cp[1])
205 || cp[2] != 'd' || !isdigit(cp[3]))
211 /* Now let's handle /dev/hd* and /dev/sd* devices.... */
212 if ((cp[0] == 'h' || cp[0] == 's') && cp[1] == 'd') {
214 /* If there's a single number after /dev/hd, skip it */
217 /* What follows must be an alpha char, or give up */
224 #if ENABLE_FEATURE_DEVFS
225 /* Now let's handle devfs (ugh) names */
227 if (is_prefixed_with(cp, "ide/"))
229 if (is_prefixed_with(cp, "scsi/"))
234 * Now we proceed down the expected devfs hierarchy.
235 * i.e., .../host1/bus2/target3/lun4/...
236 * If we don't find the expected token, followed by
237 * some number of digits at each level, abort.
239 for (hier = devfs_hier; *hier; hier++) {
240 cp = is_prefixed_with(cp, *hier);
243 while (*cp != '/' && *cp != '\0') {
248 //FIXME: what if *cp = '\0' now? cp++ moves past it!!!
255 /* Now handle devfs /dev/disc or /dev/disk names */
257 if (is_prefixed_with(cp, "discs/"))
259 else if (is_prefixed_with(cp, "disks/"))
263 cp = is_prefixed_with(cp, disk);
266 while (*cp != '/' && *cp != '\0') {
280 static void free_instance(struct fsck_instance *p)
284 free(p->base_device);
288 static struct fs_info *create_fs_device(const char *device, const char *mntpnt,
289 const char *type, const char *opts,
294 fs = xzalloc(sizeof(*fs));
295 fs->device = xstrdup(device);
296 fs->mountpt = xstrdup(mntpnt);
297 if (strchr(type, ','))
298 type = (char *)"auto";
299 fs->type = xstrdup(type);
300 fs->opts = xstrdup(opts ? opts : "");
301 fs->passno = passno < 0 ? 1 : passno;
303 /*fs->next = NULL; */
308 filesys_last->next = fs;
314 /* Load the filesystem database from /etc/fstab */
315 static void load_fs_info(const char *filename)
320 fstab = setmntent(filename, "r");
322 bb_perror_msg("can't read '%s'", filename);
326 // Loop through entries
327 while (getmntent_r(fstab, &mte, bb_common_bufsiz1, COMMON_BUFSIZE)) {
328 //bb_info_msg("CREATE[%s][%s][%s][%s][%d]", mte.mnt_fsname, mte.mnt_dir,
329 // mte.mnt_type, mte.mnt_opts,
331 create_fs_device(mte.mnt_fsname, mte.mnt_dir,
332 mte.mnt_type, mte.mnt_opts,
338 /* Lookup filesys in /etc/fstab and return the corresponding entry. */
339 static struct fs_info *lookup(char *filesys)
343 for (fs = filesys_info; fs; fs = fs->next) {
344 if (strcmp(filesys, fs->device) == 0
345 || (fs->mountpt && strcmp(filesys, fs->mountpt) == 0)
353 #if DO_PROGRESS_INDICATOR
354 static int progress_active(void)
356 struct fsck_instance *inst;
358 for (inst = instance_list; inst; inst = inst->next) {
359 if (inst->flags & FLAG_DONE)
361 if (inst->flags & FLAG_PROGRESS)
370 * Send a signal to all outstanding fsck child processes
372 static void kill_all_if_got_signal(void)
374 static smallint kill_sent;
376 struct fsck_instance *inst;
378 if (!bb_got_signal || kill_sent)
381 for (inst = instance_list; inst; inst = inst->next) {
382 if (inst->flags & FLAG_DONE)
384 kill(inst->pid, SIGTERM);
390 * Wait for one child process to exit; when it does, unlink it from
391 * the list of executing child processes, free, and return its exit status.
392 * If there is no exited child, return -1.
394 static int wait_one(int flags)
398 struct fsck_instance *inst, *prev;
403 /* if (noexecute) { already returned -1; } */
406 pid = waitpid(-1, &status, flags);
407 kill_all_if_got_signal();
408 if (pid == 0) /* flags == WNOHANG and no children exited */
413 if (errno == ECHILD) { /* paranoia */
414 bb_error_msg("wait: no more children");
417 bb_perror_msg("wait");
421 inst = instance_list;
423 if (inst->pid == pid)
431 if (WIFEXITED(status))
432 status = WEXITSTATUS(status);
433 else if (WIFSIGNALED(status)) {
434 sig = WTERMSIG(status);
435 status = EXIT_UNCORRECTED;
437 printf("Warning: %s %s terminated "
439 inst->prog, inst->device, sig);
443 printf("%s %s: status is %x, should never happen\n",
444 inst->prog, inst->device, status);
448 #if DO_PROGRESS_INDICATOR
449 if (progress && (inst->flags & FLAG_PROGRESS) && !progress_active()) {
450 struct fsck_instance *inst2;
451 for (inst2 = instance_list; inst2; inst2 = inst2->next) {
452 if (inst2->flags & FLAG_DONE)
454 if (strcmp(inst2->type, "ext2") != 0
455 && strcmp(inst2->type, "ext3") != 0
459 /* ext[23], we will send USR1
460 * (request to start displaying progress bar)
462 * If we've just started the fsck, wait a tiny
463 * bit before sending the kill, to give it
464 * time to set up the signal handler
466 if (inst2->start_time >= time(NULL) - 1)
468 kill(inst2->pid, SIGUSR1);
469 inst2->flags |= FLAG_PROGRESS;
476 prev->next = inst->next;
478 instance_list = inst->next;
480 printf("Finished with %s (exit status %d)\n",
481 inst->device, status);
489 * Wait until all executing child processes have exited; return the
490 * logical OR of all of their exit code values.
492 #define FLAG_WAIT_ALL 0
493 #define FLAG_WAIT_ATLEAST_ONE WNOHANG
494 static int wait_many(int flags)
497 int global_status = 0;
500 while ((exit_status = wait_one(wait_flags)) != -1) {
501 global_status |= exit_status;
504 return global_status;
508 * Execute a particular fsck program, and link it into the list of
509 * child processes we are waiting for.
511 static void execute(const char *type, const char *device,
512 const char *mntpt /*, int interactive */)
515 struct fsck_instance *inst;
518 args[0] = xasprintf("fsck.%s", type);
520 #if DO_PROGRESS_INDICATOR
521 if (progress && !progress_active()) {
522 if (strcmp(type, "ext2") == 0
523 || strcmp(type, "ext3") == 0
525 args[XXX] = xasprintf("-C%d", progress_fd); /* 1 */
526 inst->flags |= FLAG_PROGRESS;
531 args[num_args - 2] = (char*)device;
532 /* args[num_args - 1] = NULL; - already is */
534 if (verbose || noexecute) {
535 printf("[%s (%d) -- %s]", args[0], num_running,
536 mntpt ? mntpt : device);
537 for (i = 0; args[i]; i++)
538 printf(" %s", args[i]);
542 /* Fork and execute the correct program. */
547 bb_simple_perror_msg(args[0]);
550 #if DO_PROGRESS_INDICATOR
554 /* No child, so don't record an instance */
560 inst = xzalloc(sizeof(*inst));
562 inst->prog = args[0];
563 inst->device = xstrdup(device);
564 inst->base_device = base_device(device);
565 #if DO_PROGRESS_INDICATOR
566 inst->start_time = time(NULL);
569 /* Add to the list of running fsck's.
570 * (was adding to the end, but adding to the front is simpler...) */
571 inst->next = instance_list;
572 instance_list = inst;
576 * Run the fsck program on a particular device
578 * If the type is specified using -t, and it isn't prefixed with "no"
579 * (as in "noext2") and only one filesystem type is specified, then
580 * use that type regardless of what is specified in /etc/fstab.
582 * If the type isn't specified by the user, then use either the type
583 * specified in /etc/fstab, or "auto".
585 static void fsck_device(struct fs_info *fs /*, int interactive */)
589 if (strcmp(fs->type, "auto") != 0) {
592 bb_info_msg("using filesystem type '%s' %s",
595 && (fstype[0] != 'n' || fstype[1] != 'o') /* != "no" */
596 && !is_prefixed_with(fstype, "opts=")
597 && !is_prefixed_with(fstype, "loop")
598 && !strchr(fstype, ',')
602 bb_info_msg("using filesystem type '%s' %s",
607 bb_info_msg("using filesystem type '%s' %s",
612 execute(type, fs->device, fs->mountpt /*, interactive */);
616 * Returns TRUE if a partition on the same disk is already being
619 static int device_already_active(char *device)
621 struct fsck_instance *inst;
624 if (force_all_parallel)
628 /* Don't check a soft raid disk with any other disk */
630 && (is_prefixed_with(instance_list->device, BASE_MD)
631 || is_prefixed_with(device, BASE_MD))
637 base = base_device(device);
639 * If we don't know the base device, assume that the device is
640 * already active if there are any fsck instances running.
643 return (instance_list != NULL);
645 for (inst = instance_list; inst; inst = inst->next) {
646 if (!inst->base_device || !strcmp(base, inst->base_device)) {
657 * This function returns true if a particular option appears in a
658 * comma-delimited options list
660 static int opt_in_list(char *opt, char *optlist)
671 s = strstr(s + 1, opt);
674 /* neither "opt.." nor "xxx,opt.."? */
675 if (s != optlist && s[-1] != ',')
677 /* neither "..opt" nor "..opt,xxx"? */
678 if (s[len] != '\0' && s[len] != ',')
684 /* See if the filesystem matches the criteria given by the -t option */
685 static int fs_match(struct fs_info *fs)
687 int n, ret, checked_type;
697 cp = fs_type_list[n];
700 switch (fs_type_flag[n]) {
701 case FS_TYPE_FLAG_NORMAL:
703 if (strcmp(cp, fs->type) == 0)
706 case FS_TYPE_FLAG_NEGOPT:
707 if (opt_in_list(cp, fs->opts))
710 case FS_TYPE_FLAG_OPT:
711 if (!opt_in_list(cp, fs->opts))
717 if (checked_type == 0)
720 return (fs_type_negated ? !ret : ret);
723 /* Check if we should ignore this filesystem. */
724 static int ignore(struct fs_info *fs)
727 * If the pass number is 0, ignore it.
733 * If a specific fstype is specified, and it doesn't match,
739 /* Are we ignoring this type? */
740 if (index_in_strings(ignored_types, fs->type) >= 0)
743 /* We can and want to check this file system type. */
747 /* Check all file systems, using the /etc/fstab table. */
748 static int check_all(void)
751 int status = EXIT_OK;
752 smallint not_done_yet;
757 puts("Checking all filesystems");
760 * Do an initial scan over the filesystem; mark filesystems
761 * which should be ignored as done, and resolve any "auto"
762 * filesystem types (done as a side-effect of calling ignore()).
764 for (fs = filesys_info; fs; fs = fs->next)
766 fs->flags |= FLAG_DONE;
769 * Find and check the root filesystem.
771 if (!parallel_root) {
772 for (fs = filesys_info; fs; fs = fs->next) {
773 if (LONE_CHAR(fs->mountpt, '/')) {
774 if (!skip_root && !ignore(fs)) {
775 fsck_device(fs /*, 1*/);
776 status |= wait_many(FLAG_WAIT_ALL);
777 if (status > EXIT_NONDESTRUCT)
780 fs->flags |= FLAG_DONE;
786 * This is for the bone-headed user who has root
787 * filesystem listed twice.
788 * "Skip root" will skip _all_ root entries.
791 for (fs = filesys_info; fs; fs = fs->next)
792 if (LONE_CHAR(fs->mountpt, '/'))
793 fs->flags |= FLAG_DONE;
797 while (not_done_yet) {
801 for (fs = filesys_info; fs; fs = fs->next) {
804 if (fs->flags & FLAG_DONE)
807 * If the filesystem's pass number is higher
808 * than the current pass number, then we didn't
811 if (fs->passno > passno) {
816 * If a filesystem on a particular device has
817 * already been spawned, then we need to defer
818 * this to another pass.
820 if (device_already_active(fs->device)) {
825 * Spawn off the fsck process
827 fsck_device(fs /*, serialize*/);
828 fs->flags |= FLAG_DONE;
831 * Only do one filesystem at a time, or if we
832 * have a limit on the number of fsck's extant
833 * at one time, apply that limit.
836 || (max_running && (num_running >= max_running))
845 printf("--waiting-- (pass %d)\n", passno);
846 status |= wait_many(pass_done ? FLAG_WAIT_ALL :
847 FLAG_WAIT_ATLEAST_ONE);
850 puts("----------------------------------");
855 kill_all_if_got_signal();
856 status |= wait_many(FLAG_WAIT_ATLEAST_ONE);
861 * Deal with the fsck -t argument.
862 * Huh, for mount "-t novfat,nfs" means "neither vfat nor nfs"!
863 * Why here we require "-t novfat,nonfs" ??
865 static void compile_fs_type(char *fs_type)
872 while ((s = strchr(s, ','))) {
877 fs_type_list = xzalloc(num * sizeof(fs_type_list[0]));
878 fs_type_flag = xzalloc(num * sizeof(fs_type_flag[0]));
879 fs_type_negated = -1; /* not yet known is it negated or not */
887 if (s[0] == 'n' && s[1] == 'o') { /* "no.." */
890 } else if (s[0] == '!') {
895 if (strcmp(s, "loop") == 0)
896 /* loop is really short-hand for opts=loop */
897 goto loop_special_case;
898 if (is_prefixed_with(s, "opts=")) {
901 fs_type_flag[num] = negate ? FS_TYPE_FLAG_NEGOPT : FS_TYPE_FLAG_OPT;
903 if (fs_type_negated == -1)
904 fs_type_negated = negate;
905 if (fs_type_negated != negate)
906 bb_error_msg_and_die(
907 "either all or none of the filesystem types passed to -t must be prefixed "
910 comma = strchr(s, ',');
911 fs_type_list[num++] = comma ? xstrndup(s, comma-s) : xstrdup(s);
918 static char **new_args(void)
920 args = xrealloc_vector(args, 2, num_args);
921 return &args[num_args++];
924 int fsck_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
925 int fsck_main(int argc UNUSED_PARAM, char **argv)
934 smallint opts_for_fsck;
938 /* we want wait() to be interruptible */
939 signal_no_SA_RESTART_empty_mask(SIGINT, record_signo);
940 signal_no_SA_RESTART_empty_mask(SIGTERM, record_signo);
942 setbuf(stdout, NULL);
944 opts_for_fsck = doall = notitle = 0;
947 new_args(); /* args[0] = NULL, will be replaced by fsck.<type> */
948 /* instance_list = NULL; - in bss, so already zeroed */
956 /* "/dev/blk" or "/path" or "UUID=xxx" or "LABEL=xxx" */
957 if ((arg[0] == '/' && !opts_for_fsck) || strchr(arg, '=')) {
958 // FIXME: must check that arg is a blkdev, or resolve
959 // "/path", "UUID=xxx" or "LABEL=xxx" into block device name
960 // ("UUID=xxx"/"LABEL=xxx" can probably shifted to fsck.auto duties)
961 devices = xrealloc_vector(devices, 2, num_devices);
962 devices[num_devices++] = arg;
966 if (arg[0] != '-' || opts_for_fsck) {
971 if (LONE_CHAR(arg + 1, '-')) { /* "--" ? */
978 for (j = 1; arg[j]; j++) {
983 #if DO_PROGRESS_INDICATOR
986 if (arg[++j]) { /* -Cn */
987 progress_fd = xatoi_positive(&arg[j]);
993 progress_fd = xatoi_positive(*argv);
1026 fstype = xstrdup(tmp);
1027 compile_fs_type(fstype);
1034 /* one extra for '\0' */
1035 options = xrealloc(options, optpos + 2);
1036 options[optpos] = arg[j];
1043 options[optpos + 1] = '\0';
1044 *new_args() = options;
1047 if (getenv("FSCK_FORCE_ALL_PARALLEL"))
1048 force_all_parallel = 1;
1049 tmp = getenv("FSCK_MAX_INST");
1051 max_running = xatoi(tmp);
1052 new_args(); /* args[num_args - 2] will be replaced by <device> */
1053 new_args(); /* args[num_args - 1] is the last, NULL element */
1056 puts("fsck (busybox "BB_VER", "BB_BT")");
1058 /* Even plain "fsck /dev/hda1" needs fstab to get fs type,
1059 * so we are scanning it anyway */
1060 fstab = getenv("FSTAB_FILE");
1062 fstab = "/etc/fstab";
1063 load_fs_info(fstab);
1065 /*interactive = (num_devices == 1) | serialize;*/
1067 if (num_devices == 0)
1068 /*interactive =*/ serialize = doall = 1;
1073 for (i = 0; i < num_devices; i++) {
1074 if (bb_got_signal) {
1075 kill_all_if_got_signal();
1079 fs = lookup(devices[i]);
1081 fs = create_fs_device(devices[i], "", "auto", NULL, -1);
1082 fsck_device(fs /*, interactive */);
1085 || (max_running && (num_running >= max_running))
1087 int exit_status = wait_one(0);
1088 if (exit_status >= 0)
1089 status |= exit_status;
1091 puts("----------------------------------");
1094 status |= wait_many(FLAG_WAIT_ALL);