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