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