src/fsck/fsck.c

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2 /***
   3   Copyright © 2014 Holger Hans Peter Freyther
   4 ***/
   5
   6 #include <errno.h>
   7 #include <fcntl.h>
   8 #include <stdbool.h>
   9 #include <sys/file.h>
  10 #include <sys/prctl.h>
  11 #include <sys/stat.h>
  12 #include <unistd.h>
  13
  14 #include "sd-bus.h"
  15 #include "sd-device.h"
  16
  17 #include "alloc-util.h"
  18 #include "bus-common-errors.h"
  19 #include "bus-error.h"
  20 #include "bus-locator.h"
  21 #include "bus-util.h"
  22 #include "device-util.h"
  23 #include "fd-util.h"
  24 #include "fs-util.h"
  25 #include "fsck-util.h"
  26 #include "main-func.h"
  27 #include "parse-util.h"
  28 #include "path-util.h"
  29 #include "proc-cmdline.h"
  30 #include "process-util.h"
  31 #include "signal-util.h"
  32 #include "socket-util.h"
  33 #include "special.h"
  34 #include "stdio-util.h"
  35
  36 static bool arg_skip = false;
  37 static bool arg_force = false;
  38 static bool arg_show_progress = false;
  39 static const char *arg_repair = "-a";
  40
  41 static void start_target(const char *target, const char *mode) {
  42         _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
  43         _cleanup_(sd_bus_flush_close_unrefp) sd_bus *bus = NULL;
  44         int r;
  45
  46         assert(target);
  47
  48         r = bus_connect_system_systemd(&bus);
  49         if (r < 0) {
  50                 log_error_errno(r, "Failed to get D-Bus connection: %m");
  51                 return;
  52         }
  53
  54         log_info("Requesting %s/start/%s", target, mode);
  55
  56         /* Start this unit only if we can replace basic.target with it */
  57         r = bus_call_method(bus, bus_systemd_mgr, "StartUnitReplace", &error, NULL, "sss", "basic.target", target, mode);
  58
  59         /* Don't print a warning if we aren't called during startup */
  60         if (r < 0 && !sd_bus_error_has_name(&error, BUS_ERROR_NO_SUCH_JOB))
  61                 log_error("Failed to start unit: %s", bus_error_message(&error, r));
  62 }
  63
  64 static int parse_proc_cmdline_item(const char *key, const char *value, void *data) {
  65         int r;
  66
  67         assert(key);
  68
  69         if (streq(key, "fsck.mode")) {
  70
  71                 if (proc_cmdline_value_missing(key, value))
  72                         return 0;
  73
  74                 if (streq(value, "auto"))
  75                         arg_force = arg_skip = false;
  76                 else if (streq(value, "force"))
  77                         arg_force = true;
  78                 else if (streq(value, "skip"))
  79                         arg_skip = true;
  80                 else
  81                         log_warning("Invalid fsck.mode= parameter '%s'. Ignoring.", value);
  82
  83         } else if (streq(key, "fsck.repair")) {
  84
  85                 if (proc_cmdline_value_missing(key, value))
  86                         return 0;
  87
  88                 if (streq(value, "preen"))
  89                         arg_repair = "-a";
  90                 else {
  91                         r = parse_boolean(value);
  92                         if (r > 0)
  93                                 arg_repair = "-y";
  94                         else if (r == 0)
  95                                 arg_repair = "-n";
  96                         else
  97                                 log_warning("Invalid fsck.repair= parameter '%s'. Ignoring.", value);
  98                 }
  99         }
 100
 101 #if HAVE_SYSV_COMPAT
 102         else if (streq(key, "fastboot") && !value) {
 103                 log_warning("Please pass 'fsck.mode=skip' rather than 'fastboot' on the kernel command line.");
 104                 arg_skip = true;
 105
 106         } else if (streq(key, "forcefsck") && !value) {
 107                 log_warning("Please pass 'fsck.mode=force' rather than 'forcefsck' on the kernel command line.");
 108                 arg_force = true;
 109         }
 110 #endif
 111
 112         return 0;
 113 }
 114
 115 static void test_files(void) {
 116
 117 #if HAVE_SYSV_COMPAT
 118         if (access("/fastboot", F_OK) >= 0) {
 119                 log_error("Please pass 'fsck.mode=skip' on the kernel command line rather than creating /fastboot on the root file system.");
 120                 arg_skip = true;
 121         }
 122
 123         if (access("/forcefsck", F_OK) >= 0) {
 124                 log_error("Please pass 'fsck.mode=force' on the kernel command line rather than creating /forcefsck on the root file system.");
 125                 arg_force = true;
 126         }
 127 #endif
 128
 129         arg_show_progress = access("/run/systemd/show-status", F_OK) >= 0;
 130 }
 131
 132 static double percent(int pass, unsigned long cur, unsigned long max) {
 133         /* Values stolen from e2fsck */
 134
 135         static const int pass_table[] = {
 136                 0, 70, 90, 92, 95, 100
 137         };
 138
 139         if (pass <= 0)
 140                 return 0.0;
 141
 142         if ((unsigned) pass >= ELEMENTSOF(pass_table) || max == 0)
 143                 return 100.0;
 144
 145         return (double) pass_table[pass-1] +
 146                 ((double) pass_table[pass] - (double) pass_table[pass-1]) *
 147                 (double) cur / (double) max;
 148 }
 149
 150 static int process_progress(int fd, FILE* console) {
 151         _cleanup_fclose_ FILE *f = NULL;
 152         usec_t last = 0;
 153         bool locked = false;
 154         int clear = 0, r;
 155
 156         /* No progress pipe to process? Then we are a NOP. */
 157         if (fd < 0)
 158                 return 0;
 159
 160         f = fdopen(fd, "r");
 161         if (!f) {
 162                 safe_close(fd);
 163                 return log_debug_errno(errno, "Failed to use pipe: %m");
 164         }
 165
 166         for (;;) {
 167                 int pass;
 168                 unsigned long cur, max;
 169                 _cleanup_free_ char *device = NULL;
 170                 double p;
 171                 usec_t t;
 172
 173                 if (fscanf(f, "%i %lu %lu %ms", &pass, &cur, &max, &device) != 4) {
 174
 175                         if (ferror(f))
 176                                 r = log_warning_errno(errno, "Failed to read from progress pipe: %m");
 177                         else if (feof(f))
 178                                 r = 0;
 179                         else
 180                                 r = log_warning_errno(SYNTHETIC_ERRNO(errno), "Failed to parse progress pipe data");
 181
 182                         break;
 183                 }
 184
 185                 /* Only show one progress counter at max */
 186                 if (!locked) {
 187                         if (flock(fileno(console), LOCK_EX|LOCK_NB) < 0)
 188                                 continue;
 189
 190                         locked = true;
 191                 }
 192
 193                 /* Only update once every 50ms */
 194                 t = now(CLOCK_MONOTONIC);
 195                 if (last + 50 * USEC_PER_MSEC > t)
 196                         continue;
 197
 198                 last = t;
 199
 200                 p = percent(pass, cur, max);
 201                 r = fprintf(console, "\r%s: fsck %3.1f%% complete...\r", device, p);
 202                 if (r < 0)
 203                         return -EIO; /* No point in continuing if something happened to our output stream */
 204
 205                 fflush(console);
 206                 clear = MAX(clear, r);
 207         }
 208
 209         if (clear > 0) {
 210                 fputc('\r', console);
 211                 for (int j = 0; j < clear; j++)
 212                         fputc(' ', console);
 213                 fputc('\r', console);
 214                 fflush(console);
 215         }
 216
 217         return r;
 218 }
 219
 220 static int fsck_progress_socket(void) {
 221         _cleanup_close_ int fd = -EBADF;
 222         int r;
 223
 224         fd = socket(AF_UNIX, SOCK_STREAM, 0);
 225         if (fd < 0)
 226                 return log_warning_errno(errno, "socket(): %m");
 227
 228         r = connect_unix_path(fd, AT_FDCWD, "/run/systemd/fsck.progress");
 229         if (r < 0)
 230                 return log_full_errno(IN_SET(r, -ECONNREFUSED, -ENOENT) ? LOG_DEBUG : LOG_WARNING,
 231                                       r, "Failed to connect to progress socket, ignoring: %m");
 232
 233         return TAKE_FD(fd);
 234 }
 235
 236 static int run(int argc, char *argv[]) {
 237         _cleanup_close_pair_ int progress_pipe[2] = EBADF_PAIR;
 238         _cleanup_(sd_device_unrefp) sd_device *dev = NULL;
 239         _cleanup_free_ char *dpath = NULL;
 240         _cleanup_fclose_ FILE *console = NULL;
 241         const char *device, *type;
 242         bool root_directory;
 243         struct stat st;
 244         int r, exit_status;
 245         pid_t pid;
 246
 247         log_setup();
 248
 249         if (argc > 2)
 250                 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
 251                                        "This program expects one or no arguments.");
 252
 253         umask(0022);
 254
 255         r = proc_cmdline_parse(parse_proc_cmdline_item, NULL, PROC_CMDLINE_STRIP_RD_PREFIX);
 256         if (r < 0)
 257                 log_warning_errno(r, "Failed to parse kernel command line, ignoring: %m");
 258
 259         test_files();
 260
 261         if (!arg_force && arg_skip)
 262                 return 0;
 263
 264         if (argc > 1) {
 265                 dpath = strdup(argv[1]);
 266                 if (!dpath)
 267                         return log_oom();
 268
 269                 device = dpath;
 270
 271                 if (stat(device, &st) < 0)
 272                         return log_error_errno(errno, "Failed to stat %s: %m", device);
 273
 274                 if (!S_ISBLK(st.st_mode))
 275                         return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
 276                                                "%s is not a block device.",
 277                                                device);
 278
 279                 r = sd_device_new_from_stat_rdev(&dev, &st);
 280                 if (r < 0)
 281                         return log_error_errno(r, "Failed to detect device %s: %m", device);
 282
 283                 root_directory = false;
 284         } else {
 285                 struct timespec times[2];
 286
 287                 /* Find root device */
 288
 289                 if (stat("/", &st) < 0)
 290                         return log_error_errno(errno, "Failed to stat() the root directory: %m");
 291
 292                 /* Virtual root devices don't need an fsck */
 293                 if (major(st.st_dev) == 0) {
 294                         log_debug("Root directory is virtual or btrfs, skipping check.");
 295                         return 0;
 296                 }
 297
 298                 /* check if we are already writable */
 299                 times[0] = st.st_atim;
 300                 times[1] = st.st_mtim;
 301
 302                 if (utimensat(AT_FDCWD, "/", times, 0) == 0) {
 303                         log_info("Root directory is writable, skipping check.");
 304                         return 0;
 305                 }
 306
 307                 r = sd_device_new_from_devnum(&dev, 'b', st.st_dev);
 308                 if (r < 0)
 309                         return log_error_errno(r, "Failed to detect root device: %m");
 310
 311                 r = sd_device_get_devname(dev, &device);
 312                 if (r < 0)
 313                         return log_device_error_errno(dev, r, "Failed to detect device node of root directory: %m");
 314
 315                 root_directory = true;
 316         }
 317
 318         if (sd_device_get_property_value(dev, "ID_FS_TYPE", &type) >= 0) {
 319                 r = fsck_exists_for_fstype(type);
 320                 if (r < 0)
 321                         log_device_warning_errno(dev, r, "Couldn't detect if fsck.%s may be used, proceeding: %m", type);
 322                 else if (r == 0) {
 323                         log_device_info(dev, "fsck.%s doesn't exist, not checking file system.", type);
 324                         return 0;
 325                 }
 326         } else {
 327                 r = fsck_exists();
 328                 if (r < 0)
 329                         log_device_warning_errno(dev, r, "Couldn't detect if the fsck command may be used, proceeding: %m");
 330                 else if (r == 0) {
 331                         log_device_info(dev, "The fsck command does not exist, not checking file system.");
 332                         return 0;
 333                 }
 334         }
 335
 336         console = fopen("/dev/console", "we");
 337         if (console &&
 338             arg_show_progress &&
 339             pipe(progress_pipe) < 0)
 340                 return log_error_errno(errno, "pipe(): %m");
 341
 342         r = safe_fork("(fsck)", FORK_RESET_SIGNALS|FORK_DEATHSIG_SIGTERM|FORK_LOG|FORK_RLIMIT_NOFILE_SAFE, &pid);
 343         if (r < 0)
 344                 return r;
 345         if (r == 0) {
 346                 char dash_c[STRLEN("-C") + DECIMAL_STR_MAX(int) + 1];
 347                 int progress_socket = -1;
 348                 const char *cmdline[9];
 349                 int i = 0;
 350
 351                 /* Child */
 352
 353                 /* Close the reading side of the progress pipe */
 354                 progress_pipe[0] = safe_close(progress_pipe[0]);
 355
 356                 /* Try to connect to a progress management daemon, if there is one */
 357                 progress_socket = fsck_progress_socket();
 358                 if (progress_socket >= 0) {
 359                         /* If this worked we close the progress pipe early, and just use the socket */
 360                         progress_pipe[1] = safe_close(progress_pipe[1]);
 361                         xsprintf(dash_c, "-C%i", progress_socket);
 362                 } else if (progress_pipe[1] >= 0) {
 363                         /* Otherwise if we have the progress pipe to our own local handle, we use it */
 364                         xsprintf(dash_c, "-C%i", progress_pipe[1]);
 365                 } else
 366                         dash_c[0] = 0;
 367
 368                 cmdline[i++] = "fsck";
 369                 cmdline[i++] =  arg_repair;
 370                 cmdline[i++] = "-T";
 371
 372                 /*
 373                  * Since util-linux v2.25 fsck uses /run/fsck/<diskname>.lock files.
 374                  * The previous versions use flock for the device and conflict with
 375                  * udevd, see https://bugs.freedesktop.org/show_bug.cgi?id=79576#c5
 376                  */
 377                 cmdline[i++] = "-l";
 378
 379                 if (!root_directory)
 380                         cmdline[i++] = "-M";
 381
 382                 if (arg_force)
 383                         cmdline[i++] = "-f";
 384
 385                 if (!isempty(dash_c))
 386                         cmdline[i++] = dash_c;
 387
 388                 cmdline[i++] = device;
 389                 cmdline[i++] = NULL;
 390
 391                 execvp(cmdline[0], (char**) cmdline);
 392                 _exit(FSCK_OPERATIONAL_ERROR);
 393         }
 394
 395         if (console) {
 396                 progress_pipe[1] = safe_close(progress_pipe[1]);
 397                 (void) process_progress(TAKE_FD(progress_pipe[0]), console);
 398         }
 399
 400         exit_status = wait_for_terminate_and_check("fsck", pid, WAIT_LOG_ABNORMAL);
 401         if (exit_status < 0)
 402                 return exit_status;
 403         if ((exit_status & ~FSCK_ERROR_CORRECTED) != FSCK_SUCCESS) {
 404                 log_error("fsck failed with exit status %i.", exit_status);
 405
 406                 if ((exit_status & FSCK_SYSTEM_SHOULD_REBOOT) && root_directory) {
 407                         /* System should be rebooted. */
 408                         start_target(SPECIAL_REBOOT_TARGET, "replace-irreversibly");
 409                         return -EINVAL;
 410                 } else if (!(exit_status & (FSCK_SYSTEM_SHOULD_REBOOT | FSCK_ERRORS_LEFT_UNCORRECTED)))
 411                         log_warning("Ignoring error.");
 412         }
 413
 414         if (exit_status & FSCK_ERROR_CORRECTED)
 415                 (void) touch("/run/systemd/quotacheck");
 416
 417         return !!(exit_status & (FSCK_SYSTEM_SHOULD_REBOOT | FSCK_ERRORS_LEFT_UNCORRECTED));
 418 }
 419
 420 DEFINE_MAIN_FUNCTION_WITH_POSITIVE_FAILURE(run);