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"
122 /* Keeps tracks of references to a unit. This is useful so
123 * that we can merge two units if necessary and correct all
124 * references to them */
127 LIST_FIELDS(UnitRef, refs);
134 UnitLoadState load_state;
137 char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
141 Set *dependencies[_UNIT_DEPENDENCY_MAX];
143 char **requires_mounts_for;
146 char **documentation;
148 char *fragment_path; /* if loaded from a config file this is the primary path to it */
149 char *source_path; /* if converted, the source file */
151 usec_t fragment_mtime;
155 /* If there is something to do with this unit, then this is the installed job for it */
158 /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
163 /* References to this */
164 LIST_HEAD(UnitRef, refs);
166 /* Conditions to check */
167 LIST_HEAD(Condition, conditions);
169 dual_timestamp condition_timestamp;
171 dual_timestamp inactive_exit_timestamp;
172 dual_timestamp active_enter_timestamp;
173 dual_timestamp active_exit_timestamp;
174 dual_timestamp inactive_enter_timestamp;
176 /* Counterparts in the cgroup filesystem */
177 CGroupBonding *cgroup_bondings;
178 CGroupAttribute *cgroup_attributes;
183 LIST_FIELDS(Unit, units_by_type);
185 /* All units which have requires_mounts_for set */
186 LIST_FIELDS(Unit, has_requires_mounts_for);
189 LIST_FIELDS(Unit, load_queue);
192 LIST_FIELDS(Unit, dbus_queue);
195 LIST_FIELDS(Unit, cleanup_queue);
198 LIST_FIELDS(Unit, gc_queue);
200 /* Used during GC sweeps */
203 /* When deserializing, temporarily store the job type for this
204 * unit here, if there was a job scheduled.
205 * Only for deserializing from a legacy version. New style uses full
206 * serialized jobs. */
207 int deserialized_job; /* This is actually of type JobType */
209 /* Error code when we didn't manage to load the unit (negative) */
212 /* Cached unit file state */
213 UnitFileState unit_file_state;
215 /* Garbage collect us we nobody wants or requires us anymore */
216 bool stop_when_unneeded;
218 /* Create default dependencies */
219 bool default_dependencies;
221 /* Refuse manual starting, allow starting only indirectly via dependency. */
222 bool refuse_manual_start;
224 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
225 bool refuse_manual_stop;
227 /* Allow isolation requests */
230 /* Isolate OnFailure unit */
231 bool on_failure_isolate;
233 /* Ignore this unit when isolating */
234 bool ignore_on_isolate;
236 /* Ignore this unit when snapshotting */
237 bool ignore_on_snapshot;
239 /* Did the last condition check succeed? */
240 bool condition_result;
242 bool in_load_queue:1;
243 bool in_dbus_queue:1;
244 bool in_cleanup_queue:1;
247 bool sent_dbus_new_signal:1;
254 struct UnitStatusMessageFormats {
255 const char *starting_stopping[2];
256 const char *finished_start_job[_JOB_RESULT_MAX];
257 const char *finished_stop_job[_JOB_RESULT_MAX];
266 #include "automount.h"
267 #include "snapshot.h"
273 /* How much memory does an object of this unit type need */
276 /* If greater than 0, the offset into the object where
277 * ExecContext is found, if the unit type has that */
278 size_t exec_context_offset;
280 /* The name of the section with the exec settings of ExecContext */
281 const char *exec_section;
283 /* Config file sections this unit type understands, separated
285 const char *sections;
287 /* This should reset all type-specific variables. This should
288 * not allocate memory, and is called with zero-initialized
289 * data. It should hence only initialize variables that need
291 void (*init)(Unit *u);
293 /* This should free all type-specific variables. It should be
295 void (*done)(Unit *u);
297 /* Actually load data from disk. This may fail, and should set
298 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
299 * UNIT_STUB if no configuration could be found. */
300 int (*load)(Unit *u);
302 /* If a lot of units got created via enumerate(), this is
303 * where to actually set the state and call unit_notify(). */
304 int (*coldplug)(Unit *u);
306 void (*dump)(Unit *u, FILE *f, const char *prefix);
308 int (*start)(Unit *u);
309 int (*stop)(Unit *u);
310 int (*reload)(Unit *u);
312 int (*kill)(Unit *u, KillWho w, int signo, DBusError *error);
314 bool (*can_reload)(Unit *u);
316 /* Write all data that cannot be restored from other sources
317 * away using unit_serialize_item() */
318 int (*serialize)(Unit *u, FILE *f, FDSet *fds);
320 /* Restore one item from the serialization */
321 int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
323 /* Try to match up fds with what we need for this unit */
324 int (*distribute_fds)(Unit *u, FDSet *fds);
326 /* Boils down the more complex internal state of this unit to
327 * a simpler one that the engine can understand */
328 UnitActiveState (*active_state)(Unit *u);
330 /* Returns the substate specific to this unit type as
331 * string. This is purely information so that we can give the
332 * user a more fine grained explanation in which actual state a
334 const char* (*sub_state_to_string)(Unit *u);
336 /* Return true when there is reason to keep this entry around
337 * even nothing references it and it isn't active in any
339 bool (*check_gc)(Unit *u);
341 /* Return true when this unit is suitable for snapshotting */
342 bool (*check_snapshot)(Unit *u);
344 void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
345 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
346 void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
348 /* Reset failed state if we are in failed state */
349 void (*reset_failed)(Unit *u);
351 /* Called whenever any of the cgroups this unit watches for
353 void (*cgroup_notify_empty)(Unit *u);
355 /* Called whenever a process of this unit sends us a message */
356 void (*notify_message)(Unit *u, pid_t pid, char **tags);
358 /* Called whenever a name this Unit registered for comes or
360 void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
362 /* Called whenever a bus PID lookup finishes */
363 void (*bus_query_pid_done)(Unit *u, const char *name, pid_t pid);
365 /* Called for each message received on the bus */
366 DBusHandlerResult (*bus_message_handler)(Unit *u, DBusConnection *c, DBusMessage *message);
368 /* Return the unit this unit is following */
369 Unit *(*following)(Unit *u);
371 /* Return the set of units that are following each other */
372 int (*following_set)(Unit *u, Set **s);
374 /* Invoked each time a unit this unit is triggering changes
375 * state or gains/loses a job */
376 void (*trigger_notify)(Unit *u, Unit *trigger);
378 /* Called whenever CLOCK_REALTIME made a jump */
379 void (*time_change)(Unit *u);
381 /* This is called for each unit type and should be used to
382 * enumerate existing devices and load them. However,
383 * everything that is loaded here should still stay in
384 * inactive state. It is the job of the coldplug() call above
385 * to put the units into the initial state. */
386 int (*enumerate)(Manager *m);
388 /* Type specific cleanups. */
389 void (*shutdown)(Manager *m);
391 /* When sending out PropertiesChanged signal, which properties
392 * shall be invalidated? This is a NUL separated list of
393 * strings, to minimize relocations a little. */
394 const char *bus_invalidating_properties;
396 /* The interface name */
397 const char *bus_interface;
399 UnitStatusMessageFormats status_message_formats;
401 /* Can units of this type have multiple names? */
404 /* Instances make no sense for this type */
407 /* Exclude from automatic gc */
411 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
413 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
415 /* For casting a unit into the various unit types */
416 #define DEFINE_CAST(UPPERCASE, MixedCase) \
417 static inline MixedCase* UPPERCASE(Unit *u) { \
418 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
421 return (MixedCase*) u; \
424 /* For casting the various unit types into a unit */
425 #define UNIT(u) (&(u)->meta)
427 #define UNIT_TRIGGER(u) ((Unit*) set_first((u)->dependencies[UNIT_TRIGGERS]))
429 DEFINE_CAST(SOCKET, Socket);
430 DEFINE_CAST(TIMER, Timer);
431 DEFINE_CAST(SERVICE, Service);
432 DEFINE_CAST(TARGET, Target);
433 DEFINE_CAST(DEVICE, Device);
434 DEFINE_CAST(MOUNT, Mount);
435 DEFINE_CAST(AUTOMOUNT, Automount);
436 DEFINE_CAST(SNAPSHOT, Snapshot);
437 DEFINE_CAST(SWAP, Swap);
438 DEFINE_CAST(PATH, Path);
439 DEFINE_CAST(SLICE, Slice);
441 Unit *unit_new(Manager *m, size_t size);
442 void unit_free(Unit *u);
444 int unit_add_name(Unit *u, const char *name);
446 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
447 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
449 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
450 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
452 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
453 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
455 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
457 int unit_add_cgroup_from_text(Unit *u, const char *name, bool overwrite, CGroupBonding **ret);
458 int unit_add_default_cgroups(Unit *u);
459 CGroupBonding* unit_get_default_cgroup(Unit *u);
460 int unit_add_cgroup_attribute(Unit *u, const CGroupSemantics *semantics, const char *controller, const char *name, const char *value, CGroupAttribute **ret);
462 int unit_choose_id(Unit *u, const char *name);
463 int unit_set_description(Unit *u, const char *description);
465 bool unit_check_gc(Unit *u);
467 void unit_add_to_load_queue(Unit *u);
468 void unit_add_to_dbus_queue(Unit *u);
469 void unit_add_to_cleanup_queue(Unit *u);
470 void unit_add_to_gc_queue(Unit *u);
472 int unit_merge(Unit *u, Unit *other);
473 int unit_merge_by_name(Unit *u, const char *other);
475 Unit *unit_follow_merge(Unit *u) _pure_;
477 int unit_load_fragment_and_dropin(Unit *u);
478 int unit_load_fragment_and_dropin_optional(Unit *u);
479 int unit_load(Unit *unit);
481 int unit_add_default_slice(Unit *u);
483 const char *unit_description(Unit *u) _pure_;
485 bool unit_has_name(Unit *u, const char *name);
487 UnitActiveState unit_active_state(Unit *u);
489 const char* unit_sub_state_to_string(Unit *u);
491 void unit_dump(Unit *u, FILE *f, const char *prefix);
493 bool unit_can_reload(Unit *u) _pure_;
494 bool unit_can_start(Unit *u) _pure_;
495 bool unit_can_isolate(Unit *u) _pure_;
497 int unit_start(Unit *u);
498 int unit_stop(Unit *u);
499 int unit_reload(Unit *u);
501 int unit_kill(Unit *u, KillWho w, int signo, DBusError *error);
502 int unit_kill_common(Unit *u, KillWho who, int signo, pid_t main_pid, pid_t control_pid, DBusError *error);
504 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
506 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
507 void unit_unwatch_fd(Unit *u, Watch *w);
509 int unit_watch_pid(Unit *u, pid_t pid);
510 void unit_unwatch_pid(Unit *u, pid_t pid);
512 int unit_watch_timer(Unit *u, clockid_t, bool relative, usec_t usec, Watch *w);
513 void unit_unwatch_timer(Unit *u, Watch *w);
515 int unit_watch_bus_name(Unit *u, const char *name);
516 void unit_unwatch_bus_name(Unit *u, const char *name);
518 bool unit_job_is_applicable(Unit *u, JobType j);
520 int set_unit_path(const char *p);
522 char *unit_dbus_path(Unit *u);
524 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
525 int unit_get_related_unit(Unit *u, const char *type, Unit **_found);
527 bool unit_can_serialize(Unit *u) _pure_;
528 int unit_serialize(Unit *u, FILE *f, FDSet *fds, bool serialize_jobs);
529 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_attr_(4,5);
530 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
531 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
533 int unit_add_node_link(Unit *u, const char *what, bool wants);
535 int unit_coldplug(Unit *u);
537 void unit_status_printf(Unit *u, const char *status, const char *unit_status_msg_format) _printf_attr_(3, 0);
539 bool unit_need_daemon_reload(Unit *u);
541 void unit_reset_failed(Unit *u);
543 Unit *unit_following(Unit *u);
545 const char *unit_slice_name(Unit *u);
547 bool unit_stop_pending(Unit *u) _pure_;
548 bool unit_inactive_or_pending(Unit *u) _pure_;
549 bool unit_active_or_pending(Unit *u);
551 int unit_add_default_target_dependency(Unit *u, Unit *target);
553 char *unit_default_cgroup_path(Unit *u);
555 int unit_following_set(Unit *u, Set **s);
557 void unit_start_on_failure(Unit *u);
558 void unit_trigger_notify(Unit *u);
560 bool unit_condition_test(Unit *u);
562 UnitFileState unit_get_unit_file_state(Unit *u);
564 Unit* unit_ref_set(UnitRef *ref, Unit *u);
565 void unit_ref_unset(UnitRef *ref);
567 #define UNIT_DEREF(ref) ((ref).unit)
568 #define UNIT_ISSET(ref) (!!(ref).unit)
570 int unit_add_one_mount_link(Unit *u, Mount *m);
571 int unit_add_mount_links(Unit *u);
573 int unit_exec_context_defaults(Unit *u, ExecContext *c);
575 ExecContext *unit_get_exec_context(Unit *u) _pure_;
577 int unit_write_drop_in(Unit *u, bool runtime, const char *name, const char *data);
578 int unit_remove_drop_in(Unit *u, bool runtime, const char *name);
580 int unit_kill_context(Unit *u, KillContext *c, bool sigkill, pid_t main_pid, pid_t control_pid, bool main_pid_alien);
582 const char *unit_active_state_to_string(UnitActiveState i) _const_;
583 UnitActiveState unit_active_state_from_string(const char *s) _pure_;
585 const char *unit_dependency_to_string(UnitDependency i) _const_;
586 UnitDependency unit_dependency_from_string(const char *s) _pure_;
588 /* Macros which append UNIT= or USER_UNIT= to the message */
590 #define log_full_unit(level, unit, ...) log_meta_object(level, __FILE__, __LINE__, __func__, getpid() == 1 ? "UNIT=" : "USER_UNIT=", unit, __VA_ARGS__)
591 #define log_debug_unit(unit, ...) log_full_unit(LOG_DEBUG, unit, __VA_ARGS__)
592 #define log_info_unit(unit, ...) log_full_unit(LOG_INFO, unit, __VA_ARGS__)
593 #define log_notice_unit(unit, ...) log_full_unit(LOG_NOTICE, unit, __VA_ARGS__)
594 #define log_warning_unit(unit, ...) log_full_unit(LOG_WARNING, unit, __VA_ARGS__)
595 #define log_error_unit(unit, ...) log_full_unit(LOG_ERR, unit, __VA_ARGS__)
597 #define log_struct_unit(level, unit, ...) log_struct(level, getpid() == 1 ? "UNIT=%s" : "USER_UNIT=%s", unit, __VA_ARGS__)