LLVM API Documentation

Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
llvm::MemoryBuffer Class Reference

#include <MemoryBuffer.h>

List of all members.

Public Types

enum  BufferKind { MemoryBuffer_Malloc, MemoryBuffer_MMap }
 The kind of memory backing used to support the MemoryBuffer. More...

Public Member Functions

virtual ~MemoryBuffer ()
const char * getBufferStart () const
const char * getBufferEnd () const
size_t getBufferSize () const
StringRef getBuffer () const
virtual const char * getBufferIdentifier () const
virtual BufferKind getBufferKind () const =0

Static Public Member Functions

static error_code getFile (Twine Filename, OwningPtr< MemoryBuffer > &Result, int64_t FileSize=-1, bool RequiresNullTerminator=true)
static error_code getFile (Twine Filename, std::unique_ptr< MemoryBuffer > &Result, int64_t FileSize=-1, bool RequiresNullTerminator=true)
static error_code getOpenFileSlice (int FD, const char *Filename, OwningPtr< MemoryBuffer > &Result, uint64_t MapSize, int64_t Offset)
static error_code getOpenFileSlice (int FD, const char *Filename, std::unique_ptr< MemoryBuffer > &Result, uint64_t MapSize, int64_t Offset)
static error_code getOpenFile (int FD, const char *Filename, OwningPtr< MemoryBuffer > &Result, uint64_t FileSize, bool RequiresNullTerminator=true)
static error_code getOpenFile (int FD, const char *Filename, std::unique_ptr< MemoryBuffer > &Result, uint64_t FileSize, bool RequiresNullTerminator=true)
static MemoryBuffergetMemBuffer (StringRef InputData, StringRef BufferName="", bool RequiresNullTerminator=true)
static MemoryBuffergetMemBufferCopy (StringRef InputData, StringRef BufferName="")
static MemoryBuffergetNewMemBuffer (size_t Size, StringRef BufferName="")
static MemoryBuffergetNewUninitMemBuffer (size_t Size, StringRef BufferName="")
static error_code getSTDIN (OwningPtr< MemoryBuffer > &Result)
static error_code getSTDIN (std::unique_ptr< MemoryBuffer > &Result)
static error_code getFileOrSTDIN (StringRef Filename, OwningPtr< MemoryBuffer > &Result, int64_t FileSize=-1)
static error_code getFileOrSTDIN (StringRef Filename, std::unique_ptr< MemoryBuffer > &Result, int64_t FileSize=-1)

Protected Member Functions

 MemoryBuffer ()
void init (const char *BufStart, const char *BufEnd, bool RequiresNullTerminator)

Detailed Description

MemoryBuffer - This interface provides simple read-only access to a block of memory, and provides simple methods for reading files and standard input into a memory buffer. In addition to basic access to the characters in the file, this interface guarantees you can read one character past the end of the file, and that this character will read as '\0'.

The '\0' guarantee is needed to support an optimization -- it's intended to be more efficient for clients which are reading all the data to stop reading when they encounter a '\0' than to continually check the file position to see if it has reached the end of the file.

Definition at line 39 of file MemoryBuffer.h.


Member Enumeration Documentation

The kind of memory backing used to support the MemoryBuffer.

Enumerator:
MemoryBuffer_Malloc 
MemoryBuffer_MMap 

Definition at line 145 of file MemoryBuffer.h.


Constructor & Destructor Documentation

llvm::MemoryBuffer::MemoryBuffer ( ) [inline, protected]

Definition at line 46 of file MemoryBuffer.h.

Definition at line 50 of file MemoryBuffer.cpp.


Member Function Documentation

const char* llvm::MemoryBuffer::getBufferEnd ( ) const [inline]
virtual const char* llvm::MemoryBuffer::getBufferIdentifier ( ) const [inline, virtual]

getBufferIdentifier - Return an identifier for this buffer, typically the filename it was read from.

Definition at line 62 of file MemoryBuffer.h.

