LLVM  7.0.0svn
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
llvm::DWARFUnit Class Reference

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

Inheritance diagram for llvm::DWARFUnit:
Inheritance graph
[legend]

Public Member Functions

 DWARFUnit (DWARFContext &Context, const DWARFSection &Section, const DWARFUnitHeader &Header, const DWARFDebugAbbrev *DA, const DWARFSection *RS, StringRef SS, const DWARFSection &SOS, const DWARFSection *AOS, const DWARFSection &LS, bool LE, bool IsDWO, const DWARFUnitSectionBase &UnitSection)
 
virtual ~DWARFUnit ()
 
DWARFContextgetContext () const
 
uint32_t getOffset () const
 
const dwarf::FormParamsgetFormParams () const
 
uint16_t getVersion () const
 
uint8_t getAddressByteSize () const
 
uint8_t getRefAddrByteSize () const
 
uint8_t getDwarfOffsetByteSize () const
 
uint32_t getLength () const
 
uint8_t getUnitType () const
 
uint32_t getNextUnitOffset () const
 
const DWARFSectiongetLineSection () const
 
StringRef getStringSection () const
 
const DWARFSectiongetStringOffsetSection () const
 
void setAddrOffsetSection (const DWARFSection *AOS, uint32_t Base)
 
void updateAddressDieMap (DWARFDie Die)
 Recursively update address to Die map. More...
 
void setRangesSection (const DWARFSection *RS, uint32_t Base)
 
bool getAddrOffsetSectionItem (uint32_t Index, uint64_t &Result) const
 
bool getStringOffsetSectionItem (uint32_t Index, uint64_t &Result) const
 
DWARFDataExtractor getDebugInfoExtractor () const
 
DataExtractor getStringExtractor () const
 
bool extractRangeList (uint32_t RangeListOffset, DWARFDebugRangeList &RangeList) const
 extractRangeList - extracts the range list referenced by this compile unit from .debug_ranges section. More...
 
void clear ()
 
const Optional< StrOffsetsContributionDescriptor > & getStringOffsetsTableContribution () const
 
uint8_t getDwarfStringOffsetsByteSize () const
 
uint64_t getStringOffsetsBase () const
 
const DWARFAbbreviationDeclarationSetgetAbbreviations () const
 
llvm::Optional< BaseAddressgetBaseAddress ()
 
DWARFDie getUnitDIE (bool ExtractUnitDIEOnly=true)
 
const chargetCompilationDir ()
 
Optional< uint64_t > getDWOId ()
 
DWARFAddressRangesVector findRnglistFromOffset (uint32_t Offset)
 Return a vector of address ranges resulting from a (possibly encoded) range list starting at a given offset in the appropriate ranges section. More...
 
DWARFAddressRangesVector findRnglistFromIndex (uint32_t Index)
 Return a vector of address ranges retrieved from an encoded range list whose offset is found via a table lookup given an index (DWARF v5 and later). More...
 
Optional< uint32_tgetRnglistOffset (uint32_t Index)
 Return a rangelist's offset based on an index. More...
 
void collectAddressRanges (DWARFAddressRangesVector &CURanges)
 
DWARFDie getSubroutineForAddress (uint64_t Address)
 Returns subprogram DIE with address range encompassing the provided address. More...
 
void getInlinedChainForAddress (uint64_t Address, SmallVectorImpl< DWARFDie > &InlinedChain)
 getInlinedChainForAddress - fetches inlined chain for a given address. More...
 
const DWARFUnitSectionBasegetUnitSection () const
 getUnitSection - Return the DWARFUnitSection containing this unit. More...
 
unsigned getNumDIEs ()
 Returns the number of DIEs in the unit. More...
 
uint32_t getDIEIndex (const DWARFDie &D)
 Return the index of a DIE inside the unit's DIE vector. More...
 
DWARFDie getDIEAtIndex (unsigned Index)
 Return the DIE object at the given index. More...
 
DWARFDie getParent (const DWARFDebugInfoEntry *Die)
 
