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