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
bool	isPlaceholder () const
	Returns true if DIE is a temporary placeholder.
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 unit DIE that this DIE belongs to.
LLVM_ABI DIEUnit *	getUnit () const
	Climb up the parent chain to get the 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 void	removeChild (DIE &Child)
	Remove `Child` from the children of this DIE.
LLVM_ABI void	takeChildren (DIE &Other, bool AtFront=false)
	Move all children of `Other` to this DIE, preserving their order.
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)
static DIE *	getPlaceholder (BumpPtrAllocator &Alloc)
	Create a temporary placeholder DIE.

Static Public Attributes
static constexpr dwarf::Tag	PlaceholderTag = dwarf::DW_TAG_null
	Internal tag for temporary containers.

Friends
class	IntrusiveBackList< DIE >
class	DIEUnit

Detailed Description

A structured debug information entry.

Has an abbreviation which describes its organization.

Definition at line 835 of file DIE.h.

Member Typedef Documentation

◆ child_iterator

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

Definition at line 897 of file DIE.h.

◆ child_range

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

Definition at line 899 of file DIE.h.

◆ const_child_iterator

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

Definition at line 898 of file DIE.h.

◆ const_child_range

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

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

References assert().

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 967 of file DIE.h.

References assert().

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

◆ children() [1/2]

child_range llvm::DIE::children ( )

inline

Definition at line 902 of file DIE.h.

References llvm::make_range().

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

◆ children() [2/2]

const_child_range llvm::DIE::children ( ) const

inline

Definition at line 905 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.