contrib/llvm/tools/lldb/source/Plugins/LanguageRuntime/ObjC/AppleObjCRuntime/AppleObjCDeclVendor.cpp

   1 //===-- AppleObjCDeclVendor.cpp ---------------------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #include "AppleObjCDeclVendor.h"
  11
  12 #include "Plugins/ExpressionParser/Clang/ASTDumper.h"
  13 #include "lldb/Core/Log.h"
  14 #include "lldb/Core/Module.h"
  15 #include "lldb/Symbol/ClangExternalASTSourceCommon.h"
  16 #include "lldb/Symbol/ClangUtil.h"
  17 #include "lldb/Target/ObjCLanguageRuntime.h"
  18 #include "lldb/Target/Process.h"
  19 #include "lldb/Target/Target.h"
  20
  21 #include "clang/AST/ASTContext.h"
  22 #include "clang/AST/DeclObjC.h"
  23
  24 using namespace lldb_private;
  25
  26 class lldb_private::AppleObjCExternalASTSource
  27     : public ClangExternalASTSourceCommon {
  28 public:
  29   AppleObjCExternalASTSource(AppleObjCDeclVendor &decl_vendor)
  30       : m_decl_vendor(decl_vendor) {}
  31
  32   bool FindExternalVisibleDeclsByName(const clang::DeclContext *decl_ctx,
  33                                       clang::DeclarationName name) override {
  34     static unsigned int invocation_id = 0;
  35     unsigned int current_id = invocation_id++;
  36
  37     Log *log(GetLogIfAllCategoriesSet(
  38         LIBLLDB_LOG_EXPRESSIONS)); // FIXME - a more appropriate log channel?
  39
  40     if (log) {
  41       log->Printf("AppleObjCExternalASTSource::FindExternalVisibleDeclsByName[%"
  42                   "u] on (ASTContext*)%p Looking for %s in (%sDecl*)%p",
  43                   current_id,
  44                   static_cast<void *>(&decl_ctx->getParentASTContext()),
  45                   name.getAsString().c_str(), decl_ctx->getDeclKindName(),
  46                   static_cast<const void *>(decl_ctx));
  47     }
  48
  49     do {
  50       const clang::ObjCInterfaceDecl *interface_decl =
  51           llvm::dyn_cast<clang::ObjCInterfaceDecl>(decl_ctx);
  52
  53       if (!interface_decl)
  54         break;
  55
  56       clang::ObjCInterfaceDecl *non_const_interface_decl =
  57           const_cast<clang::ObjCInterfaceDecl *>(interface_decl);
  58
  59       if (!m_decl_vendor.FinishDecl(non_const_interface_decl))
  60         break;
  61
  62       clang::DeclContext::lookup_result result =
  63           non_const_interface_decl->lookup(name);
  64
  65       return (result.size() != 0);
  66     } while (0);
  67
  68     SetNoExternalVisibleDeclsForName(decl_ctx, name);
  69     return false;
  70   }
  71
  72   void CompleteType(clang::TagDecl *tag_decl) override {
  73     static unsigned int invocation_id = 0;
  74     unsigned int current_id = invocation_id++;
  75
  76     Log *log(GetLogIfAllCategoriesSet(
  77         LIBLLDB_LOG_EXPRESSIONS)); // FIXME - a more appropriate log channel?
  78
  79     if (log) {
  80       log->Printf("AppleObjCExternalASTSource::CompleteType[%u] on "
  81                   "(ASTContext*)%p Completing (TagDecl*)%p named %s",
  82                   current_id, static_cast<void *>(&tag_decl->getASTContext()),
  83                   static_cast<void *>(tag_decl),
  84                   tag_decl->getName().str().c_str());
  85
  86       log->Printf("  AOEAS::CT[%u] Before:", current_id);
  87       ASTDumper dumper((clang::Decl *)tag_decl);
  88       dumper.ToLog(log, "    [CT] ");
  89     }
  90
  91     if (log) {
  92       log->Printf("  AOEAS::CT[%u] After:", current_id);
  93       ASTDumper dumper((clang::Decl *)tag_decl);
  94       dumper.ToLog(log, "    [CT] ");
  95     }
  96     return;
  97   }
  98
  99   void CompleteType(clang::ObjCInterfaceDecl *interface_decl) override {
 100     static unsigned int invocation_id = 0;
 101     unsigned int current_id = invocation_id++;
 102
 103     Log *log(GetLogIfAllCategoriesSet(
 104         LIBLLDB_LOG_EXPRESSIONS)); // FIXME - a more appropriate log channel?
 105
 106     if (log) {
 107       log->Printf("AppleObjCExternalASTSource::CompleteType[%u] on "
 108                   "(ASTContext*)%p Completing (ObjCInterfaceDecl*)%p named %s",
 109                   current_id,
 110                   static_cast<void *>(&interface_decl->getASTContext()),
 111                   static_cast<void *>(interface_decl),
 112                   interface_decl->getName().str().c_str());
 113
 114       log->Printf("  AOEAS::CT[%u] Before:", current_id);
 115       ASTDumper dumper((clang::Decl *)interface_decl);
 116       dumper.ToLog(log, "    [CT] ");
 117     }
 118
 119     m_decl_vendor.FinishDecl(interface_decl);
 120
 121     if (log) {
 122       log->Printf("  [CT] After:");
 123       ASTDumper dumper((clang::Decl *)interface_decl);
 124       dumper.ToLog(log, "    [CT] ");
 125     }
 126     return;
 127   }
 128
 129   bool layoutRecordType(
 130       const clang::RecordDecl *Record, uint64_t &Size, uint64_t &Alignment,
 131       llvm::DenseMap<const clang::FieldDecl *, uint64_t> &FieldOffsets,
 132       llvm::DenseMap<const clang::CXXRecordDecl *, clang::CharUnits>
 133           &BaseOffsets,
 134       llvm::DenseMap<const clang::CXXRecordDecl *, clang::CharUnits>
 135           &VirtualBaseOffsets) override {
 136     return false;
 137   }
 138
 139   void StartTranslationUnit(clang::ASTConsumer *Consumer) override {
 140     clang::TranslationUnitDecl *translation_unit_decl =
 141         m_decl_vendor.m_ast_ctx.getASTContext()->getTranslationUnitDecl();
 142     translation_unit_decl->setHasExternalVisibleStorage();
 143     translation_unit_decl->setHasExternalLexicalStorage();
 144   }
 145
 146 private:
 147   AppleObjCDeclVendor &m_decl_vendor;
 148 };
 149
 150 AppleObjCDeclVendor::AppleObjCDeclVendor(ObjCLanguageRuntime &runtime)
 151     : DeclVendor(), m_runtime(runtime), m_ast_ctx(runtime.GetProcess()
 152                                                       ->GetTarget()
 153                                                       .GetArchitecture()
 154                                                       .GetTriple()
 155                                                       .getTriple()
 156                                                       .c_str()),
 157       m_type_realizer_sp(m_runtime.GetEncodingToType()) {
 158   m_external_source = new AppleObjCExternalASTSource(*this);
 159   llvm::IntrusiveRefCntPtr<clang::ExternalASTSource> external_source_owning_ptr(
 160       m_external_source);
 161   m_ast_ctx.getASTContext()->setExternalSource(external_source_owning_ptr);
 162 }
 163
 164 clang::ObjCInterfaceDecl *
 165 AppleObjCDeclVendor::GetDeclForISA(ObjCLanguageRuntime::ObjCISA isa) {
 166   ISAToInterfaceMap::const_iterator iter = m_isa_to_interface.find(isa);
 167
 168   if (iter != m_isa_to_interface.end())
 169     return iter->second;
 170
 171   clang::ASTContext *ast_ctx = m_ast_ctx.getASTContext();
 172
 173   ObjCLanguageRuntime::ClassDescriptorSP descriptor =
 174       m_runtime.GetClassDescriptorFromISA(isa);
 175
 176   if (!descriptor)
 177     return NULL;
 178
 179   const ConstString &name(descriptor->GetClassName());
 180
 181   clang::IdentifierInfo &identifier_info =
 182       ast_ctx->Idents.get(name.GetStringRef());
 183
 184   clang::ObjCInterfaceDecl *new_iface_decl = clang::ObjCInterfaceDecl::Create(
 185       *ast_ctx, ast_ctx->getTranslationUnitDecl(), clang::SourceLocation(),
 186       &identifier_info, nullptr, nullptr);
 187
 188   ClangASTMetadata meta_data;
 189   meta_data.SetISAPtr(isa);
 190   m_external_source->SetMetadata(new_iface_decl, meta_data);
 191
 192   new_iface_decl->setHasExternalVisibleStorage();
 193   new_iface_decl->setHasExternalLexicalStorage();
 194
 195   ast_ctx->getTranslationUnitDecl()->addDecl(new_iface_decl);
 196
 197   m_isa_to_interface[isa] = new_iface_decl;
 198
 199   return new_iface_decl;
 200 }
 201
 202 class ObjCRuntimeMethodType {
 203 public:
 204   ObjCRuntimeMethodType(const char *types) : m_is_valid(false) {
 205     const char *cursor = types;
 206     enum ParserState { Start = 0, InType, InPos } state = Start;
 207     const char *type = NULL;
 208     int brace_depth = 0;
 209
 210     uint32_t stepsLeft = 256;
 211
 212     while (1) {
 213       if (--stepsLeft == 0) {
 214         m_is_valid = false;
 215         return;
 216       }
 217
 218       switch (state) {
 219       case Start: {
 220         switch (*cursor) {
 221         default:
 222           state = InType;
 223           type = cursor;
 224           break;
 225         case '\0':
 226           m_is_valid = true;
 227           return;
 228         case '0':
 229         case '1':
 230         case '2':
 231         case '3':
 232         case '4':
 233         case '5':
 234         case '6':
 235         case '7':
 236         case '8':
 237         case '9':
 238           m_is_valid = false;
 239           return;
 240         }
 241       } break;
 242       case InType: {
 243         switch (*cursor) {
 244         default:
 245           ++cursor;
 246           break;
 247         case '0':
 248         case '1':
 249         case '2':
 250         case '3':
 251         case '4':
 252         case '5':
 253         case '6':
 254         case '7':
 255         case '8':
 256         case '9':
 257           if (!brace_depth) {
 258             state = InPos;
 259             if (type) {
 260               m_type_vector.push_back(std::string(type, (cursor - type)));
 261             } else {
 262               m_is_valid = false;
 263               return;
 264             }
 265             type = NULL;
 266           } else {
 267             ++cursor;
 268           }
 269           break;
 270         case '[':
 271         case '{':
 272         case '(':
 273           ++brace_depth;
 274           ++cursor;
 275           break;
 276         case ']':
 277         case '}':
 278         case ')':
 279           if (!brace_depth) {
 280             m_is_valid = false;
 281             return;
 282           }
 283           --brace_depth;
 284           ++cursor;
 285           break;
 286         case '\0':
 287           m_is_valid = false;
 288           return;
 289         }
 290       } break;
 291       case InPos: {
 292         switch (*cursor) {
 293         default:
 294           state = InType;
 295           type = cursor;
 296           break;
 297         case '0':
 298         case '1':
 299         case '2':
 300         case '3':
 301         case '4':
 302         case '5':
 303         case '6':
 304         case '7':
 305         case '8':
 306         case '9':
 307           ++cursor;
 308           break;
 309         case '\0':
 310           m_is_valid = true;
 311           return;
 312         }
 313       } break;
 314       }
 315     }
 316   }
 317
 318   clang::ObjCMethodDecl *
 319   BuildMethod(clang::ObjCInterfaceDecl *interface_decl, const char *name,
 320               bool instance,
 321               ObjCLanguageRuntime::EncodingToTypeSP type_realizer_sp) {
 322     if (!m_is_valid || m_type_vector.size() < 3)
 323       return NULL;
 324
 325     clang::ASTContext &ast_ctx(interface_decl->getASTContext());
 326
 327     clang::QualType return_qual_type;
 328
 329     const bool isInstance = instance;
 330     const bool isVariadic = false;
 331     const bool isSynthesized = false;
 332     const bool isImplicitlyDeclared = true;
 333     const bool isDefined = false;
 334     const clang::ObjCMethodDecl::ImplementationControl impControl =
 335         clang::ObjCMethodDecl::None;
 336     const bool HasRelatedResultType = false;
 337     const bool for_expression = true;
 338
 339     std::vector<clang::IdentifierInfo *> selector_components;
 340
 341     const char *name_cursor = name;
 342     bool is_zero_argument = true;
 343
 344     while (*name_cursor != '\0') {
 345       const char *colon_loc = strchr(name_cursor, ':');
 346       if (!colon_loc) {
 347         selector_components.push_back(
 348             &ast_ctx.Idents.get(llvm::StringRef(name_cursor)));
 349         break;
 350       } else {
 351         is_zero_argument = false;
 352         selector_components.push_back(&ast_ctx.Idents.get(
 353             llvm::StringRef(name_cursor, colon_loc - name_cursor)));
 354         name_cursor = colon_loc + 1;
 355       }
 356     }
 357
 358     clang::Selector sel = ast_ctx.Selectors.getSelector(
 359         is_zero_argument ? 0 : selector_components.size(),
 360         selector_components.data());
 361
 362     clang::QualType ret_type =
 363         ClangUtil::GetQualType(type_realizer_sp->RealizeType(
 364             interface_decl->getASTContext(), m_type_vector[0].c_str(),
 365             for_expression));
 366
 367     if (ret_type.isNull())
 368       return NULL;
 369
 370     clang::ObjCMethodDecl *ret = clang::ObjCMethodDecl::Create(
 371         ast_ctx, clang::SourceLocation(), clang::SourceLocation(), sel,
 372         ret_type, NULL, interface_decl, isInstance, isVariadic, isSynthesized,
 373         isImplicitlyDeclared, isDefined, impControl, HasRelatedResultType);
 374
 375     std::vector<clang::ParmVarDecl *> parm_vars;
 376
 377     for (size_t ai = 3, ae = m_type_vector.size(); ai != ae; ++ai) {
 378       const bool for_expression = true;
 379       clang::QualType arg_type =
 380           ClangUtil::GetQualType(type_realizer_sp->RealizeType(
 381               ast_ctx, m_type_vector[ai].c_str(), for_expression));
 382
 383       if (arg_type.isNull())
 384         return NULL; // well, we just wasted a bunch of time.  Wish we could
 385                      // delete the stuff we'd just made!
 386
 387       parm_vars.push_back(clang::ParmVarDecl::Create(
 388           ast_ctx, ret, clang::SourceLocation(), clang::SourceLocation(), NULL,
 389           arg_type, NULL, clang::SC_None, NULL));
 390     }
 391
 392     ret->setMethodParams(ast_ctx,
 393                          llvm::ArrayRef<clang::ParmVarDecl *>(parm_vars),
 394                          llvm::ArrayRef<clang::SourceLocation>());
 395
 396     return ret;
 397   }
 398
 399   explicit operator bool() { return m_is_valid; }
 400
 401   size_t GetNumTypes() { return m_type_vector.size(); }
 402
 403   const char *GetTypeAtIndex(size_t idx) { return m_type_vector[idx].c_str(); }
 404
 405 private:
 406   typedef std::vector<std::string> TypeVector;
 407
 408   TypeVector m_type_vector;
 409   bool m_is_valid;
 410 };
 411
 412 bool AppleObjCDeclVendor::FinishDecl(clang::ObjCInterfaceDecl *interface_decl) {
 413   Log *log(GetLogIfAllCategoriesSet(
 414       LIBLLDB_LOG_EXPRESSIONS)); // FIXME - a more appropriate log channel?
 415
 416   ClangASTMetadata *metadata = m_external_source->GetMetadata(interface_decl);
 417   ObjCLanguageRuntime::ObjCISA objc_isa = 0;
 418   if (metadata)
 419     objc_isa = metadata->GetISAPtr();
 420
 421   if (!objc_isa)
 422     return false;
 423
 424   if (!interface_decl->hasExternalVisibleStorage())
 425     return true;
 426
 427   interface_decl->startDefinition();
 428
 429   interface_decl->setHasExternalVisibleStorage(false);
 430   interface_decl->setHasExternalLexicalStorage(false);
 431
 432   ObjCLanguageRuntime::ClassDescriptorSP descriptor =
 433       m_runtime.GetClassDescriptorFromISA(objc_isa);
 434
 435   if (!descriptor)
 436     return false;
 437
 438   auto superclass_func = [interface_decl,
 439                           this](ObjCLanguageRuntime::ObjCISA isa) {
 440     clang::ObjCInterfaceDecl *superclass_decl = GetDeclForISA(isa);
 441
 442     if (!superclass_decl)
 443       return;
 444
 445     FinishDecl(superclass_decl);
 446     clang::ASTContext *context = m_ast_ctx.getASTContext();
 447     interface_decl->setSuperClass(context->getTrivialTypeSourceInfo(
 448         context->getObjCInterfaceType(superclass_decl)));
 449   };
 450
 451   auto instance_method_func =
 452       [log, interface_decl, this](const char *name, const char *types) -> bool {
 453     if (!name || !types)
 454       return false; // skip this one
 455
 456     ObjCRuntimeMethodType method_type(types);
 457
 458     clang::ObjCMethodDecl *method_decl =
 459         method_type.BuildMethod(interface_decl, name, true, m_type_realizer_sp);
 460
 461     if (log)
 462       log->Printf("[  AOTV::FD] Instance method [%s] [%s]", name, types);
 463
 464     if (method_decl)
 465       interface_decl->addDecl(method_decl);
 466
 467     return false;
 468   };
 469
 470   auto class_method_func = [log, interface_decl,
 471                             this](const char *name, const char *types) -> bool {
 472     if (!name || !types)
 473       return false; // skip this one
 474
 475     ObjCRuntimeMethodType method_type(types);
 476
 477     clang::ObjCMethodDecl *method_decl = method_type.BuildMethod(
 478         interface_decl, name, false, m_type_realizer_sp);
 479
 480     if (log)
 481       log->Printf("[  AOTV::FD] Class method [%s] [%s]", name, types);
 482
 483     if (method_decl)
 484       interface_decl->addDecl(method_decl);
 485
 486     return false;
 487   };
 488
 489   auto ivar_func = [log, interface_decl,
 490                     this](const char *name, const char *type,
 491                           lldb::addr_t offset_ptr, uint64_t size) -> bool {
 492     if (!name || !type)
 493       return false;
 494
 495     const bool for_expression = false;
 496
 497     if (log)
 498       log->Printf(
 499           "[  AOTV::FD] Instance variable [%s] [%s], offset at %" PRIx64, name,
 500           type, offset_ptr);
 501
 502     CompilerType ivar_type = m_runtime.GetEncodingToType()->RealizeType(
 503         m_ast_ctx, type, for_expression);
 504
 505     if (ivar_type.IsValid()) {
 506       clang::TypeSourceInfo *const type_source_info = nullptr;
 507       const bool is_synthesized = false;
 508       clang::ObjCIvarDecl *ivar_decl = clang::ObjCIvarDecl::Create(
 509           *m_ast_ctx.getASTContext(), interface_decl, clang::SourceLocation(),
 510           clang::SourceLocation(), &m_ast_ctx.getASTContext()->Idents.get(name),
 511           ClangUtil::GetQualType(ivar_type),
 512           type_source_info, // TypeSourceInfo *
 513           clang::ObjCIvarDecl::Public, 0, is_synthesized);
 514
 515       if (ivar_decl) {
 516         interface_decl->addDecl(ivar_decl);
 517       }
 518     }
 519
 520     return false;
 521   };
 522
 523   if (log) {
 524     ASTDumper method_dumper((clang::Decl *)interface_decl);
 525
 526     log->Printf("[AppleObjCDeclVendor::FinishDecl] Finishing Objective-C "
 527                 "interface for %s",
 528                 descriptor->GetClassName().AsCString());
 529   }
 530
 531   if (!descriptor->Describe(superclass_func, instance_method_func,
 532                             class_method_func, ivar_func))
 533     return false;
 534
 535   if (log) {
 536     ASTDumper method_dumper((clang::Decl *)interface_decl);
 537
 538     log->Printf(
 539         "[AppleObjCDeclVendor::FinishDecl] Finished Objective-C interface");
 540
 541     method_dumper.ToLog(log, "  [AOTV::FD] ");
 542   }
 543
 544   return true;
 545 }
 546
 547 uint32_t
 548 AppleObjCDeclVendor::FindDecls(const ConstString &name, bool append,
 549                                uint32_t max_matches,
 550                                std::vector<clang::NamedDecl *> &decls) {
 551   static unsigned int invocation_id = 0;
 552   unsigned int current_id = invocation_id++;
 553
 554   Log *log(GetLogIfAllCategoriesSet(
 555       LIBLLDB_LOG_EXPRESSIONS)); // FIXME - a more appropriate log channel?
 556
 557   if (log)
 558     log->Printf("AppleObjCDeclVendor::FindTypes [%u] ('%s', %s, %u, )",
 559                 current_id, (const char *)name.AsCString(),
 560                 append ? "true" : "false", max_matches);
 561
 562   if (!append)
 563     decls.clear();
 564
 565   uint32_t ret = 0;
 566
 567   do {
 568     // See if the type is already in our ASTContext.
 569
 570     clang::ASTContext *ast_ctx = m_ast_ctx.getASTContext();
 571
 572     clang::IdentifierInfo &identifier_info =
 573         ast_ctx->Idents.get(name.GetStringRef());
 574     clang::DeclarationName decl_name =
 575         ast_ctx->DeclarationNames.getIdentifier(&identifier_info);
 576
 577     clang::DeclContext::lookup_result lookup_result =
 578         ast_ctx->getTranslationUnitDecl()->lookup(decl_name);
 579
 580     if (!lookup_result.empty()) {
 581       if (clang::ObjCInterfaceDecl *result_iface_decl =
 582               llvm::dyn_cast<clang::ObjCInterfaceDecl>(lookup_result[0])) {
 583         if (log) {
 584           clang::QualType result_iface_type =
 585               ast_ctx->getObjCInterfaceType(result_iface_decl);
 586           ASTDumper dumper(result_iface_type);
 587
 588           uint64_t isa_value = LLDB_INVALID_ADDRESS;
 589           ClangASTMetadata *metadata =
 590               m_external_source->GetMetadata(result_iface_decl);
 591           if (metadata)
 592             isa_value = metadata->GetISAPtr();
 593
 594           log->Printf("AOCTV::FT [%u] Found %s (isa 0x%" PRIx64
 595                       ") in the ASTContext",
 596                       current_id, dumper.GetCString(), isa_value);
 597         }
 598
 599         decls.push_back(result_iface_decl);
 600         ret++;
 601         break;
 602       } else {
 603         if (log)
 604           log->Printf("AOCTV::FT [%u] There's something in the ASTContext, but "
 605                       "it's not something we know about",
 606                       current_id);
 607         break;
 608       }
 609     } else if (log) {
 610       log->Printf("AOCTV::FT [%u] Couldn't find %s in the ASTContext",
 611                   current_id, name.AsCString());
 612     }
 613
 614     // It's not.  If it exists, we have to put it into our ASTContext.
 615
 616     ObjCLanguageRuntime::ObjCISA isa = m_runtime.GetISA(name);
 617
 618     if (!isa) {
 619       if (log)
 620         log->Printf("AOCTV::FT [%u] Couldn't find the isa", current_id);
 621
 622       break;
 623     }
 624
 625     clang::ObjCInterfaceDecl *iface_decl = GetDeclForISA(isa);
 626
 627     if (!iface_decl) {
 628       if (log)
 629         log->Printf("AOCTV::FT [%u] Couldn't get the Objective-C interface for "
 630                     "isa 0x%" PRIx64,
 631                     current_id, (uint64_t)isa);
 632
 633       break;
 634     }
 635
 636     if (log) {
 637       clang::QualType new_iface_type =
 638           ast_ctx->getObjCInterfaceType(iface_decl);
 639       ASTDumper dumper(new_iface_type);
 640       log->Printf("AOCTV::FT [%u] Created %s (isa 0x%" PRIx64 ")", current_id,
 641                   dumper.GetCString(), (uint64_t)isa);
 642     }
 643
 644     decls.push_back(iface_decl);
 645     ret++;
 646     break;
 647   } while (0);
 648
 649   return ret;
 650 }