LLVM  14.0.0git
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
llvm::WritableMemoryBuffer Class Reference

This class is an extension of MemoryBuffer, which allows copy-on-write access to the underlying contents. More...

#include "llvm/Support/MemoryBuffer.h"

Inheritance diagram for llvm::WritableMemoryBuffer:
Inheritance graph
[legend]
Collaboration diagram for llvm::WritableMemoryBuffer:
Collaboration graph
[legend]

Public Member Functions

char * getBufferStart ()
 
char * getBufferEnd ()
 
MutableArrayRef< char > getBuffer ()
 
StringRef getBuffer () const
 
const char * getBufferEnd () const
 
const char * getBufferStart () const
 
- Public Member Functions inherited from llvm::MemoryBuffer
 MemoryBuffer (const MemoryBuffer &)=delete
 
MemoryBufferoperator= (const MemoryBuffer &)=delete
 
virtual ~MemoryBuffer ()
 
const char * getBufferStart () const
 
const char * getBufferEnd () const
 
size_t getBufferSize () const
 
StringRef getBuffer () const
 
virtual StringRef getBufferIdentifier () const
 Return an identifier for this buffer, typically the filename it was read from. More...
 
virtual BufferKind getBufferKind () const =0
 Return information on the memory mechanism used to support the MemoryBuffer. More...
 
MemoryBufferRef getMemBufferRef () const
 

Static Public Member Functions

static ErrorOr< std::unique_ptr< WritableMemoryBuffer > > getFile (const Twine &Filename, bool IsVolatile=false)
 
static ErrorOr< std::unique_ptr< WritableMemoryBuffer > > getFileSlice (const Twine &Filename, uint64_t MapSize, uint64_t Offset, bool IsVolatile=false)
 Map a subrange of the specified file as a WritableMemoryBuffer. More...
 
static std::unique_ptr< WritableMemoryBuffergetNewUninitMemBuffer (size_t Size, const Twine &BufferName="")
 Allocate a new MemoryBuffer of the specified size that is not initialized. More...
 
static std::unique_ptr< WritableMemoryBuffergetNewMemBuffer (size_t Size, const Twine &BufferName="")
 Allocate a new zero-initialized MemoryBuffer of the specified size. More...
 
- Static Public Member Functions inherited from llvm::MemoryBuffer
static ErrorOr< std::unique_ptr< MemoryBuffer > > getFile (const Twine &Filename, bool IsText=false, bool RequiresNullTerminator=true, bool IsVolatile=false)
 Open the specified file as a MemoryBuffer, returning a new MemoryBuffer if successful, otherwise returning null. More...
 
