src/core/socket.h

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