Reflection: Add dumping of capture descriptors to swift-reflection-dump

The tests show that there's some round-tripping issue; I will investigate
this next.

Author: slavapestov

include/swift/Reflection/TypeRefBuilder.h

@@ -19,6 +19,7 @@
 #define SWIFT_REFLECTION_TYPEREFBUILDER_H
 
 #include "swift/Remote/MetadataReader.h"
+#include "swift/Reflection/MetadataSourceBuilder.h"
 #include "swift/Reflection/Records.h"
 #include "swift/Reflection/TypeLowering.h"
 #include "swift/Reflection/TypeRef.h"
@@ -80,6 +81,14 @@ struct ReflectionInfo {
   GenericSection reflstr;
 };
 
+struct ClosureContextInfo {
+  std::vector<const TypeRef *> CaptureTypes;
+  std::vector<std::pair<const TypeRef *, const MetadataSource *>> MetadataSources;
+  unsigned NumBindings = 0;
+
+  void dump(std::ostream &OS);
+};
+
 /// An implementation of MetadataReader's BuilderType concept for
 /// building TypeRefs, and parsing field metadata from any images
 /// it has been made aware of.
@@ -105,6 +114,7 @@ class TypeRefBuilder {
   std::vector<std::unique_ptr<const TypeRef>> TypeRefPool;
 
   TypeConverter TC;
+  MetadataSourceBuilder MSB;
 
 #define TYPEREF(Id, Parent) \
   std::unordered_map<TypeRefID, const Id##TypeRef *, \
@@ -275,6 +285,9 @@ class TypeRefBuilder {
   /// Get the primitive type lowering for a builtin type.
   const BuiltinTypeDescriptor *getBuiltinTypeInfo(const TypeRef *TR);
 
+  /// Get the unsubstituted capture types for a closure context.
+  ClosureContextInfo getClosureContextInfo(const CaptureDescriptor &CD);
+
   ///
   /// Dumping typerefs, field declarations, associated types
   ///
@@ -284,6 +297,7 @@ class TypeRefBuilder {
   void dumpFieldSection(std::ostream &OS);
   void dumpAssociatedTypeSection(std::ostream &OS);
   void dumpBuiltinTypeSection(std::ostream &OS);
+  void dumpCaptureSection(std::ostream &OS);
   void dumpAllSections(std::ostream &OS);
 };
 

stdlib/public/Reflection/TypeRefBuilder.cpp

@@ -152,8 +152,45 @@ TypeRefBuilder::getBuiltinTypeInfo(const TypeRef *TR) {
   return nullptr;
 }
 
+/// Get the unsubstituted capture types for a closure context.
+ClosureContextInfo
+TypeRefBuilder::getClosureContextInfo(const CaptureDescriptor &CD) {
+  ClosureContextInfo Info;
+
+  for (auto i = CD.capture_begin(), e = CD.capture_end(); i != e; ++i) {
+    const TypeRef *TR = nullptr;
+    if (i->hasMangledTypeName()) {
+      auto MangledName = i->getMangledTypeName();
+      auto DemangleTree = Demangle::demangleTypeAsNode(MangledName);
+      TR = swift::remote::decodeMangledType(*this, DemangleTree);
+    }
+    Info.CaptureTypes.push_back(TR);
+  }
+
+  for (auto i = CD.source_begin(), e = CD.source_end(); i != e; ++i) {
+    const TypeRef *TR = nullptr;
+    if (i->hasMangledTypeName()) {
+      auto MangledName = i->getMangledTypeName();
+      auto DemangleTree = Demangle::demangleTypeAsNode(MangledName);
+      TR = swift::remote::decodeMangledType(*this, DemangleTree);
+    }
+
+    const MetadataSource *MS = nullptr;
+    if (i->hasMangledMetadataSource()) {
+      auto MangledMetadataSource = i->getMangledMetadataSource();
+      MS = MetadataSource::decode(MSB, MangledMetadataSource);
+    }
+
+    Info.MetadataSources.push_back({TR, MS});
+  }
+
+  Info.NumBindings = CD.NumBindings;
+
+  return Info;
+}
+
 ///
-/// Dumping typerefs, field declarations, associated types
+/// Dumping reflection metadata
 ///
 
 void
@@ -228,6 +265,36 @@ void TypeRefBuilder::dumpBuiltinTypeSection(std::ostream &OS) {
   }
 }
 
+void ClosureContextInfo::dump(std::ostream &OS) {
+  OS << "- Capture types:\n";
+  for (auto *TR : CaptureTypes) {
+    if (TR == nullptr)
+      OS << "!!! Invalid typeref\n";
+    else
+      TR->dump(OS);
+  }
+  OS << "- Metadata sources:\n";
+  for (auto MS : MetadataSources) {
+    if (MS.first == nullptr)
+      OS << "!!! Invalid typeref\n";
+    else
+      MS.first->dump(OS);
+    if (MS.second == nullptr)
+      OS << "!!! Invalid matadata source\n";
+    else
+      MS.second->dump(OS);
+  }
+}
+
+void TypeRefBuilder::dumpCaptureSection(std::ostream &OS) {
+  for (const auto &sections : ReflectionInfos) {
+    for (const auto &descriptor : sections.capture) {
+      auto info = getClosureContextInfo(descriptor);
+      info.dump(OS);
+    }
+  }
+}
+
 void TypeRefBuilder::dumpAllSections(std::ostream &OS) {
   OS << "FIELDS:\n";
   OS << "=======\n";
@@ -241,4 +308,8 @@ void TypeRefBuilder::dumpAllSections(std::ostream &OS) {
   OS << "==============\n";
   dumpBuiltinTypeSection(OS);
   OS << '\n';
+  OS << "CAPTURE DESCRIPTORS:\n";
+  OS << "====================\n";
+  dumpCaptureSection(OS);
+  OS << '\n';
 }

test/Reflection/Inputs/Closures.swift

@@ -0,0 +1,5 @@
+
+public func makeSomeClosures<T, U>(t: T, x: Int, y: C1<U>)
+    -> (() -> (), () -> (), () -> ()) {
+  return ({ _ = t }, { _ = x }, { _ = y })
+}

test/Reflection/typeref_decoding.result.txt

@@ -657,3 +657,25 @@ typealias Result = Swift.Int
 BUILTIN TYPES:
 ==============
 
+CAPTURE DESCRIPTORS:
+====================
+- Capture types:
+!!! Invalid typeref
+- Metadata sources:
+(generic_type_parameter depth=0 index=0)
+(closure_binding index=0)
+- Capture types:
+(struct Swift.Int)
+- Metadata sources:
+(generic_type_parameter depth=0 index=0)
+!!! Invalid matadata source
+- Capture types:
+(bound_generic_class TypesToReflect.C1
+  (generic_type_parameter depth=0 index=1))
+- Metadata sources:
+(generic_type_parameter depth=0 index=0)
+(closure_binding index=0)
+(generic_type_parameter depth=0 index=1)
+(generic_argument index=0
+  (reference_capture index=1))
+

test/Reflection/typeref_decoding.swift

@@ -1,4 +1,4 @@
 // RUN: rm -rf %t && mkdir -p %t
-// RUN: %target-build-swift %S/Inputs/ConcreteTypes.swift %S/Inputs/GenericTypes.swift %S/Inputs/Protocols.swift %S/Inputs/Extensions.swift -parse-as-library -emit-module -emit-library -module-name TypesToReflect -Xfrontend -enable-reflection-metadata -Xfrontend -enable-reflection-names -o %t/libTypesToReflect.%target-dylib-extension
+// RUN: %target-build-swift %S/Inputs/ConcreteTypes.swift %S/Inputs/GenericTypes.swift %S/Inputs/Protocols.swift %S/Inputs/Extensions.swift %S/Inputs/Closures.swift -parse-as-library -emit-module -emit-library -module-name TypesToReflect -Xfrontend -enable-reflection-metadata -Xfrontend -enable-reflection-names -o %t/libTypesToReflect.%target-dylib-extension
 // RUN: %target-swift-reflection-dump -binary-filename %t/libTypesToReflect.%target-dylib-extension > %t/typeref_decoding.txt
 // RUN: diff -u %S/typeref_decoding.result.txt %t/typeref_decoding.txt

test/Reflection/typeref_decoding_objc.result.txt

@@ -46,3 +46,39 @@ ASSOCIATED TYPES:
 BUILTIN TYPES:
 ==============
 
+CAPTURE DESCRIPTORS:
+====================
+- Capture types:
+(struct Swift.StaticString)
+(struct Swift.StaticString)
+(struct Swift.UInt)
+(struct Swift.UInt)
+- Metadata sources:
+- Capture types:
+- Metadata sources:
+!!! Invalid typeref
+!!! Invalid matadata source
+- Capture types:
+(struct Swift.StaticString)
+(bound_generic_struct Swift.UnsafeBufferPointer
+  (struct Swift.UInt8))
+(struct Swift.UInt)
+(struct Swift.UInt)
+- Metadata sources:
+- Capture types:
+- Metadata sources:
+!!! Invalid typeref
+!!! Invalid matadata source
+- Capture types:
+(bound_generic_struct Swift.UnsafeBufferPointer
+  (struct Swift.UInt8))
+(bound_generic_struct Swift.UnsafeBufferPointer
+  (struct Swift.UInt8))
+(struct Swift.UInt)
+(struct Swift.UInt)
+- Metadata sources:
+- Capture types:
+- Metadata sources:
+!!! Invalid typeref
+!!! Invalid matadata source
+