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