chiark / gitweb /
switch from udev keymaps to hwdb
[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 #include "scope.h"
284
285 struct UnitVTable {
286         /* How much memory does an object of this unit type need */
287         size_t object_size;
288
289         /* If greater than 0, the offset into the object where
290          * ExecContext is found, if the unit type has that */
291         size_t exec_context_offset;
292
293         /* If greater than 0, the offset into the object where
294          * CGroupContext is found, if the unit type has that */
295         size_t cgroup_context_offset;
296
297         /* The name of the configuration file section with the private settings of this unit*/
298         const char *private_section;
299
300         /* Config file sections this unit type understands, separated
301          * by NUL chars */
302         const char *sections;
303
304         /* This should reset all type-specific variables. This should
305          * not allocate memory, and is called with zero-initialized
306          * data. It should hence only initialize variables that need
307          * to be set != 0. */
308         void (*init)(Unit *u);
309
310         /* This should free all type-specific variables. It should be
311          * idempotent. */
312         void (*done)(Unit *u);
313
314         /* Actually load data from disk. This may fail, and should set
315          * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
316          * UNIT_STUB if no configuration could be found. */
317         int (*load)(Unit *u);
318
319         /* If a lot of units got created via enumerate(), this is
320          * where to actually set the state and call unit_notify(). */
321         int (*coldplug)(Unit *u);
322
323         void (*dump)(Unit *u, FILE *f, const char *prefix);
324
325         int (*start)(Unit *u);
326         int (*stop)(Unit *u);
327         int (*reload)(Unit *u);
328
329         int (*kill)(Unit *u, KillWho w, int signo, DBusError *error);
330
331         bool (*can_reload)(Unit *u);
332
333         /* Write all data that cannot be restored from other sources
334          * away using unit_serialize_item() */
335         int (*serialize)(Unit *u, FILE *f, FDSet *fds);
336
337         /* Restore one item from the serialization */
338         int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
339
340         /* Try to match up fds with what we need for this unit */
341         int (*distribute_fds)(Unit *u, FDSet *fds);
342
343         /* Boils down the more complex internal state of this unit to
344          * a simpler one that the engine can understand */
345         UnitActiveState (*active_state)(Unit *u);
346
347         /* Returns the substate specific to this unit type as
348          * string. This is purely information so that we can give the
349          * user a more fine grained explanation in which actual state a
350          * unit is in. */
351         const char* (*sub_state_to_string)(Unit *u);
352
353         /* Return true when there is reason to keep this entry around
354          * even nothing references it and it isn't active in any
355          * way */
356         bool (*check_gc)(Unit *u);
357
358         /* Return true when this unit is suitable for snapshotting */
359         bool (*check_snapshot)(Unit *u);
360
361         void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
362         void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
363         void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
364
365         /* Reset failed state if we are in failed state */
366         void (*reset_failed)(Unit *u);
367
368         /* Called whenever any of the cgroups this unit watches for
369          * ran empty */
370         void (*notify_cgroup_empty)(Unit *u);
371
372         /* Called whenever a process of this unit sends us a message */
373         void (*notify_message)(Unit *u, pid_t pid, char **tags);
374
375         /* Called whenever a name this Unit registered for comes or
376          * goes away. */
377         void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
378
379         /* Called whenever a bus PID lookup finishes */
380         void (*bus_query_pid_done)(Unit *u, const char *name, pid_t pid);
381
382         /* Called for each message received on the bus */
383         DBusHandlerResult (*bus_message_handler)(Unit *u, DBusConnection *c, DBusMessage *message);
384
385         /* Called for each property that is being set */
386         int (*bus_set_property)(Unit *u, const char *name, DBusMessageIter *i, UnitSetPropertiesMode mode, DBusError *error);
387
388         /* Called after at least one property got changed to apply the necessary change */
389         int (*bus_commit_properties)(Unit *u);
390
391         /* Return the unit this unit is following */
392         Unit *(*following)(Unit *u);
393
394         /* Return the set of units that are following each other */
395         int (*following_set)(Unit *u, Set **s);
396
397         /* Invoked each time a unit this unit is triggering changes
398          * state or gains/loses a job */
399         void (*trigger_notify)(Unit *u, Unit *trigger);
400
401         /* Called whenever CLOCK_REALTIME made a jump */
402         void (*time_change)(Unit *u);
403
404         /* This is called for each unit type and should be used to
405          * enumerate existing devices and load them. However,
406          * everything that is loaded here should still stay in
407          * inactive state. It is the job of the coldplug() call above
408          * to put the units into the initial state.  */
409         int (*enumerate)(Manager *m);
410
411         /* Type specific cleanups. */
412         void (*shutdown)(Manager *m);
413
414         /* When sending out PropertiesChanged signal, which properties
415          * shall be invalidated? This is a NUL separated list of
416          * strings, to minimize relocations a little. */
417         const char *bus_invalidating_properties;
418
419         /* The interface name */
420         const char *bus_interface;
421
422         UnitStatusMessageFormats status_message_formats;
423
424         /* Can units of this type have multiple names? */
425         bool no_alias:1;
426
427         /* Instances make no sense for this type */
428         bool no_instances:1;
429
430         /* Exclude from automatic gc */
431         bool no_gc:1;
432
433         /* True if transient units of this type are OK */
434         bool can_transient:1;
435 };
436
437 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
438
439 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
440
441 /* For casting a unit into the various unit types */
442 #define DEFINE_CAST(UPPERCASE, MixedCase)                               \
443         static inline MixedCase* UPPERCASE(Unit *u) {                   \
444                 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE))      \
445                         return NULL;                                    \
446                                                                         \
447                 return (MixedCase*) u;                                  \
448         }
449
450 /* For casting the various unit types into a unit */
451 #define UNIT(u) (&(u)->meta)
452
453 #define UNIT_TRIGGER(u) ((Unit*) set_first((u)->dependencies[UNIT_TRIGGERS]))
454
455 DEFINE_CAST(SOCKET, Socket);
456 DEFINE_CAST(TIMER, Timer);
457 DEFINE_CAST(SERVICE, Service);
458 DEFINE_CAST(TARGET, Target);
459 DEFINE_CAST(DEVICE, Device);
460 DEFINE_CAST(MOUNT, Mount);
461 DEFINE_CAST(AUTOMOUNT, Automount);
462 DEFINE_CAST(SNAPSHOT, Snapshot);
463 DEFINE_CAST(SWAP, Swap);
464 DEFINE_CAST(PATH, Path);
465 DEFINE_CAST(SLICE, Slice);
466 DEFINE_CAST(SCOPE, Scope);
467
468 Unit *unit_new(Manager *m, size_t size);
469 void unit_free(Unit *u);
470
471 int unit_add_name(Unit *u, const char *name);
472
473 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
474 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
475
476 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
477 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
478
479 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
480 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
481
482 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
483
484 int unit_choose_id(Unit *u, const char *name);
485 int unit_set_description(Unit *u, const char *description);
486
487 bool unit_check_gc(Unit *u);
488
489 void unit_add_to_load_queue(Unit *u);
490 void unit_add_to_dbus_queue(Unit *u);
491 void unit_add_to_cleanup_queue(Unit *u);
492 void unit_add_to_gc_queue(Unit *u);
493
494 int unit_merge(Unit *u, Unit *other);
495 int unit_merge_by_name(Unit *u, const char *other);
496
497 Unit *unit_follow_merge(Unit *u) _pure_;
498
499 int unit_load_fragment_and_dropin(Unit *u);
500 int unit_load_fragment_and_dropin_optional(Unit *u);
501 int unit_load(Unit *unit);
502
503 int unit_add_default_slice(Unit *u);
504
505 const char *unit_description(Unit *u) _pure_;
506
507 bool unit_has_name(Unit *u, const char *name);
508
509 UnitActiveState unit_active_state(Unit *u);
510
511 const char* unit_sub_state_to_string(Unit *u);
512
513 void unit_dump(Unit *u, FILE *f, const char *prefix);
514
515 bool unit_can_reload(Unit *u) _pure_;
516 bool unit_can_start(Unit *u) _pure_;
517 bool unit_can_isolate(Unit *u) _pure_;
518
519 int unit_start(Unit *u);
520 int unit_stop(Unit *u);
521 int unit_reload(Unit *u);
522
523 int unit_kill(Unit *u, KillWho w, int signo, DBusError *error);
524 int unit_kill_common(Unit *u, KillWho who, int signo, pid_t main_pid, pid_t control_pid, DBusError *error);
525
526 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
527
528 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
529 void unit_unwatch_fd(Unit *u, Watch *w);
530
531 int unit_watch_pid(Unit *u, pid_t pid);
532 void unit_unwatch_pid(Unit *u, pid_t pid);
533
534 int unit_watch_timer(Unit *u, clockid_t, bool relative, usec_t usec, Watch *w);
535 void unit_unwatch_timer(Unit *u, Watch *w);
536
537 int unit_watch_bus_name(Unit *u, const char *name);
538 void unit_unwatch_bus_name(Unit *u, const char *name);
539
540 bool unit_job_is_applicable(Unit *u, JobType j);
541
542 int set_unit_path(const char *p);
543
544 char *unit_dbus_path(Unit *u);
545
546 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
547 int unit_get_related_unit(Unit *u, const char *type, Unit **_found);
548
549 bool unit_can_serialize(Unit *u) _pure_;
550 int unit_serialize(Unit *u, FILE *f, FDSet *fds, bool serialize_jobs);
551 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_attr_(4,5);
552 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
553 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
554
555 int unit_add_node_link(Unit *u, const char *what, bool wants);
556
557 int unit_coldplug(Unit *u);
558
559 void unit_status_printf(Unit *u, const char *status, const char *unit_status_msg_format) _printf_attr_(3, 0);
560
561 bool unit_need_daemon_reload(Unit *u);
562
563 void unit_reset_failed(Unit *u);
564
565 Unit *unit_following(Unit *u);
566
567 const char *unit_slice_name(Unit *u);
568
569 bool unit_stop_pending(Unit *u) _pure_;
570 bool unit_inactive_or_pending(Unit *u) _pure_;
571 bool unit_active_or_pending(Unit *u);
572
573 int unit_add_default_target_dependency(Unit *u, Unit *target);
574
575 char *unit_default_cgroup_path(Unit *u);
576
577 int unit_following_set(Unit *u, Set **s);
578
579 void unit_start_on_failure(Unit *u);
580 void unit_trigger_notify(Unit *u);
581
582 bool unit_condition_test(Unit *u);
583
584 UnitFileState unit_get_unit_file_state(Unit *u);
585
586 Unit* unit_ref_set(UnitRef *ref, Unit *u);
587 void unit_ref_unset(UnitRef *ref);
588
589 #define UNIT_DEREF(ref) ((ref).unit)
590 #define UNIT_ISSET(ref) (!!(ref).unit)
591
592 int unit_add_one_mount_link(Unit *u, Mount *m);
593 int unit_add_mount_links(Unit *u);
594
595 int unit_exec_context_defaults(Unit *u, ExecContext *c);
596
597 ExecContext *unit_get_exec_context(Unit *u) _pure_;
598 CGroupContext *unit_get_cgroup_context(Unit *u) _pure_;
599
600 int unit_write_drop_in(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *data);
601 int unit_write_drop_in_format(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *format, ...) _printf_attr_(4,5);
602
603 int unit_write_drop_in_private(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *data);
604 int unit_write_drop_in_private_format(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *format, ...) _printf_attr_(4,5);
605
606 int unit_remove_drop_in(Unit *u, UnitSetPropertiesMode mode, const char *name);
607
608 int unit_kill_context(Unit *u, KillContext *c, bool sigkill, pid_t main_pid, pid_t control_pid, bool main_pid_alien);
609
610 int unit_make_transient(Unit *u);
611
612 const char *unit_active_state_to_string(UnitActiveState i) _const_;
613 UnitActiveState unit_active_state_from_string(const char *s) _pure_;
614
615 const char *unit_dependency_to_string(UnitDependency i) _const_;
616 UnitDependency unit_dependency_from_string(const char *s) _pure_;
617
618 /* Macros which append UNIT= or USER_UNIT= to the message */
619
620 #define log_full_unit(level, unit, ...) log_meta_object(level, __FILE__, __LINE__, __func__, getpid() == 1 ? "UNIT=" : "USER_UNIT=", unit, __VA_ARGS__)
621 #define log_debug_unit(unit, ...)       log_full_unit(LOG_DEBUG, unit, __VA_ARGS__)
622 #define log_info_unit(unit, ...)        log_full_unit(LOG_INFO, unit, __VA_ARGS__)
623 #define log_notice_unit(unit, ...)      log_full_unit(LOG_NOTICE, unit, __VA_ARGS__)
624 #define log_warning_unit(unit, ...)     log_full_unit(LOG_WARNING, unit, __VA_ARGS__)
625 #define log_error_unit(unit, ...)       log_full_unit(LOG_ERR, unit, __VA_ARGS__)
626
627 #define log_struct_unit(level, unit, ...) log_struct(level, getpid() == 1 ? "UNIT=%s" : "USER_UNIT=%s", unit, __VA_ARGS__)