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"
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];
157 char **requires_mounts_for;
160 char **documentation;
162 char *fragment_path; /* if loaded from a config file this is the primary path to it */
163 char *source_path; /* if converted, the source file */
164 usec_t fragment_mtime;
167 /* If there is something to do with this unit, then this is the installed job for it */
170 /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
175 /* References to this */
176 LIST_HEAD(UnitRef, refs);
178 /* Conditions to check */
179 LIST_HEAD(Condition, conditions);
181 dual_timestamp condition_timestamp;
183 dual_timestamp inactive_exit_timestamp;
184 dual_timestamp active_enter_timestamp;
185 dual_timestamp active_exit_timestamp;
186 dual_timestamp inactive_enter_timestamp;
188 /* Counterparts in the cgroup filesystem */
189 CGroupBonding *cgroup_bondings;
190 CGroupAttribute *cgroup_attributes;
193 LIST_FIELDS(Unit, units_by_type);
195 /* All units which have requires_mounts_for set */
196 LIST_FIELDS(Unit, has_requires_mounts_for);
199 LIST_FIELDS(Unit, load_queue);
202 LIST_FIELDS(Unit, dbus_queue);
205 LIST_FIELDS(Unit, cleanup_queue);
208 LIST_FIELDS(Unit, gc_queue);
210 /* Used during GC sweeps */
213 /* When deserializing, temporarily store the job type for this
214 * unit here, if there was a job scheduled.
215 * Only for deserializing from a legacy version. New style uses full
216 * serialized jobs. */
217 int deserialized_job; /* This is actually of type JobType */
219 /* Error code when we didn't manage to load the unit (negative) */
222 /* Cached unit file state */
223 UnitFileState unit_file_state;
225 /* Garbage collect us we nobody wants or requires us anymore */
226 bool stop_when_unneeded;
228 /* Create default dependencies */
229 bool default_dependencies;
231 /* Refuse manual starting, allow starting only indirectly via dependency. */
232 bool refuse_manual_start;
234 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
235 bool refuse_manual_stop;
237 /* Allow isolation requests */
240 /* Isolate OnFailure unit */
241 bool on_failure_isolate;
243 /* Ignore this unit when isolating */
244 bool ignore_on_isolate;
246 /* Ignore this unit when snapshotting */
247 bool ignore_on_snapshot;
249 /* Did the last condition check suceed? */
250 bool condition_result;
252 bool in_load_queue:1;
253 bool in_dbus_queue:1;
254 bool in_cleanup_queue:1;
257 bool sent_dbus_new_signal:1;
265 /* Keeps tracks of references to a unit. This is useful so
266 * that we can merge two units if necessary and correct all
267 * references to them */
270 LIST_FIELDS(UnitRef, refs);
273 struct UnitStatusMessageFormats {
274 const char *starting_stopping[2];
275 const char *finished_start_job[_JOB_RESULT_MAX];
276 const char *finished_stop_job[_JOB_RESULT_MAX];
285 #include "automount.h"
286 #include "snapshot.h"
293 /* How much memory does an object of this unit type need */
296 /* Config file sections this unit type understands, separated
298 const char *sections;
300 /* This should reset all type-specific variables. This should
301 * not allocate memory, and is called with zero-initialized
302 * data. It should hence only initialize variables that need
304 void (*init)(Unit *u);
306 /* This should free all type-specific variables. It should be
308 void (*done)(Unit *u);
310 /* Actually load data from disk. This may fail, and should set
311 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
312 * UNIT_STUB if no configuration could be found. */
313 int (*load)(Unit *u);
315 /* If a a lot of units got created via enumerate(), this is
316 * where to actually set the state and call unit_notify(). */
317 int (*coldplug)(Unit *u);
319 void (*dump)(Unit *u, FILE *f, const char *prefix);
321 int (*start)(Unit *u);
322 int (*stop)(Unit *u);
323 int (*reload)(Unit *u);
325 int (*kill)(Unit *u, KillWho w, KillMode m, int signo, DBusError *error);
327 bool (*can_reload)(Unit *u);
329 /* Write all data that cannot be restored from other sources
330 * away using unit_serialize_item() */
331 int (*serialize)(Unit *u, FILE *f, FDSet *fds);
333 /* Restore one item from the serialization */
334 int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
336 /* Boils down the more complex internal state of this unit to
337 * a simpler one that the engine can understand */
338 UnitActiveState (*active_state)(Unit *u);
340 /* Returns the substate specific to this unit type as
341 * string. This is purely information so that we can give the
342 * user a more fine grained explanation in which actual state a
344 const char* (*sub_state_to_string)(Unit *u);
346 /* Return true when there is reason to keep this entry around
347 * even nothing references it and it isn't active in any
349 bool (*check_gc)(Unit *u);
351 /* Return true when this unit is suitable for snapshotting */
352 bool (*check_snapshot)(Unit *u);
354 void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
355 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
356 void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
358 /* Reset failed state if we are in failed state */
359 void (*reset_failed)(Unit *u);
361 /* Called whenever any of the cgroups this unit watches for
363 void (*cgroup_notify_empty)(Unit *u);
365 /* Called whenever a process of this unit sends us a message */
366 void (*notify_message)(Unit *u, pid_t pid, char **tags);
368 /* Called whenever a name thus Unit registered for comes or
370 void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
372 /* Called whenever a bus PID lookup finishes */
373 void (*bus_query_pid_done)(Unit *u, const char *name, pid_t pid);
375 /* Called for each message received on the bus */
376 DBusHandlerResult (*bus_message_handler)(Unit *u, DBusConnection *c, DBusMessage *message);
378 /* Return the unit this unit is following */
379 Unit *(*following)(Unit *u);
381 /* Return the set of units that are following each other */
382 int (*following_set)(Unit *u, Set **s);
384 /* This is called for each unit type and should be used to
385 * enumerate existing devices and load them. However,
386 * everything that is loaded here should still stay in
387 * inactive state. It is the job of the coldplug() call above
388 * to put the units into the initial state. */
389 int (*enumerate)(Manager *m);
391 /* Type specific cleanups. */
392 void (*shutdown)(Manager *m);
394 /* When sending out PropertiesChanged signal, which properties
395 * shall be invalidated? This is a NUL separated list of
396 * strings, to minimize relocations a little. */
397 const char *bus_invalidating_properties;
399 /* The interface name */
400 const char *bus_interface;
402 UnitStatusMessageFormats status_message_formats;
404 /* Can units of this type have multiple names? */
407 /* Instances make no sense for this type */
410 /* Exclude from automatic gc */
414 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
416 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
418 /* For casting a unit into the various unit types */
419 #define DEFINE_CAST(UPPERCASE, MixedCase) \
420 static inline MixedCase* UPPERCASE(Unit *u) { \
421 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
424 return (MixedCase*) u; \
427 /* For casting the various unit types into a unit */
428 #define UNIT(u) (&(u)->meta)
430 DEFINE_CAST(SOCKET, Socket);
431 DEFINE_CAST(TIMER, Timer);
432 DEFINE_CAST(SERVICE, Service);
433 DEFINE_CAST(TARGET, Target);
434 DEFINE_CAST(DEVICE, Device);
435 DEFINE_CAST(MOUNT, Mount);
436 DEFINE_CAST(AUTOMOUNT, Automount);
437 DEFINE_CAST(SNAPSHOT, Snapshot);
438 DEFINE_CAST(SWAP, Swap);
439 DEFINE_CAST(PATH, Path);
441 Unit *unit_new(Manager *m, size_t size);
442 void unit_free(Unit *u);
444 int unit_add_name(Unit *u, const char *name);
446 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
447 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
449 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
450 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
452 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
453 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
455 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
457 int unit_add_cgroup(Unit *u, CGroupBonding *b);
458 int unit_add_cgroup_from_text(Unit *u, const char *name);
459 int unit_add_default_cgroups(Unit *u);
460 CGroupBonding* unit_get_default_cgroup(Unit *u);
461 int unit_add_cgroup_attribute(Unit *u, const char *controller, const char *name, const char *value, CGroupAttributeMapCallback map_callback);
463 int unit_choose_id(Unit *u, const char *name);
464 int unit_set_description(Unit *u, const char *description);
466 bool unit_check_gc(Unit *u);
468 void unit_add_to_load_queue(Unit *u);
469 void unit_add_to_dbus_queue(Unit *u);
470 void unit_add_to_cleanup_queue(Unit *u);
471 void unit_add_to_gc_queue(Unit *u);
473 int unit_merge(Unit *u, Unit *other);
474 int unit_merge_by_name(Unit *u, const char *other);
476 Unit *unit_follow_merge(Unit *u);
478 int unit_load_fragment_and_dropin(Unit *u);
479 int unit_load_fragment_and_dropin_optional(Unit *u);
480 int unit_load(Unit *unit);
482 const char *unit_description(Unit *u);
484 bool unit_has_name(Unit *u, const char *name);
486 UnitActiveState unit_active_state(Unit *u);
488 const char* unit_sub_state_to_string(Unit *u);
490 void unit_dump(Unit *u, FILE *f, const char *prefix);
492 bool unit_can_reload(Unit *u);
493 bool unit_can_start(Unit *u);
494 bool unit_can_isolate(Unit *u);
496 int unit_start(Unit *u);
497 int unit_stop(Unit *u);
498 int unit_reload(Unit *u);
500 int unit_kill(Unit *u, KillWho w, KillMode m, int signo, DBusError *error);
502 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
504 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
505 void unit_unwatch_fd(Unit *u, Watch *w);
507 int unit_watch_pid(Unit *u, pid_t pid);
508 void unit_unwatch_pid(Unit *u, pid_t pid);
510 int unit_watch_timer(Unit *u, usec_t delay, Watch *w);
511 void unit_unwatch_timer(Unit *u, Watch *w);
513 int unit_watch_bus_name(Unit *u, const char *name);
514 void unit_unwatch_bus_name(Unit *u, const char *name);
516 bool unit_job_is_applicable(Unit *u, JobType j);
518 int set_unit_path(const char *p);
520 char *unit_dbus_path(Unit *u);
522 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
523 int unit_get_related_unit(Unit *u, const char *type, Unit **_found);
525 char *unit_name_printf(Unit *u, const char* text);
526 char *unit_full_printf(Unit *u, const char *text);
527 char **unit_full_printf_strv(Unit *u, char **l);
529 bool unit_can_serialize(Unit *u);
530 int unit_serialize(Unit *u, FILE *f, FDSet *fds);
531 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_attr_(4,5);
532 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
533 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
535 int unit_add_node_link(Unit *u, const char *what, bool wants);
537 int unit_coldplug(Unit *u);
539 void unit_status_printf(Unit *u, const char *status, const char *format, ...);
541 bool unit_need_daemon_reload(Unit *u);
543 void unit_reset_failed(Unit *u);
545 Unit *unit_following(Unit *u);
547 bool unit_pending_inactive(Unit *u);
548 bool unit_pending_active(Unit *u);
550 int unit_add_default_target_dependency(Unit *u, Unit *target);
552 int unit_following_set(Unit *u, Set **s);
554 UnitType unit_name_to_type(const char *n);
555 bool unit_name_is_valid(const char *n, bool template_ok);
557 void unit_trigger_on_failure(Unit *u);
559 bool unit_condition_test(Unit *u);
561 UnitFileState unit_get_unit_file_state(Unit *u);
563 Unit* unit_ref_set(UnitRef *ref, Unit *u);
564 void unit_ref_unset(UnitRef *ref);
566 #define UNIT_DEREF(ref) ((ref).unit)
568 int unit_add_one_mount_link(Unit *u, Mount *m);
569 int unit_add_mount_links(Unit *u);
571 const char *unit_load_state_to_string(UnitLoadState i);
572 UnitLoadState unit_load_state_from_string(const char *s);
574 const char *unit_active_state_to_string(UnitActiveState i);
575 UnitActiveState unit_active_state_from_string(const char *s);
577 const char *unit_dependency_to_string(UnitDependency i);
578 UnitDependency unit_dependency_from_string(const char *s);