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;
38 #include "socket-util.h"
40 #include "condition.h"
42 #include "unit-name.h"
44 enum UnitActiveState {
51 _UNIT_ACTIVE_STATE_MAX,
52 _UNIT_ACTIVE_STATE_INVALID = -1
55 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) {
56 return t == UNIT_ACTIVE || t == UNIT_RELOADING;
59 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) {
60 return t == UNIT_ACTIVE || t == UNIT_ACTIVATING || t == UNIT_RELOADING;
63 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) {
64 return t == UNIT_INACTIVE || t == UNIT_FAILED || t == UNIT_DEACTIVATING;
67 static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t) {
68 return t == UNIT_INACTIVE || t == UNIT_FAILED;
72 /* Positive dependencies */
74 UNIT_REQUIRES_OVERRIDABLE,
76 UNIT_REQUISITE_OVERRIDABLE,
81 /* Inverse of the above */
82 UNIT_REQUIRED_BY, /* inverse of 'requires' and 'requisite' is 'required_by' */
83 UNIT_REQUIRED_BY_OVERRIDABLE, /* inverse of 'requires_overridable' and 'requisite_overridable' is 'soft_required_by' */
84 UNIT_WANTED_BY, /* inverse of 'wants' */
85 UNIT_BOUND_BY, /* inverse of 'binds_to' */
86 UNIT_CONSISTS_OF, /* inverse of 'part_of' */
88 /* Negative dependencies */
89 UNIT_CONFLICTS, /* inverse of 'conflicts' is 'conflicted_by' */
93 UNIT_BEFORE, /* inverse of 'before' is 'after' and vice versa */
99 /* Triggers (i.e. a socket triggers a service) */
103 /* Propagate reloads */
104 UNIT_PROPAGATES_RELOAD_TO,
105 UNIT_RELOAD_PROPAGATED_FROM,
107 /* Reference information for GC logic */
108 UNIT_REFERENCES, /* Inverse of 'references' is 'referenced_by' */
111 _UNIT_DEPENDENCY_MAX,
112 _UNIT_DEPENDENCY_INVALID = -1
118 #include "cgroup-attr.h"
124 UnitLoadState load_state;
127 char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
131 Set *dependencies[_UNIT_DEPENDENCY_MAX];
133 char **requires_mounts_for;
136 char **documentation;
138 char *fragment_path; /* if loaded from a config file this is the primary path to it */
139 char *source_path; /* if converted, the source file */
140 usec_t fragment_mtime;
143 /* If there is something to do with this unit, then this is the installed job for it */
146 /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
151 /* References to this */
152 LIST_HEAD(UnitRef, refs);
154 /* Conditions to check */
155 LIST_HEAD(Condition, conditions);
157 dual_timestamp condition_timestamp;
159 dual_timestamp inactive_exit_timestamp;
160 dual_timestamp active_enter_timestamp;
161 dual_timestamp active_exit_timestamp;
162 dual_timestamp inactive_enter_timestamp;
164 /* Counterparts in the cgroup filesystem */
165 CGroupBonding *cgroup_bondings;
166 CGroupAttribute *cgroup_attributes;
169 LIST_FIELDS(Unit, units_by_type);
171 /* All units which have requires_mounts_for set */
172 LIST_FIELDS(Unit, has_requires_mounts_for);
175 LIST_FIELDS(Unit, load_queue);
178 LIST_FIELDS(Unit, dbus_queue);
181 LIST_FIELDS(Unit, cleanup_queue);
184 LIST_FIELDS(Unit, gc_queue);
186 /* Used during GC sweeps */
189 /* When deserializing, temporarily store the job type for this
190 * unit here, if there was a job scheduled.
191 * Only for deserializing from a legacy version. New style uses full
192 * serialized jobs. */
193 int deserialized_job; /* This is actually of type JobType */
195 /* Error code when we didn't manage to load the unit (negative) */
198 /* Cached unit file state */
199 UnitFileState unit_file_state;
201 /* Garbage collect us we nobody wants or requires us anymore */
202 bool stop_when_unneeded;
204 /* Create default dependencies */
205 bool default_dependencies;
207 /* Refuse manual starting, allow starting only indirectly via dependency. */
208 bool refuse_manual_start;
210 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
211 bool refuse_manual_stop;
213 /* Allow isolation requests */
216 /* Isolate OnFailure unit */
217 bool on_failure_isolate;
219 /* Ignore this unit when isolating */
220 bool ignore_on_isolate;
222 /* Ignore this unit when snapshotting */
223 bool ignore_on_snapshot;
225 /* Did the last condition check succeed? */
226 bool condition_result;
228 bool in_load_queue:1;
229 bool in_dbus_queue:1;
230 bool in_cleanup_queue:1;
233 bool sent_dbus_new_signal:1;
241 /* Keeps tracks of references to a unit. This is useful so
242 * that we can merge two units if necessary and correct all
243 * references to them */
246 LIST_FIELDS(UnitRef, refs);
249 struct UnitStatusMessageFormats {
250 const char *starting_stopping[2];
251 const char *finished_start_job[_JOB_RESULT_MAX];
252 const char *finished_stop_job[_JOB_RESULT_MAX];
261 #include "automount.h"
262 #include "snapshot.h"
267 /* How much memory does an object of this unit type need */
270 /* If greater than 0, the offset into the object where
271 * ExecContext is found, if the unit type has that */
272 size_t exec_context_offset;
274 /* The name of the section with the exec settings of ExecContext */
275 const char *exec_section;
277 /* Config file sections this unit type understands, separated
279 const char *sections;
281 /* This should reset all type-specific variables. This should
282 * not allocate memory, and is called with zero-initialized
283 * data. It should hence only initialize variables that need
285 void (*init)(Unit *u);
287 /* This should free all type-specific variables. It should be
289 void (*done)(Unit *u);
291 /* Actually load data from disk. This may fail, and should set
292 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
293 * UNIT_STUB if no configuration could be found. */
294 int (*load)(Unit *u);
296 /* If a lot of units got created via enumerate(), this is
297 * where to actually set the state and call unit_notify(). */
298 int (*coldplug)(Unit *u);
300 void (*dump)(Unit *u, FILE *f, const char *prefix);
302 int (*start)(Unit *u);
303 int (*stop)(Unit *u);
304 int (*reload)(Unit *u);
306 int (*kill)(Unit *u, KillWho w, int signo, DBusError *error);
308 bool (*can_reload)(Unit *u);
310 /* Write all data that cannot be restored from other sources
311 * away using unit_serialize_item() */
312 int (*serialize)(Unit *u, FILE *f, FDSet *fds);
314 /* Restore one item from the serialization */
315 int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
317 /* Try to match up fds with what we need for this unit */
318 int (*distribute_fds)(Unit *u, FDSet *fds);
320 /* Boils down the more complex internal state of this unit to
321 * a simpler one that the engine can understand */
322 UnitActiveState (*active_state)(Unit *u);
324 /* Returns the substate specific to this unit type as
325 * string. This is purely information so that we can give the
326 * user a more fine grained explanation in which actual state a
328 const char* (*sub_state_to_string)(Unit *u);
330 /* Return true when there is reason to keep this entry around
331 * even nothing references it and it isn't active in any
333 bool (*check_gc)(Unit *u);
335 /* Return true when this unit is suitable for snapshotting */
336 bool (*check_snapshot)(Unit *u);
338 void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
339 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
340 void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
342 /* Reset failed state if we are in failed state */
343 void (*reset_failed)(Unit *u);
345 /* Called whenever any of the cgroups this unit watches for
347 void (*cgroup_notify_empty)(Unit *u);
349 /* Called whenever a process of this unit sends us a message */
350 void (*notify_message)(Unit *u, pid_t pid, char **tags);
352 /* Called whenever a name thus Unit registered for comes or
354 void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
356 /* Called whenever a bus PID lookup finishes */
357 void (*bus_query_pid_done)(Unit *u, const char *name, pid_t pid);
359 /* Called for each message received on the bus */
360 DBusHandlerResult (*bus_message_handler)(Unit *u, DBusConnection *c, DBusMessage *message);
362 /* Return the unit this unit is following */
363 Unit *(*following)(Unit *u);
365 /* Return the set of units that are following each other */
366 int (*following_set)(Unit *u, Set **s);
368 /* Called whenever CLOCK_REALTIME made a jump */
369 void (*time_change)(Unit *u);
371 /* This is called for each unit type and should be used to
372 * enumerate existing devices and load them. However,
373 * everything that is loaded here should still stay in
374 * inactive state. It is the job of the coldplug() call above
375 * to put the units into the initial state. */
376 int (*enumerate)(Manager *m);
378 /* Type specific cleanups. */
379 void (*shutdown)(Manager *m);
381 /* When sending out PropertiesChanged signal, which properties
382 * shall be invalidated? This is a NUL separated list of
383 * strings, to minimize relocations a little. */
384 const char *bus_invalidating_properties;
386 /* The interface name */
387 const char *bus_interface;
389 UnitStatusMessageFormats status_message_formats;
391 /* Can units of this type have multiple names? */
394 /* Instances make no sense for this type */
397 /* Exclude from automatic gc */
401 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
403 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
405 /* For casting a unit into the various unit types */
406 #define DEFINE_CAST(UPPERCASE, MixedCase) \
407 static inline MixedCase* UPPERCASE(Unit *u) { \
408 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
411 return (MixedCase*) u; \
414 /* For casting the various unit types into a unit */
415 #define UNIT(u) (&(u)->meta)
417 DEFINE_CAST(SOCKET, Socket);
418 DEFINE_CAST(TIMER, Timer);
419 DEFINE_CAST(SERVICE, Service);
420 DEFINE_CAST(TARGET, Target);
421 DEFINE_CAST(DEVICE, Device);
422 DEFINE_CAST(MOUNT, Mount);
423 DEFINE_CAST(AUTOMOUNT, Automount);
424 DEFINE_CAST(SNAPSHOT, Snapshot);
425 DEFINE_CAST(SWAP, Swap);
426 DEFINE_CAST(PATH, Path);
428 Unit *unit_new(Manager *m, size_t size);
429 void unit_free(Unit *u);
431 int unit_add_name(Unit *u, const char *name);
433 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
434 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
436 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
437 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
439 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
440 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
442 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
444 int unit_add_cgroup(Unit *u, CGroupBonding *b);
445 int unit_add_cgroup_from_text(Unit *u, const char *name, bool overwrite, CGroupBonding **ret);
446 int unit_add_default_cgroups(Unit *u);
447 CGroupBonding* unit_get_default_cgroup(Unit *u);
448 int unit_add_cgroup_attribute(Unit *u, const char *controller, const char *name, const char *value, CGroupAttributeMapCallback map_callback, CGroupAttribute **ret);
450 int unit_choose_id(Unit *u, const char *name);
451 int unit_set_description(Unit *u, const char *description);
453 bool unit_check_gc(Unit *u);
455 void unit_add_to_load_queue(Unit *u);
456 void unit_add_to_dbus_queue(Unit *u);
457 void unit_add_to_cleanup_queue(Unit *u);
458 void unit_add_to_gc_queue(Unit *u);
460 int unit_merge(Unit *u, Unit *other);
461 int unit_merge_by_name(Unit *u, const char *other);
463 Unit *unit_follow_merge(Unit *u);
465 int unit_load_fragment_and_dropin(Unit *u);
466 int unit_load_fragment_and_dropin_optional(Unit *u);
467 int unit_load(Unit *unit);
469 const char *unit_description(Unit *u);
471 bool unit_has_name(Unit *u, const char *name);
473 UnitActiveState unit_active_state(Unit *u);
475 const char* unit_sub_state_to_string(Unit *u);
477 void unit_dump(Unit *u, FILE *f, const char *prefix);
479 bool unit_can_reload(Unit *u);
480 bool unit_can_start(Unit *u);
481 bool unit_can_isolate(Unit *u);
483 int unit_start(Unit *u);
484 int unit_stop(Unit *u);
485 int unit_reload(Unit *u);
487 int unit_kill(Unit *u, KillWho w, int signo, DBusError *error);
489 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
491 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
492 void unit_unwatch_fd(Unit *u, Watch *w);
494 int unit_watch_pid(Unit *u, pid_t pid);
495 void unit_unwatch_pid(Unit *u, pid_t pid);
497 int unit_watch_timer(Unit *u, clockid_t, bool relative, usec_t usec, Watch *w);
498 void unit_unwatch_timer(Unit *u, Watch *w);
500 int unit_watch_bus_name(Unit *u, const char *name);
501 void unit_unwatch_bus_name(Unit *u, const char *name);
503 bool unit_job_is_applicable(Unit *u, JobType j);
505 int set_unit_path(const char *p);
507 char *unit_dbus_path(Unit *u);
509 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
510 int unit_get_related_unit(Unit *u, const char *type, Unit **_found);
512 bool unit_can_serialize(Unit *u);
513 int unit_serialize(Unit *u, FILE *f, FDSet *fds, bool serialize_jobs);
514 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_attr_(4,5);
515 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
516 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
518 int unit_add_node_link(Unit *u, const char *what, bool wants);
520 int unit_coldplug(Unit *u);
522 void unit_status_printf(Unit *u, const char *status, const char *format, ...);
524 bool unit_need_daemon_reload(Unit *u);
526 void unit_reset_failed(Unit *u);
528 Unit *unit_following(Unit *u);
530 bool unit_pending_inactive(Unit *u);
531 bool unit_pending_active(Unit *u);
533 int unit_add_default_target_dependency(Unit *u, Unit *target);
535 char *unit_default_cgroup_path(Unit *u);
537 int unit_following_set(Unit *u, Set **s);
539 void unit_trigger_on_failure(Unit *u);
541 bool unit_condition_test(Unit *u);
543 UnitFileState unit_get_unit_file_state(Unit *u);
545 Unit* unit_ref_set(UnitRef *ref, Unit *u);
546 void unit_ref_unset(UnitRef *ref);
548 #define UNIT_DEREF(ref) ((ref).unit)
550 int unit_add_one_mount_link(Unit *u, Mount *m);
551 int unit_add_mount_links(Unit *u);
553 int unit_exec_context_defaults(Unit *u, ExecContext *c);
555 ExecContext *unit_get_exec_context(Unit *u);
557 int unit_write_drop_in(Unit *u, bool runtime, const char *name, const char *data);
558 int unit_remove_drop_in(Unit *u, bool runtime, const char *name);
560 int unit_kill_context(Unit *u, KillContext *c, bool sigkill, pid_t main_pid, pid_t control_pid, bool main_pid_alien);
562 const char *unit_active_state_to_string(UnitActiveState i);
563 UnitActiveState unit_active_state_from_string(const char *s);
565 const char *unit_dependency_to_string(UnitDependency i);
566 UnitDependency unit_dependency_from_string(const char *s);
568 #define log_full_unit(level, unit, ...) log_meta_object(level, __FILE__, __LINE__, __func__, getpid() == 1 ? "UNIT=" : "USER_UNIT=", unit, __VA_ARGS__)
569 #define log_debug_unit(unit, ...) log_full_unit(LOG_DEBUG, unit, __VA_ARGS__)
570 #define log_info_unit(unit, ...) log_full_unit(LOG_INFO, unit, __VA_ARGS__)
571 #define log_notice_unit(unit, ...) log_full_unit(LOG_NOTICE, unit, __VA_ARGS__)
572 #define log_warning_unit(unit, ...) log_full_unit(LOG_WARNING, unit, __VA_ARGS__)
573 #define log_error_unit(unit, ...) log_full_unit(LOG_ERR, unit, __VA_ARGS__)
575 #define log_struct_unit(level, unit, ...) log_struct(level, getpid() == 1 ? "UNIT=%s" : "USER_UNIT=%s", unit, __VA_ARGS__)