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