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"
41 #include "condition.h"
43 #include "unit-name.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
120 /* Keeps tracks of references to a unit. This is useful so
121 * that we can merge two units if necessary and correct all
122 * references to them */
125 LIST_FIELDS(UnitRef, refs);
132 UnitLoadState load_state;
135 char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
139 Set *dependencies[_UNIT_DEPENDENCY_MAX];
141 char **requires_mounts_for;
144 char **documentation;
146 char *fragment_path; /* if loaded from a config file this is the primary path to it */
147 char *source_path; /* if converted, the source file */
149 usec_t fragment_mtime;
153 /* If there is something to do with this unit, then this is the installed job for it */
156 /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
161 /* References to this */
162 LIST_HEAD(UnitRef, refs);
164 /* Conditions to check */
165 LIST_HEAD(Condition, conditions);
167 dual_timestamp condition_timestamp;
169 dual_timestamp inactive_exit_timestamp;
170 dual_timestamp active_enter_timestamp;
171 dual_timestamp active_exit_timestamp;
172 dual_timestamp inactive_enter_timestamp;
174 /* Counterparts in the cgroup filesystem */
176 bool cgroup_realized;
177 CGroupControllerMask cgroup_mask;
182 LIST_FIELDS(Unit, units_by_type);
184 /* All units which have requires_mounts_for set */
185 LIST_FIELDS(Unit, has_requires_mounts_for);
188 LIST_FIELDS(Unit, load_queue);
191 LIST_FIELDS(Unit, dbus_queue);
194 LIST_FIELDS(Unit, cleanup_queue);
197 LIST_FIELDS(Unit, gc_queue);
199 /* CGroup realize members queue */
200 LIST_FIELDS(Unit, cgroup_queue);
202 /* Used during GC sweeps */
205 /* When deserializing, temporarily store the job type for this
206 * unit here, if there was a job scheduled.
207 * Only for deserializing from a legacy version. New style uses full
208 * serialized jobs. */
209 int deserialized_job; /* This is actually of type JobType */
211 /* Error code when we didn't manage to load the unit (negative) */
214 /* Cached unit file state */
215 UnitFileState unit_file_state;
217 /* Garbage collect us we nobody wants or requires us anymore */
218 bool stop_when_unneeded;
220 /* Create default dependencies */
221 bool default_dependencies;
223 /* Refuse manual starting, allow starting only indirectly via dependency. */
224 bool refuse_manual_start;
226 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
227 bool refuse_manual_stop;
229 /* Allow isolation requests */
232 /* Isolate OnFailure unit */
233 bool on_failure_isolate;
235 /* Ignore this unit when isolating */
236 bool ignore_on_isolate;
238 /* Ignore this unit when snapshotting */
239 bool ignore_on_snapshot;
241 /* Did the last condition check succeed? */
242 bool condition_result;
244 bool in_load_queue:1;
245 bool in_dbus_queue:1;
246 bool in_cleanup_queue:1;
248 bool in_cgroup_queue:1;
250 bool sent_dbus_new_signal:1;
257 struct UnitStatusMessageFormats {
258 const char *starting_stopping[2];
259 const char *finished_start_job[_JOB_RESULT_MAX];
260 const char *finished_stop_job[_JOB_RESULT_MAX];
263 typedef enum UnitSetPropertiesMode {
267 } UnitSetPropertiesMode;
275 #include "automount.h"
276 #include "snapshot.h"
282 /* How much memory does an object of this unit type need */
285 /* If greater than 0, the offset into the object where
286 * ExecContext is found, if the unit type has that */
287 size_t exec_context_offset;
289 /* If greater than 0, the offset into the object where
290 * CGroupContext is found, if the unit type has that */
291 size_t cgroup_context_offset;
293 /* The name of the configuration file section with the private settings of this unit*/
294 const char *private_section;
296 /* Config file sections this unit type understands, separated
298 const char *sections;
300 /* This should reset all type-specific variables. This should
301 * not allocate memory, and is called with zero-initialized
302 * data. It should hence only initialize variables that need
304 void (*init)(Unit *u);
306 /* This should free all type-specific variables. It should be
308 void (*done)(Unit *u);
310 /* Actually load data from disk. This may fail, and should set
311 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
312 * UNIT_STUB if no configuration could be found. */
313 int (*load)(Unit *u);
315 /* If a lot of units got created via enumerate(), this is
316 * where to actually set the state and call unit_notify(). */
317 int (*coldplug)(Unit *u);
319 void (*dump)(Unit *u, FILE *f, const char *prefix);
321 int (*start)(Unit *u);
322 int (*stop)(Unit *u);
323 int (*reload)(Unit *u);
325 int (*kill)(Unit *u, KillWho w, int signo, DBusError *error);
327 bool (*can_reload)(Unit *u);
329 /* Write all data that cannot be restored from other sources
330 * away using unit_serialize_item() */
331 int (*serialize)(Unit *u, FILE *f, FDSet *fds);
333 /* Restore one item from the serialization */
334 int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
336 /* Try to match up fds with what we need for this unit */
337 int (*distribute_fds)(Unit *u, FDSet *fds);
339 /* Boils down the more complex internal state of this unit to
340 * a simpler one that the engine can understand */
341 UnitActiveState (*active_state)(Unit *u);
343 /* Returns the substate specific to this unit type as
344 * string. This is purely information so that we can give the
345 * user a more fine grained explanation in which actual state a
347 const char* (*sub_state_to_string)(Unit *u);
349 /* Return true when there is reason to keep this entry around
350 * even nothing references it and it isn't active in any
352 bool (*check_gc)(Unit *u);
354 /* Return true when this unit is suitable for snapshotting */
355 bool (*check_snapshot)(Unit *u);
357 void (*fd_event)(Unit *u, int fd, uint32_t events, Watch *w);
358 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
359 void (*timer_event)(Unit *u, uint64_t n_elapsed, Watch *w);
361 /* Reset failed state if we are in failed state */
362 void (*reset_failed)(Unit *u);
364 /* Called whenever any of the cgroups this unit watches for
366 void (*notify_cgroup_empty)(Unit *u);
368 /* Called whenever a process of this unit sends us a message */
369 void (*notify_message)(Unit *u, pid_t pid, char **tags);
371 /* Called whenever a name this Unit registered for comes or
373 void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
375 /* Called whenever a bus PID lookup finishes */
376 void (*bus_query_pid_done)(Unit *u, const char *name, pid_t pid);
378 /* Called for each message received on the bus */
379 DBusHandlerResult (*bus_message_handler)(Unit *u, DBusConnection *c, DBusMessage *message);
381 /* Called for each property that is being set */
382 int (*bus_set_property)(Unit *u, const char *name, DBusMessageIter *i, UnitSetPropertiesMode mode, DBusError *error);
384 /* Called after at least one property got changed to apply the necessary change */
385 int (*bus_commit_properties)(Unit *u);
387 /* Return the unit this unit is following */
388 Unit *(*following)(Unit *u);
390 /* Return the set of units that are following each other */
391 int (*following_set)(Unit *u, Set **s);
393 /* Invoked each time a unit this unit is triggering changes
394 * state or gains/loses a job */
395 void (*trigger_notify)(Unit *u, Unit *trigger);
397 /* Called whenever CLOCK_REALTIME made a jump */
398 void (*time_change)(Unit *u);
400 /* This is called for each unit type and should be used to
401 * enumerate existing devices and load them. However,
402 * everything that is loaded here should still stay in
403 * inactive state. It is the job of the coldplug() call above
404 * to put the units into the initial state. */
405 int (*enumerate)(Manager *m);
407 /* Type specific cleanups. */
408 void (*shutdown)(Manager *m);
410 /* When sending out PropertiesChanged signal, which properties
411 * shall be invalidated? This is a NUL separated list of
412 * strings, to minimize relocations a little. */
413 const char *bus_invalidating_properties;
415 /* The interface name */
416 const char *bus_interface;
418 UnitStatusMessageFormats status_message_formats;
420 /* Can units of this type have multiple names? */
423 /* Instances make no sense for this type */
426 /* Exclude from automatic gc */
430 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
432 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
434 /* For casting a unit into the various unit types */
435 #define DEFINE_CAST(UPPERCASE, MixedCase) \
436 static inline MixedCase* UPPERCASE(Unit *u) { \
437 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
440 return (MixedCase*) u; \
443 /* For casting the various unit types into a unit */
444 #define UNIT(u) (&(u)->meta)
446 #define UNIT_TRIGGER(u) ((Unit*) set_first((u)->dependencies[UNIT_TRIGGERS]))
448 DEFINE_CAST(SOCKET, Socket);
449 DEFINE_CAST(TIMER, Timer);
450 DEFINE_CAST(SERVICE, Service);
451 DEFINE_CAST(TARGET, Target);
452 DEFINE_CAST(DEVICE, Device);
453 DEFINE_CAST(MOUNT, Mount);
454 DEFINE_CAST(AUTOMOUNT, Automount);
455 DEFINE_CAST(SNAPSHOT, Snapshot);
456 DEFINE_CAST(SWAP, Swap);
457 DEFINE_CAST(PATH, Path);
458 DEFINE_CAST(SLICE, Slice);
460 Unit *unit_new(Manager *m, size_t size);
461 void unit_free(Unit *u);
463 int unit_add_name(Unit *u, const char *name);
465 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
466 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
468 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
469 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
471 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
472 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
474 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
476 int unit_choose_id(Unit *u, const char *name);
477 int unit_set_description(Unit *u, const char *description);
479 bool unit_check_gc(Unit *u);
481 void unit_add_to_load_queue(Unit *u);
482 void unit_add_to_dbus_queue(Unit *u);
483 void unit_add_to_cleanup_queue(Unit *u);
484 void unit_add_to_gc_queue(Unit *u);
486 int unit_merge(Unit *u, Unit *other);
487 int unit_merge_by_name(Unit *u, const char *other);
489 Unit *unit_follow_merge(Unit *u) _pure_;
491 int unit_load_fragment_and_dropin(Unit *u);
492 int unit_load_fragment_and_dropin_optional(Unit *u);
493 int unit_load(Unit *unit);
495 int unit_add_default_slice(Unit *u);
497 const char *unit_description(Unit *u) _pure_;
499 bool unit_has_name(Unit *u, const char *name);
501 UnitActiveState unit_active_state(Unit *u);
503 const char* unit_sub_state_to_string(Unit *u);
505 void unit_dump(Unit *u, FILE *f, const char *prefix);
507 bool unit_can_reload(Unit *u) _pure_;
508 bool unit_can_start(Unit *u) _pure_;
509 bool unit_can_isolate(Unit *u) _pure_;
511 int unit_start(Unit *u);
512 int unit_stop(Unit *u);
513 int unit_reload(Unit *u);
515 int unit_kill(Unit *u, KillWho w, int signo, DBusError *error);
516 int unit_kill_common(Unit *u, KillWho who, int signo, pid_t main_pid, pid_t control_pid, DBusError *error);
518 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
520 int unit_watch_fd(Unit *u, int fd, uint32_t events, Watch *w);
521 void unit_unwatch_fd(Unit *u, Watch *w);
523 int unit_watch_pid(Unit *u, pid_t pid);
524 void unit_unwatch_pid(Unit *u, pid_t pid);
526 int unit_watch_timer(Unit *u, clockid_t, bool relative, usec_t usec, Watch *w);
527 void unit_unwatch_timer(Unit *u, Watch *w);
529 int unit_watch_bus_name(Unit *u, const char *name);
530 void unit_unwatch_bus_name(Unit *u, const char *name);
532 bool unit_job_is_applicable(Unit *u, JobType j);
534 int set_unit_path(const char *p);
536 char *unit_dbus_path(Unit *u);
538 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
539 int unit_get_related_unit(Unit *u, const char *type, Unit **_found);
541 bool unit_can_serialize(Unit *u) _pure_;
542 int unit_serialize(Unit *u, FILE *f, FDSet *fds, bool serialize_jobs);
543 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_attr_(4,5);
544 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
545 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
547 int unit_add_node_link(Unit *u, const char *what, bool wants);
549 int unit_coldplug(Unit *u);
551 void unit_status_printf(Unit *u, const char *status, const char *unit_status_msg_format) _printf_attr_(3, 0);
553 bool unit_need_daemon_reload(Unit *u);
555 void unit_reset_failed(Unit *u);
557 Unit *unit_following(Unit *u);
559 const char *unit_slice_name(Unit *u);
561 bool unit_stop_pending(Unit *u) _pure_;
562 bool unit_inactive_or_pending(Unit *u) _pure_;
563 bool unit_active_or_pending(Unit *u);
565 int unit_add_default_target_dependency(Unit *u, Unit *target);
567 char *unit_default_cgroup_path(Unit *u);
569 int unit_following_set(Unit *u, Set **s);
571 void unit_start_on_failure(Unit *u);
572 void unit_trigger_notify(Unit *u);
574 bool unit_condition_test(Unit *u);
576 UnitFileState unit_get_unit_file_state(Unit *u);
578 Unit* unit_ref_set(UnitRef *ref, Unit *u);
579 void unit_ref_unset(UnitRef *ref);
581 #define UNIT_DEREF(ref) ((ref).unit)
582 #define UNIT_ISSET(ref) (!!(ref).unit)
584 int unit_add_one_mount_link(Unit *u, Mount *m);
585 int unit_add_mount_links(Unit *u);
587 int unit_exec_context_defaults(Unit *u, ExecContext *c);
589 ExecContext *unit_get_exec_context(Unit *u) _pure_;
590 CGroupContext *unit_get_cgroup_context(Unit *u) _pure_;
592 int unit_write_drop_in(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *data);
593 int unit_write_drop_in_private_section(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *data);
594 int unit_remove_drop_in(Unit *u, UnitSetPropertiesMode mode, const char *name);
596 int unit_kill_context(Unit *u, KillContext *c, bool sigkill, pid_t main_pid, pid_t control_pid, bool main_pid_alien);
598 const char *unit_active_state_to_string(UnitActiveState i) _const_;
599 UnitActiveState unit_active_state_from_string(const char *s) _pure_;
601 const char *unit_dependency_to_string(UnitDependency i) _const_;
602 UnitDependency unit_dependency_from_string(const char *s) _pure_;
604 /* Macros which append UNIT= or USER_UNIT= to the message */
606 #define log_full_unit(level, unit, ...) log_meta_object(level, __FILE__, __LINE__, __func__, getpid() == 1 ? "UNIT=" : "USER_UNIT=", unit, __VA_ARGS__)
607 #define log_debug_unit(unit, ...) log_full_unit(LOG_DEBUG, unit, __VA_ARGS__)
608 #define log_info_unit(unit, ...) log_full_unit(LOG_INFO, unit, __VA_ARGS__)
609 #define log_notice_unit(unit, ...) log_full_unit(LOG_NOTICE, unit, __VA_ARGS__)
610 #define log_warning_unit(unit, ...) log_full_unit(LOG_WARNING, unit, __VA_ARGS__)
611 #define log_error_unit(unit, ...) log_full_unit(LOG_ERR, unit, __VA_ARGS__)
613 #define log_struct_unit(level, unit, ...) log_struct(level, getpid() == 1 ? "UNIT=%s" : "USER_UNIT=%s", unit, __VA_ARGS__)