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
), TAKE_PID(s
->control_pid
));
161 static void swap_done(Unit
*u
) {
166 swap_unset_proc_swaps(s
);
167 swap_set_devnode(s
, NULL
);
169 s
->what
= mfree(s
->what
);
170 s
->parameters_fragment
.what
= mfree(s
->parameters_fragment
.what
);
171 s
->parameters_fragment
.options
= mfree(s
->parameters_fragment
.options
);
173 s
->exec_runtime
= exec_runtime_free(s
->exec_runtime
);
174 exec_command_done_array(s
->exec_command
, _SWAP_EXEC_COMMAND_MAX
);
175 s
->control_command
= NULL
;
177 swap_unwatch_control_pid(s
);
179 s
->timer_event_source
= sd_event_source_disable_unref(s
->timer_event_source
);
182 static int swap_arm_timer(Swap
*s
, usec_t usec
) {
187 if (s
->timer_event_source
) {
188 r
= sd_event_source_set_time(s
->timer_event_source
, usec
);
192 return sd_event_source_set_enabled(s
->timer_event_source
, SD_EVENT_ONESHOT
);
195 if (usec
== USEC_INFINITY
)
198 r
= sd_event_add_time(
199 UNIT(s
)->manager
->event
,
200 &s
->timer_event_source
,
203 swap_dispatch_timer
, s
);
207 (void) sd_event_source_set_description(s
->timer_event_source
, "swap-timer");
212 static SwapParameters
* swap_get_parameters(Swap
*s
) {
215 if (s
->from_proc_swaps
)
216 return &s
->parameters_proc_swaps
;
218 if (s
->from_fragment
)
219 return &s
->parameters_fragment
;
224 static int swap_add_device_dependencies(Swap
*s
) {
225 UnitDependencyMask mask
;
234 p
= swap_get_parameters(s
);
238 mask
= s
->from_proc_swaps
? UNIT_DEPENDENCY_PROC_SWAP
: UNIT_DEPENDENCY_FILE
;
240 if (is_device_path(p
->what
)) {
241 r
= unit_add_node_dependency(UNIT(s
), p
->what
, UNIT_REQUIRES
, mask
);
245 return unit_add_blockdev_dependency(UNIT(s
), p
->what
, mask
);
248 /* File based swap devices need to be ordered after systemd-remount-fs.service, since they might need
249 * a writable file system. */
250 return unit_add_dependency_by_name(UNIT(s
), UNIT_AFTER
, SPECIAL_REMOUNT_FS_SERVICE
, true, mask
);
253 static int swap_add_default_dependencies(Swap
*s
) {
258 if (!UNIT(s
)->default_dependencies
)
261 if (!MANAGER_IS_SYSTEM(UNIT(s
)->manager
))
264 if (detect_container() > 0)
267 /* swap units generated for the swap dev links are missing the
268 * ordering dep against the swap target. */
269 r
= unit_add_dependency_by_name(UNIT(s
), UNIT_BEFORE
, SPECIAL_SWAP_TARGET
, true, UNIT_DEPENDENCY_DEFAULT
);
273 r
= unit_add_two_dependencies_by_name(UNIT(s
), UNIT_BEFORE
, UNIT_CONFLICTS
, SPECIAL_UMOUNT_TARGET
, true, UNIT_DEPENDENCY_DEFAULT
);
277 return exec_context_add_default_dependencies(UNIT(s
), &s
->exec_context
);
280 static int swap_verify(Swap
*s
) {
281 _cleanup_free_
char *e
= NULL
;
284 assert(UNIT(s
)->load_state
== UNIT_LOADED
);
286 r
= unit_name_from_path(s
->what
, ".swap", &e
);
288 return log_unit_error_errno(UNIT(s
), r
, "Failed to generate unit name from path: %m");
290 if (!unit_has_name(UNIT(s
), e
))
291 return log_unit_error_errno(UNIT(s
), SYNTHETIC_ERRNO(ENOEXEC
), "Value of What= and unit name do not match, not loading.");
293 if (s
->exec_context
.pam_name
&& s
->kill_context
.kill_mode
!= KILL_CONTROL_GROUP
)
294 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.");
299 static int swap_load_devnode(Swap
*s
) {
300 _cleanup_free_
char *p
= NULL
;
306 if (stat(s
->what
, &st
) < 0 || !S_ISBLK(st
.st_mode
))
309 r
= devname_from_stat_rdev(&st
, &p
);
311 log_unit_full_errno(UNIT(s
), r
== -ENOENT
? LOG_DEBUG
: LOG_WARNING
, r
,
312 "Failed to get device node for swap %s: %m", s
->what
);
316 return swap_set_devnode(s
, p
);
319 static int swap_add_extras(Swap
*s
) {
324 if (UNIT(s
)->fragment_path
)
325 s
->from_fragment
= true;
328 if (s
->parameters_fragment
.what
)
329 s
->what
= strdup(s
->parameters_fragment
.what
);
330 else if (s
->parameters_proc_swaps
.what
)
331 s
->what
= strdup(s
->parameters_proc_swaps
.what
);
333 r
= unit_name_to_path(UNIT(s
)->id
, &s
->what
);
342 path_simplify(s
->what
);
344 if (!UNIT(s
)->description
) {
345 r
= unit_set_description(UNIT(s
), s
->what
);
350 r
= unit_require_mounts_for(UNIT(s
), s
->what
, UNIT_DEPENDENCY_IMPLICIT
);
354 r
= swap_add_device_dependencies(s
);
358 r
= swap_load_devnode(s
);
362 r
= unit_patch_contexts(UNIT(s
));
366 r
= unit_add_exec_dependencies(UNIT(s
), &s
->exec_context
);
370 r
= unit_set_default_slice(UNIT(s
));
374 r
= swap_add_default_dependencies(s
);
381 static int swap_load(Unit
*u
) {
386 assert(u
->load_state
== UNIT_STUB
);
388 /* Load a .swap file */
389 bool fragment_optional
= s
->from_proc_swaps
;
390 r
= unit_load_fragment_and_dropin(u
, !fragment_optional
);
392 /* Add in some extras, and do so either when we successfully loaded something or when /proc/swaps is
394 if (u
->load_state
== UNIT_LOADED
|| s
->from_proc_swaps
)
395 q
= swap_add_extras(s
);
401 if (u
->load_state
!= UNIT_LOADED
)
404 return swap_verify(s
);
407 static int swap_setup_unit(
410 const char *what_proc_swaps
,
414 _cleanup_free_
char *e
= NULL
;
422 assert(what_proc_swaps
);
424 r
= unit_name_from_path(what
, ".swap", &e
);
426 return log_unit_error_errno(u
, r
, "Failed to generate unit name from path: %m");
428 u
= manager_get_unit(m
, e
);
430 SWAP(u
)->from_proc_swaps
&&
431 !path_equal(SWAP(u
)->parameters_proc_swaps
.what
, what_proc_swaps
))
432 return log_error_errno(SYNTHETIC_ERRNO(EEXIST
),
433 "Swap %s appeared twice with different device paths %s and %s",
434 e
, SWAP(u
)->parameters_proc_swaps
.what
, what_proc_swaps
);
439 r
= unit_new_for_name(m
, sizeof(Swap
), e
, &u
);
443 SWAP(u
)->what
= strdup(what
);
444 if (!SWAP(u
)->what
) {
449 unit_add_to_load_queue(u
);
453 p
= &SWAP(u
)->parameters_proc_swaps
;
456 p
->what
= strdup(what_proc_swaps
);
463 /* The unit is definitely around now, mark it as loaded if it was previously referenced but could not be
464 * loaded. After all we can load it now, from the data in /proc/swaps. */
465 if (IN_SET(u
->load_state
, UNIT_NOT_FOUND
, UNIT_BAD_SETTING
, UNIT_ERROR
)) {
466 u
->load_state
= UNIT_LOADED
;
471 SWAP(u
)->is_active
= true;
472 SWAP(u
)->just_activated
= !SWAP(u
)->from_proc_swaps
;
475 SWAP(u
)->from_proc_swaps
= true;
477 p
->priority
= priority
;
478 p
->priority_set
= true;
480 unit_add_to_dbus_queue(u
);
484 log_unit_warning_errno(u
, r
, "Failed to load swap unit: %m");
492 static void swap_process_new(Manager
*m
, const char *device
, int prio
, bool set_flags
) {
493 _cleanup_(sd_device_unrefp
) sd_device
*d
= NULL
;
494 const char *dn
, *devlink
;
495 struct stat st
, st_link
;
500 if (swap_setup_unit(m
, device
, device
, prio
, set_flags
) < 0)
503 /* If this is a block device, then let's add duplicates for
504 * all other names of this block device */
505 if (stat(device
, &st
) < 0 || !S_ISBLK(st
.st_mode
))
508 r
= sd_device_new_from_stat_rdev(&d
, &st
);
510 return (void) log_full_errno(r
== -ENOENT
? LOG_DEBUG
: LOG_WARNING
, r
,
511 "Failed to allocate device for swap %s: %m", device
);
513 /* Add the main device node */
514 if (sd_device_get_devname(d
, &dn
) >= 0 && !streq(dn
, device
))
515 (void) swap_setup_unit(m
, dn
, device
, prio
, set_flags
);
517 /* Add additional units for all symlinks */
518 FOREACH_DEVICE_DEVLINK(d
, devlink
) {
520 /* Don't bother with the /dev/block links */
521 if (streq(devlink
, device
))
524 if (path_startswith(devlink
, "/dev/block/"))
527 if (stat(devlink
, &st_link
) >= 0 &&
528 (!S_ISBLK(st_link
.st_mode
) ||
529 st_link
.st_rdev
!= st
.st_rdev
))
532 (void) swap_setup_unit(m
, devlink
, device
, prio
, set_flags
);
536 static void swap_set_state(Swap
*s
, SwapState state
) {
541 if (s
->state
!= state
)
542 bus_unit_send_pending_change_signal(UNIT(s
), false);
544 old_state
= s
->state
;
547 if (!SWAP_STATE_WITH_PROCESS(state
)) {
548 s
->timer_event_source
= sd_event_source_disable_unref(s
->timer_event_source
);
549 swap_unwatch_control_pid(s
);
550 s
->control_command
= NULL
;
551 s
->control_command_id
= _SWAP_EXEC_COMMAND_INVALID
;
554 if (state
!= old_state
)
555 log_unit_debug(UNIT(s
), "Changed %s -> %s", swap_state_to_string(old_state
), swap_state_to_string(state
));
557 unit_notify(UNIT(s
), state_translation_table
[old_state
], state_translation_table
[state
], /* reload_success = */ true);
559 /* If there other units for the same device node have a job
560 queued it might be worth checking again if it is runnable
561 now. This is necessary, since swap_start() refuses
562 operation with EAGAIN if there's already another job for
563 the same device node queued. */
564 LIST_FOREACH_OTHERS(same_devnode
, other
, s
)
565 if (UNIT(other
)->job
)
566 job_add_to_run_queue(UNIT(other
)->job
);
569 static int swap_coldplug(Unit
*u
) {
571 SwapState new_state
= SWAP_DEAD
;
575 assert(s
->state
== SWAP_DEAD
);
577 if (s
->deserialized_state
!= s
->state
)
578 new_state
= s
->deserialized_state
;
579 else if (s
->from_proc_swaps
)
580 new_state
= SWAP_ACTIVE
;
582 if (new_state
== s
->state
)
585 if (s
->control_pid
> 0 &&
586 pid_is_unwaited(s
->control_pid
) &&
587 SWAP_STATE_WITH_PROCESS(new_state
)) {
589 r
= unit_watch_pid(UNIT(s
), s
->control_pid
, false);
593 r
= swap_arm_timer(s
, usec_add(u
->state_change_timestamp
.monotonic
, s
->timeout_usec
));
598 if (!IN_SET(new_state
, SWAP_DEAD
, SWAP_FAILED
))
599 (void) unit_setup_exec_runtime(u
);
601 swap_set_state(s
, new_state
);
605 static void swap_dump(Unit
*u
, FILE *f
, const char *prefix
) {
612 if (s
->from_proc_swaps
)
613 p
= &s
->parameters_proc_swaps
;
614 else if (s
->from_fragment
)
615 p
= &s
->parameters_fragment
;
622 "%sClean Result: %s\n"
624 "%sFrom /proc/swaps: %s\n"
625 "%sFrom fragment: %s\n"
627 prefix
, swap_state_to_string(s
->state
),
628 prefix
, swap_result_to_string(s
->result
),
629 prefix
, swap_result_to_string(s
->clean_result
),
631 prefix
, yes_no(s
->from_proc_swaps
),
632 prefix
, yes_no(s
->from_fragment
),
633 prefix
, yes_no(swap_is_extrinsic(u
)));
636 fprintf(f
, "%sDevice Node: %s\n", prefix
, s
->devnode
);
643 prefix
, strempty(p
->options
));
646 "%sTimeoutSec: %s\n",
647 prefix
, FORMAT_TIMESPAN(s
->timeout_usec
, USEC_PER_SEC
));
649 if (s
->control_pid
> 0)
651 "%sControl PID: "PID_FMT
"\n",
652 prefix
, s
->control_pid
);
654 exec_context_dump(&s
->exec_context
, f
, prefix
);
655 kill_context_dump(&s
->kill_context
, f
, prefix
);
656 cgroup_context_dump(UNIT(s
), f
, prefix
);
659 static int swap_spawn(Swap
*s
, ExecCommand
*c
, pid_t
*_pid
) {
661 _cleanup_(exec_params_clear
) ExecParameters exec_params
= {
662 .flags
= EXEC_APPLY_SANDBOXING
|EXEC_APPLY_CHROOT
|EXEC_APPLY_TTY_STDIN
,
675 r
= unit_prepare_exec(UNIT(s
));
679 r
= swap_arm_timer(s
, usec_add(now(CLOCK_MONOTONIC
), s
->timeout_usec
));
683 r
= unit_set_exec_params(UNIT(s
), &exec_params
);
687 r
= exec_spawn(UNIT(s
),
697 r
= unit_watch_pid(UNIT(s
), pid
, true);
706 s
->timer_event_source
= sd_event_source_disable_unref(s
->timer_event_source
);
711 static void swap_enter_dead(Swap
*s
, SwapResult f
) {
714 if (s
->result
== SWAP_SUCCESS
)
717 unit_log_result(UNIT(s
), s
->result
== SWAP_SUCCESS
, swap_result_to_string(s
->result
));
718 unit_warn_leftover_processes(UNIT(s
), unit_log_leftover_process_stop
);
719 swap_set_state(s
, s
->result
!= SWAP_SUCCESS
? SWAP_FAILED
: SWAP_DEAD
);
721 s
->exec_runtime
= exec_runtime_destroy(s
->exec_runtime
);
723 unit_destroy_runtime_data(UNIT(s
), &s
->exec_context
);
725 unit_unref_uid_gid(UNIT(s
), true);
728 static void swap_enter_active(Swap
*s
, SwapResult f
) {
731 if (s
->result
== SWAP_SUCCESS
)
734 swap_set_state(s
, SWAP_ACTIVE
);
737 static void swap_enter_dead_or_active(Swap
*s
, SwapResult f
) {
740 if (s
->from_proc_swaps
) {
741 swap_enter_active(s
, f
);
743 LIST_FOREACH_OTHERS(same_devnode
, other
, s
)
744 if (UNIT(other
)->job
)
745 swap_enter_dead_or_active(other
, f
);
747 swap_enter_dead(s
, f
);
750 static int state_to_kill_operation(Swap
*s
, SwapState state
) {
751 if (state
== SWAP_DEACTIVATING_SIGTERM
) {
752 if (unit_has_job_type(UNIT(s
), JOB_RESTART
))
755 return KILL_TERMINATE
;
761 static void swap_enter_signal(Swap
*s
, SwapState state
, SwapResult f
) {
766 if (s
->result
== SWAP_SUCCESS
)
769 r
= unit_kill_context(UNIT(s
),
771 state_to_kill_operation(s
, state
),
779 r
= swap_arm_timer(s
, usec_add(now(CLOCK_MONOTONIC
), s
->timeout_usec
));
783 swap_set_state(s
, state
);
784 } else if (state
== SWAP_DEACTIVATING_SIGTERM
&& s
->kill_context
.send_sigkill
)
785 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGKILL
, SWAP_SUCCESS
);
787 swap_enter_dead_or_active(s
, SWAP_SUCCESS
);
792 log_unit_warning_errno(UNIT(s
), r
, "Failed to kill processes: %m");
793 swap_enter_dead_or_active(s
, SWAP_FAILURE_RESOURCES
);
796 static void swap_enter_activating(Swap
*s
) {
797 _cleanup_free_
char *opts
= NULL
;
802 unit_warn_leftover_processes(UNIT(s
), unit_log_leftover_process_start
);
804 s
->control_command_id
= SWAP_EXEC_ACTIVATE
;
805 s
->control_command
= s
->exec_command
+ SWAP_EXEC_ACTIVATE
;
807 if (s
->from_fragment
) {
810 r
= fstab_find_pri(s
->parameters_fragment
.options
, &priority
);
812 log_unit_warning_errno(UNIT(s
), r
, "Failed to parse swap priority \"%s\", ignoring: %m", s
->parameters_fragment
.options
);
813 else if (r
> 0 && s
->parameters_fragment
.priority_set
)
814 log_unit_warning(UNIT(s
), "Duplicate swap priority configuration by Priority= and Options= fields.");
816 if (r
<= 0 && s
->parameters_fragment
.priority_set
) {
817 if (s
->parameters_fragment
.options
)
818 r
= asprintf(&opts
, "%s,pri=%i", s
->parameters_fragment
.options
, s
->parameters_fragment
.priority
);
820 r
= asprintf(&opts
, "pri=%i", s
->parameters_fragment
.priority
);
828 r
= exec_command_set(s
->control_command
, "/sbin/swapon", "--fixpgsz", NULL
);
832 if (s
->parameters_fragment
.options
|| opts
) {
833 r
= exec_command_append(s
->control_command
, "-o",
834 opts
?: s
->parameters_fragment
.options
, NULL
);
839 r
= exec_command_append(s
->control_command
, s
->what
, NULL
);
843 swap_unwatch_control_pid(s
);
845 r
= swap_spawn(s
, s
->control_command
, &s
->control_pid
);
849 swap_set_state(s
, SWAP_ACTIVATING
);
853 log_unit_warning_errno(UNIT(s
), r
, "Failed to run 'swapon' task: %m");
854 swap_enter_dead_or_active(s
, SWAP_FAILURE_RESOURCES
);
857 static void swap_enter_deactivating(Swap
*s
) {
862 s
->control_command_id
= SWAP_EXEC_DEACTIVATE
;
863 s
->control_command
= s
->exec_command
+ SWAP_EXEC_DEACTIVATE
;
865 r
= exec_command_set(s
->control_command
,
872 swap_unwatch_control_pid(s
);
874 r
= swap_spawn(s
, s
->control_command
, &s
->control_pid
);
878 swap_set_state(s
, SWAP_DEACTIVATING
);
883 log_unit_warning_errno(UNIT(s
), r
, "Failed to run 'swapoff' task: %m");
884 swap_enter_dead_or_active(s
, SWAP_FAILURE_RESOURCES
);
887 static void swap_cycle_clear(Swap
*s
) {
890 s
->result
= SWAP_SUCCESS
;
891 exec_command_reset_status_array(s
->exec_command
, _SWAP_EXEC_COMMAND_MAX
);
892 UNIT(s
)->reset_accounting
= true;
895 static int swap_start(Unit
*u
) {
901 /* We cannot fulfill this request right now, try again later please! */
904 SWAP_DEACTIVATING_SIGTERM
,
905 SWAP_DEACTIVATING_SIGKILL
,
910 if (s
->state
== SWAP_ACTIVATING
)
913 assert(IN_SET(s
->state
, SWAP_DEAD
, SWAP_FAILED
));
915 if (detect_container() > 0)
918 /* If there's a job for another swap unit for the same node
919 * running, then let's not dispatch this one for now, and wait
920 * until that other job has finished. */
921 LIST_FOREACH_OTHERS(same_devnode
, other
, s
)
922 if (UNIT(other
)->job
&& UNIT(other
)->job
->state
== JOB_RUNNING
)
925 r
= unit_acquire_invocation_id(u
);
930 swap_enter_activating(s
);
934 static int swap_stop(Unit
*u
) {
941 case SWAP_DEACTIVATING
:
942 case SWAP_DEACTIVATING_SIGTERM
:
943 case SWAP_DEACTIVATING_SIGKILL
:
947 case SWAP_ACTIVATING
:
948 case SWAP_ACTIVATING_DONE
:
949 /* There's a control process pending, directly enter kill mode */
950 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGTERM
, SWAP_SUCCESS
);
954 if (detect_container() > 0)
957 swap_enter_deactivating(s
);
961 /* If we are currently cleaning, then abort it, brutally. */
962 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGKILL
, SWAP_SUCCESS
);
966 assert_not_reached();
970 static int swap_serialize(Unit
*u
, FILE *f
, FDSet
*fds
) {
977 (void) serialize_item(f
, "state", swap_state_to_string(s
->state
));
978 (void) serialize_item(f
, "result", swap_result_to_string(s
->result
));
980 if (s
->control_pid
> 0)
981 (void) serialize_item_format(f
, "control-pid", PID_FMT
, s
->control_pid
);
983 if (s
->control_command_id
>= 0)
984 (void) serialize_item(f
, "control-command", swap_exec_command_to_string(s
->control_command_id
));
989 static int swap_deserialize_item(Unit
*u
, const char *key
, const char *value
, FDSet
*fds
) {
995 if (streq(key
, "state")) {
998 state
= swap_state_from_string(value
);
1000 log_unit_debug(u
, "Failed to parse state value: %s", value
);
1002 s
->deserialized_state
= state
;
1003 } else if (streq(key
, "result")) {
1006 f
= swap_result_from_string(value
);
1008 log_unit_debug(u
, "Failed to parse result value: %s", value
);
1009 else if (f
!= SWAP_SUCCESS
)
1011 } else if (streq(key
, "control-pid")) {
1014 if (parse_pid(value
, &pid
) < 0)
1015 log_unit_debug(u
, "Failed to parse control-pid value: %s", value
);
1017 s
->control_pid
= pid
;
1019 } else if (streq(key
, "control-command")) {
1022 id
= swap_exec_command_from_string(value
);
1024 log_unit_debug(u
, "Failed to parse exec-command value: %s", value
);
1026 s
->control_command_id
= id
;
1027 s
->control_command
= s
->exec_command
+ id
;
1030 log_unit_debug(u
, "Unknown serialization key: %s", key
);
1035 static void swap_sigchld_event(Unit
*u
, pid_t pid
, int code
, int status
) {
1042 if (pid
!= s
->control_pid
)
1045 /* Let's scan /proc/swaps before we process SIGCHLD. For the reasoning see the similar code in
1047 (void) swap_process_proc_swaps(u
->manager
);
1051 if (is_clean_exit(code
, status
, EXIT_CLEAN_COMMAND
, NULL
))
1053 else if (code
== CLD_EXITED
)
1054 f
= SWAP_FAILURE_EXIT_CODE
;
1055 else if (code
== CLD_KILLED
)
1056 f
= SWAP_FAILURE_SIGNAL
;
1057 else if (code
== CLD_DUMPED
)
1058 f
= SWAP_FAILURE_CORE_DUMP
;
1060 assert_not_reached();
1062 if (s
->result
== SWAP_SUCCESS
)
1065 if (s
->control_command
) {
1066 exec_status_exit(&s
->control_command
->exec_status
, &s
->exec_context
, pid
, code
, status
);
1068 s
->control_command
= NULL
;
1069 s
->control_command_id
= _SWAP_EXEC_COMMAND_INVALID
;
1072 unit_log_process_exit(
1075 swap_exec_command_to_string(s
->control_command_id
),
1081 case SWAP_ACTIVATING
:
1082 case SWAP_ACTIVATING_DONE
:
1084 if (f
== SWAP_SUCCESS
|| s
->from_proc_swaps
)
1085 swap_enter_active(s
, f
);
1087 swap_enter_dead(s
, f
);
1090 case SWAP_DEACTIVATING
:
1091 case SWAP_DEACTIVATING_SIGKILL
:
1092 case SWAP_DEACTIVATING_SIGTERM
:
1094 swap_enter_dead_or_active(s
, f
);
1098 if (s
->clean_result
== SWAP_SUCCESS
)
1099 s
->clean_result
= f
;
1101 swap_enter_dead(s
, SWAP_SUCCESS
);
1105 assert_not_reached();
1108 /* Notify clients about changed exit status */
1109 unit_add_to_dbus_queue(u
);
1112 static int swap_dispatch_timer(sd_event_source
*source
, usec_t usec
, void *userdata
) {
1113 Swap
*s
= SWAP(userdata
);
1116 assert(s
->timer_event_source
== source
);
1120 case SWAP_ACTIVATING
:
1121 case SWAP_ACTIVATING_DONE
:
1122 log_unit_warning(UNIT(s
), "Activation timed out. Stopping.");
1123 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGTERM
, SWAP_FAILURE_TIMEOUT
);
1126 case SWAP_DEACTIVATING
:
1127 log_unit_warning(UNIT(s
), "Deactivation timed out. Stopping.");
1128 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGTERM
, SWAP_FAILURE_TIMEOUT
);
1131 case SWAP_DEACTIVATING_SIGTERM
:
1132 if (s
->kill_context
.send_sigkill
) {
1133 log_unit_warning(UNIT(s
), "Swap process timed out. Killing.");
1134 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGKILL
, SWAP_FAILURE_TIMEOUT
);
1136 log_unit_warning(UNIT(s
), "Swap process timed out. Skipping SIGKILL. Ignoring.");
1137 swap_enter_dead_or_active(s
, SWAP_FAILURE_TIMEOUT
);
1141 case SWAP_DEACTIVATING_SIGKILL
:
1142 log_unit_warning(UNIT(s
), "Swap process still around after SIGKILL. Ignoring.");
1143 swap_enter_dead_or_active(s
, SWAP_FAILURE_TIMEOUT
);
1147 log_unit_warning(UNIT(s
), "Cleaning timed out. killing.");
1149 if (s
->clean_result
== SWAP_SUCCESS
)
1150 s
->clean_result
= SWAP_FAILURE_TIMEOUT
;
1152 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGKILL
, 0);
1156 assert_not_reached();
1162 static int swap_load_proc_swaps(Manager
*m
, bool set_flags
) {
1165 rewind(m
->proc_swaps
);
1167 (void) fscanf(m
->proc_swaps
, "%*s %*s %*s %*s %*s\n");
1169 for (unsigned i
= 1;; i
++) {
1170 _cleanup_free_
char *dev
= NULL
, *d
= NULL
;
1173 k
= fscanf(m
->proc_swaps
,
1174 "%ms " /* device/file */
1175 "%*s " /* type of swap */
1176 "%*s " /* swap size */
1178 "%i\n", /* priority */
1184 log_warning("Failed to parse /proc/swaps:%u.", i
);
1188 ssize_t l
= cunescape(dev
, UNESCAPE_RELAX
, &d
);
1190 return log_error_errno(l
, "Failed to unescape device path: %m");
1192 device_found_node(m
, d
, DEVICE_FOUND_SWAP
, DEVICE_FOUND_SWAP
);
1194 (void) swap_process_new(m
, d
, prio
, set_flags
);
1200 static int swap_process_proc_swaps(Manager
*m
) {
1205 r
= swap_load_proc_swaps(m
, true);
1207 log_error_errno(r
, "Failed to reread /proc/swaps: %m");
1209 /* Reset flags, just in case, for late calls */
1210 LIST_FOREACH(units_by_type
, u
, m
->units_by_type
[UNIT_SWAP
]) {
1211 Swap
*swap
= SWAP(u
);
1215 swap
->is_active
= swap
->just_activated
= false;
1221 manager_dispatch_load_queue(m
);
1223 LIST_FOREACH(units_by_type
, u
, m
->units_by_type
[UNIT_SWAP
]) {
1224 Swap
*swap
= SWAP(u
);
1228 if (!swap
->is_active
) {
1230 swap_unset_proc_swaps(swap
);
1232 switch (swap
->state
) {
1235 /* This has just been deactivated */
1236 swap_enter_dead(swap
, SWAP_SUCCESS
);
1241 swap_set_state(swap
, swap
->state
);
1246 device_found_node(m
, swap
->what
, DEVICE_NOT_FOUND
, DEVICE_FOUND_SWAP
);
1248 } else if (swap
->just_activated
) {
1250 /* New swap entry */
1252 switch (swap
->state
) {
1256 (void) unit_acquire_invocation_id(u
);
1257 swap_cycle_clear(swap
);
1258 swap_enter_active(swap
, SWAP_SUCCESS
);
1261 case SWAP_ACTIVATING
:
1262 swap_set_state(swap
, SWAP_ACTIVATING_DONE
);
1266 /* Nothing really changed, but let's
1267 * issue an notification call
1268 * nonetheless, in case somebody is
1269 * waiting for this. */
1270 swap_set_state(swap
, swap
->state
);
1275 /* Reset the flags for later calls */
1276 swap
->is_active
= swap
->just_activated
= false;
1282 static int swap_dispatch_io(sd_event_source
*source
, int fd
, uint32_t revents
, void *userdata
) {
1283 Manager
*m
= ASSERT_PTR(userdata
);
1285 assert(revents
& EPOLLPRI
);
1287 return swap_process_proc_swaps(m
);
1290 static Unit
*swap_following(Unit
*u
) {
1296 /* If the user configured the swap through /etc/fstab or
1297 * a device unit, follow that. */
1299 if (s
->from_fragment
)
1302 LIST_FOREACH_OTHERS(same_devnode
, other
, s
)
1303 if (other
->from_fragment
)
1306 /* Otherwise, make everybody follow the unit that's named after
1307 * the swap device in the kernel */
1309 if (streq_ptr(s
->what
, s
->devnode
))
1312 LIST_FOREACH(same_devnode
, other
, s
->same_devnode_next
)
1313 if (streq_ptr(other
->what
, other
->devnode
))
1316 LIST_FOREACH_BACKWARDS(same_devnode
, other
, s
->same_devnode_prev
) {
1317 if (streq_ptr(other
->what
, other
->devnode
))
1323 /* Fall back to the first on the list */
1327 static int swap_following_set(Unit
*u
, Set
**_set
) {
1329 _cleanup_set_free_ Set
*set
= NULL
;
1335 if (LIST_JUST_US(same_devnode
, s
)) {
1340 set
= set_new(NULL
);
1344 LIST_FOREACH_OTHERS(same_devnode
, other
, s
) {
1345 r
= set_put(set
, other
);
1350 *_set
= TAKE_PTR(set
);
1354 static void swap_shutdown(Manager
*m
) {
1357 m
->swap_event_source
= sd_event_source_disable_unref(m
->swap_event_source
);
1358 m
->proc_swaps
= safe_fclose(m
->proc_swaps
);
1359 m
->swaps_by_devnode
= hashmap_free(m
->swaps_by_devnode
);
1362 static void swap_enumerate(Manager
*m
) {
1367 if (!m
->proc_swaps
) {
1368 m
->proc_swaps
= fopen("/proc/swaps", "re");
1369 if (!m
->proc_swaps
) {
1370 if (errno
== ENOENT
)
1371 log_debug_errno(errno
, "Not swap enabled, skipping enumeration.");
1373 log_warning_errno(errno
, "Failed to open /proc/swaps, ignoring: %m");
1378 r
= sd_event_add_io(m
->event
, &m
->swap_event_source
, fileno(m
->proc_swaps
), EPOLLPRI
, swap_dispatch_io
, m
);
1380 log_error_errno(r
, "Failed to watch /proc/swaps: %m");
1384 /* Dispatch this before we dispatch SIGCHLD, so that
1385 * we always get the events from /proc/swaps before
1386 * the SIGCHLD of /sbin/swapon. */
1387 r
= sd_event_source_set_priority(m
->swap_event_source
, SD_EVENT_PRIORITY_NORMAL
-10);
1389 log_error_errno(r
, "Failed to change /proc/swaps priority: %m");
1393 (void) sd_event_source_set_description(m
->swap_event_source
, "swap-proc");
1396 r
= swap_load_proc_swaps(m
, false);
1406 int swap_process_device_new(Manager
*m
, sd_device
*dev
) {
1407 _cleanup_free_
char *e
= NULL
;
1408 const char *dn
, *devlink
;
1415 if (sd_device_get_devname(dev
, &dn
) < 0)
1418 r
= unit_name_from_path(dn
, ".swap", &e
);
1420 log_debug_errno(r
, "Cannot convert device name '%s' to unit name, ignoring: %m", dn
);
1424 u
= manager_get_unit(m
, e
);
1426 r
= swap_set_devnode(SWAP(u
), dn
);
1428 FOREACH_DEVICE_DEVLINK(dev
, devlink
) {
1429 _cleanup_free_
char *n
= NULL
;
1432 q
= unit_name_from_path(devlink
, ".swap", &n
);
1433 if (q
== -EINVAL
) /* If the name is not convertible to unit name, we can't manage it */
1438 u
= manager_get_unit(m
, n
);
1440 q
= swap_set_devnode(SWAP(u
), dn
);
1449 int swap_process_device_remove(Manager
*m
, sd_device
*dev
) {
1454 r
= sd_device_get_devname(dev
, &dn
);
1458 while ((s
= hashmap_get(m
->swaps_by_devnode
, dn
))) {
1461 q
= swap_set_devnode(s
, NULL
);
1469 static void swap_reset_failed(Unit
*u
) {
1474 if (s
->state
== SWAP_FAILED
)
1475 swap_set_state(s
, SWAP_DEAD
);
1477 s
->result
= SWAP_SUCCESS
;
1478 s
->clean_result
= SWAP_SUCCESS
;
1481 static int swap_kill(Unit
*u
, KillWho who
, int signo
, int code
, int value
, sd_bus_error
*error
) {
1482 return unit_kill_common(u
, who
, signo
, code
, value
, -1, SWAP(u
)->control_pid
, error
);
1485 static int swap_get_timeout(Unit
*u
, usec_t
*timeout
) {
1493 if (!s
->timer_event_source
)
1496 r
= sd_event_source_get_time(s
->timer_event_source
, &t
);
1499 if (t
== USEC_INFINITY
)
1506 static bool swap_supported(void) {
1507 static int supported
= -1;
1509 /* If swap support is not available in the kernel, or we are
1510 * running in a container we don't support swap units, and any
1511 * attempts to starting one should fail immediately. */
1515 access("/proc/swaps", F_OK
) >= 0 &&
1516 detect_container() <= 0;
1521 static int swap_control_pid(Unit
*u
) {
1526 return s
->control_pid
;
1529 static int swap_clean(Unit
*u
, ExecCleanMask mask
) {
1530 _cleanup_strv_free_
char **l
= NULL
;
1537 if (s
->state
!= SWAP_DEAD
)
1540 r
= exec_context_get_clean_directories(&s
->exec_context
, u
->manager
->prefix
, mask
, &l
);
1544 if (strv_isempty(l
))
1547 swap_unwatch_control_pid(s
);
1548 s
->clean_result
= SWAP_SUCCESS
;
1549 s
->control_command
= NULL
;
1550 s
->control_command_id
= _SWAP_EXEC_COMMAND_INVALID
;
1552 r
= swap_arm_timer(s
, usec_add(now(CLOCK_MONOTONIC
), s
->exec_context
.timeout_clean_usec
));
1556 r
= unit_fork_and_watch_rm_rf(u
, l
, &s
->control_pid
);
1560 swap_set_state(s
, SWAP_CLEANING
);
1565 log_unit_warning_errno(u
, r
, "Failed to initiate cleaning: %m");
1566 s
->clean_result
= SWAP_FAILURE_RESOURCES
;
1567 s
->timer_event_source
= sd_event_source_disable_unref(s
->timer_event_source
);
1571 static int swap_can_clean(Unit
*u
, ExecCleanMask
*ret
) {
1576 return exec_context_get_clean_mask(&s
->exec_context
, ret
);
1579 static int swap_can_start(Unit
*u
) {
1585 r
= unit_test_start_limit(u
);
1587 swap_enter_dead(s
, SWAP_FAILURE_START_LIMIT_HIT
);
1594 static const char* const swap_exec_command_table
[_SWAP_EXEC_COMMAND_MAX
] = {
1595 [SWAP_EXEC_ACTIVATE
] = "ExecActivate",
1596 [SWAP_EXEC_DEACTIVATE
] = "ExecDeactivate",
1599 DEFINE_STRING_TABLE_LOOKUP(swap_exec_command
, SwapExecCommand
);
1601 static const char* const swap_result_table
[_SWAP_RESULT_MAX
] = {
1602 [SWAP_SUCCESS
] = "success",
1603 [SWAP_FAILURE_RESOURCES
] = "resources",
1604 [SWAP_FAILURE_TIMEOUT
] = "timeout",
1605 [SWAP_FAILURE_EXIT_CODE
] = "exit-code",
1606 [SWAP_FAILURE_SIGNAL
] = "signal",
1607 [SWAP_FAILURE_CORE_DUMP
] = "core-dump",
1608 [SWAP_FAILURE_START_LIMIT_HIT
] = "start-limit-hit",
1611 DEFINE_STRING_TABLE_LOOKUP(swap_result
, SwapResult
);
1613 const UnitVTable swap_vtable
= {
1614 .object_size
= sizeof(Swap
),
1615 .exec_context_offset
= offsetof(Swap
, exec_context
),
1616 .cgroup_context_offset
= offsetof(Swap
, cgroup_context
),
1617 .kill_context_offset
= offsetof(Swap
, kill_context
),
1618 .exec_runtime_offset
= offsetof(Swap
, exec_runtime
),
1624 .private_section
= "Swap",
1632 .coldplug
= swap_coldplug
,
1636 .start
= swap_start
,
1640 .clean
= swap_clean
,
1641 .can_clean
= swap_can_clean
,
1643 .get_timeout
= swap_get_timeout
,
1645 .serialize
= swap_serialize
,
1646 .deserialize_item
= swap_deserialize_item
,
1648 .active_state
= swap_active_state
,
1649 .sub_state_to_string
= swap_sub_state_to_string
,
1651 .will_restart
= unit_will_restart_default
,
1653 .may_gc
= swap_may_gc
,
1654 .is_extrinsic
= swap_is_extrinsic
,
1656 .sigchld_event
= swap_sigchld_event
,
1658 .reset_failed
= swap_reset_failed
,
1660 .control_pid
= swap_control_pid
,
1662 .bus_set_property
= bus_swap_set_property
,
1663 .bus_commit_properties
= bus_swap_commit_properties
,
1665 .following
= swap_following
,
1666 .following_set
= swap_following_set
,
1668 .enumerate
= swap_enumerate
,
1669 .shutdown
= swap_shutdown
,
1670 .supported
= swap_supported
,
1672 .status_message_formats
= {
1673 .starting_stopping
= {
1674 [0] = "Activating swap %s...",
1675 [1] = "Deactivating swap %s...",
1677 .finished_start_job
= {
1678 [JOB_DONE
] = "Activated swap %s.",
1679 [JOB_FAILED
] = "Failed to activate swap %s.",
1680 [JOB_TIMEOUT
] = "Timed out activating swap %s.",
1682 .finished_stop_job
= {
1683 [JOB_DONE
] = "Deactivated swap %s.",
1684 [JOB_FAILED
] = "Failed deactivating swap %s.",
1685 [JOB_TIMEOUT
] = "Timed out deactivating swap %s.",
1689 .can_start
= swap_can_start
,
1691 .notify_plymouth
= true,