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 #define UNIT_NAME_MAX 256
30 typedef enum UnitType
{
44 _UNIT_TYPE_INVALID
= -1
47 typedef enum UnitLoadState
{
55 _UNIT_LOAD_STATE_INVALID
= -1
58 typedef enum UnitActiveState
{
65 _UNIT_ACTIVE_STATE_MAX
,
66 _UNIT_ACTIVE_STATE_INVALID
= -1
69 typedef enum AutomountState
{
75 _AUTOMOUNT_STATE_INVALID
= -1
78 typedef enum BusNameState
{
88 _BUSNAME_STATE_INVALID
= -1
91 /* We simply watch devices, we cannot plug/unplug them. That
92 * simplifies the state engine greatly */
93 typedef enum DeviceState
{
95 DEVICE_TENTATIVE
, /* mounted or swapped, but not (yet) announced by udev */
96 DEVICE_PLUGGED
, /* announced by udev */
98 _DEVICE_STATE_INVALID
= -1
101 typedef enum MountState
{
103 MOUNT_MOUNTING
, /* /usr/bin/mount is running, but the mount is not done yet. */
104 MOUNT_MOUNTING_DONE
, /* /usr/bin/mount is running, and the mount is done. */
108 MOUNT_MOUNTING_SIGTERM
,
109 MOUNT_MOUNTING_SIGKILL
,
110 MOUNT_REMOUNTING_SIGTERM
,
111 MOUNT_REMOUNTING_SIGKILL
,
112 MOUNT_UNMOUNTING_SIGTERM
,
113 MOUNT_UNMOUNTING_SIGKILL
,
116 _MOUNT_STATE_INVALID
= -1
119 typedef enum PathState
{
125 _PATH_STATE_INVALID
= -1
128 typedef enum ScopeState
{
136 _SCOPE_STATE_INVALID
= -1
139 typedef enum ServiceState
{
145 SERVICE_EXITED
, /* Nothing is running anymore, but RemainAfterExit is true hence this is OK */
147 SERVICE_STOP
, /* No STOP_PRE state, instead just register multiple STOP executables */
148 SERVICE_STOP_SIGABRT
, /* Watchdog timeout */
149 SERVICE_STOP_SIGTERM
,
150 SERVICE_STOP_SIGKILL
,
152 SERVICE_FINAL_SIGTERM
, /* In case the STOP_POST executable hangs, we shoot that down, too */
153 SERVICE_FINAL_SIGKILL
,
155 SERVICE_AUTO_RESTART
,
157 _SERVICE_STATE_INVALID
= -1
160 typedef enum SliceState
{
164 _SLICE_STATE_INVALID
= -1
167 typedef enum SocketState
{
175 SOCKET_STOP_PRE_SIGTERM
,
176 SOCKET_STOP_PRE_SIGKILL
,
178 SOCKET_FINAL_SIGTERM
,
179 SOCKET_FINAL_SIGKILL
,
182 _SOCKET_STATE_INVALID
= -1
185 typedef enum SwapState
{
187 SWAP_ACTIVATING
, /* /sbin/swapon is running, but the swap not yet enabled. */
188 SWAP_ACTIVATING_DONE
, /* /sbin/swapon is running, and the swap is done. */
191 SWAP_ACTIVATING_SIGTERM
,
192 SWAP_ACTIVATING_SIGKILL
,
193 SWAP_DEACTIVATING_SIGTERM
,
194 SWAP_DEACTIVATING_SIGKILL
,
197 _SWAP_STATE_INVALID
= -1
201 typedef enum TargetState
{
205 _TARGET_STATE_INVALID
= -1
208 typedef enum TimerState
{
215 _TIMER_STATE_INVALID
= -1
218 typedef enum UnitDependency
{
219 /* Positive dependencies */
226 /* Inverse of the above */
227 UNIT_REQUIRED_BY
, /* inverse of 'requires' is 'required_by' */
228 UNIT_REQUISITE_OF
, /* inverse of 'requisite' is 'requisite_of' */
229 UNIT_WANTED_BY
, /* inverse of 'wants' */
230 UNIT_BOUND_BY
, /* inverse of 'binds_to' */
231 UNIT_CONSISTS_OF
, /* inverse of 'part_of' */
233 /* Negative dependencies */
234 UNIT_CONFLICTS
, /* inverse of 'conflicts' is 'conflicted_by' */
238 UNIT_BEFORE
, /* inverse of 'before' is 'after' and vice versa */
244 /* Triggers (i.e. a socket triggers a service) */
248 /* Propagate reloads */
249 UNIT_PROPAGATES_RELOAD_TO
,
250 UNIT_RELOAD_PROPAGATED_FROM
,
252 /* Joins namespace of */
253 UNIT_JOINS_NAMESPACE_OF
,
255 /* Reference information for GC logic */
256 UNIT_REFERENCES
, /* Inverse of 'references' is 'referenced_by' */
259 _UNIT_DEPENDENCY_MAX
,
260 _UNIT_DEPENDENCY_INVALID
= -1
263 typedef enum UnitNameFlags
{
264 UNIT_NAME_PLAIN
= 1, /* Allow foo.service */
265 UNIT_NAME_INSTANCE
= 2, /* Allow foo@bar.service */
266 UNIT_NAME_TEMPLATE
= 4, /* Allow foo@.service */
267 UNIT_NAME_ANY
= UNIT_NAME_PLAIN
|UNIT_NAME_INSTANCE
|UNIT_NAME_TEMPLATE
,
270 bool unit_name_is_valid(const char *n
, UnitNameFlags flags
) _pure_
;
271 bool unit_prefix_is_valid(const char *p
) _pure_
;
272 bool unit_instance_is_valid(const char *i
) _pure_
;
273 bool unit_suffix_is_valid(const char *s
) _pure_
;
275 static inline int unit_prefix_and_instance_is_valid(const char *p
) {
276 /* For prefix+instance and instance the same rules apply */
277 return unit_instance_is_valid(p
);
280 int unit_name_to_prefix(const char *n
, char **prefix
);
281 int unit_name_to_instance(const char *n
, char **instance
);
282 int unit_name_to_prefix_and_instance(const char *n
, char **ret
);
284 UnitType
unit_name_to_type(const char *n
) _pure_
;
286 int unit_name_change_suffix(const char *n
, const char *suffix
, char **ret
);
288 int unit_name_build(const char *prefix
, const char *instance
, const char *suffix
, char **ret
);
290 char *unit_name_escape(const char *f
);
291 int unit_name_unescape(const char *f
, char **ret
);
292 int unit_name_path_escape(const char *f
, char **ret
);
293 int unit_name_path_unescape(const char *f
, char **ret
);
295 int unit_name_replace_instance(const char *f
, const char *i
, char **ret
);
297 int unit_name_template(const char *f
, char **ret
);
299 int unit_name_from_path(const char *path
, const char *suffix
, char **ret
);
300 int unit_name_from_path_instance(const char *prefix
, const char *path
, const char *suffix
, char **ret
);
301 int unit_name_to_path(const char *name
, char **ret
);
303 char *unit_dbus_path_from_name(const char *name
);
304 int unit_name_from_dbus_path(const char *path
, char **name
);
306 const char* unit_dbus_interface_from_type(UnitType t
);
307 const char *unit_dbus_interface_from_name(const char *name
);
309 typedef enum UnitNameMangle
{
314 int unit_name_mangle_with_suffix(const char *name
, UnitNameMangle allow_globs
, const char *suffix
, char **ret
);
316 static inline int unit_name_mangle(const char *name
, UnitNameMangle allow_globs
, char **ret
) {
317 return unit_name_mangle_with_suffix(name
, allow_globs
, ".service", ret
);
320 int slice_build_parent_slice(const char *slice
, char **ret
);
321 int slice_build_subslice(const char *slice
, const char*name
, char **subslice
);
322 bool slice_name_is_valid(const char *name
);
324 const char *unit_type_to_string(UnitType i
) _const_
;
325 UnitType
unit_type_from_string(const char *s
) _pure_
;
327 const char *unit_load_state_to_string(UnitLoadState i
) _const_
;
328 UnitLoadState
unit_load_state_from_string(const char *s
) _pure_
;
330 const char *unit_active_state_to_string(UnitActiveState i
) _const_
;
331 UnitActiveState
unit_active_state_from_string(const char *s
) _pure_
;
333 const char* automount_state_to_string(AutomountState i
) _const_
;
334 AutomountState
automount_state_from_string(const char *s
) _pure_
;
336 const char* busname_state_to_string(BusNameState i
) _const_
;
337 BusNameState
busname_state_from_string(const char *s
) _pure_
;
339 const char* device_state_to_string(DeviceState i
) _const_
;
340 DeviceState
device_state_from_string(const char *s
) _pure_
;
342 const char* mount_state_to_string(MountState i
) _const_
;
343 MountState
mount_state_from_string(const char *s
) _pure_
;
345 const char* path_state_to_string(PathState i
) _const_
;
346 PathState
path_state_from_string(const char *s
) _pure_
;
348 const char* scope_state_to_string(ScopeState i
) _const_
;
349 ScopeState
scope_state_from_string(const char *s
) _pure_
;
351 const char* service_state_to_string(ServiceState i
) _const_
;
352 ServiceState
service_state_from_string(const char *s
) _pure_
;
354 const char* slice_state_to_string(SliceState i
) _const_
;
355 SliceState
slice_state_from_string(const char *s
) _pure_
;
357 const char* socket_state_to_string(SocketState i
) _const_
;
358 SocketState
socket_state_from_string(const char *s
) _pure_
;
360 const char* swap_state_to_string(SwapState i
) _const_
;
361 SwapState
swap_state_from_string(const char *s
) _pure_
;
363 const char* target_state_to_string(TargetState i
) _const_
;
364 TargetState
target_state_from_string(const char *s
) _pure_
;
366 const char *timer_state_to_string(TimerState i
) _const_
;
367 TimerState
timer_state_from_string(const char *s
) _pure_
;
369 const char *unit_dependency_to_string(UnitDependency i
) _const_
;
370 UnitDependency
unit_dependency_from_string(const char *s
) _pure_
;