src/core/socket.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 Socket Socket;
  25
  26 #include "socket-util.h"
  27 #include "mount.h"
  28 #include "service.h"
  29
  30 typedef enum SocketState {
  31         SOCKET_DEAD,
  32         SOCKET_START_PRE,
  33         SOCKET_START_CHOWN,
  34         SOCKET_START_POST,
  35         SOCKET_LISTENING,
  36         SOCKET_RUNNING,
  37         SOCKET_STOP_PRE,
  38         SOCKET_STOP_PRE_SIGTERM,
  39         SOCKET_STOP_PRE_SIGKILL,
  40         SOCKET_STOP_POST,
  41         SOCKET_FINAL_SIGTERM,
  42         SOCKET_FINAL_SIGKILL,
  43         SOCKET_FAILED,
  44         _SOCKET_STATE_MAX,
  45         _SOCKET_STATE_INVALID = -1
  46 } SocketState;
  47
  48 typedef enum SocketExecCommand {
  49         SOCKET_EXEC_START_PRE,
  50         SOCKET_EXEC_START_CHOWN,
  51         SOCKET_EXEC_START_POST,
  52         SOCKET_EXEC_STOP_PRE,
  53         SOCKET_EXEC_STOP_POST,
  54         _SOCKET_EXEC_COMMAND_MAX,
  55         _SOCKET_EXEC_COMMAND_INVALID = -1
  56 } SocketExecCommand;
  57
  58 typedef enum SocketType {
  59         SOCKET_SOCKET,
  60         SOCKET_FIFO,
  61         SOCKET_SPECIAL,
  62         SOCKET_MQUEUE,
  63         _SOCKET_FIFO_MAX,
  64         _SOCKET_FIFO_INVALID = -1
  65 } SocketType;
  66
  67 typedef enum SocketResult {
  68         SOCKET_SUCCESS,
  69         SOCKET_FAILURE_RESOURCES,
  70         SOCKET_FAILURE_TIMEOUT,
  71         SOCKET_FAILURE_EXIT_CODE,
  72         SOCKET_FAILURE_SIGNAL,
  73         SOCKET_FAILURE_CORE_DUMP,
  74         SOCKET_FAILURE_SERVICE_FAILED_PERMANENT,
  75         _SOCKET_RESULT_MAX,
  76         _SOCKET_RESULT_INVALID = -1
  77 } SocketResult;
  78
  79 typedef struct SocketPort {
  80         Socket *socket;
  81
  82         SocketType type;
  83         int fd;
  84
  85         SocketAddress address;
  86         char *path;
  87         sd_event_source *event_source;
  88
  89         LIST_FIELDS(struct SocketPort, port);
  90 } SocketPort;
  91
  92 struct Socket {
  93         Unit meta;
  94
  95         LIST_HEAD(SocketPort, ports);
  96
  97         unsigned n_accepted;
  98         unsigned n_connections;
  99         unsigned max_connections;
 100
 101         unsigned backlog;
 102         unsigned keep_alive_cnt;
 103         usec_t timeout_usec;
 104         usec_t keep_alive_time;
 105         usec_t keep_alive_interval;
 106         usec_t defer_accept;
 107
 108         ExecCommand* exec_command[_SOCKET_EXEC_COMMAND_MAX];
 109         ExecContext exec_context;
 110         KillContext kill_context;
 111         CGroupContext cgroup_context;
 112         ExecRuntime *exec_runtime;
 113
 114         /* For Accept=no sockets refers to the one service we'll
 115         activate. For Accept=yes sockets is either NULL, or filled
 116         when the next service we spawn. */
 117         UnitRef service;
 118
 119         SocketState state, deserialized_state;
 120
 121         sd_event_source *timer_event_source;
 122
 123         ExecCommand* control_command;
 124         SocketExecCommand control_command_id;
 125         pid_t control_pid;
 126
 127         mode_t directory_mode;
 128         mode_t socket_mode;
 129
 130         SocketResult result;
 131
 132         char **symlinks;
 133
 134         bool accept;
 135         bool remove_on_stop;
 136
 137         /* Socket options */
 138         bool keep_alive;
 139         bool no_delay;
 140         bool free_bind;
 141         bool transparent;
 142         bool broadcast;
 143         bool pass_cred;
 144         bool pass_sec;
 145
 146         /* Only for INET6 sockets: issue IPV6_V6ONLY sockopt */
 147         SocketAddressBindIPv6Only bind_ipv6_only;
 148
 149         int priority;
 150         int mark;
 151         size_t receive_buffer;
 152         size_t send_buffer;
 153         int ip_tos;
 154         int ip_ttl;
 155         size_t pipe_size;
 156         char *bind_to_device;
 157         char *tcp_congestion;
 158         bool reuse_port;
 159         long mq_maxmsg;
 160         long mq_msgsize;
 161
 162         char *smack;
 163         char *smack_ip_in;
 164         char *smack_ip_out;
 165
 166         bool selinux_context_from_net;
 167
 168         char *user, *group;
 169
 170         bool reset_cpu_usage:1;
 171 };
 172
 173 /* Called from the service code when collecting fds */
 174 int socket_collect_fds(Socket *s, int **fds, unsigned *n_fds);
 175
 176 /* Called from the service code when a per-connection service ended */
 177 void socket_connection_unref(Socket *s);
 178
 179 void socket_free_ports(Socket *s);
 180
 181 extern const UnitVTable socket_vtable;
 182
 183 const char* socket_state_to_string(SocketState i) _const_;
 184 SocketState socket_state_from_string(const char *s) _pure_;
 185
 186 const char* socket_exec_command_to_string(SocketExecCommand i) _const_;
 187 SocketExecCommand socket_exec_command_from_string(const char *s) _pure_;
 188
 189 const char* socket_result_to_string(SocketResult i) _const_;
 190 SocketResult socket_result_from_string(const char *s) _pure_;
 191
 192 const char* socket_port_type_to_string(SocketPort *p) _pure_;
 193
 194 int socket_instantiate_service(Socket *s);