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"
30 #include "exit-status.h"
31 #include "failure-action.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 */
42 SERVICE_STOP_SIGABRT, /* Watchdog timeout */
46 SERVICE_FINAL_SIGTERM, /* In case the STOP_POST executable hangs, we shoot that down, too */
47 SERVICE_FINAL_SIGKILL,
51 _SERVICE_STATE_INVALID = -1
54 typedef enum ServiceRestart {
56 SERVICE_RESTART_ON_SUCCESS,
57 SERVICE_RESTART_ON_FAILURE,
58 SERVICE_RESTART_ON_ABNORMAL,
59 SERVICE_RESTART_ON_WATCHDOG,
60 SERVICE_RESTART_ON_ABORT,
61 SERVICE_RESTART_ALWAYS,
63 _SERVICE_RESTART_INVALID = -1
66 typedef enum ServiceType {
67 SERVICE_SIMPLE, /* we fork and go on right-away (i.e. modern socket activated daemons) */
68 SERVICE_FORKING, /* forks by itself (i.e. traditional daemons) */
69 SERVICE_ONESHOT, /* we fork and wait until the program finishes (i.e. programs like fsck which run and need to finish before we continue) */
70 SERVICE_DBUS, /* we fork and wait until a specific D-Bus name appears on the bus */
71 SERVICE_NOTIFY, /* we fork and wait until a daemon sends us a ready message with sd_notify() */
72 SERVICE_IDLE, /* much like simple, but delay exec() until all jobs are dispatched. */
74 _SERVICE_TYPE_INVALID = -1
77 typedef enum ServiceExecCommand {
78 SERVICE_EXEC_START_PRE,
80 SERVICE_EXEC_START_POST,
83 SERVICE_EXEC_STOP_POST,
84 _SERVICE_EXEC_COMMAND_MAX,
85 _SERVICE_EXEC_COMMAND_INVALID = -1
88 typedef enum NotifyAccess {
93 _NOTIFY_ACCESS_INVALID = -1
96 typedef enum NotifyState {
102 _NOTIFY_STATE_INVALID = -1
105 typedef enum ServiceResult {
107 SERVICE_FAILURE_RESOURCES,
108 SERVICE_FAILURE_TIMEOUT,
109 SERVICE_FAILURE_EXIT_CODE,
110 SERVICE_FAILURE_SIGNAL,
111 SERVICE_FAILURE_CORE_DUMP,
112 SERVICE_FAILURE_WATCHDOG,
113 SERVICE_FAILURE_START_LIMIT,
115 _SERVICE_RESULT_INVALID = -1
122 ServiceRestart restart;
123 ExitStatusSet restart_prevent_status;
124 ExitStatusSet restart_force_status;
125 ExitStatusSet success_status;
127 /* If set we'll read the main daemon PID from this file */
131 usec_t timeout_start_usec;
132 usec_t timeout_stop_usec;
134 dual_timestamp watchdog_timestamp;
135 usec_t watchdog_usec;
136 sd_event_source *watchdog_event_source;
138 ExecCommand* exec_command[_SERVICE_EXEC_COMMAND_MAX];
140 ExecContext exec_context;
141 KillContext kill_context;
142 CGroupContext cgroup_context;
144 ServiceState state, deserialized_state;
146 /* The exit status of the real main process */
147 ExecStatus main_exec_status;
149 /* The currently executed control process */
150 ExecCommand *control_command;
152 /* The currently executed main process, which may be NULL if
153 * the main process got started via forking mode and not by
155 ExecCommand *main_command;
157 /* The ID of the control command currently being executed */
158 ServiceExecCommand control_command_id;
160 /* Runtime data of the execution context */
161 ExecRuntime *exec_runtime;
163 pid_t main_pid, control_pid;
165 bool socket_fd_selinux_context_net;
169 bool permissions_start_only;
170 bool root_directory_start_only;
171 bool remain_after_exit;
174 /* If we shut down, remember why */
175 ServiceResult result;
176 ServiceResult reload_result;
178 bool main_pid_known:1;
179 bool main_pid_alien:1;
180 bool bus_name_good:1;
181 bool forbid_restart:1;
182 bool start_timeout_defined:1;
189 RateLimit start_limit;
190 FailureAction start_limit_action;
191 FailureAction failure_action;
194 UnitRef accept_socket;
196 sd_event_source *timer_event_source;
197 PathSpec *pid_file_pathspec;
199 NotifyAccess notify_access;
200 NotifyState notify_state;
203 extern const UnitVTable service_vtable;
207 int service_set_socket_fd(Service *s, int fd, struct Socket *socket, bool selinux_context_net);
209 const char* service_state_to_string(ServiceState i) _const_;
210 ServiceState service_state_from_string(const char *s) _pure_;
212 const char* service_restart_to_string(ServiceRestart i) _const_;
213 ServiceRestart service_restart_from_string(const char *s) _pure_;
215 const char* service_type_to_string(ServiceType i) _const_;
216 ServiceType service_type_from_string(const char *s) _pure_;
218 const char* service_exec_command_to_string(ServiceExecCommand i) _const_;
219 ServiceExecCommand service_exec_command_from_string(const char *s) _pure_;
221 const char* notify_access_to_string(NotifyAccess i) _const_;
222 NotifyAccess notify_access_from_string(const char *s) _pure_;
224 const char* notify_state_to_string(NotifyState i) _const_;
225 NotifyState notify_state_from_string(const char *s) _pure_;
227 const char* service_result_to_string(ServiceResult i) _const_;
228 ServiceResult service_result_from_string(const char *s) _pure_;