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