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 (StringRef Filename, OwningPtr< MemoryBuffer > &result, int64_t FileSize=-1, bool RequiresNullTerminator=true)
static error_code	getFile (const char *Filename, OwningPtr< MemoryBuffer > &result, int64_t FileSize=-1, bool RequiresNullTerminator=true)
static error_code	getOpenFile (int FD, const char *Filename, OwningPtr< MemoryBuffer > &result, uint64_t FileSize=-1, uint64_t MapSize=-1, int64_t Offset=0, bool RequiresNullTerminator=true)
static MemoryBuffer *	getMemBuffer (StringRef InputData, StringRef BufferName="", bool RequiresNullTerminator=true)
static MemoryBuffer *	getMemBufferCopy (StringRef InputData, StringRef BufferName="")
static MemoryBuffer *	getNewMemBuffer (size_t Size, StringRef BufferName="")
static MemoryBuffer *	getNewUninitMemBuffer (size_t Size, StringRef BufferName="")
static error_code	getSTDIN (OwningPtr< MemoryBuffer > &result)
static error_code	getFileOrSTDIN (StringRef Filename, OwningPtr< MemoryBuffer > &result, int64_t FileSize=-1)
static error_code	getFileOrSTDIN (const char *Filename, OwningPtr< 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 38 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 132 of file MemoryBuffer.h.

---

Constructor & Destructor Documentation

llvm::MemoryBuffer::MemoryBuffer

(

)

[inline, protected]

Definition at line 45 of file MemoryBuffer.h.

MemoryBuffer::~MemoryBuffer

(

)

[virtual]

Definition at line 52 of file MemoryBuffer.cpp.

---

Member Function Documentation

StringRef llvm::MemoryBuffer::getBuffer

(

)

const [inline]

Definition at line 55 of file MemoryBuffer.h.

References getBufferSize().

Referenced by llvm::FileInfo::addLineCount(), llvm::BlackList::BlackList(), llvm::object::ObjectFile::createMachOObjectFile(), llvm::object::Binary::getData(), llvm::ObjectCache::getObjectCopy(), llvm::FileInfo::print(), llvm::GCOVBuffer::readArcTag(), llvm::GCOVBuffer::readBlockTag(), llvm::GCOVBuffer::readEdgeTag(), llvm::GCOVBuffer::readFunctionTag(), llvm::GCOVBuffer::readGCOVFormat(), llvm::GCOVBuffer::readInt(), llvm::GCOVBuffer::readLineTag(), and llvm::GCOVBuffer::readString().

const char* llvm::MemoryBuffer::getBufferEnd

(

)

const [inline]

Definition at line 52 of file MemoryBuffer.h.

Referenced by llvm::Archive::findModuleDefiningSymbol(), llvm::Archive::findModulesDefiningSymbols(), llvm::getLazyIRModule(), llvm::SourceMgr::GetMessage(), llvm::object::Archive::Child::getNext(), llvm::object::COFFObjectFile::getSectionContents(), llvm::AsmLexer::LexUntilEndOfLine(), llvm::AsmLexer::LexUntilEndOfStatement(), llvm::Archive::loadArchive(), llvm::Archive::loadSymbolTable(), llvm::ParseIR(), and llvm::yaml::Scanner::Scanner().

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 61 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]

Definition at line 53 of file MemoryBuffer.h.

Referenced by llvm::Archive::checkSignature(), llvm::object::createBinary(), llvm::object::ObjectFile::createObjectFile(), llvm::object::ELFObjectFile< ELFT >::ELFObjectFile(), getBuffer(), llvm::object::getElfArchType(), llvm::Archive::writeMember(), and llvm::Archive::writeToDisk().

const char* llvm::MemoryBuffer::getBufferStart

(

)

const [inline]

Definition at line 51 of file MemoryBuffer.h.

