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, 54 std::unique_ptr<IPDBRawSymbol> Symbol) 55 : Session(PDBSession), RawSymbol(std::move(Symbol)) {} 56 57 PDBSymbol::~PDBSymbol() = default; 58 59 #define FACTORY_SYMTAG_CASE(Tag, Type) \ 60 case PDB_SymType::Tag: \ 61 return std::unique_ptr<PDBSymbol>(new Type(PDBSession, std::move(Symbol))); 62 63 std::unique_ptr<PDBSymbol> 64 PDBSymbol::create(const IPDBSession &PDBSession, 65 std::unique_ptr<IPDBRawSymbol> Symbol) { 66 switch (Symbol->getSymTag()) { 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>( 99 new PDBSymbolUnknown(PDBSession, std::move(Symbol))); 100 } 101 } 102 103 #define TRY_DUMP_TYPE(Type) \ 104 if (const Type *DerivedThis = this->cast<Type>()) \ 105 Dumper.dump(OS, Indent, *DerivedThis); 106 107 #define ELSE_TRY_DUMP_TYPE(Type, Dumper) else TRY_DUMP_TYPE(Type, Dumper) 108 109 void PDBSymbol::defaultDump(raw_ostream &OS, int Indent) const { 110 RawSymbol->dump(OS, Indent); 111 } 112 113 void PDBSymbol::dumpProperties() const { 114 outs() << "\n"; 115 defaultDump(outs(), 0); 116 outs().flush(); 117 } 118 119 void PDBSymbol::dumpChildStats() const { 120 TagStats Stats; 121 getChildStats(Stats); 122 outs() << "\n"; 123 for (auto &Stat : Stats) { 124 outs() << Stat.first << ": " << Stat.second << "\n"; 125 } 126 outs().flush(); 127 } 128 129 std::unique_ptr<PDBSymbol> PDBSymbol::clone() const { 130 return Session.getSymbolById(getSymIndexId()); 131 } 132 133 PDB_SymType PDBSymbol::getSymTag() const { return RawSymbol->getSymTag(); } 134 uint32_t PDBSymbol::getSymIndexId() const { return RawSymbol->getSymIndexId(); } 135 136 std::unique_ptr<IPDBEnumSymbols> PDBSymbol::findAllChildren() const { 137 return findAllChildren(PDB_SymType::None); 138 } 139 140 std::unique_ptr<IPDBEnumSymbols> 141 PDBSymbol::findAllChildren(PDB_SymType Type) const { 142 return RawSymbol->findChildren(Type); 143 } 144 145 std::unique_ptr<IPDBEnumSymbols> 146 PDBSymbol::findChildren(PDB_SymType Type, StringRef Name, 147 PDB_NameSearchFlags Flags) const { 148 return RawSymbol->findChildren(Type, Name, Flags); 149 } 150 151 std::unique_ptr<IPDBEnumSymbols> 152 PDBSymbol::findChildrenByRVA(PDB_SymType Type, StringRef Name, 153 PDB_NameSearchFlags Flags, uint32_t RVA) const { 154 return RawSymbol->findChildrenByRVA(Type, Name, Flags, RVA); 155 } 156 157 std::unique_ptr<IPDBEnumSymbols> 158 PDBSymbol::findInlineFramesByRVA(uint32_t RVA) const { 159 return RawSymbol->findInlineFramesByRVA(RVA); 160 } 161 162 std::unique_ptr<IPDBEnumSymbols> 163 PDBSymbol::getChildStats(TagStats &Stats) const { 164 std::unique_ptr<IPDBEnumSymbols> Result(findAllChildren()); 165 Stats.clear(); 166 while (auto Child = Result->getNext()) { 167 ++Stats[Child->getSymTag()]; 168 } 169 Result->reset(); 170 return Result; 171 } 172 173 std::unique_ptr<PDBSymbol> PDBSymbol::getSymbolByIdHelper(uint32_t Id) const { 174 return Session.getSymbolById(Id); 175 } 176