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;
35 typedef struct UnitRef UnitRef;
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];
159 char *fragment_path; /* if loaded from a config file this is the primary path to it */
160 usec_t fragment_mtime;
162 /* If there is something to do with this unit, then this is
168 /* References to this */
169 LIST_HEAD(UnitRef, refs);
171 /* Conditions to check */
172 LIST_HEAD(Condition, conditions);
174 dual_timestamp condition_timestamp;
176 dual_timestamp inactive_exit_timestamp;
177 dual_timestamp active_enter_timestamp;
178 dual_timestamp active_exit_timestamp;
179 dual_timestamp inactive_enter_timestamp;
181 /* Counterparts in the cgroup filesystem */
182 CGroupBonding *cgroup_bondings;
183 CGroupAttribute *cgroup_attributes;
186 LIST_FIELDS(Meta, units_by_type);
189 LIST_FIELDS(Meta, load_queue);
192 LIST_FIELDS(Meta, dbus_queue);
195 LIST_FIELDS(Meta, cleanup_queue);
198 LIST_FIELDS(Meta, gc_queue);
200 /* Used during GC sweeps */
203 /* When deserializing, temporarily store the job type for this
204 * unit here, if there was a job scheduled */
205 int deserialized_job; /* This is actually of type JobType */
207 /* Error code when we didn't manage to load the unit (negative) */
210 /* Cached unit file state */
211 UnitFileState unit_file_state;
213 /* Garbage collect us we nobody wants or requires us anymore */
214 bool stop_when_unneeded;
216 /* Create default dependencies */
217 bool default_dependencies;
219 /* Refuse manual starting, allow starting only indirectly via dependency. */
220 bool refuse_manual_start;
222 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
223 bool refuse_manual_stop;
225 /* Allow isolation requests */
228 /* Isolate OnFailure unit */
229 bool on_failure_isolate;
231 /* Ignore this unit when isolating */
232 bool ignore_on_isolate;
234 /* Ignore this unit when snapshotting */
235 bool ignore_on_snapshot;
237 /* Did the last condition check suceed? */
238 bool condition_result;
240 bool in_load_queue:1;
241 bool in_dbus_queue:1;
242 bool in_cleanup_queue:1;
245 bool sent_dbus_new_signal:1;
253 /* Keeps tracks of references to a unit. This is useful so
254 * that we can merge two units if necessary and correct all
255 * references to them */
258 LIST_FIELDS(UnitRef, refs);
267 #include "automount.h"
268 #include "snapshot.h"
289 /* Config file sections this unit type understands, separated
291 const char *sections;
293 /* This should reset all type-specific variables. This should
294 * not allocate memory, and is called with zero-initialized
295 * data. It should hence only initialize variables that need
297 void (*init)(Unit *u);
299 /* This should free all type-specific variables. It should be
301 void (*done)(Unit *u);
303 /* Actually load data from disk. This may fail, and should set
304 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
305 * UNIT_STUB if no configuration could be found. */
306 int (*load)(Unit *u);
308 /* If a a lot of units got created via enumerate(), this is
309 * where to actually set the state and call unit_notify(). */
310 int (*coldplug)(Unit *u);
312 void (*dump)(Unit *u, FILE *f, const char *prefix);
314 int (*start)(Unit *u);
315 int (*stop)(Unit *u);
316 int (*reload)(Unit *u);
318 int (*kill)(Unit *u, KillWho w, KillMode m, int signo, DBusError *error);
320 bool (*can_reload)(Unit *u);
322 /* Write all data that cannot be restored from other sources
323 * away using unit_serialize_item() */
324 int (*serialize)(Unit *u, FILE *f, FDSet *fds);
326 /* Restore one item from the serialization */
327 int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
329 /* Boils down the more complex internal state of this unit to
330 * a simpler one that the engine can understand */
331 UnitActiveState (*active_state)(Unit *u);
333 /* Returns the substate specific to this unit type as
334 * string. This is purely information so that we can give the
335 * user a more fine grained explanation in which actual state a
337 const char* (*sub_state_to_string)(Unit *u);
339 /* Return true when there is reason to keep this entry around
340 * even nothing references it and it isn't active in any
342 bool (*check_gc)(Unit *u);
344 /* Return true when this unit is suitable for snapshotting */
345 bool (*check_snapshot)(Unit *u);
347 void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
348 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
349 void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
351 /* Check whether unit needs a daemon reload */
352 bool (*need_daemon_reload)(Unit *u);
354 /* Reset failed state if we are in failed state */
355 void (*reset_failed)(Unit *u);
357 /* Called whenever any of the cgroups this unit watches for
359 void (*cgroup_notify_empty)(Unit *u);
361 /* Called whenever a process of this unit sends us a message */
362 void (*notify_message)(Unit *u, pid_t pid, char **tags);
364 /* Called whenever a name thus Unit registered for comes or
366 void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
368 /* Called whenever a bus PID lookup finishes */
369 void (*bus_query_pid_done)(Unit *u, const char *name, pid_t pid);
371 /* Called for each message received on the bus */
372 DBusHandlerResult (*bus_message_handler)(Unit *u, DBusConnection *c, DBusMessage *message);
374 /* Return the unit this unit is following */
375 Unit *(*following)(Unit *u);
377 /* Return the set of units that are following each other */
378 int (*following_set)(Unit *u, Set **s);
380 /* This is called for each unit type and should be used to
381 * enumerate existing devices and load them. However,
382 * everything that is loaded here should still stay in
383 * inactive state. It is the job of the coldplug() call above
384 * to put the units into the initial state. */
385 int (*enumerate)(Manager *m);
387 /* Type specific cleanups. */
388 void (*shutdown)(Manager *m);
390 /* When sending out PropertiesChanged signal, which properties
391 * shall be invalidated? This is a NUL separated list of
392 * strings, to minimize relocations a little. */
393 const char *bus_invalidating_properties;
395 /* The interface name */
396 const char *bus_interface;
398 /* Can units of this type have multiple names? */
401 /* Instances make no sense for this type */
404 /* Exclude from automatic gc */
407 /* Show status updates on the console */
411 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
413 #define UNIT_VTABLE(u) unit_vtable[(u)->meta.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->meta.type != UNIT_##UPPERCASE)) \
421 return (MixedCase*) u; \
424 /* For casting the various unit types into a unit */
425 #define UNIT(u) ((Unit*) (&(u)->meta))
427 DEFINE_CAST(SOCKET, Socket);
428 DEFINE_CAST(TIMER, Timer);
429 DEFINE_CAST(SERVICE, Service);
430 DEFINE_CAST(TARGET, Target);
431 DEFINE_CAST(DEVICE, Device);
432 DEFINE_CAST(MOUNT, Mount);
433 DEFINE_CAST(AUTOMOUNT, Automount);
434 DEFINE_CAST(SNAPSHOT, Snapshot);
435 DEFINE_CAST(SWAP, Swap);
436 DEFINE_CAST(PATH, Path);
438 Unit *unit_new(Manager *m);
439 void unit_free(Unit *u);
441 int unit_add_name(Unit *u, const char *name);
443 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
444 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
446 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
447 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
449 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
450 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
452 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
454 int unit_add_cgroup(Unit *u, CGroupBonding *b);
455 int unit_add_cgroup_from_text(Unit *u, const char *name);
456 int unit_add_default_cgroups(Unit *u);
457 CGroupBonding* unit_get_default_cgroup(Unit *u);
458 int unit_add_cgroup_attribute(Unit *u, const char *controller, const char *name, const char *value, CGroupAttributeMapCallback map_callback);
460 int unit_choose_id(Unit *u, const char *name);
461 int unit_set_description(Unit *u, const char *description);
463 bool unit_check_gc(Unit *u);
465 void unit_add_to_load_queue(Unit *u);
466 void unit_add_to_dbus_queue(Unit *u);
467 void unit_add_to_cleanup_queue(Unit *u);
468 void unit_add_to_gc_queue(Unit *u);
470 int unit_merge(Unit *u, Unit *other);
471 int unit_merge_by_name(Unit *u, const char *other);
473 Unit *unit_follow_merge(Unit *u);
475 int unit_load_fragment_and_dropin(Unit *u);
476 int unit_load_fragment_and_dropin_optional(Unit *u);
477 int unit_load(Unit *unit);
479 const char *unit_description(Unit *u);
481 bool unit_has_name(Unit *u, const char *name);
483 UnitActiveState unit_active_state(Unit *u);
485 const char* unit_sub_state_to_string(Unit *u);
487 void unit_dump(Unit *u, FILE *f, const char *prefix);
489 bool unit_can_reload(Unit *u);
490 bool unit_can_start(Unit *u);
491 bool unit_can_isolate(Unit *u);
493 int unit_start(Unit *u);
494 int unit_stop(Unit *u);
495 int unit_reload(Unit *u);
497 int unit_kill(Unit *u, KillWho w, KillMode m, int signo, DBusError *error);
499 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
501 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
502 void unit_unwatch_fd(Unit *u, Watch *w);
504 int unit_watch_pid(Unit *u, pid_t pid);
505 void unit_unwatch_pid(Unit *u, pid_t pid);
507 int unit_watch_timer(Unit *u, usec_t delay, Watch *w);
508 void unit_unwatch_timer(Unit *u, Watch *w);
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);
520 int unit_get_related_unit(Unit *u, const char *type, Unit **_found);
522 char *unit_name_printf(Unit *u, const char* text);
523 char *unit_full_printf(Unit *u, const char *text);
524 char **unit_full_printf_strv(Unit *u, char **l);
526 bool unit_can_serialize(Unit *u);
527 int unit_serialize(Unit *u, FILE *f, FDSet *fds);
528 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_attr_(4,5);
529 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
530 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
532 int unit_add_node_link(Unit *u, const char *what, bool wants);
534 int unit_coldplug(Unit *u);
536 void unit_status_printf(Unit *u, const char *status, const char *format, ...);
538 bool unit_need_daemon_reload(Unit *u);
540 void unit_reset_failed(Unit *u);
542 Unit *unit_following(Unit *u);
544 bool unit_pending_inactive(Unit *u);
545 bool unit_pending_active(Unit *u);
547 int unit_add_default_target_dependency(Unit *u, Unit *target);
549 int unit_following_set(Unit *u, Set **s);
551 UnitType unit_name_to_type(const char *n);
552 bool unit_name_is_valid(const char *n, bool template_ok);
554 void unit_trigger_on_failure(Unit *u);
556 bool unit_condition_test(Unit *u);
558 UnitFileState unit_get_unit_file_state(Unit *u);
560 Unit* unit_ref_set(UnitRef *ref, Unit *u);
561 void unit_ref_unset(UnitRef *ref);
563 #define UNIT_DEREF(ref) ((ref).unit)
565 const char *unit_load_state_to_string(UnitLoadState i);
566 UnitLoadState unit_load_state_from_string(const char *s);
568 const char *unit_active_state_to_string(UnitActiveState i);
569 UnitActiveState unit_active_state_from_string(const char *s);
571 const char *unit_dependency_to_string(UnitDependency i);
572 UnitDependency unit_dependency_from_string(const char *s);