LLVM  15.0.0git
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
llvm::DWARFFormValue Class Reference

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

Classes

struct  UnitOffset
 

Public Types

enum  FormClass {
  FC_Unknown, FC_Address, FC_Block, FC_Constant,
  FC_String, FC_Flag, FC_Reference, FC_Indirect,
  FC_SectionOffset, FC_Exprloc
}
 

Public Member Functions

 DWARFFormValue (dwarf::Form F=dwarf::Form(0))
 
dwarf::Form getForm () const
 
uint64_t getRawUValue () const
 
bool isFormClass (FormClass FC) const
 
const DWARFUnitgetUnit () const
 
void dump (raw_ostream &OS, DIDumpOptions DumpOpts=DIDumpOptions()) const
 
void dumpSectionedAddress (raw_ostream &OS, DIDumpOptions DumpOpts, object::SectionedAddress SA) const
 
void dumpAddress (raw_ostream &OS, uint64_t Address) const
 
bool extractValue (const DWARFDataExtractor &Data, uint64_t *OffsetPtr, dwarf::FormParams FormParams, const DWARFContext *Context=nullptr, const DWARFUnit *Unit=nullptr)
 Extracts a value in Data at offset *OffsetPtr. More...
 
bool extractValue (const DWARFDataExtractor &Data, uint64_t *OffsetPtr, dwarf::FormParams FormParams, const DWARFUnit *U)
 
Optional< uint64_tgetAsReference () const
 getAsFoo functions below return the extracted value as Foo if only DWARFFormValue has form class is suitable for representing Foo. More...
 
Optional< UnitOffsetgetAsRelativeReference () const
 
Optional< uint64_tgetAsUnsignedConstant () const
 
Optional< int64_t > getAsSignedConstant () const
 
Expected< const char * > getAsCString () const
 
Optional< uint64_tgetAsAddress () const
 
Optional< object::SectionedAddressgetAsSectionedAddress () const
 
Optional< uint64_tgetAsSectionOffset () const
 
Optional< ArrayRef< uint8_t > > getAsBlock () const
 
Optional< uint64_tgetAsCStringOffset () const
 
Optional< uint64_tgetAsReferenceUVal () const
 
Optional< std::string > getAsFile (DILineInfoSpecifier::FileLineInfoKind Kind) const
 Correctly extract any file paths from a form value. More...
 
bool skipValue (DataExtractor DebugInfoData, uint64_t *OffsetPtr, const dwarf::FormParams Params) const
 Skip a form's value in DebugInfoData at the offset specified by OffsetPtr. More...
 

Static Public Member Functions

static DWARFFormValue createFromSValue (dwarf::Form F, int64_t V)
 
static DWARFFormValue createFromUValue (dwarf::Form F, uint64_t V)
 
static DWARFFormValue createFromPValue (dwarf::Form F, const char *V)
 
static DWARFFormValue createFromBlockValue (dwarf::Form F, ArrayRef< uint8_t > D)
 
static DWARFFormValue createFromUnit (dwarf::Form F, const DWARFUnit *Unit, uint64_t *OffsetPtr)
 
static void dumpAddress (raw_ostream &OS, uint8_t AddressSize, uint64_t Address)
 
static void dumpAddressSection (const DWARFObject &Obj, raw_ostream &OS, DIDumpOptions DumpOpts, uint64_t SectionIndex)
 
static bool skipValue (dwarf::Form Form, DataExtractor DebugInfoData, uint64_t *OffsetPtr, const dwarf::FormParams FormParams)
 Skip a form's value in DebugInfoData at the offset specified by OffsetPtr. More...
 

Detailed Description

Definition at line 28 of file DWARFFormValue.h.

Member Enumeration Documentation

◆ FormClass

Enumerator
FC_Unknown 
FC_Address 
FC_Block 
FC_Constant 
FC_String 
FC_Flag 
FC_Reference 
FC_Indirect 
FC_SectionOffset 
FC_Exprloc 

Definition at line 30 of file DWARFFormValue.h.

Constructor & Destructor Documentation

◆ DWARFFormValue()

llvm::DWARFFormValue::DWARFFormValue ( dwarf::Form  F = dwarf::Form(0))
inline

Definition at line 69 of file DWARFFormValue.h.

Member Function Documentation

◆ createFromBlockValue()

DWARFFormValue DWARFFormValue::createFromBlockValue ( dwarf::Form  F,
ArrayRef< uint8_t >  D 
)
static

Definition at line 95 of file DWARFFormValue.cpp.

References D, and F.

