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