LLDB mainline
SymbolFileNativePDB.h
Go to the documentation of this file.
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
14
15#include "llvm/ADT/DenseMap.h"
16#include "llvm/DebugInfo/CodeView/CVRecord.h"
17#include "llvm/DebugInfo/CodeView/SymbolRecord.h"
18#include "llvm/DebugInfo/PDB/PDBTypes.h"
19
20#include "CompileUnitIndex.h"
21#include "PdbIndex.h"
22#include "PdbAstBuilder.h"
23#include <optional>
24
25namespace clang {
26class TagDecl;
27}
28
29namespace llvm {
30namespace codeview {
31class ClassRecord;
32class EnumRecord;
33class ModifierRecord;
34class PointerRecord;
35struct UnionRecord;
36} // namespace codeview
37} // namespace llvm
38
39namespace lldb_private {
40
41namespace npdb {
42
44 friend class UdtRecordCompleter;
45
46 /// LLVM RTTI support.
47 static char ID;
48
49public:
50 /// LLVM RTTI support.
51 /// \{
52 bool isA(const void *ClassID) const override {
53 return ClassID == &ID || SymbolFileCommon::isA(ClassID);
54 }
55 static bool classof(const SymbolFile *obj) { return obj->isA(&ID); }
56 /// \}
57
58 // Static Functions
59 static void Initialize();
60
61 static void Terminate();
62
63 static void DebuggerInitialize(Debugger &debugger);
64
65 static llvm::StringRef GetPluginNameStatic() { return "native-pdb"; }
66
67 static llvm::StringRef GetPluginDescriptionStatic();
68
70
71 // Constructors and Destructors
73
75
76 uint32_t CalculateAbilities() override;
77
78 void InitializeObject() override;
79
80 uint64_t GetDebugInfoSize(bool load_all_debug_info = false) override;
81
82 // Compile Unit function calls
83
84 void
86
88 ParseLanguage(lldb_private::CompileUnit &comp_unit) override;
89
90 size_t ParseFunctions(lldb_private::CompileUnit &comp_unit) override;
91
92 bool ParseLineTable(lldb_private::CompileUnit &comp_unit) override;
93
94 bool ParseDebugMacros(lldb_private::CompileUnit &comp_unit) override;
95
97 SupportFileList &support_files) override;
98 size_t ParseTypes(lldb_private::CompileUnit &comp_unit) override;
99
101 const SymbolContext &sc,
102 std::vector<lldb_private::SourceModule> &imported_modules) override;
103
104 size_t ParseBlocksRecursive(Function &func) override;
105
107 const CompilerDeclContext &parent_decl_ctx,
108 uint32_t max_matches,
109 VariableList &variables) override;
110
111 size_t ParseVariablesForContext(const SymbolContext &sc) override;
112
113 void AddSymbols(Symtab &symtab) override;
114
118 Type *ResolveTypeUID(lldb::user_id_t type_uid) override;
119 std::optional<ArrayInfo> GetDynamicArrayInfoForUID(
120 lldb::user_id_t type_uid,
121 const lldb_private::ExecutionContext *exe_ctx) override;
122
123 bool CompleteType(CompilerType &compiler_type) override;
124 uint32_t ResolveSymbolContext(const Address &so_addr,
125 lldb::SymbolContextItem resolve_scope,
126 SymbolContext &sc) override;
127 uint32_t ResolveSymbolContext(const SourceLocationSpec &src_location_spec,
128 lldb::SymbolContextItem resolve_scope,
129 SymbolContextList &sc_list) override;
130
131 void GetTypes(SymbolContextScope *sc_scope, lldb::TypeClass type_mask,
132 TypeList &type_list) override;
133
134 void FindFunctions(const Module::LookupInfo &lookup_info,
135 const CompilerDeclContext &parent_decl_ctx,
136 bool include_inlines, SymbolContextList &sc_list) override;
137
138 void FindFunctions(const RegularExpression &regex, bool include_inlines,
139 SymbolContextList &sc_list) override;
140
141 std::optional<PdbCompilandSymId> FindSymbolScope(PdbCompilandSymId id);
142
143 void FindTypes(const lldb_private::TypeQuery &match,
144 lldb_private::TypeResults &results) override;
145
146 llvm::Expected<lldb::TypeSystemSP>
148
150 const CompilerDeclContext &parent_decl_ctx,
151 bool only_root_namespaces) override;
152
153 llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }
154
155 llvm::pdb::PDBFile &GetPDBFile() { return m_index->pdb(); }
156 const llvm::pdb::PDBFile &GetPDBFile() const { return m_index->pdb(); }
157
158 PdbIndex &GetIndex() { return *m_index; };
159
160 void DumpClangAST(Stream &s) override;
161
162 std::optional<llvm::codeview::TypeIndex>
163 GetParentType(llvm::codeview::TypeIndex ti);
164
165private:
168 const lldb_private::LineTable::Entry &rhs) const {
169 return lhs.file_addr < rhs.file_addr;
170 }
171 };
172
173 // From address range relative to function base to source line number.
176 // InlineSite contains information in a S_INLINESITE record.
177 struct InlineSite {
179 std::shared_ptr<InlineFunctionInfo> inline_function_info;
181 std::vector<lldb_private::LineTable::Entry> line_entries;
183 };
184
185 void BuildParentMap();
186
187 uint32_t CalculateNumCompileUnits() override;
188
189 lldb::CompUnitSP ParseCompileUnitAtIndex(uint32_t index) override;
190
191 void FindTypesByName(llvm::StringRef name, uint32_t max_matches,
192 TypeMap &types);
193
195 const llvm::codeview::ModifierRecord &mr,
196 CompilerType ct);
198 const llvm::codeview::PointerRecord &pr,
199 CompilerType ct);
200 lldb::TypeSP CreateSimpleType(llvm::codeview::TypeIndex ti, CompilerType ct);
202 const llvm::codeview::ClassRecord &cr,
203 CompilerType ct);
205 const llvm::codeview::EnumRecord &er,
206 CompilerType ct);
208 const llvm::codeview::UnionRecord &ur,
209 CompilerType ct);
211 const llvm::codeview::ArrayRecord &ar,
212 CompilerType ct);
214 const llvm::codeview::MemberFunctionRecord &pr,
215 CompilerType ct);
217 const llvm::codeview::ProcedureRecord &pr,
218 CompilerType ct);
220 const llvm::codeview::TagRecord &record,
221 size_t size, CompilerType ct);
222
224 CompileUnit &comp_unit);
227 lldb::TypeSP GetOrCreateType(llvm::codeview::TypeIndex ti);
231 PdbCompilandSymId var_id,
232 bool is_param);
234
236 CompileUnit &comp_unit);
239 PdbCompilandSymId var_id, bool is_param);
246 const llvm::codeview::CVSymbol &cvs);
248 VariableList &variables);
250
251 llvm::Expected<uint32_t> GetFileIndex(const CompilandIndexItem &cii,
252 uint32_t file_id);
253
255 PdbCompilandSymId parent,
256 llvm::function_ref<bool(llvm::codeview::SymbolKind, PdbCompilandSymId)>
257 fn);
258
259 void ParseInlineSite(PdbCompilandSymId inline_site_id, Address func_addr);
260
261 llvm::BumpPtrAllocator m_allocator;
262
265 // UID for anonymous union and anonymous struct as they don't have entities in
266 // pdb debug info.
268
269 std::unique_ptr<llvm::pdb::PDBFile> m_file_up;
270 std::unique_ptr<PdbIndex> m_index;
271
272 llvm::DenseMap<lldb::user_id_t, lldb::VariableSP> m_global_vars;
273 llvm::DenseMap<lldb::user_id_t, lldb::VariableSP> m_local_variables;
274 llvm::DenseMap<lldb::user_id_t, lldb::BlockSP> m_blocks;
275 llvm::DenseMap<lldb::user_id_t, lldb::FunctionSP> m_functions;
276 llvm::DenseMap<lldb::user_id_t, lldb::CompUnitSP> m_compilands;
277 llvm::DenseMap<lldb::user_id_t, lldb::TypeSP> m_types;
278 llvm::DenseMap<lldb::user_id_t, std::shared_ptr<InlineSite>> m_inline_sites;
279 llvm::DenseMap<llvm::codeview::TypeIndex, llvm::codeview::TypeIndex>
281};
282
283} // namespace npdb
284} // namespace lldb_private
285
286#endif // LLDB_SOURCE_PLUGINS_SYMBOLFILE_NATIVEPDB_SYMBOLFILENATIVEPDB_H
A section + offset based address class.
Definition: Address.h:62
A class that describes a single lexical block.
Definition: Block.h:41
A class that describes a compilation unit.
Definition: CompileUnit.h:41
Represents a generic declaration context in a program.
Represents a generic declaration such as a function declaration.
Definition: CompilerDecl.h:28
Generic representation of a type in a programming language.
Definition: CompilerType.h:36
A uniqued constant string class.
Definition: ConstString.h:40
A class to manage flag bits.
Definition: Debugger.h:80
"lldb/Target/ExecutionContext.h" A class that contains an execution context.
A class that describes a function.
Definition: Function.h:399
A class that encapsulates name lookup information.
Definition: Module.h:904
"lldb/Core/SourceLocationSpec.h" A source location specifier class.
A stream class that can stream formatted output to a file.
Definition: Stream.h:28
A list of support files for a CompileUnit.
Definition: FileSpecList.h:23
Defines a list of symbol context objects.
"lldb/Symbol/SymbolContextScope.h" Inherit from this if your object is part of a symbol context and c...
Defines a symbol context baton that can be handed other debug core functions.
Definition: SymbolContext.h:34
Containing protected virtual methods for child classes to override.
Definition: SymbolFile.h:496
bool isA(const void *ClassID) const override
LLVM RTTI support.
Definition: SymbolFile.h:503
Provides public interface for all SymbolFiles.
Definition: SymbolFile.h:50
virtual bool isA(const void *ClassID) const
LLVM RTTI support.
Definition: SymbolFile.h:57
A class that contains all state required for type lookups.
Definition: Type.h:100
This class tracks the state and results of a TypeQuery.
Definition: Type.h:308
PdbIndex - Lazy access to the important parts of a PDB file.
Definition: PdbIndex.h:47
lldb::VariableSP GetOrCreateGlobalVariable(PdbGlobalSymId var_id)
bool ParseLineTable(lldb_private::CompileUnit &comp_unit) override
lldb::TypeSP CreateArrayType(PdbTypeSymId type_id, const llvm::codeview::ArrayRecord &ar, CompilerType ct)
std::optional< ArrayInfo > GetDynamicArrayInfoForUID(lldb::user_id_t type_uid, const lldb_private::ExecutionContext *exe_ctx) override
If type_uid points to an array type, return its characteristics.
lldb::VariableSP CreateGlobalVariable(PdbGlobalSymId var_id)
llvm::Expected< lldb::TypeSystemSP > GetTypeSystemForLanguage(lldb::LanguageType language) override
void InitializeObject() override
Initialize the SymbolFile object.
static SymbolFile * CreateInstance(lldb::ObjectFileSP objfile_sp)
llvm::DenseMap< lldb::user_id_t, lldb::TypeSP > m_types
bool CompleteType(CompilerType &compiler_type) override
lldb::LanguageType ParseLanguage(lldb_private::CompileUnit &comp_unit) override
CompilerDeclContext GetDeclContextForUID(lldb::user_id_t uid) override
lldb::VariableSP GetOrCreateLocalVariable(PdbCompilandSymId scope_id, PdbCompilandSymId var_id, bool is_param)
Block & CreateBlock(PdbCompilandSymId block_id)
size_t ParseVariablesForContext(const SymbolContext &sc) override
size_t ParseFunctions(lldb_private::CompileUnit &comp_unit) override
lldb::TypeSP CreatePointerType(PdbTypeSymId type_id, const llvm::codeview::PointerRecord &pr, CompilerType ct)
lldb::FunctionSP CreateFunction(PdbCompilandSymId func_id, CompileUnit &comp_unit)
llvm::DenseMap< lldb::user_id_t, lldb::BlockSP > m_blocks
bool ParseSupportFiles(lldb_private::CompileUnit &comp_unit, SupportFileList &support_files) override
CompilerDecl GetDeclForUID(lldb::user_id_t uid) override
bool isA(const void *ClassID) const override
LLVM RTTI support.
lldb::TypeSP GetOrCreateTypedef(PdbGlobalSymId id)
void FindTypesByName(llvm::StringRef name, uint32_t max_matches, TypeMap &types)
lldb::TypeSP CreateTagType(PdbTypeSymId type_id, const llvm::codeview::ClassRecord &cr, CompilerType ct)
lldb::TypeSP GetOrCreateType(PdbTypeSymId type_id)
lldb::TypeSP CreateTagType(PdbTypeSymId type_id, const llvm::codeview::UnionRecord &ur, CompilerType ct)
void GetTypes(SymbolContextScope *sc_scope, lldb::TypeClass type_mask, TypeList &type_list) override
llvm::DenseMap< lldb::user_id_t, lldb::VariableSP > m_local_variables
lldb::VariableSP CreateConstantSymbol(PdbGlobalSymId var_id, const llvm::codeview::CVSymbol &cvs)
lldb::TypeSP CreateType(PdbTypeSymId type_id, CompilerType ct)
std::optional< llvm::codeview::TypeIndex > GetParentType(llvm::codeview::TypeIndex ti)
void FindFunctions(const Module::LookupInfo &lookup_info, const CompilerDeclContext &parent_decl_ctx, bool include_inlines, SymbolContextList &sc_list) override
static llvm::StringRef GetPluginDescriptionStatic()
std::unique_ptr< llvm::pdb::PDBFile > m_file_up
lldb::VariableSP CreateLocalVariable(PdbCompilandSymId scope_id, PdbCompilandSymId var_id, bool is_param)
lldb::TypeSP CreateProcedureType(PdbTypeSymId type_id, const llvm::codeview::ProcedureRecord &pr, CompilerType ct)
lldb::TypeSP CreateModifierType(PdbTypeSymId type_id, const llvm::codeview::ModifierRecord &mr, CompilerType ct)
uint64_t GetDebugInfoSize(bool load_all_debug_info=false) override
Metrics gathering functions.
size_t ParseTypes(lldb_private::CompileUnit &comp_unit) override
size_t ParseBlocksRecursive(Function &func) override
lldb::CompUnitSP CreateCompileUnit(const CompilandIndexItem &cci)
std::optional< PdbCompilandSymId > FindSymbolScope(PdbCompilandSymId id)
size_t ParseSymbolArrayInScope(PdbCompilandSymId parent, llvm::function_ref< bool(llvm::codeview::SymbolKind, PdbCompilandSymId)> fn)
const llvm::pdb::PDBFile & GetPDBFile() const
size_t ParseVariablesForCompileUnit(CompileUnit &comp_unit, VariableList &variables)
llvm::DenseMap< lldb::user_id_t, lldb::CompUnitSP > m_compilands
llvm::Expected< uint32_t > GetFileIndex(const CompilandIndexItem &cii, uint32_t file_id)
lldb::CompUnitSP GetOrCreateCompileUnit(const CompilandIndexItem &cci)
Type * ResolveTypeUID(lldb::user_id_t type_uid) override
llvm::DenseMap< lldb::user_id_t, lldb::FunctionSP > m_functions
bool ParseImportedModules(const SymbolContext &sc, std::vector< lldb_private::SourceModule > &imported_modules) override
static void DebuggerInitialize(Debugger &debugger)
llvm::DenseMap< lldb::user_id_t, std::shared_ptr< InlineSite > > m_inline_sites
void ParseInlineSite(PdbCompilandSymId inline_site_id, Address func_addr)
lldb::TypeSP CreateTagType(PdbTypeSymId type_id, const llvm::codeview::EnumRecord &er, CompilerType ct)
lldb::TypeSP CreateClassStructUnion(PdbTypeSymId type_id, const llvm::codeview::TagRecord &record, size_t size, CompilerType ct)
void FindGlobalVariables(ConstString name, const CompilerDeclContext &parent_decl_ctx, uint32_t max_matches, VariableList &variables) override
static llvm::StringRef GetPluginNameStatic()
size_t ParseVariablesForBlock(PdbCompilandSymId block_id)
void ParseDeclsForContext(lldb_private::CompilerDeclContext decl_ctx) override
lldb::FunctionSP GetOrCreateFunction(PdbCompilandSymId func_id, CompileUnit &comp_unit)
Block & GetOrCreateBlock(PdbCompilandSymId block_id)
llvm::DenseMap< llvm::codeview::TypeIndex, llvm::codeview::TypeIndex > m_parent_types
lldb::CompUnitSP ParseCompileUnitAtIndex(uint32_t index) override
lldb::TypeSP CreateFunctionType(PdbTypeSymId type_id, const llvm::codeview::MemberFunctionRecord &pr, CompilerType ct)
lldb::TypeSP CreateAndCacheType(PdbTypeSymId type_id)
CompilerDeclContext FindNamespace(ConstString name, const CompilerDeclContext &parent_decl_ctx, bool only_root_namespaces) override
Finds a namespace of name name and whose parent context is parent_decl_ctx.
CompilerDeclContext GetDeclContextContainingUID(lldb::user_id_t uid) override
bool ParseDebugMacros(lldb_private::CompileUnit &comp_unit) override
lldb::TypeSP CreateTypedef(PdbGlobalSymId id)
void FindTypes(const lldb_private::TypeQuery &match, lldb_private::TypeResults &results) override
Find types using a type-matching object that contains all search parameters.
lldb::TypeSP GetOrCreateType(llvm::codeview::TypeIndex ti)
static bool classof(const SymbolFile *obj)
uint32_t ResolveSymbolContext(const Address &so_addr, lldb::SymbolContextItem resolve_scope, SymbolContext &sc) override
llvm::DenseMap< lldb::user_id_t, lldb::VariableSP > m_global_vars
lldb::TypeSP CreateSimpleType(llvm::codeview::TypeIndex ti, CompilerType ct)
#define LLDB_INVALID_UID
Definition: lldb-defines.h:88
A class that represents a running process on the host machine.
std::shared_ptr< lldb_private::Function > FunctionSP
Definition: lldb-forward.h:351
std::shared_ptr< lldb_private::ObjectFile > ObjectFileSP
Definition: lldb-forward.h:371
LanguageType
Programming language type.
std::shared_ptr< lldb_private::Type > TypeSP
Definition: lldb-forward.h:455
std::shared_ptr< lldb_private::Variable > VariableSP
Definition: lldb-forward.h:480
uint64_t user_id_t
Definition: lldb-types.h:82
uint64_t addr_t
Definition: lldb-types.h:80
std::shared_ptr< lldb_private::CompileUnit > CompUnitSP
Definition: lldb-forward.h:331
Definition: Debugger.h:54
lldb::addr_t file_addr
The file address for this line entry.
Definition: LineTable.h:280
Represents a single compile unit.
std::vector< lldb_private::LineTable::Entry > line_entries
std::shared_ptr< InlineFunctionInfo > inline_function_info
bool operator()(const lldb_private::LineTable::Entry &lhs, const lldb_private::LineTable::Entry &rhs) const