lib/socket-util.c

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