A structured debug information entry. More...

#include "llvm/CodeGen/DIE.h"

Inheritance diagram for llvm::DIE:

Public Types
using	child_iterator = IntrusiveBackList< DIE >::iterator

using	const_child_iterator = IntrusiveBackList< DIE >::const_iterator

using	child_range = iterator_range< child_iterator >

using	const_child_range = iterator_range< const_child_iterator >

Public Types inherited from llvm::DIEValueList
using	value_range = iterator_range< value_iterator >

using	const_value_range = iterator_range< const_value_iterator >

Public Member Functions
	DIE ()=delete

	DIE (const DIE &RHS)=delete

	DIE (DIE &&RHS)=delete

DIE &	operator= (const DIE &RHS)=delete

DIE &	operator= (const DIE &&RHS)=delete

unsigned	getAbbrevNumber () const

dwarf::Tag	getTag () const

unsigned	getOffset () const
	Get the compile/type unit relative offset of this DIE.

unsigned	getSize () const

bool	hasChildren () const

void	setForceChildren (bool B)

child_range	children ()

const_child_range	children () const

DIE *	getParent () const

DIEAbbrev	generateAbbrev () const
	Generate the abbreviation for this DIE.

void	setAbbrevNumber (unsigned I)
	Set the abbreviation number for this DIE.

uint64_t	getDebugSectionOffset () const
	Get the absolute offset within the .debug_info or .debug_types section for this DIE.

unsigned	computeOffsetsAndAbbrevs (const dwarf::FormParams &FormParams, DIEAbbrevSet &AbbrevSet, unsigned CUOffset)
	Compute the offset of this DIE and all its children.

const DIE *	getUnitDie () const
	Climb up the parent chain to get the compile unit or type unit DIE that this DIE belongs to.

DIEUnit *	getUnit () const
	Climb up the parent chain to get the compile unit or type unit that this DIE belongs to.

void	setOffset (unsigned O)

void	setSize (unsigned S)

DIE &	addChild (DIE *Child)
	Add a child to the DIE.

DIE &	addChildFront (DIE *Child)

DIEValue	findAttribute (dwarf::Attribute Attribute) const
	Find a value in the DIE with the attribute given.

void	print (raw_ostream &O, unsigned IndentCount=0) const

void	dump () const

Public Member Functions inherited from llvm::DIEValueList
value_iterator	addValue (BumpPtrAllocator &Alloc, const DIEValue &V)

template<class T >
value_iterator	addValue (BumpPtrAllocator &Alloc, dwarf::Attribute Attribute, dwarf::Form Form, T &&Value)

void	takeValues (DIEValueList &Other)
	Take ownership of the nodes in `Other`, and append them to the back of the list.

value_range	values ()

const_value_range	values () const

Static Public Member Functions
static DIE *	get (BumpPtrAllocator &Alloc, dwarf::Tag Tag)

Friends
class	IntrusiveBackList< DIE >

class	DIEUnit

Detailed Description

A structured debug information entry.

Has an abbreviation which describes its organization.

Definition at line 746 of file DIE.h.

Member Typedef Documentation

◆ child_iterator

using llvm::DIE::child_iterator = IntrusiveBackList<DIE>::iterator

Definition at line 797 of file DIE.h.

◆ child_range

using llvm::DIE::child_range = iterator_range<child_iterator>

Definition at line 799 of file DIE.h.

◆ const_child_iterator

using llvm::DIE::const_child_iterator = IntrusiveBackList<DIE>::const_iterator

Definition at line 798 of file DIE.h.

◆ const_child_range

using llvm::DIE::const_child_range = iterator_range<const_child_iterator>

Definition at line 800 of file DIE.h.

Constructor & Destructor Documentation

◆ DIE() [1/3]

llvm::DIE::DIE ( )

delete

Referenced by get().

◆ DIE() [2/3]

llvm::DIE::DIE ( const DIE & RHS )

delete

◆ DIE() [3/3]

