#include "llvm/DebugInfo/DWARF/DWARFFormValue.h"

Public Types
enum	FormClass { FC_Unknown, FC_Address, FC_Block, FC_Constant, FC_String, FC_Flag, FC_Reference, FC_Indirect, FC_SectionOffset, FC_Exprloc }

Public Member Functions
	DWARFFormValue (dwarf::Form F=dwarf::Form(0))
	Context for extract time. More...

dwarf::Form	getForm () const

uint64_t	getRawUValue () const

void	setForm (dwarf::Form F)

void	setUValue (uint64_t V)

void	setSValue (int64_t V)

void	setPValue (const char *V)

void	setBlockValue (const ArrayRef< uint8_t > &Data)

bool	isFormClass (FormClass FC) const

const DWARFUnit *	getUnit () const

void	dump (raw_ostream &OS, DIDumpOptions DumpOpts=DIDumpOptions()) const

void	dumpSectionedAddress (raw_ostream &OS, DIDumpOptions DumpOpts, SectionedAddress SA) const

bool	extractValue (const DWARFDataExtractor &Data, uint32_t OffsetPtr, dwarf::FormParams FormParams, const DWARFContext Context=nullptr, const DWARFUnit *Unit=nullptr)
	Extracts a value in `Data` at offset `*OffsetPtr`. More...

bool	extractValue (const DWARFDataExtractor &Data, uint32_t OffsetPtr, dwarf::FormParams FormParams, const DWARFUnit U)

bool	isInlinedCStr () const

Optional< uint64_t >	getAsReference () const
	getAsFoo functions below return the extracted value as Foo if only DWARFFormValue has form class is suitable for representing Foo. More...

Optional< uint64_t >	getAsUnsignedConstant () const

Optional< int64_t >	getAsSignedConstant () const

Optional< const char * >	getAsCString () const

Optional< uint64_t >	getAsAddress () const

Optional< SectionedAddress >	getAsSectionedAddress () const

Optional< uint64_t >	getAsSectionOffset () const

Optional< ArrayRef< uint8_t > >	getAsBlock () const

Optional< uint64_t >	getAsCStringOffset () const

Optional< uint64_t >	getAsReferenceUVal () const

bool	skipValue (DataExtractor DebugInfoData, uint32_t *OffsetPtr, const dwarf::FormParams Params) const
	Skip a form's value in `DebugInfoData` at the offset specified by `OffsetPtr`. More...

Static Public Member Functions
static void	dumpAddressSection (const DWARFObject &Obj, raw_ostream &OS, DIDumpOptions DumpOpts, uint64_t SectionIndex)

static bool	skipValue (dwarf::Form Form, DataExtractor DebugInfoData, uint32_t *OffsetPtr, const dwarf::FormParams FormParams)
	Skip a form's value in `DebugInfoData` at the offset specified by `OffsetPtr`. More...

Detailed Description

Definition at line 27 of file DWARFFormValue.h.

Member Enumeration Documentation

◆ FormClass

enum llvm::DWARFFormValue::FormClass

Enumerator
FC_Unknown
FC_Address
FC_Block
FC_Constant
FC_String
FC_Flag
FC_Reference
FC_Indirect
FC_SectionOffset
FC_Exprloc

Definition at line 29 of file DWARFFormValue.h.

Constructor & Destructor Documentation

◆ DWARFFormValue()

llvm::DWARFFormValue::DWARFFormValue ( dwarf::Form F = dwarf::Form(0) )

inline

Context for extract time.

Definition at line 60 of file DWARFFormValue.h.

Member Function Documentation

◆ dump()

void DWARFFormValue::dump	(	raw_ostream &	OS,
		DIDumpOptions	DumpOpts = `DIDumpOptions()`
	)		const

Definition at line 357 of file DWARFFormValue.cpp.

References llvm::Address, llvm::format(), llvm::WithColor::get(), llvm::Optional< T >::getValue(), llvm::Optional< T >::hasValue(), llvm::None, llvm::nulls(), llvm::DIDumpOptions::ShowAddresses, llvm::String, llvm::DIDumpOptions::Verbose, and llvm::raw_ostream::write_escaped().

Referenced by llvm::DWARFDebugLine::Prologue::dump(), dumpAttribute(), dumpLocation(), and getUnit().

◆ dumpAddressSection()

void DWARFFormValue::dumpAddressSection	(	const DWARFObject &	Obj,
		raw_ostream &	OS,
		DIDumpOptions	DumpOpts,
		uint64_t	SectionIndex
	)

static

Definition at line 342 of file DWARFFormValue.cpp.

References llvm::format(), llvm::DWARFObject::getSectionNames(), and llvm::DIDumpOptions::Verbose.

Referenced by dumpRanges(), and getUnit().

◆ dumpSectionedAddress()

void DWARFFormValue::dumpSectionedAddress	(	raw_ostream &	OS,
		DIDumpOptions	DumpOpts,
		SectionedAddress	SA
	)		const