static ErrorOr< std::unique_ptr< MemoryBuffer > > getFileAsStream (const Twine &Filename)
 Read all of the specified file into a MemoryBuffer as a stream (i.e. More...
 
static ErrorOr< std::unique_ptr< MemoryBuffer > > getOpenFileSlice (sys::fs::file_t FD, const Twine &Filename, uint64_t MapSize, int64_t Offset, bool IsVolatile=false)
 Given an already-open file descriptor, map some slice of it into a MemoryBuffer. More...
 
static ErrorOr< std::unique_ptr< MemoryBuffer > > getOpenFile (sys::fs::file_t FD, const Twine &Filename, uint64_t FileSize, bool RequiresNullTerminator=true, bool IsVolatile=false)
 Given an already-open file descriptor, read the file and return a MemoryBuffer. More...
 
static std::unique_ptr< MemoryBuffergetMemBuffer (StringRef InputData, StringRef BufferName="", bool RequiresNullTerminator=true)
 Open the specified memory range as a MemoryBuffer. More...
 
static std::unique_ptr< MemoryBuffergetMemBuffer (MemoryBufferRef Ref, bool RequiresNullTerminator=true)
 
static std::unique_ptr< MemoryBuffergetMemBufferCopy (StringRef InputData, const Twine &BufferName="")
 Open the specified memory range as a MemoryBuffer, copying the contents and taking ownership of it. More...
 
static ErrorOr< std::unique_ptr< MemoryBuffer > > getSTDIN ()
 Read all of stdin into a file buffer, and return it. More...
 
static ErrorOr< std::unique_ptr< MemoryBuffer > > getFileOrSTDIN (const Twine &Filename, bool IsText=false, bool RequiresNullTerminator=true)
 Open the specified file as a MemoryBuffer, or open stdin if the Filename is "-". More...
 
static ErrorOr< std::unique_ptr< MemoryBuffer > > getFileSlice (const Twine &Filename, uint64_t MapSize, uint64_t Offset, bool IsVolatile=false)
 Map a subrange of the specified file as a MemoryBuffer. More...
 

Protected Member Functions

 WritableMemoryBuffer ()=default
 
- Protected Member Functions inherited from llvm::MemoryBuffer
 MemoryBuffer ()=default
 
void init (const char *BufStart, const char *BufEnd, bool RequiresNullTerminator)
 init - Initialize this MemoryBuffer as a reference to externally allocated memory, memory that we know is already null terminated. More...
 

Additional Inherited Members

- Public Types inherited from llvm::MemoryBuffer
enum  BufferKind { MemoryBuffer_Malloc, MemoryBuffer_MMap }
 The kind of memory backing used to support the MemoryBuffer. More...
 

Detailed Description

This class is an extension of MemoryBuffer, which allows copy-on-write access to the underlying contents.

It only supports creation methods that are guaranteed to produce a writable buffer. For example, mapping a file read-only is not supported.

Definition at line 162 of file MemoryBuffer.h.

Constructor & Destructor Documentation

◆ WritableMemoryBuffer()

llvm::WritableMemoryBuffer::WritableMemoryBuffer ( )
protecteddefault

Member Function Documentation

◆ getBuffer() [1/2]

MutableArrayRef<char> llvm::WritableMemoryBuffer::getBuffer ( )
inline

Definition at line 179 of file MemoryBuffer.h.

References getBufferEnd(), and getBufferStart().

◆ getBuffer() [2/2]

StringRef llvm::MemoryBuffer::getBuffer
inline

Definition at line 69 of file MemoryBuffer.h.

◆ getBufferEnd() [1/2]

char* llvm::WritableMemoryBuffer::getBufferEnd ( )
inline

Definition at line 176 of file MemoryBuffer.h.

References llvm::MemoryBuffer::getBufferEnd().

Referenced by getBuffer().

◆ getBufferEnd() [2/2]

const char* llvm::MemoryBuffer::getBufferEnd
inline

Definition at line 66 of file MemoryBuffer.h.

◆ getBufferStart() [1/2]

char* llvm::WritableMemoryBuffer::getBufferStart ( )
inline

Definition at line 173 of file MemoryBuffer.h.

References llvm::MemoryBuffer::getBufferStart().

Referenced by getBuffer().

◆ getBufferStart() [2/2]

const char* llvm::MemoryBuffer::getBufferStart
inline

Definition at line 65 of file MemoryBuffer.h.

◆ getFile()

ErrorOr< std::unique_ptr< WritableMemoryBuffer > > WritableMemoryBuffer::getFile ( const Twine Filename,
bool  IsVolatile = false 
)
static

◆ getFileSlice()

ErrorOr< std::unique_ptr< WritableMemoryBuffer > > WritableMemoryBuffer::getFileSlice ( const Twine Filename,
uint64_t  MapSize,
uint64_t  Offset,
bool  IsVolatile = false 
)
static

Map a subrange of the specified file as a WritableMemoryBuffer.

Definition at line 281 of file MemoryBuffer.cpp.

References llvm::AMDGPU::HSAMD::Kernel::Arg::Key::IsVolatile, and Offset.

◆ getNewMemBuffer()

std::unique_ptr< WritableMemoryBuffer > WritableMemoryBuffer::getNewMemBuffer ( size_t  Size,
const Twine 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 315 of file MemoryBuffer.cpp.

References getNewUninitMemBuffer(), and llvm::Check::Size.

Referenced by llvm::object::WindowsResourceCOFFWriter::WindowsResourceCOFFWriter().

◆ getNewUninitMemBuffer()

std::unique_ptr< WritableMemoryBuffer > WritableMemoryBuffer::getNewUninitMemBuffer ( size_t  Size,
const Twine 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 289 of file MemoryBuffer.cpp.

References llvm::alignTo(), CopyStringRef(), llvm::MipsISD::Ret, llvm::Check::Size, llvm::StringRef::size(), and llvm::Twine::toStringRef().

Referenced by getMemBufferCopyImpl(), getNewMemBuffer(), getOpenFileImpl(), and loadBinaryFormat().


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