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 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) {
58 return t == UNIT_ACTIVE || t == UNIT_RELOADING;
61 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) {
62 return t == UNIT_ACTIVE || t == UNIT_ACTIVATING || t == UNIT_RELOADING;
65 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) {
66 return t == UNIT_INACTIVE || t == UNIT_FAILED || t == UNIT_DEACTIVATING;
69 static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t) {
70 return t == UNIT_INACTIVE || t == UNIT_FAILED;
77 /* Keeps tracks of references to a unit. This is useful so
78 * that we can merge two units if necessary and correct all
79 * references to them */
82 LIST_FIELDS(UnitRef, refs);
89 UnitLoadState load_state;
92 char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
96 Set *dependencies[_UNIT_DEPENDENCY_MAX];
98 char **requires_mounts_for;
101 char **documentation;
103 char *fragment_path; /* if loaded from a config file this is the primary path to it */
104 char *source_path; /* if converted, the source file */
106 usec_t fragment_mtime;
110 /* If there is something to do with this unit, then this is the installed job for it */
113 /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
116 /* Job timeout and action to take */
118 FailureAction job_timeout_action;
119 char *job_timeout_reboot_arg;
121 /* References to this */
122 LIST_HEAD(UnitRef, refs);
124 /* Conditions to check */
125 LIST_HEAD(Condition, conditions);
127 dual_timestamp condition_timestamp;
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 /* PIDs we keep an eye on. Note that a unit might have many
158 * more, but these are the ones we care enough about to
159 * process SIGCHLD for */
162 /* Used during GC sweeps */
165 /* When deserializing, temporarily store the job type for this
166 * unit here, if there was a job scheduled.
167 * Only for deserializing from a legacy version. New style uses full
168 * serialized jobs. */
169 int deserialized_job; /* This is actually of type JobType */
171 /* Error code when we didn't manage to load the unit (negative) */
174 /* Cached unit file state */
175 UnitFileState unit_file_state;
177 /* Counterparts in the cgroup filesystem */
179 CGroupControllerMask cgroup_realized_mask;
180 CGroupControllerMask cgroup_subtree_mask;
181 CGroupControllerMask cgroup_members_mask;
183 /* How to start OnFailure units */
184 JobMode on_failure_job_mode;
186 /* Garbage collect us we nobody wants or requires us anymore */
187 bool stop_when_unneeded;
189 /* Create default dependencies */
190 bool default_dependencies;
192 /* Refuse manual starting, allow starting only indirectly via dependency. */
193 bool refuse_manual_start;
195 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
196 bool refuse_manual_stop;
198 /* Allow isolation requests */
201 /* Ignore this unit when isolating */
202 bool ignore_on_isolate;
204 /* Ignore this unit when snapshotting */
205 bool ignore_on_snapshot;
207 /* Did the last condition check succeed? */
208 bool condition_result;
210 /* Is this a transient unit? */
213 bool in_load_queue:1;
214 bool in_dbus_queue:1;
215 bool in_cleanup_queue:1;
217 bool in_cgroup_queue:1;
219 bool sent_dbus_new_signal:1;
225 bool cgroup_realized:1;
226 bool cgroup_members_mask_valid:1;
227 bool cgroup_subtree_mask_valid:1;
230 struct UnitStatusMessageFormats {
231 const char *starting_stopping[2];
232 const char *finished_start_job[_JOB_RESULT_MAX];
233 const char *finished_stop_job[_JOB_RESULT_MAX];
236 typedef enum UnitSetPropertiesMode {
240 } UnitSetPropertiesMode;
246 #include "snapshot.h"
249 #include "automount.h"
257 /* How much memory does an object of this unit type need */
260 /* If greater than 0, the offset into the object where
261 * ExecContext is found, if the unit type has that */
262 size_t exec_context_offset;
264 /* If greater than 0, the offset into the object where
265 * CGroupContext is found, if the unit type has that */
266 size_t cgroup_context_offset;
268 /* If greater than 0, the offset into the object where
269 * KillContext is found, if the unit type has that */
270 size_t kill_context_offset;
272 /* If greater than 0, the offset into the object where the
273 * pointer to ExecRuntime is found, if the unit type has
275 size_t exec_runtime_offset;
277 /* The name of the configuration file section with the private settings of this unit*/
278 const char *private_section;
280 /* Config file sections this unit type understands, separated
282 const char *sections;
284 /* This should reset all type-specific variables. This should
285 * not allocate memory, and is called with zero-initialized
286 * data. It should hence only initialize variables that need
288 void (*init)(Unit *u);
290 /* This should free all type-specific variables. It should be
292 void (*done)(Unit *u);
294 /* Actually load data from disk. This may fail, and should set
295 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
296 * UNIT_STUB if no configuration could be found. */
297 int (*load)(Unit *u);
299 /* If a lot of units got created via enumerate(), this is
300 * where to actually set the state and call unit_notify(). */
301 int (*coldplug)(Unit *u);
303 void (*dump)(Unit *u, FILE *f, const char *prefix);
305 int (*start)(Unit *u);
306 int (*stop)(Unit *u);
307 int (*reload)(Unit *u);
309 int (*kill)(Unit *u, KillWho w, int signo, sd_bus_error *error);
311 bool (*can_reload)(Unit *u);
313 /* Write all data that cannot be restored from other sources
314 * away using unit_serialize_item() */
315 int (*serialize)(Unit *u, FILE *f, FDSet *fds);
317 /* Restore one item from the serialization */
318 int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
320 /* Try to match up fds with what we need for this unit */
321 int (*distribute_fds)(Unit *u, FDSet *fds);
323 /* Boils down the more complex internal state of this unit to
324 * a simpler one that the engine can understand */
325 UnitActiveState (*active_state)(Unit *u);
327 /* Returns the substate specific to this unit type as
328 * string. This is purely information so that we can give the
329 * user a more fine grained explanation in which actual state a
331 const char* (*sub_state_to_string)(Unit *u);
333 /* Return true when there is reason to keep this entry around
334 * even nothing references it and it isn't active in any
336 bool (*check_gc)(Unit *u);
338 /* Return true when this unit is suitable for snapshotting */
339 bool (*check_snapshot)(Unit *u);
341 /* Invoked on every child that died */
342 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
344 /* Reset failed state if we are in failed state */
345 void (*reset_failed)(Unit *u);
347 /* Called whenever any of the cgroups this unit watches for
349 void (*notify_cgroup_empty)(Unit *u);
351 /* Called whenever a process of this unit sends us a message */
352 void (*notify_message)(Unit *u, pid_t pid, char **tags);
354 /* Called whenever a name this Unit registered for comes or
356 void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
358 /* Called for each property that is being set */
359 int (*bus_set_property)(Unit *u, const char *name, sd_bus_message *message, UnitSetPropertiesMode mode, sd_bus_error *error);
361 /* Called after at least one property got changed to apply the necessary change */
362 int (*bus_commit_properties)(Unit *u);
364 /* Return the unit this unit is following */
365 Unit *(*following)(Unit *u);
367 /* Return the set of units that are following each other */
368 int (*following_set)(Unit *u, Set **s);
370 /* Invoked each time a unit this unit is triggering changes
371 * state or gains/loses a job */
372 void (*trigger_notify)(Unit *u, Unit *trigger);
374 /* Called whenever CLOCK_REALTIME made a jump */
375 void (*time_change)(Unit *u);
377 int (*get_timeout)(Unit *u, uint64_t *timeout);
379 /* This is called for each unit type and should be used to
380 * enumerate existing devices and load them. However,
381 * everything that is loaded here should still stay in
382 * inactive state. It is the job of the coldplug() call above
383 * to put the units into the initial state. */
384 int (*enumerate)(Manager *m);
386 /* Type specific cleanups. */
387 void (*shutdown)(Manager *m);
389 /* The interface name */
390 const char *bus_interface;
393 const sd_bus_vtable *bus_vtable;
395 /* The strings to print in status messages */
396 UnitStatusMessageFormats status_message_formats;
398 /* Can units of this type have multiple names? */
401 /* Instances make no sense for this type */
404 /* Exclude from automatic gc */
407 /* True if transient units of this type are OK */
408 bool can_transient:1;
411 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
413 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
415 /* For casting a unit into the various unit types */
416 #define DEFINE_CAST(UPPERCASE, MixedCase) \
417 static inline MixedCase* UPPERCASE(Unit *u) { \
418 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
421 return (MixedCase*) u; \
424 /* For casting the various unit types into a unit */
425 #define UNIT(u) (&(u)->meta)
427 #define UNIT_TRIGGER(u) ((Unit*) set_first((u)->dependencies[UNIT_TRIGGERS]))
429 DEFINE_CAST(SERVICE, Service);
430 DEFINE_CAST(SOCKET, Socket);
431 DEFINE_CAST(BUSNAME, BusName);
432 DEFINE_CAST(TARGET, Target);
433 DEFINE_CAST(SNAPSHOT, Snapshot);
434 DEFINE_CAST(DEVICE, Device);
435 DEFINE_CAST(MOUNT, Mount);
436 DEFINE_CAST(AUTOMOUNT, Automount);
437 DEFINE_CAST(SWAP, Swap);
438 DEFINE_CAST(TIMER, Timer);
439 DEFINE_CAST(PATH, Path);
440 DEFINE_CAST(SLICE, Slice);
441 DEFINE_CAST(SCOPE, Scope);
443 Unit *unit_new(Manager *m, size_t size);
444 void unit_free(Unit *u);
446 int unit_add_name(Unit *u, const char *name);
448 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
449 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
451 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
452 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
454 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
455 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
457 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
459 int unit_choose_id(Unit *u, const char *name);
460 int unit_set_description(Unit *u, const char *description);
462 bool unit_check_gc(Unit *u);
464 void unit_add_to_load_queue(Unit *u);
465 void unit_add_to_dbus_queue(Unit *u);
466 void unit_add_to_cleanup_queue(Unit *u);
467 void unit_add_to_gc_queue(Unit *u);
469 int unit_merge(Unit *u, Unit *other);
470 int unit_merge_by_name(Unit *u, const char *other);
472 Unit *unit_follow_merge(Unit *u) _pure_;
474 int unit_load_fragment_and_dropin(Unit *u);
475 int unit_load_fragment_and_dropin_optional(Unit *u);
476 int unit_load(Unit *unit);
478 int unit_add_default_slice(Unit *u, CGroupContext *c);
480 const char *unit_description(Unit *u) _pure_;
482 bool unit_has_name(Unit *u, const char *name);
484 UnitActiveState unit_active_state(Unit *u);
486 const char* unit_sub_state_to_string(Unit *u);
488 void unit_dump(Unit *u, FILE *f, const char *prefix);
490 bool unit_can_reload(Unit *u) _pure_;
491 bool unit_can_start(Unit *u) _pure_;
492 bool unit_can_isolate(Unit *u) _pure_;
494 int unit_start(Unit *u);
495 int unit_stop(Unit *u);
496 int unit_reload(Unit *u);
498 int unit_kill(Unit *u, KillWho w, int signo, sd_bus_error *error);
499 int unit_kill_common(Unit *u, KillWho who, int signo, pid_t main_pid, pid_t control_pid, sd_bus_error *error);
501 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
503 int unit_watch_pid(Unit *u, pid_t pid);
504 void unit_unwatch_pid(Unit *u, pid_t pid);
505 int unit_watch_all_pids(Unit *u);
506 void unit_unwatch_all_pids(Unit *u);
508 void unit_tidy_watch_pids(Unit *u, pid_t except1, pid_t except2);
510 int unit_watch_bus_name(Unit *u, const char *name);
511 void unit_unwatch_bus_name(Unit *u, const char *name);
513 bool unit_job_is_applicable(Unit *u, JobType j);
515 int set_unit_path(const char *p);
517 char *unit_dbus_path(Unit *u);
519 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
521 bool unit_can_serialize(Unit *u) _pure_;
522 int unit_serialize(Unit *u, FILE *f, FDSet *fds, bool serialize_jobs);
523 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_(4,5);
524 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
525 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
527 int unit_add_node_link(Unit *u, const char *what, bool wants);
529 int unit_coldplug(Unit *u);
531 void unit_status_printf(Unit *u, const char *status, const char *unit_status_msg_format) _printf_(3, 0);
533 bool unit_need_daemon_reload(Unit *u);
535 void unit_reset_failed(Unit *u);
537 Unit *unit_following(Unit *u);
538 int unit_following_set(Unit *u, Set **s);
540 const char *unit_slice_name(Unit *u);
542 bool unit_stop_pending(Unit *u) _pure_;
543 bool unit_inactive_or_pending(Unit *u) _pure_;
544 bool unit_active_or_pending(Unit *u);
546 int unit_add_default_target_dependency(Unit *u, Unit *target);
548 char *unit_default_cgroup_path(Unit *u);
550 void unit_start_on_failure(Unit *u);
551 void unit_trigger_notify(Unit *u);
553 UnitFileState unit_get_unit_file_state(Unit *u);
555 Unit* unit_ref_set(UnitRef *ref, Unit *u);
556 void unit_ref_unset(UnitRef *ref);
558 #define UNIT_DEREF(ref) ((ref).unit)
559 #define UNIT_ISSET(ref) (!!(ref).unit)
561 int unit_patch_contexts(Unit *u);
563 ExecContext *unit_get_exec_context(Unit *u) _pure_;
564 KillContext *unit_get_kill_context(Unit *u) _pure_;
565 CGroupContext *unit_get_cgroup_context(Unit *u) _pure_;
567 ExecRuntime *unit_get_exec_runtime(Unit *u) _pure_;
569 int unit_setup_exec_runtime(Unit *u);
571 int unit_write_drop_in(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *data);
572 int unit_write_drop_in_format(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *format, ...) _printf_(4,5);
574 int unit_write_drop_in_private(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *data);
575 int unit_write_drop_in_private_format(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *format, ...) _printf_(4,5);
577 int unit_remove_drop_in(Unit *u, UnitSetPropertiesMode mode, const char *name);
579 int unit_kill_context(Unit *u, KillContext *c, bool sigkill, pid_t main_pid, pid_t control_pid, bool main_pid_alien);
581 int unit_make_transient(Unit *u);
583 int unit_require_mounts_for(Unit *u, const char *path);
585 const char *unit_active_state_to_string(UnitActiveState i) _const_;
586 UnitActiveState unit_active_state_from_string(const char *s) _pure_;
588 /* Macros which append UNIT= or USER_UNIT= to the message */
590 #define log_full_unit(level, unit, ...) log_meta_object(level, __FILE__, __LINE__, __func__, getpid() == 1 ? "UNIT=" : "USER_UNIT=", unit, __VA_ARGS__)
591 #define log_debug_unit(unit, ...) log_full_unit(LOG_DEBUG, unit, __VA_ARGS__)
592 #define log_info_unit(unit, ...) log_full_unit(LOG_INFO, unit, __VA_ARGS__)
593 #define log_notice_unit(unit, ...) log_full_unit(LOG_NOTICE, unit, __VA_ARGS__)
594 #define log_warning_unit(unit, ...) log_full_unit(LOG_WARNING, unit, __VA_ARGS__)
595 #define log_error_unit(unit, ...) log_full_unit(LOG_ERR, unit, __VA_ARGS__)
597 #define log_struct_unit(level, unit, ...) log_struct(level, getpid() == 1 ? "UNIT=%s" : "USER_UNIT=%s", unit, __VA_ARGS__)