1 /* SPDX-License-Identifier: LGPL-2.1+ */
8 #include "bpf-program.h"
10 #include "emergency-action.h"
13 #include "unit-file.h"
16 typedef struct UnitRef UnitRef
;
18 typedef enum KillOperation
{
20 KILL_TERMINATE_AND_LOG
,
24 _KILL_OPERATION_INVALID
= -1
27 typedef enum CollectMode
{
29 COLLECT_INACTIVE_OR_FAILED
,
31 _COLLECT_MODE_INVALID
= -1,
34 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t
) {
35 return IN_SET(t
, UNIT_ACTIVE
, UNIT_RELOADING
);
38 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t
) {
39 return IN_SET(t
, UNIT_ACTIVE
, UNIT_ACTIVATING
, UNIT_RELOADING
);
42 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t
) {
43 return IN_SET(t
, UNIT_INACTIVE
, UNIT_FAILED
, UNIT_DEACTIVATING
);
46 static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t
) {
47 return IN_SET(t
, UNIT_INACTIVE
, UNIT_FAILED
);
50 /* Stores the 'reason' a dependency was created as a bit mask, i.e. due to which configuration source it came to be. We
51 * use this so that we can selectively flush out parts of dependencies again. Note that the same dependency might be
52 * created as a result of multiple "reasons", hence the bitmask. */
53 typedef enum UnitDependencyMask
{
54 /* Configured directly by the unit file, .wants/.requires symlink or drop-in, or as an immediate result of a
55 * non-dependency option configured that way. */
56 UNIT_DEPENDENCY_FILE
= 1 << 0,
58 /* As unconditional implicit dependency (not affected by unit configuration — except by the unit name and
60 UNIT_DEPENDENCY_IMPLICIT
= 1 << 1,
62 /* A dependency effected by DefaultDependencies=yes. Note that dependencies marked this way are conceptually
63 * just a subset of UNIT_DEPENDENCY_FILE, as DefaultDependencies= is itself a unit file setting that can only
64 * be set in unit files. We make this two separate bits only to help debugging how dependencies came to be. */
65 UNIT_DEPENDENCY_DEFAULT
= 1 << 2,
67 /* A dependency created from udev rules */
68 UNIT_DEPENDENCY_UDEV
= 1 << 3,
70 /* A dependency created because of some unit's RequiresMountsFor= setting */
71 UNIT_DEPENDENCY_PATH
= 1 << 4,
73 /* A dependency created because of data read from /proc/self/mountinfo and no other configuration source */
74 UNIT_DEPENDENCY_MOUNTINFO_IMPLICIT
= 1 << 5,
76 /* A dependency created because of data read from /proc/self/mountinfo, but conditionalized by
77 * DefaultDependencies= and thus also involving configuration from UNIT_DEPENDENCY_FILE sources */
78 UNIT_DEPENDENCY_MOUNTINFO_DEFAULT
= 1 << 6,
80 /* A dependency created because of data read from /proc/swaps and no other configuration source */
81 UNIT_DEPENDENCY_PROC_SWAP
= 1 << 7,
83 _UNIT_DEPENDENCY_MASK_FULL
= (1 << 8) - 1,
86 /* The Unit's dependencies[] hashmaps use this structure as value. It has the same size as a void pointer, and thus can
87 * be stored directly as hashmap value, without any indirection. Note that this stores two masks, as both the origin
88 * and the destination of a dependency might have created it. */
89 typedef union UnitDependencyInfo
{
92 UnitDependencyMask origin_mask
:16;
93 UnitDependencyMask destination_mask
:16;
100 /* Keeps tracks of references to a unit. This is useful so
101 * that we can merge two units if necessary and correct all
102 * references to them */
104 Unit
*source
, *target
;
105 LIST_FIELDS(UnitRef
, refs_by_target
);
108 typedef struct Unit
{
112 UnitLoadState load_state
;
115 char *id
; /* One name is special because we use it for identification. Points to an entry in the names set */
120 /* For each dependency type we maintain a Hashmap whose key is the Unit* object, and the value encodes why the
121 * dependency exists, using the UnitDependencyInfo type */
122 Hashmap
*dependencies
[_UNIT_DEPENDENCY_MAX
];
124 /* Similar, for RequiresMountsFor= path dependencies. The key is the path, the value the UnitDependencyInfo type */
125 Hashmap
*requires_mounts_for
;
128 char **documentation
;
130 char *fragment_path
; /* if loaded from a config file this is the primary path to it */
131 char *source_path
; /* if converted, the source file */
134 usec_t fragment_mtime
;
138 /* If this is a transient unit we are currently writing, this is where we are writing it to */
139 FILE *transient_file
;
141 /* If there is something to do with this unit, then this is the installed job for it */
144 /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
147 /* The slot used for watching NameOwnerChanged signals */
148 sd_bus_slot
*match_bus_slot
;
150 /* References to this unit from clients */
151 sd_bus_track
*bus_track
;
152 char **deserialized_refs
;
154 /* Job timeout and action to take */
156 usec_t job_running_timeout
;
157 bool job_running_timeout_set
:1;
158 EmergencyAction job_timeout_action
;
159 char *job_timeout_reboot_arg
;
161 /* References to this */
162 LIST_HEAD(UnitRef
, refs_by_target
);
164 /* Conditions to check */
165 LIST_HEAD(Condition
, conditions
);
166 LIST_HEAD(Condition
, asserts
);
168 dual_timestamp condition_timestamp
;
169 dual_timestamp assert_timestamp
;
171 /* Updated whenever the low-level state changes */
172 dual_timestamp state_change_timestamp
;
174 /* Updated whenever the (high-level) active state enters or leaves the active or inactive states */
175 dual_timestamp inactive_exit_timestamp
;
176 dual_timestamp active_enter_timestamp
;
177 dual_timestamp active_exit_timestamp
;
178 dual_timestamp inactive_enter_timestamp
;
183 LIST_FIELDS(Unit
, units_by_type
);
186 LIST_FIELDS(Unit
, load_queue
);
189 LIST_FIELDS(Unit
, dbus_queue
);
192 LIST_FIELDS(Unit
, cleanup_queue
);
195 LIST_FIELDS(Unit
, gc_queue
);
197 /* CGroup realize members queue */
198 LIST_FIELDS(Unit
, cgroup_realize_queue
);
200 /* cgroup empty queue */
201 LIST_FIELDS(Unit
, cgroup_empty_queue
);
203 /* cgroup OOM queue */
204 LIST_FIELDS(Unit
, cgroup_oom_queue
);
206 /* Target dependencies queue */
207 LIST_FIELDS(Unit
, target_deps_queue
);
209 /* Queue of units with StopWhenUnneeded set that shell be checked for clean-up. */
210 LIST_FIELDS(Unit
, stop_when_unneeded_queue
);
212 /* PIDs we keep an eye on. Note that a unit might have many
213 * more, but these are the ones we care enough about to
214 * process SIGCHLD for */
217 /* Used in SIGCHLD and sd_notify() message event invocation logic to avoid that we dispatch the same event
218 * multiple times on the same unit. */
222 /* Used during GC sweeps */
225 /* Error code when we didn't manage to load the unit (negative) */
228 /* Put a ratelimit on unit starting */
229 RateLimit start_limit
;
230 EmergencyAction start_limit_action
;
232 /* What to do on failure or success */
233 EmergencyAction success_action
, failure_action
;
234 int success_action_exit_status
, failure_action_exit_status
;
237 /* Make sure we never enter endless loops with the check unneeded logic, or the BindsTo= logic */
238 RateLimit auto_stop_ratelimit
;
240 /* Reference to a specific UID/GID */
244 /* Cached unit file state and preset */
245 UnitFileState unit_file_state
;
246 int unit_file_preset
;
248 /* Where the cpu.stat or cpuacct.usage was at the time the unit was started */
249 nsec_t cpu_usage_base
;
250 nsec_t cpu_usage_last
; /* the most recently read value */
252 /* The current counter of the oom_kill field in the memory.events cgroup attribute */
253 uint64_t oom_kill_last
;
255 /* Where the io.stat data was at the time the unit was started */
256 uint64_t io_accounting_base
[_CGROUP_IO_ACCOUNTING_METRIC_MAX
];
257 uint64_t io_accounting_last
[_CGROUP_IO_ACCOUNTING_METRIC_MAX
]; /* the most recently read value */
259 /* Counterparts in the cgroup filesystem */
261 CGroupMask cgroup_realized_mask
; /* In which hierarchies does this unit's cgroup exist? (only relevant on cgroup v1) */
262 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) */
263 CGroupMask cgroup_invalidated_mask
; /* A mask specifying controllers which shall be considered invalidated, and require re-realization */
264 CGroupMask cgroup_members_mask
; /* A cache for the controllers required by all children of this cgroup (only relevant for slice units) */
266 /* Inotify watch descriptors for watching cgroup.events and memory.events on cgroupv2 */
267 int cgroup_control_inotify_wd
;
268 int cgroup_memory_inotify_wd
;
270 /* Device Controller BPF program */
271 BPFProgram
*bpf_device_control_installed
;
273 /* IP BPF Firewalling/accounting */
274 int ip_accounting_ingress_map_fd
;
275 int ip_accounting_egress_map_fd
;
277 int ipv4_allow_map_fd
;
278 int ipv6_allow_map_fd
;
279 int ipv4_deny_map_fd
;
280 int ipv6_deny_map_fd
;
282 BPFProgram
*ip_bpf_ingress
, *ip_bpf_ingress_installed
;
283 BPFProgram
*ip_bpf_egress
, *ip_bpf_egress_installed
;
284 Set
*ip_bpf_custom_ingress
;
285 Set
*ip_bpf_custom_ingress_installed
;
286 Set
*ip_bpf_custom_egress
;
287 Set
*ip_bpf_custom_egress_installed
;
289 uint64_t ip_accounting_extra
[_CGROUP_IP_ACCOUNTING_METRIC_MAX
];
291 /* Low-priority event source which is used to remove watched PIDs that have gone away, and subscribe to any new
292 * ones which might have appeared. */
293 sd_event_source
*rewatch_pids_event_source
;
295 /* How to start OnFailure units */
296 JobMode on_failure_job_mode
;
298 /* Tweaking the GC logic */
299 CollectMode collect_mode
;
301 /* The current invocation ID */
302 sd_id128_t invocation_id
;
303 char invocation_id_string
[SD_ID128_STRING_MAX
]; /* useful when logging */
305 /* Garbage collect us we nobody wants or requires us anymore */
306 bool stop_when_unneeded
;
308 /* Create default dependencies */
309 bool default_dependencies
;
311 /* Refuse manual starting, allow starting only indirectly via dependency. */
312 bool refuse_manual_start
;
314 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
315 bool refuse_manual_stop
;
317 /* Allow isolation requests */
320 /* Ignore this unit when isolating */
321 bool ignore_on_isolate
;
323 /* Did the last condition check succeed? */
324 bool condition_result
;
327 /* Is this a transient unit? */
330 /* Is this a unit that is always running and cannot be stopped? */
333 /* Booleans indicating membership of this unit in the various queues */
334 bool in_load_queue
:1;
335 bool in_dbus_queue
:1;
336 bool in_cleanup_queue
:1;
338 bool in_cgroup_realize_queue
:1;
339 bool in_cgroup_empty_queue
:1;
340 bool in_cgroup_oom_queue
:1;
341 bool in_target_deps_queue
:1;
342 bool in_stop_when_unneeded_queue
:1;
344 bool sent_dbus_new_signal
:1;
349 bool cgroup_realized
:1;
350 bool cgroup_members_mask_valid
:1;
352 /* Reset cgroup accounting next time we fork something off */
353 bool reset_accounting
:1;
355 bool start_limit_hit
:1;
357 /* Did we already invoke unit_coldplug() for this unit? */
360 /* For transient units: whether to add a bus track reference after creating the unit */
361 bool bus_track_add
:1;
363 /* Remember which unit state files we created */
364 bool exported_invocation_id
:1;
365 bool exported_log_level_max
:1;
366 bool exported_log_extra_fields
:1;
367 bool exported_log_rate_limit_interval
:1;
368 bool exported_log_rate_limit_burst
:1;
370 /* Whether we warned about clamping the CPU quota period */
371 bool warned_clamping_cpu_quota_period
:1;
373 /* When writing transient unit files, stores which section we stored last. If < 0, we didn't write any yet. If
374 * == 0 we are in the [Unit] section, if > 0 we are in the unit type-specific section. */
375 signed int last_section_private
:2;
378 typedef struct UnitStatusMessageFormats
{
379 const char *starting_stopping
[2];
380 const char *finished_start_job
[_JOB_RESULT_MAX
];
381 const char *finished_stop_job
[_JOB_RESULT_MAX
];
382 } UnitStatusMessageFormats
;
384 /* Flags used when writing drop-in files or transient unit files */
385 typedef enum UnitWriteFlags
{
386 /* Write a runtime unit file or drop-in (i.e. one below /run) */
387 UNIT_RUNTIME
= 1 << 0,
389 /* Write a persistent drop-in (i.e. one below /etc) */
390 UNIT_PERSISTENT
= 1 << 1,
392 /* Place this item in the per-unit-type private section, instead of [Unit] */
393 UNIT_PRIVATE
= 1 << 2,
395 /* Apply specifier escaping before writing */
396 UNIT_ESCAPE_SPECIFIERS
= 1 << 3,
398 /* Apply C escaping before writing */
399 UNIT_ESCAPE_C
= 1 << 4,
402 /* Returns true if neither persistent, nor runtime storage is requested, i.e. this is a check invocation only */
403 static inline bool UNIT_WRITE_FLAGS_NOOP(UnitWriteFlags flags
) {
404 return (flags
& (UNIT_RUNTIME
|UNIT_PERSISTENT
)) == 0;
409 typedef struct UnitVTable
{
410 /* How much memory does an object of this unit type need */
413 /* If greater than 0, the offset into the object where
414 * ExecContext is found, if the unit type has that */
415 size_t exec_context_offset
;
417 /* If greater than 0, the offset into the object where
418 * CGroupContext is found, if the unit type has that */
419 size_t cgroup_context_offset
;
421 /* If greater than 0, the offset into the object where
422 * KillContext is found, if the unit type has that */
423 size_t kill_context_offset
;
425 /* If greater than 0, the offset into the object where the
426 * pointer to ExecRuntime is found, if the unit type has
428 size_t exec_runtime_offset
;
430 /* If greater than 0, the offset into the object where the pointer to DynamicCreds is found, if the unit type
432 size_t dynamic_creds_offset
;
434 /* The name of the configuration file section with the private settings of this unit */
435 const char *private_section
;
437 /* Config file sections this unit type understands, separated
439 const char *sections
;
441 /* This should reset all type-specific variables. This should
442 * not allocate memory, and is called with zero-initialized
443 * data. It should hence only initialize variables that need
445 void (*init
)(Unit
*u
);
447 /* This should free all type-specific variables. It should be
449 void (*done
)(Unit
*u
);
451 /* Actually load data from disk. This may fail, and should set
452 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
453 * UNIT_STUB if no configuration could be found. */
454 int (*load
)(Unit
*u
);
456 /* During deserialization we only record the intended state to return to. With coldplug() we actually put the
457 * deserialized state in effect. This is where unit_notify() should be called to start things up. Note that
458 * this callback is invoked *before* we leave the reloading state of the manager, i.e. *before* we consider the
459 * reloading to be complete. Thus, this callback should just restore the exact same state for any unit that was
460 * in effect before the reload, i.e. units should not catch up with changes happened during the reload. That's
461 * what catchup() below is for. */
462 int (*coldplug
)(Unit
*u
);
464 /* This is called shortly after all units' coldplug() call was invoked, and *after* the manager left the
465 * reloading state. It's supposed to catch up with state changes due to external events we missed so far (for
466 * example because they took place while we were reloading/reexecing) */
467 void (*catchup
)(Unit
*u
);
469 void (*dump
)(Unit
*u
, FILE *f
, const char *prefix
);
471 int (*start
)(Unit
*u
);
472 int (*stop
)(Unit
*u
);
473 int (*reload
)(Unit
*u
);
475 int (*kill
)(Unit
*u
, KillWho w
, int signo
, sd_bus_error
*error
);
477 /* Clear out the various runtime/state/cache/logs/configuration data */
478 int (*clean
)(Unit
*u
, ExecCleanMask m
);
480 /* Return which kind of data can be cleaned */
481 int (*can_clean
)(Unit
*u
, ExecCleanMask
*ret
);
483 bool (*can_reload
)(Unit
*u
);
485 /* Write all data that cannot be restored from other sources
486 * away using unit_serialize_item() */
487 int (*serialize
)(Unit
*u
, FILE *f
, FDSet
*fds
);
489 /* Restore one item from the serialization */
490 int (*deserialize_item
)(Unit
*u
, const char *key
, const char *data
, FDSet
*fds
);
492 /* Try to match up fds with what we need for this unit */
493 void (*distribute_fds
)(Unit
*u
, FDSet
*fds
);
495 /* Boils down the more complex internal state of this unit to
496 * a simpler one that the engine can understand */
497 UnitActiveState (*active_state
)(Unit
*u
);
499 /* Returns the substate specific to this unit type as
500 * string. This is purely information so that we can give the
501 * user a more fine grained explanation in which actual state a
503 const char* (*sub_state_to_string
)(Unit
*u
);
505 /* Additionally to UnitActiveState determine whether unit is to be restarted. */
506 bool (*will_restart
)(Unit
*u
);
508 /* Return false when there is a reason to prevent this unit from being gc'ed
509 * even though nothing references it and it isn't active in any way. */
510 bool (*may_gc
)(Unit
*u
);
512 /* When the unit is not running and no job for it queued we shall release its runtime resources */
513 void (*release_resources
)(Unit
*u
);
515 /* Invoked on every child that died */
516 void (*sigchld_event
)(Unit
*u
, pid_t pid
, int code
, int status
);
518 /* Reset failed state if we are in failed state */
519 void (*reset_failed
)(Unit
*u
);
521 /* Called whenever any of the cgroups this unit watches for ran empty */
522 void (*notify_cgroup_empty
)(Unit
*u
);
524 /* Called whenever an OOM kill event on this unit was seen */
525 void (*notify_cgroup_oom
)(Unit
*u
);
527 /* Called whenever a process of this unit sends us a message */
528 void (*notify_message
)(Unit
*u
, const struct ucred
*ucred
, char **tags
, FDSet
*fds
);
530 /* Called whenever a name this Unit registered for comes or goes away. */
531 void (*bus_name_owner_change
)(Unit
*u
, const char *name
, const char *old_owner
, const char *new_owner
);
533 /* Called for each property that is being set */
534 int (*bus_set_property
)(Unit
*u
, const char *name
, sd_bus_message
*message
, UnitWriteFlags flags
, sd_bus_error
*error
);
536 /* Called after at least one property got changed to apply the necessary change */
537 int (*bus_commit_properties
)(Unit
*u
);
539 /* Return the unit this unit is following */
540 Unit
*(*following
)(Unit
*u
);
542 /* Return the set of units that are following each other */
543 int (*following_set
)(Unit
*u
, Set
**s
);
545 /* Invoked each time a unit this unit is triggering changes
546 * state or gains/loses a job */
547 void (*trigger_notify
)(Unit
*u
, Unit
*trigger
);
549 /* Called whenever CLOCK_REALTIME made a jump */
550 void (*time_change
)(Unit
*u
);
552 /* Called whenever /etc/localtime was modified */
553 void (*timezone_change
)(Unit
*u
);
555 /* Returns the next timeout of a unit */
556 int (*get_timeout
)(Unit
*u
, usec_t
*timeout
);
558 /* Returns the main PID if there is any defined, or 0. */
559 pid_t (*main_pid
)(Unit
*u
);
561 /* Returns the main PID if there is any defined, or 0. */
562 pid_t (*control_pid
)(Unit
*u
);
564 /* Returns true if the unit currently needs access to the console */
565 bool (*needs_console
)(Unit
*u
);
567 /* Returns the exit status to propagate in case of FailureAction=exit/SuccessAction=exit; usually returns the
568 * exit code of the "main" process of the service or similar. */
569 int (*exit_status
)(Unit
*u
);
571 /* Like the enumerate() callback further down, but only enumerates the perpetual units, i.e. all units that
572 * unconditionally exist and are always active. The main reason to keep both enumeration functions separate is
573 * philosophical: the state of perpetual units should be put in place by coldplug(), while the state of those
574 * discovered through regular enumeration should be put in place by catchup(), see below. */
575 void (*enumerate_perpetual
)(Manager
*m
);
577 /* This is called for each unit type and should be used to enumerate units already existing in the system
578 * internally and load them. However, everything that is loaded here should still stay in inactive state. It is
579 * the job of the catchup() call above to put the units into the discovered state. */
580 void (*enumerate
)(Manager
*m
);
582 /* Type specific cleanups. */
583 void (*shutdown
)(Manager
*m
);
585 /* If this function is set and return false all jobs for units
586 * of this type will immediately fail. */
587 bool (*supported
)(void);
590 const sd_bus_vtable
*bus_vtable
;
592 /* The strings to print in status messages */
593 UnitStatusMessageFormats status_message_formats
;
595 /* True if transient units of this type are OK */
596 bool can_transient
:1;
598 /* True if cgroup delegation is permissible */
601 /* True if units of this type shall be startable only once and then never again */
604 /* True if queued jobs of this type should be GC'ed if no other job needs them anymore */
608 extern const UnitVTable
* const unit_vtable
[_UNIT_TYPE_MAX
];
610 static inline const UnitVTable
* UNIT_VTABLE(Unit
*u
) {
611 return unit_vtable
[u
->type
];
614 /* For casting a unit into the various unit types */
615 #define DEFINE_CAST(UPPERCASE, MixedCase) \
616 static inline MixedCase* UPPERCASE(Unit *u) { \
617 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
620 return (MixedCase*) u; \
623 /* For casting the various unit types into a unit */
626 typeof(u) _u_ = (u); \
627 Unit *_w_ = _u_ ? &(_u_)->meta : NULL; \
631 #define UNIT_HAS_EXEC_CONTEXT(u) (UNIT_VTABLE(u)->exec_context_offset > 0)
632 #define UNIT_HAS_CGROUP_CONTEXT(u) (UNIT_VTABLE(u)->cgroup_context_offset > 0)
633 #define UNIT_HAS_KILL_CONTEXT(u) (UNIT_VTABLE(u)->kill_context_offset > 0)
635 static inline Unit
* UNIT_TRIGGER(Unit
*u
) {
636 return hashmap_first_key(u
->dependencies
[UNIT_TRIGGERS
]);
639 Unit
*unit_new(Manager
*m
, size_t size
);
640 void unit_free(Unit
*u
);
641 DEFINE_TRIVIAL_CLEANUP_FUNC(Unit
*, unit_free
);
643 int unit_new_for_name(Manager
*m
, size_t size
, const char *name
, Unit
**ret
);
644 int unit_add_name(Unit
*u
, const char *name
);
646 int unit_add_dependency(Unit
*u
, UnitDependency d
, Unit
*other
, bool add_reference
, UnitDependencyMask mask
);
647 int unit_add_two_dependencies(Unit
*u
, UnitDependency d
, UnitDependency e
, Unit
*other
, bool add_reference
, UnitDependencyMask mask
);
649 int unit_add_dependency_by_name(Unit
*u
, UnitDependency d
, const char *name
, bool add_reference
, UnitDependencyMask mask
);
650 int unit_add_two_dependencies_by_name(Unit
*u
, UnitDependency d
, UnitDependency e
, const char *name
, bool add_reference
, UnitDependencyMask mask
);
652 int unit_add_exec_dependencies(Unit
*u
, ExecContext
*c
);
654 int unit_choose_id(Unit
*u
, const char *name
);
655 int unit_set_description(Unit
*u
, const char *description
);
657 bool unit_may_gc(Unit
*u
);
659 void unit_add_to_load_queue(Unit
*u
);
660 void unit_add_to_dbus_queue(Unit
*u
);
661 void unit_add_to_cleanup_queue(Unit
*u
);
662 void unit_add_to_gc_queue(Unit
*u
);
663 void unit_add_to_target_deps_queue(Unit
*u
);
664 void unit_submit_to_stop_when_unneeded_queue(Unit
*u
);
666 int unit_merge(Unit
*u
, Unit
*other
);
667 int unit_merge_by_name(Unit
*u
, const char *other
);
669 Unit
*unit_follow_merge(Unit
*u
) _pure_
;
671 int unit_load_fragment_and_dropin(Unit
*u
);
672 int unit_load_fragment_and_dropin_optional(Unit
*u
);
673 int unit_load(Unit
*unit
);
675 int unit_set_slice(Unit
*u
, Unit
*slice
);
676 int unit_set_default_slice(Unit
*u
);
678 const char *unit_description(Unit
*u
) _pure_
;
679 const char *unit_status_string(Unit
*u
) _pure_
;
681 bool unit_has_name(const Unit
*u
, const char *name
);
683 UnitActiveState
unit_active_state(Unit
*u
);
685 const char* unit_sub_state_to_string(Unit
*u
);
687 void unit_dump(Unit
*u
, FILE *f
, const char *prefix
);
689 bool unit_can_reload(Unit
*u
) _pure_
;
690 bool unit_can_start(Unit
*u
) _pure_
;
691 bool unit_can_stop(Unit
*u
) _pure_
;
692 bool unit_can_isolate(Unit
*u
) _pure_
;
694 int unit_start(Unit
*u
);
695 int unit_stop(Unit
*u
);
696 int unit_reload(Unit
*u
);
698 int unit_kill(Unit
*u
, KillWho w
, int signo
, sd_bus_error
*error
);
699 int unit_kill_common(Unit
*u
, KillWho who
, int signo
, pid_t main_pid
, pid_t control_pid
, sd_bus_error
*error
);
701 typedef enum UnitNotifyFlags
{
702 UNIT_NOTIFY_RELOAD_FAILURE
= 1 << 0,
703 UNIT_NOTIFY_WILL_AUTO_RESTART
= 1 << 1,
704 UNIT_NOTIFY_SKIP_CONDITION
= 1 << 2,
707 void unit_notify(Unit
*u
, UnitActiveState os
, UnitActiveState ns
, UnitNotifyFlags flags
);
709 int unit_watch_pid(Unit
*u
, pid_t pid
, bool exclusive
);
710 void unit_unwatch_pid(Unit
*u
, pid_t pid
);
711 void unit_unwatch_all_pids(Unit
*u
);
713 int unit_enqueue_rewatch_pids(Unit
*u
);
714 void unit_dequeue_rewatch_pids(Unit
*u
);
716 int unit_install_bus_match(Unit
*u
, sd_bus
*bus
, const char *name
);
717 int unit_watch_bus_name(Unit
*u
, const char *name
);
718 void unit_unwatch_bus_name(Unit
*u
, const char *name
);
720 bool unit_job_is_applicable(Unit
*u
, JobType j
);
722 int set_unit_path(const char *p
);
724 char *unit_dbus_path(Unit
*u
);
725 char *unit_dbus_path_invocation_id(Unit
*u
);
727 int unit_load_related_unit(Unit
*u
, const char *type
, Unit
**_found
);
729 bool unit_can_serialize(Unit
*u
) _pure_
;
731 int unit_serialize(Unit
*u
, FILE *f
, FDSet
*fds
, bool serialize_jobs
);
732 int unit_deserialize(Unit
*u
, FILE *f
, FDSet
*fds
);
733 int unit_deserialize_skip(FILE *f
);
735 int unit_add_node_dependency(Unit
*u
, const char *what
, bool wants
, UnitDependency d
, UnitDependencyMask mask
);
737 int unit_coldplug(Unit
*u
);
738 void unit_catchup(Unit
*u
);
740 void unit_status_printf(Unit
*u
, const char *status
, const char *unit_status_msg_format
) _printf_(3, 0);
742 bool unit_need_daemon_reload(Unit
*u
);
744 void unit_reset_failed(Unit
*u
);
746 Unit
*unit_following(Unit
*u
);
747 int unit_following_set(Unit
*u
, Set
**s
);
749 const char *unit_slice_name(Unit
*u
);
751 bool unit_stop_pending(Unit
*u
) _pure_
;
752 bool unit_inactive_or_pending(Unit
*u
) _pure_
;
753 bool unit_active_or_pending(Unit
*u
);
754 bool unit_will_restart(Unit
*u
);
756 int unit_add_default_target_dependency(Unit
*u
, Unit
*target
);
758 void unit_start_on_failure(Unit
*u
);
759 void unit_trigger_notify(Unit
*u
);
761 UnitFileState
unit_get_unit_file_state(Unit
*u
);
762 int unit_get_unit_file_preset(Unit
*u
);
764 Unit
* unit_ref_set(UnitRef
*ref
, Unit
*source
, Unit
*target
);
765 void unit_ref_unset(UnitRef
*ref
);
767 #define UNIT_DEREF(ref) ((ref).target)
768 #define UNIT_ISSET(ref) (!!(ref).target)
770 int unit_patch_contexts(Unit
*u
);
772 ExecContext
*unit_get_exec_context(Unit
*u
) _pure_
;
773 KillContext
*unit_get_kill_context(Unit
*u
) _pure_
;
774 CGroupContext
*unit_get_cgroup_context(Unit
*u
) _pure_
;
776 ExecRuntime
*unit_get_exec_runtime(Unit
*u
) _pure_
;
778 int unit_setup_exec_runtime(Unit
*u
);
779 int unit_setup_dynamic_creds(Unit
*u
);
781 char* unit_escape_setting(const char *s
, UnitWriteFlags flags
, char **buf
);
782 char* unit_concat_strv(char **l
, UnitWriteFlags flags
);
784 int unit_write_setting(Unit
*u
, UnitWriteFlags flags
, const char *name
, const char *data
);
785 int unit_write_settingf(Unit
*u
, UnitWriteFlags mode
, const char *name
, const char *format
, ...) _printf_(4,5);
787 int unit_kill_context(Unit
*u
, KillContext
*c
, KillOperation k
, pid_t main_pid
, pid_t control_pid
, bool main_pid_alien
);
789 int unit_make_transient(Unit
*u
);
791 int unit_require_mounts_for(Unit
*u
, const char *path
, UnitDependencyMask mask
);
793 bool unit_type_supported(UnitType t
);
795 bool unit_is_pristine(Unit
*u
);
797 bool unit_is_unneeded(Unit
*u
);
799 pid_t
unit_control_pid(Unit
*u
);
800 pid_t
unit_main_pid(Unit
*u
);
802 void unit_warn_if_dir_nonempty(Unit
*u
, const char* where
);
803 int unit_fail_if_noncanonical(Unit
*u
, const char* where
);
805 int unit_test_start_limit(Unit
*u
);
807 void unit_unref_uid(Unit
*u
, bool destroy_now
);
808 int unit_ref_uid(Unit
*u
, uid_t uid
, bool clean_ipc
);
810 void unit_unref_gid(Unit
*u
, bool destroy_now
);
811 int unit_ref_gid(Unit
*u
, gid_t gid
, bool clean_ipc
);
813 int unit_ref_uid_gid(Unit
*u
, uid_t uid
, gid_t gid
);
814 void unit_unref_uid_gid(Unit
*u
, bool destroy_now
);
816 void unit_notify_user_lookup(Unit
*u
, uid_t uid
, gid_t gid
);
818 int unit_set_invocation_id(Unit
*u
, sd_id128_t id
);
819 int unit_acquire_invocation_id(Unit
*u
);
821 bool unit_shall_confirm_spawn(Unit
*u
);
823 int unit_set_exec_params(Unit
*s
, ExecParameters
*p
);
825 int unit_fork_helper_process(Unit
*u
, const char *name
, pid_t
*ret
);
827 void unit_remove_dependencies(Unit
*u
, UnitDependencyMask mask
);
829 void unit_export_state_files(Unit
*u
);
830 void unit_unlink_state_files(Unit
*u
);
832 int unit_prepare_exec(Unit
*u
);
834 int unit_warn_leftover_processes(Unit
*u
);
836 bool unit_needs_console(Unit
*u
);
838 const char *unit_label_path(Unit
*u
);
840 int unit_pid_attachable(Unit
*unit
, pid_t pid
, sd_bus_error
*error
);
842 /* unit_log_skip is for cases like ExecCondition= where a unit is considered "done"
843 * after some execution, rather than succeeded or failed. */
844 void unit_log_skip(Unit
*u
, const char *result
);
845 void unit_log_success(Unit
*u
);
846 void unit_log_failure(Unit
*u
, const char *result
);
847 static inline void unit_log_result(Unit
*u
, bool success
, const char *result
) {
851 unit_log_failure(u
, result
);
854 void unit_log_process_exit(Unit
*u
, int level
, const char *kind
, const char *command
, int code
, int status
);
856 int unit_exit_status(Unit
*u
);
857 int unit_success_action_exit_status(Unit
*u
);
858 int unit_failure_action_exit_status(Unit
*u
);
860 int unit_test_trigger_loaded(Unit
*u
);
862 int unit_clean(Unit
*u
, ExecCleanMask mask
);
863 int unit_can_clean(Unit
*u
, ExecCleanMask
*ret_mask
);
865 /* Macros which append UNIT= or USER_UNIT= to the message */
867 #define log_unit_full(unit, level, error, ...) \
869 const Unit *_u = (unit); \
870 _u ? log_object_internal(level, error, PROJECT_FILE, __LINE__, __func__, _u->manager->unit_log_field, _u->id, _u->manager->invocation_log_field, _u->invocation_id_string, ##__VA_ARGS__) : \
871 log_internal(level, error, PROJECT_FILE, __LINE__, __func__, ##__VA_ARGS__); \
874 #define log_unit_debug(unit, ...) log_unit_full(unit, LOG_DEBUG, 0, ##__VA_ARGS__)
875 #define log_unit_info(unit, ...) log_unit_full(unit, LOG_INFO, 0, ##__VA_ARGS__)
876 #define log_unit_notice(unit, ...) log_unit_full(unit, LOG_NOTICE, 0, ##__VA_ARGS__)
877 #define log_unit_warning(unit, ...) log_unit_full(unit, LOG_WARNING, 0, ##__VA_ARGS__)
878 #define log_unit_error(unit, ...) log_unit_full(unit, LOG_ERR, 0, ##__VA_ARGS__)
880 #define log_unit_debug_errno(unit, error, ...) log_unit_full(unit, LOG_DEBUG, error, ##__VA_ARGS__)
881 #define log_unit_info_errno(unit, error, ...) log_unit_full(unit, LOG_INFO, error, ##__VA_ARGS__)
882 #define log_unit_notice_errno(unit, error, ...) log_unit_full(unit, LOG_NOTICE, error, ##__VA_ARGS__)
883 #define log_unit_warning_errno(unit, error, ...) log_unit_full(unit, LOG_WARNING, error, ##__VA_ARGS__)
884 #define log_unit_error_errno(unit, error, ...) log_unit_full(unit, LOG_ERR, error, ##__VA_ARGS__)
886 #define LOG_UNIT_MESSAGE(unit, fmt, ...) "MESSAGE=%s: " fmt, (unit)->id, ##__VA_ARGS__
887 #define LOG_UNIT_ID(unit) (unit)->manager->unit_log_format_string, (unit)->id
888 #define LOG_UNIT_INVOCATION_ID(unit) (unit)->manager->invocation_log_format_string, (unit)->invocation_id_string
890 const char* collect_mode_to_string(CollectMode m
) _const_
;
891 CollectMode
collect_mode_from_string(const char *s
) _pure_
;