lib/socket-util.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
   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/resource.h>
  30 #include <sys/socket.h>
  31 #include <sys/stat.h>
  32 #include <sys/un.h>
  33 #include <unistd.h>
  34 #include "dynamic-string.h"
  35 #include "fatal-signal.h"
  36 #include "packets.h"
  37 #include "util.h"
  38 #include "vlog.h"
  39 #if AF_PACKET && __linux__
  40 #include <linux/if_packet.h>
  41 #endif
  42 #ifdef HAVE_NETLINK
  43 #include "netlink-protocol.h"
  44 #include "netlink-socket.h"
  45 #endif
  46
  47 VLOG_DEFINE_THIS_MODULE(socket_util);
  48
  49 /* #ifdefs make it a pain to maintain code: you have to try to build both ways.
  50  * Thus, this file compiles all of the code regardless of the target, by
  51  * writing "if (LINUX)" instead of "#ifdef __linux__". */
  52 #ifdef __linux__
  53 #define LINUX 1
  54 #else
  55 #define LINUX 0
  56 #endif
  57
  58 #ifndef O_DIRECTORY
  59 #define O_DIRECTORY 0
  60 #endif
  61
  62 static int getsockopt_int(int fd, int level, int option, const char *optname,
  63                           int *valuep);
  64
  65 /* Sets 'fd' to non-blocking mode.  Returns 0 if successful, otherwise a
  66  * positive errno value. */
  67 int
  68 set_nonblocking(int fd)
  69 {
  70     int flags = fcntl(fd, F_GETFL, 0);
  71     if (flags != -1) {
  72         if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) != -1) {
  73             return 0;
  74         } else {
  75             VLOG_ERR("fcntl(F_SETFL) failed: %s", strerror(errno));
  76             return errno;
  77         }
  78     } else {
  79         VLOG_ERR("fcntl(F_GETFL) failed: %s", strerror(errno));
  80         return errno;
  81     }
  82 }
  83
  84 static bool
  85 rlim_is_finite(rlim_t limit)
  86 {
  87     if (limit == RLIM_INFINITY) {
  88         return false;
  89     }
  90
  91 #ifdef RLIM_SAVED_CUR           /* FreeBSD 8.0 lacks RLIM_SAVED_CUR. */
  92     if (limit == RLIM_SAVED_CUR) {
  93         return false;
  94     }
  95 #endif
  96
  97 #ifdef RLIM_SAVED_MAX           /* FreeBSD 8.0 lacks RLIM_SAVED_MAX. */
  98     if (limit == RLIM_SAVED_MAX) {
  99         return false;
 100     }
 101 #endif
 102
 103     return true;
 104 }
 105
 106 /* Returns the maximum valid FD value, plus 1. */
 107 int
 108 get_max_fds(void)
 109 {
 110     static int max_fds = -1;
 111     if (max_fds < 0) {
 112         struct rlimit r;
 113         if (!getrlimit(RLIMIT_NOFILE, &r) && rlim_is_finite(r.rlim_cur)) {
 114             max_fds = r.rlim_cur;
 115         } else {
 116             VLOG_WARN("failed to obtain fd limit, defaulting to 1024");
 117             max_fds = 1024;
 118         }
 119     }
 120     return max_fds;
 121 }
 122
 123 /* Translates 'host_name', which must be a string representation of an IP
 124  * address, into a numeric IP address in '*addr'.  Returns 0 if successful,
 125  * otherwise a positive errno value. */
 126 int
 127 lookup_ip(const char *host_name, struct in_addr *addr)
 128 {
 129     if (!inet_aton(host_name, addr)) {
 130         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 131         VLOG_ERR_RL(&rl, "\"%s\" is not a valid IP address", host_name);
 132         return ENOENT;
 133     }
 134     return 0;
 135 }
 136
 137 /* Translates 'host_name', which must be a string representation of an IPv6
 138  * address, into a numeric IPv6 address in '*addr'.  Returns 0 if successful,
 139  * otherwise a positive errno value. */
 140 int
 141 lookup_ipv6(const char *host_name, struct in6_addr *addr)
 142 {
 143     if (inet_pton(AF_INET6, host_name, addr) != 1) {
 144         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 145         VLOG_ERR_RL(&rl, "\"%s\" is not a valid IPv6 address", host_name);
 146         return ENOENT;
 147     }
 148     return 0;
 149 }
 150
 151 /* Translates 'host_name', which must be a host name or a string representation
 152  * of an IP address, into a numeric IP address in '*addr'.  Returns 0 if
 153  * successful, otherwise a positive errno value.
 154  *
 155  * Most Open vSwitch code should not use this because it causes deadlocks:
 156  * gethostbyname() sends out a DNS request but that starts a new flow for which
 157  * OVS must set up a flow, but it can't because it's waiting for a DNS reply.
 158  * The synchronous lookup also delays other activty.  (Of course we can solve
 159  * this but it doesn't seem worthwhile quite yet.)  */
 160 int
 161 lookup_hostname(const char *host_name, struct in_addr *addr)
 162 {
 163     struct hostent *h;
 164
 165     if (inet_aton(host_name, addr)) {
 166         return 0;
 167     }
 168
 169     h = gethostbyname(host_name);
 170     if (h) {
 171         *addr = *(struct in_addr *) h->h_addr;
 172         return 0;
 173     }
 174
 175     return (h_errno == HOST_NOT_FOUND ? ENOENT
 176             : h_errno == TRY_AGAIN ? EAGAIN
 177             : h_errno == NO_RECOVERY ? EIO
 178             : h_errno == NO_ADDRESS ? ENXIO
 179             : EINVAL);
 180 }
 181
 182 /* Returns the error condition associated with socket 'fd' and resets the
 183  * socket's error status. */
 184 int
 185 get_socket_error(int fd)
 186 {
 187     int error;
 188
 189     if (getsockopt_int(fd, SOL_SOCKET, SO_ERROR, "SO_ERROR", &error)) {
 190         error = errno;
 191     }
 192     return error;
 193 }
 194
 195 int
 196 check_connection_completion(int fd)
 197 {
 198     struct pollfd pfd;
 199     int retval;
 200
 201     pfd.fd = fd;
 202     pfd.events = POLLOUT;
 203     do {
 204         retval = poll(&pfd, 1, 0);
 205     } while (retval < 0 && errno == EINTR);
 206     if (retval == 1) {
 207         return get_socket_error(fd);
 208     } else if (retval < 0) {
 209         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
 210         VLOG_ERR_RL(&rl, "poll: %s", strerror(errno));
 211         return errno;
 212     } else {
 213         return EAGAIN;
 214     }
 215 }
 216
 217 /* Drain all the data currently in the receive queue of a datagram socket (and
 218  * possibly additional data).  There is no way to know how many packets are in
 219  * the receive queue, but we do know that the total number of bytes queued does
 220  * not exceed the receive buffer size, so we pull packets until none are left
 221  * or we've read that many bytes. */
 222 int
 223 drain_rcvbuf(int fd)
 224 {
 225     int rcvbuf;
 226
 227     rcvbuf = get_socket_rcvbuf(fd);
 228     if (rcvbuf < 0) {
 229         return -rcvbuf;
 230     }
 231
 232     while (rcvbuf > 0) {
 233         /* In Linux, specifying MSG_TRUNC in the flags argument causes the
 234          * datagram length to be returned, even if that is longer than the
 235          * buffer provided.  Thus, we can use a 1-byte buffer to discard the
 236          * incoming datagram and still be able to account how many bytes were
 237          * removed from the receive buffer.
 238          *
 239          * On other Unix-like OSes, MSG_TRUNC has no effect in the flags
 240          * argument. */
 241         char buffer[LINUX ? 1 : 2048];
 242         ssize_t n_bytes = recv(fd, buffer, sizeof buffer,
 243                                MSG_TRUNC | MSG_DONTWAIT);
 244         if (n_bytes <= 0 || n_bytes >= rcvbuf) {
 245             break;
 246         }
 247         rcvbuf -= n_bytes;
 248     }
 249     return 0;
 250 }
 251
 252 /* Returns the size of socket 'sock''s receive buffer (SO_RCVBUF), or a
 253  * negative errno value if an error occurs. */
 254 int
 255 get_socket_rcvbuf(int sock)
 256 {
 257     int rcvbuf;
 258     int error;
 259
 260     error = getsockopt_int(sock, SOL_SOCKET, SO_RCVBUF, "SO_RCVBUF", &rcvbuf);
 261     return error ? -error : rcvbuf;
 262 }
 263
 264 /* Reads and discards up to 'n' datagrams from 'fd', stopping as soon as no
 265  * more data can be immediately read.  ('fd' should therefore be in
 266  * non-blocking mode.)*/
 267 void
 268 drain_fd(int fd, size_t n_packets)
 269 {
 270     for (; n_packets > 0; n_packets--) {
 271         /* 'buffer' only needs to be 1 byte long in most circumstances.  This
 272          * size is defensive against the possibility that we someday want to
 273          * use a Linux tap device without TUN_NO_PI, in which case a buffer
 274          * smaller than sizeof(struct tun_pi) will give EINVAL on read. */
 275         char buffer[128];
 276         if (read(fd, buffer, sizeof buffer) <= 0) {
 277             break;
 278         }
 279     }
 280 }
 281
 282 /* Stores in '*un' a sockaddr_un that refers to file 'name'.  Stores in
 283  * '*un_len' the size of the sockaddr_un. */
 284 static void
 285 make_sockaddr_un__(const char *name, struct sockaddr_un *un, socklen_t *un_len)
 286 {
 287     un->sun_family = AF_UNIX;
 288     ovs_strzcpy(un->sun_path, name, sizeof un->sun_path);
 289     *un_len = (offsetof(struct sockaddr_un, sun_path)
 290                 + strlen (un->sun_path) + 1);
 291 }
 292
 293 /* Stores in '*un' a sockaddr_un that refers to file 'name'.  Stores in
 294  * '*un_len' the size of the sockaddr_un.
 295  *
 296  * Returns 0 on success, otherwise a positive errno value.  On success,
 297  * '*dirfdp' is either -1 or a nonnegative file descriptor that the caller
 298  * should close after using '*un' to bind or connect.  On failure, '*dirfdp' is
 299  * -1. */
 300 static int
 301 make_sockaddr_un(const char *name, struct sockaddr_un *un, socklen_t *un_len,
 302                  int *dirfdp)
 303 {
 304     enum { MAX_UN_LEN = sizeof un->sun_path - 1 };
 305
 306     *dirfdp = -1;
 307     if (strlen(name) > MAX_UN_LEN) {
 308         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
 309
 310         if (LINUX) {
 311             /* 'name' is too long to fit in a sockaddr_un, but we have a
 312              * workaround for that on Linux: shorten it by opening a file
 313              * descriptor for the directory part of the name and indirecting
 314              * through /proc/self/fd/<dirfd>/<basename>. */
 315             char *dir, *base;
 316             char *short_name;
 317             int dirfd;
 318
 319             dir = dir_name(name);
 320             base = base_name(name);
 321
 322             dirfd = open(dir, O_DIRECTORY | O_RDONLY);
 323             if (dirfd < 0) {
 324                 free(base);
 325                 free(dir);
 326                 return errno;
 327             }
 328
 329             short_name = xasprintf("/proc/self/fd/%d/%s", dirfd, base);
 330             free(dir);
 331             free(base);
 332
 333             if (strlen(short_name) <= MAX_UN_LEN) {
 334                 make_sockaddr_un__(short_name, un, un_len);
 335                 free(short_name);
 336                 *dirfdp = dirfd;
 337                 return 0;
 338             }
 339             free(short_name);
 340             close(dirfd);
 341
 342             VLOG_WARN_RL(&rl, "Unix socket name %s is longer than maximum "
 343                          "%d bytes (even shortened)", name, MAX_UN_LEN);
 344         } else {
 345             /* 'name' is too long and we have no workaround. */
 346             VLOG_WARN_RL(&rl, "Unix socket name %s is longer than maximum "
 347                          "%d bytes", name, MAX_UN_LEN);
 348         }
 349
 350         return ENAMETOOLONG;
 351     } else {
 352         make_sockaddr_un__(name, un, un_len);
 353         return 0;
 354     }
 355 }
 356
 357 /* Binds Unix domain socket 'fd' to a file with permissions 0700. */
 358 static int
 359 bind_unix_socket(int fd, struct sockaddr *sun, socklen_t sun_len)
 360 {
 361     /* According to _Unix Network Programming_, umask should affect bind(). */
 362     mode_t old_umask = umask(0077);
 363     int error = bind(fd, sun, sun_len) ? errno : 0;
 364     umask(old_umask);
 365     return error;
 366 }
 367
 368 /* Creates a Unix domain socket in the given 'style' (either SOCK_DGRAM or
 369  * SOCK_STREAM) that is bound to '*bind_path' (if 'bind_path' is non-null) and
 370  * connected to '*connect_path' (if 'connect_path' is non-null).  If 'nonblock'
 371  * is true, the socket is made non-blocking.  If 'passcred' is true, the socket
 372  * is configured to receive SCM_CREDENTIALS control messages.
 373  *
 374  * Returns the socket's fd if successful, otherwise a negative errno value. */
 375 int
 376 make_unix_socket(int style, bool nonblock, bool passcred OVS_UNUSED,
 377                  const char *bind_path, const char *connect_path)
 378 {
 379     int error;
 380     int fd;
 381
 382     fd = socket(PF_UNIX, style, 0);
 383     if (fd < 0) {
 384         return -errno;
 385     }
 386
 387     /* Set nonblocking mode right away, if we want it.  This prevents blocking
 388      * in connect(), if connect_path != NULL.  (In turn, that's a corner case:
 389      * it will only happen if style is SOCK_STREAM or SOCK_SEQPACKET, and only
 390      * if a backlog of un-accepted connections has built up in the kernel.)  */
 391     if (nonblock) {
 392         int flags = fcntl(fd, F_GETFL, 0);
 393         if (flags == -1) {
 394             error = errno;
 395             goto error;
 396         }
 397         if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) == -1) {
 398             error = errno;
 399             goto error;
 400         }
 401     }
 402
 403     if (bind_path) {
 404         struct sockaddr_un un;
 405         socklen_t un_len;
 406         int dirfd;
 407
 408         if (unlink(bind_path) && errno != ENOENT) {
 409             VLOG_WARN("unlinking \"%s\": %s\n", bind_path, strerror(errno));
 410         }
 411         fatal_signal_add_file_to_unlink(bind_path);
 412
 413         error = make_sockaddr_un(bind_path, &un, &un_len, &dirfd);
 414         if (!error) {
 415             error = bind_unix_socket(fd, (struct sockaddr *) &un, un_len);
 416         }
 417         if (dirfd >= 0) {
 418             close(dirfd);
 419         }
 420         if (error) {
 421             goto error;
 422         }
 423     }
 424
 425     if (connect_path) {
 426         struct sockaddr_un un;
 427         socklen_t un_len;
 428         int dirfd;
 429
 430         error = make_sockaddr_un(connect_path, &un, &un_len, &dirfd);
 431         if (!error
 432             && connect(fd, (struct sockaddr*) &un, un_len)
 433             && errno != EINPROGRESS) {
 434             error = errno;
 435         }
 436         if (dirfd >= 0) {
 437             close(dirfd);
 438         }
 439         if (error) {
 440             goto error;
 441         }
 442     }
 443
 444 #ifdef SCM_CREDENTIALS
 445     if (passcred) {
 446         int enable = 1;
 447         if (setsockopt(fd, SOL_SOCKET, SO_PASSCRED, &enable, sizeof(enable))) {
 448             error = errno;
 449             goto error;
 450         }
 451     }
 452 #endif
 453
 454     return fd;
 455
 456 error:
 457     if (error == EAGAIN) {
 458         error = EPROTO;
 459     }
 460     if (bind_path) {
 461         fatal_signal_remove_file_to_unlink(bind_path);
 462     }
 463     close(fd);
 464     return -error;
 465 }
 466
 467 int
 468 get_unix_name_len(socklen_t sun_len)
 469 {
 470     return (sun_len >= offsetof(struct sockaddr_un, sun_path)
 471             ? sun_len - offsetof(struct sockaddr_un, sun_path)
 472             : 0);
 473 }
 474
 475 ovs_be32
 476 guess_netmask(ovs_be32 ip_)
 477 {
 478     uint32_t ip = ntohl(ip_);
 479     return ((ip >> 31) == 0 ? htonl(0xff000000)   /* Class A */
 480             : (ip >> 30) == 2 ? htonl(0xffff0000) /* Class B */
 481             : (ip >> 29) == 6 ? htonl(0xffffff00) /* Class C */
 482             : htonl(0));                          /* ??? */
 483 }
 484
 485 /* Parses 'target', which should be a string in the format "<host>[:<port>]".
 486  * <host> is required.  If 'default_port' is nonzero then <port> is optional
 487  * and defaults to 'default_port'.
 488  *
 489  * On success, returns true and stores the parsed remote address into '*sinp'.
 490  * On failure, logs an error, stores zeros into '*sinp', and returns false. */
 491 bool
 492 inet_parse_active(const char *target_, uint16_t default_port,
 493                   struct sockaddr_in *sinp)
 494 {
 495     char *target = xstrdup(target_);
 496     char *save_ptr = NULL;
 497     const char *host_name;
 498     const char *port_string;
 499     bool ok = false;
 500
 501     /* Defaults. */
 502     sinp->sin_family = AF_INET;
 503     sinp->sin_port = htons(default_port);
 504
 505     /* Tokenize. */
 506     host_name = strtok_r(target, ":", &save_ptr);
 507     port_string = strtok_r(NULL, ":", &save_ptr);
 508     if (!host_name) {
 509         VLOG_ERR("%s: bad peer name format", target_);
 510         goto exit;
 511     }
 512
 513     /* Look up IP, port. */
 514     if (lookup_ip(host_name, &sinp->sin_addr)) {
 515         goto exit;
 516     }
 517     if (port_string && atoi(port_string)) {
 518         sinp->sin_port = htons(atoi(port_string));
 519     } else if (!default_port) {
 520         VLOG_ERR("%s: port number must be specified", target_);
 521         goto exit;
 522     }
 523
 524     ok = true;
 525
 526 exit:
 527     if (!ok) {
 528         memset(sinp, 0, sizeof *sinp);
 529     }
 530     free(target);
 531     return ok;
 532 }
 533
 534 /* Opens a non-blocking IPv4 socket of the specified 'style' and connects to
 535  * 'target', which should be a string in the format "<host>[:<port>]".  <host>
 536  * is required.  If 'default_port' is nonzero then <port> is optional and
 537  * defaults to 'default_port'.
 538  *
 539  * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
 540  *
 541  * On success, returns 0 (indicating connection complete) or EAGAIN (indicating
 542  * connection in progress), in which case the new file descriptor is stored
 543  * into '*fdp'.  On failure, returns a positive errno value other than EAGAIN
 544  * and stores -1 into '*fdp'.
 545  *
 546  * If 'sinp' is non-null, then on success the target address is stored into
 547  * '*sinp'. */
 548 int
 549 inet_open_active(int style, const char *target, uint16_t default_port,
 550                  struct sockaddr_in *sinp, int *fdp)
 551 {
 552     struct sockaddr_in sin;
 553     int fd = -1;
 554     int error;
 555
 556     /* Parse. */
 557     if (!inet_parse_active(target, default_port, &sin)) {
 558         error = EAFNOSUPPORT;
 559         goto exit;
 560     }
 561
 562     /* Create non-blocking socket. */
 563     fd = socket(AF_INET, style, 0);
 564     if (fd < 0) {
 565         VLOG_ERR("%s: socket: %s", target, strerror(errno));
 566         error = errno;
 567         goto exit;
 568     }
 569     error = set_nonblocking(fd);
 570     if (error) {
 571         goto exit_close;
 572     }
 573
 574     /* Connect. */
 575     error = connect(fd, (struct sockaddr *) &sin, sizeof sin) == 0 ? 0 : errno;
 576     if (error == EINPROGRESS) {
 577         error = EAGAIN;
 578     } else if (error && error != EAGAIN) {
 579         goto exit_close;
 580     }
 581
 582     /* Success: error is 0 or EAGAIN. */
 583     goto exit;
 584
 585 exit_close:
 586     close(fd);
 587 exit:
 588     if (!error || error == EAGAIN) {
 589         if (sinp) {
 590             *sinp = sin;
 591         }
 592         *fdp = fd;
 593     } else {
 594         *fdp = -1;
 595     }
 596     return error;
 597 }
 598
 599 /* Parses 'target', which should be a string in the format "[<port>][:<ip>]":
 600  *
 601  *      - If 'default_port' is -1, then <port> is required.  Otherwise, if
 602  *        <port> is omitted, then 'default_port' is used instead.
 603  *
 604  *      - If <port> (or 'default_port', if used) is 0, then no port is bound
 605  *        and the TCP/IP stack will select a port.
 606  *
 607  *      - If <ip> is omitted then the IP address is wildcarded.
 608  *
 609  * If successful, stores the address into '*sinp' and returns true; otherwise
 610  * zeros '*sinp' and returns false. */
 611 bool
 612 inet_parse_passive(const char *target_, int default_port,
 613                    struct sockaddr_in *sinp)
 614 {
 615     char *target = xstrdup(target_);
 616     char *string_ptr = target;
 617     const char *host_name;
 618     const char *port_string;
 619     bool ok = false;
 620     int port;
 621
 622     /* Address defaults. */
 623     memset(sinp, 0, sizeof *sinp);
 624     sinp->sin_family = AF_INET;
 625     sinp->sin_addr.s_addr = htonl(INADDR_ANY);
 626     sinp->sin_port = htons(default_port);
 627
 628     /* Parse optional port number. */
 629     port_string = strsep(&string_ptr, ":");
 630     if (port_string && str_to_int(port_string, 10, &port)) {
 631         sinp->sin_port = htons(port);
 632     } else if (default_port < 0) {
 633         VLOG_ERR("%s: port number must be specified", target_);
 634         goto exit;
 635     }
 636
 637     /* Parse optional bind IP. */
 638     host_name = strsep(&string_ptr, ":");
 639     if (host_name && host_name[0] && lookup_ip(host_name, &sinp->sin_addr)) {
 640         goto exit;
 641     }
 642
 643     ok = true;
 644
 645 exit:
 646     if (!ok) {
 647         memset(sinp, 0, sizeof *sinp);
 648     }
 649     free(target);
 650     return ok;
 651 }
 652
 653
 654 /* Opens a non-blocking IPv4 socket of the specified 'style', binds to
 655  * 'target', and listens for incoming connections.  Parses 'target' in the same
 656  * way was inet_parse_passive().
 657  *
 658  * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
 659  *
 660  * For TCP, the socket will have SO_REUSEADDR turned on.
 661  *
 662  * On success, returns a non-negative file descriptor.  On failure, returns a
 663  * negative errno value.
 664  *
 665  * If 'sinp' is non-null, then on success the bound address is stored into
 666  * '*sinp'. */
 667 int
 668 inet_open_passive(int style, const char *target, int default_port,
 669                   struct sockaddr_in *sinp)
 670 {
 671     struct sockaddr_in sin;
 672     int fd = 0, error;
 673     unsigned int yes = 1;
 674
 675     if (!inet_parse_passive(target, default_port, &sin)) {
 676         return -EAFNOSUPPORT;
 677     }
 678
 679     /* Create non-blocking socket, set SO_REUSEADDR. */
 680     fd = socket(AF_INET, style, 0);
 681     if (fd < 0) {
 682         error = errno;
 683         VLOG_ERR("%s: socket: %s", target, strerror(error));
 684         return -error;
 685     }
 686     error = set_nonblocking(fd);
 687     if (error) {
 688         goto error;
 689     }
 690     if (style == SOCK_STREAM
 691         && setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof yes) < 0) {
 692         error = errno;
 693         VLOG_ERR("%s: setsockopt(SO_REUSEADDR): %s", target, strerror(error));
 694         goto error;
 695     }
 696
 697     /* Bind. */
 698     if (bind(fd, (struct sockaddr *) &sin, sizeof sin) < 0) {
 699         error = errno;
 700         VLOG_ERR("%s: bind: %s", target, strerror(error));
 701         goto error;
 702     }
 703
 704     /* Listen. */
 705     if (listen(fd, 10) < 0) {
 706         error = errno;
 707         VLOG_ERR("%s: listen: %s", target, strerror(error));
 708         goto error;
 709     }
 710
 711     if (sinp) {
 712         socklen_t sin_len = sizeof sin;
 713         if (getsockname(fd, (struct sockaddr *) &sin, &sin_len) < 0){
 714             error = errno;
 715             VLOG_ERR("%s: getsockname: %s", target, strerror(error));
 716             goto error;
 717         }
 718         if (sin.sin_family != AF_INET || sin_len != sizeof sin) {
 719             error = EAFNOSUPPORT;
 720             VLOG_ERR("%s: getsockname: invalid socket name", target);
 721             goto error;
 722         }
 723         *sinp = sin;
 724     }
 725
 726     return fd;
 727
 728 error:
 729     close(fd);
 730     return -error;
 731 }
 732
 733 /* Returns a readable and writable fd for /dev/null, if successful, otherwise
 734  * a negative errno value.  The caller must not close the returned fd (because
 735  * the same fd will be handed out to subsequent callers). */
 736 int
 737 get_null_fd(void)
 738 {
 739     static int null_fd = -1;
 740     if (null_fd < 0) {
 741         null_fd = open("/dev/null", O_RDWR);
 742         if (null_fd < 0) {
 743             int error = errno;
 744             VLOG_ERR("could not open /dev/null: %s", strerror(error));
 745             return -error;
 746         }
 747     }
 748     return null_fd;
 749 }
 750
 751 int
 752 read_fully(int fd, void *p_, size_t size, size_t *bytes_read)
 753 {
 754     uint8_t *p = p_;
 755
 756     *bytes_read = 0;
 757     while (size > 0) {
 758         ssize_t retval = read(fd, p, size);
 759         if (retval > 0) {
 760             *bytes_read += retval;
 761             size -= retval;
 762             p += retval;
 763         } else if (retval == 0) {
 764             return EOF;
 765         } else if (errno != EINTR) {
 766             return errno;
 767         }
 768     }
 769     return 0;
 770 }
 771
 772 int
 773 write_fully(int fd, const void *p_, size_t size, size_t *bytes_written)
 774 {
 775     const uint8_t *p = p_;
 776
 777     *bytes_written = 0;
 778     while (size > 0) {
 779         ssize_t retval = write(fd, p, size);
 780         if (retval > 0) {
 781             *bytes_written += retval;
 782             size -= retval;
 783             p += retval;
 784         } else if (retval == 0) {
 785             VLOG_WARN("write returned 0");
 786             return EPROTO;
 787         } else if (errno != EINTR) {
 788             return errno;
 789         }
 790     }
 791     return 0;
 792 }
 793
 794 /* Given file name 'file_name', fsyncs the directory in which it is contained.
 795  * Returns 0 if successful, otherwise a positive errno value. */
 796 int
 797 fsync_parent_dir(const char *file_name)
 798 {
 799     int error = 0;
 800     char *dir;
 801     int fd;
 802
 803     dir = dir_name(file_name);
 804     fd = open(dir, O_RDONLY);
 805     if (fd >= 0) {
 806         if (fsync(fd)) {
 807             if (errno == EINVAL || errno == EROFS) {
 808                 /* This directory does not support synchronization.  Not
 809                  * really an error. */
 810             } else {
 811                 error = errno;
 812                 VLOG_ERR("%s: fsync failed (%s)", dir, strerror(error));
 813             }
 814         }
 815         close(fd);
 816     } else {
 817         error = errno;
 818         VLOG_ERR("%s: open failed (%s)", dir, strerror(error));
 819     }
 820     free(dir);
 821
 822     return error;
 823 }
 824
 825 /* Obtains the modification time of the file named 'file_name' to the greatest
 826  * supported precision.  If successful, stores the mtime in '*mtime' and
 827  * returns 0.  On error, returns a positive errno value and stores zeros in
 828  * '*mtime'. */
 829 int
 830 get_mtime(const char *file_name, struct timespec *mtime)
 831 {
 832     struct stat s;
 833
 834     if (!stat(file_name, &s)) {
 835         mtime->tv_sec = s.st_mtime;
 836
 837 #if HAVE_STRUCT_STAT_ST_MTIM_TV_NSEC
 838         mtime->tv_nsec = s.st_mtim.tv_nsec;
 839 #elif HAVE_STRUCT_STAT_ST_MTIMENSEC
 840         mtime->tv_nsec = s.st_mtimensec;
 841 #else
 842         mtime->tv_nsec = 0;
 843 #endif
 844
 845         return 0;
 846     } else {
 847         mtime->tv_sec = mtime->tv_nsec = 0;
 848         return errno;
 849     }
 850 }
 851
 852 void
 853 xpipe(int fds[2])
 854 {
 855     if (pipe(fds)) {
 856         VLOG_FATAL("failed to create pipe (%s)", strerror(errno));
 857     }
 858 }
 859
 860 static int
 861 getsockopt_int(int fd, int level, int option, const char *optname, int *valuep)
 862 {
 863     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
 864     socklen_t len;
 865     int value;
 866     int error;
 867
 868     len = sizeof value;
 869     if (getsockopt(fd, level, option, &value, &len)) {
 870         error = errno;
 871         VLOG_ERR_RL(&rl, "getsockopt(%s): %s", optname, strerror(error));
 872     } else if (len != sizeof value) {
 873         error = EINVAL;
 874         VLOG_ERR_RL(&rl, "getsockopt(%s): value is %u bytes (expected %zu)",
 875                     optname, (unsigned int) len, sizeof value);
 876     } else {
 877         error = 0;
 878     }
 879
 880     *valuep = error ? 0 : value;
 881     return error;
 882 }
 883
 884 static void
 885 describe_sockaddr(struct ds *string, int fd,
 886                   int (*getaddr)(int, struct sockaddr *, socklen_t *))
 887 {
 888     struct sockaddr_storage ss;
 889     socklen_t len = sizeof ss;
 890
 891     if (!getaddr(fd, (struct sockaddr *) &ss, &len)) {
 892         if (ss.ss_family == AF_INET) {
 893             struct sockaddr_in sin;
 894
 895             memcpy(&sin, &ss, sizeof sin);
 896             ds_put_format(string, IP_FMT":%"PRIu16,
 897                           IP_ARGS(&sin.sin_addr.s_addr), ntohs(sin.sin_port));
 898         } else if (ss.ss_family == AF_UNIX) {
 899             struct sockaddr_un sun;
 900             const char *null;
 901             size_t maxlen;
 902
 903             memcpy(&sun, &ss, sizeof sun);
 904             maxlen = len - offsetof(struct sockaddr_un, sun_path);
 905             null = memchr(sun.sun_path, '\0', maxlen);
 906             ds_put_buffer(string, sun.sun_path,
 907                           null ? null - sun.sun_path : maxlen);
 908         }
 909 #ifdef HAVE_NETLINK
 910         else if (ss.ss_family == AF_NETLINK) {
 911             int protocol;
 912
 913 /* SO_PROTOCOL was introduced in 2.6.32.  Support it regardless of the version
 914  * of the Linux kernel headers in use at build time. */
 915 #ifndef SO_PROTOCOL
 916 #define SO_PROTOCOL 38
 917 #endif
 918
 919             if (!getsockopt_int(fd, SOL_SOCKET, SO_PROTOCOL, "SO_PROTOCOL",
 920                                 &protocol)) {
 921                 switch (protocol) {
 922                 case NETLINK_ROUTE:
 923                     ds_put_cstr(string, "NETLINK_ROUTE");
 924                     break;
 925
 926                 case NETLINK_GENERIC:
 927                     ds_put_cstr(string, "NETLINK_GENERIC");
 928                     break;
 929
 930                 default:
 931                     ds_put_format(string, "AF_NETLINK family %d", protocol);
 932                     break;
 933                 }
 934             } else {
 935                 ds_put_cstr(string, "AF_NETLINK");
 936             }
 937         }
 938 #endif
 939 #if AF_PACKET && __linux__
 940         else if (ss.ss_family == AF_PACKET) {
 941             struct sockaddr_ll sll;
 942
 943             memcpy(&sll, &ss, sizeof sll);
 944             ds_put_cstr(string, "AF_PACKET");
 945             if (sll.sll_ifindex) {
 946                 char name[IFNAMSIZ];
 947
 948                 if (if_indextoname(sll.sll_ifindex, name)) {
 949                     ds_put_format(string, "(%s)", name);
 950                 } else {
 951                     ds_put_format(string, "(ifindex=%d)", sll.sll_ifindex);
 952                 }
 953             }
 954             if (sll.sll_protocol) {
 955                 ds_put_format(string, "(protocol=0x%"PRIu16")",
 956                               ntohs(sll.sll_protocol));
 957             }
 958         }
 959 #endif
 960         else if (ss.ss_family == AF_UNSPEC) {
 961             ds_put_cstr(string, "AF_UNSPEC");
 962         } else {
 963             ds_put_format(string, "AF_%d", (int) ss.ss_family);
 964         }
 965     }
 966 }
 967
 968
 969 #ifdef __linux__
 970 static void
 971 put_fd_filename(struct ds *string, int fd)
 972 {
 973     char buf[1024];
 974     char *linkname;
 975     int n;
 976
 977     linkname = xasprintf("/proc/self/fd/%d", fd);
 978     n = readlink(linkname, buf, sizeof buf);
 979     if (n > 0) {
 980         ds_put_char(string, ' ');
 981         ds_put_buffer(string, buf, n);
 982         if (n > sizeof buf) {
 983             ds_put_cstr(string, "...");
 984         }
 985     }
 986     free(linkname);
 987 }
 988 #endif
 989
 990 /* Returns a malloc()'d string describing 'fd', for use in logging. */
 991 char *
 992 describe_fd(int fd)
 993 {
 994     struct ds string;
 995     struct stat s;
 996
 997     ds_init(&string);
 998     if (fstat(fd, &s)) {
 999         ds_put_format(&string, "fstat failed (%s)", strerror(errno));
1000     } else if (S_ISSOCK(s.st_mode)) {
1001         describe_sockaddr(&string, fd, getsockname);
1002         ds_put_cstr(&string, "<->");
1003         describe_sockaddr(&string, fd, getpeername);
1004     } else {
1005         ds_put_cstr(&string, (isatty(fd) ? "tty"
1006                               : S_ISDIR(s.st_mode) ? "directory"
1007                               : S_ISCHR(s.st_mode) ? "character device"
1008                               : S_ISBLK(s.st_mode) ? "block device"
1009                               : S_ISREG(s.st_mode) ? "file"
1010                               : S_ISFIFO(s.st_mode) ? "FIFO"
1011                               : S_ISLNK(s.st_mode) ? "symbolic link"
1012                               : "unknown"));
1013 #ifdef __linux__
1014         put_fd_filename(&string, fd);
1015 #endif
1016     }
1017     return ds_steal_cstr(&string);
1018 }