1 //===- PDBSymbol.cpp - base class for user-facing symbol types --*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "llvm/DebugInfo/PDB/IPDBEnumChildren.h"
11 #include "llvm/DebugInfo/PDB/IPDBRawSymbol.h"
12 #include "llvm/DebugInfo/PDB/PDBSymbol.h"
13 #include "llvm/DebugInfo/PDB/PDBSymbolAnnotation.h"
14 #include "llvm/DebugInfo/PDB/PDBSymbolBlock.h"
15 #include "llvm/DebugInfo/PDB/PDBSymbolCompiland.h"
16 #include "llvm/DebugInfo/PDB/PDBSymbolCompilandDetails.h"
17 #include "llvm/DebugInfo/PDB/PDBSymbolCompilandEnv.h"
18 #include "llvm/DebugInfo/PDB/PDBSymbolCustom.h"
19 #include "llvm/DebugInfo/PDB/PDBSymbolData.h"
20 #include "llvm/DebugInfo/PDB/PDBSymbolExe.h"
21 #include "llvm/DebugInfo/PDB/PDBSymbolFunc.h"
22 #include "llvm/DebugInfo/PDB/PDBSymbolFuncDebugEnd.h"
23 #include "llvm/DebugInfo/PDB/PDBSymbolFuncDebugStart.h"
24 #include "llvm/DebugInfo/PDB/PDBSymbolLabel.h"
25 #include "llvm/DebugInfo/PDB/PDBSymbolPublicSymbol.h"
26 #include "llvm/DebugInfo/PDB/PDBSymbolThunk.h"
27 #include "llvm/DebugInfo/PDB/PDBSymbolTypeArray.h"
28 #include "llvm/DebugInfo/PDB/PDBSymbolTypeBaseClass.h"
29 #include "llvm/DebugInfo/PDB/PDBSymbolTypeBuiltin.h"
30 #include "llvm/DebugInfo/PDB/PDBSymbolTypeCustom.h"
31 #include "llvm/DebugInfo/PDB/PDBSymbolTypeDimension.h"
32 #include "llvm/DebugInfo/PDB/PDBSymbolTypeEnum.h"
33 #include "llvm/DebugInfo/PDB/PDBSymbolTypeFriend.h"
34 #include "llvm/DebugInfo/PDB/PDBSymbolTypeFunctionArg.h"
35 #include "llvm/DebugInfo/PDB/PDBSymbolTypeFunctionSig.h"
36 #include "llvm/DebugInfo/PDB/PDBSymbolTypeManaged.h"
37 #include "llvm/DebugInfo/PDB/PDBSymbolTypePointer.h"
38 #include "llvm/DebugInfo/PDB/PDBSymbolTypeTypedef.h"
39 #include "llvm/DebugInfo/PDB/PDBSymbolTypeUDT.h"
40 #include "llvm/DebugInfo/PDB/PDBSymbolTypeVTable.h"
41 #include "llvm/DebugInfo/PDB/PDBSymbolTypeVTableShape.h"
42 #include "llvm/DebugInfo/PDB/PDBSymbolUnknown.h"
43 #include "llvm/DebugInfo/PDB/PDBSymbolUsingNamespace.h"
49 PDBSymbol::PDBSymbol(const IPDBSession &PDBSession,
50 std::unique_ptr<IPDBRawSymbol> Symbol)
51 : Session(PDBSession), RawSymbol(std::move(Symbol)) {}
53 PDBSymbol::~PDBSymbol() {}
55 #define FACTORY_SYMTAG_CASE(Tag, Type) \
56 case PDB_SymType::Tag: \
57 return std::unique_ptr<PDBSymbol>(new Type(PDBSession, std::move(Symbol)));
59 std::unique_ptr<PDBSymbol>
60 PDBSymbol::create(const IPDBSession &PDBSession,
61 std::unique_ptr<IPDBRawSymbol> Symbol) {
62 switch (Symbol->getSymTag()) {
63 FACTORY_SYMTAG_CASE(Exe, PDBSymbolExe)
64 FACTORY_SYMTAG_CASE(Compiland, PDBSymbolCompiland)
65 FACTORY_SYMTAG_CASE(CompilandDetails, PDBSymbolCompilandDetails)
66 FACTORY_SYMTAG_CASE(CompilandEnv, PDBSymbolCompilandEnv)
67 FACTORY_SYMTAG_CASE(Function, PDBSymbolFunc)
68 FACTORY_SYMTAG_CASE(Block, PDBSymbolBlock)
69 FACTORY_SYMTAG_CASE(Data, PDBSymbolData)
70 FACTORY_SYMTAG_CASE(Annotation, PDBSymbolAnnotation)
71 FACTORY_SYMTAG_CASE(Label, PDBSymbolLabel)
72 FACTORY_SYMTAG_CASE(PublicSymbol, PDBSymbolPublicSymbol)
73 FACTORY_SYMTAG_CASE(UDT, PDBSymbolTypeUDT)
74 FACTORY_SYMTAG_CASE(Enum, PDBSymbolTypeEnum)
75 FACTORY_SYMTAG_CASE(FunctionSig, PDBSymbolTypeFunctionSig)
76 FACTORY_SYMTAG_CASE(PointerType, PDBSymbolTypePointer)
77 FACTORY_SYMTAG_CASE(ArrayType, PDBSymbolTypeArray)
78 FACTORY_SYMTAG_CASE(BuiltinType, PDBSymbolTypeBuiltin)
79 FACTORY_SYMTAG_CASE(Typedef, PDBSymbolTypeTypedef)
80 FACTORY_SYMTAG_CASE(BaseClass, PDBSymbolTypeBaseClass)
81 FACTORY_SYMTAG_CASE(Friend, PDBSymbolTypeFriend)
82 FACTORY_SYMTAG_CASE(FunctionArg, PDBSymbolTypeFunctionArg)
83 FACTORY_SYMTAG_CASE(FuncDebugStart, PDBSymbolFuncDebugStart)
84 FACTORY_SYMTAG_CASE(FuncDebugEnd, PDBSymbolFuncDebugEnd)
85 FACTORY_SYMTAG_CASE(UsingNamespace, PDBSymbolUsingNamespace)
86 FACTORY_SYMTAG_CASE(VTableShape, PDBSymbolTypeVTableShape)
87 FACTORY_SYMTAG_CASE(VTable, PDBSymbolTypeVTable)
88 FACTORY_SYMTAG_CASE(Custom, PDBSymbolCustom)
89 FACTORY_SYMTAG_CASE(Thunk, PDBSymbolThunk)
90 FACTORY_SYMTAG_CASE(CustomType, PDBSymbolTypeCustom)
91 FACTORY_SYMTAG_CASE(ManagedType, PDBSymbolTypeManaged)
92 FACTORY_SYMTAG_CASE(Dimension, PDBSymbolTypeDimension)
94 return std::unique_ptr<PDBSymbol>(
95 new PDBSymbolUnknown(PDBSession, std::move(Symbol)));
99 void PDBSymbol::defaultDump(raw_ostream &OS, int Indent,
100 PDB_DumpLevel Level) const {
101 RawSymbol->dump(OS, Indent, Level);
104 PDB_SymType PDBSymbol::getSymTag() const { return RawSymbol->getSymTag(); }
106 std::unique_ptr<IPDBEnumSymbols> PDBSymbol::findAllChildren() const {
107 return RawSymbol->findChildren(PDB_SymType::None);
110 std::unique_ptr<IPDBEnumSymbols>
111 PDBSymbol::findChildren(PDB_SymType Type, StringRef Name,
112 PDB_NameSearchFlags Flags) const {
113 return RawSymbol->findChildren(Type, Name, Flags);
116 std::unique_ptr<IPDBEnumSymbols>
117 PDBSymbol::findChildrenByRVA(PDB_SymType Type, StringRef Name,
118 PDB_NameSearchFlags Flags, uint32_t RVA) const {
119 return RawSymbol->findChildrenByRVA(Type, Name, Flags, RVA);
122 std::unique_ptr<IPDBEnumSymbols>
123 PDBSymbol::findInlineFramesByRVA(uint32_t RVA) const {
124 return RawSymbol->findInlineFramesByRVA(RVA);
127 std::unique_ptr<IPDBEnumSymbols>
128 PDBSymbol::getChildStats(TagStats &Stats) const {
129 std::unique_ptr<IPDBEnumSymbols> Result(findAllChildren());
131 while (auto Child = Result->getNext()) {
132 ++Stats[Child->getSymTag()];