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 /* Joins namespace of */
110 UNIT_JOINS_NAMESPACE_OF,
112 /* Reference information for GC logic */
113 UNIT_REFERENCES, /* Inverse of 'references' is 'referenced_by' */
116 _UNIT_DEPENDENCY_MAX,
117 _UNIT_DEPENDENCY_INVALID = -1
124 /* Keeps tracks of references to a unit. This is useful so
125 * that we can merge two units if necessary and correct all
126 * references to them */
129 LIST_FIELDS(UnitRef, refs);
136 UnitLoadState load_state;
139 char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
143 Set *dependencies[_UNIT_DEPENDENCY_MAX];
145 char **requires_mounts_for;
148 char **documentation;
150 char *fragment_path; /* if loaded from a config file this is the primary path to it */
151 char *source_path; /* if converted, the source file */
153 usec_t fragment_mtime;
157 /* If there is something to do with this unit, then this is the installed job for it */
160 /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
165 /* References to this */
166 LIST_HEAD(UnitRef, refs);
168 /* Conditions to check */
169 LIST_HEAD(Condition, conditions);
171 dual_timestamp condition_timestamp;
173 dual_timestamp inactive_exit_timestamp;
174 dual_timestamp active_enter_timestamp;
175 dual_timestamp active_exit_timestamp;
176 dual_timestamp inactive_enter_timestamp;
178 /* Counterparts in the cgroup filesystem */
180 CGroupControllerMask cgroup_mask;
181 CGroupControllerMask cgroup_members_mask;
186 LIST_FIELDS(Unit, units_by_type);
188 /* All units which have requires_mounts_for set */
189 LIST_FIELDS(Unit, has_requires_mounts_for);
192 LIST_FIELDS(Unit, load_queue);
195 LIST_FIELDS(Unit, dbus_queue);
198 LIST_FIELDS(Unit, cleanup_queue);
201 LIST_FIELDS(Unit, gc_queue);
203 /* CGroup realize members queue */
204 LIST_FIELDS(Unit, cgroup_queue);
206 /* Used during GC sweeps */
209 /* When deserializing, temporarily store the job type for this
210 * unit here, if there was a job scheduled.
211 * Only for deserializing from a legacy version. New style uses full
212 * serialized jobs. */
213 int deserialized_job; /* This is actually of type JobType */
215 /* Error code when we didn't manage to load the unit (negative) */
218 /* Cached unit file state */
219 UnitFileState unit_file_state;
221 /* Garbage collect us we nobody wants or requires us anymore */
222 bool stop_when_unneeded;
224 /* Create default dependencies */
225 bool default_dependencies;
227 /* Refuse manual starting, allow starting only indirectly via dependency. */
228 bool refuse_manual_start;
230 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
231 bool refuse_manual_stop;
233 /* Allow isolation requests */
236 /* How to start OnFailure units */
237 JobMode on_failure_job_mode;
239 /* Ignore this unit when isolating */
240 bool ignore_on_isolate;
242 /* Ignore this unit when snapshotting */
243 bool ignore_on_snapshot;
245 /* Did the last condition check succeed? */
246 bool condition_result;
248 /* Is this a transient unit? */
251 bool in_load_queue:1;
252 bool in_dbus_queue:1;
253 bool in_cleanup_queue:1;
255 bool in_cgroup_queue:1;
257 bool sent_dbus_new_signal:1;
263 bool cgroup_realized:1;
266 struct UnitStatusMessageFormats {
267 const char *starting_stopping[2];
268 const char *finished_start_job[_JOB_RESULT_MAX];
269 const char *finished_stop_job[_JOB_RESULT_MAX];
272 typedef enum UnitSetPropertiesMode {
276 } UnitSetPropertiesMode;
282 #include "snapshot.h"
285 #include "automount.h"
293 /* How much memory does an object of this unit type need */
296 /* If greater than 0, the offset into the object where
297 * ExecContext is found, if the unit type has that */
298 size_t exec_context_offset;
300 /* If greater than 0, the offset into the object where
301 * CGroupContext is found, if the unit type has that */
302 size_t cgroup_context_offset;
304 /* If greater than 0, the offset into the object where
305 * KillContext is found, if the unit type has that */
306 size_t kill_context_offset;
308 /* If greater than 0, the offset into the object where the
309 * pointer to ExecRuntime is found, if the unit type has
311 size_t exec_runtime_offset;
313 /* The name of the configuration file section with the private settings of this unit*/
314 const char *private_section;
316 /* Config file sections this unit type understands, separated
318 const char *sections;
320 /* This should reset all type-specific variables. This should
321 * not allocate memory, and is called with zero-initialized
322 * data. It should hence only initialize variables that need
324 void (*init)(Unit *u);
326 /* This should free all type-specific variables. It should be
328 void (*done)(Unit *u);
330 /* Actually load data from disk. This may fail, and should set
331 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
332 * UNIT_STUB if no configuration could be found. */
333 int (*load)(Unit *u);
335 /* If a lot of units got created via enumerate(), this is
336 * where to actually set the state and call unit_notify(). */
337 int (*coldplug)(Unit *u);
339 void (*dump)(Unit *u, FILE *f, const char *prefix);
341 int (*start)(Unit *u);
342 int (*stop)(Unit *u);
343 int (*reload)(Unit *u);
345 int (*kill)(Unit *u, KillWho w, int signo, sd_bus_error *error);
347 bool (*can_reload)(Unit *u);
349 /* Write all data that cannot be restored from other sources
350 * away using unit_serialize_item() */
351 int (*serialize)(Unit *u, FILE *f, FDSet *fds);
353 /* Restore one item from the serialization */
354 int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
356 /* Try to match up fds with what we need for this unit */
357 int (*distribute_fds)(Unit *u, FDSet *fds);
359 /* Boils down the more complex internal state of this unit to
360 * a simpler one that the engine can understand */
361 UnitActiveState (*active_state)(Unit *u);
363 /* Returns the substate specific to this unit type as
364 * string. This is purely information so that we can give the
365 * user a more fine grained explanation in which actual state a
367 const char* (*sub_state_to_string)(Unit *u);
369 /* Return true when there is reason to keep this entry around
370 * even nothing references it and it isn't active in any
372 bool (*check_gc)(Unit *u);
374 /* Return true when this unit is suitable for snapshotting */
375 bool (*check_snapshot)(Unit *u);
377 /* Invoked on every child that died */
378 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
380 /* Reset failed state if we are in failed state */
381 void (*reset_failed)(Unit *u);
383 /* Called whenever any of the cgroups this unit watches for
385 void (*notify_cgroup_empty)(Unit *u);
387 /* Called whenever a process of this unit sends us a message */
388 void (*notify_message)(Unit *u, pid_t pid, char **tags);
390 /* Called whenever a name this Unit registered for comes or
392 void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
394 /* Called for each property that is being set */
395 int (*bus_set_property)(Unit *u, const char *name, sd_bus_message *message, UnitSetPropertiesMode mode, sd_bus_error *error);
397 /* Called after at least one property got changed to apply the necessary change */
398 int (*bus_commit_properties)(Unit *u);
400 /* Return the unit this unit is following */
401 Unit *(*following)(Unit *u);
403 /* Return the set of units that are following each other */
404 int (*following_set)(Unit *u, Set **s);
406 /* Invoked each time a unit this unit is triggering changes
407 * state or gains/loses a job */
408 void (*trigger_notify)(Unit *u, Unit *trigger);
410 /* Called whenever CLOCK_REALTIME made a jump */
411 void (*time_change)(Unit *u);
413 /* This is called for each unit type and should be used to
414 * enumerate existing devices and load them. However,
415 * everything that is loaded here should still stay in
416 * inactive state. It is the job of the coldplug() call above
417 * to put the units into the initial state. */
418 int (*enumerate)(Manager *m);
420 /* Type specific cleanups. */
421 void (*shutdown)(Manager *m);
423 /* The interface name */
424 const char *bus_interface;
427 const sd_bus_vtable *bus_vtable;
429 /* strv list of changing properties */
430 const char * const * const bus_changing_properties;
432 /* The strings to print in status messages */
433 UnitStatusMessageFormats status_message_formats;
435 /* Can units of this type have multiple names? */
438 /* Instances make no sense for this type */
441 /* Exclude from automatic gc */
444 /* True if transient units of this type are OK */
445 bool can_transient:1;
448 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
450 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
452 /* For casting a unit into the various unit types */
453 #define DEFINE_CAST(UPPERCASE, MixedCase) \
454 static inline MixedCase* UPPERCASE(Unit *u) { \
455 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
458 return (MixedCase*) u; \
461 /* For casting the various unit types into a unit */
462 #define UNIT(u) (&(u)->meta)
464 #define UNIT_TRIGGER(u) ((Unit*) set_first((u)->dependencies[UNIT_TRIGGERS]))
466 DEFINE_CAST(SERVICE, Service);
467 DEFINE_CAST(SOCKET, Socket);
468 DEFINE_CAST(BUSNAME, BusName);
469 DEFINE_CAST(TARGET, Target);
470 DEFINE_CAST(SNAPSHOT, Snapshot);
471 DEFINE_CAST(DEVICE, Device);
472 DEFINE_CAST(MOUNT, Mount);
473 DEFINE_CAST(AUTOMOUNT, Automount);
474 DEFINE_CAST(SWAP, Swap);
475 DEFINE_CAST(TIMER, Timer);
476 DEFINE_CAST(PATH, Path);
477 DEFINE_CAST(SLICE, Slice);
478 DEFINE_CAST(SCOPE, Scope);
480 Unit *unit_new(Manager *m, size_t size);
481 void unit_free(Unit *u);
483 int unit_add_name(Unit *u, const char *name);
485 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
486 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
488 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
489 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
491 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
492 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
494 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
496 int unit_choose_id(Unit *u, const char *name);
497 int unit_set_description(Unit *u, const char *description);
499 bool unit_check_gc(Unit *u);
501 void unit_add_to_load_queue(Unit *u);
502 void unit_add_to_dbus_queue(Unit *u);
503 void unit_add_to_cleanup_queue(Unit *u);
504 void unit_add_to_gc_queue(Unit *u);
506 int unit_merge(Unit *u, Unit *other);
507 int unit_merge_by_name(Unit *u, const char *other);
509 Unit *unit_follow_merge(Unit *u) _pure_;
511 int unit_load_fragment_and_dropin(Unit *u);
512 int unit_load_fragment_and_dropin_optional(Unit *u);
513 int unit_load(Unit *unit);
515 int unit_add_default_slice(Unit *u);
517 const char *unit_description(Unit *u) _pure_;
519 bool unit_has_name(Unit *u, const char *name);
521 UnitActiveState unit_active_state(Unit *u);
523 const char* unit_sub_state_to_string(Unit *u);
525 void unit_dump(Unit *u, FILE *f, const char *prefix);
527 bool unit_can_reload(Unit *u) _pure_;
528 bool unit_can_start(Unit *u) _pure_;
529 bool unit_can_isolate(Unit *u) _pure_;
531 int unit_start(Unit *u);
532 int unit_stop(Unit *u);
533 int unit_reload(Unit *u);
535 int unit_kill(Unit *u, KillWho w, int signo, sd_bus_error *error);
536 int unit_kill_common(Unit *u, KillWho who, int signo, pid_t main_pid, pid_t control_pid, sd_bus_error *error);
538 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
540 int unit_watch_pid(Unit *u, pid_t pid);
541 void unit_unwatch_pid(Unit *u, pid_t pid);
543 int unit_watch_bus_name(Unit *u, const char *name);
544 void unit_unwatch_bus_name(Unit *u, const char *name);
546 bool unit_job_is_applicable(Unit *u, JobType j);
548 int set_unit_path(const char *p);
550 char *unit_dbus_path(Unit *u);
552 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
554 bool unit_can_serialize(Unit *u) _pure_;
555 int unit_serialize(Unit *u, FILE *f, FDSet *fds, bool serialize_jobs);
556 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_(4,5);
557 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
558 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
560 int unit_add_node_link(Unit *u, const char *what, bool wants);
562 int unit_coldplug(Unit *u);
564 void unit_status_printf(Unit *u, const char *status, const char *unit_status_msg_format) _printf_(3, 0);
566 bool unit_need_daemon_reload(Unit *u);
568 void unit_reset_failed(Unit *u);
570 Unit *unit_following(Unit *u);
571 int unit_following_set(Unit *u, Set **s);
573 const char *unit_slice_name(Unit *u);
575 bool unit_stop_pending(Unit *u) _pure_;
576 bool unit_inactive_or_pending(Unit *u) _pure_;
577 bool unit_active_or_pending(Unit *u);
579 int unit_add_default_target_dependency(Unit *u, Unit *target);
581 char *unit_default_cgroup_path(Unit *u);
583 void unit_start_on_failure(Unit *u);
584 void unit_trigger_notify(Unit *u);
586 UnitFileState unit_get_unit_file_state(Unit *u);
588 Unit* unit_ref_set(UnitRef *ref, Unit *u);
589 void unit_ref_unset(UnitRef *ref);
591 #define UNIT_DEREF(ref) ((ref).unit)
592 #define UNIT_ISSET(ref) (!!(ref).unit)
594 int unit_exec_context_defaults(Unit *u, ExecContext *c);
596 ExecContext *unit_get_exec_context(Unit *u) _pure_;
597 KillContext *unit_get_kill_context(Unit *u) _pure_;
598 CGroupContext *unit_get_cgroup_context(Unit *u) _pure_;
599 ExecRuntime *unit_get_exec_runtime(Unit *u) _pure_;
601 int unit_setup_exec_runtime(Unit *u);
603 int unit_write_drop_in(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *data);
604 int unit_write_drop_in_format(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *format, ...) _printf_(4,5);
606 int unit_write_drop_in_private(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *data);
607 int unit_write_drop_in_private_format(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *format, ...) _printf_(4,5);
609 int unit_remove_drop_in(Unit *u, UnitSetPropertiesMode mode, const char *name);
611 int unit_kill_context(Unit *u, KillContext *c, bool sigkill, pid_t main_pid, pid_t control_pid, bool main_pid_alien);
613 int unit_make_transient(Unit *u);
615 int unit_require_mounts_for(Unit *u, const char *path);
617 const char *unit_active_state_to_string(UnitActiveState i) _const_;
618 UnitActiveState unit_active_state_from_string(const char *s) _pure_;
620 const char *unit_dependency_to_string(UnitDependency i) _const_;
621 UnitDependency unit_dependency_from_string(const char *s) _pure_;
623 /* Macros which append UNIT= or USER_UNIT= to the message */
625 #define log_full_unit(level, unit, ...) log_meta_object(level, __FILE__, __LINE__, __func__, getpid() == 1 ? "UNIT=" : "USER_UNIT=", unit, __VA_ARGS__)
626 #define log_debug_unit(unit, ...) log_full_unit(LOG_DEBUG, unit, __VA_ARGS__)
627 #define log_info_unit(unit, ...) log_full_unit(LOG_INFO, unit, __VA_ARGS__)
628 #define log_notice_unit(unit, ...) log_full_unit(LOG_NOTICE, unit, __VA_ARGS__)
629 #define log_warning_unit(unit, ...) log_full_unit(LOG_WARNING, unit, __VA_ARGS__)
630 #define log_error_unit(unit, ...) log_full_unit(LOG_ERR, unit, __VA_ARGS__)
632 #define log_struct_unit(level, unit, ...) log_struct(level, getpid() == 1 ? "UNIT=%s" : "USER_UNIT=%s", unit, __VA_ARGS__)