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 UnitActiveState UnitActiveState;
32 typedef enum UnitDependency UnitDependency;
33 typedef struct UnitRef UnitRef;
34 typedef struct UnitStatusMessageFormats UnitStatusMessageFormats;
39 #include "socket-util.h"
41 #include "condition.h"
43 #include "unit-name.h"
45 enum UnitActiveState {
52 _UNIT_ACTIVE_STATE_MAX,
53 _UNIT_ACTIVE_STATE_INVALID = -1
56 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) {
57 return t == UNIT_ACTIVE || t == UNIT_RELOADING;
60 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) {
61 return t == UNIT_ACTIVE || t == UNIT_ACTIVATING || t == UNIT_RELOADING;
64 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) {
65 return t == UNIT_INACTIVE || t == UNIT_FAILED || t == UNIT_DEACTIVATING;
68 static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t) {
69 return t == UNIT_INACTIVE || t == UNIT_FAILED;
73 /* Positive dependencies */
75 UNIT_REQUIRES_OVERRIDABLE,
77 UNIT_REQUISITE_OVERRIDABLE,
81 /* Inverse of the above */
82 UNIT_REQUIRED_BY, /* inverse of 'requires' and 'requisite' is 'required_by' */
83 UNIT_REQUIRED_BY_OVERRIDABLE, /* inverse of 'requires_overridable' and 'requisite_overridable' is 'soft_required_by' */
84 UNIT_WANTED_BY, /* inverse of 'wants' */
85 UNIT_BOUND_BY, /* inverse of 'bind_to' */
87 /* Negative dependencies */
88 UNIT_CONFLICTS, /* inverse of 'conflicts' is 'conflicted_by' */
92 UNIT_BEFORE, /* inverse of 'before' is 'after' and vice versa */
98 /* Triggers (i.e. a socket triggers a service) */
102 /* Propagate reloads */
103 UNIT_PROPAGATE_RELOAD_TO,
104 UNIT_PROPAGATE_RELOAD_FROM,
106 /* Reference information for GC logic */
107 UNIT_REFERENCES, /* Inverse of 'references' is 'referenced_by' */
110 _UNIT_DEPENDENCY_MAX,
111 _UNIT_DEPENDENCY_INVALID = -1
117 #include "cgroup-attr.h"
123 UnitLoadState load_state;
126 char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
130 Set *dependencies[_UNIT_DEPENDENCY_MAX];
132 char **requires_mounts_for;
135 char **documentation;
137 char *fragment_path; /* if loaded from a config file this is the primary path to it */
138 char *source_path; /* if converted, the source file */
139 usec_t fragment_mtime;
142 /* If there is something to do with this unit, then this is the installed job for it */
145 /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
150 /* References to this */
151 LIST_HEAD(UnitRef, refs);
153 /* Conditions to check */
154 LIST_HEAD(Condition, conditions);
156 dual_timestamp condition_timestamp;
158 dual_timestamp inactive_exit_timestamp;
159 dual_timestamp active_enter_timestamp;
160 dual_timestamp active_exit_timestamp;
161 dual_timestamp inactive_enter_timestamp;
163 /* Counterparts in the cgroup filesystem */
164 CGroupBonding *cgroup_bondings;
165 CGroupAttribute *cgroup_attributes;
168 LIST_FIELDS(Unit, units_by_type);
170 /* All units which have requires_mounts_for set */
171 LIST_FIELDS(Unit, has_requires_mounts_for);
174 LIST_FIELDS(Unit, load_queue);
177 LIST_FIELDS(Unit, dbus_queue);
180 LIST_FIELDS(Unit, cleanup_queue);
183 LIST_FIELDS(Unit, 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 * Only for deserializing from a legacy version. New style uses full
191 * serialized jobs. */
192 int deserialized_job; /* This is actually of type JobType */
194 /* Error code when we didn't manage to load the unit (negative) */
197 /* Cached unit file state */
198 UnitFileState unit_file_state;
200 /* Garbage collect us we nobody wants or requires us anymore */
201 bool stop_when_unneeded;
203 /* Create default dependencies */
204 bool default_dependencies;
206 /* Refuse manual starting, allow starting only indirectly via dependency. */
207 bool refuse_manual_start;
209 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
210 bool refuse_manual_stop;
212 /* Allow isolation requests */
215 /* Isolate OnFailure unit */
216 bool on_failure_isolate;
218 /* Ignore this unit when isolating */
219 bool ignore_on_isolate;
221 /* Ignore this unit when snapshotting */
222 bool ignore_on_snapshot;
224 /* Did the last condition check suceed? */
225 bool condition_result;
227 bool in_load_queue:1;
228 bool in_dbus_queue:1;
229 bool in_cleanup_queue:1;
232 bool sent_dbus_new_signal:1;
240 /* Keeps tracks of references to a unit. This is useful so
241 * that we can merge two units if necessary and correct all
242 * references to them */
245 LIST_FIELDS(UnitRef, refs);
248 struct UnitStatusMessageFormats {
249 const char *starting_stopping[2];
250 const char *finished_start_job[_JOB_RESULT_MAX];
251 const char *finished_stop_job[_JOB_RESULT_MAX];
260 #include "automount.h"
261 #include "snapshot.h"
266 /* How much memory does an object of this unit type need */
269 /* Config file sections this unit type understands, separated
271 const char *sections;
273 /* This should reset all type-specific variables. This should
274 * not allocate memory, and is called with zero-initialized
275 * data. It should hence only initialize variables that need
277 void (*init)(Unit *u);
279 /* This should free all type-specific variables. It should be
281 void (*done)(Unit *u);
283 /* Actually load data from disk. This may fail, and should set
284 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
285 * UNIT_STUB if no configuration could be found. */
286 int (*load)(Unit *u);
288 /* If a a lot of units got created via enumerate(), this is
289 * where to actually set the state and call unit_notify(). */
290 int (*coldplug)(Unit *u);
292 void (*dump)(Unit *u, FILE *f, const char *prefix);
294 int (*start)(Unit *u);
295 int (*stop)(Unit *u);
296 int (*reload)(Unit *u);
298 int (*kill)(Unit *u, KillWho w, KillMode m, int signo, DBusError *error);
300 bool (*can_reload)(Unit *u);
302 /* Write all data that cannot be restored from other sources
303 * away using unit_serialize_item() */
304 int (*serialize)(Unit *u, FILE *f, FDSet *fds);
306 /* Restore one item from the serialization */
307 int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
309 /* Boils down the more complex internal state of this unit to
310 * a simpler one that the engine can understand */
311 UnitActiveState (*active_state)(Unit *u);
313 /* Returns the substate specific to this unit type as
314 * string. This is purely information so that we can give the
315 * user a more fine grained explanation in which actual state a
317 const char* (*sub_state_to_string)(Unit *u);
319 /* Return true when there is reason to keep this entry around
320 * even nothing references it and it isn't active in any
322 bool (*check_gc)(Unit *u);
324 /* Return true when this unit is suitable for snapshotting */
325 bool (*check_snapshot)(Unit *u);
327 void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
328 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
329 void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
331 /* Reset failed state if we are in failed state */
332 void (*reset_failed)(Unit *u);
334 /* Called whenever any of the cgroups this unit watches for
336 void (*cgroup_notify_empty)(Unit *u);
338 /* Called whenever a process of this unit sends us a message */
339 void (*notify_message)(Unit *u, pid_t pid, char **tags);
341 /* Called whenever a name thus Unit registered for comes or
343 void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
345 /* Called whenever a bus PID lookup finishes */
346 void (*bus_query_pid_done)(Unit *u, const char *name, pid_t pid);
348 /* Called for each message received on the bus */
349 DBusHandlerResult (*bus_message_handler)(Unit *u, DBusConnection *c, DBusMessage *message);
351 /* Return the unit this unit is following */
352 Unit *(*following)(Unit *u);
354 /* Return the set of units that are following each other */
355 int (*following_set)(Unit *u, Set **s);
357 /* This is called for each unit type and should be used to
358 * enumerate existing devices and load them. However,
359 * everything that is loaded here should still stay in
360 * inactive state. It is the job of the coldplug() call above
361 * to put the units into the initial state. */
362 int (*enumerate)(Manager *m);
364 /* Type specific cleanups. */
365 void (*shutdown)(Manager *m);
367 /* When sending out PropertiesChanged signal, which properties
368 * shall be invalidated? This is a NUL separated list of
369 * strings, to minimize relocations a little. */
370 const char *bus_invalidating_properties;
372 /* The interface name */
373 const char *bus_interface;
375 UnitStatusMessageFormats status_message_formats;
377 /* Can units of this type have multiple names? */
380 /* Instances make no sense for this type */
383 /* Exclude from automatic gc */
387 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
389 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
391 /* For casting a unit into the various unit types */
392 #define DEFINE_CAST(UPPERCASE, MixedCase) \
393 static inline MixedCase* UPPERCASE(Unit *u) { \
394 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
397 return (MixedCase*) u; \
400 /* For casting the various unit types into a unit */
401 #define UNIT(u) (&(u)->meta)
403 DEFINE_CAST(SOCKET, Socket);
404 DEFINE_CAST(TIMER, Timer);
405 DEFINE_CAST(SERVICE, Service);
406 DEFINE_CAST(TARGET, Target);
407 DEFINE_CAST(DEVICE, Device);
408 DEFINE_CAST(MOUNT, Mount);
409 DEFINE_CAST(AUTOMOUNT, Automount);
410 DEFINE_CAST(SNAPSHOT, Snapshot);
411 DEFINE_CAST(SWAP, Swap);
412 DEFINE_CAST(PATH, Path);
414 Unit *unit_new(Manager *m, size_t size);
415 void unit_free(Unit *u);
417 int unit_add_name(Unit *u, const char *name);
419 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
420 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
422 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
423 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
425 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
426 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
428 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
430 int unit_add_cgroup(Unit *u, CGroupBonding *b);
431 int unit_add_cgroup_from_text(Unit *u, const char *name);
432 int unit_add_default_cgroups(Unit *u);
433 CGroupBonding* unit_get_default_cgroup(Unit *u);
434 int unit_add_cgroup_attribute(Unit *u, const char *controller, const char *name, const char *value, CGroupAttributeMapCallback map_callback);
436 int unit_choose_id(Unit *u, const char *name);
437 int unit_set_description(Unit *u, const char *description);
439 bool unit_check_gc(Unit *u);
441 void unit_add_to_load_queue(Unit *u);
442 void unit_add_to_dbus_queue(Unit *u);
443 void unit_add_to_cleanup_queue(Unit *u);
444 void unit_add_to_gc_queue(Unit *u);
446 int unit_merge(Unit *u, Unit *other);
447 int unit_merge_by_name(Unit *u, const char *other);
449 Unit *unit_follow_merge(Unit *u);
451 int unit_load_fragment_and_dropin(Unit *u);
452 int unit_load_fragment_and_dropin_optional(Unit *u);
453 int unit_load(Unit *unit);
455 const char *unit_description(Unit *u);
457 bool unit_has_name(Unit *u, const char *name);
459 UnitActiveState unit_active_state(Unit *u);
461 const char* unit_sub_state_to_string(Unit *u);
463 void unit_dump(Unit *u, FILE *f, const char *prefix);
465 bool unit_can_reload(Unit *u);
466 bool unit_can_start(Unit *u);
467 bool unit_can_isolate(Unit *u);
469 int unit_start(Unit *u);
470 int unit_stop(Unit *u);
471 int unit_reload(Unit *u);
473 int unit_kill(Unit *u, KillWho w, KillMode m, int signo, DBusError *error);
475 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
477 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
478 void unit_unwatch_fd(Unit *u, Watch *w);
480 int unit_watch_pid(Unit *u, pid_t pid);
481 void unit_unwatch_pid(Unit *u, pid_t pid);
483 int unit_watch_timer(Unit *u, usec_t delay, Watch *w);
484 void unit_unwatch_timer(Unit *u, Watch *w);
486 int unit_watch_bus_name(Unit *u, const char *name);
487 void unit_unwatch_bus_name(Unit *u, const char *name);
489 bool unit_job_is_applicable(Unit *u, JobType j);
491 int set_unit_path(const char *p);
493 char *unit_dbus_path(Unit *u);
495 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
496 int unit_get_related_unit(Unit *u, const char *type, Unit **_found);
498 char *unit_name_printf(Unit *u, const char* text);
499 char *unit_full_printf(Unit *u, const char *text);
500 char **unit_full_printf_strv(Unit *u, char **l);
502 bool unit_can_serialize(Unit *u);
503 int unit_serialize(Unit *u, FILE *f, FDSet *fds);
504 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_attr_(4,5);
505 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
506 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
508 int unit_add_node_link(Unit *u, const char *what, bool wants);
510 int unit_coldplug(Unit *u);
512 void unit_status_printf(Unit *u, const char *status, const char *format, ...);
514 bool unit_need_daemon_reload(Unit *u);
516 void unit_reset_failed(Unit *u);
518 Unit *unit_following(Unit *u);
520 bool unit_pending_inactive(Unit *u);
521 bool unit_pending_active(Unit *u);
523 int unit_add_default_target_dependency(Unit *u, Unit *target);
525 int unit_following_set(Unit *u, Set **s);
527 void unit_trigger_on_failure(Unit *u);
529 bool unit_condition_test(Unit *u);
531 UnitFileState unit_get_unit_file_state(Unit *u);
533 Unit* unit_ref_set(UnitRef *ref, Unit *u);
534 void unit_ref_unset(UnitRef *ref);
536 #define UNIT_DEREF(ref) ((ref).unit)
538 int unit_add_one_mount_link(Unit *u, Mount *m);
539 int unit_add_mount_links(Unit *u);
541 const char *unit_active_state_to_string(UnitActiveState i);
542 UnitActiveState unit_active_state_from_string(const char *s);
544 const char *unit_dependency_to_string(UnitDependency i);
545 UnitDependency unit_dependency_from_string(const char *s);