src/basic/socket-util.h

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