◆ createFromPValue()

DWARFFormValue DWARFFormValue::createFromPValue ( dwarf::Form  F,
const char *  V 
)
static

Definition at line 91 of file DWARFFormValue.cpp.

References F.

Referenced by llvm::DWARFDebugLine::LineTable::parse().

◆ createFromSValue()

DWARFFormValue DWARFFormValue::createFromSValue ( dwarf::Form  F,
int64_t  V 
)
static

Definition at line 83 of file DWARFFormValue.cpp.

References F.

Referenced by llvm::DWARFAbbreviationDeclaration::getAttributeValueFromOffset().

◆ createFromUnit()

DWARFFormValue DWARFFormValue::createFromUnit ( dwarf::Form  F,
const DWARFUnit Unit,
uint64_t OffsetPtr 
)
static

◆ createFromUValue()

DWARFFormValue DWARFFormValue::createFromUValue ( dwarf::Form  F,
uint64_t  V 
)
static

Definition at line 87 of file DWARFFormValue.cpp.

References F.

Referenced by dumpAttribute().

◆ dump()

void DWARFFormValue::dump ( raw_ostream OS,
DIDumpOptions  DumpOpts = DIDumpOptions() 
) const

◆ dumpAddress() [1/2]

void llvm::DWARFFormValue::dumpAddress ( raw_ostream OS,
uint64_t  Address 
) const

◆ dumpAddress() [2/2]

void DWARFFormValue::dumpAddress ( raw_ostream OS,
uint8_t  AddressSize,
uint64_t  Address 
)
static

Definition at line 379 of file DWARFFormValue.cpp.

References llvm::format().

◆ dumpAddressSection()

void DWARFFormValue::dumpAddressSection ( const DWARFObject Obj,
raw_ostream OS,
DIDumpOptions  DumpOpts,
uint64_t  SectionIndex 
)
static

◆ dumpSectionedAddress()

void DWARFFormValue::dumpSectionedAddress ( raw_ostream OS,
DIDumpOptions  DumpOpts,
object::SectionedAddress  SA 
) const

◆ extractValue() [1/2]

bool DWARFFormValue::extractValue ( const DWARFDataExtractor Data,
uint64_t OffsetPtr,
dwarf::FormParams  FormParams,
const DWARFContext Context = nullptr,
const DWARFUnit Unit = nullptr 
)

Extracts a value in Data at offset *OffsetPtr.

The information in FormParams is needed to interpret some forms. The optional Context and Unit allows extracting information if the form refers to other sections (e.g., .debug_str).

Definition at line 247 of file DWARFFormValue.cpp.

References FP.

Referenced by createFromUnit(), extractValue(), llvm::DWARFAbbreviationDeclaration::getAttributeValueFromOffset(), and llvm::AppleAcceleratorTable::readAtoms().

◆ extractValue() [2/2]

bool llvm::DWARFFormValue::extractValue ( const DWARFDataExtractor Data,
uint64_t OffsetPtr,
dwarf::FormParams  FormParams,
const DWARFUnit U 
)
inline

Definition at line 102 of file DWARFFormValue.h.

References llvm::Data, and extractValue().

◆ getAsAddress()

Optional< uint64_t > DWARFFormValue::getAsAddress ( ) const

Definition at line 668 of file DWARFFormValue.cpp.

References llvm::None.

Referenced by dumpAttribute().

◆ getAsBlock()

Optional< ArrayRef< uint8_t > > DWARFFormValue::getAsBlock ( ) const

Definition at line 753 of file DWARFFormValue.cpp.

References llvm::makeArrayRef(), and llvm::None.

Referenced by dumpLocationExpr().

◆ getAsCString()

Expected< const char * > DWARFFormValue::getAsCString ( ) const

◆ getAsCStringOffset()

Optional< uint64_t > DWARFFormValue::getAsCStringOffset ( ) const

Definition at line 760 of file DWARFFormValue.cpp.

References llvm::None.

◆ getAsFile()

Optional< std::string > DWARFFormValue::getAsFile ( DILineInfoSpecifier::FileLineInfoKind  Kind) const

Correctly extract any file paths from a form value.

These attributes can be in the from DW_AT_decl_file or DW_AT_call_file attributes. We need to use the file index in the correct DWARFUnit's line table prologue, and each DWARFFormValue has the DWARFUnit the form value was extracted from.

Parameters
KindThe kind of path to extract.
Returns
A valid string value on success, or llvm::None if the form class is not FC_Constant, or if the file index is not valid.