DWARFDie getSibling (const DWARFDebugInfoEntry *Die)
 
DWARFDie getFirstChild (const DWARFDebugInfoEntry *Die)
 
DWARFDie getDIEForOffset (uint32_t Offset)
 Return the DIE object for a given offset inside the unit's DIE vector. More...
 
uint32_t getLineTableOffset () const
 
die_iterator_range dies ()
 

Static Public Member Functions

static bool isMatchingUnitTypeAndTag (uint8_t UnitType, dwarf::Tag Tag)
 
static uint32_t getDWARF5HeaderSize (uint8_t UnitType)
 Return the number of bytes for the header of a unit of UnitType type. More...
 

Protected Member Functions

const DWARFUnitHeadergetHeader () const
 
virtual uint32_t getHeaderSize () const
 Size in bytes of the unit header. More...
 
Optional< StrOffsetsContributionDescriptordetermineStringOffsetsTableContribution (DWARFDataExtractor &DA, uint64_t Offset)
 Find the unit's contribution to the string offsets table and determine its length and form. More...
 
Optional< StrOffsetsContributionDescriptordetermineStringOffsetsTableContributionDWO (DWARFDataExtractor &DA, uint64_t Offset)
 Find the unit's contribution to the string offsets table and determine its length and form. More...
 

Detailed Description

Definition at line 243 of file DWARFUnit.h.

Constructor & Destructor Documentation

◆ DWARFUnit()

DWARFUnit::DWARFUnit ( DWARFContext Context,
const DWARFSection Section,
const DWARFUnitHeader Header,
const DWARFDebugAbbrev DA,
const DWARFSection RS,
StringRef  SS,
const DWARFSection SOS,
const DWARFSection AOS,
const DWARFSection LS,
bool  LE,
bool  IsDWO,
const DWARFUnitSectionBase UnitSection 
)

Definition at line 51 of file DWARFUnit.cpp.

References clear(), and ~DWARFUnit().

◆ ~DWARFUnit()

DWARFUnit::~DWARFUnit ( )
virtualdefault

Referenced by DWARFUnit().

Member Function Documentation

◆ clear()

void DWARFUnit::clear ( )

Definition at line 187 of file DWARFUnit.cpp.

Referenced by DWARFUnit().

◆ collectAddressRanges()

void DWARFUnit::collectAddressRanges ( DWARFAddressRangesVector CURanges)

◆ determineStringOffsetsTableContribution()

Optional< StrOffsetsContributionDescriptor > DWARFUnit::determineStringOffsetsTableContribution ( DWARFDataExtractor DA,
uint64_t  Offset 
)
protected

Find the unit's contribution to the string offsets table and determine its length and form.

The given offset is expected to be derived from the unit DIE's DW_AT_str_offsets_base attribute.

Definition at line 641 of file DWARFUnit.cpp.

References parseDWARF32StringOffsetsTableHeader(), parseDWARF64StringOffsetsTableHeader(), and llvm::StrOffsetsContributionDescriptor::validateContributionSize().

Referenced by getDWOId().

◆ determineStringOffsetsTableContributionDWO()

Optional< StrOffsetsContributionDescriptor > DWARFUnit::determineStringOffsetsTableContributionDWO ( DWARFDataExtractor DA,
uint64_t  Offset 
)
protected

Find the unit's contribution to the string offsets table and determine its length and form.

The given offset is expected to be 0 in a dwo file or, in a dwp file, the start of the unit's contribution to the string offsets table section (as determined by the index table).

Definition at line 655 of file DWARFUnit.cpp.

References C, llvm::DWARFSection::Data, llvm::DW_SECT_STR_OFFSETS, llvm::dwarf::DWARF32, llvm::DWARFUnitHeader::getIndexEntry(), getVersion(), parseDWARF32StringOffsetsTableHeader(), parseDWARF64StringOffsetsTableHeader(), llvm::StringRef::size(), and llvm::AMDGPU::HSAMD::Kernel::Arg::Key::Size.

