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
 122         dual_timestamp watchdog_timestamp;
 123         usec_t watchdog_usec;
 124         sd_event_source *watchdog_event_source;
 125
 126         ExecCommand* exec_command[_SERVICE_EXEC_COMMAND_MAX];
 127
 128         ExecContext exec_context;
 129         KillContext kill_context;
 130         CGroupContext cgroup_context;
 131
 132         ServiceState state, deserialized_state;
 133
 134         /* The exit status of the real main process */
 135         ExecStatus main_exec_status;
 136
 137         /* The currently executed control process */
 138         ExecCommand *control_command;
 139
 140         /* The currently executed main process, which may be NULL if
 141          * the main process got started via forking mode and not by
 142          * us */
 143         ExecCommand *main_command;
 144
 145         /* The ID of the control command currently being executed */
 146         ServiceExecCommand control_command_id;
 147
 148         /* Runtime data of the execution context */
 149         ExecRuntime *exec_runtime;
 150
 151         pid_t main_pid, control_pid;
 152         int socket_fd;
 153         bool socket_fd_selinux_context_net;
 154
 155         int bus_endpoint_fd;
 156
 157         bool permissions_start_only;
 158         bool root_directory_start_only;
 159         bool remain_after_exit;
 160         bool guess_main_pid;
 161
 162         /* If we shut down, remember why */
 163         ServiceResult result;
 164         ServiceResult reload_result;
 165
 166         bool main_pid_known:1;
 167         bool main_pid_alien:1;
 168         bool bus_name_good:1;
 169         bool forbid_restart:1;
 170         bool start_timeout_defined:1;
 171
 172         bool reset_cpu_usage:1;
 173
 174         char *bus_name;
 175         char *bus_name_owner; /* unique name of the current owner */
 176
 177         char *status_text;
 178         int status_errno;
 179
 180         RateLimit start_limit;
 181         FailureAction start_limit_action;
 182         FailureAction failure_action;
 183         char *reboot_arg;
 184
 185         UnitRef accept_socket;
 186
 187         sd_event_source *timer_event_source;
 188         PathSpec *pid_file_pathspec;
 189
 190         NotifyAccess notify_access;
 191         NotifyState notify_state;
 192
 193         ServiceFDStore *fd_store;
 194         unsigned n_fd_store;
 195         unsigned n_fd_store_max;
 196
 197         char *usb_function_descriptors;
 198         char *usb_function_strings;
 199
 200         int stdin_fd;
 201         int stdout_fd;
 202         int stderr_fd;
 203 };
 204
 205 extern const UnitVTable service_vtable;
 206
 207 int service_set_socket_fd(Service *s, int fd, struct Socket *socket, bool selinux_context_net);
 208
 209 const char* service_restart_to_string(ServiceRestart i) _const_;
 210 ServiceRestart service_restart_from_string(const char *s) _pure_;
 211
 212 const char* service_type_to_string(ServiceType i) _const_;
 213 ServiceType service_type_from_string(const char *s) _pure_;
 214
 215 const char* service_exec_command_to_string(ServiceExecCommand i) _const_;
 216 ServiceExecCommand service_exec_command_from_string(const char *s) _pure_;
 217
 218 const char* notify_access_to_string(NotifyAccess i) _const_;
 219 NotifyAccess notify_access_from_string(const char *s) _pure_;
 220
 221 const char* notify_state_to_string(NotifyState i) _const_;
 222 NotifyState notify_state_from_string(const char *s) _pure_;
 223
 224 const char* service_result_to_string(ServiceResult i) _const_;
 225 ServiceResult service_result_from_string(const char *s) _pure_;