#include "llvm/DebugInfo/MSF/MappedBlockStream.h"

Inheritance diagram for llvm::msf::WritableMappedBlockStream:

Public Member Functions
llvm::endianness	getEndian () const override

Error	readBytes (uint64_t Offset, uint64_t Size, ArrayRef< uint8_t > &Buffer) override
	Given an offset into the stream and a number of bytes, attempt to read the bytes and set the output ArrayRef to point to data owned by the stream.

Error	readLongestContiguousChunk (uint64_t Offset, ArrayRef< uint8_t > &Buffer) override
	Given an offset into the stream, read as much as possible without copying any data.

uint64_t	getLength () override
	Return the number of bytes of data in this stream.

Error	writeBytes (uint64_t Offset, ArrayRef< uint8_t > Buffer) override
	Attempt to write the given bytes into the stream at the desired offset.

Error	commit () override
	For buffered streams, commits changes to the backing store.

const MSFStreamLayout &	getStreamLayout () const

uint32_t	getBlockSize () const

uint32_t	getNumBlocks () const

uint32_t	getStreamLength () const

Public Member Functions inherited from llvm::WritableBinaryStream
	~WritableBinaryStream () override=default

virtual Error	writeBytes (uint64_t Offset, ArrayRef< uint8_t > Data)=0
	Attempt to write the given bytes into the stream at the desired offset.

virtual Error	commit ()=0
	For buffered streams, commits changes to the backing store.

BinaryStreamFlags	getFlags () const override
	Return the properties of this stream.

Public Member Functions inherited from llvm::BinaryStream
virtual	~BinaryStream ()=default

virtual llvm::endianness	getEndian () const =0

virtual Error	readBytes (uint64_t Offset, uint64_t Size, ArrayRef< uint8_t > &Buffer)=0
	Given an offset into the stream and a number of bytes, attempt to read the bytes and set the output ArrayRef to point to data owned by the stream.

virtual Error	readLongestContiguousChunk (uint64_t Offset, ArrayRef< uint8_t > &Buffer)=0
	Given an offset into the stream, read as much as possible without copying any data.

virtual uint64_t	getLength ()=0
	Return the number of bytes of data in this stream.

virtual BinaryStreamFlags	getFlags () const
	Return the properties of this stream.

Static Public Member Functions
static std::unique_ptr< WritableMappedBlockStream >	createStream (uint32_t BlockSize, const MSFStreamLayout &Layout, WritableBinaryStreamRef MsfData, BumpPtrAllocator &Allocator)

static std::unique_ptr< WritableMappedBlockStream >	createIndexedStream (const MSFLayout &Layout, WritableBinaryStreamRef MsfData, uint32_t StreamIndex, BumpPtrAllocator &Allocator)

static std::unique_ptr< WritableMappedBlockStream >	createDirectoryStream (const MSFLayout &Layout, WritableBinaryStreamRef MsfData, BumpPtrAllocator &Allocator)

static std::unique_ptr< WritableMappedBlockStream >	createFpmStream (const MSFLayout &Layout, WritableBinaryStreamRef MsfData, BumpPtrAllocator &Allocator, bool AltFpm=false)

Protected Member Functions
	WritableMappedBlockStream (uint32_t BlockSize, const MSFStreamLayout &StreamLayout, WritableBinaryStreamRef MsfData, BumpPtrAllocator &Allocator)

Protected Member Functions inherited from llvm::WritableBinaryStream
Error	checkOffsetForWrite (uint64_t Offset, uint64_t DataSize)

Protected Member Functions inherited from llvm::BinaryStream
Error	checkOffsetForRead (uint64_t Offset, uint64_t DataSize)

Detailed Description

Definition at line 105 of file MappedBlockStream.h.

Constructor & Destructor Documentation

◆ WritableMappedBlockStream()

WritableMappedBlockStream::WritableMappedBlockStream	(	uint32_t	BlockSize,
		const MSFStreamLayout &	StreamLayout,
		WritableBinaryStreamRef	MsfData,
		BumpPtrAllocator &	Allocator
	)

protected

Definition at line 308 of file MappedBlockStream.cpp.

References Allocator.

Member Function Documentation

◆ commit()

Error WritableMappedBlockStream::commit ( )

overridevirtual

For buffered streams, commits changes to the backing store.

Implements llvm::WritableBinaryStream.

Definition at line 419 of file MappedBlockStream.cpp.

References llvm::WritableBinaryStreamRef::commit().

◆ createDirectoryStream()

std::unique_ptr< WritableMappedBlockStream > WritableMappedBlockStream::createDirectoryStream	(	const MSFLayout &	Layout,
		WritableBinaryStreamRef	MsfData,
		BumpPtrAllocator &	Allocator
	)

static

Definition at line 336 of file MappedBlockStream.cpp.

References Allocator, llvm::msf::MSFStreamLayout::Blocks, llvm::msf::SuperBlock::BlockSize, createStream(), llvm::msf::MSFLayout::DirectoryBlocks, llvm::msf::MSFStreamLayout::Length, llvm::msf::SuperBlock::NumDirectoryBytes, and llvm::msf::MSFLayout::SB.

Referenced by llvm::msf::MSFBuilder::commit().

◆ createFpmStream()

std::unique_ptr< WritableMappedBlockStream > WritableMappedBlockStream::createFpmStream	(	const MSFLayout &	Layout,
		WritableBinaryStreamRef	MsfData,
		BumpPtrAllocator &	Allocator,
		bool	AltFpm = `false`
	)

static

Definition at line 346 of file MappedBlockStream.cpp.

References Allocator, llvm::msf::SuperBlock::BlockSize, llvm::BinaryStreamWriter::bytesRemaining(), llvm::cantFail(), createStream(), llvm::msf::getFpmStreamLayout(), llvm::msf::MSFLayout::SB, and llvm::BinaryStreamWriter::writeBytes().

Referenced by commitFpm().

◆ createIndexedStream()

std::unique_ptr< WritableMappedBlockStream > WritableMappedBlockStream::createIndexedStream	(	const MSFLayout &	Layout,
		WritableBinaryStreamRef	MsfData,
		uint32_t	StreamIndex,
		BumpPtrAllocator &	Allocator
	)

static

Definition at line 324 of file MappedBlockStream.cpp.

References Allocator, assert(), llvm::msf::MSFStreamLayout::Blocks, llvm::msf::SuperBlock::BlockSize, createStream(), llvm::msf::MSFStreamLayout::Length, llvm::msf::MSFLayout::SB, llvm::msf::MSFLayout::StreamMap, and llvm::msf::MSFLayout::StreamSizes.

Referenced by llvm::pdb::GSIStreamBuilder::commit(), llvm::pdb::TpiStreamBuilder::commit(), llvm::pdb::InfoStreamBuilder::commit(), llvm::pdb::DbiStreamBuilder::commit(), llvm::pdb::PDBFileBuilder::commit(), and llvm::pdb::DbiModuleDescriptorBuilder::commitSymbolStream().

◆ createStream()

std::unique_ptr< WritableMappedBlockStream > WritableMappedBlockStream::createStream	(	uint32_t	BlockSize,
		const MSFStreamLayout &	Layout,
		WritableBinaryStreamRef	MsfData,
		BumpPtrAllocator &	Allocator
	)