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