]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/core/swap.c
pkgconfig: define variables relative to ${prefix}/${rootprefix}/${sysconfdir}
[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 unit_log_success(UNIT(s));
658 else
659 unit_log_failure(UNIT(s), swap_result_to_string(s->result));
660
661 swap_set_state(s, s->result != SWAP_SUCCESS ? SWAP_FAILED : SWAP_DEAD);
662
663 s->exec_runtime = exec_runtime_unref(s->exec_runtime, true);
664
665 exec_context_destroy_runtime_directory(&s->exec_context, UNIT(s)->manager->prefix[EXEC_DIRECTORY_RUNTIME]);
666
667 unit_unref_uid_gid(UNIT(s), true);
668
669 dynamic_creds_destroy(&s->dynamic_creds);
670 }
671
672 static void swap_enter_active(Swap *s, SwapResult f) {
673 assert(s);
674
675 if (s->result == SWAP_SUCCESS)
676 s->result = f;
677
678 swap_set_state(s, SWAP_ACTIVE);
679 }
680
681 static void swap_enter_dead_or_active(Swap *s, SwapResult f) {
682 assert(s);
683
684 if (s->from_proc_swaps)
685 swap_enter_active(s, f);
686 else
687 swap_enter_dead(s, f);
688 }
689
690 static void swap_enter_signal(Swap *s, SwapState state, SwapResult f) {
691 int r;
692 KillOperation kop;
693
694 assert(s);
695
696 if (s->result == SWAP_SUCCESS)
697 s->result = f;
698
699 if (state == SWAP_DEACTIVATING_SIGTERM)
700 kop = KILL_TERMINATE;
701 else
702 kop = KILL_KILL;
703
704 r = unit_kill_context(UNIT(s), &s->kill_context, kop, -1, s->control_pid, false);
705 if (r < 0)
706 goto fail;
707
708 if (r > 0) {
709 r = swap_arm_timer(s, usec_add(now(CLOCK_MONOTONIC), s->timeout_usec));
710 if (r < 0)
711 goto fail;
712
713 swap_set_state(s, state);
714 } else if (state == SWAP_DEACTIVATING_SIGTERM && s->kill_context.send_sigkill)
715 swap_enter_signal(s, SWAP_DEACTIVATING_SIGKILL, SWAP_SUCCESS);
716 else
717 swap_enter_dead_or_active(s, SWAP_SUCCESS);
718
719 return;
720
721 fail:
722 log_unit_warning_errno(UNIT(s), r, "Failed to kill processes: %m");
723 swap_enter_dead_or_active(s, SWAP_FAILURE_RESOURCES);
724 }
725
726 static void swap_enter_activating(Swap *s) {
727 _cleanup_free_ char *opts = NULL;
728 int r;
729
730 assert(s);
731
732 unit_warn_leftover_processes(UNIT(s));
733
734 s->control_command_id = SWAP_EXEC_ACTIVATE;
735 s->control_command = s->exec_command + SWAP_EXEC_ACTIVATE;
736
737 if (s->from_fragment) {
738 int priority = -1;
739
740 r = fstab_find_pri(s->parameters_fragment.options, &priority);
741 if (r < 0)
742 log_warning_errno(r, "Failed to parse swap priority \"%s\", ignoring: %m", s->parameters_fragment.options);
743 else if (r == 1 && s->parameters_fragment.priority >= 0)
744 log_warning("Duplicate swap priority configuration by Priority and Options fields.");
745
746 if (r <= 0 && s->parameters_fragment.priority >= 0) {
747 if (s->parameters_fragment.options)
748 r = asprintf(&opts, "%s,pri=%i", s->parameters_fragment.options, s->parameters_fragment.priority);
749 else
750 r = asprintf(&opts, "pri=%i", s->parameters_fragment.priority);
751 if (r < 0)
752 goto fail;
753 }
754 }
755
756 r = exec_command_set(s->control_command, "/sbin/swapon", NULL);
757 if (r < 0)
758 goto fail;
759
760 if (s->parameters_fragment.options || opts) {
761 r = exec_command_append(s->control_command, "-o",
762 opts ? : s->parameters_fragment.options, NULL);
763 if (r < 0)
764 goto fail;
765 }
766
767 r = exec_command_append(s->control_command, s->what, NULL);
768 if (r < 0)
769 goto fail;
770
771 swap_unwatch_control_pid(s);
772
773 r = swap_spawn(s, s->control_command, &s->control_pid);
774 if (r < 0)
775 goto fail;
776
777 swap_set_state(s, SWAP_ACTIVATING);
778
779 return;
780
781 fail:
782 log_unit_warning_errno(UNIT(s), r, "Failed to run 'swapon' task: %m");
783 swap_enter_dead_or_active(s, SWAP_FAILURE_RESOURCES);
784 }
785
786 static void swap_enter_deactivating(Swap *s) {
787 int r;
788
789 assert(s);
790
791 s->control_command_id = SWAP_EXEC_DEACTIVATE;
792 s->control_command = s->exec_command + SWAP_EXEC_DEACTIVATE;
793
794 r = exec_command_set(s->control_command,
795 "/sbin/swapoff",
796 s->what,
797 NULL);
798 if (r < 0)
799 goto fail;
800
801 swap_unwatch_control_pid(s);
802
803 r = swap_spawn(s, s->control_command, &s->control_pid);
804 if (r < 0)
805 goto fail;
806
807 swap_set_state(s, SWAP_DEACTIVATING);
808
809 return;
810
811 fail:
812 log_unit_warning_errno(UNIT(s), r, "Failed to run 'swapoff' task: %m");
813 swap_enter_dead_or_active(s, SWAP_FAILURE_RESOURCES);
814 }
815
816 static int swap_start(Unit *u) {
817 Swap *s = SWAP(u), *other;
818 int r;
819
820 assert(s);
821
822 /* We cannot fulfill this request right now, try again later please! */
823 if (IN_SET(s->state,
824 SWAP_DEACTIVATING,
825 SWAP_DEACTIVATING_SIGTERM,
826 SWAP_DEACTIVATING_SIGKILL))
827 return -EAGAIN;
828
829 /* Already on it! */
830 if (s->state == SWAP_ACTIVATING)
831 return 0;
832
833 assert(IN_SET(s->state, SWAP_DEAD, SWAP_FAILED));
834
835 if (detect_container() > 0)
836 return -EPERM;
837
838 /* If there's a job for another swap unit for the same node
839 * running, then let's not dispatch this one for now, and wait
840 * until that other job has finished. */
841 LIST_FOREACH_OTHERS(same_devnode, other, s)
842 if (UNIT(other)->job && UNIT(other)->job->state == JOB_RUNNING)
843 return -EAGAIN;
844
845 r = unit_start_limit_test(u);
846 if (r < 0) {
847 swap_enter_dead(s, SWAP_FAILURE_START_LIMIT_HIT);
848 return r;
849 }
850
851 r = unit_acquire_invocation_id(u);
852 if (r < 0)
853 return r;
854
855 s->result = SWAP_SUCCESS;
856 exec_command_reset_status_array(s->exec_command, _SWAP_EXEC_COMMAND_MAX);
857
858 u->reset_accounting = true;
859
860 swap_enter_activating(s);
861 return 1;
862 }
863
864 static int swap_stop(Unit *u) {
865 Swap *s = SWAP(u);
866
867 assert(s);
868
869 switch (s->state) {
870
871 case SWAP_DEACTIVATING:
872 case SWAP_DEACTIVATING_SIGTERM:
873 case SWAP_DEACTIVATING_SIGKILL:
874 /* Already on it */
875 return 0;
876
877 case SWAP_ACTIVATING:
878 case SWAP_ACTIVATING_DONE:
879 /* There's a control process pending, directly enter kill mode */
880 swap_enter_signal(s, SWAP_DEACTIVATING_SIGTERM, SWAP_SUCCESS);
881 return 0;
882
883 case SWAP_ACTIVE:
884 if (detect_container() > 0)
885 return -EPERM;
886
887 swap_enter_deactivating(s);
888 return 1;
889
890 default:
891 assert_not_reached("Unexpected state.");
892 }
893 }
894
895 static int swap_serialize(Unit *u, FILE *f, FDSet *fds) {
896 Swap *s = SWAP(u);
897
898 assert(s);
899 assert(f);
900 assert(fds);
901
902 (void) serialize_item(f, "state", swap_state_to_string(s->state));
903 (void) serialize_item(f, "result", swap_result_to_string(s->result));
904
905 if (s->control_pid > 0)
906 (void) serialize_item_format(f, "control-pid", PID_FMT, s->control_pid);
907
908 if (s->control_command_id >= 0)
909 (void) serialize_item(f, "control-command", swap_exec_command_to_string(s->control_command_id));
910
911 return 0;
912 }
913
914 static int swap_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
915 Swap *s = SWAP(u);
916
917 assert(s);
918 assert(fds);
919
920 if (streq(key, "state")) {
921 SwapState state;
922
923 state = swap_state_from_string(value);
924 if (state < 0)
925 log_unit_debug(u, "Failed to parse state value: %s", value);
926 else
927 s->deserialized_state = state;
928 } else if (streq(key, "result")) {
929 SwapResult f;
930
931 f = swap_result_from_string(value);
932 if (f < 0)
933 log_unit_debug(u, "Failed to parse result value: %s", value);
934 else if (f != SWAP_SUCCESS)
935 s->result = f;
936 } else if (streq(key, "control-pid")) {
937 pid_t pid;
938
939 if (parse_pid(value, &pid) < 0)
940 log_unit_debug(u, "Failed to parse control-pid value: %s", value);
941 else
942 s->control_pid = pid;
943
944 } else if (streq(key, "control-command")) {
945 SwapExecCommand id;
946
947 id = swap_exec_command_from_string(value);
948 if (id < 0)
949 log_unit_debug(u, "Failed to parse exec-command value: %s", value);
950 else {
951 s->control_command_id = id;
952 s->control_command = s->exec_command + id;
953 }
954 } else
955 log_unit_debug(u, "Unknown serialization key: %s", key);
956
957 return 0;
958 }
959
960 _pure_ static UnitActiveState swap_active_state(Unit *u) {
961 assert(u);
962
963 return state_translation_table[SWAP(u)->state];
964 }
965
966 _pure_ static const char *swap_sub_state_to_string(Unit *u) {
967 assert(u);
968
969 return swap_state_to_string(SWAP(u)->state);
970 }
971
972 _pure_ static bool swap_may_gc(Unit *u) {
973 Swap *s = SWAP(u);
974
975 assert(s);
976
977 if (s->from_proc_swaps)
978 return false;
979
980 return true;
981 }
982
983 static void swap_sigchld_event(Unit *u, pid_t pid, int code, int status) {
984 Swap *s = SWAP(u);
985 SwapResult f;
986
987 assert(s);
988 assert(pid >= 0);
989
990 if (pid != s->control_pid)
991 return;
992
993 s->control_pid = 0;
994
995 if (is_clean_exit(code, status, EXIT_CLEAN_COMMAND, NULL))
996 f = SWAP_SUCCESS;
997 else if (code == CLD_EXITED)
998 f = SWAP_FAILURE_EXIT_CODE;
999 else if (code == CLD_KILLED)
1000 f = SWAP_FAILURE_SIGNAL;
1001 else if (code == CLD_DUMPED)
1002 f = SWAP_FAILURE_CORE_DUMP;
1003 else
1004 assert_not_reached("Unknown code");
1005
1006 if (s->result == SWAP_SUCCESS)
1007 s->result = f;
1008
1009 if (s->control_command) {
1010 exec_status_exit(&s->control_command->exec_status, &s->exec_context, pid, code, status);
1011
1012 s->control_command = NULL;
1013 s->control_command_id = _SWAP_EXEC_COMMAND_INVALID;
1014 }
1015
1016 unit_log_process_exit(
1017 u, f == SWAP_SUCCESS ? LOG_DEBUG : LOG_NOTICE,
1018 "Swap process",
1019 swap_exec_command_to_string(s->control_command_id),
1020 code, status);
1021
1022 switch (s->state) {
1023
1024 case SWAP_ACTIVATING:
1025 case SWAP_ACTIVATING_DONE:
1026
1027 if (f == SWAP_SUCCESS || s->from_proc_swaps)
1028 swap_enter_active(s, f);
1029 else
1030 swap_enter_dead(s, f);
1031 break;
1032
1033 case SWAP_DEACTIVATING:
1034 case SWAP_DEACTIVATING_SIGKILL:
1035 case SWAP_DEACTIVATING_SIGTERM:
1036
1037 swap_enter_dead_or_active(s, f);
1038 break;
1039
1040 default:
1041 assert_not_reached("Uh, control process died at wrong time.");
1042 }
1043
1044 /* Notify clients about changed exit status */
1045 unit_add_to_dbus_queue(u);
1046 }
1047
1048 static int swap_dispatch_timer(sd_event_source *source, usec_t usec, void *userdata) {
1049 Swap *s = SWAP(userdata);
1050
1051 assert(s);
1052 assert(s->timer_event_source == source);
1053
1054 switch (s->state) {
1055
1056 case SWAP_ACTIVATING:
1057 case SWAP_ACTIVATING_DONE:
1058 log_unit_warning(UNIT(s), "Activation timed out. Stopping.");
1059 swap_enter_signal(s, SWAP_DEACTIVATING_SIGTERM, SWAP_FAILURE_TIMEOUT);
1060 break;
1061
1062 case SWAP_DEACTIVATING:
1063 log_unit_warning(UNIT(s), "Deactivation timed out. Stopping.");
1064 swap_enter_signal(s, SWAP_DEACTIVATING_SIGTERM, SWAP_FAILURE_TIMEOUT);
1065 break;
1066
1067 case SWAP_DEACTIVATING_SIGTERM:
1068 if (s->kill_context.send_sigkill) {
1069 log_unit_warning(UNIT(s), "Swap process timed out. Killing.");
1070 swap_enter_signal(s, SWAP_DEACTIVATING_SIGKILL, SWAP_FAILURE_TIMEOUT);
1071 } else {
1072 log_unit_warning(UNIT(s), "Swap process timed out. Skipping SIGKILL. Ignoring.");
1073 swap_enter_dead_or_active(s, SWAP_FAILURE_TIMEOUT);
1074 }
1075 break;
1076
1077 case SWAP_DEACTIVATING_SIGKILL:
1078 log_unit_warning(UNIT(s), "Swap process still around after SIGKILL. Ignoring.");
1079 swap_enter_dead_or_active(s, SWAP_FAILURE_TIMEOUT);
1080 break;
1081
1082 default:
1083 assert_not_reached("Timeout at wrong time.");
1084 }
1085
1086 return 0;
1087 }
1088
1089 static int swap_load_proc_swaps(Manager *m, bool set_flags) {
1090 unsigned i;
1091 int r = 0;
1092
1093 assert(m);
1094
1095 rewind(m->proc_swaps);
1096
1097 (void) fscanf(m->proc_swaps, "%*s %*s %*s %*s %*s\n");
1098
1099 for (i = 1;; i++) {
1100 _cleanup_free_ char *dev = NULL, *d = NULL;
1101 int prio = 0, k;
1102
1103 k = fscanf(m->proc_swaps,
1104 "%ms " /* device/file */
1105 "%*s " /* type of swap */
1106 "%*s " /* swap size */
1107 "%*s " /* used */
1108 "%i\n", /* priority */
1109 &dev, &prio);
1110 if (k != 2) {
1111 if (k == EOF)
1112 break;
1113
1114 log_warning("Failed to parse /proc/swaps:%u.", i);
1115 continue;
1116 }
1117
1118 if (cunescape(dev, UNESCAPE_RELAX, &d) < 0)
1119 return log_oom();
1120
1121 device_found_node(m, d, DEVICE_FOUND_SWAP, DEVICE_FOUND_SWAP);
1122
1123 k = swap_process_new(m, d, prio, set_flags);
1124 if (k < 0)
1125 r = k;
1126 }
1127
1128 return r;
1129 }
1130
1131 static int swap_dispatch_io(sd_event_source *source, int fd, uint32_t revents, void *userdata) {
1132 Manager *m = userdata;
1133 Unit *u;
1134 int r;
1135
1136 assert(m);
1137 assert(revents & EPOLLPRI);
1138
1139 r = swap_load_proc_swaps(m, true);
1140 if (r < 0) {
1141 log_error_errno(r, "Failed to reread /proc/swaps: %m");
1142
1143 /* Reset flags, just in case, for late calls */
1144 LIST_FOREACH(units_by_type, u, m->units_by_type[UNIT_SWAP]) {
1145 Swap *swap = SWAP(u);
1146
1147 swap->is_active = swap->just_activated = false;
1148 }
1149
1150 return 0;
1151 }
1152
1153 manager_dispatch_load_queue(m);
1154
1155 LIST_FOREACH(units_by_type, u, m->units_by_type[UNIT_SWAP]) {
1156 Swap *swap = SWAP(u);
1157
1158 if (!swap->is_active) {
1159 /* This has just been deactivated */
1160
1161 swap_unset_proc_swaps(swap);
1162
1163 switch (swap->state) {
1164
1165 case SWAP_ACTIVE:
1166 swap_enter_dead(swap, SWAP_SUCCESS);
1167 break;
1168
1169 default:
1170 /* Fire again */
1171 swap_set_state(swap, swap->state);
1172 break;
1173 }
1174
1175 if (swap->what)
1176 device_found_node(m, swap->what, 0, DEVICE_FOUND_SWAP);
1177
1178 } else if (swap->just_activated) {
1179
1180 /* New swap entry */
1181
1182 switch (swap->state) {
1183
1184 case SWAP_DEAD:
1185 case SWAP_FAILED:
1186 (void) unit_acquire_invocation_id(UNIT(swap));
1187 swap_enter_active(swap, SWAP_SUCCESS);
1188 break;
1189
1190 case SWAP_ACTIVATING:
1191 swap_set_state(swap, SWAP_ACTIVATING_DONE);
1192 break;
1193
1194 default:
1195 /* Nothing really changed, but let's
1196 * issue an notification call
1197 * nonetheless, in case somebody is
1198 * waiting for this. */
1199 swap_set_state(swap, swap->state);
1200 break;
1201 }
1202 }
1203
1204 /* Reset the flags for later calls */
1205 swap->is_active = swap->just_activated = false;
1206 }
1207
1208 return 1;
1209 }
1210
1211 static Unit *swap_following(Unit *u) {
1212 Swap *s = SWAP(u);
1213 Swap *other, *first = NULL;
1214
1215 assert(s);
1216
1217 /* If the user configured the swap through /etc/fstab or
1218 * a device unit, follow that. */
1219
1220 if (s->from_fragment)
1221 return NULL;
1222
1223 LIST_FOREACH_OTHERS(same_devnode, other, s)
1224 if (other->from_fragment)
1225 return UNIT(other);
1226
1227 /* Otherwise, make everybody follow the unit that's named after
1228 * the swap device in the kernel */
1229
1230 if (streq_ptr(s->what, s->devnode))
1231 return NULL;
1232
1233 LIST_FOREACH_AFTER(same_devnode, other, s)
1234 if (streq_ptr(other->what, other->devnode))
1235 return UNIT(other);
1236
1237 LIST_FOREACH_BEFORE(same_devnode, other, s) {
1238 if (streq_ptr(other->what, other->devnode))
1239 return UNIT(other);
1240
1241 first = other;
1242 }
1243
1244 /* Fall back to the first on the list */
1245 return UNIT(first);
1246 }
1247
1248 static int swap_following_set(Unit *u, Set **_set) {
1249 Swap *s = SWAP(u), *other;
1250 _cleanup_set_free_ Set *set = NULL;
1251 int r;
1252
1253 assert(s);
1254 assert(_set);
1255
1256 if (LIST_JUST_US(same_devnode, s)) {
1257 *_set = NULL;
1258 return 0;
1259 }
1260
1261 set = set_new(NULL);
1262 if (!set)
1263 return -ENOMEM;
1264
1265 LIST_FOREACH_OTHERS(same_devnode, other, s) {
1266 r = set_put(set, other);
1267 if (r < 0)
1268 return r;
1269 }
1270
1271 *_set = TAKE_PTR(set);
1272 return 1;
1273 }
1274
1275 static void swap_shutdown(Manager *m) {
1276 assert(m);
1277
1278 m->swap_event_source = sd_event_source_unref(m->swap_event_source);
1279 m->proc_swaps = safe_fclose(m->proc_swaps);
1280 m->swaps_by_devnode = hashmap_free(m->swaps_by_devnode);
1281 }
1282
1283 static void swap_enumerate(Manager *m) {
1284 int r;
1285
1286 assert(m);
1287
1288 if (!m->proc_swaps) {
1289 m->proc_swaps = fopen("/proc/swaps", "re");
1290 if (!m->proc_swaps) {
1291 if (errno == ENOENT)
1292 log_debug_errno(errno, "Not swap enabled, skipping enumeration.");
1293 else
1294 log_warning_errno(errno, "Failed to open /proc/swaps, ignoring: %m");
1295
1296 return;
1297 }
1298
1299 r = sd_event_add_io(m->event, &m->swap_event_source, fileno(m->proc_swaps), EPOLLPRI, swap_dispatch_io, m);
1300 if (r < 0) {
1301 log_error_errno(r, "Failed to watch /proc/swaps: %m");
1302 goto fail;
1303 }
1304
1305 /* Dispatch this before we dispatch SIGCHLD, so that
1306 * we always get the events from /proc/swaps before
1307 * the SIGCHLD of /sbin/swapon. */
1308 r = sd_event_source_set_priority(m->swap_event_source, SD_EVENT_PRIORITY_NORMAL-10);
1309 if (r < 0) {
1310 log_error_errno(r, "Failed to change /proc/swaps priority: %m");
1311 goto fail;
1312 }
1313
1314 (void) sd_event_source_set_description(m->swap_event_source, "swap-proc");
1315 }
1316
1317 r = swap_load_proc_swaps(m, false);
1318 if (r < 0)
1319 goto fail;
1320
1321 return;
1322
1323 fail:
1324 swap_shutdown(m);
1325 }
1326
1327 int swap_process_device_new(Manager *m, sd_device *dev) {
1328 _cleanup_free_ char *e = NULL;
1329 const char *dn, *devlink;
1330 Unit *u;
1331 int r = 0;
1332
1333 assert(m);
1334 assert(dev);
1335
1336 r = sd_device_get_devname(dev, &dn);
1337 if (r < 0)
1338 return 0;
1339
1340 r = unit_name_from_path(dn, ".swap", &e);
1341 if (r < 0)
1342 return r;
1343
1344 u = manager_get_unit(m, e);
1345 if (u)
1346 r = swap_set_devnode(SWAP(u), dn);
1347
1348 FOREACH_DEVICE_DEVLINK(dev, devlink) {
1349 _cleanup_free_ char *n = NULL;
1350 int q;
1351
1352 q = unit_name_from_path(devlink, ".swap", &n);
1353 if (q < 0)
1354 return q;
1355
1356 u = manager_get_unit(m, n);
1357 if (u) {
1358 q = swap_set_devnode(SWAP(u), dn);
1359 if (q < 0)
1360 r = q;
1361 }
1362 }
1363
1364 return r;
1365 }
1366
1367 int swap_process_device_remove(Manager *m, sd_device *dev) {
1368 const char *dn;
1369 int r = 0;
1370 Swap *s;
1371
1372 r = sd_device_get_devname(dev, &dn);
1373 if (r < 0)
1374 return 0;
1375
1376 while ((s = hashmap_get(m->swaps_by_devnode, dn))) {
1377 int q;
1378
1379 q = swap_set_devnode(s, NULL);
1380 if (q < 0)
1381 r = q;
1382 }
1383
1384 return r;
1385 }
1386
1387 static void swap_reset_failed(Unit *u) {
1388 Swap *s = SWAP(u);
1389
1390 assert(s);
1391
1392 if (s->state == SWAP_FAILED)
1393 swap_set_state(s, SWAP_DEAD);
1394
1395 s->result = SWAP_SUCCESS;
1396 }
1397
1398 static int swap_kill(Unit *u, KillWho who, int signo, sd_bus_error *error) {
1399 return unit_kill_common(u, who, signo, -1, SWAP(u)->control_pid, error);
1400 }
1401
1402 static int swap_get_timeout(Unit *u, usec_t *timeout) {
1403 Swap *s = SWAP(u);
1404 usec_t t;
1405 int r;
1406
1407 if (!s->timer_event_source)
1408 return 0;
1409
1410 r = sd_event_source_get_time(s->timer_event_source, &t);
1411 if (r < 0)
1412 return r;
1413 if (t == USEC_INFINITY)
1414 return 0;
1415
1416 *timeout = t;
1417 return 1;
1418 }
1419
1420 static bool swap_supported(void) {
1421 static int supported = -1;
1422
1423 /* If swap support is not available in the kernel, or we are
1424 * running in a container we don't support swap units, and any
1425 * attempts to starting one should fail immediately. */
1426
1427 if (supported < 0)
1428 supported =
1429 access("/proc/swaps", F_OK) >= 0 &&
1430 detect_container() <= 0;
1431
1432 return supported;
1433 }
1434
1435 static int swap_control_pid(Unit *u) {
1436 Swap *s = SWAP(u);
1437
1438 assert(s);
1439
1440 return s->control_pid;
1441 }
1442
1443 static const char* const swap_exec_command_table[_SWAP_EXEC_COMMAND_MAX] = {
1444 [SWAP_EXEC_ACTIVATE] = "ExecActivate",
1445 [SWAP_EXEC_DEACTIVATE] = "ExecDeactivate",
1446 };
1447
1448 DEFINE_STRING_TABLE_LOOKUP(swap_exec_command, SwapExecCommand);
1449
1450 static const char* const swap_result_table[_SWAP_RESULT_MAX] = {
1451 [SWAP_SUCCESS] = "success",
1452 [SWAP_FAILURE_RESOURCES] = "resources",
1453 [SWAP_FAILURE_TIMEOUT] = "timeout",
1454 [SWAP_FAILURE_EXIT_CODE] = "exit-code",
1455 [SWAP_FAILURE_SIGNAL] = "signal",
1456 [SWAP_FAILURE_CORE_DUMP] = "core-dump",
1457 [SWAP_FAILURE_START_LIMIT_HIT] = "start-limit-hit",
1458 };
1459
1460 DEFINE_STRING_TABLE_LOOKUP(swap_result, SwapResult);
1461
1462 const UnitVTable swap_vtable = {
1463 .object_size = sizeof(Swap),
1464 .exec_context_offset = offsetof(Swap, exec_context),
1465 .cgroup_context_offset = offsetof(Swap, cgroup_context),
1466 .kill_context_offset = offsetof(Swap, kill_context),
1467 .exec_runtime_offset = offsetof(Swap, exec_runtime),
1468 .dynamic_creds_offset = offsetof(Swap, dynamic_creds),
1469
1470 .sections =
1471 "Unit\0"
1472 "Swap\0"
1473 "Install\0",
1474 .private_section = "Swap",
1475
1476 .init = swap_init,
1477 .load = swap_load,
1478 .done = swap_done,
1479
1480 .coldplug = swap_coldplug,
1481
1482 .dump = swap_dump,
1483
1484 .start = swap_start,
1485 .stop = swap_stop,
1486
1487 .kill = swap_kill,
1488
1489 .get_timeout = swap_get_timeout,
1490
1491 .serialize = swap_serialize,
1492 .deserialize_item = swap_deserialize_item,
1493
1494 .active_state = swap_active_state,
1495 .sub_state_to_string = swap_sub_state_to_string,
1496
1497 .may_gc = swap_may_gc,
1498
1499 .sigchld_event = swap_sigchld_event,
1500
1501 .reset_failed = swap_reset_failed,
1502
1503 .control_pid = swap_control_pid,
1504
1505 .bus_vtable = bus_swap_vtable,
1506 .bus_set_property = bus_swap_set_property,
1507 .bus_commit_properties = bus_swap_commit_properties,
1508
1509 .following = swap_following,
1510 .following_set = swap_following_set,
1511
1512 .enumerate = swap_enumerate,
1513 .shutdown = swap_shutdown,
1514 .supported = swap_supported,
1515
1516 .status_message_formats = {
1517 .starting_stopping = {
1518 [0] = "Activating swap %s...",
1519 [1] = "Deactivating swap %s...",
1520 },
1521 .finished_start_job = {
1522 [JOB_DONE] = "Activated swap %s.",
1523 [JOB_FAILED] = "Failed to activate swap %s.",
1524 [JOB_TIMEOUT] = "Timed out activating swap %s.",
1525 },
1526 .finished_stop_job = {
1527 [JOB_DONE] = "Deactivated swap %s.",
1528 [JOB_FAILED] = "Failed deactivating swap %s.",
1529 [JOB_TIMEOUT] = "Timed out deactivating swap %s.",
1530 },
1531 },
1532 };