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
LLVM_ABI DIE *	getParent () const
LLVM_ABI DIEAbbrev	generateAbbrev () const
	Generate the abbreviation for this DIE.
void	setAbbrevNumber (unsigned I)
	Set the abbreviation number for this DIE.
LLVM_ABI uint64_t	getDebugSectionOffset () const
	Get the absolute offset within the .debug_info or .debug_types section for this DIE.
LLVM_ABI unsigned	computeOffsetsAndAbbrevs (const dwarf::FormParams &FormParams, DIEAbbrevSet &AbbrevSet, unsigned CUOffset)
	Compute the offset of this DIE and all its children.
LLVM_ABI const DIE *	getUnitDie () const
	Climb up the parent chain to get the compile unit or type unit DIE that this DIE belongs to.
LLVM_ABI 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)
LLVM_ABI DIEValue	findAttribute (dwarf::Attribute Attribute) const
	Find a value in the DIE with the attribute given.
LLVM_ABI void	print (raw_ostream &O, unsigned IndentCount=0) const
LLVM_ABI 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)
template<class T>
bool	replaceValue (BumpPtrAllocator &Alloc, dwarf::Attribute Attribute, dwarf::Attribute NewAttribute, dwarf::Form Form, T &&NewValue)
template<class T>
bool	replaceValue (BumpPtrAllocator &Alloc, dwarf::Attribute Attribute, dwarf::Form Form, T &&NewValue)
bool	replaceValue (BumpPtrAllocator &Alloc, dwarf::Attribute Attribute, dwarf::Form Form, DIEValue &NewValue)
bool	deleteValue (dwarf::Attribute Attribute)
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 842 of file DIE.h.

Member Typedef Documentation

◆ child_iterator

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

Definition at line 893 of file DIE.h.

◆ child_range

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

Definition at line 895 of file DIE.h.

◆ const_child_iterator

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

Definition at line 894 of file DIE.h.

◆ const_child_range

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

Definition at line 896 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

References RHS.

◆ DIE() [3/3]

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

delete

References RHS.

Member Function Documentation

◆ addChild()

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

inline

Add a child to the DIE.

Definition at line 958 of file DIE.h.

References assert(), and getParent().

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

◆ addChildFront()

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

inline

Definition at line 965 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 898 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 901 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 265 of file DIE.cpp.

References assert(), children(), getAbbrevNumber(), getOffset(), llvm::getULEB128Size(), hasChildren(), llvm::DIEAbbrev::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 260 of file DIE.cpp.

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

Referenced by dumpKeptDIE().

◆ 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 209 of file DIE.cpp.

References llvm::DIEValueList::values().

Referenced by llvm::DwarfCompileUnit::addLinkageNamesToDeclarations(), computeIndexValue(), and llvm::DWARF5AccelTableData::getDefiningParentDieOffset().

◆ 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 173 of file DIE.cpp.

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

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

◆ get()

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

inlinestatic

Definition at line 872 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::constructSubprogramScopeDIE(), llvm::DwarfCompileUnit::constructVariableDIE(), llvm::DwarfUnit::createAndAddDIE(), llvm::DwarfCompileUnit::createBaseTypeDIEs(), llvm::dwarf_linker::parallel::DIEGenerator::createDIE(), and llvm::DwarfCompileUnit::getOrCreateLexicalBlockDIE().

◆ getAbbrevNumber()

unsigned llvm::DIE::getAbbrevNumber ( ) const

inline

Definition at line 877 of file DIE.h.

Referenced by computeOffsetsAndAbbrevs(), llvm::dwarf_linker::parallel::TypeUnit::createDIETree(), 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 184 of file DIE.cpp.

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

◆ getOffset()

unsigned llvm::DIE::getOffset ( ) const

inline

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

Definition at line 880 of file DIE.h.

References assert().

