1 /* SPDX-License-Identifier: LGPL-2.1+ */
5 This file is part of systemd.
7 Copyright 2010 Lennart Poettering
9 systemd is free software; you can redistribute it and/or modify it
10 under the terms of the GNU Lesser General Public License as published by
11 the Free Software Foundation; either version 2.1 of the License, or
12 (at your option) any later version.
14 systemd is distributed in the hope that it will be useful, but
15 WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 Lesser General Public License for more details.
19 You should have received a copy of the GNU Lesser General Public License
20 along with systemd; If not, see <http://www.gnu.org/licenses/>.
27 typedef struct Unit Unit
;
28 typedef struct UnitVTable UnitVTable
;
29 typedef struct UnitRef UnitRef
;
30 typedef struct UnitStatusMessageFormats UnitStatusMessageFormats
;
32 #include "bpf-program.h"
33 #include "condition.h"
34 #include "emergency-action.h"
37 #include "unit-name.h"
40 typedef enum KillOperation
{
42 KILL_TERMINATE_AND_LOG
,
46 _KILL_OPERATION_INVALID
= -1
49 typedef enum CollectMode
{
51 COLLECT_INACTIVE_OR_FAILED
,
53 _COLLECT_MODE_INVALID
= -1,
56 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t
) {
57 return IN_SET(t
, UNIT_ACTIVE
, UNIT_RELOADING
);
60 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t
) {
61 return IN_SET(t
, UNIT_ACTIVE
, UNIT_ACTIVATING
, UNIT_RELOADING
);
64 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t
) {
65 return IN_SET(t
, UNIT_INACTIVE
, UNIT_FAILED
, UNIT_DEACTIVATING
);
68 static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t
) {
69 return IN_SET(t
, UNIT_INACTIVE
, UNIT_FAILED
);
72 /* Stores the 'reason' a dependency was created as a bit mask, i.e. due to which configuration source it came to be. We
73 * use this so that we can selectively flush out parts of dependencies again. Note that the same dependency might be
74 * created as a result of multiple "reasons", hence the bitmask. */
75 typedef enum UnitDependencyMask
{
76 /* Configured directly by the unit file, .wants/.requries symlink or drop-in, or as an immediate result of a
77 * non-dependency option configured that way. */
78 UNIT_DEPENDENCY_FILE
= 1 << 0,
80 /* As unconditional implicit dependency (not affected by unit configuration — except by the unit name and
82 UNIT_DEPENDENCY_IMPLICIT
= 1 << 1,
84 /* A dependency effected by DefaultDependencies=yes. Note that dependencies marked this way are conceptually
85 * just a subset of UNIT_DEPENDENCY_FILE, as DefaultDependencies= is itself a unit file setting that can only
86 * be set in unit files. We make this two separate bits only to help debugging how dependencies came to be. */
87 UNIT_DEPENDENCY_DEFAULT
= 1 << 2,
89 /* A dependency created from udev rules */
90 UNIT_DEPENDENCY_UDEV
= 1 << 3,
92 /* A dependency created because of some unit's RequiresMountsFor= setting */
93 UNIT_DEPENDENCY_PATH
= 1 << 4,
95 /* A dependency created because of data read from /proc/self/mountinfo and no other configuration source */
96 UNIT_DEPENDENCY_MOUNTINFO_IMPLICIT
= 1 << 5,
98 /* A dependency created because of data read from /proc/self/mountinfo, but conditionalized by
99 * DefaultDependencies= and thus also involving configuration from UNIT_DEPENDENCY_FILE sources */
100 UNIT_DEPENDENCY_MOUNTINFO_DEFAULT
= 1 << 6,
102 /* A dependency created because of data read from /proc/swaps and no other configuration source */
103 UNIT_DEPENDENCY_PROC_SWAP
= 1 << 7,
105 _UNIT_DEPENDENCY_MASK_FULL
= (1 << 8) - 1,
106 } UnitDependencyMask
;
108 /* The Unit's dependencies[] hashmaps use this structure as value. It has the same size as a void pointer, and thus can
109 * be stored directly as hashmap value, without any indirection. Note that this stores two masks, as both the origin
110 * and the destination of a dependency might have created it. */
111 typedef union UnitDependencyInfo
{
114 UnitDependencyMask origin_mask
:16;
115 UnitDependencyMask destination_mask
:16;
117 } UnitDependencyInfo
;
122 /* Keeps tracks of references to a unit. This is useful so
123 * that we can merge two units if necessary and correct all
124 * references to them */
126 Unit
*source
, *target
;
127 LIST_FIELDS(UnitRef
, refs_by_target
);
130 typedef enum UnitCGroupBPFState
{
131 UNIT_CGROUP_BPF_OFF
= 0,
132 UNIT_CGROUP_BPF_ON
= 1,
133 UNIT_CGROUP_BPF_INVALIDATED
= -1,
134 } UnitCGroupBPFState
;
140 UnitLoadState load_state
;
143 char *id
; /* One name is special because we use it for identification. Points to an entry in the names set */
148 /* For each dependency type we maintain a Hashmap whose key is the Unit* object, and the value encodes why the
149 * dependency exists, using the UnitDependencyInfo type */
150 Hashmap
*dependencies
[_UNIT_DEPENDENCY_MAX
];
152 /* Similar, for RequiresMountsFor= path dependencies. The key is the path, the value the UnitDependencyInfo type */
153 Hashmap
*requires_mounts_for
;
156 char **documentation
;
158 char *fragment_path
; /* if loaded from a config file this is the primary path to it */
159 char *source_path
; /* if converted, the source file */
162 usec_t fragment_mtime
;
166 /* If this is a transient unit we are currently writing, this is where we are writing it to */
167 FILE *transient_file
;
169 /* If there is something to do with this unit, then this is the installed job for it */
172 /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
175 /* The slot used for watching NameOwnerChanged signals */
176 sd_bus_slot
*match_bus_slot
;
178 /* References to this unit from clients */
179 sd_bus_track
*bus_track
;
180 char **deserialized_refs
;
182 /* Job timeout and action to take */
184 usec_t job_running_timeout
;
185 bool job_running_timeout_set
:1;
186 EmergencyAction job_timeout_action
;
187 char *job_timeout_reboot_arg
;
189 /* References to this */
190 LIST_HEAD(UnitRef
, refs_by_target
);
192 /* Conditions to check */
193 LIST_HEAD(Condition
, conditions
);
194 LIST_HEAD(Condition
, asserts
);
196 dual_timestamp condition_timestamp
;
197 dual_timestamp assert_timestamp
;
199 /* Updated whenever the low-level state changes */
200 dual_timestamp state_change_timestamp
;
202 /* Updated whenever the (high-level) active state enters or leaves the active or inactive states */
203 dual_timestamp inactive_exit_timestamp
;
204 dual_timestamp active_enter_timestamp
;
205 dual_timestamp active_exit_timestamp
;
206 dual_timestamp inactive_enter_timestamp
;
211 LIST_FIELDS(Unit
, units_by_type
);
213 /* All units which have requires_mounts_for set */
214 LIST_FIELDS(Unit
, has_requires_mounts_for
);
217 LIST_FIELDS(Unit
, load_queue
);
220 LIST_FIELDS(Unit
, dbus_queue
);
223 LIST_FIELDS(Unit
, cleanup_queue
);
226 LIST_FIELDS(Unit
, gc_queue
);
228 /* CGroup realize members queue */
229 LIST_FIELDS(Unit
, cgroup_realize_queue
);
231 /* cgroup empty queue */
232 LIST_FIELDS(Unit
, cgroup_empty_queue
);
234 /* Target dependencies queue */
235 LIST_FIELDS(Unit
, target_deps_queue
);
237 /* PIDs we keep an eye on. Note that a unit might have many
238 * more, but these are the ones we care enough about to
239 * process SIGCHLD for */
242 /* Used in SIGCHLD and sd_notify() message event invocation logic to avoid that we dispatch the same event
243 * multiple times on the same unit. */
247 /* Used during GC sweeps */
250 /* Error code when we didn't manage to load the unit (negative) */
253 /* Put a ratelimit on unit starting */
254 RateLimit start_limit
;
255 EmergencyAction start_limit_action
;
257 EmergencyAction failure_action
;
258 EmergencyAction success_action
;
261 /* Make sure we never enter endless loops with the check unneeded logic, or the BindsTo= logic */
262 RateLimit auto_stop_ratelimit
;
264 /* Reference to a specific UID/GID */
268 /* Cached unit file state and preset */
269 UnitFileState unit_file_state
;
270 int unit_file_preset
;
272 /* Where the cpu.stat or cpuacct.usage was at the time the unit was started */
273 nsec_t cpu_usage_base
;
274 nsec_t cpu_usage_last
; /* the most recently read value */
276 /* Counterparts in the cgroup filesystem */
278 CGroupMask cgroup_realized_mask
;
279 CGroupMask cgroup_enabled_mask
;
280 CGroupMask cgroup_subtree_mask
;
281 CGroupMask cgroup_members_mask
;
282 int cgroup_inotify_wd
;
284 /* IP BPF Firewalling/accounting */
285 int ip_accounting_ingress_map_fd
;
286 int ip_accounting_egress_map_fd
;
288 int ipv4_allow_map_fd
;
289 int ipv6_allow_map_fd
;
290 int ipv4_deny_map_fd
;
291 int ipv6_deny_map_fd
;
293 BPFProgram
*ip_bpf_ingress
, *ip_bpf_ingress_installed
;
294 BPFProgram
*ip_bpf_egress
, *ip_bpf_egress_installed
;
296 uint64_t ip_accounting_extra
[_CGROUP_IP_ACCOUNTING_METRIC_MAX
];
298 /* How to start OnFailure units */
299 JobMode on_failure_job_mode
;
301 /* Tweaking the GC logic */
302 CollectMode collect_mode
;
304 /* The current invocation ID */
305 sd_id128_t invocation_id
;
306 char invocation_id_string
[SD_ID128_STRING_MAX
]; /* useful when logging */
308 /* Garbage collect us we nobody wants or requires us anymore */
309 bool stop_when_unneeded
;
311 /* Create default dependencies */
312 bool default_dependencies
;
314 /* Refuse manual starting, allow starting only indirectly via dependency. */
315 bool refuse_manual_start
;
317 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
318 bool refuse_manual_stop
;
320 /* Allow isolation requests */
323 /* Ignore this unit when isolating */
324 bool ignore_on_isolate
;
326 /* Did the last condition check succeed? */
327 bool condition_result
;
330 /* Is this a transient unit? */
333 /* Is this a unit that is always running and cannot be stopped? */
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_target_deps_queue
:1;
344 bool sent_dbus_new_signal
:1;
349 bool cgroup_realized
:1;
350 bool cgroup_members_mask_valid
:1;
351 bool cgroup_subtree_mask_valid
:1;
353 UnitCGroupBPFState cgroup_bpf_state
:2;
355 /* Reset cgroup accounting next time we fork something off */
356 bool reset_accounting
:1;
358 bool start_limit_hit
:1;
360 /* Did we already invoke unit_coldplug() for this unit? */
363 /* For transient units: whether to add a bus track reference after creating the unit */
364 bool bus_track_add
:1;
366 /* Remember which unit state files we created */
367 bool exported_invocation_id
:1;
368 bool exported_log_level_max
:1;
369 bool exported_log_extra_fields
:1;
371 /* When writing transient unit files, stores which section we stored last. If < 0, we didn't write any yet. If
372 * == 0 we are in the [Unit] section, if > 0 we are in the unit type-specific section. */
373 int last_section_private
:2;
376 struct UnitStatusMessageFormats
{
377 const char *starting_stopping
[2];
378 const char *finished_start_job
[_JOB_RESULT_MAX
];
379 const char *finished_stop_job
[_JOB_RESULT_MAX
];
382 /* Flags used when writing drop-in files or transient unit files */
383 typedef enum UnitWriteFlags
{
384 /* Write a runtime unit file or drop-in (i.e. one below /run) */
385 UNIT_RUNTIME
= 1 << 0,
387 /* Write a persistent drop-in (i.e. one below /etc) */
388 UNIT_PERSISTENT
= 1 << 1,
390 /* Place this item in the per-unit-type private section, instead of [Unit] */
391 UNIT_PRIVATE
= 1 << 2,
393 /* Apply specifier escaping before writing */
394 UNIT_ESCAPE_SPECIFIERS
= 1 << 3,
396 /* Apply C escaping before writing */
397 UNIT_ESCAPE_C
= 1 << 4,
400 /* Returns true if neither persistent, nor runtime storage is requested, i.e. this is a check invocation only */
401 #define UNIT_WRITE_FLAGS_NOOP(flags) (((flags) & (UNIT_RUNTIME|UNIT_PERSISTENT)) == 0)
403 #include "automount.h"
414 /* How much memory does an object of this unit type need */
417 /* If greater than 0, the offset into the object where
418 * ExecContext is found, if the unit type has that */
419 size_t exec_context_offset
;
421 /* If greater than 0, the offset into the object where
422 * CGroupContext is found, if the unit type has that */
423 size_t cgroup_context_offset
;
425 /* If greater than 0, the offset into the object where
426 * KillContext is found, if the unit type has that */
427 size_t kill_context_offset
;
429 /* If greater than 0, the offset into the object where the
430 * pointer to ExecRuntime is found, if the unit type has
432 size_t exec_runtime_offset
;
434 /* If greater than 0, the offset into the object where the pointer to DynamicCreds is found, if the unit type
436 size_t dynamic_creds_offset
;
438 /* The name of the configuration file section with the private settings of this unit */
439 const char *private_section
;
441 /* Config file sections this unit type understands, separated
443 const char *sections
;
445 /* This should reset all type-specific variables. This should
446 * not allocate memory, and is called with zero-initialized
447 * data. It should hence only initialize variables that need
449 void (*init
)(Unit
*u
);
451 /* This should free all type-specific variables. It should be
453 void (*done
)(Unit
*u
);
455 /* Actually load data from disk. This may fail, and should set
456 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
457 * UNIT_STUB if no configuration could be found. */
458 int (*load
)(Unit
*u
);
460 /* If a lot of units got created via enumerate(), this is
461 * where to actually set the state and call unit_notify(). */
462 int (*coldplug
)(Unit
*u
);
464 void (*dump
)(Unit
*u
, FILE *f
, const char *prefix
);
466 int (*start
)(Unit
*u
);
467 int (*stop
)(Unit
*u
);
468 int (*reload
)(Unit
*u
);
470 int (*kill
)(Unit
*u
, KillWho w
, int signo
, sd_bus_error
*error
);
472 bool (*can_reload
)(Unit
*u
);
474 /* Write all data that cannot be restored from other sources
475 * away using unit_serialize_item() */
476 int (*serialize
)(Unit
*u
, FILE *f
, FDSet
*fds
);
478 /* Restore one item from the serialization */
479 int (*deserialize_item
)(Unit
*u
, const char *key
, const char *data
, FDSet
*fds
);
481 /* Try to match up fds with what we need for this unit */
482 void (*distribute_fds
)(Unit
*u
, FDSet
*fds
);
484 /* Boils down the more complex internal state of this unit to
485 * a simpler one that the engine can understand */
486 UnitActiveState (*active_state
)(Unit
*u
);
488 /* Returns the substate specific to this unit type as
489 * string. This is purely information so that we can give the
490 * user a more fine grained explanation in which actual state a
492 const char* (*sub_state_to_string
)(Unit
*u
);
494 /* Additionally to UnitActiveState determine whether unit is to be restarted. */
495 bool (*will_restart
)(Unit
*u
);
497 /* Return false when there is a reason to prevent this unit from being gc'ed
498 * even though nothing references it and it isn't active in any way. */
499 bool (*may_gc
)(Unit
*u
);
501 /* When the unit is not running and no job for it queued we shall release its runtime resources */
502 void (*release_resources
)(Unit
*u
);
504 /* Invoked on every child that died */
505 void (*sigchld_event
)(Unit
*u
, pid_t pid
, int code
, int status
);
507 /* Reset failed state if we are in failed state */
508 void (*reset_failed
)(Unit
*u
);
510 /* Called whenever any of the cgroups this unit watches for
512 void (*notify_cgroup_empty
)(Unit
*u
);
514 /* Called whenever a process of this unit sends us a message */
515 void (*notify_message
)(Unit
*u
, const struct ucred
*ucred
, char **tags
, FDSet
*fds
);
517 /* Called whenever a name this Unit registered for comes or goes away. */
518 void (*bus_name_owner_change
)(Unit
*u
, const char *name
, const char *old_owner
, const char *new_owner
);
520 /* Called for each property that is being set */
521 int (*bus_set_property
)(Unit
*u
, const char *name
, sd_bus_message
*message
, UnitWriteFlags flags
, sd_bus_error
*error
);
523 /* Called after at least one property got changed to apply the necessary change */
524 int (*bus_commit_properties
)(Unit
*u
);
526 /* Return the unit this unit is following */
527 Unit
*(*following
)(Unit
*u
);
529 /* Return the set of units that are following each other */
530 int (*following_set
)(Unit
*u
, Set
**s
);
532 /* Invoked each time a unit this unit is triggering changes
533 * state or gains/loses a job */
534 void (*trigger_notify
)(Unit
*u
, Unit
*trigger
);
536 /* Called whenever CLOCK_REALTIME made a jump */
537 void (*time_change
)(Unit
*u
);
539 /* Returns the next timeout of a unit */
540 int (*get_timeout
)(Unit
*u
, usec_t
*timeout
);
542 /* Returns the main PID if there is any defined, or 0. */
543 pid_t (*main_pid
)(Unit
*u
);
545 /* Returns the main PID if there is any defined, or 0. */
546 pid_t (*control_pid
)(Unit
*u
);
548 /* Returns true if the unit currently needs access to the console */
549 bool (*needs_console
)(Unit
*u
);
551 /* This is called for each unit type and should be used to
552 * enumerate existing devices and load them. However,
553 * everything that is loaded here should still stay in
554 * inactive state. It is the job of the coldplug() call above
555 * to put the units into the initial state. */
556 void (*enumerate
)(Manager
*m
);
558 /* Type specific cleanups. */
559 void (*shutdown
)(Manager
*m
);
561 /* If this function is set and return false all jobs for units
562 * of this type will immediately fail. */
563 bool (*supported
)(void);
566 const sd_bus_vtable
*bus_vtable
;
568 /* The strings to print in status messages */
569 UnitStatusMessageFormats status_message_formats
;
571 /* True if transient units of this type are OK */
572 bool can_transient
:1;
574 /* True if cgroup delegation is permissible */
577 /* True if queued jobs of this type should be GC'ed if no other job needs them anymore */
581 extern const UnitVTable
* const unit_vtable
[_UNIT_TYPE_MAX
];
583 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
585 /* For casting a unit into the various unit types */
586 #define DEFINE_CAST(UPPERCASE, MixedCase) \
587 static inline MixedCase* UPPERCASE(Unit *u) { \
588 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
591 return (MixedCase*) u; \
594 /* For casting the various unit types into a unit */
595 #define UNIT(u) (&(u)->meta)
597 #define UNIT_HAS_EXEC_CONTEXT(u) (UNIT_VTABLE(u)->exec_context_offset > 0)
598 #define UNIT_HAS_CGROUP_CONTEXT(u) (UNIT_VTABLE(u)->cgroup_context_offset > 0)
599 #define UNIT_HAS_KILL_CONTEXT(u) (UNIT_VTABLE(u)->kill_context_offset > 0)
601 #define UNIT_TRIGGER(u) ((Unit*) hashmap_first_key((u)->dependencies[UNIT_TRIGGERS]))
603 DEFINE_CAST(SERVICE
, Service
);
604 DEFINE_CAST(SOCKET
, Socket
);
605 DEFINE_CAST(TARGET
, Target
);
606 DEFINE_CAST(DEVICE
, Device
);
607 DEFINE_CAST(MOUNT
, Mount
);
608 DEFINE_CAST(AUTOMOUNT
, Automount
);
609 DEFINE_CAST(SWAP
, Swap
);
610 DEFINE_CAST(TIMER
, Timer
);
611 DEFINE_CAST(PATH
, Path
);
612 DEFINE_CAST(SLICE
, Slice
);
613 DEFINE_CAST(SCOPE
, Scope
);
615 Unit
*unit_new(Manager
*m
, size_t size
);
616 void unit_free(Unit
*u
);
617 DEFINE_TRIVIAL_CLEANUP_FUNC(Unit
*, unit_free
);
619 int unit_new_for_name(Manager
*m
, size_t size
, const char *name
, Unit
**ret
);
620 int unit_add_name(Unit
*u
, const char *name
);
622 int unit_add_dependency(Unit
*u
, UnitDependency d
, Unit
*other
, bool add_reference
, UnitDependencyMask mask
);
623 int unit_add_two_dependencies(Unit
*u
, UnitDependency d
, UnitDependency e
, Unit
*other
, bool add_reference
, UnitDependencyMask mask
);
625 int unit_add_dependency_by_name(Unit
*u
, UnitDependency d
, const char *name
, const char *filename
, bool add_reference
, UnitDependencyMask mask
);
626 int unit_add_two_dependencies_by_name(Unit
*u
, UnitDependency d
, UnitDependency e
, const char *name
, const char *path
, bool add_reference
, UnitDependencyMask mask
);
628 int unit_add_exec_dependencies(Unit
*u
, ExecContext
*c
);
630 int unit_choose_id(Unit
*u
, const char *name
);
631 int unit_set_description(Unit
*u
, const char *description
);
633 bool unit_may_gc(Unit
*u
);
635 void unit_add_to_load_queue(Unit
*u
);
636 void unit_add_to_dbus_queue(Unit
*u
);
637 void unit_add_to_cleanup_queue(Unit
*u
);
638 void unit_add_to_gc_queue(Unit
*u
);
639 void unit_add_to_target_deps_queue(Unit
*u
);
641 int unit_merge(Unit
*u
, Unit
*other
);
642 int unit_merge_by_name(Unit
*u
, const char *other
);
644 Unit
*unit_follow_merge(Unit
*u
) _pure_
;
646 int unit_load_fragment_and_dropin(Unit
*u
);
647 int unit_load_fragment_and_dropin_optional(Unit
*u
);
648 int unit_load(Unit
*unit
);
650 int unit_set_slice(Unit
*u
, Unit
*slice
);
651 int unit_set_default_slice(Unit
*u
);
653 const char *unit_description(Unit
*u
) _pure_
;
655 bool unit_has_name(Unit
*u
, const char *name
);
657 UnitActiveState
unit_active_state(Unit
*u
);
659 const char* unit_sub_state_to_string(Unit
*u
);
661 void unit_dump(Unit
*u
, FILE *f
, const char *prefix
);
663 bool unit_can_reload(Unit
*u
) _pure_
;
664 bool unit_can_start(Unit
*u
) _pure_
;
665 bool unit_can_stop(Unit
*u
) _pure_
;
666 bool unit_can_isolate(Unit
*u
) _pure_
;
668 int unit_start(Unit
*u
);
669 int unit_stop(Unit
*u
);
670 int unit_reload(Unit
*u
);
672 int unit_kill(Unit
*u
, KillWho w
, int signo
, sd_bus_error
*error
);
673 int unit_kill_common(Unit
*u
, KillWho who
, int signo
, pid_t main_pid
, pid_t control_pid
, sd_bus_error
*error
);
675 void unit_notify(Unit
*u
, UnitActiveState os
, UnitActiveState ns
, bool reload_success
);
677 int unit_watch_pid(Unit
*u
, pid_t pid
);
678 void unit_unwatch_pid(Unit
*u
, pid_t pid
);
679 void unit_unwatch_all_pids(Unit
*u
);
681 void unit_tidy_watch_pids(Unit
*u
, pid_t except1
, pid_t except2
);
683 int unit_install_bus_match(Unit
*u
, sd_bus
*bus
, const char *name
);
684 int unit_watch_bus_name(Unit
*u
, const char *name
);
685 void unit_unwatch_bus_name(Unit
*u
, const char *name
);
687 bool unit_job_is_applicable(Unit
*u
, JobType j
);
689 int set_unit_path(const char *p
);
691 char *unit_dbus_path(Unit
*u
);
692 char *unit_dbus_path_invocation_id(Unit
*u
);
694 int unit_load_related_unit(Unit
*u
, const char *type
, Unit
**_found
);
696 bool unit_can_serialize(Unit
*u
) _pure_
;
698 int unit_serialize(Unit
*u
, FILE *f
, FDSet
*fds
, bool serialize_jobs
);
699 int unit_deserialize(Unit
*u
, FILE *f
, FDSet
*fds
);
700 void unit_deserialize_skip(FILE *f
);
702 int unit_serialize_item(Unit
*u
, FILE *f
, const char *key
, const char *value
);
703 int unit_serialize_item_escaped(Unit
*u
, FILE *f
, const char *key
, const char *value
);
704 int unit_serialize_item_fd(Unit
*u
, FILE *f
, FDSet
*fds
, const char *key
, int fd
);
705 void unit_serialize_item_format(Unit
*u
, FILE *f
, const char *key
, const char *value
, ...) _printf_(4,5);
707 int unit_add_node_dependency(Unit
*u
, const char *what
, bool wants
, UnitDependency d
, UnitDependencyMask mask
);
709 int unit_coldplug(Unit
*u
);
711 void unit_status_printf(Unit
*u
, const char *status
, const char *unit_status_msg_format
) _printf_(3, 0);
712 void unit_status_emit_starting_stopping_reloading(Unit
*u
, JobType t
);
714 bool unit_need_daemon_reload(Unit
*u
);
716 void unit_reset_failed(Unit
*u
);
718 Unit
*unit_following(Unit
*u
);
719 int unit_following_set(Unit
*u
, Set
**s
);
721 const char *unit_slice_name(Unit
*u
);
723 bool unit_stop_pending(Unit
*u
) _pure_
;
724 bool unit_inactive_or_pending(Unit
*u
) _pure_
;
725 bool unit_active_or_pending(Unit
*u
);
726 bool unit_will_restart(Unit
*u
);
728 int unit_add_default_target_dependency(Unit
*u
, Unit
*target
);
730 void unit_start_on_failure(Unit
*u
);
731 void unit_trigger_notify(Unit
*u
);
733 UnitFileState
unit_get_unit_file_state(Unit
*u
);
734 int unit_get_unit_file_preset(Unit
*u
);
736 Unit
* unit_ref_set(UnitRef
*ref
, Unit
*source
, Unit
*target
);
737 void unit_ref_unset(UnitRef
*ref
);
739 #define UNIT_DEREF(ref) ((ref).target)
740 #define UNIT_ISSET(ref) (!!(ref).target)
742 int unit_patch_contexts(Unit
*u
);
744 ExecContext
*unit_get_exec_context(Unit
*u
) _pure_
;
745 KillContext
*unit_get_kill_context(Unit
*u
) _pure_
;
746 CGroupContext
*unit_get_cgroup_context(Unit
*u
) _pure_
;
748 ExecRuntime
*unit_get_exec_runtime(Unit
*u
) _pure_
;
750 int unit_setup_exec_runtime(Unit
*u
);
751 int unit_setup_dynamic_creds(Unit
*u
);
753 char* unit_escape_setting(const char *s
, UnitWriteFlags flags
, char **buf
);
754 char* unit_concat_strv(char **l
, UnitWriteFlags flags
);
756 int unit_write_setting(Unit
*u
, UnitWriteFlags flags
, const char *name
, const char *data
);
757 int unit_write_settingf(Unit
*u
, UnitWriteFlags mode
, const char *name
, const char *format
, ...) _printf_(4,5);
759 int unit_kill_context(Unit
*u
, KillContext
*c
, KillOperation k
, pid_t main_pid
, pid_t control_pid
, bool main_pid_alien
);
761 int unit_make_transient(Unit
*u
);
763 int unit_require_mounts_for(Unit
*u
, const char *path
, UnitDependencyMask mask
);
765 bool unit_type_supported(UnitType t
);
767 bool unit_is_pristine(Unit
*u
);
769 pid_t
unit_control_pid(Unit
*u
);
770 pid_t
unit_main_pid(Unit
*u
);
772 static inline bool unit_supported(Unit
*u
) {
773 return unit_type_supported(u
->type
);
776 void unit_warn_if_dir_nonempty(Unit
*u
, const char* where
);
777 int unit_fail_if_noncanonical(Unit
*u
, const char* where
);
779 int unit_start_limit_test(Unit
*u
);
781 void unit_unref_uid(Unit
*u
, bool destroy_now
);
782 int unit_ref_uid(Unit
*u
, uid_t uid
, bool clean_ipc
);
784 void unit_unref_gid(Unit
*u
, bool destroy_now
);
785 int unit_ref_gid(Unit
*u
, gid_t gid
, bool clean_ipc
);
787 int unit_ref_uid_gid(Unit
*u
, uid_t uid
, gid_t gid
);
788 void unit_unref_uid_gid(Unit
*u
, bool destroy_now
);
790 void unit_notify_user_lookup(Unit
*u
, uid_t uid
, gid_t gid
);
792 int unit_set_invocation_id(Unit
*u
, sd_id128_t id
);
793 int unit_acquire_invocation_id(Unit
*u
);
795 bool unit_shall_confirm_spawn(Unit
*u
);
797 void unit_set_exec_params(Unit
*s
, ExecParameters
*p
);
799 int unit_fork_helper_process(Unit
*u
, const char *name
, pid_t
*ret
);
801 void unit_remove_dependencies(Unit
*u
, UnitDependencyMask mask
);
803 void unit_export_state_files(Unit
*u
);
804 void unit_unlink_state_files(Unit
*u
);
806 int unit_prepare_exec(Unit
*u
);
808 void unit_warn_leftover_processes(Unit
*u
);
810 bool unit_needs_console(Unit
*u
);
812 const char *unit_label_path(Unit
*u
);
814 int unit_pid_attachable(Unit
*unit
, pid_t pid
, sd_bus_error
*error
);
816 /* Macros which append UNIT= or USER_UNIT= to the message */
818 #define log_unit_full(unit, level, error, ...) \
820 const Unit *_u = (unit); \
821 _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__) : \
822 log_internal(level, error, __FILE__, __LINE__, __func__, ##__VA_ARGS__); \
825 #define log_unit_debug(unit, ...) log_unit_full(unit, LOG_DEBUG, 0, ##__VA_ARGS__)
826 #define log_unit_info(unit, ...) log_unit_full(unit, LOG_INFO, 0, ##__VA_ARGS__)
827 #define log_unit_notice(unit, ...) log_unit_full(unit, LOG_NOTICE, 0, ##__VA_ARGS__)
828 #define log_unit_warning(unit, ...) log_unit_full(unit, LOG_WARNING, 0, ##__VA_ARGS__)
829 #define log_unit_error(unit, ...) log_unit_full(unit, LOG_ERR, 0, ##__VA_ARGS__)
831 #define log_unit_debug_errno(unit, error, ...) log_unit_full(unit, LOG_DEBUG, error, ##__VA_ARGS__)
832 #define log_unit_info_errno(unit, error, ...) log_unit_full(unit, LOG_INFO, error, ##__VA_ARGS__)
833 #define log_unit_notice_errno(unit, error, ...) log_unit_full(unit, LOG_NOTICE, error, ##__VA_ARGS__)
834 #define log_unit_warning_errno(unit, error, ...) log_unit_full(unit, LOG_WARNING, error, ##__VA_ARGS__)
835 #define log_unit_error_errno(unit, error, ...) log_unit_full(unit, LOG_ERR, error, ##__VA_ARGS__)
837 #define LOG_UNIT_MESSAGE(unit, fmt, ...) "MESSAGE=%s: " fmt, (unit)->id, ##__VA_ARGS__
838 #define LOG_UNIT_ID(unit) (unit)->manager->unit_log_format_string, (unit)->id
839 #define LOG_UNIT_INVOCATION_ID(unit) (unit)->manager->invocation_log_format_string, (unit)->invocation_id_string
841 const char* collect_mode_to_string(CollectMode m
) _const_
;
842 CollectMode
collect_mode_from_string(const char *s
) _pure_
;