lib/socket-util.c

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