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