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 /* The slot used for watching NameOwnerChanged signals */
119 sd_bus_slot
*match_bus_slot
;
121 /* Job timeout and action to take */
123 FailureAction job_timeout_action
;
124 char *job_timeout_reboot_arg
;
126 /* References to this */
127 LIST_HEAD(UnitRef
, refs
);
129 /* Conditions to check */
130 LIST_HEAD(Condition
, conditions
);
131 LIST_HEAD(Condition
, asserts
);
133 dual_timestamp condition_timestamp
;
134 dual_timestamp assert_timestamp
;
136 dual_timestamp inactive_exit_timestamp
;
137 dual_timestamp active_enter_timestamp
;
138 dual_timestamp active_exit_timestamp
;
139 dual_timestamp inactive_enter_timestamp
;
144 LIST_FIELDS(Unit
, units_by_type
);
146 /* All units which have requires_mounts_for set */
147 LIST_FIELDS(Unit
, has_requires_mounts_for
);
150 LIST_FIELDS(Unit
, load_queue
);
153 LIST_FIELDS(Unit
, dbus_queue
);
156 LIST_FIELDS(Unit
, cleanup_queue
);
159 LIST_FIELDS(Unit
, gc_queue
);
161 /* CGroup realize members queue */
162 LIST_FIELDS(Unit
, cgroup_queue
);
164 /* Units with the same CGroup netclass */
165 LIST_FIELDS(Unit
, cgroup_netclass
);
167 /* PIDs we keep an eye on. Note that a unit might have many
168 * more, but these are the ones we care enough about to
169 * process SIGCHLD for */
172 /* Used during GC sweeps */
175 /* Error code when we didn't manage to load the unit (negative) */
178 /* Make sure we never enter endless loops with the check unneeded logic, or the BindsTo= logic */
179 RateLimit auto_stop_ratelimit
;
181 /* Cached unit file state and preset */
182 UnitFileState unit_file_state
;
183 int unit_file_preset
;
185 /* Where the cpuacct.usage cgroup counter was at the time the unit was started */
186 nsec_t cpuacct_usage_base
;
188 /* Counterparts in the cgroup filesystem */
190 CGroupMask cgroup_realized_mask
;
191 CGroupMask cgroup_subtree_mask
;
192 CGroupMask cgroup_members_mask
;
193 int cgroup_inotify_wd
;
195 uint32_t cgroup_netclass_id
;
197 /* How to start OnFailure units */
198 JobMode on_failure_job_mode
;
200 /* Garbage collect us we nobody wants or requires us anymore */
201 bool stop_when_unneeded
;
203 /* Create default dependencies */
204 bool default_dependencies
;
206 /* Refuse manual starting, allow starting only indirectly via dependency. */
207 bool refuse_manual_start
;
209 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
210 bool refuse_manual_stop
;
212 /* Allow isolation requests */
215 /* Ignore this unit when isolating */
216 bool ignore_on_isolate
;
218 /* Ignore this unit when snapshotting */
219 bool ignore_on_snapshot
;
221 /* Did the last condition check succeed? */
222 bool condition_result
;
225 /* Is this a transient unit? */
228 bool in_load_queue
:1;
229 bool in_dbus_queue
:1;
230 bool in_cleanup_queue
:1;
232 bool in_cgroup_queue
:1;
234 bool sent_dbus_new_signal
:1;
240 bool cgroup_realized
:1;
241 bool cgroup_members_mask_valid
:1;
242 bool cgroup_subtree_mask_valid
:1;
244 /* Did we already invoke unit_coldplug() for this unit? */
248 struct UnitStatusMessageFormats
{
249 const char *starting_stopping
[2];
250 const char *finished_start_job
[_JOB_RESULT_MAX
];
251 const char *finished_stop_job
[_JOB_RESULT_MAX
];
254 typedef enum UnitSetPropertiesMode
{
258 } UnitSetPropertiesMode
;
263 #include "snapshot.h"
265 #include "automount.h"
273 /* How much memory does an object of this unit type need */
276 /* If greater than 0, the offset into the object where
277 * ExecContext is found, if the unit type has that */
278 size_t exec_context_offset
;
280 /* If greater than 0, the offset into the object where
281 * CGroupContext is found, if the unit type has that */
282 size_t cgroup_context_offset
;
284 /* If greater than 0, the offset into the object where
285 * KillContext is found, if the unit type has that */
286 size_t kill_context_offset
;
288 /* If greater than 0, the offset into the object where the
289 * pointer to ExecRuntime is found, if the unit type has
291 size_t exec_runtime_offset
;
293 /* The name of the configuration file section with the private settings of this unit */
294 const char *private_section
;
296 /* Config file sections this unit type understands, separated
298 const char *sections
;
300 /* This should reset all type-specific variables. This should
301 * not allocate memory, and is called with zero-initialized
302 * data. It should hence only initialize variables that need
304 void (*init
)(Unit
*u
);
306 /* This should free all type-specific variables. It should be
308 void (*done
)(Unit
*u
);
310 /* Actually load data from disk. This may fail, and should set
311 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
312 * UNIT_STUB if no configuration could be found. */
313 int (*load
)(Unit
*u
);
315 /* If a lot of units got created via enumerate(), this is
316 * where to actually set the state and call unit_notify(). */
317 int (*coldplug
)(Unit
*u
);
319 void (*dump
)(Unit
*u
, FILE *f
, const char *prefix
);
321 int (*start
)(Unit
*u
);
322 int (*stop
)(Unit
*u
);
323 int (*reload
)(Unit
*u
);
325 int (*kill
)(Unit
*u
, KillWho w
, int signo
, sd_bus_error
*error
);
327 bool (*can_reload
)(Unit
*u
);
329 /* Write all data that cannot be restored from other sources
330 * away using unit_serialize_item() */
331 int (*serialize
)(Unit
*u
, FILE *f
, FDSet
*fds
);
333 /* Restore one item from the serialization */
334 int (*deserialize_item
)(Unit
*u
, const char *key
, const char *data
, FDSet
*fds
);
336 /* Try to match up fds with what we need for this unit */
337 int (*distribute_fds
)(Unit
*u
, FDSet
*fds
);
339 /* Boils down the more complex internal state of this unit to
340 * a simpler one that the engine can understand */
341 UnitActiveState (*active_state
)(Unit
*u
);
343 /* Returns the substate specific to this unit type as
344 * string. This is purely information so that we can give the
345 * user a more fine grained explanation in which actual state a
347 const char* (*sub_state_to_string
)(Unit
*u
);
349 /* Return true when there is reason to keep this entry around
350 * even nothing references it and it isn't active in any
352 bool (*check_gc
)(Unit
*u
);
354 /* When the unit is not running and no job for it queued we
355 * shall release its runtime resources */
356 void (*release_resources
)(Unit
*u
);
358 /* Return true when this unit is suitable for snapshotting */
359 bool (*check_snapshot
)(Unit
*u
);
361 /* Invoked on every child that died */
362 void (*sigchld_event
)(Unit
*u
, pid_t pid
, int code
, int status
);
364 /* Reset failed state if we are in failed state */
365 void (*reset_failed
)(Unit
*u
);
367 /* Called whenever any of the cgroups this unit watches for
369 void (*notify_cgroup_empty
)(Unit
*u
);
371 /* Called whenever a process of this unit sends us a message */
372 void (*notify_message
)(Unit
*u
, pid_t pid
, char **tags
, FDSet
*fds
);
374 /* Called whenever a name this Unit registered for comes or
376 void (*bus_name_owner_change
)(Unit
*u
, const char *name
, const char *old_owner
, const char *new_owner
);
378 /* Called for each property that is being set */
379 int (*bus_set_property
)(Unit
*u
, const char *name
, sd_bus_message
*message
, UnitSetPropertiesMode mode
, sd_bus_error
*error
);
381 /* Called after at least one property got changed to apply the necessary change */
382 int (*bus_commit_properties
)(Unit
*u
);
384 /* Return the unit this unit is following */
385 Unit
*(*following
)(Unit
*u
);
387 /* Return the set of units that are following each other */
388 int (*following_set
)(Unit
*u
, Set
**s
);
390 /* Invoked each time a unit this unit is triggering changes
391 * state or gains/loses a job */
392 void (*trigger_notify
)(Unit
*u
, Unit
*trigger
);
394 /* Called whenever CLOCK_REALTIME made a jump */
395 void (*time_change
)(Unit
*u
);
397 int (*get_timeout
)(Unit
*u
, uint64_t *timeout
);
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 int (*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 /* Exclude from automatic gc */
428 /* True if transient units of this type are OK */
429 bool can_transient
:1;
432 extern const UnitVTable
* const unit_vtable
[_UNIT_TYPE_MAX
];
434 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
436 /* For casting a unit into the various unit types */
437 #define DEFINE_CAST(UPPERCASE, MixedCase) \
438 static inline MixedCase* UPPERCASE(Unit *u) { \
439 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
442 return (MixedCase*) u; \
445 /* For casting the various unit types into a unit */
446 #define UNIT(u) (&(u)->meta)
448 #define UNIT_HAS_EXEC_CONTEXT(u) (UNIT_VTABLE(u)->exec_context_offset > 0)
449 #define UNIT_HAS_CGROUP_CONTEXT(u) (UNIT_VTABLE(u)->cgroup_context_offset > 0)
450 #define UNIT_HAS_KILL_CONTEXT(u) (UNIT_VTABLE(u)->kill_context_offset > 0)
452 #define UNIT_TRIGGER(u) ((Unit*) set_first((u)->dependencies[UNIT_TRIGGERS]))
454 DEFINE_CAST(SERVICE
, Service
);
455 DEFINE_CAST(SOCKET
, Socket
);
456 DEFINE_CAST(BUSNAME
, BusName
);
457 DEFINE_CAST(TARGET
, Target
);
458 DEFINE_CAST(SNAPSHOT
, Snapshot
);
459 DEFINE_CAST(DEVICE
, Device
);
460 DEFINE_CAST(MOUNT
, Mount
);
461 DEFINE_CAST(AUTOMOUNT
, Automount
);
462 DEFINE_CAST(SWAP
, Swap
);
463 DEFINE_CAST(TIMER
, Timer
);
464 DEFINE_CAST(PATH
, Path
);
465 DEFINE_CAST(SLICE
, Slice
);
466 DEFINE_CAST(SCOPE
, Scope
);
468 Unit
*unit_new(Manager
*m
, size_t size
);
469 void unit_free(Unit
*u
);
471 int unit_add_name(Unit
*u
, const char *name
);
473 int unit_add_dependency(Unit
*u
, UnitDependency d
, Unit
*other
, bool add_reference
);
474 int unit_add_two_dependencies(Unit
*u
, UnitDependency d
, UnitDependency e
, Unit
*other
, bool add_reference
);
476 int unit_add_dependency_by_name(Unit
*u
, UnitDependency d
, const char *name
, const char *filename
, bool add_reference
);
477 int unit_add_two_dependencies_by_name(Unit
*u
, UnitDependency d
, UnitDependency e
, const char *name
, const char *path
, bool add_reference
);
479 int unit_add_dependency_by_name_inverse(Unit
*u
, UnitDependency d
, const char *name
, const char *filename
, bool add_reference
);
480 int unit_add_two_dependencies_by_name_inverse(Unit
*u
, UnitDependency d
, UnitDependency e
, const char *name
, const char *path
, bool add_reference
);
482 int unit_add_exec_dependencies(Unit
*u
, ExecContext
*c
);
484 int unit_choose_id(Unit
*u
, const char *name
);
485 int unit_set_description(Unit
*u
, const char *description
);
487 bool unit_check_gc(Unit
*u
);
489 void unit_add_to_load_queue(Unit
*u
);
490 void unit_add_to_dbus_queue(Unit
*u
);
491 void unit_add_to_cleanup_queue(Unit
*u
);
492 void unit_add_to_gc_queue(Unit
*u
);
494 int unit_merge(Unit
*u
, Unit
*other
);
495 int unit_merge_by_name(Unit
*u
, const char *other
);
497 Unit
*unit_follow_merge(Unit
*u
) _pure_
;
499 int unit_load_fragment_and_dropin(Unit
*u
);
500 int unit_load_fragment_and_dropin_optional(Unit
*u
);
501 int unit_load(Unit
*unit
);
503 int unit_set_slice(Unit
*u
, Unit
*slice
);
504 int unit_set_default_slice(Unit
*u
);
506 const char *unit_description(Unit
*u
) _pure_
;
508 bool unit_has_name(Unit
*u
, const char *name
);
510 UnitActiveState
unit_active_state(Unit
*u
);
512 const char* unit_sub_state_to_string(Unit
*u
);
514 void unit_dump(Unit
*u
, FILE *f
, const char *prefix
);
516 bool unit_can_reload(Unit
*u
) _pure_
;
517 bool unit_can_start(Unit
*u
) _pure_
;
518 bool unit_can_isolate(Unit
*u
) _pure_
;
520 int unit_start(Unit
*u
);
521 int unit_stop(Unit
*u
);
522 int unit_reload(Unit
*u
);
524 int unit_kill(Unit
*u
, KillWho w
, int signo
, sd_bus_error
*error
);
525 int unit_kill_common(Unit
*u
, KillWho who
, int signo
, pid_t main_pid
, pid_t control_pid
, sd_bus_error
*error
);
527 void unit_notify(Unit
*u
, UnitActiveState os
, UnitActiveState ns
, bool reload_success
);
529 int unit_watch_pid(Unit
*u
, pid_t pid
);
530 void unit_unwatch_pid(Unit
*u
, pid_t pid
);
531 void unit_unwatch_all_pids(Unit
*u
);
533 void unit_tidy_watch_pids(Unit
*u
, pid_t except1
, pid_t except2
);
535 int unit_install_bus_match(sd_bus
*bus
, Unit
*u
, const char *name
);
536 int unit_watch_bus_name(Unit
*u
, const char *name
);
537 void unit_unwatch_bus_name(Unit
*u
, const char *name
);
539 bool unit_job_is_applicable(Unit
*u
, JobType j
);
541 int set_unit_path(const char *p
);
543 char *unit_dbus_path(Unit
*u
);
545 int unit_load_related_unit(Unit
*u
, const char *type
, Unit
**_found
);
547 bool unit_can_serialize(Unit
*u
) _pure_
;
548 int unit_serialize(Unit
*u
, FILE *f
, FDSet
*fds
, bool serialize_jobs
);
549 void unit_serialize_item_format(Unit
*u
, FILE *f
, const char *key
, const char *value
, ...) _printf_(4,5);
550 void unit_serialize_item(Unit
*u
, FILE *f
, const char *key
, const char *value
);
551 int unit_deserialize(Unit
*u
, FILE *f
, FDSet
*fds
);
553 int unit_add_node_link(Unit
*u
, const char *what
, bool wants
);
555 int unit_coldplug(Unit
*u
);
557 void unit_status_printf(Unit
*u
, const char *status
, const char *unit_status_msg_format
) _printf_(3, 0);
558 void unit_status_emit_starting_stopping_reloading(Unit
*u
, JobType t
);
560 bool unit_need_daemon_reload(Unit
*u
);
562 void unit_reset_failed(Unit
*u
);
564 Unit
*unit_following(Unit
*u
);
565 int unit_following_set(Unit
*u
, Set
**s
);
567 const char *unit_slice_name(Unit
*u
);
569 bool unit_stop_pending(Unit
*u
) _pure_
;
570 bool unit_inactive_or_pending(Unit
*u
) _pure_
;
571 bool unit_active_or_pending(Unit
*u
);
573 int unit_add_default_target_dependency(Unit
*u
, Unit
*target
);
575 void unit_start_on_failure(Unit
*u
);
576 void unit_trigger_notify(Unit
*u
);
578 UnitFileState
unit_get_unit_file_state(Unit
*u
);
579 int unit_get_unit_file_preset(Unit
*u
);
581 Unit
* unit_ref_set(UnitRef
*ref
, Unit
*u
);
582 void unit_ref_unset(UnitRef
*ref
);
584 #define UNIT_DEREF(ref) ((ref).unit)
585 #define UNIT_ISSET(ref) (!!(ref).unit)
587 int unit_patch_contexts(Unit
*u
);
589 ExecContext
*unit_get_exec_context(Unit
*u
) _pure_
;
590 KillContext
*unit_get_kill_context(Unit
*u
) _pure_
;
591 CGroupContext
*unit_get_cgroup_context(Unit
*u
) _pure_
;
593 ExecRuntime
*unit_get_exec_runtime(Unit
*u
) _pure_
;
595 int unit_setup_exec_runtime(Unit
*u
);
597 int unit_write_drop_in(Unit
*u
, UnitSetPropertiesMode mode
, const char *name
, const char *data
);
598 int unit_write_drop_in_format(Unit
*u
, UnitSetPropertiesMode mode
, const char *name
, const char *format
, ...) _printf_(4,5);
600 int unit_write_drop_in_private(Unit
*u
, UnitSetPropertiesMode mode
, const char *name
, const char *data
);
601 int unit_write_drop_in_private_format(Unit
*u
, UnitSetPropertiesMode mode
, const char *name
, const char *format
, ...) _printf_(4,5);
603 int unit_remove_drop_in(Unit
*u
, UnitSetPropertiesMode mode
, const char *name
);
605 int unit_kill_context(Unit
*u
, KillContext
*c
, KillOperation k
, pid_t main_pid
, pid_t control_pid
, bool main_pid_alien
);
607 int unit_make_transient(Unit
*u
);
609 int unit_require_mounts_for(Unit
*u
, const char *path
);
611 bool unit_type_supported(UnitType t
);
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 const char *unit_active_state_to_string(UnitActiveState i
) _const_
;
621 UnitActiveState
unit_active_state_from_string(const char *s
) _pure_
;
623 /* Macros which append UNIT= or USER_UNIT= to the message */
625 #define log_unit_full(unit, level, error, ...) \
628 _u ? log_object_internal(level, error, __FILE__, __LINE__, __func__, _u->manager->unit_log_field, _u->id, ##__VA_ARGS__) : \
629 log_internal(level, error, __FILE__, __LINE__, __func__, ##__VA_ARGS__); \
632 #define log_unit_debug(unit, ...) log_unit_full(unit, LOG_DEBUG, 0, ##__VA_ARGS__)
633 #define log_unit_info(unit, ...) log_unit_full(unit, LOG_INFO, 0, ##__VA_ARGS__)
634 #define log_unit_notice(unit, ...) log_unit_full(unit, LOG_NOTICE, 0, ##__VA_ARGS__)
635 #define log_unit_warning(unit, ...) log_unit_full(unit, LOG_WARNING, 0, ##__VA_ARGS__)
636 #define log_unit_error(unit, ...) log_unit_full(unit, LOG_ERR, 0, ##__VA_ARGS__)
638 #define log_unit_debug_errno(unit, error, ...) log_unit_full(unit, LOG_DEBUG, error, ##__VA_ARGS__)
639 #define log_unit_info_errno(unit, error, ...) log_unit_full(unit, LOG_INFO, error, ##__VA_ARGS__)
640 #define log_unit_notice_errno(unit, error, ...) log_unit_full(unit, LOG_NOTICE, error, ##__VA_ARGS__)
641 #define log_unit_warning_errno(unit, error, ...) log_unit_full(unit, LOG_WARNING, error, ##__VA_ARGS__)
642 #define log_unit_error_errno(unit, error, ...) log_unit_full(unit, LOG_ERR, error, ##__VA_ARGS__)
644 #define LOG_UNIT_MESSAGE(unit, fmt, ...) "MESSAGE=%s: " fmt, (unit)->id, ##__VA_ARGS__
645 #define LOG_UNIT_ID(unit) (unit)->manager->unit_log_format_string, (unit)->id