LLVM  13.0.0git
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
llvm::DWARFUnit Class Referenceabstract

#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, const DWARFSection *LocSection, StringRef SS, const DWARFSection &SOS, const DWARFSection *AOS, const DWARFSection &LS, bool LE, bool IsDWO, const DWARFUnitVector &UnitVector)
 
virtual ~DWARFUnit ()
 
bool isDWOUnit () const
 
DWARFContextgetContext () const
 
const DWARFSectiongetInfoSection () const
 
uint64_t getOffset () const
 
const dwarf::FormParamsgetFormParams () const
 
uint16_t getVersion () const
 
uint8_t getAddressByteSize () const
 
uint8_t getRefAddrByteSize () const
 
uint8_t getDwarfOffsetByteSize () const
 
uint64_t getLength () const
 
dwarf::DwarfFormat getFormat () const
 
uint8_t getUnitType () const
 
bool isTypeUnit () const
 
uint64_t getAbbrOffset () const
 
uint64_t getNextUnitOffset () const
 
const DWARFSectiongetLineSection () const
 
StringRef getStringSection () const
 
const DWARFSectiongetStringOffsetSection () const
 
void setAddrOffsetSection (const DWARFSection *AOS, uint64_t Base)
 
Optional< uint64_t > getAddrOffsetSectionBase () const
 
void updateAddressDieMap (DWARFDie Die)
 Recursively update address to Die map. More...
 
void setRangesSection (const DWARFSection *RS, uint64_t Base)
 
uint64_t getLocSectionBase () const
 
Optional< object::SectionedAddressgetAddrOffsetSectionItem (uint32_t Index) const
 
Optional< uint64_t > getStringOffsetSectionItem (uint32_t Index) const
 
DWARFDataExtractor getDebugInfoExtractor () const
 
DataExtractor getStringExtractor () const
 
const DWARFLocationTablegetLocationTable ()
 
Error extractRangeList (uint64_t RangeListOffset, DWARFDebugRangeList &RangeList) const
 Extract the range list referenced by this compile unit from the .debug_ranges section. More...
 
void clear ()
 
const Optional< StrOffsetsContributionDescriptor > & getStringOffsetsTableContribution () const
 
uint8_t getDwarfStringOffsetsByteSize () const
 
uint64_t getStringOffsetsBase () const
 
const DWARFAbbreviationDeclarationSetgetAbbreviations () const
 
llvm::Optional< object::SectionedAddressgetBaseAddress ()
 
DWARFDie getUnitDIE (bool ExtractUnitDIEOnly=true)
 
DWARFDie getNonSkeletonUnitDIE (bool ExtractUnitDIEOnly=true)
 
const char * getCompilationDir ()
 
Optional< uint64_t > getDWOId ()
 
void setDWOId (uint64_t NewID)
 
