1 //===- PDBSymbol.cpp - base class for user-facing symbol types --*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #include "llvm/DebugInfo/PDB/PDBSymbol.h"
11 #include "llvm/DebugInfo/PDB/IPDBEnumChildren.h"
12 #include "llvm/DebugInfo/PDB/IPDBRawSymbol.h"
13 #include "llvm/DebugInfo/PDB/PDBExtras.h"
14 #include "llvm/DebugInfo/PDB/PDBSymbolAnnotation.h"
15 #include "llvm/DebugInfo/PDB/PDBSymbolBlock.h"
16 #include "llvm/DebugInfo/PDB/PDBSymbolCompiland.h"
17 #include "llvm/DebugInfo/PDB/PDBSymbolCompilandDetails.h"
18 #include "llvm/DebugInfo/PDB/PDBSymbolCompilandEnv.h"
19 #include "llvm/DebugInfo/PDB/PDBSymbolCustom.h"
20 #include "llvm/DebugInfo/PDB/PDBSymbolData.h"
21 #include "llvm/DebugInfo/PDB/PDBSymbolExe.h"
22 #include "llvm/DebugInfo/PDB/PDBSymbolFunc.h"
23 #include "llvm/DebugInfo/PDB/PDBSymbolFuncDebugEnd.h"
24 #include "llvm/DebugInfo/PDB/PDBSymbolFuncDebugStart.h"
25 #include "llvm/DebugInfo/PDB/PDBSymbolLabel.h"
26 #include "llvm/DebugInfo/PDB/PDBSymbolPublicSymbol.h"
27 #include "llvm/DebugInfo/PDB/PDBSymbolThunk.h"
28 #include "llvm/DebugInfo/PDB/PDBSymbolTypeArray.h"
29 #include "llvm/DebugInfo/PDB/PDBSymbolTypeBaseClass.h"
30 #include "llvm/DebugInfo/PDB/PDBSymbolTypeBuiltin.h"
31 #include "llvm/DebugInfo/PDB/PDBSymbolTypeCustom.h"
32 #include "llvm/DebugInfo/PDB/PDBSymbolTypeDimension.h"
33 #include "llvm/DebugInfo/PDB/PDBSymbolTypeEnum.h"
34 #include "llvm/DebugInfo/PDB/PDBSymbolTypeFriend.h"
35 #include "llvm/DebugInfo/PDB/PDBSymbolTypeFunctionArg.h"
36 #include "llvm/DebugInfo/PDB/PDBSymbolTypeFunctionSig.h"
37 #include "llvm/DebugInfo/PDB/PDBSymbolTypeManaged.h"
38 #include "llvm/DebugInfo/PDB/PDBSymbolTypePointer.h"
39 #include "llvm/DebugInfo/PDB/PDBSymbolTypeTypedef.h"
40 #include "llvm/DebugInfo/PDB/PDBSymbolTypeUDT.h"
41 #include "llvm/DebugInfo/PDB/PDBSymbolTypeVTable.h"
42 #include "llvm/DebugInfo/PDB/PDBSymbolTypeVTableShape.h"
43 #include "llvm/DebugInfo/PDB/PDBSymbolUnknown.h"
44 #include "llvm/DebugInfo/PDB/PDBSymbolUsingNamespace.h"
45 #include "llvm/DebugInfo/PDB/PDBTypes.h"
46 #include <algorithm>
47 #include <memory>
48 
49 using namespace llvm;
50 using namespace llvm::pdb;
51 
52 PDBSymbol::PDBSymbol(const IPDBSession &PDBSession,
53                      std::unique_ptr<IPDBRawSymbol> Symbol)
54     : Session(PDBSession), RawSymbol(std::move(Symbol)) {}
55 
56 PDBSymbol::~PDBSymbol() = default;
57 
58 #define FACTORY_SYMTAG_CASE(Tag, Type)                                         \
59   case PDB_SymType::Tag:                                                       \
60     return std::unique_ptr<PDBSymbol>(new Type(PDBSession, std::move(Symbol)));
61 
62 std::unique_ptr<PDBSymbol>
63 PDBSymbol::create(const IPDBSession &PDBSession,
64                   std::unique_ptr<IPDBRawSymbol> Symbol) {
65   switch (Symbol->getSymTag()) {
66     FACTORY_SYMTAG_CASE(Exe, PDBSymbolExe)
67     FACTORY_SYMTAG_CASE(Compiland, PDBSymbolCompiland)
68     FACTORY_SYMTAG_CASE(CompilandDetails, PDBSymbolCompilandDetails)
69     FACTORY_SYMTAG_CASE(CompilandEnv, PDBSymbolCompilandEnv)
70     FACTORY_SYMTAG_CASE(Function, PDBSymbolFunc)
71     FACTORY_SYMTAG_CASE(Block, PDBSymbolBlock)
72     FACTORY_SYMTAG_CASE(Data, PDBSymbolData)
73     FACTORY_SYMTAG_CASE(Annotation, PDBSymbolAnnotation)
74     FACTORY_SYMTAG_CASE(Label, PDBSymbolLabel)
75     FACTORY_SYMTAG_CASE(PublicSymbol, PDBSymbolPublicSymbol)
76     FACTORY_SYMTAG_CASE(UDT, PDBSymbolTypeUDT)
77     FACTORY_SYMTAG_CASE(Enum, PDBSymbolTypeEnum)
78     FACTORY_SYMTAG_CASE(FunctionSig, PDBSymbolTypeFunctionSig)
79     FACTORY_SYMTAG_CASE(PointerType, PDBSymbolTypePointer)
80     FACTORY_SYMTAG_CASE(ArrayType, PDBSymbolTypeArray)
81     FACTORY_SYMTAG_CASE(BuiltinType, PDBSymbolTypeBuiltin)
82     FACTORY_SYMTAG_CASE(Typedef, PDBSymbolTypeTypedef)
83     FACTORY_SYMTAG_CASE(BaseClass, PDBSymbolTypeBaseClass)
84     FACTORY_SYMTAG_CASE(Friend, PDBSymbolTypeFriend)
85     FACTORY_SYMTAG_CASE(FunctionArg, PDBSymbolTypeFunctionArg)
86     FACTORY_SYMTAG_CASE(FuncDebugStart, PDBSymbolFuncDebugStart)
87     FACTORY_SYMTAG_CASE(FuncDebugEnd, PDBSymbolFuncDebugEnd)
88     FACTORY_SYMTAG_CASE(UsingNamespace, PDBSymbolUsingNamespace)
89     FACTORY_SYMTAG_CASE(VTableShape, PDBSymbolTypeVTableShape)
90     FACTORY_SYMTAG_CASE(VTable, PDBSymbolTypeVTable)
91     FACTORY_SYMTAG_CASE(Custom, PDBSymbolCustom)
92     FACTORY_SYMTAG_CASE(Thunk, PDBSymbolThunk)
93     FACTORY_SYMTAG_CASE(CustomType, PDBSymbolTypeCustom)
94     FACTORY_SYMTAG_CASE(ManagedType, PDBSymbolTypeManaged)
95     FACTORY_SYMTAG_CASE(Dimension, PDBSymbolTypeDimension)
96   default:
97     return std::unique_ptr<PDBSymbol>(
98         new PDBSymbolUnknown(PDBSession, std::move(Symbol)));
99   }
100 }
101 
102 #define TRY_DUMP_TYPE(Type)                                                    \
103   if (const Type *DerivedThis = dyn_cast<Type>(this))                          \
104     Dumper.dump(OS, Indent, *DerivedThis);
105 
106 #define ELSE_TRY_DUMP_TYPE(Type, Dumper) else TRY_DUMP_TYPE(Type, Dumper)
107 
108 void PDBSymbol::defaultDump(raw_ostream &OS, int Indent) const {
109   RawSymbol->dump(OS, Indent);
110 }
111 
112 PDB_SymType PDBSymbol::getSymTag() const { return RawSymbol->getSymTag(); }
113 uint32_t PDBSymbol::getSymIndexId() const { return RawSymbol->getSymIndexId(); }
114 
115 std::unique_ptr<IPDBEnumSymbols> PDBSymbol::findAllChildren() const {
116   return findAllChildren(PDB_SymType::None);
117 }
118 
119 std::unique_ptr<IPDBEnumSymbols>
120 PDBSymbol::findAllChildren(PDB_SymType Type) const {
121   return RawSymbol->findChildren(Type);
122 }
123 
124 std::unique_ptr<IPDBEnumSymbols>
125 PDBSymbol::findChildren(PDB_SymType Type, StringRef Name,
126                         PDB_NameSearchFlags Flags) const {
127   return RawSymbol->findChildren(Type, Name, Flags);
128 }
129 
130 std::unique_ptr<IPDBEnumSymbols>
131 PDBSymbol::findChildrenByRVA(PDB_SymType Type, StringRef Name,
132                              PDB_NameSearchFlags Flags, uint32_t RVA) const {
133   return RawSymbol->findChildrenByRVA(Type, Name, Flags, RVA);
134 }
135 
136 std::unique_ptr<IPDBEnumSymbols>
137 PDBSymbol::findInlineFramesByRVA(uint32_t RVA) const {
138   return RawSymbol->findInlineFramesByRVA(RVA);
139 }
140 
141 std::unique_ptr<IPDBEnumSymbols>
142 PDBSymbol::getChildStats(TagStats &Stats) const {
143   std::unique_ptr<IPDBEnumSymbols> Result(findAllChildren());
144   Stats.clear();
145   while (auto Child = Result->getNext()) {
146     ++Stats[Child->getSymTag()];
147   }
148   Result->reset();
149   return Result;
150 }
151