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)
56 _UNIT_TYPE_INVALID = -1,
64 _UNIT_LOAD_STATE_INVALID = -1
67 enum UnitActiveState {
69 UNIT_ACTIVE_RELOADING,
73 _UNIT_ACTIVE_STATE_MAX,
74 _UNIT_ACTIVE_STATE_INVALID = -1
77 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) {
78 return t == UNIT_ACTIVE || t == UNIT_ACTIVE_RELOADING;
81 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) {
82 return t == UNIT_ACTIVE || t == UNIT_ACTIVATING || t == UNIT_ACTIVE_RELOADING;
85 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) {
86 return t == UNIT_INACTIVE || t == UNIT_DEACTIVATING;
90 /* Positive dependencies */
97 /* Inverse of the above */
98 UNIT_REQUIRED_BY, /* inverse of 'requires' and 'requisite' is 'required_by' */
99 UNIT_SOFT_REQUIRED_BY, /* inverse of 'soft_requires' and 'soft_requisite' is 'soft_required_by' */
100 UNIT_WANTED_BY, /* inverse of 'wants' */
102 /* Negative dependencies */
103 UNIT_CONFLICTS, /* inverse of 'conflicts' is 'conflicts' */
106 UNIT_BEFORE, /* inverse of before is after and vice versa */
109 _UNIT_DEPENDENCY_MAX,
110 _UNIT_DEPENDENCY_INVALID = -1
119 UnitLoadState load_state;
121 char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
124 Set *dependencies[_UNIT_DEPENDENCY_MAX];
127 char *fragment_path; /* if loaded from a config file this is the primary path to it */
129 /* If there is something to do with this unit, then this is
133 bool in_load_queue:1;
134 bool in_dbus_queue:1;
135 bool sent_dbus_new_signal:1;
137 /* If we go down, pull down everything that depends on us, too */
140 /* Garbage collect us we nobody wants or requires us anymore */
141 bool stop_when_unneeded;
143 usec_t active_enter_timestamp;
144 usec_t active_exit_timestamp;
147 LIST_FIELDS(Meta, load_queue);
150 LIST_FIELDS(Meta, units_per_type);
153 LIST_FIELDS(Meta, dbus_queue);
162 #include "automount.h"
163 #include "snapshot.h"
180 int (*init)(Unit *u);
181 void (*done)(Unit *u);
182 int (*coldplug)(Unit *u);
184 void (*dump)(Unit *u, FILE *f, const char *prefix);
186 int (*start)(Unit *u);
187 int (*stop)(Unit *u);
188 int (*reload)(Unit *u);
190 bool (*can_reload)(Unit *u);
192 /* Boils down the more complex internal state of this unit to
193 * a simpler one that the engine can understand */
194 UnitActiveState (*active_state)(Unit *u);
196 void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
197 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
198 void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
200 /* This is called for each unit type and should be used to
201 * enumerate existing devices and load them. However,
202 * everything that is loaded here should still stay in
203 * inactive state. It is the job of the coldplug() call above
204 * to put the units into the initial state. */
205 int (*enumerate)(Manager *m);
207 /* Type specific cleanups. */
208 void (*shutdown)(Manager *m);
211 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
213 #define UNIT_VTABLE(u) unit_vtable[(u)->meta.type]
215 /* For casting a unit into the various unit types */
216 #define DEFINE_CAST(UPPERCASE, MixedCase) \
217 static inline MixedCase* UPPERCASE(Unit *u) { \
218 if (!u || u->meta.type != UNIT_##UPPERCASE) \
221 return (MixedCase*) u; \
224 /* For casting the various unit types into a unit */
225 #define UNIT(u) ((Unit*) (u))
227 DEFINE_CAST(SOCKET, Socket);
228 DEFINE_CAST(TIMER, Timer);
229 DEFINE_CAST(SERVICE, Service);
230 DEFINE_CAST(TARGET, Target);
231 DEFINE_CAST(DEVICE, Device);
232 DEFINE_CAST(MOUNT, Mount);
233 DEFINE_CAST(AUTOMOUNT, Automount);
234 DEFINE_CAST(SNAPSHOT, Snapshot);
236 UnitType unit_name_to_type(const char *n);
237 bool unit_name_is_valid(const char *n);
238 char *unit_name_change_suffix(const char *n, const char *suffix);
240 Unit *unit_new(Manager *m);
241 void unit_free(Unit *u);
243 int unit_add_name(Unit *u, const char *name);
244 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other);
245 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name);
247 int unit_choose_id(Unit *u, const char *name);
248 int unit_set_description(Unit *u, const char *description);
250 void unit_add_to_load_queue(Unit *u);
251 void unit_add_to_dbus_queue(Unit *u);
253 int unit_merge(Unit *u, Unit *other);
255 int unit_load_fragment_and_dropin(Unit *u);
256 int unit_load(Unit *unit);
258 const char* unit_id(Unit *u);
259 const char *unit_description(Unit *u);
261 UnitActiveState unit_active_state(Unit *u);
263 void unit_dump(Unit *u, FILE *f, const char *prefix);
265 bool unit_can_reload(Unit *u);
266 bool unit_can_start(Unit *u);
268 int unit_start(Unit *u);
269 int unit_stop(Unit *u);
270 int unit_reload(Unit *u);
272 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns);
274 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
275 void unit_unwatch_fd(Unit *u, Watch *w);
277 int unit_watch_pid(Unit *u, pid_t pid);
278 void unit_unwatch_pid(Unit *u, pid_t pid);
280 int unit_watch_timer(Unit *u, usec_t delay, Watch *w);
281 void unit_unwatch_timer(Unit *u, Watch *w);
283 bool unit_job_is_applicable(Unit *u, JobType j);
285 int set_unit_path(const char *p);
287 char *unit_name_escape_path(const char *path, const char *suffix);
289 const char *unit_type_to_string(UnitType i);
290 UnitType unit_type_from_string(const char *s);
292 const char *unit_load_state_to_string(UnitLoadState i);
293 UnitLoadState unit_load_state_from_string(const char *s);
295 const char *unit_active_state_to_string(UnitActiveState i);
296 UnitActiveState unit_active_state_from_string(const char *s);
298 const char *unit_dependency_to_string(UnitDependency i);
299 UnitDependency unit_dependency_from_string(const char *s);
301 char *unit_dbus_path(Unit *u);