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 General Public License as published by
13 the Free Software Foundation; either version 2 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 General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with systemd; If not, see <http://www.gnu.org/licenses/>.
28 typedef union Unit Unit;
29 typedef struct Meta Meta;
30 typedef struct UnitVTable UnitVTable;
31 typedef enum UnitType UnitType;
32 typedef enum UnitLoadState UnitLoadState;
33 typedef enum UnitActiveState UnitActiveState;
34 typedef enum UnitDependency UnitDependency;
39 #include "socket-util.h"
41 #include "condition.h"
55 _UNIT_TYPE_INVALID = -1
65 _UNIT_LOAD_STATE_INVALID = -1
68 enum UnitActiveState {
75 _UNIT_ACTIVE_STATE_MAX,
76 _UNIT_ACTIVE_STATE_INVALID = -1
79 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) {
80 return t == UNIT_ACTIVE || t == UNIT_RELOADING;
83 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) {
84 return t == UNIT_ACTIVE || t == UNIT_ACTIVATING || t == UNIT_RELOADING;
87 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) {
88 return t == UNIT_INACTIVE || t == UNIT_FAILED || t == UNIT_DEACTIVATING;
91 static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t) {
92 return t == UNIT_INACTIVE || t == UNIT_FAILED;
96 /* Positive dependencies */
98 UNIT_REQUIRES_OVERRIDABLE,
100 UNIT_REQUISITE_OVERRIDABLE,
104 /* Inverse of the above */
105 UNIT_REQUIRED_BY, /* inverse of 'requires' and 'requisite' is 'required_by' */
106 UNIT_REQUIRED_BY_OVERRIDABLE, /* inverse of 'requires_overridable' and 'requisite_overridable' is 'soft_required_by' */
107 UNIT_WANTED_BY, /* inverse of 'wants' */
108 UNIT_BOUND_BY, /* inverse of 'bind_to' */
110 /* Negative dependencies */
111 UNIT_CONFLICTS, /* inverse of 'conflicts' is 'conflicted_by' */
115 UNIT_BEFORE, /* inverse of 'before' is 'after' and vice versa */
121 /* Reference information for GC logic */
122 UNIT_REFERENCES, /* Inverse of 'references' is 'referenced_by' */
125 _UNIT_DEPENDENCY_MAX,
126 _UNIT_DEPENDENCY_INVALID = -1
137 UnitLoadState load_state;
140 char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
144 Set *dependencies[_UNIT_DEPENDENCY_MAX];
148 char *fragment_path; /* if loaded from a config file this is the primary path to it */
149 usec_t fragment_mtime;
151 /* If there is something to do with this unit, then this is
157 /* Conditions to check */
158 LIST_HEAD(Condition, conditions);
160 dual_timestamp condition_timestamp;
162 dual_timestamp inactive_exit_timestamp;
163 dual_timestamp active_enter_timestamp;
164 dual_timestamp active_exit_timestamp;
165 dual_timestamp inactive_enter_timestamp;
167 /* Counterparts in the cgroup filesystem */
168 CGroupBonding *cgroup_bondings;
171 LIST_FIELDS(Meta, units_per_type);
174 LIST_FIELDS(Meta, load_queue);
177 LIST_FIELDS(Meta, dbus_queue);
180 LIST_FIELDS(Meta, cleanup_queue);
183 LIST_FIELDS(Meta, gc_queue);
185 /* Used during GC sweeps */
188 /* When deserializing, temporarily store the job type for this
189 * unit here, if there was a job scheduled */
190 int deserialized_job; /* This is actually of type JobType */
192 /* Error code when we didn't manage to load the unit (negative) */
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 /* Isolate OnFailure unit */
211 bool on_failure_isolate;
213 /* Did the last condition check suceed? */
214 bool condition_result;
216 bool in_load_queue:1;
217 bool in_dbus_queue:1;
218 bool in_cleanup_queue:1;
221 bool sent_dbus_new_signal:1;
234 #include "automount.h"
235 #include "snapshot.h"
256 /* This should reset all type-specific variables. This should
257 * not allocate memory, and is called with zero-initialized
258 * data. It should hence only initialize variables that need
260 void (*init)(Unit *u);
262 /* This should free all type-specific variables. It should be
264 void (*done)(Unit *u);
266 /* Actually load data from disk. This may fail, and should set
267 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
268 * UNIT_STUB if no configuration could be found. */
269 int (*load)(Unit *u);
271 /* If a a lot of units got created via enumerate(), this is
272 * where to actually set the state and call unit_notify(). */
273 int (*coldplug)(Unit *u);
275 void (*dump)(Unit *u, FILE *f, const char *prefix);
277 int (*start)(Unit *u);
278 int (*stop)(Unit *u);
279 int (*reload)(Unit *u);
281 int (*kill)(Unit *u, KillWho w, KillMode m, int signo, DBusError *error);
283 bool (*can_reload)(Unit *u);
285 /* Write all data that cannot be restored from other sources
286 * away using unit_serialize_item() */
287 int (*serialize)(Unit *u, FILE *f, FDSet *fds);
289 /* Restore one item from the serialization */
290 int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
292 /* Boils down the more complex internal state of this unit to
293 * a simpler one that the engine can understand */
294 UnitActiveState (*active_state)(Unit *u);
296 /* Returns the substate specific to this unit type as
297 * string. This is purely information so that we can give the
298 * user a more fine grained explanation in which actual state a
300 const char* (*sub_state_to_string)(Unit *u);
302 /* Return true when there is reason to keep this entry around
303 * even nothing references it and it isn't active in any
305 bool (*check_gc)(Unit *u);
307 /* Return true when this unit is suitable for snapshotting */
308 bool (*check_snapshot)(Unit *u);
310 void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
311 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
312 void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
314 /* Reset failed state if we are in failed state */
315 void (*reset_failed)(Unit *u);
317 /* Called whenever any of the cgroups this unit watches for
319 void (*cgroup_notify_empty)(Unit *u);
321 /* Called whenever a process of this unit sends us a message */
322 void (*notify_message)(Unit *u, pid_t pid, char **tags);
324 /* Called whenever a name thus Unit registered for comes or
326 void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
328 /* Called whenever a bus PID lookup finishes */
329 void (*bus_query_pid_done)(Unit *u, const char *name, pid_t pid);
331 /* Called for each message received on the bus */
332 DBusHandlerResult (*bus_message_handler)(Unit *u, DBusConnection *c, DBusMessage *message);
334 /* Return the unit this unit is following */
335 Unit *(*following)(Unit *u);
337 /* Return the set of units that are following each other */
338 int (*following_set)(Unit *u, Set **s);
340 /* This is called for each unit type and should be used to
341 * enumerate existing devices and load them. However,
342 * everything that is loaded here should still stay in
343 * inactive state. It is the job of the coldplug() call above
344 * to put the units into the initial state. */
345 int (*enumerate)(Manager *m);
347 /* Type specific cleanups. */
348 void (*shutdown)(Manager *m);
350 /* When sending out PropertiesChanged signal, which properties
351 * shall be invalidated? This is a NUL separated list of
352 * strings, to minimize relocations a little. */
353 const char *bus_invalidating_properties;
355 /* The interface name */
356 const char *bus_interface;
358 /* Can units of this type have multiple names? */
361 /* Instances make no sense for this type */
364 /* Exclude this type from snapshots */
367 /* Exclude from automatic gc */
370 /* Exclude from stopping on isolation requests */
373 /* Show status updates on the console */
377 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
379 #define UNIT_VTABLE(u) unit_vtable[(u)->meta.type]
381 /* For casting a unit into the various unit types */
382 #define DEFINE_CAST(UPPERCASE, MixedCase) \
383 static inline MixedCase* UPPERCASE(Unit *u) { \
384 if (_unlikely_(!u || u->meta.type != UNIT_##UPPERCASE)) \
387 return (MixedCase*) u; \
390 /* For casting the various unit types into a unit */
391 #define UNIT(u) ((Unit*) (&(u)->meta))
393 DEFINE_CAST(SOCKET, Socket);
394 DEFINE_CAST(TIMER, Timer);
395 DEFINE_CAST(SERVICE, Service);
396 DEFINE_CAST(TARGET, Target);
397 DEFINE_CAST(DEVICE, Device);
398 DEFINE_CAST(MOUNT, Mount);
399 DEFINE_CAST(AUTOMOUNT, Automount);
400 DEFINE_CAST(SNAPSHOT, Snapshot);
401 DEFINE_CAST(SWAP, Swap);
402 DEFINE_CAST(PATH, Path);
404 Unit *unit_new(Manager *m);
405 void unit_free(Unit *u);
407 int unit_add_name(Unit *u, const char *name);
409 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
410 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
412 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
413 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
415 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
416 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
418 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
420 int unit_add_cgroup(Unit *u, CGroupBonding *b);
421 int unit_add_cgroup_from_text(Unit *u, const char *name);
422 int unit_add_default_cgroups(Unit *u);
423 CGroupBonding* unit_get_default_cgroup(Unit *u);
425 int unit_choose_id(Unit *u, const char *name);
426 int unit_set_description(Unit *u, const char *description);
428 bool unit_check_gc(Unit *u);
430 void unit_add_to_load_queue(Unit *u);
431 void unit_add_to_dbus_queue(Unit *u);
432 void unit_add_to_cleanup_queue(Unit *u);
433 void unit_add_to_gc_queue(Unit *u);
435 int unit_merge(Unit *u, Unit *other);
436 int unit_merge_by_name(Unit *u, const char *other);
438 Unit *unit_follow_merge(Unit *u);
440 int unit_load_fragment_and_dropin(Unit *u);
441 int unit_load_fragment_and_dropin_optional(Unit *u);
442 int unit_load(Unit *unit);
444 const char *unit_description(Unit *u);
446 bool unit_has_name(Unit *u, const char *name);
448 UnitActiveState unit_active_state(Unit *u);
450 const char* unit_sub_state_to_string(Unit *u);
452 void unit_dump(Unit *u, FILE *f, const char *prefix);
454 bool unit_can_reload(Unit *u);
455 bool unit_can_start(Unit *u);
456 bool unit_can_isolate(Unit *u);
458 int unit_start(Unit *u);
459 int unit_stop(Unit *u);
460 int unit_reload(Unit *u);
462 int unit_kill(Unit *u, KillWho w, KillMode m, int signo, DBusError *error);
464 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
466 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
467 void unit_unwatch_fd(Unit *u, Watch *w);
469 int unit_watch_pid(Unit *u, pid_t pid);
470 void unit_unwatch_pid(Unit *u, pid_t pid);
472 int unit_watch_timer(Unit *u, usec_t delay, Watch *w);
473 void unit_unwatch_timer(Unit *u, Watch *w);
475 int unit_watch_bus_name(Unit *u, const char *name);
476 void unit_unwatch_bus_name(Unit *u, const char *name);
478 bool unit_job_is_applicable(Unit *u, JobType j);
480 int set_unit_path(const char *p);
482 char *unit_dbus_path(Unit *u);
484 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
485 int unit_get_related_unit(Unit *u, const char *type, Unit **_found);
487 char *unit_name_printf(Unit *u, const char* text);
488 char *unit_full_printf(Unit *u, const char *text);
489 char **unit_full_printf_strv(Unit *u, char **l);
491 bool unit_can_serialize(Unit *u);
492 int unit_serialize(Unit *u, FILE *f, FDSet *fds);
493 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_attr_(4,5);
494 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
495 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
497 int unit_add_node_link(Unit *u, const char *what, bool wants);
499 int unit_coldplug(Unit *u);
501 void unit_status_printf(Unit *u, const char *format, ...);
503 bool unit_need_daemon_reload(Unit *u);
505 void unit_reset_failed(Unit *u);
507 Unit *unit_following(Unit *u);
509 bool unit_pending_inactive(Unit *u);
510 bool unit_pending_active(Unit *u);
512 int unit_add_default_target_dependency(Unit *u, Unit *target);
514 int unit_following_set(Unit *u, Set **s);
516 UnitType unit_name_to_type(const char *n);
517 bool unit_name_is_valid(const char *n, bool template_ok);
519 void unit_trigger_on_failure(Unit *u);
521 bool unit_condition_test(Unit *u);
523 const char *unit_load_state_to_string(UnitLoadState i);
524 UnitLoadState unit_load_state_from_string(const char *s);
526 const char *unit_active_state_to_string(UnitActiveState i);
527 UnitActiveState unit_active_state_from_string(const char *s);
529 const char *unit_dependency_to_string(UnitDependency i);
530 UnitDependency unit_dependency_from_string(const char *s);