Definition at line 334 of file DWARFFormValue.cpp.

References llvm::SectionedAddress::Address, llvm::format(), and llvm::SectionedAddress::SectionIndex.

Referenced by getUnit().

◆ extractValue() [1/2]

bool DWARFFormValue::extractValue	(	const DWARFDataExtractor &	Data,
		uint32_t *	OffsetPtr,
		dwarf::FormParams	FormParams,
		const DWARFContext *	Context = `nullptr`,
		const DWARFUnit *	Unit = `nullptr`
	)

Extracts a value in Data at offset *OffsetPtr.

The information in FormParams is needed to interpret some forms. The optional Context and Unit allows extracting information if the form refers to other sections (e.g., .debug_str).

Definition at line 205 of file DWARFFormValue.cpp.

Referenced by dumpAttribute(), extractValue(), llvm::DWARFAbbreviationDeclaration::getAttributeValue(), getUnit(), parseV5DirFileTables(), and llvm::AppleAcceleratorTable::readAtoms().

◆ extractValue() [2/2]

bool llvm::DWARFFormValue::extractValue	(	const DWARFDataExtractor &	Data,
		uint32_t *	OffsetPtr,
		dwarf::FormParams	FormParams,
		const DWARFUnit *	U
	)

inline

Definition at line 91 of file DWARFFormValue.h.

References extractValue().

◆ getAsAddress()

Optional< uint64_t > DWARFFormValue::getAsAddress ( ) const

Definition at line 589 of file DWARFFormValue.cpp.

References llvm::None.

◆ getAsBlock()

Optional< ArrayRef< uint8_t > > DWARFFormValue::getAsBlock ( ) const

Definition at line 662 of file DWARFFormValue.cpp.

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

Referenced by dumpLocation(), llvm::DWARFVerifier::handleDebugInfo(), isVariableIndexable(), and parseV5DirFileTables().

◆ getAsCString()

Optional< const char * > DWARFFormValue::getAsCString ( ) const

Definition at line 552 of file DWARFFormValue.cpp.

References C, and llvm::None.

Referenced by llvm::DWARFDebugLine::LineTable::getFileNameByIndex(), and llvm::DWARFDebugLine::LineTable::hasFileAtIndex().

◆ getAsCStringOffset()

Optional< uint64_t > DWARFFormValue::getAsCStringOffset ( ) const

Definition at line 669 of file DWARFFormValue.cpp.

References llvm::None.

◆ getAsReference()

Optional< uint64_t > DWARFFormValue::getAsReference ( ) const

getAsFoo functions below return the extracted value as Foo if only DWARFFormValue has form class is suitable for representing Foo.

Definition at line 609 of file DWARFFormValue.cpp.

References llvm::None.

Referenced by llvm::DWARFVerifier::handleDebugInfo().

◆ getAsReferenceUVal()

Optional< uint64_t > DWARFFormValue::getAsReferenceUVal ( ) const

Definition at line 675 of file DWARFFormValue.cpp.

References llvm::None.

◆ getAsSectionedAddress()

Optional< SectionedAddress > DWARFFormValue::getAsSectionedAddress ( ) const

Definition at line 594 of file DWARFFormValue.cpp.

References llvm::None.

◆ getAsSectionOffset()

Optional< uint64_t > DWARFFormValue::getAsSectionOffset ( ) const

Definition at line 630 of file DWARFFormValue.cpp.

References llvm::None.

Referenced by dumpAttribute(), dumpLocation(), llvm::DWARFDie::getAddressRanges(), llvm::DWARFVerifier::handleDebugInfo(), isVariableIndexable(), and llvm::AppleAcceleratorTable::readAtoms().

◆ getAsSignedConstant()

Optional< int64_t > DWARFFormValue::getAsSignedConstant ( ) const

Definition at line 643 of file DWARFFormValue.cpp.

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

◆ getAsUnsignedConstant()

Optional< uint64_t > DWARFFormValue::getAsUnsignedConstant ( ) const

Definition at line 636 of file DWARFFormValue.cpp.

References llvm::None.

Referenced by dumpAttribute(), llvm::AppleAcceleratorTable::Entry::getTag(), parseV5DirFileTables(), and llvm::AppleAcceleratorTable::readAtoms().

◆ getForm()

dwarf::Form llvm::DWARFFormValue::getForm ( ) const

inline

Definition at line 62 of file DWARFFormValue.h.

Referenced by dumpAttribute(), llvm::DWARFDie::getAddressRanges(), llvm::DWARFVerifier::handleDebugInfo(), llvm::AppleAcceleratorTable::readAtoms(), and llvm::AppleAcceleratorTable::validateForms().

◆ getRawUValue()

uint64_t llvm::DWARFFormValue::getRawUValue ( ) const

inline

Definition at line 63 of file DWARFFormValue.h.

Referenced by llvm::DWARFVerifier::handleDebugInfo(), and llvm::AppleAcceleratorTable::readAtoms().

◆ getUnit()

const DWARFUnit* llvm::DWARFFormValue::getUnit ( ) const

