chiark / gitweb /
Do not advertise .d snippets over main config file
[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         /* Where the cpuacct.usage cgroup counter was at the time the unit was started */
180         nsec_t cpuacct_usage_base;
181
182         /* Counterparts in the cgroup filesystem */
183         char *cgroup_path;
184         CGroupControllerMask cgroup_realized_mask;
185         CGroupControllerMask cgroup_subtree_mask;
186         CGroupControllerMask cgroup_members_mask;
187
188         /* How to start OnFailure units */
189         JobMode on_failure_job_mode;
190
191         /* Garbage collect us we nobody wants or requires us anymore */
192         bool stop_when_unneeded;
193
194         /* Create default dependencies */
195         bool default_dependencies;
196
197         /* Refuse manual starting, allow starting only indirectly via dependency. */
198         bool refuse_manual_start;
199
200         /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
201         bool refuse_manual_stop;
202
203         /* Allow isolation requests */
204         bool allow_isolate;
205
206         /* Ignore this unit when isolating */
207         bool ignore_on_isolate;
208
209         /* Ignore this unit when snapshotting */
210         bool ignore_on_snapshot;
211
212         /* Did the last condition check succeed? */
213         bool condition_result;
214         bool assert_result;
215
216         /* Is this a transient unit? */
217         bool transient;
218
219         bool in_load_queue:1;
220         bool in_dbus_queue:1;
221         bool in_cleanup_queue:1;
222         bool in_gc_queue:1;
223         bool in_cgroup_queue:1;
224
225         bool sent_dbus_new_signal:1;
226
227         bool no_gc:1;
228
229         bool in_audit:1;
230
231         bool cgroup_realized:1;
232         bool cgroup_members_mask_valid:1;
233         bool cgroup_subtree_mask_valid:1;
234 };
235
236 struct UnitStatusMessageFormats {
237         const char *starting_stopping[2];
238         const char *finished_start_job[_JOB_RESULT_MAX];
239         const char *finished_stop_job[_JOB_RESULT_MAX];
240 };
241
242 typedef enum UnitSetPropertiesMode {
243         UNIT_CHECK = 0,
244         UNIT_RUNTIME = 1,
245         UNIT_PERSISTENT = 2,
246 } UnitSetPropertiesMode;
247
248 #include "socket.h"
249 #include "busname.h"
250 #include "target.h"
251 #include "snapshot.h"
252 #include "device.h"
253 #include "automount.h"
254 #include "swap.h"
255 #include "timer.h"
256 #include "slice.h"
257 #include "path.h"
258 #include "scope.h"
259
260 struct UnitVTable {
261         /* How much memory does an object of this unit type need */
262         size_t object_size;
263
264         /* If greater than 0, the offset into the object where
265          * ExecContext is found, if the unit type has that */
266         size_t exec_context_offset;
267
268         /* If greater than 0, the offset into the object where
269          * CGroupContext is found, if the unit type has that */
270         size_t cgroup_context_offset;
271
272         /* If greater than 0, the offset into the object where
273          * KillContext is found, if the unit type has that */
274         size_t kill_context_offset;
275
276         /* If greater than 0, the offset into the object where the
277          * pointer to ExecRuntime is found, if the unit type has
278          * that */
279         size_t exec_runtime_offset;
280
281         /* The name of the configuration file section with the private settings of this unit */
282         const char *private_section;
283
284         /* Config file sections this unit type understands, separated
285          * by NUL chars */
286         const char *sections;
287
288         /* This should reset all type-specific variables. This should
289          * not allocate memory, and is called with zero-initialized
290          * data. It should hence only initialize variables that need
291          * to be set != 0. */
292         void (*init)(Unit *u);
293
294         /* This should free all type-specific variables. It should be
295          * idempotent. */
296         void (*done)(Unit *u);
297
298         /* Actually load data from disk. This may fail, and should set
299          * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
300          * UNIT_STUB if no configuration could be found. */
301         int (*load)(Unit *u);
302
303         /* If a lot of units got created via enumerate(), this is
304          * where to actually set the state and call unit_notify(). */
305         int (*coldplug)(Unit *u);
306
307         void (*dump)(Unit *u, FILE *f, const char *prefix);
308
309         int (*start)(Unit *u);
310         int (*stop)(Unit *u);
311         int (*reload)(Unit *u);
312
313         int (*kill)(Unit *u, KillWho w, int signo, sd_bus_error *error);
314
315         bool (*can_reload)(Unit *u);
316
317         /* Write all data that cannot be restored from other sources
318          * away using unit_serialize_item() */
319         int (*serialize)(Unit *u, FILE *f, FDSet *fds);
320
321         /* Restore one item from the serialization */
322         int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
323
324         /* Try to match up fds with what we need for this unit */
325         int (*distribute_fds)(Unit *u, FDSet *fds);
326
327         /* Boils down the more complex internal state of this unit to
328          * a simpler one that the engine can understand */
329         UnitActiveState (*active_state)(Unit *u);
330
331         /* Returns the substate specific to this unit type as
332          * string. This is purely information so that we can give the
333          * user a more fine grained explanation in which actual state a
334          * unit is in. */
335         const char* (*sub_state_to_string)(Unit *u);
336
337         /* Return true when there is reason to keep this entry around
338          * even nothing references it and it isn't active in any
339          * way */
340         bool (*check_gc)(Unit *u);
341
342         /* When the unit is not running and no job for it queued we
343          * shall release its runtime resources */
344         void (*release_resources)(Unit *u);
345
346         /* Return true when this unit is suitable for snapshotting */
347         bool (*check_snapshot)(Unit *u);
348
349         /* Invoked on every child that died */
350         void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
351
352         /* Reset failed state if we are in failed state */
353         void (*reset_failed)(Unit *u);
354
355         /* Called whenever any of the cgroups this unit watches for
356          * ran empty */
357         void (*notify_cgroup_empty)(Unit *u);
358
359         /* Called whenever a process of this unit sends us a message */
360         void (*notify_message)(Unit *u, pid_t pid, char **tags, FDSet *fds);
361
362         /* Called whenever a name this Unit registered for comes or
363          * goes away. */
364         void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
365
366         /* Called for each property that is being set */
367         int (*bus_set_property)(Unit *u, const char *name, sd_bus_message *message, UnitSetPropertiesMode mode, sd_bus_error *error);
368
369         /* Called after at least one property got changed to apply the necessary change */
370         int (*bus_commit_properties)(Unit *u);
371
372         /* Return the unit this unit is following */
373         Unit *(*following)(Unit *u);
374
375         /* Return the set of units that are following each other */
376         int (*following_set)(Unit *u, Set **s);
377
378         /* Invoked each time a unit this unit is triggering changes
379          * state or gains/loses a job */
380         void (*trigger_notify)(Unit *u, Unit *trigger);
381
382         /* Called whenever CLOCK_REALTIME made a jump */
383         void (*time_change)(Unit *u);
384
385         int (*get_timeout)(Unit *u, uint64_t *timeout);
386
387         /* This is called for each unit type and should be used to
388          * enumerate existing devices and load them. However,
389          * everything that is loaded here should still stay in
390          * inactive state. It is the job of the coldplug() call above
391          * to put the units into the initial state.  */
392         int (*enumerate)(Manager *m);
393
394         /* Type specific cleanups. */
395         void (*shutdown)(Manager *m);
396
397         /* If this function is set and return false all jobs for units
398          * of this type will immediately fail. */
399         bool (*supported)(Manager *m);
400
401         /* The interface name */
402         const char *bus_interface;
403
404         /* The bus vtable */
405         const sd_bus_vtable *bus_vtable;
406
407         /* The strings to print in status messages */
408         UnitStatusMessageFormats status_message_formats;
409
410         /* Can units of this type have multiple names? */
411         bool no_alias:1;
412
413         /* Instances make no sense for this type */
414         bool no_instances:1;
415
416         /* Exclude from automatic gc */
417         bool no_gc:1;
418
419         /* True if transient units of this type are OK */
420         bool can_transient:1;
421 };
422
423 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
424
425 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
426
427 /* For casting a unit into the various unit types */
428 #define DEFINE_CAST(UPPERCASE, MixedCase)                               \
429         static inline MixedCase* UPPERCASE(Unit *u) {                   \
430                 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE))      \
431                         return NULL;                                    \
432                                                                         \
433                 return (MixedCase*) u;                                  \
434         }
435
436 /* For casting the various unit types into a unit */
437 #define UNIT(u) (&(u)->meta)
438
439 #define UNIT_TRIGGER(u) ((Unit*) set_first((u)->dependencies[UNIT_TRIGGERS]))
440
441 DEFINE_CAST(SERVICE, Service);
442 DEFINE_CAST(SOCKET, Socket);
443 DEFINE_CAST(BUSNAME, BusName);
444 DEFINE_CAST(TARGET, Target);
445 DEFINE_CAST(SNAPSHOT, Snapshot);
446 DEFINE_CAST(DEVICE, Device);
447 DEFINE_CAST(MOUNT, Mount);
448 DEFINE_CAST(AUTOMOUNT, Automount);
449 DEFINE_CAST(SWAP, Swap);
450 DEFINE_CAST(TIMER, Timer);
451 DEFINE_CAST(PATH, Path);
452 DEFINE_CAST(SLICE, Slice);
453 DEFINE_CAST(SCOPE, Scope);
454
455 Unit *unit_new(Manager *m, size_t size);
456 void unit_free(Unit *u);
457
458 int unit_add_name(Unit *u, const char *name);
459
460 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
461 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
462
463 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
464 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
465
466 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
467 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
468
469 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
470
471 int unit_choose_id(Unit *u, const char *name);
472 int unit_set_description(Unit *u, const char *description);
473
474 bool unit_check_gc(Unit *u);
475
476 void unit_add_to_load_queue(Unit *u);
477 void unit_add_to_dbus_queue(Unit *u);
478 void unit_add_to_cleanup_queue(Unit *u);
479 void unit_add_to_gc_queue(Unit *u);
480
481 int unit_merge(Unit *u, Unit *other);
482 int unit_merge_by_name(Unit *u, const char *other);
483
484 Unit *unit_follow_merge(Unit *u) _pure_;
485
486 int unit_load_fragment_and_dropin(Unit *u);
487 int unit_load_fragment_and_dropin_optional(Unit *u);
488 int unit_load(Unit *unit);
489
490 int unit_add_default_slice(Unit *u, CGroupContext *c);
491
492 const char *unit_description(Unit *u) _pure_;
493
494 bool unit_has_name(Unit *u, const char *name);
495
496 UnitActiveState unit_active_state(Unit *u);
497
498 const char* unit_sub_state_to_string(Unit *u);
499
500 void unit_dump(Unit *u, FILE *f, const char *prefix);
501
502 bool unit_can_reload(Unit *u) _pure_;
503 bool unit_can_start(Unit *u) _pure_;
504 bool unit_can_isolate(Unit *u) _pure_;
505
506 int unit_start(Unit *u);
507 int unit_stop(Unit *u);
508 int unit_reload(Unit *u);
509
510 int unit_kill(Unit *u, KillWho w, int signo, sd_bus_error *error);
511 int unit_kill_common(Unit *u, KillWho who, int signo, pid_t main_pid, pid_t control_pid, sd_bus_error *error);
512
513 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
514
515 int unit_watch_pid(Unit *u, pid_t pid);
516 void unit_unwatch_pid(Unit *u, pid_t pid);
517 int unit_watch_all_pids(Unit *u);
518 void unit_unwatch_all_pids(Unit *u);
519
520 void unit_tidy_watch_pids(Unit *u, pid_t except1, pid_t except2);
521
522 int unit_watch_bus_name(Unit *u, const char *name);
523 void unit_unwatch_bus_name(Unit *u, const char *name);
524
525 bool unit_job_is_applicable(Unit *u, JobType j);
526
527 int set_unit_path(const char *p);
528
529 char *unit_dbus_path(Unit *u);
530
531 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
532
533 bool unit_can_serialize(Unit *u) _pure_;
534 int unit_serialize(Unit *u, FILE *f, FDSet *fds, bool serialize_jobs);
535 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_(4,5);
536 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
537 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
538
539 int unit_add_node_link(Unit *u, const char *what, bool wants);
540
541 int unit_coldplug(Unit *u);
542
543 void unit_status_printf(Unit *u, const char *status, const char *unit_status_msg_format) _printf_(3, 0);
544
545 bool unit_need_daemon_reload(Unit *u);
546
547 void unit_reset_failed(Unit *u);
548
549 Unit *unit_following(Unit *u);
550 int unit_following_set(Unit *u, Set **s);
551
552 const char *unit_slice_name(Unit *u);
553
554 bool unit_stop_pending(Unit *u) _pure_;
555 bool unit_inactive_or_pending(Unit *u) _pure_;
556 bool unit_active_or_pending(Unit *u);
557
558 int unit_add_default_target_dependency(Unit *u, Unit *target);
559
560 char *unit_default_cgroup_path(Unit *u);
561
562 void unit_start_on_failure(Unit *u);
563 void unit_trigger_notify(Unit *u);
564
565 UnitFileState unit_get_unit_file_state(Unit *u);
566 int unit_get_unit_file_preset(Unit *u);
567
568 Unit* unit_ref_set(UnitRef *ref, Unit *u);
569 void unit_ref_unset(UnitRef *ref);
570
571 #define UNIT_DEREF(ref) ((ref).unit)
572 #define UNIT_ISSET(ref) (!!(ref).unit)
573
574 int unit_patch_contexts(Unit *u);
575
576 ExecContext *unit_get_exec_context(Unit *u) _pure_;
577 KillContext *unit_get_kill_context(Unit *u) _pure_;
578 CGroupContext *unit_get_cgroup_context(Unit *u) _pure_;
579
580 ExecRuntime *unit_get_exec_runtime(Unit *u) _pure_;
581
582 int unit_setup_exec_runtime(Unit *u);
583
584 int unit_write_drop_in(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *data);
585 int unit_write_drop_in_format(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *format, ...) _printf_(4,5);
586
587 int unit_write_drop_in_private(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *data);
588 int unit_write_drop_in_private_format(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *format, ...) _printf_(4,5);
589
590 int unit_remove_drop_in(Unit *u, UnitSetPropertiesMode mode, const char *name);
591
592 int unit_kill_context(Unit *u, KillContext *c, KillOperation k, pid_t main_pid, pid_t control_pid, bool main_pid_alien);
593
594 int unit_make_transient(Unit *u);
595
596 int unit_require_mounts_for(Unit *u, const char *path);
597
598 const char *unit_active_state_to_string(UnitActiveState i) _const_;
599 UnitActiveState unit_active_state_from_string(const char *s) _pure_;
600
601 /* Macros which append UNIT= or USER_UNIT= to the message */
602
603 #define log_unit_full_errno(unit, level, error, ...) log_object_internal(level, error, __FILE__, __LINE__, __func__, getpid() == 1 ? "UNIT=" : "USER_UNIT=", unit, __VA_ARGS__)
604 #define log_unit_full(unit, level, ...) log_unit_full_errno(unit, level, 0, __VA_ARGS__)
605
606 #define log_unit_debug(unit, ...)       log_unit_full(unit, LOG_DEBUG, __VA_ARGS__)
607 #define log_unit_info(unit, ...)        log_unit_full(unit, LOG_INFO, __VA_ARGS__)
608 #define log_unit_notice(unit, ...)      log_unit_full(unit, LOG_NOTICE, __VA_ARGS__)
609 #define log_unit_warning(unit, ...)     log_unit_full(unit, LOG_WARNING, __VA_ARGS__)
610 #define log_unit_error(unit, ...)       log_unit_full(unit, LOG_ERR, __VA_ARGS__)
611
612 #define log_unit_debug_errno(unit, error, ...)       log_unit_full_errno(unit, LOG_DEBUG, error, __VA_ARGS__)
613 #define log_unit_info_errno(unit, error, ...)        log_unit_full_errno(unit, LOG_INFO, error, __VA_ARGS__)
614 #define log_unit_notice_errno(unit, error, ...)      log_unit_full_errno(unit, LOG_NOTICE, error, __VA_ARGS__)
615 #define log_unit_warning_errno(unit, error, ...)     log_unit_full_errno(unit, LOG_WARNING, error, __VA_ARGS__)
616 #define log_unit_error_errno(unit, error, ...)       log_unit_full_errno(unit, LOG_ERR, error, __VA_ARGS__)
617
618 #define log_unit_struct(unit, level, ...) log_struct(level, getpid() == 1 ? "UNIT=%s" : "USER_UNIT=%s", unit, __VA_ARGS__)
619 #define log_unit_struct_errno(unit, level, error, ...) log_struct_errno(level, error, getpid() == 1 ? "UNIT=%s" : "USER_UNIT=%s", unit, __VA_ARGS__)