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