1 //===-- ClangASTImporter.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 //===----------------------------------------------------------------------===//
10 #include "clang/AST/Decl.h"
11 #include "clang/AST/DeclCXX.h"
12 #include "clang/AST/DeclObjC.h"
13 #include "llvm/Support/raw_ostream.h"
14 #include "lldb/Core/Log.h"
15 #include "lldb/Core/Module.h"
16 #include "lldb/Symbol/ClangASTContext.h"
17 #include "lldb/Symbol/ClangASTImporter.h"
18 #include "lldb/Symbol/ClangExternalASTSourceCommon.h"
19 #include "lldb/Symbol/ClangNamespaceDecl.h"
21 using namespace lldb_private;
22 using namespace clang;
24 ClangASTMetrics::Counters ClangASTMetrics::global_counters = { 0, 0, 0, 0, 0, 0 };
25 ClangASTMetrics::Counters ClangASTMetrics::local_counters = { 0, 0, 0, 0, 0, 0 };
27 void ClangASTMetrics::DumpCounters (Log *log, ClangASTMetrics::Counters &counters)
29 log->Printf(" Number of visible Decl queries by name : %" PRIu64, counters.m_visible_query_count);
30 log->Printf(" Number of lexical Decl queries : %" PRIu64, counters.m_lexical_query_count);
31 log->Printf(" Number of imports initiated by LLDB : %" PRIu64, counters.m_lldb_import_count);
32 log->Printf(" Number of imports conducted by Clang : %" PRIu64, counters.m_clang_import_count);
33 log->Printf(" Number of Decls completed : %" PRIu64, counters.m_decls_completed_count);
34 log->Printf(" Number of records laid out : %" PRIu64, counters.m_record_layout_count);
37 void ClangASTMetrics::DumpCounters (Log *log)
42 log->Printf("== ClangASTMetrics output ==");
43 log->Printf("-- Global metrics --");
44 DumpCounters (log, global_counters);
45 log->Printf("-- Local metrics --");
46 DumpCounters (log, local_counters);
50 ClangASTImporter::CopyType (clang::ASTContext *dst_ast,
51 clang::ASTContext *src_ast,
54 MinionSP minion_sp (GetMinion(dst_ast, src_ast));
57 return minion_sp->Import(type);
63 ClangASTImporter::CopyType (clang::ASTContext *dst_ast,
64 clang::ASTContext *src_ast,
65 lldb::clang_type_t type)
67 return CopyType (dst_ast, src_ast, QualType::getFromOpaquePtr(type)).getAsOpaquePtr();
71 ClangASTImporter::CopyDecl (clang::ASTContext *dst_ast,
72 clang::ASTContext *src_ast,
77 minion_sp = GetMinion(dst_ast, src_ast);
81 clang::Decl *result = minion_sp->Import(decl);
85 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
89 lldb::user_id_t user_id = LLDB_INVALID_UID;
90 ClangASTMetadata *metadata = GetDeclMetadata(decl);
92 user_id = metadata->GetUserID();
94 if (NamedDecl *named_decl = dyn_cast<NamedDecl>(decl))
95 log->Printf(" [ClangASTImporter] WARNING: Failed to import a %s '%s', metadata 0x%" PRIx64,
96 decl->getDeclKindName(),
97 named_decl->getNameAsString().c_str(),
100 log->Printf(" [ClangASTImporter] WARNING: Failed to import a %s, metadata 0x%" PRIx64,
101 decl->getDeclKindName(),
113 ClangASTImporter::DeportType (clang::ASTContext *dst_ctx,
114 clang::ASTContext *src_ctx,
115 lldb::clang_type_t type)
117 MinionSP minion_sp (GetMinion (dst_ctx, src_ctx));
122 std::set<NamedDecl *> decls_to_deport;
123 std::set<NamedDecl *> decls_already_deported;
125 minion_sp->InitDeportWorkQueues(&decls_to_deport,
126 &decls_already_deported);
128 lldb::clang_type_t result = CopyType(dst_ctx, src_ctx, type);
130 minion_sp->ExecuteDeportWorkQueues();
140 ClangASTImporter::DeportDecl (clang::ASTContext *dst_ctx,
141 clang::ASTContext *src_ctx,
144 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
147 log->Printf(" [ClangASTImporter] DeportDecl called on (%sDecl*)%p from (ASTContext*)%p to (ASTContex*)%p",
148 decl->getDeclKindName(), static_cast<void*>(decl),
149 static_cast<void*>(src_ctx),
150 static_cast<void*>(dst_ctx));
152 MinionSP minion_sp (GetMinion (dst_ctx, src_ctx));
157 std::set<NamedDecl *> decls_to_deport;
158 std::set<NamedDecl *> decls_already_deported;
160 minion_sp->InitDeportWorkQueues(&decls_to_deport,
161 &decls_already_deported);
163 clang::Decl *result = CopyDecl(dst_ctx, src_ctx, decl);
165 minion_sp->ExecuteDeportWorkQueues();
171 log->Printf(" [ClangASTImporter] DeportDecl deported (%sDecl*)%p to (%sDecl*)%p",
172 decl->getDeclKindName(), static_cast<void*>(decl),
173 result->getDeclKindName(), static_cast<void*>(result));
179 ClangASTImporter::CompleteDecl (clang::Decl *decl)
181 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
184 log->Printf(" [ClangASTImporter] CompleteDecl called on (%sDecl*)%p",
185 decl->getDeclKindName(), static_cast<void*>(decl));
187 if (ObjCInterfaceDecl *interface_decl = dyn_cast<ObjCInterfaceDecl>(decl))
189 if (!interface_decl->getDefinition())
191 interface_decl->startDefinition();
192 CompleteObjCInterfaceDecl(interface_decl);
195 else if (ObjCProtocolDecl *protocol_decl = dyn_cast<ObjCProtocolDecl>(decl))
197 if (!protocol_decl->getDefinition())
198 protocol_decl->startDefinition();
200 else if (TagDecl *tag_decl = dyn_cast<TagDecl>(decl))
202 if (!tag_decl->getDefinition() && !tag_decl->isBeingDefined())
204 tag_decl->startDefinition();
205 CompleteTagDecl(tag_decl);
206 tag_decl->setCompleteDefinition(true);
211 assert (0 && "CompleteDecl called on a Decl that can't be completed");
216 ClangASTImporter::CompleteTagDecl (clang::TagDecl *decl)
218 ClangASTMetrics::RegisterDeclCompletion();
220 DeclOrigin decl_origin = GetDeclOrigin(decl);
222 if (!decl_origin.Valid())
225 if (!ClangASTContext::GetCompleteDecl(decl_origin.ctx, decl_origin.decl))
228 MinionSP minion_sp (GetMinion(&decl->getASTContext(), decl_origin.ctx));
231 minion_sp->ImportDefinitionTo(decl, decl_origin.decl);
237 ClangASTImporter::CompleteTagDeclWithOrigin(clang::TagDecl *decl, clang::TagDecl *origin_decl)
239 ClangASTMetrics::RegisterDeclCompletion();
241 clang::ASTContext *origin_ast_ctx = &origin_decl->getASTContext();
243 if (!ClangASTContext::GetCompleteDecl(origin_ast_ctx, origin_decl))
246 MinionSP minion_sp (GetMinion(&decl->getASTContext(), origin_ast_ctx));
249 minion_sp->ImportDefinitionTo(decl, origin_decl);
251 ASTContextMetadataSP context_md = GetContextMetadata(&decl->getASTContext());
253 OriginMap &origins = context_md->m_origins;
255 origins[decl] = DeclOrigin(origin_ast_ctx, origin_decl);
261 ClangASTImporter::CompleteObjCInterfaceDecl (clang::ObjCInterfaceDecl *interface_decl)
263 ClangASTMetrics::RegisterDeclCompletion();
265 DeclOrigin decl_origin = GetDeclOrigin(interface_decl);
267 if (!decl_origin.Valid())
270 if (!ClangASTContext::GetCompleteDecl(decl_origin.ctx, decl_origin.decl))
273 MinionSP minion_sp (GetMinion(&interface_decl->getASTContext(), decl_origin.ctx));
276 minion_sp->ImportDefinitionTo(interface_decl, decl_origin.decl);
278 if (ObjCInterfaceDecl *super_class = interface_decl->getSuperClass())
279 RequireCompleteType(clang::QualType(super_class->getTypeForDecl(), 0));
285 ClangASTImporter::RequireCompleteType (clang::QualType type)
290 if (const TagType *tag_type = type->getAs<TagType>())
292 TagDecl *tag_decl = tag_type->getDecl();
294 if (tag_decl->getDefinition() || tag_decl->isBeingDefined())
297 return CompleteTagDecl(tag_decl);
299 if (const ObjCObjectType *objc_object_type = type->getAs<ObjCObjectType>())
301 if (ObjCInterfaceDecl *objc_interface_decl = objc_object_type->getInterface())
302 return CompleteObjCInterfaceDecl(objc_interface_decl);
306 if (const ArrayType *array_type = type->getAsArrayTypeUnsafe())
308 return RequireCompleteType(array_type->getElementType());
310 if (const AtomicType *atomic_type = type->getAs<AtomicType>())
312 return RequireCompleteType(atomic_type->getPointeeType());
319 ClangASTImporter::GetDeclMetadata (const clang::Decl *decl)
321 DeclOrigin decl_origin = GetDeclOrigin(decl);
323 if (decl_origin.Valid())
324 return ClangASTContext::GetMetadata(decl_origin.ctx, decl_origin.decl);
326 return ClangASTContext::GetMetadata(&decl->getASTContext(), decl);
329 ClangASTImporter::DeclOrigin
330 ClangASTImporter::GetDeclOrigin(const clang::Decl *decl)
332 ASTContextMetadataSP context_md = GetContextMetadata(&decl->getASTContext());
334 OriginMap &origins = context_md->m_origins;
336 OriginMap::iterator iter = origins.find(decl);
338 if (iter != origins.end())
345 ClangASTImporter::SetDeclOrigin (const clang::Decl *decl, clang::Decl *original_decl)
347 ASTContextMetadataSP context_md = GetContextMetadata(&decl->getASTContext());
349 OriginMap &origins = context_md->m_origins;
351 OriginMap::iterator iter = origins.find(decl);
353 if (iter != origins.end())
355 iter->second.decl = original_decl;
356 iter->second.ctx = &original_decl->getASTContext();
360 origins[decl] = DeclOrigin(&original_decl->getASTContext(), original_decl);
365 ClangASTImporter::RegisterNamespaceMap(const clang::NamespaceDecl *decl,
366 NamespaceMapSP &namespace_map)
368 ASTContextMetadataSP context_md = GetContextMetadata(&decl->getASTContext());
370 context_md->m_namespace_maps[decl] = namespace_map;
373 ClangASTImporter::NamespaceMapSP
374 ClangASTImporter::GetNamespaceMap(const clang::NamespaceDecl *decl)
376 ASTContextMetadataSP context_md = GetContextMetadata(&decl->getASTContext());
378 NamespaceMetaMap &namespace_maps = context_md->m_namespace_maps;
380 NamespaceMetaMap::iterator iter = namespace_maps.find(decl);
382 if (iter != namespace_maps.end())
385 return NamespaceMapSP();
389 ClangASTImporter::BuildNamespaceMap(const clang::NamespaceDecl *decl)
392 ASTContextMetadataSP context_md = GetContextMetadata(&decl->getASTContext());
394 const DeclContext *parent_context = decl->getDeclContext();
395 const NamespaceDecl *parent_namespace = dyn_cast<NamespaceDecl>(parent_context);
396 NamespaceMapSP parent_map;
398 if (parent_namespace)
399 parent_map = GetNamespaceMap(parent_namespace);
401 NamespaceMapSP new_map;
403 new_map.reset(new NamespaceMap);
405 if (context_md->m_map_completer)
407 std::string namespace_string = decl->getDeclName().getAsString();
409 context_md->m_map_completer->CompleteNamespaceMap (new_map, ConstString(namespace_string.c_str()), parent_map);
412 context_md->m_namespace_maps[decl] = new_map;
416 ClangASTImporter::ForgetDestination (clang::ASTContext *dst_ast)
418 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
421 log->Printf(" [ClangASTImporter] Forgetting destination (ASTContext*)%p",
422 static_cast<void*>(dst_ast));
424 m_metadata_map.erase(dst_ast);
428 ClangASTImporter::ForgetSource (clang::ASTContext *dst_ast, clang::ASTContext *src_ast)
430 ASTContextMetadataSP md = MaybeGetContextMetadata (dst_ast);
432 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
435 log->Printf(" [ClangASTImporter] Forgetting source->dest (ASTContext*)%p->(ASTContext*)%p",
436 static_cast<void*>(src_ast), static_cast<void*>(dst_ast));
441 md->m_minions.erase(src_ast);
443 for (OriginMap::iterator iter = md->m_origins.begin();
444 iter != md->m_origins.end();
447 if (iter->second.ctx == src_ast)
448 md->m_origins.erase(iter++);
454 ClangASTImporter::MapCompleter::~MapCompleter ()
460 ClangASTImporter::Minion::InitDeportWorkQueues (std::set<clang::NamedDecl *> *decls_to_deport,
461 std::set<clang::NamedDecl *> *decls_already_deported)
463 assert(!m_decls_to_deport); // TODO make debug only
464 assert(!m_decls_already_deported);
466 m_decls_to_deport = decls_to_deport;
467 m_decls_already_deported = decls_already_deported;
471 ClangASTImporter::Minion::ExecuteDeportWorkQueues ()
473 assert(m_decls_to_deport); // TODO make debug only
474 assert(m_decls_already_deported);
476 ASTContextMetadataSP to_context_md = m_master.GetContextMetadata(&getToContext());
478 while (!m_decls_to_deport->empty())
480 NamedDecl *decl = *m_decls_to_deport->begin();
482 m_decls_already_deported->insert(decl);
483 m_decls_to_deport->erase(decl);
485 DeclOrigin &origin = to_context_md->m_origins[decl];
487 assert (origin.ctx == m_source_ctx); // otherwise we should never have added this
488 // because it doesn't need to be deported
490 Decl *original_decl = to_context_md->m_origins[decl].decl;
492 ClangASTContext::GetCompleteDecl (m_source_ctx, original_decl);
494 if (TagDecl *tag_decl = dyn_cast<TagDecl>(decl))
496 if (TagDecl *original_tag_decl = dyn_cast<TagDecl>(original_decl))
497 if (original_tag_decl->isCompleteDefinition())
498 ImportDefinitionTo(tag_decl, original_tag_decl);
500 tag_decl->setHasExternalLexicalStorage(false);
501 tag_decl->setHasExternalVisibleStorage(false);
503 else if (ObjCInterfaceDecl *interface_decl = dyn_cast<ObjCInterfaceDecl>(decl))
505 interface_decl->setHasExternalLexicalStorage(false);
506 interface_decl->setHasExternalVisibleStorage(false);
509 to_context_md->m_origins.erase(decl);
512 m_decls_to_deport = nullptr;
513 m_decls_already_deported = nullptr;
517 ClangASTImporter::Minion::ImportDefinitionTo (clang::Decl *to, clang::Decl *from)
519 ASTImporter::Imported(from, to);
521 ObjCInterfaceDecl *to_objc_interface = dyn_cast<ObjCInterfaceDecl>(to);
524 if (to_objc_interface)
525 to_objc_interface->startDefinition();
527 CXXRecordDecl *to_cxx_record = dyn_cast<CXXRecordDecl>(to);
530 to_cxx_record->startDefinition();
533 ImportDefinition(from);
535 // If we're dealing with an Objective-C class, ensure that the inheritance has
536 // been set up correctly. The ASTImporter may not do this correctly if the
537 // class was originally sourced from symbols.
539 if (to_objc_interface)
543 ObjCInterfaceDecl *to_superclass = to_objc_interface->getSuperClass();
546 break; // we're not going to override it if it's set
548 ObjCInterfaceDecl *from_objc_interface = dyn_cast<ObjCInterfaceDecl>(from);
550 if (!from_objc_interface)
553 ObjCInterfaceDecl *from_superclass = from_objc_interface->getSuperClass();
555 if (!from_superclass)
558 Decl *imported_from_superclass_decl = Import(from_superclass);
560 if (!imported_from_superclass_decl)
563 ObjCInterfaceDecl *imported_from_superclass = dyn_cast<ObjCInterfaceDecl>(imported_from_superclass_decl);
565 if (!imported_from_superclass)
568 if (!to_objc_interface->hasDefinition())
569 to_objc_interface->startDefinition();
571 to_objc_interface->setSuperClass(imported_from_superclass);
578 ClangASTImporter::Minion::Imported (clang::Decl *from, clang::Decl *to)
580 ClangASTMetrics::RegisterClangImport();
582 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_EXPRESSIONS));
584 lldb::user_id_t user_id = LLDB_INVALID_UID;
585 ClangASTMetadata *metadata = m_master.GetDeclMetadata(from);
587 user_id = metadata->GetUserID();
591 if (NamedDecl *from_named_decl = dyn_cast<clang::NamedDecl>(from))
593 std::string name_string;
594 llvm::raw_string_ostream name_stream(name_string);
595 from_named_decl->printName(name_stream);
598 log->Printf(" [ClangASTImporter] Imported (%sDecl*)%p, named %s (from (Decl*)%p), metadata 0x%" PRIx64,
599 from->getDeclKindName(), static_cast<void*>(to),
600 name_string.c_str(), static_cast<void*>(from),
605 log->Printf(" [ClangASTImporter] Imported (%sDecl*)%p (from (Decl*)%p), metadata 0x%" PRIx64,
606 from->getDeclKindName(), static_cast<void*>(to),
607 static_cast<void*>(from), user_id);
611 ASTContextMetadataSP to_context_md = m_master.GetContextMetadata(&to->getASTContext());
612 ASTContextMetadataSP from_context_md = m_master.MaybeGetContextMetadata(m_source_ctx);
616 OriginMap &origins = from_context_md->m_origins;
618 OriginMap::iterator origin_iter = origins.find(from);
620 if (origin_iter != origins.end())
622 if (to_context_md->m_origins.find(to) == to_context_md->m_origins.end() ||
623 user_id != LLDB_INVALID_UID)
625 to_context_md->m_origins[to] = origin_iter->second;
628 MinionSP direct_completer = m_master.GetMinion(&to->getASTContext(), origin_iter->second.ctx);
630 if (direct_completer.get() != this)
631 direct_completer->ASTImporter::Imported(origin_iter->second.decl, to);
634 log->Printf(" [ClangASTImporter] Propagated origin (Decl*)%p/(ASTContext*)%p from (ASTContext*)%p to (ASTContext*)%p",
635 static_cast<void*>(origin_iter->second.decl),
636 static_cast<void*>(origin_iter->second.ctx),
637 static_cast<void*>(&from->getASTContext()),
638 static_cast<void*>(&to->getASTContext()));
642 if (m_decls_to_deport && m_decls_already_deported)
644 if (isa<TagDecl>(to) || isa<ObjCInterfaceDecl>(to))
646 NamedDecl *to_named_decl = dyn_cast<NamedDecl>(to);
648 if (!m_decls_already_deported->count(to_named_decl))
649 m_decls_to_deport->insert(to_named_decl);
653 if (to_context_md->m_origins.find(to) == to_context_md->m_origins.end() ||
654 user_id != LLDB_INVALID_UID)
656 to_context_md->m_origins[to] = DeclOrigin(m_source_ctx, from);
660 log->Printf(" [ClangASTImporter] Decl has no origin information in (ASTContext*)%p",
661 static_cast<void*>(&from->getASTContext()));
664 if (clang::NamespaceDecl *to_namespace = dyn_cast<clang::NamespaceDecl>(to))
666 clang::NamespaceDecl *from_namespace = dyn_cast<clang::NamespaceDecl>(from);
668 NamespaceMetaMap &namespace_maps = from_context_md->m_namespace_maps;
670 NamespaceMetaMap::iterator namespace_map_iter = namespace_maps.find(from_namespace);
672 if (namespace_map_iter != namespace_maps.end())
673 to_context_md->m_namespace_maps[to_namespace] = namespace_map_iter->second;
678 to_context_md->m_origins[to] = DeclOrigin (m_source_ctx, from);
681 log->Printf(" [ClangASTImporter] Sourced origin (Decl*)%p/(ASTContext*)%p into (ASTContext*)%p",
682 static_cast<void*>(from),
683 static_cast<void*>(m_source_ctx),
684 static_cast<void*>(&to->getASTContext()));
687 if (TagDecl *from_tag_decl = dyn_cast<TagDecl>(from))
689 TagDecl *to_tag_decl = dyn_cast<TagDecl>(to);
691 to_tag_decl->setHasExternalLexicalStorage();
692 to_tag_decl->setMustBuildLookupTable();
695 log->Printf(" [ClangASTImporter] To is a TagDecl - attributes %s%s [%s->%s]",
696 (to_tag_decl->hasExternalLexicalStorage() ? " Lexical" : ""),
697 (to_tag_decl->hasExternalVisibleStorage() ? " Visible" : ""),
698 (from_tag_decl->isCompleteDefinition() ? "complete" : "incomplete"),
699 (to_tag_decl->isCompleteDefinition() ? "complete" : "incomplete"));
702 if (isa<NamespaceDecl>(from))
704 NamespaceDecl *to_namespace_decl = dyn_cast<NamespaceDecl>(to);
706 m_master.BuildNamespaceMap(to_namespace_decl);
708 to_namespace_decl->setHasExternalVisibleStorage();
711 if (isa<ObjCInterfaceDecl>(from))
713 ObjCInterfaceDecl *to_interface_decl = dyn_cast<ObjCInterfaceDecl>(to);
715 to_interface_decl->setHasExternalLexicalStorage();
716 to_interface_decl->setHasExternalVisibleStorage();
718 /*to_interface_decl->setExternallyCompleted();*/
721 log->Printf(" [ClangASTImporter] To is an ObjCInterfaceDecl - attributes %s%s%s",
722 (to_interface_decl->hasExternalLexicalStorage() ? " Lexical" : ""),
723 (to_interface_decl->hasExternalVisibleStorage() ? " Visible" : ""),
724 (to_interface_decl->hasDefinition() ? " HasDefinition" : ""));
727 return clang::ASTImporter::Imported(from, to);
730 clang::Decl *ClangASTImporter::Minion::GetOriginalDecl (clang::Decl *To)
732 ASTContextMetadataSP to_context_md = m_master.GetContextMetadata(&To->getASTContext());
737 OriginMap::iterator iter = to_context_md->m_origins.find(To);
739 if (iter == to_context_md->m_origins.end())
742 return const_cast<clang::Decl*>(iter->second.decl);