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;
39 #include "socket-util.h"
41 #include "condition.h"
56 _UNIT_TYPE_INVALID = -1
66 _UNIT_LOAD_STATE_INVALID = -1
69 enum UnitActiveState {
76 _UNIT_ACTIVE_STATE_MAX,
77 _UNIT_ACTIVE_STATE_INVALID = -1
80 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) {
81 return t == UNIT_ACTIVE || t == UNIT_RELOADING;
84 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) {
85 return t == UNIT_ACTIVE || t == UNIT_ACTIVATING || t == UNIT_RELOADING;
88 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) {
89 return t == UNIT_INACTIVE || t == UNIT_FAILED || t == UNIT_DEACTIVATING;
92 static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t) {
93 return t == UNIT_INACTIVE || t == UNIT_FAILED;
97 /* Positive dependencies */
99 UNIT_REQUIRES_OVERRIDABLE,
101 UNIT_REQUISITE_OVERRIDABLE,
105 /* Inverse of the above */
106 UNIT_REQUIRED_BY, /* inverse of 'requires' and 'requisite' is 'required_by' */
107 UNIT_REQUIRED_BY_OVERRIDABLE, /* inverse of 'requires_overridable' and 'requisite_overridable' is 'soft_required_by' */
108 UNIT_WANTED_BY, /* inverse of 'wants' */
109 UNIT_BOUND_BY, /* inverse of 'bind_to' */
111 /* Negative dependencies */
112 UNIT_CONFLICTS, /* inverse of 'conflicts' is 'conflicted_by' */
116 UNIT_BEFORE, /* inverse of 'before' is 'after' and vice versa */
122 /* Triggers (i.e. a socket triggers a service) */
126 /* Propagate reloads */
127 UNIT_PROPAGATE_RELOAD_TO,
128 UNIT_PROPAGATE_RELOAD_FROM,
130 /* Reference information for GC logic */
131 UNIT_REFERENCES, /* Inverse of 'references' is 'referenced_by' */
134 _UNIT_DEPENDENCY_MAX,
135 _UNIT_DEPENDENCY_INVALID = -1
141 #include "cgroup-attr.h"
147 UnitLoadState load_state;
150 char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
154 Set *dependencies[_UNIT_DEPENDENCY_MAX];
158 char *fragment_path; /* if loaded from a config file this is the primary path to it */
159 usec_t fragment_mtime;
161 /* If there is something to do with this unit, then this is the installed job for it */
164 /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
169 /* References to this */
170 LIST_HEAD(UnitRef, refs);
172 /* Conditions to check */
173 LIST_HEAD(Condition, conditions);
175 dual_timestamp condition_timestamp;
177 dual_timestamp inactive_exit_timestamp;
178 dual_timestamp active_enter_timestamp;
179 dual_timestamp active_exit_timestamp;
180 dual_timestamp inactive_enter_timestamp;
182 /* Counterparts in the cgroup filesystem */
183 CGroupBonding *cgroup_bondings;
184 CGroupAttribute *cgroup_attributes;
187 LIST_FIELDS(Unit, units_by_type);
190 LIST_FIELDS(Unit, load_queue);
193 LIST_FIELDS(Unit, dbus_queue);
196 LIST_FIELDS(Unit, cleanup_queue);
199 LIST_FIELDS(Unit, gc_queue);
201 /* Used during GC sweeps */
204 /* When deserializing, temporarily store the job type for this
205 * unit here, if there was a job scheduled.
206 * Only for deserializing from a legacy version. New style uses full
207 * serialized jobs. */
208 int deserialized_job; /* This is actually of type JobType */
210 /* Error code when we didn't manage to load the unit (negative) */
213 /* Cached unit file state */
214 UnitFileState unit_file_state;
216 /* Garbage collect us we nobody wants or requires us anymore */
217 bool stop_when_unneeded;
219 /* Create default dependencies */
220 bool default_dependencies;
222 /* Refuse manual starting, allow starting only indirectly via dependency. */
223 bool refuse_manual_start;
225 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
226 bool refuse_manual_stop;
228 /* Allow isolation requests */
231 /* Isolate OnFailure unit */
232 bool on_failure_isolate;
234 /* Ignore this unit when isolating */
235 bool ignore_on_isolate;
237 /* Ignore this unit when snapshotting */
238 bool ignore_on_snapshot;
240 /* Did the last condition check suceed? */
241 bool condition_result;
243 bool in_load_queue:1;
244 bool in_dbus_queue:1;
245 bool in_cleanup_queue:1;
248 bool sent_dbus_new_signal:1;
256 /* Keeps tracks of references to a unit. This is useful so
257 * that we can merge two units if necessary and correct all
258 * references to them */
261 LIST_FIELDS(UnitRef, refs);
270 #include "automount.h"
271 #include "snapshot.h"
278 /* How much memory does an object of this unit type need */
281 /* Config file sections this unit type understands, separated
283 const char *sections;
285 /* This should reset all type-specific variables. This should
286 * not allocate memory, and is called with zero-initialized
287 * data. It should hence only initialize variables that need
289 void (*init)(Unit *u);
291 /* This should free all type-specific variables. It should be
293 void (*done)(Unit *u);
295 /* Actually load data from disk. This may fail, and should set
296 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
297 * UNIT_STUB if no configuration could be found. */
298 int (*load)(Unit *u);
300 /* If a a lot of units got created via enumerate(), this is
301 * where to actually set the state and call unit_notify(). */
302 int (*coldplug)(Unit *u);
304 void (*dump)(Unit *u, FILE *f, const char *prefix);
306 int (*start)(Unit *u);
307 int (*stop)(Unit *u);
308 int (*reload)(Unit *u);
310 int (*kill)(Unit *u, KillWho w, KillMode m, int signo, DBusError *error);
312 bool (*can_reload)(Unit *u);
314 /* Write all data that cannot be restored from other sources
315 * away using unit_serialize_item() */
316 int (*serialize)(Unit *u, FILE *f, FDSet *fds);
318 /* Restore one item from the serialization */
319 int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
321 /* Boils down the more complex internal state of this unit to
322 * a simpler one that the engine can understand */
323 UnitActiveState (*active_state)(Unit *u);
325 /* Returns the substate specific to this unit type as
326 * string. This is purely information so that we can give the
327 * user a more fine grained explanation in which actual state a
329 const char* (*sub_state_to_string)(Unit *u);
331 /* Return true when there is reason to keep this entry around
332 * even nothing references it and it isn't active in any
334 bool (*check_gc)(Unit *u);
336 /* Return true when this unit is suitable for snapshotting */
337 bool (*check_snapshot)(Unit *u);
339 void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
340 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
341 void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
343 /* Check whether unit needs a daemon reload */
344 bool (*need_daemon_reload)(Unit *u);
346 /* Reset failed state if we are in failed state */
347 void (*reset_failed)(Unit *u);
349 /* Called whenever any of the cgroups this unit watches for
351 void (*cgroup_notify_empty)(Unit *u);
353 /* Called whenever a process of this unit sends us a message */
354 void (*notify_message)(Unit *u, pid_t pid, char **tags);
356 /* Called whenever a name thus Unit registered for comes or
358 void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
360 /* Called whenever a bus PID lookup finishes */
361 void (*bus_query_pid_done)(Unit *u, const char *name, pid_t pid);
363 /* Called for each message received on the bus */
364 DBusHandlerResult (*bus_message_handler)(Unit *u, DBusConnection *c, DBusMessage *message);
366 /* Return the unit this unit is following */
367 Unit *(*following)(Unit *u);
369 /* Return the set of units that are following each other */
370 int (*following_set)(Unit *u, Set **s);
372 /* This is called for each unit type and should be used to
373 * enumerate existing devices and load them. However,
374 * everything that is loaded here should still stay in
375 * inactive state. It is the job of the coldplug() call above
376 * to put the units into the initial state. */
377 int (*enumerate)(Manager *m);
379 /* Type specific cleanups. */
380 void (*shutdown)(Manager *m);
382 /* When sending out PropertiesChanged signal, which properties
383 * shall be invalidated? This is a NUL separated list of
384 * strings, to minimize relocations a little. */
385 const char *bus_invalidating_properties;
387 /* The interface name */
388 const char *bus_interface;
390 /* Can units of this type have multiple names? */
393 /* Instances make no sense for this type */
396 /* Exclude from automatic gc */
399 /* Show status updates on the console */
403 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
405 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
407 /* For casting a unit into the various unit types */
408 #define DEFINE_CAST(UPPERCASE, MixedCase) \
409 static inline MixedCase* UPPERCASE(Unit *u) { \
410 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
413 return (MixedCase*) u; \
416 /* For casting the various unit types into a unit */
417 #define UNIT(u) (&(u)->meta)
419 DEFINE_CAST(SOCKET, Socket);
420 DEFINE_CAST(TIMER, Timer);
421 DEFINE_CAST(SERVICE, Service);
422 DEFINE_CAST(TARGET, Target);
423 DEFINE_CAST(DEVICE, Device);
424 DEFINE_CAST(MOUNT, Mount);
425 DEFINE_CAST(AUTOMOUNT, Automount);
426 DEFINE_CAST(SNAPSHOT, Snapshot);
427 DEFINE_CAST(SWAP, Swap);
428 DEFINE_CAST(PATH, Path);
430 Unit *unit_new(Manager *m, size_t size);
431 void unit_free(Unit *u);
433 int unit_add_name(Unit *u, const char *name);
435 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
436 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
438 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
439 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
441 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
442 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
444 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
446 int unit_add_cgroup(Unit *u, CGroupBonding *b);
447 int unit_add_cgroup_from_text(Unit *u, const char *name);
448 int unit_add_default_cgroups(Unit *u);
449 CGroupBonding* unit_get_default_cgroup(Unit *u);
450 int unit_add_cgroup_attribute(Unit *u, const char *controller, const char *name, const char *value, CGroupAttributeMapCallback map_callback);
452 int unit_choose_id(Unit *u, const char *name);
453 int unit_set_description(Unit *u, const char *description);
455 bool unit_check_gc(Unit *u);
457 void unit_add_to_load_queue(Unit *u);
458 void unit_add_to_dbus_queue(Unit *u);
459 void unit_add_to_cleanup_queue(Unit *u);
460 void unit_add_to_gc_queue(Unit *u);
462 int unit_merge(Unit *u, Unit *other);
463 int unit_merge_by_name(Unit *u, const char *other);
465 Unit *unit_follow_merge(Unit *u);
467 int unit_load_fragment_and_dropin(Unit *u);
468 int unit_load_fragment_and_dropin_optional(Unit *u);
469 int unit_load(Unit *unit);
471 const char *unit_description(Unit *u);
473 bool unit_has_name(Unit *u, const char *name);
475 UnitActiveState unit_active_state(Unit *u);
477 const char* unit_sub_state_to_string(Unit *u);
479 void unit_dump(Unit *u, FILE *f, const char *prefix);
481 bool unit_can_reload(Unit *u);
482 bool unit_can_start(Unit *u);
483 bool unit_can_isolate(Unit *u);
485 int unit_start(Unit *u);
486 int unit_stop(Unit *u);
487 int unit_reload(Unit *u);
489 int unit_kill(Unit *u, KillWho w, KillMode m, int signo, DBusError *error);
491 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
493 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
494 void unit_unwatch_fd(Unit *u, Watch *w);
496 int unit_watch_pid(Unit *u, pid_t pid);
497 void unit_unwatch_pid(Unit *u, pid_t pid);
499 int unit_watch_timer(Unit *u, usec_t delay, Watch *w);
500 void unit_unwatch_timer(Unit *u, Watch *w);
502 int unit_watch_bus_name(Unit *u, const char *name);
503 void unit_unwatch_bus_name(Unit *u, const char *name);
505 bool unit_job_is_applicable(Unit *u, JobType j);
507 int set_unit_path(const char *p);
509 char *unit_dbus_path(Unit *u);
511 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
512 int unit_get_related_unit(Unit *u, const char *type, Unit **_found);
514 char *unit_name_printf(Unit *u, const char* text);
515 char *unit_full_printf(Unit *u, const char *text);
516 char **unit_full_printf_strv(Unit *u, char **l);
518 bool unit_can_serialize(Unit *u);
519 int unit_serialize(Unit *u, FILE *f, FDSet *fds);
520 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_attr_(4,5);
521 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
522 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
524 int unit_add_node_link(Unit *u, const char *what, bool wants);
526 int unit_coldplug(Unit *u);
528 void unit_status_printf(Unit *u, const char *status, const char *format, ...);
530 bool unit_need_daemon_reload(Unit *u);
532 void unit_reset_failed(Unit *u);
534 Unit *unit_following(Unit *u);
536 bool unit_pending_inactive(Unit *u);
537 bool unit_pending_active(Unit *u);
539 int unit_add_default_target_dependency(Unit *u, Unit *target);
541 int unit_following_set(Unit *u, Set **s);
543 UnitType unit_name_to_type(const char *n);
544 bool unit_name_is_valid(const char *n, bool template_ok);
546 void unit_trigger_on_failure(Unit *u);
548 bool unit_condition_test(Unit *u);
550 UnitFileState unit_get_unit_file_state(Unit *u);
552 Unit* unit_ref_set(UnitRef *ref, Unit *u);
553 void unit_ref_unset(UnitRef *ref);
555 #define UNIT_DEREF(ref) ((ref).unit)
557 const char *unit_load_state_to_string(UnitLoadState i);
558 UnitLoadState unit_load_state_from_string(const char *s);
560 const char *unit_active_state_to_string(UnitActiveState i);
561 UnitActiveState unit_active_state_from_string(const char *s);
563 const char *unit_dependency_to_string(UnitDependency i);
564 UnitDependency unit_dependency_from_string(const char *s);