Referenced by getDWOId().

◆ dies()

die_iterator_range llvm::DWARFUnit::dies ( )
inline

Definition at line 520 of file DWARFUnit.h.

References llvm::DWARFUnitHeader::getLength().

◆ extractRangeList()

bool DWARFUnit::extractRangeList ( uint32_t  RangeListOffset,
DWARFDebugRangeList RangeList 
) const

extractRangeList - extracts the range list referenced by this compile unit from .debug_ranges section.

Returns true on success. Requires that compile unit is already extracted.

Definition at line 177 of file DWARFUnit.cpp.

References assert(), llvm::DWARFDebugRangeList::extract(), getAddressByteSize(), and llvm::DWARFContext::getDWARFObj().

Referenced by findRnglistFromOffset().

◆ findRnglistFromIndex()

DWARFAddressRangesVector DWARFUnit::findRnglistFromIndex ( uint32_t  Index)

Return a vector of address ranges retrieved from an encoded range list whose offset is found via a table lookup given an index (DWARF v5 and later).

Definition at line 411 of file DWARFUnit.cpp.

References findRnglistFromOffset(), and getRnglistOffset().

◆ findRnglistFromOffset()

DWARFAddressRangesVector DWARFUnit::findRnglistFromOffset ( uint32_t  Offset)

Return a vector of address ranges resulting from a (possibly encoded) range list starting at a given offset in the appropriate ranges section.

Definition at line 395 of file DWARFUnit.cpp.

References extractRangeList(), llvm::DWARFDebugRangeList::getAbsoluteRanges(), getBaseAddress(), llvm::DWARFContext::getDWARFObj(), and getVersion().

Referenced by findRnglistFromIndex().

◆ getAbbreviations()

const DWARFAbbreviationDeclarationSet * DWARFUnit::getAbbreviations ( ) const

◆ getAddressByteSize()

uint8_t llvm::DWARFUnit::getAddressByteSize ( ) const
inline

◆ getAddrOffsetSectionItem()

bool DWARFUnit::getAddrOffsetSectionItem ( uint32_t  Index,
uint64_t &  Result 
) const

◆ getBaseAddress()

llvm::Optional< BaseAddress > DWARFUnit::getBaseAddress ( )

◆ getCompilationDir()

const char * DWARFUnit::getCompilationDir ( )

◆ getContext()

DWARFContext& llvm::DWARFUnit::getContext ( ) const
inline

Definition at line 320 of file DWARFUnit.h.

References Context.

Referenced by dumpAttribute(), dumpLocation(), and llvm::DWARFFormValue::extractValue().

◆ getDebugInfoExtractor()

DWARFDataExtractor DWARFUnit::getDebugInfoExtractor ( ) const

◆ getDIEAtIndex()

DWARFDie llvm::DWARFUnit::getDIEAtIndex ( unsigned  Index)
inline

Return the DIE object at the given index.

Definition at line 487 of file DWARFUnit.h.

References assert(), and getParent().

Referenced by llvm::DWARFVerifier::DieRangeInfo::intersects().

◆ getDIEForOffset()

DWARFDie llvm::DWARFUnit::getDIEForOffset ( uint32_t  Offset)
inline

Return the DIE object for a given offset inside the unit's DIE vector.

The unit needs to have its DIEs extracted for this method to work.

Definition at line 500 of file DWARFUnit.h.

References assert(), and llvm::lower_bound().

Referenced by llvm::DWARFTypeUnit::dump().

◆ getDIEIndex()

uint32_t llvm::DWARFUnit::getDIEIndex ( const DWARFDie D)
inline

Return the index of a DIE inside the unit's DIE vector.

It is illegal to call this method with a DIE that hasn't be created by this unit. In other word, it's illegal to call this method on a DIE that isn't accessible by following children/sibling links starting from this unit's getUnitDIE().

Definition at line 482 of file DWARFUnit.h.

References llvm::DWARFDie::getDebugInfoEntry().

◆ getDWARF5HeaderSize()