llvm::DIE::DIE ( DIE && RHS )

delete

Member Function Documentation

◆ addChild()

DIE & llvm::DIE::addChild ( DIE * Child )

inline

Add a child to the DIE.

Definition at line 861 of file DIE.h.

References assert(), and getParent().

Referenced by llvm::DwarfCompileUnit::constructCallSiteParmEntryDIEs(), llvm::DwarfCompileUnit::constructImportedEntityDIE(), llvm::DwarfCompileUnit::constructInlinedScopeDIE(), llvm::DwarfCompileUnit::constructScopeDIE(), llvm::DwarfCompileUnit::constructSubprogramScopeDIE(), llvm::DwarfUnit::createAndAddDIE(), and llvm::DwarfCompileUnit::createAndAddScopeChildren().

◆ addChildFront()

DIE & llvm::DIE::addChildFront ( DIE * Child )

inline

Definition at line 868 of file DIE.h.

References assert(), and getParent().

Referenced by llvm::DwarfCompileUnit::createBaseTypeDIEs().

◆ children() [1/2]

child_range llvm::DIE::children ( )

inline

Definition at line 802 of file DIE.h.

References llvm::make_range().

Referenced by computeOffsetsAndAbbrevs(), llvm::AsmPrinter::emitDwarfDIE(), and print().

◆ children() [2/2]

const_child_range llvm::DIE::children ( ) const

inline

Definition at line 805 of file DIE.h.

References llvm::make_range().

◆ computeOffsetsAndAbbrevs()

unsigned DIE::computeOffsetsAndAbbrevs	(	const dwarf::FormParams &	FormParams,
		DIEAbbrevSet &	AbbrevSet,
		unsigned	CUOffset
	)

Compute the offset of this DIE and all its children.

This function gets called just before we are going to generate the debug information and gives each DIE a chance to figure out its CU relative DIE offset, unique its abbreviation and fill in the abbreviation code, and return the unit offset that points to where the next DIE will be emitted within the debug unit section. After this function has been called for all DIE objects, the DWARF can be generated since all DIEs will be able to properly refer to other DIE objects since all DIEs have calculated their offsets.

Parameters

FormParams	Used when calculating sizes.
AbbrevSet	the abbreviation used to unique DIE abbreviations.
CUOffset	the compile/type unit relative offset in bytes.

Returns: the offset for the DIE that follows this DIE within the current compile/type unit.

Definition at line 270 of file DIE.cpp.

References assert(), children(), getAbbrevNumber(), getOffset(), llvm::getULEB128Size(), llvm::DIEAbbrev::hasChildren(), hasChildren(), setOffset(), setSize(), llvm::DIEAbbrevSet::uniqueAbbreviation(), and llvm::DIEValueList::values().

Referenced by llvm::DwarfFile::computeSizeAndOffset().

◆ dump()

LLVM_DUMP_METHOD void DIE::dump ( ) const

Definition at line 265 of file DIE.cpp.

References llvm::dbgs(), and print().

◆ findAttribute()

DIEValue DIE::findAttribute ( dwarf::Attribute Attribute ) const

Find a value in the DIE with the attribute given.

Returns a default-constructed DIEValue (where DIEValue::getType() gives DIEValue::isNone) if no such attribute exists.

Definition at line 214 of file DIE.cpp.

References llvm::DIEValueList::values().

Referenced by computeIndexValue().

◆ generateAbbrev()

DIEAbbrev DIE::generateAbbrev ( ) const

Generate the abbreviation for this DIE.

Calculate the abbreviation for this, which should be uniqued and eventually used to call setAbbrevNumber().

Definition at line 178 of file DIE.cpp.

References llvm::DIEAbbrev::AddAttribute(), llvm::DIEAbbrev::AddImplicitConstAttribute(), hasChildren(), and llvm::DIEValueList::values().

Referenced by llvm::DIEAbbrevSet::uniqueAbbreviation().

◆ get()

