]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/core/unit.c
4ef1ec1969b88c5854b3a32737bd607e5125c0a3
[thirdparty/systemd.git] / src / core / unit.c
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2
3 #include <errno.h>
4 #include <stdlib.h>
5 #include <sys/prctl.h>
6 #include <unistd.h>
7
8 #include "sd-id128.h"
9 #include "sd-messages.h"
10
11 #include "all-units.h"
12 #include "alloc-util.h"
13 #include "bpf-firewall.h"
14 #include "bpf-foreign.h"
15 #include "bpf-socket-bind.h"
16 #include "bus-common-errors.h"
17 #include "bus-internal.h"
18 #include "bus-util.h"
19 #include "cgroup-setup.h"
20 #include "cgroup-util.h"
21 #include "chase.h"
22 #include "core-varlink.h"
23 #include "dbus-unit.h"
24 #include "dbus.h"
25 #include "dropin.h"
26 #include "env-util.h"
27 #include "escape.h"
28 #include "exec-credential.h"
29 #include "execute.h"
30 #include "fd-util.h"
31 #include "fileio-label.h"
32 #include "fileio.h"
33 #include "format-util.h"
34 #include "id128-util.h"
35 #include "install.h"
36 #include "io-util.h"
37 #include "label-util.h"
38 #include "load-dropin.h"
39 #include "load-fragment.h"
40 #include "log.h"
41 #include "logarithm.h"
42 #include "macro.h"
43 #include "mkdir-label.h"
44 #include "path-util.h"
45 #include "process-util.h"
46 #include "rm-rf.h"
47 #include "serialize.h"
48 #include "set.h"
49 #include "signal-util.h"
50 #include "sparse-endian.h"
51 #include "special.h"
52 #include "specifier.h"
53 #include "stat-util.h"
54 #include "stdio-util.h"
55 #include "string-table.h"
56 #include "string-util.h"
57 #include "strv.h"
58 #include "terminal-util.h"
59 #include "tmpfile-util.h"
60 #include "umask-util.h"
61 #include "unit-name.h"
62 #include "unit.h"
63 #include "user-util.h"
64 #include "virt.h"
65 #if BPF_FRAMEWORK
66 #include "bpf-link.h"
67 #endif
68
69 /* Thresholds for logging at INFO level about resource consumption */
70 #define MENTIONWORTHY_CPU_NSEC (1 * NSEC_PER_SEC)
71 #define MENTIONWORTHY_IO_BYTES (1024 * 1024ULL)
72 #define MENTIONWORTHY_IP_BYTES (0ULL)
73
74 /* Thresholds for logging at INFO level about resource consumption */
75 #define NOTICEWORTHY_CPU_NSEC (10*60 * NSEC_PER_SEC) /* 10 minutes */
76 #define NOTICEWORTHY_IO_BYTES (10 * 1024 * 1024ULL) /* 10 MB */
77 #define NOTICEWORTHY_IP_BYTES (128 * 1024 * 1024ULL) /* 128 MB */
78
79 const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX] = {
80 [UNIT_SERVICE] = &service_vtable,
81 [UNIT_SOCKET] = &socket_vtable,
82 [UNIT_TARGET] = &target_vtable,
83 [UNIT_DEVICE] = &device_vtable,
84 [UNIT_MOUNT] = &mount_vtable,
85 [UNIT_AUTOMOUNT] = &automount_vtable,
86 [UNIT_SWAP] = &swap_vtable,
87 [UNIT_TIMER] = &timer_vtable,
88 [UNIT_PATH] = &path_vtable,
89 [UNIT_SLICE] = &slice_vtable,
90 [UNIT_SCOPE] = &scope_vtable,
91 };
92
93 Unit* unit_new(Manager *m, size_t size) {
94 Unit *u;
95
96 assert(m);
97 assert(size >= sizeof(Unit));
98
99 u = malloc0(size);
100 if (!u)
101 return NULL;
102
103 u->manager = m;
104 u->type = _UNIT_TYPE_INVALID;
105 u->default_dependencies = true;
106 u->unit_file_state = _UNIT_FILE_STATE_INVALID;
107 u->unit_file_preset = -1;
108 u->on_failure_job_mode = JOB_REPLACE;
109 u->on_success_job_mode = JOB_FAIL;
110 u->cgroup_control_inotify_wd = -1;
111 u->cgroup_memory_inotify_wd = -1;
112 u->job_timeout = USEC_INFINITY;
113 u->job_running_timeout = USEC_INFINITY;
114 u->ref_uid = UID_INVALID;
115 u->ref_gid = GID_INVALID;
116 u->cpu_usage_last = NSEC_INFINITY;
117 u->cgroup_invalidated_mask |= CGROUP_MASK_BPF_FIREWALL;
118 u->failure_action_exit_status = u->success_action_exit_status = -1;
119
120 u->ip_accounting_ingress_map_fd = -EBADF;
121 u->ip_accounting_egress_map_fd = -EBADF;
122 for (CGroupIOAccountingMetric i = 0; i < _CGROUP_IO_ACCOUNTING_METRIC_MAX; i++)
123 u->io_accounting_last[i] = UINT64_MAX;
124
125 u->ipv4_allow_map_fd = -EBADF;
126 u->ipv6_allow_map_fd = -EBADF;
127 u->ipv4_deny_map_fd = -EBADF;
128 u->ipv6_deny_map_fd = -EBADF;
129
130 u->last_section_private = -1;
131
132 u->start_ratelimit = (RateLimit) {
133 m->defaults.start_limit_interval,
134 m->defaults.start_limit_burst
135 };
136
137 u->auto_start_stop_ratelimit = (const RateLimit) {
138 10 * USEC_PER_SEC,
139 16
140 };
141
142 return u;
143 }
144
145 int unit_new_for_name(Manager *m, size_t size, const char *name, Unit **ret) {
146 _cleanup_(unit_freep) Unit *u = NULL;
147 int r;
148
149 u = unit_new(m, size);
150 if (!u)
151 return -ENOMEM;
152
153 r = unit_add_name(u, name);
154 if (r < 0)
155 return r;
156
157 *ret = TAKE_PTR(u);
158
159 return r;
160 }
161
162 bool unit_has_name(const Unit *u, const char *name) {
163 assert(u);
164 assert(name);
165
166 return streq_ptr(name, u->id) ||
167 set_contains(u->aliases, name);
168 }
169
170 static void unit_init(Unit *u) {
171 CGroupContext *cc;
172 ExecContext *ec;
173 KillContext *kc;
174
175 assert(u);
176 assert(u->manager);
177 assert(u->type >= 0);
178
179 cc = unit_get_cgroup_context(u);
180 if (cc) {
181 cgroup_context_init(cc);
182
183 /* Copy in the manager defaults into the cgroup
184 * context, _before_ the rest of the settings have
185 * been initialized */
186
187 cc->cpu_accounting = u->manager->defaults.cpu_accounting;
188 cc->io_accounting = u->manager->defaults.io_accounting;
189 cc->blockio_accounting = u->manager->defaults.blockio_accounting;
190 cc->memory_accounting = u->manager->defaults.memory_accounting;
191 cc->tasks_accounting = u->manager->defaults.tasks_accounting;
192 cc->ip_accounting = u->manager->defaults.ip_accounting;
193
194 if (u->type != UNIT_SLICE)
195 cc->tasks_max = u->manager->defaults.tasks_max;
196
197 cc->memory_pressure_watch = u->manager->defaults.memory_pressure_watch;
198 cc->memory_pressure_threshold_usec = u->manager->defaults.memory_pressure_threshold_usec;
199 }
200
201 ec = unit_get_exec_context(u);
202 if (ec) {
203 exec_context_init(ec);
204
205 if (u->manager->defaults.oom_score_adjust_set) {
206 ec->oom_score_adjust = u->manager->defaults.oom_score_adjust;
207 ec->oom_score_adjust_set = true;
208 }
209
210 if (MANAGER_IS_SYSTEM(u->manager))
211 ec->keyring_mode = EXEC_KEYRING_SHARED;
212 else {
213 ec->keyring_mode = EXEC_KEYRING_INHERIT;
214
215 /* User manager might have its umask redefined by PAM or UMask=. In this
216 * case let the units it manages inherit this value by default. They can
217 * still tune this value through their own unit file */
218 (void) get_process_umask(0, &ec->umask);
219 }
220 }
221
222 kc = unit_get_kill_context(u);
223 if (kc)
224 kill_context_init(kc);
225
226 if (UNIT_VTABLE(u)->init)
227 UNIT_VTABLE(u)->init(u);
228 }
229
230 static int unit_add_alias(Unit *u, char *donated_name) {
231 int r;
232
233 /* Make sure that u->names is allocated. We may leave u->names
234 * empty if we fail later, but this is not a problem. */
235 r = set_ensure_put(&u->aliases, &string_hash_ops, donated_name);
236 if (r < 0)
237 return r;
238 assert(r > 0);
239
240 return 0;
241 }
242
243 int unit_add_name(Unit *u, const char *text) {
244 _cleanup_free_ char *name = NULL, *instance = NULL;
245 UnitType t;
246 int r;
247
248 assert(u);
249 assert(text);
250
251 if (unit_name_is_valid(text, UNIT_NAME_TEMPLATE)) {
252 if (!u->instance)
253 return log_unit_debug_errno(u, SYNTHETIC_ERRNO(EINVAL),
254 "instance is not set when adding name '%s': %m", text);
255
256 r = unit_name_replace_instance(text, u->instance, &name);
257 if (r < 0)
258 return log_unit_debug_errno(u, r,
259 "failed to build instance name from '%s': %m", text);
260 } else {
261 name = strdup(text);
262 if (!name)
263 return -ENOMEM;
264 }
265
266 if (unit_has_name(u, name))
267 return 0;
268
269 if (hashmap_contains(u->manager->units, name))
270 return log_unit_debug_errno(u, SYNTHETIC_ERRNO(EEXIST),
271 "unit already exist when adding name '%s': %m", name);
272
273 if (!unit_name_is_valid(name, UNIT_NAME_PLAIN|UNIT_NAME_INSTANCE))
274 return log_unit_debug_errno(u, SYNTHETIC_ERRNO(EINVAL),
275 "name '%s' is invalid: %m", name);
276
277 t = unit_name_to_type(name);
278 if (t < 0)
279 return log_unit_debug_errno(u, SYNTHETIC_ERRNO(EINVAL),
280 "failed to derive unit type from name '%s': %m", name);
281
282 if (u->type != _UNIT_TYPE_INVALID && t != u->type)
283 return log_unit_debug_errno(u, SYNTHETIC_ERRNO(EINVAL),
284 "unit type is illegal: u->type(%d) and t(%d) for name '%s': %m",
285 u->type, t, name);
286
287 r = unit_name_to_instance(name, &instance);
288 if (r < 0)
289 return log_unit_debug_errno(u, r, "failed to extract instance from name '%s': %m", name);
290
291 if (instance && !unit_type_may_template(t))
292 return log_unit_debug_errno(u, SYNTHETIC_ERRNO(EINVAL), "templates are not allowed for name '%s': %m", name);
293
294 /* Ensure that this unit either has no instance, or that the instance matches. */
295 if (u->type != _UNIT_TYPE_INVALID && !streq_ptr(u->instance, instance))
296 return log_unit_debug_errno(u, SYNTHETIC_ERRNO(EINVAL),
297 "cannot add name %s, the instances don't match (\"%s\" != \"%s\").",
298 name, instance, u->instance);
299
300 if (u->id && !unit_type_may_alias(t))
301 return log_unit_debug_errno(u, SYNTHETIC_ERRNO(EEXIST),
302 "cannot add name %s, aliases are not allowed for %s units.",
303 name, unit_type_to_string(t));
304
305 if (hashmap_size(u->manager->units) >= MANAGER_MAX_NAMES)
306 return log_unit_warning_errno(u, SYNTHETIC_ERRNO(E2BIG), "cannot add name, manager has too many units: %m");
307
308 /* Add name to the global hashmap first, because that's easier to undo */
309 r = hashmap_put(u->manager->units, name, u);
310 if (r < 0)
311 return log_unit_debug_errno(u, r, "add unit to hashmap failed for name '%s': %m", text);
312
313 if (u->id) {
314 r = unit_add_alias(u, name); /* unit_add_alias() takes ownership of the name on success */
315 if (r < 0) {
316 hashmap_remove(u->manager->units, name);
317 return r;
318 }
319 TAKE_PTR(name);
320
321 } else {
322 /* A new name, we don't need the set yet. */
323 assert(u->type == _UNIT_TYPE_INVALID);
324 assert(!u->instance);
325
326 u->type = t;
327 u->id = TAKE_PTR(name);
328 u->instance = TAKE_PTR(instance);
329
330 LIST_PREPEND(units_by_type, u->manager->units_by_type[t], u);
331 unit_init(u);
332 }
333
334 unit_add_to_dbus_queue(u);
335 return 0;
336 }
337
338 int unit_choose_id(Unit *u, const char *name) {
339 _cleanup_free_ char *t = NULL;
340 char *s;
341 int r;
342
343 assert(u);
344 assert(name);
345
346 if (unit_name_is_valid(name, UNIT_NAME_TEMPLATE)) {
347 if (!u->instance)
348 return -EINVAL;
349
350 r = unit_name_replace_instance(name, u->instance, &t);
351 if (r < 0)
352 return r;
353
354 name = t;
355 }
356
357 if (streq_ptr(u->id, name))
358 return 0; /* Nothing to do. */
359
360 /* Selects one of the aliases of this unit as the id */
361 s = set_get(u->aliases, (char*) name);
362 if (!s)
363 return -ENOENT;
364
365 if (u->id) {
366 r = set_remove_and_put(u->aliases, name, u->id);
367 if (r < 0)
368 return r;
369 } else
370 assert_se(set_remove(u->aliases, name)); /* see set_get() above… */
371
372 u->id = s; /* Old u->id is now stored in the set, and s is not stored anywhere */
373 unit_add_to_dbus_queue(u);
374
375 return 0;
376 }
377
378 int unit_set_description(Unit *u, const char *description) {
379 int r;
380
381 assert(u);
382
383 r = free_and_strdup(&u->description, empty_to_null(description));
384 if (r < 0)
385 return r;
386 if (r > 0)
387 unit_add_to_dbus_queue(u);
388
389 return 0;
390 }
391
392 static bool unit_success_failure_handler_has_jobs(Unit *unit) {
393 Unit *other;
394
395 UNIT_FOREACH_DEPENDENCY(other, unit, UNIT_ATOM_ON_SUCCESS)
396 if (other->job || other->nop_job)
397 return true;
398
399 UNIT_FOREACH_DEPENDENCY(other, unit, UNIT_ATOM_ON_FAILURE)
400 if (other->job || other->nop_job)
401 return true;
402
403 return false;
404 }
405
406 void unit_release_resources(Unit *u) {
407 UnitActiveState state;
408 ExecContext *ec;
409
410 assert(u);
411
412 if (u->job || u->nop_job)
413 return;
414
415 if (u->perpetual)
416 return;
417
418 state = unit_active_state(u);
419 if (!IN_SET(state, UNIT_INACTIVE, UNIT_FAILED))
420 return;
421
422 if (unit_will_restart(u))
423 return;
424
425 ec = unit_get_exec_context(u);
426 if (ec && ec->runtime_directory_preserve_mode == EXEC_PRESERVE_RESTART)
427 exec_context_destroy_runtime_directory(ec, u->manager->prefix[EXEC_DIRECTORY_RUNTIME]);
428
429 if (UNIT_VTABLE(u)->release_resources)
430 UNIT_VTABLE(u)->release_resources(u);
431 }
432
433 bool unit_may_gc(Unit *u) {
434 UnitActiveState state;
435 int r;
436
437 assert(u);
438
439 /* Checks whether the unit is ready to be unloaded for garbage collection. Returns true when the
440 * unit may be collected, and false if there's some reason to keep it loaded.
441 *
442 * References from other units are *not* checked here. Instead, this is done in unit_gc_sweep(), but
443 * using markers to properly collect dependency loops.
444 */
445
446 if (u->job || u->nop_job)
447 return false;
448
449 if (u->perpetual)
450 return false;
451
452 /* if we saw a cgroup empty event for this unit, stay around until we processed it so that we remove
453 * the empty cgroup if possible. Similar, process any pending OOM events if they are already queued
454 * before we release the unit. */
455 if (u->in_cgroup_empty_queue || u->in_cgroup_oom_queue)
456 return false;
457
458 /* Make sure to send out D-Bus events before we unload the unit */
459 if (u->in_dbus_queue)
460 return false;
461
462 if (sd_bus_track_count(u->bus_track) > 0)
463 return false;
464
465 state = unit_active_state(u);
466
467 /* But we keep the unit object around for longer when it is referenced or configured to not be
468 * gc'ed */
469 switch (u->collect_mode) {
470
471 case COLLECT_INACTIVE:
472 if (state != UNIT_INACTIVE)
473 return false;
474
475 break;
476
477 case COLLECT_INACTIVE_OR_FAILED:
478 if (!IN_SET(state, UNIT_INACTIVE, UNIT_FAILED))
479 return false;
480
481 break;
482
483 default:
484 assert_not_reached();
485 }
486
487 /* Check if any OnFailure= or on Success= jobs may be pending */
488 if (unit_success_failure_handler_has_jobs(u))
489 return false;
490
491 if (u->cgroup_path) {
492 /* If the unit has a cgroup, then check whether there's anything in it. If so, we should stay
493 * around. Units with active processes should never be collected. */
494
495 r = cg_is_empty_recursive(SYSTEMD_CGROUP_CONTROLLER, u->cgroup_path);
496 if (r < 0)
497 log_unit_debug_errno(u, r, "Failed to determine whether cgroup %s is empty: %m", empty_to_root(u->cgroup_path));
498 if (r <= 0)
499 return false;
500 }
501
502 if (!UNIT_VTABLE(u)->may_gc)
503 return true;
504
505 return UNIT_VTABLE(u)->may_gc(u);
506 }
507
508 void unit_add_to_load_queue(Unit *u) {
509 assert(u);
510 assert(u->type != _UNIT_TYPE_INVALID);
511
512 if (u->load_state != UNIT_STUB || u->in_load_queue)
513 return;
514
515 LIST_PREPEND(load_queue, u->manager->load_queue, u);
516 u->in_load_queue = true;
517 }
518
519 void unit_add_to_cleanup_queue(Unit *u) {
520 assert(u);
521
522 if (u->in_cleanup_queue)
523 return;
524
525 LIST_PREPEND(cleanup_queue, u->manager->cleanup_queue, u);
526 u->in_cleanup_queue = true;
527 }
528
529 void unit_add_to_gc_queue(Unit *u) {
530 assert(u);
531
532 if (u->in_gc_queue || u->in_cleanup_queue)
533 return;
534
535 if (!unit_may_gc(u))
536 return;
537
538 LIST_PREPEND(gc_queue, u->manager->gc_unit_queue, u);
539 u->in_gc_queue = true;
540 }
541
542 void unit_add_to_dbus_queue(Unit *u) {
543 assert(u);
544 assert(u->type != _UNIT_TYPE_INVALID);
545
546 if (u->load_state == UNIT_STUB || u->in_dbus_queue)
547 return;
548
549 /* Shortcut things if nobody cares */
550 if (sd_bus_track_count(u->manager->subscribed) <= 0 &&
551 sd_bus_track_count(u->bus_track) <= 0 &&
552 set_isempty(u->manager->private_buses)) {
553 u->sent_dbus_new_signal = true;
554 return;
555 }
556
557 LIST_PREPEND(dbus_queue, u->manager->dbus_unit_queue, u);
558 u->in_dbus_queue = true;
559 }
560
561 void unit_submit_to_stop_when_unneeded_queue(Unit *u) {
562 assert(u);
563
564 if (u->in_stop_when_unneeded_queue)
565 return;
566
567 if (!u->stop_when_unneeded)
568 return;
569
570 if (!UNIT_IS_ACTIVE_OR_RELOADING(unit_active_state(u)))
571 return;
572
573 LIST_PREPEND(stop_when_unneeded_queue, u->manager->stop_when_unneeded_queue, u);
574 u->in_stop_when_unneeded_queue = true;
575 }
576
577 void unit_submit_to_start_when_upheld_queue(Unit *u) {
578 assert(u);
579
580 if (u->in_start_when_upheld_queue)
581 return;
582
583 if (!UNIT_IS_INACTIVE_OR_FAILED(unit_active_state(u)))
584 return;
585
586 if (!unit_has_dependency(u, UNIT_ATOM_START_STEADILY, NULL))
587 return;
588
589 LIST_PREPEND(start_when_upheld_queue, u->manager->start_when_upheld_queue, u);
590 u->in_start_when_upheld_queue = true;
591 }
592
593 void unit_submit_to_stop_when_bound_queue(Unit *u) {
594 assert(u);
595
596 if (u->in_stop_when_bound_queue)
597 return;
598
599 if (!UNIT_IS_ACTIVE_OR_RELOADING(unit_active_state(u)))
600 return;
601
602 if (!unit_has_dependency(u, UNIT_ATOM_CANNOT_BE_ACTIVE_WITHOUT, NULL))
603 return;
604
605 LIST_PREPEND(stop_when_bound_queue, u->manager->stop_when_bound_queue, u);
606 u->in_stop_when_bound_queue = true;
607 }
608
609 static bool unit_can_release_resources(Unit *u) {
610 ExecContext *ec;
611
612 assert(u);
613
614 if (UNIT_VTABLE(u)->release_resources)
615 return true;
616
617 ec = unit_get_exec_context(u);
618 if (ec && ec->runtime_directory_preserve_mode == EXEC_PRESERVE_RESTART)
619 return true;
620
621 return false;
622 }
623
624 void unit_submit_to_release_resources_queue(Unit *u) {
625 assert(u);
626
627 if (u->in_release_resources_queue)
628 return;
629
630 if (u->job || u->nop_job)
631 return;
632
633 if (u->perpetual)
634 return;
635
636 if (!unit_can_release_resources(u))
637 return;
638
639 LIST_PREPEND(release_resources_queue, u->manager->release_resources_queue, u);
640 u->in_release_resources_queue = true;
641 }
642
643 static void unit_clear_dependencies(Unit *u) {
644 assert(u);
645
646 /* Removes all dependencies configured on u and their reverse dependencies. */
647
648 for (Hashmap *deps; (deps = hashmap_steal_first(u->dependencies));) {
649
650 for (Unit *other; (other = hashmap_steal_first_key(deps));) {
651 Hashmap *other_deps;
652
653 HASHMAP_FOREACH(other_deps, other->dependencies)
654 hashmap_remove(other_deps, u);
655
656 unit_add_to_gc_queue(other);
657 }
658
659 hashmap_free(deps);
660 }
661
662 u->dependencies = hashmap_free(u->dependencies);
663 }
664
665 static void unit_remove_transient(Unit *u) {
666 assert(u);
667
668 if (!u->transient)
669 return;
670
671 if (u->fragment_path)
672 (void) unlink(u->fragment_path);
673
674 STRV_FOREACH(i, u->dropin_paths) {
675 _cleanup_free_ char *p = NULL, *pp = NULL;
676
677 if (path_extract_directory(*i, &p) < 0) /* Get the drop-in directory from the drop-in file */
678 continue;
679
680 if (path_extract_directory(p, &pp) < 0) /* Get the config directory from the drop-in directory */
681 continue;
682
683 /* Only drop transient drop-ins */
684 if (!path_equal(u->manager->lookup_paths.transient, pp))
685 continue;
686
687 (void) unlink(*i);
688 (void) rmdir(p);
689 }
690 }
691
692 static void unit_free_requires_mounts_for(Unit *u) {
693 assert(u);
694
695 for (;;) {
696 _cleanup_free_ char *path = NULL;
697
698 path = hashmap_steal_first_key(u->requires_mounts_for);
699 if (!path)
700 break;
701 else {
702 char s[strlen(path) + 1];
703
704 PATH_FOREACH_PREFIX_MORE(s, path) {
705 char *y;
706 Set *x;
707
708 x = hashmap_get2(u->manager->units_requiring_mounts_for, s, (void**) &y);
709 if (!x)
710 continue;
711
712 (void) set_remove(x, u);
713
714 if (set_isempty(x)) {
715 (void) hashmap_remove(u->manager->units_requiring_mounts_for, y);
716 free(y);
717 set_free(x);
718 }
719 }
720 }
721 }
722
723 u->requires_mounts_for = hashmap_free(u->requires_mounts_for);
724 }
725
726 static void unit_done(Unit *u) {
727 ExecContext *ec;
728 CGroupContext *cc;
729
730 assert(u);
731
732 if (u->type < 0)
733 return;
734
735 if (UNIT_VTABLE(u)->done)
736 UNIT_VTABLE(u)->done(u);
737
738 ec = unit_get_exec_context(u);
739 if (ec)
740 exec_context_done(ec);
741
742 cc = unit_get_cgroup_context(u);
743 if (cc)
744 cgroup_context_done(cc);
745 }
746
747 Unit* unit_free(Unit *u) {
748 Unit *slice;
749 char *t;
750
751 if (!u)
752 return NULL;
753
754 sd_event_source_disable_unref(u->auto_start_stop_event_source);
755
756 u->transient_file = safe_fclose(u->transient_file);
757
758 if (!MANAGER_IS_RELOADING(u->manager))
759 unit_remove_transient(u);
760
761 bus_unit_send_removed_signal(u);
762
763 unit_done(u);
764
765 unit_dequeue_rewatch_pids(u);
766
767 u->match_bus_slot = sd_bus_slot_unref(u->match_bus_slot);
768 u->bus_track = sd_bus_track_unref(u->bus_track);
769 u->deserialized_refs = strv_free(u->deserialized_refs);
770 u->pending_freezer_invocation = sd_bus_message_unref(u->pending_freezer_invocation);
771
772 unit_free_requires_mounts_for(u);
773
774 SET_FOREACH(t, u->aliases)
775 hashmap_remove_value(u->manager->units, t, u);
776 if (u->id)
777 hashmap_remove_value(u->manager->units, u->id, u);
778
779 if (!sd_id128_is_null(u->invocation_id))
780 hashmap_remove_value(u->manager->units_by_invocation_id, &u->invocation_id, u);
781
782 if (u->job) {
783 Job *j = u->job;
784 job_uninstall(j);
785 job_free(j);
786 }
787
788 if (u->nop_job) {
789 Job *j = u->nop_job;
790 job_uninstall(j);
791 job_free(j);
792 }
793
794 /* A unit is being dropped from the tree, make sure our family is realized properly. Do this after we
795 * detach the unit from slice tree in order to eliminate its effect on controller masks. */
796 slice = UNIT_GET_SLICE(u);
797 unit_clear_dependencies(u);
798 if (slice)
799 unit_add_family_to_cgroup_realize_queue(slice);
800
801 if (u->on_console)
802 manager_unref_console(u->manager);
803
804 fdset_free(u->initial_socket_bind_link_fds);
805 #if BPF_FRAMEWORK
806 bpf_link_free(u->ipv4_socket_bind_link);
807 bpf_link_free(u->ipv6_socket_bind_link);
808 #endif
809
810 unit_release_cgroup(u);
811
812 if (!MANAGER_IS_RELOADING(u->manager))
813 unit_unlink_state_files(u);
814
815 unit_unref_uid_gid(u, false);
816
817 (void) manager_update_failed_units(u->manager, u, false);
818 set_remove(u->manager->startup_units, u);
819
820 unit_unwatch_all_pids(u);
821
822 while (u->refs_by_target)
823 unit_ref_unset(u->refs_by_target);
824
825 if (u->type != _UNIT_TYPE_INVALID)
826 LIST_REMOVE(units_by_type, u->manager->units_by_type[u->type], u);
827
828 if (u->in_load_queue)
829 LIST_REMOVE(load_queue, u->manager->load_queue, u);
830
831 if (u->in_dbus_queue)
832 LIST_REMOVE(dbus_queue, u->manager->dbus_unit_queue, u);
833
834 if (u->in_cleanup_queue)
835 LIST_REMOVE(cleanup_queue, u->manager->cleanup_queue, u);
836
837 if (u->in_gc_queue)
838 LIST_REMOVE(gc_queue, u->manager->gc_unit_queue, u);
839
840 if (u->in_cgroup_realize_queue)
841 LIST_REMOVE(cgroup_realize_queue, u->manager->cgroup_realize_queue, u);
842
843 if (u->in_cgroup_empty_queue)
844 LIST_REMOVE(cgroup_empty_queue, u->manager->cgroup_empty_queue, u);
845
846 if (u->in_cgroup_oom_queue)
847 LIST_REMOVE(cgroup_oom_queue, u->manager->cgroup_oom_queue, u);
848
849 if (u->in_target_deps_queue)
850 LIST_REMOVE(target_deps_queue, u->manager->target_deps_queue, u);
851
852 if (u->in_stop_when_unneeded_queue)
853 LIST_REMOVE(stop_when_unneeded_queue, u->manager->stop_when_unneeded_queue, u);
854
855 if (u->in_start_when_upheld_queue)
856 LIST_REMOVE(start_when_upheld_queue, u->manager->start_when_upheld_queue, u);
857
858 if (u->in_stop_when_bound_queue)
859 LIST_REMOVE(stop_when_bound_queue, u->manager->stop_when_bound_queue, u);
860
861 if (u->in_release_resources_queue)
862 LIST_REMOVE(release_resources_queue, u->manager->release_resources_queue, u);
863
864 bpf_firewall_close(u);
865
866 hashmap_free(u->bpf_foreign_by_key);
867
868 bpf_program_free(u->bpf_device_control_installed);
869
870 #if BPF_FRAMEWORK
871 bpf_link_free(u->restrict_ifaces_ingress_bpf_link);
872 bpf_link_free(u->restrict_ifaces_egress_bpf_link);
873 #endif
874 fdset_free(u->initial_restric_ifaces_link_fds);
875
876 condition_free_list(u->conditions);
877 condition_free_list(u->asserts);
878
879 free(u->description);
880 strv_free(u->documentation);
881 free(u->fragment_path);
882 free(u->source_path);
883 strv_free(u->dropin_paths);
884 free(u->instance);
885
886 free(u->job_timeout_reboot_arg);
887 free(u->reboot_arg);
888
889 free(u->access_selinux_context);
890
891 set_free_free(u->aliases);
892 free(u->id);
893
894 activation_details_unref(u->activation_details);
895
896 return mfree(u);
897 }
898
899 FreezerState unit_freezer_state(Unit *u) {
900 assert(u);
901
902 return u->freezer_state;
903 }
904
905 int unit_freezer_state_kernel(Unit *u, FreezerState *ret) {
906 char *values[1] = {};
907 int r;
908
909 assert(u);
910
911 r = cg_get_keyed_attribute(SYSTEMD_CGROUP_CONTROLLER, u->cgroup_path, "cgroup.events",
912 STRV_MAKE("frozen"), values);
913 if (r < 0)
914 return r;
915
916 r = _FREEZER_STATE_INVALID;
917
918 if (values[0]) {
919 if (streq(values[0], "0"))
920 r = FREEZER_RUNNING;
921 else if (streq(values[0], "1"))
922 r = FREEZER_FROZEN;
923 }
924
925 free(values[0]);
926 *ret = r;
927
928 return 0;
929 }
930
931 UnitActiveState unit_active_state(Unit *u) {
932 assert(u);
933
934 if (u->load_state == UNIT_MERGED)
935 return unit_active_state(unit_follow_merge(u));
936
937 /* After a reload it might happen that a unit is not correctly
938 * loaded but still has a process around. That's why we won't
939 * shortcut failed loading to UNIT_INACTIVE_FAILED. */
940
941 return UNIT_VTABLE(u)->active_state(u);
942 }
943
944 const char* unit_sub_state_to_string(Unit *u) {
945 assert(u);
946
947 return UNIT_VTABLE(u)->sub_state_to_string(u);
948 }
949
950 static int unit_merge_names(Unit *u, Unit *other) {
951 char *name;
952 int r;
953
954 assert(u);
955 assert(other);
956
957 r = unit_add_alias(u, other->id);
958 if (r < 0)
959 return r;
960
961 r = set_move(u->aliases, other->aliases);
962 if (r < 0) {
963 set_remove(u->aliases, other->id);
964 return r;
965 }
966
967 TAKE_PTR(other->id);
968 other->aliases = set_free_free(other->aliases);
969
970 SET_FOREACH(name, u->aliases)
971 assert_se(hashmap_replace(u->manager->units, name, u) == 0);
972
973 return 0;
974 }
975
976 static int unit_reserve_dependencies(Unit *u, Unit *other) {
977 size_t n_reserve;
978 Hashmap* deps;
979 void *d;
980 int r;
981
982 assert(u);
983 assert(other);
984
985 /* Let's reserve some space in the dependency hashmaps so that later on merging the units cannot
986 * fail.
987 *
988 * First make some room in the per dependency type hashmaps. Using the summed size of both units'
989 * hashmaps is an estimate that is likely too high since they probably use some of the same
990 * types. But it's never too low, and that's all we need. */
991
992 n_reserve = MIN(hashmap_size(other->dependencies), LESS_BY((size_t) _UNIT_DEPENDENCY_MAX, hashmap_size(u->dependencies)));
993 if (n_reserve > 0) {
994 r = hashmap_ensure_allocated(&u->dependencies, NULL);
995 if (r < 0)
996 return r;
997
998 r = hashmap_reserve(u->dependencies, n_reserve);
999 if (r < 0)
1000 return r;
1001 }
1002
1003 /* Now, enlarge our per dependency type hashmaps by the number of entries in the same hashmap of the
1004 * other unit's dependencies.
1005 *
1006 * NB: If u does not have a dependency set allocated for some dependency type, there is no need to
1007 * reserve anything for. In that case other's set will be transferred as a whole to u by
1008 * complete_move(). */
1009
1010 HASHMAP_FOREACH_KEY(deps, d, u->dependencies) {
1011 Hashmap *other_deps;
1012
1013 other_deps = hashmap_get(other->dependencies, d);
1014
1015 r = hashmap_reserve(deps, hashmap_size(other_deps));
1016 if (r < 0)
1017 return r;
1018 }
1019
1020 return 0;
1021 }
1022
1023 static bool unit_should_warn_about_dependency(UnitDependency dependency) {
1024 /* Only warn about some unit types */
1025 return IN_SET(dependency,
1026 UNIT_CONFLICTS,
1027 UNIT_CONFLICTED_BY,
1028 UNIT_BEFORE,
1029 UNIT_AFTER,
1030 UNIT_ON_SUCCESS,
1031 UNIT_ON_FAILURE,
1032 UNIT_TRIGGERS,
1033 UNIT_TRIGGERED_BY);
1034 }
1035
1036 static int unit_per_dependency_type_hashmap_update(
1037 Hashmap *per_type,
1038 Unit *other,
1039 UnitDependencyMask origin_mask,
1040 UnitDependencyMask destination_mask) {
1041
1042 UnitDependencyInfo info;
1043 int r;
1044
1045 assert(other);
1046 assert_cc(sizeof(void*) == sizeof(info));
1047
1048 /* Acquire the UnitDependencyInfo entry for the Unit* we are interested in, and update it if it
1049 * exists, or insert it anew if not. */
1050
1051 info.data = hashmap_get(per_type, other);
1052 if (info.data) {
1053 /* Entry already exists. Add in our mask. */
1054
1055 if (FLAGS_SET(origin_mask, info.origin_mask) &&
1056 FLAGS_SET(destination_mask, info.destination_mask))
1057 return 0; /* NOP */
1058
1059 info.origin_mask |= origin_mask;
1060 info.destination_mask |= destination_mask;
1061
1062 r = hashmap_update(per_type, other, info.data);
1063 } else {
1064 info = (UnitDependencyInfo) {
1065 .origin_mask = origin_mask,
1066 .destination_mask = destination_mask,
1067 };
1068
1069 r = hashmap_put(per_type, other, info.data);
1070 }
1071 if (r < 0)
1072 return r;
1073
1074 return 1;
1075 }
1076
1077 static void unit_merge_dependencies(Unit *u, Unit *other) {
1078 Hashmap *deps;
1079 void *dt; /* Actually of type UnitDependency, except that we don't bother casting it here,
1080 * since the hashmaps all want it as void pointer. */
1081
1082 assert(u);
1083 assert(other);
1084
1085 if (u == other)
1086 return;
1087
1088 /* First, remove dependency to other. */
1089 HASHMAP_FOREACH_KEY(deps, dt, u->dependencies) {
1090 if (hashmap_remove(deps, other) && unit_should_warn_about_dependency(UNIT_DEPENDENCY_FROM_PTR(dt)))
1091 log_unit_warning(u, "Dependency %s=%s is dropped, as %s is merged into %s.",
1092 unit_dependency_to_string(UNIT_DEPENDENCY_FROM_PTR(dt)),
1093 other->id, other->id, u->id);
1094
1095 if (hashmap_isempty(deps))
1096 hashmap_free(hashmap_remove(u->dependencies, dt));
1097 }
1098
1099 for (;;) {
1100 _cleanup_hashmap_free_ Hashmap *other_deps = NULL;
1101 UnitDependencyInfo di_back;
1102 Unit *back;
1103
1104 /* Let's focus on one dependency type at a time, that 'other' has defined. */
1105 other_deps = hashmap_steal_first_key_and_value(other->dependencies, &dt);
1106 if (!other_deps)
1107 break; /* done! */
1108
1109 deps = hashmap_get(u->dependencies, dt);
1110
1111 /* Now iterate through all dependencies of this dependency type, of 'other'. We refer to the
1112 * referenced units as 'back'. */
1113 HASHMAP_FOREACH_KEY(di_back.data, back, other_deps) {
1114 Hashmap *back_deps;
1115 void *back_dt;
1116
1117 if (back == u) {
1118 /* This is a dependency pointing back to the unit we want to merge with?
1119 * Suppress it (but warn) */
1120 if (unit_should_warn_about_dependency(UNIT_DEPENDENCY_FROM_PTR(dt)))
1121 log_unit_warning(u, "Dependency %s=%s in %s is dropped, as %s is merged into %s.",
1122 unit_dependency_to_string(UNIT_DEPENDENCY_FROM_PTR(dt)),
1123 u->id, other->id, other->id, u->id);
1124
1125 hashmap_remove(other_deps, back);
1126 continue;
1127 }
1128
1129 /* Now iterate through all deps of 'back', and fix the ones pointing to 'other' to
1130 * point to 'u' instead. */
1131 HASHMAP_FOREACH_KEY(back_deps, back_dt, back->dependencies) {
1132 UnitDependencyInfo di_move;
1133
1134 di_move.data = hashmap_remove(back_deps, other);
1135 if (!di_move.data)
1136 continue;
1137
1138 assert_se(unit_per_dependency_type_hashmap_update(
1139 back_deps,
1140 u,
1141 di_move.origin_mask,
1142 di_move.destination_mask) >= 0);
1143 }
1144
1145 /* The target unit already has dependencies of this type, let's then merge this individually. */
1146 if (deps)
1147 assert_se(unit_per_dependency_type_hashmap_update(
1148 deps,
1149 back,
1150 di_back.origin_mask,
1151 di_back.destination_mask) >= 0);
1152 }
1153
1154 /* Now all references towards 'other' of the current type 'dt' are corrected to point to 'u'.
1155 * Lets's now move the deps of type 'dt' from 'other' to 'u'. If the unit does not have
1156 * dependencies of this type, let's move them per type wholesale. */
1157 if (!deps)
1158 assert_se(hashmap_put(u->dependencies, dt, TAKE_PTR(other_deps)) >= 0);
1159 }
1160
1161 other->dependencies = hashmap_free(other->dependencies);
1162 }
1163
1164 int unit_merge(Unit *u, Unit *other) {
1165 int r;
1166
1167 assert(u);
1168 assert(other);
1169 assert(u->manager == other->manager);
1170 assert(u->type != _UNIT_TYPE_INVALID);
1171
1172 other = unit_follow_merge(other);
1173
1174 if (other == u)
1175 return 0;
1176
1177 if (u->type != other->type)
1178 return -EINVAL;
1179
1180 if (!unit_type_may_alias(u->type)) /* Merging only applies to unit names that support aliases */
1181 return -EEXIST;
1182
1183 if (!IN_SET(other->load_state, UNIT_STUB, UNIT_NOT_FOUND))
1184 return -EEXIST;
1185
1186 if (!streq_ptr(u->instance, other->instance))
1187 return -EINVAL;
1188
1189 if (other->job)
1190 return -EEXIST;
1191
1192 if (other->nop_job)
1193 return -EEXIST;
1194
1195 if (!UNIT_IS_INACTIVE_OR_FAILED(unit_active_state(other)))
1196 return -EEXIST;
1197
1198 /* Make reservations to ensure merge_dependencies() won't fail. We don't rollback reservations if we
1199 * fail. We don't have a way to undo reservations. A reservation is not a leak. */
1200 r = unit_reserve_dependencies(u, other);
1201 if (r < 0)
1202 return r;
1203
1204 /* Redirect all references */
1205 while (other->refs_by_target)
1206 unit_ref_set(other->refs_by_target, other->refs_by_target->source, u);
1207
1208 /* Merge dependencies */
1209 unit_merge_dependencies(u, other);
1210
1211 /* Merge names. It is better to do that after merging deps, otherwise the log message contains n/a. */
1212 r = unit_merge_names(u, other);
1213 if (r < 0)
1214 return r;
1215
1216 other->load_state = UNIT_MERGED;
1217 other->merged_into = u;
1218
1219 if (!u->activation_details)
1220 u->activation_details = activation_details_ref(other->activation_details);
1221
1222 /* If there is still some data attached to the other node, we
1223 * don't need it anymore, and can free it. */
1224 if (other->load_state != UNIT_STUB)
1225 if (UNIT_VTABLE(other)->done)
1226 UNIT_VTABLE(other)->done(other);
1227
1228 unit_add_to_dbus_queue(u);
1229 unit_add_to_cleanup_queue(other);
1230
1231 return 0;
1232 }
1233
1234 int unit_merge_by_name(Unit *u, const char *name) {
1235 _cleanup_free_ char *s = NULL;
1236 Unit *other;
1237 int r;
1238
1239 /* Either add name to u, or if a unit with name already exists, merge it with u.
1240 * If name is a template, do the same for name@instance, where instance is u's instance. */
1241
1242 assert(u);
1243 assert(name);
1244
1245 if (unit_name_is_valid(name, UNIT_NAME_TEMPLATE)) {
1246 if (!u->instance)
1247 return -EINVAL;
1248
1249 r = unit_name_replace_instance(name, u->instance, &s);
1250 if (r < 0)
1251 return r;
1252
1253 name = s;
1254 }
1255
1256 other = manager_get_unit(u->manager, name);
1257 if (other)
1258 return unit_merge(u, other);
1259
1260 return unit_add_name(u, name);
1261 }
1262
1263 Unit* unit_follow_merge(Unit *u) {
1264 assert(u);
1265
1266 while (u->load_state == UNIT_MERGED)
1267 assert_se(u = u->merged_into);
1268
1269 return u;
1270 }
1271
1272 int unit_add_exec_dependencies(Unit *u, ExecContext *c) {
1273 int r;
1274
1275 assert(u);
1276 assert(c);
1277
1278 /* Unlike unit_add_dependency() or friends, this always returns 0 on success. */
1279
1280 if (c->working_directory && !c->working_directory_missing_ok) {
1281 r = unit_require_mounts_for(u, c->working_directory, UNIT_DEPENDENCY_FILE);
1282 if (r < 0)
1283 return r;
1284 }
1285
1286 if (c->root_directory) {
1287 r = unit_require_mounts_for(u, c->root_directory, UNIT_DEPENDENCY_FILE);
1288 if (r < 0)
1289 return r;
1290 }
1291
1292 if (c->root_image) {
1293 r = unit_require_mounts_for(u, c->root_image, UNIT_DEPENDENCY_FILE);
1294 if (r < 0)
1295 return r;
1296 }
1297
1298 for (ExecDirectoryType dt = 0; dt < _EXEC_DIRECTORY_TYPE_MAX; dt++) {
1299 if (!u->manager->prefix[dt])
1300 continue;
1301
1302 for (size_t i = 0; i < c->directories[dt].n_items; i++) {
1303 _cleanup_free_ char *p = NULL;
1304
1305 p = path_join(u->manager->prefix[dt], c->directories[dt].items[i].path);
1306 if (!p)
1307 return -ENOMEM;
1308
1309 r = unit_require_mounts_for(u, p, UNIT_DEPENDENCY_FILE);
1310 if (r < 0)
1311 return r;
1312 }
1313 }
1314
1315 if (!MANAGER_IS_SYSTEM(u->manager))
1316 return 0;
1317
1318 /* For the following three directory types we need write access, and /var/ is possibly on the root
1319 * fs. Hence order after systemd-remount-fs.service, to ensure things are writable. */
1320 if (c->directories[EXEC_DIRECTORY_STATE].n_items > 0 ||
1321 c->directories[EXEC_DIRECTORY_CACHE].n_items > 0 ||
1322 c->directories[EXEC_DIRECTORY_LOGS].n_items > 0) {
1323 r = unit_add_dependency_by_name(u, UNIT_AFTER, SPECIAL_REMOUNT_FS_SERVICE, true, UNIT_DEPENDENCY_FILE);
1324 if (r < 0)
1325 return r;
1326 }
1327
1328 if (c->private_tmp) {
1329
1330 /* FIXME: for now we make a special case for /tmp and add a weak dependency on
1331 * tmp.mount so /tmp being masked is supported. However there's no reason to treat
1332 * /tmp specifically and masking other mount units should be handled more
1333 * gracefully too, see PR#16894. */
1334 r = unit_add_two_dependencies_by_name(u, UNIT_AFTER, UNIT_WANTS, "tmp.mount", true, UNIT_DEPENDENCY_FILE);
1335 if (r < 0)
1336 return r;
1337
1338 r = unit_require_mounts_for(u, "/var/tmp", UNIT_DEPENDENCY_FILE);
1339 if (r < 0)
1340 return r;
1341
1342 r = unit_add_dependency_by_name(u, UNIT_AFTER, SPECIAL_TMPFILES_SETUP_SERVICE, true, UNIT_DEPENDENCY_FILE);
1343 if (r < 0)
1344 return r;
1345 }
1346
1347 if (c->root_image) {
1348 /* We need to wait for /dev/loopX to appear when doing RootImage=, hence let's add an
1349 * implicit dependency on udev */
1350
1351 r = unit_add_dependency_by_name(u, UNIT_AFTER, SPECIAL_UDEVD_SERVICE, true, UNIT_DEPENDENCY_FILE);
1352 if (r < 0)
1353 return r;
1354 }
1355
1356 if (!IN_SET(c->std_output,
1357 EXEC_OUTPUT_JOURNAL, EXEC_OUTPUT_JOURNAL_AND_CONSOLE,
1358 EXEC_OUTPUT_KMSG, EXEC_OUTPUT_KMSG_AND_CONSOLE) &&
1359 !IN_SET(c->std_error,
1360 EXEC_OUTPUT_JOURNAL, EXEC_OUTPUT_JOURNAL_AND_CONSOLE,
1361 EXEC_OUTPUT_KMSG, EXEC_OUTPUT_KMSG_AND_CONSOLE) &&
1362 !c->log_namespace)
1363 return 0;
1364
1365 /* If syslog or kernel logging is requested (or log namespacing is), make sure our own logging daemon
1366 * is run first. */
1367
1368 if (c->log_namespace) {
1369 _cleanup_free_ char *socket_unit = NULL, *varlink_socket_unit = NULL;
1370
1371 r = unit_name_build_from_type("systemd-journald", c->log_namespace, UNIT_SOCKET, &socket_unit);
1372 if (r < 0)
1373 return r;
1374
1375 r = unit_add_two_dependencies_by_name(u, UNIT_AFTER, UNIT_REQUIRES, socket_unit, true, UNIT_DEPENDENCY_FILE);
1376 if (r < 0)
1377 return r;
1378
1379 r = unit_name_build_from_type("systemd-journald-varlink", c->log_namespace, UNIT_SOCKET, &varlink_socket_unit);
1380 if (r < 0)
1381 return r;
1382
1383 r = unit_add_two_dependencies_by_name(u, UNIT_AFTER, UNIT_REQUIRES, varlink_socket_unit, true, UNIT_DEPENDENCY_FILE);
1384 if (r < 0)
1385 return r;
1386 } else {
1387 r = unit_add_dependency_by_name(u, UNIT_AFTER, SPECIAL_JOURNALD_SOCKET, true, UNIT_DEPENDENCY_FILE);
1388 if (r < 0)
1389 return r;
1390 }
1391
1392 r = unit_add_default_credential_dependencies(u, c);
1393 if (r < 0)
1394 return r;
1395
1396 return 0;
1397 }
1398
1399 const char* unit_description(Unit *u) {
1400 assert(u);
1401
1402 if (u->description)
1403 return u->description;
1404
1405 return strna(u->id);
1406 }
1407
1408 const char* unit_status_string(Unit *u, char **ret_combined_buffer) {
1409 assert(u);
1410 assert(u->id);
1411
1412 /* Return u->id, u->description, or "{u->id} - {u->description}".
1413 * Versions with u->description are only used if it is set.
1414 * The last option is used if configured and the caller provided the 'ret_combined_buffer'
1415 * pointer.
1416 *
1417 * Note that *ret_combined_buffer may be set to NULL. */
1418
1419 if (!u->description ||
1420 u->manager->status_unit_format == STATUS_UNIT_FORMAT_NAME ||
1421 (u->manager->status_unit_format == STATUS_UNIT_FORMAT_COMBINED && !ret_combined_buffer) ||
1422 streq(u->description, u->id)) {
1423
1424 if (ret_combined_buffer)
1425 *ret_combined_buffer = NULL;
1426 return u->id;
1427 }
1428
1429 if (ret_combined_buffer) {
1430 if (u->manager->status_unit_format == STATUS_UNIT_FORMAT_COMBINED) {
1431 *ret_combined_buffer = strjoin(u->id, " - ", u->description);
1432 if (*ret_combined_buffer)
1433 return *ret_combined_buffer;
1434 log_oom(); /* Fall back to ->description */
1435 } else
1436 *ret_combined_buffer = NULL;
1437 }
1438
1439 return u->description;
1440 }
1441
1442 /* Common implementation for multiple backends */
1443 int unit_load_fragment_and_dropin(Unit *u, bool fragment_required) {
1444 int r;
1445
1446 assert(u);
1447
1448 /* Load a .{service,socket,...} file */
1449 r = unit_load_fragment(u);
1450 if (r < 0)
1451 return r;
1452
1453 if (u->load_state == UNIT_STUB) {
1454 if (fragment_required)
1455 return -ENOENT;
1456
1457 u->load_state = UNIT_LOADED;
1458 }
1459
1460 /* Load drop-in directory data. If u is an alias, we might be reloading the
1461 * target unit needlessly. But we cannot be sure which drops-ins have already
1462 * been loaded and which not, at least without doing complicated book-keeping,
1463 * so let's always reread all drop-ins. */
1464 r = unit_load_dropin(unit_follow_merge(u));
1465 if (r < 0)
1466 return r;
1467
1468 if (u->source_path) {
1469 struct stat st;
1470
1471 if (stat(u->source_path, &st) >= 0)
1472 u->source_mtime = timespec_load(&st.st_mtim);
1473 else
1474 u->source_mtime = 0;
1475 }
1476
1477 return 0;
1478 }
1479
1480 void unit_add_to_target_deps_queue(Unit *u) {
1481 Manager *m = ASSERT_PTR(ASSERT_PTR(u)->manager);
1482
1483 if (u->in_target_deps_queue)
1484 return;
1485
1486 LIST_PREPEND(target_deps_queue, m->target_deps_queue, u);
1487 u->in_target_deps_queue = true;
1488 }
1489
1490 int unit_add_default_target_dependency(Unit *u, Unit *target) {
1491 assert(u);
1492 assert(target);
1493
1494 if (target->type != UNIT_TARGET)
1495 return 0;
1496
1497 /* Only add the dependency if both units are loaded, so that
1498 * that loop check below is reliable */
1499 if (u->load_state != UNIT_LOADED ||
1500 target->load_state != UNIT_LOADED)
1501 return 0;
1502
1503 /* If either side wants no automatic dependencies, then let's
1504 * skip this */
1505 if (!u->default_dependencies ||
1506 !target->default_dependencies)
1507 return 0;
1508
1509 /* Don't create loops */
1510 if (unit_has_dependency(target, UNIT_ATOM_BEFORE, u))
1511 return 0;
1512
1513 return unit_add_dependency(target, UNIT_AFTER, u, true, UNIT_DEPENDENCY_DEFAULT);
1514 }
1515
1516 static int unit_add_slice_dependencies(Unit *u) {
1517 Unit *slice;
1518 assert(u);
1519
1520 if (!UNIT_HAS_CGROUP_CONTEXT(u))
1521 return 0;
1522
1523 /* Slice units are implicitly ordered against their parent slices (as this relationship is encoded in the
1524 name), while all other units are ordered based on configuration (as in their case Slice= configures the
1525 relationship). */
1526 UnitDependencyMask mask = u->type == UNIT_SLICE ? UNIT_DEPENDENCY_IMPLICIT : UNIT_DEPENDENCY_FILE;
1527
1528 slice = UNIT_GET_SLICE(u);
1529 if (slice)
1530 return unit_add_two_dependencies(u, UNIT_AFTER, UNIT_REQUIRES, slice, true, mask);
1531
1532 if (unit_has_name(u, SPECIAL_ROOT_SLICE))
1533 return 0;
1534
1535 return unit_add_two_dependencies_by_name(u, UNIT_AFTER, UNIT_REQUIRES, SPECIAL_ROOT_SLICE, true, mask);
1536 }
1537
1538 static int unit_add_mount_dependencies(Unit *u) {
1539 UnitDependencyInfo di;
1540 const char *path;
1541 bool changed = false;
1542 int r;
1543
1544 assert(u);
1545
1546 HASHMAP_FOREACH_KEY(di.data, path, u->requires_mounts_for) {
1547 char prefix[strlen(path) + 1];
1548
1549 PATH_FOREACH_PREFIX_MORE(prefix, path) {
1550 _cleanup_free_ char *p = NULL;
1551 Unit *m;
1552
1553 r = unit_name_from_path(prefix, ".mount", &p);
1554 if (r == -EINVAL)
1555 continue; /* If the path cannot be converted to a mount unit name, then it's
1556 * not manageable as a unit by systemd, and hence we don't need a
1557 * dependency on it. Let's thus silently ignore the issue. */
1558 if (r < 0)
1559 return r;
1560
1561 m = manager_get_unit(u->manager, p);
1562 if (!m) {
1563 /* Make sure to load the mount unit if it exists. If so the dependencies on
1564 * this unit will be added later during the loading of the mount unit. */
1565 (void) manager_load_unit_prepare(u->manager, p, NULL, NULL, &m);
1566 continue;
1567 }
1568 if (m == u)
1569 continue;
1570
1571 if (m->load_state != UNIT_LOADED)
1572 continue;
1573
1574 r = unit_add_dependency(u, UNIT_AFTER, m, true, di.origin_mask);
1575 if (r < 0)
1576 return r;
1577 changed = changed || r > 0;
1578
1579 if (m->fragment_path) {
1580 r = unit_add_dependency(u, UNIT_REQUIRES, m, true, di.origin_mask);
1581 if (r < 0)
1582 return r;
1583 changed = changed || r > 0;
1584 }
1585 }
1586 }
1587
1588 return changed;
1589 }
1590
1591 static int unit_add_oomd_dependencies(Unit *u) {
1592 CGroupContext *c;
1593 CGroupMask mask;
1594 int r;
1595
1596 assert(u);
1597
1598 if (!u->default_dependencies)
1599 return 0;
1600
1601 c = unit_get_cgroup_context(u);
1602 if (!c)
1603 return 0;
1604
1605 bool wants_oomd = c->moom_swap == MANAGED_OOM_KILL || c->moom_mem_pressure == MANAGED_OOM_KILL;
1606 if (!wants_oomd)
1607 return 0;
1608
1609 if (!cg_all_unified())
1610 return 0;
1611
1612 r = cg_mask_supported(&mask);
1613 if (r < 0)
1614 return log_debug_errno(r, "Failed to determine supported controllers: %m");
1615
1616 if (!FLAGS_SET(mask, CGROUP_MASK_MEMORY))
1617 return 0;
1618
1619 return unit_add_two_dependencies_by_name(u, UNIT_AFTER, UNIT_WANTS, "systemd-oomd.service", true, UNIT_DEPENDENCY_FILE);
1620 }
1621
1622 static int unit_add_startup_units(Unit *u) {
1623 if (!unit_has_startup_cgroup_constraints(u))
1624 return 0;
1625
1626 return set_ensure_put(&u->manager->startup_units, NULL, u);
1627 }
1628
1629 static int unit_validate_on_failure_job_mode(
1630 Unit *u,
1631 const char *job_mode_setting,
1632 JobMode job_mode,
1633 const char *dependency_name,
1634 UnitDependencyAtom atom) {
1635
1636 Unit *other, *found = NULL;
1637
1638 if (job_mode != JOB_ISOLATE)
1639 return 0;
1640
1641 UNIT_FOREACH_DEPENDENCY(other, u, atom) {
1642 if (!found)
1643 found = other;
1644 else if (found != other)
1645 return log_unit_error_errno(
1646 u, SYNTHETIC_ERRNO(ENOEXEC),
1647 "More than one %s dependencies specified but %sisolate set. Refusing.",
1648 dependency_name, job_mode_setting);
1649 }
1650
1651 return 0;
1652 }
1653
1654 int unit_load(Unit *u) {
1655 int r;
1656
1657 assert(u);
1658
1659 if (u->in_load_queue) {
1660 LIST_REMOVE(load_queue, u->manager->load_queue, u);
1661 u->in_load_queue = false;
1662 }
1663
1664 if (u->type == _UNIT_TYPE_INVALID)
1665 return -EINVAL;
1666
1667 if (u->load_state != UNIT_STUB)
1668 return 0;
1669
1670 if (u->transient_file) {
1671 /* Finalize transient file: if this is a transient unit file, as soon as we reach unit_load() the setup
1672 * is complete, hence let's synchronize the unit file we just wrote to disk. */
1673
1674 r = fflush_and_check(u->transient_file);
1675 if (r < 0)
1676 goto fail;
1677
1678 u->transient_file = safe_fclose(u->transient_file);
1679 u->fragment_mtime = now(CLOCK_REALTIME);
1680 }
1681
1682 r = UNIT_VTABLE(u)->load(u);
1683 if (r < 0)
1684 goto fail;
1685
1686 assert(u->load_state != UNIT_STUB);
1687
1688 if (u->load_state == UNIT_LOADED) {
1689 unit_add_to_target_deps_queue(u);
1690
1691 r = unit_add_slice_dependencies(u);
1692 if (r < 0)
1693 goto fail;
1694
1695 r = unit_add_mount_dependencies(u);
1696 if (r < 0)
1697 goto fail;
1698
1699 r = unit_add_oomd_dependencies(u);
1700 if (r < 0)
1701 goto fail;
1702
1703 r = unit_add_startup_units(u);
1704 if (r < 0)
1705 goto fail;
1706
1707 r = unit_validate_on_failure_job_mode(u, "OnSuccessJobMode=", u->on_success_job_mode, "OnSuccess=", UNIT_ATOM_ON_SUCCESS);
1708 if (r < 0)
1709 goto fail;
1710
1711 r = unit_validate_on_failure_job_mode(u, "OnFailureJobMode=", u->on_failure_job_mode, "OnFailure=", UNIT_ATOM_ON_FAILURE);
1712 if (r < 0)
1713 goto fail;
1714
1715 if (u->job_running_timeout != USEC_INFINITY && u->job_running_timeout > u->job_timeout)
1716 log_unit_warning(u, "JobRunningTimeoutSec= is greater than JobTimeoutSec=, it has no effect.");
1717
1718 /* We finished loading, let's ensure our parents recalculate the members mask */
1719 unit_invalidate_cgroup_members_masks(u);
1720 }
1721
1722 assert((u->load_state != UNIT_MERGED) == !u->merged_into);
1723
1724 unit_add_to_dbus_queue(unit_follow_merge(u));
1725 unit_add_to_gc_queue(u);
1726 (void) manager_varlink_send_managed_oom_update(u);
1727
1728 return 0;
1729
1730 fail:
1731 /* We convert ENOEXEC errors to the UNIT_BAD_SETTING load state here. Configuration parsing code
1732 * should hence return ENOEXEC to ensure units are placed in this state after loading. */
1733
1734 u->load_state = u->load_state == UNIT_STUB ? UNIT_NOT_FOUND :
1735 r == -ENOEXEC ? UNIT_BAD_SETTING :
1736 UNIT_ERROR;
1737 u->load_error = r;
1738
1739 /* Record the timestamp on the cache, so that if the cache gets updated between now and the next time
1740 * an attempt is made to load this unit, we know we need to check again. */
1741 if (u->load_state == UNIT_NOT_FOUND)
1742 u->fragment_not_found_timestamp_hash = u->manager->unit_cache_timestamp_hash;
1743
1744 unit_add_to_dbus_queue(u);
1745 unit_add_to_gc_queue(u);
1746
1747 return log_unit_debug_errno(u, r, "Failed to load configuration: %m");
1748 }
1749
1750 _printf_(7, 8)
1751 static int log_unit_internal(void *userdata, int level, int error, const char *file, int line, const char *func, const char *format, ...) {
1752 Unit *u = userdata;
1753 va_list ap;
1754 int r;
1755
1756 if (u && !unit_log_level_test(u, level))
1757 return -ERRNO_VALUE(error);
1758
1759 va_start(ap, format);
1760 if (u)
1761 r = log_object_internalv(level, error, file, line, func,
1762 u->manager->unit_log_field,
1763 u->id,
1764 u->manager->invocation_log_field,
1765 u->invocation_id_string,
1766 format, ap);
1767 else
1768 r = log_internalv(level, error, file, line, func, format, ap);
1769 va_end(ap);
1770
1771 return r;
1772 }
1773
1774 static bool unit_test_condition(Unit *u) {
1775 _cleanup_strv_free_ char **env = NULL;
1776 int r;
1777
1778 assert(u);
1779
1780 dual_timestamp_get(&u->condition_timestamp);
1781
1782 r = manager_get_effective_environment(u->manager, &env);
1783 if (r < 0) {
1784 log_unit_error_errno(u, r, "Failed to determine effective environment: %m");
1785 u->condition_result = true;
1786 } else
1787 u->condition_result = condition_test_list(
1788 u->conditions,
1789 env,
1790 condition_type_to_string,
1791 log_unit_internal,
1792 u);
1793
1794 unit_add_to_dbus_queue(u);
1795 return u->condition_result;
1796 }
1797
1798 static bool unit_test_assert(Unit *u) {
1799 _cleanup_strv_free_ char **env = NULL;
1800 int r;
1801
1802 assert(u);
1803
1804 dual_timestamp_get(&u->assert_timestamp);
1805
1806 r = manager_get_effective_environment(u->manager, &env);
1807 if (r < 0) {
1808 log_unit_error_errno(u, r, "Failed to determine effective environment: %m");
1809 u->assert_result = CONDITION_ERROR;
1810 } else
1811 u->assert_result = condition_test_list(
1812 u->asserts,
1813 env,
1814 assert_type_to_string,
1815 log_unit_internal,
1816 u);
1817
1818 unit_add_to_dbus_queue(u);
1819 return u->assert_result;
1820 }
1821
1822 void unit_status_printf(Unit *u, StatusType status_type, const char *status, const char *format, const char *ident) {
1823 if (log_get_show_color()) {
1824 if (u->manager->status_unit_format == STATUS_UNIT_FORMAT_COMBINED && strchr(ident, ' '))
1825 ident = strjoina(ANSI_HIGHLIGHT, u->id, ANSI_NORMAL, " - ", u->description);
1826 else
1827 ident = strjoina(ANSI_HIGHLIGHT, ident, ANSI_NORMAL);
1828 }
1829
1830 DISABLE_WARNING_FORMAT_NONLITERAL;
1831 manager_status_printf(u->manager, status_type, status, format, ident);
1832 REENABLE_WARNING;
1833 }
1834
1835 int unit_test_start_limit(Unit *u) {
1836 const char *reason;
1837
1838 assert(u);
1839
1840 if (ratelimit_below(&u->start_ratelimit)) {
1841 u->start_limit_hit = false;
1842 return 0;
1843 }
1844
1845 log_unit_warning(u, "Start request repeated too quickly.");
1846 u->start_limit_hit = true;
1847
1848 reason = strjoina("unit ", u->id, " failed");
1849
1850 emergency_action(u->manager, u->start_limit_action,
1851 EMERGENCY_ACTION_IS_WATCHDOG|EMERGENCY_ACTION_WARN,
1852 u->reboot_arg, -1, reason);
1853
1854 return -ECANCELED;
1855 }
1856
1857 bool unit_shall_confirm_spawn(Unit *u) {
1858 assert(u);
1859
1860 if (manager_is_confirm_spawn_disabled(u->manager))
1861 return false;
1862
1863 /* For some reasons units remaining in the same process group
1864 * as PID 1 fail to acquire the console even if it's not used
1865 * by any process. So skip the confirmation question for them. */
1866 return !unit_get_exec_context(u)->same_pgrp;
1867 }
1868
1869 static bool unit_verify_deps(Unit *u) {
1870 Unit *other;
1871
1872 assert(u);
1873
1874 /* Checks whether all BindsTo= dependencies of this unit are fulfilled — if they are also combined
1875 * with After=. We do not check Requires= or Requisite= here as they only should have an effect on
1876 * the job processing, but do not have any effect afterwards. We don't check BindsTo= dependencies
1877 * that are not used in conjunction with After= as for them any such check would make things entirely
1878 * racy. */
1879
1880 UNIT_FOREACH_DEPENDENCY(other, u, UNIT_ATOM_CANNOT_BE_ACTIVE_WITHOUT) {
1881
1882 if (!unit_has_dependency(u, UNIT_ATOM_AFTER, other))
1883 continue;
1884
1885 if (!UNIT_IS_ACTIVE_OR_RELOADING(unit_active_state(other))) {
1886 log_unit_notice(u, "Bound to unit %s, but unit isn't active.", other->id);
1887 return false;
1888 }
1889 }
1890
1891 return true;
1892 }
1893
1894 /* Errors that aren't really errors:
1895 * -EALREADY: Unit is already started.
1896 * -ECOMM: Condition failed
1897 * -EAGAIN: An operation is already in progress. Retry later.
1898 *
1899 * Errors that are real errors:
1900 * -EBADR: This unit type does not support starting.
1901 * -ECANCELED: Start limit hit, too many requests for now
1902 * -EPROTO: Assert failed
1903 * -EINVAL: Unit not loaded
1904 * -EOPNOTSUPP: Unit type not supported
1905 * -ENOLINK: The necessary dependencies are not fulfilled.
1906 * -ESTALE: This unit has been started before and can't be started a second time
1907 * -ENOENT: This is a triggering unit and unit to trigger is not loaded
1908 */
1909 int unit_start(Unit *u, ActivationDetails *details) {
1910 UnitActiveState state;
1911 Unit *following;
1912 int r;
1913
1914 assert(u);
1915
1916 /* Let's hold off running start jobs for mount units when /proc/self/mountinfo monitor is ratelimited. */
1917 if (UNIT_VTABLE(u)->subsystem_ratelimited) {
1918 r = UNIT_VTABLE(u)->subsystem_ratelimited(u->manager);
1919 if (r < 0)
1920 return r;
1921 if (r > 0)
1922 return -EAGAIN;
1923 }
1924
1925 /* If this is already started, then this will succeed. Note that this will even succeed if this unit
1926 * is not startable by the user. This is relied on to detect when we need to wait for units and when
1927 * waiting is finished. */
1928 state = unit_active_state(u);
1929 if (UNIT_IS_ACTIVE_OR_RELOADING(state))
1930 return -EALREADY;
1931 if (state == UNIT_MAINTENANCE)
1932 return -EAGAIN;
1933
1934 /* Units that aren't loaded cannot be started */
1935 if (u->load_state != UNIT_LOADED)
1936 return -EINVAL;
1937
1938 /* Refuse starting scope units more than once */
1939 if (UNIT_VTABLE(u)->once_only && dual_timestamp_is_set(&u->inactive_enter_timestamp))
1940 return -ESTALE;
1941
1942 /* If the conditions were unmet, don't do anything at all. If we already are activating this call might
1943 * still be useful to speed up activation in case there is some hold-off time, but we don't want to
1944 * recheck the condition in that case. */
1945 if (state != UNIT_ACTIVATING &&
1946 !unit_test_condition(u))
1947 return log_unit_debug_errno(u, SYNTHETIC_ERRNO(ECOMM), "Starting requested but condition not met. Not starting unit.");
1948
1949 /* If the asserts failed, fail the entire job */
1950 if (state != UNIT_ACTIVATING &&
1951 !unit_test_assert(u))
1952 return log_unit_notice_errno(u, SYNTHETIC_ERRNO(EPROTO), "Starting requested but asserts failed.");
1953
1954 /* Units of types that aren't supported cannot be started. Note that we do this test only after the
1955 * condition checks, so that we rather return condition check errors (which are usually not
1956 * considered a true failure) than "not supported" errors (which are considered a failure).
1957 */
1958 if (!unit_type_supported(u->type))
1959 return -EOPNOTSUPP;
1960
1961 /* Let's make sure that the deps really are in order before we start this. Normally the job engine
1962 * should have taken care of this already, but let's check this here again. After all, our
1963 * dependencies might not be in effect anymore, due to a reload or due to an unmet condition. */
1964 if (!unit_verify_deps(u))
1965 return -ENOLINK;
1966
1967 /* Forward to the main object, if we aren't it. */
1968 following = unit_following(u);
1969 if (following) {
1970 log_unit_debug(u, "Redirecting start request from %s to %s.", u->id, following->id);
1971 return unit_start(following, details);
1972 }
1973
1974 /* Check our ability to start early so that failure conditions don't cause us to enter a busy loop. */
1975 if (UNIT_VTABLE(u)->can_start) {
1976 r = UNIT_VTABLE(u)->can_start(u);
1977 if (r < 0)
1978 return r;
1979 }
1980
1981 /* If it is stopped, but we cannot start it, then fail */
1982 if (!UNIT_VTABLE(u)->start)
1983 return -EBADR;
1984
1985 /* We don't suppress calls to ->start() here when we are already starting, to allow this request to
1986 * be used as a "hurry up" call, for example when the unit is in some "auto restart" state where it
1987 * waits for a holdoff timer to elapse before it will start again. */
1988
1989 unit_add_to_dbus_queue(u);
1990 unit_cgroup_freezer_action(u, FREEZER_THAW);
1991
1992 if (!u->activation_details) /* Older details object wins */
1993 u->activation_details = activation_details_ref(details);
1994
1995 return UNIT_VTABLE(u)->start(u);
1996 }
1997
1998 bool unit_can_start(Unit *u) {
1999 assert(u);
2000
2001 if (u->load_state != UNIT_LOADED)
2002 return false;
2003
2004 if (!unit_type_supported(u->type))
2005 return false;
2006
2007 /* Scope units may be started only once */
2008 if (UNIT_VTABLE(u)->once_only && dual_timestamp_is_set(&u->inactive_exit_timestamp))
2009 return false;
2010
2011 return !!UNIT_VTABLE(u)->start;
2012 }
2013
2014 bool unit_can_isolate(Unit *u) {
2015 assert(u);
2016
2017 return unit_can_start(u) &&
2018 u->allow_isolate;
2019 }
2020
2021 /* Errors:
2022 * -EBADR: This unit type does not support stopping.
2023 * -EALREADY: Unit is already stopped.
2024 * -EAGAIN: An operation is already in progress. Retry later.
2025 */
2026 int unit_stop(Unit *u) {
2027 UnitActiveState state;
2028 Unit *following;
2029
2030 assert(u);
2031
2032 state = unit_active_state(u);
2033 if (UNIT_IS_INACTIVE_OR_FAILED(state))
2034 return -EALREADY;
2035
2036 following = unit_following(u);
2037 if (following) {
2038 log_unit_debug(u, "Redirecting stop request from %s to %s.", u->id, following->id);
2039 return unit_stop(following);
2040 }
2041
2042 if (!UNIT_VTABLE(u)->stop)
2043 return -EBADR;
2044
2045 unit_add_to_dbus_queue(u);
2046 unit_cgroup_freezer_action(u, FREEZER_THAW);
2047
2048 return UNIT_VTABLE(u)->stop(u);
2049 }
2050
2051 bool unit_can_stop(Unit *u) {
2052 assert(u);
2053
2054 /* Note: if we return true here, it does not mean that the unit may be successfully stopped.
2055 * Extrinsic units follow external state and they may stop following external state changes
2056 * (hence we return true here), but an attempt to do this through the manager will fail. */
2057
2058 if (!unit_type_supported(u->type))
2059 return false;
2060
2061 if (u->perpetual)
2062 return false;
2063
2064 return !!UNIT_VTABLE(u)->stop;
2065 }
2066
2067 /* Errors:
2068 * -EBADR: This unit type does not support reloading.
2069 * -ENOEXEC: Unit is not started.
2070 * -EAGAIN: An operation is already in progress. Retry later.
2071 */
2072 int unit_reload(Unit *u) {
2073 UnitActiveState state;
2074 Unit *following;
2075
2076 assert(u);
2077
2078 if (u->load_state != UNIT_LOADED)
2079 return -EINVAL;
2080
2081 if (!unit_can_reload(u))
2082 return -EBADR;
2083
2084 state = unit_active_state(u);
2085 if (state == UNIT_RELOADING)
2086 return -EAGAIN;
2087
2088 if (state != UNIT_ACTIVE)
2089 return log_unit_warning_errno(u, SYNTHETIC_ERRNO(ENOEXEC), "Unit cannot be reloaded because it is inactive.");
2090
2091 following = unit_following(u);
2092 if (following) {
2093 log_unit_debug(u, "Redirecting reload request from %s to %s.", u->id, following->id);
2094 return unit_reload(following);
2095 }
2096
2097 unit_add_to_dbus_queue(u);
2098
2099 if (!UNIT_VTABLE(u)->reload) {
2100 /* Unit doesn't have a reload function, but we need to propagate the reload anyway */
2101 unit_notify(u, unit_active_state(u), unit_active_state(u), /* reload_success = */ true);
2102 return 0;
2103 }
2104
2105 unit_cgroup_freezer_action(u, FREEZER_THAW);
2106
2107 return UNIT_VTABLE(u)->reload(u);
2108 }
2109
2110 bool unit_can_reload(Unit *u) {
2111 assert(u);
2112
2113 if (UNIT_VTABLE(u)->can_reload)
2114 return UNIT_VTABLE(u)->can_reload(u);
2115
2116 if (unit_has_dependency(u, UNIT_ATOM_PROPAGATES_RELOAD_TO, NULL))
2117 return true;
2118
2119 return UNIT_VTABLE(u)->reload;
2120 }
2121
2122 bool unit_is_unneeded(Unit *u) {
2123 Unit *other;
2124 assert(u);
2125
2126 if (!u->stop_when_unneeded)
2127 return false;
2128
2129 /* Don't clean up while the unit is transitioning or is even inactive. */
2130 if (unit_active_state(u) != UNIT_ACTIVE)
2131 return false;
2132 if (u->job)
2133 return false;
2134
2135 UNIT_FOREACH_DEPENDENCY(other, u, UNIT_ATOM_PINS_STOP_WHEN_UNNEEDED) {
2136 /* If a dependent unit has a job queued, is active or transitioning, or is marked for
2137 * restart, then don't clean this one up. */
2138
2139 if (other->job)
2140 return false;
2141
2142 if (!UNIT_IS_INACTIVE_OR_FAILED(unit_active_state(other)))
2143 return false;
2144
2145 if (unit_will_restart(other))
2146 return false;
2147 }
2148
2149 return true;
2150 }
2151
2152 bool unit_is_upheld_by_active(Unit *u, Unit **ret_culprit) {
2153 Unit *other;
2154
2155 assert(u);
2156
2157 /* Checks if the unit needs to be started because it currently is not running, but some other unit
2158 * that is active declared an Uphold= dependencies on it */
2159
2160 if (!UNIT_IS_INACTIVE_OR_FAILED(unit_active_state(u)) || u->job) {
2161 if (ret_culprit)
2162 *ret_culprit = NULL;
2163 return false;
2164 }
2165
2166 UNIT_FOREACH_DEPENDENCY(other, u, UNIT_ATOM_START_STEADILY) {
2167 if (other->job)
2168 continue;
2169
2170 if (UNIT_IS_ACTIVE_OR_RELOADING(unit_active_state(other))) {
2171 if (ret_culprit)
2172 *ret_culprit = other;
2173 return true;
2174 }
2175 }
2176
2177 if (ret_culprit)
2178 *ret_culprit = NULL;
2179 return false;
2180 }
2181
2182 bool unit_is_bound_by_inactive(Unit *u, Unit **ret_culprit) {
2183 Unit *other;
2184
2185 assert(u);
2186
2187 /* Checks whether this unit is bound to another unit that is inactive, i.e. whether we should stop
2188 * because the other unit is down. */
2189
2190 if (unit_active_state(u) != UNIT_ACTIVE || u->job) {
2191 /* Don't clean up while the unit is transitioning or is even inactive. */
2192 if (ret_culprit)
2193 *ret_culprit = NULL;
2194 return false;
2195 }
2196
2197 UNIT_FOREACH_DEPENDENCY(other, u, UNIT_ATOM_CANNOT_BE_ACTIVE_WITHOUT) {
2198 if (other->job)
2199 continue;
2200
2201 if (UNIT_IS_INACTIVE_OR_FAILED(unit_active_state(other))) {
2202 if (ret_culprit)
2203 *ret_culprit = other;
2204
2205 return true;
2206 }
2207 }
2208
2209 if (ret_culprit)
2210 *ret_culprit = NULL;
2211 return false;
2212 }
2213
2214 static void check_unneeded_dependencies(Unit *u) {
2215 Unit *other;
2216 assert(u);
2217
2218 /* Add all units this unit depends on to the queue that processes StopWhenUnneeded= behaviour. */
2219
2220 UNIT_FOREACH_DEPENDENCY(other, u, UNIT_ATOM_ADD_STOP_WHEN_UNNEEDED_QUEUE)
2221 unit_submit_to_stop_when_unneeded_queue(other);
2222 }
2223
2224 static void check_uphold_dependencies(Unit *u) {
2225 Unit *other;
2226 assert(u);
2227
2228 /* Add all units this unit depends on to the queue that processes Uphold= behaviour. */
2229
2230 UNIT_FOREACH_DEPENDENCY(other, u, UNIT_ATOM_ADD_START_WHEN_UPHELD_QUEUE)
2231 unit_submit_to_start_when_upheld_queue(other);
2232 }
2233
2234 static void check_bound_by_dependencies(Unit *u) {
2235 Unit *other;
2236 assert(u);
2237
2238 /* Add all units this unit depends on to the queue that processes BindsTo= stop behaviour. */
2239
2240 UNIT_FOREACH_DEPENDENCY(other, u, UNIT_ATOM_ADD_CANNOT_BE_ACTIVE_WITHOUT_QUEUE)
2241 unit_submit_to_stop_when_bound_queue(other);
2242 }
2243
2244 static void retroactively_start_dependencies(Unit *u) {
2245 Unit *other;
2246
2247 assert(u);
2248 assert(UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(u)));
2249
2250 UNIT_FOREACH_DEPENDENCY(other, u, UNIT_ATOM_RETROACTIVE_START_REPLACE) /* Requires= + BindsTo= */
2251 if (!unit_has_dependency(u, UNIT_ATOM_AFTER, other) &&
2252 !UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(other)))
2253 manager_add_job(u->manager, JOB_START, other, JOB_REPLACE, NULL, NULL, NULL);
2254
2255 UNIT_FOREACH_DEPENDENCY(other, u, UNIT_ATOM_RETROACTIVE_START_FAIL) /* Wants= */
2256 if (!unit_has_dependency(u, UNIT_ATOM_AFTER, other) &&
2257 !UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(other)))
2258 manager_add_job(u->manager, JOB_START, other, JOB_FAIL, NULL, NULL, NULL);
2259
2260 UNIT_FOREACH_DEPENDENCY(other, u, UNIT_ATOM_RETROACTIVE_STOP_ON_START) /* Conflicts= (and inverse) */
2261 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
2262 manager_add_job(u->manager, JOB_STOP, other, JOB_REPLACE, NULL, NULL, NULL);
2263 }
2264
2265 static void retroactively_stop_dependencies(Unit *u) {
2266 Unit *other;
2267
2268 assert(u);
2269 assert(UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(u)));
2270
2271 /* Pull down units which are bound to us recursively if enabled */
2272 UNIT_FOREACH_DEPENDENCY(other, u, UNIT_ATOM_RETROACTIVE_STOP_ON_STOP) /* BoundBy= */
2273 if (!UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(other)))
2274 manager_add_job(u->manager, JOB_STOP, other, JOB_REPLACE, NULL, NULL, NULL);
2275 }
2276
2277 void unit_start_on_failure(
2278 Unit *u,
2279 const char *dependency_name,
2280 UnitDependencyAtom atom,
2281 JobMode job_mode) {
2282
2283 int n_jobs = -1;
2284 Unit *other;
2285 int r;
2286
2287 assert(u);
2288 assert(dependency_name);
2289 assert(IN_SET(atom, UNIT_ATOM_ON_SUCCESS, UNIT_ATOM_ON_FAILURE));
2290
2291 /* Act on OnFailure= and OnSuccess= dependencies */
2292
2293 UNIT_FOREACH_DEPENDENCY(other, u, atom) {
2294 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
2295
2296 if (n_jobs < 0) {
2297 log_unit_info(u, "Triggering %s dependencies.", dependency_name);
2298 n_jobs = 0;
2299 }
2300
2301 r = manager_add_job(u->manager, JOB_START, other, job_mode, NULL, &error, NULL);
2302 if (r < 0)
2303 log_unit_warning_errno(
2304 u, r, "Failed to enqueue %s job, ignoring: %s",
2305 dependency_name, bus_error_message(&error, r));
2306 n_jobs ++;
2307 }
2308
2309 if (n_jobs >= 0)
2310 log_unit_debug(u, "Triggering %s dependencies done (%i %s).",
2311 dependency_name, n_jobs, n_jobs == 1 ? "job" : "jobs");
2312 }
2313
2314 void unit_trigger_notify(Unit *u) {
2315 Unit *other;
2316
2317 assert(u);
2318
2319 UNIT_FOREACH_DEPENDENCY(other, u, UNIT_ATOM_TRIGGERED_BY)
2320 if (UNIT_VTABLE(other)->trigger_notify)
2321 UNIT_VTABLE(other)->trigger_notify(other, u);
2322 }
2323
2324 static int raise_level(int log_level, bool condition_info, bool condition_notice) {
2325 if (condition_notice && log_level > LOG_NOTICE)
2326 return LOG_NOTICE;
2327 if (condition_info && log_level > LOG_INFO)
2328 return LOG_INFO;
2329 return log_level;
2330 }
2331
2332 static int unit_log_resources(Unit *u) {
2333 struct iovec iovec[1 + _CGROUP_IP_ACCOUNTING_METRIC_MAX + _CGROUP_IO_ACCOUNTING_METRIC_MAX + 4];
2334 bool any_traffic = false, have_ip_accounting = false, any_io = false, have_io_accounting = false;
2335 _cleanup_free_ char *igress = NULL, *egress = NULL, *rr = NULL, *wr = NULL;
2336 int log_level = LOG_DEBUG; /* May be raised if resources consumed over a threshold */
2337 size_t n_message_parts = 0, n_iovec = 0;
2338 char* message_parts[1 + 2 + 2 + 1], *t;
2339 nsec_t nsec = NSEC_INFINITY;
2340 int r;
2341 const char* const ip_fields[_CGROUP_IP_ACCOUNTING_METRIC_MAX] = {
2342 [CGROUP_IP_INGRESS_BYTES] = "IP_METRIC_INGRESS_BYTES",
2343 [CGROUP_IP_INGRESS_PACKETS] = "IP_METRIC_INGRESS_PACKETS",
2344 [CGROUP_IP_EGRESS_BYTES] = "IP_METRIC_EGRESS_BYTES",
2345 [CGROUP_IP_EGRESS_PACKETS] = "IP_METRIC_EGRESS_PACKETS",
2346 };
2347 const char* const io_fields[_CGROUP_IO_ACCOUNTING_METRIC_MAX] = {
2348 [CGROUP_IO_READ_BYTES] = "IO_METRIC_READ_BYTES",
2349 [CGROUP_IO_WRITE_BYTES] = "IO_METRIC_WRITE_BYTES",
2350 [CGROUP_IO_READ_OPERATIONS] = "IO_METRIC_READ_OPERATIONS",
2351 [CGROUP_IO_WRITE_OPERATIONS] = "IO_METRIC_WRITE_OPERATIONS",
2352 };
2353
2354 assert(u);
2355
2356 /* Invoked whenever a unit enters failed or dead state. Logs information about consumed resources if resource
2357 * accounting was enabled for a unit. It does this in two ways: a friendly human readable string with reduced
2358 * information and the complete data in structured fields. */
2359
2360 (void) unit_get_cpu_usage(u, &nsec);
2361 if (nsec != NSEC_INFINITY) {
2362 /* Format the CPU time for inclusion in the structured log message */
2363 if (asprintf(&t, "CPU_USAGE_NSEC=%" PRIu64, nsec) < 0) {
2364 r = log_oom();
2365 goto finish;
2366 }
2367 iovec[n_iovec++] = IOVEC_MAKE_STRING(t);
2368
2369 /* Format the CPU time for inclusion in the human language message string */
2370 t = strjoin("consumed ", FORMAT_TIMESPAN(nsec / NSEC_PER_USEC, USEC_PER_MSEC), " CPU time");
2371 if (!t) {
2372 r = log_oom();
2373 goto finish;
2374 }
2375
2376 message_parts[n_message_parts++] = t;
2377
2378 log_level = raise_level(log_level,
2379 nsec > MENTIONWORTHY_CPU_NSEC,
2380 nsec > NOTICEWORTHY_CPU_NSEC);
2381 }
2382
2383 for (CGroupIOAccountingMetric k = 0; k < _CGROUP_IO_ACCOUNTING_METRIC_MAX; k++) {
2384 uint64_t value = UINT64_MAX;
2385
2386 assert(io_fields[k]);
2387
2388 (void) unit_get_io_accounting(u, k, k > 0, &value);
2389 if (value == UINT64_MAX)
2390 continue;
2391
2392 have_io_accounting = true;
2393 if (value > 0)
2394 any_io = true;
2395
2396 /* Format IO accounting data for inclusion in the structured log message */
2397 if (asprintf(&t, "%s=%" PRIu64, io_fields[k], value) < 0) {
2398 r = log_oom();
2399 goto finish;
2400 }
2401 iovec[n_iovec++] = IOVEC_MAKE_STRING(t);
2402
2403 /* Format the IO accounting data for inclusion in the human language message string, but only
2404 * for the bytes counters (and not for the operations counters) */
2405 if (k == CGROUP_IO_READ_BYTES) {
2406 assert(!rr);
2407 rr = strjoin("read ", strna(FORMAT_BYTES(value)), " from disk");
2408 if (!rr) {
2409 r = log_oom();
2410 goto finish;
2411 }
2412 } else if (k == CGROUP_IO_WRITE_BYTES) {
2413 assert(!wr);
2414 wr = strjoin("written ", strna(FORMAT_BYTES(value)), " to disk");
2415 if (!wr) {
2416 r = log_oom();
2417 goto finish;
2418 }
2419 }
2420
2421 if (IN_SET(k, CGROUP_IO_READ_BYTES, CGROUP_IO_WRITE_BYTES))
2422 log_level = raise_level(log_level,
2423 value > MENTIONWORTHY_IO_BYTES,
2424 value > NOTICEWORTHY_IO_BYTES);
2425 }
2426
2427 if (have_io_accounting) {
2428 if (any_io) {
2429 if (rr)
2430 message_parts[n_message_parts++] = TAKE_PTR(rr);
2431 if (wr)
2432 message_parts[n_message_parts++] = TAKE_PTR(wr);
2433
2434 } else {
2435 char *k;
2436
2437 k = strdup("no IO");
2438 if (!k) {
2439 r = log_oom();
2440 goto finish;
2441 }
2442
2443 message_parts[n_message_parts++] = k;
2444 }
2445 }
2446
2447 for (CGroupIPAccountingMetric m = 0; m < _CGROUP_IP_ACCOUNTING_METRIC_MAX; m++) {
2448 uint64_t value = UINT64_MAX;
2449
2450 assert(ip_fields[m]);
2451
2452 (void) unit_get_ip_accounting(u, m, &value);
2453 if (value == UINT64_MAX)
2454 continue;
2455
2456 have_ip_accounting = true;
2457 if (value > 0)
2458 any_traffic = true;
2459
2460 /* Format IP accounting data for inclusion in the structured log message */
2461 if (asprintf(&t, "%s=%" PRIu64, ip_fields[m], value) < 0) {
2462 r = log_oom();
2463 goto finish;
2464 }
2465 iovec[n_iovec++] = IOVEC_MAKE_STRING(t);
2466
2467 /* Format the IP accounting data for inclusion in the human language message string, but only for the
2468 * bytes counters (and not for the packets counters) */
2469 if (m == CGROUP_IP_INGRESS_BYTES) {
2470 assert(!igress);
2471 igress = strjoin("received ", strna(FORMAT_BYTES(value)), " IP traffic");
2472 if (!igress) {
2473 r = log_oom();
2474 goto finish;
2475 }
2476 } else if (m == CGROUP_IP_EGRESS_BYTES) {
2477 assert(!egress);
2478 egress = strjoin("sent ", strna(FORMAT_BYTES(value)), " IP traffic");
2479 if (!egress) {
2480 r = log_oom();
2481 goto finish;
2482 }
2483 }
2484
2485 if (IN_SET(m, CGROUP_IP_INGRESS_BYTES, CGROUP_IP_EGRESS_BYTES))
2486 log_level = raise_level(log_level,
2487 value > MENTIONWORTHY_IP_BYTES,
2488 value > NOTICEWORTHY_IP_BYTES);
2489 }
2490
2491 /* This check is here because it is the earliest point following all possible log_level assignments. If
2492 * log_level is assigned anywhere after this point, move this check. */
2493 if (!unit_log_level_test(u, log_level)) {
2494 r = 0;
2495 goto finish;
2496 }
2497
2498 if (have_ip_accounting) {
2499 if (any_traffic) {
2500 if (igress)
2501 message_parts[n_message_parts++] = TAKE_PTR(igress);
2502 if (egress)
2503 message_parts[n_message_parts++] = TAKE_PTR(egress);
2504
2505 } else {
2506 char *k;
2507
2508 k = strdup("no IP traffic");
2509 if (!k) {
2510 r = log_oom();
2511 goto finish;
2512 }
2513
2514 message_parts[n_message_parts++] = k;
2515 }
2516 }
2517
2518 /* Is there any accounting data available at all? */
2519 if (n_iovec == 0) {
2520 r = 0;
2521 goto finish;
2522 }
2523
2524 if (n_message_parts == 0)
2525 t = strjoina("MESSAGE=", u->id, ": Completed.");
2526 else {
2527 _cleanup_free_ char *joined = NULL;
2528
2529 message_parts[n_message_parts] = NULL;
2530
2531 joined = strv_join(message_parts, ", ");
2532 if (!joined) {
2533 r = log_oom();
2534 goto finish;
2535 }
2536
2537 joined[0] = ascii_toupper(joined[0]);
2538 t = strjoina("MESSAGE=", u->id, ": ", joined, ".");
2539 }
2540
2541 /* The following four fields we allocate on the stack or are static strings, we hence don't want to free them,
2542 * and hence don't increase n_iovec for them */
2543 iovec[n_iovec] = IOVEC_MAKE_STRING(t);
2544 iovec[n_iovec + 1] = IOVEC_MAKE_STRING("MESSAGE_ID=" SD_MESSAGE_UNIT_RESOURCES_STR);
2545
2546 t = strjoina(u->manager->unit_log_field, u->id);
2547 iovec[n_iovec + 2] = IOVEC_MAKE_STRING(t);
2548
2549 t = strjoina(u->manager->invocation_log_field, u->invocation_id_string);
2550 iovec[n_iovec + 3] = IOVEC_MAKE_STRING(t);
2551
2552 log_unit_struct_iovec(u, log_level, iovec, n_iovec + 4);
2553 r = 0;
2554
2555 finish:
2556 free_many_charp(message_parts, n_message_parts);
2557
2558 for (size_t i = 0; i < n_iovec; i++)
2559 free(iovec[i].iov_base);
2560
2561 return r;
2562
2563 }
2564
2565 static void unit_update_on_console(Unit *u) {
2566 bool b;
2567
2568 assert(u);
2569
2570 b = unit_needs_console(u);
2571 if (u->on_console == b)
2572 return;
2573
2574 u->on_console = b;
2575 if (b)
2576 manager_ref_console(u->manager);
2577 else
2578 manager_unref_console(u->manager);
2579 }
2580
2581 static void unit_emit_audit_start(Unit *u) {
2582 assert(u);
2583
2584 if (UNIT_VTABLE(u)->audit_start_message_type <= 0)
2585 return;
2586
2587 /* Write audit record if we have just finished starting up */
2588 manager_send_unit_audit(u->manager, u, UNIT_VTABLE(u)->audit_start_message_type, /* success= */ true);
2589 u->in_audit = true;
2590 }
2591
2592 static void unit_emit_audit_stop(Unit *u, UnitActiveState state) {
2593 assert(u);
2594
2595 if (UNIT_VTABLE(u)->audit_start_message_type <= 0)
2596 return;
2597
2598 if (u->in_audit) {
2599 /* Write audit record if we have just finished shutting down */
2600 manager_send_unit_audit(u->manager, u, UNIT_VTABLE(u)->audit_stop_message_type, /* success= */ state == UNIT_INACTIVE);
2601 u->in_audit = false;
2602 } else {
2603 /* Hmm, if there was no start record written write it now, so that we always have a nice pair */
2604 manager_send_unit_audit(u->manager, u, UNIT_VTABLE(u)->audit_start_message_type, /* success= */ state == UNIT_INACTIVE);
2605
2606 if (state == UNIT_INACTIVE)
2607 manager_send_unit_audit(u->manager, u, UNIT_VTABLE(u)->audit_stop_message_type, /* success= */ true);
2608 }
2609 }
2610
2611 static bool unit_process_job(Job *j, UnitActiveState ns, bool reload_success) {
2612 bool unexpected = false;
2613 JobResult result;
2614
2615 assert(j);
2616
2617 if (j->state == JOB_WAITING)
2618 /* So we reached a different state for this job. Let's see if we can run it now if it failed previously
2619 * due to EAGAIN. */
2620 job_add_to_run_queue(j);
2621
2622 /* Let's check whether the unit's new state constitutes a finished job, or maybe contradicts a running job and
2623 * hence needs to invalidate jobs. */
2624
2625 switch (j->type) {
2626
2627 case JOB_START:
2628 case JOB_VERIFY_ACTIVE:
2629
2630 if (UNIT_IS_ACTIVE_OR_RELOADING(ns))
2631 job_finish_and_invalidate(j, JOB_DONE, true, false);
2632 else if (j->state == JOB_RUNNING && ns != UNIT_ACTIVATING) {
2633 unexpected = true;
2634
2635 if (UNIT_IS_INACTIVE_OR_FAILED(ns)) {
2636 if (ns == UNIT_FAILED)
2637 result = JOB_FAILED;
2638 else
2639 result = JOB_DONE;
2640
2641 job_finish_and_invalidate(j, result, true, false);
2642 }
2643 }
2644
2645 break;
2646
2647 case JOB_RELOAD:
2648 case JOB_RELOAD_OR_START:
2649 case JOB_TRY_RELOAD:
2650
2651 if (j->state == JOB_RUNNING) {
2652 if (ns == UNIT_ACTIVE)
2653 job_finish_and_invalidate(j, reload_success ? JOB_DONE : JOB_FAILED, true, false);
2654 else if (!IN_SET(ns, UNIT_ACTIVATING, UNIT_RELOADING)) {
2655 unexpected = true;
2656
2657 if (UNIT_IS_INACTIVE_OR_FAILED(ns))
2658 job_finish_and_invalidate(j, ns == UNIT_FAILED ? JOB_FAILED : JOB_DONE, true, false);
2659 }
2660 }
2661
2662 break;
2663
2664 case JOB_STOP:
2665 case JOB_RESTART:
2666 case JOB_TRY_RESTART:
2667
2668 if (UNIT_IS_INACTIVE_OR_FAILED(ns))
2669 job_finish_and_invalidate(j, JOB_DONE, true, false);
2670 else if (j->state == JOB_RUNNING && ns != UNIT_DEACTIVATING) {
2671 unexpected = true;
2672 job_finish_and_invalidate(j, JOB_FAILED, true, false);
2673 }
2674
2675 break;
2676
2677 default:
2678 assert_not_reached();
2679 }
2680
2681 return unexpected;
2682 }
2683
2684 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success) {
2685 const char *reason;
2686 Manager *m;
2687
2688 assert(u);
2689 assert(os < _UNIT_ACTIVE_STATE_MAX);
2690 assert(ns < _UNIT_ACTIVE_STATE_MAX);
2691
2692 /* Note that this is called for all low-level state changes, even if they might map to the same high-level
2693 * UnitActiveState! That means that ns == os is an expected behavior here. For example: if a mount point is
2694 * remounted this function will be called too! */
2695
2696 m = u->manager;
2697
2698 /* Let's enqueue the change signal early. In case this unit has a job associated we want that this unit is in
2699 * the bus queue, so that any job change signal queued will force out the unit change signal first. */
2700 unit_add_to_dbus_queue(u);
2701
2702 /* Update systemd-oomd on the property/state change */
2703 if (os != ns) {
2704 /* Always send an update if the unit is going into an inactive state so systemd-oomd knows to stop
2705 * monitoring.
2706 * Also send an update whenever the unit goes active; this is to handle a case where an override file
2707 * sets one of the ManagedOOM*= properties to "kill", then later removes it. systemd-oomd needs to
2708 * know to stop monitoring when the unit changes from "kill" -> "auto" on daemon-reload, but we don't
2709 * have the information on the property. Thus, indiscriminately send an update. */
2710 if (UNIT_IS_INACTIVE_OR_FAILED(ns) || UNIT_IS_ACTIVE_OR_RELOADING(ns))
2711 (void) manager_varlink_send_managed_oom_update(u);
2712 }
2713
2714 /* Update timestamps for state changes */
2715 if (!MANAGER_IS_RELOADING(m)) {
2716 dual_timestamp_get(&u->state_change_timestamp);
2717
2718 if (UNIT_IS_INACTIVE_OR_FAILED(os) && !UNIT_IS_INACTIVE_OR_FAILED(ns))
2719 u->inactive_exit_timestamp = u->state_change_timestamp;
2720 else if (!UNIT_IS_INACTIVE_OR_FAILED(os) && UNIT_IS_INACTIVE_OR_FAILED(ns))
2721 u->inactive_enter_timestamp = u->state_change_timestamp;
2722
2723 if (!UNIT_IS_ACTIVE_OR_RELOADING(os) && UNIT_IS_ACTIVE_OR_RELOADING(ns))
2724 u->active_enter_timestamp = u->state_change_timestamp;
2725 else if (UNIT_IS_ACTIVE_OR_RELOADING(os) && !UNIT_IS_ACTIVE_OR_RELOADING(ns))
2726 u->active_exit_timestamp = u->state_change_timestamp;
2727 }
2728
2729 /* Keep track of failed units */
2730 (void) manager_update_failed_units(m, u, ns == UNIT_FAILED);
2731
2732 /* Make sure the cgroup and state files are always removed when we become inactive */
2733 if (UNIT_IS_INACTIVE_OR_FAILED(ns)) {
2734 SET_FLAG(u->markers,
2735 (1u << UNIT_MARKER_NEEDS_RELOAD)|(1u << UNIT_MARKER_NEEDS_RESTART),
2736 false);
2737 unit_prune_cgroup(u);
2738 unit_unlink_state_files(u);
2739 } else if (ns != os && ns == UNIT_RELOADING)
2740 SET_FLAG(u->markers, 1u << UNIT_MARKER_NEEDS_RELOAD, false);
2741
2742 unit_update_on_console(u);
2743
2744 if (!MANAGER_IS_RELOADING(m)) {
2745 bool unexpected;
2746
2747 /* Let's propagate state changes to the job */
2748 if (u->job)
2749 unexpected = unit_process_job(u->job, ns, reload_success);
2750 else
2751 unexpected = true;
2752
2753 /* If this state change happened without being requested by a job, then let's retroactively start or
2754 * stop dependencies. We skip that step when deserializing, since we don't want to create any
2755 * additional jobs just because something is already activated. */
2756
2757 if (unexpected) {
2758 if (UNIT_IS_INACTIVE_OR_FAILED(os) && UNIT_IS_ACTIVE_OR_ACTIVATING(ns))
2759 retroactively_start_dependencies(u);
2760 else if (UNIT_IS_ACTIVE_OR_ACTIVATING(os) && UNIT_IS_INACTIVE_OR_DEACTIVATING(ns))
2761 retroactively_stop_dependencies(u);
2762 }
2763
2764 if (ns != os && ns == UNIT_FAILED) {
2765 log_unit_debug(u, "Unit entered failed state.");
2766 unit_start_on_failure(u, "OnFailure=", UNIT_ATOM_ON_FAILURE, u->on_failure_job_mode);
2767 }
2768
2769 if (UNIT_IS_ACTIVE_OR_RELOADING(ns) && !UNIT_IS_ACTIVE_OR_RELOADING(os)) {
2770 /* This unit just finished starting up */
2771
2772 unit_emit_audit_start(u);
2773 manager_send_unit_plymouth(m, u);
2774 }
2775
2776 if (UNIT_IS_INACTIVE_OR_FAILED(ns) && !UNIT_IS_INACTIVE_OR_FAILED(os)) {
2777 /* This unit just stopped/failed. */
2778
2779 unit_emit_audit_stop(u, ns);
2780 unit_log_resources(u);
2781 }
2782
2783 if (ns == UNIT_INACTIVE && !IN_SET(os, UNIT_FAILED, UNIT_INACTIVE, UNIT_MAINTENANCE))
2784 unit_start_on_failure(u, "OnSuccess=", UNIT_ATOM_ON_SUCCESS, u->on_success_job_mode);
2785 }
2786
2787 manager_recheck_journal(m);
2788 manager_recheck_dbus(m);
2789
2790 unit_trigger_notify(u);
2791
2792 if (!MANAGER_IS_RELOADING(m)) {
2793 if (os != UNIT_FAILED && ns == UNIT_FAILED) {
2794 reason = strjoina("unit ", u->id, " failed");
2795 emergency_action(m, u->failure_action, 0, u->reboot_arg, unit_failure_action_exit_status(u), reason);
2796 } else if (!UNIT_IS_INACTIVE_OR_FAILED(os) && ns == UNIT_INACTIVE) {
2797 reason = strjoina("unit ", u->id, " succeeded");
2798 emergency_action(m, u->success_action, 0, u->reboot_arg, unit_success_action_exit_status(u), reason);
2799 }
2800 }
2801
2802 /* And now, add the unit or depending units to various queues that will act on the new situation if
2803 * needed. These queues generally check for continuous state changes rather than events (like most of
2804 * the state propagation above), and do work deferred instead of instantly, since they typically
2805 * don't want to run during reloading, and usually involve checking combined state of multiple units
2806 * at once. */
2807
2808 if (UNIT_IS_INACTIVE_OR_FAILED(ns)) {
2809 /* Stop unneeded units and bound-by units regardless if going down was expected or not */
2810 check_unneeded_dependencies(u);
2811 check_bound_by_dependencies(u);
2812
2813 /* Maybe someone wants us to remain up? */
2814 unit_submit_to_start_when_upheld_queue(u);
2815
2816 /* Maybe the unit should be GC'ed now? */
2817 unit_add_to_gc_queue(u);
2818
2819 /* Maybe we can release some resources now? */
2820 unit_submit_to_release_resources_queue(u);
2821 }
2822
2823 if (UNIT_IS_ACTIVE_OR_RELOADING(ns)) {
2824 /* Start uphold units regardless if going up was expected or not */
2825 check_uphold_dependencies(u);
2826
2827 /* Maybe we finished startup and are now ready for being stopped because unneeded? */
2828 unit_submit_to_stop_when_unneeded_queue(u);
2829
2830 /* Maybe we finished startup, but something we needed has vanished? Let's die then. (This happens
2831 * when something BindsTo= to a Type=oneshot unit, as these units go directly from starting to
2832 * inactive, without ever entering started.) */
2833 unit_submit_to_stop_when_bound_queue(u);
2834 }
2835 }
2836
2837 int unit_watch_pidref(Unit *u, PidRef *pid, bool exclusive) {
2838 _cleanup_(pidref_freep) PidRef *pid_dup = NULL;
2839 int r;
2840
2841 /* Adds a specific PID to the set of PIDs this unit watches. */
2842
2843 assert(u);
2844 assert(pidref_is_set(pid));
2845
2846 /* Caller might be sure that this PID belongs to this unit only. Let's take this
2847 * opportunity to remove any stalled references to this PID as they can be created
2848 * easily (when watching a process which is not our direct child). */
2849 if (exclusive)
2850 manager_unwatch_pidref(u->manager, pid);
2851
2852 if (set_contains(u->pids, pid)) /* early exit if already being watched */
2853 return 0;
2854
2855 r = pidref_dup(pid, &pid_dup);
2856 if (r < 0)
2857 return r;
2858
2859 /* First, insert into the set of PIDs maintained by the unit */
2860 r = set_ensure_put(&u->pids, &pidref_hash_ops, pid_dup);
2861 if (r < 0)
2862 return r;
2863
2864 pid = TAKE_PTR(pid_dup); /* continue with our copy now that we have installed it properly in our set */
2865
2866 /* Second, insert it into the simple global table, see if that works */
2867 r = hashmap_ensure_put(&u->manager->watch_pids, &pidref_hash_ops, pid, u);
2868 if (r != -EEXIST)
2869 return r;
2870
2871 /* OK, the key is already assigned to a different unit. That's fine, then add us via the second
2872 * hashmap that points to an array. */
2873
2874 PidRef *old_pid = NULL;
2875 Unit **array = hashmap_get2(u->manager->watch_pids_more, pid, (void**) &old_pid);
2876
2877 /* Count entries in array */
2878 size_t n = 0;
2879 for (; array && array[n]; n++)
2880 ;
2881
2882 /* Allocate a new array */
2883 _cleanup_free_ Unit **new_array = new(Unit*, n + 2);
2884 if (!new_array)
2885 return -ENOMEM;
2886
2887 /* Append us to the end */
2888 memcpy_safe(new_array, array, sizeof(Unit*) * n);
2889 new_array[n] = u;
2890 new_array[n+1] = NULL;
2891
2892 /* Make sure the hashmap is allocated */
2893 r = hashmap_ensure_allocated(&u->manager->watch_pids_more, &pidref_hash_ops);
2894 if (r < 0)
2895 return r;
2896
2897 /* Add or replace the old array */
2898 r = hashmap_replace(u->manager->watch_pids_more, old_pid ?: pid, new_array);
2899 if (r < 0)
2900 return r;
2901
2902 TAKE_PTR(new_array); /* Now part of the hash table */
2903 free(array); /* Which means we can now delete the old version */
2904 return 0;
2905 }
2906
2907 int unit_watch_pid(Unit *u, pid_t pid, bool exclusive) {
2908 _cleanup_(pidref_done) PidRef pidref = PIDREF_NULL;
2909 int r;
2910
2911 assert(u);
2912 assert(pid_is_valid(pid));
2913
2914 r = pidref_set_pid(&pidref, pid);
2915 if (r < 0)
2916 return r;
2917
2918 return unit_watch_pidref(u, &pidref, exclusive);
2919 }
2920
2921 int unit_watch_pid_str(Unit *u, const char *s, bool exclusive) {
2922 _cleanup_(pidref_done) PidRef pidref = PIDREF_NULL;
2923 int r;
2924
2925 assert(u);
2926 assert(s);
2927
2928 r = pidref_set_pidstr(&pidref, s);
2929 if (r < 0)
2930 return r;
2931
2932 return unit_watch_pidref(u, &pidref, exclusive);
2933 }
2934
2935 void unit_unwatch_pidref(Unit *u, PidRef *pid) {
2936 assert(u);
2937 assert(pidref_is_set(pid));
2938
2939 /* Remove from the set we maintain for this unit. (And destroy the returned pid eventually) */
2940 _cleanup_(pidref_freep) PidRef *pid1 = set_remove(u->pids, pid);
2941 if (!pid1)
2942 return; /* Early exit if this PID was never watched by us */
2943
2944 /* First let's drop the unit from the simple hash table, if it is included there */
2945 PidRef *pid2 = NULL;
2946 Unit *uu = hashmap_get2(u->manager->watch_pids, pid, (void**) &pid2);
2947
2948 /* Quick validation: iff we are in the watch_pids table then the PidRef object must be the same as in our local pids set */
2949 assert((uu == u) == (pid1 == pid2));
2950
2951 if (uu == u)
2952 /* OK, we are in the first table. Let's remove it there then, and we are done already. */
2953 assert_se(hashmap_remove_value(u->manager->watch_pids, pid2, uu) == uu);
2954 else {
2955 /* We weren't in the first table, then let's consult the 2nd table that points to an array */
2956 PidRef *pid3 = NULL;
2957 Unit **array = hashmap_get2(u->manager->watch_pids_more, pid, (void**) &pid3);
2958
2959 /* Let's iterate through the array, dropping our own entry */
2960 size_t m = 0, n = 0;
2961 for (; array && array[n]; n++)
2962 if (array[n] != u)
2963 array[m++] = array[n];
2964 if (n == m)
2965 return; /* Not there */
2966
2967 array[m] = NULL; /* set trailing NULL marker on the new end */
2968
2969 if (m == 0) {
2970 /* The array is now empty, remove the entire entry */
2971 assert_se(hashmap_remove_value(u->manager->watch_pids_more, pid3, array) == array);
2972 free(array);
2973 } else {
2974 /* The array is not empty, but let's make sure the entry is not keyed by the PidRef
2975 * we will delete, but by the PidRef object of the Unit that is now first in the
2976 * array. */
2977
2978 PidRef *new_pid3 = ASSERT_PTR(set_get(array[0]->pids, pid));
2979 assert_se(hashmap_replace(u->manager->watch_pids_more, new_pid3, array) >= 0);
2980 }
2981 }
2982 }
2983
2984 void unit_unwatch_pid(Unit *u, pid_t pid) {
2985 return unit_unwatch_pidref(u, &PIDREF_MAKE_FROM_PID(pid));
2986 }
2987
2988 void unit_unwatch_all_pids(Unit *u) {
2989 assert(u);
2990
2991 while (!set_isempty(u->pids))
2992 unit_unwatch_pidref(u, set_first(u->pids));
2993
2994 u->pids = set_free(u->pids);
2995 }
2996
2997 static void unit_tidy_watch_pids(Unit *u) {
2998 PidRef *except1, *except2, *e;
2999
3000 assert(u);
3001
3002 /* Cleans dead PIDs from our list */
3003
3004 except1 = unit_main_pid(u);
3005 except2 = unit_control_pid(u);
3006
3007 SET_FOREACH(e, u->pids) {
3008 if (pidref_equal(except1, e) || pidref_equal(except2, e))
3009 continue;
3010
3011 if (!pid_is_unwaited(e->pid))
3012 unit_unwatch_pidref(u, e);
3013 }
3014 }
3015
3016 static int on_rewatch_pids_event(sd_event_source *s, void *userdata) {
3017 Unit *u = ASSERT_PTR(userdata);
3018
3019 assert(s);
3020
3021 unit_tidy_watch_pids(u);
3022 unit_watch_all_pids(u);
3023
3024 /* If the PID set is empty now, then let's finish this off. */
3025 unit_synthesize_cgroup_empty_event(u);
3026
3027 return 0;
3028 }
3029
3030 int unit_enqueue_rewatch_pids(Unit *u) {
3031 int r;
3032
3033 assert(u);
3034
3035 if (!u->cgroup_path)
3036 return -ENOENT;
3037
3038 r = cg_unified_controller(SYSTEMD_CGROUP_CONTROLLER);
3039 if (r < 0)
3040 return r;
3041 if (r > 0) /* On unified we can use proper notifications */
3042 return 0;
3043
3044 /* Enqueues a low-priority job that will clean up dead PIDs from our list of PIDs to watch and subscribe to new
3045 * PIDs that might have appeared. We do this in a delayed job because the work might be quite slow, as it
3046 * involves issuing kill(pid, 0) on all processes we watch. */
3047
3048 if (!u->rewatch_pids_event_source) {
3049 _cleanup_(sd_event_source_unrefp) sd_event_source *s = NULL;
3050
3051 r = sd_event_add_defer(u->manager->event, &s, on_rewatch_pids_event, u);
3052 if (r < 0)
3053 return log_error_errno(r, "Failed to allocate event source for tidying watched PIDs: %m");
3054
3055 r = sd_event_source_set_priority(s, SD_EVENT_PRIORITY_IDLE);
3056 if (r < 0)
3057 return log_error_errno(r, "Failed to adjust priority of event source for tidying watched PIDs: %m");
3058
3059 (void) sd_event_source_set_description(s, "tidy-watch-pids");
3060
3061 u->rewatch_pids_event_source = TAKE_PTR(s);
3062 }
3063
3064 r = sd_event_source_set_enabled(u->rewatch_pids_event_source, SD_EVENT_ONESHOT);
3065 if (r < 0)
3066 return log_error_errno(r, "Failed to enable event source for tidying watched PIDs: %m");
3067
3068 return 0;
3069 }
3070
3071 void unit_dequeue_rewatch_pids(Unit *u) {
3072 int r;
3073 assert(u);
3074
3075 if (!u->rewatch_pids_event_source)
3076 return;
3077
3078 r = sd_event_source_set_enabled(u->rewatch_pids_event_source, SD_EVENT_OFF);
3079 if (r < 0)
3080 log_warning_errno(r, "Failed to disable event source for tidying watched PIDs, ignoring: %m");
3081
3082 u->rewatch_pids_event_source = sd_event_source_disable_unref(u->rewatch_pids_event_source);
3083 }
3084
3085 bool unit_job_is_applicable(Unit *u, JobType j) {
3086 assert(u);
3087 assert(j >= 0 && j < _JOB_TYPE_MAX);
3088
3089 switch (j) {
3090
3091 case JOB_VERIFY_ACTIVE:
3092 case JOB_START:
3093 case JOB_NOP:
3094 /* Note that we don't check unit_can_start() here. That's because .device units and suchlike are not
3095 * startable by us but may appear due to external events, and it thus makes sense to permit enqueuing
3096 * jobs for it. */
3097 return true;
3098
3099 case JOB_STOP:
3100 /* Similar as above. However, perpetual units can never be stopped (neither explicitly nor due to
3101 * external events), hence it makes no sense to permit enqueuing such a request either. */
3102 return !u->perpetual;
3103
3104 case JOB_RESTART:
3105 case JOB_TRY_RESTART:
3106 return unit_can_stop(u) && unit_can_start(u);
3107
3108 case JOB_RELOAD:
3109 case JOB_TRY_RELOAD:
3110 return unit_can_reload(u);
3111
3112 case JOB_RELOAD_OR_START:
3113 return unit_can_reload(u) && unit_can_start(u);
3114
3115 default:
3116 assert_not_reached();
3117 }
3118 }
3119
3120 static Hashmap *unit_get_dependency_hashmap_per_type(Unit *u, UnitDependency d) {
3121 Hashmap *deps;
3122
3123 assert(u);
3124 assert(d >= 0 && d < _UNIT_DEPENDENCY_MAX);
3125
3126 deps = hashmap_get(u->dependencies, UNIT_DEPENDENCY_TO_PTR(d));
3127 if (!deps) {
3128 _cleanup_hashmap_free_ Hashmap *h = NULL;
3129
3130 h = hashmap_new(NULL);
3131 if (!h)
3132 return NULL;
3133
3134 if (hashmap_ensure_put(&u->dependencies, NULL, UNIT_DEPENDENCY_TO_PTR(d), h) < 0)
3135 return NULL;
3136
3137 deps = TAKE_PTR(h);
3138 }
3139
3140 return deps;
3141 }
3142
3143 typedef enum NotifyDependencyFlags {
3144 NOTIFY_DEPENDENCY_UPDATE_FROM = 1 << 0,
3145 NOTIFY_DEPENDENCY_UPDATE_TO = 1 << 1,
3146 } NotifyDependencyFlags;
3147
3148 static int unit_add_dependency_impl(
3149 Unit *u,
3150 UnitDependency d,
3151 Unit *other,
3152 UnitDependencyMask mask) {
3153
3154 static const UnitDependency inverse_table[_UNIT_DEPENDENCY_MAX] = {
3155 [UNIT_REQUIRES] = UNIT_REQUIRED_BY,
3156 [UNIT_REQUISITE] = UNIT_REQUISITE_OF,
3157 [UNIT_WANTS] = UNIT_WANTED_BY,
3158 [UNIT_BINDS_TO] = UNIT_BOUND_BY,
3159 [UNIT_PART_OF] = UNIT_CONSISTS_OF,
3160 [UNIT_UPHOLDS] = UNIT_UPHELD_BY,
3161 [UNIT_REQUIRED_BY] = UNIT_REQUIRES,
3162 [UNIT_REQUISITE_OF] = UNIT_REQUISITE,
3163 [UNIT_WANTED_BY] = UNIT_WANTS,
3164 [UNIT_BOUND_BY] = UNIT_BINDS_TO,
3165 [UNIT_CONSISTS_OF] = UNIT_PART_OF,
3166 [UNIT_UPHELD_BY] = UNIT_UPHOLDS,
3167 [UNIT_CONFLICTS] = UNIT_CONFLICTED_BY,
3168 [UNIT_CONFLICTED_BY] = UNIT_CONFLICTS,
3169 [UNIT_BEFORE] = UNIT_AFTER,
3170 [UNIT_AFTER] = UNIT_BEFORE,
3171 [UNIT_ON_SUCCESS] = UNIT_ON_SUCCESS_OF,
3172 [UNIT_ON_SUCCESS_OF] = UNIT_ON_SUCCESS,
3173 [UNIT_ON_FAILURE] = UNIT_ON_FAILURE_OF,
3174 [UNIT_ON_FAILURE_OF] = UNIT_ON_FAILURE,
3175 [UNIT_TRIGGERS] = UNIT_TRIGGERED_BY,
3176 [UNIT_TRIGGERED_BY] = UNIT_TRIGGERS,
3177 [UNIT_PROPAGATES_RELOAD_TO] = UNIT_RELOAD_PROPAGATED_FROM,
3178 [UNIT_RELOAD_PROPAGATED_FROM] = UNIT_PROPAGATES_RELOAD_TO,
3179 [UNIT_PROPAGATES_STOP_TO] = UNIT_STOP_PROPAGATED_FROM,
3180 [UNIT_STOP_PROPAGATED_FROM] = UNIT_PROPAGATES_STOP_TO,
3181 [UNIT_JOINS_NAMESPACE_OF] = UNIT_JOINS_NAMESPACE_OF, /* symmetric! 👓 */
3182 [UNIT_REFERENCES] = UNIT_REFERENCED_BY,
3183 [UNIT_REFERENCED_BY] = UNIT_REFERENCES,
3184 [UNIT_IN_SLICE] = UNIT_SLICE_OF,
3185 [UNIT_SLICE_OF] = UNIT_IN_SLICE,
3186 };
3187
3188 Hashmap *u_deps, *other_deps;
3189 UnitDependencyInfo u_info, u_info_old, other_info, other_info_old;
3190 NotifyDependencyFlags flags = 0;
3191 int r;
3192
3193 assert(u);
3194 assert(other);
3195 assert(d >= 0 && d < _UNIT_DEPENDENCY_MAX);
3196 assert(inverse_table[d] >= 0 && inverse_table[d] < _UNIT_DEPENDENCY_MAX);
3197 assert(mask > 0 && mask < _UNIT_DEPENDENCY_MASK_FULL);
3198
3199 /* Ensure the following two hashmaps for each unit exist:
3200 * - the top-level dependency hashmap that maps UnitDependency → Hashmap(Unit* → UnitDependencyInfo),
3201 * - the inner hashmap, that maps Unit* → UnitDependencyInfo, for the specified dependency type. */
3202 u_deps = unit_get_dependency_hashmap_per_type(u, d);
3203 if (!u_deps)
3204 return -ENOMEM;
3205
3206 other_deps = unit_get_dependency_hashmap_per_type(other, inverse_table[d]);
3207 if (!other_deps)
3208 return -ENOMEM;
3209
3210 /* Save the original dependency info. */
3211 u_info.data = u_info_old.data = hashmap_get(u_deps, other);
3212 other_info.data = other_info_old.data = hashmap_get(other_deps, u);
3213
3214 /* Update dependency info. */
3215 u_info.origin_mask |= mask;
3216 other_info.destination_mask |= mask;
3217
3218 /* Save updated dependency info. */
3219 if (u_info.data != u_info_old.data) {
3220 r = hashmap_replace(u_deps, other, u_info.data);
3221 if (r < 0)
3222 return r;
3223
3224 flags = NOTIFY_DEPENDENCY_UPDATE_FROM;
3225 }
3226
3227 if (other_info.data != other_info_old.data) {
3228 r = hashmap_replace(other_deps, u, other_info.data);
3229 if (r < 0) {
3230 if (u_info.data != u_info_old.data) {
3231 /* Restore the old dependency. */
3232 if (u_info_old.data)
3233 (void) hashmap_update(u_deps, other, u_info_old.data);
3234 else
3235 hashmap_remove(u_deps, other);
3236 }
3237 return r;
3238 }
3239
3240 flags |= NOTIFY_DEPENDENCY_UPDATE_TO;
3241 }
3242
3243 return flags;
3244 }
3245
3246 int unit_add_dependency(
3247 Unit *u,
3248 UnitDependency d,
3249 Unit *other,
3250 bool add_reference,
3251 UnitDependencyMask mask) {
3252
3253 UnitDependencyAtom a;
3254 int r;
3255
3256 /* Helper to know whether sending a notification is necessary or not: if the dependency is already
3257 * there, no need to notify! */
3258 NotifyDependencyFlags notify_flags;
3259
3260 assert(u);
3261 assert(d >= 0 && d < _UNIT_DEPENDENCY_MAX);
3262 assert(other);
3263
3264 u = unit_follow_merge(u);
3265 other = unit_follow_merge(other);
3266 a = unit_dependency_to_atom(d);
3267 assert(a >= 0);
3268
3269 /* We won't allow dependencies on ourselves. We will not consider them an error however. */
3270 if (u == other) {
3271 if (unit_should_warn_about_dependency(d))
3272 log_unit_warning(u, "Dependency %s=%s is dropped.",
3273 unit_dependency_to_string(d), u->id);
3274 return 0;
3275 }
3276
3277 if (u->manager && FLAGS_SET(u->manager->test_run_flags, MANAGER_TEST_RUN_IGNORE_DEPENDENCIES))
3278 return 0;
3279
3280 /* Note that ordering a device unit after a unit is permitted since it allows to start its job
3281 * running timeout at a specific time. */
3282 if (FLAGS_SET(a, UNIT_ATOM_BEFORE) && other->type == UNIT_DEVICE) {
3283 log_unit_warning(u, "Dependency Before=%s ignored (.device units cannot be delayed)", other->id);
3284 return 0;
3285 }
3286
3287 if (FLAGS_SET(a, UNIT_ATOM_ON_FAILURE) && !UNIT_VTABLE(u)->can_fail) {
3288 log_unit_warning(u, "Requested dependency OnFailure=%s ignored (%s units cannot fail).", other->id, unit_type_to_string(u->type));
3289 return 0;
3290 }
3291
3292 if (FLAGS_SET(a, UNIT_ATOM_TRIGGERS) && !UNIT_VTABLE(u)->can_trigger)
3293 return log_unit_error_errno(u, SYNTHETIC_ERRNO(EINVAL),
3294 "Requested dependency Triggers=%s refused (%s units cannot trigger other units).", other->id, unit_type_to_string(u->type));
3295 if (FLAGS_SET(a, UNIT_ATOM_TRIGGERED_BY) && !UNIT_VTABLE(other)->can_trigger)
3296 return log_unit_error_errno(u, SYNTHETIC_ERRNO(EINVAL),
3297 "Requested dependency TriggeredBy=%s refused (%s units cannot trigger other units).", other->id, unit_type_to_string(other->type));
3298
3299 if (FLAGS_SET(a, UNIT_ATOM_IN_SLICE) && other->type != UNIT_SLICE)
3300 return log_unit_error_errno(u, SYNTHETIC_ERRNO(EINVAL),
3301 "Requested dependency Slice=%s refused (%s is not a slice unit).", other->id, other->id);
3302 if (FLAGS_SET(a, UNIT_ATOM_SLICE_OF) && u->type != UNIT_SLICE)
3303 return log_unit_error_errno(u, SYNTHETIC_ERRNO(EINVAL),
3304 "Requested dependency SliceOf=%s refused (%s is not a slice unit).", other->id, u->id);
3305
3306 if (FLAGS_SET(a, UNIT_ATOM_IN_SLICE) && !UNIT_HAS_CGROUP_CONTEXT(u))
3307 return log_unit_error_errno(u, SYNTHETIC_ERRNO(EINVAL),
3308 "Requested dependency Slice=%s refused (%s is not a cgroup unit).", other->id, u->id);
3309
3310 if (FLAGS_SET(a, UNIT_ATOM_SLICE_OF) && !UNIT_HAS_CGROUP_CONTEXT(other))
3311 return log_unit_error_errno(u, SYNTHETIC_ERRNO(EINVAL),
3312 "Requested dependency SliceOf=%s refused (%s is not a cgroup unit).", other->id, other->id);
3313
3314 r = unit_add_dependency_impl(u, d, other, mask);
3315 if (r < 0)
3316 return r;
3317 notify_flags = r;
3318
3319 if (add_reference) {
3320 r = unit_add_dependency_impl(u, UNIT_REFERENCES, other, mask);
3321 if (r < 0)
3322 return r;
3323 notify_flags |= r;
3324 }
3325
3326 if (FLAGS_SET(notify_flags, NOTIFY_DEPENDENCY_UPDATE_FROM))
3327 unit_add_to_dbus_queue(u);
3328 if (FLAGS_SET(notify_flags, NOTIFY_DEPENDENCY_UPDATE_TO))
3329 unit_add_to_dbus_queue(other);
3330
3331 return notify_flags != 0;
3332 }
3333
3334 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference, UnitDependencyMask mask) {
3335 int r = 0, s = 0;
3336
3337 assert(u);
3338 assert(d >= 0 || e >= 0);
3339
3340 if (d >= 0) {
3341 r = unit_add_dependency(u, d, other, add_reference, mask);
3342 if (r < 0)
3343 return r;
3344 }
3345
3346 if (e >= 0) {
3347 s = unit_add_dependency(u, e, other, add_reference, mask);
3348 if (s < 0)
3349 return s;
3350 }
3351
3352 return r > 0 || s > 0;
3353 }
3354
3355 static int resolve_template(Unit *u, const char *name, char **buf, const char **ret) {
3356 int r;
3357
3358 assert(u);
3359 assert(name);
3360 assert(buf);
3361 assert(ret);
3362
3363 if (!unit_name_is_valid(name, UNIT_NAME_TEMPLATE)) {
3364 *buf = NULL;
3365 *ret = name;
3366 return 0;
3367 }
3368
3369 if (u->instance)
3370 r = unit_name_replace_instance(name, u->instance, buf);
3371 else {
3372 _cleanup_free_ char *i = NULL;
3373
3374 r = unit_name_to_prefix(u->id, &i);
3375 if (r < 0)
3376 return r;
3377
3378 r = unit_name_replace_instance(name, i, buf);
3379 }
3380 if (r < 0)
3381 return r;
3382
3383 *ret = *buf;
3384 return 0;
3385 }
3386
3387 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, bool add_reference, UnitDependencyMask mask) {
3388 _cleanup_free_ char *buf = NULL;
3389 Unit *other;
3390 int r;
3391
3392 assert(u);
3393 assert(name);
3394
3395 r = resolve_template(u, name, &buf, &name);
3396 if (r < 0)
3397 return r;
3398
3399 if (u->manager && FLAGS_SET(u->manager->test_run_flags, MANAGER_TEST_RUN_IGNORE_DEPENDENCIES))
3400 return 0;
3401
3402 r = manager_load_unit(u->manager, name, NULL, NULL, &other);
3403 if (r < 0)
3404 return r;
3405
3406 return unit_add_dependency(u, d, other, add_reference, mask);
3407 }
3408
3409 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, bool add_reference, UnitDependencyMask mask) {
3410 _cleanup_free_ char *buf = NULL;
3411 Unit *other;
3412 int r;
3413
3414 assert(u);
3415 assert(name);
3416
3417 r = resolve_template(u, name, &buf, &name);
3418 if (r < 0)
3419 return r;
3420
3421 if (u->manager && FLAGS_SET(u->manager->test_run_flags, MANAGER_TEST_RUN_IGNORE_DEPENDENCIES))
3422 return 0;
3423
3424 r = manager_load_unit(u->manager, name, NULL, NULL, &other);
3425 if (r < 0)
3426 return r;
3427
3428 return unit_add_two_dependencies(u, d, e, other, add_reference, mask);
3429 }
3430
3431 int set_unit_path(const char *p) {
3432 /* This is mostly for debug purposes */
3433 return RET_NERRNO(setenv("SYSTEMD_UNIT_PATH", p, 1));
3434 }
3435
3436 char *unit_dbus_path(Unit *u) {
3437 assert(u);
3438
3439 if (!u->id)
3440 return NULL;
3441
3442 return unit_dbus_path_from_name(u->id);
3443 }
3444
3445 char *unit_dbus_path_invocation_id(Unit *u) {
3446 assert(u);
3447
3448 if (sd_id128_is_null(u->invocation_id))
3449 return NULL;
3450
3451 return unit_dbus_path_from_name(u->invocation_id_string);
3452 }
3453
3454 int unit_set_invocation_id(Unit *u, sd_id128_t id) {
3455 int r;
3456
3457 assert(u);
3458
3459 /* Set the invocation ID for this unit. If we cannot, this will not roll back, but reset the whole thing. */
3460
3461 if (sd_id128_equal(u->invocation_id, id))
3462 return 0;
3463
3464 if (!sd_id128_is_null(u->invocation_id))
3465 (void) hashmap_remove_value(u->manager->units_by_invocation_id, &u->invocation_id, u);
3466
3467 if (sd_id128_is_null(id)) {
3468 r = 0;
3469 goto reset;
3470 }
3471
3472 r = hashmap_ensure_allocated(&u->manager->units_by_invocation_id, &id128_hash_ops);
3473 if (r < 0)
3474 goto reset;
3475
3476 u->invocation_id = id;
3477 sd_id128_to_string(id, u->invocation_id_string);
3478
3479 r = hashmap_put(u->manager->units_by_invocation_id, &u->invocation_id, u);
3480 if (r < 0)
3481 goto reset;
3482
3483 return 0;
3484
3485 reset:
3486 u->invocation_id = SD_ID128_NULL;
3487 u->invocation_id_string[0] = 0;
3488 return r;
3489 }
3490
3491 int unit_set_slice(Unit *u, Unit *slice) {
3492 int r;
3493
3494 assert(u);
3495 assert(slice);
3496
3497 /* Sets the unit slice if it has not been set before. Is extra careful, to only allow this for units
3498 * that actually have a cgroup context. Also, we don't allow to set this for slices (since the parent
3499 * slice is derived from the name). Make sure the unit we set is actually a slice. */
3500
3501 if (!UNIT_HAS_CGROUP_CONTEXT(u))
3502 return -EOPNOTSUPP;
3503
3504 if (u->type == UNIT_SLICE)
3505 return -EINVAL;
3506
3507 if (unit_active_state(u) != UNIT_INACTIVE)
3508 return -EBUSY;
3509
3510 if (slice->type != UNIT_SLICE)
3511 return -EINVAL;
3512
3513 if (unit_has_name(u, SPECIAL_INIT_SCOPE) &&
3514 !unit_has_name(slice, SPECIAL_ROOT_SLICE))
3515 return -EPERM;
3516
3517 if (UNIT_GET_SLICE(u) == slice)
3518 return 0;
3519
3520 /* Disallow slice changes if @u is already bound to cgroups */
3521 if (UNIT_GET_SLICE(u) && u->cgroup_realized)
3522 return -EBUSY;
3523
3524 /* Remove any slices assigned prior; we should only have one UNIT_IN_SLICE dependency */
3525 if (UNIT_GET_SLICE(u))
3526 unit_remove_dependencies(u, UNIT_DEPENDENCY_SLICE_PROPERTY);
3527
3528 r = unit_add_dependency(u, UNIT_IN_SLICE, slice, true, UNIT_DEPENDENCY_SLICE_PROPERTY);
3529 if (r < 0)
3530 return r;
3531
3532 return 1;
3533 }
3534
3535 int unit_set_default_slice(Unit *u) {
3536 const char *slice_name;
3537 Unit *slice;
3538 int r;
3539
3540 assert(u);
3541
3542 if (u->manager && FLAGS_SET(u->manager->test_run_flags, MANAGER_TEST_RUN_IGNORE_DEPENDENCIES))
3543 return 0;
3544
3545 if (UNIT_GET_SLICE(u))
3546 return 0;
3547
3548 if (u->instance) {
3549 _cleanup_free_ char *prefix = NULL, *escaped = NULL;
3550
3551 /* Implicitly place all instantiated units in their
3552 * own per-template slice */
3553
3554 r = unit_name_to_prefix(u->id, &prefix);
3555 if (r < 0)
3556 return r;
3557
3558 /* The prefix is already escaped, but it might include
3559 * "-" which has a special meaning for slice units,
3560 * hence escape it here extra. */
3561 escaped = unit_name_escape(prefix);
3562 if (!escaped)
3563 return -ENOMEM;
3564
3565 if (MANAGER_IS_SYSTEM(u->manager))
3566 slice_name = strjoina("system-", escaped, ".slice");
3567 else
3568 slice_name = strjoina("app-", escaped, ".slice");
3569
3570 } else if (unit_is_extrinsic(u))
3571 /* Keep all extrinsic units (e.g. perpetual units and swap and mount units in user mode) in
3572 * the root slice. They don't really belong in one of the subslices. */
3573 slice_name = SPECIAL_ROOT_SLICE;
3574
3575 else if (MANAGER_IS_SYSTEM(u->manager))
3576 slice_name = SPECIAL_SYSTEM_SLICE;
3577 else
3578 slice_name = SPECIAL_APP_SLICE;
3579
3580 r = manager_load_unit(u->manager, slice_name, NULL, NULL, &slice);
3581 if (r < 0)
3582 return r;
3583
3584 return unit_set_slice(u, slice);
3585 }
3586
3587 const char *unit_slice_name(Unit *u) {
3588 Unit *slice;
3589 assert(u);
3590
3591 slice = UNIT_GET_SLICE(u);
3592 if (!slice)
3593 return NULL;
3594
3595 return slice->id;
3596 }
3597
3598 int unit_load_related_unit(Unit *u, const char *type, Unit **_found) {
3599 _cleanup_free_ char *t = NULL;
3600 int r;
3601
3602 assert(u);
3603 assert(type);
3604 assert(_found);
3605
3606 r = unit_name_change_suffix(u->id, type, &t);
3607 if (r < 0)
3608 return r;
3609 if (unit_has_name(u, t))
3610 return -EINVAL;
3611
3612 r = manager_load_unit(u->manager, t, NULL, NULL, _found);
3613 assert(r < 0 || *_found != u);
3614 return r;
3615 }
3616
3617 static int signal_name_owner_changed(sd_bus_message *message, void *userdata, sd_bus_error *error) {
3618 const char *new_owner;
3619 Unit *u = ASSERT_PTR(userdata);
3620 int r;
3621
3622 assert(message);
3623
3624 r = sd_bus_message_read(message, "sss", NULL, NULL, &new_owner);
3625 if (r < 0) {
3626 bus_log_parse_error(r);
3627 return 0;
3628 }
3629
3630 if (UNIT_VTABLE(u)->bus_name_owner_change)
3631 UNIT_VTABLE(u)->bus_name_owner_change(u, empty_to_null(new_owner));
3632
3633 return 0;
3634 }
3635
3636 static int get_name_owner_handler(sd_bus_message *message, void *userdata, sd_bus_error *error) {
3637 const sd_bus_error *e;
3638 const char *new_owner;
3639 Unit *u = ASSERT_PTR(userdata);
3640 int r;
3641
3642 assert(message);
3643
3644 u->get_name_owner_slot = sd_bus_slot_unref(u->get_name_owner_slot);
3645
3646 e = sd_bus_message_get_error(message);
3647 if (e) {
3648 if (!sd_bus_error_has_name(e, SD_BUS_ERROR_NAME_HAS_NO_OWNER)) {
3649 r = sd_bus_error_get_errno(e);
3650 log_unit_error_errno(u, r,
3651 "Unexpected error response from GetNameOwner(): %s",
3652 bus_error_message(e, r));
3653 }
3654
3655 new_owner = NULL;
3656 } else {
3657 r = sd_bus_message_read(message, "s", &new_owner);
3658 if (r < 0)
3659 return bus_log_parse_error(r);
3660
3661 assert(!isempty(new_owner));
3662 }
3663
3664 if (UNIT_VTABLE(u)->bus_name_owner_change)
3665 UNIT_VTABLE(u)->bus_name_owner_change(u, new_owner);
3666
3667 return 0;
3668 }
3669
3670 int unit_install_bus_match(Unit *u, sd_bus *bus, const char *name) {
3671 _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = NULL;
3672 const char *match;
3673 usec_t timeout_usec = 0;
3674 int r;
3675
3676 assert(u);
3677 assert(bus);
3678 assert(name);
3679
3680 if (u->match_bus_slot || u->get_name_owner_slot)
3681 return -EBUSY;
3682
3683 /* NameOwnerChanged and GetNameOwner is used to detect when a service finished starting up. The dbus
3684 * call timeout shouldn't be earlier than that. If we couldn't get the start timeout, use the default
3685 * value defined above. */
3686 if (UNIT_VTABLE(u)->get_timeout_start_usec)
3687 timeout_usec = UNIT_VTABLE(u)->get_timeout_start_usec(u);
3688
3689 match = strjoina("type='signal',"
3690 "sender='org.freedesktop.DBus',"
3691 "path='/org/freedesktop/DBus',"
3692 "interface='org.freedesktop.DBus',"
3693 "member='NameOwnerChanged',"
3694 "arg0='", name, "'");
3695
3696 r = bus_add_match_full(
3697 bus,
3698 &u->match_bus_slot,
3699 true,
3700 match,
3701 signal_name_owner_changed,
3702 NULL,
3703 u,
3704 timeout_usec);
3705 if (r < 0)
3706 return r;
3707
3708 r = sd_bus_message_new_method_call(
3709 bus,
3710 &m,
3711 "org.freedesktop.DBus",
3712 "/org/freedesktop/DBus",
3713 "org.freedesktop.DBus",
3714 "GetNameOwner");
3715 if (r < 0)
3716 return r;
3717
3718 r = sd_bus_message_append(m, "s", name);
3719 if (r < 0)
3720 return r;
3721
3722 r = sd_bus_call_async(
3723 bus,
3724 &u->get_name_owner_slot,
3725 m,
3726 get_name_owner_handler,
3727 u,
3728 timeout_usec);
3729
3730 if (r < 0) {
3731 u->match_bus_slot = sd_bus_slot_unref(u->match_bus_slot);
3732 return r;
3733 }
3734
3735 log_unit_debug(u, "Watching D-Bus name '%s'.", name);
3736 return 0;
3737 }
3738
3739 int unit_watch_bus_name(Unit *u, const char *name) {
3740 int r;
3741
3742 assert(u);
3743 assert(name);
3744
3745 /* Watch a specific name on the bus. We only support one unit
3746 * watching each name for now. */
3747
3748 if (u->manager->api_bus) {
3749 /* If the bus is already available, install the match directly.
3750 * Otherwise, just put the name in the list. bus_setup_api() will take care later. */
3751 r = unit_install_bus_match(u, u->manager->api_bus, name);
3752 if (r < 0)
3753 return log_warning_errno(r, "Failed to subscribe to NameOwnerChanged signal for '%s': %m", name);
3754 }
3755
3756 r = hashmap_put(u->manager->watch_bus, name, u);
3757 if (r < 0) {
3758 u->match_bus_slot = sd_bus_slot_unref(u->match_bus_slot);
3759 u->get_name_owner_slot = sd_bus_slot_unref(u->get_name_owner_slot);
3760 return log_warning_errno(r, "Failed to put bus name to hashmap: %m");
3761 }
3762
3763 return 0;
3764 }
3765
3766 void unit_unwatch_bus_name(Unit *u, const char *name) {
3767 assert(u);
3768 assert(name);
3769
3770 (void) hashmap_remove_value(u->manager->watch_bus, name, u);
3771 u->match_bus_slot = sd_bus_slot_unref(u->match_bus_slot);
3772 u->get_name_owner_slot = sd_bus_slot_unref(u->get_name_owner_slot);
3773 }
3774
3775 int unit_add_node_dependency(Unit *u, const char *what, UnitDependency dep, UnitDependencyMask mask) {
3776 _cleanup_free_ char *e = NULL;
3777 Unit *device;
3778 int r;
3779
3780 assert(u);
3781
3782 /* Adds in links to the device node that this unit is based on */
3783 if (isempty(what))
3784 return 0;
3785
3786 if (!is_device_path(what))
3787 return 0;
3788
3789 /* When device units aren't supported (such as in a container), don't create dependencies on them. */
3790 if (!unit_type_supported(UNIT_DEVICE))
3791 return 0;
3792
3793 r = unit_name_from_path(what, ".device", &e);
3794 if (r < 0)
3795 return r;
3796
3797 r = manager_load_unit(u->manager, e, NULL, NULL, &device);
3798 if (r < 0)
3799 return r;
3800
3801 if (dep == UNIT_REQUIRES && device_shall_be_bound_by(device, u))
3802 dep = UNIT_BINDS_TO;
3803
3804 return unit_add_two_dependencies(u, UNIT_AFTER,
3805 MANAGER_IS_SYSTEM(u->manager) ? dep : UNIT_WANTS,
3806 device, true, mask);
3807 }
3808
3809 int unit_add_blockdev_dependency(Unit *u, const char *what, UnitDependencyMask mask) {
3810 _cleanup_free_ char *escaped = NULL, *target = NULL;
3811 int r;
3812
3813 assert(u);
3814
3815 if (isempty(what))
3816 return 0;
3817
3818 if (!path_startswith(what, "/dev/"))
3819 return 0;
3820
3821 /* If we don't support devices, then also don't bother with blockdev@.target */
3822 if (!unit_type_supported(UNIT_DEVICE))
3823 return 0;
3824
3825 r = unit_name_path_escape(what, &escaped);
3826 if (r < 0)
3827 return r;
3828
3829 r = unit_name_build("blockdev", escaped, ".target", &target);
3830 if (r < 0)
3831 return r;
3832
3833 return unit_add_dependency_by_name(u, UNIT_AFTER, target, true, mask);
3834 }
3835
3836 int unit_coldplug(Unit *u) {
3837 int r = 0;
3838
3839 assert(u);
3840
3841 /* Make sure we don't enter a loop, when coldplugging recursively. */
3842 if (u->coldplugged)
3843 return 0;
3844
3845 u->coldplugged = true;
3846
3847 STRV_FOREACH(i, u->deserialized_refs)
3848 RET_GATHER(r, bus_unit_track_add_name(u, *i));
3849
3850 u->deserialized_refs = strv_free(u->deserialized_refs);
3851
3852 if (UNIT_VTABLE(u)->coldplug)
3853 RET_GATHER(r, UNIT_VTABLE(u)->coldplug(u));
3854
3855 if (u->job)
3856 RET_GATHER(r, job_coldplug(u->job));
3857 if (u->nop_job)
3858 RET_GATHER(r, job_coldplug(u->nop_job));
3859
3860 CGroupContext *c = unit_get_cgroup_context(u);
3861 if (c)
3862 cgroup_modify_nft_set(u, /* add = */ true);
3863
3864 return r;
3865 }
3866
3867 void unit_catchup(Unit *u) {
3868 assert(u);
3869
3870 if (UNIT_VTABLE(u)->catchup)
3871 UNIT_VTABLE(u)->catchup(u);
3872
3873 unit_cgroup_catchup(u);
3874 }
3875
3876 static bool fragment_mtime_newer(const char *path, usec_t mtime, bool path_masked) {
3877 struct stat st;
3878
3879 if (!path)
3880 return false;
3881
3882 /* If the source is some virtual kernel file system, then we assume we watch it anyway, and hence pretend we
3883 * are never out-of-date. */
3884 if (PATH_STARTSWITH_SET(path, "/proc", "/sys"))
3885 return false;
3886
3887 if (stat(path, &st) < 0)
3888 /* What, cannot access this anymore? */
3889 return true;
3890
3891 if (path_masked)
3892 /* For masked files check if they are still so */
3893 return !null_or_empty(&st);
3894 else
3895 /* For non-empty files check the mtime */
3896 return timespec_load(&st.st_mtim) > mtime;
3897
3898 return false;
3899 }
3900
3901 bool unit_need_daemon_reload(Unit *u) {
3902 _cleanup_strv_free_ char **dropins = NULL;
3903
3904 assert(u);
3905 assert(u->manager);
3906
3907 if (u->manager->unit_file_state_outdated)
3908 return true;
3909
3910 /* For unit files, we allow masking… */
3911 if (fragment_mtime_newer(u->fragment_path, u->fragment_mtime,
3912 u->load_state == UNIT_MASKED))
3913 return true;
3914
3915 /* Source paths should not be masked… */
3916 if (fragment_mtime_newer(u->source_path, u->source_mtime, false))
3917 return true;
3918
3919 if (u->load_state == UNIT_LOADED)
3920 (void) unit_find_dropin_paths(u, &dropins);
3921 if (!strv_equal(u->dropin_paths, dropins))
3922 return true;
3923
3924 /* … any drop-ins that are masked are simply omitted from the list. */
3925 STRV_FOREACH(path, u->dropin_paths)
3926 if (fragment_mtime_newer(*path, u->dropin_mtime, false))
3927 return true;
3928
3929 return false;
3930 }
3931
3932 void unit_reset_failed(Unit *u) {
3933 assert(u);
3934
3935 if (UNIT_VTABLE(u)->reset_failed)
3936 UNIT_VTABLE(u)->reset_failed(u);
3937
3938 ratelimit_reset(&u->start_ratelimit);
3939 u->start_limit_hit = false;
3940 }
3941
3942 Unit *unit_following(Unit *u) {
3943 assert(u);
3944
3945 if (UNIT_VTABLE(u)->following)
3946 return UNIT_VTABLE(u)->following(u);
3947
3948 return NULL;
3949 }
3950
3951 bool unit_stop_pending(Unit *u) {
3952 assert(u);
3953
3954 /* This call does check the current state of the unit. It's
3955 * hence useful to be called from state change calls of the
3956 * unit itself, where the state isn't updated yet. This is
3957 * different from unit_inactive_or_pending() which checks both
3958 * the current state and for a queued job. */
3959
3960 return unit_has_job_type(u, JOB_STOP);
3961 }
3962
3963 bool unit_inactive_or_pending(Unit *u) {
3964 assert(u);
3965
3966 /* Returns true if the unit is inactive or going down */
3967
3968 if (UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(u)))
3969 return true;
3970
3971 if (unit_stop_pending(u))
3972 return true;
3973
3974 return false;
3975 }
3976
3977 bool unit_active_or_pending(Unit *u) {
3978 assert(u);
3979
3980 /* Returns true if the unit is active or going up */
3981
3982 if (UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(u)))
3983 return true;
3984
3985 if (u->job &&
3986 IN_SET(u->job->type, JOB_START, JOB_RELOAD_OR_START, JOB_RESTART))
3987 return true;
3988
3989 return false;
3990 }
3991
3992 bool unit_will_restart_default(Unit *u) {
3993 assert(u);
3994
3995 return unit_has_job_type(u, JOB_START);
3996 }
3997
3998 bool unit_will_restart(Unit *u) {
3999 assert(u);
4000
4001 if (!UNIT_VTABLE(u)->will_restart)
4002 return false;
4003
4004 return UNIT_VTABLE(u)->will_restart(u);
4005 }
4006
4007 void unit_notify_cgroup_oom(Unit *u, bool managed_oom) {
4008 assert(u);
4009
4010 if (UNIT_VTABLE(u)->notify_cgroup_oom)
4011 UNIT_VTABLE(u)->notify_cgroup_oom(u, managed_oom);
4012 }
4013
4014 static Set *unit_pid_set(pid_t main_pid, pid_t control_pid) {
4015 _cleanup_set_free_ Set *pid_set = NULL;
4016 int r;
4017
4018 pid_set = set_new(NULL);
4019 if (!pid_set)
4020 return NULL;
4021
4022 /* Exclude the main/control pids from being killed via the cgroup */
4023 if (main_pid > 0) {
4024 r = set_put(pid_set, PID_TO_PTR(main_pid));
4025 if (r < 0)
4026 return NULL;
4027 }
4028
4029 if (control_pid > 0) {
4030 r = set_put(pid_set, PID_TO_PTR(control_pid));
4031 if (r < 0)
4032 return NULL;
4033 }
4034
4035 return TAKE_PTR(pid_set);
4036 }
4037
4038 static int kill_common_log(pid_t pid, int signo, void *userdata) {
4039 _cleanup_free_ char *comm = NULL;
4040 Unit *u = ASSERT_PTR(userdata);
4041
4042 (void) get_process_comm(pid, &comm);
4043 log_unit_info(u, "Sending signal SIG%s to process " PID_FMT " (%s) on client request.",
4044 signal_to_string(signo), pid, strna(comm));
4045
4046 return 1;
4047 }
4048
4049 static int kill_or_sigqueue(PidRef* pidref, int signo, int code, int value) {
4050 assert(pidref_is_set(pidref));
4051 assert(SIGNAL_VALID(signo));
4052
4053 switch (code) {
4054
4055 case SI_USER:
4056 log_debug("Killing " PID_FMT " with signal SIG%s.", pidref->pid, signal_to_string(signo));
4057 return pidref_kill(pidref, signo);
4058
4059 case SI_QUEUE:
4060 log_debug("Enqueuing value %i to " PID_FMT " on signal SIG%s.", value, pidref->pid, signal_to_string(signo));
4061 return pidref_sigqueue(pidref, signo, value);
4062
4063 default:
4064 assert_not_reached();
4065 }
4066 }
4067
4068 int unit_kill(
4069 Unit *u,
4070 KillWho who,
4071 int signo,
4072 int code,
4073 int value,
4074 sd_bus_error *error) {
4075
4076 PidRef *main_pid, *control_pid;
4077 bool killed = false;
4078 int ret = 0, r;
4079
4080 /* This is the common implementation for explicit user-requested killing of unit processes, shared by
4081 * various unit types. Do not confuse with unit_kill_context(), which is what we use when we want to
4082 * stop a service ourselves. */
4083
4084 assert(u);
4085 assert(who >= 0);
4086 assert(who < _KILL_WHO_MAX);
4087 assert(SIGNAL_VALID(signo));
4088 assert(IN_SET(code, SI_USER, SI_QUEUE));
4089
4090 main_pid = unit_main_pid(u);
4091 control_pid = unit_control_pid(u);
4092
4093 if (!UNIT_HAS_CGROUP_CONTEXT(u) && !main_pid && !control_pid)
4094 return sd_bus_error_setf(error, SD_BUS_ERROR_NOT_SUPPORTED, "Unit type does not support process killing.");
4095
4096 if (IN_SET(who, KILL_MAIN, KILL_MAIN_FAIL)) {
4097 if (!main_pid)
4098 return sd_bus_error_setf(error, BUS_ERROR_NO_SUCH_PROCESS, "%s units have no main processes", unit_type_to_string(u->type));
4099 if (!pidref_is_set(main_pid))
4100 return sd_bus_error_set_const(error, BUS_ERROR_NO_SUCH_PROCESS, "No main process to kill");
4101 }
4102
4103 if (IN_SET(who, KILL_CONTROL, KILL_CONTROL_FAIL)) {
4104 if (!control_pid)
4105 return sd_bus_error_setf(error, BUS_ERROR_NO_SUCH_PROCESS, "%s units have no control processes", unit_type_to_string(u->type));
4106 if (!pidref_is_set(control_pid))
4107 return sd_bus_error_set_const(error, BUS_ERROR_NO_SUCH_PROCESS, "No control process to kill");
4108 }
4109
4110 if (pidref_is_set(control_pid) &&
4111 IN_SET(who, KILL_CONTROL, KILL_CONTROL_FAIL, KILL_ALL, KILL_ALL_FAIL)) {
4112 _cleanup_free_ char *comm = NULL;
4113 (void) get_process_comm(control_pid->pid, &comm);
4114
4115 r = kill_or_sigqueue(control_pid, signo, code, value);
4116 if (r < 0) {
4117 ret = r;
4118
4119 /* Report this failure both to the logs and to the client */
4120 sd_bus_error_set_errnof(
4121 error, r,
4122 "Failed to send signal SIG%s to control process " PID_FMT " (%s): %m",
4123 signal_to_string(signo), control_pid->pid, strna(comm));
4124 log_unit_warning_errno(
4125 u, r,
4126 "Failed to send signal SIG%s to control process " PID_FMT " (%s) on client request: %m",
4127 signal_to_string(signo), control_pid->pid, strna(comm));
4128 } else {
4129 log_unit_info(u, "Sent signal SIG%s to control process " PID_FMT " (%s) on client request.",
4130 signal_to_string(signo), control_pid->pid, strna(comm));
4131 killed = true;
4132 }
4133 }
4134
4135 if (pidref_is_set(main_pid) &&
4136 IN_SET(who, KILL_MAIN, KILL_MAIN_FAIL, KILL_ALL, KILL_ALL_FAIL)) {
4137
4138 _cleanup_free_ char *comm = NULL;
4139 (void) get_process_comm(main_pid->pid, &comm);
4140
4141 r = kill_or_sigqueue(main_pid, signo, code, value);
4142 if (r < 0) {
4143 if (ret == 0) {
4144 ret = r;
4145
4146 sd_bus_error_set_errnof(
4147 error, r,
4148 "Failed to send signal SIG%s to main process " PID_FMT " (%s): %m",
4149 signal_to_string(signo), main_pid->pid, strna(comm));
4150 }
4151
4152 log_unit_warning_errno(
4153 u, r,
4154 "Failed to send signal SIG%s to main process " PID_FMT " (%s) on client request: %m",
4155 signal_to_string(signo), main_pid->pid, strna(comm));
4156
4157 } else {
4158 log_unit_info(u, "Sent signal SIG%s to main process " PID_FMT " (%s) on client request.",
4159 signal_to_string(signo), main_pid->pid, strna(comm));
4160 killed = true;
4161 }
4162 }
4163
4164 /* Note: if we shall enqueue rather than kill we won't do this via the cgroup mechanism, since it
4165 * doesn't really make much sense (and given that enqueued values are a relatively expensive
4166 * resource, and we shouldn't allow us to be subjects for such allocation sprees) */
4167 if (IN_SET(who, KILL_ALL, KILL_ALL_FAIL) && u->cgroup_path && code == SI_USER) {
4168 _cleanup_set_free_ Set *pid_set = NULL;
4169
4170 /* Exclude the main/control pids from being killed via the cgroup */
4171 pid_set = unit_pid_set(main_pid ? main_pid->pid : 0, control_pid ? control_pid->pid : 0);
4172 if (!pid_set)
4173 return log_oom();
4174
4175 r = cg_kill_recursive(u->cgroup_path, signo, 0, pid_set, kill_common_log, u);
4176 if (r < 0) {
4177 if (!IN_SET(r, -ESRCH, -ENOENT)) {
4178 if (ret == 0) {
4179 ret = r;
4180
4181 sd_bus_error_set_errnof(
4182 error, r,
4183 "Failed to send signal SIG%s to auxiliary processes: %m",
4184 signal_to_string(signo));
4185 }
4186
4187 log_unit_warning_errno(
4188 u, r,
4189 "Failed to send signal SIG%s to auxiliary processes on client request: %m",
4190 signal_to_string(signo));
4191 }
4192 } else
4193 killed = true;
4194 }
4195
4196 /* If the "fail" versions of the operation are requested, then complain if the set of processes we killed is empty */
4197 if (ret == 0 && !killed && IN_SET(who, KILL_ALL_FAIL, KILL_CONTROL_FAIL, KILL_MAIN_FAIL))
4198 return sd_bus_error_set_const(error, BUS_ERROR_NO_SUCH_PROCESS, "No matching processes to kill");
4199
4200 return ret;
4201 }
4202
4203 int unit_following_set(Unit *u, Set **s) {
4204 assert(u);
4205 assert(s);
4206
4207 if (UNIT_VTABLE(u)->following_set)
4208 return UNIT_VTABLE(u)->following_set(u, s);
4209
4210 *s = NULL;
4211 return 0;
4212 }
4213
4214 UnitFileState unit_get_unit_file_state(Unit *u) {
4215 int r;
4216
4217 assert(u);
4218
4219 if (u->unit_file_state < 0 && u->fragment_path) {
4220 r = unit_file_get_state(
4221 u->manager->runtime_scope,
4222 NULL,
4223 u->id,
4224 &u->unit_file_state);
4225 if (r < 0)
4226 u->unit_file_state = UNIT_FILE_BAD;
4227 }
4228
4229 return u->unit_file_state;
4230 }
4231
4232 PresetAction unit_get_unit_file_preset(Unit *u) {
4233 int r;
4234
4235 assert(u);
4236
4237 if (u->unit_file_preset < 0 && u->fragment_path) {
4238 _cleanup_free_ char *bn = NULL;
4239
4240 r = path_extract_filename(u->fragment_path, &bn);
4241 if (r < 0)
4242 return (u->unit_file_preset = r);
4243
4244 if (r == O_DIRECTORY)
4245 return (u->unit_file_preset = -EISDIR);
4246
4247 u->unit_file_preset = unit_file_query_preset(
4248 u->manager->runtime_scope,
4249 NULL,
4250 bn,
4251 NULL);
4252 }
4253
4254 return u->unit_file_preset;
4255 }
4256
4257 Unit* unit_ref_set(UnitRef *ref, Unit *source, Unit *target) {
4258 assert(ref);
4259 assert(source);
4260 assert(target);
4261
4262 if (ref->target)
4263 unit_ref_unset(ref);
4264
4265 ref->source = source;
4266 ref->target = target;
4267 LIST_PREPEND(refs_by_target, target->refs_by_target, ref);
4268 return target;
4269 }
4270
4271 void unit_ref_unset(UnitRef *ref) {
4272 assert(ref);
4273
4274 if (!ref->target)
4275 return;
4276
4277 /* We are about to drop a reference to the unit, make sure the garbage collection has a look at it as it might
4278 * be unreferenced now. */
4279 unit_add_to_gc_queue(ref->target);
4280
4281 LIST_REMOVE(refs_by_target, ref->target->refs_by_target, ref);
4282 ref->source = ref->target = NULL;
4283 }
4284
4285 static int user_from_unit_name(Unit *u, char **ret) {
4286
4287 static const uint8_t hash_key[] = {
4288 0x58, 0x1a, 0xaf, 0xe6, 0x28, 0x58, 0x4e, 0x96,
4289 0xb4, 0x4e, 0xf5, 0x3b, 0x8c, 0x92, 0x07, 0xec
4290 };
4291
4292 _cleanup_free_ char *n = NULL;
4293 int r;
4294
4295 r = unit_name_to_prefix(u->id, &n);
4296 if (r < 0)
4297 return r;
4298
4299 if (valid_user_group_name(n, 0)) {
4300 *ret = TAKE_PTR(n);
4301 return 0;
4302 }
4303
4304 /* If we can't use the unit name as a user name, then let's hash it and use that */
4305 if (asprintf(ret, "_du%016" PRIx64, siphash24(n, strlen(n), hash_key)) < 0)
4306 return -ENOMEM;
4307
4308 return 0;
4309 }
4310
4311 int unit_patch_contexts(Unit *u) {
4312 CGroupContext *cc;
4313 ExecContext *ec;
4314 int r;
4315
4316 assert(u);
4317
4318 /* Patch in the manager defaults into the exec and cgroup
4319 * contexts, _after_ the rest of the settings have been
4320 * initialized */
4321
4322 ec = unit_get_exec_context(u);
4323 if (ec) {
4324 /* This only copies in the ones that need memory */
4325 for (unsigned i = 0; i < _RLIMIT_MAX; i++)
4326 if (u->manager->defaults.rlimit[i] && !ec->rlimit[i]) {
4327 ec->rlimit[i] = newdup(struct rlimit, u->manager->defaults.rlimit[i], 1);
4328 if (!ec->rlimit[i])
4329 return -ENOMEM;
4330 }
4331
4332 if (MANAGER_IS_USER(u->manager) &&
4333 !ec->working_directory) {
4334
4335 r = get_home_dir(&ec->working_directory);
4336 if (r < 0)
4337 return r;
4338
4339 /* Allow user services to run, even if the
4340 * home directory is missing */
4341 ec->working_directory_missing_ok = true;
4342 }
4343
4344 if (ec->private_devices)
4345 ec->capability_bounding_set &= ~((UINT64_C(1) << CAP_MKNOD) | (UINT64_C(1) << CAP_SYS_RAWIO));
4346
4347 if (ec->protect_kernel_modules)
4348 ec->capability_bounding_set &= ~(UINT64_C(1) << CAP_SYS_MODULE);
4349
4350 if (ec->protect_kernel_logs)
4351 ec->capability_bounding_set &= ~(UINT64_C(1) << CAP_SYSLOG);
4352
4353 if (ec->protect_clock)
4354 ec->capability_bounding_set &= ~((UINT64_C(1) << CAP_SYS_TIME) | (UINT64_C(1) << CAP_WAKE_ALARM));
4355
4356 if (ec->dynamic_user) {
4357 if (!ec->user) {
4358 r = user_from_unit_name(u, &ec->user);
4359 if (r < 0)
4360 return r;
4361 }
4362
4363 if (!ec->group) {
4364 ec->group = strdup(ec->user);
4365 if (!ec->group)
4366 return -ENOMEM;
4367 }
4368
4369 /* If the dynamic user option is on, let's make sure that the unit can't leave its
4370 * UID/GID around in the file system or on IPC objects. Hence enforce a strict
4371 * sandbox. */
4372
4373 ec->private_tmp = true;
4374 ec->remove_ipc = true;
4375 ec->protect_system = PROTECT_SYSTEM_STRICT;
4376 if (ec->protect_home == PROTECT_HOME_NO)
4377 ec->protect_home = PROTECT_HOME_READ_ONLY;
4378
4379 /* Make sure this service can neither benefit from SUID/SGID binaries nor create
4380 * them. */
4381 ec->no_new_privileges = true;
4382 ec->restrict_suid_sgid = true;
4383 }
4384
4385 for (ExecDirectoryType dt = 0; dt < _EXEC_DIRECTORY_TYPE_MAX; dt++)
4386 exec_directory_sort(ec->directories + dt);
4387 }
4388
4389 cc = unit_get_cgroup_context(u);
4390 if (cc && ec) {
4391
4392 if (ec->private_devices &&
4393 cc->device_policy == CGROUP_DEVICE_POLICY_AUTO)
4394 cc->device_policy = CGROUP_DEVICE_POLICY_CLOSED;
4395
4396 /* Only add these if needed, as they imply that everything else is blocked. */
4397 if (cc->device_policy != CGROUP_DEVICE_POLICY_AUTO || cc->device_allow) {
4398 if (ec->root_image || ec->mount_images) {
4399
4400 /* When RootImage= or MountImages= is specified, the following devices are touched. */
4401 FOREACH_STRING(p, "/dev/loop-control", "/dev/mapper/control") {
4402 r = cgroup_add_device_allow(cc, p, "rw");
4403 if (r < 0)
4404 return r;
4405 }
4406 FOREACH_STRING(p, "block-loop", "block-blkext", "block-device-mapper") {
4407 r = cgroup_add_device_allow(cc, p, "rwm");
4408 if (r < 0)
4409 return r;
4410 }
4411
4412 /* Make sure "block-loop" can be resolved, i.e. make sure "loop" shows up in /proc/devices.
4413 * Same for mapper and verity. */
4414 FOREACH_STRING(p, "modprobe@loop.service", "modprobe@dm_mod.service", "modprobe@dm_verity.service") {
4415 r = unit_add_two_dependencies_by_name(u, UNIT_AFTER, UNIT_WANTS, p, true, UNIT_DEPENDENCY_FILE);
4416 if (r < 0)
4417 return r;
4418 }
4419 }
4420
4421 if (ec->protect_clock) {
4422 r = cgroup_add_device_allow(cc, "char-rtc", "r");
4423 if (r < 0)
4424 return r;
4425 }
4426
4427 /* If there are encrypted credentials we might need to access the TPM. */
4428 if (exec_context_has_encrypted_credentials(ec)) {
4429 r = cgroup_add_device_allow(cc, "char-tpm", "rw");
4430 if (r < 0)
4431 return r;
4432 }
4433 }
4434 }
4435
4436 return 0;
4437 }
4438
4439 ExecContext *unit_get_exec_context(const Unit *u) {
4440 size_t offset;
4441 assert(u);
4442
4443 if (u->type < 0)
4444 return NULL;
4445
4446 offset = UNIT_VTABLE(u)->exec_context_offset;
4447 if (offset <= 0)
4448 return NULL;
4449
4450 return (ExecContext*) ((uint8_t*) u + offset);
4451 }
4452
4453 KillContext *unit_get_kill_context(Unit *u) {
4454 size_t offset;
4455 assert(u);
4456
4457 if (u->type < 0)
4458 return NULL;
4459
4460 offset = UNIT_VTABLE(u)->kill_context_offset;
4461 if (offset <= 0)
4462 return NULL;
4463
4464 return (KillContext*) ((uint8_t*) u + offset);
4465 }
4466
4467 CGroupContext *unit_get_cgroup_context(Unit *u) {
4468 size_t offset;
4469
4470 if (u->type < 0)
4471 return NULL;
4472
4473 offset = UNIT_VTABLE(u)->cgroup_context_offset;
4474 if (offset <= 0)
4475 return NULL;
4476
4477 return (CGroupContext*) ((uint8_t*) u + offset);
4478 }
4479
4480 ExecRuntime *unit_get_exec_runtime(Unit *u) {
4481 size_t offset;
4482
4483 if (u->type < 0)
4484 return NULL;
4485
4486 offset = UNIT_VTABLE(u)->exec_runtime_offset;
4487 if (offset <= 0)
4488 return NULL;
4489
4490 return *(ExecRuntime**) ((uint8_t*) u + offset);
4491 }
4492
4493 static const char* unit_drop_in_dir(Unit *u, UnitWriteFlags flags) {
4494 assert(u);
4495
4496 if (UNIT_WRITE_FLAGS_NOOP(flags))
4497 return NULL;
4498
4499 if (u->transient) /* Redirect drop-ins for transient units always into the transient directory. */
4500 return u->manager->lookup_paths.transient;
4501
4502 if (flags & UNIT_PERSISTENT)
4503 return u->manager->lookup_paths.persistent_control;
4504
4505 if (flags & UNIT_RUNTIME)
4506 return u->manager->lookup_paths.runtime_control;
4507
4508 return NULL;
4509 }
4510
4511 const char* unit_escape_setting(const char *s, UnitWriteFlags flags, char **buf) {
4512 assert(s);
4513 assert(popcount(flags & (UNIT_ESCAPE_EXEC_SYNTAX_ENV | UNIT_ESCAPE_EXEC_SYNTAX | UNIT_ESCAPE_C)) <= 1);
4514 assert(buf);
4515
4516 _cleanup_free_ char *t = NULL;
4517
4518 /* Returns a string with any escaping done. If no escaping was necessary, *buf is set to NULL, and
4519 * the input pointer is returned as-is. If an allocation was needed, the return buffer pointer is
4520 * written to *buf. This means the return value always contains a properly escaped version, but *buf
4521 * only contains a pointer if an allocation was made. Callers can use this to optimize memory
4522 * allocations. */
4523
4524 if (flags & UNIT_ESCAPE_SPECIFIERS) {
4525 t = specifier_escape(s);
4526 if (!t)
4527 return NULL;
4528
4529 s = t;
4530 }
4531
4532 /* We either do C-escaping or shell-escaping, to additionally escape characters that we parse for
4533 * ExecStart= and friends, i.e. '$' and quotes. */
4534
4535 if (flags & (UNIT_ESCAPE_EXEC_SYNTAX_ENV | UNIT_ESCAPE_EXEC_SYNTAX)) {
4536 char *t2;
4537
4538 if (flags & UNIT_ESCAPE_EXEC_SYNTAX_ENV) {
4539 t2 = strreplace(s, "$", "$$");
4540 if (!t2)
4541 return NULL;
4542 free_and_replace(t, t2);
4543 }
4544
4545 t2 = shell_escape(t ?: s, "\"");
4546 if (!t2)
4547 return NULL;
4548 free_and_replace(t, t2);
4549
4550 s = t;
4551
4552 } else if (flags & UNIT_ESCAPE_C) {
4553 char *t2;
4554
4555 t2 = cescape(s);
4556 if (!t2)
4557 return NULL;
4558 free_and_replace(t, t2);
4559
4560 s = t;
4561 }
4562
4563 *buf = TAKE_PTR(t);
4564 return s;
4565 }
4566
4567 char* unit_concat_strv(char **l, UnitWriteFlags flags) {
4568 _cleanup_free_ char *result = NULL;
4569 size_t n = 0;
4570
4571 /* Takes a list of strings, escapes them, and concatenates them. This may be used to format command
4572 * lines in a way suitable for ExecStart= stanzas. */
4573
4574 STRV_FOREACH(i, l) {
4575 _cleanup_free_ char *buf = NULL;
4576 const char *p;
4577 size_t a;
4578 char *q;
4579
4580 p = unit_escape_setting(*i, flags, &buf);
4581 if (!p)
4582 return NULL;
4583
4584 a = (n > 0) + 1 + strlen(p) + 1; /* separating space + " + entry + " */
4585 if (!GREEDY_REALLOC(result, n + a + 1))
4586 return NULL;
4587
4588 q = result + n;
4589 if (n > 0)
4590 *(q++) = ' ';
4591
4592 *(q++) = '"';
4593 q = stpcpy(q, p);
4594 *(q++) = '"';
4595
4596 n += a;
4597 }
4598
4599 if (!GREEDY_REALLOC(result, n + 1))
4600 return NULL;
4601
4602 result[n] = 0;
4603
4604 return TAKE_PTR(result);
4605 }
4606
4607 int unit_write_setting(Unit *u, UnitWriteFlags flags, const char *name, const char *data) {
4608 _cleanup_free_ char *p = NULL, *q = NULL, *escaped = NULL;
4609 const char *dir, *wrapped;
4610 int r;
4611
4612 assert(u);
4613 assert(name);
4614 assert(data);
4615
4616 if (UNIT_WRITE_FLAGS_NOOP(flags))
4617 return 0;
4618
4619 data = unit_escape_setting(data, flags, &escaped);
4620 if (!data)
4621 return -ENOMEM;
4622
4623 /* Prefix the section header. If we are writing this out as transient file, then let's suppress this if the
4624 * previous section header is the same */
4625
4626 if (flags & UNIT_PRIVATE) {
4627 if (!UNIT_VTABLE(u)->private_section)
4628 return -EINVAL;
4629
4630 if (!u->transient_file || u->last_section_private < 0)
4631 data = strjoina("[", UNIT_VTABLE(u)->private_section, "]\n", data);
4632 else if (u->last_section_private == 0)
4633 data = strjoina("\n[", UNIT_VTABLE(u)->private_section, "]\n", data);
4634 } else {
4635 if (!u->transient_file || u->last_section_private < 0)
4636 data = strjoina("[Unit]\n", data);
4637 else if (u->last_section_private > 0)
4638 data = strjoina("\n[Unit]\n", data);
4639 }
4640
4641 if (u->transient_file) {
4642 /* When this is a transient unit file in creation, then let's not create a new drop-in but instead
4643 * write to the transient unit file. */
4644 fputs(data, u->transient_file);
4645
4646 if (!endswith(data, "\n"))
4647 fputc('\n', u->transient_file);
4648
4649 /* Remember which section we wrote this entry to */
4650 u->last_section_private = !!(flags & UNIT_PRIVATE);
4651 return 0;
4652 }
4653
4654 dir = unit_drop_in_dir(u, flags);
4655 if (!dir)
4656 return -EINVAL;
4657
4658 wrapped = strjoina("# This is a drop-in unit file extension, created via \"systemctl set-property\"\n"
4659 "# or an equivalent operation. Do not edit.\n",
4660 data,
4661 "\n");
4662
4663 r = drop_in_file(dir, u->id, 50, name, &p, &q);
4664 if (r < 0)
4665 return r;
4666
4667 (void) mkdir_p_label(p, 0755);
4668
4669 /* Make sure the drop-in dir is registered in our path cache. This way we don't need to stupidly
4670 * recreate the cache after every drop-in we write. */
4671 if (u->manager->unit_path_cache) {
4672 r = set_put_strdup(&u->manager->unit_path_cache, p);
4673 if (r < 0)
4674 return r;
4675 }
4676
4677 r = write_string_file_atomic_label(q, wrapped);
4678 if (r < 0)
4679 return r;
4680
4681 r = strv_push(&u->dropin_paths, q);
4682 if (r < 0)
4683 return r;
4684 q = NULL;
4685
4686 strv_uniq(u->dropin_paths);
4687
4688 u->dropin_mtime = now(CLOCK_REALTIME);
4689
4690 return 0;
4691 }
4692
4693 int unit_write_settingf(Unit *u, UnitWriteFlags flags, const char *name, const char *format, ...) {
4694 _cleanup_free_ char *p = NULL;
4695 va_list ap;
4696 int r;
4697
4698 assert(u);
4699 assert(name);
4700 assert(format);
4701
4702 if (UNIT_WRITE_FLAGS_NOOP(flags))
4703 return 0;
4704
4705 va_start(ap, format);
4706 r = vasprintf(&p, format, ap);
4707 va_end(ap);
4708
4709 if (r < 0)
4710 return -ENOMEM;
4711
4712 return unit_write_setting(u, flags, name, p);
4713 }
4714
4715 int unit_make_transient(Unit *u) {
4716 _cleanup_free_ char *path = NULL;
4717 FILE *f;
4718
4719 assert(u);
4720
4721 if (!UNIT_VTABLE(u)->can_transient)
4722 return -EOPNOTSUPP;
4723
4724 (void) mkdir_p_label(u->manager->lookup_paths.transient, 0755);
4725
4726 path = path_join(u->manager->lookup_paths.transient, u->id);
4727 if (!path)
4728 return -ENOMEM;
4729
4730 /* Let's open the file we'll write the transient settings into. This file is kept open as long as we are
4731 * creating the transient, and is closed in unit_load(), as soon as we start loading the file. */
4732
4733 WITH_UMASK(0022) {
4734 f = fopen(path, "we");
4735 if (!f)
4736 return -errno;
4737 }
4738
4739 safe_fclose(u->transient_file);
4740 u->transient_file = f;
4741
4742 free_and_replace(u->fragment_path, path);
4743
4744 u->source_path = mfree(u->source_path);
4745 u->dropin_paths = strv_free(u->dropin_paths);
4746 u->fragment_mtime = u->source_mtime = u->dropin_mtime = 0;
4747
4748 u->load_state = UNIT_STUB;
4749 u->load_error = 0;
4750 u->transient = true;
4751
4752 unit_add_to_dbus_queue(u);
4753 unit_add_to_gc_queue(u);
4754
4755 fputs("# This is a transient unit file, created programmatically via the systemd API. Do not edit.\n",
4756 u->transient_file);
4757
4758 return 0;
4759 }
4760
4761 static int log_kill(pid_t pid, int sig, void *userdata) {
4762 _cleanup_free_ char *comm = NULL;
4763
4764 (void) get_process_comm(pid, &comm);
4765
4766 /* Don't log about processes marked with brackets, under the assumption that these are temporary processes
4767 only, like for example systemd's own PAM stub process. */
4768 if (comm && comm[0] == '(')
4769 /* Although we didn't log anything, as this callback is used in unit_kill_context we must return 1
4770 * here to let the manager know that a process was killed. */
4771 return 1;
4772
4773 log_unit_notice(userdata,
4774 "Killing process " PID_FMT " (%s) with signal SIG%s.",
4775 pid,
4776 strna(comm),
4777 signal_to_string(sig));
4778
4779 return 1;
4780 }
4781
4782 static int operation_to_signal(
4783 const KillContext *c,
4784 KillOperation k,
4785 bool *ret_noteworthy) {
4786
4787 assert(c);
4788
4789 switch (k) {
4790
4791 case KILL_TERMINATE:
4792 case KILL_TERMINATE_AND_LOG:
4793 *ret_noteworthy = false;
4794 return c->kill_signal;
4795
4796 case KILL_RESTART:
4797 *ret_noteworthy = false;
4798 return restart_kill_signal(c);
4799
4800 case KILL_KILL:
4801 *ret_noteworthy = true;
4802 return c->final_kill_signal;
4803
4804 case KILL_WATCHDOG:
4805 *ret_noteworthy = true;
4806 return c->watchdog_signal;
4807
4808 default:
4809 assert_not_reached();
4810 }
4811 }
4812
4813 int unit_kill_context(
4814 Unit *u,
4815 KillContext *c,
4816 KillOperation k,
4817 PidRef* main_pid,
4818 PidRef* control_pid,
4819 bool main_pid_alien) {
4820
4821 bool wait_for_exit = false, send_sighup;
4822 cg_kill_log_func_t log_func = NULL;
4823 int sig, r;
4824
4825 assert(u);
4826 assert(c);
4827
4828 /* Kill the processes belonging to this unit, in preparation for shutting the unit down. Returns > 0
4829 * if we killed something worth waiting for, 0 otherwise. Do not confuse with unit_kill_common()
4830 * which is used for user-requested killing of unit processes. */
4831
4832 if (c->kill_mode == KILL_NONE)
4833 return 0;
4834
4835 bool noteworthy;
4836 sig = operation_to_signal(c, k, &noteworthy);
4837 if (noteworthy)
4838 log_func = log_kill;
4839
4840 send_sighup =
4841 c->send_sighup &&
4842 IN_SET(k, KILL_TERMINATE, KILL_TERMINATE_AND_LOG) &&
4843 sig != SIGHUP;
4844
4845 if (pidref_is_set(main_pid)) {
4846 if (log_func)
4847 log_func(main_pid->pid, sig, u);
4848
4849 r = pidref_kill_and_sigcont(main_pid, sig);
4850 if (r < 0 && r != -ESRCH) {
4851 _cleanup_free_ char *comm = NULL;
4852 (void) get_process_comm(main_pid->pid, &comm);
4853
4854 log_unit_warning_errno(u, r, "Failed to kill main process " PID_FMT " (%s), ignoring: %m", main_pid->pid, strna(comm));
4855 } else {
4856 if (!main_pid_alien)
4857 wait_for_exit = true;
4858
4859 if (r != -ESRCH && send_sighup)
4860 (void) pidref_kill(main_pid, SIGHUP);
4861 }
4862 }
4863
4864 if (pidref_is_set(control_pid)) {
4865 if (log_func)
4866 log_func(control_pid->pid, sig, u);
4867
4868 r = pidref_kill_and_sigcont(control_pid, sig);
4869 if (r < 0 && r != -ESRCH) {
4870 _cleanup_free_ char *comm = NULL;
4871 (void) get_process_comm(control_pid->pid, &comm);
4872
4873 log_unit_warning_errno(u, r, "Failed to kill control process " PID_FMT " (%s), ignoring: %m", control_pid->pid, strna(comm));
4874 } else {
4875 wait_for_exit = true;
4876
4877 if (r != -ESRCH && send_sighup)
4878 (void) pidref_kill(control_pid, SIGHUP);
4879 }
4880 }
4881
4882 if (u->cgroup_path &&
4883 (c->kill_mode == KILL_CONTROL_GROUP || (c->kill_mode == KILL_MIXED && k == KILL_KILL))) {
4884 _cleanup_set_free_ Set *pid_set = NULL;
4885
4886 /* Exclude the main/control pids from being killed via the cgroup */
4887 pid_set = unit_pid_set(main_pid ? main_pid->pid : 0, control_pid ? control_pid->pid : 0);
4888 if (!pid_set)
4889 return -ENOMEM;
4890
4891 r = cg_kill_recursive(
4892 u->cgroup_path,
4893 sig,
4894 CGROUP_SIGCONT|CGROUP_IGNORE_SELF,
4895 pid_set,
4896 log_func, u);
4897 if (r < 0) {
4898 if (!IN_SET(r, -EAGAIN, -ESRCH, -ENOENT))
4899 log_unit_warning_errno(u, r, "Failed to kill control group %s, ignoring: %m", empty_to_root(u->cgroup_path));
4900
4901 } else if (r > 0) {
4902
4903 /* FIXME: For now, on the legacy hierarchy, we will not wait for the cgroup members to die if
4904 * we are running in a container or if this is a delegation unit, simply because cgroup
4905 * notification is unreliable in these cases. It doesn't work at all in containers, and outside
4906 * of containers it can be confused easily by left-over directories in the cgroup — which
4907 * however should not exist in non-delegated units. On the unified hierarchy that's different,
4908 * there we get proper events. Hence rely on them. */
4909
4910 if (cg_unified_controller(SYSTEMD_CGROUP_CONTROLLER) > 0 ||
4911 (detect_container() == 0 && !unit_cgroup_delegate(u)))
4912 wait_for_exit = true;
4913
4914 if (send_sighup) {
4915 set_free(pid_set);
4916
4917 pid_set = unit_pid_set(main_pid ? main_pid->pid : 0, control_pid ? control_pid->pid : 0);
4918 if (!pid_set)
4919 return -ENOMEM;
4920
4921 (void) cg_kill_recursive(
4922 u->cgroup_path,
4923 SIGHUP,
4924 CGROUP_IGNORE_SELF,
4925 pid_set,
4926 /* kill_log= */ NULL,
4927 /* userdata= */ NULL);
4928 }
4929 }
4930 }
4931
4932 return wait_for_exit;
4933 }
4934
4935 int unit_require_mounts_for(Unit *u, const char *path, UnitDependencyMask mask) {
4936 int r;
4937
4938 assert(u);
4939 assert(path);
4940
4941 /* Registers a unit for requiring a certain path and all its prefixes. We keep a hashtable of these
4942 * paths in the unit (from the path to the UnitDependencyInfo structure indicating how to the
4943 * dependency came to be). However, we build a prefix table for all possible prefixes so that new
4944 * appearing mount units can easily determine which units to make themselves a dependency of. */
4945
4946 if (!path_is_absolute(path))
4947 return -EINVAL;
4948
4949 if (hashmap_contains(u->requires_mounts_for, path)) /* Exit quickly if the path is already covered. */
4950 return 0;
4951
4952 _cleanup_free_ char *p = strdup(path);
4953 if (!p)
4954 return -ENOMEM;
4955
4956 /* Use the canonical form of the path as the stored key. We call path_is_normalized()
4957 * only after simplification, since path_is_normalized() rejects paths with '.'.
4958 * path_is_normalized() also verifies that the path fits in PATH_MAX. */
4959 path = path_simplify(p);
4960
4961 if (!path_is_normalized(path))
4962 return -EPERM;
4963
4964 UnitDependencyInfo di = {
4965 .origin_mask = mask
4966 };
4967
4968 r = hashmap_ensure_put(&u->requires_mounts_for, &path_hash_ops, p, di.data);
4969 if (r < 0)
4970 return r;
4971 assert(r > 0);
4972 TAKE_PTR(p); /* path remains a valid pointer to the string stored in the hashmap */
4973
4974 char prefix[strlen(path) + 1];
4975 PATH_FOREACH_PREFIX_MORE(prefix, path) {
4976 Set *x;
4977
4978 x = hashmap_get(u->manager->units_requiring_mounts_for, prefix);
4979 if (!x) {
4980 _cleanup_free_ char *q = NULL;
4981
4982 r = hashmap_ensure_allocated(&u->manager->units_requiring_mounts_for, &path_hash_ops);
4983 if (r < 0)
4984 return r;
4985
4986 q = strdup(prefix);
4987 if (!q)
4988 return -ENOMEM;
4989
4990 x = set_new(NULL);
4991 if (!x)
4992 return -ENOMEM;
4993
4994 r = hashmap_put(u->manager->units_requiring_mounts_for, q, x);
4995 if (r < 0) {
4996 set_free(x);
4997 return r;
4998 }
4999 q = NULL;
5000 }
5001
5002 r = set_put(x, u);
5003 if (r < 0)
5004 return r;
5005 }
5006
5007 return 0;
5008 }
5009
5010 int unit_setup_exec_runtime(Unit *u) {
5011 _cleanup_(exec_shared_runtime_unrefp) ExecSharedRuntime *esr = NULL;
5012 _cleanup_(dynamic_creds_unrefp) DynamicCreds *dcreds = NULL;
5013 _cleanup_set_free_ Set *units = NULL;
5014 ExecRuntime **rt;
5015 ExecContext *ec;
5016 size_t offset;
5017 Unit *other;
5018 int r;
5019
5020 offset = UNIT_VTABLE(u)->exec_runtime_offset;
5021 assert(offset > 0);
5022
5023 /* Check if there already is an ExecRuntime for this unit? */
5024 rt = (ExecRuntime**) ((uint8_t*) u + offset);
5025 if (*rt)
5026 return 0;
5027
5028 ec = unit_get_exec_context(u);
5029 assert(ec);
5030
5031 r = unit_get_transitive_dependency_set(u, UNIT_ATOM_JOINS_NAMESPACE_OF, &units);
5032 if (r < 0)
5033 return r;
5034
5035 /* Try to get it from somebody else */
5036 SET_FOREACH(other, units) {
5037 r = exec_shared_runtime_acquire(u->manager, NULL, other->id, false, &esr);
5038 if (r < 0)
5039 return r;
5040 if (r > 0)
5041 break;
5042 }
5043
5044 if (!esr) {
5045 r = exec_shared_runtime_acquire(u->manager, ec, u->id, true, &esr);
5046 if (r < 0)
5047 return r;
5048 }
5049
5050 if (ec->dynamic_user) {
5051 r = dynamic_creds_make(u->manager, ec->user, ec->group, &dcreds);
5052 if (r < 0)
5053 return r;
5054 }
5055
5056 r = exec_runtime_make(u, ec, esr, dcreds, rt);
5057 if (r < 0)
5058 return r;
5059
5060 TAKE_PTR(esr);
5061 TAKE_PTR(dcreds);
5062
5063 return r;
5064 }
5065
5066 bool unit_type_supported(UnitType t) {
5067 static int8_t cache[_UNIT_TYPE_MAX] = {}; /* -1: disabled, 1: enabled: 0: don't know */
5068 int r;
5069
5070 if (_unlikely_(t < 0))
5071 return false;
5072 if (_unlikely_(t >= _UNIT_TYPE_MAX))
5073 return false;
5074
5075 if (cache[t] == 0) {
5076 char *e;
5077
5078 e = strjoina("SYSTEMD_SUPPORT_", unit_type_to_string(t));
5079
5080 r = getenv_bool(ascii_strupper(e));
5081 if (r < 0 && r != -ENXIO)
5082 log_debug_errno(r, "Failed to parse $%s, ignoring: %m", e);
5083
5084 cache[t] = r == 0 ? -1 : 1;
5085 }
5086 if (cache[t] < 0)
5087 return false;
5088
5089 if (!unit_vtable[t]->supported)
5090 return true;
5091
5092 return unit_vtable[t]->supported();
5093 }
5094
5095 void unit_warn_if_dir_nonempty(Unit *u, const char* where) {
5096 int r;
5097
5098 assert(u);
5099 assert(where);
5100
5101 if (!unit_log_level_test(u, LOG_NOTICE))
5102 return;
5103
5104 r = dir_is_empty(where, /* ignore_hidden_or_backup= */ false);
5105 if (r > 0 || r == -ENOTDIR)
5106 return;
5107 if (r < 0) {
5108 log_unit_warning_errno(u, r, "Failed to check directory %s: %m", where);
5109 return;
5110 }
5111
5112 log_unit_struct(u, LOG_NOTICE,
5113 "MESSAGE_ID=" SD_MESSAGE_OVERMOUNTING_STR,
5114 LOG_UNIT_INVOCATION_ID(u),
5115 LOG_UNIT_MESSAGE(u, "Directory %s to mount over is not empty, mounting anyway.", where),
5116 "WHERE=%s", where);
5117 }
5118
5119 int unit_fail_if_noncanonical(Unit *u, const char* where) {
5120 _cleanup_free_ char *canonical_where = NULL;
5121 int r;
5122
5123 assert(u);
5124 assert(where);
5125
5126 r = chase(where, NULL, CHASE_NONEXISTENT, &canonical_where, NULL);
5127 if (r < 0) {
5128 log_unit_debug_errno(u, r, "Failed to check %s for symlinks, ignoring: %m", where);
5129 return 0;
5130 }
5131
5132 /* We will happily ignore a trailing slash (or any redundant slashes) */
5133 if (path_equal(where, canonical_where))
5134 return 0;
5135
5136 /* No need to mention "." or "..", they would already have been rejected by unit_name_from_path() */
5137 log_unit_struct(u, LOG_ERR,
5138 "MESSAGE_ID=" SD_MESSAGE_OVERMOUNTING_STR,
5139 LOG_UNIT_INVOCATION_ID(u),
5140 LOG_UNIT_MESSAGE(u, "Mount path %s is not canonical (contains a symlink).", where),
5141 "WHERE=%s", where);
5142
5143 return -ELOOP;
5144 }
5145
5146 bool unit_is_pristine(Unit *u) {
5147 assert(u);
5148
5149 /* Check if the unit already exists or is already around, in a number of different ways. Note that to
5150 * cater for unit types such as slice, we are generally fine with units that are marked UNIT_LOADED
5151 * even though nothing was actually loaded, as those unit types don't require a file on disk.
5152 *
5153 * Note that we don't check for drop-ins here, because we allow drop-ins for transient units
5154 * identically to non-transient units, both unit-specific and hierarchical. E.g. for a-b-c.service:
5155 * service.d/….conf, a-.service.d/….conf, a-b-.service.d/….conf, a-b-c.service.d/….conf.
5156 */
5157
5158 return IN_SET(u->load_state, UNIT_NOT_FOUND, UNIT_LOADED) &&
5159 !u->fragment_path &&
5160 !u->source_path &&
5161 !u->job &&
5162 !u->merged_into;
5163 }
5164
5165 PidRef* unit_control_pid(Unit *u) {
5166 assert(u);
5167
5168 if (UNIT_VTABLE(u)->control_pid)
5169 return UNIT_VTABLE(u)->control_pid(u);
5170
5171 return NULL;
5172 }
5173
5174 PidRef* unit_main_pid(Unit *u) {
5175 assert(u);
5176
5177 if (UNIT_VTABLE(u)->main_pid)
5178 return UNIT_VTABLE(u)->main_pid(u);
5179
5180 return NULL;
5181 }
5182
5183 static void unit_modify_user_nft_set(Unit *u, bool add, NFTSetSource source, uint32_t element) {
5184 int r;
5185
5186 assert(u);
5187
5188 if (!MANAGER_IS_SYSTEM(u->manager))
5189 return;
5190
5191 CGroupContext *c;
5192 c = unit_get_cgroup_context(u);
5193 if (!c)
5194 return;
5195
5196 if (!u->manager->fw_ctx) {
5197 r = fw_ctx_new_full(&u->manager->fw_ctx, /* init_tables= */ false);
5198 if (r < 0)
5199 return;
5200
5201 assert(u->manager->fw_ctx);
5202 }
5203
5204 FOREACH_ARRAY(nft_set, c->nft_set_context.sets, c->nft_set_context.n_sets) {
5205 if (nft_set->source != source)
5206 continue;
5207
5208 r = nft_set_element_modify_any(u->manager->fw_ctx, add, nft_set->nfproto, nft_set->table, nft_set->set, &element, sizeof(element));
5209 if (r < 0)
5210 log_warning_errno(r, "Failed to %s NFT set: family %s, table %s, set %s, ID %u, ignoring: %m",
5211 add? "add" : "delete", nfproto_to_string(nft_set->nfproto), nft_set->table, nft_set->set, element);
5212 else
5213 log_debug("%s NFT set: family %s, table %s, set %s, ID %u",
5214 add? "Added" : "Deleted", nfproto_to_string(nft_set->nfproto), nft_set->table, nft_set->set, element);
5215 }
5216 }
5217
5218 static void unit_unref_uid_internal(
5219 Unit *u,
5220 uid_t *ref_uid,
5221 bool destroy_now,
5222 void (*_manager_unref_uid)(Manager *m, uid_t uid, bool destroy_now)) {
5223
5224 assert(u);
5225 assert(ref_uid);
5226 assert(_manager_unref_uid);
5227
5228 /* Generic implementation of both unit_unref_uid() and unit_unref_gid(), under the assumption that uid_t and
5229 * gid_t are actually the same time, with the same validity rules.
5230 *
5231 * Drops a reference to UID/GID from a unit. */
5232
5233 assert_cc(sizeof(uid_t) == sizeof(gid_t));
5234 assert_cc(UID_INVALID == (uid_t) GID_INVALID);
5235
5236 if (!uid_is_valid(*ref_uid))
5237 return;
5238
5239 _manager_unref_uid(u->manager, *ref_uid, destroy_now);
5240 *ref_uid = UID_INVALID;
5241 }
5242
5243 static void unit_unref_uid(Unit *u, bool destroy_now) {
5244 assert(u);
5245
5246 unit_modify_user_nft_set(u, /* add = */ false, NFT_SET_SOURCE_USER, u->ref_uid);
5247
5248 unit_unref_uid_internal(u, &u->ref_uid, destroy_now, manager_unref_uid);
5249 }
5250
5251 static void unit_unref_gid(Unit *u, bool destroy_now) {
5252 assert(u);
5253
5254 unit_modify_user_nft_set(u, /* add = */ false, NFT_SET_SOURCE_GROUP, u->ref_gid);
5255
5256 unit_unref_uid_internal(u, (uid_t*) &u->ref_gid, destroy_now, manager_unref_gid);
5257 }
5258
5259 void unit_unref_uid_gid(Unit *u, bool destroy_now) {
5260 assert(u);
5261
5262 unit_unref_uid(u, destroy_now);
5263 unit_unref_gid(u, destroy_now);
5264 }
5265
5266 static int unit_ref_uid_internal(
5267 Unit *u,
5268 uid_t *ref_uid,
5269 uid_t uid,
5270 bool clean_ipc,
5271 int (*_manager_ref_uid)(Manager *m, uid_t uid, bool clean_ipc)) {
5272
5273 int r;
5274
5275 assert(u);
5276 assert(ref_uid);
5277 assert(uid_is_valid(uid));
5278 assert(_manager_ref_uid);
5279
5280 /* Generic implementation of both unit_ref_uid() and unit_ref_guid(), under the assumption that uid_t and gid_t
5281 * are actually the same type, and have the same validity rules.
5282 *
5283 * Adds a reference on a specific UID/GID to this unit. Each unit referencing the same UID/GID maintains a
5284 * reference so that we can destroy the UID/GID's IPC resources as soon as this is requested and the counter
5285 * drops to zero. */
5286
5287 assert_cc(sizeof(uid_t) == sizeof(gid_t));
5288 assert_cc(UID_INVALID == (uid_t) GID_INVALID);
5289
5290 if (*ref_uid == uid)
5291 return 0;
5292
5293 if (uid_is_valid(*ref_uid)) /* Already set? */
5294 return -EBUSY;
5295
5296 r = _manager_ref_uid(u->manager, uid, clean_ipc);
5297 if (r < 0)
5298 return r;
5299
5300 *ref_uid = uid;
5301 return 1;
5302 }
5303
5304 static int unit_ref_uid(Unit *u, uid_t uid, bool clean_ipc) {
5305 return unit_ref_uid_internal(u, &u->ref_uid, uid, clean_ipc, manager_ref_uid);
5306 }
5307
5308 static int unit_ref_gid(Unit *u, gid_t gid, bool clean_ipc) {
5309 return unit_ref_uid_internal(u, (uid_t*) &u->ref_gid, (uid_t) gid, clean_ipc, manager_ref_gid);
5310 }
5311
5312 static int unit_ref_uid_gid_internal(Unit *u, uid_t uid, gid_t gid, bool clean_ipc) {
5313 int r = 0, q = 0;
5314
5315 assert(u);
5316
5317 /* Reference both a UID and a GID in one go. Either references both, or neither. */
5318
5319 if (uid_is_valid(uid)) {
5320 r = unit_ref_uid(u, uid, clean_ipc);
5321 if (r < 0)
5322 return r;
5323 }
5324
5325 if (gid_is_valid(gid)) {
5326 q = unit_ref_gid(u, gid, clean_ipc);
5327 if (q < 0) {
5328 if (r > 0)
5329 unit_unref_uid(u, false);
5330
5331 return q;
5332 }
5333 }
5334
5335 return r > 0 || q > 0;
5336 }
5337
5338 int unit_ref_uid_gid(Unit *u, uid_t uid, gid_t gid) {
5339 ExecContext *c;
5340 int r;
5341
5342 assert(u);
5343
5344 c = unit_get_exec_context(u);
5345
5346 r = unit_ref_uid_gid_internal(u, uid, gid, c ? c->remove_ipc : false);
5347 if (r < 0)
5348 return log_unit_warning_errno(u, r, "Couldn't add UID/GID reference to unit, proceeding without: %m");
5349
5350 unit_modify_user_nft_set(u, /* add = */ true, NFT_SET_SOURCE_USER, uid);
5351 unit_modify_user_nft_set(u, /* add = */ true, NFT_SET_SOURCE_GROUP, gid);
5352
5353 return r;
5354 }
5355
5356 void unit_notify_user_lookup(Unit *u, uid_t uid, gid_t gid) {
5357 int r;
5358
5359 assert(u);
5360
5361 /* This is invoked whenever one of the forked off processes let's us know the UID/GID its user name/group names
5362 * resolved to. We keep track of which UID/GID is currently assigned in order to be able to destroy its IPC
5363 * objects when no service references the UID/GID anymore. */
5364
5365 r = unit_ref_uid_gid(u, uid, gid);
5366 if (r > 0)
5367 unit_add_to_dbus_queue(u);
5368 }
5369
5370 int unit_acquire_invocation_id(Unit *u) {
5371 sd_id128_t id;
5372 int r;
5373
5374 assert(u);
5375
5376 r = sd_id128_randomize(&id);
5377 if (r < 0)
5378 return log_unit_error_errno(u, r, "Failed to generate invocation ID for unit: %m");
5379
5380 r = unit_set_invocation_id(u, id);
5381 if (r < 0)
5382 return log_unit_error_errno(u, r, "Failed to set invocation ID for unit: %m");
5383
5384 unit_add_to_dbus_queue(u);
5385 return 0;
5386 }
5387
5388 int unit_set_exec_params(Unit *u, ExecParameters *p) {
5389 int r;
5390
5391 assert(u);
5392 assert(p);
5393
5394 /* Copy parameters from manager */
5395 r = manager_get_effective_environment(u->manager, &p->environment);
5396 if (r < 0)
5397 return r;
5398
5399 p->runtime_scope = u->manager->runtime_scope;
5400
5401 p->confirm_spawn = manager_get_confirm_spawn(u->manager);
5402 p->cgroup_supported = u->manager->cgroup_supported;
5403 p->prefix = u->manager->prefix;
5404 SET_FLAG(p->flags, EXEC_PASS_LOG_UNIT|EXEC_CHOWN_DIRECTORIES, MANAGER_IS_SYSTEM(u->manager));
5405
5406 /* Copy parameters from unit */
5407 p->cgroup_path = u->cgroup_path;
5408 SET_FLAG(p->flags, EXEC_CGROUP_DELEGATE, unit_cgroup_delegate(u));
5409
5410 p->received_credentials_directory = u->manager->received_credentials_directory;
5411 p->received_encrypted_credentials_directory = u->manager->received_encrypted_credentials_directory;
5412
5413 return 0;
5414 }
5415
5416 int unit_fork_helper_process(Unit *u, const char *name, PidRef *ret) {
5417 pid_t pid;
5418 int r;
5419
5420 assert(u);
5421 assert(ret);
5422
5423 /* Forks off a helper process and makes sure it is a member of the unit's cgroup. Returns == 0 in the child,
5424 * and > 0 in the parent. The pid parameter is always filled in with the child's PID. */
5425
5426 (void) unit_realize_cgroup(u);
5427
5428 r = safe_fork(name, FORK_REOPEN_LOG|FORK_DEATHSIG, &pid);
5429 if (r < 0)
5430 return r;
5431 if (r > 0) {
5432 _cleanup_(pidref_done) PidRef pidref = PIDREF_NULL;
5433 int q;
5434
5435 /* Parent */
5436
5437 q = pidref_set_pid(&pidref, pid);
5438 if (q < 0)
5439 return q;
5440
5441 *ret = TAKE_PIDREF(pidref);
5442 return r;
5443 }
5444
5445 /* Child */
5446
5447 (void) default_signals(SIGNALS_CRASH_HANDLER, SIGNALS_IGNORE);
5448 (void) ignore_signals(SIGPIPE);
5449
5450 if (u->cgroup_path) {
5451 r = cg_attach_everywhere(u->manager->cgroup_supported, u->cgroup_path, 0, NULL, NULL);
5452 if (r < 0) {
5453 log_unit_error_errno(u, r, "Failed to join unit cgroup %s: %m", empty_to_root(u->cgroup_path));
5454 _exit(EXIT_CGROUP);
5455 }
5456 }
5457
5458 return 0;
5459 }
5460
5461 int unit_fork_and_watch_rm_rf(Unit *u, char **paths, PidRef *ret_pid) {
5462 _cleanup_(pidref_done) PidRef pid = PIDREF_NULL;
5463 int r;
5464
5465 assert(u);
5466 assert(ret_pid);
5467
5468 r = unit_fork_helper_process(u, "(sd-rmrf)", &pid);
5469 if (r < 0)
5470 return r;
5471 if (r == 0) {
5472 int ret = EXIT_SUCCESS;
5473
5474 STRV_FOREACH(i, paths) {
5475 r = rm_rf(*i, REMOVE_ROOT|REMOVE_PHYSICAL|REMOVE_MISSING_OK);
5476 if (r < 0) {
5477 log_error_errno(r, "Failed to remove '%s': %m", *i);
5478 ret = EXIT_FAILURE;
5479 }
5480 }
5481
5482 _exit(ret);
5483 }
5484
5485 r = unit_watch_pidref(u, &pid, /* exclusive= */ true);
5486 if (r < 0)
5487 return r;
5488
5489 *ret_pid = TAKE_PIDREF(pid);
5490 return 0;
5491 }
5492
5493 static void unit_update_dependency_mask(Hashmap *deps, Unit *other, UnitDependencyInfo di) {
5494 assert(deps);
5495 assert(other);
5496
5497 if (di.origin_mask == 0 && di.destination_mask == 0)
5498 /* No bit set anymore, let's drop the whole entry */
5499 assert_se(hashmap_remove(deps, other));
5500 else
5501 /* Mask was reduced, let's update the entry */
5502 assert_se(hashmap_update(deps, other, di.data) == 0);
5503 }
5504
5505 void unit_remove_dependencies(Unit *u, UnitDependencyMask mask) {
5506 Hashmap *deps;
5507 assert(u);
5508
5509 /* Removes all dependencies u has on other units marked for ownership by 'mask'. */
5510
5511 if (mask == 0)
5512 return;
5513
5514 HASHMAP_FOREACH(deps, u->dependencies) {
5515 bool done;
5516
5517 do {
5518 UnitDependencyInfo di;
5519 Unit *other;
5520
5521 done = true;
5522
5523 HASHMAP_FOREACH_KEY(di.data, other, deps) {
5524 Hashmap *other_deps;
5525
5526 if (FLAGS_SET(~mask, di.origin_mask))
5527 continue;
5528
5529 di.origin_mask &= ~mask;
5530 unit_update_dependency_mask(deps, other, di);
5531
5532 /* We updated the dependency from our unit to the other unit now. But most
5533 * dependencies imply a reverse dependency. Hence, let's delete that one
5534 * too. For that we go through all dependency types on the other unit and
5535 * delete all those which point to us and have the right mask set. */
5536
5537 HASHMAP_FOREACH(other_deps, other->dependencies) {
5538 UnitDependencyInfo dj;
5539
5540 dj.data = hashmap_get(other_deps, u);
5541 if (FLAGS_SET(~mask, dj.destination_mask))
5542 continue;
5543
5544 dj.destination_mask &= ~mask;
5545 unit_update_dependency_mask(other_deps, u, dj);
5546 }
5547
5548 unit_add_to_gc_queue(other);
5549
5550 /* The unit 'other' may not be wanted by the unit 'u'. */
5551 unit_submit_to_stop_when_unneeded_queue(other);
5552
5553 done = false;
5554 break;
5555 }
5556
5557 } while (!done);
5558 }
5559 }
5560
5561 static int unit_get_invocation_path(Unit *u, char **ret) {
5562 char *p;
5563 int r;
5564
5565 assert(u);
5566 assert(ret);
5567
5568 if (MANAGER_IS_SYSTEM(u->manager))
5569 p = strjoin("/run/systemd/units/invocation:", u->id);
5570 else {
5571 _cleanup_free_ char *user_path = NULL;
5572 r = xdg_user_runtime_dir(&user_path, "/systemd/units/invocation:");
5573 if (r < 0)
5574 return r;
5575 p = strjoin(user_path, u->id);
5576 }
5577
5578 if (!p)
5579 return -ENOMEM;
5580
5581 *ret = p;
5582 return 0;
5583 }
5584
5585 static int unit_export_invocation_id(Unit *u) {
5586 _cleanup_free_ char *p = NULL;
5587 int r;
5588
5589 assert(u);
5590
5591 if (u->exported_invocation_id)
5592 return 0;
5593
5594 if (sd_id128_is_null(u->invocation_id))
5595 return 0;
5596
5597 r = unit_get_invocation_path(u, &p);
5598 if (r < 0)
5599 return log_unit_debug_errno(u, r, "Failed to get invocation path: %m");
5600
5601 r = symlink_atomic_label(u->invocation_id_string, p);
5602 if (r < 0)
5603 return log_unit_debug_errno(u, r, "Failed to create invocation ID symlink %s: %m", p);
5604
5605 u->exported_invocation_id = true;
5606 return 0;
5607 }
5608
5609 static int unit_export_log_level_max(Unit *u, const ExecContext *c) {
5610 const char *p;
5611 char buf[2];
5612 int r;
5613
5614 assert(u);
5615 assert(c);
5616
5617 if (u->exported_log_level_max)
5618 return 0;
5619
5620 if (c->log_level_max < 0)
5621 return 0;
5622
5623 assert(c->log_level_max <= 7);
5624
5625 buf[0] = '0' + c->log_level_max;
5626 buf[1] = 0;
5627
5628 p = strjoina("/run/systemd/units/log-level-max:", u->id);
5629 r = symlink_atomic(buf, p);
5630 if (r < 0)
5631 return log_unit_debug_errno(u, r, "Failed to create maximum log level symlink %s: %m", p);
5632
5633 u->exported_log_level_max = true;
5634 return 0;
5635 }
5636
5637 static int unit_export_log_extra_fields(Unit *u, const ExecContext *c) {
5638 _cleanup_close_ int fd = -EBADF;
5639 struct iovec *iovec;
5640 const char *p;
5641 char *pattern;
5642 le64_t *sizes;
5643 ssize_t n;
5644 int r;
5645
5646 if (u->exported_log_extra_fields)
5647 return 0;
5648
5649 if (c->n_log_extra_fields <= 0)
5650 return 0;
5651
5652 sizes = newa(le64_t, c->n_log_extra_fields);
5653 iovec = newa(struct iovec, c->n_log_extra_fields * 2);
5654
5655 for (size_t i = 0; i < c->n_log_extra_fields; i++) {
5656 sizes[i] = htole64(c->log_extra_fields[i].iov_len);
5657
5658 iovec[i*2] = IOVEC_MAKE(sizes + i, sizeof(le64_t));
5659 iovec[i*2+1] = c->log_extra_fields[i];
5660 }
5661
5662 p = strjoina("/run/systemd/units/log-extra-fields:", u->id);
5663 pattern = strjoina(p, ".XXXXXX");
5664
5665 fd = mkostemp_safe(pattern);
5666 if (fd < 0)
5667 return log_unit_debug_errno(u, fd, "Failed to create extra fields file %s: %m", p);
5668
5669 n = writev(fd, iovec, c->n_log_extra_fields*2);
5670 if (n < 0) {
5671 r = log_unit_debug_errno(u, errno, "Failed to write extra fields: %m");
5672 goto fail;
5673 }
5674
5675 (void) fchmod(fd, 0644);
5676
5677 if (rename(pattern, p) < 0) {
5678 r = log_unit_debug_errno(u, errno, "Failed to rename extra fields file: %m");
5679 goto fail;
5680 }
5681
5682 u->exported_log_extra_fields = true;
5683 return 0;
5684
5685 fail:
5686 (void) unlink(pattern);
5687 return r;
5688 }
5689
5690 static int unit_export_log_ratelimit_interval(Unit *u, const ExecContext *c) {
5691 _cleanup_free_ char *buf = NULL;
5692 const char *p;
5693 int r;
5694
5695 assert(u);
5696 assert(c);
5697
5698 if (u->exported_log_ratelimit_interval)
5699 return 0;
5700
5701 if (c->log_ratelimit_interval_usec == 0)
5702 return 0;
5703
5704 p = strjoina("/run/systemd/units/log-rate-limit-interval:", u->id);
5705
5706 if (asprintf(&buf, "%" PRIu64, c->log_ratelimit_interval_usec) < 0)
5707 return log_oom();
5708
5709 r = symlink_atomic(buf, p);
5710 if (r < 0)
5711 return log_unit_debug_errno(u, r, "Failed to create log rate limit interval symlink %s: %m", p);
5712
5713 u->exported_log_ratelimit_interval = true;
5714 return 0;
5715 }
5716
5717 static int unit_export_log_ratelimit_burst(Unit *u, const ExecContext *c) {
5718 _cleanup_free_ char *buf = NULL;
5719 const char *p;
5720 int r;
5721
5722 assert(u);
5723 assert(c);
5724
5725 if (u->exported_log_ratelimit_burst)
5726 return 0;
5727
5728 if (c->log_ratelimit_burst == 0)
5729 return 0;
5730
5731 p = strjoina("/run/systemd/units/log-rate-limit-burst:", u->id);
5732
5733 if (asprintf(&buf, "%u", c->log_ratelimit_burst) < 0)
5734 return log_oom();
5735
5736 r = symlink_atomic(buf, p);
5737 if (r < 0)
5738 return log_unit_debug_errno(u, r, "Failed to create log rate limit burst symlink %s: %m", p);
5739
5740 u->exported_log_ratelimit_burst = true;
5741 return 0;
5742 }
5743
5744 void unit_export_state_files(Unit *u) {
5745 const ExecContext *c;
5746
5747 assert(u);
5748
5749 if (!u->id)
5750 return;
5751
5752 if (MANAGER_IS_TEST_RUN(u->manager))
5753 return;
5754
5755 /* Exports a couple of unit properties to /run/systemd/units/, so that journald can quickly query this data
5756 * from there. Ideally, journald would use IPC to query this, like everybody else, but that's hard, as long as
5757 * the IPC system itself and PID 1 also log to the journal.
5758 *
5759 * Note that these files really shouldn't be considered API for anyone else, as use a runtime file system as
5760 * IPC replacement is not compatible with today's world of file system namespaces. However, this doesn't really
5761 * apply to communication between the journal and systemd, as we assume that these two daemons live in the same
5762 * namespace at least.
5763 *
5764 * Note that some of the "files" exported here are actually symlinks and not regular files. Symlinks work
5765 * better for storing small bits of data, in particular as we can write them with two system calls, and read
5766 * them with one. */
5767
5768 (void) unit_export_invocation_id(u);
5769
5770 if (!MANAGER_IS_SYSTEM(u->manager))
5771 return;
5772
5773 c = unit_get_exec_context(u);
5774 if (c) {
5775 (void) unit_export_log_level_max(u, c);
5776 (void) unit_export_log_extra_fields(u, c);
5777 (void) unit_export_log_ratelimit_interval(u, c);
5778 (void) unit_export_log_ratelimit_burst(u, c);
5779 }
5780 }
5781
5782 void unit_unlink_state_files(Unit *u) {
5783 const char *p;
5784
5785 assert(u);
5786
5787 if (!u->id)
5788 return;
5789
5790 /* Undoes the effect of unit_export_state() */
5791
5792 if (u->exported_invocation_id) {
5793 _cleanup_free_ char *invocation_path = NULL;
5794 int r = unit_get_invocation_path(u, &invocation_path);
5795 if (r >= 0) {
5796 (void) unlink(invocation_path);
5797 u->exported_invocation_id = false;
5798 }
5799 }
5800
5801 if (!MANAGER_IS_SYSTEM(u->manager))
5802 return;
5803
5804 if (u->exported_log_level_max) {
5805 p = strjoina("/run/systemd/units/log-level-max:", u->id);
5806 (void) unlink(p);
5807
5808 u->exported_log_level_max = false;
5809 }
5810
5811 if (u->exported_log_extra_fields) {
5812 p = strjoina("/run/systemd/units/extra-fields:", u->id);
5813 (void) unlink(p);
5814
5815 u->exported_log_extra_fields = false;
5816 }
5817
5818 if (u->exported_log_ratelimit_interval) {
5819 p = strjoina("/run/systemd/units/log-rate-limit-interval:", u->id);
5820 (void) unlink(p);
5821
5822 u->exported_log_ratelimit_interval = false;
5823 }
5824
5825 if (u->exported_log_ratelimit_burst) {
5826 p = strjoina("/run/systemd/units/log-rate-limit-burst:", u->id);
5827 (void) unlink(p);
5828
5829 u->exported_log_ratelimit_burst = false;
5830 }
5831 }
5832
5833 int unit_prepare_exec(Unit *u) {
5834 int r;
5835
5836 assert(u);
5837
5838 /* Load any custom firewall BPF programs here once to test if they are existing and actually loadable.
5839 * Fail here early since later errors in the call chain unit_realize_cgroup to cgroup_context_apply are ignored. */
5840 r = bpf_firewall_load_custom(u);
5841 if (r < 0)
5842 return r;
5843
5844 /* Prepares everything so that we can fork of a process for this unit */
5845
5846 (void) unit_realize_cgroup(u);
5847
5848 if (u->reset_accounting) {
5849 (void) unit_reset_accounting(u);
5850 u->reset_accounting = false;
5851 }
5852
5853 unit_export_state_files(u);
5854
5855 r = unit_setup_exec_runtime(u);
5856 if (r < 0)
5857 return r;
5858
5859 return 0;
5860 }
5861
5862 static bool ignore_leftover_process(const char *comm) {
5863 return comm && comm[0] == '('; /* Most likely our own helper process (PAM?), ignore */
5864 }
5865
5866 int unit_log_leftover_process_start(pid_t pid, int sig, void *userdata) {
5867 _cleanup_free_ char *comm = NULL;
5868
5869 (void) get_process_comm(pid, &comm);
5870
5871 if (ignore_leftover_process(comm))
5872 return 0;
5873
5874 /* During start we print a warning */
5875
5876 log_unit_warning(userdata,
5877 "Found left-over process " PID_FMT " (%s) in control group while starting unit. Ignoring.\n"
5878 "This usually indicates unclean termination of a previous run, or service implementation deficiencies.",
5879 pid, strna(comm));
5880
5881 return 1;
5882 }
5883
5884 int unit_log_leftover_process_stop(pid_t pid, int sig, void *userdata) {
5885 _cleanup_free_ char *comm = NULL;
5886
5887 (void) get_process_comm(pid, &comm);
5888
5889 if (ignore_leftover_process(comm))
5890 return 0;
5891
5892 /* During stop we only print an informational message */
5893
5894 log_unit_info(userdata,
5895 "Unit process " PID_FMT " (%s) remains running after unit stopped.",
5896 pid, strna(comm));
5897
5898 return 1;
5899 }
5900
5901 int unit_warn_leftover_processes(Unit *u, cg_kill_log_func_t log_func) {
5902 assert(u);
5903
5904 (void) unit_pick_cgroup_path(u);
5905
5906 if (!u->cgroup_path)
5907 return 0;
5908
5909 return cg_kill_recursive(
5910 u->cgroup_path,
5911 /* sig= */ 0,
5912 /* flags= */ 0,
5913 /* set= */ NULL,
5914 log_func,
5915 u);
5916 }
5917
5918 bool unit_needs_console(Unit *u) {
5919 ExecContext *ec;
5920 UnitActiveState state;
5921
5922 assert(u);
5923
5924 state = unit_active_state(u);
5925
5926 if (UNIT_IS_INACTIVE_OR_FAILED(state))
5927 return false;
5928
5929 if (UNIT_VTABLE(u)->needs_console)
5930 return UNIT_VTABLE(u)->needs_console(u);
5931
5932 /* If this unit type doesn't implement this call, let's use a generic fallback implementation: */
5933 ec = unit_get_exec_context(u);
5934 if (!ec)
5935 return false;
5936
5937 return exec_context_may_touch_console(ec);
5938 }
5939
5940 int unit_pid_attachable(Unit *u, PidRef *pid, sd_bus_error *error) {
5941 int r;
5942
5943 assert(u);
5944
5945 /* Checks whether the specified PID is generally good for attaching, i.e. a valid PID, not our manager itself,
5946 * and not a kernel thread either */
5947
5948 /* First, a simple range check */
5949 if (!pidref_is_set(pid))
5950 return sd_bus_error_setf(error, SD_BUS_ERROR_INVALID_ARGS, "Process identifier is not valid.");
5951
5952 /* Some extra safety check */
5953 if (pid->pid == 1 || pid->pid == getpid_cached())
5954 return sd_bus_error_setf(error, SD_BUS_ERROR_INVALID_ARGS, "Process " PID_FMT " is a manager process, refusing.", pid->pid);
5955
5956 /* Don't even begin to bother with kernel threads */
5957 r = is_kernel_thread(pid->pid);
5958 if (r == -ESRCH)
5959 return sd_bus_error_setf(error, SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN, "Process with ID " PID_FMT " does not exist.", pid->pid);
5960 if (r < 0)
5961 return sd_bus_error_set_errnof(error, r, "Failed to determine whether process " PID_FMT " is a kernel thread: %m", pid->pid);
5962 if (r > 0)
5963 return sd_bus_error_setf(error, SD_BUS_ERROR_INVALID_ARGS, "Process " PID_FMT " is a kernel thread, refusing.", pid->pid);
5964
5965 return 0;
5966 }
5967
5968 void unit_log_success(Unit *u) {
5969 assert(u);
5970
5971 /* Let's show message "Deactivated successfully" in debug mode (when manager is user) rather than in info mode.
5972 * This message has low information value for regular users and it might be a bit overwhelming on a system with
5973 * a lot of devices. */
5974 log_unit_struct(u,
5975 MANAGER_IS_USER(u->manager) ? LOG_DEBUG : LOG_INFO,
5976 "MESSAGE_ID=" SD_MESSAGE_UNIT_SUCCESS_STR,
5977 LOG_UNIT_INVOCATION_ID(u),
5978 LOG_UNIT_MESSAGE(u, "Deactivated successfully."));
5979 }
5980
5981 void unit_log_failure(Unit *u, const char *result) {
5982 assert(u);
5983 assert(result);
5984
5985 log_unit_struct(u, LOG_WARNING,
5986 "MESSAGE_ID=" SD_MESSAGE_UNIT_FAILURE_RESULT_STR,
5987 LOG_UNIT_INVOCATION_ID(u),
5988 LOG_UNIT_MESSAGE(u, "Failed with result '%s'.", result),
5989 "UNIT_RESULT=%s", result);
5990 }
5991
5992 void unit_log_skip(Unit *u, const char *result) {
5993 assert(u);
5994 assert(result);
5995
5996 log_unit_struct(u, LOG_INFO,
5997 "MESSAGE_ID=" SD_MESSAGE_UNIT_SKIPPED_STR,
5998 LOG_UNIT_INVOCATION_ID(u),
5999 LOG_UNIT_MESSAGE(u, "Skipped due to '%s'.", result),
6000 "UNIT_RESULT=%s", result);
6001 }
6002
6003 void unit_log_process_exit(
6004 Unit *u,
6005 const char *kind,
6006 const char *command,
6007 bool success,
6008 int code,
6009 int status) {
6010
6011 int level;
6012
6013 assert(u);
6014 assert(kind);
6015
6016 /* If this is a successful exit, let's log about the exit code on DEBUG level. If this is a failure
6017 * and the process exited on its own via exit(), then let's make this a NOTICE, under the assumption
6018 * that the service already logged the reason at a higher log level on its own. Otherwise, make it a
6019 * WARNING. */
6020 if (success)
6021 level = LOG_DEBUG;
6022 else if (code == CLD_EXITED)
6023 level = LOG_NOTICE;
6024 else
6025 level = LOG_WARNING;
6026
6027 log_unit_struct(u, level,
6028 "MESSAGE_ID=" SD_MESSAGE_UNIT_PROCESS_EXIT_STR,
6029 LOG_UNIT_MESSAGE(u, "%s exited, code=%s, status=%i/%s%s",
6030 kind,
6031 sigchld_code_to_string(code), status,
6032 strna(code == CLD_EXITED
6033 ? exit_status_to_string(status, EXIT_STATUS_FULL)
6034 : signal_to_string(status)),
6035 success ? " (success)" : ""),
6036 "EXIT_CODE=%s", sigchld_code_to_string(code),
6037 "EXIT_STATUS=%i", status,
6038 "COMMAND=%s", strna(command),
6039 LOG_UNIT_INVOCATION_ID(u));
6040 }
6041
6042 int unit_exit_status(Unit *u) {
6043 assert(u);
6044
6045 /* Returns the exit status to propagate for the most recent cycle of this unit. Returns a value in the range
6046 * 0…255 if there's something to propagate. EOPNOTSUPP if the concept does not apply to this unit type, ENODATA
6047 * if no data is currently known (for example because the unit hasn't deactivated yet) and EBADE if the main
6048 * service process has exited abnormally (signal/coredump). */
6049
6050 if (!UNIT_VTABLE(u)->exit_status)
6051 return -EOPNOTSUPP;
6052
6053 return UNIT_VTABLE(u)->exit_status(u);
6054 }
6055
6056 int unit_failure_action_exit_status(Unit *u) {
6057 int r;
6058
6059 assert(u);
6060
6061 /* Returns the exit status to propagate on failure, or an error if there's nothing to propagate */
6062
6063 if (u->failure_action_exit_status >= 0)
6064 return u->failure_action_exit_status;
6065
6066 r = unit_exit_status(u);
6067 if (r == -EBADE) /* Exited, but not cleanly (i.e. by signal or such) */
6068 return 255;
6069
6070 return r;
6071 }
6072
6073 int unit_success_action_exit_status(Unit *u) {
6074 int r;
6075
6076 assert(u);
6077
6078 /* Returns the exit status to propagate on success, or an error if there's nothing to propagate */
6079
6080 if (u->success_action_exit_status >= 0)
6081 return u->success_action_exit_status;
6082
6083 r = unit_exit_status(u);
6084 if (r == -EBADE) /* Exited, but not cleanly (i.e. by signal or such) */
6085 return 255;
6086
6087 return r;
6088 }
6089
6090 int unit_test_trigger_loaded(Unit *u) {
6091 Unit *trigger;
6092
6093 /* Tests whether the unit to trigger is loaded */
6094
6095 trigger = UNIT_TRIGGER(u);
6096 if (!trigger)
6097 return log_unit_error_errno(u, SYNTHETIC_ERRNO(ENOENT),
6098 "Refusing to start, no unit to trigger.");
6099 if (trigger->load_state != UNIT_LOADED)
6100 return log_unit_error_errno(u, SYNTHETIC_ERRNO(ENOENT),
6101 "Refusing to start, unit %s to trigger not loaded.", trigger->id);
6102
6103 return 0;
6104 }
6105
6106 void unit_destroy_runtime_data(Unit *u, const ExecContext *context) {
6107 assert(u);
6108 assert(context);
6109
6110 /* EXEC_PRESERVE_RESTART is handled via unit_release_resources()! */
6111 if (context->runtime_directory_preserve_mode == EXEC_PRESERVE_NO)
6112 exec_context_destroy_runtime_directory(context, u->manager->prefix[EXEC_DIRECTORY_RUNTIME]);
6113
6114 exec_context_destroy_credentials(u);
6115 exec_context_destroy_mount_ns_dir(u);
6116 }
6117
6118 int unit_clean(Unit *u, ExecCleanMask mask) {
6119 UnitActiveState state;
6120
6121 assert(u);
6122
6123 /* Special return values:
6124 *
6125 * -EOPNOTSUPP → cleaning not supported for this unit type
6126 * -EUNATCH → cleaning not defined for this resource type
6127 * -EBUSY → unit currently can't be cleaned since it's running or not properly loaded, or has
6128 * a job queued or similar
6129 */
6130
6131 if (!UNIT_VTABLE(u)->clean)
6132 return -EOPNOTSUPP;
6133
6134 if (mask == 0)
6135 return -EUNATCH;
6136
6137 if (u->load_state != UNIT_LOADED)
6138 return -EBUSY;
6139
6140 if (u->job)
6141 return -EBUSY;
6142
6143 state = unit_active_state(u);
6144 if (state != UNIT_INACTIVE)
6145 return -EBUSY;
6146
6147 return UNIT_VTABLE(u)->clean(u, mask);
6148 }
6149
6150 int unit_can_clean(Unit *u, ExecCleanMask *ret) {
6151 assert(u);
6152
6153 if (!UNIT_VTABLE(u)->clean ||
6154 u->load_state != UNIT_LOADED) {
6155 *ret = 0;
6156 return 0;
6157 }
6158
6159 /* When the clean() method is set, can_clean() really should be set too */
6160 assert(UNIT_VTABLE(u)->can_clean);
6161
6162 return UNIT_VTABLE(u)->can_clean(u, ret);
6163 }
6164
6165 bool unit_can_freeze(Unit *u) {
6166 assert(u);
6167
6168 if (UNIT_VTABLE(u)->can_freeze)
6169 return UNIT_VTABLE(u)->can_freeze(u);
6170
6171 return UNIT_VTABLE(u)->freeze;
6172 }
6173
6174 void unit_frozen(Unit *u) {
6175 assert(u);
6176
6177 u->freezer_state = FREEZER_FROZEN;
6178
6179 bus_unit_send_pending_freezer_message(u, false);
6180 }
6181
6182 void unit_thawed(Unit *u) {
6183 assert(u);
6184
6185 u->freezer_state = FREEZER_RUNNING;
6186
6187 bus_unit_send_pending_freezer_message(u, false);
6188 }
6189
6190 static int unit_freezer_action(Unit *u, FreezerAction action) {
6191 UnitActiveState s;
6192 int (*method)(Unit*);
6193 int r;
6194
6195 assert(u);
6196 assert(IN_SET(action, FREEZER_FREEZE, FREEZER_THAW));
6197
6198 method = action == FREEZER_FREEZE ? UNIT_VTABLE(u)->freeze : UNIT_VTABLE(u)->thaw;
6199 if (!method || !cg_freezer_supported())
6200 return -EOPNOTSUPP;
6201
6202 if (u->job)
6203 return -EBUSY;
6204
6205 if (u->load_state != UNIT_LOADED)
6206 return -EHOSTDOWN;
6207
6208 s = unit_active_state(u);
6209 if (s != UNIT_ACTIVE)
6210 return -EHOSTDOWN;
6211
6212 if ((IN_SET(u->freezer_state, FREEZER_FREEZING, FREEZER_THAWING) && action == FREEZER_FREEZE) ||
6213 (u->freezer_state == FREEZER_THAWING && action == FREEZER_THAW))
6214 return -EALREADY;
6215
6216 r = method(u);
6217 if (r <= 0)
6218 return r;
6219
6220 assert(IN_SET(u->freezer_state, FREEZER_FREEZING, FREEZER_THAWING));
6221
6222 return 1;
6223 }
6224
6225 int unit_freeze(Unit *u) {
6226 return unit_freezer_action(u, FREEZER_FREEZE);
6227 }
6228
6229 int unit_thaw(Unit *u) {
6230 return unit_freezer_action(u, FREEZER_THAW);
6231 }
6232
6233 /* Wrappers around low-level cgroup freezer operations common for service and scope units */
6234 int unit_freeze_vtable_common(Unit *u) {
6235 return unit_cgroup_freezer_action(u, FREEZER_FREEZE);
6236 }
6237
6238 int unit_thaw_vtable_common(Unit *u) {
6239 return unit_cgroup_freezer_action(u, FREEZER_THAW);
6240 }
6241
6242 Condition *unit_find_failed_condition(Unit *u) {
6243 Condition *failed_trigger = NULL;
6244 bool has_succeeded_trigger = false;
6245
6246 if (u->condition_result)
6247 return NULL;
6248
6249 LIST_FOREACH(conditions, c, u->conditions)
6250 if (c->trigger) {
6251 if (c->result == CONDITION_SUCCEEDED)
6252 has_succeeded_trigger = true;
6253 else if (!failed_trigger)
6254 failed_trigger = c;
6255 } else if (c->result != CONDITION_SUCCEEDED)
6256 return c;
6257
6258 return failed_trigger && !has_succeeded_trigger ? failed_trigger : NULL;
6259 }
6260
6261 static const char* const collect_mode_table[_COLLECT_MODE_MAX] = {
6262 [COLLECT_INACTIVE] = "inactive",
6263 [COLLECT_INACTIVE_OR_FAILED] = "inactive-or-failed",
6264 };
6265
6266 DEFINE_STRING_TABLE_LOOKUP(collect_mode, CollectMode);
6267
6268 Unit* unit_has_dependency(const Unit *u, UnitDependencyAtom atom, Unit *other) {
6269 Unit *i;
6270
6271 assert(u);
6272
6273 /* Checks if the unit has a dependency on 'other' with the specified dependency atom. If 'other' is
6274 * NULL checks if the unit has *any* dependency of that atom. Returns 'other' if found (or if 'other'
6275 * is NULL the first entry found), or NULL if not found. */
6276
6277 UNIT_FOREACH_DEPENDENCY(i, u, atom)
6278 if (!other || other == i)
6279 return i;
6280
6281 return NULL;
6282 }
6283
6284 int unit_get_dependency_array(const Unit *u, UnitDependencyAtom atom, Unit ***ret_array) {
6285 _cleanup_free_ Unit **array = NULL;
6286 size_t n = 0;
6287 Unit *other;
6288
6289 assert(u);
6290 assert(ret_array);
6291
6292 /* Gets a list of units matching a specific atom as array. This is useful when iterating through
6293 * dependencies while modifying them: the array is an "atomic snapshot" of sorts, that can be read
6294 * while the dependency table is continuously updated. */
6295
6296 UNIT_FOREACH_DEPENDENCY(other, u, atom) {
6297 if (!GREEDY_REALLOC(array, n + 1))
6298 return -ENOMEM;
6299
6300 array[n++] = other;
6301 }
6302
6303 *ret_array = TAKE_PTR(array);
6304
6305 assert(n <= INT_MAX);
6306 return (int) n;
6307 }
6308
6309 int unit_get_transitive_dependency_set(Unit *u, UnitDependencyAtom atom, Set **ret) {
6310 _cleanup_set_free_ Set *units = NULL, *queue = NULL;
6311 Unit *other;
6312 int r;
6313
6314 assert(u);
6315 assert(ret);
6316
6317 /* Similar to unit_get_dependency_array(), but also search the same dependency in other units. */
6318
6319 do {
6320 UNIT_FOREACH_DEPENDENCY(other, u, atom) {
6321 r = set_ensure_put(&units, NULL, other);
6322 if (r < 0)
6323 return r;
6324 if (r == 0)
6325 continue;
6326 r = set_ensure_put(&queue, NULL, other);
6327 if (r < 0)
6328 return r;
6329 }
6330 } while ((u = set_steal_first(queue)));
6331
6332 *ret = TAKE_PTR(units);
6333 return 0;
6334 }
6335
6336 int unit_arm_timer(
6337 Unit *u,
6338 sd_event_source **source,
6339 bool relative,
6340 usec_t usec,
6341 sd_event_time_handler_t handler) {
6342
6343 int r;
6344
6345 assert(u);
6346 assert(source);
6347 assert(handler);
6348
6349 if (*source) {
6350 if (usec == USEC_INFINITY)
6351 return sd_event_source_set_enabled(*source, SD_EVENT_OFF);
6352
6353 r = (relative ? sd_event_source_set_time_relative : sd_event_source_set_time)(*source, usec);
6354 if (r < 0)
6355 return r;
6356
6357 return sd_event_source_set_enabled(*source, SD_EVENT_ONESHOT);
6358 }
6359
6360 if (usec == USEC_INFINITY)
6361 return 0;
6362
6363 r = (relative ? sd_event_add_time_relative : sd_event_add_time)(
6364 u->manager->event,
6365 source,
6366 CLOCK_MONOTONIC,
6367 usec, 0,
6368 handler,
6369 u);
6370 if (r < 0)
6371 return r;
6372
6373 const char *d = strjoina(unit_type_to_string(u->type), "-timer");
6374 (void) sd_event_source_set_description(*source, d);
6375
6376 return 0;
6377 }
6378
6379 const ActivationDetailsVTable * const activation_details_vtable[_UNIT_TYPE_MAX] = {
6380 [UNIT_PATH] = &activation_details_path_vtable,
6381 [UNIT_TIMER] = &activation_details_timer_vtable,
6382 };
6383
6384 ActivationDetails *activation_details_new(Unit *trigger_unit) {
6385 _cleanup_free_ ActivationDetails *details = NULL;
6386
6387 assert(trigger_unit);
6388 assert(trigger_unit->type != _UNIT_TYPE_INVALID);
6389 assert(trigger_unit->id);
6390
6391 details = malloc0(activation_details_vtable[trigger_unit->type]->object_size);
6392 if (!details)
6393 return NULL;
6394
6395 *details = (ActivationDetails) {
6396 .n_ref = 1,
6397 .trigger_unit_type = trigger_unit->type,
6398 };
6399
6400 details->trigger_unit_name = strdup(trigger_unit->id);
6401 if (!details->trigger_unit_name)
6402 return NULL;
6403
6404 if (ACTIVATION_DETAILS_VTABLE(details)->init)
6405 ACTIVATION_DETAILS_VTABLE(details)->init(details, trigger_unit);
6406
6407 return TAKE_PTR(details);
6408 }
6409
6410 static ActivationDetails *activation_details_free(ActivationDetails *details) {
6411 if (!details)
6412 return NULL;
6413
6414 if (ACTIVATION_DETAILS_VTABLE(details)->done)
6415 ACTIVATION_DETAILS_VTABLE(details)->done(details);
6416
6417 free(details->trigger_unit_name);
6418
6419 return mfree(details);
6420 }
6421
6422 void activation_details_serialize(ActivationDetails *details, FILE *f) {
6423 if (!details || details->trigger_unit_type == _UNIT_TYPE_INVALID)
6424 return;
6425
6426 (void) serialize_item(f, "activation-details-unit-type", unit_type_to_string(details->trigger_unit_type));
6427 if (details->trigger_unit_name)
6428 (void) serialize_item(f, "activation-details-unit-name", details->trigger_unit_name);
6429 if (ACTIVATION_DETAILS_VTABLE(details)->serialize)
6430 ACTIVATION_DETAILS_VTABLE(details)->serialize(details, f);
6431 }
6432
6433 int activation_details_deserialize(const char *key, const char *value, ActivationDetails **details) {
6434 int r;
6435
6436 assert(key);
6437 assert(value);
6438 assert(details);
6439
6440 if (!*details) {
6441 UnitType t;
6442
6443 if (!streq(key, "activation-details-unit-type"))
6444 return -EINVAL;
6445
6446 t = unit_type_from_string(value);
6447 if (t < 0)
6448 return t;
6449
6450 /* The activation details vtable has defined ops only for path and timer units */
6451 if (!activation_details_vtable[t])
6452 return -EINVAL;
6453
6454 *details = malloc0(activation_details_vtable[t]->object_size);
6455 if (!*details)
6456 return -ENOMEM;
6457
6458 **details = (ActivationDetails) {
6459 .n_ref = 1,
6460 .trigger_unit_type = t,
6461 };
6462
6463 return 0;
6464 }
6465
6466 if (streq(key, "activation-details-unit-name")) {
6467 r = free_and_strdup(&(*details)->trigger_unit_name, value);
6468 if (r < 0)
6469 return r;
6470
6471 return 0;
6472 }
6473
6474 if (ACTIVATION_DETAILS_VTABLE(*details)->deserialize)
6475 return ACTIVATION_DETAILS_VTABLE(*details)->deserialize(key, value, details);
6476
6477 return -EINVAL;
6478 }
6479
6480 int activation_details_append_env(ActivationDetails *details, char ***strv) {
6481 int r = 0;
6482
6483 assert(strv);
6484
6485 if (!details)
6486 return 0;
6487
6488 if (!isempty(details->trigger_unit_name)) {
6489 char *s = strjoin("TRIGGER_UNIT=", details->trigger_unit_name);
6490 if (!s)
6491 return -ENOMEM;
6492
6493 r = strv_consume(strv, TAKE_PTR(s));
6494 if (r < 0)
6495 return r;
6496 }
6497
6498 if (ACTIVATION_DETAILS_VTABLE(details)->append_env) {
6499 r = ACTIVATION_DETAILS_VTABLE(details)->append_env(details, strv);
6500 if (r < 0)
6501 return r;
6502 }
6503
6504 return r + !isempty(details->trigger_unit_name); /* Return the number of variables added to the env block */
6505 }
6506
6507 int activation_details_append_pair(ActivationDetails *details, char ***strv) {
6508 int r = 0;
6509
6510 assert(strv);
6511
6512 if (!details)
6513 return 0;
6514
6515 if (!isempty(details->trigger_unit_name)) {
6516 r = strv_extend(strv, "trigger_unit");
6517 if (r < 0)
6518 return r;
6519
6520 r = strv_extend(strv, details->trigger_unit_name);
6521 if (r < 0)
6522 return r;
6523 }
6524
6525 if (ACTIVATION_DETAILS_VTABLE(details)->append_env) {
6526 r = ACTIVATION_DETAILS_VTABLE(details)->append_pair(details, strv);
6527 if (r < 0)
6528 return r;
6529 }
6530
6531 return r + !isempty(details->trigger_unit_name); /* Return the number of pairs added to the strv */
6532 }
6533
6534 DEFINE_TRIVIAL_REF_UNREF_FUNC(ActivationDetails, activation_details, activation_details_free);