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