1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
6 This file is part of systemd.
8 Copyright 2010 Lennart Poettering
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.
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.
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/>.
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;
35 #include "condition.h"
37 #include "unit-name.h"
38 #include "failure-action.h"
40 enum UnitActiveState {
47 _UNIT_ACTIVE_STATE_MAX,
48 _UNIT_ACTIVE_STATE_INVALID = -1
51 typedef enum KillOperation {
57 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) {
58 return t == UNIT_ACTIVE || t == UNIT_RELOADING;
61 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) {
62 return t == UNIT_ACTIVE || t == UNIT_ACTIVATING || t == UNIT_RELOADING;
65 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) {
66 return t == UNIT_INACTIVE || t == UNIT_FAILED || t == UNIT_DEACTIVATING;
69 static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t) {
70 return t == UNIT_INACTIVE || t == UNIT_FAILED;
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 */
81 LIST_FIELDS(UnitRef, refs);
88 UnitLoadState load_state;
91 char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
95 Set *dependencies[_UNIT_DEPENDENCY_MAX];
97 char **requires_mounts_for;
100 char **documentation;
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 */
105 usec_t fragment_mtime;
109 /* If there is something to do with this unit, then this is the installed job for it */
112 /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
115 /* Job timeout and action to take */
117 FailureAction job_timeout_action;
118 char *job_timeout_reboot_arg;
120 /* References to this */
121 LIST_HEAD(UnitRef, refs);
123 /* Conditions to check */
124 LIST_HEAD(Condition, conditions);
125 LIST_HEAD(Condition, asserts);
127 dual_timestamp condition_timestamp;
128 dual_timestamp assert_timestamp;
130 dual_timestamp inactive_exit_timestamp;
131 dual_timestamp active_enter_timestamp;
132 dual_timestamp active_exit_timestamp;
133 dual_timestamp inactive_enter_timestamp;
138 LIST_FIELDS(Unit, units_by_type);
140 /* All units which have requires_mounts_for set */
141 LIST_FIELDS(Unit, has_requires_mounts_for);
144 LIST_FIELDS(Unit, load_queue);
147 LIST_FIELDS(Unit, dbus_queue);
150 LIST_FIELDS(Unit, cleanup_queue);
153 LIST_FIELDS(Unit, gc_queue);
155 /* CGroup realize members queue */
156 LIST_FIELDS(Unit, cgroup_queue);
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 */
163 /* Used during GC sweeps */
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 */
172 /* Error code when we didn't manage to load the unit (negative) */
175 /* Cached unit file state and preset */
176 UnitFileState unit_file_state;
177 int unit_file_preset;
179 /* Counterparts in the cgroup filesystem */
181 CGroupControllerMask cgroup_realized_mask;
182 CGroupControllerMask cgroup_subtree_mask;
183 CGroupControllerMask cgroup_members_mask;
185 /* How to start OnFailure units */
186 JobMode on_failure_job_mode;
188 /* Garbage collect us we nobody wants or requires us anymore */
189 bool stop_when_unneeded;
191 /* Create default dependencies */
192 bool default_dependencies;
194 /* Refuse manual starting, allow starting only indirectly via dependency. */
195 bool refuse_manual_start;
197 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
198 bool refuse_manual_stop;
200 /* Allow isolation requests */
203 /* Ignore this unit when isolating */
204 bool ignore_on_isolate;
206 /* Ignore this unit when snapshotting */
207 bool ignore_on_snapshot;
209 /* Did the last condition check succeed? */
210 bool condition_result;
213 /* Is this a transient unit? */
216 bool in_load_queue:1;
217 bool in_dbus_queue:1;
218 bool in_cleanup_queue:1;
220 bool in_cgroup_queue:1;
222 bool sent_dbus_new_signal:1;
228 bool cgroup_realized:1;
229 bool cgroup_members_mask_valid:1;
230 bool cgroup_subtree_mask_valid:1;
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];
239 typedef enum UnitSetPropertiesMode {
243 } UnitSetPropertiesMode;
248 #include "snapshot.h"
250 #include "automount.h"
258 /* How much memory does an object of this unit type need */
261 /* If greater than 0, the offset into the object where
262 * ExecContext is found, if the unit type has that */
263 size_t exec_context_offset;
265 /* If greater than 0, the offset into the object where
266 * CGroupContext is found, if the unit type has that */
267 size_t cgroup_context_offset;
269 /* If greater than 0, the offset into the object where
270 * KillContext is found, if the unit type has that */
271 size_t kill_context_offset;
273 /* If greater than 0, the offset into the object where the
274 * pointer to ExecRuntime is found, if the unit type has
276 size_t exec_runtime_offset;
278 /* The name of the configuration file section with the private settings of this unit */
279 const char *private_section;
281 /* Config file sections this unit type understands, separated
283 const char *sections;
285 /* This should reset all type-specific variables. This should
286 * not allocate memory, and is called with zero-initialized
287 * data. It should hence only initialize variables that need
289 void (*init)(Unit *u);
291 /* This should free all type-specific variables. It should be
293 void (*done)(Unit *u);
295 /* Actually load data from disk. This may fail, and should set
296 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
297 * UNIT_STUB if no configuration could be found. */
298 int (*load)(Unit *u);
300 /* If a lot of units got created via enumerate(), this is
301 * where to actually set the state and call unit_notify(). */
302 int (*coldplug)(Unit *u);
304 void (*dump)(Unit *u, FILE *f, const char *prefix);
306 int (*start)(Unit *u);
307 int (*stop)(Unit *u);
308 int (*reload)(Unit *u);
310 int (*kill)(Unit *u, KillWho w, int signo, sd_bus_error *error);
312 bool (*can_reload)(Unit *u);
314 /* Write all data that cannot be restored from other sources
315 * away using unit_serialize_item() */
316 int (*serialize)(Unit *u, FILE *f, FDSet *fds);
318 /* Restore one item from the serialization */
319 int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
321 /* Try to match up fds with what we need for this unit */
322 int (*distribute_fds)(Unit *u, FDSet *fds);
324 /* Boils down the more complex internal state of this unit to
325 * a simpler one that the engine can understand */
326 UnitActiveState (*active_state)(Unit *u);
328 /* Returns the substate specific to this unit type as
329 * string. This is purely information so that we can give the
330 * user a more fine grained explanation in which actual state a
332 const char* (*sub_state_to_string)(Unit *u);
334 /* Return true when there is reason to keep this entry around
335 * even nothing references it and it isn't active in any
337 bool (*check_gc)(Unit *u);
339 /* When the unit is not running and no job for it queued we
340 * shall release its runtime resources */
341 void (*release_resources)(Unit *u);
343 /* Return true when this unit is suitable for snapshotting */
344 bool (*check_snapshot)(Unit *u);
346 /* Invoked on every child that died */
347 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
349 /* Reset failed state if we are in failed state */
350 void (*reset_failed)(Unit *u);
352 /* Called whenever any of the cgroups this unit watches for
354 void (*notify_cgroup_empty)(Unit *u);
356 /* Called whenever a process of this unit sends us a message */
357 void (*notify_message)(Unit *u, pid_t pid, char **tags, FDSet *fds);
359 /* Called whenever a name this Unit registered for comes or
361 void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
363 /* Called for each property that is being set */
364 int (*bus_set_property)(Unit *u, const char *name, sd_bus_message *message, UnitSetPropertiesMode mode, sd_bus_error *error);
366 /* Called after at least one property got changed to apply the necessary change */
367 int (*bus_commit_properties)(Unit *u);
369 /* Return the unit this unit is following */
370 Unit *(*following)(Unit *u);
372 /* Return the set of units that are following each other */
373 int (*following_set)(Unit *u, Set **s);
375 /* Invoked each time a unit this unit is triggering changes
376 * state or gains/loses a job */
377 void (*trigger_notify)(Unit *u, Unit *trigger);
379 /* Called whenever CLOCK_REALTIME made a jump */
380 void (*time_change)(Unit *u);
382 int (*get_timeout)(Unit *u, uint64_t *timeout);
384 /* This is called for each unit type and should be used to
385 * enumerate existing devices and load them. However,
386 * everything that is loaded here should still stay in
387 * inactive state. It is the job of the coldplug() call above
388 * to put the units into the initial state. */
389 int (*enumerate)(Manager *m);
391 /* Type specific cleanups. */
392 void (*shutdown)(Manager *m);
394 /* If this function is set and return false all jobs for units
395 * of this type will immediately fail. */
396 bool (*supported)(Manager *m);
398 /* The interface name */
399 const char *bus_interface;
402 const sd_bus_vtable *bus_vtable;
404 /* The strings to print in status messages */
405 UnitStatusMessageFormats status_message_formats;
407 /* Can units of this type have multiple names? */
410 /* Instances make no sense for this type */
413 /* Exclude from automatic gc */
416 /* True if transient units of this type are OK */
417 bool can_transient:1;
420 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
422 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
424 /* For casting a unit into the various unit types */
425 #define DEFINE_CAST(UPPERCASE, MixedCase) \
426 static inline MixedCase* UPPERCASE(Unit *u) { \
427 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
430 return (MixedCase*) u; \
433 /* For casting the various unit types into a unit */
434 #define UNIT(u) (&(u)->meta)
436 #define UNIT_TRIGGER(u) ((Unit*) set_first((u)->dependencies[UNIT_TRIGGERS]))
438 DEFINE_CAST(SERVICE, Service);
439 DEFINE_CAST(SOCKET, Socket);
440 DEFINE_CAST(BUSNAME, BusName);
441 DEFINE_CAST(TARGET, Target);
442 DEFINE_CAST(SNAPSHOT, Snapshot);
443 DEFINE_CAST(DEVICE, Device);
444 DEFINE_CAST(MOUNT, Mount);
445 DEFINE_CAST(AUTOMOUNT, Automount);
446 DEFINE_CAST(SWAP, Swap);
447 DEFINE_CAST(TIMER, Timer);
448 DEFINE_CAST(PATH, Path);
449 DEFINE_CAST(SLICE, Slice);
450 DEFINE_CAST(SCOPE, Scope);
452 Unit *unit_new(Manager *m, size_t size);
453 void unit_free(Unit *u);
455 int unit_add_name(Unit *u, const char *name);
457 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
458 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
460 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
461 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
463 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
464 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
466 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
468 int unit_choose_id(Unit *u, const char *name);
469 int unit_set_description(Unit *u, const char *description);
471 bool unit_check_gc(Unit *u);
473 void unit_add_to_load_queue(Unit *u);
474 void unit_add_to_dbus_queue(Unit *u);
475 void unit_add_to_cleanup_queue(Unit *u);
476 void unit_add_to_gc_queue(Unit *u);
478 int unit_merge(Unit *u, Unit *other);
479 int unit_merge_by_name(Unit *u, const char *other);
481 Unit *unit_follow_merge(Unit *u) _pure_;
483 int unit_load_fragment_and_dropin(Unit *u);
484 int unit_load_fragment_and_dropin_optional(Unit *u);
485 int unit_load(Unit *unit);
487 int unit_add_default_slice(Unit *u, CGroupContext *c);
489 const char *unit_description(Unit *u) _pure_;
491 bool unit_has_name(Unit *u, const char *name);
493 UnitActiveState unit_active_state(Unit *u);
495 const char* unit_sub_state_to_string(Unit *u);
497 void unit_dump(Unit *u, FILE *f, const char *prefix);
499 bool unit_can_reload(Unit *u) _pure_;
500 bool unit_can_start(Unit *u) _pure_;
501 bool unit_can_isolate(Unit *u) _pure_;
503 int unit_start(Unit *u);
504 int unit_stop(Unit *u);
505 int unit_reload(Unit *u);
507 int unit_kill(Unit *u, KillWho w, int signo, sd_bus_error *error);
508 int unit_kill_common(Unit *u, KillWho who, int signo, pid_t main_pid, pid_t control_pid, sd_bus_error *error);
510 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
512 int unit_watch_pid(Unit *u, pid_t pid);
513 void unit_unwatch_pid(Unit *u, pid_t pid);
514 int unit_watch_all_pids(Unit *u);
515 void unit_unwatch_all_pids(Unit *u);
517 void unit_tidy_watch_pids(Unit *u, pid_t except1, pid_t except2);
519 int unit_watch_bus_name(Unit *u, const char *name);
520 void unit_unwatch_bus_name(Unit *u, const char *name);
522 bool unit_job_is_applicable(Unit *u, JobType j);
524 int set_unit_path(const char *p);
526 char *unit_dbus_path(Unit *u);
528 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
530 bool unit_can_serialize(Unit *u) _pure_;
531 int unit_serialize(Unit *u, FILE *f, FDSet *fds, bool serialize_jobs);
532 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_(4,5);
533 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
534 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
536 int unit_add_node_link(Unit *u, const char *what, bool wants);
538 int unit_coldplug(Unit *u);
540 void unit_status_printf(Unit *u, const char *status, const char *unit_status_msg_format) _printf_(3, 0);
542 bool unit_need_daemon_reload(Unit *u);
544 void unit_reset_failed(Unit *u);
546 Unit *unit_following(Unit *u);
547 int unit_following_set(Unit *u, Set **s);
549 const char *unit_slice_name(Unit *u);
551 bool unit_stop_pending(Unit *u) _pure_;
552 bool unit_inactive_or_pending(Unit *u) _pure_;
553 bool unit_active_or_pending(Unit *u);
555 int unit_add_default_target_dependency(Unit *u, Unit *target);
557 char *unit_default_cgroup_path(Unit *u);
559 void unit_start_on_failure(Unit *u);
560 void unit_trigger_notify(Unit *u);
562 UnitFileState unit_get_unit_file_state(Unit *u);
563 int unit_get_unit_file_preset(Unit *u);
565 Unit* unit_ref_set(UnitRef *ref, Unit *u);
566 void unit_ref_unset(UnitRef *ref);
568 #define UNIT_DEREF(ref) ((ref).unit)
569 #define UNIT_ISSET(ref) (!!(ref).unit)
571 int unit_patch_contexts(Unit *u);
573 ExecContext *unit_get_exec_context(Unit *u) _pure_;
574 KillContext *unit_get_kill_context(Unit *u) _pure_;
575 CGroupContext *unit_get_cgroup_context(Unit *u) _pure_;
577 ExecRuntime *unit_get_exec_runtime(Unit *u) _pure_;
579 int unit_setup_exec_runtime(Unit *u);
581 int unit_write_drop_in(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *data);
582 int unit_write_drop_in_format(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *format, ...) _printf_(4,5);
584 int unit_write_drop_in_private(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *data);
585 int unit_write_drop_in_private_format(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *format, ...) _printf_(4,5);
587 int unit_remove_drop_in(Unit *u, UnitSetPropertiesMode mode, const char *name);
589 int unit_kill_context(Unit *u, KillContext *c, KillOperation k, pid_t main_pid, pid_t control_pid, bool main_pid_alien);
591 int unit_make_transient(Unit *u);
593 int unit_require_mounts_for(Unit *u, const char *path);
595 const char *unit_active_state_to_string(UnitActiveState i) _const_;
596 UnitActiveState unit_active_state_from_string(const char *s) _pure_;
598 /* Macros which append UNIT= or USER_UNIT= to the message */
600 #define log_unit_full_errno(unit, level, error, ...) log_object_internal(level, error, __FILE__, __LINE__, __func__, getpid() == 1 ? "UNIT=" : "USER_UNIT=", unit, __VA_ARGS__)
601 #define log_unit_full(unit, level, ...) log_unit_full_errno(unit, level, 0, __VA_ARGS__)
603 #define log_unit_debug(unit, ...) log_unit_full(unit, LOG_DEBUG, __VA_ARGS__)
604 #define log_unit_info(unit, ...) log_unit_full(unit, LOG_INFO, __VA_ARGS__)
605 #define log_unit_notice(unit, ...) log_unit_full(unit, LOG_NOTICE, __VA_ARGS__)
606 #define log_unit_warning(unit, ...) log_unit_full(unit, LOG_WARNING, __VA_ARGS__)
607 #define log_unit_error(unit, ...) log_unit_full(unit, LOG_ERR, __VA_ARGS__)
609 #define log_unit_debug_errno(unit, error, ...) log_unit_full_errno(unit, LOG_DEBUG, error, __VA_ARGS__)
610 #define log_unit_info_errno(unit, error, ...) log_unit_full_errno(unit, LOG_INFO, error, __VA_ARGS__)
611 #define log_unit_notice_errno(unit, error, ...) log_unit_full_errno(unit, LOG_NOTICE, error, __VA_ARGS__)
612 #define log_unit_warning_errno(unit, error, ...) log_unit_full_errno(unit, LOG_WARNING, error, __VA_ARGS__)
613 #define log_unit_error_errno(unit, error, ...) log_unit_full_errno(unit, LOG_ERR, error, __VA_ARGS__)
615 #define log_unit_struct(unit, level, ...) log_struct(level, getpid() == 1 ? "UNIT=%s" : "USER_UNIT=%s", unit, __VA_ARGS__)
616 #define log_unit_struct_errno(unit, level, error, ...) log_struct_errno(level, error, getpid() == 1 ? "UNIT=%s" : "USER_UNIT=%s", unit, __VA_ARGS__)