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