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 <netdb.h>
  23 #include <poll.h>
  24 #include <stddef.h>
  25 #include <stdio.h>
  26 #include <stdlib.h>
  27 #include <string.h>
  28 #include <sys/resource.h>
  29 #include <sys/socket.h>
  30 #include <sys/stat.h>
  31 #include <sys/un.h>
  32 #include <unistd.h>
  33 #include "fatal-signal.h"
  34 #include "util.h"
  35 #include "vlog.h"
  36
  37 VLOG_DEFINE_THIS_MODULE(socket_util);
  38
  39 /* #ifdefs make it a pain to maintain code: you have to try to build both ways.
  40  * Thus, this file compiles all of the code regardless of the target, by
  41  * writing "if (LINUX)" instead of "#ifdef __linux__". */
  42 #ifdef __linux__
  43 #define LINUX 1
  44 #else
  45 #define LINUX 0
  46 #endif
  47
  48 #ifndef O_DIRECTORY
  49 #define O_DIRECTORY 0
  50 #endif
  51
  52 /* Sets 'fd' to non-blocking mode.  Returns 0 if successful, otherwise a
  53  * positive errno value. */
  54 int
  55 set_nonblocking(int fd)
  56 {
  57     int flags = fcntl(fd, F_GETFL, 0);
  58     if (flags != -1) {
  59         if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) != -1) {
  60             return 0;
  61         } else {
  62             VLOG_ERR("fcntl(F_SETFL) failed: %s", strerror(errno));
  63             return errno;
  64         }
  65     } else {
  66         VLOG_ERR("fcntl(F_GETFL) failed: %s", strerror(errno));
  67         return errno;
  68     }
  69 }
  70
  71 static bool
  72 rlim_is_finite(rlim_t limit)
  73 {
  74     if (limit == RLIM_INFINITY) {
  75         return false;
  76     }
  77
  78 #ifdef RLIM_SAVED_CUR           /* FreeBSD 8.0 lacks RLIM_SAVED_CUR. */
  79     if (limit == RLIM_SAVED_CUR) {
  80         return false;
  81     }
  82 #endif
  83
  84 #ifdef RLIM_SAVED_MAX           /* FreeBSD 8.0 lacks RLIM_SAVED_MAX. */
  85     if (limit == RLIM_SAVED_MAX) {
  86         return false;
  87     }
  88 #endif
  89
  90     return true;
  91 }
  92
  93 /* Returns the maximum valid FD value, plus 1. */
  94 int
  95 get_max_fds(void)
  96 {
  97     static int max_fds = -1;
  98     if (max_fds < 0) {
  99         struct rlimit r;
 100         if (!getrlimit(RLIMIT_NOFILE, &r) && rlim_is_finite(r.rlim_cur)) {
 101             max_fds = r.rlim_cur;
 102         } else {
 103             VLOG_WARN("failed to obtain fd limit, defaulting to 1024");
 104             max_fds = 1024;
 105         }
 106     }
 107     return max_fds;
 108 }
 109
 110 /* Translates 'host_name', which must be a string representation of an IP
 111  * address, into a numeric IP address in '*addr'.  Returns 0 if successful,
 112  * otherwise a positive errno value. */
 113 int
 114 lookup_ip(const char *host_name, struct in_addr *addr)
 115 {
 116     if (!inet_aton(host_name, addr)) {
 117         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 118         VLOG_ERR_RL(&rl, "\"%s\" is not a valid IP address", host_name);
 119         return ENOENT;
 120     }
 121     return 0;
 122 }
 123
 124 /* Translates 'host_name', which must be a string representation of an IPv6
 125  * address, into a numeric IPv6 address in '*addr'.  Returns 0 if successful,
 126  * otherwise a positive errno value. */
 127 int
 128 lookup_ipv6(const char *host_name, struct in6_addr *addr)
 129 {
 130     if (inet_pton(AF_INET6, host_name, addr) != 1) {
 131         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 132         VLOG_ERR_RL(&rl, "\"%s\" is not a valid IPv6 address", host_name);
 133         return ENOENT;
 134     }
 135     return 0;
 136 }
 137
 138 /* Returns the error condition associated with socket 'fd' and resets the
 139  * socket's error status. */
 140 int
 141 get_socket_error(int fd)
 142 {
 143     int error;
 144     socklen_t len = sizeof(error);
 145     if (getsockopt(fd, SOL_SOCKET, SO_ERROR, &error, &len) < 0) {
 146         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
 147         error = errno;
 148         VLOG_ERR_RL(&rl, "getsockopt(SO_ERROR): %s", strerror(error));
 149     }
 150     return error;
 151 }
 152
 153 int
 154 check_connection_completion(int fd)
 155 {
 156     struct pollfd pfd;
 157     int retval;
 158
 159     pfd.fd = fd;
 160     pfd.events = POLLOUT;
 161     do {
 162         retval = poll(&pfd, 1, 0);
 163     } while (retval < 0 && errno == EINTR);
 164     if (retval == 1) {
 165         return get_socket_error(fd);
 166     } else if (retval < 0) {
 167         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
 168         VLOG_ERR_RL(&rl, "poll: %s", strerror(errno));
 169         return errno;
 170     } else {
 171         return EAGAIN;
 172     }
 173 }
 174
 175 /* Drain all the data currently in the receive queue of a datagram socket (and
 176  * possibly additional data).  There is no way to know how many packets are in
 177  * the receive queue, but we do know that the total number of bytes queued does
 178  * not exceed the receive buffer size, so we pull packets until none are left
 179  * or we've read that many bytes. */
 180 int
 181 drain_rcvbuf(int fd)
 182 {
 183     socklen_t rcvbuf_len;
 184     size_t rcvbuf;
 185
 186     rcvbuf_len = sizeof rcvbuf;
 187     if (getsockopt(fd, SOL_SOCKET, SO_RCVBUF, &rcvbuf, &rcvbuf_len) < 0) {
 188         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 10);
 189         VLOG_ERR_RL(&rl, "getsockopt(SO_RCVBUF) failed: %s", strerror(errno));
 190         return errno;
 191     }
 192     while (rcvbuf > 0) {
 193         /* In Linux, specifying MSG_TRUNC in the flags argument causes the
 194          * datagram length to be returned, even if that is longer than the
 195          * buffer provided.  Thus, we can use a 1-byte buffer to discard the
 196          * incoming datagram and still be able to account how many bytes were
 197          * removed from the receive buffer.
 198          *
 199          * On other Unix-like OSes, MSG_TRUNC has no effect in the flags
 200          * argument. */
 201         char buffer[LINUX ? 1 : 2048];
 202         ssize_t n_bytes = recv(fd, buffer, sizeof buffer,
 203                                MSG_TRUNC | MSG_DONTWAIT);
 204         if (n_bytes <= 0 || n_bytes >= rcvbuf) {
 205             break;
 206         }
 207         rcvbuf -= n_bytes;
 208     }
 209     return 0;
 210 }
 211
 212 /* Reads and discards up to 'n' datagrams from 'fd', stopping as soon as no
 213  * more data can be immediately read.  ('fd' should therefore be in
 214  * non-blocking mode.)*/
 215 void
 216 drain_fd(int fd, size_t n_packets)
 217 {
 218     for (; n_packets > 0; n_packets--) {
 219         /* 'buffer' only needs to be 1 byte long in most circumstances.  This
 220          * size is defensive against the possibility that we someday want to
 221          * use a Linux tap device without TUN_NO_PI, in which case a buffer
 222          * smaller than sizeof(struct tun_pi) will give EINVAL on read. */
 223         char buffer[128];
 224         if (read(fd, buffer, sizeof buffer) <= 0) {
 225             break;
 226         }
 227     }
 228 }
 229
 230 /* Stores in '*un' a sockaddr_un that refers to file 'name'.  Stores in
 231  * '*un_len' the size of the sockaddr_un. */
 232 static void
 233 make_sockaddr_un__(const char *name, struct sockaddr_un *un, socklen_t *un_len)
 234 {
 235     un->sun_family = AF_UNIX;
 236     ovs_strzcpy(un->sun_path, name, sizeof un->sun_path);
 237     *un_len = (offsetof(struct sockaddr_un, sun_path)
 238                 + strlen (un->sun_path) + 1);
 239 }
 240
 241 /* Stores in '*un' a sockaddr_un that refers to file 'name'.  Stores in
 242  * '*un_len' the size of the sockaddr_un.
 243  *
 244  * Returns 0 on success, otherwise a positive errno value.  On success,
 245  * '*dirfdp' is either -1 or a nonnegative file descriptor that the caller
 246  * should close after using '*un' to bind or connect.  On failure, '*dirfdp' is
 247  * -1. */
 248 static int
 249 make_sockaddr_un(const char *name, struct sockaddr_un *un, socklen_t *un_len,
 250                  int *dirfdp)
 251 {
 252     enum { MAX_UN_LEN = sizeof un->sun_path - 1 };
 253
 254     *dirfdp = -1;
 255     if (strlen(name) > MAX_UN_LEN) {
 256         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
 257
 258         if (LINUX) {
 259             /* 'name' is too long to fit in a sockaddr_un, but we have a
 260              * workaround for that on Linux: shorten it by opening a file
 261              * descriptor for the directory part of the name and indirecting
 262              * through /proc/self/fd/<dirfd>/<basename>. */
 263             char *dir, *base;
 264             char *short_name;
 265             int dirfd;
 266
 267             dir = dir_name(name);
 268             base = base_name(name);
 269
 270             dirfd = open(dir, O_DIRECTORY | O_RDONLY);
 271             if (dirfd < 0) {
 272                 free(base);
 273                 free(dir);
 274                 return errno;
 275             }
 276
 277             short_name = xasprintf("/proc/self/fd/%d/%s", dirfd, base);
 278             free(dir);
 279             free(base);
 280
 281             if (strlen(short_name) <= MAX_UN_LEN) {
 282                 make_sockaddr_un__(short_name, un, un_len);
 283                 free(short_name);
 284                 *dirfdp = dirfd;
 285                 return 0;
 286             }
 287             free(short_name);
 288             close(dirfd);
 289
 290             VLOG_WARN_RL(&rl, "Unix socket name %s is longer than maximum "
 291                          "%d bytes (even shortened)", name, MAX_UN_LEN);
 292         } else {
 293             /* 'name' is too long and we have no workaround. */
 294             VLOG_WARN_RL(&rl, "Unix socket name %s is longer than maximum "
 295                          "%d bytes", name, MAX_UN_LEN);
 296         }
 297
 298         return ENAMETOOLONG;
 299     } else {
 300         make_sockaddr_un__(name, un, un_len);
 301         return 0;
 302     }
 303 }
 304
 305 /* Binds Unix domain socket 'fd' to a file with permissions 0700. */
 306 static int
 307 bind_unix_socket(int fd, struct sockaddr *sun, socklen_t sun_len)
 308 {
 309 #ifdef __linux__
 310     /* On Linux, calling fchmod() *before* bind() sets permissions for the file
 311      * about to be created.  Calling fchmod() *after* bind has no effect on the
 312      * file that was created.) */
 313     return fchmod(fd, 0700) || bind(fd, sun, sun_len) ? errno : 0;
 314 #else
 315     /* According to _Unix Network Programming_, umask should affect bind(). */
 316     mode_t old_umask = umask(0077);
 317     int error = bind(fd, sun, sun_len) ? errno : 0;
 318     umask(old_umask);
 319     return error;
 320 #endif
 321 }
 322
 323 /* Creates a Unix domain socket in the given 'style' (either SOCK_DGRAM or
 324  * SOCK_STREAM) that is bound to '*bind_path' (if 'bind_path' is non-null) and
 325  * connected to '*connect_path' (if 'connect_path' is non-null).  If 'nonblock'
 326  * is true, the socket is made non-blocking.  If 'passcred' is true, the socket
 327  * is configured to receive SCM_CREDENTIALS control messages.
 328  *
 329  * Returns the socket's fd if successful, otherwise a negative errno value. */
 330 int
 331 make_unix_socket(int style, bool nonblock, bool passcred OVS_UNUSED,
 332                  const char *bind_path, const char *connect_path)
 333 {
 334     int error;
 335     int fd;
 336
 337     fd = socket(PF_UNIX, style, 0);
 338     if (fd < 0) {
 339         return -errno;
 340     }
 341
 342     /* Set nonblocking mode right away, if we want it.  This prevents blocking
 343      * in connect(), if connect_path != NULL.  (In turn, that's a corner case:
 344      * it will only happen if style is SOCK_STREAM or SOCK_SEQPACKET, and only
 345      * if a backlog of un-accepted connections has built up in the kernel.)  */
 346     if (nonblock) {
 347         int flags = fcntl(fd, F_GETFL, 0);
 348         if (flags == -1) {
 349             error = errno;
 350             goto error;
 351         }
 352         if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) == -1) {
 353             error = errno;
 354             goto error;
 355         }
 356     }
 357
 358     if (bind_path) {
 359         struct sockaddr_un un;
 360         socklen_t un_len;
 361         int dirfd;
 362
 363         if (unlink(bind_path) && errno != ENOENT) {
 364             VLOG_WARN("unlinking \"%s\": %s\n", bind_path, strerror(errno));
 365         }
 366         fatal_signal_add_file_to_unlink(bind_path);
 367
 368         error = make_sockaddr_un(bind_path, &un, &un_len, &dirfd);
 369         if (!error) {
 370             error = bind_unix_socket(fd, (struct sockaddr *) &un, un_len);
 371         }
 372         if (dirfd >= 0) {
 373             close(dirfd);
 374         }
 375         if (error) {
 376             goto error;
 377         }
 378     }
 379
 380     if (connect_path) {
 381         struct sockaddr_un un;
 382         socklen_t un_len;
 383         int dirfd;
 384
 385         error = make_sockaddr_un(connect_path, &un, &un_len, &dirfd);
 386         if (!error
 387             && connect(fd, (struct sockaddr*) &un, un_len)
 388             && errno != EINPROGRESS) {
 389             error = errno;
 390         }
 391         if (dirfd >= 0) {
 392             close(dirfd);
 393         }
 394         if (error) {
 395             goto error;
 396         }
 397     }
 398
 399 #ifdef SCM_CREDENTIALS
 400     if (passcred) {
 401         int enable = 1;
 402         if (setsockopt(fd, SOL_SOCKET, SO_PASSCRED, &enable, sizeof(enable))) {
 403             error = errno;
 404             goto error;
 405         }
 406     }
 407 #endif
 408
 409     return fd;
 410
 411 error:
 412     if (error == EAGAIN) {
 413         error = EPROTO;
 414     }
 415     if (bind_path) {
 416         fatal_signal_remove_file_to_unlink(bind_path);
 417     }
 418     close(fd);
 419     return -error;
 420 }
 421
 422 int
 423 get_unix_name_len(socklen_t sun_len)
 424 {
 425     return (sun_len >= offsetof(struct sockaddr_un, sun_path)
 426             ? sun_len - offsetof(struct sockaddr_un, sun_path)
 427             : 0);
 428 }
 429
 430 uint32_t
 431 guess_netmask(uint32_t ip)
 432 {
 433     ip = ntohl(ip);
 434     return ((ip >> 31) == 0 ? htonl(0xff000000)   /* Class A */
 435             : (ip >> 30) == 2 ? htonl(0xffff0000) /* Class B */
 436             : (ip >> 29) == 6 ? htonl(0xffffff00) /* Class C */
 437             : htonl(0));                          /* ??? */
 438 }
 439
 440 /* Parses 'target', which should be a string in the format "<host>[:<port>]".
 441  * <host> is required.  If 'default_port' is nonzero then <port> is optional
 442  * and defaults to 'default_port'.
 443  *
 444  * On success, returns true and stores the parsed remote address into '*sinp'.
 445  * On failure, logs an error, stores zeros into '*sinp', and returns false. */
 446 bool
 447 inet_parse_active(const char *target_, uint16_t default_port,
 448                   struct sockaddr_in *sinp)
 449 {
 450     char *target = xstrdup(target_);
 451     char *save_ptr = NULL;
 452     const char *host_name;
 453     const char *port_string;
 454     bool ok = false;
 455
 456     /* Defaults. */
 457     sinp->sin_family = AF_INET;
 458     sinp->sin_port = htons(default_port);
 459
 460     /* Tokenize. */
 461     host_name = strtok_r(target, ":", &save_ptr);
 462     port_string = strtok_r(NULL, ":", &save_ptr);
 463     if (!host_name) {
 464         VLOG_ERR("%s: bad peer name format", target_);
 465         goto exit;
 466     }
 467
 468     /* Look up IP, port. */
 469     if (lookup_ip(host_name, &sinp->sin_addr)) {
 470         goto exit;
 471     }
 472     if (port_string && atoi(port_string)) {
 473         sinp->sin_port = htons(atoi(port_string));
 474     } else if (!default_port) {
 475         VLOG_ERR("%s: port number must be specified", target_);
 476         goto exit;
 477     }
 478
 479     ok = true;
 480
 481 exit:
 482     if (!ok) {
 483         memset(sinp, 0, sizeof *sinp);
 484     }
 485     free(target);
 486     return ok;
 487 }
 488
 489 /* Opens a non-blocking IPv4 socket of the specified 'style' and connects to
 490  * 'target', which should be a string in the format "<host>[:<port>]".  <host>
 491  * is required.  If 'default_port' is nonzero then <port> is optional and
 492  * defaults to 'default_port'.
 493  *
 494  * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
 495  *
 496  * On success, returns 0 (indicating connection complete) or EAGAIN (indicating
 497  * connection in progress), in which case the new file descriptor is stored
 498  * into '*fdp'.  On failure, returns a positive errno value other than EAGAIN
 499  * and stores -1 into '*fdp'.
 500  *
 501  * If 'sinp' is non-null, then on success the target address is stored into
 502  * '*sinp'. */
 503 int
 504 inet_open_active(int style, const char *target, uint16_t default_port,
 505                  struct sockaddr_in *sinp, int *fdp)
 506 {
 507     struct sockaddr_in sin;
 508     int fd = -1;
 509     int error;
 510
 511     /* Parse. */
 512     if (!inet_parse_active(target, default_port, &sin)) {
 513         error = EAFNOSUPPORT;
 514         goto exit;
 515     }
 516
 517     /* Create non-blocking socket. */
 518     fd = socket(AF_INET, style, 0);
 519     if (fd < 0) {
 520         VLOG_ERR("%s: socket: %s", target, strerror(errno));
 521         error = errno;
 522         goto exit;
 523     }
 524     error = set_nonblocking(fd);
 525     if (error) {
 526         goto exit_close;
 527     }
 528
 529     /* Connect. */
 530     error = connect(fd, (struct sockaddr *) &sin, sizeof sin) == 0 ? 0 : errno;
 531     if (error == EINPROGRESS) {
 532         error = EAGAIN;
 533     } else if (error && error != EAGAIN) {
 534         goto exit_close;
 535     }
 536
 537     /* Success: error is 0 or EAGAIN. */
 538     goto exit;
 539
 540 exit_close:
 541     close(fd);
 542 exit:
 543     if (!error || error == EAGAIN) {
 544         if (sinp) {
 545             *sinp = sin;
 546         }
 547         *fdp = fd;
 548     } else {
 549         *fdp = -1;
 550     }
 551     return error;
 552 }
 553
 554 /* Opens a non-blocking IPv4 socket of the specified 'style', binds to
 555  * 'target', and listens for incoming connections.  'target' should be a string
 556  * in the format "[<port>][:<ip>]":
 557  *
 558  *      - If 'default_port' is -1, then <port> is required.  Otherwise, if
 559  *        <port> is omitted, then 'default_port' is used instead.
 560  *
 561  *      - If <port> (or 'default_port', if used) is 0, then no port is bound
 562  *        and the TCP/IP stack will select a port.
 563  *
 564  *      - If <ip> is omitted then the IP address is wildcarded.
 565  *
 566  * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
 567  *
 568  * For TCP, the socket will have SO_REUSEADDR turned on.
 569  *
 570  * On success, returns a non-negative file descriptor.  On failure, returns a
 571  * negative errno value.
 572  *
 573  * If 'sinp' is non-null, then on success the bound address is stored into
 574  * '*sinp'. */
 575 int
 576 inet_open_passive(int style, const char *target_, int default_port,
 577                   struct sockaddr_in *sinp)
 578 {
 579     char *target = xstrdup(target_);
 580     char *string_ptr = target;
 581     struct sockaddr_in sin;
 582     const char *host_name;
 583     const char *port_string;
 584     int fd = 0, error, port;
 585     unsigned int yes  = 1;
 586
 587     /* Address defaults. */
 588     memset(&sin, 0, sizeof sin);
 589     sin.sin_family = AF_INET;
 590     sin.sin_addr.s_addr = htonl(INADDR_ANY);
 591     sin.sin_port = htons(default_port);
 592
 593     /* Parse optional port number. */
 594     port_string = strsep(&string_ptr, ":");
 595     if (port_string && str_to_int(port_string, 10, &port)) {
 596         sin.sin_port = htons(port);
 597     } else if (default_port < 0) {
 598         VLOG_ERR("%s: port number must be specified", target_);
 599         error = EAFNOSUPPORT;
 600         goto exit;
 601     }
 602
 603     /* Parse optional bind IP. */
 604     host_name = strsep(&string_ptr, ":");
 605     if (host_name && host_name[0]) {
 606         error = lookup_ip(host_name, &sin.sin_addr);
 607         if (error) {
 608             goto exit;
 609         }
 610     }
 611
 612     /* Create non-blocking socket, set SO_REUSEADDR. */
 613     fd = socket(AF_INET, style, 0);
 614     if (fd < 0) {
 615         error = errno;
 616         VLOG_ERR("%s: socket: %s", target_, strerror(error));
 617         goto exit;
 618     }
 619     error = set_nonblocking(fd);
 620     if (error) {
 621         goto exit_close;
 622     }
 623     if (style == SOCK_STREAM
 624         && setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof yes) < 0) {
 625         error = errno;
 626         VLOG_ERR("%s: setsockopt(SO_REUSEADDR): %s", target_, strerror(error));
 627         goto exit_close;
 628     }
 629
 630     /* Bind. */
 631     if (bind(fd, (struct sockaddr *) &sin, sizeof sin) < 0) {
 632         error = errno;
 633         VLOG_ERR("%s: bind: %s", target_, strerror(error));
 634         goto exit_close;
 635     }
 636
 637     /* Listen. */
 638     if (listen(fd, 10) < 0) {
 639         error = errno;
 640         VLOG_ERR("%s: listen: %s", target_, strerror(error));
 641         goto exit_close;
 642     }
 643
 644     if (sinp) {
 645         socklen_t sin_len = sizeof sin;
 646         if (getsockname(fd, (struct sockaddr *) &sin, &sin_len) < 0){
 647             error = errno;
 648             VLOG_ERR("%s: getsockname: %s", target_, strerror(error));
 649             goto exit_close;
 650         }
 651         if (sin.sin_family != AF_INET || sin_len != sizeof sin) {
 652             VLOG_ERR("%s: getsockname: invalid socket name", target_);
 653             goto exit_close;
 654         }
 655         *sinp = sin;
 656     }
 657
 658     error = 0;
 659     goto exit;
 660
 661 exit_close:
 662     close(fd);
 663 exit:
 664     free(target);
 665     return error ? -error : fd;
 666 }
 667
 668 /* Returns a readable and writable fd for /dev/null, if successful, otherwise
 669  * a negative errno value.  The caller must not close the returned fd (because
 670  * the same fd will be handed out to subsequent callers). */
 671 int
 672 get_null_fd(void)
 673 {
 674     static int null_fd = -1;
 675     if (null_fd < 0) {
 676         null_fd = open("/dev/null", O_RDWR);
 677         if (null_fd < 0) {
 678             int error = errno;
 679             VLOG_ERR("could not open /dev/null: %s", strerror(error));
 680             return -error;
 681         }
 682     }
 683     return null_fd;
 684 }
 685
 686 int
 687 read_fully(int fd, void *p_, size_t size, size_t *bytes_read)
 688 {
 689     uint8_t *p = p_;
 690
 691     *bytes_read = 0;
 692     while (size > 0) {
 693         ssize_t retval = read(fd, p, size);
 694         if (retval > 0) {
 695             *bytes_read += retval;
 696             size -= retval;
 697             p += retval;
 698         } else if (retval == 0) {
 699             return EOF;
 700         } else if (errno != EINTR) {
 701             return errno;
 702         }
 703     }
 704     return 0;
 705 }
 706
 707 int
 708 write_fully(int fd, const void *p_, size_t size, size_t *bytes_written)
 709 {
 710     const uint8_t *p = p_;
 711
 712     *bytes_written = 0;
 713     while (size > 0) {
 714         ssize_t retval = write(fd, p, size);
 715         if (retval > 0) {
 716             *bytes_written += retval;
 717             size -= retval;
 718             p += retval;
 719         } else if (retval == 0) {
 720             VLOG_WARN("write returned 0");
 721             return EPROTO;
 722         } else if (errno != EINTR) {
 723             return errno;
 724         }
 725     }
 726     return 0;
 727 }
 728
 729 /* Given file name 'file_name', fsyncs the directory in which it is contained.
 730  * Returns 0 if successful, otherwise a positive errno value. */
 731 int
 732 fsync_parent_dir(const char *file_name)
 733 {
 734     int error = 0;
 735     char *dir;
 736     int fd;
 737
 738     dir = dir_name(file_name);
 739     fd = open(dir, O_RDONLY);
 740     if (fd >= 0) {
 741         if (fsync(fd)) {
 742             if (errno == EINVAL || errno == EROFS) {
 743                 /* This directory does not support synchronization.  Not
 744                  * really an error. */
 745             } else {
 746                 error = errno;
 747                 VLOG_ERR("%s: fsync failed (%s)", dir, strerror(error));
 748             }
 749         }
 750         close(fd);
 751     } else {
 752         error = errno;
 753         VLOG_ERR("%s: open failed (%s)", dir, strerror(error));
 754     }
 755     free(dir);
 756
 757     return error;
 758 }
 759
 760 /* Obtains the modification time of the file named 'file_name' to the greatest
 761  * supported precision.  If successful, stores the mtime in '*mtime' and
 762  * returns 0.  On error, returns a positive errno value and stores zeros in
 763  * '*mtime'. */
 764 int
 765 get_mtime(const char *file_name, struct timespec *mtime)
 766 {
 767     struct stat s;
 768
 769     if (!stat(file_name, &s)) {
 770         mtime->tv_sec = s.st_mtime;
 771
 772 #if HAVE_STRUCT_STAT_ST_MTIM_TV_NSEC
 773         mtime->tv_nsec = s.st_mtim.tv_nsec;
 774 #elif HAVE_STRUCT_STAT_ST_MTIMENSEC
 775         mtime->tv_nsec = s.st_mtimensec;
 776 #else
 777         mtime->tv_nsec = 0;
 778 #endif
 779
 780         return 0;
 781     } else {
 782         mtime->tv_sec = mtime->tv_nsec = 0;
 783         return errno;
 784     }
 785 }
 786
 787 void
 788 xpipe(int fds[2])
 789 {
 790     if (pipe(fds)) {
 791         VLOG_FATAL("failed to create pipe (%s)", strerror(errno));
 792     }
 793 }