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