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