This represents a position within a bitcode file, implemented on top of a SimpleBitstreamCursor. More...

#include "llvm/Bitcode/BitstreamReader.h"

Inheritance diagram for llvm::BitstreamCursor:

Collaboration diagram for llvm::BitstreamCursor:

Public Types
enum	{ AF_DontPopBlockAtEnd = 1, AF_DontAutoprocessAbbrevs = 2 }
	Flags that modify the behavior of advance(). More...

Public Member Functions
	BitstreamCursor ()=default

	BitstreamCursor (ArrayRef< uint8_t > BitcodeBytes)

	BitstreamCursor (StringRef BitcodeBytes)

	BitstreamCursor (MemoryBufferRef BitcodeBytes)

unsigned	getAbbrevIDWidth () const
	Return the number of bits used to encode an abbrev #. More...

BitstreamEntry	advance (unsigned Flags=0)
	Advance the current bitstream, returning the next entry in the stream. More...

BitstreamEntry	advanceSkippingSubblocks (unsigned Flags=0)
	This is a convenience function for clients that don't expect any subblocks. More...

unsigned	ReadCode ()

unsigned	ReadSubBlockID ()
	Having read the ENTER_SUBBLOCK code, read the BlockID for the block. More...

bool	SkipBlock ()
	Having read the ENTER_SUBBLOCK abbrevid and a BlockID, skip over the body of this block. More...

bool	EnterSubBlock (unsigned BlockID, unsigned *NumWordsP=nullptr)
	Having read the ENTER_SUBBLOCK abbrevid, enter the block, and return true if the block has an error. More...

bool	ReadBlockEnd ()

const BitCodeAbbrev *	getAbbrev (unsigned AbbrevID)
	Return the abbreviation for the specified AbbrevId. More...

unsigned	skipRecord (unsigned AbbrevID)
	Read the current record and discard it, returning the code for the record. More...

unsigned	readRecord (unsigned AbbrevID, SmallVectorImpl< uint64_t > &Vals, StringRef *Blob=nullptr)

void	ReadAbbrevRecord ()

Optional< BitstreamBlockInfo >	ReadBlockInfoBlock (bool ReadBlockInfoNames=false)
	Read and return a block info block from the bitstream. More...

void	setBlockInfo (BitstreamBlockInfo *BI)
	Set the block info to be used by this BitstreamCursor to interpret abbreviated records. More...

Static Public Attributes
static const size_t	MaxChunkSize = sizeof(word_t) * 8

Detailed Description

This represents a position within a bitcode file, implemented on top of a SimpleBitstreamCursor.

Unlike iterators, BitstreamCursors are heavy-weight objects that should not be passed by value.

Definition at line 312 of file BitstreamReader.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Flags that modify the behavior of advance().

Enumerator
AF_DontPopBlockAtEnd	If this flag is used, the advance() method does not automatically pop the block scope when the end of a block is reached.
AF_DontAutoprocessAbbrevs	If this flag is used, abbrev entries are returned just like normal records.

Definition at line 359 of file BitstreamReader.h.

Constructor & Destructor Documentation

◆ BitstreamCursor() [1/4]

llvm::BitstreamCursor::BitstreamCursor ( )

default

◆ BitstreamCursor() [2/4]

llvm::BitstreamCursor::BitstreamCursor ( ArrayRef< uint8_t > BitcodeBytes )

inlineexplicit

Definition at line 336 of file BitstreamReader.h.

◆ BitstreamCursor() [3/4]

llvm::BitstreamCursor::BitstreamCursor ( StringRef BitcodeBytes )

inlineexplicit

Definition at line 338 of file BitstreamReader.h.

◆ BitstreamCursor() [4/4]

llvm::BitstreamCursor::BitstreamCursor ( MemoryBufferRef BitcodeBytes )

inlineexplicit

Definition at line 340 of file BitstreamReader.h.

Member Function Documentation

◆ advance()

BitstreamEntry llvm::BitstreamCursor::advance ( unsigned Flags = 0 )

inline

Advance the current bitstream, returning the next entry in the stream.

Definition at line 370 of file BitstreamReader.h.

References llvm::bitc::DEFINE_ABBREV, llvm::bitc::END_BLOCK, llvm::bitc::ENTER_SUBBLOCK, llvm::BitstreamEntry::getEndBlock(), llvm::BitstreamEntry::getError(), llvm::BitstreamEntry::getRecord(), and llvm::BitstreamEntry::getSubBlock().

Referenced by llvm::getBitcodeFileContents(), llvm::BitcodeModule::getLTOInfo(), hasObjCCategory(), jumpToValueSymbolTable(), readBlobInRecord(), readIdentificationBlock(), readIdentificationCode(), and readTriple().

◆ advanceSkippingSubblocks()

BitstreamEntry llvm::BitstreamCursor::advanceSkippingSubblocks ( unsigned Flags = 0 )

inline

This is a convenience function for clients that don't expect any subblocks.

This just skips over them automatically.

Definition at line 400 of file BitstreamReader.h.

