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