]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/core/swap.c
Merge pull request #32817 from YHNdnzj/core-varlink
[thirdparty/systemd.git] / src / core / swap.c
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2
3 #include <errno.h>
4 #include <sys/epoll.h>
5 #include <sys/stat.h>
6 #include <unistd.h>
7
8 #include "sd-device.h"
9
10 #include "alloc-util.h"
11 #include "dbus-swap.h"
12 #include "dbus-unit.h"
13 #include "device-util.h"
14 #include "device.h"
15 #include "escape.h"
16 #include "exit-status.h"
17 #include "fd-util.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"
24 #include "special.h"
25 #include "string-table.h"
26 #include "string-util.h"
27 #include "swap.h"
28 #include "unit-name.h"
29 #include "unit.h"
30 #include "virt.h"
31
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,
42 };
43
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);
47
48 static bool SWAP_STATE_WITH_PROCESS(SwapState state) {
49 return IN_SET(state,
50 SWAP_ACTIVATING,
51 SWAP_ACTIVATING_DONE,
52 SWAP_DEACTIVATING,
53 SWAP_DEACTIVATING_SIGTERM,
54 SWAP_DEACTIVATING_SIGKILL,
55 SWAP_CLEANING);
56 }
57
58 static UnitActiveState swap_active_state(Unit *u) {
59 assert(u);
60
61 return state_translation_table[SWAP(u)->state];
62 }
63
64 static const char *swap_sub_state_to_string(Unit *u) {
65 assert(u);
66
67 return swap_state_to_string(SWAP(u)->state);
68 }
69
70 static bool swap_may_gc(Unit *u) {
71 Swap *s = ASSERT_PTR(SWAP(u));
72
73 if (s->from_proc_swaps)
74 return false;
75
76 return true;
77 }
78
79 static bool swap_is_extrinsic(Unit *u) {
80 assert(SWAP(u));
81
82 return MANAGER_IS_USER(u->manager);
83 }
84
85 static void swap_unset_proc_swaps(Swap *s) {
86 assert(s);
87
88 if (!s->from_proc_swaps)
89 return;
90
91 s->parameters_proc_swaps.what = mfree(s->parameters_proc_swaps.what);
92 s->from_proc_swaps = false;
93 }
94
95 static int swap_set_devnode(Swap *s, const char *devnode) {
96 Hashmap *swaps;
97 Swap *first;
98 int r;
99
100 assert(s);
101
102 r = hashmap_ensure_allocated(&UNIT(s)->manager->swaps_by_devnode, &path_hash_ops);
103 if (r < 0)
104 return r;
105
106 swaps = UNIT(s)->manager->swaps_by_devnode;
107
108 if (s->devnode) {
109 first = hashmap_get(swaps, s->devnode);
110
111 LIST_REMOVE(same_devnode, first, s);
112 if (first)
113 hashmap_replace(swaps, first->devnode, first);
114 else
115 hashmap_remove(swaps, s->devnode);
116
117 s->devnode = mfree(s->devnode);
118 }
119
120 if (devnode) {
121 s->devnode = strdup(devnode);
122 if (!s->devnode)
123 return -ENOMEM;
124
125 first = hashmap_get(swaps, s->devnode);
126 LIST_PREPEND(same_devnode, first, s);
127
128 return hashmap_replace(swaps, first->devnode, first);
129 }
130
131 return 0;
132 }
133
134 static void swap_init(Unit *u) {
135 Swap *s = ASSERT_PTR(SWAP(u));
136
137 assert(u->load_state == UNIT_STUB);
138
139 s->timeout_usec = u->manager->defaults.timeout_start_usec;
140
141 s->exec_context.std_output = u->manager->defaults.std_output;
142 s->exec_context.std_error = u->manager->defaults.std_error;
143
144 s->control_pid = PIDREF_NULL;
145 s->control_command_id = _SWAP_EXEC_COMMAND_INVALID;
146
147 u->ignore_on_isolate = true;
148 }
149
150 static void swap_unwatch_control_pid(Swap *s) {
151 assert(s);
152 unit_unwatch_pidref_done(UNIT(s), &s->control_pid);
153 }
154
155 static void swap_done(Unit *u) {
156 Swap *s = ASSERT_PTR(SWAP(u));
157
158 swap_unset_proc_swaps(s);
159 swap_set_devnode(s, NULL);
160
161 s->what = mfree(s->what);
162 s->parameters_fragment.what = mfree(s->parameters_fragment.what);
163 s->parameters_fragment.options = mfree(s->parameters_fragment.options);
164
165 s->exec_runtime = exec_runtime_free(s->exec_runtime);
166
167 exec_command_done_array(s->exec_command, _SWAP_EXEC_COMMAND_MAX);
168 s->control_command = NULL;
169
170 swap_unwatch_control_pid(s);
171
172 s->timer_event_source = sd_event_source_disable_unref(s->timer_event_source);
173 }
174
175 static int swap_arm_timer(Swap *s, bool relative, usec_t usec) {
176 assert(s);
177
178 return unit_arm_timer(UNIT(s), &s->timer_event_source, relative, usec, swap_dispatch_timer);
179 }
180
181 static SwapParameters* swap_get_parameters(Swap *s) {
182 assert(s);
183
184 if (s->from_proc_swaps)
185 return &s->parameters_proc_swaps;
186
187 if (s->from_fragment)
188 return &s->parameters_fragment;
189
190 return NULL;
191 }
192
193 static int swap_add_device_dependencies(Swap *s) {
194 UnitDependencyMask mask;
195 SwapParameters *p;
196 int r;
197
198 assert(s);
199
200 if (!s->what)
201 return 0;
202
203 p = swap_get_parameters(s);
204 if (!p || !p->what)
205 return 0;
206
207 mask = s->from_proc_swaps ? UNIT_DEPENDENCY_PROC_SWAP : UNIT_DEPENDENCY_FILE;
208
209 if (is_device_path(p->what)) {
210 r = unit_add_node_dependency(UNIT(s), p->what, UNIT_REQUIRES, mask);
211 if (r < 0)
212 return r;
213
214 return unit_add_blockdev_dependency(UNIT(s), p->what, mask);
215 }
216
217 /* File based swap devices need to be ordered after systemd-remount-fs.service, since they might need
218 * a writable file system. */
219 return unit_add_dependency_by_name(UNIT(s), UNIT_AFTER, SPECIAL_REMOUNT_FS_SERVICE, true, mask);
220 }
221
222 static int swap_add_default_dependencies(Swap *s) {
223 int r;
224
225 assert(s);
226
227 if (!UNIT(s)->default_dependencies)
228 return 0;
229
230 if (!MANAGER_IS_SYSTEM(UNIT(s)->manager))
231 return 0;
232
233 if (detect_container() > 0)
234 return 0;
235
236 /* swap units generated for the swap dev links are missing the
237 * ordering dep against the swap target. */
238 r = unit_add_dependency_by_name(UNIT(s), UNIT_BEFORE, SPECIAL_SWAP_TARGET, true, UNIT_DEPENDENCY_DEFAULT);
239 if (r < 0)
240 return r;
241
242 return unit_add_two_dependencies_by_name(UNIT(s), UNIT_BEFORE, UNIT_CONFLICTS, SPECIAL_UMOUNT_TARGET, true, UNIT_DEPENDENCY_DEFAULT);
243 }
244
245 static int swap_verify(Swap *s) {
246 _cleanup_free_ char *e = NULL;
247 int r;
248
249 assert(s);
250 assert(UNIT(s)->load_state == UNIT_LOADED);
251
252 r = unit_name_from_path(s->what, ".swap", &e);
253 if (r < 0)
254 return log_unit_error_errno(UNIT(s), r, "Failed to generate unit name from path: %m");
255
256 if (!unit_has_name(UNIT(s), e))
257 return log_unit_error_errno(UNIT(s), SYNTHETIC_ERRNO(ENOEXEC), "Value of What= and unit name do not match, not loading.");
258
259 if (s->exec_context.pam_name && s->kill_context.kill_mode != KILL_CONTROL_GROUP)
260 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.");
261
262 return 0;
263 }
264
265 static int swap_load_devnode(Swap *s) {
266 _cleanup_free_ char *p = NULL;
267 struct stat st;
268 int r;
269
270 assert(s);
271
272 if (stat(s->what, &st) < 0 || !S_ISBLK(st.st_mode))
273 return 0;
274
275 r = devname_from_stat_rdev(&st, &p);
276 if (r < 0) {
277 log_unit_full_errno(UNIT(s), r == -ENOENT ? LOG_DEBUG : LOG_WARNING, r,
278 "Failed to get device node for swap %s: %m", s->what);
279 return 0;
280 }
281
282 return swap_set_devnode(s, p);
283 }
284
285 static int swap_add_extras(Swap *s) {
286 int r;
287
288 assert(s);
289
290 if (UNIT(s)->fragment_path)
291 s->from_fragment = true;
292
293 if (!s->what) {
294 if (s->parameters_fragment.what)
295 s->what = strdup(s->parameters_fragment.what);
296 else if (s->parameters_proc_swaps.what)
297 s->what = strdup(s->parameters_proc_swaps.what);
298 else {
299 r = unit_name_to_path(UNIT(s)->id, &s->what);
300 if (r < 0)
301 return r;
302 }
303
304 if (!s->what)
305 return -ENOMEM;
306 }
307
308 path_simplify(s->what);
309
310 if (!UNIT(s)->description) {
311 r = unit_set_description(UNIT(s), s->what);
312 if (r < 0)
313 return r;
314 }
315
316 r = unit_add_mounts_for(UNIT(s), s->what, UNIT_DEPENDENCY_IMPLICIT, UNIT_MOUNT_REQUIRES);
317 if (r < 0)
318 return r;
319
320 r = swap_add_device_dependencies(s);
321 if (r < 0)
322 return r;
323
324 r = swap_load_devnode(s);
325 if (r < 0)
326 return r;
327
328 r = unit_patch_contexts(UNIT(s));
329 if (r < 0)
330 return r;
331
332 r = unit_add_exec_dependencies(UNIT(s), &s->exec_context);
333 if (r < 0)
334 return r;
335
336 r = unit_set_default_slice(UNIT(s));
337 if (r < 0)
338 return r;
339
340 r = swap_add_default_dependencies(s);
341 if (r < 0)
342 return r;
343
344 return 0;
345 }
346
347 static int swap_load(Unit *u) {
348 Swap *s = ASSERT_PTR(SWAP(u));
349 int r;
350
351 assert(u->load_state == UNIT_STUB);
352
353 /* Load a .swap file */
354 r = unit_load_fragment_and_dropin(u, /* fragment_required = */ !s->from_proc_swaps);
355
356 /* Add in some extras, and do so either when we successfully loaded something or when /proc/swaps is
357 * already active. */
358 if (u->load_state == UNIT_LOADED || s->from_proc_swaps)
359 RET_GATHER(r, swap_add_extras(s));
360
361 if (r < 0)
362 return r;
363
364 if (u->load_state != UNIT_LOADED)
365 return 0;
366
367 return swap_verify(s);
368 }
369
370 static int swap_setup_unit(
371 Manager *m,
372 const char *what,
373 const char *what_proc_swaps,
374 int priority,
375 bool set_flags) {
376
377 _cleanup_(unit_freep) Unit *new = NULL;
378 _cleanup_free_ char *e = NULL;
379 Unit *u;
380 Swap *s;
381 int r;
382
383 assert(m);
384 assert(what);
385 assert(what_proc_swaps);
386
387 r = unit_name_from_path(what, ".swap", &e);
388 if (r < 0)
389 return log_error_errno(r, "Failed to generate unit name from path: %m");
390
391 u = manager_get_unit(m, e);
392 if (u) {
393 s = ASSERT_PTR(SWAP(u));
394
395 if (s->from_proc_swaps &&
396 !path_equal(s->parameters_proc_swaps.what, what_proc_swaps))
397 return log_unit_error_errno(u, SYNTHETIC_ERRNO(EEXIST),
398 "Swap appeared twice with different device paths %s and %s, refusing.",
399 s->parameters_proc_swaps.what, what_proc_swaps);
400 } else {
401 r = unit_new_for_name(m, sizeof(Swap), e, &new);
402 if (r < 0)
403 return log_warning_errno(r, "Failed to load swap unit '%s': %m", e);
404
405 u = new;
406 s = ASSERT_PTR(SWAP(u));
407
408 s->what = strdup(what);
409 if (!s->what)
410 return log_oom();
411
412 unit_add_to_load_queue(u);
413 }
414
415 SwapParameters *p = &s->parameters_proc_swaps;
416
417 if (!p->what) {
418 p->what = strdup(what_proc_swaps);
419 if (!p->what)
420 return log_oom();
421 }
422
423 /* The unit is definitely around now, mark it as loaded if it was previously referenced but
424 * could not be loaded. After all we can load it now, from the data in /proc/swaps. */
425 if (UNIT_IS_LOAD_ERROR(u->load_state)) {
426 u->load_state = UNIT_LOADED;
427 u->load_error = 0;
428 }
429
430 if (set_flags) {
431 s->is_active = true;
432 s->just_activated = !s->from_proc_swaps;
433 }
434
435 s->from_proc_swaps = true;
436
437 p->priority = priority;
438 p->priority_set = true;
439
440 unit_add_to_dbus_queue(u);
441 TAKE_PTR(new);
442
443 return 0;
444 }
445
446 static void swap_process_new(Manager *m, const char *device, int prio, bool set_flags) {
447 _cleanup_(sd_device_unrefp) sd_device *d = NULL;
448 const char *dn;
449 struct stat st, st_link;
450 int r;
451
452 assert(m);
453
454 if (swap_setup_unit(m, device, device, prio, set_flags) < 0)
455 return;
456
457 /* If this is a block device, then let's add duplicates for
458 * all other names of this block device */
459 if (stat(device, &st) < 0 || !S_ISBLK(st.st_mode))
460 return;
461
462 r = sd_device_new_from_stat_rdev(&d, &st);
463 if (r < 0)
464 return (void) log_full_errno(r == -ENOENT ? LOG_DEBUG : LOG_WARNING, r,
465 "Failed to allocate device for swap %s: %m", device);
466
467 /* Add the main device node */
468 if (sd_device_get_devname(d, &dn) >= 0 && !streq(dn, device))
469 (void) swap_setup_unit(m, dn, device, prio, set_flags);
470
471 /* Add additional units for all symlinks */
472 FOREACH_DEVICE_DEVLINK(d, devlink) {
473
474 /* Don't bother with the /dev/block links */
475 if (streq(devlink, device))
476 continue;
477
478 if (path_startswith(devlink, "/dev/block/"))
479 continue;
480
481 if (stat(devlink, &st_link) >= 0 &&
482 (!S_ISBLK(st_link.st_mode) ||
483 st_link.st_rdev != st.st_rdev))
484 continue;
485
486 (void) swap_setup_unit(m, devlink, device, prio, set_flags);
487 }
488 }
489
490 static void swap_set_state(Swap *s, SwapState state) {
491 SwapState old_state;
492
493 assert(s);
494
495 if (s->state != state)
496 bus_unit_send_pending_change_signal(UNIT(s), false);
497
498 old_state = s->state;
499 s->state = state;
500
501 if (!SWAP_STATE_WITH_PROCESS(state)) {
502 s->timer_event_source = sd_event_source_disable_unref(s->timer_event_source);
503 swap_unwatch_control_pid(s);
504 s->control_command = NULL;
505 s->control_command_id = _SWAP_EXEC_COMMAND_INVALID;
506 }
507
508 if (state != old_state)
509 log_unit_debug(UNIT(s), "Changed %s -> %s", swap_state_to_string(old_state), swap_state_to_string(state));
510
511 unit_notify(UNIT(s), state_translation_table[old_state], state_translation_table[state], /* reload_success = */ true);
512
513 /* If there other units for the same device node have a job
514 queued it might be worth checking again if it is runnable
515 now. This is necessary, since swap_start() refuses
516 operation with EAGAIN if there's already another job for
517 the same device node queued. */
518 LIST_FOREACH_OTHERS(same_devnode, other, s)
519 if (UNIT(other)->job)
520 job_add_to_run_queue(UNIT(other)->job);
521 }
522
523 static int swap_coldplug(Unit *u) {
524 Swap *s = ASSERT_PTR(SWAP(u));
525 SwapState new_state = SWAP_DEAD;
526 int r;
527
528 assert(s->state == SWAP_DEAD);
529
530 if (s->deserialized_state != s->state)
531 new_state = s->deserialized_state;
532 else if (s->from_proc_swaps)
533 new_state = SWAP_ACTIVE;
534
535 if (new_state == s->state)
536 return 0;
537
538 if (pidref_is_set(&s->control_pid) &&
539 pidref_is_unwaited(&s->control_pid) > 0 &&
540 SWAP_STATE_WITH_PROCESS(new_state)) {
541
542 r = unit_watch_pidref(UNIT(s), &s->control_pid, /* exclusive= */ false);
543 if (r < 0)
544 return r;
545
546 r = swap_arm_timer(s, /* relative= */ false, usec_add(u->state_change_timestamp.monotonic, s->timeout_usec));
547 if (r < 0)
548 return r;
549 }
550
551 if (!IN_SET(new_state, SWAP_DEAD, SWAP_FAILED)) {
552 (void) unit_setup_exec_runtime(u);
553 (void) unit_setup_cgroup_runtime(u);
554 }
555
556 swap_set_state(s, new_state);
557 return 0;
558 }
559
560 static void swap_dump(Unit *u, FILE *f, const char *prefix) {
561 Swap *s = ASSERT_PTR(SWAP(u));
562 SwapParameters *p;
563 const char *prefix2;
564
565 assert(f);
566
567 prefix = strempty(prefix);
568 prefix2 = strjoina(prefix, "\t");
569
570 if (s->from_proc_swaps)
571 p = &s->parameters_proc_swaps;
572 else if (s->from_fragment)
573 p = &s->parameters_fragment;
574 else
575 p = NULL;
576
577 fprintf(f,
578 "%sSwap State: %s\n"
579 "%sResult: %s\n"
580 "%sClean Result: %s\n"
581 "%sWhat: %s\n"
582 "%sFrom /proc/swaps: %s\n"
583 "%sFrom fragment: %s\n"
584 "%sExtrinsic: %s\n",
585 prefix, swap_state_to_string(s->state),
586 prefix, swap_result_to_string(s->result),
587 prefix, swap_result_to_string(s->clean_result),
588 prefix, s->what,
589 prefix, yes_no(s->from_proc_swaps),
590 prefix, yes_no(s->from_fragment),
591 prefix, yes_no(swap_is_extrinsic(u)));
592
593 if (s->devnode)
594 fprintf(f, "%sDevice Node: %s\n", prefix, s->devnode);
595
596 if (p)
597 fprintf(f,
598 "%sPriority: %i\n"
599 "%sOptions: %s\n",
600 prefix, p->priority,
601 prefix, strempty(p->options));
602
603 fprintf(f,
604 "%sTimeoutSec: %s\n",
605 prefix, FORMAT_TIMESPAN(s->timeout_usec, USEC_PER_SEC));
606
607 if (pidref_is_set(&s->control_pid))
608 fprintf(f,
609 "%sControl PID: "PID_FMT"\n",
610 prefix, s->control_pid.pid);
611
612 exec_context_dump(&s->exec_context, f, prefix);
613 kill_context_dump(&s->kill_context, f, prefix);
614 cgroup_context_dump(UNIT(s), f, prefix);
615
616 for (SwapExecCommand c = 0; c < _SWAP_EXEC_COMMAND_MAX; c++) {
617 if (!s->exec_command[c].argv)
618 continue;
619
620 fprintf(f, "%s%s %s:\n",
621 prefix, special_glyph(SPECIAL_GLYPH_ARROW_RIGHT), swap_exec_command_to_string(c));
622
623 exec_command_dump(s->exec_command + c, f, prefix2);
624 }
625
626 }
627
628 static int swap_spawn(Swap *s, ExecCommand *c, PidRef *ret_pid) {
629 _cleanup_(exec_params_shallow_clear) ExecParameters exec_params = EXEC_PARAMETERS_INIT(
630 EXEC_APPLY_SANDBOXING|EXEC_APPLY_CHROOT|EXEC_APPLY_TTY_STDIN);
631 _cleanup_(pidref_done) PidRef pidref = PIDREF_NULL;
632 int r;
633
634 assert(s);
635 assert(c);
636 assert(ret_pid);
637
638 r = unit_prepare_exec(UNIT(s));
639 if (r < 0)
640 return r;
641
642 r = swap_arm_timer(s, /* relative= */ true, s->timeout_usec);
643 if (r < 0)
644 return r;
645
646 r = unit_set_exec_params(UNIT(s), &exec_params);
647 if (r < 0)
648 return r;
649
650 r = exec_spawn(UNIT(s),
651 c,
652 &s->exec_context,
653 &exec_params,
654 s->exec_runtime,
655 &s->cgroup_context,
656 &pidref);
657 if (r < 0)
658 return r;
659
660 r = unit_watch_pidref(UNIT(s), &pidref, /* exclusive= */ true);
661 if (r < 0)
662 return r;
663
664 *ret_pid = TAKE_PIDREF(pidref);
665 return 0;
666 }
667
668 static void swap_enter_dead(Swap *s, SwapResult f) {
669 assert(s);
670
671 if (s->result == SWAP_SUCCESS)
672 s->result = f;
673
674 unit_log_result(UNIT(s), s->result == SWAP_SUCCESS, swap_result_to_string(s->result));
675 unit_warn_leftover_processes(UNIT(s), unit_log_leftover_process_stop);
676 swap_set_state(s, s->result != SWAP_SUCCESS ? SWAP_FAILED : SWAP_DEAD);
677
678 s->exec_runtime = exec_runtime_destroy(s->exec_runtime);
679
680 unit_destroy_runtime_data(UNIT(s), &s->exec_context);
681
682 unit_unref_uid_gid(UNIT(s), true);
683 }
684
685 static void swap_enter_active(Swap *s, SwapResult f) {
686 assert(s);
687
688 if (s->result == SWAP_SUCCESS)
689 s->result = f;
690
691 swap_set_state(s, SWAP_ACTIVE);
692 }
693
694 static void swap_enter_dead_or_active(Swap *s, SwapResult f) {
695 assert(s);
696
697 if (s->from_proc_swaps) {
698 swap_enter_active(s, f);
699
700 LIST_FOREACH_OTHERS(same_devnode, other, s)
701 if (UNIT(other)->job)
702 swap_enter_dead_or_active(other, f);
703 } else
704 swap_enter_dead(s, f);
705 }
706
707 static int state_to_kill_operation(Swap *s, SwapState state) {
708 if (state == SWAP_DEACTIVATING_SIGTERM) {
709 if (unit_has_job_type(UNIT(s), JOB_RESTART))
710 return KILL_RESTART;
711 else
712 return KILL_TERMINATE;
713 }
714
715 return KILL_KILL;
716 }
717
718 static void swap_enter_signal(Swap *s, SwapState state, SwapResult f) {
719 int r;
720
721 assert(s);
722
723 if (s->result == SWAP_SUCCESS)
724 s->result = f;
725
726 r = unit_kill_context(UNIT(s), state_to_kill_operation(s, state));
727 if (r < 0) {
728 log_unit_warning_errno(UNIT(s), r, "Failed to kill processes: %m");
729 goto fail;
730 }
731
732 if (r > 0) {
733 r = swap_arm_timer(s, /* relative= */ true, s->timeout_usec);
734 if (r < 0) {
735 log_unit_warning_errno(UNIT(s), r, "Failed to install timer: %m");
736 goto fail;
737 }
738
739 swap_set_state(s, state);
740 } else if (state == SWAP_DEACTIVATING_SIGTERM && s->kill_context.send_sigkill)
741 swap_enter_signal(s, SWAP_DEACTIVATING_SIGKILL, SWAP_SUCCESS);
742 else
743 swap_enter_dead_or_active(s, SWAP_SUCCESS);
744
745 return;
746
747 fail:
748 swap_enter_dead_or_active(s, SWAP_FAILURE_RESOURCES);
749 }
750
751 static void swap_enter_activating(Swap *s) {
752 _cleanup_free_ char *opts = NULL;
753 int r;
754
755 assert(s);
756
757 unit_warn_leftover_processes(UNIT(s), unit_log_leftover_process_start);
758
759 s->control_command_id = SWAP_EXEC_ACTIVATE;
760 s->control_command = s->exec_command + SWAP_EXEC_ACTIVATE;
761
762 if (s->from_fragment) {
763 int priority = 0;
764
765 r = fstab_find_pri(s->parameters_fragment.options, &priority);
766 if (r < 0)
767 log_unit_warning_errno(UNIT(s), r, "Failed to parse swap priority \"%s\", ignoring: %m", s->parameters_fragment.options);
768 else if (r > 0 && s->parameters_fragment.priority_set)
769 log_unit_warning(UNIT(s), "Duplicate swap priority configuration by Priority= and Options= fields.");
770
771 if (r <= 0 && s->parameters_fragment.priority_set) {
772 if (s->parameters_fragment.options)
773 r = asprintf(&opts, "%s,pri=%i", s->parameters_fragment.options, s->parameters_fragment.priority);
774 else
775 r = asprintf(&opts, "pri=%i", s->parameters_fragment.priority);
776 if (r < 0) {
777 r = log_oom();
778 goto fail;
779 }
780 }
781 }
782
783 r = exec_command_set(s->control_command, "/sbin/swapon", "--fixpgsz", NULL);
784 if (r < 0) {
785 log_unit_warning_errno(UNIT(s), r, "Failed to initialize swapon command line: %m");
786 goto fail;
787 }
788
789 if (s->parameters_fragment.options || opts) {
790 r = exec_command_append(s->control_command, "-o",
791 opts ?: s->parameters_fragment.options, NULL);
792 if (r < 0) {
793 log_unit_warning_errno(UNIT(s), r, "Failed to prepare swapon command line: %m");
794 goto fail;
795 }
796 }
797
798 r = exec_command_append(s->control_command, s->what, NULL);
799 if (r < 0) {
800 log_unit_warning_errno(UNIT(s), r, "Failed to prepare swapon command line: %m");
801 goto fail;
802 }
803
804 swap_unwatch_control_pid(s);
805
806 r = swap_spawn(s, s->control_command, &s->control_pid);
807 if (r < 0) {
808 log_unit_warning_errno(UNIT(s), r, "Failed to spawn 'swapon' task: %m");
809 goto fail;
810 }
811
812 swap_set_state(s, SWAP_ACTIVATING);
813 return;
814
815 fail:
816 swap_enter_dead_or_active(s, SWAP_FAILURE_RESOURCES);
817 }
818
819 static void swap_enter_deactivating(Swap *s) {
820 int r;
821
822 assert(s);
823
824 s->control_command_id = SWAP_EXEC_DEACTIVATE;
825 s->control_command = s->exec_command + SWAP_EXEC_DEACTIVATE;
826
827 r = exec_command_set(s->control_command,
828 "/sbin/swapoff",
829 s->what,
830 NULL);
831 if (r < 0) {
832 log_unit_warning_errno(UNIT(s), r, "Failed to prepare swapoff command line: %m");
833 goto fail;
834 }
835
836 swap_unwatch_control_pid(s);
837
838 r = swap_spawn(s, s->control_command, &s->control_pid);
839 if (r < 0) {
840 log_unit_warning_errno(UNIT(s), r, "Failed to spawn 'swapoff' task: %m");
841 goto fail;
842 }
843
844 swap_set_state(s, SWAP_DEACTIVATING);
845 return;
846
847 fail:
848 swap_enter_dead_or_active(s, SWAP_FAILURE_RESOURCES);
849 }
850
851 static void swap_cycle_clear(Swap *s) {
852 assert(s);
853
854 s->result = SWAP_SUCCESS;
855 exec_command_reset_status_array(s->exec_command, _SWAP_EXEC_COMMAND_MAX);
856
857 if (s->cgroup_runtime)
858 s->cgroup_runtime->reset_accounting = true;
859 }
860
861 static int swap_start(Unit *u) {
862 Swap *s = SWAP(u);
863 int r;
864
865 assert(s);
866
867 /* We cannot fulfill this request right now, try again later please! */
868 if (IN_SET(s->state,
869 SWAP_DEACTIVATING,
870 SWAP_DEACTIVATING_SIGTERM,
871 SWAP_DEACTIVATING_SIGKILL,
872 SWAP_CLEANING))
873 return -EAGAIN;
874
875 /* Already on it! */
876 if (s->state == SWAP_ACTIVATING)
877 return 0;
878
879 assert(IN_SET(s->state, SWAP_DEAD, SWAP_FAILED));
880
881 if (detect_container() > 0)
882 return -EPERM;
883
884 /* If there's a job for another swap unit for the same node
885 * running, then let's not dispatch this one for now, and wait
886 * until that other job has finished. */
887 LIST_FOREACH_OTHERS(same_devnode, other, s)
888 if (UNIT(other)->job && UNIT(other)->job->state == JOB_RUNNING)
889 return -EAGAIN;
890
891 r = unit_acquire_invocation_id(u);
892 if (r < 0)
893 return r;
894
895 swap_cycle_clear(s);
896 swap_enter_activating(s);
897 return 1;
898 }
899
900 static int swap_stop(Unit *u) {
901 Swap *s = ASSERT_PTR(SWAP(u));
902
903 switch (s->state) {
904
905 case SWAP_DEACTIVATING:
906 case SWAP_DEACTIVATING_SIGTERM:
907 case SWAP_DEACTIVATING_SIGKILL:
908 /* Already on it */
909 return 0;
910
911 case SWAP_ACTIVATING:
912 case SWAP_ACTIVATING_DONE:
913 /* There's a control process pending, directly enter kill mode */
914 swap_enter_signal(s, SWAP_DEACTIVATING_SIGTERM, SWAP_SUCCESS);
915 return 0;
916
917 case SWAP_ACTIVE:
918 if (detect_container() > 0)
919 return -EPERM;
920
921 swap_enter_deactivating(s);
922 return 1;
923
924 case SWAP_CLEANING:
925 /* If we are currently cleaning, then abort it, brutally. */
926 swap_enter_signal(s, SWAP_DEACTIVATING_SIGKILL, SWAP_SUCCESS);
927 return 0;
928
929 default:
930 assert_not_reached();
931 }
932 }
933
934 static int swap_serialize(Unit *u, FILE *f, FDSet *fds) {
935 Swap *s = ASSERT_PTR(SWAP(u));
936
937 assert(f);
938 assert(fds);
939
940 (void) serialize_item(f, "state", swap_state_to_string(s->state));
941 (void) serialize_item(f, "result", swap_result_to_string(s->result));
942 (void) serialize_pidref(f, fds, "control-pid", &s->control_pid);
943
944 if (s->control_command_id >= 0)
945 (void) serialize_item(f, "control-command", swap_exec_command_to_string(s->control_command_id));
946
947 return 0;
948 }
949
950 static int swap_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
951 Swap *s = ASSERT_PTR(SWAP(u));
952
953 assert(fds);
954
955 if (streq(key, "state")) {
956 SwapState state;
957
958 state = swap_state_from_string(value);
959 if (state < 0)
960 log_unit_debug(u, "Failed to parse state value: %s", value);
961 else
962 s->deserialized_state = state;
963 } else if (streq(key, "result")) {
964 SwapResult f;
965
966 f = swap_result_from_string(value);
967 if (f < 0)
968 log_unit_debug(u, "Failed to parse result value: %s", value);
969 else if (f != SWAP_SUCCESS)
970 s->result = f;
971 } else if (streq(key, "control-pid")) {
972
973 if (!pidref_is_set(&s->control_pid))
974 (void) deserialize_pidref(fds, value, &s->control_pid);
975
976 } else if (streq(key, "control-command")) {
977 SwapExecCommand id;
978
979 id = swap_exec_command_from_string(value);
980 if (id < 0)
981 log_unit_debug(u, "Failed to parse exec-command value: %s", value);
982 else {
983 s->control_command_id = id;
984 s->control_command = s->exec_command + id;
985 }
986 } else
987 log_unit_debug(u, "Unknown serialization key: %s", key);
988
989 return 0;
990 }
991
992 static void swap_sigchld_event(Unit *u, pid_t pid, int code, int status) {
993 Swap *s = ASSERT_PTR(SWAP(u));
994 SwapResult f;
995
996 assert(pid >= 0);
997
998 if (pid != s->control_pid.pid)
999 return;
1000
1001 /* Let's scan /proc/swaps before we process SIGCHLD. For the reasoning see the similar code in
1002 * mount.c */
1003 (void) swap_process_proc_swaps(u->manager);
1004
1005 pidref_done(&s->control_pid);
1006
1007 if (is_clean_exit(code, status, EXIT_CLEAN_COMMAND, NULL))
1008 f = SWAP_SUCCESS;
1009 else if (code == CLD_EXITED)
1010 f = SWAP_FAILURE_EXIT_CODE;
1011 else if (code == CLD_KILLED)
1012 f = SWAP_FAILURE_SIGNAL;
1013 else if (code == CLD_DUMPED)
1014 f = SWAP_FAILURE_CORE_DUMP;
1015 else
1016 assert_not_reached();
1017
1018 if (s->result == SWAP_SUCCESS)
1019 s->result = f;
1020
1021 if (s->control_command) {
1022 exec_status_exit(&s->control_command->exec_status, &s->exec_context, pid, code, status);
1023
1024 s->control_command = NULL;
1025 s->control_command_id = _SWAP_EXEC_COMMAND_INVALID;
1026 }
1027
1028 unit_log_process_exit(
1029 u,
1030 "Swap process",
1031 swap_exec_command_to_string(s->control_command_id),
1032 f == SWAP_SUCCESS,
1033 code, status);
1034
1035 switch (s->state) {
1036
1037 case SWAP_ACTIVATING:
1038 case SWAP_ACTIVATING_DONE:
1039
1040 if (f == SWAP_SUCCESS || s->from_proc_swaps)
1041 swap_enter_active(s, f);
1042 else
1043 swap_enter_dead(s, f);
1044 break;
1045
1046 case SWAP_DEACTIVATING:
1047 case SWAP_DEACTIVATING_SIGKILL:
1048 case SWAP_DEACTIVATING_SIGTERM:
1049
1050 swap_enter_dead_or_active(s, f);
1051 break;
1052
1053 case SWAP_CLEANING:
1054 if (s->clean_result == SWAP_SUCCESS)
1055 s->clean_result = f;
1056
1057 swap_enter_dead(s, SWAP_SUCCESS);
1058 break;
1059
1060 default:
1061 assert_not_reached();
1062 }
1063
1064 /* Notify clients about changed exit status */
1065 unit_add_to_dbus_queue(u);
1066 }
1067
1068 static int swap_dispatch_timer(sd_event_source *source, usec_t usec, void *userdata) {
1069 Swap *s = ASSERT_PTR(SWAP(userdata));
1070
1071 assert(s->timer_event_source == source);
1072
1073 switch (s->state) {
1074
1075 case SWAP_ACTIVATING:
1076 case SWAP_ACTIVATING_DONE:
1077 log_unit_warning(UNIT(s), "Activation timed out. Stopping.");
1078 swap_enter_signal(s, SWAP_DEACTIVATING_SIGTERM, SWAP_FAILURE_TIMEOUT);
1079 break;
1080
1081 case SWAP_DEACTIVATING:
1082 log_unit_warning(UNIT(s), "Deactivation timed out. Stopping.");
1083 swap_enter_signal(s, SWAP_DEACTIVATING_SIGTERM, SWAP_FAILURE_TIMEOUT);
1084 break;
1085
1086 case SWAP_DEACTIVATING_SIGTERM:
1087 if (s->kill_context.send_sigkill) {
1088 log_unit_warning(UNIT(s), "Swap process timed out. Killing.");
1089 swap_enter_signal(s, SWAP_DEACTIVATING_SIGKILL, SWAP_FAILURE_TIMEOUT);
1090 } else {
1091 log_unit_warning(UNIT(s), "Swap process timed out. Skipping SIGKILL. Ignoring.");
1092 swap_enter_dead_or_active(s, SWAP_FAILURE_TIMEOUT);
1093 }
1094 break;
1095
1096 case SWAP_DEACTIVATING_SIGKILL:
1097 log_unit_warning(UNIT(s), "Swap process still around after SIGKILL. Ignoring.");
1098 swap_enter_dead_or_active(s, SWAP_FAILURE_TIMEOUT);
1099 break;
1100
1101 case SWAP_CLEANING:
1102 log_unit_warning(UNIT(s), "Cleaning timed out. killing.");
1103
1104 if (s->clean_result == SWAP_SUCCESS)
1105 s->clean_result = SWAP_FAILURE_TIMEOUT;
1106
1107 swap_enter_signal(s, SWAP_DEACTIVATING_SIGKILL, 0);
1108 break;
1109
1110 default:
1111 assert_not_reached();
1112 }
1113
1114 return 0;
1115 }
1116
1117 static int swap_load_proc_swaps(Manager *m, bool set_flags) {
1118 assert(m);
1119
1120 rewind(m->proc_swaps);
1121
1122 (void) fscanf(m->proc_swaps, "%*s %*s %*s %*s %*s\n");
1123
1124 for (unsigned i = 1;; i++) {
1125 _cleanup_free_ char *dev = NULL, *d = NULL;
1126 int prio = 0, k;
1127
1128 k = fscanf(m->proc_swaps,
1129 "%ms " /* device/file */
1130 "%*s " /* type of swap */
1131 "%*s " /* swap size */
1132 "%*s " /* used */
1133 "%i\n", /* priority */
1134 &dev, &prio);
1135 if (k != 2) {
1136 if (k == EOF)
1137 break;
1138
1139 log_warning("Failed to parse /proc/swaps:%u, skipping.", i);
1140 continue;
1141 }
1142
1143 ssize_t l = cunescape(dev, UNESCAPE_RELAX, &d);
1144 if (l < 0)
1145 return log_error_errno(l, "Failed to unescape device path: %m");
1146
1147 device_found_node(m, d, DEVICE_FOUND_SWAP, DEVICE_FOUND_SWAP);
1148
1149 (void) swap_process_new(m, d, prio, set_flags);
1150 }
1151
1152 return 0;
1153 }
1154
1155 static int swap_process_proc_swaps(Manager *m) {
1156 int r;
1157
1158 assert(m);
1159
1160 r = swap_load_proc_swaps(m, true);
1161 if (r < 0) {
1162 /* Reset flags, just in case, for late calls */
1163 LIST_FOREACH(units_by_type, u, m->units_by_type[UNIT_SWAP]) {
1164 Swap *swap = SWAP(u);
1165
1166 assert(swap);
1167
1168 swap->is_active = swap->just_activated = false;
1169 }
1170
1171 return 0;
1172 }
1173
1174 manager_dispatch_load_queue(m);
1175
1176 LIST_FOREACH(units_by_type, u, m->units_by_type[UNIT_SWAP]) {
1177 Swap *swap = SWAP(u);
1178
1179 assert(swap);
1180
1181 if (!swap->is_active) {
1182
1183 swap_unset_proc_swaps(swap);
1184
1185 switch (swap->state) {
1186
1187 case SWAP_ACTIVE:
1188 /* This has just been deactivated */
1189 swap_enter_dead(swap, SWAP_SUCCESS);
1190 break;
1191
1192 default:
1193 /* Fire again */
1194 swap_set_state(swap, swap->state);
1195 break;
1196 }
1197
1198 if (swap->what)
1199 device_found_node(m, swap->what, DEVICE_NOT_FOUND, DEVICE_FOUND_SWAP);
1200
1201 } else if (swap->just_activated) {
1202
1203 /* New swap entry */
1204
1205 switch (swap->state) {
1206
1207 case SWAP_DEAD:
1208 case SWAP_FAILED:
1209 (void) unit_acquire_invocation_id(u);
1210 swap_cycle_clear(swap);
1211 swap_enter_active(swap, SWAP_SUCCESS);
1212 break;
1213
1214 case SWAP_ACTIVATING:
1215 swap_set_state(swap, SWAP_ACTIVATING_DONE);
1216 break;
1217
1218 default:
1219 /* Nothing really changed, but let's
1220 * issue an notification call
1221 * nonetheless, in case somebody is
1222 * waiting for this. */
1223 swap_set_state(swap, swap->state);
1224 break;
1225 }
1226 }
1227
1228 /* Reset the flags for later calls */
1229 swap->is_active = swap->just_activated = false;
1230 }
1231
1232 return 1;
1233 }
1234
1235 static int swap_dispatch_io(sd_event_source *source, int fd, uint32_t revents, void *userdata) {
1236 Manager *m = ASSERT_PTR(userdata);
1237
1238 assert(revents & EPOLLPRI);
1239
1240 return swap_process_proc_swaps(m);
1241 }
1242
1243 static Unit* swap_following(Unit *u) {
1244 Swap *s = ASSERT_PTR(SWAP(u));
1245 Swap *first = NULL;
1246
1247 /* If the user configured the swap through /etc/fstab or
1248 * a device unit, follow that. */
1249
1250 if (s->from_fragment)
1251 return NULL;
1252
1253 LIST_FOREACH_OTHERS(same_devnode, other, s)
1254 if (other->from_fragment)
1255 return UNIT(other);
1256
1257 /* Otherwise, make everybody follow the unit that's named after
1258 * the swap device in the kernel */
1259
1260 if (streq_ptr(s->what, s->devnode))
1261 return NULL;
1262
1263 LIST_FOREACH(same_devnode, other, s->same_devnode_next)
1264 if (streq_ptr(other->what, other->devnode))
1265 return UNIT(other);
1266
1267 LIST_FOREACH_BACKWARDS(same_devnode, other, s->same_devnode_prev) {
1268 if (streq_ptr(other->what, other->devnode))
1269 return UNIT(other);
1270
1271 first = other;
1272 }
1273
1274 /* Fall back to the first on the list */
1275 return UNIT(first);
1276 }
1277
1278 static int swap_following_set(Unit *u, Set **ret) {
1279 Swap *s = ASSERT_PTR(SWAP(u));
1280 _cleanup_set_free_ Set *set = NULL;
1281 int r;
1282
1283 assert(ret);
1284
1285 if (LIST_JUST_US(same_devnode, s)) {
1286 *ret = NULL;
1287 return 0;
1288 }
1289
1290 set = set_new(NULL);
1291 if (!set)
1292 return -ENOMEM;
1293
1294 LIST_FOREACH_OTHERS(same_devnode, other, s) {
1295 r = set_put(set, other);
1296 if (r < 0)
1297 return r;
1298 }
1299
1300 *ret = TAKE_PTR(set);
1301 return 1;
1302 }
1303
1304 static void swap_shutdown(Manager *m) {
1305 assert(m);
1306
1307 m->swap_event_source = sd_event_source_disable_unref(m->swap_event_source);
1308 m->proc_swaps = safe_fclose(m->proc_swaps);
1309 m->swaps_by_devnode = hashmap_free(m->swaps_by_devnode);
1310 }
1311
1312 static void swap_enumerate(Manager *m) {
1313 int r;
1314
1315 assert(m);
1316
1317 if (!m->proc_swaps) {
1318 m->proc_swaps = fopen("/proc/swaps", "re");
1319 if (!m->proc_swaps) {
1320 if (errno == ENOENT)
1321 log_debug_errno(errno, "Not swap enabled, skipping enumeration.");
1322 else
1323 log_warning_errno(errno, "Failed to open /proc/swaps, ignoring: %m");
1324
1325 return;
1326 }
1327
1328 r = sd_event_add_io(m->event, &m->swap_event_source, fileno(m->proc_swaps), EPOLLPRI, swap_dispatch_io, m);
1329 if (r < 0) {
1330 log_error_errno(r, "Failed to watch /proc/swaps: %m");
1331 goto fail;
1332 }
1333
1334 /* Dispatch this before we dispatch SIGCHLD, so that
1335 * we always get the events from /proc/swaps before
1336 * the SIGCHLD of /sbin/swapon. */
1337 r = sd_event_source_set_priority(m->swap_event_source, EVENT_PRIORITY_SWAP_TABLE);
1338 if (r < 0) {
1339 log_error_errno(r, "Failed to change /proc/swaps priority: %m");
1340 goto fail;
1341 }
1342
1343 (void) sd_event_source_set_description(m->swap_event_source, "swap-proc");
1344 }
1345
1346 r = swap_load_proc_swaps(m, false);
1347 if (r < 0)
1348 goto fail;
1349
1350 return;
1351
1352 fail:
1353 swap_shutdown(m);
1354 }
1355
1356 int swap_process_device_new(Manager *m, sd_device *dev) {
1357 _cleanup_free_ char *e = NULL;
1358 const char *dn;
1359 Unit *u;
1360 int r;
1361
1362 assert(m);
1363 assert(dev);
1364
1365 if (sd_device_get_devname(dev, &dn) < 0)
1366 return 0;
1367
1368 r = unit_name_from_path(dn, ".swap", &e);
1369 if (r < 0) {
1370 log_debug_errno(r, "Cannot convert device name '%s' to unit name, ignoring: %m", dn);
1371 return 0;
1372 }
1373
1374 u = manager_get_unit(m, e);
1375 if (u)
1376 r = swap_set_devnode(SWAP(u), dn);
1377
1378 FOREACH_DEVICE_DEVLINK(dev, devlink) {
1379 _cleanup_free_ char *n = NULL;
1380 int q;
1381
1382 q = unit_name_from_path(devlink, ".swap", &n);
1383 if (q == -EINVAL) /* If the name is not convertible to unit name, we can't manage it */
1384 continue;
1385 if (q < 0)
1386 return q;
1387
1388 u = manager_get_unit(m, n);
1389 if (u) {
1390 q = swap_set_devnode(SWAP(u), dn);
1391 if (q < 0)
1392 r = q;
1393 }
1394 }
1395
1396 return r;
1397 }
1398
1399 int swap_process_device_remove(Manager *m, sd_device *dev) {
1400 const char *dn;
1401 Swap *s;
1402 int r;
1403
1404 r = sd_device_get_devname(dev, &dn);
1405 if (r < 0)
1406 return 0;
1407
1408 r = 0;
1409 while ((s = hashmap_get(m->swaps_by_devnode, dn)))
1410 RET_GATHER(r, swap_set_devnode(s, NULL));
1411
1412 return r;
1413 }
1414
1415 static void swap_reset_failed(Unit *u) {
1416 Swap *s = ASSERT_PTR(SWAP(u));
1417
1418 if (s->state == SWAP_FAILED)
1419 swap_set_state(s, SWAP_DEAD);
1420
1421 s->result = SWAP_SUCCESS;
1422 s->clean_result = SWAP_SUCCESS;
1423 }
1424
1425 static void swap_handoff_timestamp(
1426 Unit *u,
1427 const struct ucred *ucred,
1428 const dual_timestamp *ts) {
1429
1430 Swap *s = ASSERT_PTR(SWAP(u));
1431
1432 assert(ucred);
1433 assert(ts);
1434
1435 if (s->control_pid.pid == ucred->pid && s->control_command) {
1436 exec_status_handoff(&s->control_command->exec_status, ucred, ts);
1437 unit_add_to_dbus_queue(u);
1438 }
1439 }
1440
1441 static int swap_get_timeout(Unit *u, usec_t *timeout) {
1442 Swap *s = ASSERT_PTR(SWAP(u));
1443 usec_t t;
1444 int r;
1445
1446 if (!s->timer_event_source)
1447 return 0;
1448
1449 r = sd_event_source_get_time(s->timer_event_source, &t);
1450 if (r < 0)
1451 return r;
1452 if (t == USEC_INFINITY)
1453 return 0;
1454
1455 *timeout = t;
1456 return 1;
1457 }
1458
1459 static bool swap_supported(void) {
1460 static int supported = -1;
1461
1462 /* If swap support is not available in the kernel, or we are
1463 * running in a container we don't support swap units, and any
1464 * attempts to starting one should fail immediately. */
1465
1466 if (supported < 0)
1467 supported =
1468 access("/proc/swaps", F_OK) >= 0 &&
1469 detect_container() <= 0;
1470
1471 return supported;
1472 }
1473
1474 static PidRef* swap_control_pid(Unit *u) {
1475 return &ASSERT_PTR(SWAP(u))->control_pid;
1476 }
1477
1478 static int swap_clean(Unit *u, ExecCleanMask mask) {
1479 Swap *s = ASSERT_PTR(SWAP(u));
1480 _cleanup_strv_free_ char **l = NULL;
1481 int r;
1482
1483 assert(mask != 0);
1484
1485 if (s->state != SWAP_DEAD)
1486 return -EBUSY;
1487
1488 r = exec_context_get_clean_directories(&s->exec_context, u->manager->prefix, mask, &l);
1489 if (r < 0)
1490 return r;
1491
1492 if (strv_isempty(l))
1493 return -EUNATCH;
1494
1495 swap_unwatch_control_pid(s);
1496 s->clean_result = SWAP_SUCCESS;
1497 s->control_command = NULL;
1498 s->control_command_id = _SWAP_EXEC_COMMAND_INVALID;
1499
1500 r = swap_arm_timer(s, /* relative= */ true, s->exec_context.timeout_clean_usec);
1501 if (r < 0) {
1502 log_unit_warning_errno(u, r, "Failed to install timer: %m");
1503 goto fail;
1504 }
1505
1506 r = unit_fork_and_watch_rm_rf(u, l, &s->control_pid);
1507 if (r < 0) {
1508 log_unit_warning_errno(u, r, "Failed to spawn cleaning task: %m");
1509 goto fail;
1510 }
1511
1512 swap_set_state(s, SWAP_CLEANING);
1513 return 0;
1514
1515 fail:
1516 s->clean_result = SWAP_FAILURE_RESOURCES;
1517 s->timer_event_source = sd_event_source_disable_unref(s->timer_event_source);
1518 return r;
1519 }
1520
1521 static int swap_can_clean(Unit *u, ExecCleanMask *ret) {
1522 Swap *s = ASSERT_PTR(SWAP(u));
1523
1524 return exec_context_get_clean_mask(&s->exec_context, ret);
1525 }
1526
1527 static int swap_can_start(Unit *u) {
1528 Swap *s = ASSERT_PTR(SWAP(u));
1529 int r;
1530
1531 r = unit_test_start_limit(u);
1532 if (r < 0) {
1533 swap_enter_dead(s, SWAP_FAILURE_START_LIMIT_HIT);
1534 return r;
1535 }
1536
1537 return 1;
1538 }
1539
1540 int swap_get_priority(const Swap *s) {
1541 assert(s);
1542
1543 if (s->from_proc_swaps && s->parameters_proc_swaps.priority_set)
1544 return s->parameters_proc_swaps.priority;
1545
1546 if (s->from_fragment && s->parameters_fragment.priority_set)
1547 return s->parameters_fragment.priority;
1548
1549 return -1;
1550 }
1551
1552 const char* swap_get_options(const Swap *s) {
1553 assert(s);
1554
1555 if (s->from_fragment)
1556 return s->parameters_fragment.options;
1557
1558 return NULL;
1559 }
1560
1561 static const char* const swap_exec_command_table[_SWAP_EXEC_COMMAND_MAX] = {
1562 [SWAP_EXEC_ACTIVATE] = "ExecActivate",
1563 [SWAP_EXEC_DEACTIVATE] = "ExecDeactivate",
1564 };
1565
1566 DEFINE_STRING_TABLE_LOOKUP(swap_exec_command, SwapExecCommand);
1567
1568 static const char* const swap_result_table[_SWAP_RESULT_MAX] = {
1569 [SWAP_SUCCESS] = "success",
1570 [SWAP_FAILURE_RESOURCES] = "resources",
1571 [SWAP_FAILURE_TIMEOUT] = "timeout",
1572 [SWAP_FAILURE_EXIT_CODE] = "exit-code",
1573 [SWAP_FAILURE_SIGNAL] = "signal",
1574 [SWAP_FAILURE_CORE_DUMP] = "core-dump",
1575 [SWAP_FAILURE_START_LIMIT_HIT] = "start-limit-hit",
1576 };
1577
1578 DEFINE_STRING_TABLE_LOOKUP(swap_result, SwapResult);
1579
1580 const UnitVTable swap_vtable = {
1581 .object_size = sizeof(Swap),
1582 .exec_context_offset = offsetof(Swap, exec_context),
1583 .cgroup_context_offset = offsetof(Swap, cgroup_context),
1584 .kill_context_offset = offsetof(Swap, kill_context),
1585 .exec_runtime_offset = offsetof(Swap, exec_runtime),
1586 .cgroup_runtime_offset = offsetof(Swap, cgroup_runtime),
1587
1588 .sections =
1589 "Unit\0"
1590 "Swap\0"
1591 "Install\0",
1592 .private_section = "Swap",
1593
1594 .can_fail = true,
1595
1596 .init = swap_init,
1597 .load = swap_load,
1598 .done = swap_done,
1599
1600 .coldplug = swap_coldplug,
1601
1602 .dump = swap_dump,
1603
1604 .start = swap_start,
1605 .stop = swap_stop,
1606
1607 .clean = swap_clean,
1608 .can_clean = swap_can_clean,
1609
1610 .get_timeout = swap_get_timeout,
1611
1612 .serialize = swap_serialize,
1613 .deserialize_item = swap_deserialize_item,
1614
1615 .active_state = swap_active_state,
1616 .sub_state_to_string = swap_sub_state_to_string,
1617
1618 .will_restart = unit_will_restart_default,
1619
1620 .may_gc = swap_may_gc,
1621 .is_extrinsic = swap_is_extrinsic,
1622
1623 .sigchld_event = swap_sigchld_event,
1624
1625 .reset_failed = swap_reset_failed,
1626
1627 .notify_handoff_timestamp = swap_handoff_timestamp,
1628
1629 .control_pid = swap_control_pid,
1630
1631 .bus_set_property = bus_swap_set_property,
1632 .bus_commit_properties = bus_swap_commit_properties,
1633
1634 .following = swap_following,
1635 .following_set = swap_following_set,
1636
1637 .enumerate = swap_enumerate,
1638 .shutdown = swap_shutdown,
1639 .supported = swap_supported,
1640
1641 .status_message_formats = {
1642 .starting_stopping = {
1643 [0] = "Activating swap %s...",
1644 [1] = "Deactivating swap %s...",
1645 },
1646 .finished_start_job = {
1647 [JOB_DONE] = "Activated swap %s.",
1648 [JOB_FAILED] = "Failed to activate swap %s.",
1649 [JOB_TIMEOUT] = "Timed out activating swap %s.",
1650 },
1651 .finished_stop_job = {
1652 [JOB_DONE] = "Deactivated swap %s.",
1653 [JOB_FAILED] = "Failed deactivating swap %s.",
1654 [JOB_TIMEOUT] = "Timed out deactivating swap %s.",
1655 },
1656 },
1657
1658 .can_start = swap_can_start,
1659
1660 .notify_plymouth = true,
1661 };