static DIE * llvm::DIE::get	(	BumpPtrAllocator &	Alloc,
		dwarf::Tag	Tag
	)

inlinestatic

Definition at line 776 of file DIE.h.

References llvm::Alloc, and DIE().

Referenced by llvm::DwarfCompileUnit::constructCallSiteParmEntryDIEs(), llvm::DwarfCompileUnit::constructImportedEntityDIE(), llvm::DwarfCompileUnit::constructInlinedScopeDIE(), llvm::DwarfCompileUnit::constructLabelDIE(), llvm::DwarfCompileUnit::constructLexicalScopeDIE(), llvm::DwarfCompileUnit::constructSubprogramScopeDIE(), llvm::DwarfUnit::createAndAddDIE(), and llvm::DwarfCompileUnit::createBaseTypeDIEs().

◆ getAbbrevNumber()

unsigned llvm::DIE::getAbbrevNumber ( ) const

inline

Definition at line 781 of file DIE.h.

Referenced by computeOffsetsAndAbbrevs(), and llvm::AsmPrinter::emitDwarfDIE().

◆ getDebugSectionOffset()

uint64_t DIE::getDebugSectionOffset ( ) const

Get the absolute offset within the .debug_info or .debug_types section for this DIE.

Definition at line 189 of file DIE.cpp.

References assert(), getOffset(), and getUnit().

Referenced by llvm::AppleAccelTableOffsetData::emit(), llvm::AppleAccelTableTypeData::emit(), and llvm::DIEEntry::emitValue().

◆ getOffset()

unsigned llvm::DIE::getOffset ( ) const

inline

Get the compile/type unit relative offset of this DIE.

Definition at line 784 of file DIE.h.

References assert(), and Offset.

Referenced by computeOffsetsAndAbbrevs(), llvm::AsmPrinter::emitDwarfDIE(), llvm::DIEEntry::emitValue(), llvm::CompileUnit::fixupForwardReferences(), getDebugSectionOffset(), llvm::DWARFUnit::getDIEIndexForOffset(), llvm::DWARF5AccelTableData::getDieOffset(), llvm::DWARF5AccelTableData::order(), llvm::AppleAccelTableOffsetData::order(), and llvm::DIEEntry::sizeOf().

◆ getParent()

DIE * DIE::getParent ( ) const

Definition at line 176 of file DIE.cpp.

Referenced by addChild(), addChildFront(), and llvm::DIEHash::computeTypeSignature().

◆ getSize()

unsigned llvm::DIE::getSize ( ) const

inline

Definition at line 789 of file DIE.h.

References assert(), and Size.

Referenced by llvm::DwarfStreamer::emitDIE(), llvm::AsmPrinter::emitDwarfDIE(), llvm::DwarfStreamer::emitPaperTrailWarningsDie(), and llvm::DwarfCompileUnit::getLength().

◆ getTag()

dwarf::Tag llvm::DIE::getTag ( ) const

inline

Definition at line 782 of file DIE.h.

Referenced by computeIndexValue(), llvm::DwarfUnit::constructTypeDIE(), llvm::AppleAccelTableTypeData::emit(), llvm::AsmPrinter::emitDwarfDIE(), llvm::DeclContextTree::getChildDeclContext(), llvm::DWARFContext::getDIEsForAddress(), llvm::DWARF5AccelTableData::getDieTag(), getNames(), llvm::DwarfUnit::getOrCreateStaticMemberDIE(), llvm::CompileUnit::markEverythingAsKept(), llvm::CompileUnit::noteRangeAttribute(), and print().

◆ getUnit()

DIEUnit * DIE::getUnit ( ) const

Climb up the parent chain to get the compile unit or type unit that this DIE belongs to.

Returns: the DIEUnit that represents the compile or type unit that owns this DIE, or NULL if this DIE hasn't been added to a unit DIE.

Definition at line 207 of file DIE.cpp.

References getUnitDie().

