1 //===-- ClangASTSource.cpp ------------------------------------------------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #include "ClangASTSource.h" 10 11 #include "ClangDeclVendor.h" 12 #include "ClangModulesDeclVendor.h" 13 14 #include "lldb/Core/Module.h" 15 #include "lldb/Core/ModuleList.h" 16 #include "lldb/Symbol/CompilerDeclContext.h" 17 #include "lldb/Symbol/Function.h" 18 #include "lldb/Symbol/SymbolFile.h" 19 #include "lldb/Symbol/TaggedASTType.h" 20 #include "lldb/Target/Target.h" 21 #include "lldb/Utility/Log.h" 22 #include "clang/AST/ASTContext.h" 23 #include "clang/AST/RecordLayout.h" 24 #include "clang/Basic/SourceManager.h" 25 26 #include "Plugins/ExpressionParser/Clang/ClangUtil.h" 27 #include "Plugins/LanguageRuntime/ObjC/ObjCLanguageRuntime.h" 28 #include "Plugins/TypeSystem/Clang/TypeSystemClang.h" 29 30 #include <memory> 31 #include <vector> 32 33 using namespace clang; 34 using namespace lldb_private; 35 36 // Scoped class that will remove an active lexical decl from the set when it 37 // goes out of scope. 38 namespace { 39 class ScopedLexicalDeclEraser { 40 public: 41 ScopedLexicalDeclEraser(std::set<const clang::Decl *> &decls, 42 const clang::Decl *decl) 43 : m_active_lexical_decls(decls), m_decl(decl) {} 44 45 ~ScopedLexicalDeclEraser() { m_active_lexical_decls.erase(m_decl); } 46 47 private: 48 std::set<const clang::Decl *> &m_active_lexical_decls; 49 const clang::Decl *m_decl; 50 }; 51 } 52 53 ClangASTSource::ClangASTSource( 54 const lldb::TargetSP &target, 55 const std::shared_ptr<ClangASTImporter> &importer) 56 : m_lookups_enabled(false), m_target(target), m_ast_context(nullptr), 57 m_ast_importer_sp(importer), m_active_lexical_decls(), 58 m_active_lookups() { 59 assert(m_ast_importer_sp && "No ClangASTImporter passed to ClangASTSource?"); 60 } 61 62 void ClangASTSource::InstallASTContext(TypeSystemClang &clang_ast_context) { 63 m_ast_context = &clang_ast_context.getASTContext(); 64 m_clang_ast_context = &clang_ast_context; 65 m_file_manager = &m_ast_context->getSourceManager().getFileManager(); 66 m_ast_importer_sp->InstallMapCompleter(m_ast_context, *this); 67 } 68 69 ClangASTSource::~ClangASTSource() { 70 m_ast_importer_sp->ForgetDestination(m_ast_context); 71 72 if (!m_target) 73 return; 74 75 // Unregister the current ASTContext as a source for all scratch 76 // ASTContexts in the ClangASTImporter. Without this the scratch AST might 77 // query the deleted ASTContext for additional type information. 78 // We unregister from *all* scratch ASTContexts in case a type got exported 79 // to a scratch AST that isn't the best fitting scratch ASTContext. 80 TypeSystemClang *scratch_ast = ScratchTypeSystemClang::GetForTarget( 81 *m_target, ScratchTypeSystemClang::DefaultAST, false); 82 83 if (!scratch_ast) 84 return; 85 86 ScratchTypeSystemClang *default_scratch_ast = 87 llvm::cast<ScratchTypeSystemClang>(scratch_ast); 88 // Unregister from the default scratch AST (and all sub-ASTs). 89 default_scratch_ast->ForgetSource(m_ast_context, *m_ast_importer_sp); 90 } 91 92 void ClangASTSource::StartTranslationUnit(ASTConsumer *Consumer) { 93 if (!m_ast_context) 94 return; 95 96 m_ast_context->getTranslationUnitDecl()->setHasExternalVisibleStorage(); 97 m_ast_context->getTranslationUnitDecl()->setHasExternalLexicalStorage(); 98 } 99 100 // The core lookup interface. 101 bool ClangASTSource::FindExternalVisibleDeclsByName( 102 const DeclContext *decl_ctx, DeclarationName clang_decl_name) { 103 if (!m_ast_context) { 104 SetNoExternalVisibleDeclsForName(decl_ctx, clang_decl_name); 105 return false; 106 } 107 108 std::string decl_name(clang_decl_name.getAsString()); 109 110 switch (clang_decl_name.getNameKind()) { 111 // Normal identifiers. 112 case DeclarationName::Identifier: { 113 clang::IdentifierInfo *identifier_info = 114 clang_decl_name.getAsIdentifierInfo(); 115 116 if (!identifier_info || identifier_info->getBuiltinID() != 0) { 117 SetNoExternalVisibleDeclsForName(decl_ctx, clang_decl_name); 118 return false; 119 } 120 } break; 121 122 // Operator names. 123 case DeclarationName::CXXOperatorName: 124 case DeclarationName::CXXLiteralOperatorName: 125 break; 126 127 // Using directives found in this context. 128 // Tell Sema we didn't find any or we'll end up getting asked a *lot*. 129 case DeclarationName::CXXUsingDirective: 130 SetNoExternalVisibleDeclsForName(decl_ctx, clang_decl_name); 131 return false; 132 133 case DeclarationName::ObjCZeroArgSelector: 134 case DeclarationName::ObjCOneArgSelector: 135 case DeclarationName::ObjCMultiArgSelector: { 136 llvm::SmallVector<NamedDecl *, 1> method_decls; 137 138 NameSearchContext method_search_context(*m_clang_ast_context, method_decls, 139 clang_decl_name, decl_ctx); 140 141 FindObjCMethodDecls(method_search_context); 142 143 SetExternalVisibleDeclsForName(decl_ctx, clang_decl_name, method_decls); 144 return (method_decls.size() > 0); 145 } 146 // These aren't possible in the global context. 147 case DeclarationName::CXXConstructorName: 148 case DeclarationName::CXXDestructorName: 149 case DeclarationName::CXXConversionFunctionName: 150 case DeclarationName::CXXDeductionGuideName: 151 SetNoExternalVisibleDeclsForName(decl_ctx, clang_decl_name); 152 return false; 153 } 154 155 if (!GetLookupsEnabled()) { 156 // Wait until we see a '$' at the start of a name before we start doing any 157 // lookups so we can avoid lookup up all of the builtin types. 158 if (!decl_name.empty() && decl_name[0] == '$') { 159 SetLookupsEnabled(true); 160 } else { 161 SetNoExternalVisibleDeclsForName(decl_ctx, clang_decl_name); 162 return false; 163 } 164 } 165 166 ConstString const_decl_name(decl_name.c_str()); 167 168 const char *uniqued_const_decl_name = const_decl_name.GetCString(); 169 if (m_active_lookups.find(uniqued_const_decl_name) != 170 m_active_lookups.end()) { 171 // We are currently looking up this name... 172 SetNoExternalVisibleDeclsForName(decl_ctx, clang_decl_name); 173 return false; 174 } 175 m_active_lookups.insert(uniqued_const_decl_name); 176 llvm::SmallVector<NamedDecl *, 4> name_decls; 177 NameSearchContext name_search_context(*m_clang_ast_context, name_decls, 178 clang_decl_name, decl_ctx); 179 FindExternalVisibleDecls(name_search_context); 180 SetExternalVisibleDeclsForName(decl_ctx, clang_decl_name, name_decls); 181 m_active_lookups.erase(uniqued_const_decl_name); 182 return (name_decls.size() != 0); 183 } 184 185 TagDecl *ClangASTSource::FindCompleteType(const TagDecl *decl) { 186 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 187 188 if (const NamespaceDecl *namespace_context = 189 dyn_cast<NamespaceDecl>(decl->getDeclContext())) { 190 ClangASTImporter::NamespaceMapSP namespace_map = 191 m_ast_importer_sp->GetNamespaceMap(namespace_context); 192 193 LLDB_LOGV(log, " CTD Inspecting namespace map{0} ({1} entries)", 194 namespace_map.get(), namespace_map->size()); 195 196 if (!namespace_map) 197 return nullptr; 198 199 for (const ClangASTImporter::NamespaceMapItem &item : *namespace_map) { 200 LLDB_LOG(log, " CTD Searching namespace {0} in module {1}", 201 item.second.GetName(), item.first->GetFileSpec().GetFilename()); 202 203 TypeList types; 204 205 ConstString name(decl->getName()); 206 207 item.first->FindTypesInNamespace(name, item.second, UINT32_MAX, types); 208 209 for (uint32_t ti = 0, te = types.GetSize(); ti != te; ++ti) { 210 lldb::TypeSP type = types.GetTypeAtIndex(ti); 211 212 if (!type) 213 continue; 214 215 CompilerType clang_type(type->GetFullCompilerType()); 216 217 if (!ClangUtil::IsClangType(clang_type)) 218 continue; 219 220 const TagType *tag_type = 221 ClangUtil::GetQualType(clang_type)->getAs<TagType>(); 222 223 if (!tag_type) 224 continue; 225 226 TagDecl *candidate_tag_decl = 227 const_cast<TagDecl *>(tag_type->getDecl()); 228 229 if (TypeSystemClang::GetCompleteDecl( 230 &candidate_tag_decl->getASTContext(), candidate_tag_decl)) 231 return candidate_tag_decl; 232 } 233 } 234 } else { 235 TypeList types; 236 237 ConstString name(decl->getName()); 238 239 const ModuleList &module_list = m_target->GetImages(); 240 241 bool exact_match = false; 242 llvm::DenseSet<SymbolFile *> searched_symbol_files; 243 module_list.FindTypes(nullptr, name, exact_match, UINT32_MAX, 244 searched_symbol_files, types); 245 246 for (uint32_t ti = 0, te = types.GetSize(); ti != te; ++ti) { 247 lldb::TypeSP type = types.GetTypeAtIndex(ti); 248 249 if (!type) 250 continue; 251 252 CompilerType clang_type(type->GetFullCompilerType()); 253 254 if (!ClangUtil::IsClangType(clang_type)) 255 continue; 256 257 const TagType *tag_type = 258 ClangUtil::GetQualType(clang_type)->getAs<TagType>(); 259 260 if (!tag_type) 261 continue; 262 263 TagDecl *candidate_tag_decl = const_cast<TagDecl *>(tag_type->getDecl()); 264 265 // We have found a type by basename and we need to make sure the decl 266 // contexts are the same before we can try to complete this type with 267 // another 268 if (!TypeSystemClang::DeclsAreEquivalent(const_cast<TagDecl *>(decl), 269 candidate_tag_decl)) 270 continue; 271 272 if (TypeSystemClang::GetCompleteDecl(&candidate_tag_decl->getASTContext(), 273 candidate_tag_decl)) 274 return candidate_tag_decl; 275 } 276 } 277 return nullptr; 278 } 279 280 void ClangASTSource::CompleteType(TagDecl *tag_decl) { 281 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 282 283 if (log) { 284 LLDB_LOG(log, 285 " CompleteTagDecl on (ASTContext*){0} Completing " 286 "(TagDecl*){1} named {2}", 287 m_clang_ast_context->getDisplayName(), tag_decl, 288 tag_decl->getName()); 289 290 LLDB_LOG(log, " CTD Before:\n{0}", ClangUtil::DumpDecl(tag_decl)); 291 } 292 293 auto iter = m_active_lexical_decls.find(tag_decl); 294 if (iter != m_active_lexical_decls.end()) 295 return; 296 m_active_lexical_decls.insert(tag_decl); 297 ScopedLexicalDeclEraser eraser(m_active_lexical_decls, tag_decl); 298 299 if (!m_ast_importer_sp->CompleteTagDecl(tag_decl)) { 300 // We couldn't complete the type. Maybe there's a definition somewhere 301 // else that can be completed. 302 if (TagDecl *alternate = FindCompleteType(tag_decl)) 303 m_ast_importer_sp->CompleteTagDeclWithOrigin(tag_decl, alternate); 304 } 305 306 LLDB_LOG(log, " [CTD] After:\n{0}", ClangUtil::DumpDecl(tag_decl)); 307 } 308 309 void ClangASTSource::CompleteType(clang::ObjCInterfaceDecl *interface_decl) { 310 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 311 312 LLDB_LOG(log, 313 " [CompleteObjCInterfaceDecl] on (ASTContext*){0} '{1}' " 314 "Completing an ObjCInterfaceDecl named {1}", 315 m_ast_context, m_clang_ast_context->getDisplayName(), 316 interface_decl->getName()); 317 LLDB_LOG(log, " [COID] Before:\n{0}", 318 ClangUtil::DumpDecl(interface_decl)); 319 320 ClangASTImporter::DeclOrigin original = m_ast_importer_sp->GetDeclOrigin(interface_decl); 321 322 if (original.Valid()) { 323 if (ObjCInterfaceDecl *original_iface_decl = 324 dyn_cast<ObjCInterfaceDecl>(original.decl)) { 325 ObjCInterfaceDecl *complete_iface_decl = 326 GetCompleteObjCInterface(original_iface_decl); 327 328 if (complete_iface_decl && (complete_iface_decl != original_iface_decl)) { 329 m_ast_importer_sp->SetDeclOrigin(interface_decl, complete_iface_decl); 330 } 331 } 332 } 333 334 m_ast_importer_sp->CompleteObjCInterfaceDecl(interface_decl); 335 336 if (interface_decl->getSuperClass() && 337 interface_decl->getSuperClass() != interface_decl) 338 CompleteType(interface_decl->getSuperClass()); 339 340 LLDB_LOG(log, " [COID] After:"); 341 LLDB_LOG(log, " [COID] {0}", ClangUtil::DumpDecl(interface_decl)); 342 } 343 344 clang::ObjCInterfaceDecl *ClangASTSource::GetCompleteObjCInterface( 345 const clang::ObjCInterfaceDecl *interface_decl) { 346 lldb::ProcessSP process(m_target->GetProcessSP()); 347 348 if (!process) 349 return nullptr; 350 351 ObjCLanguageRuntime *language_runtime(ObjCLanguageRuntime::Get(*process)); 352 353 if (!language_runtime) 354 return nullptr; 355 356 ConstString class_name(interface_decl->getNameAsString().c_str()); 357 358 lldb::TypeSP complete_type_sp( 359 language_runtime->LookupInCompleteClassCache(class_name)); 360 361 if (!complete_type_sp) 362 return nullptr; 363 364 TypeFromUser complete_type = 365 TypeFromUser(complete_type_sp->GetFullCompilerType()); 366 lldb::opaque_compiler_type_t complete_opaque_type = 367 complete_type.GetOpaqueQualType(); 368 369 if (!complete_opaque_type) 370 return nullptr; 371 372 const clang::Type *complete_clang_type = 373 QualType::getFromOpaquePtr(complete_opaque_type).getTypePtr(); 374 const ObjCInterfaceType *complete_interface_type = 375 dyn_cast<ObjCInterfaceType>(complete_clang_type); 376 377 if (!complete_interface_type) 378 return nullptr; 379 380 ObjCInterfaceDecl *complete_iface_decl(complete_interface_type->getDecl()); 381 382 return complete_iface_decl; 383 } 384 385 void ClangASTSource::FindExternalLexicalDecls( 386 const DeclContext *decl_context, 387 llvm::function_ref<bool(Decl::Kind)> predicate, 388 llvm::SmallVectorImpl<Decl *> &decls) { 389 390 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 391 392 const Decl *context_decl = dyn_cast<Decl>(decl_context); 393 394 if (!context_decl) 395 return; 396 397 auto iter = m_active_lexical_decls.find(context_decl); 398 if (iter != m_active_lexical_decls.end()) 399 return; 400 m_active_lexical_decls.insert(context_decl); 401 ScopedLexicalDeclEraser eraser(m_active_lexical_decls, context_decl); 402 403 if (log) { 404 if (const NamedDecl *context_named_decl = dyn_cast<NamedDecl>(context_decl)) 405 LLDB_LOG(log, 406 "FindExternalLexicalDecls on (ASTContext*){0} '{1}' in " 407 "'{2}' (%sDecl*){3}", 408 m_ast_context, m_clang_ast_context->getDisplayName(), 409 context_named_decl->getNameAsString().c_str(), 410 context_decl->getDeclKindName(), 411 static_cast<const void *>(context_decl)); 412 else if (context_decl) 413 LLDB_LOG(log, 414 "FindExternalLexicalDecls on (ASTContext*){0} '{1}' in " 415 "({2}Decl*){3}", 416 m_ast_context, m_clang_ast_context->getDisplayName(), 417 context_decl->getDeclKindName(), 418 static_cast<const void *>(context_decl)); 419 else 420 LLDB_LOG(log, 421 "FindExternalLexicalDecls on (ASTContext*){0} '{1}' in a " 422 "NULL context", 423 m_ast_context, m_clang_ast_context->getDisplayName()); 424 } 425 426 ClangASTImporter::DeclOrigin original = m_ast_importer_sp->GetDeclOrigin(context_decl); 427 428 if (!original.Valid()) 429 return; 430 431 LLDB_LOG(log, " FELD Original decl {0} (Decl*){1:x}:\n{2}", 432 static_cast<void *>(original.ctx), 433 static_cast<void *>(original.decl), 434 ClangUtil::DumpDecl(original.decl)); 435 436 if (ObjCInterfaceDecl *original_iface_decl = 437 dyn_cast<ObjCInterfaceDecl>(original.decl)) { 438 ObjCInterfaceDecl *complete_iface_decl = 439 GetCompleteObjCInterface(original_iface_decl); 440 441 if (complete_iface_decl && (complete_iface_decl != original_iface_decl)) { 442 original.decl = complete_iface_decl; 443 original.ctx = &complete_iface_decl->getASTContext(); 444 445 m_ast_importer_sp->SetDeclOrigin(context_decl, complete_iface_decl); 446 } 447 } 448 449 if (TagDecl *original_tag_decl = dyn_cast<TagDecl>(original.decl)) { 450 ExternalASTSource *external_source = original.ctx->getExternalSource(); 451 452 if (external_source) 453 external_source->CompleteType(original_tag_decl); 454 } 455 456 const DeclContext *original_decl_context = 457 dyn_cast<DeclContext>(original.decl); 458 459 if (!original_decl_context) 460 return; 461 462 // Indicates whether we skipped any Decls of the original DeclContext. 463 bool SkippedDecls = false; 464 for (Decl *decl : original_decl_context->decls()) { 465 // The predicate function returns true if the passed declaration kind is 466 // the one we are looking for. 467 // See clang::ExternalASTSource::FindExternalLexicalDecls() 468 if (predicate(decl->getKind())) { 469 if (log) { 470 std::string ast_dump = ClangUtil::DumpDecl(decl); 471 if (const NamedDecl *context_named_decl = 472 dyn_cast<NamedDecl>(context_decl)) 473 LLDB_LOG(log, " FELD Adding [to {0}Decl {1}] lexical {2}Decl {3}", 474 context_named_decl->getDeclKindName(), 475 context_named_decl->getName(), decl->getDeclKindName(), 476 ast_dump); 477 else 478 LLDB_LOG(log, " FELD Adding lexical {0}Decl {1}", 479 decl->getDeclKindName(), ast_dump); 480 } 481 482 CopyDecl(decl); 483 484 // FIXME: We should add the copied decl to the 'decls' list. This would 485 // add the copied Decl into the DeclContext and make sure that we 486 // correctly propagate that we added some Decls back to Clang. 487 // By leaving 'decls' empty we incorrectly return false from 488 // DeclContext::LoadLexicalDeclsFromExternalStorage which might cause 489 // lookup issues later on. 490 // We can't just add them for now as the ASTImporter already added the 491 // decl into the DeclContext and this would add it twice. 492 } else { 493 SkippedDecls = true; 494 } 495 } 496 497 // CopyDecl may build a lookup table which may set up ExternalLexicalStorage 498 // to false. However, since we skipped some of the external Decls we must 499 // set it back! 500 if (SkippedDecls) { 501 decl_context->setHasExternalLexicalStorage(true); 502 // This sets HasLazyExternalLexicalLookups to true. By setting this bit we 503 // ensure that the lookup table is rebuilt, which means the external source 504 // is consulted again when a clang::DeclContext::lookup is called. 505 const_cast<DeclContext *>(decl_context)->setMustBuildLookupTable(); 506 } 507 508 return; 509 } 510 511 void ClangASTSource::FindExternalVisibleDecls(NameSearchContext &context) { 512 assert(m_ast_context); 513 514 const ConstString name(context.m_decl_name.getAsString().c_str()); 515 516 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 517 518 if (log) { 519 if (!context.m_decl_context) 520 LLDB_LOG(log, 521 "ClangASTSource::FindExternalVisibleDecls on " 522 "(ASTContext*){0} '{1}' for '{2}' in a NULL DeclContext", 523 m_ast_context, m_clang_ast_context->getDisplayName(), name); 524 else if (const NamedDecl *context_named_decl = 525 dyn_cast<NamedDecl>(context.m_decl_context)) 526 LLDB_LOG(log, 527 "ClangASTSource::FindExternalVisibleDecls on " 528 "(ASTContext*){0} '{1}' for '{2}' in '{3}'", 529 m_ast_context, m_clang_ast_context->getDisplayName(), name, 530 context_named_decl->getName()); 531 else 532 LLDB_LOG(log, 533 "ClangASTSource::FindExternalVisibleDecls on " 534 "(ASTContext*){0} '{1}' for '{2}' in a '{3}'", 535 m_ast_context, m_clang_ast_context->getDisplayName(), name, 536 context.m_decl_context->getDeclKindName()); 537 } 538 539 if (isa<NamespaceDecl>(context.m_decl_context)) { 540 LookupInNamespace(context); 541 } else if (isa<ObjCInterfaceDecl>(context.m_decl_context)) { 542 FindObjCPropertyAndIvarDecls(context); 543 } else if (!isa<TranslationUnitDecl>(context.m_decl_context)) { 544 // we shouldn't be getting FindExternalVisibleDecls calls for these 545 return; 546 } else { 547 CompilerDeclContext namespace_decl; 548 549 LLDB_LOG(log, " CAS::FEVD Searching the root namespace"); 550 551 FindExternalVisibleDecls(context, lldb::ModuleSP(), namespace_decl); 552 } 553 554 if (!context.m_namespace_map->empty()) { 555 if (log && log->GetVerbose()) 556 LLDB_LOG(log, " CAS::FEVD Registering namespace map {0} ({1} entries)", 557 context.m_namespace_map.get(), context.m_namespace_map->size()); 558 559 NamespaceDecl *clang_namespace_decl = 560 AddNamespace(context, context.m_namespace_map); 561 562 if (clang_namespace_decl) 563 clang_namespace_decl->setHasExternalVisibleStorage(); 564 } 565 } 566 567 clang::Sema *ClangASTSource::getSema() { 568 return m_clang_ast_context->getSema(); 569 } 570 571 bool ClangASTSource::IgnoreName(const ConstString name, 572 bool ignore_all_dollar_names) { 573 static const ConstString id_name("id"); 574 static const ConstString Class_name("Class"); 575 576 if (m_ast_context->getLangOpts().ObjC) 577 if (name == id_name || name == Class_name) 578 return true; 579 580 StringRef name_string_ref = name.GetStringRef(); 581 582 // The ClangASTSource is not responsible for finding $-names. 583 return name_string_ref.empty() || 584 (ignore_all_dollar_names && name_string_ref.startswith("$")) || 585 name_string_ref.startswith("_$"); 586 } 587 588 void ClangASTSource::FindExternalVisibleDecls( 589 NameSearchContext &context, lldb::ModuleSP module_sp, 590 CompilerDeclContext &namespace_decl) { 591 assert(m_ast_context); 592 593 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 594 595 SymbolContextList sc_list; 596 597 const ConstString name(context.m_decl_name.getAsString().c_str()); 598 if (IgnoreName(name, true)) 599 return; 600 601 if (!m_target) 602 return; 603 604 FillNamespaceMap(context, module_sp, namespace_decl); 605 606 if (context.m_found_type) 607 return; 608 609 TypeList types; 610 const bool exact_match = true; 611 llvm::DenseSet<lldb_private::SymbolFile *> searched_symbol_files; 612 if (module_sp && namespace_decl) 613 module_sp->FindTypesInNamespace(name, namespace_decl, 1, types); 614 else { 615 m_target->GetImages().FindTypes(module_sp.get(), name, exact_match, 1, 616 searched_symbol_files, types); 617 } 618 619 if (size_t num_types = types.GetSize()) { 620 for (size_t ti = 0; ti < num_types; ++ti) { 621 lldb::TypeSP type_sp = types.GetTypeAtIndex(ti); 622 623 if (log) { 624 const char *name_string = type_sp->GetName().GetCString(); 625 626 LLDB_LOG(log, " CAS::FEVD Matching type found for \"{0}\": {1}", name, 627 (name_string ? name_string : "<anonymous>")); 628 } 629 630 CompilerType full_type = type_sp->GetFullCompilerType(); 631 632 CompilerType copied_clang_type(GuardedCopyType(full_type)); 633 634 if (!copied_clang_type) { 635 LLDB_LOG(log, " CAS::FEVD - Couldn't export a type"); 636 637 continue; 638 } 639 640 context.AddTypeDecl(copied_clang_type); 641 642 context.m_found_type = true; 643 break; 644 } 645 } 646 647 if (!context.m_found_type) { 648 // Try the modules next. 649 FindDeclInModules(context, name); 650 } 651 652 if (!context.m_found_type) { 653 FindDeclInObjCRuntime(context, name); 654 } 655 } 656 657 void ClangASTSource::FillNamespaceMap( 658 NameSearchContext &context, lldb::ModuleSP module_sp, 659 const CompilerDeclContext &namespace_decl) { 660 const ConstString name(context.m_decl_name.getAsString().c_str()); 661 if (IgnoreName(name, true)) 662 return; 663 664 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 665 666 if (module_sp && namespace_decl) { 667 CompilerDeclContext found_namespace_decl; 668 669 if (SymbolFile *symbol_file = module_sp->GetSymbolFile()) { 670 found_namespace_decl = symbol_file->FindNamespace(name, namespace_decl); 671 672 if (found_namespace_decl) { 673 context.m_namespace_map->push_back( 674 std::pair<lldb::ModuleSP, CompilerDeclContext>( 675 module_sp, found_namespace_decl)); 676 677 LLDB_LOG(log, " CAS::FEVD Found namespace {0} in module {1}", name, 678 module_sp->GetFileSpec().GetFilename()); 679 } 680 } 681 return; 682 } 683 684 for (lldb::ModuleSP image : m_target->GetImages().Modules()) { 685 if (!image) 686 continue; 687 688 CompilerDeclContext found_namespace_decl; 689 690 SymbolFile *symbol_file = image->GetSymbolFile(); 691 692 if (!symbol_file) 693 continue; 694 695 found_namespace_decl = symbol_file->FindNamespace(name, namespace_decl); 696 697 if (found_namespace_decl) { 698 context.m_namespace_map->push_back( 699 std::pair<lldb::ModuleSP, CompilerDeclContext>(image, 700 found_namespace_decl)); 701 702 LLDB_LOG(log, " CAS::FEVD Found namespace {0} in module {1}", name, 703 image->GetFileSpec().GetFilename()); 704 } 705 } 706 } 707 708 template <class D> class TaggedASTDecl { 709 public: 710 TaggedASTDecl() : decl(nullptr) {} 711 TaggedASTDecl(D *_decl) : decl(_decl) {} 712 bool IsValid() const { return (decl != nullptr); } 713 bool IsInvalid() const { return !IsValid(); } 714 D *operator->() const { return decl; } 715 D *decl; 716 }; 717 718 template <class D2, template <class D> class TD, class D1> 719 TD<D2> DynCast(TD<D1> source) { 720 return TD<D2>(dyn_cast<D2>(source.decl)); 721 } 722 723 template <class D = Decl> class DeclFromParser; 724 template <class D = Decl> class DeclFromUser; 725 726 template <class D> class DeclFromParser : public TaggedASTDecl<D> { 727 public: 728 DeclFromParser() : TaggedASTDecl<D>() {} 729 DeclFromParser(D *_decl) : TaggedASTDecl<D>(_decl) {} 730 731 DeclFromUser<D> GetOrigin(ClangASTSource &source); 732 }; 733 734 template <class D> class DeclFromUser : public TaggedASTDecl<D> { 735 public: 736 DeclFromUser() : TaggedASTDecl<D>() {} 737 DeclFromUser(D *_decl) : TaggedASTDecl<D>(_decl) {} 738 739 DeclFromParser<D> Import(ClangASTSource &source); 740 }; 741 742 template <class D> 743 DeclFromUser<D> DeclFromParser<D>::GetOrigin(ClangASTSource &source) { 744 ClangASTImporter::DeclOrigin origin = source.GetDeclOrigin(this->decl); 745 if (!origin.Valid()) 746 return DeclFromUser<D>(); 747 return DeclFromUser<D>(dyn_cast<D>(origin.decl)); 748 } 749 750 template <class D> 751 DeclFromParser<D> DeclFromUser<D>::Import(ClangASTSource &source) { 752 DeclFromParser<> parser_generic_decl(source.CopyDecl(this->decl)); 753 if (parser_generic_decl.IsInvalid()) 754 return DeclFromParser<D>(); 755 return DeclFromParser<D>(dyn_cast<D>(parser_generic_decl.decl)); 756 } 757 758 bool ClangASTSource::FindObjCMethodDeclsWithOrigin( 759 NameSearchContext &context, ObjCInterfaceDecl *original_interface_decl, 760 const char *log_info) { 761 const DeclarationName &decl_name(context.m_decl_name); 762 clang::ASTContext *original_ctx = &original_interface_decl->getASTContext(); 763 764 Selector original_selector; 765 766 if (decl_name.isObjCZeroArgSelector()) { 767 IdentifierInfo *ident = &original_ctx->Idents.get(decl_name.getAsString()); 768 original_selector = original_ctx->Selectors.getSelector(0, &ident); 769 } else if (decl_name.isObjCOneArgSelector()) { 770 const std::string &decl_name_string = decl_name.getAsString(); 771 std::string decl_name_string_without_colon(decl_name_string.c_str(), 772 decl_name_string.length() - 1); 773 IdentifierInfo *ident = 774 &original_ctx->Idents.get(decl_name_string_without_colon); 775 original_selector = original_ctx->Selectors.getSelector(1, &ident); 776 } else { 777 SmallVector<IdentifierInfo *, 4> idents; 778 779 clang::Selector sel = decl_name.getObjCSelector(); 780 781 unsigned num_args = sel.getNumArgs(); 782 783 for (unsigned i = 0; i != num_args; ++i) { 784 idents.push_back(&original_ctx->Idents.get(sel.getNameForSlot(i))); 785 } 786 787 original_selector = 788 original_ctx->Selectors.getSelector(num_args, idents.data()); 789 } 790 791 DeclarationName original_decl_name(original_selector); 792 793 llvm::SmallVector<NamedDecl *, 1> methods; 794 795 TypeSystemClang::GetCompleteDecl(original_ctx, original_interface_decl); 796 797 if (ObjCMethodDecl *instance_method_decl = 798 original_interface_decl->lookupInstanceMethod(original_selector)) { 799 methods.push_back(instance_method_decl); 800 } else if (ObjCMethodDecl *class_method_decl = 801 original_interface_decl->lookupClassMethod( 802 original_selector)) { 803 methods.push_back(class_method_decl); 804 } 805 806 if (methods.empty()) { 807 return false; 808 } 809 810 for (NamedDecl *named_decl : methods) { 811 if (!named_decl) 812 continue; 813 814 ObjCMethodDecl *result_method = dyn_cast<ObjCMethodDecl>(named_decl); 815 816 if (!result_method) 817 continue; 818 819 Decl *copied_decl = CopyDecl(result_method); 820 821 if (!copied_decl) 822 continue; 823 824 ObjCMethodDecl *copied_method_decl = dyn_cast<ObjCMethodDecl>(copied_decl); 825 826 if (!copied_method_decl) 827 continue; 828 829 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 830 831 LLDB_LOG(log, " CAS::FOMD found ({0}) {1}", log_info, 832 ClangUtil::DumpDecl(copied_method_decl)); 833 834 context.AddNamedDecl(copied_method_decl); 835 } 836 837 return true; 838 } 839 840 void ClangASTSource::FindDeclInModules(NameSearchContext &context, 841 ConstString name) { 842 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 843 844 std::shared_ptr<ClangModulesDeclVendor> modules_decl_vendor = 845 GetClangModulesDeclVendor(); 846 if (!modules_decl_vendor) 847 return; 848 849 bool append = false; 850 uint32_t max_matches = 1; 851 std::vector<clang::NamedDecl *> decls; 852 853 if (!modules_decl_vendor->FindDecls(name, append, max_matches, decls)) 854 return; 855 856 LLDB_LOG(log, " CAS::FEVD Matching entity found for \"{0}\" in the modules", 857 name); 858 859 clang::NamedDecl *const decl_from_modules = decls[0]; 860 861 if (llvm::isa<clang::TypeDecl>(decl_from_modules) || 862 llvm::isa<clang::ObjCContainerDecl>(decl_from_modules) || 863 llvm::isa<clang::EnumConstantDecl>(decl_from_modules)) { 864 clang::Decl *copied_decl = CopyDecl(decl_from_modules); 865 clang::NamedDecl *copied_named_decl = 866 copied_decl ? dyn_cast<clang::NamedDecl>(copied_decl) : nullptr; 867 868 if (!copied_named_decl) { 869 LLDB_LOG(log, " CAS::FEVD - Couldn't export a type from the modules"); 870 871 return; 872 } 873 874 context.AddNamedDecl(copied_named_decl); 875 876 context.m_found_type = true; 877 } 878 } 879 880 void ClangASTSource::FindDeclInObjCRuntime(NameSearchContext &context, 881 ConstString name) { 882 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 883 884 lldb::ProcessSP process(m_target->GetProcessSP()); 885 886 if (!process) 887 return; 888 889 ObjCLanguageRuntime *language_runtime(ObjCLanguageRuntime::Get(*process)); 890 891 if (!language_runtime) 892 return; 893 894 DeclVendor *decl_vendor = language_runtime->GetDeclVendor(); 895 896 if (!decl_vendor) 897 return; 898 899 bool append = false; 900 uint32_t max_matches = 1; 901 std::vector<clang::NamedDecl *> decls; 902 903 auto *clang_decl_vendor = llvm::cast<ClangDeclVendor>(decl_vendor); 904 if (!clang_decl_vendor->FindDecls(name, append, max_matches, decls)) 905 return; 906 907 LLDB_LOG(log, " CAS::FEVD Matching type found for \"{0}\" in the runtime", 908 name); 909 910 clang::Decl *copied_decl = CopyDecl(decls[0]); 911 clang::NamedDecl *copied_named_decl = 912 copied_decl ? dyn_cast<clang::NamedDecl>(copied_decl) : nullptr; 913 914 if (!copied_named_decl) { 915 LLDB_LOG(log, " CAS::FEVD - Couldn't export a type from the runtime"); 916 917 return; 918 } 919 920 context.AddNamedDecl(copied_named_decl); 921 } 922 923 void ClangASTSource::FindObjCMethodDecls(NameSearchContext &context) { 924 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 925 926 const DeclarationName &decl_name(context.m_decl_name); 927 const DeclContext *decl_ctx(context.m_decl_context); 928 929 const ObjCInterfaceDecl *interface_decl = 930 dyn_cast<ObjCInterfaceDecl>(decl_ctx); 931 932 if (!interface_decl) 933 return; 934 935 do { 936 ClangASTImporter::DeclOrigin original = m_ast_importer_sp->GetDeclOrigin(interface_decl); 937 938 if (!original.Valid()) 939 break; 940 941 ObjCInterfaceDecl *original_interface_decl = 942 dyn_cast<ObjCInterfaceDecl>(original.decl); 943 944 if (FindObjCMethodDeclsWithOrigin(context, original_interface_decl, 945 "at origin")) 946 return; // found it, no need to look any further 947 } while (false); 948 949 StreamString ss; 950 951 if (decl_name.isObjCZeroArgSelector()) { 952 ss.Printf("%s", decl_name.getAsString().c_str()); 953 } else if (decl_name.isObjCOneArgSelector()) { 954 ss.Printf("%s", decl_name.getAsString().c_str()); 955 } else { 956 clang::Selector sel = decl_name.getObjCSelector(); 957 958 for (unsigned i = 0, e = sel.getNumArgs(); i != e; ++i) { 959 llvm::StringRef r = sel.getNameForSlot(i); 960 ss.Printf("%s:", r.str().c_str()); 961 } 962 } 963 ss.Flush(); 964 965 if (ss.GetString().contains("$__lldb")) 966 return; // we don't need any results 967 968 ConstString selector_name(ss.GetString()); 969 970 LLDB_LOG(log, 971 "ClangASTSource::FindObjCMethodDecls on (ASTContext*){0} '{1}' " 972 "for selector [{2} {3}]", 973 m_ast_context, m_clang_ast_context->getDisplayName(), 974 interface_decl->getName(), selector_name); 975 SymbolContextList sc_list; 976 977 const bool include_symbols = false; 978 const bool include_inlines = false; 979 980 std::string interface_name = interface_decl->getNameAsString(); 981 982 do { 983 StreamString ms; 984 ms.Printf("-[%s %s]", interface_name.c_str(), selector_name.AsCString()); 985 ms.Flush(); 986 ConstString instance_method_name(ms.GetString()); 987 988 sc_list.Clear(); 989 m_target->GetImages().FindFunctions( 990 instance_method_name, lldb::eFunctionNameTypeFull, include_symbols, 991 include_inlines, sc_list); 992 993 if (sc_list.GetSize()) 994 break; 995 996 ms.Clear(); 997 ms.Printf("+[%s %s]", interface_name.c_str(), selector_name.AsCString()); 998 ms.Flush(); 999 ConstString class_method_name(ms.GetString()); 1000 1001 sc_list.Clear(); 1002 m_target->GetImages().FindFunctions( 1003 class_method_name, lldb::eFunctionNameTypeFull, include_symbols, 1004 include_inlines, sc_list); 1005 1006 if (sc_list.GetSize()) 1007 break; 1008 1009 // Fall back and check for methods in categories. If we find methods this 1010 // way, we need to check that they're actually in categories on the desired 1011 // class. 1012 1013 SymbolContextList candidate_sc_list; 1014 1015 m_target->GetImages().FindFunctions( 1016 selector_name, lldb::eFunctionNameTypeSelector, include_symbols, 1017 include_inlines, candidate_sc_list); 1018 1019 for (uint32_t ci = 0, ce = candidate_sc_list.GetSize(); ci != ce; ++ci) { 1020 SymbolContext candidate_sc; 1021 1022 if (!candidate_sc_list.GetContextAtIndex(ci, candidate_sc)) 1023 continue; 1024 1025 if (!candidate_sc.function) 1026 continue; 1027 1028 const char *candidate_name = candidate_sc.function->GetName().AsCString(); 1029 1030 const char *cursor = candidate_name; 1031 1032 if (*cursor != '+' && *cursor != '-') 1033 continue; 1034 1035 ++cursor; 1036 1037 if (*cursor != '[') 1038 continue; 1039 1040 ++cursor; 1041 1042 size_t interface_len = interface_name.length(); 1043 1044 if (strncmp(cursor, interface_name.c_str(), interface_len)) 1045 continue; 1046 1047 cursor += interface_len; 1048 1049 if (*cursor == ' ' || *cursor == '(') 1050 sc_list.Append(candidate_sc); 1051 } 1052 } while (false); 1053 1054 if (sc_list.GetSize()) { 1055 // We found a good function symbol. Use that. 1056 1057 for (uint32_t i = 0, e = sc_list.GetSize(); i != e; ++i) { 1058 SymbolContext sc; 1059 1060 if (!sc_list.GetContextAtIndex(i, sc)) 1061 continue; 1062 1063 if (!sc.function) 1064 continue; 1065 1066 CompilerDeclContext function_decl_ctx = sc.function->GetDeclContext(); 1067 if (!function_decl_ctx) 1068 continue; 1069 1070 ObjCMethodDecl *method_decl = 1071 TypeSystemClang::DeclContextGetAsObjCMethodDecl(function_decl_ctx); 1072 1073 if (!method_decl) 1074 continue; 1075 1076 ObjCInterfaceDecl *found_interface_decl = 1077 method_decl->getClassInterface(); 1078 1079 if (!found_interface_decl) 1080 continue; 1081 1082 if (found_interface_decl->getName() == interface_decl->getName()) { 1083 Decl *copied_decl = CopyDecl(method_decl); 1084 1085 if (!copied_decl) 1086 continue; 1087 1088 ObjCMethodDecl *copied_method_decl = 1089 dyn_cast<ObjCMethodDecl>(copied_decl); 1090 1091 if (!copied_method_decl) 1092 continue; 1093 1094 LLDB_LOG(log, " CAS::FOMD found (in symbols)\n{0}", 1095 ClangUtil::DumpDecl(copied_method_decl)); 1096 1097 context.AddNamedDecl(copied_method_decl); 1098 } 1099 } 1100 1101 return; 1102 } 1103 1104 // Try the debug information. 1105 1106 do { 1107 ObjCInterfaceDecl *complete_interface_decl = GetCompleteObjCInterface( 1108 const_cast<ObjCInterfaceDecl *>(interface_decl)); 1109 1110 if (!complete_interface_decl) 1111 break; 1112 1113 // We found the complete interface. The runtime never needs to be queried 1114 // in this scenario. 1115 1116 DeclFromUser<const ObjCInterfaceDecl> complete_iface_decl( 1117 complete_interface_decl); 1118 1119 if (complete_interface_decl == interface_decl) 1120 break; // already checked this one 1121 1122 LLDB_LOG(log, 1123 "CAS::FOPD trying origin " 1124 "(ObjCInterfaceDecl*){0}/(ASTContext*){1}...", 1125 complete_interface_decl, &complete_iface_decl->getASTContext()); 1126 1127 FindObjCMethodDeclsWithOrigin(context, complete_interface_decl, 1128 "in debug info"); 1129 1130 return; 1131 } while (false); 1132 1133 do { 1134 // Check the modules only if the debug information didn't have a complete 1135 // interface. 1136 1137 if (std::shared_ptr<ClangModulesDeclVendor> modules_decl_vendor = 1138 GetClangModulesDeclVendor()) { 1139 ConstString interface_name(interface_decl->getNameAsString().c_str()); 1140 bool append = false; 1141 uint32_t max_matches = 1; 1142 std::vector<clang::NamedDecl *> decls; 1143 1144 if (!modules_decl_vendor->FindDecls(interface_name, append, max_matches, 1145 decls)) 1146 break; 1147 1148 ObjCInterfaceDecl *interface_decl_from_modules = 1149 dyn_cast<ObjCInterfaceDecl>(decls[0]); 1150 1151 if (!interface_decl_from_modules) 1152 break; 1153 1154 if (FindObjCMethodDeclsWithOrigin(context, interface_decl_from_modules, 1155 "in modules")) 1156 return; 1157 } 1158 } while (false); 1159 1160 do { 1161 // Check the runtime only if the debug information didn't have a complete 1162 // interface and the modules don't get us anywhere. 1163 1164 lldb::ProcessSP process(m_target->GetProcessSP()); 1165 1166 if (!process) 1167 break; 1168 1169 ObjCLanguageRuntime *language_runtime(ObjCLanguageRuntime::Get(*process)); 1170 1171 if (!language_runtime) 1172 break; 1173 1174 DeclVendor *decl_vendor = language_runtime->GetDeclVendor(); 1175 1176 if (!decl_vendor) 1177 break; 1178 1179 ConstString interface_name(interface_decl->getNameAsString().c_str()); 1180 bool append = false; 1181 uint32_t max_matches = 1; 1182 std::vector<clang::NamedDecl *> decls; 1183 1184 auto *clang_decl_vendor = llvm::cast<ClangDeclVendor>(decl_vendor); 1185 if (!clang_decl_vendor->FindDecls(interface_name, append, max_matches, 1186 decls)) 1187 break; 1188 1189 ObjCInterfaceDecl *runtime_interface_decl = 1190 dyn_cast<ObjCInterfaceDecl>(decls[0]); 1191 1192 if (!runtime_interface_decl) 1193 break; 1194 1195 FindObjCMethodDeclsWithOrigin(context, runtime_interface_decl, 1196 "in runtime"); 1197 } while (false); 1198 } 1199 1200 static bool FindObjCPropertyAndIvarDeclsWithOrigin( 1201 NameSearchContext &context, ClangASTSource &source, 1202 DeclFromUser<const ObjCInterfaceDecl> &origin_iface_decl) { 1203 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 1204 1205 if (origin_iface_decl.IsInvalid()) 1206 return false; 1207 1208 std::string name_str = context.m_decl_name.getAsString(); 1209 StringRef name(name_str); 1210 IdentifierInfo &name_identifier( 1211 origin_iface_decl->getASTContext().Idents.get(name)); 1212 1213 DeclFromUser<ObjCPropertyDecl> origin_property_decl( 1214 origin_iface_decl->FindPropertyDeclaration( 1215 &name_identifier, ObjCPropertyQueryKind::OBJC_PR_query_instance)); 1216 1217 bool found = false; 1218 1219 if (origin_property_decl.IsValid()) { 1220 DeclFromParser<ObjCPropertyDecl> parser_property_decl( 1221 origin_property_decl.Import(source)); 1222 if (parser_property_decl.IsValid()) { 1223 LLDB_LOG(log, " CAS::FOPD found\n{0}", 1224 ClangUtil::DumpDecl(parser_property_decl.decl)); 1225 1226 context.AddNamedDecl(parser_property_decl.decl); 1227 found = true; 1228 } 1229 } 1230 1231 DeclFromUser<ObjCIvarDecl> origin_ivar_decl( 1232 origin_iface_decl->getIvarDecl(&name_identifier)); 1233 1234 if (origin_ivar_decl.IsValid()) { 1235 DeclFromParser<ObjCIvarDecl> parser_ivar_decl( 1236 origin_ivar_decl.Import(source)); 1237 if (parser_ivar_decl.IsValid()) { 1238 LLDB_LOG(log, " CAS::FOPD found\n{0}", 1239 ClangUtil::DumpDecl(parser_ivar_decl.decl)); 1240 1241 context.AddNamedDecl(parser_ivar_decl.decl); 1242 found = true; 1243 } 1244 } 1245 1246 return found; 1247 } 1248 1249 void ClangASTSource::FindObjCPropertyAndIvarDecls(NameSearchContext &context) { 1250 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 1251 1252 DeclFromParser<const ObjCInterfaceDecl> parser_iface_decl( 1253 cast<ObjCInterfaceDecl>(context.m_decl_context)); 1254 DeclFromUser<const ObjCInterfaceDecl> origin_iface_decl( 1255 parser_iface_decl.GetOrigin(*this)); 1256 1257 ConstString class_name(parser_iface_decl->getNameAsString().c_str()); 1258 1259 LLDB_LOG(log, 1260 "ClangASTSource::FindObjCPropertyAndIvarDecls on " 1261 "(ASTContext*){0} '{1}' for '{2}.{3}'", 1262 m_ast_context, m_clang_ast_context->getDisplayName(), 1263 parser_iface_decl->getName(), context.m_decl_name.getAsString()); 1264 1265 if (FindObjCPropertyAndIvarDeclsWithOrigin(context, *this, origin_iface_decl)) 1266 return; 1267 1268 LLDB_LOG(log, 1269 "CAS::FOPD couldn't find the property on origin " 1270 "(ObjCInterfaceDecl*){0}/(ASTContext*){1}, searching " 1271 "elsewhere...", 1272 origin_iface_decl.decl, &origin_iface_decl->getASTContext()); 1273 1274 SymbolContext null_sc; 1275 TypeList type_list; 1276 1277 do { 1278 ObjCInterfaceDecl *complete_interface_decl = GetCompleteObjCInterface( 1279 const_cast<ObjCInterfaceDecl *>(parser_iface_decl.decl)); 1280 1281 if (!complete_interface_decl) 1282 break; 1283 1284 // We found the complete interface. The runtime never needs to be queried 1285 // in this scenario. 1286 1287 DeclFromUser<const ObjCInterfaceDecl> complete_iface_decl( 1288 complete_interface_decl); 1289 1290 if (complete_iface_decl.decl == origin_iface_decl.decl) 1291 break; // already checked this one 1292 1293 LLDB_LOG(log, 1294 "CAS::FOPD trying origin " 1295 "(ObjCInterfaceDecl*){0}/(ASTContext*){1}...", 1296 complete_iface_decl.decl, &complete_iface_decl->getASTContext()); 1297 1298 FindObjCPropertyAndIvarDeclsWithOrigin(context, *this, complete_iface_decl); 1299 1300 return; 1301 } while (false); 1302 1303 do { 1304 // Check the modules only if the debug information didn't have a complete 1305 // interface. 1306 1307 std::shared_ptr<ClangModulesDeclVendor> modules_decl_vendor = 1308 GetClangModulesDeclVendor(); 1309 1310 if (!modules_decl_vendor) 1311 break; 1312 1313 bool append = false; 1314 uint32_t max_matches = 1; 1315 std::vector<clang::NamedDecl *> decls; 1316 1317 if (!modules_decl_vendor->FindDecls(class_name, append, max_matches, decls)) 1318 break; 1319 1320 DeclFromUser<const ObjCInterfaceDecl> interface_decl_from_modules( 1321 dyn_cast<ObjCInterfaceDecl>(decls[0])); 1322 1323 if (!interface_decl_from_modules.IsValid()) 1324 break; 1325 1326 LLDB_LOG(log, 1327 "CAS::FOPD[{0}] trying module " 1328 "(ObjCInterfaceDecl*){0}/(ASTContext*){1}...", 1329 interface_decl_from_modules.decl, 1330 &interface_decl_from_modules->getASTContext()); 1331 1332 if (FindObjCPropertyAndIvarDeclsWithOrigin(context, *this, 1333 interface_decl_from_modules)) 1334 return; 1335 } while (false); 1336 1337 do { 1338 // Check the runtime only if the debug information didn't have a complete 1339 // interface and nothing was in the modules. 1340 1341 lldb::ProcessSP process(m_target->GetProcessSP()); 1342 1343 if (!process) 1344 return; 1345 1346 ObjCLanguageRuntime *language_runtime(ObjCLanguageRuntime::Get(*process)); 1347 1348 if (!language_runtime) 1349 return; 1350 1351 DeclVendor *decl_vendor = language_runtime->GetDeclVendor(); 1352 1353 if (!decl_vendor) 1354 break; 1355 1356 bool append = false; 1357 uint32_t max_matches = 1; 1358 std::vector<clang::NamedDecl *> decls; 1359 1360 auto *clang_decl_vendor = llvm::cast<ClangDeclVendor>(decl_vendor); 1361 if (!clang_decl_vendor->FindDecls(class_name, append, max_matches, decls)) 1362 break; 1363 1364 DeclFromUser<const ObjCInterfaceDecl> interface_decl_from_runtime( 1365 dyn_cast<ObjCInterfaceDecl>(decls[0])); 1366 1367 if (!interface_decl_from_runtime.IsValid()) 1368 break; 1369 1370 LLDB_LOG(log, 1371 "CAS::FOPD[{0}] trying runtime " 1372 "(ObjCInterfaceDecl*){0}/(ASTContext*){1}...", 1373 interface_decl_from_runtime.decl, 1374 &interface_decl_from_runtime->getASTContext()); 1375 1376 if (FindObjCPropertyAndIvarDeclsWithOrigin(context, *this, 1377 interface_decl_from_runtime)) 1378 return; 1379 } while (false); 1380 } 1381 1382 void ClangASTSource::LookupInNamespace(NameSearchContext &context) { 1383 const NamespaceDecl *namespace_context = 1384 dyn_cast<NamespaceDecl>(context.m_decl_context); 1385 1386 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 1387 1388 ClangASTImporter::NamespaceMapSP namespace_map = 1389 m_ast_importer_sp->GetNamespaceMap(namespace_context); 1390 1391 LLDB_LOGV(log, " CAS::FEVD Inspecting namespace map {0} ({1} entries)", 1392 namespace_map.get(), namespace_map->size()); 1393 1394 if (!namespace_map) 1395 return; 1396 1397 for (ClangASTImporter::NamespaceMap::iterator i = namespace_map->begin(), 1398 e = namespace_map->end(); 1399 i != e; ++i) { 1400 LLDB_LOG(log, " CAS::FEVD Searching namespace {0} in module {1}", 1401 i->second.GetName(), i->first->GetFileSpec().GetFilename()); 1402 1403 FindExternalVisibleDecls(context, i->first, i->second); 1404 } 1405 } 1406 1407 typedef llvm::DenseMap<const FieldDecl *, uint64_t> FieldOffsetMap; 1408 typedef llvm::DenseMap<const CXXRecordDecl *, CharUnits> BaseOffsetMap; 1409 1410 template <class D, class O> 1411 static bool ImportOffsetMap(llvm::DenseMap<const D *, O> &destination_map, 1412 llvm::DenseMap<const D *, O> &source_map, 1413 ClangASTSource &source) { 1414 // When importing fields into a new record, clang has a hard requirement that 1415 // fields be imported in field offset order. Since they are stored in a 1416 // DenseMap with a pointer as the key type, this means we cannot simply 1417 // iterate over the map, as the order will be non-deterministic. Instead we 1418 // have to sort by the offset and then insert in sorted order. 1419 typedef llvm::DenseMap<const D *, O> MapType; 1420 typedef typename MapType::value_type PairType; 1421 std::vector<PairType> sorted_items; 1422 sorted_items.reserve(source_map.size()); 1423 sorted_items.assign(source_map.begin(), source_map.end()); 1424 llvm::sort(sorted_items.begin(), sorted_items.end(), 1425 [](const PairType &lhs, const PairType &rhs) { 1426 return lhs.second < rhs.second; 1427 }); 1428 1429 for (const auto &item : sorted_items) { 1430 DeclFromUser<D> user_decl(const_cast<D *>(item.first)); 1431 DeclFromParser<D> parser_decl(user_decl.Import(source)); 1432 if (parser_decl.IsInvalid()) 1433 return false; 1434 destination_map.insert( 1435 std::pair<const D *, O>(parser_decl.decl, item.second)); 1436 } 1437 1438 return true; 1439 } 1440 1441 template <bool IsVirtual> 1442 bool ExtractBaseOffsets(const ASTRecordLayout &record_layout, 1443 DeclFromUser<const CXXRecordDecl> &record, 1444 BaseOffsetMap &base_offsets) { 1445 for (CXXRecordDecl::base_class_const_iterator 1446 bi = (IsVirtual ? record->vbases_begin() : record->bases_begin()), 1447 be = (IsVirtual ? record->vbases_end() : record->bases_end()); 1448 bi != be; ++bi) { 1449 if (!IsVirtual && bi->isVirtual()) 1450 continue; 1451 1452 const clang::Type *origin_base_type = bi->getType().getTypePtr(); 1453 const clang::RecordType *origin_base_record_type = 1454 origin_base_type->getAs<RecordType>(); 1455 1456 if (!origin_base_record_type) 1457 return false; 1458 1459 DeclFromUser<RecordDecl> origin_base_record( 1460 origin_base_record_type->getDecl()); 1461 1462 if (origin_base_record.IsInvalid()) 1463 return false; 1464 1465 DeclFromUser<CXXRecordDecl> origin_base_cxx_record( 1466 DynCast<CXXRecordDecl>(origin_base_record)); 1467 1468 if (origin_base_cxx_record.IsInvalid()) 1469 return false; 1470 1471 CharUnits base_offset; 1472 1473 if (IsVirtual) 1474 base_offset = 1475 record_layout.getVBaseClassOffset(origin_base_cxx_record.decl); 1476 else 1477 base_offset = 1478 record_layout.getBaseClassOffset(origin_base_cxx_record.decl); 1479 1480 base_offsets.insert(std::pair<const CXXRecordDecl *, CharUnits>( 1481 origin_base_cxx_record.decl, base_offset)); 1482 } 1483 1484 return true; 1485 } 1486 1487 bool ClangASTSource::layoutRecordType(const RecordDecl *record, uint64_t &size, 1488 uint64_t &alignment, 1489 FieldOffsetMap &field_offsets, 1490 BaseOffsetMap &base_offsets, 1491 BaseOffsetMap &virtual_base_offsets) { 1492 1493 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 1494 1495 LLDB_LOG(log, 1496 "LayoutRecordType on (ASTContext*){0} '{1}' for (RecordDecl*)" 1497 "{3} [name = '{4}']", 1498 m_ast_context, m_clang_ast_context->getDisplayName(), record, 1499 record->getName()); 1500 1501 DeclFromParser<const RecordDecl> parser_record(record); 1502 DeclFromUser<const RecordDecl> origin_record( 1503 parser_record.GetOrigin(*this)); 1504 1505 if (origin_record.IsInvalid()) 1506 return false; 1507 1508 FieldOffsetMap origin_field_offsets; 1509 BaseOffsetMap origin_base_offsets; 1510 BaseOffsetMap origin_virtual_base_offsets; 1511 1512 TypeSystemClang::GetCompleteDecl( 1513 &origin_record->getASTContext(), 1514 const_cast<RecordDecl *>(origin_record.decl)); 1515 1516 clang::RecordDecl *definition = origin_record.decl->getDefinition(); 1517 if (!definition || !definition->isCompleteDefinition()) 1518 return false; 1519 1520 const ASTRecordLayout &record_layout( 1521 origin_record->getASTContext().getASTRecordLayout(origin_record.decl)); 1522 1523 int field_idx = 0, field_count = record_layout.getFieldCount(); 1524 1525 for (RecordDecl::field_iterator fi = origin_record->field_begin(), 1526 fe = origin_record->field_end(); 1527 fi != fe; ++fi) { 1528 if (field_idx >= field_count) 1529 return false; // Layout didn't go well. Bail out. 1530 1531 uint64_t field_offset = record_layout.getFieldOffset(field_idx); 1532 1533 origin_field_offsets.insert( 1534 std::pair<const FieldDecl *, uint64_t>(*fi, field_offset)); 1535 1536 field_idx++; 1537 } 1538 1539 lldbassert(&record->getASTContext() == m_ast_context); 1540 1541 DeclFromUser<const CXXRecordDecl> origin_cxx_record( 1542 DynCast<const CXXRecordDecl>(origin_record)); 1543 1544 if (origin_cxx_record.IsValid()) { 1545 if (!ExtractBaseOffsets<false>(record_layout, origin_cxx_record, 1546 origin_base_offsets) || 1547 !ExtractBaseOffsets<true>(record_layout, origin_cxx_record, 1548 origin_virtual_base_offsets)) 1549 return false; 1550 } 1551 1552 if (!ImportOffsetMap(field_offsets, origin_field_offsets, *this) || 1553 !ImportOffsetMap(base_offsets, origin_base_offsets, *this) || 1554 !ImportOffsetMap(virtual_base_offsets, origin_virtual_base_offsets, 1555 *this)) 1556 return false; 1557 1558 size = record_layout.getSize().getQuantity() * m_ast_context->getCharWidth(); 1559 alignment = record_layout.getAlignment().getQuantity() * 1560 m_ast_context->getCharWidth(); 1561 1562 if (log) { 1563 LLDB_LOG(log, "LRT returned:"); 1564 LLDB_LOG(log, "LRT Original = (RecordDecl*){0}", 1565 static_cast<const void *>(origin_record.decl)); 1566 LLDB_LOG(log, "LRT Size = {0}", size); 1567 LLDB_LOG(log, "LRT Alignment = {0}", alignment); 1568 LLDB_LOG(log, "LRT Fields:"); 1569 for (RecordDecl::field_iterator fi = record->field_begin(), 1570 fe = record->field_end(); 1571 fi != fe; ++fi) { 1572 LLDB_LOG(log, 1573 "LRT (FieldDecl*){0}, Name = '{1}', Offset = {2} bits", 1574 *fi, fi->getName(), field_offsets[*fi]); 1575 } 1576 DeclFromParser<const CXXRecordDecl> parser_cxx_record = 1577 DynCast<const CXXRecordDecl>(parser_record); 1578 if (parser_cxx_record.IsValid()) { 1579 LLDB_LOG(log, "LRT Bases:"); 1580 for (CXXRecordDecl::base_class_const_iterator 1581 bi = parser_cxx_record->bases_begin(), 1582 be = parser_cxx_record->bases_end(); 1583 bi != be; ++bi) { 1584 bool is_virtual = bi->isVirtual(); 1585 1586 QualType base_type = bi->getType(); 1587 const RecordType *base_record_type = base_type->getAs<RecordType>(); 1588 DeclFromParser<RecordDecl> base_record(base_record_type->getDecl()); 1589 DeclFromParser<CXXRecordDecl> base_cxx_record = 1590 DynCast<CXXRecordDecl>(base_record); 1591 1592 LLDB_LOG(log, 1593 "LRT {0}(CXXRecordDecl*){1}, Name = '{2}', Offset = " 1594 "{3} chars", 1595 (is_virtual ? "Virtual " : ""), base_cxx_record.decl, 1596 base_cxx_record.decl->getName(), 1597 (is_virtual 1598 ? virtual_base_offsets[base_cxx_record.decl].getQuantity() 1599 : base_offsets[base_cxx_record.decl].getQuantity())); 1600 } 1601 } else { 1602 LLDB_LOG(log, "LRD Not a CXXRecord, so no bases"); 1603 } 1604 } 1605 1606 return true; 1607 } 1608 1609 void ClangASTSource::CompleteNamespaceMap( 1610 ClangASTImporter::NamespaceMapSP &namespace_map, ConstString name, 1611 ClangASTImporter::NamespaceMapSP &parent_map) const { 1612 1613 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 1614 1615 if (log) { 1616 if (parent_map && parent_map->size()) 1617 LLDB_LOG(log, 1618 "CompleteNamespaceMap on (ASTContext*){0} '{1}' Searching " 1619 "for namespace {2} in namespace {3}", 1620 m_ast_context, m_clang_ast_context->getDisplayName(), name, 1621 parent_map->begin()->second.GetName()); 1622 else 1623 LLDB_LOG(log, 1624 "CompleteNamespaceMap on (ASTContext*){0} '{1}' Searching " 1625 "for namespace {2}", 1626 m_ast_context, m_clang_ast_context->getDisplayName(), name); 1627 } 1628 1629 if (parent_map) { 1630 for (ClangASTImporter::NamespaceMap::iterator i = parent_map->begin(), 1631 e = parent_map->end(); 1632 i != e; ++i) { 1633 CompilerDeclContext found_namespace_decl; 1634 1635 lldb::ModuleSP module_sp = i->first; 1636 CompilerDeclContext module_parent_namespace_decl = i->second; 1637 1638 SymbolFile *symbol_file = module_sp->GetSymbolFile(); 1639 1640 if (!symbol_file) 1641 continue; 1642 1643 found_namespace_decl = 1644 symbol_file->FindNamespace(name, module_parent_namespace_decl); 1645 1646 if (!found_namespace_decl) 1647 continue; 1648 1649 namespace_map->push_back(std::pair<lldb::ModuleSP, CompilerDeclContext>( 1650 module_sp, found_namespace_decl)); 1651 1652 LLDB_LOG(log, " CMN Found namespace {0} in module {1}", name, 1653 module_sp->GetFileSpec().GetFilename()); 1654 } 1655 } else { 1656 CompilerDeclContext null_namespace_decl; 1657 for (lldb::ModuleSP image : m_target->GetImages().Modules()) { 1658 if (!image) 1659 continue; 1660 1661 CompilerDeclContext found_namespace_decl; 1662 1663 SymbolFile *symbol_file = image->GetSymbolFile(); 1664 1665 if (!symbol_file) 1666 continue; 1667 1668 found_namespace_decl = 1669 symbol_file->FindNamespace(name, null_namespace_decl); 1670 1671 if (!found_namespace_decl) 1672 continue; 1673 1674 namespace_map->push_back(std::pair<lldb::ModuleSP, CompilerDeclContext>( 1675 image, found_namespace_decl)); 1676 1677 LLDB_LOG(log, " CMN[{0}] Found namespace {0} in module {1}", name, 1678 image->GetFileSpec().GetFilename()); 1679 } 1680 } 1681 } 1682 1683 NamespaceDecl *ClangASTSource::AddNamespace( 1684 NameSearchContext &context, 1685 ClangASTImporter::NamespaceMapSP &namespace_decls) { 1686 if (!namespace_decls) 1687 return nullptr; 1688 1689 const CompilerDeclContext &namespace_decl = namespace_decls->begin()->second; 1690 1691 clang::ASTContext *src_ast = 1692 TypeSystemClang::DeclContextGetTypeSystemClang(namespace_decl); 1693 if (!src_ast) 1694 return nullptr; 1695 clang::NamespaceDecl *src_namespace_decl = 1696 TypeSystemClang::DeclContextGetAsNamespaceDecl(namespace_decl); 1697 1698 if (!src_namespace_decl) 1699 return nullptr; 1700 1701 Decl *copied_decl = CopyDecl(src_namespace_decl); 1702 1703 if (!copied_decl) 1704 return nullptr; 1705 1706 NamespaceDecl *copied_namespace_decl = dyn_cast<NamespaceDecl>(copied_decl); 1707 1708 if (!copied_namespace_decl) 1709 return nullptr; 1710 1711 context.m_decls.push_back(copied_namespace_decl); 1712 1713 m_ast_importer_sp->RegisterNamespaceMap(copied_namespace_decl, 1714 namespace_decls); 1715 1716 return dyn_cast<NamespaceDecl>(copied_decl); 1717 } 1718 1719 clang::Decl *ClangASTSource::CopyDecl(Decl *src_decl) { 1720 return m_ast_importer_sp->CopyDecl(m_ast_context, src_decl); 1721 } 1722 1723 ClangASTImporter::DeclOrigin ClangASTSource::GetDeclOrigin(const clang::Decl *decl) { 1724 return m_ast_importer_sp->GetDeclOrigin(decl); 1725 } 1726 1727 CompilerType ClangASTSource::GuardedCopyType(const CompilerType &src_type) { 1728 TypeSystemClang *src_ast = 1729 llvm::dyn_cast_or_null<TypeSystemClang>(src_type.GetTypeSystem()); 1730 if (src_ast == nullptr) 1731 return CompilerType(); 1732 1733 QualType copied_qual_type = ClangUtil::GetQualType( 1734 m_ast_importer_sp->CopyType(*m_clang_ast_context, src_type)); 1735 1736 if (copied_qual_type.getAsOpaquePtr() && 1737 copied_qual_type->getCanonicalTypeInternal().isNull()) 1738 // this shouldn't happen, but we're hardening because the AST importer 1739 // seems to be generating bad types on occasion. 1740 return CompilerType(); 1741 1742 return m_clang_ast_context->GetType(copied_qual_type); 1743 } 1744 1745 std::shared_ptr<ClangModulesDeclVendor> 1746 ClangASTSource::GetClangModulesDeclVendor() { 1747 auto persistent_vars = llvm::cast<ClangPersistentVariables>( 1748 m_target->GetPersistentExpressionStateForLanguage(lldb::eLanguageTypeC)); 1749 return persistent_vars->GetClangModulesDeclVendor(); 1750 } 1751