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