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