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