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