folly/FileUtil.h

   1 /*
   2  * Copyright 2015 Facebook, Inc.
   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 #ifndef FOLLY_FILEUTIL_H_
  18 #define FOLLY_FILEUTIL_H_
  19
  20 #include <folly/Conv.h>
  21 #include <folly/Portability.h>
  22 #include <folly/ScopeGuard.h>
  23
  24 #include <cassert>
  25 #include <limits>
  26 #include <sys/stat.h>
  27 #include <sys/types.h>
  28 #include <sys/uio.h>
  29 #include <fcntl.h>
  30 #include <unistd.h>
  31
  32 namespace folly {
  33
  34 /**
  35  * Convenience wrappers around some commonly used system calls.  The *NoInt
  36  * wrappers retry on EINTR.  The *Full wrappers retry on EINTR and also loop
  37  * until all data is written.  Note that *Full wrappers weaken the thread
  38  * semantics of underlying system calls.
  39  */
  40 int openNoInt(const char* name, int flags, mode_t mode = 0666);
  41 int closeNoInt(int fd);
  42 int dupNoInt(int fd);
  43 int dup2NoInt(int oldfd, int newfd);
  44 int fsyncNoInt(int fd);
  45 int fdatasyncNoInt(int fd);
  46 int ftruncateNoInt(int fd, off_t len);
  47 int truncateNoInt(const char* path, off_t len);
  48 int flockNoInt(int fd, int operation);
  49 int shutdownNoInt(int fd, int how);
  50
  51 ssize_t readNoInt(int fd, void* buf, size_t n);
  52 ssize_t preadNoInt(int fd, void* buf, size_t n, off_t offset);
  53 ssize_t readvNoInt(int fd, const iovec* iov, int count);
  54
  55 ssize_t writeNoInt(int fd, const void* buf, size_t n);
  56 ssize_t pwriteNoInt(int fd, const void* buf, size_t n, off_t offset);
  57 ssize_t writevNoInt(int fd, const iovec* iov, int count);
  58
  59 /**
  60  * Wrapper around read() (and pread()) that, in addition to retrying on
  61  * EINTR, will loop until all data is read.
  62  *
  63  * This wrapper is only useful for blocking file descriptors (for non-blocking
  64  * file descriptors, you have to be prepared to deal with incomplete reads
  65  * anyway), and only exists because POSIX allows read() to return an incomplete
  66  * read if interrupted by a signal (instead of returning -1 and setting errno
  67  * to EINTR).
  68  *
  69  * Note that this wrapper weakens the thread safety of read(): the file pointer
  70  * is shared between threads, but the system call is atomic.  If multiple
  71  * threads are reading from a file at the same time, you don't know where your
  72  * data came from in the file, but you do know that the returned bytes were
  73  * contiguous.  You can no longer make this assumption if using readFull().
  74  * You should probably use pread() when reading from the same file descriptor
  75  * from multiple threads simultaneously, anyway.
  76  *
  77  * Note that readvFull and preadvFull require iov to be non-const, unlike
  78  * readv and preadv.  The contents of iov after these functions return
  79  * is unspecified.
  80  */
  81 ssize_t readFull(int fd, void* buf, size_t n);
  82 ssize_t preadFull(int fd, void* buf, size_t n, off_t offset);
  83 ssize_t readvFull(int fd, iovec* iov, int count);
  84 #if FOLLY_HAVE_PREADV
  85 ssize_t preadvFull(int fd, iovec* iov, int count, off_t offset);
  86 #endif
  87
  88 /**
  89  * Similar to readFull and preadFull above, wrappers around write() and
  90  * pwrite() that loop until all data is written.
  91  *
  92  * Generally, the write() / pwrite() system call may always write fewer bytes
  93  * than requested, just like read().  In certain cases (such as when writing to
  94  * a pipe), POSIX provides stronger guarantees, but not in the general case.
  95  * For example, Linux (even on a 64-bit platform) won't write more than 2GB in
  96  * one write() system call.
  97  *
  98  * Note that writevFull and pwritevFull require iov to be non-const, unlike
  99  * writev and pwritev.  The contents of iov after these functions return
 100  * is unspecified.
 101  */
 102 ssize_t writeFull(int fd, const void* buf, size_t n);
 103 ssize_t pwriteFull(int fd, const void* buf, size_t n, off_t offset);
 104 ssize_t writevFull(int fd, iovec* iov, int count);
 105 #if FOLLY_HAVE_PWRITEV
 106 ssize_t pwritevFull(int fd, iovec* iov, int count, off_t offset);
 107 #endif
 108
 109 /**
 110  * Read entire file (if num_bytes is defaulted) or no more than
 111  * num_bytes (otherwise) into container *out. The container is assumed
 112  * to be contiguous, with element size equal to 1, and offer size(),
 113  * reserve(), and random access (e.g. std::vector<char>, std::string,
 114  * fbstring).
 115  *
 116  * Returns: true on success or false on failure. In the latter case
 117  * errno will be set appropriately by the failing system primitive.
 118  */
 119 template <class Container>
 120 bool readFile(const char* file_name, Container& out,
 121               size_t num_bytes = std::numeric_limits<size_t>::max()) {
 122   static_assert(sizeof(out[0]) == 1,
 123                 "readFile: only containers with byte-sized elements accepted");
 124   assert(file_name);
 125
 126   const auto fd = openNoInt(file_name, O_RDONLY);
 127   if (fd == -1) return false;
 128
 129   size_t soFar = 0; // amount of bytes successfully read
 130   SCOPE_EXIT {
 131     assert(out.size() >= soFar); // resize better doesn't throw
 132     out.resize(soFar);
 133     // Ignore errors when closing the file
 134     closeNoInt(fd);
 135   };
 136
 137   // Obtain file size:
 138   struct stat buf;
 139   if (fstat(fd, &buf) == -1) return false;
 140   // Some files (notably under /proc and /sys on Linux) lie about
 141   // their size, so treat the size advertised by fstat under advise
 142   // but don't rely on it. In particular, if the size is zero, we
 143   // should attempt to read stuff. If not zero, we'll attempt to read
 144   // one extra byte.
 145   constexpr size_t initialAlloc = 1024 * 4;
 146   out.resize(
 147     std::min(
 148       buf.st_size > 0 ? folly::to<size_t>(buf.st_size + 1) : initialAlloc,
 149       num_bytes));
 150
 151   while (soFar < out.size()) {
 152     const auto actual = readFull(fd, &out[soFar], out.size() - soFar);
 153     if (actual == -1) {
 154       return false;
 155     }
 156     soFar += actual;
 157     if (soFar < out.size()) {
 158       // File exhausted
 159       break;
 160     }
 161     // Ew, allocate more memory. Use exponential growth to avoid
 162     // quadratic behavior. Cap size to num_bytes.
 163     out.resize(std::min(out.size() * 3 / 2, num_bytes));
 164   }
 165
 166   return true;
 167 }
 168
 169 /**
 170  * Writes container to file. The container is assumed to be
 171  * contiguous, with element size equal to 1, and offering STL-like
 172  * methods empty(), size(), and indexed access
 173  * (e.g. std::vector<char>, std::string, fbstring, StringPiece).
 174  *
 175  * "flags" dictates the open flags to use. Default is to create file
 176  * if it doesn't exist and truncate it.
 177  *
 178  * Returns: true on success or false on failure. In the latter case
 179  * errno will be set appropriately by the failing system primitive.
 180  */
 181 template <class Container>
 182 bool writeFile(const Container& data, const char* filename,
 183               int flags = O_WRONLY | O_CREAT | O_TRUNC) {
 184   static_assert(sizeof(data[0]) == 1,
 185                 "writeFile works with element size equal to 1");
 186   int fd = open(filename, flags, 0666);
 187   if (fd == -1) {
 188     return false;
 189   }
 190   bool ok = data.empty() ||
 191     writeFull(fd, &data[0], data.size()) == static_cast<ssize_t>(data.size());
 192   return closeNoInt(fd) == 0 && ok;
 193 }
 194
 195 }  // namespaces
 196
 197 #endif /* FOLLY_FILEUTIL_H_ */