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 #include "failure-action.h"
  32
  33 typedef enum ServiceState {
  34         SERVICE_DEAD,
  35         SERVICE_START_PRE,
  36         SERVICE_START,
  37         SERVICE_START_POST,
  38         SERVICE_RUNNING,
  39         SERVICE_EXITED,            /* Nothing is running anymore, but RemainAfterExit is true hence this is OK */
  40         SERVICE_RELOAD,
  41         SERVICE_STOP,              /* No STOP_PRE state, instead just register multiple STOP executables */
  42         SERVICE_STOP_SIGABRT,      /* Watchdog timeout */
  43         SERVICE_STOP_SIGTERM,
  44         SERVICE_STOP_SIGKILL,
  45         SERVICE_STOP_POST,
  46         SERVICE_FINAL_SIGTERM,     /* In case the STOP_POST executable hangs, we shoot that down, too */
  47         SERVICE_FINAL_SIGKILL,
  48         SERVICE_FAILED,
  49         SERVICE_AUTO_RESTART,
  50         _SERVICE_STATE_MAX,
  51         _SERVICE_STATE_INVALID = -1
  52 } ServiceState;
  53
  54 typedef enum ServiceRestart {
  55         SERVICE_RESTART_NO,
  56         SERVICE_RESTART_ON_SUCCESS,
  57         SERVICE_RESTART_ON_FAILURE,
  58         SERVICE_RESTART_ON_ABNORMAL,
  59         SERVICE_RESTART_ON_WATCHDOG,
  60         SERVICE_RESTART_ON_ABORT,
  61         SERVICE_RESTART_ALWAYS,
  62         _SERVICE_RESTART_MAX,
  63         _SERVICE_RESTART_INVALID = -1
  64 } ServiceRestart;
  65
  66 typedef enum ServiceType {
  67         SERVICE_SIMPLE,   /* we fork and go on right-away (i.e. modern socket activated daemons) */
  68         SERVICE_FORKING,  /* forks by itself (i.e. traditional daemons) */
  69         SERVICE_ONESHOT,  /* we fork and wait until the program finishes (i.e. programs like fsck which run and need to finish before we continue) */
  70         SERVICE_DBUS,     /* we fork and wait until a specific D-Bus name appears on the bus */
  71         SERVICE_NOTIFY,   /* we fork and wait until a daemon sends us a ready message with sd_notify() */
  72         SERVICE_IDLE,     /* much like simple, but delay exec() until all jobs are dispatched. */
  73         _SERVICE_TYPE_MAX,
  74         _SERVICE_TYPE_INVALID = -1
  75 } ServiceType;
  76
  77 typedef enum ServiceExecCommand {
  78         SERVICE_EXEC_START_PRE,
  79         SERVICE_EXEC_START,
  80         SERVICE_EXEC_START_POST,
  81         SERVICE_EXEC_RELOAD,
  82         SERVICE_EXEC_STOP,
  83         SERVICE_EXEC_STOP_POST,
  84         _SERVICE_EXEC_COMMAND_MAX,
  85         _SERVICE_EXEC_COMMAND_INVALID = -1
  86 } ServiceExecCommand;
  87
  88 typedef enum NotifyAccess {
  89         NOTIFY_NONE,
  90         NOTIFY_ALL,
  91         NOTIFY_MAIN,
  92         _NOTIFY_ACCESS_MAX,
  93         _NOTIFY_ACCESS_INVALID = -1
  94 } NotifyAccess;
  95
  96 typedef enum NotifyState {
  97         NOTIFY_UNKNOWN,
  98         NOTIFY_READY,
  99         NOTIFY_RELOADING,
 100         NOTIFY_STOPPING,
 101         _NOTIFY_STATE_MAX,
 102         _NOTIFY_STATE_INVALID = -1
 103 } NotifyState;
 104
 105 typedef enum ServiceResult {
 106         SERVICE_SUCCESS,
 107         SERVICE_FAILURE_RESOURCES,
 108         SERVICE_FAILURE_TIMEOUT,
 109         SERVICE_FAILURE_EXIT_CODE,
 110         SERVICE_FAILURE_SIGNAL,
 111         SERVICE_FAILURE_CORE_DUMP,
 112         SERVICE_FAILURE_WATCHDOG,
 113         SERVICE_FAILURE_START_LIMIT,
 114         _SERVICE_RESULT_MAX,
 115         _SERVICE_RESULT_INVALID = -1
 116 } ServiceResult;
 117
 118 struct Service {
 119         Unit meta;
 120
 121         ServiceType type;
 122         ServiceRestart restart;
 123         ExitStatusSet restart_prevent_status;
 124         ExitStatusSet restart_force_status;
 125         ExitStatusSet success_status;
 126
 127         /* If set we'll read the main daemon PID from this file */
 128         char *pid_file;
 129
 130         usec_t restart_usec;
 131         usec_t timeout_start_usec;
 132         usec_t timeout_stop_usec;
 133
 134         dual_timestamp watchdog_timestamp;
 135         usec_t watchdog_usec;
 136         sd_event_source *watchdog_event_source;
 137
 138         ExecCommand* exec_command[_SERVICE_EXEC_COMMAND_MAX];
 139
 140         ExecContext exec_context;
 141         KillContext kill_context;
 142         CGroupContext cgroup_context;
 143
 144         ServiceState state, deserialized_state;
 145
 146         /* The exit status of the real main process */
 147         ExecStatus main_exec_status;
 148
 149         /* The currently executed control process */
 150         ExecCommand *control_command;
 151
 152         /* The currently executed main process, which may be NULL if
 153          * the main process got started via forking mode and not by
 154          * us */
 155         ExecCommand *main_command;
 156
 157         /* The ID of the control command currently being executed */
 158         ServiceExecCommand control_command_id;
 159
 160         /* Runtime data of the execution context */
 161         ExecRuntime *exec_runtime;
 162
 163         pid_t main_pid, control_pid;
 164         int socket_fd;
 165         bool socket_fd_selinux_context_net;
 166
 167         int bus_endpoint_fd;
 168
 169         bool permissions_start_only;
 170         bool root_directory_start_only;
 171         bool remain_after_exit;
 172         bool guess_main_pid;
 173
 174         /* If we shut down, remember why */
 175         ServiceResult result;
 176         ServiceResult reload_result;
 177
 178         bool main_pid_known:1;
 179         bool main_pid_alien:1;
 180         bool bus_name_good:1;
 181         bool forbid_restart:1;
 182         bool start_timeout_defined:1;
 183 #ifdef HAVE_SYSV_COMPAT
 184         int sysv_start_priority;
 185 #endif
 186
 187         char *bus_name;
 188
 189         char *status_text;
 190         int status_errno;
 191
 192         RateLimit start_limit;
 193         FailureAction start_limit_action;
 194         FailureAction failure_action;
 195         char *reboot_arg;
 196
 197         UnitRef accept_socket;
 198
 199         sd_event_source *timer_event_source;
 200         PathSpec *pid_file_pathspec;
 201
 202         NotifyAccess notify_access;
 203         NotifyState notify_state;
 204 };
 205
 206 extern const UnitVTable service_vtable;
 207
 208 struct Socket;
 209
 210 int service_set_socket_fd(Service *s, int fd, struct Socket *socket, bool selinux_context_net);
 211
 212 const char* service_state_to_string(ServiceState i) _const_;
 213 ServiceState service_state_from_string(const char *s) _pure_;
 214
 215 const char* service_restart_to_string(ServiceRestart i) _const_;
 216 ServiceRestart service_restart_from_string(const char *s) _pure_;
 217
 218 const char* service_type_to_string(ServiceType i) _const_;
 219 ServiceType service_type_from_string(const char *s) _pure_;
 220
 221 const char* service_exec_command_to_string(ServiceExecCommand i) _const_;
 222 ServiceExecCommand service_exec_command_from_string(const char *s) _pure_;
 223
 224 const char* notify_access_to_string(NotifyAccess i) _const_;
 225 NotifyAccess notify_access_from_string(const char *s) _pure_;
 226
 227 const char* notify_state_to_string(NotifyState i) _const_;
 228 NotifyState notify_state_from_string(const char *s) _pure_;
 229
 230 const char* service_result_to_string(ServiceResult i) _const_;
 231 ServiceResult service_result_from_string(const char *s) _pure_;