LLVM  6.0.0svn
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
llvm::DIE Class Reference

A structured debug information entry. More...

#include "llvm/CodeGen/DIE.h"

Inheritance diagram for llvm::DIE:
Inheritance graph
[legend]
Collaboration diagram for llvm::DIE:
Collaboration graph
[legend]

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
 
DIEoperator= (const DIE &RHS)=delete
 
DIEoperator= (const DIE &&RHS)=delete
 
unsigned getAbbrevNumber () const
 
dwarf::Tag getTag () const
 
unsigned getOffset () const
 Get the compile/type unit relative offset of this DIE. More...
 
unsigned getSize () const
 
bool hasChildren () const
 
void setForceChildren (bool B)
 
child_range children ()
 
const_child_range children () const
 
DIEgetParent () const
 
DIEAbbrev generateAbbrev () const
 Generate the abbreviation for this DIE. More...
 
void setAbbrevNumber (unsigned I)
 Set the abbreviation number for this DIE. More...
 
unsigned getDebugSectionOffset () const
 Get the absolute offset within the .debug_info or .debug_types section for this DIE. More...
 
unsigned computeOffsetsAndAbbrevs (const AsmPrinter *AP, DIEAbbrevSet &AbbrevSet, unsigned CUOffset)
 Compute the offset of this DIE and all its children. More...
 
const DIEgetUnitDie () const
 Climb up the parent chain to get the compile unit or type unit DIE that this DIE belongs to. More...
 
const DIEUnitgetUnit () const
 Climb up the parent chain to get the compile unit or type unit that this DIE belongs to. More...
 
void setOffset (unsigned O)
 
void setSize (unsigned S)
 
DIEaddChild (DIE *Child)
 Add a child to the DIE. More...
 
DIEValue findAttribute (dwarf::Attribute Attribute) const
 Find a value in the DIE with the attribute given. More...
 
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)
 
value_range values ()
 
const_value_range values () const
 

Static Public Member Functions

static DIEget (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 662 of file DIE.h.

Member Typedef Documentation

◆ child_iterator

Definition at line 705 of file DIE.h.

◆ child_range

Definition at line 707 of file DIE.h.

◆ const_child_iterator

Definition at line 706 of file DIE.h.

◆ const_child_range

Definition at line 708 of file DIE.h.

Constructor & Destructor Documentation

◆ DIE() [1/3]

llvm::DIE::DIE ( )
delete

◆ 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

◆ children() [1/2]

child_range llvm::DIE::children ( )
inline

◆ children() [2/2]

const_child_range llvm::DIE::children ( ) const
inline

◆ computeOffsetsAndAbbrevs()

unsigned DIE::computeOffsetsAndAbbrevs ( const AsmPrinter AP,
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
APAsmPrinter to use when calculating sizes.
AbbrevSetthe abbreviation used to unique DIE abbreviations.
CUOffsetthe 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 276 of file DIE.cpp.

References assert(), llvm::children(), llvm::getOffset(), llvm::getULEB128Size(), llvm::DIEAbbrev::hasChildren(), llvm::DIEAbbrevSet::uniqueAbbreviation(), and llvm::cl::values().

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

◆ dump()

LLVM_DUMP_METHOD void DIE::dump ( ) const

Definition at line 271 of file DIE.cpp.

References llvm::dbgs().

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

References LLVM_DUMP_METHOD, and llvm::cl::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 185 of file DIE.cpp.

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

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

◆ get()

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

◆ getAbbrevNumber()

unsigned llvm::DIE::getAbbrevNumber ( ) const
inline

Definition at line 697 of file DIE.h.

Referenced by llvm::AsmPrinter::emitDwarfDIE().

◆ getDebugSectionOffset()

unsigned DIE::getDebugSectionOffset ( ) const

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

Definition at line 196 of file DIE.cpp.

References assert(), llvm::DIEUnit::getDebugSectionOffset(), and llvm::getOffset().

Referenced by llvm::DwarfAccelTable::FinalizeTable().

◆ getOffset()

unsigned llvm::DIE::getOffset ( ) const
inline

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

Definition at line 700 of file DIE.h.

Referenced by compareDIEs(), computeIndexValue(), llvm::AsmPrinter::emitDwarfDIE(), llvm::DwarfTypeUnit::emitHeader(), and llvm::DwarfAccelTable::HashDataContents::print().

◆ getParent()

DIE * DIE::getParent ( ) const

◆ getSize()

unsigned llvm::DIE::getSize ( ) const
inline

◆ getTag()

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

◆ getUnit()

const 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 213 of file DIE.cpp.

Referenced by llvm::DwarfUnit::addDIEEntry().

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

References getParent(), and getTag().

Referenced by llvm::DwarfDebug::addDwarfTypeUnitType(), llvm::DwarfDebug::beginModule(), and llvm::DwarfDebug::hasDwarfPubSections().

◆ hasChildren()

bool llvm::DIE::hasChildren ( ) const
inline

Definition at line 702 of file DIE.h.

References llvm::IntrusiveBackListBase::empty().

Referenced by llvm::AsmPrinter::emitDwarfDIE().

◆ 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

◆ setAbbrevNumber()

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

Set the abbreviation number for this DIE.

Definition at line 726 of file DIE.h.

References I.

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

◆ setForceChildren()

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

Definition at line 703 of file DIE.h.

References B.

◆ setOffset()

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

Definition at line 765 of file DIE.h.

◆ setSize()

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

Definition at line 766 of file DIE.h.

Friends And Related Function Documentation

◆ DIEUnit

friend class DIEUnit
friend

Definition at line 664 of file DIE.h.

◆ IntrusiveBackList< DIE >

friend class IntrusiveBackList< DIE >
friend

Definition at line 663 of file DIE.h.


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