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 */
142 usec_t fragment_mtime;
146 /* If there is something to do with this unit, then this is the installed job for it */
149 /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
154 /* References to this */
155 LIST_HEAD(UnitRef, refs);
157 /* Conditions to check */
158 LIST_HEAD(Condition, conditions);
160 dual_timestamp condition_timestamp;
162 dual_timestamp inactive_exit_timestamp;
163 dual_timestamp active_enter_timestamp;
164 dual_timestamp active_exit_timestamp;
165 dual_timestamp inactive_enter_timestamp;
167 /* Counterparts in the cgroup filesystem */
168 CGroupBonding *cgroup_bondings;
169 CGroupAttribute *cgroup_attributes;
172 LIST_FIELDS(Unit, units_by_type);
174 /* All units which have requires_mounts_for set */
175 LIST_FIELDS(Unit, has_requires_mounts_for);
178 LIST_FIELDS(Unit, load_queue);
181 LIST_FIELDS(Unit, dbus_queue);
184 LIST_FIELDS(Unit, cleanup_queue);
187 LIST_FIELDS(Unit, gc_queue);
189 /* Used during GC sweeps */
192 /* When deserializing, temporarily store the job type for this
193 * unit here, if there was a job scheduled.
194 * Only for deserializing from a legacy version. New style uses full
195 * serialized jobs. */
196 int deserialized_job; /* This is actually of type JobType */
198 /* Error code when we didn't manage to load the unit (negative) */
201 /* Cached unit file state */
202 UnitFileState unit_file_state;
204 /* Garbage collect us we nobody wants or requires us anymore */
205 bool stop_when_unneeded;
207 /* Create default dependencies */
208 bool default_dependencies;
210 /* Refuse manual starting, allow starting only indirectly via dependency. */
211 bool refuse_manual_start;
213 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
214 bool refuse_manual_stop;
216 /* Allow isolation requests */
219 /* Isolate OnFailure unit */
220 bool on_failure_isolate;
222 /* Ignore this unit when isolating */
223 bool ignore_on_isolate;
225 /* Ignore this unit when snapshotting */
226 bool ignore_on_snapshot;
228 /* Did the last condition check succeed? */
229 bool condition_result;
231 bool in_load_queue:1;
232 bool in_dbus_queue:1;
233 bool in_cleanup_queue:1;
236 bool sent_dbus_new_signal:1;
244 /* Keeps tracks of references to a unit. This is useful so
245 * that we can merge two units if necessary and correct all
246 * references to them */
249 LIST_FIELDS(UnitRef, refs);
252 struct UnitStatusMessageFormats {
253 const char *starting_stopping[2];
254 const char *finished_start_job[_JOB_RESULT_MAX];
255 const char *finished_stop_job[_JOB_RESULT_MAX];
264 #include "automount.h"
265 #include "snapshot.h"
270 /* How much memory does an object of this unit type need */
273 /* If greater than 0, the offset into the object where
274 * ExecContext is found, if the unit type has that */
275 size_t exec_context_offset;
277 /* The name of the section with the exec settings of ExecContext */
278 const char *exec_section;
280 /* Config file sections this unit type understands, separated
282 const char *sections;
284 /* This should reset all type-specific variables. This should
285 * not allocate memory, and is called with zero-initialized
286 * data. It should hence only initialize variables that need
288 void (*init)(Unit *u);
290 /* This should free all type-specific variables. It should be
292 void (*done)(Unit *u);
294 /* Actually load data from disk. This may fail, and should set
295 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
296 * UNIT_STUB if no configuration could be found. */
297 int (*load)(Unit *u);
299 /* If a lot of units got created via enumerate(), this is
300 * where to actually set the state and call unit_notify(). */
301 int (*coldplug)(Unit *u);
303 void (*dump)(Unit *u, FILE *f, const char *prefix);
305 int (*start)(Unit *u);
306 int (*stop)(Unit *u);
307 int (*reload)(Unit *u);
309 int (*kill)(Unit *u, KillWho w, int signo, DBusError *error);
311 bool (*can_reload)(Unit *u);
313 /* Write all data that cannot be restored from other sources
314 * away using unit_serialize_item() */
315 int (*serialize)(Unit *u, FILE *f, FDSet *fds);
317 /* Restore one item from the serialization */
318 int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
320 /* Try to match up fds with what we need for this unit */
321 int (*distribute_fds)(Unit *u, FDSet *fds);
323 /* Boils down the more complex internal state of this unit to
324 * a simpler one that the engine can understand */
325 UnitActiveState (*active_state)(Unit *u);
327 /* Returns the substate specific to this unit type as
328 * string. This is purely information so that we can give the
329 * user a more fine grained explanation in which actual state a
331 const char* (*sub_state_to_string)(Unit *u);
333 /* Return true when there is reason to keep this entry around
334 * even nothing references it and it isn't active in any
336 bool (*check_gc)(Unit *u);
338 /* Return true when this unit is suitable for snapshotting */
339 bool (*check_snapshot)(Unit *u);
341 void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
342 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
343 void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
345 /* Reset failed state if we are in failed state */
346 void (*reset_failed)(Unit *u);
348 /* Called whenever any of the cgroups this unit watches for
350 void (*cgroup_notify_empty)(Unit *u);
352 /* Called whenever a process of this unit sends us a message */
353 void (*notify_message)(Unit *u, pid_t pid, char **tags);
355 /* Called whenever a name this Unit registered for comes or
357 void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
359 /* Called whenever a bus PID lookup finishes */
360 void (*bus_query_pid_done)(Unit *u, const char *name, pid_t pid);
362 /* Called for each message received on the bus */
363 DBusHandlerResult (*bus_message_handler)(Unit *u, DBusConnection *c, DBusMessage *message);
365 /* Return the unit this unit is following */
366 Unit *(*following)(Unit *u);
368 /* Return the set of units that are following each other */
369 int (*following_set)(Unit *u, Set **s);
371 /* Invoked each time a unit this unit is triggering changes
372 * state or gains/loses a job */
373 void (*trigger_notify)(Unit *u, Unit *trigger);
375 /* Called whenever CLOCK_REALTIME made a jump */
376 void (*time_change)(Unit *u);
378 /* This is called for each unit type and should be used to
379 * enumerate existing devices and load them. However,
380 * everything that is loaded here should still stay in
381 * inactive state. It is the job of the coldplug() call above
382 * to put the units into the initial state. */
383 int (*enumerate)(Manager *m);
385 /* Type specific cleanups. */
386 void (*shutdown)(Manager *m);
388 /* When sending out PropertiesChanged signal, which properties
389 * shall be invalidated? This is a NUL separated list of
390 * strings, to minimize relocations a little. */
391 const char *bus_invalidating_properties;
393 /* The interface name */
394 const char *bus_interface;
396 UnitStatusMessageFormats status_message_formats;
398 /* Can units of this type have multiple names? */
401 /* Instances make no sense for this type */
404 /* Exclude from automatic gc */
408 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
410 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
412 /* For casting a unit into the various unit types */
413 #define DEFINE_CAST(UPPERCASE, MixedCase) \
414 static inline MixedCase* UPPERCASE(Unit *u) { \
415 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
418 return (MixedCase*) u; \
421 /* For casting the various unit types into a unit */
422 #define UNIT(u) (&(u)->meta)
424 #define UNIT_TRIGGER(u) ((Unit*) set_first((u)->dependencies[UNIT_TRIGGERS]))
426 DEFINE_CAST(SOCKET, Socket);
427 DEFINE_CAST(TIMER, Timer);
428 DEFINE_CAST(SERVICE, Service);
429 DEFINE_CAST(TARGET, Target);
430 DEFINE_CAST(DEVICE, Device);
431 DEFINE_CAST(MOUNT, Mount);
432 DEFINE_CAST(AUTOMOUNT, Automount);
433 DEFINE_CAST(SNAPSHOT, Snapshot);
434 DEFINE_CAST(SWAP, Swap);
435 DEFINE_CAST(PATH, Path);
437 Unit *unit_new(Manager *m, size_t size);
438 void unit_free(Unit *u);
440 int unit_add_name(Unit *u, const char *name);
442 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
443 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
445 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
446 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
448 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
449 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
451 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
453 int unit_add_cgroup(Unit *u, CGroupBonding *b);
454 int unit_add_cgroup_from_text(Unit *u, const char *name, bool overwrite, CGroupBonding **ret);
455 int unit_add_default_cgroups(Unit *u);
456 CGroupBonding* unit_get_default_cgroup(Unit *u);
457 int unit_add_cgroup_attribute(Unit *u, const CGroupSemantics *semantics, const char *controller, const char *name, const char *value, CGroupAttribute **ret);
459 int unit_choose_id(Unit *u, const char *name);
460 int unit_set_description(Unit *u, const char *description);
462 bool unit_check_gc(Unit *u);
464 void unit_add_to_load_queue(Unit *u);
465 void unit_add_to_dbus_queue(Unit *u);
466 void unit_add_to_cleanup_queue(Unit *u);
467 void unit_add_to_gc_queue(Unit *u);
469 int unit_merge(Unit *u, Unit *other);
470 int unit_merge_by_name(Unit *u, const char *other);
472 Unit *unit_follow_merge(Unit *u);
474 int unit_load_fragment_and_dropin(Unit *u);
475 int unit_load_fragment_and_dropin_optional(Unit *u);
476 int unit_load(Unit *unit);
478 const char *unit_description(Unit *u);
480 bool unit_has_name(Unit *u, const char *name);
482 UnitActiveState unit_active_state(Unit *u);
484 const char* unit_sub_state_to_string(Unit *u);
486 void unit_dump(Unit *u, FILE *f, const char *prefix);
488 bool unit_can_reload(Unit *u);
489 bool unit_can_start(Unit *u);
490 bool unit_can_isolate(Unit *u);
492 int unit_start(Unit *u);
493 int unit_stop(Unit *u);
494 int unit_reload(Unit *u);
496 int unit_kill(Unit *u, KillWho w, int signo, DBusError *error);
497 int unit_kill_common(Unit *u, KillWho who, int signo, pid_t main_pid, pid_t control_pid, DBusError *error);
499 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
501 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
502 void unit_unwatch_fd(Unit *u, Watch *w);
504 int unit_watch_pid(Unit *u, pid_t pid);
505 void unit_unwatch_pid(Unit *u, pid_t pid);
507 int unit_watch_timer(Unit *u, clockid_t, bool relative, usec_t usec, Watch *w);
508 void unit_unwatch_timer(Unit *u, Watch *w);
510 int unit_watch_bus_name(Unit *u, const char *name);
511 void unit_unwatch_bus_name(Unit *u, const char *name);
513 bool unit_job_is_applicable(Unit *u, JobType j);
515 int set_unit_path(const char *p);
517 char *unit_dbus_path(Unit *u);
519 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
520 int unit_get_related_unit(Unit *u, const char *type, Unit **_found);
522 bool unit_can_serialize(Unit *u);
523 int unit_serialize(Unit *u, FILE *f, FDSet *fds, bool serialize_jobs);
524 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_attr_(4,5);
525 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
526 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
528 int unit_add_node_link(Unit *u, const char *what, bool wants);
530 int unit_coldplug(Unit *u);
532 void unit_status_printf(Unit *u, const char *status, const char *unit_status_msg_format);
534 bool unit_need_daemon_reload(Unit *u);
536 void unit_reset_failed(Unit *u);
538 Unit *unit_following(Unit *u);
540 bool unit_pending_inactive(Unit *u);
541 bool unit_pending_active(Unit *u);
543 int unit_add_default_target_dependency(Unit *u, Unit *target);
545 char *unit_default_cgroup_path(Unit *u);
547 int unit_following_set(Unit *u, Set **s);
549 void unit_start_on_failure(Unit *u);
550 void unit_trigger_notify(Unit *u);
552 bool unit_condition_test(Unit *u);
554 UnitFileState unit_get_unit_file_state(Unit *u);
556 Unit* unit_ref_set(UnitRef *ref, Unit *u);
557 void unit_ref_unset(UnitRef *ref);
559 #define UNIT_DEREF(ref) ((ref).unit)
561 int unit_add_one_mount_link(Unit *u, Mount *m);
562 int unit_add_mount_links(Unit *u);
564 int unit_exec_context_defaults(Unit *u, ExecContext *c);
566 ExecContext *unit_get_exec_context(Unit *u);
568 int unit_write_drop_in(Unit *u, bool runtime, const char *name, const char *data);
569 int unit_remove_drop_in(Unit *u, bool runtime, const char *name);
571 int unit_kill_context(Unit *u, KillContext *c, bool sigkill, pid_t main_pid, pid_t control_pid, bool main_pid_alien);
573 const char *unit_active_state_to_string(UnitActiveState i);
574 UnitActiveState unit_active_state_from_string(const char *s);
576 const char *unit_dependency_to_string(UnitDependency i);
577 UnitDependency unit_dependency_from_string(const char *s);
579 /* Macros which append UNIT= or USER_UNIT= to the message */
581 #define log_full_unit(level, unit, ...) log_meta_object(level, __FILE__, __LINE__, __func__, getpid() == 1 ? "UNIT=" : "USER_UNIT=", unit, __VA_ARGS__)
582 #define log_debug_unit(unit, ...) log_full_unit(LOG_DEBUG, unit, __VA_ARGS__)
583 #define log_info_unit(unit, ...) log_full_unit(LOG_INFO, unit, __VA_ARGS__)
584 #define log_notice_unit(unit, ...) log_full_unit(LOG_NOTICE, unit, __VA_ARGS__)
585 #define log_warning_unit(unit, ...) log_full_unit(LOG_WARNING, unit, __VA_ARGS__)
586 #define log_error_unit(unit, ...) log_full_unit(LOG_ERR, unit, __VA_ARGS__)
588 #define log_struct_unit(level, unit, ...) log_struct(level, getpid() == 1 ? "UNIT=%s" : "USER_UNIT=%s", unit, __VA_ARGS__)