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;
38 #include "socket-util.h"
41 #include "condition.h"
43 #include "unit-name.h"
44 #include "failure-action.h"
46 enum UnitActiveState {
53 _UNIT_ACTIVE_STATE_MAX,
54 _UNIT_ACTIVE_STATE_INVALID = -1
57 typedef enum KillOperation {
63 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) {
64 return t == UNIT_ACTIVE || t == UNIT_RELOADING;
67 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) {
68 return t == UNIT_ACTIVE || t == UNIT_ACTIVATING || t == UNIT_RELOADING;
71 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) {
72 return t == UNIT_INACTIVE || t == UNIT_FAILED || t == UNIT_DEACTIVATING;
75 static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t) {
76 return t == UNIT_INACTIVE || t == UNIT_FAILED;
83 /* Keeps tracks of references to a unit. This is useful so
84 * that we can merge two units if necessary and correct all
85 * references to them */
88 LIST_FIELDS(UnitRef, refs);
95 UnitLoadState load_state;
98 char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
102 Set *dependencies[_UNIT_DEPENDENCY_MAX];
104 char **requires_mounts_for;
107 char **documentation;
109 char *fragment_path; /* if loaded from a config file this is the primary path to it */
110 char *source_path; /* if converted, the source file */
112 usec_t fragment_mtime;
116 /* If there is something to do with this unit, then this is the installed job for it */
119 /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
122 /* Job timeout and action to take */
124 FailureAction job_timeout_action;
125 char *job_timeout_reboot_arg;
127 /* References to this */
128 LIST_HEAD(UnitRef, refs);
130 /* Conditions to check */
131 LIST_HEAD(Condition, conditions);
132 LIST_HEAD(Condition, asserts);
134 dual_timestamp condition_timestamp;
135 dual_timestamp assert_timestamp;
137 dual_timestamp inactive_exit_timestamp;
138 dual_timestamp active_enter_timestamp;
139 dual_timestamp active_exit_timestamp;
140 dual_timestamp inactive_enter_timestamp;
145 LIST_FIELDS(Unit, units_by_type);
147 /* All units which have requires_mounts_for set */
148 LIST_FIELDS(Unit, has_requires_mounts_for);
151 LIST_FIELDS(Unit, load_queue);
154 LIST_FIELDS(Unit, dbus_queue);
157 LIST_FIELDS(Unit, cleanup_queue);
160 LIST_FIELDS(Unit, gc_queue);
162 /* CGroup realize members queue */
163 LIST_FIELDS(Unit, cgroup_queue);
165 /* PIDs we keep an eye on. Note that a unit might have many
166 * more, but these are the ones we care enough about to
167 * process SIGCHLD for */
170 /* Used during GC sweeps */
173 /* When deserializing, temporarily store the job type for this
174 * unit here, if there was a job scheduled.
175 * Only for deserializing from a legacy version. New style uses full
176 * serialized jobs. */
177 int deserialized_job; /* This is actually of type JobType */
179 /* Error code when we didn't manage to load the unit (negative) */
182 /* Cached unit file state and preset */
183 UnitFileState unit_file_state;
184 int unit_file_preset;
186 /* Counterparts in the cgroup filesystem */
188 CGroupControllerMask cgroup_realized_mask;
189 CGroupControllerMask cgroup_subtree_mask;
190 CGroupControllerMask cgroup_members_mask;
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;
240 struct UnitStatusMessageFormats {
241 const char *starting_stopping[2];
242 const char *finished_start_job[_JOB_RESULT_MAX];
243 const char *finished_stop_job[_JOB_RESULT_MAX];
246 typedef enum UnitSetPropertiesMode {
250 } UnitSetPropertiesMode;
256 #include "snapshot.h"
259 #include "automount.h"
267 /* How much memory does an object of this unit type need */
270 /* If greater than 0, the offset into the object where
271 * ExecContext is found, if the unit type has that */
272 size_t exec_context_offset;
274 /* If greater than 0, the offset into the object where
275 * CGroupContext is found, if the unit type has that */
276 size_t cgroup_context_offset;
278 /* If greater than 0, the offset into the object where
279 * KillContext is found, if the unit type has that */
280 size_t kill_context_offset;
282 /* If greater than 0, the offset into the object where the
283 * pointer to ExecRuntime is found, if the unit type has
285 size_t exec_runtime_offset;
287 /* The name of the configuration file section with the private settings of this unit */
288 const char *private_section;
290 /* Config file sections this unit type understands, separated
292 const char *sections;
294 /* This should reset all type-specific variables. This should
295 * not allocate memory, and is called with zero-initialized
296 * data. It should hence only initialize variables that need
298 void (*init)(Unit *u);
300 /* This should free all type-specific variables. It should be
302 void (*done)(Unit *u);
304 /* Actually load data from disk. This may fail, and should set
305 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
306 * UNIT_STUB if no configuration could be found. */
307 int (*load)(Unit *u);
309 /* If a lot of units got created via enumerate(), this is
310 * where to actually set the state and call unit_notify(). */
311 int (*coldplug)(Unit *u);
313 void (*dump)(Unit *u, FILE *f, const char *prefix);
315 int (*start)(Unit *u);
316 int (*stop)(Unit *u);
317 int (*reload)(Unit *u);
319 int (*kill)(Unit *u, KillWho w, int signo, sd_bus_error *error);
321 bool (*can_reload)(Unit *u);
323 /* Write all data that cannot be restored from other sources
324 * away using unit_serialize_item() */
325 int (*serialize)(Unit *u, FILE *f, FDSet *fds);
327 /* Restore one item from the serialization */
328 int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
330 /* Try to match up fds with what we need for this unit */
331 int (*distribute_fds)(Unit *u, FDSet *fds);
333 /* Boils down the more complex internal state of this unit to
334 * a simpler one that the engine can understand */
335 UnitActiveState (*active_state)(Unit *u);
337 /* Returns the substate specific to this unit type as
338 * string. This is purely information so that we can give the
339 * user a more fine grained explanation in which actual state a
341 const char* (*sub_state_to_string)(Unit *u);
343 /* Return true when there is reason to keep this entry around
344 * even nothing references it and it isn't active in any
346 bool (*check_gc)(Unit *u);
348 /* Return true when this unit is suitable for snapshotting */
349 bool (*check_snapshot)(Unit *u);
351 /* Invoked on every child that died */
352 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
354 /* Reset failed state if we are in failed state */
355 void (*reset_failed)(Unit *u);
357 /* Called whenever any of the cgroups this unit watches for
359 void (*notify_cgroup_empty)(Unit *u);
361 /* Called whenever a process of this unit sends us a message */
362 void (*notify_message)(Unit *u, pid_t pid, char **tags);
364 /* Called whenever a name this Unit registered for comes or
366 void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
368 /* Called for each property that is being set */
369 int (*bus_set_property)(Unit *u, const char *name, sd_bus_message *message, UnitSetPropertiesMode mode, sd_bus_error *error);
371 /* Called after at least one property got changed to apply the necessary change */
372 int (*bus_commit_properties)(Unit *u);
374 /* Return the unit this unit is following */
375 Unit *(*following)(Unit *u);
377 /* Return the set of units that are following each other */
378 int (*following_set)(Unit *u, Set **s);
380 /* Invoked each time a unit this unit is triggering changes
381 * state or gains/loses a job */
382 void (*trigger_notify)(Unit *u, Unit *trigger);
384 /* Called whenever CLOCK_REALTIME made a jump */
385 void (*time_change)(Unit *u);
387 int (*get_timeout)(Unit *u, uint64_t *timeout);
389 /* This is called for each unit type and should be used to
390 * enumerate existing devices and load them. However,
391 * everything that is loaded here should still stay in
392 * inactive state. It is the job of the coldplug() call above
393 * to put the units into the initial state. */
394 int (*enumerate)(Manager *m);
396 /* Type specific cleanups. */
397 void (*shutdown)(Manager *m);
399 /* If this function is set and return false all jobs for units
400 * of this type will immediately fail. */
401 bool (*supported)(Manager *m);
403 /* The interface name */
404 const char *bus_interface;
407 const sd_bus_vtable *bus_vtable;
409 /* The strings to print in status messages */
410 UnitStatusMessageFormats status_message_formats;
412 /* Can units of this type have multiple names? */
415 /* Instances make no sense for this type */
418 /* Exclude from automatic gc */
421 /* True if transient units of this type are OK */
422 bool can_transient:1;
425 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
427 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
429 /* For casting a unit into the various unit types */
430 #define DEFINE_CAST(UPPERCASE, MixedCase) \
431 static inline MixedCase* UPPERCASE(Unit *u) { \
432 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
435 return (MixedCase*) u; \
438 /* For casting the various unit types into a unit */
439 #define UNIT(u) (&(u)->meta)
441 #define UNIT_TRIGGER(u) ((Unit*) set_first((u)->dependencies[UNIT_TRIGGERS]))
443 DEFINE_CAST(SERVICE, Service);
444 DEFINE_CAST(SOCKET, Socket);
445 DEFINE_CAST(BUSNAME, BusName);
446 DEFINE_CAST(TARGET, Target);
447 DEFINE_CAST(SNAPSHOT, Snapshot);
448 DEFINE_CAST(DEVICE, Device);
449 DEFINE_CAST(MOUNT, Mount);
450 DEFINE_CAST(AUTOMOUNT, Automount);
451 DEFINE_CAST(SWAP, Swap);
452 DEFINE_CAST(TIMER, Timer);
453 DEFINE_CAST(PATH, Path);
454 DEFINE_CAST(SLICE, Slice);
455 DEFINE_CAST(SCOPE, Scope);
457 Unit *unit_new(Manager *m, size_t size);
458 void unit_free(Unit *u);
460 int unit_add_name(Unit *u, const char *name);
462 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
463 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
465 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
466 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
468 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
469 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
471 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
473 int unit_choose_id(Unit *u, const char *name);
474 int unit_set_description(Unit *u, const char *description);
476 bool unit_check_gc(Unit *u);
478 void unit_add_to_load_queue(Unit *u);
479 void unit_add_to_dbus_queue(Unit *u);
480 void unit_add_to_cleanup_queue(Unit *u);
481 void unit_add_to_gc_queue(Unit *u);
483 int unit_merge(Unit *u, Unit *other);
484 int unit_merge_by_name(Unit *u, const char *other);
486 Unit *unit_follow_merge(Unit *u) _pure_;
488 int unit_load_fragment_and_dropin(Unit *u);
489 int unit_load_fragment_and_dropin_optional(Unit *u);
490 int unit_load(Unit *unit);
492 int unit_add_default_slice(Unit *u, CGroupContext *c);
494 const char *unit_description(Unit *u) _pure_;
496 bool unit_has_name(Unit *u, const char *name);
498 UnitActiveState unit_active_state(Unit *u);
500 const char* unit_sub_state_to_string(Unit *u);
502 void unit_dump(Unit *u, FILE *f, const char *prefix);
504 bool unit_can_reload(Unit *u) _pure_;
505 bool unit_can_start(Unit *u) _pure_;
506 bool unit_can_isolate(Unit *u) _pure_;
508 int unit_start(Unit *u);
509 int unit_stop(Unit *u);
510 int unit_reload(Unit *u);
512 int unit_kill(Unit *u, KillWho w, int signo, sd_bus_error *error);
513 int unit_kill_common(Unit *u, KillWho who, int signo, pid_t main_pid, pid_t control_pid, sd_bus_error *error);
515 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
517 int unit_watch_pid(Unit *u, pid_t pid);
518 void unit_unwatch_pid(Unit *u, pid_t pid);
519 int unit_watch_all_pids(Unit *u);
520 void unit_unwatch_all_pids(Unit *u);
522 void unit_tidy_watch_pids(Unit *u, pid_t except1, pid_t except2);
524 int unit_watch_bus_name(Unit *u, const char *name);
525 void unit_unwatch_bus_name(Unit *u, const char *name);
527 bool unit_job_is_applicable(Unit *u, JobType j);
529 int set_unit_path(const char *p);
531 char *unit_dbus_path(Unit *u);
533 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
535 bool unit_can_serialize(Unit *u) _pure_;
536 int unit_serialize(Unit *u, FILE *f, FDSet *fds, bool serialize_jobs);
537 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_(4,5);
538 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
539 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
541 int unit_add_node_link(Unit *u, const char *what, bool wants);
543 int unit_coldplug(Unit *u);
545 void unit_status_printf(Unit *u, const char *status, const char *unit_status_msg_format) _printf_(3, 0);
547 bool unit_need_daemon_reload(Unit *u);
549 void unit_reset_failed(Unit *u);
551 Unit *unit_following(Unit *u);
552 int unit_following_set(Unit *u, Set **s);
554 const char *unit_slice_name(Unit *u);
556 bool unit_stop_pending(Unit *u) _pure_;
557 bool unit_inactive_or_pending(Unit *u) _pure_;
558 bool unit_active_or_pending(Unit *u);
560 int unit_add_default_target_dependency(Unit *u, Unit *target);
562 char *unit_default_cgroup_path(Unit *u);
564 void unit_start_on_failure(Unit *u);
565 void unit_trigger_notify(Unit *u);
567 UnitFileState unit_get_unit_file_state(Unit *u);
568 int unit_get_unit_file_preset(Unit *u);
570 Unit* unit_ref_set(UnitRef *ref, Unit *u);
571 void unit_ref_unset(UnitRef *ref);
573 #define UNIT_DEREF(ref) ((ref).unit)
574 #define UNIT_ISSET(ref) (!!(ref).unit)
576 int unit_patch_contexts(Unit *u);
578 ExecContext *unit_get_exec_context(Unit *u) _pure_;
579 KillContext *unit_get_kill_context(Unit *u) _pure_;
580 CGroupContext *unit_get_cgroup_context(Unit *u) _pure_;
582 ExecRuntime *unit_get_exec_runtime(Unit *u) _pure_;
584 int unit_setup_exec_runtime(Unit *u);
586 int unit_write_drop_in(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *data);
587 int unit_write_drop_in_format(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *format, ...) _printf_(4,5);
589 int unit_write_drop_in_private(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *data);
590 int unit_write_drop_in_private_format(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *format, ...) _printf_(4,5);
592 int unit_remove_drop_in(Unit *u, UnitSetPropertiesMode mode, const char *name);
594 int unit_kill_context(Unit *u, KillContext *c, KillOperation k, pid_t main_pid, pid_t control_pid, bool main_pid_alien);
596 int unit_make_transient(Unit *u);
598 int unit_require_mounts_for(Unit *u, const char *path);
600 const char *unit_active_state_to_string(UnitActiveState i) _const_;
601 UnitActiveState unit_active_state_from_string(const char *s) _pure_;
603 /* Macros which append UNIT= or USER_UNIT= to the message */
605 #define log_unit_full_errno(unit, level, error, ...) log_object_internal(level, error, __FILE__, __LINE__, __func__, getpid() == 1 ? "UNIT=" : "USER_UNIT=", unit, __VA_ARGS__)
606 #define log_unit_full(unit, level, ...) log_unit_full_errno(unit, level, 0, __VA_ARGS__)
608 #define log_unit_debug(unit, ...) log_unit_full(unit, LOG_DEBUG, __VA_ARGS__)
609 #define log_unit_info(unit, ...) log_unit_full(unit, LOG_INFO, __VA_ARGS__)
610 #define log_unit_notice(unit, ...) log_unit_full(unit, LOG_NOTICE, __VA_ARGS__)
611 #define log_unit_warning(unit, ...) log_unit_full(unit, LOG_WARNING, __VA_ARGS__)
612 #define log_unit_error(unit, ...) log_unit_full(unit, LOG_ERR, __VA_ARGS__)
614 #define log_unit_debug_errno(unit, error, ...) log_unit_full_errno(unit, LOG_DEBUG, error, __VA_ARGS__)
615 #define log_unit_info_errno(unit, error, ...) log_unit_full_errno(unit, LOG_INFO, error, __VA_ARGS__)
616 #define log_unit_notice_errno(unit, error, ...) log_unit_full_errno(unit, LOG_NOTICE, error, __VA_ARGS__)
617 #define log_unit_warning_errno(unit, error, ...) log_unit_full_errno(unit, LOG_WARNING, error, __VA_ARGS__)
618 #define log_unit_error_errno(unit, error, ...) log_unit_full_errno(unit, LOG_ERR, error, __VA_ARGS__)
620 #define log_unit_struct(unit, level, ...) log_struct(level, getpid() == 1 ? "UNIT=%s" : "USER_UNIT=%s", unit, __VA_ARGS__)
621 #define log_unit_struct_errno(unit, level, error, ...) log_struct_errno(level, error, getpid() == 1 ? "UNIT=%s" : "USER_UNIT=%s", unit, __VA_ARGS__)