static uint32_t llvm::DWARFUnit::getDWARF5HeaderSize ( uint8_t  UnitType)
inlinestatic

Return the number of bytes for the header of a unit of UnitType type.

This function must be called with a valid unit type which in DWARF5 is defined as one of the following six types.

Definition at line 408 of file DWARFUnit.h.

References llvm_unreachable.

◆ getDwarfOffsetByteSize()

uint8_t llvm::DWARFUnit::getDwarfOffsetByteSize ( ) const
inline

◆ getDwarfStringOffsetsByteSize()

uint8_t llvm::DWARFUnit::getDwarfStringOffsetsByteSize ( ) const
inline

Definition at line 374 of file DWARFUnit.h.

References assert().

Referenced by getStringOffsetSectionItem().

◆ getDWOId()

Optional< uint64_t > DWARFUnit::getDWOId ( )

◆ getFirstChild()

DWARFDie DWARFUnit::getFirstChild ( const DWARFDebugInfoEntry Die)

Definition at line 560 of file DWARFUnit.cpp.

References llvm::DWARFDebugInfoEntry::hasChildren(), and I.

◆ getFormParams()

const dwarf::FormParams& llvm::DWARFUnit::getFormParams ( ) const
inline

◆ getHeader()

const DWARFUnitHeader& llvm::DWARFUnit::getHeader ( ) const
inlineprotected

◆ getHeaderSize()

virtual uint32_t llvm::DWARFUnit::getHeaderSize ( ) const
inlineprotectedvirtual

Size in bytes of the unit header.

Reimplemented in llvm::DWARFTypeUnit.

Definition at line 293 of file DWARFUnit.h.

References llvm::DWARFUnitHeader::getVersion(), llvm::AArch64CC::LE, llvm::AArch64CC::LS, and llvm::ARMBuildAttrs::Section.

Referenced by getDWOId(), and llvm::DWARFTypeUnit::getHeaderSize().

◆ getInlinedChainForAddress()

void DWARFUnit::getInlinedChainForAddress ( uint64_t  Address,
SmallVectorImpl< DWARFDie > &  InlinedChain 
)

getInlinedChainForAddress - fetches inlined chain for a given address.

Returns empty chain if there is no subprogram containing address. The chain is valid as long as parsed compile unit DIEs are not cleared.

Definition at line 492 of file DWARFUnit.cpp.

References assert(), llvm::SmallVectorBase::empty(), llvm::DWARFDie::getParent(), getSubroutineForAddress(), llvm::DWARFDie::getTag(), llvm::DWARFDie::isSubprogramDIE(), and llvm::SmallVectorTemplateBase< T, isPodLike< T >::value >::push_back().

Referenced by getFunctionNameAndStartLineForAddress(), and llvm::DWARFContext::getInliningInfoForAddress().

◆ getLength()

uint32_t llvm::DWARFUnit::getLength ( ) const
inline

◆ getLineSection()

const DWARFSection& llvm::DWARFUnit::getLineSection ( ) const
inline

Definition at line 334 of file DWARFUnit.h.

Referenced by llvm::DWARFContext::getLineTableForUnit().

◆ getLineTableOffset()

uint32_t llvm::DWARFUnit::getLineTableOffset ( ) const
inline

◆ getNextUnitOffset()

uint32_t llvm::DWARFUnit::getNextUnitOffset ( ) const
inline

◆ getNumDIEs()

unsigned llvm::DWARFUnit::getNumDIEs ( )
inline

Returns the number of DIEs in the unit.

Parses the unit if necessary.

Definition at line 471 of file DWARFUnit.h.

Referenced by llvm::DWARFVerifier::DieRangeInfo::intersects().

◆ getOffset()

uint32_t llvm::DWARFUnit::getOffset ( ) const
inline

◆ getParent()

DWARFDie DWARFUnit::getParent ( const DWARFDebugInfoEntry Die)

Definition at line 521 of file DWARFUnit.cpp.