Referenced by llvm::LLLexer::getFilename(), llvm::object::Binary::getFileName(), llvm::getLazyBitcodeModule(), llvm::getLazyIRModule(), llvm::SourceMgr::GetMessage(), llvm::MCContext::MCContext(), llvm::ParseAssembly(), and llvm::ParseIR().

virtual BufferKind llvm::MemoryBuffer::getBufferKind ( ) const [pure virtual]

Return information on the memory mechanism used to support the MemoryBuffer.

size_t llvm::MemoryBuffer::getBufferSize ( ) const [inline]
const char* llvm::MemoryBuffer::getBufferStart ( ) const [inline]
error_code MemoryBuffer::getFile ( Twine  Filename,
OwningPtr< MemoryBuffer > &  Result,
int64_t  FileSize = -1,
bool  RequiresNullTerminator = true 
) [static]

getFile - Open the specified file as a MemoryBuffer, returning a new MemoryBuffer if successful, otherwise returning null. If FileSize is specified, this means that the client knows that the file exists and that it has the specified size.

Definition at line 268 of file MemoryBuffer.cpp.

Referenced by llvm::SourceMgr::AddIncludeFile(), llvm::SpecialCaseList::create(), llvm::object::ObjectFile::createObjectFile(), llvm::DiffFilesWithTolerance(), ExpandResponseFile(), getFileOrSTDIN(), and LLVMCreateMemoryBufferWithContentsOfFile().

error_code MemoryBuffer::getFile ( Twine  Filename,
std::unique_ptr< MemoryBuffer > &  Result,
int64_t  FileSize = -1,
bool  RequiresNullTerminator = true 
) [static]
error_code MemoryBuffer::getFileOrSTDIN ( StringRef  Filename,
OwningPtr< MemoryBuffer > &  Result,
int64_t  FileSize = -1 
) [static]

getFileOrSTDIN - Open the specified file as a MemoryBuffer, or open stdin if the Filename is "-". If an error occurs, this returns null and sets ec.

Definition at line 176 of file MemoryBuffer.cpp.

Referenced by llvm::InstrProfReader::create(), llvm::object::createBinary(), llvm::getLazyIRFileModule(), llvm::ParseAssemblyFile(), llvm::ParseIRFile(), llvm::FileInfo::print(), and llvm::TableGenMain().

error_code MemoryBuffer::getFileOrSTDIN ( StringRef  Filename,
std::unique_ptr< MemoryBuffer > &  Result,
int64_t  FileSize = -1 
) [static]

getFileOrSTDIN - Open the specified file as a MemoryBuffer, or open stdin if the Filename is "-". If an error occurs, this returns null and fills in *ErrStr with a reason. If stdin is empty, this API (unlike getSTDIN) returns an empty buffer.

Definition at line 168 of file MemoryBuffer.cpp.

References getFile(), and getSTDIN().

MemoryBuffer * MemoryBuffer::getMemBuffer ( StringRef  InputData,
StringRef  BufferName = "",
bool  RequiresNullTerminator = true 
) [static]

getMemBuffer - Open the specified memory range as a MemoryBuffer. Note that InputData must be null terminated if RequiresNullTerminator is true.

getMemBuffer - Open the specified memory range as a MemoryBuffer. Note that InputData must be a null terminated if RequiresNullTerminator is true!

Definition at line 107 of file MemoryBuffer.cpp.

Referenced by llvm::RuntimeDyldELF::createObjectImageFromFile(), llvm::ObjectBufferStream::flush(), llvm::object::MachOUniversalBinary::ObjectForArch::getAsObjectFile(), LLVMCreateMemoryBufferWithMemoryRange(), llvm::ParseAssemblyString(), and llvm::yaml::Scanner::Scanner().

MemoryBuffer * MemoryBuffer::getMemBufferCopy ( StringRef  InputData,
StringRef  BufferName = "" 
) [static]

