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 <poll.h>
  11 #include <sys/timerfd.h>
  12 #include <sys/types.h>
  13 #include <sys/utsname.h>
  14 #include <unistd.h>
  15
  16 #include "sd-bus.h"
  17 #include "sd-device.h"
  18 #include "sd-id128.h"
  19 #include "sd-messages.h"
  20
  21 #include "battery-capacity.h"
  22 #include "battery-util.h"
  23 #include "build.h"
  24 #include "bus-error.h"
  25 #include "bus-locator.h"
  26 #include "bus-util.h"
  27 #include "constants.h"
  28 #include "devnum-util.h"
  29 #include "efivars.h"
  30 #include "exec-util.h"
  31 #include "fd-util.h"
  32 #include "fileio.h"
  33 #include "format-util.h"
  34 #include "hibernate-util.h"
  35 #include "id128-util.h"
  36 #include "io-util.h"
  37 #include "json.h"
  38 #include "log.h"
  39 #include "main-func.h"
  40 #include "os-util.h"
  41 #include "parse-util.h"
  42 #include "pretty-print.h"
  43 #include "sleep-config.h"
  44 #include "special.h"
  45 #include "stdio-util.h"
  46 #include "string-util.h"
  47 #include "strv.h"
  48 #include "time-util.h"
  49
  50 #define DEFAULT_HIBERNATE_DELAY_USEC_NO_BATTERY (2 * USEC_PER_HOUR)
  51
  52 static SleepOperation arg_operation = _SLEEP_OPERATION_INVALID;
  53
  54 static int write_efi_hibernate_location(const HibernationDevice *hibernation_device, bool required) {
  55         int log_level = required ? LOG_ERR : LOG_DEBUG;
  56
  57 #if ENABLE_EFI
  58         _cleanup_(json_variant_unrefp) JsonVariant *v = NULL;
  59         _cleanup_free_ char *formatted = NULL, *id = NULL, *image_id = NULL,
  60                        *version_id = NULL, *image_version = NULL;
  61         _cleanup_(sd_device_unrefp) sd_device *device = NULL;
  62         const char *uuid_str;
  63         sd_id128_t uuid;
  64         struct utsname uts = {};
  65         int r, log_level_ignore = required ? LOG_WARNING : LOG_DEBUG;
  66
  67         assert(hibernation_device);
  68
  69         if (!is_efi_boot())
  70                 return log_full_errno(log_level, SYNTHETIC_ERRNO(EOPNOTSUPP),
  71                                       "Not an EFI boot, passing HibernateLocation via EFI variable is not possible.");
  72
  73         r = sd_device_new_from_devnum(&device, 'b', hibernation_device->devno);
  74         if (r < 0)
  75                 return log_full_errno(log_level, r, "Failed to create sd-device object for '%s': %m",
  76                                       hibernation_device->path);
  77
  78         r = sd_device_get_property_value(device, "ID_FS_UUID", &uuid_str);
  79         if (r < 0)
  80                 return log_full_errno(log_level, r, "Failed to get filesystem UUID for device '%s': %m",
  81                                       hibernation_device->path);
  82
  83         r = sd_id128_from_string(uuid_str, &uuid);
  84         if (r < 0)
  85                 return log_full_errno(log_level, r, "Failed to parse ID_FS_UUID '%s' for device '%s': %m",
  86                                       uuid_str, hibernation_device->path);
  87
  88         if (uname(&uts) < 0)
  89                 log_full_errno(log_level_ignore, errno, "Failed to get kernel info, ignoring: %m");
  90
  91         r = parse_os_release(NULL,
  92                              "ID", &id,
  93                              "IMAGE_ID", &image_id,
  94                              "VERSION_ID", &version_id,
  95                              "IMAGE_VERSION", &image_version);
  96         if (r < 0)
  97                 log_full_errno(log_level_ignore, r, "Failed to parse os-release, ignoring: %m");
  98
  99         r = json_build(&v, JSON_BUILD_OBJECT(
 100                                JSON_BUILD_PAIR_UUID("uuid", uuid),
 101                                JSON_BUILD_PAIR_UNSIGNED("offset", hibernation_device->offset),
 102                                JSON_BUILD_PAIR_CONDITION(!isempty(uts.release), "kernelVersion", JSON_BUILD_STRING(uts.release)),
 103                                JSON_BUILD_PAIR_CONDITION(id, "osReleaseId", JSON_BUILD_STRING(id)),
 104                                JSON_BUILD_PAIR_CONDITION(image_id, "osReleaseImageId", JSON_BUILD_STRING(image_id)),
 105                                JSON_BUILD_PAIR_CONDITION(version_id, "osReleaseVersionId", JSON_BUILD_STRING(version_id)),
 106                                JSON_BUILD_PAIR_CONDITION(image_version, "osReleaseImageVersion", JSON_BUILD_STRING(image_version))));
 107         if (r < 0)
 108                 return log_full_errno(log_level, r, "Failed to build JSON object: %m");
 109
 110         r = json_variant_format(v, 0, &formatted);
 111         if (r < 0)
 112                 return log_full_errno(log_level, r, "Failed to format JSON object: %m");
 113
 114         r = efi_set_variable_string(EFI_SYSTEMD_VARIABLE(HibernateLocation), formatted);
 115         if (r < 0)
 116                 return log_full_errno(log_level, r, "Failed to set EFI variable HibernateLocation: %m");
 117
 118         log_debug("Set EFI variable HibernateLocation to '%s'.", formatted);
 119         return 0;
 120 #else
 121         return log_full_errno(log_level, SYNTHETIC_ERRNO(EOPNOTSUPP),
 122                               "EFI support not enabled, passing HibernateLocation via EFI variable is not possible.");
 123 #endif
 124 }
 125
 126 static int write_state(int fd, char * const *states) {
 127         int r = 0;
 128
 129         assert(fd >= 0);
 130         assert(states);
 131
 132         STRV_FOREACH(state, states) {
 133                 _cleanup_fclose_ FILE *f = NULL;
 134                 int k;
 135
 136                 k = fdopen_independent(fd, "we", &f);
 137                 if (k < 0)
 138                         return RET_GATHER(r, k);
 139
 140                 k = write_string_stream(f, *state, WRITE_STRING_FILE_DISABLE_BUFFER);
 141                 if (k >= 0) {
 142                         log_debug("Using sleep state '%s'.", *state);
 143                         return 0;
 144                 }
 145
 146                 RET_GATHER(r, log_debug_errno(k, "Failed to write '%s' to /sys/power/state: %m", *state));
 147         }
 148
 149         return r;
 150 }
 151
 152 static int write_mode(char * const *modes) {
 153         int r = 0;
 154
 155         STRV_FOREACH(mode, modes) {
 156                 int k;
 157
 158                 k = write_string_file("/sys/power/disk", *mode, WRITE_STRING_FILE_DISABLE_BUFFER);
 159                 if (k >= 0) {
 160                         log_debug("Using sleep disk mode '%s'.", *mode);
 161                         return 0;
 162                 }
 163
 164                 RET_GATHER(r, log_debug_errno(k, "Failed to write '%s' to /sys/power/disk: %m", *mode));
 165         }
 166
 167         return r;
 168 }
 169
 170 static int lock_all_homes(void) {
 171         _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
 172         _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = NULL;
 173         _cleanup_(sd_bus_flush_close_unrefp) sd_bus *bus = NULL;
 174         int r;
 175
 176         /* Let's synchronously lock all home directories managed by homed that have been marked for it. This
 177          * way the key material required to access these volumes is hopefully removed from memory. */
 178
 179         r = sd_bus_open_system(&bus);
 180         if (r < 0)
 181                 return log_error_errno(r, "Failed to connect to system bus: %m");
 182
 183         r = bus_message_new_method_call(bus, &m, bus_home_mgr, "LockAllHomes");
 184         if (r < 0)
 185                 return bus_log_create_error(r);
 186
 187         /* If homed is not running it can't have any home directories active either. */
 188         r = sd_bus_message_set_auto_start(m, false);
 189         if (r < 0)
 190                 return log_error_errno(r, "Failed to disable auto-start of LockAllHomes() message: %m");
 191
 192         r = sd_bus_call(bus, m, DEFAULT_TIMEOUT_USEC, &error, NULL);
 193         if (r < 0) {
 194                 if (!bus_error_is_unknown_service(&error))
 195                         return log_error_errno(r, "Failed to lock home directories: %s", bus_error_message(&error, r));
 196
 197                 log_debug("systemd-homed is not running, locking of home directories skipped.");
 198         } else
 199                 log_debug("Successfully requested locking of all home directories.");
 200         return 0;
 201 }
 202
 203 static int execute(
 204                 const SleepConfig *sleep_config,
 205                 SleepOperation operation,
 206                 const char *action) {
 207
 208         const char *arguments[] = {
 209                 NULL,
 210                 "pre",
 211                 /* NB: we use 'arg_operation' instead of 'operation' here, as we want to communicate the overall
 212                  * operation here, not the specific one, in case of s2h. */
 213                 sleep_operation_to_string(arg_operation),
 214                 NULL
 215         };
 216         static const char* const dirs[] = {
 217                 SYSTEM_SLEEP_PATH,
 218                 NULL
 219         };
 220
 221         _cleanup_close_ int state_fd = -EBADF;
 222         int r;
 223
 224         assert(sleep_config);
 225         assert(operation >= 0);
 226         assert(operation < _SLEEP_OPERATION_CONFIG_MAX); /* Others are handled by execute_s2h() instead */
 227
 228         if (strv_isempty(sleep_config->states[operation]))
 229                 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
 230                                        "No sleep states configured for sleep operation %s, can't sleep.",
 231                                        sleep_operation_to_string(operation));
 232
 233         /* This file is opened first, so that if we hit an error, we can abort before modifying any state. */
 234         state_fd = open("/sys/power/state", O_WRONLY|O_CLOEXEC);
 235         if (state_fd < 0)
 236                 return log_error_errno(errno, "Failed to open /sys/power/state: %m");
 237
 238         /* Configure hibernation settings if we are supposed to hibernate */
 239         if (sleep_operation_is_hibernation(operation)) {
 240                 _cleanup_(hibernation_device_done) HibernationDevice hibernation_device = {};
 241                 bool resume_set;
 242
 243                 r = find_suitable_hibernation_device(&hibernation_device);
 244                 if (r < 0)
 245                         return log_error_errno(r, "Failed to find location to hibernate to: %m");
 246                 resume_set = r > 0;
 247
 248                 r = write_efi_hibernate_location(&hibernation_device, !resume_set);
 249                 if (!resume_set) {
 250                         if (r == -EOPNOTSUPP)
 251                                 return log_error_errno(r, "No valid 'resume=' option found, refusing to hibernate.");
 252                         if (r < 0)
 253                                 return r;
 254
 255                         r = write_resume_config(hibernation_device.devno, hibernation_device.offset, hibernation_device.path);
 256                         if (r < 0)
 257                                 goto fail;
 258                 }
 259
 260                 r = write_mode(sleep_config->modes[operation]);
 261                 if (r < 0) {
 262                         log_error_errno(r, "Failed to write mode to /sys/power/disk: %m");
 263                         goto fail;
 264                 }
 265         }
 266
 267         /* Pass an action string to the call-outs. This is mostly our operation string, except if the
 268          * hibernate step of s-t-h fails, in which case we communicate that with a separate action. */
 269         if (!action)
 270                 action = sleep_operation_to_string(operation);
 271
 272         if (setenv("SYSTEMD_SLEEP_ACTION", action, /* overwrite = */ 1) < 0)
 273                 log_warning_errno(errno, "Failed to set SYSTEMD_SLEEP_ACTION=%s, ignoring: %m", action);
 274
 275         (void) execute_directories(dirs, DEFAULT_TIMEOUT_USEC, NULL, NULL, (char **) arguments, NULL, EXEC_DIR_PARALLEL | EXEC_DIR_IGNORE_ERRORS);
 276         (void) lock_all_homes();
 277
 278         log_struct(LOG_INFO,
 279                    "MESSAGE_ID=" SD_MESSAGE_SLEEP_START_STR,
 280                    LOG_MESSAGE("Performing sleep operation '%s'...", sleep_operation_to_string(operation)),
 281                    "SLEEP=%s", sleep_operation_to_string(arg_operation));
 282
 283         r = write_state(state_fd, sleep_config->states[operation]);
 284         if (r < 0)
 285                 log_struct_errno(LOG_ERR, r,
 286                                  "MESSAGE_ID=" SD_MESSAGE_SLEEP_STOP_STR,
 287                                  LOG_MESSAGE("Failed to put system to sleep. System resumed again: %m"),
 288                                  "SLEEP=%s", sleep_operation_to_string(arg_operation));
 289         else
 290                 log_struct(LOG_INFO,
 291                            "MESSAGE_ID=" SD_MESSAGE_SLEEP_STOP_STR,
 292                            LOG_MESSAGE("System returned from sleep operation '%s'.", sleep_operation_to_string(arg_operation)),
 293                            "SLEEP=%s", sleep_operation_to_string(arg_operation));
 294
 295         arguments[1] = "post";
 296         (void) execute_directories(dirs, DEFAULT_TIMEOUT_USEC, NULL, NULL, (char **) arguments, NULL, EXEC_DIR_PARALLEL | EXEC_DIR_IGNORE_ERRORS);
 297
 298         if (r >= 0)
 299                 return 0;
 300
 301 fail:
 302         if (sleep_operation_is_hibernation(operation))
 303                 clear_efi_hibernate_location_and_warn();
 304
 305         return r;
 306 }
 307
 308 /* Return true if wakeup type is APM timer */
 309 static int check_wakeup_type(void) {
 310         static const char dmi_object_path[] = "/sys/firmware/dmi/entries/1-0/raw";
 311         uint8_t wakeup_type_byte, tablesize;
 312         _cleanup_free_ char *buf = NULL;
 313         size_t bufsize;
 314         int r;
 315
 316         /* implementation via dmi/entries */
 317         r = read_full_virtual_file(dmi_object_path, &buf, &bufsize);
 318         if (r < 0)
 319                 return log_debug_errno(r, "Unable to read %s: %m", dmi_object_path);
 320         if (bufsize < 25)
 321                 return log_debug_errno(SYNTHETIC_ERRNO(EINVAL),
 322                                        "Only read %zu bytes from %s (expected 25)",
 323                                        bufsize, dmi_object_path);
 324
 325         /* index 1 stores the size of table */
 326         tablesize = (uint8_t) buf[1];
 327         if (tablesize < 25)
 328                 return log_debug_errno(SYNTHETIC_ERRNO(EINVAL),
 329                                        "Table size less than the index[0x18] where waketype byte is available.");
 330
 331         wakeup_type_byte = (uint8_t) buf[24];
 332         /* 0 is Reserved and 8 is AC Power Restored. As per table 12 in
 333          * https://www.dmtf.org/sites/default/files/standards/documents/DSP0134_3.4.0.pdf */
 334         if (wakeup_type_byte >= 128)
 335                 return log_debug_errno(SYNTHETIC_ERRNO(EINVAL), "Expected value in range 0-127");
 336
 337         if (wakeup_type_byte == 3) {
 338                 log_debug("DMI BIOS System Information indicates wakeup type is APM Timer");
 339                 return true;
 340         }
 341
 342         return false;
 343 }
 344
 345 static int custom_timer_suspend(const SleepConfig *sleep_config) {
 346         usec_t hibernate_timestamp;
 347         int r;
 348
 349         assert(sleep_config);
 350
 351         hibernate_timestamp = usec_add(now(CLOCK_BOOTTIME), sleep_config->hibernate_delay_usec);
 352
 353         while (battery_is_discharging_and_low() == 0) {
 354                 _cleanup_hashmap_free_ Hashmap *last_capacity = NULL, *current_capacity = NULL;
 355                 _cleanup_close_ int tfd = -EBADF;
 356                 struct itimerspec ts = {};
 357                 usec_t suspend_interval;
 358                 bool woken_by_timer;
 359
 360                 tfd = timerfd_create(CLOCK_BOOTTIME_ALARM, TFD_NONBLOCK|TFD_CLOEXEC);
 361                 if (tfd < 0)
 362                         return log_error_errno(errno, "Error creating timerfd: %m");
 363
 364                 /* Store current battery capacity before suspension */
 365                 r = fetch_batteries_capacity_by_name(&last_capacity);
 366                 if (r < 0)
 367                         return log_error_errno(r, "Error fetching battery capacity percentage: %m");
 368
 369                 if (hashmap_isempty(last_capacity))
 370                         /* In case of no battery, system suspend interval will be set to HibernateDelaySec= or 2 hours. */
 371                         suspend_interval = timestamp_is_set(hibernate_timestamp)
 372                                            ? sleep_config->hibernate_delay_usec : DEFAULT_HIBERNATE_DELAY_USEC_NO_BATTERY;
 373                 else {
 374                         r = get_total_suspend_interval(last_capacity, &suspend_interval);
 375                         if (r < 0) {
 376                                 log_debug_errno(r, "Failed to estimate suspend interval using previous discharge rate, ignoring: %m");
 377                                 /* In case of any errors, especially when we do not know the battery
 378                                  * discharging rate, system suspend interval will be set to
 379                                  * SuspendEstimationSec=. */
 380                                 suspend_interval = sleep_config->suspend_estimation_usec;
 381                         }
 382                 }
 383
 384                 /* Do not suspend more than HibernateDelaySec= */
 385                 usec_t before_timestamp = now(CLOCK_BOOTTIME);
 386                 suspend_interval = MIN(suspend_interval, usec_sub_unsigned(hibernate_timestamp, before_timestamp));
 387                 if (suspend_interval <= 0)
 388                         break; /* system should hibernate */
 389
 390                 log_debug("Set timerfd wake alarm for %s", FORMAT_TIMESPAN(suspend_interval, USEC_PER_SEC));
 391                 /* Wake alarm for system with or without battery to hibernate or estimate discharge rate whichever is applicable */
 392                 timespec_store(&ts.it_value, suspend_interval);
 393
 394                 if (timerfd_settime(tfd, 0, &ts, NULL) < 0)
 395                         return log_error_errno(errno, "Error setting battery estimate timer: %m");
 396
 397                 r = execute(sleep_config, SLEEP_SUSPEND, NULL);
 398                 if (r < 0)
 399                         return r;
 400
 401                 r = fd_wait_for_event(tfd, POLLIN, 0);
 402                 if (r < 0)
 403                         return log_error_errno(r, "Error polling timerfd: %m");
 404                 /* Store fd_wait status */
 405                 woken_by_timer = FLAGS_SET(r, POLLIN);
 406
 407                 r = fetch_batteries_capacity_by_name(&current_capacity);
 408                 if (r < 0 || hashmap_isempty(current_capacity)) {
 409                         /* In case of no battery or error while getting charge level, no need to measure
 410                          * discharge rate. Instead the system should wake up if it is manual wakeup or
 411                          * hibernate if this is a timer wakeup. */
 412                         if (r < 0)
 413                                 log_debug_errno(r, "Battery capacity percentage unavailable, cannot estimate discharge rate: %m");
 414                         else
 415                                 log_debug("No battery found.");
 416                         if (!woken_by_timer)
 417                                 return 0;
 418                         break;
 419                 }
 420
 421                 usec_t after_timestamp = now(CLOCK_BOOTTIME);
 422                 log_debug("Attempting to estimate battery discharge rate after wakeup from %s sleep",
 423                           FORMAT_TIMESPAN(after_timestamp - before_timestamp, USEC_PER_HOUR));
 424
 425                 if (after_timestamp != before_timestamp) {
 426                         r = estimate_battery_discharge_rate_per_hour(last_capacity, current_capacity, before_timestamp, after_timestamp);
 427                         if (r < 0)
 428                                 log_warning_errno(r, "Failed to estimate and update battery discharge rate, ignoring: %m");
 429                 } else
 430                         log_debug("System woke up too early to estimate discharge rate.");
 431
 432                 if (!woken_by_timer)
 433                         /* Return as manual wakeup done. This also will return in case battery was charged during suspension */
 434                         return 0;
 435
 436                 r = check_wakeup_type();
 437                 if (r > 0) {
 438                         log_debug("wakeup type is APM timer");
 439                         /* system should hibernate */
 440                         break;
 441                 }
 442         }
 443
 444         return 1;
 445 }
 446
 447 /* Freeze when invoked and thaw on cleanup */
 448 static int freeze_thaw_user_slice(const char **method) {
 449         _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
 450         _cleanup_(sd_bus_flush_close_unrefp) sd_bus *bus = NULL;
 451         int r;
 452
 453         if (!method || !*method)
 454                 return 0;
 455
 456         r = bus_connect_system_systemd(&bus);
 457         if (r < 0)
 458                 return log_debug_errno(r, "Failed to open connection to systemd: %m");
 459
 460         (void) sd_bus_set_method_call_timeout(bus, FREEZE_TIMEOUT);
 461
 462         r = bus_call_method(bus, bus_systemd_mgr, *method, &error, NULL, "s", SPECIAL_USER_SLICE);
 463         if (r < 0)
 464                 return log_debug_errno(r, "Failed to execute operation: %s", bus_error_message(&error, r));
 465
 466         return 1;
 467 }
 468
 469 static int execute_s2h(const SleepConfig *sleep_config) {
 470         _unused_ _cleanup_(freeze_thaw_user_slice) const char *auto_method_thaw = "ThawUnit";
 471         int r;
 472
 473         assert(sleep_config);
 474
 475         r = freeze_thaw_user_slice(&(const char*) { "FreezeUnit" });
 476         if (r < 0)
 477                 log_warning_errno(r, "Failed to freeze unit user.slice, ignoring: %m");
 478
 479         /* Only check if we have automated battery alarms if HibernateDelaySec= is not set, as in that case
 480          * we'll busy poll for the configured interval instead */
 481         if (!timestamp_is_set(sleep_config->hibernate_delay_usec)) {
 482                 r = check_wakeup_type();
 483                 if (r < 0)
 484                         log_warning_errno(r, "Failed to check hardware wakeup type, ignoring: %m");
 485                 else {
 486                         r = battery_trip_point_alarm_exists();
 487                         if (r < 0)
 488                                 log_warning_errno(r, "Failed to check whether acpi_btp support is enabled or not, ignoring: %m");
 489                 }
 490         } else
 491                 r = 0;  /* Force fallback path */
 492
 493         if (r > 0) { /* If we have both wakeup alarms and battery trip point support, use them */
 494                 log_debug("Attempting to suspend...");
 495                 r = execute(sleep_config, SLEEP_SUSPEND, NULL);
 496                 if (r < 0)
 497                         return r;
 498
 499                 r = check_wakeup_type();
 500                 if (r < 0)
 501                         return log_error_errno(r, "Failed to check hardware wakeup type: %m");
 502
 503                 if (r == 0)
 504                         /* For APM Timer wakeup, system should hibernate else wakeup */
 505                         return 0;
 506         } else {
 507                 r = custom_timer_suspend(sleep_config);
 508                 if (r < 0)
 509                         return log_debug_errno(r, "Suspend cycle with manual battery discharge rate estimation failed: %m");
 510                 if (r == 0)
 511                         /* manual wakeup */
 512                         return 0;
 513         }
 514         /* For above custom timer, if 1 is returned, system will directly hibernate */
 515
 516         log_debug("Attempting to hibernate");
 517         r = execute(sleep_config, SLEEP_HIBERNATE, NULL);
 518         if (r < 0) {
 519                 log_notice("Couldn't hibernate, will try to suspend again.");
 520
 521                 r = execute(sleep_config, SLEEP_SUSPEND, "suspend-after-failed-hibernate");
 522                 if (r < 0)
 523                         return r;
 524         }
 525
 526         return 0;
 527 }
 528
 529 static int help(void) {
 530         _cleanup_free_ char *link = NULL;
 531         int r;
 532
 533         r = terminal_urlify_man("systemd-suspend.service", "8", &link);
 534         if (r < 0)
 535                 return log_oom();
 536
 537         printf("%s COMMAND\n\n"
 538                "Suspend the system, hibernate the system, or both.\n\n"
 539                "  -h --help              Show this help and exit\n"
 540                "  --version              Print version string and exit\n"
 541                "\nCommands:\n"
 542                "  suspend                Suspend the system\n"
 543                "  hibernate              Hibernate the system\n"
 544                "  hybrid-sleep           Both hibernate and suspend the system\n"
 545                "  suspend-then-hibernate Initially suspend and then hibernate\n"
 546                "                         the system after a fixed period of time or\n"
 547                "                         when battery is low\n"
 548                "\nSee the %s for details.\n",
 549                program_invocation_short_name,
 550                link);
 551
 552         return 0;
 553 }
 554
 555 static int parse_argv(int argc, char *argv[]) {
 556
 557         enum {
 558                 ARG_VERSION = 0x100,
 559         };
 560
 561         static const struct option options[] = {
 562                 { "help",         no_argument,       NULL, 'h'           },
 563                 { "version",      no_argument,       NULL, ARG_VERSION   },
 564                 {}
 565         };
 566
 567         int c;
 568
 569         assert(argc >= 0);
 570         assert(argv);
 571
 572         while ((c = getopt_long(argc, argv, "h", options, NULL)) >= 0)
 573                 switch (c) {
 574
 575                 case 'h':
 576                         return help();
 577
 578                 case ARG_VERSION:
 579                         return version();
 580
 581                 case '?':
 582                         return -EINVAL;
 583
 584                 default:
 585                         assert_not_reached();
 586
 587                 }
 588
 589         if (argc - optind != 1)
 590                 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
 591                                        "Usage: %s COMMAND",
 592                                        program_invocation_short_name);
 593
 594         arg_operation = sleep_operation_from_string(argv[optind]);
 595         if (arg_operation < 0)
 596                 return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Unknown command '%s'.", argv[optind]);
 597
 598         return 1 /* work to do */;
 599 }
 600
 601 static int run(int argc, char *argv[]) {
 602         _cleanup_(sleep_config_freep) SleepConfig *sleep_config = NULL;
 603         int r;
 604
 605         log_setup();
 606
 607         r = parse_argv(argc, argv);
 608         if (r <= 0)
 609                 return r;
 610
 611         r = parse_sleep_config(&sleep_config);
 612         if (r < 0)
 613                 return r;
 614
 615         if (!sleep_config->allow[arg_operation])
 616                 return log_error_errno(SYNTHETIC_ERRNO(EACCES),
 617                                        "Sleep operation \"%s\" is disabled by configuration, refusing.",
 618                                        sleep_operation_to_string(arg_operation));
 619
 620         switch (arg_operation) {
 621
 622         case SLEEP_SUSPEND_THEN_HIBERNATE:
 623                 r = execute_s2h(sleep_config);
 624                 break;
 625
 626         case SLEEP_HYBRID_SLEEP:
 627                 r = execute(sleep_config, SLEEP_HYBRID_SLEEP, NULL);
 628                 if (r < 0) {
 629                         /* If we can't hybrid sleep, then let's try to suspend at least. After all, the user
 630                          * asked us to do both: suspend + hibernate, and it's almost certainly the
 631                          * hibernation that failed, hence still do the other thing, the suspend. */
 632
 633                         log_notice_errno(r, "Couldn't hybrid sleep, will try to suspend instead: %m");
 634
 635                         r = execute(sleep_config, SLEEP_SUSPEND, "suspend-after-failed-hybrid-sleep");
 636                 }
 637
 638                 break;
 639
 640         default:
 641                 r = execute(sleep_config, arg_operation, NULL);
 642                 break;
 643
 644         }
 645
 646         return r;
 647 }
 648
 649 DEFINE_MAIN_FUNCTION(run);