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