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 128
43 #define DEFAULT_TIMEOUT_USEC (20*USEC_PER_SEC)
44 #define DEFAULT_RESTART_USEC (100*USEC_PER_MSEC)
46 typedef enum KillMode {
47 KILL_CONTROL_GROUP = 0,
51 _KILL_MODE_INVALID = -1
64 _UNIT_TYPE_INVALID = -1
73 _UNIT_LOAD_STATE_INVALID = -1
76 enum UnitActiveState {
78 UNIT_ACTIVE_RELOADING,
82 _UNIT_ACTIVE_STATE_MAX,
83 _UNIT_ACTIVE_STATE_INVALID = -1
86 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) {
87 return t == UNIT_ACTIVE || t == UNIT_ACTIVE_RELOADING;
90 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) {
91 return t == UNIT_ACTIVE || t == UNIT_ACTIVATING || t == UNIT_ACTIVE_RELOADING;
94 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) {
95 return t == UNIT_INACTIVE || t == UNIT_DEACTIVATING;
99 /* Positive dependencies */
106 /* Inverse of the above */
107 UNIT_REQUIRED_BY, /* inverse of 'requires' and 'requisite' is 'required_by' */
108 UNIT_SOFT_REQUIRED_BY, /* inverse of 'soft_requires' and 'soft_requisite' is 'soft_required_by' */
109 UNIT_WANTED_BY, /* inverse of 'wants' */
111 /* Negative dependencies */
112 UNIT_CONFLICTS, /* inverse of 'conflicts' is 'conflicts' */
115 UNIT_BEFORE, /* inverse of before is after and vice versa */
118 _UNIT_DEPENDENCY_MAX,
119 _UNIT_DEPENDENCY_INVALID = -1
130 UnitLoadState load_state;
133 char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
136 Set *dependencies[_UNIT_DEPENDENCY_MAX];
139 char *fragment_path; /* if loaded from a config file this is the primary path to it */
141 /* If there is something to do with this unit, then this is
145 bool in_load_queue:1;
146 bool in_dbus_queue:1;
147 bool in_cleanup_queue:1;
148 bool sent_dbus_new_signal:1;
150 /* If we go down, pull down everything that depends on us, too */
153 /* Garbage collect us we nobody wants or requires us anymore */
154 bool stop_when_unneeded;
156 usec_t active_enter_timestamp;
157 usec_t active_exit_timestamp;
159 /* Counterparts in the cgroup filesystem */
160 CGroupBonding *cgroup_bondings;
163 LIST_FIELDS(Meta, load_queue);
166 LIST_FIELDS(Meta, units_per_type);
169 LIST_FIELDS(Meta, dbus_queue);
172 LIST_FIELDS(Meta, cleanup_queue);
181 #include "automount.h"
182 #include "snapshot.h"
199 /* Can units of this type have multiple names? */
202 /* If true units of this types can never have "Requires"
203 * dependencies, because state changes can only be observed,
205 bool refuse_requires:1;
207 /* This should reset all type-specific variables. This should
208 * not allocate memory, and is either called with 0
209 * initialized data, or with data left from done() */
210 void (*init)(Unit *u);
212 /* Actually load data from disk. This may fail, and should set
213 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
214 * UNIT_STUB if no configuration could be found. */
215 int (*load)(Unit *u);
217 /* This should free all type-specific variables. It should be
218 * idempotent. There's no need to reset variables that deal
219 * with dynamic memory/resources. */
220 void (*done)(Unit *u);
222 /* If a a lot of units got created via enumerate(), this is
223 * where to actually set the state and call unit_notify(). */
224 int (*coldplug)(Unit *u);
226 void (*dump)(Unit *u, FILE *f, const char *prefix);
228 int (*start)(Unit *u);
229 int (*stop)(Unit *u);
230 int (*reload)(Unit *u);
232 bool (*can_reload)(Unit *u);
234 /* Boils down the more complex internal state of this unit to
235 * a simpler one that the engine can understand */
236 UnitActiveState (*active_state)(Unit *u);
238 void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
239 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
240 void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
242 void (*cgroup_notify_empty)(Unit *u);
244 /* This is called for each unit type and should be used to
245 * enumerate existing devices and load them. However,
246 * everything that is loaded here should still stay in
247 * inactive state. It is the job of the coldplug() call above
248 * to put the units into the initial state. */
249 int (*enumerate)(Manager *m);
251 /* Type specific cleanups. */
252 void (*shutdown)(Manager *m);
255 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
257 #define UNIT_VTABLE(u) unit_vtable[(u)->meta.type]
259 /* For casting a unit into the various unit types */
260 #define DEFINE_CAST(UPPERCASE, MixedCase) \
261 static inline MixedCase* UPPERCASE(Unit *u) { \
262 if (!u || u->meta.type != UNIT_##UPPERCASE) \
265 return (MixedCase*) u; \
268 /* For casting the various unit types into a unit */
269 #define UNIT(u) ((Unit*) (u))
271 DEFINE_CAST(SOCKET, Socket);
272 DEFINE_CAST(TIMER, Timer);
273 DEFINE_CAST(SERVICE, Service);
274 DEFINE_CAST(TARGET, Target);
275 DEFINE_CAST(DEVICE, Device);
276 DEFINE_CAST(MOUNT, Mount);
277 DEFINE_CAST(AUTOMOUNT, Automount);
278 DEFINE_CAST(SNAPSHOT, Snapshot);
280 UnitType unit_name_to_type(const char *n);
281 bool unit_name_is_valid(const char *n);
282 char *unit_name_change_suffix(const char *n, const char *suffix);
284 Unit *unit_new(Manager *m);
285 void unit_free(Unit *u);
287 int unit_add_name(Unit *u, const char *name);
288 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other);
289 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name);
290 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name);
292 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
294 int unit_add_cgroup(Unit *u, CGroupBonding *b);
295 int unit_add_cgroup_from_text(Unit *u, const char *name);
296 int unit_add_default_cgroup(Unit *u);
297 CGroupBonding* unit_get_default_cgroup(Unit *u);
299 int unit_choose_id(Unit *u, const char *name);
300 int unit_set_description(Unit *u, const char *description);
302 void unit_add_to_load_queue(Unit *u);
303 void unit_add_to_dbus_queue(Unit *u);
304 void unit_add_to_cleanup_queue(Unit *u);
306 int unit_merge(Unit *u, Unit *other);
307 int unit_merge_by_name(Unit *u, const char *other);
309 Unit *unit_follow_merge(Unit *u);
311 int unit_load_fragment_and_dropin(Unit *u);
312 int unit_load_fragment_and_dropin_optional(Unit *u);
313 int unit_load(Unit *unit);
315 const char* unit_id(Unit *u);
316 const char *unit_description(Unit *u);
318 bool unit_has_name(Unit *u, const char *name);
320 UnitActiveState unit_active_state(Unit *u);
322 void unit_dump(Unit *u, FILE *f, const char *prefix);
324 bool unit_can_reload(Unit *u);
325 bool unit_can_start(Unit *u);
327 int unit_start(Unit *u);
328 int unit_stop(Unit *u);
329 int unit_reload(Unit *u);
331 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns);
333 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
334 void unit_unwatch_fd(Unit *u, Watch *w);
336 int unit_watch_pid(Unit *u, pid_t pid);
337 void unit_unwatch_pid(Unit *u, pid_t pid);
339 int unit_watch_timer(Unit *u, usec_t delay, Watch *w);
340 void unit_unwatch_timer(Unit *u, Watch *w);
342 bool unit_job_is_applicable(Unit *u, JobType j);
344 int set_unit_path(const char *p);
346 char *unit_name_escape_path(const char *path, const char *suffix);
348 char *unit_dbus_path(Unit *u);
350 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
352 const char *unit_type_to_string(UnitType i);
353 UnitType unit_type_from_string(const char *s);
355 const char *unit_load_state_to_string(UnitLoadState i);
356 UnitLoadState unit_load_state_from_string(const char *s);
358 const char *unit_active_state_to_string(UnitActiveState i);
359 UnitActiveState unit_active_state_from_string(const char *s);
361 const char *unit_dependency_to_string(UnitDependency i);
362 UnitDependency unit_dependency_from_string(const char *s);
364 const char *kill_mode_to_string(KillMode k);
365 KillMode kill_mode_from_string(const char *s);