lib/socket-util.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
   3  *
   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:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 #include <config.h>
  18 #include "socket-util.h"
  19 #include <arpa/inet.h>
  20 #include <errno.h>
  21 #include <fcntl.h>
  22 #include <net/if.h>
  23 #include <netdb.h>
  24 #include <poll.h>
  25 #include <stddef.h>
  26 #include <stdio.h>
  27 #include <stdlib.h>
  28 #include <string.h>
  29 #include <sys/resource.h>
  30 #include <sys/socket.h>
  31 #include <sys/stat.h>
  32 #include <sys/uio.h>
  33 #include <sys/un.h>
  34 #include <unistd.h>
  35 #include "dynamic-string.h"
  36 #include "fatal-signal.h"
  37 #include "packets.h"
  38 #include "poll-loop.h"
  39 #include "util.h"
  40 #include "vlog.h"
  41 #if AF_PACKET && LINUX_DATAPATH
  42 #include <linux/if_packet.h>
  43 #endif
  44 #ifdef HAVE_NETLINK
  45 #include "netlink-protocol.h"
  46 #include "netlink-socket.h"
  47 #endif
  48
  49 VLOG_DEFINE_THIS_MODULE(socket_util);
  50
  51 /* #ifdefs make it a pain to maintain code: you have to try to build both ways.
  52  * Thus, this file compiles all of the code regardless of the target, by
  53  * writing "if (LINUX_DATAPATH)" instead of "#ifdef __linux__". */
  54 #ifndef LINUX_DATAPATH
  55 #define LINUX_DATAPATH 0
  56 #endif
  57
  58 #ifndef O_DIRECTORY
  59 #define O_DIRECTORY 0
  60 #endif
  61
  62 static int getsockopt_int(int fd, int level, int option, const char *optname,
  63                           int *valuep);
  64
  65 /* Sets 'fd' to non-blocking mode.  Returns 0 if successful, otherwise a
  66  * positive errno value. */
  67 int
  68 set_nonblocking(int fd)
  69 {
  70     int flags = fcntl(fd, F_GETFL, 0);
  71     if (flags != -1) {
  72         if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) != -1) {
  73             return 0;
  74         } else {
  75             VLOG_ERR("fcntl(F_SETFL) failed: %s", strerror(errno));
  76             return errno;
  77         }
  78     } else {
  79         VLOG_ERR("fcntl(F_GETFL) failed: %s", strerror(errno));
  80         return errno;
  81     }
  82 }
  83
  84 void
  85 xset_nonblocking(int fd)
  86 {
  87     if (set_nonblocking(fd)) {
  88         exit(EXIT_FAILURE);
  89     }
  90 }
  91
  92 int
  93 set_dscp(int fd, uint8_t dscp)
  94 {
  95     int val;
  96
  97     if (dscp > 63) {
  98         return EINVAL;
  99     }
 100
 101     val = dscp << 2;
 102     if (setsockopt(fd, IPPROTO_IP, IP_TOS, &val, sizeof val)) {
 103         return errno;
 104     }
 105
 106     return 0;
 107 }
 108
 109 static bool
 110 rlim_is_finite(rlim_t limit)
 111 {
 112     if (limit == RLIM_INFINITY) {
 113         return false;
 114     }
 115
 116 #ifdef RLIM_SAVED_CUR           /* FreeBSD 8.0 lacks RLIM_SAVED_CUR. */
 117     if (limit == RLIM_SAVED_CUR) {
 118         return false;
 119     }
 120 #endif
 121
 122 #ifdef RLIM_SAVED_MAX           /* FreeBSD 8.0 lacks RLIM_SAVED_MAX. */
 123     if (limit == RLIM_SAVED_MAX) {
 124         return false;
 125     }
 126 #endif
 127
 128     return true;
 129 }
 130
 131 /* Returns the maximum valid FD value, plus 1. */
 132 int
 133 get_max_fds(void)
 134 {
 135     static int max_fds = -1;
 136     if (max_fds < 0) {
 137         struct rlimit r;
 138         if (!getrlimit(RLIMIT_NOFILE, &r) && rlim_is_finite(r.rlim_cur)) {
 139             max_fds = r.rlim_cur;
 140         } else {
 141             VLOG_WARN("failed to obtain fd limit, defaulting to 1024");
 142             max_fds = 1024;
 143         }
 144     }
 145     return max_fds;
 146 }
 147
 148 /* Translates 'host_name', which must be a string representation of an IP
 149  * address, into a numeric IP address in '*addr'.  Returns 0 if successful,
 150  * otherwise a positive errno value. */
 151 int
 152 lookup_ip(const char *host_name, struct in_addr *addr)
 153 {
 154     if (!inet_aton(host_name, addr)) {
 155         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 156         VLOG_ERR_RL(&rl, "\"%s\" is not a valid IP address", host_name);
 157         return ENOENT;
 158     }
 159     return 0;
 160 }
 161
 162 /* Translates 'host_name', which must be a string representation of an IPv6
 163  * address, into a numeric IPv6 address in '*addr'.  Returns 0 if successful,
 164  * otherwise a positive errno value. */
 165 int
 166 lookup_ipv6(const char *host_name, struct in6_addr *addr)
 167 {
 168     if (inet_pton(AF_INET6, host_name, addr) != 1) {
 169         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 170         VLOG_ERR_RL(&rl, "\"%s\" is not a valid IPv6 address", host_name);
 171         return ENOENT;
 172     }
 173     return 0;
 174 }
 175
 176 /* Translates 'host_name', which must be a host name or a string representation
 177  * of an IP address, into a numeric IP address in '*addr'.  Returns 0 if
 178  * successful, otherwise a positive errno value.
 179  *
 180  * Most Open vSwitch code should not use this because it causes deadlocks:
 181  * getaddrinfo() sends out a DNS request but that starts a new flow for which
 182  * OVS must set up a flow, but it can't because it's waiting for a DNS reply.
 183  * The synchronous lookup also delays other activity.  (Of course we can solve
 184  * this but it doesn't seem worthwhile quite yet.)  */
 185 int
 186 lookup_hostname(const char *host_name, struct in_addr *addr)
 187 {
 188     struct addrinfo *result;
 189     struct addrinfo hints;
 190
 191     if (inet_aton(host_name, addr)) {
 192         return 0;
 193     }
 194
 195     memset(&hints, 0, sizeof hints);
 196     hints.ai_family = AF_INET;
 197
 198     switch (getaddrinfo(host_name, NULL, &hints, &result)) {
 199     case 0:
 200         *addr = ((struct sockaddr_in *) result->ai_addr)->sin_addr;
 201         freeaddrinfo(result);
 202         return 0;
 203
 204     case EAI_ADDRFAMILY:
 205     case EAI_NONAME:
 206     case EAI_SERVICE:
 207         return ENOENT;
 208
 209     case EAI_AGAIN:
 210         return EAGAIN;
 211
 212     case EAI_BADFLAGS:
 213     case EAI_FAMILY:
 214     case EAI_SOCKTYPE:
 215         return EINVAL;
 216
 217     case EAI_FAIL:
 218         return EIO;
 219
 220     case EAI_MEMORY:
 221         return ENOMEM;
 222
 223     case EAI_NODATA:
 224         return ENXIO;
 225
 226     case EAI_SYSTEM:
 227         return errno;
 228
 229     default:
 230         return EPROTO;
 231     }
 232 }
 233
 234 int
 235 check_connection_completion(int fd)
 236 {
 237     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
 238     struct pollfd pfd;
 239     int retval;
 240
 241     pfd.fd = fd;
 242     pfd.events = POLLOUT;
 243     do {
 244         retval = poll(&pfd, 1, 0);
 245     } while (retval < 0 && errno == EINTR);
 246     if (retval == 1) {
 247         if (pfd.revents & POLLERR) {
 248             ssize_t n = send(fd, "", 1, MSG_DONTWAIT);
 249             if (n < 0) {
 250                 return errno;
 251             } else {
 252                 VLOG_ERR_RL(&rl, "poll return POLLERR but send succeeded");
 253                 return EPROTO;
 254             }
 255         }
 256         return 0;
 257     } else if (retval < 0) {
 258         VLOG_ERR_RL(&rl, "poll: %s", strerror(errno));
 259         return errno;
 260     } else {
 261         return EAGAIN;
 262     }
 263 }
 264
 265 /* Drain all the data currently in the receive queue of a datagram socket (and
 266  * possibly additional data).  There is no way to know how many packets are in
 267  * the receive queue, but we do know that the total number of bytes queued does
 268  * not exceed the receive buffer size, so we pull packets until none are left
 269  * or we've read that many bytes. */
 270 int
 271 drain_rcvbuf(int fd)
 272 {
 273     int rcvbuf;
 274
 275     rcvbuf = get_socket_rcvbuf(fd);
 276     if (rcvbuf < 0) {
 277         return -rcvbuf;
 278     }
 279
 280     while (rcvbuf > 0) {
 281         /* In Linux, specifying MSG_TRUNC in the flags argument causes the
 282          * datagram length to be returned, even if that is longer than the
 283          * buffer provided.  Thus, we can use a 1-byte buffer to discard the
 284          * incoming datagram and still be able to account how many bytes were
 285          * removed from the receive buffer.
 286          *
 287          * On other Unix-like OSes, MSG_TRUNC has no effect in the flags
 288          * argument. */
 289         char buffer[LINUX_DATAPATH ? 1 : 2048];
 290         ssize_t n_bytes = recv(fd, buffer, sizeof buffer,
 291                                MSG_TRUNC | MSG_DONTWAIT);
 292         if (n_bytes <= 0 || n_bytes >= rcvbuf) {
 293             break;
 294         }
 295         rcvbuf -= n_bytes;
 296     }
 297     return 0;
 298 }
 299
 300 /* Returns the size of socket 'sock''s receive buffer (SO_RCVBUF), or a
 301  * negative errno value if an error occurs. */
 302 int
 303 get_socket_rcvbuf(int sock)
 304 {
 305     int rcvbuf;
 306     int error;
 307
 308     error = getsockopt_int(sock, SOL_SOCKET, SO_RCVBUF, "SO_RCVBUF", &rcvbuf);
 309     return error ? -error : rcvbuf;
 310 }
 311
 312 /* Reads and discards up to 'n' datagrams from 'fd', stopping as soon as no
 313  * more data can be immediately read.  ('fd' should therefore be in
 314  * non-blocking mode.)*/
 315 void
 316 drain_fd(int fd, size_t n_packets)
 317 {
 318     for (; n_packets > 0; n_packets--) {
 319         /* 'buffer' only needs to be 1 byte long in most circumstances.  This
 320          * size is defensive against the possibility that we someday want to
 321          * use a Linux tap device without TUN_NO_PI, in which case a buffer
 322          * smaller than sizeof(struct tun_pi) will give EINVAL on read. */
 323         char buffer[128];
 324         if (read(fd, buffer, sizeof buffer) <= 0) {
 325             break;
 326         }
 327     }
 328 }
 329
 330 /* Stores in '*un' a sockaddr_un that refers to file 'name'.  Stores in
 331  * '*un_len' the size of the sockaddr_un. */
 332 static void
 333 make_sockaddr_un__(const char *name, struct sockaddr_un *un, socklen_t *un_len)
 334 {
 335     un->sun_family = AF_UNIX;
 336     ovs_strzcpy(un->sun_path, name, sizeof un->sun_path);
 337     *un_len = (offsetof(struct sockaddr_un, sun_path)
 338                 + strlen (un->sun_path) + 1);
 339 }
 340
 341 /* Stores in '*un' a sockaddr_un that refers to file 'name'.  Stores in
 342  * '*un_len' the size of the sockaddr_un.
 343  *
 344  * Returns 0 on success, otherwise a positive errno value.  On success,
 345  * '*dirfdp' is either -1 or a nonnegative file descriptor that the caller
 346  * should close after using '*un' to bind or connect.  On failure, '*dirfdp' is
 347  * -1. */
 348 static int
 349 make_sockaddr_un(const char *name, struct sockaddr_un *un, socklen_t *un_len,
 350                  int *dirfdp)
 351 {
 352     enum { MAX_UN_LEN = sizeof un->sun_path - 1 };
 353
 354     *dirfdp = -1;
 355     if (strlen(name) > MAX_UN_LEN) {
 356         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
 357
 358         if (LINUX_DATAPATH) {
 359             /* 'name' is too long to fit in a sockaddr_un, but we have a
 360              * workaround for that on Linux: shorten it by opening a file
 361              * descriptor for the directory part of the name and indirecting
 362              * through /proc/self/fd/<dirfd>/<basename>. */
 363             char *dir, *base;
 364             char *short_name;
 365             int dirfd;
 366
 367             dir = dir_name(name);
 368             base = base_name(name);
 369
 370             dirfd = open(dir, O_DIRECTORY | O_RDONLY);
 371             if (dirfd < 0) {
 372                 free(base);
 373                 free(dir);
 374                 return errno;
 375             }
 376
 377             short_name = xasprintf("/proc/self/fd/%d/%s", dirfd, base);
 378             free(dir);
 379             free(base);
 380
 381             if (strlen(short_name) <= MAX_UN_LEN) {
 382                 make_sockaddr_un__(short_name, un, un_len);
 383                 free(short_name);
 384                 *dirfdp = dirfd;
 385                 return 0;
 386             }
 387             free(short_name);
 388             close(dirfd);
 389
 390             VLOG_WARN_RL(&rl, "Unix socket name %s is longer than maximum "
 391                          "%d bytes (even shortened)", name, MAX_UN_LEN);
 392         } else {
 393             /* 'name' is too long and we have no workaround. */
 394             VLOG_WARN_RL(&rl, "Unix socket name %s is longer than maximum "
 395                          "%d bytes", name, MAX_UN_LEN);
 396         }
 397
 398         return ENAMETOOLONG;
 399     } else {
 400         make_sockaddr_un__(name, un, un_len);
 401         return 0;
 402     }
 403 }
 404
 405 /* Binds Unix domain socket 'fd' to a file with permissions 0700. */
 406 static int
 407 bind_unix_socket(int fd, struct sockaddr *sun, socklen_t sun_len)
 408 {
 409     /* According to _Unix Network Programming_, umask should affect bind(). */
 410     mode_t old_umask = umask(0077);
 411     int error = bind(fd, sun, sun_len) ? errno : 0;
 412     umask(old_umask);
 413     return error;
 414 }
 415
 416 /* Creates a Unix domain socket in the given 'style' (either SOCK_DGRAM or
 417  * SOCK_STREAM) that is bound to '*bind_path' (if 'bind_path' is non-null) and
 418  * connected to '*connect_path' (if 'connect_path' is non-null).  If 'nonblock'
 419  * is true, the socket is made non-blocking.
 420  *
 421  * Returns the socket's fd if successful, otherwise a negative errno value. */
 422 int
 423 make_unix_socket(int style, bool nonblock,
 424                  const char *bind_path, const char *connect_path)
 425 {
 426     int error;
 427     int fd;
 428
 429     fd = socket(PF_UNIX, style, 0);
 430     if (fd < 0) {
 431         return -errno;
 432     }
 433
 434     /* Set nonblocking mode right away, if we want it.  This prevents blocking
 435      * in connect(), if connect_path != NULL.  (In turn, that's a corner case:
 436      * it will only happen if style is SOCK_STREAM or SOCK_SEQPACKET, and only
 437      * if a backlog of un-accepted connections has built up in the kernel.)  */
 438     if (nonblock) {
 439         error = set_nonblocking(fd);
 440         if (error) {
 441             goto error;
 442         }
 443     }
 444
 445     if (bind_path) {
 446         struct sockaddr_un un;
 447         socklen_t un_len;
 448         int dirfd;
 449
 450         if (unlink(bind_path) && errno != ENOENT) {
 451             VLOG_WARN("unlinking \"%s\": %s\n", bind_path, strerror(errno));
 452         }
 453         fatal_signal_add_file_to_unlink(bind_path);
 454
 455         error = make_sockaddr_un(bind_path, &un, &un_len, &dirfd);
 456         if (!error) {
 457             error = bind_unix_socket(fd, (struct sockaddr *) &un, un_len);
 458         }
 459         if (dirfd >= 0) {
 460             close(dirfd);
 461         }
 462         if (error) {
 463             goto error;
 464         }
 465     }
 466
 467     if (connect_path) {
 468         struct sockaddr_un un;
 469         socklen_t un_len;
 470         int dirfd;
 471
 472         error = make_sockaddr_un(connect_path, &un, &un_len, &dirfd);
 473         if (!error
 474             && connect(fd, (struct sockaddr*) &un, un_len)
 475             && errno != EINPROGRESS) {
 476             error = errno;
 477         }
 478         if (dirfd >= 0) {
 479             close(dirfd);
 480         }
 481         if (error) {
 482             goto error;
 483         }
 484     }
 485
 486     return fd;
 487
 488 error:
 489     if (error == EAGAIN) {
 490         error = EPROTO;
 491     }
 492     if (bind_path) {
 493         fatal_signal_unlink_file_now(bind_path);
 494     }
 495     close(fd);
 496     return -error;
 497 }
 498
 499 int
 500 get_unix_name_len(socklen_t sun_len)
 501 {
 502     return (sun_len >= offsetof(struct sockaddr_un, sun_path)
 503             ? sun_len - offsetof(struct sockaddr_un, sun_path)
 504             : 0);
 505 }
 506
 507 ovs_be32
 508 guess_netmask(ovs_be32 ip_)
 509 {
 510     uint32_t ip = ntohl(ip_);
 511     return ((ip >> 31) == 0 ? htonl(0xff000000)   /* Class A */
 512             : (ip >> 30) == 2 ? htonl(0xffff0000) /* Class B */
 513             : (ip >> 29) == 6 ? htonl(0xffffff00) /* Class C */
 514             : htonl(0));                          /* ??? */
 515 }
 516
 517 /* Parses 'target', which should be a string in the format "<host>[:<port>]".
 518  * <host> is required.  If 'default_port' is nonzero then <port> is optional
 519  * and defaults to 'default_port'.
 520  *
 521  * On success, returns true and stores the parsed remote address into '*sinp'.
 522  * On failure, logs an error, stores zeros into '*sinp', and returns false. */
 523 bool
 524 inet_parse_active(const char *target_, uint16_t default_port,
 525                   struct sockaddr_in *sinp)
 526 {
 527     char *target = xstrdup(target_);
 528     char *save_ptr = NULL;
 529     const char *host_name;
 530     const char *port_string;
 531     bool ok = false;
 532
 533     /* Defaults. */
 534     sinp->sin_family = AF_INET;
 535     sinp->sin_port = htons(default_port);
 536
 537     /* Tokenize. */
 538     host_name = strtok_r(target, ":", &save_ptr);
 539     port_string = strtok_r(NULL, ":", &save_ptr);
 540     if (!host_name) {
 541         VLOG_ERR("%s: bad peer name format", target_);
 542         goto exit;
 543     }
 544
 545     /* Look up IP, port. */
 546     if (lookup_ip(host_name, &sinp->sin_addr)) {
 547         goto exit;
 548     }
 549     if (port_string && atoi(port_string)) {
 550         sinp->sin_port = htons(atoi(port_string));
 551     } else if (!default_port) {
 552         VLOG_ERR("%s: port number must be specified", target_);
 553         goto exit;
 554     }
 555
 556     ok = true;
 557
 558 exit:
 559     if (!ok) {
 560         memset(sinp, 0, sizeof *sinp);
 561     }
 562     free(target);
 563     return ok;
 564 }
 565
 566 /* Opens a non-blocking IPv4 socket of the specified 'style' and connects to
 567  * 'target', which should be a string in the format "<host>[:<port>]".  <host>
 568  * is required.  If 'default_port' is nonzero then <port> is optional and
 569  * defaults to 'default_port'.
 570  *
 571  * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
 572  *
 573  * On success, returns 0 (indicating connection complete) or EAGAIN (indicating
 574  * connection in progress), in which case the new file descriptor is stored
 575  * into '*fdp'.  On failure, returns a positive errno value other than EAGAIN
 576  * and stores -1 into '*fdp'.
 577  *
 578  * If 'sinp' is non-null, then on success the target address is stored into
 579  * '*sinp'.
 580  *
 581  * 'dscp' becomes the DSCP bits in the IP headers for the new connection.  It
 582  * should be in the range [0, 63] and will automatically be shifted to the
 583  * appropriately place in the IP tos field. */
 584 int
 585 inet_open_active(int style, const char *target, uint16_t default_port,
 586                  struct sockaddr_in *sinp, int *fdp, uint8_t dscp)
 587 {
 588     struct sockaddr_in sin;
 589     int fd = -1;
 590     int error;
 591
 592     /* Parse. */
 593     if (!inet_parse_active(target, default_port, &sin)) {
 594         error = EAFNOSUPPORT;
 595         goto exit;
 596     }
 597
 598     /* Create non-blocking socket. */
 599     fd = socket(AF_INET, style, 0);
 600     if (fd < 0) {
 601         VLOG_ERR("%s: socket: %s", target, strerror(errno));
 602         error = errno;
 603         goto exit;
 604     }
 605     error = set_nonblocking(fd);
 606     if (error) {
 607         goto exit;
 608     }
 609
 610     /* The dscp bits must be configured before connect() to ensure that the TOS
 611      * field is set during the connection establishment.  If set after
 612      * connect(), the handshake SYN frames will be sent with a TOS of 0. */
 613     error = set_dscp(fd, dscp);
 614     if (error) {
 615         VLOG_ERR("%s: socket: %s", target, strerror(error));
 616         goto exit;
 617     }
 618
 619     /* Connect. */
 620     error = connect(fd, (struct sockaddr *) &sin, sizeof sin) == 0 ? 0 : errno;
 621     if (error == EINPROGRESS) {
 622         error = EAGAIN;
 623     }
 624
 625 exit:
 626     if (!error || error == EAGAIN) {
 627         if (sinp) {
 628             *sinp = sin;
 629         }
 630     } else if (fd >= 0) {
 631         close(fd);
 632         fd = -1;
 633     }
 634     *fdp = fd;
 635     return error;
 636 }
 637
 638 /* Parses 'target', which should be a string in the format "[<port>][:<ip>]":
 639  *
 640  *      - If 'default_port' is -1, then <port> is required.  Otherwise, if
 641  *        <port> is omitted, then 'default_port' is used instead.
 642  *
 643  *      - If <port> (or 'default_port', if used) is 0, then no port is bound
 644  *        and the TCP/IP stack will select a port.
 645  *
 646  *      - If <ip> is omitted then the IP address is wildcarded.
 647  *
 648  * If successful, stores the address into '*sinp' and returns true; otherwise
 649  * zeros '*sinp' and returns false. */
 650 bool
 651 inet_parse_passive(const char *target_, int default_port,
 652                    struct sockaddr_in *sinp)
 653 {
 654     char *target = xstrdup(target_);
 655     char *string_ptr = target;
 656     const char *host_name;
 657     const char *port_string;
 658     bool ok = false;
 659     int port;
 660
 661     /* Address defaults. */
 662     memset(sinp, 0, sizeof *sinp);
 663     sinp->sin_family = AF_INET;
 664     sinp->sin_addr.s_addr = htonl(INADDR_ANY);
 665     sinp->sin_port = htons(default_port);
 666
 667     /* Parse optional port number. */
 668     port_string = strsep(&string_ptr, ":");
 669     if (port_string && str_to_int(port_string, 10, &port)) {
 670         sinp->sin_port = htons(port);
 671     } else if (default_port < 0) {
 672         VLOG_ERR("%s: port number must be specified", target_);
 673         goto exit;
 674     }
 675
 676     /* Parse optional bind IP. */
 677     host_name = strsep(&string_ptr, ":");
 678     if (host_name && host_name[0] && lookup_ip(host_name, &sinp->sin_addr)) {
 679         goto exit;
 680     }
 681
 682     ok = true;
 683
 684 exit:
 685     if (!ok) {
 686         memset(sinp, 0, sizeof *sinp);
 687     }
 688     free(target);
 689     return ok;
 690 }
 691
 692
 693 /* Opens a non-blocking IPv4 socket of the specified 'style', binds to
 694  * 'target', and listens for incoming connections.  Parses 'target' in the same
 695  * way was inet_parse_passive().
 696  *
 697  * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
 698  *
 699  * For TCP, the socket will have SO_REUSEADDR turned on.
 700  *
 701  * On success, returns a non-negative file descriptor.  On failure, returns a
 702  * negative errno value.
 703  *
 704  * If 'sinp' is non-null, then on success the bound address is stored into
 705  * '*sinp'.
 706  *
 707  * 'dscp' becomes the DSCP bits in the IP headers for the new connection.  It
 708  * should be in the range [0, 63] and will automatically be shifted to the
 709  * appropriately place in the IP tos field. */
 710 int
 711 inet_open_passive(int style, const char *target, int default_port,
 712                   struct sockaddr_in *sinp, uint8_t dscp)
 713 {
 714     bool kernel_chooses_port;
 715     struct sockaddr_in sin;
 716     int fd = 0, error;
 717     unsigned int yes = 1;
 718
 719     if (!inet_parse_passive(target, default_port, &sin)) {
 720         return -EAFNOSUPPORT;
 721     }
 722
 723     /* Create non-blocking socket, set SO_REUSEADDR. */
 724     fd = socket(AF_INET, style, 0);
 725     if (fd < 0) {
 726         error = errno;
 727         VLOG_ERR("%s: socket: %s", target, strerror(error));
 728         return -error;
 729     }
 730     error = set_nonblocking(fd);
 731     if (error) {
 732         goto error;
 733     }
 734     if (style == SOCK_STREAM
 735         && setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof yes) < 0) {
 736         error = errno;
 737         VLOG_ERR("%s: setsockopt(SO_REUSEADDR): %s", target, strerror(error));
 738         goto error;
 739     }
 740
 741     /* Bind. */
 742     if (bind(fd, (struct sockaddr *) &sin, sizeof sin) < 0) {
 743         error = errno;
 744         VLOG_ERR("%s: bind: %s", target, strerror(error));
 745         goto error;
 746     }
 747
 748     /* The dscp bits must be configured before connect() to ensure that the TOS
 749      * field is set during the connection establishment.  If set after
 750      * connect(), the handshake SYN frames will be sent with a TOS of 0. */
 751     error = set_dscp(fd, dscp);
 752     if (error) {
 753         VLOG_ERR("%s: socket: %s", target, strerror(error));
 754         goto error;
 755     }
 756
 757     /* Listen. */
 758     if (style == SOCK_STREAM && listen(fd, 10) < 0) {
 759         error = errno;
 760         VLOG_ERR("%s: listen: %s", target, strerror(error));
 761         goto error;
 762     }
 763
 764     kernel_chooses_port = sin.sin_port == htons(0);
 765     if (sinp || kernel_chooses_port) {
 766         socklen_t sin_len = sizeof sin;
 767         if (getsockname(fd, (struct sockaddr *) &sin, &sin_len) < 0) {
 768             error = errno;
 769             VLOG_ERR("%s: getsockname: %s", target, strerror(error));
 770             goto error;
 771         }
 772         if (sin.sin_family != AF_INET || sin_len != sizeof sin) {
 773             error = EAFNOSUPPORT;
 774             VLOG_ERR("%s: getsockname: invalid socket name", target);
 775             goto error;
 776         }
 777         if (sinp) {
 778             *sinp = sin;
 779         }
 780         if (kernel_chooses_port) {
 781             VLOG_INFO("%s: listening on port %"PRIu16,
 782                       target, ntohs(sin.sin_port));
 783         }
 784     }
 785
 786     return fd;
 787
 788 error:
 789     close(fd);
 790     return -error;
 791 }
 792
 793 /* Returns a readable and writable fd for /dev/null, if successful, otherwise
 794  * a negative errno value.  The caller must not close the returned fd (because
 795  * the same fd will be handed out to subsequent callers). */
 796 int
 797 get_null_fd(void)
 798 {
 799     static int null_fd = -1;
 800     if (null_fd < 0) {
 801         null_fd = open("/dev/null", O_RDWR);
 802         if (null_fd < 0) {
 803             int error = errno;
 804             VLOG_ERR("could not open /dev/null: %s", strerror(error));
 805             return -error;
 806         }
 807     }
 808     return null_fd;
 809 }
 810
 811 int
 812 read_fully(int fd, void *p_, size_t size, size_t *bytes_read)
 813 {
 814     uint8_t *p = p_;
 815
 816     *bytes_read = 0;
 817     while (size > 0) {
 818         ssize_t retval = read(fd, p, size);
 819         if (retval > 0) {
 820             *bytes_read += retval;
 821             size -= retval;
 822             p += retval;
 823         } else if (retval == 0) {
 824             return EOF;
 825         } else if (errno != EINTR) {
 826             return errno;
 827         }
 828     }
 829     return 0;
 830 }
 831
 832 int
 833 write_fully(int fd, const void *p_, size_t size, size_t *bytes_written)
 834 {
 835     const uint8_t *p = p_;
 836
 837     *bytes_written = 0;
 838     while (size > 0) {
 839         ssize_t retval = write(fd, p, size);
 840         if (retval > 0) {
 841             *bytes_written += retval;
 842             size -= retval;
 843             p += retval;
 844         } else if (retval == 0) {
 845             VLOG_WARN("write returned 0");
 846             return EPROTO;
 847         } else if (errno != EINTR) {
 848             return errno;
 849         }
 850     }
 851     return 0;
 852 }
 853
 854 /* Given file name 'file_name', fsyncs the directory in which it is contained.
 855  * Returns 0 if successful, otherwise a positive errno value. */
 856 int
 857 fsync_parent_dir(const char *file_name)
 858 {
 859     int error = 0;
 860     char *dir;
 861     int fd;
 862
 863     dir = dir_name(file_name);
 864     fd = open(dir, O_RDONLY);
 865     if (fd >= 0) {
 866         if (fsync(fd)) {
 867             if (errno == EINVAL || errno == EROFS) {
 868                 /* This directory does not support synchronization.  Not
 869                  * really an error. */
 870             } else {
 871                 error = errno;
 872                 VLOG_ERR("%s: fsync failed (%s)", dir, strerror(error));
 873             }
 874         }
 875         close(fd);
 876     } else {
 877         error = errno;
 878         VLOG_ERR("%s: open failed (%s)", dir, strerror(error));
 879     }
 880     free(dir);
 881
 882     return error;
 883 }
 884
 885 /* Obtains the modification time of the file named 'file_name' to the greatest
 886  * supported precision.  If successful, stores the mtime in '*mtime' and
 887  * returns 0.  On error, returns a positive errno value and stores zeros in
 888  * '*mtime'. */
 889 int
 890 get_mtime(const char *file_name, struct timespec *mtime)
 891 {
 892     struct stat s;
 893
 894     if (!stat(file_name, &s)) {
 895         mtime->tv_sec = s.st_mtime;
 896
 897 #if HAVE_STRUCT_STAT_ST_MTIM_TV_NSEC
 898         mtime->tv_nsec = s.st_mtim.tv_nsec;
 899 #elif HAVE_STRUCT_STAT_ST_MTIMENSEC
 900         mtime->tv_nsec = s.st_mtimensec;
 901 #else
 902         mtime->tv_nsec = 0;
 903 #endif
 904
 905         return 0;
 906     } else {
 907         mtime->tv_sec = mtime->tv_nsec = 0;
 908         return errno;
 909     }
 910 }
 911
 912 void
 913 xpipe(int fds[2])
 914 {
 915     if (pipe(fds)) {
 916         VLOG_FATAL("failed to create pipe (%s)", strerror(errno));
 917     }
 918 }
 919
 920 void
 921 xpipe_nonblocking(int fds[2])
 922 {
 923     xpipe(fds);
 924     xset_nonblocking(fds[0]);
 925     xset_nonblocking(fds[1]);
 926 }
 927
 928 void
 929 xsocketpair(int domain, int type, int protocol, int fds[2])
 930 {
 931     if (socketpair(domain, type, protocol, fds)) {
 932         VLOG_FATAL("failed to create socketpair (%s)", strerror(errno));
 933     }
 934 }
 935
 936 static int
 937 getsockopt_int(int fd, int level, int option, const char *optname, int *valuep)
 938 {
 939     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
 940     socklen_t len;
 941     int value;
 942     int error;
 943
 944     len = sizeof value;
 945     if (getsockopt(fd, level, option, &value, &len)) {
 946         error = errno;
 947         VLOG_ERR_RL(&rl, "getsockopt(%s): %s", optname, strerror(error));
 948     } else if (len != sizeof value) {
 949         error = EINVAL;
 950         VLOG_ERR_RL(&rl, "getsockopt(%s): value is %u bytes (expected %zu)",
 951                     optname, (unsigned int) len, sizeof value);
 952     } else {
 953         error = 0;
 954     }
 955
 956     *valuep = error ? 0 : value;
 957     return error;
 958 }
 959
 960 static void
 961 describe_sockaddr(struct ds *string, int fd,
 962                   int (*getaddr)(int, struct sockaddr *, socklen_t *))
 963 {
 964     struct sockaddr_storage ss;
 965     socklen_t len = sizeof ss;
 966
 967     if (!getaddr(fd, (struct sockaddr *) &ss, &len)) {
 968         if (ss.ss_family == AF_INET) {
 969             struct sockaddr_in sin;
 970
 971             memcpy(&sin, &ss, sizeof sin);
 972             ds_put_format(string, IP_FMT":%"PRIu16,
 973                           IP_ARGS(sin.sin_addr.s_addr), ntohs(sin.sin_port));
 974         } else if (ss.ss_family == AF_UNIX) {
 975             struct sockaddr_un sun;
 976             const char *null;
 977             size_t maxlen;
 978
 979             memcpy(&sun, &ss, sizeof sun);
 980             maxlen = len - offsetof(struct sockaddr_un, sun_path);
 981             null = memchr(sun.sun_path, '\0', maxlen);
 982             ds_put_buffer(string, sun.sun_path,
 983                           null ? null - sun.sun_path : maxlen);
 984         }
 985 #ifdef HAVE_NETLINK
 986         else if (ss.ss_family == AF_NETLINK) {
 987             int protocol;
 988
 989 /* SO_PROTOCOL was introduced in 2.6.32.  Support it regardless of the version
 990  * of the Linux kernel headers in use at build time. */
 991 #ifndef SO_PROTOCOL
 992 #define SO_PROTOCOL 38
 993 #endif
 994
 995             if (!getsockopt_int(fd, SOL_SOCKET, SO_PROTOCOL, "SO_PROTOCOL",
 996                                 &protocol)) {
 997                 switch (protocol) {
 998                 case NETLINK_ROUTE:
 999                     ds_put_cstr(string, "NETLINK_ROUTE");
1000                     break;
1001
1002                 case NETLINK_GENERIC:
1003                     ds_put_cstr(string, "NETLINK_GENERIC");
1004                     break;
1005
1006                 default:
1007                     ds_put_format(string, "AF_NETLINK family %d", protocol);
1008                     break;
1009                 }
1010             } else {
1011                 ds_put_cstr(string, "AF_NETLINK");
1012             }
1013         }
1014 #endif
1015 #if AF_PACKET && LINUX_DATAPATH
1016         else if (ss.ss_family == AF_PACKET) {
1017             struct sockaddr_ll sll;
1018
1019             memcpy(&sll, &ss, sizeof sll);
1020             ds_put_cstr(string, "AF_PACKET");
1021             if (sll.sll_ifindex) {
1022                 char name[IFNAMSIZ];
1023
1024                 if (if_indextoname(sll.sll_ifindex, name)) {
1025                     ds_put_format(string, "(%s)", name);
1026                 } else {
1027                     ds_put_format(string, "(ifindex=%d)", sll.sll_ifindex);
1028                 }
1029             }
1030             if (sll.sll_protocol) {
1031                 ds_put_format(string, "(protocol=0x%"PRIu16")",
1032                               ntohs(sll.sll_protocol));
1033             }
1034         }
1035 #endif
1036         else if (ss.ss_family == AF_UNSPEC) {
1037             ds_put_cstr(string, "AF_UNSPEC");
1038         } else {
1039             ds_put_format(string, "AF_%d", (int) ss.ss_family);
1040         }
1041     }
1042 }
1043
1044
1045 #ifdef LINUX_DATAPATH
1046 static void
1047 put_fd_filename(struct ds *string, int fd)
1048 {
1049     char buf[1024];
1050     char *linkname;
1051     int n;
1052
1053     linkname = xasprintf("/proc/self/fd/%d", fd);
1054     n = readlink(linkname, buf, sizeof buf);
1055     if (n > 0) {
1056         ds_put_char(string, ' ');
1057         ds_put_buffer(string, buf, n);
1058         if (n > sizeof buf) {
1059             ds_put_cstr(string, "...");
1060         }
1061     }
1062     free(linkname);
1063 }
1064 #endif
1065
1066 /* Returns a malloc()'d string describing 'fd', for use in logging. */
1067 char *
1068 describe_fd(int fd)
1069 {
1070     struct ds string;
1071     struct stat s;
1072
1073     ds_init(&string);
1074     if (fstat(fd, &s)) {
1075         ds_put_format(&string, "fstat failed (%s)", strerror(errno));
1076     } else if (S_ISSOCK(s.st_mode)) {
1077         describe_sockaddr(&string, fd, getsockname);
1078         ds_put_cstr(&string, "<->");
1079         describe_sockaddr(&string, fd, getpeername);
1080     } else {
1081         ds_put_cstr(&string, (isatty(fd) ? "tty"
1082                               : S_ISDIR(s.st_mode) ? "directory"
1083                               : S_ISCHR(s.st_mode) ? "character device"
1084                               : S_ISBLK(s.st_mode) ? "block device"
1085                               : S_ISREG(s.st_mode) ? "file"
1086                               : S_ISFIFO(s.st_mode) ? "FIFO"
1087                               : S_ISLNK(s.st_mode) ? "symbolic link"
1088                               : "unknown"));
1089 #ifdef LINUX_DATAPATH
1090         put_fd_filename(&string, fd);
1091 #endif
1092     }
1093     return ds_steal_cstr(&string);
1094 }
1095
1096 /* Returns the total of the 'iov_len' members of the 'n_iovs' in 'iovs'.
1097  * The caller must ensure that the total does not exceed SIZE_MAX. */
1098 size_t
1099 iovec_len(const struct iovec iovs[], size_t n_iovs)
1100 {
1101     size_t len = 0;
1102     size_t i;
1103
1104     for (i = 0; i < n_iovs; i++) {
1105         len += iovs[i].iov_len;
1106     }
1107     return len;
1108 }
1109
1110 /* Returns true if all of the 'n_iovs' iovecs in 'iovs' have length zero. */
1111 bool
1112 iovec_is_empty(const struct iovec iovs[], size_t n_iovs)
1113 {
1114     size_t i;
1115
1116     for (i = 0; i < n_iovs; i++) {
1117         if (iovs[i].iov_len) {
1118             return false;
1119         }
1120     }
1121     return true;
1122 }
1123
1124 /* Sends the 'n_iovs' iovecs of data in 'iovs' and the 'n_fds' file descriptors
1125  * in 'fds' on Unix domain socket 'sock'.  Returns the number of bytes
1126  * successfully sent or -1 if an error occurred.  On error, sets errno
1127  * appropriately.  */
1128 int
1129 send_iovec_and_fds(int sock,
1130                    const struct iovec *iovs, size_t n_iovs,
1131                    const int fds[], size_t n_fds)
1132 {
1133     ovs_assert(sock >= 0);
1134     if (n_fds > 0) {
1135         union {
1136             struct cmsghdr cm;
1137             char control[CMSG_SPACE(SOUTIL_MAX_FDS * sizeof *fds)];
1138         } cmsg;
1139         struct msghdr msg;
1140
1141         ovs_assert(!iovec_is_empty(iovs, n_iovs));
1142         ovs_assert(n_fds <= SOUTIL_MAX_FDS);
1143
1144         memset(&cmsg, 0, sizeof cmsg);
1145         cmsg.cm.cmsg_len = CMSG_LEN(n_fds * sizeof *fds);
1146         cmsg.cm.cmsg_level = SOL_SOCKET;
1147         cmsg.cm.cmsg_type = SCM_RIGHTS;
1148         memcpy(CMSG_DATA(&cmsg.cm), fds, n_fds * sizeof *fds);
1149
1150         msg.msg_name = NULL;
1151         msg.msg_namelen = 0;
1152         msg.msg_iov = CONST_CAST(struct iovec *, iovs);
1153         msg.msg_iovlen = n_iovs;
1154         msg.msg_control = &cmsg.cm;
1155         msg.msg_controllen = CMSG_SPACE(n_fds * sizeof *fds);
1156         msg.msg_flags = 0;
1157
1158         return sendmsg(sock, &msg, 0);
1159     } else {
1160         return writev(sock, iovs, n_iovs);
1161     }
1162 }
1163
1164 /* Sends the 'n_iovs' iovecs of data in 'iovs' and the 'n_fds' file descriptors
1165  * in 'fds' on Unix domain socket 'sock'.  If 'skip_bytes' is nonzero, then the
1166  * first 'skip_bytes' of data in the iovecs are not sent, and none of the file
1167  * descriptors are sent.  The function continues to retry sending until an
1168  * error (other than EINTR) occurs or all the data and fds are sent.
1169  *
1170  * Returns 0 if all the data and fds were successfully sent, otherwise a
1171  * positive errno value.  Regardless of success, stores the number of bytes
1172  * sent (always at least 'skip_bytes') in '*bytes_sent'.  (If at least one byte
1173  * is sent, then all the fds have been sent.)
1174  *
1175  * 'skip_bytes' must be less than or equal to iovec_len(iovs, n_iovs). */
1176 int
1177 send_iovec_and_fds_fully(int sock,
1178                          const struct iovec iovs[], size_t n_iovs,
1179                          const int fds[], size_t n_fds,
1180                          size_t skip_bytes, size_t *bytes_sent)
1181 {
1182     *bytes_sent = 0;
1183     while (n_iovs > 0) {
1184         int retval;
1185
1186         if (skip_bytes) {
1187             retval = skip_bytes;
1188             skip_bytes = 0;
1189         } else if (!*bytes_sent) {
1190             retval = send_iovec_and_fds(sock, iovs, n_iovs, fds, n_fds);
1191         } else {
1192             retval = writev(sock, iovs, n_iovs);
1193         }
1194
1195         if (retval > 0) {
1196             *bytes_sent += retval;
1197             while (retval > 0) {
1198                 const uint8_t *base = iovs->iov_base;
1199                 size_t len = iovs->iov_len;
1200
1201                 if (retval < len) {
1202                     size_t sent;
1203                     int error;
1204
1205                     error = write_fully(sock, base + retval, len - retval,
1206                                         &sent);
1207                     *bytes_sent += sent;
1208                     retval += sent;
1209                     if (error) {
1210                         return error;
1211                     }
1212                 }
1213                 retval -= len;
1214                 iovs++;
1215                 n_iovs--;
1216             }
1217         } else if (retval == 0) {
1218             if (iovec_is_empty(iovs, n_iovs)) {
1219                 break;
1220             }
1221             VLOG_WARN("send returned 0");
1222             return EPROTO;
1223         } else if (errno != EINTR) {
1224             return errno;
1225         }
1226     }
1227
1228     return 0;
1229 }
1230
1231 /* Sends the 'n_iovs' iovecs of data in 'iovs' and the 'n_fds' file descriptors
1232  * in 'fds' on Unix domain socket 'sock'.  The function continues to retry
1233  * sending until an error (other than EAGAIN or EINTR) occurs or all the data
1234  * and fds are sent.  Upon EAGAIN, the function blocks until the socket is
1235  * ready for more data.
1236  *
1237  * Returns 0 if all the data and fds were successfully sent, otherwise a
1238  * positive errno value. */
1239 int
1240 send_iovec_and_fds_fully_block(int sock,
1241                                const struct iovec iovs[], size_t n_iovs,
1242                                const int fds[], size_t n_fds)
1243 {
1244     size_t sent = 0;
1245
1246     for (;;) {
1247         int error;
1248
1249         error = send_iovec_and_fds_fully(sock, iovs, n_iovs,
1250                                          fds, n_fds, sent, &sent);
1251         if (error != EAGAIN) {
1252             return error;
1253         }
1254         poll_fd_wait(sock, POLLOUT);
1255         poll_block();
1256     }
1257 }
1258
1259 /* Attempts to receive from Unix domain socket 'sock' up to 'size' bytes of
1260  * data into 'data' and up to SOUTIL_MAX_FDS file descriptors into 'fds'.
1261  *
1262  *      - Upon success, returns the number of bytes of data copied into 'data'
1263  *        and stores the number of received file descriptors into '*n_fdsp'.
1264  *
1265  *      - On failure, returns a negative errno value and stores 0 in
1266  *        '*n_fdsp'.
1267  *
1268  *      - On EOF, returns 0 and stores 0 in '*n_fdsp'. */
1269 int
1270 recv_data_and_fds(int sock,
1271                   void *data, size_t size,
1272                   int fds[SOUTIL_MAX_FDS], size_t *n_fdsp)
1273 {
1274     union {
1275         struct cmsghdr cm;
1276         char control[CMSG_SPACE(SOUTIL_MAX_FDS * sizeof *fds)];
1277     } cmsg;
1278     struct msghdr msg;
1279     int retval;
1280     struct cmsghdr *p;
1281     size_t i;
1282
1283     *n_fdsp = 0;
1284
1285     do {
1286         struct iovec iov;
1287
1288         iov.iov_base = data;
1289         iov.iov_len = size;
1290
1291         msg.msg_name = NULL;
1292         msg.msg_namelen = 0;
1293         msg.msg_iov = &iov;
1294         msg.msg_iovlen = 1;
1295         msg.msg_control = &cmsg.cm;
1296         msg.msg_controllen = sizeof cmsg.control;
1297         msg.msg_flags = 0;
1298
1299         retval = recvmsg(sock, &msg, 0);
1300     } while (retval < 0 && errno == EINTR);
1301     if (retval <= 0) {
1302         return retval < 0 ? -errno : 0;
1303     }
1304
1305     for (p = CMSG_FIRSTHDR(&msg); p; p = CMSG_NXTHDR(&msg, p)) {
1306         if (p->cmsg_level != SOL_SOCKET || p->cmsg_type != SCM_RIGHTS) {
1307             VLOG_ERR("unexpected control message %d:%d",
1308                      p->cmsg_level, p->cmsg_type);
1309             goto error;
1310         } else if (*n_fdsp) {
1311             VLOG_ERR("multiple SCM_RIGHTS received");
1312             goto error;
1313         } else {
1314             size_t n_fds = (p->cmsg_len - CMSG_LEN(0)) / sizeof *fds;
1315             const int *fds_data = (const int *) CMSG_DATA(p);
1316
1317             ovs_assert(n_fds > 0);
1318             if (n_fds > SOUTIL_MAX_FDS) {
1319                 VLOG_ERR("%zu fds received but only %d supported",
1320                          n_fds, SOUTIL_MAX_FDS);
1321                 for (i = 0; i < n_fds; i++) {
1322                     close(fds_data[i]);
1323                 }
1324                 goto error;
1325             }
1326
1327             *n_fdsp = n_fds;
1328             memcpy(fds, fds_data, n_fds * sizeof *fds);
1329         }
1330     }
1331
1332     return retval;
1333
1334 error:
1335     for (i = 0; i < *n_fdsp; i++) {
1336         close(fds[i]);
1337     }
1338     *n_fdsp = 0;
1339     return EPROTO;
1340 }