Provides write only access to a subclass of WritableBinaryStream. More...

#include "llvm/Support/BinaryStreamWriter.h"

Public Member Functions
	BinaryStreamWriter ()=default

	BinaryStreamWriter (WritableBinaryStreamRef Ref)

	BinaryStreamWriter (WritableBinaryStream &Stream)

	BinaryStreamWriter (MutableArrayRef< uint8_t > Data, llvm::endianness Endian)

	BinaryStreamWriter (const BinaryStreamWriter &Other)=default

BinaryStreamWriter &	operator= (const BinaryStreamWriter &Other)=default

virtual	~BinaryStreamWriter ()=default

Error	writeBytes (ArrayRef< uint8_t > Buffer)
	Write the bytes specified in `Buffer` to the underlying stream.

template<typename T >
Error	writeInteger (T Value)
	Write the integer `Value` to the underlying stream in the specified endianness.

template<typename T >
Error	writeEnum (T Num)
	Similar to writeInteger.

Error	writeULEB128 (uint64_t Value)
	Write the unsigned integer Value to the underlying stream using ULEB128 encoding.

Error	writeSLEB128 (int64_t Value)
	Write the unsigned integer Value to the underlying stream using ULEB128 encoding.

Error	writeCString (StringRef Str)
	Write the string `Str` to the underlying stream followed by a null terminator.

Error	writeFixedString (StringRef Str)
	Write the string `Str` to the underlying stream without a null terminator.

Error	writeStreamRef (BinaryStreamRef Ref)
	Efficiently reads all data from `Ref`, and writes it to this stream.

Error	writeStreamRef (BinaryStreamRef Ref, uint64_t Size)
	Efficiently reads `Size` bytes from `Ref`, and writes it to this stream.

template<typename T >
Error	writeObject (const T &Obj)
	Writes the object `Obj` to the underlying stream, as if by using memcpy.

template<typename T >
Error	writeArray (ArrayRef< T > Array)
	Writes an array of objects of type T to the underlying stream, as if by using memcpy.

template<typename T , typename U >
Error	writeArray (VarStreamArray< T, U > Array)
	Writes all data from the array `Array` to the underlying stream.

template<typename T >
Error	writeArray (FixedStreamArray< T > Array)
	Writes all elements from the array `Array` to the underlying stream.

std::pair< BinaryStreamWriter, BinaryStreamWriter >	split (uint64_t Off) const
	Splits the Writer into two Writers at a given offset.

void	setOffset (uint64_t Off)

uint64_t	getOffset () const

uint64_t	getLength () const

uint64_t	bytesRemaining () const

Error	padToAlignment (uint32_t Align)

Protected Attributes
WritableBinaryStreamRef	Stream

uint64_t	Offset = 0

Detailed Description

Provides write only access to a subclass of WritableBinaryStream.

Provides bounds checking and helpers for writing certain common data types such as null-terminated strings, integers in various flavors of endianness, etc. Can be subclassed to provide reading and writing of custom datatypes, although no methods are overridable.

Definition at line 30 of file BinaryStreamWriter.h.

Constructor & Destructor Documentation

◆ BinaryStreamWriter() [1/5]

llvm::BinaryStreamWriter::BinaryStreamWriter ( )

default

◆ BinaryStreamWriter() [2/5]

BinaryStreamWriter::BinaryStreamWriter ( WritableBinaryStreamRef Ref )

explicit

Definition at line 18 of file BinaryStreamWriter.cpp.

◆ BinaryStreamWriter() [3/5]

BinaryStreamWriter::BinaryStreamWriter ( WritableBinaryStream & Stream )

explicit

Definition at line 21 of file BinaryStreamWriter.cpp.

◆ BinaryStreamWriter() [4/5]

BinaryStreamWriter::BinaryStreamWriter	(	MutableArrayRef< uint8_t >	Data,
		llvm::endianness	Endian
	)

explicit