Referenced by llvm::object::ObjectFile::base(), llvm::object::Archive::begin_children(), llvm::object::createBinary(), llvm::object::ObjectFile::createELFObjectFile(), llvm::object::ObjectFile::createObjectFile(), llvm::object::getElfArchType(), llvm::getLazyIRModule(), llvm::SourceMgr::getLineAndColumn(), getMemBufferCopy(), llvm::SourceMgr::GetMessage(), getNewMemBuffer(), llvm::LLLexer::LLLexer(), llvm::Archive::mapToMemory(), llvm::ParseIR(), llvm::yaml::Scanner::Scanner(), llvm::AsmLexer::setBuffer(), llvm::TGLexer::TGLexer(), and llvm::Archive::writeMember().

error_code MemoryBuffer::getFile	(	StringRef	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 251 of file MemoryBuffer.cpp.

References llvm::StringRef::begin(), and llvm::StringRef::end().

Referenced by llvm::SourceMgr::AddIncludeFile(), llvm::BlackList::BlackList(), llvm::object::ObjectFile::createObjectFile(), llvm::DiffFilesWithTolerance(), ExpandResponseFiles(), getFileOrSTDIN(), LLVMCreateMemoryBufferWithContentsOfFile(), llvm::Archive::mapToMemory(), llvm::Archive::writeMember(), and llvm::Archive::writeToDisk().

error_code MemoryBuffer::getFile	(	const char *	Filename,
		OwningPtr< MemoryBuffer > &	result,
		int64_t	FileSize = -1,
		bool	RequiresNullTerminator = true
	)		[static]

Definition at line 261 of file MemoryBuffer.cpp.

References getOpenFile(), llvm::errc::is_a_directory, llvm::sys::fs::is_directory(), llvm::make_error_code(), llvm::LibFunc::open, and llvm::posix_category().

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.

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

References getFile(), and getSTDIN().

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

error_code MemoryBuffer::getFileOrSTDIN	(	const char *	Filename,
		OwningPtr< MemoryBuffer > &	result,
		int64_t	FileSize = -1
	)		[static]

Definition at line 177 of file MemoryBuffer.cpp.

References getFile(), getSTDIN(), and llvm::LibFunc::strcmp.

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

Referenced by llvm::ObjectBufferStream::flush(), llvm::object::Archive::Child::getMemoryBuffer(), 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 119 of file MemoryBuffer.cpp.

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

Referenced by llvm::Archive::findModuleDefiningSymbol(), llvm::Archive::getAllModules(), llvm::GetBitcodeSymbols(), getMemoryBufferForStream(), llvm::ObjectCache::getObjectCopy(), llvm::Archive::isBitcodeArchive(), 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 157 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 132 of file MemoryBuffer.cpp.

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

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

error_code MemoryBuffer::getOpenFile	(	int	FD,
		const char *	Filename,
		OwningPtr< MemoryBuffer > &	result,
		uint64_t	FileSize = -1,
		uint64_t	MapSize = -1,
		int64_t	Offset = 0,
		bool	RequiresNullTerminator = true
	)		[static]

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

Definition at line 333 of file MemoryBuffer.cpp.

References llvm::LibFunc::fstat, llvm::sys::process::get_self(), getMemoryBufferForStream(), getNewUninitMemBuffer(), llvm::make_error_code(), llvm::errc::not_enough_memory, llvm::sys::self_process::page_size(), llvm::posix_category(), llvm::LibFunc::pread, llvm::LibFunc::read, llvm::OwningPtr< T >::reset(), shouldUseMmap(), llvm::LibFunc::stat, llvm::error_code::success(), and llvm::OwningPtr< T >::swap().

Referenced by getFile().

error_code MemoryBuffer::getSTDIN

(

OwningPtr< MemoryBuffer > &

result

)

[static]

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

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

Referenced by getFileOrSTDIN(), and LLVMCreateMemoryBufferWithSTDIN().

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

---

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

• MemoryBuffer.h
• MemoryBuffer.cpp