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