Definition at line 24 of file BinaryStreamWriter.cpp.

References Endian.

◆ BinaryStreamWriter() [5/5]

llvm::BinaryStreamWriter::BinaryStreamWriter ( const BinaryStreamWriter & Other )

default

◆ ~BinaryStreamWriter()

virtual llvm::BinaryStreamWriter::~BinaryStreamWriter ( )

virtualdefault

Member Function Documentation

◆ bytesRemaining()

uint64_t llvm::BinaryStreamWriter::bytesRemaining ( ) const

inline

Definition at line 179 of file BinaryStreamWriter.h.

References getLength(), and getOffset().

Referenced by llvm::pdb::InfoStreamBuilder::commit(), llvm::pdb::DbiStreamBuilder::commit(), commitFpm(), llvm::pdb::DbiModuleDescriptorBuilder::commitSymbolStream(), llvm::msf::WritableMappedBlockStream::createFpmStream(), llvm::CodeViewYAML::toDebugH(), and llvm::CodeViewYAML::toDebugT().

◆ getLength()

uint64_t llvm::BinaryStreamWriter::getLength ( ) const

inline

Definition at line 178 of file BinaryStreamWriter.h.

References llvm::BinaryStreamRefBase< RefType, StreamType >::getLength(), and Stream.

Referenced by llvm::codeview::ContinuationRecordBuilder::begin(), bytesRemaining(), and split().

◆ getOffset()

uint64_t llvm::BinaryStreamWriter::getOffset ( ) const

inline

Definition at line 177 of file BinaryStreamWriter.h.

References Offset.

Referenced by addPadding(), llvm::codeview::ContinuationRecordBuilder::begin(), bytesRemaining(), llvm::codeview::DebugStringTableSubsection::commit(), llvm::codeview::DebugSubsectionRecordBuilder::commit(), llvm::pdb::DbiModuleDescriptorBuilder::commitSymbolStream(), llvm::codeview::ContinuationRecordBuilder::end(), llvm::codeview::SimpleTypeSerializer::serialize(), llvm::codeview::SymbolSerializer::visitSymbolEnd(), and llvm::codeview::ContinuationRecordBuilder::writeMemberType().

◆ operator=()

BinaryStreamWriter & llvm::BinaryStreamWriter::operator= ( const BinaryStreamWriter & Other )

default

◆ padToAlignment()

Error BinaryStreamWriter::padToAlignment ( uint32_t Align )

Definition at line 95 of file BinaryStreamWriter.cpp.

References llvm::alignTo(), Offset, llvm::Error::success(), and writeArray().

Referenced by llvm::pdb::DbiModuleDescriptorBuilder::commit(), llvm::codeview::DebugChecksumsSubsection::commit(), llvm::codeview::DebugSubsectionRecordBuilder::commit(), and llvm::codeview::CodeViewRecordIO::padToAlignment().

◆ setOffset()

void llvm::BinaryStreamWriter::setOffset ( uint64_t Off )

inline

Definition at line 176 of file BinaryStreamWriter.h.

References Offset.

Referenced by llvm::codeview::ContinuationRecordBuilder::begin(), llvm::codeview::DebugStringTableSubsection::commit(), llvm::msf::MSFBuilder::commit(), llvm::pdb::DbiModuleDescriptorBuilder::commitSymbolStream(), llvm::codeview::SymbolSerializer::visitSymbolBegin(), and llvm::codeview::SymbolSerializer::visitSymbolEnd().

◆ split()

std::pair< BinaryStreamWriter, BinaryStreamWriter > BinaryStreamWriter::split ( uint64_t Off ) const

Splits the Writer into two Writers at a given offset.

Definition at line 83 of file BinaryStreamWriter.cpp.

References assert(), llvm::BinaryStreamRefBase< RefType, StreamType >::drop_front(), llvm::First, getLength(), Offset, and Stream.

◆ writeArray() [1/3]

