]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/core/unit.c
projects / thirdparty / systemd.git / blob
? search:


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