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   // Static Functions
48   static void Initialize();
49 
50   static void Terminate();
51 
52   static void DebuggerInitialize(Debugger &debugger);
53 
54   static ConstString GetPluginNameStatic();
55 
56   static const char *GetPluginDescriptionStatic();
57 
58   static SymbolFile *CreateInstance(ObjectFile *obj_file);
59 
60   // Constructors and Destructors
61   SymbolFileNativePDB(ObjectFile *ofile);
62 
63   ~SymbolFileNativePDB() override;
64 
65   uint32_t CalculateAbilities() override;
66 
67   void InitializeObject() override;
68 
69   // Compile Unit function calls
70 
71   void
72   ParseDeclsForContext(lldb_private::CompilerDeclContext decl_ctx) override;
73 
74   lldb::LanguageType
75   ParseLanguage(lldb_private::CompileUnit &comp_unit) override;
76 
77   size_t ParseFunctions(lldb_private::CompileUnit &comp_unit) override;
78 
79   bool ParseLineTable(lldb_private::CompileUnit &comp_unit) override;
80 
81   bool ParseDebugMacros(lldb_private::CompileUnit &comp_unit) override;
82 
83   bool ParseSupportFiles(lldb_private::CompileUnit &comp_unit,
84                          FileSpecList &support_files) override;
85   size_t ParseTypes(lldb_private::CompileUnit &comp_unit) override;
86 
87   bool ParseImportedModules(
88       const SymbolContext &sc,
89       std::vector<lldb_private::SourceModule> &imported_modules) override;
90 
91   size_t ParseBlocksRecursive(Function &func) override;
92 
93   uint32_t FindGlobalVariables(ConstString name,
94                                const CompilerDeclContext *parent_decl_ctx,
95                                uint32_t max_matches,
96                                VariableList &variables) override;
97 
98   size_t ParseVariablesForContext(const SymbolContext &sc) override;
99 
100   void AddSymbols(Symtab &symtab) override;
101 
102   CompilerDecl GetDeclForUID(lldb::user_id_t uid) override;
103   CompilerDeclContext GetDeclContextForUID(lldb::user_id_t uid) override;
104   CompilerDeclContext GetDeclContextContainingUID(lldb::user_id_t uid) override;
105   Type *ResolveTypeUID(lldb::user_id_t type_uid) override;
106   llvm::Optional<ArrayInfo> GetDynamicArrayInfoForUID(
107       lldb::user_id_t type_uid,
108       const lldb_private::ExecutionContext *exe_ctx) override;
109 
110   bool CompleteType(CompilerType &compiler_type) override;
111   uint32_t ResolveSymbolContext(const Address &so_addr,
112                                 lldb::SymbolContextItem resolve_scope,
113                                 SymbolContext &sc) override;
114   uint32_t ResolveSymbolContext(const FileSpec &file_spec, uint32_t line,
115                                 bool check_inlines,
116                                 lldb::SymbolContextItem resolve_scope,
117                                 SymbolContextList &sc_list) override;
118 
119   size_t GetTypes(SymbolContextScope *sc_scope, lldb::TypeClass type_mask,
120                   TypeList &type_list) override;
121 
122   uint32_t FindFunctions(ConstString name,
123                          const CompilerDeclContext *parent_decl_ctx,
124                          lldb::FunctionNameType name_type_mask,
125                          bool include_inlines, bool append,
126                          SymbolContextList &sc_list) override;
127 
128   uint32_t FindFunctions(const RegularExpression &regex, bool include_inlines,
129                          bool append, SymbolContextList &sc_list) override;
130 
131   uint32_t FindTypes(ConstString name,
132                      const CompilerDeclContext *parent_decl_ctx, bool append,
133                      uint32_t max_matches,
134                      llvm::DenseSet<SymbolFile *> &searched_symbol_files,
135                      TypeMap &types) override;
136 
137   size_t FindTypes(const std::vector<CompilerContext> &context, bool append,
138                    TypeMap &types) override;
139 
140   TypeSystem *GetTypeSystemForLanguage(lldb::LanguageType language) override;
141 
142   CompilerDeclContext
143   FindNamespace(ConstString name,
144                 const CompilerDeclContext *parent_decl_ctx) override;
145 
146   ConstString GetPluginName() override;
147 
148   uint32_t GetPluginVersion() override;
149 
150   llvm::pdb::PDBFile &GetPDBFile() { return m_index->pdb(); }
151   const llvm::pdb::PDBFile &GetPDBFile() const { return m_index->pdb(); }
152 
153   void DumpClangAST(Stream &s) override;
154 
155 private:
156   uint32_t CalculateNumCompileUnits() override;
157 
158   lldb::CompUnitSP ParseCompileUnitAtIndex(uint32_t index) override;
159 
160   size_t FindTypesByName(llvm::StringRef name, uint32_t max_matches,
161                          TypeMap &types);
162 
163   lldb::TypeSP CreateModifierType(PdbTypeSymId type_id,
164                                   const llvm::codeview::ModifierRecord &mr,
165                                   CompilerType ct);
166   lldb::TypeSP CreatePointerType(PdbTypeSymId type_id,
167                                  const llvm::codeview::PointerRecord &pr,
168                                  CompilerType ct);
169   lldb::TypeSP CreateSimpleType(llvm::codeview::TypeIndex ti, CompilerType ct);
170   lldb::TypeSP CreateTagType(PdbTypeSymId type_id,
171                              const llvm::codeview::ClassRecord &cr,
172                              CompilerType ct);
173   lldb::TypeSP CreateTagType(PdbTypeSymId type_id,
174                              const llvm::codeview::EnumRecord &er,
175                              CompilerType ct);
176   lldb::TypeSP CreateTagType(PdbTypeSymId type_id,
177                              const llvm::codeview::UnionRecord &ur,
178                              CompilerType ct);
179   lldb::TypeSP CreateArrayType(PdbTypeSymId type_id,
180                                const llvm::codeview::ArrayRecord &ar,
181                                CompilerType ct);
182   lldb::TypeSP CreateFunctionType(PdbTypeSymId type_id,
183                                   const llvm::codeview::MemberFunctionRecord &pr,
184                                   CompilerType ct);
185   lldb::TypeSP CreateProcedureType(PdbTypeSymId type_id,
186                                    const llvm::codeview::ProcedureRecord &pr,
187                                    CompilerType ct);
188   lldb::TypeSP CreateClassStructUnion(PdbTypeSymId type_id,
189                                       const llvm::codeview::TagRecord &record,
190                                       size_t size, CompilerType ct);
191 
192   lldb::FunctionSP GetOrCreateFunction(PdbCompilandSymId func_id,
193                                        CompileUnit &comp_unit);
194   lldb::CompUnitSP GetOrCreateCompileUnit(const CompilandIndexItem &cci);
195   lldb::TypeSP GetOrCreateType(PdbTypeSymId type_id);
196   lldb::TypeSP GetOrCreateType(llvm::codeview::TypeIndex ti);
197   lldb::VariableSP GetOrCreateGlobalVariable(PdbGlobalSymId var_id);
198   Block &GetOrCreateBlock(PdbCompilandSymId block_id);
199   lldb::VariableSP GetOrCreateLocalVariable(PdbCompilandSymId scope_id,
200                                             PdbCompilandSymId var_id,
201                                             bool is_param);
202   lldb::TypeSP GetOrCreateTypedef(PdbGlobalSymId id);
203 
204   lldb::FunctionSP CreateFunction(PdbCompilandSymId func_id,
205                                   CompileUnit &comp_unit);
206   Block &CreateBlock(PdbCompilandSymId block_id);
207   lldb::VariableSP CreateLocalVariable(PdbCompilandSymId scope_id,
208                                        PdbCompilandSymId var_id, bool is_param);
209   lldb::TypeSP CreateTypedef(PdbGlobalSymId id);
210   lldb::CompUnitSP CreateCompileUnit(const CompilandIndexItem &cci);
211   lldb::TypeSP CreateType(PdbTypeSymId type_id, CompilerType ct);
212   lldb::TypeSP CreateAndCacheType(PdbTypeSymId type_id);
213   lldb::VariableSP CreateGlobalVariable(PdbGlobalSymId var_id);
214   lldb::VariableSP CreateConstantSymbol(PdbGlobalSymId var_id,
215                                         const llvm::codeview::CVSymbol &cvs);
216   size_t ParseVariablesForCompileUnit(CompileUnit &comp_unit,
217                                       VariableList &variables);
218   size_t ParseVariablesForBlock(PdbCompilandSymId block_id);
219 
220   llvm::BumpPtrAllocator m_allocator;
221 
222   lldb::addr_t m_obj_load_address = 0;
223   bool m_done_full_type_scan = false;
224 
225   std::unique_ptr<PdbIndex> m_index;
226 
227   std::unique_ptr<PdbAstBuilder> m_ast;
228 
229   llvm::DenseMap<lldb::user_id_t, lldb::VariableSP> m_global_vars;
230   llvm::DenseMap<lldb::user_id_t, lldb::VariableSP> m_local_variables;
231   llvm::DenseMap<lldb::user_id_t, lldb::BlockSP> m_blocks;
232   llvm::DenseMap<lldb::user_id_t, lldb::FunctionSP> m_functions;
233   llvm::DenseMap<lldb::user_id_t, lldb::CompUnitSP> m_compilands;
234   llvm::DenseMap<lldb::user_id_t, lldb::TypeSP> m_types;
235 };
236 
237 } // namespace npdb
238 } // namespace lldb_private
239 
240 #endif // lldb_Plugins_SymbolFile_PDB_SymbolFilePDB_h_
241