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 /* Reference information for GC logic */
128 UNIT_REFERENCES, /* Inverse of 'references' is 'referenced_by' */
131 _UNIT_DEPENDENCY_MAX,
132 _UNIT_DEPENDENCY_INVALID = -1
138 #include "cgroup-attr.h"
144 UnitLoadState load_state;
147 char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
151 Set *dependencies[_UNIT_DEPENDENCY_MAX];
155 char *fragment_path; /* if loaded from a config file this is the primary path to it */
156 usec_t fragment_mtime;
158 /* If there is something to do with this unit, then this is
164 /* References to this */
165 LIST_HEAD(UnitRef, refs);
167 /* Conditions to check */
168 LIST_HEAD(Condition, conditions);
170 dual_timestamp condition_timestamp;
172 dual_timestamp inactive_exit_timestamp;
173 dual_timestamp active_enter_timestamp;
174 dual_timestamp active_exit_timestamp;
175 dual_timestamp inactive_enter_timestamp;
177 /* Counterparts in the cgroup filesystem */
178 CGroupBonding *cgroup_bondings;
179 CGroupAttribute *cgroup_attributes;
182 LIST_FIELDS(Meta, units_by_type);
185 LIST_FIELDS(Meta, load_queue);
188 LIST_FIELDS(Meta, dbus_queue);
191 LIST_FIELDS(Meta, cleanup_queue);
194 LIST_FIELDS(Meta, 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 int deserialized_job; /* This is actually of type JobType */
203 /* Error code when we didn't manage to load the unit (negative) */
206 /* Cached unit file state */
207 UnitFileState unit_file_state;
209 /* Garbage collect us we nobody wants or requires us anymore */
210 bool stop_when_unneeded;
212 /* Create default dependencies */
213 bool default_dependencies;
215 /* Refuse manual starting, allow starting only indirectly via dependency. */
216 bool refuse_manual_start;
218 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
219 bool refuse_manual_stop;
221 /* Allow isolation requests */
224 /* Isolate OnFailure unit */
225 bool on_failure_isolate;
227 /* Ignore this unit when isolating */
228 bool ignore_on_isolate;
230 /* Ignore this unit when snapshotting */
231 bool ignore_on_snapshot;
233 /* Did the last condition check suceed? */
234 bool condition_result;
236 bool in_load_queue:1;
237 bool in_dbus_queue:1;
238 bool in_cleanup_queue:1;
241 bool sent_dbus_new_signal:1;
249 /* Keeps tracks of references to a unit. This is useful so
250 * that we can merge two units if necessary and correct all
251 * references to them */
254 LIST_FIELDS(UnitRef, refs);
263 #include "automount.h"
264 #include "snapshot.h"
285 /* Config file sections this unit type understands, separated
287 const char *sections;
289 /* This should reset all type-specific variables. This should
290 * not allocate memory, and is called with zero-initialized
291 * data. It should hence only initialize variables that need
293 void (*init)(Unit *u);
295 /* This should free all type-specific variables. It should be
297 void (*done)(Unit *u);
299 /* Actually load data from disk. This may fail, and should set
300 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
301 * UNIT_STUB if no configuration could be found. */
302 int (*load)(Unit *u);
304 /* If a a lot of units got created via enumerate(), this is
305 * where to actually set the state and call unit_notify(). */
306 int (*coldplug)(Unit *u);
308 void (*dump)(Unit *u, FILE *f, const char *prefix);
310 int (*start)(Unit *u);
311 int (*stop)(Unit *u);
312 int (*reload)(Unit *u);
314 int (*kill)(Unit *u, KillWho w, KillMode m, int signo, DBusError *error);
316 bool (*can_reload)(Unit *u);
318 /* Write all data that cannot be restored from other sources
319 * away using unit_serialize_item() */
320 int (*serialize)(Unit *u, FILE *f, FDSet *fds);
322 /* Restore one item from the serialization */
323 int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
325 /* Boils down the more complex internal state of this unit to
326 * a simpler one that the engine can understand */
327 UnitActiveState (*active_state)(Unit *u);
329 /* Returns the substate specific to this unit type as
330 * string. This is purely information so that we can give the
331 * user a more fine grained explanation in which actual state a
333 const char* (*sub_state_to_string)(Unit *u);
335 /* Return true when there is reason to keep this entry around
336 * even nothing references it and it isn't active in any
338 bool (*check_gc)(Unit *u);
340 /* Return true when this unit is suitable for snapshotting */
341 bool (*check_snapshot)(Unit *u);
343 void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
344 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
345 void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
347 /* Check whether unit needs a daemon reload */
348 bool (*need_daemon_reload)(Unit *u);
350 /* Reset failed state if we are in failed state */
351 void (*reset_failed)(Unit *u);
353 /* Called whenever any of the cgroups this unit watches for
355 void (*cgroup_notify_empty)(Unit *u);
357 /* Called whenever a process of this unit sends us a message */
358 void (*notify_message)(Unit *u, pid_t pid, char **tags);
360 /* Called whenever a name thus Unit registered for comes or
362 void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
364 /* Called whenever a bus PID lookup finishes */
365 void (*bus_query_pid_done)(Unit *u, const char *name, pid_t pid);
367 /* Called for each message received on the bus */
368 DBusHandlerResult (*bus_message_handler)(Unit *u, DBusConnection *c, DBusMessage *message);
370 /* Return the unit this unit is following */
371 Unit *(*following)(Unit *u);
373 /* Return the set of units that are following each other */
374 int (*following_set)(Unit *u, Set **s);
376 /* This is called for each unit type and should be used to
377 * enumerate existing devices and load them. However,
378 * everything that is loaded here should still stay in
379 * inactive state. It is the job of the coldplug() call above
380 * to put the units into the initial state. */
381 int (*enumerate)(Manager *m);
383 /* Type specific cleanups. */
384 void (*shutdown)(Manager *m);
386 /* When sending out PropertiesChanged signal, which properties
387 * shall be invalidated? This is a NUL separated list of
388 * strings, to minimize relocations a little. */
389 const char *bus_invalidating_properties;
391 /* The interface name */
392 const char *bus_interface;
394 /* Can units of this type have multiple names? */
397 /* Instances make no sense for this type */
400 /* Exclude from automatic gc */
403 /* Show status updates on the console */
407 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
409 #define UNIT_VTABLE(u) unit_vtable[(u)->meta.type]
411 /* For casting a unit into the various unit types */
412 #define DEFINE_CAST(UPPERCASE, MixedCase) \
413 static inline MixedCase* UPPERCASE(Unit *u) { \
414 if (_unlikely_(!u || u->meta.type != UNIT_##UPPERCASE)) \
417 return (MixedCase*) u; \
420 /* For casting the various unit types into a unit */
421 #define UNIT(u) ((Unit*) (&(u)->meta))
423 DEFINE_CAST(SOCKET, Socket);
424 DEFINE_CAST(TIMER, Timer);
425 DEFINE_CAST(SERVICE, Service);
426 DEFINE_CAST(TARGET, Target);
427 DEFINE_CAST(DEVICE, Device);
428 DEFINE_CAST(MOUNT, Mount);
429 DEFINE_CAST(AUTOMOUNT, Automount);
430 DEFINE_CAST(SNAPSHOT, Snapshot);
431 DEFINE_CAST(SWAP, Swap);
432 DEFINE_CAST(PATH, Path);
434 Unit *unit_new(Manager *m);
435 void unit_free(Unit *u);
437 int unit_add_name(Unit *u, const char *name);
439 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
440 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
442 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
443 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
445 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
446 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
448 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
450 int unit_add_cgroup(Unit *u, CGroupBonding *b);
451 int unit_add_cgroup_from_text(Unit *u, const char *name);
452 int unit_add_default_cgroups(Unit *u);
453 CGroupBonding* unit_get_default_cgroup(Unit *u);
454 int unit_add_cgroup_attribute(Unit *u, const char *controller, const char *name, const char *value, CGroupAttributeMapCallback map_callback);
456 int unit_choose_id(Unit *u, const char *name);
457 int unit_set_description(Unit *u, const char *description);
459 bool unit_check_gc(Unit *u);
461 void unit_add_to_load_queue(Unit *u);
462 void unit_add_to_dbus_queue(Unit *u);
463 void unit_add_to_cleanup_queue(Unit *u);
464 void unit_add_to_gc_queue(Unit *u);
466 int unit_merge(Unit *u, Unit *other);
467 int unit_merge_by_name(Unit *u, const char *other);
469 Unit *unit_follow_merge(Unit *u);
471 int unit_load_fragment_and_dropin(Unit *u);
472 int unit_load_fragment_and_dropin_optional(Unit *u);
473 int unit_load(Unit *unit);
475 const char *unit_description(Unit *u);
477 bool unit_has_name(Unit *u, const char *name);
479 UnitActiveState unit_active_state(Unit *u);
481 const char* unit_sub_state_to_string(Unit *u);
483 void unit_dump(Unit *u, FILE *f, const char *prefix);
485 bool unit_can_reload(Unit *u);
486 bool unit_can_start(Unit *u);
487 bool unit_can_isolate(Unit *u);
489 int unit_start(Unit *u);
490 int unit_stop(Unit *u);
491 int unit_reload(Unit *u);
493 int unit_kill(Unit *u, KillWho w, KillMode m, int signo, DBusError *error);
495 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
497 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
498 void unit_unwatch_fd(Unit *u, Watch *w);
500 int unit_watch_pid(Unit *u, pid_t pid);
501 void unit_unwatch_pid(Unit *u, pid_t pid);
503 int unit_watch_timer(Unit *u, usec_t delay, Watch *w);
504 void unit_unwatch_timer(Unit *u, Watch *w);
506 int unit_watch_bus_name(Unit *u, const char *name);
507 void unit_unwatch_bus_name(Unit *u, const char *name);
509 bool unit_job_is_applicable(Unit *u, JobType j);
511 int set_unit_path(const char *p);
513 char *unit_dbus_path(Unit *u);
515 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
516 int unit_get_related_unit(Unit *u, const char *type, Unit **_found);
518 char *unit_name_printf(Unit *u, const char* text);
519 char *unit_full_printf(Unit *u, const char *text);
520 char **unit_full_printf_strv(Unit *u, char **l);
522 bool unit_can_serialize(Unit *u);
523 int unit_serialize(Unit *u, FILE *f, FDSet *fds);
524 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_attr_(4,5);
525 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
526 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
528 int unit_add_node_link(Unit *u, const char *what, bool wants);
530 int unit_coldplug(Unit *u);
532 void unit_status_printf(Unit *u, const char *status, const char *format, ...);
534 bool unit_need_daemon_reload(Unit *u);
536 void unit_reset_failed(Unit *u);
538 Unit *unit_following(Unit *u);
540 bool unit_pending_inactive(Unit *u);
541 bool unit_pending_active(Unit *u);
543 int unit_add_default_target_dependency(Unit *u, Unit *target);
545 int unit_following_set(Unit *u, Set **s);
547 UnitType unit_name_to_type(const char *n);
548 bool unit_name_is_valid(const char *n, bool template_ok);
550 void unit_trigger_on_failure(Unit *u);
552 bool unit_condition_test(Unit *u);
554 UnitFileState unit_get_unit_file_state(Unit *u);
556 Unit* unit_ref_set(UnitRef *ref, Unit *u);
557 void unit_ref_unset(UnitRef *ref);
559 #define UNIT_DEREF(ref) ((ref).unit)
561 const char *unit_load_state_to_string(UnitLoadState i);
562 UnitLoadState unit_load_state_from_string(const char *s);
564 const char *unit_active_state_to_string(UnitActiveState i);
565 UnitActiveState unit_active_state_from_string(const char *s);
567 const char *unit_dependency_to_string(UnitDependency i);
568 UnitDependency unit_dependency_from_string(const char *s);