1 /* SPDX-License-Identifier: LGPL-2.1+ */
10 #include "alloc-util.h"
11 #include "dbus-swap.h"
12 #include "dbus-unit.h"
13 #include "device-private.h"
14 #include "device-util.h"
17 #include "exit-status.h"
19 #include "format-util.h"
20 #include "fstab-util.h"
21 #include "parse-util.h"
22 #include "path-util.h"
23 #include "process-util.h"
24 #include "serialize.h"
26 #include "string-table.h"
27 #include "string-util.h"
29 #include "unit-name.h"
33 static const UnitActiveState state_translation_table
[_SWAP_STATE_MAX
] = {
34 [SWAP_DEAD
] = UNIT_INACTIVE
,
35 [SWAP_ACTIVATING
] = UNIT_ACTIVATING
,
36 [SWAP_ACTIVATING_DONE
] = UNIT_ACTIVE
,
37 [SWAP_ACTIVE
] = UNIT_ACTIVE
,
38 [SWAP_DEACTIVATING
] = UNIT_DEACTIVATING
,
39 [SWAP_DEACTIVATING_SIGTERM
] = UNIT_DEACTIVATING
,
40 [SWAP_DEACTIVATING_SIGKILL
] = UNIT_DEACTIVATING
,
41 [SWAP_FAILED
] = UNIT_FAILED
,
42 [SWAP_CLEANING
] = UNIT_MAINTENANCE
,
45 static int swap_dispatch_timer(sd_event_source
*source
, usec_t usec
, void *userdata
);
46 static int swap_dispatch_io(sd_event_source
*source
, int fd
, uint32_t revents
, void *userdata
);
47 static int swap_process_proc_swaps(Manager
*m
);
49 static bool SWAP_STATE_WITH_PROCESS(SwapState state
) {
54 SWAP_DEACTIVATING_SIGTERM
,
55 SWAP_DEACTIVATING_SIGKILL
,
59 static void swap_unset_proc_swaps(Swap
*s
) {
62 if (!s
->from_proc_swaps
)
65 s
->parameters_proc_swaps
.what
= mfree(s
->parameters_proc_swaps
.what
);
67 s
->from_proc_swaps
= false;
70 static int swap_set_devnode(Swap
*s
, const char *devnode
) {
77 r
= hashmap_ensure_allocated(&UNIT(s
)->manager
->swaps_by_devnode
, &path_hash_ops
);
81 swaps
= UNIT(s
)->manager
->swaps_by_devnode
;
84 first
= hashmap_get(swaps
, s
->devnode
);
86 LIST_REMOVE(same_devnode
, first
, s
);
88 hashmap_replace(swaps
, first
->devnode
, first
);
90 hashmap_remove(swaps
, s
->devnode
);
92 s
->devnode
= mfree(s
->devnode
);
96 s
->devnode
= strdup(devnode
);
100 first
= hashmap_get(swaps
, s
->devnode
);
101 LIST_PREPEND(same_devnode
, first
, s
);
103 return hashmap_replace(swaps
, first
->devnode
, first
);
109 static void swap_init(Unit
*u
) {
113 assert(UNIT(s
)->load_state
== UNIT_STUB
);
115 s
->timeout_usec
= u
->manager
->default_timeout_start_usec
;
117 s
->exec_context
.std_output
= u
->manager
->default_std_output
;
118 s
->exec_context
.std_error
= u
->manager
->default_std_error
;
120 s
->parameters_proc_swaps
.priority
= s
->parameters_fragment
.priority
= 0;
121 s
->parameters_fragment
.priority_set
= false;
123 s
->control_command_id
= _SWAP_EXEC_COMMAND_INVALID
;
125 u
->ignore_on_isolate
= true;
128 static void swap_unwatch_control_pid(Swap
*s
) {
131 if (s
->control_pid
<= 0)
134 unit_unwatch_pid(UNIT(s
), s
->control_pid
);
138 static void swap_done(Unit
*u
) {
143 swap_unset_proc_swaps(s
);
144 swap_set_devnode(s
, NULL
);
146 s
->what
= mfree(s
->what
);
147 s
->parameters_fragment
.what
= mfree(s
->parameters_fragment
.what
);
148 s
->parameters_fragment
.options
= mfree(s
->parameters_fragment
.options
);
150 s
->exec_runtime
= exec_runtime_unref(s
->exec_runtime
, false);
151 exec_command_done_array(s
->exec_command
, _SWAP_EXEC_COMMAND_MAX
);
152 s
->control_command
= NULL
;
154 dynamic_creds_unref(&s
->dynamic_creds
);
156 swap_unwatch_control_pid(s
);
158 s
->timer_event_source
= sd_event_source_unref(s
->timer_event_source
);
161 static int swap_arm_timer(Swap
*s
, usec_t usec
) {
166 if (s
->timer_event_source
) {
167 r
= sd_event_source_set_time(s
->timer_event_source
, usec
);
171 return sd_event_source_set_enabled(s
->timer_event_source
, SD_EVENT_ONESHOT
);
174 if (usec
== USEC_INFINITY
)
177 r
= sd_event_add_time(
178 UNIT(s
)->manager
->event
,
179 &s
->timer_event_source
,
182 swap_dispatch_timer
, s
);
186 (void) sd_event_source_set_description(s
->timer_event_source
, "swap-timer");
191 static int swap_add_device_dependencies(Swap
*s
) {
197 if (!s
->from_fragment
)
200 if (is_device_path(s
->what
))
201 return unit_add_node_dependency(UNIT(s
), s
->what
, UNIT_BINDS_TO
, UNIT_DEPENDENCY_FILE
);
203 /* File based swap devices need to be ordered after systemd-remount-fs.service,
204 * since they might need a writable file system. */
205 return unit_add_dependency_by_name(UNIT(s
), UNIT_AFTER
, SPECIAL_REMOUNT_FS_SERVICE
, true, UNIT_DEPENDENCY_FILE
);
208 static int swap_add_default_dependencies(Swap
*s
) {
213 if (!UNIT(s
)->default_dependencies
)
216 if (!MANAGER_IS_SYSTEM(UNIT(s
)->manager
))
219 if (detect_container() > 0)
222 /* swap units generated for the swap dev links are missing the
223 * ordering dep against the swap target. */
224 r
= unit_add_dependency_by_name(UNIT(s
), UNIT_BEFORE
, SPECIAL_SWAP_TARGET
, true, UNIT_DEPENDENCY_DEFAULT
);
228 return unit_add_two_dependencies_by_name(UNIT(s
), UNIT_BEFORE
, UNIT_CONFLICTS
, SPECIAL_UMOUNT_TARGET
, true, UNIT_DEPENDENCY_DEFAULT
);
231 static int swap_verify(Swap
*s
) {
232 _cleanup_free_
char *e
= NULL
;
235 assert(UNIT(s
)->load_state
== UNIT_LOADED
);
237 r
= unit_name_from_path(s
->what
, ".swap", &e
);
239 return log_unit_error_errno(UNIT(s
), r
, "Failed to generate unit name from path: %m");
241 if (!unit_has_name(UNIT(s
), e
)) {
242 log_unit_error(UNIT(s
), "Value of What= and unit name do not match, not loading.");
246 if (s
->exec_context
.pam_name
&& s
->kill_context
.kill_mode
!= KILL_CONTROL_GROUP
) {
247 log_unit_error(UNIT(s
), "Unit has PAM enabled. Kill mode must be set to 'control-group'. Refusing to load.");
254 static int swap_load_devnode(Swap
*s
) {
255 _cleanup_(sd_device_unrefp
) sd_device
*d
= NULL
;
262 if (stat(s
->what
, &st
) < 0 || !S_ISBLK(st
.st_mode
))
265 r
= device_new_from_stat_rdev(&d
, &st
);
267 log_unit_full(UNIT(s
), r
== -ENOENT
? LOG_DEBUG
: LOG_WARNING
, r
,
268 "Failed to allocate device for swap %s: %m", s
->what
);
272 if (sd_device_get_devname(d
, &p
) < 0)
275 return swap_set_devnode(s
, p
);
278 static int swap_add_extras(Swap
*s
) {
283 if (UNIT(s
)->fragment_path
)
284 s
->from_fragment
= true;
287 if (s
->parameters_fragment
.what
)
288 s
->what
= strdup(s
->parameters_fragment
.what
);
289 else if (s
->parameters_proc_swaps
.what
)
290 s
->what
= strdup(s
->parameters_proc_swaps
.what
);
292 r
= unit_name_to_path(UNIT(s
)->id
, &s
->what
);
301 path_simplify(s
->what
, false);
303 if (!UNIT(s
)->description
) {
304 r
= unit_set_description(UNIT(s
), s
->what
);
309 r
= unit_require_mounts_for(UNIT(s
), s
->what
, UNIT_DEPENDENCY_IMPLICIT
);
313 r
= swap_add_device_dependencies(s
);
317 r
= swap_load_devnode(s
);
321 r
= unit_patch_contexts(UNIT(s
));
325 r
= unit_add_exec_dependencies(UNIT(s
), &s
->exec_context
);
329 r
= unit_set_default_slice(UNIT(s
));
333 r
= swap_add_default_dependencies(s
);
340 static int swap_load(Unit
*u
) {
345 assert(u
->load_state
== UNIT_STUB
);
347 /* Load a .swap file */
348 bool fragment_optional
= s
->from_proc_swaps
;
349 r
= unit_load_fragment_and_dropin(u
, !fragment_optional
);
351 /* Add in some extras, and do so either when we successfully loaded something or when /proc/swaps is
353 if (u
->load_state
== UNIT_LOADED
|| s
->from_proc_swaps
)
354 q
= swap_add_extras(s
);
360 if (u
->load_state
!= UNIT_LOADED
)
363 return swap_verify(s
);
366 static int swap_setup_unit(
369 const char *what_proc_swaps
,
373 _cleanup_free_
char *e
= NULL
;
381 assert(what_proc_swaps
);
383 r
= unit_name_from_path(what
, ".swap", &e
);
385 return log_unit_error_errno(u
, r
, "Failed to generate unit name from path: %m");
387 u
= manager_get_unit(m
, e
);
389 SWAP(u
)->from_proc_swaps
&&
390 !path_equal(SWAP(u
)->parameters_proc_swaps
.what
, what_proc_swaps
))
391 return log_error_errno(SYNTHETIC_ERRNO(EEXIST
),
392 "Swap %s appeared twice with different device paths %s and %s",
393 e
, SWAP(u
)->parameters_proc_swaps
.what
, what_proc_swaps
);
398 r
= unit_new_for_name(m
, sizeof(Swap
), e
, &u
);
402 SWAP(u
)->what
= strdup(what
);
403 if (!SWAP(u
)->what
) {
408 unit_add_to_load_queue(u
);
412 p
= &SWAP(u
)->parameters_proc_swaps
;
415 p
->what
= strdup(what_proc_swaps
);
422 /* The unit is definitely around now, mark it as loaded if it was previously referenced but could not be
423 * loaded. After all we can load it now, from the data in /proc/swaps. */
424 if (IN_SET(u
->load_state
, UNIT_NOT_FOUND
, UNIT_BAD_SETTING
, UNIT_ERROR
)) {
425 u
->load_state
= UNIT_LOADED
;
430 SWAP(u
)->is_active
= true;
431 SWAP(u
)->just_activated
= !SWAP(u
)->from_proc_swaps
;
434 SWAP(u
)->from_proc_swaps
= true;
436 p
->priority
= priority
;
437 p
->priority_set
= true;
439 unit_add_to_dbus_queue(u
);
443 log_unit_warning_errno(u
, r
, "Failed to load swap unit: %m");
451 static int swap_process_new(Manager
*m
, const char *device
, int prio
, bool set_flags
) {
452 _cleanup_(sd_device_unrefp
) sd_device
*d
= NULL
;
453 const char *dn
, *devlink
;
454 struct stat st
, st_link
;
459 r
= swap_setup_unit(m
, device
, device
, prio
, set_flags
);
463 /* If this is a block device, then let's add duplicates for
464 * all other names of this block device */
465 if (stat(device
, &st
) < 0 || !S_ISBLK(st
.st_mode
))
468 r
= device_new_from_stat_rdev(&d
, &st
);
470 log_full_errno(r
== -ENOENT
? LOG_DEBUG
: LOG_WARNING
, r
,
471 "Failed to allocate device for swap %s: %m", device
);
475 /* Add the main device node */
476 if (sd_device_get_devname(d
, &dn
) >= 0 && !streq(dn
, device
))
477 swap_setup_unit(m
, dn
, device
, prio
, set_flags
);
479 /* Add additional units for all symlinks */
480 FOREACH_DEVICE_DEVLINK(d
, devlink
) {
482 /* Don't bother with the /dev/block links */
483 if (streq(devlink
, device
))
486 if (path_startswith(devlink
, "/dev/block/"))
489 if (stat(devlink
, &st_link
) >= 0 &&
490 (!S_ISBLK(st_link
.st_mode
) ||
491 st_link
.st_rdev
!= st
.st_rdev
))
494 swap_setup_unit(m
, devlink
, device
, prio
, set_flags
);
500 static void swap_set_state(Swap
*s
, SwapState state
) {
506 if (s
->state
!= state
)
507 bus_unit_send_pending_change_signal(UNIT(s
), false);
509 old_state
= s
->state
;
512 if (!SWAP_STATE_WITH_PROCESS(state
)) {
513 s
->timer_event_source
= sd_event_source_unref(s
->timer_event_source
);
514 swap_unwatch_control_pid(s
);
515 s
->control_command
= NULL
;
516 s
->control_command_id
= _SWAP_EXEC_COMMAND_INVALID
;
519 if (state
!= old_state
)
520 log_unit_debug(UNIT(s
), "Changed %s -> %s", swap_state_to_string(old_state
), swap_state_to_string(state
));
522 unit_notify(UNIT(s
), state_translation_table
[old_state
], state_translation_table
[state
], 0);
524 /* If there other units for the same device node have a job
525 queued it might be worth checking again if it is runnable
526 now. This is necessary, since swap_start() refuses
527 operation with EAGAIN if there's already another job for
528 the same device node queued. */
529 LIST_FOREACH_OTHERS(same_devnode
, other
, s
)
530 if (UNIT(other
)->job
)
531 job_add_to_run_queue(UNIT(other
)->job
);
534 static int swap_coldplug(Unit
*u
) {
536 SwapState new_state
= SWAP_DEAD
;
540 assert(s
->state
== SWAP_DEAD
);
542 if (s
->deserialized_state
!= s
->state
)
543 new_state
= s
->deserialized_state
;
544 else if (s
->from_proc_swaps
)
545 new_state
= SWAP_ACTIVE
;
547 if (new_state
== s
->state
)
550 if (s
->control_pid
> 0 &&
551 pid_is_unwaited(s
->control_pid
) &&
552 SWAP_STATE_WITH_PROCESS(new_state
)) {
554 r
= unit_watch_pid(UNIT(s
), s
->control_pid
, false);
558 r
= swap_arm_timer(s
, usec_add(u
->state_change_timestamp
.monotonic
, s
->timeout_usec
));
563 if (!IN_SET(new_state
, SWAP_DEAD
, SWAP_FAILED
)) {
564 (void) unit_setup_dynamic_creds(u
);
565 (void) unit_setup_exec_runtime(u
);
568 swap_set_state(s
, new_state
);
572 static void swap_dump(Unit
*u
, FILE *f
, const char *prefix
) {
573 char buf
[FORMAT_TIMESPAN_MAX
];
580 if (s
->from_proc_swaps
)
581 p
= &s
->parameters_proc_swaps
;
582 else if (s
->from_fragment
)
583 p
= &s
->parameters_fragment
;
590 "%sClean Result: %s\n"
592 "%sFrom /proc/swaps: %s\n"
593 "%sFrom fragment: %s\n",
594 prefix
, swap_state_to_string(s
->state
),
595 prefix
, swap_result_to_string(s
->result
),
596 prefix
, swap_result_to_string(s
->clean_result
),
598 prefix
, yes_no(s
->from_proc_swaps
),
599 prefix
, yes_no(s
->from_fragment
));
602 fprintf(f
, "%sDevice Node: %s\n", prefix
, s
->devnode
);
609 prefix
, strempty(p
->options
));
612 "%sTimeoutSec: %s\n",
613 prefix
, format_timespan(buf
, sizeof(buf
), s
->timeout_usec
, USEC_PER_SEC
));
615 if (s
->control_pid
> 0)
617 "%sControl PID: "PID_FMT
"\n",
618 prefix
, s
->control_pid
);
620 exec_context_dump(&s
->exec_context
, f
, prefix
);
621 kill_context_dump(&s
->kill_context
, f
, prefix
);
622 cgroup_context_dump(UNIT(s
), f
, prefix
);
625 static int swap_spawn(Swap
*s
, ExecCommand
*c
, pid_t
*_pid
) {
627 _cleanup_(exec_params_clear
) ExecParameters exec_params
= {
628 .flags
= EXEC_APPLY_SANDBOXING
|EXEC_APPLY_CHROOT
|EXEC_APPLY_TTY_STDIN
,
641 r
= unit_prepare_exec(UNIT(s
));
645 r
= swap_arm_timer(s
, usec_add(now(CLOCK_MONOTONIC
), s
->timeout_usec
));
649 r
= unit_set_exec_params(UNIT(s
), &exec_params
);
653 r
= exec_spawn(UNIT(s
),
663 r
= unit_watch_pid(UNIT(s
), pid
, true);
672 s
->timer_event_source
= sd_event_source_unref(s
->timer_event_source
);
677 static void swap_enter_dead(Swap
*s
, SwapResult f
) {
680 if (s
->result
== SWAP_SUCCESS
)
683 unit_log_result(UNIT(s
), s
->result
== SWAP_SUCCESS
, swap_result_to_string(s
->result
));
684 swap_set_state(s
, s
->result
!= SWAP_SUCCESS
? SWAP_FAILED
: SWAP_DEAD
);
686 s
->exec_runtime
= exec_runtime_unref(s
->exec_runtime
, true);
688 unit_destroy_runtime_directory(UNIT(s
), &s
->exec_context
);
690 unit_unref_uid_gid(UNIT(s
), true);
692 dynamic_creds_destroy(&s
->dynamic_creds
);
695 static void swap_enter_active(Swap
*s
, SwapResult f
) {
698 if (s
->result
== SWAP_SUCCESS
)
701 swap_set_state(s
, SWAP_ACTIVE
);
704 static void swap_enter_dead_or_active(Swap
*s
, SwapResult f
) {
707 if (s
->from_proc_swaps
)
708 swap_enter_active(s
, f
);
710 swap_enter_dead(s
, f
);
713 static int state_to_kill_operation(Swap
*s
, SwapState state
) {
714 if (state
== SWAP_DEACTIVATING_SIGTERM
) {
715 if (unit_has_job_type(UNIT(s
), JOB_RESTART
))
718 return KILL_TERMINATE
;
724 static void swap_enter_signal(Swap
*s
, SwapState state
, SwapResult f
) {
729 if (s
->result
== SWAP_SUCCESS
)
732 r
= unit_kill_context(UNIT(s
),
734 state_to_kill_operation(s
, state
),
742 r
= swap_arm_timer(s
, usec_add(now(CLOCK_MONOTONIC
), s
->timeout_usec
));
746 swap_set_state(s
, state
);
747 } else if (state
== SWAP_DEACTIVATING_SIGTERM
&& s
->kill_context
.send_sigkill
)
748 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGKILL
, SWAP_SUCCESS
);
750 swap_enter_dead_or_active(s
, SWAP_SUCCESS
);
755 log_unit_warning_errno(UNIT(s
), r
, "Failed to kill processes: %m");
756 swap_enter_dead_or_active(s
, SWAP_FAILURE_RESOURCES
);
759 static void swap_enter_activating(Swap
*s
) {
760 _cleanup_free_
char *opts
= NULL
;
765 unit_warn_leftover_processes(UNIT(s
));
767 s
->control_command_id
= SWAP_EXEC_ACTIVATE
;
768 s
->control_command
= s
->exec_command
+ SWAP_EXEC_ACTIVATE
;
770 if (s
->from_fragment
) {
773 r
= fstab_find_pri(s
->parameters_fragment
.options
, &priority
);
775 log_warning_errno(r
, "Failed to parse swap priority \"%s\", ignoring: %m", s
->parameters_fragment
.options
);
776 else if (r
== 1 && s
->parameters_fragment
.priority_set
)
777 log_warning("Duplicate swap priority configuration by Priority and Options fields.");
779 if (r
<= 0 && s
->parameters_fragment
.priority_set
) {
780 if (s
->parameters_fragment
.options
)
781 r
= asprintf(&opts
, "%s,pri=%i", s
->parameters_fragment
.options
, s
->parameters_fragment
.priority
);
783 r
= asprintf(&opts
, "pri=%i", s
->parameters_fragment
.priority
);
789 r
= exec_command_set(s
->control_command
, "/sbin/swapon", NULL
);
793 if (s
->parameters_fragment
.options
|| opts
) {
794 r
= exec_command_append(s
->control_command
, "-o",
795 opts
? : s
->parameters_fragment
.options
, NULL
);
800 r
= exec_command_append(s
->control_command
, s
->what
, NULL
);
804 swap_unwatch_control_pid(s
);
806 r
= swap_spawn(s
, s
->control_command
, &s
->control_pid
);
810 swap_set_state(s
, SWAP_ACTIVATING
);
815 log_unit_warning_errno(UNIT(s
), r
, "Failed to run 'swapon' task: %m");
816 swap_enter_dead_or_active(s
, SWAP_FAILURE_RESOURCES
);
819 static void swap_enter_deactivating(Swap
*s
) {
824 s
->control_command_id
= SWAP_EXEC_DEACTIVATE
;
825 s
->control_command
= s
->exec_command
+ SWAP_EXEC_DEACTIVATE
;
827 r
= exec_command_set(s
->control_command
,
834 swap_unwatch_control_pid(s
);
836 r
= swap_spawn(s
, s
->control_command
, &s
->control_pid
);
840 swap_set_state(s
, SWAP_DEACTIVATING
);
845 log_unit_warning_errno(UNIT(s
), r
, "Failed to run 'swapoff' task: %m");
846 swap_enter_dead_or_active(s
, SWAP_FAILURE_RESOURCES
);
849 static void swap_cycle_clear(Swap
*s
) {
852 s
->result
= SWAP_SUCCESS
;
853 exec_command_reset_status_array(s
->exec_command
, _SWAP_EXEC_COMMAND_MAX
);
854 UNIT(s
)->reset_accounting
= true;
857 static int swap_start(Unit
*u
) {
858 Swap
*s
= SWAP(u
), *other
;
863 /* We cannot fulfill this request right now, try again later please! */
866 SWAP_DEACTIVATING_SIGTERM
,
867 SWAP_DEACTIVATING_SIGKILL
,
872 if (s
->state
== SWAP_ACTIVATING
)
875 assert(IN_SET(s
->state
, SWAP_DEAD
, SWAP_FAILED
));
877 if (detect_container() > 0)
880 /* If there's a job for another swap unit for the same node
881 * running, then let's not dispatch this one for now, and wait
882 * until that other job has finished. */
883 LIST_FOREACH_OTHERS(same_devnode
, other
, s
)
884 if (UNIT(other
)->job
&& UNIT(other
)->job
->state
== JOB_RUNNING
)
887 r
= unit_test_start_limit(u
);
889 swap_enter_dead(s
, SWAP_FAILURE_START_LIMIT_HIT
);
893 r
= unit_acquire_invocation_id(u
);
898 swap_enter_activating(s
);
902 static int swap_stop(Unit
*u
) {
909 case SWAP_DEACTIVATING
:
910 case SWAP_DEACTIVATING_SIGTERM
:
911 case SWAP_DEACTIVATING_SIGKILL
:
915 case SWAP_ACTIVATING
:
916 case SWAP_ACTIVATING_DONE
:
917 /* There's a control process pending, directly enter kill mode */
918 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGTERM
, SWAP_SUCCESS
);
922 if (detect_container() > 0)
925 swap_enter_deactivating(s
);
929 /* If we are currently cleaning, then abort it, brutally. */
930 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGKILL
, SWAP_SUCCESS
);
934 assert_not_reached("Unexpected state.");
938 static int swap_serialize(Unit
*u
, FILE *f
, FDSet
*fds
) {
945 (void) serialize_item(f
, "state", swap_state_to_string(s
->state
));
946 (void) serialize_item(f
, "result", swap_result_to_string(s
->result
));
948 if (s
->control_pid
> 0)
949 (void) serialize_item_format(f
, "control-pid", PID_FMT
, 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")) {
982 if (parse_pid(value
, &pid
) < 0)
983 log_unit_debug(u
, "Failed to parse control-pid value: %s", value
);
985 s
->control_pid
= pid
;
987 } else if (streq(key
, "control-command")) {
990 id
= swap_exec_command_from_string(value
);
992 log_unit_debug(u
, "Failed to parse exec-command value: %s", value
);
994 s
->control_command_id
= id
;
995 s
->control_command
= s
->exec_command
+ id
;
998 log_unit_debug(u
, "Unknown serialization key: %s", key
);
1003 _pure_
static UnitActiveState
swap_active_state(Unit
*u
) {
1006 return state_translation_table
[SWAP(u
)->state
];
1009 _pure_
static const char *swap_sub_state_to_string(Unit
*u
) {
1012 return swap_state_to_string(SWAP(u
)->state
);
1015 _pure_
static bool swap_may_gc(Unit
*u
) {
1020 if (s
->from_proc_swaps
)
1026 static void swap_sigchld_event(Unit
*u
, pid_t pid
, int code
, int status
) {
1033 if (pid
!= s
->control_pid
)
1036 /* Let's scan /proc/swaps before we process SIGCHLD. For the reasoning see the similar code in
1038 (void) swap_process_proc_swaps(u
->manager
);
1042 if (is_clean_exit(code
, status
, EXIT_CLEAN_COMMAND
, NULL
))
1044 else if (code
== CLD_EXITED
)
1045 f
= SWAP_FAILURE_EXIT_CODE
;
1046 else if (code
== CLD_KILLED
)
1047 f
= SWAP_FAILURE_SIGNAL
;
1048 else if (code
== CLD_DUMPED
)
1049 f
= SWAP_FAILURE_CORE_DUMP
;
1051 assert_not_reached("Unknown code");
1053 if (s
->result
== SWAP_SUCCESS
)
1056 if (s
->control_command
) {
1057 exec_status_exit(&s
->control_command
->exec_status
, &s
->exec_context
, pid
, code
, status
);
1059 s
->control_command
= NULL
;
1060 s
->control_command_id
= _SWAP_EXEC_COMMAND_INVALID
;
1063 unit_log_process_exit(
1066 swap_exec_command_to_string(s
->control_command_id
),
1072 case SWAP_ACTIVATING
:
1073 case SWAP_ACTIVATING_DONE
:
1075 if (f
== SWAP_SUCCESS
|| s
->from_proc_swaps
)
1076 swap_enter_active(s
, f
);
1078 swap_enter_dead(s
, f
);
1081 case SWAP_DEACTIVATING
:
1082 case SWAP_DEACTIVATING_SIGKILL
:
1083 case SWAP_DEACTIVATING_SIGTERM
:
1085 swap_enter_dead_or_active(s
, f
);
1089 if (s
->clean_result
== SWAP_SUCCESS
)
1090 s
->clean_result
= f
;
1092 swap_enter_dead(s
, SWAP_SUCCESS
);
1096 assert_not_reached("Uh, control process died at wrong time.");
1099 /* Notify clients about changed exit status */
1100 unit_add_to_dbus_queue(u
);
1103 static int swap_dispatch_timer(sd_event_source
*source
, usec_t usec
, void *userdata
) {
1104 Swap
*s
= SWAP(userdata
);
1107 assert(s
->timer_event_source
== source
);
1111 case SWAP_ACTIVATING
:
1112 case SWAP_ACTIVATING_DONE
:
1113 log_unit_warning(UNIT(s
), "Activation timed out. Stopping.");
1114 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGTERM
, SWAP_FAILURE_TIMEOUT
);
1117 case SWAP_DEACTIVATING
:
1118 log_unit_warning(UNIT(s
), "Deactivation timed out. Stopping.");
1119 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGTERM
, SWAP_FAILURE_TIMEOUT
);
1122 case SWAP_DEACTIVATING_SIGTERM
:
1123 if (s
->kill_context
.send_sigkill
) {
1124 log_unit_warning(UNIT(s
), "Swap process timed out. Killing.");
1125 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGKILL
, SWAP_FAILURE_TIMEOUT
);
1127 log_unit_warning(UNIT(s
), "Swap process timed out. Skipping SIGKILL. Ignoring.");
1128 swap_enter_dead_or_active(s
, SWAP_FAILURE_TIMEOUT
);
1132 case SWAP_DEACTIVATING_SIGKILL
:
1133 log_unit_warning(UNIT(s
), "Swap process still around after SIGKILL. Ignoring.");
1134 swap_enter_dead_or_active(s
, SWAP_FAILURE_TIMEOUT
);
1138 log_unit_warning(UNIT(s
), "Cleaning timed out. killing.");
1140 if (s
->clean_result
== SWAP_SUCCESS
)
1141 s
->clean_result
= SWAP_FAILURE_TIMEOUT
;
1143 swap_enter_signal(s
, SWAP_DEACTIVATING_SIGKILL
, 0);
1147 assert_not_reached("Timeout at wrong time.");
1153 static int swap_load_proc_swaps(Manager
*m
, bool set_flags
) {
1158 rewind(m
->proc_swaps
);
1160 (void) fscanf(m
->proc_swaps
, "%*s %*s %*s %*s %*s\n");
1163 _cleanup_free_
char *dev
= NULL
, *d
= NULL
;
1166 k
= fscanf(m
->proc_swaps
,
1167 "%ms " /* device/file */
1168 "%*s " /* type of swap */
1169 "%*s " /* swap size */
1171 "%i\n", /* priority */
1177 log_warning("Failed to parse /proc/swaps:%u.", i
);
1181 if (cunescape(dev
, UNESCAPE_RELAX
, &d
) < 0)
1184 device_found_node(m
, d
, DEVICE_FOUND_SWAP
, DEVICE_FOUND_SWAP
);
1186 (void) swap_process_new(m
, d
, prio
, set_flags
);
1192 static int swap_process_proc_swaps(Manager
*m
) {
1198 r
= swap_load_proc_swaps(m
, true);
1200 log_error_errno(r
, "Failed to reread /proc/swaps: %m");
1202 /* Reset flags, just in case, for late calls */
1203 LIST_FOREACH(units_by_type
, u
, m
->units_by_type
[UNIT_SWAP
]) {
1204 Swap
*swap
= SWAP(u
);
1206 swap
->is_active
= swap
->just_activated
= false;
1212 manager_dispatch_load_queue(m
);
1214 LIST_FOREACH(units_by_type
, u
, m
->units_by_type
[UNIT_SWAP
]) {
1215 Swap
*swap
= SWAP(u
);
1217 if (!swap
->is_active
) {
1219 swap_unset_proc_swaps(swap
);
1221 switch (swap
->state
) {
1224 /* This has just been deactivated */
1225 swap_enter_dead(swap
, SWAP_SUCCESS
);
1230 swap_set_state(swap
, swap
->state
);
1235 device_found_node(m
, swap
->what
, 0, DEVICE_FOUND_SWAP
);
1237 } else if (swap
->just_activated
) {
1239 /* New swap entry */
1241 switch (swap
->state
) {
1245 (void) unit_acquire_invocation_id(u
);
1246 swap_cycle_clear(swap
);
1247 swap_enter_active(swap
, SWAP_SUCCESS
);
1250 case SWAP_ACTIVATING
:
1251 swap_set_state(swap
, SWAP_ACTIVATING_DONE
);
1255 /* Nothing really changed, but let's
1256 * issue an notification call
1257 * nonetheless, in case somebody is
1258 * waiting for this. */
1259 swap_set_state(swap
, swap
->state
);
1264 /* Reset the flags for later calls */
1265 swap
->is_active
= swap
->just_activated
= false;
1271 static int swap_dispatch_io(sd_event_source
*source
, int fd
, uint32_t revents
, void *userdata
) {
1272 Manager
*m
= userdata
;
1275 assert(revents
& EPOLLPRI
);
1277 return swap_process_proc_swaps(m
);
1280 static Unit
*swap_following(Unit
*u
) {
1282 Swap
*other
, *first
= NULL
;
1286 /* If the user configured the swap through /etc/fstab or
1287 * a device unit, follow that. */
1289 if (s
->from_fragment
)
1292 LIST_FOREACH_OTHERS(same_devnode
, other
, s
)
1293 if (other
->from_fragment
)
1296 /* Otherwise, make everybody follow the unit that's named after
1297 * the swap device in the kernel */
1299 if (streq_ptr(s
->what
, s
->devnode
))
1302 LIST_FOREACH_AFTER(same_devnode
, other
, s
)
1303 if (streq_ptr(other
->what
, other
->devnode
))
1306 LIST_FOREACH_BEFORE(same_devnode
, other
, s
) {
1307 if (streq_ptr(other
->what
, other
->devnode
))
1313 /* Fall back to the first on the list */
1317 static int swap_following_set(Unit
*u
, Set
**_set
) {
1318 Swap
*s
= SWAP(u
), *other
;
1319 _cleanup_set_free_ Set
*set
= NULL
;
1325 if (LIST_JUST_US(same_devnode
, s
)) {
1330 set
= set_new(NULL
);
1334 LIST_FOREACH_OTHERS(same_devnode
, other
, s
) {
1335 r
= set_put(set
, other
);
1340 *_set
= TAKE_PTR(set
);
1344 static void swap_shutdown(Manager
*m
) {
1347 m
->swap_event_source
= sd_event_source_unref(m
->swap_event_source
);
1348 m
->proc_swaps
= safe_fclose(m
->proc_swaps
);
1349 m
->swaps_by_devnode
= hashmap_free(m
->swaps_by_devnode
);
1352 static void swap_enumerate(Manager
*m
) {
1357 if (!m
->proc_swaps
) {
1358 m
->proc_swaps
= fopen("/proc/swaps", "re");
1359 if (!m
->proc_swaps
) {
1360 if (errno
== ENOENT
)
1361 log_debug_errno(errno
, "Not swap enabled, skipping enumeration.");
1363 log_warning_errno(errno
, "Failed to open /proc/swaps, ignoring: %m");
1368 r
= sd_event_add_io(m
->event
, &m
->swap_event_source
, fileno(m
->proc_swaps
), EPOLLPRI
, swap_dispatch_io
, m
);
1370 log_error_errno(r
, "Failed to watch /proc/swaps: %m");
1374 /* Dispatch this before we dispatch SIGCHLD, so that
1375 * we always get the events from /proc/swaps before
1376 * the SIGCHLD of /sbin/swapon. */
1377 r
= sd_event_source_set_priority(m
->swap_event_source
, SD_EVENT_PRIORITY_NORMAL
-10);
1379 log_error_errno(r
, "Failed to change /proc/swaps priority: %m");
1383 (void) sd_event_source_set_description(m
->swap_event_source
, "swap-proc");
1386 r
= swap_load_proc_swaps(m
, false);
1396 int swap_process_device_new(Manager
*m
, sd_device
*dev
) {
1397 _cleanup_free_
char *e
= NULL
;
1398 const char *dn
, *devlink
;
1405 r
= sd_device_get_devname(dev
, &dn
);
1409 r
= unit_name_from_path(dn
, ".swap", &e
);
1413 u
= manager_get_unit(m
, e
);
1415 r
= swap_set_devnode(SWAP(u
), dn
);
1417 FOREACH_DEVICE_DEVLINK(dev
, devlink
) {
1418 _cleanup_free_
char *n
= NULL
;
1421 q
= unit_name_from_path(devlink
, ".swap", &n
);
1425 u
= manager_get_unit(m
, n
);
1427 q
= swap_set_devnode(SWAP(u
), dn
);
1436 int swap_process_device_remove(Manager
*m
, sd_device
*dev
) {
1441 r
= sd_device_get_devname(dev
, &dn
);
1445 while ((s
= hashmap_get(m
->swaps_by_devnode
, dn
))) {
1448 q
= swap_set_devnode(s
, NULL
);
1456 static void swap_reset_failed(Unit
*u
) {
1461 if (s
->state
== SWAP_FAILED
)
1462 swap_set_state(s
, SWAP_DEAD
);
1464 s
->result
= SWAP_SUCCESS
;
1465 s
->clean_result
= SWAP_SUCCESS
;
1468 static int swap_kill(Unit
*u
, KillWho who
, int signo
, sd_bus_error
*error
) {
1469 return unit_kill_common(u
, who
, signo
, -1, SWAP(u
)->control_pid
, error
);
1472 static int swap_get_timeout(Unit
*u
, usec_t
*timeout
) {
1477 if (!s
->timer_event_source
)
1480 r
= sd_event_source_get_time(s
->timer_event_source
, &t
);
1483 if (t
== USEC_INFINITY
)
1490 static bool swap_supported(void) {
1491 static int supported
= -1;
1493 /* If swap support is not available in the kernel, or we are
1494 * running in a container we don't support swap units, and any
1495 * attempts to starting one should fail immediately. */
1499 access("/proc/swaps", F_OK
) >= 0 &&
1500 detect_container() <= 0;
1505 static int swap_control_pid(Unit
*u
) {
1510 return s
->control_pid
;
1513 static int swap_clean(Unit
*u
, ExecCleanMask mask
) {
1514 _cleanup_strv_free_
char **l
= NULL
;
1521 if (s
->state
!= SWAP_DEAD
)
1524 r
= exec_context_get_clean_directories(&s
->exec_context
, u
->manager
->prefix
, mask
, &l
);
1528 if (strv_isempty(l
))
1531 swap_unwatch_control_pid(s
);
1532 s
->clean_result
= SWAP_SUCCESS
;
1533 s
->control_command
= NULL
;
1534 s
->control_command_id
= _SWAP_EXEC_COMMAND_INVALID
;
1536 r
= swap_arm_timer(s
, usec_add(now(CLOCK_MONOTONIC
), s
->exec_context
.timeout_clean_usec
));
1540 r
= unit_fork_and_watch_rm_rf(u
, l
, &s
->control_pid
);
1544 swap_set_state(s
, SWAP_CLEANING
);
1549 log_unit_warning_errno(u
, r
, "Failed to initiate cleaning: %m");
1550 s
->clean_result
= SWAP_FAILURE_RESOURCES
;
1551 s
->timer_event_source
= sd_event_source_unref(s
->timer_event_source
);
1555 static int swap_can_clean(Unit
*u
, ExecCleanMask
*ret
) {
1560 return exec_context_get_clean_mask(&s
->exec_context
, ret
);
1563 static const char* const swap_exec_command_table
[_SWAP_EXEC_COMMAND_MAX
] = {
1564 [SWAP_EXEC_ACTIVATE
] = "ExecActivate",
1565 [SWAP_EXEC_DEACTIVATE
] = "ExecDeactivate",
1568 DEFINE_STRING_TABLE_LOOKUP(swap_exec_command
, SwapExecCommand
);
1570 static const char* const swap_result_table
[_SWAP_RESULT_MAX
] = {
1571 [SWAP_SUCCESS
] = "success",
1572 [SWAP_FAILURE_RESOURCES
] = "resources",
1573 [SWAP_FAILURE_TIMEOUT
] = "timeout",
1574 [SWAP_FAILURE_EXIT_CODE
] = "exit-code",
1575 [SWAP_FAILURE_SIGNAL
] = "signal",
1576 [SWAP_FAILURE_CORE_DUMP
] = "core-dump",
1577 [SWAP_FAILURE_START_LIMIT_HIT
] = "start-limit-hit",
1580 DEFINE_STRING_TABLE_LOOKUP(swap_result
, SwapResult
);
1582 const UnitVTable swap_vtable
= {
1583 .object_size
= sizeof(Swap
),
1584 .exec_context_offset
= offsetof(Swap
, exec_context
),
1585 .cgroup_context_offset
= offsetof(Swap
, cgroup_context
),
1586 .kill_context_offset
= offsetof(Swap
, kill_context
),
1587 .exec_runtime_offset
= offsetof(Swap
, exec_runtime
),
1588 .dynamic_creds_offset
= offsetof(Swap
, dynamic_creds
),
1594 .private_section
= "Swap",
1600 .coldplug
= swap_coldplug
,
1604 .start
= swap_start
,
1608 .clean
= swap_clean
,
1609 .can_clean
= swap_can_clean
,
1611 .get_timeout
= swap_get_timeout
,
1613 .serialize
= swap_serialize
,
1614 .deserialize_item
= swap_deserialize_item
,
1616 .active_state
= swap_active_state
,
1617 .sub_state_to_string
= swap_sub_state_to_string
,
1619 .will_restart
= unit_will_restart_default
,
1621 .may_gc
= swap_may_gc
,
1623 .sigchld_event
= swap_sigchld_event
,
1625 .reset_failed
= swap_reset_failed
,
1627 .control_pid
= swap_control_pid
,
1629 .bus_vtable
= bus_swap_vtable
,
1630 .bus_set_property
= bus_swap_set_property
,
1631 .bus_commit_properties
= bus_swap_commit_properties
,
1633 .following
= swap_following
,
1634 .following_set
= swap_following_set
,
1636 .enumerate
= swap_enumerate
,
1637 .shutdown
= swap_shutdown
,
1638 .supported
= swap_supported
,
1640 .status_message_formats
= {
1641 .starting_stopping
= {
1642 [0] = "Activating swap %s...",
1643 [1] = "Deactivating swap %s...",
1645 .finished_start_job
= {
1646 [JOB_DONE
] = "Activated swap %s.",
1647 [JOB_FAILED
] = "Failed to activate swap %s.",
1648 [JOB_TIMEOUT
] = "Timed out activating swap %s.",
1650 .finished_stop_job
= {
1651 [JOB_DONE
] = "Deactivated swap %s.",
1652 [JOB_FAILED
] = "Failed deactivating swap %s.",
1653 [JOB_TIMEOUT
] = "Timed out deactivating swap %s.",