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