1 //===-- DWARFASTParserClang.cpp ---------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
12 #include "DWARFASTParserClang.h"
13 #include "DWARFCompileUnit.h"
15 #include "DWARFDIECollection.h"
16 #include "DWARFDebugInfo.h"
17 #include "DWARFDeclContext.h"
18 #include "DWARFDefines.h"
19 #include "SymbolFileDWARF.h"
20 #include "SymbolFileDWARFDebugMap.h"
21 #include "UniqueDWARFASTType.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/Interpreter/Args.h"
28 #include "lldb/Symbol/ClangASTImporter.h"
29 #include "lldb/Symbol/ClangExternalASTSourceCommon.h"
30 #include "lldb/Symbol/ClangUtil.h"
31 #include "lldb/Symbol/CompileUnit.h"
32 #include "lldb/Symbol/Function.h"
33 #include "lldb/Symbol/ObjectFile.h"
34 #include "lldb/Symbol/SymbolVendor.h"
35 #include "lldb/Symbol/TypeList.h"
36 #include "lldb/Symbol/TypeMap.h"
37 #include "lldb/Target/Language.h"
38 #include "lldb/Utility/LLDBAssert.h"
39 #include "lldb/Utility/Log.h"
40 #include "lldb/Utility/StreamString.h"
42 #include "clang/AST/DeclCXX.h"
43 #include "clang/AST/DeclObjC.h"
48 //#define ENABLE_DEBUG_PRINTF // COMMENT OUT THIS LINE PRIOR TO CHECKIN
50 #ifdef ENABLE_DEBUG_PRINTF
52 #define DEBUG_PRINTF(fmt, ...) printf(fmt, __VA_ARGS__)
54 #define DEBUG_PRINTF(fmt, ...)
58 using namespace lldb_private;
59 DWARFASTParserClang::DWARFASTParserClang(ClangASTContext &ast)
60 : m_ast(ast), m_die_to_decl_ctx(), m_decl_ctx_to_die() {}
62 DWARFASTParserClang::~DWARFASTParserClang() {}
64 static AccessType DW_ACCESS_to_AccessType(uint32_t dwarf_accessibility) {
65 switch (dwarf_accessibility) {
66 case DW_ACCESS_public:
68 case DW_ACCESS_private:
69 return eAccessPrivate;
70 case DW_ACCESS_protected:
71 return eAccessProtected;
78 static bool DeclKindIsCXXClass(clang::Decl::Kind decl_kind) {
80 case clang::Decl::CXXRecord:
81 case clang::Decl::ClassTemplateSpecialization:
94 : bit_size(LLDB_INVALID_ADDRESS), bit_offset(LLDB_INVALID_ADDRESS) {}
97 bit_size = LLDB_INVALID_ADDRESS;
98 bit_offset = LLDB_INVALID_ADDRESS;
101 bool IsValid() const {
102 return (bit_size != LLDB_INVALID_ADDRESS) &&
103 (bit_offset != LLDB_INVALID_ADDRESS);
106 bool NextBitfieldOffsetIsValid(const uint64_t next_bit_offset) const {
108 // This bitfield info is valid, so any subsequent bitfields
109 // must not overlap and must be at a higher bit offset than
110 // any previous bitfield + size.
111 return (bit_size + bit_offset) <= next_bit_offset;
113 // If the this BitfieldInfo is not valid, then any offset isOK
119 ClangASTImporter &DWARFASTParserClang::GetClangASTImporter() {
120 if (!m_clang_ast_importer_ap) {
121 m_clang_ast_importer_ap.reset(new ClangASTImporter);
123 return *m_clang_ast_importer_ap;
126 TypeSP DWARFASTParserClang::ParseTypeFromDWO(const DWARFDIE &die, Log *log) {
127 ModuleSP dwo_module_sp = die.GetContainingDWOModule();
129 // This type comes from an external DWO module
130 std::vector<CompilerContext> dwo_context;
131 die.GetDWOContext(dwo_context);
133 if (dwo_module_sp->GetSymbolVendor()->FindTypes(dwo_context, true,
135 const size_t num_dwo_types = dwo_types.GetSize();
136 if (num_dwo_types == 1) {
137 // We found a real definition for this type elsewhere
138 // so lets use it and cache the fact that we found
139 // a complete type for this die
140 TypeSP dwo_type_sp = dwo_types.GetTypeAtIndex(0);
142 lldb_private::CompilerType dwo_type =
143 dwo_type_sp->GetForwardCompilerType();
145 lldb_private::CompilerType type =
146 GetClangASTImporter().CopyType(m_ast, dwo_type);
148 // printf ("copied_qual_type: ast = %p, clang_type = %p, name =
149 // '%s'\n", m_ast, copied_qual_type.getAsOpaquePtr(),
150 // external_type->GetName().GetCString());
152 SymbolFileDWARF *dwarf = die.GetDWARF();
153 TypeSP type_sp(new Type(die.GetID(), dwarf, dwo_type_sp->GetName(),
154 dwo_type_sp->GetByteSize(), NULL,
155 LLDB_INVALID_UID, Type::eEncodingInvalid,
156 &dwo_type_sp->GetDeclaration(), type,
157 Type::eResolveStateForward));
159 dwarf->GetTypeList()->Insert(type_sp);
160 dwarf->GetDIEToType()[die.GetDIE()] = type_sp.get();
161 clang::TagDecl *tag_decl = ClangASTContext::GetAsTagDecl(type);
163 LinkDeclContextToDIE(tag_decl, die);
165 clang::DeclContext *defn_decl_ctx =
166 GetCachedClangDeclContextForDIE(die);
168 LinkDeclContextToDIE(defn_decl_ctx, die);
179 TypeSP DWARFASTParserClang::ParseTypeFromDWARF(const SymbolContext &sc,
180 const DWARFDIE &die, Log *log,
181 bool *type_is_new_ptr) {
185 *type_is_new_ptr = false;
187 AccessType accessibility = eAccessNone;
189 SymbolFileDWARF *dwarf = die.GetDWARF();
191 DWARFDIE context_die;
192 clang::DeclContext *context =
193 GetClangDeclContextContainingDIE(die, &context_die);
195 dwarf->GetObjectFile()->GetModule()->LogMessage(
196 log, "SymbolFileDWARF::ParseType (die = 0x%8.8x, decl_ctx = %p (die "
197 "0x%8.8x)) %s name = '%s')",
198 die.GetOffset(), static_cast<void *>(context),
199 context_die.GetOffset(), die.GetTagAsCString(), die.GetName());
202 // Log *log (LogChannelDWARF::GetLogIfAll(DWARF_LOG_DEBUG_INFO));
203 // if (log && dwarf_cu)
206 // die->DumpLocation (this, dwarf_cu, s);
207 // dwarf->GetObjectFile()->GetModule()->LogMessage (log,
208 // "SymbolFileDwarf::%s %s", __FUNCTION__, s.GetData());
212 Type *type_ptr = dwarf->GetDIEToType().lookup(die.GetDIE());
213 TypeList *type_list = dwarf->GetTypeList();
214 if (type_ptr == NULL) {
216 *type_is_new_ptr = true;
218 const dw_tag_t tag = die.Tag();
220 bool is_forward_declaration = false;
221 DWARFAttributes attributes;
222 const char *type_name_cstr = NULL;
223 ConstString type_name_const_str;
224 Type::ResolveState resolve_state = Type::eResolveStateUnresolved;
225 uint64_t byte_size = 0;
228 Type::EncodingDataType encoding_data_type = Type::eEncodingIsUID;
229 CompilerType clang_type;
230 DWARFFormValue form_value;
236 case DW_TAG_base_type:
237 case DW_TAG_pointer_type:
238 case DW_TAG_reference_type:
239 case DW_TAG_rvalue_reference_type:
240 case DW_TAG_const_type:
241 case DW_TAG_restrict_type:
242 case DW_TAG_volatile_type:
243 case DW_TAG_unspecified_type: {
244 // Set a bit that lets us know that we are currently parsing this
245 dwarf->GetDIEToType()[die.GetDIE()] = DIE_IS_BEING_PARSED;
247 const size_t num_attributes = die.GetAttributes(attributes);
248 uint32_t encoding = 0;
249 DWARFFormValue encoding_uid;
251 if (num_attributes > 0) {
253 for (i = 0; i < num_attributes; ++i) {
254 attr = attributes.AttributeAtIndex(i);
255 if (attributes.ExtractFormValueAtIndex(i, form_value)) {
257 case DW_AT_decl_file:
258 decl.SetFile(sc.comp_unit->GetSupportFiles().GetFileSpecAtIndex(
259 form_value.Unsigned()));
261 case DW_AT_decl_line:
262 decl.SetLine(form_value.Unsigned());
264 case DW_AT_decl_column:
265 decl.SetColumn(form_value.Unsigned());
269 type_name_cstr = form_value.AsCString();
270 // Work around a bug in llvm-gcc where they give a name to a
271 // reference type which doesn't
272 // include the "&"...
273 if (tag == DW_TAG_reference_type) {
274 if (strchr(type_name_cstr, '&') == NULL)
275 type_name_cstr = NULL;
278 type_name_const_str.SetCString(type_name_cstr);
280 case DW_AT_byte_size:
281 byte_size = form_value.Unsigned();
284 encoding = form_value.Unsigned();
287 encoding_uid = form_value;
297 if (tag == DW_TAG_typedef && encoding_uid.IsValid()) {
298 // Try to parse a typedef from the DWO file first as modules
299 // can contain typedef'ed structures that have no names like:
301 // typedef struct { int a; } Foo;
303 // In this case we will have a structure with no name and a
304 // typedef named "Foo" that points to this unnamed structure.
305 // The name in the typedef is the only identifier for the struct,
306 // so always try to get typedefs from DWO files if possible.
308 // The type_sp returned will be empty if the typedef doesn't exist
309 // in a DWO file, so it is cheap to call this function just to check.
311 // If we don't do this we end up creating a TypeSP that says this
312 // is a typedef to type 0x123 (the DW_AT_type value would be 0x123
313 // in the DW_TAG_typedef), and this is the unnamed structure type.
314 // We will have a hard time tracking down an unnammed structure
315 // type in the module DWO file, so we make sure we don't get into
316 // this situation by always resolving typedefs from the DWO file.
317 const DWARFDIE encoding_die = dwarf->GetDIE(DIERef(encoding_uid));
319 // First make sure that the die that this is typedef'ed to _is_
320 // just a declaration (DW_AT_declaration == 1), not a full definition
321 // since template types can't be represented in modules since only
322 // concrete instances of templates are ever emitted and modules
323 // won't contain those
325 encoding_die.GetAttributeValueAsUnsigned(DW_AT_declaration, 0) ==
327 type_sp = ParseTypeFromDWO(die, log);
333 DEBUG_PRINTF("0x%8.8" PRIx64 ": %s (\"%s\") type => 0x%8.8lx\n",
334 die.GetID(), DW_TAG_value_to_name(tag), type_name_cstr,
335 encoding_uid.Reference());
341 case DW_TAG_unspecified_type:
342 if (strcmp(type_name_cstr, "nullptr_t") == 0 ||
343 strcmp(type_name_cstr, "decltype(nullptr)") == 0) {
344 resolve_state = Type::eResolveStateFull;
345 clang_type = m_ast.GetBasicType(eBasicTypeNullPtr);
348 // Fall through to base type below in case we can handle the type
352 case DW_TAG_base_type:
353 resolve_state = Type::eResolveStateFull;
354 clang_type = m_ast.GetBuiltinTypeForDWARFEncodingAndBitSize(
355 type_name_cstr, encoding, byte_size * 8);
358 case DW_TAG_pointer_type:
359 encoding_data_type = Type::eEncodingIsPointerUID;
361 case DW_TAG_reference_type:
362 encoding_data_type = Type::eEncodingIsLValueReferenceUID;
364 case DW_TAG_rvalue_reference_type:
365 encoding_data_type = Type::eEncodingIsRValueReferenceUID;
368 encoding_data_type = Type::eEncodingIsTypedefUID;
370 case DW_TAG_const_type:
371 encoding_data_type = Type::eEncodingIsConstUID;
373 case DW_TAG_restrict_type:
374 encoding_data_type = Type::eEncodingIsRestrictUID;
376 case DW_TAG_volatile_type:
377 encoding_data_type = Type::eEncodingIsVolatileUID;
382 (encoding_data_type == Type::eEncodingIsPointerUID ||
383 encoding_data_type == Type::eEncodingIsTypedefUID) &&
384 sc.comp_unit != NULL) {
385 if (tag == DW_TAG_pointer_type) {
386 DWARFDIE target_die = die.GetReferencedDIE(DW_AT_type);
388 if (target_die.GetAttributeValueAsUnsigned(DW_AT_APPLE_block, 0)) {
389 // Blocks have a __FuncPtr inside them which is a pointer to a
390 // function of the proper type.
392 for (DWARFDIE child_die = target_die.GetFirstChild();
393 child_die.IsValid(); child_die = child_die.GetSibling()) {
394 if (!strcmp(child_die.GetAttributeValueAsString(DW_AT_name, ""),
396 DWARFDIE function_pointer_type =
397 child_die.GetReferencedDIE(DW_AT_type);
399 if (function_pointer_type) {
400 DWARFDIE function_type =
401 function_pointer_type.GetReferencedDIE(DW_AT_type);
403 bool function_type_is_new_pointer;
404 TypeSP lldb_function_type_sp = ParseTypeFromDWARF(
405 sc, function_type, log, &function_type_is_new_pointer);
407 if (lldb_function_type_sp) {
408 clang_type = m_ast.CreateBlockPointerType(
409 lldb_function_type_sp->GetForwardCompilerType());
410 encoding_data_type = Type::eEncodingIsUID;
411 encoding_uid.Clear();
412 resolve_state = Type::eResolveStateFull;
422 bool translation_unit_is_objc =
423 (sc.comp_unit->GetLanguage() == eLanguageTypeObjC ||
424 sc.comp_unit->GetLanguage() == eLanguageTypeObjC_plus_plus);
426 if (translation_unit_is_objc) {
427 if (type_name_cstr != NULL) {
428 static ConstString g_objc_type_name_id("id");
429 static ConstString g_objc_type_name_Class("Class");
430 static ConstString g_objc_type_name_selector("SEL");
432 if (type_name_const_str == g_objc_type_name_id) {
434 dwarf->GetObjectFile()->GetModule()->LogMessage(
435 log, "SymbolFileDWARF::ParseType (die = 0x%8.8x) %s '%s' "
436 "is Objective C 'id' built-in type.",
437 die.GetOffset(), die.GetTagAsCString(), die.GetName());
438 clang_type = m_ast.GetBasicType(eBasicTypeObjCID);
439 encoding_data_type = Type::eEncodingIsUID;
440 encoding_uid.Clear();
441 resolve_state = Type::eResolveStateFull;
443 } else if (type_name_const_str == g_objc_type_name_Class) {
445 dwarf->GetObjectFile()->GetModule()->LogMessage(
446 log, "SymbolFileDWARF::ParseType (die = 0x%8.8x) %s '%s' "
447 "is Objective C 'Class' built-in type.",
448 die.GetOffset(), die.GetTagAsCString(), die.GetName());
449 clang_type = m_ast.GetBasicType(eBasicTypeObjCClass);
450 encoding_data_type = Type::eEncodingIsUID;
451 encoding_uid.Clear();
452 resolve_state = Type::eResolveStateFull;
453 } else if (type_name_const_str == g_objc_type_name_selector) {
455 dwarf->GetObjectFile()->GetModule()->LogMessage(
456 log, "SymbolFileDWARF::ParseType (die = 0x%8.8x) %s '%s' "
457 "is Objective C 'selector' built-in type.",
458 die.GetOffset(), die.GetTagAsCString(), die.GetName());
459 clang_type = m_ast.GetBasicType(eBasicTypeObjCSel);
460 encoding_data_type = Type::eEncodingIsUID;
461 encoding_uid.Clear();
462 resolve_state = Type::eResolveStateFull;
464 } else if (encoding_data_type == Type::eEncodingIsPointerUID &&
465 encoding_uid.IsValid()) {
466 // Clang sometimes erroneously emits id as objc_object*. In that
467 // case we fix up the type to "id".
469 const DWARFDIE encoding_die = dwarf->GetDIE(DIERef(encoding_uid));
471 if (encoding_die && encoding_die.Tag() == DW_TAG_structure_type) {
472 if (const char *struct_name = encoding_die.GetName()) {
473 if (!strcmp(struct_name, "objc_object")) {
475 dwarf->GetObjectFile()->GetModule()->LogMessage(
476 log, "SymbolFileDWARF::ParseType (die = 0x%8.8x) %s "
477 "'%s' is 'objc_object*', which we overrode to "
479 die.GetOffset(), die.GetTagAsCString(),
481 clang_type = m_ast.GetBasicType(eBasicTypeObjCID);
482 encoding_data_type = Type::eEncodingIsUID;
483 encoding_uid.Clear();
484 resolve_state = Type::eResolveStateFull;
493 new Type(die.GetID(), dwarf, type_name_const_str, byte_size, NULL,
494 DIERef(encoding_uid).GetUID(dwarf), encoding_data_type,
495 &decl, clang_type, resolve_state));
497 dwarf->GetDIEToType()[die.GetDIE()] = type_sp.get();
499 // Type* encoding_type =
500 // GetUniquedTypeForDIEOffset(encoding_uid, type_sp,
501 // NULL, 0, 0, false);
502 // if (encoding_type != NULL)
504 // if (encoding_type != DIE_IS_BEING_PARSED)
505 // type_sp->SetEncodingType(encoding_type);
507 // m_indirect_fixups.push_back(type_sp.get());
511 case DW_TAG_structure_type:
512 case DW_TAG_union_type:
513 case DW_TAG_class_type: {
514 // Set a bit that lets us know that we are currently parsing this
515 dwarf->GetDIEToType()[die.GetDIE()] = DIE_IS_BEING_PARSED;
516 bool byte_size_valid = false;
518 LanguageType class_language = eLanguageTypeUnknown;
519 bool is_complete_objc_class = false;
520 // bool struct_is_class = false;
521 const size_t num_attributes = die.GetAttributes(attributes);
522 if (num_attributes > 0) {
524 for (i = 0; i < num_attributes; ++i) {
525 attr = attributes.AttributeAtIndex(i);
526 if (attributes.ExtractFormValueAtIndex(i, form_value)) {
528 case DW_AT_decl_file:
529 if (die.GetCU()->DW_AT_decl_file_attributes_are_invalid()) {
530 // llvm-gcc outputs invalid DW_AT_decl_file attributes that
532 // point to the compile unit file, so we clear this invalid
534 // so that we can still unique types efficiently.
535 decl.SetFile(FileSpec("<invalid>", false));
538 sc.comp_unit->GetSupportFiles().GetFileSpecAtIndex(
539 form_value.Unsigned()));
542 case DW_AT_decl_line:
543 decl.SetLine(form_value.Unsigned());
546 case DW_AT_decl_column:
547 decl.SetColumn(form_value.Unsigned());
551 type_name_cstr = form_value.AsCString();
552 type_name_const_str.SetCString(type_name_cstr);
555 case DW_AT_byte_size:
556 byte_size = form_value.Unsigned();
557 byte_size_valid = true;
560 case DW_AT_accessibility:
561 accessibility = DW_ACCESS_to_AccessType(form_value.Unsigned());
564 case DW_AT_declaration:
565 is_forward_declaration = form_value.Boolean();
568 case DW_AT_APPLE_runtime_class:
569 class_language = (LanguageType)form_value.Signed();
572 case DW_AT_APPLE_objc_complete_type:
573 is_complete_objc_class = form_value.Signed();
576 case DW_AT_allocated:
577 case DW_AT_associated:
578 case DW_AT_data_location:
579 case DW_AT_description:
580 case DW_AT_start_scope:
581 case DW_AT_visibility:
590 // UniqueDWARFASTType is large, so don't create a local variables on the
591 // stack, put it on the heap. This function is often called recursively
592 // and clang isn't good and sharing the stack space for variables in
594 std::unique_ptr<UniqueDWARFASTType> unique_ast_entry_ap(
595 new UniqueDWARFASTType());
597 ConstString unique_typename(type_name_const_str);
598 Declaration unique_decl(decl);
600 if (type_name_const_str) {
601 LanguageType die_language = die.GetLanguage();
602 if (Language::LanguageIsCPlusPlus(die_language)) {
603 // For C++, we rely solely upon the one definition rule that says
605 // one thing can exist at a given decl context. We ignore the file
607 // line that things are declared on.
608 std::string qualified_name;
609 if (die.GetQualifiedName(qualified_name))
610 unique_typename = ConstString(qualified_name);
614 if (dwarf->GetUniqueDWARFASTTypeMap().Find(
615 unique_typename, die, unique_decl,
616 byte_size_valid ? byte_size : -1, *unique_ast_entry_ap)) {
617 type_sp = unique_ast_entry_ap->m_type_sp;
619 dwarf->GetDIEToType()[die.GetDIE()] = type_sp.get();
625 DEBUG_PRINTF("0x%8.8" PRIx64 ": %s (\"%s\")\n", die.GetID(),
626 DW_TAG_value_to_name(tag), type_name_cstr);
628 int tag_decl_kind = -1;
629 AccessType default_accessibility = eAccessNone;
630 if (tag == DW_TAG_structure_type) {
631 tag_decl_kind = clang::TTK_Struct;
632 default_accessibility = eAccessPublic;
633 } else if (tag == DW_TAG_union_type) {
634 tag_decl_kind = clang::TTK_Union;
635 default_accessibility = eAccessPublic;
636 } else if (tag == DW_TAG_class_type) {
637 tag_decl_kind = clang::TTK_Class;
638 default_accessibility = eAccessPrivate;
641 if (byte_size_valid && byte_size == 0 && type_name_cstr &&
642 die.HasChildren() == false &&
643 sc.comp_unit->GetLanguage() == eLanguageTypeObjC) {
644 // Work around an issue with clang at the moment where
645 // forward declarations for objective C classes are emitted
647 // DW_TAG_structure_type [2]
648 // DW_AT_name( "ForwardObjcClass" )
649 // DW_AT_byte_size( 0x00 )
650 // DW_AT_decl_file( "..." )
651 // DW_AT_decl_line( 1 )
653 // Note that there is no DW_AT_declaration and there are
654 // no children, and the byte size is zero.
655 is_forward_declaration = true;
658 if (class_language == eLanguageTypeObjC ||
659 class_language == eLanguageTypeObjC_plus_plus) {
660 if (!is_complete_objc_class &&
661 die.Supports_DW_AT_APPLE_objc_complete_type()) {
662 // We have a valid eSymbolTypeObjCClass class symbol whose
663 // name matches the current objective C class that we
664 // are trying to find and this DIE isn't the complete
665 // definition (we checked is_complete_objc_class above and
666 // know it is false), so the real definition is in here somewhere
667 type_sp = dwarf->FindCompleteObjCDefinitionTypeForDIE(
668 die, type_name_const_str, true);
671 SymbolFileDWARFDebugMap *debug_map_symfile =
672 dwarf->GetDebugMapSymfile();
673 if (debug_map_symfile) {
674 // We weren't able to find a full declaration in
675 // this DWARF, see if we have a declaration anywhere
678 debug_map_symfile->FindCompleteObjCDefinitionTypeForDIE(
679 die, type_name_const_str, true);
685 dwarf->GetObjectFile()->GetModule()->LogMessage(
686 log, "SymbolFileDWARF(%p) - 0x%8.8x: %s type \"%s\" is an "
687 "incomplete objc type, complete type is 0x%8.8" PRIx64,
688 static_cast<void *>(this), die.GetOffset(),
689 DW_TAG_value_to_name(tag), type_name_cstr,
693 // We found a real definition for this type elsewhere
694 // so lets use it and cache the fact that we found
695 // a complete type for this die
696 dwarf->GetDIEToType()[die.GetDIE()] = type_sp.get();
702 if (is_forward_declaration) {
703 // We have a forward declaration to a type and we need
704 // to try and find a full declaration. We look in the
705 // current type index just in case we have a forward
706 // declaration followed by an actual declarations in the
707 // DWARF. If this fails, we need to look elsewhere...
709 dwarf->GetObjectFile()->GetModule()->LogMessage(
710 log, "SymbolFileDWARF(%p) - 0x%8.8x: %s type \"%s\" is a "
711 "forward declaration, trying to find complete type",
712 static_cast<void *>(this), die.GetOffset(),
713 DW_TAG_value_to_name(tag), type_name_cstr);
716 // See if the type comes from a DWO module and if so, track down that
718 type_sp = ParseTypeFromDWO(die, log);
722 DWARFDeclContext die_decl_ctx;
723 die.GetDWARFDeclContext(die_decl_ctx);
725 // type_sp = FindDefinitionTypeForDIE (dwarf_cu, die,
726 // type_name_const_str);
727 type_sp = dwarf->FindDefinitionTypeForDWARFDeclContext(die_decl_ctx);
730 SymbolFileDWARFDebugMap *debug_map_symfile =
731 dwarf->GetDebugMapSymfile();
732 if (debug_map_symfile) {
733 // We weren't able to find a full declaration in
734 // this DWARF, see if we have a declaration anywhere
737 debug_map_symfile->FindDefinitionTypeForDWARFDeclContext(
744 dwarf->GetObjectFile()->GetModule()->LogMessage(
745 log, "SymbolFileDWARF(%p) - 0x%8.8x: %s type \"%s\" is a "
746 "forward declaration, complete type is 0x%8.8" PRIx64,
747 static_cast<void *>(this), die.GetOffset(),
748 DW_TAG_value_to_name(tag), type_name_cstr, type_sp->GetID());
751 // We found a real definition for this type elsewhere
752 // so lets use it and cache the fact that we found
753 // a complete type for this die
754 dwarf->GetDIEToType()[die.GetDIE()] = type_sp.get();
755 clang::DeclContext *defn_decl_ctx = GetCachedClangDeclContextForDIE(
756 dwarf->DebugInfo()->GetDIE(DIERef(type_sp->GetID(), dwarf)));
758 LinkDeclContextToDIE(defn_decl_ctx, die);
762 assert(tag_decl_kind != -1);
763 bool clang_type_was_created = false;
764 clang_type.SetCompilerType(
765 &m_ast, dwarf->GetForwardDeclDieToClangType().lookup(die.GetDIE()));
767 clang::DeclContext *decl_ctx =
768 GetClangDeclContextContainingDIE(die, nullptr);
769 if (accessibility == eAccessNone && decl_ctx) {
770 // Check the decl context that contains this class/struct/union.
771 // If it is a class we must give it an accessibility.
772 const clang::Decl::Kind containing_decl_kind =
773 decl_ctx->getDeclKind();
774 if (DeclKindIsCXXClass(containing_decl_kind))
775 accessibility = default_accessibility;
778 ClangASTMetadata metadata;
779 metadata.SetUserID(die.GetID());
780 metadata.SetIsDynamicCXXType(dwarf->ClassOrStructIsVirtual(die));
782 if (type_name_cstr && strchr(type_name_cstr, '<')) {
783 ClangASTContext::TemplateParameterInfos template_param_infos;
784 if (ParseTemplateParameterInfos(die, template_param_infos)) {
785 clang::ClassTemplateDecl *class_template_decl =
786 m_ast.ParseClassTemplateDecl(decl_ctx, accessibility,
787 type_name_cstr, tag_decl_kind,
788 template_param_infos);
790 clang::ClassTemplateSpecializationDecl
791 *class_specialization_decl =
792 m_ast.CreateClassTemplateSpecializationDecl(
793 decl_ctx, class_template_decl, tag_decl_kind,
794 template_param_infos);
795 clang_type = m_ast.CreateClassTemplateSpecializationType(
796 class_specialization_decl);
797 clang_type_was_created = true;
799 m_ast.SetMetadata(class_template_decl, metadata);
800 m_ast.SetMetadata(class_specialization_decl, metadata);
804 if (!clang_type_was_created) {
805 clang_type_was_created = true;
806 clang_type = m_ast.CreateRecordType(decl_ctx, accessibility,
807 type_name_cstr, tag_decl_kind,
808 class_language, &metadata);
812 // Store a forward declaration to this class type in case any
813 // parameters in any class methods need it for the clang
814 // types for function prototypes.
815 LinkDeclContextToDIE(m_ast.GetDeclContextForType(clang_type), die);
816 type_sp.reset(new Type(die.GetID(), dwarf, type_name_const_str,
817 byte_size, NULL, LLDB_INVALID_UID,
818 Type::eEncodingIsUID, &decl, clang_type,
819 Type::eResolveStateForward));
821 type_sp->SetIsCompleteObjCClass(is_complete_objc_class);
823 // Add our type to the unique type map so we don't
824 // end up creating many copies of the same type over
825 // and over in the ASTContext for our module
826 unique_ast_entry_ap->m_type_sp = type_sp;
827 unique_ast_entry_ap->m_die = die;
828 unique_ast_entry_ap->m_declaration = unique_decl;
829 unique_ast_entry_ap->m_byte_size = byte_size;
830 dwarf->GetUniqueDWARFASTTypeMap().Insert(unique_typename,
831 *unique_ast_entry_ap);
833 if (is_forward_declaration && die.HasChildren()) {
834 // Check to see if the DIE actually has a definition, some version of
836 // emit DIEs with DW_AT_declaration set to true, but yet still have
838 // members, or inheritance, so we can't trust it
839 DWARFDIE child_die = die.GetFirstChild();
841 switch (child_die.Tag()) {
842 case DW_TAG_inheritance:
843 case DW_TAG_subprogram:
845 case DW_TAG_APPLE_property:
846 case DW_TAG_class_type:
847 case DW_TAG_structure_type:
848 case DW_TAG_enumeration_type:
850 case DW_TAG_union_type:
852 is_forward_declaration = false;
855 child_die = child_die.GetSibling();
861 if (!is_forward_declaration) {
862 // Always start the definition for a class type so that
863 // if the class has child classes or types that require
864 // the class to be created for use as their decl contexts
865 // the class will be ready to accept these child definitions.
866 if (die.HasChildren() == false) {
867 // No children for this struct/union/class, lets finish it
868 if (ClangASTContext::StartTagDeclarationDefinition(clang_type)) {
869 ClangASTContext::CompleteTagDeclarationDefinition(clang_type);
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(), type_name_cstr);
878 if (tag == DW_TAG_structure_type) // this only applies in C
880 clang::RecordDecl *record_decl =
881 ClangASTContext::GetAsRecordDecl(clang_type);
884 GetClangASTImporter().InsertRecordDecl(
885 record_decl, ClangASTImporter::LayoutInfo());
888 } else if (clang_type_was_created) {
889 // Start the definition if the class is not objective C since
890 // the underlying decls respond to isCompleteDefinition(). Objective
891 // C decls don't respond to isCompleteDefinition() so we can't
892 // start the declaration definition right away. For C++
893 // class/union/structs
894 // we want to start the definition in case the class is needed as
896 // declaration context for a contained class or type without the
898 // to complete that type..
900 if (class_language != eLanguageTypeObjC &&
901 class_language != eLanguageTypeObjC_plus_plus)
902 ClangASTContext::StartTagDeclarationDefinition(clang_type);
904 // Leave this as a forward declaration until we need
905 // to know the details of the type. lldb_private::Type
906 // will automatically call the SymbolFile virtual function
907 // "SymbolFileDWARF::CompleteType(Type *)"
908 // When the definition needs to be defined.
909 assert(!dwarf->GetForwardDeclClangTypeToDie().count(
910 ClangUtil::RemoveFastQualifiers(clang_type)
911 .GetOpaqueQualType()) &&
912 "Type already in the forward declaration map!");
913 // Can't assume m_ast.GetSymbolFile() is actually a SymbolFileDWARF,
915 // SymbolFileDWARFDebugMap for Apple binaries.
916 dwarf->GetForwardDeclDieToClangType()[die.GetDIE()] =
917 clang_type.GetOpaqueQualType();
918 dwarf->GetForwardDeclClangTypeToDie()
919 [ClangUtil::RemoveFastQualifiers(clang_type)
920 .GetOpaqueQualType()] = die.GetDIERef();
921 m_ast.SetHasExternalStorage(clang_type.GetOpaqueQualType(), true);
926 case DW_TAG_enumeration_type: {
927 // Set a bit that lets us know that we are currently parsing this
928 dwarf->GetDIEToType()[die.GetDIE()] = DIE_IS_BEING_PARSED;
930 DWARFFormValue encoding_form;
932 const size_t num_attributes = die.GetAttributes(attributes);
933 if (num_attributes > 0) {
936 for (i = 0; i < num_attributes; ++i) {
937 attr = attributes.AttributeAtIndex(i);
938 if (attributes.ExtractFormValueAtIndex(i, form_value)) {
940 case DW_AT_decl_file:
941 decl.SetFile(sc.comp_unit->GetSupportFiles().GetFileSpecAtIndex(
942 form_value.Unsigned()));
944 case DW_AT_decl_line:
945 decl.SetLine(form_value.Unsigned());
947 case DW_AT_decl_column:
948 decl.SetColumn(form_value.Unsigned());
951 type_name_cstr = form_value.AsCString();
952 type_name_const_str.SetCString(type_name_cstr);
955 encoding_form = form_value;
957 case DW_AT_byte_size:
958 byte_size = form_value.Unsigned();
960 case DW_AT_accessibility:
961 break; // accessibility =
962 // DW_ACCESS_to_AccessType(form_value.Unsigned()); break;
963 case DW_AT_declaration:
964 is_forward_declaration = form_value.Boolean();
966 case DW_AT_allocated:
967 case DW_AT_associated:
968 case DW_AT_bit_stride:
969 case DW_AT_byte_stride:
970 case DW_AT_data_location:
971 case DW_AT_description:
972 case DW_AT_start_scope:
973 case DW_AT_visibility:
974 case DW_AT_specification:
975 case DW_AT_abstract_origin:
982 if (is_forward_declaration) {
983 type_sp = ParseTypeFromDWO(die, log);
987 DWARFDeclContext die_decl_ctx;
988 die.GetDWARFDeclContext(die_decl_ctx);
991 dwarf->FindDefinitionTypeForDWARFDeclContext(die_decl_ctx);
994 SymbolFileDWARFDebugMap *debug_map_symfile =
995 dwarf->GetDebugMapSymfile();
996 if (debug_map_symfile) {
997 // We weren't able to find a full declaration in
998 // this DWARF, see if we have a declaration anywhere
1001 debug_map_symfile->FindDefinitionTypeForDWARFDeclContext(
1008 dwarf->GetObjectFile()->GetModule()->LogMessage(
1009 log, "SymbolFileDWARF(%p) - 0x%8.8x: %s type \"%s\" is a "
1010 "forward declaration, complete type is 0x%8.8" PRIx64,
1011 static_cast<void *>(this), die.GetOffset(),
1012 DW_TAG_value_to_name(tag), type_name_cstr,
1016 // We found a real definition for this type elsewhere
1017 // so lets use it and cache the fact that we found
1018 // a complete type for this die
1019 dwarf->GetDIEToType()[die.GetDIE()] = type_sp.get();
1020 clang::DeclContext *defn_decl_ctx =
1021 GetCachedClangDeclContextForDIE(dwarf->DebugInfo()->GetDIE(
1022 DIERef(type_sp->GetID(), dwarf)));
1024 LinkDeclContextToDIE(defn_decl_ctx, die);
1028 DEBUG_PRINTF("0x%8.8" PRIx64 ": %s (\"%s\")\n", die.GetID(),
1029 DW_TAG_value_to_name(tag), type_name_cstr);
1031 CompilerType enumerator_clang_type;
1032 clang_type.SetCompilerType(
1034 dwarf->GetForwardDeclDieToClangType().lookup(die.GetDIE()));
1036 if (encoding_form.IsValid()) {
1037 Type *enumerator_type =
1038 dwarf->ResolveTypeUID(DIERef(encoding_form));
1039 if (enumerator_type)
1040 enumerator_clang_type = enumerator_type->GetFullCompilerType();
1043 if (!enumerator_clang_type) {
1044 if (byte_size > 0) {
1045 enumerator_clang_type =
1046 m_ast.GetBuiltinTypeForDWARFEncodingAndBitSize(
1047 NULL, DW_ATE_signed, byte_size * 8);
1049 enumerator_clang_type = m_ast.GetBasicType(eBasicTypeInt);
1053 clang_type = m_ast.CreateEnumerationType(
1054 type_name_cstr, GetClangDeclContextContainingDIE(die, nullptr),
1055 decl, enumerator_clang_type);
1057 enumerator_clang_type =
1058 m_ast.GetEnumerationIntegerType(clang_type.GetOpaqueQualType());
1061 LinkDeclContextToDIE(
1062 ClangASTContext::GetDeclContextForType(clang_type), die);
1064 type_sp.reset(new Type(
1065 die.GetID(), dwarf, type_name_const_str, byte_size, NULL,
1066 DIERef(encoding_form).GetUID(dwarf), Type::eEncodingIsUID, &decl,
1067 clang_type, Type::eResolveStateForward));
1069 if (ClangASTContext::StartTagDeclarationDefinition(clang_type)) {
1070 if (die.HasChildren()) {
1071 SymbolContext cu_sc(die.GetLLDBCompileUnit());
1072 bool is_signed = false;
1073 enumerator_clang_type.IsIntegerType(is_signed);
1074 ParseChildEnumerators(cu_sc, clang_type, is_signed,
1075 type_sp->GetByteSize(), die);
1077 ClangASTContext::CompleteTagDeclarationDefinition(clang_type);
1079 dwarf->GetObjectFile()->GetModule()->ReportError(
1080 "DWARF DIE at 0x%8.8x named \"%s\" was not able to start its "
1081 "definition.\nPlease file a bug and attach the file at the "
1082 "start of this error message",
1083 die.GetOffset(), type_name_cstr);
1088 case DW_TAG_inlined_subroutine:
1089 case DW_TAG_subprogram:
1090 case DW_TAG_subroutine_type: {
1091 // Set a bit that lets us know that we are currently parsing this
1092 dwarf->GetDIEToType()[die.GetDIE()] = DIE_IS_BEING_PARSED;
1094 DWARFFormValue type_die_form;
1095 bool is_variadic = false;
1096 bool is_inline = false;
1097 bool is_static = false;
1098 bool is_virtual = false;
1099 bool is_explicit = false;
1100 bool is_artificial = false;
1101 bool has_template_params = false;
1102 DWARFFormValue specification_die_form;
1103 DWARFFormValue abstract_origin_die_form;
1104 dw_offset_t object_pointer_die_offset = DW_INVALID_OFFSET;
1106 unsigned type_quals = 0;
1107 clang::StorageClass storage =
1108 clang::SC_None; //, Extern, Static, PrivateExtern
1110 const size_t num_attributes = die.GetAttributes(attributes);
1111 if (num_attributes > 0) {
1113 for (i = 0; i < num_attributes; ++i) {
1114 attr = attributes.AttributeAtIndex(i);
1115 if (attributes.ExtractFormValueAtIndex(i, form_value)) {
1117 case DW_AT_decl_file:
1118 decl.SetFile(sc.comp_unit->GetSupportFiles().GetFileSpecAtIndex(
1119 form_value.Unsigned()));
1121 case DW_AT_decl_line:
1122 decl.SetLine(form_value.Unsigned());
1124 case DW_AT_decl_column:
1125 decl.SetColumn(form_value.Unsigned());
1128 type_name_cstr = form_value.AsCString();
1129 type_name_const_str.SetCString(type_name_cstr);
1132 case DW_AT_linkage_name:
1133 case DW_AT_MIPS_linkage_name:
1135 // form_value.AsCString(&dwarf->get_debug_str_data());
1138 type_die_form = form_value;
1140 case DW_AT_accessibility:
1141 accessibility = DW_ACCESS_to_AccessType(form_value.Unsigned());
1143 case DW_AT_declaration:
1144 break; // is_forward_declaration = form_value.Boolean(); break;
1146 is_inline = form_value.Boolean();
1148 case DW_AT_virtuality:
1149 is_virtual = form_value.Boolean();
1151 case DW_AT_explicit:
1152 is_explicit = form_value.Boolean();
1154 case DW_AT_artificial:
1155 is_artificial = form_value.Boolean();
1158 case DW_AT_external:
1159 if (form_value.Unsigned()) {
1160 if (storage == clang::SC_None)
1161 storage = clang::SC_Extern;
1163 storage = clang::SC_PrivateExtern;
1167 case DW_AT_specification:
1168 specification_die_form = form_value;
1171 case DW_AT_abstract_origin:
1172 abstract_origin_die_form = form_value;
1175 case DW_AT_object_pointer:
1176 object_pointer_die_offset = form_value.Reference();
1179 case DW_AT_allocated:
1180 case DW_AT_associated:
1181 case DW_AT_address_class:
1182 case DW_AT_calling_convention:
1183 case DW_AT_data_location:
1184 case DW_AT_elemental:
1185 case DW_AT_entry_pc:
1186 case DW_AT_frame_base:
1189 case DW_AT_prototyped:
1192 case DW_AT_recursive:
1193 case DW_AT_return_addr:
1195 case DW_AT_start_scope:
1196 case DW_AT_static_link:
1197 case DW_AT_trampoline:
1198 case DW_AT_visibility:
1199 case DW_AT_vtable_elem_location:
1200 case DW_AT_description:
1208 std::string object_pointer_name;
1209 if (object_pointer_die_offset != DW_INVALID_OFFSET) {
1210 DWARFDIE object_pointer_die = die.GetDIE(object_pointer_die_offset);
1211 if (object_pointer_die) {
1212 const char *object_pointer_name_cstr = object_pointer_die.GetName();
1213 if (object_pointer_name_cstr)
1214 object_pointer_name = object_pointer_name_cstr;
1218 DEBUG_PRINTF("0x%8.8" PRIx64 ": %s (\"%s\")\n", die.GetID(),
1219 DW_TAG_value_to_name(tag), type_name_cstr);
1221 CompilerType return_clang_type;
1222 Type *func_type = NULL;
1224 if (type_die_form.IsValid())
1225 func_type = dwarf->ResolveTypeUID(DIERef(type_die_form));
1228 return_clang_type = func_type->GetForwardCompilerType();
1230 return_clang_type = m_ast.GetBasicType(eBasicTypeVoid);
1232 std::vector<CompilerType> function_param_types;
1233 std::vector<clang::ParmVarDecl *> function_param_decls;
1235 // Parse the function children for the parameters
1237 DWARFDIE decl_ctx_die;
1238 clang::DeclContext *containing_decl_ctx =
1239 GetClangDeclContextContainingDIE(die, &decl_ctx_die);
1240 const clang::Decl::Kind containing_decl_kind =
1241 containing_decl_ctx->getDeclKind();
1243 bool is_cxx_method = DeclKindIsCXXClass(containing_decl_kind);
1244 // Start off static. This will be set to false in
1245 // ParseChildParameters(...)
1246 // if we find a "this" parameters as the first parameter
1247 if (is_cxx_method) {
1251 if (die.HasChildren()) {
1252 bool skip_artificial = true;
1253 ParseChildParameters(sc, containing_decl_ctx, die, skip_artificial,
1254 is_static, is_variadic, has_template_params,
1255 function_param_types, function_param_decls,
1259 bool ignore_containing_context = false;
1260 // Check for templatized class member functions. If we had any
1261 // DW_TAG_template_type_parameter
1262 // or DW_TAG_template_value_parameter the DW_TAG_subprogram DIE, then we
1263 // can't let this become
1264 // a method in a class. Why? Because templatized functions are only
1265 // emitted if one of the
1266 // templatized methods is used in the current compile unit and we will
1267 // end up with classes
1268 // that may or may not include these member functions and this means one
1269 // class won't match another
1270 // class definition and it affects our ability to use a class in the
1271 // clang expression parser. So
1272 // for the greater good, we currently must not allow any template member
1273 // functions in a class definition.
1274 if (is_cxx_method && has_template_params) {
1275 ignore_containing_context = true;
1276 is_cxx_method = false;
1279 // clang_type will get the function prototype clang type after this call
1280 clang_type = m_ast.CreateFunctionType(
1281 return_clang_type, function_param_types.data(),
1282 function_param_types.size(), is_variadic, type_quals);
1284 if (type_name_cstr) {
1285 bool type_handled = false;
1286 if (tag == DW_TAG_subprogram || tag == DW_TAG_inlined_subroutine) {
1287 ObjCLanguage::MethodName objc_method(type_name_cstr, true);
1288 if (objc_method.IsValid(true)) {
1289 CompilerType class_opaque_type;
1290 ConstString class_name(objc_method.GetClassName());
1292 TypeSP complete_objc_class_type_sp(
1293 dwarf->FindCompleteObjCDefinitionTypeForDIE(
1294 DWARFDIE(), class_name, false));
1296 if (complete_objc_class_type_sp) {
1297 CompilerType type_clang_forward_type =
1298 complete_objc_class_type_sp->GetForwardCompilerType();
1299 if (ClangASTContext::IsObjCObjectOrInterfaceType(
1300 type_clang_forward_type))
1301 class_opaque_type = type_clang_forward_type;
1305 if (class_opaque_type) {
1306 // If accessibility isn't set to anything valid, assume public
1309 if (accessibility == eAccessNone)
1310 accessibility = eAccessPublic;
1312 clang::ObjCMethodDecl *objc_method_decl =
1313 m_ast.AddMethodToObjCObjectType(
1314 class_opaque_type, type_name_cstr, clang_type,
1315 accessibility, is_artificial, is_variadic);
1316 type_handled = objc_method_decl != NULL;
1318 LinkDeclContextToDIE(
1319 ClangASTContext::GetAsDeclContext(objc_method_decl), die);
1320 m_ast.SetMetadataAsUserID(objc_method_decl, die.GetID());
1322 dwarf->GetObjectFile()->GetModule()->ReportError(
1323 "{0x%8.8x}: invalid Objective-C method 0x%4.4x (%s), "
1324 "please file a bug and attach the file at the start of "
1325 "this error message",
1326 die.GetOffset(), tag, DW_TAG_value_to_name(tag));
1329 } else if (is_cxx_method) {
1330 // Look at the parent of this DIE and see if is is
1331 // a class or struct and see if this is actually a
1333 Type *class_type = dwarf->ResolveType(decl_ctx_die);
1335 bool alternate_defn = false;
1336 if (class_type->GetID() != decl_ctx_die.GetID() ||
1337 decl_ctx_die.GetContainingDWOModuleDIE()) {
1338 alternate_defn = true;
1340 // We uniqued the parent class of this function to another
1342 // so we now need to associate all dies under "decl_ctx_die"
1344 // DIEs in the DIE for "class_type"...
1345 SymbolFileDWARF *class_symfile = NULL;
1346 DWARFDIE class_type_die;
1348 SymbolFileDWARFDebugMap *debug_map_symfile =
1349 dwarf->GetDebugMapSymfile();
1350 if (debug_map_symfile) {
1351 class_symfile = debug_map_symfile->GetSymbolFileByOSOIndex(
1352 SymbolFileDWARFDebugMap::GetOSOIndexFromUserID(
1353 class_type->GetID()));
1354 class_type_die = class_symfile->DebugInfo()->GetDIE(
1355 DIERef(class_type->GetID(), dwarf));
1357 class_symfile = dwarf;
1358 class_type_die = dwarf->DebugInfo()->GetDIE(
1359 DIERef(class_type->GetID(), dwarf));
1361 if (class_type_die) {
1362 DWARFDIECollection failures;
1364 CopyUniqueClassMethodTypes(decl_ctx_die, class_type_die,
1365 class_type, failures);
1367 // FIXME do something with these failures that's smarter
1369 // just dropping them on the ground. Unfortunately classes
1371 // like having stuff added to them after their definitions
1375 type_ptr = dwarf->GetDIEToType()[die.GetDIE()];
1376 if (type_ptr && type_ptr != DIE_IS_BEING_PARSED) {
1377 type_sp = type_ptr->shared_from_this();
1383 if (specification_die_form.IsValid()) {
1384 // We have a specification which we are going to base our
1386 // prototype off of, so we need this type to be completed so
1388 // m_die_to_decl_ctx for the method in the specification has a
1390 // clang decl context.
1391 class_type->GetForwardCompilerType();
1392 // If we have a specification, then the function type should
1394 // made with the specification and not with this die.
1395 DWARFDIE spec_die = dwarf->DebugInfo()->GetDIE(
1396 DIERef(specification_die_form));
1397 clang::DeclContext *spec_clang_decl_ctx =
1398 GetClangDeclContextForDIE(spec_die);
1399 if (spec_clang_decl_ctx) {
1400 LinkDeclContextToDIE(spec_clang_decl_ctx, die);
1402 dwarf->GetObjectFile()->GetModule()->ReportWarning(
1403 "0x%8.8" PRIx64 ": DW_AT_specification(0x%8.8" PRIx64
1405 die.GetID(), specification_die_form.Reference());
1407 type_handled = true;
1408 } else if (abstract_origin_die_form.IsValid()) {
1409 // We have a specification which we are going to base our
1411 // prototype off of, so we need this type to be completed so
1413 // m_die_to_decl_ctx for the method in the abstract origin has
1415 // clang decl context.
1416 class_type->GetForwardCompilerType();
1418 DWARFDIE abs_die = dwarf->DebugInfo()->GetDIE(
1419 DIERef(abstract_origin_die_form));
1420 clang::DeclContext *abs_clang_decl_ctx =
1421 GetClangDeclContextForDIE(abs_die);
1422 if (abs_clang_decl_ctx) {
1423 LinkDeclContextToDIE(abs_clang_decl_ctx, die);
1425 dwarf->GetObjectFile()->GetModule()->ReportWarning(
1426 "0x%8.8" PRIx64 ": DW_AT_abstract_origin(0x%8.8" PRIx64
1428 die.GetID(), abstract_origin_die_form.Reference());
1430 type_handled = true;
1432 CompilerType class_opaque_type =
1433 class_type->GetForwardCompilerType();
1434 if (ClangASTContext::IsCXXClassType(class_opaque_type)) {
1435 if (class_opaque_type.IsBeingDefined() || alternate_defn) {
1436 if (!is_static && !die.HasChildren()) {
1437 // We have a C++ member function with no children (this
1439 // and clang will get mad if we try and make a function
1441 // well formed in the DWARF, so we will just skip it...
1442 type_handled = true;
1444 bool add_method = true;
1445 if (alternate_defn) {
1446 // If an alternate definition for the class exists,
1447 // then add the method only if an
1448 // equivalent is not already present.
1449 clang::CXXRecordDecl *record_decl =
1450 m_ast.GetAsCXXRecordDecl(
1451 class_opaque_type.GetOpaqueQualType());
1453 for (auto method_iter = record_decl->method_begin();
1454 method_iter != record_decl->method_end();
1456 clang::CXXMethodDecl *method_decl = *method_iter;
1457 if (method_decl->getNameInfo().getAsString() ==
1458 std::string(type_name_cstr)) {
1459 if (method_decl->getType() ==
1460 ClangUtil::GetQualType(clang_type)) {
1462 LinkDeclContextToDIE(
1463 ClangASTContext::GetAsDeclContext(
1466 type_handled = true;
1476 llvm::PrettyStackTraceFormat stack_trace(
1477 "SymbolFileDWARF::ParseType() is adding a method "
1478 "%s to class %s in DIE 0x%8.8" PRIx64 " from %s",
1480 class_type->GetName().GetCString(), die.GetID(),
1481 dwarf->GetObjectFile()
1486 const bool is_attr_used = false;
1487 // Neither GCC 4.2 nor clang++ currently set a valid
1489 // in the DWARF for C++ methods... Default to public
1491 if (accessibility == eAccessNone)
1492 accessibility = eAccessPublic;
1494 clang::CXXMethodDecl *cxx_method_decl =
1495 m_ast.AddMethodToCXXRecordType(
1496 class_opaque_type.GetOpaqueQualType(),
1497 type_name_cstr, clang_type, accessibility,
1498 is_virtual, is_static, is_inline, is_explicit,
1499 is_attr_used, is_artificial);
1501 type_handled = cxx_method_decl != NULL;
1504 LinkDeclContextToDIE(
1505 ClangASTContext::GetAsDeclContext(
1509 ClangASTMetadata metadata;
1510 metadata.SetUserID(die.GetID());
1512 if (!object_pointer_name.empty()) {
1513 metadata.SetObjectPtrName(
1514 object_pointer_name.c_str());
1517 "Setting object pointer name: %s on method "
1519 object_pointer_name.c_str(),
1520 static_cast<void *>(cxx_method_decl));
1522 m_ast.SetMetadata(cxx_method_decl, metadata);
1524 ignore_containing_context = true;
1529 // We were asked to parse the type for a method in a
1531 // class hasn't been asked to complete itself through the
1532 // clang::ExternalASTSource protocol, so we need to just
1534 // class complete itself and do things the right way, then
1536 // DIE should then have an entry in the
1537 // dwarf->GetDIEToType() map. First
1538 // we need to modify the dwarf->GetDIEToType() so it
1539 // doesn't think we are
1540 // trying to parse this DIE anymore...
1541 dwarf->GetDIEToType()[die.GetDIE()] = NULL;
1543 // Now we get the full type to force our class type to
1545 // using the clang::ExternalASTSource protocol which will
1547 // base classes and all methods (including the method for
1549 class_type->GetFullCompilerType();
1551 // The type for this DIE should have been filled in the
1552 // function call above
1553 type_ptr = dwarf->GetDIEToType()[die.GetDIE()];
1554 if (type_ptr && type_ptr != DIE_IS_BEING_PARSED) {
1555 type_sp = type_ptr->shared_from_this();
1559 // FIXME This is fixing some even uglier behavior but we
1561 // uniq the methods of each class as well as the class
1563 // <rdar://problem/11240464>
1564 type_handled = true;
1572 if (!type_handled) {
1573 clang::FunctionDecl *function_decl = nullptr;
1575 if (abstract_origin_die_form.IsValid()) {
1577 dwarf->DebugInfo()->GetDIE(DIERef(abstract_origin_die_form));
1581 if (dwarf->ResolveType(abs_die)) {
1582 function_decl = llvm::dyn_cast_or_null<clang::FunctionDecl>(
1583 GetCachedClangDeclContextForDIE(abs_die));
1585 if (function_decl) {
1586 LinkDeclContextToDIE(function_decl, die);
1591 if (!function_decl) {
1592 // We just have a function that isn't part of a class
1593 function_decl = m_ast.CreateFunctionDeclaration(
1594 ignore_containing_context ? m_ast.GetTranslationUnitDecl()
1595 : containing_decl_ctx,
1596 type_name_cstr, clang_type, storage, is_inline);
1598 if (has_template_params) {
1599 ClangASTContext::TemplateParameterInfos template_param_infos;
1600 ParseTemplateParameterInfos(die, template_param_infos);
1601 clang::FunctionTemplateDecl *func_template_decl =
1602 m_ast.CreateFunctionTemplateDecl(
1603 containing_decl_ctx, function_decl, type_name_cstr,
1604 template_param_infos);
1605 m_ast.CreateFunctionTemplateSpecializationInfo(
1606 function_decl, func_template_decl, template_param_infos);
1609 lldbassert(function_decl);
1611 if (function_decl) {
1612 LinkDeclContextToDIE(function_decl, die);
1614 if (!function_param_decls.empty())
1615 m_ast.SetFunctionParameters(function_decl,
1616 &function_param_decls.front(),
1617 function_param_decls.size());
1619 ClangASTMetadata metadata;
1620 metadata.SetUserID(die.GetID());
1622 if (!object_pointer_name.empty()) {
1623 metadata.SetObjectPtrName(object_pointer_name.c_str());
1625 log->Printf("Setting object pointer name: %s on function "
1627 object_pointer_name.c_str(),
1628 static_cast<void *>(function_decl));
1630 m_ast.SetMetadata(function_decl, metadata);
1635 type_sp.reset(new Type(die.GetID(), dwarf, type_name_const_str, 0, NULL,
1636 LLDB_INVALID_UID, Type::eEncodingIsUID, &decl,
1637 clang_type, Type::eResolveStateFull));
1638 assert(type_sp.get());
1641 case DW_TAG_array_type: {
1642 // Set a bit that lets us know that we are currently parsing this
1643 dwarf->GetDIEToType()[die.GetDIE()] = DIE_IS_BEING_PARSED;
1645 DWARFFormValue type_die_form;
1646 int64_t first_index = 0;
1647 uint32_t byte_stride = 0;
1648 uint32_t bit_stride = 0;
1649 bool is_vector = false;
1650 const size_t num_attributes = die.GetAttributes(attributes);
1652 if (num_attributes > 0) {
1654 for (i = 0; i < num_attributes; ++i) {
1655 attr = attributes.AttributeAtIndex(i);
1656 if (attributes.ExtractFormValueAtIndex(i, form_value)) {
1658 case DW_AT_decl_file:
1659 decl.SetFile(sc.comp_unit->GetSupportFiles().GetFileSpecAtIndex(
1660 form_value.Unsigned()));
1662 case DW_AT_decl_line:
1663 decl.SetLine(form_value.Unsigned());
1665 case DW_AT_decl_column:
1666 decl.SetColumn(form_value.Unsigned());
1669 type_name_cstr = form_value.AsCString();
1670 type_name_const_str.SetCString(type_name_cstr);
1674 type_die_form = form_value;
1676 case DW_AT_byte_size:
1677 break; // byte_size = form_value.Unsigned(); break;
1678 case DW_AT_byte_stride:
1679 byte_stride = form_value.Unsigned();
1681 case DW_AT_bit_stride:
1682 bit_stride = form_value.Unsigned();
1684 case DW_AT_GNU_vector:
1685 is_vector = form_value.Boolean();
1687 case DW_AT_accessibility:
1688 break; // accessibility =
1689 // DW_ACCESS_to_AccessType(form_value.Unsigned()); break;
1690 case DW_AT_declaration:
1691 break; // is_forward_declaration = form_value.Boolean(); break;
1692 case DW_AT_allocated:
1693 case DW_AT_associated:
1694 case DW_AT_data_location:
1695 case DW_AT_description:
1696 case DW_AT_ordering:
1697 case DW_AT_start_scope:
1698 case DW_AT_visibility:
1699 case DW_AT_specification:
1700 case DW_AT_abstract_origin:
1707 DEBUG_PRINTF("0x%8.8" PRIx64 ": %s (\"%s\")\n", die.GetID(),
1708 DW_TAG_value_to_name(tag), type_name_cstr);
1710 DIERef type_die_ref(type_die_form);
1711 Type *element_type = dwarf->ResolveTypeUID(type_die_ref);
1714 std::vector<uint64_t> element_orders;
1715 ParseChildArrayInfo(sc, die, first_index, element_orders,
1716 byte_stride, bit_stride);
1717 if (byte_stride == 0 && bit_stride == 0)
1718 byte_stride = element_type->GetByteSize();
1719 CompilerType array_element_type =
1720 element_type->GetForwardCompilerType();
1722 if (ClangASTContext::IsCXXClassType(array_element_type) &&
1723 array_element_type.GetCompleteType() == false) {
1724 ModuleSP module_sp = die.GetModule();
1726 if (die.GetCU()->GetProducer() ==
1727 DWARFCompileUnit::eProducerClang)
1728 module_sp->ReportError(
1729 "DWARF DW_TAG_array_type DIE at 0x%8.8x has a "
1730 "class/union/struct element type DIE 0x%8.8x that is a "
1731 "forward declaration, not a complete definition.\nTry "
1732 "compiling the source file with -fno-limit-debug-info or "
1734 die.GetOffset(), type_die_ref.die_offset);
1736 module_sp->ReportError(
1737 "DWARF DW_TAG_array_type DIE at 0x%8.8x has a "
1738 "class/union/struct element type DIE 0x%8.8x that is a "
1739 "forward declaration, not a complete definition.\nPlease "
1740 "file a bug against the compiler and include the "
1741 "preprocessed output for %s",
1742 die.GetOffset(), type_die_ref.die_offset,
1743 die.GetLLDBCompileUnit()
1744 ? die.GetLLDBCompileUnit()->GetPath().c_str()
1745 : "the source file");
1748 // We have no choice other than to pretend that the element class
1750 // is complete. If we don't do this, clang will crash when trying
1751 // to layout the class. Since we provide layout assistance, all
1752 // ivars in this class and other classes will be fine, this is
1753 // the best we can do short of crashing.
1754 if (ClangASTContext::StartTagDeclarationDefinition(
1755 array_element_type)) {
1756 ClangASTContext::CompleteTagDeclarationDefinition(
1757 array_element_type);
1759 module_sp->ReportError("DWARF DIE at 0x%8.8x was not able to "
1760 "start its definition.\nPlease file a "
1761 "bug and attach the file at the start "
1762 "of this error message",
1763 type_die_ref.die_offset);
1767 uint64_t array_element_bit_stride = byte_stride * 8 + bit_stride;
1768 if (element_orders.size() > 0) {
1769 uint64_t num_elements = 0;
1770 std::vector<uint64_t>::const_reverse_iterator pos;
1771 std::vector<uint64_t>::const_reverse_iterator end =
1772 element_orders.rend();
1773 for (pos = element_orders.rbegin(); pos != end; ++pos) {
1774 num_elements = *pos;
1775 clang_type = m_ast.CreateArrayType(array_element_type,
1776 num_elements, is_vector);
1777 array_element_type = clang_type;
1778 array_element_bit_stride =
1779 num_elements ? array_element_bit_stride * num_elements
1780 : array_element_bit_stride;
1784 m_ast.CreateArrayType(array_element_type, 0, is_vector);
1786 ConstString empty_name;
1787 type_sp.reset(new Type(
1788 die.GetID(), dwarf, empty_name, array_element_bit_stride / 8,
1789 NULL, DIERef(type_die_form).GetUID(dwarf), Type::eEncodingIsUID,
1790 &decl, clang_type, Type::eResolveStateFull));
1791 type_sp->SetEncodingType(element_type);
1796 case DW_TAG_ptr_to_member_type: {
1797 DWARFFormValue type_die_form;
1798 DWARFFormValue containing_type_die_form;
1800 const size_t num_attributes = die.GetAttributes(attributes);
1802 if (num_attributes > 0) {
1804 for (i = 0; i < num_attributes; ++i) {
1805 attr = attributes.AttributeAtIndex(i);
1806 if (attributes.ExtractFormValueAtIndex(i, form_value)) {
1809 type_die_form = form_value;
1811 case DW_AT_containing_type:
1812 containing_type_die_form = form_value;
1818 Type *pointee_type = dwarf->ResolveTypeUID(DIERef(type_die_form));
1820 dwarf->ResolveTypeUID(DIERef(containing_type_die_form));
1822 CompilerType pointee_clang_type =
1823 pointee_type->GetForwardCompilerType();
1824 CompilerType class_clang_type = class_type->GetLayoutCompilerType();
1826 clang_type = ClangASTContext::CreateMemberPointerType(
1827 class_clang_type, pointee_clang_type);
1829 byte_size = clang_type.GetByteSize(nullptr);
1831 type_sp.reset(new Type(die.GetID(), dwarf, type_name_const_str,
1832 byte_size, NULL, LLDB_INVALID_UID,
1833 Type::eEncodingIsUID, NULL, clang_type,
1834 Type::eResolveStateForward));
1840 dwarf->GetObjectFile()->GetModule()->ReportError(
1841 "{0x%8.8x}: unhandled type tag 0x%4.4x (%s), please file a bug and "
1842 "attach the file at the start of this error message",
1843 die.GetOffset(), tag, DW_TAG_value_to_name(tag));
1847 if (type_sp.get()) {
1848 DWARFDIE sc_parent_die =
1849 SymbolFileDWARF::GetParentSymbolContextDIE(die);
1850 dw_tag_t sc_parent_tag = sc_parent_die.Tag();
1852 SymbolContextScope *symbol_context_scope = NULL;
1853 if (sc_parent_tag == DW_TAG_compile_unit) {
1854 symbol_context_scope = sc.comp_unit;
1855 } else if (sc.function != NULL && sc_parent_die) {
1856 symbol_context_scope =
1857 sc.function->GetBlock(true).FindBlockByID(sc_parent_die.GetID());
1858 if (symbol_context_scope == NULL)
1859 symbol_context_scope = sc.function;
1862 if (symbol_context_scope != NULL) {
1863 type_sp->SetSymbolContextScope(symbol_context_scope);
1866 // We are ready to put this type into the uniqued list up at the module
1868 type_list->Insert(type_sp);
1870 dwarf->GetDIEToType()[die.GetDIE()] = type_sp.get();
1872 } else if (type_ptr != DIE_IS_BEING_PARSED) {
1873 type_sp = type_ptr->shared_from_this();
1879 // DWARF parsing functions
1881 class DWARFASTParserClang::DelayedAddObjCClassProperty {
1883 DelayedAddObjCClassProperty(
1884 const CompilerType &class_opaque_type, const char *property_name,
1885 const CompilerType &property_opaque_type, // The property type is only
1886 // required if you don't have an
1888 clang::ObjCIvarDecl *ivar_decl, const char *property_setter_name,
1889 const char *property_getter_name, uint32_t property_attributes,
1890 const ClangASTMetadata *metadata)
1891 : m_class_opaque_type(class_opaque_type), m_property_name(property_name),
1892 m_property_opaque_type(property_opaque_type), m_ivar_decl(ivar_decl),
1893 m_property_setter_name(property_setter_name),
1894 m_property_getter_name(property_getter_name),
1895 m_property_attributes(property_attributes) {
1896 if (metadata != NULL) {
1897 m_metadata_ap.reset(new ClangASTMetadata());
1898 *m_metadata_ap = *metadata;
1902 DelayedAddObjCClassProperty(const DelayedAddObjCClassProperty &rhs) {
1906 DelayedAddObjCClassProperty &
1907 operator=(const DelayedAddObjCClassProperty &rhs) {
1908 m_class_opaque_type = rhs.m_class_opaque_type;
1909 m_property_name = rhs.m_property_name;
1910 m_property_opaque_type = rhs.m_property_opaque_type;
1911 m_ivar_decl = rhs.m_ivar_decl;
1912 m_property_setter_name = rhs.m_property_setter_name;
1913 m_property_getter_name = rhs.m_property_getter_name;
1914 m_property_attributes = rhs.m_property_attributes;
1916 if (rhs.m_metadata_ap.get()) {
1917 m_metadata_ap.reset(new ClangASTMetadata());
1918 *m_metadata_ap = *rhs.m_metadata_ap;
1924 return ClangASTContext::AddObjCClassProperty(
1925 m_class_opaque_type, m_property_name, m_property_opaque_type,
1926 m_ivar_decl, m_property_setter_name, m_property_getter_name,
1927 m_property_attributes, m_metadata_ap.get());
1931 CompilerType m_class_opaque_type;
1932 const char *m_property_name;
1933 CompilerType m_property_opaque_type;
1934 clang::ObjCIvarDecl *m_ivar_decl;
1935 const char *m_property_setter_name;
1936 const char *m_property_getter_name;
1937 uint32_t m_property_attributes;
1938 std::unique_ptr<ClangASTMetadata> m_metadata_ap;
1941 bool DWARFASTParserClang::ParseTemplateDIE(
1942 const DWARFDIE &die,
1943 ClangASTContext::TemplateParameterInfos &template_param_infos) {
1944 const dw_tag_t tag = die.Tag();
1947 case DW_TAG_GNU_template_parameter_pack: {
1948 template_param_infos.packed_args.reset(
1949 new ClangASTContext::TemplateParameterInfos);
1950 for (DWARFDIE child_die = die.GetFirstChild(); child_die.IsValid();
1951 child_die = child_die.GetSibling()) {
1952 if (!ParseTemplateDIE(child_die, *template_param_infos.packed_args))
1955 if (const char *name = die.GetName()) {
1956 template_param_infos.pack_name = name;
1960 case DW_TAG_template_type_parameter:
1961 case DW_TAG_template_value_parameter: {
1962 DWARFAttributes attributes;
1963 const size_t num_attributes = die.GetAttributes(attributes);
1964 const char *name = nullptr;
1965 CompilerType clang_type;
1966 uint64_t uval64 = 0;
1967 bool uval64_valid = false;
1968 if (num_attributes > 0) {
1969 DWARFFormValue form_value;
1970 for (size_t i = 0; i < num_attributes; ++i) {
1971 const dw_attr_t attr = attributes.AttributeAtIndex(i);
1975 if (attributes.ExtractFormValueAtIndex(i, form_value))
1976 name = form_value.AsCString();
1980 if (attributes.ExtractFormValueAtIndex(i, form_value)) {
1981 Type *lldb_type = die.ResolveTypeUID(DIERef(form_value));
1983 clang_type = lldb_type->GetForwardCompilerType();
1987 case DW_AT_const_value:
1988 if (attributes.ExtractFormValueAtIndex(i, form_value)) {
1989 uval64_valid = true;
1990 uval64 = form_value.Unsigned();
1998 clang::ASTContext *ast = m_ast.getASTContext();
2000 clang_type = m_ast.GetBasicType(eBasicTypeVoid);
2003 bool is_signed = false;
2004 if (name && name[0])
2005 template_param_infos.names.push_back(name);
2007 template_param_infos.names.push_back(NULL);
2009 // Get the signed value for any integer or enumeration if available
2010 clang_type.IsIntegerOrEnumerationType(is_signed);
2012 if (tag == DW_TAG_template_value_parameter && uval64_valid) {
2013 llvm::APInt apint(clang_type.GetBitSize(nullptr), uval64, is_signed);
2014 template_param_infos.args.push_back(
2015 clang::TemplateArgument(*ast, llvm::APSInt(apint, !is_signed),
2016 ClangUtil::GetQualType(clang_type)));
2018 template_param_infos.args.push_back(
2019 clang::TemplateArgument(ClangUtil::GetQualType(clang_type)));
2034 bool DWARFASTParserClang::ParseTemplateParameterInfos(
2035 const DWARFDIE &parent_die,
2036 ClangASTContext::TemplateParameterInfos &template_param_infos) {
2041 Args template_parameter_names;
2042 for (DWARFDIE die = parent_die.GetFirstChild(); die.IsValid();
2043 die = die.GetSibling()) {
2044 const dw_tag_t tag = die.Tag();
2047 case DW_TAG_template_type_parameter:
2048 case DW_TAG_template_value_parameter:
2049 case DW_TAG_GNU_template_parameter_pack:
2050 ParseTemplateDIE(die, template_param_infos);
2057 if (template_param_infos.args.empty())
2059 return template_param_infos.args.size() == template_param_infos.names.size();
2062 bool DWARFASTParserClang::CompleteTypeFromDWARF(const DWARFDIE &die,
2063 lldb_private::Type *type,
2064 CompilerType &clang_type) {
2065 SymbolFileDWARF *dwarf = die.GetDWARF();
2067 std::lock_guard<std::recursive_mutex> guard(
2068 dwarf->GetObjectFile()->GetModule()->GetMutex());
2070 // Disable external storage for this type so we don't get anymore
2071 // clang::ExternalASTSource queries for this type.
2072 m_ast.SetHasExternalStorage(clang_type.GetOpaqueQualType(), false);
2077 #if defined LLDB_CONFIGURATION_DEBUG
2078 //----------------------------------------------------------------------
2079 // For debugging purposes, the LLDB_DWARF_DONT_COMPLETE_TYPENAMES
2080 // environment variable can be set with one or more typenames separated
2081 // by ';' characters. This will cause this function to not complete any
2082 // types whose names match.
2084 // Examples of setting this environment variable:
2086 // LLDB_DWARF_DONT_COMPLETE_TYPENAMES=Foo
2087 // LLDB_DWARF_DONT_COMPLETE_TYPENAMES=Foo;Bar;Baz
2088 //----------------------------------------------------------------------
2089 const char *dont_complete_typenames_cstr =
2090 getenv("LLDB_DWARF_DONT_COMPLETE_TYPENAMES");
2091 if (dont_complete_typenames_cstr && dont_complete_typenames_cstr[0]) {
2092 const char *die_name = die.GetName();
2093 if (die_name && die_name[0]) {
2094 const char *match = strstr(dont_complete_typenames_cstr, die_name);
2096 size_t die_name_length = strlen(die_name);
2098 const char separator_char = ';';
2099 const char next_char = match[die_name_length];
2100 if (next_char == '\0' || next_char == separator_char) {
2101 if (match == dont_complete_typenames_cstr ||
2102 match[-1] == separator_char)
2105 match = strstr(match + 1, die_name);
2112 const dw_tag_t tag = die.Tag();
2115 nullptr; // (LogChannelDWARF::GetLogIfAny(DWARF_LOG_DEBUG_INFO|DWARF_LOG_TYPE_COMPLETION));
2117 dwarf->GetObjectFile()->GetModule()->LogMessageVerboseBacktrace(
2118 log, "0x%8.8" PRIx64 ": %s '%s' resolving forward declaration...",
2119 die.GetID(), die.GetTagAsCString(), type->GetName().AsCString());
2121 DWARFAttributes attributes;
2123 case DW_TAG_structure_type:
2124 case DW_TAG_union_type:
2125 case DW_TAG_class_type: {
2126 ClangASTImporter::LayoutInfo layout_info;
2129 if (die.HasChildren()) {
2130 LanguageType class_language = eLanguageTypeUnknown;
2131 if (ClangASTContext::IsObjCObjectOrInterfaceType(clang_type)) {
2132 class_language = eLanguageTypeObjC;
2133 // For objective C we don't start the definition when
2134 // the class is created.
2135 ClangASTContext::StartTagDeclarationDefinition(clang_type);
2138 int tag_decl_kind = -1;
2139 AccessType default_accessibility = eAccessNone;
2140 if (tag == DW_TAG_structure_type) {
2141 tag_decl_kind = clang::TTK_Struct;
2142 default_accessibility = eAccessPublic;
2143 } else if (tag == DW_TAG_union_type) {
2144 tag_decl_kind = clang::TTK_Union;
2145 default_accessibility = eAccessPublic;
2146 } else if (tag == DW_TAG_class_type) {
2147 tag_decl_kind = clang::TTK_Class;
2148 default_accessibility = eAccessPrivate;
2151 SymbolContext sc(die.GetLLDBCompileUnit());
2152 std::vector<clang::CXXBaseSpecifier *> base_classes;
2153 std::vector<int> member_accessibilities;
2154 bool is_a_class = false;
2155 // Parse members and base classes first
2156 DWARFDIECollection member_function_dies;
2158 DelayedPropertyList delayed_properties;
2159 ParseChildMembers(sc, die, clang_type, class_language, base_classes,
2160 member_accessibilities, member_function_dies,
2161 delayed_properties, default_accessibility, is_a_class,
2164 // Now parse any methods if there were any...
2165 size_t num_functions = member_function_dies.Size();
2166 if (num_functions > 0) {
2167 for (size_t i = 0; i < num_functions; ++i) {
2168 dwarf->ResolveType(member_function_dies.GetDIEAtIndex(i));
2172 if (class_language == eLanguageTypeObjC) {
2173 ConstString class_name(clang_type.GetTypeName());
2175 DIEArray method_die_offsets;
2176 dwarf->GetObjCMethodDIEOffsets(class_name, method_die_offsets);
2178 if (!method_die_offsets.empty()) {
2179 DWARFDebugInfo *debug_info = dwarf->DebugInfo();
2181 const size_t num_matches = method_die_offsets.size();
2182 for (size_t i = 0; i < num_matches; ++i) {
2183 const DIERef &die_ref = method_die_offsets[i];
2184 DWARFDIE method_die = debug_info->GetDIE(die_ref);
2187 method_die.ResolveType();
2191 for (DelayedPropertyList::iterator pi = delayed_properties.begin(),
2192 pe = delayed_properties.end();
2198 // If we have a DW_TAG_structure_type instead of a DW_TAG_class_type we
2199 // need to tell the clang type it is actually a class.
2200 if (class_language != eLanguageTypeObjC) {
2201 if (is_a_class && tag_decl_kind != clang::TTK_Class)
2202 m_ast.SetTagTypeKind(ClangUtil::GetQualType(clang_type),
2206 // Since DW_TAG_structure_type gets used for both classes
2207 // and structures, we may need to set any DW_TAG_member
2208 // fields to have a "private" access if none was specified.
2209 // When we parsed the child members we tracked that actual
2210 // accessibility value for each DW_TAG_member in the
2211 // "member_accessibilities" array. If the value for the
2212 // member is zero, then it was set to the "default_accessibility"
2213 // which for structs was "public". Below we correct this
2214 // by setting any fields to "private" that weren't correctly
2216 if (is_a_class && !member_accessibilities.empty()) {
2217 // This is a class and all members that didn't have
2218 // their access specified are private.
2219 m_ast.SetDefaultAccessForRecordFields(
2220 m_ast.GetAsRecordDecl(clang_type), eAccessPrivate,
2221 &member_accessibilities.front(), member_accessibilities.size());
2224 if (!base_classes.empty()) {
2225 // Make sure all base classes refer to complete types and not
2226 // forward declarations. If we don't do this, clang will crash
2227 // with an assertion in the call to
2228 // clang_type.SetBaseClassesForClassType()
2229 for (auto &base_class : base_classes) {
2230 clang::TypeSourceInfo *type_source_info =
2231 base_class->getTypeSourceInfo();
2232 if (type_source_info) {
2233 CompilerType base_class_type(
2234 &m_ast, type_source_info->getType().getAsOpaquePtr());
2235 if (base_class_type.GetCompleteType() == false) {
2236 auto module = dwarf->GetObjectFile()->GetModule();
2237 module->ReportError(":: Class '%s' has a base class '%s' which "
2238 "does not have a complete definition.",
2240 base_class_type.GetTypeName().GetCString());
2241 if (die.GetCU()->GetProducer() ==
2242 DWARFCompileUnit::eProducerClang)
2243 module->ReportError(":: Try compiling the source file with "
2244 "-fno-limit-debug-info.");
2246 // We have no choice other than to pretend that the base class
2247 // is complete. If we don't do this, clang will crash when we
2248 // call setBases() inside of
2249 // "clang_type.SetBaseClassesForClassType()"
2250 // below. Since we provide layout assistance, all ivars in this
2251 // class and other classes will be fine, this is the best we can
2253 // short of crashing.
2254 if (ClangASTContext::StartTagDeclarationDefinition(
2256 ClangASTContext::CompleteTagDeclarationDefinition(
2262 m_ast.SetBaseClassesForClassType(clang_type.GetOpaqueQualType(),
2263 &base_classes.front(),
2264 base_classes.size());
2266 // Clang will copy each CXXBaseSpecifier in "base_classes"
2267 // so we have to free them all.
2268 ClangASTContext::DeleteBaseClassSpecifiers(&base_classes.front(),
2269 base_classes.size());
2274 ClangASTContext::BuildIndirectFields(clang_type);
2275 ClangASTContext::CompleteTagDeclarationDefinition(clang_type);
2277 if (!layout_info.field_offsets.empty() ||
2278 !layout_info.base_offsets.empty() ||
2279 !layout_info.vbase_offsets.empty()) {
2281 layout_info.bit_size = type->GetByteSize() * 8;
2282 if (layout_info.bit_size == 0)
2283 layout_info.bit_size =
2284 die.GetAttributeValueAsUnsigned(DW_AT_byte_size, 0) * 8;
2286 clang::CXXRecordDecl *record_decl =
2287 m_ast.GetAsCXXRecordDecl(clang_type.GetOpaqueQualType());
2290 ModuleSP module_sp = dwarf->GetObjectFile()->GetModule();
2293 module_sp->LogMessage(
2295 "ClangASTContext::CompleteTypeFromDWARF (clang_type = %p) "
2296 "caching layout info for record_decl = %p, bit_size = %" PRIu64
2297 ", alignment = %" PRIu64
2298 ", field_offsets[%u], base_offsets[%u], vbase_offsets[%u])",
2299 static_cast<void *>(clang_type.GetOpaqueQualType()),
2300 static_cast<void *>(record_decl), layout_info.bit_size,
2301 layout_info.alignment,
2302 static_cast<uint32_t>(layout_info.field_offsets.size()),
2303 static_cast<uint32_t>(layout_info.base_offsets.size()),
2304 static_cast<uint32_t>(layout_info.vbase_offsets.size()));
2308 llvm::DenseMap<const clang::FieldDecl *, uint64_t>::const_iterator
2310 end = layout_info.field_offsets.end();
2311 for (idx = 0, pos = layout_info.field_offsets.begin(); pos != end;
2313 module_sp->LogMessage(
2314 log, "ClangASTContext::CompleteTypeFromDWARF (clang_type = "
2315 "%p) field[%u] = { bit_offset=%u, name='%s' }",
2316 static_cast<void *>(clang_type.GetOpaqueQualType()), idx,
2317 static_cast<uint32_t>(pos->second),
2318 pos->first->getNameAsString().c_str());
2323 llvm::DenseMap<const clang::CXXRecordDecl *,
2324 clang::CharUnits>::const_iterator base_pos,
2325 base_end = layout_info.base_offsets.end();
2326 for (idx = 0, base_pos = layout_info.base_offsets.begin();
2327 base_pos != base_end; ++base_pos, ++idx) {
2328 module_sp->LogMessage(
2329 log, "ClangASTContext::CompleteTypeFromDWARF (clang_type = "
2330 "%p) base[%u] = { byte_offset=%u, name='%s' }",
2331 clang_type.GetOpaqueQualType(), idx,
2332 (uint32_t)base_pos->second.getQuantity(),
2333 base_pos->first->getNameAsString().c_str());
2337 llvm::DenseMap<const clang::CXXRecordDecl *,
2338 clang::CharUnits>::const_iterator vbase_pos,
2339 vbase_end = layout_info.vbase_offsets.end();
2340 for (idx = 0, vbase_pos = layout_info.vbase_offsets.begin();
2341 vbase_pos != vbase_end; ++vbase_pos, ++idx) {
2342 module_sp->LogMessage(
2343 log, "ClangASTContext::CompleteTypeFromDWARF (clang_type = "
2344 "%p) vbase[%u] = { byte_offset=%u, name='%s' }",
2345 static_cast<void *>(clang_type.GetOpaqueQualType()), idx,
2346 static_cast<uint32_t>(vbase_pos->second.getQuantity()),
2347 vbase_pos->first->getNameAsString().c_str());
2352 GetClangASTImporter().InsertRecordDecl(record_decl, layout_info);
2357 return (bool)clang_type;
2359 case DW_TAG_enumeration_type:
2360 if (ClangASTContext::StartTagDeclarationDefinition(clang_type)) {
2361 if (die.HasChildren()) {
2362 SymbolContext sc(die.GetLLDBCompileUnit());
2363 bool is_signed = false;
2364 clang_type.IsIntegerType(is_signed);
2365 ParseChildEnumerators(sc, clang_type, is_signed, type->GetByteSize(),
2368 ClangASTContext::CompleteTagDeclarationDefinition(clang_type);
2370 return (bool)clang_type;
2373 assert(false && "not a forward clang type decl!");
2380 std::vector<DWARFDIE> DWARFASTParserClang::GetDIEForDeclContext(
2381 lldb_private::CompilerDeclContext decl_context) {
2382 std::vector<DWARFDIE> result;
2383 for (auto it = m_decl_ctx_to_die.find(
2384 (clang::DeclContext *)decl_context.GetOpaqueDeclContext());
2385 it != m_decl_ctx_to_die.end(); it++)
2386 result.push_back(it->second);
2390 CompilerDecl DWARFASTParserClang::GetDeclForUIDFromDWARF(const DWARFDIE &die) {
2391 clang::Decl *clang_decl = GetClangDeclForDIE(die);
2392 if (clang_decl != nullptr)
2393 return CompilerDecl(&m_ast, clang_decl);
2394 return CompilerDecl();
2398 DWARFASTParserClang::GetDeclContextForUIDFromDWARF(const DWARFDIE &die) {
2399 clang::DeclContext *clang_decl_ctx = GetClangDeclContextForDIE(die);
2401 return CompilerDeclContext(&m_ast, clang_decl_ctx);
2402 return CompilerDeclContext();
2406 DWARFASTParserClang::GetDeclContextContainingUIDFromDWARF(const DWARFDIE &die) {
2407 clang::DeclContext *clang_decl_ctx =
2408 GetClangDeclContextContainingDIE(die, nullptr);
2410 return CompilerDeclContext(&m_ast, clang_decl_ctx);
2411 return CompilerDeclContext();
2414 size_t DWARFASTParserClang::ParseChildEnumerators(
2415 const SymbolContext &sc, lldb_private::CompilerType &clang_type,
2416 bool is_signed, uint32_t enumerator_byte_size, const DWARFDIE &parent_die) {
2420 size_t enumerators_added = 0;
2422 for (DWARFDIE die = parent_die.GetFirstChild(); die.IsValid();
2423 die = die.GetSibling()) {
2424 const dw_tag_t tag = die.Tag();
2425 if (tag == DW_TAG_enumerator) {
2426 DWARFAttributes attributes;
2427 const size_t num_child_attributes = die.GetAttributes(attributes);
2428 if (num_child_attributes > 0) {
2429 const char *name = NULL;
2430 bool got_value = false;
2431 int64_t enum_value = 0;
2435 for (i = 0; i < num_child_attributes; ++i) {
2436 const dw_attr_t attr = attributes.AttributeAtIndex(i);
2437 DWARFFormValue form_value;
2438 if (attributes.ExtractFormValueAtIndex(i, form_value)) {
2440 case DW_AT_const_value:
2443 enum_value = form_value.Signed();
2445 enum_value = form_value.Unsigned();
2449 name = form_value.AsCString();
2452 case DW_AT_description:
2454 case DW_AT_decl_file:
2455 decl.SetFile(sc.comp_unit->GetSupportFiles().GetFileSpecAtIndex(
2456 form_value.Unsigned()));
2458 case DW_AT_decl_line:
2459 decl.SetLine(form_value.Unsigned());
2461 case DW_AT_decl_column:
2462 decl.SetColumn(form_value.Unsigned());
2470 if (name && name[0] && got_value) {
2471 m_ast.AddEnumerationValueToEnumerationType(
2472 clang_type.GetOpaqueQualType(),
2473 m_ast.GetEnumerationIntegerType(clang_type.GetOpaqueQualType()),
2474 decl, name, enum_value, enumerator_byte_size * 8);
2475 ++enumerators_added;
2480 return enumerators_added;
2483 #if defined(LLDB_CONFIGURATION_DEBUG) || defined(LLDB_CONFIGURATION_RELEASE)
2487 void Push(const DWARFDIE &die) { m_dies.push_back(die); }
2489 void LogDIEs(Log *log) {
2490 StreamString log_strm;
2491 const size_t n = m_dies.size();
2492 log_strm.Printf("DIEStack[%" PRIu64 "]:\n", (uint64_t)n);
2493 for (size_t i = 0; i < n; i++) {
2494 std::string qualified_name;
2495 const DWARFDIE &die = m_dies[i];
2496 die.GetQualifiedName(qualified_name);
2497 log_strm.Printf("[%" PRIu64 "] 0x%8.8x: %s name='%s'\n", (uint64_t)i,
2498 die.GetOffset(), die.GetTagAsCString(),
2499 qualified_name.c_str());
2501 log->PutCString(log_strm.GetData());
2503 void Pop() { m_dies.pop_back(); }
2505 class ScopedPopper {
2507 ScopedPopper(DIEStack &die_stack)
2508 : m_die_stack(die_stack), m_valid(false) {}
2510 void Push(const DWARFDIE &die) {
2512 m_die_stack.Push(die);
2521 DIEStack &m_die_stack;
2526 typedef std::vector<DWARFDIE> Stack;
2531 Function *DWARFASTParserClang::ParseFunctionFromDWARF(const SymbolContext &sc,
2532 const DWARFDIE &die) {
2533 DWARFRangeList func_ranges;
2534 const char *name = NULL;
2535 const char *mangled = NULL;
2538 int decl_column = 0;
2541 int call_column = 0;
2542 DWARFExpression frame_base(die.GetCU());
2544 const dw_tag_t tag = die.Tag();
2546 if (tag != DW_TAG_subprogram)
2549 if (die.GetDIENamesAndRanges(name, mangled, func_ranges, decl_file, decl_line,
2550 decl_column, call_file, call_line, call_column,
2553 // Union of all ranges in the function DIE (if the function is
2555 AddressRange func_range;
2556 lldb::addr_t lowest_func_addr = func_ranges.GetMinRangeBase(0);
2557 lldb::addr_t highest_func_addr = func_ranges.GetMaxRangeEnd(0);
2558 if (lowest_func_addr != LLDB_INVALID_ADDRESS &&
2559 lowest_func_addr <= highest_func_addr) {
2560 ModuleSP module_sp(die.GetModule());
2561 func_range.GetBaseAddress().ResolveAddressUsingFileSections(
2562 lowest_func_addr, module_sp->GetSectionList());
2563 if (func_range.GetBaseAddress().IsValid())
2564 func_range.SetByteSize(highest_func_addr - lowest_func_addr);
2567 if (func_range.GetBaseAddress().IsValid()) {
2570 func_name.SetValue(ConstString(mangled), true);
2571 else if (die.GetParent().Tag() == DW_TAG_compile_unit &&
2572 Language::LanguageIsCPlusPlus(die.GetLanguage()) && name &&
2573 strcmp(name, "main") != 0) {
2574 // If the mangled name is not present in the DWARF, generate the
2576 // using the decl context. We skip if the function is "main" as its name
2579 bool is_static = false;
2580 bool is_variadic = false;
2581 bool has_template_params = false;
2582 unsigned type_quals = 0;
2583 std::vector<CompilerType> param_types;
2584 std::vector<clang::ParmVarDecl *> param_decls;
2585 DWARFDeclContext decl_ctx;
2588 die.GetDWARFDeclContext(decl_ctx);
2589 sstr << decl_ctx.GetQualifiedName();
2591 clang::DeclContext *containing_decl_ctx =
2592 GetClangDeclContextContainingDIE(die, nullptr);
2593 ParseChildParameters(sc, containing_decl_ctx, die, true, is_static,
2594 is_variadic, has_template_params, param_types,
2595 param_decls, type_quals);
2597 for (size_t i = 0; i < param_types.size(); i++) {
2600 sstr << param_types[i].GetTypeName();
2605 if (type_quals & clang::Qualifiers::Const)
2608 func_name.SetValue(ConstString(sstr.GetString()), false);
2610 func_name.SetValue(ConstString(name), false);
2613 std::unique_ptr<Declaration> decl_ap;
2614 if (decl_file != 0 || decl_line != 0 || decl_column != 0)
2615 decl_ap.reset(new Declaration(
2616 sc.comp_unit->GetSupportFiles().GetFileSpecAtIndex(decl_file),
2617 decl_line, decl_column));
2619 SymbolFileDWARF *dwarf = die.GetDWARF();
2620 // Supply the type _only_ if it has already been parsed
2621 Type *func_type = dwarf->GetDIEToType().lookup(die.GetDIE());
2623 assert(func_type == NULL || func_type != DIE_IS_BEING_PARSED);
2625 if (dwarf->FixupAddress(func_range.GetBaseAddress())) {
2626 const user_id_t func_user_id = die.GetID();
2627 func_sp.reset(new Function(sc.comp_unit,
2628 func_user_id, // UserID is the DIE offset
2629 func_user_id, func_name, func_type,
2630 func_range)); // first address range
2632 if (func_sp.get() != NULL) {
2633 if (frame_base.IsValid())
2634 func_sp->GetFrameBaseExpression() = frame_base;
2635 sc.comp_unit->AddFunction(func_sp);
2636 return func_sp.get();
2644 bool DWARFASTParserClang::ParseChildMembers(
2645 const SymbolContext &sc, const DWARFDIE &parent_die,
2646 CompilerType &class_clang_type, const LanguageType class_language,
2647 std::vector<clang::CXXBaseSpecifier *> &base_classes,
2648 std::vector<int> &member_accessibilities,
2649 DWARFDIECollection &member_function_dies,
2650 DelayedPropertyList &delayed_properties, AccessType &default_accessibility,
2651 bool &is_a_class, ClangASTImporter::LayoutInfo &layout_info) {
2655 // Get the parent byte size so we can verify any members will fit
2656 const uint64_t parent_byte_size =
2657 parent_die.GetAttributeValueAsUnsigned(DW_AT_byte_size, UINT64_MAX);
2658 const uint64_t parent_bit_size =
2659 parent_byte_size == UINT64_MAX ? UINT64_MAX : parent_byte_size * 8;
2661 uint32_t member_idx = 0;
2662 BitfieldInfo last_field_info;
2664 ModuleSP module_sp = parent_die.GetDWARF()->GetObjectFile()->GetModule();
2665 ClangASTContext *ast =
2666 llvm::dyn_cast_or_null<ClangASTContext>(class_clang_type.GetTypeSystem());
2670 for (DWARFDIE die = parent_die.GetFirstChild(); die.IsValid();
2671 die = die.GetSibling()) {
2672 dw_tag_t tag = die.Tag();
2676 case DW_TAG_APPLE_property: {
2677 DWARFAttributes attributes;
2678 const size_t num_attributes = die.GetAttributes(attributes);
2679 if (num_attributes > 0) {
2681 // DWARFExpression location;
2682 const char *name = NULL;
2683 const char *prop_name = NULL;
2684 const char *prop_getter_name = NULL;
2685 const char *prop_setter_name = NULL;
2686 uint32_t prop_attributes = 0;
2688 bool is_artificial = false;
2689 DWARFFormValue encoding_form;
2690 AccessType accessibility = eAccessNone;
2691 uint32_t member_byte_offset =
2692 (parent_die.Tag() == DW_TAG_union_type) ? 0 : UINT32_MAX;
2693 size_t byte_size = 0;
2694 int64_t bit_offset = 0;
2695 uint64_t data_bit_offset = UINT64_MAX;
2696 size_t bit_size = 0;
2698 false; // On DW_TAG_members, this means the member is static
2700 for (i = 0; i < num_attributes && !is_artificial; ++i) {
2701 const dw_attr_t attr = attributes.AttributeAtIndex(i);
2702 DWARFFormValue form_value;
2703 if (attributes.ExtractFormValueAtIndex(i, form_value)) {
2705 case DW_AT_decl_file:
2706 decl.SetFile(sc.comp_unit->GetSupportFiles().GetFileSpecAtIndex(
2707 form_value.Unsigned()));
2709 case DW_AT_decl_line:
2710 decl.SetLine(form_value.Unsigned());
2712 case DW_AT_decl_column:
2713 decl.SetColumn(form_value.Unsigned());
2716 name = form_value.AsCString();
2719 encoding_form = form_value;
2721 case DW_AT_bit_offset:
2722 bit_offset = form_value.Signed();
2724 case DW_AT_bit_size:
2725 bit_size = form_value.Unsigned();
2727 case DW_AT_byte_size:
2728 byte_size = form_value.Unsigned();
2730 case DW_AT_data_bit_offset:
2731 data_bit_offset = form_value.Unsigned();
2733 case DW_AT_data_member_location:
2734 if (form_value.BlockData()) {
2735 Value initialValue(0);
2736 Value memberOffset(0);
2737 const DWARFDataExtractor &debug_info_data =
2738 die.GetDWARF()->get_debug_info_data();
2739 uint32_t block_length = form_value.Unsigned();
2740 uint32_t block_offset =
2741 form_value.BlockData() - debug_info_data.GetDataStart();
2742 if (DWARFExpression::Evaluate(
2743 nullptr, // ExecutionContext *
2744 nullptr, // ClangExpressionVariableList *
2745 nullptr, // ClangExpressionDeclMap *
2746 nullptr, // RegisterContext *
2747 module_sp, debug_info_data, die.GetCU(), block_offset,
2748 block_length, eRegisterKindDWARF, &initialValue,
2749 nullptr, memberOffset, nullptr)) {
2750 member_byte_offset = memberOffset.ResolveValue(NULL).UInt();
2753 // With DWARF 3 and later, if the value is an integer constant,
2754 // this form value is the offset in bytes from the beginning
2755 // of the containing entity.
2756 member_byte_offset = form_value.Unsigned();
2760 case DW_AT_accessibility:
2761 accessibility = DW_ACCESS_to_AccessType(form_value.Unsigned());
2763 case DW_AT_artificial:
2764 is_artificial = form_value.Boolean();
2766 case DW_AT_APPLE_property_name:
2767 prop_name = form_value.AsCString();
2769 case DW_AT_APPLE_property_getter:
2770 prop_getter_name = form_value.AsCString();
2772 case DW_AT_APPLE_property_setter:
2773 prop_setter_name = form_value.AsCString();
2775 case DW_AT_APPLE_property_attribute:
2776 prop_attributes = form_value.Unsigned();
2778 case DW_AT_external:
2779 is_external = form_value.Boolean();
2783 case DW_AT_declaration:
2784 case DW_AT_description:
2786 case DW_AT_visibility:
2794 ConstString fixed_getter;
2795 ConstString fixed_setter;
2797 // Check if the property getter/setter were provided as full
2798 // names. We want basenames, so we extract them.
2800 if (prop_getter_name && prop_getter_name[0] == '-') {
2801 ObjCLanguage::MethodName prop_getter_method(prop_getter_name, true);
2802 prop_getter_name = prop_getter_method.GetSelector().GetCString();
2805 if (prop_setter_name && prop_setter_name[0] == '-') {
2806 ObjCLanguage::MethodName prop_setter_method(prop_setter_name, true);
2807 prop_setter_name = prop_setter_method.GetSelector().GetCString();
2810 // If the names haven't been provided, they need to be
2813 if (!prop_getter_name) {
2814 prop_getter_name = prop_name;
2816 if (!prop_setter_name && prop_name[0] &&
2817 !(prop_attributes & DW_APPLE_PROPERTY_readonly)) {
2820 ss.Printf("set%c%s:", toupper(prop_name[0]), &prop_name[1]);
2822 fixed_setter.SetString(ss.GetString());
2823 prop_setter_name = fixed_setter.GetCString();
2827 // Clang has a DWARF generation bug where sometimes it
2828 // represents fields that are references with bad byte size
2829 // and bit size/offset information such as:
2831 // DW_AT_byte_size( 0x00 )
2832 // DW_AT_bit_size( 0x40 )
2833 // DW_AT_bit_offset( 0xffffffffffffffc0 )
2835 // So check the bit offset to make sure it is sane, and if
2836 // the values are not sane, remove them. If we don't do this
2837 // then we will end up with a crash if we try to use this
2838 // type in an expression when clang becomes unhappy with its
2839 // recycled debug info.
2841 if (byte_size == 0 && bit_offset < 0) {
2846 // FIXME: Make Clang ignore Objective-C accessibility for expressions
2847 if (class_language == eLanguageTypeObjC ||
2848 class_language == eLanguageTypeObjC_plus_plus)
2849 accessibility = eAccessNone;
2851 if (member_idx == 0 && !is_artificial && name &&
2852 (strstr(name, "_vptr$") == name)) {
2853 // Not all compilers will mark the vtable pointer
2854 // member as artificial (llvm-gcc). We can't have
2855 // the virtual members in our classes otherwise it
2856 // throws off all child offsets since we end up
2857 // having and extra pointer sized member in our
2859 is_artificial = true;
2862 // Handle static members
2863 if (is_external && member_byte_offset == UINT32_MAX) {
2864 Type *var_type = die.ResolveTypeUID(DIERef(encoding_form));
2867 if (accessibility == eAccessNone)
2868 accessibility = eAccessPublic;
2869 ClangASTContext::AddVariableToRecordType(
2870 class_clang_type, name, var_type->GetLayoutCompilerType(),
2876 if (is_artificial == false) {
2877 Type *member_type = die.ResolveTypeUID(DIERef(encoding_form));
2879 clang::FieldDecl *field_decl = NULL;
2880 if (tag == DW_TAG_member) {
2882 if (accessibility == eAccessNone)
2883 accessibility = default_accessibility;
2884 member_accessibilities.push_back(accessibility);
2886 uint64_t field_bit_offset =
2887 (member_byte_offset == UINT32_MAX ? 0
2888 : (member_byte_offset * 8));
2891 BitfieldInfo this_field_info;
2892 this_field_info.bit_offset = field_bit_offset;
2893 this_field_info.bit_size = bit_size;
2895 /////////////////////////////////////////////////////////////
2896 // How to locate a field given the DWARF debug information
2898 // AT_byte_size indicates the size of the word in which the
2899 // bit offset must be interpreted.
2901 // AT_data_member_location indicates the byte offset of the
2902 // word from the base address of the structure.
2904 // AT_bit_offset indicates how many bits into the word
2905 // (according to the host endianness) the low-order bit of
2906 // the field starts. AT_bit_offset can be negative.
2908 // AT_bit_size indicates the size of the field in bits.
2909 /////////////////////////////////////////////////////////////
2911 if (data_bit_offset != UINT64_MAX) {
2912 this_field_info.bit_offset = data_bit_offset;
2915 byte_size = member_type->GetByteSize();
2917 ObjectFile *objfile = die.GetDWARF()->GetObjectFile();
2918 if (objfile->GetByteOrder() == eByteOrderLittle) {
2919 this_field_info.bit_offset += byte_size * 8;
2920 this_field_info.bit_offset -= (bit_offset + bit_size);
2922 this_field_info.bit_offset += bit_offset;
2926 if ((this_field_info.bit_offset >= parent_bit_size) ||
2927 !last_field_info.NextBitfieldOffsetIsValid(
2928 this_field_info.bit_offset)) {
2929 ObjectFile *objfile = die.GetDWARF()->GetObjectFile();
2930 objfile->GetModule()->ReportWarning(
2931 "0x%8.8" PRIx64 ": %s bitfield named \"%s\" has invalid "
2932 "bit offset (0x%8.8" PRIx64
2933 ") member will be ignored. Please file a bug against the "
2934 "compiler and include the preprocessed output for %s\n",
2935 die.GetID(), DW_TAG_value_to_name(tag), name,
2936 this_field_info.bit_offset,
2937 sc.comp_unit ? sc.comp_unit->GetPath().c_str()
2938 : "the source file");
2939 this_field_info.Clear();
2943 // Update the field bit offset we will report for layout
2944 field_bit_offset = this_field_info.bit_offset;
2946 // If the member to be emitted did not start on a character
2947 // boundary and there is
2948 // empty space between the last field and this one, then we need
2950 // anonymous member filling up the space up to its start. There
2954 // 1 If the previous member ended on a character boundary, then
2956 // anonymous member starting at the most recent character
2959 // 2 If the previous member did not end on a character boundary
2961 // from the end of the previous member to the current member
2963 // word width, then we can emit an anonymous member starting
2965 // previous member and right before this member.
2967 // 3 If the previous member did not end on a character boundary
2969 // from the end of the previous member to the current member
2971 // or equal a word width, then we act as in Case 1.
2973 const uint64_t character_width = 8;
2974 const uint64_t word_width = 32;
2976 // Objective-C has invalid DW_AT_bit_offset values in older
2978 // of clang, so we have to be careful and only insert unnamed
2980 // if we have a new enough clang.
2981 bool detect_unnamed_bitfields = true;
2983 if (class_language == eLanguageTypeObjC ||
2984 class_language == eLanguageTypeObjC_plus_plus)
2985 detect_unnamed_bitfields =
2986 die.GetCU()->Supports_unnamed_objc_bitfields();
2988 if (detect_unnamed_bitfields) {
2989 BitfieldInfo anon_field_info;
2991 if ((this_field_info.bit_offset % character_width) !=
2992 0) // not char aligned
2994 uint64_t last_field_end = 0;
2996 if (last_field_info.IsValid())
2998 last_field_info.bit_offset + last_field_info.bit_size;
3000 if (this_field_info.bit_offset != last_field_end) {
3001 if (((last_field_end % character_width) == 0) || // case 1
3002 (this_field_info.bit_offset - last_field_end >=
3003 word_width)) // case 3
3005 anon_field_info.bit_size =
3006 this_field_info.bit_offset % character_width;
3007 anon_field_info.bit_offset =
3008 this_field_info.bit_offset -
3009 anon_field_info.bit_size;
3012 anon_field_info.bit_size =
3013 this_field_info.bit_offset - last_field_end;
3014 anon_field_info.bit_offset = last_field_end;
3019 if (anon_field_info.IsValid()) {
3020 clang::FieldDecl *unnamed_bitfield_decl =
3021 ClangASTContext::AddFieldToRecordType(
3022 class_clang_type, NULL,
3023 m_ast.GetBuiltinTypeForEncodingAndBitSize(
3024 eEncodingSint, word_width),
3025 accessibility, anon_field_info.bit_size);
3027 layout_info.field_offsets.insert(std::make_pair(
3028 unnamed_bitfield_decl, anon_field_info.bit_offset));
3031 last_field_info = this_field_info;
3033 last_field_info.Clear();
3036 CompilerType member_clang_type =
3037 member_type->GetLayoutCompilerType();
3038 if (!member_clang_type.IsCompleteType())
3039 member_clang_type.GetCompleteType();
3042 // Older versions of clang emit array[0] and array[1] in the
3043 // same way (<rdar://problem/12566646>).
3044 // If the current field is at the end of the structure, then
3045 // there is definitely no room for extra
3046 // elements and we override the type to array[0].
3048 CompilerType member_array_element_type;
3049 uint64_t member_array_size;
3050 bool member_array_is_incomplete;
3052 if (member_clang_type.IsArrayType(
3053 &member_array_element_type, &member_array_size,
3054 &member_array_is_incomplete) &&
3055 !member_array_is_incomplete) {
3056 uint64_t parent_byte_size =
3057 parent_die.GetAttributeValueAsUnsigned(DW_AT_byte_size,
3060 if (member_byte_offset >= parent_byte_size) {
3061 if (member_array_size != 1 &&
3062 (member_array_size != 0 ||
3063 member_byte_offset > parent_byte_size)) {
3064 module_sp->ReportError(
3066 ": DW_TAG_member '%s' refers to type 0x%8.8" PRIx64
3067 " which extends beyond the bounds of 0x%8.8" PRIx64,
3068 die.GetID(), name, encoding_form.Reference(),
3069 parent_die.GetID());
3072 member_clang_type = m_ast.CreateArrayType(
3073 member_array_element_type, 0, false);
3078 if (ClangASTContext::IsCXXClassType(member_clang_type) &&
3079 member_clang_type.GetCompleteType() == false) {
3080 if (die.GetCU()->GetProducer() ==
3081 DWARFCompileUnit::eProducerClang)
3082 module_sp->ReportError(
3083 "DWARF DIE at 0x%8.8x (class %s) has a member variable "
3084 "0x%8.8x (%s) whose type is a forward declaration, not a "
3085 "complete definition.\nTry compiling the source file "
3086 "with -fno-limit-debug-info",
3087 parent_die.GetOffset(), parent_die.GetName(),
3088 die.GetOffset(), name);
3090 module_sp->ReportError(
3091 "DWARF DIE at 0x%8.8x (class %s) has a member variable "
3092 "0x%8.8x (%s) whose type is a forward declaration, not a "
3093 "complete definition.\nPlease file a bug against the "
3094 "compiler and include the preprocessed output for %s",
3095 parent_die.GetOffset(), parent_die.GetName(),
3096 die.GetOffset(), name,
3097 sc.comp_unit ? sc.comp_unit->GetPath().c_str()
3098 : "the source file");
3099 // We have no choice other than to pretend that the member class
3100 // is complete. If we don't do this, clang will crash when
3102 // to layout the class. Since we provide layout assistance, all
3103 // ivars in this class and other classes will be fine, this is
3104 // the best we can do short of crashing.
3105 if (ClangASTContext::StartTagDeclarationDefinition(
3106 member_clang_type)) {
3107 ClangASTContext::CompleteTagDeclarationDefinition(
3110 module_sp->ReportError(
3111 "DWARF DIE at 0x%8.8x (class %s) has a member variable "
3112 "0x%8.8x (%s) whose type claims to be a C++ class but we "
3113 "were not able to start its definition.\nPlease file a "
3114 "bug and attach the file at the start of this error "
3116 parent_die.GetOffset(), parent_die.GetName(),
3117 die.GetOffset(), name);
3121 field_decl = ClangASTContext::AddFieldToRecordType(
3122 class_clang_type, name, member_clang_type, accessibility,
3125 m_ast.SetMetadataAsUserID(field_decl, die.GetID());
3127 layout_info.field_offsets.insert(
3128 std::make_pair(field_decl, field_bit_offset));
3131 module_sp->ReportError(
3133 ": DW_TAG_member '%s' refers to type 0x%8.8" PRIx64
3134 " which was unable to be parsed",
3135 die.GetID(), name, encoding_form.Reference());
3137 module_sp->ReportError(
3139 ": DW_TAG_member refers to type 0x%8.8" PRIx64
3140 " which was unable to be parsed",
3141 die.GetID(), encoding_form.Reference());
3145 if (prop_name != NULL && member_type) {
3146 clang::ObjCIvarDecl *ivar_decl = NULL;
3149 ivar_decl = clang::dyn_cast<clang::ObjCIvarDecl>(field_decl);
3150 assert(ivar_decl != NULL);
3153 ClangASTMetadata metadata;
3154 metadata.SetUserID(die.GetID());
3155 delayed_properties.push_back(DelayedAddObjCClassProperty(
3156 class_clang_type, prop_name,
3157 member_type->GetLayoutCompilerType(), ivar_decl,
3158 prop_setter_name, prop_getter_name, prop_attributes,
3162 m_ast.SetMetadataAsUserID(ivar_decl, die.GetID());
3169 case DW_TAG_subprogram:
3170 // Let the type parsing code handle this one for us.
3171 member_function_dies.Append(die);
3174 case DW_TAG_inheritance: {
3176 if (default_accessibility == eAccessNone)
3177 default_accessibility = eAccessPrivate;
3178 // TODO: implement DW_TAG_inheritance type parsing
3179 DWARFAttributes attributes;
3180 const size_t num_attributes = die.GetAttributes(attributes);
3181 if (num_attributes > 0) {
3183 DWARFExpression location(die.GetCU());
3184 DWARFFormValue encoding_form;
3185 AccessType accessibility = default_accessibility;
3186 bool is_virtual = false;
3187 bool is_base_of_class = true;
3188 off_t member_byte_offset = 0;
3190 for (i = 0; i < num_attributes; ++i) {
3191 const dw_attr_t attr = attributes.AttributeAtIndex(i);
3192 DWARFFormValue form_value;
3193 if (attributes.ExtractFormValueAtIndex(i, form_value)) {
3195 case DW_AT_decl_file:
3196 decl.SetFile(sc.comp_unit->GetSupportFiles().GetFileSpecAtIndex(
3197 form_value.Unsigned()));
3199 case DW_AT_decl_line:
3200 decl.SetLine(form_value.Unsigned());
3202 case DW_AT_decl_column:
3203 decl.SetColumn(form_value.Unsigned());
3206 encoding_form = form_value;
3208 case DW_AT_data_member_location:
3209 if (form_value.BlockData()) {
3210 Value initialValue(0);
3211 Value memberOffset(0);
3212 const DWARFDataExtractor &debug_info_data =
3213 die.GetDWARF()->get_debug_info_data();
3214 uint32_t block_length = form_value.Unsigned();
3215 uint32_t block_offset =
3216 form_value.BlockData() - debug_info_data.GetDataStart();
3217 if (DWARFExpression::Evaluate(
3218 nullptr, nullptr, nullptr, nullptr, module_sp,
3219 debug_info_data, die.GetCU(), block_offset,
3220 block_length, eRegisterKindDWARF, &initialValue,
3221 nullptr, memberOffset, nullptr)) {
3222 member_byte_offset = memberOffset.ResolveValue(NULL).UInt();
3225 // With DWARF 3 and later, if the value is an integer constant,
3226 // this form value is the offset in bytes from the beginning
3227 // of the containing entity.
3228 member_byte_offset = form_value.Unsigned();
3232 case DW_AT_accessibility:
3233 accessibility = DW_ACCESS_to_AccessType(form_value.Unsigned());
3236 case DW_AT_virtuality:
3237 is_virtual = form_value.Boolean();
3249 Type *base_class_type = die.ResolveTypeUID(DIERef(encoding_form));
3250 if (base_class_type == NULL) {
3251 module_sp->ReportError("0x%8.8x: DW_TAG_inheritance failed to "
3252 "resolve the base class at 0x%8.8" PRIx64
3253 " from enclosing type 0x%8.8x. \nPlease file "
3254 "a bug and attach the file at the start of "
3255 "this error message",
3256 die.GetOffset(), encoding_form.Reference(),
3257 parent_die.GetOffset());
3261 CompilerType base_class_clang_type =
3262 base_class_type->GetFullCompilerType();
3263 assert(base_class_clang_type);
3264 if (class_language == eLanguageTypeObjC) {
3265 ast->SetObjCSuperClass(class_clang_type, base_class_clang_type);
3267 base_classes.push_back(ast->CreateBaseClassSpecifier(
3268 base_class_clang_type.GetOpaqueQualType(), accessibility,
3269 is_virtual, is_base_of_class));
3272 // Do not specify any offset for virtual inheritance. The DWARF
3273 // produced by clang doesn't
3274 // give us a constant offset, but gives us a DWARF expressions that
3275 // requires an actual object
3276 // in memory. the DW_AT_data_member_location for a virtual base
3277 // class looks like:
3278 // DW_AT_data_member_location( DW_OP_dup, DW_OP_deref,
3279 // DW_OP_constu(0x00000018), DW_OP_minus, DW_OP_deref,
3281 // Given this, there is really no valid response we can give to
3282 // clang for virtual base
3283 // class offsets, and this should eventually be removed from
3284 // LayoutRecordType() in the external
3285 // AST source in clang.
3287 layout_info.base_offsets.insert(std::make_pair(
3288 ast->GetAsCXXRecordDecl(
3289 base_class_clang_type.GetOpaqueQualType()),
3290 clang::CharUnits::fromQuantity(member_byte_offset)));
3304 size_t DWARFASTParserClang::ParseChildParameters(
3305 const SymbolContext &sc, clang::DeclContext *containing_decl_ctx,
3306 const DWARFDIE &parent_die, bool skip_artificial, bool &is_static,
3307 bool &is_variadic, bool &has_template_params,
3308 std::vector<CompilerType> &function_param_types,
3309 std::vector<clang::ParmVarDecl *> &function_param_decls,
3310 unsigned &type_quals) {
3315 for (DWARFDIE die = parent_die.GetFirstChild(); die.IsValid();
3316 die = die.GetSibling()) {
3317 const dw_tag_t tag = die.Tag();
3319 case DW_TAG_formal_parameter: {
3320 DWARFAttributes attributes;
3321 const size_t num_attributes = die.GetAttributes(attributes);
3322 if (num_attributes > 0) {
3323 const char *name = NULL;
3325 DWARFFormValue param_type_die_form;
3326 bool is_artificial = false;
3327 // one of None, Auto, Register, Extern, Static, PrivateExtern
3329 clang::StorageClass storage = clang::SC_None;
3331 for (i = 0; i < num_attributes; ++i) {
3332 const dw_attr_t attr = attributes.AttributeAtIndex(i);
3333 DWARFFormValue form_value;
3334 if (attributes.ExtractFormValueAtIndex(i, form_value)) {
3336 case DW_AT_decl_file:
3337 decl.SetFile(sc.comp_unit->GetSupportFiles().GetFileSpecAtIndex(
3338 form_value.Unsigned()));
3340 case DW_AT_decl_line:
3341 decl.SetLine(form_value.Unsigned());
3343 case DW_AT_decl_column:
3344 decl.SetColumn(form_value.Unsigned());
3347 name = form_value.AsCString();
3350 param_type_die_form = form_value;
3352 case DW_AT_artificial:
3353 is_artificial = form_value.Boolean();
3355 case DW_AT_location:
3356 // if (form_value.BlockData())
3358 // const DWARFDataExtractor&
3359 // debug_info_data = debug_info();
3360 // uint32_t block_length =
3361 // form_value.Unsigned();
3362 // DWARFDataExtractor
3363 // location(debug_info_data,
3364 // form_value.BlockData() -
3365 // debug_info_data.GetDataStart(),
3372 case DW_AT_const_value:
3373 case DW_AT_default_value:
3374 case DW_AT_description:
3375 case DW_AT_endianity:
3376 case DW_AT_is_optional:
3378 case DW_AT_variable_parameter:
3380 case DW_AT_abstract_origin:
3388 if (skip_artificial) {
3389 if (is_artificial) {
3390 // In order to determine if a C++ member function is
3391 // "const" we have to look at the const-ness of "this"...
3394 if (DeclKindIsCXXClass(containing_decl_ctx->getDeclKind())) {
3395 // Often times compilers omit the "this" name for the
3396 // specification DIEs, so we can't rely upon the name
3397 // being in the formal parameter DIE...
3398 if (name == NULL || ::strcmp(name, "this") == 0) {
3400 die.ResolveTypeUID(DIERef(param_type_die_form));
3402 uint32_t encoding_mask = this_type->GetEncodingMask();
3403 if (encoding_mask & Type::eEncodingIsPointerUID) {
3406 if (encoding_mask & (1u << Type::eEncodingIsConstUID))
3407 type_quals |= clang::Qualifiers::Const;
3408 if (encoding_mask & (1u << Type::eEncodingIsVolatileUID))
3409 type_quals |= clang::Qualifiers::Volatile;
3418 // HACK: Objective C formal parameters "self" and "_cmd"
3419 // are not marked as artificial in the DWARF...
3420 CompileUnit *comp_unit = die.GetLLDBCompileUnit();
3422 switch (comp_unit->GetLanguage()) {
3423 case eLanguageTypeObjC:
3424 case eLanguageTypeObjC_plus_plus:
3425 if (name && name[0] &&
3426 (strcmp(name, "self") == 0 || strcmp(name, "_cmd") == 0))
3437 Type *type = die.ResolveTypeUID(DIERef(param_type_die_form));
3439 function_param_types.push_back(type->GetForwardCompilerType());
3441 clang::ParmVarDecl *param_var_decl =
3442 m_ast.CreateParameterDeclaration(
3443 name, type->GetForwardCompilerType(), storage);
3444 assert(param_var_decl);
3445 function_param_decls.push_back(param_var_decl);
3447 m_ast.SetMetadataAsUserID(param_var_decl, die.GetID());
3454 case DW_TAG_unspecified_parameters:
3458 case DW_TAG_template_type_parameter:
3459 case DW_TAG_template_value_parameter:
3460 case DW_TAG_GNU_template_parameter_pack:
3461 // The one caller of this was never using the template_param_infos,
3462 // and the local variable was taking up a large amount of stack space
3463 // in SymbolFileDWARF::ParseType() so this was removed. If we ever need
3464 // the template params back, we can add them back.
3465 // ParseTemplateDIE (dwarf_cu, die, template_param_infos);
3466 has_template_params = true;
3476 void DWARFASTParserClang::ParseChildArrayInfo(
3477 const SymbolContext &sc, const DWARFDIE &parent_die, int64_t &first_index,
3478 std::vector<uint64_t> &element_orders, uint32_t &byte_stride,
3479 uint32_t &bit_stride) {
3483 for (DWARFDIE die = parent_die.GetFirstChild(); die.IsValid();
3484 die = die.GetSibling()) {
3485 const dw_tag_t tag = die.Tag();
3487 case DW_TAG_subrange_type: {
3488 DWARFAttributes attributes;
3489 const size_t num_child_attributes = die.GetAttributes(attributes);
3490 if (num_child_attributes > 0) {
3491 uint64_t num_elements = 0;
3492 uint64_t lower_bound = 0;
3493 uint64_t upper_bound = 0;
3494 bool upper_bound_valid = false;
3496 for (i = 0; i < num_child_attributes; ++i) {
3497 const dw_attr_t attr = attributes.AttributeAtIndex(i);
3498 DWARFFormValue form_value;
3499 if (attributes.ExtractFormValueAtIndex(i, form_value)) {
3505 num_elements = form_value.Unsigned();
3508 case DW_AT_bit_stride:
3509 bit_stride = form_value.Unsigned();
3512 case DW_AT_byte_stride:
3513 byte_stride = form_value.Unsigned();
3516 case DW_AT_lower_bound:
3517 lower_bound = form_value.Unsigned();
3520 case DW_AT_upper_bound:
3521 upper_bound_valid = true;
3522 upper_bound = form_value.Unsigned();
3526 case DW_AT_abstract_origin:
3527 case DW_AT_accessibility:
3528 case DW_AT_allocated:
3529 case DW_AT_associated:
3530 case DW_AT_data_location:
3531 case DW_AT_declaration:
3532 case DW_AT_description:
3534 case DW_AT_threads_scaled:
3536 case DW_AT_visibility:
3542 if (num_elements == 0) {
3543 if (upper_bound_valid && upper_bound >= lower_bound)
3544 num_elements = upper_bound - lower_bound + 1;
3547 element_orders.push_back(num_elements);
3554 Type *DWARFASTParserClang::GetTypeForDIE(const DWARFDIE &die) {
3556 SymbolFileDWARF *dwarf = die.GetDWARF();
3557 DWARFAttributes attributes;
3558 const size_t num_attributes = die.GetAttributes(attributes);
3559 if (num_attributes > 0) {
3560 DWARFFormValue type_die_form;
3561 for (size_t i = 0; i < num_attributes; ++i) {
3562 dw_attr_t attr = attributes.AttributeAtIndex(i);
3563 DWARFFormValue form_value;
3565 if (attr == DW_AT_type &&
3566 attributes.ExtractFormValueAtIndex(i, form_value))
3567 return dwarf->ResolveTypeUID(dwarf->GetDIE(DIERef(form_value)), true);
3575 clang::Decl *DWARFASTParserClang::GetClangDeclForDIE(const DWARFDIE &die) {
3579 switch (die.Tag()) {
3580 case DW_TAG_variable:
3581 case DW_TAG_constant:
3582 case DW_TAG_formal_parameter:
3583 case DW_TAG_imported_declaration:
3584 case DW_TAG_imported_module:
3590 DIEToDeclMap::iterator cache_pos = m_die_to_decl.find(die.GetDIE());
3591 if (cache_pos != m_die_to_decl.end())
3592 return cache_pos->second;
3594 if (DWARFDIE spec_die = die.GetReferencedDIE(DW_AT_specification)) {
3595 clang::Decl *decl = GetClangDeclForDIE(spec_die);
3596 m_die_to_decl[die.GetDIE()] = decl;
3597 m_decl_to_die[decl].insert(die.GetDIE());
3601 if (DWARFDIE abstract_origin_die =
3602 die.GetReferencedDIE(DW_AT_abstract_origin)) {
3603 clang::Decl *decl = GetClangDeclForDIE(abstract_origin_die);
3604 m_die_to_decl[die.GetDIE()] = decl;
3605 m_decl_to_die[decl].insert(die.GetDIE());
3609 clang::Decl *decl = nullptr;
3610 switch (die.Tag()) {
3611 case DW_TAG_variable:
3612 case DW_TAG_constant:
3613 case DW_TAG_formal_parameter: {
3614 SymbolFileDWARF *dwarf = die.GetDWARF();
3615 Type *type = GetTypeForDIE(die);
3616 if (dwarf && type) {
3617 const char *name = die.GetName();
3618 clang::DeclContext *decl_context =
3619 ClangASTContext::DeclContextGetAsDeclContext(
3620 dwarf->GetDeclContextContainingUID(die.GetID()));
3621 decl = m_ast.CreateVariableDeclaration(
3623 ClangUtil::GetQualType(type->GetForwardCompilerType()));
3627 case DW_TAG_imported_declaration: {
3628 SymbolFileDWARF *dwarf = die.GetDWARF();
3629 DWARFDIE imported_uid = die.GetAttributeValueAsReferenceDIE(DW_AT_import);
3631 CompilerDecl imported_decl = imported_uid.GetDecl();
3632 if (imported_decl) {
3633 clang::DeclContext *decl_context =
3634 ClangASTContext::DeclContextGetAsDeclContext(
3635 dwarf->GetDeclContextContainingUID(die.GetID()));
3636 if (clang::NamedDecl *clang_imported_decl =
3637 llvm::dyn_cast<clang::NamedDecl>(
3638 (clang::Decl *)imported_decl.GetOpaqueDecl()))
3640 m_ast.CreateUsingDeclaration(decl_context, clang_imported_decl);
3645 case DW_TAG_imported_module: {
3646 SymbolFileDWARF *dwarf = die.GetDWARF();
3647 DWARFDIE imported_uid = die.GetAttributeValueAsReferenceDIE(DW_AT_import);
3650 CompilerDeclContext imported_decl_ctx = imported_uid.GetDeclContext();
3651 if (imported_decl_ctx) {
3652 clang::DeclContext *decl_context =
3653 ClangASTContext::DeclContextGetAsDeclContext(
3654 dwarf->GetDeclContextContainingUID(die.GetID()));
3655 if (clang::NamespaceDecl *ns_decl =
3656 ClangASTContext::DeclContextGetAsNamespaceDecl(
3658 decl = m_ast.CreateUsingDirectiveDeclaration(decl_context, ns_decl);
3667 m_die_to_decl[die.GetDIE()] = decl;
3668 m_decl_to_die[decl].insert(die.GetDIE());
3673 clang::DeclContext *
3674 DWARFASTParserClang::GetClangDeclContextForDIE(const DWARFDIE &die) {
3676 clang::DeclContext *decl_ctx = GetCachedClangDeclContextForDIE(die);
3680 bool try_parsing_type = true;
3681 switch (die.Tag()) {
3682 case DW_TAG_compile_unit:
3683 decl_ctx = m_ast.GetTranslationUnitDecl();
3684 try_parsing_type = false;
3687 case DW_TAG_namespace:
3688 decl_ctx = ResolveNamespaceDIE(die);
3689 try_parsing_type = false;
3692 case DW_TAG_lexical_block:
3693 decl_ctx = GetDeclContextForBlock(die);
3694 try_parsing_type = false;
3701 if (decl_ctx == nullptr && try_parsing_type) {
3702 Type *type = die.GetDWARF()->ResolveType(die);
3704 decl_ctx = GetCachedClangDeclContextForDIE(die);
3708 LinkDeclContextToDIE(decl_ctx, die);
3715 static bool IsSubroutine(const DWARFDIE &die) {
3716 switch (die.Tag()) {
3717 case DW_TAG_subprogram:
3718 case DW_TAG_inlined_subroutine:
3725 static DWARFDIE GetContainingFunctionWithAbstractOrigin(const DWARFDIE &die) {
3726 for (DWARFDIE candidate = die; candidate; candidate = candidate.GetParent()) {
3727 if (IsSubroutine(candidate)) {
3728 if (candidate.GetReferencedDIE(DW_AT_abstract_origin)) {
3735 assert(0 && "Shouldn't call GetContainingFunctionWithAbstractOrigin on "
3736 "something not in a function");
3740 static DWARFDIE FindAnyChildWithAbstractOrigin(const DWARFDIE &context) {
3741 for (DWARFDIE candidate = context.GetFirstChild(); candidate.IsValid();
3742 candidate = candidate.GetSibling()) {
3743 if (candidate.GetReferencedDIE(DW_AT_abstract_origin)) {
3750 static DWARFDIE FindFirstChildWithAbstractOrigin(const DWARFDIE &block,
3751 const DWARFDIE &function) {
3752 assert(IsSubroutine(function));
3753 for (DWARFDIE context = block; context != function.GetParent();
3754 context = context.GetParent()) {
3755 assert(!IsSubroutine(context) || context == function);
3756 if (DWARFDIE child = FindAnyChildWithAbstractOrigin(context)) {
3763 clang::DeclContext *
3764 DWARFASTParserClang::GetDeclContextForBlock(const DWARFDIE &die) {
3765 assert(die.Tag() == DW_TAG_lexical_block);
3766 DWARFDIE containing_function_with_abstract_origin =
3767 GetContainingFunctionWithAbstractOrigin(die);
3768 if (!containing_function_with_abstract_origin) {
3769 return (clang::DeclContext *)ResolveBlockDIE(die);
3771 DWARFDIE child = FindFirstChildWithAbstractOrigin(
3772 die, containing_function_with_abstract_origin);
3773 CompilerDeclContext decl_context =
3774 GetDeclContextContainingUIDFromDWARF(child);
3775 return (clang::DeclContext *)decl_context.GetOpaqueDeclContext();
3778 clang::BlockDecl *DWARFASTParserClang::ResolveBlockDIE(const DWARFDIE &die) {
3779 if (die && die.Tag() == DW_TAG_lexical_block) {
3780 clang::BlockDecl *decl =
3781 llvm::cast_or_null<clang::BlockDecl>(m_die_to_decl_ctx[die.GetDIE()]);
3784 DWARFDIE decl_context_die;
3785 clang::DeclContext *decl_context =
3786 GetClangDeclContextContainingDIE(die, &decl_context_die);
3787 decl = m_ast.CreateBlockDeclaration(decl_context);
3790 LinkDeclContextToDIE((clang::DeclContext *)decl, die);
3798 clang::NamespaceDecl *
3799 DWARFASTParserClang::ResolveNamespaceDIE(const DWARFDIE &die) {
3800 if (die && die.Tag() == DW_TAG_namespace) {
3801 // See if we already parsed this namespace DIE and associated it with a
3802 // uniqued namespace declaration
3803 clang::NamespaceDecl *namespace_decl =
3804 static_cast<clang::NamespaceDecl *>(m_die_to_decl_ctx[die.GetDIE()]);
3806 return namespace_decl;
3808 const char *namespace_name = die.GetName();
3809 clang::DeclContext *containing_decl_ctx =
3810 GetClangDeclContextContainingDIE(die, nullptr);
3811 namespace_decl = m_ast.GetUniqueNamespaceDeclaration(namespace_name,
3812 containing_decl_ctx);
3814 nullptr; // (LogChannelDWARF::GetLogIfAll(DWARF_LOG_DEBUG_INFO));
3816 SymbolFileDWARF *dwarf = die.GetDWARF();
3817 if (namespace_name) {
3818 dwarf->GetObjectFile()->GetModule()->LogMessage(
3819 log, "ASTContext => %p: 0x%8.8" PRIx64
3820 ": DW_TAG_namespace with DW_AT_name(\"%s\") => "
3821 "clang::NamespaceDecl *%p (original = %p)",
3822 static_cast<void *>(m_ast.getASTContext()), die.GetID(),
3823 namespace_name, static_cast<void *>(namespace_decl),
3824 static_cast<void *>(namespace_decl->getOriginalNamespace()));
3826 dwarf->GetObjectFile()->GetModule()->LogMessage(
3827 log, "ASTContext => %p: 0x%8.8" PRIx64
3828 ": DW_TAG_namespace (anonymous) => clang::NamespaceDecl *%p "
3830 static_cast<void *>(m_ast.getASTContext()), die.GetID(),
3831 static_cast<void *>(namespace_decl),
3832 static_cast<void *>(namespace_decl->getOriginalNamespace()));
3837 LinkDeclContextToDIE((clang::DeclContext *)namespace_decl, die);
3838 return namespace_decl;
3844 clang::DeclContext *DWARFASTParserClang::GetClangDeclContextContainingDIE(
3845 const DWARFDIE &die, DWARFDIE *decl_ctx_die_copy) {
3846 SymbolFileDWARF *dwarf = die.GetDWARF();
3848 DWARFDIE decl_ctx_die = dwarf->GetDeclContextDIEContainingDIE(die);
3850 if (decl_ctx_die_copy)
3851 *decl_ctx_die_copy = decl_ctx_die;
3854 clang::DeclContext *clang_decl_ctx =
3855 GetClangDeclContextForDIE(decl_ctx_die);
3857 return clang_decl_ctx;
3859 return m_ast.GetTranslationUnitDecl();
3862 clang::DeclContext *
3863 DWARFASTParserClang::GetCachedClangDeclContextForDIE(const DWARFDIE &die) {
3865 DIEToDeclContextMap::iterator pos = m_die_to_decl_ctx.find(die.GetDIE());
3866 if (pos != m_die_to_decl_ctx.end())
3872 void DWARFASTParserClang::LinkDeclContextToDIE(clang::DeclContext *decl_ctx,
3873 const DWARFDIE &die) {
3874 m_die_to_decl_ctx[die.GetDIE()] = decl_ctx;
3875 // There can be many DIEs for a single decl context
3876 // m_decl_ctx_to_die[decl_ctx].insert(die.GetDIE());
3877 m_decl_ctx_to_die.insert(std::make_pair(decl_ctx, die));
3880 bool DWARFASTParserClang::CopyUniqueClassMethodTypes(
3881 const DWARFDIE &src_class_die, const DWARFDIE &dst_class_die,
3882 lldb_private::Type *class_type, DWARFDIECollection &failures) {
3883 if (!class_type || !src_class_die || !dst_class_die)
3885 if (src_class_die.Tag() != dst_class_die.Tag())
3888 // We need to complete the class type so we can get all of the method types
3889 // parsed so we can then unique those types to their equivalent counterparts
3890 // in "dst_cu" and "dst_class_die"
3891 class_type->GetFullCompilerType();
3895 UniqueCStringMap<DWARFDIE> src_name_to_die;
3896 UniqueCStringMap<DWARFDIE> dst_name_to_die;
3897 UniqueCStringMap<DWARFDIE> src_name_to_die_artificial;
3898 UniqueCStringMap<DWARFDIE> dst_name_to_die_artificial;
3899 for (src_die = src_class_die.GetFirstChild(); src_die.IsValid();
3900 src_die = src_die.GetSibling()) {
3901 if (src_die.Tag() == DW_TAG_subprogram) {
3902 // Make sure this is a declaration and not a concrete instance by looking
3903 // for DW_AT_declaration set to 1. Sometimes concrete function instances
3904 // are placed inside the class definitions and shouldn't be included in
3905 // the list of things are are tracking here.
3906 if (src_die.GetAttributeValueAsUnsigned(DW_AT_declaration, 0) == 1) {
3907 const char *src_name = src_die.GetMangledName();
3909 ConstString src_const_name(src_name);
3910 if (src_die.GetAttributeValueAsUnsigned(DW_AT_artificial, 0))
3911 src_name_to_die_artificial.Append(src_const_name, src_die);
3913 src_name_to_die.Append(src_const_name, src_die);
3918 for (dst_die = dst_class_die.GetFirstChild(); dst_die.IsValid();
3919 dst_die = dst_die.GetSibling()) {
3920 if (dst_die.Tag() == DW_TAG_subprogram) {
3921 // Make sure this is a declaration and not a concrete instance by looking
3922 // for DW_AT_declaration set to 1. Sometimes concrete function instances
3923 // are placed inside the class definitions and shouldn't be included in
3924 // the list of things are are tracking here.
3925 if (dst_die.GetAttributeValueAsUnsigned(DW_AT_declaration, 0) == 1) {
3926 const char *dst_name = dst_die.GetMangledName();
3928 ConstString dst_const_name(dst_name);
3929 if (dst_die.GetAttributeValueAsUnsigned(DW_AT_artificial, 0))
3930 dst_name_to_die_artificial.Append(dst_const_name, dst_die);
3932 dst_name_to_die.Append(dst_const_name, dst_die);
3937 const uint32_t src_size = src_name_to_die.GetSize();
3938 const uint32_t dst_size = dst_name_to_die.GetSize();
3939 Log *log = nullptr; // (LogChannelDWARF::GetLogIfAny(DWARF_LOG_DEBUG_INFO |
3940 // DWARF_LOG_TYPE_COMPLETION));
3942 // Is everything kosher so we can go through the members at top speed?
3943 bool fast_path = true;
3945 if (src_size != dst_size) {
3946 if (src_size != 0 && dst_size != 0) {
3948 log->Printf("warning: trying to unique class DIE 0x%8.8x to 0x%8.8x, "
3949 "but they didn't have the same size (src=%d, dst=%d)",
3950 src_class_die.GetOffset(), dst_class_die.GetOffset(),
3951 src_size, dst_size);
3960 for (idx = 0; idx < src_size; ++idx) {
3961 src_die = src_name_to_die.GetValueAtIndexUnchecked(idx);
3962 dst_die = dst_name_to_die.GetValueAtIndexUnchecked(idx);
3964 if (src_die.Tag() != dst_die.Tag()) {
3966 log->Printf("warning: tried to unique class DIE 0x%8.8x to 0x%8.8x, "
3967 "but 0x%8.8x (%s) tags didn't match 0x%8.8x (%s)",
3968 src_class_die.GetOffset(), dst_class_die.GetOffset(),
3969 src_die.GetOffset(), src_die.GetTagAsCString(),
3970 dst_die.GetOffset(), dst_die.GetTagAsCString());
3974 const char *src_name = src_die.GetMangledName();
3975 const char *dst_name = dst_die.GetMangledName();
3977 // Make sure the names match
3978 if (src_name == dst_name || (strcmp(src_name, dst_name) == 0))
3982 log->Printf("warning: tried to unique class DIE 0x%8.8x to 0x%8.8x, "
3983 "but 0x%8.8x (%s) names didn't match 0x%8.8x (%s)",
3984 src_class_die.GetOffset(), dst_class_die.GetOffset(),
3985 src_die.GetOffset(), src_name, dst_die.GetOffset(),
3992 DWARFASTParserClang *src_dwarf_ast_parser =
3993 (DWARFASTParserClang *)src_die.GetDWARFParser();
3994 DWARFASTParserClang *dst_dwarf_ast_parser =
3995 (DWARFASTParserClang *)dst_die.GetDWARFParser();
3997 // Now do the work of linking the DeclContexts and Types.
3999 // We can do this quickly. Just run across the tables index-for-index since
4000 // we know each node has matching names and tags.
4001 for (idx = 0; idx < src_size; ++idx) {
4002 src_die = src_name_to_die.GetValueAtIndexUnchecked(idx);
4003 dst_die = dst_name_to_die.GetValueAtIndexUnchecked(idx);
4005 clang::DeclContext *src_decl_ctx =
4006 src_dwarf_ast_parser->m_die_to_decl_ctx[src_die.GetDIE()];
4009 log->Printf("uniquing decl context %p from 0x%8.8x for 0x%8.8x",
4010 static_cast<void *>(src_decl_ctx), src_die.GetOffset(),
4011 dst_die.GetOffset());
4012 dst_dwarf_ast_parser->LinkDeclContextToDIE(src_decl_ctx, dst_die);
4015 log->Printf("warning: tried to unique decl context from 0x%8.8x for "
4016 "0x%8.8x, but none was found",
4017 src_die.GetOffset(), dst_die.GetOffset());
4020 Type *src_child_type =
4021 dst_die.GetDWARF()->GetDIEToType()[src_die.GetDIE()];
4022 if (src_child_type) {
4025 "uniquing type %p (uid=0x%" PRIx64 ") from 0x%8.8x for 0x%8.8x",
4026 static_cast<void *>(src_child_type), src_child_type->GetID(),
4027 src_die.GetOffset(), dst_die.GetOffset());
4028 dst_die.GetDWARF()->GetDIEToType()[dst_die.GetDIE()] = src_child_type;
4031 log->Printf("warning: tried to unique lldb_private::Type from "
4032 "0x%8.8x for 0x%8.8x, but none was found",
4033 src_die.GetOffset(), dst_die.GetOffset());
4037 // We must do this slowly. For each member of the destination, look
4038 // up a member in the source with the same name, check its tag, and
4039 // unique them if everything matches up. Report failures.
4041 if (!src_name_to_die.IsEmpty() && !dst_name_to_die.IsEmpty()) {
4042 src_name_to_die.Sort();
4044 for (idx = 0; idx < dst_size; ++idx) {
4045 ConstString dst_name = dst_name_to_die.GetCStringAtIndex(idx);
4046 dst_die = dst_name_to_die.GetValueAtIndexUnchecked(idx);
4047 src_die = src_name_to_die.Find(dst_name, DWARFDIE());
4049 if (src_die && (src_die.Tag() == dst_die.Tag())) {
4050 clang::DeclContext *src_decl_ctx =
4051 src_dwarf_ast_parser->m_die_to_decl_ctx[src_die.GetDIE()];
4054 log->Printf("uniquing decl context %p from 0x%8.8x for 0x%8.8x",
4055 static_cast<void *>(src_decl_ctx),
4056 src_die.GetOffset(), dst_die.GetOffset());
4057 dst_dwarf_ast_parser->LinkDeclContextToDIE(src_decl_ctx, dst_die);
4060 log->Printf("warning: tried to unique decl context from 0x%8.8x "
4061 "for 0x%8.8x, but none was found",
4062 src_die.GetOffset(), dst_die.GetOffset());
4065 Type *src_child_type =
4066 dst_die.GetDWARF()->GetDIEToType()[src_die.GetDIE()];
4067 if (src_child_type) {
4069 log->Printf("uniquing type %p (uid=0x%" PRIx64
4070 ") from 0x%8.8x for 0x%8.8x",
4071 static_cast<void *>(src_child_type),
4072 src_child_type->GetID(), src_die.GetOffset(),
4073 dst_die.GetOffset());
4074 dst_die.GetDWARF()->GetDIEToType()[dst_die.GetDIE()] =
4078 log->Printf("warning: tried to unique lldb_private::Type from "
4079 "0x%8.8x for 0x%8.8x, but none was found",
4080 src_die.GetOffset(), dst_die.GetOffset());
4084 log->Printf("warning: couldn't find a match for 0x%8.8x",
4085 dst_die.GetOffset());
4087 failures.Append(dst_die);
4093 const uint32_t src_size_artificial = src_name_to_die_artificial.GetSize();
4094 const uint32_t dst_size_artificial = dst_name_to_die_artificial.GetSize();
4096 if (src_size_artificial && dst_size_artificial) {
4097 dst_name_to_die_artificial.Sort();
4099 for (idx = 0; idx < src_size_artificial; ++idx) {
4100 ConstString src_name_artificial =
4101 src_name_to_die_artificial.GetCStringAtIndex(idx);
4102 src_die = src_name_to_die_artificial.GetValueAtIndexUnchecked(idx);
4104 dst_name_to_die_artificial.Find(src_name_artificial, DWARFDIE());
4107 // Both classes have the artificial types, link them
4108 clang::DeclContext *src_decl_ctx =
4109 src_dwarf_ast_parser->m_die_to_decl_ctx[src_die.GetDIE()];
4112 log->Printf("uniquing decl context %p from 0x%8.8x for 0x%8.8x",
4113 static_cast<void *>(src_decl_ctx), src_die.GetOffset(),
4114 dst_die.GetOffset());
4115 dst_dwarf_ast_parser->LinkDeclContextToDIE(src_decl_ctx, dst_die);
4118 log->Printf("warning: tried to unique decl context from 0x%8.8x "
4119 "for 0x%8.8x, but none was found",
4120 src_die.GetOffset(), dst_die.GetOffset());
4123 Type *src_child_type =
4124 dst_die.GetDWARF()->GetDIEToType()[src_die.GetDIE()];
4125 if (src_child_type) {
4128 "uniquing type %p (uid=0x%" PRIx64 ") from 0x%8.8x for 0x%8.8x",
4129 static_cast<void *>(src_child_type), src_child_type->GetID(),
4130 src_die.GetOffset(), dst_die.GetOffset());
4131 dst_die.GetDWARF()->GetDIEToType()[dst_die.GetDIE()] = src_child_type;
4134 log->Printf("warning: tried to unique lldb_private::Type from "
4135 "0x%8.8x for 0x%8.8x, but none was found",
4136 src_die.GetOffset(), dst_die.GetOffset());
4142 if (dst_size_artificial) {
4143 for (idx = 0; idx < dst_size_artificial; ++idx) {
4144 ConstString dst_name_artificial =
4145 dst_name_to_die_artificial.GetCStringAtIndex(idx);
4146 dst_die = dst_name_to_die_artificial.GetValueAtIndexUnchecked(idx);
4148 log->Printf("warning: need to create artificial method for 0x%8.8x for "
4150 dst_die.GetOffset(), dst_name_artificial.GetCString());
4152 failures.Append(dst_die);
4156 return (failures.Size() != 0);