Merge commit '4a0987a19d34' from swift/release/5.4 into swift/main

git apple-llvm automerger · git apple-llvm automerger · commit 64e84164a095 · 2021-01-15T16:36:07.000-08:00
diff --git a/lldb/include/lldb/Symbol/CompilerType.h b/lldb/include/lldb/Symbol/CompilerType.h
@@ -290,7 +290,7 @@ class CompilerType {
       std::function<bool(const CompilerType &integer_type, ConstString name,
                          const llvm::APSInt &value)> const &callback) const;
 
-  uint32_t GetNumFields() const;
+  uint32_t GetNumFields(ExecutionContext *exe_ctx = nullptr) const;
 
   CompilerType GetFieldAtIndex(size_t idx, std::string &name,
                                uint64_t *bit_offset_ptr,
diff --git a/lldb/include/lldb/Symbol/TypeSystem.h b/lldb/include/lldb/Symbol/TypeSystem.h
@@ -320,7 +320,8 @@ class TypeSystem : public PluginInterface {
                          ConstString name,
                          const llvm::APSInt &value)> const &callback) {}
 
-  virtual uint32_t GetNumFields(lldb::opaque_compiler_type_t type) = 0;
+  virtual uint32_t GetNumFields(lldb::opaque_compiler_type_t type,
+                                ExecutionContext *exe_ctx = nullptr) = 0;
 
   virtual CompilerType GetFieldAtIndex(lldb::opaque_compiler_type_t type,
                                        size_t idx, std::string &name,
diff --git a/lldb/include/lldb/Target/SwiftLanguageRuntime.h b/lldb/include/lldb/Target/SwiftLanguageRuntime.h
@@ -270,6 +270,10 @@ class SwiftLanguageRuntime : public LanguageRuntime {
       bool &child_is_deref_of_parent, ValueObject *valobj,
       uint64_t &language_flags);
 
+  /// Ask Remote Mirrors about the fields of a composite type.
+  llvm::Optional<unsigned> GetNumFields(CompilerType type,
+                                        ExecutionContext *exe_ctx);
+
   /// Ask Remote Mirrors for the size of a Swift type.
   llvm::Optional<uint64_t> GetBitSize(CompilerType type,
                                       ExecutionContextScope *exe_scope);
diff --git a/lldb/source/Plugins/Language/Swift/SwiftLanguage.cpp b/lldb/source/Plugins/Language/Swift/SwiftLanguage.cpp
@@ -789,7 +789,8 @@ SwiftLanguage::GetHardcodedSynthetics() {
                   is_imported = true;
               }
 
-              if (is_imported && type.GetNumFields() == 0)
+              ExecutionContext exe_ctx(valobj.GetExecutionContextRef());
+              if (is_imported && type.GetNumFields(&exe_ctx) == 0)
                 return true;
               if (valobj.IsBaseClass() && type.IsRuntimeGeneratedType()) {
                 auto parent(valobj.GetParent());
diff --git a/lldb/source/Plugins/TypeSystem/Clang/TypeSystemClang.cpp b/lldb/source/Plugins/TypeSystem/Clang/TypeSystemClang.cpp
@@ -5416,7 +5416,8 @@ void TypeSystemClang::ForEachEnumerator(
 
 #pragma mark Aggregate Types
 
-uint32_t TypeSystemClang::GetNumFields(lldb::opaque_compiler_type_t type) {
+uint32_t TypeSystemClang::GetNumFields(lldb::opaque_compiler_type_t type,
+                                       ExecutionContext *exe_ctx) {
   if (!type)
     return 0;
 
diff --git a/lldb/source/Plugins/TypeSystem/Clang/TypeSystemClang.h b/lldb/source/Plugins/TypeSystem/Clang/TypeSystemClang.h
@@ -788,7 +788,8 @@ class TypeSystemClang : public TypeSystem {
                          ConstString name,
                          const llvm::APSInt &value)> const &callback) override;
 
-  uint32_t GetNumFields(lldb::opaque_compiler_type_t type) override;
+  uint32_t GetNumFields(lldb::opaque_compiler_type_t type,
+                        ExecutionContext *exe_ctx = nullptr) override;
 
   CompilerType GetFieldAtIndex(lldb::opaque_compiler_type_t type, size_t idx,
                                std::string &name, uint64_t *bit_offset_ptr,
diff --git a/lldb/source/Plugins/TypeSystem/Swift/SwiftASTContext.cpp b/lldb/source/Plugins/TypeSystem/Swift/SwiftASTContext.cpp
@@ -6384,7 +6384,8 @@ SwiftASTContext::GetNumDirectBaseClasses(opaque_compiler_type_t opaque_type) {
   return 0;
 }
 
-uint32_t SwiftASTContext::GetNumFields(opaque_compiler_type_t type) {
+uint32_t SwiftASTContext::GetNumFields(opaque_compiler_type_t type,
+                                       ExecutionContext *exe_ctx) {
   VALID_OR_RETURN(0);
 
   if (!type)
diff --git a/lldb/source/Plugins/TypeSystem/Swift/SwiftASTContext.h b/lldb/source/Plugins/TypeSystem/Swift/SwiftASTContext.h
@@ -586,7 +586,8 @@ class SwiftASTContext : public TypeSystemSwift {
                           bool omit_empty_base_classes,
                           const ExecutionContext *exe_ctx) override;
 
-  uint32_t GetNumFields(lldb::opaque_compiler_type_t type) override;
+  uint32_t GetNumFields(lldb::opaque_compiler_type_t type,
+                        ExecutionContext *exe_ctx = nullptr) override;
 
   CompilerType GetFieldAtIndex(lldb::opaque_compiler_type_t type, size_t idx,
                                std::string &name, uint64_t *bit_offset_ptr,
diff --git a/lldb/source/Plugins/TypeSystem/Swift/TypeSystemSwiftTypeRef.cpp b/lldb/source/Plugins/TypeSystem/Swift/TypeSystemSwiftTypeRef.cpp
@@ -2231,9 +2231,31 @@ TypeSystemSwiftTypeRef::GetNumChildren(opaque_compiler_type_t type,
         ReconstructType(type), omit_empty_base_classes, exe_ctx);
 }
 
-uint32_t TypeSystemSwiftTypeRef::GetNumFields(opaque_compiler_type_t type) {
-  return m_swift_ast_context->GetNumFields(ReconstructType(type));
+uint32_t TypeSystemSwiftTypeRef::GetNumFields(opaque_compiler_type_t type,
+                                              ExecutionContext *exe_ctx) {
+  if (exe_ctx)
+    if (auto *runtime = SwiftLanguageRuntime::Get(exe_ctx->GetProcessSP()))
+      if (auto num_fields =
+              runtime->GetNumFields(GetCanonicalType(type), exe_ctx))
+        // Use a lambda to intercept & unwrap the `Optional` return value from
+        // `SwiftLanguageRuntime::GetNumFields`.
+        return [&] {
+          auto impl = [&]() -> llvm::Optional<uint32_t> {
+            if (!type)
+              return 0;
+            return num_fields;
+          };
+          VALIDATE_AND_RETURN(impl, GetNumFields, type,
+                              (ReconstructType(type), exe_ctx));
+        }().getValue();
+
+  LLDB_LOGF(GetLogIfAllCategoriesSet(LIBLLDB_LOG_TYPES),
+            "Using SwiftASTContext::GetNumFields fallback for type %s",
+            AsMangledName(type));
+
+  return m_swift_ast_context->GetNumFields(ReconstructType(type), exe_ctx);
 }
+
 CompilerType TypeSystemSwiftTypeRef::GetFieldAtIndex(
     opaque_compiler_type_t type, size_t idx, std::string &name,
     uint64_t *bit_offset_ptr, uint32_t *bitfield_bit_size_ptr,
diff --git a/lldb/source/Plugins/TypeSystem/Swift/TypeSystemSwiftTypeRef.h b/lldb/source/Plugins/TypeSystem/Swift/TypeSystemSwiftTypeRef.h
@@ -152,7 +152,8 @@ class TypeSystemSwiftTypeRef : public TypeSystemSwift {
   uint32_t GetNumChildren(lldb::opaque_compiler_type_t type,
                           bool omit_empty_base_classes,
                           const ExecutionContext *exe_ctx) override;
-  uint32_t GetNumFields(lldb::opaque_compiler_type_t type) override;
+  uint32_t GetNumFields(lldb::opaque_compiler_type_t type,
+                        ExecutionContext *exe_ctx = nullptr) override;
   CompilerType GetFieldAtIndex(lldb::opaque_compiler_type_t type, size_t idx,
                                std::string &name, uint64_t *bit_offset_ptr,
                                uint32_t *bitfield_bit_size_ptr,
diff --git a/lldb/source/Symbol/CompilerType.cpp b/lldb/source/Symbol/CompilerType.cpp
@@ -538,10 +538,10 @@ void CompilerType::ForEachEnumerator(
     return m_type_system->ForEachEnumerator(m_type, callback);
 }
 
-uint32_t CompilerType::GetNumFields() const {
+uint32_t CompilerType::GetNumFields(ExecutionContext *exe_ctx) const {
   if (!IsValid())
     return 0;
-  return m_type_system->GetNumFields(m_type);
+  return m_type_system->GetNumFields(m_type, exe_ctx);
 }
 
 CompilerType CompilerType::GetFieldAtIndex(size_t idx, std::string &name,
diff --git a/lldb/source/Target/SwiftLanguageRuntime.cpp b/lldb/source/Target/SwiftLanguageRuntime.cpp
@@ -278,6 +278,12 @@ class SwiftLanguageRuntimeStub {
     return {};
   }
 
+  llvm::Optional<unsigned> GetNumFields(CompilerType type,
+                                        ExecutionContext *exe_ctx) {
+    STUB_LOG();
+    return {};
+  }
+
   bool GetObjectDescription(Stream &str, ValueObject &object) {
     STUB_LOG();
     return false;
@@ -2185,6 +2191,12 @@ CompilerType SwiftLanguageRuntime::GetChildCompilerTypeAtIndex(
           language_flags);
 }
 
+llvm::Optional<unsigned>
+SwiftLanguageRuntime::GetNumFields(CompilerType type,
+                                   ExecutionContext *exe_ctx) {
+  FORWARD(GetNumFields, type, exe_ctx);
+}
+
 bool SwiftLanguageRuntime::GetObjectDescription(Stream &str,
                                                 ValueObject &object) {
   FORWARD(GetObjectDescription, str, object);
diff --git a/lldb/source/Target/SwiftLanguageRuntimeDynamicTypeResolution.cpp b/lldb/source/Target/SwiftLanguageRuntimeDynamicTypeResolution.cpp
@@ -1093,6 +1093,70 @@ SwiftLanguageRuntimeImpl::GetNumChildren(CompilerType type,
   return {};
 }
 
+llvm::Optional<unsigned>
+SwiftLanguageRuntimeImpl::GetNumFields(CompilerType type,
+                                       ExecutionContext *exe_ctx) {
+  auto *ts =
+      llvm::dyn_cast_or_null<TypeSystemSwiftTypeRef>(type.GetTypeSystem());
+  if (!ts)
+    return {};
+
+  using namespace swift::reflection;
+  // Try the static type metadata.
+  const TypeRef *tr = nullptr;
+  auto *ti = GetTypeInfo(type, exe_ctx->GetFramePtr(), &tr);
+  // Structs and Tuples.
+  switch (ti->getKind()) {
+  case TypeInfoKind::Record: {
+    // Structs and Tuples.
+    auto *rti = llvm::cast<RecordTypeInfo>(ti);
+    switch (rti->getRecordKind()) {
+    case RecordKind::ExistentialMetatype:
+    case RecordKind::ThickFunction:
+      // There are two fields, `function` and `context`, but they're not exposed
+      // by lldb.
+      return 0;
+    case RecordKind::OpaqueExistential:
+      // `OpaqueExistential` is documented as:
+      //     An existential is a three-word buffer followed by value metadata...
+      // The buffer is exposed as fields named `payload_data_{0,1,2}`, and
+      // the number of fields are increased to match.
+      return rti->getNumFields() + 3;
+    default:
+      return rti->getNumFields();
+    }
+  }
+  case TypeInfoKind::Enum: {
+    auto *eti = llvm::cast<EnumTypeInfo>(ti);
+    return eti->getNumPayloadCases();
+  }
+  case TypeInfoKind::Reference: {
+    // Objects.
+    auto *rti = llvm::cast<ReferenceTypeInfo>(ti);
+    switch (rti->getReferenceKind()) {
+    case ReferenceKind::Weak:
+    case ReferenceKind::Unowned:
+    case ReferenceKind::Unmanaged:
+      if (auto referent = GetWeakReferent(*ts, type))
+        return referent.GetNumFields(exe_ctx);
+      return 0;
+    case ReferenceKind::Strong:
+      TypeConverter tc(GetReflectionContext()->getBuilder());
+      LLDBTypeInfoProvider tip(*this, *ts);
+      auto *cti = tc.getClassInstanceTypeInfo(tr, 0, &tip);
+      if (auto *rti = llvm::dyn_cast_or_null<RecordTypeInfo>(cti)) {
+        return rti->getNumFields();
+      }
+
+      return {};
+    }
+  }
+  default:
+    // FIXME: Implement more cases.
+    return {};
+  }
+}
+
 /// Return the base name of the topmost nominal type.
 static llvm::StringRef GetBaseName(swift::Demangle::NodePointer node) {
   if (!node)
diff --git a/lldb/source/Target/SwiftLanguageRuntimeImpl.h b/lldb/source/Target/SwiftLanguageRuntimeImpl.h
@@ -120,6 +120,9 @@ class SwiftLanguageRuntimeImpl {
   llvm::Optional<unsigned> GetNumChildren(CompilerType type,
                                           ValueObject *valobj);
 
+  llvm::Optional<unsigned> GetNumFields(CompilerType type,
+                                        ExecutionContext *exe_ctx);
+
   llvm::Optional<size_t> GetIndexOfChildMemberWithName(
       CompilerType type, llvm::StringRef name, ExecutionContext *exe_ctx,
       bool omit_empty_base_classes, std::vector<uint32_t> &child_indexes);

Original file line number	Diff line number	Diff line change
`@@ -789,7 +789,8 @@ SwiftLanguage::GetHardcodedSynthetics() {`
`789`	`789`	`is_imported = true;`
`790`	`790`	`}`
`791`	`791`
`792`		`- if (is_imported && type.GetNumFields() == 0)`
	`792`	`+ ExecutionContext exe_ctx(valobj.GetExecutionContextRef());`
	`793`	`+ if (is_imported && type.GetNumFields(&exe_ctx) == 0)`
`793`	`794`	`return true;`
`794`	`795`	`if (valobj.IsBaseClass() && type.IsRuntimeGeneratedType()) {`
`795`	`796`	`auto parent(valobj.GetParent());`
Original file line number	Diff line number	Diff line change
`@@ -6384,7 +6384,8 @@ SwiftASTContext::GetNumDirectBaseClasses(opaque_compiler_type_t opaque_type) {`
`6384`	`6384`	`return 0;`
`6385`	`6385`	`}`
`6386`	`6386`
`6387`		`-uint32_t SwiftASTContext::GetNumFields(opaque_compiler_type_t type) {`
	`6387`	`+uint32_t SwiftASTContext::GetNumFields(opaque_compiler_type_t type,`
	`6388`	`+ ExecutionContext *exe_ctx) {`
`6388`	`6389`	`VALID_OR_RETURN(0);`
`6389`	`6390`
`6390`	`6391`	`if (!type)`