src/core/service.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 typedef struct Service Service;
   5 typedef struct ServiceFDStore ServiceFDStore;
   6
   7 #include "exit-status.h"
   8 #include "kill.h"
   9 #include "path.h"
  10 #include "ratelimit.h"
  11 #include "socket.h"
  12 #include "unit.h"
  13
  14 typedef enum ServiceRestart {
  15         SERVICE_RESTART_NO,
  16         SERVICE_RESTART_ON_SUCCESS,
  17         SERVICE_RESTART_ON_FAILURE,
  18         SERVICE_RESTART_ON_ABNORMAL,
  19         SERVICE_RESTART_ON_WATCHDOG,
  20         SERVICE_RESTART_ON_ABORT,
  21         SERVICE_RESTART_ALWAYS,
  22         _SERVICE_RESTART_MAX,
  23         _SERVICE_RESTART_INVALID = -1
  24 } ServiceRestart;
  25
  26 typedef enum ServiceType {
  27         SERVICE_SIMPLE,   /* we fork and go on right-away (i.e. modern socket activated daemons) */
  28         SERVICE_FORKING,  /* forks by itself (i.e. traditional daemons) */
  29         SERVICE_ONESHOT,  /* we fork and wait until the program finishes (i.e. programs like fsck which run and need to finish before we continue) */
  30         SERVICE_DBUS,     /* we fork and wait until a specific D-Bus name appears on the bus */
  31         SERVICE_NOTIFY,   /* we fork and wait until a daemon sends us a ready message with sd_notify() */
  32         SERVICE_IDLE,     /* much like simple, but delay exec() until all jobs are dispatched. */
  33         SERVICE_EXEC,     /* we fork and wait until we execute exec() (this means our own setup is waited for) */
  34         _SERVICE_TYPE_MAX,
  35         _SERVICE_TYPE_INVALID = -1
  36 } ServiceType;
  37
  38 typedef enum ServiceExecCommand {
  39         SERVICE_EXEC_START_PRE,
  40         SERVICE_EXEC_START,
  41         SERVICE_EXEC_START_POST,
  42         SERVICE_EXEC_RELOAD,
  43         SERVICE_EXEC_STOP,
  44         SERVICE_EXEC_STOP_POST,
  45         _SERVICE_EXEC_COMMAND_MAX,
  46         _SERVICE_EXEC_COMMAND_INVALID = -1
  47 } ServiceExecCommand;
  48
  49 typedef enum NotifyState {
  50         NOTIFY_UNKNOWN,
  51         NOTIFY_READY,
  52         NOTIFY_RELOADING,
  53         NOTIFY_STOPPING,
  54         _NOTIFY_STATE_MAX,
  55         _NOTIFY_STATE_INVALID = -1
  56 } NotifyState;
  57
  58 /* The values of this enum are referenced in man/systemd.exec.xml and src/shared/bus-unit-util.c.
  59  * Update those sources for each change to this enum. */
  60 typedef enum ServiceResult {
  61         SERVICE_SUCCESS,
  62         SERVICE_FAILURE_RESOURCES, /* a bit of a misnomer, just our catch-all error for errnos we didn't expect */
  63         SERVICE_FAILURE_PROTOCOL,
  64         SERVICE_FAILURE_TIMEOUT,
  65         SERVICE_FAILURE_EXIT_CODE,
  66         SERVICE_FAILURE_SIGNAL,
  67         SERVICE_FAILURE_CORE_DUMP,
  68         SERVICE_FAILURE_WATCHDOG,
  69         SERVICE_FAILURE_START_LIMIT_HIT,
  70         SERVICE_FAILURE_OOM_KILL,
  71         _SERVICE_RESULT_MAX,
  72         _SERVICE_RESULT_INVALID = -1
  73 } ServiceResult;
  74
  75 struct ServiceFDStore {
  76         Service *service;
  77
  78         int fd;
  79         char *fdname;
  80         sd_event_source *event_source;
  81
  82         LIST_FIELDS(ServiceFDStore, fd_store);
  83 };
  84
  85 struct Service {
  86         Unit meta;
  87
  88         ServiceType type;
  89         ServiceRestart restart;
  90         ExitStatusSet restart_prevent_status;
  91         ExitStatusSet restart_force_status;
  92         ExitStatusSet success_status;
  93
  94         /* If set we'll read the main daemon PID from this file */
  95         char *pid_file;
  96
  97         usec_t restart_usec;
  98         usec_t timeout_start_usec;
  99         usec_t timeout_stop_usec;
 100         usec_t timeout_abort_usec;
 101         bool timeout_abort_set;
 102         usec_t timeout_clean_usec;
 103         usec_t runtime_max_usec;
 104
 105         dual_timestamp watchdog_timestamp;
 106         usec_t watchdog_usec;            /* the requested watchdog timeout in the unit file */
 107         usec_t watchdog_original_usec;   /* the watchdog timeout that was in effect when the unit was started, i.e. the timeout the forked off processes currently see */
 108         usec_t watchdog_override_usec;   /* the watchdog timeout requested by the service itself through sd_notify() */
 109         bool watchdog_override_enable;
 110         sd_event_source *watchdog_event_source;
 111
 112         ExecCommand* exec_command[_SERVICE_EXEC_COMMAND_MAX];
 113
 114         ExecContext exec_context;
 115         KillContext kill_context;
 116         CGroupContext cgroup_context;
 117
 118         ServiceState state, deserialized_state;
 119
 120         /* The exit status of the real main process */
 121         ExecStatus main_exec_status;
 122
 123         /* The currently executed control process */
 124         ExecCommand *control_command;
 125
 126         /* The currently executed main process, which may be NULL if
 127          * the main process got started via forking mode and not by
 128          * us */
 129         ExecCommand *main_command;
 130
 131         /* The ID of the control command currently being executed */
 132         ServiceExecCommand control_command_id;
 133
 134         /* Runtime data of the execution context */
 135         ExecRuntime *exec_runtime;
 136         DynamicCreds dynamic_creds;
 137
 138         pid_t main_pid, control_pid;
 139         int socket_fd;
 140         SocketPeer *peer;
 141         bool socket_fd_selinux_context_net;
 142
 143         bool permissions_start_only;
 144         bool root_directory_start_only;
 145         bool remain_after_exit;
 146         bool guess_main_pid;
 147
 148         /* If we shut down, remember why */
 149         ServiceResult result;
 150         ServiceResult reload_result;
 151         ServiceResult clean_result;
 152
 153         bool main_pid_known:1;
 154         bool main_pid_alien:1;
 155         bool bus_name_good:1;
 156         bool forbid_restart:1;
 157         /* Keep restart intention between UNIT_FAILED and UNIT_ACTIVATING */
 158         bool will_auto_restart:1;
 159         bool start_timeout_defined:1;
 160         bool exec_fd_hot:1;
 161
 162         char *bus_name;
 163         char *bus_name_owner; /* unique name of the current owner */
 164
 165         char *status_text;
 166         int status_errno;
 167
 168         UnitRef accept_socket;
 169
 170         sd_event_source *timer_event_source;
 171         PathSpec *pid_file_pathspec;
 172
 173         NotifyAccess notify_access;
 174         NotifyState notify_state;
 175
 176         sd_event_source *exec_fd_event_source;
 177
 178         ServiceFDStore *fd_store;
 179         size_t n_fd_store;
 180         unsigned n_fd_store_max;
 181         unsigned n_keep_fd_store;
 182
 183         char *usb_function_descriptors;
 184         char *usb_function_strings;
 185
 186         int stdin_fd;
 187         int stdout_fd;
 188         int stderr_fd;
 189
 190         unsigned n_restarts;
 191         bool flush_n_restarts;
 192
 193         OOMPolicy oom_policy;
 194 };
 195
 196 static inline usec_t service_timeout_abort_usec(Service *s) {
 197         assert(s);
 198         return s->timeout_abort_set ? s->timeout_abort_usec : s->timeout_stop_usec;
 199 }
 200
 201 extern const UnitVTable service_vtable;
 202
 203 int service_set_socket_fd(Service *s, int fd, struct Socket *socket, bool selinux_context_net);
 204 void service_close_socket_fd(Service *s);
 205
 206 const char* service_restart_to_string(ServiceRestart i) _const_;
 207 ServiceRestart service_restart_from_string(const char *s) _pure_;
 208
 209 const char* service_type_to_string(ServiceType i) _const_;
 210 ServiceType service_type_from_string(const char *s) _pure_;
 211
 212 const char* service_exec_command_to_string(ServiceExecCommand i) _const_;
 213 ServiceExecCommand service_exec_command_from_string(const char *s) _pure_;
 214
 215 const char* service_exec_ex_command_to_string(ServiceExecCommand i) _const_;
 216 ServiceExecCommand service_exec_ex_command_from_string(const char *s) _pure_;
 217
 218 const char* notify_state_to_string(NotifyState i) _const_;
 219 NotifyState notify_state_from_string(const char *s) _pure_;
 220
 221 const char* service_result_to_string(ServiceResult i) _const_;
 222 ServiceResult service_result_from_string(const char *s) _pure_;
 223
 224 DEFINE_CAST(SERVICE, Service);
 225
 226 #define STATUS_TEXT_MAX (16U*1024U)