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