inline

Definition at line 75 of file DWARFFormValue.h.

References Context, llvm::Data, dump(), dumpAddressSection(), dumpSectionedAddress(), extractValue(), and Unit.

◆ isFormClass()

bool DWARFFormValue::isFormClass ( DWARFFormValue::FormClass FC ) const

Definition at line 179 of file DWARFFormValue.cpp.

References DWARF5FormClasses, llvm::makeArrayRef(), and llvm::size().

Referenced by dumpLocation(), setBlockValue(), and llvm::AppleAcceleratorTable::validateForms().

◆ isInlinedCStr()

bool llvm::DWARFFormValue::isInlinedCStr ( ) const

inline

Definition at line 96 of file DWARFFormValue.h.

◆ setBlockValue()

void llvm::DWARFFormValue::setBlockValue ( const ArrayRef< uint8_t > & Data )

inline

Definition at line 69 of file DWARFFormValue.h.

References llvm::ArrayRef< T >::data(), R600_InstFlag::FC, isFormClass(), setUValue(), and llvm::ArrayRef< T >::size().

◆ setForm()

void llvm::DWARFFormValue::setForm ( dwarf::Form F )

inline

Definition at line 64 of file DWARFFormValue.h.

References F().

Referenced by llvm::DWARFDebugLine::LineTable::parse(), and parseV2DirFileTables().

◆ setPValue()

void llvm::DWARFFormValue::setPValue ( const char * V )

inline

Definition at line 67 of file DWARFFormValue.h.

Referenced by llvm::DWARFDebugLine::LineTable::parse(), and parseV2DirFileTables().

◆ setSValue()

void llvm::DWARFFormValue::setSValue ( int64_t V )

inline

Definition at line 66 of file DWARFFormValue.h.

Referenced by llvm::DWARFAbbreviationDeclaration::getAttributeValue().

◆ setUValue()

void llvm::DWARFFormValue::setUValue ( uint64_t V )

inline

Definition at line 65 of file DWARFFormValue.h.

Referenced by dumpAttribute(), and setBlockValue().

◆ skipValue() [1/2]

bool llvm::DWARFFormValue::skipValue	(	DataExtractor	DebugInfoData,
		uint32_t *	OffsetPtr,
		const dwarf::FormParams	Params
	)		const

inline

Skip a form's value in DebugInfoData at the offset specified by OffsetPtr.

Skips the bytes for the current form and updates the offset.

Parameters

DebugInfoData	The data where we want to skip the value.
OffsetPtr	A reference to the offset that will be updated.
Params	DWARF parameters to help interpret forms.

Returns: true on success, false if the form was not skipped.

Definition at line 122 of file DWARFFormValue.h.

Referenced by llvm::DWARFDebugInfoEntry::extractFast(), llvm::DWARFAbbreviationDeclaration::getAttributeValue(), and parseV5DirFileTables().

◆ skipValue() [2/2]

bool DWARFFormValue::skipValue	(	dwarf::Form	Form,
		DataExtractor	DebugInfoData,
		uint32_t *	OffsetPtr,
		const dwarf::FormParams	FormParams
	)

static

Skip a form's value in DebugInfoData at the offset specified by OffsetPtr.

Skips the bytes for the specified form and updates the offset.

Parameters

Form	The DW_FORM enumeration that indicates the form to skip.
DebugInfoData	The data where we want to skip the value.
OffsetPtr	A reference to the offset that will be updated.
FormParams	DWARF parameters to help interpret forms.

Returns: true on success, false if the form was not skipped.

Definition at line 81 of file DWARFFormValue.cpp.

References llvm::DataExtractor::getCStr(), llvm::dwarf::getFixedFormByteSize(), llvm::DataExtractor::getSLEB128(), llvm::DataExtractor::getU16(), llvm::DataExtractor::getU32(), llvm::DataExtractor::getU8(), llvm::DataExtractor::getULEB128(), and llvm::size().

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

include/llvm/DebugInfo/DWARF/DWARFFormValue.h
lib/DebugInfo/DWARF/DWARFFormValue.cpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ FormClass

Constructor & Destructor Documentation

◆ DWARFFormValue()

Member Function Documentation

◆ dump()

◆ dumpAddressSection()

◆ dumpSectionedAddress()

◆ extractValue() [1/2]

◆ extractValue() [2/2]

◆ getAsAddress()

◆ getAsBlock()

◆ getAsCString()

◆ getAsCStringOffset()

◆ getAsReference()

◆ getAsReferenceUVal()

◆ getAsSectionedAddress()

◆ getAsSectionOffset()

◆ getAsSignedConstant()

◆ getAsUnsignedConstant()

◆ getForm()

◆ getRawUValue()

◆ getUnit()

◆ isFormClass()

◆ isInlinedCStr()

◆ setBlockValue()

◆ setForm()

◆ setPValue()

◆ setSValue()

◆ setUValue()

◆ skipValue() [1/2]

◆ skipValue() [2/2]