References llvm::BitstreamEntry::getError(), llvm::BitstreamEntry::Kind, and llvm::BitstreamEntry::SubBlock.

Referenced by decodeLLVMAttributesForBitcode(), getAttrFromCode(), getEnableSplitLTOUnitFlag(), hasObjCCategoryInModule(), jumpToValueSymbolTable(), llvm::MetadataLoader::MetadataLoaderImpl::parseMetadata(), llvm::MetadataLoader::MetadataLoaderImpl::parseMetadataAttachment(), llvm::MetadataLoader::MetadataLoaderImpl::parseMetadataKinds(), ReadBlockInfoBlock(), readModuleTriple(), readWideAPInt(), setImmutableRefs(), and llvm::MetadataLoader::MetadataLoaderImpl::upgradeDebugIntrinsics().

◆ EnterSubBlock()

bool BitstreamCursor::EnterSubBlock	(	unsigned	BlockID,
		unsigned *	NumWordsP = `nullptr`
	)

Having read the ENTER_SUBBLOCK abbrevid, enter the block, and return true if the block has an error.

EnterSubBlock - Having read the ENTER_SUBBLOCK abbrevid, enter the block, and return true if the block has an error.

Definition at line 23 of file BitstreamReader.cpp.

References llvm::SimpleBitstreamCursor::AtEndOfStream(), llvm::SmallVectorTemplateCommon< T, typename >::back(), llvm::bitc::BlockSizeWidth, llvm::bitc::CodeLenWidth, llvm::BitstreamBlockInfo::getBlockInfo(), Info, MaxChunkSize, llvm::SmallVectorTemplateBase< T, bool >::push_back(), llvm::SimpleBitstreamCursor::Read(), llvm::SimpleBitstreamCursor::ReadVBR(), and llvm::SimpleBitstreamCursor::SkipToFourByteBoundary().

Referenced by decodeLLVMAttributesForBitcode(), getAttrFromCode(), getEnableSplitLTOUnitFlag(), llvm::BitcodeModule::getLTOInfo(), hasObjCCategoryInModule(), jumpToValueSymbolTable(), llvm::MetadataLoader::MetadataLoaderImpl::parseMetadata(), llvm::MetadataLoader::MetadataLoaderImpl::parseMetadataAttachment(), llvm::MetadataLoader::MetadataLoaderImpl::parseMetadataKinds(), readBlobInRecord(), ReadBlockInfoBlock(), readIdentificationBlock(), readModuleTriple(), readWideAPInt(), and setImmutableRefs().

◆ getAbbrev()

const BitCodeAbbrev* llvm::BitstreamCursor::getAbbrev ( unsigned AbbrevID )

inline

Return the abbreviation for the specified AbbrevId.

Definition at line 473 of file BitstreamReader.h.

References llvm::bitc::FIRST_APPLICATION_ABBREV, and llvm::report_fatal_error().

Referenced by readRecord(), and skipRecord().

◆ getAbbrevIDWidth()

unsigned llvm::BitstreamCursor::getAbbrevIDWidth ( ) const

inline

Return the number of bits used to encode an abbrev #.

Definition at line 356 of file BitstreamReader.h.

Referenced by jumpToValueSymbolTable().

◆ ReadAbbrevRecord()

void BitstreamCursor::ReadAbbrevRecord ( )

Definition at line 285 of file BitstreamReader.cpp.

References llvm::Data, E, llvm::BitCodeAbbrevOp::Fixed, llvm::BitCodeAbbrevOp::hasEncodingData(), MaxChunkSize, llvm::SimpleBitstreamCursor::Read(), llvm::SimpleBitstreamCursor::ReadVBR(), llvm::SimpleBitstreamCursor::ReadVBR64(), llvm::report_fatal_error(), and llvm::BitCodeAbbrevOp::VBR.

Referenced by ReadBlockInfoBlock().

◆ ReadBlockEnd()

bool llvm::BitstreamCursor::ReadBlockEnd ( )

inline

Definition at line 448 of file BitstreamReader.h.

References llvm::SmallVectorTemplateCommon< T, typename >::back(), llvm::SmallVectorBase::empty(), and llvm::SmallVectorTemplateBase< T, bool >::pop_back().

Referenced by llvm::MetadataLoader::MetadataLoaderImpl::parseMetadata().

◆ ReadBlockInfoBlock()

Optional< BitstreamBlockInfo > BitstreamCursor::ReadBlockInfoBlock ( bool ReadBlockInfoNames = false )

Read and return a block info block from the bitstream.

If an error was encountered, return None.

Parameters

ReadBlockInfoNames Whether to read block/record name information in the BlockInfo block. Only llvm-bcanalyzer uses this.

Definition at line 324 of file BitstreamReader.cpp.

