2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #include "socket-util.h"
19 #include <arpa/inet.h>
29 #include <sys/ioctl.h>
30 #include <sys/socket.h>
35 #include "dynamic-string.h"
36 #include "fatal-signal.h"
37 #include "ovs-thread.h"
39 #include "poll-loop.h"
42 #if AF_PACKET && LINUX_DATAPATH
43 #include <linux/if_packet.h>
46 #include "netlink-protocol.h"
47 #include "netlink-socket.h"
50 VLOG_DEFINE_THIS_MODULE(socket_util);
52 /* #ifdefs make it a pain to maintain code: you have to try to build both ways.
53 * Thus, this file compiles all of the code regardless of the target, by
54 * writing "if (LINUX_DATAPATH)" instead of "#ifdef __linux__". */
55 #ifndef LINUX_DATAPATH
56 #define LINUX_DATAPATH 0
63 /* Maximum length of the sun_path member in a struct sockaddr_un, excluding
64 * space for a null terminator. */
65 #define MAX_UN_LEN (sizeof(((struct sockaddr_un *) 0)->sun_path) - 1)
67 static int getsockopt_int(int fd, int level, int option, const char *optname,
70 /* Sets 'fd' to non-blocking mode. Returns 0 if successful, otherwise a
71 * positive errno value. */
73 set_nonblocking(int fd)
76 int flags = fcntl(fd, F_GETFL, 0);
78 if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) != -1) {
81 VLOG_ERR("fcntl(F_SETFL) failed: %s", ovs_strerror(errno));
85 VLOG_ERR("fcntl(F_GETFL) failed: %s", ovs_strerror(errno));
89 unsigned long arg = 1;
90 if (ioctlsocket(fd, FIONBIO, &arg)) {
91 int error = sock_errno();
92 VLOG_ERR("set_nonblocking failed: %s", sock_strerror(error));
100 xset_nonblocking(int fd)
102 if (set_nonblocking(fd)) {
108 set_dscp(int fd, uint8_t dscp)
117 if (setsockopt(fd, IPPROTO_IP, IP_TOS, &val, sizeof val)) {
124 /* Translates 'host_name', which must be a string representation of an IP
125 * address, into a numeric IP address in '*addr'. Returns 0 if successful,
126 * otherwise a positive errno value. */
128 lookup_ip(const char *host_name, struct in_addr *addr)
130 if (!inet_pton(AF_INET, host_name, addr)) {
131 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
132 VLOG_ERR_RL(&rl, "\"%s\" is not a valid IP address", host_name);
138 /* Translates 'host_name', which must be a string representation of an IPv6
139 * address, into a numeric IPv6 address in '*addr'. Returns 0 if successful,
140 * otherwise a positive errno value. */
142 lookup_ipv6(const char *host_name, struct in6_addr *addr)
144 if (inet_pton(AF_INET6, host_name, addr) != 1) {
145 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
146 VLOG_ERR_RL(&rl, "\"%s\" is not a valid IPv6 address", host_name);
152 /* Translates 'host_name', which must be a host name or a string representation
153 * of an IP address, into a numeric IP address in '*addr'. Returns 0 if
154 * successful, otherwise a positive errno value.
156 * Most Open vSwitch code should not use this because it causes deadlocks:
157 * getaddrinfo() sends out a DNS request but that starts a new flow for which
158 * OVS must set up a flow, but it can't because it's waiting for a DNS reply.
159 * The synchronous lookup also delays other activity. (Of course we can solve
160 * this but it doesn't seem worthwhile quite yet.) */
162 lookup_hostname(const char *host_name, struct in_addr *addr)
164 struct addrinfo *result;
165 struct addrinfo hints;
167 if (inet_pton(AF_INET, host_name, addr)) {
171 memset(&hints, 0, sizeof hints);
172 hints.ai_family = AF_INET;
174 switch (getaddrinfo(host_name, NULL, &hints, &result)) {
176 *addr = ALIGNED_CAST(struct sockaddr_in *,
177 result->ai_addr)->sin_addr;
178 freeaddrinfo(result);
181 #ifdef EAI_ADDRFAMILY
202 #if defined (EAI_NODATA) && EAI_NODATA != EAI_NONAME
218 check_connection_completion(int fd)
220 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
225 pfd.events = POLLOUT;
229 retval = poll(&pfd, 1, 0);
230 } while (retval < 0 && errno == EINTR);
232 retval = WSAPoll(&pfd, 1, 0);
235 if (pfd.revents & POLLERR) {
236 ssize_t n = send(fd, "", 1, 0);
240 VLOG_ERR_RL(&rl, "poll return POLLERR but send succeeded");
245 } else if (retval < 0) {
246 VLOG_ERR_RL(&rl, "poll: %s", sock_strerror(sock_errno()));
254 /* Drain all the data currently in the receive queue of a datagram socket (and
255 * possibly additional data). There is no way to know how many packets are in
256 * the receive queue, but we do know that the total number of bytes queued does
257 * not exceed the receive buffer size, so we pull packets until none are left
258 * or we've read that many bytes. */
264 rcvbuf = get_socket_rcvbuf(fd);
270 /* In Linux, specifying MSG_TRUNC in the flags argument causes the
271 * datagram length to be returned, even if that is longer than the
272 * buffer provided. Thus, we can use a 1-byte buffer to discard the
273 * incoming datagram and still be able to account how many bytes were
274 * removed from the receive buffer.
276 * On other Unix-like OSes, MSG_TRUNC has no effect in the flags
278 char buffer[LINUX_DATAPATH ? 1 : 2048];
279 ssize_t n_bytes = recv(fd, buffer, sizeof buffer,
280 MSG_TRUNC | MSG_DONTWAIT);
281 if (n_bytes <= 0 || n_bytes >= rcvbuf) {
290 /* Returns the size of socket 'sock''s receive buffer (SO_RCVBUF), or a
291 * negative errno value if an error occurs. */
293 get_socket_rcvbuf(int sock)
298 error = getsockopt_int(sock, SOL_SOCKET, SO_RCVBUF, "SO_RCVBUF", &rcvbuf);
299 return error ? -error : rcvbuf;
302 /* Reads and discards up to 'n' datagrams from 'fd', stopping as soon as no
303 * more data can be immediately read. ('fd' should therefore be in
304 * non-blocking mode.)*/
306 drain_fd(int fd, size_t n_packets)
308 for (; n_packets > 0; n_packets--) {
309 /* 'buffer' only needs to be 1 byte long in most circumstances. This
310 * size is defensive against the possibility that we someday want to
311 * use a Linux tap device without TUN_NO_PI, in which case a buffer
312 * smaller than sizeof(struct tun_pi) will give EINVAL on read. */
314 if (read(fd, buffer, sizeof buffer) <= 0) {
321 /* Attempts to shorten 'name' by opening a file descriptor for the directory
322 * part of the name and indirecting through /proc/self/fd/<dirfd>/<basename>.
323 * On systems with Linux-like /proc, this works as long as <basename> isn't too
326 * On success, returns 0 and stores the short name in 'short_name' and a
327 * directory file descriptor to eventually be closed in '*dirfpd'. */
329 shorten_name_via_proc(const char *name, char short_name[MAX_UN_LEN + 1],
336 if (!LINUX_DATAPATH) {
340 dir = dir_name(name);
341 dirfd = open(dir, O_DIRECTORY | O_RDONLY);
343 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
346 VLOG_WARN_RL(&rl, "%s: open failed (%s)", dir, ovs_strerror(error));
353 base = base_name(name);
354 len = snprintf(short_name, MAX_UN_LEN + 1,
355 "/proc/self/fd/%d/%s", dirfd, base);
358 if (len >= 0 && len <= MAX_UN_LEN) {
367 /* Attempts to shorten 'name' by creating a symlink for the directory part of
368 * the name and indirecting through <symlink>/<basename>. This works on
369 * systems that support symlinks, as long as <basename> isn't too long.
371 * On success, returns 0 and stores the short name in 'short_name' and the
372 * symbolic link to eventually delete in 'linkname'. */
374 shorten_name_via_symlink(const char *name, char short_name[MAX_UN_LEN + 1],
375 char linkname[MAX_UN_LEN + 1])
377 char *abs, *dir, *base;
382 abs = abs_file_name(NULL, name);
384 base = base_name(abs);
387 tmpdir = getenv("TMPDIR");
388 if (tmpdir == NULL) {
392 for (i = 0; i < 1000; i++) {
395 len = snprintf(linkname, MAX_UN_LEN + 1,
396 "%s/ovs-un-c-%"PRIu32, tmpdir, random_uint32());
397 error = (len < 0 || len > MAX_UN_LEN ? ENAMETOOLONG
398 : symlink(dir, linkname) ? errno
400 if (error != EEXIST) {
408 fatal_signal_add_file_to_unlink(linkname);
410 len = snprintf(short_name, MAX_UN_LEN + 1, "%s/%s", linkname, base);
411 if (len < 0 || len > MAX_UN_LEN) {
412 fatal_signal_unlink_file_now(linkname);
413 error = ENAMETOOLONG;
426 /* Stores in '*un' a sockaddr_un that refers to file 'name'. Stores in
427 * '*un_len' the size of the sockaddr_un.
429 * Returns 0 on success, otherwise a positive errno value.
431 * Uses '*dirfdp' and 'linkname' to store references to data when the caller no
432 * longer needs to use 'un'. On success, freeing these references with
433 * free_sockaddr_un() is mandatory to avoid a leak; on failure, freeing them is
434 * unnecessary but harmless. */
436 make_sockaddr_un(const char *name, struct sockaddr_un *un, socklen_t *un_len,
437 int *dirfdp, char linkname[MAX_UN_LEN + 1])
439 char short_name[MAX_UN_LEN + 1];
443 if (strlen(name) > MAX_UN_LEN) {
444 /* 'name' is too long to fit in a sockaddr_un. Try a workaround. */
445 int error = shorten_name_via_proc(name, short_name, dirfdp);
446 if (error == ENAMETOOLONG) {
447 error = shorten_name_via_symlink(name, short_name, linkname);
450 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
452 VLOG_WARN_RL(&rl, "Unix socket name %s is longer than maximum "
453 "%"PRIuSIZE" bytes", name, MAX_UN_LEN);
460 un->sun_family = AF_UNIX;
461 ovs_strzcpy(un->sun_path, name, sizeof un->sun_path);
462 *un_len = (offsetof(struct sockaddr_un, sun_path)
463 + strlen (un->sun_path) + 1);
467 /* Clean up after make_sockaddr_un(). */
469 free_sockaddr_un(int dirfd, const char *linkname)
475 fatal_signal_unlink_file_now(linkname);
479 /* Binds Unix domain socket 'fd' to a file with permissions 0700. */
481 bind_unix_socket(int fd, struct sockaddr *sun, socklen_t sun_len)
483 /* According to _Unix Network Programming_, umask should affect bind(). */
484 mode_t old_umask = umask(0077);
485 int error = bind(fd, sun, sun_len) ? errno : 0;
490 /* Creates a Unix domain socket in the given 'style' (either SOCK_DGRAM or
491 * SOCK_STREAM) that is bound to '*bind_path' (if 'bind_path' is non-null) and
492 * connected to '*connect_path' (if 'connect_path' is non-null). If 'nonblock'
493 * is true, the socket is made non-blocking.
495 * Returns the socket's fd if successful, otherwise a negative errno value. */
497 make_unix_socket(int style, bool nonblock,
498 const char *bind_path, const char *connect_path)
503 fd = socket(PF_UNIX, style, 0);
508 /* Set nonblocking mode right away, if we want it. This prevents blocking
509 * in connect(), if connect_path != NULL. (In turn, that's a corner case:
510 * it will only happen if style is SOCK_STREAM or SOCK_SEQPACKET, and only
511 * if a backlog of un-accepted connections has built up in the kernel.) */
513 error = set_nonblocking(fd);
520 char linkname[MAX_UN_LEN + 1];
521 struct sockaddr_un un;
525 if (unlink(bind_path) && errno != ENOENT) {
526 VLOG_WARN("unlinking \"%s\": %s\n",
527 bind_path, ovs_strerror(errno));
529 fatal_signal_add_file_to_unlink(bind_path);
531 error = make_sockaddr_un(bind_path, &un, &un_len, &dirfd, linkname);
533 error = bind_unix_socket(fd, (struct sockaddr *) &un, un_len);
535 free_sockaddr_un(dirfd, linkname);
543 char linkname[MAX_UN_LEN + 1];
544 struct sockaddr_un un;
548 error = make_sockaddr_un(connect_path, &un, &un_len, &dirfd, linkname);
550 && connect(fd, (struct sockaddr*) &un, un_len)
551 && errno != EINPROGRESS) {
554 free_sockaddr_un(dirfd, linkname);
564 if (error == EAGAIN) {
568 fatal_signal_unlink_file_now(bind_path);
575 get_unix_name_len(socklen_t sun_len)
577 return (sun_len >= offsetof(struct sockaddr_un, sun_path)
578 ? sun_len - offsetof(struct sockaddr_un, sun_path)
584 guess_netmask(ovs_be32 ip_)
586 uint32_t ip = ntohl(ip_);
587 return ((ip >> 31) == 0 ? htonl(0xff000000) /* Class A */
588 : (ip >> 30) == 2 ? htonl(0xffff0000) /* Class B */
589 : (ip >> 29) == 6 ? htonl(0xffffff00) /* Class C */
590 : htonl(0)); /* ??? */
593 /* This is like strsep() except:
595 * - The separator string is ":".
597 * - Square brackets [] quote ":" separators and are removed from the
600 parse_bracketed_token(char **pp)
606 } else if (*p == '\0') {
609 } else if (*p == '[') {
611 char *end = start + strcspn(start, "]");
612 *pp = (*end == '\0' ? NULL
613 : end[1] == ':' ? end + 2
619 char *end = start + strcspn(start, ":");
620 *pp = *end == '\0' ? NULL : end + 1;
627 parse_sockaddr_components(struct sockaddr_storage *ss,
629 const char *port_s, uint16_t default_port,
632 struct sockaddr_in *sin = ALIGNED_CAST(struct sockaddr_in *, ss);
635 if (port_s && port_s[0]) {
636 if (!str_to_int(port_s, 10, &port) || port < 0 || port > 65535) {
637 VLOG_ERR("%s: bad port number \"%s\"", s, port_s);
643 memset(ss, 0, sizeof *ss);
644 if (strchr(host_s, ':')) {
645 struct sockaddr_in6 *sin6
646 = ALIGNED_CAST(struct sockaddr_in6 *, ss);
648 sin6->sin6_family = AF_INET6;
649 sin6->sin6_port = htons(port);
650 if (!inet_pton(AF_INET6, host_s, sin6->sin6_addr.s6_addr)) {
651 VLOG_ERR("%s: bad IPv6 address \"%s\"", s, host_s);
655 sin->sin_family = AF_INET;
656 sin->sin_port = htons(port);
657 if (!inet_pton(AF_INET, host_s, &sin->sin_addr.s_addr)) {
658 VLOG_ERR("%s: bad IPv4 address \"%s\"", s, host_s);
666 memset(ss, 0, sizeof *ss);
670 /* Parses 'target', which should be a string in the format "<host>[:<port>]".
671 * <host>, which is required, may be an IPv4 address or an IPv6 address
672 * enclosed in square brackets. If 'default_port' is nonzero then <port> is
673 * optional and defaults to 'default_port'.
675 * On success, returns true and stores the parsed remote address into '*ss'.
676 * On failure, logs an error, stores zeros into '*ss', and returns false. */
678 inet_parse_active(const char *target_, uint16_t default_port,
679 struct sockaddr_storage *ss)
681 char *target = xstrdup(target_);
688 host = parse_bracketed_token(&p);
689 port = parse_bracketed_token(&p);
691 VLOG_ERR("%s: host must be specified", target_);
693 } else if (!port && !default_port) {
694 VLOG_ERR("%s: port must be specified", target_);
697 ok = parse_sockaddr_components(ss, host, port, default_port, target_);
700 memset(ss, 0, sizeof *ss);
707 /* Opens a non-blocking IPv4 or IPv6 socket of the specified 'style' and
708 * connects to 'target', which should be a string in the format
709 * "<host>[:<port>]". <host>, which is required, may be an IPv4 address or an
710 * IPv6 address enclosed in square brackets. If 'default_port' is nonzero then
711 * <port> is optional and defaults to 'default_port'.
713 * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
715 * On success, returns 0 (indicating connection complete) or EAGAIN (indicating
716 * connection in progress), in which case the new file descriptor is stored
717 * into '*fdp'. On failure, returns a positive errno value other than EAGAIN
718 * and stores -1 into '*fdp'.
720 * If 'ss' is non-null, then on success stores the target address into '*ss'.
722 * 'dscp' becomes the DSCP bits in the IP headers for the new connection. It
723 * should be in the range [0, 63] and will automatically be shifted to the
724 * appropriately place in the IP tos field. */
726 inet_open_active(int style, const char *target, uint16_t default_port,
727 struct sockaddr_storage *ssp, int *fdp, uint8_t dscp)
729 struct sockaddr_storage ss;
734 if (!inet_parse_active(target, default_port, &ss)) {
735 error = EAFNOSUPPORT;
739 /* Create non-blocking socket. */
740 fd = socket(ss.ss_family, style, 0);
742 error = sock_errno();
743 VLOG_ERR("%s: socket: %s", target, sock_strerror(error));
746 error = set_nonblocking(fd);
751 /* The dscp bits must be configured before connect() to ensure that the
752 * TOS field is set during the connection establishment. If set after
753 * connect(), the handshake SYN frames will be sent with a TOS of 0. */
754 error = set_dscp(fd, dscp);
756 VLOG_ERR("%s: socket: %s", target, sock_strerror(error));
761 error = connect(fd, (struct sockaddr *) &ss, ss_length(&ss)) == 0
764 if (error == EINPROGRESS
766 || error == WSAEALREADY || error == WSAEWOULDBLOCK
773 if (error && error != EAGAIN) {
775 memset(ssp, 0, sizeof *ssp);
790 /* Parses 'target', which should be a string in the format "[<port>][:<host>]":
792 * - If 'default_port' is -1, then <port> is required. Otherwise, if
793 * <port> is omitted, then 'default_port' is used instead.
795 * - If <port> (or 'default_port', if used) is 0, then no port is bound
796 * and the TCP/IP stack will select a port.
798 * - <host> is optional. If supplied, it may be an IPv4 address or an
799 * IPv6 address enclosed in square brackets. If omitted, the IP address
802 * If successful, stores the address into '*ss' and returns true; otherwise
803 * zeros '*ss' and returns false. */
805 inet_parse_passive(const char *target_, int default_port,
806 struct sockaddr_storage *ss)
808 char *target = xstrdup(target_);
815 port = parse_bracketed_token(&p);
816 host = parse_bracketed_token(&p);
817 if (!port && default_port < 0) {
818 VLOG_ERR("%s: port must be specified", target_);
821 ok = parse_sockaddr_components(ss, host ? host : "0.0.0.0",
822 port, default_port, target_);
825 memset(ss, 0, sizeof *ss);
832 /* Opens a non-blocking IPv4 or IPv6 socket of the specified 'style', binds to
833 * 'target', and listens for incoming connections. Parses 'target' in the same
834 * way was inet_parse_passive().
836 * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
838 * For TCP, the socket will have SO_REUSEADDR turned on.
840 * On success, returns a non-negative file descriptor. On failure, returns a
841 * negative errno value.
843 * If 'ss' is non-null, then on success stores the bound address into '*ss'.
845 * 'dscp' becomes the DSCP bits in the IP headers for the new connection. It
846 * should be in the range [0, 63] and will automatically be shifted to the
847 * appropriately place in the IP tos field. */
849 inet_open_passive(int style, const char *target, int default_port,
850 struct sockaddr_storage *ssp, uint8_t dscp)
852 bool kernel_chooses_port;
853 struct sockaddr_storage ss;
855 unsigned int yes = 1;
857 if (!inet_parse_passive(target, default_port, &ss)) {
858 return -EAFNOSUPPORT;
860 kernel_chooses_port = ss_get_port(&ss) == 0;
862 /* Create non-blocking socket, set SO_REUSEADDR. */
863 fd = socket(ss.ss_family, style, 0);
865 error = sock_errno();
866 VLOG_ERR("%s: socket: %s", target, sock_strerror(error));
869 error = set_nonblocking(fd);
873 if (style == SOCK_STREAM
874 && setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof yes) < 0) {
875 error = sock_errno();
876 VLOG_ERR("%s: setsockopt(SO_REUSEADDR): %s",
877 target, sock_strerror(error));
882 if (bind(fd, (struct sockaddr *) &ss, ss_length(&ss)) < 0) {
883 error = sock_errno();
884 VLOG_ERR("%s: bind: %s", target, sock_strerror(error));
888 /* The dscp bits must be configured before connect() to ensure that the TOS
889 * field is set during the connection establishment. If set after
890 * connect(), the handshake SYN frames will be sent with a TOS of 0. */
891 error = set_dscp(fd, dscp);
893 VLOG_ERR("%s: socket: %s", target, sock_strerror(error));
898 if (style == SOCK_STREAM && listen(fd, 10) < 0) {
899 error = sock_errno();
900 VLOG_ERR("%s: listen: %s", target, sock_strerror(error));
904 if (ssp || kernel_chooses_port) {
905 socklen_t ss_len = sizeof ss;
906 if (getsockname(fd, (struct sockaddr *) &ss, &ss_len) < 0) {
907 error = sock_errno();
908 VLOG_ERR("%s: getsockname: %s", target, sock_strerror(error));
911 if (kernel_chooses_port) {
912 VLOG_INFO("%s: listening on port %"PRIu16,
913 target, ss_get_port(&ss));
924 memset(ssp, 0, sizeof *ssp);
931 read_fully(int fd, void *p_, size_t size, size_t *bytes_read)
937 ssize_t retval = read(fd, p, size);
939 *bytes_read += retval;
942 } else if (retval == 0) {
944 } else if (errno != EINTR) {
952 write_fully(int fd, const void *p_, size_t size, size_t *bytes_written)
954 const uint8_t *p = p_;
958 ssize_t retval = write(fd, p, size);
960 *bytes_written += retval;
963 } else if (retval == 0) {
964 VLOG_WARN("write returned 0");
966 } else if (errno != EINTR) {
973 /* Given file name 'file_name', fsyncs the directory in which it is contained.
974 * Returns 0 if successful, otherwise a positive errno value. */
976 fsync_parent_dir(const char *file_name)
983 dir = dir_name(file_name);
984 fd = open(dir, O_RDONLY);
987 if (errno == EINVAL || errno == EROFS) {
988 /* This directory does not support synchronization. Not
989 * really an error. */
992 VLOG_ERR("%s: fsync failed (%s)", dir, ovs_strerror(error));
998 VLOG_ERR("%s: open failed (%s)", dir, ovs_strerror(error));
1006 /* Obtains the modification time of the file named 'file_name' to the greatest
1007 * supported precision. If successful, stores the mtime in '*mtime' and
1008 * returns 0. On error, returns a positive errno value and stores zeros in
1011 get_mtime(const char *file_name, struct timespec *mtime)
1015 if (!stat(file_name, &s)) {
1016 mtime->tv_sec = s.st_mtime;
1018 #if HAVE_STRUCT_STAT_ST_MTIM_TV_NSEC
1019 mtime->tv_nsec = s.st_mtim.tv_nsec;
1020 #elif HAVE_STRUCT_STAT_ST_MTIMENSEC
1021 mtime->tv_nsec = s.st_mtimensec;
1028 mtime->tv_sec = mtime->tv_nsec = 0;
1037 VLOG_FATAL("failed to create pipe (%s)", ovs_strerror(errno));
1042 xpipe_nonblocking(int fds[2])
1045 xset_nonblocking(fds[0]);
1046 xset_nonblocking(fds[1]);
1050 getsockopt_int(int fd, int level, int option, const char *optname, int *valuep)
1052 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
1058 if (getsockopt(fd, level, option, &value, &len)) {
1059 error = sock_errno();
1060 VLOG_ERR_RL(&rl, "getsockopt(%s): %s", optname, sock_strerror(error));
1061 } else if (len != sizeof value) {
1063 VLOG_ERR_RL(&rl, "getsockopt(%s): value is %u bytes (expected %"PRIuSIZE")",
1064 optname, (unsigned int) len, sizeof value);
1069 *valuep = error ? 0 : value;
1074 describe_sockaddr(struct ds *string, int fd,
1075 int (*getaddr)(int, struct sockaddr *, socklen_t *))
1077 struct sockaddr_storage ss;
1078 socklen_t len = sizeof ss;
1080 if (!getaddr(fd, (struct sockaddr *) &ss, &len)) {
1081 if (ss.ss_family == AF_INET || ss.ss_family == AF_INET6) {
1082 char addrbuf[SS_NTOP_BUFSIZE];
1084 ds_put_format(string, "%s:%"PRIu16,
1085 ss_format_address(&ss, addrbuf, sizeof addrbuf),
1088 } else if (ss.ss_family == AF_UNIX) {
1089 struct sockaddr_un sun;
1093 memcpy(&sun, &ss, sizeof sun);
1094 maxlen = len - offsetof(struct sockaddr_un, sun_path);
1095 null = memchr(sun.sun_path, '\0', maxlen);
1096 ds_put_buffer(string, sun.sun_path,
1097 null ? null - sun.sun_path : maxlen);
1101 else if (ss.ss_family == AF_NETLINK) {
1104 /* SO_PROTOCOL was introduced in 2.6.32. Support it regardless of the version
1105 * of the Linux kernel headers in use at build time. */
1107 #define SO_PROTOCOL 38
1110 if (!getsockopt_int(fd, SOL_SOCKET, SO_PROTOCOL, "SO_PROTOCOL",
1114 ds_put_cstr(string, "NETLINK_ROUTE");
1117 case NETLINK_GENERIC:
1118 ds_put_cstr(string, "NETLINK_GENERIC");
1122 ds_put_format(string, "AF_NETLINK family %d", protocol);
1126 ds_put_cstr(string, "AF_NETLINK");
1130 #if AF_PACKET && LINUX_DATAPATH
1131 else if (ss.ss_family == AF_PACKET) {
1132 struct sockaddr_ll sll;
1134 memcpy(&sll, &ss, sizeof sll);
1135 ds_put_cstr(string, "AF_PACKET");
1136 if (sll.sll_ifindex) {
1137 char name[IFNAMSIZ];
1139 if (if_indextoname(sll.sll_ifindex, name)) {
1140 ds_put_format(string, "(%s)", name);
1142 ds_put_format(string, "(ifindex=%d)", sll.sll_ifindex);
1145 if (sll.sll_protocol) {
1146 ds_put_format(string, "(protocol=0x%"PRIu16")",
1147 ntohs(sll.sll_protocol));
1151 else if (ss.ss_family == AF_UNSPEC) {
1152 ds_put_cstr(string, "AF_UNSPEC");
1154 ds_put_format(string, "AF_%d", (int) ss.ss_family);
1160 #ifdef LINUX_DATAPATH
1162 put_fd_filename(struct ds *string, int fd)
1168 linkname = xasprintf("/proc/self/fd/%d", fd);
1169 n = readlink(linkname, buf, sizeof buf);
1171 ds_put_char(string, ' ');
1172 ds_put_buffer(string, buf, n);
1173 if (n > sizeof buf) {
1174 ds_put_cstr(string, "...");
1181 /* Returns a malloc()'d string describing 'fd', for use in logging. */
1190 if (fstat(fd, &s)) {
1191 ds_put_format(&string, "fstat failed (%s)", ovs_strerror(errno));
1192 } else if (S_ISSOCK(s.st_mode)) {
1193 describe_sockaddr(&string, fd, getsockname);
1194 ds_put_cstr(&string, "<->");
1195 describe_sockaddr(&string, fd, getpeername);
1197 ds_put_cstr(&string, (isatty(fd) ? "tty"
1198 : S_ISDIR(s.st_mode) ? "directory"
1199 : S_ISCHR(s.st_mode) ? "character device"
1200 : S_ISBLK(s.st_mode) ? "block device"
1201 : S_ISREG(s.st_mode) ? "file"
1202 : S_ISFIFO(s.st_mode) ? "FIFO"
1203 : S_ISLNK(s.st_mode) ? "symbolic link"
1205 #ifdef LINUX_DATAPATH
1206 put_fd_filename(&string, fd);
1210 ds_put_format(&string,"file descriptor");
1212 return ds_steal_cstr(&string);
1216 /* Calls ioctl() on an AF_INET sock, passing the specified 'command' and
1217 * 'arg'. Returns 0 if successful, otherwise a positive errno value. */
1219 af_inet_ioctl(unsigned long int command, const void *arg)
1221 static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
1224 if (ovsthread_once_start(&once)) {
1225 sock = socket(AF_INET, SOCK_DGRAM, 0);
1227 int error = sock_errno();
1228 VLOG_ERR("failed to create inet socket: %s", sock_strerror(error));
1231 ovsthread_once_done(&once);
1234 return (sock < 0 ? -sock
1235 : ioctl(sock, command, arg) == -1 ? errno
1240 af_inet_ifreq_ioctl(const char *name, struct ifreq *ifr, unsigned long int cmd,
1241 const char *cmd_name)
1245 ovs_strzcpy(ifr->ifr_name, name, sizeof ifr->ifr_name);
1246 error = af_inet_ioctl(cmd, ifr);
1248 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
1249 VLOG_DBG_RL(&rl, "%s: ioctl(%s) failed: %s", name, cmd_name,
1250 ovs_strerror(error));
1256 /* sockaddr_storage helpers. */
1258 /* Returns the IPv4 or IPv6 port in 'ss'. */
1260 ss_get_port(const struct sockaddr_storage *ss)
1262 if (ss->ss_family == AF_INET) {
1263 const struct sockaddr_in *sin
1264 = ALIGNED_CAST(const struct sockaddr_in *, ss);
1265 return ntohs(sin->sin_port);
1266 } else if (ss->ss_family == AF_INET6) {
1267 const struct sockaddr_in6 *sin6
1268 = ALIGNED_CAST(const struct sockaddr_in6 *, ss);
1269 return ntohs(sin6->sin6_port);
1275 /* Formats the IPv4 or IPv6 address in 'ss' into the 'bufsize' bytes in 'buf'.
1276 * If 'ss' is an IPv6 address, puts square brackets around the address.
1277 * 'bufsize' should be at least SS_NTOP_BUFSIZE.
1281 ss_format_address(const struct sockaddr_storage *ss,
1282 char *buf, size_t bufsize)
1284 ovs_assert(bufsize >= SS_NTOP_BUFSIZE);
1285 if (ss->ss_family == AF_INET) {
1286 const struct sockaddr_in *sin
1287 = ALIGNED_CAST(const struct sockaddr_in *, ss);
1289 snprintf(buf, bufsize, IP_FMT, IP_ARGS(sin->sin_addr.s_addr));
1290 } else if (ss->ss_family == AF_INET6) {
1291 const struct sockaddr_in6 *sin6
1292 = ALIGNED_CAST(const struct sockaddr_in6 *, ss);
1295 inet_ntop(AF_INET6, sin6->sin6_addr.s6_addr, buf + 1, bufsize - 1);
1296 strcpy(strchr(buf, '\0'), "]");
1305 ss_length(const struct sockaddr_storage *ss)
1307 switch (ss->ss_family) {
1309 return sizeof(struct sockaddr_in);
1312 return sizeof(struct sockaddr_in6);
1319 /* For Windows socket calls, 'errno' is not set. One has to call
1320 * WSAGetLastError() to get the error number and then pass it to
1321 * this function to get the correct error string.
1323 * ovs_strerror() calls strerror_r() and would not get the correct error
1324 * string for Windows sockets, but is good for POSIX. */
1326 sock_strerror(int error)
1329 return ovs_format_message(error);
1331 return ovs_strerror(error);