1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
7 This file is part of systemd.
9 Copyright 2010 Lennart Poettering
11 systemd is free software; you can redistribute it and/or modify it
12 under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 2 of the License, or
14 (at your option) any later version.
16 systemd is distributed in the hope that it will be useful, but
17 WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with systemd; If not, see <http://www.gnu.org/licenses/>.
28 typedef union Unit Unit
;
29 typedef struct Meta Meta
;
30 typedef struct UnitVTable UnitVTable
;
31 typedef enum UnitType UnitType
;
32 typedef enum UnitLoadState UnitLoadState
;
33 typedef enum UnitActiveState UnitActiveState
;
34 typedef enum UnitDependency UnitDependency
;
39 #include "socket-util.h"
42 #define UNIT_NAME_MAX 256
43 #define DEFAULT_TIMEOUT_USEC (60*USEC_PER_SEC)
44 #define DEFAULT_RESTART_USEC (100*USEC_PER_MSEC)
58 _UNIT_TYPE_INVALID
= -1
67 _UNIT_LOAD_STATE_INVALID
= -1
70 enum UnitActiveState
{
77 _UNIT_ACTIVE_STATE_MAX
,
78 _UNIT_ACTIVE_STATE_INVALID
= -1
81 static inline bool UNIT_IS_ACTIVE_OR_RELOADING(UnitActiveState t
) {
82 return t
== UNIT_ACTIVE
|| t
== UNIT_RELOADING
;
85 static inline bool UNIT_IS_ACTIVE_OR_ACTIVATING(UnitActiveState t
) {
86 return t
== UNIT_ACTIVE
|| t
== UNIT_ACTIVATING
|| t
== UNIT_RELOADING
;
89 static inline bool UNIT_IS_INACTIVE_OR_DEACTIVATING(UnitActiveState t
) {
90 return t
== UNIT_INACTIVE
|| t
== UNIT_FAILED
|| t
== UNIT_DEACTIVATING
;
93 static inline bool UNIT_IS_INACTIVE_OR_FAILED(UnitActiveState t
) {
94 return t
== UNIT_INACTIVE
|| t
== UNIT_FAILED
;
98 /* Positive dependencies */
100 UNIT_REQUIRES_OVERRIDABLE
,
102 UNIT_REQUISITE_OVERRIDABLE
,
105 /* Inverse of the above */
106 UNIT_REQUIRED_BY
, /* inverse of 'requires' and 'requisite' is 'required_by' */
107 UNIT_REQUIRED_BY_OVERRIDABLE
, /* inverse of 'soft_requires' and 'soft_requisite' is 'soft_required_by' */
108 UNIT_WANTED_BY
, /* inverse of 'wants' */
110 /* Negative dependencies */
111 UNIT_CONFLICTS
, /* inverse of 'conflicts' is 'conflicted_by' */
115 UNIT_BEFORE
, /* inverse of 'before' is 'after' and vice versa */
121 /* Reference information for GC logic */
122 UNIT_REFERENCES
, /* Inverse of 'references' is 'referenced_by' */
125 _UNIT_DEPENDENCY_MAX
,
126 _UNIT_DEPENDENCY_INVALID
= -1
137 UnitLoadState load_state
;
140 char *id
; /* One name is special because we use it for identification. Points to an entry in the names set */
144 Set
*dependencies
[_UNIT_DEPENDENCY_MAX
];
148 char *fragment_path
; /* if loaded from a config file this is the primary path to it */
149 usec_t fragment_mtime
;
151 /* If there is something to do with this unit, then this is
157 dual_timestamp inactive_exit_timestamp
;
158 dual_timestamp active_enter_timestamp
;
159 dual_timestamp active_exit_timestamp
;
160 dual_timestamp inactive_enter_timestamp
;
162 /* Counterparts in the cgroup filesystem */
163 CGroupBonding
*cgroup_bondings
;
166 LIST_FIELDS(Meta
, units_per_type
);
169 LIST_FIELDS(Meta
, load_queue
);
172 LIST_FIELDS(Meta
, dbus_queue
);
175 LIST_FIELDS(Meta
, cleanup_queue
);
178 LIST_FIELDS(Meta
, gc_queue
);
180 /* Used during GC sweeps */
183 /* When deserializing, temporarily store the job type for this
184 * unit here, if there was a job scheduled */
185 int deserialized_job
; /* This is actually of type JobType */
187 /* Error code when we didn't manage to load the unit (negative) */
190 /* If we go down, pull down everything that depends on us, too */
193 /* Garbage collect us we nobody wants or requires us anymore */
194 bool stop_when_unneeded
;
196 /* Create default depedencies */
197 bool default_dependencies
;
199 /* Bring up this unit even if a dependency fails to start */
200 bool ignore_dependency_failure
;
202 /* Refuse manual starting, allow starting only indirectly via dependency. */
203 bool refuse_manual_start
;
205 /* Don't allow the user to stop this unit manually, allow stopping only indirectly via dependency. */
206 bool refuse_manual_stop
;
208 /* Allow isolation requests */
211 bool in_load_queue
:1;
212 bool in_dbus_queue
:1;
213 bool in_cleanup_queue
:1;
216 bool sent_dbus_new_signal
:1;
229 #include "automount.h"
230 #include "snapshot.h"
251 /* This should reset all type-specific variables. This should
252 * not allocate memory, and is called with zero-initialized
253 * data. It should hence only initialize variables that need
255 void (*init
)(Unit
*u
);
257 /* This should free all type-specific variables. It should be
259 void (*done
)(Unit
*u
);
261 /* Actually load data from disk. This may fail, and should set
262 * load_state to UNIT_LOADED, UNIT_MERGED or leave it at
263 * UNIT_STUB if no configuration could be found. */
264 int (*load
)(Unit
*u
);
266 /* If a a lot of units got created via enumerate(), this is
267 * where to actually set the state and call unit_notify(). */
268 int (*coldplug
)(Unit
*u
);
270 void (*dump
)(Unit
*u
, FILE *f
, const char *prefix
);
272 int (*start
)(Unit
*u
);
273 int (*stop
)(Unit
*u
);
274 int (*reload
)(Unit
*u
);
276 bool (*can_reload
)(Unit
*u
);
278 /* Write all data that cannot be restored from other sources
279 * away using unit_serialize_item() */
280 int (*serialize
)(Unit
*u
, FILE *f
, FDSet
*fds
);
282 /* Restore one item from the serialization */
283 int (*deserialize_item
)(Unit
*u
, const char *key
, const char *data
, FDSet
*fds
);
285 /* Boils down the more complex internal state of this unit to
286 * a simpler one that the engine can understand */
287 UnitActiveState (*active_state
)(Unit
*u
);
289 /* Returns the substate specific to this unit type as
290 * string. This is purely information so that we can give the
291 * user a more finegrained explanation in which actual state a
293 const char* (*sub_state_to_string
)(Unit
*u
);
295 /* Return true when there is reason to keep this entry around
296 * even nothing references it and it isn't active in any
298 bool (*check_gc
)(Unit
*u
);
300 /* Return true when this unit is suitable for snapshotting */
301 bool (*check_snapshot
)(Unit
*u
);
303 void (*fd_event
)(Unit
*u
, int fd
, uint32_t events
, Watch
*w
);
304 void (*sigchld_event
)(Unit
*u
, pid_t pid
, int code
, int status
);
305 void (*timer_event
)(Unit
*u
, uint64_t n_elapsed
, Watch
*w
);
307 /* Reset failed state if we are in failed state */
308 void (*reset_failed
)(Unit
*u
);
310 /* Called whenever any of the cgroups this unit watches for
312 void (*cgroup_notify_empty
)(Unit
*u
);
314 /* Called whenever a process of this unit sends us a message */
315 void (*notify_message
)(Unit
*u
, pid_t pid
, char **tags
);
317 /* Called whenever a name thus Unit registered for comes or
319 void (*bus_name_owner_change
)(Unit
*u
, const char *name
, const char *old_owner
, const char *new_owner
);
321 /* Called whenever a bus PID lookup finishes */
322 void (*bus_query_pid_done
)(Unit
*u
, const char *name
, pid_t pid
);
324 /* Called for each message received on the bus */
325 DBusHandlerResult (*bus_message_handler
)(Unit
*u
, DBusConnection
*c
, DBusMessage
*message
);
327 /* Return the unit this unit is following */
328 Unit
*(*following
)(Unit
*u
);
330 /* This is called for each unit type and should be used to
331 * enumerate existing devices and load them. However,
332 * everything that is loaded here should still stay in
333 * inactive state. It is the job of the coldplug() call above
334 * to put the units into the initial state. */
335 int (*enumerate
)(Manager
*m
);
337 /* Type specific cleanups. */
338 void (*shutdown
)(Manager
*m
);
340 /* When sending out PropertiesChanged signal, which properties
341 * shall be invalidated? This is a NUL seperated list of
342 * strings, to minimize relocations a little. */
343 const char *bus_invalidating_properties
;
345 /* The interface name */
346 const char *bus_interface
;
348 /* Can units of this type have multiple names? */
351 /* If true units of this types can never have "Requires"
352 * dependencies, because state changes can only be observed,
356 /* Instances make no sense for this type */
359 /* Exclude this type from snapshots */
362 /* Exclude from automatic gc */
365 /* Exclude from stopping on isolation requests */
368 /* Show status updates on the console */
372 extern const UnitVTable
* const unit_vtable
[_UNIT_TYPE_MAX
];
374 #define UNIT_VTABLE(u) unit_vtable[(u)->meta.type]
376 /* For casting a unit into the various unit types */
377 #define DEFINE_CAST(UPPERCASE, MixedCase) \
378 static inline MixedCase* UPPERCASE(Unit *u) { \
379 if (_unlikely_(!u || u->meta.type != UNIT_##UPPERCASE)) \
382 return (MixedCase*) u; \
385 /* For casting the various unit types into a unit */
386 #define UNIT(u) ((Unit*) (&(u)->meta))
388 DEFINE_CAST(SOCKET
, Socket
);
389 DEFINE_CAST(TIMER
, Timer
);
390 DEFINE_CAST(SERVICE
, Service
);
391 DEFINE_CAST(TARGET
, Target
);
392 DEFINE_CAST(DEVICE
, Device
);
393 DEFINE_CAST(MOUNT
, Mount
);
394 DEFINE_CAST(AUTOMOUNT
, Automount
);
395 DEFINE_CAST(SNAPSHOT
, Snapshot
);
396 DEFINE_CAST(SWAP
, Swap
);
397 DEFINE_CAST(PATH
, Path
);
399 Unit
*unit_new(Manager
*m
);
400 void unit_free(Unit
*u
);
402 int unit_add_name(Unit
*u
, const char *name
);
404 int unit_add_dependency(Unit
*u
, UnitDependency d
, Unit
*other
, bool add_reference
);
405 int unit_add_two_dependencies(Unit
*u
, UnitDependency d
, UnitDependency e
, Unit
*other
, bool add_reference
);
407 int unit_add_dependency_by_name(Unit
*u
, UnitDependency d
, const char *name
, const char *filename
, bool add_reference
);
408 int unit_add_two_dependencies_by_name(Unit
*u
, UnitDependency d
, UnitDependency e
, const char *name
, const char *path
, bool add_reference
);
410 int unit_add_dependency_by_name_inverse(Unit
*u
, UnitDependency d
, const char *name
, const char *filename
, bool add_reference
);
411 int unit_add_two_dependencies_by_name_inverse(Unit
*u
, UnitDependency d
, UnitDependency e
, const char *name
, const char *path
, bool add_reference
);
413 int unit_add_exec_dependencies(Unit
*u
, ExecContext
*c
);
415 int unit_add_cgroup(Unit
*u
, CGroupBonding
*b
);
416 int unit_add_cgroup_from_text(Unit
*u
, const char *name
);
417 int unit_add_default_cgroup(Unit
*u
);
418 CGroupBonding
* unit_get_default_cgroup(Unit
*u
);
420 int unit_choose_id(Unit
*u
, const char *name
);
421 int unit_set_description(Unit
*u
, const char *description
);
423 bool unit_check_gc(Unit
*u
);
425 void unit_add_to_load_queue(Unit
*u
);
426 void unit_add_to_dbus_queue(Unit
*u
);
427 void unit_add_to_cleanup_queue(Unit
*u
);
428 void unit_add_to_gc_queue(Unit
*u
);
430 int unit_merge(Unit
*u
, Unit
*other
);
431 int unit_merge_by_name(Unit
*u
, const char *other
);
433 Unit
*unit_follow_merge(Unit
*u
);
435 int unit_load_fragment_and_dropin(Unit
*u
);
436 int unit_load_fragment_and_dropin_optional(Unit
*u
);
437 int unit_load(Unit
*unit
);
439 const char *unit_description(Unit
*u
);
441 bool unit_has_name(Unit
*u
, const char *name
);
443 UnitActiveState
unit_active_state(Unit
*u
);
445 const char* unit_sub_state_to_string(Unit
*u
);
447 void unit_dump(Unit
*u
, FILE *f
, const char *prefix
);
449 bool unit_can_reload(Unit
*u
);
450 bool unit_can_start(Unit
*u
);
451 bool unit_can_isolate(Unit
*u
);
453 int unit_start(Unit
*u
);
454 int unit_stop(Unit
*u
);
455 int unit_reload(Unit
*u
);
457 void unit_notify(Unit
*u
, UnitActiveState os
, UnitActiveState ns
);
459 int unit_watch_fd(Unit
*u
, int fd
, uint32_t events
, Watch
*w
);
460 void unit_unwatch_fd(Unit
*u
, Watch
*w
);
462 int unit_watch_pid(Unit
*u
, pid_t pid
);
463 void unit_unwatch_pid(Unit
*u
, pid_t pid
);
465 int unit_watch_timer(Unit
*u
, usec_t delay
, Watch
*w
);
466 void unit_unwatch_timer(Unit
*u
, Watch
*w
);
468 int unit_watch_bus_name(Unit
*u
, const char *name
);
469 void unit_unwatch_bus_name(Unit
*u
, const char *name
);
471 bool unit_job_is_applicable(Unit
*u
, JobType j
);
473 int set_unit_path(const char *p
);
475 char *unit_dbus_path(Unit
*u
);
477 int unit_load_related_unit(Unit
*u
, const char *type
, Unit
**_found
);
478 int unit_get_related_unit(Unit
*u
, const char *type
, Unit
**_found
);
480 char *unit_name_printf(Unit
*u
, const char* text
);
481 char *unit_full_printf(Unit
*u
, const char *text
);
482 char **unit_full_printf_strv(Unit
*u
, char **l
);
484 bool unit_can_serialize(Unit
*u
);
485 int unit_serialize(Unit
*u
, FILE *f
, FDSet
*fds
);
486 void unit_serialize_item_format(Unit
*u
, FILE *f
, const char *key
, const char *value
, ...) _printf_attr_(4,5);
487 void unit_serialize_item(Unit
*u
, FILE *f
, const char *key
, const char *value
);
488 int unit_deserialize(Unit
*u
, FILE *f
, FDSet
*fds
);
490 int unit_add_node_link(Unit
*u
, const char *what
, bool wants
);
492 int unit_coldplug(Unit
*u
);
494 void unit_status_printf(Unit
*u
, const char *format
, ...);
496 bool unit_need_daemon_reload(Unit
*u
);
498 void unit_reset_failed(Unit
*u
);
500 Unit
*unit_following(Unit
*u
);
502 const char *unit_load_state_to_string(UnitLoadState i
);
503 UnitLoadState
unit_load_state_from_string(const char *s
);
505 const char *unit_active_state_to_string(UnitActiveState i
);
506 UnitActiveState
unit_active_state_from_string(const char *s
);
508 const char *unit_dependency_to_string(UnitDependency i
);
509 UnitDependency
unit_dependency_from_string(const char *s
);
511 const char *kill_mode_to_string(KillMode k
);
512 KillMode
kill_mode_from_string(const char *s
);