1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
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"
42 #define UNIT_NAME_MAX 256
43 #define DEFAULT_TIMEOUT_USEC (60*USEC_PER_SEC)
44 #define DEFAULT_RESTART_USEC (100*USEC_PER_MSEC)
58 _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_MAINTENANCE || t == UNIT_DEACTIVATING;
93 static inline bool UNIT_IS_INACTIVE_OR_MAINTENANCE(UnitActiveState t) {
94 return t == UNIT_INACTIVE || t == UNIT_MAINTENANCE;
98 /* Positive dependencies */
100 UNIT_REQUIRES_OVERRIDABLE,
102 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 'soft_requires' and 'soft_requisite' is 'soft_required_by' */
108 UNIT_WANTED_BY, /* inverse of 'wants' */
110 /* Negative dependencies */
111 UNIT_CONFLICTS, /* inverse of 'conflicts' is 'conflicts' */
114 UNIT_BEFORE, /* inverse of 'before' is 'after' and vice versa */
120 /* Reference information for GC logic */
121 UNIT_REFERENCES, /* Inverse of 'references' is 'referenced_by' */
124 _UNIT_DEPENDENCY_MAX,
125 _UNIT_DEPENDENCY_INVALID = -1
136 UnitLoadState load_state;
139 char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
143 Set *dependencies[_UNIT_DEPENDENCY_MAX];
147 char *fragment_path; /* if loaded from a config file this is the primary path to it */
148 usec_t fragment_mtime;
150 /* If there is something to do with this unit, then this is
156 dual_timestamp inactive_exit_timestamp;
157 dual_timestamp active_enter_timestamp;
158 dual_timestamp active_exit_timestamp;
159 dual_timestamp inactive_enter_timestamp;
161 /* Counterparts in the cgroup filesystem */
162 CGroupBonding *cgroup_bondings;
165 LIST_FIELDS(Meta, units_per_type);
168 LIST_FIELDS(Meta, load_queue);
171 LIST_FIELDS(Meta, dbus_queue);
174 LIST_FIELDS(Meta, cleanup_queue);
177 LIST_FIELDS(Meta, gc_queue);
179 /* Used during GC sweeps */
182 /* If we go down, pull down everything that depends on us, too */
185 /* Garbage collect us we nobody wants or requires us anymore */
186 bool stop_when_unneeded;
188 /* Refuse manual starting, allow starting only indirectly via dependency. */
189 bool only_by_dependency;
191 /* Create default depedencies */
192 bool default_dependencies;
194 /* Bring up this unit even if a dependency fails to start */
195 bool ignore_dependency_failure;
197 /* When deserializing, temporarily store the job type for this
198 * unit here, if there was a job scheduled */
199 int deserialized_job; /* This is actually of type JobType */
201 bool in_load_queue:1;
202 bool in_dbus_queue:1;
203 bool in_cleanup_queue:1;
206 bool sent_dbus_new_signal:1;
215 #include "automount.h"
216 #include "snapshot.h"
237 /* This should reset all type-specific variables. This should
238 * not allocate memory, and is called with zero-initialized
239 * data. It should hence only initialize variables that need
241 void (*init)(Unit *u);
243 /* This should free all type-specific variables. It should be
245 void (*done)(Unit *u);
247 /* Actually load data from disk. This may fail, and should set
248 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
249 * UNIT_STUB if no configuration could be found. */
250 int (*load)(Unit *u);
252 /* If a a lot of units got created via enumerate(), this is
253 * where to actually set the state and call unit_notify(). */
254 int (*coldplug)(Unit *u);
256 void (*dump)(Unit *u, FILE *f, const char *prefix);
258 int (*start)(Unit *u);
259 int (*stop)(Unit *u);
260 int (*reload)(Unit *u);
262 bool (*can_reload)(Unit *u);
264 /* Write all data that cannot be restored from other sources
265 * away using unit_serialize_item() */
266 int (*serialize)(Unit *u, FILE *f, FDSet *fds);
268 /* Restore one item from the serialization */
269 int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
271 /* Boils down the more complex internal state of this unit to
272 * a simpler one that the engine can understand */
273 UnitActiveState (*active_state)(Unit *u);
275 /* Returns the substate specific to this unit type as
276 * string. This is purely information so that we can give the
277 * user a more finegrained explanation in which actual state a
279 const char* (*sub_state_to_string)(Unit *u);
281 /* Return true when there is reason to keep this entry around
282 * even nothing references it and it isn't active in any
284 bool (*check_gc)(Unit *u);
286 /* Return true when this unit is suitable for snapshotting */
287 bool (*check_snapshot)(Unit *u);
289 void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
290 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
291 void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
293 /* Reset maintenance state if we are in maintainance state */
294 void (*reset_maintenance)(Unit *u);
296 /* Called whenever any of the cgroups this unit watches for
298 void (*cgroup_notify_empty)(Unit *u);
300 /* Called whenever a process of this unit sends us a message */
301 void (*notify_message)(Unit *u, pid_t pid, char **tags);
303 /* Called whenever a name thus Unit registered for comes or
305 void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
307 /* Called whenever a bus PID lookup finishes */
308 void (*bus_query_pid_done)(Unit *u, const char *name, pid_t pid);
310 /* Called for each message received on the bus */
311 DBusHandlerResult (*bus_message_handler)(Unit *u, DBusConnection *c, DBusMessage *message);
313 /* Return the unit this unit is following */
314 Unit *(*following)(Unit *u);
316 /* This is called for each unit type and should be used to
317 * enumerate existing devices and load them. However,
318 * everything that is loaded here should still stay in
319 * inactive state. It is the job of the coldplug() call above
320 * to put the units into the initial state. */
321 int (*enumerate)(Manager *m);
323 /* Type specific cleanups. */
324 void (*shutdown)(Manager *m);
326 /* Can units of this type have multiple names? */
329 /* If true units of this types can never have "Requires"
330 * dependencies, because state changes can only be observed,
334 /* Instances make no sense for this type */
337 /* Exclude this type from snapshots */
340 /* Exclude from automatic gc */
343 /* Exclude from isolation requests */
346 /* Show status updates on the console */
350 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
352 #define UNIT_VTABLE(u) unit_vtable[(u)->meta.type]
354 /* For casting a unit into the various unit types */
355 #define DEFINE_CAST(UPPERCASE, MixedCase) \
356 static inline MixedCase* UPPERCASE(Unit *u) { \
357 if (_unlikely_(!u || u->meta.type != UNIT_##UPPERCASE)) \
360 return (MixedCase*) u; \
363 /* For casting the various unit types into a unit */
364 #define UNIT(u) ((Unit*) (&(u)->meta))
366 DEFINE_CAST(SOCKET, Socket);
367 DEFINE_CAST(TIMER, Timer);
368 DEFINE_CAST(SERVICE, Service);
369 DEFINE_CAST(TARGET, Target);
370 DEFINE_CAST(DEVICE, Device);
371 DEFINE_CAST(MOUNT, Mount);
372 DEFINE_CAST(AUTOMOUNT, Automount);
373 DEFINE_CAST(SNAPSHOT, Snapshot);
374 DEFINE_CAST(SWAP, Swap);
375 DEFINE_CAST(PATH, Path);
377 Unit *unit_new(Manager *m);
378 void unit_free(Unit *u);
380 int unit_add_name(Unit *u, const char *name);
382 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
383 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
385 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
386 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
388 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
389 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
391 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
393 int unit_add_cgroup(Unit *u, CGroupBonding *b);
394 int unit_add_cgroup_from_text(Unit *u, const char *name);
395 int unit_add_default_cgroup(Unit *u);
396 CGroupBonding* unit_get_default_cgroup(Unit *u);
398 int unit_choose_id(Unit *u, const char *name);
399 int unit_set_description(Unit *u, const char *description);
401 bool unit_check_gc(Unit *u);
403 void unit_add_to_load_queue(Unit *u);
404 void unit_add_to_dbus_queue(Unit *u);
405 void unit_add_to_cleanup_queue(Unit *u);
406 void unit_add_to_gc_queue(Unit *u);
408 int unit_merge(Unit *u, Unit *other);
409 int unit_merge_by_name(Unit *u, const char *other);
411 Unit *unit_follow_merge(Unit *u);
413 int unit_load_fragment_and_dropin(Unit *u);
414 int unit_load_fragment_and_dropin_optional(Unit *u);
415 int unit_load_nop(Unit *u);
416 int unit_load(Unit *unit);
418 const char *unit_description(Unit *u);
420 bool unit_has_name(Unit *u, const char *name);
422 UnitActiveState unit_active_state(Unit *u);
424 const char* unit_sub_state_to_string(Unit *u);
426 void unit_dump(Unit *u, FILE *f, const char *prefix);
428 bool unit_can_reload(Unit *u);
429 bool unit_can_start(Unit *u);
431 int unit_start(Unit *u);
432 int unit_stop(Unit *u);
433 int unit_reload(Unit *u);
435 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns);
437 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
438 void unit_unwatch_fd(Unit *u, Watch *w);
440 int unit_watch_pid(Unit *u, pid_t pid);
441 void unit_unwatch_pid(Unit *u, pid_t pid);
443 int unit_watch_timer(Unit *u, usec_t delay, Watch *w);
444 void unit_unwatch_timer(Unit *u, Watch *w);
446 int unit_watch_bus_name(Unit *u, const char *name);
447 void unit_unwatch_bus_name(Unit *u, const char *name);
449 bool unit_job_is_applicable(Unit *u, JobType j);
451 int set_unit_path(const char *p);
453 char *unit_dbus_path(Unit *u);
455 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
456 int unit_get_related_unit(Unit *u, const char *type, Unit **_found);
458 char *unit_name_printf(Unit *u, const char* text);
459 char *unit_full_printf(Unit *u, const char *text);
460 char **unit_full_printf_strv(Unit *u, char **l);
462 bool unit_can_serialize(Unit *u);
463 int unit_serialize(Unit *u, FILE *f, FDSet *fds);
464 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_attr_(4,5);
465 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
466 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
468 int unit_add_node_link(Unit *u, const char *what, bool wants);
470 int unit_coldplug(Unit *u);
472 void unit_status_printf(Unit *u, const char *format, ...);
474 bool unit_need_daemon_reload(Unit *u);
476 void unit_reset_maintenance(Unit *u);
478 Unit *unit_following(Unit *u);
480 const char *unit_type_to_string(UnitType i);
481 UnitType unit_type_from_string(const char *s);
483 const char *unit_load_state_to_string(UnitLoadState i);
484 UnitLoadState unit_load_state_from_string(const char *s);
486 const char *unit_active_state_to_string(UnitActiveState i);
487 UnitActiveState unit_active_state_from_string(const char *s);
489 const char *unit_dependency_to_string(UnitDependency i);
490 UnitDependency unit_dependency_from_string(const char *s);
492 const char *kill_mode_to_string(KillMode k);
493 KillMode kill_mode_from_string(const char *s);