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