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"
43 #include "cgroup-semantics.h"
45 enum UnitActiveState {
52 _UNIT_ACTIVE_STATE_MAX,
53 _UNIT_ACTIVE_STATE_INVALID = -1
56 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) {
57 return t == UNIT_ACTIVE || t == UNIT_RELOADING;
60 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) {
61 return t == UNIT_ACTIVE || t == UNIT_ACTIVATING || t == UNIT_RELOADING;
64 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) {
65 return t == UNIT_INACTIVE || t == UNIT_FAILED || t == UNIT_DEACTIVATING;
68 static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t) {
69 return t == UNIT_INACTIVE || t == UNIT_FAILED;
73 /* Positive dependencies */
75 UNIT_REQUIRES_OVERRIDABLE,
77 UNIT_REQUISITE_OVERRIDABLE,
82 /* Inverse of the above */
83 UNIT_REQUIRED_BY, /* inverse of 'requires' and 'requisite' is 'required_by' */
84 UNIT_REQUIRED_BY_OVERRIDABLE, /* inverse of 'requires_overridable' and 'requisite_overridable' is 'soft_required_by' */
85 UNIT_WANTED_BY, /* inverse of 'wants' */
86 UNIT_BOUND_BY, /* inverse of 'binds_to' */
87 UNIT_CONSISTS_OF, /* inverse of 'part_of' */
89 /* Negative dependencies */
90 UNIT_CONFLICTS, /* inverse of 'conflicts' is 'conflicted_by' */
94 UNIT_BEFORE, /* inverse of 'before' is 'after' and vice versa */
100 /* Triggers (i.e. a socket triggers a service) */
104 /* Propagate reloads */
105 UNIT_PROPAGATES_RELOAD_TO,
106 UNIT_RELOAD_PROPAGATED_FROM,
108 /* Reference information for GC logic */
109 UNIT_REFERENCES, /* Inverse of 'references' is 'referenced_by' */
112 _UNIT_DEPENDENCY_MAX,
113 _UNIT_DEPENDENCY_INVALID = -1
119 #include "cgroup-attr.h"
125 UnitLoadState load_state;
128 char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
132 Set *dependencies[_UNIT_DEPENDENCY_MAX];
134 char **requires_mounts_for;
137 char **documentation;
139 char *fragment_path; /* if loaded from a config file this is the primary path to it */
140 char *source_path; /* if converted, the source file */
141 usec_t fragment_mtime;
144 /* If there is something to do with this unit, then this is the installed job for it */
147 /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
152 /* References to this */
153 LIST_HEAD(UnitRef, refs);
155 /* Conditions to check */
156 LIST_HEAD(Condition, conditions);
158 dual_timestamp condition_timestamp;
160 dual_timestamp inactive_exit_timestamp;
161 dual_timestamp active_enter_timestamp;
162 dual_timestamp active_exit_timestamp;
163 dual_timestamp inactive_enter_timestamp;
165 /* Counterparts in the cgroup filesystem */
166 CGroupBonding *cgroup_bondings;
167 CGroupAttribute *cgroup_attributes;
170 LIST_FIELDS(Unit, units_by_type);
172 /* All units which have requires_mounts_for set */
173 LIST_FIELDS(Unit, has_requires_mounts_for);
176 LIST_FIELDS(Unit, load_queue);
179 LIST_FIELDS(Unit, dbus_queue);
182 LIST_FIELDS(Unit, cleanup_queue);
185 LIST_FIELDS(Unit, gc_queue);
187 /* Used during GC sweeps */
190 /* When deserializing, temporarily store the job type for this
191 * unit here, if there was a job scheduled.
192 * Only for deserializing from a legacy version. New style uses full
193 * serialized jobs. */
194 int deserialized_job; /* This is actually of type JobType */
196 /* Error code when we didn't manage to load the unit (negative) */
199 /* Cached unit file state */
200 UnitFileState unit_file_state;
202 /* Garbage collect us we nobody wants or requires us anymore */
203 bool stop_when_unneeded;
205 /* Create default dependencies */
206 bool default_dependencies;
208 /* Refuse manual starting, allow starting only indirectly via dependency. */
209 bool refuse_manual_start;
211 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
212 bool refuse_manual_stop;
214 /* Allow isolation requests */
217 /* Isolate OnFailure unit */
218 bool on_failure_isolate;
220 /* Ignore this unit when isolating */
221 bool ignore_on_isolate;
223 /* Ignore this unit when snapshotting */
224 bool ignore_on_snapshot;
226 /* Did the last condition check succeed? */
227 bool condition_result;
229 bool in_load_queue:1;
230 bool in_dbus_queue:1;
231 bool in_cleanup_queue:1;
234 bool sent_dbus_new_signal:1;
242 /* Keeps tracks of references to a unit. This is useful so
243 * that we can merge two units if necessary and correct all
244 * references to them */
247 LIST_FIELDS(UnitRef, refs);
250 struct UnitStatusMessageFormats {
251 const char *starting_stopping[2];
252 const char *finished_start_job[_JOB_RESULT_MAX];
253 const char *finished_stop_job[_JOB_RESULT_MAX];
262 #include "automount.h"
263 #include "snapshot.h"
268 /* How much memory does an object of this unit type need */
271 /* If greater than 0, the offset into the object where
272 * ExecContext is found, if the unit type has that */
273 size_t exec_context_offset;
275 /* The name of the section with the exec settings of ExecContext */
276 const char *exec_section;
278 /* Config file sections this unit type understands, separated
280 const char *sections;
282 /* This should reset all type-specific variables. This should
283 * not allocate memory, and is called with zero-initialized
284 * data. It should hence only initialize variables that need
286 void (*init)(Unit *u);
288 /* This should free all type-specific variables. It should be
290 void (*done)(Unit *u);
292 /* Actually load data from disk. This may fail, and should set
293 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
294 * UNIT_STUB if no configuration could be found. */
295 int (*load)(Unit *u);
297 /* If a lot of units got created via enumerate(), this is
298 * where to actually set the state and call unit_notify(). */
299 int (*coldplug)(Unit *u);
301 void (*dump)(Unit *u, FILE *f, const char *prefix);
303 int (*start)(Unit *u);
304 int (*stop)(Unit *u);
305 int (*reload)(Unit *u);
307 int (*kill)(Unit *u, KillWho w, int signo, DBusError *error);
309 bool (*can_reload)(Unit *u);
311 /* Write all data that cannot be restored from other sources
312 * away using unit_serialize_item() */
313 int (*serialize)(Unit *u, FILE *f, FDSet *fds);
315 /* Restore one item from the serialization */
316 int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
318 /* Try to match up fds with what we need for this unit */
319 int (*distribute_fds)(Unit *u, FDSet *fds);
321 /* Boils down the more complex internal state of this unit to
322 * a simpler one that the engine can understand */
323 UnitActiveState (*active_state)(Unit *u);
325 /* Returns the substate specific to this unit type as
326 * string. This is purely information so that we can give the
327 * user a more fine grained explanation in which actual state a
329 const char* (*sub_state_to_string)(Unit *u);
331 /* Return true when there is reason to keep this entry around
332 * even nothing references it and it isn't active in any
334 bool (*check_gc)(Unit *u);
336 /* Return true when this unit is suitable for snapshotting */
337 bool (*check_snapshot)(Unit *u);
339 void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
340 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
341 void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
343 /* Reset failed state if we are in failed state */
344 void (*reset_failed)(Unit *u);
346 /* Called whenever any of the cgroups this unit watches for
348 void (*cgroup_notify_empty)(Unit *u);
350 /* Called whenever a process of this unit sends us a message */
351 void (*notify_message)(Unit *u, pid_t pid, char **tags);
353 /* Called whenever a name thus Unit registered for comes or
355 void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
357 /* Called whenever a bus PID lookup finishes */
358 void (*bus_query_pid_done)(Unit *u, const char *name, pid_t pid);
360 /* Called for each message received on the bus */
361 DBusHandlerResult (*bus_message_handler)(Unit *u, DBusConnection *c, DBusMessage *message);
363 /* Return the unit this unit is following */
364 Unit *(*following)(Unit *u);
366 /* Return the set of units that are following each other */
367 int (*following_set)(Unit *u, Set **s);
369 /* Called whenever CLOCK_REALTIME made a jump */
370 void (*time_change)(Unit *u);
372 /* This is called for each unit type and should be used to
373 * enumerate existing devices and load them. However,
374 * everything that is loaded here should still stay in
375 * inactive state. It is the job of the coldplug() call above
376 * to put the units into the initial state. */
377 int (*enumerate)(Manager *m);
379 /* Type specific cleanups. */
380 void (*shutdown)(Manager *m);
382 /* When sending out PropertiesChanged signal, which properties
383 * shall be invalidated? This is a NUL separated list of
384 * strings, to minimize relocations a little. */
385 const char *bus_invalidating_properties;
387 /* The interface name */
388 const char *bus_interface;
390 UnitStatusMessageFormats status_message_formats;
392 /* Can units of this type have multiple names? */
395 /* Instances make no sense for this type */
398 /* Exclude from automatic gc */
402 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
404 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
406 /* For casting a unit into the various unit types */
407 #define DEFINE_CAST(UPPERCASE, MixedCase) \
408 static inline MixedCase* UPPERCASE(Unit *u) { \
409 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
412 return (MixedCase*) u; \
415 /* For casting the various unit types into a unit */
416 #define UNIT(u) (&(u)->meta)
418 DEFINE_CAST(SOCKET, Socket);
419 DEFINE_CAST(TIMER, Timer);
420 DEFINE_CAST(SERVICE, Service);
421 DEFINE_CAST(TARGET, Target);
422 DEFINE_CAST(DEVICE, Device);
423 DEFINE_CAST(MOUNT, Mount);
424 DEFINE_CAST(AUTOMOUNT, Automount);
425 DEFINE_CAST(SNAPSHOT, Snapshot);
426 DEFINE_CAST(SWAP, Swap);
427 DEFINE_CAST(PATH, Path);
429 Unit *unit_new(Manager *m, size_t size);
430 void unit_free(Unit *u);
432 int unit_add_name(Unit *u, const char *name);
434 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
435 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
437 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
438 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
440 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
441 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
443 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
445 int unit_add_cgroup(Unit *u, CGroupBonding *b);
446 int unit_add_cgroup_from_text(Unit *u, const char *name, bool overwrite, CGroupBonding **ret);
447 int unit_add_default_cgroups(Unit *u);
448 CGroupBonding* unit_get_default_cgroup(Unit *u);
449 int unit_add_cgroup_attribute(Unit *u, const CGroupSemantics *semantics, const char *controller, const char *name, const char *value, CGroupAttribute **ret);
451 int unit_choose_id(Unit *u, const char *name);
452 int unit_set_description(Unit *u, const char *description);
454 bool unit_check_gc(Unit *u);
456 void unit_add_to_load_queue(Unit *u);
457 void unit_add_to_dbus_queue(Unit *u);
458 void unit_add_to_cleanup_queue(Unit *u);
459 void unit_add_to_gc_queue(Unit *u);
461 int unit_merge(Unit *u, Unit *other);
462 int unit_merge_by_name(Unit *u, const char *other);
464 Unit *unit_follow_merge(Unit *u);
466 int unit_load_fragment_and_dropin(Unit *u);
467 int unit_load_fragment_and_dropin_optional(Unit *u);
468 int unit_load(Unit *unit);
470 const char *unit_description(Unit *u);
472 bool unit_has_name(Unit *u, const char *name);
474 UnitActiveState unit_active_state(Unit *u);
476 const char* unit_sub_state_to_string(Unit *u);
478 void unit_dump(Unit *u, FILE *f, const char *prefix);
480 bool unit_can_reload(Unit *u);
481 bool unit_can_start(Unit *u);
482 bool unit_can_isolate(Unit *u);
484 int unit_start(Unit *u);
485 int unit_stop(Unit *u);
486 int unit_reload(Unit *u);
488 int unit_kill(Unit *u, KillWho w, int signo, DBusError *error);
489 int unit_kill_common(Unit *u, KillWho who, int signo, pid_t main_pid, pid_t control_pid, DBusError *error);
491 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
493 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
494 void unit_unwatch_fd(Unit *u, Watch *w);
496 int unit_watch_pid(Unit *u, pid_t pid);
497 void unit_unwatch_pid(Unit *u, pid_t pid);
499 int unit_watch_timer(Unit *u, clockid_t, bool relative, usec_t usec, Watch *w);
500 void unit_unwatch_timer(Unit *u, Watch *w);
502 int unit_watch_bus_name(Unit *u, const char *name);
503 void unit_unwatch_bus_name(Unit *u, const char *name);
505 bool unit_job_is_applicable(Unit *u, JobType j);
507 int set_unit_path(const char *p);
509 char *unit_dbus_path(Unit *u);
511 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
512 int unit_get_related_unit(Unit *u, const char *type, Unit **_found);
514 bool unit_can_serialize(Unit *u);
515 int unit_serialize(Unit *u, FILE *f, FDSet *fds, bool serialize_jobs);
516 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_attr_(4,5);
517 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
518 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
520 int unit_add_node_link(Unit *u, const char *what, bool wants);
522 int unit_coldplug(Unit *u);
524 void unit_status_printf(Unit *u, const char *status, const char *unit_status_msg_format);
526 bool unit_need_daemon_reload(Unit *u);
528 void unit_reset_failed(Unit *u);
530 Unit *unit_following(Unit *u);
532 bool unit_pending_inactive(Unit *u);
533 bool unit_pending_active(Unit *u);
535 int unit_add_default_target_dependency(Unit *u, Unit *target);
537 char *unit_default_cgroup_path(Unit *u);
539 int unit_following_set(Unit *u, Set **s);
541 void unit_trigger_on_failure(Unit *u);
543 bool unit_condition_test(Unit *u);
545 UnitFileState unit_get_unit_file_state(Unit *u);
547 Unit* unit_ref_set(UnitRef *ref, Unit *u);
548 void unit_ref_unset(UnitRef *ref);
550 #define UNIT_DEREF(ref) ((ref).unit)
552 int unit_add_one_mount_link(Unit *u, Mount *m);
553 int unit_add_mount_links(Unit *u);
555 int unit_exec_context_defaults(Unit *u, ExecContext *c);
557 ExecContext *unit_get_exec_context(Unit *u);
559 int unit_write_drop_in(Unit *u, bool runtime, const char *name, const char *data);
560 int unit_remove_drop_in(Unit *u, bool runtime, const char *name);
562 int unit_kill_context(Unit *u, KillContext *c, bool sigkill, pid_t main_pid, pid_t control_pid, bool main_pid_alien);
564 const char *unit_active_state_to_string(UnitActiveState i);
565 UnitActiveState unit_active_state_from_string(const char *s);
567 const char *unit_dependency_to_string(UnitDependency i);
568 UnitDependency unit_dependency_from_string(const char *s);
570 #define log_full_unit(level, unit, ...) log_meta_object(level, __FILE__, __LINE__, __func__, getpid() == 1 ? "UNIT=" : "USER_UNIT=", unit, __VA_ARGS__)
571 #define log_debug_unit(unit, ...) log_full_unit(LOG_DEBUG, unit, __VA_ARGS__)
572 #define log_info_unit(unit, ...) log_full_unit(LOG_INFO, unit, __VA_ARGS__)
573 #define log_notice_unit(unit, ...) log_full_unit(LOG_NOTICE, unit, __VA_ARGS__)
574 #define log_warning_unit(unit, ...) log_full_unit(LOG_WARNING, unit, __VA_ARGS__)
575 #define log_error_unit(unit, ...) log_full_unit(LOG_ERR, unit, __VA_ARGS__)
577 #define log_struct_unit(level, unit, ...) log_struct(level, getpid() == 1 ? "UNIT=%s" : "USER_UNIT=%s", unit, __VA_ARGS__)