]>
Commit | Line | Data |
---|---|---|
53e1b683 | 1 | /* SPDX-License-Identifier: LGPL-2.1+ */ |
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, | |
23 | _SERVICE_RESTART_INVALID = -1 | |
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 LP |
34 | _SERVICE_TYPE_MAX, |
35 | _SERVICE_TYPE_INVALID = -1 | |
034c6ed7 | 36 | } ServiceType; |
5cb5a6ff LP |
37 | |
38 | typedef enum ServiceExecCommand { | |
39 | SERVICE_EXEC_START_PRE, | |
40 | SERVICE_EXEC_START, | |
41 | SERVICE_EXEC_START_POST, | |
5cb5a6ff | 42 | SERVICE_EXEC_RELOAD, |
5cb5a6ff LP |
43 | SERVICE_EXEC_STOP, |
44 | SERVICE_EXEC_STOP_POST, | |
e537352b LP |
45 | _SERVICE_EXEC_COMMAND_MAX, |
46 | _SERVICE_EXEC_COMMAND_INVALID = -1 | |
5cb5a6ff LP |
47 | } ServiceExecCommand; |
48 | ||
308d72dc LP |
49 | typedef enum NotifyState { |
50 | NOTIFY_UNKNOWN, | |
51 | NOTIFY_READY, | |
52 | NOTIFY_RELOADING, | |
53 | NOTIFY_STOPPING, | |
54 | _NOTIFY_STATE_MAX, | |
55 | _NOTIFY_STATE_INVALID = -1 | |
56 | } NotifyState; | |
57 | ||
a4e26faf JW |
58 | /* The values of this enum are referenced in man/systemd.exec.xml and src/shared/bus-unit-util.c. |
59 | * Update those sources for each change to this enum. */ | |
f42806df LP |
60 | typedef enum ServiceResult { |
61 | SERVICE_SUCCESS, | |
0b2de9d9 | 62 | SERVICE_FAILURE_RESOURCES, /* a bit of a misnomer, just our catch-all error for errnos we didn't expect */ |
c35755fb | 63 | SERVICE_FAILURE_PROTOCOL, |
f42806df LP |
64 | SERVICE_FAILURE_TIMEOUT, |
65 | SERVICE_FAILURE_EXIT_CODE, | |
66 | SERVICE_FAILURE_SIGNAL, | |
67 | SERVICE_FAILURE_CORE_DUMP, | |
bb242b7b | 68 | SERVICE_FAILURE_WATCHDOG, |
07299350 | 69 | SERVICE_FAILURE_START_LIMIT_HIT, |
afcfaa69 | 70 | SERVICE_FAILURE_OOM_KILL, |
f42806df LP |
71 | _SERVICE_RESULT_MAX, |
72 | _SERVICE_RESULT_INVALID = -1 | |
73 | } ServiceResult; | |
74 | ||
a354329f LP |
75 | struct ServiceFDStore { |
76 | Service *service; | |
77 | ||
78 | int fd; | |
8dd4c05b | 79 | char *fdname; |
a354329f LP |
80 | sd_event_source *event_source; |
81 | ||
82 | LIST_FIELDS(ServiceFDStore, fd_store); | |
83 | }; | |
84 | ||
5cb5a6ff | 85 | struct Service { |
ac155bb8 | 86 | Unit meta; |
5cb5a6ff | 87 | |
034c6ed7 LP |
88 | ServiceType type; |
89 | ServiceRestart restart; | |
37520c1b LP |
90 | ExitStatusSet restart_prevent_status; |
91 | ExitStatusSet restart_force_status; | |
96342de6 | 92 | ExitStatusSet success_status; |
034c6ed7 LP |
93 | |
94 | /* If set we'll read the main daemon PID from this file */ | |
95 | char *pid_file; | |
96 | ||
97 | usec_t restart_usec; | |
d568a335 MS |
98 | usec_t timeout_start_usec; |
99 | usec_t timeout_stop_usec; | |
dc653bf4 | 100 | usec_t timeout_abort_usec; |
54c1a6ab | 101 | bool timeout_abort_set; |
4c2f5842 | 102 | usec_t timeout_clean_usec; |
36c16a7c | 103 | usec_t runtime_max_usec; |
5cb5a6ff | 104 | |
a6927d7f | 105 | dual_timestamp watchdog_timestamp; |
aa8c4bbf LP |
106 | usec_t watchdog_usec; /* the requested watchdog timeout in the unit file */ |
107 | 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 */ | |
108 | usec_t watchdog_override_usec; /* the watchdog timeout requested by the service itself through sd_notify() */ | |
2787d83c | 109 | bool watchdog_override_enable; |
718db961 | 110 | sd_event_source *watchdog_event_source; |
a6927d7f | 111 | |
e537352b | 112 | ExecCommand* exec_command[_SERVICE_EXEC_COMMAND_MAX]; |
4819ff03 | 113 | |
5cb5a6ff | 114 | ExecContext exec_context; |
4819ff03 | 115 | KillContext kill_context; |
4ad49000 | 116 | CGroupContext cgroup_context; |
5cb5a6ff | 117 | |
a16e1123 | 118 | ServiceState state, deserialized_state; |
034c6ed7 | 119 | |
867b3b7d | 120 | /* The exit status of the real main process */ |
034c6ed7 LP |
121 | ExecStatus main_exec_status; |
122 | ||
867b3b7d | 123 | /* The currently executed control process */ |
034c6ed7 | 124 | ExecCommand *control_command; |
867b3b7d LP |
125 | |
126 | /* The currently executed main process, which may be NULL if | |
127 | * the main process got started via forking mode and not by | |
128 | * us */ | |
129 | ExecCommand *main_command; | |
130 | ||
131 | /* The ID of the control command currently being executed */ | |
a16e1123 | 132 | ServiceExecCommand control_command_id; |
867b3b7d | 133 | |
613b411c LP |
134 | /* Runtime data of the execution context */ |
135 | ExecRuntime *exec_runtime; | |
29206d46 | 136 | DynamicCreds dynamic_creds; |
613b411c | 137 | |
034c6ed7 | 138 | pid_t main_pid, control_pid; |
07459bb6 | 139 | int socket_fd; |
9d565427 | 140 | SocketPeer *peer; |
16115b0a | 141 | bool socket_fd_selinux_context_net; |
8fe914ec LP |
142 | |
143 | bool permissions_start_only; | |
144 | bool root_directory_start_only; | |
02ee865a | 145 | bool remain_after_exit; |
3185a36b | 146 | bool guess_main_pid; |
8fe914ec | 147 | |
05e343b7 | 148 | /* If we shut down, remember why */ |
f42806df LP |
149 | ServiceResult result; |
150 | ServiceResult reload_result; | |
4c2f5842 | 151 | ServiceResult clean_result; |
e2f3b44c | 152 | |
5de6b302 | 153 | bool main_pid_known:1; |
6dfa5494 | 154 | bool main_pid_alien:1; |
05e343b7 | 155 | bool bus_name_good:1; |
47342320 | 156 | bool forbid_restart:1; |
deb4e708 MK |
157 | /* Keep restart intention between UNIT_FAILED and UNIT_ACTIVATING */ |
158 | bool will_auto_restart:1; | |
d568a335 | 159 | bool start_timeout_defined:1; |
0a6991e0 | 160 | bool exec_fd_hot:1; |
2c4104f0 | 161 | |
05e343b7 | 162 | char *bus_name; |
d8ccf5fd | 163 | char *bus_name_owner; /* unique name of the current owner */ |
05e343b7 | 164 | |
8c47c732 | 165 | char *status_text; |
4774e357 | 166 | int status_errno; |
8c47c732 | 167 | |
57020a3a | 168 | UnitRef accept_socket; |
4f2d528d | 169 | |
718db961 | 170 | sd_event_source *timer_event_source; |
3a111838 | 171 | PathSpec *pid_file_pathspec; |
8fe914ec LP |
172 | |
173 | NotifyAccess notify_access; | |
308d72dc | 174 | NotifyState notify_state; |
a354329f | 175 | |
5686391b LP |
176 | sd_event_source *exec_fd_event_source; |
177 | ||
a354329f | 178 | ServiceFDStore *fd_store; |
da6053d0 | 179 | size_t n_fd_store; |
a354329f | 180 | unsigned n_fd_store_max; |
7eb2a8a1 | 181 | unsigned n_keep_fd_store; |
6b7e5923 PS |
182 | |
183 | char *usb_function_descriptors; | |
184 | char *usb_function_strings; | |
a34ceba6 LP |
185 | |
186 | int stdin_fd; | |
187 | int stdout_fd; | |
188 | int stderr_fd; | |
7a0019d3 LP |
189 | |
190 | unsigned n_restarts; | |
191 | bool flush_n_restarts; | |
afcfaa69 LP |
192 | |
193 | OOMPolicy oom_policy; | |
5cb5a6ff LP |
194 | }; |
195 | ||
dc653bf4 | 196 | static inline usec_t service_timeout_abort_usec(Service *s) { |
9c79f0e0 | 197 | assert(s); |
dc653bf4 JK |
198 | return s->timeout_abort_set ? s->timeout_abort_usec : s->timeout_stop_usec; |
199 | } | |
200 | ||
47be870b | 201 | extern const UnitVTable service_vtable; |
5cb5a6ff | 202 | |
16115b0a | 203 | int service_set_socket_fd(Service *s, int fd, struct Socket *socket, bool selinux_context_net); |
3e7a1f50 | 204 | void service_close_socket_fd(Service *s); |
4f2d528d | 205 | |
44a6b1b6 ZJS |
206 | const char* service_restart_to_string(ServiceRestart i) _const_; |
207 | ServiceRestart service_restart_from_string(const char *s) _pure_; | |
94f04347 | 208 | |
44a6b1b6 ZJS |
209 | const char* service_type_to_string(ServiceType i) _const_; |
210 | ServiceType service_type_from_string(const char *s) _pure_; | |
94f04347 | 211 | |
44a6b1b6 ZJS |
212 | const char* service_exec_command_to_string(ServiceExecCommand i) _const_; |
213 | ServiceExecCommand service_exec_command_from_string(const char *s) _pure_; | |
94f04347 | 214 | |
b3d59367 AZ |
215 | const char* service_exec_ex_command_to_string(ServiceExecCommand i) _const_; |
216 | ServiceExecCommand service_exec_ex_command_from_string(const char *s) _pure_; | |
217 | ||
308d72dc LP |
218 | const char* notify_state_to_string(NotifyState i) _const_; |
219 | NotifyState notify_state_from_string(const char *s) _pure_; | |
220 | ||
44a6b1b6 ZJS |
221 | const char* service_result_to_string(ServiceResult i) _const_; |
222 | ServiceResult service_result_from_string(const char *s) _pure_; | |
57b7a260 FS |
223 | |
224 | DEFINE_CAST(SERVICE, Service); | |
3eac1bca LP |
225 | |
226 | #define STATUS_TEXT_MAX (16U*1024U) |