src/sleep/sleep.c

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2 /***
   3   Copyright © 2010-2017 Canonical
   4   Copyright © 2018 Dell Inc.
   5 ***/
   6
   7 #include <errno.h>
   8 #include <fcntl.h>
   9 #include <getopt.h>
  10 #include <linux/fiemap.h>
  11 #include <poll.h>
  12 #include <sys/stat.h>
  13 #include <sys/types.h>
  14 #include <sys/timerfd.h>
  15 #include <unistd.h>
  16
  17 #include "sd-bus.h"
  18 #include "sd-messages.h"
  19
  20 #include "btrfs-util.h"
  21 #include "build.h"
  22 #include "bus-error.h"
  23 #include "bus-locator.h"
  24 #include "bus-util.h"
  25 #include "constants.h"
  26 #include "devnum-util.h"
  27 #include "exec-util.h"
  28 #include "fd-util.h"
  29 #include "fileio.h"
  30 #include "format-util.h"
  31 #include "io-util.h"
  32 #include "log.h"
  33 #include "main-func.h"
  34 #include "parse-util.h"
  35 #include "pretty-print.h"
  36 #include "sleep-config.h"
  37 #include "special.h"
  38 #include "stdio-util.h"
  39 #include "string-util.h"
  40 #include "strv.h"
  41 #include "time-util.h"
  42
  43 #define DEFAULT_HIBERNATE_DELAY_USEC_NO_BATTERY (2 * USEC_PER_HOUR)
  44
  45 static SleepOperation arg_operation = _SLEEP_OPERATION_INVALID;
  46
  47 static int write_hibernate_location_info(const HibernateLocation *hibernate_location) {
  48         char offset_str[DECIMAL_STR_MAX(uint64_t)];
  49         const char *resume_str;
  50         int r;
  51
  52         assert(hibernate_location);
  53         assert(hibernate_location->swap);
  54
  55         resume_str = FORMAT_DEVNUM(hibernate_location->devno);
  56
  57         r = write_string_file("/sys/power/resume", resume_str, WRITE_STRING_FILE_DISABLE_BUFFER);
  58         if (r < 0)
  59                 return log_debug_errno(r, "Failed to write partition device to /sys/power/resume for '%s': '%s': %m",
  60                                        hibernate_location->swap->device, resume_str);
  61
  62         log_debug("Wrote resume= value for %s to /sys/power/resume: %s", hibernate_location->swap->device, resume_str);
  63
  64         /* if it's a swap partition, we're done */
  65         if (streq(hibernate_location->swap->type, "partition"))
  66                 return r;
  67
  68         if (!streq(hibernate_location->swap->type, "file"))
  69                 return log_debug_errno(SYNTHETIC_ERRNO(EINVAL),
  70                                        "Invalid hibernate type: %s", hibernate_location->swap->type);
  71
  72         /* Only available in 4.17+ */
  73         if (hibernate_location->offset > 0 && access("/sys/power/resume_offset", W_OK) < 0) {
  74                 if (errno == ENOENT) {
  75                         log_debug("Kernel too old, can't configure resume_offset for %s, ignoring: %" PRIu64,
  76                                   hibernate_location->swap->device, hibernate_location->offset);
  77                         return 0;
  78                 }
  79
  80                 return log_debug_errno(errno, "/sys/power/resume_offset not writable: %m");
  81         }
  82
  83         xsprintf(offset_str, "%" PRIu64, hibernate_location->offset);
  84         r = write_string_file("/sys/power/resume_offset", offset_str, WRITE_STRING_FILE_DISABLE_BUFFER);
  85         if (r < 0)
  86                 return log_debug_errno(r, "Failed to write swap file offset to /sys/power/resume_offset for '%s': '%s': %m",
  87                                        hibernate_location->swap->device, offset_str);
  88
  89         log_debug("Wrote resume_offset= value for %s to /sys/power/resume_offset: %s", hibernate_location->swap->device, offset_str);
  90
  91         return 0;
  92 }
  93
  94 static int write_mode(char **modes) {
  95         int r = 0;
  96
  97         STRV_FOREACH(mode, modes) {
  98                 int k;
  99
 100                 k = write_string_file("/sys/power/disk", *mode, WRITE_STRING_FILE_DISABLE_BUFFER);
 101                 if (k >= 0)
 102                         return 0;
 103
 104                 log_debug_errno(k, "Failed to write '%s' to /sys/power/disk: %m", *mode);
 105                 if (r >= 0)
 106                         r = k;
 107         }
 108
 109         return r;
 110 }
 111
 112 static int write_state(FILE **f, char **states) {
 113         int r = 0;
 114
 115         assert(f);
 116         assert(*f);
 117
 118         STRV_FOREACH(state, states) {
 119                 int k;
 120
 121                 k = write_string_stream(*f, *state, WRITE_STRING_FILE_DISABLE_BUFFER);
 122                 if (k >= 0)
 123                         return 0;
 124                 log_debug_errno(k, "Failed to write '%s' to /sys/power/state: %m", *state);
 125                 if (r >= 0)
 126                         r = k;
 127
 128                 fclose(*f);
 129                 *f = fopen("/sys/power/state", "we");
 130                 if (!*f)
 131                         return -errno;
 132         }
 133
 134         return r;
 135 }
 136
 137 static int lock_all_homes(void) {
 138         _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
 139         _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = NULL;
 140         _cleanup_(sd_bus_flush_close_unrefp) sd_bus *bus = NULL;
 141         int r;
 142
 143         /* Let's synchronously lock all home directories managed by homed that have been marked for it. This
 144          * way the key material required to access these volumes is hopefully removed from memory. */
 145
 146         r = sd_bus_open_system(&bus);
 147         if (r < 0)
 148                 return log_warning_errno(r, "Failed to connect to system bus, ignoring: %m");
 149
 150         r = bus_message_new_method_call(bus, &m, bus_home_mgr, "LockAllHomes");
 151         if (r < 0)
 152                 return bus_log_create_error(r);
 153
 154         /* If homed is not running it can't have any home directories active either. */
 155         r = sd_bus_message_set_auto_start(m, false);
 156         if (r < 0)
 157                 return log_error_errno(r, "Failed to disable auto-start of LockAllHomes() message: %m");
 158
 159         r = sd_bus_call(bus, m, DEFAULT_TIMEOUT_USEC, &error, NULL);
 160         if (r < 0) {
 161                 if (!bus_error_is_unknown_service(&error))
 162                         return log_error_errno(r, "Failed to lock home directories: %s", bus_error_message(&error, r));
 163
 164                 log_debug("systemd-homed is not running, locking of home directories skipped.");
 165         } else
 166                 log_debug("Successfully requested locking of all home directories.");
 167         return 0;
 168 }
 169
 170 static int execute(
 171                 const SleepConfig *sleep_config,
 172                 SleepOperation operation,
 173                 const char *action) {
 174
 175         char *arguments[] = {
 176                 NULL,
 177                 (char*) "pre",
 178                 /* NB: we use 'arg_operation' instead of 'operation' here, as we want to communicate the overall
 179                  * operation here, not the specific one, in case of s2h. */
 180                 (char*) sleep_operation_to_string(arg_operation),
 181                 NULL
 182         };
 183         static const char* const dirs[] = {
 184                 SYSTEM_SLEEP_PATH,
 185                 NULL
 186         };
 187
 188         _cleanup_(hibernate_location_freep) HibernateLocation *hibernate_location = NULL;
 189         _cleanup_fclose_ FILE *f = NULL;
 190         char **modes, **states;
 191         int r;
 192
 193         assert(sleep_config);
 194         assert(operation >= 0);
 195         assert(operation < _SLEEP_OPERATION_MAX);
 196         assert(operation != SLEEP_SUSPEND_THEN_HIBERNATE); /* Handled by execute_s2h() instead */
 197
 198         states = sleep_config->states[operation];
 199         modes = sleep_config->modes[operation];
 200
 201         if (strv_isempty(states))
 202                 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
 203                                        "No sleep states configured for sleep operation %s, can't sleep.",
 204                                        sleep_operation_to_string(operation));
 205
 206         /* This file is opened first, so that if we hit an error,
 207          * we can abort before modifying any state. */
 208         f = fopen("/sys/power/state", "we");
 209         if (!f)
 210                 return log_error_errno(errno, "Failed to open /sys/power/state: %m");
 211
 212         setvbuf(f, NULL, _IONBF, 0);
 213
 214         /* Configure hibernation settings if we are supposed to hibernate */
 215         if (!strv_isempty(modes)) {
 216                 r = find_hibernate_location(&hibernate_location);
 217                 if (r < 0)
 218                         return log_error_errno(r, "Failed to find location to hibernate to: %m");
 219                 if (r == 0) { /* 0 means: no hibernation location was configured in the kernel so far, let's
 220                                * do it ourselves then. > 0 means: kernel already had a configured hibernation
 221                                * location which we shouldn't touch. */
 222                         r = write_hibernate_location_info(hibernate_location);
 223                         if (r < 0)
 224                                 return log_error_errno(r, "Failed to prepare for hibernation: %m");
 225                 }
 226
 227                 r = write_mode(modes);
 228                 if (r < 0)
 229                         return log_error_errno(r, "Failed to write mode to /sys/power/disk: %m");
 230         }
 231
 232         /* Pass an action string to the call-outs. This is mostly our operation string, except if the
 233          * hibernate step of s-t-h fails, in which case we communicate that with a separate action. */
 234         if (!action)
 235                 action = sleep_operation_to_string(operation);
 236
 237         r = setenv("SYSTEMD_SLEEP_ACTION", action, 1);
 238         if (r != 0)
 239                 log_warning_errno(errno, "Error setting SYSTEMD_SLEEP_ACTION=%s, ignoring: %m", action);
 240
 241         (void) execute_directories(dirs, DEFAULT_TIMEOUT_USEC, NULL, NULL, arguments, NULL, EXEC_DIR_PARALLEL | EXEC_DIR_IGNORE_ERRORS);
 242         (void) lock_all_homes();
 243
 244         log_struct(LOG_INFO,
 245                    "MESSAGE_ID=" SD_MESSAGE_SLEEP_START_STR,
 246                    LOG_MESSAGE("Entering sleep state '%s'...", sleep_operation_to_string(operation)),
 247                    "SLEEP=%s", sleep_operation_to_string(arg_operation));
 248
 249         r = write_state(&f, states);
 250         if (r < 0)
 251                 log_struct_errno(LOG_ERR, r,
 252                                  "MESSAGE_ID=" SD_MESSAGE_SLEEP_STOP_STR,
 253                                  LOG_MESSAGE("Failed to put system to sleep. System resumed again: %m"),
 254                                  "SLEEP=%s", sleep_operation_to_string(arg_operation));
 255         else
 256                 log_struct(LOG_INFO,
 257                            "MESSAGE_ID=" SD_MESSAGE_SLEEP_STOP_STR,
 258                            LOG_MESSAGE("System returned from sleep state."),
 259                            "SLEEP=%s", sleep_operation_to_string(arg_operation));
 260
 261         arguments[1] = (char*) "post";
 262         (void) execute_directories(dirs, DEFAULT_TIMEOUT_USEC, NULL, NULL, arguments, NULL, EXEC_DIR_PARALLEL | EXEC_DIR_IGNORE_ERRORS);
 263
 264         return r;
 265 }
 266
 267 static int custom_timer_suspend(const SleepConfig *sleep_config) {
 268         usec_t hibernate_timestamp;
 269         int r;
 270
 271         assert(sleep_config);
 272
 273         hibernate_timestamp = usec_add(now(CLOCK_BOOTTIME), sleep_config->hibernate_delay_usec);
 274
 275         while (battery_is_discharging_and_low() == 0) {
 276                 _cleanup_hashmap_free_ Hashmap *last_capacity = NULL, *current_capacity = NULL;
 277                 _cleanup_close_ int tfd = -EBADF;
 278                 struct itimerspec ts = {};
 279                 usec_t suspend_interval;
 280                 bool woken_by_timer;
 281
 282                 tfd = timerfd_create(CLOCK_BOOTTIME_ALARM, TFD_NONBLOCK|TFD_CLOEXEC);
 283                 if (tfd < 0)
 284                         return log_error_errno(errno, "Error creating timerfd: %m");
 285
 286                 /* Store current battery capacity before suspension */
 287                 r = fetch_batteries_capacity_by_name(&last_capacity);
 288                 if (r < 0)
 289                         return log_error_errno(r, "Error fetching battery capacity percentage: %m");
 290
 291                 if (hashmap_isempty(last_capacity))
 292                         /* In case of no battery, system suspend interval will be set to HibernateDelaySec= or 2 hours. */
 293                         suspend_interval = timestamp_is_set(hibernate_timestamp)
 294                                            ? sleep_config->hibernate_delay_usec : DEFAULT_HIBERNATE_DELAY_USEC_NO_BATTERY;
 295                 else {
 296                         r = get_total_suspend_interval(last_capacity, &suspend_interval);
 297                         if (r < 0) {
 298                                 log_debug_errno(r, "Failed to estimate suspend interval using previous discharge rate, ignoring: %m");
 299                                 /* In case of any errors, especially when we do not know the battery
 300                                  * discharging rate, system suspend interval will be set to
 301                                  * SuspendEstimationSec=. */
 302                                 suspend_interval = sleep_config->suspend_estimation_usec;
 303                         }
 304                 }
 305
 306                 /* Do not suspend more than HibernateDelaySec= */
 307                 usec_t before_timestamp = now(CLOCK_BOOTTIME);
 308                 suspend_interval = MIN(suspend_interval, usec_sub_unsigned(hibernate_timestamp, before_timestamp));
 309                 if (suspend_interval <= 0)
 310                         break; /* system should hibernate */
 311
 312                 log_debug("Set timerfd wake alarm for %s", FORMAT_TIMESPAN(suspend_interval, USEC_PER_SEC));
 313                 /* Wake alarm for system with or without battery to hibernate or estimate discharge rate whichever is applicable */
 314                 timespec_store(&ts.it_value, suspend_interval);
 315
 316                 if (timerfd_settime(tfd, 0, &ts, NULL) < 0)
 317                         return log_error_errno(errno, "Error setting battery estimate timer: %m");
 318
 319                 r = execute(sleep_config, SLEEP_SUSPEND, NULL);
 320                 if (r < 0)
 321                         return r;
 322
 323                 r = fd_wait_for_event(tfd, POLLIN, 0);
 324                 if (r < 0)
 325                         return log_error_errno(r, "Error polling timerfd: %m");
 326                 /* Store fd_wait status */
 327                 woken_by_timer = FLAGS_SET(r, POLLIN);
 328
 329                 r = fetch_batteries_capacity_by_name(&current_capacity);
 330                 if (r < 0 || hashmap_isempty(current_capacity)) {
 331                         /* In case of no battery or error while getting charge level, no need to measure
 332                          * discharge rate. Instead the system should wake up if it is manual wakeup or
 333                          * hibernate if this is a timer wakeup. */
 334                         if (r < 0)
 335                                 log_debug_errno(r, "Battery capacity percentage unavailable, cannot estimate discharge rate: %m");
 336                         else
 337                                 log_debug("No battery found.");
 338                         if (!woken_by_timer)
 339                                 return 0;
 340                         break;
 341                 }
 342
 343                 usec_t after_timestamp = now(CLOCK_BOOTTIME);
 344                 log_debug("Attempting to estimate battery discharge rate after wakeup from %s sleep",
 345                           FORMAT_TIMESPAN(after_timestamp - before_timestamp, USEC_PER_HOUR));
 346
 347                 if (after_timestamp != before_timestamp) {
 348                         r = estimate_battery_discharge_rate_per_hour(last_capacity, current_capacity, before_timestamp, after_timestamp);
 349                         if (r < 0)
 350                                 log_warning_errno(r, "Failed to estimate and update battery discharge rate, ignoring: %m");
 351                 } else
 352                         log_debug("System woke up too early to estimate discharge rate");
 353
 354                 if (!woken_by_timer)
 355                         /* Return as manual wakeup done. This also will return in case battery was charged during suspension */
 356                         return 0;
 357
 358                 r = check_wakeup_type();
 359                 if (r < 0)
 360                         log_debug_errno(r, "Failed to check hardware wakeup type, ignoring: %m");
 361                 if (r > 0) {
 362                         log_debug("wakeup type is APM timer");
 363                         /* system should hibernate */
 364                         break;
 365                 }
 366         }
 367
 368         return 1;
 369 }
 370
 371 /* Freeze when invoked and thaw on cleanup */
 372 static int freeze_thaw_user_slice(const char **method) {
 373         _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
 374         _cleanup_(sd_bus_flush_close_unrefp) sd_bus *bus = NULL;
 375         int r;
 376
 377         if (!method || !*method)
 378                 return 0;
 379
 380         r = bus_connect_system_systemd(&bus);
 381         if (r < 0)
 382                 return log_debug_errno(r, "Failed to open connection to systemd: %m");
 383
 384         (void) sd_bus_set_method_call_timeout(bus, FREEZE_TIMEOUT);
 385
 386         r = bus_call_method(bus, bus_systemd_mgr, *method, &error, NULL, "s", SPECIAL_USER_SLICE);
 387         if (r < 0)
 388                 return log_debug_errno(r, "Failed to execute operation: %s", bus_error_message(&error, r));
 389
 390         return 1;
 391 }
 392
 393 static int execute_s2h(const SleepConfig *sleep_config) {
 394         _unused_ _cleanup_(freeze_thaw_user_slice) const char *auto_method_thaw = "ThawUnit";
 395         int r;
 396
 397         assert(sleep_config);
 398
 399         r = freeze_thaw_user_slice(&(const char*) { "FreezeUnit" });
 400         if (r < 0)
 401                 log_debug_errno(r, "Failed to freeze unit user.slice, ignoring: %m");
 402
 403         /* Only check if we have automated battery alarms if HibernateDelaySec= is not set, as in that case
 404          * we'll busy poll for the configured interval instead */
 405         if (!timestamp_is_set(sleep_config->hibernate_delay_usec)) {
 406                 r = check_wakeup_type();
 407                 if (r < 0)
 408                         log_debug_errno(r, "Failed to check hardware wakeup type, ignoring: %m");
 409                 else {
 410                         r = battery_trip_point_alarm_exists();
 411                         if (r < 0)
 412                                 log_debug_errno(r, "Failed to check whether acpi_btp support is enabled or not, ignoring: %m");
 413                 }
 414         } else
 415                 r = 0;  /* Force fallback path */
 416
 417         if (r > 0) { /* If we have both wakeup alarms and battery trip point support, use them */
 418                 log_debug("Attempting to suspend...");
 419                 r = execute(sleep_config, SLEEP_SUSPEND, NULL);
 420                 if (r < 0)
 421                         return r;
 422
 423                 r = check_wakeup_type();
 424                 if (r < 0)
 425                         return log_debug_errno(r, "Failed to check hardware wakeup type: %m");
 426
 427                 if (r == 0)
 428                         /* For APM Timer wakeup, system should hibernate else wakeup */
 429                         return 0;
 430         } else {
 431                 r = custom_timer_suspend(sleep_config);
 432                 if (r < 0)
 433                         return log_debug_errno(r, "Suspend cycle with manual battery discharge rate estimation failed: %m");
 434                 if (r == 0)
 435                         /* manual wakeup */
 436                         return 0;
 437         }
 438         /* For above custom timer, if 1 is returned, system will directly hibernate */
 439
 440         log_debug("Attempting to hibernate");
 441         r = execute(sleep_config, SLEEP_HIBERNATE, NULL);
 442         if (r < 0) {
 443                 log_notice("Couldn't hibernate, will try to suspend again.");
 444
 445                 r = execute(sleep_config, SLEEP_SUSPEND, "suspend-after-failed-hibernate");
 446                 if (r < 0)
 447                         return r;
 448         }
 449
 450         return 0;
 451 }
 452
 453 static int help(void) {
 454         _cleanup_free_ char *link = NULL;
 455         int r;
 456
 457         r = terminal_urlify_man("systemd-suspend.service", "8", &link);
 458         if (r < 0)
 459                 return log_oom();
 460
 461         printf("%s COMMAND\n\n"
 462                "Suspend the system, hibernate the system, or both.\n\n"
 463                "  -h --help              Show this help and exit\n"
 464                "  --version              Print version string and exit\n"
 465                "\nCommands:\n"
 466                "  suspend                Suspend the system\n"
 467                "  hibernate              Hibernate the system\n"
 468                "  hybrid-sleep           Both hibernate and suspend the system\n"
 469                "  suspend-then-hibernate Initially suspend and then hibernate\n"
 470                "                         the system after a fixed period of time\n"
 471                "\nSee the %s for details.\n",
 472                program_invocation_short_name,
 473                link);
 474
 475         return 0;
 476 }
 477
 478 static int parse_argv(int argc, char *argv[]) {
 479         enum {
 480                 ARG_VERSION = 0x100,
 481         };
 482
 483         static const struct option options[] = {
 484                 { "help",         no_argument,       NULL, 'h'           },
 485                 { "version",      no_argument,       NULL, ARG_VERSION   },
 486                 {}
 487         };
 488
 489         int c;
 490
 491         assert(argc >= 0);
 492         assert(argv);
 493
 494         while ((c = getopt_long(argc, argv, "h", options, NULL)) >= 0)
 495                 switch (c) {
 496                 case 'h':
 497                         return help();
 498
 499                 case ARG_VERSION:
 500                         return version();
 501
 502                 case '?':
 503                         return -EINVAL;
 504
 505                 default:
 506                         assert_not_reached();
 507                 }
 508
 509         if (argc - optind != 1)
 510                 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
 511                                        "Usage: %s COMMAND",
 512                                        program_invocation_short_name);
 513
 514         arg_operation = sleep_operation_from_string(argv[optind]);
 515         if (arg_operation < 0)
 516                 return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Unknown command '%s'.", argv[optind]);
 517
 518         return 1 /* work to do */;
 519 }
 520
 521 static int run(int argc, char *argv[]) {
 522         _cleanup_(free_sleep_configp) SleepConfig *sleep_config = NULL;
 523         int r;
 524
 525         log_setup();
 526
 527         r = parse_argv(argc, argv);
 528         if (r <= 0)
 529                 return r;
 530
 531         r = parse_sleep_config(&sleep_config);
 532         if (r < 0)
 533                 return r;
 534
 535         if (!sleep_config->allow[arg_operation])
 536                 return log_error_errno(SYNTHETIC_ERRNO(EACCES),
 537                                        "Sleep operation \"%s\" is disabled by configuration, refusing.",
 538                                        sleep_operation_to_string(arg_operation));
 539
 540         switch (arg_operation) {
 541
 542         case SLEEP_SUSPEND_THEN_HIBERNATE:
 543                 r = execute_s2h(sleep_config);
 544                 break;
 545
 546         case SLEEP_HYBRID_SLEEP:
 547                 r = execute(sleep_config, SLEEP_HYBRID_SLEEP, NULL);
 548                 if (r < 0) {
 549                         /* If we can't hybrid sleep, then let's try to suspend at least. After all, the user
 550                          * asked us to do both: suspend + hibernate, and it's almost certainly the
 551                          * hibernation that failed, hence still do the other thing, the suspend. */
 552
 553                         log_notice("Couldn't hybrid sleep, will try to suspend instead.");
 554
 555                         r = execute(sleep_config, SLEEP_SUSPEND, "suspend-after-failed-hybrid-sleep");
 556                 }
 557
 558                 break;
 559
 560         default:
 561                 r = execute(sleep_config, arg_operation, NULL);
 562                 break;
 563         }
 564
 565         return r;
 566 }
 567
 568 DEFINE_MAIN_FUNCTION(run);