Expected< DWARFAddressRangesVectorfindRnglistFromOffset (uint64_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...
 
Expected< DWARFAddressRangesVectorfindRnglistFromIndex (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< uint64_t > getRnglistOffset (uint32_t Index)
 Return a rangelist's offset based on an index. More...
 
Optional< uint64_t > getLoclistOffset (uint32_t Index)
 
Expected< DWARFAddressRangesVectorcollectAddressRanges ()
 
Expected< DWARFLocationExpressionsVectorfindLoclistFromOffset (uint64_t Offset)
 
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 DWARFUnitVectorgetUnitVector () const
 Return the DWARFUnitVector 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 getPreviousSibling (const DWARFDebugInfoEntry *Die)
 
DWARFDie getFirstChild (const DWARFDebugInfoEntry *Die)
 
DWARFDie getLastChild (const DWARFDebugInfoEntry *Die)
 
DWARFDie getDIEForOffset (uint64_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 ()
 
virtual void dump (raw_ostream &OS, DIDumpOptions DumpOpts)=0
 
Error tryExtractDIEsIfNeeded (bool CUDieOnly)
 

Static Public Member Functions

static bool isMatchingUnitTypeAndTag (uint8_t UnitType, dwarf::Tag Tag)
 

Protected Member Functions

const DWARFUnitHeadergetHeader () const
 
uint32_t getHeaderSize () const
 Size in bytes of the parsed unit header. More...
 
Expected< Optional< StrOffsetsContributionDescriptor > > determineStringOffsetsTableContribution (DWARFDataExtractor &DA)
 Find the unit's contribution to the string offsets table and determine its length and form. More...
 
Expected< Optional< StrOffsetsContributionDescriptor > > determineStringOffsetsTableContributionDWO (DWARFDataExtractor &DA)
 Find the unit's contribution to the string offsets table and determine its length and form. More...
 

Detailed Description

Definition at line 203 of file DWARFUnit.h.

Constructor & Destructor Documentation

◆ DWARFUnit()

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

Definition at line 173 of file DWARFUnit.cpp.

References clear().

◆ ~DWARFUnit()

DWARFUnit::~DWARFUnit ( )
virtualdefault

Member Function Documentation

◆ clear()

void DWARFUnit::clear ( )

Definition at line 338 of file DWARFUnit.cpp.

References llvm::None.

Referenced by DWARFUnit().

◆ collectAddressRanges()

Expected< DWARFAddressRangesVector > DWARFUnit::collectAddressRanges ( )

◆ determineStringOffsetsTableContribution()

Expected< Optional< StrOffsetsContributionDescriptor > > DWARFUnit::determineStringOffsetsTableContribution ( DWARFDataExtractor DA)
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 891 of file DWARFUnit.cpp.

References assert(), llvm::M68kBeads::DA, llvm::find(), llvm::DWARFUnitHeader::getFormat(), getUnitDIE(), llvm::None, parseDWARFStringOffsetsTableHeader(), and llvm::dwarf::toSectionOffset().

Referenced by tryExtractDIEsIfNeeded().

◆ determineStringOffsetsTableContributionDWO()

Expected< Optional< StrOffsetsContributionDescriptor > > DWARFUnit::determineStringOffsetsTableContributionDWO ( DWARFDataExtractor DA)
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 904 of file DWARFUnit.cpp.

References assert(), llvm::M68kBeads::DA, llvm::DWARFSection::Data, llvm::dwarf::DWARF32, llvm::StringRef::empty(), llvm::DWARFUnitIndex::Entry::getContribution(), llvm::DWARFUnitHeader::getFormat(), llvm::DWARFUnitHeader::getIndexEntry(), getVersion(), llvm::None, Offset, parseDWARFStringOffsetsTableHeader(), llvm::StringRef::size(), and llvm::StrOffsetsContributionDescriptor::validateContributionSize().

Referenced by tryExtractDIEsIfNeeded().

◆ dies()

die_iterator_range llvm::DWARFUnit::dies ( )
inline

Definition at line 489 of file DWARFUnit.h.

◆ dump()

virtual void llvm::DWARFUnit::dump ( raw_ostream OS,
DIDumpOptions  DumpOpts 
)
pure virtual

◆ extractRangeList()

Error DWARFUnit::extractRangeList ( uint64_t  RangeListOffset,
DWARFDebugRangeList RangeList 
) const

Extract the range list referenced by this compile unit from the .debug_ranges section.

If the extraction is unsuccessful, an error is returned. Successful extraction requires that the compile unit has already been extracted.

Definition at line 328 of file DWARFUnit.cpp.

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

Referenced by findRnglistFromOffset().

◆ findLoclistFromOffset()

Expected< DWARFLocationExpressionsVector > DWARFUnit::findLoclistFromOffset ( uint64_t  Offset)

◆ findRnglistFromIndex()

Expected< 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 588 of file DWARFUnit.cpp.

References llvm::createStringError(), findRnglistFromOffset(), getRnglistOffset(), llvm::invalid_argument, and Offset.

◆ findRnglistFromOffset()

Expected< DWARFAddressRangesVector > DWARFUnit::findRnglistFromOffset ( uint64_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 571 of file DWARFUnit.cpp.

References Context, E, extractRangeList(), llvm::DWARFListTableBase< DWARFListType >::findList(), llvm::DWARFDebugRangeList::getAbsoluteRanges(), llvm::DWARFUnitHeader::getAddressByteSize(), getBaseAddress(), getVersion(), move, and Offset.

Referenced by findRnglistFromIndex().

◆ getAbbreviations()

const DWARFAbbreviationDeclarationSet * DWARFUnit::getAbbreviations ( ) const

◆ getAbbrOffset()

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

◆ getAddressByteSize()

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

◆ getAddrOffsetSectionBase()

Optional<uint64_t> llvm::DWARFUnit::getAddrOffsetSectionBase ( ) const
inline

Definition at line 310 of file DWARFUnit.h.

◆ getAddrOffsetSectionItem()

Optional< object::SectionedAddress > DWARFUnit::getAddrOffsetSectionItem ( uint32_t  Index) const

◆ getBaseAddress()

llvm::Optional< object::SectionedAddress > DWARFUnit::getBaseAddress ( )

◆ getCompilationDir()

const char * DWARFUnit::getCompilationDir ( )

Definition at line 348 of file DWARFUnit.cpp.

References llvm::find(), getUnitDIE(), and llvm::dwarf::toString().

◆ getContext()

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

Definition at line 281 of file DWARFUnit.h.

References Context.

Referenced by dumpLocation(), and llvm::DeclContextTree::getChildDeclContext().

◆ getDebugInfoExtractor()

DWARFDataExtractor DWARFUnit::getDebugInfoExtractor ( ) const

◆ getDIEAtIndex()

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

Return the DIE object at the given index.

Definition at line 456 of file DWARFUnit.h.

References assert(), and Index.

Referenced by llvm::inFunctionScope(), and llvm::CompileUnit::markEverythingAsKept().

◆ getDIEForOffset()

DWARFDie llvm::DWARFUnit::getDIEForOffset ( uint64_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 471 of file DWARFUnit.h.

References llvm::DIE::getOffset(), Offset, and llvm::partition_point().

Referenced by llvm::DWARFTypeUnit::dump(), llvm::prettyPrintBaseTypeRef(), and llvm::DWARFExpression::Operation::verify().

◆ 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 451 of file DWARFUnit.h.

References D.

◆ getDwarfOffsetByteSize()

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

Definition at line 290 of file DWARFUnit.h.

References llvm::DWARFUnitHeader::getDwarfOffsetByteSize().

◆ getDwarfStringOffsetsByteSize()

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

Definition at line 351 of file DWARFUnit.h.

References assert().

Referenced by getStringOffsetSectionItem().

◆ getDWOId()

Optional<uint64_t> llvm::DWARFUnit::getDWOId ( )
inline

Definition at line 397 of file DWARFUnit.h.

References llvm::DWARFUnitHeader::getDWOId(), and getHeader().

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

◆ getFirstChild()

DWARFDie DWARFUnit::getFirstChild ( const DWARFDebugInfoEntry Die)

Definition at line 769 of file DWARFUnit.cpp.

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

◆ getFormat()

dwarf::DwarfFormat llvm::DWARFUnit::getFormat ( ) const
inline

◆ getFormParams()

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

◆ getHeader()

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

◆ getHeaderSize()

uint32_t llvm::DWARFUnit::getHeaderSize ( ) const
inlineprotected

Size in bytes of the parsed unit header.

Definition at line 255 of file DWARFUnit.h.

References llvm::DWARFUnitHeader::getSize().

◆ getInfoSection()

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

Definition at line 282 of file DWARFUnit.h.

◆ 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 682 of file DWARFUnit.cpp.

References llvm::Address, assert(), llvm::DWARFDie::getParent(), getSubroutineForAddress(), llvm::DWARFDie::getTag(), and llvm::DWARFDie::isSubprogramDIE().

◆ getLastChild()

DWARFDie DWARFUnit::getLastChild ( const DWARFDebugInfoEntry Die)

◆ getLength()

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

◆ getLineSection()

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

Definition at line 299 of file DWARFUnit.h.

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

◆ getLineTableOffset()

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

◆ getLocationTable()

const DWARFLocationTable& llvm::DWARFUnit::getLocationTable ( )
inline

Definition at line 336 of file DWARFUnit.h.

Referenced by dumpLocation(), and findLoclistFromOffset().

◆ getLoclistOffset()

Optional< uint64_t > DWARFUnit::getLoclistOffset ( uint32_t  Index)

Definition at line 951 of file DWARFUnit.cpp.

References getFormat(), llvm::DWARFListTableHeader::getOffsetEntry(), and llvm::None.

Referenced by dumpLocation().

◆ getLocSectionBase()

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

Definition at line 322 of file DWARFUnit.h.

◆ getNextUnitOffset()

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

◆ getNonSkeletonUnitDIE()

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

Definition at line 389 of file DWARFUnit.h.

References getUnitDIE().

◆ getNumDIEs()

unsigned llvm::DWARFUnit::getNumDIEs ( )
inline

Returns the number of DIEs in the unit.

Parses the unit if necessary.

Definition at line 440 of file DWARFUnit.h.

Referenced by llvm::CompileUnit::CompileUnit().

◆ getOffset()

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

◆ getParent()

DWARFDie DWARFUnit::getParent ( const DWARFDebugInfoEntry Die)

Definition at line 711 of file DWARFUnit.cpp.

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

◆ getPreviousSibling()

DWARFDie DWARFUnit::getPreviousSibling ( const DWARFDebugInfoEntry Die)

Definition at line 750 of file DWARFUnit.cpp.

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

◆ getRefAddrByteSize()

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

Definition at line 289 of file DWARFUnit.h.

References llvm::DWARFUnitHeader::getRefAddrByteSize().

◆ getRnglistOffset()

Optional< uint64_t > DWARFUnit::getRnglistOffset ( uint32_t  Index)

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 940 of file DWARFUnit.cpp.

References Context, llvm::DWARFSection::Data, getAddressByteSize(), getFormat(), llvm::DWARFListTableHeader::getOffsetEntry(), and llvm::None.

Referenced by findRnglistFromIndex().

◆ getSibling()

DWARFDie DWARFUnit::getSibling ( const DWARFDebugInfoEntry Die)

◆ getStringExtractor()

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

Definition at line 332 of file DWARFUnit.h.

◆ getStringOffsetsBase()

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

Definition at line 356 of file DWARFUnit.h.

References assert().

Referenced by getStringOffsetSectionItem().

◆ getStringOffsetSection()

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

Definition at line 301 of file DWARFUnit.h.

◆ getStringOffsetSectionItem()

Optional< uint64_t > DWARFUnit::getStringOffsetSectionItem ( uint32_t  Index) const

◆ getStringOffsetsTableContribution()

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

Definition at line 347 of file DWARFUnit.h.

◆ getStringSection()

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

Definition at line 300 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 667 of file DWARFUnit.cpp.

References llvm::Address, getUnitDIE(), and updateAddressDieMap().

Referenced by getInlinedChainForAddress().

◆ getUnitDIE()

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

◆ getUnitType()

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

◆ getUnitVector()

const DWARFUnitVector& llvm::DWARFUnit::getUnitVector ( ) const
inline

Return the DWARFUnitVector containing this unit.

Definition at line 436 of file DWARFUnit.h.

◆ getVersion()

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

◆ isDWOUnit()

bool llvm::DWARFUnit::isDWOUnit ( ) const
inline

Definition at line 280 of file DWARFUnit.h.

◆ isMatchingUnitTypeAndTag()

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

Definition at line 363 of file DWARFUnit.h.

References llvm::dwarf::isUnitType().

◆ isTypeUnit()

bool llvm::DWARFUnit::isTypeUnit ( ) const
inline

◆ setAddrOffsetSection()

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

Definition at line 305 of file DWARFUnit.h.

◆ setDWOId()

void llvm::DWARFUnit::setDWOId ( uint64_t  NewID)
inline

Definition at line 401 of file DWARFUnit.h.

References llvm::DWARFUnitHeader::setDWOId().

◆ setRangesSection()

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

Definition at line 317 of file DWARFUnit.h.

Referenced by tryExtractDIEsIfNeeded().

◆ tryExtractDIEsIfNeeded()

Error DWARFUnit::tryExtractDIEsIfNeeded ( bool  CUDieOnly)

◆ updateAddressDieMap()

void DWARFUnit::updateAddressDieMap ( DWARFDie  Die)

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