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/IPDBSession.h"
14 #include "llvm/DebugInfo/PDB/PDBExtras.h"
15 #include "llvm/DebugInfo/PDB/PDBSymbolAnnotation.h"
16 #include "llvm/DebugInfo/PDB/PDBSymbolBlock.h"
17 #include "llvm/DebugInfo/PDB/PDBSymbolCompiland.h"
18 #include "llvm/DebugInfo/PDB/PDBSymbolCompilandDetails.h"
19 #include "llvm/DebugInfo/PDB/PDBSymbolCompilandEnv.h"
20 #include "llvm/DebugInfo/PDB/PDBSymbolCustom.h"
21 #include "llvm/DebugInfo/PDB/PDBSymbolData.h"
22 #include "llvm/DebugInfo/PDB/PDBSymbolExe.h"
23 #include "llvm/DebugInfo/PDB/PDBSymbolFunc.h"
24 #include "llvm/DebugInfo/PDB/PDBSymbolFuncDebugEnd.h"
25 #include "llvm/DebugInfo/PDB/PDBSymbolFuncDebugStart.h"
26 #include "llvm/DebugInfo/PDB/PDBSymbolLabel.h"
27 #include "llvm/DebugInfo/PDB/PDBSymbolPublicSymbol.h"
28 #include "llvm/DebugInfo/PDB/PDBSymbolThunk.h"
29 #include "llvm/DebugInfo/PDB/PDBSymbolTypeArray.h"
30 #include "llvm/DebugInfo/PDB/PDBSymbolTypeBaseClass.h"
31 #include "llvm/DebugInfo/PDB/PDBSymbolTypeBuiltin.h"
32 #include "llvm/DebugInfo/PDB/PDBSymbolTypeCustom.h"
33 #include "llvm/DebugInfo/PDB/PDBSymbolTypeDimension.h"
34 #include "llvm/DebugInfo/PDB/PDBSymbolTypeEnum.h"
35 #include "llvm/DebugInfo/PDB/PDBSymbolTypeFriend.h"
36 #include "llvm/DebugInfo/PDB/PDBSymbolTypeFunctionArg.h"
37 #include "llvm/DebugInfo/PDB/PDBSymbolTypeFunctionSig.h"
38 #include "llvm/DebugInfo/PDB/PDBSymbolTypeManaged.h"
39 #include "llvm/DebugInfo/PDB/PDBSymbolTypePointer.h"
40 #include "llvm/DebugInfo/PDB/PDBSymbolTypeTypedef.h"
41 #include "llvm/DebugInfo/PDB/PDBSymbolTypeUDT.h"
42 #include "llvm/DebugInfo/PDB/PDBSymbolTypeVTable.h"
43 #include "llvm/DebugInfo/PDB/PDBSymbolTypeVTableShape.h"
44 #include "llvm/DebugInfo/PDB/PDBSymbolUnknown.h"
45 #include "llvm/DebugInfo/PDB/PDBSymbolUsingNamespace.h"
46 #include "llvm/DebugInfo/PDB/PDBTypes.h"
47 #include <algorithm>
48 #include <memory>
49 
50 using namespace llvm;
51 using namespace llvm::pdb;
52 
53 PDBSymbol::PDBSymbol(const IPDBSession &PDBSession) : Session(PDBSession) {}
54 
55 PDBSymbol::PDBSymbol(PDBSymbol &&Other)
56     : Session(Other.Session), RawSymbol(std::move(Other.RawSymbol)) {}
57 
58 PDBSymbol::~PDBSymbol() = default;
59 
60 #define FACTORY_SYMTAG_CASE(Tag, Type)                                         \
61   case PDB_SymType::Tag:                                                       \
62     return std::unique_ptr<PDBSymbol>(new Type(PDBSession));
63 
64 std::unique_ptr<PDBSymbol>
65 PDBSymbol::createSymbol(const IPDBSession &PDBSession, PDB_SymType Tag) {
66   switch (Tag) {
67     FACTORY_SYMTAG_CASE(Exe, PDBSymbolExe)
68     FACTORY_SYMTAG_CASE(Compiland, PDBSymbolCompiland)
69     FACTORY_SYMTAG_CASE(CompilandDetails, PDBSymbolCompilandDetails)
70     FACTORY_SYMTAG_CASE(CompilandEnv, PDBSymbolCompilandEnv)
71     FACTORY_SYMTAG_CASE(Function, PDBSymbolFunc)
72     FACTORY_SYMTAG_CASE(Block, PDBSymbolBlock)
73     FACTORY_SYMTAG_CASE(Data, PDBSymbolData)
74     FACTORY_SYMTAG_CASE(Annotation, PDBSymbolAnnotation)
75     FACTORY_SYMTAG_CASE(Label, PDBSymbolLabel)
76     FACTORY_SYMTAG_CASE(PublicSymbol, PDBSymbolPublicSymbol)
77     FACTORY_SYMTAG_CASE(UDT, PDBSymbolTypeUDT)
78     FACTORY_SYMTAG_CASE(Enum, PDBSymbolTypeEnum)
79     FACTORY_SYMTAG_CASE(FunctionSig, PDBSymbolTypeFunctionSig)
80     FACTORY_SYMTAG_CASE(PointerType, PDBSymbolTypePointer)
81     FACTORY_SYMTAG_CASE(ArrayType, PDBSymbolTypeArray)
82     FACTORY_SYMTAG_CASE(BuiltinType, PDBSymbolTypeBuiltin)
83     FACTORY_SYMTAG_CASE(Typedef, PDBSymbolTypeTypedef)
84     FACTORY_SYMTAG_CASE(BaseClass, PDBSymbolTypeBaseClass)
85     FACTORY_SYMTAG_CASE(Friend, PDBSymbolTypeFriend)
86     FACTORY_SYMTAG_CASE(FunctionArg, PDBSymbolTypeFunctionArg)
87     FACTORY_SYMTAG_CASE(FuncDebugStart, PDBSymbolFuncDebugStart)
88     FACTORY_SYMTAG_CASE(FuncDebugEnd, PDBSymbolFuncDebugEnd)
89     FACTORY_SYMTAG_CASE(UsingNamespace, PDBSymbolUsingNamespace)
90     FACTORY_SYMTAG_CASE(VTableShape, PDBSymbolTypeVTableShape)
91     FACTORY_SYMTAG_CASE(VTable, PDBSymbolTypeVTable)
92     FACTORY_SYMTAG_CASE(Custom, PDBSymbolCustom)
93     FACTORY_SYMTAG_CASE(Thunk, PDBSymbolThunk)
94     FACTORY_SYMTAG_CASE(CustomType, PDBSymbolTypeCustom)
95     FACTORY_SYMTAG_CASE(ManagedType, PDBSymbolTypeManaged)
96     FACTORY_SYMTAG_CASE(Dimension, PDBSymbolTypeDimension)
97   default:
98     return std::unique_ptr<PDBSymbol>(new PDBSymbolUnknown(PDBSession));
99   }
100 }
101 
102 std::unique_ptr<PDBSymbol>
103 PDBSymbol::create(const IPDBSession &PDBSession,
104                   std::unique_ptr<IPDBRawSymbol> RawSymbol) {
105   auto SymbolPtr = createSymbol(PDBSession, RawSymbol->getSymTag());
106   SymbolPtr->RawSymbol = RawSymbol.get();
107   SymbolPtr->OwnedRawSymbol = std::move(RawSymbol);
108   return SymbolPtr;
109 }
110 
111 std::unique_ptr<PDBSymbol> PDBSymbol::create(const IPDBSession &PDBSession,
112                                              IPDBRawSymbol &RawSymbol) {
113   auto SymbolPtr = createSymbol(PDBSession, RawSymbol.getSymTag());
114   SymbolPtr->RawSymbol = &RawSymbol;
115   return SymbolPtr;
116 }
117 
118 void PDBSymbol::defaultDump(raw_ostream &OS, int Indent,
119                             PdbSymbolIdField ShowFlags,
120                             PdbSymbolIdField RecurseFlags) const {
121   RawSymbol->dump(OS, Indent, ShowFlags, RecurseFlags);
122 }
123 
124 void PDBSymbol::dumpProperties() const {
125   outs() << "\n";
126   defaultDump(outs(), 0, PdbSymbolIdField::All, PdbSymbolIdField::None);
127   outs().flush();
128 }
129 
130 void PDBSymbol::dumpChildStats() const {
131   TagStats Stats;
132   getChildStats(Stats);
133   outs() << "\n";
134   for (auto &Stat : Stats) {
135     outs() << Stat.first << ": " << Stat.second << "\n";
136   }
137   outs().flush();
138 }
139 
140 PDB_SymType PDBSymbol::getSymTag() const { return RawSymbol->getSymTag(); }
141 uint32_t PDBSymbol::getSymIndexId() const { return RawSymbol->getSymIndexId(); }
142 
143 std::unique_ptr<IPDBEnumSymbols> PDBSymbol::findAllChildren() const {
144   return findAllChildren(PDB_SymType::None);
145 }
146 
147 std::unique_ptr<IPDBEnumSymbols>
148 PDBSymbol::findAllChildren(PDB_SymType Type) const {
149   return RawSymbol->findChildren(Type);
150 }
151 
152 std::unique_ptr<IPDBEnumSymbols>
153 PDBSymbol::findChildren(PDB_SymType Type, StringRef Name,
154                         PDB_NameSearchFlags Flags) const {
155   return RawSymbol->findChildren(Type, Name, Flags);
156 }
157 
158 std::unique_ptr<IPDBEnumSymbols>
159 PDBSymbol::findChildrenByRVA(PDB_SymType Type, StringRef Name,
160                              PDB_NameSearchFlags Flags, uint32_t RVA) const {
161   return RawSymbol->findChildrenByRVA(Type, Name, Flags, RVA);
162 }
163 
164 std::unique_ptr<IPDBEnumSymbols>
165 PDBSymbol::findInlineFramesByRVA(uint32_t RVA) const {
166   return RawSymbol->findInlineFramesByRVA(RVA);
167 }
168 
169 std::unique_ptr<IPDBEnumSymbols>
170 PDBSymbol::getChildStats(TagStats &Stats) const {
171   std::unique_ptr<IPDBEnumSymbols> Result(findAllChildren());
172   if (!Result)
173     return nullptr;
174   Stats.clear();
175   while (auto Child = Result->getNext()) {
176     ++Stats[Child->getSymTag()];
177   }
178   Result->reset();
179   return Result;
180 }
181 
182 std::unique_ptr<PDBSymbol> PDBSymbol::getSymbolByIdHelper(uint32_t Id) const {
183   return Session.getSymbolById(Id);
184 }
185 
186 void llvm::pdb::dumpSymbolIdField(raw_ostream &OS, StringRef Name,
187                                   SymIndexId Value, int Indent,
188                                   const IPDBSession &Session,
189                                   PdbSymbolIdField FieldId,
190                                   PdbSymbolIdField ShowFlags,
191                                   PdbSymbolIdField RecurseFlags) {
192   if ((FieldId & ShowFlags) == PdbSymbolIdField::None)
193     return;
194 
195   OS << "\n";
196   OS.indent(Indent);
197   OS << Name << ": " << Value;
198   // Don't recurse unless the user requested it.
199   if ((FieldId & RecurseFlags) == PdbSymbolIdField::None)
200     return;
201   // And obviously don't recurse on the symbol itself.
202   if (FieldId == PdbSymbolIdField::SymIndexId)
203     return;
204 
205   auto Child = Session.getSymbolById(Value);
206 
207   // It could have been a placeholder symbol for a type we don't yet support,
208   // so just exit in that case.
209   if (!Child)
210     return;
211 
212   // Don't recurse more than once, so pass PdbSymbolIdField::None) for the
213   // recurse flags.
214   Child->defaultDump(OS, Indent + 2, ShowFlags, PdbSymbolIdField::None);
215 }
216