1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
6 This file is part of systemd.
8 Copyright 2010 Lennart Poettering
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
28 typedef struct Unit Unit
;
29 typedef struct UnitVTable UnitVTable
;
30 typedef enum UnitActiveState UnitActiveState
;
31 typedef struct UnitRef UnitRef
;
32 typedef struct UnitStatusMessageFormats UnitStatusMessageFormats
;
35 #include "condition.h"
37 #include "unit-name.h"
38 #include "failure-action.h"
40 enum UnitActiveState
{
47 _UNIT_ACTIVE_STATE_MAX
,
48 _UNIT_ACTIVE_STATE_INVALID
= -1
51 typedef enum KillOperation
{
56 _KILL_OPERATION_INVALID
= -1
59 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t
) {
60 return t
== UNIT_ACTIVE
|| t
== UNIT_RELOADING
;
63 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t
) {
64 return t
== UNIT_ACTIVE
|| t
== UNIT_ACTIVATING
|| t
== UNIT_RELOADING
;
67 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t
) {
68 return t
== UNIT_INACTIVE
|| t
== UNIT_FAILED
|| t
== UNIT_DEACTIVATING
;
71 static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t
) {
72 return t
== UNIT_INACTIVE
|| t
== UNIT_FAILED
;
78 /* Keeps tracks of references to a unit. This is useful so
79 * that we can merge two units if necessary and correct all
80 * references to them */
83 LIST_FIELDS(UnitRef
, refs
);
90 UnitLoadState load_state
;
93 char *id
; /* One name is special because we use it for identification. Points to an entry in the names set */
97 Set
*dependencies
[_UNIT_DEPENDENCY_MAX
];
99 char **requires_mounts_for
;
102 char **documentation
;
104 char *fragment_path
; /* if loaded from a config file this is the primary path to it */
105 char *source_path
; /* if converted, the source file */
108 usec_t fragment_mtime
;
112 /* If there is something to do with this unit, then this is the installed job for it */
115 /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
118 /* Job timeout and action to take */
120 FailureAction job_timeout_action
;
121 char *job_timeout_reboot_arg
;
123 /* References to this */
124 LIST_HEAD(UnitRef
, refs
);
126 /* Conditions to check */
127 LIST_HEAD(Condition
, conditions
);
128 LIST_HEAD(Condition
, asserts
);
130 dual_timestamp condition_timestamp
;
131 dual_timestamp assert_timestamp
;
133 dual_timestamp inactive_exit_timestamp
;
134 dual_timestamp active_enter_timestamp
;
135 dual_timestamp active_exit_timestamp
;
136 dual_timestamp inactive_enter_timestamp
;
141 LIST_FIELDS(Unit
, units_by_type
);
143 /* All units which have requires_mounts_for set */
144 LIST_FIELDS(Unit
, has_requires_mounts_for
);
147 LIST_FIELDS(Unit
, load_queue
);
150 LIST_FIELDS(Unit
, dbus_queue
);
153 LIST_FIELDS(Unit
, cleanup_queue
);
156 LIST_FIELDS(Unit
, gc_queue
);
158 /* CGroup realize members queue */
159 LIST_FIELDS(Unit
, cgroup_queue
);
161 /* PIDs we keep an eye on. Note that a unit might have many
162 * more, but these are the ones we care enough about to
163 * process SIGCHLD for */
166 /* Used during GC sweeps */
169 /* Error code when we didn't manage to load the unit (negative) */
172 /* Make sure we never enter endless loops with the check unneeded logic, or the BindsTo= logic */
173 RateLimit auto_stop_ratelimit
;
175 /* Cached unit file state and preset */
176 UnitFileState unit_file_state
;
177 int unit_file_preset
;
179 /* Where the cpuacct.usage cgroup counter was at the time the unit was started */
180 nsec_t cpuacct_usage_base
;
182 /* Counterparts in the cgroup filesystem */
184 CGroupControllerMask cgroup_realized_mask
;
185 CGroupControllerMask cgroup_subtree_mask
;
186 CGroupControllerMask cgroup_members_mask
;
188 /* How to start OnFailure units */
189 JobMode on_failure_job_mode
;
191 /* Garbage collect us we nobody wants or requires us anymore */
192 bool stop_when_unneeded
;
194 /* Create default dependencies */
195 bool default_dependencies
;
197 /* Refuse manual starting, allow starting only indirectly via dependency. */
198 bool refuse_manual_start
;
200 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
201 bool refuse_manual_stop
;
203 /* Allow isolation requests */
206 /* Ignore this unit when isolating */
207 bool ignore_on_isolate
;
209 /* Ignore this unit when snapshotting */
210 bool ignore_on_snapshot
;
212 /* Did the last condition check succeed? */
213 bool condition_result
;
216 /* Is this a transient unit? */
219 bool in_load_queue
:1;
220 bool in_dbus_queue
:1;
221 bool in_cleanup_queue
:1;
223 bool in_cgroup_queue
:1;
225 bool sent_dbus_new_signal
:1;
231 bool cgroup_realized
:1;
232 bool cgroup_members_mask_valid
:1;
233 bool cgroup_subtree_mask_valid
:1;
235 /* Did we already invoke unit_coldplug() for this unit? */
239 struct UnitStatusMessageFormats
{
240 const char *starting_stopping
[2];
241 const char *finished_start_job
[_JOB_RESULT_MAX
];
242 const char *finished_stop_job
[_JOB_RESULT_MAX
];
245 typedef enum UnitSetPropertiesMode
{
249 } UnitSetPropertiesMode
;
254 #include "snapshot.h"
256 #include "automount.h"
264 /* How much memory does an object of this unit type need */
267 /* If greater than 0, the offset into the object where
268 * ExecContext is found, if the unit type has that */
269 size_t exec_context_offset
;
271 /* If greater than 0, the offset into the object where
272 * CGroupContext is found, if the unit type has that */
273 size_t cgroup_context_offset
;
275 /* If greater than 0, the offset into the object where
276 * KillContext is found, if the unit type has that */
277 size_t kill_context_offset
;
279 /* If greater than 0, the offset into the object where the
280 * pointer to ExecRuntime is found, if the unit type has
282 size_t exec_runtime_offset
;
284 /* The name of the configuration file section with the private settings of this unit */
285 const char *private_section
;
287 /* Config file sections this unit type understands, separated
289 const char *sections
;
291 /* This should reset all type-specific variables. This should
292 * not allocate memory, and is called with zero-initialized
293 * data. It should hence only initialize variables that need
295 void (*init
)(Unit
*u
);
297 /* This should free all type-specific variables. It should be
299 void (*done
)(Unit
*u
);
301 /* Actually load data from disk. This may fail, and should set
302 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
303 * UNIT_STUB if no configuration could be found. */
304 int (*load
)(Unit
*u
);
306 /* If a lot of units got created via enumerate(), this is
307 * where to actually set the state and call unit_notify(). */
308 int (*coldplug
)(Unit
*u
);
310 void (*dump
)(Unit
*u
, FILE *f
, const char *prefix
);
312 int (*start
)(Unit
*u
);
313 int (*stop
)(Unit
*u
);
314 int (*reload
)(Unit
*u
);
316 int (*kill
)(Unit
*u
, KillWho w
, int signo
, sd_bus_error
*error
);
318 bool (*can_reload
)(Unit
*u
);
320 /* Write all data that cannot be restored from other sources
321 * away using unit_serialize_item() */
322 int (*serialize
)(Unit
*u
, FILE *f
, FDSet
*fds
);
324 /* Restore one item from the serialization */
325 int (*deserialize_item
)(Unit
*u
, const char *key
, const char *data
, FDSet
*fds
);
327 /* Try to match up fds with what we need for this unit */
328 int (*distribute_fds
)(Unit
*u
, FDSet
*fds
);
330 /* Boils down the more complex internal state of this unit to
331 * a simpler one that the engine can understand */
332 UnitActiveState (*active_state
)(Unit
*u
);
334 /* Returns the substate specific to this unit type as
335 * string. This is purely information so that we can give the
336 * user a more fine grained explanation in which actual state a
338 const char* (*sub_state_to_string
)(Unit
*u
);
340 /* Return true when there is reason to keep this entry around
341 * even nothing references it and it isn't active in any
343 bool (*check_gc
)(Unit
*u
);
345 /* When the unit is not running and no job for it queued we
346 * shall release its runtime resources */
347 void (*release_resources
)(Unit
*u
);
349 /* Return true when this unit is suitable for snapshotting */
350 bool (*check_snapshot
)(Unit
*u
);
352 /* Invoked on every child that died */
353 void (*sigchld_event
)(Unit
*u
, pid_t pid
, int code
, int status
);
355 /* Reset failed state if we are in failed state */
356 void (*reset_failed
)(Unit
*u
);
358 /* Called whenever any of the cgroups this unit watches for
360 void (*notify_cgroup_empty
)(Unit
*u
);
362 /* Called whenever a process of this unit sends us a message */
363 void (*notify_message
)(Unit
*u
, pid_t pid
, char **tags
, FDSet
*fds
);
365 /* Called whenever a name this Unit registered for comes or
367 void (*bus_name_owner_change
)(Unit
*u
, const char *name
, const char *old_owner
, const char *new_owner
);
369 /* Called for each property that is being set */
370 int (*bus_set_property
)(Unit
*u
, const char *name
, sd_bus_message
*message
, UnitSetPropertiesMode mode
, sd_bus_error
*error
);
372 /* Called after at least one property got changed to apply the necessary change */
373 int (*bus_commit_properties
)(Unit
*u
);
375 /* Return the unit this unit is following */
376 Unit
*(*following
)(Unit
*u
);
378 /* Return the set of units that are following each other */
379 int (*following_set
)(Unit
*u
, Set
**s
);
381 /* Invoked each time a unit this unit is triggering changes
382 * state or gains/loses a job */
383 void (*trigger_notify
)(Unit
*u
, Unit
*trigger
);
385 /* Called whenever CLOCK_REALTIME made a jump */
386 void (*time_change
)(Unit
*u
);
388 int (*get_timeout
)(Unit
*u
, uint64_t *timeout
);
390 /* This is called for each unit type and should be used to
391 * enumerate existing devices and load them. However,
392 * everything that is loaded here should still stay in
393 * inactive state. It is the job of the coldplug() call above
394 * to put the units into the initial state. */
395 int (*enumerate
)(Manager
*m
);
397 /* Type specific cleanups. */
398 void (*shutdown
)(Manager
*m
);
400 /* If this function is set and return false all jobs for units
401 * of this type will immediately fail. */
402 bool (*supported
)(void);
404 /* The interface name */
405 const char *bus_interface
;
408 const sd_bus_vtable
*bus_vtable
;
410 /* The strings to print in status messages */
411 UnitStatusMessageFormats status_message_formats
;
413 /* Can units of this type have multiple names? */
416 /* Instances make no sense for this type */
419 /* Exclude from automatic gc */
422 /* True if transient units of this type are OK */
423 bool can_transient
:1;
426 extern const UnitVTable
* const unit_vtable
[_UNIT_TYPE_MAX
];
428 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
430 /* For casting a unit into the various unit types */
431 #define DEFINE_CAST(UPPERCASE, MixedCase) \
432 static inline MixedCase* UPPERCASE(Unit *u) { \
433 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
436 return (MixedCase*) u; \
439 /* For casting the various unit types into a unit */
440 #define UNIT(u) (&(u)->meta)
442 #define UNIT_TRIGGER(u) ((Unit*) set_first((u)->dependencies[UNIT_TRIGGERS]))
444 DEFINE_CAST(SERVICE
, Service
);
445 DEFINE_CAST(SOCKET
, Socket
);
446 DEFINE_CAST(BUSNAME
, BusName
);
447 DEFINE_CAST(TARGET
, Target
);
448 DEFINE_CAST(SNAPSHOT
, Snapshot
);
449 DEFINE_CAST(DEVICE
, Device
);
450 DEFINE_CAST(MOUNT
, Mount
);
451 DEFINE_CAST(AUTOMOUNT
, Automount
);
452 DEFINE_CAST(SWAP
, Swap
);
453 DEFINE_CAST(TIMER
, Timer
);
454 DEFINE_CAST(PATH
, Path
);
455 DEFINE_CAST(SLICE
, Slice
);
456 DEFINE_CAST(SCOPE
, Scope
);
458 Unit
*unit_new(Manager
*m
, size_t size
);
459 void unit_free(Unit
*u
);
461 int unit_add_name(Unit
*u
, const char *name
);
463 int unit_add_dependency(Unit
*u
, UnitDependency d
, Unit
*other
, bool add_reference
);
464 int unit_add_two_dependencies(Unit
*u
, UnitDependency d
, UnitDependency e
, Unit
*other
, bool add_reference
);
466 int unit_add_dependency_by_name(Unit
*u
, UnitDependency d
, const char *name
, const char *filename
, bool add_reference
);
467 int unit_add_two_dependencies_by_name(Unit
*u
, UnitDependency d
, UnitDependency e
, const char *name
, const char *path
, bool add_reference
);
469 int unit_add_dependency_by_name_inverse(Unit
*u
, UnitDependency d
, const char *name
, const char *filename
, bool add_reference
);
470 int unit_add_two_dependencies_by_name_inverse(Unit
*u
, UnitDependency d
, UnitDependency e
, const char *name
, const char *path
, bool add_reference
);
472 int unit_add_exec_dependencies(Unit
*u
, ExecContext
*c
);
474 int unit_choose_id(Unit
*u
, const char *name
);
475 int unit_set_description(Unit
*u
, const char *description
);
477 bool unit_check_gc(Unit
*u
);
479 void unit_add_to_load_queue(Unit
*u
);
480 void unit_add_to_dbus_queue(Unit
*u
);
481 void unit_add_to_cleanup_queue(Unit
*u
);
482 void unit_add_to_gc_queue(Unit
*u
);
484 int unit_merge(Unit
*u
, Unit
*other
);
485 int unit_merge_by_name(Unit
*u
, const char *other
);
487 Unit
*unit_follow_merge(Unit
*u
) _pure_
;
489 int unit_load_fragment_and_dropin(Unit
*u
);
490 int unit_load_fragment_and_dropin_optional(Unit
*u
);
491 int unit_load(Unit
*unit
);
493 int unit_add_default_slice(Unit
*u
, CGroupContext
*c
);
495 const char *unit_description(Unit
*u
) _pure_
;
497 bool unit_has_name(Unit
*u
, const char *name
);
499 UnitActiveState
unit_active_state(Unit
*u
);
501 const char* unit_sub_state_to_string(Unit
*u
);
503 void unit_dump(Unit
*u
, FILE *f
, const char *prefix
);
505 bool unit_can_reload(Unit
*u
) _pure_
;
506 bool unit_can_start(Unit
*u
) _pure_
;
507 bool unit_can_isolate(Unit
*u
) _pure_
;
509 int unit_start(Unit
*u
);
510 int unit_stop(Unit
*u
);
511 int unit_reload(Unit
*u
);
513 int unit_kill(Unit
*u
, KillWho w
, int signo
, sd_bus_error
*error
);
514 int unit_kill_common(Unit
*u
, KillWho who
, int signo
, pid_t main_pid
, pid_t control_pid
, sd_bus_error
*error
);
516 void unit_notify(Unit
*u
, UnitActiveState os
, UnitActiveState ns
, bool reload_success
);
518 int unit_watch_pid(Unit
*u
, pid_t pid
);
519 void unit_unwatch_pid(Unit
*u
, pid_t pid
);
520 int unit_watch_all_pids(Unit
*u
);
521 void unit_unwatch_all_pids(Unit
*u
);
523 void unit_tidy_watch_pids(Unit
*u
, pid_t except1
, pid_t except2
);
525 int unit_watch_bus_name(Unit
*u
, const char *name
);
526 void unit_unwatch_bus_name(Unit
*u
, const char *name
);
528 bool unit_job_is_applicable(Unit
*u
, JobType j
);
530 int set_unit_path(const char *p
);
532 char *unit_dbus_path(Unit
*u
);
534 int unit_load_related_unit(Unit
*u
, const char *type
, Unit
**_found
);
536 bool unit_can_serialize(Unit
*u
) _pure_
;
537 int unit_serialize(Unit
*u
, FILE *f
, FDSet
*fds
, bool serialize_jobs
);
538 void unit_serialize_item_format(Unit
*u
, FILE *f
, const char *key
, const char *value
, ...) _printf_(4,5);
539 void unit_serialize_item(Unit
*u
, FILE *f
, const char *key
, const char *value
);
540 int unit_deserialize(Unit
*u
, FILE *f
, FDSet
*fds
);
542 int unit_add_node_link(Unit
*u
, const char *what
, bool wants
);
544 int unit_coldplug(Unit
*u
);
546 void unit_status_printf(Unit
*u
, const char *status
, const char *unit_status_msg_format
) _printf_(3, 0);
547 void unit_status_emit_starting_stopping_reloading(Unit
*u
, JobType t
);
549 bool unit_need_daemon_reload(Unit
*u
);
551 void unit_reset_failed(Unit
*u
);
553 Unit
*unit_following(Unit
*u
);
554 int unit_following_set(Unit
*u
, Set
**s
);
556 const char *unit_slice_name(Unit
*u
);
558 bool unit_stop_pending(Unit
*u
) _pure_
;
559 bool unit_inactive_or_pending(Unit
*u
) _pure_
;
560 bool unit_active_or_pending(Unit
*u
);
562 int unit_add_default_target_dependency(Unit
*u
, Unit
*target
);
564 char *unit_default_cgroup_path(Unit
*u
);
566 void unit_start_on_failure(Unit
*u
);
567 void unit_trigger_notify(Unit
*u
);
569 UnitFileState
unit_get_unit_file_state(Unit
*u
);
570 int unit_get_unit_file_preset(Unit
*u
);
572 Unit
* unit_ref_set(UnitRef
*ref
, Unit
*u
);
573 void unit_ref_unset(UnitRef
*ref
);
575 #define UNIT_DEREF(ref) ((ref).unit)
576 #define UNIT_ISSET(ref) (!!(ref).unit)
578 int unit_patch_contexts(Unit
*u
);
580 ExecContext
*unit_get_exec_context(Unit
*u
) _pure_
;
581 KillContext
*unit_get_kill_context(Unit
*u
) _pure_
;
582 CGroupContext
*unit_get_cgroup_context(Unit
*u
) _pure_
;
584 ExecRuntime
*unit_get_exec_runtime(Unit
*u
) _pure_
;
586 int unit_setup_exec_runtime(Unit
*u
);
588 int unit_write_drop_in(Unit
*u
, UnitSetPropertiesMode mode
, const char *name
, const char *data
);
589 int unit_write_drop_in_format(Unit
*u
, UnitSetPropertiesMode mode
, const char *name
, const char *format
, ...) _printf_(4,5);
591 int unit_write_drop_in_private(Unit
*u
, UnitSetPropertiesMode mode
, const char *name
, const char *data
);
592 int unit_write_drop_in_private_format(Unit
*u
, UnitSetPropertiesMode mode
, const char *name
, const char *format
, ...) _printf_(4,5);
594 int unit_remove_drop_in(Unit
*u
, UnitSetPropertiesMode mode
, const char *name
);
596 int unit_kill_context(Unit
*u
, KillContext
*c
, KillOperation k
, pid_t main_pid
, pid_t control_pid
, bool main_pid_alien
);
598 int unit_make_transient(Unit
*u
);
600 int unit_require_mounts_for(Unit
*u
, const char *path
);
602 bool unit_type_supported(UnitType t
);
604 static inline bool unit_supported(Unit
*u
) {
605 return unit_type_supported(u
->type
);
608 void unit_warn_if_dir_nonempty(Unit
*u
, const char* where
);
609 int unit_fail_if_symlink(Unit
*u
, const char* where
);
611 const char *unit_active_state_to_string(UnitActiveState i
) _const_
;
612 UnitActiveState
unit_active_state_from_string(const char *s
) _pure_
;
614 /* Macros which append UNIT= or USER_UNIT= to the message */
616 #define log_unit_full(unit, level, error, ...) \
619 _u ? log_object_internal(level, error, __FILE__, __LINE__, __func__, _u->manager->unit_log_field, _u->id, ##__VA_ARGS__) : \
620 log_internal(level, error, __FILE__, __LINE__, __func__, ##__VA_ARGS__); \
623 #define log_unit_debug(unit, ...) log_unit_full(unit, LOG_DEBUG, 0, ##__VA_ARGS__)
624 #define log_unit_info(unit, ...) log_unit_full(unit, LOG_INFO, 0, ##__VA_ARGS__)
625 #define log_unit_notice(unit, ...) log_unit_full(unit, LOG_NOTICE, 0, ##__VA_ARGS__)
626 #define log_unit_warning(unit, ...) log_unit_full(unit, LOG_WARNING, 0, ##__VA_ARGS__)
627 #define log_unit_error(unit, ...) log_unit_full(unit, LOG_ERR, 0, ##__VA_ARGS__)
629 #define log_unit_debug_errno(unit, error, ...) log_unit_full(unit, LOG_DEBUG, error, ##__VA_ARGS__)
630 #define log_unit_info_errno(unit, error, ...) log_unit_full(unit, LOG_INFO, error, ##__VA_ARGS__)
631 #define log_unit_notice_errno(unit, error, ...) log_unit_full(unit, LOG_NOTICE, error, ##__VA_ARGS__)
632 #define log_unit_warning_errno(unit, error, ...) log_unit_full(unit, LOG_WARNING, error, ##__VA_ARGS__)
633 #define log_unit_error_errno(unit, error, ...) log_unit_full(unit, LOG_ERR, error, ##__VA_ARGS__)
635 #define LOG_UNIT_MESSAGE(unit, fmt, ...) "MESSAGE=%s: " fmt, (unit)->id, ##__VA_ARGS__
636 #define LOG_UNIT_ID(unit) (unit)->manager->unit_log_format_string, (unit)->id