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