1 //===-- DWARFASTParserClang.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_DWARFASTPARSERCLANG_H
10 #define LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_DWARFASTPARSERCLANG_H
11 
12 #include "clang/AST/CharUnits.h"
13 #include "llvm/ADT/DenseMap.h"
14 #include "llvm/ADT/SmallPtrSet.h"
15 #include "llvm/ADT/SmallVector.h"
16 
17 #include "DWARFASTParser.h"
18 #include "DWARFDIE.h"
19 #include "DWARFDefines.h"
20 #include "DWARFFormValue.h"
21 #include "LogChannelDWARF.h"
22 #include "lldb/Core/PluginInterface.h"
23 
24 #include "Plugins/ExpressionParser/Clang/ClangASTImporter.h"
25 #include "Plugins/TypeSystem/Clang/TypeSystemClang.h"
26 
27 #include <vector>
28 
29 namespace lldb_private {
30 class CompileUnit;
31 }
32 class DWARFDebugInfoEntry;
33 class SymbolFileDWARF;
34 
35 struct ParsedDWARFTypeAttributes;
36 
37 class DWARFASTParserClang : public DWARFASTParser {
38 public:
39   DWARFASTParserClang(lldb_private::TypeSystemClang &ast);
40 
41   ~DWARFASTParserClang() override;
42 
43   // DWARFASTParser interface.
44   lldb::TypeSP ParseTypeFromDWARF(const lldb_private::SymbolContext &sc,
45                                   const DWARFDIE &die,
46                                   bool *type_is_new_ptr) override;
47 
48   lldb_private::Function *
49   ParseFunctionFromDWARF(lldb_private::CompileUnit &comp_unit,
50                          const DWARFDIE &die) override;
51 
52   bool
53   CompleteTypeFromDWARF(const DWARFDIE &die, lldb_private::Type *type,
54                         lldb_private::CompilerType &compiler_type) override;
55 
56   lldb_private::CompilerDecl
57   GetDeclForUIDFromDWARF(const DWARFDIE &die) override;
58 
59   void EnsureAllDIEsInDeclContextHaveBeenParsed(
60       lldb_private::CompilerDeclContext decl_context) override;
61 
62   lldb_private::CompilerDeclContext
63   GetDeclContextForUIDFromDWARF(const DWARFDIE &die) override;
64 
65   lldb_private::CompilerDeclContext
66   GetDeclContextContainingUIDFromDWARF(const DWARFDIE &die) override;
67 
68   lldb_private::ClangASTImporter &GetClangASTImporter();
69 
70 protected:
71   /// Protected typedefs and members.
72   /// @{
73   class DelayedAddObjCClassProperty;
74   typedef std::vector<DelayedAddObjCClassProperty> DelayedPropertyList;
75 
76   typedef llvm::DenseMap<const DWARFDebugInfoEntry *, clang::DeclContext *>
77       DIEToDeclContextMap;
78   typedef std::multimap<const clang::DeclContext *, const DWARFDIE>
79       DeclContextToDIEMap;
80   typedef llvm::DenseMap<const DWARFDebugInfoEntry *,
81                          lldb_private::OptionalClangModuleID>
82       DIEToModuleMap;
83   typedef llvm::DenseMap<const DWARFDebugInfoEntry *, clang::Decl *>
84       DIEToDeclMap;
85 
86   lldb_private::TypeSystemClang &m_ast;
87   DIEToDeclMap m_die_to_decl;
88   DIEToDeclContextMap m_die_to_decl_ctx;
89   DeclContextToDIEMap m_decl_ctx_to_die;
90   DIEToModuleMap m_die_to_module;
91   std::unique_ptr<lldb_private::ClangASTImporter> m_clang_ast_importer_up;
92   /// @}
93 
94   clang::DeclContext *GetDeclContextForBlock(const DWARFDIE &die);
95 
96   clang::BlockDecl *ResolveBlockDIE(const DWARFDIE &die);
97 
98   clang::NamespaceDecl *ResolveNamespaceDIE(const DWARFDIE &die);
99 
100   bool ParseTemplateDIE(const DWARFDIE &die,
101                         lldb_private::TypeSystemClang::TemplateParameterInfos
102                             &template_param_infos);
103   bool ParseTemplateParameterInfos(
104       const DWARFDIE &parent_die,
105       lldb_private::TypeSystemClang::TemplateParameterInfos
106           &template_param_infos);
107 
108   bool ParseChildMembers(
109       const DWARFDIE &die, lldb_private::CompilerType &class_compiler_type,
110       std::vector<std::unique_ptr<clang::CXXBaseSpecifier>> &base_classes,
111       std::vector<DWARFDIE> &member_function_dies,
112       DelayedPropertyList &delayed_properties,
113       lldb::AccessType &default_accessibility,
114       lldb_private::ClangASTImporter::LayoutInfo &layout_info);
115 
116   size_t
117   ParseChildParameters(clang::DeclContext *containing_decl_ctx,
118                        const DWARFDIE &parent_die, bool skip_artificial,
119                        bool &is_static, bool &is_variadic,
120                        bool &has_template_params,
121                        std::vector<lldb_private::CompilerType> &function_args,
122                        std::vector<clang::ParmVarDecl *> &function_param_decls,
123                        unsigned &type_quals);
124 
125   size_t ParseChildEnumerators(lldb_private::CompilerType &compiler_type,
126                                bool is_signed, uint32_t enumerator_byte_size,
127                                const DWARFDIE &parent_die);
128 
129   /// Parse a structure, class, or union type DIE.
130   lldb::TypeSP ParseStructureLikeDIE(const lldb_private::SymbolContext &sc,
131                                      const DWARFDIE &die,
132                                      ParsedDWARFTypeAttributes &attrs);
133 
134   lldb_private::Type *GetTypeForDIE(const DWARFDIE &die);
135 
136   clang::Decl *GetClangDeclForDIE(const DWARFDIE &die);
137 
138   clang::DeclContext *GetClangDeclContextForDIE(const DWARFDIE &die);
139 
140   clang::DeclContext *GetClangDeclContextContainingDIE(const DWARFDIE &die,
141                                                        DWARFDIE *decl_ctx_die);
142   lldb_private::OptionalClangModuleID GetOwningClangModule(const DWARFDIE &die);
143 
144   bool CopyUniqueClassMethodTypes(const DWARFDIE &src_class_die,
145                                   const DWARFDIE &dst_class_die,
146                                   lldb_private::Type *class_type,
147                                   std::vector<DWARFDIE> &failures);
148 
149   clang::DeclContext *GetCachedClangDeclContextForDIE(const DWARFDIE &die);
150 
151   void LinkDeclContextToDIE(clang::DeclContext *decl_ctx, const DWARFDIE &die);
152 
153   void LinkDeclToDIE(clang::Decl *decl, const DWARFDIE &die);
154 
155   /// If \p type_sp is valid, calculate and set its symbol context scope, and
156   /// update the type list for its backing symbol file.
157   ///
158   /// Returns \p type_sp.
159   lldb::TypeSP
160   UpdateSymbolContextScopeForType(const lldb_private::SymbolContext &sc,
161                                   const DWARFDIE &die, lldb::TypeSP type_sp);
162 
163   /// Follow Clang Module Skeleton CU references to find a type definition.
164   lldb::TypeSP ParseTypeFromClangModule(const lldb_private::SymbolContext &sc,
165                                         const DWARFDIE &die,
166                                         lldb_private::Log *log);
167 
168   // Return true if this type is a declaration to a type in an external
169   // module.
170   lldb::ModuleSP GetModuleForType(const DWARFDIE &die);
171 
172 private:
173   struct FieldInfo {
174     uint64_t bit_size = 0;
175     uint64_t bit_offset = 0;
176     bool is_bitfield = false;
177 
178     FieldInfo() = default;
179 
180     void SetIsBitfield(bool flag) { is_bitfield = flag; }
181     bool IsBitfield() { return is_bitfield; }
182 
183     bool NextBitfieldOffsetIsValid(const uint64_t next_bit_offset) const {
184       // Any subsequent bitfields must not overlap and must be at a higher
185       // bit offset than any previous bitfield + size.
186       return (bit_size + bit_offset) <= next_bit_offset;
187     }
188   };
189 
190   void
191   ParseSingleMember(const DWARFDIE &die, const DWARFDIE &parent_die,
192                     const lldb_private::CompilerType &class_clang_type,
193                     lldb::AccessType default_accessibility,
194                     DelayedPropertyList &delayed_properties,
195                     lldb_private::ClangASTImporter::LayoutInfo &layout_info,
196                     FieldInfo &last_field_info);
197 
198   bool CompleteRecordType(const DWARFDIE &die, lldb_private::Type *type,
199                           lldb_private::CompilerType &clang_type);
200   bool CompleteEnumType(const DWARFDIE &die, lldb_private::Type *type,
201                         lldb_private::CompilerType &clang_type);
202 
203   lldb::TypeSP ParseTypeModifier(const lldb_private::SymbolContext &sc,
204                                  const DWARFDIE &die,
205                                  ParsedDWARFTypeAttributes &attrs);
206   lldb::TypeSP ParseEnum(const lldb_private::SymbolContext &sc,
207                          const DWARFDIE &die, ParsedDWARFTypeAttributes &attrs);
208   lldb::TypeSP ParseSubroutine(const DWARFDIE &die,
209                                ParsedDWARFTypeAttributes &attrs);
210   // FIXME: attrs should be passed as a const reference.
211   lldb::TypeSP ParseArrayType(const DWARFDIE &die,
212                               ParsedDWARFTypeAttributes &attrs);
213   lldb::TypeSP ParsePointerToMemberType(const DWARFDIE &die,
214                                         const ParsedDWARFTypeAttributes &attrs);
215 };
216 
217 /// Parsed form of all attributes that are relevant for type reconstruction.
218 /// Some attributes are relevant for all kinds of types (declaration), while
219 /// others are only meaningful to a specific type (is_virtual)
220 struct ParsedDWARFTypeAttributes {
221   explicit ParsedDWARFTypeAttributes(const DWARFDIE &die);
222 
223   lldb::AccessType accessibility = lldb::eAccessNone;
224   bool is_artificial = false;
225   bool is_complete_objc_class = false;
226   bool is_explicit = false;
227   bool is_forward_declaration = false;
228   bool is_inline = false;
229   bool is_scoped_enum = false;
230   bool is_vector = false;
231   bool is_virtual = false;
232   bool is_objc_direct_call = false;
233   bool exports_symbols = false;
234   clang::StorageClass storage = clang::SC_None;
235   const char *mangled_name = nullptr;
236   lldb_private::ConstString name;
237   lldb_private::Declaration decl;
238   DWARFDIE object_pointer;
239   DWARFFormValue abstract_origin;
240   DWARFFormValue containing_type;
241   DWARFFormValue signature;
242   DWARFFormValue specification;
243   DWARFFormValue type;
244   lldb::LanguageType class_language = lldb::eLanguageTypeUnknown;
245   llvm::Optional<uint64_t> byte_size;
246   size_t calling_convention = llvm::dwarf::DW_CC_normal;
247   uint32_t bit_stride = 0;
248   uint32_t byte_stride = 0;
249   uint32_t encoding = 0;
250 };
251 
252 #endif // LLDB_SOURCE_PLUGINS_SYMBOLFILE_DWARF_DWARFASTPARSERCLANG_H
253