src/core/socket.h

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