1//===- PDBSymbol.cpp - base class for user-facing symbol types --*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#include "llvm/DebugInfo/PDB/PDBSymbol.h"
10#include "llvm/DebugInfo/PDB/IPDBEnumChildren.h"
11#include "llvm/DebugInfo/PDB/IPDBRawSymbol.h"
12#include "llvm/DebugInfo/PDB/IPDBSession.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 <memory>
47
48using namespace llvm;
49using namespace llvm::pdb;
50
51PDBSymbol::PDBSymbol(const IPDBSession &PDBSession) : Session(PDBSession) {}
52
53PDBSymbol::PDBSymbol(PDBSymbol &&Other)
54 : Session(Other.Session), RawSymbol(std::move(Other.RawSymbol)) {}
55
56PDBSymbol::~PDBSymbol() = default;
57
58#define FACTORY_SYMTAG_CASE(Tag, Type) \
59 case PDB_SymType::Tag: \
60 return std::unique_ptr<PDBSymbol>(new Type(PDBSession));
61
62std::unique_ptr<PDBSymbol>
63PDBSymbol::createSymbol(const IPDBSession &PDBSession, PDB_SymType Tag) {
64 switch (Tag) {
65 FACTORY_SYMTAG_CASE(Exe, PDBSymbolExe)
66 FACTORY_SYMTAG_CASE(Compiland, PDBSymbolCompiland)
67 FACTORY_SYMTAG_CASE(CompilandDetails, PDBSymbolCompilandDetails)
68 FACTORY_SYMTAG_CASE(CompilandEnv, PDBSymbolCompilandEnv)
69 FACTORY_SYMTAG_CASE(Function, PDBSymbolFunc)
70 FACTORY_SYMTAG_CASE(Block, PDBSymbolBlock)
71 FACTORY_SYMTAG_CASE(Data, PDBSymbolData)
72 FACTORY_SYMTAG_CASE(Annotation, PDBSymbolAnnotation)
73 FACTORY_SYMTAG_CASE(Label, PDBSymbolLabel)
74 FACTORY_SYMTAG_CASE(PublicSymbol, PDBSymbolPublicSymbol)
75 FACTORY_SYMTAG_CASE(UDT, PDBSymbolTypeUDT)
76 FACTORY_SYMTAG_CASE(Enum, PDBSymbolTypeEnum)
77 FACTORY_SYMTAG_CASE(FunctionSig, PDBSymbolTypeFunctionSig)
78 FACTORY_SYMTAG_CASE(PointerType, PDBSymbolTypePointer)
79 FACTORY_SYMTAG_CASE(ArrayType, PDBSymbolTypeArray)
80 FACTORY_SYMTAG_CASE(BuiltinType, PDBSymbolTypeBuiltin)
81 FACTORY_SYMTAG_CASE(Typedef, PDBSymbolTypeTypedef)
82 FACTORY_SYMTAG_CASE(BaseClass, PDBSymbolTypeBaseClass)
83 FACTORY_SYMTAG_CASE(Friend, PDBSymbolTypeFriend)
84 FACTORY_SYMTAG_CASE(FunctionArg, PDBSymbolTypeFunctionArg)
85 FACTORY_SYMTAG_CASE(FuncDebugStart, PDBSymbolFuncDebugStart)
86 FACTORY_SYMTAG_CASE(FuncDebugEnd, PDBSymbolFuncDebugEnd)
87 FACTORY_SYMTAG_CASE(UsingNamespace, PDBSymbolUsingNamespace)
88 FACTORY_SYMTAG_CASE(VTableShape, PDBSymbolTypeVTableShape)
89 FACTORY_SYMTAG_CASE(VTable, PDBSymbolTypeVTable)
90 FACTORY_SYMTAG_CASE(Custom, PDBSymbolCustom)
91 FACTORY_SYMTAG_CASE(Thunk, PDBSymbolThunk)
92 FACTORY_SYMTAG_CASE(CustomType, PDBSymbolTypeCustom)
93 FACTORY_SYMTAG_CASE(ManagedType, PDBSymbolTypeManaged)
94 FACTORY_SYMTAG_CASE(Dimension, PDBSymbolTypeDimension)
95 default:
96 return std::unique_ptr<PDBSymbol>(new PDBSymbolUnknown(PDBSession));
97 }
98}
99
100std::unique_ptr<PDBSymbol>
101PDBSymbol::create(const IPDBSession &PDBSession,
102 std::unique_ptr<IPDBRawSymbol> RawSymbol) {
103 auto SymbolPtr = createSymbol(PDBSession, Tag: RawSymbol->getSymTag());
104 SymbolPtr->RawSymbol = RawSymbol.get();
105 SymbolPtr->OwnedRawSymbol = std::move(RawSymbol);
106 return SymbolPtr;
107}
108
109std::unique_ptr<PDBSymbol> PDBSymbol::create(const IPDBSession &PDBSession,
110 IPDBRawSymbol &RawSymbol) {
111 auto SymbolPtr = createSymbol(PDBSession, Tag: RawSymbol.getSymTag());
112 SymbolPtr->RawSymbol = &RawSymbol;
113 return SymbolPtr;
114}
115
116void PDBSymbol::defaultDump(raw_ostream &OS, int Indent,
117 PdbSymbolIdField ShowFlags,
118 PdbSymbolIdField RecurseFlags) const {
119 RawSymbol->dump(OS, Indent, ShowIdFields: ShowFlags, RecurseIdFields: RecurseFlags);
120}
121
122void PDBSymbol::dumpProperties() const {
123 outs() << "\n";
124 defaultDump(OS&: outs(), Indent: 0, ShowFlags: PdbSymbolIdField::All, RecurseFlags: PdbSymbolIdField::None);
125 outs().flush();
126}
127
128void PDBSymbol::dumpChildStats() const {
129 TagStats Stats;
130 getChildStats(Stats);
131 outs() << "\n";
132 for (auto &Stat : Stats) {
133 outs() << Stat.first << ": " << Stat.second << "\n";
134 }
135 outs().flush();
136}
137
138PDB_SymType PDBSymbol::getSymTag() const { return RawSymbol->getSymTag(); }
139uint32_t PDBSymbol::getSymIndexId() const { return RawSymbol->getSymIndexId(); }
140
141std::unique_ptr<IPDBEnumSymbols> PDBSymbol::findAllChildren() const {
142 return findAllChildren(Type: PDB_SymType::None);
143}
144
145std::unique_ptr<IPDBEnumSymbols>
146PDBSymbol::findAllChildren(PDB_SymType Type) const {
147 return RawSymbol->findChildren(Type);
148}
149
150std::unique_ptr<IPDBEnumSymbols>
151PDBSymbol::findChildren(PDB_SymType Type, StringRef Name,
152 PDB_NameSearchFlags Flags) const {
153 return RawSymbol->findChildren(Type, Name, Flags);
154}
155
156std::unique_ptr<IPDBEnumSymbols>
157PDBSymbol::findChildrenByRVA(PDB_SymType Type, StringRef Name,
158 PDB_NameSearchFlags Flags, uint32_t RVA) const {
159 return RawSymbol->findChildrenByRVA(Type, Name, Flags, RVA);
160}
161
162std::unique_ptr<IPDBEnumSymbols>
163PDBSymbol::findInlineFramesByVA(uint64_t VA) const {
164 return RawSymbol->findInlineFramesByVA(VA);
165}
166
167std::unique_ptr<IPDBEnumSymbols>
168PDBSymbol::findInlineFramesByRVA(uint32_t RVA) const {
169 return RawSymbol->findInlineFramesByRVA(RVA);
170}
171
172std::unique_ptr<IPDBEnumLineNumbers>
173PDBSymbol::findInlineeLinesByVA(uint64_t VA, uint32_t Length) const {
174 return RawSymbol->findInlineeLinesByVA(VA, Length);
175}
176
177std::unique_ptr<IPDBEnumLineNumbers>
178PDBSymbol::findInlineeLinesByRVA(uint32_t RVA, uint32_t Length) const {
179 return RawSymbol->findInlineeLinesByRVA(RVA, Length);
180}
181
182std::string PDBSymbol::getName() const { return RawSymbol->getName(); }
183
184std::unique_ptr<IPDBEnumSymbols>
185PDBSymbol::getChildStats(TagStats &Stats) const {
186 std::unique_ptr<IPDBEnumSymbols> Result(findAllChildren());
187 if (!Result)
188 return nullptr;
189 Stats.clear();
190 while (auto Child = Result->getNext()) {
191 ++Stats[Child->getSymTag()];
192 }
193 Result->reset();
194 return Result;
195}
196
197std::unique_ptr<PDBSymbol> PDBSymbol::getSymbolByIdHelper(uint32_t Id) const {
198 return Session.getSymbolById(SymbolId: Id);
199}
200
201void llvm::pdb::dumpSymbolIdField(raw_ostream &OS, StringRef Name,
202 SymIndexId Value, int Indent,
203 const IPDBSession &Session,
204 PdbSymbolIdField FieldId,
205 PdbSymbolIdField ShowFlags,
206 PdbSymbolIdField RecurseFlags) {
207 if ((FieldId & ShowFlags) == PdbSymbolIdField::None)
208 return;
209
210 OS << "\n";
211 OS.indent(NumSpaces: Indent);
212 OS << Name << ": " << Value;
213 // Don't recurse unless the user requested it.
214 if ((FieldId & RecurseFlags) == PdbSymbolIdField::None)
215 return;
216 // And obviously don't recurse on the symbol itself.
217 if (FieldId == PdbSymbolIdField::SymIndexId)
218 return;
219
220 auto Child = Session.getSymbolById(SymbolId: Value);
221
222 // It could have been a placeholder symbol for a type we don't yet support,
223 // so just exit in that case.
224 if (!Child)
225 return;
226
227 // Don't recurse more than once, so pass PdbSymbolIdField::None) for the
228 // recurse flags.
229 Child->defaultDump(OS, Indent: Indent + 2, ShowFlags, RecurseFlags: PdbSymbolIdField::None);
230}
231