Definition at line 773 of file DWARFFormValue.cpp.

References llvm::DWARFUnit::getCompilationDir(), llvm::DWARFUnit::getContext(), llvm::DWARFContext::getLineTableForUnit(), llvm::AArch64CC::LT, and llvm::None.

◆ getAsReference()

Optional< uint64_t > DWARFFormValue::getAsReference ( ) const

getAsFoo functions below return the extracted value as Foo if only DWARFFormValue has form class is suitable for representing Foo.

Definition at line 694 of file DWARFFormValue.cpp.

References llvm::None.

◆ getAsReferenceUVal()

Optional< uint64_t > DWARFFormValue::getAsReferenceUVal ( ) const

Definition at line 766 of file DWARFFormValue.cpp.

References llvm::None.

◆ getAsRelativeReference()

Optional< DWARFFormValue::UnitOffset > DWARFFormValue::getAsRelativeReference ( ) const

Definition at line 700 of file DWARFFormValue.cpp.

References llvm::None.

Referenced by llvm::DWARFDie::getAttributeValueAsReferencedDie().

◆ getAsSectionedAddress()

Optional< object::SectionedAddress > DWARFFormValue::getAsSectionedAddress ( ) const

Definition at line 675 of file DWARFFormValue.cpp.

References llvm::object::SectionedAddress::Address, if(), and llvm::None.

◆ getAsSectionOffset()

Optional< uint64_t > DWARFFormValue::getAsSectionOffset ( ) const

Definition at line 721 of file DWARFFormValue.cpp.

References llvm::None.

Referenced by dumpAttribute(), and dumpLocationList().

◆ getAsSignedConstant()

Optional< int64_t > DWARFFormValue::getAsSignedConstant ( ) const

Definition at line 734 of file DWARFFormValue.cpp.

References llvm::max(), and llvm::None.

◆ getAsUnsignedConstant()

Optional< uint64_t > DWARFFormValue::getAsUnsignedConstant ( ) const

Definition at line 727 of file DWARFFormValue.cpp.

References llvm::None.

Referenced by dumpAttribute(), and llvm::AppleAcceleratorTable::readAtoms().

◆ getForm()

dwarf::Form llvm::DWARFFormValue::getForm ( ) const
inline

◆ getRawUValue()

uint64_t llvm::DWARFFormValue::getRawUValue ( ) const
inline

Definition at line 80 of file DWARFFormValue.h.

◆ getUnit()

const DWARFUnit* llvm::DWARFFormValue::getUnit ( ) const
inline

Definition at line 83 of file DWARFFormValue.h.

◆ isFormClass()

bool DWARFFormValue::isFormClass ( DWARFFormValue::FormClass  FC) const

◆ skipValue() [1/2]

bool llvm::DWARFFormValue::skipValue ( DataExtractor  DebugInfoData,
uint64_t OffsetPtr,
const dwarf::FormParams  Params 
) const
inline

Skip a form's value in DebugInfoData at the offset specified by OffsetPtr.

Skips the bytes for the current form and updates the offset.

Parameters
DebugInfoDataThe data where we want to skip the value.
OffsetPtrA reference to the offset that will be updated.
ParamsDWARF parameters to help interpret forms.
Returns
true on success, false if the form was not skipped.

Definition at line 147 of file DWARFFormValue.h.

Referenced by llvm::DWARFDebugInfoEntry::extractFast(), llvm::DWARFAbbreviationDeclaration::getAttributeOffsetFromIndex(), and getCUIdentifiers().

◆ skipValue() [2/2]

bool DWARFFormValue::skipValue ( dwarf::Form  Form,
DataExtractor  DebugInfoData,
uint64_t OffsetPtr,
const dwarf::FormParams  FormParams 
)
static

Skip a form's value in DebugInfoData at the offset specified by OffsetPtr.

Skips the bytes for the specified form and updates the offset.

Parameters
FormThe DW_FORM enumeration that indicates the form to skip.
DebugInfoDataThe data where we want to skip the value.
OffsetPtrA reference to the offset that will be updated.
FormParamsDWARF parameters to help interpret forms.
Returns
true on success, false if the form was not skipped.

Definition at line 111 of file DWARFFormValue.cpp.

References llvm::DataExtractor::getCStr(), llvm::dwarf::getFixedFormByteSize(), llvm::DataExtractor::getSLEB128(), llvm::DataExtractor::getU16(), llvm::DataExtractor::getU32(), llvm::DataExtractor::getU8(), llvm::DataExtractor::getULEB128(), and llvm::size().


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