Referenced by llvm::DwarfUnit::addDIEEntry(), llvm::DwarfCompileUnit::constructSubprogramScopeDIE(), llvm::DIEEntry::emitValue(), getDebugSectionOffset(), llvm::DwarfUnit::getOrCreateSubprogramDIE(), llvm::DwarfUnit::getOrCreateTypeDIE(), and llvm::DwarfCompileUnit::updateSubprogramScopeDIE().

◆ getUnitDie()

const DIE * DIE::getUnitDie ( ) const

Climb up the parent chain to get the compile unit or type unit DIE that this DIE belongs to.

Returns: the compile or type unit DIE that owns this DIE, or NULL if this DIE hasn't been added to a unit DIE.

Definition at line 195 of file DIE.cpp.

Referenced by llvm::DwarfCompileUnit::constructAbstractSubprogramScopeDIE(), and getUnit().

◆ hasChildren()

bool llvm::DIE::hasChildren ( ) const

inline

Definition at line 794 of file DIE.h.

Referenced by computeOffsetsAndAbbrevs(), llvm::AsmPrinter::emitDwarfDIE(), generateAbbrev(), llvm::DwarfUnit::hasContent(), and print().

◆ operator=() [1/2]

DIE & llvm::DIE::operator= ( const DIE && RHS )

delete

◆ operator=() [2/2]

DIE & llvm::DIE::operator= ( const DIE & RHS )

delete

◆ print()

LLVM_DUMP_METHOD void DIE::print	(	raw_ostream &	O,
		unsigned	IndentCount = `0`
	)		const

Definition at line 240 of file DIE.cpp.

References llvm::dwarf::AttributeString(), children(), llvm::dwarf::ChildrenString(), llvm::format(), llvm::dwarf::FormEncodingString(), getTag(), hasChildren(), llvm::dwarf::TagString(), and llvm::DIEValueList::values().

Referenced by dump().

◆ setAbbrevNumber()

void llvm::DIE::setAbbrevNumber ( unsigned I )

inline

Set the abbreviation number for this DIE.

Definition at line 818 of file DIE.h.

References I.

Referenced by llvm::DIEAbbrevSet::uniqueAbbreviation().

◆ setForceChildren()

void llvm::DIE::setForceChildren ( bool B )

inline

Definition at line 795 of file DIE.h.

References B.

◆ setOffset()

void llvm::DIE::setOffset ( unsigned O )

inline

Definition at line 857 of file DIE.h.

References Offset.

Referenced by computeOffsetsAndAbbrevs().

◆ setSize()

void llvm::DIE::setSize ( unsigned S )

inline

Definition at line 858 of file DIE.h.

References Size.

Referenced by computeOffsetsAndAbbrevs().

Friends And Related Function Documentation

◆ DIEUnit

friend class DIEUnit

friend

Definition at line 748 of file DIE.h.

◆ IntrusiveBackList< DIE >

friend class IntrusiveBackList< DIE >

friend

Definition at line 714 of file DIE.h.

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

include/llvm/CodeGen/DIE.h
lib/CodeGen/AsmPrinter/DIE.cpp

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ child_iterator

◆ child_range

◆ const_child_iterator

◆ const_child_range

Constructor & Destructor Documentation

◆ DIE() [1/3]

◆ DIE() [2/3]

◆ DIE() [3/3]

Member Function Documentation

◆ addChild()

◆ addChildFront()

◆ children() [1/2]

◆ children() [2/2]

◆ computeOffsetsAndAbbrevs()

◆ dump()

◆ findAttribute()

◆ generateAbbrev()

◆ get()

◆ getAbbrevNumber()

◆ getDebugSectionOffset()

◆ getOffset()

◆ getParent()

◆ getSize()

◆ getTag()

◆ getUnit()

◆ getUnitDie()

◆ hasChildren()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ print()

◆ setAbbrevNumber()

◆ setForceChildren()

◆ setOffset()

◆ setSize()

Friends And Related Function Documentation

◆ DIEUnit

◆ IntrusiveBackList< DIE >