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