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,
52 _KILL_MODE_INVALID = -1
65 _UNIT_TYPE_INVALID = -1
74 _UNIT_LOAD_STATE_INVALID = -1
77 enum UnitActiveState {
79 UNIT_ACTIVE_RELOADING,
83 _UNIT_ACTIVE_STATE_MAX,
84 _UNIT_ACTIVE_STATE_INVALID = -1
87 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) {
88 return t == UNIT_ACTIVE || t == UNIT_ACTIVE_RELOADING;
91 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) {
92 return t == UNIT_ACTIVE || t == UNIT_ACTIVATING || t == UNIT_ACTIVE_RELOADING;
95 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) {
96 return t == UNIT_INACTIVE || t == UNIT_DEACTIVATING;
100 /* Positive dependencies */
107 /* Inverse of the above */
108 UNIT_REQUIRED_BY, /* inverse of 'requires' and 'requisite' is 'required_by' */
109 UNIT_SOFT_REQUIRED_BY, /* inverse of 'soft_requires' and 'soft_requisite' is 'soft_required_by' */
110 UNIT_WANTED_BY, /* inverse of 'wants' */
112 /* Negative dependencies */
113 UNIT_CONFLICTS, /* inverse of 'conflicts' is 'conflicts' */
116 UNIT_BEFORE, /* inverse of before is after and vice versa */
119 _UNIT_DEPENDENCY_MAX,
120 _UNIT_DEPENDENCY_INVALID = -1
131 UnitLoadState load_state;
134 char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
137 Set *dependencies[_UNIT_DEPENDENCY_MAX];
140 char *fragment_path; /* if loaded from a config file this is the primary path to it */
142 /* If there is something to do with this unit, then this is
146 bool in_load_queue:1;
147 bool in_dbus_queue:1;
148 bool in_cleanup_queue:1;
149 bool sent_dbus_new_signal:1;
151 /* If we go down, pull down everything that depends on us, too */
154 /* Garbage collect us we nobody wants or requires us anymore */
155 bool stop_when_unneeded;
157 usec_t active_enter_timestamp;
158 usec_t active_exit_timestamp;
160 /* Counterparts in the cgroup filesystem */
161 CGroupBonding *cgroup_bondings;
164 LIST_FIELDS(Meta, load_queue);
167 LIST_FIELDS(Meta, units_per_type);
170 LIST_FIELDS(Meta, dbus_queue);
173 LIST_FIELDS(Meta, cleanup_queue);
182 #include "automount.h"
183 #include "snapshot.h"
200 /* Can units of this type have multiple names? */
203 /* If true units of this types can never have "Requires"
204 * dependencies, because state changes can only be observed,
206 bool refuse_requires:1;
208 /* This should reset all type-specific variables. This should
209 * not allocate memory, and is either called with 0
210 * initialized data, or with data left from done() */
211 void (*init)(Unit *u);
213 /* Actually load data from disk. This may fail, and should set
214 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
215 * UNIT_STUB if no configuration could be found. */
216 int (*load)(Unit *u);
218 /* This should free all type-specific variables. It should be
219 * idempotent. There's no need to reset variables that deal
220 * with dynamic memory/resources. */
221 void (*done)(Unit *u);
223 /* If a a lot of units got created via enumerate(), this is
224 * where to actually set the state and call unit_notify(). */
225 int (*coldplug)(Unit *u);
227 void (*dump)(Unit *u, FILE *f, const char *prefix);
229 int (*start)(Unit *u);
230 int (*stop)(Unit *u);
231 int (*reload)(Unit *u);
233 bool (*can_reload)(Unit *u);
235 /* Boils down the more complex internal state of this unit to
236 * a simpler one that the engine can understand */
237 UnitActiveState (*active_state)(Unit *u);
239 void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
240 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
241 void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
243 void (*cgroup_notify_empty)(Unit *u);
245 /* This is called for each unit type and should be used to
246 * enumerate existing devices and load them. However,
247 * everything that is loaded here should still stay in
248 * inactive state. It is the job of the coldplug() call above
249 * to put the units into the initial state. */
250 int (*enumerate)(Manager *m);
252 /* Type specific cleanups. */
253 void (*shutdown)(Manager *m);
256 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
258 #define UNIT_VTABLE(u) unit_vtable[(u)->meta.type]
260 /* For casting a unit into the various unit types */
261 #define DEFINE_CAST(UPPERCASE, MixedCase) \
262 static inline MixedCase* UPPERCASE(Unit *u) { \
263 if (!u || u->meta.type != UNIT_##UPPERCASE) \
266 return (MixedCase*) u; \
269 /* For casting the various unit types into a unit */
270 #define UNIT(u) ((Unit*) (u))
272 DEFINE_CAST(SOCKET, Socket);
273 DEFINE_CAST(TIMER, Timer);
274 DEFINE_CAST(SERVICE, Service);
275 DEFINE_CAST(TARGET, Target);
276 DEFINE_CAST(DEVICE, Device);
277 DEFINE_CAST(MOUNT, Mount);
278 DEFINE_CAST(AUTOMOUNT, Automount);
279 DEFINE_CAST(SNAPSHOT, Snapshot);
281 UnitType unit_name_to_type(const char *n);
282 bool unit_name_is_valid(const char *n);
283 char *unit_name_change_suffix(const char *n, const char *suffix);
285 Unit *unit_new(Manager *m);
286 void unit_free(Unit *u);
288 int unit_add_name(Unit *u, const char *name);
289 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other);
290 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name);
291 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name);
293 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
295 int unit_add_cgroup(Unit *u, CGroupBonding *b);
296 int unit_add_cgroup_from_text(Unit *u, const char *name);
297 int unit_add_default_cgroup(Unit *u);
298 CGroupBonding* unit_get_default_cgroup(Unit *u);
300 int unit_choose_id(Unit *u, const char *name);
301 int unit_set_description(Unit *u, const char *description);
303 void unit_add_to_load_queue(Unit *u);
304 void unit_add_to_dbus_queue(Unit *u);
305 void unit_add_to_cleanup_queue(Unit *u);
307 int unit_merge(Unit *u, Unit *other);
308 int unit_merge_by_name(Unit *u, const char *other);
310 Unit *unit_follow_merge(Unit *u);
312 int unit_load_fragment_and_dropin(Unit *u);
313 int unit_load_fragment_and_dropin_optional(Unit *u);
314 int unit_load(Unit *unit);
316 const char* unit_id(Unit *u);
317 const char *unit_description(Unit *u);
319 bool unit_has_name(Unit *u, const char *name);
321 UnitActiveState unit_active_state(Unit *u);
323 void unit_dump(Unit *u, FILE *f, const char *prefix);
325 bool unit_can_reload(Unit *u);
326 bool unit_can_start(Unit *u);
328 int unit_start(Unit *u);
329 int unit_stop(Unit *u);
330 int unit_reload(Unit *u);
332 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns);
334 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
335 void unit_unwatch_fd(Unit *u, Watch *w);
337 int unit_watch_pid(Unit *u, pid_t pid);
338 void unit_unwatch_pid(Unit *u, pid_t pid);
340 int unit_watch_timer(Unit *u, usec_t delay, Watch *w);
341 void unit_unwatch_timer(Unit *u, Watch *w);
343 bool unit_job_is_applicable(Unit *u, JobType j);
345 int set_unit_path(const char *p);
347 char *unit_name_escape_path(const char *path, const char *suffix);
349 char *unit_dbus_path(Unit *u);
351 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
353 const char *unit_type_to_string(UnitType i);
354 UnitType unit_type_from_string(const char *s);
356 const char *unit_load_state_to_string(UnitLoadState i);
357 UnitLoadState unit_load_state_from_string(const char *s);
359 const char *unit_active_state_to_string(UnitActiveState i);
360 UnitActiveState unit_active_state_from_string(const char *s);
362 const char *unit_dependency_to_string(UnitDependency i);
363 UnitDependency unit_dependency_from_string(const char *s);
365 const char *kill_mode_to_string(KillMode k);
366 KillMode kill_mode_from_string(const char *s);