src/basic/socket-util.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 #include <netinet/ether.h>
   5 #include <netinet/in.h>
   6 #include <stdbool.h>
   7 #include <stddef.h>
   8 #include <sys/socket.h>
   9 #include <sys/types.h>
  10 #include <sys/un.h>
  11 #include <linux/netlink.h>
  12 #include <linux/if_infiniband.h>
  13 #include <linux/if_packet.h>
  14
  15 #include "macro.h"
  16 #include "missing.h"
  17 #include "util.h"
  18
  19 union sockaddr_union {
  20         /* The minimal, abstract version */
  21         struct sockaddr sa;
  22
  23         /* The libc provided version that allocates "enough room" for every protocol */
  24         struct sockaddr_storage storage;
  25
  26         /* Protoctol-specific implementations */
  27         struct sockaddr_in in;
  28         struct sockaddr_in6 in6;
  29         struct sockaddr_un un;
  30 #if 0 /// UNNEEDED by elogind.
  31         struct sockaddr_nl nl;
  32         struct sockaddr_ll ll;
  33 #endif // 0
  34         struct sockaddr_vm vm;
  35
  36         /* Ensure there is enough space to store Infiniband addresses */
  37         uint8_t ll_buffer[offsetof(struct sockaddr_ll, sll_addr) + CONST_MAX(ETH_ALEN, INFINIBAND_ALEN)];
  38
  39         /* Ensure there is enough space after the AF_UNIX sun_path for one more NUL byte, just to be sure that the path
  40          * component is always followed by at least one NUL byte. */
  41         uint8_t un_buffer[sizeof(struct sockaddr_un) + 1];
  42 };
  43
  44 #if 0 /// UNNEEDED by elogind
  45 typedef struct SocketAddress {
  46         union sockaddr_union sockaddr;
  47
  48         /* We store the size here explicitly due to the weird
  49          * sockaddr_un semantics for abstract sockets */
  50         socklen_t size;
  51
  52         /* Socket type, i.e. SOCK_STREAM, SOCK_DGRAM, ... */
  53         int type;
  54
  55         /* Socket protocol, IPPROTO_xxx, usually 0, except for netlink */
  56         int protocol;
  57 } SocketAddress;
  58
  59 typedef enum SocketAddressBindIPv6Only {
  60         SOCKET_ADDRESS_DEFAULT,
  61         SOCKET_ADDRESS_BOTH,
  62         SOCKET_ADDRESS_IPV6_ONLY,
  63         _SOCKET_ADDRESS_BIND_IPV6_ONLY_MAX,
  64         _SOCKET_ADDRESS_BIND_IPV6_ONLY_INVALID = -1
  65 } SocketAddressBindIPv6Only;
  66
  67 #define socket_address_family(a) ((a)->sockaddr.sa.sa_family)
  68
  69 const char* socket_address_type_to_string(int t) _const_;
  70 int socket_address_type_from_string(const char *s) _pure_;
  71
  72 int socket_address_parse(SocketAddress *a, const char *s);
  73 int socket_address_parse_and_warn(SocketAddress *a, const char *s);
  74 int socket_address_parse_netlink(SocketAddress *a, const char *s);
  75 int socket_address_print(const SocketAddress *a, char **p);
  76 int socket_address_verify(const SocketAddress *a) _pure_;
  77 int socket_address_unlink(SocketAddress *a);
  78
  79 bool socket_address_can_accept(const SocketAddress *a) _pure_;
  80
  81 int socket_address_listen(
  82                 const SocketAddress *a,
  83                 int flags,
  84                 int backlog,
  85                 SocketAddressBindIPv6Only only,
  86                 const char *bind_to_device,
  87                 bool reuse_port,
  88                 bool free_bind,
  89                 bool transparent,
  90                 mode_t directory_mode,
  91                 mode_t socket_mode,
  92                 const char *label);
  93 int make_socket_fd(int log_level, const char* address, int type, int flags);
  94
  95 bool socket_address_is(const SocketAddress *a, const char *s, int type);
  96 bool socket_address_is_netlink(const SocketAddress *a, const char *s);
  97
  98 bool socket_address_matches_fd(const SocketAddress *a, int fd);
  99
 100 bool socket_address_equal(const SocketAddress *a, const SocketAddress *b) _pure_;
 101
 102 const char* socket_address_get_path(const SocketAddress *a);
 103
 104 bool socket_ipv6_is_supported(void);
 105 #endif // 0
 106
 107 int sockaddr_port(const struct sockaddr *_sa, unsigned *port);
 108
 109 #if 0 /// UNNEEDED by elogind
 110 int sockaddr_pretty(const struct sockaddr *_sa, socklen_t salen, bool translate_ipv6, bool include_port, char **ret);
 111 int getpeername_pretty(int fd, bool include_port, char **ret);
 112 int getsockname_pretty(int fd, char **ret);
 113
 114 int socknameinfo_pretty(union sockaddr_union *sa, socklen_t salen, char **_ret);
 115
 116 const char* socket_address_bind_ipv6_only_to_string(SocketAddressBindIPv6Only b) _const_;
 117 SocketAddressBindIPv6Only socket_address_bind_ipv6_only_from_string(const char *s) _pure_;
 118 SocketAddressBindIPv6Only socket_address_bind_ipv6_only_or_bool_from_string(const char *s);
 119
 120 int netlink_family_to_string_alloc(int b, char **s);
 121 int netlink_family_from_string(const char *s) _pure_;
 122
 123 bool sockaddr_equal(const union sockaddr_union *a, const union sockaddr_union *b);
 124 #endif // 0
 125
 126 int fd_inc_sndbuf(int fd, size_t n);
 127 int fd_inc_rcvbuf(int fd, size_t n);
 128 #if 0 /// UNNEEDED by elogind
 129
 130 int ip_tos_to_string_alloc(int i, char **s);
 131 int ip_tos_from_string(const char *s);
 132
 133 bool ifname_valid(const char *p);
 134 bool address_label_valid(const char *p);
 135 #endif // 0
 136
 137 int getpeercred(int fd, struct ucred *ucred);
 138 int getpeersec(int fd, char **ret);
 139 int getpeergroups(int fd, gid_t **ret);
 140
 141 int send_one_fd_sa(int transport_fd,
 142                    int fd,
 143                    const struct sockaddr *sa, socklen_t len,
 144                    int flags);
 145 #define send_one_fd(transport_fd, fd, flags) send_one_fd_sa(transport_fd, fd, NULL, 0, flags)
 146 #if 0 /// UNNEEDED by elogind
 147 int receive_one_fd(int transport_fd, int flags);
 148
 149 ssize_t next_datagram_size_fd(int fd);
 150
 151 int flush_accept(int fd);
 152 #endif // 0
 153
 154 #define CMSG_FOREACH(cmsg, mh)                                          \
 155         for ((cmsg) = CMSG_FIRSTHDR(mh); (cmsg); (cmsg) = CMSG_NXTHDR((mh), (cmsg)))
 156
 157 #if 0 /// UNNEEDED by elogind
 158 struct cmsghdr* cmsg_find(struct msghdr *mh, int level, int type, socklen_t length);
 159 #endif // 0
 160
 161 /*
 162  * Certain hardware address types (e.g Infiniband) do not fit into sll_addr
 163  * (8 bytes) and run over the structure. This macro returns the correct size that
 164  * must be passed to kernel.
 165  */
 166 #define SOCKADDR_LL_LEN(sa)                                             \
 167         ({                                                              \
 168                 const struct sockaddr_ll *_sa = &(sa);                  \
 169                 size_t _mac_len = sizeof(_sa->sll_addr);                \
 170                 assert(_sa->sll_family == AF_PACKET);                   \
 171                 if (be16toh(_sa->sll_hatype) == ARPHRD_ETHER)           \
 172                         _mac_len = MAX(_mac_len, (size_t) ETH_ALEN);    \
 173                 if (be16toh(_sa->sll_hatype) == ARPHRD_INFINIBAND)      \
 174                         _mac_len = MAX(_mac_len, (size_t) INFINIBAND_ALEN); \
 175                 offsetof(struct sockaddr_ll, sll_addr) + _mac_len;      \
 176         })
 177
 178 /* Covers only file system and abstract AF_UNIX socket addresses, but not unnamed socket addresses. */
 179 #define SOCKADDR_UN_LEN(sa)                                             \
 180         ({                                                              \
 181                 const struct sockaddr_un *_sa = &(sa);                  \
 182                 assert(_sa->sun_family == AF_UNIX);                     \
 183                 offsetof(struct sockaddr_un, sun_path) +                \
 184                         (_sa->sun_path[0] == 0 ?                        \
 185                          1 + strnlen(_sa->sun_path+1, sizeof(_sa->sun_path)-1) : \
 186                          strnlen(_sa->sun_path, sizeof(_sa->sun_path))); \
 187         })
 188
 189 #if 0 /// UNNEEDED by elogind
 190 int socket_ioctl_fd(void);
 191 #endif // 0