]>
Commit | Line | Data |
---|---|---|
53e1b683 | 1 | /* SPDX-License-Identifier: LGPL-2.1+ */ |
c2f1db8f | 2 | #pragma once |
87f0e418 | 3 | |
a7334b09 LP |
4 | /*** |
5 | This file is part of systemd. | |
6 | ||
7 | Copyright 2010 Lennart Poettering | |
a7334b09 LP |
8 | ***/ |
9 | ||
87f0e418 LP |
10 | #include <stdbool.h> |
11 | #include <stdlib.h> | |
bbc9006e | 12 | #include <unistd.h> |
87f0e418 | 13 | |
6a48d82f | 14 | #include "bpf-program.h" |
134e56dc | 15 | #include "condition.h" |
87a47f99 | 16 | #include "emergency-action.h" |
a4375746 | 17 | #include "install.h" |
71d35b6b | 18 | #include "list.h" |
0a9f8ed0 | 19 | #include "unit-name.h" |
6b659ed8 | 20 | #include "cgroup.h" |
87f0e418 | 21 | |
57b7a260 FS |
22 | typedef struct UnitRef UnitRef; |
23 | ||
db2cb23b UTL |
24 | typedef enum KillOperation { |
25 | KILL_TERMINATE, | |
1d98fef1 | 26 | KILL_TERMINATE_AND_LOG, |
db2cb23b UTL |
27 | KILL_KILL, |
28 | KILL_ABORT, | |
4940c0b0 LP |
29 | _KILL_OPERATION_MAX, |
30 | _KILL_OPERATION_INVALID = -1 | |
db2cb23b UTL |
31 | } KillOperation; |
32 | ||
5afe510c LP |
33 | typedef enum CollectMode { |
34 | COLLECT_INACTIVE, | |
35 | COLLECT_INACTIVE_OR_FAILED, | |
36 | _COLLECT_MODE_MAX, | |
37 | _COLLECT_MODE_INVALID = -1, | |
38 | } CollectMode; | |
39 | ||
87f0e418 | 40 | static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) { |
3742095b | 41 | return IN_SET(t, UNIT_ACTIVE, UNIT_RELOADING); |
87f0e418 LP |
42 | } |
43 | ||
44 | static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) { | |
3742095b | 45 | return IN_SET(t, UNIT_ACTIVE, UNIT_ACTIVATING, UNIT_RELOADING); |
87f0e418 LP |
46 | } |
47 | ||
48 | static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) { | |
3742095b | 49 | return IN_SET(t, UNIT_INACTIVE, UNIT_FAILED, UNIT_DEACTIVATING); |
6124958c LP |
50 | } |
51 | ||
fdf20a31 | 52 | static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t) { |
3742095b | 53 | return IN_SET(t, UNIT_INACTIVE, UNIT_FAILED); |
87f0e418 LP |
54 | } |
55 | ||
eef85c4a LP |
56 | /* Stores the 'reason' a dependency was created as a bit mask, i.e. due to which configuration source it came to be. We |
57 | * use this so that we can selectively flush out parts of dependencies again. Note that the same dependency might be | |
58 | * created as a result of multiple "reasons", hence the bitmask. */ | |
59 | typedef enum UnitDependencyMask { | |
60 | /* Configured directly by the unit file, .wants/.requries symlink or drop-in, or as an immediate result of a | |
61 | * non-dependency option configured that way. */ | |
62 | UNIT_DEPENDENCY_FILE = 1 << 0, | |
63 | ||
64 | /* As unconditional implicit dependency (not affected by unit configuration — except by the unit name and | |
65 | * type) */ | |
66 | UNIT_DEPENDENCY_IMPLICIT = 1 << 1, | |
67 | ||
68 | /* A dependency effected by DefaultDependencies=yes. Note that dependencies marked this way are conceptually | |
69 | * just a subset of UNIT_DEPENDENCY_FILE, as DefaultDependencies= is itself a unit file setting that can only | |
70 | * be set in unit files. We make this two separate bits only to help debugging how dependencies came to be. */ | |
71 | UNIT_DEPENDENCY_DEFAULT = 1 << 2, | |
72 | ||
73 | /* A dependency created from udev rules */ | |
74 | UNIT_DEPENDENCY_UDEV = 1 << 3, | |
75 | ||
76 | /* A dependency created because of some unit's RequiresMountsFor= setting */ | |
77 | UNIT_DEPENDENCY_PATH = 1 << 4, | |
78 | ||
79 | /* A dependency created because of data read from /proc/self/mountinfo and no other configuration source */ | |
80 | UNIT_DEPENDENCY_MOUNTINFO_IMPLICIT = 1 << 5, | |
81 | ||
82 | /* A dependency created because of data read from /proc/self/mountinfo, but conditionalized by | |
83 | * DefaultDependencies= and thus also involving configuration from UNIT_DEPENDENCY_FILE sources */ | |
84 | UNIT_DEPENDENCY_MOUNTINFO_DEFAULT = 1 << 6, | |
85 | ||
86 | /* A dependency created because of data read from /proc/swaps and no other configuration source */ | |
87 | UNIT_DEPENDENCY_PROC_SWAP = 1 << 7, | |
88 | ||
89 | _UNIT_DEPENDENCY_MASK_FULL = (1 << 8) - 1, | |
90 | } UnitDependencyMask; | |
91 | ||
92 | /* The Unit's dependencies[] hashmaps use this structure as value. It has the same size as a void pointer, and thus can | |
93 | * be stored directly as hashmap value, without any indirection. Note that this stores two masks, as both the origin | |
94 | * and the destination of a dependency might have created it. */ | |
95 | typedef union UnitDependencyInfo { | |
96 | void *data; | |
97 | struct { | |
98 | UnitDependencyMask origin_mask:16; | |
99 | UnitDependencyMask destination_mask:16; | |
100 | } _packed_; | |
101 | } UnitDependencyInfo; | |
102 | ||
ef734fd6 LP |
103 | #include "job.h" |
104 | ||
a016b922 LP |
105 | struct UnitRef { |
106 | /* Keeps tracks of references to a unit. This is useful so | |
107 | * that we can merge two units if necessary and correct all | |
108 | * references to them */ | |
109 | ||
7f7d01ed ZJS |
110 | Unit *source, *target; |
111 | LIST_FIELDS(UnitRef, refs_by_target); | |
a016b922 LP |
112 | }; |
113 | ||
906c06f6 DM |
114 | typedef enum UnitCGroupBPFState { |
115 | UNIT_CGROUP_BPF_OFF = 0, | |
116 | UNIT_CGROUP_BPF_ON = 1, | |
117 | UNIT_CGROUP_BPF_INVALIDATED = -1, | |
118 | } UnitCGroupBPFState; | |
119 | ||
57b7a260 | 120 | typedef struct Unit { |
87f0e418 | 121 | Manager *manager; |
23a177ef | 122 | |
87f0e418 LP |
123 | UnitType type; |
124 | UnitLoadState load_state; | |
23a177ef | 125 | Unit *merged_into; |
87f0e418 LP |
126 | |
127 | char *id; /* One name is special because we use it for identification. Points to an entry in the names set */ | |
9e2f7c11 | 128 | char *instance; |
87f0e418 LP |
129 | |
130 | Set *names; | |
87f0e418 | 131 | |
eef85c4a LP |
132 | /* For each dependency type we maintain a Hashmap whose key is the Unit* object, and the value encodes why the |
133 | * dependency exists, using the UnitDependencyInfo type */ | |
134 | Hashmap *dependencies[_UNIT_DEPENDENCY_MAX]; | |
135 | ||
136 | /* Similar, for RequiresMountsFor= path dependencies. The key is the path, the value the UnitDependencyInfo type */ | |
137 | Hashmap *requires_mounts_for; | |
7c8fa05c | 138 | |
87f0e418 | 139 | char *description; |
49dbfa7b | 140 | char **documentation; |
faf919f1 | 141 | |
6be1e7d5 | 142 | char *fragment_path; /* if loaded from a config file this is the primary path to it */ |
1b64d026 | 143 | char *source_path; /* if converted, the source file */ |
ae7a7182 | 144 | char **dropin_paths; |
f78f265f | 145 | |
45fb0699 | 146 | usec_t fragment_mtime; |
1b64d026 | 147 | usec_t source_mtime; |
ae7a7182 | 148 | usec_t dropin_mtime; |
87f0e418 | 149 | |
4f4afc88 LP |
150 | /* If this is a transient unit we are currently writing, this is where we are writing it to */ |
151 | FILE *transient_file; | |
152 | ||
e0209d83 | 153 | /* If there is something to do with this unit, then this is the installed job for it */ |
87f0e418 LP |
154 | Job *job; |
155 | ||
e0209d83 MS |
156 | /* JOB_NOP jobs are special and can be installed without disturbing the real job. */ |
157 | Job *nop_job; | |
158 | ||
bbc29086 DM |
159 | /* The slot used for watching NameOwnerChanged signals */ |
160 | sd_bus_slot *match_bus_slot; | |
161 | ||
05a98afd LP |
162 | /* References to this unit from clients */ |
163 | sd_bus_track *bus_track; | |
164 | char **deserialized_refs; | |
165 | ||
f189ab18 | 166 | /* Job timeout and action to take */ |
faf919f1 | 167 | usec_t job_timeout; |
a2df3ea4 | 168 | usec_t job_running_timeout; |
eae51da3 | 169 | bool job_running_timeout_set:1; |
87a47f99 | 170 | EmergencyAction job_timeout_action; |
f189ab18 | 171 | char *job_timeout_reboot_arg; |
faf919f1 | 172 | |
57020a3a | 173 | /* References to this */ |
7f7d01ed | 174 | LIST_HEAD(UnitRef, refs_by_target); |
57020a3a | 175 | |
52661efd LP |
176 | /* Conditions to check */ |
177 | LIST_HEAD(Condition, conditions); | |
59fccdc5 | 178 | LIST_HEAD(Condition, asserts); |
52661efd | 179 | |
90bbc946 | 180 | dual_timestamp condition_timestamp; |
59fccdc5 | 181 | dual_timestamp assert_timestamp; |
90bbc946 | 182 | |
a483fb59 LP |
183 | /* Updated whenever the low-level state changes */ |
184 | dual_timestamp state_change_timestamp; | |
185 | ||
186 | /* Updated whenever the (high-level) active state enters or leaves the active or inactive states */ | |
63983207 LP |
187 | dual_timestamp inactive_exit_timestamp; |
188 | dual_timestamp active_enter_timestamp; | |
189 | dual_timestamp active_exit_timestamp; | |
190 | dual_timestamp inactive_enter_timestamp; | |
87f0e418 | 191 | |
a016b922 LP |
192 | UnitRef slice; |
193 | ||
ef734fd6 | 194 | /* Per type list */ |
ac155bb8 | 195 | LIST_FIELDS(Unit, units_by_type); |
c1e1601e | 196 | |
7c8fa05c LP |
197 | /* All units which have requires_mounts_for set */ |
198 | LIST_FIELDS(Unit, has_requires_mounts_for); | |
199 | ||
701cc384 | 200 | /* Load queue */ |
ac155bb8 | 201 | LIST_FIELDS(Unit, load_queue); |
701cc384 | 202 | |
c1e1601e | 203 | /* D-Bus queue */ |
ac155bb8 | 204 | LIST_FIELDS(Unit, dbus_queue); |
23a177ef LP |
205 | |
206 | /* Cleanup queue */ | |
ac155bb8 | 207 | LIST_FIELDS(Unit, cleanup_queue); |
9d58f1db | 208 | |
701cc384 | 209 | /* GC queue */ |
ac155bb8 | 210 | LIST_FIELDS(Unit, gc_queue); |
701cc384 | 211 | |
4ad49000 | 212 | /* CGroup realize members queue */ |
91a6073e | 213 | LIST_FIELDS(Unit, cgroup_realize_queue); |
4ad49000 | 214 | |
09e24654 LP |
215 | /* cgroup empty queue */ |
216 | LIST_FIELDS(Unit, cgroup_empty_queue); | |
217 | ||
19496554 MS |
218 | /* Target dependencies queue */ |
219 | LIST_FIELDS(Unit, target_deps_queue); | |
220 | ||
a911bb9a LP |
221 | /* PIDs we keep an eye on. Note that a unit might have many |
222 | * more, but these are the ones we care enough about to | |
223 | * process SIGCHLD for */ | |
224 | Set *pids; | |
225 | ||
62a76913 LP |
226 | /* Used in SIGCHLD and sd_notify() message event invocation logic to avoid that we dispatch the same event |
227 | * multiple times on the same unit. */ | |
228 | unsigned sigchldgen; | |
229 | unsigned notifygen; | |
36f20ae3 | 230 | |
701cc384 | 231 | /* Used during GC sweeps */ |
eced69b3 | 232 | unsigned gc_marker; |
701cc384 | 233 | |
8821a00f LP |
234 | /* Error code when we didn't manage to load the unit (negative) */ |
235 | int load_error; | |
236 | ||
6bf0f408 LP |
237 | /* Put a ratelimit on unit starting */ |
238 | RateLimit start_limit; | |
87a47f99 | 239 | EmergencyAction start_limit_action; |
53c35a76 LP |
240 | |
241 | EmergencyAction failure_action; | |
e7dfbb4e | 242 | EmergencyAction success_action; |
6bf0f408 LP |
243 | char *reboot_arg; |
244 | ||
67bfdc97 LP |
245 | /* Make sure we never enter endless loops with the check unneeded logic, or the BindsTo= logic */ |
246 | RateLimit auto_stop_ratelimit; | |
bea355da | 247 | |
00d9ef85 LP |
248 | /* Reference to a specific UID/GID */ |
249 | uid_t ref_uid; | |
250 | gid_t ref_gid; | |
251 | ||
d2dc52db | 252 | /* Cached unit file state and preset */ |
a4375746 | 253 | UnitFileState unit_file_state; |
d2dc52db | 254 | int unit_file_preset; |
a4375746 | 255 | |
66ebf6c0 TH |
256 | /* Where the cpu.stat or cpuacct.usage was at the time the unit was started */ |
257 | nsec_t cpu_usage_base; | |
fe700f46 | 258 | nsec_t cpu_usage_last; /* the most recently read value */ |
5ad096b3 | 259 | |
7c52a17b ZJS |
260 | /* Counterparts in the cgroup filesystem */ |
261 | char *cgroup_path; | |
efdb0237 | 262 | CGroupMask cgroup_realized_mask; |
ccf78df1 | 263 | CGroupMask cgroup_enabled_mask; |
efdb0237 LP |
264 | CGroupMask cgroup_subtree_mask; |
265 | CGroupMask cgroup_members_mask; | |
266 | int cgroup_inotify_wd; | |
7c52a17b | 267 | |
6a48d82f DM |
268 | /* IP BPF Firewalling/accounting */ |
269 | int ip_accounting_ingress_map_fd; | |
270 | int ip_accounting_egress_map_fd; | |
271 | ||
272 | int ipv4_allow_map_fd; | |
273 | int ipv6_allow_map_fd; | |
274 | int ipv4_deny_map_fd; | |
275 | int ipv6_deny_map_fd; | |
276 | ||
aa2b6f1d LP |
277 | BPFProgram *ip_bpf_ingress, *ip_bpf_ingress_installed; |
278 | BPFProgram *ip_bpf_egress, *ip_bpf_egress_installed; | |
6a48d82f | 279 | |
6b659ed8 LP |
280 | uint64_t ip_accounting_extra[_CGROUP_IP_ACCOUNTING_METRIC_MAX]; |
281 | ||
7c52a17b ZJS |
282 | /* How to start OnFailure units */ |
283 | JobMode on_failure_job_mode; | |
284 | ||
5afe510c LP |
285 | /* Tweaking the GC logic */ |
286 | CollectMode collect_mode; | |
287 | ||
4b58153d LP |
288 | /* The current invocation ID */ |
289 | sd_id128_t invocation_id; | |
290 | char invocation_id_string[SD_ID128_STRING_MAX]; /* useful when logging */ | |
291 | ||
9d58f1db LP |
292 | /* Garbage collect us we nobody wants or requires us anymore */ |
293 | bool stop_when_unneeded; | |
294 | ||
35b8ca3a | 295 | /* Create default dependencies */ |
a40eb732 LP |
296 | bool default_dependencies; |
297 | ||
b5e9dba8 LP |
298 | /* Refuse manual starting, allow starting only indirectly via dependency. */ |
299 | bool refuse_manual_start; | |
300 | ||
301 | /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */ | |
302 | bool refuse_manual_stop; | |
303 | ||
2528a7a6 LP |
304 | /* Allow isolation requests */ |
305 | bool allow_isolate; | |
306 | ||
c8f4d764 LP |
307 | /* Ignore this unit when isolating */ |
308 | bool ignore_on_isolate; | |
309 | ||
49f43d5f | 310 | /* Did the last condition check succeed? */ |
90bbc946 | 311 | bool condition_result; |
59fccdc5 | 312 | bool assert_result; |
90bbc946 | 313 | |
c2756a68 LP |
314 | /* Is this a transient unit? */ |
315 | bool transient; | |
316 | ||
f5869324 LP |
317 | /* Is this a unit that is always running and cannot be stopped? */ |
318 | bool perpetual; | |
319 | ||
9d58f1db LP |
320 | bool in_load_queue:1; |
321 | bool in_dbus_queue:1; | |
322 | bool in_cleanup_queue:1; | |
701cc384 | 323 | bool in_gc_queue:1; |
91a6073e | 324 | bool in_cgroup_realize_queue:1; |
09e24654 | 325 | bool in_cgroup_empty_queue:1; |
19496554 | 326 | bool in_target_deps_queue:1; |
701cc384 | 327 | |
9d58f1db | 328 | bool sent_dbus_new_signal:1; |
6c073082 | 329 | |
cd6d0a45 | 330 | bool in_audit:1; |
adefcf28 | 331 | bool on_console:1; |
a57f7e2c LP |
332 | |
333 | bool cgroup_realized:1; | |
bc432dc7 LP |
334 | bool cgroup_members_mask_valid:1; |
335 | bool cgroup_subtree_mask_valid:1; | |
f78f265f | 336 | |
906c06f6 DM |
337 | UnitCGroupBPFState cgroup_bpf_state:2; |
338 | ||
3c7416b6 LP |
339 | /* Reset cgroup accounting next time we fork something off */ |
340 | bool reset_accounting:1; | |
341 | ||
6bf0f408 LP |
342 | bool start_limit_hit:1; |
343 | ||
f78f265f | 344 | /* Did we already invoke unit_coldplug() for this unit? */ |
f8a30ce5 | 345 | bool coldplugged:1; |
05a98afd LP |
346 | |
347 | /* For transient units: whether to add a bus track reference after creating the unit */ | |
348 | bool bus_track_add:1; | |
d3070fbd LP |
349 | |
350 | /* Remember which unit state files we created */ | |
351 | bool exported_invocation_id:1; | |
352 | bool exported_log_level_max:1; | |
353 | bool exported_log_extra_fields:1; | |
2e59b241 LP |
354 | |
355 | /* When writing transient unit files, stores which section we stored last. If < 0, we didn't write any yet. If | |
356 | * == 0 we are in the [Unit] section, if > 0 we are in the unit type-specific section. */ | |
357 | int last_section_private:2; | |
57b7a260 | 358 | } Unit; |
87f0e418 | 359 | |
57b7a260 | 360 | typedef struct UnitStatusMessageFormats { |
c6918296 MS |
361 | const char *starting_stopping[2]; |
362 | const char *finished_start_job[_JOB_RESULT_MAX]; | |
363 | const char *finished_stop_job[_JOB_RESULT_MAX]; | |
57b7a260 | 364 | } UnitStatusMessageFormats; |
c6918296 | 365 | |
2e59b241 LP |
366 | /* Flags used when writing drop-in files or transient unit files */ |
367 | typedef enum UnitWriteFlags { | |
368 | /* Write a runtime unit file or drop-in (i.e. one below /run) */ | |
369 | UNIT_RUNTIME = 1 << 0, | |
370 | ||
371 | /* Write a persistent drop-in (i.e. one below /etc) */ | |
372 | UNIT_PERSISTENT = 1 << 1, | |
373 | ||
374 | /* Place this item in the per-unit-type private section, instead of [Unit] */ | |
375 | UNIT_PRIVATE = 1 << 2, | |
376 | ||
377 | /* Apply specifier escaping before writing */ | |
378 | UNIT_ESCAPE_SPECIFIERS = 1 << 3, | |
379 | ||
380 | /* Apply C escaping before writing */ | |
381 | UNIT_ESCAPE_C = 1 << 4, | |
382 | } UnitWriteFlags; | |
383 | ||
384 | /* Returns true if neither persistent, nor runtime storage is requested, i.e. this is a check invocation only */ | |
385 | #define UNIT_WRITE_FLAGS_NOOP(flags) (((flags) & (UNIT_RUNTIME|UNIT_PERSISTENT)) == 0) | |
8e2af478 | 386 | |
57b7a260 FS |
387 | #include "kill.h" |
388 | ||
389 | typedef struct UnitVTable { | |
7d17cfbc MS |
390 | /* How much memory does an object of this unit type need */ |
391 | size_t object_size; | |
392 | ||
3ef63c31 LP |
393 | /* If greater than 0, the offset into the object where |
394 | * ExecContext is found, if the unit type has that */ | |
395 | size_t exec_context_offset; | |
396 | ||
4ad49000 LP |
397 | /* If greater than 0, the offset into the object where |
398 | * CGroupContext is found, if the unit type has that */ | |
399 | size_t cgroup_context_offset; | |
400 | ||
718db961 LP |
401 | /* If greater than 0, the offset into the object where |
402 | * KillContext is found, if the unit type has that */ | |
403 | size_t kill_context_offset; | |
404 | ||
613b411c LP |
405 | /* If greater than 0, the offset into the object where the |
406 | * pointer to ExecRuntime is found, if the unit type has | |
407 | * that */ | |
408 | size_t exec_runtime_offset; | |
409 | ||
29206d46 LP |
410 | /* If greater than 0, the offset into the object where the pointer to DynamicCreds is found, if the unit type |
411 | * has that. */ | |
412 | size_t dynamic_creds_offset; | |
413 | ||
ee33e53a | 414 | /* The name of the configuration file section with the private settings of this unit */ |
4ad49000 | 415 | const char *private_section; |
71645aca | 416 | |
f975e971 LP |
417 | /* Config file sections this unit type understands, separated |
418 | * by NUL chars */ | |
419 | const char *sections; | |
420 | ||
e537352b | 421 | /* This should reset all type-specific variables. This should |
a16e1123 LP |
422 | * not allocate memory, and is called with zero-initialized |
423 | * data. It should hence only initialize variables that need | |
424 | * to be set != 0. */ | |
e537352b LP |
425 | void (*init)(Unit *u); |
426 | ||
a16e1123 LP |
427 | /* This should free all type-specific variables. It should be |
428 | * idempotent. */ | |
429 | void (*done)(Unit *u); | |
430 | ||
e537352b LP |
431 | /* Actually load data from disk. This may fail, and should set |
432 | * load_state to UNIT_LOADED, UNIT_MERGED or leave it at | |
433 | * UNIT_STUB if no configuration could be found. */ | |
434 | int (*load)(Unit *u); | |
435 | ||
c5315881 | 436 | /* If a lot of units got created via enumerate(), this is |
be847e82 LP |
437 | * where to actually set the state and call unit_notify(). */ |
438 | int (*coldplug)(Unit *u); | |
87f0e418 LP |
439 | |
440 | void (*dump)(Unit *u, FILE *f, const char *prefix); | |
441 | ||
442 | int (*start)(Unit *u); | |
443 | int (*stop)(Unit *u); | |
444 | int (*reload)(Unit *u); | |
445 | ||
718db961 | 446 | int (*kill)(Unit *u, KillWho w, int signo, sd_bus_error *error); |
8a0867d6 | 447 | |
87f0e418 LP |
448 | bool (*can_reload)(Unit *u); |
449 | ||
a16e1123 LP |
450 | /* Write all data that cannot be restored from other sources |
451 | * away using unit_serialize_item() */ | |
452 | int (*serialize)(Unit *u, FILE *f, FDSet *fds); | |
453 | ||
454 | /* Restore one item from the serialization */ | |
455 | int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds); | |
456 | ||
01e10de3 | 457 | /* Try to match up fds with what we need for this unit */ |
9ff1a6f1 | 458 | void (*distribute_fds)(Unit *u, FDSet *fds); |
01e10de3 | 459 | |
87f0e418 LP |
460 | /* Boils down the more complex internal state of this unit to |
461 | * a simpler one that the engine can understand */ | |
462 | UnitActiveState (*active_state)(Unit *u); | |
463 | ||
10a94420 LP |
464 | /* Returns the substate specific to this unit type as |
465 | * string. This is purely information so that we can give the | |
35b8ca3a | 466 | * user a more fine grained explanation in which actual state a |
10a94420 LP |
467 | * unit is in. */ |
468 | const char* (*sub_state_to_string)(Unit *u); | |
469 | ||
deb4e708 MK |
470 | /* Additionally to UnitActiveState determine whether unit is to be restarted. */ |
471 | bool (*will_restart)(Unit *u); | |
472 | ||
f2f725e5 ZJS |
473 | /* Return false when there is a reason to prevent this unit from being gc'ed |
474 | * even though nothing references it and it isn't active in any way. */ | |
475 | bool (*may_gc)(Unit *u); | |
701cc384 | 476 | |
7eb2a8a1 LP |
477 | /* When the unit is not running and no job for it queued we shall release its runtime resources */ |
478 | void (*release_resources)(Unit *u); | |
a354329f | 479 | |
718db961 | 480 | /* Invoked on every child that died */ |
87f0e418 | 481 | void (*sigchld_event)(Unit *u, pid_t pid, int code, int status); |
7824bbeb | 482 | |
fdf20a31 MM |
483 | /* Reset failed state if we are in failed state */ |
484 | void (*reset_failed)(Unit *u); | |
5632e374 | 485 | |
05e343b7 LP |
486 | /* Called whenever any of the cgroups this unit watches for |
487 | * ran empty */ | |
4ad49000 | 488 | void (*notify_cgroup_empty)(Unit *u); |
8e274523 | 489 | |
8c47c732 | 490 | /* Called whenever a process of this unit sends us a message */ |
db256aab | 491 | void (*notify_message)(Unit *u, const struct ucred *ucred, char **tags, FDSet *fds); |
8c47c732 | 492 | |
00d9ef85 | 493 | /* Called whenever a name this Unit registered for comes or goes away. */ |
05e343b7 LP |
494 | void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner); |
495 | ||
8e2af478 | 496 | /* Called for each property that is being set */ |
2e59b241 | 497 | int (*bus_set_property)(Unit *u, const char *name, sd_bus_message *message, UnitWriteFlags flags, sd_bus_error *error); |
8e2af478 LP |
498 | |
499 | /* Called after at least one property got changed to apply the necessary change */ | |
500 | int (*bus_commit_properties)(Unit *u); | |
501 | ||
a7f241db LP |
502 | /* Return the unit this unit is following */ |
503 | Unit *(*following)(Unit *u); | |
504 | ||
6210e7fc LP |
505 | /* Return the set of units that are following each other */ |
506 | int (*following_set)(Unit *u, Set **s); | |
507 | ||
3ecaa09b LP |
508 | /* Invoked each time a unit this unit is triggering changes |
509 | * state or gains/loses a job */ | |
510 | void (*trigger_notify)(Unit *u, Unit *trigger); | |
511 | ||
8742514c LP |
512 | /* Called whenever CLOCK_REALTIME made a jump */ |
513 | void (*time_change)(Unit *u); | |
514 | ||
7a7821c8 LP |
515 | /* Returns the next timeout of a unit */ |
516 | int (*get_timeout)(Unit *u, usec_t *timeout); | |
68db7a3b | 517 | |
291d565a LP |
518 | /* Returns the main PID if there is any defined, or 0. */ |
519 | pid_t (*main_pid)(Unit *u); | |
520 | ||
521 | /* Returns the main PID if there is any defined, or 0. */ | |
522 | pid_t (*control_pid)(Unit *u); | |
523 | ||
bb2c7685 LP |
524 | /* Returns true if the unit currently needs access to the console */ |
525 | bool (*needs_console)(Unit *u); | |
526 | ||
f50e0a01 LP |
527 | /* This is called for each unit type and should be used to |
528 | * enumerate existing devices and load them. However, | |
529 | * everything that is loaded here should still stay in | |
530 | * inactive state. It is the job of the coldplug() call above | |
531 | * to put the units into the initial state. */ | |
ba64af90 | 532 | void (*enumerate)(Manager *m); |
f50e0a01 LP |
533 | |
534 | /* Type specific cleanups. */ | |
7824bbeb | 535 | void (*shutdown)(Manager *m); |
9d58f1db | 536 | |
0faacd47 LP |
537 | /* If this function is set and return false all jobs for units |
538 | * of this type will immediately fail. */ | |
1c2e9646 | 539 | bool (*supported)(void); |
0faacd47 | 540 | |
718db961 LP |
541 | /* The bus vtable */ |
542 | const sd_bus_vtable *bus_vtable; | |
543 | ||
718db961 | 544 | /* The strings to print in status messages */ |
c6918296 MS |
545 | UnitStatusMessageFormats status_message_formats; |
546 | ||
c2756a68 LP |
547 | /* True if transient units of this type are OK */ |
548 | bool can_transient:1; | |
c5a97ed1 | 549 | |
1d9cc876 LP |
550 | /* True if cgroup delegation is permissible */ |
551 | bool can_delegate:1; | |
552 | ||
d4fd1cf2 LP |
553 | /* True if units of this type shall be startable only once and then never again */ |
554 | bool once_only:1; | |
555 | ||
c5a97ed1 LP |
556 | /* True if queued jobs of this type should be GC'ed if no other job needs them anymore */ |
557 | bool gc_jobs:1; | |
57b7a260 | 558 | } UnitVTable; |
87f0e418 LP |
559 | |
560 | extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX]; | |
561 | ||
ac155bb8 | 562 | #define UNIT_VTABLE(u) unit_vtable[(u)->type] |
87f0e418 LP |
563 | |
564 | /* For casting a unit into the various unit types */ | |
565 | #define DEFINE_CAST(UPPERCASE, MixedCase) \ | |
566 | static inline MixedCase* UPPERCASE(Unit *u) { \ | |
ac155bb8 | 567 | if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \ |
87f0e418 LP |
568 | return NULL; \ |
569 | \ | |
570 | return (MixedCase*) u; \ | |
571 | } | |
572 | ||
573 | /* For casting the various unit types into a unit */ | |
ac155bb8 | 574 | #define UNIT(u) (&(u)->meta) |
87f0e418 | 575 | |
35b7ff80 LP |
576 | #define UNIT_HAS_EXEC_CONTEXT(u) (UNIT_VTABLE(u)->exec_context_offset > 0) |
577 | #define UNIT_HAS_CGROUP_CONTEXT(u) (UNIT_VTABLE(u)->cgroup_context_offset > 0) | |
578 | #define UNIT_HAS_KILL_CONTEXT(u) (UNIT_VTABLE(u)->kill_context_offset > 0) | |
579 | ||
eef85c4a | 580 | #define UNIT_TRIGGER(u) ((Unit*) hashmap_first_key((u)->dependencies[UNIT_TRIGGERS])) |
3ecaa09b | 581 | |
7d17cfbc | 582 | Unit *unit_new(Manager *m, size_t size); |
87f0e418 | 583 | void unit_free(Unit *u); |
dc409696 | 584 | DEFINE_TRIVIAL_CLEANUP_FUNC(Unit *, unit_free); |
87f0e418 | 585 | |
a581e45a | 586 | int unit_new_for_name(Manager *m, size_t size, const char *name, Unit **ret); |
87f0e418 | 587 | int unit_add_name(Unit *u, const char *name); |
9e2f7c11 | 588 | |
eef85c4a LP |
589 | int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference, UnitDependencyMask mask); |
590 | int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference, UnitDependencyMask mask); | |
2c966c03 | 591 | |
eef85c4a LP |
592 | int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference, UnitDependencyMask mask); |
593 | int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference, UnitDependencyMask mask); | |
2c966c03 | 594 | |
23a177ef LP |
595 | int unit_add_exec_dependencies(Unit *u, ExecContext *c); |
596 | ||
0ae97ec1 | 597 | int unit_choose_id(Unit *u, const char *name); |
f50e0a01 | 598 | int unit_set_description(Unit *u, const char *description); |
87f0e418 | 599 | |
f2f725e5 | 600 | bool unit_may_gc(Unit *u); |
701cc384 | 601 | |
87f0e418 | 602 | void unit_add_to_load_queue(Unit *u); |
c1e1601e | 603 | void unit_add_to_dbus_queue(Unit *u); |
23a177ef | 604 | void unit_add_to_cleanup_queue(Unit *u); |
701cc384 | 605 | void unit_add_to_gc_queue(Unit *u); |
19496554 | 606 | void unit_add_to_target_deps_queue(Unit *u); |
87f0e418 LP |
607 | |
608 | int unit_merge(Unit *u, Unit *other); | |
23a177ef LP |
609 | int unit_merge_by_name(Unit *u, const char *other); |
610 | ||
44a6b1b6 | 611 | Unit *unit_follow_merge(Unit *u) _pure_; |
87f0e418 | 612 | |
e537352b LP |
613 | int unit_load_fragment_and_dropin(Unit *u); |
614 | int unit_load_fragment_and_dropin_optional(Unit *u); | |
87f0e418 LP |
615 | int unit_load(Unit *unit); |
616 | ||
d79200e2 LP |
617 | int unit_set_slice(Unit *u, Unit *slice); |
618 | int unit_set_default_slice(Unit *u); | |
a016b922 | 619 | |
44a6b1b6 | 620 | const char *unit_description(Unit *u) _pure_; |
87f0e418 | 621 | |
f278026d LP |
622 | bool unit_has_name(Unit *u, const char *name); |
623 | ||
87f0e418 LP |
624 | UnitActiveState unit_active_state(Unit *u); |
625 | ||
10a94420 LP |
626 | const char* unit_sub_state_to_string(Unit *u); |
627 | ||
87f0e418 LP |
628 | void unit_dump(Unit *u, FILE *f, const char *prefix); |
629 | ||
44a6b1b6 ZJS |
630 | bool unit_can_reload(Unit *u) _pure_; |
631 | bool unit_can_start(Unit *u) _pure_; | |
f5869324 | 632 | bool unit_can_stop(Unit *u) _pure_; |
44a6b1b6 | 633 | bool unit_can_isolate(Unit *u) _pure_; |
87f0e418 LP |
634 | |
635 | int unit_start(Unit *u); | |
636 | int unit_stop(Unit *u); | |
637 | int unit_reload(Unit *u); | |
638 | ||
718db961 LP |
639 | int unit_kill(Unit *u, KillWho w, int signo, sd_bus_error *error); |
640 | int unit_kill_common(Unit *u, KillWho who, int signo, pid_t main_pid, pid_t control_pid, sd_bus_error *error); | |
8a0867d6 | 641 | |
2ad2e41a LP |
642 | typedef enum UnitNotifyFlags { |
643 | UNIT_NOTIFY_RELOAD_FAILURE = 1U << 0, | |
644 | UNIT_NOTIFY_WILL_AUTO_RESTART = 1U << 1, | |
645 | } UnitNotifyFlags; | |
646 | ||
647 | void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, UnitNotifyFlags flags); | |
87f0e418 | 648 | |
87f0e418 LP |
649 | int unit_watch_pid(Unit *u, pid_t pid); |
650 | void unit_unwatch_pid(Unit *u, pid_t pid); | |
a911bb9a LP |
651 | void unit_unwatch_all_pids(Unit *u); |
652 | ||
653 | void unit_tidy_watch_pids(Unit *u, pid_t except1, pid_t except2); | |
87f0e418 | 654 | |
9806e87d | 655 | int unit_install_bus_match(Unit *u, sd_bus *bus, const char *name); |
05e343b7 LP |
656 | int unit_watch_bus_name(Unit *u, const char *name); |
657 | void unit_unwatch_bus_name(Unit *u, const char *name); | |
658 | ||
87f0e418 LP |
659 | bool unit_job_is_applicable(Unit *u, JobType j); |
660 | ||
0301abf4 LP |
661 | int set_unit_path(const char *p); |
662 | ||
50159e6a | 663 | char *unit_dbus_path(Unit *u); |
4b58153d | 664 | char *unit_dbus_path_invocation_id(Unit *u); |
50159e6a | 665 | |
f6ff8c29 LP |
666 | int unit_load_related_unit(Unit *u, const char *type, Unit **_found); |
667 | ||
44a6b1b6 | 668 | bool unit_can_serialize(Unit *u) _pure_; |
a34ceba6 | 669 | |
6b78f9b4 | 670 | int unit_serialize(Unit *u, FILE *f, FDSet *fds, bool serialize_jobs); |
a16e1123 | 671 | int unit_deserialize(Unit *u, FILE *f, FDSet *fds); |
07429866 | 672 | void unit_deserialize_skip(FILE *f); |
a16e1123 | 673 | |
a34ceba6 LP |
674 | int unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value); |
675 | int unit_serialize_item_escaped(Unit *u, FILE *f, const char *key, const char *value); | |
676 | int unit_serialize_item_fd(Unit *u, FILE *f, FDSet *fds, const char *key, int fd); | |
677 | void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_(4,5); | |
678 | ||
eef85c4a | 679 | int unit_add_node_dependency(Unit *u, const char *what, bool wants, UnitDependency d, UnitDependencyMask mask); |
6e2ef85b | 680 | |
be847e82 | 681 | int unit_coldplug(Unit *u); |
cca098b0 | 682 | |
44b601bc | 683 | void unit_status_printf(Unit *u, const char *status, const char *unit_status_msg_format) _printf_(3, 0); |
d1a34ae9 | 684 | void unit_status_emit_starting_stopping_reloading(Unit *u, JobType t); |
9e58ff9c | 685 | |
45fb0699 LP |
686 | bool unit_need_daemon_reload(Unit *u); |
687 | ||
fdf20a31 | 688 | void unit_reset_failed(Unit *u); |
5632e374 | 689 | |
a7f241db | 690 | Unit *unit_following(Unit *u); |
eeaedb7c | 691 | int unit_following_set(Unit *u, Set **s); |
a7f241db | 692 | |
9444b1f2 LP |
693 | const char *unit_slice_name(Unit *u); |
694 | ||
44a6b1b6 ZJS |
695 | bool unit_stop_pending(Unit *u) _pure_; |
696 | bool unit_inactive_or_pending(Unit *u) _pure_; | |
31afa0a4 | 697 | bool unit_active_or_pending(Unit *u); |
deb4e708 | 698 | bool unit_will_restart(Unit *u); |
18ffdfda | 699 | |
bba34eed LP |
700 | int unit_add_default_target_dependency(Unit *u, Unit *target); |
701 | ||
3ecaa09b LP |
702 | void unit_start_on_failure(Unit *u); |
703 | void unit_trigger_notify(Unit *u); | |
c0daa706 | 704 | |
a4375746 | 705 | UnitFileState unit_get_unit_file_state(Unit *u); |
d2dc52db | 706 | int unit_get_unit_file_preset(Unit *u); |
a4375746 | 707 | |
7f7d01ed | 708 | Unit* unit_ref_set(UnitRef *ref, Unit *source, Unit *target); |
57020a3a LP |
709 | void unit_ref_unset(UnitRef *ref); |
710 | ||
7f7d01ed ZJS |
711 | #define UNIT_DEREF(ref) ((ref).target) |
712 | #define UNIT_ISSET(ref) (!!(ref).target) | |
57020a3a | 713 | |
598459ce | 714 | int unit_patch_contexts(Unit *u); |
e06c73cc | 715 | |
44a6b1b6 | 716 | ExecContext *unit_get_exec_context(Unit *u) _pure_; |
718db961 | 717 | KillContext *unit_get_kill_context(Unit *u) _pure_; |
4ad49000 | 718 | CGroupContext *unit_get_cgroup_context(Unit *u) _pure_; |
598459ce | 719 | |
613b411c LP |
720 | ExecRuntime *unit_get_exec_runtime(Unit *u) _pure_; |
721 | ||
722 | int unit_setup_exec_runtime(Unit *u); | |
29206d46 | 723 | int unit_setup_dynamic_creds(Unit *u); |
3ef63c31 | 724 | |
2e59b241 LP |
725 | char* unit_escape_setting(const char *s, UnitWriteFlags flags, char **buf); |
726 | char* unit_concat_strv(char **l, UnitWriteFlags flags); | |
b9ec9359 | 727 | |
2e59b241 LP |
728 | int unit_write_setting(Unit *u, UnitWriteFlags flags, const char *name, const char *data); |
729 | int unit_write_settingf(Unit *u, UnitWriteFlags mode, const char *name, const char *format, ...) _printf_(4,5); | |
b9ec9359 | 730 | |
db2cb23b | 731 | int unit_kill_context(Unit *u, KillContext *c, KillOperation k, pid_t main_pid, pid_t control_pid, bool main_pid_alien); |
cd2086fe | 732 | |
c2756a68 LP |
733 | int unit_make_transient(Unit *u); |
734 | ||
eef85c4a | 735 | int unit_require_mounts_for(Unit *u, const char *path, UnitDependencyMask mask); |
a57f7e2c | 736 | |
1c2e9646 LP |
737 | bool unit_type_supported(UnitType t); |
738 | ||
0f13f3bd LP |
739 | bool unit_is_pristine(Unit *u); |
740 | ||
291d565a LP |
741 | pid_t unit_control_pid(Unit *u); |
742 | pid_t unit_main_pid(Unit *u); | |
743 | ||
1c2e9646 LP |
744 | static inline bool unit_supported(Unit *u) { |
745 | return unit_type_supported(u->type); | |
746 | } | |
747 | ||
8b4305c7 | 748 | void unit_warn_if_dir_nonempty(Unit *u, const char* where); |
25cd4964 | 749 | int unit_fail_if_noncanonical(Unit *u, const char* where); |
8b4305c7 | 750 | |
07299350 LP |
751 | int unit_start_limit_test(Unit *u); |
752 | ||
00d9ef85 LP |
753 | void unit_unref_uid(Unit *u, bool destroy_now); |
754 | int unit_ref_uid(Unit *u, uid_t uid, bool clean_ipc); | |
755 | ||
756 | void unit_unref_gid(Unit *u, bool destroy_now); | |
757 | int unit_ref_gid(Unit *u, gid_t gid, bool clean_ipc); | |
758 | ||
759 | int unit_ref_uid_gid(Unit *u, uid_t uid, gid_t gid); | |
760 | void unit_unref_uid_gid(Unit *u, bool destroy_now); | |
761 | ||
762 | void unit_notify_user_lookup(Unit *u, uid_t uid, gid_t gid); | |
763 | ||
4b58153d LP |
764 | int unit_set_invocation_id(Unit *u, sd_id128_t id); |
765 | int unit_acquire_invocation_id(Unit *u); | |
766 | ||
c891efaf FB |
767 | bool unit_shall_confirm_spawn(Unit *u); |
768 | ||
f0d47797 LP |
769 | void unit_set_exec_params(Unit *s, ExecParameters *p); |
770 | ||
4c253ed1 | 771 | int unit_fork_helper_process(Unit *u, const char *name, pid_t *ret); |
a79279c7 | 772 | |
c999cf38 LP |
773 | void unit_remove_dependencies(Unit *u, UnitDependencyMask mask); |
774 | ||
d3070fbd LP |
775 | void unit_export_state_files(Unit *u); |
776 | void unit_unlink_state_files(Unit *u); | |
777 | ||
3c7416b6 LP |
778 | int unit_prepare_exec(Unit *u); |
779 | ||
a4634b21 LP |
780 | void unit_warn_leftover_processes(Unit *u); |
781 | ||
bb2c7685 LP |
782 | bool unit_needs_console(Unit *u); |
783 | ||
81e9871e LP |
784 | const char *unit_label_path(Unit *u); |
785 | ||
6592b975 LP |
786 | int unit_pid_attachable(Unit *unit, pid_t pid, sd_bus_error *error); |
787 | ||
e8e581bf ZJS |
788 | /* Macros which append UNIT= or USER_UNIT= to the message */ |
789 | ||
f2341e0a LP |
790 | #define log_unit_full(unit, level, error, ...) \ |
791 | ({ \ | |
8dec4a9d | 792 | const Unit *_u = (unit); \ |
4b58153d | 793 | _u ? log_object_internal(level, error, __FILE__, __LINE__, __func__, _u->manager->unit_log_field, _u->id, _u->manager->invocation_log_field, _u->invocation_id_string, ##__VA_ARGS__) : \ |
f2341e0a LP |
794 | log_internal(level, error, __FILE__, __LINE__, __func__, ##__VA_ARGS__); \ |
795 | }) | |
796 | ||
797 | #define log_unit_debug(unit, ...) log_unit_full(unit, LOG_DEBUG, 0, ##__VA_ARGS__) | |
798 | #define log_unit_info(unit, ...) log_unit_full(unit, LOG_INFO, 0, ##__VA_ARGS__) | |
799 | #define log_unit_notice(unit, ...) log_unit_full(unit, LOG_NOTICE, 0, ##__VA_ARGS__) | |
800 | #define log_unit_warning(unit, ...) log_unit_full(unit, LOG_WARNING, 0, ##__VA_ARGS__) | |
801 | #define log_unit_error(unit, ...) log_unit_full(unit, LOG_ERR, 0, ##__VA_ARGS__) | |
802 | ||
803 | #define log_unit_debug_errno(unit, error, ...) log_unit_full(unit, LOG_DEBUG, error, ##__VA_ARGS__) | |
804 | #define log_unit_info_errno(unit, error, ...) log_unit_full(unit, LOG_INFO, error, ##__VA_ARGS__) | |
805 | #define log_unit_notice_errno(unit, error, ...) log_unit_full(unit, LOG_NOTICE, error, ##__VA_ARGS__) | |
806 | #define log_unit_warning_errno(unit, error, ...) log_unit_full(unit, LOG_WARNING, error, ##__VA_ARGS__) | |
807 | #define log_unit_error_errno(unit, error, ...) log_unit_full(unit, LOG_ERR, error, ##__VA_ARGS__) | |
808 | ||
809 | #define LOG_UNIT_MESSAGE(unit, fmt, ...) "MESSAGE=%s: " fmt, (unit)->id, ##__VA_ARGS__ | |
810 | #define LOG_UNIT_ID(unit) (unit)->manager->unit_log_format_string, (unit)->id | |
f1c50bec | 811 | #define LOG_UNIT_INVOCATION_ID(unit) (unit)->manager->invocation_log_format_string, (unit)->invocation_id_string |
5afe510c LP |
812 | |
813 | const char* collect_mode_to_string(CollectMode m) _const_; | |
814 | CollectMode collect_mode_from_string(const char *s) _pure_; |