1 /* SPDX-License-Identifier: LGPL-2.1+ */
5 This file is part of systemd.
7 Copyright 2010 Lennart Poettering
9 systemd is free software; you can redistribute it and/or modify it
10 under the terms of the GNU Lesser General Public License as published by
11 the Free Software Foundation; either version 2.1 of the License, or
12 (at your option) any later version.
14 systemd is distributed in the hope that it will be useful, but
15 WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 Lesser General Public License for more details.
19 You should have received a copy of the GNU Lesser General Public License
20 along with systemd; If not, see <http://www.gnu.org/licenses/>.
23 typedef struct Service Service
;
24 typedef struct ServiceFDStore ServiceFDStore
;
26 #include "exit-status.h"
29 #include "ratelimit.h"
31 typedef enum ServiceRestart
{
33 SERVICE_RESTART_ON_SUCCESS
,
34 SERVICE_RESTART_ON_FAILURE
,
35 SERVICE_RESTART_ON_ABNORMAL
,
36 SERVICE_RESTART_ON_WATCHDOG
,
37 SERVICE_RESTART_ON_ABORT
,
38 SERVICE_RESTART_ALWAYS
,
40 _SERVICE_RESTART_INVALID
= -1
43 typedef enum ServiceType
{
44 SERVICE_SIMPLE
, /* we fork and go on right-away (i.e. modern socket activated daemons) */
45 SERVICE_FORKING
, /* forks by itself (i.e. traditional daemons) */
46 SERVICE_ONESHOT
, /* we fork and wait until the program finishes (i.e. programs like fsck which run and need to finish before we continue) */
47 SERVICE_DBUS
, /* we fork and wait until a specific D-Bus name appears on the bus */
48 SERVICE_NOTIFY
, /* we fork and wait until a daemon sends us a ready message with sd_notify() */
49 SERVICE_IDLE
, /* much like simple, but delay exec() until all jobs are dispatched. */
51 _SERVICE_TYPE_INVALID
= -1
54 typedef enum ServiceExecCommand
{
55 SERVICE_EXEC_START_PRE
,
57 SERVICE_EXEC_START_POST
,
60 SERVICE_EXEC_STOP_POST
,
61 _SERVICE_EXEC_COMMAND_MAX
,
62 _SERVICE_EXEC_COMMAND_INVALID
= -1
65 typedef enum NotifyState
{
71 _NOTIFY_STATE_INVALID
= -1
74 /* The values of this enum are referenced in man/systemd.exec.xml and src/shared/bus-unit-util.c.
75 * Update those sources for each change to this enum. */
76 typedef enum ServiceResult
{
78 SERVICE_FAILURE_RESOURCES
, /* a bit of a misnomer, just our catch-all error for errnos we didn't expect */
79 SERVICE_FAILURE_PROTOCOL
,
80 SERVICE_FAILURE_TIMEOUT
,
81 SERVICE_FAILURE_EXIT_CODE
,
82 SERVICE_FAILURE_SIGNAL
,
83 SERVICE_FAILURE_CORE_DUMP
,
84 SERVICE_FAILURE_WATCHDOG
,
85 SERVICE_FAILURE_START_LIMIT_HIT
,
87 _SERVICE_RESULT_INVALID
= -1
90 struct ServiceFDStore
{
95 sd_event_source
*event_source
;
97 LIST_FIELDS(ServiceFDStore
, fd_store
);
104 ServiceRestart restart
;
105 ExitStatusSet restart_prevent_status
;
106 ExitStatusSet restart_force_status
;
107 ExitStatusSet success_status
;
109 /* If set we'll read the main daemon PID from this file */
113 usec_t timeout_start_usec
;
114 usec_t timeout_stop_usec
;
115 usec_t runtime_max_usec
;
117 dual_timestamp watchdog_timestamp
;
118 usec_t watchdog_usec
;
119 usec_t watchdog_override_usec
;
120 bool watchdog_override_enable
;
121 sd_event_source
*watchdog_event_source
;
123 ExecCommand
* exec_command
[_SERVICE_EXEC_COMMAND_MAX
];
125 ExecContext exec_context
;
126 KillContext kill_context
;
127 CGroupContext cgroup_context
;
129 ServiceState state
, deserialized_state
;
131 /* The exit status of the real main process */
132 ExecStatus main_exec_status
;
134 /* The currently executed control process */
135 ExecCommand
*control_command
;
137 /* The currently executed main process, which may be NULL if
138 * the main process got started via forking mode and not by
140 ExecCommand
*main_command
;
142 /* The ID of the control command currently being executed */
143 ServiceExecCommand control_command_id
;
145 /* Runtime data of the execution context */
146 ExecRuntime
*exec_runtime
;
147 DynamicCreds dynamic_creds
;
149 pid_t main_pid
, control_pid
;
152 bool socket_fd_selinux_context_net
;
154 bool permissions_start_only
;
155 bool root_directory_start_only
;
156 bool remain_after_exit
;
159 /* If we shut down, remember why */
160 ServiceResult result
;
161 ServiceResult reload_result
;
163 bool main_pid_known
:1;
164 bool main_pid_alien
:1;
165 bool bus_name_good
:1;
166 bool forbid_restart
:1;
167 /* Keep restart intention between UNIT_FAILED and UNIT_ACTIVATING */
168 bool will_auto_restart
:1;
169 bool start_timeout_defined
:1;
172 char *bus_name_owner
; /* unique name of the current owner */
177 UnitRef accept_socket
;
179 sd_event_source
*timer_event_source
;
180 PathSpec
*pid_file_pathspec
;
182 NotifyAccess notify_access
;
183 NotifyState notify_state
;
185 ServiceFDStore
*fd_store
;
187 unsigned n_fd_store_max
;
188 unsigned n_keep_fd_store
;
190 char *usb_function_descriptors
;
191 char *usb_function_strings
;
198 bool flush_n_restarts
;
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* notify_state_to_string(NotifyState i
) _const_
;
216 NotifyState
notify_state_from_string(const char *s
) _pure_
;
218 const char* service_result_to_string(ServiceResult i
) _const_
;
219 ServiceResult
service_result_from_string(const char *s
) _pure_
;