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