1 //===-- SymbolFileNativePDB.h -----------------------------------*- 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 #ifndef LLDB_SOURCE_PLUGINS_SYMBOLFILE_NATIVEPDB_SYMBOLFILENATIVEPDB_H 10 #define LLDB_SOURCE_PLUGINS_SYMBOLFILE_NATIVEPDB_SYMBOLFILENATIVEPDB_H 11 12 #include "lldb/Symbol/SymbolFile.h" 13 14 #include "llvm/ADT/DenseMap.h" 15 #include "llvm/DebugInfo/CodeView/CVRecord.h" 16 #include "llvm/DebugInfo/CodeView/SymbolRecord.h" 17 #include "llvm/DebugInfo/PDB/PDBTypes.h" 18 19 #include "CompileUnitIndex.h" 20 #include "PdbIndex.h" 21 22 namespace clang { 23 class TagDecl; 24 } 25 26 namespace llvm { 27 namespace codeview { 28 class ClassRecord; 29 class EnumRecord; 30 class ModifierRecord; 31 class PointerRecord; 32 struct UnionRecord; 33 } // namespace codeview 34 } // namespace llvm 35 36 namespace lldb_private { 37 38 namespace npdb { 39 class PdbAstBuilder; 40 41 class SymbolFileNativePDB : public SymbolFile { 42 friend class UdtRecordCompleter; 43 44 /// LLVM RTTI support. 45 static char ID; 46 47 public: 48 /// LLVM RTTI support. 49 /// \{ 50 bool isA(const void *ClassID) const override { 51 return ClassID == &ID || SymbolFile::isA(ClassID); 52 } 53 static bool classof(const SymbolFile *obj) { return obj->isA(&ID); } 54 /// \} 55 56 // Static Functions 57 static void Initialize(); 58 59 static void Terminate(); 60 61 static void DebuggerInitialize(Debugger &debugger); 62 63 static llvm::StringRef GetPluginNameStatic() { return "native-pdb"; } 64 65 static llvm::StringRef GetPluginDescriptionStatic(); 66 67 static SymbolFile *CreateInstance(lldb::ObjectFileSP objfile_sp); 68 69 // Constructors and Destructors 70 SymbolFileNativePDB(lldb::ObjectFileSP objfile_sp); 71 72 ~SymbolFileNativePDB() override; 73 74 uint32_t CalculateAbilities() override; 75 76 void InitializeObject() override; 77 78 uint64_t GetDebugInfoSize() override; 79 80 // Compile Unit function calls 81 82 void 83 ParseDeclsForContext(lldb_private::CompilerDeclContext decl_ctx) override; 84 85 lldb::LanguageType 86 ParseLanguage(lldb_private::CompileUnit &comp_unit) override; 87 88 size_t ParseFunctions(lldb_private::CompileUnit &comp_unit) override; 89 90 bool ParseLineTable(lldb_private::CompileUnit &comp_unit) override; 91 92 bool ParseDebugMacros(lldb_private::CompileUnit &comp_unit) override; 93 94 bool ParseSupportFiles(lldb_private::CompileUnit &comp_unit, 95 FileSpecList &support_files) override; 96 size_t ParseTypes(lldb_private::CompileUnit &comp_unit) override; 97 98 bool ParseImportedModules( 99 const SymbolContext &sc, 100 std::vector<lldb_private::SourceModule> &imported_modules) override; 101 102 size_t ParseBlocksRecursive(Function &func) override; 103 104 void FindGlobalVariables(ConstString name, 105 const CompilerDeclContext &parent_decl_ctx, 106 uint32_t max_matches, 107 VariableList &variables) override; 108 109 size_t ParseVariablesForContext(const SymbolContext &sc) override; 110 111 void AddSymbols(Symtab &symtab) override; 112 113 CompilerDecl GetDeclForUID(lldb::user_id_t uid) override; 114 CompilerDeclContext GetDeclContextForUID(lldb::user_id_t uid) override; 115 CompilerDeclContext GetDeclContextContainingUID(lldb::user_id_t uid) override; 116 Type *ResolveTypeUID(lldb::user_id_t type_uid) override; 117 llvm::Optional<ArrayInfo> GetDynamicArrayInfoForUID( 118 lldb::user_id_t type_uid, 119 const lldb_private::ExecutionContext *exe_ctx) override; 120 121 bool CompleteType(CompilerType &compiler_type) override; 122 uint32_t ResolveSymbolContext(const Address &so_addr, 123 lldb::SymbolContextItem resolve_scope, 124 SymbolContext &sc) override; 125 uint32_t ResolveSymbolContext(const SourceLocationSpec &src_location_spec, 126 lldb::SymbolContextItem resolve_scope, 127 SymbolContextList &sc_list) override; 128 129 void GetTypes(SymbolContextScope *sc_scope, lldb::TypeClass type_mask, 130 TypeList &type_list) override; 131 132 void FindFunctions(ConstString name, 133 const CompilerDeclContext &parent_decl_ctx, 134 lldb::FunctionNameType name_type_mask, 135 bool include_inlines, SymbolContextList &sc_list) override; 136 137 void FindFunctions(const RegularExpression ®ex, bool include_inlines, 138 SymbolContextList &sc_list) override; 139 140 void FindTypes(ConstString name, const CompilerDeclContext &parent_decl_ctx, 141 uint32_t max_matches, 142 llvm::DenseSet<SymbolFile *> &searched_symbol_files, 143 TypeMap &types) override; 144 145 void FindTypes(llvm::ArrayRef<CompilerContext> pattern, LanguageSet languages, 146 llvm::DenseSet<SymbolFile *> &searched_symbol_files, 147 TypeMap &types) override; 148 149 llvm::Expected<TypeSystem &> 150 GetTypeSystemForLanguage(lldb::LanguageType language) override; 151 152 CompilerDeclContext 153 FindNamespace(ConstString name, 154 const CompilerDeclContext &parent_decl_ctx) override; 155 156 llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); } 157 158 llvm::pdb::PDBFile &GetPDBFile() { return m_index->pdb(); } 159 const llvm::pdb::PDBFile &GetPDBFile() const { return m_index->pdb(); } 160 161 void DumpClangAST(Stream &s) override; 162 163 private: 164 uint32_t CalculateNumCompileUnits() override; 165 166 lldb::CompUnitSP ParseCompileUnitAtIndex(uint32_t index) override; 167 168 void FindTypesByName(llvm::StringRef name, uint32_t max_matches, 169 TypeMap &types); 170 171 lldb::TypeSP CreateModifierType(PdbTypeSymId type_id, 172 const llvm::codeview::ModifierRecord &mr, 173 CompilerType ct); 174 lldb::TypeSP CreatePointerType(PdbTypeSymId type_id, 175 const llvm::codeview::PointerRecord &pr, 176 CompilerType ct); 177 lldb::TypeSP CreateSimpleType(llvm::codeview::TypeIndex ti, CompilerType ct); 178 lldb::TypeSP CreateTagType(PdbTypeSymId type_id, 179 const llvm::codeview::ClassRecord &cr, 180 CompilerType ct); 181 lldb::TypeSP CreateTagType(PdbTypeSymId type_id, 182 const llvm::codeview::EnumRecord &er, 183 CompilerType ct); 184 lldb::TypeSP CreateTagType(PdbTypeSymId type_id, 185 const llvm::codeview::UnionRecord &ur, 186 CompilerType ct); 187 lldb::TypeSP CreateArrayType(PdbTypeSymId type_id, 188 const llvm::codeview::ArrayRecord &ar, 189 CompilerType ct); 190 lldb::TypeSP CreateFunctionType(PdbTypeSymId type_id, 191 const llvm::codeview::MemberFunctionRecord &pr, 192 CompilerType ct); 193 lldb::TypeSP CreateProcedureType(PdbTypeSymId type_id, 194 const llvm::codeview::ProcedureRecord &pr, 195 CompilerType ct); 196 lldb::TypeSP CreateClassStructUnion(PdbTypeSymId type_id, 197 const llvm::codeview::TagRecord &record, 198 size_t size, CompilerType ct); 199 200 lldb::FunctionSP GetOrCreateFunction(PdbCompilandSymId func_id, 201 CompileUnit &comp_unit); 202 lldb::CompUnitSP GetOrCreateCompileUnit(const CompilandIndexItem &cci); 203 lldb::TypeSP GetOrCreateType(PdbTypeSymId type_id); 204 lldb::TypeSP GetOrCreateType(llvm::codeview::TypeIndex ti); 205 lldb::VariableSP GetOrCreateGlobalVariable(PdbGlobalSymId var_id); 206 Block &GetOrCreateBlock(PdbCompilandSymId block_id); 207 lldb::VariableSP GetOrCreateLocalVariable(PdbCompilandSymId scope_id, 208 PdbCompilandSymId var_id, 209 bool is_param); 210 lldb::TypeSP GetOrCreateTypedef(PdbGlobalSymId id); 211 212 lldb::FunctionSP CreateFunction(PdbCompilandSymId func_id, 213 CompileUnit &comp_unit); 214 Block &CreateBlock(PdbCompilandSymId block_id); 215 lldb::VariableSP CreateLocalVariable(PdbCompilandSymId scope_id, 216 PdbCompilandSymId var_id, bool is_param); 217 lldb::TypeSP CreateTypedef(PdbGlobalSymId id); 218 lldb::CompUnitSP CreateCompileUnit(const CompilandIndexItem &cci); 219 lldb::TypeSP CreateType(PdbTypeSymId type_id, CompilerType ct); 220 lldb::TypeSP CreateAndCacheType(PdbTypeSymId type_id); 221 lldb::VariableSP CreateGlobalVariable(PdbGlobalSymId var_id); 222 lldb::VariableSP CreateConstantSymbol(PdbGlobalSymId var_id, 223 const llvm::codeview::CVSymbol &cvs); 224 size_t ParseVariablesForCompileUnit(CompileUnit &comp_unit, 225 VariableList &variables); 226 size_t ParseVariablesForBlock(PdbCompilandSymId block_id); 227 228 llvm::BumpPtrAllocator m_allocator; 229 230 lldb::addr_t m_obj_load_address = 0; 231 bool m_done_full_type_scan = false; 232 233 std::unique_ptr<llvm::pdb::PDBFile> m_file_up; 234 std::unique_ptr<PdbIndex> m_index; 235 236 std::unique_ptr<PdbAstBuilder> m_ast; 237 238 llvm::DenseMap<lldb::user_id_t, lldb::VariableSP> m_global_vars; 239 llvm::DenseMap<lldb::user_id_t, lldb::VariableSP> m_local_variables; 240 llvm::DenseMap<lldb::user_id_t, lldb::BlockSP> m_blocks; 241 llvm::DenseMap<lldb::user_id_t, lldb::FunctionSP> m_functions; 242 llvm::DenseMap<lldb::user_id_t, lldb::CompUnitSP> m_compilands; 243 llvm::DenseMap<lldb::user_id_t, lldb::TypeSP> m_types; 244 }; 245 246 } // namespace npdb 247 } // namespace lldb_private 248 249 #endif // LLDB_SOURCE_PLUGINS_SYMBOLFILE_NATIVEPDB_SYMBOLFILENATIVEPDB_H 250