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