LLVM
15.0.0git
|
Utility class that carries the DWARF compile/type unit and the debug info entry in an object. More...
#include "llvm/DebugInfo/DWARF/DWARFDie.h"
Classes | |
class | attribute_iterator |
class | iterator |
Public Member Functions | |
DWARFDie ()=default | |
DWARFDie (DWARFUnit *Unit, const DWARFDebugInfoEntry *D) | |
bool | isValid () const |
operator bool () const | |
const DWARFDebugInfoEntry * | getDebugInfoEntry () const |
DWARFUnit * | getDwarfUnit () const |
const DWARFAbbreviationDeclaration * | getAbbreviationDeclarationPtr () const |
Get the abbreviation declaration for this DIE. More... | |
uint64_t | getOffset () const |
Get the absolute offset into the debug info or types section. More... | |
dwarf::Tag | getTag () const |
bool | hasChildren () const |
bool | isNULL () const |
Returns true for a valid DIE that terminates a sibling chain. More... | |
bool | isSubprogramDIE () const |
Returns true if DIE represents a subprogram (not inlined). More... | |
bool | isSubroutineDIE () const |
Returns true if DIE represents a subprogram or an inlined subroutine. More... | |
DWARFDie | getParent () const |
Get the parent of this DIE object. More... | |
DWARFDie | getSibling () const |
Get the sibling of this DIE object. More... | |
DWARFDie | getPreviousSibling () const |
Get the previous sibling of this DIE object. More... | |
DWARFDie | getFirstChild () const |
Get the first child of this DIE object. More... | |
DWARFDie | getLastChild () const |
Get the last child of this DIE object. More... | |
void | dump (raw_ostream &OS, unsigned indent=0, DIDumpOptions DumpOpts=DIDumpOptions()) const |
Dump the DIE and all of its attributes to the supplied stream. More... | |
LLVM_DUMP_METHOD void | dump () const |
Convenience zero-argument overload for debugging. More... | |
Optional< DWARFFormValue > | find (dwarf::Attribute Attr) const |
Extract the specified attribute from this DIE. More... | |
Optional< DWARFFormValue > | find (ArrayRef< dwarf::Attribute > Attrs) const |
Extract the first value of any attribute in Attrs from this DIE. More... | |
Optional< DWARFFormValue > | findRecursively (ArrayRef< dwarf::Attribute > Attrs) const |
Extract the first value of any attribute in Attrs from this DIE and recurse into any DW_AT_specification or DW_AT_abstract_origin referenced DIEs. More... | |
DWARFDie | getAttributeValueAsReferencedDie (dwarf::Attribute Attr) const |
Extract the specified attribute from this DIE as the referenced DIE. More... | |
DWARFDie | getAttributeValueAsReferencedDie (const DWARFFormValue &V) const |
DWARFDie | resolveTypeUnitReference () const |
Optional< uint64_t > | getRangesBaseAttribute () const |
Extract the range base attribute from this DIE as absolute section offset. More... | |
Optional< uint64_t > | getLocBaseAttribute () const |
Optional< uint64_t > | getHighPC (uint64_t LowPC) const |
Get the DW_AT_high_pc attribute value as an address. More... | |
bool | getLowAndHighPC (uint64_t &LowPC, uint64_t &HighPC, uint64_t &SectionIndex) const |
Retrieves DW_AT_low_pc and DW_AT_high_pc from CU. More... | |
Expected< DWARFAddressRangesVector > | getAddressRanges () const |
Get the address ranges for this DIE. More... | |
bool | addressRangeContainsAddress (const uint64_t Address) const |
Expected< DWARFLocationExpressionsVector > | getLocations (dwarf::Attribute Attr) const |
const char * | getSubroutineName (DINameKind Kind) const |
If a DIE represents a subprogram (or inlined subroutine), returns its mangled name (or short name, if mangled is missing). More... | |
const char * | getName (DINameKind Kind) const |
Return the DIE name resolving DW_AT_specification or DW_AT_abstract_origin references if necessary. More... | |
void | getFullName (raw_string_ostream &, std::string *OriginalFullName=nullptr) const |
const char * | getShortName () const |
Return the DIE short name resolving DW_AT_specification or DW_AT_abstract_origin references if necessary. More... | |
const char * | getLinkageName () const |
Return the DIE linkage name resolving DW_AT_specification or DW_AT_abstract_origin references if necessary. More... | |
uint64_t | getDeclLine () const |
Returns the declaration line (start line) for a DIE, assuming it specifies a subprogram. More... | |
std::string | getDeclFile (DILineInfoSpecifier::FileLineInfoKind Kind) const |
void | getCallerFrame (uint32_t &CallFile, uint32_t &CallLine, uint32_t &CallColumn, uint32_t &CallDiscriminator) const |
Retrieves values of DW_AT_call_file, DW_AT_call_line and DW_AT_call_column from DIE (or zeroes if they are missing). More... | |
iterator_range< attribute_iterator > | attributes () const |
Get an iterator range to all attributes in the current DIE only. More... | |
Optional< uint64_t > | getTypeSize (uint64_t PointerSize) |
Gets the type size (in bytes) for this DIE. More... | |
iterator | begin () const |
iterator | end () const |
std::reverse_iterator< iterator > | rbegin () const |
std::reverse_iterator< iterator > | rend () const |
iterator_range< iterator > | children () const |
Utility class that carries the DWARF compile/type unit and the debug info entry in an object.
When accessing information from a debug info entry we always need to DWARF compile/type unit in order to extract the info correctly as some information is relative to the compile/type unit. Prior to this class the DWARFUnit and the DWARFDebugInfoEntry was passed around separately and there was the possibility for error if the wrong DWARFUnit was used to extract a unit relative offset. This class helps to ensure that this doesn't happen and also simplifies the attribute extraction calls by not having to specify the DWARFUnit for each call.
Definition at line 43 of file DWARFDie.h.
|
default |
|
inline |
Definition at line 49 of file DWARFDie.h.
Definition at line 390 of file DWARFDie.cpp.
References llvm::consumeError().
iterator_range< DWARFDie::attribute_iterator > DWARFDie::attributes | ( | ) | const |
Get an iterator range to all attributes in the current DIE only.
Definition at line 650 of file DWARFDie.cpp.
References llvm::make_range().
|
inline |
Definition at line 388 of file DWARFDie.h.
References getFirstChild().
Referenced by children(), and rend().
|
inline |
Definition at line 396 of file DWARFDie.h.
References begin(), end(), and llvm::make_range().
Referenced by llvm::analyzeContextInfo(), hasInlineInfo(), and parseInlineInfo().
LLVM_DUMP_METHOD void DWARFDie::dump | ( | ) | const |
Convenience zero-argument overload for debugging.
Definition at line 618 of file DWARFDie.cpp.
References llvm::dump(), and llvm::errs().
void DWARFDie::dump | ( | raw_ostream & | OS, |
unsigned | indent = 0 , |
||
DIDumpOptions | DumpOpts = DIDumpOptions() |
||
) | const |
Dump the DIE and all of its attributes to the supplied stream.
OS | the stream to use for output. |
indent | the number of characters to indent each line that is output. |
Definition at line 560 of file DWARFDie.cpp.
References llvm::Address, attributes, llvm::DIDumpOptions::ChildRecurseDepth, dump(), dumpAttribute(), dumpParentChain(), llvm::format(), llvm::formatv(), llvm::WithColor::get(), llvm::getOffset(), getParent(), getSibling(), llvm::dwarf::getTag(), llvm::DataExtractor::getULEB128(), llvm::raw_ostream::indent(), isValid(), llvm::DataExtractor::isValidOffset(), llvm::DIDumpOptions::ShowAddresses, llvm::DIDumpOptions::ShowChildren, llvm::DIDumpOptions::ShowParents, llvm::Tag, and llvm::DIDumpOptions::Verbose.
Referenced by convertFunctionLineTable(), dump(), and dumpParentChain().
|
inline |
Definition at line 392 of file DWARFDie.h.
References getLastChild().
Referenced by children(), and rbegin().
Optional< DWARFFormValue > DWARFDie::find | ( | ArrayRef< dwarf::Attribute > | Attrs | ) | const |
Extract the first value of any attribute in Attrs from this DIE.
Extract the first attribute that matches from this DIE only. This call doesn't look for the attribute value in any DW_AT_specification or DW_AT_abstract_origin referenced DIEs. The attributes will be searched linearly in the order they are specified within Attrs.
Attrs | an array of DWARF attribute to look for. |
Definition at line 255 of file DWARFDie.cpp.
References Attrs, llvm::getOffset(), isValid(), and llvm::None.
Optional< DWARFFormValue > DWARFDie::find | ( | dwarf::Attribute | Attr | ) | const |
Extract the specified attribute from this DIE.
Extract an attribute value from this DIE only. This call doesn't look for the attribute value in any DW_AT_specification or DW_AT_abstract_origin referenced DIEs.
Attr | the attribute to extract. |
Definition at line 245 of file DWARFDie.cpp.
References llvm::getOffset(), isValid(), and llvm::None.
Referenced by llvm::analyzeContextInfo(), llvm::gsym::CUInfo::CUInfo(), findRecursively(), llvm::DWARFUnit::getBaseAddress(), llvm::getDwoId(), llvm::DWARFContext::getInliningInfoForAddress(), getTypeSize(), parseInlineInfo(), llvm::DWARFUnit::tryExtractDIEsIfNeeded(), and llvm::updatePruning().
Optional< DWARFFormValue > DWARFDie::findRecursively | ( | ArrayRef< dwarf::Attribute > | Attrs | ) | const |
Extract the first value of any attribute in Attrs from this DIE and recurse into any DW_AT_specification or DW_AT_abstract_origin referenced DIEs.
Attrs | an array of DWARF attribute to look for. |
Definition at line 269 of file DWARFDie.cpp.
References Attrs, D, find(), getAttributeValueAsReferencedDie(), llvm::SmallSet< T, N, C >::insert(), isValid(), llvm::None, and llvm::SmallVectorImpl< T >::pop_back_val().
Referenced by convertFunctionLineTable(), and getQualifiedNameIndex().
|
inline |
Get the abbreviation declaration for this DIE.
Definition at line 59 of file DWARFDie.h.
References assert(), llvm::DWARFDebugInfoEntry::getAbbreviationDeclarationPtr(), and isValid().
Expected< DWARFAddressRangesVector > DWARFDie::getAddressRanges | ( | ) | const |
Get the address ranges for this DIE.
Get the hi/low PC range if both attributes are available or exrtracts the non-contiguous address ranges from the DW_AT_ranges attribute.
Extracts the range information from this DIE only. This call doesn't look for the range in any DW_AT_specification or DW_AT_abstract_origin DIEs.
Definition at line 373 of file DWARFDie.cpp.
References llvm::find().
Referenced by llvm::DWARFUnit::collectAddressRanges(), dumpAttribute(), parseInlineInfo(), and llvm::DWARFUnit::updateAddressDieMap().
DWARFDie DWARFDie::getAttributeValueAsReferencedDie | ( | const DWARFFormValue & | V | ) | const |
Definition at line 309 of file DWARFDie.cpp.
References llvm::DWARFFormValue::getAsRelativeReference().
DWARFDie DWARFDie::getAttributeValueAsReferencedDie | ( | dwarf::Attribute | Attr | ) | const |
Extract the specified attribute from this DIE as the referenced DIE.
Regardless of the reference type, return the correct DWARFDie instance if the attribute exists. The returned DWARFDie object might be from another DWARFUnit, but that is all encapsulated in the new DWARFDie object.
Extract an attribute value from this DIE only. This call doesn't look for the attribute value in any DW_AT_specification or DW_AT_abstract_origin referenced DIEs.
Attr | the attribute to extract. |
Definition at line 302 of file DWARFDie.cpp.
References F, and llvm::find().
Referenced by dumpAttribute(), findRecursively(), and GetParentDeclContextDIE().
void DWARFDie::getCallerFrame | ( | uint32_t & | CallFile, |
uint32_t & | CallLine, | ||
uint32_t & | CallColumn, | ||
uint32_t & | CallDiscriminator | ||
) | const |
Retrieves values of DW_AT_call_file, DW_AT_call_line and DW_AT_call_column from DIE (or zeroes if they are missing).
This function looks for DW_AT_call attributes in this DIE only, it will not resolve the attribute values in any DW_AT_specification or DW_AT_abstract_origin DIEs.
CallFile | filled in with non-zero if successful, zero if there is no DW_AT_call_file attribute in this DIE. |
CallLine | filled in with non-zero if successful, zero if there is no DW_AT_call_line attribute in this DIE. |
CallColumn | filled in with non-zero if successful, zero if there is no DW_AT_call_column attribute in this DIE. |
CallDiscriminator | filled in with non-zero if successful, zero if there is no DW_AT_GNU_discriminator attribute in this DIE. |
Definition at line 479 of file DWARFDie.cpp.
References llvm::find(), and llvm::dwarf::toUnsigned().
Referenced by llvm::DWARFContext::getInliningInfoForAddress().
|
inline |
Definition at line 53 of file DWARFDie.h.
std::string DWARFDie::getDeclFile | ( | DILineInfoSpecifier::FileLineInfoKind | Kind | ) | const |
Definition at line 472 of file DWARFDie.cpp.
Referenced by convertFunctionLineTable(), llvm::DWARFContext::getInliningInfoForAddress(), and llvm::DWARFContext::getLineInfoForDataAddress().
uint64_t DWARFDie::getDeclLine | ( | ) | const |
Returns the declaration line (start line) for a DIE, assuming it specifies a subprogram.
This may be fetched from specification or abstract origin for this subprogram by resolving DW_AT_sepcification or DW_AT_abstract_origin references if necessary.
Definition at line 467 of file DWARFDie.cpp.
References llvm::dwarf::toUnsigned().
Referenced by llvm::DWARFContext::getInliningInfoForAddress(), and llvm::DWARFContext::getLineInfoForDataAddress().
|
inline |
Definition at line 54 of file DWARFDie.h.
Referenced by dumpAttribute(), and isVariableIndexable().
DWARFDie DWARFDie::getFirstChild | ( | ) | const |
Get the first child of this DIE object.
Definition at line 638 of file DWARFDie.cpp.
References getFirstChild(), and isValid().
Referenced by begin(), getFirstChild(), and llvm::DWARFUnit::updateAddressDieMap().
void DWARFDie::getFullName | ( | raw_string_ostream & | OS, |
std::string * | OriginalFullName = nullptr |
||
) | const |
Definition at line 228 of file DWARFDie.cpp.
References llvm::dumpTypeUnqualifiedName(), and llvm::dwarf::getTag().
Get the DW_AT_high_pc attribute value as an address.
In DWARF version 4 and later the high PC can be encoded as an offset from the DW_AT_low_pc. This function takes care of extracting the value as an address or offset and adds it to the low PC if needed and returns the value as an optional in case the DIE doesn't have a DW_AT_high_pc attribute.
LowPC | the low PC that might be needed to calculate the high PC. |
Definition at line 341 of file DWARFDie.cpp.
References llvm::dwarf::computeTombstoneAddress(), llvm::find(), and llvm::None.
DWARFDie DWARFDie::getLastChild | ( | ) | const |
Get the last child of this DIE object.
Definition at line 644 of file DWARFDie.cpp.
References getLastChild(), and isValid().
Referenced by end(), and getLastChild().
const char * DWARFDie::getLinkageName | ( | ) | const |
Return the DIE linkage name resolving DW_AT_specification or DW_AT_abstract_origin references if necessary.
Returns null if no name is found.
Definition at line 458 of file DWARFDie.cpp.
References isValid(), and llvm::dwarf::toString().
Expected< DWARFLocationExpressionsVector > DWARFDie::getLocations | ( | dwarf::Attribute | Attr | ) | const |
Definition at line 404 of file DWARFDie.cpp.
References llvm::dwarf::AttributeString(), llvm::createStringError(), llvm::StringRef::data(), llvm::find(), llvm::dwarf::FormEncodingString(), llvm::inconvertibleErrorCode(), and llvm::None.
Referenced by isVariableIndexable().
Definition at line 337 of file DWARFDie.cpp.
References llvm::find(), and llvm::dwarf::toSectionOffset().
bool DWARFDie::getLowAndHighPC | ( | uint64_t & | LowPC, |
uint64_t & | HighPC, | ||
uint64_t & | SectionIndex | ||
) | const |
Retrieves DW_AT_low_pc and DW_AT_high_pc from CU.
Returns true if both attributes are present.
Definition at line 358 of file DWARFDie.cpp.
References F, llvm::find(), and llvm::dwarf::toSectionedAddress().
Referenced by dumpAttribute().
const char * DWARFDie::getName | ( | DINameKind | Kind | ) | const |
Return the DIE name resolving DW_AT_specification or DW_AT_abstract_origin references if necessary.
For the LinkageName case it additionaly searches for ShortName if LinkageName is not found. Returns null if no name is found.
Definition at line 440 of file DWARFDie.cpp.
References getLinkageName(), isValid(), llvm::LinkageName, and llvm::None.
Referenced by llvm::DWARFTypeUnit::dump(), dumpAttribute(), and getQualifiedNameIndex().
|
inline |
Get the absolute offset into the debug info or types section.
Definition at line 67 of file DWARFDie.h.
References assert(), llvm::DWARFDebugInfoEntry::getOffset(), and isValid().
DWARFDie DWARFDie::getParent | ( | ) | const |
Get the parent of this DIE object.
Definition at line 620 of file DWARFDie.cpp.
References getParent(), and isValid().
Referenced by dumpParentChain(), llvm::DWARFUnit::getInlinedChainForAddress(), getParent(), and GetParentDeclContextDIE().
DWARFDie DWARFDie::getPreviousSibling | ( | ) | const |
Get the previous sibling of this DIE object.
Definition at line 632 of file DWARFDie.cpp.
References getPreviousSibling(), and isValid().
Referenced by getPreviousSibling(), std::reverse_iterator< llvm::DWARFDie::iterator >::operator++(), llvm::DWARFDie::iterator::operator--(), and std::reverse_iterator< llvm::DWARFDie::iterator >::reverse_iterator().
Extract the range base attribute from this DIE as absolute section offset.
This is a utility function that checks for either the DW_AT_rnglists_base or DW_AT_GNU_ranges_base attribute.
Definition at line 333 of file DWARFDie.cpp.
References llvm::find(), and llvm::dwarf::toSectionOffset().
const char * DWARFDie::getShortName | ( | ) | const |
Return the DIE short name resolving DW_AT_specification or DW_AT_abstract_origin references if necessary.
Returns null if no name is found.
Definition at line 451 of file DWARFDie.cpp.
References isValid(), and llvm::dwarf::toString().
DWARFDie DWARFDie::getSibling | ( | ) | const |
Get the sibling of this DIE object.
Definition at line 626 of file DWARFDie.cpp.
References getSibling(), and isValid().
Referenced by std::reverse_iterator< llvm::DWARFDie::iterator >::base(), dump(), getSibling(), llvm::DWARFDie::iterator::operator++(), std::reverse_iterator< llvm::DWARFDie::iterator >::operator--(), and llvm::DWARFUnit::updateAddressDieMap().
const char * DWARFDie::getSubroutineName | ( | DINameKind | Kind | ) | const |
If a DIE represents a subprogram (or inlined subroutine), returns its mangled name (or short name, if mangled is missing).
This name may be fetched from specification or abstract origin for this subprogram. Returns null if no name is found.
Definition at line 434 of file DWARFDie.cpp.
References getName().
Referenced by llvm::DWARFContext::getInliningInfoForAddress().
|
inline |
Definition at line 72 of file DWARFDie.h.
References getAbbreviationDeclarationPtr().
Referenced by llvm::analyzeContextInfo(), llvm::CompileUnit::createOutputDIE(), llvm::DWARFUnit::getInlinedChainForAddress(), GetParentDeclContextDIE(), getTypeSize(), hasInlineInfo(), llvm::inFunctionScope(), parseInlineInfo(), llvm::updateChildIncompleteness(), llvm::updatePruning(), and llvm::updateRefIncompleteness().
Gets the type size (in bytes) for this DIE.
PointerSize | the pointer size of the containing CU. |
Definition at line 488 of file DWARFDie.cpp.
References find(), llvm::find(), getTag(), llvm::dwarf::getTag(), llvm::None, and llvm::jitlink::x86_64::PointerSize.
|
inline |
Definition at line 79 of file DWARFDie.h.
References assert(), llvm::DWARFDebugInfoEntry::hasChildren(), and isValid().
|
inline |
Returns true for a valid DIE that terminates a sibling chain.
Definition at line 85 of file DWARFDie.h.
References getAbbreviationDeclarationPtr().
Referenced by std::reverse_iterator< llvm::DWARFDie::iterator >::operator--().
bool DWARFDie::isSubprogramDIE | ( | ) | const |
Returns true if DIE represents a subprogram (not inlined).
Definition at line 238 of file DWARFDie.cpp.
References llvm::dwarf::getTag().
Referenced by llvm::DWARFUnit::getInlinedChainForAddress().
bool DWARFDie::isSubroutineDIE | ( | ) | const |
Returns true if DIE represents a subprogram or an inlined subroutine.
Definition at line 240 of file DWARFDie.cpp.
References llvm::dwarf::getTag().
Referenced by llvm::DWARFUnit::updateAddressDieMap().
|
inline |
Definition at line 51 of file DWARFDie.h.
Referenced by dumpAttribute(), findRecursively(), getAbbreviationDeclarationPtr(), llvm::DWARFContext::getLocalsForAddress(), getOffset(), hasChildren(), operator bool(), and std::reverse_iterator< llvm::DWARFDie::iterator >::operator*().
|
inlineexplicit |
Definition at line 52 of file DWARFDie.h.
References isValid().
|
inline |
Definition at line 472 of file DWARFDie.h.
References end().
|
inline |
Definition at line 476 of file DWARFDie.h.
References begin().
DWARFDie DWARFDie::resolveTypeUnitReference | ( | ) | const |
Definition at line 322 of file DWARFDie.cpp.
References llvm::find(), llvm::DWARFUnit::getContext(), and llvm::DWARFContext::getTypeUnitForHash().