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;
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 /* Reference information for GC logic */
123 UNIT_REFERENCES, /* Inverse of 'references' is 'referenced_by' */
126 _UNIT_DEPENDENCY_MAX,
127 _UNIT_DEPENDENCY_INVALID = -1
133 #include "cgroup-attr.h"
139 UnitLoadState load_state;
142 char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
146 Set *dependencies[_UNIT_DEPENDENCY_MAX];
150 char *fragment_path; /* if loaded from a config file this is the primary path to it */
151 usec_t fragment_mtime;
153 /* If there is something to do with this unit, then this is
159 /* Conditions to check */
160 LIST_HEAD(Condition, conditions);
162 dual_timestamp condition_timestamp;
164 dual_timestamp inactive_exit_timestamp;
165 dual_timestamp active_enter_timestamp;
166 dual_timestamp active_exit_timestamp;
167 dual_timestamp inactive_enter_timestamp;
169 /* Counterparts in the cgroup filesystem */
170 CGroupBonding *cgroup_bondings;
171 CGroupAttribute *cgroup_attributes;
174 LIST_FIELDS(Meta, units_by_type);
177 LIST_FIELDS(Meta, load_queue);
180 LIST_FIELDS(Meta, dbus_queue);
183 LIST_FIELDS(Meta, cleanup_queue);
186 LIST_FIELDS(Meta, gc_queue);
188 /* Used during GC sweeps */
191 /* When deserializing, temporarily store the job type for this
192 * unit here, if there was a job scheduled */
193 int deserialized_job; /* This is actually of type JobType */
195 /* Error code when we didn't manage to load the unit (negative) */
198 /* Cached unit file state */
199 UnitFileState unit_file_state;
201 /* Garbage collect us we nobody wants or requires us anymore */
202 bool stop_when_unneeded;
204 /* Create default dependencies */
205 bool default_dependencies;
207 /* Refuse manual starting, allow starting only indirectly via dependency. */
208 bool refuse_manual_start;
210 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
211 bool refuse_manual_stop;
213 /* Allow isolation requests */
216 /* Isolate OnFailure unit */
217 bool on_failure_isolate;
219 /* Ignore this unit when isolating */
220 bool ignore_on_isolate;
222 /* Ignore this unit when snapshotting */
223 bool ignore_on_snapshot;
225 /* Did the last condition check suceed? */
226 bool condition_result;
228 bool in_load_queue:1;
229 bool in_dbus_queue:1;
230 bool in_cleanup_queue:1;
233 bool sent_dbus_new_signal:1;
246 #include "automount.h"
247 #include "snapshot.h"
268 /* Config file sections this unit type understands, separated
270 const char *sections;
272 /* This should reset all type-specific variables. This should
273 * not allocate memory, and is called with zero-initialized
274 * data. It should hence only initialize variables that need
276 void (*init)(Unit *u);
278 /* This should free all type-specific variables. It should be
280 void (*done)(Unit *u);
282 /* Actually load data from disk. This may fail, and should set
283 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
284 * UNIT_STUB if no configuration could be found. */
285 int (*load)(Unit *u);
287 /* If a a lot of units got created via enumerate(), this is
288 * where to actually set the state and call unit_notify(). */
289 int (*coldplug)(Unit *u);
291 void (*dump)(Unit *u, FILE *f, const char *prefix);
293 int (*start)(Unit *u);
294 int (*stop)(Unit *u);
295 int (*reload)(Unit *u);
297 int (*kill)(Unit *u, KillWho w, KillMode m, int signo, DBusError *error);
299 bool (*can_reload)(Unit *u);
301 /* Write all data that cannot be restored from other sources
302 * away using unit_serialize_item() */
303 int (*serialize)(Unit *u, FILE *f, FDSet *fds);
305 /* Restore one item from the serialization */
306 int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
308 /* Boils down the more complex internal state of this unit to
309 * a simpler one that the engine can understand */
310 UnitActiveState (*active_state)(Unit *u);
312 /* Returns the substate specific to this unit type as
313 * string. This is purely information so that we can give the
314 * user a more fine grained explanation in which actual state a
316 const char* (*sub_state_to_string)(Unit *u);
318 /* Return true when there is reason to keep this entry around
319 * even nothing references it and it isn't active in any
321 bool (*check_gc)(Unit *u);
323 /* Return true when this unit is suitable for snapshotting */
324 bool (*check_snapshot)(Unit *u);
326 void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
327 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
328 void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
330 /* Check whether unit needs a daemon reload */
331 bool (*need_daemon_reload)(Unit *u);
333 /* Reset failed state if we are in failed state */
334 void (*reset_failed)(Unit *u);
336 /* Called whenever any of the cgroups this unit watches for
338 void (*cgroup_notify_empty)(Unit *u);
340 /* Called whenever a process of this unit sends us a message */
341 void (*notify_message)(Unit *u, pid_t pid, char **tags);
343 /* Called whenever a name thus Unit registered for comes or
345 void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
347 /* Called whenever a bus PID lookup finishes */
348 void (*bus_query_pid_done)(Unit *u, const char *name, pid_t pid);
350 /* Called for each message received on the bus */
351 DBusHandlerResult (*bus_message_handler)(Unit *u, DBusConnection *c, DBusMessage *message);
353 /* Return the unit this unit is following */
354 Unit *(*following)(Unit *u);
356 /* Return the set of units that are following each other */
357 int (*following_set)(Unit *u, Set **s);
359 /* This is called for each unit type and should be used to
360 * enumerate existing devices and load them. However,
361 * everything that is loaded here should still stay in
362 * inactive state. It is the job of the coldplug() call above
363 * to put the units into the initial state. */
364 int (*enumerate)(Manager *m);
366 /* Type specific cleanups. */
367 void (*shutdown)(Manager *m);
369 /* When sending out PropertiesChanged signal, which properties
370 * shall be invalidated? This is a NUL separated list of
371 * strings, to minimize relocations a little. */
372 const char *bus_invalidating_properties;
374 /* The interface name */
375 const char *bus_interface;
377 /* Can units of this type have multiple names? */
380 /* Instances make no sense for this type */
383 /* Exclude from automatic gc */
386 /* Show status updates on the console */
390 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
392 #define UNIT_VTABLE(u) unit_vtable[(u)->meta.type]
394 /* For casting a unit into the various unit types */
395 #define DEFINE_CAST(UPPERCASE, MixedCase) \
396 static inline MixedCase* UPPERCASE(Unit *u) { \
397 if (_unlikely_(!u || u->meta.type != UNIT_##UPPERCASE)) \
400 return (MixedCase*) u; \
403 /* For casting the various unit types into a unit */
404 #define UNIT(u) ((Unit*) (&(u)->meta))
406 DEFINE_CAST(SOCKET, Socket);
407 DEFINE_CAST(TIMER, Timer);
408 DEFINE_CAST(SERVICE, Service);
409 DEFINE_CAST(TARGET, Target);
410 DEFINE_CAST(DEVICE, Device);
411 DEFINE_CAST(MOUNT, Mount);
412 DEFINE_CAST(AUTOMOUNT, Automount);
413 DEFINE_CAST(SNAPSHOT, Snapshot);
414 DEFINE_CAST(SWAP, Swap);
415 DEFINE_CAST(PATH, Path);
417 Unit *unit_new(Manager *m);
418 void unit_free(Unit *u);
420 int unit_add_name(Unit *u, const char *name);
422 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
423 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
425 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
426 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
428 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
429 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
431 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
433 int unit_add_cgroup(Unit *u, CGroupBonding *b);
434 int unit_add_cgroup_from_text(Unit *u, const char *name);
435 int unit_add_default_cgroups(Unit *u);
436 CGroupBonding* unit_get_default_cgroup(Unit *u);
437 int unit_add_cgroup_attribute(Unit *u, const char *controller, const char *name, const char *value, CGroupAttributeMapCallback map_callback);
439 int unit_choose_id(Unit *u, const char *name);
440 int unit_set_description(Unit *u, const char *description);
442 bool unit_check_gc(Unit *u);
444 void unit_add_to_load_queue(Unit *u);
445 void unit_add_to_dbus_queue(Unit *u);
446 void unit_add_to_cleanup_queue(Unit *u);
447 void unit_add_to_gc_queue(Unit *u);
449 int unit_merge(Unit *u, Unit *other);
450 int unit_merge_by_name(Unit *u, const char *other);
452 Unit *unit_follow_merge(Unit *u);
454 int unit_load_fragment_and_dropin(Unit *u);
455 int unit_load_fragment_and_dropin_optional(Unit *u);
456 int unit_load(Unit *unit);
458 const char *unit_description(Unit *u);
460 bool unit_has_name(Unit *u, const char *name);
462 UnitActiveState unit_active_state(Unit *u);
464 const char* unit_sub_state_to_string(Unit *u);
466 void unit_dump(Unit *u, FILE *f, const char *prefix);
468 bool unit_can_reload(Unit *u);
469 bool unit_can_start(Unit *u);
470 bool unit_can_isolate(Unit *u);
472 int unit_start(Unit *u);
473 int unit_stop(Unit *u);
474 int unit_reload(Unit *u);
476 int unit_kill(Unit *u, KillWho w, KillMode m, int signo, DBusError *error);
478 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
480 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
481 void unit_unwatch_fd(Unit *u, Watch *w);
483 int unit_watch_pid(Unit *u, pid_t pid);
484 void unit_unwatch_pid(Unit *u, pid_t pid);
486 int unit_watch_timer(Unit *u, usec_t delay, Watch *w);
487 void unit_unwatch_timer(Unit *u, Watch *w);
489 int unit_watch_bus_name(Unit *u, const char *name);
490 void unit_unwatch_bus_name(Unit *u, const char *name);
492 bool unit_job_is_applicable(Unit *u, JobType j);
494 int set_unit_path(const char *p);
496 char *unit_dbus_path(Unit *u);
498 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
499 int unit_get_related_unit(Unit *u, const char *type, Unit **_found);
501 char *unit_name_printf(Unit *u, const char* text);
502 char *unit_full_printf(Unit *u, const char *text);
503 char **unit_full_printf_strv(Unit *u, char **l);
505 bool unit_can_serialize(Unit *u);
506 int unit_serialize(Unit *u, FILE *f, FDSet *fds);
507 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_attr_(4,5);
508 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
509 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
511 int unit_add_node_link(Unit *u, const char *what, bool wants);
513 int unit_coldplug(Unit *u);
515 void unit_status_printf(Unit *u, const char *format, ...);
517 bool unit_need_daemon_reload(Unit *u);
519 void unit_reset_failed(Unit *u);
521 Unit *unit_following(Unit *u);
523 bool unit_pending_inactive(Unit *u);
524 bool unit_pending_active(Unit *u);
526 int unit_add_default_target_dependency(Unit *u, Unit *target);
528 int unit_following_set(Unit *u, Set **s);
530 UnitType unit_name_to_type(const char *n);
531 bool unit_name_is_valid(const char *n, bool template_ok);
533 void unit_trigger_on_failure(Unit *u);
535 bool unit_condition_test(Unit *u);
537 UnitFileState unit_get_unit_file_state(Unit *u);
539 const char *unit_load_state_to_string(UnitLoadState i);
540 UnitLoadState unit_load_state_from_string(const char *s);
542 const char *unit_active_state_to_string(UnitActiveState i);
543 UnitActiveState unit_active_state_from_string(const char *s);
545 const char *unit_dependency_to_string(UnitDependency i);
546 UnitDependency unit_dependency_from_string(const char *s);