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