src/core/service.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #pragma once
   4
   5 /***
   6   This file is part of systemd.
   7
   8   Copyright 2010 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 ***/
  23
  24 typedef struct Service Service;
  25 typedef struct ServiceFDStore ServiceFDStore;
  26
  27 #include "exit-status.h"
  28 #include "kill.h"
  29 #include "path.h"
  30 #include "ratelimit.h"
  31
  32 typedef enum ServiceRestart {
  33         SERVICE_RESTART_NO,
  34         SERVICE_RESTART_ON_SUCCESS,
  35         SERVICE_RESTART_ON_FAILURE,
  36         SERVICE_RESTART_ON_ABNORMAL,
  37         SERVICE_RESTART_ON_WATCHDOG,
  38         SERVICE_RESTART_ON_ABORT,
  39         SERVICE_RESTART_ALWAYS,
  40         _SERVICE_RESTART_MAX,
  41         _SERVICE_RESTART_INVALID = -1
  42 } ServiceRestart;
  43
  44 typedef enum ServiceType {
  45         SERVICE_SIMPLE,   /* we fork and go on right-away (i.e. modern socket activated daemons) */
  46         SERVICE_FORKING,  /* forks by itself (i.e. traditional daemons) */
  47         SERVICE_ONESHOT,  /* we fork and wait until the program finishes (i.e. programs like fsck which run and need to finish before we continue) */
  48         SERVICE_DBUS,     /* we fork and wait until a specific D-Bus name appears on the bus */
  49         SERVICE_NOTIFY,   /* we fork and wait until a daemon sends us a ready message with sd_notify() */
  50         SERVICE_IDLE,     /* much like simple, but delay exec() until all jobs are dispatched. */
  51         _SERVICE_TYPE_MAX,
  52         _SERVICE_TYPE_INVALID = -1
  53 } ServiceType;
  54
  55 typedef enum ServiceExecCommand {
  56         SERVICE_EXEC_START_PRE,
  57         SERVICE_EXEC_START,
  58         SERVICE_EXEC_START_POST,
  59         SERVICE_EXEC_RELOAD,
  60         SERVICE_EXEC_STOP,
  61         SERVICE_EXEC_STOP_POST,
  62         _SERVICE_EXEC_COMMAND_MAX,
  63         _SERVICE_EXEC_COMMAND_INVALID = -1
  64 } ServiceExecCommand;
  65
  66 typedef enum NotifyAccess {
  67         NOTIFY_NONE,
  68         NOTIFY_ALL,
  69         NOTIFY_MAIN,
  70         _NOTIFY_ACCESS_MAX,
  71         _NOTIFY_ACCESS_INVALID = -1
  72 } NotifyAccess;
  73
  74 typedef enum NotifyState {
  75         NOTIFY_UNKNOWN,
  76         NOTIFY_READY,
  77         NOTIFY_RELOADING,
  78         NOTIFY_STOPPING,
  79         _NOTIFY_STATE_MAX,
  80         _NOTIFY_STATE_INVALID = -1
  81 } NotifyState;
  82
  83 typedef enum ServiceResult {
  84         SERVICE_SUCCESS,
  85         SERVICE_FAILURE_RESOURCES,
  86         SERVICE_FAILURE_TIMEOUT,
  87         SERVICE_FAILURE_EXIT_CODE,
  88         SERVICE_FAILURE_SIGNAL,
  89         SERVICE_FAILURE_CORE_DUMP,
  90         SERVICE_FAILURE_WATCHDOG,
  91         SERVICE_FAILURE_START_LIMIT,
  92         _SERVICE_RESULT_MAX,
  93         _SERVICE_RESULT_INVALID = -1
  94 } ServiceResult;
  95
  96 struct ServiceFDStore {
  97         Service *service;
  98
  99         int fd;
 100         char *fdname;
 101         sd_event_source *event_source;
 102
 103         LIST_FIELDS(ServiceFDStore, fd_store);
 104 };
 105
 106 struct Service {
 107         Unit meta;
 108
 109         ServiceType type;
 110         ServiceRestart restart;
 111         ExitStatusSet restart_prevent_status;
 112         ExitStatusSet restart_force_status;
 113         ExitStatusSet success_status;
 114
 115         /* If set we'll read the main daemon PID from this file */
 116         char *pid_file;
 117
 118         usec_t restart_usec;
 119         usec_t timeout_start_usec;
 120         usec_t timeout_stop_usec;
 121         usec_t runtime_max_usec;
 122
 123         dual_timestamp watchdog_timestamp;
 124         usec_t watchdog_usec;
 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
 152         pid_t main_pid, control_pid;
 153         int socket_fd;
 154         bool socket_fd_selinux_context_net;
 155
 156         int bus_endpoint_fd;
 157
 158         bool permissions_start_only;
 159         bool root_directory_start_only;
 160         bool remain_after_exit;
 161         bool guess_main_pid;
 162
 163         /* If we shut down, remember why */
 164         ServiceResult result;
 165         ServiceResult reload_result;
 166
 167         bool main_pid_known:1;
 168         bool main_pid_alien:1;
 169         bool bus_name_good:1;
 170         bool forbid_restart:1;
 171         bool start_timeout_defined:1;
 172
 173         bool reset_cpu_usage:1;
 174
 175         char *bus_name;
 176         char *bus_name_owner; /* unique name of the current owner */
 177
 178         char *status_text;
 179         int status_errno;
 180
 181         RateLimit start_limit;
 182         FailureAction start_limit_action;
 183         FailureAction failure_action;
 184         char *reboot_arg;
 185
 186         UnitRef accept_socket;
 187
 188         sd_event_source *timer_event_source;
 189         PathSpec *pid_file_pathspec;
 190
 191         NotifyAccess notify_access;
 192         NotifyState notify_state;
 193
 194         ServiceFDStore *fd_store;
 195         unsigned n_fd_store;
 196         unsigned n_fd_store_max;
 197
 198         char *usb_function_descriptors;
 199         char *usb_function_strings;
 200
 201         int stdin_fd;
 202         int stdout_fd;
 203         int stderr_fd;
 204 };
 205
 206 extern const UnitVTable service_vtable;
 207
 208 int service_set_socket_fd(Service *s, int fd, struct Socket *socket, bool selinux_context_net);
 209
 210 const char* service_restart_to_string(ServiceRestart i) _const_;
 211 ServiceRestart service_restart_from_string(const char *s) _pure_;
 212
 213 const char* service_type_to_string(ServiceType i) _const_;
 214 ServiceType service_type_from_string(const char *s) _pure_;
 215
 216 const char* service_exec_command_to_string(ServiceExecCommand i) _const_;
 217 ServiceExecCommand service_exec_command_from_string(const char *s) _pure_;
 218
 219 const char* notify_access_to_string(NotifyAccess i) _const_;
 220 NotifyAccess notify_access_from_string(const char *s) _pure_;
 221
 222 const char* notify_state_to_string(NotifyState i) _const_;
 223 NotifyState notify_state_from_string(const char *s) _pure_;
 224
 225 const char* service_result_to_string(ServiceResult i) _const_;
 226 ServiceResult service_result_from_string(const char *s) _pure_;