References llvm::BitstreamBlockInfo::BlockInfo::Abbrevs, advanceSkippingSubblocks(), AF_DontAutoprocessAbbrevs, llvm::bitc::BLOCKINFO_BLOCK_ID, llvm::bitc::BLOCKINFO_CODE_BLOCKNAME, llvm::bitc::BLOCKINFO_CODE_SETBID, llvm::bitc::BLOCKINFO_CODE_SETRECORDNAME, llvm::SmallVectorImpl< T >::clear(), llvm::bitc::DEFINE_ABBREV, llvm::BitstreamEntry::EndBlock, EnterSubBlock(), llvm::BitstreamEntry::Error, llvm::BitstreamBlockInfo::getOrCreateBlockInfo(), llvm::BitstreamEntry::ID, llvm::BitstreamEntry::Kind, llvm::BitstreamBlockInfo::BlockInfo::Name, Name, llvm::None, ReadAbbrevRecord(), readRecord(), llvm::BitstreamEntry::Record, llvm::BitstreamBlockInfo::BlockInfo::RecordNames, llvm::SmallVectorBase::size(), and llvm::BitstreamEntry::SubBlock.

◆ ReadCode()

unsigned llvm::BitstreamCursor::ReadCode ( )

inline

Definition at line 413 of file BitstreamReader.h.

◆ readRecord()

unsigned BitstreamCursor::readRecord	(	unsigned	AbbrevID,
		SmallVectorImpl< uint64_t > &	Vals,
		StringRef *	Blob = `nullptr`
	)

Definition at line 179 of file BitstreamReader.cpp.

Referenced by decodeLLVMAttributesForBitcode(), getAttrFromCode(), getEnableSplitLTOUnitFlag(), hasObjCCategoryInModule(), jumpToValueSymbolTable(), llvm::MetadataLoader::MetadataLoaderImpl::parseMetadata(), llvm::MetadataLoader::MetadataLoaderImpl::parseMetadataAttachment(), llvm::MetadataLoader::MetadataLoaderImpl::parseMetadataKinds(), readBlobInRecord(), ReadBlockInfoBlock(), readIdentificationBlock(), readModuleTriple(), readWideAPInt(), setImmutableRefs(), and llvm::MetadataLoader::MetadataLoaderImpl::upgradeDebugIntrinsics().

◆ ReadSubBlockID()

unsigned llvm::BitstreamCursor::ReadSubBlockID ( )

inline

Having read the ENTER_SUBBLOCK code, read the BlockID for the block.

Definition at line 421 of file BitstreamReader.h.

References llvm::bitc::BlockIDWidth.

◆ setBlockInfo()

void llvm::BitstreamCursor::setBlockInfo ( BitstreamBlockInfo * BI )

inline

Set the block info to be used by this BitstreamCursor to interpret abbreviated records.

Definition at line 501 of file BitstreamReader.h.

Referenced by readTriple().

◆ SkipBlock()

bool llvm::BitstreamCursor::SkipBlock ( )

inline

Having read the ENTER_SUBBLOCK abbrevid and a BlockID, skip over the body of this block.

If the block record is malformed, return true.

Definition at line 427 of file BitstreamReader.h.

References llvm::BitstreamBlockInfo::BlockInfo::BlockID, llvm::bitc::BlockSizeWidth, and llvm::bitc::CodeLenWidth.

Referenced by llvm::getBitcodeFileContents(), llvm::BitcodeModule::getLTOInfo(), hasObjCCategory(), llvm::MetadataLoader::MetadataLoaderImpl::parseMetadata(), readBlobInRecord(), readIdentificationCode(), readTriple(), and readWideAPInt().

◆ skipRecord()

unsigned BitstreamCursor::skipRecord ( unsigned AbbrevID )

Read the current record and discard it, returning the code for the record.

skipRecord - Read the current record and discard it.

Definition at line 96 of file BitstreamReader.cpp.

Referenced by llvm::getBitcodeFileContents(), llvm::BitcodeModule::getLTOInfo(), hasObjCCategory(), readIdentificationCode(), readTriple(), and llvm::MetadataLoader::MetadataLoaderImpl::upgradeDebugIntrinsics().

Member Data Documentation

◆ MaxChunkSize

const size_t llvm::BitstreamCursor::MaxChunkSize = sizeof(word_t) * 8

static

Definition at line 333 of file BitstreamReader.h.

Referenced by EnterSubBlock(), readAbbreviatedField(), ReadAbbrevRecord(), skipAbbreviatedField(), and skipRecord().

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

include/llvm/Bitcode/BitstreamReader.h
lib/Bitcode/Reader/BitstreamReader.cpp

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ BitstreamCursor() [1/4]

◆ BitstreamCursor() [2/4]

◆ BitstreamCursor() [3/4]

◆ BitstreamCursor() [4/4]

Member Function Documentation

◆ advance()

◆ advanceSkippingSubblocks()

◆ EnterSubBlock()

◆ getAbbrev()

◆ getAbbrevIDWidth()

◆ ReadAbbrevRecord()

◆ ReadBlockEnd()

◆ ReadBlockInfoBlock()

◆ ReadCode()

◆ readRecord()

◆ ReadSubBlockID()

◆ setBlockInfo()

◆ SkipBlock()

◆ skipRecord()

Member Data Documentation

◆ MaxChunkSize