lib/Support/MemoryBuffer.cpp

   1 //===--- MemoryBuffer.cpp - Memory Buffer implementation ------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 //  This file implements the MemoryBuffer interface.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/Support/MemoryBuffer.h"
  15 #include "llvm/ADT/OwningPtr.h"
  16 #include "llvm/ADT/SmallString.h"
  17 #include "llvm/Config/config.h"
  18 #include "llvm/Support/Errno.h"
  19 #include "llvm/Support/FileSystem.h"
  20 #include "llvm/Support/MathExtras.h"
  21 #include "llvm/Support/Path.h"
  22 #include "llvm/Support/Process.h"
  23 #include "llvm/Support/Program.h"
  24 #include "llvm/Support/system_error.h"
  25 #include <cassert>
  26 #include <cerrno>
  27 #include <cstdio>
  28 #include <cstring>
  29 #include <new>
  30 #include <sys/stat.h>
  31 #include <sys/types.h>
  32 #if !defined(_MSC_VER) && !defined(__MINGW32__)
  33 #include <unistd.h>
  34 #else
  35 #include <io.h>
  36 // Simplistic definitinos of these macros for use in getOpenFile.
  37 #ifndef S_ISREG
  38 #define S_ISREG(x) (1)
  39 #endif
  40 #ifndef S_ISBLK
  41 #define S_ISBLK(x) (0)
  42 #endif
  43 #endif
  44 using namespace llvm;
  45
  46 //===----------------------------------------------------------------------===//
  47 // MemoryBuffer implementation itself.
  48 //===----------------------------------------------------------------------===//
  49
  50 MemoryBuffer::~MemoryBuffer() { }
  51
  52 /// init - Initialize this MemoryBuffer as a reference to externally allocated
  53 /// memory, memory that we know is already null terminated.
  54 void MemoryBuffer::init(const char *BufStart, const char *BufEnd,
  55                         bool RequiresNullTerminator) {
  56   assert((!RequiresNullTerminator || BufEnd[0] == 0) &&
  57          "Buffer is not null terminated!");
  58   BufferStart = BufStart;
  59   BufferEnd = BufEnd;
  60 }
  61
  62 //===----------------------------------------------------------------------===//
  63 // MemoryBufferMem implementation.
  64 //===----------------------------------------------------------------------===//
  65
  66 /// CopyStringRef - Copies contents of a StringRef into a block of memory and
  67 /// null-terminates it.
  68 static void CopyStringRef(char *Memory, StringRef Data) {
  69   memcpy(Memory, Data.data(), Data.size());
  70   Memory[Data.size()] = 0; // Null terminate string.
  71 }
  72
  73 namespace {
  74 struct NamedBufferAlloc {
  75   StringRef Name;
  76   NamedBufferAlloc(StringRef Name) : Name(Name) {}
  77 };
  78 }
  79
  80 void *operator new(size_t N, const NamedBufferAlloc &Alloc) {
  81   char *Mem = static_cast<char *>(operator new(N + Alloc.Name.size() + 1));
  82   CopyStringRef(Mem + N, Alloc.Name);
  83   return Mem;
  84 }
  85
  86 namespace {
  87 /// MemoryBufferMem - Named MemoryBuffer pointing to a block of memory.
  88 class MemoryBufferMem : public MemoryBuffer {
  89 public:
  90   MemoryBufferMem(StringRef InputData, bool RequiresNullTerminator) {
  91     init(InputData.begin(), InputData.end(), RequiresNullTerminator);
  92   }
  93
  94   virtual const char *getBufferIdentifier() const LLVM_OVERRIDE {
  95      // The name is stored after the class itself.
  96     return reinterpret_cast<const char*>(this + 1);
  97   }
  98
  99   virtual BufferKind getBufferKind() const LLVM_OVERRIDE {
 100     return MemoryBuffer_Malloc;
 101   }
 102 };
 103 }
 104
 105 /// getMemBuffer - Open the specified memory range as a MemoryBuffer.  Note
 106 /// that InputData must be a null terminated if RequiresNullTerminator is true!
 107 MemoryBuffer *MemoryBuffer::getMemBuffer(StringRef InputData,
 108                                          StringRef BufferName,
 109                                          bool RequiresNullTerminator) {
 110   return new (NamedBufferAlloc(BufferName))
 111       MemoryBufferMem(InputData, RequiresNullTerminator);
 112 }
 113
 114 /// getMemBufferCopy - Open the specified memory range as a MemoryBuffer,
 115 /// copying the contents and taking ownership of it.  This has no requirements
 116 /// on EndPtr[0].
 117 MemoryBuffer *MemoryBuffer::getMemBufferCopy(StringRef InputData,
 118                                              StringRef BufferName) {
 119   MemoryBuffer *Buf = getNewUninitMemBuffer(InputData.size(), BufferName);
 120   if (!Buf) return 0;
 121   memcpy(const_cast<char*>(Buf->getBufferStart()), InputData.data(),
 122          InputData.size());
 123   return Buf;
 124 }
 125
 126 /// getNewUninitMemBuffer - Allocate a new MemoryBuffer of the specified size
 127 /// that is not initialized.  Note that the caller should initialize the
 128 /// memory allocated by this method.  The memory is owned by the MemoryBuffer
 129 /// object.
 130 MemoryBuffer *MemoryBuffer::getNewUninitMemBuffer(size_t Size,
 131                                                   StringRef BufferName) {
 132   // Allocate space for the MemoryBuffer, the data and the name. It is important
 133   // that MemoryBuffer and data are aligned so PointerIntPair works with them.
 134   // TODO: Is 16-byte alignment enough?  We copy small object files with large
 135   // alignment expectations into this buffer.
 136   size_t AlignedStringLen =
 137       RoundUpToAlignment(sizeof(MemoryBufferMem) + BufferName.size() + 1, 16);
 138   size_t RealLen = AlignedStringLen + Size + 1;
 139   char *Mem = static_cast<char*>(operator new(RealLen, std::nothrow));
 140   if (!Mem) return 0;
 141
 142   // The name is stored after the class itself.
 143   CopyStringRef(Mem + sizeof(MemoryBufferMem), BufferName);
 144
 145   // The buffer begins after the name and must be aligned.
 146   char *Buf = Mem + AlignedStringLen;
 147   Buf[Size] = 0; // Null terminate buffer.
 148
 149   return new (Mem) MemoryBufferMem(StringRef(Buf, Size), true);
 150 }
 151
 152 /// getNewMemBuffer - Allocate a new MemoryBuffer of the specified size that
 153 /// is completely initialized to zeros.  Note that the caller should
 154 /// initialize the memory allocated by this method.  The memory is owned by
 155 /// the MemoryBuffer object.
 156 MemoryBuffer *MemoryBuffer::getNewMemBuffer(size_t Size, StringRef BufferName) {
 157   MemoryBuffer *SB = getNewUninitMemBuffer(Size, BufferName);
 158   if (!SB) return 0;
 159   memset(const_cast<char*>(SB->getBufferStart()), 0, Size);
 160   return SB;
 161 }
 162
 163
 164 /// getFileOrSTDIN - Open the specified file as a MemoryBuffer, or open stdin
 165 /// if the Filename is "-".  If an error occurs, this returns null and fills
 166 /// in *ErrStr with a reason.  If stdin is empty, this API (unlike getSTDIN)
 167 /// returns an empty buffer.
 168 error_code MemoryBuffer::getFileOrSTDIN(StringRef Filename,
 169                                         OwningPtr<MemoryBuffer> &result,
 170                                         int64_t FileSize) {
 171   if (Filename == "-")
 172     return getSTDIN(result);
 173   return getFile(Filename, result, FileSize);
 174 }
 175
 176 //===----------------------------------------------------------------------===//
 177 // MemoryBuffer::getFile implementation.
 178 //===----------------------------------------------------------------------===//
 179
 180 namespace {
 181 /// \brief Memory maps a file descriptor using sys::fs::mapped_file_region.
 182 ///
 183 /// This handles converting the offset into a legal offset on the platform.
 184 class MemoryBufferMMapFile : public MemoryBuffer {
 185   sys::fs::mapped_file_region MFR;
 186
 187   static uint64_t getLegalMapOffset(uint64_t Offset) {
 188     return Offset & ~(sys::fs::mapped_file_region::alignment() - 1);
 189   }
 190
 191   static uint64_t getLegalMapSize(uint64_t Len, uint64_t Offset) {
 192     return Len + (Offset - getLegalMapOffset(Offset));
 193   }
 194
 195   const char *getStart(uint64_t Len, uint64_t Offset) {
 196     return MFR.const_data() + (Offset - getLegalMapOffset(Offset));
 197   }
 198
 199 public:
 200   MemoryBufferMMapFile(bool RequiresNullTerminator, int FD, uint64_t Len,
 201                        uint64_t Offset, error_code EC)
 202       : MFR(FD, false, sys::fs::mapped_file_region::readonly,
 203             getLegalMapSize(Len, Offset), getLegalMapOffset(Offset), EC) {
 204     if (!EC) {
 205       const char *Start = getStart(Len, Offset);
 206       init(Start, Start + Len, RequiresNullTerminator);
 207     }
 208   }
 209
 210   virtual const char *getBufferIdentifier() const LLVM_OVERRIDE {
 211     // The name is stored after the class itself.
 212     return reinterpret_cast<const char *>(this + 1);
 213   }
 214
 215   virtual BufferKind getBufferKind() const LLVM_OVERRIDE {
 216     return MemoryBuffer_MMap;
 217   }
 218 };
 219 }
 220
 221 static error_code getMemoryBufferForStream(int FD,
 222                                            StringRef BufferName,
 223                                            OwningPtr<MemoryBuffer> &result) {
 224   const ssize_t ChunkSize = 4096*4;
 225   SmallString<ChunkSize> Buffer;
 226   ssize_t ReadBytes;
 227   // Read into Buffer until we hit EOF.
 228   do {
 229     Buffer.reserve(Buffer.size() + ChunkSize);
 230     ReadBytes = read(FD, Buffer.end(), ChunkSize);
 231     if (ReadBytes == -1) {
 232       if (errno == EINTR) continue;
 233       return error_code(errno, posix_category());
 234     }
 235     Buffer.set_size(Buffer.size() + ReadBytes);
 236   } while (ReadBytes != 0);
 237
 238   result.reset(MemoryBuffer::getMemBufferCopy(Buffer, BufferName));
 239   return error_code::success();
 240 }
 241
 242 static error_code getFileAux(const char *Filename,
 243                              OwningPtr<MemoryBuffer> &result, int64_t FileSize,
 244                              bool RequiresNullTerminator);
 245
 246 error_code MemoryBuffer::getFile(Twine Filename,
 247                                  OwningPtr<MemoryBuffer> &result,
 248                                  int64_t FileSize,
 249                                  bool RequiresNullTerminator) {
 250   // Ensure the path is null terminated.
 251   SmallString<256> PathBuf;
 252   StringRef NullTerminatedName = Filename.toNullTerminatedStringRef(PathBuf);
 253   return getFileAux(NullTerminatedName.data(), result, FileSize,
 254                     RequiresNullTerminator);
 255 }
 256
 257 static error_code getOpenFileImpl(int FD, const char *Filename,
 258                                   OwningPtr<MemoryBuffer> &Result,
 259                                   uint64_t FileSize, uint64_t MapSize,
 260                                   int64_t Offset, bool RequiresNullTerminator);
 261
 262 static error_code getFileAux(const char *Filename,
 263                              OwningPtr<MemoryBuffer> &result, int64_t FileSize,
 264                              bool RequiresNullTerminator) {
 265   int FD;
 266   error_code EC = sys::fs::openFileForRead(Filename, FD);
 267   if (EC)
 268     return EC;
 269
 270   error_code ret = getOpenFileImpl(FD, Filename, result, FileSize, FileSize, 0,
 271                                    RequiresNullTerminator);
 272   close(FD);
 273   return ret;
 274 }
 275
 276 static bool shouldUseMmap(int FD,
 277                           size_t FileSize,
 278                           size_t MapSize,
 279                           off_t Offset,
 280                           bool RequiresNullTerminator,
 281                           int PageSize) {
 282   // We don't use mmap for small files because this can severely fragment our
 283   // address space.
 284   if (MapSize < 4 * 4096 || MapSize < (unsigned)PageSize)
 285     return false;
 286
 287   if (!RequiresNullTerminator)
 288     return true;
 289
 290
 291   // If we don't know the file size, use fstat to find out.  fstat on an open
 292   // file descriptor is cheaper than stat on a random path.
 293   // FIXME: this chunk of code is duplicated, but it avoids a fstat when
 294   // RequiresNullTerminator = false and MapSize != -1.
 295   if (FileSize == size_t(-1)) {
 296     sys::fs::file_status Status;
 297     error_code EC = sys::fs::status(FD, Status);
 298     if (EC)
 299       return EC;
 300     FileSize = Status.getSize();
 301   }
 302
 303   // If we need a null terminator and the end of the map is inside the file,
 304   // we cannot use mmap.
 305   size_t End = Offset + MapSize;
 306   assert(End <= FileSize);
 307   if (End != FileSize)
 308     return false;
 309
 310 #if defined(_WIN32) || defined(__CYGWIN__)
 311   // Don't peek the next page if file is multiple of *physical* pagesize(4k)
 312   // but is not multiple of AllocationGranularity(64k),
 313   // when a null terminator is required.
 314   // FIXME: It's not good to hardcode 4096 here. dwPageSize shows 4096.
 315   if ((FileSize & (4096 - 1)) == 0)
 316     return false;
 317 #endif
 318
 319   // Don't try to map files that are exactly a multiple of the system page size
 320   // if we need a null terminator.
 321   if ((FileSize & (PageSize -1)) == 0)
 322     return false;
 323
 324   return true;
 325 }
 326
 327 static error_code getOpenFileImpl(int FD, const char *Filename,
 328                                   OwningPtr<MemoryBuffer> &result,
 329                                   uint64_t FileSize, uint64_t MapSize,
 330                                   int64_t Offset, bool RequiresNullTerminator) {
 331   static int PageSize = sys::process::get_self()->page_size();
 332
 333   // Default is to map the full file.
 334   if (MapSize == uint64_t(-1)) {
 335     // If we don't know the file size, use fstat to find out.  fstat on an open
 336     // file descriptor is cheaper than stat on a random path.
 337     if (FileSize == uint64_t(-1)) {
 338       sys::fs::file_status Status;
 339       error_code EC = sys::fs::status(FD, Status);
 340       if (EC)
 341         return EC;
 342
 343       // If this not a file or a block device (e.g. it's a named pipe
 344       // or character device), we can't trust the size. Create the memory
 345       // buffer by copying off the stream.
 346       sys::fs::file_type Type = Status.type();
 347       if (Type != sys::fs::file_type::regular_file &&
 348           Type != sys::fs::file_type::block_file)
 349         return getMemoryBufferForStream(FD, Filename, result);
 350
 351       FileSize = Status.getSize();
 352     }
 353     MapSize = FileSize;
 354   }
 355
 356   if (shouldUseMmap(FD, FileSize, MapSize, Offset, RequiresNullTerminator,
 357                     PageSize)) {
 358     error_code EC;
 359     result.reset(new (NamedBufferAlloc(Filename)) MemoryBufferMMapFile(
 360         RequiresNullTerminator, FD, MapSize, Offset, EC));
 361     if (!EC)
 362       return error_code::success();
 363   }
 364
 365   MemoryBuffer *Buf = MemoryBuffer::getNewUninitMemBuffer(MapSize, Filename);
 366   if (!Buf) {
 367     // Failed to create a buffer. The only way it can fail is if
 368     // new(std::nothrow) returns 0.
 369     return make_error_code(errc::not_enough_memory);
 370   }
 371
 372   OwningPtr<MemoryBuffer> SB(Buf);
 373   char *BufPtr = const_cast<char*>(SB->getBufferStart());
 374
 375   size_t BytesLeft = MapSize;
 376 #ifndef HAVE_PREAD
 377   if (lseek(FD, Offset, SEEK_SET) == -1)
 378     return error_code(errno, posix_category());
 379 #endif
 380
 381   while (BytesLeft) {
 382 #ifdef HAVE_PREAD
 383     ssize_t NumRead = ::pread(FD, BufPtr, BytesLeft, MapSize-BytesLeft+Offset);
 384 #else
 385     ssize_t NumRead = ::read(FD, BufPtr, BytesLeft);
 386 #endif
 387     if (NumRead == -1) {
 388       if (errno == EINTR)
 389         continue;
 390       // Error while reading.
 391       return error_code(errno, posix_category());
 392     }
 393     if (NumRead == 0) {
 394       assert(0 && "We got inaccurate FileSize value or fstat reported an "
 395                    "invalid file size.");
 396       *BufPtr = '\0'; // null-terminate at the actual size.
 397       break;
 398     }
 399     BytesLeft -= NumRead;
 400     BufPtr += NumRead;
 401   }
 402
 403   result.swap(SB);
 404   return error_code::success();
 405 }
 406
 407 error_code MemoryBuffer::getOpenFile(int FD, const char *Filename,
 408                                      OwningPtr<MemoryBuffer> &Result,
 409                                      uint64_t FileSize,
 410                                      bool RequiresNullTerminator) {
 411   return getOpenFileImpl(FD, Filename, Result, FileSize, FileSize, 0,
 412                          RequiresNullTerminator);
 413 }
 414
 415 error_code MemoryBuffer::getOpenFileSlice(int FD, const char *Filename,
 416                                           OwningPtr<MemoryBuffer> &Result,
 417                                           uint64_t MapSize, int64_t Offset) {
 418   return getOpenFileImpl(FD, Filename, Result, -1, MapSize, Offset, false);
 419 }
 420
 421 //===----------------------------------------------------------------------===//
 422 // MemoryBuffer::getSTDIN implementation.
 423 //===----------------------------------------------------------------------===//
 424
 425 error_code MemoryBuffer::getSTDIN(OwningPtr<MemoryBuffer> &result) {
 426   // Read in all of the data from stdin, we cannot mmap stdin.
 427   //
 428   // FIXME: That isn't necessarily true, we should try to mmap stdin and
 429   // fallback if it fails.
 430   sys::ChangeStdinToBinary();
 431
 432   return getMemoryBufferForStream(0, "<stdin>", result);
 433 }