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