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