]>
Commit | Line | Data |
---|---|---|
db9ecf05 | 1 | /* SPDX-License-Identifier: LGPL-2.1-or-later */ |
c2f1db8f | 2 | #pragma once |
42f4e3c4 | 3 | |
ef118d00 YW |
4 | #include <inttypes.h> |
5 | #include <linux/netlink.h> | |
8f815e8b | 6 | #include <linux/if_ether.h> |
ef118d00 YW |
7 | #include <linux/if_infiniband.h> |
8 | #include <linux/if_packet.h> | |
71d35b6b | 9 | #include <netinet/in.h> |
11c3a366 TA |
10 | #include <stdbool.h> |
11 | #include <stddef.h> | |
56fb30d9 | 12 | #include <string.h> |
71d35b6b | 13 | #include <sys/socket.h> |
11c3a366 | 14 | #include <sys/types.h> |
42f4e3c4 LP |
15 | #include <sys/un.h> |
16 | ||
befab2c4 | 17 | #include "errno-util.h" |
c1b91f06 | 18 | #include "in-addr-util.h" |
42f4e3c4 | 19 | #include "macro.h" |
402506ce | 20 | #include "missing_network.h" |
ef118d00 YW |
21 | #include "missing_socket.h" |
22 | #include "sparse-endian.h" | |
42f4e3c4 | 23 | |
f6144808 | 24 | union sockaddr_union { |
8b7f989a | 25 | /* The minimal, abstract version */ |
f6144808 | 26 | struct sockaddr sa; |
8b7f989a LP |
27 | |
28 | /* The libc provided version that allocates "enough room" for every protocol */ | |
29 | struct sockaddr_storage storage; | |
30 | ||
31 | /* Protoctol-specific implementations */ | |
4d49b48c | 32 | struct sockaddr_in in; |
f6144808 LP |
33 | struct sockaddr_in6 in6; |
34 | struct sockaddr_un un; | |
7a22745a | 35 | struct sockaddr_nl nl; |
e88bc795 | 36 | struct sockaddr_ll ll; |
0fc0f14b | 37 | struct sockaddr_vm vm; |
8b7f989a | 38 | |
b1f24b75 BG |
39 | /* Ensure there is enough space to store Infiniband addresses */ |
40 | uint8_t ll_buffer[offsetof(struct sockaddr_ll, sll_addr) + CONST_MAX(ETH_ALEN, INFINIBAND_ALEN)]; | |
8b7f989a LP |
41 | |
42 | /* Ensure there is enough space after the AF_UNIX sun_path for one more NUL byte, just to be sure that the path | |
43 | * component is always followed by at least one NUL byte. */ | |
44 | uint8_t un_buffer[sizeof(struct sockaddr_un) + 1]; | |
f6144808 LP |
45 | }; |
46 | ||
5c3fa98d ZJS |
47 | #define SUN_PATH_LEN (sizeof(((struct sockaddr_un){}).sun_path)) |
48 | ||
542563ba | 49 | typedef struct SocketAddress { |
f6144808 | 50 | union sockaddr_union sockaddr; |
42f4e3c4 LP |
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; | |
7a22745a LP |
58 | |
59 | /* Socket protocol, IPPROTO_xxx, usually 0, except for netlink */ | |
60 | int protocol; | |
542563ba | 61 | } SocketAddress; |
42f4e3c4 | 62 | |
542563ba LP |
63 | typedef enum SocketAddressBindIPv6Only { |
64 | SOCKET_ADDRESS_DEFAULT, | |
65 | SOCKET_ADDRESS_BOTH, | |
c0120d99 LP |
66 | SOCKET_ADDRESS_IPV6_ONLY, |
67 | _SOCKET_ADDRESS_BIND_IPV6_ONLY_MAX, | |
2d93c20e | 68 | _SOCKET_ADDRESS_BIND_IPV6_ONLY_INVALID = -EINVAL, |
542563ba | 69 | } SocketAddressBindIPv6Only; |
42f4e3c4 | 70 | |
542563ba | 71 | #define socket_address_family(a) ((a)->sockaddr.sa.sa_family) |
42f4e3c4 | 72 | |
398ce0bc YW |
73 | const char* socket_address_type_to_string(int t) _const_; |
74 | int socket_address_type_from_string(const char *s) _pure_; | |
75 | ||
9f20fc28 LP |
76 | int sockaddr_un_unlink(const struct sockaddr_un *sa); |
77 | ||
78 | static inline int socket_address_unlink(const SocketAddress *a) { | |
79 | return socket_address_family(a) == AF_UNIX ? sockaddr_un_unlink(&a->sockaddr.un) : 0; | |
80 | } | |
b5a0699f | 81 | |
44a6b1b6 | 82 | bool socket_address_can_accept(const SocketAddress *a) _pure_; |
4f2d528d | 83 | |
b5a0699f LP |
84 | int socket_address_listen( |
85 | const SocketAddress *a, | |
175a3d25 | 86 | int flags, |
b5a0699f LP |
87 | int backlog, |
88 | SocketAddressBindIPv6Only only, | |
89 | const char *bind_to_device, | |
54255c64 | 90 | bool reuse_port, |
4fd5948e | 91 | bool free_bind, |
6b6d2dee | 92 | bool transparent, |
b5a0699f LP |
93 | mode_t directory_mode, |
94 | mode_t socket_mode, | |
175a3d25 | 95 | const char *label); |
a16e1123 | 96 | |
5c3fa98d ZJS |
97 | int socket_address_verify(const SocketAddress *a, bool strict) _pure_; |
98 | int socket_address_print(const SocketAddress *a, char **p); | |
01e10de3 LP |
99 | bool socket_address_matches_fd(const SocketAddress *a, int fd); |
100 | ||
44a6b1b6 | 101 | bool socket_address_equal(const SocketAddress *a, const SocketAddress *b) _pure_; |
a16e1123 | 102 | |
a57f7e2c | 103 | const char* socket_address_get_path(const SocketAddress *a); |
6e2ef85b | 104 | |
4d49b48c | 105 | bool socket_ipv6_is_supported(void); |
83e03c4f | 106 | bool socket_ipv6_is_enabled(void); |
4d49b48c | 107 | |
69dc6922 | 108 | int sockaddr_port(const struct sockaddr *_sa, unsigned *port); |
31325971 | 109 | const union in_addr_union *sockaddr_in_addr(const struct sockaddr *sa); |
c1b91f06 | 110 | int sockaddr_set_in_addr(union sockaddr_union *u, int family, const union in_addr_union *a, uint16_t port); |
3b1c5241 SL |
111 | |
112 | int sockaddr_pretty(const struct sockaddr *_sa, socklen_t salen, bool translate_ipv6, bool include_port, char **ret); | |
366b7db4 | 113 | int getpeername_pretty(int fd, bool include_port, char **ret); |
4d49b48c LP |
114 | int getsockname_pretty(int fd, char **ret); |
115 | ||
b31f535c | 116 | int socknameinfo_pretty(union sockaddr_union *sa, socklen_t salen, char **_ret); |
b31f535c | 117 | |
44a6b1b6 ZJS |
118 | const char* socket_address_bind_ipv6_only_to_string(SocketAddressBindIPv6Only b) _const_; |
119 | SocketAddressBindIPv6Only socket_address_bind_ipv6_only_from_string(const char *s) _pure_; | |
b54e98ef | 120 | SocketAddressBindIPv6Only socket_address_bind_ipv6_only_or_bool_from_string(const char *s); |
c0120d99 | 121 | |
f8b69d1d | 122 | int netlink_family_to_string_alloc(int b, char **s); |
4d49b48c | 123 | int netlink_family_from_string(const char *s) _pure_; |
f01e5736 LP |
124 | |
125 | bool sockaddr_equal(const union sockaddr_union *a, const union sockaddr_union *b); | |
2583fbea | 126 | |
d9d9b2a0 YW |
127 | int fd_set_sndbuf(int fd, size_t n, bool increase); |
128 | static inline int fd_inc_sndbuf(int fd, size_t n) { | |
129 | return fd_set_sndbuf(fd, n, true); | |
130 | } | |
131 | int fd_set_rcvbuf(int fd, size_t n, bool increase); | |
28e7e934 | 132 | static inline int fd_increase_rxbuf(int fd, size_t n) { |
d9d9b2a0 YW |
133 | return fd_set_rcvbuf(fd, n, true); |
134 | } | |
2583fbea LP |
135 | |
136 | int ip_tos_to_string_alloc(int i, char **s); | |
137 | int ip_tos_from_string(const char *s); | |
138 | ||
2313524a | 139 | typedef enum { |
6aebfec3 LP |
140 | IFNAME_VALID_ALTERNATIVE = 1 << 0, /* Allow "altnames" too */ |
141 | IFNAME_VALID_NUMERIC = 1 << 1, /* Allow decimal formatted ifindexes too */ | |
142 | IFNAME_VALID_SPECIAL = 1 << 2, /* Allow the special names "all" and "default" */ | |
143 | _IFNAME_VALID_ALL = IFNAME_VALID_ALTERNATIVE | IFNAME_VALID_NUMERIC | IFNAME_VALID_SPECIAL, | |
2313524a | 144 | } IfnameValidFlags; |
5a3586db | 145 | bool ifname_valid_char(char a); |
2313524a | 146 | bool ifname_valid_full(const char *p, IfnameValidFlags flags); |
4252696a | 147 | static inline bool ifname_valid(const char *p) { |
2313524a | 148 | return ifname_valid_full(p, 0); |
4252696a | 149 | } |
26808948 | 150 | bool address_label_valid(const char *p); |
ef76dff2 | 151 | |
2583fbea LP |
152 | int getpeercred(int fd, struct ucred *ucred); |
153 | int getpeersec(int fd, char **ret); | |
43f2c88d | 154 | int getpeergroups(int fd, gid_t **ret); |
2583fbea | 155 | |
d34673ec FB |
156 | ssize_t send_one_fd_iov_sa( |
157 | int transport_fd, | |
158 | int fd, | |
f621b8d7 | 159 | const struct iovec *iov, size_t iovlen, |
d34673ec FB |
160 | const struct sockaddr *sa, socklen_t len, |
161 | int flags); | |
726f4c47 ZJS |
162 | int send_one_fd_sa(int transport_fd, |
163 | int fd, | |
164 | const struct sockaddr *sa, socklen_t len, | |
165 | int flags); | |
d34673ec FB |
166 | #define send_one_fd_iov(transport_fd, fd, iov, iovlen, flags) send_one_fd_iov_sa(transport_fd, fd, iov, iovlen, NULL, 0, flags) |
167 | #define send_one_fd(transport_fd, fd, flags) send_one_fd_iov_sa(transport_fd, fd, NULL, 0, NULL, 0, flags) | |
168 | ssize_t receive_one_fd_iov(int transport_fd, struct iovec *iov, size_t iovlen, int flags, int *ret_fd); | |
2583fbea | 169 | int receive_one_fd(int transport_fd, int flags); |
8f328d36 | 170 | |
4edc2c9b LP |
171 | ssize_t next_datagram_size_fd(int fd); |
172 | ||
60d9771c LP |
173 | int flush_accept(int fd); |
174 | ||
8f328d36 LP |
175 | #define CMSG_FOREACH(cmsg, mh) \ |
176 | for ((cmsg) = CMSG_FIRSTHDR(mh); (cmsg); (cmsg) = CMSG_NXTHDR((mh), (cmsg))) | |
fc2fffe7 | 177 | |
79dec6f5 LP |
178 | /* Returns the cmsghdr's data pointer, but safely cast to the specified type. Does two alignment checks: one |
179 | * at compile time, that the requested type has a smaller or same alignment as 'struct cmsghdr', and one | |
180 | * during runtime, that the actual pointer matches the alignment too. This is supposed to catch cases such as | |
181 | * 'struct timeval' is embedded into 'struct cmsghdr' on architectures where the alignment of the former is 8 | |
182 | * bytes (because of a 64bit time_t), but of the latter is 4 bytes (because size_t is 32bit), such as | |
183 | * riscv32. */ | |
b6256af7 LP |
184 | #define CMSG_TYPED_DATA(cmsg, type) \ |
185 | ({ \ | |
4db752e4 | 186 | struct cmsghdr *_cmsg = (cmsg); \ |
1113e507 | 187 | assert_cc(alignof(type) <= alignof(struct cmsghdr)); \ |
b6256af7 LP |
188 | _cmsg ? CAST_ALIGN_PTR(type, CMSG_DATA(_cmsg)) : (type*) NULL; \ |
189 | }) | |
190 | ||
29206d46 | 191 | struct cmsghdr* cmsg_find(struct msghdr *mh, int level, int type, socklen_t length); |
4836f4c6 | 192 | void* cmsg_find_and_copy_data(struct msghdr *mh, int level, int type, void *buf, size_t buf_len); |
29206d46 | 193 | |
371d72e0 | 194 | /* Type-safe, dereferencing version of cmsg_find() */ |
b6256af7 LP |
195 | #define CMSG_FIND_DATA(mh, level, type, ctype) \ |
196 | CMSG_TYPED_DATA(cmsg_find(mh, level, type, CMSG_LEN(sizeof(ctype))), ctype) | |
371d72e0 | 197 | |
4836f4c6 YW |
198 | /* Type-safe version of cmsg_find_and_copy_data() */ |
199 | #define CMSG_FIND_AND_COPY_DATA(mh, level, type, ctype) \ | |
200 | (ctype*) cmsg_find_and_copy_data(mh, level, type, &(ctype){}, sizeof(ctype)) | |
201 | ||
fb29cdbe LP |
202 | /* Resolves to a type that can carry cmsghdr structures. Make sure things are properly aligned, i.e. the type |
203 | * itself is placed properly in memory and the size is also aligned to what's appropriate for "cmsghdr" | |
204 | * structures. */ | |
205 | #define CMSG_BUFFER_TYPE(size) \ | |
206 | union { \ | |
207 | struct cmsghdr cmsghdr; \ | |
208 | uint8_t buf[size]; \ | |
209 | uint8_t align_check[(size) >= CMSG_SPACE(0) && \ | |
210 | (size) == CMSG_ALIGN(size) ? 1 : -1]; \ | |
211 | } | |
212 | ||
b1f24b75 BG |
213 | /* |
214 | * Certain hardware address types (e.g Infiniband) do not fit into sll_addr | |
215 | * (8 bytes) and run over the structure. This macro returns the correct size that | |
216 | * must be passed to kernel. | |
217 | */ | |
218 | #define SOCKADDR_LL_LEN(sa) \ | |
219 | ({ \ | |
220 | const struct sockaddr_ll *_sa = &(sa); \ | |
221 | size_t _mac_len = sizeof(_sa->sll_addr); \ | |
222 | assert(_sa->sll_family == AF_PACKET); \ | |
223 | if (be16toh(_sa->sll_hatype) == ARPHRD_ETHER) \ | |
224 | _mac_len = MAX(_mac_len, (size_t) ETH_ALEN); \ | |
225 | if (be16toh(_sa->sll_hatype) == ARPHRD_INFINIBAND) \ | |
226 | _mac_len = MAX(_mac_len, (size_t) INFINIBAND_ALEN); \ | |
227 | offsetof(struct sockaddr_ll, sll_addr) + _mac_len; \ | |
228 | }) | |
229 | ||
fc2fffe7 LP |
230 | /* Covers only file system and abstract AF_UNIX socket addresses, but not unnamed socket addresses. */ |
231 | #define SOCKADDR_UN_LEN(sa) \ | |
232 | ({ \ | |
233 | const struct sockaddr_un *_sa = &(sa); \ | |
234 | assert(_sa->sun_family == AF_UNIX); \ | |
235 | offsetof(struct sockaddr_un, sun_path) + \ | |
236 | (_sa->sun_path[0] == 0 ? \ | |
237 | 1 + strnlen(_sa->sun_path+1, sizeof(_sa->sun_path)-1) : \ | |
69995bff | 238 | strnlen(_sa->sun_path, sizeof(_sa->sun_path))+1); \ |
fc2fffe7 | 239 | }) |
429b4350 | 240 | |
b501e42e | 241 | #define SOCKADDR_LEN(saddr) \ |
4e0a46f6 | 242 | ({ \ |
b501e42e | 243 | const union sockaddr_union *__sa = &(saddr); \ |
4e0a46f6 | 244 | size_t _len; \ |
79893116 | 245 | switch (__sa->sa.sa_family) { \ |
4e0a46f6 YW |
246 | case AF_INET: \ |
247 | _len = sizeof(struct sockaddr_in); \ | |
248 | break; \ | |
249 | case AF_INET6: \ | |
250 | _len = sizeof(struct sockaddr_in6); \ | |
251 | break; \ | |
252 | case AF_UNIX: \ | |
253 | _len = SOCKADDR_UN_LEN(__sa->un); \ | |
254 | break; \ | |
255 | case AF_PACKET: \ | |
256 | _len = SOCKADDR_LL_LEN(__sa->ll); \ | |
257 | break; \ | |
258 | case AF_NETLINK: \ | |
259 | _len = sizeof(struct sockaddr_nl); \ | |
260 | break; \ | |
261 | case AF_VSOCK: \ | |
262 | _len = sizeof(struct sockaddr_vm); \ | |
263 | break; \ | |
264 | default: \ | |
04499a70 | 265 | assert_not_reached(); \ |
4e0a46f6 YW |
266 | } \ |
267 | _len; \ | |
268 | }) | |
269 | ||
429b4350 | 270 | int socket_ioctl_fd(void); |
5cf91ea9 LP |
271 | |
272 | int sockaddr_un_set_path(struct sockaddr_un *ret, const char *path); | |
2ff48e98 LP |
273 | |
274 | static inline int setsockopt_int(int fd, int level, int optname, int value) { | |
275 | if (setsockopt(fd, level, optname, &value, sizeof(value)) < 0) | |
276 | return -errno; | |
277 | ||
278 | return 0; | |
279 | } | |
5d594d01 | 280 | |
4e25d4cf LP |
281 | static inline int getsockopt_int(int fd, int level, int optname, int *ret) { |
282 | int v; | |
283 | socklen_t sl = sizeof(v); | |
284 | ||
285 | if (getsockopt(fd, level, optname, &v, &sl) < 0) | |
befab2c4 | 286 | return negative_errno(); |
4e25d4cf LP |
287 | if (sl != sizeof(v)) |
288 | return -EIO; | |
289 | ||
290 | *ret = v; | |
291 | return 0; | |
292 | } | |
293 | ||
5d594d01 LP |
294 | int socket_bind_to_ifname(int fd, const char *ifname); |
295 | int socket_bind_to_ifindex(int fd, int ifindex); | |
47eae6ce | 296 | |
9365e296 YW |
297 | /* Define a 64bit version of timeval/timespec in any case, even on 32bit userspace. */ |
298 | struct timeval_large { | |
299 | uint64_t tvl_sec, tvl_usec; | |
300 | }; | |
301 | struct timespec_large { | |
302 | uint64_t tvl_sec, tvl_nsec; | |
303 | }; | |
304 | ||
305 | /* glibc duplicates timespec/timeval on certain 32bit archs, once in 32bit and once in 64bit. | |
05403363 | 306 | * See __convert_scm_timestamps() in glibc source code. Hence, we need additional buffer space for them |
9365e296 YW |
307 | * to prevent from recvmsg_safe() returning -EXFULL. */ |
308 | #define CMSG_SPACE_TIMEVAL \ | |
309 | ((sizeof(struct timeval) == sizeof(struct timeval_large)) ? \ | |
310 | CMSG_SPACE(sizeof(struct timeval)) : \ | |
311 | CMSG_SPACE(sizeof(struct timeval)) + \ | |
312 | CMSG_SPACE(sizeof(struct timeval_large))) | |
313 | #define CMSG_SPACE_TIMESPEC \ | |
314 | ((sizeof(struct timespec) == sizeof(struct timespec_large)) ? \ | |
315 | CMSG_SPACE(sizeof(struct timespec)) : \ | |
316 | CMSG_SPACE(sizeof(struct timespec)) + \ | |
317 | CMSG_SPACE(sizeof(struct timespec_large))) | |
318 | ||
47eae6ce | 319 | ssize_t recvmsg_safe(int sockfd, struct msghdr *msg, int flags); |
35a3eb9b | 320 | |
5f64d2bf | 321 | int socket_get_family(int fd); |
5d0fe423 | 322 | int socket_set_recvpktinfo(int fd, int af, bool b); |
5d0fe423 | 323 | int socket_set_unicast_if(int fd, int af, int ifi); |
00ed2fff | 324 | |
402506ce YW |
325 | int socket_set_option(int fd, int af, int opt_ipv4, int opt_ipv6, int val); |
326 | static inline int socket_set_recverr(int fd, int af, bool b) { | |
327 | return socket_set_option(fd, af, IP_RECVERR, IPV6_RECVERR, b); | |
328 | } | |
329 | static inline int socket_set_recvttl(int fd, int af, bool b) { | |
330 | return socket_set_option(fd, af, IP_RECVTTL, IPV6_RECVHOPLIMIT, b); | |
331 | } | |
332 | static inline int socket_set_ttl(int fd, int af, int ttl) { | |
333 | return socket_set_option(fd, af, IP_TTL, IPV6_UNICAST_HOPS, ttl); | |
334 | } | |
335 | static inline int socket_set_freebind(int fd, int af, bool b) { | |
336 | return socket_set_option(fd, af, IP_FREEBIND, IPV6_FREEBIND, b); | |
337 | } | |
338 | static inline int socket_set_transparent(int fd, int af, bool b) { | |
339 | return socket_set_option(fd, af, IP_TRANSPARENT, IPV6_TRANSPARENT, b); | |
340 | } | |
00ed2fff LP |
341 | static inline int socket_set_recvfragsize(int fd, int af, bool b) { |
342 | return socket_set_option(fd, af, IP_RECVFRAGSIZE, IPV6_RECVFRAGSIZE, b); | |
343 | } | |
52975f86 LP |
344 | |
345 | int socket_get_mtu(int fd, int af, size_t *ret); | |
a995ce47 LP |
346 | |
347 | /* an initializer for struct ucred that initialized all fields to the invalid value appropriate for each */ | |
348 | #define UCRED_INVALID { .pid = 0, .uid = UID_INVALID, .gid = GID_INVALID } | |
2679aee4 LP |
349 | |
350 | int connect_unix_path(int fd, int dir_fd, const char *path); | |
747b5d96 LB |
351 | |
352 | /* Parses AF_UNIX and AF_VSOCK addresses. AF_INET[6] require some netlink calls, so it cannot be in | |
353 | * src/basic/ and is done from 'socket_local_address from src/shared/. Return -EPROTO in case of | |
354 | * protocol mismatch. */ | |
355 | int socket_address_parse_unix(SocketAddress *ret_address, const char *s); | |
356 | int socket_address_parse_vsock(SocketAddress *ret_address, const char *s); |