]>
Commit | Line | Data |
---|---|---|
064af421 | 1 | /* |
ce04c33d | 2 | * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 Nicira, Inc. |
064af421 | 3 | * |
a14bc59f BP |
4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
5 | * you may not use this file except in compliance with the License. | |
6 | * You may obtain a copy of the License at: | |
064af421 | 7 | * |
a14bc59f BP |
8 | * http://www.apache.org/licenses/LICENSE-2.0 |
9 | * | |
10 | * Unless required by applicable law or agreed to in writing, software | |
11 | * distributed under the License is distributed on an "AS IS" BASIS, | |
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
13 | * See the License for the specific language governing permissions and | |
14 | * limitations under the License. | |
064af421 BP |
15 | */ |
16 | ||
17 | #include <config.h> | |
18 | #include "socket-util.h" | |
b2befd5b BP |
19 | #include <sys/types.h> |
20 | #include <netinet/in.h> | |
064af421 | 21 | #include <arpa/inet.h> |
5d77b36b | 22 | #include <ctype.h> |
064af421 BP |
23 | #include <errno.h> |
24 | #include <fcntl.h> | |
f89ffb0e | 25 | #include <net/if.h> |
064af421 | 26 | #include <netdb.h> |
b7cefbf7 | 27 | #include <netinet/tcp.h> |
064af421 BP |
28 | #include <poll.h> |
29 | #include <stddef.h> | |
30 | #include <stdio.h> | |
78ff0270 | 31 | #include <stdlib.h> |
064af421 | 32 | #include <string.h> |
3762274e BP |
33 | #include <sys/socket.h> |
34 | #include <sys/stat.h> | |
a7a27d07 | 35 | #include <sys/uio.h> |
064af421 BP |
36 | #include <sys/un.h> |
37 | #include <unistd.h> | |
3e8a2ad1 | 38 | #include "openvswitch/dynamic-string.h" |
b26f46a4 | 39 | #include "ovs-thread.h" |
f89ffb0e | 40 | #include "packets.h" |
fd016ae3 | 41 | #include "openvswitch/poll-loop.h" |
064af421 | 42 | #include "util.h" |
e6211adc | 43 | #include "openvswitch/vlog.h" |
2f51a7eb | 44 | #ifdef __linux__ |
f89ffb0e BP |
45 | #include <linux/if_packet.h> |
46 | #endif | |
47 | #ifdef HAVE_NETLINK | |
48 | #include "netlink-protocol.h" | |
49 | #include "netlink-socket.h" | |
50 | #endif | |
771680d9 | 51 | #include "dns-resolve.h" |
5136ce49 | 52 | |
d98e6007 | 53 | VLOG_DEFINE_THIS_MODULE(socket_util); |
064af421 | 54 | |
c1c19657 BP |
55 | static int getsockopt_int(int fd, int level, int option, const char *optname, |
56 | int *valuep); | |
93b7faf1 BP |
57 | static struct sockaddr_in *sin_cast(const struct sockaddr *); |
58 | static struct sockaddr_in6 *sin6_cast(const struct sockaddr *); | |
59 | static const struct sockaddr *sa_cast(const struct sockaddr_storage *); | |
771680d9 YS |
60 | static bool parse_sockaddr_components(struct sockaddr_storage *ss, |
61 | char *host_s, | |
62 | const char *port_s, | |
63 | uint16_t default_port, | |
64 | const char *s, | |
65 | bool resolve_host); | |
c1c19657 | 66 | |
064af421 BP |
67 | /* Sets 'fd' to non-blocking mode. Returns 0 if successful, otherwise a |
68 | * positive errno value. */ | |
69 | int | |
70 | set_nonblocking(int fd) | |
71 | { | |
de8bd597 | 72 | #ifndef _WIN32 |
064af421 BP |
73 | int flags = fcntl(fd, F_GETFL, 0); |
74 | if (flags != -1) { | |
75 | if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) != -1) { | |
76 | return 0; | |
77 | } else { | |
10a89ef0 | 78 | VLOG_ERR("fcntl(F_SETFL) failed: %s", ovs_strerror(errno)); |
064af421 BP |
79 | return errno; |
80 | } | |
81 | } else { | |
10a89ef0 | 82 | VLOG_ERR("fcntl(F_GETFL) failed: %s", ovs_strerror(errno)); |
064af421 BP |
83 | return errno; |
84 | } | |
de8bd597 GS |
85 | #else |
86 | unsigned long arg = 1; | |
87 | if (ioctlsocket(fd, FIONBIO, &arg)) { | |
88 | int error = sock_errno(); | |
89 | VLOG_ERR("set_nonblocking failed: %s", sock_strerror(error)); | |
90 | return error; | |
91 | } | |
92 | return 0; | |
93 | #endif | |
064af421 BP |
94 | } |
95 | ||
a0505c49 BP |
96 | void |
97 | xset_nonblocking(int fd) | |
98 | { | |
99 | if (set_nonblocking(fd)) { | |
100 | exit(EXIT_FAILURE); | |
101 | } | |
102 | } | |
103 | ||
b7cefbf7 GS |
104 | void |
105 | setsockopt_tcp_nodelay(int fd) | |
106 | { | |
107 | int on = 1; | |
108 | int retval; | |
109 | ||
110 | retval = setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &on, sizeof on); | |
111 | if (retval) { | |
112 | retval = sock_errno(); | |
113 | VLOG_ERR("setsockopt(TCP_NODELAY): %s", sock_strerror(retval)); | |
114 | } | |
115 | } | |
116 | ||
afc1d536 BP |
117 | /* Sets the DSCP value of socket 'fd' to 'dscp', which must be 63 or less. |
118 | * 'family' must indicate the socket's address family (AF_INET or AF_INET6, to | |
119 | * do anything useful). */ | |
6b9c1eab | 120 | int |
afc1d536 | 121 | set_dscp(int fd, int family, uint8_t dscp) |
cea15768 | 122 | { |
afc1d536 | 123 | int retval; |
eb0cb316 EM |
124 | int val; |
125 | ||
5349904d GS |
126 | #ifdef _WIN32 |
127 | /* XXX: Consider using QoS2 APIs for Windows to set dscp. */ | |
128 | return 0; | |
129 | #endif | |
130 | ||
cea15768 EJ |
131 | if (dscp > 63) { |
132 | return EINVAL; | |
133 | } | |
eb0cb316 | 134 | val = dscp << 2; |
afc1d536 BP |
135 | |
136 | switch (family) { | |
137 | case AF_INET: | |
138 | retval = setsockopt(fd, IPPROTO_IP, IP_TOS, &val, sizeof val); | |
139 | break; | |
140 | ||
141 | case AF_INET6: | |
142 | retval = setsockopt(fd, IPPROTO_IPV6, IPV6_TCLASS, &val, sizeof val); | |
143 | break; | |
144 | ||
145 | default: | |
92ae5930 | 146 | return ENOPROTOOPT; |
cea15768 EJ |
147 | } |
148 | ||
afc1d536 | 149 | return retval ? sock_errno() : 0; |
cea15768 EJ |
150 | } |
151 | ||
9835576b JB |
152 | /* Checks whether 'host_name' is an IPv4 or IPv6 address. It is assumed |
153 | * that 'host_name' is valid. Returns false if it is IPv4 address, true if | |
154 | * it is IPv6 address. */ | |
155 | bool | |
156 | addr_is_ipv6(const char *host_name) | |
157 | { | |
158 | return strchr(host_name, ':') != NULL; | |
159 | } | |
160 | ||
2b35e147 BP |
161 | /* Translates 'host_name', which must be a string representation of an IP |
162 | * address, into a numeric IP address in '*addr'. Returns 0 if successful, | |
163 | * otherwise a positive errno value. */ | |
064af421 | 164 | int |
d295e8e9 | 165 | lookup_ip(const char *host_name, struct in_addr *addr) |
064af421 | 166 | { |
e7695092 | 167 | if (!ip_parse(host_name, &addr->s_addr)) { |
db5ce514 | 168 | static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5); |
2b35e147 BP |
169 | VLOG_ERR_RL(&rl, "\"%s\" is not a valid IP address", host_name); |
170 | return ENOENT; | |
064af421 BP |
171 | } |
172 | return 0; | |
173 | } | |
174 | ||
d31f1109 JP |
175 | /* Translates 'host_name', which must be a string representation of an IPv6 |
176 | * address, into a numeric IPv6 address in '*addr'. Returns 0 if successful, | |
177 | * otherwise a positive errno value. */ | |
178 | int | |
179 | lookup_ipv6(const char *host_name, struct in6_addr *addr) | |
180 | { | |
e7695092 | 181 | if (!ipv6_parse(host_name, addr)) { |
d31f1109 JP |
182 | static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5); |
183 | VLOG_ERR_RL(&rl, "\"%s\" is not a valid IPv6 address", host_name); | |
184 | return ENOENT; | |
185 | } | |
186 | return 0; | |
187 | } | |
188 | ||
13f2ef97 BP |
189 | /* Translates 'host_name', which must be a host name or a string representation |
190 | * of an IP address, into a numeric IP address in '*addr'. Returns 0 if | |
191 | * successful, otherwise a positive errno value. | |
192 | * | |
193 | * Most Open vSwitch code should not use this because it causes deadlocks: | |
3cbb5dc7 | 194 | * getaddrinfo() sends out a DNS request but that starts a new flow for which |
13f2ef97 | 195 | * OVS must set up a flow, but it can't because it's waiting for a DNS reply. |
293d49bd | 196 | * The synchronous lookup also delays other activity. (Of course we can solve |
13f2ef97 BP |
197 | * this but it doesn't seem worthwhile quite yet.) */ |
198 | int | |
199 | lookup_hostname(const char *host_name, struct in_addr *addr) | |
200 | { | |
3cbb5dc7 BP |
201 | struct addrinfo *result; |
202 | struct addrinfo hints; | |
13f2ef97 | 203 | |
e7695092 | 204 | if (ip_parse(host_name, &addr->s_addr)) { |
13f2ef97 BP |
205 | return 0; |
206 | } | |
207 | ||
3cbb5dc7 BP |
208 | memset(&hints, 0, sizeof hints); |
209 | hints.ai_family = AF_INET; | |
210 | ||
211 | switch (getaddrinfo(host_name, NULL, &hints, &result)) { | |
212 | case 0: | |
db5a1019 AW |
213 | *addr = ALIGNED_CAST(struct sockaddr_in *, |
214 | result->ai_addr)->sin_addr; | |
3cbb5dc7 | 215 | freeaddrinfo(result); |
13f2ef97 | 216 | return 0; |
13f2ef97 | 217 | |
44f645a5 | 218 | #ifdef EAI_ADDRFAMILY |
3cbb5dc7 | 219 | case EAI_ADDRFAMILY: |
44f645a5 | 220 | #endif |
3cbb5dc7 BP |
221 | case EAI_NONAME: |
222 | case EAI_SERVICE: | |
223 | return ENOENT; | |
224 | ||
225 | case EAI_AGAIN: | |
226 | return EAGAIN; | |
227 | ||
228 | case EAI_BADFLAGS: | |
229 | case EAI_FAMILY: | |
230 | case EAI_SOCKTYPE: | |
231 | return EINVAL; | |
232 | ||
233 | case EAI_FAIL: | |
234 | return EIO; | |
235 | ||
236 | case EAI_MEMORY: | |
237 | return ENOMEM; | |
238 | ||
99ad8ba8 | 239 | #if defined (EAI_NODATA) && EAI_NODATA != EAI_NONAME |
3cbb5dc7 BP |
240 | case EAI_NODATA: |
241 | return ENXIO; | |
44f645a5 | 242 | #endif |
3cbb5dc7 | 243 | |
99ad8ba8 | 244 | #ifdef EAI_SYSTEM |
3cbb5dc7 | 245 | case EAI_SYSTEM: |
0f0b5401 | 246 | return sock_errno(); |
99ad8ba8 | 247 | #endif |
3cbb5dc7 BP |
248 | |
249 | default: | |
250 | return EPROTO; | |
251 | } | |
13f2ef97 BP |
252 | } |
253 | ||
064af421 | 254 | int |
d295e8e9 | 255 | check_connection_completion(int fd) |
064af421 | 256 | { |
d6cedfd9 | 257 | static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10); |
064af421 BP |
258 | struct pollfd pfd; |
259 | int retval; | |
260 | ||
261 | pfd.fd = fd; | |
262 | pfd.events = POLLOUT; | |
1bada7ab GS |
263 | |
264 | #ifndef _WIN32 | |
064af421 BP |
265 | do { |
266 | retval = poll(&pfd, 1, 0); | |
267 | } while (retval < 0 && errno == EINTR); | |
1bada7ab | 268 | #else |
ff792c6a AS |
269 | fd_set wrset, exset; |
270 | FD_ZERO(&wrset); | |
271 | FD_ZERO(&exset); | |
272 | FD_SET(fd, &exset); | |
273 | FD_SET(fd, &wrset); | |
274 | pfd.revents = 0; | |
275 | struct timeval tv = { 0, 0 }; | |
276 | /* WSAPoll is broken on Windows, instead do a select */ | |
277 | retval = select(0, NULL, &wrset, &exset, &tv); | |
278 | if (retval == 1) { | |
279 | if (FD_ISSET(fd, &wrset)) { | |
280 | pfd.revents |= pfd.events; | |
281 | } | |
282 | if (FD_ISSET(fd, &exset)) { | |
283 | pfd.revents |= POLLERR; | |
284 | } | |
285 | } | |
1bada7ab | 286 | #endif |
064af421 | 287 | if (retval == 1) { |
d6cedfd9 | 288 | if (pfd.revents & POLLERR) { |
1bada7ab | 289 | ssize_t n = send(fd, "", 1, 0); |
d6cedfd9 | 290 | if (n < 0) { |
1bada7ab | 291 | return sock_errno(); |
d6cedfd9 BP |
292 | } else { |
293 | VLOG_ERR_RL(&rl, "poll return POLLERR but send succeeded"); | |
294 | return EPROTO; | |
295 | } | |
296 | } | |
297 | return 0; | |
064af421 | 298 | } else if (retval < 0) { |
1bada7ab | 299 | VLOG_ERR_RL(&rl, "poll: %s", sock_strerror(sock_errno())); |
064af421 BP |
300 | return errno; |
301 | } else { | |
302 | return EAGAIN; | |
303 | } | |
304 | } | |
305 | ||
c1c19657 BP |
306 | /* Returns the size of socket 'sock''s receive buffer (SO_RCVBUF), or a |
307 | * negative errno value if an error occurs. */ | |
308 | int | |
309 | get_socket_rcvbuf(int sock) | |
310 | { | |
311 | int rcvbuf; | |
312 | int error; | |
313 | ||
314 | error = getsockopt_int(sock, SOL_SOCKET, SO_RCVBUF, "SO_RCVBUF", &rcvbuf); | |
315 | return error ? -error : rcvbuf; | |
316 | } | |
317 | ||
064af421 BP |
318 | /* Reads and discards up to 'n' datagrams from 'fd', stopping as soon as no |
319 | * more data can be immediately read. ('fd' should therefore be in | |
320 | * non-blocking mode.)*/ | |
321 | void | |
322 | drain_fd(int fd, size_t n_packets) | |
323 | { | |
324 | for (; n_packets > 0; n_packets--) { | |
325 | /* 'buffer' only needs to be 1 byte long in most circumstances. This | |
326 | * size is defensive against the possibility that we someday want to | |
327 | * use a Linux tap device without TUN_NO_PI, in which case a buffer | |
328 | * smaller than sizeof(struct tun_pi) will give EINVAL on read. */ | |
329 | char buffer[128]; | |
330 | if (read(fd, buffer, sizeof buffer) <= 0) { | |
331 | break; | |
332 | } | |
333 | } | |
334 | } | |
335 | ||
dbba996b BP |
336 | ovs_be32 |
337 | guess_netmask(ovs_be32 ip_) | |
064af421 | 338 | { |
dbba996b | 339 | uint32_t ip = ntohl(ip_); |
064af421 BP |
340 | return ((ip >> 31) == 0 ? htonl(0xff000000) /* Class A */ |
341 | : (ip >> 30) == 2 ? htonl(0xffff0000) /* Class B */ | |
342 | : (ip >> 29) == 6 ? htonl(0xffffff00) /* Class C */ | |
343 | : htonl(0)); /* ??? */ | |
344 | } | |
345 | ||
0b043300 BP |
346 | static char * |
347 | unbracket(char *s) | |
78ff0270 | 348 | { |
0b043300 BP |
349 | if (*s == '[') { |
350 | s++; | |
351 | ||
352 | char *end = strchr(s, '\0'); | |
353 | if (end[-1] == ']') { | |
354 | end[-1] = '\0'; | |
355 | } | |
356 | } | |
357 | return s; | |
358 | } | |
359 | ||
360 | /* 'host_index' is 0 if the host precedes the port within 's', 1 otherwise. */ | |
361 | static void | |
362 | inet_parse_tokens__(char *s, int host_index, char **hostp, char **portp) | |
363 | { | |
364 | char *colon = NULL; | |
365 | bool in_brackets = false; | |
366 | int n_colons = 0; | |
367 | for (char *p = s; *p; p++) { | |
368 | if (*p == '[') { | |
369 | in_brackets = true; | |
370 | } else if (*p == ']') { | |
371 | in_brackets = false; | |
372 | } else if (*p == ':' && !in_brackets) { | |
373 | n_colons++; | |
374 | colon = p; | |
375 | } | |
376 | } | |
377 | ||
378 | *hostp = *portp = NULL; | |
379 | if (n_colons > 1) { | |
380 | *hostp = s; | |
e731d71b | 381 | } else { |
0b043300 BP |
382 | char **tokens[2]; |
383 | tokens[host_index] = hostp; | |
384 | tokens[!host_index] = portp; | |
385 | ||
386 | if (colon) { | |
387 | *colon = '\0'; | |
388 | *tokens[1] = unbracket(colon + 1); | |
389 | } | |
390 | *tokens[0] = unbracket(s); | |
78ff0270 | 391 | } |
e731d71b | 392 | } |
78ff0270 | 393 | |
0b043300 BP |
394 | /* Parses 's', a string in the form "<host>[:<port>]", into its (required) host |
395 | * and (optional) port components, and stores pointers to them in '*hostp' and | |
396 | * '*portp' respectively. Always sets '*hostp' nonnull, although possibly to | |
f415dad9 | 397 | * an empty string. Can set '*portp' to the null string. |
0b043300 BP |
398 | * |
399 | * Supports both IPv4 and IPv6. IPv6 addresses may be quoted with square | |
400 | * brackets. Resolves ambiguous cases that might represent an IPv6 address or | |
401 | * an IPv6 address and a port as representing just a host, e.g. "::1:2:3:4:80" | |
402 | * is a host but "[::1:2:3:4]:80" is a host and a port. | |
403 | * | |
404 | * Modifies 's' and points '*hostp' and '*portp' (if nonnull) into it. | |
405 | */ | |
406 | void | |
407 | inet_parse_host_port_tokens(char *s, char **hostp, char **portp) | |
408 | { | |
409 | inet_parse_tokens__(s, 0, hostp, portp); | |
410 | } | |
411 | ||
412 | /* Parses 's', a string in the form "<port>[:<host>]", into its port and host | |
413 | * components, and stores pointers to them in '*portp' and '*hostp' | |
f415dad9 | 414 | * respectively. Either '*portp' and '*hostp' (but not both) can end up null. |
0b043300 BP |
415 | * |
416 | * Supports both IPv4 and IPv6. IPv6 addresses may be quoted with square | |
417 | * brackets. Resolves ambiguous cases that might represent an IPv6 address or | |
418 | * an IPv6 address and a port as representing just a host, e.g. "::1:2:3:4:80" | |
419 | * is a host but "[::1:2:3:4]:80" is a host and a port. | |
420 | * | |
421 | * Modifies 's' and points '*hostp' and '*portp' (if nonnull) into it. | |
422 | */ | |
423 | void | |
424 | inet_parse_port_host_tokens(char *s, char **portp, char **hostp) | |
425 | { | |
426 | inet_parse_tokens__(s, 1, hostp, portp); | |
427 | } | |
428 | ||
771680d9 YS |
429 | static bool |
430 | parse_sockaddr_components_dns(struct sockaddr_storage *ss OVS_UNUSED, | |
431 | char *host_s, | |
432 | const char *port_s OVS_UNUSED, | |
433 | uint16_t default_port OVS_UNUSED, | |
434 | const char *s OVS_UNUSED) | |
435 | { | |
436 | char *tmp_host_s; | |
437 | ||
438 | dns_resolve(host_s, &tmp_host_s); | |
439 | if (tmp_host_s != NULL) { | |
440 | parse_sockaddr_components(ss, tmp_host_s, port_s, | |
441 | default_port, s, false); | |
442 | free(tmp_host_s); | |
443 | return true; | |
444 | } | |
445 | return false; | |
446 | } | |
447 | ||
e731d71b AS |
448 | static bool |
449 | parse_sockaddr_components(struct sockaddr_storage *ss, | |
5d77b36b | 450 | char *host_s, |
e731d71b | 451 | const char *port_s, uint16_t default_port, |
771680d9 YS |
452 | const char *s, |
453 | bool resolve_host) | |
e731d71b | 454 | { |
93b7faf1 | 455 | struct sockaddr_in *sin = sin_cast(sa_cast(ss)); |
e731d71b AS |
456 | int port; |
457 | ||
458 | if (port_s && port_s[0]) { | |
459 | if (!str_to_int(port_s, 10, &port) || port < 0 || port > 65535) { | |
460 | VLOG_ERR("%s: bad port number \"%s\"", s, port_s); | |
12c5f227 | 461 | goto exit; |
e731d71b AS |
462 | } |
463 | } else { | |
464 | port = default_port; | |
78ff0270 | 465 | } |
e731d71b AS |
466 | |
467 | memset(ss, 0, sizeof *ss); | |
5d77b36b | 468 | if (host_s && strchr(host_s, ':')) { |
93b7faf1 | 469 | struct sockaddr_in6 *sin6 = sin6_cast(sa_cast(ss)); |
5d77b36b BP |
470 | char *addr = strsep(&host_s, "%"); |
471 | ||
e731d71b AS |
472 | sin6->sin6_family = AF_INET6; |
473 | sin6->sin6_port = htons(port); | |
5d77b36b | 474 | if (!addr || !*addr || !ipv6_parse(addr, &sin6->sin6_addr)) { |
e731d71b AS |
475 | goto exit; |
476 | } | |
5d77b36b BP |
477 | |
478 | #ifdef HAVE_STRUCT_SOCKADDR_IN6_SIN6_SCOPE_ID | |
479 | char *scope = strsep(&host_s, "%"); | |
480 | if (scope && *scope) { | |
481 | if (!scope[strspn(scope, "0123456789")]) { | |
482 | sin6->sin6_scope_id = atoi(scope); | |
483 | } else { | |
484 | sin6->sin6_scope_id = if_nametoindex(scope); | |
485 | if (!sin6->sin6_scope_id) { | |
486 | VLOG_ERR("%s: bad IPv6 scope \"%s\" (%s)", | |
487 | s, scope, ovs_strerror(errno)); | |
488 | goto exit; | |
489 | } | |
490 | } | |
491 | } | |
492 | #endif | |
e731d71b AS |
493 | } else { |
494 | sin->sin_family = AF_INET; | |
495 | sin->sin_port = htons(port); | |
5d77b36b | 496 | if (host_s && !ip_parse(host_s, &sin->sin_addr.s_addr)) { |
771680d9 | 497 | goto resolve; |
e731d71b | 498 | } |
52f8a75e BP |
499 | } |
500 | ||
e731d71b | 501 | return true; |
52f8a75e | 502 | |
771680d9 YS |
503 | resolve: |
504 | if (resolve_host && parse_sockaddr_components_dns(ss, host_s, port_s, | |
505 | default_port, s)) { | |
506 | return true; | |
507 | } else if (!resolve_host) { | |
508 | VLOG_ERR("%s: bad IP address \"%s\"", s, host_s); | |
509 | } | |
52f8a75e | 510 | exit: |
e731d71b AS |
511 | memset(ss, 0, sizeof *ss); |
512 | return false; | |
513 | } | |
514 | ||
515 | /* Parses 'target', which should be a string in the format "<host>[:<port>]". | |
516 | * <host>, which is required, may be an IPv4 address or an IPv6 address | |
1bb01121 | 517 | * enclosed in square brackets. If 'default_port' is nonnegative then <port> |
28533680 DB |
518 | * is optional and defaults to 'default_port' (use 0 to make the kernel choose |
519 | * an available port, although this isn't usually appropriate for active | |
520 | * connections). If 'default_port' is negative, then <port> is required. | |
e731d71b AS |
521 | * |
522 | * On success, returns true and stores the parsed remote address into '*ss'. | |
523 | * On failure, logs an error, stores zeros into '*ss', and returns false. */ | |
524 | bool | |
1bb01121 | 525 | inet_parse_active(const char *target_, int default_port, |
e731d71b AS |
526 | struct sockaddr_storage *ss) |
527 | { | |
528 | char *target = xstrdup(target_); | |
0b043300 | 529 | char *port, *host; |
e731d71b AS |
530 | bool ok; |
531 | ||
0b043300 | 532 | inet_parse_host_port_tokens(target, &host, &port); |
e731d71b AS |
533 | if (!host) { |
534 | VLOG_ERR("%s: host must be specified", target_); | |
535 | ok = false; | |
1bb01121 | 536 | } else if (!port && default_port < 0) { |
e731d71b AS |
537 | VLOG_ERR("%s: port must be specified", target_); |
538 | ok = false; | |
539 | } else { | |
771680d9 YS |
540 | ok = parse_sockaddr_components(ss, host, port, default_port, |
541 | target_, true); | |
e731d71b | 542 | } |
52f8a75e | 543 | if (!ok) { |
e731d71b | 544 | memset(ss, 0, sizeof *ss); |
52f8a75e BP |
545 | } |
546 | free(target); | |
547 | return ok; | |
548 | } | |
549 | ||
e731d71b AS |
550 | |
551 | /* Opens a non-blocking IPv4 or IPv6 socket of the specified 'style' and | |
552 | * connects to 'target', which should be a string in the format | |
553 | * "<host>[:<port>]". <host>, which is required, may be an IPv4 address or an | |
1bb01121 BP |
554 | * IPv6 address enclosed in square brackets. If 'default_port' is nonnegative |
555 | * then <port> is optional and defaults to 'default_port'. | |
52f8a75e BP |
556 | * |
557 | * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP). | |
558 | * | |
559 | * On success, returns 0 (indicating connection complete) or EAGAIN (indicating | |
560 | * connection in progress), in which case the new file descriptor is stored | |
561 | * into '*fdp'. On failure, returns a positive errno value other than EAGAIN | |
562 | * and stores -1 into '*fdp'. | |
563 | * | |
e731d71b | 564 | * If 'ss' is non-null, then on success stores the target address into '*ss'. |
f125905c | 565 | * |
cea15768 EJ |
566 | * 'dscp' becomes the DSCP bits in the IP headers for the new connection. It |
567 | * should be in the range [0, 63] and will automatically be shifted to the | |
568 | * appropriately place in the IP tos field. */ | |
52f8a75e | 569 | int |
1bb01121 | 570 | inet_open_active(int style, const char *target, int default_port, |
e731d71b | 571 | struct sockaddr_storage *ssp, int *fdp, uint8_t dscp) |
52f8a75e | 572 | { |
e731d71b | 573 | struct sockaddr_storage ss; |
52f8a75e BP |
574 | int fd = -1; |
575 | int error; | |
576 | ||
577 | /* Parse. */ | |
e731d71b | 578 | if (!inet_parse_active(target, default_port, &ss)) { |
1901968e BP |
579 | error = EAFNOSUPPORT; |
580 | goto exit; | |
78ff0270 BP |
581 | } |
582 | ||
583 | /* Create non-blocking socket. */ | |
e731d71b | 584 | fd = socket(ss.ss_family, style, 0); |
78ff0270 | 585 | if (fd < 0) { |
0f0b5401 GS |
586 | error = sock_errno(); |
587 | VLOG_ERR("%s: socket: %s", target, sock_strerror(error)); | |
78ff0270 BP |
588 | goto exit; |
589 | } | |
590 | error = set_nonblocking(fd); | |
591 | if (error) { | |
a4efa3fc | 592 | goto exit; |
78ff0270 BP |
593 | } |
594 | ||
e731d71b AS |
595 | /* The dscp bits must be configured before connect() to ensure that the |
596 | * TOS field is set during the connection establishment. If set after | |
cea15768 | 597 | * connect(), the handshake SYN frames will be sent with a TOS of 0. */ |
afc1d536 | 598 | error = set_dscp(fd, ss.ss_family, dscp); |
cea15768 | 599 | if (error) { |
909dad2b | 600 | VLOG_ERR("%s: set_dscp: %s", target, sock_strerror(error)); |
ef8a3d14 | 601 | goto exit; |
f125905c MM |
602 | } |
603 | ||
78ff0270 | 604 | /* Connect. */ |
e731d71b AS |
605 | error = connect(fd, (struct sockaddr *) &ss, ss_length(&ss)) == 0 |
606 | ? 0 | |
0f0b5401 GS |
607 | : sock_errno(); |
608 | if (error == EINPROGRESS | |
609 | #ifdef _WIN32 | |
610 | || error == WSAEALREADY || error == WSAEWOULDBLOCK | |
611 | #endif | |
612 | ) { | |
78ff0270 | 613 | error = EAGAIN; |
78ff0270 BP |
614 | } |
615 | ||
78ff0270 | 616 | exit: |
e731d71b AS |
617 | if (error && error != EAGAIN) { |
618 | if (ssp) { | |
619 | memset(ssp, 0, sizeof *ssp); | |
620 | } | |
621 | if (fd >= 0) { | |
7009a594 | 622 | closesocket(fd); |
e731d71b AS |
623 | fd = -1; |
624 | } | |
625 | } else { | |
626 | if (ssp) { | |
627 | *ssp = ss; | |
78ff0270 | 628 | } |
78ff0270 | 629 | } |
a4efa3fc | 630 | *fdp = fd; |
78ff0270 BP |
631 | return error; |
632 | } | |
633 | ||
e731d71b | 634 | /* Parses 'target', which should be a string in the format "[<port>][:<host>]": |
e1bd3bee BP |
635 | * |
636 | * - If 'default_port' is -1, then <port> is required. Otherwise, if | |
637 | * <port> is omitted, then 'default_port' is used instead. | |
638 | * | |
639 | * - If <port> (or 'default_port', if used) is 0, then no port is bound | |
640 | * and the TCP/IP stack will select a port. | |
641 | * | |
e731d71b AS |
642 | * - <host> is optional. If supplied, it may be an IPv4 address or an |
643 | * IPv6 address enclosed in square brackets. If omitted, the IP address | |
644 | * is wildcarded. | |
4f2eb9a7 | 645 | * |
e731d71b AS |
646 | * If successful, stores the address into '*ss' and returns true; otherwise |
647 | * zeros '*ss' and returns false. */ | |
d98fa503 | 648 | bool |
995337c4 | 649 | inet_parse_passive(const char *target_, int default_port, |
e731d71b | 650 | struct sockaddr_storage *ss) |
78ff0270 BP |
651 | { |
652 | char *target = xstrdup(target_); | |
0b043300 | 653 | char *port, *host; |
e731d71b AS |
654 | bool ok; |
655 | ||
0b043300 | 656 | inet_parse_port_host_tokens(target, &port, &host); |
e731d71b AS |
657 | if (!port && default_port < 0) { |
658 | VLOG_ERR("%s: port must be specified", target_); | |
659 | ok = false; | |
660 | } else { | |
771680d9 YS |
661 | ok = parse_sockaddr_components(ss, host, port, default_port, |
662 | target_, true); | |
d98fa503 | 663 | } |
d98fa503 | 664 | if (!ok) { |
e731d71b | 665 | memset(ss, 0, sizeof *ss); |
d98fa503 BP |
666 | } |
667 | free(target); | |
668 | return ok; | |
669 | } | |
670 | ||
671 | ||
e731d71b | 672 | /* Opens a non-blocking IPv4 or IPv6 socket of the specified 'style', binds to |
d98fa503 BP |
673 | * 'target', and listens for incoming connections. Parses 'target' in the same |
674 | * way was inet_parse_passive(). | |
675 | * | |
676 | * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP). | |
677 | * | |
678 | * For TCP, the socket will have SO_REUSEADDR turned on. | |
679 | * | |
680 | * On success, returns a non-negative file descriptor. On failure, returns a | |
681 | * negative errno value. | |
682 | * | |
e731d71b | 683 | * If 'ss' is non-null, then on success stores the bound address into '*ss'. |
f125905c | 684 | * |
cea15768 EJ |
685 | * 'dscp' becomes the DSCP bits in the IP headers for the new connection. It |
686 | * should be in the range [0, 63] and will automatically be shifted to the | |
b52ecd96 GS |
687 | * appropriately place in the IP tos field. |
688 | * | |
689 | * If 'kernel_print_port' is true and the port is dynamically assigned by | |
690 | * the kernel, print the chosen port. */ | |
d98fa503 BP |
691 | int |
692 | inet_open_passive(int style, const char *target, int default_port, | |
b52ecd96 GS |
693 | struct sockaddr_storage *ssp, uint8_t dscp, |
694 | bool kernel_print_port) | |
d98fa503 | 695 | { |
df451457 | 696 | bool kernel_chooses_port; |
e731d71b | 697 | struct sockaddr_storage ss; |
d98fa503 BP |
698 | int fd = 0, error; |
699 | unsigned int yes = 1; | |
700 | ||
e731d71b | 701 | if (!inet_parse_passive(target, default_port, &ss)) { |
ca286ba9 | 702 | return -EAFNOSUPPORT; |
78ff0270 | 703 | } |
e731d71b | 704 | kernel_chooses_port = ss_get_port(&ss) == 0; |
78ff0270 BP |
705 | |
706 | /* Create non-blocking socket, set SO_REUSEADDR. */ | |
e731d71b | 707 | fd = socket(ss.ss_family, style, 0); |
78ff0270 | 708 | if (fd < 0) { |
0f0b5401 GS |
709 | error = sock_errno(); |
710 | VLOG_ERR("%s: socket: %s", target, sock_strerror(error)); | |
ca286ba9 | 711 | return -error; |
78ff0270 BP |
712 | } |
713 | error = set_nonblocking(fd); | |
714 | if (error) { | |
d98fa503 | 715 | goto error; |
78ff0270 | 716 | } |
4f2eb9a7 BP |
717 | if (style == SOCK_STREAM |
718 | && setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof yes) < 0) { | |
0f0b5401 | 719 | error = sock_errno(); |
10a89ef0 | 720 | VLOG_ERR("%s: setsockopt(SO_REUSEADDR): %s", |
0f0b5401 | 721 | target, sock_strerror(error)); |
d98fa503 | 722 | goto error; |
78ff0270 BP |
723 | } |
724 | ||
725 | /* Bind. */ | |
e731d71b | 726 | if (bind(fd, (struct sockaddr *) &ss, ss_length(&ss)) < 0) { |
0f0b5401 GS |
727 | error = sock_errno(); |
728 | VLOG_ERR("%s: bind: %s", target, sock_strerror(error)); | |
d98fa503 | 729 | goto error; |
78ff0270 BP |
730 | } |
731 | ||
cea15768 EJ |
732 | /* The dscp bits must be configured before connect() to ensure that the TOS |
733 | * field is set during the connection establishment. If set after | |
734 | * connect(), the handshake SYN frames will be sent with a TOS of 0. */ | |
afc1d536 | 735 | error = set_dscp(fd, ss.ss_family, dscp); |
cea15768 | 736 | if (error) { |
909dad2b | 737 | VLOG_ERR("%s: set_dscp: %s", target, sock_strerror(error)); |
ef8a3d14 | 738 | goto error; |
f125905c MM |
739 | } |
740 | ||
78ff0270 | 741 | /* Listen. */ |
041dc07f | 742 | if (style == SOCK_STREAM && listen(fd, 10) < 0) { |
0f0b5401 GS |
743 | error = sock_errno(); |
744 | VLOG_ERR("%s: listen: %s", target, sock_strerror(error)); | |
d98fa503 | 745 | goto error; |
78ff0270 | 746 | } |
36775dad | 747 | |
e731d71b AS |
748 | if (ssp || kernel_chooses_port) { |
749 | socklen_t ss_len = sizeof ss; | |
750 | if (getsockname(fd, (struct sockaddr *) &ss, &ss_len) < 0) { | |
0f0b5401 GS |
751 | error = sock_errno(); |
752 | VLOG_ERR("%s: getsockname: %s", target, sock_strerror(error)); | |
d98fa503 | 753 | goto error; |
36775dad | 754 | } |
b52ecd96 | 755 | if (kernel_chooses_port && kernel_print_port) { |
df451457 | 756 | VLOG_INFO("%s: listening on port %"PRIu16, |
e731d71b AS |
757 | target, ss_get_port(&ss)); |
758 | } | |
759 | if (ssp) { | |
760 | *ssp = ss; | |
df451457 | 761 | } |
36775dad BP |
762 | } |
763 | ||
d98fa503 | 764 | return fd; |
78ff0270 | 765 | |
d98fa503 | 766 | error: |
e731d71b AS |
767 | if (ssp) { |
768 | memset(ssp, 0, sizeof *ssp); | |
769 | } | |
7009a594 | 770 | closesocket(fd); |
ca286ba9 | 771 | return -error; |
78ff0270 BP |
772 | } |
773 | ||
3a974b92 BP |
774 | /* Parses 'target', which may be an IPv4 address or an IPv6 address |
775 | * enclosed in square brackets. | |
776 | * | |
777 | * On success, returns true and stores the parsed remote address into '*ss'. | |
778 | * On failure, logs an error, stores zeros into '*ss', and returns false. */ | |
779 | bool | |
780 | inet_parse_address(const char *target_, struct sockaddr_storage *ss) | |
781 | { | |
782 | char *target = xstrdup(target_); | |
0b043300 | 783 | char *host = unbracket(target); |
771680d9 | 784 | bool ok = parse_sockaddr_components(ss, host, NULL, 0, target_, false); |
3a974b92 BP |
785 | if (!ok) { |
786 | memset(ss, 0, sizeof *ss); | |
787 | } | |
788 | free(target); | |
789 | return ok; | |
790 | } | |
791 | ||
064af421 BP |
792 | int |
793 | read_fully(int fd, void *p_, size_t size, size_t *bytes_read) | |
794 | { | |
795 | uint8_t *p = p_; | |
796 | ||
797 | *bytes_read = 0; | |
798 | while (size > 0) { | |
799 | ssize_t retval = read(fd, p, size); | |
800 | if (retval > 0) { | |
801 | *bytes_read += retval; | |
802 | size -= retval; | |
803 | p += retval; | |
804 | } else if (retval == 0) { | |
805 | return EOF; | |
806 | } else if (errno != EINTR) { | |
807 | return errno; | |
808 | } | |
809 | } | |
810 | return 0; | |
811 | } | |
812 | ||
813 | int | |
814 | write_fully(int fd, const void *p_, size_t size, size_t *bytes_written) | |
815 | { | |
816 | const uint8_t *p = p_; | |
817 | ||
818 | *bytes_written = 0; | |
819 | while (size > 0) { | |
820 | ssize_t retval = write(fd, p, size); | |
821 | if (retval > 0) { | |
822 | *bytes_written += retval; | |
823 | size -= retval; | |
824 | p += retval; | |
825 | } else if (retval == 0) { | |
826 | VLOG_WARN("write returned 0"); | |
827 | return EPROTO; | |
828 | } else if (errno != EINTR) { | |
829 | return errno; | |
830 | } | |
831 | } | |
832 | return 0; | |
833 | } | |
8e71cf88 BP |
834 | |
835 | /* Given file name 'file_name', fsyncs the directory in which it is contained. | |
836 | * Returns 0 if successful, otherwise a positive errno value. */ | |
837 | int | |
838 | fsync_parent_dir(const char *file_name) | |
839 | { | |
840 | int error = 0; | |
cbf414e5 | 841 | #ifndef _WIN32 |
8e71cf88 BP |
842 | char *dir; |
843 | int fd; | |
844 | ||
845 | dir = dir_name(file_name); | |
846 | fd = open(dir, O_RDONLY); | |
847 | if (fd >= 0) { | |
848 | if (fsync(fd)) { | |
849 | if (errno == EINVAL || errno == EROFS) { | |
850 | /* This directory does not support synchronization. Not | |
851 | * really an error. */ | |
852 | } else { | |
853 | error = errno; | |
10a89ef0 | 854 | VLOG_ERR("%s: fsync failed (%s)", dir, ovs_strerror(error)); |
8e71cf88 BP |
855 | } |
856 | } | |
857 | close(fd); | |
858 | } else { | |
859 | error = errno; | |
10a89ef0 | 860 | VLOG_ERR("%s: open failed (%s)", dir, ovs_strerror(error)); |
8e71cf88 BP |
861 | } |
862 | free(dir); | |
cbf414e5 | 863 | #endif |
8e71cf88 BP |
864 | |
865 | return error; | |
866 | } | |
26efd256 BP |
867 | |
868 | /* Obtains the modification time of the file named 'file_name' to the greatest | |
869 | * supported precision. If successful, stores the mtime in '*mtime' and | |
870 | * returns 0. On error, returns a positive errno value and stores zeros in | |
871 | * '*mtime'. */ | |
872 | int | |
873 | get_mtime(const char *file_name, struct timespec *mtime) | |
874 | { | |
875 | struct stat s; | |
876 | ||
877 | if (!stat(file_name, &s)) { | |
878 | mtime->tv_sec = s.st_mtime; | |
879 | ||
880 | #if HAVE_STRUCT_STAT_ST_MTIM_TV_NSEC | |
881 | mtime->tv_nsec = s.st_mtim.tv_nsec; | |
882 | #elif HAVE_STRUCT_STAT_ST_MTIMENSEC | |
883 | mtime->tv_nsec = s.st_mtimensec; | |
884 | #else | |
885 | mtime->tv_nsec = 0; | |
886 | #endif | |
887 | ||
888 | return 0; | |
889 | } else { | |
890 | mtime->tv_sec = mtime->tv_nsec = 0; | |
891 | return errno; | |
892 | } | |
893 | } | |
894 | ||
f89ffb0e | 895 | static int |
c1c19657 | 896 | getsockopt_int(int fd, int level, int option, const char *optname, int *valuep) |
f89ffb0e | 897 | { |
c1c19657 BP |
898 | static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10); |
899 | socklen_t len; | |
900 | int value; | |
901 | int error; | |
f89ffb0e | 902 | |
c1c19657 BP |
903 | len = sizeof value; |
904 | if (getsockopt(fd, level, option, &value, &len)) { | |
0f0b5401 GS |
905 | error = sock_errno(); |
906 | VLOG_ERR_RL(&rl, "getsockopt(%s): %s", optname, sock_strerror(error)); | |
c1c19657 BP |
907 | } else if (len != sizeof value) { |
908 | error = EINVAL; | |
34582733 | 909 | VLOG_ERR_RL(&rl, "getsockopt(%s): value is %u bytes (expected %"PRIuSIZE")", |
c1c19657 BP |
910 | optname, (unsigned int) len, sizeof value); |
911 | } else { | |
912 | error = 0; | |
913 | } | |
914 | ||
915 | *valuep = error ? 0 : value; | |
916 | return error; | |
f89ffb0e BP |
917 | } |
918 | ||
919 | static void | |
920 | describe_sockaddr(struct ds *string, int fd, | |
921 | int (*getaddr)(int, struct sockaddr *, socklen_t *)) | |
922 | { | |
923 | struct sockaddr_storage ss; | |
924 | socklen_t len = sizeof ss; | |
925 | ||
926 | if (!getaddr(fd, (struct sockaddr *) &ss, &len)) { | |
e731d71b | 927 | if (ss.ss_family == AF_INET || ss.ss_family == AF_INET6) { |
fd245f1d BP |
928 | ss_format_address(&ss, string); |
929 | ds_put_format(string, ":%"PRIu16, ss_get_port(&ss)); | |
7ff04d92 | 930 | #ifndef _WIN32 |
f89ffb0e BP |
931 | } else if (ss.ss_family == AF_UNIX) { |
932 | struct sockaddr_un sun; | |
933 | const char *null; | |
934 | size_t maxlen; | |
935 | ||
936 | memcpy(&sun, &ss, sizeof sun); | |
937 | maxlen = len - offsetof(struct sockaddr_un, sun_path); | |
938 | null = memchr(sun.sun_path, '\0', maxlen); | |
939 | ds_put_buffer(string, sun.sun_path, | |
940 | null ? null - sun.sun_path : maxlen); | |
7ff04d92 | 941 | #endif |
f89ffb0e BP |
942 | } |
943 | #ifdef HAVE_NETLINK | |
944 | else if (ss.ss_family == AF_NETLINK) { | |
945 | int protocol; | |
946 | ||
947 | /* SO_PROTOCOL was introduced in 2.6.32. Support it regardless of the version | |
948 | * of the Linux kernel headers in use at build time. */ | |
949 | #ifndef SO_PROTOCOL | |
950 | #define SO_PROTOCOL 38 | |
951 | #endif | |
952 | ||
c1c19657 BP |
953 | if (!getsockopt_int(fd, SOL_SOCKET, SO_PROTOCOL, "SO_PROTOCOL", |
954 | &protocol)) { | |
f89ffb0e BP |
955 | switch (protocol) { |
956 | case NETLINK_ROUTE: | |
957 | ds_put_cstr(string, "NETLINK_ROUTE"); | |
958 | break; | |
959 | ||
960 | case NETLINK_GENERIC: | |
961 | ds_put_cstr(string, "NETLINK_GENERIC"); | |
962 | break; | |
963 | ||
964 | default: | |
965 | ds_put_format(string, "AF_NETLINK family %d", protocol); | |
966 | break; | |
967 | } | |
968 | } else { | |
969 | ds_put_cstr(string, "AF_NETLINK"); | |
970 | } | |
971 | } | |
972 | #endif | |
2f51a7eb | 973 | #if __linux__ |
f89ffb0e BP |
974 | else if (ss.ss_family == AF_PACKET) { |
975 | struct sockaddr_ll sll; | |
976 | ||
977 | memcpy(&sll, &ss, sizeof sll); | |
978 | ds_put_cstr(string, "AF_PACKET"); | |
979 | if (sll.sll_ifindex) { | |
980 | char name[IFNAMSIZ]; | |
981 | ||
982 | if (if_indextoname(sll.sll_ifindex, name)) { | |
983 | ds_put_format(string, "(%s)", name); | |
984 | } else { | |
985 | ds_put_format(string, "(ifindex=%d)", sll.sll_ifindex); | |
986 | } | |
987 | } | |
988 | if (sll.sll_protocol) { | |
989 | ds_put_format(string, "(protocol=0x%"PRIu16")", | |
990 | ntohs(sll.sll_protocol)); | |
991 | } | |
992 | } | |
993 | #endif | |
994 | else if (ss.ss_family == AF_UNSPEC) { | |
995 | ds_put_cstr(string, "AF_UNSPEC"); | |
996 | } else { | |
997 | ds_put_format(string, "AF_%d", (int) ss.ss_family); | |
998 | } | |
999 | } | |
1000 | } | |
1001 | ||
1002 | ||
2f51a7eb | 1003 | #ifdef __linux__ |
f89ffb0e BP |
1004 | static void |
1005 | put_fd_filename(struct ds *string, int fd) | |
1006 | { | |
1007 | char buf[1024]; | |
1008 | char *linkname; | |
1009 | int n; | |
1010 | ||
1011 | linkname = xasprintf("/proc/self/fd/%d", fd); | |
1012 | n = readlink(linkname, buf, sizeof buf); | |
1013 | if (n > 0) { | |
1014 | ds_put_char(string, ' '); | |
1015 | ds_put_buffer(string, buf, n); | |
1016 | if (n > sizeof buf) { | |
1017 | ds_put_cstr(string, "..."); | |
1018 | } | |
1019 | } | |
1020 | free(linkname); | |
1021 | } | |
1022 | #endif | |
1023 | ||
1024 | /* Returns a malloc()'d string describing 'fd', for use in logging. */ | |
1025 | char * | |
1026 | describe_fd(int fd) | |
1027 | { | |
1028 | struct ds string; | |
1029 | struct stat s; | |
1030 | ||
1031 | ds_init(&string); | |
54a1cfb5 | 1032 | #ifndef _WIN32 |
f89ffb0e | 1033 | if (fstat(fd, &s)) { |
10a89ef0 | 1034 | ds_put_format(&string, "fstat failed (%s)", ovs_strerror(errno)); |
f89ffb0e BP |
1035 | } else if (S_ISSOCK(s.st_mode)) { |
1036 | describe_sockaddr(&string, fd, getsockname); | |
1037 | ds_put_cstr(&string, "<->"); | |
1038 | describe_sockaddr(&string, fd, getpeername); | |
1039 | } else { | |
1040 | ds_put_cstr(&string, (isatty(fd) ? "tty" | |
1041 | : S_ISDIR(s.st_mode) ? "directory" | |
1042 | : S_ISCHR(s.st_mode) ? "character device" | |
1043 | : S_ISBLK(s.st_mode) ? "block device" | |
1044 | : S_ISREG(s.st_mode) ? "file" | |
1045 | : S_ISFIFO(s.st_mode) ? "FIFO" | |
1046 | : S_ISLNK(s.st_mode) ? "symbolic link" | |
1047 | : "unknown")); | |
2f51a7eb | 1048 | #ifdef __linux__ |
f89ffb0e BP |
1049 | put_fd_filename(&string, fd); |
1050 | #endif | |
1051 | } | |
54a1cfb5 GS |
1052 | #else |
1053 | ds_put_format(&string,"file descriptor"); | |
1054 | #endif /* _WIN32 */ | |
f89ffb0e BP |
1055 | return ds_steal_cstr(&string); |
1056 | } | |
e731d71b | 1057 | \f |
93b7faf1 BP |
1058 | /* sockaddr helpers. */ |
1059 | ||
1060 | static struct sockaddr_in * | |
1061 | sin_cast(const struct sockaddr *sa) | |
1062 | { | |
1063 | return ALIGNED_CAST(struct sockaddr_in *, sa); | |
1064 | } | |
1065 | ||
1066 | static struct sockaddr_in6 * | |
1067 | sin6_cast(const struct sockaddr *sa) | |
1068 | { | |
1069 | return ALIGNED_CAST(struct sockaddr_in6 *, sa); | |
1070 | } | |
1071 | ||
1072 | /* Returns true if 'sa' represents an IPv4 or IPv6 address, false otherwise. */ | |
1073 | bool | |
1074 | sa_is_ip(const struct sockaddr *sa) | |
1075 | { | |
1076 | return sa->sa_family == AF_INET || sa->sa_family == AF_INET6; | |
1077 | } | |
1078 | ||
1079 | /* Returns the IPv4 or IPv6 address in 'sa'. Returns IPv4 addresses as | |
1080 | * v6-mapped. */ | |
1081 | struct in6_addr | |
1082 | sa_get_address(const struct sockaddr *sa) | |
1083 | { | |
1084 | ovs_assert(sa_is_ip(sa)); | |
1085 | return (sa->sa_family == AF_INET | |
1086 | ? in6_addr_mapped_ipv4(sin_cast(sa)->sin_addr.s_addr) | |
1087 | : sin6_cast(sa)->sin6_addr); | |
1088 | } | |
259e0b1a | 1089 | |
93b7faf1 | 1090 | /* Returns the IPv4 or IPv6 port in 'sa'. */ |
e731d71b | 1091 | uint16_t |
93b7faf1 | 1092 | sa_get_port(const struct sockaddr *sa) |
e731d71b | 1093 | { |
93b7faf1 BP |
1094 | ovs_assert(sa_is_ip(sa)); |
1095 | return ntohs(sa->sa_family == AF_INET | |
1096 | ? sin_cast(sa)->sin_port | |
1097 | : sin6_cast(sa)->sin6_port); | |
e731d71b AS |
1098 | } |
1099 | ||
5d77b36b BP |
1100 | /* Returns true if 'name' is safe to include inside a network address field. |
1101 | * We want to avoid names that include confusing punctuation, etc. */ | |
1102 | static bool OVS_UNUSED | |
1103 | is_safe_name(const char *name) | |
1104 | { | |
1105 | if (!name[0] || isdigit((unsigned char) name[0])) { | |
1106 | return false; | |
1107 | } | |
1108 | for (const char *p = name; *p; p++) { | |
1109 | if (!isalnum((unsigned char) *p) && *p != '-' && *p != '_') { | |
1110 | return false; | |
1111 | } | |
1112 | } | |
1113 | return true; | |
1114 | } | |
fd245f1d | 1115 | |
51b8505b | 1116 | static void |
93b7faf1 | 1117 | sa_format_address__(const struct sockaddr *sa, |
51b8505b BP |
1118 | const char *lbrack, const char *rbrack, |
1119 | struct ds *s) | |
e731d71b | 1120 | { |
93b7faf1 BP |
1121 | ovs_assert(sa_is_ip(sa)); |
1122 | if (sa->sa_family == AF_INET) { | |
1123 | ds_put_format(s, IP_FMT, IP_ARGS(sin_cast(sa)->sin_addr.s_addr)); | |
1124 | } else { | |
1125 | const struct sockaddr_in6 *sin6 = sin6_cast(sa); | |
e731d71b | 1126 | |
51b8505b | 1127 | ds_put_cstr(s, lbrack); |
fd245f1d BP |
1128 | ds_reserve(s, s->length + INET6_ADDRSTRLEN); |
1129 | char *tail = &s->string[s->length]; | |
1130 | inet_ntop(AF_INET6, sin6->sin6_addr.s6_addr, tail, INET6_ADDRSTRLEN); | |
1131 | s->length += strlen(tail); | |
1132 | ||
5d77b36b BP |
1133 | #ifdef HAVE_STRUCT_SOCKADDR_IN6_SIN6_SCOPE_ID |
1134 | uint32_t scope = sin6->sin6_scope_id; | |
1135 | if (scope) { | |
1136 | char namebuf[IF_NAMESIZE]; | |
1137 | char *name = if_indextoname(scope, namebuf); | |
1138 | ds_put_char(s, '%'); | |
1139 | if (name && is_safe_name(name)) { | |
1140 | ds_put_cstr(s, name); | |
1141 | } else { | |
1142 | ds_put_format(s, "%"PRIu32, scope); | |
1143 | } | |
1144 | } | |
1145 | #endif | |
1146 | ||
51b8505b | 1147 | ds_put_cstr(s, rbrack); |
e731d71b | 1148 | } |
e731d71b AS |
1149 | } |
1150 | ||
93b7faf1 | 1151 | /* Formats the IPv4 or IPv6 address in 'sa' into 's'. If 'sa' is an IPv6 |
51b8505b BP |
1152 | * address, puts square brackets around the address. */ |
1153 | void | |
93b7faf1 | 1154 | sa_format_address(const struct sockaddr *sa, struct ds *s) |
51b8505b | 1155 | { |
93b7faf1 | 1156 | sa_format_address__(sa, "[", "]", s); |
51b8505b BP |
1157 | } |
1158 | ||
93b7faf1 | 1159 | /* Formats the IPv4 or IPv6 address in 'sa' into 's'. Does not add square |
51b8505b BP |
1160 | * brackets around IPv6 addresses. */ |
1161 | void | |
93b7faf1 | 1162 | sa_format_address_nobracks(const struct sockaddr *sa, struct ds *s) |
51b8505b | 1163 | { |
93b7faf1 | 1164 | sa_format_address__(sa, "", "", s); |
51b8505b BP |
1165 | } |
1166 | ||
e731d71b | 1167 | size_t |
93b7faf1 | 1168 | sa_length(const struct sockaddr *sa) |
e731d71b | 1169 | { |
93b7faf1 | 1170 | switch (sa->sa_family) { |
e731d71b AS |
1171 | case AF_INET: |
1172 | return sizeof(struct sockaddr_in); | |
1173 | ||
1174 | case AF_INET6: | |
1175 | return sizeof(struct sockaddr_in6); | |
1176 | ||
1177 | default: | |
1178 | OVS_NOT_REACHED(); | |
1179 | } | |
1180 | } | |
93b7faf1 BP |
1181 | \f |
1182 | /* sockaddr_storage helpers. */ | |
b26f46a4 | 1183 | |
93b7faf1 BP |
1184 | static const struct sockaddr * |
1185 | sa_cast(const struct sockaddr_storage *ss) | |
1186 | { | |
1187 | return ALIGNED_CAST(const struct sockaddr *, ss); | |
1188 | } | |
1189 | ||
1190 | bool | |
1191 | ss_is_ip(const struct sockaddr_storage *ss) | |
1192 | { | |
1193 | return sa_is_ip(sa_cast(ss)); | |
1194 | } | |
1195 | ||
1196 | uint16_t | |
1197 | ss_get_port(const struct sockaddr_storage *ss) | |
1198 | { | |
1199 | return sa_get_port(sa_cast(ss)); | |
1200 | } | |
1201 | ||
1202 | struct in6_addr | |
1203 | ss_get_address(const struct sockaddr_storage *ss) | |
1204 | { | |
1205 | return sa_get_address(sa_cast(ss)); | |
1206 | } | |
1207 | ||
1208 | void | |
1209 | ss_format_address(const struct sockaddr_storage *ss, struct ds *s) | |
1210 | { | |
1211 | sa_format_address(sa_cast(ss), s); | |
1212 | } | |
1213 | ||
1214 | void | |
1215 | ss_format_address_nobracks(const struct sockaddr_storage *ss, struct ds *s) | |
1216 | { | |
1217 | sa_format_address_nobracks(sa_cast(ss), s); | |
1218 | } | |
1219 | ||
1220 | size_t | |
1221 | ss_length(const struct sockaddr_storage *ss) | |
1222 | { | |
1223 | return sa_length(sa_cast(ss)); | |
1224 | } | |
1225 | \f | |
b26f46a4 GS |
1226 | /* For Windows socket calls, 'errno' is not set. One has to call |
1227 | * WSAGetLastError() to get the error number and then pass it to | |
315ea327 GS |
1228 | * this function to get the correct error string. |
1229 | * | |
b26f46a4 GS |
1230 | * ovs_strerror() calls strerror_r() and would not get the correct error |
1231 | * string for Windows sockets, but is good for POSIX. */ | |
1232 | const char * | |
1233 | sock_strerror(int error) | |
1234 | { | |
1235 | #ifdef _WIN32 | |
315ea327 | 1236 | return ovs_format_message(error); |
b26f46a4 GS |
1237 | #else |
1238 | return ovs_strerror(error); | |
1239 | #endif | |
1240 | } | |
8a8c1b93 | 1241 | \f |
7f918dca | 1242 | #ifndef _WIN32 //Avoid using sendmsg on Windows entirely |
8a8c1b93 BP |
1243 | static int |
1244 | emulate_sendmmsg(int fd, struct mmsghdr *msgs, unsigned int n, | |
1245 | unsigned int flags) | |
1246 | { | |
1247 | for (unsigned int i = 0; i < n; i++) { | |
1248 | ssize_t retval = sendmsg(fd, &msgs[i].msg_hdr, flags); | |
1249 | if (retval < 0) { | |
1250 | return i ? i : retval; | |
1251 | } | |
1252 | msgs[i].msg_len = retval; | |
1253 | } | |
1254 | return n; | |
1255 | } | |
1256 | ||
1257 | #ifndef HAVE_SENDMMSG | |
1258 | int | |
1259 | sendmmsg(int fd, struct mmsghdr *msgs, unsigned int n, unsigned int flags) | |
1260 | { | |
1261 | return emulate_sendmmsg(fd, msgs, n, flags); | |
1262 | } | |
1263 | #else | |
00f5565c ZG |
1264 | /* sendmmsg was redefined in lib/socket-util.c, should undef sendmmsg here |
1265 | * to avoid recursion */ | |
1266 | #undef sendmmsg | |
8a8c1b93 BP |
1267 | int |
1268 | wrap_sendmmsg(int fd, struct mmsghdr *msgs, unsigned int n, unsigned int flags) | |
1269 | { | |
1270 | static bool sendmmsg_broken = false; | |
1271 | if (!sendmmsg_broken) { | |
1272 | int save_errno = errno; | |
1273 | int retval = sendmmsg(fd, msgs, n, flags); | |
1274 | if (retval >= 0 || errno != ENOSYS) { | |
1275 | return retval; | |
1276 | } | |
1277 | sendmmsg_broken = true; | |
1278 | errno = save_errno; | |
1279 | } | |
1280 | return emulate_sendmmsg(fd, msgs, n, flags); | |
1281 | } | |
1282 | #endif | |
7f918dca | 1283 | #endif |