src/service.h

   1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
   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 ValidNoProcess is true, ehnce 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_MAINTENANCE,
  45         SERVICE_AUTO_RESTART,
  46         _SERVICE_STATE_MAX,
  47         _SERVICE_STATE_INVALID = -1
  48 } ServiceState;
  49
  50 typedef enum ServiceRestart {
  51         SERVICE_ONCE,
  52         SERVICE_RESTART_ON_SUCCESS,
  53         SERVICE_RESTART_ALWAYS,
  54         _SERVICE_RESTART_MAX,
  55         _SERVICE_RESTART_INVALID = -1
  56 } ServiceRestart;
  57
  58 typedef enum ServiceType {
  59         SERVICE_SIMPLE,   /* we fork and go on right-away (i.e. modern socket activated daemons) */
  60         SERVICE_FORKING,  /* forks by itself (i.e. traditional daemons) */
  61         SERVICE_FINISH,   /* we fork and wait until the program finishes (i.e. programs like fsck which run and need to finish before we continue) */
  62         SERVICE_DBUS,     /* we fork and wait until a specific D-Bus name appears on the bus */
  63         SERVICE_NOTIFY,   /* we fork and wait until a daemon sends us a ready message with sd_notify() */
  64         _SERVICE_TYPE_MAX,
  65         _SERVICE_TYPE_INVALID = -1
  66 } ServiceType;
  67
  68 typedef enum ServiceExecCommand {
  69         SERVICE_EXEC_START_PRE,
  70         SERVICE_EXEC_START,
  71         SERVICE_EXEC_START_POST,
  72         SERVICE_EXEC_RELOAD,
  73         SERVICE_EXEC_STOP,
  74         SERVICE_EXEC_STOP_POST,
  75         _SERVICE_EXEC_COMMAND_MAX,
  76         _SERVICE_EXEC_COMMAND_INVALID = -1
  77 } ServiceExecCommand;
  78
  79 typedef enum NotifyAccess {
  80         NOTIFY_NONE,
  81         NOTIFY_ALL,
  82         NOTIFY_MAIN,
  83         _NOTIFY_ACCESS_MAX,
  84         _NOTIFY_ACCESS_INVALID = -1
  85 } NotifyAccess;
  86
  87 struct Service {
  88         Meta meta;
  89
  90         ServiceType type;
  91         ServiceRestart restart;
  92
  93         NotifyAccess notify_access;
  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         bool permissions_start_only;
 105         bool root_directory_start_only;
 106         bool valid_no_process;
 107
 108         ServiceState state, deserialized_state;
 109
 110         KillMode kill_mode;
 111
 112         ExecStatus main_exec_status;
 113
 114         ExecCommand *control_command;
 115         ServiceExecCommand control_command_id;
 116         pid_t main_pid, control_pid;
 117         bool main_pid_known:1;
 118
 119         /* If we shut down, remember why */
 120         bool failure:1;
 121
 122         bool bus_name_good:1;
 123
 124         bool allow_restart:1;
 125
 126         bool got_socket_fd:1;
 127
 128         bool sysv_has_lsb:1;
 129         char *sysv_path;
 130         int sysv_start_priority;
 131         char *sysv_runlevels;
 132
 133         char *bus_name;
 134
 135         char *status_text;
 136
 137         RateLimit ratelimit;
 138
 139         int socket_fd;
 140         struct Socket *socket;
 141
 142         Watch timer_watch;
 143 };
 144
 145 extern const UnitVTable service_vtable;
 146
 147 int service_set_socket_fd(Service *s, int fd, struct Socket *socket);
 148
 149 const char* service_state_to_string(ServiceState i);
 150 ServiceState service_state_from_string(const char *s);
 151
 152 const char* service_restart_to_string(ServiceRestart i);
 153 ServiceRestart service_restart_from_string(const char *s);
 154
 155 const char* service_type_to_string(ServiceType i);
 156 ServiceType service_type_from_string(const char *s);
 157
 158 const char* service_exec_command_to_string(ServiceExecCommand i);
 159 ServiceExecCommand service_exec_command_from_string(const char *s);
 160
 161 const char* notify_access_to_string(NotifyAccess i);
 162 NotifyAccess notify_access_from_string(const char *s);
 163
 164 #endif