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