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