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