]>
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, | |
62 | UNIT_SNAPSHOT, | |
41447faf | 63 | UNIT_TIMER, |
07b0b134 | 64 | UNIT_SWAP, |
87f0e418 | 65 | _UNIT_TYPE_MAX, |
50159e6a | 66 | _UNIT_TYPE_INVALID = -1 |
87f0e418 LP |
67 | }; |
68 | ||
69 | enum UnitLoadState { | |
70 | UNIT_STUB, | |
71 | UNIT_LOADED, | |
72 | UNIT_FAILED, | |
23a177ef | 73 | UNIT_MERGED, |
94f04347 LP |
74 | _UNIT_LOAD_STATE_MAX, |
75 | _UNIT_LOAD_STATE_INVALID = -1 | |
87f0e418 LP |
76 | }; |
77 | ||
78 | enum UnitActiveState { | |
79 | UNIT_ACTIVE, | |
80 | UNIT_ACTIVE_RELOADING, | |
81 | UNIT_INACTIVE, | |
82 | UNIT_ACTIVATING, | |
83 | UNIT_DEACTIVATING, | |
94f04347 LP |
84 | _UNIT_ACTIVE_STATE_MAX, |
85 | _UNIT_ACTIVE_STATE_INVALID = -1 | |
87f0e418 LP |
86 | }; |
87 | ||
88 | static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) { | |
89 | return t == UNIT_ACTIVE || t == UNIT_ACTIVE_RELOADING; | |
90 | } | |
91 | ||
92 | static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) { | |
93 | return t == UNIT_ACTIVE || t == UNIT_ACTIVATING || t == UNIT_ACTIVE_RELOADING; | |
94 | } | |
95 | ||
96 | static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) { | |
97 | return t == UNIT_INACTIVE || t == UNIT_DEACTIVATING; | |
98 | } | |
99 | ||
100 | enum UnitDependency { | |
101 | /* Positive dependencies */ | |
102 | UNIT_REQUIRES, | |
9e2f7c11 | 103 | UNIT_REQUIRES_OVERRIDABLE, |
87f0e418 | 104 | UNIT_REQUISITE, |
9e2f7c11 LP |
105 | UNIT_REQUISITE_OVERRIDABLE, |
106 | UNIT_WANTS, | |
87f0e418 LP |
107 | |
108 | /* Inverse of the above */ | |
9e2f7c11 LP |
109 | UNIT_REQUIRED_BY, /* inverse of 'requires' and 'requisite' is 'required_by' */ |
110 | UNIT_REQUIRED_BY_OVERRIDABLE, /* inverse of 'soft_requires' and 'soft_requisite' is 'soft_required_by' */ | |
111 | UNIT_WANTED_BY, /* inverse of 'wants' */ | |
87f0e418 LP |
112 | |
113 | /* Negative dependencies */ | |
9e2f7c11 | 114 | UNIT_CONFLICTS, /* inverse of 'conflicts' is 'conflicts' */ |
87f0e418 LP |
115 | |
116 | /* Order */ | |
701cc384 | 117 | UNIT_BEFORE, /* inverse of 'before' is 'after' and vice versa */ |
87f0e418 LP |
118 | UNIT_AFTER, |
119 | ||
701cc384 LP |
120 | /* Reference information for GC logic */ |
121 | UNIT_REFERENCES, /* Inverse of 'references' is 'referenced_by' */ | |
122 | UNIT_REFERENCED_BY, | |
123 | ||
87f0e418 LP |
124 | _UNIT_DEPENDENCY_MAX, |
125 | _UNIT_DEPENDENCY_INVALID = -1 | |
126 | }; | |
127 | ||
ef734fd6 LP |
128 | #include "manager.h" |
129 | #include "job.h" | |
8e274523 | 130 | #include "cgroup.h" |
ef734fd6 | 131 | |
87f0e418 LP |
132 | struct Meta { |
133 | Manager *manager; | |
23a177ef | 134 | |
87f0e418 LP |
135 | UnitType type; |
136 | UnitLoadState load_state; | |
23a177ef | 137 | Unit *merged_into; |
87f0e418 | 138 | |
bc0f8771 LP |
139 | /* Refuse manual starting, allow starting only indirectly via dependency. */ |
140 | bool only_by_dependency; | |
141 | ||
87f0e418 | 142 | char *id; /* One name is special because we use it for identification. Points to an entry in the names set */ |
9e2f7c11 | 143 | char *instance; |
87f0e418 LP |
144 | |
145 | Set *names; | |
146 | Set *dependencies[_UNIT_DEPENDENCY_MAX]; | |
147 | ||
148 | char *description; | |
6be1e7d5 | 149 | char *fragment_path; /* if loaded from a config file this is the primary path to it */ |
87f0e418 LP |
150 | |
151 | /* If there is something to do with this unit, then this is | |
152 | * the job for it */ | |
153 | Job *job; | |
154 | ||
871d7de4 LP |
155 | timestamp inactive_exit_timestamp; |
156 | timestamp active_enter_timestamp; | |
157 | timestamp active_exit_timestamp; | |
158 | timestamp inactive_enter_timestamp; | |
87f0e418 | 159 | |
8e274523 LP |
160 | /* Counterparts in the cgroup filesystem */ |
161 | CGroupBonding *cgroup_bondings; | |
162 | ||
ef734fd6 LP |
163 | /* Per type list */ |
164 | LIST_FIELDS(Meta, units_per_type); | |
c1e1601e | 165 | |
701cc384 LP |
166 | /* Load queue */ |
167 | LIST_FIELDS(Meta, load_queue); | |
168 | ||
c1e1601e LP |
169 | /* D-Bus queue */ |
170 | LIST_FIELDS(Meta, dbus_queue); | |
23a177ef LP |
171 | |
172 | /* Cleanup queue */ | |
173 | LIST_FIELDS(Meta, cleanup_queue); | |
9d58f1db | 174 | |
701cc384 LP |
175 | /* GC queue */ |
176 | LIST_FIELDS(Meta, gc_queue); | |
177 | ||
178 | /* Used during GC sweeps */ | |
eced69b3 | 179 | unsigned gc_marker; |
701cc384 | 180 | |
9d58f1db LP |
181 | /* If we go down, pull down everything that depends on us, too */ |
182 | bool recursive_stop; | |
183 | ||
184 | /* Garbage collect us we nobody wants or requires us anymore */ | |
185 | bool stop_when_unneeded; | |
186 | ||
187 | bool in_load_queue:1; | |
188 | bool in_dbus_queue:1; | |
189 | bool in_cleanup_queue:1; | |
701cc384 LP |
190 | bool in_gc_queue:1; |
191 | ||
9d58f1db | 192 | bool sent_dbus_new_signal:1; |
87f0e418 LP |
193 | }; |
194 | ||
195 | #include "service.h" | |
196 | #include "timer.h" | |
197 | #include "socket.h" | |
198 | #include "target.h" | |
199 | #include "device.h" | |
200 | #include "mount.h" | |
201 | #include "automount.h" | |
202 | #include "snapshot.h" | |
07b0b134 | 203 | #include "swap.h" |
87f0e418 LP |
204 | |
205 | union Unit { | |
206 | Meta meta; | |
207 | Service service; | |
208 | Timer timer; | |
209 | Socket socket; | |
210 | Target target; | |
211 | Device device; | |
212 | Mount mount; | |
213 | Automount automount; | |
214 | Snapshot snapshot; | |
07b0b134 | 215 | Swap swap; |
87f0e418 LP |
216 | }; |
217 | ||
218 | struct UnitVTable { | |
219 | const char *suffix; | |
220 | ||
e537352b | 221 | /* This should reset all type-specific variables. This should |
a16e1123 LP |
222 | * not allocate memory, and is called with zero-initialized |
223 | * data. It should hence only initialize variables that need | |
224 | * to be set != 0. */ | |
e537352b LP |
225 | void (*init)(Unit *u); |
226 | ||
a16e1123 LP |
227 | /* This should free all type-specific variables. It should be |
228 | * idempotent. */ | |
229 | void (*done)(Unit *u); | |
230 | ||
e537352b LP |
231 | /* Actually load data from disk. This may fail, and should set |
232 | * load_state to UNIT_LOADED, UNIT_MERGED or leave it at | |
233 | * UNIT_STUB if no configuration could be found. */ | |
234 | int (*load)(Unit *u); | |
235 | ||
e537352b LP |
236 | /* If a a lot of units got created via enumerate(), this is |
237 | * where to actually set the state and call unit_notify(). */ | |
f50e0a01 | 238 | int (*coldplug)(Unit *u); |
87f0e418 LP |
239 | |
240 | void (*dump)(Unit *u, FILE *f, const char *prefix); | |
241 | ||
242 | int (*start)(Unit *u); | |
243 | int (*stop)(Unit *u); | |
244 | int (*reload)(Unit *u); | |
245 | ||
246 | bool (*can_reload)(Unit *u); | |
247 | ||
a16e1123 LP |
248 | /* Write all data that cannot be restored from other sources |
249 | * away using unit_serialize_item() */ | |
250 | int (*serialize)(Unit *u, FILE *f, FDSet *fds); | |
251 | ||
252 | /* Restore one item from the serialization */ | |
253 | int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds); | |
254 | ||
87f0e418 LP |
255 | /* Boils down the more complex internal state of this unit to |
256 | * a simpler one that the engine can understand */ | |
257 | UnitActiveState (*active_state)(Unit *u); | |
258 | ||
10a94420 LP |
259 | /* Returns the substate specific to this unit type as |
260 | * string. This is purely information so that we can give the | |
261 | * user a more finegrained explanation in which actual state a | |
262 | * unit is in. */ | |
263 | const char* (*sub_state_to_string)(Unit *u); | |
264 | ||
701cc384 LP |
265 | /* Return true when there is reason to keep this entry around |
266 | * even nothing references it and it isn't active in any | |
267 | * way */ | |
268 | bool (*check_gc)(Unit *u); | |
269 | ||
270 | /* Return true when this unit is suitable for snapshotting */ | |
271 | bool (*check_snapshot)(Unit *u); | |
272 | ||
acbb0225 | 273 | void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w); |
87f0e418 | 274 | void (*sigchld_event)(Unit *u, pid_t pid, int code, int status); |
acbb0225 | 275 | void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w); |
7824bbeb | 276 | |
05e343b7 LP |
277 | /* Called whenever any of the cgroups this unit watches for |
278 | * ran empty */ | |
8e274523 LP |
279 | void (*cgroup_notify_empty)(Unit *u); |
280 | ||
05e343b7 LP |
281 | /* Called whenever a name thus Unit registered for comes or |
282 | * goes away. */ | |
283 | void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner); | |
284 | ||
285 | /* Called whenever a bus PID lookup finishes */ | |
286 | void (*bus_query_pid_done)(Unit *u, const char *name, pid_t pid); | |
287 | ||
4139c1b2 LP |
288 | /* Called for each message received on the bus */ |
289 | DBusHandlerResult (*bus_message_handler)(Unit *u, DBusMessage *message); | |
290 | ||
f50e0a01 LP |
291 | /* This is called for each unit type and should be used to |
292 | * enumerate existing devices and load them. However, | |
293 | * everything that is loaded here should still stay in | |
294 | * inactive state. It is the job of the coldplug() call above | |
295 | * to put the units into the initial state. */ | |
7824bbeb | 296 | int (*enumerate)(Manager *m); |
f50e0a01 LP |
297 | |
298 | /* Type specific cleanups. */ | |
7824bbeb | 299 | void (*shutdown)(Manager *m); |
9d58f1db LP |
300 | |
301 | /* Can units of this type have multiple names? */ | |
302 | bool no_alias:1; | |
303 | ||
304 | /* If true units of this types can never have "Requires" | |
305 | * dependencies, because state changes can only be observed, | |
306 | * not triggered */ | |
307 | bool no_requires:1; | |
308 | ||
309 | /* Instances make no sense for this type */ | |
310 | bool no_instances:1; | |
311 | ||
312 | /* Exclude this type from snapshots */ | |
313 | bool no_snapshots:1; | |
701cc384 LP |
314 | |
315 | /* Exclude from automatic gc */ | |
316 | bool no_gc:1; | |
c497c7a9 LP |
317 | |
318 | /* Exclude from isolation requests */ | |
319 | bool no_isolate:1; | |
87f0e418 LP |
320 | }; |
321 | ||
322 | extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX]; | |
323 | ||
324 | #define UNIT_VTABLE(u) unit_vtable[(u)->meta.type] | |
325 | ||
326 | /* For casting a unit into the various unit types */ | |
327 | #define DEFINE_CAST(UPPERCASE, MixedCase) \ | |
328 | static inline MixedCase* UPPERCASE(Unit *u) { \ | |
329 | if (!u || u->meta.type != UNIT_##UPPERCASE) \ | |
330 | return NULL; \ | |
331 | \ | |
332 | return (MixedCase*) u; \ | |
333 | } | |
334 | ||
335 | /* For casting the various unit types into a unit */ | |
336 | #define UNIT(u) ((Unit*) (u)) | |
337 | ||
338 | DEFINE_CAST(SOCKET, Socket); | |
339 | DEFINE_CAST(TIMER, Timer); | |
340 | DEFINE_CAST(SERVICE, Service); | |
341 | DEFINE_CAST(TARGET, Target); | |
342 | DEFINE_CAST(DEVICE, Device); | |
343 | DEFINE_CAST(MOUNT, Mount); | |
344 | DEFINE_CAST(AUTOMOUNT, Automount); | |
345 | DEFINE_CAST(SNAPSHOT, Snapshot); | |
07b0b134 | 346 | DEFINE_CAST(SWAP, Swap); |
87f0e418 | 347 | |
87f0e418 LP |
348 | Unit *unit_new(Manager *m); |
349 | void unit_free(Unit *u); | |
350 | ||
351 | int unit_add_name(Unit *u, const char *name); | |
9e2f7c11 | 352 | |
701cc384 LP |
353 | int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference); |
354 | int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference); | |
355 | int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference); | |
0ae97ec1 | 356 | |
23a177ef LP |
357 | int unit_add_exec_dependencies(Unit *u, ExecContext *c); |
358 | ||
8e274523 LP |
359 | int unit_add_cgroup(Unit *u, CGroupBonding *b); |
360 | int unit_add_cgroup_from_text(Unit *u, const char *name); | |
361 | int unit_add_default_cgroup(Unit *u); | |
362 | CGroupBonding* unit_get_default_cgroup(Unit *u); | |
363 | ||
0ae97ec1 | 364 | int unit_choose_id(Unit *u, const char *name); |
f50e0a01 | 365 | int unit_set_description(Unit *u, const char *description); |
87f0e418 | 366 | |
701cc384 LP |
367 | bool unit_check_gc(Unit *u); |
368 | ||
87f0e418 | 369 | void unit_add_to_load_queue(Unit *u); |
c1e1601e | 370 | void unit_add_to_dbus_queue(Unit *u); |
23a177ef | 371 | void unit_add_to_cleanup_queue(Unit *u); |
701cc384 | 372 | void unit_add_to_gc_queue(Unit *u); |
87f0e418 LP |
373 | |
374 | int unit_merge(Unit *u, Unit *other); | |
23a177ef LP |
375 | int unit_merge_by_name(Unit *u, const char *other); |
376 | ||
377 | Unit *unit_follow_merge(Unit *u); | |
87f0e418 | 378 | |
e537352b LP |
379 | int unit_load_fragment_and_dropin(Unit *u); |
380 | int unit_load_fragment_and_dropin_optional(Unit *u); | |
a16e1123 | 381 | int unit_load_nop(Unit *u); |
87f0e418 LP |
382 | int unit_load(Unit *unit); |
383 | ||
87f0e418 LP |
384 | const char *unit_description(Unit *u); |
385 | ||
f278026d LP |
386 | bool unit_has_name(Unit *u, const char *name); |
387 | ||
87f0e418 LP |
388 | UnitActiveState unit_active_state(Unit *u); |
389 | ||
10a94420 LP |
390 | const char* unit_sub_state_to_string(Unit *u); |
391 | ||
87f0e418 LP |
392 | void unit_dump(Unit *u, FILE *f, const char *prefix); |
393 | ||
394 | bool unit_can_reload(Unit *u); | |
395 | bool unit_can_start(Unit *u); | |
396 | ||
397 | int unit_start(Unit *u); | |
398 | int unit_stop(Unit *u); | |
399 | int unit_reload(Unit *u); | |
400 | ||
401 | void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns); | |
402 | ||
acbb0225 LP |
403 | int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w); |
404 | void unit_unwatch_fd(Unit *u, Watch *w); | |
87f0e418 LP |
405 | |
406 | int unit_watch_pid(Unit *u, pid_t pid); | |
407 | void unit_unwatch_pid(Unit *u, pid_t pid); | |
408 | ||
acbb0225 LP |
409 | int unit_watch_timer(Unit *u, usec_t delay, Watch *w); |
410 | void unit_unwatch_timer(Unit *u, Watch *w); | |
87f0e418 | 411 | |
05e343b7 LP |
412 | int unit_watch_bus_name(Unit *u, const char *name); |
413 | void unit_unwatch_bus_name(Unit *u, const char *name); | |
414 | ||
87f0e418 LP |
415 | bool unit_job_is_applicable(Unit *u, JobType j); |
416 | ||
0301abf4 LP |
417 | int set_unit_path(const char *p); |
418 | ||
50159e6a LP |
419 | char *unit_dbus_path(Unit *u); |
420 | ||
f6ff8c29 | 421 | int unit_load_related_unit(Unit *u, const char *type, Unit **_found); |
a16e1123 | 422 | int unit_get_related_unit(Unit *u, const char *type, Unit **_found); |
f6ff8c29 | 423 | |
9e2f7c11 LP |
424 | char *unit_name_printf(Unit *u, const char* text); |
425 | char *unit_full_printf(Unit *u, const char *text); | |
426 | char **unit_full_printf_strv(Unit *u, char **l); | |
427 | ||
a16e1123 LP |
428 | bool unit_can_serialize(Unit *u); |
429 | int unit_serialize(Unit *u, FILE *f, FDSet *fds); | |
430 | void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_attr(4,5); | |
431 | void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value); | |
432 | int unit_deserialize(Unit *u, FILE *f, FDSet *fds); | |
433 | ||
6e2ef85b LP |
434 | int unit_add_node_link(Unit *u, const char *what, bool wants); |
435 | ||
94f04347 LP |
436 | const char *unit_type_to_string(UnitType i); |
437 | UnitType unit_type_from_string(const char *s); | |
438 | ||
439 | const char *unit_load_state_to_string(UnitLoadState i); | |
440 | UnitLoadState unit_load_state_from_string(const char *s); | |
441 | ||
442 | const char *unit_active_state_to_string(UnitActiveState i); | |
443 | UnitActiveState unit_active_state_from_string(const char *s); | |
444 | ||
445 | const char *unit_dependency_to_string(UnitDependency i); | |
446 | UnitDependency unit_dependency_from_string(const char *s); | |
447 | ||
50159e6a LP |
448 | const char *kill_mode_to_string(KillMode k); |
449 | KillMode kill_mode_from_string(const char *s); | |
ea430986 | 450 | |
87f0e418 | 451 | #endif |