]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/core/unit.h
execute: Do not pass destroy as a boolean argument to unref()
[thirdparty/systemd.git] / src / core / unit.h
CommitLineData
db9ecf05 1/* SPDX-License-Identifier: LGPL-2.1-or-later */
c2f1db8f 2#pragma once
87f0e418
LP
3
4#include <stdbool.h>
5#include <stdlib.h>
84ebe6f0 6#include <sys/socket.h>
bbc9006e 7#include <unistd.h>
87f0e418 8
2d3b784d
ZJS
9#include "sd-id128.h"
10
6a48d82f 11#include "bpf-program.h"
134e56dc 12#include "condition.h"
87a47f99 13#include "emergency-action.h"
71d35b6b 14#include "list.h"
5bcf34eb 15#include "show-status.h"
fab34748 16#include "set.h"
5cfa33e0 17#include "unit-file.h"
6b659ed8 18#include "cgroup.h"
87f0e418 19
57b7a260
FS
20typedef struct UnitRef UnitRef;
21
db2cb23b
UTL
22typedef enum KillOperation {
23 KILL_TERMINATE,
1d98fef1 24 KILL_TERMINATE_AND_LOG,
a232ebcc 25 KILL_RESTART,
db2cb23b 26 KILL_KILL,
c87700a1 27 KILL_WATCHDOG,
4940c0b0 28 _KILL_OPERATION_MAX,
2d93c20e 29 _KILL_OPERATION_INVALID = -EINVAL,
db2cb23b
UTL
30} KillOperation;
31
5afe510c
LP
32typedef enum CollectMode {
33 COLLECT_INACTIVE,
34 COLLECT_INACTIVE_OR_FAILED,
35 _COLLECT_MODE_MAX,
2d93c20e 36 _COLLECT_MODE_INVALID = -EINVAL,
5afe510c
LP
37} CollectMode;
38
87f0e418 39static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) {
3742095b 40 return IN_SET(t, UNIT_ACTIVE, UNIT_RELOADING);
87f0e418
LP
41}
42
43static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) {
3742095b 44 return IN_SET(t, UNIT_ACTIVE, UNIT_ACTIVATING, UNIT_RELOADING);
87f0e418
LP
45}
46
47static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) {
3742095b 48 return IN_SET(t, UNIT_INACTIVE, UNIT_FAILED, UNIT_DEACTIVATING);
6124958c
LP
49}
50
fdf20a31 51static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t) {
3742095b 52 return IN_SET(t, UNIT_INACTIVE, UNIT_FAILED);
87f0e418
LP
53}
54
0377cd29
LP
55static inline bool UNIT_IS_LOAD_COMPLETE(UnitLoadState t) {
56 return t >= 0 && t < _UNIT_LOAD_STATE_MAX && t != UNIT_STUB && t != UNIT_MERGED;
57}
58
eef85c4a
LP
59/* Stores the 'reason' a dependency was created as a bit mask, i.e. due to which configuration source it came to be. We
60 * use this so that we can selectively flush out parts of dependencies again. Note that the same dependency might be
61 * created as a result of multiple "reasons", hence the bitmask. */
62typedef enum UnitDependencyMask {
5238e957 63 /* Configured directly by the unit file, .wants/.requires symlink or drop-in, or as an immediate result of a
eef85c4a
LP
64 * non-dependency option configured that way. */
65 UNIT_DEPENDENCY_FILE = 1 << 0,
66
67 /* As unconditional implicit dependency (not affected by unit configuration — except by the unit name and
68 * type) */
69 UNIT_DEPENDENCY_IMPLICIT = 1 << 1,
70
71 /* A dependency effected by DefaultDependencies=yes. Note that dependencies marked this way are conceptually
72 * just a subset of UNIT_DEPENDENCY_FILE, as DefaultDependencies= is itself a unit file setting that can only
73 * be set in unit files. We make this two separate bits only to help debugging how dependencies came to be. */
74 UNIT_DEPENDENCY_DEFAULT = 1 << 2,
75
76 /* A dependency created from udev rules */
77 UNIT_DEPENDENCY_UDEV = 1 << 3,
78
79 /* A dependency created because of some unit's RequiresMountsFor= setting */
80 UNIT_DEPENDENCY_PATH = 1 << 4,
81
87c734ee
FB
82 /* A dependency initially configured from the mount unit file however the dependency will be updated
83 * from /proc/self/mountinfo as soon as the kernel will make the entry for that mount available in
84 * the /proc file */
85 UNIT_DEPENDENCY_MOUNT_FILE = 1 << 5,
86
87 /* A dependency created or updated because of data read from /proc/self/mountinfo */
88 UNIT_DEPENDENCY_MOUNTINFO = 1 << 6,
49267b1b 89
eef85c4a 90 /* A dependency created because of data read from /proc/swaps and no other configuration source */
87c734ee 91 UNIT_DEPENDENCY_PROC_SWAP = 1 << 7,
eef85c4a 92
899acf5c 93 /* A dependency for units in slices assigned by directly setting Slice= */
87c734ee 94 UNIT_DEPENDENCY_SLICE_PROPERTY = 1 << 8,
899acf5c 95
87c734ee 96 _UNIT_DEPENDENCY_MASK_FULL = (1 << 9) - 1,
eef85c4a
LP
97} UnitDependencyMask;
98
99/* The Unit's dependencies[] hashmaps use this structure as value. It has the same size as a void pointer, and thus can
100 * be stored directly as hashmap value, without any indirection. Note that this stores two masks, as both the origin
101 * and the destination of a dependency might have created it. */
102typedef union UnitDependencyInfo {
103 void *data;
104 struct {
105 UnitDependencyMask origin_mask:16;
106 UnitDependencyMask destination_mask:16;
107 } _packed_;
108} UnitDependencyInfo;
109
48b92b37
LB
110/* Store information about why a unit was activated.
111 * We start with trigger units (.path/.timer), eventually it will be expanded to include more metadata. */
112typedef struct ActivationDetails {
113 unsigned n_ref;
114 UnitType trigger_unit_type;
115 char *trigger_unit_name;
116} ActivationDetails;
117
118/* For casting an activation event into the various unit-specific types */
119#define DEFINE_ACTIVATION_DETAILS_CAST(UPPERCASE, MixedCase, UNIT_TYPE) \
120 static inline MixedCase* UPPERCASE(ActivationDetails *a) { \
121 if (_unlikely_(!a || a->trigger_unit_type != UNIT_##UNIT_TYPE)) \
122 return NULL; \
123 \
124 return (MixedCase*) a; \
125 }
126
127/* For casting the various unit types into a unit */
128#define ACTIVATION_DETAILS(u) \
129 ({ \
130 typeof(u) _u_ = (u); \
131 ActivationDetails *_w_ = _u_ ? &(_u_)->meta : NULL; \
132 _w_; \
133 })
134
135ActivationDetails *activation_details_new(Unit *trigger_unit);
136ActivationDetails *activation_details_ref(ActivationDetails *p);
137ActivationDetails *activation_details_unref(ActivationDetails *p);
138void activation_details_serialize(ActivationDetails *p, FILE *f);
139int activation_details_deserialize(const char *key, const char *value, ActivationDetails **info);
140int activation_details_append_env(ActivationDetails *info, char ***strv);
141int activation_details_append_pair(ActivationDetails *info, char ***strv);
142DEFINE_TRIVIAL_CLEANUP_FUNC(ActivationDetails*, activation_details_unref);
143
144typedef struct ActivationDetailsVTable {
145 /* How much memory does an object of this activation type need */
146 size_t object_size;
147
148 /* This should reset all type-specific variables. This should not allocate memory, and is called
149 * with zero-initialized data. It should hence only initialize variables that need to be set != 0. */
150 void (*init)(ActivationDetails *info, Unit *trigger_unit);
151
152 /* This should free all type-specific variables. It should be idempotent. */
153 void (*done)(ActivationDetails *info);
154
155 /* This should serialize all type-specific variables. */
156 void (*serialize)(ActivationDetails *info, FILE *f);
157
158 /* This should deserialize all type-specific variables, one at a time. */
159 int (*deserialize)(const char *key, const char *value, ActivationDetails **info);
160
161 /* This should format the type-specific variables for the env block of the spawned service,
162 * and return the number of added items. */
163 int (*append_env)(ActivationDetails *info, char ***strv);
164
165 /* This should append type-specific variables as key/value pairs for the D-Bus property of the job,
166 * and return the number of added pairs. */
167 int (*append_pair)(ActivationDetails *info, char ***strv);
168} ActivationDetailsVTable;
169
170extern const ActivationDetailsVTable * const activation_details_vtable[_UNIT_TYPE_MAX];
171
172static inline const ActivationDetailsVTable* ACTIVATION_DETAILS_VTABLE(const ActivationDetails *a) {
173 assert(a);
174 assert(a->trigger_unit_type < _UNIT_TYPE_MAX);
175
176 return activation_details_vtable[a->trigger_unit_type];
177}
178
15ed3c3a
LP
179/* Newer LLVM versions don't like implicit casts from large pointer types to smaller enums, hence let's add
180 * explicit type-safe helpers for that. */
181static inline UnitDependency UNIT_DEPENDENCY_FROM_PTR(const void *p) {
182 return PTR_TO_INT(p);
183}
184
185static inline void* UNIT_DEPENDENCY_TO_PTR(UnitDependency d) {
186 return INT_TO_PTR(d);
187}
188
ef734fd6
LP
189#include "job.h"
190
a016b922
LP
191struct UnitRef {
192 /* Keeps tracks of references to a unit. This is useful so
193 * that we can merge two units if necessary and correct all
194 * references to them */
195
7f7d01ed
ZJS
196 Unit *source, *target;
197 LIST_FIELDS(UnitRef, refs_by_target);
a016b922
LP
198};
199
57b7a260 200typedef struct Unit {
87f0e418 201 Manager *manager;
23a177ef 202
87f0e418
LP
203 UnitType type;
204 UnitLoadState load_state;
23a177ef 205 Unit *merged_into;
87f0e418 206
4562c355 207 char *id; /* The one special name that we use for identification */
9e2f7c11 208 char *instance;
87f0e418 209
4562c355 210 Set *aliases; /* All the other names. */
87f0e418 211
15ed3c3a
LP
212 /* For each dependency type we can look up another Hashmap with this, whose key is a Unit* object,
213 * and whose value encodes why the dependency exists, using the UnitDependencyInfo type. i.e. a
214 * Hashmap(UnitDependency → Hashmap(Unit* → UnitDependencyInfo)) */
215 Hashmap *dependencies;
eef85c4a 216
15ed3c3a
LP
217 /* Similar, for RequiresMountsFor= path dependencies. The key is the path, the value the
218 * UnitDependencyInfo type */
eef85c4a 219 Hashmap *requires_mounts_for;
7c8fa05c 220
87f0e418 221 char *description;
49dbfa7b 222 char **documentation;
faf919f1 223
23e9a7dd
LP
224 /* The SELinux context used for checking access to this unit read off the unit file at load time (do
225 * not confuse with the selinux_context field in ExecContext which is the SELinux context we'll set
226 * for processes) */
227 char *access_selinux_context;
228
6be1e7d5 229 char *fragment_path; /* if loaded from a config file this is the primary path to it */
1b64d026 230 char *source_path; /* if converted, the source file */
ae7a7182 231 char **dropin_paths;
f78f265f 232
c2911d48 233 usec_t fragment_not_found_timestamp_hash;
45fb0699 234 usec_t fragment_mtime;
1b64d026 235 usec_t source_mtime;
ae7a7182 236 usec_t dropin_mtime;
87f0e418 237
4f4afc88
LP
238 /* If this is a transient unit we are currently writing, this is where we are writing it to */
239 FILE *transient_file;
240
8c2524c7 241 /* Freezer state */
af1e3365 242 sd_bus_message *pending_freezer_invocation;
8c2524c7
ZJS
243 FreezerState freezer_state;
244
245 /* Job timeout and action to take */
246 EmergencyAction job_timeout_action;
247 usec_t job_timeout;
248 usec_t job_running_timeout;
249 char *job_timeout_reboot_arg;
250
e0209d83 251 /* If there is something to do with this unit, then this is the installed job for it */
87f0e418
LP
252 Job *job;
253
e0209d83
MS
254 /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
255 Job *nop_job;
256
bbc29086
DM
257 /* The slot used for watching NameOwnerChanged signals */
258 sd_bus_slot *match_bus_slot;
a5a8776a 259 sd_bus_slot *get_name_owner_slot;
bbc29086 260
05a98afd
LP
261 /* References to this unit from clients */
262 sd_bus_track *bus_track;
263 char **deserialized_refs;
264
57020a3a 265 /* References to this */
7f7d01ed 266 LIST_HEAD(UnitRef, refs_by_target);
57020a3a 267
52661efd
LP
268 /* Conditions to check */
269 LIST_HEAD(Condition, conditions);
59fccdc5 270 LIST_HEAD(Condition, asserts);
52661efd 271
90bbc946 272 dual_timestamp condition_timestamp;
59fccdc5 273 dual_timestamp assert_timestamp;
90bbc946 274
a483fb59
LP
275 /* Updated whenever the low-level state changes */
276 dual_timestamp state_change_timestamp;
277
278 /* Updated whenever the (high-level) active state enters or leaves the active or inactive states */
63983207
LP
279 dual_timestamp inactive_exit_timestamp;
280 dual_timestamp active_enter_timestamp;
281 dual_timestamp active_exit_timestamp;
282 dual_timestamp inactive_enter_timestamp;
87f0e418 283
ef734fd6 284 /* Per type list */
ac155bb8 285 LIST_FIELDS(Unit, units_by_type);
c1e1601e 286
701cc384 287 /* Load queue */
ac155bb8 288 LIST_FIELDS(Unit, load_queue);
701cc384 289
c1e1601e 290 /* D-Bus queue */
ac155bb8 291 LIST_FIELDS(Unit, dbus_queue);
23a177ef
LP
292
293 /* Cleanup queue */
ac155bb8 294 LIST_FIELDS(Unit, cleanup_queue);
9d58f1db 295
701cc384 296 /* GC queue */
ac155bb8 297 LIST_FIELDS(Unit, gc_queue);
701cc384 298
4ad49000 299 /* CGroup realize members queue */
91a6073e 300 LIST_FIELDS(Unit, cgroup_realize_queue);
4ad49000 301
09e24654
LP
302 /* cgroup empty queue */
303 LIST_FIELDS(Unit, cgroup_empty_queue);
304
afcfaa69
LP
305 /* cgroup OOM queue */
306 LIST_FIELDS(Unit, cgroup_oom_queue);
307
19496554
MS
308 /* Target dependencies queue */
309 LIST_FIELDS(Unit, target_deps_queue);
310
0bc488c9 311 /* Queue of units with StopWhenUnneeded= set that shall be checked for clean-up. */
a3c1168a
LP
312 LIST_FIELDS(Unit, stop_when_unneeded_queue);
313
0bc488c9
LP
314 /* Queue of units that have an Uphold= dependency from some other unit, and should be checked for starting */
315 LIST_FIELDS(Unit, start_when_upheld_queue);
316
56c59592
LP
317 /* Queue of units that have a BindTo= dependency on some other unit, and should possibly be shut down */
318 LIST_FIELDS(Unit, stop_when_bound_queue);
319
a911bb9a
LP
320 /* PIDs we keep an eye on. Note that a unit might have many
321 * more, but these are the ones we care enough about to
322 * process SIGCHLD for */
323 Set *pids;
324
62a76913
LP
325 /* Used in SIGCHLD and sd_notify() message event invocation logic to avoid that we dispatch the same event
326 * multiple times on the same unit. */
327 unsigned sigchldgen;
328 unsigned notifygen;
36f20ae3 329
701cc384 330 /* Used during GC sweeps */
eced69b3 331 unsigned gc_marker;
701cc384 332
8821a00f
LP
333 /* Error code when we didn't manage to load the unit (negative) */
334 int load_error;
335
6bf0f408 336 /* Put a ratelimit on unit starting */
7bf081a1 337 RateLimit start_ratelimit;
87a47f99 338 EmergencyAction start_limit_action;
53c35a76 339
ff68472a
ZJS
340 /* The unit has been marked for reload, restart, etc. Stored as 1u << marker1 | 1u << marker2. */
341 unsigned markers;
342
7af67e9a
LP
343 /* What to do on failure or success */
344 EmergencyAction success_action, failure_action;
345 int success_action_exit_status, failure_action_exit_status;
6bf0f408
LP
346 char *reboot_arg;
347
0bc488c9
LP
348 /* Make sure we never enter endless loops with the StopWhenUnneeded=, BindsTo=, Uphold= logic */
349 RateLimit auto_start_stop_ratelimit;
bea355da 350
00d9ef85
LP
351 /* Reference to a specific UID/GID */
352 uid_t ref_uid;
353 gid_t ref_gid;
354
d2dc52db 355 /* Cached unit file state and preset */
a4375746 356 UnitFileState unit_file_state;
d2dc52db 357 int unit_file_preset;
a4375746 358
66ebf6c0
TH
359 /* Where the cpu.stat or cpuacct.usage was at the time the unit was started */
360 nsec_t cpu_usage_base;
fe700f46 361 nsec_t cpu_usage_last; /* the most recently read value */
5ad096b3 362
38c41427 363 /* The current counter of OOM kills initiated by systemd-oomd */
fe8d22fb
AZ
364 uint64_t managed_oom_kill_last;
365
366 /* The current counter of the oom_kill field in the memory.events cgroup attribute */
afcfaa69
LP
367 uint64_t oom_kill_last;
368
fbe14fc9
LP
369 /* Where the io.stat data was at the time the unit was started */
370 uint64_t io_accounting_base[_CGROUP_IO_ACCOUNTING_METRIC_MAX];
371 uint64_t io_accounting_last[_CGROUP_IO_ACCOUNTING_METRIC_MAX]; /* the most recently read value */
372
7c52a17b
ZJS
373 /* Counterparts in the cgroup filesystem */
374 char *cgroup_path;
184b4f78 375 uint64_t cgroup_id;
4e1dfa45
CD
376 CGroupMask cgroup_realized_mask; /* In which hierarchies does this unit's cgroup exist? (only relevant on cgroup v1) */
377 CGroupMask cgroup_enabled_mask; /* Which controllers are enabled (or more correctly: enabled for the children) for this unit's cgroup? (only relevant on cgroup v2) */
5238e957 378 CGroupMask cgroup_invalidated_mask; /* A mask specifying controllers which shall be considered invalidated, and require re-realization */
5a62e5e2 379 CGroupMask cgroup_members_mask; /* A cache for the controllers required by all children of this cgroup (only relevant for slice units) */
afcfaa69
LP
380
381 /* Inotify watch descriptors for watching cgroup.events and memory.events on cgroupv2 */
0bb814c2 382 int cgroup_control_inotify_wd;
afcfaa69 383 int cgroup_memory_inotify_wd;
7c52a17b 384
084c7007
RG
385 /* Device Controller BPF program */
386 BPFProgram *bpf_device_control_installed;
387
6a48d82f
DM
388 /* IP BPF Firewalling/accounting */
389 int ip_accounting_ingress_map_fd;
390 int ip_accounting_egress_map_fd;
0fd9c28c 391 uint64_t ip_accounting_extra[_CGROUP_IP_ACCOUNTING_METRIC_MAX];
6a48d82f
DM
392
393 int ipv4_allow_map_fd;
394 int ipv6_allow_map_fd;
395 int ipv4_deny_map_fd;
396 int ipv6_deny_map_fd;
aa2b6f1d
LP
397 BPFProgram *ip_bpf_ingress, *ip_bpf_ingress_installed;
398 BPFProgram *ip_bpf_egress, *ip_bpf_egress_installed;
0fd9c28c 399
fab34748
KL
400 Set *ip_bpf_custom_ingress;
401 Set *ip_bpf_custom_ingress_installed;
402 Set *ip_bpf_custom_egress;
403 Set *ip_bpf_custom_egress_installed;
6a48d82f 404
5f8ba20d
JK
405 /* BPF programs managed (e.g. loaded to kernel) by an entity external to systemd,
406 * attached to unit cgroup by provided program fd and attach type. */
407 Hashmap *bpf_foreign_by_key;
408
3d027d4d 409 FDSet *initial_socket_bind_link_fds;
91ce91c7
JK
410#if BPF_FRAMEWORK
411 /* BPF links to BPF programs attached to cgroup/bind{4|6} hooks and
412 * responsible for allowing or denying a unit to bind(2) to a socket
413 * address. */
414 struct bpf_link *ipv4_socket_bind_link;
415 struct bpf_link *ipv6_socket_bind_link;
416#endif
417
6f50d4f7
MV
418 FDSet *initial_restric_ifaces_link_fds;
419#if BPF_FRAMEWORK
420 struct bpf_link *restrict_ifaces_ingress_bpf_link;
421 struct bpf_link *restrict_ifaces_egress_bpf_link;
422#endif
423
50be4f4a
LP
424 /* Low-priority event source which is used to remove watched PIDs that have gone away, and subscribe to any new
425 * ones which might have appeared. */
426 sd_event_source *rewatch_pids_event_source;
427
294446dc
LP
428 /* How to start OnSuccess=/OnFailure= units */
429 JobMode on_success_job_mode;
7c52a17b
ZJS
430 JobMode on_failure_job_mode;
431
48b92b37
LB
432 /* If the job had a specific trigger that needs to be advertised (eg: a path unit), store it. */
433 ActivationDetails *activation_details;
434
5afe510c
LP
435 /* Tweaking the GC logic */
436 CollectMode collect_mode;
437
4b58153d
LP
438 /* The current invocation ID */
439 sd_id128_t invocation_id;
440 char invocation_id_string[SD_ID128_STRING_MAX]; /* useful when logging */
441
9d58f1db
LP
442 /* Garbage collect us we nobody wants or requires us anymore */
443 bool stop_when_unneeded;
444
35b8ca3a 445 /* Create default dependencies */
a40eb732
LP
446 bool default_dependencies;
447
b5e9dba8
LP
448 /* Refuse manual starting, allow starting only indirectly via dependency. */
449 bool refuse_manual_start;
450
451 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
452 bool refuse_manual_stop;
453
2528a7a6
LP
454 /* Allow isolation requests */
455 bool allow_isolate;
456
c8f4d764
LP
457 /* Ignore this unit when isolating */
458 bool ignore_on_isolate;
459
49f43d5f 460 /* Did the last condition check succeed? */
90bbc946 461 bool condition_result;
59fccdc5 462 bool assert_result;
90bbc946 463
c2756a68
LP
464 /* Is this a transient unit? */
465 bool transient;
466
f5869324
LP
467 /* Is this a unit that is always running and cannot be stopped? */
468 bool perpetual;
469
66fa4bdd 470 /* Booleans indicating membership of this unit in the various queues */
9d58f1db
LP
471 bool in_load_queue:1;
472 bool in_dbus_queue:1;
473 bool in_cleanup_queue:1;
701cc384 474 bool in_gc_queue:1;
91a6073e 475 bool in_cgroup_realize_queue:1;
09e24654 476 bool in_cgroup_empty_queue:1;
afcfaa69 477 bool in_cgroup_oom_queue:1;
19496554 478 bool in_target_deps_queue:1;
a3c1168a 479 bool in_stop_when_unneeded_queue:1;
0bc488c9 480 bool in_start_when_upheld_queue:1;
56c59592 481 bool in_stop_when_bound_queue:1;
701cc384 482
9d58f1db 483 bool sent_dbus_new_signal:1;
6c073082 484
8c2524c7
ZJS
485 bool job_running_timeout_set:1;
486
cd6d0a45 487 bool in_audit:1;
adefcf28 488 bool on_console:1;
a57f7e2c
LP
489
490 bool cgroup_realized:1;
bc432dc7 491 bool cgroup_members_mask_valid:1;
f78f265f 492
3c7416b6
LP
493 /* Reset cgroup accounting next time we fork something off */
494 bool reset_accounting:1;
495
6bf0f408
LP
496 bool start_limit_hit:1;
497
f78f265f 498 /* Did we already invoke unit_coldplug() for this unit? */
f8a30ce5 499 bool coldplugged:1;
05a98afd
LP
500
501 /* For transient units: whether to add a bus track reference after creating the unit */
502 bool bus_track_add:1;
d3070fbd
LP
503
504 /* Remember which unit state files we created */
505 bool exported_invocation_id:1;
506 bool exported_log_level_max:1;
507 bool exported_log_extra_fields:1;
5ac1530e
ZJS
508 bool exported_log_ratelimit_interval:1;
509 bool exported_log_ratelimit_burst:1;
2e59b241 510
527ede0c
FB
511 /* Whether we warned about clamping the CPU quota period */
512 bool warned_clamping_cpu_quota_period:1;
513
2e59b241
LP
514 /* When writing transient unit files, stores which section we stored last. If < 0, we didn't write any yet. If
515 * == 0 we are in the [Unit] section, if > 0 we are in the unit type-specific section. */
845d247a 516 signed int last_section_private:2;
57b7a260 517} Unit;
87f0e418 518
57b7a260 519typedef struct UnitStatusMessageFormats {
c6918296
MS
520 const char *starting_stopping[2];
521 const char *finished_start_job[_JOB_RESULT_MAX];
522 const char *finished_stop_job[_JOB_RESULT_MAX];
eda0cbf0
ZJS
523 /* If this entry is present, it'll be called to provide a context-dependent format string,
524 * or NULL to fall back to finished_{start,stop}_job; if those are NULL too, fall back to generic. */
525 const char *(*finished_job)(Unit *u, JobType t, JobResult result);
57b7a260 526} UnitStatusMessageFormats;
c6918296 527
2e59b241
LP
528/* Flags used when writing drop-in files or transient unit files */
529typedef enum UnitWriteFlags {
530 /* Write a runtime unit file or drop-in (i.e. one below /run) */
24536beb 531 UNIT_RUNTIME = 1 << 0,
2e59b241
LP
532
533 /* Write a persistent drop-in (i.e. one below /etc) */
24536beb 534 UNIT_PERSISTENT = 1 << 1,
2e59b241
LP
535
536 /* Place this item in the per-unit-type private section, instead of [Unit] */
24536beb 537 UNIT_PRIVATE = 1 << 2,
2e59b241
LP
538
539 /* Apply specifier escaping before writing */
24536beb
ZJS
540 UNIT_ESCAPE_SPECIFIERS = 1 << 3,
541
542 /* Escape elements of ExecStart= syntax before writing */
543 UNIT_ESCAPE_EXEC_SYNTAX = 1 << 4,
2e59b241
LP
544
545 /* Apply C escaping before writing */
24536beb 546 UNIT_ESCAPE_C = 1 << 5,
2e59b241
LP
547} UnitWriteFlags;
548
549/* Returns true if neither persistent, nor runtime storage is requested, i.e. this is a check invocation only */
6529ccfa
LP
550static inline bool UNIT_WRITE_FLAGS_NOOP(UnitWriteFlags flags) {
551 return (flags & (UNIT_RUNTIME|UNIT_PERSISTENT)) == 0;
552}
8e2af478 553
57b7a260
FS
554#include "kill.h"
555
556typedef struct UnitVTable {
7d17cfbc
MS
557 /* How much memory does an object of this unit type need */
558 size_t object_size;
559
3ef63c31
LP
560 /* If greater than 0, the offset into the object where
561 * ExecContext is found, if the unit type has that */
562 size_t exec_context_offset;
563
4ad49000
LP
564 /* If greater than 0, the offset into the object where
565 * CGroupContext is found, if the unit type has that */
566 size_t cgroup_context_offset;
567
718db961
LP
568 /* If greater than 0, the offset into the object where
569 * KillContext is found, if the unit type has that */
570 size_t kill_context_offset;
571
613b411c 572 /* If greater than 0, the offset into the object where the
e76506b7 573 * pointer to ExecSharedRuntime is found, if the unit type has
613b411c
LP
574 * that */
575 size_t exec_runtime_offset;
576
29206d46
LP
577 /* If greater than 0, the offset into the object where the pointer to DynamicCreds is found, if the unit type
578 * has that. */
579 size_t dynamic_creds_offset;
580
ee33e53a 581 /* The name of the configuration file section with the private settings of this unit */
4ad49000 582 const char *private_section;
71645aca 583
f975e971
LP
584 /* Config file sections this unit type understands, separated
585 * by NUL chars */
586 const char *sections;
587
e537352b 588 /* This should reset all type-specific variables. This should
a16e1123
LP
589 * not allocate memory, and is called with zero-initialized
590 * data. It should hence only initialize variables that need
591 * to be set != 0. */
e537352b
LP
592 void (*init)(Unit *u);
593
a16e1123
LP
594 /* This should free all type-specific variables. It should be
595 * idempotent. */
596 void (*done)(Unit *u);
597
e537352b
LP
598 /* Actually load data from disk. This may fail, and should set
599 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
600 * UNIT_STUB if no configuration could be found. */
601 int (*load)(Unit *u);
602
f0831ed2 603 /* During deserialization we only record the intended state to return to. With coldplug() we actually put the
a95c0505
LP
604 * deserialized state in effect. This is where unit_notify() should be called to start things up. Note that
605 * this callback is invoked *before* we leave the reloading state of the manager, i.e. *before* we consider the
606 * reloading to be complete. Thus, this callback should just restore the exact same state for any unit that was
607 * in effect before the reload, i.e. units should not catch up with changes happened during the reload. That's
608 * what catchup() below is for. */
be847e82 609 int (*coldplug)(Unit *u);
87f0e418 610
a95c0505
LP
611 /* This is called shortly after all units' coldplug() call was invoked, and *after* the manager left the
612 * reloading state. It's supposed to catch up with state changes due to external events we missed so far (for
613 * example because they took place while we were reloading/reexecing) */
f0831ed2
LP
614 void (*catchup)(Unit *u);
615
87f0e418
LP
616 void (*dump)(Unit *u, FILE *f, const char *prefix);
617
618 int (*start)(Unit *u);
619 int (*stop)(Unit *u);
620 int (*reload)(Unit *u);
621
a721cd00 622 int (*kill)(Unit *u, KillWho w, int signo, int code, int value, sd_bus_error *error);
8a0867d6 623
380dc8b0
LP
624 /* Clear out the various runtime/state/cache/logs/configuration data */
625 int (*clean)(Unit *u, ExecCleanMask m);
626
d9e45bc3
MS
627 /* Freeze the unit */
628 int (*freeze)(Unit *u);
629 int (*thaw)(Unit *u);
630 bool (*can_freeze)(Unit *u);
631
380dc8b0
LP
632 /* Return which kind of data can be cleaned */
633 int (*can_clean)(Unit *u, ExecCleanMask *ret);
634
87f0e418
LP
635 bool (*can_reload)(Unit *u);
636
1ece068e
ZJS
637 /* Serialize state and file descriptors that should be carried over into the new
638 * instance after reexecution. */
a16e1123
LP
639 int (*serialize)(Unit *u, FILE *f, FDSet *fds);
640
641 /* Restore one item from the serialization */
642 int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
643
01e10de3 644 /* Try to match up fds with what we need for this unit */
9ff1a6f1 645 void (*distribute_fds)(Unit *u, FDSet *fds);
01e10de3 646
87f0e418
LP
647 /* Boils down the more complex internal state of this unit to
648 * a simpler one that the engine can understand */
649 UnitActiveState (*active_state)(Unit *u);
650
10a94420
LP
651 /* Returns the substate specific to this unit type as
652 * string. This is purely information so that we can give the
35b8ca3a 653 * user a more fine grained explanation in which actual state a
10a94420
LP
654 * unit is in. */
655 const char* (*sub_state_to_string)(Unit *u);
656
deb4e708
MK
657 /* Additionally to UnitActiveState determine whether unit is to be restarted. */
658 bool (*will_restart)(Unit *u);
659
f2f725e5
ZJS
660 /* Return false when there is a reason to prevent this unit from being gc'ed
661 * even though nothing references it and it isn't active in any way. */
662 bool (*may_gc)(Unit *u);
701cc384 663
39c79477
ZJS
664 /* Return true when the unit is not controlled by the manager (e.g. extrinsic mounts). */
665 bool (*is_extrinsic)(Unit *u);
666
7eb2a8a1
LP
667 /* When the unit is not running and no job for it queued we shall release its runtime resources */
668 void (*release_resources)(Unit *u);
a354329f 669
718db961 670 /* Invoked on every child that died */
87f0e418 671 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
7824bbeb 672
fdf20a31
MM
673 /* Reset failed state if we are in failed state */
674 void (*reset_failed)(Unit *u);
5632e374 675
afcfaa69 676 /* Called whenever any of the cgroups this unit watches for ran empty */
4ad49000 677 void (*notify_cgroup_empty)(Unit *u);
8e274523 678
afcfaa69 679 /* Called whenever an OOM kill event on this unit was seen */
38c41427 680 void (*notify_cgroup_oom)(Unit *u, bool managed_oom);
afcfaa69 681
8c47c732 682 /* Called whenever a process of this unit sends us a message */
fcee2755 683 void (*notify_message)(Unit *u, const struct ucred *ucred, char * const *tags, FDSet *fds);
8c47c732 684
00d9ef85 685 /* Called whenever a name this Unit registered for comes or goes away. */
fc67a943 686 void (*bus_name_owner_change)(Unit *u, const char *new_owner);
05e343b7 687
8e2af478 688 /* Called for each property that is being set */
2e59b241 689 int (*bus_set_property)(Unit *u, const char *name, sd_bus_message *message, UnitWriteFlags flags, sd_bus_error *error);
8e2af478
LP
690
691 /* Called after at least one property got changed to apply the necessary change */
692 int (*bus_commit_properties)(Unit *u);
693
a7f241db
LP
694 /* Return the unit this unit is following */
695 Unit *(*following)(Unit *u);
696
6210e7fc
LP
697 /* Return the set of units that are following each other */
698 int (*following_set)(Unit *u, Set **s);
699
3ecaa09b
LP
700 /* Invoked each time a unit this unit is triggering changes
701 * state or gains/loses a job */
702 void (*trigger_notify)(Unit *u, Unit *trigger);
703
8742514c
LP
704 /* Called whenever CLOCK_REALTIME made a jump */
705 void (*time_change)(Unit *u);
706
bbf5fd8e
LP
707 /* Called whenever /etc/localtime was modified */
708 void (*timezone_change)(Unit *u);
709
7a7821c8
LP
710 /* Returns the next timeout of a unit */
711 int (*get_timeout)(Unit *u, usec_t *timeout);
68db7a3b 712
291d565a
LP
713 /* Returns the main PID if there is any defined, or 0. */
714 pid_t (*main_pid)(Unit *u);
715
716 /* Returns the main PID if there is any defined, or 0. */
717 pid_t (*control_pid)(Unit *u);
718
bb2c7685
LP
719 /* Returns true if the unit currently needs access to the console */
720 bool (*needs_console)(Unit *u);
721
7af67e9a
LP
722 /* Returns the exit status to propagate in case of FailureAction=exit/SuccessAction=exit; usually returns the
723 * exit code of the "main" process of the service or similar. */
724 int (*exit_status)(Unit *u);
725
5e1669ff
ZJS
726 /* Return a copy of the status string pointer. */
727 const char* (*status_text)(Unit *u);
728
04eb582a
LP
729 /* Like the enumerate() callback further down, but only enumerates the perpetual units, i.e. all units that
730 * unconditionally exist and are always active. The main reason to keep both enumeration functions separate is
731 * philosophical: the state of perpetual units should be put in place by coldplug(), while the state of those
732 * discovered through regular enumeration should be put in place by catchup(), see below. */
733 void (*enumerate_perpetual)(Manager *m);
734
f0831ed2
LP
735 /* This is called for each unit type and should be used to enumerate units already existing in the system
736 * internally and load them. However, everything that is loaded here should still stay in inactive state. It is
04eb582a 737 * the job of the catchup() call above to put the units into the discovered state. */
ba64af90 738 void (*enumerate)(Manager *m);
f50e0a01
LP
739
740 /* Type specific cleanups. */
7824bbeb 741 void (*shutdown)(Manager *m);
9d58f1db 742
cbd4a8df 743 /* If this function is set and returns false all jobs for units
0faacd47 744 * of this type will immediately fail. */
1c2e9646 745 bool (*supported)(void);
0faacd47 746
9727f242
DDM
747 /* If this function is set, it's invoked first as part of starting a unit to allow start rate
748 * limiting checks to occur before we do anything else. */
705578c3 749 int (*can_start)(Unit *u);
9727f242 750
718db961 751 /* The strings to print in status messages */
c6918296
MS
752 UnitStatusMessageFormats status_message_formats;
753
c2756a68 754 /* True if transient units of this type are OK */
cbd4a8df 755 bool can_transient;
c5a97ed1 756
1d9cc876 757 /* True if cgroup delegation is permissible */
cbd4a8df 758 bool can_delegate;
1d9cc876 759
c80a9a33 760 /* True if the unit type triggers other units, i.e. can have a UNIT_TRIGGERS dependency */
cbd4a8df 761 bool can_trigger;
c80a9a33
LP
762
763 /* True if the unit type knows a failure state, and thus can be source of an OnFailure= dependency */
cbd4a8df 764 bool can_fail;
c80a9a33 765
d4fd1cf2 766 /* True if units of this type shall be startable only once and then never again */
cbd4a8df 767 bool once_only;
d4fd1cf2 768
755021d4
ZJS
769 /* Do not serialize this unit when preparing for root switch */
770 bool exclude_from_switch_root_serialization;
771
c5a97ed1 772 /* True if queued jobs of this type should be GC'ed if no other job needs them anymore */
cbd4a8df 773 bool gc_jobs;
4d824a4e 774
0923b425 775 /* True if systemd-oomd can monitor and act on this unit's recursive children's cgroups */
cbd4a8df 776 bool can_set_managed_oom;
57b7a260 777} UnitVTable;
87f0e418
LP
778
779extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
780
c2503e35 781static inline const UnitVTable* UNIT_VTABLE(const Unit *u) {
6529ccfa
LP
782 return unit_vtable[u->type];
783}
87f0e418
LP
784
785/* For casting a unit into the various unit types */
786#define DEFINE_CAST(UPPERCASE, MixedCase) \
787 static inline MixedCase* UPPERCASE(Unit *u) { \
ac155bb8 788 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
87f0e418
LP
789 return NULL; \
790 \
791 return (MixedCase*) u; \
792 }
793
794/* For casting the various unit types into a unit */
bbf11206
LP
795#define UNIT(u) \
796 ({ \
797 typeof(u) _u_ = (u); \
798 Unit *_w_ = _u_ ? &(_u_)->meta : NULL; \
799 _w_; \
800 })
87f0e418 801
35b7ff80
LP
802#define UNIT_HAS_EXEC_CONTEXT(u) (UNIT_VTABLE(u)->exec_context_offset > 0)
803#define UNIT_HAS_CGROUP_CONTEXT(u) (UNIT_VTABLE(u)->cgroup_context_offset > 0)
804#define UNIT_HAS_KILL_CONTEXT(u) (UNIT_VTABLE(u)->kill_context_offset > 0)
805
15ed3c3a
LP
806Unit* unit_has_dependency(const Unit *u, UnitDependencyAtom atom, Unit *other);
807int unit_get_dependency_array(const Unit *u, UnitDependencyAtom atom, Unit ***ret_array);
808
809static inline Hashmap* unit_get_dependencies(Unit *u, UnitDependency d) {
810 return hashmap_get(u->dependencies, UNIT_DEPENDENCY_TO_PTR(d));
811}
812
6529ccfa 813static inline Unit* UNIT_TRIGGER(Unit *u) {
15ed3c3a 814 return unit_has_dependency(u, UNIT_ATOM_TRIGGERS, NULL);
6529ccfa 815}
3ecaa09b 816
12f64221 817static inline Unit* UNIT_GET_SLICE(const Unit *u) {
d219a2b0 818 return unit_has_dependency(u, UNIT_ATOM_IN_SLICE, NULL);
12f64221
LP
819}
820
75db809a
ZJS
821Unit* unit_new(Manager *m, size_t size);
822Unit* unit_free(Unit *u);
dc409696 823DEFINE_TRIVIAL_CLEANUP_FUNC(Unit *, unit_free);
87f0e418 824
a581e45a 825int unit_new_for_name(Manager *m, size_t size, const char *name, Unit **ret);
87f0e418 826int unit_add_name(Unit *u, const char *name);
9e2f7c11 827
eef85c4a
LP
828int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference, UnitDependencyMask mask);
829int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference, UnitDependencyMask mask);
2c966c03 830
35d8c19a 831int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, bool add_reference, UnitDependencyMask mask);
5a724170 832int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, bool add_reference, UnitDependencyMask mask);
2c966c03 833
23a177ef
LP
834int unit_add_exec_dependencies(Unit *u, ExecContext *c);
835
0ae97ec1 836int unit_choose_id(Unit *u, const char *name);
f50e0a01 837int unit_set_description(Unit *u, const char *description);
87f0e418 838
f2f725e5 839bool unit_may_gc(Unit *u);
701cc384 840
39c79477
ZJS
841static inline bool unit_is_extrinsic(Unit *u) {
842 return u->perpetual ||
843 (UNIT_VTABLE(u)->is_extrinsic && UNIT_VTABLE(u)->is_extrinsic(u));
844}
845
5e1669ff
ZJS
846static inline const char* unit_status_text(Unit *u) {
847 if (u && UNIT_VTABLE(u)->status_text)
848 return UNIT_VTABLE(u)->status_text(u);
849 return NULL;
850}
851
87f0e418 852void unit_add_to_load_queue(Unit *u);
c1e1601e 853void unit_add_to_dbus_queue(Unit *u);
23a177ef 854void unit_add_to_cleanup_queue(Unit *u);
701cc384 855void unit_add_to_gc_queue(Unit *u);
19496554 856void unit_add_to_target_deps_queue(Unit *u);
fda09318 857void unit_submit_to_stop_when_unneeded_queue(Unit *u);
0bc488c9 858void unit_submit_to_start_when_upheld_queue(Unit *u);
56c59592 859void unit_submit_to_stop_when_bound_queue(Unit *u);
87f0e418
LP
860
861int unit_merge(Unit *u, Unit *other);
23a177ef
LP
862int unit_merge_by_name(Unit *u, const char *other);
863
44a6b1b6 864Unit *unit_follow_merge(Unit *u) _pure_;
87f0e418 865
c3620770 866int unit_load_fragment_and_dropin(Unit *u, bool fragment_required);
87f0e418
LP
867int unit_load(Unit *unit);
868
899acf5c 869int unit_set_slice(Unit *u, Unit *slice);
d79200e2 870int unit_set_default_slice(Unit *u);
a016b922 871
44a6b1b6 872const char *unit_description(Unit *u) _pure_;
04d232d8 873const char *unit_status_string(Unit *u, char **combined);
87f0e418 874
303ee601 875bool unit_has_name(const Unit *u, const char *name);
f278026d 876
87f0e418 877UnitActiveState unit_active_state(Unit *u);
d9e45bc3
MS
878FreezerState unit_freezer_state(Unit *u);
879int unit_freezer_state_kernel(Unit *u, FreezerState *ret);
87f0e418 880
10a94420
LP
881const char* unit_sub_state_to_string(Unit *u);
882
44a6b1b6
ZJS
883bool unit_can_reload(Unit *u) _pure_;
884bool unit_can_start(Unit *u) _pure_;
f5869324 885bool unit_can_stop(Unit *u) _pure_;
44a6b1b6 886bool unit_can_isolate(Unit *u) _pure_;
87f0e418 887
48b92b37 888int unit_start(Unit *u, ActivationDetails *details);
87f0e418
LP
889int unit_stop(Unit *u);
890int unit_reload(Unit *u);
891
a721cd00
LP
892int unit_kill(Unit *u, KillWho w, int signo, int code, int value, sd_bus_error *error);
893int unit_kill_common(Unit *u, KillWho who, int signo, int code, int value, pid_t main_pid, pid_t control_pid, sd_bus_error *error);
8a0867d6 894
38c41427
NK
895void unit_notify_cgroup_oom(Unit *u, bool managed_oom);
896
2ad2e41a 897typedef enum UnitNotifyFlags {
ef31828d
LP
898 UNIT_NOTIFY_RELOAD_FAILURE = 1 << 0,
899 UNIT_NOTIFY_WILL_AUTO_RESTART = 1 << 1,
2ad2e41a
LP
900} UnitNotifyFlags;
901
902void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, UnitNotifyFlags flags);
87f0e418 903
f75f613d 904int unit_watch_pid(Unit *u, pid_t pid, bool exclusive);
87f0e418 905void unit_unwatch_pid(Unit *u, pid_t pid);
a911bb9a
LP
906void unit_unwatch_all_pids(Unit *u);
907
50be4f4a
LP
908int unit_enqueue_rewatch_pids(Unit *u);
909void unit_dequeue_rewatch_pids(Unit *u);
87f0e418 910
9806e87d 911int unit_install_bus_match(Unit *u, sd_bus *bus, const char *name);
05e343b7
LP
912int unit_watch_bus_name(Unit *u, const char *name);
913void unit_unwatch_bus_name(Unit *u, const char *name);
914
87f0e418
LP
915bool unit_job_is_applicable(Unit *u, JobType j);
916
0301abf4
LP
917int set_unit_path(const char *p);
918
50159e6a 919char *unit_dbus_path(Unit *u);
4b58153d 920char *unit_dbus_path_invocation_id(Unit *u);
50159e6a 921
f6ff8c29
LP
922int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
923
d336ba9f 924int unit_add_node_dependency(Unit *u, const char *what, UnitDependency d, UnitDependencyMask mask);
44b0d1fd 925int unit_add_blockdev_dependency(Unit *u, const char *what, UnitDependencyMask mask);
6e2ef85b 926
be847e82 927int unit_coldplug(Unit *u);
f0831ed2 928void unit_catchup(Unit *u);
cca098b0 929
04d232d8 930void unit_status_printf(Unit *u, StatusType status_type, const char *status, const char *format, const char *ident) _printf_(4, 0);
9e58ff9c 931
45fb0699
LP
932bool unit_need_daemon_reload(Unit *u);
933
fdf20a31 934void unit_reset_failed(Unit *u);
5632e374 935
a7f241db 936Unit *unit_following(Unit *u);
eeaedb7c 937int unit_following_set(Unit *u, Set **s);
a7f241db 938
9444b1f2
LP
939const char *unit_slice_name(Unit *u);
940
44a6b1b6
ZJS
941bool unit_stop_pending(Unit *u) _pure_;
942bool unit_inactive_or_pending(Unit *u) _pure_;
31afa0a4 943bool unit_active_or_pending(Unit *u);
52a12341 944bool unit_will_restart_default(Unit *u);
deb4e708 945bool unit_will_restart(Unit *u);
18ffdfda 946
bba34eed
LP
947int unit_add_default_target_dependency(Unit *u, Unit *target);
948
294446dc 949void unit_start_on_failure(Unit *u, const char *dependency_name, UnitDependencyAtom atom, JobMode job_mode);
3ecaa09b 950void unit_trigger_notify(Unit *u);
c0daa706 951
a4375746 952UnitFileState unit_get_unit_file_state(Unit *u);
d2dc52db 953int unit_get_unit_file_preset(Unit *u);
a4375746 954
7f7d01ed 955Unit* unit_ref_set(UnitRef *ref, Unit *source, Unit *target);
57020a3a
LP
956void unit_ref_unset(UnitRef *ref);
957
7f7d01ed
ZJS
958#define UNIT_DEREF(ref) ((ref).target)
959#define UNIT_ISSET(ref) (!!(ref).target)
57020a3a 960
598459ce 961int unit_patch_contexts(Unit *u);
e06c73cc 962
c2503e35 963ExecContext *unit_get_exec_context(const Unit *u) _pure_;
718db961 964KillContext *unit_get_kill_context(Unit *u) _pure_;
4ad49000 965CGroupContext *unit_get_cgroup_context(Unit *u) _pure_;
598459ce 966
e76506b7 967ExecSharedRuntime *unit_get_exec_runtime(Unit *u) _pure_;
613b411c
LP
968
969int unit_setup_exec_runtime(Unit *u);
29206d46 970int unit_setup_dynamic_creds(Unit *u);
3ef63c31 971
2e59b241
LP
972char* unit_escape_setting(const char *s, UnitWriteFlags flags, char **buf);
973char* unit_concat_strv(char **l, UnitWriteFlags flags);
b9ec9359 974
2e59b241
LP
975int unit_write_setting(Unit *u, UnitWriteFlags flags, const char *name, const char *data);
976int unit_write_settingf(Unit *u, UnitWriteFlags mode, const char *name, const char *format, ...) _printf_(4,5);
b9ec9359 977
db2cb23b 978int unit_kill_context(Unit *u, KillContext *c, KillOperation k, pid_t main_pid, pid_t control_pid, bool main_pid_alien);
cd2086fe 979
c2756a68
LP
980int unit_make_transient(Unit *u);
981
eef85c4a 982int unit_require_mounts_for(Unit *u, const char *path, UnitDependencyMask mask);
a57f7e2c 983
1c2e9646
LP
984bool unit_type_supported(UnitType t);
985
0f13f3bd
LP
986bool unit_is_pristine(Unit *u);
987
a3c1168a 988bool unit_is_unneeded(Unit *u);
0bc488c9 989bool unit_is_upheld_by_active(Unit *u, Unit **ret_culprit);
56c59592 990bool unit_is_bound_by_inactive(Unit *u, Unit **ret_culprit);
a3c1168a 991
291d565a
LP
992pid_t unit_control_pid(Unit *u);
993pid_t unit_main_pid(Unit *u);
994
8b4305c7 995void unit_warn_if_dir_nonempty(Unit *u, const char* where);
25cd4964 996int unit_fail_if_noncanonical(Unit *u, const char* where);
8b4305c7 997
97a3f4ee 998int unit_test_start_limit(Unit *u);
07299350 999
00d9ef85
LP
1000int unit_ref_uid_gid(Unit *u, uid_t uid, gid_t gid);
1001void unit_unref_uid_gid(Unit *u, bool destroy_now);
1002
1003void unit_notify_user_lookup(Unit *u, uid_t uid, gid_t gid);
1004
2d3b784d 1005int unit_set_invocation_id(Unit *u, sd_id128_t id);
4b58153d
LP
1006int unit_acquire_invocation_id(Unit *u);
1007
c891efaf
FB
1008bool unit_shall_confirm_spawn(Unit *u);
1009
1ad6e8b3 1010int unit_set_exec_params(Unit *s, ExecParameters *p);
f0d47797 1011
4c253ed1 1012int unit_fork_helper_process(Unit *u, const char *name, pid_t *ret);
810ef318 1013int unit_fork_and_watch_rm_rf(Unit *u, char **paths, pid_t *ret_pid);
a79279c7 1014
c999cf38
LP
1015void unit_remove_dependencies(Unit *u, UnitDependencyMask mask);
1016
d3070fbd
LP
1017void unit_export_state_files(Unit *u);
1018void unit_unlink_state_files(Unit *u);
1019
3c7416b6
LP
1020int unit_prepare_exec(Unit *u);
1021
4c425434
LP
1022int unit_log_leftover_process_start(pid_t pid, int sig, void *userdata);
1023int unit_log_leftover_process_stop(pid_t pid, int sig, void *userdata);
1024int unit_warn_leftover_processes(Unit *u, cg_kill_log_func_t log_func);
a4634b21 1025
bb2c7685
LP
1026bool unit_needs_console(Unit *u);
1027
6592b975
LP
1028int unit_pid_attachable(Unit *unit, pid_t pid, sd_bus_error *error);
1029
28a2dfe8
ZJS
1030static inline bool unit_has_job_type(Unit *u, JobType type) {
1031 return u && u->job && u->job->type == type;
1032}
1033
c2503e35
RH
1034static inline bool unit_log_level_test(const Unit *u, int level) {
1035 ExecContext *ec = unit_get_exec_context(u);
1036 return !ec || ec->log_level_max < 0 || ec->log_level_max >= LOG_PRI(level);
1037}
1038
31cd5f63
AZ
1039/* unit_log_skip is for cases like ExecCondition= where a unit is considered "done"
1040 * after some execution, rather than succeeded or failed. */
1041void unit_log_skip(Unit *u, const char *result);
523ee2d4 1042void unit_log_success(Unit *u);
7c047d74 1043void unit_log_failure(Unit *u, const char *result);
aac99f30
ZJS
1044static inline void unit_log_result(Unit *u, bool success, const char *result) {
1045 if (success)
1046 unit_log_success(u);
1047 else
1048 unit_log_failure(u, result);
1049}
1050
5cc2cd1c 1051void unit_log_process_exit(Unit *u, const char *kind, const char *command, bool success, int code, int status);
7c047d74 1052
7af67e9a
LP
1053int unit_exit_status(Unit *u);
1054int unit_success_action_exit_status(Unit *u);
1055int unit_failure_action_exit_status(Unit *u);
1056
a4191c9f
LP
1057int unit_test_trigger_loaded(Unit *u);
1058
bb0c0d6f 1059void unit_destroy_runtime_data(Unit *u, const ExecContext *context);
380dc8b0
LP
1060int unit_clean(Unit *u, ExecCleanMask mask);
1061int unit_can_clean(Unit *u, ExecCleanMask *ret_mask);
1062
d9e45bc3
MS
1063bool unit_can_freeze(Unit *u);
1064int unit_freeze(Unit *u);
1065void unit_frozen(Unit *u);
1066
1067int unit_thaw(Unit *u);
1068void unit_thawed(Unit *u);
1069
1070int unit_freeze_vtable_common(Unit *u);
1071int unit_thaw_vtable_common(Unit *u);
1072
6e548561
DDM
1073Condition *unit_find_failed_condition(Unit *u);
1074
e8e581bf
ZJS
1075/* Macros which append UNIT= or USER_UNIT= to the message */
1076
ac513634 1077#define log_unit_full_errno_zerook(unit, level, error, ...) \
f2341e0a 1078 ({ \
8dec4a9d 1079 const Unit *_u = (unit); \
c2503e35 1080 const int _l = (level); \
1092e82b
LB
1081 bool _do_log = !(log_get_max_level() < LOG_PRI(_l) || \
1082 (_u && !unit_log_level_test(_u, _l))); \
1083 const ExecContext *_c = _do_log && _u ? \
1084 unit_get_exec_context(_u) : NULL; \
1085 LOG_CONTEXT_PUSH_IOV(_c ? _c->log_extra_fields : NULL, \
1086 _c ? _c->n_log_extra_fields : 0); \
1087 !_do_log ? -ERRNO_VALUE(error) : \
c2503e35
RH
1088 _u ? log_object_internal(_l, error, PROJECT_FILE, __LINE__, __func__, _u->manager->unit_log_field, _u->id, _u->manager->invocation_log_field, _u->invocation_id_string, ##__VA_ARGS__) : \
1089 log_internal(_l, error, PROJECT_FILE, __LINE__, __func__, ##__VA_ARGS__); \
f2341e0a
LP
1090 })
1091
ac513634
YW
1092#define log_unit_full_errno(unit, level, error, ...) \
1093 ({ \
1094 int _error = (error); \
1095 ASSERT_NON_ZERO(_error); \
1096 log_unit_full_errno_zerook(unit, level, _error, ##__VA_ARGS__); \
1097 })
1098
1099#define log_unit_full(unit, level, ...) (void) log_unit_full_errno_zerook(unit, level, 0, __VA_ARGS__)
8ed6f81b 1100
ac513634 1101#define log_unit_debug(unit, ...) log_unit_full(unit, LOG_DEBUG, __VA_ARGS__)
8ed6f81b
YW
1102#define log_unit_info(unit, ...) log_unit_full(unit, LOG_INFO, __VA_ARGS__)
1103#define log_unit_notice(unit, ...) log_unit_full(unit, LOG_NOTICE, __VA_ARGS__)
1104#define log_unit_warning(unit, ...) log_unit_full(unit, LOG_WARNING, __VA_ARGS__)
1105#define log_unit_error(unit, ...) log_unit_full(unit, LOG_ERR, __VA_ARGS__)
1106
1107#define log_unit_debug_errno(unit, error, ...) log_unit_full_errno(unit, LOG_DEBUG, error, __VA_ARGS__)
1108#define log_unit_info_errno(unit, error, ...) log_unit_full_errno(unit, LOG_INFO, error, __VA_ARGS__)
1109#define log_unit_notice_errno(unit, error, ...) log_unit_full_errno(unit, LOG_NOTICE, error, __VA_ARGS__)
1110#define log_unit_warning_errno(unit, error, ...) log_unit_full_errno(unit, LOG_WARNING, error, __VA_ARGS__)
1111#define log_unit_error_errno(unit, error, ...) log_unit_full_errno(unit, LOG_ERR, error, __VA_ARGS__)
f2341e0a 1112
556b6f4e
DDM
1113#if LOG_TRACE
1114# define log_unit_trace(...) log_unit_debug(__VA_ARGS__)
1115# define log_unit_trace_errno(...) log_unit_debug_errno(__VA_ARGS__)
1116#else
1117# define log_unit_trace(...) do {} while (0)
1118# define log_unit_trace_errno(e, ...) (-ERRNO_VALUE(e))
1119#endif
1120
c2503e35
RH
1121#define log_unit_struct_errno(unit, level, error, ...) \
1122 ({ \
1123 const Unit *_u = (unit); \
1124 const int _l = (level); \
1092e82b
LB
1125 bool _do_log = unit_log_level_test(_u, _l); \
1126 const ExecContext *_c = _do_log && _u ? \
1127 unit_get_exec_context(_u) : NULL; \
1128 LOG_CONTEXT_PUSH_IOV(_c ? _c->log_extra_fields : NULL, \
1129 _c ? _c->n_log_extra_fields : 0); \
1130 _do_log ? \
c2503e35
RH
1131 log_struct_errno(_l, error, __VA_ARGS__, LOG_UNIT_ID(_u)) : \
1132 -ERRNO_VALUE(error); \
1133 })
1134
1135#define log_unit_struct(unit, level, ...) log_unit_struct_errno(unit, level, 0, __VA_ARGS__)
1136
1137#define log_unit_struct_iovec_errno(unit, level, error, iovec, n_iovec) \
1138 ({ \
1092e82b 1139 const Unit *_u = (unit); \
c2503e35 1140 const int _l = (level); \
1092e82b
LB
1141 bool _do_log = unit_log_level_test(_u, _l); \
1142 const ExecContext *_c = _do_log && _u ? \
1143 unit_get_exec_context(_u) : NULL; \
1144 LOG_CONTEXT_PUSH_IOV(_c ? _c->log_extra_fields : NULL, \
1145 _c ? _c->n_log_extra_fields : 0); \
1146 _do_log ? \
c2503e35
RH
1147 log_struct_iovec_errno(_l, error, iovec, n_iovec) : \
1148 -ERRNO_VALUE(error); \
1149 })
1150
1151#define log_unit_struct_iovec(unit, level, iovec, n_iovec) log_unit_struct_iovec_errno(unit, level, 0, iovec, n_iovec)
1152
b9ce5cf9
ZJS
1153/* Like LOG_MESSAGE(), but with the unit name prefixed. */
1154#define LOG_UNIT_MESSAGE(unit, fmt, ...) LOG_MESSAGE("%s: " fmt, (unit)->id, ##__VA_ARGS__)
f2341e0a 1155#define LOG_UNIT_ID(unit) (unit)->manager->unit_log_format_string, (unit)->id
f1c50bec 1156#define LOG_UNIT_INVOCATION_ID(unit) (unit)->manager->invocation_log_format_string, (unit)->invocation_id_string
5afe510c
LP
1157
1158const char* collect_mode_to_string(CollectMode m) _const_;
1159CollectMode collect_mode_from_string(const char *s) _pure_;
15ed3c3a
LP
1160
1161typedef struct UnitForEachDependencyData {
1162 /* Stores state for the FOREACH macro below for iterating through all deps that have any of the
1163 * specified dependency atom bits set */
1164 UnitDependencyAtom match_atom;
1165 Hashmap *by_type, *by_unit;
1166 void *current_type;
1167 Iterator by_type_iterator, by_unit_iterator;
1168 Unit **current_unit;
1169} UnitForEachDependencyData;
1170
1171/* Iterates through all dependencies that have a specific atom in the dependency type set. This tries to be
1172 * smart: if the atom is unique, we'll directly go to right entry. Otherwise we'll iterate through the
1173 * per-dependency type hashmap and match all dep that have the right atom set. */
1174#define _UNIT_FOREACH_DEPENDENCY(other, u, ma, data) \
1175 for (UnitForEachDependencyData data = { \
1176 .match_atom = (ma), \
1177 .by_type = (u)->dependencies, \
1178 .by_type_iterator = ITERATOR_FIRST, \
1179 .current_unit = &(other), \
1180 }; \
1181 ({ \
1182 UnitDependency _dt = _UNIT_DEPENDENCY_INVALID; \
1183 bool _found; \
1184 \
1185 if (data.by_type && ITERATOR_IS_FIRST(data.by_type_iterator)) { \
1186 _dt = unit_dependency_from_unique_atom(data.match_atom); \
1187 if (_dt >= 0) { \
1188 data.by_unit = hashmap_get(data.by_type, UNIT_DEPENDENCY_TO_PTR(_dt)); \
1189 data.current_type = UNIT_DEPENDENCY_TO_PTR(_dt); \
1190 data.by_type = NULL; \
1191 _found = !!data.by_unit; \
1192 } \
1193 } \
1194 if (_dt < 0) \
1195 _found = hashmap_iterate(data.by_type, \
1196 &data.by_type_iterator, \
1197 (void**)&(data.by_unit), \
1198 (const void**) &(data.current_type)); \
1199 _found; \
1200 }); ) \
1201 if ((unit_dependency_to_atom(UNIT_DEPENDENCY_FROM_PTR(data.current_type)) & data.match_atom) != 0) \
1202 for (data.by_unit_iterator = ITERATOR_FIRST; \
1203 hashmap_iterate(data.by_unit, \
1204 &data.by_unit_iterator, \
1205 NULL, \
1206 (const void**) data.current_unit); )
1207
1208/* Note: this matches deps that have *any* of the atoms specified in match_atom set */
1209#define UNIT_FOREACH_DEPENDENCY(other, u, match_atom) \
1210 _UNIT_FOREACH_DEPENDENCY(other, u, match_atom, UNIQ_T(data, UNIQ))
4b2af439
DDM
1211
1212#define _LOG_CONTEXT_PUSH_UNIT(unit, u, c) \
1213 const Unit *u = (unit); \
1214 const ExecContext *c = unit_get_exec_context(u); \
1215 LOG_CONTEXT_PUSH_KEY_VALUE(u->manager->unit_log_field, u->id); \
1216 LOG_CONTEXT_PUSH_KEY_VALUE(u->manager->invocation_log_field, u->invocation_id_string); \
1217 LOG_CONTEXT_PUSH_IOV(c ? c->log_extra_fields : NULL, c ? c->n_log_extra_fields : 0)
1218
1219#define LOG_CONTEXT_PUSH_UNIT(unit) \
1220 _LOG_CONTEXT_PUSH_UNIT(unit, UNIQ_T(u, UNIQ), UNIQ_T(c, UNIQ))