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