1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
10 #include "alloc-util.h"
11 #include "dbus-swap.h"
12 #include "dbus-unit.h"
13 #include "device-util.h"
16 #include "exit-status.h"
18 #include "format-util.h"
19 #include "fstab-util.h"
20 #include "parse-util.h"
21 #include "path-util.h"
22 #include "process-util.h"
23 #include "serialize.h"
25 #include "string-table.h"
26 #include "string-util.h"
28 #include "unit-name.h"
32 static const UnitActiveState state_translation_table
[_SWAP_STATE_MAX
] = {
33 [SWAP_DEAD
] = UNIT_INACTIVE
,
34 [SWAP_ACTIVATING
] = UNIT_ACTIVATING
,
35 [SWAP_ACTIVATING_DONE
] = UNIT_ACTIVE
,
36 [SWAP_ACTIVE
] = UNIT_ACTIVE
,
37 [SWAP_DEACTIVATING
] = UNIT_DEACTIVATING
,
38 [SWAP_DEACTIVATING_SIGTERM
] = UNIT_DEACTIVATING
,
39 [SWAP_DEACTIVATING_SIGKILL
] = UNIT_DEACTIVATING
,
40 [SWAP_FAILED
] = UNIT_FAILED
,
41 [SWAP_CLEANING
] = UNIT_MAINTENANCE
,
44 static int swap_dispatch_timer(sd_event_source
*source
, usec_t usec
, void *userdata
);
45 static int swap_dispatch_io(sd_event_source
*source
, int fd
, uint32_t revents
, void *userdata
);
46 static int swap_process_proc_swaps(Manager
*m
);
48 static bool SWAP_STATE_WITH_PROCESS(SwapState state
) {
53 SWAP_DEACTIVATING_SIGTERM
,
54 SWAP_DEACTIVATING_SIGKILL
,
58 _pure_
static UnitActiveState
swap_active_state(Unit
*u
) {
61 return state_translation_table
[SWAP(u
)->state
];
64 _pure_
static const char *swap_sub_state_to_string(Unit
*u
) {
67 return swap_state_to_string(SWAP(u
)->state
);
70 _pure_
static bool swap_may_gc(Unit
*u
) {
75 if (s
->from_proc_swaps
)
81 _pure_
static bool swap_is_extrinsic(Unit
*u
) {
84 return MANAGER_IS_USER(u
->manager
);
87 static void swap_unset_proc_swaps(Swap
*s
) {
90 if (!s
->from_proc_swaps
)
93 s
->parameters_proc_swaps
.what
= mfree(s
->parameters_proc_swaps
.what
);
94 s
->from_proc_swaps
= false;
97 static int swap_set_devnode(Swap
*s
, const char *devnode
) {
104 r
= hashmap_ensure_allocated(&UNIT(s
)->manager
->swaps_by_devnode
, &path_hash_ops
);
108 swaps
= UNIT(s
)->manager
->swaps_by_devnode
;
111 first
= hashmap_get(swaps
, s
->devnode
);
113 LIST_REMOVE(same_devnode
, first
, s
);
115 hashmap_replace(swaps
, first
->devnode
, first
);
117 hashmap_remove(swaps
, s
->devnode
);
119 s
->devnode
= mfree(s
->devnode
);
123 s
->devnode
= strdup(devnode
);
127 first
= hashmap_get(swaps
, s
->devnode
);
128 LIST_PREPEND(same_devnode
, first
, s
);
130 return hashmap_replace(swaps
, first
->devnode
, first
);
136 static void swap_init(Unit
*u
) {
140 assert(UNIT(s
)->load_state
== UNIT_STUB
);
142 s
->timeout_usec
= u
->manager
->default_timeout_start_usec
;
144 s
->exec_context
.std_output
= u
->manager
->default_std_output
;
145 s
->exec_context
.std_error
= u
->manager
->default_std_error
;
147 s
->control_command_id
= _SWAP_EXEC_COMMAND_INVALID
;
149 u
->ignore_on_isolate
= true;
152 static void swap_unwatch_control_pid(Swap
*s
) {
155 if (s
->control_pid
<= 0)
158 unit_unwatch_pid(UNIT(s
), s
->control_pid
);
162 static void swap_done(Unit
*u
) {
167 swap_unset_proc_swaps(s
);
168 swap_set_devnode(s
, NULL
);
170 s
->what
= mfree(s
->what
);
171 s
->parameters_fragment
.what
= mfree(s
->parameters_fragment
.what
);
172 s
->parameters_fragment
.options
= mfree(s
->parameters_fragment
.options
);
174 s
->exec_runtime
= exec_runtime_unref(s
->exec_runtime
, false);
175 exec_command_done_array(s
->exec_command
, _SWAP_EXEC_COMMAND_MAX
);
176 s
->control_command
= NULL
;
178 dynamic_creds_unref(&s
->dynamic_creds
);
180 swap_unwatch_control_pid(s
);
182 s
->timer_event_source
= sd_event_source_disable_unref(s
->timer_event_source
);
185 static int swap_arm_timer(Swap
*s
, usec_t usec
) {
190 if (s
->timer_event_source
) {
191 r
= sd_event_source_set_time(s
->timer_event_source
, usec
);
195 return sd_event_source_set_enabled(s
->timer_event_source
, SD_EVENT_ONESHOT
);
198 if (usec
== USEC_INFINITY
)
201 r
= sd_event_add_time(
202 UNIT(s
)->manager
->event
,
203 &s
->timer_event_source
,
206 swap_dispatch_timer
, s
);
210 (void) sd_event_source_set_description(s
->timer_event_source
, "swap-timer");
215 static SwapParameters
* swap_get_parameters(Swap
*s
) {
218 if (s
->from_proc_swaps
)
219 return &s
->parameters_proc_swaps
;
221 if (s
->from_fragment
)
222 return &s
->parameters_fragment
;
227 static int swap_add_device_dependencies(Swap
*s
) {
228 UnitDependencyMask mask
;
237 p
= swap_get_parameters(s
);
241 mask
= s
->from_proc_swaps
? UNIT_DEPENDENCY_PROC_SWAP
: UNIT_DEPENDENCY_FILE
;
243 if (is_device_path(p
->what
)) {
244 r
= unit_add_node_dependency(UNIT(s
), p
->what
, UNIT_REQUIRES
, mask
);
248 return unit_add_blockdev_dependency(UNIT(s
), p
->what
, mask
);
251 /* File based swap devices need to be ordered after systemd-remount-fs.service, since they might need
252 * a writable file system. */
253 return unit_add_dependency_by_name(UNIT(s
), UNIT_AFTER
, SPECIAL_REMOUNT_FS_SERVICE
, true, mask
);
256 static int swap_add_default_dependencies(Swap
*s
) {
261 if (!UNIT(s
)->default_dependencies
)
264 if (!MANAGER_IS_SYSTEM(UNIT(s
)->manager
))
267 if (detect_container() > 0)
270 /* swap units generated for the swap dev links are missing the
271 * ordering dep against the swap target. */
272 r
= unit_add_dependency_by_name(UNIT(s
), UNIT_BEFORE
, SPECIAL_SWAP_TARGET
, true, UNIT_DEPENDENCY_DEFAULT
);
276 return unit_add_two_dependencies_by_name(UNIT(s
), UNIT_BEFORE
, UNIT_CONFLICTS
, SPECIAL_UMOUNT_TARGET
, true, UNIT_DEPENDENCY_DEFAULT
);
279 static int swap_verify(Swap
*s
) {
280 _cleanup_free_
char *e
= NULL
;
283 assert(UNIT(s
)->load_state
== UNIT_LOADED
);
285 r
= unit_name_from_path(s
->what
, ".swap", &e
);
287 return log_unit_error_errno(UNIT(s
), r
, "Failed to generate unit name from path: %m");
289 if (!unit_has_name(UNIT(s
), e
))
290 return log_unit_error_errno(UNIT(s
), SYNTHETIC_ERRNO(ENOEXEC
), "Value of What= and unit name do not match, not loading.");
292 if (s
->exec_context
.pam_name
&& s
->kill_context
.kill_mode
!= KILL_CONTROL_GROUP
)
293 return log_unit_error_errno(UNIT(s
), SYNTHETIC_ERRNO(ENOEXEC
), "Unit has PAM enabled. Kill mode must be set to 'control-group'. Refusing to load.");
298 static int swap_load_devnode(Swap
*s
) {
299 _cleanup_(sd_device_unrefp
) sd_device
*d
= NULL
;
306 if (stat(s
->what
, &st
) < 0 || !S_ISBLK(st
.st_mode
))
309 r
= sd_device_new_from_stat_rdev(&d
, &st
);
311 log_unit_full_errno(UNIT(s
), r
== -ENOENT
? LOG_DEBUG
: LOG_WARNING
, r
,
312 "Failed to allocate device for swap %s: %m", s
->what
);
316 if (sd_device_get_devname(d
, &p
) < 0)
319 return swap_set_devnode(s
, p
);
322 static int swap_add_extras(Swap
*s
) {
327 if (UNIT(s
)->fragment_path
)
328 s
->from_fragment
= true;
331 if (s
->parameters_fragment
.what
)
332 s
->what
= strdup(s
->parameters_fragment
.what
);
333 else if (s
->parameters_proc_swaps
.what
)
334 s
->what
= strdup(s
->parameters_proc_swaps
.what
);
336 r
= unit_name_to_path(UNIT(s
)->id
, &s
->what
);
345 path_simplify(s
->what
);
347 if (!UNIT(s
)->description
) {
348 r
= unit_set_description(UNIT(s
), s
->what
);
353 r
= unit_require_mounts_for(UNIT(s
), s
->what
, UNIT_DEPENDENCY_IMPLICIT
);
357 r
= swap_add_device_dependencies(s
);
361 r
= swap_load_devnode(s
);
365 r
= unit_patch_contexts(UNIT(s
));
369 r
= unit_add_exec_dependencies(UNIT(s
), &s
->exec_context
);
373 r
= unit_set_default_slice(UNIT(s
));
377 r
= swap_add_default_dependencies(s
);
384 static int swap_load(Unit
*u
) {
389 assert(u
->load_state
== UNIT_STUB
);
391 /* Load a .swap file */
392 bool fragment_optional
= s
->from_proc_swaps
;
393 r
= unit_load_fragment_and_dropin(u
, !fragment_optional
);
395 /* Add in some extras, and do so either when we successfully loaded something or when /proc/swaps is
397 if (u
->load_state
== UNIT_LOADED
|| s
->from_proc_swaps
)
398 q
= swap_add_extras(s
);
404 if (u
->load_state
!= UNIT_LOADED
)
407 return swap_verify(s
);
410 static int swap_setup_unit(
413 const char *what_proc_swaps
,
417 _cleanup_free_
char *e
= NULL
;
425 assert(what_proc_swaps
);
427 r
= unit_name_from_path(what
, ".swap", &e
);
429 return log_unit_error_errno(u
, r
, "Failed to generate unit name from path: %m");
431 u
= manager_get_unit(m
, e
);
433 SWAP(u
)->from_proc_swaps
&&
434 !path_equal(SWAP(u
)->parameters_proc_swaps
.what
, what_proc_swaps
))
435 return log_error_errno(SYNTHETIC_ERRNO(EEXIST
),
436 "Swap %s appeared twice with different device paths %s and %s",
437 e
, SWAP(u
)->parameters_proc_swaps
.what
, what_proc_swaps
);
442 r
= unit_new_for_name(m
, sizeof(Swap
), e
, &u
);
446 SWAP(u
)->what
= strdup(what
);
447 if (!SWAP(u
)->what
) {
452 unit_add_to_load_queue(u
);
456 p
= &SWAP(u
)->parameters_proc_swaps
;
459 p
->what
= strdup(what_proc_swaps
);
466 /* The unit is definitely around now, mark it as loaded if it was previously referenced but could not be
467 * loaded. After all we can load it now, from the data in /proc/swaps. */
468 if (IN_SET(u
->load_state
, UNIT_NOT_FOUND
, UNIT_BAD_SETTING
, UNIT_ERROR
)) {
469 u
->load_state
= UNIT_LOADED
;
474 SWAP(u
)->is_active
= true;
475 SWAP(u
)->just_activated
= !SWAP(u
)->from_proc_swaps
;
478 SWAP(u
)->from_proc_swaps
= true;
480 p
->priority
= priority
;
481 p
->priority_set
= true;
483 unit_add_to_dbus_queue(u
);
487 log_unit_warning_errno(u
, r
, "Failed to load swap unit: %m");
495 static void swap_process_new(Manager
*m
, const char *device
, int prio
, bool set_flags
) {
496 _cleanup_(sd_device_unrefp
) sd_device
*d
= NULL
;
497 const char *dn
, *devlink
;
498 struct stat st
, st_link
;
503 if (swap_setup_unit(m
, device
, device
, prio
, set_flags
) < 0)
506 /* If this is a block device, then let's add duplicates for
507 * all other names of this block device */
508 if (stat(device
, &st
) < 0 || !S_ISBLK(st
.st_mode
))
511 r
= sd_device_new_from_stat_rdev(&d
, &st
);
513 return (void) log_full_errno(r
== -ENOENT
? LOG_DEBUG
: LOG_WARNING
, r
,
514 "Failed to allocate device for swap %s: %m", device
);
516 /* Add the main device node */
517 if (sd_device_get_devname(d
, &dn
) >= 0 && !streq(dn
, device
))
518 (void) swap_setup_unit(m
, dn
, device
, prio
, set_flags
);
520 /* Add additional units for all symlinks */
521 FOREACH_DEVICE_DEVLINK(d
, devlink
) {
523 /* Don't bother with the /dev/block links */
524 if (streq(devlink
, device
))
527 if (path_startswith(devlink
, "/dev/block/"))
530 if (stat(devlink
, &st_link
) >= 0 &&
531 (!S_ISBLK(st_link
.st_mode
) ||
532 st_link
.st_rdev
!= st
.st_rdev
))
535 (void) swap_setup_unit(m
, devlink
, device
, prio
, set_flags
);
539 static void swap_set_state(Swap
*s
, SwapState state
) {
545 if (s
->state
!= state
)
546 bus_unit_send_pending_change_signal(UNIT(s
), false);
548 old_state
= s
->state
;
551 if (!SWAP_STATE_WITH_PROCESS(state
)) {
552 s
->timer_event_source
= sd_event_source_disable_unref(s
->timer_event_source
);
553 swap_unwatch_control_pid(s
);
554 s
->control_command
= NULL
;
555 s
->control_command_id
= _SWAP_EXEC_COMMAND_INVALID
;
558 if (state
!= old_state
)
559 log_unit_debug(UNIT(s
), "Changed %s -> %s", swap_state_to_string(old_state
), swap_state_to_string(state
));
561 unit_notify(UNIT(s
), state_translation_table
[old_state
], state_translation_table
[state
], 0);
563 /* If there other units for the same device node have a job
564 queued it might be worth checking again if it is runnable
565 now. This is necessary, since swap_start() refuses
566 operation with EAGAIN if there's already another job for
567 the same device node queued. */
568 LIST_FOREACH_OTHERS(same_devnode
, other
, s
)
569 if (UNIT(other
)->job
)
570 job_add_to_run_queue(UNIT(other
)->job
);
573 static int swap_coldplug(Unit
*u
) {
575 SwapState new_state
= SWAP_DEAD
;
579 assert(s
->state
== SWAP_DEAD
);
581 if (s
->deserialized_state
!= s
->state
)
582 new_state
= s
->deserialized_state
;
583 else if (s
->from_proc_swaps
)
584 new_state
= SWAP_ACTIVE
;
586 if (new_state
== s
->state
)
589 if (s
->control_pid
> 0 &&
590 pid_is_unwaited(s
->control_pid
) &&
591 SWAP_STATE_WITH_PROCESS(new_state
)) {
593 r
= unit_watch_pid(UNIT(s
), s
->control_pid
, false);
597 r
= swap_arm_timer(s
, usec_add(u
->state_change_timestamp
.monotonic
, s
->timeout_usec
));
602 if (!IN_SET(new_state
, SWAP_DEAD
, SWAP_FAILED
)) {
603 (void) unit_setup_dynamic_creds(u
);
604 (void) unit_setup_exec_runtime(u
);
607 swap_set_state(s
, new_state
);
611 static void swap_dump(Unit
*u
, FILE *f
, const char *prefix
) {
612 char buf
[FORMAT_TIMESPAN_MAX
];
619 if (s
->from_proc_swaps
)
620 p
= &s
->parameters_proc_swaps
;
621 else if (s
->from_fragment
)
622 p
= &s
->parameters_fragment
;
629 "%sClean Result: %s\n"
631 "%sFrom /proc/swaps: %s\n"
632 "%sFrom fragment: %s\n"
634 prefix
, swap_state_to_string(s
->state
),
635 prefix
, swap_result_to_string(s
->result
),
636 prefix
, swap_result_to_string(s
->clean_result
),
638 prefix
, yes_no(s
->from_proc_swaps
),
639 prefix
, yes_no(s
->from_fragment
),
640 prefix
, yes_no(swap_is_extrinsic(u
)));
643 fprintf(f
, "%sDevice Node: %s\n", prefix
, s
->devnode
);
650 prefix
, strempty(p
->options
));
653 "%sTimeoutSec: %s\n",
654 prefix
, format_timespan(buf
, sizeof(buf
), s
->timeout_usec
, USEC_PER_SEC
));
656 if (s
->control_pid
> 0)
658 "%sControl PID: "PID_FMT
"\n",
659 prefix
, s
->control_pid
);
661 exec_context_dump(&s
->exec_context
, f
, prefix
);
662 kill_context_dump(&s
->kill_context
, f
, prefix
);
663 cgroup_context_dump(UNIT(s
), f
, prefix
);
666 static int swap_spawn(Swap
*s
, ExecCommand
*c
, pid_t
*_pid
) {
668 _cleanup_(exec_params_clear
) ExecParameters exec_params
= {
669 .flags
= EXEC_APPLY_SANDBOXING
|EXEC_APPLY_CHROOT
|EXEC_APPLY_TTY_STDIN
,
682 r
= unit_prepare_exec(UNIT(s
));
686 r
= swap_arm_timer(s
, usec_add(now(CLOCK_MONOTONIC
), s
->timeout_usec
));
690 r
= unit_set_exec_params(UNIT(s
), &exec_params
);
694 r
= exec_spawn(UNIT(s
),
704 r
= unit_watch_pid(UNIT(s
), pid
, true);
713 s
->timer_event_source
= sd_event_source_disable_unref(s
->timer_event_source
);
718 static void swap_enter_dead(Swap
*s
, SwapResult f
) {
721 if (s
->result
== SWAP_SUCCESS
)
724 unit_log_result(UNIT(s
), s
->result
== SWAP_SUCCESS
, swap_result_to_string(s
->result
));
725 unit_warn_leftover_processes(UNIT(s
), unit_log_leftover_process_stop
);
726 swap_set_state(s
, s
->result
!= SWAP_SUCCESS
? SWAP_FAILED
: SWAP_DEAD
);
728 s
->exec_runtime
= exec_runtime_unref(s
->exec_runtime
, true);
730 unit_destroy_runtime_data(UNIT(s
), &s
->exec_context
);
732 unit_unref_uid_gid(UNIT(s
), true);
734 dynamic_creds_destroy(&s
->dynamic_creds
);
737 static void swap_enter_active(Swap
*s
, SwapResult f
) {
740 if (s
->result
== SWAP_SUCCESS
)
743 swap_set_state(s
, SWAP_ACTIVE
);
746 static void swap_enter_dead_or_active(Swap
*s
, SwapResult f
) {
749 if (s
->from_proc_swaps
) {
752 swap_enter_active(s
, f
);
754 LIST_FOREACH_OTHERS(same_devnode
, other
, s
)
755 if (UNIT(other
)->job
)
756 swap_enter_dead_or_active(other
, f
);
758 swap_enter_dead(s
, f
);
761 static int state_to_kill_operation(Swap
*s
, SwapState state
) {
762 if (state
== SWAP_DEACTIVATING_SIGTERM
) {
763 if (unit_has_job_type(UNIT(s
), JOB_RESTART
))
766 return KILL_TERMINATE
;
772 static void swap_enter_signal(Swap
*s
, SwapState state
, SwapResult f
) {
777 if (s
->result
== SWAP_SUCCESS
)
780 r
= unit_kill_context(UNIT(s
),
782 state_to_kill_operation(s
, state
),
790 r
= swap_arm_timer(s
, usec_add(now(CLOCK_MONOTONIC
), s
->timeout_usec
));
794 swap_set_state(s
, state
);
795 } else if (state
== SWAP_DEACTIVATING_SIGTERM
&& s
->kill_context
.send_sigkill
)
796 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGKILL
, SWAP_SUCCESS
);
798 swap_enter_dead_or_active(s
, SWAP_SUCCESS
);
803 log_unit_warning_errno(UNIT(s
), r
, "Failed to kill processes: %m");
804 swap_enter_dead_or_active(s
, SWAP_FAILURE_RESOURCES
);
807 static void swap_enter_activating(Swap
*s
) {
808 _cleanup_free_
char *opts
= NULL
;
813 unit_warn_leftover_processes(UNIT(s
), unit_log_leftover_process_start
);
815 s
->control_command_id
= SWAP_EXEC_ACTIVATE
;
816 s
->control_command
= s
->exec_command
+ SWAP_EXEC_ACTIVATE
;
818 if (s
->from_fragment
) {
821 r
= fstab_find_pri(s
->parameters_fragment
.options
, &priority
);
823 log_unit_warning_errno(UNIT(s
), r
, "Failed to parse swap priority \"%s\", ignoring: %m", s
->parameters_fragment
.options
);
824 else if (r
> 0 && s
->parameters_fragment
.priority_set
)
825 log_unit_warning(UNIT(s
), "Duplicate swap priority configuration by Priority= and Options= fields.");
827 if (r
<= 0 && s
->parameters_fragment
.priority_set
) {
828 if (s
->parameters_fragment
.options
)
829 r
= asprintf(&opts
, "%s,pri=%i", s
->parameters_fragment
.options
, s
->parameters_fragment
.priority
);
831 r
= asprintf(&opts
, "pri=%i", s
->parameters_fragment
.priority
);
839 r
= exec_command_set(s
->control_command
, "/sbin/swapon", NULL
);
843 if (s
->parameters_fragment
.options
|| opts
) {
844 r
= exec_command_append(s
->control_command
, "-o",
845 opts
?: s
->parameters_fragment
.options
, NULL
);
850 r
= exec_command_append(s
->control_command
, s
->what
, NULL
);
854 swap_unwatch_control_pid(s
);
856 r
= swap_spawn(s
, s
->control_command
, &s
->control_pid
);
860 swap_set_state(s
, SWAP_ACTIVATING
);
864 log_unit_warning_errno(UNIT(s
), r
, "Failed to run 'swapon' task: %m");
865 swap_enter_dead_or_active(s
, SWAP_FAILURE_RESOURCES
);
868 static void swap_enter_deactivating(Swap
*s
) {
873 s
->control_command_id
= SWAP_EXEC_DEACTIVATE
;
874 s
->control_command
= s
->exec_command
+ SWAP_EXEC_DEACTIVATE
;
876 r
= exec_command_set(s
->control_command
,
883 swap_unwatch_control_pid(s
);
885 r
= swap_spawn(s
, s
->control_command
, &s
->control_pid
);
889 swap_set_state(s
, SWAP_DEACTIVATING
);
894 log_unit_warning_errno(UNIT(s
), r
, "Failed to run 'swapoff' task: %m");
895 swap_enter_dead_or_active(s
, SWAP_FAILURE_RESOURCES
);
898 static void swap_cycle_clear(Swap
*s
) {
901 s
->result
= SWAP_SUCCESS
;
902 exec_command_reset_status_array(s
->exec_command
, _SWAP_EXEC_COMMAND_MAX
);
903 UNIT(s
)->reset_accounting
= true;
906 static int swap_start(Unit
*u
) {
907 Swap
*s
= SWAP(u
), *other
;
912 /* We cannot fulfill this request right now, try again later please! */
915 SWAP_DEACTIVATING_SIGTERM
,
916 SWAP_DEACTIVATING_SIGKILL
,
921 if (s
->state
== SWAP_ACTIVATING
)
924 assert(IN_SET(s
->state
, SWAP_DEAD
, SWAP_FAILED
));
926 if (detect_container() > 0)
929 /* If there's a job for another swap unit for the same node
930 * running, then let's not dispatch this one for now, and wait
931 * until that other job has finished. */
932 LIST_FOREACH_OTHERS(same_devnode
, other
, s
)
933 if (UNIT(other
)->job
&& UNIT(other
)->job
->state
== JOB_RUNNING
)
936 r
= unit_test_start_limit(u
);
938 swap_enter_dead(s
, SWAP_FAILURE_START_LIMIT_HIT
);
942 r
= unit_acquire_invocation_id(u
);
947 swap_enter_activating(s
);
951 static int swap_stop(Unit
*u
) {
958 case SWAP_DEACTIVATING
:
959 case SWAP_DEACTIVATING_SIGTERM
:
960 case SWAP_DEACTIVATING_SIGKILL
:
964 case SWAP_ACTIVATING
:
965 case SWAP_ACTIVATING_DONE
:
966 /* There's a control process pending, directly enter kill mode */
967 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGTERM
, SWAP_SUCCESS
);
971 if (detect_container() > 0)
974 swap_enter_deactivating(s
);
978 /* If we are currently cleaning, then abort it, brutally. */
979 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGKILL
, SWAP_SUCCESS
);
983 assert_not_reached("Unexpected state.");
987 static int swap_serialize(Unit
*u
, FILE *f
, FDSet
*fds
) {
994 (void) serialize_item(f
, "state", swap_state_to_string(s
->state
));
995 (void) serialize_item(f
, "result", swap_result_to_string(s
->result
));
997 if (s
->control_pid
> 0)
998 (void) serialize_item_format(f
, "control-pid", PID_FMT
, s
->control_pid
);
1000 if (s
->control_command_id
>= 0)
1001 (void) serialize_item(f
, "control-command", swap_exec_command_to_string(s
->control_command_id
));
1006 static int swap_deserialize_item(Unit
*u
, const char *key
, const char *value
, FDSet
*fds
) {
1012 if (streq(key
, "state")) {
1015 state
= swap_state_from_string(value
);
1017 log_unit_debug(u
, "Failed to parse state value: %s", value
);
1019 s
->deserialized_state
= state
;
1020 } else if (streq(key
, "result")) {
1023 f
= swap_result_from_string(value
);
1025 log_unit_debug(u
, "Failed to parse result value: %s", value
);
1026 else if (f
!= SWAP_SUCCESS
)
1028 } else if (streq(key
, "control-pid")) {
1031 if (parse_pid(value
, &pid
) < 0)
1032 log_unit_debug(u
, "Failed to parse control-pid value: %s", value
);
1034 s
->control_pid
= pid
;
1036 } else if (streq(key
, "control-command")) {
1039 id
= swap_exec_command_from_string(value
);
1041 log_unit_debug(u
, "Failed to parse exec-command value: %s", value
);
1043 s
->control_command_id
= id
;
1044 s
->control_command
= s
->exec_command
+ id
;
1047 log_unit_debug(u
, "Unknown serialization key: %s", key
);
1052 static void swap_sigchld_event(Unit
*u
, pid_t pid
, int code
, int status
) {
1059 if (pid
!= s
->control_pid
)
1062 /* Let's scan /proc/swaps before we process SIGCHLD. For the reasoning see the similar code in
1064 (void) swap_process_proc_swaps(u
->manager
);
1068 if (is_clean_exit(code
, status
, EXIT_CLEAN_COMMAND
, NULL
))
1070 else if (code
== CLD_EXITED
)
1071 f
= SWAP_FAILURE_EXIT_CODE
;
1072 else if (code
== CLD_KILLED
)
1073 f
= SWAP_FAILURE_SIGNAL
;
1074 else if (code
== CLD_DUMPED
)
1075 f
= SWAP_FAILURE_CORE_DUMP
;
1077 assert_not_reached("Unknown code");
1079 if (s
->result
== SWAP_SUCCESS
)
1082 if (s
->control_command
) {
1083 exec_status_exit(&s
->control_command
->exec_status
, &s
->exec_context
, pid
, code
, status
);
1085 s
->control_command
= NULL
;
1086 s
->control_command_id
= _SWAP_EXEC_COMMAND_INVALID
;
1089 unit_log_process_exit(
1092 swap_exec_command_to_string(s
->control_command_id
),
1098 case SWAP_ACTIVATING
:
1099 case SWAP_ACTIVATING_DONE
:
1101 if (f
== SWAP_SUCCESS
|| s
->from_proc_swaps
)
1102 swap_enter_active(s
, f
);
1104 swap_enter_dead(s
, f
);
1107 case SWAP_DEACTIVATING
:
1108 case SWAP_DEACTIVATING_SIGKILL
:
1109 case SWAP_DEACTIVATING_SIGTERM
:
1111 swap_enter_dead_or_active(s
, f
);
1115 if (s
->clean_result
== SWAP_SUCCESS
)
1116 s
->clean_result
= f
;
1118 swap_enter_dead(s
, SWAP_SUCCESS
);
1122 assert_not_reached("Uh, control process died at wrong time.");
1125 /* Notify clients about changed exit status */
1126 unit_add_to_dbus_queue(u
);
1129 static int swap_dispatch_timer(sd_event_source
*source
, usec_t usec
, void *userdata
) {
1130 Swap
*s
= SWAP(userdata
);
1133 assert(s
->timer_event_source
== source
);
1137 case SWAP_ACTIVATING
:
1138 case SWAP_ACTIVATING_DONE
:
1139 log_unit_warning(UNIT(s
), "Activation timed out. Stopping.");
1140 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGTERM
, SWAP_FAILURE_TIMEOUT
);
1143 case SWAP_DEACTIVATING
:
1144 log_unit_warning(UNIT(s
), "Deactivation timed out. Stopping.");
1145 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGTERM
, SWAP_FAILURE_TIMEOUT
);
1148 case SWAP_DEACTIVATING_SIGTERM
:
1149 if (s
->kill_context
.send_sigkill
) {
1150 log_unit_warning(UNIT(s
), "Swap process timed out. Killing.");
1151 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGKILL
, SWAP_FAILURE_TIMEOUT
);
1153 log_unit_warning(UNIT(s
), "Swap process timed out. Skipping SIGKILL. Ignoring.");
1154 swap_enter_dead_or_active(s
, SWAP_FAILURE_TIMEOUT
);
1158 case SWAP_DEACTIVATING_SIGKILL
:
1159 log_unit_warning(UNIT(s
), "Swap process still around after SIGKILL. Ignoring.");
1160 swap_enter_dead_or_active(s
, SWAP_FAILURE_TIMEOUT
);
1164 log_unit_warning(UNIT(s
), "Cleaning timed out. killing.");
1166 if (s
->clean_result
== SWAP_SUCCESS
)
1167 s
->clean_result
= SWAP_FAILURE_TIMEOUT
;
1169 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGKILL
, 0);
1173 assert_not_reached("Timeout at wrong time.");
1179 static int swap_load_proc_swaps(Manager
*m
, bool set_flags
) {
1182 rewind(m
->proc_swaps
);
1184 (void) fscanf(m
->proc_swaps
, "%*s %*s %*s %*s %*s\n");
1186 for (unsigned i
= 1;; i
++) {
1187 _cleanup_free_
char *dev
= NULL
, *d
= NULL
;
1190 k
= fscanf(m
->proc_swaps
,
1191 "%ms " /* device/file */
1192 "%*s " /* type of swap */
1193 "%*s " /* swap size */
1195 "%i\n", /* priority */
1201 log_warning("Failed to parse /proc/swaps:%u.", i
);
1205 if (cunescape(dev
, UNESCAPE_RELAX
, &d
) < 0)
1208 device_found_node(m
, d
, DEVICE_FOUND_SWAP
, DEVICE_FOUND_SWAP
);
1210 (void) swap_process_new(m
, d
, prio
, set_flags
);
1216 static int swap_process_proc_swaps(Manager
*m
) {
1222 r
= swap_load_proc_swaps(m
, true);
1224 log_error_errno(r
, "Failed to reread /proc/swaps: %m");
1226 /* Reset flags, just in case, for late calls */
1227 LIST_FOREACH(units_by_type
, u
, m
->units_by_type
[UNIT_SWAP
]) {
1228 Swap
*swap
= SWAP(u
);
1230 swap
->is_active
= swap
->just_activated
= false;
1236 manager_dispatch_load_queue(m
);
1238 LIST_FOREACH(units_by_type
, u
, m
->units_by_type
[UNIT_SWAP
]) {
1239 Swap
*swap
= SWAP(u
);
1241 if (!swap
->is_active
) {
1243 swap_unset_proc_swaps(swap
);
1245 switch (swap
->state
) {
1248 /* This has just been deactivated */
1249 swap_enter_dead(swap
, SWAP_SUCCESS
);
1254 swap_set_state(swap
, swap
->state
);
1259 device_found_node(m
, swap
->what
, 0, DEVICE_FOUND_SWAP
);
1261 } else if (swap
->just_activated
) {
1263 /* New swap entry */
1265 switch (swap
->state
) {
1269 (void) unit_acquire_invocation_id(u
);
1270 swap_cycle_clear(swap
);
1271 swap_enter_active(swap
, SWAP_SUCCESS
);
1274 case SWAP_ACTIVATING
:
1275 swap_set_state(swap
, SWAP_ACTIVATING_DONE
);
1279 /* Nothing really changed, but let's
1280 * issue an notification call
1281 * nonetheless, in case somebody is
1282 * waiting for this. */
1283 swap_set_state(swap
, swap
->state
);
1288 /* Reset the flags for later calls */
1289 swap
->is_active
= swap
->just_activated
= false;
1295 static int swap_dispatch_io(sd_event_source
*source
, int fd
, uint32_t revents
, void *userdata
) {
1296 Manager
*m
= userdata
;
1299 assert(revents
& EPOLLPRI
);
1301 return swap_process_proc_swaps(m
);
1304 static Unit
*swap_following(Unit
*u
) {
1306 Swap
*other
, *first
= NULL
;
1310 /* If the user configured the swap through /etc/fstab or
1311 * a device unit, follow that. */
1313 if (s
->from_fragment
)
1316 LIST_FOREACH_OTHERS(same_devnode
, other
, s
)
1317 if (other
->from_fragment
)
1320 /* Otherwise, make everybody follow the unit that's named after
1321 * the swap device in the kernel */
1323 if (streq_ptr(s
->what
, s
->devnode
))
1326 LIST_FOREACH_AFTER(same_devnode
, other
, s
)
1327 if (streq_ptr(other
->what
, other
->devnode
))
1330 LIST_FOREACH_BEFORE(same_devnode
, other
, s
) {
1331 if (streq_ptr(other
->what
, other
->devnode
))
1337 /* Fall back to the first on the list */
1341 static int swap_following_set(Unit
*u
, Set
**_set
) {
1342 Swap
*s
= SWAP(u
), *other
;
1343 _cleanup_set_free_ Set
*set
= NULL
;
1349 if (LIST_JUST_US(same_devnode
, s
)) {
1354 set
= set_new(NULL
);
1358 LIST_FOREACH_OTHERS(same_devnode
, other
, s
) {
1359 r
= set_put(set
, other
);
1364 *_set
= TAKE_PTR(set
);
1368 static void swap_shutdown(Manager
*m
) {
1371 m
->swap_event_source
= sd_event_source_disable_unref(m
->swap_event_source
);
1372 m
->proc_swaps
= safe_fclose(m
->proc_swaps
);
1373 m
->swaps_by_devnode
= hashmap_free(m
->swaps_by_devnode
);
1376 static void swap_enumerate(Manager
*m
) {
1381 if (!m
->proc_swaps
) {
1382 m
->proc_swaps
= fopen("/proc/swaps", "re");
1383 if (!m
->proc_swaps
) {
1384 if (errno
== ENOENT
)
1385 log_debug_errno(errno
, "Not swap enabled, skipping enumeration.");
1387 log_warning_errno(errno
, "Failed to open /proc/swaps, ignoring: %m");
1392 r
= sd_event_add_io(m
->event
, &m
->swap_event_source
, fileno(m
->proc_swaps
), EPOLLPRI
, swap_dispatch_io
, m
);
1394 log_error_errno(r
, "Failed to watch /proc/swaps: %m");
1398 /* Dispatch this before we dispatch SIGCHLD, so that
1399 * we always get the events from /proc/swaps before
1400 * the SIGCHLD of /sbin/swapon. */
1401 r
= sd_event_source_set_priority(m
->swap_event_source
, SD_EVENT_PRIORITY_NORMAL
-10);
1403 log_error_errno(r
, "Failed to change /proc/swaps priority: %m");
1407 (void) sd_event_source_set_description(m
->swap_event_source
, "swap-proc");
1410 r
= swap_load_proc_swaps(m
, false);
1420 int swap_process_device_new(Manager
*m
, sd_device
*dev
) {
1421 _cleanup_free_
char *e
= NULL
;
1422 const char *dn
, *devlink
;
1429 if (sd_device_get_devname(dev
, &dn
) < 0)
1432 r
= unit_name_from_path(dn
, ".swap", &e
);
1434 log_debug_errno(r
, "Cannot convert device name '%s' to unit name, ignoring: %m", dn
);
1438 u
= manager_get_unit(m
, e
);
1440 r
= swap_set_devnode(SWAP(u
), dn
);
1442 FOREACH_DEVICE_DEVLINK(dev
, devlink
) {
1443 _cleanup_free_
char *n
= NULL
;
1446 q
= unit_name_from_path(devlink
, ".swap", &n
);
1447 if (IN_SET(q
, -EINVAL
, -ENAMETOOLONG
)) /* If name too long or otherwise not convertible to
1448 * unit name, we can't manage it */
1453 u
= manager_get_unit(m
, n
);
1455 q
= swap_set_devnode(SWAP(u
), dn
);
1464 int swap_process_device_remove(Manager
*m
, sd_device
*dev
) {
1469 r
= sd_device_get_devname(dev
, &dn
);
1473 while ((s
= hashmap_get(m
->swaps_by_devnode
, dn
))) {
1476 q
= swap_set_devnode(s
, NULL
);
1484 static void swap_reset_failed(Unit
*u
) {
1489 if (s
->state
== SWAP_FAILED
)
1490 swap_set_state(s
, SWAP_DEAD
);
1492 s
->result
= SWAP_SUCCESS
;
1493 s
->clean_result
= SWAP_SUCCESS
;
1496 static int swap_kill(Unit
*u
, KillWho who
, int signo
, sd_bus_error
*error
) {
1497 return unit_kill_common(u
, who
, signo
, -1, SWAP(u
)->control_pid
, error
);
1500 static int swap_get_timeout(Unit
*u
, usec_t
*timeout
) {
1505 if (!s
->timer_event_source
)
1508 r
= sd_event_source_get_time(s
->timer_event_source
, &t
);
1511 if (t
== USEC_INFINITY
)
1518 static bool swap_supported(void) {
1519 static int supported
= -1;
1521 /* If swap support is not available in the kernel, or we are
1522 * running in a container we don't support swap units, and any
1523 * attempts to starting one should fail immediately. */
1527 access("/proc/swaps", F_OK
) >= 0 &&
1528 detect_container() <= 0;
1533 static int swap_control_pid(Unit
*u
) {
1538 return s
->control_pid
;
1541 static int swap_clean(Unit
*u
, ExecCleanMask mask
) {
1542 _cleanup_strv_free_
char **l
= NULL
;
1549 if (s
->state
!= SWAP_DEAD
)
1552 r
= exec_context_get_clean_directories(&s
->exec_context
, u
->manager
->prefix
, mask
, &l
);
1556 if (strv_isempty(l
))
1559 swap_unwatch_control_pid(s
);
1560 s
->clean_result
= SWAP_SUCCESS
;
1561 s
->control_command
= NULL
;
1562 s
->control_command_id
= _SWAP_EXEC_COMMAND_INVALID
;
1564 r
= swap_arm_timer(s
, usec_add(now(CLOCK_MONOTONIC
), s
->exec_context
.timeout_clean_usec
));
1568 r
= unit_fork_and_watch_rm_rf(u
, l
, &s
->control_pid
);
1572 swap_set_state(s
, SWAP_CLEANING
);
1577 log_unit_warning_errno(u
, r
, "Failed to initiate cleaning: %m");
1578 s
->clean_result
= SWAP_FAILURE_RESOURCES
;
1579 s
->timer_event_source
= sd_event_source_disable_unref(s
->timer_event_source
);
1583 static int swap_can_clean(Unit
*u
, ExecCleanMask
*ret
) {
1588 return exec_context_get_clean_mask(&s
->exec_context
, ret
);
1591 static const char* const swap_exec_command_table
[_SWAP_EXEC_COMMAND_MAX
] = {
1592 [SWAP_EXEC_ACTIVATE
] = "ExecActivate",
1593 [SWAP_EXEC_DEACTIVATE
] = "ExecDeactivate",
1596 DEFINE_STRING_TABLE_LOOKUP(swap_exec_command
, SwapExecCommand
);
1598 static const char* const swap_result_table
[_SWAP_RESULT_MAX
] = {
1599 [SWAP_SUCCESS
] = "success",
1600 [SWAP_FAILURE_RESOURCES
] = "resources",
1601 [SWAP_FAILURE_TIMEOUT
] = "timeout",
1602 [SWAP_FAILURE_EXIT_CODE
] = "exit-code",
1603 [SWAP_FAILURE_SIGNAL
] = "signal",
1604 [SWAP_FAILURE_CORE_DUMP
] = "core-dump",
1605 [SWAP_FAILURE_START_LIMIT_HIT
] = "start-limit-hit",
1608 DEFINE_STRING_TABLE_LOOKUP(swap_result
, SwapResult
);
1610 const UnitVTable swap_vtable
= {
1611 .object_size
= sizeof(Swap
),
1612 .exec_context_offset
= offsetof(Swap
, exec_context
),
1613 .cgroup_context_offset
= offsetof(Swap
, cgroup_context
),
1614 .kill_context_offset
= offsetof(Swap
, kill_context
),
1615 .exec_runtime_offset
= offsetof(Swap
, exec_runtime
),
1616 .dynamic_creds_offset
= offsetof(Swap
, dynamic_creds
),
1622 .private_section
= "Swap",
1630 .coldplug
= swap_coldplug
,
1634 .start
= swap_start
,
1638 .clean
= swap_clean
,
1639 .can_clean
= swap_can_clean
,
1641 .get_timeout
= swap_get_timeout
,
1643 .serialize
= swap_serialize
,
1644 .deserialize_item
= swap_deserialize_item
,
1646 .active_state
= swap_active_state
,
1647 .sub_state_to_string
= swap_sub_state_to_string
,
1649 .will_restart
= unit_will_restart_default
,
1651 .may_gc
= swap_may_gc
,
1652 .is_extrinsic
= swap_is_extrinsic
,
1654 .sigchld_event
= swap_sigchld_event
,
1656 .reset_failed
= swap_reset_failed
,
1658 .control_pid
= swap_control_pid
,
1660 .bus_set_property
= bus_swap_set_property
,
1661 .bus_commit_properties
= bus_swap_commit_properties
,
1663 .following
= swap_following
,
1664 .following_set
= swap_following_set
,
1666 .enumerate
= swap_enumerate
,
1667 .shutdown
= swap_shutdown
,
1668 .supported
= swap_supported
,
1670 .status_message_formats
= {
1671 .starting_stopping
= {
1672 [0] = "Activating swap %s...",
1673 [1] = "Deactivating swap %s...",
1675 .finished_start_job
= {
1676 [JOB_DONE
] = "Activated swap %s.",
1677 [JOB_FAILED
] = "Failed to activate swap %s.",
1678 [JOB_TIMEOUT
] = "Timed out activating swap %s.",
1680 .finished_stop_job
= {
1681 [JOB_DONE
] = "Deactivated swap %s.",
1682 [JOB_FAILED
] = "Failed deactivating swap %s.",
1683 [JOB_TIMEOUT
] = "Timed out deactivating swap %s.",