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 
24 namespace clang {
25 class TagDecl;
26 }
27 
28 namespace llvm {
29 namespace codeview {
30 class ClassRecord;
31 class EnumRecord;
32 class ModifierRecord;
33 class PointerRecord;
34 struct UnionRecord;
35 } // namespace codeview
36 } // namespace llvm
37 
38 namespace lldb_private {
39 class ClangASTImporter;
40 
41 namespace npdb {
42 class PdbAstBuilder;
43 
44 class SymbolFileNativePDB : public SymbolFile {
45   friend class UdtRecordCompleter;
46 
47 public:
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   lldb::CompUnitSP ParseCompileUnitAtIndex(uint32_t index) override;
81 
82   lldb::LanguageType ParseCompileUnitLanguage(const SymbolContext &sc) override;
83 
84   size_t ParseCompileUnitFunctions(const SymbolContext &sc) override;
85 
86   bool ParseCompileUnitLineTable(const SymbolContext &sc) override;
87 
88   bool ParseCompileUnitDebugMacros(const SymbolContext &sc) override;
89 
90   bool ParseCompileUnitSupportFiles(const SymbolContext &sc,
91                                     FileSpecList &support_files) override;
92 
93   bool
94   ParseImportedModules(const SymbolContext &sc,
95                        std::vector<ConstString> &imported_modules) override;
96 
97   size_t ParseFunctionBlocks(const SymbolContext &sc) override;
98 
99   uint32_t FindGlobalVariables(const ConstString &name,
100                                const CompilerDeclContext *parent_decl_ctx,
101                                uint32_t max_matches,
102                                VariableList &variables) override;
103 
104   size_t ParseTypes(const SymbolContext &sc) override;
105   size_t ParseVariablesForContext(const SymbolContext &sc) override;
106 
107   CompilerDecl GetDeclForUID(lldb::user_id_t uid) override;
108   CompilerDeclContext GetDeclContextForUID(lldb::user_id_t uid) override;
109   CompilerDeclContext GetDeclContextContainingUID(lldb::user_id_t uid) override;
110   Type *ResolveTypeUID(lldb::user_id_t type_uid) override;
111   llvm::Optional<ArrayInfo> GetDynamicArrayInfoForUID(
112       lldb::user_id_t type_uid,
113       const lldb_private::ExecutionContext *exe_ctx) override;
114 
115   bool CompleteType(CompilerType &compiler_type) override;
116   uint32_t ResolveSymbolContext(const Address &so_addr,
117                                 lldb::SymbolContextItem resolve_scope,
118                                 SymbolContext &sc) override;
119 
120   size_t GetTypes(SymbolContextScope *sc_scope, lldb::TypeClass type_mask,
121                   TypeList &type_list) override;
122 
123   uint32_t FindFunctions(const ConstString &name,
124                          const CompilerDeclContext *parent_decl_ctx,
125                          lldb::FunctionNameType name_type_mask,
126                          bool include_inlines, bool append,
127                          SymbolContextList &sc_list) override;
128 
129   uint32_t FindFunctions(const RegularExpression &regex, bool include_inlines,
130                          bool append, SymbolContextList &sc_list) override;
131 
132   uint32_t FindTypes(const SymbolContext &sc, const ConstString &name,
133                      const CompilerDeclContext *parent_decl_ctx, bool append,
134                      uint32_t max_matches,
135                      llvm::DenseSet<SymbolFile *> &searched_symbol_files,
136                      TypeMap &types) override;
137 
138   size_t FindTypes(const std::vector<CompilerContext> &context, bool append,
139                    TypeMap &types) override;
140 
141   TypeSystem *GetTypeSystemForLanguage(lldb::LanguageType language) override;
142 
143   CompilerDeclContext
144   FindNamespace(const SymbolContext &sc, const ConstString &name,
145                 const CompilerDeclContext *parent_decl_ctx) override;
146 
147   ConstString GetPluginName() override;
148 
149   uint32_t GetPluginVersion() override;
150 
151   llvm::pdb::PDBFile &GetPDBFile() { return m_index->pdb(); }
152   const llvm::pdb::PDBFile &GetPDBFile() const { return m_index->pdb(); }
153 
154   void DumpClangAST(Stream &s) override;
155 
156 private:
157 
158   size_t FindTypesByName(llvm::StringRef name, uint32_t max_matches,
159                          TypeMap &types);
160 
161   lldb::TypeSP CreateModifierType(PdbTypeSymId type_id,
162                                   const llvm::codeview::ModifierRecord &mr,
163                                   CompilerType ct);
164   lldb::TypeSP CreatePointerType(PdbTypeSymId type_id,
165                                  const llvm::codeview::PointerRecord &pr,
166                                  CompilerType ct);
167   lldb::TypeSP CreateSimpleType(llvm::codeview::TypeIndex ti, CompilerType ct);
168   lldb::TypeSP CreateTagType(PdbTypeSymId type_id,
169                              const llvm::codeview::ClassRecord &cr,
170                              CompilerType ct);
171   lldb::TypeSP CreateTagType(PdbTypeSymId type_id,
172                              const llvm::codeview::EnumRecord &er,
173                              CompilerType ct);
174   lldb::TypeSP CreateTagType(PdbTypeSymId type_id,
175                              const llvm::codeview::UnionRecord &ur,
176                              CompilerType ct);
177   lldb::TypeSP CreateArrayType(PdbTypeSymId type_id,
178                                const llvm::codeview::ArrayRecord &ar,
179                                CompilerType ct);
180   lldb::TypeSP CreateProcedureType(PdbTypeSymId type_id,
181                                    const llvm::codeview::ProcedureRecord &pr,
182                                    CompilerType ct);
183   lldb::TypeSP CreateClassStructUnion(PdbTypeSymId type_id,
184                                       const llvm::codeview::TagRecord &record,
185                                       size_t size, CompilerType ct);
186 
187   lldb::FunctionSP GetOrCreateFunction(PdbCompilandSymId func_id,
188                                        CompileUnit &comp_unit);
189   lldb::CompUnitSP GetOrCreateCompileUnit(const CompilandIndexItem &cci);
190   lldb::TypeSP GetOrCreateType(PdbTypeSymId type_id);
191   lldb::TypeSP GetOrCreateType(llvm::codeview::TypeIndex ti);
192   lldb::VariableSP GetOrCreateGlobalVariable(PdbGlobalSymId var_id);
193   Block &GetOrCreateBlock(PdbCompilandSymId block_id);
194   lldb::VariableSP GetOrCreateLocalVariable(PdbCompilandSymId scope_id,
195                                             PdbCompilandSymId var_id,
196                                             bool is_param);
197 
198   lldb::FunctionSP CreateFunction(PdbCompilandSymId func_id,
199                                   CompileUnit &comp_unit);
200   Block &CreateBlock(PdbCompilandSymId block_id);
201   lldb::VariableSP CreateLocalVariable(PdbCompilandSymId scope_id,
202                                        PdbCompilandSymId var_id, bool is_param);
203   lldb::CompUnitSP CreateCompileUnit(const CompilandIndexItem &cci);
204   lldb::TypeSP CreateType(PdbTypeSymId type_id, CompilerType ct);
205   lldb::TypeSP CreateAndCacheType(PdbTypeSymId type_id);
206   lldb::VariableSP CreateGlobalVariable(PdbGlobalSymId var_id);
207   lldb::VariableSP CreateConstantSymbol(PdbGlobalSymId var_id,
208                                         const llvm::codeview::CVSymbol &cvs);
209   size_t ParseVariablesForCompileUnit(CompileUnit &comp_unit,
210                                       VariableList &variables);
211   size_t ParseVariablesForBlock(PdbCompilandSymId block_id);
212 
213   llvm::BumpPtrAllocator m_allocator;
214 
215   lldb::addr_t m_obj_load_address = 0;
216 
217   std::unique_ptr<PdbIndex> m_index;
218 
219   std::unique_ptr<PdbAstBuilder> m_ast;
220 
221   llvm::DenseMap<lldb::user_id_t, lldb::VariableSP> m_global_vars;
222   llvm::DenseMap<lldb::user_id_t, lldb::VariableSP> m_local_variables;
223   llvm::DenseMap<lldb::user_id_t, lldb::BlockSP> m_blocks;
224   llvm::DenseMap<lldb::user_id_t, lldb::FunctionSP> m_functions;
225   llvm::DenseMap<lldb::user_id_t, lldb::CompUnitSP> m_compilands;
226   llvm::DenseMap<lldb::user_id_t, lldb::TypeSP> m_types;
227 };
228 
229 } // namespace npdb
230 } // namespace lldb_private
231 
232 #endif // lldb_Plugins_SymbolFile_PDB_SymbolFilePDB_h_
233