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 Decl *copied_decl = CopyDecl(decl); 483 484 if (!copied_decl) 485 continue; 486 487 // FIXME: We should add the copied decl to the 'decls' list. This would 488 // add the copied Decl into the DeclContext and make sure that we 489 // correctly propagate that we added some Decls back to Clang. 490 // By leaving 'decls' empty we incorrectly return false from 491 // DeclContext::LoadLexicalDeclsFromExternalStorage which might cause 492 // lookup issues later on. 493 // We can't just add them for now as the ASTImporter already added the 494 // decl into the DeclContext and this would add it twice. 495 496 if (FieldDecl *copied_field = dyn_cast<FieldDecl>(copied_decl)) { 497 QualType copied_field_type = copied_field->getType(); 498 499 m_ast_importer_sp->RequireCompleteType(copied_field_type); 500 } 501 } else { 502 SkippedDecls = true; 503 } 504 } 505 506 // CopyDecl may build a lookup table which may set up ExternalLexicalStorage 507 // to false. However, since we skipped some of the external Decls we must 508 // set it back! 509 if (SkippedDecls) { 510 decl_context->setHasExternalLexicalStorage(true); 511 // This sets HasLazyExternalLexicalLookups to true. By setting this bit we 512 // ensure that the lookup table is rebuilt, which means the external source 513 // is consulted again when a clang::DeclContext::lookup is called. 514 const_cast<DeclContext *>(decl_context)->setMustBuildLookupTable(); 515 } 516 517 return; 518 } 519 520 void ClangASTSource::FindExternalVisibleDecls(NameSearchContext &context) { 521 assert(m_ast_context); 522 523 const ConstString name(context.m_decl_name.getAsString().c_str()); 524 525 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 526 527 if (log) { 528 if (!context.m_decl_context) 529 LLDB_LOG(log, 530 "ClangASTSource::FindExternalVisibleDecls on " 531 "(ASTContext*){0} '{1}' for '{2}' in a NULL DeclContext", 532 m_ast_context, m_clang_ast_context->getDisplayName(), name); 533 else if (const NamedDecl *context_named_decl = 534 dyn_cast<NamedDecl>(context.m_decl_context)) 535 LLDB_LOG(log, 536 "ClangASTSource::FindExternalVisibleDecls on " 537 "(ASTContext*){0} '{1}' for '{2}' in '{3}'", 538 m_ast_context, m_clang_ast_context->getDisplayName(), name, 539 context_named_decl->getName()); 540 else 541 LLDB_LOG(log, 542 "ClangASTSource::FindExternalVisibleDecls on " 543 "(ASTContext*){0} '{1}' for '{2}' in a '{3}'", 544 m_ast_context, m_clang_ast_context->getDisplayName(), name, 545 context.m_decl_context->getDeclKindName()); 546 } 547 548 if (isa<NamespaceDecl>(context.m_decl_context)) { 549 LookupInNamespace(context); 550 } else if (isa<ObjCInterfaceDecl>(context.m_decl_context)) { 551 FindObjCPropertyAndIvarDecls(context); 552 } else if (!isa<TranslationUnitDecl>(context.m_decl_context)) { 553 // we shouldn't be getting FindExternalVisibleDecls calls for these 554 return; 555 } else { 556 CompilerDeclContext namespace_decl; 557 558 LLDB_LOG(log, " CAS::FEVD Searching the root namespace"); 559 560 FindExternalVisibleDecls(context, lldb::ModuleSP(), namespace_decl); 561 } 562 563 if (!context.m_namespace_map->empty()) { 564 if (log && log->GetVerbose()) 565 LLDB_LOG(log, " CAS::FEVD Registering namespace map {0} ({1} entries)", 566 context.m_namespace_map.get(), context.m_namespace_map->size()); 567 568 NamespaceDecl *clang_namespace_decl = 569 AddNamespace(context, context.m_namespace_map); 570 571 if (clang_namespace_decl) 572 clang_namespace_decl->setHasExternalVisibleStorage(); 573 } 574 } 575 576 clang::Sema *ClangASTSource::getSema() { 577 return m_clang_ast_context->getSema(); 578 } 579 580 bool ClangASTSource::IgnoreName(const ConstString name, 581 bool ignore_all_dollar_names) { 582 static const ConstString id_name("id"); 583 static const ConstString Class_name("Class"); 584 585 if (m_ast_context->getLangOpts().ObjC) 586 if (name == id_name || name == Class_name) 587 return true; 588 589 StringRef name_string_ref = name.GetStringRef(); 590 591 // The ClangASTSource is not responsible for finding $-names. 592 return name_string_ref.empty() || 593 (ignore_all_dollar_names && name_string_ref.startswith("$")) || 594 name_string_ref.startswith("_$"); 595 } 596 597 void ClangASTSource::FindExternalVisibleDecls( 598 NameSearchContext &context, lldb::ModuleSP module_sp, 599 CompilerDeclContext &namespace_decl) { 600 assert(m_ast_context); 601 602 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 603 604 SymbolContextList sc_list; 605 606 const ConstString name(context.m_decl_name.getAsString().c_str()); 607 if (IgnoreName(name, true)) 608 return; 609 610 if (!m_target) 611 return; 612 613 FillNamespaceMap(context, module_sp, namespace_decl); 614 615 if (context.m_found_type) 616 return; 617 618 TypeList types; 619 const bool exact_match = true; 620 llvm::DenseSet<lldb_private::SymbolFile *> searched_symbol_files; 621 if (module_sp && namespace_decl) 622 module_sp->FindTypesInNamespace(name, namespace_decl, 1, types); 623 else { 624 m_target->GetImages().FindTypes(module_sp.get(), name, exact_match, 1, 625 searched_symbol_files, types); 626 } 627 628 if (size_t num_types = types.GetSize()) { 629 for (size_t ti = 0; ti < num_types; ++ti) { 630 lldb::TypeSP type_sp = types.GetTypeAtIndex(ti); 631 632 if (log) { 633 const char *name_string = type_sp->GetName().GetCString(); 634 635 LLDB_LOG(log, " CAS::FEVD Matching type found for \"{0}\": {1}", name, 636 (name_string ? name_string : "<anonymous>")); 637 } 638 639 CompilerType full_type = type_sp->GetFullCompilerType(); 640 641 CompilerType copied_clang_type(GuardedCopyType(full_type)); 642 643 if (!copied_clang_type) { 644 LLDB_LOG(log, " CAS::FEVD - Couldn't export a type"); 645 646 continue; 647 } 648 649 context.AddTypeDecl(copied_clang_type); 650 651 context.m_found_type = true; 652 break; 653 } 654 } 655 656 if (!context.m_found_type) { 657 // Try the modules next. 658 FindDeclInModules(context, name); 659 } 660 661 if (!context.m_found_type) { 662 FindDeclInObjCRuntime(context, name); 663 } 664 } 665 666 void ClangASTSource::FillNamespaceMap( 667 NameSearchContext &context, lldb::ModuleSP module_sp, 668 const CompilerDeclContext &namespace_decl) { 669 const ConstString name(context.m_decl_name.getAsString().c_str()); 670 if (IgnoreName(name, true)) 671 return; 672 673 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 674 675 if (module_sp && namespace_decl) { 676 CompilerDeclContext found_namespace_decl; 677 678 if (SymbolFile *symbol_file = module_sp->GetSymbolFile()) { 679 found_namespace_decl = symbol_file->FindNamespace(name, namespace_decl); 680 681 if (found_namespace_decl) { 682 context.m_namespace_map->push_back( 683 std::pair<lldb::ModuleSP, CompilerDeclContext>( 684 module_sp, found_namespace_decl)); 685 686 LLDB_LOG(log, " CAS::FEVD Found namespace {0} in module {1}", name, 687 module_sp->GetFileSpec().GetFilename()); 688 } 689 } 690 return; 691 } 692 693 for (lldb::ModuleSP image : m_target->GetImages().Modules()) { 694 if (!image) 695 continue; 696 697 CompilerDeclContext found_namespace_decl; 698 699 SymbolFile *symbol_file = image->GetSymbolFile(); 700 701 if (!symbol_file) 702 continue; 703 704 found_namespace_decl = symbol_file->FindNamespace(name, namespace_decl); 705 706 if (found_namespace_decl) { 707 context.m_namespace_map->push_back( 708 std::pair<lldb::ModuleSP, CompilerDeclContext>(image, 709 found_namespace_decl)); 710 711 LLDB_LOG(log, " CAS::FEVD Found namespace {0} in module {1}", name, 712 image->GetFileSpec().GetFilename()); 713 } 714 } 715 } 716 717 template <class D> class TaggedASTDecl { 718 public: 719 TaggedASTDecl() : decl(nullptr) {} 720 TaggedASTDecl(D *_decl) : decl(_decl) {} 721 bool IsValid() const { return (decl != nullptr); } 722 bool IsInvalid() const { return !IsValid(); } 723 D *operator->() const { return decl; } 724 D *decl; 725 }; 726 727 template <class D2, template <class D> class TD, class D1> 728 TD<D2> DynCast(TD<D1> source) { 729 return TD<D2>(dyn_cast<D2>(source.decl)); 730 } 731 732 template <class D = Decl> class DeclFromParser; 733 template <class D = Decl> class DeclFromUser; 734 735 template <class D> class DeclFromParser : public TaggedASTDecl<D> { 736 public: 737 DeclFromParser() : TaggedASTDecl<D>() {} 738 DeclFromParser(D *_decl) : TaggedASTDecl<D>(_decl) {} 739 740 DeclFromUser<D> GetOrigin(ClangASTSource &source); 741 }; 742 743 template <class D> class DeclFromUser : public TaggedASTDecl<D> { 744 public: 745 DeclFromUser() : TaggedASTDecl<D>() {} 746 DeclFromUser(D *_decl) : TaggedASTDecl<D>(_decl) {} 747 748 DeclFromParser<D> Import(ClangASTSource &source); 749 }; 750 751 template <class D> 752 DeclFromUser<D> DeclFromParser<D>::GetOrigin(ClangASTSource &source) { 753 ClangASTImporter::DeclOrigin origin = source.GetDeclOrigin(this->decl); 754 if (!origin.Valid()) 755 return DeclFromUser<D>(); 756 return DeclFromUser<D>(dyn_cast<D>(origin.decl)); 757 } 758 759 template <class D> 760 DeclFromParser<D> DeclFromUser<D>::Import(ClangASTSource &source) { 761 DeclFromParser<> parser_generic_decl(source.CopyDecl(this->decl)); 762 if (parser_generic_decl.IsInvalid()) 763 return DeclFromParser<D>(); 764 return DeclFromParser<D>(dyn_cast<D>(parser_generic_decl.decl)); 765 } 766 767 bool ClangASTSource::FindObjCMethodDeclsWithOrigin( 768 NameSearchContext &context, ObjCInterfaceDecl *original_interface_decl, 769 const char *log_info) { 770 const DeclarationName &decl_name(context.m_decl_name); 771 clang::ASTContext *original_ctx = &original_interface_decl->getASTContext(); 772 773 Selector original_selector; 774 775 if (decl_name.isObjCZeroArgSelector()) { 776 IdentifierInfo *ident = &original_ctx->Idents.get(decl_name.getAsString()); 777 original_selector = original_ctx->Selectors.getSelector(0, &ident); 778 } else if (decl_name.isObjCOneArgSelector()) { 779 const std::string &decl_name_string = decl_name.getAsString(); 780 std::string decl_name_string_without_colon(decl_name_string.c_str(), 781 decl_name_string.length() - 1); 782 IdentifierInfo *ident = 783 &original_ctx->Idents.get(decl_name_string_without_colon); 784 original_selector = original_ctx->Selectors.getSelector(1, &ident); 785 } else { 786 SmallVector<IdentifierInfo *, 4> idents; 787 788 clang::Selector sel = decl_name.getObjCSelector(); 789 790 unsigned num_args = sel.getNumArgs(); 791 792 for (unsigned i = 0; i != num_args; ++i) { 793 idents.push_back(&original_ctx->Idents.get(sel.getNameForSlot(i))); 794 } 795 796 original_selector = 797 original_ctx->Selectors.getSelector(num_args, idents.data()); 798 } 799 800 DeclarationName original_decl_name(original_selector); 801 802 llvm::SmallVector<NamedDecl *, 1> methods; 803 804 TypeSystemClang::GetCompleteDecl(original_ctx, original_interface_decl); 805 806 if (ObjCMethodDecl *instance_method_decl = 807 original_interface_decl->lookupInstanceMethod(original_selector)) { 808 methods.push_back(instance_method_decl); 809 } else if (ObjCMethodDecl *class_method_decl = 810 original_interface_decl->lookupClassMethod( 811 original_selector)) { 812 methods.push_back(class_method_decl); 813 } 814 815 if (methods.empty()) { 816 return false; 817 } 818 819 for (NamedDecl *named_decl : methods) { 820 if (!named_decl) 821 continue; 822 823 ObjCMethodDecl *result_method = dyn_cast<ObjCMethodDecl>(named_decl); 824 825 if (!result_method) 826 continue; 827 828 Decl *copied_decl = CopyDecl(result_method); 829 830 if (!copied_decl) 831 continue; 832 833 ObjCMethodDecl *copied_method_decl = dyn_cast<ObjCMethodDecl>(copied_decl); 834 835 if (!copied_method_decl) 836 continue; 837 838 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 839 840 LLDB_LOG(log, " CAS::FOMD found ({0}) {1}", log_info, 841 ClangUtil::DumpDecl(copied_method_decl)); 842 843 context.AddNamedDecl(copied_method_decl); 844 } 845 846 return true; 847 } 848 849 void ClangASTSource::FindDeclInModules(NameSearchContext &context, 850 ConstString name) { 851 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 852 853 ClangModulesDeclVendor *modules_decl_vendor = 854 m_target->GetClangModulesDeclVendor(); 855 if (!modules_decl_vendor) 856 return; 857 858 bool append = false; 859 uint32_t max_matches = 1; 860 std::vector<clang::NamedDecl *> decls; 861 862 if (!modules_decl_vendor->FindDecls(name, append, max_matches, decls)) 863 return; 864 865 LLDB_LOG(log, " CAS::FEVD Matching entity found for \"{0}\" in the modules", 866 name); 867 868 clang::NamedDecl *const decl_from_modules = decls[0]; 869 870 if (llvm::isa<clang::TypeDecl>(decl_from_modules) || 871 llvm::isa<clang::ObjCContainerDecl>(decl_from_modules) || 872 llvm::isa<clang::EnumConstantDecl>(decl_from_modules)) { 873 clang::Decl *copied_decl = CopyDecl(decl_from_modules); 874 clang::NamedDecl *copied_named_decl = 875 copied_decl ? dyn_cast<clang::NamedDecl>(copied_decl) : nullptr; 876 877 if (!copied_named_decl) { 878 LLDB_LOG(log, " CAS::FEVD - Couldn't export a type from the modules"); 879 880 return; 881 } 882 883 context.AddNamedDecl(copied_named_decl); 884 885 context.m_found_type = true; 886 } 887 } 888 889 void ClangASTSource::FindDeclInObjCRuntime(NameSearchContext &context, 890 ConstString name) { 891 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 892 893 lldb::ProcessSP process(m_target->GetProcessSP()); 894 895 if (!process) 896 return; 897 898 ObjCLanguageRuntime *language_runtime(ObjCLanguageRuntime::Get(*process)); 899 900 if (!language_runtime) 901 return; 902 903 DeclVendor *decl_vendor = language_runtime->GetDeclVendor(); 904 905 if (!decl_vendor) 906 return; 907 908 bool append = false; 909 uint32_t max_matches = 1; 910 std::vector<clang::NamedDecl *> decls; 911 912 auto *clang_decl_vendor = llvm::cast<ClangDeclVendor>(decl_vendor); 913 if (!clang_decl_vendor->FindDecls(name, append, max_matches, decls)) 914 return; 915 916 LLDB_LOG(log, " CAS::FEVD Matching type found for \"{0}\" in the runtime", 917 name); 918 919 clang::Decl *copied_decl = CopyDecl(decls[0]); 920 clang::NamedDecl *copied_named_decl = 921 copied_decl ? dyn_cast<clang::NamedDecl>(copied_decl) : nullptr; 922 923 if (!copied_named_decl) { 924 LLDB_LOG(log, " CAS::FEVD - Couldn't export a type from the runtime"); 925 926 return; 927 } 928 929 context.AddNamedDecl(copied_named_decl); 930 } 931 932 void ClangASTSource::FindObjCMethodDecls(NameSearchContext &context) { 933 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 934 935 const DeclarationName &decl_name(context.m_decl_name); 936 const DeclContext *decl_ctx(context.m_decl_context); 937 938 const ObjCInterfaceDecl *interface_decl = 939 dyn_cast<ObjCInterfaceDecl>(decl_ctx); 940 941 if (!interface_decl) 942 return; 943 944 do { 945 ClangASTImporter::DeclOrigin original = m_ast_importer_sp->GetDeclOrigin(interface_decl); 946 947 if (!original.Valid()) 948 break; 949 950 ObjCInterfaceDecl *original_interface_decl = 951 dyn_cast<ObjCInterfaceDecl>(original.decl); 952 953 if (FindObjCMethodDeclsWithOrigin(context, original_interface_decl, 954 "at origin")) 955 return; // found it, no need to look any further 956 } while (false); 957 958 StreamString ss; 959 960 if (decl_name.isObjCZeroArgSelector()) { 961 ss.Printf("%s", decl_name.getAsString().c_str()); 962 } else if (decl_name.isObjCOneArgSelector()) { 963 ss.Printf("%s", decl_name.getAsString().c_str()); 964 } else { 965 clang::Selector sel = decl_name.getObjCSelector(); 966 967 for (unsigned i = 0, e = sel.getNumArgs(); i != e; ++i) { 968 llvm::StringRef r = sel.getNameForSlot(i); 969 ss.Printf("%s:", r.str().c_str()); 970 } 971 } 972 ss.Flush(); 973 974 if (ss.GetString().contains("$__lldb")) 975 return; // we don't need any results 976 977 ConstString selector_name(ss.GetString()); 978 979 LLDB_LOG(log, 980 "ClangASTSource::FindObjCMethodDecls on (ASTContext*){0} '{1}' " 981 "for selector [{2} {3}]", 982 m_ast_context, m_clang_ast_context->getDisplayName(), 983 interface_decl->getName(), selector_name); 984 SymbolContextList sc_list; 985 986 const bool include_symbols = false; 987 const bool include_inlines = false; 988 989 std::string interface_name = interface_decl->getNameAsString(); 990 991 do { 992 StreamString ms; 993 ms.Printf("-[%s %s]", interface_name.c_str(), selector_name.AsCString()); 994 ms.Flush(); 995 ConstString instance_method_name(ms.GetString()); 996 997 sc_list.Clear(); 998 m_target->GetImages().FindFunctions( 999 instance_method_name, lldb::eFunctionNameTypeFull, include_symbols, 1000 include_inlines, sc_list); 1001 1002 if (sc_list.GetSize()) 1003 break; 1004 1005 ms.Clear(); 1006 ms.Printf("+[%s %s]", interface_name.c_str(), selector_name.AsCString()); 1007 ms.Flush(); 1008 ConstString class_method_name(ms.GetString()); 1009 1010 sc_list.Clear(); 1011 m_target->GetImages().FindFunctions( 1012 class_method_name, lldb::eFunctionNameTypeFull, include_symbols, 1013 include_inlines, sc_list); 1014 1015 if (sc_list.GetSize()) 1016 break; 1017 1018 // Fall back and check for methods in categories. If we find methods this 1019 // way, we need to check that they're actually in categories on the desired 1020 // class. 1021 1022 SymbolContextList candidate_sc_list; 1023 1024 m_target->GetImages().FindFunctions( 1025 selector_name, lldb::eFunctionNameTypeSelector, include_symbols, 1026 include_inlines, candidate_sc_list); 1027 1028 for (uint32_t ci = 0, ce = candidate_sc_list.GetSize(); ci != ce; ++ci) { 1029 SymbolContext candidate_sc; 1030 1031 if (!candidate_sc_list.GetContextAtIndex(ci, candidate_sc)) 1032 continue; 1033 1034 if (!candidate_sc.function) 1035 continue; 1036 1037 const char *candidate_name = candidate_sc.function->GetName().AsCString(); 1038 1039 const char *cursor = candidate_name; 1040 1041 if (*cursor != '+' && *cursor != '-') 1042 continue; 1043 1044 ++cursor; 1045 1046 if (*cursor != '[') 1047 continue; 1048 1049 ++cursor; 1050 1051 size_t interface_len = interface_name.length(); 1052 1053 if (strncmp(cursor, interface_name.c_str(), interface_len)) 1054 continue; 1055 1056 cursor += interface_len; 1057 1058 if (*cursor == ' ' || *cursor == '(') 1059 sc_list.Append(candidate_sc); 1060 } 1061 } while (false); 1062 1063 if (sc_list.GetSize()) { 1064 // We found a good function symbol. Use that. 1065 1066 for (uint32_t i = 0, e = sc_list.GetSize(); i != e; ++i) { 1067 SymbolContext sc; 1068 1069 if (!sc_list.GetContextAtIndex(i, sc)) 1070 continue; 1071 1072 if (!sc.function) 1073 continue; 1074 1075 CompilerDeclContext function_decl_ctx = sc.function->GetDeclContext(); 1076 if (!function_decl_ctx) 1077 continue; 1078 1079 ObjCMethodDecl *method_decl = 1080 TypeSystemClang::DeclContextGetAsObjCMethodDecl(function_decl_ctx); 1081 1082 if (!method_decl) 1083 continue; 1084 1085 ObjCInterfaceDecl *found_interface_decl = 1086 method_decl->getClassInterface(); 1087 1088 if (!found_interface_decl) 1089 continue; 1090 1091 if (found_interface_decl->getName() == interface_decl->getName()) { 1092 Decl *copied_decl = CopyDecl(method_decl); 1093 1094 if (!copied_decl) 1095 continue; 1096 1097 ObjCMethodDecl *copied_method_decl = 1098 dyn_cast<ObjCMethodDecl>(copied_decl); 1099 1100 if (!copied_method_decl) 1101 continue; 1102 1103 LLDB_LOG(log, " CAS::FOMD found (in symbols)\n{0}", 1104 ClangUtil::DumpDecl(copied_method_decl)); 1105 1106 context.AddNamedDecl(copied_method_decl); 1107 } 1108 } 1109 1110 return; 1111 } 1112 1113 // Try the debug information. 1114 1115 do { 1116 ObjCInterfaceDecl *complete_interface_decl = GetCompleteObjCInterface( 1117 const_cast<ObjCInterfaceDecl *>(interface_decl)); 1118 1119 if (!complete_interface_decl) 1120 break; 1121 1122 // We found the complete interface. The runtime never needs to be queried 1123 // in this scenario. 1124 1125 DeclFromUser<const ObjCInterfaceDecl> complete_iface_decl( 1126 complete_interface_decl); 1127 1128 if (complete_interface_decl == interface_decl) 1129 break; // already checked this one 1130 1131 LLDB_LOG(log, 1132 "CAS::FOPD trying origin " 1133 "(ObjCInterfaceDecl*){0}/(ASTContext*){1}...", 1134 complete_interface_decl, &complete_iface_decl->getASTContext()); 1135 1136 FindObjCMethodDeclsWithOrigin(context, complete_interface_decl, 1137 "in debug info"); 1138 1139 return; 1140 } while (false); 1141 1142 do { 1143 // Check the modules only if the debug information didn't have a complete 1144 // interface. 1145 1146 if (ClangModulesDeclVendor *modules_decl_vendor = 1147 m_target->GetClangModulesDeclVendor()) { 1148 ConstString interface_name(interface_decl->getNameAsString().c_str()); 1149 bool append = false; 1150 uint32_t max_matches = 1; 1151 std::vector<clang::NamedDecl *> decls; 1152 1153 if (!modules_decl_vendor->FindDecls(interface_name, append, max_matches, 1154 decls)) 1155 break; 1156 1157 ObjCInterfaceDecl *interface_decl_from_modules = 1158 dyn_cast<ObjCInterfaceDecl>(decls[0]); 1159 1160 if (!interface_decl_from_modules) 1161 break; 1162 1163 if (FindObjCMethodDeclsWithOrigin(context, interface_decl_from_modules, 1164 "in modules")) 1165 return; 1166 } 1167 } while (false); 1168 1169 do { 1170 // Check the runtime only if the debug information didn't have a complete 1171 // interface and the modules don't get us anywhere. 1172 1173 lldb::ProcessSP process(m_target->GetProcessSP()); 1174 1175 if (!process) 1176 break; 1177 1178 ObjCLanguageRuntime *language_runtime(ObjCLanguageRuntime::Get(*process)); 1179 1180 if (!language_runtime) 1181 break; 1182 1183 DeclVendor *decl_vendor = language_runtime->GetDeclVendor(); 1184 1185 if (!decl_vendor) 1186 break; 1187 1188 ConstString interface_name(interface_decl->getNameAsString().c_str()); 1189 bool append = false; 1190 uint32_t max_matches = 1; 1191 std::vector<clang::NamedDecl *> decls; 1192 1193 auto *clang_decl_vendor = llvm::cast<ClangDeclVendor>(decl_vendor); 1194 if (!clang_decl_vendor->FindDecls(interface_name, append, max_matches, 1195 decls)) 1196 break; 1197 1198 ObjCInterfaceDecl *runtime_interface_decl = 1199 dyn_cast<ObjCInterfaceDecl>(decls[0]); 1200 1201 if (!runtime_interface_decl) 1202 break; 1203 1204 FindObjCMethodDeclsWithOrigin(context, runtime_interface_decl, 1205 "in runtime"); 1206 } while (false); 1207 } 1208 1209 static bool FindObjCPropertyAndIvarDeclsWithOrigin( 1210 NameSearchContext &context, ClangASTSource &source, 1211 DeclFromUser<const ObjCInterfaceDecl> &origin_iface_decl) { 1212 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 1213 1214 if (origin_iface_decl.IsInvalid()) 1215 return false; 1216 1217 std::string name_str = context.m_decl_name.getAsString(); 1218 StringRef name(name_str); 1219 IdentifierInfo &name_identifier( 1220 origin_iface_decl->getASTContext().Idents.get(name)); 1221 1222 DeclFromUser<ObjCPropertyDecl> origin_property_decl( 1223 origin_iface_decl->FindPropertyDeclaration( 1224 &name_identifier, ObjCPropertyQueryKind::OBJC_PR_query_instance)); 1225 1226 bool found = false; 1227 1228 if (origin_property_decl.IsValid()) { 1229 DeclFromParser<ObjCPropertyDecl> parser_property_decl( 1230 origin_property_decl.Import(source)); 1231 if (parser_property_decl.IsValid()) { 1232 LLDB_LOG(log, " CAS::FOPD found\n{0}", 1233 ClangUtil::DumpDecl(parser_property_decl.decl)); 1234 1235 context.AddNamedDecl(parser_property_decl.decl); 1236 found = true; 1237 } 1238 } 1239 1240 DeclFromUser<ObjCIvarDecl> origin_ivar_decl( 1241 origin_iface_decl->getIvarDecl(&name_identifier)); 1242 1243 if (origin_ivar_decl.IsValid()) { 1244 DeclFromParser<ObjCIvarDecl> parser_ivar_decl( 1245 origin_ivar_decl.Import(source)); 1246 if (parser_ivar_decl.IsValid()) { 1247 LLDB_LOG(log, " CAS::FOPD found\n{0}", 1248 ClangUtil::DumpDecl(parser_ivar_decl.decl)); 1249 1250 context.AddNamedDecl(parser_ivar_decl.decl); 1251 found = true; 1252 } 1253 } 1254 1255 return found; 1256 } 1257 1258 void ClangASTSource::FindObjCPropertyAndIvarDecls(NameSearchContext &context) { 1259 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 1260 1261 DeclFromParser<const ObjCInterfaceDecl> parser_iface_decl( 1262 cast<ObjCInterfaceDecl>(context.m_decl_context)); 1263 DeclFromUser<const ObjCInterfaceDecl> origin_iface_decl( 1264 parser_iface_decl.GetOrigin(*this)); 1265 1266 ConstString class_name(parser_iface_decl->getNameAsString().c_str()); 1267 1268 LLDB_LOG(log, 1269 "ClangASTSource::FindObjCPropertyAndIvarDecls on " 1270 "(ASTContext*){0} '{1}' for '{2}.{3}'", 1271 m_ast_context, m_clang_ast_context->getDisplayName(), 1272 parser_iface_decl->getName(), context.m_decl_name.getAsString()); 1273 1274 if (FindObjCPropertyAndIvarDeclsWithOrigin(context, *this, origin_iface_decl)) 1275 return; 1276 1277 LLDB_LOG(log, 1278 "CAS::FOPD couldn't find the property on origin " 1279 "(ObjCInterfaceDecl*){0}/(ASTContext*){1}, searching " 1280 "elsewhere...", 1281 origin_iface_decl.decl, &origin_iface_decl->getASTContext()); 1282 1283 SymbolContext null_sc; 1284 TypeList type_list; 1285 1286 do { 1287 ObjCInterfaceDecl *complete_interface_decl = GetCompleteObjCInterface( 1288 const_cast<ObjCInterfaceDecl *>(parser_iface_decl.decl)); 1289 1290 if (!complete_interface_decl) 1291 break; 1292 1293 // We found the complete interface. The runtime never needs to be queried 1294 // in this scenario. 1295 1296 DeclFromUser<const ObjCInterfaceDecl> complete_iface_decl( 1297 complete_interface_decl); 1298 1299 if (complete_iface_decl.decl == origin_iface_decl.decl) 1300 break; // already checked this one 1301 1302 LLDB_LOG(log, 1303 "CAS::FOPD trying origin " 1304 "(ObjCInterfaceDecl*){0}/(ASTContext*){1}...", 1305 complete_iface_decl.decl, &complete_iface_decl->getASTContext()); 1306 1307 FindObjCPropertyAndIvarDeclsWithOrigin(context, *this, complete_iface_decl); 1308 1309 return; 1310 } while (false); 1311 1312 do { 1313 // Check the modules only if the debug information didn't have a complete 1314 // interface. 1315 1316 ClangModulesDeclVendor *modules_decl_vendor = 1317 m_target->GetClangModulesDeclVendor(); 1318 1319 if (!modules_decl_vendor) 1320 break; 1321 1322 bool append = false; 1323 uint32_t max_matches = 1; 1324 std::vector<clang::NamedDecl *> decls; 1325 1326 if (!modules_decl_vendor->FindDecls(class_name, append, max_matches, decls)) 1327 break; 1328 1329 DeclFromUser<const ObjCInterfaceDecl> interface_decl_from_modules( 1330 dyn_cast<ObjCInterfaceDecl>(decls[0])); 1331 1332 if (!interface_decl_from_modules.IsValid()) 1333 break; 1334 1335 LLDB_LOG(log, 1336 "CAS::FOPD[{0}] trying module " 1337 "(ObjCInterfaceDecl*){0}/(ASTContext*){1}...", 1338 interface_decl_from_modules.decl, 1339 &interface_decl_from_modules->getASTContext()); 1340 1341 if (FindObjCPropertyAndIvarDeclsWithOrigin(context, *this, 1342 interface_decl_from_modules)) 1343 return; 1344 } while (false); 1345 1346 do { 1347 // Check the runtime only if the debug information didn't have a complete 1348 // interface and nothing was in the modules. 1349 1350 lldb::ProcessSP process(m_target->GetProcessSP()); 1351 1352 if (!process) 1353 return; 1354 1355 ObjCLanguageRuntime *language_runtime(ObjCLanguageRuntime::Get(*process)); 1356 1357 if (!language_runtime) 1358 return; 1359 1360 DeclVendor *decl_vendor = language_runtime->GetDeclVendor(); 1361 1362 if (!decl_vendor) 1363 break; 1364 1365 bool append = false; 1366 uint32_t max_matches = 1; 1367 std::vector<clang::NamedDecl *> decls; 1368 1369 auto *clang_decl_vendor = llvm::cast<ClangDeclVendor>(decl_vendor); 1370 if (!clang_decl_vendor->FindDecls(class_name, append, max_matches, decls)) 1371 break; 1372 1373 DeclFromUser<const ObjCInterfaceDecl> interface_decl_from_runtime( 1374 dyn_cast<ObjCInterfaceDecl>(decls[0])); 1375 1376 if (!interface_decl_from_runtime.IsValid()) 1377 break; 1378 1379 LLDB_LOG(log, 1380 "CAS::FOPD[{0}] trying runtime " 1381 "(ObjCInterfaceDecl*){0}/(ASTContext*){1}...", 1382 interface_decl_from_runtime.decl, 1383 &interface_decl_from_runtime->getASTContext()); 1384 1385 if (FindObjCPropertyAndIvarDeclsWithOrigin(context, *this, 1386 interface_decl_from_runtime)) 1387 return; 1388 } while (false); 1389 } 1390 1391 void ClangASTSource::LookupInNamespace(NameSearchContext &context) { 1392 const NamespaceDecl *namespace_context = 1393 dyn_cast<NamespaceDecl>(context.m_decl_context); 1394 1395 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 1396 1397 ClangASTImporter::NamespaceMapSP namespace_map = 1398 m_ast_importer_sp->GetNamespaceMap(namespace_context); 1399 1400 LLDB_LOGV(log, " CAS::FEVD Inspecting namespace map {0} ({1} entries)", 1401 namespace_map.get(), namespace_map->size()); 1402 1403 if (!namespace_map) 1404 return; 1405 1406 for (ClangASTImporter::NamespaceMap::iterator i = namespace_map->begin(), 1407 e = namespace_map->end(); 1408 i != e; ++i) { 1409 LLDB_LOG(log, " CAS::FEVD Searching namespace {0} in module {1}", 1410 i->second.GetName(), i->first->GetFileSpec().GetFilename()); 1411 1412 FindExternalVisibleDecls(context, i->first, i->second); 1413 } 1414 } 1415 1416 typedef llvm::DenseMap<const FieldDecl *, uint64_t> FieldOffsetMap; 1417 typedef llvm::DenseMap<const CXXRecordDecl *, CharUnits> BaseOffsetMap; 1418 1419 template <class D, class O> 1420 static bool ImportOffsetMap(llvm::DenseMap<const D *, O> &destination_map, 1421 llvm::DenseMap<const D *, O> &source_map, 1422 ClangASTSource &source) { 1423 // When importing fields into a new record, clang has a hard requirement that 1424 // fields be imported in field offset order. Since they are stored in a 1425 // DenseMap with a pointer as the key type, this means we cannot simply 1426 // iterate over the map, as the order will be non-deterministic. Instead we 1427 // have to sort by the offset and then insert in sorted order. 1428 typedef llvm::DenseMap<const D *, O> MapType; 1429 typedef typename MapType::value_type PairType; 1430 std::vector<PairType> sorted_items; 1431 sorted_items.reserve(source_map.size()); 1432 sorted_items.assign(source_map.begin(), source_map.end()); 1433 llvm::sort(sorted_items.begin(), sorted_items.end(), 1434 [](const PairType &lhs, const PairType &rhs) { 1435 return lhs.second < rhs.second; 1436 }); 1437 1438 for (const auto &item : sorted_items) { 1439 DeclFromUser<D> user_decl(const_cast<D *>(item.first)); 1440 DeclFromParser<D> parser_decl(user_decl.Import(source)); 1441 if (parser_decl.IsInvalid()) 1442 return false; 1443 destination_map.insert( 1444 std::pair<const D *, O>(parser_decl.decl, item.second)); 1445 } 1446 1447 return true; 1448 } 1449 1450 template <bool IsVirtual> 1451 bool ExtractBaseOffsets(const ASTRecordLayout &record_layout, 1452 DeclFromUser<const CXXRecordDecl> &record, 1453 BaseOffsetMap &base_offsets) { 1454 for (CXXRecordDecl::base_class_const_iterator 1455 bi = (IsVirtual ? record->vbases_begin() : record->bases_begin()), 1456 be = (IsVirtual ? record->vbases_end() : record->bases_end()); 1457 bi != be; ++bi) { 1458 if (!IsVirtual && bi->isVirtual()) 1459 continue; 1460 1461 const clang::Type *origin_base_type = bi->getType().getTypePtr(); 1462 const clang::RecordType *origin_base_record_type = 1463 origin_base_type->getAs<RecordType>(); 1464 1465 if (!origin_base_record_type) 1466 return false; 1467 1468 DeclFromUser<RecordDecl> origin_base_record( 1469 origin_base_record_type->getDecl()); 1470 1471 if (origin_base_record.IsInvalid()) 1472 return false; 1473 1474 DeclFromUser<CXXRecordDecl> origin_base_cxx_record( 1475 DynCast<CXXRecordDecl>(origin_base_record)); 1476 1477 if (origin_base_cxx_record.IsInvalid()) 1478 return false; 1479 1480 CharUnits base_offset; 1481 1482 if (IsVirtual) 1483 base_offset = 1484 record_layout.getVBaseClassOffset(origin_base_cxx_record.decl); 1485 else 1486 base_offset = 1487 record_layout.getBaseClassOffset(origin_base_cxx_record.decl); 1488 1489 base_offsets.insert(std::pair<const CXXRecordDecl *, CharUnits>( 1490 origin_base_cxx_record.decl, base_offset)); 1491 } 1492 1493 return true; 1494 } 1495 1496 bool ClangASTSource::layoutRecordType(const RecordDecl *record, uint64_t &size, 1497 uint64_t &alignment, 1498 FieldOffsetMap &field_offsets, 1499 BaseOffsetMap &base_offsets, 1500 BaseOffsetMap &virtual_base_offsets) { 1501 1502 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 1503 1504 LLDB_LOG(log, 1505 "LayoutRecordType on (ASTContext*){0} '{1}' for (RecordDecl*)" 1506 "{3} [name = '{4}']", 1507 m_ast_context, m_clang_ast_context->getDisplayName(), record, 1508 record->getName()); 1509 1510 DeclFromParser<const RecordDecl> parser_record(record); 1511 DeclFromUser<const RecordDecl> origin_record( 1512 parser_record.GetOrigin(*this)); 1513 1514 if (origin_record.IsInvalid()) 1515 return false; 1516 1517 FieldOffsetMap origin_field_offsets; 1518 BaseOffsetMap origin_base_offsets; 1519 BaseOffsetMap origin_virtual_base_offsets; 1520 1521 TypeSystemClang::GetCompleteDecl( 1522 &origin_record->getASTContext(), 1523 const_cast<RecordDecl *>(origin_record.decl)); 1524 1525 clang::RecordDecl *definition = origin_record.decl->getDefinition(); 1526 if (!definition || !definition->isCompleteDefinition()) 1527 return false; 1528 1529 const ASTRecordLayout &record_layout( 1530 origin_record->getASTContext().getASTRecordLayout(origin_record.decl)); 1531 1532 int field_idx = 0, field_count = record_layout.getFieldCount(); 1533 1534 for (RecordDecl::field_iterator fi = origin_record->field_begin(), 1535 fe = origin_record->field_end(); 1536 fi != fe; ++fi) { 1537 if (field_idx >= field_count) 1538 return false; // Layout didn't go well. Bail out. 1539 1540 uint64_t field_offset = record_layout.getFieldOffset(field_idx); 1541 1542 origin_field_offsets.insert( 1543 std::pair<const FieldDecl *, uint64_t>(*fi, field_offset)); 1544 1545 field_idx++; 1546 } 1547 1548 lldbassert(&record->getASTContext() == m_ast_context); 1549 1550 DeclFromUser<const CXXRecordDecl> origin_cxx_record( 1551 DynCast<const CXXRecordDecl>(origin_record)); 1552 1553 if (origin_cxx_record.IsValid()) { 1554 if (!ExtractBaseOffsets<false>(record_layout, origin_cxx_record, 1555 origin_base_offsets) || 1556 !ExtractBaseOffsets<true>(record_layout, origin_cxx_record, 1557 origin_virtual_base_offsets)) 1558 return false; 1559 } 1560 1561 if (!ImportOffsetMap(field_offsets, origin_field_offsets, *this) || 1562 !ImportOffsetMap(base_offsets, origin_base_offsets, *this) || 1563 !ImportOffsetMap(virtual_base_offsets, origin_virtual_base_offsets, 1564 *this)) 1565 return false; 1566 1567 size = record_layout.getSize().getQuantity() * m_ast_context->getCharWidth(); 1568 alignment = record_layout.getAlignment().getQuantity() * 1569 m_ast_context->getCharWidth(); 1570 1571 if (log) { 1572 LLDB_LOG(log, "LRT returned:"); 1573 LLDB_LOG(log, "LRT Original = (RecordDecl*)%p", 1574 static_cast<const void *>(origin_record.decl)); 1575 LLDB_LOG(log, "LRT Size = %" PRId64, size); 1576 LLDB_LOG(log, "LRT Alignment = %" PRId64, alignment); 1577 LLDB_LOG(log, "LRT Fields:"); 1578 for (RecordDecl::field_iterator fi = record->field_begin(), 1579 fe = record->field_end(); 1580 fi != fe; ++fi) { 1581 LLDB_LOG(log, 1582 "LRT (FieldDecl*){0}, Name = '{1}', Offset = {2} bits", 1583 *fi, fi->getName(), field_offsets[*fi]); 1584 } 1585 DeclFromParser<const CXXRecordDecl> parser_cxx_record = 1586 DynCast<const CXXRecordDecl>(parser_record); 1587 if (parser_cxx_record.IsValid()) { 1588 LLDB_LOG(log, "LRT Bases:"); 1589 for (CXXRecordDecl::base_class_const_iterator 1590 bi = parser_cxx_record->bases_begin(), 1591 be = parser_cxx_record->bases_end(); 1592 bi != be; ++bi) { 1593 bool is_virtual = bi->isVirtual(); 1594 1595 QualType base_type = bi->getType(); 1596 const RecordType *base_record_type = base_type->getAs<RecordType>(); 1597 DeclFromParser<RecordDecl> base_record(base_record_type->getDecl()); 1598 DeclFromParser<CXXRecordDecl> base_cxx_record = 1599 DynCast<CXXRecordDecl>(base_record); 1600 1601 LLDB_LOG(log, 1602 "LRT {0}(CXXRecordDecl*){1}, Name = '{2}', Offset = " 1603 "{3} chars", 1604 (is_virtual ? "Virtual " : ""), base_cxx_record.decl, 1605 base_cxx_record.decl->getName(), 1606 (is_virtual 1607 ? virtual_base_offsets[base_cxx_record.decl].getQuantity() 1608 : base_offsets[base_cxx_record.decl].getQuantity())); 1609 } 1610 } else { 1611 LLDB_LOG(log, "LRD Not a CXXRecord, so no bases"); 1612 } 1613 } 1614 1615 return true; 1616 } 1617 1618 void ClangASTSource::CompleteNamespaceMap( 1619 ClangASTImporter::NamespaceMapSP &namespace_map, ConstString name, 1620 ClangASTImporter::NamespaceMapSP &parent_map) const { 1621 1622 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS)); 1623 1624 if (log) { 1625 if (parent_map && parent_map->size()) 1626 LLDB_LOG(log, 1627 "CompleteNamespaceMap on (ASTContext*){0} '{1}' Searching " 1628 "for namespace {2} in namespace {3}", 1629 m_ast_context, m_clang_ast_context->getDisplayName(), name, 1630 parent_map->begin()->second.GetName()); 1631 else 1632 LLDB_LOG(log, 1633 "CompleteNamespaceMap on (ASTContext*){0} '{1}' Searching " 1634 "for namespace {2}", 1635 m_ast_context, m_clang_ast_context->getDisplayName(), name); 1636 } 1637 1638 if (parent_map) { 1639 for (ClangASTImporter::NamespaceMap::iterator i = parent_map->begin(), 1640 e = parent_map->end(); 1641 i != e; ++i) { 1642 CompilerDeclContext found_namespace_decl; 1643 1644 lldb::ModuleSP module_sp = i->first; 1645 CompilerDeclContext module_parent_namespace_decl = i->second; 1646 1647 SymbolFile *symbol_file = module_sp->GetSymbolFile(); 1648 1649 if (!symbol_file) 1650 continue; 1651 1652 found_namespace_decl = 1653 symbol_file->FindNamespace(name, module_parent_namespace_decl); 1654 1655 if (!found_namespace_decl) 1656 continue; 1657 1658 namespace_map->push_back(std::pair<lldb::ModuleSP, CompilerDeclContext>( 1659 module_sp, found_namespace_decl)); 1660 1661 LLDB_LOG(log, " CMN Found namespace {0} in module {1}", name, 1662 module_sp->GetFileSpec().GetFilename()); 1663 } 1664 } else { 1665 CompilerDeclContext null_namespace_decl; 1666 for (lldb::ModuleSP image : m_target->GetImages().Modules()) { 1667 if (!image) 1668 continue; 1669 1670 CompilerDeclContext found_namespace_decl; 1671 1672 SymbolFile *symbol_file = image->GetSymbolFile(); 1673 1674 if (!symbol_file) 1675 continue; 1676 1677 found_namespace_decl = 1678 symbol_file->FindNamespace(name, null_namespace_decl); 1679 1680 if (!found_namespace_decl) 1681 continue; 1682 1683 namespace_map->push_back(std::pair<lldb::ModuleSP, CompilerDeclContext>( 1684 image, found_namespace_decl)); 1685 1686 LLDB_LOG(log, " CMN[{0}] Found namespace {0} in module {1}", name, 1687 image->GetFileSpec().GetFilename()); 1688 } 1689 } 1690 } 1691 1692 NamespaceDecl *ClangASTSource::AddNamespace( 1693 NameSearchContext &context, 1694 ClangASTImporter::NamespaceMapSP &namespace_decls) { 1695 if (!namespace_decls) 1696 return nullptr; 1697 1698 const CompilerDeclContext &namespace_decl = namespace_decls->begin()->second; 1699 1700 clang::ASTContext *src_ast = 1701 TypeSystemClang::DeclContextGetTypeSystemClang(namespace_decl); 1702 if (!src_ast) 1703 return nullptr; 1704 clang::NamespaceDecl *src_namespace_decl = 1705 TypeSystemClang::DeclContextGetAsNamespaceDecl(namespace_decl); 1706 1707 if (!src_namespace_decl) 1708 return nullptr; 1709 1710 Decl *copied_decl = CopyDecl(src_namespace_decl); 1711 1712 if (!copied_decl) 1713 return nullptr; 1714 1715 NamespaceDecl *copied_namespace_decl = dyn_cast<NamespaceDecl>(copied_decl); 1716 1717 if (!copied_namespace_decl) 1718 return nullptr; 1719 1720 context.m_decls.push_back(copied_namespace_decl); 1721 1722 m_ast_importer_sp->RegisterNamespaceMap(copied_namespace_decl, 1723 namespace_decls); 1724 1725 return dyn_cast<NamespaceDecl>(copied_decl); 1726 } 1727 1728 clang::Decl *ClangASTSource::CopyDecl(Decl *src_decl) { 1729 return m_ast_importer_sp->CopyDecl(m_ast_context, src_decl); 1730 } 1731 1732 ClangASTImporter::DeclOrigin ClangASTSource::GetDeclOrigin(const clang::Decl *decl) { 1733 return m_ast_importer_sp->GetDeclOrigin(decl); 1734 } 1735 1736 CompilerType ClangASTSource::GuardedCopyType(const CompilerType &src_type) { 1737 TypeSystemClang *src_ast = 1738 llvm::dyn_cast_or_null<TypeSystemClang>(src_type.GetTypeSystem()); 1739 if (src_ast == nullptr) 1740 return CompilerType(); 1741 1742 QualType copied_qual_type = ClangUtil::GetQualType( 1743 m_ast_importer_sp->CopyType(*m_clang_ast_context, src_type)); 1744 1745 if (copied_qual_type.getAsOpaquePtr() && 1746 copied_qual_type->getCanonicalTypeInternal().isNull()) 1747 // this shouldn't happen, but we're hardening because the AST importer 1748 // seems to be generating bad types on occasion. 1749 return CompilerType(); 1750 1751 return m_clang_ast_context->GetType(copied_qual_type); 1752 } 1753