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