template<typename T >

Error llvm::BinaryStreamWriter::writeArray ( ArrayRef< T > Array )

inline

Writes an array of objects of type T to the underlying stream, as if by using memcpy.

It is up to the caller to ensure that type of Obj can be safely copied in this fashion, as no checks are made to ensure that this is safe.

Returns: a success error code if the data was successfully written, otherwise returns an appropriate error code.

Definition at line 144 of file BinaryStreamWriter.h.

References llvm::invalid_array_size, llvm::Error::success(), and writeBytes().

Referenced by llvm::pdb::DbiStreamBuilder::addDbgStream(), llvm::pdb::GSIHashStreamBuilder::commit(), llvm::codeview::DebugChecksumsSubsection::commit(), llvm::codeview::DebugCrossModuleImportsSubsection::commit(), llvm::codeview::DebugFrameDataSubsection::commit(), llvm::codeview::DebugInlineeLinesSubsection::commit(), llvm::codeview::DebugLinesSubsection::commit(), llvm::codeview::DebugSymbolRVASubsection::commit(), llvm::pdb::DbiStreamBuilder::commit(), llvm::msf::MSFBuilder::commit(), llvm::pdb::DbiStreamBuilder::finalizeMsfLayout(), and padToAlignment().

◆ writeArray() [2/3]

template<typename T >

Error llvm::BinaryStreamWriter::writeArray ( FixedStreamArray< T > Array )

inline

Writes all elements from the array Array to the underlying stream.

Returns: a success error code if the data was successfully written, otherwise returns an appropriate error code.

Definition at line 169 of file BinaryStreamWriter.h.

References writeStreamRef().

◆ writeArray() [3/3]

template<typename T , typename U >

Error llvm::BinaryStreamWriter::writeArray ( VarStreamArray< T, U > Array )

inline

Writes all data from the array Array to the underlying stream.

Returns: a success error code if the data was successfully written, otherwise returns an appropriate error code.

Definition at line 161 of file BinaryStreamWriter.h.

References writeStreamRef().

◆ writeBytes()

Error BinaryStreamWriter::writeBytes ( ArrayRef< uint8_t > Buffer )

Write the bytes specified in Buffer to the underlying stream.

On success, updates the offset so that subsequent writes will occur at the next unwritten position.

Returns: a success error code if the data was successfully written, otherwise returns an appropriate error code.

Definition at line 28 of file BinaryStreamWriter.cpp.

References Offset, llvm::ArrayRef< T >::size(), Stream, llvm::Error::success(), and llvm::WritableBinaryStreamRef::writeBytes().

Referenced by llvm::codeview::DebugSymbolsSubsection::commit(), llvm::pdb::TpiStreamBuilder::commit(), llvm::pdb::PDBFileBuilder::commit(), llvm::pdb::DbiModuleDescriptorBuilder::commitSymbolStream(), llvm::msf::WritableMappedBlockStream::createFpmStream(), llvm::codeview::CodeViewRecordIO::mapByteVectorTail(), llvm::codeview::CodeViewRecordIO::mapGuid(), llvm::CodeViewYAML::toDebugT(), writeArray(), writeFixedString(), writeInteger(), writeObject(), writePublics(), writeSLEB128(), writeStreamRef(), and writeULEB128().

◆ writeCString()

Error BinaryStreamWriter::writeCString ( StringRef Str )

Write the string Str to the underlying stream followed by a null terminator.

On success, updates the offset so that subsequent writes occur at the next unwritten position. Str need not be null terminated on input.

Returns: a success error code if the data was successfully written, otherwise returns an appropriate error code.

Definition at line 47 of file BinaryStreamWriter.cpp.

References llvm::Error::success(), writeFixedString(), and writeObject().

Referenced by llvm::pdb::DbiModuleDescriptorBuilder::commit(), llvm::codeview::DebugStringTableSubsection::commit(), and llvm::codeview::CodeViewRecordIO::mapStringZ().

