include/llvm/Support/MemoryBuffer.h

   1 //===--- MemoryBuffer.h - Memory Buffer Interface ---------------*- C++ -*-===//
   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 defines the MemoryBuffer interface.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_SUPPORT_MEMORYBUFFER_H
  15 #define LLVM_SUPPORT_MEMORYBUFFER_H
  16
  17 #include "llvm/ADT/StringRef.h"
  18 #include "llvm/Support/CBindingWrapping.h"
  19 #include "llvm/Support/Compiler.h"
  20 #include "llvm/Support/DataTypes.h"
  21 #include "llvm-c/Core.h"
  22
  23 namespace llvm {
  24
  25 class error_code;
  26 template<class T> class OwningPtr;
  27
  28 /// MemoryBuffer - This interface provides simple read-only access to a block
  29 /// of memory, and provides simple methods for reading files and standard input
  30 /// into a memory buffer.  In addition to basic access to the characters in the
  31 /// file, this interface guarantees you can read one character past the end of
  32 /// the file, and that this character will read as '\0'.
  33 ///
  34 /// The '\0' guarantee is needed to support an optimization -- it's intended to
  35 /// be more efficient for clients which are reading all the data to stop
  36 /// reading when they encounter a '\0' than to continually check the file
  37 /// position to see if it has reached the end of the file.
  38 class MemoryBuffer {
  39   const char *BufferStart; // Start of the buffer.
  40   const char *BufferEnd;   // End of the buffer.
  41
  42   MemoryBuffer(const MemoryBuffer &) LLVM_DELETED_FUNCTION;
  43   MemoryBuffer &operator=(const MemoryBuffer &) LLVM_DELETED_FUNCTION;
  44 protected:
  45   MemoryBuffer() {}
  46   void init(const char *BufStart, const char *BufEnd,
  47             bool RequiresNullTerminator);
  48 public:
  49   virtual ~MemoryBuffer();
  50
  51   const char *getBufferStart() const { return BufferStart; }
  52   const char *getBufferEnd() const   { return BufferEnd; }
  53   size_t getBufferSize() const { return BufferEnd-BufferStart; }
  54
  55   StringRef getBuffer() const {
  56     return StringRef(BufferStart, getBufferSize());
  57   }
  58
  59   /// getBufferIdentifier - Return an identifier for this buffer, typically the
  60   /// filename it was read from.
  61   virtual const char *getBufferIdentifier() const {
  62     return "Unknown buffer";
  63   }
  64
  65   /// getFile - Open the specified file as a MemoryBuffer, returning a new
  66   /// MemoryBuffer if successful, otherwise returning null.  If FileSize is
  67   /// specified, this means that the client knows that the file exists and that
  68   /// it has the specified size.
  69   static error_code getFile(StringRef Filename, OwningPtr<MemoryBuffer> &result,
  70                             int64_t FileSize = -1,
  71                             bool RequiresNullTerminator = true);
  72   static error_code getFile(const char *Filename,
  73                             OwningPtr<MemoryBuffer> &result,
  74                             int64_t FileSize = -1,
  75                             bool RequiresNullTerminator = true);
  76
  77   // Get a MemoryBuffer of part of a file. Since this is in the middle of a
  78   // file, the buffer is not null terminated.
  79   static error_code getOpenFileSlice(int FD, const char *Filename,
  80                                      OwningPtr<MemoryBuffer> &Result,
  81                                      uint64_t MapSize, int64_t Offset);
  82
  83   /// Given an already-open file descriptor, read the file and return a
  84   /// MemoryBuffer.
  85   static error_code getOpenFile(int FD, const char *Filename,
  86                                 OwningPtr<MemoryBuffer> &Result,
  87                                 uint64_t FileSize,
  88                                 bool RequiresNullTerminator = true);
  89
  90   /// getMemBuffer - Open the specified memory range as a MemoryBuffer.  Note
  91   /// that InputData must be null terminated if RequiresNullTerminator is true.
  92   static MemoryBuffer *getMemBuffer(StringRef InputData,
  93                                     StringRef BufferName = "",
  94                                     bool RequiresNullTerminator = true);
  95
  96   /// getMemBufferCopy - Open the specified memory range as a MemoryBuffer,
  97   /// copying the contents and taking ownership of it.  InputData does not
  98   /// have to be null terminated.
  99   static MemoryBuffer *getMemBufferCopy(StringRef InputData,
 100                                         StringRef BufferName = "");
 101
 102   /// getNewMemBuffer - Allocate a new MemoryBuffer of the specified size that
 103   /// is completely initialized to zeros.  Note that the caller should
 104   /// initialize the memory allocated by this method.  The memory is owned by
 105   /// the MemoryBuffer object.
 106   static MemoryBuffer *getNewMemBuffer(size_t Size, StringRef BufferName = "");
 107
 108   /// getNewUninitMemBuffer - Allocate a new MemoryBuffer of the specified size
 109   /// that is not initialized.  Note that the caller should initialize the
 110   /// memory allocated by this method.  The memory is owned by the MemoryBuffer
 111   /// object.
 112   static MemoryBuffer *getNewUninitMemBuffer(size_t Size,
 113                                              StringRef BufferName = "");
 114
 115   /// getSTDIN - Read all of stdin into a file buffer, and return it.
 116   /// If an error occurs, this returns null and sets ec.
 117   static error_code getSTDIN(OwningPtr<MemoryBuffer> &result);
 118
 119
 120   /// getFileOrSTDIN - Open the specified file as a MemoryBuffer, or open stdin
 121   /// if the Filename is "-".  If an error occurs, this returns null and sets
 122   /// ec.
 123   static error_code getFileOrSTDIN(StringRef Filename,
 124                                    OwningPtr<MemoryBuffer> &result,
 125                                    int64_t FileSize = -1);
 126
 127   //===--------------------------------------------------------------------===//
 128   // Provided for performance analysis.
 129   //===--------------------------------------------------------------------===//
 130
 131   /// The kind of memory backing used to support the MemoryBuffer.
 132   enum BufferKind {
 133     MemoryBuffer_Malloc,
 134     MemoryBuffer_MMap
 135   };
 136
 137   /// Return information on the memory mechanism used to support the
 138   /// MemoryBuffer.
 139   virtual BufferKind getBufferKind() const = 0;
 140 };
 141
 142 // Create wrappers for C Binding types (see CBindingWrapping.h).
 143 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(MemoryBuffer, LLVMMemoryBufferRef)
 144
 145 } // end namespace llvm
 146
 147 #endif