1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
7 This file is part of systemd.
9 Copyright 2010 Lennart Poettering
11 systemd is free software; you can redistribute it and/or modify it
12 under the terms of the GNU Lesser General Public License as published by
13 the Free Software Foundation; either version 2.1 of the License, or
14 (at your option) any later version.
16 systemd is distributed in the hope that it will be useful, but
17 WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 Lesser General Public License for more details.
21 You should have received a copy of the GNU Lesser General Public License
22 along with systemd; If not, see <http://www.gnu.org/licenses/>.
28 typedef struct Unit Unit;
29 typedef struct UnitVTable UnitVTable;
30 typedef enum UnitType UnitType;
31 typedef enum UnitLoadState UnitLoadState;
32 typedef enum UnitActiveState UnitActiveState;
33 typedef enum UnitDependency UnitDependency;
34 typedef struct UnitRef UnitRef;
35 typedef struct UnitStatusMessageFormats UnitStatusMessageFormats;
40 #include "socket-util.h"
42 #include "condition.h"
57 _UNIT_TYPE_INVALID = -1
67 _UNIT_LOAD_STATE_INVALID = -1
70 enum UnitActiveState {
77 _UNIT_ACTIVE_STATE_MAX,
78 _UNIT_ACTIVE_STATE_INVALID = -1
81 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) {
82 return t == UNIT_ACTIVE || t == UNIT_RELOADING;
85 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) {
86 return t == UNIT_ACTIVE || t == UNIT_ACTIVATING || t == UNIT_RELOADING;
89 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) {
90 return t == UNIT_INACTIVE || t == UNIT_FAILED || t == UNIT_DEACTIVATING;
93 static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t) {
94 return t == UNIT_INACTIVE || t == UNIT_FAILED;
98 /* Positive dependencies */
100 UNIT_REQUIRES_OVERRIDABLE,
102 UNIT_REQUISITE_OVERRIDABLE,
106 /* Inverse of the above */
107 UNIT_REQUIRED_BY, /* inverse of 'requires' and 'requisite' is 'required_by' */
108 UNIT_REQUIRED_BY_OVERRIDABLE, /* inverse of 'requires_overridable' and 'requisite_overridable' is 'soft_required_by' */
109 UNIT_WANTED_BY, /* inverse of 'wants' */
110 UNIT_BOUND_BY, /* inverse of 'bind_to' */
112 /* Negative dependencies */
113 UNIT_CONFLICTS, /* inverse of 'conflicts' is 'conflicted_by' */
117 UNIT_BEFORE, /* inverse of 'before' is 'after' and vice versa */
123 /* Triggers (i.e. a socket triggers a service) */
127 /* Propagate reloads */
128 UNIT_PROPAGATE_RELOAD_TO,
129 UNIT_PROPAGATE_RELOAD_FROM,
131 /* Reference information for GC logic */
132 UNIT_REFERENCES, /* Inverse of 'references' is 'referenced_by' */
135 _UNIT_DEPENDENCY_MAX,
136 _UNIT_DEPENDENCY_INVALID = -1
142 #include "cgroup-attr.h"
148 UnitLoadState load_state;
151 char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
155 Set *dependencies[_UNIT_DEPENDENCY_MAX];
157 char **requires_mounts_for;
160 char **documentation;
162 char *fragment_path; /* if loaded from a config file this is the primary path to it */
163 usec_t fragment_mtime;
165 /* If there is something to do with this unit, then this is the installed job for it */
168 /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
173 /* References to this */
174 LIST_HEAD(UnitRef, refs);
176 /* Conditions to check */
177 LIST_HEAD(Condition, conditions);
179 dual_timestamp condition_timestamp;
181 dual_timestamp inactive_exit_timestamp;
182 dual_timestamp active_enter_timestamp;
183 dual_timestamp active_exit_timestamp;
184 dual_timestamp inactive_enter_timestamp;
186 /* Counterparts in the cgroup filesystem */
187 CGroupBonding *cgroup_bondings;
188 CGroupAttribute *cgroup_attributes;
191 LIST_FIELDS(Unit, units_by_type);
193 /* All units which have requires_mounts_for set */
194 LIST_FIELDS(Unit, has_requires_mounts_for);
197 LIST_FIELDS(Unit, load_queue);
200 LIST_FIELDS(Unit, dbus_queue);
203 LIST_FIELDS(Unit, cleanup_queue);
206 LIST_FIELDS(Unit, gc_queue);
208 /* Used during GC sweeps */
211 /* When deserializing, temporarily store the job type for this
212 * unit here, if there was a job scheduled.
213 * Only for deserializing from a legacy version. New style uses full
214 * serialized jobs. */
215 int deserialized_job; /* This is actually of type JobType */
217 /* Error code when we didn't manage to load the unit (negative) */
220 /* Cached unit file state */
221 UnitFileState unit_file_state;
223 /* Garbage collect us we nobody wants or requires us anymore */
224 bool stop_when_unneeded;
226 /* Create default dependencies */
227 bool default_dependencies;
229 /* Refuse manual starting, allow starting only indirectly via dependency. */
230 bool refuse_manual_start;
232 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
233 bool refuse_manual_stop;
235 /* Allow isolation requests */
238 /* Isolate OnFailure unit */
239 bool on_failure_isolate;
241 /* Ignore this unit when isolating */
242 bool ignore_on_isolate;
244 /* Ignore this unit when snapshotting */
245 bool ignore_on_snapshot;
247 /* Did the last condition check suceed? */
248 bool condition_result;
250 bool in_load_queue:1;
251 bool in_dbus_queue:1;
252 bool in_cleanup_queue:1;
255 bool sent_dbus_new_signal:1;
263 /* Keeps tracks of references to a unit. This is useful so
264 * that we can merge two units if necessary and correct all
265 * references to them */
268 LIST_FIELDS(UnitRef, refs);
271 struct UnitStatusMessageFormats {
272 const char *starting_stopping[2];
273 const char *finished_start_job[_JOB_RESULT_MAX];
274 const char *finished_stop_job[_JOB_RESULT_MAX];
283 #include "automount.h"
284 #include "snapshot.h"
291 /* How much memory does an object of this unit type need */
294 /* Config file sections this unit type understands, separated
296 const char *sections;
298 /* This should reset all type-specific variables. This should
299 * not allocate memory, and is called with zero-initialized
300 * data. It should hence only initialize variables that need
302 void (*init)(Unit *u);
304 /* This should free all type-specific variables. It should be
306 void (*done)(Unit *u);
308 /* Actually load data from disk. This may fail, and should set
309 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
310 * UNIT_STUB if no configuration could be found. */
311 int (*load)(Unit *u);
313 /* If a a lot of units got created via enumerate(), this is
314 * where to actually set the state and call unit_notify(). */
315 int (*coldplug)(Unit *u);
317 void (*dump)(Unit *u, FILE *f, const char *prefix);
319 int (*start)(Unit *u);
320 int (*stop)(Unit *u);
321 int (*reload)(Unit *u);
323 int (*kill)(Unit *u, KillWho w, KillMode m, int signo, DBusError *error);
325 bool (*can_reload)(Unit *u);
327 /* Write all data that cannot be restored from other sources
328 * away using unit_serialize_item() */
329 int (*serialize)(Unit *u, FILE *f, FDSet *fds);
331 /* Restore one item from the serialization */
332 int (*deserialize_item)(Unit *u, const char *key, const char *data, 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 /* Return true when this unit is suitable for snapshotting */
350 bool (*check_snapshot)(Unit *u);
352 void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
353 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
354 void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
356 /* Check whether unit needs a daemon reload */
357 bool (*need_daemon_reload)(Unit *u);
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 (*cgroup_notify_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);
369 /* Called whenever a name thus 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 whenever a bus PID lookup finishes */
374 void (*bus_query_pid_done)(Unit *u, const char *name, pid_t pid);
376 /* Called for each message received on the bus */
377 DBusHandlerResult (*bus_message_handler)(Unit *u, DBusConnection *c, DBusMessage *message);
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 /* This is called for each unit type and should be used to
386 * enumerate existing devices and load them. However,
387 * everything that is loaded here should still stay in
388 * inactive state. It is the job of the coldplug() call above
389 * to put the units into the initial state. */
390 int (*enumerate)(Manager *m);
392 /* Type specific cleanups. */
393 void (*shutdown)(Manager *m);
395 /* When sending out PropertiesChanged signal, which properties
396 * shall be invalidated? This is a NUL separated list of
397 * strings, to minimize relocations a little. */
398 const char *bus_invalidating_properties;
400 /* The interface name */
401 const char *bus_interface;
403 UnitStatusMessageFormats status_message_formats;
405 /* Can units of this type have multiple names? */
408 /* Instances make no sense for this type */
411 /* Exclude from automatic gc */
415 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
417 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
419 /* For casting a unit into the various unit types */
420 #define DEFINE_CAST(UPPERCASE, MixedCase) \
421 static inline MixedCase* UPPERCASE(Unit *u) { \
422 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
425 return (MixedCase*) u; \
428 /* For casting the various unit types into a unit */
429 #define UNIT(u) (&(u)->meta)
431 DEFINE_CAST(SOCKET, Socket);
432 DEFINE_CAST(TIMER, Timer);
433 DEFINE_CAST(SERVICE, Service);
434 DEFINE_CAST(TARGET, Target);
435 DEFINE_CAST(DEVICE, Device);
436 DEFINE_CAST(MOUNT, Mount);
437 DEFINE_CAST(AUTOMOUNT, Automount);
438 DEFINE_CAST(SNAPSHOT, Snapshot);
439 DEFINE_CAST(SWAP, Swap);
440 DEFINE_CAST(PATH, Path);
442 Unit *unit_new(Manager *m, size_t size);
443 void unit_free(Unit *u);
445 int unit_add_name(Unit *u, const char *name);
447 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
448 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
450 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
451 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
453 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
454 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
456 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
458 int unit_add_cgroup(Unit *u, CGroupBonding *b);
459 int unit_add_cgroup_from_text(Unit *u, const char *name);
460 int unit_add_default_cgroups(Unit *u);
461 CGroupBonding* unit_get_default_cgroup(Unit *u);
462 int unit_add_cgroup_attribute(Unit *u, const char *controller, const char *name, const char *value, CGroupAttributeMapCallback map_callback);
464 int unit_choose_id(Unit *u, const char *name);
465 int unit_set_description(Unit *u, const char *description);
467 bool unit_check_gc(Unit *u);
469 void unit_add_to_load_queue(Unit *u);
470 void unit_add_to_dbus_queue(Unit *u);
471 void unit_add_to_cleanup_queue(Unit *u);
472 void unit_add_to_gc_queue(Unit *u);
474 int unit_merge(Unit *u, Unit *other);
475 int unit_merge_by_name(Unit *u, const char *other);
477 Unit *unit_follow_merge(Unit *u);
479 int unit_load_fragment_and_dropin(Unit *u);
480 int unit_load_fragment_and_dropin_optional(Unit *u);
481 int unit_load(Unit *unit);
483 const char *unit_description(Unit *u);
485 bool unit_has_name(Unit *u, const char *name);
487 UnitActiveState unit_active_state(Unit *u);
489 const char* unit_sub_state_to_string(Unit *u);
491 void unit_dump(Unit *u, FILE *f, const char *prefix);
493 bool unit_can_reload(Unit *u);
494 bool unit_can_start(Unit *u);
495 bool unit_can_isolate(Unit *u);
497 int unit_start(Unit *u);
498 int unit_stop(Unit *u);
499 int unit_reload(Unit *u);
501 int unit_kill(Unit *u, KillWho w, KillMode m, int signo, DBusError *error);
503 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
505 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
506 void unit_unwatch_fd(Unit *u, Watch *w);
508 int unit_watch_pid(Unit *u, pid_t pid);
509 void unit_unwatch_pid(Unit *u, pid_t pid);
511 int unit_watch_timer(Unit *u, usec_t delay, Watch *w);
512 void unit_unwatch_timer(Unit *u, Watch *w);
514 int unit_watch_bus_name(Unit *u, const char *name);
515 void unit_unwatch_bus_name(Unit *u, const char *name);
517 bool unit_job_is_applicable(Unit *u, JobType j);
519 int set_unit_path(const char *p);
521 char *unit_dbus_path(Unit *u);
523 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
524 int unit_get_related_unit(Unit *u, const char *type, Unit **_found);
526 char *unit_name_printf(Unit *u, const char* text);
527 char *unit_full_printf(Unit *u, const char *text);
528 char **unit_full_printf_strv(Unit *u, char **l);
530 bool unit_can_serialize(Unit *u);
531 int unit_serialize(Unit *u, FILE *f, FDSet *fds);
532 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_attr_(4,5);
533 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
534 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
536 int unit_add_node_link(Unit *u, const char *what, bool wants);
538 int unit_coldplug(Unit *u);
540 void unit_status_printf(Unit *u, const char *status, const char *format, ...);
542 bool unit_need_daemon_reload(Unit *u);
544 void unit_reset_failed(Unit *u);
546 Unit *unit_following(Unit *u);
548 bool unit_pending_inactive(Unit *u);
549 bool unit_pending_active(Unit *u);
551 int unit_add_default_target_dependency(Unit *u, Unit *target);
553 int unit_following_set(Unit *u, Set **s);
555 UnitType unit_name_to_type(const char *n);
556 bool unit_name_is_valid(const char *n, bool template_ok);
558 void unit_trigger_on_failure(Unit *u);
560 bool unit_condition_test(Unit *u);
562 UnitFileState unit_get_unit_file_state(Unit *u);
564 Unit* unit_ref_set(UnitRef *ref, Unit *u);
565 void unit_ref_unset(UnitRef *ref);
567 #define UNIT_DEREF(ref) ((ref).unit)
569 int unit_add_one_mount_link(Unit *u, Mount *m);
570 int unit_add_mount_links(Unit *u);
572 const char *unit_load_state_to_string(UnitLoadState i);
573 UnitLoadState unit_load_state_from_string(const char *s);
575 const char *unit_active_state_to_string(UnitActiveState i);
576 UnitActiveState unit_active_state_from_string(const char *s);
578 const char *unit_dependency_to_string(UnitDependency i);
579 UnitDependency unit_dependency_from_string(const char *s);