◆ writeEnum()

template<typename T >

Error llvm::BinaryStreamWriter::writeEnum ( T Num )

inline

Similar to writeInteger.

Definition at line 67 of file BinaryStreamWriter.h.

Referenced by llvm::codeview::DebugInlineeLinesSubsection::commit(), llvm::pdb::InfoStreamBuilder::commit(), llvm::pdb::DbiStreamBuilder::commit(), and llvm::codeview::ContinuationRecordBuilder::writeMemberType().

◆ writeFixedString()

Error BinaryStreamWriter::writeFixedString ( StringRef Str )

Write the string Str to the underlying stream without a null terminator.

On success, updates the offset so that subsequent writes occur at the next unwritten position.

Returns: a success error code if the data was successfully written, otherwise returns an appropriate error code.

Definition at line 56 of file BinaryStreamWriter.cpp.

References writeBytes().

Referenced by llvm::pdb::NamedStreamMap::commit(), llvm::CodeViewYAML::toDebugH(), and writeCString().

◆ writeInteger()

template<typename T >

Error llvm::BinaryStreamWriter::writeInteger ( T Value )

inline

Write the integer Value to the underlying stream in the specified endianness.

On success, updates the offset so that subsequent writes occur at the next unwritten position.

Returns: a success error code if the data was successfully written, otherwise returns an appropriate error code.

Definition at line 58 of file BinaryStreamWriter.h.

References llvm::BinaryStreamRefBase< RefType, StreamType >::getEndian(), Stream, T, and writeBytes().

Referenced by addPadding(), llvm::pdb::HashTable< ValueT >::commit(), llvm::pdb::NamedStreamMap::commit(), llvm::codeview::DebugCrossModuleExportsSubsection::commit(), llvm::codeview::DebugFrameDataSubsection::commit(), llvm::codeview::DebugInlineeLinesSubsection::commit(), llvm::pdb::InfoStreamBuilder::commit(), llvm::pdb::DbiStreamBuilder::commit(), llvm::msf::MSFBuilder::commit(), llvm::pdb::DbiModuleDescriptorBuilder::commitSymbolStream(), llvm::jitlink::aarch64::lowerPointer64AuthEdgesToSigningFunction(), llvm::codeview::CodeViewRecordIO::mapInteger(), llvm::codeview::CodeViewRecordIO::mapVectorN(), llvm::CodeViewYAML::toDebugH(), toDebugS(), llvm::CodeViewYAML::toDebugT(), llvm::codeview::SymbolSerializer::visitSymbolEnd(), and llvm::pdb::writeSparseBitVector().

◆ writeObject()

template<typename T >

Error llvm::BinaryStreamWriter::writeObject ( const T & Obj )

inline

Writes the object Obj to the underlying stream, as if by using memcpy.

It is up to the caller to ensure that type of Obj can be safely copied in this fashion, as no checks are made to ensure that this is safe.

Returns: a success error code if the data was successfully written, otherwise returns an appropriate error code.

Definition at line 128 of file BinaryStreamWriter.h.

References writeBytes().

Referenced by llvm::codeview::ContinuationRecordBuilder::begin(), llvm::pdb::DbiModuleDescriptorBuilder::commit(), llvm::pdb::GSIHashStreamBuilder::commit(), llvm::pdb::HashTable< ValueT >::commit(), llvm::codeview::DebugChecksumsSubsection::commit(), llvm::codeview::DebugCrossModuleImportsSubsection::commit(), llvm::codeview::DebugInlineeLinesSubsection::commit(), llvm::codeview::DebugLinesSubsection::commit(), llvm::codeview::DebugSubsectionRecordBuilder::commit(), llvm::pdb::TpiStreamBuilder::commit(), llvm::pdb::InfoStreamBuilder::commit(), llvm::pdb::DbiStreamBuilder::commit(), llvm::msf::MSFBuilder::commit(), commitFpm(), llvm::codeview::CodeViewRecordIO::mapObject(), llvm::codeview::SimpleTypeSerializer::serialize(), and writeCString().

