#include <MemoryBuffer.h>

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
MemoryBufferRef	getMemBufferRef () const
Static Public Member Functions
static ErrorOr < std::unique_ptr < MemoryBuffer > >	getFile (Twine Filename, int64_t FileSize=-1, bool RequiresNullTerminator=true, bool IsVolatileSize=false)
static ErrorOr < std::unique_ptr < MemoryBuffer > >	getOpenFileSlice (int FD, const char *Filename, uint64_t MapSize, int64_t Offset, bool IsVolatileSize=false)
static ErrorOr < std::unique_ptr < MemoryBuffer > >	getOpenFile (int FD, const char *Filename, uint64_t FileSize, bool RequiresNullTerminator=true, bool IsVolatileSize=false)
static std::unique_ptr < MemoryBuffer >	getMemBuffer (StringRef InputData, StringRef BufferName="", bool RequiresNullTerminator=true)
static std::unique_ptr < MemoryBuffer >	getMemBuffer (MemoryBufferRef Ref, bool RequiresNullTerminator=true)
static std::unique_ptr < MemoryBuffer >	getMemBufferCopy (StringRef InputData, StringRef BufferName="")
static std::unique_ptr < MemoryBuffer >	getNewMemBuffer (size_t Size, StringRef BufferName="")
static std::unique_ptr < MemoryBuffer >	getNewUninitMemBuffer (size_t Size, StringRef BufferName="")
static ErrorOr < std::unique_ptr < MemoryBuffer > >	getSTDIN ()
	Read all of stdin into a file buffer, and return it.
static ErrorOr < std::unique_ptr < MemoryBuffer > >	getFileOrSTDIN (StringRef Filename, int64_t FileSize=-1)
Protected Member Functions
	MemoryBuffer ()
void	init (const char BufStart, const char BufEnd, bool RequiresNullTerminator)

Detailed Description

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

enum llvm::MemoryBuffer::BufferKind

The kind of memory backing used to support the MemoryBuffer.

Enumerator:

MemoryBuffer_Malloc
MemoryBuffer_MMap

Definition at line 138 of file MemoryBuffer.h.

Constructor & Destructor Documentation

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

Definition at line 46 of file MemoryBuffer.h.

MemoryBuffer::~MemoryBuffer ( ) [virtual]

Definition at line 42 of file MemoryBuffer.cpp.

Member Function Documentation

StringRef llvm::MemoryBuffer::getBuffer ( ) const [inline]

Definition at line 56 of file MemoryBuffer.h.

References getBufferSize().

Referenced by getMemBufferRef(), llvm::GCOVBuffer::readArcTag(), llvm::GCOVBuffer::readBlockTag(), llvm::GCOVBuffer::readEdgeTag(), llvm::GCOVBuffer::readFunctionTag(), llvm::GCOVBuffer::readGCDAFormat(), llvm::GCOVBuffer::readGCNOFormat(), llvm::GCOVBuffer::readGCOVVersion(), llvm::GCOVBuffer::readInt(), llvm::GCOVBuffer::readLineTag(), llvm::GCOVBuffer::readObjectTag(), llvm::GCOVBuffer::readProgramTag(), llvm::GCOVBuffer::readString(), and llvm::TGLexer::TGLexer().

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

Definition at line 53 of file MemoryBuffer.h.

Referenced by llvm::RuntimeDyldCheckerImpl::checkAllRulesInBuffer(), llvm::DiffFilesWithTolerance(), ExpandResponseFile(), llvm::SourceMgr::GetMessage(), and llvm::line_iterator::line_iterator().

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

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

Definition at line 62 of file MemoryBuffer.h.

Referenced by getMemBufferRef(), and llvm::SourceMgr::GetMessage().

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]

Definition at line 54 of file MemoryBuffer.h.

Referenced by llvm::DiffFilesWithTolerance(), ExpandResponseFile(), getBuffer(), llvm::RawInstrProfReader< IntPtrT >::hasFormat(), llvm::IndexedInstrProfReader::hasFormat(), and llvm::line_iterator::line_iterator().

const char* llvm::MemoryBuffer::getBufferStart ( ) const [inline]

Definition at line 52 of file MemoryBuffer.h.

Referenced by llvm::RuntimeDyldCheckerImpl::checkAllRulesInBuffer(), llvm::DiffFilesWithTolerance(), ExpandResponseFile(), llvm::SourceMgr::getLineAndColumn(), llvm::SourceMgr::GetMessage(), llvm::RawInstrProfReader< IntPtrT >::hasFormat(), llvm::IndexedInstrProfReader::hasFormat(), and llvm::line_iterator::line_iterator().