Referenced by llvm::dwarf_linker::parallel::OutputSections::applyPatches(), computeOffsetsAndAbbrevs(), llvm::dwarf_linker::parallel::TypeUnit::createDIETree(), llvm::AsmPrinter::emitDwarfDIE(), llvm::dwarf_linker::classic::CompileUnit::fixupForwardReferences(), getDebugSectionOffset(), llvm::DWARFUnit::getDIEIndexForOffset(), llvm::dwarf_linker::AddressesMap::getVariableRelocAdjustment(), llvm::dwarf_linker::parallel::AcceleratorRecordsSaver::saveNameRecord(), llvm::dwarf_linker::parallel::AcceleratorRecordsSaver::saveNamespaceRecord(), llvm::dwarf_linker::parallel::AcceleratorRecordsSaver::saveObjCNameRecord(), and llvm::dwarf_linker::parallel::AcceleratorRecordsSaver::saveTypeRecord().

◆ getParent()

DIE * DIE::getParent ( ) const

Definition at line 171 of file DIE.cpp.

References llvm::dyn_cast_if_present().

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

◆ getSize()

unsigned llvm::DIE::getSize ( ) const

inline

Definition at line 885 of file DIE.h.

References assert().

Referenced by llvm::dwarf_linker::classic::DwarfStreamer::emitDIE(), llvm::dwarf_linker::parallel::DwarfEmitterImpl::emitDIE(), llvm::AsmPrinter::emitDwarfDIE(), and llvm::DwarfCompileUnit::getLength().

◆ getTag()

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

inline

Definition at line 878 of file DIE.h.

Referenced by computeIndexValue(), llvm::DwarfUnit::constructTypeDIE(), llvm::AsmPrinter::emitDwarfDIE(), llvm::dwarf_linker::classic::DeclContextTree::getChildDeclContext(), llvm::DWARFContext::getDIEsForAddress(), getNames(), llvm::DwarfUnit::getOrCreateStaticMemberDIE(), llvm::dwarf_linker::AddressesMap::getVariableRelocAdjustment(), llvm::dwarf_linker::parallel::DependencyTracker::isLiveSubprogramEntry(), llvm::dwarf_linker::classic::CompileUnit::markEverythingAsKept(), llvm::dwarf_linker::classic::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 202 of file DIE.cpp.

References DIEUnit, llvm::dyn_cast_if_present(), and getUnitDie().

Referenced by llvm::DwarfUnit::addDIEEntry(), getDebugSectionOffset(), llvm::DwarfUnit::getOrCreateStaticMemberDIE(), llvm::DwarfUnit::getOrCreateSubprogramDIE(), and llvm::DwarfUnit::getOrCreateTypeDIE().

◆ 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 190 of file DIE.cpp.

Referenced by getUnit().

◆ hasChildren()

bool llvm::DIE::hasChildren ( ) const

inline

Definition at line 890 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

References RHS.

◆ operator=() [2/2]

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

delete

References RHS.

◆ print()

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

Definition at line 235 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 914 of file DIE.h.

References I.

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

◆ setForceChildren()

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

inline

Definition at line 891 of file DIE.h.

References B().

◆ setOffset()

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

inline

Definition at line 954 of file DIE.h.

Referenced by computeOffsetsAndAbbrevs(), and llvm::dwarf_linker::parallel::TypeUnit::createDIETree().

◆ setSize()

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

inline

Definition at line 955 of file DIE.h.

Referenced by computeOffsetsAndAbbrevs(), and llvm::dwarf_linker::parallel::TypeUnit::createDIETree().

◆ DIEUnit

friend class DIEUnit

friend

Definition at line 844 of file DIE.h.

References DIEUnit.

Referenced by DIEUnit, getDebugSectionOffset(), and getUnit().

◆ IntrusiveBackList< DIE >

friend class IntrusiveBackList< DIE >

friend

Definition at line 757 of file DIE.h.

References llvm::iterator_adaptor_base< const_value_iterator, ListTy::const_iterator, std::forward_iterator_tag, const DIEValue >::wrapped().

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 Symbol Documentation

◆ DIEUnit

◆ IntrusiveBackList< DIE >