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,
  84         SERVICE_FAILURE_TIMEOUT,
  85         SERVICE_FAILURE_EXIT_CODE,
  86         SERVICE_FAILURE_SIGNAL,
  87         SERVICE_FAILURE_CORE_DUMP,
  88         SERVICE_FAILURE_WATCHDOG,
  89         _SERVICE_RESULT_MAX,
  90         _SERVICE_RESULT_INVALID = -1
  91 } ServiceResult;
  92
  93 struct ServiceFDStore {
  94         Service *service;
  95
  96         int fd;
  97         char *fdname;
  98         sd_event_source *event_source;
  99
 100         LIST_FIELDS(ServiceFDStore, fd_store);
 101 };
 102
 103 struct Service {
 104         Unit meta;
 105
 106         ServiceType type;
 107         ServiceRestart restart;
 108         ExitStatusSet restart_prevent_status;
 109         ExitStatusSet restart_force_status;
 110         ExitStatusSet success_status;
 111
 112         /* If set we'll read the main daemon PID from this file */
 113         char *pid_file;
 114
 115         usec_t restart_usec;
 116         usec_t timeout_start_usec;
 117         usec_t timeout_stop_usec;
 118         usec_t runtime_max_usec;
 119
 120         dual_timestamp watchdog_timestamp;
 121         usec_t watchdog_usec;
 122         sd_event_source *watchdog_event_source;
 123
 124         ExecCommand* exec_command[_SERVICE_EXEC_COMMAND_MAX];
 125
 126         ExecContext exec_context;
 127         KillContext kill_context;
 128         CGroupContext cgroup_context;
 129
 130         ServiceState state, deserialized_state;
 131
 132         /* The exit status of the real main process */
 133         ExecStatus main_exec_status;
 134
 135         /* The currently executed control process */
 136         ExecCommand *control_command;
 137
 138         /* The currently executed main process, which may be NULL if
 139          * the main process got started via forking mode and not by
 140          * us */
 141         ExecCommand *main_command;
 142
 143         /* The ID of the control command currently being executed */
 144         ServiceExecCommand control_command_id;
 145
 146         /* Runtime data of the execution context */
 147         ExecRuntime *exec_runtime;
 148
 149         pid_t main_pid, control_pid;
 150         int socket_fd;
 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_cpu_usage: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         FailureAction failure_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
 198 extern const UnitVTable service_vtable;
 199
 200 int service_set_socket_fd(Service *s, int fd, struct Socket *socket, bool selinux_context_net);
 201
 202 const char* service_restart_to_string(ServiceRestart i) _const_;
 203 ServiceRestart service_restart_from_string(const char *s) _pure_;
 204
 205 const char* service_type_to_string(ServiceType i) _const_;
 206 ServiceType service_type_from_string(const char *s) _pure_;
 207
 208 const char* service_exec_command_to_string(ServiceExecCommand i) _const_;
 209 ServiceExecCommand service_exec_command_from_string(const char *s) _pure_;
 210
 211 const char* notify_access_to_string(NotifyAccess i) _const_;
 212 NotifyAccess notify_access_from_string(const char *s) _pure_;
 213
 214 const char* notify_state_to_string(NotifyState i) _const_;
 215 NotifyState notify_state_from_string(const char *s) _pure_;
 216
 217 const char* service_result_to_string(ServiceResult i) _const_;
 218 ServiceResult service_result_from_string(const char *s) _pure_;