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 typedef struct PathSpec PathSpec;
  90
  91 struct Service {
  92         Meta meta;
  93
  94         ServiceType type;
  95         ServiceRestart restart;
  96
  97         /* If set we'll read the main daemon PID from this file */
  98         char *pid_file;
  99
 100         usec_t restart_usec;
 101         usec_t timeout_usec;
 102
 103         ExecCommand* exec_command[_SERVICE_EXEC_COMMAND_MAX];
 104         ExecContext exec_context;
 105
 106         ServiceState state, deserialized_state;
 107
 108         /* The exit status of the real main process */
 109         ExecStatus main_exec_status;
 110
 111         /* The currently executed control process */
 112         ExecCommand *control_command;
 113
 114         /* The currently executed main process, which may be NULL if
 115          * the main process got started via forking mode and not by
 116          * us */
 117         ExecCommand *main_command;
 118
 119         /* The ID of the control command currently being executed */
 120         ServiceExecCommand control_command_id;
 121
 122         pid_t main_pid, control_pid;
 123         int socket_fd;
 124
 125         int fsck_passno;
 126
 127         bool permissions_start_only;
 128         bool root_directory_start_only;
 129         bool remain_after_exit;
 130         bool guess_main_pid;
 131
 132         /* If we shut down, remember why */
 133         bool failure:1;
 134         bool reload_failure:1;
 135
 136         bool main_pid_known:1;
 137         bool main_pid_alien:1;
 138         bool bus_name_good:1;
 139         bool forbid_restart:1;
 140         bool got_socket_fd:1;
 141 #ifdef HAVE_SYSV_COMPAT
 142         bool sysv_has_lsb:1;
 143         bool sysv_enabled:1;
 144         int sysv_start_priority_from_rcnd;
 145         int sysv_start_priority;
 146
 147         char *sysv_path;
 148         char *sysv_runlevels;
 149         usec_t sysv_mtime;
 150 #endif
 151
 152         char *bus_name;
 153
 154         char *status_text;
 155
 156         RateLimit ratelimit;
 157
 158         struct Socket *accept_socket;
 159         Set *configured_sockets;
 160
 161         Watch timer_watch;
 162         PathSpec *pid_file_pathspec;
 163
 164         NotifyAccess notify_access;
 165 };
 166
 167 extern const UnitVTable service_vtable;
 168
 169 int service_set_socket_fd(Service *s, int fd, struct Socket *socket);
 170
 171 const char* service_state_to_string(ServiceState i);
 172 ServiceState service_state_from_string(const char *s);
 173
 174 const char* service_restart_to_string(ServiceRestart i);
 175 ServiceRestart service_restart_from_string(const char *s);
 176
 177 const char* service_type_to_string(ServiceType i);
 178 ServiceType service_type_from_string(const char *s);
 179
 180 const char* service_exec_command_to_string(ServiceExecCommand i);
 181 ServiceExecCommand service_exec_command_from_string(const char *s);
 182
 183 const char* notify_access_to_string(NotifyAccess i);
 184 NotifyAccess notify_access_from_string(const char *s);
 185
 186 #endif