]>
Commit | Line | Data |
---|---|---|
87f0e418 LP |
1 | /*-*- Mode: C; c-basic-offset: 8 -*-*/ |
2 | ||
3 | #ifndef foounithfoo | |
4 | #define foounithfoo | |
5 | ||
a7334b09 LP |
6 | /*** |
7 | This file is part of systemd. | |
8 | ||
9 | Copyright 2010 Lennart Poettering | |
10 | ||
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. | |
15 | ||
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. | |
20 | ||
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/>. | |
23 | ***/ | |
24 | ||
87f0e418 LP |
25 | #include <stdbool.h> |
26 | #include <stdlib.h> | |
27 | ||
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; | |
35 | ||
87f0e418 LP |
36 | #include "set.h" |
37 | #include "util.h" | |
38 | #include "list.h" | |
39 | #include "socket-util.h" | |
40 | #include "execute.h" | |
87f0e418 | 41 | |
b5ea5d95 | 42 | #define UNIT_NAME_MAX 128 |
87f0e418 LP |
43 | #define DEFAULT_TIMEOUT_USEC (20*USEC_PER_SEC) |
44 | #define DEFAULT_RESTART_USEC (100*USEC_PER_MSEC) | |
45 | ||
50159e6a LP |
46 | typedef enum KillMode { |
47 | KILL_CONTROL_GROUP = 0, | |
48 | KILL_PROCESS_GROUP, | |
49 | KILL_PROCESS, | |
80876c20 | 50 | KILL_NONE, |
50159e6a LP |
51 | _KILL_MODE_MAX, |
52 | _KILL_MODE_INVALID = -1 | |
53 | } KillMode; | |
54 | ||
87f0e418 LP |
55 | enum UnitType { |
56 | UNIT_SERVICE = 0, | |
87f0e418 LP |
57 | UNIT_SOCKET, |
58 | UNIT_TARGET, | |
59 | UNIT_DEVICE, | |
60 | UNIT_MOUNT, | |
61 | UNIT_AUTOMOUNT, | |
8d567588 | 62 | UNIT_TIMER, |
87f0e418 LP |
63 | UNIT_SNAPSHOT, |
64 | _UNIT_TYPE_MAX, | |
50159e6a | 65 | _UNIT_TYPE_INVALID = -1 |
87f0e418 LP |
66 | }; |
67 | ||
68 | enum UnitLoadState { | |
69 | UNIT_STUB, | |
70 | UNIT_LOADED, | |
71 | UNIT_FAILED, | |
23a177ef | 72 | UNIT_MERGED, |
94f04347 LP |
73 | _UNIT_LOAD_STATE_MAX, |
74 | _UNIT_LOAD_STATE_INVALID = -1 | |
87f0e418 LP |
75 | }; |
76 | ||
77 | enum UnitActiveState { | |
78 | UNIT_ACTIVE, | |
79 | UNIT_ACTIVE_RELOADING, | |
80 | UNIT_INACTIVE, | |
81 | UNIT_ACTIVATING, | |
82 | UNIT_DEACTIVATING, | |
94f04347 LP |
83 | _UNIT_ACTIVE_STATE_MAX, |
84 | _UNIT_ACTIVE_STATE_INVALID = -1 | |
87f0e418 LP |
85 | }; |
86 | ||
87 | static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) { | |
88 | return t == UNIT_ACTIVE || t == UNIT_ACTIVE_RELOADING; | |
89 | } | |
90 | ||
91 | static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) { | |
92 | return t == UNIT_ACTIVE || t == UNIT_ACTIVATING || t == UNIT_ACTIVE_RELOADING; | |
93 | } | |
94 | ||
95 | static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) { | |
96 | return t == UNIT_INACTIVE || t == UNIT_DEACTIVATING; | |
97 | } | |
98 | ||
99 | enum UnitDependency { | |
100 | /* Positive dependencies */ | |
101 | UNIT_REQUIRES, | |
9e2f7c11 | 102 | UNIT_REQUIRES_OVERRIDABLE, |
87f0e418 | 103 | UNIT_REQUISITE, |
9e2f7c11 LP |
104 | UNIT_REQUISITE_OVERRIDABLE, |
105 | UNIT_WANTS, | |
87f0e418 LP |
106 | |
107 | /* Inverse of the above */ | |
9e2f7c11 LP |
108 | UNIT_REQUIRED_BY, /* inverse of 'requires' and 'requisite' is 'required_by' */ |
109 | UNIT_REQUIRED_BY_OVERRIDABLE, /* inverse of 'soft_requires' and 'soft_requisite' is 'soft_required_by' */ | |
110 | UNIT_WANTED_BY, /* inverse of 'wants' */ | |
87f0e418 LP |
111 | |
112 | /* Negative dependencies */ | |
9e2f7c11 | 113 | UNIT_CONFLICTS, /* inverse of 'conflicts' is 'conflicts' */ |
87f0e418 LP |
114 | |
115 | /* Order */ | |
9e2f7c11 | 116 | UNIT_BEFORE, /* inverse of before is after and vice versa */ |
87f0e418 LP |
117 | UNIT_AFTER, |
118 | ||
119 | _UNIT_DEPENDENCY_MAX, | |
120 | _UNIT_DEPENDENCY_INVALID = -1 | |
121 | }; | |
122 | ||
ef734fd6 LP |
123 | #include "manager.h" |
124 | #include "job.h" | |
8e274523 | 125 | #include "cgroup.h" |
ef734fd6 | 126 | |
87f0e418 LP |
127 | struct Meta { |
128 | Manager *manager; | |
23a177ef | 129 | |
87f0e418 LP |
130 | UnitType type; |
131 | UnitLoadState load_state; | |
23a177ef | 132 | Unit *merged_into; |
87f0e418 LP |
133 | |
134 | char *id; /* One name is special because we use it for identification. Points to an entry in the names set */ | |
9e2f7c11 | 135 | char *instance; |
87f0e418 LP |
136 | |
137 | Set *names; | |
138 | Set *dependencies[_UNIT_DEPENDENCY_MAX]; | |
139 | ||
140 | char *description; | |
6be1e7d5 | 141 | char *fragment_path; /* if loaded from a config file this is the primary path to it */ |
87f0e418 LP |
142 | |
143 | /* If there is something to do with this unit, then this is | |
144 | * the job for it */ | |
145 | Job *job; | |
146 | ||
147 | bool in_load_queue:1; | |
c1e1601e | 148 | bool in_dbus_queue:1; |
23a177ef | 149 | bool in_cleanup_queue:1; |
c1e1601e | 150 | bool sent_dbus_new_signal:1; |
87f0e418 | 151 | |
f3bff0eb LP |
152 | /* If we go down, pull down everything that depends on us, too */ |
153 | bool recursive_stop; | |
154 | ||
155 | /* Garbage collect us we nobody wants or requires us anymore */ | |
156 | bool stop_when_unneeded; | |
157 | ||
87f0e418 LP |
158 | usec_t active_enter_timestamp; |
159 | usec_t active_exit_timestamp; | |
160 | ||
8e274523 LP |
161 | /* Counterparts in the cgroup filesystem */ |
162 | CGroupBonding *cgroup_bondings; | |
163 | ||
87f0e418 LP |
164 | /* Load queue */ |
165 | LIST_FIELDS(Meta, load_queue); | |
ef734fd6 LP |
166 | |
167 | /* Per type list */ | |
168 | LIST_FIELDS(Meta, units_per_type); | |
c1e1601e LP |
169 | |
170 | /* D-Bus queue */ | |
171 | LIST_FIELDS(Meta, dbus_queue); | |
23a177ef LP |
172 | |
173 | /* Cleanup queue */ | |
174 | LIST_FIELDS(Meta, cleanup_queue); | |
87f0e418 LP |
175 | }; |
176 | ||
177 | #include "service.h" | |
178 | #include "timer.h" | |
179 | #include "socket.h" | |
180 | #include "target.h" | |
181 | #include "device.h" | |
182 | #include "mount.h" | |
183 | #include "automount.h" | |
184 | #include "snapshot.h" | |
185 | ||
186 | union Unit { | |
187 | Meta meta; | |
188 | Service service; | |
189 | Timer timer; | |
190 | Socket socket; | |
191 | Target target; | |
192 | Device device; | |
193 | Mount mount; | |
194 | Automount automount; | |
195 | Snapshot snapshot; | |
196 | }; | |
197 | ||
198 | struct UnitVTable { | |
199 | const char *suffix; | |
200 | ||
e537352b LP |
201 | /* Can units of this type have multiple names? */ |
202 | bool no_alias:1; | |
203 | ||
204 | /* If true units of this types can never have "Requires" | |
205 | * dependencies, because state changes can only be observed, | |
206 | * not triggered */ | |
9e2f7c11 LP |
207 | bool no_requires:1; |
208 | ||
209 | /* Instances make no sense for this type */ | |
210 | bool no_instances:1; | |
e537352b LP |
211 | |
212 | /* This should reset all type-specific variables. This should | |
213 | * not allocate memory, and is either called with 0 | |
214 | * initialized data, or with data left from done() */ | |
215 | void (*init)(Unit *u); | |
216 | ||
217 | /* Actually load data from disk. This may fail, and should set | |
218 | * load_state to UNIT_LOADED, UNIT_MERGED or leave it at | |
219 | * UNIT_STUB if no configuration could be found. */ | |
220 | int (*load)(Unit *u); | |
221 | ||
222 | /* This should free all type-specific variables. It should be | |
223 | * idempotent. There's no need to reset variables that deal | |
224 | * with dynamic memory/resources. */ | |
87f0e418 | 225 | void (*done)(Unit *u); |
e537352b LP |
226 | |
227 | /* If a a lot of units got created via enumerate(), this is | |
228 | * where to actually set the state and call unit_notify(). */ | |
f50e0a01 | 229 | int (*coldplug)(Unit *u); |
87f0e418 LP |
230 | |
231 | void (*dump)(Unit *u, FILE *f, const char *prefix); | |
232 | ||
233 | int (*start)(Unit *u); | |
234 | int (*stop)(Unit *u); | |
235 | int (*reload)(Unit *u); | |
236 | ||
237 | bool (*can_reload)(Unit *u); | |
238 | ||
239 | /* Boils down the more complex internal state of this unit to | |
240 | * a simpler one that the engine can understand */ | |
241 | UnitActiveState (*active_state)(Unit *u); | |
242 | ||
10a94420 LP |
243 | /* Returns the substate specific to this unit type as |
244 | * string. This is purely information so that we can give the | |
245 | * user a more finegrained explanation in which actual state a | |
246 | * unit is in. */ | |
247 | const char* (*sub_state_to_string)(Unit *u); | |
248 | ||
acbb0225 | 249 | void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w); |
87f0e418 | 250 | void (*sigchld_event)(Unit *u, pid_t pid, int code, int status); |
acbb0225 | 251 | void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w); |
7824bbeb | 252 | |
05e343b7 LP |
253 | /* Called whenever any of the cgroups this unit watches for |
254 | * ran empty */ | |
8e274523 LP |
255 | void (*cgroup_notify_empty)(Unit *u); |
256 | ||
05e343b7 LP |
257 | /* Called whenever a name thus Unit registered for comes or |
258 | * goes away. */ | |
259 | void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner); | |
260 | ||
261 | /* Called whenever a bus PID lookup finishes */ | |
262 | void (*bus_query_pid_done)(Unit *u, const char *name, pid_t pid); | |
263 | ||
f50e0a01 LP |
264 | /* This is called for each unit type and should be used to |
265 | * enumerate existing devices and load them. However, | |
266 | * everything that is loaded here should still stay in | |
267 | * inactive state. It is the job of the coldplug() call above | |
268 | * to put the units into the initial state. */ | |
7824bbeb | 269 | int (*enumerate)(Manager *m); |
f50e0a01 LP |
270 | |
271 | /* Type specific cleanups. */ | |
7824bbeb | 272 | void (*shutdown)(Manager *m); |
87f0e418 LP |
273 | }; |
274 | ||
275 | extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX]; | |
276 | ||
277 | #define UNIT_VTABLE(u) unit_vtable[(u)->meta.type] | |
278 | ||
279 | /* For casting a unit into the various unit types */ | |
280 | #define DEFINE_CAST(UPPERCASE, MixedCase) \ | |
281 | static inline MixedCase* UPPERCASE(Unit *u) { \ | |
282 | if (!u || u->meta.type != UNIT_##UPPERCASE) \ | |
283 | return NULL; \ | |
284 | \ | |
285 | return (MixedCase*) u; \ | |
286 | } | |
287 | ||
288 | /* For casting the various unit types into a unit */ | |
289 | #define UNIT(u) ((Unit*) (u)) | |
290 | ||
291 | DEFINE_CAST(SOCKET, Socket); | |
292 | DEFINE_CAST(TIMER, Timer); | |
293 | DEFINE_CAST(SERVICE, Service); | |
294 | DEFINE_CAST(TARGET, Target); | |
295 | DEFINE_CAST(DEVICE, Device); | |
296 | DEFINE_CAST(MOUNT, Mount); | |
297 | DEFINE_CAST(AUTOMOUNT, Automount); | |
298 | DEFINE_CAST(SNAPSHOT, Snapshot); | |
299 | ||
87f0e418 LP |
300 | Unit *unit_new(Manager *m); |
301 | void unit_free(Unit *u); | |
302 | ||
303 | int unit_add_name(Unit *u, const char *name); | |
9e2f7c11 | 304 | |
87f0e418 | 305 | int unit_add_dependency(Unit *u, UnitDependency d, Unit *other); |
9e2f7c11 LP |
306 | int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename); |
307 | int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename); | |
0ae97ec1 | 308 | |
23a177ef LP |
309 | int unit_add_exec_dependencies(Unit *u, ExecContext *c); |
310 | ||
8e274523 LP |
311 | int unit_add_cgroup(Unit *u, CGroupBonding *b); |
312 | int unit_add_cgroup_from_text(Unit *u, const char *name); | |
313 | int unit_add_default_cgroup(Unit *u); | |
314 | CGroupBonding* unit_get_default_cgroup(Unit *u); | |
315 | ||
0ae97ec1 | 316 | int unit_choose_id(Unit *u, const char *name); |
f50e0a01 | 317 | int unit_set_description(Unit *u, const char *description); |
87f0e418 LP |
318 | |
319 | void unit_add_to_load_queue(Unit *u); | |
c1e1601e | 320 | void unit_add_to_dbus_queue(Unit *u); |
23a177ef | 321 | void unit_add_to_cleanup_queue(Unit *u); |
87f0e418 LP |
322 | |
323 | int unit_merge(Unit *u, Unit *other); | |
23a177ef LP |
324 | int unit_merge_by_name(Unit *u, const char *other); |
325 | ||
326 | Unit *unit_follow_merge(Unit *u); | |
87f0e418 | 327 | |
e537352b LP |
328 | int unit_load_fragment_and_dropin(Unit *u); |
329 | int unit_load_fragment_and_dropin_optional(Unit *u); | |
87f0e418 LP |
330 | int unit_load(Unit *unit); |
331 | ||
87f0e418 LP |
332 | const char *unit_description(Unit *u); |
333 | ||
f278026d LP |
334 | bool unit_has_name(Unit *u, const char *name); |
335 | ||
87f0e418 LP |
336 | UnitActiveState unit_active_state(Unit *u); |
337 | ||
10a94420 LP |
338 | const char* unit_sub_state_to_string(Unit *u); |
339 | ||
87f0e418 LP |
340 | void unit_dump(Unit *u, FILE *f, const char *prefix); |
341 | ||
342 | bool unit_can_reload(Unit *u); | |
343 | bool unit_can_start(Unit *u); | |
344 | ||
345 | int unit_start(Unit *u); | |
346 | int unit_stop(Unit *u); | |
347 | int unit_reload(Unit *u); | |
348 | ||
349 | void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns); | |
350 | ||
acbb0225 LP |
351 | int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w); |
352 | void unit_unwatch_fd(Unit *u, Watch *w); | |
87f0e418 LP |
353 | |
354 | int unit_watch_pid(Unit *u, pid_t pid); | |
355 | void unit_unwatch_pid(Unit *u, pid_t pid); | |
356 | ||
acbb0225 LP |
357 | int unit_watch_timer(Unit *u, usec_t delay, Watch *w); |
358 | void unit_unwatch_timer(Unit *u, Watch *w); | |
87f0e418 | 359 | |
05e343b7 LP |
360 | int unit_watch_bus_name(Unit *u, const char *name); |
361 | void unit_unwatch_bus_name(Unit *u, const char *name); | |
362 | ||
87f0e418 LP |
363 | bool unit_job_is_applicable(Unit *u, JobType j); |
364 | ||
0301abf4 LP |
365 | int set_unit_path(const char *p); |
366 | ||
50159e6a LP |
367 | char *unit_dbus_path(Unit *u); |
368 | ||
f6ff8c29 LP |
369 | int unit_load_related_unit(Unit *u, const char *type, Unit **_found); |
370 | ||
9e2f7c11 LP |
371 | char *unit_name_printf(Unit *u, const char* text); |
372 | char *unit_full_printf(Unit *u, const char *text); | |
373 | char **unit_full_printf_strv(Unit *u, char **l); | |
374 | ||
94f04347 LP |
375 | const char *unit_type_to_string(UnitType i); |
376 | UnitType unit_type_from_string(const char *s); | |
377 | ||
378 | const char *unit_load_state_to_string(UnitLoadState i); | |
379 | UnitLoadState unit_load_state_from_string(const char *s); | |
380 | ||
381 | const char *unit_active_state_to_string(UnitActiveState i); | |
382 | UnitActiveState unit_active_state_from_string(const char *s); | |
383 | ||
384 | const char *unit_dependency_to_string(UnitDependency i); | |
385 | UnitDependency unit_dependency_from_string(const char *s); | |
386 | ||
50159e6a LP |
387 | const char *kill_mode_to_string(KillMode k); |
388 | KillMode kill_mode_from_string(const char *s); | |
ea430986 | 389 | |
87f0e418 | 390 | #endif |