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