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 
43 struct DeclStatus {
44   DeclStatus() = default;
45   DeclStatus(lldb::user_id_t uid, Type::ResolveStateTag status)
46       : uid(uid), status(status) {}
47   lldb::user_id_t uid = 0;
48   Type::ResolveStateTag status = Type::eResolveStateForward;
49 };
50 
51 class SymbolFileNativePDB : public SymbolFile {
52   friend class UdtRecordCompleter;
53 
54 public:
55   //------------------------------------------------------------------
56   // Static Functions
57   //------------------------------------------------------------------
58   static void Initialize();
59 
60   static void Terminate();
61 
62   static void DebuggerInitialize(Debugger &debugger);
63 
64   static ConstString GetPluginNameStatic();
65 
66   static const char *GetPluginDescriptionStatic();
67 
68   static SymbolFile *CreateInstance(ObjectFile *obj_file);
69 
70   //------------------------------------------------------------------
71   // Constructors and Destructors
72   //------------------------------------------------------------------
73   SymbolFileNativePDB(ObjectFile *ofile);
74 
75   ~SymbolFileNativePDB() override;
76 
77   uint32_t CalculateAbilities() override;
78 
79   void InitializeObject() override;
80 
81   //------------------------------------------------------------------
82   // Compile Unit function calls
83   //------------------------------------------------------------------
84 
85   uint32_t GetNumCompileUnits() override;
86 
87   lldb::CompUnitSP ParseCompileUnitAtIndex(uint32_t index) override;
88 
89   lldb::LanguageType ParseCompileUnitLanguage(const SymbolContext &sc) override;
90 
91   size_t ParseCompileUnitFunctions(const SymbolContext &sc) override;
92 
93   bool ParseCompileUnitLineTable(const SymbolContext &sc) override;
94 
95   bool ParseCompileUnitDebugMacros(const SymbolContext &sc) override;
96 
97   bool ParseCompileUnitSupportFiles(const SymbolContext &sc,
98                                     FileSpecList &support_files) override;
99 
100   bool
101   ParseImportedModules(const SymbolContext &sc,
102                        std::vector<ConstString> &imported_modules) override;
103 
104   size_t ParseFunctionBlocks(const SymbolContext &sc) override;
105 
106   uint32_t FindGlobalVariables(const ConstString &name,
107                                const CompilerDeclContext *parent_decl_ctx,
108                                uint32_t max_matches,
109                                VariableList &variables) override;
110 
111   size_t ParseTypes(const SymbolContext &sc) override;
112   size_t ParseVariablesForContext(const SymbolContext &sc) override {
113     return 0;
114   }
115 
116   CompilerDeclContext GetDeclContextContainingUID(lldb::user_id_t uid) override;
117   Type *ResolveTypeUID(lldb::user_id_t type_uid) override;
118   llvm::Optional<ArrayInfo> GetDynamicArrayInfoForUID(
119       lldb::user_id_t type_uid,
120       const lldb_private::ExecutionContext *exe_ctx) override;
121 
122   bool CompleteType(CompilerType &compiler_type) override;
123   uint32_t ResolveSymbolContext(const Address &so_addr,
124                                 lldb::SymbolContextItem resolve_scope,
125                                 SymbolContext &sc) override;
126 
127   size_t GetTypes(SymbolContextScope *sc_scope, lldb::TypeClass type_mask,
128                   TypeList &type_list) override;
129 
130   uint32_t FindFunctions(const ConstString &name,
131                          const CompilerDeclContext *parent_decl_ctx,
132                          lldb::FunctionNameType name_type_mask,
133                          bool include_inlines, bool append,
134                          SymbolContextList &sc_list) override;
135 
136   uint32_t FindFunctions(const RegularExpression &regex, bool include_inlines,
137                          bool append, SymbolContextList &sc_list) override;
138 
139   uint32_t FindTypes(const SymbolContext &sc, const ConstString &name,
140                      const CompilerDeclContext *parent_decl_ctx, bool append,
141                      uint32_t max_matches,
142                      llvm::DenseSet<SymbolFile *> &searched_symbol_files,
143                      TypeMap &types) override;
144 
145   size_t FindTypes(const std::vector<CompilerContext> &context, bool append,
146                    TypeMap &types) override;
147 
148   TypeSystem *GetTypeSystemForLanguage(lldb::LanguageType language) override;
149 
150   CompilerDeclContext
151   FindNamespace(const SymbolContext &sc, const ConstString &name,
152                 const CompilerDeclContext *parent_decl_ctx) override;
153 
154   ConstString GetPluginName() override;
155 
156   uint32_t GetPluginVersion() override;
157 
158   llvm::pdb::PDBFile &GetPDBFile() { return m_index->pdb(); }
159   const llvm::pdb::PDBFile &GetPDBFile() const { return m_index->pdb(); }
160 
161   ClangASTContext &GetASTContext() { return *m_clang; }
162   ClangASTImporter &GetASTImporter() { return *m_importer; }
163 
164   void DumpClangAST(Stream &s) override;
165 
166 private:
167   std::pair<clang::DeclContext *, std::string>
168   CreateDeclInfoForType(const llvm::codeview::TagRecord &record,
169                         llvm::codeview::TypeIndex ti);
170 
171   void PreprocessTpiStream();
172   size_t FindTypesByName(llvm::StringRef name, uint32_t max_matches,
173                          TypeMap &types);
174 
175   lldb::TypeSP CreateModifierType(PdbTypeSymId type_id,
176                                   const llvm::codeview::ModifierRecord &mr);
177   lldb::TypeSP CreatePointerType(PdbTypeSymId type_id,
178                                  const llvm::codeview::PointerRecord &pr);
179   lldb::TypeSP CreateSimpleType(llvm::codeview::TypeIndex ti);
180   lldb::TypeSP CreateTagType(PdbTypeSymId type_id,
181                              const llvm::codeview::ClassRecord &cr);
182   lldb::TypeSP CreateTagType(PdbTypeSymId type_id,
183                              const llvm::codeview::EnumRecord &er);
184   lldb::TypeSP CreateTagType(PdbTypeSymId type_id,
185                              const llvm::codeview::UnionRecord &ur);
186   lldb::TypeSP CreateArrayType(PdbTypeSymId type_id,
187                                const llvm::codeview::ArrayRecord &ar);
188   lldb::TypeSP CreateProcedureType(PdbTypeSymId type_id,
189                                    const llvm::codeview::ProcedureRecord &pr);
190   lldb::TypeSP
191   CreateClassStructUnion(PdbTypeSymId type_id,
192                          const llvm::codeview::TagRecord &record, size_t size,
193                          clang::TagTypeKind ttk,
194                          clang::MSInheritanceAttr::Spelling inheritance);
195 
196   lldb::FunctionSP GetOrCreateFunction(PdbCompilandSymId func_id,
197                                        const SymbolContext &sc);
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 
203   lldb::FunctionSP CreateFunction(PdbCompilandSymId func_id,
204                                   const SymbolContext &sc);
205   lldb::CompUnitSP CreateCompileUnit(const CompilandIndexItem &cci);
206   lldb::TypeSP CreateType(PdbTypeSymId type_id);
207   lldb::TypeSP CreateAndCacheType(PdbTypeSymId type_id);
208   lldb::VariableSP CreateGlobalVariable(PdbGlobalSymId var_id);
209   lldb::VariableSP CreateConstantSymbol(PdbGlobalSymId var_id,
210                                         const llvm::codeview::CVSymbol &cvs);
211 
212   llvm::BumpPtrAllocator m_allocator;
213 
214   lldb::addr_t m_obj_load_address = 0;
215 
216   std::unique_ptr<PdbIndex> m_index;
217   std::unique_ptr<ClangASTImporter> m_importer;
218   ClangASTContext *m_clang = nullptr;
219 
220   llvm::DenseMap<clang::TagDecl *, DeclStatus> m_decl_to_status;
221 
222   llvm::DenseMap<lldb::user_id_t, clang::Decl *> m_uid_to_decl;
223   llvm::DenseMap<llvm::codeview::TypeIndex, llvm::codeview::TypeIndex>
224       m_parent_types;
225 
226   llvm::DenseMap<lldb::user_id_t, lldb::VariableSP> m_global_vars;
227   llvm::DenseMap<lldb::user_id_t, lldb::FunctionSP> m_functions;
228   llvm::DenseMap<lldb::user_id_t, lldb::CompUnitSP> m_compilands;
229   llvm::DenseMap<lldb::user_id_t, lldb::TypeSP> m_types;
230 };
231 
232 } // namespace npdb
233 } // namespace lldb_private
234 
235 #endif // lldb_Plugins_SymbolFile_PDB_SymbolFilePDB_h_
236