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_ACCESS_MAX,
  69         _NOTIFY_ACCESS_INVALID = -1
  70 } NotifyAccess;
  71
  72 typedef enum NotifyState {
  73         NOTIFY_UNKNOWN,
  74         NOTIFY_READY,
  75         NOTIFY_RELOADING,
  76         NOTIFY_STOPPING,
  77         _NOTIFY_STATE_MAX,
  78         _NOTIFY_STATE_INVALID = -1
  79 } NotifyState;
  80
  81 typedef enum ServiceResult {
  82         SERVICE_SUCCESS,
  83         SERVICE_FAILURE_RESOURCES, /* a bit of a misnomer, just our catch-all error for errnos we didn't expect */
  84         SERVICE_FAILURE_TIMEOUT,
  85         SERVICE_FAILURE_EXIT_CODE,
  86         SERVICE_FAILURE_SIGNAL,
  87         SERVICE_FAILURE_CORE_DUMP,
  88         SERVICE_FAILURE_WATCHDOG,
  89         SERVICE_FAILURE_START_LIMIT_HIT,
  90         _SERVICE_RESULT_MAX,
  91         _SERVICE_RESULT_INVALID = -1
  92 } ServiceResult;
  93
  94 struct ServiceFDStore {
  95         Service *service;
  96
  97         int fd;
  98         char *fdname;
  99         sd_event_source *event_source;
 100
 101         LIST_FIELDS(ServiceFDStore, fd_store);
 102 };
 103
 104 struct Service {
 105         Unit meta;
 106
 107         ServiceType type;
 108         ServiceRestart restart;
 109         ExitStatusSet restart_prevent_status;
 110         ExitStatusSet restart_force_status;
 111         ExitStatusSet success_status;
 112
 113         /* If set we'll read the main daemon PID from this file */
 114         char *pid_file;
 115
 116         usec_t restart_usec;
 117         usec_t timeout_start_usec;
 118         usec_t timeout_stop_usec;
 119         usec_t runtime_max_usec;
 120
 121         dual_timestamp watchdog_timestamp;
 122         usec_t watchdog_usec;
 123         usec_t watchdog_override_usec;
 124         bool watchdog_override_enable;
 125         sd_event_source *watchdog_event_source;
 126
 127         ExecCommand* exec_command[_SERVICE_EXEC_COMMAND_MAX];
 128
 129         ExecContext exec_context;
 130         KillContext kill_context;
 131         CGroupContext cgroup_context;
 132
 133         ServiceState state, deserialized_state;
 134
 135         /* The exit status of the real main process */
 136         ExecStatus main_exec_status;
 137
 138         /* The currently executed control process */
 139         ExecCommand *control_command;
 140
 141         /* The currently executed main process, which may be NULL if
 142          * the main process got started via forking mode and not by
 143          * us */
 144         ExecCommand *main_command;
 145
 146         /* The ID of the control command currently being executed */
 147         ServiceExecCommand control_command_id;
 148
 149         /* Runtime data of the execution context */
 150         ExecRuntime *exec_runtime;
 151         DynamicCreds dynamic_creds;
 152
 153         pid_t main_pid, control_pid;
 154         int socket_fd;
 155         bool socket_fd_selinux_context_net;
 156
 157         bool permissions_start_only;
 158         bool root_directory_start_only;
 159         bool remain_after_exit;
 160         bool guess_main_pid;
 161
 162         /* If we shut down, remember why */
 163         ServiceResult result;
 164         ServiceResult reload_result;
 165
 166         bool main_pid_known:1;
 167         bool main_pid_alien:1;
 168         bool bus_name_good:1;
 169         bool forbid_restart:1;
 170         bool start_timeout_defined:1;
 171
 172         bool reset_cpu_usage:1;
 173
 174         char *bus_name;
 175         char *bus_name_owner; /* unique name of the current owner */
 176
 177         char *status_text;
 178         int status_errno;
 179
 180         FailureAction failure_action;
 181
 182         UnitRef accept_socket;
 183
 184         sd_event_source *timer_event_source;
 185         PathSpec *pid_file_pathspec;
 186
 187         NotifyAccess notify_access;
 188         NotifyState notify_state;
 189
 190         ServiceFDStore *fd_store;
 191         unsigned n_fd_store;
 192         unsigned n_fd_store_max;
 193
 194         char *usb_function_descriptors;
 195         char *usb_function_strings;
 196
 197         int stdin_fd;
 198         int stdout_fd;
 199         int stderr_fd;
 200 };
 201
 202 extern const UnitVTable service_vtable;
 203
 204 int service_set_socket_fd(Service *s, int fd, struct Socket *socket, bool selinux_context_net);
 205 void service_close_socket_fd(Service *s);
 206
 207 const char* service_restart_to_string(ServiceRestart i) _const_;
 208 ServiceRestart service_restart_from_string(const char *s) _pure_;
 209
 210 const char* service_type_to_string(ServiceType i) _const_;
 211 ServiceType service_type_from_string(const char *s) _pure_;
 212
 213 const char* service_exec_command_to_string(ServiceExecCommand i) _const_;
 214 ServiceExecCommand service_exec_command_from_string(const char *s) _pure_;
 215
 216 const char* notify_access_to_string(NotifyAccess i) _const_;
 217 NotifyAccess notify_access_from_string(const char *s) _pure_;
 218
 219 const char* notify_state_to_string(NotifyState i) _const_;
 220 NotifyState notify_state_from_string(const char *s) _pure_;
 221
 222 const char* service_result_to_string(ServiceResult i) _const_;
 223 ServiceResult service_result_from_string(const char *s) _pure_;