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 
23 namespace clang {
24 class TagDecl;
25 }
26 
27 namespace llvm {
28 namespace codeview {
29 class ClassRecord;
30 class EnumRecord;
31 class ModifierRecord;
32 class PointerRecord;
33 struct UnionRecord;
34 } // namespace codeview
35 } // namespace llvm
36 
37 namespace lldb_private {
38 class ClangASTImporter;
39 
40 namespace npdb {
41 class PdbAstBuilder;
42 
43 class SymbolFileNativePDB : public SymbolFile {
44   friend class UdtRecordCompleter;
45 
46 public:
47   //------------------------------------------------------------------
48   // Static Functions
49   //------------------------------------------------------------------
50   static void Initialize();
51 
52   static void Terminate();
53 
54   static void DebuggerInitialize(Debugger &debugger);
55 
56   static ConstString GetPluginNameStatic();
57 
58   static const char *GetPluginDescriptionStatic();
59 
60   static SymbolFile *CreateInstance(ObjectFile *obj_file);
61 
62   //------------------------------------------------------------------
63   // Constructors and Destructors
64   //------------------------------------------------------------------
65   SymbolFileNativePDB(ObjectFile *ofile);
66 
67   ~SymbolFileNativePDB() override;
68 
69   uint32_t CalculateAbilities() override;
70 
71   void InitializeObject() override;
72 
73   //------------------------------------------------------------------
74   // Compile Unit function calls
75   //------------------------------------------------------------------
76 
77   uint32_t GetNumCompileUnits() override;
78 
79   void
80   ParseDeclsForContext(lldb_private::CompilerDeclContext decl_ctx) override;
81 
82   lldb::CompUnitSP ParseCompileUnitAtIndex(uint32_t index) override;
83 
84   lldb::LanguageType
85   ParseLanguage(lldb_private::CompileUnit &comp_unit) override;
86 
87   size_t ParseFunctions(lldb_private::CompileUnit &comp_unit) override;
88 
89   bool ParseLineTable(lldb_private::CompileUnit &comp_unit) override;
90 
91   bool ParseDebugMacros(lldb_private::CompileUnit &comp_unit) override;
92 
93   bool ParseSupportFiles(lldb_private::CompileUnit &comp_unit,
94                          FileSpecList &support_files) override;
95   size_t ParseTypes(lldb_private::CompileUnit &comp_unit) override;
96 
97   bool ParseImportedModules(
98       const SymbolContext &sc,
99       std::vector<lldb_private::SourceModule> &imported_modules) override;
100 
101   size_t ParseBlocksRecursive(Function &func) override;
102 
103   uint32_t FindGlobalVariables(ConstString name,
104                                const CompilerDeclContext *parent_decl_ctx,
105                                uint32_t max_matches,
106                                VariableList &variables) override;
107 
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(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(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(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   lldb::TypeSP GetOrCreateTypedef(PdbGlobalSymId id);
207 
208   lldb::FunctionSP CreateFunction(PdbCompilandSymId func_id,
209                                   CompileUnit &comp_unit);
210   Block &CreateBlock(PdbCompilandSymId block_id);
211   lldb::VariableSP CreateLocalVariable(PdbCompilandSymId scope_id,
212                                        PdbCompilandSymId var_id, bool is_param);
213   lldb::TypeSP CreateTypedef(PdbGlobalSymId id);
214   lldb::CompUnitSP CreateCompileUnit(const CompilandIndexItem &cci);
215   lldb::TypeSP CreateType(PdbTypeSymId type_id, CompilerType ct);
216   lldb::TypeSP CreateAndCacheType(PdbTypeSymId type_id);
217   lldb::VariableSP CreateGlobalVariable(PdbGlobalSymId var_id);
218   lldb::VariableSP CreateConstantSymbol(PdbGlobalSymId var_id,
219                                         const llvm::codeview::CVSymbol &cvs);
220   size_t ParseVariablesForCompileUnit(CompileUnit &comp_unit,
221                                       VariableList &variables);
222   size_t ParseVariablesForBlock(PdbCompilandSymId block_id);
223 
224   llvm::BumpPtrAllocator m_allocator;
225 
226   lldb::addr_t m_obj_load_address = 0;
227   bool m_done_full_type_scan = false;
228 
229   std::unique_ptr<PdbIndex> m_index;
230 
231   std::unique_ptr<PdbAstBuilder> m_ast;
232 
233   llvm::DenseMap<lldb::user_id_t, lldb::VariableSP> m_global_vars;
234   llvm::DenseMap<lldb::user_id_t, lldb::VariableSP> m_local_variables;
235   llvm::DenseMap<lldb::user_id_t, lldb::BlockSP> m_blocks;
236   llvm::DenseMap<lldb::user_id_t, lldb::FunctionSP> m_functions;
237   llvm::DenseMap<lldb::user_id_t, lldb::CompUnitSP> m_compilands;
238   llvm::DenseMap<lldb::user_id_t, lldb::TypeSP> m_types;
239 };
240 
241 } // namespace npdb
242 } // namespace lldb_private
243 
244 #endif // lldb_Plugins_SymbolFile_PDB_SymbolFilePDB_h_
245