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 */
127 LIST_FIELDS(UnitRef
, refs
);
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
);
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 /* PIDs we keep an eye on. Note that a unit might have many
235 * more, but these are the ones we care enough about to
236 * process SIGCHLD for */
239 /* Used in sigchld event invocation to avoid repeat events being invoked */
242 /* Used during GC sweeps */
245 /* Error code when we didn't manage to load the unit (negative) */
248 /* Put a ratelimit on unit starting */
249 RateLimit start_limit
;
250 EmergencyAction start_limit_action
;
252 EmergencyAction failure_action
;
253 EmergencyAction success_action
;
256 /* Make sure we never enter endless loops with the check unneeded logic, or the BindsTo= logic */
257 RateLimit auto_stop_ratelimit
;
259 /* Reference to a specific UID/GID */
263 /* Cached unit file state and preset */
264 UnitFileState unit_file_state
;
265 int unit_file_preset
;
267 /* Where the cpu.stat or cpuacct.usage was at the time the unit was started */
268 nsec_t cpu_usage_base
;
269 nsec_t cpu_usage_last
; /* the most recently read value */
271 /* Counterparts in the cgroup filesystem */
273 CGroupMask cgroup_realized_mask
;
274 CGroupMask cgroup_enabled_mask
;
275 CGroupMask cgroup_subtree_mask
;
276 CGroupMask cgroup_members_mask
;
277 int cgroup_inotify_wd
;
279 /* IP BPF Firewalling/accounting */
280 int ip_accounting_ingress_map_fd
;
281 int ip_accounting_egress_map_fd
;
283 int ipv4_allow_map_fd
;
284 int ipv6_allow_map_fd
;
285 int ipv4_deny_map_fd
;
286 int ipv6_deny_map_fd
;
288 BPFProgram
*ip_bpf_ingress
;
289 BPFProgram
*ip_bpf_egress
;
291 uint64_t ip_accounting_extra
[_CGROUP_IP_ACCOUNTING_METRIC_MAX
];
293 /* How to start OnFailure units */
294 JobMode on_failure_job_mode
;
296 /* Tweaking the GC logic */
297 CollectMode collect_mode
;
299 /* The current invocation ID */
300 sd_id128_t invocation_id
;
301 char invocation_id_string
[SD_ID128_STRING_MAX
]; /* useful when logging */
303 /* Garbage collect us we nobody wants or requires us anymore */
304 bool stop_when_unneeded
;
306 /* Create default dependencies */
307 bool default_dependencies
;
309 /* Refuse manual starting, allow starting only indirectly via dependency. */
310 bool refuse_manual_start
;
312 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
313 bool refuse_manual_stop
;
315 /* Allow isolation requests */
318 /* Ignore this unit when isolating */
319 bool ignore_on_isolate
;
321 /* Did the last condition check succeed? */
322 bool condition_result
;
325 /* Is this a transient unit? */
328 /* Is this a unit that is always running and cannot be stopped? */
331 bool in_load_queue
:1;
332 bool in_dbus_queue
:1;
333 bool in_cleanup_queue
:1;
335 bool in_cgroup_realize_queue
:1;
336 bool in_cgroup_empty_queue
:1;
338 bool sent_dbus_new_signal
:1;
342 bool cgroup_realized
:1;
343 bool cgroup_members_mask_valid
:1;
344 bool cgroup_subtree_mask_valid
:1;
346 UnitCGroupBPFState cgroup_bpf_state
:2;
348 /* Reset cgroup accounting next time we fork something off */
349 bool reset_accounting
:1;
351 bool start_limit_hit
:1;
353 /* Did we already invoke unit_coldplug() for this unit? */
356 /* For transient units: whether to add a bus track reference after creating the unit */
357 bool bus_track_add
:1;
359 /* Remember which unit state files we created */
360 bool exported_invocation_id
:1;
361 bool exported_log_level_max
:1;
362 bool exported_log_extra_fields
:1;
364 /* When writing transient unit files, stores which section we stored last. If < 0, we didn't write any yet. If
365 * == 0 we are in the [Unit] section, if > 0 we are in the unit type-specific section. */
366 int last_section_private
:2;
369 struct UnitStatusMessageFormats
{
370 const char *starting_stopping
[2];
371 const char *finished_start_job
[_JOB_RESULT_MAX
];
372 const char *finished_stop_job
[_JOB_RESULT_MAX
];
375 /* Flags used when writing drop-in files or transient unit files */
376 typedef enum UnitWriteFlags
{
377 /* Write a runtime unit file or drop-in (i.e. one below /run) */
378 UNIT_RUNTIME
= 1 << 0,
380 /* Write a persistent drop-in (i.e. one below /etc) */
381 UNIT_PERSISTENT
= 1 << 1,
383 /* Place this item in the per-unit-type private section, instead of [Unit] */
384 UNIT_PRIVATE
= 1 << 2,
386 /* Apply specifier escaping before writing */
387 UNIT_ESCAPE_SPECIFIERS
= 1 << 3,
389 /* Apply C escaping before writing */
390 UNIT_ESCAPE_C
= 1 << 4,
393 /* Returns true if neither persistent, nor runtime storage is requested, i.e. this is a check invocation only */
394 #define UNIT_WRITE_FLAGS_NOOP(flags) (((flags) & (UNIT_RUNTIME|UNIT_PERSISTENT)) == 0)
396 #include "automount.h"
407 /* How much memory does an object of this unit type need */
410 /* If greater than 0, the offset into the object where
411 * ExecContext is found, if the unit type has that */
412 size_t exec_context_offset
;
414 /* If greater than 0, the offset into the object where
415 * CGroupContext is found, if the unit type has that */
416 size_t cgroup_context_offset
;
418 /* If greater than 0, the offset into the object where
419 * KillContext is found, if the unit type has that */
420 size_t kill_context_offset
;
422 /* If greater than 0, the offset into the object where the
423 * pointer to ExecRuntime is found, if the unit type has
425 size_t exec_runtime_offset
;
427 /* If greater than 0, the offset into the object where the pointer to DynamicCreds is found, if the unit type
429 size_t dynamic_creds_offset
;
431 /* The name of the configuration file section with the private settings of this unit */
432 const char *private_section
;
434 /* Config file sections this unit type understands, separated
436 const char *sections
;
438 /* This should reset all type-specific variables. This should
439 * not allocate memory, and is called with zero-initialized
440 * data. It should hence only initialize variables that need
442 void (*init
)(Unit
*u
);
444 /* This should free all type-specific variables. It should be
446 void (*done
)(Unit
*u
);
448 /* Actually load data from disk. This may fail, and should set
449 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
450 * UNIT_STUB if no configuration could be found. */
451 int (*load
)(Unit
*u
);
453 /* If a lot of units got created via enumerate(), this is
454 * where to actually set the state and call unit_notify(). */
455 int (*coldplug
)(Unit
*u
);
457 void (*dump
)(Unit
*u
, FILE *f
, const char *prefix
);
459 int (*start
)(Unit
*u
);
460 int (*stop
)(Unit
*u
);
461 int (*reload
)(Unit
*u
);
463 int (*kill
)(Unit
*u
, KillWho w
, int signo
, sd_bus_error
*error
);
465 bool (*can_reload
)(Unit
*u
);
467 /* Write all data that cannot be restored from other sources
468 * away using unit_serialize_item() */
469 int (*serialize
)(Unit
*u
, FILE *f
, FDSet
*fds
);
471 /* Restore one item from the serialization */
472 int (*deserialize_item
)(Unit
*u
, const char *key
, const char *data
, FDSet
*fds
);
474 /* Try to match up fds with what we need for this unit */
475 void (*distribute_fds
)(Unit
*u
, FDSet
*fds
);
477 /* Boils down the more complex internal state of this unit to
478 * a simpler one that the engine can understand */
479 UnitActiveState (*active_state
)(Unit
*u
);
481 /* Returns the substate specific to this unit type as
482 * string. This is purely information so that we can give the
483 * user a more fine grained explanation in which actual state a
485 const char* (*sub_state_to_string
)(Unit
*u
);
487 /* Additionally to UnitActiveState determine whether unit is to be restarted. */
488 bool (*will_restart
)(Unit
*u
);
490 /* Return true when there is reason to keep this entry around
491 * even nothing references it and it isn't active in any
493 bool (*check_gc
)(Unit
*u
);
495 /* When the unit is not running and no job for it queued we shall release its runtime resources */
496 void (*release_resources
)(Unit
*u
);
498 /* Invoked on every child that died */
499 void (*sigchld_event
)(Unit
*u
, pid_t pid
, int code
, int status
);
501 /* Reset failed state if we are in failed state */
502 void (*reset_failed
)(Unit
*u
);
504 /* Called whenever any of the cgroups this unit watches for
506 void (*notify_cgroup_empty
)(Unit
*u
);
508 /* Called whenever a process of this unit sends us a message */
509 void (*notify_message
)(Unit
*u
, pid_t pid
, char **tags
, FDSet
*fds
);
511 /* Called whenever a name this Unit registered for comes or goes away. */
512 void (*bus_name_owner_change
)(Unit
*u
, const char *name
, const char *old_owner
, const char *new_owner
);
514 /* Called for each property that is being set */
515 int (*bus_set_property
)(Unit
*u
, const char *name
, sd_bus_message
*message
, UnitWriteFlags flags
, sd_bus_error
*error
);
517 /* Called after at least one property got changed to apply the necessary change */
518 int (*bus_commit_properties
)(Unit
*u
);
520 /* Return the unit this unit is following */
521 Unit
*(*following
)(Unit
*u
);
523 /* Return the set of units that are following each other */
524 int (*following_set
)(Unit
*u
, Set
**s
);
526 /* Invoked each time a unit this unit is triggering changes
527 * state or gains/loses a job */
528 void (*trigger_notify
)(Unit
*u
, Unit
*trigger
);
530 /* Called whenever CLOCK_REALTIME made a jump */
531 void (*time_change
)(Unit
*u
);
533 /* Returns the next timeout of a unit */
534 int (*get_timeout
)(Unit
*u
, usec_t
*timeout
);
536 /* Returns the main PID if there is any defined, or 0. */
537 pid_t (*main_pid
)(Unit
*u
);
539 /* Returns the main PID if there is any defined, or 0. */
540 pid_t (*control_pid
)(Unit
*u
);
542 /* This is called for each unit type and should be used to
543 * enumerate existing devices and load them. However,
544 * everything that is loaded here should still stay in
545 * inactive state. It is the job of the coldplug() call above
546 * to put the units into the initial state. */
547 void (*enumerate
)(Manager
*m
);
549 /* Type specific cleanups. */
550 void (*shutdown
)(Manager
*m
);
552 /* If this function is set and return false all jobs for units
553 * of this type will immediately fail. */
554 bool (*supported
)(void);
557 const sd_bus_vtable
*bus_vtable
;
559 /* The strings to print in status messages */
560 UnitStatusMessageFormats status_message_formats
;
562 /* True if transient units of this type are OK */
563 bool can_transient
:1;
565 /* True if queued jobs of this type should be GC'ed if no other job needs them anymore */
569 extern const UnitVTable
* const unit_vtable
[_UNIT_TYPE_MAX
];
571 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
573 /* For casting a unit into the various unit types */
574 #define DEFINE_CAST(UPPERCASE, MixedCase) \
575 static inline MixedCase* UPPERCASE(Unit *u) { \
576 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
579 return (MixedCase*) u; \
582 /* For casting the various unit types into a unit */
583 #define UNIT(u) (&(u)->meta)
585 #define UNIT_HAS_EXEC_CONTEXT(u) (UNIT_VTABLE(u)->exec_context_offset > 0)
586 #define UNIT_HAS_CGROUP_CONTEXT(u) (UNIT_VTABLE(u)->cgroup_context_offset > 0)
587 #define UNIT_HAS_KILL_CONTEXT(u) (UNIT_VTABLE(u)->kill_context_offset > 0)
589 #define UNIT_TRIGGER(u) ((Unit*) hashmap_first_key((u)->dependencies[UNIT_TRIGGERS]))
591 DEFINE_CAST(SERVICE
, Service
);
592 DEFINE_CAST(SOCKET
, Socket
);
593 DEFINE_CAST(TARGET
, Target
);
594 DEFINE_CAST(DEVICE
, Device
);
595 DEFINE_CAST(MOUNT
, Mount
);
596 DEFINE_CAST(AUTOMOUNT
, Automount
);
597 DEFINE_CAST(SWAP
, Swap
);
598 DEFINE_CAST(TIMER
, Timer
);
599 DEFINE_CAST(PATH
, Path
);
600 DEFINE_CAST(SLICE
, Slice
);
601 DEFINE_CAST(SCOPE
, Scope
);
603 Unit
*unit_new(Manager
*m
, size_t size
);
604 void unit_free(Unit
*u
);
606 int unit_new_for_name(Manager
*m
, size_t size
, const char *name
, Unit
**ret
);
607 int unit_add_name(Unit
*u
, const char *name
);
609 int unit_add_dependency(Unit
*u
, UnitDependency d
, Unit
*other
, bool add_reference
, UnitDependencyMask mask
);
610 int unit_add_two_dependencies(Unit
*u
, UnitDependency d
, UnitDependency e
, Unit
*other
, bool add_reference
, UnitDependencyMask mask
);
612 int unit_add_dependency_by_name(Unit
*u
, UnitDependency d
, const char *name
, const char *filename
, bool add_reference
, UnitDependencyMask mask
);
613 int unit_add_two_dependencies_by_name(Unit
*u
, UnitDependency d
, UnitDependency e
, const char *name
, const char *path
, bool add_reference
, UnitDependencyMask mask
);
615 int unit_add_exec_dependencies(Unit
*u
, ExecContext
*c
);
617 int unit_choose_id(Unit
*u
, const char *name
);
618 int unit_set_description(Unit
*u
, const char *description
);
620 bool unit_check_gc(Unit
*u
);
622 void unit_add_to_load_queue(Unit
*u
);
623 void unit_add_to_dbus_queue(Unit
*u
);
624 void unit_add_to_cleanup_queue(Unit
*u
);
625 void unit_add_to_gc_queue(Unit
*u
);
627 int unit_merge(Unit
*u
, Unit
*other
);
628 int unit_merge_by_name(Unit
*u
, const char *other
);
630 Unit
*unit_follow_merge(Unit
*u
) _pure_
;
632 int unit_load_fragment_and_dropin(Unit
*u
);
633 int unit_load_fragment_and_dropin_optional(Unit
*u
);
634 int unit_load(Unit
*unit
);
636 int unit_set_slice(Unit
*u
, Unit
*slice
);
637 int unit_set_default_slice(Unit
*u
);
639 const char *unit_description(Unit
*u
) _pure_
;
641 bool unit_has_name(Unit
*u
, const char *name
);
643 UnitActiveState
unit_active_state(Unit
*u
);
645 const char* unit_sub_state_to_string(Unit
*u
);
647 void unit_dump(Unit
*u
, FILE *f
, const char *prefix
);
649 bool unit_can_reload(Unit
*u
) _pure_
;
650 bool unit_can_start(Unit
*u
) _pure_
;
651 bool unit_can_stop(Unit
*u
) _pure_
;
652 bool unit_can_isolate(Unit
*u
) _pure_
;
654 int unit_start(Unit
*u
);
655 int unit_stop(Unit
*u
);
656 int unit_reload(Unit
*u
);
658 int unit_kill(Unit
*u
, KillWho w
, int signo
, sd_bus_error
*error
);
659 int unit_kill_common(Unit
*u
, KillWho who
, int signo
, pid_t main_pid
, pid_t control_pid
, sd_bus_error
*error
);
661 void unit_notify(Unit
*u
, UnitActiveState os
, UnitActiveState ns
, bool reload_success
);
663 int unit_watch_pid(Unit
*u
, pid_t pid
);
664 void unit_unwatch_pid(Unit
*u
, pid_t pid
);
665 void unit_unwatch_all_pids(Unit
*u
);
667 void unit_tidy_watch_pids(Unit
*u
, pid_t except1
, pid_t except2
);
669 int unit_install_bus_match(Unit
*u
, sd_bus
*bus
, const char *name
);
670 int unit_watch_bus_name(Unit
*u
, const char *name
);
671 void unit_unwatch_bus_name(Unit
*u
, const char *name
);
673 bool unit_job_is_applicable(Unit
*u
, JobType j
);
675 int set_unit_path(const char *p
);
677 char *unit_dbus_path(Unit
*u
);
678 char *unit_dbus_path_invocation_id(Unit
*u
);
680 int unit_load_related_unit(Unit
*u
, const char *type
, Unit
**_found
);
682 bool unit_can_serialize(Unit
*u
) _pure_
;
684 int unit_serialize(Unit
*u
, FILE *f
, FDSet
*fds
, bool serialize_jobs
);
685 int unit_deserialize(Unit
*u
, FILE *f
, FDSet
*fds
);
686 void unit_deserialize_skip(FILE *f
);
688 int unit_serialize_item(Unit
*u
, FILE *f
, const char *key
, const char *value
);
689 int unit_serialize_item_escaped(Unit
*u
, FILE *f
, const char *key
, const char *value
);
690 int unit_serialize_item_fd(Unit
*u
, FILE *f
, FDSet
*fds
, const char *key
, int fd
);
691 void unit_serialize_item_format(Unit
*u
, FILE *f
, const char *key
, const char *value
, ...) _printf_(4,5);
693 int unit_add_node_dependency(Unit
*u
, const char *what
, bool wants
, UnitDependency d
, UnitDependencyMask mask
);
695 int unit_coldplug(Unit
*u
);
697 void unit_status_printf(Unit
*u
, const char *status
, const char *unit_status_msg_format
) _printf_(3, 0);
698 void unit_status_emit_starting_stopping_reloading(Unit
*u
, JobType t
);
700 bool unit_need_daemon_reload(Unit
*u
);
702 void unit_reset_failed(Unit
*u
);
704 Unit
*unit_following(Unit
*u
);
705 int unit_following_set(Unit
*u
, Set
**s
);
707 const char *unit_slice_name(Unit
*u
);
709 bool unit_stop_pending(Unit
*u
) _pure_
;
710 bool unit_inactive_or_pending(Unit
*u
) _pure_
;
711 bool unit_active_or_pending(Unit
*u
);
712 bool unit_will_restart(Unit
*u
);
714 int unit_add_default_target_dependency(Unit
*u
, Unit
*target
);
716 void unit_start_on_failure(Unit
*u
);
717 void unit_trigger_notify(Unit
*u
);
719 UnitFileState
unit_get_unit_file_state(Unit
*u
);
720 int unit_get_unit_file_preset(Unit
*u
);
722 Unit
* unit_ref_set(UnitRef
*ref
, Unit
*u
);
723 void unit_ref_unset(UnitRef
*ref
);
725 #define UNIT_DEREF(ref) ((ref).unit)
726 #define UNIT_ISSET(ref) (!!(ref).unit)
728 int unit_patch_contexts(Unit
*u
);
730 ExecContext
*unit_get_exec_context(Unit
*u
) _pure_
;
731 KillContext
*unit_get_kill_context(Unit
*u
) _pure_
;
732 CGroupContext
*unit_get_cgroup_context(Unit
*u
) _pure_
;
734 ExecRuntime
*unit_get_exec_runtime(Unit
*u
) _pure_
;
736 int unit_setup_exec_runtime(Unit
*u
);
737 int unit_setup_dynamic_creds(Unit
*u
);
739 char* unit_escape_setting(const char *s
, UnitWriteFlags flags
, char **buf
);
740 char* unit_concat_strv(char **l
, UnitWriteFlags flags
);
742 int unit_write_setting(Unit
*u
, UnitWriteFlags flags
, const char *name
, const char *data
);
743 int unit_write_settingf(Unit
*u
, UnitWriteFlags mode
, const char *name
, const char *format
, ...) _printf_(4,5);
745 int unit_kill_context(Unit
*u
, KillContext
*c
, KillOperation k
, pid_t main_pid
, pid_t control_pid
, bool main_pid_alien
);
747 int unit_make_transient(Unit
*u
);
749 int unit_require_mounts_for(Unit
*u
, const char *path
, UnitDependencyMask mask
);
751 bool unit_type_supported(UnitType t
);
753 bool unit_is_pristine(Unit
*u
);
755 pid_t
unit_control_pid(Unit
*u
);
756 pid_t
unit_main_pid(Unit
*u
);
758 static inline bool unit_supported(Unit
*u
) {
759 return unit_type_supported(u
->type
);
762 void unit_warn_if_dir_nonempty(Unit
*u
, const char* where
);
763 int unit_fail_if_symlink(Unit
*u
, const char* where
);
765 int unit_start_limit_test(Unit
*u
);
767 void unit_unref_uid(Unit
*u
, bool destroy_now
);
768 int unit_ref_uid(Unit
*u
, uid_t uid
, bool clean_ipc
);
770 void unit_unref_gid(Unit
*u
, bool destroy_now
);
771 int unit_ref_gid(Unit
*u
, gid_t gid
, bool clean_ipc
);
773 int unit_ref_uid_gid(Unit
*u
, uid_t uid
, gid_t gid
);
774 void unit_unref_uid_gid(Unit
*u
, bool destroy_now
);
776 void unit_notify_user_lookup(Unit
*u
, uid_t uid
, gid_t gid
);
778 int unit_set_invocation_id(Unit
*u
, sd_id128_t id
);
779 int unit_acquire_invocation_id(Unit
*u
);
781 bool unit_shall_confirm_spawn(Unit
*u
);
783 void unit_set_exec_params(Unit
*s
, ExecParameters
*p
);
785 int unit_fork_helper_process(Unit
*u
, const char *name
, pid_t
*ret
);
787 void unit_remove_dependencies(Unit
*u
, UnitDependencyMask mask
);
789 void unit_export_state_files(Unit
*u
);
790 void unit_unlink_state_files(Unit
*u
);
792 int unit_prepare_exec(Unit
*u
);
794 void unit_warn_leftover_processes(Unit
*u
);
796 /* Macros which append UNIT= or USER_UNIT= to the message */
798 #define log_unit_full(unit, level, error, ...) \
800 const Unit *_u = (unit); \
801 _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__) : \
802 log_internal(level, error, __FILE__, __LINE__, __func__, ##__VA_ARGS__); \
805 #define log_unit_debug(unit, ...) log_unit_full(unit, LOG_DEBUG, 0, ##__VA_ARGS__)
806 #define log_unit_info(unit, ...) log_unit_full(unit, LOG_INFO, 0, ##__VA_ARGS__)
807 #define log_unit_notice(unit, ...) log_unit_full(unit, LOG_NOTICE, 0, ##__VA_ARGS__)
808 #define log_unit_warning(unit, ...) log_unit_full(unit, LOG_WARNING, 0, ##__VA_ARGS__)
809 #define log_unit_error(unit, ...) log_unit_full(unit, LOG_ERR, 0, ##__VA_ARGS__)
811 #define log_unit_debug_errno(unit, error, ...) log_unit_full(unit, LOG_DEBUG, error, ##__VA_ARGS__)
812 #define log_unit_info_errno(unit, error, ...) log_unit_full(unit, LOG_INFO, error, ##__VA_ARGS__)
813 #define log_unit_notice_errno(unit, error, ...) log_unit_full(unit, LOG_NOTICE, error, ##__VA_ARGS__)
814 #define log_unit_warning_errno(unit, error, ...) log_unit_full(unit, LOG_WARNING, error, ##__VA_ARGS__)
815 #define log_unit_error_errno(unit, error, ...) log_unit_full(unit, LOG_ERR, error, ##__VA_ARGS__)
817 #define LOG_UNIT_MESSAGE(unit, fmt, ...) "MESSAGE=%s: " fmt, (unit)->id, ##__VA_ARGS__
818 #define LOG_UNIT_ID(unit) (unit)->manager->unit_log_format_string, (unit)->id
819 #define LOG_UNIT_INVOCATION_ID(unit) (unit)->manager->invocation_log_format_string, (unit)->invocation_id_string
821 const char* collect_mode_to_string(CollectMode m
) _const_
;
822 CollectMode
collect_mode_from_string(const char *s
) _pure_
;