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/>.
24 typedef struct Service Service;
28 #include "ratelimit.h"
31 #include "exit-status.h"
33 typedef enum ServiceState {
39 SERVICE_EXITED, /* Nothing is running anymore, but RemainAfterExit is true hence this is OK */
41 SERVICE_STOP, /* No STOP_PRE state, instead just register multiple STOP executables */
45 SERVICE_FINAL_SIGTERM, /* In case the STOP_POST executable hangs, we shoot that down, too */
46 SERVICE_FINAL_SIGKILL,
50 _SERVICE_STATE_INVALID = -1
53 typedef enum ServiceRestart {
55 SERVICE_RESTART_ON_SUCCESS,
56 SERVICE_RESTART_ON_FAILURE,
57 SERVICE_RESTART_ON_ABORT,
58 SERVICE_RESTART_ALWAYS,
60 _SERVICE_RESTART_INVALID = -1
63 typedef enum ServiceType {
64 SERVICE_SIMPLE, /* we fork and go on right-away (i.e. modern socket activated daemons) */
65 SERVICE_FORKING, /* forks by itself (i.e. traditional daemons) */
66 SERVICE_ONESHOT, /* we fork and wait until the program finishes (i.e. programs like fsck which run and need to finish before we continue) */
67 SERVICE_DBUS, /* we fork and wait until a specific D-Bus name appears on the bus */
68 SERVICE_NOTIFY, /* we fork and wait until a daemon sends us a ready message with sd_notify() */
69 SERVICE_IDLE, /* much like simple, but delay exec() until all jobs are dispatched. */
71 _SERVICE_TYPE_INVALID = -1
74 typedef enum ServiceExecCommand {
75 SERVICE_EXEC_START_PRE,
77 SERVICE_EXEC_START_POST,
80 SERVICE_EXEC_STOP_POST,
81 _SERVICE_EXEC_COMMAND_MAX,
82 _SERVICE_EXEC_COMMAND_INVALID = -1
85 typedef enum NotifyAccess {
90 _NOTIFY_ACCESS_INVALID = -1
93 typedef enum ServiceResult {
95 SERVICE_FAILURE_RESOURCES,
96 SERVICE_FAILURE_TIMEOUT,
97 SERVICE_FAILURE_EXIT_CODE,
98 SERVICE_FAILURE_SIGNAL,
99 SERVICE_FAILURE_CORE_DUMP,
100 SERVICE_FAILURE_WATCHDOG,
101 SERVICE_FAILURE_START_LIMIT,
103 _SERVICE_RESULT_INVALID = -1
106 typedef enum StartLimitAction {
107 SERVICE_START_LIMIT_NONE,
108 SERVICE_START_LIMIT_REBOOT,
109 SERVICE_START_LIMIT_REBOOT_FORCE,
110 SERVICE_START_LIMIT_REBOOT_IMMEDIATE,
111 _SERVICE_START_LIMIT_MAX,
112 _SERVICE_START_LIMIT_INVALID = -1
119 ServiceRestart restart;
120 ExitStatusSet restart_ignore_status;
121 ExitStatusSet success_status;
123 /* If set we'll read the main daemon PID from this file */
127 usec_t timeout_start_usec;
128 usec_t timeout_stop_usec;
130 dual_timestamp watchdog_timestamp;
131 usec_t watchdog_usec;
132 Watch watchdog_watch;
134 ExecCommand* exec_command[_SERVICE_EXEC_COMMAND_MAX];
136 ExecContext exec_context;
137 KillContext kill_context;
138 CGroupContext cgroup_context;
140 ServiceState state, deserialized_state;
142 /* The exit status of the real main process */
143 ExecStatus main_exec_status;
145 /* The currently executed control process */
146 ExecCommand *control_command;
148 /* The currently executed main process, which may be NULL if
149 * the main process got started via forking mode and not by
151 ExecCommand *main_command;
153 /* The ID of the control command currently being executed */
154 ServiceExecCommand control_command_id;
156 pid_t main_pid, control_pid;
161 bool permissions_start_only;
162 bool root_directory_start_only;
163 bool remain_after_exit;
166 /* If we shut down, remember why */
167 ServiceResult result;
168 ServiceResult reload_result;
170 bool main_pid_known:1;
171 bool main_pid_alien:1;
172 bool bus_name_good:1;
173 bool forbid_restart:1;
174 bool got_socket_fd:1;
175 bool start_timeout_defined:1;
176 #ifdef HAVE_SYSV_COMPAT
180 int sysv_start_priority_from_rcnd;
181 int sysv_start_priority;
183 char *sysv_runlevels;
190 RateLimit start_limit;
191 StartLimitAction start_limit_action;
193 UnitRef accept_socket;
196 PathSpec *pid_file_pathspec;
198 NotifyAccess notify_access;
201 extern const UnitVTable service_vtable;
205 int service_set_socket_fd(Service *s, int fd, struct Socket *socket);
207 const char* service_state_to_string(ServiceState i) _const_;
208 ServiceState service_state_from_string(const char *s) _pure_;
210 const char* service_restart_to_string(ServiceRestart i) _const_;
211 ServiceRestart service_restart_from_string(const char *s) _pure_;
213 const char* service_type_to_string(ServiceType i) _const_;
214 ServiceType service_type_from_string(const char *s) _pure_;
216 const char* service_exec_command_to_string(ServiceExecCommand i) _const_;
217 ServiceExecCommand service_exec_command_from_string(const char *s) _pure_;
219 const char* notify_access_to_string(NotifyAccess i) _const_;
220 NotifyAccess notify_access_from_string(const char *s) _pure_;
222 const char* service_result_to_string(ServiceResult i) _const_;
223 ServiceResult service_result_from_string(const char *s) _pure_;
225 const char* start_limit_action_to_string(StartLimitAction i) _const_;
226 StartLimitAction start_limit_action_from_string(const char *s) _pure_;