LLVM 24.0.0git
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
llvm::pdb::PDBSymbol Class Referenceabstract

PDBSymbol defines the base of the inheritance hierarchy for concrete symbol types (e.g. More...

#include "llvm/DebugInfo/PDB/PDBSymbol.h"

Inheritance diagram for llvm::pdb::PDBSymbol:
[legend]

Public Member Functions

virtual ~PDBSymbol ()
virtual void dump (PDBSymDumper &Dumper) const =0
 Dumps the contents of a symbol a raw_ostream.
virtual void dumpRight (PDBSymDumper &Dumper) const
 For certain PDBSymbolTypes, dumps additional information for the type that normally goes on the right side of the symbol.
void defaultDump (raw_ostream &OS, int Indent, PdbSymbolIdField ShowFlags, PdbSymbolIdField RecurseFlags) const
void dumpProperties () const
void dumpChildStats () const
PDB_SymType getSymTag () const
uint32_t getSymIndexId () const
template<typename T>
std::unique_ptr< T > findOneChild () const
template<typename T>
std::unique_ptr< ConcreteSymbolEnumerator< T > > findAllChildren () const
std::unique_ptr< IPDBEnumSymbols > findAllChildren (PDB_SymType Type) const
std::unique_ptr< IPDBEnumSymbols > findAllChildren () const
std::unique_ptr< IPDBEnumSymbols > findChildren (PDB_SymType Type, StringRef Name, PDB_NameSearchFlags Flags) const
std::unique_ptr< IPDBEnumSymbols > findChildrenByRVA (PDB_SymType Type, StringRef Name, PDB_NameSearchFlags Flags, uint32_t RVA) const
std::unique_ptr< IPDBEnumSymbols > findInlineFramesByVA (uint64_t VA) const
std::unique_ptr< IPDBEnumSymbols > findInlineFramesByRVA (uint32_t RVA) const
std::unique_ptr< IPDBEnumLineNumbers > findInlineeLinesByVA (uint64_t VA, uint32_t Length) const
std::unique_ptr< IPDBEnumLineNumbers > findInlineeLinesByRVA (uint32_t RVA, uint32_t Length) const
std::string getName () const
const IPDBRawSymbol & getRawSymbol () const
IPDBRawSymbol & getRawSymbol ()
const IPDBSession & getSession () const
std::unique_ptr< IPDBEnumSymbols > getChildStats (TagStats &Stats) const

Static Public Member Functions

static std::unique_ptr< PDBSymbol > create (const IPDBSession &PDBSession, std::unique_ptr< IPDBRawSymbol > RawSymbol)
static std::unique_ptr< PDBSymbol > create (const IPDBSession &PDBSession, IPDBRawSymbol &RawSymbol)
template<typename ConcreteT>
static std::unique_ptr< ConcreteT > createAs (const IPDBSession &PDBSession, std::unique_ptr< IPDBRawSymbol > RawSymbol)
template<typename ConcreteT>
static std::unique_ptr< ConcreteT > createAs (const IPDBSession &PDBSession, IPDBRawSymbol &RawSymbol)

Protected Member Functions

 PDBSymbol (const IPDBSession &PDBSession)
 PDBSymbol (PDBSymbol &&Other)
std::unique_ptr< PDBSymbol > getSymbolByIdHelper (uint32_t Id) const
template<typename ConcreteType>
std::unique_ptr< ConcreteType > getConcreteSymbolByIdHelper (uint32_t Id) const

Protected Attributes

const IPDBSession & Session
std::unique_ptr< IPDBRawSymbol > OwnedRawSymbol
IPDBRawSymbol * RawSymbol = nullptr

Detailed Description

PDBSymbol defines the base of the inheritance hierarchy for concrete symbol types (e.g.

functions, executables, vtables, etc). All concrete symbol types inherit from PDBSymbol and expose the exact set of methods that are valid for that particular symbol type, as described in the Microsoft reference "Lexical and Class Hierarchy of Symbol Types": https://msdn.microsoft.com/en-us/library/370hs6k4.aspx

Definition at line 72 of file PDBSymbol.h.

Constructor & Destructor Documentation

◆ PDBSymbol() [1/2]

PDBSymbol::PDBSymbol ( const IPDBSession & PDBSession)
explicitprotected

Definition at line 51 of file PDBSymbol.cpp.

References Session.

Referenced by PDBSymbol().

◆ PDBSymbol() [2/2]

PDBSymbol::PDBSymbol ( PDBSymbol && Other)
protected

Definition at line 53 of file PDBSymbol.cpp.

References llvm::move(), llvm::Other, PDBSymbol(), RawSymbol, and Session.

◆ ~PDBSymbol()

PDBSymbol::~PDBSymbol ( )
virtualdefault

Member Function Documentation

◆ create() [1/2]

std::unique_ptr< PDBSymbol > PDBSymbol::create ( const IPDBSession & PDBSession,
IPDBRawSymbol & RawSymbol )
static

Definition at line 109 of file PDBSymbol.cpp.

References RawSymbol.

◆ create() [2/2]

std::unique_ptr< PDBSymbol > PDBSymbol::create ( const IPDBSession & PDBSession,
std::unique_ptr< IPDBRawSymbol > RawSymbol )
static

Definition at line 101 of file PDBSymbol.cpp.

References RawSymbol.

Referenced by createAs(), createAs(), llvm::pdb::DIASession::findSymbolByAddress(), llvm::pdb::DIASession::findSymbolByRVA(), llvm::pdb::DIASession::findSymbolBySectOffset(), llvm::pdb::DIAEnumSymbols::getChildAtIndex(), llvm::pdb::DIASession::getGlobalScope(), llvm::pdb::DIAEnumSymbols::getNext(), llvm::pdb::DIASession::getSymbolById(), and llvm::pdb::SymbolCache::getSymbolById().

◆ createAs() [1/2]

template<typename ConcreteT>
std::unique_ptr< ConcreteT > llvm::pdb::PDBSymbol::createAs ( const IPDBSession & PDBSession,
IPDBRawSymbol & RawSymbol )
inlinestatic

Definition at line 95 of file PDBSymbol.h.

References create(), RawSymbol, and llvm::unique_dyn_cast_or_null().

◆ createAs() [2/2]

template<typename ConcreteT>
std::unique_ptr< ConcreteT > llvm::pdb::PDBSymbol::createAs ( const IPDBSession & PDBSession,
std::unique_ptr< IPDBRawSymbol > RawSymbol )
inlinestatic

Definition at line 89 of file PDBSymbol.h.

References create(), RawSymbol, and llvm::unique_dyn_cast_or_null().

Referenced by llvm::pdb::DIASectionContrib::getCompiland(), llvm::pdb::NativeSession::getGlobalScope(), and llvm::pdb::DIARawSymbol::getVirtualBaseTableType().

◆ defaultDump()

void PDBSymbol::defaultDump ( raw_ostream & OS,
int Indent,
PdbSymbolIdField ShowFlags,
PdbSymbolIdField RecurseFlags ) const

Definition at line 116 of file PDBSymbol.cpp.

References RawSymbol.

Referenced by dumpProperties().

◆ dump()

virtual void llvm::pdb::PDBSymbol::dump ( PDBSymDumper & Dumper) const
pure virtual

Dumps the contents of a symbol a raw_ostream.

By default this will just call dump() on the underlying RawSymbol, which allows us to discover unknown properties, but individual implementations of PDBSymbol may override the behavior to only dump known fields.

Implemented in llvm::pdb::PDBSymbolAnnotation, llvm::pdb::PDBSymbolBlock, llvm::pdb::PDBSymbolCompiland, llvm::pdb::PDBSymbolCompilandDetails, llvm::pdb::PDBSymbolCompilandEnv, llvm::pdb::PDBSymbolCustom, llvm::pdb::PDBSymbolData, llvm::pdb::PDBSymbolExe, llvm::pdb::PDBSymbolFunc, llvm::pdb::PDBSymbolFuncDebugEnd, llvm::pdb::PDBSymbolFuncDebugStart, llvm::pdb::PDBSymbolLabel, llvm::pdb::PDBSymbolPublicSymbol, llvm::pdb::PDBSymbolThunk, llvm::pdb::PDBSymbolTypeArray, llvm::pdb::PDBSymbolTypeBaseClass, llvm::pdb::PDBSymbolTypeBuiltin, llvm::pdb::PDBSymbolTypeCustom, llvm::pdb::PDBSymbolTypeDimension, llvm::pdb::PDBSymbolTypeEnum, llvm::pdb::PDBSymbolTypeFriend, llvm::pdb::PDBSymbolTypeFunctionArg, llvm::pdb::PDBSymbolTypeFunctionSig, llvm::pdb::PDBSymbolTypeManaged, llvm::pdb::PDBSymbolTypePointer, llvm::pdb::PDBSymbolTypeTypedef, llvm::pdb::PDBSymbolTypeUDT, llvm::pdb::PDBSymbolTypeVTable, llvm::pdb::PDBSymbolTypeVTableShape, and llvm::pdb::PDBSymbolUsingNamespace.

◆ dumpChildStats()

void PDBSymbol::dumpChildStats ( ) const

Definition at line 128 of file PDBSymbol.cpp.

References llvm::raw_ostream::flush(), getChildStats(), llvm::outs(), and Stats.

◆ dumpProperties()

void PDBSymbol::dumpProperties ( ) const

Definition at line 122 of file PDBSymbol.cpp.

References llvm::pdb::All, defaultDump(), llvm::raw_ostream::flush(), llvm::pdb::None, and llvm::outs().

◆ dumpRight()

virtual void llvm::pdb::PDBSymbol::dumpRight ( PDBSymDumper & Dumper) const
inlinevirtual

For certain PDBSymbolTypes, dumps additional information for the type that normally goes on the right side of the symbol.

Reimplemented in llvm::pdb::PDBSymbolTypeArray, llvm::pdb::PDBSymbolTypeFunctionSig, and llvm::pdb::PDBSymbolTypePointer.

Definition at line 111 of file PDBSymbol.h.

◆ findAllChildren() [1/3]

template<typename T>
std::unique_ptr< ConcreteSymbolEnumerator< T > > llvm::pdb::PDBSymbol::findAllChildren ( ) const
inline

Definition at line 129 of file PDBSymbol.h.

References RawSymbol.

Referenced by findAllChildren(), findOneChild(), getChildStats(), llvm::pdb::PDBSymbolCompiland::getSourceFileFullPath(), and llvm::pdb::UDTLayoutBase::initializeChildren().

◆ findAllChildren() [2/3]

std::unique_ptr< IPDBEnumSymbols > PDBSymbol::findAllChildren ( ) const

Definition at line 141 of file PDBSymbol.cpp.

References findAllChildren(), and llvm::pdb::None.

◆ findAllChildren() [3/3]

std::unique_ptr< IPDBEnumSymbols > PDBSymbol::findAllChildren ( PDB_SymType Type) const

Definition at line 146 of file PDBSymbol.cpp.

References RawSymbol, and llvm::pdb::Type.

◆ findChildren()

std::unique_ptr< IPDBEnumSymbols > PDBSymbol::findChildren ( PDB_SymType Type,
StringRef Name,
PDB_NameSearchFlags Flags ) const

Definition at line 151 of file PDBSymbol.cpp.

References RawSymbol, and llvm::pdb::Type.

◆ findChildrenByRVA()

std::unique_ptr< IPDBEnumSymbols > PDBSymbol::findChildrenByRVA ( PDB_SymType Type,
StringRef Name,
PDB_NameSearchFlags Flags,
uint32_t RVA ) const

Definition at line 157 of file PDBSymbol.cpp.

References RawSymbol, and llvm::pdb::Type.

◆ findInlineeLinesByRVA()

std::unique_ptr< IPDBEnumLineNumbers > PDBSymbol::findInlineeLinesByRVA ( uint32_t RVA,
uint32_t Length ) const

Definition at line 178 of file PDBSymbol.cpp.

References llvm::Length, and RawSymbol.

◆ findInlineeLinesByVA()

std::unique_ptr< IPDBEnumLineNumbers > PDBSymbol::findInlineeLinesByVA ( uint64_t VA,
uint32_t Length ) const

Definition at line 173 of file PDBSymbol.cpp.

References llvm::Length, and RawSymbol.

◆ findInlineFramesByRVA()

std::unique_ptr< IPDBEnumSymbols > PDBSymbol::findInlineFramesByRVA ( uint32_t RVA) const

Definition at line 168 of file PDBSymbol.cpp.

References RawSymbol.

◆ findInlineFramesByVA()

std::unique_ptr< IPDBEnumSymbols > PDBSymbol::findInlineFramesByVA ( uint64_t VA) const

Definition at line 163 of file PDBSymbol.cpp.

References RawSymbol.

◆ findOneChild()

template<typename T>
std::unique_ptr< T > llvm::pdb::PDBSymbol::findOneChild ( ) const
inline

Definition at line 121 of file PDBSymbol.h.

References llvm::Enumerator, and findAllChildren().

Referenced by llvm::pdb::PDBSymbolExe::getPointerByteSize(), and llvm::pdb::PDBSymbolCompiland::getSourceFileFullPath().

◆ getChildStats()

std::unique_ptr< IPDBEnumSymbols > PDBSymbol::getChildStats ( TagStats & Stats) const

Definition at line 185 of file PDBSymbol.cpp.

References findAllChildren(), and Stats.

Referenced by dumpChildStats().

◆ getConcreteSymbolByIdHelper()

template<typename ConcreteType>
std::unique_ptr< ConcreteType > llvm::pdb::PDBSymbol::getConcreteSymbolByIdHelper ( uint32_t Id) const
inlineprotected

Definition at line 165 of file PDBSymbol.h.

References getSymbolByIdHelper(), and llvm::unique_dyn_cast_or_null().

◆ getName()

std::string PDBSymbol::getName ( ) const

Definition at line 182 of file PDBSymbol.cpp.

References RawSymbol.

Referenced by llvm::pdb::PDBSymbolFunc::isDestructor().

◆ getRawSymbol() [1/2]

IPDBRawSymbol & llvm::pdb::PDBSymbol::getRawSymbol ( )
inline

Definition at line 155 of file PDBSymbol.h.

References RawSymbol.

◆ getRawSymbol() [2/2]

const IPDBRawSymbol & llvm::pdb::PDBSymbol::getRawSymbol ( ) const
inline

Definition at line 154 of file PDBSymbol.h.

References RawSymbol.

◆ getSession()

const IPDBSession & llvm::pdb::PDBSymbol::getSession ( ) const
inline

Definition at line 157 of file PDBSymbol.h.

References Session.

◆ getSymbolByIdHelper()

std::unique_ptr< PDBSymbol > PDBSymbol::getSymbolByIdHelper ( uint32_t Id) const
protected

Definition at line 197 of file PDBSymbol.cpp.

References Session.

Referenced by getConcreteSymbolByIdHelper().

◆ getSymIndexId()

uint32_t PDBSymbol::getSymIndexId ( ) const

Definition at line 139 of file PDBSymbol.cpp.

References RawSymbol.

◆ getSymTag()

PDB_SymType PDBSymbol::getSymTag ( ) const

Definition at line 138 of file PDBSymbol.cpp.

References RawSymbol.

Member Data Documentation

◆ OwnedRawSymbol

std::unique_ptr<IPDBRawSymbol> llvm::pdb::PDBSymbol::OwnedRawSymbol
protected

Definition at line 170 of file PDBSymbol.h.

◆ RawSymbol

IPDBRawSymbol* llvm::pdb::PDBSymbol::RawSymbol = nullptr
protected

Definition at line 171 of file PDBSymbol.h.

Referenced by create(), create(), createAs(), createAs(), defaultDump(), findAllChildren(), findAllChildren(), findChildren(), findChildrenByRVA(), findInlineeLinesByRVA(), findInlineeLinesByVA(), findInlineFramesByRVA(), findInlineFramesByVA(), llvm::pdb::PDBSymbolCompilandDetails::getBackEndVersion(), llvm::pdb::PDBSymbolData::getCompilandId(), llvm::pdb::PDBSymbolCustom::getDataBytes(), llvm::pdb::PDBSymbolCompilandDetails::getFrontEndVersion(), llvm::pdb::PDBSymbolData::getLineNumbers(), getName(), getRawSymbol(), getRawSymbol(), llvm::pdb::PDBSymbolCompiland::getSourceFileFullPath(), getSymIndexId(), getSymTag(), llvm::pdb::PDBSymbolCompilandEnv::getValue(), and PDBSymbol().

◆ Session

const IPDBSession& llvm::pdb::PDBSymbol::Session
protected

Definition at line 169 of file PDBSymbol.h.

Referenced by llvm::pdb::PDBSymbolFunc::getArguments(), llvm::pdb::PDBSymbolTypeFunctionSig::getArguments(), llvm::pdb::PDBSymbolData::getCompilandId(), llvm::pdb::PDBSymbolData::getLineNumbers(), getSession(), llvm::pdb::PDBSymbolCompiland::getSourceFileFullPath(), getSymbolByIdHelper(), PDBSymbol(), and PDBSymbol().

The documentation for this class was generated from the following files:
Generated on for LLVM by doxygen 1.14.0