chiark / gitweb /
Make sure that keys are properly removed from hashmap
[elogind.git] / src / core / service.h
1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
2
3 #pragma once
4
5 /***
6   This file is part of systemd.
7
8   Copyright 2010 Lennart Poettering
9
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.
14
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.
19
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/>.
22 ***/
23
24 typedef struct Service Service;
25
26 #include "unit.h"
27 #include "path.h"
28 #include "ratelimit.h"
29 #include "kill.h"
30 #include "exit-status.h"
31
32 typedef enum ServiceState {
33         SERVICE_DEAD,
34         SERVICE_START_PRE,
35         SERVICE_START,
36         SERVICE_START_POST,
37         SERVICE_RUNNING,
38         SERVICE_EXITED,            /* Nothing is running anymore, but RemainAfterExit is true hence this is OK */
39         SERVICE_RELOAD,
40         SERVICE_STOP,              /* No STOP_PRE state, instead just register multiple STOP executables */
41         SERVICE_STOP_SIGTERM,
42         SERVICE_STOP_SIGKILL,
43         SERVICE_STOP_POST,
44         SERVICE_FINAL_SIGTERM,     /* In case the STOP_POST executable hangs, we shoot that down, too */
45         SERVICE_FINAL_SIGKILL,
46         SERVICE_FAILED,
47         SERVICE_AUTO_RESTART,
48         _SERVICE_STATE_MAX,
49         _SERVICE_STATE_INVALID = -1
50 } ServiceState;
51
52 typedef enum ServiceRestart {
53         SERVICE_RESTART_NO,
54         SERVICE_RESTART_ON_SUCCESS,
55         SERVICE_RESTART_ON_FAILURE,
56         SERVICE_RESTART_ON_WATCHDOG,
57         SERVICE_RESTART_ON_ABORT,
58         SERVICE_RESTART_ALWAYS,
59         _SERVICE_RESTART_MAX,
60         _SERVICE_RESTART_INVALID = -1
61 } ServiceRestart;
62
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. */
70         _SERVICE_TYPE_MAX,
71         _SERVICE_TYPE_INVALID = -1
72 } ServiceType;
73
74 typedef enum ServiceExecCommand {
75         SERVICE_EXEC_START_PRE,
76         SERVICE_EXEC_START,
77         SERVICE_EXEC_START_POST,
78         SERVICE_EXEC_RELOAD,
79         SERVICE_EXEC_STOP,
80         SERVICE_EXEC_STOP_POST,
81         _SERVICE_EXEC_COMMAND_MAX,
82         _SERVICE_EXEC_COMMAND_INVALID = -1
83 } ServiceExecCommand;
84
85 typedef enum NotifyAccess {
86         NOTIFY_NONE,
87         NOTIFY_ALL,
88         NOTIFY_MAIN,
89         _NOTIFY_ACCESS_MAX,
90         _NOTIFY_ACCESS_INVALID = -1
91 } NotifyAccess;
92
93 typedef enum ServiceResult {
94         SERVICE_SUCCESS,
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,
102         _SERVICE_RESULT_MAX,
103         _SERVICE_RESULT_INVALID = -1
104 } ServiceResult;
105
106 typedef enum FailureAction {
107         SERVICE_FAILURE_ACTION_NONE,
108         SERVICE_FAILURE_ACTION_REBOOT,
109         SERVICE_FAILURE_ACTION_REBOOT_FORCE,
110         SERVICE_FAILURE_ACTION_REBOOT_IMMEDIATE,
111         _SERVICE_FAILURE_ACTION_MAX,
112         _SERVICE_FAILURE_ACTION_INVALID = -1
113 } FailureAction;
114
115 struct Service {
116         Unit meta;
117
118         ServiceType type;
119         ServiceRestart restart;
120         ExitStatusSet restart_ignore_status;
121         ExitStatusSet success_status;
122
123         /* If set we'll read the main daemon PID from this file */
124         char *pid_file;
125
126         usec_t restart_usec;
127         usec_t timeout_start_usec;
128         usec_t timeout_stop_usec;
129
130         dual_timestamp watchdog_timestamp;
131         usec_t watchdog_usec;
132         sd_event_source *watchdog_event_source;
133
134         ExecCommand* exec_command[_SERVICE_EXEC_COMMAND_MAX];
135
136         ExecContext exec_context;
137         KillContext kill_context;
138         CGroupContext cgroup_context;
139
140         ServiceState state, deserialized_state;
141
142         /* The exit status of the real main process */
143         ExecStatus main_exec_status;
144
145         /* The currently executed control process */
146         ExecCommand *control_command;
147
148         /* The currently executed main process, which may be NULL if
149          * the main process got started via forking mode and not by
150          * us */
151         ExecCommand *main_command;
152
153         /* The ID of the control command currently being executed */
154         ServiceExecCommand control_command_id;
155
156         /* Runtime data of the execution context */
157         ExecRuntime *exec_runtime;
158
159         pid_t main_pid, control_pid;
160         int socket_fd;
161
162         bool permissions_start_only;
163         bool root_directory_start_only;
164         bool remain_after_exit;
165         bool guess_main_pid;
166
167         /* If we shut down, remember why */
168         ServiceResult result;
169         ServiceResult reload_result;
170
171         bool main_pid_known:1;
172         bool main_pid_alien:1;
173         bool bus_name_good:1;
174         bool forbid_restart:1;
175         bool start_timeout_defined:1;
176 #ifdef HAVE_SYSV_COMPAT
177         bool is_sysv:1;
178         bool sysv_has_lsb:1;
179         bool sysv_enabled:1;
180         int sysv_start_priority_from_rcnd;
181         int sysv_start_priority;
182
183         char *sysv_runlevels;
184 #endif
185
186         char *bus_name;
187
188         char *status_text;
189
190         FailureAction failure_action;
191
192         RateLimit start_limit;
193         FailureAction start_limit_action;
194         char *reboot_arg;
195
196         UnitRef accept_socket;
197
198         sd_event_source *timer_event_source;
199         PathSpec *pid_file_pathspec;
200
201         NotifyAccess notify_access;
202 };
203
204 extern const UnitVTable service_vtable;
205
206 struct Socket;
207
208 int service_set_socket_fd(Service *s, int fd, struct Socket *socket);
209
210 const char* service_state_to_string(ServiceState i) _const_;
211 ServiceState service_state_from_string(const char *s) _pure_;
212
213 const char* service_restart_to_string(ServiceRestart i) _const_;
214 ServiceRestart service_restart_from_string(const char *s) _pure_;
215
216 const char* service_type_to_string(ServiceType i) _const_;
217 ServiceType service_type_from_string(const char *s) _pure_;
218
219 const char* service_exec_command_to_string(ServiceExecCommand i) _const_;
220 ServiceExecCommand service_exec_command_from_string(const char *s) _pure_;
221
222 const char* notify_access_to_string(NotifyAccess i) _const_;
223 NotifyAccess notify_access_from_string(const char *s) _pure_;
224
225 const char* service_result_to_string(ServiceResult i) _const_;
226 ServiceResult service_result_from_string(const char *s) _pure_;
227
228 const char* failure_action_to_string(FailureAction i) _const_;
229 FailureAction failure_action_from_string(const char *s) _pure_;