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 #if 0 /// UNNEEDED by elogind
48 typedef enum UnitLoadState {
56 _UNIT_LOAD_STATE_INVALID = -1
59 typedef enum UnitActiveState {
66 _UNIT_ACTIVE_STATE_MAX,
67 _UNIT_ACTIVE_STATE_INVALID = -1
70 typedef enum AutomountState {
76 _AUTOMOUNT_STATE_INVALID = -1
79 typedef enum BusNameState {
89 _BUSNAME_STATE_INVALID = -1
92 /* We simply watch devices, we cannot plug/unplug them. That
93 * simplifies the state engine greatly */
94 typedef enum DeviceState {
96 DEVICE_TENTATIVE, /* mounted or swapped, but not (yet) announced by udev */
97 DEVICE_PLUGGED, /* announced by udev */
99 _DEVICE_STATE_INVALID = -1
102 typedef enum MountState {
104 MOUNT_MOUNTING, /* /usr/bin/mount is running, but the mount is not done yet. */
105 MOUNT_MOUNTING_DONE, /* /usr/bin/mount is running, and the mount is done. */
109 MOUNT_MOUNTING_SIGTERM,
110 MOUNT_MOUNTING_SIGKILL,
111 MOUNT_REMOUNTING_SIGTERM,
112 MOUNT_REMOUNTING_SIGKILL,
113 MOUNT_UNMOUNTING_SIGTERM,
114 MOUNT_UNMOUNTING_SIGKILL,
117 _MOUNT_STATE_INVALID = -1
120 typedef enum PathState {
126 _PATH_STATE_INVALID = -1
129 typedef enum ScopeState {
137 _SCOPE_STATE_INVALID = -1
140 typedef enum ServiceState {
146 SERVICE_EXITED, /* Nothing is running anymore, but RemainAfterExit is true hence this is OK */
148 SERVICE_STOP, /* No STOP_PRE state, instead just register multiple STOP executables */
149 SERVICE_STOP_SIGABRT, /* Watchdog timeout */
150 SERVICE_STOP_SIGTERM,
151 SERVICE_STOP_SIGKILL,
153 SERVICE_FINAL_SIGTERM, /* In case the STOP_POST executable hangs, we shoot that down, too */
154 SERVICE_FINAL_SIGKILL,
156 SERVICE_AUTO_RESTART,
158 _SERVICE_STATE_INVALID = -1
161 typedef enum SliceState {
165 _SLICE_STATE_INVALID = -1
168 typedef enum SocketState {
176 SOCKET_STOP_PRE_SIGTERM,
177 SOCKET_STOP_PRE_SIGKILL,
179 SOCKET_FINAL_SIGTERM,
180 SOCKET_FINAL_SIGKILL,
183 _SOCKET_STATE_INVALID = -1
186 typedef enum SwapState {
188 SWAP_ACTIVATING, /* /sbin/swapon is running, but the swap not yet enabled. */
189 SWAP_ACTIVATING_DONE, /* /sbin/swapon is running, and the swap is done. */
192 SWAP_ACTIVATING_SIGTERM,
193 SWAP_ACTIVATING_SIGKILL,
194 SWAP_DEACTIVATING_SIGTERM,
195 SWAP_DEACTIVATING_SIGKILL,
198 _SWAP_STATE_INVALID = -1
202 typedef enum TargetState {
206 _TARGET_STATE_INVALID = -1
209 typedef enum TimerState {
216 _TIMER_STATE_INVALID = -1
219 typedef enum UnitDependency {
220 /* Positive dependencies */
227 /* Inverse of the above */
228 UNIT_REQUIRED_BY, /* inverse of 'requires' is 'required_by' */
229 UNIT_REQUISITE_OF, /* inverse of 'requisite' is 'requisite_of' */
230 UNIT_WANTED_BY, /* inverse of 'wants' */
231 UNIT_BOUND_BY, /* inverse of 'binds_to' */
232 UNIT_CONSISTS_OF, /* inverse of 'part_of' */
234 /* Negative dependencies */
235 UNIT_CONFLICTS, /* inverse of 'conflicts' is 'conflicted_by' */
239 UNIT_BEFORE, /* inverse of 'before' is 'after' and vice versa */
245 /* Triggers (i.e. a socket triggers a service) */
249 /* Propagate reloads */
250 UNIT_PROPAGATES_RELOAD_TO,
251 UNIT_RELOAD_PROPAGATED_FROM,
253 /* Joins namespace of */
254 UNIT_JOINS_NAMESPACE_OF,
256 /* Reference information for GC logic */
257 UNIT_REFERENCES, /* Inverse of 'references' is 'referenced_by' */
260 _UNIT_DEPENDENCY_MAX,
261 _UNIT_DEPENDENCY_INVALID = -1
265 typedef enum UnitNameFlags {
266 UNIT_NAME_PLAIN = 1, /* Allow foo.service */
267 UNIT_NAME_INSTANCE = 2, /* Allow foo@bar.service */
268 UNIT_NAME_TEMPLATE = 4, /* Allow foo@.service */
269 UNIT_NAME_ANY = UNIT_NAME_PLAIN|UNIT_NAME_INSTANCE|UNIT_NAME_TEMPLATE,
272 bool unit_name_is_valid(const char *n, UnitNameFlags flags) _pure_;
273 bool unit_prefix_is_valid(const char *p) _pure_;
274 bool unit_instance_is_valid(const char *i) _pure_;
275 bool unit_suffix_is_valid(const char *s) _pure_;
277 #if 0 /// UNNEEDED by elogind
278 static inline int unit_prefix_and_instance_is_valid(const char *p) {
279 /* For prefix+instance and instance the same rules apply */
280 return unit_instance_is_valid(p);
283 int unit_name_to_prefix(const char *n, char **prefix);
284 int unit_name_to_instance(const char *n, char **instance);
285 int unit_name_to_prefix_and_instance(const char *n, char **ret);
287 UnitType unit_name_to_type(const char *n) _pure_;
289 int unit_name_change_suffix(const char *n, const char *suffix, char **ret);
292 int unit_name_build(const char *prefix, const char *instance, const char *suffix, char **ret);
294 #if 0 /// UNNEEDED by elogind
295 char *unit_name_escape(const char *f);
296 int unit_name_unescape(const char *f, char **ret);
297 int unit_name_path_escape(const char *f, char **ret);
298 int unit_name_path_unescape(const char *f, char **ret);
300 int unit_name_replace_instance(const char *f, const char *i, char **ret);
302 int unit_name_template(const char *f, char **ret);
304 int unit_name_from_path(const char *path, const char *suffix, char **ret);
305 int unit_name_from_path_instance(const char *prefix, const char *path, const char *suffix, char **ret);
306 int unit_name_to_path(const char *name, char **ret);
308 char *unit_dbus_path_from_name(const char *name);
309 int unit_name_from_dbus_path(const char *path, char **name);
311 const char* unit_dbus_interface_from_type(UnitType t);
312 const char *unit_dbus_interface_from_name(const char *name);
314 typedef enum UnitNameMangle {
319 int unit_name_mangle_with_suffix(const char *name, UnitNameMangle allow_globs, const char *suffix, char **ret);
321 static inline int unit_name_mangle(const char *name, UnitNameMangle allow_globs, char **ret) {
322 return unit_name_mangle_with_suffix(name, allow_globs, ".service", ret);
325 int slice_build_parent_slice(const char *slice, char **ret);
327 int slice_build_subslice(const char *slice, const char*name, char **subslice);
328 bool slice_name_is_valid(const char *name);
330 const char *unit_type_to_string(UnitType i) _const_;
331 UnitType unit_type_from_string(const char *s) _pure_;
333 #if 0 /// UNNEEDED by elogind
334 const char *unit_load_state_to_string(UnitLoadState i) _const_;
335 UnitLoadState unit_load_state_from_string(const char *s) _pure_;
337 const char *unit_active_state_to_string(UnitActiveState i) _const_;
338 UnitActiveState unit_active_state_from_string(const char *s) _pure_;
340 const char* automount_state_to_string(AutomountState i) _const_;
341 AutomountState automount_state_from_string(const char *s) _pure_;
343 const char* busname_state_to_string(BusNameState i) _const_;
344 BusNameState busname_state_from_string(const char *s) _pure_;
346 const char* device_state_to_string(DeviceState i) _const_;
347 DeviceState device_state_from_string(const char *s) _pure_;
349 const char* mount_state_to_string(MountState i) _const_;
350 MountState mount_state_from_string(const char *s) _pure_;
352 const char* path_state_to_string(PathState i) _const_;
353 PathState path_state_from_string(const char *s) _pure_;
355 const char* scope_state_to_string(ScopeState i) _const_;
356 ScopeState scope_state_from_string(const char *s) _pure_;
358 const char* service_state_to_string(ServiceState i) _const_;
359 ServiceState service_state_from_string(const char *s) _pure_;
361 const char* slice_state_to_string(SliceState i) _const_;
362 SliceState slice_state_from_string(const char *s) _pure_;
364 const char* socket_state_to_string(SocketState i) _const_;
365 SocketState socket_state_from_string(const char *s) _pure_;
367 const char* swap_state_to_string(SwapState i) _const_;
368 SwapState swap_state_from_string(const char *s) _pure_;
370 const char* target_state_to_string(TargetState i) _const_;
371 TargetState target_state_from_string(const char *s) _pure_;
373 const char *timer_state_to_string(TimerState i) _const_;
374 TimerState timer_state_from_string(const char *s) _pure_;
376 const char *unit_dependency_to_string(UnitDependency i) _const_;
377 UnitDependency unit_dependency_from_string(const char *s) _pure_;