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