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 /* PIDs we keep an eye on. Note that a unit might have many
165 * more, but these are the ones we care enough about to
166 * process SIGCHLD for */
169 /* Used during GC sweeps */
172 /* Error code when we didn't manage to load the unit (negative) */
175 /* Make sure we never enter endless loops with the check unneeded logic, or the BindsTo= logic */
176 RateLimit auto_stop_ratelimit
;
178 /* Cached unit file state and preset */
179 UnitFileState unit_file_state
;
180 int unit_file_preset
;
182 /* Where the cpuacct.usage cgroup counter was at the time the unit was started */
183 nsec_t cpuacct_usage_base
;
185 /* Counterparts in the cgroup filesystem */
187 CGroupMask cgroup_realized_mask
;
188 CGroupMask cgroup_subtree_mask
;
189 CGroupMask cgroup_members_mask
;
190 int cgroup_inotify_wd
;
192 /* How to start OnFailure units */
193 JobMode on_failure_job_mode
;
195 /* Garbage collect us we nobody wants or requires us anymore */
196 bool stop_when_unneeded
;
198 /* Create default dependencies */
199 bool default_dependencies
;
201 /* Refuse manual starting, allow starting only indirectly via dependency. */
202 bool refuse_manual_start
;
204 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
205 bool refuse_manual_stop
;
207 /* Allow isolation requests */
210 /* Ignore this unit when isolating */
211 bool ignore_on_isolate
;
213 /* Ignore this unit when snapshotting */
214 bool ignore_on_snapshot
;
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 /* Did we already invoke unit_coldplug() for this unit? */
243 struct UnitStatusMessageFormats
{
244 const char *starting_stopping
[2];
245 const char *finished_start_job
[_JOB_RESULT_MAX
];
246 const char *finished_stop_job
[_JOB_RESULT_MAX
];
249 typedef enum UnitSetPropertiesMode
{
253 } UnitSetPropertiesMode
;
258 #include "snapshot.h"
260 #include "automount.h"
268 /* How much memory does an object of this unit type need */
271 /* If greater than 0, the offset into the object where
272 * ExecContext is found, if the unit type has that */
273 size_t exec_context_offset
;
275 /* If greater than 0, the offset into the object where
276 * CGroupContext is found, if the unit type has that */
277 size_t cgroup_context_offset
;
279 /* If greater than 0, the offset into the object where
280 * KillContext is found, if the unit type has that */
281 size_t kill_context_offset
;
283 /* If greater than 0, the offset into the object where the
284 * pointer to ExecRuntime is found, if the unit type has
286 size_t exec_runtime_offset
;
288 /* The name of the configuration file section with the private settings of this unit */
289 const char *private_section
;
291 /* Config file sections this unit type understands, separated
293 const char *sections
;
295 /* This should reset all type-specific variables. This should
296 * not allocate memory, and is called with zero-initialized
297 * data. It should hence only initialize variables that need
299 void (*init
)(Unit
*u
);
301 /* This should free all type-specific variables. It should be
303 void (*done
)(Unit
*u
);
305 /* Actually load data from disk. This may fail, and should set
306 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
307 * UNIT_STUB if no configuration could be found. */
308 int (*load
)(Unit
*u
);
310 /* If a lot of units got created via enumerate(), this is
311 * where to actually set the state and call unit_notify(). */
312 int (*coldplug
)(Unit
*u
);
314 void (*dump
)(Unit
*u
, FILE *f
, const char *prefix
);
316 int (*start
)(Unit
*u
);
317 int (*stop
)(Unit
*u
);
318 int (*reload
)(Unit
*u
);
320 int (*kill
)(Unit
*u
, KillWho w
, int signo
, sd_bus_error
*error
);
322 bool (*can_reload
)(Unit
*u
);
324 /* Write all data that cannot be restored from other sources
325 * away using unit_serialize_item() */
326 int (*serialize
)(Unit
*u
, FILE *f
, FDSet
*fds
);
328 /* Restore one item from the serialization */
329 int (*deserialize_item
)(Unit
*u
, const char *key
, const char *data
, FDSet
*fds
);
331 /* Try to match up fds with what we need for this unit */
332 int (*distribute_fds
)(Unit
*u
, FDSet
*fds
);
334 /* Boils down the more complex internal state of this unit to
335 * a simpler one that the engine can understand */
336 UnitActiveState (*active_state
)(Unit
*u
);
338 /* Returns the substate specific to this unit type as
339 * string. This is purely information so that we can give the
340 * user a more fine grained explanation in which actual state a
342 const char* (*sub_state_to_string
)(Unit
*u
);
344 /* Return true when there is reason to keep this entry around
345 * even nothing references it and it isn't active in any
347 bool (*check_gc
)(Unit
*u
);
349 /* When the unit is not running and no job for it queued we
350 * shall release its runtime resources */
351 void (*release_resources
)(Unit
*u
);
353 /* Return true when this unit is suitable for snapshotting */
354 bool (*check_snapshot
)(Unit
*u
);
356 /* Invoked on every child that died */
357 void (*sigchld_event
)(Unit
*u
, pid_t pid
, int code
, int status
);
359 /* Reset failed state if we are in failed state */
360 void (*reset_failed
)(Unit
*u
);
362 /* Called whenever any of the cgroups this unit watches for
364 void (*notify_cgroup_empty
)(Unit
*u
);
366 /* Called whenever a process of this unit sends us a message */
367 void (*notify_message
)(Unit
*u
, pid_t pid
, char **tags
, FDSet
*fds
);
369 /* Called whenever a name this Unit registered for comes or
371 void (*bus_name_owner_change
)(Unit
*u
, const char *name
, const char *old_owner
, const char *new_owner
);
373 /* Called for each property that is being set */
374 int (*bus_set_property
)(Unit
*u
, const char *name
, sd_bus_message
*message
, UnitSetPropertiesMode mode
, sd_bus_error
*error
);
376 /* Called after at least one property got changed to apply the necessary change */
377 int (*bus_commit_properties
)(Unit
*u
);
379 /* Return the unit this unit is following */
380 Unit
*(*following
)(Unit
*u
);
382 /* Return the set of units that are following each other */
383 int (*following_set
)(Unit
*u
, Set
**s
);
385 /* Invoked each time a unit this unit is triggering changes
386 * state or gains/loses a job */
387 void (*trigger_notify
)(Unit
*u
, Unit
*trigger
);
389 /* Called whenever CLOCK_REALTIME made a jump */
390 void (*time_change
)(Unit
*u
);
392 int (*get_timeout
)(Unit
*u
, uint64_t *timeout
);
394 /* This is called for each unit type and should be used to
395 * enumerate existing devices and load them. However,
396 * everything that is loaded here should still stay in
397 * inactive state. It is the job of the coldplug() call above
398 * to put the units into the initial state. */
399 int (*enumerate
)(Manager
*m
);
401 /* Type specific cleanups. */
402 void (*shutdown
)(Manager
*m
);
404 /* If this function is set and return false all jobs for units
405 * of this type will immediately fail. */
406 bool (*supported
)(void);
409 const sd_bus_vtable
*bus_vtable
;
411 /* The strings to print in status messages */
412 UnitStatusMessageFormats status_message_formats
;
414 /* Can units of this type have multiple names? */
417 /* Instances make no sense for this type */
420 /* Exclude from automatic gc */
423 /* True if transient units of this type are OK */
424 bool can_transient
:1;
427 extern const UnitVTable
* const unit_vtable
[_UNIT_TYPE_MAX
];
429 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
431 /* For casting a unit into the various unit types */
432 #define DEFINE_CAST(UPPERCASE, MixedCase) \
433 static inline MixedCase* UPPERCASE(Unit *u) { \
434 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
437 return (MixedCase*) u; \
440 /* For casting the various unit types into a unit */
441 #define UNIT(u) (&(u)->meta)
443 #define UNIT_HAS_EXEC_CONTEXT(u) (UNIT_VTABLE(u)->exec_context_offset > 0)
444 #define UNIT_HAS_CGROUP_CONTEXT(u) (UNIT_VTABLE(u)->cgroup_context_offset > 0)
445 #define UNIT_HAS_KILL_CONTEXT(u) (UNIT_VTABLE(u)->kill_context_offset > 0)
447 #define UNIT_TRIGGER(u) ((Unit*) set_first((u)->dependencies[UNIT_TRIGGERS]))
449 DEFINE_CAST(SERVICE
, Service
);
450 DEFINE_CAST(SOCKET
, Socket
);
451 DEFINE_CAST(BUSNAME
, BusName
);
452 DEFINE_CAST(TARGET
, Target
);
453 DEFINE_CAST(SNAPSHOT
, Snapshot
);
454 DEFINE_CAST(DEVICE
, Device
);
455 DEFINE_CAST(MOUNT
, Mount
);
456 DEFINE_CAST(AUTOMOUNT
, Automount
);
457 DEFINE_CAST(SWAP
, Swap
);
458 DEFINE_CAST(TIMER
, Timer
);
459 DEFINE_CAST(PATH
, Path
);
460 DEFINE_CAST(SLICE
, Slice
);
461 DEFINE_CAST(SCOPE
, Scope
);
463 Unit
*unit_new(Manager
*m
, size_t size
);
464 void unit_free(Unit
*u
);
466 int unit_add_name(Unit
*u
, const char *name
);
468 int unit_add_dependency(Unit
*u
, UnitDependency d
, Unit
*other
, bool add_reference
);
469 int unit_add_two_dependencies(Unit
*u
, UnitDependency d
, UnitDependency e
, Unit
*other
, bool add_reference
);
471 int unit_add_dependency_by_name(Unit
*u
, UnitDependency d
, const char *name
, const char *filename
, bool add_reference
);
472 int unit_add_two_dependencies_by_name(Unit
*u
, UnitDependency d
, UnitDependency e
, const char *name
, const char *path
, bool add_reference
);
474 int unit_add_dependency_by_name_inverse(Unit
*u
, UnitDependency d
, const char *name
, const char *filename
, bool add_reference
);
475 int unit_add_two_dependencies_by_name_inverse(Unit
*u
, UnitDependency d
, UnitDependency e
, const char *name
, const char *path
, bool add_reference
);
477 int unit_add_exec_dependencies(Unit
*u
, ExecContext
*c
);
479 int unit_choose_id(Unit
*u
, const char *name
);
480 int unit_set_description(Unit
*u
, const char *description
);
482 bool unit_check_gc(Unit
*u
);
484 void unit_add_to_load_queue(Unit
*u
);
485 void unit_add_to_dbus_queue(Unit
*u
);
486 void unit_add_to_cleanup_queue(Unit
*u
);
487 void unit_add_to_gc_queue(Unit
*u
);
489 int unit_merge(Unit
*u
, Unit
*other
);
490 int unit_merge_by_name(Unit
*u
, const char *other
);
492 Unit
*unit_follow_merge(Unit
*u
) _pure_
;
494 int unit_load_fragment_and_dropin(Unit
*u
);
495 int unit_load_fragment_and_dropin_optional(Unit
*u
);
496 int unit_load(Unit
*unit
);
498 int unit_set_slice(Unit
*u
, Unit
*slice
);
499 int unit_set_default_slice(Unit
*u
);
501 const char *unit_description(Unit
*u
) _pure_
;
503 bool unit_has_name(Unit
*u
, const char *name
);
505 UnitActiveState
unit_active_state(Unit
*u
);
507 const char* unit_sub_state_to_string(Unit
*u
);
509 void unit_dump(Unit
*u
, FILE *f
, const char *prefix
);
511 bool unit_can_reload(Unit
*u
) _pure_
;
512 bool unit_can_start(Unit
*u
) _pure_
;
513 bool unit_can_isolate(Unit
*u
) _pure_
;
515 int unit_start(Unit
*u
);
516 int unit_stop(Unit
*u
);
517 int unit_reload(Unit
*u
);
519 int unit_kill(Unit
*u
, KillWho w
, int signo
, sd_bus_error
*error
);
520 int unit_kill_common(Unit
*u
, KillWho who
, int signo
, pid_t main_pid
, pid_t control_pid
, sd_bus_error
*error
);
522 void unit_notify(Unit
*u
, UnitActiveState os
, UnitActiveState ns
, bool reload_success
);
524 int unit_watch_pid(Unit
*u
, pid_t pid
);
525 void unit_unwatch_pid(Unit
*u
, pid_t pid
);
526 void unit_unwatch_all_pids(Unit
*u
);
528 void unit_tidy_watch_pids(Unit
*u
, pid_t except1
, pid_t except2
);
530 int unit_install_bus_match(sd_bus
*bus
, Unit
*u
, const char *name
);
531 int unit_watch_bus_name(Unit
*u
, const char *name
);
532 void unit_unwatch_bus_name(Unit
*u
, const char *name
);
534 bool unit_job_is_applicable(Unit
*u
, JobType j
);
536 int set_unit_path(const char *p
);
538 char *unit_dbus_path(Unit
*u
);
540 int unit_load_related_unit(Unit
*u
, const char *type
, Unit
**_found
);
542 bool unit_can_serialize(Unit
*u
) _pure_
;
543 int unit_serialize(Unit
*u
, FILE *f
, FDSet
*fds
, bool serialize_jobs
);
544 void unit_serialize_item_format(Unit
*u
, FILE *f
, const char *key
, const char *value
, ...) _printf_(4,5);
545 void unit_serialize_item(Unit
*u
, FILE *f
, const char *key
, const char *value
);
546 int unit_deserialize(Unit
*u
, FILE *f
, FDSet
*fds
);
548 int unit_add_node_link(Unit
*u
, const char *what
, bool wants
);
550 int unit_coldplug(Unit
*u
);
552 void unit_status_printf(Unit
*u
, const char *status
, const char *unit_status_msg_format
) _printf_(3, 0);
553 void unit_status_emit_starting_stopping_reloading(Unit
*u
, JobType t
);
555 bool unit_need_daemon_reload(Unit
*u
);
557 void unit_reset_failed(Unit
*u
);
559 Unit
*unit_following(Unit
*u
);
560 int unit_following_set(Unit
*u
, Set
**s
);
562 const char *unit_slice_name(Unit
*u
);
564 bool unit_stop_pending(Unit
*u
) _pure_
;
565 bool unit_inactive_or_pending(Unit
*u
) _pure_
;
566 bool unit_active_or_pending(Unit
*u
);
568 int unit_add_default_target_dependency(Unit
*u
, Unit
*target
);
570 void unit_start_on_failure(Unit
*u
);
571 void unit_trigger_notify(Unit
*u
);
573 UnitFileState
unit_get_unit_file_state(Unit
*u
);
574 int unit_get_unit_file_preset(Unit
*u
);
576 Unit
* unit_ref_set(UnitRef
*ref
, Unit
*u
);
577 void unit_ref_unset(UnitRef
*ref
);
579 #define UNIT_DEREF(ref) ((ref).unit)
580 #define UNIT_ISSET(ref) (!!(ref).unit)
582 int unit_patch_contexts(Unit
*u
);
584 ExecContext
*unit_get_exec_context(Unit
*u
) _pure_
;
585 KillContext
*unit_get_kill_context(Unit
*u
) _pure_
;
586 CGroupContext
*unit_get_cgroup_context(Unit
*u
) _pure_
;
588 ExecRuntime
*unit_get_exec_runtime(Unit
*u
) _pure_
;
590 int unit_setup_exec_runtime(Unit
*u
);
592 int unit_write_drop_in(Unit
*u
, UnitSetPropertiesMode mode
, const char *name
, const char *data
);
593 int unit_write_drop_in_format(Unit
*u
, UnitSetPropertiesMode mode
, const char *name
, const char *format
, ...) _printf_(4,5);
595 int unit_write_drop_in_private(Unit
*u
, UnitSetPropertiesMode mode
, const char *name
, const char *data
);
596 int unit_write_drop_in_private_format(Unit
*u
, UnitSetPropertiesMode mode
, const char *name
, const char *format
, ...) _printf_(4,5);
598 int unit_remove_drop_in(Unit
*u
, UnitSetPropertiesMode mode
, const char *name
);
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 static inline bool unit_supported(Unit
*u
) {
609 return unit_type_supported(u
->type
);
612 void unit_warn_if_dir_nonempty(Unit
*u
, const char* where
);
613 int unit_fail_if_symlink(Unit
*u
, const char* where
);
615 const char *unit_active_state_to_string(UnitActiveState i
) _const_
;
616 UnitActiveState
unit_active_state_from_string(const char *s
) _pure_
;
618 /* Macros which append UNIT= or USER_UNIT= to the message */
620 #define log_unit_full(unit, level, error, ...) \
623 _u ? log_object_internal(level, error, __FILE__, __LINE__, __func__, _u->manager->unit_log_field, _u->id, ##__VA_ARGS__) : \
624 log_internal(level, error, __FILE__, __LINE__, __func__, ##__VA_ARGS__); \
627 #define log_unit_debug(unit, ...) log_unit_full(unit, LOG_DEBUG, 0, ##__VA_ARGS__)
628 #define log_unit_info(unit, ...) log_unit_full(unit, LOG_INFO, 0, ##__VA_ARGS__)
629 #define log_unit_notice(unit, ...) log_unit_full(unit, LOG_NOTICE, 0, ##__VA_ARGS__)
630 #define log_unit_warning(unit, ...) log_unit_full(unit, LOG_WARNING, 0, ##__VA_ARGS__)
631 #define log_unit_error(unit, ...) log_unit_full(unit, LOG_ERR, 0, ##__VA_ARGS__)
633 #define log_unit_debug_errno(unit, error, ...) log_unit_full(unit, LOG_DEBUG, error, ##__VA_ARGS__)
634 #define log_unit_info_errno(unit, error, ...) log_unit_full(unit, LOG_INFO, error, ##__VA_ARGS__)
635 #define log_unit_notice_errno(unit, error, ...) log_unit_full(unit, LOG_NOTICE, error, ##__VA_ARGS__)
636 #define log_unit_warning_errno(unit, error, ...) log_unit_full(unit, LOG_WARNING, error, ##__VA_ARGS__)
637 #define log_unit_error_errno(unit, error, ...) log_unit_full(unit, LOG_ERR, error, ##__VA_ARGS__)
639 #define LOG_UNIT_MESSAGE(unit, fmt, ...) "MESSAGE=%s: " fmt, (unit)->id, ##__VA_ARGS__
640 #define LOG_UNIT_ID(unit) (unit)->manager->unit_log_format_string, (unit)->id