#include "llvm/Bitcode/BitstreamWriter.h"

Public Member Functions
	BitstreamWriter (SmallVectorImpl< char > &O)

	~BitstreamWriter ()

uint64_t	GetCurrentBitNo () const
	Retrieve the current position in the stream, in bits. More...

unsigned	GetAbbrevIDWidth () const
	Retrieve the number of bits currently used to encode an abbrev ID. More...

void	BackpatchWord (uint64_t BitNo, unsigned NewWord)
	Backpatch a 32-bit word in the output at the given bit offset with the specified value. More...

void	BackpatchWord64 (uint64_t BitNo, uint64_t Val)

void	Emit (uint32_t Val, unsigned NumBits)

void	FlushToWord ()

void	EmitVBR (uint32_t Val, unsigned NumBits)

void	EmitVBR64 (uint64_t Val, unsigned NumBits)

void	EmitCode (unsigned Val)
	EmitCode - Emit the specified code. More...

BlockInfo *	getBlockInfo (unsigned BlockID)
	getBlockInfo - If there is block info for the specified ID, return it, otherwise return null. More...

void	EnterSubblock (unsigned BlockID, unsigned CodeLen)

void	ExitBlock ()

template<class UIntTy >
void	emitBlob (ArrayRef< UIntTy > Bytes, bool ShouldEmitSize=true)
	Emit a blob, including flushing before and tail-padding. More...

void	emitBlob (StringRef Bytes, bool ShouldEmitSize=true)

template<typename Container >
void	EmitRecord (unsigned Code, const Container &Vals, unsigned Abbrev=0)
	EmitRecord - Emit the specified record to the stream, using an abbrev if we have one to compress the output. More...

template<typename Container >
void	EmitRecordWithAbbrev (unsigned Abbrev, const Container &Vals)
	EmitRecordWithAbbrev - Emit a record with the specified abbreviation. More...

template<typename Container >
void	EmitRecordWithBlob (unsigned Abbrev, const Container &Vals, StringRef Blob)
	EmitRecordWithBlob - Emit the specified record to the stream, using an abbrev that includes a blob at the end. More...

template<typename Container >
void	EmitRecordWithBlob (unsigned Abbrev, const Container &Vals, const char *BlobData, unsigned BlobLen)

template<typename Container >
void	EmitRecordWithArray (unsigned Abbrev, const Container &Vals, StringRef Array)
	EmitRecordWithArray - Just like EmitRecordWithBlob, works with records that end with an array. More...

template<typename Container >
void	EmitRecordWithArray (unsigned Abbrev, const Container &Vals, const char *ArrayData, unsigned ArrayLen)

unsigned	EmitAbbrev (std::shared_ptr< BitCodeAbbrev > Abbv)
	EmitAbbrev - This emits an abbreviation to the stream. More...

void	EnterBlockInfoBlock ()
	EnterBlockInfoBlock - Start emitting the BLOCKINFO_BLOCK. More...

unsigned	EmitBlockInfoAbbrev (unsigned BlockID, std::shared_ptr< BitCodeAbbrev > Abbv)
	EmitBlockInfoAbbrev - Emit a DEFINE_ABBREV record for the specified BlockID. More...

Detailed Description

Definition at line 28 of file BitstreamWriter.h.

Constructor & Destructor Documentation

◆ BitstreamWriter()

llvm::BitstreamWriter::BitstreamWriter ( SmallVectorImpl< char > & O )

inlineexplicit

Definition at line 85 of file BitstreamWriter.h.

◆ ~BitstreamWriter()

llvm::BitstreamWriter::~BitstreamWriter ( )

inline

Definition at line 88 of file BitstreamWriter.h.

References assert().

Member Function Documentation

◆ BackpatchWord()

void llvm::BitstreamWriter::BackpatchWord	(	uint64_t	BitNo,
		unsigned	NewWord
	)

inline

Backpatch a 32-bit word in the output at the given bit offset with the specified value.

Definition at line 105 of file BitstreamWriter.h.

References assert().

Referenced by BackpatchWord64(), emitSignedInt64(), and ExitBlock().

◆ BackpatchWord64()

void llvm::BitstreamWriter::BackpatchWord64	(	uint64_t	BitNo,
		uint64_t	Val
	)

inline

Definition at line 115 of file BitstreamWriter.h.

References BackpatchWord().

◆ Emit()

void llvm::BitstreamWriter::Emit	(	uint32_t	Val,
		unsigned	NumBits
	)

inline

Definition at line 120 of file BitstreamWriter.h.

References assert().

Referenced by EmitCode(), EmitRecordWithArray(), EmitVBR(), EmitVBR64(), EnterSubblock(), ExitBlock(), and writeBitcodeHeader().

◆ EmitAbbrev()

unsigned llvm::BitstreamWriter::EmitAbbrev ( std::shared_ptr< BitCodeAbbrev > Abbv )

inline

EmitAbbrev - This emits an abbreviation to the stream.

Note that this method takes ownership of the specified abbrev.

Definition at line 492 of file BitstreamWriter.h.

References llvm::bitc::FIRST_APPLICATION_ABBREV.

Referenced by emitSignedInt64(), getAttrKindEncoding(), getEncodedUnnamedAddr(), getOptimizationFlags(), getStringEncoding(), rotateSign(), writeIdentificationBlock(), llvm::WriteIndexToFile(), and llvm::BitcodeWriter::~BitcodeWriter().

