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