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