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
,
25 _KILL_OPERATION_INVALID
= -1
28 typedef enum CollectMode
{
30 COLLECT_INACTIVE_OR_FAILED
,
32 _COLLECT_MODE_INVALID
= -1,
35 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t
) {
36 return IN_SET(t
, UNIT_ACTIVE
, UNIT_RELOADING
);
39 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t
) {
40 return IN_SET(t
, UNIT_ACTIVE
, UNIT_ACTIVATING
, UNIT_RELOADING
);
43 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t
) {
44 return IN_SET(t
, UNIT_INACTIVE
, UNIT_FAILED
, UNIT_DEACTIVATING
);
47 static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t
) {
48 return IN_SET(t
, UNIT_INACTIVE
, UNIT_FAILED
);
51 /* Stores the 'reason' a dependency was created as a bit mask, i.e. due to which configuration source it came to be. We
52 * use this so that we can selectively flush out parts of dependencies again. Note that the same dependency might be
53 * created as a result of multiple "reasons", hence the bitmask. */
54 typedef enum UnitDependencyMask
{
55 /* Configured directly by the unit file, .wants/.requires symlink or drop-in, or as an immediate result of a
56 * non-dependency option configured that way. */
57 UNIT_DEPENDENCY_FILE
= 1 << 0,
59 /* As unconditional implicit dependency (not affected by unit configuration — except by the unit name and
61 UNIT_DEPENDENCY_IMPLICIT
= 1 << 1,
63 /* A dependency effected by DefaultDependencies=yes. Note that dependencies marked this way are conceptually
64 * just a subset of UNIT_DEPENDENCY_FILE, as DefaultDependencies= is itself a unit file setting that can only
65 * be set in unit files. We make this two separate bits only to help debugging how dependencies came to be. */
66 UNIT_DEPENDENCY_DEFAULT
= 1 << 2,
68 /* A dependency created from udev rules */
69 UNIT_DEPENDENCY_UDEV
= 1 << 3,
71 /* A dependency created because of some unit's RequiresMountsFor= setting */
72 UNIT_DEPENDENCY_PATH
= 1 << 4,
74 /* A dependency created because of data read from /proc/self/mountinfo and no other configuration source */
75 UNIT_DEPENDENCY_MOUNTINFO_IMPLICIT
= 1 << 5,
77 /* A dependency created because of data read from /proc/self/mountinfo, but conditionalized by
78 * DefaultDependencies= and thus also involving configuration from UNIT_DEPENDENCY_FILE sources */
79 UNIT_DEPENDENCY_MOUNTINFO_DEFAULT
= 1 << 6,
81 /* A dependency created because of data read from /proc/swaps and no other configuration source */
82 UNIT_DEPENDENCY_PROC_SWAP
= 1 << 7,
84 _UNIT_DEPENDENCY_MASK_FULL
= (1 << 8) - 1,
87 /* The Unit's dependencies[] hashmaps use this structure as value. It has the same size as a void pointer, and thus can
88 * be stored directly as hashmap value, without any indirection. Note that this stores two masks, as both the origin
89 * and the destination of a dependency might have created it. */
90 typedef union UnitDependencyInfo
{
93 UnitDependencyMask origin_mask
:16;
94 UnitDependencyMask destination_mask
:16;
101 /* Keeps tracks of references to a unit. This is useful so
102 * that we can merge two units if necessary and correct all
103 * references to them */
105 Unit
*source
, *target
;
106 LIST_FIELDS(UnitRef
, refs_by_target
);
109 typedef struct Unit
{
113 UnitLoadState load_state
;
116 char *id
; /* One name is special because we use it for identification. Points to an entry in the names set */
121 /* For each dependency type we maintain a Hashmap whose key is the Unit* object, and the value encodes why the
122 * dependency exists, using the UnitDependencyInfo type */
123 Hashmap
*dependencies
[_UNIT_DEPENDENCY_MAX
];
125 /* Similar, for RequiresMountsFor= path dependencies. The key is the path, the value the UnitDependencyInfo type */
126 Hashmap
*requires_mounts_for
;
129 char **documentation
;
131 char *fragment_path
; /* if loaded from a config file this is the primary path to it */
132 char *source_path
; /* if converted, the source file */
135 usec_t fragment_mtime
;
139 /* If this is a transient unit we are currently writing, this is where we are writing it to */
140 FILE *transient_file
;
142 /* If there is something to do with this unit, then this is the installed job for it */
145 /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
148 /* The slot used for watching NameOwnerChanged signals */
149 sd_bus_slot
*match_bus_slot
;
150 sd_bus_slot
*get_name_owner_slot
;
152 /* References to this unit from clients */
153 sd_bus_track
*bus_track
;
154 char **deserialized_refs
;
156 /* Job timeout and action to take */
158 usec_t job_running_timeout
;
159 bool job_running_timeout_set
:1;
160 EmergencyAction job_timeout_action
;
161 char *job_timeout_reboot_arg
;
163 /* References to this */
164 LIST_HEAD(UnitRef
, refs_by_target
);
166 /* Conditions to check */
167 LIST_HEAD(Condition
, conditions
);
168 LIST_HEAD(Condition
, asserts
);
170 dual_timestamp condition_timestamp
;
171 dual_timestamp assert_timestamp
;
173 /* Updated whenever the low-level state changes */
174 dual_timestamp state_change_timestamp
;
176 /* Updated whenever the (high-level) active state enters or leaves the active or inactive states */
177 dual_timestamp inactive_exit_timestamp
;
178 dual_timestamp active_enter_timestamp
;
179 dual_timestamp active_exit_timestamp
;
180 dual_timestamp inactive_enter_timestamp
;
185 LIST_FIELDS(Unit
, units_by_type
);
188 LIST_FIELDS(Unit
, load_queue
);
191 LIST_FIELDS(Unit
, dbus_queue
);
194 LIST_FIELDS(Unit
, cleanup_queue
);
197 LIST_FIELDS(Unit
, gc_queue
);
199 /* CGroup realize members queue */
200 LIST_FIELDS(Unit
, cgroup_realize_queue
);
202 /* cgroup empty queue */
203 LIST_FIELDS(Unit
, cgroup_empty_queue
);
205 /* cgroup OOM queue */
206 LIST_FIELDS(Unit
, cgroup_oom_queue
);
208 /* Target dependencies queue */
209 LIST_FIELDS(Unit
, target_deps_queue
);
211 /* Queue of units with StopWhenUnneeded set that shell be checked for clean-up. */
212 LIST_FIELDS(Unit
, stop_when_unneeded_queue
);
214 /* PIDs we keep an eye on. Note that a unit might have many
215 * more, but these are the ones we care enough about to
216 * process SIGCHLD for */
219 /* Used in SIGCHLD and sd_notify() message event invocation logic to avoid that we dispatch the same event
220 * multiple times on the same unit. */
224 /* Used during GC sweeps */
227 /* Error code when we didn't manage to load the unit (negative) */
230 /* Put a ratelimit on unit starting */
231 RateLimit start_ratelimit
;
232 EmergencyAction start_limit_action
;
234 /* What to do on failure or success */
235 EmergencyAction success_action
, failure_action
;
236 int success_action_exit_status
, failure_action_exit_status
;
239 /* Make sure we never enter endless loops with the check unneeded logic, or the BindsTo= logic */
240 RateLimit auto_stop_ratelimit
;
242 /* Reference to a specific UID/GID */
246 /* Cached unit file state and preset */
247 UnitFileState unit_file_state
;
248 int unit_file_preset
;
250 /* Where the cpu.stat or cpuacct.usage was at the time the unit was started */
251 nsec_t cpu_usage_base
;
252 nsec_t cpu_usage_last
; /* the most recently read value */
254 /* The current counter of the oom_kill field in the memory.events cgroup attribute */
255 uint64_t oom_kill_last
;
257 /* Where the io.stat data was at the time the unit was started */
258 uint64_t io_accounting_base
[_CGROUP_IO_ACCOUNTING_METRIC_MAX
];
259 uint64_t io_accounting_last
[_CGROUP_IO_ACCOUNTING_METRIC_MAX
]; /* the most recently read value */
261 /* Counterparts in the cgroup filesystem */
263 CGroupMask cgroup_realized_mask
; /* In which hierarchies does this unit's cgroup exist? (only relevant on cgroup v1) */
264 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) */
265 CGroupMask cgroup_invalidated_mask
; /* A mask specifying controllers which shall be considered invalidated, and require re-realization */
266 CGroupMask cgroup_members_mask
; /* A cache for the controllers required by all children of this cgroup (only relevant for slice units) */
268 /* Inotify watch descriptors for watching cgroup.events and memory.events on cgroupv2 */
269 int cgroup_control_inotify_wd
;
270 int cgroup_memory_inotify_wd
;
272 /* Device Controller BPF program */
273 BPFProgram
*bpf_device_control_installed
;
275 /* IP BPF Firewalling/accounting */
276 int ip_accounting_ingress_map_fd
;
277 int ip_accounting_egress_map_fd
;
279 int ipv4_allow_map_fd
;
280 int ipv6_allow_map_fd
;
281 int ipv4_deny_map_fd
;
282 int ipv6_deny_map_fd
;
284 BPFProgram
*ip_bpf_ingress
, *ip_bpf_ingress_installed
;
285 BPFProgram
*ip_bpf_egress
, *ip_bpf_egress_installed
;
286 Set
*ip_bpf_custom_ingress
;
287 Set
*ip_bpf_custom_ingress_installed
;
288 Set
*ip_bpf_custom_egress
;
289 Set
*ip_bpf_custom_egress_installed
;
291 uint64_t ip_accounting_extra
[_CGROUP_IP_ACCOUNTING_METRIC_MAX
];
293 /* Low-priority event source which is used to remove watched PIDs that have gone away, and subscribe to any new
294 * ones which might have appeared. */
295 sd_event_source
*rewatch_pids_event_source
;
297 /* How to start OnFailure units */
298 JobMode on_failure_job_mode
;
300 /* Tweaking the GC logic */
301 CollectMode collect_mode
;
303 /* The current invocation ID */
304 sd_id128_t invocation_id
;
305 char invocation_id_string
[SD_ID128_STRING_MAX
]; /* useful when logging */
307 /* Garbage collect us we nobody wants or requires us anymore */
308 bool stop_when_unneeded
;
310 /* Create default dependencies */
311 bool default_dependencies
;
313 /* Refuse manual starting, allow starting only indirectly via dependency. */
314 bool refuse_manual_start
;
316 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
317 bool refuse_manual_stop
;
319 /* Allow isolation requests */
322 /* Ignore this unit when isolating */
323 bool ignore_on_isolate
;
325 /* Did the last condition check succeed? */
326 bool condition_result
;
329 /* Is this a transient unit? */
332 /* Is this a unit that is always running and cannot be stopped? */
335 /* Booleans indicating membership of this unit in the various queues */
336 bool in_load_queue
:1;
337 bool in_dbus_queue
:1;
338 bool in_cleanup_queue
:1;
340 bool in_cgroup_realize_queue
:1;
341 bool in_cgroup_empty_queue
:1;
342 bool in_cgroup_oom_queue
:1;
343 bool in_target_deps_queue
:1;
344 bool in_stop_when_unneeded_queue
:1;
346 bool sent_dbus_new_signal
:1;
351 bool cgroup_realized
:1;
352 bool cgroup_members_mask_valid
:1;
354 /* Reset cgroup accounting next time we fork something off */
355 bool reset_accounting
:1;
357 bool start_limit_hit
:1;
359 /* Did we already invoke unit_coldplug() for this unit? */
362 /* For transient units: whether to add a bus track reference after creating the unit */
363 bool bus_track_add
:1;
365 /* Remember which unit state files we created */
366 bool exported_invocation_id
:1;
367 bool exported_log_level_max
:1;
368 bool exported_log_extra_fields
:1;
369 bool exported_log_ratelimit_interval
:1;
370 bool exported_log_ratelimit_burst
:1;
372 /* Whether we warned about clamping the CPU quota period */
373 bool warned_clamping_cpu_quota_period
:1;
375 /* When writing transient unit files, stores which section we stored last. If < 0, we didn't write any yet. If
376 * == 0 we are in the [Unit] section, if > 0 we are in the unit type-specific section. */
377 signed int last_section_private
:2;
380 typedef struct UnitStatusMessageFormats
{
381 const char *starting_stopping
[2];
382 const char *finished_start_job
[_JOB_RESULT_MAX
];
383 const char *finished_stop_job
[_JOB_RESULT_MAX
];
384 } UnitStatusMessageFormats
;
386 /* Flags used when writing drop-in files or transient unit files */
387 typedef enum UnitWriteFlags
{
388 /* Write a runtime unit file or drop-in (i.e. one below /run) */
389 UNIT_RUNTIME
= 1 << 0,
391 /* Write a persistent drop-in (i.e. one below /etc) */
392 UNIT_PERSISTENT
= 1 << 1,
394 /* Place this item in the per-unit-type private section, instead of [Unit] */
395 UNIT_PRIVATE
= 1 << 2,
397 /* Apply specifier escaping before writing */
398 UNIT_ESCAPE_SPECIFIERS
= 1 << 3,
400 /* Apply C escaping before writing */
401 UNIT_ESCAPE_C
= 1 << 4,
404 /* Returns true if neither persistent, nor runtime storage is requested, i.e. this is a check invocation only */
405 static inline bool UNIT_WRITE_FLAGS_NOOP(UnitWriteFlags flags
) {
406 return (flags
& (UNIT_RUNTIME
|UNIT_PERSISTENT
)) == 0;
411 typedef struct UnitVTable
{
412 /* How much memory does an object of this unit type need */
415 /* If greater than 0, the offset into the object where
416 * ExecContext is found, if the unit type has that */
417 size_t exec_context_offset
;
419 /* If greater than 0, the offset into the object where
420 * CGroupContext is found, if the unit type has that */
421 size_t cgroup_context_offset
;
423 /* If greater than 0, the offset into the object where
424 * KillContext is found, if the unit type has that */
425 size_t kill_context_offset
;
427 /* If greater than 0, the offset into the object where the
428 * pointer to ExecRuntime is found, if the unit type has
430 size_t exec_runtime_offset
;
432 /* If greater than 0, the offset into the object where the pointer to DynamicCreds is found, if the unit type
434 size_t dynamic_creds_offset
;
436 /* The name of the configuration file section with the private settings of this unit */
437 const char *private_section
;
439 /* Config file sections this unit type understands, separated
441 const char *sections
;
443 /* This should reset all type-specific variables. This should
444 * not allocate memory, and is called with zero-initialized
445 * data. It should hence only initialize variables that need
447 void (*init
)(Unit
*u
);
449 /* This should free all type-specific variables. It should be
451 void (*done
)(Unit
*u
);
453 /* Actually load data from disk. This may fail, and should set
454 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
455 * UNIT_STUB if no configuration could be found. */
456 int (*load
)(Unit
*u
);
458 /* During deserialization we only record the intended state to return to. With coldplug() we actually put the
459 * deserialized state in effect. This is where unit_notify() should be called to start things up. Note that
460 * this callback is invoked *before* we leave the reloading state of the manager, i.e. *before* we consider the
461 * reloading to be complete. Thus, this callback should just restore the exact same state for any unit that was
462 * in effect before the reload, i.e. units should not catch up with changes happened during the reload. That's
463 * what catchup() below is for. */
464 int (*coldplug
)(Unit
*u
);
466 /* This is called shortly after all units' coldplug() call was invoked, and *after* the manager left the
467 * reloading state. It's supposed to catch up with state changes due to external events we missed so far (for
468 * example because they took place while we were reloading/reexecing) */
469 void (*catchup
)(Unit
*u
);
471 void (*dump
)(Unit
*u
, FILE *f
, const char *prefix
);
473 int (*start
)(Unit
*u
);
474 int (*stop
)(Unit
*u
);
475 int (*reload
)(Unit
*u
);
477 int (*kill
)(Unit
*u
, KillWho w
, int signo
, sd_bus_error
*error
);
479 /* Clear out the various runtime/state/cache/logs/configuration data */
480 int (*clean
)(Unit
*u
, ExecCleanMask m
);
482 /* Return which kind of data can be cleaned */
483 int (*can_clean
)(Unit
*u
, ExecCleanMask
*ret
);
485 bool (*can_reload
)(Unit
*u
);
487 /* Write all data that cannot be restored from other sources
488 * away using unit_serialize_item() */
489 int (*serialize
)(Unit
*u
, FILE *f
, FDSet
*fds
);
491 /* Restore one item from the serialization */
492 int (*deserialize_item
)(Unit
*u
, const char *key
, const char *data
, FDSet
*fds
);
494 /* Try to match up fds with what we need for this unit */
495 void (*distribute_fds
)(Unit
*u
, FDSet
*fds
);
497 /* Boils down the more complex internal state of this unit to
498 * a simpler one that the engine can understand */
499 UnitActiveState (*active_state
)(Unit
*u
);
501 /* Returns the substate specific to this unit type as
502 * string. This is purely information so that we can give the
503 * user a more fine grained explanation in which actual state a
505 const char* (*sub_state_to_string
)(Unit
*u
);
507 /* Additionally to UnitActiveState determine whether unit is to be restarted. */
508 bool (*will_restart
)(Unit
*u
);
510 /* Return false when there is a reason to prevent this unit from being gc'ed
511 * even though nothing references it and it isn't active in any way. */
512 bool (*may_gc
)(Unit
*u
);
514 /* When the unit is not running and no job for it queued we shall release its runtime resources */
515 void (*release_resources
)(Unit
*u
);
517 /* Invoked on every child that died */
518 void (*sigchld_event
)(Unit
*u
, pid_t pid
, int code
, int status
);
520 /* Reset failed state if we are in failed state */
521 void (*reset_failed
)(Unit
*u
);
523 /* Called whenever any of the cgroups this unit watches for ran empty */
524 void (*notify_cgroup_empty
)(Unit
*u
);
526 /* Called whenever an OOM kill event on this unit was seen */
527 void (*notify_cgroup_oom
)(Unit
*u
);
529 /* Called whenever a process of this unit sends us a message */
530 void (*notify_message
)(Unit
*u
, const struct ucred
*ucred
, char **tags
, FDSet
*fds
);
532 /* Called whenever a name this Unit registered for comes or goes away. */
533 void (*bus_name_owner_change
)(Unit
*u
, const char *new_owner
);
535 /* Called for each property that is being set */
536 int (*bus_set_property
)(Unit
*u
, const char *name
, sd_bus_message
*message
, UnitWriteFlags flags
, sd_bus_error
*error
);
538 /* Called after at least one property got changed to apply the necessary change */
539 int (*bus_commit_properties
)(Unit
*u
);
541 /* Return the unit this unit is following */
542 Unit
*(*following
)(Unit
*u
);
544 /* Return the set of units that are following each other */
545 int (*following_set
)(Unit
*u
, Set
**s
);
547 /* Invoked each time a unit this unit is triggering changes
548 * state or gains/loses a job */
549 void (*trigger_notify
)(Unit
*u
, Unit
*trigger
);
551 /* Called whenever CLOCK_REALTIME made a jump */
552 void (*time_change
)(Unit
*u
);
554 /* Called whenever /etc/localtime was modified */
555 void (*timezone_change
)(Unit
*u
);
557 /* Returns the next timeout of a unit */
558 int (*get_timeout
)(Unit
*u
, usec_t
*timeout
);
560 /* Returns the main PID if there is any defined, or 0. */
561 pid_t (*main_pid
)(Unit
*u
);
563 /* Returns the main PID if there is any defined, or 0. */
564 pid_t (*control_pid
)(Unit
*u
);
566 /* Returns true if the unit currently needs access to the console */
567 bool (*needs_console
)(Unit
*u
);
569 /* Returns the exit status to propagate in case of FailureAction=exit/SuccessAction=exit; usually returns the
570 * exit code of the "main" process of the service or similar. */
571 int (*exit_status
)(Unit
*u
);
573 /* Like the enumerate() callback further down, but only enumerates the perpetual units, i.e. all units that
574 * unconditionally exist and are always active. The main reason to keep both enumeration functions separate is
575 * philosophical: the state of perpetual units should be put in place by coldplug(), while the state of those
576 * discovered through regular enumeration should be put in place by catchup(), see below. */
577 void (*enumerate_perpetual
)(Manager
*m
);
579 /* This is called for each unit type and should be used to enumerate units already existing in the system
580 * internally and load them. However, everything that is loaded here should still stay in inactive state. It is
581 * the job of the catchup() call above to put the units into the discovered state. */
582 void (*enumerate
)(Manager
*m
);
584 /* Type specific cleanups. */
585 void (*shutdown
)(Manager
*m
);
587 /* If this function is set and return false all jobs for units
588 * of this type will immediately fail. */
589 bool (*supported
)(void);
592 const sd_bus_vtable
*bus_vtable
;
594 /* The strings to print in status messages */
595 UnitStatusMessageFormats status_message_formats
;
597 /* True if transient units of this type are OK */
598 bool can_transient
:1;
600 /* True if cgroup delegation is permissible */
603 /* True if units of this type shall be startable only once and then never again */
606 /* True if queued jobs of this type should be GC'ed if no other job needs them anymore */
610 extern const UnitVTable
* const unit_vtable
[_UNIT_TYPE_MAX
];
612 static inline const UnitVTable
* UNIT_VTABLE(Unit
*u
) {
613 return unit_vtable
[u
->type
];
616 /* For casting a unit into the various unit types */
617 #define DEFINE_CAST(UPPERCASE, MixedCase) \
618 static inline MixedCase* UPPERCASE(Unit *u) { \
619 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
622 return (MixedCase*) u; \
625 /* For casting the various unit types into a unit */
628 typeof(u) _u_ = (u); \
629 Unit *_w_ = _u_ ? &(_u_)->meta : NULL; \
633 #define UNIT_HAS_EXEC_CONTEXT(u) (UNIT_VTABLE(u)->exec_context_offset > 0)
634 #define UNIT_HAS_CGROUP_CONTEXT(u) (UNIT_VTABLE(u)->cgroup_context_offset > 0)
635 #define UNIT_HAS_KILL_CONTEXT(u) (UNIT_VTABLE(u)->kill_context_offset > 0)
637 static inline Unit
* UNIT_TRIGGER(Unit
*u
) {
638 return hashmap_first_key(u
->dependencies
[UNIT_TRIGGERS
]);
641 Unit
*unit_new(Manager
*m
, size_t size
);
642 void unit_free(Unit
*u
);
643 DEFINE_TRIVIAL_CLEANUP_FUNC(Unit
*, unit_free
);
645 int unit_new_for_name(Manager
*m
, size_t size
, const char *name
, Unit
**ret
);
646 int unit_add_name(Unit
*u
, const char *name
);
648 int unit_add_dependency(Unit
*u
, UnitDependency d
, Unit
*other
, bool add_reference
, UnitDependencyMask mask
);
649 int unit_add_two_dependencies(Unit
*u
, UnitDependency d
, UnitDependency e
, Unit
*other
, bool add_reference
, UnitDependencyMask mask
);
651 int unit_add_dependency_by_name(Unit
*u
, UnitDependency d
, const char *name
, bool add_reference
, UnitDependencyMask mask
);
652 int unit_add_two_dependencies_by_name(Unit
*u
, UnitDependency d
, UnitDependency e
, const char *name
, bool add_reference
, UnitDependencyMask mask
);
654 int unit_add_exec_dependencies(Unit
*u
, ExecContext
*c
);
656 int unit_choose_id(Unit
*u
, const char *name
);
657 int unit_set_description(Unit
*u
, const char *description
);
659 bool unit_may_gc(Unit
*u
);
661 void unit_add_to_load_queue(Unit
*u
);
662 void unit_add_to_dbus_queue(Unit
*u
);
663 void unit_add_to_cleanup_queue(Unit
*u
);
664 void unit_add_to_gc_queue(Unit
*u
);
665 void unit_add_to_target_deps_queue(Unit
*u
);
666 void unit_submit_to_stop_when_unneeded_queue(Unit
*u
);
668 int unit_merge(Unit
*u
, Unit
*other
);
669 int unit_merge_by_name(Unit
*u
, const char *other
);
671 Unit
*unit_follow_merge(Unit
*u
) _pure_
;
673 int unit_load_fragment_and_dropin(Unit
*u
, bool fragment_required
);
674 int unit_load(Unit
*unit
);
676 int unit_set_slice(Unit
*u
, Unit
*slice
);
677 int unit_set_default_slice(Unit
*u
);
679 const char *unit_description(Unit
*u
) _pure_
;
680 const char *unit_status_string(Unit
*u
) _pure_
;
682 bool unit_has_name(const Unit
*u
, const char *name
);
684 UnitActiveState
unit_active_state(Unit
*u
);
686 const char* unit_sub_state_to_string(Unit
*u
);
688 void unit_dump(Unit
*u
, FILE *f
, const char *prefix
);
690 bool unit_can_reload(Unit
*u
) _pure_
;
691 bool unit_can_start(Unit
*u
) _pure_
;
692 bool unit_can_stop(Unit
*u
) _pure_
;
693 bool unit_can_isolate(Unit
*u
) _pure_
;
695 int unit_start(Unit
*u
);
696 int unit_stop(Unit
*u
);
697 int unit_reload(Unit
*u
);
699 int unit_kill(Unit
*u
, KillWho w
, int signo
, sd_bus_error
*error
);
700 int unit_kill_common(Unit
*u
, KillWho who
, int signo
, pid_t main_pid
, pid_t control_pid
, sd_bus_error
*error
);
702 typedef enum UnitNotifyFlags
{
703 UNIT_NOTIFY_RELOAD_FAILURE
= 1 << 0,
704 UNIT_NOTIFY_WILL_AUTO_RESTART
= 1 << 1,
705 UNIT_NOTIFY_SKIP_CONDITION
= 1 << 2,
708 void unit_notify(Unit
*u
, UnitActiveState os
, UnitActiveState ns
, UnitNotifyFlags flags
);
710 int unit_watch_pid(Unit
*u
, pid_t pid
, bool exclusive
);
711 void unit_unwatch_pid(Unit
*u
, pid_t pid
);
712 void unit_unwatch_all_pids(Unit
*u
);
714 int unit_enqueue_rewatch_pids(Unit
*u
);
715 void unit_dequeue_rewatch_pids(Unit
*u
);
717 int unit_install_bus_match(Unit
*u
, sd_bus
*bus
, const char *name
);
718 int unit_watch_bus_name(Unit
*u
, const char *name
);
719 void unit_unwatch_bus_name(Unit
*u
, const char *name
);
721 bool unit_job_is_applicable(Unit
*u
, JobType j
);
723 int set_unit_path(const char *p
);
725 char *unit_dbus_path(Unit
*u
);
726 char *unit_dbus_path_invocation_id(Unit
*u
);
728 int unit_load_related_unit(Unit
*u
, const char *type
, Unit
**_found
);
730 bool unit_can_serialize(Unit
*u
) _pure_
;
732 int unit_serialize(Unit
*u
, FILE *f
, FDSet
*fds
, bool serialize_jobs
);
733 int unit_deserialize(Unit
*u
, FILE *f
, FDSet
*fds
);
734 int unit_deserialize_skip(FILE *f
);
736 int unit_add_node_dependency(Unit
*u
, const char *what
, UnitDependency d
, UnitDependencyMask mask
);
738 int unit_coldplug(Unit
*u
);
739 void unit_catchup(Unit
*u
);
741 void unit_status_printf(Unit
*u
, const char *status
, const char *unit_status_msg_format
) _printf_(3, 0);
743 bool unit_need_daemon_reload(Unit
*u
);
745 void unit_reset_failed(Unit
*u
);
747 Unit
*unit_following(Unit
*u
);
748 int unit_following_set(Unit
*u
, Set
**s
);
750 const char *unit_slice_name(Unit
*u
);
752 bool unit_stop_pending(Unit
*u
) _pure_
;
753 bool unit_inactive_or_pending(Unit
*u
) _pure_
;
754 bool unit_active_or_pending(Unit
*u
);
755 bool unit_will_restart_default(Unit
*u
);
756 bool unit_will_restart(Unit
*u
);
758 int unit_add_default_target_dependency(Unit
*u
, Unit
*target
);
760 void unit_start_on_failure(Unit
*u
);
761 void unit_trigger_notify(Unit
*u
);
763 UnitFileState
unit_get_unit_file_state(Unit
*u
);
764 int unit_get_unit_file_preset(Unit
*u
);
766 Unit
* unit_ref_set(UnitRef
*ref
, Unit
*source
, Unit
*target
);
767 void unit_ref_unset(UnitRef
*ref
);
769 #define UNIT_DEREF(ref) ((ref).target)
770 #define UNIT_ISSET(ref) (!!(ref).target)
772 int unit_patch_contexts(Unit
*u
);
774 ExecContext
*unit_get_exec_context(Unit
*u
) _pure_
;
775 KillContext
*unit_get_kill_context(Unit
*u
) _pure_
;
776 CGroupContext
*unit_get_cgroup_context(Unit
*u
) _pure_
;
778 ExecRuntime
*unit_get_exec_runtime(Unit
*u
) _pure_
;
780 int unit_setup_exec_runtime(Unit
*u
);
781 int unit_setup_dynamic_creds(Unit
*u
);
783 char* unit_escape_setting(const char *s
, UnitWriteFlags flags
, char **buf
);
784 char* unit_concat_strv(char **l
, UnitWriteFlags flags
);
786 int unit_write_setting(Unit
*u
, UnitWriteFlags flags
, const char *name
, const char *data
);
787 int unit_write_settingf(Unit
*u
, UnitWriteFlags mode
, const char *name
, const char *format
, ...) _printf_(4,5);
789 int unit_kill_context(Unit
*u
, KillContext
*c
, KillOperation k
, pid_t main_pid
, pid_t control_pid
, bool main_pid_alien
);
791 int unit_make_transient(Unit
*u
);
793 int unit_require_mounts_for(Unit
*u
, const char *path
, UnitDependencyMask mask
);
795 bool unit_type_supported(UnitType t
);
797 bool unit_is_pristine(Unit
*u
);
799 bool unit_is_unneeded(Unit
*u
);
801 pid_t
unit_control_pid(Unit
*u
);
802 pid_t
unit_main_pid(Unit
*u
);
804 void unit_warn_if_dir_nonempty(Unit
*u
, const char* where
);
805 int unit_fail_if_noncanonical(Unit
*u
, const char* where
);
807 int unit_test_start_limit(Unit
*u
);
809 void unit_unref_uid(Unit
*u
, bool destroy_now
);
810 int unit_ref_uid(Unit
*u
, uid_t uid
, bool clean_ipc
);
812 void unit_unref_gid(Unit
*u
, bool destroy_now
);
813 int unit_ref_gid(Unit
*u
, gid_t gid
, bool clean_ipc
);
815 int unit_ref_uid_gid(Unit
*u
, uid_t uid
, gid_t gid
);
816 void unit_unref_uid_gid(Unit
*u
, bool destroy_now
);
818 void unit_notify_user_lookup(Unit
*u
, uid_t uid
, gid_t gid
);
820 int unit_set_invocation_id(Unit
*u
, sd_id128_t id
);
821 int unit_acquire_invocation_id(Unit
*u
);
823 bool unit_shall_confirm_spawn(Unit
*u
);
825 int unit_set_exec_params(Unit
*s
, ExecParameters
*p
);
827 int unit_fork_helper_process(Unit
*u
, const char *name
, pid_t
*ret
);
828 int unit_fork_and_watch_rm_rf(Unit
*u
, char **paths
, pid_t
*ret_pid
);
830 void unit_remove_dependencies(Unit
*u
, UnitDependencyMask mask
);
832 void unit_export_state_files(Unit
*u
);
833 void unit_unlink_state_files(Unit
*u
);
835 int unit_prepare_exec(Unit
*u
);
837 int unit_warn_leftover_processes(Unit
*u
);
839 bool unit_needs_console(Unit
*u
);
841 const char *unit_label_path(Unit
*u
);
843 int unit_pid_attachable(Unit
*unit
, pid_t pid
, sd_bus_error
*error
);
845 static inline bool unit_has_job_type(Unit
*u
, JobType type
) {
846 return u
&& u
->job
&& u
->job
->type
== type
;
849 /* unit_log_skip is for cases like ExecCondition= where a unit is considered "done"
850 * after some execution, rather than succeeded or failed. */
851 void unit_log_skip(Unit
*u
, const char *result
);
852 void unit_log_success(Unit
*u
);
853 void unit_log_failure(Unit
*u
, const char *result
);
854 static inline void unit_log_result(Unit
*u
, bool success
, const char *result
) {
858 unit_log_failure(u
, result
);
861 void unit_log_process_exit(Unit
*u
, const char *kind
, const char *command
, bool success
, int code
, int status
);
863 int unit_exit_status(Unit
*u
);
864 int unit_success_action_exit_status(Unit
*u
);
865 int unit_failure_action_exit_status(Unit
*u
);
867 int unit_test_trigger_loaded(Unit
*u
);
869 void unit_destroy_runtime_directory(Unit
*u
, const ExecContext
*context
);
870 int unit_clean(Unit
*u
, ExecCleanMask mask
);
871 int unit_can_clean(Unit
*u
, ExecCleanMask
*ret_mask
);
873 /* Macros which append UNIT= or USER_UNIT= to the message */
875 #define log_unit_full(unit, level, error, ...) \
877 const Unit *_u = (unit); \
878 _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__) : \
879 log_internal(level, error, PROJECT_FILE, __LINE__, __func__, ##__VA_ARGS__); \
882 #define log_unit_debug(unit, ...) log_unit_full(unit, LOG_DEBUG, 0, ##__VA_ARGS__)
883 #define log_unit_info(unit, ...) log_unit_full(unit, LOG_INFO, 0, ##__VA_ARGS__)
884 #define log_unit_notice(unit, ...) log_unit_full(unit, LOG_NOTICE, 0, ##__VA_ARGS__)
885 #define log_unit_warning(unit, ...) log_unit_full(unit, LOG_WARNING, 0, ##__VA_ARGS__)
886 #define log_unit_error(unit, ...) log_unit_full(unit, LOG_ERR, 0, ##__VA_ARGS__)
888 #define log_unit_debug_errno(unit, error, ...) log_unit_full(unit, LOG_DEBUG, error, ##__VA_ARGS__)
889 #define log_unit_info_errno(unit, error, ...) log_unit_full(unit, LOG_INFO, error, ##__VA_ARGS__)
890 #define log_unit_notice_errno(unit, error, ...) log_unit_full(unit, LOG_NOTICE, error, ##__VA_ARGS__)
891 #define log_unit_warning_errno(unit, error, ...) log_unit_full(unit, LOG_WARNING, error, ##__VA_ARGS__)
892 #define log_unit_error_errno(unit, error, ...) log_unit_full(unit, LOG_ERR, error, ##__VA_ARGS__)
894 #define LOG_UNIT_MESSAGE(unit, fmt, ...) "MESSAGE=%s: " fmt, (unit)->id, ##__VA_ARGS__
895 #define LOG_UNIT_ID(unit) (unit)->manager->unit_log_format_string, (unit)->id
896 #define LOG_UNIT_INVOCATION_ID(unit) (unit)->manager->invocation_log_format_string, (unit)->invocation_id_string
898 const char* collect_mode_to_string(CollectMode m
) _const_
;
899 CollectMode
collect_mode_from_string(const char *s
) _pure_
;