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 static UnitActiveState
swap_active_state(Unit
*u
) {
61 return state_translation_table
[SWAP(u
)->state
];
64 static const char *swap_sub_state_to_string(Unit
*u
) {
67 return swap_state_to_string(SWAP(u
)->state
);
70 static bool swap_may_gc(Unit
*u
) {
75 if (s
->from_proc_swaps
)
81 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
->defaults
.timeout_start_usec
;
144 s
->exec_context
.std_output
= u
->manager
->defaults
.std_output
;
145 s
->exec_context
.std_error
= u
->manager
->defaults
.std_error
;
147 s
->control_pid
= PIDREF_NULL
;
148 s
->control_command_id
= _SWAP_EXEC_COMMAND_INVALID
;
150 u
->ignore_on_isolate
= true;
153 static void swap_unwatch_control_pid(Swap
*s
) {
155 unit_unwatch_pidref_done(UNIT(s
), &s
->control_pid
);
158 static void swap_done(Unit
*u
) {
163 swap_unset_proc_swaps(s
);
164 swap_set_devnode(s
, NULL
);
166 s
->what
= mfree(s
->what
);
167 s
->parameters_fragment
.what
= mfree(s
->parameters_fragment
.what
);
168 s
->parameters_fragment
.options
= mfree(s
->parameters_fragment
.options
);
170 s
->exec_runtime
= exec_runtime_free(s
->exec_runtime
);
172 exec_command_done_array(s
->exec_command
, _SWAP_EXEC_COMMAND_MAX
);
173 s
->control_command
= NULL
;
175 swap_unwatch_control_pid(s
);
177 s
->timer_event_source
= sd_event_source_disable_unref(s
->timer_event_source
);
180 static int swap_arm_timer(Swap
*s
, bool relative
, usec_t usec
) {
183 return unit_arm_timer(UNIT(s
), &s
->timer_event_source
, relative
, usec
, swap_dispatch_timer
);
186 static SwapParameters
* swap_get_parameters(Swap
*s
) {
189 if (s
->from_proc_swaps
)
190 return &s
->parameters_proc_swaps
;
192 if (s
->from_fragment
)
193 return &s
->parameters_fragment
;
198 static int swap_add_device_dependencies(Swap
*s
) {
199 UnitDependencyMask mask
;
208 p
= swap_get_parameters(s
);
212 mask
= s
->from_proc_swaps
? UNIT_DEPENDENCY_PROC_SWAP
: UNIT_DEPENDENCY_FILE
;
214 if (is_device_path(p
->what
)) {
215 r
= unit_add_node_dependency(UNIT(s
), p
->what
, UNIT_REQUIRES
, mask
);
219 return unit_add_blockdev_dependency(UNIT(s
), p
->what
, mask
);
222 /* File based swap devices need to be ordered after systemd-remount-fs.service, since they might need
223 * a writable file system. */
224 return unit_add_dependency_by_name(UNIT(s
), UNIT_AFTER
, SPECIAL_REMOUNT_FS_SERVICE
, true, mask
);
227 static int swap_add_default_dependencies(Swap
*s
) {
232 if (!UNIT(s
)->default_dependencies
)
235 if (!MANAGER_IS_SYSTEM(UNIT(s
)->manager
))
238 if (detect_container() > 0)
241 /* swap units generated for the swap dev links are missing the
242 * ordering dep against the swap target. */
243 r
= unit_add_dependency_by_name(UNIT(s
), UNIT_BEFORE
, SPECIAL_SWAP_TARGET
, true, UNIT_DEPENDENCY_DEFAULT
);
247 return unit_add_two_dependencies_by_name(UNIT(s
), UNIT_BEFORE
, UNIT_CONFLICTS
, SPECIAL_UMOUNT_TARGET
, true, UNIT_DEPENDENCY_DEFAULT
);
250 static int swap_verify(Swap
*s
) {
251 _cleanup_free_
char *e
= NULL
;
254 assert(UNIT(s
)->load_state
== UNIT_LOADED
);
256 r
= unit_name_from_path(s
->what
, ".swap", &e
);
258 return log_unit_error_errno(UNIT(s
), r
, "Failed to generate unit name from path: %m");
260 if (!unit_has_name(UNIT(s
), e
))
261 return log_unit_error_errno(UNIT(s
), SYNTHETIC_ERRNO(ENOEXEC
), "Value of What= and unit name do not match, not loading.");
263 if (s
->exec_context
.pam_name
&& s
->kill_context
.kill_mode
!= KILL_CONTROL_GROUP
)
264 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.");
269 static int swap_load_devnode(Swap
*s
) {
270 _cleanup_free_
char *p
= NULL
;
276 if (stat(s
->what
, &st
) < 0 || !S_ISBLK(st
.st_mode
))
279 r
= devname_from_stat_rdev(&st
, &p
);
281 log_unit_full_errno(UNIT(s
), r
== -ENOENT
? LOG_DEBUG
: LOG_WARNING
, r
,
282 "Failed to get device node for swap %s: %m", s
->what
);
286 return swap_set_devnode(s
, p
);
289 static int swap_add_extras(Swap
*s
) {
294 if (UNIT(s
)->fragment_path
)
295 s
->from_fragment
= true;
298 if (s
->parameters_fragment
.what
)
299 s
->what
= strdup(s
->parameters_fragment
.what
);
300 else if (s
->parameters_proc_swaps
.what
)
301 s
->what
= strdup(s
->parameters_proc_swaps
.what
);
303 r
= unit_name_to_path(UNIT(s
)->id
, &s
->what
);
312 path_simplify(s
->what
);
314 if (!UNIT(s
)->description
) {
315 r
= unit_set_description(UNIT(s
), s
->what
);
320 r
= unit_add_mounts_for(UNIT(s
), s
->what
, UNIT_DEPENDENCY_IMPLICIT
, UNIT_MOUNT_REQUIRES
);
324 r
= swap_add_device_dependencies(s
);
328 r
= swap_load_devnode(s
);
332 r
= unit_patch_contexts(UNIT(s
));
336 r
= unit_add_exec_dependencies(UNIT(s
), &s
->exec_context
);
340 r
= unit_set_default_slice(UNIT(s
));
344 r
= swap_add_default_dependencies(s
);
351 static int swap_load(Unit
*u
) {
356 assert(u
->load_state
== UNIT_STUB
);
358 /* Load a .swap file */
359 bool fragment_optional
= s
->from_proc_swaps
;
360 r
= unit_load_fragment_and_dropin(u
, !fragment_optional
);
362 /* Add in some extras, and do so either when we successfully loaded something or when /proc/swaps is
364 if (u
->load_state
== UNIT_LOADED
|| s
->from_proc_swaps
)
365 q
= swap_add_extras(s
);
371 if (u
->load_state
!= UNIT_LOADED
)
374 return swap_verify(s
);
377 static int swap_setup_unit(
380 const char *what_proc_swaps
,
384 _cleanup_free_
char *e
= NULL
;
392 assert(what_proc_swaps
);
394 r
= unit_name_from_path(what
, ".swap", &e
);
396 return log_unit_error_errno(u
, r
, "Failed to generate unit name from path: %m");
398 u
= manager_get_unit(m
, e
);
400 SWAP(u
)->from_proc_swaps
&&
401 !path_equal(SWAP(u
)->parameters_proc_swaps
.what
, what_proc_swaps
))
402 return log_error_errno(SYNTHETIC_ERRNO(EEXIST
),
403 "Swap %s appeared twice with different device paths %s and %s",
404 e
, SWAP(u
)->parameters_proc_swaps
.what
, what_proc_swaps
);
409 r
= unit_new_for_name(m
, sizeof(Swap
), e
, &u
);
411 log_unit_warning_errno(u
, r
, "Failed to load swap unit: %m");
415 SWAP(u
)->what
= strdup(what
);
416 if (!SWAP(u
)->what
) {
421 unit_add_to_load_queue(u
);
425 p
= &SWAP(u
)->parameters_proc_swaps
;
428 p
->what
= strdup(what_proc_swaps
);
435 /* The unit is definitely around now, mark it as loaded if it was previously referenced but could not be
436 * loaded. After all we can load it now, from the data in /proc/swaps. */
437 if (IN_SET(u
->load_state
, UNIT_NOT_FOUND
, UNIT_BAD_SETTING
, UNIT_ERROR
)) {
438 u
->load_state
= UNIT_LOADED
;
443 SWAP(u
)->is_active
= true;
444 SWAP(u
)->just_activated
= !SWAP(u
)->from_proc_swaps
;
447 SWAP(u
)->from_proc_swaps
= true;
449 p
->priority
= priority
;
450 p
->priority_set
= true;
452 unit_add_to_dbus_queue(u
);
462 static void swap_process_new(Manager
*m
, const char *device
, int prio
, bool set_flags
) {
463 _cleanup_(sd_device_unrefp
) sd_device
*d
= NULL
;
465 struct stat st
, st_link
;
470 if (swap_setup_unit(m
, device
, device
, prio
, set_flags
) < 0)
473 /* If this is a block device, then let's add duplicates for
474 * all other names of this block device */
475 if (stat(device
, &st
) < 0 || !S_ISBLK(st
.st_mode
))
478 r
= sd_device_new_from_stat_rdev(&d
, &st
);
480 return (void) log_full_errno(r
== -ENOENT
? LOG_DEBUG
: LOG_WARNING
, r
,
481 "Failed to allocate device for swap %s: %m", device
);
483 /* Add the main device node */
484 if (sd_device_get_devname(d
, &dn
) >= 0 && !streq(dn
, device
))
485 (void) swap_setup_unit(m
, dn
, device
, prio
, set_flags
);
487 /* Add additional units for all symlinks */
488 FOREACH_DEVICE_DEVLINK(d
, devlink
) {
490 /* Don't bother with the /dev/block links */
491 if (streq(devlink
, device
))
494 if (path_startswith(devlink
, "/dev/block/"))
497 if (stat(devlink
, &st_link
) >= 0 &&
498 (!S_ISBLK(st_link
.st_mode
) ||
499 st_link
.st_rdev
!= st
.st_rdev
))
502 (void) swap_setup_unit(m
, devlink
, device
, prio
, set_flags
);
506 static void swap_set_state(Swap
*s
, SwapState state
) {
511 if (s
->state
!= state
)
512 bus_unit_send_pending_change_signal(UNIT(s
), false);
514 old_state
= s
->state
;
517 if (!SWAP_STATE_WITH_PROCESS(state
)) {
518 s
->timer_event_source
= sd_event_source_disable_unref(s
->timer_event_source
);
519 swap_unwatch_control_pid(s
);
520 s
->control_command
= NULL
;
521 s
->control_command_id
= _SWAP_EXEC_COMMAND_INVALID
;
524 if (state
!= old_state
)
525 log_unit_debug(UNIT(s
), "Changed %s -> %s", swap_state_to_string(old_state
), swap_state_to_string(state
));
527 unit_notify(UNIT(s
), state_translation_table
[old_state
], state_translation_table
[state
], /* reload_success = */ true);
529 /* If there other units for the same device node have a job
530 queued it might be worth checking again if it is runnable
531 now. This is necessary, since swap_start() refuses
532 operation with EAGAIN if there's already another job for
533 the same device node queued. */
534 LIST_FOREACH_OTHERS(same_devnode
, other
, s
)
535 if (UNIT(other
)->job
)
536 job_add_to_run_queue(UNIT(other
)->job
);
539 static int swap_coldplug(Unit
*u
) {
541 SwapState new_state
= SWAP_DEAD
;
545 assert(s
->state
== SWAP_DEAD
);
547 if (s
->deserialized_state
!= s
->state
)
548 new_state
= s
->deserialized_state
;
549 else if (s
->from_proc_swaps
)
550 new_state
= SWAP_ACTIVE
;
552 if (new_state
== s
->state
)
555 if (pidref_is_set(&s
->control_pid
) &&
556 pidref_is_unwaited(&s
->control_pid
) > 0 &&
557 SWAP_STATE_WITH_PROCESS(new_state
)) {
559 r
= unit_watch_pidref(UNIT(s
), &s
->control_pid
, /* exclusive= */ false);
563 r
= swap_arm_timer(s
, /* relative= */ false, usec_add(u
->state_change_timestamp
.monotonic
, s
->timeout_usec
));
568 if (!IN_SET(new_state
, SWAP_DEAD
, SWAP_FAILED
)) {
569 (void) unit_setup_exec_runtime(u
);
570 (void) unit_setup_cgroup_runtime(u
);
573 swap_set_state(s
, new_state
);
577 static void swap_dump(Unit
*u
, FILE *f
, const char *prefix
) {
584 if (s
->from_proc_swaps
)
585 p
= &s
->parameters_proc_swaps
;
586 else if (s
->from_fragment
)
587 p
= &s
->parameters_fragment
;
594 "%sClean Result: %s\n"
596 "%sFrom /proc/swaps: %s\n"
597 "%sFrom fragment: %s\n"
599 prefix
, swap_state_to_string(s
->state
),
600 prefix
, swap_result_to_string(s
->result
),
601 prefix
, swap_result_to_string(s
->clean_result
),
603 prefix
, yes_no(s
->from_proc_swaps
),
604 prefix
, yes_no(s
->from_fragment
),
605 prefix
, yes_no(swap_is_extrinsic(u
)));
608 fprintf(f
, "%sDevice Node: %s\n", prefix
, s
->devnode
);
615 prefix
, strempty(p
->options
));
618 "%sTimeoutSec: %s\n",
619 prefix
, FORMAT_TIMESPAN(s
->timeout_usec
, USEC_PER_SEC
));
621 if (pidref_is_set(&s
->control_pid
))
623 "%sControl PID: "PID_FMT
"\n",
624 prefix
, s
->control_pid
.pid
);
626 exec_context_dump(&s
->exec_context
, f
, prefix
);
627 kill_context_dump(&s
->kill_context
, f
, prefix
);
628 cgroup_context_dump(UNIT(s
), f
, prefix
);
631 static int swap_spawn(Swap
*s
, ExecCommand
*c
, PidRef
*ret_pid
) {
633 _cleanup_(exec_params_shallow_clear
) ExecParameters exec_params
= EXEC_PARAMETERS_INIT(
634 EXEC_APPLY_SANDBOXING
|EXEC_APPLY_CHROOT
|EXEC_APPLY_TTY_STDIN
);
635 _cleanup_(pidref_done
) PidRef pidref
= PIDREF_NULL
;
642 r
= unit_prepare_exec(UNIT(s
));
646 r
= swap_arm_timer(s
, /* relative= */ true, s
->timeout_usec
);
650 r
= unit_set_exec_params(UNIT(s
), &exec_params
);
654 r
= exec_spawn(UNIT(s
),
664 r
= unit_watch_pidref(UNIT(s
), &pidref
, /* exclusive= */ true);
668 *ret_pid
= TAKE_PIDREF(pidref
);
672 static void swap_enter_dead(Swap
*s
, SwapResult f
) {
675 if (s
->result
== SWAP_SUCCESS
)
678 unit_log_result(UNIT(s
), s
->result
== SWAP_SUCCESS
, swap_result_to_string(s
->result
));
679 unit_warn_leftover_processes(UNIT(s
), unit_log_leftover_process_stop
);
680 swap_set_state(s
, s
->result
!= SWAP_SUCCESS
? SWAP_FAILED
: SWAP_DEAD
);
682 s
->exec_runtime
= exec_runtime_destroy(s
->exec_runtime
);
684 unit_destroy_runtime_data(UNIT(s
), &s
->exec_context
);
686 unit_unref_uid_gid(UNIT(s
), true);
689 static void swap_enter_active(Swap
*s
, SwapResult f
) {
692 if (s
->result
== SWAP_SUCCESS
)
695 swap_set_state(s
, SWAP_ACTIVE
);
698 static void swap_enter_dead_or_active(Swap
*s
, SwapResult f
) {
701 if (s
->from_proc_swaps
) {
702 swap_enter_active(s
, f
);
704 LIST_FOREACH_OTHERS(same_devnode
, other
, s
)
705 if (UNIT(other
)->job
)
706 swap_enter_dead_or_active(other
, f
);
708 swap_enter_dead(s
, f
);
711 static int state_to_kill_operation(Swap
*s
, SwapState state
) {
712 if (state
== SWAP_DEACTIVATING_SIGTERM
) {
713 if (unit_has_job_type(UNIT(s
), JOB_RESTART
))
716 return KILL_TERMINATE
;
722 static void swap_enter_signal(Swap
*s
, SwapState state
, SwapResult f
) {
727 if (s
->result
== SWAP_SUCCESS
)
730 r
= unit_kill_context(UNIT(s
), state_to_kill_operation(s
, state
));
732 log_unit_warning_errno(UNIT(s
), r
, "Failed to kill processes: %m");
737 r
= swap_arm_timer(s
, /* relative= */ true, s
->timeout_usec
);
739 log_unit_warning_errno(UNIT(s
), r
, "Failed to install timer: %m");
743 swap_set_state(s
, state
);
744 } else if (state
== SWAP_DEACTIVATING_SIGTERM
&& s
->kill_context
.send_sigkill
)
745 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGKILL
, SWAP_SUCCESS
);
747 swap_enter_dead_or_active(s
, SWAP_SUCCESS
);
752 swap_enter_dead_or_active(s
, SWAP_FAILURE_RESOURCES
);
755 static void swap_enter_activating(Swap
*s
) {
756 _cleanup_free_
char *opts
= NULL
;
761 unit_warn_leftover_processes(UNIT(s
), unit_log_leftover_process_start
);
763 s
->control_command_id
= SWAP_EXEC_ACTIVATE
;
764 s
->control_command
= s
->exec_command
+ SWAP_EXEC_ACTIVATE
;
766 if (s
->from_fragment
) {
769 r
= fstab_find_pri(s
->parameters_fragment
.options
, &priority
);
771 log_unit_warning_errno(UNIT(s
), r
, "Failed to parse swap priority \"%s\", ignoring: %m", s
->parameters_fragment
.options
);
772 else if (r
> 0 && s
->parameters_fragment
.priority_set
)
773 log_unit_warning(UNIT(s
), "Duplicate swap priority configuration by Priority= and Options= fields.");
775 if (r
<= 0 && s
->parameters_fragment
.priority_set
) {
776 if (s
->parameters_fragment
.options
)
777 r
= asprintf(&opts
, "%s,pri=%i", s
->parameters_fragment
.options
, s
->parameters_fragment
.priority
);
779 r
= asprintf(&opts
, "pri=%i", s
->parameters_fragment
.priority
);
787 r
= exec_command_set(s
->control_command
, "/sbin/swapon", "--fixpgsz", NULL
);
789 log_unit_warning_errno(UNIT(s
), r
, "Failed to initialize swapon command line: %m");
793 if (s
->parameters_fragment
.options
|| opts
) {
794 r
= exec_command_append(s
->control_command
, "-o",
795 opts
?: s
->parameters_fragment
.options
, NULL
);
797 log_unit_warning_errno(UNIT(s
), r
, "Failed to prepare swapon command line: %m");
802 r
= exec_command_append(s
->control_command
, s
->what
, NULL
);
804 log_unit_warning_errno(UNIT(s
), r
, "Failed to prepare swapon command line: %m");
808 swap_unwatch_control_pid(s
);
810 r
= swap_spawn(s
, s
->control_command
, &s
->control_pid
);
812 log_unit_warning_errno(UNIT(s
), r
, "Failed to spawn 'swapon' task: %m");
816 swap_set_state(s
, SWAP_ACTIVATING
);
820 swap_enter_dead_or_active(s
, SWAP_FAILURE_RESOURCES
);
823 static void swap_enter_deactivating(Swap
*s
) {
828 s
->control_command_id
= SWAP_EXEC_DEACTIVATE
;
829 s
->control_command
= s
->exec_command
+ SWAP_EXEC_DEACTIVATE
;
831 r
= exec_command_set(s
->control_command
,
836 log_unit_warning_errno(UNIT(s
), r
, "Failed to prepare swapoff command line: %m");
840 swap_unwatch_control_pid(s
);
842 r
= swap_spawn(s
, s
->control_command
, &s
->control_pid
);
844 log_unit_warning_errno(UNIT(s
), r
, "Failed to spawn 'swapoff' task: %m");
848 swap_set_state(s
, SWAP_DEACTIVATING
);
852 swap_enter_dead_or_active(s
, SWAP_FAILURE_RESOURCES
);
855 static void swap_cycle_clear(Swap
*s
) {
858 s
->result
= SWAP_SUCCESS
;
859 exec_command_reset_status_array(s
->exec_command
, _SWAP_EXEC_COMMAND_MAX
);
861 if (s
->cgroup_runtime
)
862 s
->cgroup_runtime
->reset_accounting
= true;
865 static int swap_start(Unit
*u
) {
871 /* We cannot fulfill this request right now, try again later please! */
874 SWAP_DEACTIVATING_SIGTERM
,
875 SWAP_DEACTIVATING_SIGKILL
,
880 if (s
->state
== SWAP_ACTIVATING
)
883 assert(IN_SET(s
->state
, SWAP_DEAD
, SWAP_FAILED
));
885 if (detect_container() > 0)
888 /* If there's a job for another swap unit for the same node
889 * running, then let's not dispatch this one for now, and wait
890 * until that other job has finished. */
891 LIST_FOREACH_OTHERS(same_devnode
, other
, s
)
892 if (UNIT(other
)->job
&& UNIT(other
)->job
->state
== JOB_RUNNING
)
895 r
= unit_acquire_invocation_id(u
);
900 swap_enter_activating(s
);
904 static int swap_stop(Unit
*u
) {
911 case SWAP_DEACTIVATING
:
912 case SWAP_DEACTIVATING_SIGTERM
:
913 case SWAP_DEACTIVATING_SIGKILL
:
917 case SWAP_ACTIVATING
:
918 case SWAP_ACTIVATING_DONE
:
919 /* There's a control process pending, directly enter kill mode */
920 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGTERM
, SWAP_SUCCESS
);
924 if (detect_container() > 0)
927 swap_enter_deactivating(s
);
931 /* If we are currently cleaning, then abort it, brutally. */
932 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGKILL
, SWAP_SUCCESS
);
936 assert_not_reached();
940 static int swap_serialize(Unit
*u
, FILE *f
, FDSet
*fds
) {
947 (void) serialize_item(f
, "state", swap_state_to_string(s
->state
));
948 (void) serialize_item(f
, "result", swap_result_to_string(s
->result
));
949 (void) serialize_pidref(f
, fds
, "control-pid", &s
->control_pid
);
951 if (s
->control_command_id
>= 0)
952 (void) serialize_item(f
, "control-command", swap_exec_command_to_string(s
->control_command_id
));
957 static int swap_deserialize_item(Unit
*u
, const char *key
, const char *value
, FDSet
*fds
) {
963 if (streq(key
, "state")) {
966 state
= swap_state_from_string(value
);
968 log_unit_debug(u
, "Failed to parse state value: %s", value
);
970 s
->deserialized_state
= state
;
971 } else if (streq(key
, "result")) {
974 f
= swap_result_from_string(value
);
976 log_unit_debug(u
, "Failed to parse result value: %s", value
);
977 else if (f
!= SWAP_SUCCESS
)
979 } else if (streq(key
, "control-pid")) {
981 pidref_done(&s
->control_pid
);
982 (void) deserialize_pidref(fds
, value
, &s
->control_pid
);
984 } else if (streq(key
, "control-command")) {
987 id
= swap_exec_command_from_string(value
);
989 log_unit_debug(u
, "Failed to parse exec-command value: %s", value
);
991 s
->control_command_id
= id
;
992 s
->control_command
= s
->exec_command
+ id
;
995 log_unit_debug(u
, "Unknown serialization key: %s", key
);
1000 static void swap_sigchld_event(Unit
*u
, pid_t pid
, int code
, int status
) {
1007 if (pid
!= s
->control_pid
.pid
)
1010 /* Let's scan /proc/swaps before we process SIGCHLD. For the reasoning see the similar code in
1012 (void) swap_process_proc_swaps(u
->manager
);
1014 pidref_done(&s
->control_pid
);
1016 if (is_clean_exit(code
, status
, EXIT_CLEAN_COMMAND
, NULL
))
1018 else if (code
== CLD_EXITED
)
1019 f
= SWAP_FAILURE_EXIT_CODE
;
1020 else if (code
== CLD_KILLED
)
1021 f
= SWAP_FAILURE_SIGNAL
;
1022 else if (code
== CLD_DUMPED
)
1023 f
= SWAP_FAILURE_CORE_DUMP
;
1025 assert_not_reached();
1027 if (s
->result
== SWAP_SUCCESS
)
1030 if (s
->control_command
) {
1031 exec_status_exit(&s
->control_command
->exec_status
, &s
->exec_context
, pid
, code
, status
);
1033 s
->control_command
= NULL
;
1034 s
->control_command_id
= _SWAP_EXEC_COMMAND_INVALID
;
1037 unit_log_process_exit(
1040 swap_exec_command_to_string(s
->control_command_id
),
1046 case SWAP_ACTIVATING
:
1047 case SWAP_ACTIVATING_DONE
:
1049 if (f
== SWAP_SUCCESS
|| s
->from_proc_swaps
)
1050 swap_enter_active(s
, f
);
1052 swap_enter_dead(s
, f
);
1055 case SWAP_DEACTIVATING
:
1056 case SWAP_DEACTIVATING_SIGKILL
:
1057 case SWAP_DEACTIVATING_SIGTERM
:
1059 swap_enter_dead_or_active(s
, f
);
1063 if (s
->clean_result
== SWAP_SUCCESS
)
1064 s
->clean_result
= f
;
1066 swap_enter_dead(s
, SWAP_SUCCESS
);
1070 assert_not_reached();
1073 /* Notify clients about changed exit status */
1074 unit_add_to_dbus_queue(u
);
1077 static int swap_dispatch_timer(sd_event_source
*source
, usec_t usec
, void *userdata
) {
1078 Swap
*s
= SWAP(userdata
);
1081 assert(s
->timer_event_source
== source
);
1085 case SWAP_ACTIVATING
:
1086 case SWAP_ACTIVATING_DONE
:
1087 log_unit_warning(UNIT(s
), "Activation timed out. Stopping.");
1088 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGTERM
, SWAP_FAILURE_TIMEOUT
);
1091 case SWAP_DEACTIVATING
:
1092 log_unit_warning(UNIT(s
), "Deactivation timed out. Stopping.");
1093 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGTERM
, SWAP_FAILURE_TIMEOUT
);
1096 case SWAP_DEACTIVATING_SIGTERM
:
1097 if (s
->kill_context
.send_sigkill
) {
1098 log_unit_warning(UNIT(s
), "Swap process timed out. Killing.");
1099 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGKILL
, SWAP_FAILURE_TIMEOUT
);
1101 log_unit_warning(UNIT(s
), "Swap process timed out. Skipping SIGKILL. Ignoring.");
1102 swap_enter_dead_or_active(s
, SWAP_FAILURE_TIMEOUT
);
1106 case SWAP_DEACTIVATING_SIGKILL
:
1107 log_unit_warning(UNIT(s
), "Swap process still around after SIGKILL. Ignoring.");
1108 swap_enter_dead_or_active(s
, SWAP_FAILURE_TIMEOUT
);
1112 log_unit_warning(UNIT(s
), "Cleaning timed out. killing.");
1114 if (s
->clean_result
== SWAP_SUCCESS
)
1115 s
->clean_result
= SWAP_FAILURE_TIMEOUT
;
1117 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGKILL
, 0);
1121 assert_not_reached();
1127 static int swap_load_proc_swaps(Manager
*m
, bool set_flags
) {
1130 rewind(m
->proc_swaps
);
1132 (void) fscanf(m
->proc_swaps
, "%*s %*s %*s %*s %*s\n");
1134 for (unsigned i
= 1;; i
++) {
1135 _cleanup_free_
char *dev
= NULL
, *d
= NULL
;
1138 k
= fscanf(m
->proc_swaps
,
1139 "%ms " /* device/file */
1140 "%*s " /* type of swap */
1141 "%*s " /* swap size */
1143 "%i\n", /* priority */
1149 log_warning("Failed to parse /proc/swaps:%u, skipping.", i
);
1153 ssize_t l
= cunescape(dev
, UNESCAPE_RELAX
, &d
);
1155 return log_error_errno(l
, "Failed to unescape device path: %m");
1157 device_found_node(m
, d
, DEVICE_FOUND_SWAP
, DEVICE_FOUND_SWAP
);
1159 (void) swap_process_new(m
, d
, prio
, set_flags
);
1165 static int swap_process_proc_swaps(Manager
*m
) {
1170 r
= swap_load_proc_swaps(m
, true);
1172 /* Reset flags, just in case, for late calls */
1173 LIST_FOREACH(units_by_type
, u
, m
->units_by_type
[UNIT_SWAP
]) {
1174 Swap
*swap
= SWAP(u
);
1178 swap
->is_active
= swap
->just_activated
= false;
1184 manager_dispatch_load_queue(m
);
1186 LIST_FOREACH(units_by_type
, u
, m
->units_by_type
[UNIT_SWAP
]) {
1187 Swap
*swap
= SWAP(u
);
1191 if (!swap
->is_active
) {
1193 swap_unset_proc_swaps(swap
);
1195 switch (swap
->state
) {
1198 /* This has just been deactivated */
1199 swap_enter_dead(swap
, SWAP_SUCCESS
);
1204 swap_set_state(swap
, swap
->state
);
1209 device_found_node(m
, swap
->what
, DEVICE_NOT_FOUND
, DEVICE_FOUND_SWAP
);
1211 } else if (swap
->just_activated
) {
1213 /* New swap entry */
1215 switch (swap
->state
) {
1219 (void) unit_acquire_invocation_id(u
);
1220 swap_cycle_clear(swap
);
1221 swap_enter_active(swap
, SWAP_SUCCESS
);
1224 case SWAP_ACTIVATING
:
1225 swap_set_state(swap
, SWAP_ACTIVATING_DONE
);
1229 /* Nothing really changed, but let's
1230 * issue an notification call
1231 * nonetheless, in case somebody is
1232 * waiting for this. */
1233 swap_set_state(swap
, swap
->state
);
1238 /* Reset the flags for later calls */
1239 swap
->is_active
= swap
->just_activated
= false;
1245 static int swap_dispatch_io(sd_event_source
*source
, int fd
, uint32_t revents
, void *userdata
) {
1246 Manager
*m
= ASSERT_PTR(userdata
);
1248 assert(revents
& EPOLLPRI
);
1250 return swap_process_proc_swaps(m
);
1253 static Unit
*swap_following(Unit
*u
) {
1259 /* If the user configured the swap through /etc/fstab or
1260 * a device unit, follow that. */
1262 if (s
->from_fragment
)
1265 LIST_FOREACH_OTHERS(same_devnode
, other
, s
)
1266 if (other
->from_fragment
)
1269 /* Otherwise, make everybody follow the unit that's named after
1270 * the swap device in the kernel */
1272 if (streq_ptr(s
->what
, s
->devnode
))
1275 LIST_FOREACH(same_devnode
, other
, s
->same_devnode_next
)
1276 if (streq_ptr(other
->what
, other
->devnode
))
1279 LIST_FOREACH_BACKWARDS(same_devnode
, other
, s
->same_devnode_prev
) {
1280 if (streq_ptr(other
->what
, other
->devnode
))
1286 /* Fall back to the first on the list */
1290 static int swap_following_set(Unit
*u
, Set
**_set
) {
1292 _cleanup_set_free_ Set
*set
= NULL
;
1298 if (LIST_JUST_US(same_devnode
, s
)) {
1303 set
= set_new(NULL
);
1307 LIST_FOREACH_OTHERS(same_devnode
, other
, s
) {
1308 r
= set_put(set
, other
);
1313 *_set
= TAKE_PTR(set
);
1317 static void swap_shutdown(Manager
*m
) {
1320 m
->swap_event_source
= sd_event_source_disable_unref(m
->swap_event_source
);
1321 m
->proc_swaps
= safe_fclose(m
->proc_swaps
);
1322 m
->swaps_by_devnode
= hashmap_free(m
->swaps_by_devnode
);
1325 static void swap_enumerate(Manager
*m
) {
1330 if (!m
->proc_swaps
) {
1331 m
->proc_swaps
= fopen("/proc/swaps", "re");
1332 if (!m
->proc_swaps
) {
1333 if (errno
== ENOENT
)
1334 log_debug_errno(errno
, "Not swap enabled, skipping enumeration.");
1336 log_warning_errno(errno
, "Failed to open /proc/swaps, ignoring: %m");
1341 r
= sd_event_add_io(m
->event
, &m
->swap_event_source
, fileno(m
->proc_swaps
), EPOLLPRI
, swap_dispatch_io
, m
);
1343 log_error_errno(r
, "Failed to watch /proc/swaps: %m");
1347 /* Dispatch this before we dispatch SIGCHLD, so that
1348 * we always get the events from /proc/swaps before
1349 * the SIGCHLD of /sbin/swapon. */
1350 r
= sd_event_source_set_priority(m
->swap_event_source
, EVENT_PRIORITY_SWAP_TABLE
);
1352 log_error_errno(r
, "Failed to change /proc/swaps priority: %m");
1356 (void) sd_event_source_set_description(m
->swap_event_source
, "swap-proc");
1359 r
= swap_load_proc_swaps(m
, false);
1369 int swap_process_device_new(Manager
*m
, sd_device
*dev
) {
1370 _cleanup_free_
char *e
= NULL
;
1378 if (sd_device_get_devname(dev
, &dn
) < 0)
1381 r
= unit_name_from_path(dn
, ".swap", &e
);
1383 log_debug_errno(r
, "Cannot convert device name '%s' to unit name, ignoring: %m", dn
);
1387 u
= manager_get_unit(m
, e
);
1389 r
= swap_set_devnode(SWAP(u
), dn
);
1391 FOREACH_DEVICE_DEVLINK(dev
, devlink
) {
1392 _cleanup_free_
char *n
= NULL
;
1395 q
= unit_name_from_path(devlink
, ".swap", &n
);
1396 if (q
== -EINVAL
) /* If the name is not convertible to unit name, we can't manage it */
1401 u
= manager_get_unit(m
, n
);
1403 q
= swap_set_devnode(SWAP(u
), dn
);
1412 int swap_process_device_remove(Manager
*m
, sd_device
*dev
) {
1417 r
= sd_device_get_devname(dev
, &dn
);
1421 while ((s
= hashmap_get(m
->swaps_by_devnode
, dn
))) {
1424 q
= swap_set_devnode(s
, NULL
);
1432 static void swap_reset_failed(Unit
*u
) {
1437 if (s
->state
== SWAP_FAILED
)
1438 swap_set_state(s
, SWAP_DEAD
);
1440 s
->result
= SWAP_SUCCESS
;
1441 s
->clean_result
= SWAP_SUCCESS
;
1444 static int swap_get_timeout(Unit
*u
, usec_t
*timeout
) {
1452 if (!s
->timer_event_source
)
1455 r
= sd_event_source_get_time(s
->timer_event_source
, &t
);
1458 if (t
== USEC_INFINITY
)
1465 static bool swap_supported(void) {
1466 static int supported
= -1;
1468 /* If swap support is not available in the kernel, or we are
1469 * running in a container we don't support swap units, and any
1470 * attempts to starting one should fail immediately. */
1474 access("/proc/swaps", F_OK
) >= 0 &&
1475 detect_container() <= 0;
1480 static PidRef
* swap_control_pid(Unit
*u
) {
1481 return &ASSERT_PTR(SWAP(u
))->control_pid
;
1484 static int swap_clean(Unit
*u
, ExecCleanMask mask
) {
1485 _cleanup_strv_free_
char **l
= NULL
;
1492 if (s
->state
!= SWAP_DEAD
)
1495 r
= exec_context_get_clean_directories(&s
->exec_context
, u
->manager
->prefix
, mask
, &l
);
1499 if (strv_isempty(l
))
1502 swap_unwatch_control_pid(s
);
1503 s
->clean_result
= SWAP_SUCCESS
;
1504 s
->control_command
= NULL
;
1505 s
->control_command_id
= _SWAP_EXEC_COMMAND_INVALID
;
1507 r
= swap_arm_timer(s
, /* relative= */ true, s
->exec_context
.timeout_clean_usec
);
1509 log_unit_warning_errno(u
, r
, "Failed to install timer: %m");
1513 r
= unit_fork_and_watch_rm_rf(u
, l
, &s
->control_pid
);
1515 log_unit_warning_errno(u
, r
, "Failed to spawn cleaning task: %m");
1519 swap_set_state(s
, SWAP_CLEANING
);
1523 s
->clean_result
= SWAP_FAILURE_RESOURCES
;
1524 s
->timer_event_source
= sd_event_source_disable_unref(s
->timer_event_source
);
1528 static int swap_can_clean(Unit
*u
, ExecCleanMask
*ret
) {
1533 return exec_context_get_clean_mask(&s
->exec_context
, ret
);
1536 static int swap_can_start(Unit
*u
) {
1542 r
= unit_test_start_limit(u
);
1544 swap_enter_dead(s
, SWAP_FAILURE_START_LIMIT_HIT
);
1551 int swap_get_priority(const Swap
*s
) {
1554 if (s
->from_proc_swaps
&& s
->parameters_proc_swaps
.priority_set
)
1555 return s
->parameters_proc_swaps
.priority
;
1557 if (s
->from_fragment
&& s
->parameters_fragment
.priority_set
)
1558 return s
->parameters_fragment
.priority
;
1563 const char* swap_get_options(const Swap
*s
) {
1566 if (s
->from_fragment
)
1567 return s
->parameters_fragment
.options
;
1572 static const char* const swap_exec_command_table
[_SWAP_EXEC_COMMAND_MAX
] = {
1573 [SWAP_EXEC_ACTIVATE
] = "ExecActivate",
1574 [SWAP_EXEC_DEACTIVATE
] = "ExecDeactivate",
1577 DEFINE_STRING_TABLE_LOOKUP(swap_exec_command
, SwapExecCommand
);
1579 static const char* const swap_result_table
[_SWAP_RESULT_MAX
] = {
1580 [SWAP_SUCCESS
] = "success",
1581 [SWAP_FAILURE_RESOURCES
] = "resources",
1582 [SWAP_FAILURE_TIMEOUT
] = "timeout",
1583 [SWAP_FAILURE_EXIT_CODE
] = "exit-code",
1584 [SWAP_FAILURE_SIGNAL
] = "signal",
1585 [SWAP_FAILURE_CORE_DUMP
] = "core-dump",
1586 [SWAP_FAILURE_START_LIMIT_HIT
] = "start-limit-hit",
1589 DEFINE_STRING_TABLE_LOOKUP(swap_result
, SwapResult
);
1591 const UnitVTable swap_vtable
= {
1592 .object_size
= sizeof(Swap
),
1593 .exec_context_offset
= offsetof(Swap
, exec_context
),
1594 .cgroup_context_offset
= offsetof(Swap
, cgroup_context
),
1595 .kill_context_offset
= offsetof(Swap
, kill_context
),
1596 .exec_runtime_offset
= offsetof(Swap
, exec_runtime
),
1597 .cgroup_runtime_offset
= offsetof(Swap
, cgroup_runtime
),
1603 .private_section
= "Swap",
1611 .coldplug
= swap_coldplug
,
1615 .start
= swap_start
,
1618 .clean
= swap_clean
,
1619 .can_clean
= swap_can_clean
,
1621 .get_timeout
= swap_get_timeout
,
1623 .serialize
= swap_serialize
,
1624 .deserialize_item
= swap_deserialize_item
,
1626 .active_state
= swap_active_state
,
1627 .sub_state_to_string
= swap_sub_state_to_string
,
1629 .will_restart
= unit_will_restart_default
,
1631 .may_gc
= swap_may_gc
,
1632 .is_extrinsic
= swap_is_extrinsic
,
1634 .sigchld_event
= swap_sigchld_event
,
1636 .reset_failed
= swap_reset_failed
,
1638 .control_pid
= swap_control_pid
,
1640 .bus_set_property
= bus_swap_set_property
,
1641 .bus_commit_properties
= bus_swap_commit_properties
,
1643 .following
= swap_following
,
1644 .following_set
= swap_following_set
,
1646 .enumerate
= swap_enumerate
,
1647 .shutdown
= swap_shutdown
,
1648 .supported
= swap_supported
,
1650 .status_message_formats
= {
1651 .starting_stopping
= {
1652 [0] = "Activating swap %s...",
1653 [1] = "Deactivating swap %s...",
1655 .finished_start_job
= {
1656 [JOB_DONE
] = "Activated swap %s.",
1657 [JOB_FAILED
] = "Failed to activate swap %s.",
1658 [JOB_TIMEOUT
] = "Timed out activating swap %s.",
1660 .finished_stop_job
= {
1661 [JOB_DONE
] = "Deactivated swap %s.",
1662 [JOB_FAILED
] = "Failed deactivating swap %s.",
1663 [JOB_TIMEOUT
] = "Timed out deactivating swap %s.",
1667 .can_start
= swap_can_start
,
1669 .notify_plymouth
= true,