src/core/socket.h

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