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"
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 'conflicted_by' */
115 UNIT_BEFORE, /* inverse of 'before' is 'after' and vice versa */
121 /* Reference information for GC logic */
122 UNIT_REFERENCES, /* Inverse of 'references' is 'referenced_by' */
125 _UNIT_DEPENDENCY_MAX,
126 _UNIT_DEPENDENCY_INVALID = -1
137 UnitLoadState load_state;
140 char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
144 Set *dependencies[_UNIT_DEPENDENCY_MAX];
148 char *fragment_path; /* if loaded from a config file this is the primary path to it */
149 usec_t fragment_mtime;
151 /* If there is something to do with this unit, then this is
157 dual_timestamp inactive_exit_timestamp;
158 dual_timestamp active_enter_timestamp;
159 dual_timestamp active_exit_timestamp;
160 dual_timestamp inactive_enter_timestamp;
162 /* Counterparts in the cgroup filesystem */
163 CGroupBonding *cgroup_bondings;
166 LIST_FIELDS(Meta, units_per_type);
169 LIST_FIELDS(Meta, load_queue);
172 LIST_FIELDS(Meta, dbus_queue);
175 LIST_FIELDS(Meta, cleanup_queue);
178 LIST_FIELDS(Meta, gc_queue);
180 /* Used during GC sweeps */
183 /* When deserializing, temporarily store the job type for this
184 * unit here, if there was a job scheduled */
185 int deserialized_job; /* This is actually of type JobType */
187 /* Error code when we didn't manage to load the unit (negative) */
190 /* If we go down, pull down everything that depends on us, too */
193 /* Garbage collect us we nobody wants or requires us anymore */
194 bool stop_when_unneeded;
196 /* Create default depedencies */
197 bool default_dependencies;
199 /* Bring up this unit even if a dependency fails to start */
200 bool ignore_dependency_failure;
202 /* Refuse manual starting, allow starting only indirectly via dependency. */
203 bool refuse_manual_start;
205 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
206 bool refuse_manual_stop;
208 bool in_load_queue:1;
209 bool in_dbus_queue:1;
210 bool in_cleanup_queue:1;
213 bool sent_dbus_new_signal:1;
226 #include "automount.h"
227 #include "snapshot.h"
248 /* This should reset all type-specific variables. This should
249 * not allocate memory, and is called with zero-initialized
250 * data. It should hence only initialize variables that need
252 void (*init)(Unit *u);
254 /* This should free all type-specific variables. It should be
256 void (*done)(Unit *u);
258 /* Actually load data from disk. This may fail, and should set
259 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
260 * UNIT_STUB if no configuration could be found. */
261 int (*load)(Unit *u);
263 /* If a a lot of units got created via enumerate(), this is
264 * where to actually set the state and call unit_notify(). */
265 int (*coldplug)(Unit *u);
267 void (*dump)(Unit *u, FILE *f, const char *prefix);
269 int (*start)(Unit *u);
270 int (*stop)(Unit *u);
271 int (*reload)(Unit *u);
273 bool (*can_reload)(Unit *u);
275 /* Write all data that cannot be restored from other sources
276 * away using unit_serialize_item() */
277 int (*serialize)(Unit *u, FILE *f, FDSet *fds);
279 /* Restore one item from the serialization */
280 int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
282 /* Boils down the more complex internal state of this unit to
283 * a simpler one that the engine can understand */
284 UnitActiveState (*active_state)(Unit *u);
286 /* Returns the substate specific to this unit type as
287 * string. This is purely information so that we can give the
288 * user a more finegrained explanation in which actual state a
290 const char* (*sub_state_to_string)(Unit *u);
292 /* Return true when there is reason to keep this entry around
293 * even nothing references it and it isn't active in any
295 bool (*check_gc)(Unit *u);
297 /* Return true when this unit is suitable for snapshotting */
298 bool (*check_snapshot)(Unit *u);
300 void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
301 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
302 void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
304 /* Reset maintenance state if we are in maintainance state */
305 void (*reset_maintenance)(Unit *u);
307 /* Called whenever any of the cgroups this unit watches for
309 void (*cgroup_notify_empty)(Unit *u);
311 /* Called whenever a process of this unit sends us a message */
312 void (*notify_message)(Unit *u, pid_t pid, char **tags);
314 /* Called whenever a name thus Unit registered for comes or
316 void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
318 /* Called whenever a bus PID lookup finishes */
319 void (*bus_query_pid_done)(Unit *u, const char *name, pid_t pid);
321 /* Called for each message received on the bus */
322 DBusHandlerResult (*bus_message_handler)(Unit *u, DBusConnection *c, DBusMessage *message);
324 /* Return the unit this unit is following */
325 Unit *(*following)(Unit *u);
327 /* This is called for each unit type and should be used to
328 * enumerate existing devices and load them. However,
329 * everything that is loaded here should still stay in
330 * inactive state. It is the job of the coldplug() call above
331 * to put the units into the initial state. */
332 int (*enumerate)(Manager *m);
334 /* Type specific cleanups. */
335 void (*shutdown)(Manager *m);
337 /* When sending out PropertiesChanged signal, which properties
338 * shall be invalidated? This is a NUL seperated list of
339 * strings, to minimize relocations a little. */
340 const char *bus_invalidating_properties;
342 /* The interface name */
343 const char *bus_interface;
345 /* Can units of this type have multiple names? */
348 /* If true units of this types can never have "Requires"
349 * dependencies, because state changes can only be observed,
353 /* Instances make no sense for this type */
356 /* Exclude this type from snapshots */
359 /* Exclude from automatic gc */
362 /* Exclude from isolation requests */
365 /* Show status updates on the console */
369 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
371 #define UNIT_VTABLE(u) unit_vtable[(u)->meta.type]
373 /* For casting a unit into the various unit types */
374 #define DEFINE_CAST(UPPERCASE, MixedCase) \
375 static inline MixedCase* UPPERCASE(Unit *u) { \
376 if (_unlikely_(!u || u->meta.type != UNIT_##UPPERCASE)) \
379 return (MixedCase*) u; \
382 /* For casting the various unit types into a unit */
383 #define UNIT(u) ((Unit*) (&(u)->meta))
385 DEFINE_CAST(SOCKET, Socket);
386 DEFINE_CAST(TIMER, Timer);
387 DEFINE_CAST(SERVICE, Service);
388 DEFINE_CAST(TARGET, Target);
389 DEFINE_CAST(DEVICE, Device);
390 DEFINE_CAST(MOUNT, Mount);
391 DEFINE_CAST(AUTOMOUNT, Automount);
392 DEFINE_CAST(SNAPSHOT, Snapshot);
393 DEFINE_CAST(SWAP, Swap);
394 DEFINE_CAST(PATH, Path);
396 Unit *unit_new(Manager *m);
397 void unit_free(Unit *u);
399 int unit_add_name(Unit *u, const char *name);
401 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
402 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
404 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
405 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
407 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
408 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
410 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
412 int unit_add_cgroup(Unit *u, CGroupBonding *b);
413 int unit_add_cgroup_from_text(Unit *u, const char *name);
414 int unit_add_default_cgroup(Unit *u);
415 CGroupBonding* unit_get_default_cgroup(Unit *u);
417 int unit_choose_id(Unit *u, const char *name);
418 int unit_set_description(Unit *u, const char *description);
420 bool unit_check_gc(Unit *u);
422 void unit_add_to_load_queue(Unit *u);
423 void unit_add_to_dbus_queue(Unit *u);
424 void unit_add_to_cleanup_queue(Unit *u);
425 void unit_add_to_gc_queue(Unit *u);
427 int unit_merge(Unit *u, Unit *other);
428 int unit_merge_by_name(Unit *u, const char *other);
430 Unit *unit_follow_merge(Unit *u);
432 int unit_load_fragment_and_dropin(Unit *u);
433 int unit_load_fragment_and_dropin_optional(Unit *u);
434 int unit_load(Unit *unit);
436 const char *unit_description(Unit *u);
438 bool unit_has_name(Unit *u, const char *name);
440 UnitActiveState unit_active_state(Unit *u);
442 const char* unit_sub_state_to_string(Unit *u);
444 void unit_dump(Unit *u, FILE *f, const char *prefix);
446 bool unit_can_reload(Unit *u);
447 bool unit_can_start(Unit *u);
449 int unit_start(Unit *u);
450 int unit_stop(Unit *u);
451 int unit_reload(Unit *u);
453 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns);
455 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
456 void unit_unwatch_fd(Unit *u, Watch *w);
458 int unit_watch_pid(Unit *u, pid_t pid);
459 void unit_unwatch_pid(Unit *u, pid_t pid);
461 int unit_watch_timer(Unit *u, usec_t delay, Watch *w);
462 void unit_unwatch_timer(Unit *u, Watch *w);
464 int unit_watch_bus_name(Unit *u, const char *name);
465 void unit_unwatch_bus_name(Unit *u, const char *name);
467 bool unit_job_is_applicable(Unit *u, JobType j);
469 int set_unit_path(const char *p);
471 char *unit_dbus_path(Unit *u);
473 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
474 int unit_get_related_unit(Unit *u, const char *type, Unit **_found);
476 char *unit_name_printf(Unit *u, const char* text);
477 char *unit_full_printf(Unit *u, const char *text);
478 char **unit_full_printf_strv(Unit *u, char **l);
480 bool unit_can_serialize(Unit *u);
481 int unit_serialize(Unit *u, FILE *f, FDSet *fds);
482 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_attr_(4,5);
483 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
484 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
486 int unit_add_node_link(Unit *u, const char *what, bool wants);
488 int unit_coldplug(Unit *u);
490 void unit_status_printf(Unit *u, const char *format, ...);
492 bool unit_need_daemon_reload(Unit *u);
494 void unit_reset_maintenance(Unit *u);
496 Unit *unit_following(Unit *u);
498 const char *unit_load_state_to_string(UnitLoadState i);
499 UnitLoadState unit_load_state_from_string(const char *s);
501 const char *unit_active_state_to_string(UnitActiveState i);
502 UnitActiveState unit_active_state_from_string(const char *s);
504 const char *unit_dependency_to_string(UnitDependency i);
505 UnitDependency unit_dependency_from_string(const char *s);
507 const char *kill_mode_to_string(KillMode k);
508 KillMode kill_mode_from_string(const char *s);