lib/socket-util.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 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 /* Parses 'target', which should be a string in the format "<host>[:<port>]".
 616  * <host> is required.  If 'default_port' is nonzero then <port> is optional
 617  * and defaults to 'default_port'.
 618  *
 619  * On success, returns true and stores the parsed remote address into '*sinp'.
 620  * On failure, logs an error, stores zeros into '*sinp', and returns false. */
 621 bool
 622 inet_parse_active(const char *target_, uint16_t default_port,
 623                   struct sockaddr_in *sinp)
 624 {
 625     char *target = xstrdup(target_);
 626     char *save_ptr = NULL;
 627     const char *host_name;
 628     const char *port_string;
 629     bool ok = false;
 630
 631     /* Defaults. */
 632     sinp->sin_family = AF_INET;
 633     sinp->sin_port = htons(default_port);
 634
 635     /* Tokenize. */
 636     host_name = strtok_r(target, ":", &save_ptr);
 637     port_string = strtok_r(NULL, ":", &save_ptr);
 638     if (!host_name) {
 639         VLOG_ERR("%s: bad peer name format", target_);
 640         goto exit;
 641     }
 642
 643     /* Look up IP, port. */
 644     if (lookup_ip(host_name, &sinp->sin_addr)) {
 645         goto exit;
 646     }
 647     if (port_string && atoi(port_string)) {
 648         sinp->sin_port = htons(atoi(port_string));
 649     } else if (!default_port) {
 650         VLOG_ERR("%s: port number must be specified", target_);
 651         goto exit;
 652     }
 653
 654     ok = true;
 655
 656 exit:
 657     if (!ok) {
 658         memset(sinp, 0, sizeof *sinp);
 659     }
 660     free(target);
 661     return ok;
 662 }
 663
 664 /* Opens a non-blocking IPv4 socket of the specified 'style' and connects to
 665  * 'target', which should be a string in the format "<host>[:<port>]".  <host>
 666  * is required.  If 'default_port' is nonzero then <port> is optional and
 667  * defaults to 'default_port'.
 668  *
 669  * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
 670  *
 671  * On success, returns 0 (indicating connection complete) or EAGAIN (indicating
 672  * connection in progress), in which case the new file descriptor is stored
 673  * into '*fdp'.  On failure, returns a positive errno value other than EAGAIN
 674  * and stores -1 into '*fdp'.
 675  *
 676  * If 'sinp' is non-null, then on success the target address is stored into
 677  * '*sinp'.
 678  *
 679  * 'dscp' becomes the DSCP bits in the IP headers for the new connection.  It
 680  * should be in the range [0, 63] and will automatically be shifted to the
 681  * appropriately place in the IP tos field. */
 682 int
 683 inet_open_active(int style, const char *target, uint16_t default_port,
 684                  struct sockaddr_in *sinp, int *fdp, uint8_t dscp)
 685 {
 686     struct sockaddr_in sin;
 687     int fd = -1;
 688     int error;
 689
 690     /* Parse. */
 691     if (!inet_parse_active(target, default_port, &sin)) {
 692         error = EAFNOSUPPORT;
 693         goto exit;
 694     }
 695
 696     /* Create non-blocking socket. */
 697     fd = socket(AF_INET, style, 0);
 698     if (fd < 0) {
 699         VLOG_ERR("%s: socket: %s", target, ovs_strerror(errno));
 700         error = errno;
 701         goto exit;
 702     }
 703     error = set_nonblocking(fd);
 704     if (error) {
 705         goto exit;
 706     }
 707
 708     /* The dscp bits must be configured before connect() to ensure that the TOS
 709      * field is set during the connection establishment.  If set after
 710      * connect(), the handshake SYN frames will be sent with a TOS of 0. */
 711     error = set_dscp(fd, dscp);
 712     if (error) {
 713         VLOG_ERR("%s: socket: %s", target, ovs_strerror(error));
 714         goto exit;
 715     }
 716
 717     /* Connect. */
 718     error = connect(fd, (struct sockaddr *) &sin, sizeof sin) == 0 ? 0 : errno;
 719     if (error == EINPROGRESS) {
 720         error = EAGAIN;
 721     }
 722
 723 exit:
 724     if (!error || error == EAGAIN) {
 725         if (sinp) {
 726             *sinp = sin;
 727         }
 728     } else if (fd >= 0) {
 729         close(fd);
 730         fd = -1;
 731     }
 732     *fdp = fd;
 733     return error;
 734 }
 735
 736 /* Parses 'target', which should be a string in the format "[<port>][:<ip>]":
 737  *
 738  *      - If 'default_port' is -1, then <port> is required.  Otherwise, if
 739  *        <port> is omitted, then 'default_port' is used instead.
 740  *
 741  *      - If <port> (or 'default_port', if used) is 0, then no port is bound
 742  *        and the TCP/IP stack will select a port.
 743  *
 744  *      - If <ip> is omitted then the IP address is wildcarded.
 745  *
 746  * If successful, stores the address into '*sinp' and returns true; otherwise
 747  * zeros '*sinp' and returns false. */
 748 bool
 749 inet_parse_passive(const char *target_, int default_port,
 750                    struct sockaddr_in *sinp)
 751 {
 752     char *target = xstrdup(target_);
 753     char *string_ptr = target;
 754     const char *host_name;
 755     const char *port_string;
 756     bool ok = false;
 757     int port;
 758
 759     /* Address defaults. */
 760     memset(sinp, 0, sizeof *sinp);
 761     sinp->sin_family = AF_INET;
 762     sinp->sin_addr.s_addr = htonl(INADDR_ANY);
 763     sinp->sin_port = htons(default_port);
 764
 765     /* Parse optional port number. */
 766     port_string = strsep(&string_ptr, ":");
 767     if (port_string && str_to_int(port_string, 10, &port)) {
 768         sinp->sin_port = htons(port);
 769     } else if (default_port < 0) {
 770         VLOG_ERR("%s: port number must be specified", target_);
 771         goto exit;
 772     }
 773
 774     /* Parse optional bind IP. */
 775     host_name = strsep(&string_ptr, ":");
 776     if (host_name && host_name[0] && lookup_ip(host_name, &sinp->sin_addr)) {
 777         goto exit;
 778     }
 779
 780     ok = true;
 781
 782 exit:
 783     if (!ok) {
 784         memset(sinp, 0, sizeof *sinp);
 785     }
 786     free(target);
 787     return ok;
 788 }
 789
 790
 791 /* Opens a non-blocking IPv4 socket of the specified 'style', binds to
 792  * 'target', and listens for incoming connections.  Parses 'target' in the same
 793  * way was inet_parse_passive().
 794  *
 795  * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
 796  *
 797  * For TCP, the socket will have SO_REUSEADDR turned on.
 798  *
 799  * On success, returns a non-negative file descriptor.  On failure, returns a
 800  * negative errno value.
 801  *
 802  * If 'sinp' is non-null, then on success the bound address is stored into
 803  * '*sinp'.
 804  *
 805  * 'dscp' becomes the DSCP bits in the IP headers for the new connection.  It
 806  * should be in the range [0, 63] and will automatically be shifted to the
 807  * appropriately place in the IP tos field. */
 808 int
 809 inet_open_passive(int style, const char *target, int default_port,
 810                   struct sockaddr_in *sinp, uint8_t dscp)
 811 {
 812     bool kernel_chooses_port;
 813     struct sockaddr_in sin;
 814     int fd = 0, error;
 815     unsigned int yes = 1;
 816
 817     if (!inet_parse_passive(target, default_port, &sin)) {
 818         return -EAFNOSUPPORT;
 819     }
 820
 821     /* Create non-blocking socket, set SO_REUSEADDR. */
 822     fd = socket(AF_INET, style, 0);
 823     if (fd < 0) {
 824         error = errno;
 825         VLOG_ERR("%s: socket: %s", target, ovs_strerror(error));
 826         return -error;
 827     }
 828     error = set_nonblocking(fd);
 829     if (error) {
 830         goto error;
 831     }
 832     if (style == SOCK_STREAM
 833         && setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof yes) < 0) {
 834         error = errno;
 835         VLOG_ERR("%s: setsockopt(SO_REUSEADDR): %s",
 836                  target, ovs_strerror(error));
 837         goto error;
 838     }
 839
 840     /* Bind. */
 841     if (bind(fd, (struct sockaddr *) &sin, sizeof sin) < 0) {
 842         error = errno;
 843         VLOG_ERR("%s: bind: %s", target, ovs_strerror(error));
 844         goto error;
 845     }
 846
 847     /* The dscp bits must be configured before connect() to ensure that the TOS
 848      * field is set during the connection establishment.  If set after
 849      * connect(), the handshake SYN frames will be sent with a TOS of 0. */
 850     error = set_dscp(fd, dscp);
 851     if (error) {
 852         VLOG_ERR("%s: socket: %s", target, ovs_strerror(error));
 853         goto error;
 854     }
 855
 856     /* Listen. */
 857     if (style == SOCK_STREAM && listen(fd, 10) < 0) {
 858         error = errno;
 859         VLOG_ERR("%s: listen: %s", target, ovs_strerror(error));
 860         goto error;
 861     }
 862
 863     kernel_chooses_port = sin.sin_port == htons(0);
 864     if (sinp || kernel_chooses_port) {
 865         socklen_t sin_len = sizeof sin;
 866         if (getsockname(fd, (struct sockaddr *) &sin, &sin_len) < 0) {
 867             error = errno;
 868             VLOG_ERR("%s: getsockname: %s", target, ovs_strerror(error));
 869             goto error;
 870         }
 871         if (sin.sin_family != AF_INET || sin_len != sizeof sin) {
 872             error = EAFNOSUPPORT;
 873             VLOG_ERR("%s: getsockname: invalid socket name", target);
 874             goto error;
 875         }
 876         if (sinp) {
 877             *sinp = sin;
 878         }
 879         if (kernel_chooses_port) {
 880             VLOG_INFO("%s: listening on port %"PRIu16,
 881                       target, ntohs(sin.sin_port));
 882         }
 883     }
 884
 885     return fd;
 886
 887 error:
 888     close(fd);
 889     return -error;
 890 }
 891
 892 /* Returns a readable and writable fd for /dev/null, if successful, otherwise
 893  * a negative errno value.  The caller must not close the returned fd (because
 894  * the same fd will be handed out to subsequent callers). */
 895 int
 896 get_null_fd(void)
 897 {
 898     static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
 899     static int null_fd;
 900
 901     if (ovsthread_once_start(&once)) {
 902         null_fd = open("/dev/null", O_RDWR);
 903         if (null_fd < 0) {
 904             int error = errno;
 905             VLOG_ERR("could not open /dev/null: %s", ovs_strerror(error));
 906             null_fd = -error;
 907         }
 908         ovsthread_once_done(&once);
 909     }
 910
 911     return null_fd;
 912 }
 913
 914 int
 915 read_fully(int fd, void *p_, size_t size, size_t *bytes_read)
 916 {
 917     uint8_t *p = p_;
 918
 919     *bytes_read = 0;
 920     while (size > 0) {
 921         ssize_t retval = read(fd, p, size);
 922         if (retval > 0) {
 923             *bytes_read += retval;
 924             size -= retval;
 925             p += retval;
 926         } else if (retval == 0) {
 927             return EOF;
 928         } else if (errno != EINTR) {
 929             return errno;
 930         }
 931     }
 932     return 0;
 933 }
 934
 935 int
 936 write_fully(int fd, const void *p_, size_t size, size_t *bytes_written)
 937 {
 938     const uint8_t *p = p_;
 939
 940     *bytes_written = 0;
 941     while (size > 0) {
 942         ssize_t retval = write(fd, p, size);
 943         if (retval > 0) {
 944             *bytes_written += retval;
 945             size -= retval;
 946             p += retval;
 947         } else if (retval == 0) {
 948             VLOG_WARN("write returned 0");
 949             return EPROTO;
 950         } else if (errno != EINTR) {
 951             return errno;
 952         }
 953     }
 954     return 0;
 955 }
 956
 957 /* Given file name 'file_name', fsyncs the directory in which it is contained.
 958  * Returns 0 if successful, otherwise a positive errno value. */
 959 int
 960 fsync_parent_dir(const char *file_name)
 961 {
 962     int error = 0;
 963     char *dir;
 964     int fd;
 965
 966     dir = dir_name(file_name);
 967     fd = open(dir, O_RDONLY);
 968     if (fd >= 0) {
 969         if (fsync(fd)) {
 970             if (errno == EINVAL || errno == EROFS) {
 971                 /* This directory does not support synchronization.  Not
 972                  * really an error. */
 973             } else {
 974                 error = errno;
 975                 VLOG_ERR("%s: fsync failed (%s)", dir, ovs_strerror(error));
 976             }
 977         }
 978         close(fd);
 979     } else {
 980         error = errno;
 981         VLOG_ERR("%s: open failed (%s)", dir, ovs_strerror(error));
 982     }
 983     free(dir);
 984
 985     return error;
 986 }
 987
 988 /* Obtains the modification time of the file named 'file_name' to the greatest
 989  * supported precision.  If successful, stores the mtime in '*mtime' and
 990  * returns 0.  On error, returns a positive errno value and stores zeros in
 991  * '*mtime'. */
 992 int
 993 get_mtime(const char *file_name, struct timespec *mtime)
 994 {
 995     struct stat s;
 996
 997     if (!stat(file_name, &s)) {
 998         mtime->tv_sec = s.st_mtime;
 999
1000 #if HAVE_STRUCT_STAT_ST_MTIM_TV_NSEC
1001         mtime->tv_nsec = s.st_mtim.tv_nsec;
1002 #elif HAVE_STRUCT_STAT_ST_MTIMENSEC
1003         mtime->tv_nsec = s.st_mtimensec;
1004 #else
1005         mtime->tv_nsec = 0;
1006 #endif
1007
1008         return 0;
1009     } else {
1010         mtime->tv_sec = mtime->tv_nsec = 0;
1011         return errno;
1012     }
1013 }
1014
1015 void
1016 xpipe(int fds[2])
1017 {
1018     if (pipe(fds)) {
1019         VLOG_FATAL("failed to create pipe (%s)", ovs_strerror(errno));
1020     }
1021 }
1022
1023 void
1024 xpipe_nonblocking(int fds[2])
1025 {
1026     xpipe(fds);
1027     xset_nonblocking(fds[0]);
1028     xset_nonblocking(fds[1]);
1029 }
1030
1031 static int
1032 getsockopt_int(int fd, int level, int option, const char *optname, int *valuep)
1033 {
1034     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
1035     socklen_t len;
1036     int value;
1037     int error;
1038
1039     len = sizeof value;
1040     if (getsockopt(fd, level, option, &value, &len)) {
1041         error = errno;
1042         VLOG_ERR_RL(&rl, "getsockopt(%s): %s", optname, ovs_strerror(error));
1043     } else if (len != sizeof value) {
1044         error = EINVAL;
1045         VLOG_ERR_RL(&rl, "getsockopt(%s): value is %u bytes (expected %"PRIuSIZE")",
1046                     optname, (unsigned int) len, sizeof value);
1047     } else {
1048         error = 0;
1049     }
1050
1051     *valuep = error ? 0 : value;
1052     return error;
1053 }
1054
1055 static void
1056 describe_sockaddr(struct ds *string, int fd,
1057                   int (*getaddr)(int, struct sockaddr *, socklen_t *))
1058 {
1059     struct sockaddr_storage ss;
1060     socklen_t len = sizeof ss;
1061
1062     if (!getaddr(fd, (struct sockaddr *) &ss, &len)) {
1063         if (ss.ss_family == AF_INET) {
1064             struct sockaddr_in sin;
1065
1066             memcpy(&sin, &ss, sizeof sin);
1067             ds_put_format(string, IP_FMT":%"PRIu16,
1068                           IP_ARGS(sin.sin_addr.s_addr), ntohs(sin.sin_port));
1069         } else if (ss.ss_family == AF_UNIX) {
1070             struct sockaddr_un sun;
1071             const char *null;
1072             size_t maxlen;
1073
1074             memcpy(&sun, &ss, sizeof sun);
1075             maxlen = len - offsetof(struct sockaddr_un, sun_path);
1076             null = memchr(sun.sun_path, '\0', maxlen);
1077             ds_put_buffer(string, sun.sun_path,
1078                           null ? null - sun.sun_path : maxlen);
1079         }
1080 #ifdef HAVE_NETLINK
1081         else if (ss.ss_family == AF_NETLINK) {
1082             int protocol;
1083
1084 /* SO_PROTOCOL was introduced in 2.6.32.  Support it regardless of the version
1085  * of the Linux kernel headers in use at build time. */
1086 #ifndef SO_PROTOCOL
1087 #define SO_PROTOCOL 38
1088 #endif
1089
1090             if (!getsockopt_int(fd, SOL_SOCKET, SO_PROTOCOL, "SO_PROTOCOL",
1091                                 &protocol)) {
1092                 switch (protocol) {
1093                 case NETLINK_ROUTE:
1094                     ds_put_cstr(string, "NETLINK_ROUTE");
1095                     break;
1096
1097                 case NETLINK_GENERIC:
1098                     ds_put_cstr(string, "NETLINK_GENERIC");
1099                     break;
1100
1101                 default:
1102                     ds_put_format(string, "AF_NETLINK family %d", protocol);
1103                     break;
1104                 }
1105             } else {
1106                 ds_put_cstr(string, "AF_NETLINK");
1107             }
1108         }
1109 #endif
1110 #if AF_PACKET && LINUX_DATAPATH
1111         else if (ss.ss_family == AF_PACKET) {
1112             struct sockaddr_ll sll;
1113
1114             memcpy(&sll, &ss, sizeof sll);
1115             ds_put_cstr(string, "AF_PACKET");
1116             if (sll.sll_ifindex) {
1117                 char name[IFNAMSIZ];
1118
1119                 if (if_indextoname(sll.sll_ifindex, name)) {
1120                     ds_put_format(string, "(%s)", name);
1121                 } else {
1122                     ds_put_format(string, "(ifindex=%d)", sll.sll_ifindex);
1123                 }
1124             }
1125             if (sll.sll_protocol) {
1126                 ds_put_format(string, "(protocol=0x%"PRIu16")",
1127                               ntohs(sll.sll_protocol));
1128             }
1129         }
1130 #endif
1131         else if (ss.ss_family == AF_UNSPEC) {
1132             ds_put_cstr(string, "AF_UNSPEC");
1133         } else {
1134             ds_put_format(string, "AF_%d", (int) ss.ss_family);
1135         }
1136     }
1137 }
1138
1139
1140 #ifdef LINUX_DATAPATH
1141 static void
1142 put_fd_filename(struct ds *string, int fd)
1143 {
1144     char buf[1024];
1145     char *linkname;
1146     int n;
1147
1148     linkname = xasprintf("/proc/self/fd/%d", fd);
1149     n = readlink(linkname, buf, sizeof buf);
1150     if (n > 0) {
1151         ds_put_char(string, ' ');
1152         ds_put_buffer(string, buf, n);
1153         if (n > sizeof buf) {
1154             ds_put_cstr(string, "...");
1155         }
1156     }
1157     free(linkname);
1158 }
1159 #endif
1160
1161 /* Returns a malloc()'d string describing 'fd', for use in logging. */
1162 char *
1163 describe_fd(int fd)
1164 {
1165     struct ds string;
1166     struct stat s;
1167
1168     ds_init(&string);
1169     if (fstat(fd, &s)) {
1170         ds_put_format(&string, "fstat failed (%s)", ovs_strerror(errno));
1171     } else if (S_ISSOCK(s.st_mode)) {
1172         describe_sockaddr(&string, fd, getsockname);
1173         ds_put_cstr(&string, "<->");
1174         describe_sockaddr(&string, fd, getpeername);
1175     } else {
1176         ds_put_cstr(&string, (isatty(fd) ? "tty"
1177                               : S_ISDIR(s.st_mode) ? "directory"
1178                               : S_ISCHR(s.st_mode) ? "character device"
1179                               : S_ISBLK(s.st_mode) ? "block device"
1180                               : S_ISREG(s.st_mode) ? "file"
1181                               : S_ISFIFO(s.st_mode) ? "FIFO"
1182                               : S_ISLNK(s.st_mode) ? "symbolic link"
1183                               : "unknown"));
1184 #ifdef LINUX_DATAPATH
1185         put_fd_filename(&string, fd);
1186 #endif
1187     }
1188     return ds_steal_cstr(&string);
1189 }
1190
1191 /* Calls ioctl() on an AF_INET sock, passing the specified 'command' and
1192  * 'arg'.  Returns 0 if successful, otherwise a positive errno value. */
1193 int
1194 af_inet_ioctl(unsigned long int command, const void *arg)
1195 {
1196     static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
1197     static int sock;
1198
1199     if (ovsthread_once_start(&once)) {
1200         sock = socket(AF_INET, SOCK_DGRAM, 0);
1201         if (sock < 0) {
1202             sock = -errno;
1203             VLOG_ERR("failed to create inet socket: %s", ovs_strerror(errno));
1204         }
1205         ovsthread_once_done(&once);
1206     }
1207
1208     return (sock < 0 ? -sock
1209             : ioctl(sock, command, arg) == -1 ? errno
1210             : 0);
1211 }
1212
1213 int
1214 af_inet_ifreq_ioctl(const char *name, struct ifreq *ifr, unsigned long int cmd,
1215                     const char *cmd_name)
1216 {
1217     int error;
1218
1219     ovs_strzcpy(ifr->ifr_name, name, sizeof ifr->ifr_name);
1220     error = af_inet_ioctl(cmd, ifr);
1221     if (error) {
1222         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
1223         VLOG_DBG_RL(&rl, "%s: ioctl(%s) failed: %s", name, cmd_name,
1224                     ovs_strerror(error));
1225     }
1226     return error;
1227 }
1228