]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/core/unit.h
Merge pull request #27424 from dtardon/auto-cleanup
[thirdparty/systemd.git] / src / core / unit.h
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2 #pragma once
3
4 #include <stdbool.h>
5 #include <stdlib.h>
6 #include <sys/socket.h>
7 #include <unistd.h>
8
9 #include "sd-id128.h"
10
11 #include "bpf-program.h"
12 #include "condition.h"
13 #include "emergency-action.h"
14 #include "install.h"
15 #include "list.h"
16 #include "show-status.h"
17 #include "set.h"
18 #include "unit-file.h"
19 #include "cgroup.h"
20
21 typedef struct UnitRef UnitRef;
22
23 typedef enum KillOperation {
24 KILL_TERMINATE,
25 KILL_TERMINATE_AND_LOG,
26 KILL_RESTART,
27 KILL_KILL,
28 KILL_WATCHDOG,
29 _KILL_OPERATION_MAX,
30 _KILL_OPERATION_INVALID = -EINVAL,
31 } KillOperation;
32
33 typedef enum CollectMode {
34 COLLECT_INACTIVE,
35 COLLECT_INACTIVE_OR_FAILED,
36 _COLLECT_MODE_MAX,
37 _COLLECT_MODE_INVALID = -EINVAL,
38 } CollectMode;
39
40 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) {
41 return IN_SET(t, UNIT_ACTIVE, UNIT_RELOADING);
42 }
43
44 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) {
45 return IN_SET(t, UNIT_ACTIVE, UNIT_ACTIVATING, UNIT_RELOADING);
46 }
47
48 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) {
49 return IN_SET(t, UNIT_INACTIVE, UNIT_FAILED, UNIT_DEACTIVATING);
50 }
51
52 static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t) {
53 return IN_SET(t, UNIT_INACTIVE, UNIT_FAILED);
54 }
55
56 static inline bool UNIT_IS_LOAD_COMPLETE(UnitLoadState t) {
57 return t >= 0 && t < _UNIT_LOAD_STATE_MAX && t != UNIT_STUB && t != UNIT_MERGED;
58 }
59
60 /* Stores the 'reason' a dependency was created as a bit mask, i.e. due to which configuration source it came to be. We
61 * use this so that we can selectively flush out parts of dependencies again. Note that the same dependency might be
62 * created as a result of multiple "reasons", hence the bitmask. */
63 typedef enum UnitDependencyMask {
64 /* Configured directly by the unit file, .wants/.requires symlink or drop-in, or as an immediate result of a
65 * non-dependency option configured that way. */
66 UNIT_DEPENDENCY_FILE = 1 << 0,
67
68 /* As unconditional implicit dependency (not affected by unit configuration — except by the unit name and
69 * type) */
70 UNIT_DEPENDENCY_IMPLICIT = 1 << 1,
71
72 /* A dependency effected by DefaultDependencies=yes. Note that dependencies marked this way are conceptually
73 * just a subset of UNIT_DEPENDENCY_FILE, as DefaultDependencies= is itself a unit file setting that can only
74 * be set in unit files. We make this two separate bits only to help debugging how dependencies came to be. */
75 UNIT_DEPENDENCY_DEFAULT = 1 << 2,
76
77 /* A dependency created from udev rules */
78 UNIT_DEPENDENCY_UDEV = 1 << 3,
79
80 /* A dependency created because of some unit's RequiresMountsFor= setting */
81 UNIT_DEPENDENCY_PATH = 1 << 4,
82
83 /* A dependency initially configured from the mount unit file however the dependency will be updated
84 * from /proc/self/mountinfo as soon as the kernel will make the entry for that mount available in
85 * the /proc file */
86 UNIT_DEPENDENCY_MOUNT_FILE = 1 << 5,
87
88 /* A dependency created or updated because of data read from /proc/self/mountinfo */
89 UNIT_DEPENDENCY_MOUNTINFO = 1 << 6,
90
91 /* A dependency created because of data read from /proc/swaps and no other configuration source */
92 UNIT_DEPENDENCY_PROC_SWAP = 1 << 7,
93
94 /* A dependency for units in slices assigned by directly setting Slice= */
95 UNIT_DEPENDENCY_SLICE_PROPERTY = 1 << 8,
96
97 _UNIT_DEPENDENCY_MASK_FULL = (1 << 9) - 1,
98 } UnitDependencyMask;
99
100 /* The Unit's dependencies[] hashmaps use this structure as value. It has the same size as a void pointer, and thus can
101 * be stored directly as hashmap value, without any indirection. Note that this stores two masks, as both the origin
102 * and the destination of a dependency might have created it. */
103 typedef union UnitDependencyInfo {
104 void *data;
105 struct {
106 UnitDependencyMask origin_mask:16;
107 UnitDependencyMask destination_mask:16;
108 } _packed_;
109 } UnitDependencyInfo;
110
111 /* Store information about why a unit was activated.
112 * We start with trigger units (.path/.timer), eventually it will be expanded to include more metadata. */
113 typedef struct ActivationDetails {
114 unsigned n_ref;
115 UnitType trigger_unit_type;
116 char *trigger_unit_name;
117 } ActivationDetails;
118
119 /* For casting an activation event into the various unit-specific types */
120 #define DEFINE_ACTIVATION_DETAILS_CAST(UPPERCASE, MixedCase, UNIT_TYPE) \
121 static inline MixedCase* UPPERCASE(ActivationDetails *a) { \
122 if (_unlikely_(!a || a->trigger_unit_type != UNIT_##UNIT_TYPE)) \
123 return NULL; \
124 \
125 return (MixedCase*) a; \
126 }
127
128 /* For casting the various unit types into a unit */
129 #define ACTIVATION_DETAILS(u) \
130 ({ \
131 typeof(u) _u_ = (u); \
132 ActivationDetails *_w_ = _u_ ? &(_u_)->meta : NULL; \
133 _w_; \
134 })
135
136 ActivationDetails *activation_details_new(Unit *trigger_unit);
137 ActivationDetails *activation_details_ref(ActivationDetails *p);
138 ActivationDetails *activation_details_unref(ActivationDetails *p);
139 void activation_details_serialize(ActivationDetails *p, FILE *f);
140 int activation_details_deserialize(const char *key, const char *value, ActivationDetails **info);
141 int activation_details_append_env(ActivationDetails *info, char ***strv);
142 int activation_details_append_pair(ActivationDetails *info, char ***strv);
143 DEFINE_TRIVIAL_CLEANUP_FUNC(ActivationDetails*, activation_details_unref);
144
145 typedef struct ActivationDetailsVTable {
146 /* How much memory does an object of this activation type need */
147 size_t object_size;
148
149 /* This should reset all type-specific variables. This should not allocate memory, and is called
150 * with zero-initialized data. It should hence only initialize variables that need to be set != 0. */
151 void (*init)(ActivationDetails *info, Unit *trigger_unit);
152
153 /* This should free all type-specific variables. It should be idempotent. */
154 void (*done)(ActivationDetails *info);
155
156 /* This should serialize all type-specific variables. */
157 void (*serialize)(ActivationDetails *info, FILE *f);
158
159 /* This should deserialize all type-specific variables, one at a time. */
160 int (*deserialize)(const char *key, const char *value, ActivationDetails **info);
161
162 /* This should format the type-specific variables for the env block of the spawned service,
163 * and return the number of added items. */
164 int (*append_env)(ActivationDetails *info, char ***strv);
165
166 /* This should append type-specific variables as key/value pairs for the D-Bus property of the job,
167 * and return the number of added pairs. */
168 int (*append_pair)(ActivationDetails *info, char ***strv);
169 } ActivationDetailsVTable;
170
171 extern const ActivationDetailsVTable * const activation_details_vtable[_UNIT_TYPE_MAX];
172
173 static inline const ActivationDetailsVTable* ACTIVATION_DETAILS_VTABLE(const ActivationDetails *a) {
174 assert(a);
175 assert(a->trigger_unit_type < _UNIT_TYPE_MAX);
176
177 return activation_details_vtable[a->trigger_unit_type];
178 }
179
180 /* Newer LLVM versions don't like implicit casts from large pointer types to smaller enums, hence let's add
181 * explicit type-safe helpers for that. */
182 static inline UnitDependency UNIT_DEPENDENCY_FROM_PTR(const void *p) {
183 return PTR_TO_INT(p);
184 }
185
186 static inline void* UNIT_DEPENDENCY_TO_PTR(UnitDependency d) {
187 return INT_TO_PTR(d);
188 }
189
190 #include "job.h"
191
192 struct UnitRef {
193 /* Keeps tracks of references to a unit. This is useful so
194 * that we can merge two units if necessary and correct all
195 * references to them */
196
197 Unit *source, *target;
198 LIST_FIELDS(UnitRef, refs_by_target);
199 };
200
201 typedef struct Unit {
202 Manager *manager;
203
204 UnitType type;
205 UnitLoadState load_state;
206 Unit *merged_into;
207
208 char *id; /* The one special name that we use for identification */
209 char *instance;
210
211 Set *aliases; /* All the other names. */
212
213 /* For each dependency type we can look up another Hashmap with this, whose key is a Unit* object,
214 * and whose value encodes why the dependency exists, using the UnitDependencyInfo type. i.e. a
215 * Hashmap(UnitDependency → Hashmap(Unit* → UnitDependencyInfo)) */
216 Hashmap *dependencies;
217
218 /* Similar, for RequiresMountsFor= path dependencies. The key is the path, the value the
219 * UnitDependencyInfo type */
220 Hashmap *requires_mounts_for;
221
222 char *description;
223 char **documentation;
224
225 /* The SELinux context used for checking access to this unit read off the unit file at load time (do
226 * not confuse with the selinux_context field in ExecContext which is the SELinux context we'll set
227 * for processes) */
228 char *access_selinux_context;
229
230 char *fragment_path; /* if loaded from a config file this is the primary path to it */
231 char *source_path; /* if converted, the source file */
232 char **dropin_paths;
233
234 usec_t fragment_not_found_timestamp_hash;
235 usec_t fragment_mtime;
236 usec_t source_mtime;
237 usec_t dropin_mtime;
238
239 /* If this is a transient unit we are currently writing, this is where we are writing it to */
240 FILE *transient_file;
241
242 /* Freezer state */
243 sd_bus_message *pending_freezer_invocation;
244 FreezerState freezer_state;
245
246 /* Job timeout and action to take */
247 EmergencyAction job_timeout_action;
248 usec_t job_timeout;
249 usec_t job_running_timeout;
250 char *job_timeout_reboot_arg;
251
252 /* If there is something to do with this unit, then this is the installed job for it */
253 Job *job;
254
255 /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
256 Job *nop_job;
257
258 /* The slot used for watching NameOwnerChanged signals */
259 sd_bus_slot *match_bus_slot;
260 sd_bus_slot *get_name_owner_slot;
261
262 /* References to this unit from clients */
263 sd_bus_track *bus_track;
264 char **deserialized_refs;
265
266 /* References to this */
267 LIST_HEAD(UnitRef, refs_by_target);
268
269 /* Conditions to check */
270 LIST_HEAD(Condition, conditions);
271 LIST_HEAD(Condition, asserts);
272
273 dual_timestamp condition_timestamp;
274 dual_timestamp assert_timestamp;
275
276 /* Updated whenever the low-level state changes */
277 dual_timestamp state_change_timestamp;
278
279 /* Updated whenever the (high-level) active state enters or leaves the active or inactive states */
280 dual_timestamp inactive_exit_timestamp;
281 dual_timestamp active_enter_timestamp;
282 dual_timestamp active_exit_timestamp;
283 dual_timestamp inactive_enter_timestamp;
284
285 /* Per type list */
286 LIST_FIELDS(Unit, units_by_type);
287
288 /* Load queue */
289 LIST_FIELDS(Unit, load_queue);
290
291 /* D-Bus queue */
292 LIST_FIELDS(Unit, dbus_queue);
293
294 /* Cleanup queue */
295 LIST_FIELDS(Unit, cleanup_queue);
296
297 /* GC queue */
298 LIST_FIELDS(Unit, gc_queue);
299
300 /* CGroup realize members queue */
301 LIST_FIELDS(Unit, cgroup_realize_queue);
302
303 /* cgroup empty queue */
304 LIST_FIELDS(Unit, cgroup_empty_queue);
305
306 /* cgroup OOM queue */
307 LIST_FIELDS(Unit, cgroup_oom_queue);
308
309 /* Target dependencies queue */
310 LIST_FIELDS(Unit, target_deps_queue);
311
312 /* Queue of units with StopWhenUnneeded= set that shall be checked for clean-up. */
313 LIST_FIELDS(Unit, stop_when_unneeded_queue);
314
315 /* Queue of units that have an Uphold= dependency from some other unit, and should be checked for starting */
316 LIST_FIELDS(Unit, start_when_upheld_queue);
317
318 /* Queue of units that have a BindTo= dependency on some other unit, and should possibly be shut down */
319 LIST_FIELDS(Unit, stop_when_bound_queue);
320
321 /* Queue of units that should be checked if they can release resources now */
322 LIST_FIELDS(Unit, release_resources_queue);
323
324 /* PIDs we keep an eye on. Note that a unit might have many
325 * more, but these are the ones we care enough about to
326 * process SIGCHLD for */
327 Set *pids;
328
329 /* Used in SIGCHLD and sd_notify() message event invocation logic to avoid that we dispatch the same event
330 * multiple times on the same unit. */
331 unsigned sigchldgen;
332 unsigned notifygen;
333
334 /* Used during GC sweeps */
335 unsigned gc_marker;
336
337 /* Error code when we didn't manage to load the unit (negative) */
338 int load_error;
339
340 /* Put a ratelimit on unit starting */
341 RateLimit start_ratelimit;
342 EmergencyAction start_limit_action;
343
344 /* The unit has been marked for reload, restart, etc. Stored as 1u << marker1 | 1u << marker2. */
345 unsigned markers;
346
347 /* What to do on failure or success */
348 EmergencyAction success_action, failure_action;
349 int success_action_exit_status, failure_action_exit_status;
350 char *reboot_arg;
351
352 /* Make sure we never enter endless loops with the StopWhenUnneeded=, BindsTo=, Uphold= logic */
353 RateLimit auto_start_stop_ratelimit;
354 sd_event_source *auto_start_stop_event_source;
355
356 /* Reference to a specific UID/GID */
357 uid_t ref_uid;
358 gid_t ref_gid;
359
360 /* Cached unit file state and preset */
361 UnitFileState unit_file_state;
362 PresetAction unit_file_preset;
363
364 /* Where the cpu.stat or cpuacct.usage was at the time the unit was started */
365 nsec_t cpu_usage_base;
366 nsec_t cpu_usage_last; /* the most recently read value */
367
368 /* The current counter of OOM kills initiated by systemd-oomd */
369 uint64_t managed_oom_kill_last;
370
371 /* The current counter of the oom_kill field in the memory.events cgroup attribute */
372 uint64_t oom_kill_last;
373
374 /* Where the io.stat data was at the time the unit was started */
375 uint64_t io_accounting_base[_CGROUP_IO_ACCOUNTING_METRIC_MAX];
376 uint64_t io_accounting_last[_CGROUP_IO_ACCOUNTING_METRIC_MAX]; /* the most recently read value */
377
378 /* Counterparts in the cgroup filesystem */
379 char *cgroup_path;
380 uint64_t cgroup_id;
381 CGroupMask cgroup_realized_mask; /* In which hierarchies does this unit's cgroup exist? (only relevant on cgroup v1) */
382 CGroupMask cgroup_enabled_mask; /* Which controllers are enabled (or more correctly: enabled for the children) for this unit's cgroup? (only relevant on cgroup v2) */
383 CGroupMask cgroup_invalidated_mask; /* A mask specifying controllers which shall be considered invalidated, and require re-realization */
384 CGroupMask cgroup_members_mask; /* A cache for the controllers required by all children of this cgroup (only relevant for slice units) */
385
386 /* Inotify watch descriptors for watching cgroup.events and memory.events on cgroupv2 */
387 int cgroup_control_inotify_wd;
388 int cgroup_memory_inotify_wd;
389
390 /* Device Controller BPF program */
391 BPFProgram *bpf_device_control_installed;
392
393 /* IP BPF Firewalling/accounting */
394 int ip_accounting_ingress_map_fd;
395 int ip_accounting_egress_map_fd;
396 uint64_t ip_accounting_extra[_CGROUP_IP_ACCOUNTING_METRIC_MAX];
397
398 int ipv4_allow_map_fd;
399 int ipv6_allow_map_fd;
400 int ipv4_deny_map_fd;
401 int ipv6_deny_map_fd;
402 BPFProgram *ip_bpf_ingress, *ip_bpf_ingress_installed;
403 BPFProgram *ip_bpf_egress, *ip_bpf_egress_installed;
404
405 Set *ip_bpf_custom_ingress;
406 Set *ip_bpf_custom_ingress_installed;
407 Set *ip_bpf_custom_egress;
408 Set *ip_bpf_custom_egress_installed;
409
410 /* BPF programs managed (e.g. loaded to kernel) by an entity external to systemd,
411 * attached to unit cgroup by provided program fd and attach type. */
412 Hashmap *bpf_foreign_by_key;
413
414 FDSet *initial_socket_bind_link_fds;
415 #if BPF_FRAMEWORK
416 /* BPF links to BPF programs attached to cgroup/bind{4|6} hooks and
417 * responsible for allowing or denying a unit to bind(2) to a socket
418 * address. */
419 struct bpf_link *ipv4_socket_bind_link;
420 struct bpf_link *ipv6_socket_bind_link;
421 #endif
422
423 FDSet *initial_restric_ifaces_link_fds;
424 #if BPF_FRAMEWORK
425 struct bpf_link *restrict_ifaces_ingress_bpf_link;
426 struct bpf_link *restrict_ifaces_egress_bpf_link;
427 #endif
428
429 /* Low-priority event source which is used to remove watched PIDs that have gone away, and subscribe to any new
430 * ones which might have appeared. */
431 sd_event_source *rewatch_pids_event_source;
432
433 /* How to start OnSuccess=/OnFailure= units */
434 JobMode on_success_job_mode;
435 JobMode on_failure_job_mode;
436
437 /* If the job had a specific trigger that needs to be advertised (eg: a path unit), store it. */
438 ActivationDetails *activation_details;
439
440 /* Tweaking the GC logic */
441 CollectMode collect_mode;
442
443 /* The current invocation ID */
444 sd_id128_t invocation_id;
445 char invocation_id_string[SD_ID128_STRING_MAX]; /* useful when logging */
446
447 /* Garbage collect us we nobody wants or requires us anymore */
448 bool stop_when_unneeded;
449
450 /* Create default dependencies */
451 bool default_dependencies;
452
453 /* Refuse manual starting, allow starting only indirectly via dependency. */
454 bool refuse_manual_start;
455
456 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
457 bool refuse_manual_stop;
458
459 /* Allow isolation requests */
460 bool allow_isolate;
461
462 /* Ignore this unit when isolating */
463 bool ignore_on_isolate;
464
465 /* Did the last condition check succeed? */
466 bool condition_result;
467 bool assert_result;
468
469 /* Is this a transient unit? */
470 bool transient;
471
472 /* Is this a unit that is always running and cannot be stopped? */
473 bool perpetual;
474
475 /* Booleans indicating membership of this unit in the various queues */
476 bool in_load_queue:1;
477 bool in_dbus_queue:1;
478 bool in_cleanup_queue:1;
479 bool in_gc_queue:1;
480 bool in_cgroup_realize_queue:1;
481 bool in_cgroup_empty_queue:1;
482 bool in_cgroup_oom_queue:1;
483 bool in_target_deps_queue:1;
484 bool in_stop_when_unneeded_queue:1;
485 bool in_start_when_upheld_queue:1;
486 bool in_stop_when_bound_queue:1;
487 bool in_release_resources_queue:1;
488
489 bool sent_dbus_new_signal:1;
490
491 bool job_running_timeout_set:1;
492
493 bool in_audit:1;
494 bool on_console:1;
495
496 bool cgroup_realized:1;
497 bool cgroup_members_mask_valid:1;
498
499 /* Reset cgroup accounting next time we fork something off */
500 bool reset_accounting:1;
501
502 bool start_limit_hit:1;
503
504 /* Did we already invoke unit_coldplug() for this unit? */
505 bool coldplugged:1;
506
507 /* For transient units: whether to add a bus track reference after creating the unit */
508 bool bus_track_add:1;
509
510 /* Remember which unit state files we created */
511 bool exported_invocation_id:1;
512 bool exported_log_level_max:1;
513 bool exported_log_extra_fields:1;
514 bool exported_log_ratelimit_interval:1;
515 bool exported_log_ratelimit_burst:1;
516
517 /* Whether we warned about clamping the CPU quota period */
518 bool warned_clamping_cpu_quota_period:1;
519
520 /* When writing transient unit files, stores which section we stored last. If < 0, we didn't write any yet. If
521 * == 0 we are in the [Unit] section, if > 0 we are in the unit type-specific section. */
522 signed int last_section_private:2;
523 } Unit;
524
525 typedef struct UnitStatusMessageFormats {
526 const char *starting_stopping[2];
527 const char *finished_start_job[_JOB_RESULT_MAX];
528 const char *finished_stop_job[_JOB_RESULT_MAX];
529 /* If this entry is present, it'll be called to provide a context-dependent format string,
530 * or NULL to fall back to finished_{start,stop}_job; if those are NULL too, fall back to generic. */
531 const char *(*finished_job)(Unit *u, JobType t, JobResult result);
532 } UnitStatusMessageFormats;
533
534 /* Flags used when writing drop-in files or transient unit files */
535 typedef enum UnitWriteFlags {
536 /* Write a runtime unit file or drop-in (i.e. one below /run) */
537 UNIT_RUNTIME = 1 << 0,
538
539 /* Write a persistent drop-in (i.e. one below /etc) */
540 UNIT_PERSISTENT = 1 << 1,
541
542 /* Place this item in the per-unit-type private section, instead of [Unit] */
543 UNIT_PRIVATE = 1 << 2,
544
545 /* Apply specifier escaping */
546 UNIT_ESCAPE_SPECIFIERS = 1 << 3,
547
548 /* Escape elements of ExecStart= syntax, incl. prevention of variable expansion */
549 UNIT_ESCAPE_EXEC_SYNTAX_ENV = 1 << 4,
550
551 /* Escape elements of ExecStart=: syntax (no variable expansion) */
552 UNIT_ESCAPE_EXEC_SYNTAX = 1 << 5,
553
554 /* Apply C escaping before writing */
555 UNIT_ESCAPE_C = 1 << 6,
556 } UnitWriteFlags;
557
558 /* Returns true if neither persistent, nor runtime storage is requested, i.e. this is a check invocation only */
559 static inline bool UNIT_WRITE_FLAGS_NOOP(UnitWriteFlags flags) {
560 return (flags & (UNIT_RUNTIME|UNIT_PERSISTENT)) == 0;
561 }
562
563 #include "kill.h"
564
565 typedef struct UnitVTable {
566 /* How much memory does an object of this unit type need */
567 size_t object_size;
568
569 /* If greater than 0, the offset into the object where
570 * ExecContext is found, if the unit type has that */
571 size_t exec_context_offset;
572
573 /* If greater than 0, the offset into the object where
574 * CGroupContext is found, if the unit type has that */
575 size_t cgroup_context_offset;
576
577 /* If greater than 0, the offset into the object where
578 * KillContext is found, if the unit type has that */
579 size_t kill_context_offset;
580
581 /* If greater than 0, the offset into the object where the
582 * pointer to ExecSharedRuntime is found, if the unit type has
583 * that */
584 size_t exec_runtime_offset;
585
586 /* The name of the configuration file section with the private settings of this unit */
587 const char *private_section;
588
589 /* Config file sections this unit type understands, separated
590 * by NUL chars */
591 const char *sections;
592
593 /* This should reset all type-specific variables. This should
594 * not allocate memory, and is called with zero-initialized
595 * data. It should hence only initialize variables that need
596 * to be set != 0. */
597 void (*init)(Unit *u);
598
599 /* This should free all type-specific variables. It should be
600 * idempotent. */
601 void (*done)(Unit *u);
602
603 /* Actually load data from disk. This may fail, and should set
604 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
605 * UNIT_STUB if no configuration could be found. */
606 int (*load)(Unit *u);
607
608 /* During deserialization we only record the intended state to return to. With coldplug() we actually put the
609 * deserialized state in effect. This is where unit_notify() should be called to start things up. Note that
610 * this callback is invoked *before* we leave the reloading state of the manager, i.e. *before* we consider the
611 * reloading to be complete. Thus, this callback should just restore the exact same state for any unit that was
612 * in effect before the reload, i.e. units should not catch up with changes happened during the reload. That's
613 * what catchup() below is for. */
614 int (*coldplug)(Unit *u);
615
616 /* This is called shortly after all units' coldplug() call was invoked, and *after* the manager left the
617 * reloading state. It's supposed to catch up with state changes due to external events we missed so far (for
618 * example because they took place while we were reloading/reexecing) */
619 void (*catchup)(Unit *u);
620
621 void (*dump)(Unit *u, FILE *f, const char *prefix);
622
623 int (*start)(Unit *u);
624 int (*stop)(Unit *u);
625 int (*reload)(Unit *u);
626
627 int (*kill)(Unit *u, KillWho w, int signo, int code, int value, sd_bus_error *error);
628
629 /* Clear out the various runtime/state/cache/logs/configuration data */
630 int (*clean)(Unit *u, ExecCleanMask m);
631
632 /* Freeze the unit */
633 int (*freeze)(Unit *u);
634 int (*thaw)(Unit *u);
635 bool (*can_freeze)(Unit *u);
636
637 /* Return which kind of data can be cleaned */
638 int (*can_clean)(Unit *u, ExecCleanMask *ret);
639
640 bool (*can_reload)(Unit *u);
641
642 /* Serialize state and file descriptors that should be carried over into the new
643 * instance after reexecution. */
644 int (*serialize)(Unit *u, FILE *f, FDSet *fds);
645
646 /* Restore one item from the serialization */
647 int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
648
649 /* Try to match up fds with what we need for this unit */
650 void (*distribute_fds)(Unit *u, FDSet *fds);
651
652 /* Boils down the more complex internal state of this unit to
653 * a simpler one that the engine can understand */
654 UnitActiveState (*active_state)(Unit *u);
655
656 /* Returns the substate specific to this unit type as
657 * string. This is purely information so that we can give the
658 * user a more fine grained explanation in which actual state a
659 * unit is in. */
660 const char* (*sub_state_to_string)(Unit *u);
661
662 /* Additionally to UnitActiveState determine whether unit is to be restarted. */
663 bool (*will_restart)(Unit *u);
664
665 /* Return false when there is a reason to prevent this unit from being gc'ed
666 * even though nothing references it and it isn't active in any way. */
667 bool (*may_gc)(Unit *u);
668
669 /* Return true when the unit is not controlled by the manager (e.g. extrinsic mounts). */
670 bool (*is_extrinsic)(Unit *u);
671
672 /* When the unit is not running and no job for it queued we shall release its runtime resources */
673 void (*release_resources)(Unit *u);
674
675 /* Invoked on every child that died */
676 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
677
678 /* Reset failed state if we are in failed state */
679 void (*reset_failed)(Unit *u);
680
681 /* Called whenever any of the cgroups this unit watches for ran empty */
682 void (*notify_cgroup_empty)(Unit *u);
683
684 /* Called whenever an OOM kill event on this unit was seen */
685 void (*notify_cgroup_oom)(Unit *u, bool managed_oom);
686
687 /* Called whenever a process of this unit sends us a message */
688 void (*notify_message)(Unit *u, const struct ucred *ucred, char * const *tags, FDSet *fds);
689
690 /* Called whenever a name this Unit registered for comes or goes away. */
691 void (*bus_name_owner_change)(Unit *u, const char *new_owner);
692
693 /* Called for each property that is being set */
694 int (*bus_set_property)(Unit *u, const char *name, sd_bus_message *message, UnitWriteFlags flags, sd_bus_error *error);
695
696 /* Called after at least one property got changed to apply the necessary change */
697 int (*bus_commit_properties)(Unit *u);
698
699 /* Return the unit this unit is following */
700 Unit *(*following)(Unit *u);
701
702 /* Return the set of units that are following each other */
703 int (*following_set)(Unit *u, Set **s);
704
705 /* Invoked each time a unit this unit is triggering changes
706 * state or gains/loses a job */
707 void (*trigger_notify)(Unit *u, Unit *trigger);
708
709 /* Called whenever CLOCK_REALTIME made a jump */
710 void (*time_change)(Unit *u);
711
712 /* Called whenever /etc/localtime was modified */
713 void (*timezone_change)(Unit *u);
714
715 /* Returns the next timeout of a unit */
716 int (*get_timeout)(Unit *u, usec_t *timeout);
717
718 /* Returns the main PID if there is any defined, or 0. */
719 pid_t (*main_pid)(Unit *u);
720
721 /* Returns the main PID if there is any defined, or 0. */
722 pid_t (*control_pid)(Unit *u);
723
724 /* Returns true if the unit currently needs access to the console */
725 bool (*needs_console)(Unit *u);
726
727 /* Returns the exit status to propagate in case of FailureAction=exit/SuccessAction=exit; usually returns the
728 * exit code of the "main" process of the service or similar. */
729 int (*exit_status)(Unit *u);
730
731 /* Return a copy of the status string pointer. */
732 const char* (*status_text)(Unit *u);
733
734 /* Like the enumerate() callback further down, but only enumerates the perpetual units, i.e. all units that
735 * unconditionally exist and are always active. The main reason to keep both enumeration functions separate is
736 * philosophical: the state of perpetual units should be put in place by coldplug(), while the state of those
737 * discovered through regular enumeration should be put in place by catchup(), see below. */
738 void (*enumerate_perpetual)(Manager *m);
739
740 /* This is called for each unit type and should be used to enumerate units already existing in the system
741 * internally and load them. However, everything that is loaded here should still stay in inactive state. It is
742 * the job of the catchup() call above to put the units into the discovered state. */
743 void (*enumerate)(Manager *m);
744
745 /* Type specific cleanups. */
746 void (*shutdown)(Manager *m);
747
748 /* If this function is set and returns false all jobs for units
749 * of this type will immediately fail. */
750 bool (*supported)(void);
751
752 /* If this function is set, it's invoked first as part of starting a unit to allow start rate
753 * limiting checks to occur before we do anything else. */
754 int (*can_start)(Unit *u);
755
756 /* The strings to print in status messages */
757 UnitStatusMessageFormats status_message_formats;
758
759 /* True if transient units of this type are OK */
760 bool can_transient;
761
762 /* True if cgroup delegation is permissible */
763 bool can_delegate;
764
765 /* True if the unit type triggers other units, i.e. can have a UNIT_TRIGGERS dependency */
766 bool can_trigger;
767
768 /* True if the unit type knows a failure state, and thus can be source of an OnFailure= dependency */
769 bool can_fail;
770
771 /* True if units of this type shall be startable only once and then never again */
772 bool once_only;
773
774 /* Do not serialize this unit when preparing for root switch */
775 bool exclude_from_switch_root_serialization;
776
777 /* True if queued jobs of this type should be GC'ed if no other job needs them anymore */
778 bool gc_jobs;
779
780 /* True if systemd-oomd can monitor and act on this unit's recursive children's cgroups */
781 bool can_set_managed_oom;
782 } UnitVTable;
783
784 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
785
786 static inline const UnitVTable* UNIT_VTABLE(const Unit *u) {
787 return unit_vtable[u->type];
788 }
789
790 /* For casting a unit into the various unit types */
791 #define DEFINE_CAST(UPPERCASE, MixedCase) \
792 static inline MixedCase* UPPERCASE(Unit *u) { \
793 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
794 return NULL; \
795 \
796 return (MixedCase*) u; \
797 }
798
799 /* For casting the various unit types into a unit */
800 #define UNIT(u) \
801 ({ \
802 typeof(u) _u_ = (u); \
803 Unit *_w_ = _u_ ? &(_u_)->meta : NULL; \
804 _w_; \
805 })
806
807 #define UNIT_HAS_EXEC_CONTEXT(u) (UNIT_VTABLE(u)->exec_context_offset > 0)
808 #define UNIT_HAS_CGROUP_CONTEXT(u) (UNIT_VTABLE(u)->cgroup_context_offset > 0)
809 #define UNIT_HAS_KILL_CONTEXT(u) (UNIT_VTABLE(u)->kill_context_offset > 0)
810
811 Unit* unit_has_dependency(const Unit *u, UnitDependencyAtom atom, Unit *other);
812 int unit_get_dependency_array(const Unit *u, UnitDependencyAtom atom, Unit ***ret_array);
813
814 static inline Hashmap* unit_get_dependencies(Unit *u, UnitDependency d) {
815 return hashmap_get(u->dependencies, UNIT_DEPENDENCY_TO_PTR(d));
816 }
817
818 static inline Unit* UNIT_TRIGGER(Unit *u) {
819 return unit_has_dependency(u, UNIT_ATOM_TRIGGERS, NULL);
820 }
821
822 static inline Unit* UNIT_GET_SLICE(const Unit *u) {
823 return unit_has_dependency(u, UNIT_ATOM_IN_SLICE, NULL);
824 }
825
826 Unit* unit_new(Manager *m, size_t size);
827 Unit* unit_free(Unit *u);
828 DEFINE_TRIVIAL_CLEANUP_FUNC(Unit *, unit_free);
829
830 int unit_new_for_name(Manager *m, size_t size, const char *name, Unit **ret);
831 int unit_add_name(Unit *u, const char *name);
832
833 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference, UnitDependencyMask mask);
834 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference, UnitDependencyMask mask);
835
836 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, bool add_reference, UnitDependencyMask mask);
837 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, bool add_reference, UnitDependencyMask mask);
838
839 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
840
841 int unit_choose_id(Unit *u, const char *name);
842 int unit_set_description(Unit *u, const char *description);
843
844 void unit_release_resources(Unit *u);
845
846 bool unit_may_gc(Unit *u);
847
848 static inline bool unit_is_extrinsic(Unit *u) {
849 return u->perpetual ||
850 (UNIT_VTABLE(u)->is_extrinsic && UNIT_VTABLE(u)->is_extrinsic(u));
851 }
852
853 static inline const char* unit_status_text(Unit *u) {
854 if (u && UNIT_VTABLE(u)->status_text)
855 return UNIT_VTABLE(u)->status_text(u);
856 return NULL;
857 }
858
859 void unit_add_to_load_queue(Unit *u);
860 void unit_add_to_dbus_queue(Unit *u);
861 void unit_add_to_cleanup_queue(Unit *u);
862 void unit_add_to_gc_queue(Unit *u);
863 void unit_add_to_target_deps_queue(Unit *u);
864 void unit_submit_to_stop_when_unneeded_queue(Unit *u);
865 void unit_submit_to_start_when_upheld_queue(Unit *u);
866 void unit_submit_to_stop_when_bound_queue(Unit *u);
867 void unit_submit_to_release_resources_queue(Unit *u);
868
869 int unit_merge(Unit *u, Unit *other);
870 int unit_merge_by_name(Unit *u, const char *other);
871
872 Unit *unit_follow_merge(Unit *u) _pure_;
873
874 int unit_load_fragment_and_dropin(Unit *u, bool fragment_required);
875 int unit_load(Unit *unit);
876
877 int unit_set_slice(Unit *u, Unit *slice);
878 int unit_set_default_slice(Unit *u);
879
880 const char *unit_description(Unit *u) _pure_;
881 const char *unit_status_string(Unit *u, char **combined);
882
883 bool unit_has_name(const Unit *u, const char *name);
884
885 UnitActiveState unit_active_state(Unit *u);
886 FreezerState unit_freezer_state(Unit *u);
887 int unit_freezer_state_kernel(Unit *u, FreezerState *ret);
888
889 const char* unit_sub_state_to_string(Unit *u);
890
891 bool unit_can_reload(Unit *u) _pure_;
892 bool unit_can_start(Unit *u) _pure_;
893 bool unit_can_stop(Unit *u) _pure_;
894 bool unit_can_isolate(Unit *u) _pure_;
895
896 int unit_start(Unit *u, ActivationDetails *details);
897 int unit_stop(Unit *u);
898 int unit_reload(Unit *u);
899
900 int unit_kill(Unit *u, KillWho w, int signo, int code, int value, sd_bus_error *error);
901 int unit_kill_common(Unit *u, KillWho who, int signo, int code, int value, pid_t main_pid, pid_t control_pid, sd_bus_error *error);
902
903 void unit_notify_cgroup_oom(Unit *u, bool managed_oom);
904
905 typedef enum UnitNotifyFlags {
906 UNIT_NOTIFY_RELOAD_FAILURE = 1 << 0,
907 UNIT_NOTIFY_WILL_AUTO_RESTART = 1 << 1,
908 } UnitNotifyFlags;
909
910 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, UnitNotifyFlags flags);
911
912 int unit_watch_pid(Unit *u, pid_t pid, bool exclusive);
913 void unit_unwatch_pid(Unit *u, pid_t pid);
914 void unit_unwatch_all_pids(Unit *u);
915
916 int unit_enqueue_rewatch_pids(Unit *u);
917 void unit_dequeue_rewatch_pids(Unit *u);
918
919 int unit_install_bus_match(Unit *u, sd_bus *bus, const char *name);
920 int unit_watch_bus_name(Unit *u, const char *name);
921 void unit_unwatch_bus_name(Unit *u, const char *name);
922
923 bool unit_job_is_applicable(Unit *u, JobType j);
924
925 int set_unit_path(const char *p);
926
927 char *unit_dbus_path(Unit *u);
928 char *unit_dbus_path_invocation_id(Unit *u);
929
930 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
931
932 int unit_add_node_dependency(Unit *u, const char *what, UnitDependency d, UnitDependencyMask mask);
933 int unit_add_blockdev_dependency(Unit *u, const char *what, UnitDependencyMask mask);
934
935 int unit_coldplug(Unit *u);
936 void unit_catchup(Unit *u);
937
938 void unit_status_printf(Unit *u, StatusType status_type, const char *status, const char *format, const char *ident) _printf_(4, 0);
939
940 bool unit_need_daemon_reload(Unit *u);
941
942 void unit_reset_failed(Unit *u);
943
944 Unit *unit_following(Unit *u);
945 int unit_following_set(Unit *u, Set **s);
946
947 const char *unit_slice_name(Unit *u);
948
949 bool unit_stop_pending(Unit *u) _pure_;
950 bool unit_inactive_or_pending(Unit *u) _pure_;
951 bool unit_active_or_pending(Unit *u);
952 bool unit_will_restart_default(Unit *u);
953 bool unit_will_restart(Unit *u);
954
955 int unit_add_default_target_dependency(Unit *u, Unit *target);
956
957 void unit_start_on_failure(Unit *u, const char *dependency_name, UnitDependencyAtom atom, JobMode job_mode);
958 void unit_trigger_notify(Unit *u);
959
960 UnitFileState unit_get_unit_file_state(Unit *u);
961 PresetAction unit_get_unit_file_preset(Unit *u);
962
963 Unit* unit_ref_set(UnitRef *ref, Unit *source, Unit *target);
964 void unit_ref_unset(UnitRef *ref);
965
966 #define UNIT_DEREF(ref) ((ref).target)
967 #define UNIT_ISSET(ref) (!!(ref).target)
968
969 int unit_patch_contexts(Unit *u);
970
971 ExecContext *unit_get_exec_context(const Unit *u) _pure_;
972 KillContext *unit_get_kill_context(Unit *u) _pure_;
973 CGroupContext *unit_get_cgroup_context(Unit *u) _pure_;
974
975 ExecRuntime *unit_get_exec_runtime(Unit *u) _pure_;
976
977 int unit_setup_exec_runtime(Unit *u);
978
979 const char* unit_escape_setting(const char *s, UnitWriteFlags flags, char **buf);
980 char* unit_concat_strv(char **l, UnitWriteFlags flags);
981
982 int unit_write_setting(Unit *u, UnitWriteFlags flags, const char *name, const char *data);
983 int unit_write_settingf(Unit *u, UnitWriteFlags mode, const char *name, const char *format, ...) _printf_(4,5);
984
985 int unit_kill_context(Unit *u, KillContext *c, KillOperation k, pid_t main_pid, pid_t control_pid, bool main_pid_alien);
986
987 int unit_make_transient(Unit *u);
988
989 int unit_require_mounts_for(Unit *u, const char *path, UnitDependencyMask mask);
990
991 bool unit_type_supported(UnitType t);
992
993 bool unit_is_pristine(Unit *u);
994
995 bool unit_is_unneeded(Unit *u);
996 bool unit_is_upheld_by_active(Unit *u, Unit **ret_culprit);
997 bool unit_is_bound_by_inactive(Unit *u, Unit **ret_culprit);
998
999 pid_t unit_control_pid(Unit *u);
1000 pid_t unit_main_pid(Unit *u);
1001
1002 void unit_warn_if_dir_nonempty(Unit *u, const char* where);
1003 int unit_fail_if_noncanonical(Unit *u, const char* where);
1004
1005 int unit_test_start_limit(Unit *u);
1006
1007 int unit_ref_uid_gid(Unit *u, uid_t uid, gid_t gid);
1008 void unit_unref_uid_gid(Unit *u, bool destroy_now);
1009
1010 void unit_notify_user_lookup(Unit *u, uid_t uid, gid_t gid);
1011
1012 int unit_set_invocation_id(Unit *u, sd_id128_t id);
1013 int unit_acquire_invocation_id(Unit *u);
1014
1015 bool unit_shall_confirm_spawn(Unit *u);
1016
1017 int unit_set_exec_params(Unit *s, ExecParameters *p);
1018
1019 int unit_fork_helper_process(Unit *u, const char *name, pid_t *ret);
1020 int unit_fork_and_watch_rm_rf(Unit *u, char **paths, pid_t *ret_pid);
1021
1022 void unit_remove_dependencies(Unit *u, UnitDependencyMask mask);
1023
1024 void unit_export_state_files(Unit *u);
1025 void unit_unlink_state_files(Unit *u);
1026
1027 int unit_prepare_exec(Unit *u);
1028
1029 int unit_log_leftover_process_start(pid_t pid, int sig, void *userdata);
1030 int unit_log_leftover_process_stop(pid_t pid, int sig, void *userdata);
1031 int unit_warn_leftover_processes(Unit *u, cg_kill_log_func_t log_func);
1032
1033 bool unit_needs_console(Unit *u);
1034
1035 int unit_pid_attachable(Unit *unit, pid_t pid, sd_bus_error *error);
1036
1037 static inline bool unit_has_job_type(Unit *u, JobType type) {
1038 return u && u->job && u->job->type == type;
1039 }
1040
1041 static inline bool unit_log_level_test(const Unit *u, int level) {
1042 ExecContext *ec = unit_get_exec_context(u);
1043 return !ec || ec->log_level_max < 0 || ec->log_level_max >= LOG_PRI(level);
1044 }
1045
1046 /* unit_log_skip is for cases like ExecCondition= where a unit is considered "done"
1047 * after some execution, rather than succeeded or failed. */
1048 void unit_log_skip(Unit *u, const char *result);
1049 void unit_log_success(Unit *u);
1050 void unit_log_failure(Unit *u, const char *result);
1051 static inline void unit_log_result(Unit *u, bool success, const char *result) {
1052 if (success)
1053 unit_log_success(u);
1054 else
1055 unit_log_failure(u, result);
1056 }
1057
1058 void unit_log_process_exit(Unit *u, const char *kind, const char *command, bool success, int code, int status);
1059
1060 int unit_exit_status(Unit *u);
1061 int unit_success_action_exit_status(Unit *u);
1062 int unit_failure_action_exit_status(Unit *u);
1063
1064 int unit_test_trigger_loaded(Unit *u);
1065
1066 void unit_destroy_runtime_data(Unit *u, const ExecContext *context);
1067 int unit_clean(Unit *u, ExecCleanMask mask);
1068 int unit_can_clean(Unit *u, ExecCleanMask *ret_mask);
1069
1070 bool unit_can_freeze(Unit *u);
1071 int unit_freeze(Unit *u);
1072 void unit_frozen(Unit *u);
1073
1074 int unit_thaw(Unit *u);
1075 void unit_thawed(Unit *u);
1076
1077 int unit_freeze_vtable_common(Unit *u);
1078 int unit_thaw_vtable_common(Unit *u);
1079
1080 Condition *unit_find_failed_condition(Unit *u);
1081
1082 /* Macros which append UNIT= or USER_UNIT= to the message */
1083
1084 #define log_unit_full_errno_zerook(unit, level, error, ...) \
1085 ({ \
1086 const Unit *_u = (unit); \
1087 const int _l = (level); \
1088 bool _do_log = !(log_get_max_level() < LOG_PRI(_l) || \
1089 (_u && !unit_log_level_test(_u, _l))); \
1090 const ExecContext *_c = _do_log && _u ? \
1091 unit_get_exec_context(_u) : NULL; \
1092 LOG_CONTEXT_PUSH_IOV(_c ? _c->log_extra_fields : NULL, \
1093 _c ? _c->n_log_extra_fields : 0); \
1094 !_do_log ? -ERRNO_VALUE(error) : \
1095 _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__) : \
1096 log_internal(_l, error, PROJECT_FILE, __LINE__, __func__, ##__VA_ARGS__); \
1097 })
1098
1099 #define log_unit_full_errno(unit, level, error, ...) \
1100 ({ \
1101 int _error = (error); \
1102 ASSERT_NON_ZERO(_error); \
1103 log_unit_full_errno_zerook(unit, level, _error, ##__VA_ARGS__); \
1104 })
1105
1106 #define log_unit_full(unit, level, ...) (void) log_unit_full_errno_zerook(unit, level, 0, __VA_ARGS__)
1107
1108 #define log_unit_debug(unit, ...) log_unit_full(unit, LOG_DEBUG, __VA_ARGS__)
1109 #define log_unit_info(unit, ...) log_unit_full(unit, LOG_INFO, __VA_ARGS__)
1110 #define log_unit_notice(unit, ...) log_unit_full(unit, LOG_NOTICE, __VA_ARGS__)
1111 #define log_unit_warning(unit, ...) log_unit_full(unit, LOG_WARNING, __VA_ARGS__)
1112 #define log_unit_error(unit, ...) log_unit_full(unit, LOG_ERR, __VA_ARGS__)
1113
1114 #define log_unit_debug_errno(unit, error, ...) log_unit_full_errno(unit, LOG_DEBUG, error, __VA_ARGS__)
1115 #define log_unit_info_errno(unit, error, ...) log_unit_full_errno(unit, LOG_INFO, error, __VA_ARGS__)
1116 #define log_unit_notice_errno(unit, error, ...) log_unit_full_errno(unit, LOG_NOTICE, error, __VA_ARGS__)
1117 #define log_unit_warning_errno(unit, error, ...) log_unit_full_errno(unit, LOG_WARNING, error, __VA_ARGS__)
1118 #define log_unit_error_errno(unit, error, ...) log_unit_full_errno(unit, LOG_ERR, error, __VA_ARGS__)
1119
1120 #if LOG_TRACE
1121 # define log_unit_trace(...) log_unit_debug(__VA_ARGS__)
1122 # define log_unit_trace_errno(...) log_unit_debug_errno(__VA_ARGS__)
1123 #else
1124 # define log_unit_trace(...) do {} while (0)
1125 # define log_unit_trace_errno(e, ...) (-ERRNO_VALUE(e))
1126 #endif
1127
1128 #define log_unit_struct_errno(unit, level, error, ...) \
1129 ({ \
1130 const Unit *_u = (unit); \
1131 const int _l = (level); \
1132 bool _do_log = unit_log_level_test(_u, _l); \
1133 const ExecContext *_c = _do_log && _u ? \
1134 unit_get_exec_context(_u) : NULL; \
1135 LOG_CONTEXT_PUSH_IOV(_c ? _c->log_extra_fields : NULL, \
1136 _c ? _c->n_log_extra_fields : 0); \
1137 _do_log ? \
1138 log_struct_errno(_l, error, __VA_ARGS__, LOG_UNIT_ID(_u)) : \
1139 -ERRNO_VALUE(error); \
1140 })
1141
1142 #define log_unit_struct(unit, level, ...) log_unit_struct_errno(unit, level, 0, __VA_ARGS__)
1143
1144 #define log_unit_struct_iovec_errno(unit, level, error, iovec, n_iovec) \
1145 ({ \
1146 const Unit *_u = (unit); \
1147 const int _l = (level); \
1148 bool _do_log = unit_log_level_test(_u, _l); \
1149 const ExecContext *_c = _do_log && _u ? \
1150 unit_get_exec_context(_u) : NULL; \
1151 LOG_CONTEXT_PUSH_IOV(_c ? _c->log_extra_fields : NULL, \
1152 _c ? _c->n_log_extra_fields : 0); \
1153 _do_log ? \
1154 log_struct_iovec_errno(_l, error, iovec, n_iovec) : \
1155 -ERRNO_VALUE(error); \
1156 })
1157
1158 #define log_unit_struct_iovec(unit, level, iovec, n_iovec) log_unit_struct_iovec_errno(unit, level, 0, iovec, n_iovec)
1159
1160 /* Like LOG_MESSAGE(), but with the unit name prefixed. */
1161 #define LOG_UNIT_MESSAGE(unit, fmt, ...) LOG_MESSAGE("%s: " fmt, (unit)->id, ##__VA_ARGS__)
1162 #define LOG_UNIT_ID(unit) (unit)->manager->unit_log_format_string, (unit)->id
1163 #define LOG_UNIT_INVOCATION_ID(unit) (unit)->manager->invocation_log_format_string, (unit)->invocation_id_string
1164
1165 const char* collect_mode_to_string(CollectMode m) _const_;
1166 CollectMode collect_mode_from_string(const char *s) _pure_;
1167
1168 typedef struct UnitForEachDependencyData {
1169 /* Stores state for the FOREACH macro below for iterating through all deps that have any of the
1170 * specified dependency atom bits set */
1171 UnitDependencyAtom match_atom;
1172 Hashmap *by_type, *by_unit;
1173 void *current_type;
1174 Iterator by_type_iterator, by_unit_iterator;
1175 Unit **current_unit;
1176 } UnitForEachDependencyData;
1177
1178 /* Iterates through all dependencies that have a specific atom in the dependency type set. This tries to be
1179 * smart: if the atom is unique, we'll directly go to right entry. Otherwise we'll iterate through the
1180 * per-dependency type hashmap and match all dep that have the right atom set. */
1181 #define _UNIT_FOREACH_DEPENDENCY(other, u, ma, data) \
1182 for (UnitForEachDependencyData data = { \
1183 .match_atom = (ma), \
1184 .by_type = (u)->dependencies, \
1185 .by_type_iterator = ITERATOR_FIRST, \
1186 .current_unit = &(other), \
1187 }; \
1188 ({ \
1189 UnitDependency _dt = _UNIT_DEPENDENCY_INVALID; \
1190 bool _found; \
1191 \
1192 if (data.by_type && ITERATOR_IS_FIRST(data.by_type_iterator)) { \
1193 _dt = unit_dependency_from_unique_atom(data.match_atom); \
1194 if (_dt >= 0) { \
1195 data.by_unit = hashmap_get(data.by_type, UNIT_DEPENDENCY_TO_PTR(_dt)); \
1196 data.current_type = UNIT_DEPENDENCY_TO_PTR(_dt); \
1197 data.by_type = NULL; \
1198 _found = !!data.by_unit; \
1199 } \
1200 } \
1201 if (_dt < 0) \
1202 _found = hashmap_iterate(data.by_type, \
1203 &data.by_type_iterator, \
1204 (void**)&(data.by_unit), \
1205 (const void**) &(data.current_type)); \
1206 _found; \
1207 }); ) \
1208 if ((unit_dependency_to_atom(UNIT_DEPENDENCY_FROM_PTR(data.current_type)) & data.match_atom) != 0) \
1209 for (data.by_unit_iterator = ITERATOR_FIRST; \
1210 hashmap_iterate(data.by_unit, \
1211 &data.by_unit_iterator, \
1212 NULL, \
1213 (const void**) data.current_unit); )
1214
1215 /* Note: this matches deps that have *any* of the atoms specified in match_atom set */
1216 #define UNIT_FOREACH_DEPENDENCY(other, u, match_atom) \
1217 _UNIT_FOREACH_DEPENDENCY(other, u, match_atom, UNIQ_T(data, UNIQ))
1218
1219 #define _LOG_CONTEXT_PUSH_UNIT(unit, u, c) \
1220 const Unit *u = (unit); \
1221 const ExecContext *c = unit_get_exec_context(u); \
1222 LOG_CONTEXT_PUSH_KEY_VALUE(u->manager->unit_log_field, u->id); \
1223 LOG_CONTEXT_PUSH_KEY_VALUE(u->manager->invocation_log_field, u->invocation_id_string); \
1224 LOG_CONTEXT_PUSH_IOV(c ? c->log_extra_fields : NULL, c ? c->n_log_extra_fields : 0)
1225
1226 #define LOG_CONTEXT_PUSH_UNIT(unit) \
1227 _LOG_CONTEXT_PUSH_UNIT(unit, UNIQ_T(u, UNIQ), UNIQ_T(c, UNIQ))