getMemBufferCopy - Open the specified memory range as a MemoryBuffer, copying the contents and taking ownership of it. InputData does not have to be null terminated.

getMemBufferCopy - Open the specified memory range as a MemoryBuffer, copying the contents and taking ownership of it. This has no requirements on EndPtr[0].

Definition at line 117 of file MemoryBuffer.cpp.

References llvm::StringRef::data(), getBufferStart(), getNewUninitMemBuffer(), llvm::LibFunc::memcpy, and llvm::StringRef::size().

Referenced by getMemoryBufferForStream(), and LLVMCreateMemoryBufferWithMemoryRangeCopy().

MemoryBuffer * MemoryBuffer::getNewMemBuffer ( size_t  Size,
StringRef  BufferName = "" 
) [static]

getNewMemBuffer - Allocate a new MemoryBuffer of the specified size that is completely initialized to zeros. Note that the caller should initialize the memory allocated by this method. The memory is owned by the MemoryBuffer object.

Definition at line 156 of file MemoryBuffer.cpp.

References getBufferStart(), getNewUninitMemBuffer(), and llvm::LibFunc::memset.

MemoryBuffer * MemoryBuffer::getNewUninitMemBuffer ( size_t  Size,
StringRef  BufferName = "" 
) [static]

getNewUninitMemBuffer - Allocate a new MemoryBuffer of the specified size that is not initialized. Note that the caller should initialize the memory allocated by this method. The memory is owned by the MemoryBuffer object.

Definition at line 130 of file MemoryBuffer.cpp.

References CopyStringRef(), operator new(), llvm::RoundUpToAlignment(), and llvm::StringRef::size().

Referenced by getMemBufferCopy(), getNewMemBuffer(), and getOpenFileImpl().

error_code MemoryBuffer::getOpenFile ( int  FD,
const char *  Filename,
OwningPtr< MemoryBuffer > &  Result,
uint64_t  FileSize,
bool  RequiresNullTerminator = true 
) [static]

Given an already-open file descriptor, read the file and return a MemoryBuffer.

Definition at line 436 of file MemoryBuffer.cpp.

References getOpenFileImpl().

error_code MemoryBuffer::getOpenFile ( int  FD,
const char *  Filename,
std::unique_ptr< MemoryBuffer > &  Result,
uint64_t  FileSize,
bool  RequiresNullTerminator = true 
) [static]

Definition at line 428 of file MemoryBuffer.cpp.

References getOpenFileImpl().

error_code MemoryBuffer::getOpenFileSlice ( int  FD,
const char *  Filename,
OwningPtr< MemoryBuffer > &  Result,
uint64_t  MapSize,
int64_t  Offset 
) [static]

Given an already-open file descriptor, map some slice of it into a MemoryBuffer. The slice is specified by an Offset and MapSize. Since this is in the middle of a file, the buffer is not null terminated.

Definition at line 453 of file MemoryBuffer.cpp.

References getOpenFileImpl().

error_code MemoryBuffer::getOpenFileSlice ( int  FD,
const char *  Filename,
std::unique_ptr< MemoryBuffer > &  Result,
uint64_t  MapSize,
int64_t  Offset 
) [static]

Definition at line 447 of file MemoryBuffer.cpp.

References getOpenFileImpl().

getSTDIN - Read all of stdin into a file buffer, and return it. If an error occurs, this returns null and sets ec.

Definition at line 476 of file MemoryBuffer.cpp.

Referenced by getFileOrSTDIN(), and LLVMCreateMemoryBufferWithSTDIN().

error_code MemoryBuffer::getSTDIN ( std::unique_ptr< MemoryBuffer > &  Result) [static]
void MemoryBuffer::init ( const char *  BufStart,
const char *  BufEnd,
bool  RequiresNullTerminator 
) [protected]

init - Initialize this MemoryBuffer as a reference to externally allocated memory, memory that we know is already null terminated.

Definition at line 54 of file MemoryBuffer.cpp.


The documentation for this class was generated from the following files: