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/System/Path.h"
  18 #include "llvm/System/Process.h"
  19 #include "llvm/System/Program.h"
  20 #include <cassert>
  21 #include <cstdio>
  22 #include <cstring>
  23 #include <cerrno>
  24 #include <sys/types.h>
  25 #include <sys/stat.h>
  26 #if !defined(_MSC_VER) && !defined(__MINGW32__)
  27 #include <unistd.h>
  28 #include <sys/uio.h>
  29 #else
  30 #include <io.h>
  31 #endif
  32 #include <fcntl.h>
  33 using namespace llvm;
  34
  35 //===----------------------------------------------------------------------===//
  36 // MemoryBuffer implementation itself.
  37 //===----------------------------------------------------------------------===//
  38
  39 MemoryBuffer::~MemoryBuffer() {
  40   if (MustDeleteBuffer)
  41     free((void*)BufferStart);
  42 }
  43
  44 /// initCopyOf - Initialize this source buffer with a copy of the specified
  45 /// memory range.  We make the copy so that we can null terminate it
  46 /// successfully.
  47 void MemoryBuffer::initCopyOf(const char *BufStart, const char *BufEnd) {
  48   size_t Size = BufEnd-BufStart;
  49   BufferStart = (char *)malloc(Size+1);
  50   BufferEnd = BufferStart+Size;
  51   memcpy(const_cast<char*>(BufferStart), BufStart, Size);
  52   *const_cast<char*>(BufferEnd) = 0;   // Null terminate buffer.
  53   MustDeleteBuffer = true;
  54 }
  55
  56 /// init - Initialize this MemoryBuffer as a reference to externally allocated
  57 /// memory, memory that we know is already null terminated.
  58 void MemoryBuffer::init(const char *BufStart, const char *BufEnd) {
  59   assert(BufEnd[0] == 0 && "Buffer is not null terminated!");
  60   BufferStart = BufStart;
  61   BufferEnd = BufEnd;
  62   MustDeleteBuffer = false;
  63 }
  64
  65 //===----------------------------------------------------------------------===//
  66 // MemoryBufferMem implementation.
  67 //===----------------------------------------------------------------------===//
  68
  69 namespace {
  70 class MemoryBufferMem : public MemoryBuffer {
  71   std::string FileID;
  72 public:
  73   MemoryBufferMem(const char *Start, const char *End, StringRef FID,
  74                   bool Copy = false)
  75   : FileID(FID) {
  76     if (!Copy)
  77       init(Start, End);
  78     else
  79       initCopyOf(Start, End);
  80   }
  81
  82   virtual const char *getBufferIdentifier() const {
  83     return FileID.c_str();
  84   }
  85 };
  86 }
  87
  88 /// getMemBuffer - Open the specified memory range as a MemoryBuffer.  Note
  89 /// that EndPtr[0] must be a null byte and be accessible!
  90 MemoryBuffer *MemoryBuffer::getMemBuffer(const char *StartPtr,
  91                                          const char *EndPtr,
  92                                          const char *BufferName) {
  93   return new MemoryBufferMem(StartPtr, EndPtr, BufferName);
  94 }
  95
  96 /// getMemBufferCopy - Open the specified memory range as a MemoryBuffer,
  97 /// copying the contents and taking ownership of it.  This has no requirements
  98 /// on EndPtr[0].
  99 MemoryBuffer *MemoryBuffer::getMemBufferCopy(const char *StartPtr,
 100                                              const char *EndPtr,
 101                                              const char *BufferName) {
 102   return new MemoryBufferMem(StartPtr, EndPtr, BufferName, true);
 103 }
 104
 105 /// getNewUninitMemBuffer - Allocate a new MemoryBuffer of the specified size
 106 /// that is completely initialized to zeros.  Note that the caller should
 107 /// initialize the memory allocated by this method.  The memory is owned by
 108 /// the MemoryBuffer object.
 109 MemoryBuffer *MemoryBuffer::getNewUninitMemBuffer(size_t Size,
 110                                                   StringRef BufferName) {
 111   char *Buf = (char *)malloc(Size+1);
 112   if (!Buf) return 0;
 113   Buf[Size] = 0;
 114   MemoryBufferMem *SB = new MemoryBufferMem(Buf, Buf+Size, BufferName);
 115   // The memory for this buffer is owned by the MemoryBuffer.
 116   SB->MustDeleteBuffer = true;
 117   return SB;
 118 }
 119
 120 /// getNewMemBuffer - Allocate a new MemoryBuffer of the specified size that
 121 /// is completely initialized to zeros.  Note that the caller should
 122 /// initialize the memory allocated by this method.  The memory is owned by
 123 /// the MemoryBuffer object.
 124 MemoryBuffer *MemoryBuffer::getNewMemBuffer(size_t Size,
 125                                             const char *BufferName) {
 126   MemoryBuffer *SB = getNewUninitMemBuffer(Size, BufferName);
 127   if (!SB) return 0;
 128   memset(const_cast<char*>(SB->getBufferStart()), 0, Size+1);
 129   return SB;
 130 }
 131
 132
 133 /// getFileOrSTDIN - Open the specified file as a MemoryBuffer, or open stdin
 134 /// if the Filename is "-".  If an error occurs, this returns null and fills
 135 /// in *ErrStr with a reason.  If stdin is empty, this API (unlike getSTDIN)
 136 /// returns an empty buffer.
 137 MemoryBuffer *MemoryBuffer::getFileOrSTDIN(StringRef Filename,
 138                                            std::string *ErrStr,
 139                                            int64_t FileSize,
 140                                            struct stat *FileInfo) {
 141   if (Filename == "-")
 142     return getSTDIN();
 143   return getFile(Filename, ErrStr, FileSize, FileInfo);
 144 }
 145
 146 //===----------------------------------------------------------------------===//
 147 // MemoryBuffer::getFile implementation.
 148 //===----------------------------------------------------------------------===//
 149
 150 namespace {
 151 /// MemoryBufferMMapFile - This represents a file that was mapped in with the
 152 /// sys::Path::MapInFilePages method.  When destroyed, it calls the
 153 /// sys::Path::UnMapFilePages method.
 154 class MemoryBufferMMapFile : public MemoryBuffer {
 155   std::string Filename;
 156 public:
 157   MemoryBufferMMapFile(StringRef filename, const char *Pages, uint64_t Size)
 158     : Filename(filename) {
 159     init(Pages, Pages+Size);
 160   }
 161
 162   virtual const char *getBufferIdentifier() const {
 163     return Filename.c_str();
 164   }
 165
 166   ~MemoryBufferMMapFile() {
 167     sys::Path::UnMapFilePages(getBufferStart(), getBufferSize());
 168   }
 169 };
 170 }
 171
 172 MemoryBuffer *MemoryBuffer::getFile(StringRef Filename, std::string *ErrStr,
 173                                     int64_t FileSize, struct stat *FileInfo) {
 174   int OpenFlags = 0;
 175 #ifdef O_BINARY
 176   OpenFlags |= O_BINARY;  // Open input file in binary mode on win32.
 177 #endif
 178   SmallString<256> PathBuf(Filename.begin(), Filename.end());
 179   int FD = ::open(PathBuf.c_str(), O_RDONLY|OpenFlags);
 180   if (FD == -1) {
 181     if (ErrStr) *ErrStr = strerror(errno);
 182     return 0;
 183   }
 184
 185   // If we don't know the file size, use fstat to find out.  fstat on an open
 186   // file descriptor is cheaper than stat on a random path.
 187   if (FileSize == -1 || FileInfo) {
 188     struct stat MyFileInfo;
 189     struct stat *FileInfoPtr = FileInfo? FileInfo : &MyFileInfo;
 190
 191     // TODO: This should use fstat64 when available.
 192     if (fstat(FD, FileInfoPtr) == -1) {
 193       if (ErrStr) *ErrStr = strerror(errno);
 194       ::close(FD);
 195       return 0;
 196     }
 197     FileSize = FileInfoPtr->st_size;
 198   }
 199
 200
 201   // If the file is large, try to use mmap to read it in.  We don't use mmap
 202   // for small files, because this can severely fragment our address space. Also
 203   // don't try to map files that are exactly a multiple of the system page size,
 204   // as the file would not have the required null terminator.
 205   //
 206   // FIXME: Can we just mmap an extra page in the latter case?
 207   if (FileSize >= 4096*4 &&
 208       (FileSize & (sys::Process::GetPageSize()-1)) != 0) {
 209     if (const char *Pages = sys::Path::MapInFilePages(FD, FileSize)) {
 210       // Close the file descriptor, now that the whole file is in memory.
 211       ::close(FD);
 212       return new MemoryBufferMMapFile(Filename, Pages, FileSize);
 213     }
 214   }
 215
 216   MemoryBuffer *Buf = MemoryBuffer::getNewUninitMemBuffer(FileSize, Filename);
 217   if (!Buf) {
 218     // Failed to create a buffer.
 219     if (ErrStr) *ErrStr = "could not allocate buffer";
 220     ::close(FD);
 221     return 0;
 222   }
 223
 224   OwningPtr<MemoryBuffer> SB(Buf);
 225   char *BufPtr = const_cast<char*>(SB->getBufferStart());
 226
 227   size_t BytesLeft = FileSize;
 228   while (BytesLeft) {
 229     ssize_t NumRead = ::read(FD, BufPtr, BytesLeft);
 230     if (NumRead > 0) {
 231       BytesLeft -= NumRead;
 232       BufPtr += NumRead;
 233     } else if (NumRead == -1 && errno == EINTR) {
 234       // try again
 235     } else {
 236       // error reading.
 237       if (ErrStr) *ErrStr = strerror(errno);
 238       close(FD);
 239       return 0;
 240     }
 241   }
 242   close(FD);
 243
 244   return SB.take();
 245 }
 246
 247 //===----------------------------------------------------------------------===//
 248 // MemoryBuffer::getSTDIN implementation.
 249 //===----------------------------------------------------------------------===//
 250
 251 namespace {
 252 class STDINBufferFile : public MemoryBuffer {
 253 public:
 254   virtual const char *getBufferIdentifier() const {
 255     return "<stdin>";
 256   }
 257 };
 258 }
 259
 260 MemoryBuffer *MemoryBuffer::getSTDIN() {
 261   char Buffer[4096*4];
 262
 263   std::vector<char> FileData;
 264
 265   // Read in all of the data from stdin, we cannot mmap stdin.
 266   //
 267   // FIXME: That isn't necessarily true, we should try to mmap stdin and
 268   // fallback if it fails.
 269   sys::Program::ChangeStdinToBinary();
 270   size_t ReadBytes;
 271   do {
 272     ReadBytes = fread(Buffer, sizeof(char), sizeof(Buffer), stdin);
 273     FileData.insert(FileData.end(), Buffer, Buffer+ReadBytes);
 274   } while (ReadBytes == sizeof(Buffer));
 275
 276   FileData.push_back(0); // &FileData[Size] is invalid. So is &*FileData.end().
 277   size_t Size = FileData.size();
 278   MemoryBuffer *B = new STDINBufferFile();
 279   B->initCopyOf(&FileData[0], &FileData[Size-1]);
 280   return B;
 281 }