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 /// \{ isA(const void * ClassID)50 bool isA(const void *ClassID) const override { 51 return ClassID == &ID || SymbolFile::isA(ClassID); 52 } classof(const SymbolFile * obj)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 ConstString GetPluginNameStatic(); 64 65 static const char *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 // Compile Unit function calls 79 80 void 81 ParseDeclsForContext(lldb_private::CompilerDeclContext decl_ctx) override; 82 83 lldb::LanguageType 84 ParseLanguage(lldb_private::CompileUnit &comp_unit) override; 85 86 size_t ParseFunctions(lldb_private::CompileUnit &comp_unit) override; 87 88 bool ParseLineTable(lldb_private::CompileUnit &comp_unit) override; 89 90 bool ParseDebugMacros(lldb_private::CompileUnit &comp_unit) override; 91 92 bool ParseSupportFiles(lldb_private::CompileUnit &comp_unit, 93 FileSpecList &support_files) override; 94 size_t ParseTypes(lldb_private::CompileUnit &comp_unit) override; 95 96 bool ParseImportedModules( 97 const SymbolContext &sc, 98 std::vector<lldb_private::SourceModule> &imported_modules) override; 99 100 size_t ParseBlocksRecursive(Function &func) override; 101 102 void FindGlobalVariables(ConstString name, 103 const CompilerDeclContext &parent_decl_ctx, 104 uint32_t max_matches, 105 VariableList &variables) override; 106 107 size_t ParseVariablesForContext(const SymbolContext &sc) override; 108 109 void AddSymbols(Symtab &symtab) override; 110 111 CompilerDecl GetDeclForUID(lldb::user_id_t uid) override; 112 CompilerDeclContext GetDeclContextForUID(lldb::user_id_t uid) override; 113 CompilerDeclContext GetDeclContextContainingUID(lldb::user_id_t uid) override; 114 Type *ResolveTypeUID(lldb::user_id_t type_uid) override; 115 llvm::Optional<ArrayInfo> GetDynamicArrayInfoForUID( 116 lldb::user_id_t type_uid, 117 const lldb_private::ExecutionContext *exe_ctx) override; 118 119 bool CompleteType(CompilerType &compiler_type) override; 120 uint32_t ResolveSymbolContext(const Address &so_addr, 121 lldb::SymbolContextItem resolve_scope, 122 SymbolContext &sc) override; 123 uint32_t ResolveSymbolContext(const FileSpec &file_spec, uint32_t line, 124 bool check_inlines, 125 lldb::SymbolContextItem resolve_scope, 126 SymbolContextList &sc_list) override; 127 128 void GetTypes(SymbolContextScope *sc_scope, lldb::TypeClass type_mask, 129 TypeList &type_list) override; 130 131 void FindFunctions(ConstString name, 132 const CompilerDeclContext &parent_decl_ctx, 133 lldb::FunctionNameType name_type_mask, 134 bool include_inlines, SymbolContextList &sc_list) override; 135 136 void FindFunctions(const RegularExpression ®ex, bool include_inlines, 137 SymbolContextList &sc_list) override; 138 139 void FindTypes(ConstString name, const CompilerDeclContext &parent_decl_ctx, 140 uint32_t max_matches, 141 llvm::DenseSet<SymbolFile *> &searched_symbol_files, 142 TypeMap &types) override; 143 144 void FindTypes(llvm::ArrayRef<CompilerContext> pattern, LanguageSet languages, 145 llvm::DenseSet<SymbolFile *> &searched_symbol_files, 146 TypeMap &types) override; 147 148 llvm::Expected<TypeSystem &> 149 GetTypeSystemForLanguage(lldb::LanguageType language) override; 150 151 CompilerDeclContext 152 FindNamespace(ConstString name, 153 const CompilerDeclContext &parent_decl_ctx) override; 154 155 ConstString GetPluginName() override; 156 157 uint32_t GetPluginVersion() override; 158 GetPDBFile()159 llvm::pdb::PDBFile &GetPDBFile() { return m_index->pdb(); } GetPDBFile()160 const llvm::pdb::PDBFile &GetPDBFile() const { return m_index->pdb(); } 161 162 void DumpClangAST(Stream &s) override; 163 164 private: 165 uint32_t CalculateNumCompileUnits() override; 166 167 lldb::CompUnitSP ParseCompileUnitAtIndex(uint32_t index) override; 168 169 void FindTypesByName(llvm::StringRef name, uint32_t max_matches, 170 TypeMap &types); 171 172 lldb::TypeSP CreateModifierType(PdbTypeSymId type_id, 173 const llvm::codeview::ModifierRecord &mr, 174 CompilerType ct); 175 lldb::TypeSP CreatePointerType(PdbTypeSymId type_id, 176 const llvm::codeview::PointerRecord &pr, 177 CompilerType ct); 178 lldb::TypeSP CreateSimpleType(llvm::codeview::TypeIndex ti, CompilerType ct); 179 lldb::TypeSP CreateTagType(PdbTypeSymId type_id, 180 const llvm::codeview::ClassRecord &cr, 181 CompilerType ct); 182 lldb::TypeSP CreateTagType(PdbTypeSymId type_id, 183 const llvm::codeview::EnumRecord &er, 184 CompilerType ct); 185 lldb::TypeSP CreateTagType(PdbTypeSymId type_id, 186 const llvm::codeview::UnionRecord &ur, 187 CompilerType ct); 188 lldb::TypeSP CreateArrayType(PdbTypeSymId type_id, 189 const llvm::codeview::ArrayRecord &ar, 190 CompilerType ct); 191 lldb::TypeSP CreateFunctionType(PdbTypeSymId type_id, 192 const llvm::codeview::MemberFunctionRecord &pr, 193 CompilerType ct); 194 lldb::TypeSP CreateProcedureType(PdbTypeSymId type_id, 195 const llvm::codeview::ProcedureRecord &pr, 196 CompilerType ct); 197 lldb::TypeSP CreateClassStructUnion(PdbTypeSymId type_id, 198 const llvm::codeview::TagRecord &record, 199 size_t size, CompilerType ct); 200 201 lldb::FunctionSP GetOrCreateFunction(PdbCompilandSymId func_id, 202 CompileUnit &comp_unit); 203 lldb::CompUnitSP GetOrCreateCompileUnit(const CompilandIndexItem &cci); 204 lldb::TypeSP GetOrCreateType(PdbTypeSymId type_id); 205 lldb::TypeSP GetOrCreateType(llvm::codeview::TypeIndex ti); 206 lldb::VariableSP GetOrCreateGlobalVariable(PdbGlobalSymId var_id); 207 Block &GetOrCreateBlock(PdbCompilandSymId block_id); 208 lldb::VariableSP GetOrCreateLocalVariable(PdbCompilandSymId scope_id, 209 PdbCompilandSymId var_id, 210 bool is_param); 211 lldb::TypeSP GetOrCreateTypedef(PdbGlobalSymId id); 212 213 lldb::FunctionSP CreateFunction(PdbCompilandSymId func_id, 214 CompileUnit &comp_unit); 215 Block &CreateBlock(PdbCompilandSymId block_id); 216 lldb::VariableSP CreateLocalVariable(PdbCompilandSymId scope_id, 217 PdbCompilandSymId var_id, bool is_param); 218 lldb::TypeSP CreateTypedef(PdbGlobalSymId id); 219 lldb::CompUnitSP CreateCompileUnit(const CompilandIndexItem &cci); 220 lldb::TypeSP CreateType(PdbTypeSymId type_id, CompilerType ct); 221 lldb::TypeSP CreateAndCacheType(PdbTypeSymId type_id); 222 lldb::VariableSP CreateGlobalVariable(PdbGlobalSymId var_id); 223 lldb::VariableSP CreateConstantSymbol(PdbGlobalSymId var_id, 224 const llvm::codeview::CVSymbol &cvs); 225 size_t ParseVariablesForCompileUnit(CompileUnit &comp_unit, 226 VariableList &variables); 227 size_t ParseVariablesForBlock(PdbCompilandSymId block_id); 228 229 llvm::BumpPtrAllocator m_allocator; 230 231 lldb::addr_t m_obj_load_address = 0; 232 bool m_done_full_type_scan = false; 233 234 std::unique_ptr<llvm::pdb::PDBFile> m_file_up; 235 std::unique_ptr<PdbIndex> m_index; 236 237 std::unique_ptr<PdbAstBuilder> m_ast; 238 239 llvm::DenseMap<lldb::user_id_t, lldb::VariableSP> m_global_vars; 240 llvm::DenseMap<lldb::user_id_t, lldb::VariableSP> m_local_variables; 241 llvm::DenseMap<lldb::user_id_t, lldb::BlockSP> m_blocks; 242 llvm::DenseMap<lldb::user_id_t, lldb::FunctionSP> m_functions; 243 llvm::DenseMap<lldb::user_id_t, lldb::CompUnitSP> m_compilands; 244 llvm::DenseMap<lldb::user_id_t, lldb::TypeSP> m_types; 245 }; 246 247 } // namespace npdb 248 } // namespace lldb_private 249 250 #endif // LLDB_SOURCE_PLUGINS_SYMBOLFILE_NATIVEPDB_SYMBOLFILENATIVEPDB_H 251