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