SymbolFileNativePDB.h revision 343218 
1//===-- SymbolFileNativePDB.h -----------------------------------*- C++ -*-===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
10#ifndef LLDB_PLUGINS_SYMBOLFILE_NATIVEPDB_SYMBOLFILENATIVEPDB_H
11#define LLDB_PLUGINS_SYMBOLFILE_NATIVEPDB_SYMBOLFILENATIVEPDB_H
12
13#include "lldb/Symbol/ClangASTImporter.h"
14#include "lldb/Symbol/SymbolFile.h"
15
16#include "llvm/ADT/DenseMap.h"
17#include "llvm/DebugInfo/CodeView/CVRecord.h"
18#include "llvm/DebugInfo/CodeView/SymbolRecord.h"
19#include "llvm/DebugInfo/PDB/PDBTypes.h"
20
21#include "CompileUnitIndex.h"
22#include "PdbIndex.h"
23
24namespace clang {
25class TagDecl;
26}
27
28namespace llvm {
29namespace codeview {
30class ClassRecord;
31class EnumRecord;
32class ModifierRecord;
33class PointerRecord;
34struct UnionRecord;
35} // namespace codeview
36} // namespace llvm
37
38namespace lldb_private {
39class ClangASTImporter;
40
41namespace npdb {
42class PdbAstBuilder;
43
44class SymbolFileNativePDB : public SymbolFile {
45  friend class UdtRecordCompleter;
46
47public:
48  //------------------------------------------------------------------
49  // Static Functions
50  //------------------------------------------------------------------
51  static void Initialize();
52
53  static void Terminate();
54
55  static void DebuggerInitialize(Debugger &debugger);
56
57  static ConstString GetPluginNameStatic();
58
59  static const char *GetPluginDescriptionStatic();
60
61  static SymbolFile *CreateInstance(ObjectFile *obj_file);
62
63  //------------------------------------------------------------------
64  // Constructors and Destructors
65  //------------------------------------------------------------------
66  SymbolFileNativePDB(ObjectFile *ofile);
67
68  ~SymbolFileNativePDB() override;
69
70  uint32_t CalculateAbilities() override;
71
72  void InitializeObject() override;
73
74  //------------------------------------------------------------------
75  // Compile Unit function calls
76  //------------------------------------------------------------------
77
78  uint32_t GetNumCompileUnits() override;
79
80  void
81  ParseDeclsForContext(lldb_private::CompilerDeclContext decl_ctx) override;
82
83  lldb::CompUnitSP ParseCompileUnitAtIndex(uint32_t index) 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
99  ParseImportedModules(const SymbolContext &sc,
100                       std::vector<ConstString> &imported_modules) override;
101
102  size_t ParseBlocksRecursive(Function &func) override;
103
104  uint32_t FindGlobalVariables(const 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 FileSpec &file_spec, uint32_t line,
126                                bool check_inlines,
127                                lldb::SymbolContextItem resolve_scope,
128                                SymbolContextList &sc_list) override;
129
130  size_t GetTypes(SymbolContextScope *sc_scope, lldb::TypeClass type_mask,
131                  TypeList &type_list) override;
132
133  uint32_t FindFunctions(const ConstString &name,
134                         const CompilerDeclContext *parent_decl_ctx,
135                         lldb::FunctionNameType name_type_mask,
136                         bool include_inlines, bool append,
137                         SymbolContextList &sc_list) override;
138
139  uint32_t FindFunctions(const RegularExpression &regex, bool include_inlines,
140                         bool append, SymbolContextList &sc_list) override;
141
142  uint32_t FindTypes(const ConstString &name,
143                     const CompilerDeclContext *parent_decl_ctx, bool append,
144                     uint32_t max_matches,
145                     llvm::DenseSet<SymbolFile *> &searched_symbol_files,
146                     TypeMap &types) override;
147
148  size_t FindTypes(const std::vector<CompilerContext> &context, bool append,
149                   TypeMap &types) override;
150
151  TypeSystem *GetTypeSystemForLanguage(lldb::LanguageType language) override;
152
153  CompilerDeclContext
154  FindNamespace(const ConstString &name,
155                const CompilerDeclContext *parent_decl_ctx) override;
156
157  ConstString GetPluginName() override;
158
159  uint32_t GetPluginVersion() override;
160
161  llvm::pdb::PDBFile &GetPDBFile() { return m_index->pdb(); }
162  const llvm::pdb::PDBFile &GetPDBFile() const { return m_index->pdb(); }
163
164  void DumpClangAST(Stream &s) override;
165
166private:
167
168  size_t 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 CreateProcedureType(PdbTypeSymId type_id,
191                                   const llvm::codeview::ProcedureRecord &pr,
192                                   CompilerType ct);
193  lldb::TypeSP CreateClassStructUnion(PdbTypeSymId type_id,
194                                      const llvm::codeview::TagRecord &record,
195                                      size_t size, CompilerType ct);
196
197  lldb::FunctionSP GetOrCreateFunction(PdbCompilandSymId func_id,
198                                       CompileUnit &comp_unit);
199  lldb::CompUnitSP GetOrCreateCompileUnit(const CompilandIndexItem &cci);
200  lldb::TypeSP GetOrCreateType(PdbTypeSymId type_id);
201  lldb::TypeSP GetOrCreateType(llvm::codeview::TypeIndex ti);
202  lldb::VariableSP GetOrCreateGlobalVariable(PdbGlobalSymId var_id);
203  Block &GetOrCreateBlock(PdbCompilandSymId block_id);
204  lldb::VariableSP GetOrCreateLocalVariable(PdbCompilandSymId scope_id,
205                                            PdbCompilandSymId var_id,
206                                            bool is_param);
207  lldb::TypeSP GetOrCreateTypedef(PdbGlobalSymId id);
208
209  lldb::FunctionSP CreateFunction(PdbCompilandSymId func_id,
210                                  CompileUnit &comp_unit);
211  Block &CreateBlock(PdbCompilandSymId block_id);
212  lldb::VariableSP CreateLocalVariable(PdbCompilandSymId scope_id,
213                                       PdbCompilandSymId var_id, bool is_param);
214  lldb::TypeSP CreateTypedef(PdbGlobalSymId id);
215  lldb::CompUnitSP CreateCompileUnit(const CompilandIndexItem &cci);
216  lldb::TypeSP CreateType(PdbTypeSymId type_id, CompilerType ct);
217  lldb::TypeSP CreateAndCacheType(PdbTypeSymId type_id);
218  lldb::VariableSP CreateGlobalVariable(PdbGlobalSymId var_id);
219  lldb::VariableSP CreateConstantSymbol(PdbGlobalSymId var_id,
220                                        const llvm::codeview::CVSymbol &cvs);
221  size_t ParseVariablesForCompileUnit(CompileUnit &comp_unit,
222                                      VariableList &variables);
223  size_t ParseVariablesForBlock(PdbCompilandSymId block_id);
224
225  llvm::BumpPtrAllocator m_allocator;
226
227  lldb::addr_t m_obj_load_address = 0;
228  bool m_done_full_type_scan = false;
229
230  std::unique_ptr<PdbIndex> m_index;
231
232  std::unique_ptr<PdbAstBuilder> m_ast;
233
234  llvm::DenseMap<lldb::user_id_t, lldb::VariableSP> m_global_vars;
235  llvm::DenseMap<lldb::user_id_t, lldb::VariableSP> m_local_variables;
236  llvm::DenseMap<lldb::user_id_t, lldb::BlockSP> m_blocks;
237  llvm::DenseMap<lldb::user_id_t, lldb::FunctionSP> m_functions;
238  llvm::DenseMap<lldb::user_id_t, lldb::CompUnitSP> m_compilands;
239  llvm::DenseMap<lldb::user_id_t, lldb::TypeSP> m_types;
240};
241
242} // namespace npdb
243} // namespace lldb_private
244
245#endif // lldb_Plugins_SymbolFile_PDB_SymbolFilePDB_h_
246