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