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;
25 typedef struct ServiceFDStore ServiceFDStore;
28 #include "ratelimit.h"
30 #include "exit-status.h"
32 typedef enum ServiceState {
38 SERVICE_EXITED, /* Nothing is running anymore, but RemainAfterExit is true hence this is OK */
40 SERVICE_STOP, /* No STOP_PRE state, instead just register multiple STOP executables */
41 SERVICE_STOP_SIGABRT, /* Watchdog timeout */
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_ABNORMAL,
58 SERVICE_RESTART_ON_WATCHDOG,
59 SERVICE_RESTART_ON_ABORT,
60 SERVICE_RESTART_ALWAYS,
62 _SERVICE_RESTART_INVALID = -1
65 typedef enum ServiceType {
66 SERVICE_SIMPLE, /* we fork and go on right-away (i.e. modern socket activated daemons) */
67 SERVICE_FORKING, /* forks by itself (i.e. traditional daemons) */
68 SERVICE_ONESHOT, /* we fork and wait until the program finishes (i.e. programs like fsck which run and need to finish before we continue) */
69 SERVICE_DBUS, /* we fork and wait until a specific D-Bus name appears on the bus */
70 SERVICE_NOTIFY, /* we fork and wait until a daemon sends us a ready message with sd_notify() */
71 SERVICE_IDLE, /* much like simple, but delay exec() until all jobs are dispatched. */
73 _SERVICE_TYPE_INVALID = -1
76 typedef enum ServiceExecCommand {
77 SERVICE_EXEC_START_PRE,
79 SERVICE_EXEC_START_POST,
82 SERVICE_EXEC_STOP_POST,
83 _SERVICE_EXEC_COMMAND_MAX,
84 _SERVICE_EXEC_COMMAND_INVALID = -1
87 typedef enum NotifyAccess {
92 _NOTIFY_ACCESS_INVALID = -1
95 typedef enum NotifyState {
101 _NOTIFY_STATE_INVALID = -1
104 typedef enum ServiceResult {
106 SERVICE_FAILURE_RESOURCES,
107 SERVICE_FAILURE_TIMEOUT,
108 SERVICE_FAILURE_EXIT_CODE,
109 SERVICE_FAILURE_SIGNAL,
110 SERVICE_FAILURE_CORE_DUMP,
111 SERVICE_FAILURE_WATCHDOG,
112 SERVICE_FAILURE_START_LIMIT,
114 _SERVICE_RESULT_INVALID = -1
117 struct ServiceFDStore {
121 sd_event_source *event_source;
123 LIST_FIELDS(ServiceFDStore, fd_store);
130 ServiceRestart restart;
131 ExitStatusSet restart_prevent_status;
132 ExitStatusSet restart_force_status;
133 ExitStatusSet success_status;
135 /* If set we'll read the main daemon PID from this file */
139 usec_t timeout_start_usec;
140 usec_t timeout_stop_usec;
142 dual_timestamp watchdog_timestamp;
143 usec_t watchdog_usec;
144 sd_event_source *watchdog_event_source;
146 ExecCommand* exec_command[_SERVICE_EXEC_COMMAND_MAX];
148 ExecContext exec_context;
149 KillContext kill_context;
150 CGroupContext cgroup_context;
152 ServiceState state, deserialized_state;
154 /* The exit status of the real main process */
155 ExecStatus main_exec_status;
157 /* The currently executed control process */
158 ExecCommand *control_command;
160 /* The currently executed main process, which may be NULL if
161 * the main process got started via forking mode and not by
163 ExecCommand *main_command;
165 /* The ID of the control command currently being executed */
166 ServiceExecCommand control_command_id;
168 /* Runtime data of the execution context */
169 ExecRuntime *exec_runtime;
171 pid_t main_pid, control_pid;
173 bool socket_fd_selinux_context_net;
177 bool permissions_start_only;
178 bool root_directory_start_only;
179 bool remain_after_exit;
182 /* If we shut down, remember why */
183 ServiceResult result;
184 ServiceResult reload_result;
186 bool main_pid_known:1;
187 bool main_pid_alien:1;
188 bool bus_name_good:1;
189 bool forbid_restart:1;
190 bool start_timeout_defined:1;
192 bool reset_cpu_usage:1;
199 RateLimit start_limit;
200 FailureAction start_limit_action;
201 FailureAction failure_action;
204 UnitRef accept_socket;
206 sd_event_source *timer_event_source;
207 PathSpec *pid_file_pathspec;
209 NotifyAccess notify_access;
210 NotifyState notify_state;
212 ServiceFDStore *fd_store;
214 unsigned n_fd_store_max;
217 extern const UnitVTable service_vtable;
221 int service_set_socket_fd(Service *s, int fd, struct Socket *socket, bool selinux_context_net);
223 const char* service_state_to_string(ServiceState i) _const_;
224 ServiceState service_state_from_string(const char *s) _pure_;
226 const char* service_restart_to_string(ServiceRestart i) _const_;
227 ServiceRestart service_restart_from_string(const char *s) _pure_;
229 const char* service_type_to_string(ServiceType i) _const_;
230 ServiceType service_type_from_string(const char *s) _pure_;
232 const char* service_exec_command_to_string(ServiceExecCommand i) _const_;
233 ServiceExecCommand service_exec_command_from_string(const char *s) _pure_;
235 const char* notify_access_to_string(NotifyAccess i) _const_;
236 NotifyAccess notify_access_from_string(const char *s) _pure_;
238 const char* notify_state_to_string(NotifyState i) _const_;
239 NotifyState notify_state_from_string(const char *s) _pure_;
241 const char* service_result_to_string(ServiceResult i) _const_;
242 ServiceResult service_result_from_string(const char *s) _pure_;