1 /* SPDX-License-Identifier: LGPL-2.1+ */
4 typedef struct Service Service
;
5 typedef struct ServiceFDStore ServiceFDStore
;
7 #include "exit-status.h"
10 #include "ratelimit.h"
14 typedef enum ServiceRestart
{
16 SERVICE_RESTART_ON_SUCCESS
,
17 SERVICE_RESTART_ON_FAILURE
,
18 SERVICE_RESTART_ON_ABNORMAL
,
19 SERVICE_RESTART_ON_WATCHDOG
,
20 SERVICE_RESTART_ON_ABORT
,
21 SERVICE_RESTART_ALWAYS
,
23 _SERVICE_RESTART_INVALID
= -1
26 typedef enum ServiceType
{
27 SERVICE_SIMPLE
, /* we fork and go on right-away (i.e. modern socket activated daemons) */
28 SERVICE_FORKING
, /* forks by itself (i.e. traditional daemons) */
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) */
30 SERVICE_DBUS
, /* we fork and wait until a specific D-Bus name appears on the bus */
31 SERVICE_NOTIFY
, /* we fork and wait until a daemon sends us a ready message with sd_notify() */
32 SERVICE_IDLE
, /* much like simple, but delay exec() until all jobs are dispatched. */
33 SERVICE_EXEC
, /* we fork and wait until we execute exec() (this means our own setup is waited for) */
35 _SERVICE_TYPE_INVALID
= -1
38 typedef enum ServiceExecCommand
{
39 SERVICE_EXEC_START_PRE
,
41 SERVICE_EXEC_START_POST
,
44 SERVICE_EXEC_STOP_POST
,
45 _SERVICE_EXEC_COMMAND_MAX
,
46 _SERVICE_EXEC_COMMAND_INVALID
= -1
49 typedef enum NotifyState
{
55 _NOTIFY_STATE_INVALID
= -1
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. */
60 typedef enum ServiceResult
{
62 SERVICE_FAILURE_RESOURCES
, /* a bit of a misnomer, just our catch-all error for errnos we didn't expect */
63 SERVICE_FAILURE_PROTOCOL
,
64 SERVICE_FAILURE_TIMEOUT
,
65 SERVICE_FAILURE_EXIT_CODE
,
66 SERVICE_FAILURE_SIGNAL
,
67 SERVICE_FAILURE_CORE_DUMP
,
68 SERVICE_FAILURE_WATCHDOG
,
69 SERVICE_FAILURE_START_LIMIT_HIT
,
70 SERVICE_FAILURE_OOM_KILL
,
72 _SERVICE_RESULT_INVALID
= -1
75 struct ServiceFDStore
{
80 sd_event_source
*event_source
;
82 LIST_FIELDS(ServiceFDStore
, fd_store
);
89 ServiceRestart restart
;
90 ExitStatusSet restart_prevent_status
;
91 ExitStatusSet restart_force_status
;
92 ExitStatusSet success_status
;
94 /* If set we'll read the main daemon PID from this file */
98 usec_t timeout_start_usec
;
99 usec_t timeout_stop_usec
;
100 usec_t timeout_abort_usec
;
101 bool timeout_abort_set
;
102 usec_t timeout_clean_usec
;
103 usec_t runtime_max_usec
;
105 dual_timestamp watchdog_timestamp
;
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() */
109 bool watchdog_override_enable
;
110 sd_event_source
*watchdog_event_source
;
112 ExecCommand
* exec_command
[_SERVICE_EXEC_COMMAND_MAX
];
114 ExecContext exec_context
;
115 KillContext kill_context
;
116 CGroupContext cgroup_context
;
118 ServiceState state
, deserialized_state
;
120 /* The exit status of the real main process */
121 ExecStatus main_exec_status
;
123 /* The currently executed control process */
124 ExecCommand
*control_command
;
126 /* The currently executed main process, which may be NULL if
127 * the main process got started via forking mode and not by
129 ExecCommand
*main_command
;
131 /* The ID of the control command currently being executed */
132 ServiceExecCommand control_command_id
;
134 /* Runtime data of the execution context */
135 ExecRuntime
*exec_runtime
;
136 DynamicCreds dynamic_creds
;
138 pid_t main_pid
, control_pid
;
141 bool socket_fd_selinux_context_net
;
143 bool permissions_start_only
;
144 bool root_directory_start_only
;
145 bool remain_after_exit
;
148 /* If we shut down, remember why */
149 ServiceResult result
;
150 ServiceResult reload_result
;
151 ServiceResult clean_result
;
153 bool main_pid_known
:1;
154 bool main_pid_alien
:1;
155 bool bus_name_good
:1;
156 bool forbid_restart
:1;
157 /* Keep restart intention between UNIT_FAILED and UNIT_ACTIVATING */
158 bool will_auto_restart
:1;
159 bool start_timeout_defined
:1;
163 char *bus_name_owner
; /* unique name of the current owner */
168 UnitRef accept_socket
;
170 sd_event_source
*timer_event_source
;
171 PathSpec
*pid_file_pathspec
;
173 NotifyAccess notify_access
;
174 NotifyState notify_state
;
176 sd_event_source
*exec_fd_event_source
;
178 ServiceFDStore
*fd_store
;
180 unsigned n_fd_store_max
;
181 unsigned n_keep_fd_store
;
183 char *usb_function_descriptors
;
184 char *usb_function_strings
;
191 bool flush_n_restarts
;
193 OOMPolicy oom_policy
;
196 static inline usec_t
service_timeout_abort_usec(Service
*s
) {
198 return s
->timeout_abort_set
? s
->timeout_abort_usec
: s
->timeout_stop_usec
;
201 extern const UnitVTable service_vtable
;
203 int service_set_socket_fd(Service
*s
, int fd
, struct Socket
*socket
, bool selinux_context_net
);
204 void service_close_socket_fd(Service
*s
);
206 const char* service_restart_to_string(ServiceRestart i
) _const_
;
207 ServiceRestart
service_restart_from_string(const char *s
) _pure_
;
209 const char* service_type_to_string(ServiceType i
) _const_
;
210 ServiceType
service_type_from_string(const char *s
) _pure_
;
212 const char* service_exec_command_to_string(ServiceExecCommand i
) _const_
;
213 ServiceExecCommand
service_exec_command_from_string(const char *s
) _pure_
;
215 const char* service_exec_ex_command_to_string(ServiceExecCommand i
) _const_
;
216 ServiceExecCommand
service_exec_ex_command_from_string(const char *s
) _pure_
;
218 const char* notify_state_to_string(NotifyState i
) _const_
;
219 NotifyState
notify_state_from_string(const char *s
) _pure_
;
221 const char* service_result_to_string(ServiceResult i
) _const_
;
222 ServiceResult
service_result_from_string(const char *s
) _pure_
;
224 DEFINE_CAST(SERVICE
, Service
);
226 #define STATUS_TEXT_MAX (16U*1024U)