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/resource.h>
31 #include <sys/socket.h>
36 #include "dynamic-string.h"
37 #include "fatal-signal.h"
38 #include "ovs-thread.h"
40 #include "poll-loop.h"
43 #if AF_PACKET && LINUX_DATAPATH
44 #include <linux/if_packet.h>
47 #include "netlink-protocol.h"
48 #include "netlink-socket.h"
51 VLOG_DEFINE_THIS_MODULE(socket_util);
53 /* #ifdefs make it a pain to maintain code: you have to try to build both ways.
54 * Thus, this file compiles all of the code regardless of the target, by
55 * writing "if (LINUX_DATAPATH)" instead of "#ifdef __linux__". */
56 #ifndef LINUX_DATAPATH
57 #define LINUX_DATAPATH 0
64 /* Maximum length of the sun_path member in a struct sockaddr_un, excluding
65 * space for a null terminator. */
66 #define MAX_UN_LEN (sizeof(((struct sockaddr_un *) 0)->sun_path) - 1)
68 static int getsockopt_int(int fd, int level, int option, const char *optname,
71 /* Sets 'fd' to non-blocking mode. Returns 0 if successful, otherwise a
72 * positive errno value. */
74 set_nonblocking(int fd)
77 int flags = fcntl(fd, F_GETFL, 0);
79 if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) != -1) {
82 VLOG_ERR("fcntl(F_SETFL) failed: %s", ovs_strerror(errno));
86 VLOG_ERR("fcntl(F_GETFL) failed: %s", ovs_strerror(errno));
90 unsigned long arg = 1;
91 if (ioctlsocket(fd, FIONBIO, &arg)) {
92 int error = sock_errno();
93 VLOG_ERR("set_nonblocking failed: %s", sock_strerror(error));
101 xset_nonblocking(int fd)
103 if (set_nonblocking(fd)) {
109 set_dscp(int fd, uint8_t dscp)
118 if (setsockopt(fd, IPPROTO_IP, IP_TOS, &val, sizeof val)) {
126 rlim_is_finite(rlim_t limit)
128 if (limit == RLIM_INFINITY) {
132 #ifdef RLIM_SAVED_CUR /* FreeBSD 8.0 lacks RLIM_SAVED_CUR. */
133 if (limit == RLIM_SAVED_CUR) {
138 #ifdef RLIM_SAVED_MAX /* FreeBSD 8.0 lacks RLIM_SAVED_MAX. */
139 if (limit == RLIM_SAVED_MAX) {
147 /* Returns the maximum valid FD value, plus 1. */
151 static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
154 if (ovsthread_once_start(&once)) {
156 if (!getrlimit(RLIMIT_NOFILE, &r) && rlim_is_finite(r.rlim_cur)) {
157 max_fds = r.rlim_cur;
159 VLOG_WARN("failed to obtain fd limit, defaulting to 1024");
162 ovsthread_once_done(&once);
168 /* Translates 'host_name', which must be a string representation of an IP
169 * address, into a numeric IP address in '*addr'. Returns 0 if successful,
170 * otherwise a positive errno value. */
172 lookup_ip(const char *host_name, struct in_addr *addr)
174 if (!inet_aton(host_name, addr)) {
175 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
176 VLOG_ERR_RL(&rl, "\"%s\" is not a valid IP address", host_name);
182 /* Translates 'host_name', which must be a string representation of an IPv6
183 * address, into a numeric IPv6 address in '*addr'. Returns 0 if successful,
184 * otherwise a positive errno value. */
186 lookup_ipv6(const char *host_name, struct in6_addr *addr)
188 if (inet_pton(AF_INET6, host_name, addr) != 1) {
189 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
190 VLOG_ERR_RL(&rl, "\"%s\" is not a valid IPv6 address", host_name);
196 /* Translates 'host_name', which must be a host name or a string representation
197 * of an IP address, into a numeric IP address in '*addr'. Returns 0 if
198 * successful, otherwise a positive errno value.
200 * Most Open vSwitch code should not use this because it causes deadlocks:
201 * getaddrinfo() sends out a DNS request but that starts a new flow for which
202 * OVS must set up a flow, but it can't because it's waiting for a DNS reply.
203 * The synchronous lookup also delays other activity. (Of course we can solve
204 * this but it doesn't seem worthwhile quite yet.) */
206 lookup_hostname(const char *host_name, struct in_addr *addr)
208 struct addrinfo *result;
209 struct addrinfo hints;
211 if (inet_aton(host_name, addr)) {
215 memset(&hints, 0, sizeof hints);
216 hints.ai_family = AF_INET;
218 switch (getaddrinfo(host_name, NULL, &hints, &result)) {
220 *addr = ALIGNED_CAST(struct sockaddr_in *,
221 result->ai_addr)->sin_addr;
222 freeaddrinfo(result);
225 #ifdef EAI_ADDRFAMILY
260 check_connection_completion(int fd)
262 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
267 pfd.events = POLLOUT;
269 retval = poll(&pfd, 1, 0);
270 } while (retval < 0 && errno == EINTR);
272 if (pfd.revents & POLLERR) {
273 ssize_t n = send(fd, "", 1, MSG_DONTWAIT);
277 VLOG_ERR_RL(&rl, "poll return POLLERR but send succeeded");
282 } else if (retval < 0) {
283 VLOG_ERR_RL(&rl, "poll: %s", ovs_strerror(errno));
290 /* Drain all the data currently in the receive queue of a datagram socket (and
291 * possibly additional data). There is no way to know how many packets are in
292 * the receive queue, but we do know that the total number of bytes queued does
293 * not exceed the receive buffer size, so we pull packets until none are left
294 * or we've read that many bytes. */
300 rcvbuf = get_socket_rcvbuf(fd);
306 /* In Linux, specifying MSG_TRUNC in the flags argument causes the
307 * datagram length to be returned, even if that is longer than the
308 * buffer provided. Thus, we can use a 1-byte buffer to discard the
309 * incoming datagram and still be able to account how many bytes were
310 * removed from the receive buffer.
312 * On other Unix-like OSes, MSG_TRUNC has no effect in the flags
314 char buffer[LINUX_DATAPATH ? 1 : 2048];
315 ssize_t n_bytes = recv(fd, buffer, sizeof buffer,
316 MSG_TRUNC | MSG_DONTWAIT);
317 if (n_bytes <= 0 || n_bytes >= rcvbuf) {
325 /* Returns the size of socket 'sock''s receive buffer (SO_RCVBUF), or a
326 * negative errno value if an error occurs. */
328 get_socket_rcvbuf(int sock)
333 error = getsockopt_int(sock, SOL_SOCKET, SO_RCVBUF, "SO_RCVBUF", &rcvbuf);
334 return error ? -error : rcvbuf;
337 /* Reads and discards up to 'n' datagrams from 'fd', stopping as soon as no
338 * more data can be immediately read. ('fd' should therefore be in
339 * non-blocking mode.)*/
341 drain_fd(int fd, size_t n_packets)
343 for (; n_packets > 0; n_packets--) {
344 /* 'buffer' only needs to be 1 byte long in most circumstances. This
345 * size is defensive against the possibility that we someday want to
346 * use a Linux tap device without TUN_NO_PI, in which case a buffer
347 * smaller than sizeof(struct tun_pi) will give EINVAL on read. */
349 if (read(fd, buffer, sizeof buffer) <= 0) {
355 /* Attempts to shorten 'name' by opening a file descriptor for the directory
356 * part of the name and indirecting through /proc/self/fd/<dirfd>/<basename>.
357 * On systems with Linux-like /proc, this works as long as <basename> isn't too
360 * On success, returns 0 and stores the short name in 'short_name' and a
361 * directory file descriptor to eventually be closed in '*dirfpd'. */
363 shorten_name_via_proc(const char *name, char short_name[MAX_UN_LEN + 1],
370 if (!LINUX_DATAPATH) {
374 dir = dir_name(name);
375 dirfd = open(dir, O_DIRECTORY | O_RDONLY);
377 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
380 VLOG_WARN_RL(&rl, "%s: open failed (%s)", dir, ovs_strerror(error));
387 base = base_name(name);
388 len = snprintf(short_name, MAX_UN_LEN + 1,
389 "/proc/self/fd/%d/%s", dirfd, base);
392 if (len >= 0 && len <= MAX_UN_LEN) {
401 /* Attempts to shorten 'name' by creating a symlink for the directory part of
402 * the name and indirecting through <symlink>/<basename>. This works on
403 * systems that support symlinks, as long as <basename> isn't too long.
405 * On success, returns 0 and stores the short name in 'short_name' and the
406 * symbolic link to eventually delete in 'linkname'. */
408 shorten_name_via_symlink(const char *name, char short_name[MAX_UN_LEN + 1],
409 char linkname[MAX_UN_LEN + 1])
411 char *abs, *dir, *base;
416 abs = abs_file_name(NULL, name);
418 base = base_name(abs);
421 tmpdir = getenv("TMPDIR");
422 if (tmpdir == NULL) {
426 for (i = 0; i < 1000; i++) {
429 len = snprintf(linkname, MAX_UN_LEN + 1,
430 "%s/ovs-un-c-%"PRIu32, tmpdir, random_uint32());
431 error = (len < 0 || len > MAX_UN_LEN ? ENAMETOOLONG
432 : symlink(dir, linkname) ? errno
434 if (error != EEXIST) {
442 fatal_signal_add_file_to_unlink(linkname);
444 len = snprintf(short_name, MAX_UN_LEN + 1, "%s/%s", linkname, base);
445 if (len < 0 || len > MAX_UN_LEN) {
446 fatal_signal_unlink_file_now(linkname);
447 error = ENAMETOOLONG;
460 /* Stores in '*un' a sockaddr_un that refers to file 'name'. Stores in
461 * '*un_len' the size of the sockaddr_un.
463 * Returns 0 on success, otherwise a positive errno value.
465 * Uses '*dirfdp' and 'linkname' to store references to data when the caller no
466 * longer needs to use 'un'. On success, freeing these references with
467 * free_sockaddr_un() is mandatory to avoid a leak; on failure, freeing them is
468 * unnecessary but harmless. */
470 make_sockaddr_un(const char *name, struct sockaddr_un *un, socklen_t *un_len,
471 int *dirfdp, char linkname[MAX_UN_LEN + 1])
473 char short_name[MAX_UN_LEN + 1];
477 if (strlen(name) > MAX_UN_LEN) {
478 /* 'name' is too long to fit in a sockaddr_un. Try a workaround. */
479 int error = shorten_name_via_proc(name, short_name, dirfdp);
480 if (error == ENAMETOOLONG) {
481 error = shorten_name_via_symlink(name, short_name, linkname);
484 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
486 VLOG_WARN_RL(&rl, "Unix socket name %s is longer than maximum "
487 "%"PRIuSIZE" bytes", name, MAX_UN_LEN);
494 un->sun_family = AF_UNIX;
495 ovs_strzcpy(un->sun_path, name, sizeof un->sun_path);
496 *un_len = (offsetof(struct sockaddr_un, sun_path)
497 + strlen (un->sun_path) + 1);
501 /* Clean up after make_sockaddr_un(). */
503 free_sockaddr_un(int dirfd, const char *linkname)
509 fatal_signal_unlink_file_now(linkname);
513 /* Binds Unix domain socket 'fd' to a file with permissions 0700. */
515 bind_unix_socket(int fd, struct sockaddr *sun, socklen_t sun_len)
517 /* According to _Unix Network Programming_, umask should affect bind(). */
518 mode_t old_umask = umask(0077);
519 int error = bind(fd, sun, sun_len) ? errno : 0;
524 /* Creates a Unix domain socket in the given 'style' (either SOCK_DGRAM or
525 * SOCK_STREAM) that is bound to '*bind_path' (if 'bind_path' is non-null) and
526 * connected to '*connect_path' (if 'connect_path' is non-null). If 'nonblock'
527 * is true, the socket is made non-blocking.
529 * Returns the socket's fd if successful, otherwise a negative errno value. */
531 make_unix_socket(int style, bool nonblock,
532 const char *bind_path, const char *connect_path)
537 fd = socket(PF_UNIX, style, 0);
542 /* Set nonblocking mode right away, if we want it. This prevents blocking
543 * in connect(), if connect_path != NULL. (In turn, that's a corner case:
544 * it will only happen if style is SOCK_STREAM or SOCK_SEQPACKET, and only
545 * if a backlog of un-accepted connections has built up in the kernel.) */
547 error = set_nonblocking(fd);
554 char linkname[MAX_UN_LEN + 1];
555 struct sockaddr_un un;
559 if (unlink(bind_path) && errno != ENOENT) {
560 VLOG_WARN("unlinking \"%s\": %s\n",
561 bind_path, ovs_strerror(errno));
563 fatal_signal_add_file_to_unlink(bind_path);
565 error = make_sockaddr_un(bind_path, &un, &un_len, &dirfd, linkname);
567 error = bind_unix_socket(fd, (struct sockaddr *) &un, un_len);
569 free_sockaddr_un(dirfd, linkname);
577 char linkname[MAX_UN_LEN + 1];
578 struct sockaddr_un un;
582 error = make_sockaddr_un(connect_path, &un, &un_len, &dirfd, linkname);
584 && connect(fd, (struct sockaddr*) &un, un_len)
585 && errno != EINPROGRESS) {
588 free_sockaddr_un(dirfd, linkname);
598 if (error == EAGAIN) {
602 fatal_signal_unlink_file_now(bind_path);
609 get_unix_name_len(socklen_t sun_len)
611 return (sun_len >= offsetof(struct sockaddr_un, sun_path)
612 ? sun_len - offsetof(struct sockaddr_un, sun_path)
617 guess_netmask(ovs_be32 ip_)
619 uint32_t ip = ntohl(ip_);
620 return ((ip >> 31) == 0 ? htonl(0xff000000) /* Class A */
621 : (ip >> 30) == 2 ? htonl(0xffff0000) /* Class B */
622 : (ip >> 29) == 6 ? htonl(0xffffff00) /* Class C */
623 : htonl(0)); /* ??? */
626 /* This is like strsep() except:
628 * - The separator string is ":".
630 * - Square brackets [] quote ":" separators and are removed from the
633 parse_bracketed_token(char **pp)
639 } else if (*p == '\0') {
642 } else if (*p == '[') {
644 char *end = start + strcspn(start, "]");
645 *pp = (*end == '\0' ? NULL
646 : end[1] == ':' ? end + 2
652 char *end = start + strcspn(start, ":");
653 *pp = *end == '\0' ? NULL : end + 1;
660 parse_sockaddr_components(struct sockaddr_storage *ss,
662 const char *port_s, uint16_t default_port,
665 struct sockaddr_in *sin = ALIGNED_CAST(struct sockaddr_in *, ss);
668 if (port_s && port_s[0]) {
669 if (!str_to_int(port_s, 10, &port) || port < 0 || port > 65535) {
670 VLOG_ERR("%s: bad port number \"%s\"", s, port_s);
676 memset(ss, 0, sizeof *ss);
677 if (strchr(host_s, ':')) {
678 struct sockaddr_in6 *sin6
679 = ALIGNED_CAST(struct sockaddr_in6 *, ss);
681 sin6->sin6_family = AF_INET6;
682 sin6->sin6_port = htons(port);
683 if (!inet_pton(AF_INET6, host_s, sin6->sin6_addr.s6_addr)) {
684 VLOG_ERR("%s: bad IPv6 address \"%s\"", s, host_s);
688 sin->sin_family = AF_INET;
689 sin->sin_port = htons(port);
690 if (!inet_pton(AF_INET, host_s, &sin->sin_addr.s_addr)) {
691 VLOG_ERR("%s: bad IPv4 address \"%s\"", s, host_s);
699 memset(ss, 0, sizeof *ss);
703 /* Parses 'target', which should be a string in the format "<host>[:<port>]".
704 * <host>, which is required, may be an IPv4 address or an IPv6 address
705 * enclosed in square brackets. If 'default_port' is nonzero then <port> is
706 * optional and defaults to 'default_port'.
708 * On success, returns true and stores the parsed remote address into '*ss'.
709 * On failure, logs an error, stores zeros into '*ss', and returns false. */
711 inet_parse_active(const char *target_, uint16_t default_port,
712 struct sockaddr_storage *ss)
714 char *target = xstrdup(target_);
721 host = parse_bracketed_token(&p);
722 port = parse_bracketed_token(&p);
724 VLOG_ERR("%s: host must be specified", target_);
726 } else if (!port && !default_port) {
727 VLOG_ERR("%s: port must be specified", target_);
730 ok = parse_sockaddr_components(ss, host, port, default_port, target_);
733 memset(ss, 0, sizeof *ss);
740 /* Opens a non-blocking IPv4 or IPv6 socket of the specified 'style' and
741 * connects to 'target', which should be a string in the format
742 * "<host>[:<port>]". <host>, which is required, may be an IPv4 address or an
743 * IPv6 address enclosed in square brackets. If 'default_port' is nonzero then
744 * <port> is optional and defaults to 'default_port'.
746 * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
748 * On success, returns 0 (indicating connection complete) or EAGAIN (indicating
749 * connection in progress), in which case the new file descriptor is stored
750 * into '*fdp'. On failure, returns a positive errno value other than EAGAIN
751 * and stores -1 into '*fdp'.
753 * If 'ss' is non-null, then on success stores the target address into '*ss'.
755 * 'dscp' becomes the DSCP bits in the IP headers for the new connection. It
756 * should be in the range [0, 63] and will automatically be shifted to the
757 * appropriately place in the IP tos field. */
759 inet_open_active(int style, const char *target, uint16_t default_port,
760 struct sockaddr_storage *ssp, int *fdp, uint8_t dscp)
762 struct sockaddr_storage ss;
767 if (!inet_parse_active(target, default_port, &ss)) {
768 error = EAFNOSUPPORT;
772 /* Create non-blocking socket. */
773 fd = socket(ss.ss_family, style, 0);
775 error = sock_errno();
776 VLOG_ERR("%s: socket: %s", target, sock_strerror(error));
779 error = set_nonblocking(fd);
784 /* The dscp bits must be configured before connect() to ensure that the
785 * TOS field is set during the connection establishment. If set after
786 * connect(), the handshake SYN frames will be sent with a TOS of 0. */
787 error = set_dscp(fd, dscp);
789 VLOG_ERR("%s: socket: %s", target, sock_strerror(error));
794 error = connect(fd, (struct sockaddr *) &ss, ss_length(&ss)) == 0
797 if (error == EINPROGRESS
799 || error == WSAEALREADY || error == WSAEWOULDBLOCK
806 if (error && error != EAGAIN) {
808 memset(ssp, 0, sizeof *ssp);
823 /* Parses 'target', which should be a string in the format "[<port>][:<host>]":
825 * - If 'default_port' is -1, then <port> is required. Otherwise, if
826 * <port> is omitted, then 'default_port' is used instead.
828 * - If <port> (or 'default_port', if used) is 0, then no port is bound
829 * and the TCP/IP stack will select a port.
831 * - <host> is optional. If supplied, it may be an IPv4 address or an
832 * IPv6 address enclosed in square brackets. If omitted, the IP address
835 * If successful, stores the address into '*ss' and returns true; otherwise
836 * zeros '*ss' and returns false. */
838 inet_parse_passive(const char *target_, int default_port,
839 struct sockaddr_storage *ss)
841 char *target = xstrdup(target_);
848 port = parse_bracketed_token(&p);
849 host = parse_bracketed_token(&p);
850 if (!port && default_port < 0) {
851 VLOG_ERR("%s: port must be specified", target_);
854 ok = parse_sockaddr_components(ss, host ? host : "0.0.0.0",
855 port, default_port, target_);
858 memset(ss, 0, sizeof *ss);
865 /* Opens a non-blocking IPv4 or IPv6 socket of the specified 'style', binds to
866 * 'target', and listens for incoming connections. Parses 'target' in the same
867 * way was inet_parse_passive().
869 * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
871 * For TCP, the socket will have SO_REUSEADDR turned on.
873 * On success, returns a non-negative file descriptor. On failure, returns a
874 * negative errno value.
876 * If 'ss' is non-null, then on success stores the bound address into '*ss'.
878 * 'dscp' becomes the DSCP bits in the IP headers for the new connection. It
879 * should be in the range [0, 63] and will automatically be shifted to the
880 * appropriately place in the IP tos field. */
882 inet_open_passive(int style, const char *target, int default_port,
883 struct sockaddr_storage *ssp, uint8_t dscp)
885 bool kernel_chooses_port;
886 struct sockaddr_storage ss;
888 unsigned int yes = 1;
890 if (!inet_parse_passive(target, default_port, &ss)) {
891 return -EAFNOSUPPORT;
893 kernel_chooses_port = ss_get_port(&ss) == 0;
895 /* Create non-blocking socket, set SO_REUSEADDR. */
896 fd = socket(ss.ss_family, style, 0);
898 error = sock_errno();
899 VLOG_ERR("%s: socket: %s", target, sock_strerror(error));
902 error = set_nonblocking(fd);
906 if (style == SOCK_STREAM
907 && setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof yes) < 0) {
908 error = sock_errno();
909 VLOG_ERR("%s: setsockopt(SO_REUSEADDR): %s",
910 target, sock_strerror(error));
915 if (bind(fd, (struct sockaddr *) &ss, ss_length(&ss)) < 0) {
916 error = sock_errno();
917 VLOG_ERR("%s: bind: %s", target, sock_strerror(error));
921 /* The dscp bits must be configured before connect() to ensure that the TOS
922 * field is set during the connection establishment. If set after
923 * connect(), the handshake SYN frames will be sent with a TOS of 0. */
924 error = set_dscp(fd, dscp);
926 VLOG_ERR("%s: socket: %s", target, sock_strerror(error));
931 if (style == SOCK_STREAM && listen(fd, 10) < 0) {
932 error = sock_errno();
933 VLOG_ERR("%s: listen: %s", target, sock_strerror(error));
937 if (ssp || kernel_chooses_port) {
938 socklen_t ss_len = sizeof ss;
939 if (getsockname(fd, (struct sockaddr *) &ss, &ss_len) < 0) {
940 error = sock_errno();
941 VLOG_ERR("%s: getsockname: %s", target, sock_strerror(error));
944 if (kernel_chooses_port) {
945 VLOG_INFO("%s: listening on port %"PRIu16,
946 target, ss_get_port(&ss));
957 memset(ssp, 0, sizeof *ssp);
963 /* Returns a readable and writable fd for /dev/null, if successful, otherwise
964 * a negative errno value. The caller must not close the returned fd (because
965 * the same fd will be handed out to subsequent callers). */
969 static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
972 if (ovsthread_once_start(&once)) {
973 null_fd = open("/dev/null", O_RDWR);
976 VLOG_ERR("could not open /dev/null: %s", ovs_strerror(error));
979 ovsthread_once_done(&once);
986 read_fully(int fd, void *p_, size_t size, size_t *bytes_read)
992 ssize_t retval = read(fd, p, size);
994 *bytes_read += retval;
997 } else if (retval == 0) {
999 } else if (errno != EINTR) {
1007 write_fully(int fd, const void *p_, size_t size, size_t *bytes_written)
1009 const uint8_t *p = p_;
1013 ssize_t retval = write(fd, p, size);
1015 *bytes_written += retval;
1018 } else if (retval == 0) {
1019 VLOG_WARN("write returned 0");
1021 } else if (errno != EINTR) {
1028 /* Given file name 'file_name', fsyncs the directory in which it is contained.
1029 * Returns 0 if successful, otherwise a positive errno value. */
1031 fsync_parent_dir(const char *file_name)
1037 dir = dir_name(file_name);
1038 fd = open(dir, O_RDONLY);
1041 if (errno == EINVAL || errno == EROFS) {
1042 /* This directory does not support synchronization. Not
1043 * really an error. */
1046 VLOG_ERR("%s: fsync failed (%s)", dir, ovs_strerror(error));
1052 VLOG_ERR("%s: open failed (%s)", dir, ovs_strerror(error));
1059 /* Obtains the modification time of the file named 'file_name' to the greatest
1060 * supported precision. If successful, stores the mtime in '*mtime' and
1061 * returns 0. On error, returns a positive errno value and stores zeros in
1064 get_mtime(const char *file_name, struct timespec *mtime)
1068 if (!stat(file_name, &s)) {
1069 mtime->tv_sec = s.st_mtime;
1071 #if HAVE_STRUCT_STAT_ST_MTIM_TV_NSEC
1072 mtime->tv_nsec = s.st_mtim.tv_nsec;
1073 #elif HAVE_STRUCT_STAT_ST_MTIMENSEC
1074 mtime->tv_nsec = s.st_mtimensec;
1081 mtime->tv_sec = mtime->tv_nsec = 0;
1090 VLOG_FATAL("failed to create pipe (%s)", ovs_strerror(errno));
1095 xpipe_nonblocking(int fds[2])
1098 xset_nonblocking(fds[0]);
1099 xset_nonblocking(fds[1]);
1103 getsockopt_int(int fd, int level, int option, const char *optname, int *valuep)
1105 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
1111 if (getsockopt(fd, level, option, &value, &len)) {
1112 error = sock_errno();
1113 VLOG_ERR_RL(&rl, "getsockopt(%s): %s", optname, sock_strerror(error));
1114 } else if (len != sizeof value) {
1116 VLOG_ERR_RL(&rl, "getsockopt(%s): value is %u bytes (expected %"PRIuSIZE")",
1117 optname, (unsigned int) len, sizeof value);
1122 *valuep = error ? 0 : value;
1127 describe_sockaddr(struct ds *string, int fd,
1128 int (*getaddr)(int, struct sockaddr *, socklen_t *))
1130 struct sockaddr_storage ss;
1131 socklen_t len = sizeof ss;
1133 if (!getaddr(fd, (struct sockaddr *) &ss, &len)) {
1134 if (ss.ss_family == AF_INET || ss.ss_family == AF_INET6) {
1135 char addrbuf[SS_NTOP_BUFSIZE];
1137 ds_put_format(string, "%s:%"PRIu16,
1138 ss_format_address(&ss, addrbuf, sizeof addrbuf),
1140 } else if (ss.ss_family == AF_UNIX) {
1141 struct sockaddr_un sun;
1145 memcpy(&sun, &ss, sizeof sun);
1146 maxlen = len - offsetof(struct sockaddr_un, sun_path);
1147 null = memchr(sun.sun_path, '\0', maxlen);
1148 ds_put_buffer(string, sun.sun_path,
1149 null ? null - sun.sun_path : maxlen);
1152 else if (ss.ss_family == AF_NETLINK) {
1155 /* SO_PROTOCOL was introduced in 2.6.32. Support it regardless of the version
1156 * of the Linux kernel headers in use at build time. */
1158 #define SO_PROTOCOL 38
1161 if (!getsockopt_int(fd, SOL_SOCKET, SO_PROTOCOL, "SO_PROTOCOL",
1165 ds_put_cstr(string, "NETLINK_ROUTE");
1168 case NETLINK_GENERIC:
1169 ds_put_cstr(string, "NETLINK_GENERIC");
1173 ds_put_format(string, "AF_NETLINK family %d", protocol);
1177 ds_put_cstr(string, "AF_NETLINK");
1181 #if AF_PACKET && LINUX_DATAPATH
1182 else if (ss.ss_family == AF_PACKET) {
1183 struct sockaddr_ll sll;
1185 memcpy(&sll, &ss, sizeof sll);
1186 ds_put_cstr(string, "AF_PACKET");
1187 if (sll.sll_ifindex) {
1188 char name[IFNAMSIZ];
1190 if (if_indextoname(sll.sll_ifindex, name)) {
1191 ds_put_format(string, "(%s)", name);
1193 ds_put_format(string, "(ifindex=%d)", sll.sll_ifindex);
1196 if (sll.sll_protocol) {
1197 ds_put_format(string, "(protocol=0x%"PRIu16")",
1198 ntohs(sll.sll_protocol));
1202 else if (ss.ss_family == AF_UNSPEC) {
1203 ds_put_cstr(string, "AF_UNSPEC");
1205 ds_put_format(string, "AF_%d", (int) ss.ss_family);
1211 #ifdef LINUX_DATAPATH
1213 put_fd_filename(struct ds *string, int fd)
1219 linkname = xasprintf("/proc/self/fd/%d", fd);
1220 n = readlink(linkname, buf, sizeof buf);
1222 ds_put_char(string, ' ');
1223 ds_put_buffer(string, buf, n);
1224 if (n > sizeof buf) {
1225 ds_put_cstr(string, "...");
1232 /* Returns a malloc()'d string describing 'fd', for use in logging. */
1240 if (fstat(fd, &s)) {
1241 ds_put_format(&string, "fstat failed (%s)", ovs_strerror(errno));
1242 } else if (S_ISSOCK(s.st_mode)) {
1243 describe_sockaddr(&string, fd, getsockname);
1244 ds_put_cstr(&string, "<->");
1245 describe_sockaddr(&string, fd, getpeername);
1247 ds_put_cstr(&string, (isatty(fd) ? "tty"
1248 : S_ISDIR(s.st_mode) ? "directory"
1249 : S_ISCHR(s.st_mode) ? "character device"
1250 : S_ISBLK(s.st_mode) ? "block device"
1251 : S_ISREG(s.st_mode) ? "file"
1252 : S_ISFIFO(s.st_mode) ? "FIFO"
1253 : S_ISLNK(s.st_mode) ? "symbolic link"
1255 #ifdef LINUX_DATAPATH
1256 put_fd_filename(&string, fd);
1259 return ds_steal_cstr(&string);
1262 /* Calls ioctl() on an AF_INET sock, passing the specified 'command' and
1263 * 'arg'. Returns 0 if successful, otherwise a positive errno value. */
1265 af_inet_ioctl(unsigned long int command, const void *arg)
1267 static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
1270 if (ovsthread_once_start(&once)) {
1271 sock = socket(AF_INET, SOCK_DGRAM, 0);
1273 int error = sock_errno();
1274 VLOG_ERR("failed to create inet socket: %s", sock_strerror(error));
1277 ovsthread_once_done(&once);
1280 return (sock < 0 ? -sock
1281 : ioctl(sock, command, arg) == -1 ? errno
1286 af_inet_ifreq_ioctl(const char *name, struct ifreq *ifr, unsigned long int cmd,
1287 const char *cmd_name)
1291 ovs_strzcpy(ifr->ifr_name, name, sizeof ifr->ifr_name);
1292 error = af_inet_ioctl(cmd, ifr);
1294 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
1295 VLOG_DBG_RL(&rl, "%s: ioctl(%s) failed: %s", name, cmd_name,
1296 ovs_strerror(error));
1301 /* sockaddr_storage helpers. */
1303 /* Returns the IPv4 or IPv6 port in 'ss'. */
1305 ss_get_port(const struct sockaddr_storage *ss)
1307 if (ss->ss_family == AF_INET) {
1308 const struct sockaddr_in *sin
1309 = ALIGNED_CAST(const struct sockaddr_in *, ss);
1310 return ntohs(sin->sin_port);
1311 } else if (ss->ss_family == AF_INET6) {
1312 const struct sockaddr_in6 *sin6
1313 = ALIGNED_CAST(const struct sockaddr_in6 *, ss);
1314 return ntohs(sin6->sin6_port);
1320 /* Formats the IPv4 or IPv6 address in 'ss' into the 'bufsize' bytes in 'buf'.
1321 * If 'ss' is an IPv6 address, puts square brackets around the address.
1322 * 'bufsize' should be at least SS_NTOP_BUFSIZE.
1326 ss_format_address(const struct sockaddr_storage *ss,
1327 char *buf, size_t bufsize)
1329 ovs_assert(bufsize >= SS_NTOP_BUFSIZE);
1330 if (ss->ss_family == AF_INET) {
1331 const struct sockaddr_in *sin
1332 = ALIGNED_CAST(const struct sockaddr_in *, ss);
1334 snprintf(buf, bufsize, IP_FMT, IP_ARGS(sin->sin_addr.s_addr));
1335 } else if (ss->ss_family == AF_INET6) {
1336 const struct sockaddr_in6 *sin6
1337 = ALIGNED_CAST(const struct sockaddr_in6 *, ss);
1340 inet_ntop(AF_INET6, sin6->sin6_addr.s6_addr, buf + 1, bufsize - 1);
1341 strcpy(strchr(buf, '\0'), "]");
1350 ss_length(const struct sockaddr_storage *ss)
1352 switch (ss->ss_family) {
1354 return sizeof(struct sockaddr_in);
1357 return sizeof(struct sockaddr_in6);
1364 /* For Windows socket calls, 'errno' is not set. One has to call
1365 * WSAGetLastError() to get the error number and then pass it to
1366 * this function to get the correct error string.
1368 * ovs_strerror() calls strerror_r() and would not get the correct error
1369 * string for Windows sockets, but is good for POSIX. */
1371 sock_strerror(int error)
1374 return ovs_format_message(error);
1376 return ovs_strerror(error);