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     strncpy(un->sun_path, name, sizeof un->sun_path);
 237     un->sun_path[sizeof un->sun_path - 1] = '\0';
 238     *un_len = (offsetof(struct sockaddr_un, sun_path)
 239                 + strlen (un->sun_path) + 1);
 240 }
 241
 242 /* Stores in '*un' a sockaddr_un that refers to file 'name'.  Stores in
 243  * '*un_len' the size of the sockaddr_un.
 244  *
 245  * Returns 0 on success, otherwise a positive errno value.  On success,
 246  * '*dirfdp' is either -1 or a nonnegative file descriptor that the caller
 247  * should close after using '*un' to bind or connect.  On failure, '*dirfdp' is
 248  * -1. */
 249 static int
 250 make_sockaddr_un(const char *name, struct sockaddr_un *un, socklen_t *un_len,
 251                  int *dirfdp)
 252 {
 253     enum { MAX_UN_LEN = sizeof un->sun_path - 1 };
 254
 255     *dirfdp = -1;
 256     if (strlen(name) > MAX_UN_LEN) {
 257         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
 258
 259         if (LINUX) {
 260             /* 'name' is too long to fit in a sockaddr_un, but we have a
 261              * workaround for that on Linux: shorten it by opening a file
 262              * descriptor for the directory part of the name and indirecting
 263              * through /proc/self/fd/<dirfd>/<basename>. */
 264             char *dir, *base;
 265             char *short_name;
 266             int dirfd;
 267
 268             dir = dir_name(name);
 269             base = base_name(name);
 270
 271             dirfd = open(dir, O_DIRECTORY | O_RDONLY);
 272             if (dirfd < 0) {
 273                 return errno;
 274             }
 275
 276             short_name = xasprintf("/proc/self/fd/%d/%s", dirfd, base);
 277             free(dir);
 278             free(base);
 279
 280             if (strlen(short_name) <= MAX_UN_LEN) {
 281                 make_sockaddr_un__(short_name, un, un_len);
 282                 free(short_name);
 283                 *dirfdp = dirfd;
 284                 return 0;
 285             }
 286             free(short_name);
 287             close(dirfd);
 288
 289             VLOG_WARN_RL(&rl, "Unix socket name %s is longer than maximum "
 290                          "%d bytes (even shortened)", name, MAX_UN_LEN);
 291         } else {
 292             /* 'name' is too long and we have no workaround. */
 293             VLOG_WARN_RL(&rl, "Unix socket name %s is longer than maximum "
 294                          "%d bytes", name, MAX_UN_LEN);
 295         }
 296
 297         return ENAMETOOLONG;
 298     } else {
 299         make_sockaddr_un__(name, un, un_len);
 300         return 0;
 301     }
 302 }
 303
 304 /* Creates a Unix domain socket in the given 'style' (either SOCK_DGRAM or
 305  * SOCK_STREAM) that is bound to '*bind_path' (if 'bind_path' is non-null) and
 306  * connected to '*connect_path' (if 'connect_path' is non-null).  If 'nonblock'
 307  * is true, the socket is made non-blocking.  If 'passcred' is true, the socket
 308  * is configured to receive SCM_CREDENTIALS control messages.
 309  *
 310  * Returns the socket's fd if successful, otherwise a negative errno value. */
 311 int
 312 make_unix_socket(int style, bool nonblock, bool passcred OVS_UNUSED,
 313                  const char *bind_path, const char *connect_path)
 314 {
 315     int error;
 316     int fd;
 317
 318     fd = socket(PF_UNIX, style, 0);
 319     if (fd < 0) {
 320         return -errno;
 321     }
 322
 323     /* Set nonblocking mode right away, if we want it.  This prevents blocking
 324      * in connect(), if connect_path != NULL.  (In turn, that's a corner case:
 325      * it will only happen if style is SOCK_STREAM or SOCK_SEQPACKET, and only
 326      * if a backlog of un-accepted connections has built up in the kernel.)  */
 327     if (nonblock) {
 328         int flags = fcntl(fd, F_GETFL, 0);
 329         if (flags == -1) {
 330             error = errno;
 331             goto error;
 332         }
 333         if (fcntl(fd, F_SETFL, flags | O_NONBLOCK) == -1) {
 334             error = errno;
 335             goto error;
 336         }
 337     }
 338
 339     if (bind_path) {
 340         struct sockaddr_un un;
 341         socklen_t un_len;
 342         int dirfd;
 343
 344         if (unlink(bind_path) && errno != ENOENT) {
 345             VLOG_WARN("unlinking \"%s\": %s\n", bind_path, strerror(errno));
 346         }
 347         fatal_signal_add_file_to_unlink(bind_path);
 348
 349         error = make_sockaddr_un(bind_path, &un, &un_len, &dirfd);
 350         if (!error && (bind(fd, (struct sockaddr*) &un, un_len)
 351                        || fchmod(fd, S_IRWXU))) {
 352             error = errno;
 353         }
 354         if (dirfd >= 0) {
 355             close(dirfd);
 356         }
 357         if (error) {
 358             goto error;
 359         }
 360     }
 361
 362     if (connect_path) {
 363         struct sockaddr_un un;
 364         socklen_t un_len;
 365         int dirfd;
 366
 367         error = make_sockaddr_un(connect_path, &un, &un_len, &dirfd);
 368         if (!error
 369             && connect(fd, (struct sockaddr*) &un, un_len)
 370             && errno != EINPROGRESS) {
 371             error = errno;
 372         }
 373         if (dirfd >= 0) {
 374             close(dirfd);
 375         }
 376         if (error) {
 377             goto error;
 378         }
 379     }
 380
 381 #ifdef SCM_CREDENTIALS
 382     if (passcred) {
 383         int enable = 1;
 384         if (setsockopt(fd, SOL_SOCKET, SO_PASSCRED, &enable, sizeof(enable))) {
 385             error = errno;
 386             goto error;
 387         }
 388     }
 389 #endif
 390
 391     return fd;
 392
 393 error:
 394     if (error == EAGAIN) {
 395         error = EPROTO;
 396     }
 397     if (bind_path) {
 398         fatal_signal_remove_file_to_unlink(bind_path);
 399     }
 400     close(fd);
 401     return -error;
 402 }
 403
 404 int
 405 get_unix_name_len(socklen_t sun_len)
 406 {
 407     return (sun_len >= offsetof(struct sockaddr_un, sun_path)
 408             ? sun_len - offsetof(struct sockaddr_un, sun_path)
 409             : 0);
 410 }
 411
 412 uint32_t
 413 guess_netmask(uint32_t ip)
 414 {
 415     ip = ntohl(ip);
 416     return ((ip >> 31) == 0 ? htonl(0xff000000)   /* Class A */
 417             : (ip >> 30) == 2 ? htonl(0xffff0000) /* Class B */
 418             : (ip >> 29) == 6 ? htonl(0xffffff00) /* Class C */
 419             : htonl(0));                          /* ??? */
 420 }
 421
 422 /* Parses 'target', which should be a string in the format "<host>[:<port>]".
 423  * <host> is required.  If 'default_port' is nonzero then <port> is optional
 424  * and defaults to 'default_port'.
 425  *
 426  * On success, returns true and stores the parsed remote address into '*sinp'.
 427  * On failure, logs an error, stores zeros into '*sinp', and returns false. */
 428 bool
 429 inet_parse_active(const char *target_, uint16_t default_port,
 430                   struct sockaddr_in *sinp)
 431 {
 432     char *target = xstrdup(target_);
 433     char *save_ptr = NULL;
 434     const char *host_name;
 435     const char *port_string;
 436     bool ok = false;
 437
 438     /* Defaults. */
 439     sinp->sin_family = AF_INET;
 440     sinp->sin_port = htons(default_port);
 441
 442     /* Tokenize. */
 443     host_name = strtok_r(target, ":", &save_ptr);
 444     port_string = strtok_r(NULL, ":", &save_ptr);
 445     if (!host_name) {
 446         VLOG_ERR("%s: bad peer name format", target_);
 447         goto exit;
 448     }
 449
 450     /* Look up IP, port. */
 451     if (lookup_ip(host_name, &sinp->sin_addr)) {
 452         goto exit;
 453     }
 454     if (port_string && atoi(port_string)) {
 455         sinp->sin_port = htons(atoi(port_string));
 456     } else if (!default_port) {
 457         VLOG_ERR("%s: port number must be specified", target_);
 458         goto exit;
 459     }
 460
 461     ok = true;
 462
 463 exit:
 464     if (!ok) {
 465         memset(sinp, 0, sizeof *sinp);
 466     }
 467     free(target);
 468     return ok;
 469 }
 470
 471 /* Opens a non-blocking IPv4 socket of the specified 'style' and connects to
 472  * 'target', which should be a string in the format "<host>[:<port>]".  <host>
 473  * is required.  If 'default_port' is nonzero then <port> is optional and
 474  * defaults to 'default_port'.
 475  *
 476  * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
 477  *
 478  * On success, returns 0 (indicating connection complete) or EAGAIN (indicating
 479  * connection in progress), in which case the new file descriptor is stored
 480  * into '*fdp'.  On failure, returns a positive errno value other than EAGAIN
 481  * and stores -1 into '*fdp'.
 482  *
 483  * If 'sinp' is non-null, then on success the target address is stored into
 484  * '*sinp'. */
 485 int
 486 inet_open_active(int style, const char *target, uint16_t default_port,
 487                  struct sockaddr_in *sinp, int *fdp)
 488 {
 489     struct sockaddr_in sin;
 490     int fd = -1;
 491     int error;
 492
 493     /* Parse. */
 494     if (!inet_parse_active(target, default_port, &sin)) {
 495         error = EAFNOSUPPORT;
 496         goto exit;
 497     }
 498
 499     /* Create non-blocking socket. */
 500     fd = socket(AF_INET, style, 0);
 501     if (fd < 0) {
 502         VLOG_ERR("%s: socket: %s", target, strerror(errno));
 503         error = errno;
 504         goto exit;
 505     }
 506     error = set_nonblocking(fd);
 507     if (error) {
 508         goto exit_close;
 509     }
 510
 511     /* Connect. */
 512     error = connect(fd, (struct sockaddr *) &sin, sizeof sin) == 0 ? 0 : errno;
 513     if (error == EINPROGRESS) {
 514         error = EAGAIN;
 515     } else if (error && error != EAGAIN) {
 516         goto exit_close;
 517     }
 518
 519     /* Success: error is 0 or EAGAIN. */
 520     goto exit;
 521
 522 exit_close:
 523     close(fd);
 524 exit:
 525     if (!error || error == EAGAIN) {
 526         if (sinp) {
 527             *sinp = sin;
 528         }
 529         *fdp = fd;
 530     } else {
 531         *fdp = -1;
 532     }
 533     return error;
 534 }
 535
 536 /* Opens a non-blocking IPv4 socket of the specified 'style', binds to
 537  * 'target', and listens for incoming connections.  'target' should be a string
 538  * in the format "[<port>][:<ip>]":
 539  *
 540  *      - If 'default_port' is -1, then <port> is required.  Otherwise, if
 541  *        <port> is omitted, then 'default_port' is used instead.
 542  *
 543  *      - If <port> (or 'default_port', if used) is 0, then no port is bound
 544  *        and the TCP/IP stack will select a port.
 545  *
 546  *      - If <ip> is omitted then the IP address is wildcarded.
 547  *
 548  * 'style' should be SOCK_STREAM (for TCP) or SOCK_DGRAM (for UDP).
 549  *
 550  * For TCP, the socket will have SO_REUSEADDR turned on.
 551  *
 552  * On success, returns a non-negative file descriptor.  On failure, returns a
 553  * negative errno value.
 554  *
 555  * If 'sinp' is non-null, then on success the bound address is stored into
 556  * '*sinp'. */
 557 int
 558 inet_open_passive(int style, const char *target_, int default_port,
 559                   struct sockaddr_in *sinp)
 560 {
 561     char *target = xstrdup(target_);
 562     char *string_ptr = target;
 563     struct sockaddr_in sin;
 564     const char *host_name;
 565     const char *port_string;
 566     int fd = 0, error, port;
 567     unsigned int yes  = 1;
 568
 569     /* Address defaults. */
 570     memset(&sin, 0, sizeof sin);
 571     sin.sin_family = AF_INET;
 572     sin.sin_addr.s_addr = htonl(INADDR_ANY);
 573     sin.sin_port = htons(default_port);
 574
 575     /* Parse optional port number. */
 576     port_string = strsep(&string_ptr, ":");
 577     if (port_string && str_to_int(port_string, 10, &port)) {
 578         sin.sin_port = htons(port);
 579     } else if (default_port < 0) {
 580         VLOG_ERR("%s: port number must be specified", target_);
 581         error = EAFNOSUPPORT;
 582         goto exit;
 583     }
 584
 585     /* Parse optional bind IP. */
 586     host_name = strsep(&string_ptr, ":");
 587     if (host_name && host_name[0]) {
 588         error = lookup_ip(host_name, &sin.sin_addr);
 589         if (error) {
 590             goto exit;
 591         }
 592     }
 593
 594     /* Create non-blocking socket, set SO_REUSEADDR. */
 595     fd = socket(AF_INET, style, 0);
 596     if (fd < 0) {
 597         error = errno;
 598         VLOG_ERR("%s: socket: %s", target_, strerror(error));
 599         goto exit;
 600     }
 601     error = set_nonblocking(fd);
 602     if (error) {
 603         goto exit_close;
 604     }
 605     if (style == SOCK_STREAM
 606         && setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &yes, sizeof yes) < 0) {
 607         error = errno;
 608         VLOG_ERR("%s: setsockopt(SO_REUSEADDR): %s", target_, strerror(error));
 609         goto exit_close;
 610     }
 611
 612     /* Bind. */
 613     if (bind(fd, (struct sockaddr *) &sin, sizeof sin) < 0) {
 614         error = errno;
 615         VLOG_ERR("%s: bind: %s", target_, strerror(error));
 616         goto exit_close;
 617     }
 618
 619     /* Listen. */
 620     if (listen(fd, 10) < 0) {
 621         error = errno;
 622         VLOG_ERR("%s: listen: %s", target_, strerror(error));
 623         goto exit_close;
 624     }
 625
 626     if (sinp) {
 627         socklen_t sin_len = sizeof sin;
 628         if (getsockname(fd, (struct sockaddr *) &sin, &sin_len) < 0){
 629             error = errno;
 630             VLOG_ERR("%s: getsockname: %s", target_, strerror(error));
 631             goto exit_close;
 632         }
 633         if (sin.sin_family != AF_INET || sin_len != sizeof sin) {
 634             VLOG_ERR("%s: getsockname: invalid socket name", target_);
 635             goto exit_close;
 636         }
 637         *sinp = sin;
 638     }
 639
 640     error = 0;
 641     goto exit;
 642
 643 exit_close:
 644     close(fd);
 645 exit:
 646     free(target);
 647     return error ? -error : fd;
 648 }
 649
 650 /* Returns a readable and writable fd for /dev/null, if successful, otherwise
 651  * a negative errno value.  The caller must not close the returned fd (because
 652  * the same fd will be handed out to subsequent callers). */
 653 int
 654 get_null_fd(void)
 655 {
 656     static int null_fd = -1;
 657     if (null_fd < 0) {
 658         null_fd = open("/dev/null", O_RDWR);
 659         if (null_fd < 0) {
 660             int error = errno;
 661             VLOG_ERR("could not open /dev/null: %s", strerror(error));
 662             return -error;
 663         }
 664     }
 665     return null_fd;
 666 }
 667
 668 int
 669 read_fully(int fd, void *p_, size_t size, size_t *bytes_read)
 670 {
 671     uint8_t *p = p_;
 672
 673     *bytes_read = 0;
 674     while (size > 0) {
 675         ssize_t retval = read(fd, p, size);
 676         if (retval > 0) {
 677             *bytes_read += retval;
 678             size -= retval;
 679             p += retval;
 680         } else if (retval == 0) {
 681             return EOF;
 682         } else if (errno != EINTR) {
 683             return errno;
 684         }
 685     }
 686     return 0;
 687 }
 688
 689 int
 690 write_fully(int fd, const void *p_, size_t size, size_t *bytes_written)
 691 {
 692     const uint8_t *p = p_;
 693
 694     *bytes_written = 0;
 695     while (size > 0) {
 696         ssize_t retval = write(fd, p, size);
 697         if (retval > 0) {
 698             *bytes_written += retval;
 699             size -= retval;
 700             p += retval;
 701         } else if (retval == 0) {
 702             VLOG_WARN("write returned 0");
 703             return EPROTO;
 704         } else if (errno != EINTR) {
 705             return errno;
 706         }
 707     }
 708     return 0;
 709 }
 710
 711 /* Given file name 'file_name', fsyncs the directory in which it is contained.
 712  * Returns 0 if successful, otherwise a positive errno value. */
 713 int
 714 fsync_parent_dir(const char *file_name)
 715 {
 716     int error = 0;
 717     char *dir;
 718     int fd;
 719
 720     dir = dir_name(file_name);
 721     fd = open(dir, O_RDONLY);
 722     if (fd >= 0) {
 723         if (fsync(fd)) {
 724             if (errno == EINVAL || errno == EROFS) {
 725                 /* This directory does not support synchronization.  Not
 726                  * really an error. */
 727             } else {
 728                 error = errno;
 729                 VLOG_ERR("%s: fsync failed (%s)", dir, strerror(error));
 730             }
 731         }
 732         close(fd);
 733     } else {
 734         error = errno;
 735         VLOG_ERR("%s: open failed (%s)", dir, strerror(error));
 736     }
 737     free(dir);
 738
 739     return error;
 740 }
 741
 742 /* Obtains the modification time of the file named 'file_name' to the greatest
 743  * supported precision.  If successful, stores the mtime in '*mtime' and
 744  * returns 0.  On error, returns a positive errno value and stores zeros in
 745  * '*mtime'. */
 746 int
 747 get_mtime(const char *file_name, struct timespec *mtime)
 748 {
 749     struct stat s;
 750
 751     if (!stat(file_name, &s)) {
 752         mtime->tv_sec = s.st_mtime;
 753
 754 #if HAVE_STRUCT_STAT_ST_MTIM_TV_NSEC
 755         mtime->tv_nsec = s.st_mtim.tv_nsec;
 756 #elif HAVE_STRUCT_STAT_ST_MTIMENSEC
 757         mtime->tv_nsec = s.st_mtimensec;
 758 #else
 759         mtime->tv_nsec = 0;
 760 #endif
 761
 762         return 0;
 763     } else {
 764         mtime->tv_sec = mtime->tv_nsec = 0;
 765         return errno;
 766     }
 767 }
 768