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