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