src/core/service.h

   1 #pragma once
   2
   3 /***
   4   This file is part of systemd.
   5
   6   Copyright 2010 Lennart Poettering
   7
   8   systemd is free software; you can redistribute it and/or modify it
   9   under the terms of the GNU Lesser General Public License as published by
  10   the Free Software Foundation; either version 2.1 of the License, or
  11   (at your option) any later version.
  12
  13   systemd is distributed in the hope that it will be useful, but
  14   WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16   Lesser General Public License for more details.
  17
  18   You should have received a copy of the GNU Lesser General Public License
  19   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  20 ***/
  21
  22 typedef struct Service Service;
  23 typedef struct ServiceFDStore ServiceFDStore;
  24
  25 #include "exit-status.h"
  26 #include "kill.h"
  27 #include "path.h"
  28 #include "ratelimit.h"
  29
  30 typedef enum ServiceRestart {
  31         SERVICE_RESTART_NO,
  32         SERVICE_RESTART_ON_SUCCESS,
  33         SERVICE_RESTART_ON_FAILURE,
  34         SERVICE_RESTART_ON_ABNORMAL,
  35         SERVICE_RESTART_ON_WATCHDOG,
  36         SERVICE_RESTART_ON_ABORT,
  37         SERVICE_RESTART_ALWAYS,
  38         _SERVICE_RESTART_MAX,
  39         _SERVICE_RESTART_INVALID = -1
  40 } ServiceRestart;
  41
  42 typedef enum ServiceType {
  43         SERVICE_SIMPLE,   /* we fork and go on right-away (i.e. modern socket activated daemons) */
  44         SERVICE_FORKING,  /* forks by itself (i.e. traditional daemons) */
  45         SERVICE_ONESHOT,  /* we fork and wait until the program finishes (i.e. programs like fsck which run and need to finish before we continue) */
  46         SERVICE_DBUS,     /* we fork and wait until a specific D-Bus name appears on the bus */
  47         SERVICE_NOTIFY,   /* we fork and wait until a daemon sends us a ready message with sd_notify() */
  48         SERVICE_IDLE,     /* much like simple, but delay exec() until all jobs are dispatched. */
  49         _SERVICE_TYPE_MAX,
  50         _SERVICE_TYPE_INVALID = -1
  51 } ServiceType;
  52
  53 typedef enum ServiceExecCommand {
  54         SERVICE_EXEC_START_PRE,
  55         SERVICE_EXEC_START,
  56         SERVICE_EXEC_START_POST,
  57         SERVICE_EXEC_RELOAD,
  58         SERVICE_EXEC_STOP,
  59         SERVICE_EXEC_STOP_POST,
  60         _SERVICE_EXEC_COMMAND_MAX,
  61         _SERVICE_EXEC_COMMAND_INVALID = -1
  62 } ServiceExecCommand;
  63
  64 typedef enum NotifyAccess {
  65         NOTIFY_NONE,
  66         NOTIFY_ALL,
  67         NOTIFY_MAIN,
  68         NOTIFY_EXEC,
  69         _NOTIFY_ACCESS_MAX,
  70         _NOTIFY_ACCESS_INVALID = -1
  71 } NotifyAccess;
  72
  73 typedef enum NotifyState {
  74         NOTIFY_UNKNOWN,
  75         NOTIFY_READY,
  76         NOTIFY_RELOADING,
  77         NOTIFY_STOPPING,
  78         _NOTIFY_STATE_MAX,
  79         _NOTIFY_STATE_INVALID = -1
  80 } NotifyState;
  81
  82 typedef enum ServiceResult {
  83         SERVICE_SUCCESS,
  84         SERVICE_FAILURE_RESOURCES, /* a bit of a misnomer, just our catch-all error for errnos we didn't expect */
  85         SERVICE_FAILURE_PROTOCOL,
  86         SERVICE_FAILURE_TIMEOUT,
  87         SERVICE_FAILURE_EXIT_CODE,
  88         SERVICE_FAILURE_SIGNAL,
  89         SERVICE_FAILURE_CORE_DUMP,
  90         SERVICE_FAILURE_WATCHDOG,
  91         SERVICE_FAILURE_START_LIMIT_HIT,
  92         _SERVICE_RESULT_MAX,
  93         _SERVICE_RESULT_INVALID = -1
  94 } ServiceResult;
  95
  96 struct ServiceFDStore {
  97         Service *service;
  98
  99         int fd;
 100         char *fdname;
 101         sd_event_source *event_source;
 102
 103         LIST_FIELDS(ServiceFDStore, fd_store);
 104 };
 105
 106 struct Service {
 107         Unit meta;
 108
 109         ServiceType type;
 110         ServiceRestart restart;
 111         ExitStatusSet restart_prevent_status;
 112         ExitStatusSet restart_force_status;
 113         ExitStatusSet success_status;
 114
 115         /* If set we'll read the main daemon PID from this file */
 116         char *pid_file;
 117
 118         usec_t restart_usec;
 119         usec_t timeout_start_usec;
 120         usec_t timeout_stop_usec;
 121         usec_t runtime_max_usec;
 122
 123         dual_timestamp watchdog_timestamp;
 124         usec_t watchdog_usec;
 125         usec_t watchdog_override_usec;
 126         bool watchdog_override_enable;
 127         sd_event_source *watchdog_event_source;
 128
 129         ExecCommand* exec_command[_SERVICE_EXEC_COMMAND_MAX];
 130
 131         ExecContext exec_context;
 132         KillContext kill_context;
 133         CGroupContext cgroup_context;
 134
 135         ServiceState state, deserialized_state;
 136
 137         /* The exit status of the real main process */
 138         ExecStatus main_exec_status;
 139
 140         /* The currently executed control process */
 141         ExecCommand *control_command;
 142
 143         /* The currently executed main process, which may be NULL if
 144          * the main process got started via forking mode and not by
 145          * us */
 146         ExecCommand *main_command;
 147
 148         /* The ID of the control command currently being executed */
 149         ServiceExecCommand control_command_id;
 150
 151         /* Runtime data of the execution context */
 152         ExecRuntime *exec_runtime;
 153         DynamicCreds dynamic_creds;
 154
 155         pid_t main_pid, control_pid;
 156         int socket_fd;
 157         SocketPeer *peer;
 158         bool socket_fd_selinux_context_net;
 159
 160         bool permissions_start_only;
 161         bool root_directory_start_only;
 162         bool remain_after_exit;
 163         bool guess_main_pid;
 164
 165         /* If we shut down, remember why */
 166         ServiceResult result;
 167         ServiceResult reload_result;
 168
 169         bool main_pid_known:1;
 170         bool main_pid_alien:1;
 171         bool bus_name_good:1;
 172         bool forbid_restart:1;
 173         bool start_timeout_defined:1;
 174
 175         bool reset_cpu_usage:1;
 176
 177         char *bus_name;
 178         char *bus_name_owner; /* unique name of the current owner */
 179
 180         char *status_text;
 181         int status_errno;
 182
 183         EmergencyAction emergency_action;
 184
 185         UnitRef accept_socket;
 186
 187         sd_event_source *timer_event_source;
 188         PathSpec *pid_file_pathspec;
 189
 190         NotifyAccess notify_access;
 191         NotifyState notify_state;
 192
 193         ServiceFDStore *fd_store;
 194         unsigned n_fd_store;
 195         unsigned n_fd_store_max;
 196
 197         char *usb_function_descriptors;
 198         char *usb_function_strings;
 199
 200         int stdin_fd;
 201         int stdout_fd;
 202         int stderr_fd;
 203 };
 204
 205 extern const UnitVTable service_vtable;
 206
 207 int service_set_socket_fd(Service *s, int fd, struct Socket *socket, bool selinux_context_net);
 208 void service_close_socket_fd(Service *s);
 209
 210 const char* service_restart_to_string(ServiceRestart i) _const_;
 211 ServiceRestart service_restart_from_string(const char *s) _pure_;
 212
 213 const char* service_type_to_string(ServiceType i) _const_;
 214 ServiceType service_type_from_string(const char *s) _pure_;
 215
 216 const char* service_exec_command_to_string(ServiceExecCommand i) _const_;
 217 ServiceExecCommand service_exec_command_from_string(const char *s) _pure_;
 218
 219 const char* notify_access_to_string(NotifyAccess i) _const_;
 220 NotifyAccess notify_access_from_string(const char *s) _pure_;
 221
 222 const char* notify_state_to_string(NotifyState i) _const_;
 223 NotifyState notify_state_from_string(const char *s) _pure_;
 224
 225 const char* service_result_to_string(ServiceResult i) _const_;
 226 ServiceResult service_result_from_string(const char *s) _pure_;