]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/core/unit.c
login: respect install_sysconfdir_samples in meson file
[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 uint64_t value = UINT64_MAX;
2299
2300 assert(io_fields[k]);
2301
2302 (void) unit_get_io_accounting(u, k, k > 0, &value);
2303 if (value == UINT64_MAX)
2304 continue;
2305
2306 have_io_accounting = true;
2307 if (value > 0)
2308 any_io = true;
2309
2310 /* Format IO accounting data for inclusion in the structured log message */
2311 if (asprintf(&t, "%s=%" PRIu64, io_fields[k], value) < 0) {
2312 r = log_oom();
2313 goto finish;
2314 }
2315 iovec[n_iovec++] = IOVEC_MAKE_STRING(t);
2316
2317 /* Format the IO accounting data for inclusion in the human language message string, but only
2318 * for the bytes counters (and not for the operations counters) */
2319 if (k == CGROUP_IO_READ_BYTES) {
2320 assert(!rr);
2321 rr = strjoin("read ", strna(FORMAT_BYTES(value)), " from disk");
2322 if (!rr) {
2323 r = log_oom();
2324 goto finish;
2325 }
2326 } else if (k == CGROUP_IO_WRITE_BYTES) {
2327 assert(!wr);
2328 wr = strjoin("written ", strna(FORMAT_BYTES(value)), " to disk");
2329 if (!wr) {
2330 r = log_oom();
2331 goto finish;
2332 }
2333 }
2334
2335 if (IN_SET(k, CGROUP_IO_READ_BYTES, CGROUP_IO_WRITE_BYTES))
2336 log_level = raise_level(log_level,
2337 value > MENTIONWORTHY_IO_BYTES,
2338 value > NOTICEWORTHY_IO_BYTES);
2339 }
2340
2341 if (have_io_accounting) {
2342 if (any_io) {
2343 if (rr)
2344 message_parts[n_message_parts++] = TAKE_PTR(rr);
2345 if (wr)
2346 message_parts[n_message_parts++] = TAKE_PTR(wr);
2347
2348 } else {
2349 char *k;
2350
2351 k = strdup("no IO");
2352 if (!k) {
2353 r = log_oom();
2354 goto finish;
2355 }
2356
2357 message_parts[n_message_parts++] = k;
2358 }
2359 }
2360
2361 for (CGroupIPAccountingMetric m = 0; m < _CGROUP_IP_ACCOUNTING_METRIC_MAX; m++) {
2362 uint64_t value = UINT64_MAX;
2363
2364 assert(ip_fields[m]);
2365
2366 (void) unit_get_ip_accounting(u, m, &value);
2367 if (value == UINT64_MAX)
2368 continue;
2369
2370 have_ip_accounting = true;
2371 if (value > 0)
2372 any_traffic = true;
2373
2374 /* Format IP accounting data for inclusion in the structured log message */
2375 if (asprintf(&t, "%s=%" PRIu64, ip_fields[m], value) < 0) {
2376 r = log_oom();
2377 goto finish;
2378 }
2379 iovec[n_iovec++] = IOVEC_MAKE_STRING(t);
2380
2381 /* Format the IP accounting data for inclusion in the human language message string, but only for the
2382 * bytes counters (and not for the packets counters) */
2383 if (m == CGROUP_IP_INGRESS_BYTES) {
2384 assert(!igress);
2385 igress = strjoin("received ", strna(FORMAT_BYTES(value)), " IP traffic");
2386 if (!igress) {
2387 r = log_oom();
2388 goto finish;
2389 }
2390 } else if (m == CGROUP_IP_EGRESS_BYTES) {
2391 assert(!egress);
2392 egress = strjoin("sent ", strna(FORMAT_BYTES(value)), " IP traffic");
2393 if (!egress) {
2394 r = log_oom();
2395 goto finish;
2396 }
2397 }
2398
2399 if (IN_SET(m, CGROUP_IP_INGRESS_BYTES, CGROUP_IP_EGRESS_BYTES))
2400 log_level = raise_level(log_level,
2401 value > MENTIONWORTHY_IP_BYTES,
2402 value > NOTICEWORTHY_IP_BYTES);
2403 }
2404
2405 /* This check is here because it is the earliest point following all possible log_level assignments. If
2406 * log_level is assigned anywhere after this point, move this check. */
2407 if (!unit_log_level_test(u, log_level)) {
2408 r = 0;
2409 goto finish;
2410 }
2411
2412 if (have_ip_accounting) {
2413 if (any_traffic) {
2414 if (igress)
2415 message_parts[n_message_parts++] = TAKE_PTR(igress);
2416 if (egress)
2417 message_parts[n_message_parts++] = TAKE_PTR(egress);
2418
2419 } else {
2420 char *k;
2421
2422 k = strdup("no IP traffic");
2423 if (!k) {
2424 r = log_oom();
2425 goto finish;
2426 }
2427
2428 message_parts[n_message_parts++] = k;
2429 }
2430 }
2431
2432 /* Is there any accounting data available at all? */
2433 if (n_iovec == 0) {
2434 r = 0;
2435 goto finish;
2436 }
2437
2438 if (n_message_parts == 0)
2439 t = strjoina("MESSAGE=", u->id, ": Completed.");
2440 else {
2441 _cleanup_free_ char *joined = NULL;
2442
2443 message_parts[n_message_parts] = NULL;
2444
2445 joined = strv_join(message_parts, ", ");
2446 if (!joined) {
2447 r = log_oom();
2448 goto finish;
2449 }
2450
2451 joined[0] = ascii_toupper(joined[0]);
2452 t = strjoina("MESSAGE=", u->id, ": ", joined, ".");
2453 }
2454
2455 /* The following four fields we allocate on the stack or are static strings, we hence don't want to free them,
2456 * and hence don't increase n_iovec for them */
2457 iovec[n_iovec] = IOVEC_MAKE_STRING(t);
2458 iovec[n_iovec + 1] = IOVEC_MAKE_STRING("MESSAGE_ID=" SD_MESSAGE_UNIT_RESOURCES_STR);
2459
2460 t = strjoina(u->manager->unit_log_field, u->id);
2461 iovec[n_iovec + 2] = IOVEC_MAKE_STRING(t);
2462
2463 t = strjoina(u->manager->invocation_log_field, u->invocation_id_string);
2464 iovec[n_iovec + 3] = IOVEC_MAKE_STRING(t);
2465
2466 log_unit_struct_iovec(u, log_level, iovec, n_iovec + 4);
2467 r = 0;
2468
2469 finish:
2470 for (size_t i = 0; i < n_message_parts; i++)
2471 free(message_parts[i]);
2472
2473 for (size_t i = 0; i < n_iovec; i++)
2474 free(iovec[i].iov_base);
2475
2476 return r;
2477
2478 }
2479
2480 static void unit_update_on_console(Unit *u) {
2481 bool b;
2482
2483 assert(u);
2484
2485 b = unit_needs_console(u);
2486 if (u->on_console == b)
2487 return;
2488
2489 u->on_console = b;
2490 if (b)
2491 manager_ref_console(u->manager);
2492 else
2493 manager_unref_console(u->manager);
2494 }
2495
2496 static void unit_emit_audit_start(Unit *u) {
2497 assert(u);
2498
2499 if (u->type != UNIT_SERVICE)
2500 return;
2501
2502 /* Write audit record if we have just finished starting up */
2503 manager_send_unit_audit(u->manager, u, AUDIT_SERVICE_START, true);
2504 u->in_audit = true;
2505 }
2506
2507 static void unit_emit_audit_stop(Unit *u, UnitActiveState state) {
2508 assert(u);
2509
2510 if (u->type != UNIT_SERVICE)
2511 return;
2512
2513 if (u->in_audit) {
2514 /* Write audit record if we have just finished shutting down */
2515 manager_send_unit_audit(u->manager, u, AUDIT_SERVICE_STOP, state == UNIT_INACTIVE);
2516 u->in_audit = false;
2517 } else {
2518 /* Hmm, if there was no start record written write it now, so that we always have a nice pair */
2519 manager_send_unit_audit(u->manager, u, AUDIT_SERVICE_START, state == UNIT_INACTIVE);
2520
2521 if (state == UNIT_INACTIVE)
2522 manager_send_unit_audit(u->manager, u, AUDIT_SERVICE_STOP, true);
2523 }
2524 }
2525
2526 static bool unit_process_job(Job *j, UnitActiveState ns, UnitNotifyFlags flags) {
2527 bool unexpected = false;
2528 JobResult result;
2529
2530 assert(j);
2531
2532 if (j->state == JOB_WAITING)
2533
2534 /* So we reached a different state for this job. Let's see if we can run it now if it failed previously
2535 * due to EAGAIN. */
2536 job_add_to_run_queue(j);
2537
2538 /* Let's check whether the unit's new state constitutes a finished job, or maybe contradicts a running job and
2539 * hence needs to invalidate jobs. */
2540
2541 switch (j->type) {
2542
2543 case JOB_START:
2544 case JOB_VERIFY_ACTIVE:
2545
2546 if (UNIT_IS_ACTIVE_OR_RELOADING(ns))
2547 job_finish_and_invalidate(j, JOB_DONE, true, false);
2548 else if (j->state == JOB_RUNNING && ns != UNIT_ACTIVATING) {
2549 unexpected = true;
2550
2551 if (UNIT_IS_INACTIVE_OR_FAILED(ns)) {
2552 if (ns == UNIT_FAILED)
2553 result = JOB_FAILED;
2554 else
2555 result = JOB_DONE;
2556
2557 job_finish_and_invalidate(j, result, true, false);
2558 }
2559 }
2560
2561 break;
2562
2563 case JOB_RELOAD:
2564 case JOB_RELOAD_OR_START:
2565 case JOB_TRY_RELOAD:
2566
2567 if (j->state == JOB_RUNNING) {
2568 if (ns == UNIT_ACTIVE)
2569 job_finish_and_invalidate(j, (flags & UNIT_NOTIFY_RELOAD_FAILURE) ? JOB_FAILED : JOB_DONE, true, false);
2570 else if (!IN_SET(ns, UNIT_ACTIVATING, UNIT_RELOADING)) {
2571 unexpected = true;
2572
2573 if (UNIT_IS_INACTIVE_OR_FAILED(ns))
2574 job_finish_and_invalidate(j, ns == UNIT_FAILED ? JOB_FAILED : JOB_DONE, true, false);
2575 }
2576 }
2577
2578 break;
2579
2580 case JOB_STOP:
2581 case JOB_RESTART:
2582 case JOB_TRY_RESTART:
2583
2584 if (UNIT_IS_INACTIVE_OR_FAILED(ns))
2585 job_finish_and_invalidate(j, JOB_DONE, true, false);
2586 else if (j->state == JOB_RUNNING && ns != UNIT_DEACTIVATING) {
2587 unexpected = true;
2588 job_finish_and_invalidate(j, JOB_FAILED, true, false);
2589 }
2590
2591 break;
2592
2593 default:
2594 assert_not_reached("Job type unknown");
2595 }
2596
2597 return unexpected;
2598 }
2599
2600 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, UnitNotifyFlags flags) {
2601 const char *reason;
2602 Manager *m;
2603
2604 assert(u);
2605 assert(os < _UNIT_ACTIVE_STATE_MAX);
2606 assert(ns < _UNIT_ACTIVE_STATE_MAX);
2607
2608 /* Note that this is called for all low-level state changes, even if they might map to the same high-level
2609 * UnitActiveState! That means that ns == os is an expected behavior here. For example: if a mount point is
2610 * remounted this function will be called too! */
2611
2612 m = u->manager;
2613
2614 /* Let's enqueue the change signal early. In case this unit has a job associated we want that this unit is in
2615 * the bus queue, so that any job change signal queued will force out the unit change signal first. */
2616 unit_add_to_dbus_queue(u);
2617
2618 /* Update systemd-oomd on the property/state change */
2619 if (os != ns) {
2620 /* Always send an update if the unit is going into an inactive state so systemd-oomd knows to stop
2621 * monitoring.
2622 * Also send an update whenever the unit goes active; this is to handle a case where an override file
2623 * sets one of the ManagedOOM*= properties to "kill", then later removes it. systemd-oomd needs to
2624 * know to stop monitoring when the unit changes from "kill" -> "auto" on daemon-reload, but we don't
2625 * have the information on the property. Thus, indiscriminately send an update. */
2626 if (UNIT_IS_INACTIVE_OR_FAILED(ns) || UNIT_IS_ACTIVE_OR_RELOADING(ns))
2627 (void) manager_varlink_send_managed_oom_update(u);
2628 }
2629
2630 /* Update timestamps for state changes */
2631 if (!MANAGER_IS_RELOADING(m)) {
2632 dual_timestamp_get(&u->state_change_timestamp);
2633
2634 if (UNIT_IS_INACTIVE_OR_FAILED(os) && !UNIT_IS_INACTIVE_OR_FAILED(ns))
2635 u->inactive_exit_timestamp = u->state_change_timestamp;
2636 else if (!UNIT_IS_INACTIVE_OR_FAILED(os) && UNIT_IS_INACTIVE_OR_FAILED(ns))
2637 u->inactive_enter_timestamp = u->state_change_timestamp;
2638
2639 if (!UNIT_IS_ACTIVE_OR_RELOADING(os) && UNIT_IS_ACTIVE_OR_RELOADING(ns))
2640 u->active_enter_timestamp = u->state_change_timestamp;
2641 else if (UNIT_IS_ACTIVE_OR_RELOADING(os) && !UNIT_IS_ACTIVE_OR_RELOADING(ns))
2642 u->active_exit_timestamp = u->state_change_timestamp;
2643 }
2644
2645 /* Keep track of failed units */
2646 (void) manager_update_failed_units(m, u, ns == UNIT_FAILED);
2647
2648 /* Make sure the cgroup and state files are always removed when we become inactive */
2649 if (UNIT_IS_INACTIVE_OR_FAILED(ns)) {
2650 SET_FLAG(u->markers,
2651 (1u << UNIT_MARKER_NEEDS_RELOAD)|(1u << UNIT_MARKER_NEEDS_RESTART),
2652 false);
2653 unit_prune_cgroup(u);
2654 unit_unlink_state_files(u);
2655 } else if (ns != os && ns == UNIT_RELOADING)
2656 SET_FLAG(u->markers, 1u << UNIT_MARKER_NEEDS_RELOAD, false);
2657
2658 unit_update_on_console(u);
2659
2660 if (!MANAGER_IS_RELOADING(m)) {
2661 bool unexpected;
2662
2663 /* Let's propagate state changes to the job */
2664 if (u->job)
2665 unexpected = unit_process_job(u->job, ns, flags);
2666 else
2667 unexpected = true;
2668
2669 /* If this state change happened without being requested by a job, then let's retroactively start or
2670 * stop dependencies. We skip that step when deserializing, since we don't want to create any
2671 * additional jobs just because something is already activated. */
2672
2673 if (unexpected) {
2674 if (UNIT_IS_INACTIVE_OR_FAILED(os) && UNIT_IS_ACTIVE_OR_ACTIVATING(ns))
2675 retroactively_start_dependencies(u);
2676 else if (UNIT_IS_ACTIVE_OR_ACTIVATING(os) && UNIT_IS_INACTIVE_OR_DEACTIVATING(ns))
2677 retroactively_stop_dependencies(u);
2678 }
2679
2680 if (ns != os && ns == UNIT_FAILED) {
2681 log_unit_debug(u, "Unit entered failed state.");
2682
2683 if (!(flags & UNIT_NOTIFY_WILL_AUTO_RESTART))
2684 unit_start_on_failure(u, "OnFailure=", UNIT_ATOM_ON_FAILURE, u->on_failure_job_mode);
2685 }
2686
2687 if (UNIT_IS_ACTIVE_OR_RELOADING(ns) && !UNIT_IS_ACTIVE_OR_RELOADING(os)) {
2688 /* This unit just finished starting up */
2689
2690 unit_emit_audit_start(u);
2691 manager_send_unit_plymouth(m, u);
2692 }
2693
2694 if (UNIT_IS_INACTIVE_OR_FAILED(ns) && !UNIT_IS_INACTIVE_OR_FAILED(os)) {
2695 /* This unit just stopped/failed. */
2696
2697 unit_emit_audit_stop(u, ns);
2698 unit_log_resources(u);
2699 }
2700
2701 if (ns == UNIT_INACTIVE && !IN_SET(os, UNIT_FAILED, UNIT_INACTIVE, UNIT_MAINTENANCE) &&
2702 !(flags & UNIT_NOTIFY_WILL_AUTO_RESTART))
2703 unit_start_on_failure(u, "OnSuccess=", UNIT_ATOM_ON_SUCCESS, u->on_success_job_mode);
2704 }
2705
2706 manager_recheck_journal(m);
2707 manager_recheck_dbus(m);
2708
2709 unit_trigger_notify(u);
2710
2711 if (!MANAGER_IS_RELOADING(m)) {
2712 if (os != UNIT_FAILED && ns == UNIT_FAILED) {
2713 reason = strjoina("unit ", u->id, " failed");
2714 emergency_action(m, u->failure_action, 0, u->reboot_arg, unit_failure_action_exit_status(u), reason);
2715 } else if (!UNIT_IS_INACTIVE_OR_FAILED(os) && ns == UNIT_INACTIVE) {
2716 reason = strjoina("unit ", u->id, " succeeded");
2717 emergency_action(m, u->success_action, 0, u->reboot_arg, unit_success_action_exit_status(u), reason);
2718 }
2719 }
2720
2721 /* And now, add the unit or depending units to various queues that will act on the new situation if
2722 * needed. These queues generally check for continuous state changes rather than events (like most of
2723 * the state propagation above), and do work deferred instead of instantly, since they typically
2724 * don't want to run during reloading, and usually involve checking combined state of multiple units
2725 * at once. */
2726
2727 if (UNIT_IS_INACTIVE_OR_FAILED(ns)) {
2728 /* Stop unneeded units and bound-by units regardless if going down was expected or not */
2729 check_unneeded_dependencies(u);
2730 check_bound_by_dependencies(u);
2731
2732 /* Maybe someone wants us to remain up? */
2733 unit_submit_to_start_when_upheld_queue(u);
2734
2735 /* Maybe the unit should be GC'ed now? */
2736 unit_add_to_gc_queue(u);
2737 }
2738
2739 if (UNIT_IS_ACTIVE_OR_RELOADING(ns)) {
2740 /* Start uphold units regardless if going up was expected or not */
2741 check_uphold_dependencies(u);
2742
2743 /* Maybe we finished startup and are now ready for being stopped because unneeded? */
2744 unit_submit_to_stop_when_unneeded_queue(u);
2745
2746 /* Maybe we finished startup, but something we needed has vanished? Let's die then. (This happens
2747 * when something BindsTo= to a Type=oneshot unit, as these units go directly from starting to
2748 * inactive, without ever entering started.) */
2749 unit_submit_to_stop_when_bound_queue(u);
2750 }
2751 }
2752
2753 int unit_watch_pid(Unit *u, pid_t pid, bool exclusive) {
2754 int r;
2755
2756 assert(u);
2757 assert(pid_is_valid(pid));
2758
2759 /* Watch a specific PID */
2760
2761 /* Caller might be sure that this PID belongs to this unit only. Let's take this
2762 * opportunity to remove any stalled references to this PID as they can be created
2763 * easily (when watching a process which is not our direct child). */
2764 if (exclusive)
2765 manager_unwatch_pid(u->manager, pid);
2766
2767 r = set_ensure_allocated(&u->pids, NULL);
2768 if (r < 0)
2769 return r;
2770
2771 r = hashmap_ensure_allocated(&u->manager->watch_pids, NULL);
2772 if (r < 0)
2773 return r;
2774
2775 /* First try, let's add the unit keyed by "pid". */
2776 r = hashmap_put(u->manager->watch_pids, PID_TO_PTR(pid), u);
2777 if (r == -EEXIST) {
2778 Unit **array;
2779 bool found = false;
2780 size_t n = 0;
2781
2782 /* OK, the "pid" key is already assigned to a different unit. Let's see if the "-pid" key (which points
2783 * to an array of Units rather than just a Unit), lists us already. */
2784
2785 array = hashmap_get(u->manager->watch_pids, PID_TO_PTR(-pid));
2786 if (array)
2787 for (; array[n]; n++)
2788 if (array[n] == u)
2789 found = true;
2790
2791 if (found) /* Found it already? if so, do nothing */
2792 r = 0;
2793 else {
2794 Unit **new_array;
2795
2796 /* Allocate a new array */
2797 new_array = new(Unit*, n + 2);
2798 if (!new_array)
2799 return -ENOMEM;
2800
2801 memcpy_safe(new_array, array, sizeof(Unit*) * n);
2802 new_array[n] = u;
2803 new_array[n+1] = NULL;
2804
2805 /* Add or replace the old array */
2806 r = hashmap_replace(u->manager->watch_pids, PID_TO_PTR(-pid), new_array);
2807 if (r < 0) {
2808 free(new_array);
2809 return r;
2810 }
2811
2812 free(array);
2813 }
2814 } else if (r < 0)
2815 return r;
2816
2817 r = set_put(u->pids, PID_TO_PTR(pid));
2818 if (r < 0)
2819 return r;
2820
2821 return 0;
2822 }
2823
2824 void unit_unwatch_pid(Unit *u, pid_t pid) {
2825 Unit **array;
2826
2827 assert(u);
2828 assert(pid_is_valid(pid));
2829
2830 /* First let's drop the unit in case it's keyed as "pid". */
2831 (void) hashmap_remove_value(u->manager->watch_pids, PID_TO_PTR(pid), u);
2832
2833 /* Then, let's also drop the unit, in case it's in the array keyed by -pid */
2834 array = hashmap_get(u->manager->watch_pids, PID_TO_PTR(-pid));
2835 if (array) {
2836 /* Let's iterate through the array, dropping our own entry */
2837
2838 size_t m = 0;
2839 for (size_t n = 0; array[n]; n++)
2840 if (array[n] != u)
2841 array[m++] = array[n];
2842 array[m] = NULL;
2843
2844 if (m == 0) {
2845 /* The array is now empty, remove the entire entry */
2846 assert_se(hashmap_remove(u->manager->watch_pids, PID_TO_PTR(-pid)) == array);
2847 free(array);
2848 }
2849 }
2850
2851 (void) set_remove(u->pids, PID_TO_PTR(pid));
2852 }
2853
2854 void unit_unwatch_all_pids(Unit *u) {
2855 assert(u);
2856
2857 while (!set_isempty(u->pids))
2858 unit_unwatch_pid(u, PTR_TO_PID(set_first(u->pids)));
2859
2860 u->pids = set_free(u->pids);
2861 }
2862
2863 static void unit_tidy_watch_pids(Unit *u) {
2864 pid_t except1, except2;
2865 void *e;
2866
2867 assert(u);
2868
2869 /* Cleans dead PIDs from our list */
2870
2871 except1 = unit_main_pid(u);
2872 except2 = unit_control_pid(u);
2873
2874 SET_FOREACH(e, u->pids) {
2875 pid_t pid = PTR_TO_PID(e);
2876
2877 if (pid == except1 || pid == except2)
2878 continue;
2879
2880 if (!pid_is_unwaited(pid))
2881 unit_unwatch_pid(u, pid);
2882 }
2883 }
2884
2885 static int on_rewatch_pids_event(sd_event_source *s, void *userdata) {
2886 Unit *u = userdata;
2887
2888 assert(s);
2889 assert(u);
2890
2891 unit_tidy_watch_pids(u);
2892 unit_watch_all_pids(u);
2893
2894 /* If the PID set is empty now, then let's finish this off. */
2895 unit_synthesize_cgroup_empty_event(u);
2896
2897 return 0;
2898 }
2899
2900 int unit_enqueue_rewatch_pids(Unit *u) {
2901 int r;
2902
2903 assert(u);
2904
2905 if (!u->cgroup_path)
2906 return -ENOENT;
2907
2908 r = cg_unified_controller(SYSTEMD_CGROUP_CONTROLLER);
2909 if (r < 0)
2910 return r;
2911 if (r > 0) /* On unified we can use proper notifications */
2912 return 0;
2913
2914 /* Enqueues a low-priority job that will clean up dead PIDs from our list of PIDs to watch and subscribe to new
2915 * PIDs that might have appeared. We do this in a delayed job because the work might be quite slow, as it
2916 * involves issuing kill(pid, 0) on all processes we watch. */
2917
2918 if (!u->rewatch_pids_event_source) {
2919 _cleanup_(sd_event_source_unrefp) sd_event_source *s = NULL;
2920
2921 r = sd_event_add_defer(u->manager->event, &s, on_rewatch_pids_event, u);
2922 if (r < 0)
2923 return log_error_errno(r, "Failed to allocate event source for tidying watched PIDs: %m");
2924
2925 r = sd_event_source_set_priority(s, SD_EVENT_PRIORITY_IDLE);
2926 if (r < 0)
2927 return log_error_errno(r, "Failed to adjust priority of event source for tidying watched PIDs: %m");
2928
2929 (void) sd_event_source_set_description(s, "tidy-watch-pids");
2930
2931 u->rewatch_pids_event_source = TAKE_PTR(s);
2932 }
2933
2934 r = sd_event_source_set_enabled(u->rewatch_pids_event_source, SD_EVENT_ONESHOT);
2935 if (r < 0)
2936 return log_error_errno(r, "Failed to enable event source for tidying watched PIDs: %m");
2937
2938 return 0;
2939 }
2940
2941 void unit_dequeue_rewatch_pids(Unit *u) {
2942 int r;
2943 assert(u);
2944
2945 if (!u->rewatch_pids_event_source)
2946 return;
2947
2948 r = sd_event_source_set_enabled(u->rewatch_pids_event_source, SD_EVENT_OFF);
2949 if (r < 0)
2950 log_warning_errno(r, "Failed to disable event source for tidying watched PIDs, ignoring: %m");
2951
2952 u->rewatch_pids_event_source = sd_event_source_disable_unref(u->rewatch_pids_event_source);
2953 }
2954
2955 bool unit_job_is_applicable(Unit *u, JobType j) {
2956 assert(u);
2957 assert(j >= 0 && j < _JOB_TYPE_MAX);
2958
2959 switch (j) {
2960
2961 case JOB_VERIFY_ACTIVE:
2962 case JOB_START:
2963 case JOB_NOP:
2964 /* Note that we don't check unit_can_start() here. That's because .device units and suchlike are not
2965 * startable by us but may appear due to external events, and it thus makes sense to permit enqueuing
2966 * jobs for it. */
2967 return true;
2968
2969 case JOB_STOP:
2970 /* Similar as above. However, perpetual units can never be stopped (neither explicitly nor due to
2971 * external events), hence it makes no sense to permit enqueuing such a request either. */
2972 return !u->perpetual;
2973
2974 case JOB_RESTART:
2975 case JOB_TRY_RESTART:
2976 return unit_can_stop(u) && unit_can_start(u);
2977
2978 case JOB_RELOAD:
2979 case JOB_TRY_RELOAD:
2980 return unit_can_reload(u);
2981
2982 case JOB_RELOAD_OR_START:
2983 return unit_can_reload(u) && unit_can_start(u);
2984
2985 default:
2986 assert_not_reached("Invalid job type");
2987 }
2988 }
2989
2990 int unit_add_dependency(
2991 Unit *u,
2992 UnitDependency d,
2993 Unit *other,
2994 bool add_reference,
2995 UnitDependencyMask mask) {
2996
2997 static const UnitDependency inverse_table[_UNIT_DEPENDENCY_MAX] = {
2998 [UNIT_REQUIRES] = UNIT_REQUIRED_BY,
2999 [UNIT_REQUISITE] = UNIT_REQUISITE_OF,
3000 [UNIT_WANTS] = UNIT_WANTED_BY,
3001 [UNIT_BINDS_TO] = UNIT_BOUND_BY,
3002 [UNIT_PART_OF] = UNIT_CONSISTS_OF,
3003 [UNIT_UPHOLDS] = UNIT_UPHELD_BY,
3004 [UNIT_REQUIRED_BY] = UNIT_REQUIRES,
3005 [UNIT_REQUISITE_OF] = UNIT_REQUISITE,
3006 [UNIT_WANTED_BY] = UNIT_WANTS,
3007 [UNIT_BOUND_BY] = UNIT_BINDS_TO,
3008 [UNIT_CONSISTS_OF] = UNIT_PART_OF,
3009 [UNIT_UPHELD_BY] = UNIT_UPHOLDS,
3010 [UNIT_CONFLICTS] = UNIT_CONFLICTED_BY,
3011 [UNIT_CONFLICTED_BY] = UNIT_CONFLICTS,
3012 [UNIT_BEFORE] = UNIT_AFTER,
3013 [UNIT_AFTER] = UNIT_BEFORE,
3014 [UNIT_ON_SUCCESS] = UNIT_ON_SUCCESS_OF,
3015 [UNIT_ON_SUCCESS_OF] = UNIT_ON_SUCCESS,
3016 [UNIT_ON_FAILURE] = UNIT_ON_FAILURE_OF,
3017 [UNIT_ON_FAILURE_OF] = UNIT_ON_FAILURE,
3018 [UNIT_TRIGGERS] = UNIT_TRIGGERED_BY,
3019 [UNIT_TRIGGERED_BY] = UNIT_TRIGGERS,
3020 [UNIT_PROPAGATES_RELOAD_TO] = UNIT_RELOAD_PROPAGATED_FROM,
3021 [UNIT_RELOAD_PROPAGATED_FROM] = UNIT_PROPAGATES_RELOAD_TO,
3022 [UNIT_PROPAGATES_STOP_TO] = UNIT_STOP_PROPAGATED_FROM,
3023 [UNIT_STOP_PROPAGATED_FROM] = UNIT_PROPAGATES_STOP_TO,
3024 [UNIT_JOINS_NAMESPACE_OF] = UNIT_JOINS_NAMESPACE_OF, /* symmetric! 👓 */
3025 [UNIT_REFERENCES] = UNIT_REFERENCED_BY,
3026 [UNIT_REFERENCED_BY] = UNIT_REFERENCES,
3027 [UNIT_IN_SLICE] = UNIT_SLICE_OF,
3028 [UNIT_SLICE_OF] = UNIT_IN_SLICE,
3029 };
3030 Unit *original_u = u, *original_other = other;
3031 UnitDependencyAtom a;
3032 int r;
3033
3034 /* Helper to know whether sending a notification is necessary or not: if the dependency is already
3035 * there, no need to notify! */
3036 bool noop;
3037
3038 assert(u);
3039 assert(d >= 0 && d < _UNIT_DEPENDENCY_MAX);
3040 assert(other);
3041
3042 u = unit_follow_merge(u);
3043 other = unit_follow_merge(other);
3044 a = unit_dependency_to_atom(d);
3045 assert(a >= 0);
3046
3047 /* We won't allow dependencies on ourselves. We will not consider them an error however. */
3048 if (u == other) {
3049 unit_maybe_warn_about_dependency(original_u, original_other->id, d);
3050 return 0;
3051 }
3052
3053 /* Note that ordering a device unit after a unit is permitted since it allows to start its job
3054 * running timeout at a specific time. */
3055 if (FLAGS_SET(a, UNIT_ATOM_BEFORE) && other->type == UNIT_DEVICE) {
3056 log_unit_warning(u, "Dependency Before=%s ignored (.device units cannot be delayed)", other->id);
3057 return 0;
3058 }
3059
3060 if (FLAGS_SET(a, UNIT_ATOM_ON_FAILURE) && !UNIT_VTABLE(u)->can_fail) {
3061 log_unit_warning(u, "Requested dependency OnFailure=%s ignored (%s units cannot fail).", other->id, unit_type_to_string(u->type));
3062 return 0;
3063 }
3064
3065 if (FLAGS_SET(a, UNIT_ATOM_TRIGGERS) && !UNIT_VTABLE(u)->can_trigger)
3066 return log_unit_error_errno(u, SYNTHETIC_ERRNO(EINVAL),
3067 "Requested dependency Triggers=%s refused (%s units cannot trigger other units).", other->id, unit_type_to_string(u->type));
3068 if (FLAGS_SET(a, UNIT_ATOM_TRIGGERED_BY) && !UNIT_VTABLE(other)->can_trigger)
3069 return log_unit_error_errno(u, SYNTHETIC_ERRNO(EINVAL),
3070 "Requested dependency TriggeredBy=%s refused (%s units cannot trigger other units).", other->id, unit_type_to_string(other->type));
3071
3072 if (FLAGS_SET(a, UNIT_ATOM_IN_SLICE) && other->type != UNIT_SLICE)
3073 return log_unit_error_errno(u, SYNTHETIC_ERRNO(EINVAL),
3074 "Requested dependency Slice=%s refused (%s is not a slice unit).", other->id, other->id);
3075 if (FLAGS_SET(a, UNIT_ATOM_SLICE_OF) && u->type != UNIT_SLICE)
3076 return log_unit_error_errno(u, SYNTHETIC_ERRNO(EINVAL),
3077 "Requested dependency SliceOf=%s refused (%s is not a slice unit).", other->id, u->id);
3078
3079 if (FLAGS_SET(a, UNIT_ATOM_IN_SLICE) && !UNIT_HAS_CGROUP_CONTEXT(u))
3080 return log_unit_error_errno(u, SYNTHETIC_ERRNO(EINVAL),
3081 "Requested dependency Slice=%s refused (%s is not a cgroup unit).", other->id, u->id);
3082
3083 if (FLAGS_SET(a, UNIT_ATOM_SLICE_OF) && !UNIT_HAS_CGROUP_CONTEXT(other))
3084 return log_unit_error_errno(u, SYNTHETIC_ERRNO(EINVAL),
3085 "Requested dependency SliceOf=%s refused (%s is not a cgroup unit).", other->id, other->id);
3086
3087 r = unit_add_dependency_hashmap(&u->dependencies, d, other, mask, 0);
3088 if (r < 0)
3089 return r;
3090 noop = !r;
3091
3092 if (inverse_table[d] != _UNIT_DEPENDENCY_INVALID && inverse_table[d] != d) {
3093 r = unit_add_dependency_hashmap(&other->dependencies, inverse_table[d], u, 0, mask);
3094 if (r < 0)
3095 return r;
3096 if (r)
3097 noop = false;
3098 }
3099
3100 if (add_reference) {
3101 r = unit_add_dependency_hashmap(&u->dependencies, UNIT_REFERENCES, other, mask, 0);
3102 if (r < 0)
3103 return r;
3104 if (r)
3105 noop = false;
3106
3107 r = unit_add_dependency_hashmap(&other->dependencies, UNIT_REFERENCED_BY, u, 0, mask);
3108 if (r < 0)
3109 return r;
3110 if (r)
3111 noop = false;
3112 }
3113
3114 if (!noop)
3115 unit_add_to_dbus_queue(u);
3116
3117 return 0;
3118 }
3119
3120 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference, UnitDependencyMask mask) {
3121 int r;
3122
3123 assert(u);
3124
3125 r = unit_add_dependency(u, d, other, add_reference, mask);
3126 if (r < 0)
3127 return r;
3128
3129 return unit_add_dependency(u, e, other, add_reference, mask);
3130 }
3131
3132 static int resolve_template(Unit *u, const char *name, char **buf, const char **ret) {
3133 int r;
3134
3135 assert(u);
3136 assert(name);
3137 assert(buf);
3138 assert(ret);
3139
3140 if (!unit_name_is_valid(name, UNIT_NAME_TEMPLATE)) {
3141 *buf = NULL;
3142 *ret = name;
3143 return 0;
3144 }
3145
3146 if (u->instance)
3147 r = unit_name_replace_instance(name, u->instance, buf);
3148 else {
3149 _cleanup_free_ char *i = NULL;
3150
3151 r = unit_name_to_prefix(u->id, &i);
3152 if (r < 0)
3153 return r;
3154
3155 r = unit_name_replace_instance(name, i, buf);
3156 }
3157 if (r < 0)
3158 return r;
3159
3160 *ret = *buf;
3161 return 0;
3162 }
3163
3164 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, bool add_reference, UnitDependencyMask mask) {
3165 _cleanup_free_ char *buf = NULL;
3166 Unit *other;
3167 int r;
3168
3169 assert(u);
3170 assert(name);
3171
3172 r = resolve_template(u, name, &buf, &name);
3173 if (r < 0)
3174 return r;
3175
3176 r = manager_load_unit(u->manager, name, NULL, NULL, &other);
3177 if (r < 0)
3178 return r;
3179
3180 return unit_add_dependency(u, d, other, add_reference, mask);
3181 }
3182
3183 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, bool add_reference, UnitDependencyMask mask) {
3184 _cleanup_free_ char *buf = NULL;
3185 Unit *other;
3186 int r;
3187
3188 assert(u);
3189 assert(name);
3190
3191 r = resolve_template(u, name, &buf, &name);
3192 if (r < 0)
3193 return r;
3194
3195 r = manager_load_unit(u->manager, name, NULL, NULL, &other);
3196 if (r < 0)
3197 return r;
3198
3199 return unit_add_two_dependencies(u, d, e, other, add_reference, mask);
3200 }
3201
3202 int set_unit_path(const char *p) {
3203 /* This is mostly for debug purposes */
3204 if (setenv("SYSTEMD_UNIT_PATH", p, 1) < 0)
3205 return -errno;
3206
3207 return 0;
3208 }
3209
3210 char *unit_dbus_path(Unit *u) {
3211 assert(u);
3212
3213 if (!u->id)
3214 return NULL;
3215
3216 return unit_dbus_path_from_name(u->id);
3217 }
3218
3219 char *unit_dbus_path_invocation_id(Unit *u) {
3220 assert(u);
3221
3222 if (sd_id128_is_null(u->invocation_id))
3223 return NULL;
3224
3225 return unit_dbus_path_from_name(u->invocation_id_string);
3226 }
3227
3228 int unit_set_invocation_id(Unit *u, sd_id128_t id) {
3229 int r;
3230
3231 assert(u);
3232
3233 /* Set the invocation ID for this unit. If we cannot, this will not roll back, but reset the whole thing. */
3234
3235 if (sd_id128_equal(u->invocation_id, id))
3236 return 0;
3237
3238 if (!sd_id128_is_null(u->invocation_id))
3239 (void) hashmap_remove_value(u->manager->units_by_invocation_id, &u->invocation_id, u);
3240
3241 if (sd_id128_is_null(id)) {
3242 r = 0;
3243 goto reset;
3244 }
3245
3246 r = hashmap_ensure_allocated(&u->manager->units_by_invocation_id, &id128_hash_ops);
3247 if (r < 0)
3248 goto reset;
3249
3250 u->invocation_id = id;
3251 sd_id128_to_string(id, u->invocation_id_string);
3252
3253 r = hashmap_put(u->manager->units_by_invocation_id, &u->invocation_id, u);
3254 if (r < 0)
3255 goto reset;
3256
3257 return 0;
3258
3259 reset:
3260 u->invocation_id = SD_ID128_NULL;
3261 u->invocation_id_string[0] = 0;
3262 return r;
3263 }
3264
3265 int unit_set_slice(Unit *u, Unit *slice, UnitDependencyMask mask) {
3266 int r;
3267
3268 assert(u);
3269 assert(slice);
3270
3271 /* Sets the unit slice if it has not been set before. Is extra careful, to only allow this for units
3272 * that actually have a cgroup context. Also, we don't allow to set this for slices (since the parent
3273 * slice is derived from the name). Make sure the unit we set is actually a slice. */
3274
3275 if (!UNIT_HAS_CGROUP_CONTEXT(u))
3276 return -EOPNOTSUPP;
3277
3278 if (u->type == UNIT_SLICE)
3279 return -EINVAL;
3280
3281 if (unit_active_state(u) != UNIT_INACTIVE)
3282 return -EBUSY;
3283
3284 if (slice->type != UNIT_SLICE)
3285 return -EINVAL;
3286
3287 if (unit_has_name(u, SPECIAL_INIT_SCOPE) &&
3288 !unit_has_name(slice, SPECIAL_ROOT_SLICE))
3289 return -EPERM;
3290
3291 if (UNIT_GET_SLICE(u) == slice)
3292 return 0;
3293
3294 /* Disallow slice changes if @u is already bound to cgroups */
3295 if (UNIT_GET_SLICE(u) && u->cgroup_realized)
3296 return -EBUSY;
3297
3298 r = unit_add_dependency(u, UNIT_IN_SLICE, slice, true, mask);
3299 if (r < 0)
3300 return r;
3301
3302 return 1;
3303 }
3304
3305 int unit_set_default_slice(Unit *u) {
3306 const char *slice_name;
3307 Unit *slice;
3308 int r;
3309
3310 assert(u);
3311
3312 if (UNIT_GET_SLICE(u))
3313 return 0;
3314
3315 if (u->instance) {
3316 _cleanup_free_ char *prefix = NULL, *escaped = NULL;
3317
3318 /* Implicitly place all instantiated units in their
3319 * own per-template slice */
3320
3321 r = unit_name_to_prefix(u->id, &prefix);
3322 if (r < 0)
3323 return r;
3324
3325 /* The prefix is already escaped, but it might include
3326 * "-" which has a special meaning for slice units,
3327 * hence escape it here extra. */
3328 escaped = unit_name_escape(prefix);
3329 if (!escaped)
3330 return -ENOMEM;
3331
3332 if (MANAGER_IS_SYSTEM(u->manager))
3333 slice_name = strjoina("system-", escaped, ".slice");
3334 else
3335 slice_name = strjoina("app-", escaped, ".slice");
3336
3337 } else if (unit_is_extrinsic(u))
3338 /* Keep all extrinsic units (e.g. perpetual units and swap and mount units in user mode) in
3339 * the root slice. They don't really belong in one of the subslices. */
3340 slice_name = SPECIAL_ROOT_SLICE;
3341
3342 else if (MANAGER_IS_SYSTEM(u->manager))
3343 slice_name = SPECIAL_SYSTEM_SLICE;
3344 else
3345 slice_name = SPECIAL_APP_SLICE;
3346
3347 r = manager_load_unit(u->manager, slice_name, NULL, NULL, &slice);
3348 if (r < 0)
3349 return r;
3350
3351 return unit_set_slice(u, slice, UNIT_DEPENDENCY_FILE);
3352 }
3353
3354 const char *unit_slice_name(Unit *u) {
3355 Unit *slice;
3356 assert(u);
3357
3358 slice = UNIT_GET_SLICE(u);
3359 if (!slice)
3360 return NULL;
3361
3362 return slice->id;
3363 }
3364
3365 int unit_load_related_unit(Unit *u, const char *type, Unit **_found) {
3366 _cleanup_free_ char *t = NULL;
3367 int r;
3368
3369 assert(u);
3370 assert(type);
3371 assert(_found);
3372
3373 r = unit_name_change_suffix(u->id, type, &t);
3374 if (r < 0)
3375 return r;
3376 if (unit_has_name(u, t))
3377 return -EINVAL;
3378
3379 r = manager_load_unit(u->manager, t, NULL, NULL, _found);
3380 assert(r < 0 || *_found != u);
3381 return r;
3382 }
3383
3384 static int signal_name_owner_changed(sd_bus_message *message, void *userdata, sd_bus_error *error) {
3385 const char *new_owner;
3386 Unit *u = userdata;
3387 int r;
3388
3389 assert(message);
3390 assert(u);
3391
3392 r = sd_bus_message_read(message, "sss", NULL, NULL, &new_owner);
3393 if (r < 0) {
3394 bus_log_parse_error(r);
3395 return 0;
3396 }
3397
3398 if (UNIT_VTABLE(u)->bus_name_owner_change)
3399 UNIT_VTABLE(u)->bus_name_owner_change(u, empty_to_null(new_owner));
3400
3401 return 0;
3402 }
3403
3404 static int get_name_owner_handler(sd_bus_message *message, void *userdata, sd_bus_error *error) {
3405 const sd_bus_error *e;
3406 const char *new_owner;
3407 Unit *u = userdata;
3408 int r;
3409
3410 assert(message);
3411 assert(u);
3412
3413 u->get_name_owner_slot = sd_bus_slot_unref(u->get_name_owner_slot);
3414
3415 e = sd_bus_message_get_error(message);
3416 if (e) {
3417 if (!sd_bus_error_has_name(e, "org.freedesktop.DBus.Error.NameHasNoOwner"))
3418 log_unit_error(u, "Unexpected error response from GetNameOwner(): %s", e->message);
3419
3420 new_owner = NULL;
3421 } else {
3422 r = sd_bus_message_read(message, "s", &new_owner);
3423 if (r < 0)
3424 return bus_log_parse_error(r);
3425
3426 assert(!isempty(new_owner));
3427 }
3428
3429 if (UNIT_VTABLE(u)->bus_name_owner_change)
3430 UNIT_VTABLE(u)->bus_name_owner_change(u, new_owner);
3431
3432 return 0;
3433 }
3434
3435 int unit_install_bus_match(Unit *u, sd_bus *bus, const char *name) {
3436 const char *match;
3437 int r;
3438
3439 assert(u);
3440 assert(bus);
3441 assert(name);
3442
3443 if (u->match_bus_slot || u->get_name_owner_slot)
3444 return -EBUSY;
3445
3446 match = strjoina("type='signal',"
3447 "sender='org.freedesktop.DBus',"
3448 "path='/org/freedesktop/DBus',"
3449 "interface='org.freedesktop.DBus',"
3450 "member='NameOwnerChanged',"
3451 "arg0='", name, "'");
3452
3453 r = sd_bus_add_match_async(bus, &u->match_bus_slot, match, signal_name_owner_changed, NULL, u);
3454 if (r < 0)
3455 return r;
3456
3457 r = sd_bus_call_method_async(
3458 bus,
3459 &u->get_name_owner_slot,
3460 "org.freedesktop.DBus",
3461 "/org/freedesktop/DBus",
3462 "org.freedesktop.DBus",
3463 "GetNameOwner",
3464 get_name_owner_handler,
3465 u,
3466 "s", name);
3467 if (r < 0) {
3468 u->match_bus_slot = sd_bus_slot_unref(u->match_bus_slot);
3469 return r;
3470 }
3471
3472 log_unit_debug(u, "Watching D-Bus name '%s'.", name);
3473 return 0;
3474 }
3475
3476 int unit_watch_bus_name(Unit *u, const char *name) {
3477 int r;
3478
3479 assert(u);
3480 assert(name);
3481
3482 /* Watch a specific name on the bus. We only support one unit
3483 * watching each name for now. */
3484
3485 if (u->manager->api_bus) {
3486 /* If the bus is already available, install the match directly.
3487 * Otherwise, just put the name in the list. bus_setup_api() will take care later. */
3488 r = unit_install_bus_match(u, u->manager->api_bus, name);
3489 if (r < 0)
3490 return log_warning_errno(r, "Failed to subscribe to NameOwnerChanged signal for '%s': %m", name);
3491 }
3492
3493 r = hashmap_put(u->manager->watch_bus, name, u);
3494 if (r < 0) {
3495 u->match_bus_slot = sd_bus_slot_unref(u->match_bus_slot);
3496 u->get_name_owner_slot = sd_bus_slot_unref(u->get_name_owner_slot);
3497 return log_warning_errno(r, "Failed to put bus name to hashmap: %m");
3498 }
3499
3500 return 0;
3501 }
3502
3503 void unit_unwatch_bus_name(Unit *u, const char *name) {
3504 assert(u);
3505 assert(name);
3506
3507 (void) hashmap_remove_value(u->manager->watch_bus, name, u);
3508 u->match_bus_slot = sd_bus_slot_unref(u->match_bus_slot);
3509 u->get_name_owner_slot = sd_bus_slot_unref(u->get_name_owner_slot);
3510 }
3511
3512 int unit_add_node_dependency(Unit *u, const char *what, UnitDependency dep, UnitDependencyMask mask) {
3513 _cleanup_free_ char *e = NULL;
3514 Unit *device;
3515 int r;
3516
3517 assert(u);
3518
3519 /* Adds in links to the device node that this unit is based on */
3520 if (isempty(what))
3521 return 0;
3522
3523 if (!is_device_path(what))
3524 return 0;
3525
3526 /* When device units aren't supported (such as in a container), don't create dependencies on them. */
3527 if (!unit_type_supported(UNIT_DEVICE))
3528 return 0;
3529
3530 r = unit_name_from_path(what, ".device", &e);
3531 if (r < 0)
3532 return r;
3533
3534 r = manager_load_unit(u->manager, e, NULL, NULL, &device);
3535 if (r < 0)
3536 return r;
3537
3538 if (dep == UNIT_REQUIRES && device_shall_be_bound_by(device, u))
3539 dep = UNIT_BINDS_TO;
3540
3541 return unit_add_two_dependencies(u, UNIT_AFTER,
3542 MANAGER_IS_SYSTEM(u->manager) ? dep : UNIT_WANTS,
3543 device, true, mask);
3544 }
3545
3546 int unit_add_blockdev_dependency(Unit *u, const char *what, UnitDependencyMask mask) {
3547 _cleanup_free_ char *escaped = NULL, *target = NULL;
3548 int r;
3549
3550 assert(u);
3551
3552 if (isempty(what))
3553 return 0;
3554
3555 if (!path_startswith(what, "/dev/"))
3556 return 0;
3557
3558 /* If we don't support devices, then also don't bother with blockdev@.target */
3559 if (!unit_type_supported(UNIT_DEVICE))
3560 return 0;
3561
3562 r = unit_name_path_escape(what, &escaped);
3563 if (r < 0)
3564 return r;
3565
3566 r = unit_name_build("blockdev", escaped, ".target", &target);
3567 if (r < 0)
3568 return r;
3569
3570 return unit_add_dependency_by_name(u, UNIT_AFTER, target, true, mask);
3571 }
3572
3573 int unit_coldplug(Unit *u) {
3574 int r = 0, q;
3575 char **i;
3576 Job *uj;
3577
3578 assert(u);
3579
3580 /* Make sure we don't enter a loop, when coldplugging recursively. */
3581 if (u->coldplugged)
3582 return 0;
3583
3584 u->coldplugged = true;
3585
3586 STRV_FOREACH(i, u->deserialized_refs) {
3587 q = bus_unit_track_add_name(u, *i);
3588 if (q < 0 && r >= 0)
3589 r = q;
3590 }
3591 u->deserialized_refs = strv_free(u->deserialized_refs);
3592
3593 if (UNIT_VTABLE(u)->coldplug) {
3594 q = UNIT_VTABLE(u)->coldplug(u);
3595 if (q < 0 && r >= 0)
3596 r = q;
3597 }
3598
3599 uj = u->job ?: u->nop_job;
3600 if (uj) {
3601 q = job_coldplug(uj);
3602 if (q < 0 && r >= 0)
3603 r = q;
3604 }
3605
3606 return r;
3607 }
3608
3609 void unit_catchup(Unit *u) {
3610 assert(u);
3611
3612 if (UNIT_VTABLE(u)->catchup)
3613 UNIT_VTABLE(u)->catchup(u);
3614 }
3615
3616 static bool fragment_mtime_newer(const char *path, usec_t mtime, bool path_masked) {
3617 struct stat st;
3618
3619 if (!path)
3620 return false;
3621
3622 /* If the source is some virtual kernel file system, then we assume we watch it anyway, and hence pretend we
3623 * are never out-of-date. */
3624 if (PATH_STARTSWITH_SET(path, "/proc", "/sys"))
3625 return false;
3626
3627 if (stat(path, &st) < 0)
3628 /* What, cannot access this anymore? */
3629 return true;
3630
3631 if (path_masked)
3632 /* For masked files check if they are still so */
3633 return !null_or_empty(&st);
3634 else
3635 /* For non-empty files check the mtime */
3636 return timespec_load(&st.st_mtim) > mtime;
3637
3638 return false;
3639 }
3640
3641 bool unit_need_daemon_reload(Unit *u) {
3642 _cleanup_strv_free_ char **t = NULL;
3643 char **path;
3644
3645 assert(u);
3646
3647 /* For unit files, we allow masking… */
3648 if (fragment_mtime_newer(u->fragment_path, u->fragment_mtime,
3649 u->load_state == UNIT_MASKED))
3650 return true;
3651
3652 /* Source paths should not be masked… */
3653 if (fragment_mtime_newer(u->source_path, u->source_mtime, false))
3654 return true;
3655
3656 if (u->load_state == UNIT_LOADED)
3657 (void) unit_find_dropin_paths(u, &t);
3658 if (!strv_equal(u->dropin_paths, t))
3659 return true;
3660
3661 /* … any drop-ins that are masked are simply omitted from the list. */
3662 STRV_FOREACH(path, u->dropin_paths)
3663 if (fragment_mtime_newer(*path, u->dropin_mtime, false))
3664 return true;
3665
3666 return false;
3667 }
3668
3669 void unit_reset_failed(Unit *u) {
3670 assert(u);
3671
3672 if (UNIT_VTABLE(u)->reset_failed)
3673 UNIT_VTABLE(u)->reset_failed(u);
3674
3675 ratelimit_reset(&u->start_ratelimit);
3676 u->start_limit_hit = false;
3677 }
3678
3679 Unit *unit_following(Unit *u) {
3680 assert(u);
3681
3682 if (UNIT_VTABLE(u)->following)
3683 return UNIT_VTABLE(u)->following(u);
3684
3685 return NULL;
3686 }
3687
3688 bool unit_stop_pending(Unit *u) {
3689 assert(u);
3690
3691 /* This call does check the current state of the unit. It's
3692 * hence useful to be called from state change calls of the
3693 * unit itself, where the state isn't updated yet. This is
3694 * different from unit_inactive_or_pending() which checks both
3695 * the current state and for a queued job. */
3696
3697 return unit_has_job_type(u, JOB_STOP);
3698 }
3699
3700 bool unit_inactive_or_pending(Unit *u) {
3701 assert(u);
3702
3703 /* Returns true if the unit is inactive or going down */
3704
3705 if (UNIT_IS_INACTIVE_OR_DEACTIVATING(unit_active_state(u)))
3706 return true;
3707
3708 if (unit_stop_pending(u))
3709 return true;
3710
3711 return false;
3712 }
3713
3714 bool unit_active_or_pending(Unit *u) {
3715 assert(u);
3716
3717 /* Returns true if the unit is active or going up */
3718
3719 if (UNIT_IS_ACTIVE_OR_ACTIVATING(unit_active_state(u)))
3720 return true;
3721
3722 if (u->job &&
3723 IN_SET(u->job->type, JOB_START, JOB_RELOAD_OR_START, JOB_RESTART))
3724 return true;
3725
3726 return false;
3727 }
3728
3729 bool unit_will_restart_default(Unit *u) {
3730 assert(u);
3731
3732 return unit_has_job_type(u, JOB_START);
3733 }
3734
3735 bool unit_will_restart(Unit *u) {
3736 assert(u);
3737
3738 if (!UNIT_VTABLE(u)->will_restart)
3739 return false;
3740
3741 return UNIT_VTABLE(u)->will_restart(u);
3742 }
3743
3744 int unit_kill(Unit *u, KillWho w, int signo, sd_bus_error *error) {
3745 assert(u);
3746 assert(w >= 0 && w < _KILL_WHO_MAX);
3747 assert(SIGNAL_VALID(signo));
3748
3749 if (!UNIT_VTABLE(u)->kill)
3750 return -EOPNOTSUPP;
3751
3752 return UNIT_VTABLE(u)->kill(u, w, signo, error);
3753 }
3754
3755 static Set *unit_pid_set(pid_t main_pid, pid_t control_pid) {
3756 _cleanup_set_free_ Set *pid_set = NULL;
3757 int r;
3758
3759 pid_set = set_new(NULL);
3760 if (!pid_set)
3761 return NULL;
3762
3763 /* Exclude the main/control pids from being killed via the cgroup */
3764 if (main_pid > 0) {
3765 r = set_put(pid_set, PID_TO_PTR(main_pid));
3766 if (r < 0)
3767 return NULL;
3768 }
3769
3770 if (control_pid > 0) {
3771 r = set_put(pid_set, PID_TO_PTR(control_pid));
3772 if (r < 0)
3773 return NULL;
3774 }
3775
3776 return TAKE_PTR(pid_set);
3777 }
3778
3779 static int kill_common_log(pid_t pid, int signo, void *userdata) {
3780 _cleanup_free_ char *comm = NULL;
3781 Unit *u = userdata;
3782
3783 assert(u);
3784
3785 (void) get_process_comm(pid, &comm);
3786 log_unit_info(u, "Sending signal SIG%s to process " PID_FMT " (%s) on client request.",
3787 signal_to_string(signo), pid, strna(comm));
3788
3789 return 1;
3790 }
3791
3792 int unit_kill_common(
3793 Unit *u,
3794 KillWho who,
3795 int signo,
3796 pid_t main_pid,
3797 pid_t control_pid,
3798 sd_bus_error *error) {
3799
3800 int r = 0;
3801 bool killed = false;
3802
3803 /* This is the common implementation for explicit user-requested killing of unit processes, shared by
3804 * various unit types. Do not confuse with unit_kill_context(), which is what we use when we want to
3805 * stop a service ourselves. */
3806
3807 if (IN_SET(who, KILL_MAIN, KILL_MAIN_FAIL)) {
3808 if (main_pid < 0)
3809 return sd_bus_error_setf(error, BUS_ERROR_NO_SUCH_PROCESS, "%s units have no main processes", unit_type_to_string(u->type));
3810 if (main_pid == 0)
3811 return sd_bus_error_set_const(error, BUS_ERROR_NO_SUCH_PROCESS, "No main process to kill");
3812 }
3813
3814 if (IN_SET(who, KILL_CONTROL, KILL_CONTROL_FAIL)) {
3815 if (control_pid < 0)
3816 return sd_bus_error_setf(error, BUS_ERROR_NO_SUCH_PROCESS, "%s units have no control processes", unit_type_to_string(u->type));
3817 if (control_pid == 0)
3818 return sd_bus_error_set_const(error, BUS_ERROR_NO_SUCH_PROCESS, "No control process to kill");
3819 }
3820
3821 if (IN_SET(who, KILL_CONTROL, KILL_CONTROL_FAIL, KILL_ALL, KILL_ALL_FAIL))
3822 if (control_pid > 0) {
3823 _cleanup_free_ char *comm = NULL;
3824 (void) get_process_comm(control_pid, &comm);
3825
3826 if (kill(control_pid, signo) < 0) {
3827 /* Report this failure both to the logs and to the client */
3828 sd_bus_error_set_errnof(
3829 error, errno,
3830 "Failed to send signal SIG%s to control process " PID_FMT " (%s): %m",
3831 signal_to_string(signo), control_pid, strna(comm));
3832 r = log_unit_warning_errno(
3833 u, errno,
3834 "Failed to send signal SIG%s to control process " PID_FMT " (%s) on client request: %m",
3835 signal_to_string(signo), control_pid, strna(comm));
3836 } else {
3837 log_unit_info(u, "Sent signal SIG%s to control process " PID_FMT " (%s) on client request.",
3838 signal_to_string(signo), control_pid, strna(comm));
3839 killed = true;
3840 }
3841 }
3842
3843 if (IN_SET(who, KILL_MAIN, KILL_MAIN_FAIL, KILL_ALL, KILL_ALL_FAIL))
3844 if (main_pid > 0) {
3845 _cleanup_free_ char *comm = NULL;
3846 (void) get_process_comm(main_pid, &comm);
3847
3848 if (kill(main_pid, signo) < 0) {
3849 if (r == 0)
3850 sd_bus_error_set_errnof(
3851 error, errno,
3852 "Failed to send signal SIG%s to main process " PID_FMT " (%s): %m",
3853 signal_to_string(signo), main_pid, strna(comm));
3854
3855 r = log_unit_warning_errno(
3856 u, errno,
3857 "Failed to send signal SIG%s to main process " PID_FMT " (%s) on client request: %m",
3858 signal_to_string(signo), main_pid, strna(comm));
3859 } else {
3860 log_unit_info(u, "Sent signal SIG%s to main process " PID_FMT " (%s) on client request.",
3861 signal_to_string(signo), main_pid, strna(comm));
3862 killed = true;
3863 }
3864 }
3865
3866 if (IN_SET(who, KILL_ALL, KILL_ALL_FAIL) && u->cgroup_path) {
3867 _cleanup_set_free_ Set *pid_set = NULL;
3868 int q;
3869
3870 /* Exclude the main/control pids from being killed via the cgroup */
3871 pid_set = unit_pid_set(main_pid, control_pid);
3872 if (!pid_set)
3873 return log_oom();
3874
3875 q = cg_kill_recursive(SYSTEMD_CGROUP_CONTROLLER, u->cgroup_path, signo, 0, pid_set, kill_common_log, u);
3876 if (q < 0) {
3877 if (!IN_SET(q, -ESRCH, -ENOENT)) {
3878 if (r == 0)
3879 sd_bus_error_set_errnof(
3880 error, q,
3881 "Failed to send signal SIG%s to auxiliary processes: %m",
3882 signal_to_string(signo));
3883
3884 r = log_unit_warning_errno(
3885 u, q,
3886 "Failed to send signal SIG%s to auxiliary processes on client request: %m",
3887 signal_to_string(signo));
3888 }
3889 } else
3890 killed = true;
3891 }
3892
3893 /* If the "fail" versions of the operation are requested, then complain if the set of processes we killed is empty */
3894 if (r == 0 && !killed && IN_SET(who, KILL_ALL_FAIL, KILL_CONTROL_FAIL, KILL_MAIN_FAIL))
3895 return sd_bus_error_set_const(error, BUS_ERROR_NO_SUCH_PROCESS, "No matching processes to kill");
3896
3897 return r;
3898 }
3899
3900 int unit_following_set(Unit *u, Set **s) {
3901 assert(u);
3902 assert(s);
3903
3904 if (UNIT_VTABLE(u)->following_set)
3905 return UNIT_VTABLE(u)->following_set(u, s);
3906
3907 *s = NULL;
3908 return 0;
3909 }
3910
3911 UnitFileState unit_get_unit_file_state(Unit *u) {
3912 int r;
3913
3914 assert(u);
3915
3916 if (u->unit_file_state < 0 && u->fragment_path) {
3917 r = unit_file_get_state(
3918 u->manager->unit_file_scope,
3919 NULL,
3920 u->id,
3921 &u->unit_file_state);
3922 if (r < 0)
3923 u->unit_file_state = UNIT_FILE_BAD;
3924 }
3925
3926 return u->unit_file_state;
3927 }
3928
3929 int unit_get_unit_file_preset(Unit *u) {
3930 assert(u);
3931
3932 if (u->unit_file_preset < 0 && u->fragment_path)
3933 u->unit_file_preset = unit_file_query_preset(
3934 u->manager->unit_file_scope,
3935 NULL,
3936 basename(u->fragment_path),
3937 NULL);
3938
3939 return u->unit_file_preset;
3940 }
3941
3942 Unit* unit_ref_set(UnitRef *ref, Unit *source, Unit *target) {
3943 assert(ref);
3944 assert(source);
3945 assert(target);
3946
3947 if (ref->target)
3948 unit_ref_unset(ref);
3949
3950 ref->source = source;
3951 ref->target = target;
3952 LIST_PREPEND(refs_by_target, target->refs_by_target, ref);
3953 return target;
3954 }
3955
3956 void unit_ref_unset(UnitRef *ref) {
3957 assert(ref);
3958
3959 if (!ref->target)
3960 return;
3961
3962 /* We are about to drop a reference to the unit, make sure the garbage collection has a look at it as it might
3963 * be unreferenced now. */
3964 unit_add_to_gc_queue(ref->target);
3965
3966 LIST_REMOVE(refs_by_target, ref->target->refs_by_target, ref);
3967 ref->source = ref->target = NULL;
3968 }
3969
3970 static int user_from_unit_name(Unit *u, char **ret) {
3971
3972 static const uint8_t hash_key[] = {
3973 0x58, 0x1a, 0xaf, 0xe6, 0x28, 0x58, 0x4e, 0x96,
3974 0xb4, 0x4e, 0xf5, 0x3b, 0x8c, 0x92, 0x07, 0xec
3975 };
3976
3977 _cleanup_free_ char *n = NULL;
3978 int r;
3979
3980 r = unit_name_to_prefix(u->id, &n);
3981 if (r < 0)
3982 return r;
3983
3984 if (valid_user_group_name(n, 0)) {
3985 *ret = TAKE_PTR(n);
3986 return 0;
3987 }
3988
3989 /* If we can't use the unit name as a user name, then let's hash it and use that */
3990 if (asprintf(ret, "_du%016" PRIx64, siphash24(n, strlen(n), hash_key)) < 0)
3991 return -ENOMEM;
3992
3993 return 0;
3994 }
3995
3996 int unit_patch_contexts(Unit *u) {
3997 CGroupContext *cc;
3998 ExecContext *ec;
3999 int r;
4000
4001 assert(u);
4002
4003 /* Patch in the manager defaults into the exec and cgroup
4004 * contexts, _after_ the rest of the settings have been
4005 * initialized */
4006
4007 ec = unit_get_exec_context(u);
4008 if (ec) {
4009 /* This only copies in the ones that need memory */
4010 for (unsigned i = 0; i < _RLIMIT_MAX; i++)
4011 if (u->manager->rlimit[i] && !ec->rlimit[i]) {
4012 ec->rlimit[i] = newdup(struct rlimit, u->manager->rlimit[i], 1);
4013 if (!ec->rlimit[i])
4014 return -ENOMEM;
4015 }
4016
4017 if (MANAGER_IS_USER(u->manager) &&
4018 !ec->working_directory) {
4019
4020 r = get_home_dir(&ec->working_directory);
4021 if (r < 0)
4022 return r;
4023
4024 /* Allow user services to run, even if the
4025 * home directory is missing */
4026 ec->working_directory_missing_ok = true;
4027 }
4028
4029 if (ec->private_devices)
4030 ec->capability_bounding_set &= ~((UINT64_C(1) << CAP_MKNOD) | (UINT64_C(1) << CAP_SYS_RAWIO));
4031
4032 if (ec->protect_kernel_modules)
4033 ec->capability_bounding_set &= ~(UINT64_C(1) << CAP_SYS_MODULE);
4034
4035 if (ec->protect_kernel_logs)
4036 ec->capability_bounding_set &= ~(UINT64_C(1) << CAP_SYSLOG);
4037
4038 if (ec->protect_clock)
4039 ec->capability_bounding_set &= ~((UINT64_C(1) << CAP_SYS_TIME) | (UINT64_C(1) << CAP_WAKE_ALARM));
4040
4041 if (ec->dynamic_user) {
4042 if (!ec->user) {
4043 r = user_from_unit_name(u, &ec->user);
4044 if (r < 0)
4045 return r;
4046 }
4047
4048 if (!ec->group) {
4049 ec->group = strdup(ec->user);
4050 if (!ec->group)
4051 return -ENOMEM;
4052 }
4053
4054 /* If the dynamic user option is on, let's make sure that the unit can't leave its
4055 * UID/GID around in the file system or on IPC objects. Hence enforce a strict
4056 * sandbox. */
4057
4058 ec->private_tmp = true;
4059 ec->remove_ipc = true;
4060 ec->protect_system = PROTECT_SYSTEM_STRICT;
4061 if (ec->protect_home == PROTECT_HOME_NO)
4062 ec->protect_home = PROTECT_HOME_READ_ONLY;
4063
4064 /* Make sure this service can neither benefit from SUID/SGID binaries nor create
4065 * them. */
4066 ec->no_new_privileges = true;
4067 ec->restrict_suid_sgid = true;
4068 }
4069 }
4070
4071 cc = unit_get_cgroup_context(u);
4072 if (cc && ec) {
4073
4074 if (ec->private_devices &&
4075 cc->device_policy == CGROUP_DEVICE_POLICY_AUTO)
4076 cc->device_policy = CGROUP_DEVICE_POLICY_CLOSED;
4077
4078 if ((ec->root_image || !LIST_IS_EMPTY(ec->mount_images)) &&
4079 (cc->device_policy != CGROUP_DEVICE_POLICY_AUTO || cc->device_allow)) {
4080 const char *p;
4081
4082 /* When RootImage= or MountImages= is specified, the following devices are touched. */
4083 FOREACH_STRING(p, "/dev/loop-control", "/dev/mapper/control") {
4084 r = cgroup_add_device_allow(cc, p, "rw");
4085 if (r < 0)
4086 return r;
4087 }
4088 FOREACH_STRING(p, "block-loop", "block-blkext", "block-device-mapper") {
4089 r = cgroup_add_device_allow(cc, p, "rwm");
4090 if (r < 0)
4091 return r;
4092 }
4093
4094 /* Make sure "block-loop" can be resolved, i.e. make sure "loop" shows up in /proc/devices.
4095 * Same for mapper and verity. */
4096 FOREACH_STRING(p, "modprobe@loop.service", "modprobe@dm_mod.service", "modprobe@dm_verity.service") {
4097 r = unit_add_two_dependencies_by_name(u, UNIT_AFTER, UNIT_WANTS, p, true, UNIT_DEPENDENCY_FILE);
4098 if (r < 0)
4099 return r;
4100 }
4101 }
4102
4103 if (ec->protect_clock) {
4104 r = cgroup_add_device_allow(cc, "char-rtc", "r");
4105 if (r < 0)
4106 return r;
4107 }
4108 }
4109
4110 return 0;
4111 }
4112
4113 ExecContext *unit_get_exec_context(const Unit *u) {
4114 size_t offset;
4115 assert(u);
4116
4117 if (u->type < 0)
4118 return NULL;
4119
4120 offset = UNIT_VTABLE(u)->exec_context_offset;
4121 if (offset <= 0)
4122 return NULL;
4123
4124 return (ExecContext*) ((uint8_t*) u + offset);
4125 }
4126
4127 KillContext *unit_get_kill_context(Unit *u) {
4128 size_t offset;
4129 assert(u);
4130
4131 if (u->type < 0)
4132 return NULL;
4133
4134 offset = UNIT_VTABLE(u)->kill_context_offset;
4135 if (offset <= 0)
4136 return NULL;
4137
4138 return (KillContext*) ((uint8_t*) u + offset);
4139 }
4140
4141 CGroupContext *unit_get_cgroup_context(Unit *u) {
4142 size_t offset;
4143
4144 if (u->type < 0)
4145 return NULL;
4146
4147 offset = UNIT_VTABLE(u)->cgroup_context_offset;
4148 if (offset <= 0)
4149 return NULL;
4150
4151 return (CGroupContext*) ((uint8_t*) u + offset);
4152 }
4153
4154 ExecRuntime *unit_get_exec_runtime(Unit *u) {
4155 size_t offset;
4156
4157 if (u->type < 0)
4158 return NULL;
4159
4160 offset = UNIT_VTABLE(u)->exec_runtime_offset;
4161 if (offset <= 0)
4162 return NULL;
4163
4164 return *(ExecRuntime**) ((uint8_t*) u + offset);
4165 }
4166
4167 static const char* unit_drop_in_dir(Unit *u, UnitWriteFlags flags) {
4168 assert(u);
4169
4170 if (UNIT_WRITE_FLAGS_NOOP(flags))
4171 return NULL;
4172
4173 if (u->transient) /* Redirect drop-ins for transient units always into the transient directory. */
4174 return u->manager->lookup_paths.transient;
4175
4176 if (flags & UNIT_PERSISTENT)
4177 return u->manager->lookup_paths.persistent_control;
4178
4179 if (flags & UNIT_RUNTIME)
4180 return u->manager->lookup_paths.runtime_control;
4181
4182 return NULL;
4183 }
4184
4185 char* unit_escape_setting(const char *s, UnitWriteFlags flags, char **buf) {
4186 char *ret = NULL;
4187
4188 if (!s)
4189 return NULL;
4190
4191 /* Escapes the input string as requested. Returns the escaped string. If 'buf' is specified then the allocated
4192 * return buffer pointer is also written to *buf, except if no escaping was necessary, in which case *buf is
4193 * set to NULL, and the input pointer is returned as-is. This means the return value always contains a properly
4194 * escaped version, but *buf when passed only contains a pointer if an allocation was necessary. If *buf is
4195 * not specified, then the return value always needs to be freed. Callers can use this to optimize memory
4196 * allocations. */
4197
4198 if (flags & UNIT_ESCAPE_SPECIFIERS) {
4199 ret = specifier_escape(s);
4200 if (!ret)
4201 return NULL;
4202
4203 s = ret;
4204 }
4205
4206 if (flags & UNIT_ESCAPE_C) {
4207 char *a;
4208
4209 a = cescape(s);
4210 free(ret);
4211 if (!a)
4212 return NULL;
4213
4214 ret = a;
4215 }
4216
4217 if (buf) {
4218 *buf = ret;
4219 return ret ?: (char*) s;
4220 }
4221
4222 return ret ?: strdup(s);
4223 }
4224
4225 char* unit_concat_strv(char **l, UnitWriteFlags flags) {
4226 _cleanup_free_ char *result = NULL;
4227 size_t n = 0;
4228 char **i;
4229
4230 /* Takes a list of strings, escapes them, and concatenates them. This may be used to format command lines in a
4231 * way suitable for ExecStart= stanzas */
4232
4233 STRV_FOREACH(i, l) {
4234 _cleanup_free_ char *buf = NULL;
4235 const char *p;
4236 size_t a;
4237 char *q;
4238
4239 p = unit_escape_setting(*i, flags, &buf);
4240 if (!p)
4241 return NULL;
4242
4243 a = (n > 0) + 1 + strlen(p) + 1; /* separating space + " + entry + " */
4244 if (!GREEDY_REALLOC(result, n + a + 1))
4245 return NULL;
4246
4247 q = result + n;
4248 if (n > 0)
4249 *(q++) = ' ';
4250
4251 *(q++) = '"';
4252 q = stpcpy(q, p);
4253 *(q++) = '"';
4254
4255 n += a;
4256 }
4257
4258 if (!GREEDY_REALLOC(result, n + 1))
4259 return NULL;
4260
4261 result[n] = 0;
4262
4263 return TAKE_PTR(result);
4264 }
4265
4266 int unit_write_setting(Unit *u, UnitWriteFlags flags, const char *name, const char *data) {
4267 _cleanup_free_ char *p = NULL, *q = NULL, *escaped = NULL;
4268 const char *dir, *wrapped;
4269 int r;
4270
4271 assert(u);
4272 assert(name);
4273 assert(data);
4274
4275 if (UNIT_WRITE_FLAGS_NOOP(flags))
4276 return 0;
4277
4278 data = unit_escape_setting(data, flags, &escaped);
4279 if (!data)
4280 return -ENOMEM;
4281
4282 /* Prefix the section header. If we are writing this out as transient file, then let's suppress this if the
4283 * previous section header is the same */
4284
4285 if (flags & UNIT_PRIVATE) {
4286 if (!UNIT_VTABLE(u)->private_section)
4287 return -EINVAL;
4288
4289 if (!u->transient_file || u->last_section_private < 0)
4290 data = strjoina("[", UNIT_VTABLE(u)->private_section, "]\n", data);
4291 else if (u->last_section_private == 0)
4292 data = strjoina("\n[", UNIT_VTABLE(u)->private_section, "]\n", data);
4293 } else {
4294 if (!u->transient_file || u->last_section_private < 0)
4295 data = strjoina("[Unit]\n", data);
4296 else if (u->last_section_private > 0)
4297 data = strjoina("\n[Unit]\n", data);
4298 }
4299
4300 if (u->transient_file) {
4301 /* When this is a transient unit file in creation, then let's not create a new drop-in but instead
4302 * write to the transient unit file. */
4303 fputs(data, u->transient_file);
4304
4305 if (!endswith(data, "\n"))
4306 fputc('\n', u->transient_file);
4307
4308 /* Remember which section we wrote this entry to */
4309 u->last_section_private = !!(flags & UNIT_PRIVATE);
4310 return 0;
4311 }
4312
4313 dir = unit_drop_in_dir(u, flags);
4314 if (!dir)
4315 return -EINVAL;
4316
4317 wrapped = strjoina("# This is a drop-in unit file extension, created via \"systemctl set-property\"\n"
4318 "# or an equivalent operation. Do not edit.\n",
4319 data,
4320 "\n");
4321
4322 r = drop_in_file(dir, u->id, 50, name, &p, &q);
4323 if (r < 0)
4324 return r;
4325
4326 (void) mkdir_p_label(p, 0755);
4327
4328 /* Make sure the drop-in dir is registered in our path cache. This way we don't need to stupidly
4329 * recreate the cache after every drop-in we write. */
4330 if (u->manager->unit_path_cache) {
4331 r = set_put_strdup(&u->manager->unit_path_cache, p);
4332 if (r < 0)
4333 return r;
4334 }
4335
4336 r = write_string_file_atomic_label(q, wrapped);
4337 if (r < 0)
4338 return r;
4339
4340 r = strv_push(&u->dropin_paths, q);
4341 if (r < 0)
4342 return r;
4343 q = NULL;
4344
4345 strv_uniq(u->dropin_paths);
4346
4347 u->dropin_mtime = now(CLOCK_REALTIME);
4348
4349 return 0;
4350 }
4351
4352 int unit_write_settingf(Unit *u, UnitWriteFlags flags, const char *name, const char *format, ...) {
4353 _cleanup_free_ char *p = NULL;
4354 va_list ap;
4355 int r;
4356
4357 assert(u);
4358 assert(name);
4359 assert(format);
4360
4361 if (UNIT_WRITE_FLAGS_NOOP(flags))
4362 return 0;
4363
4364 va_start(ap, format);
4365 r = vasprintf(&p, format, ap);
4366 va_end(ap);
4367
4368 if (r < 0)
4369 return -ENOMEM;
4370
4371 return unit_write_setting(u, flags, name, p);
4372 }
4373
4374 int unit_make_transient(Unit *u) {
4375 _cleanup_free_ char *path = NULL;
4376 FILE *f;
4377
4378 assert(u);
4379
4380 if (!UNIT_VTABLE(u)->can_transient)
4381 return -EOPNOTSUPP;
4382
4383 (void) mkdir_p_label(u->manager->lookup_paths.transient, 0755);
4384
4385 path = path_join(u->manager->lookup_paths.transient, u->id);
4386 if (!path)
4387 return -ENOMEM;
4388
4389 /* Let's open the file we'll write the transient settings into. This file is kept open as long as we are
4390 * creating the transient, and is closed in unit_load(), as soon as we start loading the file. */
4391
4392 RUN_WITH_UMASK(0022) {
4393 f = fopen(path, "we");
4394 if (!f)
4395 return -errno;
4396 }
4397
4398 safe_fclose(u->transient_file);
4399 u->transient_file = f;
4400
4401 free_and_replace(u->fragment_path, path);
4402
4403 u->source_path = mfree(u->source_path);
4404 u->dropin_paths = strv_free(u->dropin_paths);
4405 u->fragment_mtime = u->source_mtime = u->dropin_mtime = 0;
4406
4407 u->load_state = UNIT_STUB;
4408 u->load_error = 0;
4409 u->transient = true;
4410
4411 unit_add_to_dbus_queue(u);
4412 unit_add_to_gc_queue(u);
4413
4414 fputs("# This is a transient unit file, created programmatically via the systemd API. Do not edit.\n",
4415 u->transient_file);
4416
4417 return 0;
4418 }
4419
4420 static int log_kill(pid_t pid, int sig, void *userdata) {
4421 _cleanup_free_ char *comm = NULL;
4422
4423 (void) get_process_comm(pid, &comm);
4424
4425 /* Don't log about processes marked with brackets, under the assumption that these are temporary processes
4426 only, like for example systemd's own PAM stub process. */
4427 if (comm && comm[0] == '(')
4428 return 0;
4429
4430 log_unit_notice(userdata,
4431 "Killing process " PID_FMT " (%s) with signal SIG%s.",
4432 pid,
4433 strna(comm),
4434 signal_to_string(sig));
4435
4436 return 1;
4437 }
4438
4439 static int operation_to_signal(const KillContext *c, KillOperation k, bool *noteworthy) {
4440 assert(c);
4441
4442 switch (k) {
4443
4444 case KILL_TERMINATE:
4445 case KILL_TERMINATE_AND_LOG:
4446 *noteworthy = false;
4447 return c->kill_signal;
4448
4449 case KILL_RESTART:
4450 *noteworthy = false;
4451 return restart_kill_signal(c);
4452
4453 case KILL_KILL:
4454 *noteworthy = true;
4455 return c->final_kill_signal;
4456
4457 case KILL_WATCHDOG:
4458 *noteworthy = true;
4459 return c->watchdog_signal;
4460
4461 default:
4462 assert_not_reached("KillOperation unknown");
4463 }
4464 }
4465
4466 int unit_kill_context(
4467 Unit *u,
4468 KillContext *c,
4469 KillOperation k,
4470 pid_t main_pid,
4471 pid_t control_pid,
4472 bool main_pid_alien) {
4473
4474 bool wait_for_exit = false, send_sighup;
4475 cg_kill_log_func_t log_func = NULL;
4476 int sig, r;
4477
4478 assert(u);
4479 assert(c);
4480
4481 /* Kill the processes belonging to this unit, in preparation for shutting the unit down. Returns > 0
4482 * if we killed something worth waiting for, 0 otherwise. Do not confuse with unit_kill_common()
4483 * which is used for user-requested killing of unit processes. */
4484
4485 if (c->kill_mode == KILL_NONE)
4486 return 0;
4487
4488 bool noteworthy;
4489 sig = operation_to_signal(c, k, &noteworthy);
4490 if (noteworthy)
4491 log_func = log_kill;
4492
4493 send_sighup =
4494 c->send_sighup &&
4495 IN_SET(k, KILL_TERMINATE, KILL_TERMINATE_AND_LOG) &&
4496 sig != SIGHUP;
4497
4498 if (main_pid > 0) {
4499 if (log_func)
4500 log_func(main_pid, sig, u);
4501
4502 r = kill_and_sigcont(main_pid, sig);
4503 if (r < 0 && r != -ESRCH) {
4504 _cleanup_free_ char *comm = NULL;
4505 (void) get_process_comm(main_pid, &comm);
4506
4507 log_unit_warning_errno(u, r, "Failed to kill main process " PID_FMT " (%s), ignoring: %m", main_pid, strna(comm));
4508 } else {
4509 if (!main_pid_alien)
4510 wait_for_exit = true;
4511
4512 if (r != -ESRCH && send_sighup)
4513 (void) kill(main_pid, SIGHUP);
4514 }
4515 }
4516
4517 if (control_pid > 0) {
4518 if (log_func)
4519 log_func(control_pid, sig, u);
4520
4521 r = kill_and_sigcont(control_pid, sig);
4522 if (r < 0 && r != -ESRCH) {
4523 _cleanup_free_ char *comm = NULL;
4524 (void) get_process_comm(control_pid, &comm);
4525
4526 log_unit_warning_errno(u, r, "Failed to kill control process " PID_FMT " (%s), ignoring: %m", control_pid, strna(comm));
4527 } else {
4528 wait_for_exit = true;
4529
4530 if (r != -ESRCH && send_sighup)
4531 (void) kill(control_pid, SIGHUP);
4532 }
4533 }
4534
4535 if (u->cgroup_path &&
4536 (c->kill_mode == KILL_CONTROL_GROUP || (c->kill_mode == KILL_MIXED && k == KILL_KILL))) {
4537 _cleanup_set_free_ Set *pid_set = NULL;
4538
4539 /* Exclude the main/control pids from being killed via the cgroup */
4540 pid_set = unit_pid_set(main_pid, control_pid);
4541 if (!pid_set)
4542 return -ENOMEM;
4543
4544 r = cg_kill_recursive(SYSTEMD_CGROUP_CONTROLLER, u->cgroup_path,
4545 sig,
4546 CGROUP_SIGCONT|CGROUP_IGNORE_SELF,
4547 pid_set,
4548 log_func, u);
4549 if (r < 0) {
4550 if (!IN_SET(r, -EAGAIN, -ESRCH, -ENOENT))
4551 log_unit_warning_errno(u, r, "Failed to kill control group %s, ignoring: %m", u->cgroup_path);
4552
4553 } else if (r > 0) {
4554
4555 /* FIXME: For now, on the legacy hierarchy, we will not wait for the cgroup members to die if
4556 * we are running in a container or if this is a delegation unit, simply because cgroup
4557 * notification is unreliable in these cases. It doesn't work at all in containers, and outside
4558 * of containers it can be confused easily by left-over directories in the cgroup — which
4559 * however should not exist in non-delegated units. On the unified hierarchy that's different,
4560 * there we get proper events. Hence rely on them. */
4561
4562 if (cg_unified_controller(SYSTEMD_CGROUP_CONTROLLER) > 0 ||
4563 (detect_container() == 0 && !unit_cgroup_delegate(u)))
4564 wait_for_exit = true;
4565
4566 if (send_sighup) {
4567 set_free(pid_set);
4568
4569 pid_set = unit_pid_set(main_pid, control_pid);
4570 if (!pid_set)
4571 return -ENOMEM;
4572
4573 (void) cg_kill_recursive(SYSTEMD_CGROUP_CONTROLLER, u->cgroup_path,
4574 SIGHUP,
4575 CGROUP_IGNORE_SELF,
4576 pid_set,
4577 NULL, NULL);
4578 }
4579 }
4580 }
4581
4582 return wait_for_exit;
4583 }
4584
4585 int unit_require_mounts_for(Unit *u, const char *path, UnitDependencyMask mask) {
4586 int r;
4587
4588 assert(u);
4589 assert(path);
4590
4591 /* Registers a unit for requiring a certain path and all its prefixes. We keep a hashtable of these
4592 * paths in the unit (from the path to the UnitDependencyInfo structure indicating how to the
4593 * dependency came to be). However, we build a prefix table for all possible prefixes so that new
4594 * appearing mount units can easily determine which units to make themselves a dependency of. */
4595
4596 if (!path_is_absolute(path))
4597 return -EINVAL;
4598
4599 if (hashmap_contains(u->requires_mounts_for, path)) /* Exit quickly if the path is already covered. */
4600 return 0;
4601
4602 _cleanup_free_ char *p = strdup(path);
4603 if (!p)
4604 return -ENOMEM;
4605
4606 /* Use the canonical form of the path as the stored key. We call path_is_normalized()
4607 * only after simplification, since path_is_normalized() rejects paths with '.'.
4608 * path_is_normalized() also verifies that the path fits in PATH_MAX. */
4609 path = path_simplify(p);
4610
4611 if (!path_is_normalized(path))
4612 return -EPERM;
4613
4614 UnitDependencyInfo di = {
4615 .origin_mask = mask
4616 };
4617
4618 r = hashmap_ensure_put(&u->requires_mounts_for, &path_hash_ops, p, di.data);
4619 if (r < 0)
4620 return r;
4621 assert(r > 0);
4622 TAKE_PTR(p); /* path remains a valid pointer to the string stored in the hashmap */
4623
4624 char prefix[strlen(path) + 1];
4625 PATH_FOREACH_PREFIX_MORE(prefix, path) {
4626 Set *x;
4627
4628 x = hashmap_get(u->manager->units_requiring_mounts_for, prefix);
4629 if (!x) {
4630 _cleanup_free_ char *q = NULL;
4631
4632 r = hashmap_ensure_allocated(&u->manager->units_requiring_mounts_for, &path_hash_ops);
4633 if (r < 0)
4634 return r;
4635
4636 q = strdup(prefix);
4637 if (!q)
4638 return -ENOMEM;
4639
4640 x = set_new(NULL);
4641 if (!x)
4642 return -ENOMEM;
4643
4644 r = hashmap_put(u->manager->units_requiring_mounts_for, q, x);
4645 if (r < 0) {
4646 set_free(x);
4647 return r;
4648 }
4649 q = NULL;
4650 }
4651
4652 r = set_put(x, u);
4653 if (r < 0)
4654 return r;
4655 }
4656
4657 return 0;
4658 }
4659
4660 int unit_setup_exec_runtime(Unit *u) {
4661 ExecRuntime **rt;
4662 size_t offset;
4663 Unit *other;
4664 int r;
4665
4666 offset = UNIT_VTABLE(u)->exec_runtime_offset;
4667 assert(offset > 0);
4668
4669 /* Check if there already is an ExecRuntime for this unit? */
4670 rt = (ExecRuntime**) ((uint8_t*) u + offset);
4671 if (*rt)
4672 return 0;
4673
4674 /* Try to get it from somebody else */
4675 UNIT_FOREACH_DEPENDENCY(other, u, UNIT_ATOM_JOINS_NAMESPACE_OF) {
4676 r = exec_runtime_acquire(u->manager, NULL, other->id, false, rt);
4677 if (r == 1)
4678 return 1;
4679 }
4680
4681 return exec_runtime_acquire(u->manager, unit_get_exec_context(u), u->id, true, rt);
4682 }
4683
4684 int unit_setup_dynamic_creds(Unit *u) {
4685 ExecContext *ec;
4686 DynamicCreds *dcreds;
4687 size_t offset;
4688
4689 assert(u);
4690
4691 offset = UNIT_VTABLE(u)->dynamic_creds_offset;
4692 assert(offset > 0);
4693 dcreds = (DynamicCreds*) ((uint8_t*) u + offset);
4694
4695 ec = unit_get_exec_context(u);
4696 assert(ec);
4697
4698 if (!ec->dynamic_user)
4699 return 0;
4700
4701 return dynamic_creds_acquire(dcreds, u->manager, ec->user, ec->group);
4702 }
4703
4704 bool unit_type_supported(UnitType t) {
4705 if (_unlikely_(t < 0))
4706 return false;
4707 if (_unlikely_(t >= _UNIT_TYPE_MAX))
4708 return false;
4709
4710 if (!unit_vtable[t]->supported)
4711 return true;
4712
4713 return unit_vtable[t]->supported();
4714 }
4715
4716 void unit_warn_if_dir_nonempty(Unit *u, const char* where) {
4717 int r;
4718
4719 assert(u);
4720 assert(where);
4721
4722 if (!unit_log_level_test(u, LOG_NOTICE))
4723 return;
4724
4725 r = dir_is_empty(where);
4726 if (r > 0 || r == -ENOTDIR)
4727 return;
4728 if (r < 0) {
4729 log_unit_warning_errno(u, r, "Failed to check directory %s: %m", where);
4730 return;
4731 }
4732
4733 log_unit_struct(u, LOG_NOTICE,
4734 "MESSAGE_ID=" SD_MESSAGE_OVERMOUNTING_STR,
4735 LOG_UNIT_INVOCATION_ID(u),
4736 LOG_UNIT_MESSAGE(u, "Directory %s to mount over is not empty, mounting anyway.", where),
4737 "WHERE=%s", where);
4738 }
4739
4740 int unit_fail_if_noncanonical(Unit *u, const char* where) {
4741 _cleanup_free_ char *canonical_where = NULL;
4742 int r;
4743
4744 assert(u);
4745 assert(where);
4746
4747 r = chase_symlinks(where, NULL, CHASE_NONEXISTENT, &canonical_where, NULL);
4748 if (r < 0) {
4749 log_unit_debug_errno(u, r, "Failed to check %s for symlinks, ignoring: %m", where);
4750 return 0;
4751 }
4752
4753 /* We will happily ignore a trailing slash (or any redundant slashes) */
4754 if (path_equal(where, canonical_where))
4755 return 0;
4756
4757 /* No need to mention "." or "..", they would already have been rejected by unit_name_from_path() */
4758 log_unit_struct(u, LOG_ERR,
4759 "MESSAGE_ID=" SD_MESSAGE_OVERMOUNTING_STR,
4760 LOG_UNIT_INVOCATION_ID(u),
4761 LOG_UNIT_MESSAGE(u, "Mount path %s is not canonical (contains a symlink).", where),
4762 "WHERE=%s", where);
4763
4764 return -ELOOP;
4765 }
4766
4767 bool unit_is_pristine(Unit *u) {
4768 assert(u);
4769
4770 /* Check if the unit already exists or is already around,
4771 * in a number of different ways. Note that to cater for unit
4772 * types such as slice, we are generally fine with units that
4773 * are marked UNIT_LOADED even though nothing was actually
4774 * loaded, as those unit types don't require a file on disk. */
4775
4776 return !(!IN_SET(u->load_state, UNIT_NOT_FOUND, UNIT_LOADED) ||
4777 u->fragment_path ||
4778 u->source_path ||
4779 !strv_isempty(u->dropin_paths) ||
4780 u->job ||
4781 u->merged_into);
4782 }
4783
4784 pid_t unit_control_pid(Unit *u) {
4785 assert(u);
4786
4787 if (UNIT_VTABLE(u)->control_pid)
4788 return UNIT_VTABLE(u)->control_pid(u);
4789
4790 return 0;
4791 }
4792
4793 pid_t unit_main_pid(Unit *u) {
4794 assert(u);
4795
4796 if (UNIT_VTABLE(u)->main_pid)
4797 return UNIT_VTABLE(u)->main_pid(u);
4798
4799 return 0;
4800 }
4801
4802 static void unit_unref_uid_internal(
4803 Unit *u,
4804 uid_t *ref_uid,
4805 bool destroy_now,
4806 void (*_manager_unref_uid)(Manager *m, uid_t uid, bool destroy_now)) {
4807
4808 assert(u);
4809 assert(ref_uid);
4810 assert(_manager_unref_uid);
4811
4812 /* Generic implementation of both unit_unref_uid() and unit_unref_gid(), under the assumption that uid_t and
4813 * gid_t are actually the same time, with the same validity rules.
4814 *
4815 * Drops a reference to UID/GID from a unit. */
4816
4817 assert_cc(sizeof(uid_t) == sizeof(gid_t));
4818 assert_cc(UID_INVALID == (uid_t) GID_INVALID);
4819
4820 if (!uid_is_valid(*ref_uid))
4821 return;
4822
4823 _manager_unref_uid(u->manager, *ref_uid, destroy_now);
4824 *ref_uid = UID_INVALID;
4825 }
4826
4827 static void unit_unref_uid(Unit *u, bool destroy_now) {
4828 unit_unref_uid_internal(u, &u->ref_uid, destroy_now, manager_unref_uid);
4829 }
4830
4831 static void unit_unref_gid(Unit *u, bool destroy_now) {
4832 unit_unref_uid_internal(u, (uid_t*) &u->ref_gid, destroy_now, manager_unref_gid);
4833 }
4834
4835 void unit_unref_uid_gid(Unit *u, bool destroy_now) {
4836 assert(u);
4837
4838 unit_unref_uid(u, destroy_now);
4839 unit_unref_gid(u, destroy_now);
4840 }
4841
4842 static int unit_ref_uid_internal(
4843 Unit *u,
4844 uid_t *ref_uid,
4845 uid_t uid,
4846 bool clean_ipc,
4847 int (*_manager_ref_uid)(Manager *m, uid_t uid, bool clean_ipc)) {
4848
4849 int r;
4850
4851 assert(u);
4852 assert(ref_uid);
4853 assert(uid_is_valid(uid));
4854 assert(_manager_ref_uid);
4855
4856 /* Generic implementation of both unit_ref_uid() and unit_ref_guid(), under the assumption that uid_t and gid_t
4857 * are actually the same type, and have the same validity rules.
4858 *
4859 * Adds a reference on a specific UID/GID to this unit. Each unit referencing the same UID/GID maintains a
4860 * reference so that we can destroy the UID/GID's IPC resources as soon as this is requested and the counter
4861 * drops to zero. */
4862
4863 assert_cc(sizeof(uid_t) == sizeof(gid_t));
4864 assert_cc(UID_INVALID == (uid_t) GID_INVALID);
4865
4866 if (*ref_uid == uid)
4867 return 0;
4868
4869 if (uid_is_valid(*ref_uid)) /* Already set? */
4870 return -EBUSY;
4871
4872 r = _manager_ref_uid(u->manager, uid, clean_ipc);
4873 if (r < 0)
4874 return r;
4875
4876 *ref_uid = uid;
4877 return 1;
4878 }
4879
4880 static int unit_ref_uid(Unit *u, uid_t uid, bool clean_ipc) {
4881 return unit_ref_uid_internal(u, &u->ref_uid, uid, clean_ipc, manager_ref_uid);
4882 }
4883
4884 static int unit_ref_gid(Unit *u, gid_t gid, bool clean_ipc) {
4885 return unit_ref_uid_internal(u, (uid_t*) &u->ref_gid, (uid_t) gid, clean_ipc, manager_ref_gid);
4886 }
4887
4888 static int unit_ref_uid_gid_internal(Unit *u, uid_t uid, gid_t gid, bool clean_ipc) {
4889 int r = 0, q = 0;
4890
4891 assert(u);
4892
4893 /* Reference both a UID and a GID in one go. Either references both, or neither. */
4894
4895 if (uid_is_valid(uid)) {
4896 r = unit_ref_uid(u, uid, clean_ipc);
4897 if (r < 0)
4898 return r;
4899 }
4900
4901 if (gid_is_valid(gid)) {
4902 q = unit_ref_gid(u, gid, clean_ipc);
4903 if (q < 0) {
4904 if (r > 0)
4905 unit_unref_uid(u, false);
4906
4907 return q;
4908 }
4909 }
4910
4911 return r > 0 || q > 0;
4912 }
4913
4914 int unit_ref_uid_gid(Unit *u, uid_t uid, gid_t gid) {
4915 ExecContext *c;
4916 int r;
4917
4918 assert(u);
4919
4920 c = unit_get_exec_context(u);
4921
4922 r = unit_ref_uid_gid_internal(u, uid, gid, c ? c->remove_ipc : false);
4923 if (r < 0)
4924 return log_unit_warning_errno(u, r, "Couldn't add UID/GID reference to unit, proceeding without: %m");
4925
4926 return r;
4927 }
4928
4929 void unit_notify_user_lookup(Unit *u, uid_t uid, gid_t gid) {
4930 int r;
4931
4932 assert(u);
4933
4934 /* This is invoked whenever one of the forked off processes let's us know the UID/GID its user name/group names
4935 * resolved to. We keep track of which UID/GID is currently assigned in order to be able to destroy its IPC
4936 * objects when no service references the UID/GID anymore. */
4937
4938 r = unit_ref_uid_gid(u, uid, gid);
4939 if (r > 0)
4940 unit_add_to_dbus_queue(u);
4941 }
4942
4943 int unit_acquire_invocation_id(Unit *u) {
4944 sd_id128_t id;
4945 int r;
4946
4947 assert(u);
4948
4949 r = sd_id128_randomize(&id);
4950 if (r < 0)
4951 return log_unit_error_errno(u, r, "Failed to generate invocation ID for unit: %m");
4952
4953 r = unit_set_invocation_id(u, id);
4954 if (r < 0)
4955 return log_unit_error_errno(u, r, "Failed to set invocation ID for unit: %m");
4956
4957 unit_add_to_dbus_queue(u);
4958 return 0;
4959 }
4960
4961 int unit_set_exec_params(Unit *u, ExecParameters *p) {
4962 int r;
4963
4964 assert(u);
4965 assert(p);
4966
4967 /* Copy parameters from manager */
4968 r = manager_get_effective_environment(u->manager, &p->environment);
4969 if (r < 0)
4970 return r;
4971
4972 p->confirm_spawn = manager_get_confirm_spawn(u->manager);
4973 p->cgroup_supported = u->manager->cgroup_supported;
4974 p->prefix = u->manager->prefix;
4975 SET_FLAG(p->flags, EXEC_PASS_LOG_UNIT|EXEC_CHOWN_DIRECTORIES, MANAGER_IS_SYSTEM(u->manager));
4976
4977 /* Copy parameters from unit */
4978 p->cgroup_path = u->cgroup_path;
4979 SET_FLAG(p->flags, EXEC_CGROUP_DELEGATE, unit_cgroup_delegate(u));
4980
4981 p->received_credentials = u->manager->received_credentials;
4982
4983 return 0;
4984 }
4985
4986 int unit_fork_helper_process(Unit *u, const char *name, pid_t *ret) {
4987 int r;
4988
4989 assert(u);
4990 assert(ret);
4991
4992 /* Forks off a helper process and makes sure it is a member of the unit's cgroup. Returns == 0 in the child,
4993 * and > 0 in the parent. The pid parameter is always filled in with the child's PID. */
4994
4995 (void) unit_realize_cgroup(u);
4996
4997 r = safe_fork(name, FORK_REOPEN_LOG, ret);
4998 if (r != 0)
4999 return r;
5000
5001 (void) default_signals(SIGNALS_CRASH_HANDLER, SIGNALS_IGNORE);
5002 (void) ignore_signals(SIGPIPE);
5003
5004 (void) prctl(PR_SET_PDEATHSIG, SIGTERM);
5005
5006 if (u->cgroup_path) {
5007 r = cg_attach_everywhere(u->manager->cgroup_supported, u->cgroup_path, 0, NULL, NULL);
5008 if (r < 0) {
5009 log_unit_error_errno(u, r, "Failed to join unit cgroup %s: %m", u->cgroup_path);
5010 _exit(EXIT_CGROUP);
5011 }
5012 }
5013
5014 return 0;
5015 }
5016
5017 int unit_fork_and_watch_rm_rf(Unit *u, char **paths, pid_t *ret_pid) {
5018 pid_t pid;
5019 int r;
5020
5021 assert(u);
5022 assert(ret_pid);
5023
5024 r = unit_fork_helper_process(u, "(sd-rmrf)", &pid);
5025 if (r < 0)
5026 return r;
5027 if (r == 0) {
5028 int ret = EXIT_SUCCESS;
5029 char **i;
5030
5031 STRV_FOREACH(i, paths) {
5032 r = rm_rf(*i, REMOVE_ROOT|REMOVE_PHYSICAL|REMOVE_MISSING_OK);
5033 if (r < 0) {
5034 log_error_errno(r, "Failed to remove '%s': %m", *i);
5035 ret = EXIT_FAILURE;
5036 }
5037 }
5038
5039 _exit(ret);
5040 }
5041
5042 r = unit_watch_pid(u, pid, true);
5043 if (r < 0)
5044 return r;
5045
5046 *ret_pid = pid;
5047 return 0;
5048 }
5049
5050 static void unit_update_dependency_mask(Hashmap *deps, Unit *other, UnitDependencyInfo di) {
5051 assert(deps);
5052 assert(other);
5053
5054 if (di.origin_mask == 0 && di.destination_mask == 0)
5055 /* No bit set anymore, let's drop the whole entry */
5056 assert_se(hashmap_remove(deps, other));
5057 else
5058 /* Mask was reduced, let's update the entry */
5059 assert_se(hashmap_update(deps, other, di.data) == 0);
5060 }
5061
5062 void unit_remove_dependencies(Unit *u, UnitDependencyMask mask) {
5063 Hashmap *deps;
5064 assert(u);
5065
5066 /* Removes all dependencies u has on other units marked for ownership by 'mask'. */
5067
5068 if (mask == 0)
5069 return;
5070
5071 HASHMAP_FOREACH(deps, u->dependencies) {
5072 bool done;
5073
5074 do {
5075 UnitDependencyInfo di;
5076 Unit *other;
5077
5078 done = true;
5079
5080 HASHMAP_FOREACH_KEY(di.data, other, deps) {
5081 Hashmap *other_deps;
5082
5083 if (FLAGS_SET(~mask, di.origin_mask))
5084 continue;
5085
5086 di.origin_mask &= ~mask;
5087 unit_update_dependency_mask(deps, other, di);
5088
5089 /* We updated the dependency from our unit to the other unit now. But most
5090 * dependencies imply a reverse dependency. Hence, let's delete that one
5091 * too. For that we go through all dependency types on the other unit and
5092 * delete all those which point to us and have the right mask set. */
5093
5094 HASHMAP_FOREACH(other_deps, other->dependencies) {
5095 UnitDependencyInfo dj;
5096
5097 dj.data = hashmap_get(other_deps, u);
5098 if (FLAGS_SET(~mask, dj.destination_mask))
5099 continue;
5100
5101 dj.destination_mask &= ~mask;
5102 unit_update_dependency_mask(other_deps, u, dj);
5103 }
5104
5105 unit_add_to_gc_queue(other);
5106
5107 done = false;
5108 break;
5109 }
5110
5111 } while (!done);
5112 }
5113 }
5114
5115 static int unit_get_invocation_path(Unit *u, char **ret) {
5116 char *p;
5117 int r;
5118
5119 assert(u);
5120 assert(ret);
5121
5122 if (MANAGER_IS_SYSTEM(u->manager))
5123 p = strjoin("/run/systemd/units/invocation:", u->id);
5124 else {
5125 _cleanup_free_ char *user_path = NULL;
5126 r = xdg_user_runtime_dir(&user_path, "/systemd/units/invocation:");
5127 if (r < 0)
5128 return r;
5129 p = strjoin(user_path, u->id);
5130 }
5131
5132 if (!p)
5133 return -ENOMEM;
5134
5135 *ret = p;
5136 return 0;
5137 }
5138
5139 static int unit_export_invocation_id(Unit *u) {
5140 _cleanup_free_ char *p = NULL;
5141 int r;
5142
5143 assert(u);
5144
5145 if (u->exported_invocation_id)
5146 return 0;
5147
5148 if (sd_id128_is_null(u->invocation_id))
5149 return 0;
5150
5151 r = unit_get_invocation_path(u, &p);
5152 if (r < 0)
5153 return log_unit_debug_errno(u, r, "Failed to get invocation path: %m");
5154
5155 r = symlink_atomic_label(u->invocation_id_string, p);
5156 if (r < 0)
5157 return log_unit_debug_errno(u, r, "Failed to create invocation ID symlink %s: %m", p);
5158
5159 u->exported_invocation_id = true;
5160 return 0;
5161 }
5162
5163 static int unit_export_log_level_max(Unit *u, const ExecContext *c) {
5164 const char *p;
5165 char buf[2];
5166 int r;
5167
5168 assert(u);
5169 assert(c);
5170
5171 if (u->exported_log_level_max)
5172 return 0;
5173
5174 if (c->log_level_max < 0)
5175 return 0;
5176
5177 assert(c->log_level_max <= 7);
5178
5179 buf[0] = '0' + c->log_level_max;
5180 buf[1] = 0;
5181
5182 p = strjoina("/run/systemd/units/log-level-max:", u->id);
5183 r = symlink_atomic(buf, p);
5184 if (r < 0)
5185 return log_unit_debug_errno(u, r, "Failed to create maximum log level symlink %s: %m", p);
5186
5187 u->exported_log_level_max = true;
5188 return 0;
5189 }
5190
5191 static int unit_export_log_extra_fields(Unit *u, const ExecContext *c) {
5192 _cleanup_close_ int fd = -1;
5193 struct iovec *iovec;
5194 const char *p;
5195 char *pattern;
5196 le64_t *sizes;
5197 ssize_t n;
5198 int r;
5199
5200 if (u->exported_log_extra_fields)
5201 return 0;
5202
5203 if (c->n_log_extra_fields <= 0)
5204 return 0;
5205
5206 sizes = newa(le64_t, c->n_log_extra_fields);
5207 iovec = newa(struct iovec, c->n_log_extra_fields * 2);
5208
5209 for (size_t i = 0; i < c->n_log_extra_fields; i++) {
5210 sizes[i] = htole64(c->log_extra_fields[i].iov_len);
5211
5212 iovec[i*2] = IOVEC_MAKE(sizes + i, sizeof(le64_t));
5213 iovec[i*2+1] = c->log_extra_fields[i];
5214 }
5215
5216 p = strjoina("/run/systemd/units/log-extra-fields:", u->id);
5217 pattern = strjoina(p, ".XXXXXX");
5218
5219 fd = mkostemp_safe(pattern);
5220 if (fd < 0)
5221 return log_unit_debug_errno(u, fd, "Failed to create extra fields file %s: %m", p);
5222
5223 n = writev(fd, iovec, c->n_log_extra_fields*2);
5224 if (n < 0) {
5225 r = log_unit_debug_errno(u, errno, "Failed to write extra fields: %m");
5226 goto fail;
5227 }
5228
5229 (void) fchmod(fd, 0644);
5230
5231 if (rename(pattern, p) < 0) {
5232 r = log_unit_debug_errno(u, errno, "Failed to rename extra fields file: %m");
5233 goto fail;
5234 }
5235
5236 u->exported_log_extra_fields = true;
5237 return 0;
5238
5239 fail:
5240 (void) unlink(pattern);
5241 return r;
5242 }
5243
5244 static int unit_export_log_ratelimit_interval(Unit *u, const ExecContext *c) {
5245 _cleanup_free_ char *buf = NULL;
5246 const char *p;
5247 int r;
5248
5249 assert(u);
5250 assert(c);
5251
5252 if (u->exported_log_ratelimit_interval)
5253 return 0;
5254
5255 if (c->log_ratelimit_interval_usec == 0)
5256 return 0;
5257
5258 p = strjoina("/run/systemd/units/log-rate-limit-interval:", u->id);
5259
5260 if (asprintf(&buf, "%" PRIu64, c->log_ratelimit_interval_usec) < 0)
5261 return log_oom();
5262
5263 r = symlink_atomic(buf, p);
5264 if (r < 0)
5265 return log_unit_debug_errno(u, r, "Failed to create log rate limit interval symlink %s: %m", p);
5266
5267 u->exported_log_ratelimit_interval = true;
5268 return 0;
5269 }
5270
5271 static int unit_export_log_ratelimit_burst(Unit *u, const ExecContext *c) {
5272 _cleanup_free_ char *buf = NULL;
5273 const char *p;
5274 int r;
5275
5276 assert(u);
5277 assert(c);
5278
5279 if (u->exported_log_ratelimit_burst)
5280 return 0;
5281
5282 if (c->log_ratelimit_burst == 0)
5283 return 0;
5284
5285 p = strjoina("/run/systemd/units/log-rate-limit-burst:", u->id);
5286
5287 if (asprintf(&buf, "%u", c->log_ratelimit_burst) < 0)
5288 return log_oom();
5289
5290 r = symlink_atomic(buf, p);
5291 if (r < 0)
5292 return log_unit_debug_errno(u, r, "Failed to create log rate limit burst symlink %s: %m", p);
5293
5294 u->exported_log_ratelimit_burst = true;
5295 return 0;
5296 }
5297
5298 void unit_export_state_files(Unit *u) {
5299 const ExecContext *c;
5300
5301 assert(u);
5302
5303 if (!u->id)
5304 return;
5305
5306 if (MANAGER_IS_TEST_RUN(u->manager))
5307 return;
5308
5309 /* Exports a couple of unit properties to /run/systemd/units/, so that journald can quickly query this data
5310 * from there. Ideally, journald would use IPC to query this, like everybody else, but that's hard, as long as
5311 * the IPC system itself and PID 1 also log to the journal.
5312 *
5313 * Note that these files really shouldn't be considered API for anyone else, as use a runtime file system as
5314 * IPC replacement is not compatible with today's world of file system namespaces. However, this doesn't really
5315 * apply to communication between the journal and systemd, as we assume that these two daemons live in the same
5316 * namespace at least.
5317 *
5318 * Note that some of the "files" exported here are actually symlinks and not regular files. Symlinks work
5319 * better for storing small bits of data, in particular as we can write them with two system calls, and read
5320 * them with one. */
5321
5322 (void) unit_export_invocation_id(u);
5323
5324 if (!MANAGER_IS_SYSTEM(u->manager))
5325 return;
5326
5327 c = unit_get_exec_context(u);
5328 if (c) {
5329 (void) unit_export_log_level_max(u, c);
5330 (void) unit_export_log_extra_fields(u, c);
5331 (void) unit_export_log_ratelimit_interval(u, c);
5332 (void) unit_export_log_ratelimit_burst(u, c);
5333 }
5334 }
5335
5336 void unit_unlink_state_files(Unit *u) {
5337 const char *p;
5338
5339 assert(u);
5340
5341 if (!u->id)
5342 return;
5343
5344 /* Undoes the effect of unit_export_state() */
5345
5346 if (u->exported_invocation_id) {
5347 _cleanup_free_ char *invocation_path = NULL;
5348 int r = unit_get_invocation_path(u, &invocation_path);
5349 if (r >= 0) {
5350 (void) unlink(invocation_path);
5351 u->exported_invocation_id = false;
5352 }
5353 }
5354
5355 if (!MANAGER_IS_SYSTEM(u->manager))
5356 return;
5357
5358 if (u->exported_log_level_max) {
5359 p = strjoina("/run/systemd/units/log-level-max:", u->id);
5360 (void) unlink(p);
5361
5362 u->exported_log_level_max = false;
5363 }
5364
5365 if (u->exported_log_extra_fields) {
5366 p = strjoina("/run/systemd/units/extra-fields:", u->id);
5367 (void) unlink(p);
5368
5369 u->exported_log_extra_fields = false;
5370 }
5371
5372 if (u->exported_log_ratelimit_interval) {
5373 p = strjoina("/run/systemd/units/log-rate-limit-interval:", u->id);
5374 (void) unlink(p);
5375
5376 u->exported_log_ratelimit_interval = false;
5377 }
5378
5379 if (u->exported_log_ratelimit_burst) {
5380 p = strjoina("/run/systemd/units/log-rate-limit-burst:", u->id);
5381 (void) unlink(p);
5382
5383 u->exported_log_ratelimit_burst = false;
5384 }
5385 }
5386
5387 int unit_prepare_exec(Unit *u) {
5388 int r;
5389
5390 assert(u);
5391
5392 /* Load any custom firewall BPF programs here once to test if they are existing and actually loadable.
5393 * Fail here early since later errors in the call chain unit_realize_cgroup to cgroup_context_apply are ignored. */
5394 r = bpf_firewall_load_custom(u);
5395 if (r < 0)
5396 return r;
5397
5398 /* Prepares everything so that we can fork of a process for this unit */
5399
5400 (void) unit_realize_cgroup(u);
5401
5402 if (u->reset_accounting) {
5403 (void) unit_reset_accounting(u);
5404 u->reset_accounting = false;
5405 }
5406
5407 unit_export_state_files(u);
5408
5409 r = unit_setup_exec_runtime(u);
5410 if (r < 0)
5411 return r;
5412
5413 r = unit_setup_dynamic_creds(u);
5414 if (r < 0)
5415 return r;
5416
5417 return 0;
5418 }
5419
5420 static bool ignore_leftover_process(const char *comm) {
5421 return comm && comm[0] == '('; /* Most likely our own helper process (PAM?), ignore */
5422 }
5423
5424 int unit_log_leftover_process_start(pid_t pid, int sig, void *userdata) {
5425 _cleanup_free_ char *comm = NULL;
5426
5427 (void) get_process_comm(pid, &comm);
5428
5429 if (ignore_leftover_process(comm))
5430 return 0;
5431
5432 /* During start we print a warning */
5433
5434 log_unit_warning(userdata,
5435 "Found left-over process " PID_FMT " (%s) in control group while starting unit. Ignoring.\n"
5436 "This usually indicates unclean termination of a previous run, or service implementation deficiencies.",
5437 pid, strna(comm));
5438
5439 return 1;
5440 }
5441
5442 int unit_log_leftover_process_stop(pid_t pid, int sig, void *userdata) {
5443 _cleanup_free_ char *comm = NULL;
5444
5445 (void) get_process_comm(pid, &comm);
5446
5447 if (ignore_leftover_process(comm))
5448 return 0;
5449
5450 /* During stop we only print an informational message */
5451
5452 log_unit_info(userdata,
5453 "Unit process " PID_FMT " (%s) remains running after unit stopped.",
5454 pid, strna(comm));
5455
5456 return 1;
5457 }
5458
5459 int unit_warn_leftover_processes(Unit *u, cg_kill_log_func_t log_func) {
5460 assert(u);
5461
5462 (void) unit_pick_cgroup_path(u);
5463
5464 if (!u->cgroup_path)
5465 return 0;
5466
5467 return cg_kill_recursive(SYSTEMD_CGROUP_CONTROLLER, u->cgroup_path, 0, 0, NULL, log_func, u);
5468 }
5469
5470 bool unit_needs_console(Unit *u) {
5471 ExecContext *ec;
5472 UnitActiveState state;
5473
5474 assert(u);
5475
5476 state = unit_active_state(u);
5477
5478 if (UNIT_IS_INACTIVE_OR_FAILED(state))
5479 return false;
5480
5481 if (UNIT_VTABLE(u)->needs_console)
5482 return UNIT_VTABLE(u)->needs_console(u);
5483
5484 /* If this unit type doesn't implement this call, let's use a generic fallback implementation: */
5485 ec = unit_get_exec_context(u);
5486 if (!ec)
5487 return false;
5488
5489 return exec_context_may_touch_console(ec);
5490 }
5491
5492 const char *unit_label_path(const Unit *u) {
5493 const char *p;
5494
5495 assert(u);
5496
5497 /* Returns the file system path to use for MAC access decisions, i.e. the file to read the SELinux label off
5498 * when validating access checks. */
5499
5500 p = u->source_path ?: u->fragment_path;
5501 if (!p)
5502 return NULL;
5503
5504 /* If a unit is masked, then don't read the SELinux label of /dev/null, as that really makes no sense */
5505 if (null_or_empty_path(p) > 0)
5506 return NULL;
5507
5508 return p;
5509 }
5510
5511 int unit_pid_attachable(Unit *u, pid_t pid, sd_bus_error *error) {
5512 int r;
5513
5514 assert(u);
5515
5516 /* Checks whether the specified PID is generally good for attaching, i.e. a valid PID, not our manager itself,
5517 * and not a kernel thread either */
5518
5519 /* First, a simple range check */
5520 if (!pid_is_valid(pid))
5521 return sd_bus_error_setf(error, SD_BUS_ERROR_INVALID_ARGS, "Process identifier " PID_FMT " is not valid.", pid);
5522
5523 /* Some extra safety check */
5524 if (pid == 1 || pid == getpid_cached())
5525 return sd_bus_error_setf(error, SD_BUS_ERROR_INVALID_ARGS, "Process " PID_FMT " is a manager process, refusing.", pid);
5526
5527 /* Don't even begin to bother with kernel threads */
5528 r = is_kernel_thread(pid);
5529 if (r == -ESRCH)
5530 return sd_bus_error_setf(error, SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN, "Process with ID " PID_FMT " does not exist.", pid);
5531 if (r < 0)
5532 return sd_bus_error_set_errnof(error, r, "Failed to determine whether process " PID_FMT " is a kernel thread: %m", pid);
5533 if (r > 0)
5534 return sd_bus_error_setf(error, SD_BUS_ERROR_INVALID_ARGS, "Process " PID_FMT " is a kernel thread, refusing.", pid);
5535
5536 return 0;
5537 }
5538
5539 void unit_log_success(Unit *u) {
5540 assert(u);
5541
5542 /* Let's show message "Deactivated successfully" in debug mode (when manager is user) rather than in info mode.
5543 * This message has low information value for regular users and it might be a bit overwhelming on a system with
5544 * a lot of devices. */
5545 log_unit_struct(u,
5546 MANAGER_IS_USER(u->manager) ? LOG_DEBUG : LOG_INFO,
5547 "MESSAGE_ID=" SD_MESSAGE_UNIT_SUCCESS_STR,
5548 LOG_UNIT_INVOCATION_ID(u),
5549 LOG_UNIT_MESSAGE(u, "Deactivated successfully."));
5550 }
5551
5552 void unit_log_failure(Unit *u, const char *result) {
5553 assert(u);
5554 assert(result);
5555
5556 log_unit_struct(u, LOG_WARNING,
5557 "MESSAGE_ID=" SD_MESSAGE_UNIT_FAILURE_RESULT_STR,
5558 LOG_UNIT_INVOCATION_ID(u),
5559 LOG_UNIT_MESSAGE(u, "Failed with result '%s'.", result),
5560 "UNIT_RESULT=%s", result);
5561 }
5562
5563 void unit_log_skip(Unit *u, const char *result) {
5564 assert(u);
5565 assert(result);
5566
5567 log_unit_struct(u, LOG_INFO,
5568 "MESSAGE_ID=" SD_MESSAGE_UNIT_SKIPPED_STR,
5569 LOG_UNIT_INVOCATION_ID(u),
5570 LOG_UNIT_MESSAGE(u, "Skipped due to '%s'.", result),
5571 "UNIT_RESULT=%s", result);
5572 }
5573
5574 void unit_log_process_exit(
5575 Unit *u,
5576 const char *kind,
5577 const char *command,
5578 bool success,
5579 int code,
5580 int status) {
5581
5582 int level;
5583
5584 assert(u);
5585 assert(kind);
5586
5587 /* If this is a successful exit, let's log about the exit code on DEBUG level. If this is a failure
5588 * and the process exited on its own via exit(), then let's make this a NOTICE, under the assumption
5589 * that the service already logged the reason at a higher log level on its own. Otherwise, make it a
5590 * WARNING. */
5591 if (success)
5592 level = LOG_DEBUG;
5593 else if (code == CLD_EXITED)
5594 level = LOG_NOTICE;
5595 else
5596 level = LOG_WARNING;
5597
5598 log_unit_struct(u, level,
5599 "MESSAGE_ID=" SD_MESSAGE_UNIT_PROCESS_EXIT_STR,
5600 LOG_UNIT_MESSAGE(u, "%s exited, code=%s, status=%i/%s%s",
5601 kind,
5602 sigchld_code_to_string(code), status,
5603 strna(code == CLD_EXITED
5604 ? exit_status_to_string(status, EXIT_STATUS_FULL)
5605 : signal_to_string(status)),
5606 success ? " (success)" : ""),
5607 "EXIT_CODE=%s", sigchld_code_to_string(code),
5608 "EXIT_STATUS=%i", status,
5609 "COMMAND=%s", strna(command),
5610 LOG_UNIT_INVOCATION_ID(u));
5611 }
5612
5613 int unit_exit_status(Unit *u) {
5614 assert(u);
5615
5616 /* Returns the exit status to propagate for the most recent cycle of this unit. Returns a value in the range
5617 * 0…255 if there's something to propagate. EOPNOTSUPP if the concept does not apply to this unit type, ENODATA
5618 * if no data is currently known (for example because the unit hasn't deactivated yet) and EBADE if the main
5619 * service process has exited abnormally (signal/coredump). */
5620
5621 if (!UNIT_VTABLE(u)->exit_status)
5622 return -EOPNOTSUPP;
5623
5624 return UNIT_VTABLE(u)->exit_status(u);
5625 }
5626
5627 int unit_failure_action_exit_status(Unit *u) {
5628 int r;
5629
5630 assert(u);
5631
5632 /* Returns the exit status to propagate on failure, or an error if there's nothing to propagate */
5633
5634 if (u->failure_action_exit_status >= 0)
5635 return u->failure_action_exit_status;
5636
5637 r = unit_exit_status(u);
5638 if (r == -EBADE) /* Exited, but not cleanly (i.e. by signal or such) */
5639 return 255;
5640
5641 return r;
5642 }
5643
5644 int unit_success_action_exit_status(Unit *u) {
5645 int r;
5646
5647 assert(u);
5648
5649 /* Returns the exit status to propagate on success, or an error if there's nothing to propagate */
5650
5651 if (u->success_action_exit_status >= 0)
5652 return u->success_action_exit_status;
5653
5654 r = unit_exit_status(u);
5655 if (r == -EBADE) /* Exited, but not cleanly (i.e. by signal or such) */
5656 return 255;
5657
5658 return r;
5659 }
5660
5661 int unit_test_trigger_loaded(Unit *u) {
5662 Unit *trigger;
5663
5664 /* Tests whether the unit to trigger is loaded */
5665
5666 trigger = UNIT_TRIGGER(u);
5667 if (!trigger)
5668 return log_unit_error_errno(u, SYNTHETIC_ERRNO(ENOENT),
5669 "Refusing to start, no unit to trigger.");
5670 if (trigger->load_state != UNIT_LOADED)
5671 return log_unit_error_errno(u, SYNTHETIC_ERRNO(ENOENT),
5672 "Refusing to start, unit %s to trigger not loaded.", trigger->id);
5673
5674 return 0;
5675 }
5676
5677 void unit_destroy_runtime_data(Unit *u, const ExecContext *context) {
5678 assert(u);
5679 assert(context);
5680
5681 if (context->runtime_directory_preserve_mode == EXEC_PRESERVE_NO ||
5682 (context->runtime_directory_preserve_mode == EXEC_PRESERVE_RESTART && !unit_will_restart(u)))
5683 exec_context_destroy_runtime_directory(context, u->manager->prefix[EXEC_DIRECTORY_RUNTIME]);
5684
5685 exec_context_destroy_credentials(context, u->manager->prefix[EXEC_DIRECTORY_RUNTIME], u->id);
5686 }
5687
5688 int unit_clean(Unit *u, ExecCleanMask mask) {
5689 UnitActiveState state;
5690
5691 assert(u);
5692
5693 /* Special return values:
5694 *
5695 * -EOPNOTSUPP → cleaning not supported for this unit type
5696 * -EUNATCH → cleaning not defined for this resource type
5697 * -EBUSY → unit currently can't be cleaned since it's running or not properly loaded, or has
5698 * a job queued or similar
5699 */
5700
5701 if (!UNIT_VTABLE(u)->clean)
5702 return -EOPNOTSUPP;
5703
5704 if (mask == 0)
5705 return -EUNATCH;
5706
5707 if (u->load_state != UNIT_LOADED)
5708 return -EBUSY;
5709
5710 if (u->job)
5711 return -EBUSY;
5712
5713 state = unit_active_state(u);
5714 if (!IN_SET(state, UNIT_INACTIVE))
5715 return -EBUSY;
5716
5717 return UNIT_VTABLE(u)->clean(u, mask);
5718 }
5719
5720 int unit_can_clean(Unit *u, ExecCleanMask *ret) {
5721 assert(u);
5722
5723 if (!UNIT_VTABLE(u)->clean ||
5724 u->load_state != UNIT_LOADED) {
5725 *ret = 0;
5726 return 0;
5727 }
5728
5729 /* When the clean() method is set, can_clean() really should be set too */
5730 assert(UNIT_VTABLE(u)->can_clean);
5731
5732 return UNIT_VTABLE(u)->can_clean(u, ret);
5733 }
5734
5735 bool unit_can_freeze(Unit *u) {
5736 assert(u);
5737
5738 if (UNIT_VTABLE(u)->can_freeze)
5739 return UNIT_VTABLE(u)->can_freeze(u);
5740
5741 return UNIT_VTABLE(u)->freeze;
5742 }
5743
5744 void unit_frozen(Unit *u) {
5745 assert(u);
5746
5747 u->freezer_state = FREEZER_FROZEN;
5748
5749 bus_unit_send_pending_freezer_message(u);
5750 }
5751
5752 void unit_thawed(Unit *u) {
5753 assert(u);
5754
5755 u->freezer_state = FREEZER_RUNNING;
5756
5757 bus_unit_send_pending_freezer_message(u);
5758 }
5759
5760 static int unit_freezer_action(Unit *u, FreezerAction action) {
5761 UnitActiveState s;
5762 int (*method)(Unit*);
5763 int r;
5764
5765 assert(u);
5766 assert(IN_SET(action, FREEZER_FREEZE, FREEZER_THAW));
5767
5768 method = action == FREEZER_FREEZE ? UNIT_VTABLE(u)->freeze : UNIT_VTABLE(u)->thaw;
5769 if (!method || !cg_freezer_supported())
5770 return -EOPNOTSUPP;
5771
5772 if (u->job)
5773 return -EBUSY;
5774
5775 if (u->load_state != UNIT_LOADED)
5776 return -EHOSTDOWN;
5777
5778 s = unit_active_state(u);
5779 if (s != UNIT_ACTIVE)
5780 return -EHOSTDOWN;
5781
5782 if (IN_SET(u->freezer_state, FREEZER_FREEZING, FREEZER_THAWING))
5783 return -EALREADY;
5784
5785 r = method(u);
5786 if (r <= 0)
5787 return r;
5788
5789 return 1;
5790 }
5791
5792 int unit_freeze(Unit *u) {
5793 return unit_freezer_action(u, FREEZER_FREEZE);
5794 }
5795
5796 int unit_thaw(Unit *u) {
5797 return unit_freezer_action(u, FREEZER_THAW);
5798 }
5799
5800 /* Wrappers around low-level cgroup freezer operations common for service and scope units */
5801 int unit_freeze_vtable_common(Unit *u) {
5802 return unit_cgroup_freezer_action(u, FREEZER_FREEZE);
5803 }
5804
5805 int unit_thaw_vtable_common(Unit *u) {
5806 return unit_cgroup_freezer_action(u, FREEZER_THAW);
5807 }
5808
5809 static const char* const collect_mode_table[_COLLECT_MODE_MAX] = {
5810 [COLLECT_INACTIVE] = "inactive",
5811 [COLLECT_INACTIVE_OR_FAILED] = "inactive-or-failed",
5812 };
5813
5814 DEFINE_STRING_TABLE_LOOKUP(collect_mode, CollectMode);
5815
5816 Unit* unit_has_dependency(const Unit *u, UnitDependencyAtom atom, Unit *other) {
5817 Unit *i;
5818
5819 assert(u);
5820
5821 /* Checks if the unit has a dependency on 'other' with the specified dependency atom. If 'other' is
5822 * NULL checks if the unit has *any* dependency of that atom. Returns 'other' if found (or if 'other'
5823 * is NULL the first entry found), or NULL if not found. */
5824
5825 UNIT_FOREACH_DEPENDENCY(i, u, atom)
5826 if (!other || other == i)
5827 return i;
5828
5829 return NULL;
5830 }
5831
5832 int unit_get_dependency_array(const Unit *u, UnitDependencyAtom atom, Unit ***ret_array) {
5833 _cleanup_free_ Unit **array = NULL;
5834 size_t n = 0;
5835 Unit *other;
5836
5837 assert(u);
5838 assert(ret_array);
5839
5840 /* Gets a list of units matching a specific atom as array. This is useful when iterating through
5841 * dependencies while modifying them: the array is an "atomic snapshot" of sorts, that can be read
5842 * while the dependency table is continuously updated. */
5843
5844 UNIT_FOREACH_DEPENDENCY(other, u, atom) {
5845 if (!GREEDY_REALLOC(array, n + 1))
5846 return -ENOMEM;
5847
5848 array[n++] = other;
5849 }
5850
5851 *ret_array = TAKE_PTR(array);
5852
5853 assert(n <= INT_MAX);
5854 return (int) n;
5855 }