References llvm::Depth, llvm::DWARFDebugInfoEntry::getDepth(), getUnitDIE(), and I.

◆ getRefAddrByteSize()

uint8_t llvm::DWARFUnit::getRefAddrByteSize ( ) const
inline

◆ getRnglistOffset()

Optional<uint32_t> llvm::DWARFUnit::getRnglistOffset ( uint32_t  Index)
inline

Return a rangelist's offset based on an index.

The index designates an entry in the rangelist table's offset array and is supplied by DW_FORM_rnglistx.

Definition at line 447 of file DWARFUnit.h.

References llvm::Address, and llvm::None.

Referenced by dumpAttribute(), and findRnglistFromIndex().

◆ getSibling()

DWARFDie DWARFUnit::getSibling ( const DWARFDebugInfoEntry Die)

◆ getStringExtractor()

DataExtractor llvm::DWARFUnit::getStringExtractor ( ) const
inline

Definition at line 358 of file DWARFUnit.h.

References clear().

◆ getStringOffsetsBase()

uint64_t llvm::DWARFUnit::getStringOffsetsBase ( ) const
inline

Definition at line 379 of file DWARFUnit.h.

References assert().

Referenced by getStringOffsetSectionItem().

◆ getStringOffsetSection()

const DWARFSection& llvm::DWARFUnit::getStringOffsetSection ( ) const
inline

Definition at line 336 of file DWARFUnit.h.

◆ getStringOffsetSectionItem()

bool DWARFUnit::getStringOffsetSectionItem ( uint32_t  Index,
uint64_t &  Result 
) const

◆ getStringOffsetsTableContribution()

const Optional<StrOffsetsContributionDescriptor>& llvm::DWARFUnit::getStringOffsetsTableContribution ( ) const
inline

Definition at line 370 of file DWARFUnit.h.

◆ getStringSection()

StringRef llvm::DWARFUnit::getStringSection ( ) const
inline

Definition at line 335 of file DWARFUnit.h.

◆ getSubroutineForAddress()

DWARFDie DWARFUnit::getSubroutineForAddress ( uint64_t  Address)

Returns subprogram DIE with address range encompassing the provided address.

The pointer is alive as long as parsed compile unit DIEs are not cleared.

Definition at line 477 of file DWARFUnit.cpp.

References getUnitDIE(), and updateAddressDieMap().

Referenced by llvm::DWARFContext::getDIEsForAddress(), and getInlinedChainForAddress().

◆ getUnitDIE()

DWARFDie llvm::DWARFUnit::getUnitDIE ( bool  ExtractUnitDIEOnly = true)
inline

◆ getUnitSection()

const DWARFUnitSectionBase& llvm::DWARFUnit::getUnitSection ( ) const
inline

getUnitSection - Return the DWARFUnitSection containing this unit.

Definition at line 467 of file DWARFUnit.h.

◆ getUnitType()

uint8_t llvm::DWARFUnit::getUnitType ( ) const
inline

◆ getVersion()

uint16_t llvm::DWARFUnit::getVersion ( ) const
inline

◆ isMatchingUnitTypeAndTag()

static bool llvm::DWARFUnit::isMatchingUnitTypeAndTag ( uint8_t  UnitType,
dwarf::Tag  Tag 
)
inlinestatic

Definition at line 386 of file DWARFUnit.h.

References llvm::dwarf::isUnitType().

Referenced by llvm::DWARFVerifier::DieRangeInfo::intersects().

◆ setAddrOffsetSection()

void llvm::DWARFUnit::setAddrOffsetSection ( const DWARFSection AOS,
uint32_t  Base 
)
inline

Definition at line 340 of file DWARFUnit.h.

◆ setRangesSection()

void llvm::DWARFUnit::setRangesSection ( const DWARFSection RS,
uint32_t  Base 
)
inline

Definition at line 348 of file DWARFUnit.h.

Referenced by getDWOId().

◆ updateAddressDieMap()

void DWARFUnit::updateAddressDieMap ( DWARFDie  Die)

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