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 
89   bool CompleteType(lldb_private::CompilerType &compiler_type) override;
90 
91   lldb_private::CompilerDecl GetDeclForUID(lldb::user_id_t uid) override;
92 
93   lldb_private::CompilerDeclContext
94   GetDeclContextForUID(lldb::user_id_t uid) override;
95 
96   lldb_private::CompilerDeclContext
97   GetDeclContextContainingUID(lldb::user_id_t uid) override;
98 
99   void
100   ParseDeclsForContext(lldb_private::CompilerDeclContext decl_ctx) override;
101 
102   uint32_t ResolveSymbolContext(const lldb_private::Address &so_addr,
103                                 lldb::SymbolContextItem resolve_scope,
104                                 lldb_private::SymbolContext &sc) override;
105 
106   uint32_t
107   ResolveSymbolContext(const lldb_private::FileSpec &file_spec, uint32_t line,
108                        bool check_inlines,
109                        lldb::SymbolContextItem resolve_scope,
110                        lldb_private::SymbolContextList &sc_list) override;
111 
112   uint32_t
113   FindGlobalVariables(const lldb_private::ConstString &name,
114                       const lldb_private::CompilerDeclContext *parent_decl_ctx,
115                       uint32_t max_matches,
116                       lldb_private::VariableList &variables) override;
117 
118   uint32_t FindGlobalVariables(const lldb_private::RegularExpression &regex,
119                                uint32_t max_matches,
120                                lldb_private::VariableList &variables) override;
121 
122   uint32_t
123   FindFunctions(const lldb_private::ConstString &name,
124                 const lldb_private::CompilerDeclContext *parent_decl_ctx,
125                 lldb::FunctionNameType name_type_mask, bool include_inlines,
126                 bool append, lldb_private::SymbolContextList &sc_list) override;
127 
128   uint32_t FindFunctions(const lldb_private::RegularExpression &regex,
129                          bool include_inlines, bool append,
130                          lldb_private::SymbolContextList &sc_list) override;
131 
132   void GetMangledNamesForFunction(
133       const std::string &scope_qualified_name,
134       std::vector<lldb_private::ConstString> &mangled_names) override;
135 
136   uint32_t
137   FindTypes(const lldb_private::SymbolContext &sc,
138             const lldb_private::ConstString &name,
139             const lldb_private::CompilerDeclContext *parent_decl_ctx,
140             bool append, uint32_t max_matches,
141             llvm::DenseSet<lldb_private::SymbolFile *> &searched_symbol_files,
142             lldb_private::TypeMap &types) override;
143 
144   size_t FindTypes(const std::vector<lldb_private::CompilerContext> &context,
145                    bool append, lldb_private::TypeMap &types) override;
146 
147   void FindTypesByRegex(const lldb_private::RegularExpression &regex,
148                         uint32_t max_matches, lldb_private::TypeMap &types);
149 
150   lldb_private::TypeList *GetTypeList() override;
151 
152   size_t GetTypes(lldb_private::SymbolContextScope *sc_scope,
153                   lldb::TypeClass type_mask,
154                   lldb_private::TypeList &type_list) override;
155 
156   lldb_private::TypeSystem *
157   GetTypeSystemForLanguage(lldb::LanguageType language) override;
158 
159   lldb_private::CompilerDeclContext FindNamespace(
160       const lldb_private::SymbolContext &sc,
161       const lldb_private::ConstString &name,
162       const lldb_private::CompilerDeclContext *parent_decl_ctx) override;
163 
164   lldb_private::ConstString GetPluginName() override;
165 
166   uint32_t GetPluginVersion() override;
167 
168   llvm::pdb::IPDBSession &GetPDBSession();
169 
170   const llvm::pdb::IPDBSession &GetPDBSession() const;
171 
172 private:
173   struct SecContribInfo {
174     uint32_t Offset;
175     uint32_t Size;
176     uint32_t CompilandId;
177   };
178   using SecContribsMap = std::map<uint32_t, std::vector<SecContribInfo>>;
179 
180   lldb::CompUnitSP ParseCompileUnitForUID(uint32_t id,
181                                           uint32_t index = UINT32_MAX);
182 
183   bool ParseCompileUnitLineTable(const lldb_private::SymbolContext &sc,
184                                  uint32_t match_line);
185 
186   void BuildSupportFileIdToSupportFileIndexMap(
187       const llvm::pdb::PDBSymbolCompiland &pdb_compiland,
188       llvm::DenseMap<uint32_t, uint32_t> &index_map) const;
189 
190   void FindTypesByName(const std::string &name,
191                        const lldb_private::CompilerDeclContext *parent_decl_ctx,
192                        uint32_t max_matches, lldb_private::TypeMap &types);
193 
194   std::string GetMangledForPDBData(const llvm::pdb::PDBSymbolData &pdb_data);
195 
196   lldb::VariableSP
197   ParseVariableForPDBData(const lldb_private::SymbolContext &sc,
198                           const llvm::pdb::PDBSymbolData &pdb_data);
199 
200   size_t ParseVariables(const lldb_private::SymbolContext &sc,
201                         const llvm::pdb::PDBSymbol &pdb_data,
202                         lldb_private::VariableList *variable_list = nullptr);
203 
204   lldb::CompUnitSP
205   GetCompileUnitContainsAddress(const lldb_private::Address &so_addr);
206 
207   typedef std::vector<lldb_private::Type *> TypeCollection;
208 
209   void GetTypesForPDBSymbol(const llvm::pdb::PDBSymbol &pdb_symbol,
210                             uint32_t type_mask,
211                             TypeCollection &type_collection);
212 
213   lldb_private::Function *
214   ParseCompileUnitFunctionForPDBFunc(const llvm::pdb::PDBSymbolFunc &pdb_func,
215                                      const lldb_private::SymbolContext &sc);
216 
217   void GetCompileUnitIndex(const llvm::pdb::PDBSymbolCompiland &pdb_compiland,
218                            uint32_t &index);
219 
220   std::unique_ptr<llvm::pdb::PDBSymbolCompiland>
221   GetPDBCompilandByUID(uint32_t uid);
222 
223   lldb_private::Mangled
224   GetMangledForPDBFunc(const llvm::pdb::PDBSymbolFunc &pdb_func);
225 
226   bool ResolveFunction(const llvm::pdb::PDBSymbolFunc &pdb_func,
227                        bool include_inlines,
228                        lldb_private::SymbolContextList &sc_list);
229 
230   bool ResolveFunction(uint32_t uid, bool include_inlines,
231                        lldb_private::SymbolContextList &sc_list);
232 
233   void CacheFunctionNames();
234 
235   bool DeclContextMatchesThisSymbolFile(
236       const lldb_private::CompilerDeclContext *decl_ctx);
237 
238   uint32_t GetCompilandId(const llvm::pdb::PDBSymbolData &data);
239 
240   llvm::DenseMap<uint32_t, lldb::CompUnitSP> m_comp_units;
241   llvm::DenseMap<uint32_t, lldb::TypeSP> m_types;
242   llvm::DenseMap<uint32_t, lldb::VariableSP> m_variables;
243   llvm::DenseMap<uint64_t, std::string> m_public_names;
244 
245   SecContribsMap m_sec_contribs;
246 
247   std::vector<lldb::TypeSP> m_builtin_types;
248   std::unique_ptr<llvm::pdb::IPDBSession> m_session_up;
249   std::unique_ptr<llvm::pdb::PDBSymbolExe> m_global_scope_up;
250   uint32_t m_cached_compile_unit_count;
251   std::unique_ptr<lldb_private::CompilerDeclContext> m_tu_decl_ctx_up;
252 
253   lldb_private::UniqueCStringMap<uint32_t> m_func_full_names;
254   lldb_private::UniqueCStringMap<uint32_t> m_func_base_names;
255   lldb_private::UniqueCStringMap<uint32_t> m_func_method_names;
256 };
257 
258 #endif // lldb_Plugins_SymbolFile_PDB_SymbolFilePDB_h_
259