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