4 This file is part of systemd.
6 Copyright 2010 Lennart Poettering
8 systemd is free software; you can redistribute it and/or modify it
9 under the terms of the GNU Lesser General Public License as published by
10 the Free Software Foundation; either version 2.1 of the License, or
11 (at your option) any later version.
13 systemd is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 Lesser General Public License for more details.
18 You should have received a copy of the GNU Lesser General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
26 #define UNIT_NAME_MAX 256
28 typedef enum UnitType
{
41 _UNIT_TYPE_INVALID
= -1
44 typedef enum UnitLoadState
{
52 _UNIT_LOAD_STATE_INVALID
= -1
55 typedef enum UnitActiveState
{
62 _UNIT_ACTIVE_STATE_MAX
,
63 _UNIT_ACTIVE_STATE_INVALID
= -1
66 typedef enum AutomountState
{
72 _AUTOMOUNT_STATE_INVALID
= -1
75 /* We simply watch devices, we cannot plug/unplug them. That
76 * simplifies the state engine greatly */
77 typedef enum DeviceState
{
79 DEVICE_TENTATIVE
, /* mounted or swapped, but not (yet) announced by udev */
80 DEVICE_PLUGGED
, /* announced by udev */
82 _DEVICE_STATE_INVALID
= -1
85 typedef enum MountState
{
87 MOUNT_MOUNTING
, /* /usr/bin/mount is running, but the mount is not done yet. */
88 MOUNT_MOUNTING_DONE
, /* /usr/bin/mount is running, and the mount is done. */
92 MOUNT_MOUNTING_SIGTERM
,
93 MOUNT_MOUNTING_SIGKILL
,
94 MOUNT_REMOUNTING_SIGTERM
,
95 MOUNT_REMOUNTING_SIGKILL
,
96 MOUNT_UNMOUNTING_SIGTERM
,
97 MOUNT_UNMOUNTING_SIGKILL
,
100 _MOUNT_STATE_INVALID
= -1
103 typedef enum PathState
{
109 _PATH_STATE_INVALID
= -1
112 typedef enum ScopeState
{
120 _SCOPE_STATE_INVALID
= -1
123 typedef enum ServiceState
{
129 SERVICE_EXITED
, /* Nothing is running anymore, but RemainAfterExit is true hence this is OK */
131 SERVICE_STOP
, /* No STOP_PRE state, instead just register multiple STOP executables */
132 SERVICE_STOP_SIGABRT
, /* Watchdog timeout */
133 SERVICE_STOP_SIGTERM
,
134 SERVICE_STOP_SIGKILL
,
136 SERVICE_FINAL_SIGTERM
, /* In case the STOP_POST executable hangs, we shoot that down, too */
137 SERVICE_FINAL_SIGKILL
,
139 SERVICE_AUTO_RESTART
,
141 _SERVICE_STATE_INVALID
= -1
144 typedef enum SliceState
{
148 _SLICE_STATE_INVALID
= -1
151 typedef enum SocketState
{
159 SOCKET_STOP_PRE_SIGTERM
,
160 SOCKET_STOP_PRE_SIGKILL
,
162 SOCKET_FINAL_SIGTERM
,
163 SOCKET_FINAL_SIGKILL
,
166 _SOCKET_STATE_INVALID
= -1
169 typedef enum SwapState
{
171 SWAP_ACTIVATING
, /* /sbin/swapon is running, but the swap not yet enabled. */
172 SWAP_ACTIVATING_DONE
, /* /sbin/swapon is running, and the swap is done. */
175 SWAP_ACTIVATING_SIGTERM
,
176 SWAP_ACTIVATING_SIGKILL
,
177 SWAP_DEACTIVATING_SIGTERM
,
178 SWAP_DEACTIVATING_SIGKILL
,
181 _SWAP_STATE_INVALID
= -1
184 typedef enum TargetState
{
188 _TARGET_STATE_INVALID
= -1
191 typedef enum TimerState
{
198 _TIMER_STATE_INVALID
= -1
201 typedef enum UnitDependency
{
202 /* Positive dependencies */
209 /* Inverse of the above */
210 UNIT_REQUIRED_BY
, /* inverse of 'requires' is 'required_by' */
211 UNIT_REQUISITE_OF
, /* inverse of 'requisite' is 'requisite_of' */
212 UNIT_WANTED_BY
, /* inverse of 'wants' */
213 UNIT_BOUND_BY
, /* inverse of 'binds_to' */
214 UNIT_CONSISTS_OF
, /* inverse of 'part_of' */
216 /* Negative dependencies */
217 UNIT_CONFLICTS
, /* inverse of 'conflicts' is 'conflicted_by' */
221 UNIT_BEFORE
, /* inverse of 'before' is 'after' and vice versa */
227 /* Triggers (i.e. a socket triggers a service) */
231 /* Propagate reloads */
232 UNIT_PROPAGATES_RELOAD_TO
,
233 UNIT_RELOAD_PROPAGATED_FROM
,
235 /* Joins namespace of */
236 UNIT_JOINS_NAMESPACE_OF
,
238 /* Reference information for GC logic */
239 UNIT_REFERENCES
, /* Inverse of 'references' is 'referenced_by' */
242 _UNIT_DEPENDENCY_MAX
,
243 _UNIT_DEPENDENCY_INVALID
= -1
246 typedef enum NotifyAccess
{
252 _NOTIFY_ACCESS_INVALID
= -1
255 typedef enum UnitNameFlags
{
256 UNIT_NAME_PLAIN
= 1, /* Allow foo.service */
257 UNIT_NAME_INSTANCE
= 2, /* Allow foo@bar.service */
258 UNIT_NAME_TEMPLATE
= 4, /* Allow foo@.service */
259 UNIT_NAME_ANY
= UNIT_NAME_PLAIN
|UNIT_NAME_INSTANCE
|UNIT_NAME_TEMPLATE
,
262 bool unit_name_is_valid(const char *n
, UnitNameFlags flags
) _pure_
;
263 bool unit_prefix_is_valid(const char *p
) _pure_
;
264 bool unit_instance_is_valid(const char *i
) _pure_
;
265 bool unit_suffix_is_valid(const char *s
) _pure_
;
267 static inline int unit_prefix_and_instance_is_valid(const char *p
) {
268 /* For prefix+instance and instance the same rules apply */
269 return unit_instance_is_valid(p
);
272 int unit_name_to_prefix(const char *n
, char **prefix
);
273 int unit_name_to_instance(const char *n
, char **instance
);
274 int unit_name_to_prefix_and_instance(const char *n
, char **ret
);
276 UnitType
unit_name_to_type(const char *n
) _pure_
;
278 int unit_name_change_suffix(const char *n
, const char *suffix
, char **ret
);
280 int unit_name_build(const char *prefix
, const char *instance
, const char *suffix
, char **ret
);
282 char *unit_name_escape(const char *f
);
283 int unit_name_unescape(const char *f
, char **ret
);
284 int unit_name_path_escape(const char *f
, char **ret
);
285 int unit_name_path_unescape(const char *f
, char **ret
);
287 int unit_name_replace_instance(const char *f
, const char *i
, char **ret
);
289 int unit_name_template(const char *f
, char **ret
);
291 int unit_name_from_path(const char *path
, const char *suffix
, char **ret
);
292 int unit_name_from_path_instance(const char *prefix
, const char *path
, const char *suffix
, char **ret
);
293 int unit_name_to_path(const char *name
, char **ret
);
295 char *unit_dbus_path_from_name(const char *name
);
296 int unit_name_from_dbus_path(const char *path
, char **name
);
298 const char* unit_dbus_interface_from_type(UnitType t
);
299 const char *unit_dbus_interface_from_name(const char *name
);
301 typedef enum UnitNameMangle
{
306 int unit_name_mangle_with_suffix(const char *name
, UnitNameMangle allow_globs
, const char *suffix
, char **ret
);
308 static inline int unit_name_mangle(const char *name
, UnitNameMangle allow_globs
, char **ret
) {
309 return unit_name_mangle_with_suffix(name
, allow_globs
, ".service", ret
);
312 int slice_build_parent_slice(const char *slice
, char **ret
);
313 int slice_build_subslice(const char *slice
, const char*name
, char **subslice
);
314 bool slice_name_is_valid(const char *name
);
316 const char *unit_type_to_string(UnitType i
) _const_
;
317 UnitType
unit_type_from_string(const char *s
) _pure_
;
319 const char *unit_load_state_to_string(UnitLoadState i
) _const_
;
320 UnitLoadState
unit_load_state_from_string(const char *s
) _pure_
;
322 const char *unit_active_state_to_string(UnitActiveState i
) _const_
;
323 UnitActiveState
unit_active_state_from_string(const char *s
) _pure_
;
325 const char* automount_state_to_string(AutomountState i
) _const_
;
326 AutomountState
automount_state_from_string(const char *s
) _pure_
;
328 const char* device_state_to_string(DeviceState i
) _const_
;
329 DeviceState
device_state_from_string(const char *s
) _pure_
;
331 const char* mount_state_to_string(MountState i
) _const_
;
332 MountState
mount_state_from_string(const char *s
) _pure_
;
334 const char* path_state_to_string(PathState i
) _const_
;
335 PathState
path_state_from_string(const char *s
) _pure_
;
337 const char* scope_state_to_string(ScopeState i
) _const_
;
338 ScopeState
scope_state_from_string(const char *s
) _pure_
;
340 const char* service_state_to_string(ServiceState i
) _const_
;
341 ServiceState
service_state_from_string(const char *s
) _pure_
;
343 const char* slice_state_to_string(SliceState i
) _const_
;
344 SliceState
slice_state_from_string(const char *s
) _pure_
;
346 const char* socket_state_to_string(SocketState i
) _const_
;
347 SocketState
socket_state_from_string(const char *s
) _pure_
;
349 const char* swap_state_to_string(SwapState i
) _const_
;
350 SwapState
swap_state_from_string(const char *s
) _pure_
;
352 const char* target_state_to_string(TargetState i
) _const_
;
353 TargetState
target_state_from_string(const char *s
) _pure_
;
355 const char *timer_state_to_string(TimerState i
) _const_
;
356 TimerState
timer_state_from_string(const char *s
) _pure_
;
358 const char *unit_dependency_to_string(UnitDependency i
) _const_
;
359 UnitDependency
unit_dependency_from_string(const char *s
) _pure_
;
361 const char* notify_access_to_string(NotifyAccess i
) _const_
;
362 NotifyAccess
notify_access_from_string(const char *s
) _pure_
;