• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 //===-- DWARFASTParserClang.cpp -------------------------------------------===//
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 #include <stdlib.h>
10 
11 #include "DWARFASTParserClang.h"
12 #include "DWARFDebugInfo.h"
13 #include "DWARFDeclContext.h"
14 #include "DWARFDefines.h"
15 #include "SymbolFileDWARF.h"
16 #include "SymbolFileDWARFDebugMap.h"
17 #include "SymbolFileDWARFDwo.h"
18 #include "UniqueDWARFASTType.h"
19 
20 #include "Plugins/ExpressionParser/Clang/ClangASTImporter.h"
21 #include "Plugins/ExpressionParser/Clang/ClangASTMetadata.h"
22 #include "Plugins/ExpressionParser/Clang/ClangUtil.h"
23 #include "Plugins/Language/ObjC/ObjCLanguage.h"
24 #include "lldb/Core/Module.h"
25 #include "lldb/Core/Value.h"
26 #include "lldb/Host/Host.h"
27 #include "lldb/Symbol/CompileUnit.h"
28 #include "lldb/Symbol/Function.h"
29 #include "lldb/Symbol/ObjectFile.h"
30 #include "lldb/Symbol/SymbolFile.h"
31 #include "lldb/Symbol/TypeList.h"
32 #include "lldb/Symbol/TypeMap.h"
33 #include "lldb/Target/Language.h"
34 #include "lldb/Utility/LLDBAssert.h"
35 #include "lldb/Utility/Log.h"
36 #include "lldb/Utility/StreamString.h"
37 
38 #include "llvm/Demangle/Demangle.h"
39 
40 #include "clang/AST/CXXInheritance.h"
41 #include "clang/AST/DeclCXX.h"
42 #include "clang/AST/DeclObjC.h"
43 #include "clang/AST/DeclTemplate.h"
44 
45 #include <map>
46 #include <memory>
47 #include <vector>
48 
49 //#define ENABLE_DEBUG_PRINTF // COMMENT OUT THIS LINE PRIOR TO CHECKIN
50 
51 #ifdef ENABLE_DEBUG_PRINTF
52 #include <stdio.h>
53 #define DEBUG_PRINTF(fmt, ...) printf(fmt, __VA_ARGS__)
54 #else
55 #define DEBUG_PRINTF(fmt, ...)
56 #endif
57 
58 using namespace lldb;
59 using namespace lldb_private;
DWARFASTParserClang(TypeSystemClang & ast)60 DWARFASTParserClang::DWARFASTParserClang(TypeSystemClang &ast)
61     : m_ast(ast), m_die_to_decl_ctx(), m_decl_ctx_to_die() {}
62 
~DWARFASTParserClang()63 DWARFASTParserClang::~DWARFASTParserClang() {}
64 
DW_ACCESS_to_AccessType(uint32_t dwarf_accessibility)65 static AccessType DW_ACCESS_to_AccessType(uint32_t dwarf_accessibility) {
66   switch (dwarf_accessibility) {
67   case DW_ACCESS_public:
68     return eAccessPublic;
69   case DW_ACCESS_private:
70     return eAccessPrivate;
71   case DW_ACCESS_protected:
72     return eAccessProtected;
73   default:
74     break;
75   }
76   return eAccessNone;
77 }
78 
DeclKindIsCXXClass(clang::Decl::Kind decl_kind)79 static bool DeclKindIsCXXClass(clang::Decl::Kind decl_kind) {
80   switch (decl_kind) {
81   case clang::Decl::CXXRecord:
82   case clang::Decl::ClassTemplateSpecialization:
83     return true;
84   default:
85     break;
86   }
87   return false;
88 }
89 
90 
GetClangASTImporter()91 ClangASTImporter &DWARFASTParserClang::GetClangASTImporter() {
92   if (!m_clang_ast_importer_up) {
93     m_clang_ast_importer_up = std::make_unique<ClangASTImporter>();
94   }
95   return *m_clang_ast_importer_up;
96 }
97 
98 /// Detect a forward declaration that is nested in a DW_TAG_module.
IsClangModuleFwdDecl(const DWARFDIE & Die)99 static bool IsClangModuleFwdDecl(const DWARFDIE &Die) {
100   if (!Die.GetAttributeValueAsUnsigned(DW_AT_declaration, 0))
101     return false;
102   auto Parent = Die.GetParent();
103   while (Parent.IsValid()) {
104     if (Parent.Tag() == DW_TAG_module)
105       return true;
106     Parent = Parent.GetParent();
107   }
108   return false;
109 }
110 
GetContainingClangModuleDIE(const DWARFDIE & die)111 static DWARFDIE GetContainingClangModuleDIE(const DWARFDIE &die) {
112   if (die.IsValid()) {
113     DWARFDIE top_module_die;
114     // Now make sure this DIE is scoped in a DW_TAG_module tag and return true
115     // if so
116     for (DWARFDIE parent = die.GetParent(); parent.IsValid();
117          parent = parent.GetParent()) {
118       const dw_tag_t tag = parent.Tag();
119       if (tag == DW_TAG_module)
120         top_module_die = parent;
121       else if (tag == DW_TAG_compile_unit || tag == DW_TAG_partial_unit)
122         break;
123     }
124 
125     return top_module_die;
126   }
127   return DWARFDIE();
128 }
129 
GetContainingClangModule(const DWARFDIE & die)130 static lldb::ModuleSP GetContainingClangModule(const DWARFDIE &die) {
131   if (die.IsValid()) {
132     DWARFDIE clang_module_die = GetContainingClangModuleDIE(die);
133 
134     if (clang_module_die) {
135       const char *module_name = clang_module_die.GetName();
136       if (module_name)
137         return die.GetDWARF()->GetExternalModule(
138             lldb_private::ConstString(module_name));
139     }
140   }
141   return lldb::ModuleSP();
142 }
143 
ParseTypeFromClangModule(const SymbolContext & sc,const DWARFDIE & die,Log * log)144 TypeSP DWARFASTParserClang::ParseTypeFromClangModule(const SymbolContext &sc,
145                                                      const DWARFDIE &die,
146                                                      Log *log) {
147   ModuleSP clang_module_sp = GetContainingClangModule(die);
148   if (!clang_module_sp)
149     return TypeSP();
150 
151   // If this type comes from a Clang module, recursively look in the
152   // DWARF section of the .pcm file in the module cache. Clang
153   // generates DWO skeleton units as breadcrumbs to find them.
154   llvm::SmallVector<CompilerContext, 4> decl_context;
155   die.GetDeclContext(decl_context);
156   TypeMap pcm_types;
157 
158   // The type in the Clang module must have the same language as the current CU.
159   LanguageSet languages;
160   languages.Insert(SymbolFileDWARF::GetLanguage(*die.GetCU()));
161   llvm::DenseSet<SymbolFile *> searched_symbol_files;
162   clang_module_sp->GetSymbolFile()->FindTypes(decl_context, languages,
163                                               searched_symbol_files, pcm_types);
164   if (pcm_types.Empty()) {
165     // Since this type is defined in one of the Clang modules imported
166     // by this symbol file, search all of them. Instead of calling
167     // sym_file->FindTypes(), which would return this again, go straight
168     // to the imported modules.
169     auto &sym_file = die.GetCU()->GetSymbolFileDWARF();
170 
171     // Well-formed clang modules never form cycles; guard against corrupted
172     // ones by inserting the current file.
173     searched_symbol_files.insert(&sym_file);
174     sym_file.ForEachExternalModule(
175         *sc.comp_unit, searched_symbol_files, [&](Module &module) {
176           module.GetSymbolFile()->FindTypes(decl_context, languages,
177                                             searched_symbol_files, pcm_types);
178           return pcm_types.GetSize();
179         });
180   }
181 
182   if (!pcm_types.GetSize())
183     return TypeSP();
184 
185   // We found a real definition for this type in the Clang module, so lets use
186   // it and cache the fact that we found a complete type for this die.
187   TypeSP pcm_type_sp = pcm_types.GetTypeAtIndex(0);
188   if (!pcm_type_sp)
189     return TypeSP();
190 
191   lldb_private::CompilerType pcm_type = pcm_type_sp->GetForwardCompilerType();
192   lldb_private::CompilerType type =
193       GetClangASTImporter().CopyType(m_ast, pcm_type);
194 
195   if (!type)
196     return TypeSP();
197 
198   // Under normal operation pcm_type is a shallow forward declaration
199   // that gets completed later. This is necessary to support cyclic
200   // data structures. If, however, pcm_type is already complete (for
201   // example, because it was loaded for a different target before),
202   // the definition needs to be imported right away, too.
203   // Type::ResolveClangType() effectively ignores the ResolveState
204   // inside type_sp and only looks at IsDefined(), so it never calls
205   // ClangASTImporter::ASTImporterDelegate::ImportDefinitionTo(),
206   // which does extra work for Objective-C classes. This would result
207   // in only the forward declaration to be visible.
208   if (pcm_type.IsDefined())
209     GetClangASTImporter().RequireCompleteType(ClangUtil::GetQualType(type));
210 
211   SymbolFileDWARF *dwarf = die.GetDWARF();
212   TypeSP type_sp(new Type(die.GetID(), dwarf, pcm_type_sp->GetName(),
213                           pcm_type_sp->GetByteSize(nullptr), nullptr,
214                           LLDB_INVALID_UID, Type::eEncodingInvalid,
215                           &pcm_type_sp->GetDeclaration(), type,
216                           Type::ResolveState::Forward,
217                           TypePayloadClang(GetOwningClangModule(die))));
218 
219   dwarf->GetTypeList().Insert(type_sp);
220   dwarf->GetDIEToType()[die.GetDIE()] = type_sp.get();
221   clang::TagDecl *tag_decl = TypeSystemClang::GetAsTagDecl(type);
222   if (tag_decl) {
223     LinkDeclContextToDIE(tag_decl, die);
224   } else {
225     clang::DeclContext *defn_decl_ctx = GetCachedClangDeclContextForDIE(die);
226     if (defn_decl_ctx)
227       LinkDeclContextToDIE(defn_decl_ctx, die);
228   }
229 
230   return type_sp;
231 }
232 
ForcefullyCompleteType(CompilerType type)233 static void ForcefullyCompleteType(CompilerType type) {
234   bool started = TypeSystemClang::StartTagDeclarationDefinition(type);
235   lldbassert(started && "Unable to start a class type definition.");
236   TypeSystemClang::CompleteTagDeclarationDefinition(type);
237   const clang::TagDecl *td = ClangUtil::GetAsTagDecl(type);
238   auto &ts = llvm::cast<TypeSystemClang>(*type.GetTypeSystem());
239   ts.GetMetadata(td)->SetIsForcefullyCompleted();
240 }
241 
242 /// Complete a type from debug info, or mark it as forcefully completed if
243 /// there is no definition of the type in the current Module. Call this function
244 /// in contexts where the usual C++ rules require a type to be complete (base
245 /// class, member, etc.).
RequireCompleteType(CompilerType type)246 static void RequireCompleteType(CompilerType type) {
247   // Technically, enums can be incomplete too, but we don't handle those as they
248   // are emitted even under -flimit-debug-info.
249   if (!TypeSystemClang::IsCXXClassType(type))
250     return;
251 
252   if (type.GetCompleteType())
253     return;
254 
255   // No complete definition in this module.  Mark the class as complete to
256   // satisfy local ast invariants, but make a note of the fact that
257   // it is not _really_ complete so we can later search for a definition in a
258   // different module.
259   // Since we provide layout assistance, layouts of types containing this class
260   // will be correct even if we  are not able to find the definition elsewhere.
261   ForcefullyCompleteType(type);
262 }
263 
264 /// This function serves a similar purpose as RequireCompleteType above, but it
265 /// avoids completing the type if it is not immediately necessary. It only
266 /// ensures we _can_ complete the type later.
PrepareContextToReceiveMembers(TypeSystemClang & ast,ClangASTImporter & ast_importer,clang::DeclContext * decl_ctx,DWARFDIE die,const char * type_name_cstr)267 static void PrepareContextToReceiveMembers(TypeSystemClang &ast,
268                                            ClangASTImporter &ast_importer,
269                                            clang::DeclContext *decl_ctx,
270                                            DWARFDIE die,
271                                            const char *type_name_cstr) {
272   auto *tag_decl_ctx = clang::dyn_cast<clang::TagDecl>(decl_ctx);
273   if (!tag_decl_ctx)
274     return; // Non-tag context are always ready.
275 
276   // We have already completed the type, or we have found its definition and are
277   // ready to complete it later (cf. ParseStructureLikeDIE).
278   if (tag_decl_ctx->isCompleteDefinition() || tag_decl_ctx->isBeingDefined())
279     return;
280 
281   // We reach this point of the tag was present in the debug info as a
282   // declaration only. If it was imported from another AST context (in the
283   // gmodules case), we can complete the type by doing a full import.
284 
285   // If this type was not imported from an external AST, there's nothing to do.
286   CompilerType type = ast.GetTypeForDecl(tag_decl_ctx);
287   if (type && ast_importer.CanImport(type)) {
288     auto qual_type = ClangUtil::GetQualType(type);
289     if (ast_importer.RequireCompleteType(qual_type))
290       return;
291     die.GetDWARF()->GetObjectFile()->GetModule()->ReportError(
292         "Unable to complete the Decl context for DIE '%s' at offset "
293         "0x%8.8x.\nPlease file a bug report.",
294         type_name_cstr ? type_name_cstr : "", die.GetOffset());
295   }
296 
297   // We don't have a type definition and/or the import failed. We must
298   // forcefully complete the type to avoid crashes.
299   ForcefullyCompleteType(type);
300 }
301 
ParsedDWARFTypeAttributes(const DWARFDIE & die)302 ParsedDWARFTypeAttributes::ParsedDWARFTypeAttributes(const DWARFDIE &die) {
303   DWARFAttributes attributes;
304   size_t num_attributes = die.GetAttributes(attributes);
305   for (size_t i = 0; i < num_attributes; ++i) {
306     dw_attr_t attr = attributes.AttributeAtIndex(i);
307     DWARFFormValue form_value;
308     if (!attributes.ExtractFormValueAtIndex(i, form_value))
309       continue;
310     switch (attr) {
311     case DW_AT_abstract_origin:
312       abstract_origin = form_value;
313       break;
314 
315     case DW_AT_accessibility:
316       accessibility = DW_ACCESS_to_AccessType(form_value.Unsigned());
317       break;
318 
319     case DW_AT_artificial:
320       is_artificial = form_value.Boolean();
321       break;
322 
323     case DW_AT_bit_stride:
324       bit_stride = form_value.Unsigned();
325       break;
326 
327     case DW_AT_byte_size:
328       byte_size = form_value.Unsigned();
329       break;
330 
331     case DW_AT_byte_stride:
332       byte_stride = form_value.Unsigned();
333       break;
334 
335     case DW_AT_calling_convention:
336       calling_convention = form_value.Unsigned();
337       break;
338 
339     case DW_AT_containing_type:
340       containing_type = form_value;
341       break;
342 
343     case DW_AT_decl_file:
344       // die.GetCU() can differ if DW_AT_specification uses DW_FORM_ref_addr.
345       decl.SetFile(
346           attributes.CompileUnitAtIndex(i)->GetFile(form_value.Unsigned()));
347       break;
348     case DW_AT_decl_line:
349       decl.SetLine(form_value.Unsigned());
350       break;
351     case DW_AT_decl_column:
352       decl.SetColumn(form_value.Unsigned());
353       break;
354 
355     case DW_AT_declaration:
356       is_forward_declaration = form_value.Boolean();
357       break;
358 
359     case DW_AT_encoding:
360       encoding = form_value.Unsigned();
361       break;
362 
363     case DW_AT_enum_class:
364       is_scoped_enum = form_value.Boolean();
365       break;
366 
367     case DW_AT_explicit:
368       is_explicit = form_value.Boolean();
369       break;
370 
371     case DW_AT_external:
372       if (form_value.Unsigned())
373         storage = clang::SC_Extern;
374       break;
375 
376     case DW_AT_inline:
377       is_inline = form_value.Boolean();
378       break;
379 
380     case DW_AT_linkage_name:
381     case DW_AT_MIPS_linkage_name:
382       mangled_name = form_value.AsCString();
383       break;
384 
385     case DW_AT_name:
386       name.SetCString(form_value.AsCString());
387       break;
388 
389     case DW_AT_object_pointer:
390       object_pointer = form_value.Reference();
391       break;
392 
393     case DW_AT_signature:
394       signature = form_value;
395       break;
396 
397     case DW_AT_specification:
398       specification = form_value;
399       break;
400 
401     case DW_AT_type:
402       type = form_value;
403       break;
404 
405     case DW_AT_virtuality:
406       is_virtual = form_value.Boolean();
407       break;
408 
409     case DW_AT_APPLE_objc_complete_type:
410       is_complete_objc_class = form_value.Signed();
411       break;
412 
413     case DW_AT_APPLE_objc_direct:
414       is_objc_direct_call = true;
415       break;
416 
417     case DW_AT_APPLE_runtime_class:
418       class_language = (LanguageType)form_value.Signed();
419       break;
420 
421     case DW_AT_GNU_vector:
422       is_vector = form_value.Boolean();
423       break;
424     case DW_AT_export_symbols:
425       exports_symbols = form_value.Boolean();
426       break;
427     }
428   }
429 }
430 
GetUnitName(const DWARFDIE & die)431 static std::string GetUnitName(const DWARFDIE &die) {
432   if (DWARFUnit *unit = die.GetCU())
433     return unit->GetAbsolutePath().GetPath();
434   return "<missing DWARF unit path>";
435 }
436 
ParseTypeFromDWARF(const SymbolContext & sc,const DWARFDIE & die,bool * type_is_new_ptr)437 TypeSP DWARFASTParserClang::ParseTypeFromDWARF(const SymbolContext &sc,
438                                                const DWARFDIE &die,
439                                                bool *type_is_new_ptr) {
440   if (type_is_new_ptr)
441     *type_is_new_ptr = false;
442 
443   if (!die)
444     return nullptr;
445 
446   Log *log(LogChannelDWARF::GetLogIfAny(DWARF_LOG_TYPE_COMPLETION |
447                                         DWARF_LOG_LOOKUPS));
448 
449   SymbolFileDWARF *dwarf = die.GetDWARF();
450   if (log) {
451     DWARFDIE context_die;
452     clang::DeclContext *context =
453         GetClangDeclContextContainingDIE(die, &context_die);
454 
455     dwarf->GetObjectFile()->GetModule()->LogMessage(
456         log,
457         "DWARFASTParserClang::ParseTypeFromDWARF "
458         "(die = 0x%8.8x, decl_ctx = %p (die 0x%8.8x)) %s name = '%s')",
459         die.GetOffset(), static_cast<void *>(context), context_die.GetOffset(),
460         die.GetTagAsCString(), die.GetName());
461   }
462 
463   Type *type_ptr = dwarf->GetDIEToType().lookup(die.GetDIE());
464   if (type_ptr == DIE_IS_BEING_PARSED)
465     return nullptr;
466   if (type_ptr)
467     return type_ptr->shared_from_this();
468   // Set a bit that lets us know that we are currently parsing this
469   dwarf->GetDIEToType()[die.GetDIE()] = DIE_IS_BEING_PARSED;
470 
471   ParsedDWARFTypeAttributes attrs(die);
472 
473   if (DWARFDIE signature_die = attrs.signature.Reference()) {
474     if (TypeSP type_sp =
475             ParseTypeFromDWARF(sc, signature_die, type_is_new_ptr)) {
476       dwarf->GetDIEToType()[die.GetDIE()] = type_sp.get();
477       if (clang::DeclContext *decl_ctx =
478               GetCachedClangDeclContextForDIE(signature_die))
479         LinkDeclContextToDIE(decl_ctx, die);
480       return type_sp;
481     }
482     return nullptr;
483   }
484 
485   if (type_is_new_ptr)
486     *type_is_new_ptr = true;
487 
488   const dw_tag_t tag = die.Tag();
489 
490   TypeSP type_sp;
491 
492   switch (tag) {
493   case DW_TAG_typedef:
494   case DW_TAG_base_type:
495   case DW_TAG_pointer_type:
496   case DW_TAG_reference_type:
497   case DW_TAG_rvalue_reference_type:
498   case DW_TAG_const_type:
499   case DW_TAG_restrict_type:
500   case DW_TAG_volatile_type:
501   case DW_TAG_atomic_type:
502   case DW_TAG_unspecified_type: {
503     type_sp = ParseTypeModifier(sc, die, attrs);
504     break;
505   }
506 
507   case DW_TAG_structure_type:
508   case DW_TAG_union_type:
509   case DW_TAG_class_type: {
510     type_sp = ParseStructureLikeDIE(sc, die, attrs);
511     break;
512   }
513 
514   case DW_TAG_enumeration_type: {
515     type_sp = ParseEnum(sc, die, attrs);
516     break;
517   }
518 
519   case DW_TAG_inlined_subroutine:
520   case DW_TAG_subprogram:
521   case DW_TAG_subroutine_type: {
522     type_sp = ParseSubroutine(die, attrs);
523     break;
524   }
525   case DW_TAG_array_type: {
526     type_sp = ParseArrayType(die, attrs);
527     break;
528   }
529   case DW_TAG_ptr_to_member_type: {
530     type_sp = ParsePointerToMemberType(die, attrs);
531     break;
532   }
533   default:
534     dwarf->GetObjectFile()->GetModule()->ReportError(
535         "{0x%8.8x}: unhandled type tag 0x%4.4x (%s), please file a bug and "
536         "attach the file at the start of this error message",
537         die.GetOffset(), tag, DW_TAG_value_to_name(tag));
538     break;
539   }
540 
541   // TODO: We should consider making the switch above exhaustive to simplify
542   // control flow in ParseTypeFromDWARF. Then, we could simply replace this
543   // return statement with a call to llvm_unreachable.
544   return UpdateSymbolContextScopeForType(sc, die, type_sp);
545 }
546 
547 lldb::TypeSP
ParseTypeModifier(const SymbolContext & sc,const DWARFDIE & die,ParsedDWARFTypeAttributes & attrs)548 DWARFASTParserClang::ParseTypeModifier(const SymbolContext &sc,
549                                        const DWARFDIE &die,
550                                        ParsedDWARFTypeAttributes &attrs) {
551   Log *log(LogChannelDWARF::GetLogIfAny(DWARF_LOG_TYPE_COMPLETION |
552                                         DWARF_LOG_LOOKUPS));
553   SymbolFileDWARF *dwarf = die.GetDWARF();
554   const dw_tag_t tag = die.Tag();
555   LanguageType cu_language = SymbolFileDWARF::GetLanguage(*die.GetCU());
556   Type::ResolveState resolve_state = Type::ResolveState::Unresolved;
557   Type::EncodingDataType encoding_data_type = Type::eEncodingIsUID;
558   TypeSP type_sp;
559   CompilerType clang_type;
560 
561   if (tag == DW_TAG_typedef) {
562     // DeclContext will be populated when the clang type is materialized in
563     // Type::ResolveCompilerType.
564     PrepareContextToReceiveMembers(
565         m_ast, GetClangASTImporter(),
566         GetClangDeclContextContainingDIE(die, nullptr), die,
567         attrs.name.GetCString());
568 
569     if (attrs.type.IsValid()) {
570       // Try to parse a typedef from the (DWARF embedded in the) Clang
571       // module file first as modules can contain typedef'ed
572       // structures that have no names like:
573       //
574       //  typedef struct { int a; } Foo;
575       //
576       // In this case we will have a structure with no name and a
577       // typedef named "Foo" that points to this unnamed
578       // structure. The name in the typedef is the only identifier for
579       // the struct, so always try to get typedefs from Clang modules
580       // if possible.
581       //
582       // The type_sp returned will be empty if the typedef doesn't
583       // exist in a module file, so it is cheap to call this function
584       // just to check.
585       //
586       // If we don't do this we end up creating a TypeSP that says
587       // this is a typedef to type 0x123 (the DW_AT_type value would
588       // be 0x123 in the DW_TAG_typedef), and this is the unnamed
589       // structure type. We will have a hard time tracking down an
590       // unnammed structure type in the module debug info, so we make
591       // sure we don't get into this situation by always resolving
592       // typedefs from the module.
593       const DWARFDIE encoding_die = attrs.type.Reference();
594 
595       // First make sure that the die that this is typedef'ed to _is_
596       // just a declaration (DW_AT_declaration == 1), not a full
597       // definition since template types can't be represented in
598       // modules since only concrete instances of templates are ever
599       // emitted and modules won't contain those
600       if (encoding_die &&
601           encoding_die.GetAttributeValueAsUnsigned(DW_AT_declaration, 0) == 1) {
602         type_sp = ParseTypeFromClangModule(sc, die, log);
603         if (type_sp)
604           return type_sp;
605       }
606     }
607   }
608 
609   DEBUG_PRINTF("0x%8.8" PRIx64 ": %s (\"%s\") type => 0x%8.8lx\n", die.GetID(),
610                DW_TAG_value_to_name(tag), type_name_cstr,
611                encoding_uid.Reference());
612 
613   switch (tag) {
614   default:
615     break;
616 
617   case DW_TAG_unspecified_type:
618     if (attrs.name == "nullptr_t" || attrs.name == "decltype(nullptr)") {
619       resolve_state = Type::ResolveState::Full;
620       clang_type = m_ast.GetBasicType(eBasicTypeNullPtr);
621       break;
622     }
623     // Fall through to base type below in case we can handle the type
624     // there...
625     LLVM_FALLTHROUGH;
626 
627   case DW_TAG_base_type:
628     resolve_state = Type::ResolveState::Full;
629     clang_type = m_ast.GetBuiltinTypeForDWARFEncodingAndBitSize(
630         attrs.name.GetStringRef(), attrs.encoding,
631         attrs.byte_size.getValueOr(0) * 8);
632     break;
633 
634   case DW_TAG_pointer_type:
635     encoding_data_type = Type::eEncodingIsPointerUID;
636     break;
637   case DW_TAG_reference_type:
638     encoding_data_type = Type::eEncodingIsLValueReferenceUID;
639     break;
640   case DW_TAG_rvalue_reference_type:
641     encoding_data_type = Type::eEncodingIsRValueReferenceUID;
642     break;
643   case DW_TAG_typedef:
644     encoding_data_type = Type::eEncodingIsTypedefUID;
645     break;
646   case DW_TAG_const_type:
647     encoding_data_type = Type::eEncodingIsConstUID;
648     break;
649   case DW_TAG_restrict_type:
650     encoding_data_type = Type::eEncodingIsRestrictUID;
651     break;
652   case DW_TAG_volatile_type:
653     encoding_data_type = Type::eEncodingIsVolatileUID;
654     break;
655   case DW_TAG_atomic_type:
656     encoding_data_type = Type::eEncodingIsAtomicUID;
657     break;
658   }
659 
660   if (!clang_type && (encoding_data_type == Type::eEncodingIsPointerUID ||
661                       encoding_data_type == Type::eEncodingIsTypedefUID)) {
662     if (tag == DW_TAG_pointer_type) {
663       DWARFDIE target_die = die.GetReferencedDIE(DW_AT_type);
664 
665       if (target_die.GetAttributeValueAsUnsigned(DW_AT_APPLE_block, 0)) {
666         // Blocks have a __FuncPtr inside them which is a pointer to a
667         // function of the proper type.
668 
669         for (DWARFDIE child_die = target_die.GetFirstChild();
670              child_die.IsValid(); child_die = child_die.GetSibling()) {
671           if (!strcmp(child_die.GetAttributeValueAsString(DW_AT_name, ""),
672                       "__FuncPtr")) {
673             DWARFDIE function_pointer_type =
674                 child_die.GetReferencedDIE(DW_AT_type);
675 
676             if (function_pointer_type) {
677               DWARFDIE function_type =
678                   function_pointer_type.GetReferencedDIE(DW_AT_type);
679 
680               bool function_type_is_new_pointer;
681               TypeSP lldb_function_type_sp = ParseTypeFromDWARF(
682                   sc, function_type, &function_type_is_new_pointer);
683 
684               if (lldb_function_type_sp) {
685                 clang_type = m_ast.CreateBlockPointerType(
686                     lldb_function_type_sp->GetForwardCompilerType());
687                 encoding_data_type = Type::eEncodingIsUID;
688                 attrs.type.Clear();
689                 resolve_state = Type::ResolveState::Full;
690               }
691             }
692 
693             break;
694           }
695         }
696       }
697     }
698 
699     if (cu_language == eLanguageTypeObjC ||
700         cu_language == eLanguageTypeObjC_plus_plus) {
701       if (attrs.name) {
702         if (attrs.name == "id") {
703           if (log)
704             dwarf->GetObjectFile()->GetModule()->LogMessage(
705                 log,
706                 "SymbolFileDWARF::ParseType (die = 0x%8.8x) %s '%s' "
707                 "is Objective-C 'id' built-in type.",
708                 die.GetOffset(), die.GetTagAsCString(), die.GetName());
709           clang_type = m_ast.GetBasicType(eBasicTypeObjCID);
710           encoding_data_type = Type::eEncodingIsUID;
711           attrs.type.Clear();
712           resolve_state = Type::ResolveState::Full;
713         } else if (attrs.name == "Class") {
714           if (log)
715             dwarf->GetObjectFile()->GetModule()->LogMessage(
716                 log,
717                 "SymbolFileDWARF::ParseType (die = 0x%8.8x) %s '%s' "
718                 "is Objective-C 'Class' built-in type.",
719                 die.GetOffset(), die.GetTagAsCString(), die.GetName());
720           clang_type = m_ast.GetBasicType(eBasicTypeObjCClass);
721           encoding_data_type = Type::eEncodingIsUID;
722           attrs.type.Clear();
723           resolve_state = Type::ResolveState::Full;
724         } else if (attrs.name == "SEL") {
725           if (log)
726             dwarf->GetObjectFile()->GetModule()->LogMessage(
727                 log,
728                 "SymbolFileDWARF::ParseType (die = 0x%8.8x) %s '%s' "
729                 "is Objective-C 'selector' built-in type.",
730                 die.GetOffset(), die.GetTagAsCString(), die.GetName());
731           clang_type = m_ast.GetBasicType(eBasicTypeObjCSel);
732           encoding_data_type = Type::eEncodingIsUID;
733           attrs.type.Clear();
734           resolve_state = Type::ResolveState::Full;
735         }
736       } else if (encoding_data_type == Type::eEncodingIsPointerUID &&
737                  attrs.type.IsValid()) {
738         // Clang sometimes erroneously emits id as objc_object*.  In that
739         // case we fix up the type to "id".
740 
741         const DWARFDIE encoding_die = attrs.type.Reference();
742 
743         if (encoding_die && encoding_die.Tag() == DW_TAG_structure_type) {
744           llvm::StringRef struct_name = encoding_die.GetName();
745           if (struct_name == "objc_object") {
746             if (log)
747               dwarf->GetObjectFile()->GetModule()->LogMessage(
748                   log,
749                   "SymbolFileDWARF::ParseType (die = 0x%8.8x) %s "
750                   "'%s' is 'objc_object*', which we overrode to "
751                   "'id'.",
752                   die.GetOffset(), die.GetTagAsCString(), die.GetName());
753             clang_type = m_ast.GetBasicType(eBasicTypeObjCID);
754             encoding_data_type = Type::eEncodingIsUID;
755             attrs.type.Clear();
756             resolve_state = Type::ResolveState::Full;
757           }
758         }
759       }
760     }
761   }
762 
763   type_sp = std::make_shared<Type>(
764       die.GetID(), dwarf, attrs.name, attrs.byte_size, nullptr,
765       dwarf->GetUID(attrs.type.Reference()), encoding_data_type, &attrs.decl,
766       clang_type, resolve_state, TypePayloadClang(GetOwningClangModule(die)));
767 
768   dwarf->GetDIEToType()[die.GetDIE()] = type_sp.get();
769   return type_sp;
770 }
771 
ParseEnum(const SymbolContext & sc,const DWARFDIE & die,ParsedDWARFTypeAttributes & attrs)772 TypeSP DWARFASTParserClang::ParseEnum(const SymbolContext &sc,
773                                       const DWARFDIE &die,
774                                       ParsedDWARFTypeAttributes &attrs) {
775   Log *log(LogChannelDWARF::GetLogIfAny(DWARF_LOG_TYPE_COMPLETION |
776                                         DWARF_LOG_LOOKUPS));
777   SymbolFileDWARF *dwarf = die.GetDWARF();
778   const dw_tag_t tag = die.Tag();
779   TypeSP type_sp;
780 
781   if (attrs.is_forward_declaration) {
782     type_sp = ParseTypeFromClangModule(sc, die, log);
783     if (type_sp)
784       return type_sp;
785 
786     DWARFDeclContext die_decl_ctx = SymbolFileDWARF::GetDWARFDeclContext(die);
787 
788     type_sp = dwarf->FindDefinitionTypeForDWARFDeclContext(die_decl_ctx);
789 
790     if (!type_sp) {
791       SymbolFileDWARFDebugMap *debug_map_symfile = dwarf->GetDebugMapSymfile();
792       if (debug_map_symfile) {
793         // We weren't able to find a full declaration in this DWARF,
794         // see if we have a declaration anywhere else...
795         type_sp = debug_map_symfile->FindDefinitionTypeForDWARFDeclContext(
796             die_decl_ctx);
797       }
798     }
799 
800     if (type_sp) {
801       if (log) {
802         dwarf->GetObjectFile()->GetModule()->LogMessage(
803             log,
804             "SymbolFileDWARF(%p) - 0x%8.8x: %s type \"%s\" is a "
805             "forward declaration, complete type is 0x%8.8" PRIx64,
806             static_cast<void *>(this), die.GetOffset(),
807             DW_TAG_value_to_name(tag), attrs.name.GetCString(),
808             type_sp->GetID());
809       }
810 
811       // We found a real definition for this type elsewhere so lets use
812       // it and cache the fact that we found a complete type for this
813       // die
814       dwarf->GetDIEToType()[die.GetDIE()] = type_sp.get();
815       clang::DeclContext *defn_decl_ctx =
816           GetCachedClangDeclContextForDIE(dwarf->GetDIE(type_sp->GetID()));
817       if (defn_decl_ctx)
818         LinkDeclContextToDIE(defn_decl_ctx, die);
819       return type_sp;
820     }
821   }
822   DEBUG_PRINTF("0x%8.8" PRIx64 ": %s (\"%s\")\n", die.GetID(),
823                DW_TAG_value_to_name(tag), type_name_cstr);
824 
825   CompilerType enumerator_clang_type;
826   CompilerType clang_type;
827   clang_type.SetCompilerType(
828       &m_ast, dwarf->GetForwardDeclDieToClangType().lookup(die.GetDIE()));
829   if (!clang_type) {
830     if (attrs.type.IsValid()) {
831       Type *enumerator_type =
832           dwarf->ResolveTypeUID(attrs.type.Reference(), true);
833       if (enumerator_type)
834         enumerator_clang_type = enumerator_type->GetFullCompilerType();
835     }
836 
837     if (!enumerator_clang_type) {
838       if (attrs.byte_size) {
839         enumerator_clang_type = m_ast.GetBuiltinTypeForDWARFEncodingAndBitSize(
840             "", DW_ATE_signed, *attrs.byte_size * 8);
841       } else {
842         enumerator_clang_type = m_ast.GetBasicType(eBasicTypeInt);
843       }
844     }
845 
846     clang_type = m_ast.CreateEnumerationType(
847         attrs.name.GetCString(), GetClangDeclContextContainingDIE(die, nullptr),
848         GetOwningClangModule(die), attrs.decl, enumerator_clang_type,
849         attrs.is_scoped_enum);
850   } else {
851     enumerator_clang_type = m_ast.GetEnumerationIntegerType(clang_type);
852   }
853 
854   LinkDeclContextToDIE(TypeSystemClang::GetDeclContextForType(clang_type), die);
855 
856   type_sp = std::make_shared<Type>(
857       die.GetID(), dwarf, attrs.name, attrs.byte_size, nullptr,
858       dwarf->GetUID(attrs.type.Reference()), Type::eEncodingIsUID, &attrs.decl,
859       clang_type, Type::ResolveState::Forward,
860       TypePayloadClang(GetOwningClangModule(die)));
861 
862   if (TypeSystemClang::StartTagDeclarationDefinition(clang_type)) {
863     if (die.HasChildren()) {
864       bool is_signed = false;
865       enumerator_clang_type.IsIntegerType(is_signed);
866       ParseChildEnumerators(clang_type, is_signed,
867                             type_sp->GetByteSize(nullptr).getValueOr(0), die);
868     }
869     TypeSystemClang::CompleteTagDeclarationDefinition(clang_type);
870   } else {
871     dwarf->GetObjectFile()->GetModule()->ReportError(
872         "DWARF DIE at 0x%8.8x named \"%s\" was not able to start its "
873         "definition.\nPlease file a bug and attach the file at the "
874         "start of this error message",
875         die.GetOffset(), attrs.name.GetCString());
876   }
877   return type_sp;
878 }
879 
ParseSubroutine(const DWARFDIE & die,ParsedDWARFTypeAttributes & attrs)880 TypeSP DWARFASTParserClang::ParseSubroutine(const DWARFDIE &die,
881                            ParsedDWARFTypeAttributes &attrs) {
882   Log *log(LogChannelDWARF::GetLogIfAny(DWARF_LOG_TYPE_COMPLETION |
883                                         DWARF_LOG_LOOKUPS));
884 
885   SymbolFileDWARF *dwarf = die.GetDWARF();
886   const dw_tag_t tag = die.Tag();
887 
888   bool is_variadic = false;
889   bool is_static = false;
890   bool has_template_params = false;
891 
892   unsigned type_quals = 0;
893 
894   std::string object_pointer_name;
895   if (attrs.object_pointer) {
896     const char *object_pointer_name_cstr = attrs.object_pointer.GetName();
897     if (object_pointer_name_cstr)
898       object_pointer_name = object_pointer_name_cstr;
899   }
900 
901   DEBUG_PRINTF("0x%8.8" PRIx64 ": %s (\"%s\")\n", die.GetID(),
902                DW_TAG_value_to_name(tag), type_name_cstr);
903 
904   CompilerType return_clang_type;
905   Type *func_type = NULL;
906 
907   if (attrs.type.IsValid())
908     func_type = dwarf->ResolveTypeUID(attrs.type.Reference(), true);
909 
910   if (func_type)
911     return_clang_type = func_type->GetForwardCompilerType();
912   else
913     return_clang_type = m_ast.GetBasicType(eBasicTypeVoid);
914 
915   std::vector<CompilerType> function_param_types;
916   std::vector<clang::ParmVarDecl *> function_param_decls;
917 
918   // Parse the function children for the parameters
919 
920   DWARFDIE decl_ctx_die;
921   clang::DeclContext *containing_decl_ctx =
922       GetClangDeclContextContainingDIE(die, &decl_ctx_die);
923   const clang::Decl::Kind containing_decl_kind =
924       containing_decl_ctx->getDeclKind();
925 
926   bool is_cxx_method = DeclKindIsCXXClass(containing_decl_kind);
927   // Start off static. This will be set to false in
928   // ParseChildParameters(...) if we find a "this" parameters as the
929   // first parameter
930   if (is_cxx_method) {
931     is_static = true;
932   }
933 
934   if (die.HasChildren()) {
935     bool skip_artificial = true;
936     ParseChildParameters(containing_decl_ctx, die, skip_artificial, is_static,
937                          is_variadic, has_template_params,
938                          function_param_types, function_param_decls,
939                          type_quals);
940   }
941 
942   bool ignore_containing_context = false;
943   // Check for templatized class member functions. If we had any
944   // DW_TAG_template_type_parameter or DW_TAG_template_value_parameter
945   // the DW_TAG_subprogram DIE, then we can't let this become a method in
946   // a class. Why? Because templatized functions are only emitted if one
947   // of the templatized methods is used in the current compile unit and
948   // we will end up with classes that may or may not include these member
949   // functions and this means one class won't match another class
950   // definition and it affects our ability to use a class in the clang
951   // expression parser. So for the greater good, we currently must not
952   // allow any template member functions in a class definition.
953   if (is_cxx_method && has_template_params) {
954     ignore_containing_context = true;
955     is_cxx_method = false;
956   }
957 
958   // clang_type will get the function prototype clang type after this
959   // call
960   CompilerType clang_type = m_ast.CreateFunctionType(
961       return_clang_type, function_param_types.data(),
962       function_param_types.size(), is_variadic, type_quals);
963 
964   if (attrs.name) {
965     bool type_handled = false;
966     if (tag == DW_TAG_subprogram || tag == DW_TAG_inlined_subroutine) {
967       ObjCLanguage::MethodName objc_method(attrs.name.GetStringRef(), true);
968       if (objc_method.IsValid(true)) {
969         CompilerType class_opaque_type;
970         ConstString class_name(objc_method.GetClassName());
971         if (class_name) {
972           TypeSP complete_objc_class_type_sp(
973               dwarf->FindCompleteObjCDefinitionTypeForDIE(DWARFDIE(),
974                                                           class_name, false));
975 
976           if (complete_objc_class_type_sp) {
977             CompilerType type_clang_forward_type =
978                 complete_objc_class_type_sp->GetForwardCompilerType();
979             if (TypeSystemClang::IsObjCObjectOrInterfaceType(
980                     type_clang_forward_type))
981               class_opaque_type = type_clang_forward_type;
982           }
983         }
984 
985         if (class_opaque_type) {
986           // If accessibility isn't set to anything valid, assume public
987           // for now...
988           if (attrs.accessibility == eAccessNone)
989             attrs.accessibility = eAccessPublic;
990 
991           clang::ObjCMethodDecl *objc_method_decl =
992               m_ast.AddMethodToObjCObjectType(
993                   class_opaque_type, attrs.name.GetCString(), clang_type,
994                   attrs.accessibility, attrs.is_artificial, is_variadic,
995                   attrs.is_objc_direct_call);
996           type_handled = objc_method_decl != NULL;
997           if (type_handled) {
998             LinkDeclContextToDIE(objc_method_decl, die);
999             m_ast.SetMetadataAsUserID(objc_method_decl, die.GetID());
1000           } else {
1001             dwarf->GetObjectFile()->GetModule()->ReportError(
1002                 "{0x%8.8x}: invalid Objective-C method 0x%4.4x (%s), "
1003                 "please file a bug and attach the file at the start of "
1004                 "this error message",
1005                 die.GetOffset(), tag, DW_TAG_value_to_name(tag));
1006           }
1007         }
1008       } else if (is_cxx_method) {
1009         // Look at the parent of this DIE and see if is is a class or
1010         // struct and see if this is actually a C++ method
1011         Type *class_type = dwarf->ResolveType(decl_ctx_die);
1012         if (class_type) {
1013           bool alternate_defn = false;
1014           if (class_type->GetID() != decl_ctx_die.GetID() ||
1015               IsClangModuleFwdDecl(decl_ctx_die)) {
1016             alternate_defn = true;
1017 
1018             // We uniqued the parent class of this function to another
1019             // class so we now need to associate all dies under
1020             // "decl_ctx_die" to DIEs in the DIE for "class_type"...
1021             DWARFDIE class_type_die = dwarf->GetDIE(class_type->GetID());
1022 
1023             if (class_type_die) {
1024               std::vector<DWARFDIE> failures;
1025 
1026               CopyUniqueClassMethodTypes(decl_ctx_die, class_type_die,
1027                                          class_type, failures);
1028 
1029               // FIXME do something with these failures that's
1030               // smarter than just dropping them on the ground.
1031               // Unfortunately classes don't like having stuff added
1032               // to them after their definitions are complete...
1033 
1034               Type *type_ptr = dwarf->GetDIEToType()[die.GetDIE()];
1035               if (type_ptr && type_ptr != DIE_IS_BEING_PARSED) {
1036                 return type_ptr->shared_from_this();
1037               }
1038             }
1039           }
1040 
1041           if (attrs.specification.IsValid()) {
1042             // We have a specification which we are going to base our
1043             // function prototype off of, so we need this type to be
1044             // completed so that the m_die_to_decl_ctx for the method in
1045             // the specification has a valid clang decl context.
1046             class_type->GetForwardCompilerType();
1047             // If we have a specification, then the function type should
1048             // have been made with the specification and not with this
1049             // die.
1050             DWARFDIE spec_die = attrs.specification.Reference();
1051             clang::DeclContext *spec_clang_decl_ctx =
1052                 GetClangDeclContextForDIE(spec_die);
1053             if (spec_clang_decl_ctx) {
1054               LinkDeclContextToDIE(spec_clang_decl_ctx, die);
1055             } else {
1056               dwarf->GetObjectFile()->GetModule()->ReportWarning(
1057                   "0x%8.8" PRIx64 ": DW_AT_specification(0x%8.8x"
1058                   ") has no decl\n",
1059                   die.GetID(), spec_die.GetOffset());
1060             }
1061             type_handled = true;
1062           } else if (attrs.abstract_origin.IsValid()) {
1063             // We have a specification which we are going to base our
1064             // function prototype off of, so we need this type to be
1065             // completed so that the m_die_to_decl_ctx for the method in
1066             // the abstract origin has a valid clang decl context.
1067             class_type->GetForwardCompilerType();
1068 
1069             DWARFDIE abs_die = attrs.abstract_origin.Reference();
1070             clang::DeclContext *abs_clang_decl_ctx =
1071                 GetClangDeclContextForDIE(abs_die);
1072             if (abs_clang_decl_ctx) {
1073               LinkDeclContextToDIE(abs_clang_decl_ctx, die);
1074             } else {
1075               dwarf->GetObjectFile()->GetModule()->ReportWarning(
1076                   "0x%8.8" PRIx64 ": DW_AT_abstract_origin(0x%8.8x"
1077                   ") has no decl\n",
1078                   die.GetID(), abs_die.GetOffset());
1079             }
1080             type_handled = true;
1081           } else {
1082             CompilerType class_opaque_type =
1083                 class_type->GetForwardCompilerType();
1084             if (TypeSystemClang::IsCXXClassType(class_opaque_type)) {
1085               if (class_opaque_type.IsBeingDefined() || alternate_defn) {
1086                 if (!is_static && !die.HasChildren()) {
1087                   // We have a C++ member function with no children (this
1088                   // pointer!) and clang will get mad if we try and make
1089                   // a function that isn't well formed in the DWARF, so
1090                   // we will just skip it...
1091                   type_handled = true;
1092                 } else {
1093                   bool add_method = true;
1094                   if (alternate_defn) {
1095                     // If an alternate definition for the class exists,
1096                     // then add the method only if an equivalent is not
1097                     // already present.
1098                     clang::CXXRecordDecl *record_decl =
1099                         m_ast.GetAsCXXRecordDecl(
1100                             class_opaque_type.GetOpaqueQualType());
1101                     if (record_decl) {
1102                       for (auto method_iter = record_decl->method_begin();
1103                            method_iter != record_decl->method_end();
1104                            method_iter++) {
1105                         clang::CXXMethodDecl *method_decl = *method_iter;
1106                         if (method_decl->getNameInfo().getAsString() ==
1107                             attrs.name.GetStringRef()) {
1108                           if (method_decl->getType() ==
1109                               ClangUtil::GetQualType(clang_type)) {
1110                             add_method = false;
1111                             LinkDeclContextToDIE(method_decl, die);
1112                             type_handled = true;
1113 
1114                             break;
1115                           }
1116                         }
1117                       }
1118                     }
1119                   }
1120 
1121                   if (add_method) {
1122                     llvm::PrettyStackTraceFormat stack_trace(
1123                         "SymbolFileDWARF::ParseType() is adding a method "
1124                         "%s to class %s in DIE 0x%8.8" PRIx64 " from %s",
1125                         attrs.name.GetCString(),
1126                         class_type->GetName().GetCString(), die.GetID(),
1127                         dwarf->GetObjectFile()
1128                             ->GetFileSpec()
1129                             .GetPath()
1130                             .c_str());
1131 
1132                     const bool is_attr_used = false;
1133                     // Neither GCC 4.2 nor clang++ currently set a valid
1134                     // accessibility in the DWARF for C++ methods...
1135                     // Default to public for now...
1136                     if (attrs.accessibility == eAccessNone)
1137                       attrs.accessibility = eAccessPublic;
1138 
1139                     clang::CXXMethodDecl *cxx_method_decl =
1140                         m_ast.AddMethodToCXXRecordType(
1141                             class_opaque_type.GetOpaqueQualType(),
1142                             attrs.name.GetCString(), attrs.mangled_name,
1143                             clang_type, attrs.accessibility, attrs.is_virtual,
1144                             is_static, attrs.is_inline, attrs.is_explicit,
1145                             is_attr_used, attrs.is_artificial);
1146 
1147                     type_handled = cxx_method_decl != NULL;
1148                     // Artificial methods are always handled even when we
1149                     // don't create a new declaration for them.
1150                     type_handled |= attrs.is_artificial;
1151 
1152                     if (cxx_method_decl) {
1153                       LinkDeclContextToDIE(cxx_method_decl, die);
1154 
1155                       ClangASTMetadata metadata;
1156                       metadata.SetUserID(die.GetID());
1157 
1158                       if (!object_pointer_name.empty()) {
1159                         metadata.SetObjectPtrName(
1160                             object_pointer_name.c_str());
1161                         LLDB_LOGF(log,
1162                                   "Setting object pointer name: %s on method "
1163                                   "object %p.\n",
1164                                   object_pointer_name.c_str(),
1165                                   static_cast<void *>(cxx_method_decl));
1166                       }
1167                       m_ast.SetMetadata(cxx_method_decl, metadata);
1168                     } else {
1169                       ignore_containing_context = true;
1170                     }
1171                   }
1172                 }
1173               } else {
1174                 // We were asked to parse the type for a method in a
1175                 // class, yet the class hasn't been asked to complete
1176                 // itself through the clang::ExternalASTSource protocol,
1177                 // so we need to just have the class complete itself and
1178                 // do things the right way, then our
1179                 // DIE should then have an entry in the
1180                 // dwarf->GetDIEToType() map. First
1181                 // we need to modify the dwarf->GetDIEToType() so it
1182                 // doesn't think we are trying to parse this DIE
1183                 // anymore...
1184                 dwarf->GetDIEToType()[die.GetDIE()] = NULL;
1185 
1186                 // Now we get the full type to force our class type to
1187                 // complete itself using the clang::ExternalASTSource
1188                 // protocol which will parse all base classes and all
1189                 // methods (including the method for this DIE).
1190                 class_type->GetFullCompilerType();
1191 
1192                 // The type for this DIE should have been filled in the
1193                 // function call above
1194                 Type *type_ptr = dwarf->GetDIEToType()[die.GetDIE()];
1195                 if (type_ptr && type_ptr != DIE_IS_BEING_PARSED) {
1196                   return type_ptr->shared_from_this();
1197                 }
1198 
1199                 // FIXME This is fixing some even uglier behavior but we
1200                 // really need to
1201                 // uniq the methods of each class as well as the class
1202                 // itself. <rdar://problem/11240464>
1203                 type_handled = true;
1204               }
1205             }
1206           }
1207         }
1208       }
1209     }
1210 
1211     if (!type_handled) {
1212       clang::FunctionDecl *function_decl = nullptr;
1213       clang::FunctionDecl *template_function_decl = nullptr;
1214 
1215       if (attrs.abstract_origin.IsValid()) {
1216         DWARFDIE abs_die = attrs.abstract_origin.Reference();
1217 
1218         if (dwarf->ResolveType(abs_die)) {
1219           function_decl = llvm::dyn_cast_or_null<clang::FunctionDecl>(
1220               GetCachedClangDeclContextForDIE(abs_die));
1221 
1222           if (function_decl) {
1223             LinkDeclContextToDIE(function_decl, die);
1224           }
1225         }
1226       }
1227 
1228       if (!function_decl) {
1229         llvm::StringRef name = attrs.name.GetStringRef();
1230 
1231         // We currently generate function templates with template parameters in
1232         // their name. In order to get closer to the AST that clang generates
1233         // we want to strip these from the name when creating the AST.
1234         if (attrs.mangled_name) {
1235           llvm::ItaniumPartialDemangler D;
1236           if (!D.partialDemangle(attrs.mangled_name))
1237             name = D.getFunctionBaseName(nullptr, nullptr);
1238         }
1239 
1240         // We just have a function that isn't part of a class
1241         function_decl = m_ast.CreateFunctionDeclaration(
1242             ignore_containing_context ? m_ast.GetTranslationUnitDecl()
1243                                       : containing_decl_ctx,
1244             GetOwningClangModule(die), name, clang_type, attrs.storage,
1245             attrs.is_inline);
1246 
1247         if (has_template_params) {
1248           TypeSystemClang::TemplateParameterInfos template_param_infos;
1249           ParseTemplateParameterInfos(die, template_param_infos);
1250           template_function_decl = m_ast.CreateFunctionDeclaration(
1251               ignore_containing_context ? m_ast.GetTranslationUnitDecl()
1252                                         : containing_decl_ctx,
1253               GetOwningClangModule(die), attrs.name.GetStringRef(), clang_type,
1254               attrs.storage, attrs.is_inline);
1255           clang::FunctionTemplateDecl *func_template_decl =
1256               m_ast.CreateFunctionTemplateDecl(
1257                   containing_decl_ctx, GetOwningClangModule(die),
1258                   template_function_decl, template_param_infos);
1259           m_ast.CreateFunctionTemplateSpecializationInfo(
1260               template_function_decl, func_template_decl, template_param_infos);
1261         }
1262 
1263         lldbassert(function_decl);
1264 
1265         if (function_decl) {
1266           LinkDeclContextToDIE(function_decl, die);
1267 
1268           if (!function_param_decls.empty()) {
1269             m_ast.SetFunctionParameters(function_decl,
1270                                         &function_param_decls.front(),
1271                                         function_param_decls.size());
1272             if (template_function_decl)
1273               m_ast.SetFunctionParameters(template_function_decl,
1274                                           &function_param_decls.front(),
1275                                           function_param_decls.size());
1276           }
1277 
1278           ClangASTMetadata metadata;
1279           metadata.SetUserID(die.GetID());
1280 
1281           if (!object_pointer_name.empty()) {
1282             metadata.SetObjectPtrName(object_pointer_name.c_str());
1283             LLDB_LOGF(log,
1284                       "Setting object pointer name: %s on function "
1285                       "object %p.",
1286                       object_pointer_name.c_str(),
1287                       static_cast<void *>(function_decl));
1288           }
1289           m_ast.SetMetadata(function_decl, metadata);
1290         }
1291       }
1292     }
1293   }
1294   return std::make_shared<Type>(
1295       die.GetID(), dwarf, attrs.name, llvm::None, nullptr, LLDB_INVALID_UID,
1296       Type::eEncodingIsUID, &attrs.decl, clang_type, Type::ResolveState::Full);
1297 }
1298 
ParseArrayType(const DWARFDIE & die,ParsedDWARFTypeAttributes & attrs)1299 TypeSP DWARFASTParserClang::ParseArrayType(const DWARFDIE &die,
1300                                            ParsedDWARFTypeAttributes &attrs) {
1301   SymbolFileDWARF *dwarf = die.GetDWARF();
1302 
1303   DEBUG_PRINTF("0x%8.8" PRIx64 ": %s (\"%s\")\n", die.GetID(),
1304                DW_TAG_value_to_name(tag), type_name_cstr);
1305 
1306   DWARFDIE type_die = attrs.type.Reference();
1307   Type *element_type = dwarf->ResolveTypeUID(type_die, true);
1308 
1309   if (!element_type)
1310     return nullptr;
1311 
1312   llvm::Optional<SymbolFile::ArrayInfo> array_info = ParseChildArrayInfo(die);
1313   if (array_info) {
1314     attrs.byte_stride = array_info->byte_stride;
1315     attrs.bit_stride = array_info->bit_stride;
1316   }
1317   if (attrs.byte_stride == 0 && attrs.bit_stride == 0)
1318     attrs.byte_stride = element_type->GetByteSize(nullptr).getValueOr(0);
1319   CompilerType array_element_type = element_type->GetForwardCompilerType();
1320   RequireCompleteType(array_element_type);
1321 
1322   uint64_t array_element_bit_stride =
1323       attrs.byte_stride * 8 + attrs.bit_stride;
1324   CompilerType clang_type;
1325   if (array_info && array_info->element_orders.size() > 0) {
1326     uint64_t num_elements = 0;
1327     auto end = array_info->element_orders.rend();
1328     for (auto pos = array_info->element_orders.rbegin(); pos != end; ++pos) {
1329       num_elements = *pos;
1330       clang_type = m_ast.CreateArrayType(array_element_type, num_elements,
1331                                          attrs.is_vector);
1332       array_element_type = clang_type;
1333       array_element_bit_stride = num_elements
1334                                      ? array_element_bit_stride * num_elements
1335                                      : array_element_bit_stride;
1336     }
1337   } else {
1338     clang_type =
1339         m_ast.CreateArrayType(array_element_type, 0, attrs.is_vector);
1340   }
1341   ConstString empty_name;
1342   TypeSP type_sp = std::make_shared<Type>(
1343       die.GetID(), dwarf, empty_name, array_element_bit_stride / 8, nullptr,
1344       dwarf->GetUID(type_die), Type::eEncodingIsUID, &attrs.decl, clang_type,
1345       Type::ResolveState::Full);
1346   type_sp->SetEncodingType(element_type);
1347   const clang::Type *type = ClangUtil::GetQualType(clang_type).getTypePtr();
1348   m_ast.SetMetadataAsUserID(type, die.GetID());
1349   return type_sp;
1350 }
1351 
ParsePointerToMemberType(const DWARFDIE & die,const ParsedDWARFTypeAttributes & attrs)1352 TypeSP DWARFASTParserClang::ParsePointerToMemberType(
1353     const DWARFDIE &die, const ParsedDWARFTypeAttributes &attrs) {
1354   SymbolFileDWARF *dwarf = die.GetDWARF();
1355   Type *pointee_type = dwarf->ResolveTypeUID(attrs.type.Reference(), true);
1356   Type *class_type =
1357       dwarf->ResolveTypeUID(attrs.containing_type.Reference(), true);
1358 
1359   CompilerType pointee_clang_type = pointee_type->GetForwardCompilerType();
1360   CompilerType class_clang_type = class_type->GetLayoutCompilerType();
1361 
1362   CompilerType clang_type = TypeSystemClang::CreateMemberPointerType(
1363       class_clang_type, pointee_clang_type);
1364 
1365   if (llvm::Optional<uint64_t> clang_type_size =
1366           clang_type.GetByteSize(nullptr)) {
1367     return std::make_shared<Type>(die.GetID(), dwarf, attrs.name,
1368                                   *clang_type_size, nullptr, LLDB_INVALID_UID,
1369                                   Type::eEncodingIsUID, nullptr, clang_type,
1370                                   Type::ResolveState::Forward);
1371   }
1372   return nullptr;
1373 }
1374 
UpdateSymbolContextScopeForType(const SymbolContext & sc,const DWARFDIE & die,TypeSP type_sp)1375 TypeSP DWARFASTParserClang::UpdateSymbolContextScopeForType(
1376     const SymbolContext &sc, const DWARFDIE &die, TypeSP type_sp) {
1377   if (!type_sp)
1378     return type_sp;
1379 
1380   SymbolFileDWARF *dwarf = die.GetDWARF();
1381   TypeList &type_list = dwarf->GetTypeList();
1382   DWARFDIE sc_parent_die = SymbolFileDWARF::GetParentSymbolContextDIE(die);
1383   dw_tag_t sc_parent_tag = sc_parent_die.Tag();
1384 
1385   SymbolContextScope *symbol_context_scope = nullptr;
1386   if (sc_parent_tag == DW_TAG_compile_unit ||
1387       sc_parent_tag == DW_TAG_partial_unit) {
1388     symbol_context_scope = sc.comp_unit;
1389   } else if (sc.function != nullptr && sc_parent_die) {
1390     symbol_context_scope =
1391         sc.function->GetBlock(true).FindBlockByID(sc_parent_die.GetID());
1392     if (symbol_context_scope == nullptr)
1393       symbol_context_scope = sc.function;
1394   } else {
1395     symbol_context_scope = sc.module_sp.get();
1396   }
1397 
1398   if (symbol_context_scope != nullptr)
1399     type_sp->SetSymbolContextScope(symbol_context_scope);
1400 
1401   // We are ready to put this type into the uniqued list up at the module
1402   // level.
1403   type_list.Insert(type_sp);
1404 
1405   dwarf->GetDIEToType()[die.GetDIE()] = type_sp.get();
1406   return type_sp;
1407 }
1408 
1409 TypeSP
ParseStructureLikeDIE(const SymbolContext & sc,const DWARFDIE & die,ParsedDWARFTypeAttributes & attrs)1410 DWARFASTParserClang::ParseStructureLikeDIE(const SymbolContext &sc,
1411                                            const DWARFDIE &die,
1412                                            ParsedDWARFTypeAttributes &attrs) {
1413   TypeSP type_sp;
1414   CompilerType clang_type;
1415   const dw_tag_t tag = die.Tag();
1416   SymbolFileDWARF *dwarf = die.GetDWARF();
1417   LanguageType cu_language = SymbolFileDWARF::GetLanguage(*die.GetCU());
1418   Log *log = LogChannelDWARF::GetLogIfAll(DWARF_LOG_TYPE_COMPLETION |
1419                                           DWARF_LOG_LOOKUPS);
1420 
1421   // UniqueDWARFASTType is large, so don't create a local variables on the
1422   // stack, put it on the heap. This function is often called recursively and
1423   // clang isn't good at sharing the stack space for variables in different
1424   // blocks.
1425   auto unique_ast_entry_up = std::make_unique<UniqueDWARFASTType>();
1426 
1427   ConstString unique_typename(attrs.name);
1428   Declaration unique_decl(attrs.decl);
1429 
1430   if (attrs.name) {
1431     if (Language::LanguageIsCPlusPlus(cu_language)) {
1432       // For C++, we rely solely upon the one definition rule that says
1433       // only one thing can exist at a given decl context. We ignore the
1434       // file and line that things are declared on.
1435       std::string qualified_name;
1436       if (die.GetQualifiedName(qualified_name))
1437         unique_typename = ConstString(qualified_name);
1438       unique_decl.Clear();
1439     }
1440 
1441     if (dwarf->GetUniqueDWARFASTTypeMap().Find(
1442             unique_typename, die, unique_decl, attrs.byte_size.getValueOr(-1),
1443             *unique_ast_entry_up)) {
1444       type_sp = unique_ast_entry_up->m_type_sp;
1445       if (type_sp) {
1446         dwarf->GetDIEToType()[die.GetDIE()] = type_sp.get();
1447         LinkDeclContextToDIE(
1448             GetCachedClangDeclContextForDIE(unique_ast_entry_up->m_die), die);
1449         return type_sp;
1450       }
1451     }
1452   }
1453 
1454   DEBUG_PRINTF("0x%8.8" PRIx64 ": %s (\"%s\")\n", die.GetID(),
1455                DW_TAG_value_to_name(tag), type_name_cstr);
1456 
1457   int tag_decl_kind = -1;
1458   AccessType default_accessibility = eAccessNone;
1459   if (tag == DW_TAG_structure_type) {
1460     tag_decl_kind = clang::TTK_Struct;
1461     default_accessibility = eAccessPublic;
1462   } else if (tag == DW_TAG_union_type) {
1463     tag_decl_kind = clang::TTK_Union;
1464     default_accessibility = eAccessPublic;
1465   } else if (tag == DW_TAG_class_type) {
1466     tag_decl_kind = clang::TTK_Class;
1467     default_accessibility = eAccessPrivate;
1468   }
1469 
1470   if (attrs.byte_size && *attrs.byte_size == 0 && attrs.name &&
1471       !die.HasChildren() && cu_language == eLanguageTypeObjC) {
1472     // Work around an issue with clang at the moment where forward
1473     // declarations for objective C classes are emitted as:
1474     //  DW_TAG_structure_type [2]
1475     //  DW_AT_name( "ForwardObjcClass" )
1476     //  DW_AT_byte_size( 0x00 )
1477     //  DW_AT_decl_file( "..." )
1478     //  DW_AT_decl_line( 1 )
1479     //
1480     // Note that there is no DW_AT_declaration and there are no children,
1481     // and the byte size is zero.
1482     attrs.is_forward_declaration = true;
1483   }
1484 
1485   if (attrs.class_language == eLanguageTypeObjC ||
1486       attrs.class_language == eLanguageTypeObjC_plus_plus) {
1487     if (!attrs.is_complete_objc_class &&
1488         die.Supports_DW_AT_APPLE_objc_complete_type()) {
1489       // We have a valid eSymbolTypeObjCClass class symbol whose name
1490       // matches the current objective C class that we are trying to find
1491       // and this DIE isn't the complete definition (we checked
1492       // is_complete_objc_class above and know it is false), so the real
1493       // definition is in here somewhere
1494       type_sp =
1495           dwarf->FindCompleteObjCDefinitionTypeForDIE(die, attrs.name, true);
1496 
1497       if (!type_sp) {
1498         SymbolFileDWARFDebugMap *debug_map_symfile =
1499             dwarf->GetDebugMapSymfile();
1500         if (debug_map_symfile) {
1501           // We weren't able to find a full declaration in this DWARF,
1502           // see if we have a declaration anywhere else...
1503           type_sp = debug_map_symfile->FindCompleteObjCDefinitionTypeForDIE(
1504               die, attrs.name, true);
1505         }
1506       }
1507 
1508       if (type_sp) {
1509         if (log) {
1510           dwarf->GetObjectFile()->GetModule()->LogMessage(
1511               log,
1512               "SymbolFileDWARF(%p) - 0x%8.8x: %s type \"%s\" is an "
1513               "incomplete objc type, complete type is 0x%8.8" PRIx64,
1514               static_cast<void *>(this), die.GetOffset(),
1515               DW_TAG_value_to_name(tag), attrs.name.GetCString(),
1516               type_sp->GetID());
1517         }
1518 
1519         // We found a real definition for this type elsewhere so lets use
1520         // it and cache the fact that we found a complete type for this
1521         // die
1522         dwarf->GetDIEToType()[die.GetDIE()] = type_sp.get();
1523         return type_sp;
1524       }
1525     }
1526   }
1527 
1528   if (attrs.is_forward_declaration) {
1529     // We have a forward declaration to a type and we need to try and
1530     // find a full declaration. We look in the current type index just in
1531     // case we have a forward declaration followed by an actual
1532     // declarations in the DWARF. If this fails, we need to look
1533     // elsewhere...
1534     if (log) {
1535       dwarf->GetObjectFile()->GetModule()->LogMessage(
1536           log,
1537           "SymbolFileDWARF(%p) - 0x%8.8x: %s type \"%s\" is a "
1538           "forward declaration, trying to find complete type",
1539           static_cast<void *>(this), die.GetOffset(), DW_TAG_value_to_name(tag),
1540           attrs.name.GetCString());
1541     }
1542 
1543     // See if the type comes from a Clang module and if so, track down
1544     // that type.
1545     type_sp = ParseTypeFromClangModule(sc, die, log);
1546     if (type_sp)
1547       return type_sp;
1548 
1549     DWARFDeclContext die_decl_ctx = SymbolFileDWARF::GetDWARFDeclContext(die);
1550 
1551     // type_sp = FindDefinitionTypeForDIE (dwarf_cu, die,
1552     // type_name_const_str);
1553     type_sp = dwarf->FindDefinitionTypeForDWARFDeclContext(die_decl_ctx);
1554 
1555     if (!type_sp) {
1556       SymbolFileDWARFDebugMap *debug_map_symfile = dwarf->GetDebugMapSymfile();
1557       if (debug_map_symfile) {
1558         // We weren't able to find a full declaration in this DWARF, see
1559         // if we have a declaration anywhere else...
1560         type_sp = debug_map_symfile->FindDefinitionTypeForDWARFDeclContext(
1561             die_decl_ctx);
1562       }
1563     }
1564 
1565     if (type_sp) {
1566       if (log) {
1567         dwarf->GetObjectFile()->GetModule()->LogMessage(
1568             log,
1569             "SymbolFileDWARF(%p) - 0x%8.8x: %s type \"%s\" is a "
1570             "forward declaration, complete type is 0x%8.8" PRIx64,
1571             static_cast<void *>(this), die.GetOffset(),
1572             DW_TAG_value_to_name(tag), attrs.name.GetCString(),
1573             type_sp->GetID());
1574       }
1575 
1576       // We found a real definition for this type elsewhere so lets use
1577       // it and cache the fact that we found a complete type for this die
1578       dwarf->GetDIEToType()[die.GetDIE()] = type_sp.get();
1579       clang::DeclContext *defn_decl_ctx =
1580           GetCachedClangDeclContextForDIE(dwarf->GetDIE(type_sp->GetID()));
1581       if (defn_decl_ctx)
1582         LinkDeclContextToDIE(defn_decl_ctx, die);
1583       return type_sp;
1584     }
1585   }
1586   assert(tag_decl_kind != -1);
1587   bool clang_type_was_created = false;
1588   clang_type.SetCompilerType(
1589       &m_ast, dwarf->GetForwardDeclDieToClangType().lookup(die.GetDIE()));
1590   if (!clang_type) {
1591     clang::DeclContext *decl_ctx =
1592         GetClangDeclContextContainingDIE(die, nullptr);
1593 
1594     PrepareContextToReceiveMembers(m_ast, GetClangASTImporter(), decl_ctx, die,
1595                                    attrs.name.GetCString());
1596 
1597     if (attrs.accessibility == eAccessNone && decl_ctx) {
1598       // Check the decl context that contains this class/struct/union. If
1599       // it is a class we must give it an accessibility.
1600       const clang::Decl::Kind containing_decl_kind = decl_ctx->getDeclKind();
1601       if (DeclKindIsCXXClass(containing_decl_kind))
1602         attrs.accessibility = default_accessibility;
1603     }
1604 
1605     ClangASTMetadata metadata;
1606     metadata.SetUserID(die.GetID());
1607     metadata.SetIsDynamicCXXType(dwarf->ClassOrStructIsVirtual(die));
1608 
1609     if (attrs.name.GetStringRef().contains('<')) {
1610       TypeSystemClang::TemplateParameterInfos template_param_infos;
1611       if (ParseTemplateParameterInfos(die, template_param_infos)) {
1612         clang::ClassTemplateDecl *class_template_decl =
1613             m_ast.ParseClassTemplateDecl(
1614                 decl_ctx, GetOwningClangModule(die), attrs.accessibility,
1615                 attrs.name.GetCString(), tag_decl_kind, template_param_infos);
1616         if (!class_template_decl) {
1617           if (log) {
1618             dwarf->GetObjectFile()->GetModule()->LogMessage(
1619                 log,
1620                 "SymbolFileDWARF(%p) - 0x%8.8x: %s type \"%s\" "
1621                 "clang::ClassTemplateDecl failed to return a decl.",
1622                 static_cast<void *>(this), die.GetOffset(),
1623                 DW_TAG_value_to_name(tag), attrs.name.GetCString());
1624           }
1625           return TypeSP();
1626         }
1627 
1628         clang::ClassTemplateSpecializationDecl *class_specialization_decl =
1629             m_ast.CreateClassTemplateSpecializationDecl(
1630                 decl_ctx, GetOwningClangModule(die), class_template_decl,
1631                 tag_decl_kind, template_param_infos);
1632         clang_type = m_ast.CreateClassTemplateSpecializationType(
1633             class_specialization_decl);
1634         clang_type_was_created = true;
1635 
1636         m_ast.SetMetadata(class_template_decl, metadata);
1637         m_ast.SetMetadata(class_specialization_decl, metadata);
1638       }
1639     }
1640 
1641     if (!clang_type_was_created) {
1642       clang_type_was_created = true;
1643       clang_type = m_ast.CreateRecordType(
1644           decl_ctx, GetOwningClangModule(die), attrs.accessibility,
1645           attrs.name.GetCString(), tag_decl_kind, attrs.class_language,
1646           &metadata, attrs.exports_symbols);
1647     }
1648   }
1649 
1650   // Store a forward declaration to this class type in case any
1651   // parameters in any class methods need it for the clang types for
1652   // function prototypes.
1653   LinkDeclContextToDIE(m_ast.GetDeclContextForType(clang_type), die);
1654   type_sp = std::make_shared<Type>(
1655       die.GetID(), dwarf, attrs.name, attrs.byte_size, nullptr,
1656       LLDB_INVALID_UID, Type::eEncodingIsUID, &attrs.decl, clang_type,
1657       Type::ResolveState::Forward,
1658       TypePayloadClang(OptionalClangModuleID(), attrs.is_complete_objc_class));
1659 
1660   // Add our type to the unique type map so we don't end up creating many
1661   // copies of the same type over and over in the ASTContext for our
1662   // module
1663   unique_ast_entry_up->m_type_sp = type_sp;
1664   unique_ast_entry_up->m_die = die;
1665   unique_ast_entry_up->m_declaration = unique_decl;
1666   unique_ast_entry_up->m_byte_size = attrs.byte_size.getValueOr(0);
1667   dwarf->GetUniqueDWARFASTTypeMap().Insert(unique_typename,
1668                                            *unique_ast_entry_up);
1669 
1670   if (!attrs.is_forward_declaration) {
1671     // Always start the definition for a class type so that if the class
1672     // has child classes or types that require the class to be created
1673     // for use as their decl contexts the class will be ready to accept
1674     // these child definitions.
1675     if (!die.HasChildren()) {
1676       // No children for this struct/union/class, lets finish it
1677       if (TypeSystemClang::StartTagDeclarationDefinition(clang_type)) {
1678         TypeSystemClang::CompleteTagDeclarationDefinition(clang_type);
1679       } else {
1680         dwarf->GetObjectFile()->GetModule()->ReportError(
1681             "DWARF DIE at 0x%8.8x named \"%s\" was not able to start its "
1682             "definition.\nPlease file a bug and attach the file at the "
1683             "start of this error message",
1684             die.GetOffset(), attrs.name.GetCString());
1685       }
1686 
1687       if (tag == DW_TAG_structure_type) // this only applies in C
1688       {
1689         clang::RecordDecl *record_decl =
1690             TypeSystemClang::GetAsRecordDecl(clang_type);
1691 
1692         if (record_decl) {
1693           GetClangASTImporter().SetRecordLayout(
1694               record_decl, ClangASTImporter::LayoutInfo());
1695         }
1696       }
1697     } else if (clang_type_was_created) {
1698       // Start the definition if the class is not objective C since the
1699       // underlying decls respond to isCompleteDefinition(). Objective
1700       // C decls don't respond to isCompleteDefinition() so we can't
1701       // start the declaration definition right away. For C++
1702       // class/union/structs we want to start the definition in case the
1703       // class is needed as the declaration context for a contained class
1704       // or type without the need to complete that type..
1705 
1706       if (attrs.class_language != eLanguageTypeObjC &&
1707           attrs.class_language != eLanguageTypeObjC_plus_plus)
1708         TypeSystemClang::StartTagDeclarationDefinition(clang_type);
1709 
1710       // Leave this as a forward declaration until we need to know the
1711       // details of the type. lldb_private::Type will automatically call
1712       // the SymbolFile virtual function
1713       // "SymbolFileDWARF::CompleteType(Type *)" When the definition
1714       // needs to be defined.
1715       assert(!dwarf->GetForwardDeclClangTypeToDie().count(
1716                  ClangUtil::RemoveFastQualifiers(clang_type)
1717                      .GetOpaqueQualType()) &&
1718              "Type already in the forward declaration map!");
1719       // Can't assume m_ast.GetSymbolFile() is actually a
1720       // SymbolFileDWARF, it can be a SymbolFileDWARFDebugMap for Apple
1721       // binaries.
1722       dwarf->GetForwardDeclDieToClangType()[die.GetDIE()] =
1723           clang_type.GetOpaqueQualType();
1724       dwarf->GetForwardDeclClangTypeToDie().try_emplace(
1725           ClangUtil::RemoveFastQualifiers(clang_type).GetOpaqueQualType(),
1726           *die.GetDIERef());
1727       m_ast.SetHasExternalStorage(clang_type.GetOpaqueQualType(), true);
1728     }
1729   }
1730 
1731   // If we made a clang type, set the trivial abi if applicable: We only
1732   // do this for pass by value - which implies the Trivial ABI. There
1733   // isn't a way to assert that something that would normally be pass by
1734   // value is pass by reference, so we ignore that attribute if set.
1735   if (attrs.calling_convention == llvm::dwarf::DW_CC_pass_by_value) {
1736     clang::CXXRecordDecl *record_decl =
1737         m_ast.GetAsCXXRecordDecl(clang_type.GetOpaqueQualType());
1738     if (record_decl && record_decl->getDefinition()) {
1739       record_decl->setHasTrivialSpecialMemberForCall();
1740     }
1741   }
1742 
1743   if (attrs.calling_convention == llvm::dwarf::DW_CC_pass_by_reference) {
1744     clang::CXXRecordDecl *record_decl =
1745         m_ast.GetAsCXXRecordDecl(clang_type.GetOpaqueQualType());
1746     if (record_decl)
1747       record_decl->setArgPassingRestrictions(
1748           clang::RecordDecl::APK_CannotPassInRegs);
1749   }
1750   return type_sp;
1751 }
1752 
1753 // DWARF parsing functions
1754 
1755 class DWARFASTParserClang::DelayedAddObjCClassProperty {
1756 public:
DelayedAddObjCClassProperty(const CompilerType & class_opaque_type,const char * property_name,const CompilerType & property_opaque_type,clang::ObjCIvarDecl * ivar_decl,const char * property_setter_name,const char * property_getter_name,uint32_t property_attributes,const ClangASTMetadata * metadata)1757   DelayedAddObjCClassProperty(
1758       const CompilerType &class_opaque_type, const char *property_name,
1759       const CompilerType &property_opaque_type, // The property type is only
1760                                                 // required if you don't have an
1761                                                 // ivar decl
1762       clang::ObjCIvarDecl *ivar_decl, const char *property_setter_name,
1763       const char *property_getter_name, uint32_t property_attributes,
1764       const ClangASTMetadata *metadata)
1765       : m_class_opaque_type(class_opaque_type), m_property_name(property_name),
1766         m_property_opaque_type(property_opaque_type), m_ivar_decl(ivar_decl),
1767         m_property_setter_name(property_setter_name),
1768         m_property_getter_name(property_getter_name),
1769         m_property_attributes(property_attributes) {
1770     if (metadata != nullptr) {
1771       m_metadata_up = std::make_unique<ClangASTMetadata>();
1772       *m_metadata_up = *metadata;
1773     }
1774   }
1775 
DelayedAddObjCClassProperty(const DelayedAddObjCClassProperty & rhs)1776   DelayedAddObjCClassProperty(const DelayedAddObjCClassProperty &rhs) {
1777     *this = rhs;
1778   }
1779 
1780   DelayedAddObjCClassProperty &
operator =(const DelayedAddObjCClassProperty & rhs)1781   operator=(const DelayedAddObjCClassProperty &rhs) {
1782     m_class_opaque_type = rhs.m_class_opaque_type;
1783     m_property_name = rhs.m_property_name;
1784     m_property_opaque_type = rhs.m_property_opaque_type;
1785     m_ivar_decl = rhs.m_ivar_decl;
1786     m_property_setter_name = rhs.m_property_setter_name;
1787     m_property_getter_name = rhs.m_property_getter_name;
1788     m_property_attributes = rhs.m_property_attributes;
1789 
1790     if (rhs.m_metadata_up) {
1791       m_metadata_up = std::make_unique<ClangASTMetadata>();
1792       *m_metadata_up = *rhs.m_metadata_up;
1793     }
1794     return *this;
1795   }
1796 
Finalize()1797   bool Finalize() {
1798     return TypeSystemClang::AddObjCClassProperty(
1799         m_class_opaque_type, m_property_name, m_property_opaque_type,
1800         m_ivar_decl, m_property_setter_name, m_property_getter_name,
1801         m_property_attributes, m_metadata_up.get());
1802   }
1803 
1804 private:
1805   CompilerType m_class_opaque_type;
1806   const char *m_property_name;
1807   CompilerType m_property_opaque_type;
1808   clang::ObjCIvarDecl *m_ivar_decl;
1809   const char *m_property_setter_name;
1810   const char *m_property_getter_name;
1811   uint32_t m_property_attributes;
1812   std::unique_ptr<ClangASTMetadata> m_metadata_up;
1813 };
1814 
ParseTemplateDIE(const DWARFDIE & die,TypeSystemClang::TemplateParameterInfos & template_param_infos)1815 bool DWARFASTParserClang::ParseTemplateDIE(
1816     const DWARFDIE &die,
1817     TypeSystemClang::TemplateParameterInfos &template_param_infos) {
1818   const dw_tag_t tag = die.Tag();
1819   bool is_template_template_argument = false;
1820 
1821   switch (tag) {
1822   case DW_TAG_GNU_template_parameter_pack: {
1823     template_param_infos.packed_args =
1824         std::make_unique<TypeSystemClang::TemplateParameterInfos>();
1825     for (DWARFDIE child_die = die.GetFirstChild(); child_die.IsValid();
1826          child_die = child_die.GetSibling()) {
1827       if (!ParseTemplateDIE(child_die, *template_param_infos.packed_args))
1828         return false;
1829     }
1830     if (const char *name = die.GetName()) {
1831       template_param_infos.pack_name = name;
1832     }
1833     return true;
1834   }
1835   case DW_TAG_GNU_template_template_param:
1836     is_template_template_argument = true;
1837     LLVM_FALLTHROUGH;
1838   case DW_TAG_template_type_parameter:
1839   case DW_TAG_template_value_parameter: {
1840     DWARFAttributes attributes;
1841     const size_t num_attributes = die.GetAttributes(attributes);
1842     const char *name = nullptr;
1843     const char *template_name = nullptr;
1844     CompilerType clang_type;
1845     uint64_t uval64 = 0;
1846     bool uval64_valid = false;
1847     if (num_attributes > 0) {
1848       DWARFFormValue form_value;
1849       for (size_t i = 0; i < num_attributes; ++i) {
1850         const dw_attr_t attr = attributes.AttributeAtIndex(i);
1851 
1852         switch (attr) {
1853         case DW_AT_name:
1854           if (attributes.ExtractFormValueAtIndex(i, form_value))
1855             name = form_value.AsCString();
1856           break;
1857 
1858         case DW_AT_GNU_template_name:
1859           if (attributes.ExtractFormValueAtIndex(i, form_value))
1860             template_name = form_value.AsCString();
1861           break;
1862 
1863         case DW_AT_type:
1864           if (attributes.ExtractFormValueAtIndex(i, form_value)) {
1865             Type *lldb_type = die.ResolveTypeUID(form_value.Reference());
1866             if (lldb_type)
1867               clang_type = lldb_type->GetForwardCompilerType();
1868           }
1869           break;
1870 
1871         case DW_AT_const_value:
1872           if (attributes.ExtractFormValueAtIndex(i, form_value)) {
1873             uval64_valid = true;
1874             uval64 = form_value.Unsigned();
1875           }
1876           break;
1877         default:
1878           break;
1879         }
1880       }
1881 
1882       clang::ASTContext &ast = m_ast.getASTContext();
1883       if (!clang_type)
1884         clang_type = m_ast.GetBasicType(eBasicTypeVoid);
1885 
1886       if (!is_template_template_argument) {
1887         bool is_signed = false;
1888         if (name && name[0])
1889           template_param_infos.names.push_back(name);
1890         else
1891           template_param_infos.names.push_back(NULL);
1892 
1893         // Get the signed value for any integer or enumeration if available
1894         clang_type.IsIntegerOrEnumerationType(is_signed);
1895 
1896         if (tag == DW_TAG_template_value_parameter && uval64_valid) {
1897           llvm::Optional<uint64_t> size = clang_type.GetBitSize(nullptr);
1898           if (!size)
1899             return false;
1900           llvm::APInt apint(*size, uval64, is_signed);
1901           template_param_infos.args.push_back(
1902               clang::TemplateArgument(ast, llvm::APSInt(apint, !is_signed),
1903                                       ClangUtil::GetQualType(clang_type)));
1904         } else {
1905           template_param_infos.args.push_back(
1906               clang::TemplateArgument(ClangUtil::GetQualType(clang_type)));
1907         }
1908       } else {
1909         auto *tplt_type = m_ast.CreateTemplateTemplateParmDecl(template_name);
1910         template_param_infos.names.push_back(name);
1911         template_param_infos.args.push_back(
1912             clang::TemplateArgument(clang::TemplateName(tplt_type)));
1913       }
1914     }
1915   }
1916     return true;
1917 
1918   default:
1919     break;
1920   }
1921   return false;
1922 }
1923 
ParseTemplateParameterInfos(const DWARFDIE & parent_die,TypeSystemClang::TemplateParameterInfos & template_param_infos)1924 bool DWARFASTParserClang::ParseTemplateParameterInfos(
1925     const DWARFDIE &parent_die,
1926     TypeSystemClang::TemplateParameterInfos &template_param_infos) {
1927 
1928   if (!parent_die)
1929     return false;
1930 
1931   for (DWARFDIE die = parent_die.GetFirstChild(); die.IsValid();
1932        die = die.GetSibling()) {
1933     const dw_tag_t tag = die.Tag();
1934 
1935     switch (tag) {
1936     case DW_TAG_template_type_parameter:
1937     case DW_TAG_template_value_parameter:
1938     case DW_TAG_GNU_template_parameter_pack:
1939     case DW_TAG_GNU_template_template_param:
1940       ParseTemplateDIE(die, template_param_infos);
1941       break;
1942 
1943     default:
1944       break;
1945     }
1946   }
1947   return template_param_infos.args.size() == template_param_infos.names.size();
1948 }
1949 
CompleteRecordType(const DWARFDIE & die,lldb_private::Type * type,CompilerType & clang_type)1950 bool DWARFASTParserClang::CompleteRecordType(const DWARFDIE &die,
1951                                              lldb_private::Type *type,
1952                                              CompilerType &clang_type) {
1953   const dw_tag_t tag = die.Tag();
1954   SymbolFileDWARF *dwarf = die.GetDWARF();
1955 
1956   ClangASTImporter::LayoutInfo layout_info;
1957 
1958   if (die.HasChildren()) {
1959     const bool type_is_objc_object_or_interface =
1960         TypeSystemClang::IsObjCObjectOrInterfaceType(clang_type);
1961     if (type_is_objc_object_or_interface) {
1962       // For objective C we don't start the definition when the class is
1963       // created.
1964       TypeSystemClang::StartTagDeclarationDefinition(clang_type);
1965     }
1966 
1967     int tag_decl_kind = -1;
1968     AccessType default_accessibility = eAccessNone;
1969     if (tag == DW_TAG_structure_type) {
1970       tag_decl_kind = clang::TTK_Struct;
1971       default_accessibility = eAccessPublic;
1972     } else if (tag == DW_TAG_union_type) {
1973       tag_decl_kind = clang::TTK_Union;
1974       default_accessibility = eAccessPublic;
1975     } else if (tag == DW_TAG_class_type) {
1976       tag_decl_kind = clang::TTK_Class;
1977       default_accessibility = eAccessPrivate;
1978     }
1979 
1980     std::vector<std::unique_ptr<clang::CXXBaseSpecifier>> bases;
1981     std::vector<int> member_accessibilities;
1982     bool is_a_class = false;
1983     // Parse members and base classes first
1984     std::vector<DWARFDIE> member_function_dies;
1985 
1986     DelayedPropertyList delayed_properties;
1987     ParseChildMembers(die, clang_type, bases, member_accessibilities,
1988                       member_function_dies, delayed_properties,
1989                       default_accessibility, is_a_class, layout_info);
1990 
1991     // Now parse any methods if there were any...
1992     for (const DWARFDIE &die : member_function_dies)
1993       dwarf->ResolveType(die);
1994 
1995     if (type_is_objc_object_or_interface) {
1996       ConstString class_name(clang_type.GetTypeName());
1997       if (class_name) {
1998         dwarf->GetObjCMethods(class_name, [&](DWARFDIE method_die) {
1999           method_die.ResolveType();
2000           return true;
2001         });
2002 
2003         for (DelayedPropertyList::iterator pi = delayed_properties.begin(),
2004                                            pe = delayed_properties.end();
2005              pi != pe; ++pi)
2006           pi->Finalize();
2007       }
2008     }
2009 
2010     // If we have a DW_TAG_structure_type instead of a DW_TAG_class_type we
2011     // need to tell the clang type it is actually a class.
2012     if (!type_is_objc_object_or_interface) {
2013       if (is_a_class && tag_decl_kind != clang::TTK_Class)
2014         m_ast.SetTagTypeKind(ClangUtil::GetQualType(clang_type),
2015                              clang::TTK_Class);
2016     }
2017 
2018     // Since DW_TAG_structure_type gets used for both classes and
2019     // structures, we may need to set any DW_TAG_member fields to have a
2020     // "private" access if none was specified. When we parsed the child
2021     // members we tracked that actual accessibility value for each
2022     // DW_TAG_member in the "member_accessibilities" array. If the value
2023     // for the member is zero, then it was set to the
2024     // "default_accessibility" which for structs was "public". Below we
2025     // correct this by setting any fields to "private" that weren't
2026     // correctly set.
2027     if (is_a_class && !member_accessibilities.empty()) {
2028       // This is a class and all members that didn't have their access
2029       // specified are private.
2030       m_ast.SetDefaultAccessForRecordFields(
2031           m_ast.GetAsRecordDecl(clang_type), eAccessPrivate,
2032           &member_accessibilities.front(), member_accessibilities.size());
2033     }
2034 
2035     if (!bases.empty()) {
2036       // Make sure all base classes refer to complete types and not forward
2037       // declarations. If we don't do this, clang will crash with an
2038       // assertion in the call to clang_type.TransferBaseClasses()
2039       for (const auto &base_class : bases) {
2040         clang::TypeSourceInfo *type_source_info =
2041             base_class->getTypeSourceInfo();
2042         if (type_source_info)
2043           RequireCompleteType(m_ast.GetType(type_source_info->getType()));
2044       }
2045 
2046       m_ast.TransferBaseClasses(clang_type.GetOpaqueQualType(),
2047                                 std::move(bases));
2048     }
2049   }
2050 
2051   m_ast.AddMethodOverridesForCXXRecordType(clang_type.GetOpaqueQualType());
2052   TypeSystemClang::BuildIndirectFields(clang_type);
2053   TypeSystemClang::CompleteTagDeclarationDefinition(clang_type);
2054 
2055   if (!layout_info.field_offsets.empty() || !layout_info.base_offsets.empty() ||
2056       !layout_info.vbase_offsets.empty()) {
2057     if (type)
2058       layout_info.bit_size = type->GetByteSize(nullptr).getValueOr(0) * 8;
2059     if (layout_info.bit_size == 0)
2060       layout_info.bit_size =
2061           die.GetAttributeValueAsUnsigned(DW_AT_byte_size, 0) * 8;
2062 
2063     clang::CXXRecordDecl *record_decl =
2064         m_ast.GetAsCXXRecordDecl(clang_type.GetOpaqueQualType());
2065     if (record_decl)
2066       GetClangASTImporter().SetRecordLayout(record_decl, layout_info);
2067   }
2068 
2069   return (bool)clang_type;
2070 }
2071 
CompleteEnumType(const DWARFDIE & die,lldb_private::Type * type,CompilerType & clang_type)2072 bool DWARFASTParserClang::CompleteEnumType(const DWARFDIE &die,
2073                                            lldb_private::Type *type,
2074                                            CompilerType &clang_type) {
2075   if (TypeSystemClang::StartTagDeclarationDefinition(clang_type)) {
2076     if (die.HasChildren()) {
2077       bool is_signed = false;
2078       clang_type.IsIntegerType(is_signed);
2079       ParseChildEnumerators(clang_type, is_signed,
2080                             type->GetByteSize(nullptr).getValueOr(0), die);
2081     }
2082     TypeSystemClang::CompleteTagDeclarationDefinition(clang_type);
2083   }
2084   return (bool)clang_type;
2085 }
2086 
CompleteTypeFromDWARF(const DWARFDIE & die,lldb_private::Type * type,CompilerType & clang_type)2087 bool DWARFASTParserClang::CompleteTypeFromDWARF(const DWARFDIE &die,
2088                                                 lldb_private::Type *type,
2089                                                 CompilerType &clang_type) {
2090   SymbolFileDWARF *dwarf = die.GetDWARF();
2091 
2092   std::lock_guard<std::recursive_mutex> guard(
2093       dwarf->GetObjectFile()->GetModule()->GetMutex());
2094 
2095   // Disable external storage for this type so we don't get anymore
2096   // clang::ExternalASTSource queries for this type.
2097   m_ast.SetHasExternalStorage(clang_type.GetOpaqueQualType(), false);
2098 
2099   if (!die)
2100     return false;
2101 
2102   const dw_tag_t tag = die.Tag();
2103 
2104   Log *log =
2105       nullptr; // (LogChannelDWARF::GetLogIfAny(DWARF_LOG_DEBUG_INFO|DWARF_LOG_TYPE_COMPLETION));
2106   if (log)
2107     dwarf->GetObjectFile()->GetModule()->LogMessageVerboseBacktrace(
2108         log, "0x%8.8" PRIx64 ": %s '%s' resolving forward declaration...",
2109         die.GetID(), die.GetTagAsCString(), type->GetName().AsCString());
2110   assert(clang_type);
2111   DWARFAttributes attributes;
2112   switch (tag) {
2113   case DW_TAG_structure_type:
2114   case DW_TAG_union_type:
2115   case DW_TAG_class_type:
2116     return CompleteRecordType(die, type, clang_type);
2117   case DW_TAG_enumeration_type:
2118     return CompleteEnumType(die, type, clang_type);
2119   default:
2120     assert(false && "not a forward clang type decl!");
2121     break;
2122   }
2123 
2124   return false;
2125 }
2126 
EnsureAllDIEsInDeclContextHaveBeenParsed(lldb_private::CompilerDeclContext decl_context)2127 void DWARFASTParserClang::EnsureAllDIEsInDeclContextHaveBeenParsed(
2128     lldb_private::CompilerDeclContext decl_context) {
2129   auto opaque_decl_ctx =
2130       (clang::DeclContext *)decl_context.GetOpaqueDeclContext();
2131   for (auto it = m_decl_ctx_to_die.find(opaque_decl_ctx);
2132        it != m_decl_ctx_to_die.end() && it->first == opaque_decl_ctx;
2133        it = m_decl_ctx_to_die.erase(it))
2134     for (DWARFDIE decl = it->second.GetFirstChild(); decl;
2135          decl = decl.GetSibling())
2136       GetClangDeclForDIE(decl);
2137 }
2138 
GetDeclForUIDFromDWARF(const DWARFDIE & die)2139 CompilerDecl DWARFASTParserClang::GetDeclForUIDFromDWARF(const DWARFDIE &die) {
2140   clang::Decl *clang_decl = GetClangDeclForDIE(die);
2141   if (clang_decl != nullptr)
2142     return m_ast.GetCompilerDecl(clang_decl);
2143   return CompilerDecl();
2144 }
2145 
2146 CompilerDeclContext
GetDeclContextForUIDFromDWARF(const DWARFDIE & die)2147 DWARFASTParserClang::GetDeclContextForUIDFromDWARF(const DWARFDIE &die) {
2148   clang::DeclContext *clang_decl_ctx = GetClangDeclContextForDIE(die);
2149   if (clang_decl_ctx)
2150     return m_ast.CreateDeclContext(clang_decl_ctx);
2151   return CompilerDeclContext();
2152 }
2153 
2154 CompilerDeclContext
GetDeclContextContainingUIDFromDWARF(const DWARFDIE & die)2155 DWARFASTParserClang::GetDeclContextContainingUIDFromDWARF(const DWARFDIE &die) {
2156   clang::DeclContext *clang_decl_ctx =
2157       GetClangDeclContextContainingDIE(die, nullptr);
2158   if (clang_decl_ctx)
2159     return m_ast.CreateDeclContext(clang_decl_ctx);
2160   return CompilerDeclContext();
2161 }
2162 
ParseChildEnumerators(lldb_private::CompilerType & clang_type,bool is_signed,uint32_t enumerator_byte_size,const DWARFDIE & parent_die)2163 size_t DWARFASTParserClang::ParseChildEnumerators(
2164     lldb_private::CompilerType &clang_type, bool is_signed,
2165     uint32_t enumerator_byte_size, const DWARFDIE &parent_die) {
2166   if (!parent_die)
2167     return 0;
2168 
2169   size_t enumerators_added = 0;
2170 
2171   for (DWARFDIE die = parent_die.GetFirstChild(); die.IsValid();
2172        die = die.GetSibling()) {
2173     const dw_tag_t tag = die.Tag();
2174     if (tag == DW_TAG_enumerator) {
2175       DWARFAttributes attributes;
2176       const size_t num_child_attributes = die.GetAttributes(attributes);
2177       if (num_child_attributes > 0) {
2178         const char *name = nullptr;
2179         bool got_value = false;
2180         int64_t enum_value = 0;
2181         Declaration decl;
2182 
2183         uint32_t i;
2184         for (i = 0; i < num_child_attributes; ++i) {
2185           const dw_attr_t attr = attributes.AttributeAtIndex(i);
2186           DWARFFormValue form_value;
2187           if (attributes.ExtractFormValueAtIndex(i, form_value)) {
2188             switch (attr) {
2189             case DW_AT_const_value:
2190               got_value = true;
2191               if (is_signed)
2192                 enum_value = form_value.Signed();
2193               else
2194                 enum_value = form_value.Unsigned();
2195               break;
2196 
2197             case DW_AT_name:
2198               name = form_value.AsCString();
2199               break;
2200 
2201             case DW_AT_description:
2202             default:
2203             case DW_AT_decl_file:
2204               decl.SetFile(die.GetCU()->GetFile(form_value.Unsigned()));
2205               break;
2206             case DW_AT_decl_line:
2207               decl.SetLine(form_value.Unsigned());
2208               break;
2209             case DW_AT_decl_column:
2210               decl.SetColumn(form_value.Unsigned());
2211               break;
2212             case DW_AT_sibling:
2213               break;
2214             }
2215           }
2216         }
2217 
2218         if (name && name[0] && got_value) {
2219           m_ast.AddEnumerationValueToEnumerationType(
2220               clang_type, decl, name, enum_value, enumerator_byte_size * 8);
2221           ++enumerators_added;
2222         }
2223       }
2224     }
2225   }
2226   return enumerators_added;
2227 }
2228 
ParseFunctionFromDWARF(CompileUnit & comp_unit,const DWARFDIE & die)2229 Function *DWARFASTParserClang::ParseFunctionFromDWARF(CompileUnit &comp_unit,
2230                                                       const DWARFDIE &die) {
2231   DWARFRangeList func_ranges;
2232   const char *name = nullptr;
2233   const char *mangled = nullptr;
2234   int decl_file = 0;
2235   int decl_line = 0;
2236   int decl_column = 0;
2237   int call_file = 0;
2238   int call_line = 0;
2239   int call_column = 0;
2240   DWARFExpression frame_base;
2241 
2242   const dw_tag_t tag = die.Tag();
2243 
2244   if (tag != DW_TAG_subprogram)
2245     return nullptr;
2246 
2247   if (die.GetDIENamesAndRanges(name, mangled, func_ranges, decl_file, decl_line,
2248                                decl_column, call_file, call_line, call_column,
2249                                &frame_base)) {
2250 
2251     // Union of all ranges in the function DIE (if the function is
2252     // discontiguous)
2253     AddressRange func_range;
2254     lldb::addr_t lowest_func_addr = func_ranges.GetMinRangeBase(0);
2255     lldb::addr_t highest_func_addr = func_ranges.GetMaxRangeEnd(0);
2256     if (lowest_func_addr != LLDB_INVALID_ADDRESS &&
2257         lowest_func_addr <= highest_func_addr) {
2258       ModuleSP module_sp(die.GetModule());
2259       func_range.GetBaseAddress().ResolveAddressUsingFileSections(
2260           lowest_func_addr, module_sp->GetSectionList());
2261       if (func_range.GetBaseAddress().IsValid())
2262         func_range.SetByteSize(highest_func_addr - lowest_func_addr);
2263     }
2264 
2265     if (func_range.GetBaseAddress().IsValid()) {
2266       Mangled func_name;
2267       if (mangled)
2268         func_name.SetValue(ConstString(mangled), true);
2269       else if ((die.GetParent().Tag() == DW_TAG_compile_unit ||
2270                 die.GetParent().Tag() == DW_TAG_partial_unit) &&
2271                Language::LanguageIsCPlusPlus(
2272                    SymbolFileDWARF::GetLanguage(*die.GetCU())) &&
2273                !Language::LanguageIsObjC(
2274                    SymbolFileDWARF::GetLanguage(*die.GetCU())) &&
2275                name && strcmp(name, "main") != 0) {
2276         // If the mangled name is not present in the DWARF, generate the
2277         // demangled name using the decl context. We skip if the function is
2278         // "main" as its name is never mangled.
2279         bool is_static = false;
2280         bool is_variadic = false;
2281         bool has_template_params = false;
2282         unsigned type_quals = 0;
2283         std::vector<CompilerType> param_types;
2284         std::vector<clang::ParmVarDecl *> param_decls;
2285         StreamString sstr;
2286 
2287         DWARFDeclContext decl_ctx = SymbolFileDWARF::GetDWARFDeclContext(die);
2288         sstr << decl_ctx.GetQualifiedName();
2289 
2290         clang::DeclContext *containing_decl_ctx =
2291             GetClangDeclContextContainingDIE(die, nullptr);
2292         ParseChildParameters(containing_decl_ctx, die, true, is_static,
2293                              is_variadic, has_template_params, param_types,
2294                              param_decls, type_quals);
2295         sstr << "(";
2296         for (size_t i = 0; i < param_types.size(); i++) {
2297           if (i > 0)
2298             sstr << ", ";
2299           sstr << param_types[i].GetTypeName();
2300         }
2301         if (is_variadic)
2302           sstr << ", ...";
2303         sstr << ")";
2304         if (type_quals & clang::Qualifiers::Const)
2305           sstr << " const";
2306 
2307         func_name.SetValue(ConstString(sstr.GetString()), false);
2308       } else
2309         func_name.SetValue(ConstString(name), false);
2310 
2311       FunctionSP func_sp;
2312       std::unique_ptr<Declaration> decl_up;
2313       if (decl_file != 0 || decl_line != 0 || decl_column != 0)
2314         decl_up = std::make_unique<Declaration>(die.GetCU()->GetFile(decl_file),
2315                                                 decl_line, decl_column);
2316 
2317       SymbolFileDWARF *dwarf = die.GetDWARF();
2318       // Supply the type _only_ if it has already been parsed
2319       Type *func_type = dwarf->GetDIEToType().lookup(die.GetDIE());
2320 
2321       assert(func_type == nullptr || func_type != DIE_IS_BEING_PARSED);
2322 
2323       if (dwarf->FixupAddress(func_range.GetBaseAddress())) {
2324         const user_id_t func_user_id = die.GetID();
2325         func_sp =
2326             std::make_shared<Function>(&comp_unit,
2327                                    func_user_id, // UserID is the DIE offset
2328                                    func_user_id, func_name, func_type,
2329                                        func_range); // first address range
2330 
2331         if (func_sp.get() != nullptr) {
2332           if (frame_base.IsValid())
2333             func_sp->GetFrameBaseExpression() = frame_base;
2334           comp_unit.AddFunction(func_sp);
2335           return func_sp.get();
2336         }
2337       }
2338     }
2339   }
2340   return nullptr;
2341 }
2342 
ParseSingleMember(const DWARFDIE & die,const DWARFDIE & parent_die,const lldb_private::CompilerType & class_clang_type,std::vector<int> & member_accessibilities,lldb::AccessType default_accessibility,DelayedPropertyList & delayed_properties,lldb_private::ClangASTImporter::LayoutInfo & layout_info,FieldInfo & last_field_info)2343 void DWARFASTParserClang::ParseSingleMember(
2344     const DWARFDIE &die, const DWARFDIE &parent_die,
2345     const lldb_private::CompilerType &class_clang_type,
2346     std::vector<int> &member_accessibilities,
2347     lldb::AccessType default_accessibility,
2348     DelayedPropertyList &delayed_properties,
2349     lldb_private::ClangASTImporter::LayoutInfo &layout_info,
2350     FieldInfo &last_field_info) {
2351   ModuleSP module_sp = parent_die.GetDWARF()->GetObjectFile()->GetModule();
2352   const dw_tag_t tag = die.Tag();
2353   // Get the parent byte size so we can verify any members will fit
2354   const uint64_t parent_byte_size =
2355       parent_die.GetAttributeValueAsUnsigned(DW_AT_byte_size, UINT64_MAX);
2356   const uint64_t parent_bit_size =
2357       parent_byte_size == UINT64_MAX ? UINT64_MAX : parent_byte_size * 8;
2358 
2359   DWARFAttributes attributes;
2360   const size_t num_attributes = die.GetAttributes(attributes);
2361   if (num_attributes == 0)
2362     return;
2363 
2364   const char *name = nullptr;
2365   const char *prop_name = nullptr;
2366   const char *prop_getter_name = nullptr;
2367   const char *prop_setter_name = nullptr;
2368   uint32_t prop_attributes = 0;
2369 
2370   bool is_artificial = false;
2371   DWARFFormValue encoding_form;
2372   AccessType accessibility = eAccessNone;
2373   uint32_t member_byte_offset =
2374       (parent_die.Tag() == DW_TAG_union_type) ? 0 : UINT32_MAX;
2375   llvm::Optional<uint64_t> byte_size;
2376   int64_t bit_offset = 0;
2377   uint64_t data_bit_offset = UINT64_MAX;
2378   size_t bit_size = 0;
2379   bool is_external =
2380       false; // On DW_TAG_members, this means the member is static
2381   uint32_t i;
2382   for (i = 0; i < num_attributes && !is_artificial; ++i) {
2383     const dw_attr_t attr = attributes.AttributeAtIndex(i);
2384     DWARFFormValue form_value;
2385     if (attributes.ExtractFormValueAtIndex(i, form_value)) {
2386       // DW_AT_data_member_location indicates the byte offset of the
2387       // word from the base address of the structure.
2388       //
2389       // DW_AT_bit_offset indicates how many bits into the word
2390       // (according to the host endianness) the low-order bit of the
2391       // field starts.  AT_bit_offset can be negative.
2392       //
2393       // DW_AT_bit_size indicates the size of the field in bits.
2394       switch (attr) {
2395       case DW_AT_name:
2396         name = form_value.AsCString();
2397         break;
2398       case DW_AT_type:
2399         encoding_form = form_value;
2400         break;
2401       case DW_AT_bit_offset:
2402         bit_offset = form_value.Signed();
2403         break;
2404       case DW_AT_bit_size:
2405         bit_size = form_value.Unsigned();
2406         break;
2407       case DW_AT_byte_size:
2408         byte_size = form_value.Unsigned();
2409         break;
2410       case DW_AT_data_bit_offset:
2411         data_bit_offset = form_value.Unsigned();
2412         break;
2413       case DW_AT_data_member_location:
2414         if (form_value.BlockData()) {
2415           Value initialValue(0);
2416           Value memberOffset(0);
2417           const DWARFDataExtractor &debug_info_data = die.GetData();
2418           uint32_t block_length = form_value.Unsigned();
2419           uint32_t block_offset =
2420               form_value.BlockData() - debug_info_data.GetDataStart();
2421           if (DWARFExpression::Evaluate(
2422                   nullptr, // ExecutionContext *
2423                   nullptr, // RegisterContext *
2424                   module_sp,
2425                   DataExtractor(debug_info_data, block_offset, block_length),
2426                   die.GetCU(), eRegisterKindDWARF, &initialValue, nullptr,
2427                   memberOffset, nullptr)) {
2428             member_byte_offset = memberOffset.ResolveValue(nullptr).UInt();
2429           }
2430         } else {
2431           // With DWARF 3 and later, if the value is an integer constant,
2432           // this form value is the offset in bytes from the beginning of
2433           // the containing entity.
2434           member_byte_offset = form_value.Unsigned();
2435         }
2436         break;
2437 
2438       case DW_AT_accessibility:
2439         accessibility = DW_ACCESS_to_AccessType(form_value.Unsigned());
2440         break;
2441       case DW_AT_artificial:
2442         is_artificial = form_value.Boolean();
2443         break;
2444       case DW_AT_APPLE_property_name:
2445         prop_name = form_value.AsCString();
2446         break;
2447       case DW_AT_APPLE_property_getter:
2448         prop_getter_name = form_value.AsCString();
2449         break;
2450       case DW_AT_APPLE_property_setter:
2451         prop_setter_name = form_value.AsCString();
2452         break;
2453       case DW_AT_APPLE_property_attribute:
2454         prop_attributes = form_value.Unsigned();
2455         break;
2456       case DW_AT_external:
2457         is_external = form_value.Boolean();
2458         break;
2459 
2460       default:
2461       case DW_AT_declaration:
2462       case DW_AT_description:
2463       case DW_AT_mutable:
2464       case DW_AT_visibility:
2465       case DW_AT_sibling:
2466         break;
2467       }
2468     }
2469   }
2470 
2471   if (prop_name) {
2472     ConstString fixed_setter;
2473 
2474     // Check if the property getter/setter were provided as full names.
2475     // We want basenames, so we extract them.
2476 
2477     if (prop_getter_name && prop_getter_name[0] == '-') {
2478       ObjCLanguage::MethodName prop_getter_method(prop_getter_name, true);
2479       prop_getter_name = prop_getter_method.GetSelector().GetCString();
2480     }
2481 
2482     if (prop_setter_name && prop_setter_name[0] == '-') {
2483       ObjCLanguage::MethodName prop_setter_method(prop_setter_name, true);
2484       prop_setter_name = prop_setter_method.GetSelector().GetCString();
2485     }
2486 
2487     // If the names haven't been provided, they need to be filled in.
2488 
2489     if (!prop_getter_name) {
2490       prop_getter_name = prop_name;
2491     }
2492     if (!prop_setter_name && prop_name[0] &&
2493         !(prop_attributes & DW_APPLE_PROPERTY_readonly)) {
2494       StreamString ss;
2495 
2496       ss.Printf("set%c%s:", toupper(prop_name[0]), &prop_name[1]);
2497 
2498       fixed_setter.SetString(ss.GetString());
2499       prop_setter_name = fixed_setter.GetCString();
2500     }
2501   }
2502 
2503   // Clang has a DWARF generation bug where sometimes it represents
2504   // fields that are references with bad byte size and bit size/offset
2505   // information such as:
2506   //
2507   //  DW_AT_byte_size( 0x00 )
2508   //  DW_AT_bit_size( 0x40 )
2509   //  DW_AT_bit_offset( 0xffffffffffffffc0 )
2510   //
2511   // So check the bit offset to make sure it is sane, and if the values
2512   // are not sane, remove them. If we don't do this then we will end up
2513   // with a crash if we try to use this type in an expression when clang
2514   // becomes unhappy with its recycled debug info.
2515 
2516   if (byte_size.getValueOr(0) == 0 && bit_offset < 0) {
2517     bit_size = 0;
2518     bit_offset = 0;
2519   }
2520 
2521   const bool class_is_objc_object_or_interface =
2522       TypeSystemClang::IsObjCObjectOrInterfaceType(class_clang_type);
2523 
2524   // FIXME: Make Clang ignore Objective-C accessibility for expressions
2525   if (class_is_objc_object_or_interface)
2526     accessibility = eAccessNone;
2527 
2528   // Handle static members
2529   if (is_external && member_byte_offset == UINT32_MAX) {
2530     Type *var_type = die.ResolveTypeUID(encoding_form.Reference());
2531 
2532     if (var_type) {
2533       if (accessibility == eAccessNone)
2534         accessibility = eAccessPublic;
2535       TypeSystemClang::AddVariableToRecordType(
2536           class_clang_type, name, var_type->GetLayoutCompilerType(),
2537           accessibility);
2538     }
2539     return;
2540   }
2541 
2542   if (!is_artificial) {
2543     Type *member_type = die.ResolveTypeUID(encoding_form.Reference());
2544 
2545     clang::FieldDecl *field_decl = nullptr;
2546     const uint64_t character_width = 8;
2547     const uint64_t word_width = 32;
2548     if (tag == DW_TAG_member) {
2549       if (member_type) {
2550         CompilerType member_clang_type = member_type->GetLayoutCompilerType();
2551 
2552         if (accessibility == eAccessNone)
2553           accessibility = default_accessibility;
2554         member_accessibilities.push_back(accessibility);
2555 
2556         uint64_t field_bit_offset =
2557             (member_byte_offset == UINT32_MAX ? 0 : (member_byte_offset * 8));
2558 
2559         if (bit_size > 0) {
2560           FieldInfo this_field_info;
2561           this_field_info.bit_offset = field_bit_offset;
2562           this_field_info.bit_size = bit_size;
2563 
2564           if (data_bit_offset != UINT64_MAX) {
2565             this_field_info.bit_offset = data_bit_offset;
2566           } else {
2567             if (!byte_size)
2568               byte_size = member_type->GetByteSize(nullptr);
2569 
2570             ObjectFile *objfile = die.GetDWARF()->GetObjectFile();
2571             if (objfile->GetByteOrder() == eByteOrderLittle) {
2572               this_field_info.bit_offset += byte_size.getValueOr(0) * 8;
2573               this_field_info.bit_offset -= (bit_offset + bit_size);
2574             } else {
2575               this_field_info.bit_offset += bit_offset;
2576             }
2577           }
2578 
2579           // The ObjC runtime knows the byte offset but we still need to provide
2580           // the bit-offset in the layout. It just means something different then
2581           // what it does in C and C++. So we skip this check for ObjC types.
2582           //
2583           // We also skip this for fields of a union since they will all have a
2584           // zero offset.
2585           if (!TypeSystemClang::IsObjCObjectOrInterfaceType(class_clang_type) &&
2586               !(parent_die.Tag() == DW_TAG_union_type && this_field_info.bit_offset == 0) &&
2587               ((this_field_info.bit_offset >= parent_bit_size) ||
2588                (last_field_info.IsBitfield() &&
2589                 !last_field_info.NextBitfieldOffsetIsValid(
2590                     this_field_info.bit_offset)))) {
2591             ObjectFile *objfile = die.GetDWARF()->GetObjectFile();
2592             objfile->GetModule()->ReportWarning(
2593                 "0x%8.8" PRIx64 ": %s bitfield named \"%s\" has invalid "
2594                 "bit offset (0x%8.8" PRIx64
2595                 ") member will be ignored. Please file a bug against the "
2596                 "compiler and include the preprocessed output for %s\n",
2597                 die.GetID(), DW_TAG_value_to_name(tag), name,
2598                 this_field_info.bit_offset, GetUnitName(parent_die).c_str());
2599             return;
2600           }
2601 
2602           // Update the field bit offset we will report for layout
2603           field_bit_offset = this_field_info.bit_offset;
2604 
2605           // Objective-C has invalid DW_AT_bit_offset values in older
2606           // versions of clang, so we have to be careful and only insert
2607           // unnamed bitfields if we have a new enough clang.
2608           bool detect_unnamed_bitfields = true;
2609 
2610           if (class_is_objc_object_or_interface)
2611             detect_unnamed_bitfields =
2612                 die.GetCU()->Supports_unnamed_objc_bitfields();
2613 
2614           if (detect_unnamed_bitfields) {
2615             clang::Optional<FieldInfo> unnamed_field_info;
2616             uint64_t last_field_end = 0;
2617 
2618             last_field_end =
2619                 last_field_info.bit_offset + last_field_info.bit_size;
2620 
2621             if (!last_field_info.IsBitfield()) {
2622               // The last field was not a bit-field...
2623               // but if it did take up the entire word then we need to extend
2624               // last_field_end so the bit-field does not step into the last
2625               // fields padding.
2626               if (last_field_end != 0 && ((last_field_end % word_width) != 0))
2627                 last_field_end += word_width - (last_field_end % word_width);
2628             }
2629 
2630             // If we have a gap between the last_field_end and the current
2631             // field we have an unnamed bit-field.
2632             // If we have a base class, we assume there is no unnamed
2633             // bit-field if this is the first field since the gap can be
2634             // attributed to the members from the base class. This assumption
2635             // is not correct if the first field of the derived class is
2636             // indeed an unnamed bit-field. We currently do not have the
2637             // machinary to track the offset of the last field of classes we
2638             // have seen before, so we are not handling this case.
2639             if (this_field_info.bit_offset != last_field_end &&
2640                 this_field_info.bit_offset > last_field_end &&
2641                 !(last_field_info.bit_offset == 0 &&
2642                   last_field_info.bit_size == 0 &&
2643                   layout_info.base_offsets.size() != 0)) {
2644               unnamed_field_info = FieldInfo{};
2645               unnamed_field_info->bit_size =
2646                   this_field_info.bit_offset - last_field_end;
2647               unnamed_field_info->bit_offset = last_field_end;
2648             }
2649 
2650             if (unnamed_field_info) {
2651               clang::FieldDecl *unnamed_bitfield_decl =
2652                   TypeSystemClang::AddFieldToRecordType(
2653                       class_clang_type, llvm::StringRef(),
2654                       m_ast.GetBuiltinTypeForEncodingAndBitSize(eEncodingSint,
2655                                                                 word_width),
2656                       accessibility, unnamed_field_info->bit_size);
2657 
2658               layout_info.field_offsets.insert(std::make_pair(
2659                   unnamed_bitfield_decl, unnamed_field_info->bit_offset));
2660             }
2661           }
2662 
2663           last_field_info = this_field_info;
2664           last_field_info.SetIsBitfield(true);
2665         } else {
2666           last_field_info.bit_offset = field_bit_offset;
2667 
2668           if (llvm::Optional<uint64_t> clang_type_size =
2669                   member_clang_type.GetByteSize(nullptr)) {
2670             last_field_info.bit_size = *clang_type_size * character_width;
2671           }
2672 
2673           last_field_info.SetIsBitfield(false);
2674         }
2675 
2676         if (!member_clang_type.IsCompleteType())
2677           member_clang_type.GetCompleteType();
2678 
2679         {
2680           // Older versions of clang emit array[0] and array[1] in the
2681           // same way (<rdar://problem/12566646>). If the current field
2682           // is at the end of the structure, then there is definitely no
2683           // room for extra elements and we override the type to
2684           // array[0].
2685 
2686           CompilerType member_array_element_type;
2687           uint64_t member_array_size;
2688           bool member_array_is_incomplete;
2689 
2690           if (member_clang_type.IsArrayType(&member_array_element_type,
2691                                             &member_array_size,
2692                                             &member_array_is_incomplete) &&
2693               !member_array_is_incomplete) {
2694             uint64_t parent_byte_size =
2695                 parent_die.GetAttributeValueAsUnsigned(DW_AT_byte_size,
2696                                                        UINT64_MAX);
2697 
2698             if (member_byte_offset >= parent_byte_size) {
2699               if (member_array_size != 1 &&
2700                   (member_array_size != 0 ||
2701                    member_byte_offset > parent_byte_size)) {
2702                 module_sp->ReportError(
2703                     "0x%8.8" PRIx64
2704                     ": DW_TAG_member '%s' refers to type 0x%8.8x"
2705                     " which extends beyond the bounds of 0x%8.8" PRIx64,
2706                     die.GetID(), name, encoding_form.Reference().GetOffset(),
2707                     parent_die.GetID());
2708               }
2709 
2710               member_clang_type =
2711                   m_ast.CreateArrayType(member_array_element_type, 0, false);
2712             }
2713           }
2714         }
2715 
2716         RequireCompleteType(member_clang_type);
2717 
2718         field_decl = TypeSystemClang::AddFieldToRecordType(
2719             class_clang_type, name, member_clang_type, accessibility,
2720             bit_size);
2721 
2722         m_ast.SetMetadataAsUserID(field_decl, die.GetID());
2723 
2724         layout_info.field_offsets.insert(
2725             std::make_pair(field_decl, field_bit_offset));
2726       } else {
2727         if (name)
2728           module_sp->ReportError(
2729               "0x%8.8" PRIx64 ": DW_TAG_member '%s' refers to type 0x%8.8x"
2730               " which was unable to be parsed",
2731               die.GetID(), name, encoding_form.Reference().GetOffset());
2732         else
2733           module_sp->ReportError(
2734               "0x%8.8" PRIx64 ": DW_TAG_member refers to type 0x%8.8x"
2735               " which was unable to be parsed",
2736               die.GetID(), encoding_form.Reference().GetOffset());
2737       }
2738     }
2739 
2740     if (prop_name != nullptr && member_type) {
2741       clang::ObjCIvarDecl *ivar_decl = nullptr;
2742 
2743       if (field_decl) {
2744         ivar_decl = clang::dyn_cast<clang::ObjCIvarDecl>(field_decl);
2745         assert(ivar_decl != nullptr);
2746       }
2747 
2748       ClangASTMetadata metadata;
2749       metadata.SetUserID(die.GetID());
2750       delayed_properties.push_back(DelayedAddObjCClassProperty(
2751           class_clang_type, prop_name, member_type->GetLayoutCompilerType(),
2752           ivar_decl, prop_setter_name, prop_getter_name, prop_attributes,
2753           &metadata));
2754 
2755       if (ivar_decl)
2756         m_ast.SetMetadataAsUserID(ivar_decl, die.GetID());
2757     }
2758   }
2759 }
2760 
ParseChildMembers(const DWARFDIE & parent_die,CompilerType & class_clang_type,std::vector<std::unique_ptr<clang::CXXBaseSpecifier>> & base_classes,std::vector<int> & member_accessibilities,std::vector<DWARFDIE> & member_function_dies,DelayedPropertyList & delayed_properties,AccessType & default_accessibility,bool & is_a_class,ClangASTImporter::LayoutInfo & layout_info)2761 bool DWARFASTParserClang::ParseChildMembers(
2762     const DWARFDIE &parent_die, CompilerType &class_clang_type,
2763     std::vector<std::unique_ptr<clang::CXXBaseSpecifier>> &base_classes,
2764     std::vector<int> &member_accessibilities,
2765     std::vector<DWARFDIE> &member_function_dies,
2766     DelayedPropertyList &delayed_properties, AccessType &default_accessibility,
2767     bool &is_a_class, ClangASTImporter::LayoutInfo &layout_info) {
2768   if (!parent_die)
2769     return false;
2770 
2771   FieldInfo last_field_info;
2772 
2773   ModuleSP module_sp = parent_die.GetDWARF()->GetObjectFile()->GetModule();
2774   TypeSystemClang *ast =
2775       llvm::dyn_cast_or_null<TypeSystemClang>(class_clang_type.GetTypeSystem());
2776   if (ast == nullptr)
2777     return false;
2778 
2779   for (DWARFDIE die = parent_die.GetFirstChild(); die.IsValid();
2780        die = die.GetSibling()) {
2781     dw_tag_t tag = die.Tag();
2782 
2783     switch (tag) {
2784     case DW_TAG_member:
2785     case DW_TAG_APPLE_property:
2786       ParseSingleMember(die, parent_die, class_clang_type,
2787                         member_accessibilities, default_accessibility,
2788                         delayed_properties, layout_info, last_field_info);
2789       break;
2790 
2791     case DW_TAG_subprogram:
2792       // Let the type parsing code handle this one for us.
2793       member_function_dies.push_back(die);
2794       break;
2795 
2796     case DW_TAG_inheritance: {
2797       is_a_class = true;
2798       if (default_accessibility == eAccessNone)
2799         default_accessibility = eAccessPrivate;
2800       // TODO: implement DW_TAG_inheritance type parsing
2801       DWARFAttributes attributes;
2802       const size_t num_attributes = die.GetAttributes(attributes);
2803       if (num_attributes > 0) {
2804         DWARFFormValue encoding_form;
2805         AccessType accessibility = default_accessibility;
2806         bool is_virtual = false;
2807         bool is_base_of_class = true;
2808         off_t member_byte_offset = 0;
2809         uint32_t i;
2810         for (i = 0; i < num_attributes; ++i) {
2811           const dw_attr_t attr = attributes.AttributeAtIndex(i);
2812           DWARFFormValue form_value;
2813           if (attributes.ExtractFormValueAtIndex(i, form_value)) {
2814             switch (attr) {
2815             case DW_AT_type:
2816               encoding_form = form_value;
2817               break;
2818             case DW_AT_data_member_location:
2819               if (form_value.BlockData()) {
2820                 Value initialValue(0);
2821                 Value memberOffset(0);
2822                 const DWARFDataExtractor &debug_info_data = die.GetData();
2823                 uint32_t block_length = form_value.Unsigned();
2824                 uint32_t block_offset =
2825                     form_value.BlockData() - debug_info_data.GetDataStart();
2826                 if (DWARFExpression::Evaluate(
2827                         nullptr, nullptr, module_sp,
2828                         DataExtractor(debug_info_data, block_offset,
2829                                       block_length),
2830                         die.GetCU(), eRegisterKindDWARF, &initialValue, nullptr,
2831                         memberOffset, nullptr)) {
2832                   member_byte_offset =
2833                       memberOffset.ResolveValue(nullptr).UInt();
2834                 }
2835               } else {
2836                 // With DWARF 3 and later, if the value is an integer constant,
2837                 // this form value is the offset in bytes from the beginning of
2838                 // the containing entity.
2839                 member_byte_offset = form_value.Unsigned();
2840               }
2841               break;
2842 
2843             case DW_AT_accessibility:
2844               accessibility = DW_ACCESS_to_AccessType(form_value.Unsigned());
2845               break;
2846 
2847             case DW_AT_virtuality:
2848               is_virtual = form_value.Boolean();
2849               break;
2850 
2851             case DW_AT_sibling:
2852               break;
2853 
2854             default:
2855               break;
2856             }
2857           }
2858         }
2859 
2860         Type *base_class_type = die.ResolveTypeUID(encoding_form.Reference());
2861         if (base_class_type == nullptr) {
2862           module_sp->ReportError("0x%8.8x: DW_TAG_inheritance failed to "
2863                                  "resolve the base class at 0x%8.8x"
2864                                  " from enclosing type 0x%8.8x. \nPlease file "
2865                                  "a bug and attach the file at the start of "
2866                                  "this error message",
2867                                  die.GetOffset(),
2868                                  encoding_form.Reference().GetOffset(),
2869                                  parent_die.GetOffset());
2870           break;
2871         }
2872 
2873         CompilerType base_class_clang_type =
2874             base_class_type->GetFullCompilerType();
2875         assert(base_class_clang_type);
2876         if (TypeSystemClang::IsObjCObjectOrInterfaceType(class_clang_type)) {
2877           ast->SetObjCSuperClass(class_clang_type, base_class_clang_type);
2878         } else {
2879           std::unique_ptr<clang::CXXBaseSpecifier> result =
2880               ast->CreateBaseClassSpecifier(
2881                   base_class_clang_type.GetOpaqueQualType(), accessibility,
2882                   is_virtual, is_base_of_class);
2883           if (!result)
2884             break;
2885 
2886           base_classes.push_back(std::move(result));
2887 
2888           if (is_virtual) {
2889             // Do not specify any offset for virtual inheritance. The DWARF
2890             // produced by clang doesn't give us a constant offset, but gives
2891             // us a DWARF expressions that requires an actual object in memory.
2892             // the DW_AT_data_member_location for a virtual base class looks
2893             // like:
2894             //      DW_AT_data_member_location( DW_OP_dup, DW_OP_deref,
2895             //      DW_OP_constu(0x00000018), DW_OP_minus, DW_OP_deref,
2896             //      DW_OP_plus )
2897             // Given this, there is really no valid response we can give to
2898             // clang for virtual base class offsets, and this should eventually
2899             // be removed from LayoutRecordType() in the external
2900             // AST source in clang.
2901           } else {
2902             layout_info.base_offsets.insert(std::make_pair(
2903                 ast->GetAsCXXRecordDecl(
2904                     base_class_clang_type.GetOpaqueQualType()),
2905                 clang::CharUnits::fromQuantity(member_byte_offset)));
2906           }
2907         }
2908       }
2909     } break;
2910 
2911     default:
2912       break;
2913     }
2914   }
2915 
2916   return true;
2917 }
2918 
ParseChildParameters(clang::DeclContext * containing_decl_ctx,const DWARFDIE & parent_die,bool skip_artificial,bool & is_static,bool & is_variadic,bool & has_template_params,std::vector<CompilerType> & function_param_types,std::vector<clang::ParmVarDecl * > & function_param_decls,unsigned & type_quals)2919 size_t DWARFASTParserClang::ParseChildParameters(
2920     clang::DeclContext *containing_decl_ctx, const DWARFDIE &parent_die,
2921     bool skip_artificial, bool &is_static, bool &is_variadic,
2922     bool &has_template_params, std::vector<CompilerType> &function_param_types,
2923     std::vector<clang::ParmVarDecl *> &function_param_decls,
2924     unsigned &type_quals) {
2925   if (!parent_die)
2926     return 0;
2927 
2928   size_t arg_idx = 0;
2929   for (DWARFDIE die = parent_die.GetFirstChild(); die.IsValid();
2930        die = die.GetSibling()) {
2931     const dw_tag_t tag = die.Tag();
2932     switch (tag) {
2933     case DW_TAG_formal_parameter: {
2934       DWARFAttributes attributes;
2935       const size_t num_attributes = die.GetAttributes(attributes);
2936       if (num_attributes > 0) {
2937         const char *name = nullptr;
2938         DWARFFormValue param_type_die_form;
2939         bool is_artificial = false;
2940         // one of None, Auto, Register, Extern, Static, PrivateExtern
2941 
2942         clang::StorageClass storage = clang::SC_None;
2943         uint32_t i;
2944         for (i = 0; i < num_attributes; ++i) {
2945           const dw_attr_t attr = attributes.AttributeAtIndex(i);
2946           DWARFFormValue form_value;
2947           if (attributes.ExtractFormValueAtIndex(i, form_value)) {
2948             switch (attr) {
2949             case DW_AT_name:
2950               name = form_value.AsCString();
2951               break;
2952             case DW_AT_type:
2953               param_type_die_form = form_value;
2954               break;
2955             case DW_AT_artificial:
2956               is_artificial = form_value.Boolean();
2957               break;
2958             case DW_AT_location:
2959             case DW_AT_const_value:
2960             case DW_AT_default_value:
2961             case DW_AT_description:
2962             case DW_AT_endianity:
2963             case DW_AT_is_optional:
2964             case DW_AT_segment:
2965             case DW_AT_variable_parameter:
2966             default:
2967             case DW_AT_abstract_origin:
2968             case DW_AT_sibling:
2969               break;
2970             }
2971           }
2972         }
2973 
2974         bool skip = false;
2975         if (skip_artificial && is_artificial) {
2976           // In order to determine if a C++ member function is "const" we
2977           // have to look at the const-ness of "this"...
2978           if (arg_idx == 0 &&
2979               DeclKindIsCXXClass(containing_decl_ctx->getDeclKind()) &&
2980               // Often times compilers omit the "this" name for the
2981               // specification DIEs, so we can't rely upon the name being in
2982               // the formal parameter DIE...
2983               (name == nullptr || ::strcmp(name, "this") == 0)) {
2984             Type *this_type =
2985                 die.ResolveTypeUID(param_type_die_form.Reference());
2986             if (this_type) {
2987               uint32_t encoding_mask = this_type->GetEncodingMask();
2988               if (encoding_mask & Type::eEncodingIsPointerUID) {
2989                 is_static = false;
2990 
2991                 if (encoding_mask & (1u << Type::eEncodingIsConstUID))
2992                   type_quals |= clang::Qualifiers::Const;
2993                 if (encoding_mask & (1u << Type::eEncodingIsVolatileUID))
2994                   type_quals |= clang::Qualifiers::Volatile;
2995               }
2996             }
2997           }
2998           skip = true;
2999         }
3000 
3001         if (!skip) {
3002           Type *type = die.ResolveTypeUID(param_type_die_form.Reference());
3003           if (type) {
3004             function_param_types.push_back(type->GetForwardCompilerType());
3005 
3006             clang::ParmVarDecl *param_var_decl =
3007                 m_ast.CreateParameterDeclaration(
3008                     containing_decl_ctx, GetOwningClangModule(die), name,
3009                     type->GetForwardCompilerType(), storage);
3010             assert(param_var_decl);
3011             function_param_decls.push_back(param_var_decl);
3012 
3013             m_ast.SetMetadataAsUserID(param_var_decl, die.GetID());
3014           }
3015         }
3016       }
3017       arg_idx++;
3018     } break;
3019 
3020     case DW_TAG_unspecified_parameters:
3021       is_variadic = true;
3022       break;
3023 
3024     case DW_TAG_template_type_parameter:
3025     case DW_TAG_template_value_parameter:
3026     case DW_TAG_GNU_template_parameter_pack:
3027       // The one caller of this was never using the template_param_infos, and
3028       // the local variable was taking up a large amount of stack space in
3029       // SymbolFileDWARF::ParseType() so this was removed. If we ever need the
3030       // template params back, we can add them back.
3031       // ParseTemplateDIE (dwarf_cu, die, template_param_infos);
3032       has_template_params = true;
3033       break;
3034 
3035     default:
3036       break;
3037     }
3038   }
3039   return arg_idx;
3040 }
3041 
3042 llvm::Optional<SymbolFile::ArrayInfo>
ParseChildArrayInfo(const DWARFDIE & parent_die,const ExecutionContext * exe_ctx)3043 DWARFASTParser::ParseChildArrayInfo(const DWARFDIE &parent_die,
3044                                     const ExecutionContext *exe_ctx) {
3045   SymbolFile::ArrayInfo array_info;
3046   if (!parent_die)
3047     return llvm::None;
3048 
3049   for (DWARFDIE die = parent_die.GetFirstChild(); die.IsValid();
3050        die = die.GetSibling()) {
3051     const dw_tag_t tag = die.Tag();
3052     switch (tag) {
3053     case DW_TAG_subrange_type: {
3054       DWARFAttributes attributes;
3055       const size_t num_child_attributes = die.GetAttributes(attributes);
3056       if (num_child_attributes > 0) {
3057         uint64_t num_elements = 0;
3058         uint64_t lower_bound = 0;
3059         uint64_t upper_bound = 0;
3060         bool upper_bound_valid = false;
3061         uint32_t i;
3062         for (i = 0; i < num_child_attributes; ++i) {
3063           const dw_attr_t attr = attributes.AttributeAtIndex(i);
3064           DWARFFormValue form_value;
3065           if (attributes.ExtractFormValueAtIndex(i, form_value)) {
3066             switch (attr) {
3067             case DW_AT_name:
3068               break;
3069 
3070             case DW_AT_count:
3071               if (DWARFDIE var_die = die.GetReferencedDIE(DW_AT_count)) {
3072                 if (var_die.Tag() == DW_TAG_variable)
3073                   if (exe_ctx) {
3074                     if (auto frame = exe_ctx->GetFrameSP()) {
3075                       Status error;
3076                       lldb::VariableSP var_sp;
3077                       auto valobj_sp = frame->GetValueForVariableExpressionPath(
3078                           var_die.GetName(), eNoDynamicValues, 0, var_sp,
3079                           error);
3080                       if (valobj_sp) {
3081                         num_elements = valobj_sp->GetValueAsUnsigned(0);
3082                         break;
3083                       }
3084                     }
3085                   }
3086               } else
3087                 num_elements = form_value.Unsigned();
3088               break;
3089 
3090             case DW_AT_bit_stride:
3091               array_info.bit_stride = form_value.Unsigned();
3092               break;
3093 
3094             case DW_AT_byte_stride:
3095               array_info.byte_stride = form_value.Unsigned();
3096               break;
3097 
3098             case DW_AT_lower_bound:
3099               lower_bound = form_value.Unsigned();
3100               break;
3101 
3102             case DW_AT_upper_bound:
3103               upper_bound_valid = true;
3104               upper_bound = form_value.Unsigned();
3105               break;
3106 
3107             default:
3108             case DW_AT_abstract_origin:
3109             case DW_AT_accessibility:
3110             case DW_AT_allocated:
3111             case DW_AT_associated:
3112             case DW_AT_data_location:
3113             case DW_AT_declaration:
3114             case DW_AT_description:
3115             case DW_AT_sibling:
3116             case DW_AT_threads_scaled:
3117             case DW_AT_type:
3118             case DW_AT_visibility:
3119               break;
3120             }
3121           }
3122         }
3123 
3124         if (num_elements == 0) {
3125           if (upper_bound_valid && upper_bound >= lower_bound)
3126             num_elements = upper_bound - lower_bound + 1;
3127         }
3128 
3129         array_info.element_orders.push_back(num_elements);
3130       }
3131     } break;
3132     default:
3133       break;
3134     }
3135   }
3136   return array_info;
3137 }
3138 
GetTypeForDIE(const DWARFDIE & die)3139 Type *DWARFASTParserClang::GetTypeForDIE(const DWARFDIE &die) {
3140   if (die) {
3141     SymbolFileDWARF *dwarf = die.GetDWARF();
3142     DWARFAttributes attributes;
3143     const size_t num_attributes = die.GetAttributes(attributes);
3144     if (num_attributes > 0) {
3145       DWARFFormValue type_die_form;
3146       for (size_t i = 0; i < num_attributes; ++i) {
3147         dw_attr_t attr = attributes.AttributeAtIndex(i);
3148         DWARFFormValue form_value;
3149 
3150         if (attr == DW_AT_type &&
3151             attributes.ExtractFormValueAtIndex(i, form_value))
3152           return dwarf->ResolveTypeUID(form_value.Reference(), true);
3153       }
3154     }
3155   }
3156 
3157   return nullptr;
3158 }
3159 
GetClangDeclForDIE(const DWARFDIE & die)3160 clang::Decl *DWARFASTParserClang::GetClangDeclForDIE(const DWARFDIE &die) {
3161   if (!die)
3162     return nullptr;
3163 
3164   switch (die.Tag()) {
3165   case DW_TAG_variable:
3166   case DW_TAG_constant:
3167   case DW_TAG_formal_parameter:
3168   case DW_TAG_imported_declaration:
3169   case DW_TAG_imported_module:
3170     break;
3171   default:
3172     return nullptr;
3173   }
3174 
3175   DIEToDeclMap::iterator cache_pos = m_die_to_decl.find(die.GetDIE());
3176   if (cache_pos != m_die_to_decl.end())
3177     return cache_pos->second;
3178 
3179   if (DWARFDIE spec_die = die.GetReferencedDIE(DW_AT_specification)) {
3180     clang::Decl *decl = GetClangDeclForDIE(spec_die);
3181     m_die_to_decl[die.GetDIE()] = decl;
3182     m_decl_to_die[decl].insert(die.GetDIE());
3183     return decl;
3184   }
3185 
3186   if (DWARFDIE abstract_origin_die =
3187           die.GetReferencedDIE(DW_AT_abstract_origin)) {
3188     clang::Decl *decl = GetClangDeclForDIE(abstract_origin_die);
3189     m_die_to_decl[die.GetDIE()] = decl;
3190     m_decl_to_die[decl].insert(die.GetDIE());
3191     return decl;
3192   }
3193 
3194   clang::Decl *decl = nullptr;
3195   switch (die.Tag()) {
3196   case DW_TAG_variable:
3197   case DW_TAG_constant:
3198   case DW_TAG_formal_parameter: {
3199     SymbolFileDWARF *dwarf = die.GetDWARF();
3200     Type *type = GetTypeForDIE(die);
3201     if (dwarf && type) {
3202       const char *name = die.GetName();
3203       clang::DeclContext *decl_context =
3204           TypeSystemClang::DeclContextGetAsDeclContext(
3205               dwarf->GetDeclContextContainingUID(die.GetID()));
3206       decl = m_ast.CreateVariableDeclaration(
3207           decl_context, GetOwningClangModule(die), name,
3208           ClangUtil::GetQualType(type->GetForwardCompilerType()));
3209     }
3210     break;
3211   }
3212   case DW_TAG_imported_declaration: {
3213     SymbolFileDWARF *dwarf = die.GetDWARF();
3214     DWARFDIE imported_uid = die.GetAttributeValueAsReferenceDIE(DW_AT_import);
3215     if (imported_uid) {
3216       CompilerDecl imported_decl = SymbolFileDWARF::GetDecl(imported_uid);
3217       if (imported_decl) {
3218         clang::DeclContext *decl_context =
3219             TypeSystemClang::DeclContextGetAsDeclContext(
3220                 dwarf->GetDeclContextContainingUID(die.GetID()));
3221         if (clang::NamedDecl *clang_imported_decl =
3222                 llvm::dyn_cast<clang::NamedDecl>(
3223                     (clang::Decl *)imported_decl.GetOpaqueDecl()))
3224           decl = m_ast.CreateUsingDeclaration(
3225               decl_context, OptionalClangModuleID(), clang_imported_decl);
3226       }
3227     }
3228     break;
3229   }
3230   case DW_TAG_imported_module: {
3231     SymbolFileDWARF *dwarf = die.GetDWARF();
3232     DWARFDIE imported_uid = die.GetAttributeValueAsReferenceDIE(DW_AT_import);
3233 
3234     if (imported_uid) {
3235       CompilerDeclContext imported_decl_ctx =
3236           SymbolFileDWARF::GetDeclContext(imported_uid);
3237       if (imported_decl_ctx) {
3238         clang::DeclContext *decl_context =
3239             TypeSystemClang::DeclContextGetAsDeclContext(
3240                 dwarf->GetDeclContextContainingUID(die.GetID()));
3241         if (clang::NamespaceDecl *ns_decl =
3242                 TypeSystemClang::DeclContextGetAsNamespaceDecl(
3243                     imported_decl_ctx))
3244           decl = m_ast.CreateUsingDirectiveDeclaration(
3245               decl_context, OptionalClangModuleID(), ns_decl);
3246       }
3247     }
3248     break;
3249   }
3250   default:
3251     break;
3252   }
3253 
3254   m_die_to_decl[die.GetDIE()] = decl;
3255   m_decl_to_die[decl].insert(die.GetDIE());
3256 
3257   return decl;
3258 }
3259 
3260 clang::DeclContext *
GetClangDeclContextForDIE(const DWARFDIE & die)3261 DWARFASTParserClang::GetClangDeclContextForDIE(const DWARFDIE &die) {
3262   if (die) {
3263     clang::DeclContext *decl_ctx = GetCachedClangDeclContextForDIE(die);
3264     if (decl_ctx)
3265       return decl_ctx;
3266 
3267     bool try_parsing_type = true;
3268     switch (die.Tag()) {
3269     case DW_TAG_compile_unit:
3270     case DW_TAG_partial_unit:
3271       decl_ctx = m_ast.GetTranslationUnitDecl();
3272       try_parsing_type = false;
3273       break;
3274 
3275     case DW_TAG_namespace:
3276       decl_ctx = ResolveNamespaceDIE(die);
3277       try_parsing_type = false;
3278       break;
3279 
3280     case DW_TAG_lexical_block:
3281       decl_ctx = GetDeclContextForBlock(die);
3282       try_parsing_type = false;
3283       break;
3284 
3285     default:
3286       break;
3287     }
3288 
3289     if (decl_ctx == nullptr && try_parsing_type) {
3290       Type *type = die.GetDWARF()->ResolveType(die);
3291       if (type)
3292         decl_ctx = GetCachedClangDeclContextForDIE(die);
3293     }
3294 
3295     if (decl_ctx) {
3296       LinkDeclContextToDIE(decl_ctx, die);
3297       return decl_ctx;
3298     }
3299   }
3300   return nullptr;
3301 }
3302 
3303 OptionalClangModuleID
GetOwningClangModule(const DWARFDIE & die)3304 DWARFASTParserClang::GetOwningClangModule(const DWARFDIE &die) {
3305   if (!die.IsValid())
3306     return {};
3307 
3308   for (DWARFDIE parent = die.GetParent(); parent.IsValid();
3309        parent = parent.GetParent()) {
3310     const dw_tag_t tag = parent.Tag();
3311     if (tag == DW_TAG_module) {
3312       DWARFDIE module_die = parent;
3313       auto it = m_die_to_module.find(module_die.GetDIE());
3314       if (it != m_die_to_module.end())
3315         return it->second;
3316       const char *name = module_die.GetAttributeValueAsString(DW_AT_name, 0);
3317       if (!name)
3318         return {};
3319 
3320       OptionalClangModuleID id =
3321           m_ast.GetOrCreateClangModule(name, GetOwningClangModule(module_die));
3322       m_die_to_module.insert({module_die.GetDIE(), id});
3323       return id;
3324     }
3325   }
3326   return {};
3327 }
3328 
IsSubroutine(const DWARFDIE & die)3329 static bool IsSubroutine(const DWARFDIE &die) {
3330   switch (die.Tag()) {
3331   case DW_TAG_subprogram:
3332   case DW_TAG_inlined_subroutine:
3333     return true;
3334   default:
3335     return false;
3336   }
3337 }
3338 
GetContainingFunctionWithAbstractOrigin(const DWARFDIE & die)3339 static DWARFDIE GetContainingFunctionWithAbstractOrigin(const DWARFDIE &die) {
3340   for (DWARFDIE candidate = die; candidate; candidate = candidate.GetParent()) {
3341     if (IsSubroutine(candidate)) {
3342       if (candidate.GetReferencedDIE(DW_AT_abstract_origin)) {
3343         return candidate;
3344       } else {
3345         return DWARFDIE();
3346       }
3347     }
3348   }
3349   assert(0 && "Shouldn't call GetContainingFunctionWithAbstractOrigin on "
3350               "something not in a function");
3351   return DWARFDIE();
3352 }
3353 
FindAnyChildWithAbstractOrigin(const DWARFDIE & context)3354 static DWARFDIE FindAnyChildWithAbstractOrigin(const DWARFDIE &context) {
3355   for (DWARFDIE candidate = context.GetFirstChild(); candidate.IsValid();
3356        candidate = candidate.GetSibling()) {
3357     if (candidate.GetReferencedDIE(DW_AT_abstract_origin)) {
3358       return candidate;
3359     }
3360   }
3361   return DWARFDIE();
3362 }
3363 
FindFirstChildWithAbstractOrigin(const DWARFDIE & block,const DWARFDIE & function)3364 static DWARFDIE FindFirstChildWithAbstractOrigin(const DWARFDIE &block,
3365                                                  const DWARFDIE &function) {
3366   assert(IsSubroutine(function));
3367   for (DWARFDIE context = block; context != function.GetParent();
3368        context = context.GetParent()) {
3369     assert(!IsSubroutine(context) || context == function);
3370     if (DWARFDIE child = FindAnyChildWithAbstractOrigin(context)) {
3371       return child;
3372     }
3373   }
3374   return DWARFDIE();
3375 }
3376 
3377 clang::DeclContext *
GetDeclContextForBlock(const DWARFDIE & die)3378 DWARFASTParserClang::GetDeclContextForBlock(const DWARFDIE &die) {
3379   assert(die.Tag() == DW_TAG_lexical_block);
3380   DWARFDIE containing_function_with_abstract_origin =
3381       GetContainingFunctionWithAbstractOrigin(die);
3382   if (!containing_function_with_abstract_origin) {
3383     return (clang::DeclContext *)ResolveBlockDIE(die);
3384   }
3385   DWARFDIE child = FindFirstChildWithAbstractOrigin(
3386       die, containing_function_with_abstract_origin);
3387   CompilerDeclContext decl_context =
3388       GetDeclContextContainingUIDFromDWARF(child);
3389   return (clang::DeclContext *)decl_context.GetOpaqueDeclContext();
3390 }
3391 
ResolveBlockDIE(const DWARFDIE & die)3392 clang::BlockDecl *DWARFASTParserClang::ResolveBlockDIE(const DWARFDIE &die) {
3393   if (die && die.Tag() == DW_TAG_lexical_block) {
3394     clang::BlockDecl *decl =
3395         llvm::cast_or_null<clang::BlockDecl>(m_die_to_decl_ctx[die.GetDIE()]);
3396 
3397     if (!decl) {
3398       DWARFDIE decl_context_die;
3399       clang::DeclContext *decl_context =
3400           GetClangDeclContextContainingDIE(die, &decl_context_die);
3401       decl =
3402           m_ast.CreateBlockDeclaration(decl_context, GetOwningClangModule(die));
3403 
3404       if (decl)
3405         LinkDeclContextToDIE((clang::DeclContext *)decl, die);
3406     }
3407 
3408     return decl;
3409   }
3410   return nullptr;
3411 }
3412 
3413 clang::NamespaceDecl *
ResolveNamespaceDIE(const DWARFDIE & die)3414 DWARFASTParserClang::ResolveNamespaceDIE(const DWARFDIE &die) {
3415   if (die && die.Tag() == DW_TAG_namespace) {
3416     // See if we already parsed this namespace DIE and associated it with a
3417     // uniqued namespace declaration
3418     clang::NamespaceDecl *namespace_decl =
3419         static_cast<clang::NamespaceDecl *>(m_die_to_decl_ctx[die.GetDIE()]);
3420     if (namespace_decl)
3421       return namespace_decl;
3422     else {
3423       const char *namespace_name = die.GetName();
3424       clang::DeclContext *containing_decl_ctx =
3425           GetClangDeclContextContainingDIE(die, nullptr);
3426       bool is_inline =
3427           die.GetAttributeValueAsUnsigned(DW_AT_export_symbols, 0) != 0;
3428 
3429       namespace_decl = m_ast.GetUniqueNamespaceDeclaration(
3430           namespace_name, containing_decl_ctx, GetOwningClangModule(die),
3431           is_inline);
3432       Log *log =
3433           nullptr; // (LogChannelDWARF::GetLogIfAll(DWARF_LOG_DEBUG_INFO));
3434       if (log) {
3435         SymbolFileDWARF *dwarf = die.GetDWARF();
3436         if (namespace_name) {
3437           dwarf->GetObjectFile()->GetModule()->LogMessage(
3438               log,
3439               "ASTContext => %p: 0x%8.8" PRIx64
3440               ": DW_TAG_namespace with DW_AT_name(\"%s\") => "
3441               "clang::NamespaceDecl *%p (original = %p)",
3442               static_cast<void *>(&m_ast.getASTContext()), die.GetID(),
3443               namespace_name, static_cast<void *>(namespace_decl),
3444               static_cast<void *>(namespace_decl->getOriginalNamespace()));
3445         } else {
3446           dwarf->GetObjectFile()->GetModule()->LogMessage(
3447               log,
3448               "ASTContext => %p: 0x%8.8" PRIx64
3449               ": DW_TAG_namespace (anonymous) => clang::NamespaceDecl *%p "
3450               "(original = %p)",
3451               static_cast<void *>(&m_ast.getASTContext()), die.GetID(),
3452               static_cast<void *>(namespace_decl),
3453               static_cast<void *>(namespace_decl->getOriginalNamespace()));
3454         }
3455       }
3456 
3457       if (namespace_decl)
3458         LinkDeclContextToDIE((clang::DeclContext *)namespace_decl, die);
3459       return namespace_decl;
3460     }
3461   }
3462   return nullptr;
3463 }
3464 
GetClangDeclContextContainingDIE(const DWARFDIE & die,DWARFDIE * decl_ctx_die_copy)3465 clang::DeclContext *DWARFASTParserClang::GetClangDeclContextContainingDIE(
3466     const DWARFDIE &die, DWARFDIE *decl_ctx_die_copy) {
3467   SymbolFileDWARF *dwarf = die.GetDWARF();
3468 
3469   DWARFDIE decl_ctx_die = dwarf->GetDeclContextDIEContainingDIE(die);
3470 
3471   if (decl_ctx_die_copy)
3472     *decl_ctx_die_copy = decl_ctx_die;
3473 
3474   if (decl_ctx_die) {
3475     clang::DeclContext *clang_decl_ctx =
3476         GetClangDeclContextForDIE(decl_ctx_die);
3477     if (clang_decl_ctx)
3478       return clang_decl_ctx;
3479   }
3480   return m_ast.GetTranslationUnitDecl();
3481 }
3482 
3483 clang::DeclContext *
GetCachedClangDeclContextForDIE(const DWARFDIE & die)3484 DWARFASTParserClang::GetCachedClangDeclContextForDIE(const DWARFDIE &die) {
3485   if (die) {
3486     DIEToDeclContextMap::iterator pos = m_die_to_decl_ctx.find(die.GetDIE());
3487     if (pos != m_die_to_decl_ctx.end())
3488       return pos->second;
3489   }
3490   return nullptr;
3491 }
3492 
LinkDeclContextToDIE(clang::DeclContext * decl_ctx,const DWARFDIE & die)3493 void DWARFASTParserClang::LinkDeclContextToDIE(clang::DeclContext *decl_ctx,
3494                                                const DWARFDIE &die) {
3495   m_die_to_decl_ctx[die.GetDIE()] = decl_ctx;
3496   // There can be many DIEs for a single decl context
3497   // m_decl_ctx_to_die[decl_ctx].insert(die.GetDIE());
3498   m_decl_ctx_to_die.insert(std::make_pair(decl_ctx, die));
3499 }
3500 
CopyUniqueClassMethodTypes(const DWARFDIE & src_class_die,const DWARFDIE & dst_class_die,lldb_private::Type * class_type,std::vector<DWARFDIE> & failures)3501 bool DWARFASTParserClang::CopyUniqueClassMethodTypes(
3502     const DWARFDIE &src_class_die, const DWARFDIE &dst_class_die,
3503     lldb_private::Type *class_type, std::vector<DWARFDIE> &failures) {
3504   if (!class_type || !src_class_die || !dst_class_die)
3505     return false;
3506   if (src_class_die.Tag() != dst_class_die.Tag())
3507     return false;
3508 
3509   // We need to complete the class type so we can get all of the method types
3510   // parsed so we can then unique those types to their equivalent counterparts
3511   // in "dst_cu" and "dst_class_die"
3512   class_type->GetFullCompilerType();
3513 
3514   DWARFDIE src_die;
3515   DWARFDIE dst_die;
3516   UniqueCStringMap<DWARFDIE> src_name_to_die;
3517   UniqueCStringMap<DWARFDIE> dst_name_to_die;
3518   UniqueCStringMap<DWARFDIE> src_name_to_die_artificial;
3519   UniqueCStringMap<DWARFDIE> dst_name_to_die_artificial;
3520   for (src_die = src_class_die.GetFirstChild(); src_die.IsValid();
3521        src_die = src_die.GetSibling()) {
3522     if (src_die.Tag() == DW_TAG_subprogram) {
3523       // Make sure this is a declaration and not a concrete instance by looking
3524       // for DW_AT_declaration set to 1. Sometimes concrete function instances
3525       // are placed inside the class definitions and shouldn't be included in
3526       // the list of things are are tracking here.
3527       if (src_die.GetAttributeValueAsUnsigned(DW_AT_declaration, 0) == 1) {
3528         const char *src_name = src_die.GetMangledName();
3529         if (src_name) {
3530           ConstString src_const_name(src_name);
3531           if (src_die.GetAttributeValueAsUnsigned(DW_AT_artificial, 0))
3532             src_name_to_die_artificial.Append(src_const_name, src_die);
3533           else
3534             src_name_to_die.Append(src_const_name, src_die);
3535         }
3536       }
3537     }
3538   }
3539   for (dst_die = dst_class_die.GetFirstChild(); dst_die.IsValid();
3540        dst_die = dst_die.GetSibling()) {
3541     if (dst_die.Tag() == DW_TAG_subprogram) {
3542       // Make sure this is a declaration and not a concrete instance by looking
3543       // for DW_AT_declaration set to 1. Sometimes concrete function instances
3544       // are placed inside the class definitions and shouldn't be included in
3545       // the list of things are are tracking here.
3546       if (dst_die.GetAttributeValueAsUnsigned(DW_AT_declaration, 0) == 1) {
3547         const char *dst_name = dst_die.GetMangledName();
3548         if (dst_name) {
3549           ConstString dst_const_name(dst_name);
3550           if (dst_die.GetAttributeValueAsUnsigned(DW_AT_artificial, 0))
3551             dst_name_to_die_artificial.Append(dst_const_name, dst_die);
3552           else
3553             dst_name_to_die.Append(dst_const_name, dst_die);
3554         }
3555       }
3556     }
3557   }
3558   const uint32_t src_size = src_name_to_die.GetSize();
3559   const uint32_t dst_size = dst_name_to_die.GetSize();
3560   Log *log = nullptr; // (LogChannelDWARF::GetLogIfAny(DWARF_LOG_DEBUG_INFO |
3561                       // DWARF_LOG_TYPE_COMPLETION));
3562 
3563   // Is everything kosher so we can go through the members at top speed?
3564   bool fast_path = true;
3565 
3566   if (src_size != dst_size) {
3567     if (src_size != 0 && dst_size != 0) {
3568       LLDB_LOGF(log,
3569                 "warning: trying to unique class DIE 0x%8.8x to 0x%8.8x, "
3570                 "but they didn't have the same size (src=%d, dst=%d)",
3571                 src_class_die.GetOffset(), dst_class_die.GetOffset(), src_size,
3572                 dst_size);
3573     }
3574 
3575     fast_path = false;
3576   }
3577 
3578   uint32_t idx;
3579 
3580   if (fast_path) {
3581     for (idx = 0; idx < src_size; ++idx) {
3582       src_die = src_name_to_die.GetValueAtIndexUnchecked(idx);
3583       dst_die = dst_name_to_die.GetValueAtIndexUnchecked(idx);
3584 
3585       if (src_die.Tag() != dst_die.Tag()) {
3586         LLDB_LOGF(log,
3587                   "warning: tried to unique class DIE 0x%8.8x to 0x%8.8x, "
3588                   "but 0x%8.8x (%s) tags didn't match 0x%8.8x (%s)",
3589                   src_class_die.GetOffset(), dst_class_die.GetOffset(),
3590                   src_die.GetOffset(), src_die.GetTagAsCString(),
3591                   dst_die.GetOffset(), dst_die.GetTagAsCString());
3592         fast_path = false;
3593       }
3594 
3595       const char *src_name = src_die.GetMangledName();
3596       const char *dst_name = dst_die.GetMangledName();
3597 
3598       // Make sure the names match
3599       if (src_name == dst_name || (strcmp(src_name, dst_name) == 0))
3600         continue;
3601 
3602       LLDB_LOGF(log,
3603                 "warning: tried to unique class DIE 0x%8.8x to 0x%8.8x, "
3604                 "but 0x%8.8x (%s) names didn't match 0x%8.8x (%s)",
3605                 src_class_die.GetOffset(), dst_class_die.GetOffset(),
3606                 src_die.GetOffset(), src_name, dst_die.GetOffset(), dst_name);
3607 
3608       fast_path = false;
3609     }
3610   }
3611 
3612   DWARFASTParserClang *src_dwarf_ast_parser =
3613       static_cast<DWARFASTParserClang *>(
3614           SymbolFileDWARF::GetDWARFParser(*src_die.GetCU()));
3615   DWARFASTParserClang *dst_dwarf_ast_parser =
3616       static_cast<DWARFASTParserClang *>(
3617           SymbolFileDWARF::GetDWARFParser(*dst_die.GetCU()));
3618 
3619   // Now do the work of linking the DeclContexts and Types.
3620   if (fast_path) {
3621     // We can do this quickly.  Just run across the tables index-for-index
3622     // since we know each node has matching names and tags.
3623     for (idx = 0; idx < src_size; ++idx) {
3624       src_die = src_name_to_die.GetValueAtIndexUnchecked(idx);
3625       dst_die = dst_name_to_die.GetValueAtIndexUnchecked(idx);
3626 
3627       clang::DeclContext *src_decl_ctx =
3628           src_dwarf_ast_parser->m_die_to_decl_ctx[src_die.GetDIE()];
3629       if (src_decl_ctx) {
3630         LLDB_LOGF(log, "uniquing decl context %p from 0x%8.8x for 0x%8.8x",
3631                   static_cast<void *>(src_decl_ctx), src_die.GetOffset(),
3632                   dst_die.GetOffset());
3633         dst_dwarf_ast_parser->LinkDeclContextToDIE(src_decl_ctx, dst_die);
3634       } else {
3635         LLDB_LOGF(log,
3636                   "warning: tried to unique decl context from 0x%8.8x for "
3637                   "0x%8.8x, but none was found",
3638                   src_die.GetOffset(), dst_die.GetOffset());
3639       }
3640 
3641       Type *src_child_type =
3642           dst_die.GetDWARF()->GetDIEToType()[src_die.GetDIE()];
3643       if (src_child_type) {
3644         LLDB_LOGF(log,
3645                   "uniquing type %p (uid=0x%" PRIx64
3646                   ") from 0x%8.8x for 0x%8.8x",
3647                   static_cast<void *>(src_child_type), src_child_type->GetID(),
3648                   src_die.GetOffset(), dst_die.GetOffset());
3649         dst_die.GetDWARF()->GetDIEToType()[dst_die.GetDIE()] = src_child_type;
3650       } else {
3651         LLDB_LOGF(log,
3652                   "warning: tried to unique lldb_private::Type from "
3653                   "0x%8.8x for 0x%8.8x, but none was found",
3654                   src_die.GetOffset(), dst_die.GetOffset());
3655       }
3656     }
3657   } else {
3658     // We must do this slowly.  For each member of the destination, look up a
3659     // member in the source with the same name, check its tag, and unique them
3660     // if everything matches up.  Report failures.
3661 
3662     if (!src_name_to_die.IsEmpty() && !dst_name_to_die.IsEmpty()) {
3663       src_name_to_die.Sort();
3664 
3665       for (idx = 0; idx < dst_size; ++idx) {
3666         ConstString dst_name = dst_name_to_die.GetCStringAtIndex(idx);
3667         dst_die = dst_name_to_die.GetValueAtIndexUnchecked(idx);
3668         src_die = src_name_to_die.Find(dst_name, DWARFDIE());
3669 
3670         if (src_die && (src_die.Tag() == dst_die.Tag())) {
3671           clang::DeclContext *src_decl_ctx =
3672               src_dwarf_ast_parser->m_die_to_decl_ctx[src_die.GetDIE()];
3673           if (src_decl_ctx) {
3674             LLDB_LOGF(log, "uniquing decl context %p from 0x%8.8x for 0x%8.8x",
3675                       static_cast<void *>(src_decl_ctx), src_die.GetOffset(),
3676                       dst_die.GetOffset());
3677             dst_dwarf_ast_parser->LinkDeclContextToDIE(src_decl_ctx, dst_die);
3678           } else {
3679             LLDB_LOGF(log,
3680                       "warning: tried to unique decl context from 0x%8.8x "
3681                       "for 0x%8.8x, but none was found",
3682                       src_die.GetOffset(), dst_die.GetOffset());
3683           }
3684 
3685           Type *src_child_type =
3686               dst_die.GetDWARF()->GetDIEToType()[src_die.GetDIE()];
3687           if (src_child_type) {
3688             LLDB_LOGF(
3689                 log,
3690                 "uniquing type %p (uid=0x%" PRIx64 ") from 0x%8.8x for 0x%8.8x",
3691                 static_cast<void *>(src_child_type), src_child_type->GetID(),
3692                 src_die.GetOffset(), dst_die.GetOffset());
3693             dst_die.GetDWARF()->GetDIEToType()[dst_die.GetDIE()] =
3694                 src_child_type;
3695           } else {
3696             LLDB_LOGF(log,
3697                       "warning: tried to unique lldb_private::Type from "
3698                       "0x%8.8x for 0x%8.8x, but none was found",
3699                       src_die.GetOffset(), dst_die.GetOffset());
3700           }
3701         } else {
3702           LLDB_LOGF(log, "warning: couldn't find a match for 0x%8.8x",
3703                     dst_die.GetOffset());
3704 
3705           failures.push_back(dst_die);
3706         }
3707       }
3708     }
3709   }
3710 
3711   const uint32_t src_size_artificial = src_name_to_die_artificial.GetSize();
3712   const uint32_t dst_size_artificial = dst_name_to_die_artificial.GetSize();
3713 
3714   if (src_size_artificial && dst_size_artificial) {
3715     dst_name_to_die_artificial.Sort();
3716 
3717     for (idx = 0; idx < src_size_artificial; ++idx) {
3718       ConstString src_name_artificial =
3719           src_name_to_die_artificial.GetCStringAtIndex(idx);
3720       src_die = src_name_to_die_artificial.GetValueAtIndexUnchecked(idx);
3721       dst_die =
3722           dst_name_to_die_artificial.Find(src_name_artificial, DWARFDIE());
3723 
3724       if (dst_die) {
3725         // Both classes have the artificial types, link them
3726         clang::DeclContext *src_decl_ctx =
3727             src_dwarf_ast_parser->m_die_to_decl_ctx[src_die.GetDIE()];
3728         if (src_decl_ctx) {
3729           LLDB_LOGF(log, "uniquing decl context %p from 0x%8.8x for 0x%8.8x",
3730                     static_cast<void *>(src_decl_ctx), src_die.GetOffset(),
3731                     dst_die.GetOffset());
3732           dst_dwarf_ast_parser->LinkDeclContextToDIE(src_decl_ctx, dst_die);
3733         } else {
3734           LLDB_LOGF(log,
3735                     "warning: tried to unique decl context from 0x%8.8x "
3736                     "for 0x%8.8x, but none was found",
3737                     src_die.GetOffset(), dst_die.GetOffset());
3738         }
3739 
3740         Type *src_child_type =
3741             dst_die.GetDWARF()->GetDIEToType()[src_die.GetDIE()];
3742         if (src_child_type) {
3743           LLDB_LOGF(
3744               log,
3745               "uniquing type %p (uid=0x%" PRIx64 ") from 0x%8.8x for 0x%8.8x",
3746               static_cast<void *>(src_child_type), src_child_type->GetID(),
3747               src_die.GetOffset(), dst_die.GetOffset());
3748           dst_die.GetDWARF()->GetDIEToType()[dst_die.GetDIE()] = src_child_type;
3749         } else {
3750           LLDB_LOGF(log,
3751                     "warning: tried to unique lldb_private::Type from "
3752                     "0x%8.8x for 0x%8.8x, but none was found",
3753                     src_die.GetOffset(), dst_die.GetOffset());
3754         }
3755       }
3756     }
3757   }
3758 
3759   if (dst_size_artificial) {
3760     for (idx = 0; idx < dst_size_artificial; ++idx) {
3761       ConstString dst_name_artificial =
3762           dst_name_to_die_artificial.GetCStringAtIndex(idx);
3763       dst_die = dst_name_to_die_artificial.GetValueAtIndexUnchecked(idx);
3764       LLDB_LOGF(log,
3765                 "warning: need to create artificial method for 0x%8.8x for "
3766                 "method '%s'",
3767                 dst_die.GetOffset(), dst_name_artificial.GetCString());
3768 
3769       failures.push_back(dst_die);
3770     }
3771   }
3772 
3773   return !failures.empty();
3774 }
3775