1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
7 #include <sys/socket.h>
12 /* Circular dependency with manager.h, needs to be defined before local includes */
13 typedef enum UnitMountDependencyType
{
16 _UNIT_MOUNT_DEPENDENCY_TYPE_MAX
,
17 _UNIT_MOUNT_DEPENDENCY_TYPE_INVALID
= -EINVAL
,
18 } UnitMountDependencyType
;
20 #include "bpf-program.h"
22 #include "condition.h"
23 #include "emergency-action.h"
28 #include "show-status.h"
29 #include "unit-file.h"
31 typedef struct UnitRef UnitRef
;
33 typedef enum KillOperation
{
35 KILL_TERMINATE_AND_LOG
,
40 _KILL_OPERATION_INVALID
= -EINVAL
,
43 typedef enum CollectMode
{
45 COLLECT_INACTIVE_OR_FAILED
,
47 _COLLECT_MODE_INVALID
= -EINVAL
,
50 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t
) {
51 return IN_SET(t
, UNIT_ACTIVE
, UNIT_RELOADING
);
54 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t
) {
55 return IN_SET(t
, UNIT_ACTIVE
, UNIT_ACTIVATING
, UNIT_RELOADING
);
58 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t
) {
59 return IN_SET(t
, UNIT_INACTIVE
, UNIT_FAILED
, UNIT_DEACTIVATING
);
62 static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t
) {
63 return IN_SET(t
, UNIT_INACTIVE
, UNIT_FAILED
);
66 static inline bool UNIT_IS_LOAD_COMPLETE(UnitLoadState t
) {
67 return t
>= 0 && t
< _UNIT_LOAD_STATE_MAX
&& t
!= UNIT_STUB
&& t
!= UNIT_MERGED
;
70 /* Stores the 'reason' a dependency was created as a bit mask, i.e. due to which configuration source it came to be. We
71 * use this so that we can selectively flush out parts of dependencies again. Note that the same dependency might be
72 * created as a result of multiple "reasons", hence the bitmask. */
73 typedef enum UnitDependencyMask
{
74 /* Configured directly by the unit file, .wants/.requires symlink or drop-in, or as an immediate result of a
75 * non-dependency option configured that way. */
76 UNIT_DEPENDENCY_FILE
= 1 << 0,
78 /* As unconditional implicit dependency (not affected by unit configuration — except by the unit name and
80 UNIT_DEPENDENCY_IMPLICIT
= 1 << 1,
82 /* A dependency effected by DefaultDependencies=yes. Note that dependencies marked this way are conceptually
83 * just a subset of UNIT_DEPENDENCY_FILE, as DefaultDependencies= is itself a unit file setting that can only
84 * be set in unit files. We make this two separate bits only to help debugging how dependencies came to be. */
85 UNIT_DEPENDENCY_DEFAULT
= 1 << 2,
87 /* A dependency created from udev rules */
88 UNIT_DEPENDENCY_UDEV
= 1 << 3,
90 /* A dependency created because of some unit's RequiresMountsFor= setting */
91 UNIT_DEPENDENCY_PATH
= 1 << 4,
93 /* A dependency initially configured from the mount unit file however the dependency will be updated
94 * from /proc/self/mountinfo as soon as the kernel will make the entry for that mount available in
96 UNIT_DEPENDENCY_MOUNT_FILE
= 1 << 5,
98 /* A dependency created or updated because of data read from /proc/self/mountinfo */
99 UNIT_DEPENDENCY_MOUNTINFO
= 1 << 6,
101 /* A dependency created because of data read from /proc/swaps and no other configuration source */
102 UNIT_DEPENDENCY_PROC_SWAP
= 1 << 7,
104 /* A dependency for units in slices assigned by directly setting Slice= */
105 UNIT_DEPENDENCY_SLICE_PROPERTY
= 1 << 8,
107 _UNIT_DEPENDENCY_MASK_FULL
= (1 << 9) - 1,
108 } UnitDependencyMask
;
110 /* The Unit's dependencies[] hashmaps use this structure as value. It has the same size as a void pointer, and thus can
111 * be stored directly as hashmap value, without any indirection. Note that this stores two masks, as both the origin
112 * and the destination of a dependency might have created it. */
113 typedef union UnitDependencyInfo
{
116 UnitDependencyMask origin_mask
:16;
117 UnitDependencyMask destination_mask
:16;
119 } UnitDependencyInfo
;
121 /* Store information about why a unit was activated.
122 * We start with trigger units (.path/.timer), eventually it will be expanded to include more metadata. */
123 typedef struct ActivationDetails
{
125 UnitType trigger_unit_type
;
126 char *trigger_unit_name
;
129 /* For casting an activation event into the various unit-specific types */
130 #define DEFINE_ACTIVATION_DETAILS_CAST(UPPERCASE, MixedCase, UNIT_TYPE) \
131 static inline MixedCase* UPPERCASE(ActivationDetails *a) { \
132 if (_unlikely_(!a || a->trigger_unit_type != UNIT_##UNIT_TYPE)) \
135 return (MixedCase*) a; \
138 /* For casting the various unit types into a unit */
139 #define ACTIVATION_DETAILS(u) \
141 typeof(u) _u_ = (u); \
142 ActivationDetails *_w_ = _u_ ? &(_u_)->meta : NULL; \
146 ActivationDetails
*activation_details_new(Unit
*trigger_unit
);
147 ActivationDetails
*activation_details_ref(ActivationDetails
*p
);
148 ActivationDetails
*activation_details_unref(ActivationDetails
*p
);
149 void activation_details_serialize(ActivationDetails
*p
, FILE *f
);
150 int activation_details_deserialize(const char *key
, const char *value
, ActivationDetails
**info
);
151 int activation_details_append_env(ActivationDetails
*info
, char ***strv
);
152 int activation_details_append_pair(ActivationDetails
*info
, char ***strv
);
153 DEFINE_TRIVIAL_CLEANUP_FUNC(ActivationDetails
*, activation_details_unref
);
155 typedef struct ActivationDetailsVTable
{
156 /* How much memory does an object of this activation type need */
159 /* This should reset all type-specific variables. This should not allocate memory, and is called
160 * with zero-initialized data. It should hence only initialize variables that need to be set != 0. */
161 void (*init
)(ActivationDetails
*info
, Unit
*trigger_unit
);
163 /* This should free all type-specific variables. It should be idempotent. */
164 void (*done
)(ActivationDetails
*info
);
166 /* This should serialize all type-specific variables. */
167 void (*serialize
)(ActivationDetails
*info
, FILE *f
);
169 /* This should deserialize all type-specific variables, one at a time. */
170 int (*deserialize
)(const char *key
, const char *value
, ActivationDetails
**info
);
172 /* This should format the type-specific variables for the env block of the spawned service,
173 * and return the number of added items. */
174 int (*append_env
)(ActivationDetails
*info
, char ***strv
);
176 /* This should append type-specific variables as key/value pairs for the D-Bus property of the job,
177 * and return the number of added pairs. */
178 int (*append_pair
)(ActivationDetails
*info
, char ***strv
);
179 } ActivationDetailsVTable
;
181 extern const ActivationDetailsVTable
* const activation_details_vtable
[_UNIT_TYPE_MAX
];
183 static inline const ActivationDetailsVTable
* ACTIVATION_DETAILS_VTABLE(const ActivationDetails
*a
) {
185 assert(a
->trigger_unit_type
< _UNIT_TYPE_MAX
);
187 return activation_details_vtable
[a
->trigger_unit_type
];
190 /* Newer LLVM versions don't like implicit casts from large pointer types to smaller enums, hence let's add
191 * explicit type-safe helpers for that. */
192 static inline UnitDependency
UNIT_DEPENDENCY_FROM_PTR(const void *p
) {
193 return PTR_TO_INT(p
);
196 static inline void* UNIT_DEPENDENCY_TO_PTR(UnitDependency d
) {
197 return INT_TO_PTR(d
);
203 /* Keeps tracks of references to a unit. This is useful so
204 * that we can merge two units if necessary and correct all
205 * references to them */
207 Unit
*source
, *target
;
208 LIST_FIELDS(UnitRef
, refs_by_target
);
211 typedef struct Unit
{
215 UnitLoadState load_state
;
218 char *id
; /* The one special name that we use for identification */
221 Set
*aliases
; /* All the other names. */
223 /* For each dependency type we can look up another Hashmap with this, whose key is a Unit* object,
224 * and whose value encodes why the dependency exists, using the UnitDependencyInfo type. i.e. a
225 * Hashmap(UnitDependency → Hashmap(Unit* → UnitDependencyInfo)) */
226 Hashmap
*dependencies
;
228 /* Similar, for RequiresMountsFor= and WantsMountsFor= path dependencies. The key is the path, the
229 * value the UnitDependencyInfo type */
230 Hashmap
*mounts_for
[_UNIT_MOUNT_DEPENDENCY_TYPE_MAX
];
233 char **documentation
;
235 /* The SELinux context used for checking access to this unit read off the unit file at load time (do
236 * not confuse with the selinux_context field in ExecContext which is the SELinux context we'll set
238 char *access_selinux_context
;
240 char *fragment_path
; /* if loaded from a config file this is the primary path to it */
241 char *source_path
; /* if converted, the source file */
244 usec_t fragment_not_found_timestamp_hash
;
245 usec_t fragment_mtime
;
249 /* If this is a transient unit we are currently writing, this is where we are writing it to */
250 FILE *transient_file
;
253 sd_bus_message
*pending_freezer_invocation
;
254 FreezerState freezer_state
;
256 /* Job timeout and action to take */
257 EmergencyAction job_timeout_action
;
259 usec_t job_running_timeout
;
260 char *job_timeout_reboot_arg
;
262 /* If there is something to do with this unit, then this is the installed job for it */
265 /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
268 /* The slot used for watching NameOwnerChanged signals */
269 sd_bus_slot
*match_bus_slot
;
270 sd_bus_slot
*get_name_owner_slot
;
272 /* References to this unit from clients */
273 sd_bus_track
*bus_track
;
274 char **deserialized_refs
;
276 /* References to this */
277 LIST_HEAD(UnitRef
, refs_by_target
);
279 /* Conditions to check */
280 LIST_HEAD(Condition
, conditions
);
281 LIST_HEAD(Condition
, asserts
);
283 dual_timestamp condition_timestamp
;
284 dual_timestamp assert_timestamp
;
286 /* Updated whenever the low-level state changes */
287 dual_timestamp state_change_timestamp
;
289 /* Updated whenever the (high-level) active state enters or leaves the active or inactive states */
290 dual_timestamp inactive_exit_timestamp
;
291 dual_timestamp active_enter_timestamp
;
292 dual_timestamp active_exit_timestamp
;
293 dual_timestamp inactive_enter_timestamp
;
296 LIST_FIELDS(Unit
, units_by_type
);
299 LIST_FIELDS(Unit
, load_queue
);
302 LIST_FIELDS(Unit
, dbus_queue
);
305 LIST_FIELDS(Unit
, cleanup_queue
);
308 LIST_FIELDS(Unit
, gc_queue
);
310 /* CGroup realize members queue */
311 LIST_FIELDS(Unit
, cgroup_realize_queue
);
313 /* cgroup empty queue */
314 LIST_FIELDS(Unit
, cgroup_empty_queue
);
316 /* cgroup OOM queue */
317 LIST_FIELDS(Unit
, cgroup_oom_queue
);
319 /* Target dependencies queue */
320 LIST_FIELDS(Unit
, target_deps_queue
);
322 /* Queue of units with StopWhenUnneeded= set that shall be checked for clean-up. */
323 LIST_FIELDS(Unit
, stop_when_unneeded_queue
);
325 /* Queue of units that have an Uphold= dependency from some other unit, and should be checked for starting */
326 LIST_FIELDS(Unit
, start_when_upheld_queue
);
328 /* Queue of units that have a BindTo= dependency on some other unit, and should possibly be shut down */
329 LIST_FIELDS(Unit
, stop_when_bound_queue
);
331 /* Queue of units that should be checked if they can release resources now */
332 LIST_FIELDS(Unit
, release_resources_queue
);
334 /* PIDs we keep an eye on. Note that a unit might have many more, but these are the ones we care
335 * enough about to process SIGCHLD for */
336 Set
*pids
; /* → PidRef* */
338 /* Used in SIGCHLD and sd_notify() message event invocation logic to avoid that we dispatch the same event
339 * multiple times on the same unit. */
343 /* Used during GC sweeps */
346 /* Error code when we didn't manage to load the unit (negative) */
349 /* Put a ratelimit on unit starting */
350 RateLimit start_ratelimit
;
351 EmergencyAction start_limit_action
;
353 /* The unit has been marked for reload, restart, etc. Stored as 1u << marker1 | 1u << marker2. */
356 /* What to do on failure or success */
357 EmergencyAction success_action
, failure_action
;
358 int success_action_exit_status
, failure_action_exit_status
;
361 /* Make sure we never enter endless loops with the StopWhenUnneeded=, BindsTo=, Uphold= logic */
362 RateLimit auto_start_stop_ratelimit
;
363 sd_event_source
*auto_start_stop_event_source
;
365 /* Reference to a specific UID/GID */
369 /* Cached unit file state and preset */
370 UnitFileState unit_file_state
;
371 PresetAction unit_file_preset
;
373 /* Where the cpu.stat or cpuacct.usage was at the time the unit was started */
374 nsec_t cpu_usage_base
;
375 nsec_t cpu_usage_last
; /* the most recently read value */
377 /* Most recently read value of memory accounting metrics */
378 uint64_t memory_accounting_last
[_CGROUP_MEMORY_ACCOUNTING_METRIC_CACHED_LAST
+ 1];
380 /* The current counter of OOM kills initiated by systemd-oomd */
381 uint64_t managed_oom_kill_last
;
383 /* The current counter of the oom_kill field in the memory.events cgroup attribute */
384 uint64_t oom_kill_last
;
386 /* Where the io.stat data was at the time the unit was started */
387 uint64_t io_accounting_base
[_CGROUP_IO_ACCOUNTING_METRIC_MAX
];
388 uint64_t io_accounting_last
[_CGROUP_IO_ACCOUNTING_METRIC_MAX
]; /* the most recently read value */
390 /* Counterparts in the cgroup filesystem */
393 CGroupMask cgroup_realized_mask
; /* In which hierarchies does this unit's cgroup exist? (only relevant on cgroup v1) */
394 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) */
395 CGroupMask cgroup_invalidated_mask
; /* A mask specifying controllers which shall be considered invalidated, and require re-realization */
396 CGroupMask cgroup_members_mask
; /* A cache for the controllers required by all children of this cgroup (only relevant for slice units) */
398 /* Inotify watch descriptors for watching cgroup.events and memory.events on cgroupv2 */
399 int cgroup_control_inotify_wd
;
400 int cgroup_memory_inotify_wd
;
402 /* Device Controller BPF program */
403 BPFProgram
*bpf_device_control_installed
;
405 /* IP BPF Firewalling/accounting */
406 int ip_accounting_ingress_map_fd
;
407 int ip_accounting_egress_map_fd
;
408 uint64_t ip_accounting_extra
[_CGROUP_IP_ACCOUNTING_METRIC_MAX
];
410 int ipv4_allow_map_fd
;
411 int ipv6_allow_map_fd
;
412 int ipv4_deny_map_fd
;
413 int ipv6_deny_map_fd
;
414 BPFProgram
*ip_bpf_ingress
, *ip_bpf_ingress_installed
;
415 BPFProgram
*ip_bpf_egress
, *ip_bpf_egress_installed
;
417 Set
*ip_bpf_custom_ingress
;
418 Set
*ip_bpf_custom_ingress_installed
;
419 Set
*ip_bpf_custom_egress
;
420 Set
*ip_bpf_custom_egress_installed
;
422 /* BPF programs managed (e.g. loaded to kernel) by an entity external to systemd,
423 * attached to unit cgroup by provided program fd and attach type. */
424 Hashmap
*bpf_foreign_by_key
;
426 FDSet
*initial_socket_bind_link_fds
;
428 /* BPF links to BPF programs attached to cgroup/bind{4|6} hooks and
429 * responsible for allowing or denying a unit to bind(2) to a socket
431 struct bpf_link
*ipv4_socket_bind_link
;
432 struct bpf_link
*ipv6_socket_bind_link
;
435 FDSet
*initial_restric_ifaces_link_fds
;
437 struct bpf_link
*restrict_ifaces_ingress_bpf_link
;
438 struct bpf_link
*restrict_ifaces_egress_bpf_link
;
441 /* Low-priority event source which is used to remove watched PIDs that have gone away, and subscribe to any new
442 * ones which might have appeared. */
443 sd_event_source
*rewatch_pids_event_source
;
445 /* How to start OnSuccess=/OnFailure= units */
446 JobMode on_success_job_mode
;
447 JobMode on_failure_job_mode
;
449 /* If the job had a specific trigger that needs to be advertised (eg: a path unit), store it. */
450 ActivationDetails
*activation_details
;
452 /* Tweaking the GC logic */
453 CollectMode collect_mode
;
455 /* The current invocation ID */
456 sd_id128_t invocation_id
;
457 char invocation_id_string
[SD_ID128_STRING_MAX
]; /* useful when logging */
459 /* Garbage collect us we nobody wants or requires us anymore */
460 bool stop_when_unneeded
;
462 /* Create default dependencies */
463 bool default_dependencies
;
465 /* Configure so that the unit survives a system transition without stopping/starting. */
466 bool survive_final_kill_signal
;
468 /* Refuse manual starting, allow starting only indirectly via dependency. */
469 bool refuse_manual_start
;
471 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
472 bool refuse_manual_stop
;
474 /* Allow isolation requests */
477 /* Ignore this unit when isolating */
478 bool ignore_on_isolate
;
480 /* Did the last condition check succeed? */
481 bool condition_result
;
484 /* Is this a transient unit? */
487 /* Is this a unit that is always running and cannot be stopped? */
490 /* Booleans indicating membership of this unit in the various queues */
491 bool in_load_queue
:1;
492 bool in_dbus_queue
:1;
493 bool in_cleanup_queue
:1;
495 bool in_cgroup_realize_queue
:1;
496 bool in_cgroup_empty_queue
:1;
497 bool in_cgroup_oom_queue
:1;
498 bool in_target_deps_queue
:1;
499 bool in_stop_when_unneeded_queue
:1;
500 bool in_start_when_upheld_queue
:1;
501 bool in_stop_when_bound_queue
:1;
502 bool in_release_resources_queue
:1;
504 bool sent_dbus_new_signal
:1;
506 bool job_running_timeout_set
:1;
511 bool cgroup_realized
:1;
512 bool cgroup_members_mask_valid
:1;
514 /* Reset cgroup accounting next time we fork something off */
515 bool reset_accounting
:1;
517 bool start_limit_hit
:1;
519 /* Did we already invoke unit_coldplug() for this unit? */
522 /* For transient units: whether to add a bus track reference after creating the unit */
523 bool bus_track_add
:1;
525 /* Remember which unit state files we created */
526 bool exported_invocation_id
:1;
527 bool exported_log_level_max
:1;
528 bool exported_log_extra_fields
:1;
529 bool exported_log_ratelimit_interval
:1;
530 bool exported_log_ratelimit_burst
:1;
532 /* Whether we warned about clamping the CPU quota period */
533 bool warned_clamping_cpu_quota_period
:1;
535 /* When writing transient unit files, stores which section we stored last. If < 0, we didn't write any yet. If
536 * == 0 we are in the [Unit] section, if > 0 we are in the unit type-specific section. */
537 signed int last_section_private
:2;
540 typedef struct UnitStatusMessageFormats
{
541 const char *starting_stopping
[2];
542 const char *finished_start_job
[_JOB_RESULT_MAX
];
543 const char *finished_stop_job
[_JOB_RESULT_MAX
];
544 /* If this entry is present, it'll be called to provide a context-dependent format string,
545 * or NULL to fall back to finished_{start,stop}_job; if those are NULL too, fall back to generic. */
546 const char *(*finished_job
)(Unit
*u
, JobType t
, JobResult result
);
547 } UnitStatusMessageFormats
;
549 /* Flags used when writing drop-in files or transient unit files */
550 typedef enum UnitWriteFlags
{
551 /* Write a runtime unit file or drop-in (i.e. one below /run) */
552 UNIT_RUNTIME
= 1 << 0,
554 /* Write a persistent drop-in (i.e. one below /etc) */
555 UNIT_PERSISTENT
= 1 << 1,
557 /* Place this item in the per-unit-type private section, instead of [Unit] */
558 UNIT_PRIVATE
= 1 << 2,
560 /* Apply specifier escaping */
561 UNIT_ESCAPE_SPECIFIERS
= 1 << 3,
563 /* Escape elements of ExecStart= syntax, incl. prevention of variable expansion */
564 UNIT_ESCAPE_EXEC_SYNTAX_ENV
= 1 << 4,
566 /* Escape elements of ExecStart=: syntax (no variable expansion) */
567 UNIT_ESCAPE_EXEC_SYNTAX
= 1 << 5,
569 /* Apply C escaping before writing */
570 UNIT_ESCAPE_C
= 1 << 6,
573 /* Returns true if neither persistent, nor runtime storage is requested, i.e. this is a check invocation only */
574 static inline bool UNIT_WRITE_FLAGS_NOOP(UnitWriteFlags flags
) {
575 return (flags
& (UNIT_RUNTIME
|UNIT_PERSISTENT
)) == 0;
580 typedef struct UnitVTable
{
581 /* How much memory does an object of this unit type need */
584 /* If greater than 0, the offset into the object where
585 * ExecContext is found, if the unit type has that */
586 size_t exec_context_offset
;
588 /* If greater than 0, the offset into the object where
589 * CGroupContext is found, if the unit type has that */
590 size_t cgroup_context_offset
;
592 /* If greater than 0, the offset into the object where
593 * KillContext is found, if the unit type has that */
594 size_t kill_context_offset
;
596 /* If greater than 0, the offset into the object where the
597 * pointer to ExecSharedRuntime is found, if the unit type has
599 size_t exec_runtime_offset
;
601 /* The name of the configuration file section with the private settings of this unit */
602 const char *private_section
;
604 /* Config file sections this unit type understands, separated
606 const char *sections
;
608 /* This should reset all type-specific variables. This should
609 * not allocate memory, and is called with zero-initialized
610 * data. It should hence only initialize variables that need
612 void (*init
)(Unit
*u
);
614 /* This should free all type-specific variables. It should be
616 void (*done
)(Unit
*u
);
618 /* Actually load data from disk. This may fail, and should set
619 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
620 * UNIT_STUB if no configuration could be found. */
621 int (*load
)(Unit
*u
);
623 /* During deserialization we only record the intended state to return to. With coldplug() we actually put the
624 * deserialized state in effect. This is where unit_notify() should be called to start things up. Note that
625 * this callback is invoked *before* we leave the reloading state of the manager, i.e. *before* we consider the
626 * reloading to be complete. Thus, this callback should just restore the exact same state for any unit that was
627 * in effect before the reload, i.e. units should not catch up with changes happened during the reload. That's
628 * what catchup() below is for. */
629 int (*coldplug
)(Unit
*u
);
631 /* This is called shortly after all units' coldplug() call was invoked, and *after* the manager left the
632 * reloading state. It's supposed to catch up with state changes due to external events we missed so far (for
633 * example because they took place while we were reloading/reexecing) */
634 void (*catchup
)(Unit
*u
);
636 void (*dump
)(Unit
*u
, FILE *f
, const char *prefix
);
638 int (*start
)(Unit
*u
);
639 int (*stop
)(Unit
*u
);
640 int (*reload
)(Unit
*u
);
642 /* Clear out the various runtime/state/cache/logs/configuration data */
643 int (*clean
)(Unit
*u
, ExecCleanMask m
);
645 /* Freeze the unit */
646 int (*freeze
)(Unit
*u
);
647 int (*thaw
)(Unit
*u
);
648 bool (*can_freeze
)(Unit
*u
);
650 /* Return which kind of data can be cleaned */
651 int (*can_clean
)(Unit
*u
, ExecCleanMask
*ret
);
653 bool (*can_reload
)(Unit
*u
);
655 /* Serialize state and file descriptors that should be carried over into the new
656 * instance after reexecution. */
657 int (*serialize
)(Unit
*u
, FILE *f
, FDSet
*fds
);
659 /* Restore one item from the serialization */
660 int (*deserialize_item
)(Unit
*u
, const char *key
, const char *data
, FDSet
*fds
);
662 /* Try to match up fds with what we need for this unit */
663 void (*distribute_fds
)(Unit
*u
, FDSet
*fds
);
665 /* Boils down the more complex internal state of this unit to
666 * a simpler one that the engine can understand */
667 UnitActiveState (*active_state
)(Unit
*u
);
669 /* Returns the substate specific to this unit type as
670 * string. This is purely information so that we can give the
671 * user a more fine grained explanation in which actual state a
673 const char* (*sub_state_to_string
)(Unit
*u
);
675 /* Additionally to UnitActiveState determine whether unit is to be restarted. */
676 bool (*will_restart
)(Unit
*u
);
678 /* Return false when there is a reason to prevent this unit from being gc'ed
679 * even though nothing references it and it isn't active in any way. */
680 bool (*may_gc
)(Unit
*u
);
682 /* Return true when the unit is not controlled by the manager (e.g. extrinsic mounts). */
683 bool (*is_extrinsic
)(Unit
*u
);
685 /* When the unit is not running and no job for it queued we shall release its runtime resources */
686 void (*release_resources
)(Unit
*u
);
688 /* Invoked on every child that died */
689 void (*sigchld_event
)(Unit
*u
, pid_t pid
, int code
, int status
);
691 /* Reset failed state if we are in failed state */
692 void (*reset_failed
)(Unit
*u
);
694 /* Called whenever any of the cgroups this unit watches for ran empty */
695 void (*notify_cgroup_empty
)(Unit
*u
);
697 /* Called whenever an OOM kill event on this unit was seen */
698 void (*notify_cgroup_oom
)(Unit
*u
, bool managed_oom
);
700 /* Called whenever a process of this unit sends us a message */
701 void (*notify_message
)(Unit
*u
, const struct ucred
*ucred
, char * const *tags
, FDSet
*fds
);
703 /* Called whenever a name this Unit registered for comes or goes away. */
704 void (*bus_name_owner_change
)(Unit
*u
, const char *new_owner
);
706 /* Called for each property that is being set */
707 int (*bus_set_property
)(Unit
*u
, const char *name
, sd_bus_message
*message
, UnitWriteFlags flags
, sd_bus_error
*error
);
709 /* Called after at least one property got changed to apply the necessary change */
710 int (*bus_commit_properties
)(Unit
*u
);
712 /* Return the unit this unit is following */
713 Unit
*(*following
)(Unit
*u
);
715 /* Return the set of units that are following each other */
716 int (*following_set
)(Unit
*u
, Set
**s
);
718 /* Invoked each time a unit this unit is triggering changes
719 * state or gains/loses a job */
720 void (*trigger_notify
)(Unit
*u
, Unit
*trigger
);
722 /* Called whenever CLOCK_REALTIME made a jump */
723 void (*time_change
)(Unit
*u
);
725 /* Called whenever /etc/localtime was modified */
726 void (*timezone_change
)(Unit
*u
);
728 /* Returns the next timeout of a unit */
729 int (*get_timeout
)(Unit
*u
, usec_t
*timeout
);
731 /* Returns the start timeout of a unit */
732 usec_t (*get_timeout_start_usec
)(Unit
*u
);
734 /* Returns the main PID if there is any defined, or 0. */
735 PidRef
* (*main_pid
)(Unit
*u
);
737 /* Returns the control PID if there is any defined, or 0. */
738 PidRef
* (*control_pid
)(Unit
*u
);
740 /* Returns true if the unit currently needs access to the console */
741 bool (*needs_console
)(Unit
*u
);
743 /* Returns the exit status to propagate in case of FailureAction=exit/SuccessAction=exit; usually returns the
744 * exit code of the "main" process of the service or similar. */
745 int (*exit_status
)(Unit
*u
);
747 /* Return a copy of the status string pointer. */
748 const char* (*status_text
)(Unit
*u
);
750 /* Like the enumerate() callback further down, but only enumerates the perpetual units, i.e. all units that
751 * unconditionally exist and are always active. The main reason to keep both enumeration functions separate is
752 * philosophical: the state of perpetual units should be put in place by coldplug(), while the state of those
753 * discovered through regular enumeration should be put in place by catchup(), see below. */
754 void (*enumerate_perpetual
)(Manager
*m
);
756 /* This is called for each unit type and should be used to enumerate units already existing in the system
757 * internally and load them. However, everything that is loaded here should still stay in inactive state. It is
758 * the job of the catchup() call above to put the units into the discovered state. */
759 void (*enumerate
)(Manager
*m
);
761 /* Type specific cleanups. */
762 void (*shutdown
)(Manager
*m
);
764 /* If this function is set and returns false all jobs for units
765 * of this type will immediately fail. */
766 bool (*supported
)(void);
768 /* If this function is set, it's invoked first as part of starting a unit to allow start rate
769 * limiting checks to occur before we do anything else. */
770 int (*can_start
)(Unit
*u
);
772 /* Returns > 0 if the whole subsystem is ratelimited, and new start operations should not be started
773 * for this unit type right now. */
774 int (*subsystem_ratelimited
)(Manager
*m
);
776 /* The strings to print in status messages */
777 UnitStatusMessageFormats status_message_formats
;
779 /* True if transient units of this type are OK */
782 /* True if cgroup delegation is permissible */
785 /* True if the unit type triggers other units, i.e. can have a UNIT_TRIGGERS dependency */
788 /* True if the unit type knows a failure state, and thus can be source of an OnFailure= dependency */
791 /* True if units of this type shall be startable only once and then never again */
794 /* Do not serialize this unit when preparing for root switch */
795 bool exclude_from_switch_root_serialization
;
797 /* True if queued jobs of this type should be GC'ed if no other job needs them anymore */
800 /* True if systemd-oomd can monitor and act on this unit's recursive children's cgroups */
801 bool can_set_managed_oom
;
803 /* If true, we'll notify plymouth about this unit */
804 bool notify_plymouth
;
806 /* The audit events to generate on start + stop (or 0 if none shall be generated) */
807 int audit_start_message_type
;
808 int audit_stop_message_type
;
811 extern const UnitVTable
* const unit_vtable
[_UNIT_TYPE_MAX
];
813 static inline const UnitVTable
* UNIT_VTABLE(const Unit
*u
) {
814 return unit_vtable
[u
->type
];
817 /* For casting a unit into the various unit types */
818 #define DEFINE_CAST(UPPERCASE, MixedCase) \
819 static inline MixedCase* UPPERCASE(Unit *u) { \
820 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
823 return (MixedCase*) u; \
826 /* For casting the various unit types into a unit */
829 typeof(u) _u_ = (u); \
830 Unit *_w_ = _u_ ? &(_u_)->meta : NULL; \
834 #define UNIT_HAS_EXEC_CONTEXT(u) (UNIT_VTABLE(u)->exec_context_offset > 0)
835 #define UNIT_HAS_CGROUP_CONTEXT(u) (UNIT_VTABLE(u)->cgroup_context_offset > 0)
836 #define UNIT_HAS_KILL_CONTEXT(u) (UNIT_VTABLE(u)->kill_context_offset > 0)
838 Unit
* unit_has_dependency(const Unit
*u
, UnitDependencyAtom atom
, Unit
*other
);
839 int unit_get_dependency_array(const Unit
*u
, UnitDependencyAtom atom
, Unit
***ret_array
);
840 int unit_get_transitive_dependency_set(Unit
*u
, UnitDependencyAtom atom
, Set
**ret
);
842 static inline Hashmap
* unit_get_dependencies(Unit
*u
, UnitDependency d
) {
843 return hashmap_get(u
->dependencies
, UNIT_DEPENDENCY_TO_PTR(d
));
846 static inline Unit
* UNIT_TRIGGER(Unit
*u
) {
847 return unit_has_dependency(u
, UNIT_ATOM_TRIGGERS
, NULL
);
850 static inline Unit
* UNIT_GET_SLICE(const Unit
*u
) {
851 return unit_has_dependency(u
, UNIT_ATOM_IN_SLICE
, NULL
);
854 Unit
* unit_new(Manager
*m
, size_t size
);
855 Unit
* unit_free(Unit
*u
);
856 DEFINE_TRIVIAL_CLEANUP_FUNC(Unit
*, unit_free
);
858 int unit_new_for_name(Manager
*m
, size_t size
, const char *name
, Unit
**ret
);
859 int unit_add_name(Unit
*u
, const char *name
);
861 int unit_add_dependency(Unit
*u
, UnitDependency d
, Unit
*other
, bool add_reference
, UnitDependencyMask mask
);
862 int unit_add_two_dependencies(Unit
*u
, UnitDependency d
, UnitDependency e
, Unit
*other
, bool add_reference
, UnitDependencyMask mask
);
864 int unit_add_dependency_by_name(Unit
*u
, UnitDependency d
, const char *name
, bool add_reference
, UnitDependencyMask mask
);
865 int unit_add_two_dependencies_by_name(Unit
*u
, UnitDependency d
, UnitDependency e
, const char *name
, bool add_reference
, UnitDependencyMask mask
);
867 int unit_add_exec_dependencies(Unit
*u
, ExecContext
*c
);
869 int unit_choose_id(Unit
*u
, const char *name
);
870 int unit_set_description(Unit
*u
, const char *description
);
872 void unit_release_resources(Unit
*u
);
874 bool unit_may_gc(Unit
*u
);
876 static inline bool unit_is_extrinsic(Unit
*u
) {
877 return u
->perpetual
||
878 (UNIT_VTABLE(u
)->is_extrinsic
&& UNIT_VTABLE(u
)->is_extrinsic(u
));
881 static inline const char* unit_status_text(Unit
*u
) {
882 if (u
&& UNIT_VTABLE(u
)->status_text
)
883 return UNIT_VTABLE(u
)->status_text(u
);
887 void unit_add_to_load_queue(Unit
*u
);
888 void unit_add_to_dbus_queue(Unit
*u
);
889 void unit_add_to_cleanup_queue(Unit
*u
);
890 void unit_add_to_gc_queue(Unit
*u
);
891 void unit_add_to_target_deps_queue(Unit
*u
);
892 void unit_submit_to_stop_when_unneeded_queue(Unit
*u
);
893 void unit_submit_to_start_when_upheld_queue(Unit
*u
);
894 void unit_submit_to_stop_when_bound_queue(Unit
*u
);
895 void unit_submit_to_release_resources_queue(Unit
*u
);
897 int unit_merge(Unit
*u
, Unit
*other
);
898 int unit_merge_by_name(Unit
*u
, const char *other
);
900 Unit
*unit_follow_merge(Unit
*u
) _pure_
;
902 int unit_load_fragment_and_dropin(Unit
*u
, bool fragment_required
);
903 int unit_load(Unit
*unit
);
905 int unit_set_slice(Unit
*u
, Unit
*slice
);
906 int unit_set_default_slice(Unit
*u
);
908 const char *unit_description(Unit
*u
) _pure_
;
909 const char *unit_status_string(Unit
*u
, char **combined
);
911 bool unit_has_name(const Unit
*u
, const char *name
);
913 UnitActiveState
unit_active_state(Unit
*u
);
914 FreezerState
unit_freezer_state(Unit
*u
);
915 int unit_freezer_state_kernel(Unit
*u
, FreezerState
*ret
);
917 const char* unit_sub_state_to_string(Unit
*u
);
919 bool unit_can_reload(Unit
*u
) _pure_
;
920 bool unit_can_start(Unit
*u
) _pure_
;
921 bool unit_can_stop(Unit
*u
) _pure_
;
922 bool unit_can_isolate(Unit
*u
) _pure_
;
924 int unit_start(Unit
*u
, ActivationDetails
*details
);
925 int unit_stop(Unit
*u
);
926 int unit_reload(Unit
*u
);
928 int unit_kill(Unit
*u
, KillWho w
, int signo
, int code
, int value
, sd_bus_error
*error
);
930 void unit_notify_cgroup_oom(Unit
*u
, bool managed_oom
);
932 void unit_notify(Unit
*u
, UnitActiveState os
, UnitActiveState ns
, bool reload_success
);
934 int unit_watch_pidref(Unit
*u
, PidRef
*pid
, bool exclusive
);
935 int unit_watch_pid(Unit
*u
, pid_t pid
, bool exclusive
);
936 void unit_unwatch_pidref(Unit
*u
, PidRef
*pid
);
937 void unit_unwatch_pid(Unit
*u
, pid_t pid
);
938 void unit_unwatch_all_pids(Unit
*u
);
940 int unit_enqueue_rewatch_pids(Unit
*u
);
941 void unit_dequeue_rewatch_pids(Unit
*u
);
943 int unit_install_bus_match(Unit
*u
, sd_bus
*bus
, const char *name
);
944 int unit_watch_bus_name(Unit
*u
, const char *name
);
945 void unit_unwatch_bus_name(Unit
*u
, const char *name
);
947 bool unit_job_is_applicable(Unit
*u
, JobType j
);
949 int set_unit_path(const char *p
);
951 char *unit_dbus_path(Unit
*u
);
952 char *unit_dbus_path_invocation_id(Unit
*u
);
954 int unit_load_related_unit(Unit
*u
, const char *type
, Unit
**_found
);
956 int unit_add_node_dependency(Unit
*u
, const char *what
, UnitDependency d
, UnitDependencyMask mask
);
957 int unit_add_blockdev_dependency(Unit
*u
, const char *what
, UnitDependencyMask mask
);
959 int unit_coldplug(Unit
*u
);
960 void unit_catchup(Unit
*u
);
962 void unit_status_printf(Unit
*u
, StatusType status_type
, const char *status
, const char *format
, const char *ident
) _printf_(4, 0);
964 bool unit_need_daemon_reload(Unit
*u
);
966 void unit_reset_failed(Unit
*u
);
968 Unit
*unit_following(Unit
*u
);
969 int unit_following_set(Unit
*u
, Set
**s
);
971 const char *unit_slice_name(Unit
*u
);
973 bool unit_stop_pending(Unit
*u
) _pure_
;
974 bool unit_inactive_or_pending(Unit
*u
) _pure_
;
975 bool unit_active_or_pending(Unit
*u
);
976 bool unit_will_restart_default(Unit
*u
);
977 bool unit_will_restart(Unit
*u
);
979 int unit_add_default_target_dependency(Unit
*u
, Unit
*target
);
981 void unit_start_on_failure(Unit
*u
, const char *dependency_name
, UnitDependencyAtom atom
, JobMode job_mode
);
982 void unit_trigger_notify(Unit
*u
);
984 UnitFileState
unit_get_unit_file_state(Unit
*u
);
985 PresetAction
unit_get_unit_file_preset(Unit
*u
);
987 Unit
* unit_ref_set(UnitRef
*ref
, Unit
*source
, Unit
*target
);
988 void unit_ref_unset(UnitRef
*ref
);
990 #define UNIT_DEREF(ref) ((ref).target)
991 #define UNIT_ISSET(ref) (!!(ref).target)
993 int unit_patch_contexts(Unit
*u
);
995 ExecContext
*unit_get_exec_context(const Unit
*u
) _pure_
;
996 KillContext
*unit_get_kill_context(Unit
*u
) _pure_
;
997 CGroupContext
*unit_get_cgroup_context(Unit
*u
) _pure_
;
999 ExecRuntime
*unit_get_exec_runtime(Unit
*u
) _pure_
;
1001 int unit_setup_exec_runtime(Unit
*u
);
1003 const char* unit_escape_setting(const char *s
, UnitWriteFlags flags
, char **buf
);
1004 char* unit_concat_strv(char **l
, UnitWriteFlags flags
);
1006 int unit_write_setting(Unit
*u
, UnitWriteFlags flags
, const char *name
, const char *data
);
1007 int unit_write_settingf(Unit
*u
, UnitWriteFlags mode
, const char *name
, const char *format
, ...) _printf_(4,5);
1009 int unit_kill_context(Unit
*u
, KillContext
*c
, KillOperation k
, PidRef
*main_pid
, PidRef
*control_pid
, bool main_pid_alien
);
1011 int unit_make_transient(Unit
*u
);
1013 int unit_add_mounts_for(Unit
*u
, const char *path
, UnitDependencyMask mask
, UnitMountDependencyType type
);
1015 bool unit_type_supported(UnitType t
);
1017 bool unit_is_pristine(Unit
*u
);
1019 bool unit_is_unneeded(Unit
*u
);
1020 bool unit_is_upheld_by_active(Unit
*u
, Unit
**ret_culprit
);
1021 bool unit_is_bound_by_inactive(Unit
*u
, Unit
**ret_culprit
);
1023 PidRef
* unit_control_pid(Unit
*u
);
1024 PidRef
* unit_main_pid(Unit
*u
);
1026 void unit_warn_if_dir_nonempty(Unit
*u
, const char* where
);
1027 int unit_fail_if_noncanonical(Unit
*u
, const char* where
);
1029 int unit_test_start_limit(Unit
*u
);
1031 int unit_ref_uid_gid(Unit
*u
, uid_t uid
, gid_t gid
);
1032 void unit_unref_uid_gid(Unit
*u
, bool destroy_now
);
1034 void unit_notify_user_lookup(Unit
*u
, uid_t uid
, gid_t gid
);
1036 int unit_set_invocation_id(Unit
*u
, sd_id128_t id
);
1037 int unit_acquire_invocation_id(Unit
*u
);
1039 int unit_set_exec_params(Unit
*s
, ExecParameters
*p
);
1041 int unit_fork_helper_process(Unit
*u
, const char *name
, PidRef
*ret
);
1042 int unit_fork_and_watch_rm_rf(Unit
*u
, char **paths
, PidRef
*ret
);
1044 void unit_remove_dependencies(Unit
*u
, UnitDependencyMask mask
);
1046 void unit_export_state_files(Unit
*u
);
1047 void unit_unlink_state_files(Unit
*u
);
1049 int unit_prepare_exec(Unit
*u
);
1051 int unit_log_leftover_process_start(const PidRef
* pid
, int sig
, void *userdata
);
1052 int unit_log_leftover_process_stop(const PidRef
* pid
, int sig
, void *userdata
);
1054 int unit_warn_leftover_processes(Unit
*u
, cg_kill_log_func_t log_func
);
1056 bool unit_needs_console(Unit
*u
);
1058 int unit_pid_attachable(Unit
*unit
, PidRef
*pid
, sd_bus_error
*error
);
1060 static inline bool unit_has_job_type(Unit
*u
, JobType type
) {
1061 return u
&& u
->job
&& u
->job
->type
== type
;
1064 static inline bool unit_log_level_test(const Unit
*u
, int level
) {
1065 ExecContext
*ec
= unit_get_exec_context(u
);
1066 return !ec
|| ec
->log_level_max
< 0 || ec
->log_level_max
>= LOG_PRI(level
);
1069 /* unit_log_skip is for cases like ExecCondition= where a unit is considered "done"
1070 * after some execution, rather than succeeded or failed. */
1071 void unit_log_skip(Unit
*u
, const char *result
);
1072 void unit_log_success(Unit
*u
);
1073 void unit_log_failure(Unit
*u
, const char *result
);
1074 static inline void unit_log_result(Unit
*u
, bool success
, const char *result
) {
1076 unit_log_success(u
);
1078 unit_log_failure(u
, result
);
1081 void unit_log_process_exit(Unit
*u
, const char *kind
, const char *command
, bool success
, int code
, int status
);
1083 int unit_exit_status(Unit
*u
);
1084 int unit_success_action_exit_status(Unit
*u
);
1085 int unit_failure_action_exit_status(Unit
*u
);
1087 int unit_test_trigger_loaded(Unit
*u
);
1089 void unit_destroy_runtime_data(Unit
*u
, const ExecContext
*context
);
1090 int unit_clean(Unit
*u
, ExecCleanMask mask
);
1091 int unit_can_clean(Unit
*u
, ExecCleanMask
*ret_mask
);
1093 bool unit_can_start_refuse_manual(Unit
*u
);
1094 bool unit_can_stop_refuse_manual(Unit
*u
);
1095 bool unit_can_isolate_refuse_manual(Unit
*u
);
1097 bool unit_can_freeze(Unit
*u
);
1098 int unit_freeze(Unit
*u
);
1099 void unit_frozen(Unit
*u
);
1101 int unit_thaw(Unit
*u
);
1102 void unit_thawed(Unit
*u
);
1104 int unit_freeze_vtable_common(Unit
*u
);
1105 int unit_thaw_vtable_common(Unit
*u
);
1107 Condition
*unit_find_failed_condition(Unit
*u
);
1109 int unit_arm_timer(Unit
*u
, sd_event_source
**source
, bool relative
, usec_t usec
, sd_event_time_handler_t handler
);
1111 int unit_compare_priority(Unit
*a
, Unit
*b
);
1113 UnitMountDependencyType
unit_mount_dependency_type_from_string(const char *s
) _const_
;
1114 const char* unit_mount_dependency_type_to_string(UnitMountDependencyType t
) _const_
;
1115 UnitDependency
unit_mount_dependency_type_to_dependency_type(UnitMountDependencyType t
) _pure_
;
1117 /* Macros which append UNIT= or USER_UNIT= to the message */
1119 #define log_unit_full_errno_zerook(unit, level, error, ...) \
1121 const Unit *_u = (unit); \
1122 const int _l = (level); \
1123 bool _do_log = !(log_get_max_level() < LOG_PRI(_l) || \
1124 (_u && !unit_log_level_test(_u, _l))); \
1125 const ExecContext *_c = _do_log && _u ? \
1126 unit_get_exec_context(_u) : NULL; \
1127 LOG_CONTEXT_PUSH_IOV(_c ? _c->log_extra_fields : NULL, \
1128 _c ? _c->n_log_extra_fields : 0); \
1129 !_do_log ? -ERRNO_VALUE(error) : \
1130 _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__) : \
1131 log_internal(_l, error, PROJECT_FILE, __LINE__, __func__, ##__VA_ARGS__); \
1134 #define log_unit_full_errno(unit, level, error, ...) \
1136 int _error = (error); \
1137 ASSERT_NON_ZERO(_error); \
1138 log_unit_full_errno_zerook(unit, level, _error, ##__VA_ARGS__); \
1141 #define log_unit_full(unit, level, ...) (void) log_unit_full_errno_zerook(unit, level, 0, __VA_ARGS__)
1143 #define log_unit_debug(unit, ...) log_unit_full(unit, LOG_DEBUG, __VA_ARGS__)
1144 #define log_unit_info(unit, ...) log_unit_full(unit, LOG_INFO, __VA_ARGS__)
1145 #define log_unit_notice(unit, ...) log_unit_full(unit, LOG_NOTICE, __VA_ARGS__)
1146 #define log_unit_warning(unit, ...) log_unit_full(unit, LOG_WARNING, __VA_ARGS__)
1147 #define log_unit_error(unit, ...) log_unit_full(unit, LOG_ERR, __VA_ARGS__)
1149 #define log_unit_debug_errno(unit, error, ...) log_unit_full_errno(unit, LOG_DEBUG, error, __VA_ARGS__)
1150 #define log_unit_info_errno(unit, error, ...) log_unit_full_errno(unit, LOG_INFO, error, __VA_ARGS__)
1151 #define log_unit_notice_errno(unit, error, ...) log_unit_full_errno(unit, LOG_NOTICE, error, __VA_ARGS__)
1152 #define log_unit_warning_errno(unit, error, ...) log_unit_full_errno(unit, LOG_WARNING, error, __VA_ARGS__)
1153 #define log_unit_error_errno(unit, error, ...) log_unit_full_errno(unit, LOG_ERR, error, __VA_ARGS__)
1156 # define log_unit_trace(...) log_unit_debug(__VA_ARGS__)
1157 # define log_unit_trace_errno(...) log_unit_debug_errno(__VA_ARGS__)
1159 # define log_unit_trace(...) do {} while (0)
1160 # define log_unit_trace_errno(e, ...) (-ERRNO_VALUE(e))
1163 #define log_unit_struct_errno(unit, level, error, ...) \
1165 const Unit *_u = (unit); \
1166 const int _l = (level); \
1167 bool _do_log = unit_log_level_test(_u, _l); \
1168 const ExecContext *_c = _do_log && _u ? \
1169 unit_get_exec_context(_u) : NULL; \
1170 LOG_CONTEXT_PUSH_IOV(_c ? _c->log_extra_fields : NULL, \
1171 _c ? _c->n_log_extra_fields : 0); \
1173 log_struct_errno(_l, error, __VA_ARGS__, LOG_UNIT_ID(_u)) : \
1174 -ERRNO_VALUE(error); \
1177 #define log_unit_struct(unit, level, ...) log_unit_struct_errno(unit, level, 0, __VA_ARGS__)
1179 #define log_unit_struct_iovec_errno(unit, level, error, iovec, n_iovec) \
1181 const Unit *_u = (unit); \
1182 const int _l = (level); \
1183 bool _do_log = unit_log_level_test(_u, _l); \
1184 const ExecContext *_c = _do_log && _u ? \
1185 unit_get_exec_context(_u) : NULL; \
1186 LOG_CONTEXT_PUSH_IOV(_c ? _c->log_extra_fields : NULL, \
1187 _c ? _c->n_log_extra_fields : 0); \
1189 log_struct_iovec_errno(_l, error, iovec, n_iovec) : \
1190 -ERRNO_VALUE(error); \
1193 #define log_unit_struct_iovec(unit, level, iovec, n_iovec) log_unit_struct_iovec_errno(unit, level, 0, iovec, n_iovec)
1195 /* Like LOG_MESSAGE(), but with the unit name prefixed. */
1196 #define LOG_UNIT_MESSAGE(unit, fmt, ...) LOG_MESSAGE("%s: " fmt, (unit)->id, ##__VA_ARGS__)
1197 #define LOG_UNIT_ID(unit) (unit)->manager->unit_log_format_string, (unit)->id
1198 #define LOG_UNIT_INVOCATION_ID(unit) (unit)->manager->invocation_log_format_string, (unit)->invocation_id_string
1200 const char* collect_mode_to_string(CollectMode m
) _const_
;
1201 CollectMode
collect_mode_from_string(const char *s
) _pure_
;
1203 typedef struct UnitForEachDependencyData
{
1204 /* Stores state for the FOREACH macro below for iterating through all deps that have any of the
1205 * specified dependency atom bits set */
1206 UnitDependencyAtom match_atom
;
1207 Hashmap
*by_type
, *by_unit
;
1209 Iterator by_type_iterator
, by_unit_iterator
;
1210 Unit
**current_unit
;
1211 } UnitForEachDependencyData
;
1213 /* Iterates through all dependencies that have a specific atom in the dependency type set. This tries to be
1214 * smart: if the atom is unique, we'll directly go to right entry. Otherwise we'll iterate through the
1215 * per-dependency type hashmap and match all dep that have the right atom set. */
1216 #define _UNIT_FOREACH_DEPENDENCY(other, u, ma, data) \
1217 for (UnitForEachDependencyData data = { \
1218 .match_atom = (ma), \
1219 .by_type = (u)->dependencies, \
1220 .by_type_iterator = ITERATOR_FIRST, \
1221 .current_unit = &(other), \
1224 UnitDependency _dt = _UNIT_DEPENDENCY_INVALID; \
1227 if (data.by_type && ITERATOR_IS_FIRST(data.by_type_iterator)) { \
1228 _dt = unit_dependency_from_unique_atom(data.match_atom); \
1230 data.by_unit = hashmap_get(data.by_type, UNIT_DEPENDENCY_TO_PTR(_dt)); \
1231 data.current_type = UNIT_DEPENDENCY_TO_PTR(_dt); \
1232 data.by_type = NULL; \
1233 _found = !!data.by_unit; \
1237 _found = hashmap_iterate(data.by_type, \
1238 &data.by_type_iterator, \
1239 (void**)&(data.by_unit), \
1240 (const void**) &(data.current_type)); \
1243 if ((unit_dependency_to_atom(UNIT_DEPENDENCY_FROM_PTR(data.current_type)) & data.match_atom) != 0) \
1244 for (data.by_unit_iterator = ITERATOR_FIRST; \
1245 hashmap_iterate(data.by_unit, \
1246 &data.by_unit_iterator, \
1248 (const void**) data.current_unit); )
1250 /* Note: this matches deps that have *any* of the atoms specified in match_atom set */
1251 #define UNIT_FOREACH_DEPENDENCY(other, u, match_atom) \
1252 _UNIT_FOREACH_DEPENDENCY(other, u, match_atom, UNIQ_T(data, UNIQ))
1254 #define _LOG_CONTEXT_PUSH_UNIT(unit, u, c) \
1255 const Unit *u = (unit); \
1256 const ExecContext *c = unit_get_exec_context(u); \
1257 LOG_CONTEXT_PUSH_KEY_VALUE(u->manager->unit_log_field, u->id); \
1258 LOG_CONTEXT_PUSH_KEY_VALUE(u->manager->invocation_log_field, u->invocation_id_string); \
1259 LOG_CONTEXT_PUSH_IOV(c ? c->log_extra_fields : NULL, c ? c->n_log_extra_fields : 0)
1261 #define LOG_CONTEXT_PUSH_UNIT(unit) \
1262 _LOG_CONTEXT_PUSH_UNIT(unit, UNIQ_T(u, UNIQ), UNIQ_T(c, UNIQ))