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 *load_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;
135 /* If we go down, pull down everything that depends on us, too */
138 /* Garbage collect us we nobody wants or requires us anymore */
139 bool stop_when_unneeded;
141 usec_t active_enter_timestamp;
142 usec_t active_exit_timestamp;
145 LIST_FIELDS(Meta, load_queue);
148 LIST_FIELDS(Meta, units_per_type);
157 #include "automount.h"
158 #include "snapshot.h"
175 int (*init)(Unit *u);
176 void (*done)(Unit *u);
177 int (*coldplug)(Unit *u);
179 void (*dump)(Unit *u, FILE *f, const char *prefix);
181 int (*start)(Unit *u);
182 int (*stop)(Unit *u);
183 int (*reload)(Unit *u);
185 bool (*can_reload)(Unit *u);
187 /* Boils down the more complex internal state of this unit to
188 * a simpler one that the engine can understand */
189 UnitActiveState (*active_state)(Unit *u);
191 void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
192 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
193 void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
195 /* This is called for each unit type and should be used to
196 * enumerate existing devices and load them. However,
197 * everything that is loaded here should still stay in
198 * inactive state. It is the job of the coldplug() call above
199 * to put the units into the initial state. */
200 int (*enumerate)(Manager *m);
202 /* Type specific cleanups. */
203 void (*shutdown)(Manager *m);
206 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
208 #define UNIT_VTABLE(u) unit_vtable[(u)->meta.type]
210 /* For casting a unit into the various unit types */
211 #define DEFINE_CAST(UPPERCASE, MixedCase) \
212 static inline MixedCase* UPPERCASE(Unit *u) { \
213 if (!u || u->meta.type != UNIT_##UPPERCASE) \
216 return (MixedCase*) u; \
219 /* For casting the various unit types into a unit */
220 #define UNIT(u) ((Unit*) (u))
222 DEFINE_CAST(SOCKET, Socket);
223 DEFINE_CAST(TIMER, Timer);
224 DEFINE_CAST(SERVICE, Service);
225 DEFINE_CAST(TARGET, Target);
226 DEFINE_CAST(DEVICE, Device);
227 DEFINE_CAST(MOUNT, Mount);
228 DEFINE_CAST(AUTOMOUNT, Automount);
229 DEFINE_CAST(SNAPSHOT, Snapshot);
231 UnitType unit_name_to_type(const char *n);
232 bool unit_name_is_valid(const char *n);
233 char *unit_name_change_suffix(const char *n, const char *suffix);
235 Unit *unit_new(Manager *m);
236 void unit_free(Unit *u);
238 int unit_add_name(Unit *u, const char *name);
239 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other);
240 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name);
242 int unit_choose_id(Unit *u, const char *name);
243 int unit_set_description(Unit *u, const char *description);
245 void unit_add_to_load_queue(Unit *u);
247 int unit_merge(Unit *u, Unit *other);
249 int unit_load_fragment_and_dropin(Unit *u);
250 int unit_load(Unit *unit);
252 const char* unit_id(Unit *u);
253 const char *unit_description(Unit *u);
255 UnitActiveState unit_active_state(Unit *u);
257 void unit_dump(Unit *u, FILE *f, const char *prefix);
259 bool unit_can_reload(Unit *u);
260 bool unit_can_start(Unit *u);
262 int unit_start(Unit *u);
263 int unit_stop(Unit *u);
264 int unit_reload(Unit *u);
266 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns);
268 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
269 void unit_unwatch_fd(Unit *u, Watch *w);
271 int unit_watch_pid(Unit *u, pid_t pid);
272 void unit_unwatch_pid(Unit *u, pid_t pid);
274 int unit_watch_timer(Unit *u, usec_t delay, Watch *w);
275 void unit_unwatch_timer(Unit *u, Watch *w);
277 bool unit_job_is_applicable(Unit *u, JobType j);
279 const char *unit_path(void);
280 int set_unit_path(const char *p);
282 char *unit_name_escape_path(const char *prefix, const char *path, const char *suffix);
284 const char *unit_type_to_string(UnitType i);
285 UnitType unit_type_from_string(const char *s);
287 const char *unit_load_state_to_string(UnitLoadState i);
288 UnitLoadState unit_load_state_from_string(const char *s);
290 const char *unit_active_state_to_string(UnitActiveState i);
291 UnitActiveState unit_active_state_from_string(const char *s);
293 const char *unit_dependency_to_string(UnitDependency i);
294 UnitDependency unit_dependency_from_string(const char *s);
296 char *unit_dbus_path(Unit *u);