/*
- * Copyright (c) 2008, 2009 Nicira Networks.
+ * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#include <arpa/inet.h>
#include <errno.h>
#include <fcntl.h>
+#include <net/if.h>
#include <netdb.h>
#include <poll.h>
#include <stddef.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
+#include <sys/ioctl.h>
#include <sys/resource.h>
+#include <sys/socket.h>
+#include <sys/stat.h>
+#include <sys/uio.h>
#include <sys/un.h>
#include <unistd.h>
+#include "dynamic-string.h"
#include "fatal-signal.h"
+#include "packets.h"
+#include "poll-loop.h"
#include "util.h"
-
#include "vlog.h"
-#define THIS_MODULE VLM_socket_util
+#if AF_PACKET && LINUX_DATAPATH
+#include <linux/if_packet.h>
+#endif
+#ifdef HAVE_NETLINK
+#include "netlink-protocol.h"
+#include "netlink-socket.h"
+#endif
+
+VLOG_DEFINE_THIS_MODULE(socket_util);
+
+/* #ifdefs make it a pain to maintain code: you have to try to build both ways.
+ * Thus, this file compiles all of the code regardless of the target, by
+ * writing "if (LINUX_DATAPATH)" instead of "#ifdef __linux__". */
+#ifndef LINUX_DATAPATH
+#define LINUX_DATAPATH 0
+#endif
+
+#ifndef O_DIRECTORY
+#define O_DIRECTORY 0
+#endif
+
+/* Maximum length of the sun_path member in a struct sockaddr_un, excluding
+ * space for a null terminator. */
+#define MAX_UN_LEN (sizeof(((struct sockaddr_un *) 0)->sun_path) - 1)
+
+static int getsockopt_int(int fd, int level, int option, const char *optname,
+ int *valuep);
/* Sets 'fd' to non-blocking mode. Returns 0 if successful, otherwise a
* positive errno value. */
if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) != -1) {
return 0;
} else {
- VLOG_ERR("fcntl(F_SETFL) failed: %s", strerror(errno));
+ VLOG_ERR("fcntl(F_SETFL) failed: %s", ovs_strerror(errno));
return errno;
}
} else {
- VLOG_ERR("fcntl(F_GETFL) failed: %s", strerror(errno));
+ VLOG_ERR("fcntl(F_GETFL) failed: %s", ovs_strerror(errno));
+ return errno;
+ }
+}
+
+void
+xset_nonblocking(int fd)
+{
+ if (set_nonblocking(fd)) {
+ exit(EXIT_FAILURE);
+ }
+}
+
+int
+set_dscp(int fd, uint8_t dscp)
+{
+ int val;
+
+ if (dscp > 63) {
+ return EINVAL;
+ }
+
+ val = dscp << 2;
+ if (setsockopt(fd, IPPROTO_IP, IP_TOS, &val, sizeof val)) {
return errno;
}
+
+ return 0;
+}
+
+static bool
+rlim_is_finite(rlim_t limit)
+{
+ if (limit == RLIM_INFINITY) {
+ return false;
+ }
+
+#ifdef RLIM_SAVED_CUR /* FreeBSD 8.0 lacks RLIM_SAVED_CUR. */
+ if (limit == RLIM_SAVED_CUR) {
+ return false;
+ }
+#endif
+
+#ifdef RLIM_SAVED_MAX /* FreeBSD 8.0 lacks RLIM_SAVED_MAX. */
+ if (limit == RLIM_SAVED_MAX) {
+ return false;
+ }
+#endif
+
+ return true;
}
/* Returns the maximum valid FD value, plus 1. */
int
get_max_fds(void)
{
- static int max_fds = -1;
- if (max_fds < 0) {
+ static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
+ static int max_fds;
+
+ if (ovsthread_once_start(&once)) {
struct rlimit r;
- if (!getrlimit(RLIMIT_NOFILE, &r)
- && r.rlim_cur != RLIM_INFINITY
- && r.rlim_cur != RLIM_SAVED_MAX
- && r.rlim_cur != RLIM_SAVED_CUR) {
+ if (!getrlimit(RLIMIT_NOFILE, &r) && rlim_is_finite(r.rlim_cur)) {
max_fds = r.rlim_cur;
} else {
VLOG_WARN("failed to obtain fd limit, defaulting to 1024");
max_fds = 1024;
}
+ ovsthread_once_done(&once);
}
+
return max_fds;
}
* address, into a numeric IP address in '*addr'. Returns 0 if successful,
* otherwise a positive errno value. */
int
-lookup_ip(const char *host_name, struct in_addr *addr)
+lookup_ip(const char *host_name, struct in_addr *addr)
{
if (!inet_aton(host_name, addr)) {
- struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
+ static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
VLOG_ERR_RL(&rl, "\"%s\" is not a valid IP address", host_name);
return ENOENT;
}
return 0;
}
-/* Returns the error condition associated with socket 'fd' and resets the
- * socket's error status. */
+/* Translates 'host_name', which must be a string representation of an IPv6
+ * address, into a numeric IPv6 address in '*addr'. Returns 0 if successful,
+ * otherwise a positive errno value. */
int
-get_socket_error(int fd)
+lookup_ipv6(const char *host_name, struct in6_addr *addr)
{
- int error;
- socklen_t len = sizeof(error);
- if (getsockopt(fd, SOL_SOCKET, SO_ERROR, &error, &len) < 0) {
- struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
- error = errno;
- VLOG_ERR_RL(&rl, "getsockopt(SO_ERROR): %s", strerror(error));
+ if (inet_pton(AF_INET6, host_name, addr) != 1) {
+ static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
+ VLOG_ERR_RL(&rl, "\"%s\" is not a valid IPv6 address", host_name);
+ return ENOENT;
+ }
+ return 0;
+}
+
+/* Translates 'host_name', which must be a host name or a string representation
+ * of an IP address, into a numeric IP address in '*addr'. Returns 0 if
+ * successful, otherwise a positive errno value.
+ *
+ * Most Open vSwitch code should not use this because it causes deadlocks:
+ * getaddrinfo() sends out a DNS request but that starts a new flow for which
+ * OVS must set up a flow, but it can't because it's waiting for a DNS reply.
+ * The synchronous lookup also delays other activity. (Of course we can solve
+ * this but it doesn't seem worthwhile quite yet.) */
+int
+lookup_hostname(const char *host_name, struct in_addr *addr)
+{
+ struct addrinfo *result;
+ struct addrinfo hints;
+
+ if (inet_aton(host_name, addr)) {
+ return 0;
+ }
+
+ memset(&hints, 0, sizeof hints);
+ hints.ai_family = AF_INET;
+
+ switch (getaddrinfo(host_name, NULL, &hints, &result)) {
+ case 0:
+ *addr = ALIGNED_CAST(struct sockaddr_in *,
+ result->ai_addr)->sin_addr;
+ freeaddrinfo(result);
+ return 0;
+
+#ifdef EAI_ADDRFAMILY
+ case EAI_ADDRFAMILY:
+#endif
+ case EAI_NONAME:
+ case EAI_SERVICE:
+ return ENOENT;
+
+ case EAI_AGAIN:
+ return EAGAIN;
+
+ case EAI_BADFLAGS:
+ case EAI_FAMILY:
+ case EAI_SOCKTYPE:
+ return EINVAL;
+
+ case EAI_FAIL:
+ return EIO;
+
+ case EAI_MEMORY:
+ return ENOMEM;
+
+#ifdef EAI_NODATA
+ case EAI_NODATA:
+ return ENXIO;
+#endif
+
+ case EAI_SYSTEM:
+ return errno;
+
+ default:
+ return EPROTO;
}
- return error;
}
int
-check_connection_completion(int fd)
+check_connection_completion(int fd)
{
+ static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
struct pollfd pfd;
int retval;
retval = poll(&pfd, 1, 0);
} while (retval < 0 && errno == EINTR);
if (retval == 1) {
- return get_socket_error(fd);
+ if (pfd.revents & POLLERR) {
+ ssize_t n = send(fd, "", 1, MSG_DONTWAIT);
+ if (n < 0) {
+ return errno;
+ } else {
+ VLOG_ERR_RL(&rl, "poll return POLLERR but send succeeded");
+ return EPROTO;
+ }
+ }
+ return 0;
} else if (retval < 0) {
- static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
- VLOG_ERR_RL(&rl, "poll: %s", strerror(errno));
+ VLOG_ERR_RL(&rl, "poll: %s", ovs_strerror(errno));
return errno;
} else {
return EAGAIN;
int
drain_rcvbuf(int fd)
{
- socklen_t rcvbuf_len;
- size_t rcvbuf;
+ int rcvbuf;
- rcvbuf_len = sizeof rcvbuf;
- if (getsockopt(fd, SOL_SOCKET, SO_RCVBUF, &rcvbuf, &rcvbuf_len) < 0) {
- static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
- VLOG_ERR_RL(&rl, "getsockopt(SO_RCVBUF) failed: %s", strerror(errno));
- return errno;
+ rcvbuf = get_socket_rcvbuf(fd);
+ if (rcvbuf < 0) {
+ return -rcvbuf;
}
+
while (rcvbuf > 0) {
/* In Linux, specifying MSG_TRUNC in the flags argument causes the
* datagram length to be returned, even if that is longer than the
*
* On other Unix-like OSes, MSG_TRUNC has no effect in the flags
* argument. */
-#ifdef __linux__
-#define BUFFER_SIZE 1
-#else
-#define BUFFER_SIZE 2048
-#endif
- char buffer[BUFFER_SIZE];
+ char buffer[LINUX_DATAPATH ? 1 : 2048];
ssize_t n_bytes = recv(fd, buffer, sizeof buffer,
MSG_TRUNC | MSG_DONTWAIT);
if (n_bytes <= 0 || n_bytes >= rcvbuf) {
return 0;
}
+/* Returns the size of socket 'sock''s receive buffer (SO_RCVBUF), or a
+ * negative errno value if an error occurs. */
+int
+get_socket_rcvbuf(int sock)
+{
+ int rcvbuf;
+ int error;
+
+ error = getsockopt_int(sock, SOL_SOCKET, SO_RCVBUF, "SO_RCVBUF", &rcvbuf);
+ return error ? -error : rcvbuf;
+}
+
/* Reads and discards up to 'n' datagrams from 'fd', stopping as soon as no
* more data can be immediately read. ('fd' should therefore be in
* non-blocking mode.)*/
}
}
+/* Attempts to shorten 'name' by opening a file descriptor for the directory
+ * part of the name and indirecting through /proc/self/fd/<dirfd>/<basename>.
+ * On systems with Linux-like /proc, this works as long as <basename> isn't too
+ * long.
+ *
+ * On success, returns 0 and stores the short name in 'short_name' and a
+ * directory file descriptor to eventually be closed in '*dirfpd'. */
+static int
+shorten_name_via_proc(const char *name, char short_name[MAX_UN_LEN + 1],
+ int *dirfdp)
+{
+ char *dir, *base;
+ int dirfd;
+ int len;
+
+ if (!LINUX_DATAPATH) {
+ return ENAMETOOLONG;
+ }
+
+ dir = dir_name(name);
+ dirfd = open(dir, O_DIRECTORY | O_RDONLY);
+ if (dirfd < 0) {
+ static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
+ int error = errno;
+
+ VLOG_WARN_RL(&rl, "%s: open failed (%s)", dir, ovs_strerror(error));
+ free(dir);
+
+ return error;
+ }
+ free(dir);
+
+ base = base_name(name);
+ len = snprintf(short_name, MAX_UN_LEN + 1,
+ "/proc/self/fd/%d/%s", dirfd, base);
+ free(base);
+
+ if (len >= 0 && len <= MAX_UN_LEN) {
+ *dirfdp = dirfd;
+ return 0;
+ } else {
+ close(dirfd);
+ return ENAMETOOLONG;
+ }
+}
+
+/* Attempts to shorten 'name' by creating a symlink for the directory part of
+ * the name and indirecting through <symlink>/<basename>. This works on
+ * systems that support symlinks, as long as <basename> isn't too long.
+ *
+ * On success, returns 0 and stores the short name in 'short_name' and the
+ * symbolic link to eventually delete in 'linkname'. */
+static int
+shorten_name_via_symlink(const char *name, char short_name[MAX_UN_LEN + 1],
+ char linkname[MAX_UN_LEN + 1])
+{
+ char *abs, *dir, *base;
+ const char *tmpdir;
+ int error;
+ int i;
+
+ abs = abs_file_name(NULL, name);
+ dir = dir_name(abs);
+ base = base_name(abs);
+ free(abs);
+
+ tmpdir = getenv("TMPDIR");
+ if (tmpdir == NULL) {
+ tmpdir = "/tmp";
+ }
+
+ for (i = 0; i < 1000; i++) {
+ int len;
+
+ len = snprintf(linkname, MAX_UN_LEN + 1,
+ "%s/ovs-un-c-%"PRIu32, tmpdir, random_uint32());
+ error = (len < 0 || len > MAX_UN_LEN ? ENAMETOOLONG
+ : symlink(dir, linkname) ? errno
+ : 0);
+ if (error != EEXIST) {
+ break;
+ }
+ }
+
+ if (!error) {
+ int len;
+
+ fatal_signal_add_file_to_unlink(linkname);
+
+ len = snprintf(short_name, MAX_UN_LEN + 1, "%s/%s", linkname, base);
+ if (len < 0 || len > MAX_UN_LEN) {
+ fatal_signal_unlink_file_now(linkname);
+ error = ENAMETOOLONG;
+ }
+ }
+
+ if (error) {
+ linkname[0] = '\0';
+ }
+ free(dir);
+ free(base);
+
+ return error;
+}
+
/* Stores in '*un' a sockaddr_un that refers to file 'name'. Stores in
- * '*un_len' the size of the sockaddr_un. */
-static void
-make_sockaddr_un(const char *name, struct sockaddr_un* un, socklen_t *un_len)
+ * '*un_len' the size of the sockaddr_un.
+ *
+ * Returns 0 on success, otherwise a positive errno value.
+ *
+ * Uses '*dirfdp' and 'linkname' to store references to data when the caller no
+ * longer needs to use 'un'. On success, freeing these references with
+ * free_sockaddr_un() is mandatory to avoid a leak; on failure, freeing them is
+ * unnecessary but harmless. */
+static int
+make_sockaddr_un(const char *name, struct sockaddr_un *un, socklen_t *un_len,
+ int *dirfdp, char linkname[MAX_UN_LEN + 1])
{
+ char short_name[MAX_UN_LEN + 1];
+
+ *dirfdp = -1;
+ linkname[0] = '\0';
+ if (strlen(name) > MAX_UN_LEN) {
+ /* 'name' is too long to fit in a sockaddr_un. Try a workaround. */
+ int error = shorten_name_via_proc(name, short_name, dirfdp);
+ if (error == ENAMETOOLONG) {
+ error = shorten_name_via_symlink(name, short_name, linkname);
+ }
+ if (error) {
+ static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
+
+ VLOG_WARN_RL(&rl, "Unix socket name %s is longer than maximum "
+ "%"PRIuSIZE" bytes", name, MAX_UN_LEN);
+ return error;
+ }
+
+ name = short_name;
+ }
+
un->sun_family = AF_UNIX;
- strncpy(un->sun_path, name, sizeof un->sun_path);
- un->sun_path[sizeof un->sun_path - 1] = '\0';
+ ovs_strzcpy(un->sun_path, name, sizeof un->sun_path);
*un_len = (offsetof(struct sockaddr_un, sun_path)
+ strlen (un->sun_path) + 1);
+ return 0;
+}
+
+/* Clean up after make_sockaddr_un(). */
+static void
+free_sockaddr_un(int dirfd, const char *linkname)
+{
+ if (dirfd >= 0) {
+ close(dirfd);
+ }
+ if (linkname[0]) {
+ fatal_signal_unlink_file_now(linkname);
+ }
+}
+
+/* Binds Unix domain socket 'fd' to a file with permissions 0700. */
+static int
+bind_unix_socket(int fd, struct sockaddr *sun, socklen_t sun_len)
+{
+ /* According to _Unix Network Programming_, umask should affect bind(). */
+ mode_t old_umask = umask(0077);
+ int error = bind(fd, sun, sun_len) ? errno : 0;
+ umask(old_umask);
+ return error;
}
/* Creates a Unix domain socket in the given 'style' (either SOCK_DGRAM or
* SOCK_STREAM) that is bound to '*bind_path' (if 'bind_path' is non-null) and
* connected to '*connect_path' (if 'connect_path' is non-null). If 'nonblock'
- * is true, the socket is made non-blocking. If 'passcred' is true, the socket
- * is configured to receive SCM_CREDENTIALS control messages.
+ * is true, the socket is made non-blocking.
*
* Returns the socket's fd if successful, otherwise a negative errno value. */
int
-make_unix_socket(int style, bool nonblock, bool passcred UNUSED,
+make_unix_socket(int style, bool nonblock,
const char *bind_path, const char *connect_path)
{
int error;
* it will only happen if style is SOCK_STREAM or SOCK_SEQPACKET, and only
* if a backlog of un-accepted connections has built up in the kernel.) */
if (nonblock) {
- int flags = fcntl(fd, F_GETFL, 0);
- if (flags == -1) {
- goto error;
- }
- if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) == -1) {
+ error = set_nonblocking(fd);
+ if (error) {
goto error;
}
}
if (bind_path) {
+ char linkname[MAX_UN_LEN + 1];
struct sockaddr_un un;
socklen_t un_len;
- make_sockaddr_un(bind_path, &un, &un_len);
- if (unlink(un.sun_path) && errno != ENOENT) {
- VLOG_WARN("unlinking \"%s\": %s\n", un.sun_path, strerror(errno));
+ int dirfd;
+
+ if (unlink(bind_path) && errno != ENOENT) {
+ VLOG_WARN("unlinking \"%s\": %s\n",
+ bind_path, ovs_strerror(errno));
}
fatal_signal_add_file_to_unlink(bind_path);
- if (bind(fd, (struct sockaddr*) &un, un_len)
- || fchmod(fd, S_IRWXU)) {
+
+ error = make_sockaddr_un(bind_path, &un, &un_len, &dirfd, linkname);
+ if (!error) {
+ error = bind_unix_socket(fd, (struct sockaddr *) &un, un_len);
+ }
+ free_sockaddr_un(dirfd, linkname);
+
+ if (error) {
goto error;
}
}
if (connect_path) {
+ char linkname[MAX_UN_LEN + 1];
struct sockaddr_un un;
socklen_t un_len;
- make_sockaddr_un(connect_path, &un, &un_len);
- if (connect(fd, (struct sockaddr*) &un, un_len)
+ int dirfd;
+
+ error = make_sockaddr_un(connect_path, &un, &un_len, &dirfd, linkname);
+ if (!error
+ && connect(fd, (struct sockaddr*) &un, un_len)
&& errno != EINPROGRESS) {
- printf("connect failed with %s\n", strerror(errno));
- goto error;
+ error = errno;
}
- }
+ free_sockaddr_un(dirfd, linkname);
-#ifdef SCM_CREDENTIALS
- if (passcred) {
- int enable = 1;
- if (setsockopt(fd, SOL_SOCKET, SO_PASSCRED, &enable, sizeof(enable))) {
+ if (error) {
goto error;
}
}
-#endif
return fd;
error:
- error = errno == EAGAIN ? EPROTO : errno;
+ if (error == EAGAIN) {
+ error = EPROTO;
+ }
if (bind_path) {
- fatal_signal_remove_file_to_unlink(bind_path);
+ fatal_signal_unlink_file_now(bind_path);
}
close(fd);
return -error;
: 0);
}
-uint32_t
-guess_netmask(uint32_t ip)
+ovs_be32
+guess_netmask(ovs_be32 ip_)
{
- ip = ntohl(ip);
+ uint32_t ip = ntohl(ip_);
return ((ip >> 31) == 0 ? htonl(0xff000000) /* Class A */
: (ip >> 30) == 2 ? htonl(0xffff0000) /* Class B */
: (ip >> 29) == 6 ? htonl(0xffffff00) /* Class C */
: htonl(0)); /* ??? */
}
-/* Opens a non-blocking IPv4 socket of the specified 'style' and connects to
- * 'target', which should be a string in the format "<host>[:<port>]". <host>
- * is required. If 'default_port' is nonzero then <port> is optional and
- * defaults to 'default_port'.
+/* Parses 'target', which should be a string in the format "<host>[:<port>]".
+ * <host> is required. If 'default_port' is nonzero then <port> is optional
+ * and defaults to 'default_port'.
*
- * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
- *
- * On success, returns 0 (indicating connection complete) or EAGAIN (indicating
- * connection in progress), in which case the new file descriptor is stored
- * into '*fdp'. On failure, returns a positive errno value other than EAGAIN
- * and stores -1 into '*fdp'.
- *
- * If 'sinp' is non-null, then on success the target address is stored into
- * '*sinp'. */
-int
-inet_open_active(int style, const char *target_, uint16_t default_port,
- struct sockaddr_in *sinp, int *fdp)
+ * On success, returns true and stores the parsed remote address into '*sinp'.
+ * On failure, logs an error, stores zeros into '*sinp', and returns false. */
+bool
+inet_parse_active(const char *target_, uint16_t default_port,
+ struct sockaddr_in *sinp)
{
char *target = xstrdup(target_);
char *save_ptr = NULL;
const char *host_name;
const char *port_string;
- struct sockaddr_in sin;
- int fd = -1;
- int error;
+ bool ok = false;
/* Defaults. */
- memset(&sin, 0, sizeof sin);
- sin.sin_family = AF_INET;
- sin.sin_port = htons(default_port);
+ sinp->sin_family = AF_INET;
+ sinp->sin_port = htons(default_port);
/* Tokenize. */
host_name = strtok_r(target, ":", &save_ptr);
port_string = strtok_r(NULL, ":", &save_ptr);
if (!host_name) {
- ovs_error(0, "%s: bad peer name format", target_);
- error = EAFNOSUPPORT;
+ VLOG_ERR("%s: bad peer name format", target_);
goto exit;
}
/* Look up IP, port. */
- error = lookup_ip(host_name, &sin.sin_addr);
- if (error) {
+ if (lookup_ip(host_name, &sinp->sin_addr)) {
goto exit;
}
if (port_string && atoi(port_string)) {
- sin.sin_port = htons(atoi(port_string));
+ sinp->sin_port = htons(atoi(port_string));
} else if (!default_port) {
VLOG_ERR("%s: port number must be specified", target_);
+ goto exit;
+ }
+
+ ok = true;
+
+exit:
+ if (!ok) {
+ memset(sinp, 0, sizeof *sinp);
+ }
+ free(target);
+ return ok;
+}
+
+/* Opens a non-blocking IPv4 socket of the specified 'style' and connects to
+ * 'target', which should be a string in the format "<host>[:<port>]". <host>
+ * is required. If 'default_port' is nonzero then <port> is optional and
+ * defaults to 'default_port'.
+ *
+ * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
+ *
+ * On success, returns 0 (indicating connection complete) or EAGAIN (indicating
+ * connection in progress), in which case the new file descriptor is stored
+ * into '*fdp'. On failure, returns a positive errno value other than EAGAIN
+ * and stores -1 into '*fdp'.
+ *
+ * If 'sinp' is non-null, then on success the target address is stored into
+ * '*sinp'.
+ *
+ * 'dscp' becomes the DSCP bits in the IP headers for the new connection. It
+ * should be in the range [0, 63] and will automatically be shifted to the
+ * appropriately place in the IP tos field. */
+int
+inet_open_active(int style, const char *target, uint16_t default_port,
+ struct sockaddr_in *sinp, int *fdp, uint8_t dscp)
+{
+ struct sockaddr_in sin;
+ int fd = -1;
+ int error;
+
+ /* Parse. */
+ if (!inet_parse_active(target, default_port, &sin)) {
error = EAFNOSUPPORT;
goto exit;
}
/* Create non-blocking socket. */
fd = socket(AF_INET, style, 0);
if (fd < 0) {
- VLOG_ERR("%s: socket: %s", target_, strerror(errno));
+ VLOG_ERR("%s: socket: %s", target, ovs_strerror(errno));
error = errno;
goto exit;
}
error = set_nonblocking(fd);
if (error) {
- goto exit_close;
+ goto exit;
+ }
+
+ /* The dscp bits must be configured before connect() to ensure that the TOS
+ * field is set during the connection establishment. If set after
+ * connect(), the handshake SYN frames will be sent with a TOS of 0. */
+ error = set_dscp(fd, dscp);
+ if (error) {
+ VLOG_ERR("%s: socket: %s", target, ovs_strerror(error));
+ goto exit;
}
/* Connect. */
error = connect(fd, (struct sockaddr *) &sin, sizeof sin) == 0 ? 0 : errno;
if (error == EINPROGRESS) {
error = EAGAIN;
- } else if (error && error != EAGAIN) {
- goto exit_close;
}
- /* Success: error is 0 or EAGAIN. */
- goto exit;
-
-exit_close:
- close(fd);
exit:
if (!error || error == EAGAIN) {
if (sinp) {
*sinp = sin;
}
- *fdp = fd;
- } else {
- *fdp = -1;
+ } else if (fd >= 0) {
+ close(fd);
+ fd = -1;
}
- free(target);
+ *fdp = fd;
return error;
}
-/* Opens a non-blocking IPv4 socket of the specified 'style', binds to
- * 'target', and listens for incoming connections. 'target' should be a string
- * in the format "[<port>][:<ip>]". <port> may be omitted if 'default_port' is
- * nonzero, in which case it defaults to 'default_port'. If <ip> is omitted it
- * defaults to the wildcard IP address.
+/* Parses 'target', which should be a string in the format "[<port>][:<ip>]":
*
- * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
+ * - If 'default_port' is -1, then <port> is required. Otherwise, if
+ * <port> is omitted, then 'default_port' is used instead.
*
- * For TCP, the socket will have SO_REUSEADDR turned on.
+ * - If <port> (or 'default_port', if used) is 0, then no port is bound
+ * and the TCP/IP stack will select a port.
*
- * On success, returns a non-negative file descriptor. On failure, returns a
- * negative errno value. */
-int
-inet_open_passive(int style, const char *target_, uint16_t default_port)
+ * - If <ip> is omitted then the IP address is wildcarded.
+ *
+ * If successful, stores the address into '*sinp' and returns true; otherwise
+ * zeros '*sinp' and returns false. */
+bool
+inet_parse_passive(const char *target_, int default_port,
+ struct sockaddr_in *sinp)
{
char *target = xstrdup(target_);
char *string_ptr = target;
- struct sockaddr_in sin;
const char *host_name;
const char *port_string;
- int fd, error;
- unsigned int yes = 1;
+ bool ok = false;
+ int port;
/* Address defaults. */
- memset(&sin, 0, sizeof sin);
- sin.sin_family = AF_INET;
- sin.sin_addr.s_addr = htonl(INADDR_ANY);
- sin.sin_port = htons(default_port);
+ memset(sinp, 0, sizeof *sinp);
+ sinp->sin_family = AF_INET;
+ sinp->sin_addr.s_addr = htonl(INADDR_ANY);
+ sinp->sin_port = htons(default_port);
/* Parse optional port number. */
port_string = strsep(&string_ptr, ":");
- if (port_string && atoi(port_string)) {
- sin.sin_port = htons(atoi(port_string));
- } else if (!default_port) {
+ if (port_string && str_to_int(port_string, 10, &port)) {
+ sinp->sin_port = htons(port);
+ } else if (default_port < 0) {
VLOG_ERR("%s: port number must be specified", target_);
- error = EAFNOSUPPORT;
goto exit;
}
/* Parse optional bind IP. */
host_name = strsep(&string_ptr, ":");
- if (host_name && host_name[0]) {
- error = lookup_ip(host_name, &sin.sin_addr);
- if (error) {
- goto exit;
- }
+ if (host_name && host_name[0] && lookup_ip(host_name, &sinp->sin_addr)) {
+ goto exit;
+ }
+
+ ok = true;
+
+exit:
+ if (!ok) {
+ memset(sinp, 0, sizeof *sinp);
+ }
+ free(target);
+ return ok;
+}
+
+
+/* Opens a non-blocking IPv4 socket of the specified 'style', binds to
+ * 'target', and listens for incoming connections. Parses 'target' in the same
+ * way was inet_parse_passive().
+ *
+ * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
+ *
+ * For TCP, the socket will have SO_REUSEADDR turned on.
+ *
+ * On success, returns a non-negative file descriptor. On failure, returns a
+ * negative errno value.
+ *
+ * If 'sinp' is non-null, then on success the bound address is stored into
+ * '*sinp'.
+ *
+ * 'dscp' becomes the DSCP bits in the IP headers for the new connection. It
+ * should be in the range [0, 63] and will automatically be shifted to the
+ * appropriately place in the IP tos field. */
+int
+inet_open_passive(int style, const char *target, int default_port,
+ struct sockaddr_in *sinp, uint8_t dscp)
+{
+ bool kernel_chooses_port;
+ struct sockaddr_in sin;
+ int fd = 0, error;
+ unsigned int yes = 1;
+
+ if (!inet_parse_passive(target, default_port, &sin)) {
+ return -EAFNOSUPPORT;
}
/* Create non-blocking socket, set SO_REUSEADDR. */
fd = socket(AF_INET, style, 0);
if (fd < 0) {
error = errno;
- VLOG_ERR("%s: socket: %s", target_, strerror(error));
- goto exit;
+ VLOG_ERR("%s: socket: %s", target, ovs_strerror(error));
+ return -error;
}
error = set_nonblocking(fd);
if (error) {
- goto exit_close;
+ goto error;
}
if (style == SOCK_STREAM
&& setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof yes) < 0) {
error = errno;
- VLOG_ERR("%s: setsockopt(SO_REUSEADDR): %s", target_, strerror(error));
- goto exit_close;
+ VLOG_ERR("%s: setsockopt(SO_REUSEADDR): %s",
+ target, ovs_strerror(error));
+ goto error;
}
/* Bind. */
if (bind(fd, (struct sockaddr *) &sin, sizeof sin) < 0) {
error = errno;
- VLOG_ERR("%s: bind: %s", target_, strerror(error));
- goto exit_close;
+ VLOG_ERR("%s: bind: %s", target, ovs_strerror(error));
+ goto error;
+ }
+
+ /* The dscp bits must be configured before connect() to ensure that the TOS
+ * field is set during the connection establishment. If set after
+ * connect(), the handshake SYN frames will be sent with a TOS of 0. */
+ error = set_dscp(fd, dscp);
+ if (error) {
+ VLOG_ERR("%s: socket: %s", target, ovs_strerror(error));
+ goto error;
}
/* Listen. */
- if (listen(fd, 10) < 0) {
+ if (style == SOCK_STREAM && listen(fd, 10) < 0) {
error = errno;
- VLOG_ERR("%s: listen: %s", target_, strerror(error));
- goto exit_close;
+ VLOG_ERR("%s: listen: %s", target, ovs_strerror(error));
+ goto error;
}
- error = 0;
- goto exit;
-exit_close:
+ kernel_chooses_port = sin.sin_port == htons(0);
+ if (sinp || kernel_chooses_port) {
+ socklen_t sin_len = sizeof sin;
+ if (getsockname(fd, (struct sockaddr *) &sin, &sin_len) < 0) {
+ error = errno;
+ VLOG_ERR("%s: getsockname: %s", target, ovs_strerror(error));
+ goto error;
+ }
+ if (sin.sin_family != AF_INET || sin_len != sizeof sin) {
+ error = EAFNOSUPPORT;
+ VLOG_ERR("%s: getsockname: invalid socket name", target);
+ goto error;
+ }
+ if (sinp) {
+ *sinp = sin;
+ }
+ if (kernel_chooses_port) {
+ VLOG_INFO("%s: listening on port %"PRIu16,
+ target, ntohs(sin.sin_port));
+ }
+ }
+
+ return fd;
+
+error:
close(fd);
-exit:
- free(target);
- return error ? -error : fd;
+ return -error;
}
/* Returns a readable and writable fd for /dev/null, if successful, otherwise
int
get_null_fd(void)
{
- static int null_fd = -1;
- if (null_fd < 0) {
+ static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
+ static int null_fd;
+
+ if (ovsthread_once_start(&once)) {
null_fd = open("/dev/null", O_RDWR);
if (null_fd < 0) {
int error = errno;
- VLOG_ERR("could not open /dev/null: %s", strerror(error));
- return -error;
+ VLOG_ERR("could not open /dev/null: %s", ovs_strerror(error));
+ null_fd = -error;
}
+ ovsthread_once_done(&once);
}
+
return null_fd;
}
}
return 0;
}
+
+/* Given file name 'file_name', fsyncs the directory in which it is contained.
+ * Returns 0 if successful, otherwise a positive errno value. */
+int
+fsync_parent_dir(const char *file_name)
+{
+ int error = 0;
+ char *dir;
+ int fd;
+
+ dir = dir_name(file_name);
+ fd = open(dir, O_RDONLY);
+ if (fd >= 0) {
+ if (fsync(fd)) {
+ if (errno == EINVAL || errno == EROFS) {
+ /* This directory does not support synchronization. Not
+ * really an error. */
+ } else {
+ error = errno;
+ VLOG_ERR("%s: fsync failed (%s)", dir, ovs_strerror(error));
+ }
+ }
+ close(fd);
+ } else {
+ error = errno;
+ VLOG_ERR("%s: open failed (%s)", dir, ovs_strerror(error));
+ }
+ free(dir);
+
+ return error;
+}
+
+/* Obtains the modification time of the file named 'file_name' to the greatest
+ * supported precision. If successful, stores the mtime in '*mtime' and
+ * returns 0. On error, returns a positive errno value and stores zeros in
+ * '*mtime'. */
+int
+get_mtime(const char *file_name, struct timespec *mtime)
+{
+ struct stat s;
+
+ if (!stat(file_name, &s)) {
+ mtime->tv_sec = s.st_mtime;
+
+#if HAVE_STRUCT_STAT_ST_MTIM_TV_NSEC
+ mtime->tv_nsec = s.st_mtim.tv_nsec;
+#elif HAVE_STRUCT_STAT_ST_MTIMENSEC
+ mtime->tv_nsec = s.st_mtimensec;
+#else
+ mtime->tv_nsec = 0;
+#endif
+
+ return 0;
+ } else {
+ mtime->tv_sec = mtime->tv_nsec = 0;
+ return errno;
+ }
+}
+
+void
+xpipe(int fds[2])
+{
+ if (pipe(fds)) {
+ VLOG_FATAL("failed to create pipe (%s)", ovs_strerror(errno));
+ }
+}
+
+void
+xpipe_nonblocking(int fds[2])
+{
+ xpipe(fds);
+ xset_nonblocking(fds[0]);
+ xset_nonblocking(fds[1]);
+}
+
+static int
+getsockopt_int(int fd, int level, int option, const char *optname, int *valuep)
+{
+ static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
+ socklen_t len;
+ int value;
+ int error;
+
+ len = sizeof value;
+ if (getsockopt(fd, level, option, &value, &len)) {
+ error = errno;
+ VLOG_ERR_RL(&rl, "getsockopt(%s): %s", optname, ovs_strerror(error));
+ } else if (len != sizeof value) {
+ error = EINVAL;
+ VLOG_ERR_RL(&rl, "getsockopt(%s): value is %u bytes (expected %"PRIuSIZE")",
+ optname, (unsigned int) len, sizeof value);
+ } else {
+ error = 0;
+ }
+
+ *valuep = error ? 0 : value;
+ return error;
+}
+
+static void
+describe_sockaddr(struct ds *string, int fd,
+ int (*getaddr)(int, struct sockaddr *, socklen_t *))
+{
+ struct sockaddr_storage ss;
+ socklen_t len = sizeof ss;
+
+ if (!getaddr(fd, (struct sockaddr *) &ss, &len)) {
+ if (ss.ss_family == AF_INET) {
+ struct sockaddr_in sin;
+
+ memcpy(&sin, &ss, sizeof sin);
+ ds_put_format(string, IP_FMT":%"PRIu16,
+ IP_ARGS(sin.sin_addr.s_addr), ntohs(sin.sin_port));
+ } else if (ss.ss_family == AF_UNIX) {
+ struct sockaddr_un sun;
+ const char *null;
+ size_t maxlen;
+
+ memcpy(&sun, &ss, sizeof sun);
+ maxlen = len - offsetof(struct sockaddr_un, sun_path);
+ null = memchr(sun.sun_path, '\0', maxlen);
+ ds_put_buffer(string, sun.sun_path,
+ null ? null - sun.sun_path : maxlen);
+ }
+#ifdef HAVE_NETLINK
+ else if (ss.ss_family == AF_NETLINK) {
+ int protocol;
+
+/* SO_PROTOCOL was introduced in 2.6.32. Support it regardless of the version
+ * of the Linux kernel headers in use at build time. */
+#ifndef SO_PROTOCOL
+#define SO_PROTOCOL 38
+#endif
+
+ if (!getsockopt_int(fd, SOL_SOCKET, SO_PROTOCOL, "SO_PROTOCOL",
+ &protocol)) {
+ switch (protocol) {
+ case NETLINK_ROUTE:
+ ds_put_cstr(string, "NETLINK_ROUTE");
+ break;
+
+ case NETLINK_GENERIC:
+ ds_put_cstr(string, "NETLINK_GENERIC");
+ break;
+
+ default:
+ ds_put_format(string, "AF_NETLINK family %d", protocol);
+ break;
+ }
+ } else {
+ ds_put_cstr(string, "AF_NETLINK");
+ }
+ }
+#endif
+#if AF_PACKET && LINUX_DATAPATH
+ else if (ss.ss_family == AF_PACKET) {
+ struct sockaddr_ll sll;
+
+ memcpy(&sll, &ss, sizeof sll);
+ ds_put_cstr(string, "AF_PACKET");
+ if (sll.sll_ifindex) {
+ char name[IFNAMSIZ];
+
+ if (if_indextoname(sll.sll_ifindex, name)) {
+ ds_put_format(string, "(%s)", name);
+ } else {
+ ds_put_format(string, "(ifindex=%d)", sll.sll_ifindex);
+ }
+ }
+ if (sll.sll_protocol) {
+ ds_put_format(string, "(protocol=0x%"PRIu16")",
+ ntohs(sll.sll_protocol));
+ }
+ }
+#endif
+ else if (ss.ss_family == AF_UNSPEC) {
+ ds_put_cstr(string, "AF_UNSPEC");
+ } else {
+ ds_put_format(string, "AF_%d", (int) ss.ss_family);
+ }
+ }
+}
+
+
+#ifdef LINUX_DATAPATH
+static void
+put_fd_filename(struct ds *string, int fd)
+{
+ char buf[1024];
+ char *linkname;
+ int n;
+
+ linkname = xasprintf("/proc/self/fd/%d", fd);
+ n = readlink(linkname, buf, sizeof buf);
+ if (n > 0) {
+ ds_put_char(string, ' ');
+ ds_put_buffer(string, buf, n);
+ if (n > sizeof buf) {
+ ds_put_cstr(string, "...");
+ }
+ }
+ free(linkname);
+}
+#endif
+
+/* Returns a malloc()'d string describing 'fd', for use in logging. */
+char *
+describe_fd(int fd)
+{
+ struct ds string;
+ struct stat s;
+
+ ds_init(&string);
+ if (fstat(fd, &s)) {
+ ds_put_format(&string, "fstat failed (%s)", ovs_strerror(errno));
+ } else if (S_ISSOCK(s.st_mode)) {
+ describe_sockaddr(&string, fd, getsockname);
+ ds_put_cstr(&string, "<->");
+ describe_sockaddr(&string, fd, getpeername);
+ } else {
+ ds_put_cstr(&string, (isatty(fd) ? "tty"
+ : S_ISDIR(s.st_mode) ? "directory"
+ : S_ISCHR(s.st_mode) ? "character device"
+ : S_ISBLK(s.st_mode) ? "block device"
+ : S_ISREG(s.st_mode) ? "file"
+ : S_ISFIFO(s.st_mode) ? "FIFO"
+ : S_ISLNK(s.st_mode) ? "symbolic link"
+ : "unknown"));
+#ifdef LINUX_DATAPATH
+ put_fd_filename(&string, fd);
+#endif
+ }
+ return ds_steal_cstr(&string);
+}
+
+/* Calls ioctl() on an AF_INET sock, passing the specified 'command' and
+ * 'arg'. Returns 0 if successful, otherwise a positive errno value. */
+int
+af_inet_ioctl(unsigned long int command, const void *arg)
+{
+ static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
+ static int sock;
+
+ if (ovsthread_once_start(&once)) {
+ sock = socket(AF_INET, SOCK_DGRAM, 0);
+ if (sock < 0) {
+ sock = -errno;
+ VLOG_ERR("failed to create inet socket: %s", ovs_strerror(errno));
+ }
+ ovsthread_once_done(&once);
+ }
+
+ return (sock < 0 ? -sock
+ : ioctl(sock, command, arg) == -1 ? errno
+ : 0);
+}
+
+int
+af_inet_ifreq_ioctl(const char *name, struct ifreq *ifr, unsigned long int cmd,
+ const char *cmd_name)
+{
+ int error;
+
+ ovs_strzcpy(ifr->ifr_name, name, sizeof ifr->ifr_name);
+ error = af_inet_ioctl(cmd, ifr);
+ if (error) {
+ static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
+ VLOG_DBG_RL(&rl, "%s: ioctl(%s) failed: %s", name, cmd_name,
+ ovs_strerror(error));
+ }
+ return error;
+}
+