]>
Commit | Line | Data |
---|---|---|
db9ecf05 | 1 | /* SPDX-License-Identifier: LGPL-2.1-or-later */ |
c2f1db8f | 2 | #pragma once |
5cb5a6ff LP |
3 | |
4 | typedef struct Service Service; | |
a354329f | 5 | typedef struct ServiceFDStore ServiceFDStore; |
5cb5a6ff | 6 | |
71d35b6b TA |
7 | #include "exit-status.h" |
8 | #include "kill.h" | |
9cf3ab0e | 9 | #include "path.h" |
1e2e8133 | 10 | #include "ratelimit.h" |
57b7a260 FS |
11 | #include "socket.h" |
12 | #include "unit.h" | |
5cb5a6ff | 13 | |
034c6ed7 | 14 | typedef enum ServiceRestart { |
525ee6f4 | 15 | SERVICE_RESTART_NO, |
034c6ed7 | 16 | SERVICE_RESTART_ON_SUCCESS, |
50caaedb | 17 | SERVICE_RESTART_ON_FAILURE, |
6cfe2fde | 18 | SERVICE_RESTART_ON_ABNORMAL, |
dc99a976 | 19 | SERVICE_RESTART_ON_WATCHDOG, |
50caaedb | 20 | SERVICE_RESTART_ON_ABORT, |
94f04347 LP |
21 | SERVICE_RESTART_ALWAYS, |
22 | _SERVICE_RESTART_MAX, | |
2d93c20e | 23 | _SERVICE_RESTART_INVALID = -EINVAL, |
034c6ed7 LP |
24 | } ServiceRestart; |
25 | ||
26 | typedef enum ServiceType { | |
05e343b7 | 27 | SERVICE_SIMPLE, /* we fork and go on right-away (i.e. modern socket activated daemons) */ |
1f48cf56 | 28 | SERVICE_FORKING, /* forks by itself (i.e. traditional daemons) */ |
34e9ba66 | 29 | SERVICE_ONESHOT, /* we fork and wait until the program finishes (i.e. programs like fsck which run and need to finish before we continue) */ |
05e343b7 | 30 | SERVICE_DBUS, /* we fork and wait until a specific D-Bus name appears on the bus */ |
8c47c732 | 31 | SERVICE_NOTIFY, /* we fork and wait until a daemon sends us a ready message with sd_notify() */ |
f2b68789 | 32 | SERVICE_IDLE, /* much like simple, but delay exec() until all jobs are dispatched. */ |
5686391b | 33 | SERVICE_EXEC, /* we fork and wait until we execute exec() (this means our own setup is waited for) */ |
94f04347 | 34 | _SERVICE_TYPE_MAX, |
2d93c20e | 35 | _SERVICE_TYPE_INVALID = -EINVAL, |
034c6ed7 | 36 | } ServiceType; |
5cb5a6ff | 37 | |
596e4470 HC |
38 | typedef enum ServiceExitType { |
39 | SERVICE_EXIT_MAIN, /* we consider the main PID when deciding if the service exited */ | |
40 | SERVICE_EXIT_CGROUP, /* we wait for the last process in the cgroup to exit */ | |
41 | _SERVICE_EXIT_TYPE_MAX, | |
42 | _SERVICE_EXIT_TYPE_INVALID = -EINVAL, | |
43 | } ServiceExitType; | |
44 | ||
5cb5a6ff | 45 | typedef enum ServiceExecCommand { |
31cd5f63 | 46 | SERVICE_EXEC_CONDITION, |
5cb5a6ff LP |
47 | SERVICE_EXEC_START_PRE, |
48 | SERVICE_EXEC_START, | |
49 | SERVICE_EXEC_START_POST, | |
5cb5a6ff | 50 | SERVICE_EXEC_RELOAD, |
5cb5a6ff LP |
51 | SERVICE_EXEC_STOP, |
52 | SERVICE_EXEC_STOP_POST, | |
e537352b | 53 | _SERVICE_EXEC_COMMAND_MAX, |
2d93c20e | 54 | _SERVICE_EXEC_COMMAND_INVALID = -EINVAL, |
5cb5a6ff LP |
55 | } ServiceExecCommand; |
56 | ||
308d72dc LP |
57 | typedef enum NotifyState { |
58 | NOTIFY_UNKNOWN, | |
59 | NOTIFY_READY, | |
60 | NOTIFY_RELOADING, | |
61 | NOTIFY_STOPPING, | |
62 | _NOTIFY_STATE_MAX, | |
2d93c20e | 63 | _NOTIFY_STATE_INVALID = -EINVAL, |
308d72dc LP |
64 | } NotifyState; |
65 | ||
a4e26faf JW |
66 | /* The values of this enum are referenced in man/systemd.exec.xml and src/shared/bus-unit-util.c. |
67 | * Update those sources for each change to this enum. */ | |
f42806df LP |
68 | typedef enum ServiceResult { |
69 | SERVICE_SUCCESS, | |
0b2de9d9 | 70 | SERVICE_FAILURE_RESOURCES, /* a bit of a misnomer, just our catch-all error for errnos we didn't expect */ |
c35755fb | 71 | SERVICE_FAILURE_PROTOCOL, |
f42806df LP |
72 | SERVICE_FAILURE_TIMEOUT, |
73 | SERVICE_FAILURE_EXIT_CODE, | |
74 | SERVICE_FAILURE_SIGNAL, | |
75 | SERVICE_FAILURE_CORE_DUMP, | |
bb242b7b | 76 | SERVICE_FAILURE_WATCHDOG, |
07299350 | 77 | SERVICE_FAILURE_START_LIMIT_HIT, |
38c41427 | 78 | SERVICE_FAILURE_OOM_KILL, /* OOM Kill by the Kernel or systemd-oomd */ |
31cd5f63 | 79 | SERVICE_SKIP_CONDITION, |
f42806df | 80 | _SERVICE_RESULT_MAX, |
2d93c20e | 81 | _SERVICE_RESULT_INVALID = -EINVAL, |
f42806df LP |
82 | } ServiceResult; |
83 | ||
bf760801 JK |
84 | typedef enum ServiceTimeoutFailureMode { |
85 | SERVICE_TIMEOUT_TERMINATE, | |
86 | SERVICE_TIMEOUT_ABORT, | |
87 | SERVICE_TIMEOUT_KILL, | |
88 | _SERVICE_TIMEOUT_FAILURE_MODE_MAX, | |
2d93c20e | 89 | _SERVICE_TIMEOUT_FAILURE_MODE_INVALID = -EINVAL, |
bf760801 JK |
90 | } ServiceTimeoutFailureMode; |
91 | ||
a354329f LP |
92 | struct ServiceFDStore { |
93 | Service *service; | |
94 | ||
95 | int fd; | |
8dd4c05b | 96 | char *fdname; |
a354329f | 97 | sd_event_source *event_source; |
30520492 | 98 | bool do_poll; |
a354329f LP |
99 | |
100 | LIST_FIELDS(ServiceFDStore, fd_store); | |
101 | }; | |
102 | ||
5cb5a6ff | 103 | struct Service { |
ac155bb8 | 104 | Unit meta; |
5cb5a6ff | 105 | |
034c6ed7 | 106 | ServiceType type; |
596e4470 | 107 | ServiceExitType exit_type; |
034c6ed7 | 108 | ServiceRestart restart; |
37520c1b LP |
109 | ExitStatusSet restart_prevent_status; |
110 | ExitStatusSet restart_force_status; | |
96342de6 | 111 | ExitStatusSet success_status; |
034c6ed7 LP |
112 | |
113 | /* If set we'll read the main daemon PID from this file */ | |
114 | char *pid_file; | |
115 | ||
116 | usec_t restart_usec; | |
d568a335 MS |
117 | usec_t timeout_start_usec; |
118 | usec_t timeout_stop_usec; | |
dc653bf4 | 119 | usec_t timeout_abort_usec; |
54c1a6ab | 120 | bool timeout_abort_set; |
36c16a7c | 121 | usec_t runtime_max_usec; |
5918a933 | 122 | usec_t runtime_rand_extra_usec; |
bf760801 JK |
123 | ServiceTimeoutFailureMode timeout_start_failure_mode; |
124 | ServiceTimeoutFailureMode timeout_stop_failure_mode; | |
5cb5a6ff | 125 | |
a6927d7f | 126 | dual_timestamp watchdog_timestamp; |
aa8c4bbf LP |
127 | usec_t watchdog_usec; /* the requested watchdog timeout in the unit file */ |
128 | usec_t watchdog_original_usec; /* the watchdog timeout that was in effect when the unit was started, i.e. the timeout the forked off processes currently see */ | |
129 | usec_t watchdog_override_usec; /* the watchdog timeout requested by the service itself through sd_notify() */ | |
2787d83c | 130 | bool watchdog_override_enable; |
718db961 | 131 | sd_event_source *watchdog_event_source; |
a6927d7f | 132 | |
e537352b | 133 | ExecCommand* exec_command[_SERVICE_EXEC_COMMAND_MAX]; |
4819ff03 | 134 | |
5cb5a6ff | 135 | ExecContext exec_context; |
4819ff03 | 136 | KillContext kill_context; |
4ad49000 | 137 | CGroupContext cgroup_context; |
5cb5a6ff | 138 | |
a16e1123 | 139 | ServiceState state, deserialized_state; |
034c6ed7 | 140 | |
867b3b7d | 141 | /* The exit status of the real main process */ |
034c6ed7 LP |
142 | ExecStatus main_exec_status; |
143 | ||
867b3b7d | 144 | /* The currently executed control process */ |
034c6ed7 | 145 | ExecCommand *control_command; |
867b3b7d LP |
146 | |
147 | /* The currently executed main process, which may be NULL if | |
148 | * the main process got started via forking mode and not by | |
149 | * us */ | |
150 | ExecCommand *main_command; | |
151 | ||
152 | /* The ID of the control command currently being executed */ | |
a16e1123 | 153 | ServiceExecCommand control_command_id; |
867b3b7d | 154 | |
613b411c LP |
155 | /* Runtime data of the execution context */ |
156 | ExecRuntime *exec_runtime; | |
29206d46 | 157 | DynamicCreds dynamic_creds; |
613b411c | 158 | |
034c6ed7 | 159 | pid_t main_pid, control_pid; |
3fabebf4 LP |
160 | |
161 | /* if we are a socket activated service instance, store information of the connection/peer/socket */ | |
07459bb6 | 162 | int socket_fd; |
3fabebf4 LP |
163 | SocketPeer *socket_peer; |
164 | UnitRef accept_socket; | |
16115b0a | 165 | bool socket_fd_selinux_context_net; |
8fe914ec LP |
166 | |
167 | bool permissions_start_only; | |
168 | bool root_directory_start_only; | |
02ee865a | 169 | bool remain_after_exit; |
3185a36b | 170 | bool guess_main_pid; |
8fe914ec | 171 | |
05e343b7 | 172 | /* If we shut down, remember why */ |
f42806df LP |
173 | ServiceResult result; |
174 | ServiceResult reload_result; | |
4c2f5842 | 175 | ServiceResult clean_result; |
e2f3b44c | 176 | |
5de6b302 | 177 | bool main_pid_known:1; |
6dfa5494 | 178 | bool main_pid_alien:1; |
05e343b7 | 179 | bool bus_name_good:1; |
47342320 | 180 | bool forbid_restart:1; |
deb4e708 MK |
181 | /* Keep restart intention between UNIT_FAILED and UNIT_ACTIVATING */ |
182 | bool will_auto_restart:1; | |
d568a335 | 183 | bool start_timeout_defined:1; |
0a6991e0 | 184 | bool exec_fd_hot:1; |
2c4104f0 | 185 | |
05e343b7 | 186 | char *bus_name; |
d8ccf5fd | 187 | char *bus_name_owner; /* unique name of the current owner */ |
05e343b7 | 188 | |
8c47c732 | 189 | char *status_text; |
4774e357 | 190 | int status_errno; |
8c47c732 | 191 | |
718db961 | 192 | sd_event_source *timer_event_source; |
3a111838 | 193 | PathSpec *pid_file_pathspec; |
8fe914ec LP |
194 | |
195 | NotifyAccess notify_access; | |
308d72dc | 196 | NotifyState notify_state; |
a354329f | 197 | |
e39eb045 LP |
198 | sd_bus_slot *bus_name_pid_lookup_slot; |
199 | ||
5686391b LP |
200 | sd_event_source *exec_fd_event_source; |
201 | ||
a354329f | 202 | ServiceFDStore *fd_store; |
da6053d0 | 203 | size_t n_fd_store; |
a354329f | 204 | unsigned n_fd_store_max; |
7eb2a8a1 | 205 | unsigned n_keep_fd_store; |
6b7e5923 PS |
206 | |
207 | char *usb_function_descriptors; | |
208 | char *usb_function_strings; | |
a34ceba6 LP |
209 | |
210 | int stdin_fd; | |
211 | int stdout_fd; | |
212 | int stderr_fd; | |
7a0019d3 LP |
213 | |
214 | unsigned n_restarts; | |
215 | bool flush_n_restarts; | |
afcfaa69 LP |
216 | |
217 | OOMPolicy oom_policy; | |
5cb5a6ff LP |
218 | }; |
219 | ||
dc653bf4 | 220 | static inline usec_t service_timeout_abort_usec(Service *s) { |
9c79f0e0 | 221 | assert(s); |
dc653bf4 JK |
222 | return s->timeout_abort_set ? s->timeout_abort_usec : s->timeout_stop_usec; |
223 | } | |
224 | ||
4793c310 CD |
225 | static inline usec_t service_get_watchdog_usec(Service *s) { |
226 | assert(s); | |
227 | return s->watchdog_override_enable ? s->watchdog_override_usec : s->watchdog_original_usec; | |
228 | } | |
229 | ||
47be870b | 230 | extern const UnitVTable service_vtable; |
5cb5a6ff | 231 | |
3fabebf4 | 232 | int service_set_socket_fd(Service *s, int fd, struct Socket *socket, struct SocketPeer *peer, bool selinux_context_net); |
3e7a1f50 | 233 | void service_close_socket_fd(Service *s); |
4f2d528d | 234 | |
44a6b1b6 ZJS |
235 | const char* service_restart_to_string(ServiceRestart i) _const_; |
236 | ServiceRestart service_restart_from_string(const char *s) _pure_; | |
94f04347 | 237 | |
44a6b1b6 ZJS |
238 | const char* service_type_to_string(ServiceType i) _const_; |
239 | ServiceType service_type_from_string(const char *s) _pure_; | |
94f04347 | 240 | |
596e4470 HC |
241 | const char* service_exit_type_to_string(ServiceExitType i) _const_; |
242 | ServiceExitType service_exit_type_from_string(const char *s) _pure_; | |
243 | ||
44a6b1b6 ZJS |
244 | const char* service_exec_command_to_string(ServiceExecCommand i) _const_; |
245 | ServiceExecCommand service_exec_command_from_string(const char *s) _pure_; | |
94f04347 | 246 | |
b3d59367 AZ |
247 | const char* service_exec_ex_command_to_string(ServiceExecCommand i) _const_; |
248 | ServiceExecCommand service_exec_ex_command_from_string(const char *s) _pure_; | |
249 | ||
308d72dc LP |
250 | const char* notify_state_to_string(NotifyState i) _const_; |
251 | NotifyState notify_state_from_string(const char *s) _pure_; | |
252 | ||
44a6b1b6 ZJS |
253 | const char* service_result_to_string(ServiceResult i) _const_; |
254 | ServiceResult service_result_from_string(const char *s) _pure_; | |
57b7a260 | 255 | |
bf760801 JK |
256 | const char* service_timeout_failure_mode_to_string(ServiceTimeoutFailureMode i) _const_; |
257 | ServiceTimeoutFailureMode service_timeout_failure_mode_from_string(const char *s) _pure_; | |
258 | ||
57b7a260 | 259 | DEFINE_CAST(SERVICE, Service); |
3eac1bca LP |
260 | |
261 | #define STATUS_TEXT_MAX (16U*1024U) | |
35243b77 ZJS |
262 | |
263 | /* Only exported for unit tests */ | |
264 | int service_deserialize_exec_command(Unit *u, const char *key, const char *value); |