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 enum UnitDependency UnitDependency;
32 typedef struct UnitRef UnitRef;
33 typedef struct UnitStatusMessageFormats UnitStatusMessageFormats;
39 #include "socket-util.h"
42 #include "condition.h"
44 #include "unit-name.h"
46 enum UnitActiveState {
53 _UNIT_ACTIVE_STATE_MAX,
54 _UNIT_ACTIVE_STATE_INVALID = -1
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;
74 /* Positive dependencies */
76 UNIT_REQUIRES_OVERRIDABLE,
78 UNIT_REQUISITE_OVERRIDABLE,
83 /* Inverse of the above */
84 UNIT_REQUIRED_BY, /* inverse of 'requires' and 'requisite' is 'required_by' */
85 UNIT_REQUIRED_BY_OVERRIDABLE, /* inverse of 'requires_overridable' and 'requisite_overridable' is 'soft_required_by' */
86 UNIT_WANTED_BY, /* inverse of 'wants' */
87 UNIT_BOUND_BY, /* inverse of 'binds_to' */
88 UNIT_CONSISTS_OF, /* inverse of 'part_of' */
90 /* Negative dependencies */
91 UNIT_CONFLICTS, /* inverse of 'conflicts' is 'conflicted_by' */
95 UNIT_BEFORE, /* inverse of 'before' is 'after' and vice versa */
101 /* Triggers (i.e. a socket triggers a service) */
105 /* Propagate reloads */
106 UNIT_PROPAGATES_RELOAD_TO,
107 UNIT_RELOAD_PROPAGATED_FROM,
109 /* Reference information for GC logic */
110 UNIT_REFERENCES, /* Inverse of 'references' is 'referenced_by' */
113 _UNIT_DEPENDENCY_MAX,
114 _UNIT_DEPENDENCY_INVALID = -1
121 /* Keeps tracks of references to a unit. This is useful so
122 * that we can merge two units if necessary and correct all
123 * references to them */
126 LIST_FIELDS(UnitRef, refs);
133 UnitLoadState load_state;
136 char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
140 Set *dependencies[_UNIT_DEPENDENCY_MAX];
142 char **requires_mounts_for;
145 char **documentation;
147 char *fragment_path; /* if loaded from a config file this is the primary path to it */
148 char *source_path; /* if converted, the source file */
150 usec_t fragment_mtime;
154 /* If there is something to do with this unit, then this is the installed job for it */
157 /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
162 /* References to this */
163 LIST_HEAD(UnitRef, refs);
165 /* Conditions to check */
166 LIST_HEAD(Condition, conditions);
168 dual_timestamp condition_timestamp;
170 dual_timestamp inactive_exit_timestamp;
171 dual_timestamp active_enter_timestamp;
172 dual_timestamp active_exit_timestamp;
173 dual_timestamp inactive_enter_timestamp;
175 /* Counterparts in the cgroup filesystem */
177 CGroupControllerMask cgroup_mask;
182 LIST_FIELDS(Unit, units_by_type);
184 /* All units which have requires_mounts_for set */
185 LIST_FIELDS(Unit, has_requires_mounts_for);
188 LIST_FIELDS(Unit, load_queue);
191 LIST_FIELDS(Unit, dbus_queue);
194 LIST_FIELDS(Unit, cleanup_queue);
197 LIST_FIELDS(Unit, gc_queue);
199 /* CGroup realize members queue */
200 LIST_FIELDS(Unit, cgroup_queue);
202 /* Used during GC sweeps */
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 */
211 /* Error code when we didn't manage to load the unit (negative) */
214 /* Cached unit file state */
215 UnitFileState unit_file_state;
217 /* Garbage collect us we nobody wants or requires us anymore */
218 bool stop_when_unneeded;
220 /* Create default dependencies */
221 bool default_dependencies;
223 /* Refuse manual starting, allow starting only indirectly via dependency. */
224 bool refuse_manual_start;
226 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
227 bool refuse_manual_stop;
229 /* Allow isolation requests */
232 /* Isolate OnFailure unit */
233 bool on_failure_isolate;
235 /* Ignore this unit when isolating */
236 bool ignore_on_isolate;
238 /* Ignore this unit when snapshotting */
239 bool ignore_on_snapshot;
241 /* Did the last condition check succeed? */
242 bool condition_result;
244 /* Is this a transient unit? */
247 bool in_load_queue:1;
248 bool in_dbus_queue:1;
249 bool in_cleanup_queue:1;
251 bool in_cgroup_queue:1;
253 bool sent_dbus_new_signal:1;
259 bool cgroup_realized:1;
262 struct UnitStatusMessageFormats {
263 const char *starting_stopping[2];
264 const char *finished_start_job[_JOB_RESULT_MAX];
265 const char *finished_stop_job[_JOB_RESULT_MAX];
268 typedef enum UnitSetPropertiesMode {
272 } UnitSetPropertiesMode;
280 #include "automount.h"
281 #include "snapshot.h"
288 /* How much memory does an object of this unit type need */
291 /* If greater than 0, the offset into the object where
292 * ExecContext is found, if the unit type has that */
293 size_t exec_context_offset;
295 /* If greater than 0, the offset into the object where
296 * CGroupContext is found, if the unit type has that */
297 size_t cgroup_context_offset;
299 /* If greater than 0, the offset into the object where
300 * KillContext is found, if the unit type has that */
301 size_t kill_context_offset;
303 /* The name of the configuration file section with the private settings of this unit*/
304 const char *private_section;
306 /* Config file sections this unit type understands, separated
308 const char *sections;
310 /* This should reset all type-specific variables. This should
311 * not allocate memory, and is called with zero-initialized
312 * data. It should hence only initialize variables that need
314 void (*init)(Unit *u);
316 /* This should free all type-specific variables. It should be
318 void (*done)(Unit *u);
320 /* Actually load data from disk. This may fail, and should set
321 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
322 * UNIT_STUB if no configuration could be found. */
323 int (*load)(Unit *u);
325 /* If a lot of units got created via enumerate(), this is
326 * where to actually set the state and call unit_notify(). */
327 int (*coldplug)(Unit *u);
329 void (*dump)(Unit *u, FILE *f, const char *prefix);
331 int (*start)(Unit *u);
332 int (*stop)(Unit *u);
333 int (*reload)(Unit *u);
335 int (*kill)(Unit *u, KillWho w, int signo, sd_bus_error *error);
337 bool (*can_reload)(Unit *u);
339 /* Write all data that cannot be restored from other sources
340 * away using unit_serialize_item() */
341 int (*serialize)(Unit *u, FILE *f, FDSet *fds);
343 /* Restore one item from the serialization */
344 int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
346 /* Try to match up fds with what we need for this unit */
347 int (*distribute_fds)(Unit *u, FDSet *fds);
349 /* Boils down the more complex internal state of this unit to
350 * a simpler one that the engine can understand */
351 UnitActiveState (*active_state)(Unit *u);
353 /* Returns the substate specific to this unit type as
354 * string. This is purely information so that we can give the
355 * user a more fine grained explanation in which actual state a
357 const char* (*sub_state_to_string)(Unit *u);
359 /* Return true when there is reason to keep this entry around
360 * even nothing references it and it isn't active in any
362 bool (*check_gc)(Unit *u);
364 /* Return true when this unit is suitable for snapshotting */
365 bool (*check_snapshot)(Unit *u);
367 /* Invoked on every child that died */
368 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
370 /* Reset failed state if we are in failed state */
371 void (*reset_failed)(Unit *u);
373 /* Called whenever any of the cgroups this unit watches for
375 void (*notify_cgroup_empty)(Unit *u);
377 /* Called whenever a process of this unit sends us a message */
378 void (*notify_message)(Unit *u, pid_t pid, char **tags);
380 /* Called whenever a name this Unit registered for comes or
382 void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
384 /* Called for each property that is being set */
385 int (*bus_set_property)(Unit *u, const char *name, sd_bus_message *message, UnitSetPropertiesMode mode, sd_bus_error *error);
387 /* Called after at least one property got changed to apply the necessary change */
388 int (*bus_commit_properties)(Unit *u);
390 /* Return the unit this unit is following */
391 Unit *(*following)(Unit *u);
393 /* Return the set of units that are following each other */
394 int (*following_set)(Unit *u, Set **s);
396 /* Invoked each time a unit this unit is triggering changes
397 * state or gains/loses a job */
398 void (*trigger_notify)(Unit *u, Unit *trigger);
400 /* Called whenever CLOCK_REALTIME made a jump */
401 void (*time_change)(Unit *u);
403 /* This is called for each unit type and should be used to
404 * enumerate existing devices and load them. However,
405 * everything that is loaded here should still stay in
406 * inactive state. It is the job of the coldplug() call above
407 * to put the units into the initial state. */
408 int (*enumerate)(Manager *m);
410 /* Type specific cleanups. */
411 void (*shutdown)(Manager *m);
413 /* The interface name */
414 const char *bus_interface;
417 const sd_bus_vtable *bus_vtable;
419 /* strv list of changing properties */
420 const char * const * const bus_changing_properties;
422 /* The strings to print in status messages */
423 UnitStatusMessageFormats status_message_formats;
425 /* Can units of this type have multiple names? */
428 /* Instances make no sense for this type */
431 /* Exclude from automatic gc */
434 /* True if transient units of this type are OK */
435 bool can_transient:1;
438 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
440 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
442 /* For casting a unit into the various unit types */
443 #define DEFINE_CAST(UPPERCASE, MixedCase) \
444 static inline MixedCase* UPPERCASE(Unit *u) { \
445 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
448 return (MixedCase*) u; \
451 /* For casting the various unit types into a unit */
452 #define UNIT(u) (&(u)->meta)
454 #define UNIT_TRIGGER(u) ((Unit*) set_first((u)->dependencies[UNIT_TRIGGERS]))
456 DEFINE_CAST(SOCKET, Socket);
457 DEFINE_CAST(TIMER, Timer);
458 DEFINE_CAST(SERVICE, Service);
459 DEFINE_CAST(TARGET, Target);
460 DEFINE_CAST(DEVICE, Device);
461 DEFINE_CAST(MOUNT, Mount);
462 DEFINE_CAST(AUTOMOUNT, Automount);
463 DEFINE_CAST(SNAPSHOT, Snapshot);
464 DEFINE_CAST(SWAP, Swap);
465 DEFINE_CAST(PATH, Path);
466 DEFINE_CAST(SLICE, Slice);
467 DEFINE_CAST(SCOPE, Scope);
469 Unit *unit_new(Manager *m, size_t size);
470 void unit_free(Unit *u);
472 int unit_add_name(Unit *u, const char *name);
474 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
475 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
477 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
478 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
480 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
481 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
483 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
485 int unit_choose_id(Unit *u, const char *name);
486 int unit_set_description(Unit *u, const char *description);
488 bool unit_check_gc(Unit *u);
490 void unit_add_to_load_queue(Unit *u);
491 void unit_add_to_dbus_queue(Unit *u);
492 void unit_add_to_cleanup_queue(Unit *u);
493 void unit_add_to_gc_queue(Unit *u);
495 int unit_merge(Unit *u, Unit *other);
496 int unit_merge_by_name(Unit *u, const char *other);
498 Unit *unit_follow_merge(Unit *u) _pure_;
500 int unit_load_fragment_and_dropin(Unit *u);
501 int unit_load_fragment_and_dropin_optional(Unit *u);
502 int unit_load(Unit *unit);
504 int unit_add_default_slice(Unit *u);
506 const char *unit_description(Unit *u) _pure_;
508 bool unit_has_name(Unit *u, const char *name);
510 UnitActiveState unit_active_state(Unit *u);
512 const char* unit_sub_state_to_string(Unit *u);
514 void unit_dump(Unit *u, FILE *f, const char *prefix);
516 bool unit_can_reload(Unit *u) _pure_;
517 bool unit_can_start(Unit *u) _pure_;
518 bool unit_can_isolate(Unit *u) _pure_;
520 int unit_start(Unit *u);
521 int unit_stop(Unit *u);
522 int unit_reload(Unit *u);
524 int unit_kill(Unit *u, KillWho w, int signo, sd_bus_error *error);
525 int unit_kill_common(Unit *u, KillWho who, int signo, pid_t main_pid, pid_t control_pid, sd_bus_error *error);
527 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
529 int unit_watch_pid(Unit *u, pid_t pid);
530 void unit_unwatch_pid(Unit *u, pid_t pid);
532 int unit_watch_bus_name(Unit *u, const char *name);
533 void unit_unwatch_bus_name(Unit *u, const char *name);
535 bool unit_job_is_applicable(Unit *u, JobType j);
537 int set_unit_path(const char *p);
539 char *unit_dbus_path(Unit *u);
541 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
543 bool unit_can_serialize(Unit *u) _pure_;
544 int unit_serialize(Unit *u, FILE *f, FDSet *fds, bool serialize_jobs);
545 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_(4,5);
546 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
547 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
549 int unit_add_node_link(Unit *u, const char *what, bool wants);
551 int unit_coldplug(Unit *u);
553 void unit_status_printf(Unit *u, const char *status, const char *unit_status_msg_format) _printf_(3, 0);
555 bool unit_need_daemon_reload(Unit *u);
557 void unit_reset_failed(Unit *u);
559 Unit *unit_following(Unit *u);
561 const char *unit_slice_name(Unit *u);
563 bool unit_stop_pending(Unit *u) _pure_;
564 bool unit_inactive_or_pending(Unit *u) _pure_;
565 bool unit_active_or_pending(Unit *u);
567 int unit_add_default_target_dependency(Unit *u, Unit *target);
569 char *unit_default_cgroup_path(Unit *u);
571 int unit_following_set(Unit *u, Set **s);
573 void unit_start_on_failure(Unit *u);
574 void unit_trigger_notify(Unit *u);
576 UnitFileState unit_get_unit_file_state(Unit *u);
578 Unit* unit_ref_set(UnitRef *ref, Unit *u);
579 void unit_ref_unset(UnitRef *ref);
581 #define UNIT_DEREF(ref) ((ref).unit)
582 #define UNIT_ISSET(ref) (!!(ref).unit)
584 int unit_exec_context_defaults(Unit *u, ExecContext *c);
586 ExecContext *unit_get_exec_context(Unit *u) _pure_;
587 KillContext *unit_get_kill_context(Unit *u) _pure_;
588 CGroupContext *unit_get_cgroup_context(Unit *u) _pure_;
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);
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);
596 int unit_remove_drop_in(Unit *u, UnitSetPropertiesMode mode, const char *name);
598 int unit_kill_context(Unit *u, KillContext *c, bool sigkill, pid_t main_pid, pid_t control_pid, bool main_pid_alien);
600 int unit_make_transient(Unit *u);
602 int unit_require_mounts_for(Unit *u, const char *path);
604 const char *unit_active_state_to_string(UnitActiveState i) _const_;
605 UnitActiveState unit_active_state_from_string(const char *s) _pure_;
607 const char *unit_dependency_to_string(UnitDependency i) _const_;
608 UnitDependency unit_dependency_from_string(const char *s) _pure_;
610 /* Macros which append UNIT= or USER_UNIT= to the message */
612 #define log_full_unit(level, unit, ...) log_meta_object(level, __FILE__, __LINE__, __func__, getpid() == 1 ? "UNIT=" : "USER_UNIT=", unit, __VA_ARGS__)
613 #define log_debug_unit(unit, ...) log_full_unit(LOG_DEBUG, unit, __VA_ARGS__)
614 #define log_info_unit(unit, ...) log_full_unit(LOG_INFO, unit, __VA_ARGS__)
615 #define log_notice_unit(unit, ...) log_full_unit(LOG_NOTICE, unit, __VA_ARGS__)
616 #define log_warning_unit(unit, ...) log_full_unit(LOG_WARNING, unit, __VA_ARGS__)
617 #define log_error_unit(unit, ...) log_full_unit(LOG_ERR, unit, __VA_ARGS__)
619 #define log_struct_unit(level, unit, ...) log_struct(level, getpid() == 1 ? "UNIT=%s" : "USER_UNIT=%s", unit, __VA_ARGS__)