chiark / gitweb /
core: add transient units
[elogind.git] / src / core / unit.h
1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
2
3 #pragma once
4
5 /***
6   This file is part of systemd.
7
8   Copyright 2010 Lennart Poettering
9
10   systemd is free software; you can redistribute it and/or modify it
11   under the terms of the GNU Lesser General Public License as published by
12   the Free Software Foundation; either version 2.1 of the License, or
13   (at your option) any later version.
14
15   systemd is distributed in the hope that it will be useful, but
16   WITHOUT ANY WARRANTY; without even the implied warranty of
17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18   Lesser General Public License for more details.
19
20   You should have received a copy of the GNU Lesser General Public License
21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
22 ***/
23
24 #include <stdbool.h>
25 #include <stdlib.h>
26 #include <unistd.h>
27
28 typedef struct Unit Unit;
29 typedef struct UnitVTable UnitVTable;
30 typedef enum UnitActiveState UnitActiveState;
31 typedef enum UnitDependency UnitDependency;
32 typedef struct UnitRef UnitRef;
33 typedef struct UnitStatusMessageFormats UnitStatusMessageFormats;
34
35 #include "set.h"
36 #include "util.h"
37 #include "list.h"
38 #include "socket-util.h"
39 #include "execute.h"
40 #include "cgroup.h"
41 #include "condition.h"
42 #include "install.h"
43 #include "unit-name.h"
44
45 enum UnitActiveState {
46         UNIT_ACTIVE,
47         UNIT_RELOADING,
48         UNIT_INACTIVE,
49         UNIT_FAILED,
50         UNIT_ACTIVATING,
51         UNIT_DEACTIVATING,
52         _UNIT_ACTIVE_STATE_MAX,
53         _UNIT_ACTIVE_STATE_INVALID = -1
54 };
55
56 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) {
57         return t == UNIT_ACTIVE || t == UNIT_RELOADING;
58 }
59
60 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) {
61         return t == UNIT_ACTIVE || t == UNIT_ACTIVATING || t == UNIT_RELOADING;
62 }
63
64 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) {
65         return t == UNIT_INACTIVE || t == UNIT_FAILED || t == UNIT_DEACTIVATING;
66 }
67
68 static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t) {
69         return t == UNIT_INACTIVE || t == UNIT_FAILED;
70 }
71
72 enum UnitDependency {
73         /* Positive dependencies */
74         UNIT_REQUIRES,
75         UNIT_REQUIRES_OVERRIDABLE,
76         UNIT_REQUISITE,
77         UNIT_REQUISITE_OVERRIDABLE,
78         UNIT_WANTS,
79         UNIT_BINDS_TO,
80         UNIT_PART_OF,
81
82         /* Inverse of the above */
83         UNIT_REQUIRED_BY,             /* inverse of 'requires' and 'requisite' is 'required_by' */
84         UNIT_REQUIRED_BY_OVERRIDABLE, /* inverse of 'requires_overridable' and 'requisite_overridable' is 'soft_required_by' */
85         UNIT_WANTED_BY,               /* inverse of 'wants' */
86         UNIT_BOUND_BY,                /* inverse of 'binds_to' */
87         UNIT_CONSISTS_OF,             /* inverse of 'part_of' */
88
89         /* Negative dependencies */
90         UNIT_CONFLICTS,               /* inverse of 'conflicts' is 'conflicted_by' */
91         UNIT_CONFLICTED_BY,
92
93         /* Order */
94         UNIT_BEFORE,                  /* inverse of 'before' is 'after' and vice versa */
95         UNIT_AFTER,
96
97         /* On Failure */
98         UNIT_ON_FAILURE,
99
100         /* Triggers (i.e. a socket triggers a service) */
101         UNIT_TRIGGERS,
102         UNIT_TRIGGERED_BY,
103
104         /* Propagate reloads */
105         UNIT_PROPAGATES_RELOAD_TO,
106         UNIT_RELOAD_PROPAGATED_FROM,
107
108         /* Reference information for GC logic */
109         UNIT_REFERENCES,              /* Inverse of 'references' is 'referenced_by' */
110         UNIT_REFERENCED_BY,
111
112         _UNIT_DEPENDENCY_MAX,
113         _UNIT_DEPENDENCY_INVALID = -1
114 };
115
116 #include "manager.h"
117 #include "job.h"
118
119 struct UnitRef {
120         /* Keeps tracks of references to a unit. This is useful so
121          * that we can merge two units if necessary and correct all
122          * references to them */
123
124         Unit* unit;
125         LIST_FIELDS(UnitRef, refs);
126 };
127
128 struct Unit {
129         Manager *manager;
130
131         UnitType type;
132         UnitLoadState load_state;
133         Unit *merged_into;
134
135         char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
136         char *instance;
137
138         Set *names;
139         Set *dependencies[_UNIT_DEPENDENCY_MAX];
140
141         char **requires_mounts_for;
142
143         char *description;
144         char **documentation;
145
146         char *fragment_path; /* if loaded from a config file this is the primary path to it */
147         char *source_path; /* if converted, the source file */
148         char **dropin_paths;
149         usec_t fragment_mtime;
150         usec_t source_mtime;
151         usec_t dropin_mtime;
152
153         /* If there is something to do with this unit, then this is the installed job for it */
154         Job *job;
155
156         /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
157         Job *nop_job;
158
159         usec_t job_timeout;
160
161         /* References to this */
162         LIST_HEAD(UnitRef, refs);
163
164         /* Conditions to check */
165         LIST_HEAD(Condition, conditions);
166
167         dual_timestamp condition_timestamp;
168
169         dual_timestamp inactive_exit_timestamp;
170         dual_timestamp active_enter_timestamp;
171         dual_timestamp active_exit_timestamp;
172         dual_timestamp inactive_enter_timestamp;
173
174         /* Counterparts in the cgroup filesystem */
175         char *cgroup_path;
176         bool cgroup_realized;
177         CGroupControllerMask cgroup_mask;
178
179         UnitRef slice;
180
181         /* Per type list */
182         LIST_FIELDS(Unit, units_by_type);
183
184         /* All units which have requires_mounts_for set */
185         LIST_FIELDS(Unit, has_requires_mounts_for);
186
187         /* Load queue */
188         LIST_FIELDS(Unit, load_queue);
189
190         /* D-Bus queue */
191         LIST_FIELDS(Unit, dbus_queue);
192
193         /* Cleanup queue */
194         LIST_FIELDS(Unit, cleanup_queue);
195
196         /* GC queue */
197         LIST_FIELDS(Unit, gc_queue);
198
199         /* CGroup realize members queue */
200         LIST_FIELDS(Unit, cgroup_queue);
201
202         /* Used during GC sweeps */
203         unsigned gc_marker;
204
205         /* When deserializing, temporarily store the job type for this
206          * unit here, if there was a job scheduled.
207          * Only for deserializing from a legacy version. New style uses full
208          * serialized jobs. */
209         int deserialized_job; /* This is actually of type JobType */
210
211         /* Error code when we didn't manage to load the unit (negative) */
212         int load_error;
213
214         /* Cached unit file state */
215         UnitFileState unit_file_state;
216
217         /* Garbage collect us we nobody wants or requires us anymore */
218         bool stop_when_unneeded;
219
220         /* Create default dependencies */
221         bool default_dependencies;
222
223         /* Refuse manual starting, allow starting only indirectly via dependency. */
224         bool refuse_manual_start;
225
226         /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
227         bool refuse_manual_stop;
228
229         /* Allow isolation requests */
230         bool allow_isolate;
231
232         /* Isolate OnFailure unit */
233         bool on_failure_isolate;
234
235         /* Ignore this unit when isolating */
236         bool ignore_on_isolate;
237
238         /* Ignore this unit when snapshotting */
239         bool ignore_on_snapshot;
240
241         /* Did the last condition check succeed? */
242         bool condition_result;
243
244         /* Is this a transient unit? */
245         bool transient;
246
247         bool in_load_queue:1;
248         bool in_dbus_queue:1;
249         bool in_cleanup_queue:1;
250         bool in_gc_queue:1;
251         bool in_cgroup_queue:1;
252
253         bool sent_dbus_new_signal:1;
254
255         bool no_gc:1;
256
257         bool in_audit:1;
258 };
259
260 struct UnitStatusMessageFormats {
261         const char *starting_stopping[2];
262         const char *finished_start_job[_JOB_RESULT_MAX];
263         const char *finished_stop_job[_JOB_RESULT_MAX];
264 };
265
266 typedef enum UnitSetPropertiesMode {
267         UNIT_CHECK = 0,
268         UNIT_RUNTIME = 1,
269         UNIT_PERSISTENT = 2,
270 } UnitSetPropertiesMode;
271
272 #include "service.h"
273 #include "timer.h"
274 #include "socket.h"
275 #include "target.h"
276 #include "device.h"
277 #include "mount.h"
278 #include "automount.h"
279 #include "snapshot.h"
280 #include "swap.h"
281 #include "path.h"
282 #include "slice.h"
283
284 struct UnitVTable {
285         /* How much memory does an object of this unit type need */
286         size_t object_size;
287
288         /* If greater than 0, the offset into the object where
289          * ExecContext is found, if the unit type has that */
290         size_t exec_context_offset;
291
292         /* If greater than 0, the offset into the object where
293          * CGroupContext is found, if the unit type has that */
294         size_t cgroup_context_offset;
295
296         /* The name of the configuration file section with the private settings of this unit*/
297         const char *private_section;
298
299         /* Config file sections this unit type understands, separated
300          * by NUL chars */
301         const char *sections;
302
303         /* This should reset all type-specific variables. This should
304          * not allocate memory, and is called with zero-initialized
305          * data. It should hence only initialize variables that need
306          * to be set != 0. */
307         void (*init)(Unit *u);
308
309         /* This should free all type-specific variables. It should be
310          * idempotent. */
311         void (*done)(Unit *u);
312
313         /* Actually load data from disk. This may fail, and should set
314          * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
315          * UNIT_STUB if no configuration could be found. */
316         int (*load)(Unit *u);
317
318         /* If a lot of units got created via enumerate(), this is
319          * where to actually set the state and call unit_notify(). */
320         int (*coldplug)(Unit *u);
321
322         void (*dump)(Unit *u, FILE *f, const char *prefix);
323
324         int (*start)(Unit *u);
325         int (*stop)(Unit *u);
326         int (*reload)(Unit *u);
327
328         int (*kill)(Unit *u, KillWho w, int signo, DBusError *error);
329
330         bool (*can_reload)(Unit *u);
331
332         /* Write all data that cannot be restored from other sources
333          * away using unit_serialize_item() */
334         int (*serialize)(Unit *u, FILE *f, FDSet *fds);
335
336         /* Restore one item from the serialization */
337         int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
338
339         /* Try to match up fds with what we need for this unit */
340         int (*distribute_fds)(Unit *u, FDSet *fds);
341
342         /* Boils down the more complex internal state of this unit to
343          * a simpler one that the engine can understand */
344         UnitActiveState (*active_state)(Unit *u);
345
346         /* Returns the substate specific to this unit type as
347          * string. This is purely information so that we can give the
348          * user a more fine grained explanation in which actual state a
349          * unit is in. */
350         const char* (*sub_state_to_string)(Unit *u);
351
352         /* Return true when there is reason to keep this entry around
353          * even nothing references it and it isn't active in any
354          * way */
355         bool (*check_gc)(Unit *u);
356
357         /* Return true when this unit is suitable for snapshotting */
358         bool (*check_snapshot)(Unit *u);
359
360         void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
361         void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
362         void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
363
364         /* Reset failed state if we are in failed state */
365         void (*reset_failed)(Unit *u);
366
367         /* Called whenever any of the cgroups this unit watches for
368          * ran empty */
369         void (*notify_cgroup_empty)(Unit *u);
370
371         /* Called whenever a process of this unit sends us a message */
372         void (*notify_message)(Unit *u, pid_t pid, char **tags);
373
374         /* Called whenever a name this Unit registered for comes or
375          * goes away. */
376         void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
377
378         /* Called whenever a bus PID lookup finishes */
379         void (*bus_query_pid_done)(Unit *u, const char *name, pid_t pid);
380
381         /* Called for each message received on the bus */
382         DBusHandlerResult (*bus_message_handler)(Unit *u, DBusConnection *c, DBusMessage *message);
383
384         /* Called for each property that is being set */
385         int (*bus_set_property)(Unit *u, const char *name, DBusMessageIter *i, UnitSetPropertiesMode mode, DBusError *error);
386
387         /* Called after at least one property got changed to apply the necessary change */
388         int (*bus_commit_properties)(Unit *u);
389
390         /* Return the unit this unit is following */
391         Unit *(*following)(Unit *u);
392
393         /* Return the set of units that are following each other */
394         int (*following_set)(Unit *u, Set **s);
395
396         /* Invoked each time a unit this unit is triggering changes
397          * state or gains/loses a job */
398         void (*trigger_notify)(Unit *u, Unit *trigger);
399
400         /* Called whenever CLOCK_REALTIME made a jump */
401         void (*time_change)(Unit *u);
402
403         /* This is called for each unit type and should be used to
404          * enumerate existing devices and load them. However,
405          * everything that is loaded here should still stay in
406          * inactive state. It is the job of the coldplug() call above
407          * to put the units into the initial state.  */
408         int (*enumerate)(Manager *m);
409
410         /* Type specific cleanups. */
411         void (*shutdown)(Manager *m);
412
413         /* When sending out PropertiesChanged signal, which properties
414          * shall be invalidated? This is a NUL separated list of
415          * strings, to minimize relocations a little. */
416         const char *bus_invalidating_properties;
417
418         /* The interface name */
419         const char *bus_interface;
420
421         UnitStatusMessageFormats status_message_formats;
422
423         /* Can units of this type have multiple names? */
424         bool no_alias:1;
425
426         /* Instances make no sense for this type */
427         bool no_instances:1;
428
429         /* Exclude from automatic gc */
430         bool no_gc:1;
431
432         /* True if transient units of this type are OK */
433         bool can_transient:1;
434 };
435
436 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
437
438 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
439
440 /* For casting a unit into the various unit types */
441 #define DEFINE_CAST(UPPERCASE, MixedCase)                               \
442         static inline MixedCase* UPPERCASE(Unit *u) {                   \
443                 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE))      \
444                         return NULL;                                    \
445                                                                         \
446                 return (MixedCase*) u;                                  \
447         }
448
449 /* For casting the various unit types into a unit */
450 #define UNIT(u) (&(u)->meta)
451
452 #define UNIT_TRIGGER(u) ((Unit*) set_first((u)->dependencies[UNIT_TRIGGERS]))
453
454 DEFINE_CAST(SOCKET, Socket);
455 DEFINE_CAST(TIMER, Timer);
456 DEFINE_CAST(SERVICE, Service);
457 DEFINE_CAST(TARGET, Target);
458 DEFINE_CAST(DEVICE, Device);
459 DEFINE_CAST(MOUNT, Mount);
460 DEFINE_CAST(AUTOMOUNT, Automount);
461 DEFINE_CAST(SNAPSHOT, Snapshot);
462 DEFINE_CAST(SWAP, Swap);
463 DEFINE_CAST(PATH, Path);
464 DEFINE_CAST(SLICE, Slice);
465
466 Unit *unit_new(Manager *m, size_t size);
467 void unit_free(Unit *u);
468
469 int unit_add_name(Unit *u, const char *name);
470
471 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
472 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
473
474 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
475 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
476
477 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
478 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
479
480 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
481
482 int unit_choose_id(Unit *u, const char *name);
483 int unit_set_description(Unit *u, const char *description);
484
485 bool unit_check_gc(Unit *u);
486
487 void unit_add_to_load_queue(Unit *u);
488 void unit_add_to_dbus_queue(Unit *u);
489 void unit_add_to_cleanup_queue(Unit *u);
490 void unit_add_to_gc_queue(Unit *u);
491
492 int unit_merge(Unit *u, Unit *other);
493 int unit_merge_by_name(Unit *u, const char *other);
494
495 Unit *unit_follow_merge(Unit *u) _pure_;
496
497 int unit_load_fragment_and_dropin(Unit *u);
498 int unit_load_fragment_and_dropin_optional(Unit *u);
499 int unit_load(Unit *unit);
500
501 int unit_add_default_slice(Unit *u);
502
503 const char *unit_description(Unit *u) _pure_;
504
505 bool unit_has_name(Unit *u, const char *name);
506
507 UnitActiveState unit_active_state(Unit *u);
508
509 const char* unit_sub_state_to_string(Unit *u);
510
511 void unit_dump(Unit *u, FILE *f, const char *prefix);
512
513 bool unit_can_reload(Unit *u) _pure_;
514 bool unit_can_start(Unit *u) _pure_;
515 bool unit_can_isolate(Unit *u) _pure_;
516
517 int unit_start(Unit *u);
518 int unit_stop(Unit *u);
519 int unit_reload(Unit *u);
520
521 int unit_kill(Unit *u, KillWho w, int signo, DBusError *error);
522 int unit_kill_common(Unit *u, KillWho who, int signo, pid_t main_pid, pid_t control_pid, DBusError *error);
523
524 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
525
526 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
527 void unit_unwatch_fd(Unit *u, Watch *w);
528
529 int unit_watch_pid(Unit *u, pid_t pid);
530 void unit_unwatch_pid(Unit *u, pid_t pid);
531
532 int unit_watch_timer(Unit *u, clockid_t, bool relative, usec_t usec, Watch *w);
533 void unit_unwatch_timer(Unit *u, Watch *w);
534
535 int unit_watch_bus_name(Unit *u, const char *name);
536 void unit_unwatch_bus_name(Unit *u, const char *name);
537
538 bool unit_job_is_applicable(Unit *u, JobType j);
539
540 int set_unit_path(const char *p);
541
542 char *unit_dbus_path(Unit *u);
543
544 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
545 int unit_get_related_unit(Unit *u, const char *type, Unit **_found);
546
547 bool unit_can_serialize(Unit *u) _pure_;
548 int unit_serialize(Unit *u, FILE *f, FDSet *fds, bool serialize_jobs);
549 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_attr_(4,5);
550 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
551 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
552
553 int unit_add_node_link(Unit *u, const char *what, bool wants);
554
555 int unit_coldplug(Unit *u);
556
557 void unit_status_printf(Unit *u, const char *status, const char *unit_status_msg_format) _printf_attr_(3, 0);
558
559 bool unit_need_daemon_reload(Unit *u);
560
561 void unit_reset_failed(Unit *u);
562
563 Unit *unit_following(Unit *u);
564
565 const char *unit_slice_name(Unit *u);
566
567 bool unit_stop_pending(Unit *u) _pure_;
568 bool unit_inactive_or_pending(Unit *u) _pure_;
569 bool unit_active_or_pending(Unit *u);
570
571 int unit_add_default_target_dependency(Unit *u, Unit *target);
572
573 char *unit_default_cgroup_path(Unit *u);
574
575 int unit_following_set(Unit *u, Set **s);
576
577 void unit_start_on_failure(Unit *u);
578 void unit_trigger_notify(Unit *u);
579
580 bool unit_condition_test(Unit *u);
581
582 UnitFileState unit_get_unit_file_state(Unit *u);
583
584 Unit* unit_ref_set(UnitRef *ref, Unit *u);
585 void unit_ref_unset(UnitRef *ref);
586
587 #define UNIT_DEREF(ref) ((ref).unit)
588 #define UNIT_ISSET(ref) (!!(ref).unit)
589
590 int unit_add_one_mount_link(Unit *u, Mount *m);
591 int unit_add_mount_links(Unit *u);
592
593 int unit_exec_context_defaults(Unit *u, ExecContext *c);
594
595 ExecContext *unit_get_exec_context(Unit *u) _pure_;
596 CGroupContext *unit_get_cgroup_context(Unit *u) _pure_;
597
598 int unit_write_drop_in(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *data);
599 int unit_write_drop_in_private_section(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *data);
600 int unit_remove_drop_in(Unit *u, UnitSetPropertiesMode mode, const char *name);
601
602 int unit_kill_context(Unit *u, KillContext *c, bool sigkill, pid_t main_pid, pid_t control_pid, bool main_pid_alien);
603
604 int unit_make_transient(Unit *u);
605
606 const char *unit_active_state_to_string(UnitActiveState i) _const_;
607 UnitActiveState unit_active_state_from_string(const char *s) _pure_;
608
609 const char *unit_dependency_to_string(UnitDependency i) _const_;
610 UnitDependency unit_dependency_from_string(const char *s) _pure_;
611
612 /* Macros which append UNIT= or USER_UNIT= to the message */
613
614 #define log_full_unit(level, unit, ...) log_meta_object(level, __FILE__, __LINE__, __func__, getpid() == 1 ? "UNIT=" : "USER_UNIT=", unit, __VA_ARGS__)
615 #define log_debug_unit(unit, ...)       log_full_unit(LOG_DEBUG, unit, __VA_ARGS__)
616 #define log_info_unit(unit, ...)        log_full_unit(LOG_INFO, unit, __VA_ARGS__)
617 #define log_notice_unit(unit, ...)      log_full_unit(LOG_NOTICE, unit, __VA_ARGS__)
618 #define log_warning_unit(unit, ...)     log_full_unit(LOG_WARNING, unit, __VA_ARGS__)
619 #define log_error_unit(unit, ...)       log_full_unit(LOG_ERR, unit, __VA_ARGS__)
620
621 #define log_struct_unit(level, unit, ...) log_struct(level, getpid() == 1 ? "UNIT=%s" : "USER_UNIT=%s", unit, __VA_ARGS__)