◆ writeSLEB128()

Error BinaryStreamWriter::writeSLEB128 ( int64_t Value )

Write the unsigned integer Value to the underlying stream using ULEB128 encoding.

Returns: a success error code if the data was successfully written, otherwise returns an appropriate error code.

Definition at line 41 of file BinaryStreamWriter.cpp.

References llvm::encodeSLEB128(), Size, and writeBytes().

◆ writeStreamRef() [1/2]

Error BinaryStreamWriter::writeStreamRef ( BinaryStreamRef Ref )

Efficiently reads all data from Ref, and writes it to this stream.

This operation will not invoke any copies of the source data, regardless of the source stream's implementation.

Returns: a success error code if the data was successfully written, otherwise returns an appropriate error code.

Definition at line 61 of file BinaryStreamWriter.cpp.

References llvm::Ref, and writeStreamRef().

Referenced by llvm::codeview::DebugSubsectionRecordBuilder::commit(), llvm::pdb::TpiStreamBuilder::commit(), llvm::pdb::DbiStreamBuilder::commit(), writeArray(), writeRecords(), and writeStreamRef().

◆ writeStreamRef() [2/2]

Error BinaryStreamWriter::writeStreamRef	(	BinaryStreamRef	Ref,
		uint64_t	Size
	)

Efficiently reads Size bytes from Ref, and writes it to this stream.

This operation will not invoke any copies of the source data, regardless of the source stream's implementation.

Returns: a success error code if the data was successfully written, otherwise returns an appropriate error code.

Definition at line 65 of file BinaryStreamWriter.cpp.

References llvm::BinaryStreamReader::bytesRemaining(), llvm::Length, llvm::BinaryStreamReader::readLongestContiguousChunk(), llvm::Ref, llvm::Error::success(), and writeBytes().

◆ writeULEB128()

Error BinaryStreamWriter::writeULEB128 ( uint64_t Value )

Write the unsigned integer Value to the underlying stream using ULEB128 encoding.

Returns: a success error code if the data was successfully written, otherwise returns an appropriate error code.

Definition at line 35 of file BinaryStreamWriter.cpp.

References llvm::encodeULEB128(), Size, and writeBytes().

Member Data Documentation

◆ Offset

uint64_t llvm::BinaryStreamWriter::Offset = 0

protected

Definition at line 184 of file BinaryStreamWriter.h.

Referenced by getOffset(), padToAlignment(), setOffset(), split(), and writeBytes().

◆ Stream

WritableBinaryStreamRef llvm::BinaryStreamWriter::Stream

protected

Definition at line 183 of file BinaryStreamWriter.h.

Referenced by getLength(), split(), writeBytes(), and writeInteger().

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

include/llvm/Support/BinaryStreamWriter.h
lib/Support/BinaryStreamWriter.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BinaryStreamWriter() [1/5]

◆ BinaryStreamWriter() [2/5]

◆ BinaryStreamWriter() [3/5]

◆ BinaryStreamWriter() [4/5]

◆ BinaryStreamWriter() [5/5]

◆ ~BinaryStreamWriter()

Member Function Documentation

◆ bytesRemaining()

◆ getLength()

◆ getOffset()

◆ operator=()

◆ padToAlignment()

◆ setOffset()

◆ split()

◆ writeArray() [1/3]

◆ writeArray() [2/3]

◆ writeArray() [3/3]

◆ writeBytes()

◆ writeCString()

◆ writeEnum()

◆ writeFixedString()

◆ writeInteger()

◆ writeObject()

◆ writeSLEB128()

◆ writeStreamRef() [1/2]

◆ writeStreamRef() [2/2]

◆ writeULEB128()

Member Data Documentation

◆ Offset

◆ Stream