2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 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>
30 #include <sys/resource.h>
31 #include <sys/socket.h>
36 #include "dynamic-string.h"
37 #include "fatal-signal.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 static int getsockopt_int(int fd, int level, int option, const char *optname,
66 /* Sets 'fd' to non-blocking mode. Returns 0 if successful, otherwise a
67 * positive errno value. */
69 set_nonblocking(int fd)
71 int flags = fcntl(fd, F_GETFL, 0);
73 if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) != -1) {
76 VLOG_ERR("fcntl(F_SETFL) failed: %s", strerror(errno));
80 VLOG_ERR("fcntl(F_GETFL) failed: %s", strerror(errno));
86 xset_nonblocking(int fd)
88 if (set_nonblocking(fd)) {
94 set_dscp(int fd, uint8_t dscp)
103 if (setsockopt(fd, IPPROTO_IP, IP_TOS, &val, sizeof val)) {
111 rlim_is_finite(rlim_t limit)
113 if (limit == RLIM_INFINITY) {
117 #ifdef RLIM_SAVED_CUR /* FreeBSD 8.0 lacks RLIM_SAVED_CUR. */
118 if (limit == RLIM_SAVED_CUR) {
123 #ifdef RLIM_SAVED_MAX /* FreeBSD 8.0 lacks RLIM_SAVED_MAX. */
124 if (limit == RLIM_SAVED_MAX) {
132 /* Returns the maximum valid FD value, plus 1. */
136 static int max_fds = -1;
139 if (!getrlimit(RLIMIT_NOFILE, &r) && rlim_is_finite(r.rlim_cur)) {
140 max_fds = r.rlim_cur;
142 VLOG_WARN("failed to obtain fd limit, defaulting to 1024");
149 /* Translates 'host_name', which must be a string representation of an IP
150 * address, into a numeric IP address in '*addr'. Returns 0 if successful,
151 * otherwise a positive errno value. */
153 lookup_ip(const char *host_name, struct in_addr *addr)
155 if (!inet_aton(host_name, addr)) {
156 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
157 VLOG_ERR_RL(&rl, "\"%s\" is not a valid IP address", host_name);
163 /* Translates 'host_name', which must be a string representation of an IPv6
164 * address, into a numeric IPv6 address in '*addr'. Returns 0 if successful,
165 * otherwise a positive errno value. */
167 lookup_ipv6(const char *host_name, struct in6_addr *addr)
169 if (inet_pton(AF_INET6, host_name, addr) != 1) {
170 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
171 VLOG_ERR_RL(&rl, "\"%s\" is not a valid IPv6 address", host_name);
177 /* Translates 'host_name', which must be a host name or a string representation
178 * of an IP address, into a numeric IP address in '*addr'. Returns 0 if
179 * successful, otherwise a positive errno value.
181 * Most Open vSwitch code should not use this because it causes deadlocks:
182 * gethostbyname() sends out a DNS request but that starts a new flow for which
183 * OVS must set up a flow, but it can't because it's waiting for a DNS reply.
184 * The synchronous lookup also delays other activity. (Of course we can solve
185 * this but it doesn't seem worthwhile quite yet.) */
187 lookup_hostname(const char *host_name, struct in_addr *addr)
191 if (inet_aton(host_name, addr)) {
195 h = gethostbyname(host_name);
197 *addr = *(struct in_addr *) h->h_addr;
201 return (h_errno == HOST_NOT_FOUND ? ENOENT
202 : h_errno == TRY_AGAIN ? EAGAIN
203 : h_errno == NO_RECOVERY ? EIO
204 : h_errno == NO_ADDRESS ? ENXIO
208 /* Returns the error condition associated with socket 'fd' and resets the
209 * socket's error status. */
211 get_socket_error(int fd)
215 if (getsockopt_int(fd, SOL_SOCKET, SO_ERROR, "SO_ERROR", &error)) {
222 check_connection_completion(int fd)
228 pfd.events = POLLOUT;
230 retval = poll(&pfd, 1, 0);
231 } while (retval < 0 && errno == EINTR);
233 return get_socket_error(fd);
234 } else if (retval < 0) {
235 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
236 VLOG_ERR_RL(&rl, "poll: %s", strerror(errno));
243 /* Drain all the data currently in the receive queue of a datagram socket (and
244 * possibly additional data). There is no way to know how many packets are in
245 * the receive queue, but we do know that the total number of bytes queued does
246 * not exceed the receive buffer size, so we pull packets until none are left
247 * or we've read that many bytes. */
253 rcvbuf = get_socket_rcvbuf(fd);
259 /* In Linux, specifying MSG_TRUNC in the flags argument causes the
260 * datagram length to be returned, even if that is longer than the
261 * buffer provided. Thus, we can use a 1-byte buffer to discard the
262 * incoming datagram and still be able to account how many bytes were
263 * removed from the receive buffer.
265 * On other Unix-like OSes, MSG_TRUNC has no effect in the flags
267 char buffer[LINUX_DATAPATH ? 1 : 2048];
268 ssize_t n_bytes = recv(fd, buffer, sizeof buffer,
269 MSG_TRUNC | MSG_DONTWAIT);
270 if (n_bytes <= 0 || n_bytes >= rcvbuf) {
278 /* Returns the size of socket 'sock''s receive buffer (SO_RCVBUF), or a
279 * negative errno value if an error occurs. */
281 get_socket_rcvbuf(int sock)
286 error = getsockopt_int(sock, SOL_SOCKET, SO_RCVBUF, "SO_RCVBUF", &rcvbuf);
287 return error ? -error : rcvbuf;
290 /* Reads and discards up to 'n' datagrams from 'fd', stopping as soon as no
291 * more data can be immediately read. ('fd' should therefore be in
292 * non-blocking mode.)*/
294 drain_fd(int fd, size_t n_packets)
296 for (; n_packets > 0; n_packets--) {
297 /* 'buffer' only needs to be 1 byte long in most circumstances. This
298 * size is defensive against the possibility that we someday want to
299 * use a Linux tap device without TUN_NO_PI, in which case a buffer
300 * smaller than sizeof(struct tun_pi) will give EINVAL on read. */
302 if (read(fd, buffer, sizeof buffer) <= 0) {
308 /* Stores in '*un' a sockaddr_un that refers to file 'name'. Stores in
309 * '*un_len' the size of the sockaddr_un. */
311 make_sockaddr_un__(const char *name, struct sockaddr_un *un, socklen_t *un_len)
313 un->sun_family = AF_UNIX;
314 ovs_strzcpy(un->sun_path, name, sizeof un->sun_path);
315 *un_len = (offsetof(struct sockaddr_un, sun_path)
316 + strlen (un->sun_path) + 1);
319 /* Stores in '*un' a sockaddr_un that refers to file 'name'. Stores in
320 * '*un_len' the size of the sockaddr_un.
322 * Returns 0 on success, otherwise a positive errno value. On success,
323 * '*dirfdp' is either -1 or a nonnegative file descriptor that the caller
324 * should close after using '*un' to bind or connect. On failure, '*dirfdp' is
327 make_sockaddr_un(const char *name, struct sockaddr_un *un, socklen_t *un_len,
330 enum { MAX_UN_LEN = sizeof un->sun_path - 1 };
333 if (strlen(name) > MAX_UN_LEN) {
334 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
336 if (LINUX_DATAPATH) {
337 /* 'name' is too long to fit in a sockaddr_un, but we have a
338 * workaround for that on Linux: shorten it by opening a file
339 * descriptor for the directory part of the name and indirecting
340 * through /proc/self/fd/<dirfd>/<basename>. */
345 dir = dir_name(name);
346 base = base_name(name);
348 dirfd = open(dir, O_DIRECTORY | O_RDONLY);
355 short_name = xasprintf("/proc/self/fd/%d/%s", dirfd, base);
359 if (strlen(short_name) <= MAX_UN_LEN) {
360 make_sockaddr_un__(short_name, un, un_len);
368 VLOG_WARN_RL(&rl, "Unix socket name %s is longer than maximum "
369 "%d bytes (even shortened)", name, MAX_UN_LEN);
371 /* 'name' is too long and we have no workaround. */
372 VLOG_WARN_RL(&rl, "Unix socket name %s is longer than maximum "
373 "%d bytes", name, MAX_UN_LEN);
378 make_sockaddr_un__(name, un, un_len);
383 /* Binds Unix domain socket 'fd' to a file with permissions 0700. */
385 bind_unix_socket(int fd, struct sockaddr *sun, socklen_t sun_len)
387 /* According to _Unix Network Programming_, umask should affect bind(). */
388 mode_t old_umask = umask(0077);
389 int error = bind(fd, sun, sun_len) ? errno : 0;
394 /* Creates a Unix domain socket in the given 'style' (either SOCK_DGRAM or
395 * SOCK_STREAM) that is bound to '*bind_path' (if 'bind_path' is non-null) and
396 * connected to '*connect_path' (if 'connect_path' is non-null). If 'nonblock'
397 * is true, the socket is made non-blocking.
399 * Returns the socket's fd if successful, otherwise a negative errno value. */
401 make_unix_socket(int style, bool nonblock,
402 const char *bind_path, const char *connect_path)
407 fd = socket(PF_UNIX, style, 0);
412 /* Set nonblocking mode right away, if we want it. This prevents blocking
413 * in connect(), if connect_path != NULL. (In turn, that's a corner case:
414 * it will only happen if style is SOCK_STREAM or SOCK_SEQPACKET, and only
415 * if a backlog of un-accepted connections has built up in the kernel.) */
417 int flags = fcntl(fd, F_GETFL, 0);
422 if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) == -1) {
429 struct sockaddr_un un;
433 if (unlink(bind_path) && errno != ENOENT) {
434 VLOG_WARN("unlinking \"%s\": %s\n", bind_path, strerror(errno));
436 fatal_signal_add_file_to_unlink(bind_path);
438 error = make_sockaddr_un(bind_path, &un, &un_len, &dirfd);
440 error = bind_unix_socket(fd, (struct sockaddr *) &un, un_len);
451 struct sockaddr_un un;
455 error = make_sockaddr_un(connect_path, &un, &un_len, &dirfd);
457 && connect(fd, (struct sockaddr*) &un, un_len)
458 && errno != EINPROGRESS) {
472 if (error == EAGAIN) {
476 fatal_signal_unlink_file_now(bind_path);
483 get_unix_name_len(socklen_t sun_len)
485 return (sun_len >= offsetof(struct sockaddr_un, sun_path)
486 ? sun_len - offsetof(struct sockaddr_un, sun_path)
491 guess_netmask(ovs_be32 ip_)
493 uint32_t ip = ntohl(ip_);
494 return ((ip >> 31) == 0 ? htonl(0xff000000) /* Class A */
495 : (ip >> 30) == 2 ? htonl(0xffff0000) /* Class B */
496 : (ip >> 29) == 6 ? htonl(0xffffff00) /* Class C */
497 : htonl(0)); /* ??? */
500 /* Parses 'target', which should be a string in the format "<host>[:<port>]".
501 * <host> is required. If 'default_port' is nonzero then <port> is optional
502 * and defaults to 'default_port'.
504 * On success, returns true and stores the parsed remote address into '*sinp'.
505 * On failure, logs an error, stores zeros into '*sinp', and returns false. */
507 inet_parse_active(const char *target_, uint16_t default_port,
508 struct sockaddr_in *sinp)
510 char *target = xstrdup(target_);
511 char *save_ptr = NULL;
512 const char *host_name;
513 const char *port_string;
517 sinp->sin_family = AF_INET;
518 sinp->sin_port = htons(default_port);
521 host_name = strtok_r(target, ":", &save_ptr);
522 port_string = strtok_r(NULL, ":", &save_ptr);
524 VLOG_ERR("%s: bad peer name format", target_);
528 /* Look up IP, port. */
529 if (lookup_ip(host_name, &sinp->sin_addr)) {
532 if (port_string && atoi(port_string)) {
533 sinp->sin_port = htons(atoi(port_string));
534 } else if (!default_port) {
535 VLOG_ERR("%s: port number must be specified", target_);
543 memset(sinp, 0, sizeof *sinp);
549 /* Opens a non-blocking IPv4 socket of the specified 'style' and connects to
550 * 'target', which should be a string in the format "<host>[:<port>]". <host>
551 * is required. If 'default_port' is nonzero then <port> is optional and
552 * defaults to 'default_port'.
554 * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
556 * On success, returns 0 (indicating connection complete) or EAGAIN (indicating
557 * connection in progress), in which case the new file descriptor is stored
558 * into '*fdp'. On failure, returns a positive errno value other than EAGAIN
559 * and stores -1 into '*fdp'.
561 * If 'sinp' is non-null, then on success the target address is stored into
564 * 'dscp' becomes the DSCP bits in the IP headers for the new connection. It
565 * should be in the range [0, 63] and will automatically be shifted to the
566 * appropriately place in the IP tos field. */
568 inet_open_active(int style, const char *target, uint16_t default_port,
569 struct sockaddr_in *sinp, int *fdp, uint8_t dscp)
571 struct sockaddr_in sin;
576 if (!inet_parse_active(target, default_port, &sin)) {
577 error = EAFNOSUPPORT;
581 /* Create non-blocking socket. */
582 fd = socket(AF_INET, style, 0);
584 VLOG_ERR("%s: socket: %s", target, strerror(errno));
588 error = set_nonblocking(fd);
593 /* The dscp bits must be configured before connect() to ensure that the TOS
594 * field is set during the connection establishment. If set after
595 * connect(), the handshake SYN frames will be sent with a TOS of 0. */
596 error = set_dscp(fd, dscp);
598 VLOG_ERR("%s: socket: %s", target, strerror(error));
603 error = connect(fd, (struct sockaddr *) &sin, sizeof sin) == 0 ? 0 : errno;
604 if (error == EINPROGRESS) {
609 if (!error || error == EAGAIN) {
613 } else if (fd >= 0) {
620 /* Parses 'target', which should be a string in the format "[<port>][:<ip>]":
622 * - If 'default_port' is -1, then <port> is required. Otherwise, if
623 * <port> is omitted, then 'default_port' is used instead.
625 * - If <port> (or 'default_port', if used) is 0, then no port is bound
626 * and the TCP/IP stack will select a port.
628 * - If <ip> is omitted then the IP address is wildcarded.
630 * If successful, stores the address into '*sinp' and returns true; otherwise
631 * zeros '*sinp' and returns false. */
633 inet_parse_passive(const char *target_, int default_port,
634 struct sockaddr_in *sinp)
636 char *target = xstrdup(target_);
637 char *string_ptr = target;
638 const char *host_name;
639 const char *port_string;
643 /* Address defaults. */
644 memset(sinp, 0, sizeof *sinp);
645 sinp->sin_family = AF_INET;
646 sinp->sin_addr.s_addr = htonl(INADDR_ANY);
647 sinp->sin_port = htons(default_port);
649 /* Parse optional port number. */
650 port_string = strsep(&string_ptr, ":");
651 if (port_string && str_to_int(port_string, 10, &port)) {
652 sinp->sin_port = htons(port);
653 } else if (default_port < 0) {
654 VLOG_ERR("%s: port number must be specified", target_);
658 /* Parse optional bind IP. */
659 host_name = strsep(&string_ptr, ":");
660 if (host_name && host_name[0] && lookup_ip(host_name, &sinp->sin_addr)) {
668 memset(sinp, 0, sizeof *sinp);
675 /* Opens a non-blocking IPv4 socket of the specified 'style', binds to
676 * 'target', and listens for incoming connections. Parses 'target' in the same
677 * way was inet_parse_passive().
679 * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
681 * For TCP, the socket will have SO_REUSEADDR turned on.
683 * On success, returns a non-negative file descriptor. On failure, returns a
684 * negative errno value.
686 * If 'sinp' is non-null, then on success the bound address is stored into
689 * 'dscp' becomes the DSCP bits in the IP headers for the new connection. It
690 * should be in the range [0, 63] and will automatically be shifted to the
691 * appropriately place in the IP tos field. */
693 inet_open_passive(int style, const char *target, int default_port,
694 struct sockaddr_in *sinp, uint8_t dscp)
696 struct sockaddr_in sin;
698 unsigned int yes = 1;
700 if (!inet_parse_passive(target, default_port, &sin)) {
701 return -EAFNOSUPPORT;
704 /* Create non-blocking socket, set SO_REUSEADDR. */
705 fd = socket(AF_INET, style, 0);
708 VLOG_ERR("%s: socket: %s", target, strerror(error));
711 error = set_nonblocking(fd);
715 if (style == SOCK_STREAM
716 && setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof yes) < 0) {
718 VLOG_ERR("%s: setsockopt(SO_REUSEADDR): %s", target, strerror(error));
723 if (bind(fd, (struct sockaddr *) &sin, sizeof sin) < 0) {
725 VLOG_ERR("%s: bind: %s", target, strerror(error));
729 /* The dscp bits must be configured before connect() to ensure that the TOS
730 * field is set during the connection establishment. If set after
731 * connect(), the handshake SYN frames will be sent with a TOS of 0. */
732 error = set_dscp(fd, dscp);
734 VLOG_ERR("%s: socket: %s", target, strerror(error));
739 if (style == SOCK_STREAM && listen(fd, 10) < 0) {
741 VLOG_ERR("%s: listen: %s", target, strerror(error));
746 socklen_t sin_len = sizeof sin;
747 if (getsockname(fd, (struct sockaddr *) &sin, &sin_len) < 0){
749 VLOG_ERR("%s: getsockname: %s", target, strerror(error));
752 if (sin.sin_family != AF_INET || sin_len != sizeof sin) {
753 error = EAFNOSUPPORT;
754 VLOG_ERR("%s: getsockname: invalid socket name", target);
767 /* Returns a readable and writable fd for /dev/null, if successful, otherwise
768 * a negative errno value. The caller must not close the returned fd (because
769 * the same fd will be handed out to subsequent callers). */
773 static int null_fd = -1;
775 null_fd = open("/dev/null", O_RDWR);
778 VLOG_ERR("could not open /dev/null: %s", strerror(error));
786 read_fully(int fd, void *p_, size_t size, size_t *bytes_read)
792 ssize_t retval = read(fd, p, size);
794 *bytes_read += retval;
797 } else if (retval == 0) {
799 } else if (errno != EINTR) {
807 write_fully(int fd, const void *p_, size_t size, size_t *bytes_written)
809 const uint8_t *p = p_;
813 ssize_t retval = write(fd, p, size);
815 *bytes_written += retval;
818 } else if (retval == 0) {
819 VLOG_WARN("write returned 0");
821 } else if (errno != EINTR) {
828 /* Given file name 'file_name', fsyncs the directory in which it is contained.
829 * Returns 0 if successful, otherwise a positive errno value. */
831 fsync_parent_dir(const char *file_name)
837 dir = dir_name(file_name);
838 fd = open(dir, O_RDONLY);
841 if (errno == EINVAL || errno == EROFS) {
842 /* This directory does not support synchronization. Not
843 * really an error. */
846 VLOG_ERR("%s: fsync failed (%s)", dir, strerror(error));
852 VLOG_ERR("%s: open failed (%s)", dir, strerror(error));
859 /* Obtains the modification time of the file named 'file_name' to the greatest
860 * supported precision. If successful, stores the mtime in '*mtime' and
861 * returns 0. On error, returns a positive errno value and stores zeros in
864 get_mtime(const char *file_name, struct timespec *mtime)
868 if (!stat(file_name, &s)) {
869 mtime->tv_sec = s.st_mtime;
871 #if HAVE_STRUCT_STAT_ST_MTIM_TV_NSEC
872 mtime->tv_nsec = s.st_mtim.tv_nsec;
873 #elif HAVE_STRUCT_STAT_ST_MTIMENSEC
874 mtime->tv_nsec = s.st_mtimensec;
881 mtime->tv_sec = mtime->tv_nsec = 0;
890 VLOG_FATAL("failed to create pipe (%s)", strerror(errno));
895 xpipe_nonblocking(int fds[2])
898 xset_nonblocking(fds[0]);
899 xset_nonblocking(fds[1]);
903 xsocketpair(int domain, int type, int protocol, int fds[2])
905 if (socketpair(domain, type, protocol, fds)) {
906 VLOG_FATAL("failed to create socketpair (%s)", strerror(errno));
911 getsockopt_int(int fd, int level, int option, const char *optname, int *valuep)
913 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
919 if (getsockopt(fd, level, option, &value, &len)) {
921 VLOG_ERR_RL(&rl, "getsockopt(%s): %s", optname, strerror(error));
922 } else if (len != sizeof value) {
924 VLOG_ERR_RL(&rl, "getsockopt(%s): value is %u bytes (expected %zu)",
925 optname, (unsigned int) len, sizeof value);
930 *valuep = error ? 0 : value;
935 describe_sockaddr(struct ds *string, int fd,
936 int (*getaddr)(int, struct sockaddr *, socklen_t *))
938 struct sockaddr_storage ss;
939 socklen_t len = sizeof ss;
941 if (!getaddr(fd, (struct sockaddr *) &ss, &len)) {
942 if (ss.ss_family == AF_INET) {
943 struct sockaddr_in sin;
945 memcpy(&sin, &ss, sizeof sin);
946 ds_put_format(string, IP_FMT":%"PRIu16,
947 IP_ARGS(&sin.sin_addr.s_addr), ntohs(sin.sin_port));
948 } else if (ss.ss_family == AF_UNIX) {
949 struct sockaddr_un sun;
953 memcpy(&sun, &ss, sizeof sun);
954 maxlen = len - offsetof(struct sockaddr_un, sun_path);
955 null = memchr(sun.sun_path, '\0', maxlen);
956 ds_put_buffer(string, sun.sun_path,
957 null ? null - sun.sun_path : maxlen);
960 else if (ss.ss_family == AF_NETLINK) {
963 /* SO_PROTOCOL was introduced in 2.6.32. Support it regardless of the version
964 * of the Linux kernel headers in use at build time. */
966 #define SO_PROTOCOL 38
969 if (!getsockopt_int(fd, SOL_SOCKET, SO_PROTOCOL, "SO_PROTOCOL",
973 ds_put_cstr(string, "NETLINK_ROUTE");
976 case NETLINK_GENERIC:
977 ds_put_cstr(string, "NETLINK_GENERIC");
981 ds_put_format(string, "AF_NETLINK family %d", protocol);
985 ds_put_cstr(string, "AF_NETLINK");
989 #if AF_PACKET && LINUX_DATAPATH
990 else if (ss.ss_family == AF_PACKET) {
991 struct sockaddr_ll sll;
993 memcpy(&sll, &ss, sizeof sll);
994 ds_put_cstr(string, "AF_PACKET");
995 if (sll.sll_ifindex) {
998 if (if_indextoname(sll.sll_ifindex, name)) {
999 ds_put_format(string, "(%s)", name);
1001 ds_put_format(string, "(ifindex=%d)", sll.sll_ifindex);
1004 if (sll.sll_protocol) {
1005 ds_put_format(string, "(protocol=0x%"PRIu16")",
1006 ntohs(sll.sll_protocol));
1010 else if (ss.ss_family == AF_UNSPEC) {
1011 ds_put_cstr(string, "AF_UNSPEC");
1013 ds_put_format(string, "AF_%d", (int) ss.ss_family);
1019 #ifdef LINUX_DATAPATH
1021 put_fd_filename(struct ds *string, int fd)
1027 linkname = xasprintf("/proc/self/fd/%d", fd);
1028 n = readlink(linkname, buf, sizeof buf);
1030 ds_put_char(string, ' ');
1031 ds_put_buffer(string, buf, n);
1032 if (n > sizeof buf) {
1033 ds_put_cstr(string, "...");
1040 /* Returns a malloc()'d string describing 'fd', for use in logging. */
1048 if (fstat(fd, &s)) {
1049 ds_put_format(&string, "fstat failed (%s)", strerror(errno));
1050 } else if (S_ISSOCK(s.st_mode)) {
1051 describe_sockaddr(&string, fd, getsockname);
1052 ds_put_cstr(&string, "<->");
1053 describe_sockaddr(&string, fd, getpeername);
1055 ds_put_cstr(&string, (isatty(fd) ? "tty"
1056 : S_ISDIR(s.st_mode) ? "directory"
1057 : S_ISCHR(s.st_mode) ? "character device"
1058 : S_ISBLK(s.st_mode) ? "block device"
1059 : S_ISREG(s.st_mode) ? "file"
1060 : S_ISFIFO(s.st_mode) ? "FIFO"
1061 : S_ISLNK(s.st_mode) ? "symbolic link"
1063 #ifdef LINUX_DATAPATH
1064 put_fd_filename(&string, fd);
1067 return ds_steal_cstr(&string);
1070 /* Returns the total of the 'iov_len' members of the 'n_iovs' in 'iovs'.
1071 * The caller must ensure that the total does not exceed SIZE_MAX. */
1073 iovec_len(const struct iovec iovs[], size_t n_iovs)
1078 for (i = 0; i < n_iovs; i++) {
1079 len += iovs[i].iov_len;
1084 /* Returns true if all of the 'n_iovs' iovecs in 'iovs' have length zero. */
1086 iovec_is_empty(const struct iovec iovs[], size_t n_iovs)
1090 for (i = 0; i < n_iovs; i++) {
1091 if (iovs[i].iov_len) {
1098 /* Sends the 'n_iovs' iovecs of data in 'iovs' and the 'n_fds' file descriptors
1099 * in 'fds' on Unix domain socket 'sock'. Returns the number of bytes
1100 * successfully sent or -1 if an error occurred. On error, sets errno
1103 send_iovec_and_fds(int sock,
1104 const struct iovec *iovs, size_t n_iovs,
1105 const int fds[], size_t n_fds)
1111 char control[CMSG_SPACE(SOUTIL_MAX_FDS * sizeof *fds)];
1115 assert(!iovec_is_empty(iovs, n_iovs));
1116 assert(n_fds <= SOUTIL_MAX_FDS);
1118 memset(&cmsg, 0, sizeof cmsg);
1119 cmsg.cm.cmsg_len = CMSG_LEN(n_fds * sizeof *fds);
1120 cmsg.cm.cmsg_level = SOL_SOCKET;
1121 cmsg.cm.cmsg_type = SCM_RIGHTS;
1122 memcpy(CMSG_DATA(&cmsg.cm), fds, n_fds * sizeof *fds);
1124 msg.msg_name = NULL;
1125 msg.msg_namelen = 0;
1126 msg.msg_iov = (struct iovec *) iovs;
1127 msg.msg_iovlen = n_iovs;
1128 msg.msg_control = &cmsg.cm;
1129 msg.msg_controllen = CMSG_SPACE(n_fds * sizeof *fds);
1132 return sendmsg(sock, &msg, 0);
1134 return writev(sock, iovs, n_iovs);
1138 /* Sends the 'n_iovs' iovecs of data in 'iovs' and the 'n_fds' file descriptors
1139 * in 'fds' on Unix domain socket 'sock'. If 'skip_bytes' is nonzero, then the
1140 * first 'skip_bytes' of data in the iovecs are not sent, and none of the file
1141 * descriptors are sent. The function continues to retry sending until an
1142 * error (other than EINTR) occurs or all the data and fds are sent.
1144 * Returns 0 if all the data and fds were successfully sent, otherwise a
1145 * positive errno value. Regardless of success, stores the number of bytes
1146 * sent (always at least 'skip_bytes') in '*bytes_sent'. (If at least one byte
1147 * is sent, then all the fds have been sent.)
1149 * 'skip_bytes' must be less than or equal to iovec_len(iovs, n_iovs). */
1151 send_iovec_and_fds_fully(int sock,
1152 const struct iovec iovs[], size_t n_iovs,
1153 const int fds[], size_t n_fds,
1154 size_t skip_bytes, size_t *bytes_sent)
1157 while (n_iovs > 0) {
1161 retval = skip_bytes;
1163 } else if (!*bytes_sent) {
1164 retval = send_iovec_and_fds(sock, iovs, n_iovs, fds, n_fds);
1166 retval = writev(sock, iovs, n_iovs);
1170 *bytes_sent += retval;
1171 while (retval > 0) {
1172 const uint8_t *base = iovs->iov_base;
1173 size_t len = iovs->iov_len;
1179 error = write_fully(sock, base + retval, len - retval,
1181 *bytes_sent += sent;
1191 } else if (retval == 0) {
1192 if (iovec_is_empty(iovs, n_iovs)) {
1195 VLOG_WARN("send returned 0");
1197 } else if (errno != EINTR) {
1205 /* Sends the 'n_iovs' iovecs of data in 'iovs' and the 'n_fds' file descriptors
1206 * in 'fds' on Unix domain socket 'sock'. The function continues to retry
1207 * sending until an error (other than EAGAIN or EINTR) occurs or all the data
1208 * and fds are sent. Upon EAGAIN, the function blocks until the socket is
1209 * ready for more data.
1211 * Returns 0 if all the data and fds were successfully sent, otherwise a
1212 * positive errno value. */
1214 send_iovec_and_fds_fully_block(int sock,
1215 const struct iovec iovs[], size_t n_iovs,
1216 const int fds[], size_t n_fds)
1223 error = send_iovec_and_fds_fully(sock, iovs, n_iovs,
1224 fds, n_fds, sent, &sent);
1225 if (error != EAGAIN) {
1228 poll_fd_wait(sock, POLLOUT);
1233 /* Attempts to receive from Unix domain socket 'sock' up to 'size' bytes of
1234 * data into 'data' and up to SOUTIL_MAX_FDS file descriptors into 'fds'.
1236 * - Upon success, returns the number of bytes of data copied into 'data'
1237 * and stores the number of received file descriptors into '*n_fdsp'.
1239 * - On failure, returns a negative errno value and stores 0 in
1242 * - On EOF, returns 0 and stores 0 in '*n_fdsp'. */
1244 recv_data_and_fds(int sock,
1245 void *data, size_t size,
1246 int fds[SOUTIL_MAX_FDS], size_t *n_fdsp)
1250 char control[CMSG_SPACE(SOUTIL_MAX_FDS * sizeof *fds)];
1262 iov.iov_base = data;
1265 msg.msg_name = NULL;
1266 msg.msg_namelen = 0;
1269 msg.msg_control = &cmsg.cm;
1270 msg.msg_controllen = sizeof cmsg.control;
1273 retval = recvmsg(sock, &msg, 0);
1274 } while (retval < 0 && errno == EINTR);
1276 return retval < 0 ? -errno : 0;
1279 for (p = CMSG_FIRSTHDR(&msg); p; p = CMSG_NXTHDR(&msg, p)) {
1280 if (p->cmsg_level != SOL_SOCKET || p->cmsg_type != SCM_RIGHTS) {
1281 VLOG_ERR("unexpected control message %d:%d",
1282 p->cmsg_level, p->cmsg_type);
1284 } else if (*n_fdsp) {
1285 VLOG_ERR("multiple SCM_RIGHTS received");
1288 size_t n_fds = (p->cmsg_len - CMSG_LEN(0)) / sizeof *fds;
1289 const int *fds_data = (const int *) CMSG_DATA(p);
1292 if (n_fds > SOUTIL_MAX_FDS) {
1293 VLOG_ERR("%zu fds received but only %d supported",
1294 n_fds, SOUTIL_MAX_FDS);
1295 for (i = 0; i < n_fds; i++) {
1302 memcpy(fds, fds_data, n_fds * sizeof *fds);
1309 for (i = 0; i < *n_fdsp; i++) {