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"
44 #include "unit-name.h"
53 _UNIT_LOAD_STATE_INVALID = -1
56 enum UnitActiveState {
63 _UNIT_ACTIVE_STATE_MAX,
64 _UNIT_ACTIVE_STATE_INVALID = -1
67 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) {
68 return t == UNIT_ACTIVE || t == UNIT_RELOADING;
71 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) {
72 return t == UNIT_ACTIVE || t == UNIT_ACTIVATING || t == UNIT_RELOADING;
75 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) {
76 return t == UNIT_INACTIVE || t == UNIT_FAILED || t == UNIT_DEACTIVATING;
79 static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t) {
80 return t == UNIT_INACTIVE || t == UNIT_FAILED;
84 /* Positive dependencies */
86 UNIT_REQUIRES_OVERRIDABLE,
88 UNIT_REQUISITE_OVERRIDABLE,
92 /* Inverse of the above */
93 UNIT_REQUIRED_BY, /* inverse of 'requires' and 'requisite' is 'required_by' */
94 UNIT_REQUIRED_BY_OVERRIDABLE, /* inverse of 'requires_overridable' and 'requisite_overridable' is 'soft_required_by' */
95 UNIT_WANTED_BY, /* inverse of 'wants' */
96 UNIT_BOUND_BY, /* inverse of 'bind_to' */
98 /* Negative dependencies */
99 UNIT_CONFLICTS, /* inverse of 'conflicts' is 'conflicted_by' */
103 UNIT_BEFORE, /* inverse of 'before' is 'after' and vice versa */
109 /* Triggers (i.e. a socket triggers a service) */
113 /* Propagate reloads */
114 UNIT_PROPAGATE_RELOAD_TO,
115 UNIT_PROPAGATE_RELOAD_FROM,
117 /* Reference information for GC logic */
118 UNIT_REFERENCES, /* Inverse of 'references' is 'referenced_by' */
121 _UNIT_DEPENDENCY_MAX,
122 _UNIT_DEPENDENCY_INVALID = -1
128 #include "cgroup-attr.h"
134 UnitLoadState load_state;
137 char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
141 Set *dependencies[_UNIT_DEPENDENCY_MAX];
143 char **requires_mounts_for;
146 char **documentation;
148 char *fragment_path; /* if loaded from a config file this is the primary path to it */
149 char *source_path; /* if converted, the source file */
150 usec_t fragment_mtime;
153 /* If there is something to do with this unit, then this is the installed job for it */
156 /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
161 /* References to this */
162 LIST_HEAD(UnitRef, refs);
164 /* Conditions to check */
165 LIST_HEAD(Condition, conditions);
167 dual_timestamp condition_timestamp;
169 dual_timestamp inactive_exit_timestamp;
170 dual_timestamp active_enter_timestamp;
171 dual_timestamp active_exit_timestamp;
172 dual_timestamp inactive_enter_timestamp;
174 /* Counterparts in the cgroup filesystem */
175 CGroupBonding *cgroup_bondings;
176 CGroupAttribute *cgroup_attributes;
179 LIST_FIELDS(Unit, units_by_type);
181 /* All units which have requires_mounts_for set */
182 LIST_FIELDS(Unit, has_requires_mounts_for);
185 LIST_FIELDS(Unit, load_queue);
188 LIST_FIELDS(Unit, dbus_queue);
191 LIST_FIELDS(Unit, cleanup_queue);
194 LIST_FIELDS(Unit, gc_queue);
196 /* Used during GC sweeps */
199 /* When deserializing, temporarily store the job type for this
200 * unit here, if there was a job scheduled.
201 * Only for deserializing from a legacy version. New style uses full
202 * serialized jobs. */
203 int deserialized_job; /* This is actually of type JobType */
205 /* Error code when we didn't manage to load the unit (negative) */
208 /* Cached unit file state */
209 UnitFileState unit_file_state;
211 /* Garbage collect us we nobody wants or requires us anymore */
212 bool stop_when_unneeded;
214 /* Create default dependencies */
215 bool default_dependencies;
217 /* Refuse manual starting, allow starting only indirectly via dependency. */
218 bool refuse_manual_start;
220 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
221 bool refuse_manual_stop;
223 /* Allow isolation requests */
226 /* Isolate OnFailure unit */
227 bool on_failure_isolate;
229 /* Ignore this unit when isolating */
230 bool ignore_on_isolate;
232 /* Ignore this unit when snapshotting */
233 bool ignore_on_snapshot;
235 /* Did the last condition check suceed? */
236 bool condition_result;
238 bool in_load_queue:1;
239 bool in_dbus_queue:1;
240 bool in_cleanup_queue:1;
243 bool sent_dbus_new_signal:1;
251 /* Keeps tracks of references to a unit. This is useful so
252 * that we can merge two units if necessary and correct all
253 * references to them */
256 LIST_FIELDS(UnitRef, refs);
259 struct UnitStatusMessageFormats {
260 const char *starting_stopping[2];
261 const char *finished_start_job[_JOB_RESULT_MAX];
262 const char *finished_stop_job[_JOB_RESULT_MAX];
271 #include "automount.h"
272 #include "snapshot.h"
277 /* How much memory does an object of this unit type need */
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 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, KillMode m, int signo, DBusError *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 /* Boils down the more complex internal state of this unit to
321 * a simpler one that the engine can understand */
322 UnitActiveState (*active_state)(Unit *u);
324 /* Returns the substate specific to this unit type as
325 * string. This is purely information so that we can give the
326 * user a more fine grained explanation in which actual state a
328 const char* (*sub_state_to_string)(Unit *u);
330 /* Return true when there is reason to keep this entry around
331 * even nothing references it and it isn't active in any
333 bool (*check_gc)(Unit *u);
335 /* Return true when this unit is suitable for snapshotting */
336 bool (*check_snapshot)(Unit *u);
338 void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
339 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
340 void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
342 /* Reset failed state if we are in failed state */
343 void (*reset_failed)(Unit *u);
345 /* Called whenever any of the cgroups this unit watches for
347 void (*cgroup_notify_empty)(Unit *u);
349 /* Called whenever a process of this unit sends us a message */
350 void (*notify_message)(Unit *u, pid_t pid, char **tags);
352 /* Called whenever a name thus Unit registered for comes or
354 void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
356 /* Called whenever a bus PID lookup finishes */
357 void (*bus_query_pid_done)(Unit *u, const char *name, pid_t pid);
359 /* Called for each message received on the bus */
360 DBusHandlerResult (*bus_message_handler)(Unit *u, DBusConnection *c, DBusMessage *message);
362 /* Return the unit this unit is following */
363 Unit *(*following)(Unit *u);
365 /* Return the set of units that are following each other */
366 int (*following_set)(Unit *u, Set **s);
368 /* This is called for each unit type and should be used to
369 * enumerate existing devices and load them. However,
370 * everything that is loaded here should still stay in
371 * inactive state. It is the job of the coldplug() call above
372 * to put the units into the initial state. */
373 int (*enumerate)(Manager *m);
375 /* Type specific cleanups. */
376 void (*shutdown)(Manager *m);
378 /* When sending out PropertiesChanged signal, which properties
379 * shall be invalidated? This is a NUL separated list of
380 * strings, to minimize relocations a little. */
381 const char *bus_invalidating_properties;
383 /* The interface name */
384 const char *bus_interface;
386 UnitStatusMessageFormats status_message_formats;
388 /* Can units of this type have multiple names? */
391 /* Instances make no sense for this type */
394 /* Exclude from automatic gc */
398 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
400 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
402 /* For casting a unit into the various unit types */
403 #define DEFINE_CAST(UPPERCASE, MixedCase) \
404 static inline MixedCase* UPPERCASE(Unit *u) { \
405 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
408 return (MixedCase*) u; \
411 /* For casting the various unit types into a unit */
412 #define UNIT(u) (&(u)->meta)
414 DEFINE_CAST(SOCKET, Socket);
415 DEFINE_CAST(TIMER, Timer);
416 DEFINE_CAST(SERVICE, Service);
417 DEFINE_CAST(TARGET, Target);
418 DEFINE_CAST(DEVICE, Device);
419 DEFINE_CAST(MOUNT, Mount);
420 DEFINE_CAST(AUTOMOUNT, Automount);
421 DEFINE_CAST(SNAPSHOT, Snapshot);
422 DEFINE_CAST(SWAP, Swap);
423 DEFINE_CAST(PATH, Path);
425 Unit *unit_new(Manager *m, size_t size);
426 void unit_free(Unit *u);
428 int unit_add_name(Unit *u, const char *name);
430 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
431 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
433 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
434 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
436 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
437 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
439 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
441 int unit_add_cgroup(Unit *u, CGroupBonding *b);
442 int unit_add_cgroup_from_text(Unit *u, const char *name);
443 int unit_add_default_cgroups(Unit *u);
444 CGroupBonding* unit_get_default_cgroup(Unit *u);
445 int unit_add_cgroup_attribute(Unit *u, const char *controller, const char *name, const char *value, CGroupAttributeMapCallback map_callback);
447 int unit_choose_id(Unit *u, const char *name);
448 int unit_set_description(Unit *u, const char *description);
450 bool unit_check_gc(Unit *u);
452 void unit_add_to_load_queue(Unit *u);
453 void unit_add_to_dbus_queue(Unit *u);
454 void unit_add_to_cleanup_queue(Unit *u);
455 void unit_add_to_gc_queue(Unit *u);
457 int unit_merge(Unit *u, Unit *other);
458 int unit_merge_by_name(Unit *u, const char *other);
460 Unit *unit_follow_merge(Unit *u);
462 int unit_load_fragment_and_dropin(Unit *u);
463 int unit_load_fragment_and_dropin_optional(Unit *u);
464 int unit_load(Unit *unit);
466 const char *unit_description(Unit *u);
468 bool unit_has_name(Unit *u, const char *name);
470 UnitActiveState unit_active_state(Unit *u);
472 const char* unit_sub_state_to_string(Unit *u);
474 void unit_dump(Unit *u, FILE *f, const char *prefix);
476 bool unit_can_reload(Unit *u);
477 bool unit_can_start(Unit *u);
478 bool unit_can_isolate(Unit *u);
480 int unit_start(Unit *u);
481 int unit_stop(Unit *u);
482 int unit_reload(Unit *u);
484 int unit_kill(Unit *u, KillWho w, KillMode m, int signo, DBusError *error);
486 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
488 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
489 void unit_unwatch_fd(Unit *u, Watch *w);
491 int unit_watch_pid(Unit *u, pid_t pid);
492 void unit_unwatch_pid(Unit *u, pid_t pid);
494 int unit_watch_timer(Unit *u, usec_t delay, Watch *w);
495 void unit_unwatch_timer(Unit *u, Watch *w);
497 int unit_watch_bus_name(Unit *u, const char *name);
498 void unit_unwatch_bus_name(Unit *u, const char *name);
500 bool unit_job_is_applicable(Unit *u, JobType j);
502 int set_unit_path(const char *p);
504 char *unit_dbus_path(Unit *u);
506 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
507 int unit_get_related_unit(Unit *u, const char *type, Unit **_found);
509 char *unit_name_printf(Unit *u, const char* text);
510 char *unit_full_printf(Unit *u, const char *text);
511 char **unit_full_printf_strv(Unit *u, char **l);
513 bool unit_can_serialize(Unit *u);
514 int unit_serialize(Unit *u, FILE *f, FDSet *fds);
515 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_attr_(4,5);
516 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
517 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
519 int unit_add_node_link(Unit *u, const char *what, bool wants);
521 int unit_coldplug(Unit *u);
523 void unit_status_printf(Unit *u, const char *status, const char *format, ...);
525 bool unit_need_daemon_reload(Unit *u);
527 void unit_reset_failed(Unit *u);
529 Unit *unit_following(Unit *u);
531 bool unit_pending_inactive(Unit *u);
532 bool unit_pending_active(Unit *u);
534 int unit_add_default_target_dependency(Unit *u, Unit *target);
536 int unit_following_set(Unit *u, Set **s);
538 void unit_trigger_on_failure(Unit *u);
540 bool unit_condition_test(Unit *u);
542 UnitFileState unit_get_unit_file_state(Unit *u);
544 Unit* unit_ref_set(UnitRef *ref, Unit *u);
545 void unit_ref_unset(UnitRef *ref);
547 #define UNIT_DEREF(ref) ((ref).unit)
549 int unit_add_one_mount_link(Unit *u, Mount *m);
550 int unit_add_mount_links(Unit *u);
552 const char *unit_load_state_to_string(UnitLoadState i);
553 UnitLoadState unit_load_state_from_string(const char *s);
555 const char *unit_active_state_to_string(UnitActiveState i);
556 UnitActiveState unit_active_state_from_string(const char *s);
558 const char *unit_dependency_to_string(UnitDependency i);
559 UnitDependency unit_dependency_from_string(const char *s);