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 <cstdlib>
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 <cstdio>
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;
60 DWARFASTParserClang::DWARFASTParserClang(TypeSystemClang &ast)
61     : m_ast(ast), m_die_to_decl_ctx(), m_decl_ctx_to_die() {}
62 
63 DWARFASTParserClang::~DWARFASTParserClang() {}
64 
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 
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 
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.
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 
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 
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 
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 
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.).
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.
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 
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 
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 
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
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 
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 
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         char *name_buf = nullptr;
1230         llvm::StringRef name = attrs.name.GetStringRef();
1231 
1232         // We currently generate function templates with template parameters in
1233         // their name. In order to get closer to the AST that clang generates
1234         // we want to strip these from the name when creating the AST.
1235         if (attrs.mangled_name) {
1236           llvm::ItaniumPartialDemangler D;
1237           if (!D.partialDemangle(attrs.mangled_name)) {
1238             name_buf = D.getFunctionBaseName(nullptr, nullptr);
1239             name = name_buf;
1240           }
1241         }
1242 
1243         // We just have a function that isn't part of a class
1244         function_decl = m_ast.CreateFunctionDeclaration(
1245             ignore_containing_context ? m_ast.GetTranslationUnitDecl()
1246                                       : containing_decl_ctx,
1247             GetOwningClangModule(die), name, clang_type, attrs.storage,
1248             attrs.is_inline);
1249         std::free(name_buf);
1250 
1251         if (has_template_params) {
1252           TypeSystemClang::TemplateParameterInfos template_param_infos;
1253           ParseTemplateParameterInfos(die, template_param_infos);
1254           template_function_decl = m_ast.CreateFunctionDeclaration(
1255               ignore_containing_context ? m_ast.GetTranslationUnitDecl()
1256                                         : containing_decl_ctx,
1257               GetOwningClangModule(die), attrs.name.GetStringRef(), clang_type,
1258               attrs.storage, attrs.is_inline);
1259           clang::FunctionTemplateDecl *func_template_decl =
1260               m_ast.CreateFunctionTemplateDecl(
1261                   containing_decl_ctx, GetOwningClangModule(die),
1262                   template_function_decl, template_param_infos);
1263           m_ast.CreateFunctionTemplateSpecializationInfo(
1264               template_function_decl, func_template_decl, template_param_infos);
1265         }
1266 
1267         lldbassert(function_decl);
1268 
1269         if (function_decl) {
1270           LinkDeclContextToDIE(function_decl, die);
1271 
1272           if (!function_param_decls.empty()) {
1273             m_ast.SetFunctionParameters(function_decl,
1274                                         &function_param_decls.front(),
1275                                         function_param_decls.size());
1276             if (template_function_decl)
1277               m_ast.SetFunctionParameters(template_function_decl,
1278                                           &function_param_decls.front(),
1279                                           function_param_decls.size());
1280           }
1281 
1282           ClangASTMetadata metadata;
1283           metadata.SetUserID(die.GetID());
1284 
1285           if (!object_pointer_name.empty()) {
1286             metadata.SetObjectPtrName(object_pointer_name.c_str());
1287             LLDB_LOGF(log,
1288                       "Setting object pointer name: %s on function "
1289                       "object %p.",
1290                       object_pointer_name.c_str(),
1291                       static_cast<void *>(function_decl));
1292           }
1293           m_ast.SetMetadata(function_decl, metadata);
1294         }
1295       }
1296     }
1297   }
1298   return std::make_shared<Type>(
1299       die.GetID(), dwarf, attrs.name, llvm::None, nullptr, LLDB_INVALID_UID,
1300       Type::eEncodingIsUID, &attrs.decl, clang_type, Type::ResolveState::Full);
1301 }
1302 
1303 TypeSP DWARFASTParserClang::ParseArrayType(const DWARFDIE &die,
1304                                            ParsedDWARFTypeAttributes &attrs) {
1305   SymbolFileDWARF *dwarf = die.GetDWARF();
1306 
1307   DEBUG_PRINTF("0x%8.8" PRIx64 ": %s (\"%s\")\n", die.GetID(),
1308                DW_TAG_value_to_name(tag), type_name_cstr);
1309 
1310   DWARFDIE type_die = attrs.type.Reference();
1311   Type *element_type = dwarf->ResolveTypeUID(type_die, true);
1312 
1313   if (!element_type)
1314     return nullptr;
1315 
1316   llvm::Optional<SymbolFile::ArrayInfo> array_info = ParseChildArrayInfo(die);
1317   if (array_info) {
1318     attrs.byte_stride = array_info->byte_stride;
1319     attrs.bit_stride = array_info->bit_stride;
1320   }
1321   if (attrs.byte_stride == 0 && attrs.bit_stride == 0)
1322     attrs.byte_stride = element_type->GetByteSize(nullptr).getValueOr(0);
1323   CompilerType array_element_type = element_type->GetForwardCompilerType();
1324   RequireCompleteType(array_element_type);
1325 
1326   uint64_t array_element_bit_stride =
1327       attrs.byte_stride * 8 + attrs.bit_stride;
1328   CompilerType clang_type;
1329   if (array_info && array_info->element_orders.size() > 0) {
1330     uint64_t num_elements = 0;
1331     auto end = array_info->element_orders.rend();
1332     for (auto pos = array_info->element_orders.rbegin(); pos != end; ++pos) {
1333       num_elements = *pos;
1334       clang_type = m_ast.CreateArrayType(array_element_type, num_elements,
1335                                          attrs.is_vector);
1336       array_element_type = clang_type;
1337       array_element_bit_stride = num_elements
1338                                      ? array_element_bit_stride * num_elements
1339                                      : array_element_bit_stride;
1340     }
1341   } else {
1342     clang_type =
1343         m_ast.CreateArrayType(array_element_type, 0, attrs.is_vector);
1344   }
1345   ConstString empty_name;
1346   TypeSP type_sp = std::make_shared<Type>(
1347       die.GetID(), dwarf, empty_name, array_element_bit_stride / 8, nullptr,
1348       dwarf->GetUID(type_die), Type::eEncodingIsUID, &attrs.decl, clang_type,
1349       Type::ResolveState::Full);
1350   type_sp->SetEncodingType(element_type);
1351   const clang::Type *type = ClangUtil::GetQualType(clang_type).getTypePtr();
1352   m_ast.SetMetadataAsUserID(type, die.GetID());
1353   return type_sp;
1354 }
1355 
1356 TypeSP DWARFASTParserClang::ParsePointerToMemberType(
1357     const DWARFDIE &die, const ParsedDWARFTypeAttributes &attrs) {
1358   SymbolFileDWARF *dwarf = die.GetDWARF();
1359   Type *pointee_type = dwarf->ResolveTypeUID(attrs.type.Reference(), true);
1360   Type *class_type =
1361       dwarf->ResolveTypeUID(attrs.containing_type.Reference(), true);
1362 
1363   CompilerType pointee_clang_type = pointee_type->GetForwardCompilerType();
1364   CompilerType class_clang_type = class_type->GetForwardCompilerType();
1365 
1366   CompilerType clang_type = TypeSystemClang::CreateMemberPointerType(
1367       class_clang_type, pointee_clang_type);
1368 
1369   if (llvm::Optional<uint64_t> clang_type_size =
1370           clang_type.GetByteSize(nullptr)) {
1371     return std::make_shared<Type>(die.GetID(), dwarf, attrs.name,
1372                                   *clang_type_size, nullptr, LLDB_INVALID_UID,
1373                                   Type::eEncodingIsUID, nullptr, clang_type,
1374                                   Type::ResolveState::Forward);
1375   }
1376   return nullptr;
1377 }
1378 
1379 TypeSP DWARFASTParserClang::UpdateSymbolContextScopeForType(
1380     const SymbolContext &sc, const DWARFDIE &die, TypeSP type_sp) {
1381   if (!type_sp)
1382     return type_sp;
1383 
1384   SymbolFileDWARF *dwarf = die.GetDWARF();
1385   TypeList &type_list = dwarf->GetTypeList();
1386   DWARFDIE sc_parent_die = SymbolFileDWARF::GetParentSymbolContextDIE(die);
1387   dw_tag_t sc_parent_tag = sc_parent_die.Tag();
1388 
1389   SymbolContextScope *symbol_context_scope = nullptr;
1390   if (sc_parent_tag == DW_TAG_compile_unit ||
1391       sc_parent_tag == DW_TAG_partial_unit) {
1392     symbol_context_scope = sc.comp_unit;
1393   } else if (sc.function != nullptr && sc_parent_die) {
1394     symbol_context_scope =
1395         sc.function->GetBlock(true).FindBlockByID(sc_parent_die.GetID());
1396     if (symbol_context_scope == nullptr)
1397       symbol_context_scope = sc.function;
1398   } else {
1399     symbol_context_scope = sc.module_sp.get();
1400   }
1401 
1402   if (symbol_context_scope != nullptr)
1403     type_sp->SetSymbolContextScope(symbol_context_scope);
1404 
1405   // We are ready to put this type into the uniqued list up at the module
1406   // level.
1407   type_list.Insert(type_sp);
1408 
1409   dwarf->GetDIEToType()[die.GetDIE()] = type_sp.get();
1410   return type_sp;
1411 }
1412 
1413 TypeSP
1414 DWARFASTParserClang::ParseStructureLikeDIE(const SymbolContext &sc,
1415                                            const DWARFDIE &die,
1416                                            ParsedDWARFTypeAttributes &attrs) {
1417   TypeSP type_sp;
1418   CompilerType clang_type;
1419   const dw_tag_t tag = die.Tag();
1420   SymbolFileDWARF *dwarf = die.GetDWARF();
1421   LanguageType cu_language = SymbolFileDWARF::GetLanguage(*die.GetCU());
1422   Log *log = LogChannelDWARF::GetLogIfAll(DWARF_LOG_TYPE_COMPLETION |
1423                                           DWARF_LOG_LOOKUPS);
1424 
1425   // UniqueDWARFASTType is large, so don't create a local variables on the
1426   // stack, put it on the heap. This function is often called recursively and
1427   // clang isn't good at sharing the stack space for variables in different
1428   // blocks.
1429   auto unique_ast_entry_up = std::make_unique<UniqueDWARFASTType>();
1430 
1431   ConstString unique_typename(attrs.name);
1432   Declaration unique_decl(attrs.decl);
1433 
1434   if (attrs.name) {
1435     if (Language::LanguageIsCPlusPlus(cu_language)) {
1436       // For C++, we rely solely upon the one definition rule that says
1437       // only one thing can exist at a given decl context. We ignore the
1438       // file and line that things are declared on.
1439       std::string qualified_name;
1440       if (die.GetQualifiedName(qualified_name))
1441         unique_typename = ConstString(qualified_name);
1442       unique_decl.Clear();
1443     }
1444 
1445     if (dwarf->GetUniqueDWARFASTTypeMap().Find(
1446             unique_typename, die, unique_decl, attrs.byte_size.getValueOr(-1),
1447             *unique_ast_entry_up)) {
1448       type_sp = unique_ast_entry_up->m_type_sp;
1449       if (type_sp) {
1450         dwarf->GetDIEToType()[die.GetDIE()] = type_sp.get();
1451         LinkDeclContextToDIE(
1452             GetCachedClangDeclContextForDIE(unique_ast_entry_up->m_die), die);
1453         return type_sp;
1454       }
1455     }
1456   }
1457 
1458   DEBUG_PRINTF("0x%8.8" PRIx64 ": %s (\"%s\")\n", die.GetID(),
1459                DW_TAG_value_to_name(tag), type_name_cstr);
1460 
1461   int tag_decl_kind = -1;
1462   AccessType default_accessibility = eAccessNone;
1463   if (tag == DW_TAG_structure_type) {
1464     tag_decl_kind = clang::TTK_Struct;
1465     default_accessibility = eAccessPublic;
1466   } else if (tag == DW_TAG_union_type) {
1467     tag_decl_kind = clang::TTK_Union;
1468     default_accessibility = eAccessPublic;
1469   } else if (tag == DW_TAG_class_type) {
1470     tag_decl_kind = clang::TTK_Class;
1471     default_accessibility = eAccessPrivate;
1472   }
1473 
1474   if (attrs.byte_size && *attrs.byte_size == 0 && attrs.name &&
1475       !die.HasChildren() && cu_language == eLanguageTypeObjC) {
1476     // Work around an issue with clang at the moment where forward
1477     // declarations for objective C classes are emitted as:
1478     //  DW_TAG_structure_type [2]
1479     //  DW_AT_name( "ForwardObjcClass" )
1480     //  DW_AT_byte_size( 0x00 )
1481     //  DW_AT_decl_file( "..." )
1482     //  DW_AT_decl_line( 1 )
1483     //
1484     // Note that there is no DW_AT_declaration and there are no children,
1485     // and the byte size is zero.
1486     attrs.is_forward_declaration = true;
1487   }
1488 
1489   if (attrs.class_language == eLanguageTypeObjC ||
1490       attrs.class_language == eLanguageTypeObjC_plus_plus) {
1491     if (!attrs.is_complete_objc_class &&
1492         die.Supports_DW_AT_APPLE_objc_complete_type()) {
1493       // We have a valid eSymbolTypeObjCClass class symbol whose name
1494       // matches the current objective C class that we are trying to find
1495       // and this DIE isn't the complete definition (we checked
1496       // is_complete_objc_class above and know it is false), so the real
1497       // definition is in here somewhere
1498       type_sp =
1499           dwarf->FindCompleteObjCDefinitionTypeForDIE(die, attrs.name, true);
1500 
1501       if (!type_sp) {
1502         SymbolFileDWARFDebugMap *debug_map_symfile =
1503             dwarf->GetDebugMapSymfile();
1504         if (debug_map_symfile) {
1505           // We weren't able to find a full declaration in this DWARF,
1506           // see if we have a declaration anywhere else...
1507           type_sp = debug_map_symfile->FindCompleteObjCDefinitionTypeForDIE(
1508               die, attrs.name, true);
1509         }
1510       }
1511 
1512       if (type_sp) {
1513         if (log) {
1514           dwarf->GetObjectFile()->GetModule()->LogMessage(
1515               log,
1516               "SymbolFileDWARF(%p) - 0x%8.8x: %s type \"%s\" is an "
1517               "incomplete objc type, complete type is 0x%8.8" PRIx64,
1518               static_cast<void *>(this), die.GetOffset(),
1519               DW_TAG_value_to_name(tag), attrs.name.GetCString(),
1520               type_sp->GetID());
1521         }
1522 
1523         // We found a real definition for this type elsewhere so lets use
1524         // it and cache the fact that we found a complete type for this
1525         // die
1526         dwarf->GetDIEToType()[die.GetDIE()] = type_sp.get();
1527         return type_sp;
1528       }
1529     }
1530   }
1531 
1532   if (attrs.is_forward_declaration) {
1533     // We have a forward declaration to a type and we need to try and
1534     // find a full declaration. We look in the current type index just in
1535     // case we have a forward declaration followed by an actual
1536     // declarations in the DWARF. If this fails, we need to look
1537     // elsewhere...
1538     if (log) {
1539       dwarf->GetObjectFile()->GetModule()->LogMessage(
1540           log,
1541           "SymbolFileDWARF(%p) - 0x%8.8x: %s type \"%s\" is a "
1542           "forward declaration, trying to find complete type",
1543           static_cast<void *>(this), die.GetOffset(), DW_TAG_value_to_name(tag),
1544           attrs.name.GetCString());
1545     }
1546 
1547     // See if the type comes from a Clang module and if so, track down
1548     // that type.
1549     type_sp = ParseTypeFromClangModule(sc, die, log);
1550     if (type_sp)
1551       return type_sp;
1552 
1553     DWARFDeclContext die_decl_ctx = SymbolFileDWARF::GetDWARFDeclContext(die);
1554 
1555     // type_sp = FindDefinitionTypeForDIE (dwarf_cu, die,
1556     // type_name_const_str);
1557     type_sp = dwarf->FindDefinitionTypeForDWARFDeclContext(die_decl_ctx);
1558 
1559     if (!type_sp) {
1560       SymbolFileDWARFDebugMap *debug_map_symfile = dwarf->GetDebugMapSymfile();
1561       if (debug_map_symfile) {
1562         // We weren't able to find a full declaration in this DWARF, see
1563         // if we have a declaration anywhere else...
1564         type_sp = debug_map_symfile->FindDefinitionTypeForDWARFDeclContext(
1565             die_decl_ctx);
1566       }
1567     }
1568 
1569     if (type_sp) {
1570       if (log) {
1571         dwarf->GetObjectFile()->GetModule()->LogMessage(
1572             log,
1573             "SymbolFileDWARF(%p) - 0x%8.8x: %s type \"%s\" is a "
1574             "forward declaration, complete type is 0x%8.8" PRIx64,
1575             static_cast<void *>(this), die.GetOffset(),
1576             DW_TAG_value_to_name(tag), attrs.name.GetCString(),
1577             type_sp->GetID());
1578       }
1579 
1580       // We found a real definition for this type elsewhere so lets use
1581       // it and cache the fact that we found a complete type for this die
1582       dwarf->GetDIEToType()[die.GetDIE()] = type_sp.get();
1583       clang::DeclContext *defn_decl_ctx =
1584           GetCachedClangDeclContextForDIE(dwarf->GetDIE(type_sp->GetID()));
1585       if (defn_decl_ctx)
1586         LinkDeclContextToDIE(defn_decl_ctx, die);
1587       return type_sp;
1588     }
1589   }
1590   assert(tag_decl_kind != -1);
1591   bool clang_type_was_created = false;
1592   clang_type.SetCompilerType(
1593       &m_ast, dwarf->GetForwardDeclDieToClangType().lookup(die.GetDIE()));
1594   if (!clang_type) {
1595     clang::DeclContext *decl_ctx =
1596         GetClangDeclContextContainingDIE(die, nullptr);
1597 
1598     PrepareContextToReceiveMembers(m_ast, GetClangASTImporter(), decl_ctx, die,
1599                                    attrs.name.GetCString());
1600 
1601     if (attrs.accessibility == eAccessNone && decl_ctx) {
1602       // Check the decl context that contains this class/struct/union. If
1603       // it is a class we must give it an accessibility.
1604       const clang::Decl::Kind containing_decl_kind = decl_ctx->getDeclKind();
1605       if (DeclKindIsCXXClass(containing_decl_kind))
1606         attrs.accessibility = default_accessibility;
1607     }
1608 
1609     ClangASTMetadata metadata;
1610     metadata.SetUserID(die.GetID());
1611     metadata.SetIsDynamicCXXType(dwarf->ClassOrStructIsVirtual(die));
1612 
1613     if (attrs.name.GetStringRef().contains('<')) {
1614       TypeSystemClang::TemplateParameterInfos template_param_infos;
1615       if (ParseTemplateParameterInfos(die, template_param_infos)) {
1616         clang::ClassTemplateDecl *class_template_decl =
1617             m_ast.ParseClassTemplateDecl(
1618                 decl_ctx, GetOwningClangModule(die), attrs.accessibility,
1619                 attrs.name.GetCString(), tag_decl_kind, template_param_infos);
1620         if (!class_template_decl) {
1621           if (log) {
1622             dwarf->GetObjectFile()->GetModule()->LogMessage(
1623                 log,
1624                 "SymbolFileDWARF(%p) - 0x%8.8x: %s type \"%s\" "
1625                 "clang::ClassTemplateDecl failed to return a decl.",
1626                 static_cast<void *>(this), die.GetOffset(),
1627                 DW_TAG_value_to_name(tag), attrs.name.GetCString());
1628           }
1629           return TypeSP();
1630         }
1631 
1632         clang::ClassTemplateSpecializationDecl *class_specialization_decl =
1633             m_ast.CreateClassTemplateSpecializationDecl(
1634                 decl_ctx, GetOwningClangModule(die), class_template_decl,
1635                 tag_decl_kind, template_param_infos);
1636         clang_type = m_ast.CreateClassTemplateSpecializationType(
1637             class_specialization_decl);
1638         clang_type_was_created = true;
1639 
1640         m_ast.SetMetadata(class_template_decl, metadata);
1641         m_ast.SetMetadata(class_specialization_decl, metadata);
1642       }
1643     }
1644 
1645     if (!clang_type_was_created) {
1646       clang_type_was_created = true;
1647       clang_type = m_ast.CreateRecordType(
1648           decl_ctx, GetOwningClangModule(die), attrs.accessibility,
1649           attrs.name.GetCString(), tag_decl_kind, attrs.class_language,
1650           &metadata, attrs.exports_symbols);
1651     }
1652   }
1653 
1654   // Store a forward declaration to this class type in case any
1655   // parameters in any class methods need it for the clang types for
1656   // function prototypes.
1657   LinkDeclContextToDIE(m_ast.GetDeclContextForType(clang_type), die);
1658   type_sp = std::make_shared<Type>(
1659       die.GetID(), dwarf, attrs.name, attrs.byte_size, nullptr,
1660       LLDB_INVALID_UID, Type::eEncodingIsUID, &attrs.decl, clang_type,
1661       Type::ResolveState::Forward,
1662       TypePayloadClang(OptionalClangModuleID(), attrs.is_complete_objc_class));
1663 
1664   // Add our type to the unique type map so we don't end up creating many
1665   // copies of the same type over and over in the ASTContext for our
1666   // module
1667   unique_ast_entry_up->m_type_sp = type_sp;
1668   unique_ast_entry_up->m_die = die;
1669   unique_ast_entry_up->m_declaration = unique_decl;
1670   unique_ast_entry_up->m_byte_size = attrs.byte_size.getValueOr(0);
1671   dwarf->GetUniqueDWARFASTTypeMap().Insert(unique_typename,
1672                                            *unique_ast_entry_up);
1673 
1674   if (!attrs.is_forward_declaration) {
1675     // Always start the definition for a class type so that if the class
1676     // has child classes or types that require the class to be created
1677     // for use as their decl contexts the class will be ready to accept
1678     // these child definitions.
1679     if (!die.HasChildren()) {
1680       // No children for this struct/union/class, lets finish it
1681       if (TypeSystemClang::StartTagDeclarationDefinition(clang_type)) {
1682         TypeSystemClang::CompleteTagDeclarationDefinition(clang_type);
1683       } else {
1684         dwarf->GetObjectFile()->GetModule()->ReportError(
1685             "DWARF DIE at 0x%8.8x named \"%s\" was not able to start its "
1686             "definition.\nPlease file a bug and attach the file at the "
1687             "start of this error message",
1688             die.GetOffset(), attrs.name.GetCString());
1689       }
1690 
1691       if (tag == DW_TAG_structure_type) // this only applies in C
1692       {
1693         clang::RecordDecl *record_decl =
1694             TypeSystemClang::GetAsRecordDecl(clang_type);
1695 
1696         if (record_decl) {
1697           GetClangASTImporter().SetRecordLayout(
1698               record_decl, ClangASTImporter::LayoutInfo());
1699         }
1700       }
1701     } else if (clang_type_was_created) {
1702       // Start the definition if the class is not objective C since the
1703       // underlying decls respond to isCompleteDefinition(). Objective
1704       // C decls don't respond to isCompleteDefinition() so we can't
1705       // start the declaration definition right away. For C++
1706       // class/union/structs we want to start the definition in case the
1707       // class is needed as the declaration context for a contained class
1708       // or type without the need to complete that type..
1709 
1710       if (attrs.class_language != eLanguageTypeObjC &&
1711           attrs.class_language != eLanguageTypeObjC_plus_plus)
1712         TypeSystemClang::StartTagDeclarationDefinition(clang_type);
1713 
1714       // Leave this as a forward declaration until we need to know the
1715       // details of the type. lldb_private::Type will automatically call
1716       // the SymbolFile virtual function
1717       // "SymbolFileDWARF::CompleteType(Type *)" When the definition
1718       // needs to be defined.
1719       assert(!dwarf->GetForwardDeclClangTypeToDie().count(
1720                  ClangUtil::RemoveFastQualifiers(clang_type)
1721                      .GetOpaqueQualType()) &&
1722              "Type already in the forward declaration map!");
1723       // Can't assume m_ast.GetSymbolFile() is actually a
1724       // SymbolFileDWARF, it can be a SymbolFileDWARFDebugMap for Apple
1725       // binaries.
1726       dwarf->GetForwardDeclDieToClangType()[die.GetDIE()] =
1727           clang_type.GetOpaqueQualType();
1728       dwarf->GetForwardDeclClangTypeToDie().try_emplace(
1729           ClangUtil::RemoveFastQualifiers(clang_type).GetOpaqueQualType(),
1730           *die.GetDIERef());
1731       m_ast.SetHasExternalStorage(clang_type.GetOpaqueQualType(), true);
1732     }
1733   }
1734 
1735   // If we made a clang type, set the trivial abi if applicable: We only
1736   // do this for pass by value - which implies the Trivial ABI. There
1737   // isn't a way to assert that something that would normally be pass by
1738   // value is pass by reference, so we ignore that attribute if set.
1739   if (attrs.calling_convention == llvm::dwarf::DW_CC_pass_by_value) {
1740     clang::CXXRecordDecl *record_decl =
1741         m_ast.GetAsCXXRecordDecl(clang_type.GetOpaqueQualType());
1742     if (record_decl && record_decl->getDefinition()) {
1743       record_decl->setHasTrivialSpecialMemberForCall();
1744     }
1745   }
1746 
1747   if (attrs.calling_convention == llvm::dwarf::DW_CC_pass_by_reference) {
1748     clang::CXXRecordDecl *record_decl =
1749         m_ast.GetAsCXXRecordDecl(clang_type.GetOpaqueQualType());
1750     if (record_decl)
1751       record_decl->setArgPassingRestrictions(
1752           clang::RecordDecl::APK_CannotPassInRegs);
1753   }
1754   return type_sp;
1755 }
1756 
1757 // DWARF parsing functions
1758 
1759 class DWARFASTParserClang::DelayedAddObjCClassProperty {
1760 public:
1761   DelayedAddObjCClassProperty(
1762       const CompilerType &class_opaque_type, const char *property_name,
1763       const CompilerType &property_opaque_type, // The property type is only
1764                                                 // required if you don't have an
1765                                                 // ivar decl
1766       clang::ObjCIvarDecl *ivar_decl, const char *property_setter_name,
1767       const char *property_getter_name, uint32_t property_attributes,
1768       const ClangASTMetadata *metadata)
1769       : m_class_opaque_type(class_opaque_type), m_property_name(property_name),
1770         m_property_opaque_type(property_opaque_type), m_ivar_decl(ivar_decl),
1771         m_property_setter_name(property_setter_name),
1772         m_property_getter_name(property_getter_name),
1773         m_property_attributes(property_attributes) {
1774     if (metadata != nullptr) {
1775       m_metadata_up = std::make_unique<ClangASTMetadata>();
1776       *m_metadata_up = *metadata;
1777     }
1778   }
1779 
1780   DelayedAddObjCClassProperty(const DelayedAddObjCClassProperty &rhs) {
1781     *this = rhs;
1782   }
1783 
1784   DelayedAddObjCClassProperty &
1785   operator=(const DelayedAddObjCClassProperty &rhs) {
1786     m_class_opaque_type = rhs.m_class_opaque_type;
1787     m_property_name = rhs.m_property_name;
1788     m_property_opaque_type = rhs.m_property_opaque_type;
1789     m_ivar_decl = rhs.m_ivar_decl;
1790     m_property_setter_name = rhs.m_property_setter_name;
1791     m_property_getter_name = rhs.m_property_getter_name;
1792     m_property_attributes = rhs.m_property_attributes;
1793 
1794     if (rhs.m_metadata_up) {
1795       m_metadata_up = std::make_unique<ClangASTMetadata>();
1796       *m_metadata_up = *rhs.m_metadata_up;
1797     }
1798     return *this;
1799   }
1800 
1801   bool Finalize() {
1802     return TypeSystemClang::AddObjCClassProperty(
1803         m_class_opaque_type, m_property_name, m_property_opaque_type,
1804         m_ivar_decl, m_property_setter_name, m_property_getter_name,
1805         m_property_attributes, m_metadata_up.get());
1806   }
1807 
1808 private:
1809   CompilerType m_class_opaque_type;
1810   const char *m_property_name;
1811   CompilerType m_property_opaque_type;
1812   clang::ObjCIvarDecl *m_ivar_decl;
1813   const char *m_property_setter_name;
1814   const char *m_property_getter_name;
1815   uint32_t m_property_attributes;
1816   std::unique_ptr<ClangASTMetadata> m_metadata_up;
1817 };
1818 
1819 bool DWARFASTParserClang::ParseTemplateDIE(
1820     const DWARFDIE &die,
1821     TypeSystemClang::TemplateParameterInfos &template_param_infos) {
1822   const dw_tag_t tag = die.Tag();
1823   bool is_template_template_argument = false;
1824 
1825   switch (tag) {
1826   case DW_TAG_GNU_template_parameter_pack: {
1827     template_param_infos.packed_args =
1828         std::make_unique<TypeSystemClang::TemplateParameterInfos>();
1829     for (DWARFDIE child_die = die.GetFirstChild(); child_die.IsValid();
1830          child_die = child_die.GetSibling()) {
1831       if (!ParseTemplateDIE(child_die, *template_param_infos.packed_args))
1832         return false;
1833     }
1834     if (const char *name = die.GetName()) {
1835       template_param_infos.pack_name = name;
1836     }
1837     return true;
1838   }
1839   case DW_TAG_GNU_template_template_param:
1840     is_template_template_argument = true;
1841     LLVM_FALLTHROUGH;
1842   case DW_TAG_template_type_parameter:
1843   case DW_TAG_template_value_parameter: {
1844     DWARFAttributes attributes;
1845     const size_t num_attributes = die.GetAttributes(attributes);
1846     const char *name = nullptr;
1847     const char *template_name = nullptr;
1848     CompilerType clang_type;
1849     uint64_t uval64 = 0;
1850     bool uval64_valid = false;
1851     if (num_attributes > 0) {
1852       DWARFFormValue form_value;
1853       for (size_t i = 0; i < num_attributes; ++i) {
1854         const dw_attr_t attr = attributes.AttributeAtIndex(i);
1855 
1856         switch (attr) {
1857         case DW_AT_name:
1858           if (attributes.ExtractFormValueAtIndex(i, form_value))
1859             name = form_value.AsCString();
1860           break;
1861 
1862         case DW_AT_GNU_template_name:
1863           if (attributes.ExtractFormValueAtIndex(i, form_value))
1864             template_name = form_value.AsCString();
1865           break;
1866 
1867         case DW_AT_type:
1868           if (attributes.ExtractFormValueAtIndex(i, form_value)) {
1869             Type *lldb_type = die.ResolveTypeUID(form_value.Reference());
1870             if (lldb_type)
1871               clang_type = lldb_type->GetForwardCompilerType();
1872           }
1873           break;
1874 
1875         case DW_AT_const_value:
1876           if (attributes.ExtractFormValueAtIndex(i, form_value)) {
1877             uval64_valid = true;
1878             uval64 = form_value.Unsigned();
1879           }
1880           break;
1881         default:
1882           break;
1883         }
1884       }
1885 
1886       clang::ASTContext &ast = m_ast.getASTContext();
1887       if (!clang_type)
1888         clang_type = m_ast.GetBasicType(eBasicTypeVoid);
1889 
1890       if (!is_template_template_argument) {
1891         bool is_signed = false;
1892         if (name && name[0])
1893           template_param_infos.names.push_back(name);
1894         else
1895           template_param_infos.names.push_back(NULL);
1896 
1897         // Get the signed value for any integer or enumeration if available
1898         clang_type.IsIntegerOrEnumerationType(is_signed);
1899 
1900         if (tag == DW_TAG_template_value_parameter && uval64_valid) {
1901           llvm::Optional<uint64_t> size = clang_type.GetBitSize(nullptr);
1902           if (!size)
1903             return false;
1904           llvm::APInt apint(*size, uval64, is_signed);
1905           template_param_infos.args.push_back(
1906               clang::TemplateArgument(ast, llvm::APSInt(apint, !is_signed),
1907                                       ClangUtil::GetQualType(clang_type)));
1908         } else {
1909           template_param_infos.args.push_back(
1910               clang::TemplateArgument(ClangUtil::GetQualType(clang_type)));
1911         }
1912       } else {
1913         auto *tplt_type = m_ast.CreateTemplateTemplateParmDecl(template_name);
1914         template_param_infos.names.push_back(name);
1915         template_param_infos.args.push_back(
1916             clang::TemplateArgument(clang::TemplateName(tplt_type)));
1917       }
1918     }
1919   }
1920     return true;
1921 
1922   default:
1923     break;
1924   }
1925   return false;
1926 }
1927 
1928 bool DWARFASTParserClang::ParseTemplateParameterInfos(
1929     const DWARFDIE &parent_die,
1930     TypeSystemClang::TemplateParameterInfos &template_param_infos) {
1931 
1932   if (!parent_die)
1933     return false;
1934 
1935   for (DWARFDIE die = parent_die.GetFirstChild(); die.IsValid();
1936        die = die.GetSibling()) {
1937     const dw_tag_t tag = die.Tag();
1938 
1939     switch (tag) {
1940     case DW_TAG_template_type_parameter:
1941     case DW_TAG_template_value_parameter:
1942     case DW_TAG_GNU_template_parameter_pack:
1943     case DW_TAG_GNU_template_template_param:
1944       ParseTemplateDIE(die, template_param_infos);
1945       break;
1946 
1947     default:
1948       break;
1949     }
1950   }
1951   return template_param_infos.args.size() == template_param_infos.names.size();
1952 }
1953 
1954 bool DWARFASTParserClang::CompleteRecordType(const DWARFDIE &die,
1955                                              lldb_private::Type *type,
1956                                              CompilerType &clang_type) {
1957   const dw_tag_t tag = die.Tag();
1958   SymbolFileDWARF *dwarf = die.GetDWARF();
1959 
1960   ClangASTImporter::LayoutInfo layout_info;
1961 
1962   if (die.HasChildren()) {
1963     const bool type_is_objc_object_or_interface =
1964         TypeSystemClang::IsObjCObjectOrInterfaceType(clang_type);
1965     if (type_is_objc_object_or_interface) {
1966       // For objective C we don't start the definition when the class is
1967       // created.
1968       TypeSystemClang::StartTagDeclarationDefinition(clang_type);
1969     }
1970 
1971     int tag_decl_kind = -1;
1972     AccessType default_accessibility = eAccessNone;
1973     if (tag == DW_TAG_structure_type) {
1974       tag_decl_kind = clang::TTK_Struct;
1975       default_accessibility = eAccessPublic;
1976     } else if (tag == DW_TAG_union_type) {
1977       tag_decl_kind = clang::TTK_Union;
1978       default_accessibility = eAccessPublic;
1979     } else if (tag == DW_TAG_class_type) {
1980       tag_decl_kind = clang::TTK_Class;
1981       default_accessibility = eAccessPrivate;
1982     }
1983 
1984     std::vector<std::unique_ptr<clang::CXXBaseSpecifier>> bases;
1985     std::vector<int> member_accessibilities;
1986     bool is_a_class = false;
1987     // Parse members and base classes first
1988     std::vector<DWARFDIE> member_function_dies;
1989 
1990     DelayedPropertyList delayed_properties;
1991     ParseChildMembers(die, clang_type, bases, member_accessibilities,
1992                       member_function_dies, delayed_properties,
1993                       default_accessibility, is_a_class, layout_info);
1994 
1995     // Now parse any methods if there were any...
1996     for (const DWARFDIE &die : member_function_dies)
1997       dwarf->ResolveType(die);
1998 
1999     if (type_is_objc_object_or_interface) {
2000       ConstString class_name(clang_type.GetTypeName());
2001       if (class_name) {
2002         dwarf->GetObjCMethods(class_name, [&](DWARFDIE method_die) {
2003           method_die.ResolveType();
2004           return true;
2005         });
2006 
2007         for (DelayedPropertyList::iterator pi = delayed_properties.begin(),
2008                                            pe = delayed_properties.end();
2009              pi != pe; ++pi)
2010           pi->Finalize();
2011       }
2012     }
2013 
2014     // If we have a DW_TAG_structure_type instead of a DW_TAG_class_type we
2015     // need to tell the clang type it is actually a class.
2016     if (!type_is_objc_object_or_interface) {
2017       if (is_a_class && tag_decl_kind != clang::TTK_Class)
2018         m_ast.SetTagTypeKind(ClangUtil::GetQualType(clang_type),
2019                              clang::TTK_Class);
2020     }
2021 
2022     // Since DW_TAG_structure_type gets used for both classes and
2023     // structures, we may need to set any DW_TAG_member fields to have a
2024     // "private" access if none was specified. When we parsed the child
2025     // members we tracked that actual accessibility value for each
2026     // DW_TAG_member in the "member_accessibilities" array. If the value
2027     // for the member is zero, then it was set to the
2028     // "default_accessibility" which for structs was "public". Below we
2029     // correct this by setting any fields to "private" that weren't
2030     // correctly set.
2031     if (is_a_class && !member_accessibilities.empty()) {
2032       // This is a class and all members that didn't have their access
2033       // specified are private.
2034       m_ast.SetDefaultAccessForRecordFields(
2035           m_ast.GetAsRecordDecl(clang_type), eAccessPrivate,
2036           &member_accessibilities.front(), member_accessibilities.size());
2037     }
2038 
2039     if (!bases.empty()) {
2040       // Make sure all base classes refer to complete types and not forward
2041       // declarations. If we don't do this, clang will crash with an
2042       // assertion in the call to clang_type.TransferBaseClasses()
2043       for (const auto &base_class : bases) {
2044         clang::TypeSourceInfo *type_source_info =
2045             base_class->getTypeSourceInfo();
2046         if (type_source_info)
2047           RequireCompleteType(m_ast.GetType(type_source_info->getType()));
2048       }
2049 
2050       m_ast.TransferBaseClasses(clang_type.GetOpaqueQualType(),
2051                                 std::move(bases));
2052     }
2053   }
2054 
2055   m_ast.AddMethodOverridesForCXXRecordType(clang_type.GetOpaqueQualType());
2056   TypeSystemClang::BuildIndirectFields(clang_type);
2057   TypeSystemClang::CompleteTagDeclarationDefinition(clang_type);
2058 
2059   if (!layout_info.field_offsets.empty() || !layout_info.base_offsets.empty() ||
2060       !layout_info.vbase_offsets.empty()) {
2061     if (type)
2062       layout_info.bit_size = type->GetByteSize(nullptr).getValueOr(0) * 8;
2063     if (layout_info.bit_size == 0)
2064       layout_info.bit_size =
2065           die.GetAttributeValueAsUnsigned(DW_AT_byte_size, 0) * 8;
2066 
2067     clang::CXXRecordDecl *record_decl =
2068         m_ast.GetAsCXXRecordDecl(clang_type.GetOpaqueQualType());
2069     if (record_decl)
2070       GetClangASTImporter().SetRecordLayout(record_decl, layout_info);
2071   }
2072 
2073   return (bool)clang_type;
2074 }
2075 
2076 bool DWARFASTParserClang::CompleteEnumType(const DWARFDIE &die,
2077                                            lldb_private::Type *type,
2078                                            CompilerType &clang_type) {
2079   if (TypeSystemClang::StartTagDeclarationDefinition(clang_type)) {
2080     if (die.HasChildren()) {
2081       bool is_signed = false;
2082       clang_type.IsIntegerType(is_signed);
2083       ParseChildEnumerators(clang_type, is_signed,
2084                             type->GetByteSize(nullptr).getValueOr(0), die);
2085     }
2086     TypeSystemClang::CompleteTagDeclarationDefinition(clang_type);
2087   }
2088   return (bool)clang_type;
2089 }
2090 
2091 bool DWARFASTParserClang::CompleteTypeFromDWARF(const DWARFDIE &die,
2092                                                 lldb_private::Type *type,
2093                                                 CompilerType &clang_type) {
2094   SymbolFileDWARF *dwarf = die.GetDWARF();
2095 
2096   std::lock_guard<std::recursive_mutex> guard(
2097       dwarf->GetObjectFile()->GetModule()->GetMutex());
2098 
2099   // Disable external storage for this type so we don't get anymore
2100   // clang::ExternalASTSource queries for this type.
2101   m_ast.SetHasExternalStorage(clang_type.GetOpaqueQualType(), false);
2102 
2103   if (!die)
2104     return false;
2105 
2106   const dw_tag_t tag = die.Tag();
2107 
2108   Log *log =
2109       nullptr; // (LogChannelDWARF::GetLogIfAny(DWARF_LOG_DEBUG_INFO|DWARF_LOG_TYPE_COMPLETION));
2110   if (log)
2111     dwarf->GetObjectFile()->GetModule()->LogMessageVerboseBacktrace(
2112         log, "0x%8.8" PRIx64 ": %s '%s' resolving forward declaration...",
2113         die.GetID(), die.GetTagAsCString(), type->GetName().AsCString());
2114   assert(clang_type);
2115   DWARFAttributes attributes;
2116   switch (tag) {
2117   case DW_TAG_structure_type:
2118   case DW_TAG_union_type:
2119   case DW_TAG_class_type:
2120     return CompleteRecordType(die, type, clang_type);
2121   case DW_TAG_enumeration_type:
2122     return CompleteEnumType(die, type, clang_type);
2123   default:
2124     assert(false && "not a forward clang type decl!");
2125     break;
2126   }
2127 
2128   return false;
2129 }
2130 
2131 void DWARFASTParserClang::EnsureAllDIEsInDeclContextHaveBeenParsed(
2132     lldb_private::CompilerDeclContext decl_context) {
2133   auto opaque_decl_ctx =
2134       (clang::DeclContext *)decl_context.GetOpaqueDeclContext();
2135   for (auto it = m_decl_ctx_to_die.find(opaque_decl_ctx);
2136        it != m_decl_ctx_to_die.end() && it->first == opaque_decl_ctx;
2137        it = m_decl_ctx_to_die.erase(it))
2138     for (DWARFDIE decl = it->second.GetFirstChild(); decl;
2139          decl = decl.GetSibling())
2140       GetClangDeclForDIE(decl);
2141 }
2142 
2143 CompilerDecl DWARFASTParserClang::GetDeclForUIDFromDWARF(const DWARFDIE &die) {
2144   clang::Decl *clang_decl = GetClangDeclForDIE(die);
2145   if (clang_decl != nullptr)
2146     return m_ast.GetCompilerDecl(clang_decl);
2147   return CompilerDecl();
2148 }
2149 
2150 CompilerDeclContext
2151 DWARFASTParserClang::GetDeclContextForUIDFromDWARF(const DWARFDIE &die) {
2152   clang::DeclContext *clang_decl_ctx = GetClangDeclContextForDIE(die);
2153   if (clang_decl_ctx)
2154     return m_ast.CreateDeclContext(clang_decl_ctx);
2155   return CompilerDeclContext();
2156 }
2157 
2158 CompilerDeclContext
2159 DWARFASTParserClang::GetDeclContextContainingUIDFromDWARF(const DWARFDIE &die) {
2160   clang::DeclContext *clang_decl_ctx =
2161       GetClangDeclContextContainingDIE(die, nullptr);
2162   if (clang_decl_ctx)
2163     return m_ast.CreateDeclContext(clang_decl_ctx);
2164   return CompilerDeclContext();
2165 }
2166 
2167 size_t DWARFASTParserClang::ParseChildEnumerators(
2168     lldb_private::CompilerType &clang_type, bool is_signed,
2169     uint32_t enumerator_byte_size, const DWARFDIE &parent_die) {
2170   if (!parent_die)
2171     return 0;
2172 
2173   size_t enumerators_added = 0;
2174 
2175   for (DWARFDIE die = parent_die.GetFirstChild(); die.IsValid();
2176        die = die.GetSibling()) {
2177     const dw_tag_t tag = die.Tag();
2178     if (tag == DW_TAG_enumerator) {
2179       DWARFAttributes attributes;
2180       const size_t num_child_attributes = die.GetAttributes(attributes);
2181       if (num_child_attributes > 0) {
2182         const char *name = nullptr;
2183         bool got_value = false;
2184         int64_t enum_value = 0;
2185         Declaration decl;
2186 
2187         uint32_t i;
2188         for (i = 0; i < num_child_attributes; ++i) {
2189           const dw_attr_t attr = attributes.AttributeAtIndex(i);
2190           DWARFFormValue form_value;
2191           if (attributes.ExtractFormValueAtIndex(i, form_value)) {
2192             switch (attr) {
2193             case DW_AT_const_value:
2194               got_value = true;
2195               if (is_signed)
2196                 enum_value = form_value.Signed();
2197               else
2198                 enum_value = form_value.Unsigned();
2199               break;
2200 
2201             case DW_AT_name:
2202               name = form_value.AsCString();
2203               break;
2204 
2205             case DW_AT_description:
2206             default:
2207             case DW_AT_decl_file:
2208               decl.SetFile(attributes.CompileUnitAtIndex(i)->GetFile(
2209                   form_value.Unsigned()));
2210               break;
2211             case DW_AT_decl_line:
2212               decl.SetLine(form_value.Unsigned());
2213               break;
2214             case DW_AT_decl_column:
2215               decl.SetColumn(form_value.Unsigned());
2216               break;
2217             case DW_AT_sibling:
2218               break;
2219             }
2220           }
2221         }
2222 
2223         if (name && name[0] && got_value) {
2224           m_ast.AddEnumerationValueToEnumerationType(
2225               clang_type, decl, name, enum_value, enumerator_byte_size * 8);
2226           ++enumerators_added;
2227         }
2228       }
2229     }
2230   }
2231   return enumerators_added;
2232 }
2233 
2234 Function *DWARFASTParserClang::ParseFunctionFromDWARF(CompileUnit &comp_unit,
2235                                                       const DWARFDIE &die) {
2236   DWARFRangeList func_ranges;
2237   const char *name = nullptr;
2238   const char *mangled = nullptr;
2239   int decl_file = 0;
2240   int decl_line = 0;
2241   int decl_column = 0;
2242   int call_file = 0;
2243   int call_line = 0;
2244   int call_column = 0;
2245   DWARFExpression frame_base;
2246 
2247   const dw_tag_t tag = die.Tag();
2248 
2249   if (tag != DW_TAG_subprogram)
2250     return nullptr;
2251 
2252   if (die.GetDIENamesAndRanges(name, mangled, func_ranges, decl_file, decl_line,
2253                                decl_column, call_file, call_line, call_column,
2254                                &frame_base)) {
2255 
2256     // Union of all ranges in the function DIE (if the function is
2257     // discontiguous)
2258     AddressRange func_range;
2259     lldb::addr_t lowest_func_addr = func_ranges.GetMinRangeBase(0);
2260     lldb::addr_t highest_func_addr = func_ranges.GetMaxRangeEnd(0);
2261     if (lowest_func_addr != LLDB_INVALID_ADDRESS &&
2262         lowest_func_addr <= highest_func_addr) {
2263       ModuleSP module_sp(die.GetModule());
2264       func_range.GetBaseAddress().ResolveAddressUsingFileSections(
2265           lowest_func_addr, module_sp->GetSectionList());
2266       if (func_range.GetBaseAddress().IsValid())
2267         func_range.SetByteSize(highest_func_addr - lowest_func_addr);
2268     }
2269 
2270     if (func_range.GetBaseAddress().IsValid()) {
2271       Mangled func_name;
2272       if (mangled)
2273         func_name.SetValue(ConstString(mangled), true);
2274       else if ((die.GetParent().Tag() == DW_TAG_compile_unit ||
2275                 die.GetParent().Tag() == DW_TAG_partial_unit) &&
2276                Language::LanguageIsCPlusPlus(
2277                    SymbolFileDWARF::GetLanguage(*die.GetCU())) &&
2278                !Language::LanguageIsObjC(
2279                    SymbolFileDWARF::GetLanguage(*die.GetCU())) &&
2280                name && strcmp(name, "main") != 0) {
2281         // If the mangled name is not present in the DWARF, generate the
2282         // demangled name using the decl context. We skip if the function is
2283         // "main" as its name is never mangled.
2284         bool is_static = false;
2285         bool is_variadic = false;
2286         bool has_template_params = false;
2287         unsigned type_quals = 0;
2288         std::vector<CompilerType> param_types;
2289         std::vector<clang::ParmVarDecl *> param_decls;
2290         StreamString sstr;
2291 
2292         DWARFDeclContext decl_ctx = SymbolFileDWARF::GetDWARFDeclContext(die);
2293         sstr << decl_ctx.GetQualifiedName();
2294 
2295         clang::DeclContext *containing_decl_ctx =
2296             GetClangDeclContextContainingDIE(die, nullptr);
2297         ParseChildParameters(containing_decl_ctx, die, true, is_static,
2298                              is_variadic, has_template_params, param_types,
2299                              param_decls, type_quals);
2300         sstr << "(";
2301         for (size_t i = 0; i < param_types.size(); i++) {
2302           if (i > 0)
2303             sstr << ", ";
2304           sstr << param_types[i].GetTypeName();
2305         }
2306         if (is_variadic)
2307           sstr << ", ...";
2308         sstr << ")";
2309         if (type_quals & clang::Qualifiers::Const)
2310           sstr << " const";
2311 
2312         func_name.SetValue(ConstString(sstr.GetString()), false);
2313       } else
2314         func_name.SetValue(ConstString(name), false);
2315 
2316       FunctionSP func_sp;
2317       std::unique_ptr<Declaration> decl_up;
2318       if (decl_file != 0 || decl_line != 0 || decl_column != 0)
2319         decl_up = std::make_unique<Declaration>(die.GetCU()->GetFile(decl_file),
2320                                                 decl_line, decl_column);
2321 
2322       SymbolFileDWARF *dwarf = die.GetDWARF();
2323       // Supply the type _only_ if it has already been parsed
2324       Type *func_type = dwarf->GetDIEToType().lookup(die.GetDIE());
2325 
2326       assert(func_type == nullptr || func_type != DIE_IS_BEING_PARSED);
2327 
2328       if (dwarf->FixupAddress(func_range.GetBaseAddress())) {
2329         const user_id_t func_user_id = die.GetID();
2330         func_sp =
2331             std::make_shared<Function>(&comp_unit,
2332                                    func_user_id, // UserID is the DIE offset
2333                                    func_user_id, func_name, func_type,
2334                                        func_range); // first address range
2335 
2336         if (func_sp.get() != nullptr) {
2337           if (frame_base.IsValid())
2338             func_sp->GetFrameBaseExpression() = frame_base;
2339           comp_unit.AddFunction(func_sp);
2340           return func_sp.get();
2341         }
2342       }
2343     }
2344   }
2345   return nullptr;
2346 }
2347 
2348 void DWARFASTParserClang::ParseSingleMember(
2349     const DWARFDIE &die, const DWARFDIE &parent_die,
2350     const lldb_private::CompilerType &class_clang_type,
2351     std::vector<int> &member_accessibilities,
2352     lldb::AccessType default_accessibility,
2353     DelayedPropertyList &delayed_properties,
2354     lldb_private::ClangASTImporter::LayoutInfo &layout_info,
2355     FieldInfo &last_field_info) {
2356   ModuleSP module_sp = parent_die.GetDWARF()->GetObjectFile()->GetModule();
2357   const dw_tag_t tag = die.Tag();
2358   // Get the parent byte size so we can verify any members will fit
2359   const uint64_t parent_byte_size =
2360       parent_die.GetAttributeValueAsUnsigned(DW_AT_byte_size, UINT64_MAX);
2361   const uint64_t parent_bit_size =
2362       parent_byte_size == UINT64_MAX ? UINT64_MAX : parent_byte_size * 8;
2363 
2364   DWARFAttributes attributes;
2365   const size_t num_attributes = die.GetAttributes(attributes);
2366   if (num_attributes == 0)
2367     return;
2368 
2369   const char *name = nullptr;
2370   const char *prop_name = nullptr;
2371   const char *prop_getter_name = nullptr;
2372   const char *prop_setter_name = nullptr;
2373   uint32_t prop_attributes = 0;
2374 
2375   bool is_artificial = false;
2376   DWARFFormValue encoding_form;
2377   AccessType accessibility = eAccessNone;
2378   uint32_t member_byte_offset =
2379       (parent_die.Tag() == DW_TAG_union_type) ? 0 : UINT32_MAX;
2380   llvm::Optional<uint64_t> byte_size;
2381   int64_t bit_offset = 0;
2382   uint64_t data_bit_offset = UINT64_MAX;
2383   size_t bit_size = 0;
2384   bool is_external =
2385       false; // On DW_TAG_members, this means the member is static
2386   uint32_t i;
2387   for (i = 0; i < num_attributes && !is_artificial; ++i) {
2388     const dw_attr_t attr = attributes.AttributeAtIndex(i);
2389     DWARFFormValue form_value;
2390     if (attributes.ExtractFormValueAtIndex(i, form_value)) {
2391       // DW_AT_data_member_location indicates the byte offset of the
2392       // word from the base address of the structure.
2393       //
2394       // DW_AT_bit_offset indicates how many bits into the word
2395       // (according to the host endianness) the low-order bit of the
2396       // field starts.  AT_bit_offset can be negative.
2397       //
2398       // DW_AT_bit_size indicates the size of the field in bits.
2399       switch (attr) {
2400       case DW_AT_name:
2401         name = form_value.AsCString();
2402         break;
2403       case DW_AT_type:
2404         encoding_form = form_value;
2405         break;
2406       case DW_AT_bit_offset:
2407         bit_offset = form_value.Signed();
2408         break;
2409       case DW_AT_bit_size:
2410         bit_size = form_value.Unsigned();
2411         break;
2412       case DW_AT_byte_size:
2413         byte_size = form_value.Unsigned();
2414         break;
2415       case DW_AT_data_bit_offset:
2416         data_bit_offset = form_value.Unsigned();
2417         break;
2418       case DW_AT_data_member_location:
2419         if (form_value.BlockData()) {
2420           Value initialValue(0);
2421           Value memberOffset(0);
2422           const DWARFDataExtractor &debug_info_data = die.GetData();
2423           uint32_t block_length = form_value.Unsigned();
2424           uint32_t block_offset =
2425               form_value.BlockData() - debug_info_data.GetDataStart();
2426           if (DWARFExpression::Evaluate(
2427                   nullptr, // ExecutionContext *
2428                   nullptr, // RegisterContext *
2429                   module_sp,
2430                   DataExtractor(debug_info_data, block_offset, block_length),
2431                   die.GetCU(), eRegisterKindDWARF, &initialValue, nullptr,
2432                   memberOffset, nullptr)) {
2433             member_byte_offset = memberOffset.ResolveValue(nullptr).UInt();
2434           }
2435         } else {
2436           // With DWARF 3 and later, if the value is an integer constant,
2437           // this form value is the offset in bytes from the beginning of
2438           // the containing entity.
2439           member_byte_offset = form_value.Unsigned();
2440         }
2441         break;
2442 
2443       case DW_AT_accessibility:
2444         accessibility = DW_ACCESS_to_AccessType(form_value.Unsigned());
2445         break;
2446       case DW_AT_artificial:
2447         is_artificial = form_value.Boolean();
2448         break;
2449       case DW_AT_APPLE_property_name:
2450         prop_name = form_value.AsCString();
2451         break;
2452       case DW_AT_APPLE_property_getter:
2453         prop_getter_name = form_value.AsCString();
2454         break;
2455       case DW_AT_APPLE_property_setter:
2456         prop_setter_name = form_value.AsCString();
2457         break;
2458       case DW_AT_APPLE_property_attribute:
2459         prop_attributes = form_value.Unsigned();
2460         break;
2461       case DW_AT_external:
2462         is_external = form_value.Boolean();
2463         break;
2464 
2465       default:
2466       case DW_AT_declaration:
2467       case DW_AT_description:
2468       case DW_AT_mutable:
2469       case DW_AT_visibility:
2470       case DW_AT_sibling:
2471         break;
2472       }
2473     }
2474   }
2475 
2476   if (prop_name) {
2477     ConstString fixed_setter;
2478 
2479     // Check if the property getter/setter were provided as full names.
2480     // We want basenames, so we extract them.
2481 
2482     if (prop_getter_name && prop_getter_name[0] == '-') {
2483       ObjCLanguage::MethodName prop_getter_method(prop_getter_name, true);
2484       prop_getter_name = prop_getter_method.GetSelector().GetCString();
2485     }
2486 
2487     if (prop_setter_name && prop_setter_name[0] == '-') {
2488       ObjCLanguage::MethodName prop_setter_method(prop_setter_name, true);
2489       prop_setter_name = prop_setter_method.GetSelector().GetCString();
2490     }
2491 
2492     // If the names haven't been provided, they need to be filled in.
2493 
2494     if (!prop_getter_name) {
2495       prop_getter_name = prop_name;
2496     }
2497     if (!prop_setter_name && prop_name[0] &&
2498         !(prop_attributes & DW_APPLE_PROPERTY_readonly)) {
2499       StreamString ss;
2500 
2501       ss.Printf("set%c%s:", toupper(prop_name[0]), &prop_name[1]);
2502 
2503       fixed_setter.SetString(ss.GetString());
2504       prop_setter_name = fixed_setter.GetCString();
2505     }
2506   }
2507 
2508   // Clang has a DWARF generation bug where sometimes it represents
2509   // fields that are references with bad byte size and bit size/offset
2510   // information such as:
2511   //
2512   //  DW_AT_byte_size( 0x00 )
2513   //  DW_AT_bit_size( 0x40 )
2514   //  DW_AT_bit_offset( 0xffffffffffffffc0 )
2515   //
2516   // So check the bit offset to make sure it is sane, and if the values
2517   // are not sane, remove them. If we don't do this then we will end up
2518   // with a crash if we try to use this type in an expression when clang
2519   // becomes unhappy with its recycled debug info.
2520 
2521   if (byte_size.getValueOr(0) == 0 && bit_offset < 0) {
2522     bit_size = 0;
2523     bit_offset = 0;
2524   }
2525 
2526   const bool class_is_objc_object_or_interface =
2527       TypeSystemClang::IsObjCObjectOrInterfaceType(class_clang_type);
2528 
2529   // FIXME: Make Clang ignore Objective-C accessibility for expressions
2530   if (class_is_objc_object_or_interface)
2531     accessibility = eAccessNone;
2532 
2533   // Handle static members
2534   if (is_external && member_byte_offset == UINT32_MAX) {
2535     Type *var_type = die.ResolveTypeUID(encoding_form.Reference());
2536 
2537     if (var_type) {
2538       if (accessibility == eAccessNone)
2539         accessibility = eAccessPublic;
2540       TypeSystemClang::AddVariableToRecordType(
2541           class_clang_type, name, var_type->GetForwardCompilerType(),
2542           accessibility);
2543     }
2544     return;
2545   }
2546 
2547   if (!is_artificial) {
2548     Type *member_type = die.ResolveTypeUID(encoding_form.Reference());
2549 
2550     clang::FieldDecl *field_decl = nullptr;
2551     const uint64_t character_width = 8;
2552     const uint64_t word_width = 32;
2553     if (tag == DW_TAG_member) {
2554       if (member_type) {
2555         CompilerType member_clang_type = member_type->GetLayoutCompilerType();
2556 
2557         if (accessibility == eAccessNone)
2558           accessibility = default_accessibility;
2559         member_accessibilities.push_back(accessibility);
2560 
2561         uint64_t field_bit_offset =
2562             (member_byte_offset == UINT32_MAX ? 0 : (member_byte_offset * 8));
2563 
2564         if (bit_size > 0) {
2565           FieldInfo this_field_info;
2566           this_field_info.bit_offset = field_bit_offset;
2567           this_field_info.bit_size = bit_size;
2568 
2569           if (data_bit_offset != UINT64_MAX) {
2570             this_field_info.bit_offset = data_bit_offset;
2571           } else {
2572             if (!byte_size)
2573               byte_size = member_type->GetByteSize(nullptr);
2574 
2575             ObjectFile *objfile = die.GetDWARF()->GetObjectFile();
2576             if (objfile->GetByteOrder() == eByteOrderLittle) {
2577               this_field_info.bit_offset += byte_size.getValueOr(0) * 8;
2578               this_field_info.bit_offset -= (bit_offset + bit_size);
2579             } else {
2580               this_field_info.bit_offset += bit_offset;
2581             }
2582           }
2583 
2584           // The ObjC runtime knows the byte offset but we still need to provide
2585           // the bit-offset in the layout. It just means something different then
2586           // what it does in C and C++. So we skip this check for ObjC types.
2587           //
2588           // We also skip this for fields of a union since they will all have a
2589           // zero offset.
2590           if (!TypeSystemClang::IsObjCObjectOrInterfaceType(class_clang_type) &&
2591               !(parent_die.Tag() == DW_TAG_union_type && this_field_info.bit_offset == 0) &&
2592               ((this_field_info.bit_offset >= parent_bit_size) ||
2593                (last_field_info.IsBitfield() &&
2594                 !last_field_info.NextBitfieldOffsetIsValid(
2595                     this_field_info.bit_offset)))) {
2596             ObjectFile *objfile = die.GetDWARF()->GetObjectFile();
2597             objfile->GetModule()->ReportWarning(
2598                 "0x%8.8" PRIx64 ": %s bitfield named \"%s\" has invalid "
2599                 "bit offset (0x%8.8" PRIx64
2600                 ") member will be ignored. Please file a bug against the "
2601                 "compiler and include the preprocessed output for %s\n",
2602                 die.GetID(), DW_TAG_value_to_name(tag), name,
2603                 this_field_info.bit_offset, GetUnitName(parent_die).c_str());
2604             return;
2605           }
2606 
2607           // Update the field bit offset we will report for layout
2608           field_bit_offset = this_field_info.bit_offset;
2609 
2610           // Objective-C has invalid DW_AT_bit_offset values in older
2611           // versions of clang, so we have to be careful and only insert
2612           // unnamed bitfields if we have a new enough clang.
2613           bool detect_unnamed_bitfields = true;
2614 
2615           if (class_is_objc_object_or_interface)
2616             detect_unnamed_bitfields =
2617                 die.GetCU()->Supports_unnamed_objc_bitfields();
2618 
2619           if (detect_unnamed_bitfields) {
2620             clang::Optional<FieldInfo> unnamed_field_info;
2621             uint64_t last_field_end = 0;
2622 
2623             last_field_end =
2624                 last_field_info.bit_offset + last_field_info.bit_size;
2625 
2626             if (!last_field_info.IsBitfield()) {
2627               // The last field was not a bit-field...
2628               // but if it did take up the entire word then we need to extend
2629               // last_field_end so the bit-field does not step into the last
2630               // fields padding.
2631               if (last_field_end != 0 && ((last_field_end % word_width) != 0))
2632                 last_field_end += word_width - (last_field_end % word_width);
2633             }
2634 
2635             // If we have a gap between the last_field_end and the current
2636             // field we have an unnamed bit-field.
2637             // If we have a base class, we assume there is no unnamed
2638             // bit-field if this is the first field since the gap can be
2639             // attributed to the members from the base class. This assumption
2640             // is not correct if the first field of the derived class is
2641             // indeed an unnamed bit-field. We currently do not have the
2642             // machinary to track the offset of the last field of classes we
2643             // have seen before, so we are not handling this case.
2644             if (this_field_info.bit_offset != last_field_end &&
2645                 this_field_info.bit_offset > last_field_end &&
2646                 !(last_field_info.bit_offset == 0 &&
2647                   last_field_info.bit_size == 0 &&
2648                   layout_info.base_offsets.size() != 0)) {
2649               unnamed_field_info = FieldInfo{};
2650               unnamed_field_info->bit_size =
2651                   this_field_info.bit_offset - last_field_end;
2652               unnamed_field_info->bit_offset = last_field_end;
2653             }
2654 
2655             if (unnamed_field_info) {
2656               clang::FieldDecl *unnamed_bitfield_decl =
2657                   TypeSystemClang::AddFieldToRecordType(
2658                       class_clang_type, llvm::StringRef(),
2659                       m_ast.GetBuiltinTypeForEncodingAndBitSize(eEncodingSint,
2660                                                                 word_width),
2661                       accessibility, unnamed_field_info->bit_size);
2662 
2663               layout_info.field_offsets.insert(std::make_pair(
2664                   unnamed_bitfield_decl, unnamed_field_info->bit_offset));
2665             }
2666           }
2667 
2668           last_field_info = this_field_info;
2669           last_field_info.SetIsBitfield(true);
2670         } else {
2671           last_field_info.bit_offset = field_bit_offset;
2672 
2673           if (llvm::Optional<uint64_t> clang_type_size =
2674                   member_type->GetByteSize(nullptr)) {
2675             last_field_info.bit_size = *clang_type_size * character_width;
2676           }
2677 
2678           last_field_info.SetIsBitfield(false);
2679         }
2680 
2681         if (!member_clang_type.IsCompleteType())
2682           member_clang_type.GetCompleteType();
2683 
2684         {
2685           // Older versions of clang emit array[0] and array[1] in the
2686           // same way (<rdar://problem/12566646>). If the current field
2687           // is at the end of the structure, then there is definitely no
2688           // room for extra elements and we override the type to
2689           // array[0].
2690 
2691           CompilerType member_array_element_type;
2692           uint64_t member_array_size;
2693           bool member_array_is_incomplete;
2694 
2695           if (member_clang_type.IsArrayType(&member_array_element_type,
2696                                             &member_array_size,
2697                                             &member_array_is_incomplete) &&
2698               !member_array_is_incomplete) {
2699             uint64_t parent_byte_size =
2700                 parent_die.GetAttributeValueAsUnsigned(DW_AT_byte_size,
2701                                                        UINT64_MAX);
2702 
2703             if (member_byte_offset >= parent_byte_size) {
2704               if (member_array_size != 1 &&
2705                   (member_array_size != 0 ||
2706                    member_byte_offset > parent_byte_size)) {
2707                 module_sp->ReportError(
2708                     "0x%8.8" PRIx64
2709                     ": DW_TAG_member '%s' refers to type 0x%8.8x"
2710                     " which extends beyond the bounds of 0x%8.8" PRIx64,
2711                     die.GetID(), name, encoding_form.Reference().GetOffset(),
2712                     parent_die.GetID());
2713               }
2714 
2715               member_clang_type =
2716                   m_ast.CreateArrayType(member_array_element_type, 0, false);
2717             }
2718           }
2719         }
2720 
2721         RequireCompleteType(member_clang_type);
2722 
2723         field_decl = TypeSystemClang::AddFieldToRecordType(
2724             class_clang_type, name, member_clang_type, accessibility,
2725             bit_size);
2726 
2727         m_ast.SetMetadataAsUserID(field_decl, die.GetID());
2728 
2729         layout_info.field_offsets.insert(
2730             std::make_pair(field_decl, field_bit_offset));
2731       } else {
2732         if (name)
2733           module_sp->ReportError(
2734               "0x%8.8" PRIx64 ": DW_TAG_member '%s' refers to type 0x%8.8x"
2735               " which was unable to be parsed",
2736               die.GetID(), name, encoding_form.Reference().GetOffset());
2737         else
2738           module_sp->ReportError(
2739               "0x%8.8" PRIx64 ": DW_TAG_member refers to type 0x%8.8x"
2740               " which was unable to be parsed",
2741               die.GetID(), encoding_form.Reference().GetOffset());
2742       }
2743     }
2744 
2745     if (prop_name != nullptr && member_type) {
2746       clang::ObjCIvarDecl *ivar_decl = nullptr;
2747 
2748       if (field_decl) {
2749         ivar_decl = clang::dyn_cast<clang::ObjCIvarDecl>(field_decl);
2750         assert(ivar_decl != nullptr);
2751       }
2752 
2753       ClangASTMetadata metadata;
2754       metadata.SetUserID(die.GetID());
2755       delayed_properties.push_back(DelayedAddObjCClassProperty(
2756           class_clang_type, prop_name, member_type->GetLayoutCompilerType(),
2757           ivar_decl, prop_setter_name, prop_getter_name, prop_attributes,
2758           &metadata));
2759 
2760       if (ivar_decl)
2761         m_ast.SetMetadataAsUserID(ivar_decl, die.GetID());
2762     }
2763   }
2764 }
2765 
2766 bool DWARFASTParserClang::ParseChildMembers(
2767     const DWARFDIE &parent_die, CompilerType &class_clang_type,
2768     std::vector<std::unique_ptr<clang::CXXBaseSpecifier>> &base_classes,
2769     std::vector<int> &member_accessibilities,
2770     std::vector<DWARFDIE> &member_function_dies,
2771     DelayedPropertyList &delayed_properties, AccessType &default_accessibility,
2772     bool &is_a_class, ClangASTImporter::LayoutInfo &layout_info) {
2773   if (!parent_die)
2774     return false;
2775 
2776   FieldInfo last_field_info;
2777 
2778   ModuleSP module_sp = parent_die.GetDWARF()->GetObjectFile()->GetModule();
2779   TypeSystemClang *ast =
2780       llvm::dyn_cast_or_null<TypeSystemClang>(class_clang_type.GetTypeSystem());
2781   if (ast == nullptr)
2782     return false;
2783 
2784   for (DWARFDIE die = parent_die.GetFirstChild(); die.IsValid();
2785        die = die.GetSibling()) {
2786     dw_tag_t tag = die.Tag();
2787 
2788     switch (tag) {
2789     case DW_TAG_member:
2790     case DW_TAG_APPLE_property:
2791       ParseSingleMember(die, parent_die, class_clang_type,
2792                         member_accessibilities, default_accessibility,
2793                         delayed_properties, layout_info, last_field_info);
2794       break;
2795 
2796     case DW_TAG_subprogram:
2797       // Let the type parsing code handle this one for us.
2798       member_function_dies.push_back(die);
2799       break;
2800 
2801     case DW_TAG_inheritance: {
2802       is_a_class = true;
2803       if (default_accessibility == eAccessNone)
2804         default_accessibility = eAccessPrivate;
2805       // TODO: implement DW_TAG_inheritance type parsing
2806       DWARFAttributes attributes;
2807       const size_t num_attributes = die.GetAttributes(attributes);
2808       if (num_attributes > 0) {
2809         DWARFFormValue encoding_form;
2810         AccessType accessibility = default_accessibility;
2811         bool is_virtual = false;
2812         bool is_base_of_class = true;
2813         off_t member_byte_offset = 0;
2814         uint32_t i;
2815         for (i = 0; i < num_attributes; ++i) {
2816           const dw_attr_t attr = attributes.AttributeAtIndex(i);
2817           DWARFFormValue form_value;
2818           if (attributes.ExtractFormValueAtIndex(i, form_value)) {
2819             switch (attr) {
2820             case DW_AT_type:
2821               encoding_form = form_value;
2822               break;
2823             case DW_AT_data_member_location:
2824               if (form_value.BlockData()) {
2825                 Value initialValue(0);
2826                 Value memberOffset(0);
2827                 const DWARFDataExtractor &debug_info_data = die.GetData();
2828                 uint32_t block_length = form_value.Unsigned();
2829                 uint32_t block_offset =
2830                     form_value.BlockData() - debug_info_data.GetDataStart();
2831                 if (DWARFExpression::Evaluate(
2832                         nullptr, nullptr, module_sp,
2833                         DataExtractor(debug_info_data, block_offset,
2834                                       block_length),
2835                         die.GetCU(), eRegisterKindDWARF, &initialValue, nullptr,
2836                         memberOffset, nullptr)) {
2837                   member_byte_offset =
2838                       memberOffset.ResolveValue(nullptr).UInt();
2839                 }
2840               } else {
2841                 // With DWARF 3 and later, if the value is an integer constant,
2842                 // this form value is the offset in bytes from the beginning of
2843                 // the containing entity.
2844                 member_byte_offset = form_value.Unsigned();
2845               }
2846               break;
2847 
2848             case DW_AT_accessibility:
2849               accessibility = DW_ACCESS_to_AccessType(form_value.Unsigned());
2850               break;
2851 
2852             case DW_AT_virtuality:
2853               is_virtual = form_value.Boolean();
2854               break;
2855 
2856             case DW_AT_sibling:
2857               break;
2858 
2859             default:
2860               break;
2861             }
2862           }
2863         }
2864 
2865         Type *base_class_type = die.ResolveTypeUID(encoding_form.Reference());
2866         if (base_class_type == nullptr) {
2867           module_sp->ReportError("0x%8.8x: DW_TAG_inheritance failed to "
2868                                  "resolve the base class at 0x%8.8x"
2869                                  " from enclosing type 0x%8.8x. \nPlease file "
2870                                  "a bug and attach the file at the start of "
2871                                  "this error message",
2872                                  die.GetOffset(),
2873                                  encoding_form.Reference().GetOffset(),
2874                                  parent_die.GetOffset());
2875           break;
2876         }
2877 
2878         CompilerType base_class_clang_type =
2879             base_class_type->GetFullCompilerType();
2880         assert(base_class_clang_type);
2881         if (TypeSystemClang::IsObjCObjectOrInterfaceType(class_clang_type)) {
2882           ast->SetObjCSuperClass(class_clang_type, base_class_clang_type);
2883         } else {
2884           std::unique_ptr<clang::CXXBaseSpecifier> result =
2885               ast->CreateBaseClassSpecifier(
2886                   base_class_clang_type.GetOpaqueQualType(), accessibility,
2887                   is_virtual, is_base_of_class);
2888           if (!result)
2889             break;
2890 
2891           base_classes.push_back(std::move(result));
2892 
2893           if (is_virtual) {
2894             // Do not specify any offset for virtual inheritance. The DWARF
2895             // produced by clang doesn't give us a constant offset, but gives
2896             // us a DWARF expressions that requires an actual object in memory.
2897             // the DW_AT_data_member_location for a virtual base class looks
2898             // like:
2899             //      DW_AT_data_member_location( DW_OP_dup, DW_OP_deref,
2900             //      DW_OP_constu(0x00000018), DW_OP_minus, DW_OP_deref,
2901             //      DW_OP_plus )
2902             // Given this, there is really no valid response we can give to
2903             // clang for virtual base class offsets, and this should eventually
2904             // be removed from LayoutRecordType() in the external
2905             // AST source in clang.
2906           } else {
2907             layout_info.base_offsets.insert(std::make_pair(
2908                 ast->GetAsCXXRecordDecl(
2909                     base_class_clang_type.GetOpaqueQualType()),
2910                 clang::CharUnits::fromQuantity(member_byte_offset)));
2911           }
2912         }
2913       }
2914     } break;
2915 
2916     default:
2917       break;
2918     }
2919   }
2920 
2921   return true;
2922 }
2923 
2924 size_t DWARFASTParserClang::ParseChildParameters(
2925     clang::DeclContext *containing_decl_ctx, const DWARFDIE &parent_die,
2926     bool skip_artificial, bool &is_static, bool &is_variadic,
2927     bool &has_template_params, std::vector<CompilerType> &function_param_types,
2928     std::vector<clang::ParmVarDecl *> &function_param_decls,
2929     unsigned &type_quals) {
2930   if (!parent_die)
2931     return 0;
2932 
2933   size_t arg_idx = 0;
2934   for (DWARFDIE die = parent_die.GetFirstChild(); die.IsValid();
2935        die = die.GetSibling()) {
2936     const dw_tag_t tag = die.Tag();
2937     switch (tag) {
2938     case DW_TAG_formal_parameter: {
2939       DWARFAttributes attributes;
2940       const size_t num_attributes = die.GetAttributes(attributes);
2941       if (num_attributes > 0) {
2942         const char *name = nullptr;
2943         DWARFFormValue param_type_die_form;
2944         bool is_artificial = false;
2945         // one of None, Auto, Register, Extern, Static, PrivateExtern
2946 
2947         clang::StorageClass storage = clang::SC_None;
2948         uint32_t i;
2949         for (i = 0; i < num_attributes; ++i) {
2950           const dw_attr_t attr = attributes.AttributeAtIndex(i);
2951           DWARFFormValue form_value;
2952           if (attributes.ExtractFormValueAtIndex(i, form_value)) {
2953             switch (attr) {
2954             case DW_AT_name:
2955               name = form_value.AsCString();
2956               break;
2957             case DW_AT_type:
2958               param_type_die_form = form_value;
2959               break;
2960             case DW_AT_artificial:
2961               is_artificial = form_value.Boolean();
2962               break;
2963             case DW_AT_location:
2964             case DW_AT_const_value:
2965             case DW_AT_default_value:
2966             case DW_AT_description:
2967             case DW_AT_endianity:
2968             case DW_AT_is_optional:
2969             case DW_AT_segment:
2970             case DW_AT_variable_parameter:
2971             default:
2972             case DW_AT_abstract_origin:
2973             case DW_AT_sibling:
2974               break;
2975             }
2976           }
2977         }
2978 
2979         bool skip = false;
2980         if (skip_artificial && is_artificial) {
2981           // In order to determine if a C++ member function is "const" we
2982           // have to look at the const-ness of "this"...
2983           if (arg_idx == 0 &&
2984               DeclKindIsCXXClass(containing_decl_ctx->getDeclKind()) &&
2985               // Often times compilers omit the "this" name for the
2986               // specification DIEs, so we can't rely upon the name being in
2987               // the formal parameter DIE...
2988               (name == nullptr || ::strcmp(name, "this") == 0)) {
2989             Type *this_type =
2990                 die.ResolveTypeUID(param_type_die_form.Reference());
2991             if (this_type) {
2992               uint32_t encoding_mask = this_type->GetEncodingMask();
2993               if (encoding_mask & Type::eEncodingIsPointerUID) {
2994                 is_static = false;
2995 
2996                 if (encoding_mask & (1u << Type::eEncodingIsConstUID))
2997                   type_quals |= clang::Qualifiers::Const;
2998                 if (encoding_mask & (1u << Type::eEncodingIsVolatileUID))
2999                   type_quals |= clang::Qualifiers::Volatile;
3000               }
3001             }
3002           }
3003           skip = true;
3004         }
3005 
3006         if (!skip) {
3007           Type *type = die.ResolveTypeUID(param_type_die_form.Reference());
3008           if (type) {
3009             function_param_types.push_back(type->GetForwardCompilerType());
3010 
3011             clang::ParmVarDecl *param_var_decl =
3012                 m_ast.CreateParameterDeclaration(
3013                     containing_decl_ctx, GetOwningClangModule(die), name,
3014                     type->GetForwardCompilerType(), storage);
3015             assert(param_var_decl);
3016             function_param_decls.push_back(param_var_decl);
3017 
3018             m_ast.SetMetadataAsUserID(param_var_decl, die.GetID());
3019           }
3020         }
3021       }
3022       arg_idx++;
3023     } break;
3024 
3025     case DW_TAG_unspecified_parameters:
3026       is_variadic = true;
3027       break;
3028 
3029     case DW_TAG_template_type_parameter:
3030     case DW_TAG_template_value_parameter:
3031     case DW_TAG_GNU_template_parameter_pack:
3032       // The one caller of this was never using the template_param_infos, and
3033       // the local variable was taking up a large amount of stack space in
3034       // SymbolFileDWARF::ParseType() so this was removed. If we ever need the
3035       // template params back, we can add them back.
3036       // ParseTemplateDIE (dwarf_cu, die, template_param_infos);
3037       has_template_params = true;
3038       break;
3039 
3040     default:
3041       break;
3042     }
3043   }
3044   return arg_idx;
3045 }
3046 
3047 llvm::Optional<SymbolFile::ArrayInfo>
3048 DWARFASTParser::ParseChildArrayInfo(const DWARFDIE &parent_die,
3049                                     const ExecutionContext *exe_ctx) {
3050   SymbolFile::ArrayInfo array_info;
3051   if (!parent_die)
3052     return llvm::None;
3053 
3054   for (DWARFDIE die = parent_die.GetFirstChild(); die.IsValid();
3055        die = die.GetSibling()) {
3056     const dw_tag_t tag = die.Tag();
3057     if (tag != DW_TAG_subrange_type)
3058       continue;
3059 
3060     DWARFAttributes attributes;
3061     const size_t num_child_attributes = die.GetAttributes(attributes);
3062     if (num_child_attributes > 0) {
3063       uint64_t num_elements = 0;
3064       uint64_t lower_bound = 0;
3065       uint64_t upper_bound = 0;
3066       bool upper_bound_valid = false;
3067       uint32_t i;
3068       for (i = 0; i < num_child_attributes; ++i) {
3069         const dw_attr_t attr = attributes.AttributeAtIndex(i);
3070         DWARFFormValue form_value;
3071         if (attributes.ExtractFormValueAtIndex(i, form_value)) {
3072           switch (attr) {
3073           case DW_AT_name:
3074             break;
3075 
3076           case DW_AT_count:
3077             if (DWARFDIE var_die = die.GetReferencedDIE(DW_AT_count)) {
3078               if (var_die.Tag() == DW_TAG_variable)
3079                 if (exe_ctx) {
3080                   if (auto frame = exe_ctx->GetFrameSP()) {
3081                     Status error;
3082                     lldb::VariableSP var_sp;
3083                     auto valobj_sp = frame->GetValueForVariableExpressionPath(
3084                         var_die.GetName(), eNoDynamicValues, 0, var_sp,
3085                         error);
3086                     if (valobj_sp) {
3087                       num_elements = valobj_sp->GetValueAsUnsigned(0);
3088                       break;
3089                     }
3090                   }
3091                 }
3092             } else
3093               num_elements = form_value.Unsigned();
3094             break;
3095 
3096           case DW_AT_bit_stride:
3097             array_info.bit_stride = form_value.Unsigned();
3098             break;
3099 
3100           case DW_AT_byte_stride:
3101             array_info.byte_stride = form_value.Unsigned();
3102             break;
3103 
3104           case DW_AT_lower_bound:
3105             lower_bound = form_value.Unsigned();
3106             break;
3107 
3108           case DW_AT_upper_bound:
3109             upper_bound_valid = true;
3110             upper_bound = form_value.Unsigned();
3111             break;
3112 
3113           default:
3114           case DW_AT_abstract_origin:
3115           case DW_AT_accessibility:
3116           case DW_AT_allocated:
3117           case DW_AT_associated:
3118           case DW_AT_data_location:
3119           case DW_AT_declaration:
3120           case DW_AT_description:
3121           case DW_AT_sibling:
3122           case DW_AT_threads_scaled:
3123           case DW_AT_type:
3124           case DW_AT_visibility:
3125             break;
3126           }
3127         }
3128       }
3129 
3130       if (num_elements == 0) {
3131         if (upper_bound_valid && upper_bound >= lower_bound)
3132           num_elements = upper_bound - lower_bound + 1;
3133       }
3134 
3135       array_info.element_orders.push_back(num_elements);
3136     }
3137   }
3138   return array_info;
3139 }
3140 
3141 Type *DWARFASTParserClang::GetTypeForDIE(const DWARFDIE &die) {
3142   if (die) {
3143     SymbolFileDWARF *dwarf = die.GetDWARF();
3144     DWARFAttributes attributes;
3145     const size_t num_attributes = die.GetAttributes(attributes);
3146     if (num_attributes > 0) {
3147       DWARFFormValue type_die_form;
3148       for (size_t i = 0; i < num_attributes; ++i) {
3149         dw_attr_t attr = attributes.AttributeAtIndex(i);
3150         DWARFFormValue form_value;
3151 
3152         if (attr == DW_AT_type &&
3153             attributes.ExtractFormValueAtIndex(i, form_value))
3154           return dwarf->ResolveTypeUID(form_value.Reference(), true);
3155       }
3156     }
3157   }
3158 
3159   return nullptr;
3160 }
3161 
3162 clang::Decl *DWARFASTParserClang::GetClangDeclForDIE(const DWARFDIE &die) {
3163   if (!die)
3164     return nullptr;
3165 
3166   switch (die.Tag()) {
3167   case DW_TAG_variable:
3168   case DW_TAG_constant:
3169   case DW_TAG_formal_parameter:
3170   case DW_TAG_imported_declaration:
3171   case DW_TAG_imported_module:
3172     break;
3173   default:
3174     return nullptr;
3175   }
3176 
3177   DIEToDeclMap::iterator cache_pos = m_die_to_decl.find(die.GetDIE());
3178   if (cache_pos != m_die_to_decl.end())
3179     return cache_pos->second;
3180 
3181   if (DWARFDIE spec_die = die.GetReferencedDIE(DW_AT_specification)) {
3182     clang::Decl *decl = GetClangDeclForDIE(spec_die);
3183     m_die_to_decl[die.GetDIE()] = decl;
3184     m_decl_to_die[decl].insert(die.GetDIE());
3185     return decl;
3186   }
3187 
3188   if (DWARFDIE abstract_origin_die =
3189           die.GetReferencedDIE(DW_AT_abstract_origin)) {
3190     clang::Decl *decl = GetClangDeclForDIE(abstract_origin_die);
3191     m_die_to_decl[die.GetDIE()] = decl;
3192     m_decl_to_die[decl].insert(die.GetDIE());
3193     return decl;
3194   }
3195 
3196   clang::Decl *decl = nullptr;
3197   switch (die.Tag()) {
3198   case DW_TAG_variable:
3199   case DW_TAG_constant:
3200   case DW_TAG_formal_parameter: {
3201     SymbolFileDWARF *dwarf = die.GetDWARF();
3202     Type *type = GetTypeForDIE(die);
3203     if (dwarf && type) {
3204       const char *name = die.GetName();
3205       clang::DeclContext *decl_context =
3206           TypeSystemClang::DeclContextGetAsDeclContext(
3207               dwarf->GetDeclContextContainingUID(die.GetID()));
3208       decl = m_ast.CreateVariableDeclaration(
3209           decl_context, GetOwningClangModule(die), name,
3210           ClangUtil::GetQualType(type->GetForwardCompilerType()));
3211     }
3212     break;
3213   }
3214   case DW_TAG_imported_declaration: {
3215     SymbolFileDWARF *dwarf = die.GetDWARF();
3216     DWARFDIE imported_uid = die.GetAttributeValueAsReferenceDIE(DW_AT_import);
3217     if (imported_uid) {
3218       CompilerDecl imported_decl = SymbolFileDWARF::GetDecl(imported_uid);
3219       if (imported_decl) {
3220         clang::DeclContext *decl_context =
3221             TypeSystemClang::DeclContextGetAsDeclContext(
3222                 dwarf->GetDeclContextContainingUID(die.GetID()));
3223         if (clang::NamedDecl *clang_imported_decl =
3224                 llvm::dyn_cast<clang::NamedDecl>(
3225                     (clang::Decl *)imported_decl.GetOpaqueDecl()))
3226           decl = m_ast.CreateUsingDeclaration(
3227               decl_context, OptionalClangModuleID(), clang_imported_decl);
3228       }
3229     }
3230     break;
3231   }
3232   case DW_TAG_imported_module: {
3233     SymbolFileDWARF *dwarf = die.GetDWARF();
3234     DWARFDIE imported_uid = die.GetAttributeValueAsReferenceDIE(DW_AT_import);
3235 
3236     if (imported_uid) {
3237       CompilerDeclContext imported_decl_ctx =
3238           SymbolFileDWARF::GetDeclContext(imported_uid);
3239       if (imported_decl_ctx) {
3240         clang::DeclContext *decl_context =
3241             TypeSystemClang::DeclContextGetAsDeclContext(
3242                 dwarf->GetDeclContextContainingUID(die.GetID()));
3243         if (clang::NamespaceDecl *ns_decl =
3244                 TypeSystemClang::DeclContextGetAsNamespaceDecl(
3245                     imported_decl_ctx))
3246           decl = m_ast.CreateUsingDirectiveDeclaration(
3247               decl_context, OptionalClangModuleID(), ns_decl);
3248       }
3249     }
3250     break;
3251   }
3252   default:
3253     break;
3254   }
3255 
3256   m_die_to_decl[die.GetDIE()] = decl;
3257   m_decl_to_die[decl].insert(die.GetDIE());
3258 
3259   return decl;
3260 }
3261 
3262 clang::DeclContext *
3263 DWARFASTParserClang::GetClangDeclContextForDIE(const DWARFDIE &die) {
3264   if (die) {
3265     clang::DeclContext *decl_ctx = GetCachedClangDeclContextForDIE(die);
3266     if (decl_ctx)
3267       return decl_ctx;
3268 
3269     bool try_parsing_type = true;
3270     switch (die.Tag()) {
3271     case DW_TAG_compile_unit:
3272     case DW_TAG_partial_unit:
3273       decl_ctx = m_ast.GetTranslationUnitDecl();
3274       try_parsing_type = false;
3275       break;
3276 
3277     case DW_TAG_namespace:
3278       decl_ctx = ResolveNamespaceDIE(die);
3279       try_parsing_type = false;
3280       break;
3281 
3282     case DW_TAG_lexical_block:
3283       decl_ctx = GetDeclContextForBlock(die);
3284       try_parsing_type = false;
3285       break;
3286 
3287     default:
3288       break;
3289     }
3290 
3291     if (decl_ctx == nullptr && try_parsing_type) {
3292       Type *type = die.GetDWARF()->ResolveType(die);
3293       if (type)
3294         decl_ctx = GetCachedClangDeclContextForDIE(die);
3295     }
3296 
3297     if (decl_ctx) {
3298       LinkDeclContextToDIE(decl_ctx, die);
3299       return decl_ctx;
3300     }
3301   }
3302   return nullptr;
3303 }
3304 
3305 OptionalClangModuleID
3306 DWARFASTParserClang::GetOwningClangModule(const DWARFDIE &die) {
3307   if (!die.IsValid())
3308     return {};
3309 
3310   for (DWARFDIE parent = die.GetParent(); parent.IsValid();
3311        parent = parent.GetParent()) {
3312     const dw_tag_t tag = parent.Tag();
3313     if (tag == DW_TAG_module) {
3314       DWARFDIE module_die = parent;
3315       auto it = m_die_to_module.find(module_die.GetDIE());
3316       if (it != m_die_to_module.end())
3317         return it->second;
3318       const char *name = module_die.GetAttributeValueAsString(DW_AT_name, 0);
3319       if (!name)
3320         return {};
3321 
3322       OptionalClangModuleID id =
3323           m_ast.GetOrCreateClangModule(name, GetOwningClangModule(module_die));
3324       m_die_to_module.insert({module_die.GetDIE(), id});
3325       return id;
3326     }
3327   }
3328   return {};
3329 }
3330 
3331 static bool IsSubroutine(const DWARFDIE &die) {
3332   switch (die.Tag()) {
3333   case DW_TAG_subprogram:
3334   case DW_TAG_inlined_subroutine:
3335     return true;
3336   default:
3337     return false;
3338   }
3339 }
3340 
3341 static DWARFDIE GetContainingFunctionWithAbstractOrigin(const DWARFDIE &die) {
3342   for (DWARFDIE candidate = die; candidate; candidate = candidate.GetParent()) {
3343     if (IsSubroutine(candidate)) {
3344       if (candidate.GetReferencedDIE(DW_AT_abstract_origin)) {
3345         return candidate;
3346       } else {
3347         return DWARFDIE();
3348       }
3349     }
3350   }
3351   assert(0 && "Shouldn't call GetContainingFunctionWithAbstractOrigin on "
3352               "something not in a function");
3353   return DWARFDIE();
3354 }
3355 
3356 static DWARFDIE FindAnyChildWithAbstractOrigin(const DWARFDIE &context) {
3357   for (DWARFDIE candidate = context.GetFirstChild(); candidate.IsValid();
3358        candidate = candidate.GetSibling()) {
3359     if (candidate.GetReferencedDIE(DW_AT_abstract_origin)) {
3360       return candidate;
3361     }
3362   }
3363   return DWARFDIE();
3364 }
3365 
3366 static DWARFDIE FindFirstChildWithAbstractOrigin(const DWARFDIE &block,
3367                                                  const DWARFDIE &function) {
3368   assert(IsSubroutine(function));
3369   for (DWARFDIE context = block; context != function.GetParent();
3370        context = context.GetParent()) {
3371     assert(!IsSubroutine(context) || context == function);
3372     if (DWARFDIE child = FindAnyChildWithAbstractOrigin(context)) {
3373       return child;
3374     }
3375   }
3376   return DWARFDIE();
3377 }
3378 
3379 clang::DeclContext *
3380 DWARFASTParserClang::GetDeclContextForBlock(const DWARFDIE &die) {
3381   assert(die.Tag() == DW_TAG_lexical_block);
3382   DWARFDIE containing_function_with_abstract_origin =
3383       GetContainingFunctionWithAbstractOrigin(die);
3384   if (!containing_function_with_abstract_origin) {
3385     return (clang::DeclContext *)ResolveBlockDIE(die);
3386   }
3387   DWARFDIE child = FindFirstChildWithAbstractOrigin(
3388       die, containing_function_with_abstract_origin);
3389   CompilerDeclContext decl_context =
3390       GetDeclContextContainingUIDFromDWARF(child);
3391   return (clang::DeclContext *)decl_context.GetOpaqueDeclContext();
3392 }
3393 
3394 clang::BlockDecl *DWARFASTParserClang::ResolveBlockDIE(const DWARFDIE &die) {
3395   if (die && die.Tag() == DW_TAG_lexical_block) {
3396     clang::BlockDecl *decl =
3397         llvm::cast_or_null<clang::BlockDecl>(m_die_to_decl_ctx[die.GetDIE()]);
3398 
3399     if (!decl) {
3400       DWARFDIE decl_context_die;
3401       clang::DeclContext *decl_context =
3402           GetClangDeclContextContainingDIE(die, &decl_context_die);
3403       decl =
3404           m_ast.CreateBlockDeclaration(decl_context, GetOwningClangModule(die));
3405 
3406       if (decl)
3407         LinkDeclContextToDIE((clang::DeclContext *)decl, die);
3408     }
3409 
3410     return decl;
3411   }
3412   return nullptr;
3413 }
3414 
3415 clang::NamespaceDecl *
3416 DWARFASTParserClang::ResolveNamespaceDIE(const DWARFDIE &die) {
3417   if (die && die.Tag() == DW_TAG_namespace) {
3418     // See if we already parsed this namespace DIE and associated it with a
3419     // uniqued namespace declaration
3420     clang::NamespaceDecl *namespace_decl =
3421         static_cast<clang::NamespaceDecl *>(m_die_to_decl_ctx[die.GetDIE()]);
3422     if (namespace_decl)
3423       return namespace_decl;
3424     else {
3425       const char *namespace_name = die.GetName();
3426       clang::DeclContext *containing_decl_ctx =
3427           GetClangDeclContextContainingDIE(die, nullptr);
3428       bool is_inline =
3429           die.GetAttributeValueAsUnsigned(DW_AT_export_symbols, 0) != 0;
3430 
3431       namespace_decl = m_ast.GetUniqueNamespaceDeclaration(
3432           namespace_name, containing_decl_ctx, GetOwningClangModule(die),
3433           is_inline);
3434       Log *log =
3435           nullptr; // (LogChannelDWARF::GetLogIfAll(DWARF_LOG_DEBUG_INFO));
3436       if (log) {
3437         SymbolFileDWARF *dwarf = die.GetDWARF();
3438         if (namespace_name) {
3439           dwarf->GetObjectFile()->GetModule()->LogMessage(
3440               log,
3441               "ASTContext => %p: 0x%8.8" PRIx64
3442               ": DW_TAG_namespace with DW_AT_name(\"%s\") => "
3443               "clang::NamespaceDecl *%p (original = %p)",
3444               static_cast<void *>(&m_ast.getASTContext()), die.GetID(),
3445               namespace_name, static_cast<void *>(namespace_decl),
3446               static_cast<void *>(namespace_decl->getOriginalNamespace()));
3447         } else {
3448           dwarf->GetObjectFile()->GetModule()->LogMessage(
3449               log,
3450               "ASTContext => %p: 0x%8.8" PRIx64
3451               ": DW_TAG_namespace (anonymous) => clang::NamespaceDecl *%p "
3452               "(original = %p)",
3453               static_cast<void *>(&m_ast.getASTContext()), die.GetID(),
3454               static_cast<void *>(namespace_decl),
3455               static_cast<void *>(namespace_decl->getOriginalNamespace()));
3456         }
3457       }
3458 
3459       if (namespace_decl)
3460         LinkDeclContextToDIE((clang::DeclContext *)namespace_decl, die);
3461       return namespace_decl;
3462     }
3463   }
3464   return nullptr;
3465 }
3466 
3467 clang::DeclContext *DWARFASTParserClang::GetClangDeclContextContainingDIE(
3468     const DWARFDIE &die, DWARFDIE *decl_ctx_die_copy) {
3469   SymbolFileDWARF *dwarf = die.GetDWARF();
3470 
3471   DWARFDIE decl_ctx_die = dwarf->GetDeclContextDIEContainingDIE(die);
3472 
3473   if (decl_ctx_die_copy)
3474     *decl_ctx_die_copy = decl_ctx_die;
3475 
3476   if (decl_ctx_die) {
3477     clang::DeclContext *clang_decl_ctx =
3478         GetClangDeclContextForDIE(decl_ctx_die);
3479     if (clang_decl_ctx)
3480       return clang_decl_ctx;
3481   }
3482   return m_ast.GetTranslationUnitDecl();
3483 }
3484 
3485 clang::DeclContext *
3486 DWARFASTParserClang::GetCachedClangDeclContextForDIE(const DWARFDIE &die) {
3487   if (die) {
3488     DIEToDeclContextMap::iterator pos = m_die_to_decl_ctx.find(die.GetDIE());
3489     if (pos != m_die_to_decl_ctx.end())
3490       return pos->second;
3491   }
3492   return nullptr;
3493 }
3494 
3495 void DWARFASTParserClang::LinkDeclContextToDIE(clang::DeclContext *decl_ctx,
3496                                                const DWARFDIE &die) {
3497   m_die_to_decl_ctx[die.GetDIE()] = decl_ctx;
3498   // There can be many DIEs for a single decl context
3499   // m_decl_ctx_to_die[decl_ctx].insert(die.GetDIE());
3500   m_decl_ctx_to_die.insert(std::make_pair(decl_ctx, die));
3501 }
3502 
3503 bool DWARFASTParserClang::CopyUniqueClassMethodTypes(
3504     const DWARFDIE &src_class_die, const DWARFDIE &dst_class_die,
3505     lldb_private::Type *class_type, std::vector<DWARFDIE> &failures) {
3506   if (!class_type || !src_class_die || !dst_class_die)
3507     return false;
3508   if (src_class_die.Tag() != dst_class_die.Tag())
3509     return false;
3510 
3511   // We need to complete the class type so we can get all of the method types
3512   // parsed so we can then unique those types to their equivalent counterparts
3513   // in "dst_cu" and "dst_class_die"
3514   class_type->GetFullCompilerType();
3515 
3516   DWARFDIE src_die;
3517   DWARFDIE dst_die;
3518   UniqueCStringMap<DWARFDIE> src_name_to_die;
3519   UniqueCStringMap<DWARFDIE> dst_name_to_die;
3520   UniqueCStringMap<DWARFDIE> src_name_to_die_artificial;
3521   UniqueCStringMap<DWARFDIE> dst_name_to_die_artificial;
3522   for (src_die = src_class_die.GetFirstChild(); src_die.IsValid();
3523        src_die = src_die.GetSibling()) {
3524     if (src_die.Tag() == DW_TAG_subprogram) {
3525       // Make sure this is a declaration and not a concrete instance by looking
3526       // for DW_AT_declaration set to 1. Sometimes concrete function instances
3527       // are placed inside the class definitions and shouldn't be included in
3528       // the list of things are are tracking here.
3529       if (src_die.GetAttributeValueAsUnsigned(DW_AT_declaration, 0) == 1) {
3530         const char *src_name = src_die.GetMangledName();
3531         if (src_name) {
3532           ConstString src_const_name(src_name);
3533           if (src_die.GetAttributeValueAsUnsigned(DW_AT_artificial, 0))
3534             src_name_to_die_artificial.Append(src_const_name, src_die);
3535           else
3536             src_name_to_die.Append(src_const_name, src_die);
3537         }
3538       }
3539     }
3540   }
3541   for (dst_die = dst_class_die.GetFirstChild(); dst_die.IsValid();
3542        dst_die = dst_die.GetSibling()) {
3543     if (dst_die.Tag() == DW_TAG_subprogram) {
3544       // Make sure this is a declaration and not a concrete instance by looking
3545       // for DW_AT_declaration set to 1. Sometimes concrete function instances
3546       // are placed inside the class definitions and shouldn't be included in
3547       // the list of things are are tracking here.
3548       if (dst_die.GetAttributeValueAsUnsigned(DW_AT_declaration, 0) == 1) {
3549         const char *dst_name = dst_die.GetMangledName();
3550         if (dst_name) {
3551           ConstString dst_const_name(dst_name);
3552           if (dst_die.GetAttributeValueAsUnsigned(DW_AT_artificial, 0))
3553             dst_name_to_die_artificial.Append(dst_const_name, dst_die);
3554           else
3555             dst_name_to_die.Append(dst_const_name, dst_die);
3556         }
3557       }
3558     }
3559   }
3560   const uint32_t src_size = src_name_to_die.GetSize();
3561   const uint32_t dst_size = dst_name_to_die.GetSize();
3562   Log *log = nullptr; // (LogChannelDWARF::GetLogIfAny(DWARF_LOG_DEBUG_INFO |
3563                       // DWARF_LOG_TYPE_COMPLETION));
3564 
3565   // Is everything kosher so we can go through the members at top speed?
3566   bool fast_path = true;
3567 
3568   if (src_size != dst_size) {
3569     if (src_size != 0 && dst_size != 0) {
3570       LLDB_LOGF(log,
3571                 "warning: trying to unique class DIE 0x%8.8x to 0x%8.8x, "
3572                 "but they didn't have the same size (src=%d, dst=%d)",
3573                 src_class_die.GetOffset(), dst_class_die.GetOffset(), src_size,
3574                 dst_size);
3575     }
3576 
3577     fast_path = false;
3578   }
3579 
3580   uint32_t idx;
3581 
3582   if (fast_path) {
3583     for (idx = 0; idx < src_size; ++idx) {
3584       src_die = src_name_to_die.GetValueAtIndexUnchecked(idx);
3585       dst_die = dst_name_to_die.GetValueAtIndexUnchecked(idx);
3586 
3587       if (src_die.Tag() != dst_die.Tag()) {
3588         LLDB_LOGF(log,
3589                   "warning: tried to unique class DIE 0x%8.8x to 0x%8.8x, "
3590                   "but 0x%8.8x (%s) tags didn't match 0x%8.8x (%s)",
3591                   src_class_die.GetOffset(), dst_class_die.GetOffset(),
3592                   src_die.GetOffset(), src_die.GetTagAsCString(),
3593                   dst_die.GetOffset(), dst_die.GetTagAsCString());
3594         fast_path = false;
3595       }
3596 
3597       const char *src_name = src_die.GetMangledName();
3598       const char *dst_name = dst_die.GetMangledName();
3599 
3600       // Make sure the names match
3601       if (src_name == dst_name || (strcmp(src_name, dst_name) == 0))
3602         continue;
3603 
3604       LLDB_LOGF(log,
3605                 "warning: tried to unique class DIE 0x%8.8x to 0x%8.8x, "
3606                 "but 0x%8.8x (%s) names didn't match 0x%8.8x (%s)",
3607                 src_class_die.GetOffset(), dst_class_die.GetOffset(),
3608                 src_die.GetOffset(), src_name, dst_die.GetOffset(), dst_name);
3609 
3610       fast_path = false;
3611     }
3612   }
3613 
3614   DWARFASTParserClang *src_dwarf_ast_parser =
3615       static_cast<DWARFASTParserClang *>(
3616           SymbolFileDWARF::GetDWARFParser(*src_die.GetCU()));
3617   DWARFASTParserClang *dst_dwarf_ast_parser =
3618       static_cast<DWARFASTParserClang *>(
3619           SymbolFileDWARF::GetDWARFParser(*dst_die.GetCU()));
3620 
3621   // Now do the work of linking the DeclContexts and Types.
3622   if (fast_path) {
3623     // We can do this quickly.  Just run across the tables index-for-index
3624     // since we know each node has matching names and tags.
3625     for (idx = 0; idx < src_size; ++idx) {
3626       src_die = src_name_to_die.GetValueAtIndexUnchecked(idx);
3627       dst_die = dst_name_to_die.GetValueAtIndexUnchecked(idx);
3628 
3629       clang::DeclContext *src_decl_ctx =
3630           src_dwarf_ast_parser->m_die_to_decl_ctx[src_die.GetDIE()];
3631       if (src_decl_ctx) {
3632         LLDB_LOGF(log, "uniquing decl context %p from 0x%8.8x for 0x%8.8x",
3633                   static_cast<void *>(src_decl_ctx), src_die.GetOffset(),
3634                   dst_die.GetOffset());
3635         dst_dwarf_ast_parser->LinkDeclContextToDIE(src_decl_ctx, dst_die);
3636       } else {
3637         LLDB_LOGF(log,
3638                   "warning: tried to unique decl context from 0x%8.8x for "
3639                   "0x%8.8x, but none was found",
3640                   src_die.GetOffset(), dst_die.GetOffset());
3641       }
3642 
3643       Type *src_child_type =
3644           dst_die.GetDWARF()->GetDIEToType()[src_die.GetDIE()];
3645       if (src_child_type) {
3646         LLDB_LOGF(log,
3647                   "uniquing type %p (uid=0x%" PRIx64
3648                   ") from 0x%8.8x for 0x%8.8x",
3649                   static_cast<void *>(src_child_type), src_child_type->GetID(),
3650                   src_die.GetOffset(), dst_die.GetOffset());
3651         dst_die.GetDWARF()->GetDIEToType()[dst_die.GetDIE()] = src_child_type;
3652       } else {
3653         LLDB_LOGF(log,
3654                   "warning: tried to unique lldb_private::Type from "
3655                   "0x%8.8x for 0x%8.8x, but none was found",
3656                   src_die.GetOffset(), dst_die.GetOffset());
3657       }
3658     }
3659   } else {
3660     // We must do this slowly.  For each member of the destination, look up a
3661     // member in the source with the same name, check its tag, and unique them
3662     // if everything matches up.  Report failures.
3663 
3664     if (!src_name_to_die.IsEmpty() && !dst_name_to_die.IsEmpty()) {
3665       src_name_to_die.Sort();
3666 
3667       for (idx = 0; idx < dst_size; ++idx) {
3668         ConstString dst_name = dst_name_to_die.GetCStringAtIndex(idx);
3669         dst_die = dst_name_to_die.GetValueAtIndexUnchecked(idx);
3670         src_die = src_name_to_die.Find(dst_name, DWARFDIE());
3671 
3672         if (src_die && (src_die.Tag() == dst_die.Tag())) {
3673           clang::DeclContext *src_decl_ctx =
3674               src_dwarf_ast_parser->m_die_to_decl_ctx[src_die.GetDIE()];
3675           if (src_decl_ctx) {
3676             LLDB_LOGF(log, "uniquing decl context %p from 0x%8.8x for 0x%8.8x",
3677                       static_cast<void *>(src_decl_ctx), src_die.GetOffset(),
3678                       dst_die.GetOffset());
3679             dst_dwarf_ast_parser->LinkDeclContextToDIE(src_decl_ctx, dst_die);
3680           } else {
3681             LLDB_LOGF(log,
3682                       "warning: tried to unique decl context from 0x%8.8x "
3683                       "for 0x%8.8x, but none was found",
3684                       src_die.GetOffset(), dst_die.GetOffset());
3685           }
3686 
3687           Type *src_child_type =
3688               dst_die.GetDWARF()->GetDIEToType()[src_die.GetDIE()];
3689           if (src_child_type) {
3690             LLDB_LOGF(
3691                 log,
3692                 "uniquing type %p (uid=0x%" PRIx64 ") from 0x%8.8x for 0x%8.8x",
3693                 static_cast<void *>(src_child_type), src_child_type->GetID(),
3694                 src_die.GetOffset(), dst_die.GetOffset());
3695             dst_die.GetDWARF()->GetDIEToType()[dst_die.GetDIE()] =
3696                 src_child_type;
3697           } else {
3698             LLDB_LOGF(log,
3699                       "warning: tried to unique lldb_private::Type from "
3700                       "0x%8.8x for 0x%8.8x, but none was found",
3701                       src_die.GetOffset(), dst_die.GetOffset());
3702           }
3703         } else {
3704           LLDB_LOGF(log, "warning: couldn't find a match for 0x%8.8x",
3705                     dst_die.GetOffset());
3706 
3707           failures.push_back(dst_die);
3708         }
3709       }
3710     }
3711   }
3712 
3713   const uint32_t src_size_artificial = src_name_to_die_artificial.GetSize();
3714   const uint32_t dst_size_artificial = dst_name_to_die_artificial.GetSize();
3715 
3716   if (src_size_artificial && dst_size_artificial) {
3717     dst_name_to_die_artificial.Sort();
3718 
3719     for (idx = 0; idx < src_size_artificial; ++idx) {
3720       ConstString src_name_artificial =
3721           src_name_to_die_artificial.GetCStringAtIndex(idx);
3722       src_die = src_name_to_die_artificial.GetValueAtIndexUnchecked(idx);
3723       dst_die =
3724           dst_name_to_die_artificial.Find(src_name_artificial, DWARFDIE());
3725 
3726       if (dst_die) {
3727         // Both classes have the artificial types, link them
3728         clang::DeclContext *src_decl_ctx =
3729             src_dwarf_ast_parser->m_die_to_decl_ctx[src_die.GetDIE()];
3730         if (src_decl_ctx) {
3731           LLDB_LOGF(log, "uniquing decl context %p from 0x%8.8x for 0x%8.8x",
3732                     static_cast<void *>(src_decl_ctx), src_die.GetOffset(),
3733                     dst_die.GetOffset());
3734           dst_dwarf_ast_parser->LinkDeclContextToDIE(src_decl_ctx, dst_die);
3735         } else {
3736           LLDB_LOGF(log,
3737                     "warning: tried to unique decl context from 0x%8.8x "
3738                     "for 0x%8.8x, but none was found",
3739                     src_die.GetOffset(), dst_die.GetOffset());
3740         }
3741 
3742         Type *src_child_type =
3743             dst_die.GetDWARF()->GetDIEToType()[src_die.GetDIE()];
3744         if (src_child_type) {
3745           LLDB_LOGF(
3746               log,
3747               "uniquing type %p (uid=0x%" PRIx64 ") from 0x%8.8x for 0x%8.8x",
3748               static_cast<void *>(src_child_type), src_child_type->GetID(),
3749               src_die.GetOffset(), dst_die.GetOffset());
3750           dst_die.GetDWARF()->GetDIEToType()[dst_die.GetDIE()] = src_child_type;
3751         } else {
3752           LLDB_LOGF(log,
3753                     "warning: tried to unique lldb_private::Type from "
3754                     "0x%8.8x for 0x%8.8x, but none was found",
3755                     src_die.GetOffset(), dst_die.GetOffset());
3756         }
3757       }
3758     }
3759   }
3760 
3761   if (dst_size_artificial) {
3762     for (idx = 0; idx < dst_size_artificial; ++idx) {
3763       ConstString dst_name_artificial =
3764           dst_name_to_die_artificial.GetCStringAtIndex(idx);
3765       dst_die = dst_name_to_die_artificial.GetValueAtIndexUnchecked(idx);
3766       LLDB_LOGF(log,
3767                 "warning: need to create artificial method for 0x%8.8x for "
3768                 "method '%s'",
3769                 dst_die.GetOffset(), dst_name_artificial.GetCString());
3770 
3771       failures.push_back(dst_die);
3772     }
3773   }
3774 
3775   return !failures.empty();
3776 }
3777