1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
6 #include <sys/socket.h>
11 #include "bpf-program.h"
13 #include "condition.h"
14 #include "emergency-action.h"
19 #include "show-status.h"
20 #include "unit-file.h"
22 typedef struct UnitRef UnitRef
;
24 typedef enum KillOperation
{
26 KILL_TERMINATE_AND_LOG
,
31 _KILL_OPERATION_INVALID
= -EINVAL
,
34 typedef enum CollectMode
{
36 COLLECT_INACTIVE_OR_FAILED
,
38 _COLLECT_MODE_INVALID
= -EINVAL
,
41 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t
) {
42 return IN_SET(t
, UNIT_ACTIVE
, UNIT_RELOADING
);
45 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t
) {
46 return IN_SET(t
, UNIT_ACTIVE
, UNIT_ACTIVATING
, UNIT_RELOADING
);
49 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t
) {
50 return IN_SET(t
, UNIT_INACTIVE
, UNIT_FAILED
, UNIT_DEACTIVATING
);
53 static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t
) {
54 return IN_SET(t
, UNIT_INACTIVE
, UNIT_FAILED
);
57 static inline bool UNIT_IS_LOAD_COMPLETE(UnitLoadState t
) {
58 return t
>= 0 && t
< _UNIT_LOAD_STATE_MAX
&& t
!= UNIT_STUB
&& t
!= UNIT_MERGED
;
61 /* Stores the 'reason' a dependency was created as a bit mask, i.e. due to which configuration source it came to be. We
62 * use this so that we can selectively flush out parts of dependencies again. Note that the same dependency might be
63 * created as a result of multiple "reasons", hence the bitmask. */
64 typedef enum UnitDependencyMask
{
65 /* Configured directly by the unit file, .wants/.requires symlink or drop-in, or as an immediate result of a
66 * non-dependency option configured that way. */
67 UNIT_DEPENDENCY_FILE
= 1 << 0,
69 /* As unconditional implicit dependency (not affected by unit configuration — except by the unit name and
71 UNIT_DEPENDENCY_IMPLICIT
= 1 << 1,
73 /* A dependency effected by DefaultDependencies=yes. Note that dependencies marked this way are conceptually
74 * just a subset of UNIT_DEPENDENCY_FILE, as DefaultDependencies= is itself a unit file setting that can only
75 * be set in unit files. We make this two separate bits only to help debugging how dependencies came to be. */
76 UNIT_DEPENDENCY_DEFAULT
= 1 << 2,
78 /* A dependency created from udev rules */
79 UNIT_DEPENDENCY_UDEV
= 1 << 3,
81 /* A dependency created because of some unit's RequiresMountsFor= setting */
82 UNIT_DEPENDENCY_PATH
= 1 << 4,
84 /* A dependency initially configured from the mount unit file however the dependency will be updated
85 * from /proc/self/mountinfo as soon as the kernel will make the entry for that mount available in
87 UNIT_DEPENDENCY_MOUNT_FILE
= 1 << 5,
89 /* A dependency created or updated because of data read from /proc/self/mountinfo */
90 UNIT_DEPENDENCY_MOUNTINFO
= 1 << 6,
92 /* A dependency created because of data read from /proc/swaps and no other configuration source */
93 UNIT_DEPENDENCY_PROC_SWAP
= 1 << 7,
95 /* A dependency for units in slices assigned by directly setting Slice= */
96 UNIT_DEPENDENCY_SLICE_PROPERTY
= 1 << 8,
98 _UNIT_DEPENDENCY_MASK_FULL
= (1 << 9) - 1,
101 /* The Unit's dependencies[] hashmaps use this structure as value. It has the same size as a void pointer, and thus can
102 * be stored directly as hashmap value, without any indirection. Note that this stores two masks, as both the origin
103 * and the destination of a dependency might have created it. */
104 typedef union UnitDependencyInfo
{
107 UnitDependencyMask origin_mask
:16;
108 UnitDependencyMask destination_mask
:16;
110 } UnitDependencyInfo
;
112 /* Store information about why a unit was activated.
113 * We start with trigger units (.path/.timer), eventually it will be expanded to include more metadata. */
114 typedef struct ActivationDetails
{
116 UnitType trigger_unit_type
;
117 char *trigger_unit_name
;
120 /* For casting an activation event into the various unit-specific types */
121 #define DEFINE_ACTIVATION_DETAILS_CAST(UPPERCASE, MixedCase, UNIT_TYPE) \
122 static inline MixedCase* UPPERCASE(ActivationDetails *a) { \
123 if (_unlikely_(!a || a->trigger_unit_type != UNIT_##UNIT_TYPE)) \
126 return (MixedCase*) a; \
129 /* For casting the various unit types into a unit */
130 #define ACTIVATION_DETAILS(u) \
132 typeof(u) _u_ = (u); \
133 ActivationDetails *_w_ = _u_ ? &(_u_)->meta : NULL; \
137 ActivationDetails
*activation_details_new(Unit
*trigger_unit
);
138 ActivationDetails
*activation_details_ref(ActivationDetails
*p
);
139 ActivationDetails
*activation_details_unref(ActivationDetails
*p
);
140 void activation_details_serialize(ActivationDetails
*p
, FILE *f
);
141 int activation_details_deserialize(const char *key
, const char *value
, ActivationDetails
**info
);
142 int activation_details_append_env(ActivationDetails
*info
, char ***strv
);
143 int activation_details_append_pair(ActivationDetails
*info
, char ***strv
);
144 DEFINE_TRIVIAL_CLEANUP_FUNC(ActivationDetails
*, activation_details_unref
);
146 typedef struct ActivationDetailsVTable
{
147 /* How much memory does an object of this activation type need */
150 /* This should reset all type-specific variables. This should not allocate memory, and is called
151 * with zero-initialized data. It should hence only initialize variables that need to be set != 0. */
152 void (*init
)(ActivationDetails
*info
, Unit
*trigger_unit
);
154 /* This should free all type-specific variables. It should be idempotent. */
155 void (*done
)(ActivationDetails
*info
);
157 /* This should serialize all type-specific variables. */
158 void (*serialize
)(ActivationDetails
*info
, FILE *f
);
160 /* This should deserialize all type-specific variables, one at a time. */
161 int (*deserialize
)(const char *key
, const char *value
, ActivationDetails
**info
);
163 /* This should format the type-specific variables for the env block of the spawned service,
164 * and return the number of added items. */
165 int (*append_env
)(ActivationDetails
*info
, char ***strv
);
167 /* This should append type-specific variables as key/value pairs for the D-Bus property of the job,
168 * and return the number of added pairs. */
169 int (*append_pair
)(ActivationDetails
*info
, char ***strv
);
170 } ActivationDetailsVTable
;
172 extern const ActivationDetailsVTable
* const activation_details_vtable
[_UNIT_TYPE_MAX
];
174 static inline const ActivationDetailsVTable
* ACTIVATION_DETAILS_VTABLE(const ActivationDetails
*a
) {
176 assert(a
->trigger_unit_type
< _UNIT_TYPE_MAX
);
178 return activation_details_vtable
[a
->trigger_unit_type
];
181 /* Newer LLVM versions don't like implicit casts from large pointer types to smaller enums, hence let's add
182 * explicit type-safe helpers for that. */
183 static inline UnitDependency
UNIT_DEPENDENCY_FROM_PTR(const void *p
) {
184 return PTR_TO_INT(p
);
187 static inline void* UNIT_DEPENDENCY_TO_PTR(UnitDependency d
) {
188 return INT_TO_PTR(d
);
194 /* Keeps tracks of references to a unit. This is useful so
195 * that we can merge two units if necessary and correct all
196 * references to them */
198 Unit
*source
, *target
;
199 LIST_FIELDS(UnitRef
, refs_by_target
);
202 typedef struct Unit
{
206 UnitLoadState load_state
;
209 char *id
; /* The one special name that we use for identification */
212 Set
*aliases
; /* All the other names. */
214 /* For each dependency type we can look up another Hashmap with this, whose key is a Unit* object,
215 * and whose value encodes why the dependency exists, using the UnitDependencyInfo type. i.e. a
216 * Hashmap(UnitDependency → Hashmap(Unit* → UnitDependencyInfo)) */
217 Hashmap
*dependencies
;
219 /* Similar, for RequiresMountsFor= path dependencies. The key is the path, the value the
220 * UnitDependencyInfo type */
221 Hashmap
*requires_mounts_for
;
224 char **documentation
;
226 /* The SELinux context used for checking access to this unit read off the unit file at load time (do
227 * not confuse with the selinux_context field in ExecContext which is the SELinux context we'll set
229 char *access_selinux_context
;
231 char *fragment_path
; /* if loaded from a config file this is the primary path to it */
232 char *source_path
; /* if converted, the source file */
235 usec_t fragment_not_found_timestamp_hash
;
236 usec_t fragment_mtime
;
240 /* If this is a transient unit we are currently writing, this is where we are writing it to */
241 FILE *transient_file
;
244 sd_bus_message
*pending_freezer_invocation
;
245 FreezerState freezer_state
;
247 /* Job timeout and action to take */
248 EmergencyAction job_timeout_action
;
250 usec_t job_running_timeout
;
251 char *job_timeout_reboot_arg
;
253 /* If there is something to do with this unit, then this is the installed job for it */
256 /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
259 /* The slot used for watching NameOwnerChanged signals */
260 sd_bus_slot
*match_bus_slot
;
261 sd_bus_slot
*get_name_owner_slot
;
263 /* References to this unit from clients */
264 sd_bus_track
*bus_track
;
265 char **deserialized_refs
;
267 /* References to this */
268 LIST_HEAD(UnitRef
, refs_by_target
);
270 /* Conditions to check */
271 LIST_HEAD(Condition
, conditions
);
272 LIST_HEAD(Condition
, asserts
);
274 dual_timestamp condition_timestamp
;
275 dual_timestamp assert_timestamp
;
277 /* Updated whenever the low-level state changes */
278 dual_timestamp state_change_timestamp
;
280 /* Updated whenever the (high-level) active state enters or leaves the active or inactive states */
281 dual_timestamp inactive_exit_timestamp
;
282 dual_timestamp active_enter_timestamp
;
283 dual_timestamp active_exit_timestamp
;
284 dual_timestamp inactive_enter_timestamp
;
287 LIST_FIELDS(Unit
, units_by_type
);
290 LIST_FIELDS(Unit
, load_queue
);
293 LIST_FIELDS(Unit
, dbus_queue
);
296 LIST_FIELDS(Unit
, cleanup_queue
);
299 LIST_FIELDS(Unit
, gc_queue
);
301 /* CGroup realize members queue */
302 LIST_FIELDS(Unit
, cgroup_realize_queue
);
304 /* cgroup empty queue */
305 LIST_FIELDS(Unit
, cgroup_empty_queue
);
307 /* cgroup OOM queue */
308 LIST_FIELDS(Unit
, cgroup_oom_queue
);
310 /* Target dependencies queue */
311 LIST_FIELDS(Unit
, target_deps_queue
);
313 /* Queue of units with StopWhenUnneeded= set that shall be checked for clean-up. */
314 LIST_FIELDS(Unit
, stop_when_unneeded_queue
);
316 /* Queue of units that have an Uphold= dependency from some other unit, and should be checked for starting */
317 LIST_FIELDS(Unit
, start_when_upheld_queue
);
319 /* Queue of units that have a BindTo= dependency on some other unit, and should possibly be shut down */
320 LIST_FIELDS(Unit
, stop_when_bound_queue
);
322 /* Queue of units that should be checked if they can release resources now */
323 LIST_FIELDS(Unit
, release_resources_queue
);
325 /* PIDs we keep an eye on. Note that a unit might have many more, but these are the ones we care
326 * enough about to process SIGCHLD for */
327 Set
*pids
; /* → PidRef* */
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. */
334 /* Used during GC sweeps */
337 /* Error code when we didn't manage to load the unit (negative) */
340 /* Put a ratelimit on unit starting */
341 RateLimit start_ratelimit
;
342 EmergencyAction start_limit_action
;
344 /* The unit has been marked for reload, restart, etc. Stored as 1u << marker1 | 1u << marker2. */
347 /* What to do on failure or success */
348 EmergencyAction success_action
, failure_action
;
349 int success_action_exit_status
, failure_action_exit_status
;
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
;
356 /* Reference to a specific UID/GID */
360 /* Cached unit file state and preset */
361 UnitFileState unit_file_state
;
362 PresetAction unit_file_preset
;
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 */
368 /* The current counter of OOM kills initiated by systemd-oomd */
369 uint64_t managed_oom_kill_last
;
371 /* The current counter of the oom_kill field in the memory.events cgroup attribute */
372 uint64_t oom_kill_last
;
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 */
378 /* Counterparts in the cgroup filesystem */
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) */
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
;
390 /* Device Controller BPF program */
391 BPFProgram
*bpf_device_control_installed
;
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
];
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
;
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
;
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
;
414 FDSet
*initial_socket_bind_link_fds
;
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
419 struct bpf_link
*ipv4_socket_bind_link
;
420 struct bpf_link
*ipv6_socket_bind_link
;
423 FDSet
*initial_restric_ifaces_link_fds
;
425 struct bpf_link
*restrict_ifaces_ingress_bpf_link
;
426 struct bpf_link
*restrict_ifaces_egress_bpf_link
;
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
;
433 /* How to start OnSuccess=/OnFailure= units */
434 JobMode on_success_job_mode
;
435 JobMode on_failure_job_mode
;
437 /* If the job had a specific trigger that needs to be advertised (eg: a path unit), store it. */
438 ActivationDetails
*activation_details
;
440 /* Tweaking the GC logic */
441 CollectMode collect_mode
;
443 /* The current invocation ID */
444 sd_id128_t invocation_id
;
445 char invocation_id_string
[SD_ID128_STRING_MAX
]; /* useful when logging */
447 /* Garbage collect us we nobody wants or requires us anymore */
448 bool stop_when_unneeded
;
450 /* Create default dependencies */
451 bool default_dependencies
;
453 /* Configure so that the unit survives a system transition without stopping/starting. */
454 bool survive_final_kill_signal
;
456 /* Refuse manual starting, allow starting only indirectly via dependency. */
457 bool refuse_manual_start
;
459 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
460 bool refuse_manual_stop
;
462 /* Allow isolation requests */
465 /* Ignore this unit when isolating */
466 bool ignore_on_isolate
;
468 /* Did the last condition check succeed? */
469 bool condition_result
;
472 /* Is this a transient unit? */
475 /* Is this a unit that is always running and cannot be stopped? */
478 /* Booleans indicating membership of this unit in the various queues */
479 bool in_load_queue
:1;
480 bool in_dbus_queue
:1;
481 bool in_cleanup_queue
:1;
483 bool in_cgroup_realize_queue
:1;
484 bool in_cgroup_empty_queue
:1;
485 bool in_cgroup_oom_queue
:1;
486 bool in_target_deps_queue
:1;
487 bool in_stop_when_unneeded_queue
:1;
488 bool in_start_when_upheld_queue
:1;
489 bool in_stop_when_bound_queue
:1;
490 bool in_release_resources_queue
:1;
492 bool sent_dbus_new_signal
:1;
494 bool job_running_timeout_set
:1;
499 bool cgroup_realized
:1;
500 bool cgroup_members_mask_valid
:1;
502 /* Reset cgroup accounting next time we fork something off */
503 bool reset_accounting
:1;
505 bool start_limit_hit
:1;
507 /* Did we already invoke unit_coldplug() for this unit? */
510 /* For transient units: whether to add a bus track reference after creating the unit */
511 bool bus_track_add
:1;
513 /* Remember which unit state files we created */
514 bool exported_invocation_id
:1;
515 bool exported_log_level_max
:1;
516 bool exported_log_extra_fields
:1;
517 bool exported_log_ratelimit_interval
:1;
518 bool exported_log_ratelimit_burst
:1;
520 /* Whether we warned about clamping the CPU quota period */
521 bool warned_clamping_cpu_quota_period
:1;
523 /* When writing transient unit files, stores which section we stored last. If < 0, we didn't write any yet. If
524 * == 0 we are in the [Unit] section, if > 0 we are in the unit type-specific section. */
525 signed int last_section_private
:2;
528 typedef struct UnitStatusMessageFormats
{
529 const char *starting_stopping
[2];
530 const char *finished_start_job
[_JOB_RESULT_MAX
];
531 const char *finished_stop_job
[_JOB_RESULT_MAX
];
532 /* If this entry is present, it'll be called to provide a context-dependent format string,
533 * or NULL to fall back to finished_{start,stop}_job; if those are NULL too, fall back to generic. */
534 const char *(*finished_job
)(Unit
*u
, JobType t
, JobResult result
);
535 } UnitStatusMessageFormats
;
537 /* Flags used when writing drop-in files or transient unit files */
538 typedef enum UnitWriteFlags
{
539 /* Write a runtime unit file or drop-in (i.e. one below /run) */
540 UNIT_RUNTIME
= 1 << 0,
542 /* Write a persistent drop-in (i.e. one below /etc) */
543 UNIT_PERSISTENT
= 1 << 1,
545 /* Place this item in the per-unit-type private section, instead of [Unit] */
546 UNIT_PRIVATE
= 1 << 2,
548 /* Apply specifier escaping */
549 UNIT_ESCAPE_SPECIFIERS
= 1 << 3,
551 /* Escape elements of ExecStart= syntax, incl. prevention of variable expansion */
552 UNIT_ESCAPE_EXEC_SYNTAX_ENV
= 1 << 4,
554 /* Escape elements of ExecStart=: syntax (no variable expansion) */
555 UNIT_ESCAPE_EXEC_SYNTAX
= 1 << 5,
557 /* Apply C escaping before writing */
558 UNIT_ESCAPE_C
= 1 << 6,
561 /* Returns true if neither persistent, nor runtime storage is requested, i.e. this is a check invocation only */
562 static inline bool UNIT_WRITE_FLAGS_NOOP(UnitWriteFlags flags
) {
563 return (flags
& (UNIT_RUNTIME
|UNIT_PERSISTENT
)) == 0;
568 typedef struct UnitVTable
{
569 /* How much memory does an object of this unit type need */
572 /* If greater than 0, the offset into the object where
573 * ExecContext is found, if the unit type has that */
574 size_t exec_context_offset
;
576 /* If greater than 0, the offset into the object where
577 * CGroupContext is found, if the unit type has that */
578 size_t cgroup_context_offset
;
580 /* If greater than 0, the offset into the object where
581 * KillContext is found, if the unit type has that */
582 size_t kill_context_offset
;
584 /* If greater than 0, the offset into the object where the
585 * pointer to ExecSharedRuntime is found, if the unit type has
587 size_t exec_runtime_offset
;
589 /* The name of the configuration file section with the private settings of this unit */
590 const char *private_section
;
592 /* Config file sections this unit type understands, separated
594 const char *sections
;
596 /* This should reset all type-specific variables. This should
597 * not allocate memory, and is called with zero-initialized
598 * data. It should hence only initialize variables that need
600 void (*init
)(Unit
*u
);
602 /* This should free all type-specific variables. It should be
604 void (*done
)(Unit
*u
);
606 /* Actually load data from disk. This may fail, and should set
607 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
608 * UNIT_STUB if no configuration could be found. */
609 int (*load
)(Unit
*u
);
611 /* During deserialization we only record the intended state to return to. With coldplug() we actually put the
612 * deserialized state in effect. This is where unit_notify() should be called to start things up. Note that
613 * this callback is invoked *before* we leave the reloading state of the manager, i.e. *before* we consider the
614 * reloading to be complete. Thus, this callback should just restore the exact same state for any unit that was
615 * in effect before the reload, i.e. units should not catch up with changes happened during the reload. That's
616 * what catchup() below is for. */
617 int (*coldplug
)(Unit
*u
);
619 /* This is called shortly after all units' coldplug() call was invoked, and *after* the manager left the
620 * reloading state. It's supposed to catch up with state changes due to external events we missed so far (for
621 * example because they took place while we were reloading/reexecing) */
622 void (*catchup
)(Unit
*u
);
624 void (*dump
)(Unit
*u
, FILE *f
, const char *prefix
);
626 int (*start
)(Unit
*u
);
627 int (*stop
)(Unit
*u
);
628 int (*reload
)(Unit
*u
);
630 /* Clear out the various runtime/state/cache/logs/configuration data */
631 int (*clean
)(Unit
*u
, ExecCleanMask m
);
633 /* Freeze the unit */
634 int (*freeze
)(Unit
*u
);
635 int (*thaw
)(Unit
*u
);
636 bool (*can_freeze
)(Unit
*u
);
638 /* Return which kind of data can be cleaned */
639 int (*can_clean
)(Unit
*u
, ExecCleanMask
*ret
);
641 bool (*can_reload
)(Unit
*u
);
643 /* Serialize state and file descriptors that should be carried over into the new
644 * instance after reexecution. */
645 int (*serialize
)(Unit
*u
, FILE *f
, FDSet
*fds
);
647 /* Restore one item from the serialization */
648 int (*deserialize_item
)(Unit
*u
, const char *key
, const char *data
, FDSet
*fds
);
650 /* Try to match up fds with what we need for this unit */
651 void (*distribute_fds
)(Unit
*u
, FDSet
*fds
);
653 /* Boils down the more complex internal state of this unit to
654 * a simpler one that the engine can understand */
655 UnitActiveState (*active_state
)(Unit
*u
);
657 /* Returns the substate specific to this unit type as
658 * string. This is purely information so that we can give the
659 * user a more fine grained explanation in which actual state a
661 const char* (*sub_state_to_string
)(Unit
*u
);
663 /* Additionally to UnitActiveState determine whether unit is to be restarted. */
664 bool (*will_restart
)(Unit
*u
);
666 /* Return false when there is a reason to prevent this unit from being gc'ed
667 * even though nothing references it and it isn't active in any way. */
668 bool (*may_gc
)(Unit
*u
);
670 /* Return true when the unit is not controlled by the manager (e.g. extrinsic mounts). */
671 bool (*is_extrinsic
)(Unit
*u
);
673 /* When the unit is not running and no job for it queued we shall release its runtime resources */
674 void (*release_resources
)(Unit
*u
);
676 /* Invoked on every child that died */
677 void (*sigchld_event
)(Unit
*u
, pid_t pid
, int code
, int status
);
679 /* Reset failed state if we are in failed state */
680 void (*reset_failed
)(Unit
*u
);
682 /* Called whenever any of the cgroups this unit watches for ran empty */
683 void (*notify_cgroup_empty
)(Unit
*u
);
685 /* Called whenever an OOM kill event on this unit was seen */
686 void (*notify_cgroup_oom
)(Unit
*u
, bool managed_oom
);
688 /* Called whenever a process of this unit sends us a message */
689 void (*notify_message
)(Unit
*u
, const struct ucred
*ucred
, char * const *tags
, FDSet
*fds
);
691 /* Called whenever a name this Unit registered for comes or goes away. */
692 void (*bus_name_owner_change
)(Unit
*u
, const char *new_owner
);
694 /* Called for each property that is being set */
695 int (*bus_set_property
)(Unit
*u
, const char *name
, sd_bus_message
*message
, UnitWriteFlags flags
, sd_bus_error
*error
);
697 /* Called after at least one property got changed to apply the necessary change */
698 int (*bus_commit_properties
)(Unit
*u
);
700 /* Return the unit this unit is following */
701 Unit
*(*following
)(Unit
*u
);
703 /* Return the set of units that are following each other */
704 int (*following_set
)(Unit
*u
, Set
**s
);
706 /* Invoked each time a unit this unit is triggering changes
707 * state or gains/loses a job */
708 void (*trigger_notify
)(Unit
*u
, Unit
*trigger
);
710 /* Called whenever CLOCK_REALTIME made a jump */
711 void (*time_change
)(Unit
*u
);
713 /* Called whenever /etc/localtime was modified */
714 void (*timezone_change
)(Unit
*u
);
716 /* Returns the next timeout of a unit */
717 int (*get_timeout
)(Unit
*u
, usec_t
*timeout
);
719 /* Returns the start timeout of a unit */
720 usec_t (*get_timeout_start_usec
)(Unit
*u
);
722 /* Returns the main PID if there is any defined, or 0. */
723 PidRef
* (*main_pid
)(Unit
*u
);
725 /* Returns the control PID if there is any defined, or 0. */
726 PidRef
* (*control_pid
)(Unit
*u
);
728 /* Returns true if the unit currently needs access to the console */
729 bool (*needs_console
)(Unit
*u
);
731 /* Returns the exit status to propagate in case of FailureAction=exit/SuccessAction=exit; usually returns the
732 * exit code of the "main" process of the service or similar. */
733 int (*exit_status
)(Unit
*u
);
735 /* Return a copy of the status string pointer. */
736 const char* (*status_text
)(Unit
*u
);
738 /* Like the enumerate() callback further down, but only enumerates the perpetual units, i.e. all units that
739 * unconditionally exist and are always active. The main reason to keep both enumeration functions separate is
740 * philosophical: the state of perpetual units should be put in place by coldplug(), while the state of those
741 * discovered through regular enumeration should be put in place by catchup(), see below. */
742 void (*enumerate_perpetual
)(Manager
*m
);
744 /* This is called for each unit type and should be used to enumerate units already existing in the system
745 * internally and load them. However, everything that is loaded here should still stay in inactive state. It is
746 * the job of the catchup() call above to put the units into the discovered state. */
747 void (*enumerate
)(Manager
*m
);
749 /* Type specific cleanups. */
750 void (*shutdown
)(Manager
*m
);
752 /* If this function is set and returns false all jobs for units
753 * of this type will immediately fail. */
754 bool (*supported
)(void);
756 /* If this function is set, it's invoked first as part of starting a unit to allow start rate
757 * limiting checks to occur before we do anything else. */
758 int (*can_start
)(Unit
*u
);
760 /* Returns > 0 if the whole subsystem is ratelimited, and new start operations should not be started
761 * for this unit type right now. */
762 int (*subsystem_ratelimited
)(Manager
*m
);
764 /* The strings to print in status messages */
765 UnitStatusMessageFormats status_message_formats
;
767 /* True if transient units of this type are OK */
770 /* True if cgroup delegation is permissible */
773 /* True if the unit type triggers other units, i.e. can have a UNIT_TRIGGERS dependency */
776 /* True if the unit type knows a failure state, and thus can be source of an OnFailure= dependency */
779 /* True if units of this type shall be startable only once and then never again */
782 /* Do not serialize this unit when preparing for root switch */
783 bool exclude_from_switch_root_serialization
;
785 /* True if queued jobs of this type should be GC'ed if no other job needs them anymore */
788 /* True if systemd-oomd can monitor and act on this unit's recursive children's cgroups */
789 bool can_set_managed_oom
;
791 /* If true, we'll notify plymouth about this unit */
792 bool notify_plymouth
;
794 /* The audit events to generate on start + stop (or 0 if none shall be generated) */
795 int audit_start_message_type
;
796 int audit_stop_message_type
;
799 extern const UnitVTable
* const unit_vtable
[_UNIT_TYPE_MAX
];
801 static inline const UnitVTable
* UNIT_VTABLE(const Unit
*u
) {
802 return unit_vtable
[u
->type
];
805 /* For casting a unit into the various unit types */
806 #define DEFINE_CAST(UPPERCASE, MixedCase) \
807 static inline MixedCase* UPPERCASE(Unit *u) { \
808 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
811 return (MixedCase*) u; \
814 /* For casting the various unit types into a unit */
817 typeof(u) _u_ = (u); \
818 Unit *_w_ = _u_ ? &(_u_)->meta : NULL; \
822 #define UNIT_HAS_EXEC_CONTEXT(u) (UNIT_VTABLE(u)->exec_context_offset > 0)
823 #define UNIT_HAS_CGROUP_CONTEXT(u) (UNIT_VTABLE(u)->cgroup_context_offset > 0)
824 #define UNIT_HAS_KILL_CONTEXT(u) (UNIT_VTABLE(u)->kill_context_offset > 0)
826 Unit
* unit_has_dependency(const Unit
*u
, UnitDependencyAtom atom
, Unit
*other
);
827 int unit_get_dependency_array(const Unit
*u
, UnitDependencyAtom atom
, Unit
***ret_array
);
828 int unit_get_transitive_dependency_set(Unit
*u
, UnitDependencyAtom atom
, Set
**ret
);
830 static inline Hashmap
* unit_get_dependencies(Unit
*u
, UnitDependency d
) {
831 return hashmap_get(u
->dependencies
, UNIT_DEPENDENCY_TO_PTR(d
));
834 static inline Unit
* UNIT_TRIGGER(Unit
*u
) {
835 return unit_has_dependency(u
, UNIT_ATOM_TRIGGERS
, NULL
);
838 static inline Unit
* UNIT_GET_SLICE(const Unit
*u
) {
839 return unit_has_dependency(u
, UNIT_ATOM_IN_SLICE
, NULL
);
842 Unit
* unit_new(Manager
*m
, size_t size
);
843 Unit
* unit_free(Unit
*u
);
844 DEFINE_TRIVIAL_CLEANUP_FUNC(Unit
*, unit_free
);
846 int unit_new_for_name(Manager
*m
, size_t size
, const char *name
, Unit
**ret
);
847 int unit_add_name(Unit
*u
, const char *name
);
849 int unit_add_dependency(Unit
*u
, UnitDependency d
, Unit
*other
, bool add_reference
, UnitDependencyMask mask
);
850 int unit_add_two_dependencies(Unit
*u
, UnitDependency d
, UnitDependency e
, Unit
*other
, bool add_reference
, UnitDependencyMask mask
);
852 int unit_add_dependency_by_name(Unit
*u
, UnitDependency d
, const char *name
, bool add_reference
, UnitDependencyMask mask
);
853 int unit_add_two_dependencies_by_name(Unit
*u
, UnitDependency d
, UnitDependency e
, const char *name
, bool add_reference
, UnitDependencyMask mask
);
855 int unit_add_exec_dependencies(Unit
*u
, ExecContext
*c
);
857 int unit_choose_id(Unit
*u
, const char *name
);
858 int unit_set_description(Unit
*u
, const char *description
);
860 void unit_release_resources(Unit
*u
);
862 bool unit_may_gc(Unit
*u
);
864 static inline bool unit_is_extrinsic(Unit
*u
) {
865 return u
->perpetual
||
866 (UNIT_VTABLE(u
)->is_extrinsic
&& UNIT_VTABLE(u
)->is_extrinsic(u
));
869 static inline const char* unit_status_text(Unit
*u
) {
870 if (u
&& UNIT_VTABLE(u
)->status_text
)
871 return UNIT_VTABLE(u
)->status_text(u
);
875 void unit_add_to_load_queue(Unit
*u
);
876 void unit_add_to_dbus_queue(Unit
*u
);
877 void unit_add_to_cleanup_queue(Unit
*u
);
878 void unit_add_to_gc_queue(Unit
*u
);
879 void unit_add_to_target_deps_queue(Unit
*u
);
880 void unit_submit_to_stop_when_unneeded_queue(Unit
*u
);
881 void unit_submit_to_start_when_upheld_queue(Unit
*u
);
882 void unit_submit_to_stop_when_bound_queue(Unit
*u
);
883 void unit_submit_to_release_resources_queue(Unit
*u
);
885 int unit_merge(Unit
*u
, Unit
*other
);
886 int unit_merge_by_name(Unit
*u
, const char *other
);
888 Unit
*unit_follow_merge(Unit
*u
) _pure_
;
890 int unit_load_fragment_and_dropin(Unit
*u
, bool fragment_required
);
891 int unit_load(Unit
*unit
);
893 int unit_set_slice(Unit
*u
, Unit
*slice
);
894 int unit_set_default_slice(Unit
*u
);
896 const char *unit_description(Unit
*u
) _pure_
;
897 const char *unit_status_string(Unit
*u
, char **combined
);
899 bool unit_has_name(const Unit
*u
, const char *name
);
901 UnitActiveState
unit_active_state(Unit
*u
);
902 FreezerState
unit_freezer_state(Unit
*u
);
903 int unit_freezer_state_kernel(Unit
*u
, FreezerState
*ret
);
905 const char* unit_sub_state_to_string(Unit
*u
);
907 bool unit_can_reload(Unit
*u
) _pure_
;
908 bool unit_can_start(Unit
*u
) _pure_
;
909 bool unit_can_stop(Unit
*u
) _pure_
;
910 bool unit_can_isolate(Unit
*u
) _pure_
;
912 int unit_start(Unit
*u
, ActivationDetails
*details
);
913 int unit_stop(Unit
*u
);
914 int unit_reload(Unit
*u
);
916 int unit_kill(Unit
*u
, KillWho w
, int signo
, int code
, int value
, sd_bus_error
*error
);
918 void unit_notify_cgroup_oom(Unit
*u
, bool managed_oom
);
920 void unit_notify(Unit
*u
, UnitActiveState os
, UnitActiveState ns
, bool reload_success
);
922 int unit_watch_pidref(Unit
*u
, PidRef
*pid
, bool exclusive
);
923 int unit_watch_pid(Unit
*u
, pid_t pid
, bool exclusive
);
924 void unit_unwatch_pidref(Unit
*u
, PidRef
*pid
);
925 void unit_unwatch_pid(Unit
*u
, pid_t pid
);
926 void unit_unwatch_all_pids(Unit
*u
);
928 int unit_enqueue_rewatch_pids(Unit
*u
);
929 void unit_dequeue_rewatch_pids(Unit
*u
);
931 int unit_install_bus_match(Unit
*u
, sd_bus
*bus
, const char *name
);
932 int unit_watch_bus_name(Unit
*u
, const char *name
);
933 void unit_unwatch_bus_name(Unit
*u
, const char *name
);
935 bool unit_job_is_applicable(Unit
*u
, JobType j
);
937 int set_unit_path(const char *p
);
939 char *unit_dbus_path(Unit
*u
);
940 char *unit_dbus_path_invocation_id(Unit
*u
);
942 int unit_load_related_unit(Unit
*u
, const char *type
, Unit
**_found
);
944 int unit_add_node_dependency(Unit
*u
, const char *what
, UnitDependency d
, UnitDependencyMask mask
);
945 int unit_add_blockdev_dependency(Unit
*u
, const char *what
, UnitDependencyMask mask
);
947 int unit_coldplug(Unit
*u
);
948 void unit_catchup(Unit
*u
);
950 void unit_status_printf(Unit
*u
, StatusType status_type
, const char *status
, const char *format
, const char *ident
) _printf_(4, 0);
952 bool unit_need_daemon_reload(Unit
*u
);
954 void unit_reset_failed(Unit
*u
);
956 Unit
*unit_following(Unit
*u
);
957 int unit_following_set(Unit
*u
, Set
**s
);
959 const char *unit_slice_name(Unit
*u
);
961 bool unit_stop_pending(Unit
*u
) _pure_
;
962 bool unit_inactive_or_pending(Unit
*u
) _pure_
;
963 bool unit_active_or_pending(Unit
*u
);
964 bool unit_will_restart_default(Unit
*u
);
965 bool unit_will_restart(Unit
*u
);
967 int unit_add_default_target_dependency(Unit
*u
, Unit
*target
);
969 void unit_start_on_failure(Unit
*u
, const char *dependency_name
, UnitDependencyAtom atom
, JobMode job_mode
);
970 void unit_trigger_notify(Unit
*u
);
972 UnitFileState
unit_get_unit_file_state(Unit
*u
);
973 PresetAction
unit_get_unit_file_preset(Unit
*u
);
975 Unit
* unit_ref_set(UnitRef
*ref
, Unit
*source
, Unit
*target
);
976 void unit_ref_unset(UnitRef
*ref
);
978 #define UNIT_DEREF(ref) ((ref).target)
979 #define UNIT_ISSET(ref) (!!(ref).target)
981 int unit_patch_contexts(Unit
*u
);
983 ExecContext
*unit_get_exec_context(const Unit
*u
) _pure_
;
984 KillContext
*unit_get_kill_context(Unit
*u
) _pure_
;
985 CGroupContext
*unit_get_cgroup_context(Unit
*u
) _pure_
;
987 ExecRuntime
*unit_get_exec_runtime(Unit
*u
) _pure_
;
989 int unit_setup_exec_runtime(Unit
*u
);
991 const char* unit_escape_setting(const char *s
, UnitWriteFlags flags
, char **buf
);
992 char* unit_concat_strv(char **l
, UnitWriteFlags flags
);
994 int unit_write_setting(Unit
*u
, UnitWriteFlags flags
, const char *name
, const char *data
);
995 int unit_write_settingf(Unit
*u
, UnitWriteFlags mode
, const char *name
, const char *format
, ...) _printf_(4,5);
997 int unit_kill_context(Unit
*u
, KillContext
*c
, KillOperation k
, PidRef
*main_pid
, PidRef
*control_pid
, bool main_pid_alien
);
999 int unit_make_transient(Unit
*u
);
1001 int unit_require_mounts_for(Unit
*u
, const char *path
, UnitDependencyMask mask
);
1003 bool unit_type_supported(UnitType t
);
1005 bool unit_is_pristine(Unit
*u
);
1007 bool unit_is_unneeded(Unit
*u
);
1008 bool unit_is_upheld_by_active(Unit
*u
, Unit
**ret_culprit
);
1009 bool unit_is_bound_by_inactive(Unit
*u
, Unit
**ret_culprit
);
1011 PidRef
* unit_control_pid(Unit
*u
);
1012 PidRef
* unit_main_pid(Unit
*u
);
1014 void unit_warn_if_dir_nonempty(Unit
*u
, const char* where
);
1015 int unit_fail_if_noncanonical(Unit
*u
, const char* where
);
1017 int unit_test_start_limit(Unit
*u
);
1019 int unit_ref_uid_gid(Unit
*u
, uid_t uid
, gid_t gid
);
1020 void unit_unref_uid_gid(Unit
*u
, bool destroy_now
);
1022 void unit_notify_user_lookup(Unit
*u
, uid_t uid
, gid_t gid
);
1024 int unit_set_invocation_id(Unit
*u
, sd_id128_t id
);
1025 int unit_acquire_invocation_id(Unit
*u
);
1027 bool unit_shall_confirm_spawn(Unit
*u
);
1029 int unit_set_exec_params(Unit
*s
, ExecParameters
*p
);
1031 int unit_fork_helper_process(Unit
*u
, const char *name
, PidRef
*ret
);
1032 int unit_fork_and_watch_rm_rf(Unit
*u
, char **paths
, PidRef
*ret
);
1034 void unit_remove_dependencies(Unit
*u
, UnitDependencyMask mask
);
1036 void unit_export_state_files(Unit
*u
);
1037 void unit_unlink_state_files(Unit
*u
);
1039 int unit_prepare_exec(Unit
*u
);
1041 int unit_log_leftover_process_start(pid_t pid
, int sig
, void *userdata
);
1042 int unit_log_leftover_process_stop(pid_t pid
, int sig
, void *userdata
);
1043 int unit_warn_leftover_processes(Unit
*u
, cg_kill_log_func_t log_func
);
1045 bool unit_needs_console(Unit
*u
);
1047 int unit_pid_attachable(Unit
*unit
, PidRef
*pid
, sd_bus_error
*error
);
1049 static inline bool unit_has_job_type(Unit
*u
, JobType type
) {
1050 return u
&& u
->job
&& u
->job
->type
== type
;
1053 static inline bool unit_log_level_test(const Unit
*u
, int level
) {
1054 ExecContext
*ec
= unit_get_exec_context(u
);
1055 return !ec
|| ec
->log_level_max
< 0 || ec
->log_level_max
>= LOG_PRI(level
);
1058 /* unit_log_skip is for cases like ExecCondition= where a unit is considered "done"
1059 * after some execution, rather than succeeded or failed. */
1060 void unit_log_skip(Unit
*u
, const char *result
);
1061 void unit_log_success(Unit
*u
);
1062 void unit_log_failure(Unit
*u
, const char *result
);
1063 static inline void unit_log_result(Unit
*u
, bool success
, const char *result
) {
1065 unit_log_success(u
);
1067 unit_log_failure(u
, result
);
1070 void unit_log_process_exit(Unit
*u
, const char *kind
, const char *command
, bool success
, int code
, int status
);
1072 int unit_exit_status(Unit
*u
);
1073 int unit_success_action_exit_status(Unit
*u
);
1074 int unit_failure_action_exit_status(Unit
*u
);
1076 int unit_test_trigger_loaded(Unit
*u
);
1078 void unit_destroy_runtime_data(Unit
*u
, const ExecContext
*context
);
1079 int unit_clean(Unit
*u
, ExecCleanMask mask
);
1080 int unit_can_clean(Unit
*u
, ExecCleanMask
*ret_mask
);
1082 bool unit_can_freeze(Unit
*u
);
1083 int unit_freeze(Unit
*u
);
1084 void unit_frozen(Unit
*u
);
1086 int unit_thaw(Unit
*u
);
1087 void unit_thawed(Unit
*u
);
1089 int unit_freeze_vtable_common(Unit
*u
);
1090 int unit_thaw_vtable_common(Unit
*u
);
1092 Condition
*unit_find_failed_condition(Unit
*u
);
1094 int unit_arm_timer(Unit
*u
, sd_event_source
**source
, bool relative
, usec_t usec
, sd_event_time_handler_t handler
);
1096 /* Macros which append UNIT= or USER_UNIT= to the message */
1098 #define log_unit_full_errno_zerook(unit, level, error, ...) \
1100 const Unit *_u = (unit); \
1101 const int _l = (level); \
1102 bool _do_log = !(log_get_max_level() < LOG_PRI(_l) || \
1103 (_u && !unit_log_level_test(_u, _l))); \
1104 const ExecContext *_c = _do_log && _u ? \
1105 unit_get_exec_context(_u) : NULL; \
1106 LOG_CONTEXT_PUSH_IOV(_c ? _c->log_extra_fields : NULL, \
1107 _c ? _c->n_log_extra_fields : 0); \
1108 !_do_log ? -ERRNO_VALUE(error) : \
1109 _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__) : \
1110 log_internal(_l, error, PROJECT_FILE, __LINE__, __func__, ##__VA_ARGS__); \
1113 #define log_unit_full_errno(unit, level, error, ...) \
1115 int _error = (error); \
1116 ASSERT_NON_ZERO(_error); \
1117 log_unit_full_errno_zerook(unit, level, _error, ##__VA_ARGS__); \
1120 #define log_unit_full(unit, level, ...) (void) log_unit_full_errno_zerook(unit, level, 0, __VA_ARGS__)
1122 #define log_unit_debug(unit, ...) log_unit_full(unit, LOG_DEBUG, __VA_ARGS__)
1123 #define log_unit_info(unit, ...) log_unit_full(unit, LOG_INFO, __VA_ARGS__)
1124 #define log_unit_notice(unit, ...) log_unit_full(unit, LOG_NOTICE, __VA_ARGS__)
1125 #define log_unit_warning(unit, ...) log_unit_full(unit, LOG_WARNING, __VA_ARGS__)
1126 #define log_unit_error(unit, ...) log_unit_full(unit, LOG_ERR, __VA_ARGS__)
1128 #define log_unit_debug_errno(unit, error, ...) log_unit_full_errno(unit, LOG_DEBUG, error, __VA_ARGS__)
1129 #define log_unit_info_errno(unit, error, ...) log_unit_full_errno(unit, LOG_INFO, error, __VA_ARGS__)
1130 #define log_unit_notice_errno(unit, error, ...) log_unit_full_errno(unit, LOG_NOTICE, error, __VA_ARGS__)
1131 #define log_unit_warning_errno(unit, error, ...) log_unit_full_errno(unit, LOG_WARNING, error, __VA_ARGS__)
1132 #define log_unit_error_errno(unit, error, ...) log_unit_full_errno(unit, LOG_ERR, error, __VA_ARGS__)
1135 # define log_unit_trace(...) log_unit_debug(__VA_ARGS__)
1136 # define log_unit_trace_errno(...) log_unit_debug_errno(__VA_ARGS__)
1138 # define log_unit_trace(...) do {} while (0)
1139 # define log_unit_trace_errno(e, ...) (-ERRNO_VALUE(e))
1142 #define log_unit_struct_errno(unit, level, error, ...) \
1144 const Unit *_u = (unit); \
1145 const int _l = (level); \
1146 bool _do_log = unit_log_level_test(_u, _l); \
1147 const ExecContext *_c = _do_log && _u ? \
1148 unit_get_exec_context(_u) : NULL; \
1149 LOG_CONTEXT_PUSH_IOV(_c ? _c->log_extra_fields : NULL, \
1150 _c ? _c->n_log_extra_fields : 0); \
1152 log_struct_errno(_l, error, __VA_ARGS__, LOG_UNIT_ID(_u)) : \
1153 -ERRNO_VALUE(error); \
1156 #define log_unit_struct(unit, level, ...) log_unit_struct_errno(unit, level, 0, __VA_ARGS__)
1158 #define log_unit_struct_iovec_errno(unit, level, error, iovec, n_iovec) \
1160 const Unit *_u = (unit); \
1161 const int _l = (level); \
1162 bool _do_log = unit_log_level_test(_u, _l); \
1163 const ExecContext *_c = _do_log && _u ? \
1164 unit_get_exec_context(_u) : NULL; \
1165 LOG_CONTEXT_PUSH_IOV(_c ? _c->log_extra_fields : NULL, \
1166 _c ? _c->n_log_extra_fields : 0); \
1168 log_struct_iovec_errno(_l, error, iovec, n_iovec) : \
1169 -ERRNO_VALUE(error); \
1172 #define log_unit_struct_iovec(unit, level, iovec, n_iovec) log_unit_struct_iovec_errno(unit, level, 0, iovec, n_iovec)
1174 /* Like LOG_MESSAGE(), but with the unit name prefixed. */
1175 #define LOG_UNIT_MESSAGE(unit, fmt, ...) LOG_MESSAGE("%s: " fmt, (unit)->id, ##__VA_ARGS__)
1176 #define LOG_UNIT_ID(unit) (unit)->manager->unit_log_format_string, (unit)->id
1177 #define LOG_UNIT_INVOCATION_ID(unit) (unit)->manager->invocation_log_format_string, (unit)->invocation_id_string
1179 const char* collect_mode_to_string(CollectMode m
) _const_
;
1180 CollectMode
collect_mode_from_string(const char *s
) _pure_
;
1182 typedef struct UnitForEachDependencyData
{
1183 /* Stores state for the FOREACH macro below for iterating through all deps that have any of the
1184 * specified dependency atom bits set */
1185 UnitDependencyAtom match_atom
;
1186 Hashmap
*by_type
, *by_unit
;
1188 Iterator by_type_iterator
, by_unit_iterator
;
1189 Unit
**current_unit
;
1190 } UnitForEachDependencyData
;
1192 /* Iterates through all dependencies that have a specific atom in the dependency type set. This tries to be
1193 * smart: if the atom is unique, we'll directly go to right entry. Otherwise we'll iterate through the
1194 * per-dependency type hashmap and match all dep that have the right atom set. */
1195 #define _UNIT_FOREACH_DEPENDENCY(other, u, ma, data) \
1196 for (UnitForEachDependencyData data = { \
1197 .match_atom = (ma), \
1198 .by_type = (u)->dependencies, \
1199 .by_type_iterator = ITERATOR_FIRST, \
1200 .current_unit = &(other), \
1203 UnitDependency _dt = _UNIT_DEPENDENCY_INVALID; \
1206 if (data.by_type && ITERATOR_IS_FIRST(data.by_type_iterator)) { \
1207 _dt = unit_dependency_from_unique_atom(data.match_atom); \
1209 data.by_unit = hashmap_get(data.by_type, UNIT_DEPENDENCY_TO_PTR(_dt)); \
1210 data.current_type = UNIT_DEPENDENCY_TO_PTR(_dt); \
1211 data.by_type = NULL; \
1212 _found = !!data.by_unit; \
1216 _found = hashmap_iterate(data.by_type, \
1217 &data.by_type_iterator, \
1218 (void**)&(data.by_unit), \
1219 (const void**) &(data.current_type)); \
1222 if ((unit_dependency_to_atom(UNIT_DEPENDENCY_FROM_PTR(data.current_type)) & data.match_atom) != 0) \
1223 for (data.by_unit_iterator = ITERATOR_FIRST; \
1224 hashmap_iterate(data.by_unit, \
1225 &data.by_unit_iterator, \
1227 (const void**) data.current_unit); )
1229 /* Note: this matches deps that have *any* of the atoms specified in match_atom set */
1230 #define UNIT_FOREACH_DEPENDENCY(other, u, match_atom) \
1231 _UNIT_FOREACH_DEPENDENCY(other, u, match_atom, UNIQ_T(data, UNIQ))
1233 #define _LOG_CONTEXT_PUSH_UNIT(unit, u, c) \
1234 const Unit *u = (unit); \
1235 const ExecContext *c = unit_get_exec_context(u); \
1236 LOG_CONTEXT_PUSH_KEY_VALUE(u->manager->unit_log_field, u->id); \
1237 LOG_CONTEXT_PUSH_KEY_VALUE(u->manager->invocation_log_field, u->invocation_id_string); \
1238 LOG_CONTEXT_PUSH_IOV(c ? c->log_extra_fields : NULL, c ? c->n_log_extra_fields : 0)
1240 #define LOG_CONTEXT_PUSH_UNIT(unit) \
1241 _LOG_CONTEXT_PUSH_UNIT(unit, UNIQ_T(u, UNIQ), UNIQ_T(c, UNIQ))