1 /* SPDX-License-Identifier: LGPL-2.1+ */
5 This file is part of systemd.
7 Copyright 2010 Lennart Poettering
14 #include "bpf-program.h"
15 #include "condition.h"
16 #include "emergency-action.h"
19 #include "unit-name.h"
22 typedef struct UnitRef UnitRef
;
24 typedef enum KillOperation
{
26 KILL_TERMINATE_AND_LOG
,
30 _KILL_OPERATION_INVALID
= -1
33 typedef enum CollectMode
{
35 COLLECT_INACTIVE_OR_FAILED
,
37 _COLLECT_MODE_INVALID
= -1,
40 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t
) {
41 return IN_SET(t
, UNIT_ACTIVE
, UNIT_RELOADING
);
44 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t
) {
45 return IN_SET(t
, UNIT_ACTIVE
, UNIT_ACTIVATING
, UNIT_RELOADING
);
48 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t
) {
49 return IN_SET(t
, UNIT_INACTIVE
, UNIT_FAILED
, UNIT_DEACTIVATING
);
52 static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t
) {
53 return IN_SET(t
, UNIT_INACTIVE
, UNIT_FAILED
);
56 /* Stores the 'reason' a dependency was created as a bit mask, i.e. due to which configuration source it came to be. We
57 * use this so that we can selectively flush out parts of dependencies again. Note that the same dependency might be
58 * created as a result of multiple "reasons", hence the bitmask. */
59 typedef enum UnitDependencyMask
{
60 /* Configured directly by the unit file, .wants/.requries symlink or drop-in, or as an immediate result of a
61 * non-dependency option configured that way. */
62 UNIT_DEPENDENCY_FILE
= 1 << 0,
64 /* As unconditional implicit dependency (not affected by unit configuration — except by the unit name and
66 UNIT_DEPENDENCY_IMPLICIT
= 1 << 1,
68 /* A dependency effected by DefaultDependencies=yes. Note that dependencies marked this way are conceptually
69 * just a subset of UNIT_DEPENDENCY_FILE, as DefaultDependencies= is itself a unit file setting that can only
70 * be set in unit files. We make this two separate bits only to help debugging how dependencies came to be. */
71 UNIT_DEPENDENCY_DEFAULT
= 1 << 2,
73 /* A dependency created from udev rules */
74 UNIT_DEPENDENCY_UDEV
= 1 << 3,
76 /* A dependency created because of some unit's RequiresMountsFor= setting */
77 UNIT_DEPENDENCY_PATH
= 1 << 4,
79 /* A dependency created because of data read from /proc/self/mountinfo and no other configuration source */
80 UNIT_DEPENDENCY_MOUNTINFO_IMPLICIT
= 1 << 5,
82 /* A dependency created because of data read from /proc/self/mountinfo, but conditionalized by
83 * DefaultDependencies= and thus also involving configuration from UNIT_DEPENDENCY_FILE sources */
84 UNIT_DEPENDENCY_MOUNTINFO_DEFAULT
= 1 << 6,
86 /* A dependency created because of data read from /proc/swaps and no other configuration source */
87 UNIT_DEPENDENCY_PROC_SWAP
= 1 << 7,
89 _UNIT_DEPENDENCY_MASK_FULL
= (1 << 8) - 1,
92 /* The Unit's dependencies[] hashmaps use this structure as value. It has the same size as a void pointer, and thus can
93 * be stored directly as hashmap value, without any indirection. Note that this stores two masks, as both the origin
94 * and the destination of a dependency might have created it. */
95 typedef union UnitDependencyInfo
{
98 UnitDependencyMask origin_mask
:16;
99 UnitDependencyMask destination_mask
:16;
101 } UnitDependencyInfo
;
106 /* Keeps tracks of references to a unit. This is useful so
107 * that we can merge two units if necessary and correct all
108 * references to them */
110 Unit
*source
, *target
;
111 LIST_FIELDS(UnitRef
, refs_by_target
);
114 typedef enum UnitCGroupBPFState
{
115 UNIT_CGROUP_BPF_OFF
= 0,
116 UNIT_CGROUP_BPF_ON
= 1,
117 UNIT_CGROUP_BPF_INVALIDATED
= -1,
118 } UnitCGroupBPFState
;
120 typedef struct Unit
{
124 UnitLoadState load_state
;
127 char *id
; /* One name is special because we use it for identification. Points to an entry in the names set */
132 /* For each dependency type we maintain a Hashmap whose key is the Unit* object, and the value encodes why the
133 * dependency exists, using the UnitDependencyInfo type */
134 Hashmap
*dependencies
[_UNIT_DEPENDENCY_MAX
];
136 /* Similar, for RequiresMountsFor= path dependencies. The key is the path, the value the UnitDependencyInfo type */
137 Hashmap
*requires_mounts_for
;
140 char **documentation
;
142 char *fragment_path
; /* if loaded from a config file this is the primary path to it */
143 char *source_path
; /* if converted, the source file */
146 usec_t fragment_mtime
;
150 /* If this is a transient unit we are currently writing, this is where we are writing it to */
151 FILE *transient_file
;
153 /* If there is something to do with this unit, then this is the installed job for it */
156 /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
159 /* The slot used for watching NameOwnerChanged signals */
160 sd_bus_slot
*match_bus_slot
;
162 /* References to this unit from clients */
163 sd_bus_track
*bus_track
;
164 char **deserialized_refs
;
166 /* Job timeout and action to take */
168 usec_t job_running_timeout
;
169 bool job_running_timeout_set
:1;
170 EmergencyAction job_timeout_action
;
171 char *job_timeout_reboot_arg
;
173 /* References to this */
174 LIST_HEAD(UnitRef
, refs_by_target
);
176 /* Conditions to check */
177 LIST_HEAD(Condition
, conditions
);
178 LIST_HEAD(Condition
, asserts
);
180 dual_timestamp condition_timestamp
;
181 dual_timestamp assert_timestamp
;
183 /* Updated whenever the low-level state changes */
184 dual_timestamp state_change_timestamp
;
186 /* Updated whenever the (high-level) active state enters or leaves the active or inactive states */
187 dual_timestamp inactive_exit_timestamp
;
188 dual_timestamp active_enter_timestamp
;
189 dual_timestamp active_exit_timestamp
;
190 dual_timestamp inactive_enter_timestamp
;
195 LIST_FIELDS(Unit
, units_by_type
);
197 /* All units which have requires_mounts_for set */
198 LIST_FIELDS(Unit
, has_requires_mounts_for
);
201 LIST_FIELDS(Unit
, load_queue
);
204 LIST_FIELDS(Unit
, dbus_queue
);
207 LIST_FIELDS(Unit
, cleanup_queue
);
210 LIST_FIELDS(Unit
, gc_queue
);
212 /* CGroup realize members queue */
213 LIST_FIELDS(Unit
, cgroup_realize_queue
);
215 /* cgroup empty queue */
216 LIST_FIELDS(Unit
, cgroup_empty_queue
);
218 /* Target dependencies queue */
219 LIST_FIELDS(Unit
, target_deps_queue
);
221 /* PIDs we keep an eye on. Note that a unit might have many
222 * more, but these are the ones we care enough about to
223 * process SIGCHLD for */
226 /* Used in SIGCHLD and sd_notify() message event invocation logic to avoid that we dispatch the same event
227 * multiple times on the same unit. */
231 /* Used during GC sweeps */
234 /* Error code when we didn't manage to load the unit (negative) */
237 /* Put a ratelimit on unit starting */
238 RateLimit start_limit
;
239 EmergencyAction start_limit_action
;
241 EmergencyAction failure_action
;
242 EmergencyAction success_action
;
245 /* Make sure we never enter endless loops with the check unneeded logic, or the BindsTo= logic */
246 RateLimit auto_stop_ratelimit
;
248 /* Reference to a specific UID/GID */
252 /* Cached unit file state and preset */
253 UnitFileState unit_file_state
;
254 int unit_file_preset
;
256 /* Where the cpu.stat or cpuacct.usage was at the time the unit was started */
257 nsec_t cpu_usage_base
;
258 nsec_t cpu_usage_last
; /* the most recently read value */
260 /* Counterparts in the cgroup filesystem */
262 CGroupMask cgroup_realized_mask
;
263 CGroupMask cgroup_enabled_mask
;
264 CGroupMask cgroup_subtree_mask
;
265 CGroupMask cgroup_members_mask
;
266 int cgroup_inotify_wd
;
268 /* IP BPF Firewalling/accounting */
269 int ip_accounting_ingress_map_fd
;
270 int ip_accounting_egress_map_fd
;
272 int ipv4_allow_map_fd
;
273 int ipv6_allow_map_fd
;
274 int ipv4_deny_map_fd
;
275 int ipv6_deny_map_fd
;
277 BPFProgram
*ip_bpf_ingress
, *ip_bpf_ingress_installed
;
278 BPFProgram
*ip_bpf_egress
, *ip_bpf_egress_installed
;
280 uint64_t ip_accounting_extra
[_CGROUP_IP_ACCOUNTING_METRIC_MAX
];
282 /* How to start OnFailure units */
283 JobMode on_failure_job_mode
;
285 /* Tweaking the GC logic */
286 CollectMode collect_mode
;
288 /* The current invocation ID */
289 sd_id128_t invocation_id
;
290 char invocation_id_string
[SD_ID128_STRING_MAX
]; /* useful when logging */
292 /* Garbage collect us we nobody wants or requires us anymore */
293 bool stop_when_unneeded
;
295 /* Create default dependencies */
296 bool default_dependencies
;
298 /* Refuse manual starting, allow starting only indirectly via dependency. */
299 bool refuse_manual_start
;
301 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
302 bool refuse_manual_stop
;
304 /* Allow isolation requests */
307 /* Ignore this unit when isolating */
308 bool ignore_on_isolate
;
310 /* Did the last condition check succeed? */
311 bool condition_result
;
314 /* Is this a transient unit? */
317 /* Is this a unit that is always running and cannot be stopped? */
320 bool in_load_queue
:1;
321 bool in_dbus_queue
:1;
322 bool in_cleanup_queue
:1;
324 bool in_cgroup_realize_queue
:1;
325 bool in_cgroup_empty_queue
:1;
326 bool in_target_deps_queue
:1;
328 bool sent_dbus_new_signal
:1;
333 bool cgroup_realized
:1;
334 bool cgroup_members_mask_valid
:1;
335 bool cgroup_subtree_mask_valid
:1;
337 UnitCGroupBPFState cgroup_bpf_state
:2;
339 /* Reset cgroup accounting next time we fork something off */
340 bool reset_accounting
:1;
342 bool start_limit_hit
:1;
344 /* Did we already invoke unit_coldplug() for this unit? */
347 /* For transient units: whether to add a bus track reference after creating the unit */
348 bool bus_track_add
:1;
350 /* Remember which unit state files we created */
351 bool exported_invocation_id
:1;
352 bool exported_log_level_max
:1;
353 bool exported_log_extra_fields
:1;
355 /* When writing transient unit files, stores which section we stored last. If < 0, we didn't write any yet. If
356 * == 0 we are in the [Unit] section, if > 0 we are in the unit type-specific section. */
357 int last_section_private
:2;
360 typedef struct UnitStatusMessageFormats
{
361 const char *starting_stopping
[2];
362 const char *finished_start_job
[_JOB_RESULT_MAX
];
363 const char *finished_stop_job
[_JOB_RESULT_MAX
];
364 } UnitStatusMessageFormats
;
366 /* Flags used when writing drop-in files or transient unit files */
367 typedef enum UnitWriteFlags
{
368 /* Write a runtime unit file or drop-in (i.e. one below /run) */
369 UNIT_RUNTIME
= 1 << 0,
371 /* Write a persistent drop-in (i.e. one below /etc) */
372 UNIT_PERSISTENT
= 1 << 1,
374 /* Place this item in the per-unit-type private section, instead of [Unit] */
375 UNIT_PRIVATE
= 1 << 2,
377 /* Apply specifier escaping before writing */
378 UNIT_ESCAPE_SPECIFIERS
= 1 << 3,
380 /* Apply C escaping before writing */
381 UNIT_ESCAPE_C
= 1 << 4,
384 /* Returns true if neither persistent, nor runtime storage is requested, i.e. this is a check invocation only */
385 #define UNIT_WRITE_FLAGS_NOOP(flags) (((flags) & (UNIT_RUNTIME|UNIT_PERSISTENT)) == 0)
389 typedef struct UnitVTable
{
390 /* How much memory does an object of this unit type need */
393 /* If greater than 0, the offset into the object where
394 * ExecContext is found, if the unit type has that */
395 size_t exec_context_offset
;
397 /* If greater than 0, the offset into the object where
398 * CGroupContext is found, if the unit type has that */
399 size_t cgroup_context_offset
;
401 /* If greater than 0, the offset into the object where
402 * KillContext is found, if the unit type has that */
403 size_t kill_context_offset
;
405 /* If greater than 0, the offset into the object where the
406 * pointer to ExecRuntime is found, if the unit type has
408 size_t exec_runtime_offset
;
410 /* If greater than 0, the offset into the object where the pointer to DynamicCreds is found, if the unit type
412 size_t dynamic_creds_offset
;
414 /* The name of the configuration file section with the private settings of this unit */
415 const char *private_section
;
417 /* Config file sections this unit type understands, separated
419 const char *sections
;
421 /* This should reset all type-specific variables. This should
422 * not allocate memory, and is called with zero-initialized
423 * data. It should hence only initialize variables that need
425 void (*init
)(Unit
*u
);
427 /* This should free all type-specific variables. It should be
429 void (*done
)(Unit
*u
);
431 /* Actually load data from disk. This may fail, and should set
432 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
433 * UNIT_STUB if no configuration could be found. */
434 int (*load
)(Unit
*u
);
436 /* If a lot of units got created via enumerate(), this is
437 * where to actually set the state and call unit_notify(). */
438 int (*coldplug
)(Unit
*u
);
440 void (*dump
)(Unit
*u
, FILE *f
, const char *prefix
);
442 int (*start
)(Unit
*u
);
443 int (*stop
)(Unit
*u
);
444 int (*reload
)(Unit
*u
);
446 int (*kill
)(Unit
*u
, KillWho w
, int signo
, sd_bus_error
*error
);
448 bool (*can_reload
)(Unit
*u
);
450 /* Write all data that cannot be restored from other sources
451 * away using unit_serialize_item() */
452 int (*serialize
)(Unit
*u
, FILE *f
, FDSet
*fds
);
454 /* Restore one item from the serialization */
455 int (*deserialize_item
)(Unit
*u
, const char *key
, const char *data
, FDSet
*fds
);
457 /* Try to match up fds with what we need for this unit */
458 void (*distribute_fds
)(Unit
*u
, FDSet
*fds
);
460 /* Boils down the more complex internal state of this unit to
461 * a simpler one that the engine can understand */
462 UnitActiveState (*active_state
)(Unit
*u
);
464 /* Returns the substate specific to this unit type as
465 * string. This is purely information so that we can give the
466 * user a more fine grained explanation in which actual state a
468 const char* (*sub_state_to_string
)(Unit
*u
);
470 /* Additionally to UnitActiveState determine whether unit is to be restarted. */
471 bool (*will_restart
)(Unit
*u
);
473 /* Return false when there is a reason to prevent this unit from being gc'ed
474 * even though nothing references it and it isn't active in any way. */
475 bool (*may_gc
)(Unit
*u
);
477 /* When the unit is not running and no job for it queued we shall release its runtime resources */
478 void (*release_resources
)(Unit
*u
);
480 /* Invoked on every child that died */
481 void (*sigchld_event
)(Unit
*u
, pid_t pid
, int code
, int status
);
483 /* Reset failed state if we are in failed state */
484 void (*reset_failed
)(Unit
*u
);
486 /* Called whenever any of the cgroups this unit watches for
488 void (*notify_cgroup_empty
)(Unit
*u
);
490 /* Called whenever a process of this unit sends us a message */
491 void (*notify_message
)(Unit
*u
, const struct ucred
*ucred
, char **tags
, FDSet
*fds
);
493 /* Called whenever a name this Unit registered for comes or goes away. */
494 void (*bus_name_owner_change
)(Unit
*u
, const char *name
, const char *old_owner
, const char *new_owner
);
496 /* Called for each property that is being set */
497 int (*bus_set_property
)(Unit
*u
, const char *name
, sd_bus_message
*message
, UnitWriteFlags flags
, sd_bus_error
*error
);
499 /* Called after at least one property got changed to apply the necessary change */
500 int (*bus_commit_properties
)(Unit
*u
);
502 /* Return the unit this unit is following */
503 Unit
*(*following
)(Unit
*u
);
505 /* Return the set of units that are following each other */
506 int (*following_set
)(Unit
*u
, Set
**s
);
508 /* Invoked each time a unit this unit is triggering changes
509 * state or gains/loses a job */
510 void (*trigger_notify
)(Unit
*u
, Unit
*trigger
);
512 /* Called whenever CLOCK_REALTIME made a jump */
513 void (*time_change
)(Unit
*u
);
515 /* Returns the next timeout of a unit */
516 int (*get_timeout
)(Unit
*u
, usec_t
*timeout
);
518 /* Returns the main PID if there is any defined, or 0. */
519 pid_t (*main_pid
)(Unit
*u
);
521 /* Returns the main PID if there is any defined, or 0. */
522 pid_t (*control_pid
)(Unit
*u
);
524 /* Returns true if the unit currently needs access to the console */
525 bool (*needs_console
)(Unit
*u
);
527 /* This is called for each unit type and should be used to
528 * enumerate existing devices and load them. However,
529 * everything that is loaded here should still stay in
530 * inactive state. It is the job of the coldplug() call above
531 * to put the units into the initial state. */
532 void (*enumerate
)(Manager
*m
);
534 /* Type specific cleanups. */
535 void (*shutdown
)(Manager
*m
);
537 /* If this function is set and return false all jobs for units
538 * of this type will immediately fail. */
539 bool (*supported
)(void);
542 const sd_bus_vtable
*bus_vtable
;
544 /* The strings to print in status messages */
545 UnitStatusMessageFormats status_message_formats
;
547 /* True if transient units of this type are OK */
548 bool can_transient
:1;
550 /* True if cgroup delegation is permissible */
553 /* True if units of this type shall be startable only once and then never again */
556 /* True if queued jobs of this type should be GC'ed if no other job needs them anymore */
560 extern const UnitVTable
* const unit_vtable
[_UNIT_TYPE_MAX
];
562 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
564 /* For casting a unit into the various unit types */
565 #define DEFINE_CAST(UPPERCASE, MixedCase) \
566 static inline MixedCase* UPPERCASE(Unit *u) { \
567 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
570 return (MixedCase*) u; \
573 /* For casting the various unit types into a unit */
574 #define UNIT(u) (&(u)->meta)
576 #define UNIT_HAS_EXEC_CONTEXT(u) (UNIT_VTABLE(u)->exec_context_offset > 0)
577 #define UNIT_HAS_CGROUP_CONTEXT(u) (UNIT_VTABLE(u)->cgroup_context_offset > 0)
578 #define UNIT_HAS_KILL_CONTEXT(u) (UNIT_VTABLE(u)->kill_context_offset > 0)
580 #define UNIT_TRIGGER(u) ((Unit*) hashmap_first_key((u)->dependencies[UNIT_TRIGGERS]))
582 Unit
*unit_new(Manager
*m
, size_t size
);
583 void unit_free(Unit
*u
);
584 DEFINE_TRIVIAL_CLEANUP_FUNC(Unit
*, unit_free
);
586 int unit_new_for_name(Manager
*m
, size_t size
, const char *name
, Unit
**ret
);
587 int unit_add_name(Unit
*u
, const char *name
);
589 int unit_add_dependency(Unit
*u
, UnitDependency d
, Unit
*other
, bool add_reference
, UnitDependencyMask mask
);
590 int unit_add_two_dependencies(Unit
*u
, UnitDependency d
, UnitDependency e
, Unit
*other
, bool add_reference
, UnitDependencyMask mask
);
592 int unit_add_dependency_by_name(Unit
*u
, UnitDependency d
, const char *name
, const char *filename
, bool add_reference
, UnitDependencyMask mask
);
593 int unit_add_two_dependencies_by_name(Unit
*u
, UnitDependency d
, UnitDependency e
, const char *name
, const char *path
, bool add_reference
, UnitDependencyMask mask
);
595 int unit_add_exec_dependencies(Unit
*u
, ExecContext
*c
);
597 int unit_choose_id(Unit
*u
, const char *name
);
598 int unit_set_description(Unit
*u
, const char *description
);
600 bool unit_may_gc(Unit
*u
);
602 void unit_add_to_load_queue(Unit
*u
);
603 void unit_add_to_dbus_queue(Unit
*u
);
604 void unit_add_to_cleanup_queue(Unit
*u
);
605 void unit_add_to_gc_queue(Unit
*u
);
606 void unit_add_to_target_deps_queue(Unit
*u
);
608 int unit_merge(Unit
*u
, Unit
*other
);
609 int unit_merge_by_name(Unit
*u
, const char *other
);
611 Unit
*unit_follow_merge(Unit
*u
) _pure_
;
613 int unit_load_fragment_and_dropin(Unit
*u
);
614 int unit_load_fragment_and_dropin_optional(Unit
*u
);
615 int unit_load(Unit
*unit
);
617 int unit_set_slice(Unit
*u
, Unit
*slice
);
618 int unit_set_default_slice(Unit
*u
);
620 const char *unit_description(Unit
*u
) _pure_
;
622 bool unit_has_name(Unit
*u
, const char *name
);
624 UnitActiveState
unit_active_state(Unit
*u
);
626 const char* unit_sub_state_to_string(Unit
*u
);
628 void unit_dump(Unit
*u
, FILE *f
, const char *prefix
);
630 bool unit_can_reload(Unit
*u
) _pure_
;
631 bool unit_can_start(Unit
*u
) _pure_
;
632 bool unit_can_stop(Unit
*u
) _pure_
;
633 bool unit_can_isolate(Unit
*u
) _pure_
;
635 int unit_start(Unit
*u
);
636 int unit_stop(Unit
*u
);
637 int unit_reload(Unit
*u
);
639 int unit_kill(Unit
*u
, KillWho w
, int signo
, sd_bus_error
*error
);
640 int unit_kill_common(Unit
*u
, KillWho who
, int signo
, pid_t main_pid
, pid_t control_pid
, sd_bus_error
*error
);
642 void unit_notify(Unit
*u
, UnitActiveState os
, UnitActiveState ns
, bool reload_success
);
644 int unit_watch_pid(Unit
*u
, pid_t pid
);
645 void unit_unwatch_pid(Unit
*u
, pid_t pid
);
646 void unit_unwatch_all_pids(Unit
*u
);
648 void unit_tidy_watch_pids(Unit
*u
, pid_t except1
, pid_t except2
);
650 int unit_install_bus_match(Unit
*u
, sd_bus
*bus
, const char *name
);
651 int unit_watch_bus_name(Unit
*u
, const char *name
);
652 void unit_unwatch_bus_name(Unit
*u
, const char *name
);
654 bool unit_job_is_applicable(Unit
*u
, JobType j
);
656 int set_unit_path(const char *p
);
658 char *unit_dbus_path(Unit
*u
);
659 char *unit_dbus_path_invocation_id(Unit
*u
);
661 int unit_load_related_unit(Unit
*u
, const char *type
, Unit
**_found
);
663 bool unit_can_serialize(Unit
*u
) _pure_
;
665 int unit_serialize(Unit
*u
, FILE *f
, FDSet
*fds
, bool serialize_jobs
);
666 int unit_deserialize(Unit
*u
, FILE *f
, FDSet
*fds
);
667 void unit_deserialize_skip(FILE *f
);
669 int unit_serialize_item(Unit
*u
, FILE *f
, const char *key
, const char *value
);
670 int unit_serialize_item_escaped(Unit
*u
, FILE *f
, const char *key
, const char *value
);
671 int unit_serialize_item_fd(Unit
*u
, FILE *f
, FDSet
*fds
, const char *key
, int fd
);
672 void unit_serialize_item_format(Unit
*u
, FILE *f
, const char *key
, const char *value
, ...) _printf_(4,5);
674 int unit_add_node_dependency(Unit
*u
, const char *what
, bool wants
, UnitDependency d
, UnitDependencyMask mask
);
676 int unit_coldplug(Unit
*u
);
678 void unit_status_printf(Unit
*u
, const char *status
, const char *unit_status_msg_format
) _printf_(3, 0);
679 void unit_status_emit_starting_stopping_reloading(Unit
*u
, JobType t
);
681 bool unit_need_daemon_reload(Unit
*u
);
683 void unit_reset_failed(Unit
*u
);
685 Unit
*unit_following(Unit
*u
);
686 int unit_following_set(Unit
*u
, Set
**s
);
688 const char *unit_slice_name(Unit
*u
);
690 bool unit_stop_pending(Unit
*u
) _pure_
;
691 bool unit_inactive_or_pending(Unit
*u
) _pure_
;
692 bool unit_active_or_pending(Unit
*u
);
693 bool unit_will_restart(Unit
*u
);
695 int unit_add_default_target_dependency(Unit
*u
, Unit
*target
);
697 void unit_start_on_failure(Unit
*u
);
698 void unit_trigger_notify(Unit
*u
);
700 UnitFileState
unit_get_unit_file_state(Unit
*u
);
701 int unit_get_unit_file_preset(Unit
*u
);
703 Unit
* unit_ref_set(UnitRef
*ref
, Unit
*source
, Unit
*target
);
704 void unit_ref_unset(UnitRef
*ref
);
706 #define UNIT_DEREF(ref) ((ref).target)
707 #define UNIT_ISSET(ref) (!!(ref).target)
709 int unit_patch_contexts(Unit
*u
);
711 ExecContext
*unit_get_exec_context(Unit
*u
) _pure_
;
712 KillContext
*unit_get_kill_context(Unit
*u
) _pure_
;
713 CGroupContext
*unit_get_cgroup_context(Unit
*u
) _pure_
;
715 ExecRuntime
*unit_get_exec_runtime(Unit
*u
) _pure_
;
717 int unit_setup_exec_runtime(Unit
*u
);
718 int unit_setup_dynamic_creds(Unit
*u
);
720 char* unit_escape_setting(const char *s
, UnitWriteFlags flags
, char **buf
);
721 char* unit_concat_strv(char **l
, UnitWriteFlags flags
);
723 int unit_write_setting(Unit
*u
, UnitWriteFlags flags
, const char *name
, const char *data
);
724 int unit_write_settingf(Unit
*u
, UnitWriteFlags mode
, const char *name
, const char *format
, ...) _printf_(4,5);
726 int unit_kill_context(Unit
*u
, KillContext
*c
, KillOperation k
, pid_t main_pid
, pid_t control_pid
, bool main_pid_alien
);
728 int unit_make_transient(Unit
*u
);
730 int unit_require_mounts_for(Unit
*u
, const char *path
, UnitDependencyMask mask
);
732 bool unit_type_supported(UnitType t
);
734 bool unit_is_pristine(Unit
*u
);
736 pid_t
unit_control_pid(Unit
*u
);
737 pid_t
unit_main_pid(Unit
*u
);
739 static inline bool unit_supported(Unit
*u
) {
740 return unit_type_supported(u
->type
);
743 void unit_warn_if_dir_nonempty(Unit
*u
, const char* where
);
744 int unit_fail_if_noncanonical(Unit
*u
, const char* where
);
746 int unit_start_limit_test(Unit
*u
);
748 void unit_unref_uid(Unit
*u
, bool destroy_now
);
749 int unit_ref_uid(Unit
*u
, uid_t uid
, bool clean_ipc
);
751 void unit_unref_gid(Unit
*u
, bool destroy_now
);
752 int unit_ref_gid(Unit
*u
, gid_t gid
, bool clean_ipc
);
754 int unit_ref_uid_gid(Unit
*u
, uid_t uid
, gid_t gid
);
755 void unit_unref_uid_gid(Unit
*u
, bool destroy_now
);
757 void unit_notify_user_lookup(Unit
*u
, uid_t uid
, gid_t gid
);
759 int unit_set_invocation_id(Unit
*u
, sd_id128_t id
);
760 int unit_acquire_invocation_id(Unit
*u
);
762 bool unit_shall_confirm_spawn(Unit
*u
);
764 void unit_set_exec_params(Unit
*s
, ExecParameters
*p
);
766 int unit_fork_helper_process(Unit
*u
, const char *name
, pid_t
*ret
);
768 void unit_remove_dependencies(Unit
*u
, UnitDependencyMask mask
);
770 void unit_export_state_files(Unit
*u
);
771 void unit_unlink_state_files(Unit
*u
);
773 int unit_prepare_exec(Unit
*u
);
775 void unit_warn_leftover_processes(Unit
*u
);
777 bool unit_needs_console(Unit
*u
);
779 const char *unit_label_path(Unit
*u
);
781 int unit_pid_attachable(Unit
*unit
, pid_t pid
, sd_bus_error
*error
);
783 /* Macros which append UNIT= or USER_UNIT= to the message */
785 #define log_unit_full(unit, level, error, ...) \
787 const Unit *_u = (unit); \
788 _u ? log_object_internal(level, error, __FILE__, __LINE__, __func__, _u->manager->unit_log_field, _u->id, _u->manager->invocation_log_field, _u->invocation_id_string, ##__VA_ARGS__) : \
789 log_internal(level, error, __FILE__, __LINE__, __func__, ##__VA_ARGS__); \
792 #define log_unit_debug(unit, ...) log_unit_full(unit, LOG_DEBUG, 0, ##__VA_ARGS__)
793 #define log_unit_info(unit, ...) log_unit_full(unit, LOG_INFO, 0, ##__VA_ARGS__)
794 #define log_unit_notice(unit, ...) log_unit_full(unit, LOG_NOTICE, 0, ##__VA_ARGS__)
795 #define log_unit_warning(unit, ...) log_unit_full(unit, LOG_WARNING, 0, ##__VA_ARGS__)
796 #define log_unit_error(unit, ...) log_unit_full(unit, LOG_ERR, 0, ##__VA_ARGS__)
798 #define log_unit_debug_errno(unit, error, ...) log_unit_full(unit, LOG_DEBUG, error, ##__VA_ARGS__)
799 #define log_unit_info_errno(unit, error, ...) log_unit_full(unit, LOG_INFO, error, ##__VA_ARGS__)
800 #define log_unit_notice_errno(unit, error, ...) log_unit_full(unit, LOG_NOTICE, error, ##__VA_ARGS__)
801 #define log_unit_warning_errno(unit, error, ...) log_unit_full(unit, LOG_WARNING, error, ##__VA_ARGS__)
802 #define log_unit_error_errno(unit, error, ...) log_unit_full(unit, LOG_ERR, error, ##__VA_ARGS__)
804 #define LOG_UNIT_MESSAGE(unit, fmt, ...) "MESSAGE=%s: " fmt, (unit)->id, ##__VA_ARGS__
805 #define LOG_UNIT_ID(unit) (unit)->manager->unit_log_format_string, (unit)->id
806 #define LOG_UNIT_INVOCATION_ID(unit) (unit)->manager->invocation_log_format_string, (unit)->invocation_id_string
808 const char* collect_mode_to_string(CollectMode m
) _const_
;
809 CollectMode
collect_mode_from_string(const char *s
) _pure_
;