ErrorOr< std::unique_ptr< MemoryBuffer > > MemoryBuffer::getFile	(	Twine	Filename,
		int64_t	FileSize = `-1`,
		bool	RequiresNullTerminator = `true`,
		bool	IsVolatileSize = `false`
	)		`[static]`

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.

Parameters:

IsVolatileSize Set to true to indicate that the file size may be changing, e.g. when libclang tries to parse while the user is editing/updating the file.

Definition at line 232 of file MemoryBuffer.cpp.

References llvm::StringRef::data(), getFileAux(), and llvm::Twine::toNullTerminatedStringRef().

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

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

Open the specified file as a MemoryBuffer, or open stdin if the Filename is "-".

Definition at line 156 of file MemoryBuffer.cpp.

References getFile(), and getSTDIN().

Referenced by llvm::object::createBinary(), llvm::getLazyIRFileModule(), llvm::parseAssemblyFile(), llvm::parseIRFile(), setupMemoryBuffer(), and llvm::TableGenMain().

std::unique_ptr< MemoryBuffer > MemoryBuffer::getMemBuffer	(	StringRef	InputData,
		StringRef	BufferName = `""`,
		bool	RequiresNullTerminator = `true`
	)		`[static]`

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

Definition at line 98 of file MemoryBuffer.cpp.

References llvm::MipsISD::Ret.

Referenced by llvm::object::IRObjectFile::createIRObjectFile(), llvm::getBitcodeTargetTriple(), getMemBuffer(), llvm::object::IRObjectFile::IRObjectFile(), LLVMCreateMemoryBufferWithMemoryRange(), llvm::LTOModule::makeBuffer(), llvm::parseAssemblyInto(), and llvm::parseBitcodeFile().

std::unique_ptr< MemoryBuffer > MemoryBuffer::getMemBuffer	(	MemoryBufferRef	Ref,
		bool	RequiresNullTerminator = `true`
	)		`[static]`

Definition at line 106 of file MemoryBuffer.cpp.

References llvm::MemoryBufferRef::getBuffer(), llvm::MemoryBufferRef::getBufferIdentifier(), and getMemBuffer().

std::unique_ptr< MemoryBuffer > MemoryBuffer::getMemBufferCopy	(	StringRef	InputData,
		StringRef	BufferName = `""`
	)		`[static]`

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

Definition at line 112 of file MemoryBuffer.cpp.

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

Referenced by getMemoryBufferForStream(), and LLVMCreateMemoryBufferWithMemoryRangeCopy().

MemoryBufferRef MemoryBuffer::getMemBufferRef ( ) const

Definition at line 419 of file MemoryBuffer.cpp.

References getBuffer(), and getBufferIdentifier().

Referenced by llvm::LTOModule::isBitcodeForTarget().

std::unique_ptr< MemoryBuffer > MemoryBuffer::getNewMemBuffer	(	size_t	Size,
		StringRef	BufferName = `""`
	)		`[static]`

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

Definition at line 147 of file MemoryBuffer.cpp.

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

std::unique_ptr< MemoryBuffer > MemoryBuffer::getNewUninitMemBuffer	(	size_t	Size,
		StringRef	BufferName = `""`
	)		`[static]`

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 123 of file MemoryBuffer.cpp.

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

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

ErrorOr< std::unique_ptr< MemoryBuffer > > MemoryBuffer::getOpenFile	(	int	FD,
		const char *	Filename,
		uint64_t	FileSize,
		bool	RequiresNullTerminator = `true`,
		bool	IsVolatileSize = `false`
	)		`[static]`

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

Parameters:

IsVolatileSize Set to true to indicate that the file size may be changing, e.g. when libclang tries to parse while the user is editing/updating the file.

Definition at line 396 of file MemoryBuffer.cpp.

References getOpenFileImpl().

ErrorOr< std::unique_ptr< MemoryBuffer > > MemoryBuffer::getOpenFileSlice	(	int	FD,
		const char *	Filename,
		uint64_t	MapSize,
		int64_t	Offset,
		bool	IsVolatileSize = `false`
	)		`[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.

Parameters:

IsVolatileSize Set to true to indicate that the file size may be changing, e.g. when libclang tries to parse while the user is editing/updating the file.

Definition at line 403 of file MemoryBuffer.cpp.

References getOpenFileImpl().

Referenced by llvm::LTOModule::createFromOpenFileSlice().

ErrorOr< std::unique_ptr< MemoryBuffer > > MemoryBuffer::getSTDIN ( ) [static]

Read all of stdin into a file buffer, and return it.

Definition at line 409 of file MemoryBuffer.cpp.

References llvm::sys::ChangeStdinToBinary(), and getMemoryBufferForStream().

Referenced by getFileOrSTDIN(), and LLVMCreateMemoryBufferWithSTDIN().