◆ emitBlob() [1/2]

template<class UIntTy >

void llvm::BitstreamWriter::emitBlob	(	ArrayRef< UIntTy >	Bytes,
		bool	ShouldEmitSize = `true`
	)

inline

Emit a blob, including flushing before and tail-padding.

Definition at line 385 of file BitstreamWriter.h.

References assert(), B, EmitVBR(), FlushToWord(), llvm::isUInt< 8 >(), and llvm::ArrayRef< T >::size().

Referenced by emitBlob(), and ExitBlock().

◆ emitBlob() [2/2]

void llvm::BitstreamWriter::emitBlob	(	StringRef	Bytes,
		bool	ShouldEmitSize = `true`
	)

inline

Definition at line 403 of file BitstreamWriter.h.

References llvm::StringRef::data(), emitBlob(), llvm::makeArrayRef(), and llvm::StringRef::size().

◆ EmitBlockInfoAbbrev()

unsigned llvm::BitstreamWriter::EmitBlockInfoAbbrev	(	unsigned	BlockID,
		std::shared_ptr< BitCodeAbbrev >	Abbv
	)

inline

EmitBlockInfoAbbrev - Emit a DEFINE_ABBREV record for the specified BlockID.

Definition at line 535 of file BitstreamWriter.h.

References llvm::bitc::FIRST_APPLICATION_ABBREV, and Info.

Referenced by emitSignedInt64().

◆ EmitCode()

void llvm::BitstreamWriter::EmitCode ( unsigned Val )

inline

EmitCode - Emit the specified code.

Definition at line 178 of file BitstreamWriter.h.

References Emit().

Referenced by EmitRecord(), EmitRecordWithArray(), EnterSubblock(), and ExitBlock().

◆ EmitRecord()

template<typename Container >

void llvm::BitstreamWriter::EmitRecord	(	unsigned	Code,
		const Container &	Vals,
		unsigned	Abbrev = `0`
	)

inline

EmitRecord - Emit the specified record to the stream, using an abbrev if we have one to compress the output.

Definition at line 411 of file BitstreamWriter.h.

References EmitCode(), EmitVBR(), EmitVBR64(), llvm::makeArrayRef(), and llvm::bitc::UNABBREV_RECORD.

Referenced by emitSignedInt64(), EnterBlockInfoBlock(), getAttrKindEncoding(), getEncodedUnnamedAddr(), getOptimizationFlags(), getStringEncoding(), rotateSign(), writeFunctionTypeMetadataRecords(), writeIdentificationBlock(), llvm::WriteIndexToFile(), writeStringRecord(), and writeTypeIdSummaryRecord().

◆ EmitRecordWithAbbrev()

template<typename Container >

void llvm::BitstreamWriter::EmitRecordWithAbbrev	(	unsigned	Abbrev,
		const Container &	Vals
	)

inline

EmitRecordWithAbbrev - Emit a record with the specified abbreviation.

Unlike EmitRecord, the code for the record should be included in Vals as the first entry.

Definition at line 431 of file BitstreamWriter.h.

References llvm::makeArrayRef(), and llvm::None.

Referenced by getEncodedUnnamedAddr().

◆ EmitRecordWithArray() [1/2]

template<typename Container >

void llvm::BitstreamWriter::EmitRecordWithArray	(	unsigned	Abbrev,
		const Container &	Vals,
		StringRef	Array
	)

inline

EmitRecordWithArray - Just like EmitRecordWithBlob, works with records that end with an array.

Definition at line 455 of file BitstreamWriter.h.

References llvm::makeArrayRef(), and llvm::None.

◆ EmitRecordWithArray() [2/2]

template<typename Container >

void llvm::BitstreamWriter::EmitRecordWithArray	(	unsigned	Abbrev,
		const Container &	Vals,
		const char *	ArrayData,
		unsigned	ArrayLen
	)

inline

Definition at line 460 of file BitstreamWriter.h.

References llvm::bitc::DEFINE_ABBREV, Emit(), EmitCode(), EmitVBR(), EmitVBR64(), llvm::BitCodeAbbrevOp::getEncoding(), llvm::BitCodeAbbrevOp::getEncodingData(), llvm::BitCodeAbbrevOp::getLiteralValue(), llvm::BitCodeAbbrev::getNumOperandInfos(), llvm::BitCodeAbbrev::getOperandInfo(), llvm::BitCodeAbbrevOp::hasEncodingData(), llvm::BitCodeAbbrevOp::isLiteral(), llvm::makeArrayRef(), and llvm::None.

◆ EmitRecordWithBlob() [1/2]

template<typename Container >

void llvm::BitstreamWriter::EmitRecordWithBlob	(	unsigned	Abbrev,
		const Container &	Vals,
		StringRef	Blob
	)

inline

EmitRecordWithBlob - Emit the specified record to the stream, using an abbrev that includes a blob at the end.

The blob data to emit is specified by the pointer and length specified at the end. In contrast to EmitRecord, this routine expects that the first entry in Vals is the code of the record.

Definition at line 441 of file BitstreamWriter.h.

References llvm::makeArrayRef(), and llvm::None.

Referenced by rotateSign(), and llvm::BitcodeWriter::~BitcodeWriter().