src/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 General Public License as published by
  13   the Free Software Foundation; either version 2 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   General Public License for more details.
  20
  21   You should have received a copy of the GNU 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
  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_TYPE_MAX,
  68         _SERVICE_TYPE_INVALID = -1
  69 } ServiceType;
  70
  71 typedef enum ServiceExecCommand {
  72         SERVICE_EXEC_START_PRE,
  73         SERVICE_EXEC_START,
  74         SERVICE_EXEC_START_POST,
  75         SERVICE_EXEC_RELOAD,
  76         SERVICE_EXEC_STOP,
  77         SERVICE_EXEC_STOP_POST,
  78         _SERVICE_EXEC_COMMAND_MAX,
  79         _SERVICE_EXEC_COMMAND_INVALID = -1
  80 } ServiceExecCommand;
  81
  82 typedef enum NotifyAccess {
  83         NOTIFY_NONE,
  84         NOTIFY_ALL,
  85         NOTIFY_MAIN,
  86         _NOTIFY_ACCESS_MAX,
  87         _NOTIFY_ACCESS_INVALID = -1
  88 } NotifyAccess;
  89
  90 struct Service {
  91         Meta meta;
  92
  93         ServiceType type;
  94         ServiceRestart restart;
  95
  96         /* If set we'll read the main daemon PID from this file */
  97         char *pid_file;
  98
  99         usec_t restart_usec;
 100         usec_t timeout_usec;
 101
 102         ExecCommand* exec_command[_SERVICE_EXEC_COMMAND_MAX];
 103         ExecContext exec_context;
 104
 105         ServiceState state, deserialized_state;
 106
 107         /* The exit status of the real main process */
 108         ExecStatus main_exec_status;
 109
 110         /* The currently executed control process */
 111         ExecCommand *control_command;
 112
 113         /* The currently executed main process, which may be NULL if
 114          * the main process got started via forking mode and not by
 115          * us */
 116         ExecCommand *main_command;
 117
 118         /* The ID of the control command currently being executed */
 119         ServiceExecCommand control_command_id;
 120
 121         pid_t main_pid, control_pid;
 122         int socket_fd;
 123
 124         int fsck_passno;
 125
 126         bool permissions_start_only;
 127         bool root_directory_start_only;
 128         bool remain_after_exit;
 129         bool guess_main_pid;
 130
 131         /* If we shut down, remember why */
 132         bool failure:1;
 133         bool reload_failure:1;
 134
 135         bool main_pid_known:1;
 136         bool main_pid_alien:1;
 137         bool bus_name_good:1;
 138         bool forbid_restart:1;
 139         bool got_socket_fd:1;
 140 #ifdef HAVE_SYSV_COMPAT
 141         bool sysv_has_lsb:1;
 142         bool sysv_enabled:1;
 143         int sysv_start_priority_from_rcnd;
 144         int sysv_start_priority;
 145
 146         char *sysv_path;
 147         char *sysv_runlevels;
 148         usec_t sysv_mtime;
 149 #endif
 150
 151         char *bus_name;
 152
 153         char *status_text;
 154
 155         RateLimit ratelimit;
 156
 157         struct Socket *accept_socket;
 158         Set *configured_sockets;
 159
 160         Watch timer_watch;
 161         PathSpec *pid_file_pathspec;
 162
 163         NotifyAccess notify_access;
 164 };
 165
 166 extern const UnitVTable service_vtable;
 167
 168 int service_set_socket_fd(Service *s, int fd, struct Socket *socket);
 169
 170 const char* service_state_to_string(ServiceState i);
 171 ServiceState service_state_from_string(const char *s);
 172
 173 const char* service_restart_to_string(ServiceRestart i);
 174 ServiceRestart service_restart_from_string(const char *s);
 175
 176 const char* service_type_to_string(ServiceType i);
 177 ServiceType service_type_from_string(const char *s);
 178
 179 const char* service_exec_command_to_string(ServiceExecCommand i);
 180 ServiceExecCommand service_exec_command_from_string(const char *s);
 181
 182 const char* notify_access_to_string(NotifyAccess i);
 183 NotifyAccess notify_access_from_string(const char *s);
 184
 185 #endif