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