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"
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)" instead of "#ifdef __linux__". */
65 /* Maximum length of the sun_path member in a struct sockaddr_un, excluding
66 * space for a null terminator. */
67 #define MAX_UN_LEN (sizeof(((struct sockaddr_un *) 0)->sun_path) - 1)
69 static int getsockopt_int(int fd, int level, int option, const char *optname,
72 /* Sets 'fd' to non-blocking mode. Returns 0 if successful, otherwise a
73 * positive errno value. */
75 set_nonblocking(int fd)
78 int flags = fcntl(fd, F_GETFL, 0);
80 if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) != -1) {
83 VLOG_ERR("fcntl(F_SETFL) failed: %s", ovs_strerror(errno));
87 VLOG_ERR("fcntl(F_GETFL) failed: %s", ovs_strerror(errno));
91 unsigned long arg = 1;
92 if (ioctlsocket(fd, FIONBIO, &arg)) {
93 int error = sock_errno();
94 VLOG_ERR("set_nonblocking failed: %s", sock_strerror(error));
102 xset_nonblocking(int fd)
104 if (set_nonblocking(fd)) {
110 set_dscp(int fd, uint8_t dscp)
119 /* Note: this function is used for both of IPv4 and IPv6 sockets */
122 if (setsockopt(fd, IPPROTO_IP, IP_TOS, &val, sizeof val)) {
123 if (sock_errno() != ENOPROTOOPT) {
129 if (setsockopt(fd, IPPROTO_IPV6, IPV6_TCLASS, &val, sizeof val)) {
130 if (sock_errno() != ENOPROTOOPT) {
143 /* Translates 'host_name', which must be a string representation of an IP
144 * address, into a numeric IP address in '*addr'. Returns 0 if successful,
145 * otherwise a positive errno value. */
147 lookup_ip(const char *host_name, struct in_addr *addr)
149 if (!inet_pton(AF_INET, host_name, addr)) {
150 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
151 VLOG_ERR_RL(&rl, "\"%s\" is not a valid IP address", host_name);
157 /* Translates 'host_name', which must be a string representation of an IPv6
158 * address, into a numeric IPv6 address in '*addr'. Returns 0 if successful,
159 * otherwise a positive errno value. */
161 lookup_ipv6(const char *host_name, struct in6_addr *addr)
163 if (inet_pton(AF_INET6, host_name, addr) != 1) {
164 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
165 VLOG_ERR_RL(&rl, "\"%s\" is not a valid IPv6 address", host_name);
171 /* Translates 'host_name', which must be a host name or a string representation
172 * of an IP address, into a numeric IP address in '*addr'. Returns 0 if
173 * successful, otherwise a positive errno value.
175 * Most Open vSwitch code should not use this because it causes deadlocks:
176 * getaddrinfo() sends out a DNS request but that starts a new flow for which
177 * OVS must set up a flow, but it can't because it's waiting for a DNS reply.
178 * The synchronous lookup also delays other activity. (Of course we can solve
179 * this but it doesn't seem worthwhile quite yet.) */
181 lookup_hostname(const char *host_name, struct in_addr *addr)
183 struct addrinfo *result;
184 struct addrinfo hints;
186 if (inet_pton(AF_INET, host_name, addr)) {
190 memset(&hints, 0, sizeof hints);
191 hints.ai_family = AF_INET;
193 switch (getaddrinfo(host_name, NULL, &hints, &result)) {
195 *addr = ALIGNED_CAST(struct sockaddr_in *,
196 result->ai_addr)->sin_addr;
197 freeaddrinfo(result);
200 #ifdef EAI_ADDRFAMILY
221 #if defined (EAI_NODATA) && EAI_NODATA != EAI_NONAME
237 check_connection_completion(int fd)
239 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
244 pfd.events = POLLOUT;
248 retval = poll(&pfd, 1, 0);
249 } while (retval < 0 && errno == EINTR);
251 retval = WSAPoll(&pfd, 1, 0);
254 if (pfd.revents & POLLERR) {
255 ssize_t n = send(fd, "", 1, 0);
259 VLOG_ERR_RL(&rl, "poll return POLLERR but send succeeded");
264 } else if (retval < 0) {
265 VLOG_ERR_RL(&rl, "poll: %s", sock_strerror(sock_errno()));
273 /* Drain all the data currently in the receive queue of a datagram socket (and
274 * possibly additional data). There is no way to know how many packets are in
275 * the receive queue, but we do know that the total number of bytes queued does
276 * not exceed the receive buffer size, so we pull packets until none are left
277 * or we've read that many bytes. */
283 rcvbuf = get_socket_rcvbuf(fd);
289 /* In Linux, specifying MSG_TRUNC in the flags argument causes the
290 * datagram length to be returned, even if that is longer than the
291 * buffer provided. Thus, we can use a 1-byte buffer to discard the
292 * incoming datagram and still be able to account how many bytes were
293 * removed from the receive buffer.
295 * On other Unix-like OSes, MSG_TRUNC has no effect in the flags
297 char buffer[LINUX ? 1 : 2048];
298 ssize_t n_bytes = recv(fd, buffer, sizeof buffer,
299 MSG_TRUNC | MSG_DONTWAIT);
300 if (n_bytes <= 0 || n_bytes >= rcvbuf) {
309 /* Returns the size of socket 'sock''s receive buffer (SO_RCVBUF), or a
310 * negative errno value if an error occurs. */
312 get_socket_rcvbuf(int sock)
317 error = getsockopt_int(sock, SOL_SOCKET, SO_RCVBUF, "SO_RCVBUF", &rcvbuf);
318 return error ? -error : rcvbuf;
321 /* Reads and discards up to 'n' datagrams from 'fd', stopping as soon as no
322 * more data can be immediately read. ('fd' should therefore be in
323 * non-blocking mode.)*/
325 drain_fd(int fd, size_t n_packets)
327 for (; n_packets > 0; n_packets--) {
328 /* 'buffer' only needs to be 1 byte long in most circumstances. This
329 * size is defensive against the possibility that we someday want to
330 * use a Linux tap device without TUN_NO_PI, in which case a buffer
331 * smaller than sizeof(struct tun_pi) will give EINVAL on read. */
333 if (read(fd, buffer, sizeof buffer) <= 0) {
340 /* Attempts to shorten 'name' by opening a file descriptor for the directory
341 * part of the name and indirecting through /proc/self/fd/<dirfd>/<basename>.
342 * On systems with Linux-like /proc, this works as long as <basename> isn't too
345 * On success, returns 0 and stores the short name in 'short_name' and a
346 * directory file descriptor to eventually be closed in '*dirfpd'. */
348 shorten_name_via_proc(const char *name, char short_name[MAX_UN_LEN + 1],
359 dir = dir_name(name);
360 dirfd = open(dir, O_DIRECTORY | O_RDONLY);
362 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
365 VLOG_WARN_RL(&rl, "%s: open failed (%s)", dir, ovs_strerror(error));
372 base = base_name(name);
373 len = snprintf(short_name, MAX_UN_LEN + 1,
374 "/proc/self/fd/%d/%s", dirfd, base);
377 if (len >= 0 && len <= MAX_UN_LEN) {
386 /* Attempts to shorten 'name' by creating a symlink for the directory part of
387 * the name and indirecting through <symlink>/<basename>. This works on
388 * systems that support symlinks, as long as <basename> isn't too long.
390 * On success, returns 0 and stores the short name in 'short_name' and the
391 * symbolic link to eventually delete in 'linkname'. */
393 shorten_name_via_symlink(const char *name, char short_name[MAX_UN_LEN + 1],
394 char linkname[MAX_UN_LEN + 1])
396 char *abs, *dir, *base;
401 abs = abs_file_name(NULL, name);
403 base = base_name(abs);
406 tmpdir = getenv("TMPDIR");
407 if (tmpdir == NULL) {
411 for (i = 0; i < 1000; i++) {
414 len = snprintf(linkname, MAX_UN_LEN + 1,
415 "%s/ovs-un-c-%"PRIu32, tmpdir, random_uint32());
416 error = (len < 0 || len > MAX_UN_LEN ? ENAMETOOLONG
417 : symlink(dir, linkname) ? errno
419 if (error != EEXIST) {
427 fatal_signal_add_file_to_unlink(linkname);
429 len = snprintf(short_name, MAX_UN_LEN + 1, "%s/%s", linkname, base);
430 if (len < 0 || len > MAX_UN_LEN) {
431 fatal_signal_unlink_file_now(linkname);
432 error = ENAMETOOLONG;
445 /* Stores in '*un' a sockaddr_un that refers to file 'name'. Stores in
446 * '*un_len' the size of the sockaddr_un.
448 * Returns 0 on success, otherwise a positive errno value.
450 * Uses '*dirfdp' and 'linkname' to store references to data when the caller no
451 * longer needs to use 'un'. On success, freeing these references with
452 * free_sockaddr_un() is mandatory to avoid a leak; on failure, freeing them is
453 * unnecessary but harmless. */
455 make_sockaddr_un(const char *name, struct sockaddr_un *un, socklen_t *un_len,
456 int *dirfdp, char linkname[MAX_UN_LEN + 1])
458 char short_name[MAX_UN_LEN + 1];
462 if (strlen(name) > MAX_UN_LEN) {
463 /* 'name' is too long to fit in a sockaddr_un. Try a workaround. */
464 int error = shorten_name_via_proc(name, short_name, dirfdp);
465 if (error == ENAMETOOLONG) {
466 error = shorten_name_via_symlink(name, short_name, linkname);
469 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
471 VLOG_WARN_RL(&rl, "Unix socket name %s is longer than maximum "
472 "%"PRIuSIZE" bytes", name, MAX_UN_LEN);
479 un->sun_family = AF_UNIX;
480 ovs_strzcpy(un->sun_path, name, sizeof un->sun_path);
481 *un_len = (offsetof(struct sockaddr_un, sun_path)
482 + strlen (un->sun_path) + 1);
486 /* Clean up after make_sockaddr_un(). */
488 free_sockaddr_un(int dirfd, const char *linkname)
494 fatal_signal_unlink_file_now(linkname);
498 /* Binds Unix domain socket 'fd' to a file with permissions 0700. */
500 bind_unix_socket(int fd, struct sockaddr *sun, socklen_t sun_len)
502 /* According to _Unix Network Programming_, umask should affect bind(). */
503 mode_t old_umask = umask(0077);
504 int error = bind(fd, sun, sun_len) ? errno : 0;
509 /* Creates a Unix domain socket in the given 'style' (either SOCK_DGRAM or
510 * SOCK_STREAM) that is bound to '*bind_path' (if 'bind_path' is non-null) and
511 * connected to '*connect_path' (if 'connect_path' is non-null). If 'nonblock'
512 * is true, the socket is made non-blocking.
514 * Returns the socket's fd if successful, otherwise a negative errno value. */
516 make_unix_socket(int style, bool nonblock,
517 const char *bind_path, const char *connect_path)
522 fd = socket(PF_UNIX, style, 0);
527 /* Set nonblocking mode right away, if we want it. This prevents blocking
528 * in connect(), if connect_path != NULL. (In turn, that's a corner case:
529 * it will only happen if style is SOCK_STREAM or SOCK_SEQPACKET, and only
530 * if a backlog of un-accepted connections has built up in the kernel.) */
532 error = set_nonblocking(fd);
539 char linkname[MAX_UN_LEN + 1];
540 struct sockaddr_un un;
544 if (unlink(bind_path) && errno != ENOENT) {
545 VLOG_WARN("unlinking \"%s\": %s\n",
546 bind_path, ovs_strerror(errno));
548 fatal_signal_add_file_to_unlink(bind_path);
550 error = make_sockaddr_un(bind_path, &un, &un_len, &dirfd, linkname);
552 error = bind_unix_socket(fd, (struct sockaddr *) &un, un_len);
554 free_sockaddr_un(dirfd, linkname);
562 char linkname[MAX_UN_LEN + 1];
563 struct sockaddr_un un;
567 error = make_sockaddr_un(connect_path, &un, &un_len, &dirfd, linkname);
569 && connect(fd, (struct sockaddr*) &un, un_len)
570 && errno != EINPROGRESS) {
573 free_sockaddr_un(dirfd, linkname);
583 if (error == EAGAIN) {
587 fatal_signal_unlink_file_now(bind_path);
594 get_unix_name_len(socklen_t sun_len)
596 return (sun_len >= offsetof(struct sockaddr_un, sun_path)
597 ? sun_len - offsetof(struct sockaddr_un, sun_path)
603 guess_netmask(ovs_be32 ip_)
605 uint32_t ip = ntohl(ip_);
606 return ((ip >> 31) == 0 ? htonl(0xff000000) /* Class A */
607 : (ip >> 30) == 2 ? htonl(0xffff0000) /* Class B */
608 : (ip >> 29) == 6 ? htonl(0xffffff00) /* Class C */
609 : htonl(0)); /* ??? */
612 /* This is like strsep() except:
614 * - The separator string is ":".
616 * - Square brackets [] quote ":" separators and are removed from the
619 parse_bracketed_token(char **pp)
625 } else if (*p == '\0') {
628 } else if (*p == '[') {
630 char *end = start + strcspn(start, "]");
631 *pp = (*end == '\0' ? NULL
632 : end[1] == ':' ? end + 2
638 char *end = start + strcspn(start, ":");
639 *pp = *end == '\0' ? NULL : end + 1;
646 parse_sockaddr_components(struct sockaddr_storage *ss,
648 const char *port_s, uint16_t default_port,
651 struct sockaddr_in *sin = ALIGNED_CAST(struct sockaddr_in *, ss);
654 if (port_s && port_s[0]) {
655 if (!str_to_int(port_s, 10, &port) || port < 0 || port > 65535) {
656 VLOG_ERR("%s: bad port number \"%s\"", s, port_s);
662 memset(ss, 0, sizeof *ss);
663 if (strchr(host_s, ':')) {
664 struct sockaddr_in6 *sin6
665 = ALIGNED_CAST(struct sockaddr_in6 *, ss);
667 sin6->sin6_family = AF_INET6;
668 sin6->sin6_port = htons(port);
669 if (!inet_pton(AF_INET6, host_s, sin6->sin6_addr.s6_addr)) {
670 VLOG_ERR("%s: bad IPv6 address \"%s\"", s, host_s);
674 sin->sin_family = AF_INET;
675 sin->sin_port = htons(port);
676 if (!inet_pton(AF_INET, host_s, &sin->sin_addr.s_addr)) {
677 VLOG_ERR("%s: bad IPv4 address \"%s\"", s, host_s);
685 memset(ss, 0, sizeof *ss);
689 /* Parses 'target', which should be a string in the format "<host>[:<port>]".
690 * <host>, which is required, may be an IPv4 address or an IPv6 address
691 * enclosed in square brackets. If 'default_port' is nonzero then <port> is
692 * optional and defaults to 'default_port'.
694 * On success, returns true and stores the parsed remote address into '*ss'.
695 * On failure, logs an error, stores zeros into '*ss', and returns false. */
697 inet_parse_active(const char *target_, uint16_t default_port,
698 struct sockaddr_storage *ss)
700 char *target = xstrdup(target_);
707 host = parse_bracketed_token(&p);
708 port = parse_bracketed_token(&p);
710 VLOG_ERR("%s: host must be specified", target_);
712 } else if (!port && !default_port) {
713 VLOG_ERR("%s: port must be specified", target_);
716 ok = parse_sockaddr_components(ss, host, port, default_port, target_);
719 memset(ss, 0, sizeof *ss);
726 /* Opens a non-blocking IPv4 or IPv6 socket of the specified 'style' and
727 * connects to 'target', which should be a string in the format
728 * "<host>[:<port>]". <host>, which is required, may be an IPv4 address or an
729 * IPv6 address enclosed in square brackets. If 'default_port' is nonzero then
730 * <port> is optional and defaults to 'default_port'.
732 * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
734 * On success, returns 0 (indicating connection complete) or EAGAIN (indicating
735 * connection in progress), in which case the new file descriptor is stored
736 * into '*fdp'. On failure, returns a positive errno value other than EAGAIN
737 * and stores -1 into '*fdp'.
739 * If 'ss' is non-null, then on success stores the target address into '*ss'.
741 * 'dscp' becomes the DSCP bits in the IP headers for the new connection. It
742 * should be in the range [0, 63] and will automatically be shifted to the
743 * appropriately place in the IP tos field. */
745 inet_open_active(int style, const char *target, uint16_t default_port,
746 struct sockaddr_storage *ssp, int *fdp, uint8_t dscp)
748 struct sockaddr_storage ss;
753 if (!inet_parse_active(target, default_port, &ss)) {
754 error = EAFNOSUPPORT;
758 /* Create non-blocking socket. */
759 fd = socket(ss.ss_family, style, 0);
761 error = sock_errno();
762 VLOG_ERR("%s: socket: %s", target, sock_strerror(error));
765 error = set_nonblocking(fd);
770 /* The dscp bits must be configured before connect() to ensure that the
771 * TOS field is set during the connection establishment. If set after
772 * connect(), the handshake SYN frames will be sent with a TOS of 0. */
773 error = set_dscp(fd, dscp);
775 VLOG_ERR("%s: set_dscp: %s", target, sock_strerror(error));
780 error = connect(fd, (struct sockaddr *) &ss, ss_length(&ss)) == 0
783 if (error == EINPROGRESS
785 || error == WSAEALREADY || error == WSAEWOULDBLOCK
792 if (error && error != EAGAIN) {
794 memset(ssp, 0, sizeof *ssp);
809 /* Parses 'target', which should be a string in the format "[<port>][:<host>]":
811 * - If 'default_port' is -1, then <port> is required. Otherwise, if
812 * <port> is omitted, then 'default_port' is used instead.
814 * - If <port> (or 'default_port', if used) is 0, then no port is bound
815 * and the TCP/IP stack will select a port.
817 * - <host> is optional. If supplied, it may be an IPv4 address or an
818 * IPv6 address enclosed in square brackets. If omitted, the IP address
821 * If successful, stores the address into '*ss' and returns true; otherwise
822 * zeros '*ss' and returns false. */
824 inet_parse_passive(const char *target_, int default_port,
825 struct sockaddr_storage *ss)
827 char *target = xstrdup(target_);
834 port = parse_bracketed_token(&p);
835 host = parse_bracketed_token(&p);
836 if (!port && default_port < 0) {
837 VLOG_ERR("%s: port must be specified", target_);
840 ok = parse_sockaddr_components(ss, host ? host : "0.0.0.0",
841 port, default_port, target_);
844 memset(ss, 0, sizeof *ss);
851 /* Opens a non-blocking IPv4 or IPv6 socket of the specified 'style', binds to
852 * 'target', and listens for incoming connections. Parses 'target' in the same
853 * way was inet_parse_passive().
855 * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
857 * For TCP, the socket will have SO_REUSEADDR turned on.
859 * On success, returns a non-negative file descriptor. On failure, returns a
860 * negative errno value.
862 * If 'ss' is non-null, then on success stores the bound address into '*ss'.
864 * 'dscp' becomes the DSCP bits in the IP headers for the new connection. It
865 * should be in the range [0, 63] and will automatically be shifted to the
866 * appropriately place in the IP tos field. */
868 inet_open_passive(int style, const char *target, int default_port,
869 struct sockaddr_storage *ssp, uint8_t dscp)
871 bool kernel_chooses_port;
872 struct sockaddr_storage ss;
874 unsigned int yes = 1;
876 if (!inet_parse_passive(target, default_port, &ss)) {
877 return -EAFNOSUPPORT;
879 kernel_chooses_port = ss_get_port(&ss) == 0;
881 /* Create non-blocking socket, set SO_REUSEADDR. */
882 fd = socket(ss.ss_family, style, 0);
884 error = sock_errno();
885 VLOG_ERR("%s: socket: %s", target, sock_strerror(error));
888 error = set_nonblocking(fd);
892 if (style == SOCK_STREAM
893 && setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof yes) < 0) {
894 error = sock_errno();
895 VLOG_ERR("%s: setsockopt(SO_REUSEADDR): %s",
896 target, sock_strerror(error));
901 if (bind(fd, (struct sockaddr *) &ss, ss_length(&ss)) < 0) {
902 error = sock_errno();
903 VLOG_ERR("%s: bind: %s", target, sock_strerror(error));
907 /* The dscp bits must be configured before connect() to ensure that the TOS
908 * field is set during the connection establishment. If set after
909 * connect(), the handshake SYN frames will be sent with a TOS of 0. */
910 error = set_dscp(fd, dscp);
912 VLOG_ERR("%s: set_dscp: %s", target, sock_strerror(error));
917 if (style == SOCK_STREAM && listen(fd, 10) < 0) {
918 error = sock_errno();
919 VLOG_ERR("%s: listen: %s", target, sock_strerror(error));
923 if (ssp || kernel_chooses_port) {
924 socklen_t ss_len = sizeof ss;
925 if (getsockname(fd, (struct sockaddr *) &ss, &ss_len) < 0) {
926 error = sock_errno();
927 VLOG_ERR("%s: getsockname: %s", target, sock_strerror(error));
930 if (kernel_chooses_port) {
931 VLOG_INFO("%s: listening on port %"PRIu16,
932 target, ss_get_port(&ss));
943 memset(ssp, 0, sizeof *ssp);
950 read_fully(int fd, void *p_, size_t size, size_t *bytes_read)
956 ssize_t retval = read(fd, p, size);
958 *bytes_read += retval;
961 } else if (retval == 0) {
963 } else if (errno != EINTR) {
971 write_fully(int fd, const void *p_, size_t size, size_t *bytes_written)
973 const uint8_t *p = p_;
977 ssize_t retval = write(fd, p, size);
979 *bytes_written += retval;
982 } else if (retval == 0) {
983 VLOG_WARN("write returned 0");
985 } else if (errno != EINTR) {
992 /* Given file name 'file_name', fsyncs the directory in which it is contained.
993 * Returns 0 if successful, otherwise a positive errno value. */
995 fsync_parent_dir(const char *file_name)
1002 dir = dir_name(file_name);
1003 fd = open(dir, O_RDONLY);
1006 if (errno == EINVAL || errno == EROFS) {
1007 /* This directory does not support synchronization. Not
1008 * really an error. */
1011 VLOG_ERR("%s: fsync failed (%s)", dir, ovs_strerror(error));
1017 VLOG_ERR("%s: open failed (%s)", dir, ovs_strerror(error));
1025 /* Obtains the modification time of the file named 'file_name' to the greatest
1026 * supported precision. If successful, stores the mtime in '*mtime' and
1027 * returns 0. On error, returns a positive errno value and stores zeros in
1030 get_mtime(const char *file_name, struct timespec *mtime)
1034 if (!stat(file_name, &s)) {
1035 mtime->tv_sec = s.st_mtime;
1037 #if HAVE_STRUCT_STAT_ST_MTIM_TV_NSEC
1038 mtime->tv_nsec = s.st_mtim.tv_nsec;
1039 #elif HAVE_STRUCT_STAT_ST_MTIMENSEC
1040 mtime->tv_nsec = s.st_mtimensec;
1047 mtime->tv_sec = mtime->tv_nsec = 0;
1057 VLOG_FATAL("failed to create pipe (%s)", ovs_strerror(errno));
1062 xpipe_nonblocking(int fds[2])
1065 xset_nonblocking(fds[0]);
1066 xset_nonblocking(fds[1]);
1071 getsockopt_int(int fd, int level, int option, const char *optname, int *valuep)
1073 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
1079 if (getsockopt(fd, level, option, &value, &len)) {
1080 error = sock_errno();
1081 VLOG_ERR_RL(&rl, "getsockopt(%s): %s", optname, sock_strerror(error));
1082 } else if (len != sizeof value) {
1084 VLOG_ERR_RL(&rl, "getsockopt(%s): value is %u bytes (expected %"PRIuSIZE")",
1085 optname, (unsigned int) len, sizeof value);
1090 *valuep = error ? 0 : value;
1095 describe_sockaddr(struct ds *string, int fd,
1096 int (*getaddr)(int, struct sockaddr *, socklen_t *))
1098 struct sockaddr_storage ss;
1099 socklen_t len = sizeof ss;
1101 if (!getaddr(fd, (struct sockaddr *) &ss, &len)) {
1102 if (ss.ss_family == AF_INET || ss.ss_family == AF_INET6) {
1103 char addrbuf[SS_NTOP_BUFSIZE];
1105 ds_put_format(string, "%s:%"PRIu16,
1106 ss_format_address(&ss, addrbuf, sizeof addrbuf),
1109 } else if (ss.ss_family == AF_UNIX) {
1110 struct sockaddr_un sun;
1114 memcpy(&sun, &ss, sizeof sun);
1115 maxlen = len - offsetof(struct sockaddr_un, sun_path);
1116 null = memchr(sun.sun_path, '\0', maxlen);
1117 ds_put_buffer(string, sun.sun_path,
1118 null ? null - sun.sun_path : maxlen);
1122 else if (ss.ss_family == AF_NETLINK) {
1125 /* SO_PROTOCOL was introduced in 2.6.32. Support it regardless of the version
1126 * of the Linux kernel headers in use at build time. */
1128 #define SO_PROTOCOL 38
1131 if (!getsockopt_int(fd, SOL_SOCKET, SO_PROTOCOL, "SO_PROTOCOL",
1135 ds_put_cstr(string, "NETLINK_ROUTE");
1138 case NETLINK_GENERIC:
1139 ds_put_cstr(string, "NETLINK_GENERIC");
1143 ds_put_format(string, "AF_NETLINK family %d", protocol);
1147 ds_put_cstr(string, "AF_NETLINK");
1152 else if (ss.ss_family == AF_PACKET) {
1153 struct sockaddr_ll sll;
1155 memcpy(&sll, &ss, sizeof sll);
1156 ds_put_cstr(string, "AF_PACKET");
1157 if (sll.sll_ifindex) {
1158 char name[IFNAMSIZ];
1160 if (if_indextoname(sll.sll_ifindex, name)) {
1161 ds_put_format(string, "(%s)", name);
1163 ds_put_format(string, "(ifindex=%d)", sll.sll_ifindex);
1166 if (sll.sll_protocol) {
1167 ds_put_format(string, "(protocol=0x%"PRIu16")",
1168 ntohs(sll.sll_protocol));
1172 else if (ss.ss_family == AF_UNSPEC) {
1173 ds_put_cstr(string, "AF_UNSPEC");
1175 ds_put_format(string, "AF_%d", (int) ss.ss_family);
1183 put_fd_filename(struct ds *string, int fd)
1189 linkname = xasprintf("/proc/self/fd/%d", fd);
1190 n = readlink(linkname, buf, sizeof buf);
1192 ds_put_char(string, ' ');
1193 ds_put_buffer(string, buf, n);
1194 if (n > sizeof buf) {
1195 ds_put_cstr(string, "...");
1202 /* Returns a malloc()'d string describing 'fd', for use in logging. */
1211 if (fstat(fd, &s)) {
1212 ds_put_format(&string, "fstat failed (%s)", ovs_strerror(errno));
1213 } else if (S_ISSOCK(s.st_mode)) {
1214 describe_sockaddr(&string, fd, getsockname);
1215 ds_put_cstr(&string, "<->");
1216 describe_sockaddr(&string, fd, getpeername);
1218 ds_put_cstr(&string, (isatty(fd) ? "tty"
1219 : S_ISDIR(s.st_mode) ? "directory"
1220 : S_ISCHR(s.st_mode) ? "character device"
1221 : S_ISBLK(s.st_mode) ? "block device"
1222 : S_ISREG(s.st_mode) ? "file"
1223 : S_ISFIFO(s.st_mode) ? "FIFO"
1224 : S_ISLNK(s.st_mode) ? "symbolic link"
1227 put_fd_filename(&string, fd);
1231 ds_put_format(&string,"file descriptor");
1233 return ds_steal_cstr(&string);
1237 /* Calls ioctl() on an AF_INET sock, passing the specified 'command' and
1238 * 'arg'. Returns 0 if successful, otherwise a positive errno value. */
1240 af_inet_ioctl(unsigned long int command, const void *arg)
1242 static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
1245 if (ovsthread_once_start(&once)) {
1246 sock = socket(AF_INET, SOCK_DGRAM, 0);
1248 int error = sock_errno();
1249 VLOG_ERR("failed to create inet socket: %s", sock_strerror(error));
1252 ovsthread_once_done(&once);
1255 return (sock < 0 ? -sock
1256 : ioctl(sock, command, arg) == -1 ? errno
1261 af_inet_ifreq_ioctl(const char *name, struct ifreq *ifr, unsigned long int cmd,
1262 const char *cmd_name)
1266 ovs_strzcpy(ifr->ifr_name, name, sizeof ifr->ifr_name);
1267 error = af_inet_ioctl(cmd, ifr);
1269 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
1270 VLOG_DBG_RL(&rl, "%s: ioctl(%s) failed: %s", name, cmd_name,
1271 ovs_strerror(error));
1277 /* sockaddr_storage helpers. */
1279 /* Returns the IPv4 or IPv6 port in 'ss'. */
1281 ss_get_port(const struct sockaddr_storage *ss)
1283 if (ss->ss_family == AF_INET) {
1284 const struct sockaddr_in *sin
1285 = ALIGNED_CAST(const struct sockaddr_in *, ss);
1286 return ntohs(sin->sin_port);
1287 } else if (ss->ss_family == AF_INET6) {
1288 const struct sockaddr_in6 *sin6
1289 = ALIGNED_CAST(const struct sockaddr_in6 *, ss);
1290 return ntohs(sin6->sin6_port);
1296 /* Formats the IPv4 or IPv6 address in 'ss' into the 'bufsize' bytes in 'buf'.
1297 * If 'ss' is an IPv6 address, puts square brackets around the address.
1298 * 'bufsize' should be at least SS_NTOP_BUFSIZE.
1302 ss_format_address(const struct sockaddr_storage *ss,
1303 char *buf, size_t bufsize)
1305 ovs_assert(bufsize >= SS_NTOP_BUFSIZE);
1306 if (ss->ss_family == AF_INET) {
1307 const struct sockaddr_in *sin
1308 = ALIGNED_CAST(const struct sockaddr_in *, ss);
1310 snprintf(buf, bufsize, IP_FMT, IP_ARGS(sin->sin_addr.s_addr));
1311 } else if (ss->ss_family == AF_INET6) {
1312 const struct sockaddr_in6 *sin6
1313 = ALIGNED_CAST(const struct sockaddr_in6 *, ss);
1316 inet_ntop(AF_INET6, sin6->sin6_addr.s6_addr, buf + 1, bufsize - 1);
1317 strcpy(strchr(buf, '\0'), "]");
1326 ss_length(const struct sockaddr_storage *ss)
1328 switch (ss->ss_family) {
1330 return sizeof(struct sockaddr_in);
1333 return sizeof(struct sockaddr_in6);
1340 /* For Windows socket calls, 'errno' is not set. One has to call
1341 * WSAGetLastError() to get the error number and then pass it to
1342 * this function to get the correct error string.
1344 * ovs_strerror() calls strerror_r() and would not get the correct error
1345 * string for Windows sockets, but is good for POSIX. */
1347 sock_strerror(int error)
1350 return ovs_format_message(error);
1352 return ovs_strerror(error);