4 This file is part of systemd.
6 Copyright 2010 Lennart Poettering
8 systemd is free software; you can redistribute it and/or modify it
9 under the terms of the GNU Lesser General Public License as published by
10 the Free Software Foundation; either version 2.1 of the License, or
11 (at your option) any later version.
13 systemd is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 Lesser General Public License for more details.
18 You should have received a copy of the GNU Lesser General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
26 typedef struct Unit Unit
;
27 typedef struct UnitVTable UnitVTable
;
28 typedef struct UnitRef UnitRef
;
29 typedef struct UnitStatusMessageFormats UnitStatusMessageFormats
;
31 #include "condition.h"
32 #include "failure-action.h"
35 #include "unit-name.h"
37 typedef enum KillOperation
{
42 _KILL_OPERATION_INVALID
= -1
45 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t
) {
46 return t
== UNIT_ACTIVE
|| t
== UNIT_RELOADING
;
49 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t
) {
50 return t
== UNIT_ACTIVE
|| t
== UNIT_ACTIVATING
|| t
== UNIT_RELOADING
;
53 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t
) {
54 return t
== UNIT_INACTIVE
|| t
== UNIT_FAILED
|| t
== UNIT_DEACTIVATING
;
57 static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t
) {
58 return t
== UNIT_INACTIVE
|| t
== UNIT_FAILED
;
64 /* Keeps tracks of references to a unit. This is useful so
65 * that we can merge two units if necessary and correct all
66 * references to them */
69 LIST_FIELDS(UnitRef
, refs
);
76 UnitLoadState load_state
;
79 char *id
; /* One name is special because we use it for identification. Points to an entry in the names set */
83 Set
*dependencies
[_UNIT_DEPENDENCY_MAX
];
85 char **requires_mounts_for
;
90 char *fragment_path
; /* if loaded from a config file this is the primary path to it */
91 char *source_path
; /* if converted, the source file */
94 usec_t fragment_mtime
;
98 /* If this is a transient unit we are currently writing, this is where we are writing it to */
101 /* If there is something to do with this unit, then this is the installed job for it */
104 /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
107 /* The slot used for watching NameOwnerChanged signals */
108 sd_bus_slot
*match_bus_slot
;
110 /* Job timeout and action to take */
112 FailureAction job_timeout_action
;
113 char *job_timeout_reboot_arg
;
115 /* References to this */
116 LIST_HEAD(UnitRef
, refs
);
118 /* Conditions to check */
119 LIST_HEAD(Condition
, conditions
);
120 LIST_HEAD(Condition
, asserts
);
122 dual_timestamp condition_timestamp
;
123 dual_timestamp assert_timestamp
;
125 /* Updated whenever the low-level state changes */
126 dual_timestamp state_change_timestamp
;
128 /* Updated whenever the (high-level) active state enters or leaves the active or inactive states */
129 dual_timestamp inactive_exit_timestamp
;
130 dual_timestamp active_enter_timestamp
;
131 dual_timestamp active_exit_timestamp
;
132 dual_timestamp inactive_enter_timestamp
;
137 LIST_FIELDS(Unit
, units_by_type
);
139 /* All units which have requires_mounts_for set */
140 LIST_FIELDS(Unit
, has_requires_mounts_for
);
143 LIST_FIELDS(Unit
, load_queue
);
146 LIST_FIELDS(Unit
, dbus_queue
);
149 LIST_FIELDS(Unit
, cleanup_queue
);
152 LIST_FIELDS(Unit
, gc_queue
);
154 /* CGroup realize members queue */
155 LIST_FIELDS(Unit
, cgroup_queue
);
157 /* Units with the same CGroup netclass */
158 LIST_FIELDS(Unit
, cgroup_netclass
);
160 /* PIDs we keep an eye on. Note that a unit might have many
161 * more, but these are the ones we care enough about to
162 * process SIGCHLD for */
165 /* Used during GC sweeps */
168 /* Error code when we didn't manage to load the unit (negative) */
171 /* Put a ratelimit on unit starting */
172 RateLimit start_limit
;
173 FailureAction start_limit_action
;
176 /* Make sure we never enter endless loops with the check unneeded logic, or the BindsTo= logic */
177 RateLimit auto_stop_ratelimit
;
179 /* Cached unit file state and preset */
180 UnitFileState unit_file_state
;
181 int unit_file_preset
;
183 /* Where the cpuacct.usage cgroup counter was at the time the unit was started */
184 nsec_t cpuacct_usage_base
;
186 /* Counterparts in the cgroup filesystem */
188 CGroupMask cgroup_realized_mask
;
189 CGroupMask cgroup_subtree_mask
;
190 CGroupMask cgroup_members_mask
;
191 int cgroup_inotify_wd
;
193 uint32_t cgroup_netclass_id
;
195 /* How to start OnFailure units */
196 JobMode on_failure_job_mode
;
198 /* Garbage collect us we nobody wants or requires us anymore */
199 bool stop_when_unneeded
;
201 /* Create default dependencies */
202 bool default_dependencies
;
204 /* Refuse manual starting, allow starting only indirectly via dependency. */
205 bool refuse_manual_start
;
207 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
208 bool refuse_manual_stop
;
210 /* Allow isolation requests */
213 /* Ignore this unit when isolating */
214 bool ignore_on_isolate
;
216 /* Did the last condition check succeed? */
217 bool condition_result
;
220 /* Is this a transient unit? */
223 bool in_load_queue
:1;
224 bool in_dbus_queue
:1;
225 bool in_cleanup_queue
:1;
227 bool in_cgroup_queue
:1;
229 bool sent_dbus_new_signal
:1;
235 bool cgroup_realized
:1;
236 bool cgroup_members_mask_valid
:1;
237 bool cgroup_subtree_mask_valid
:1;
239 bool start_limit_hit
:1;
241 /* Did we already invoke unit_coldplug() for this unit? */
245 struct UnitStatusMessageFormats
{
246 const char *starting_stopping
[2];
247 const char *finished_start_job
[_JOB_RESULT_MAX
];
248 const char *finished_stop_job
[_JOB_RESULT_MAX
];
251 typedef enum UnitSetPropertiesMode
{
255 } UnitSetPropertiesMode
;
257 #include "automount.h"
269 /* How much memory does an object of this unit type need */
272 /* If greater than 0, the offset into the object where
273 * ExecContext is found, if the unit type has that */
274 size_t exec_context_offset
;
276 /* If greater than 0, the offset into the object where
277 * CGroupContext is found, if the unit type has that */
278 size_t cgroup_context_offset
;
280 /* If greater than 0, the offset into the object where
281 * KillContext is found, if the unit type has that */
282 size_t kill_context_offset
;
284 /* If greater than 0, the offset into the object where the
285 * pointer to ExecRuntime is found, if the unit type has
287 size_t exec_runtime_offset
;
289 /* The name of the configuration file section with the private settings of this unit */
290 const char *private_section
;
292 /* Config file sections this unit type understands, separated
294 const char *sections
;
296 /* This should reset all type-specific variables. This should
297 * not allocate memory, and is called with zero-initialized
298 * data. It should hence only initialize variables that need
300 void (*init
)(Unit
*u
);
302 /* This should free all type-specific variables. It should be
304 void (*done
)(Unit
*u
);
306 /* Actually load data from disk. This may fail, and should set
307 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
308 * UNIT_STUB if no configuration could be found. */
309 int (*load
)(Unit
*u
);
311 /* If a lot of units got created via enumerate(), this is
312 * where to actually set the state and call unit_notify(). */
313 int (*coldplug
)(Unit
*u
);
315 void (*dump
)(Unit
*u
, FILE *f
, const char *prefix
);
317 int (*start
)(Unit
*u
);
318 int (*stop
)(Unit
*u
);
319 int (*reload
)(Unit
*u
);
321 int (*kill
)(Unit
*u
, KillWho w
, int signo
, sd_bus_error
*error
);
323 bool (*can_reload
)(Unit
*u
);
325 /* Write all data that cannot be restored from other sources
326 * away using unit_serialize_item() */
327 int (*serialize
)(Unit
*u
, FILE *f
, FDSet
*fds
);
329 /* Restore one item from the serialization */
330 int (*deserialize_item
)(Unit
*u
, const char *key
, const char *data
, FDSet
*fds
);
332 /* Try to match up fds with what we need for this unit */
333 void (*distribute_fds
)(Unit
*u
, FDSet
*fds
);
335 /* Boils down the more complex internal state of this unit to
336 * a simpler one that the engine can understand */
337 UnitActiveState (*active_state
)(Unit
*u
);
339 /* Returns the substate specific to this unit type as
340 * string. This is purely information so that we can give the
341 * user a more fine grained explanation in which actual state a
343 const char* (*sub_state_to_string
)(Unit
*u
);
345 /* Return true when there is reason to keep this entry around
346 * even nothing references it and it isn't active in any
348 bool (*check_gc
)(Unit
*u
);
350 /* When the unit is not running and no job for it queued we
351 * shall release its runtime resources */
352 void (*release_resources
)(Unit
*u
);
354 /* Invoked on every child that died */
355 void (*sigchld_event
)(Unit
*u
, pid_t pid
, int code
, int status
);
357 /* Reset failed state if we are in failed state */
358 void (*reset_failed
)(Unit
*u
);
360 /* Called whenever any of the cgroups this unit watches for
362 void (*notify_cgroup_empty
)(Unit
*u
);
364 /* Called whenever a process of this unit sends us a message */
365 void (*notify_message
)(Unit
*u
, pid_t pid
, char **tags
, FDSet
*fds
);
367 /* Called whenever a name this Unit registered for comes or
369 void (*bus_name_owner_change
)(Unit
*u
, const char *name
, const char *old_owner
, const char *new_owner
);
371 /* Called for each property that is being set */
372 int (*bus_set_property
)(Unit
*u
, const char *name
, sd_bus_message
*message
, UnitSetPropertiesMode mode
, sd_bus_error
*error
);
374 /* Called after at least one property got changed to apply the necessary change */
375 int (*bus_commit_properties
)(Unit
*u
);
377 /* Return the unit this unit is following */
378 Unit
*(*following
)(Unit
*u
);
380 /* Return the set of units that are following each other */
381 int (*following_set
)(Unit
*u
, Set
**s
);
383 /* Invoked each time a unit this unit is triggering changes
384 * state or gains/loses a job */
385 void (*trigger_notify
)(Unit
*u
, Unit
*trigger
);
387 /* Called whenever CLOCK_REALTIME made a jump */
388 void (*time_change
)(Unit
*u
);
390 /* Returns the next timeout of a unit */
391 int (*get_timeout
)(Unit
*u
, usec_t
*timeout
);
393 /* Returns the main PID if there is any defined, or 0. */
394 pid_t (*main_pid
)(Unit
*u
);
396 /* Returns the main PID if there is any defined, or 0. */
397 pid_t (*control_pid
)(Unit
*u
);
399 /* This is called for each unit type and should be used to
400 * enumerate existing devices and load them. However,
401 * everything that is loaded here should still stay in
402 * inactive state. It is the job of the coldplug() call above
403 * to put the units into the initial state. */
404 void (*enumerate
)(Manager
*m
);
406 /* Type specific cleanups. */
407 void (*shutdown
)(Manager
*m
);
409 /* If this function is set and return false all jobs for units
410 * of this type will immediately fail. */
411 bool (*supported
)(void);
414 const sd_bus_vtable
*bus_vtable
;
416 /* The strings to print in status messages */
417 UnitStatusMessageFormats status_message_formats
;
419 /* Can units of this type have multiple names? */
422 /* Instances make no sense for this type */
425 /* True if transient units of this type are OK */
426 bool can_transient
:1;
429 extern const UnitVTable
* const unit_vtable
[_UNIT_TYPE_MAX
];
431 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
433 /* For casting a unit into the various unit types */
434 #define DEFINE_CAST(UPPERCASE, MixedCase) \
435 static inline MixedCase* UPPERCASE(Unit *u) { \
436 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
439 return (MixedCase*) u; \
442 /* For casting the various unit types into a unit */
443 #define UNIT(u) (&(u)->meta)
445 #define UNIT_HAS_EXEC_CONTEXT(u) (UNIT_VTABLE(u)->exec_context_offset > 0)
446 #define UNIT_HAS_CGROUP_CONTEXT(u) (UNIT_VTABLE(u)->cgroup_context_offset > 0)
447 #define UNIT_HAS_KILL_CONTEXT(u) (UNIT_VTABLE(u)->kill_context_offset > 0)
449 #define UNIT_TRIGGER(u) ((Unit*) set_first((u)->dependencies[UNIT_TRIGGERS]))
451 DEFINE_CAST(SERVICE
, Service
);
452 DEFINE_CAST(SOCKET
, Socket
);
453 DEFINE_CAST(BUSNAME
, BusName
);
454 DEFINE_CAST(TARGET
, Target
);
455 DEFINE_CAST(DEVICE
, Device
);
456 DEFINE_CAST(MOUNT
, Mount
);
457 DEFINE_CAST(AUTOMOUNT
, Automount
);
458 DEFINE_CAST(SWAP
, Swap
);
459 DEFINE_CAST(TIMER
, Timer
);
460 DEFINE_CAST(PATH
, Path
);
461 DEFINE_CAST(SLICE
, Slice
);
462 DEFINE_CAST(SCOPE
, Scope
);
464 Unit
*unit_new(Manager
*m
, size_t size
);
465 void unit_free(Unit
*u
);
467 int unit_add_name(Unit
*u
, const char *name
);
469 int unit_add_dependency(Unit
*u
, UnitDependency d
, Unit
*other
, bool add_reference
);
470 int unit_add_two_dependencies(Unit
*u
, UnitDependency d
, UnitDependency e
, Unit
*other
, bool add_reference
);
472 int unit_add_dependency_by_name(Unit
*u
, UnitDependency d
, const char *name
, const char *filename
, bool add_reference
);
473 int unit_add_two_dependencies_by_name(Unit
*u
, UnitDependency d
, UnitDependency e
, const char *name
, const char *path
, bool add_reference
);
475 int unit_add_exec_dependencies(Unit
*u
, ExecContext
*c
);
477 int unit_choose_id(Unit
*u
, const char *name
);
478 int unit_set_description(Unit
*u
, const char *description
);
480 bool unit_check_gc(Unit
*u
);
482 void unit_add_to_load_queue(Unit
*u
);
483 void unit_add_to_dbus_queue(Unit
*u
);
484 void unit_add_to_cleanup_queue(Unit
*u
);
485 void unit_add_to_gc_queue(Unit
*u
);
487 int unit_merge(Unit
*u
, Unit
*other
);
488 int unit_merge_by_name(Unit
*u
, const char *other
);
490 Unit
*unit_follow_merge(Unit
*u
) _pure_
;
492 int unit_load_fragment_and_dropin(Unit
*u
);
493 int unit_load_fragment_and_dropin_optional(Unit
*u
);
494 int unit_load(Unit
*unit
);
496 int unit_set_slice(Unit
*u
, Unit
*slice
);
497 int unit_set_default_slice(Unit
*u
);
499 const char *unit_description(Unit
*u
) _pure_
;
501 bool unit_has_name(Unit
*u
, const char *name
);
503 UnitActiveState
unit_active_state(Unit
*u
);
505 const char* unit_sub_state_to_string(Unit
*u
);
507 void unit_dump(Unit
*u
, FILE *f
, const char *prefix
);
509 bool unit_can_reload(Unit
*u
) _pure_
;
510 bool unit_can_start(Unit
*u
) _pure_
;
511 bool unit_can_isolate(Unit
*u
) _pure_
;
513 int unit_start(Unit
*u
);
514 int unit_stop(Unit
*u
);
515 int unit_reload(Unit
*u
);
517 int unit_kill(Unit
*u
, KillWho w
, int signo
, sd_bus_error
*error
);
518 int unit_kill_common(Unit
*u
, KillWho who
, int signo
, pid_t main_pid
, pid_t control_pid
, sd_bus_error
*error
);
520 void unit_notify(Unit
*u
, UnitActiveState os
, UnitActiveState ns
, bool reload_success
);
522 int unit_watch_pid(Unit
*u
, pid_t pid
);
523 void unit_unwatch_pid(Unit
*u
, pid_t pid
);
524 void unit_unwatch_all_pids(Unit
*u
);
526 void unit_tidy_watch_pids(Unit
*u
, pid_t except1
, pid_t except2
);
528 int unit_install_bus_match(Unit
*u
, sd_bus
*bus
, const char *name
);
529 int unit_watch_bus_name(Unit
*u
, const char *name
);
530 void unit_unwatch_bus_name(Unit
*u
, const char *name
);
532 bool unit_job_is_applicable(Unit
*u
, JobType j
);
534 int set_unit_path(const char *p
);
536 char *unit_dbus_path(Unit
*u
);
538 int unit_load_related_unit(Unit
*u
, const char *type
, Unit
**_found
);
540 bool unit_can_serialize(Unit
*u
) _pure_
;
542 int unit_serialize(Unit
*u
, FILE *f
, FDSet
*fds
, bool serialize_jobs
);
543 int unit_deserialize(Unit
*u
, FILE *f
, FDSet
*fds
);
545 int unit_serialize_item(Unit
*u
, FILE *f
, const char *key
, const char *value
);
546 int unit_serialize_item_escaped(Unit
*u
, FILE *f
, const char *key
, const char *value
);
547 int unit_serialize_item_fd(Unit
*u
, FILE *f
, FDSet
*fds
, const char *key
, int fd
);
548 void unit_serialize_item_format(Unit
*u
, FILE *f
, const char *key
, const char *value
, ...) _printf_(4,5);
550 int unit_add_node_link(Unit
*u
, const char *what
, bool wants
, UnitDependency d
);
552 int unit_coldplug(Unit
*u
);
554 void unit_status_printf(Unit
*u
, const char *status
, const char *unit_status_msg_format
) _printf_(3, 0);
555 void unit_status_emit_starting_stopping_reloading(Unit
*u
, JobType t
);
557 bool unit_need_daemon_reload(Unit
*u
);
559 void unit_reset_failed(Unit
*u
);
561 Unit
*unit_following(Unit
*u
);
562 int unit_following_set(Unit
*u
, Set
**s
);
564 const char *unit_slice_name(Unit
*u
);
566 bool unit_stop_pending(Unit
*u
) _pure_
;
567 bool unit_inactive_or_pending(Unit
*u
) _pure_
;
568 bool unit_active_or_pending(Unit
*u
);
570 int unit_add_default_target_dependency(Unit
*u
, Unit
*target
);
572 void unit_start_on_failure(Unit
*u
);
573 void unit_trigger_notify(Unit
*u
);
575 UnitFileState
unit_get_unit_file_state(Unit
*u
);
576 int unit_get_unit_file_preset(Unit
*u
);
578 Unit
* unit_ref_set(UnitRef
*ref
, Unit
*u
);
579 void unit_ref_unset(UnitRef
*ref
);
581 #define UNIT_DEREF(ref) ((ref).unit)
582 #define UNIT_ISSET(ref) (!!(ref).unit)
584 int unit_patch_contexts(Unit
*u
);
586 ExecContext
*unit_get_exec_context(Unit
*u
) _pure_
;
587 KillContext
*unit_get_kill_context(Unit
*u
) _pure_
;
588 CGroupContext
*unit_get_cgroup_context(Unit
*u
) _pure_
;
590 ExecRuntime
*unit_get_exec_runtime(Unit
*u
) _pure_
;
592 int unit_setup_exec_runtime(Unit
*u
);
594 int unit_write_drop_in(Unit
*u
, UnitSetPropertiesMode mode
, const char *name
, const char *data
);
595 int unit_write_drop_in_format(Unit
*u
, UnitSetPropertiesMode mode
, const char *name
, const char *format
, ...) _printf_(4,5);
597 int unit_write_drop_in_private(Unit
*u
, UnitSetPropertiesMode mode
, const char *name
, const char *data
);
598 int unit_write_drop_in_private_format(Unit
*u
, UnitSetPropertiesMode mode
, const char *name
, const char *format
, ...) _printf_(4,5);
600 int unit_kill_context(Unit
*u
, KillContext
*c
, KillOperation k
, pid_t main_pid
, pid_t control_pid
, bool main_pid_alien
);
602 int unit_make_transient(Unit
*u
);
604 int unit_require_mounts_for(Unit
*u
, const char *path
);
606 bool unit_type_supported(UnitType t
);
608 bool unit_is_pristine(Unit
*u
);
610 pid_t
unit_control_pid(Unit
*u
);
611 pid_t
unit_main_pid(Unit
*u
);
613 static inline bool unit_supported(Unit
*u
) {
614 return unit_type_supported(u
->type
);
617 void unit_warn_if_dir_nonempty(Unit
*u
, const char* where
);
618 int unit_fail_if_symlink(Unit
*u
, const char* where
);
620 /* Macros which append UNIT= or USER_UNIT= to the message */
622 #define log_unit_full(unit, level, error, ...) \
625 _u ? log_object_internal(level, error, __FILE__, __LINE__, __func__, _u->manager->unit_log_field, _u->id, ##__VA_ARGS__) : \
626 log_internal(level, error, __FILE__, __LINE__, __func__, ##__VA_ARGS__); \
629 #define log_unit_debug(unit, ...) log_unit_full(unit, LOG_DEBUG, 0, ##__VA_ARGS__)
630 #define log_unit_info(unit, ...) log_unit_full(unit, LOG_INFO, 0, ##__VA_ARGS__)
631 #define log_unit_notice(unit, ...) log_unit_full(unit, LOG_NOTICE, 0, ##__VA_ARGS__)
632 #define log_unit_warning(unit, ...) log_unit_full(unit, LOG_WARNING, 0, ##__VA_ARGS__)
633 #define log_unit_error(unit, ...) log_unit_full(unit, LOG_ERR, 0, ##__VA_ARGS__)
635 #define log_unit_debug_errno(unit, error, ...) log_unit_full(unit, LOG_DEBUG, error, ##__VA_ARGS__)
636 #define log_unit_info_errno(unit, error, ...) log_unit_full(unit, LOG_INFO, error, ##__VA_ARGS__)
637 #define log_unit_notice_errno(unit, error, ...) log_unit_full(unit, LOG_NOTICE, error, ##__VA_ARGS__)
638 #define log_unit_warning_errno(unit, error, ...) log_unit_full(unit, LOG_WARNING, error, ##__VA_ARGS__)
639 #define log_unit_error_errno(unit, error, ...) log_unit_full(unit, LOG_ERR, error, ##__VA_ARGS__)
641 #define LOG_UNIT_MESSAGE(unit, fmt, ...) "MESSAGE=%s: " fmt, (unit)->id, ##__VA_ARGS__
642 #define LOG_UNIT_ID(unit) (unit)->manager->unit_log_format_string, (unit)->id