src/core/service.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #ifndef fooservicehfoo
   4 #define fooservicehfoo
   5
   6 /***
   7   This file is part of systemd.
   8
   9   Copyright 2010 Lennart Poettering
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU Lesser General Public License as published by
  13   the Free Software Foundation; either version 2.1 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   Lesser General Public License for more details.
  20
  21   You should have received a copy of the GNU Lesser General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 ***/
  24
  25 typedef struct Service Service;
  26
  27 #include "unit.h"
  28 #include "path.h"
  29 #include "ratelimit.h"
  30 #include "service.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_usec;
 124
 125         dual_timestamp watchdog_timestamp;
 126         usec_t watchdog_usec;
 127         Watch watchdog_watch;
 128
 129         ExecCommand* exec_command[_SERVICE_EXEC_COMMAND_MAX];
 130         ExecContext exec_context;
 131
 132         ServiceState state, deserialized_state;
 133
 134         /* The exit status of the real main process */
 135         ExecStatus main_exec_status;
 136
 137         /* The currently executed control process */
 138         ExecCommand *control_command;
 139
 140         /* The currently executed main process, which may be NULL if
 141          * the main process got started via forking mode and not by
 142          * us */
 143         ExecCommand *main_command;
 144
 145         /* The ID of the control command currently being executed */
 146         ServiceExecCommand control_command_id;
 147
 148         pid_t main_pid, control_pid;
 149         int socket_fd;
 150
 151         int fsck_passno;
 152
 153         bool permissions_start_only;
 154         bool root_directory_start_only;
 155         bool remain_after_exit;
 156         bool guess_main_pid;
 157
 158         /* If we shut down, remember why */
 159         ServiceResult result;
 160         ServiceResult reload_result;
 161
 162         bool main_pid_known:1;
 163         bool main_pid_alien:1;
 164         bool bus_name_good:1;
 165         bool forbid_restart:1;
 166         bool got_socket_fd:1;
 167         bool timeout_defined:1;
 168 #ifdef HAVE_SYSV_COMPAT
 169         bool is_sysv:1;
 170         bool sysv_has_lsb:1;
 171         bool sysv_enabled:1;
 172         int sysv_start_priority_from_rcnd;
 173         int sysv_start_priority;
 174
 175         char *sysv_runlevels;
 176 #endif
 177
 178         char *bus_name;
 179
 180         char *status_text;
 181
 182         RateLimit start_limit;
 183         StartLimitAction start_limit_action;
 184
 185         UnitRef accept_socket;
 186
 187         Watch timer_watch;
 188         PathSpec *pid_file_pathspec;
 189
 190         NotifyAccess notify_access;
 191 };
 192
 193 extern const UnitVTable service_vtable;
 194
 195 struct Socket;
 196
 197 int service_set_socket_fd(Service *s, int fd, struct Socket *socket);
 198
 199 const char* service_state_to_string(ServiceState i);
 200 ServiceState service_state_from_string(const char *s);
 201
 202 const char* service_restart_to_string(ServiceRestart i);
 203 ServiceRestart service_restart_from_string(const char *s);
 204
 205 const char* service_type_to_string(ServiceType i);
 206 ServiceType service_type_from_string(const char *s);
 207
 208 const char* service_exec_command_to_string(ServiceExecCommand i);
 209 ServiceExecCommand service_exec_command_from_string(const char *s);
 210
 211 const char* notify_access_to_string(NotifyAccess i);
 212 NotifyAccess notify_access_from_string(const char *s);
 213
 214 const char* service_result_to_string(ServiceResult i);
 215 ServiceResult service_result_from_string(const char *s);
 216
 217 const char* start_limit_action_to_string(StartLimitAction i);
 218 StartLimitAction start_limit_action_from_string(const char *s);
 219
 220 #endif