256 lines · c
1//===-- SymbolFilePDB.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-exception6//7//===----------------------------------------------------------------------===//8 9#ifndef LLDB_SOURCE_PLUGINS_SYMBOLFILE_PDB_SYMBOLFILEPDB_H10#define LLDB_SOURCE_PLUGINS_SYMBOLFILE_PDB_SYMBOLFILEPDB_H11 12#include "lldb/Core/UniqueCStringMap.h"13#include "lldb/Symbol/SymbolFile.h"14#include "lldb/Symbol/VariableList.h"15#include "lldb/Utility/UserID.h"16 17#include "llvm/ADT/DenseMap.h"18#include "llvm/DebugInfo/PDB/IPDBSession.h"19#include "llvm/DebugInfo/PDB/PDB.h"20#include "llvm/DebugInfo/PDB/PDBSymbolExe.h"21#include <optional>22 23class PDBASTParser;24 25class SymbolFilePDB : public lldb_private::SymbolFileCommon {26 /// LLVM RTTI support.27 static char ID;28 29public:30 /// LLVM RTTI support.31 /// \{32 bool isA(const void *ClassID) const override {33 return ClassID == &ID || SymbolFileCommon::isA(ClassID);34 }35 static bool classof(const SymbolFile *obj) { return obj->isA(&ID); }36 /// \}37 38 // Static Functions39 static void Initialize();40 41 static void Terminate();42 43 static void DebuggerInitialize(lldb_private::Debugger &debugger);44 45 static llvm::StringRef GetPluginNameStatic() { return "pdb"; }46 47 static llvm::StringRef GetPluginDescriptionStatic();48 49 static lldb_private::SymbolFile *50 CreateInstance(lldb::ObjectFileSP objfile_sp);51 52 static bool UseNativePDB();53 54 // Constructors and Destructors55 SymbolFilePDB(lldb::ObjectFileSP objfile_sp);56 57 ~SymbolFilePDB() override;58 59 uint32_t CalculateAbilities() override;60 61 void InitializeObject() override;62 63 // Compile Unit function calls64 65 lldb::LanguageType66 ParseLanguage(lldb_private::CompileUnit &comp_unit) override;67 68 size_t ParseFunctions(lldb_private::CompileUnit &comp_unit) override;69 70 bool ParseLineTable(lldb_private::CompileUnit &comp_unit) override;71 72 bool ParseDebugMacros(lldb_private::CompileUnit &comp_unit) override;73 74 bool ParseSupportFiles(lldb_private::CompileUnit &comp_unit,75 lldb_private::SupportFileList &support_files) override;76 77 size_t ParseTypes(lldb_private::CompileUnit &comp_unit) override;78 79 bool ParseImportedModules(80 const lldb_private::SymbolContext &sc,81 std::vector<lldb_private::SourceModule> &imported_modules) override;82 83 size_t ParseBlocksRecursive(lldb_private::Function &func) override;84 85 size_t86 ParseVariablesForContext(const lldb_private::SymbolContext &sc) override;87 88 lldb_private::Type *ResolveTypeUID(lldb::user_id_t type_uid) override;89 std::optional<ArrayInfo> GetDynamicArrayInfoForUID(90 lldb::user_id_t type_uid,91 const lldb_private::ExecutionContext *exe_ctx) override;92 93 bool CompleteType(lldb_private::CompilerType &compiler_type) override;94 95 lldb_private::CompilerDecl GetDeclForUID(lldb::user_id_t uid) override;96 97 lldb_private::CompilerDeclContext98 GetDeclContextForUID(lldb::user_id_t uid) override;99 100 lldb_private::CompilerDeclContext101 GetDeclContextContainingUID(lldb::user_id_t uid) override;102 103 void104 ParseDeclsForContext(lldb_private::CompilerDeclContext decl_ctx) override;105 106 uint32_t ResolveSymbolContext(const lldb_private::Address &so_addr,107 lldb::SymbolContextItem resolve_scope,108 lldb_private::SymbolContext &sc) override;109 110 uint32_t ResolveSymbolContext(111 const lldb_private::SourceLocationSpec &src_location_spec,112 lldb::SymbolContextItem resolve_scope,113 lldb_private::SymbolContextList &sc_list) override;114 115 void116 FindGlobalVariables(lldb_private::ConstString name,117 const lldb_private::CompilerDeclContext &parent_decl_ctx,118 uint32_t max_matches,119 lldb_private::VariableList &variables) override;120 121 void FindGlobalVariables(const lldb_private::RegularExpression ®ex,122 uint32_t max_matches,123 lldb_private::VariableList &variables) override;124 125 void FindFunctions(const lldb_private::Module::LookupInfo &lookup_info,126 const lldb_private::CompilerDeclContext &parent_decl_ctx,127 bool include_inlines,128 lldb_private::SymbolContextList &sc_list) override;129 130 void FindFunctions(const lldb_private::RegularExpression ®ex,131 bool include_inlines,132 lldb_private::SymbolContextList &sc_list) override;133 134 void GetMangledNamesForFunction(135 const std::string &scope_qualified_name,136 std::vector<lldb_private::ConstString> &mangled_names) override;137 138 void AddSymbols(lldb_private::Symtab &symtab) override;139 void FindTypes(const lldb_private::TypeQuery &match,140 lldb_private::TypeResults &results) override;141 void FindTypesByRegex(const lldb_private::RegularExpression ®ex,142 uint32_t max_matches, lldb_private::TypeMap &types);143 144 void GetTypes(lldb_private::SymbolContextScope *sc_scope,145 lldb::TypeClass type_mask,146 lldb_private::TypeList &type_list) override;147 148 llvm::Expected<lldb::TypeSystemSP>149 GetTypeSystemForLanguage(lldb::LanguageType language) override;150 151 lldb_private::CompilerDeclContext152 FindNamespace(lldb_private::ConstString name,153 const lldb_private::CompilerDeclContext &parent_decl_ctx,154 bool only_root_namespaces) override;155 156 llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }157 158 llvm::pdb::IPDBSession &GetPDBSession();159 160 const llvm::pdb::IPDBSession &GetPDBSession() const;161 162 void DumpClangAST(lldb_private::Stream &s, llvm::StringRef filter,163 bool show_color) override;164 165private:166 struct SecContribInfo {167 uint32_t Offset;168 uint32_t Size;169 uint32_t CompilandId;170 };171 using SecContribsMap = std::map<uint32_t, std::vector<SecContribInfo>>;172 173 uint32_t CalculateNumCompileUnits() override;174 175 lldb::CompUnitSP ParseCompileUnitAtIndex(uint32_t index) override;176 177 lldb::CompUnitSP ParseCompileUnitForUID(uint32_t id,178 uint32_t index = UINT32_MAX);179 180 bool ParseCompileUnitLineTable(lldb_private::CompileUnit &comp_unit,181 uint32_t match_line);182 183 void BuildSupportFileIdToSupportFileIndexMap(184 const llvm::pdb::PDBSymbolCompiland &pdb_compiland,185 llvm::DenseMap<uint32_t, uint32_t> &index_map) const;186 187 void FindTypesByName(llvm::StringRef name,188 const lldb_private::CompilerDeclContext &parent_decl_ctx,189 uint32_t max_matches, lldb_private::TypeMap &types);190 191 std::string GetMangledForPDBData(const llvm::pdb::PDBSymbolData &pdb_data);192 193 lldb::VariableSP194 ParseVariableForPDBData(const lldb_private::SymbolContext &sc,195 const llvm::pdb::PDBSymbolData &pdb_data);196 197 size_t ParseVariables(const lldb_private::SymbolContext &sc,198 const llvm::pdb::PDBSymbol &pdb_data,199 lldb_private::VariableList *variable_list = nullptr);200 201 lldb::CompUnitSP202 GetCompileUnitContainsAddress(const lldb_private::Address &so_addr);203 204 typedef std::vector<lldb_private::Type *> TypeCollection;205 206 void GetTypesForPDBSymbol(const llvm::pdb::PDBSymbol &pdb_symbol,207 uint32_t type_mask,208 TypeCollection &type_collection);209 210 lldb_private::Function *211 ParseCompileUnitFunctionForPDBFunc(const llvm::pdb::PDBSymbolFunc &pdb_func,212 lldb_private::CompileUnit &comp_unit);213 214 void GetCompileUnitIndex(const llvm::pdb::PDBSymbolCompiland &pdb_compiland,215 uint32_t &index);216 217 PDBASTParser *GetPDBAstParser();218 219 std::unique_ptr<llvm::pdb::PDBSymbolCompiland>220 GetPDBCompilandByUID(uint32_t uid);221 222 lldb_private::Mangled223 GetMangledForPDBFunc(const llvm::pdb::PDBSymbolFunc &pdb_func);224 225 bool ResolveFunction(const llvm::pdb::PDBSymbolFunc &pdb_func,226 bool include_inlines,227 lldb_private::SymbolContextList &sc_list);228 229 bool ResolveFunction(uint32_t uid, bool include_inlines,230 lldb_private::SymbolContextList &sc_list);231 232 void CacheFunctionNames();233 234 bool DeclContextMatchesThisSymbolFile(235 const lldb_private::CompilerDeclContext &decl_ctx);236 237 uint32_t GetCompilandId(const llvm::pdb::PDBSymbolData &data);238 239 llvm::DenseMap<uint32_t, lldb::CompUnitSP> m_comp_units;240 llvm::DenseMap<uint32_t, lldb::TypeSP> m_types;241 llvm::DenseMap<uint32_t, lldb::VariableSP> m_variables;242 llvm::DenseMap<uint64_t, std::string> m_public_names;243 244 SecContribsMap m_sec_contribs;245 246 std::vector<lldb::TypeSP> m_builtin_types;247 std::unique_ptr<llvm::pdb::IPDBSession> m_session_up;248 std::unique_ptr<llvm::pdb::PDBSymbolExe> m_global_scope_up;249 250 lldb_private::UniqueCStringMap<uint32_t> m_func_full_names;251 lldb_private::UniqueCStringMap<uint32_t> m_func_base_names;252 lldb_private::UniqueCStringMap<uint32_t> m_func_method_names;253};254 255#endif // LLDB_SOURCE_PLUGINS_SYMBOLFILE_PDB_SYMBOLFILEPDB_H256