1 //===-- SymbolFilePDB.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_PDB_SymbolFilePDB_h_
10 #define lldb_Plugins_SymbolFile_PDB_SymbolFilePDB_h_
11 
12 #include "lldb/Core/UniqueCStringMap.h"
13 #include "lldb/Symbol/SymbolFile.h"
14 #include "lldb/Symbol/VariableList.h"
15 #include "lldb/Utility/UserID.h"
16 
17 #include "llvm/ADT/DenseMap.h"
18 #include "llvm/DebugInfo/PDB/IPDBSession.h"
19 #include "llvm/DebugInfo/PDB/PDB.h"
20 #include "llvm/DebugInfo/PDB/PDBSymbolExe.h"
21 
22 class PDBASTParser;
23 
24 class SymbolFilePDB : public lldb_private::SymbolFile {
25 public:
26   //------------------------------------------------------------------
27   // Static Functions
28   //------------------------------------------------------------------
29   static void Initialize();
30 
31   static void Terminate();
32 
33   static void DebuggerInitialize(lldb_private::Debugger &debugger);
34 
35   static lldb_private::ConstString GetPluginNameStatic();
36 
37   static const char *GetPluginDescriptionStatic();
38 
39   static lldb_private::SymbolFile *
40   CreateInstance(lldb_private::ObjectFile *obj_file);
41 
42   //------------------------------------------------------------------
43   // Constructors and Destructors
44   //------------------------------------------------------------------
45   SymbolFilePDB(lldb_private::ObjectFile *ofile);
46 
47   ~SymbolFilePDB() override;
48 
49   uint32_t CalculateAbilities() override;
50 
51   void InitializeObject() override;
52 
53   //------------------------------------------------------------------
54   // Compile Unit function calls
55   //------------------------------------------------------------------
56 
57   uint32_t GetNumCompileUnits() override;
58 
59   lldb::CompUnitSP ParseCompileUnitAtIndex(uint32_t index) override;
60 
61   lldb::LanguageType
62   ParseLanguage(lldb_private::CompileUnit &comp_unit) override;
63 
64   size_t ParseFunctions(lldb_private::CompileUnit &comp_unit) override;
65 
66   bool ParseLineTable(lldb_private::CompileUnit &comp_unit) override;
67 
68   bool ParseDebugMacros(lldb_private::CompileUnit &comp_unit) override;
69 
70   bool ParseSupportFiles(lldb_private::CompileUnit &comp_unit,
71                          lldb_private::FileSpecList &support_files) override;
72 
73   size_t ParseTypes(lldb_private::CompileUnit &comp_unit) override;
74 
75   bool ParseImportedModules(
76       const lldb_private::SymbolContext &sc,
77       std::vector<lldb_private::SourceModule> &imported_modules) override;
78 
79   size_t ParseBlocksRecursive(lldb_private::Function &func) override;
80 
81   size_t
82   ParseVariablesForContext(const lldb_private::SymbolContext &sc) override;
83 
84   lldb_private::Type *ResolveTypeUID(lldb::user_id_t type_uid) override;
85   llvm::Optional<ArrayInfo> GetDynamicArrayInfoForUID(
86       lldb::user_id_t type_uid,
87       const lldb_private::ExecutionContext *exe_ctx) 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   void AddSymbols(lldb_private::Symtab &symtab) override;
137 
138   uint32_t
139   FindTypes(const lldb_private::ConstString &name,
140             const lldb_private::CompilerDeclContext *parent_decl_ctx,
141             bool append, uint32_t max_matches,
142             llvm::DenseSet<lldb_private::SymbolFile *> &searched_symbol_files,
143             lldb_private::TypeMap &types) override;
144 
145   size_t FindTypes(const std::vector<lldb_private::CompilerContext> &context,
146                    bool append, lldb_private::TypeMap &types) override;
147 
148   void FindTypesByRegex(const lldb_private::RegularExpression &regex,
149                         uint32_t max_matches, lldb_private::TypeMap &types);
150 
151   lldb_private::TypeList *GetTypeList() override;
152 
153   size_t GetTypes(lldb_private::SymbolContextScope *sc_scope,
154                   lldb::TypeClass type_mask,
155                   lldb_private::TypeList &type_list) override;
156 
157   lldb_private::TypeSystem *
158   GetTypeSystemForLanguage(lldb::LanguageType language) override;
159 
160   lldb_private::CompilerDeclContext FindNamespace(
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   void DumpClangAST(lldb_private::Stream &s) override;
173 
174 private:
175   struct SecContribInfo {
176     uint32_t Offset;
177     uint32_t Size;
178     uint32_t CompilandId;
179   };
180   using SecContribsMap = std::map<uint32_t, std::vector<SecContribInfo>>;
181 
182   lldb::CompUnitSP ParseCompileUnitForUID(uint32_t id,
183                                           uint32_t index = UINT32_MAX);
184 
185   bool ParseCompileUnitLineTable(lldb_private::CompileUnit &comp_unit,
186                                  uint32_t match_line);
187 
188   void BuildSupportFileIdToSupportFileIndexMap(
189       const llvm::pdb::PDBSymbolCompiland &pdb_compiland,
190       llvm::DenseMap<uint32_t, uint32_t> &index_map) const;
191 
192   void FindTypesByName(llvm::StringRef name,
193                        const lldb_private::CompilerDeclContext *parent_decl_ctx,
194                        uint32_t max_matches, lldb_private::TypeMap &types);
195 
196   std::string GetMangledForPDBData(const llvm::pdb::PDBSymbolData &pdb_data);
197 
198   lldb::VariableSP
199   ParseVariableForPDBData(const lldb_private::SymbolContext &sc,
200                           const llvm::pdb::PDBSymbolData &pdb_data);
201 
202   size_t ParseVariables(const lldb_private::SymbolContext &sc,
203                         const llvm::pdb::PDBSymbol &pdb_data,
204                         lldb_private::VariableList *variable_list = nullptr);
205 
206   lldb::CompUnitSP
207   GetCompileUnitContainsAddress(const lldb_private::Address &so_addr);
208 
209   typedef std::vector<lldb_private::Type *> TypeCollection;
210 
211   void GetTypesForPDBSymbol(const llvm::pdb::PDBSymbol &pdb_symbol,
212                             uint32_t type_mask,
213                             TypeCollection &type_collection);
214 
215   lldb_private::Function *
216   ParseCompileUnitFunctionForPDBFunc(const llvm::pdb::PDBSymbolFunc &pdb_func,
217                                      lldb_private::CompileUnit &comp_unit);
218 
219   void GetCompileUnitIndex(const llvm::pdb::PDBSymbolCompiland &pdb_compiland,
220                            uint32_t &index);
221 
222   PDBASTParser *GetPDBAstParser();
223 
224   std::unique_ptr<llvm::pdb::PDBSymbolCompiland>
225   GetPDBCompilandByUID(uint32_t uid);
226 
227   lldb_private::Mangled
228   GetMangledForPDBFunc(const llvm::pdb::PDBSymbolFunc &pdb_func);
229 
230   bool ResolveFunction(const llvm::pdb::PDBSymbolFunc &pdb_func,
231                        bool include_inlines,
232                        lldb_private::SymbolContextList &sc_list);
233 
234   bool ResolveFunction(uint32_t uid, bool include_inlines,
235                        lldb_private::SymbolContextList &sc_list);
236 
237   void CacheFunctionNames();
238 
239   bool DeclContextMatchesThisSymbolFile(
240       const lldb_private::CompilerDeclContext *decl_ctx);
241 
242   uint32_t GetCompilandId(const llvm::pdb::PDBSymbolData &data);
243 
244   llvm::DenseMap<uint32_t, lldb::CompUnitSP> m_comp_units;
245   llvm::DenseMap<uint32_t, lldb::TypeSP> m_types;
246   llvm::DenseMap<uint32_t, lldb::VariableSP> m_variables;
247   llvm::DenseMap<uint64_t, std::string> m_public_names;
248 
249   SecContribsMap m_sec_contribs;
250 
251   std::vector<lldb::TypeSP> m_builtin_types;
252   std::unique_ptr<llvm::pdb::IPDBSession> m_session_up;
253   std::unique_ptr<llvm::pdb::PDBSymbolExe> m_global_scope_up;
254   uint32_t m_cached_compile_unit_count;
255   std::unique_ptr<lldb_private::CompilerDeclContext> m_tu_decl_ctx_up;
256 
257   lldb_private::UniqueCStringMap<uint32_t> m_func_full_names;
258   lldb_private::UniqueCStringMap<uint32_t> m_func_base_names;
259   lldb_private::UniqueCStringMap<uint32_t> m_func_method_names;
260 };
261 
262 #endif // lldb_Plugins_SymbolFile_PDB_SymbolFilePDB_h_
263