]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/core/unit.h
core: add IgnoreOnSoftReboot= unit option
[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
b80fc61e
LB
453 /* Configure so that the unit survives a soft reboot without stopping/starting. */
454 bool ignore_on_soft_reboot;
455
b5e9dba8
LP
456 /* Refuse manual starting, allow starting only indirectly via dependency. */
457 bool refuse_manual_start;
458
459 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
460 bool refuse_manual_stop;
461
2528a7a6
LP
462 /* Allow isolation requests */
463 bool allow_isolate;
464
c8f4d764
LP
465 /* Ignore this unit when isolating */
466 bool ignore_on_isolate;
467
49f43d5f 468 /* Did the last condition check succeed? */
90bbc946 469 bool condition_result;
59fccdc5 470 bool assert_result;
90bbc946 471
c2756a68
LP
472 /* Is this a transient unit? */
473 bool transient;
474
f5869324
LP
475 /* Is this a unit that is always running and cannot be stopped? */
476 bool perpetual;
477
66fa4bdd 478 /* Booleans indicating membership of this unit in the various queues */
9d58f1db
LP
479 bool in_load_queue:1;
480 bool in_dbus_queue:1;
481 bool in_cleanup_queue:1;
701cc384 482 bool in_gc_queue:1;
91a6073e 483 bool in_cgroup_realize_queue:1;
09e24654 484 bool in_cgroup_empty_queue:1;
afcfaa69 485 bool in_cgroup_oom_queue:1;
19496554 486 bool in_target_deps_queue:1;
a3c1168a 487 bool in_stop_when_unneeded_queue:1;
0bc488c9 488 bool in_start_when_upheld_queue:1;
56c59592 489 bool in_stop_when_bound_queue:1;
6ac62d61 490 bool in_release_resources_queue:1;
701cc384 491
9d58f1db 492 bool sent_dbus_new_signal:1;
6c073082 493
8c2524c7
ZJS
494 bool job_running_timeout_set:1;
495
cd6d0a45 496 bool in_audit:1;
adefcf28 497 bool on_console:1;
a57f7e2c
LP
498
499 bool cgroup_realized:1;
bc432dc7 500 bool cgroup_members_mask_valid:1;
f78f265f 501
3c7416b6
LP
502 /* Reset cgroup accounting next time we fork something off */
503 bool reset_accounting:1;
504
6bf0f408
LP
505 bool start_limit_hit:1;
506
f78f265f 507 /* Did we already invoke unit_coldplug() for this unit? */
f8a30ce5 508 bool coldplugged:1;
05a98afd
LP
509
510 /* For transient units: whether to add a bus track reference after creating the unit */
511 bool bus_track_add:1;
d3070fbd
LP
512
513 /* Remember which unit state files we created */
514 bool exported_invocation_id:1;
515 bool exported_log_level_max:1;
516 bool exported_log_extra_fields:1;
5ac1530e
ZJS
517 bool exported_log_ratelimit_interval:1;
518 bool exported_log_ratelimit_burst:1;
2e59b241 519
527ede0c
FB
520 /* Whether we warned about clamping the CPU quota period */
521 bool warned_clamping_cpu_quota_period:1;
522
2e59b241
LP
523 /* When writing transient unit files, stores which section we stored last. If < 0, we didn't write any yet. If
524 * == 0 we are in the [Unit] section, if > 0 we are in the unit type-specific section. */
845d247a 525 signed int last_section_private:2;
57b7a260 526} Unit;
87f0e418 527
57b7a260 528typedef struct UnitStatusMessageFormats {
c6918296
MS
529 const char *starting_stopping[2];
530 const char *finished_start_job[_JOB_RESULT_MAX];
531 const char *finished_stop_job[_JOB_RESULT_MAX];
eda0cbf0
ZJS
532 /* If this entry is present, it'll be called to provide a context-dependent format string,
533 * or NULL to fall back to finished_{start,stop}_job; if those are NULL too, fall back to generic. */
534 const char *(*finished_job)(Unit *u, JobType t, JobResult result);
57b7a260 535} UnitStatusMessageFormats;
c6918296 536
2e59b241
LP
537/* Flags used when writing drop-in files or transient unit files */
538typedef enum UnitWriteFlags {
539 /* Write a runtime unit file or drop-in (i.e. one below /run) */
f3af6290 540 UNIT_RUNTIME = 1 << 0,
2e59b241
LP
541
542 /* Write a persistent drop-in (i.e. one below /etc) */
f3af6290 543 UNIT_PERSISTENT = 1 << 1,
2e59b241
LP
544
545 /* Place this item in the per-unit-type private section, instead of [Unit] */
f3af6290 546 UNIT_PRIVATE = 1 << 2,
2e59b241 547
f3af6290
ZJS
548 /* Apply specifier escaping */
549 UNIT_ESCAPE_SPECIFIERS = 1 << 3,
24536beb 550
f3af6290
ZJS
551 /* Escape elements of ExecStart= syntax, incl. prevention of variable expansion */
552 UNIT_ESCAPE_EXEC_SYNTAX_ENV = 1 << 4,
2e59b241 553
8c41640a
ZJS
554 /* Escape elements of ExecStart=: syntax (no variable expansion) */
555 UNIT_ESCAPE_EXEC_SYNTAX = 1 << 5,
2e59b241
LP
556
557 /* Apply C escaping before writing */
8c41640a 558 UNIT_ESCAPE_C = 1 << 6,
2e59b241
LP
559} UnitWriteFlags;
560
561/* Returns true if neither persistent, nor runtime storage is requested, i.e. this is a check invocation only */
6529ccfa
LP
562static inline bool UNIT_WRITE_FLAGS_NOOP(UnitWriteFlags flags) {
563 return (flags & (UNIT_RUNTIME|UNIT_PERSISTENT)) == 0;
564}
8e2af478 565
57b7a260
FS
566#include "kill.h"
567
568typedef struct UnitVTable {
7d17cfbc
MS
569 /* How much memory does an object of this unit type need */
570 size_t object_size;
571
3ef63c31
LP
572 /* If greater than 0, the offset into the object where
573 * ExecContext is found, if the unit type has that */
574 size_t exec_context_offset;
575
4ad49000
LP
576 /* If greater than 0, the offset into the object where
577 * CGroupContext is found, if the unit type has that */
578 size_t cgroup_context_offset;
579
718db961
LP
580 /* If greater than 0, the offset into the object where
581 * KillContext is found, if the unit type has that */
582 size_t kill_context_offset;
583
613b411c 584 /* If greater than 0, the offset into the object where the
e76506b7 585 * pointer to ExecSharedRuntime is found, if the unit type has
613b411c
LP
586 * that */
587 size_t exec_runtime_offset;
588
ee33e53a 589 /* The name of the configuration file section with the private settings of this unit */
4ad49000 590 const char *private_section;
71645aca 591
f975e971
LP
592 /* Config file sections this unit type understands, separated
593 * by NUL chars */
594 const char *sections;
595
e537352b 596 /* This should reset all type-specific variables. This should
a16e1123
LP
597 * not allocate memory, and is called with zero-initialized
598 * data. It should hence only initialize variables that need
599 * to be set != 0. */
e537352b
LP
600 void (*init)(Unit *u);
601
a16e1123
LP
602 /* This should free all type-specific variables. It should be
603 * idempotent. */
604 void (*done)(Unit *u);
605
e537352b
LP
606 /* Actually load data from disk. This may fail, and should set
607 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
608 * UNIT_STUB if no configuration could be found. */
609 int (*load)(Unit *u);
610
f0831ed2 611 /* During deserialization we only record the intended state to return to. With coldplug() we actually put the
a95c0505
LP
612 * deserialized state in effect. This is where unit_notify() should be called to start things up. Note that
613 * this callback is invoked *before* we leave the reloading state of the manager, i.e. *before* we consider the
614 * reloading to be complete. Thus, this callback should just restore the exact same state for any unit that was
615 * in effect before the reload, i.e. units should not catch up with changes happened during the reload. That's
616 * what catchup() below is for. */
be847e82 617 int (*coldplug)(Unit *u);
87f0e418 618
a95c0505
LP
619 /* This is called shortly after all units' coldplug() call was invoked, and *after* the manager left the
620 * reloading state. It's supposed to catch up with state changes due to external events we missed so far (for
621 * example because they took place while we were reloading/reexecing) */
f0831ed2
LP
622 void (*catchup)(Unit *u);
623
87f0e418
LP
624 void (*dump)(Unit *u, FILE *f, const char *prefix);
625
626 int (*start)(Unit *u);
627 int (*stop)(Unit *u);
628 int (*reload)(Unit *u);
629
a721cd00 630 int (*kill)(Unit *u, KillWho w, int signo, int code, int value, sd_bus_error *error);
8a0867d6 631
380dc8b0
LP
632 /* Clear out the various runtime/state/cache/logs/configuration data */
633 int (*clean)(Unit *u, ExecCleanMask m);
634
d9e45bc3
MS
635 /* Freeze the unit */
636 int (*freeze)(Unit *u);
637 int (*thaw)(Unit *u);
638 bool (*can_freeze)(Unit *u);
639
380dc8b0
LP
640 /* Return which kind of data can be cleaned */
641 int (*can_clean)(Unit *u, ExecCleanMask *ret);
642
87f0e418
LP
643 bool (*can_reload)(Unit *u);
644
1ece068e
ZJS
645 /* Serialize state and file descriptors that should be carried over into the new
646 * instance after reexecution. */
a16e1123
LP
647 int (*serialize)(Unit *u, FILE *f, FDSet *fds);
648
649 /* Restore one item from the serialization */
650 int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
651
01e10de3 652 /* Try to match up fds with what we need for this unit */
9ff1a6f1 653 void (*distribute_fds)(Unit *u, FDSet *fds);
01e10de3 654
87f0e418
LP
655 /* Boils down the more complex internal state of this unit to
656 * a simpler one that the engine can understand */
657 UnitActiveState (*active_state)(Unit *u);
658
10a94420
LP
659 /* Returns the substate specific to this unit type as
660 * string. This is purely information so that we can give the
35b8ca3a 661 * user a more fine grained explanation in which actual state a
10a94420
LP
662 * unit is in. */
663 const char* (*sub_state_to_string)(Unit *u);
664
deb4e708
MK
665 /* Additionally to UnitActiveState determine whether unit is to be restarted. */
666 bool (*will_restart)(Unit *u);
667
f2f725e5
ZJS
668 /* Return false when there is a reason to prevent this unit from being gc'ed
669 * even though nothing references it and it isn't active in any way. */
670 bool (*may_gc)(Unit *u);
701cc384 671
39c79477
ZJS
672 /* Return true when the unit is not controlled by the manager (e.g. extrinsic mounts). */
673 bool (*is_extrinsic)(Unit *u);
674
7eb2a8a1
LP
675 /* When the unit is not running and no job for it queued we shall release its runtime resources */
676 void (*release_resources)(Unit *u);
a354329f 677
718db961 678 /* Invoked on every child that died */
87f0e418 679 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
7824bbeb 680
fdf20a31
MM
681 /* Reset failed state if we are in failed state */
682 void (*reset_failed)(Unit *u);
5632e374 683
afcfaa69 684 /* Called whenever any of the cgroups this unit watches for ran empty */
4ad49000 685 void (*notify_cgroup_empty)(Unit *u);
8e274523 686
afcfaa69 687 /* Called whenever an OOM kill event on this unit was seen */
38c41427 688 void (*notify_cgroup_oom)(Unit *u, bool managed_oom);
afcfaa69 689
8c47c732 690 /* Called whenever a process of this unit sends us a message */
fcee2755 691 void (*notify_message)(Unit *u, const struct ucred *ucred, char * const *tags, FDSet *fds);
8c47c732 692
00d9ef85 693 /* Called whenever a name this Unit registered for comes or goes away. */
fc67a943 694 void (*bus_name_owner_change)(Unit *u, const char *new_owner);
05e343b7 695
8e2af478 696 /* Called for each property that is being set */
2e59b241 697 int (*bus_set_property)(Unit *u, const char *name, sd_bus_message *message, UnitWriteFlags flags, sd_bus_error *error);
8e2af478
LP
698
699 /* Called after at least one property got changed to apply the necessary change */
700 int (*bus_commit_properties)(Unit *u);
701
a7f241db
LP
702 /* Return the unit this unit is following */
703 Unit *(*following)(Unit *u);
704
6210e7fc
LP
705 /* Return the set of units that are following each other */
706 int (*following_set)(Unit *u, Set **s);
707
3ecaa09b
LP
708 /* Invoked each time a unit this unit is triggering changes
709 * state or gains/loses a job */
710 void (*trigger_notify)(Unit *u, Unit *trigger);
711
8742514c
LP
712 /* Called whenever CLOCK_REALTIME made a jump */
713 void (*time_change)(Unit *u);
714
bbf5fd8e
LP
715 /* Called whenever /etc/localtime was modified */
716 void (*timezone_change)(Unit *u);
717
7a7821c8
LP
718 /* Returns the next timeout of a unit */
719 int (*get_timeout)(Unit *u, usec_t *timeout);
68db7a3b 720
f5a9d2ee 721 /* Returns the start timeout of a unit */
722 usec_t (*get_timeout_start_usec)(Unit *u);
723
291d565a
LP
724 /* Returns the main PID if there is any defined, or 0. */
725 pid_t (*main_pid)(Unit *u);
726
727 /* Returns the main PID if there is any defined, or 0. */
728 pid_t (*control_pid)(Unit *u);
729
bb2c7685
LP
730 /* Returns true if the unit currently needs access to the console */
731 bool (*needs_console)(Unit *u);
732
7af67e9a
LP
733 /* Returns the exit status to propagate in case of FailureAction=exit/SuccessAction=exit; usually returns the
734 * exit code of the "main" process of the service or similar. */
735 int (*exit_status)(Unit *u);
736
5e1669ff
ZJS
737 /* Return a copy of the status string pointer. */
738 const char* (*status_text)(Unit *u);
739
04eb582a
LP
740 /* Like the enumerate() callback further down, but only enumerates the perpetual units, i.e. all units that
741 * unconditionally exist and are always active. The main reason to keep both enumeration functions separate is
742 * philosophical: the state of perpetual units should be put in place by coldplug(), while the state of those
743 * discovered through regular enumeration should be put in place by catchup(), see below. */
744 void (*enumerate_perpetual)(Manager *m);
745
f0831ed2
LP
746 /* This is called for each unit type and should be used to enumerate units already existing in the system
747 * internally and load them. However, everything that is loaded here should still stay in inactive state. It is
04eb582a 748 * the job of the catchup() call above to put the units into the discovered state. */
ba64af90 749 void (*enumerate)(Manager *m);
f50e0a01
LP
750
751 /* Type specific cleanups. */
7824bbeb 752 void (*shutdown)(Manager *m);
9d58f1db 753
cbd4a8df 754 /* If this function is set and returns false all jobs for units
0faacd47 755 * of this type will immediately fail. */
1c2e9646 756 bool (*supported)(void);
0faacd47 757
9727f242
DDM
758 /* If this function is set, it's invoked first as part of starting a unit to allow start rate
759 * limiting checks to occur before we do anything else. */
705578c3 760 int (*can_start)(Unit *u);
9727f242 761
47261967
LP
762 /* Returns > 0 if the whole subsystem is ratelimited, and new start operations should not be started
763 * for this unit type right now. */
764 int (*subsystem_ratelimited)(Manager *m);
765
718db961 766 /* The strings to print in status messages */
c6918296
MS
767 UnitStatusMessageFormats status_message_formats;
768
c2756a68 769 /* True if transient units of this type are OK */
cbd4a8df 770 bool can_transient;
c5a97ed1 771
1d9cc876 772 /* True if cgroup delegation is permissible */
cbd4a8df 773 bool can_delegate;
1d9cc876 774
c80a9a33 775 /* True if the unit type triggers other units, i.e. can have a UNIT_TRIGGERS dependency */
cbd4a8df 776 bool can_trigger;
c80a9a33
LP
777
778 /* True if the unit type knows a failure state, and thus can be source of an OnFailure= dependency */
cbd4a8df 779 bool can_fail;
c80a9a33 780
d4fd1cf2 781 /* True if units of this type shall be startable only once and then never again */
cbd4a8df 782 bool once_only;
d4fd1cf2 783
755021d4
ZJS
784 /* Do not serialize this unit when preparing for root switch */
785 bool exclude_from_switch_root_serialization;
786
c5a97ed1 787 /* True if queued jobs of this type should be GC'ed if no other job needs them anymore */
cbd4a8df 788 bool gc_jobs;
4d824a4e 789
0923b425 790 /* True if systemd-oomd can monitor and act on this unit's recursive children's cgroups */
cbd4a8df 791 bool can_set_managed_oom;
d52b8493 792
b2bfd121
LP
793 /* If true, we'll notify plymouth about this unit */
794 bool notify_plymouth;
795
d52b8493
LP
796 /* The audit events to generate on start + stop (or 0 if none shall be generated) */
797 int audit_start_message_type;
798 int audit_stop_message_type;
57b7a260 799} UnitVTable;
87f0e418
LP
800
801extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
802
c2503e35 803static inline const UnitVTable* UNIT_VTABLE(const Unit *u) {
6529ccfa
LP
804 return unit_vtable[u->type];
805}
87f0e418
LP
806
807/* For casting a unit into the various unit types */
808#define DEFINE_CAST(UPPERCASE, MixedCase) \
809 static inline MixedCase* UPPERCASE(Unit *u) { \
ac155bb8 810 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
87f0e418
LP
811 return NULL; \
812 \
813 return (MixedCase*) u; \
814 }
815
816/* For casting the various unit types into a unit */
bbf11206
LP
817#define UNIT(u) \
818 ({ \
819 typeof(u) _u_ = (u); \
820 Unit *_w_ = _u_ ? &(_u_)->meta : NULL; \
821 _w_; \
822 })
87f0e418 823
35b7ff80
LP
824#define UNIT_HAS_EXEC_CONTEXT(u) (UNIT_VTABLE(u)->exec_context_offset > 0)
825#define UNIT_HAS_CGROUP_CONTEXT(u) (UNIT_VTABLE(u)->cgroup_context_offset > 0)
826#define UNIT_HAS_KILL_CONTEXT(u) (UNIT_VTABLE(u)->kill_context_offset > 0)
827
15ed3c3a
LP
828Unit* unit_has_dependency(const Unit *u, UnitDependencyAtom atom, Unit *other);
829int unit_get_dependency_array(const Unit *u, UnitDependencyAtom atom, Unit ***ret_array);
83123a44 830int unit_get_transitive_dependency_set(Unit *u, UnitDependencyAtom atom, Set **ret);
15ed3c3a
LP
831
832static inline Hashmap* unit_get_dependencies(Unit *u, UnitDependency d) {
833 return hashmap_get(u->dependencies, UNIT_DEPENDENCY_TO_PTR(d));
834}
835
6529ccfa 836static inline Unit* UNIT_TRIGGER(Unit *u) {
15ed3c3a 837 return unit_has_dependency(u, UNIT_ATOM_TRIGGERS, NULL);
6529ccfa 838}
3ecaa09b 839
12f64221 840static inline Unit* UNIT_GET_SLICE(const Unit *u) {
d219a2b0 841 return unit_has_dependency(u, UNIT_ATOM_IN_SLICE, NULL);
12f64221
LP
842}
843
75db809a
ZJS
844Unit* unit_new(Manager *m, size_t size);
845Unit* unit_free(Unit *u);
dc409696 846DEFINE_TRIVIAL_CLEANUP_FUNC(Unit *, unit_free);
87f0e418 847
a581e45a 848int unit_new_for_name(Manager *m, size_t size, const char *name, Unit **ret);
87f0e418 849int unit_add_name(Unit *u, const char *name);
9e2f7c11 850
eef85c4a
LP
851int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference, UnitDependencyMask mask);
852int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference, UnitDependencyMask mask);
2c966c03 853
35d8c19a 854int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, bool add_reference, UnitDependencyMask mask);
5a724170 855int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, bool add_reference, UnitDependencyMask mask);
2c966c03 856
23a177ef 857int unit_add_exec_dependencies(Unit *u, ExecContext *c);
b80fc61e
LB
858/* Helper for IgnoreOnSoftReboot units that need to survive soft-reboot.target but not others */
859int unit_add_dependencies_on_real_shutdown_targets(Unit *u);
23a177ef 860
0ae97ec1 861int unit_choose_id(Unit *u, const char *name);
f50e0a01 862int unit_set_description(Unit *u, const char *description);
87f0e418 863
6ac62d61
LP
864void unit_release_resources(Unit *u);
865
f2f725e5 866bool unit_may_gc(Unit *u);
701cc384 867
39c79477
ZJS
868static inline bool unit_is_extrinsic(Unit *u) {
869 return u->perpetual ||
870 (UNIT_VTABLE(u)->is_extrinsic && UNIT_VTABLE(u)->is_extrinsic(u));
871}
872
5e1669ff
ZJS
873static inline const char* unit_status_text(Unit *u) {
874 if (u && UNIT_VTABLE(u)->status_text)
875 return UNIT_VTABLE(u)->status_text(u);
876 return NULL;
877}
878
87f0e418 879void unit_add_to_load_queue(Unit *u);
c1e1601e 880void unit_add_to_dbus_queue(Unit *u);
23a177ef 881void unit_add_to_cleanup_queue(Unit *u);
701cc384 882void unit_add_to_gc_queue(Unit *u);
19496554 883void unit_add_to_target_deps_queue(Unit *u);
fda09318 884void unit_submit_to_stop_when_unneeded_queue(Unit *u);
0bc488c9 885void unit_submit_to_start_when_upheld_queue(Unit *u);
56c59592 886void unit_submit_to_stop_when_bound_queue(Unit *u);
6ac62d61 887void unit_submit_to_release_resources_queue(Unit *u);
87f0e418
LP
888
889int unit_merge(Unit *u, Unit *other);
23a177ef
LP
890int unit_merge_by_name(Unit *u, const char *other);
891
44a6b1b6 892Unit *unit_follow_merge(Unit *u) _pure_;
87f0e418 893
c3620770 894int unit_load_fragment_and_dropin(Unit *u, bool fragment_required);
87f0e418
LP
895int unit_load(Unit *unit);
896
899acf5c 897int unit_set_slice(Unit *u, Unit *slice);
d79200e2 898int unit_set_default_slice(Unit *u);
a016b922 899
44a6b1b6 900const char *unit_description(Unit *u) _pure_;
04d232d8 901const char *unit_status_string(Unit *u, char **combined);
87f0e418 902
303ee601 903bool unit_has_name(const Unit *u, const char *name);
f278026d 904
87f0e418 905UnitActiveState unit_active_state(Unit *u);
d9e45bc3
MS
906FreezerState unit_freezer_state(Unit *u);
907int unit_freezer_state_kernel(Unit *u, FreezerState *ret);
87f0e418 908
10a94420
LP
909const char* unit_sub_state_to_string(Unit *u);
910
44a6b1b6
ZJS
911bool unit_can_reload(Unit *u) _pure_;
912bool unit_can_start(Unit *u) _pure_;
f5869324 913bool unit_can_stop(Unit *u) _pure_;
44a6b1b6 914bool unit_can_isolate(Unit *u) _pure_;
87f0e418 915
48b92b37 916int unit_start(Unit *u, ActivationDetails *details);
87f0e418
LP
917int unit_stop(Unit *u);
918int unit_reload(Unit *u);
919
a721cd00
LP
920int unit_kill(Unit *u, KillWho w, int signo, int code, int value, sd_bus_error *error);
921int 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 922
38c41427
NK
923void unit_notify_cgroup_oom(Unit *u, bool managed_oom);
924
96b09de5 925void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
87f0e418 926
f75f613d 927int unit_watch_pid(Unit *u, pid_t pid, bool exclusive);
87f0e418 928void unit_unwatch_pid(Unit *u, pid_t pid);
a911bb9a
LP
929void unit_unwatch_all_pids(Unit *u);
930
50be4f4a
LP
931int unit_enqueue_rewatch_pids(Unit *u);
932void unit_dequeue_rewatch_pids(Unit *u);
87f0e418 933
9806e87d 934int unit_install_bus_match(Unit *u, sd_bus *bus, const char *name);
05e343b7
LP
935int unit_watch_bus_name(Unit *u, const char *name);
936void unit_unwatch_bus_name(Unit *u, const char *name);
937
87f0e418
LP
938bool unit_job_is_applicable(Unit *u, JobType j);
939
0301abf4
LP
940int set_unit_path(const char *p);
941
50159e6a 942char *unit_dbus_path(Unit *u);
4b58153d 943char *unit_dbus_path_invocation_id(Unit *u);
50159e6a 944
f6ff8c29
LP
945int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
946
d336ba9f 947int unit_add_node_dependency(Unit *u, const char *what, UnitDependency d, UnitDependencyMask mask);
44b0d1fd 948int unit_add_blockdev_dependency(Unit *u, const char *what, UnitDependencyMask mask);
6e2ef85b 949
be847e82 950int unit_coldplug(Unit *u);
f0831ed2 951void unit_catchup(Unit *u);
cca098b0 952
04d232d8 953void unit_status_printf(Unit *u, StatusType status_type, const char *status, const char *format, const char *ident) _printf_(4, 0);
9e58ff9c 954
45fb0699
LP
955bool unit_need_daemon_reload(Unit *u);
956
fdf20a31 957void unit_reset_failed(Unit *u);
5632e374 958
a7f241db 959Unit *unit_following(Unit *u);
eeaedb7c 960int unit_following_set(Unit *u, Set **s);
a7f241db 961
9444b1f2
LP
962const char *unit_slice_name(Unit *u);
963
44a6b1b6
ZJS
964bool unit_stop_pending(Unit *u) _pure_;
965bool unit_inactive_or_pending(Unit *u) _pure_;
31afa0a4 966bool unit_active_or_pending(Unit *u);
52a12341 967bool unit_will_restart_default(Unit *u);
deb4e708 968bool unit_will_restart(Unit *u);
18ffdfda 969
bba34eed
LP
970int unit_add_default_target_dependency(Unit *u, Unit *target);
971
294446dc 972void unit_start_on_failure(Unit *u, const char *dependency_name, UnitDependencyAtom atom, JobMode job_mode);
3ecaa09b 973void unit_trigger_notify(Unit *u);
c0daa706 974
a4375746 975UnitFileState unit_get_unit_file_state(Unit *u);
e77e07f6 976PresetAction unit_get_unit_file_preset(Unit *u);
a4375746 977
7f7d01ed 978Unit* unit_ref_set(UnitRef *ref, Unit *source, Unit *target);
57020a3a
LP
979void unit_ref_unset(UnitRef *ref);
980
7f7d01ed
ZJS
981#define UNIT_DEREF(ref) ((ref).target)
982#define UNIT_ISSET(ref) (!!(ref).target)
57020a3a 983
598459ce 984int unit_patch_contexts(Unit *u);
e06c73cc 985
c2503e35 986ExecContext *unit_get_exec_context(const Unit *u) _pure_;
718db961 987KillContext *unit_get_kill_context(Unit *u) _pure_;
4ad49000 988CGroupContext *unit_get_cgroup_context(Unit *u) _pure_;
598459ce 989
28135da3 990ExecRuntime *unit_get_exec_runtime(Unit *u) _pure_;
613b411c
LP
991
992int unit_setup_exec_runtime(Unit *u);
3ef63c31 993
68ecb48b 994const char* unit_escape_setting(const char *s, UnitWriteFlags flags, char **buf);
2e59b241 995char* unit_concat_strv(char **l, UnitWriteFlags flags);
b9ec9359 996
2e59b241
LP
997int unit_write_setting(Unit *u, UnitWriteFlags flags, const char *name, const char *data);
998int unit_write_settingf(Unit *u, UnitWriteFlags mode, const char *name, const char *format, ...) _printf_(4,5);
b9ec9359 999
db2cb23b 1000int unit_kill_context(Unit *u, KillContext *c, KillOperation k, pid_t main_pid, pid_t control_pid, bool main_pid_alien);
cd2086fe 1001
c2756a68
LP
1002int unit_make_transient(Unit *u);
1003
eef85c4a 1004int unit_require_mounts_for(Unit *u, const char *path, UnitDependencyMask mask);
a57f7e2c 1005
1c2e9646
LP
1006bool unit_type_supported(UnitType t);
1007
0f13f3bd
LP
1008bool unit_is_pristine(Unit *u);
1009
a3c1168a 1010bool unit_is_unneeded(Unit *u);
0bc488c9 1011bool unit_is_upheld_by_active(Unit *u, Unit **ret_culprit);
56c59592 1012bool unit_is_bound_by_inactive(Unit *u, Unit **ret_culprit);
a3c1168a 1013
291d565a
LP
1014pid_t unit_control_pid(Unit *u);
1015pid_t unit_main_pid(Unit *u);
1016
8b4305c7 1017void unit_warn_if_dir_nonempty(Unit *u, const char* where);
25cd4964 1018int unit_fail_if_noncanonical(Unit *u, const char* where);
8b4305c7 1019
97a3f4ee 1020int unit_test_start_limit(Unit *u);
07299350 1021
00d9ef85
LP
1022int unit_ref_uid_gid(Unit *u, uid_t uid, gid_t gid);
1023void unit_unref_uid_gid(Unit *u, bool destroy_now);
1024
1025void unit_notify_user_lookup(Unit *u, uid_t uid, gid_t gid);
1026
2d3b784d 1027int unit_set_invocation_id(Unit *u, sd_id128_t id);
4b58153d
LP
1028int unit_acquire_invocation_id(Unit *u);
1029
c891efaf
FB
1030bool unit_shall_confirm_spawn(Unit *u);
1031
1ad6e8b3 1032int unit_set_exec_params(Unit *s, ExecParameters *p);
f0d47797 1033
4c253ed1 1034int unit_fork_helper_process(Unit *u, const char *name, pid_t *ret);
810ef318 1035int unit_fork_and_watch_rm_rf(Unit *u, char **paths, pid_t *ret_pid);
a79279c7 1036
c999cf38
LP
1037void unit_remove_dependencies(Unit *u, UnitDependencyMask mask);
1038
d3070fbd
LP
1039void unit_export_state_files(Unit *u);
1040void unit_unlink_state_files(Unit *u);
1041
3c7416b6
LP
1042int unit_prepare_exec(Unit *u);
1043
4c425434
LP
1044int unit_log_leftover_process_start(pid_t pid, int sig, void *userdata);
1045int unit_log_leftover_process_stop(pid_t pid, int sig, void *userdata);
1046int unit_warn_leftover_processes(Unit *u, cg_kill_log_func_t log_func);
a4634b21 1047
bb2c7685
LP
1048bool unit_needs_console(Unit *u);
1049
6592b975
LP
1050int unit_pid_attachable(Unit *unit, pid_t pid, sd_bus_error *error);
1051
28a2dfe8
ZJS
1052static inline bool unit_has_job_type(Unit *u, JobType type) {
1053 return u && u->job && u->job->type == type;
1054}
1055
c2503e35
RH
1056static inline bool unit_log_level_test(const Unit *u, int level) {
1057 ExecContext *ec = unit_get_exec_context(u);
1058 return !ec || ec->log_level_max < 0 || ec->log_level_max >= LOG_PRI(level);
1059}
1060
31cd5f63
AZ
1061/* unit_log_skip is for cases like ExecCondition= where a unit is considered "done"
1062 * after some execution, rather than succeeded or failed. */
1063void unit_log_skip(Unit *u, const char *result);
523ee2d4 1064void unit_log_success(Unit *u);
7c047d74 1065void unit_log_failure(Unit *u, const char *result);
aac99f30
ZJS
1066static inline void unit_log_result(Unit *u, bool success, const char *result) {
1067 if (success)
1068 unit_log_success(u);
1069 else
1070 unit_log_failure(u, result);
1071}
1072
5cc2cd1c 1073void unit_log_process_exit(Unit *u, const char *kind, const char *command, bool success, int code, int status);
7c047d74 1074
7af67e9a
LP
1075int unit_exit_status(Unit *u);
1076int unit_success_action_exit_status(Unit *u);
1077int unit_failure_action_exit_status(Unit *u);
1078
a4191c9f
LP
1079int unit_test_trigger_loaded(Unit *u);
1080
bb0c0d6f 1081void unit_destroy_runtime_data(Unit *u, const ExecContext *context);
380dc8b0
LP
1082int unit_clean(Unit *u, ExecCleanMask mask);
1083int unit_can_clean(Unit *u, ExecCleanMask *ret_mask);
1084
d9e45bc3
MS
1085bool unit_can_freeze(Unit *u);
1086int unit_freeze(Unit *u);
1087void unit_frozen(Unit *u);
1088
1089int unit_thaw(Unit *u);
1090void unit_thawed(Unit *u);
1091
1092int unit_freeze_vtable_common(Unit *u);
1093int unit_thaw_vtable_common(Unit *u);
1094
6e548561
DDM
1095Condition *unit_find_failed_condition(Unit *u);
1096
e8e581bf
ZJS
1097/* Macros which append UNIT= or USER_UNIT= to the message */
1098
ac513634 1099#define log_unit_full_errno_zerook(unit, level, error, ...) \
f2341e0a 1100 ({ \
8dec4a9d 1101 const Unit *_u = (unit); \
c2503e35 1102 const int _l = (level); \
1092e82b
LB
1103 bool _do_log = !(log_get_max_level() < LOG_PRI(_l) || \
1104 (_u && !unit_log_level_test(_u, _l))); \
1105 const ExecContext *_c = _do_log && _u ? \
1106 unit_get_exec_context(_u) : NULL; \
1107 LOG_CONTEXT_PUSH_IOV(_c ? _c->log_extra_fields : NULL, \
1108 _c ? _c->n_log_extra_fields : 0); \
1109 !_do_log ? -ERRNO_VALUE(error) : \
c2503e35
RH
1110 _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__) : \
1111 log_internal(_l, error, PROJECT_FILE, __LINE__, __func__, ##__VA_ARGS__); \
f2341e0a
LP
1112 })
1113
ac513634
YW
1114#define log_unit_full_errno(unit, level, error, ...) \
1115 ({ \
1116 int _error = (error); \
1117 ASSERT_NON_ZERO(_error); \
1118 log_unit_full_errno_zerook(unit, level, _error, ##__VA_ARGS__); \
1119 })
1120
1121#define log_unit_full(unit, level, ...) (void) log_unit_full_errno_zerook(unit, level, 0, __VA_ARGS__)
8ed6f81b 1122
ac513634 1123#define log_unit_debug(unit, ...) log_unit_full(unit, LOG_DEBUG, __VA_ARGS__)
8ed6f81b
YW
1124#define log_unit_info(unit, ...) log_unit_full(unit, LOG_INFO, __VA_ARGS__)
1125#define log_unit_notice(unit, ...) log_unit_full(unit, LOG_NOTICE, __VA_ARGS__)
1126#define log_unit_warning(unit, ...) log_unit_full(unit, LOG_WARNING, __VA_ARGS__)
1127#define log_unit_error(unit, ...) log_unit_full(unit, LOG_ERR, __VA_ARGS__)
1128
1129#define log_unit_debug_errno(unit, error, ...) log_unit_full_errno(unit, LOG_DEBUG, error, __VA_ARGS__)
1130#define log_unit_info_errno(unit, error, ...) log_unit_full_errno(unit, LOG_INFO, error, __VA_ARGS__)
1131#define log_unit_notice_errno(unit, error, ...) log_unit_full_errno(unit, LOG_NOTICE, error, __VA_ARGS__)
1132#define log_unit_warning_errno(unit, error, ...) log_unit_full_errno(unit, LOG_WARNING, error, __VA_ARGS__)
1133#define log_unit_error_errno(unit, error, ...) log_unit_full_errno(unit, LOG_ERR, error, __VA_ARGS__)
f2341e0a 1134
556b6f4e
DDM
1135#if LOG_TRACE
1136# define log_unit_trace(...) log_unit_debug(__VA_ARGS__)
1137# define log_unit_trace_errno(...) log_unit_debug_errno(__VA_ARGS__)
1138#else
1139# define log_unit_trace(...) do {} while (0)
1140# define log_unit_trace_errno(e, ...) (-ERRNO_VALUE(e))
1141#endif
1142
c2503e35
RH
1143#define log_unit_struct_errno(unit, level, error, ...) \
1144 ({ \
1145 const Unit *_u = (unit); \
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_errno(_l, error, __VA_ARGS__, LOG_UNIT_ID(_u)) : \
1154 -ERRNO_VALUE(error); \
1155 })
1156
1157#define log_unit_struct(unit, level, ...) log_unit_struct_errno(unit, level, 0, __VA_ARGS__)
1158
1159#define log_unit_struct_iovec_errno(unit, level, error, iovec, n_iovec) \
1160 ({ \
1092e82b 1161 const Unit *_u = (unit); \
c2503e35 1162 const int _l = (level); \
1092e82b
LB
1163 bool _do_log = unit_log_level_test(_u, _l); \
1164 const ExecContext *_c = _do_log && _u ? \
1165 unit_get_exec_context(_u) : NULL; \
1166 LOG_CONTEXT_PUSH_IOV(_c ? _c->log_extra_fields : NULL, \
1167 _c ? _c->n_log_extra_fields : 0); \
1168 _do_log ? \
c2503e35
RH
1169 log_struct_iovec_errno(_l, error, iovec, n_iovec) : \
1170 -ERRNO_VALUE(error); \
1171 })
1172
1173#define log_unit_struct_iovec(unit, level, iovec, n_iovec) log_unit_struct_iovec_errno(unit, level, 0, iovec, n_iovec)
1174
b9ce5cf9
ZJS
1175/* Like LOG_MESSAGE(), but with the unit name prefixed. */
1176#define LOG_UNIT_MESSAGE(unit, fmt, ...) LOG_MESSAGE("%s: " fmt, (unit)->id, ##__VA_ARGS__)
f2341e0a 1177#define LOG_UNIT_ID(unit) (unit)->manager->unit_log_format_string, (unit)->id
f1c50bec 1178#define LOG_UNIT_INVOCATION_ID(unit) (unit)->manager->invocation_log_format_string, (unit)->invocation_id_string
5afe510c
LP
1179
1180const char* collect_mode_to_string(CollectMode m) _const_;
1181CollectMode collect_mode_from_string(const char *s) _pure_;
15ed3c3a
LP
1182
1183typedef struct UnitForEachDependencyData {
1184 /* Stores state for the FOREACH macro below for iterating through all deps that have any of the
1185 * specified dependency atom bits set */
1186 UnitDependencyAtom match_atom;
1187 Hashmap *by_type, *by_unit;
1188 void *current_type;
1189 Iterator by_type_iterator, by_unit_iterator;
1190 Unit **current_unit;
1191} UnitForEachDependencyData;
1192
1193/* Iterates through all dependencies that have a specific atom in the dependency type set. This tries to be
1194 * smart: if the atom is unique, we'll directly go to right entry. Otherwise we'll iterate through the
1195 * per-dependency type hashmap and match all dep that have the right atom set. */
1196#define _UNIT_FOREACH_DEPENDENCY(other, u, ma, data) \
1197 for (UnitForEachDependencyData data = { \
1198 .match_atom = (ma), \
1199 .by_type = (u)->dependencies, \
1200 .by_type_iterator = ITERATOR_FIRST, \
1201 .current_unit = &(other), \
1202 }; \
1203 ({ \
1204 UnitDependency _dt = _UNIT_DEPENDENCY_INVALID; \
1205 bool _found; \
1206 \
1207 if (data.by_type && ITERATOR_IS_FIRST(data.by_type_iterator)) { \
1208 _dt = unit_dependency_from_unique_atom(data.match_atom); \
1209 if (_dt >= 0) { \
1210 data.by_unit = hashmap_get(data.by_type, UNIT_DEPENDENCY_TO_PTR(_dt)); \
1211 data.current_type = UNIT_DEPENDENCY_TO_PTR(_dt); \
1212 data.by_type = NULL; \
1213 _found = !!data.by_unit; \
1214 } \
1215 } \
1216 if (_dt < 0) \
1217 _found = hashmap_iterate(data.by_type, \
1218 &data.by_type_iterator, \
1219 (void**)&(data.by_unit), \
1220 (const void**) &(data.current_type)); \
1221 _found; \
1222 }); ) \
1223 if ((unit_dependency_to_atom(UNIT_DEPENDENCY_FROM_PTR(data.current_type)) & data.match_atom) != 0) \
1224 for (data.by_unit_iterator = ITERATOR_FIRST; \
1225 hashmap_iterate(data.by_unit, \
1226 &data.by_unit_iterator, \
1227 NULL, \
1228 (const void**) data.current_unit); )
1229
1230/* Note: this matches deps that have *any* of the atoms specified in match_atom set */
1231#define UNIT_FOREACH_DEPENDENCY(other, u, match_atom) \
1232 _UNIT_FOREACH_DEPENDENCY(other, u, match_atom, UNIQ_T(data, UNIQ))
4b2af439
DDM
1233
1234#define _LOG_CONTEXT_PUSH_UNIT(unit, u, c) \
1235 const Unit *u = (unit); \
1236 const ExecContext *c = unit_get_exec_context(u); \
1237 LOG_CONTEXT_PUSH_KEY_VALUE(u->manager->unit_log_field, u->id); \
1238 LOG_CONTEXT_PUSH_KEY_VALUE(u->manager->invocation_log_field, u->invocation_id_string); \
1239 LOG_CONTEXT_PUSH_IOV(c ? c->log_extra_fields : NULL, c ? c->n_log_extra_fields : 0)
1240
1241#define LOG_CONTEXT_PUSH_UNIT(unit) \
1242 _LOG_CONTEXT_PUSH_UNIT(unit, UNIQ_T(u, UNIQ), UNIQ_T(c, UNIQ))