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 struct UnitRef UnitRef;
32 typedef struct UnitStatusMessageFormats UnitStatusMessageFormats;
38 #include "socket-util.h"
41 #include "condition.h"
43 #include "unit-name.h"
44 #include "failure-action.h"
46 enum UnitActiveState {
53 _UNIT_ACTIVE_STATE_MAX,
54 _UNIT_ACTIVE_STATE_INVALID = -1
57 typedef enum KillOperation {
63 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t) {
64 return t == UNIT_ACTIVE || t == UNIT_RELOADING;
67 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t) {
68 return t == UNIT_ACTIVE || t == UNIT_ACTIVATING || t == UNIT_RELOADING;
71 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t) {
72 return t == UNIT_INACTIVE || t == UNIT_FAILED || t == UNIT_DEACTIVATING;
75 static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t) {
76 return t == UNIT_INACTIVE || t == UNIT_FAILED;
83 /* Keeps tracks of references to a unit. This is useful so
84 * that we can merge two units if necessary and correct all
85 * references to them */
88 LIST_FIELDS(UnitRef, refs);
95 UnitLoadState load_state;
98 char *id; /* One name is special because we use it for identification. Points to an entry in the names set */
102 Set *dependencies[_UNIT_DEPENDENCY_MAX];
104 char **requires_mounts_for;
107 char **documentation;
109 char *fragment_path; /* if loaded from a config file this is the primary path to it */
110 char *source_path; /* if converted, the source file */
112 usec_t fragment_mtime;
116 /* If there is something to do with this unit, then this is the installed job for it */
119 /* JOB_NOP jobs are special and can be installed without disturbing the real job. */
122 /* Job timeout and action to take */
124 FailureAction job_timeout_action;
125 char *job_timeout_reboot_arg;
127 /* References to this */
128 LIST_HEAD(UnitRef, refs);
130 /* Conditions to check */
131 LIST_HEAD(Condition, conditions);
132 LIST_HEAD(Condition, asserts);
134 dual_timestamp condition_timestamp;
135 dual_timestamp assert_timestamp;
137 dual_timestamp inactive_exit_timestamp;
138 dual_timestamp active_enter_timestamp;
139 dual_timestamp active_exit_timestamp;
140 dual_timestamp inactive_enter_timestamp;
145 LIST_FIELDS(Unit, units_by_type);
147 /* All units which have requires_mounts_for set */
148 LIST_FIELDS(Unit, has_requires_mounts_for);
151 LIST_FIELDS(Unit, load_queue);
154 LIST_FIELDS(Unit, dbus_queue);
157 LIST_FIELDS(Unit, cleanup_queue);
160 LIST_FIELDS(Unit, gc_queue);
162 /* CGroup realize members queue */
163 LIST_FIELDS(Unit, cgroup_queue);
165 /* PIDs we keep an eye on. Note that a unit might have many
166 * more, but these are the ones we care enough about to
167 * process SIGCHLD for */
170 /* Used during GC sweeps */
173 /* When deserializing, temporarily store the job type for this
174 * unit here, if there was a job scheduled.
175 * Only for deserializing from a legacy version. New style uses full
176 * serialized jobs. */
177 int deserialized_job; /* This is actually of type JobType */
179 /* Error code when we didn't manage to load the unit (negative) */
182 /* Cached unit file state */
183 UnitFileState unit_file_state;
185 /* Counterparts in the cgroup filesystem */
187 CGroupControllerMask cgroup_realized_mask;
188 CGroupControllerMask cgroup_subtree_mask;
189 CGroupControllerMask cgroup_members_mask;
191 /* How to start OnFailure units */
192 JobMode on_failure_job_mode;
194 /* Garbage collect us we nobody wants or requires us anymore */
195 bool stop_when_unneeded;
197 /* Create default dependencies */
198 bool default_dependencies;
200 /* Refuse manual starting, allow starting only indirectly via dependency. */
201 bool refuse_manual_start;
203 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
204 bool refuse_manual_stop;
206 /* Allow isolation requests */
209 /* Ignore this unit when isolating */
210 bool ignore_on_isolate;
212 /* Ignore this unit when snapshotting */
213 bool ignore_on_snapshot;
215 /* Did the last condition check succeed? */
216 bool condition_result;
219 /* Is this a transient unit? */
222 bool in_load_queue:1;
223 bool in_dbus_queue:1;
224 bool in_cleanup_queue:1;
226 bool in_cgroup_queue:1;
228 bool sent_dbus_new_signal:1;
234 bool cgroup_realized:1;
235 bool cgroup_members_mask_valid:1;
236 bool cgroup_subtree_mask_valid:1;
239 struct UnitStatusMessageFormats {
240 const char *starting_stopping[2];
241 const char *finished_start_job[_JOB_RESULT_MAX];
242 const char *finished_stop_job[_JOB_RESULT_MAX];
245 typedef enum UnitSetPropertiesMode {
249 } UnitSetPropertiesMode;
255 #include "snapshot.h"
258 #include "automount.h"
266 /* How much memory does an object of this unit type need */
269 /* If greater than 0, the offset into the object where
270 * ExecContext is found, if the unit type has that */
271 size_t exec_context_offset;
273 /* If greater than 0, the offset into the object where
274 * CGroupContext is found, if the unit type has that */
275 size_t cgroup_context_offset;
277 /* If greater than 0, the offset into the object where
278 * KillContext is found, if the unit type has that */
279 size_t kill_context_offset;
281 /* If greater than 0, the offset into the object where the
282 * pointer to ExecRuntime is found, if the unit type has
284 size_t exec_runtime_offset;
286 /* The name of the configuration file section with the private settings of this unit*/
287 const char *private_section;
289 /* Config file sections this unit type understands, separated
291 const char *sections;
293 /* This should reset all type-specific variables. This should
294 * not allocate memory, and is called with zero-initialized
295 * data. It should hence only initialize variables that need
297 void (*init)(Unit *u);
299 /* This should free all type-specific variables. It should be
301 void (*done)(Unit *u);
303 /* Actually load data from disk. This may fail, and should set
304 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
305 * UNIT_STUB if no configuration could be found. */
306 int (*load)(Unit *u);
308 /* If a lot of units got created via enumerate(), this is
309 * where to actually set the state and call unit_notify(). */
310 int (*coldplug)(Unit *u);
312 void (*dump)(Unit *u, FILE *f, const char *prefix);
314 int (*start)(Unit *u);
315 int (*stop)(Unit *u);
316 int (*reload)(Unit *u);
318 int (*kill)(Unit *u, KillWho w, int signo, sd_bus_error *error);
320 bool (*can_reload)(Unit *u);
322 /* Write all data that cannot be restored from other sources
323 * away using unit_serialize_item() */
324 int (*serialize)(Unit *u, FILE *f, FDSet *fds);
326 /* Restore one item from the serialization */
327 int (*deserialize_item)(Unit *u, const char *key, const char *data, FDSet *fds);
329 /* Try to match up fds with what we need for this unit */
330 int (*distribute_fds)(Unit *u, FDSet *fds);
332 /* Boils down the more complex internal state of this unit to
333 * a simpler one that the engine can understand */
334 UnitActiveState (*active_state)(Unit *u);
336 /* Returns the substate specific to this unit type as
337 * string. This is purely information so that we can give the
338 * user a more fine grained explanation in which actual state a
340 const char* (*sub_state_to_string)(Unit *u);
342 /* Return true when there is reason to keep this entry around
343 * even nothing references it and it isn't active in any
345 bool (*check_gc)(Unit *u);
347 /* Return true when this unit is suitable for snapshotting */
348 bool (*check_snapshot)(Unit *u);
350 /* Invoked on every child that died */
351 void (*sigchld_event)(Unit *u, pid_t pid, int code, int status);
353 /* Reset failed state if we are in failed state */
354 void (*reset_failed)(Unit *u);
356 /* Called whenever any of the cgroups this unit watches for
358 void (*notify_cgroup_empty)(Unit *u);
360 /* Called whenever a process of this unit sends us a message */
361 void (*notify_message)(Unit *u, pid_t pid, char **tags);
363 /* Called whenever a name this Unit registered for comes or
365 void (*bus_name_owner_change)(Unit *u, const char *name, const char *old_owner, const char *new_owner);
367 /* Called for each property that is being set */
368 int (*bus_set_property)(Unit *u, const char *name, sd_bus_message *message, UnitSetPropertiesMode mode, sd_bus_error *error);
370 /* Called after at least one property got changed to apply the necessary change */
371 int (*bus_commit_properties)(Unit *u);
373 /* Return the unit this unit is following */
374 Unit *(*following)(Unit *u);
376 /* Return the set of units that are following each other */
377 int (*following_set)(Unit *u, Set **s);
379 /* Invoked each time a unit this unit is triggering changes
380 * state or gains/loses a job */
381 void (*trigger_notify)(Unit *u, Unit *trigger);
383 /* Called whenever CLOCK_REALTIME made a jump */
384 void (*time_change)(Unit *u);
386 int (*get_timeout)(Unit *u, uint64_t *timeout);
388 /* This is called for each unit type and should be used to
389 * enumerate existing devices and load them. However,
390 * everything that is loaded here should still stay in
391 * inactive state. It is the job of the coldplug() call above
392 * to put the units into the initial state. */
393 int (*enumerate)(Manager *m);
395 /* Type specific cleanups. */
396 void (*shutdown)(Manager *m);
398 /* The interface name */
399 const char *bus_interface;
402 const sd_bus_vtable *bus_vtable;
404 /* The strings to print in status messages */
405 UnitStatusMessageFormats status_message_formats;
407 /* Can units of this type have multiple names? */
410 /* Instances make no sense for this type */
413 /* Exclude from automatic gc */
416 /* True if transient units of this type are OK */
417 bool can_transient:1;
420 extern const UnitVTable * const unit_vtable[_UNIT_TYPE_MAX];
422 #define UNIT_VTABLE(u) unit_vtable[(u)->type]
424 /* For casting a unit into the various unit types */
425 #define DEFINE_CAST(UPPERCASE, MixedCase) \
426 static inline MixedCase* UPPERCASE(Unit *u) { \
427 if (_unlikely_(!u || u->type != UNIT_##UPPERCASE)) \
430 return (MixedCase*) u; \
433 /* For casting the various unit types into a unit */
434 #define UNIT(u) (&(u)->meta)
436 #define UNIT_TRIGGER(u) ((Unit*) set_first((u)->dependencies[UNIT_TRIGGERS]))
438 DEFINE_CAST(SERVICE, Service);
439 DEFINE_CAST(SOCKET, Socket);
440 DEFINE_CAST(BUSNAME, BusName);
441 DEFINE_CAST(TARGET, Target);
442 DEFINE_CAST(SNAPSHOT, Snapshot);
443 DEFINE_CAST(DEVICE, Device);
444 DEFINE_CAST(MOUNT, Mount);
445 DEFINE_CAST(AUTOMOUNT, Automount);
446 DEFINE_CAST(SWAP, Swap);
447 DEFINE_CAST(TIMER, Timer);
448 DEFINE_CAST(PATH, Path);
449 DEFINE_CAST(SLICE, Slice);
450 DEFINE_CAST(SCOPE, Scope);
452 Unit *unit_new(Manager *m, size_t size);
453 void unit_free(Unit *u);
455 int unit_add_name(Unit *u, const char *name);
457 int unit_add_dependency(Unit *u, UnitDependency d, Unit *other, bool add_reference);
458 int unit_add_two_dependencies(Unit *u, UnitDependency d, UnitDependency e, Unit *other, bool add_reference);
460 int unit_add_dependency_by_name(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
461 int unit_add_two_dependencies_by_name(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
463 int unit_add_dependency_by_name_inverse(Unit *u, UnitDependency d, const char *name, const char *filename, bool add_reference);
464 int unit_add_two_dependencies_by_name_inverse(Unit *u, UnitDependency d, UnitDependency e, const char *name, const char *path, bool add_reference);
466 int unit_add_exec_dependencies(Unit *u, ExecContext *c);
468 int unit_choose_id(Unit *u, const char *name);
469 int unit_set_description(Unit *u, const char *description);
471 bool unit_check_gc(Unit *u);
473 void unit_add_to_load_queue(Unit *u);
474 void unit_add_to_dbus_queue(Unit *u);
475 void unit_add_to_cleanup_queue(Unit *u);
476 void unit_add_to_gc_queue(Unit *u);
478 int unit_merge(Unit *u, Unit *other);
479 int unit_merge_by_name(Unit *u, const char *other);
481 Unit *unit_follow_merge(Unit *u) _pure_;
483 int unit_load_fragment_and_dropin(Unit *u);
484 int unit_load_fragment_and_dropin_optional(Unit *u);
485 int unit_load(Unit *unit);
487 int unit_add_default_slice(Unit *u, CGroupContext *c);
489 const char *unit_description(Unit *u) _pure_;
491 bool unit_has_name(Unit *u, const char *name);
493 UnitActiveState unit_active_state(Unit *u);
495 const char* unit_sub_state_to_string(Unit *u);
497 void unit_dump(Unit *u, FILE *f, const char *prefix);
499 bool unit_can_reload(Unit *u) _pure_;
500 bool unit_can_start(Unit *u) _pure_;
501 bool unit_can_isolate(Unit *u) _pure_;
503 int unit_start(Unit *u);
504 int unit_stop(Unit *u);
505 int unit_reload(Unit *u);
507 int unit_kill(Unit *u, KillWho w, int signo, sd_bus_error *error);
508 int unit_kill_common(Unit *u, KillWho who, int signo, pid_t main_pid, pid_t control_pid, sd_bus_error *error);
510 void unit_notify(Unit *u, UnitActiveState os, UnitActiveState ns, bool reload_success);
512 int unit_watch_pid(Unit *u, pid_t pid);
513 void unit_unwatch_pid(Unit *u, pid_t pid);
514 int unit_watch_all_pids(Unit *u);
515 void unit_unwatch_all_pids(Unit *u);
517 void unit_tidy_watch_pids(Unit *u, pid_t except1, pid_t except2);
519 int unit_watch_bus_name(Unit *u, const char *name);
520 void unit_unwatch_bus_name(Unit *u, const char *name);
522 bool unit_job_is_applicable(Unit *u, JobType j);
524 int set_unit_path(const char *p);
526 char *unit_dbus_path(Unit *u);
528 int unit_load_related_unit(Unit *u, const char *type, Unit **_found);
530 bool unit_can_serialize(Unit *u) _pure_;
531 int unit_serialize(Unit *u, FILE *f, FDSet *fds, bool serialize_jobs);
532 void unit_serialize_item_format(Unit *u, FILE *f, const char *key, const char *value, ...) _printf_(4,5);
533 void unit_serialize_item(Unit *u, FILE *f, const char *key, const char *value);
534 int unit_deserialize(Unit *u, FILE *f, FDSet *fds);
536 int unit_add_node_link(Unit *u, const char *what, bool wants);
538 int unit_coldplug(Unit *u);
540 void unit_status_printf(Unit *u, const char *status, const char *unit_status_msg_format) _printf_(3, 0);
542 bool unit_need_daemon_reload(Unit *u);
544 void unit_reset_failed(Unit *u);
546 Unit *unit_following(Unit *u);
547 int unit_following_set(Unit *u, Set **s);
549 const char *unit_slice_name(Unit *u);
551 bool unit_stop_pending(Unit *u) _pure_;
552 bool unit_inactive_or_pending(Unit *u) _pure_;
553 bool unit_active_or_pending(Unit *u);
555 int unit_add_default_target_dependency(Unit *u, Unit *target);
557 char *unit_default_cgroup_path(Unit *u);
559 void unit_start_on_failure(Unit *u);
560 void unit_trigger_notify(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_patch_contexts(Unit *u);
572 ExecContext *unit_get_exec_context(Unit *u) _pure_;
573 KillContext *unit_get_kill_context(Unit *u) _pure_;
574 CGroupContext *unit_get_cgroup_context(Unit *u) _pure_;
576 ExecRuntime *unit_get_exec_runtime(Unit *u) _pure_;
578 int unit_setup_exec_runtime(Unit *u);
580 int unit_write_drop_in(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *data);
581 int unit_write_drop_in_format(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *format, ...) _printf_(4,5);
583 int unit_write_drop_in_private(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *data);
584 int unit_write_drop_in_private_format(Unit *u, UnitSetPropertiesMode mode, const char *name, const char *format, ...) _printf_(4,5);
586 int unit_remove_drop_in(Unit *u, UnitSetPropertiesMode mode, const char *name);
588 int unit_kill_context(Unit *u, KillContext *c, KillOperation k, pid_t main_pid, pid_t control_pid, bool main_pid_alien);
590 int unit_make_transient(Unit *u);
592 int unit_require_mounts_for(Unit *u, const char *path);
594 const char *unit_active_state_to_string(UnitActiveState i) _const_;
595 UnitActiveState unit_active_state_from_string(const char *s) _pure_;
597 /* Macros which append UNIT= or USER_UNIT= to the message */
599 #define log_unit_full_errno(unit, level, error, ...) log_object_internal(level, error, __FILE__, __LINE__, __func__, getpid() == 1 ? "UNIT=" : "USER_UNIT=", unit, __VA_ARGS__)
600 #define log_unit_full(unit, level, ...) log_unit_full_errno(unit, level, 0, __VA_ARGS__)
602 #define log_unit_debug(unit, ...) log_unit_full(unit, LOG_DEBUG, __VA_ARGS__)
603 #define log_unit_info(unit, ...) log_unit_full(unit, LOG_INFO, __VA_ARGS__)
604 #define log_unit_notice(unit, ...) log_unit_full(unit, LOG_NOTICE, __VA_ARGS__)
605 #define log_unit_warning(unit, ...) log_unit_full(unit, LOG_WARNING, __VA_ARGS__)
606 #define log_unit_error(unit, ...) log_unit_full(unit, LOG_ERR, __VA_ARGS__)
608 #define log_unit_struct(unit, level, ...) log_struct(level, getpid() == 1 ? "UNIT=%s" : "USER_UNIT=%s", unit, __VA_ARGS__)