1 //===-- SymbolFileDWARF.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_DWARF_SYMBOLFILEDWARF_H
10 #define LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_SYMBOLFILEDWARF_H
11 
12 #include <list>
13 #include <map>
14 #include <mutex>
15 #include <unordered_map>
16 #include <vector>
17 
18 #include "llvm/ADT/DenseMap.h"
19 #include "llvm/ADT/SetVector.h"
20 #include "llvm/Support/Threading.h"
21 
22 #include "lldb/Core/UniqueCStringMap.h"
23 #include "lldb/Core/dwarf.h"
24 #include "lldb/Symbol/DebugMacros.h"
25 #include "lldb/Symbol/SymbolContext.h"
26 #include "lldb/Symbol/SymbolFile.h"
27 #include "lldb/Utility/ConstString.h"
28 #include "lldb/Utility/Flags.h"
29 #include "lldb/Utility/RangeMap.h"
30 #include "lldb/lldb-private.h"
31 
32 #include "DWARFContext.h"
33 #include "DWARFDataExtractor.h"
34 #include "DWARFDefines.h"
35 #include "DWARFIndex.h"
36 #include "UniqueDWARFASTType.h"
37 
38 // Forward Declarations for this DWARF plugin
39 class DebugMapModule;
40 class DWARFAbbreviationDeclaration;
41 class DWARFAbbreviationDeclarationSet;
42 class DWARFCompileUnit;
43 class DWARFDebugAbbrev;
44 class DWARFDebugAranges;
45 class DWARFDebugInfo;
46 class DWARFDebugInfoEntry;
47 class DWARFDebugLine;
48 class DWARFDebugRanges;
49 class DWARFDeclContext;
50 class DWARFFormValue;
51 class DWARFTypeUnit;
52 class SymbolFileDWARFDebugMap;
53 class SymbolFileDWARFDwo;
54 class SymbolFileDWARFDwp;
55 
56 #define DIE_IS_BEING_PARSED ((lldb_private::Type *)1)
57 
58 class SymbolFileDWARF : public lldb_private::SymbolFile,
59                         public lldb_private::UserID {
60   /// LLVM RTTI support.
61   static char ID;
62 
63 public:
64   /// LLVM RTTI support.
65   /// \{
66   bool isA(const void *ClassID) const override {
67     return ClassID == &ID || SymbolFile::isA(ClassID);
68   }
69   static bool classof(const SymbolFile *obj) { return obj->isA(&ID); }
70   /// \}
71 
72   friend class SymbolFileDWARFDebugMap;
73   friend class SymbolFileDWARFDwo;
74   friend class DebugMapModule;
75   friend class DWARFCompileUnit;
76   friend class DWARFDIE;
77   friend class DWARFASTParserClang;
78 
79   // Static Functions
80   static void Initialize();
81 
82   static void Terminate();
83 
84   static void DebuggerInitialize(lldb_private::Debugger &debugger);
85 
86   static lldb_private::ConstString GetPluginNameStatic();
87 
88   static const char *GetPluginDescriptionStatic();
89 
90   static lldb_private::SymbolFile *
91   CreateInstance(lldb::ObjectFileSP objfile_sp);
92 
93   // Constructors and Destructors
94 
95   SymbolFileDWARF(lldb::ObjectFileSP objfile_sp,
96                   lldb_private::SectionList *dwo_section_list);
97 
98   ~SymbolFileDWARF() override;
99 
100   uint32_t CalculateAbilities() override;
101 
102   void InitializeObject() override;
103 
104   // Compile Unit function calls
105 
106   lldb::LanguageType
107   ParseLanguage(lldb_private::CompileUnit &comp_unit) override;
108 
109   size_t ParseFunctions(lldb_private::CompileUnit &comp_unit) override;
110 
111   bool ParseLineTable(lldb_private::CompileUnit &comp_unit) override;
112 
113   bool ParseDebugMacros(lldb_private::CompileUnit &comp_unit) override;
114 
115   bool ForEachExternalModule(
116       lldb_private::CompileUnit &, llvm::DenseSet<lldb_private::SymbolFile *> &,
117       llvm::function_ref<bool(lldb_private::Module &)>) override;
118 
119   bool ParseSupportFiles(lldb_private::CompileUnit &comp_unit,
120                          lldb_private::FileSpecList &support_files) override;
121 
122   bool ParseIsOptimized(lldb_private::CompileUnit &comp_unit) override;
123 
124   size_t ParseTypes(lldb_private::CompileUnit &comp_unit) override;
125 
126   bool ParseImportedModules(
127       const lldb_private::SymbolContext &sc,
128       std::vector<lldb_private::SourceModule> &imported_modules) override;
129 
130   size_t ParseBlocksRecursive(lldb_private::Function &func) override;
131 
132   size_t
133   ParseVariablesForContext(const lldb_private::SymbolContext &sc) override;
134 
135   lldb_private::Type *ResolveTypeUID(lldb::user_id_t type_uid) override;
136   llvm::Optional<ArrayInfo> GetDynamicArrayInfoForUID(
137       lldb::user_id_t type_uid,
138       const lldb_private::ExecutionContext *exe_ctx) override;
139 
140   bool CompleteType(lldb_private::CompilerType &compiler_type) override;
141 
142   lldb_private::Type *ResolveType(const DWARFDIE &die,
143                                   bool assert_not_being_parsed = true,
144                                   bool resolve_function_context = false);
145 
146   lldb_private::CompilerDecl GetDeclForUID(lldb::user_id_t uid) override;
147 
148   lldb_private::CompilerDeclContext
149   GetDeclContextForUID(lldb::user_id_t uid) override;
150 
151   lldb_private::CompilerDeclContext
152   GetDeclContextContainingUID(lldb::user_id_t uid) override;
153 
154   void
155   ParseDeclsForContext(lldb_private::CompilerDeclContext decl_ctx) override;
156 
157   uint32_t ResolveSymbolContext(const lldb_private::Address &so_addr,
158                                 lldb::SymbolContextItem resolve_scope,
159                                 lldb_private::SymbolContext &sc) override;
160 
161   uint32_t
162   ResolveSymbolContext(const lldb_private::FileSpec &file_spec, uint32_t line,
163                        bool check_inlines,
164                        lldb::SymbolContextItem resolve_scope,
165                        lldb_private::SymbolContextList &sc_list) override;
166 
167   void
168   FindGlobalVariables(lldb_private::ConstString name,
169                       const lldb_private::CompilerDeclContext &parent_decl_ctx,
170                       uint32_t max_matches,
171                       lldb_private::VariableList &variables) override;
172 
173   void FindGlobalVariables(const lldb_private::RegularExpression &regex,
174                            uint32_t max_matches,
175                            lldb_private::VariableList &variables) override;
176 
177   void FindFunctions(lldb_private::ConstString name,
178                      const lldb_private::CompilerDeclContext &parent_decl_ctx,
179                      lldb::FunctionNameType name_type_mask,
180                      bool include_inlines,
181                      lldb_private::SymbolContextList &sc_list) override;
182 
183   void FindFunctions(const lldb_private::RegularExpression &regex,
184                      bool include_inlines,
185                      lldb_private::SymbolContextList &sc_list) override;
186 
187   void GetMangledNamesForFunction(
188       const std::string &scope_qualified_name,
189       std::vector<lldb_private::ConstString> &mangled_names) override;
190 
191   void
192   FindTypes(lldb_private::ConstString name,
193             const lldb_private::CompilerDeclContext &parent_decl_ctx,
194             uint32_t max_matches,
195             llvm::DenseSet<lldb_private::SymbolFile *> &searched_symbol_files,
196             lldb_private::TypeMap &types) override;
197 
198   void FindTypes(llvm::ArrayRef<lldb_private::CompilerContext> pattern,
199                  lldb_private::LanguageSet languages,
200                  llvm::DenseSet<SymbolFile *> &searched_symbol_files,
201                  lldb_private::TypeMap &types) override;
202 
203   void GetTypes(lldb_private::SymbolContextScope *sc_scope,
204                 lldb::TypeClass type_mask,
205                 lldb_private::TypeList &type_list) override;
206 
207   llvm::Expected<lldb_private::TypeSystem &>
208   GetTypeSystemForLanguage(lldb::LanguageType language) override;
209 
210   lldb_private::CompilerDeclContext FindNamespace(
211       lldb_private::ConstString name,
212       const lldb_private::CompilerDeclContext &parent_decl_ctx) override;
213 
214   void PreloadSymbols() override;
215 
216   std::recursive_mutex &GetModuleMutex() const override;
217 
218   // PluginInterface protocol
219   lldb_private::ConstString GetPluginName() override;
220 
221   uint32_t GetPluginVersion() override;
222 
223   DWARFDebugAbbrev *DebugAbbrev();
224 
225   DWARFDebugInfo &DebugInfo();
226 
227   DWARFDebugRanges *GetDebugRanges();
228 
229   static bool SupportedVersion(uint16_t version);
230 
231   DWARFDIE
232   GetDeclContextDIEContainingDIE(const DWARFDIE &die);
233 
234   bool
235   HasForwardDeclForClangType(const lldb_private::CompilerType &compiler_type);
236 
237   lldb_private::CompileUnit *
238   GetCompUnitForDWARFCompUnit(DWARFCompileUnit &dwarf_cu);
239 
240   virtual size_t GetObjCMethodDIEOffsets(lldb_private::ConstString class_name,
241                                          DIEArray &method_die_offsets);
242 
243   bool Supports_DW_AT_APPLE_objc_complete_type(DWARFUnit *cu);
244 
245   lldb_private::DebugMacrosSP ParseDebugMacros(lldb::offset_t *offset);
246 
247   static DWARFDIE GetParentSymbolContextDIE(const DWARFDIE &die);
248 
249   lldb::ModuleSP GetExternalModule(lldb_private::ConstString name);
250 
251   typedef std::map<lldb_private::ConstString, lldb::ModuleSP>
252       ExternalTypeModuleMap;
253 
254   /// Return the list of Clang modules imported by this SymbolFile.
255   const ExternalTypeModuleMap& getExternalTypeModules() const {
256       return m_external_type_modules;
257   }
258 
259   virtual DWARFDIE GetDIE(const DIERef &die_ref);
260 
261   DWARFDIE GetDIE(lldb::user_id_t uid);
262 
263   lldb::user_id_t GetUID(const DWARFBaseDIE &die) {
264     return GetUID(die.GetDIERef());
265   }
266 
267   lldb::user_id_t GetUID(const llvm::Optional<DIERef> &ref) {
268     return ref ? GetUID(*ref) : LLDB_INVALID_UID;
269   }
270 
271   lldb::user_id_t GetUID(DIERef ref);
272 
273   std::shared_ptr<SymbolFileDWARFDwo>
274   GetDwoSymbolFileForCompileUnit(DWARFUnit &dwarf_cu,
275                                  const DWARFDebugInfoEntry &cu_die);
276 
277   virtual llvm::Optional<uint32_t> GetDwoNum() { return llvm::None; }
278 
279   /// If this is a DWARF object with a single CU, return its DW_AT_dwo_id.
280   llvm::Optional<uint64_t> GetDWOId();
281 
282   static bool
283   DIEInDeclContext(const lldb_private::CompilerDeclContext &parent_decl_ctx,
284                    const DWARFDIE &die);
285 
286   std::vector<std::unique_ptr<lldb_private::CallEdge>>
287   ParseCallEdgesInFunction(UserID func_id) override;
288 
289   void Dump(lldb_private::Stream &s) override;
290 
291   void DumpClangAST(lldb_private::Stream &s) override;
292 
293   lldb_private::DWARFContext &GetDWARFContext() { return m_context; }
294 
295   const std::shared_ptr<SymbolFileDWARFDwo> &GetDwpSymbolFile();
296 
297   lldb_private::FileSpec GetFile(DWARFUnit &unit, size_t file_idx);
298 
299   static llvm::Expected<lldb_private::TypeSystem &>
300   GetTypeSystem(DWARFUnit &unit);
301 
302   static DWARFASTParser *GetDWARFParser(DWARFUnit &unit);
303 
304   // CompilerDecl related functions
305 
306   static lldb_private::CompilerDecl GetDecl(const DWARFDIE &die);
307 
308   static lldb_private::CompilerDeclContext GetDeclContext(const DWARFDIE &die);
309 
310   static lldb_private::CompilerDeclContext
311   GetContainingDeclContext(const DWARFDIE &die);
312 
313   static DWARFDeclContext GetDWARFDeclContext(const DWARFDIE &die);
314 
315   static lldb::LanguageType LanguageTypeFromDWARF(uint64_t val);
316 
317   static lldb::LanguageType GetLanguage(DWARFUnit &unit);
318 
319 protected:
320   typedef llvm::DenseMap<const DWARFDebugInfoEntry *, lldb_private::Type *>
321       DIEToTypePtr;
322   typedef llvm::DenseMap<const DWARFDebugInfoEntry *, lldb::VariableSP>
323       DIEToVariableSP;
324   typedef llvm::DenseMap<const DWARFDebugInfoEntry *,
325                          lldb::opaque_compiler_type_t>
326       DIEToClangType;
327   typedef llvm::DenseMap<lldb::opaque_compiler_type_t, DIERef> ClangTypeToDIE;
328 
329   DISALLOW_COPY_AND_ASSIGN(SymbolFileDWARF);
330 
331   virtual void LoadSectionData(lldb::SectionType sect_type,
332                                lldb_private::DWARFDataExtractor &data);
333 
334   bool DeclContextMatchesThisSymbolFile(
335       const lldb_private::CompilerDeclContext &decl_ctx);
336 
337   uint32_t CalculateNumCompileUnits() override;
338 
339   lldb::CompUnitSP ParseCompileUnitAtIndex(uint32_t index) override;
340 
341   lldb_private::TypeList &GetTypeList() override;
342 
343   lldb::CompUnitSP ParseCompileUnit(DWARFCompileUnit &dwarf_cu);
344 
345   virtual DWARFUnit *
346   GetDWARFCompileUnit(lldb_private::CompileUnit *comp_unit);
347 
348   DWARFUnit *GetNextUnparsedDWARFCompileUnit(DWARFUnit *prev_cu);
349 
350   bool GetFunction(const DWARFDIE &die, lldb_private::SymbolContext &sc);
351 
352   lldb_private::Function *ParseFunction(lldb_private::CompileUnit &comp_unit,
353                                         const DWARFDIE &die);
354 
355   size_t ParseBlocksRecursive(lldb_private::CompileUnit &comp_unit,
356                               lldb_private::Block *parent_block,
357                               const DWARFDIE &die,
358                               lldb::addr_t subprogram_low_pc, uint32_t depth);
359 
360   size_t ParseTypes(const lldb_private::SymbolContext &sc, const DWARFDIE &die,
361                     bool parse_siblings, bool parse_children);
362 
363   lldb::TypeSP ParseType(const lldb_private::SymbolContext &sc,
364                          const DWARFDIE &die, bool *type_is_new);
365 
366   lldb_private::Type *ResolveTypeUID(const DWARFDIE &die,
367                                      bool assert_not_being_parsed);
368 
369   lldb_private::Type *ResolveTypeUID(const DIERef &die_ref);
370 
371   lldb::VariableSP ParseVariableDIE(const lldb_private::SymbolContext &sc,
372                                     const DWARFDIE &die,
373                                     const lldb::addr_t func_low_pc);
374 
375   size_t ParseVariables(const lldb_private::SymbolContext &sc,
376                         const DWARFDIE &orig_die,
377                         const lldb::addr_t func_low_pc, bool parse_siblings,
378                         bool parse_children,
379                         lldb_private::VariableList *cc_variable_list = nullptr);
380 
381   bool ClassOrStructIsVirtual(const DWARFDIE &die);
382 
383   // Given a die_offset, figure out the symbol context representing that die.
384   bool ResolveFunction(const DWARFDIE &die, bool include_inlines,
385                        lldb_private::SymbolContextList &sc_list);
386 
387   /// Resolve functions and (possibly) blocks for the given file address and a
388   /// compile unit. The compile unit comes from the sc argument and it must be
389   /// set. The results of the lookup (if any) are written back to the symbol
390   /// context.
391   void ResolveFunctionAndBlock(lldb::addr_t file_vm_addr, bool lookup_block,
392                                lldb_private::SymbolContext &sc);
393 
394   virtual lldb::TypeSP
395   FindDefinitionTypeForDWARFDeclContext(const DWARFDeclContext &die_decl_ctx);
396 
397   virtual lldb::TypeSP FindCompleteObjCDefinitionTypeForDIE(
398       const DWARFDIE &die, lldb_private::ConstString type_name,
399       bool must_be_implementation);
400 
401   lldb_private::Symbol *
402   GetObjCClassSymbol(lldb_private::ConstString objc_class_name);
403 
404   lldb::TypeSP GetTypeForDIE(const DWARFDIE &die,
405                              bool resolve_function_context = false);
406 
407   void SetDebugMapModule(const lldb::ModuleSP &module_sp) {
408     m_debug_map_module_wp = module_sp;
409   }
410 
411   SymbolFileDWARFDebugMap *GetDebugMapSymfile();
412 
413   DWARFDIE
414   FindBlockContainingSpecification(const DIERef &func_die_ref,
415                                    dw_offset_t spec_block_die_offset);
416 
417   DWARFDIE
418   FindBlockContainingSpecification(const DWARFDIE &die,
419                                    dw_offset_t spec_block_die_offset);
420 
421   virtual UniqueDWARFASTTypeMap &GetUniqueDWARFASTTypeMap();
422 
423   bool DIEDeclContextsMatch(const DWARFDIE &die1, const DWARFDIE &die2);
424 
425   bool ClassContainsSelector(const DWARFDIE &class_die,
426                              lldb_private::ConstString selector);
427 
428   /// Parse call site entries (DW_TAG_call_site), including any nested call site
429   /// parameters (DW_TAG_call_site_parameter).
430   std::vector<std::unique_ptr<lldb_private::CallEdge>>
431   CollectCallEdges(lldb::ModuleSP module, DWARFDIE function_die);
432 
433   /// If this symbol file is linked to by a debug map (see
434   /// SymbolFileDWARFDebugMap), and \p file_addr is a file address relative to
435   /// an object file, adjust \p file_addr so that it is relative to the main
436   /// binary. Returns the adjusted address, or \p file_addr if no adjustment is
437   /// needed, on success and LLDB_INVALID_ADDRESS otherwise.
438   lldb::addr_t FixupAddress(lldb::addr_t file_addr);
439 
440   bool FixupAddress(lldb_private::Address &addr);
441 
442   typedef llvm::SetVector<lldb_private::Type *> TypeSet;
443 
444   void GetTypes(const DWARFDIE &die, dw_offset_t min_die_offset,
445                 dw_offset_t max_die_offset, uint32_t type_mask,
446                 TypeSet &type_set);
447 
448   typedef lldb_private::RangeDataVector<lldb::addr_t, lldb::addr_t,
449                                         lldb_private::Variable *>
450       GlobalVariableMap;
451 
452   GlobalVariableMap &GetGlobalAranges();
453 
454   void UpdateExternalModuleListIfNeeded();
455 
456   virtual DIEToTypePtr &GetDIEToType() { return m_die_to_type; }
457 
458   virtual DIEToVariableSP &GetDIEToVariable() { return m_die_to_variable_sp; }
459 
460   virtual DIEToClangType &GetForwardDeclDieToClangType() {
461     return m_forward_decl_die_to_clang_type;
462   }
463 
464   virtual ClangTypeToDIE &GetForwardDeclClangTypeToDie() {
465     return m_forward_decl_clang_type_to_die;
466   }
467 
468   void BuildCuTranslationTable();
469   llvm::Optional<uint32_t> GetDWARFUnitIndex(uint32_t cu_idx);
470 
471   struct DecodedUID {
472     SymbolFileDWARF &dwarf;
473     DIERef ref;
474   };
475   llvm::Optional<DecodedUID> DecodeUID(lldb::user_id_t uid);
476 
477   void FindDwpSymbolFile();
478 
479   const lldb_private::FileSpecList &GetTypeUnitSupportFiles(DWARFTypeUnit &tu);
480 
481   lldb::ModuleWP m_debug_map_module_wp;
482   SymbolFileDWARFDebugMap *m_debug_map_symfile;
483 
484   llvm::once_flag m_dwp_symfile_once_flag;
485   std::shared_ptr<SymbolFileDWARFDwo> m_dwp_symfile;
486 
487   lldb_private::DWARFContext m_context;
488 
489   llvm::once_flag m_info_once_flag;
490   std::unique_ptr<DWARFDebugInfo> m_info;
491 
492   std::unique_ptr<DWARFDebugAbbrev> m_abbr;
493   std::unique_ptr<GlobalVariableMap> m_global_aranges_up;
494 
495   typedef std::unordered_map<lldb::offset_t, lldb_private::DebugMacrosSP>
496       DebugMacrosMap;
497   DebugMacrosMap m_debug_macros_map;
498 
499   ExternalTypeModuleMap m_external_type_modules;
500   std::unique_ptr<lldb_private::DWARFIndex> m_index;
501   bool m_fetched_external_modules : 1;
502   lldb_private::LazyBool m_supports_DW_AT_APPLE_objc_complete_type;
503 
504   typedef std::set<DIERef> DIERefSet;
505   typedef llvm::StringMap<DIERefSet> NameToOffsetMap;
506   NameToOffsetMap m_function_scope_qualified_name_map;
507   std::unique_ptr<DWARFDebugRanges> m_ranges;
508   UniqueDWARFASTTypeMap m_unique_ast_type_map;
509   DIEToTypePtr m_die_to_type;
510   DIEToVariableSP m_die_to_variable_sp;
511   DIEToClangType m_forward_decl_die_to_clang_type;
512   ClangTypeToDIE m_forward_decl_clang_type_to_die;
513   llvm::DenseMap<dw_offset_t, lldb_private::FileSpecList>
514       m_type_unit_support_files;
515   std::vector<uint32_t> m_lldb_cu_to_dwarf_unit;
516 };
517 
518 #endif // LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_SYMBOLFILEDWARF_H
519