1 //===-- SymbolFilePDB.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_PDB_SymbolFilePDB_h_
11 #define lldb_Plugins_SymbolFile_PDB_SymbolFilePDB_h_
12 
13 #include "lldb/Core/UniqueCStringMap.h"
14 #include "lldb/Symbol/SymbolFile.h"
15 #include "lldb/Symbol/VariableList.h"
16 #include "lldb/Utility/UserID.h"
17 
18 #include "llvm/ADT/DenseMap.h"
19 #include "llvm/DebugInfo/PDB/IPDBSession.h"
20 #include "llvm/DebugInfo/PDB/PDB.h"
21 #include "llvm/DebugInfo/PDB/PDBSymbolExe.h"
22 
23 class SymbolFilePDB : public lldb_private::SymbolFile {
24 public:
25   //------------------------------------------------------------------
26   // Static Functions
27   //------------------------------------------------------------------
28   static void Initialize();
29 
30   static void Terminate();
31 
32   static void DebuggerInitialize(lldb_private::Debugger &debugger);
33 
34   static lldb_private::ConstString GetPluginNameStatic();
35 
36   static const char *GetPluginDescriptionStatic();
37 
38   static lldb_private::SymbolFile *
39   CreateInstance(lldb_private::ObjectFile *obj_file);
40 
41   //------------------------------------------------------------------
42   // Constructors and Destructors
43   //------------------------------------------------------------------
44   SymbolFilePDB(lldb_private::ObjectFile *ofile);
45 
46   ~SymbolFilePDB() override;
47 
48   uint32_t CalculateAbilities() override;
49 
50   void InitializeObject() override;
51 
52   //------------------------------------------------------------------
53   // Compile Unit function calls
54   //------------------------------------------------------------------
55 
56   uint32_t GetNumCompileUnits() override;
57 
58   lldb::CompUnitSP ParseCompileUnitAtIndex(uint32_t index) override;
59 
60   lldb::LanguageType
61   ParseCompileUnitLanguage(const lldb_private::SymbolContext &sc) override;
62 
63   size_t
64   ParseCompileUnitFunctions(const lldb_private::SymbolContext &sc) override;
65 
66   bool
67   ParseCompileUnitLineTable(const lldb_private::SymbolContext &sc) override;
68 
69   bool
70   ParseCompileUnitDebugMacros(const lldb_private::SymbolContext &sc) override;
71 
72   bool ParseCompileUnitSupportFiles(
73       const lldb_private::SymbolContext &sc,
74       lldb_private::FileSpecList &support_files) override;
75 
76   bool ParseImportedModules(
77       const lldb_private::SymbolContext &sc,
78       std::vector<lldb_private::ConstString> &imported_modules) override;
79 
80   size_t ParseFunctionBlocks(const lldb_private::SymbolContext &sc) override;
81 
82   size_t ParseTypes(const lldb_private::SymbolContext &sc) override;
83 
84   size_t
85   ParseVariablesForContext(const lldb_private::SymbolContext &sc) override;
86 
87   lldb_private::Type *ResolveTypeUID(lldb::user_id_t type_uid) override;
88   llvm::Optional<ArrayInfo> GetDynamicArrayInfoForUID(
89       lldb::user_id_t type_uid,
90       const lldb_private::ExecutionContext *exe_ctx) override;
91 
92   bool CompleteType(lldb_private::CompilerType &compiler_type) override;
93 
94   lldb_private::CompilerDecl GetDeclForUID(lldb::user_id_t uid) override;
95 
96   lldb_private::CompilerDeclContext
97   GetDeclContextForUID(lldb::user_id_t uid) override;
98 
99   lldb_private::CompilerDeclContext
100   GetDeclContextContainingUID(lldb::user_id_t uid) override;
101 
102   void
103   ParseDeclsForContext(lldb_private::CompilerDeclContext decl_ctx) override;
104 
105   uint32_t ResolveSymbolContext(const lldb_private::Address &so_addr,
106                                 lldb::SymbolContextItem resolve_scope,
107                                 lldb_private::SymbolContext &sc) override;
108 
109   uint32_t
110   ResolveSymbolContext(const lldb_private::FileSpec &file_spec, uint32_t line,
111                        bool check_inlines,
112                        lldb::SymbolContextItem resolve_scope,
113                        lldb_private::SymbolContextList &sc_list) override;
114 
115   uint32_t
116   FindGlobalVariables(const lldb_private::ConstString &name,
117                       const lldb_private::CompilerDeclContext *parent_decl_ctx,
118                       uint32_t max_matches,
119                       lldb_private::VariableList &variables) override;
120 
121   uint32_t FindGlobalVariables(const lldb_private::RegularExpression &regex,
122                                uint32_t max_matches,
123                                lldb_private::VariableList &variables) override;
124 
125   uint32_t
126   FindFunctions(const lldb_private::ConstString &name,
127                 const lldb_private::CompilerDeclContext *parent_decl_ctx,
128                 lldb::FunctionNameType name_type_mask, bool include_inlines,
129                 bool append, lldb_private::SymbolContextList &sc_list) override;
130 
131   uint32_t FindFunctions(const lldb_private::RegularExpression &regex,
132                          bool include_inlines, bool append,
133                          lldb_private::SymbolContextList &sc_list) override;
134 
135   void GetMangledNamesForFunction(
136       const std::string &scope_qualified_name,
137       std::vector<lldb_private::ConstString> &mangled_names) override;
138 
139   void AddSymbols(lldb_private::Symtab &symtab) override;
140 
141   uint32_t
142   FindTypes(const lldb_private::SymbolContext &sc,
143             const lldb_private::ConstString &name,
144             const lldb_private::CompilerDeclContext *parent_decl_ctx,
145             bool append, uint32_t max_matches,
146             llvm::DenseSet<lldb_private::SymbolFile *> &searched_symbol_files,
147             lldb_private::TypeMap &types) override;
148 
149   size_t FindTypes(const std::vector<lldb_private::CompilerContext> &context,
150                    bool append, lldb_private::TypeMap &types) override;
151 
152   void FindTypesByRegex(const lldb_private::RegularExpression &regex,
153                         uint32_t max_matches, lldb_private::TypeMap &types);
154 
155   lldb_private::TypeList *GetTypeList() override;
156 
157   size_t GetTypes(lldb_private::SymbolContextScope *sc_scope,
158                   lldb::TypeClass type_mask,
159                   lldb_private::TypeList &type_list) override;
160 
161   lldb_private::TypeSystem *
162   GetTypeSystemForLanguage(lldb::LanguageType language) override;
163 
164   lldb_private::CompilerDeclContext FindNamespace(
165       const lldb_private::SymbolContext &sc,
166       const lldb_private::ConstString &name,
167       const lldb_private::CompilerDeclContext *parent_decl_ctx) override;
168 
169   lldb_private::ConstString GetPluginName() override;
170 
171   uint32_t GetPluginVersion() override;
172 
173   llvm::pdb::IPDBSession &GetPDBSession();
174 
175   const llvm::pdb::IPDBSession &GetPDBSession() const;
176 
177   void DumpClangAST(lldb_private::Stream &s) override;
178 
179 private:
180   struct SecContribInfo {
181     uint32_t Offset;
182     uint32_t Size;
183     uint32_t CompilandId;
184   };
185   using SecContribsMap = std::map<uint32_t, std::vector<SecContribInfo>>;
186 
187   lldb::CompUnitSP ParseCompileUnitForUID(uint32_t id,
188                                           uint32_t index = UINT32_MAX);
189 
190   bool ParseCompileUnitLineTable(const lldb_private::SymbolContext &sc,
191                                  uint32_t match_line);
192 
193   void BuildSupportFileIdToSupportFileIndexMap(
194       const llvm::pdb::PDBSymbolCompiland &pdb_compiland,
195       llvm::DenseMap<uint32_t, uint32_t> &index_map) const;
196 
197   void FindTypesByName(llvm::StringRef name,
198                        const lldb_private::CompilerDeclContext *parent_decl_ctx,
199                        uint32_t max_matches, lldb_private::TypeMap &types);
200 
201   std::string GetMangledForPDBData(const llvm::pdb::PDBSymbolData &pdb_data);
202 
203   lldb::VariableSP
204   ParseVariableForPDBData(const lldb_private::SymbolContext &sc,
205                           const llvm::pdb::PDBSymbolData &pdb_data);
206 
207   size_t ParseVariables(const lldb_private::SymbolContext &sc,
208                         const llvm::pdb::PDBSymbol &pdb_data,
209                         lldb_private::VariableList *variable_list = nullptr);
210 
211   lldb::CompUnitSP
212   GetCompileUnitContainsAddress(const lldb_private::Address &so_addr);
213 
214   typedef std::vector<lldb_private::Type *> TypeCollection;
215 
216   void GetTypesForPDBSymbol(const llvm::pdb::PDBSymbol &pdb_symbol,
217                             uint32_t type_mask,
218                             TypeCollection &type_collection);
219 
220   lldb_private::Function *
221   ParseCompileUnitFunctionForPDBFunc(const llvm::pdb::PDBSymbolFunc &pdb_func,
222                                      const lldb_private::SymbolContext &sc);
223 
224   void GetCompileUnitIndex(const llvm::pdb::PDBSymbolCompiland &pdb_compiland,
225                            uint32_t &index);
226 
227   std::unique_ptr<llvm::pdb::PDBSymbolCompiland>
228   GetPDBCompilandByUID(uint32_t uid);
229 
230   lldb_private::Mangled
231   GetMangledForPDBFunc(const llvm::pdb::PDBSymbolFunc &pdb_func);
232 
233   bool ResolveFunction(const llvm::pdb::PDBSymbolFunc &pdb_func,
234                        bool include_inlines,
235                        lldb_private::SymbolContextList &sc_list);
236 
237   bool ResolveFunction(uint32_t uid, bool include_inlines,
238                        lldb_private::SymbolContextList &sc_list);
239 
240   void CacheFunctionNames();
241 
242   bool DeclContextMatchesThisSymbolFile(
243       const lldb_private::CompilerDeclContext *decl_ctx);
244 
245   uint32_t GetCompilandId(const llvm::pdb::PDBSymbolData &data);
246 
247   llvm::DenseMap<uint32_t, lldb::CompUnitSP> m_comp_units;
248   llvm::DenseMap<uint32_t, lldb::TypeSP> m_types;
249   llvm::DenseMap<uint32_t, lldb::VariableSP> m_variables;
250   llvm::DenseMap<uint64_t, std::string> m_public_names;
251 
252   SecContribsMap m_sec_contribs;
253 
254   std::vector<lldb::TypeSP> m_builtin_types;
255   std::unique_ptr<llvm::pdb::IPDBSession> m_session_up;
256   std::unique_ptr<llvm::pdb::PDBSymbolExe> m_global_scope_up;
257   uint32_t m_cached_compile_unit_count;
258   std::unique_ptr<lldb_private::CompilerDeclContext> m_tu_decl_ctx_up;
259 
260   lldb_private::UniqueCStringMap<uint32_t> m_func_full_names;
261   lldb_private::UniqueCStringMap<uint32_t> m_func_base_names;
262   lldb_private::UniqueCStringMap<uint32_t> m_func_method_names;
263 };
264 
265 #endif // lldb_Plugins_SymbolFile_PDB_SymbolFilePDB_h_
266