Reflection: Plumb through capture descriptor section

Author: slavapestov

include/swift/Reflection/Records.h

@@ -364,6 +364,184 @@ class BuiltinTypeDescriptorIterator
   }
 };
 
+class CaptureTypeRecord {
+  const RelativeDirectPointer<const char> MangledTypeName;
+
+public:
+  CaptureTypeRecord() = delete;
+
+  bool hasMangledTypeName() const {
+    return MangledTypeName;
+  }
+
+  std::string getMangledTypeName() const {
+    return MangledTypeName.get();
+  }
+};
+
+struct CaptureTypeRecordIterator {
+  const CaptureTypeRecord *Cur;
+  const CaptureTypeRecord * const End;
+
+  CaptureTypeRecordIterator(const CaptureTypeRecord *Cur,
+                            const CaptureTypeRecord * const End)
+    : Cur(Cur), End(End) {}
+
+  const CaptureTypeRecord &operator*() const {
+    return *Cur;
+  }
+
+  const CaptureTypeRecord *operator->() const {
+    return Cur;
+  }
+
+  CaptureTypeRecordIterator &operator++() {
+    ++Cur;
+    return *this;
+  }
+
+  bool operator==(const CaptureTypeRecordIterator &other) const {
+    return Cur == other.Cur && End == other.End;
+  }
+
+  bool operator!=(const CaptureTypeRecordIterator &other) const {
+    return !(*this == other);
+  }
+};
+
+class MetadataSourceRecord {
+  const RelativeDirectPointer<const char> MangledTypeName;
+  const RelativeDirectPointer<const char> MangledMetadataSource;
+
+public:
+  MetadataSourceRecord() = delete;
+
+  bool hasMangledTypeName() const {
+    return MangledTypeName;
+  }
+
+  std::string getMangledTypeName() const {
+    return MangledTypeName.get();
+  }
+
+  bool hasMangledMetadataSource() const {
+    return MangledMetadataSource;
+  }
+
+  std::string getMangledMetadataSource() const {
+    return MangledMetadataSource.get();
+  }
+};
+
+struct MetadataSourceRecordIterator {
+  const MetadataSourceRecord *Cur;
+  const MetadataSourceRecord * const End;
+
+  MetadataSourceRecordIterator(const MetadataSourceRecord *Cur,
+                            const MetadataSourceRecord * const End)
+    : Cur(Cur), End(End) {}
+
+  const MetadataSourceRecord &operator*() const {
+    return *Cur;
+  }
+
+  const MetadataSourceRecord *operator->() const {
+    return Cur;
+  }
+
+  MetadataSourceRecordIterator &operator++() {
+    ++Cur;
+    return *this;
+  }
+
+  bool operator==(const MetadataSourceRecordIterator &other) const {
+    return Cur == other.Cur && End == other.End;
+  }
+
+  bool operator!=(const MetadataSourceRecordIterator &other) const {
+    return !(*this == other);
+  }
+};
+
+// Capture descriptors describe the layout of a closure context
+// object. Unlike nominal types, the generic substitutions for a
+// closure context come from the object, and not the metadata.
+class CaptureDescriptor {
+  const CaptureTypeRecord *getCaptureTypeRecordBuffer() const {
+    return reinterpret_cast<const CaptureTypeRecord *>(this + 1);
+  }
+
+  const MetadataSourceRecord *getMetadataSourceRecordBuffer() const {
+    return reinterpret_cast<const MetadataSourceRecord *>(capture_end().End);
+  }
+
+public:
+  uint32_t NumCaptureTypes;
+  uint32_t NumMetadataSources;
+  uint32_t NumBindings;
+
+  using const_iterator = FieldRecordIterator;
+
+  CaptureTypeRecordIterator capture_begin() const {
+    auto Begin = getCaptureTypeRecordBuffer();
+    auto End = Begin + NumCaptureTypes;
+    return { Begin, End };
+  }
+
+  CaptureTypeRecordIterator capture_end() const {
+    auto Begin = getCaptureTypeRecordBuffer();
+    auto End = Begin + NumCaptureTypes;
+    return { End, End };
+  }
+
+  MetadataSourceRecordIterator source_begin() const {
+    auto Begin = getMetadataSourceRecordBuffer();
+    auto End = Begin + NumMetadataSources;
+    return { Begin, End };
+  }
+
+  MetadataSourceRecordIterator source_end() const {
+    auto Begin = getMetadataSourceRecordBuffer();
+    auto End = Begin + NumMetadataSources;
+    return { End, End };
+  }
+};
+
+class CaptureDescriptorIterator
+  : public std::iterator<std::forward_iterator_tag, CaptureDescriptor> {
+public:
+  const void *Cur;
+  const void * const End;
+  CaptureDescriptorIterator(const void *Cur, const void * const End)
+    : Cur(Cur), End(End) {}
+
+  const CaptureDescriptor &operator*() const {
+    return *reinterpret_cast<const CaptureDescriptor *>(Cur);
+  }
+
+  const CaptureDescriptor *operator->() const {
+    return reinterpret_cast<const CaptureDescriptor *>(Cur);
+  }
+
+  CaptureDescriptorIterator &operator++() {
+    const auto &CR = this->operator*();
+    const void *Next = reinterpret_cast<const char *>(Cur)
+      + sizeof(CaptureDescriptor)
+      + CR.NumCaptureTypes * sizeof(CaptureTypeRecord)
+      + CR.NumMetadataSources * sizeof(MetadataSourceRecord);
+    Cur = Next;
+    return *this;
+  }
+
+  bool operator==(CaptureDescriptorIterator const &other) const {
+    return Cur == other.Cur && End == other.End;
+  }
+
+  bool operator!=(CaptureDescriptorIterator const &other) const {
+    return !(*this == other);
+  }
+};
+
 } // end namespace reflection
 } // end namespace swift
 

include/swift/Reflection/TypeRefBuilder.h

@@ -68,12 +68,14 @@ class ReflectionSection {
 using FieldSection = ReflectionSection<FieldDescriptorIterator>;
 using AssociatedTypeSection = ReflectionSection<AssociatedTypeIterator>;
 using BuiltinTypeSection = ReflectionSection<BuiltinTypeDescriptorIterator>;
+using CaptureSection = ReflectionSection<CaptureDescriptorIterator>;
 using GenericSection = ReflectionSection<const void *>;
 
 struct ReflectionInfo {
   FieldSection fieldmd;
   AssociatedTypeSection assocty;
   BuiltinTypeSection builtin;
+  CaptureSection capture;
   GenericSection typeref;
   GenericSection reflstr;
 };

include/swift/SwiftRemoteMirror/SwiftRemoteMirrorTypes.h

@@ -38,6 +38,7 @@ typedef struct swift_reflection_info {
   swift_reflection_section_t fieldmd;
   swift_reflection_section_t builtin;
   swift_reflection_section_t assocty;
+  swift_reflection_section_t capture;
   swift_reflection_section_t typeref;
   swift_reflection_section_t reflstr;
 } swift_reflection_info_t;

stdlib/private/SwiftReflectionTest/SwiftReflectionTest.swift

@@ -54,6 +54,7 @@ internal struct ReflectionInfo : Sequence {
   internal let fieldmd: Section?
   internal let assocty: Section?
   internal let builtin: Section?
+  internal let capture: Section?
   internal let typeref: Section?
   internal let reflstr: Section?
 
@@ -62,6 +63,7 @@ internal struct ReflectionInfo : Sequence {
       fieldmd,
       assocty,
       builtin,
+      capture,
       typeref,
       reflstr
     ].makeIterator())
@@ -98,6 +100,7 @@ internal func getSectionInfo(_ name: String,
 /// - __swift3_fieldmd
 /// - __swift3_assocty
 /// - __swift3_builtin
+/// - __swift3_capture
 /// - __swift3_typeref
 /// - __swift3_reflstr (optional, may have been stripped out)
 ///
@@ -111,14 +114,16 @@ internal func getReflectionInfoForImage(atIndex i: UInt32) -> ReflectionInfo? {
 
   let imageName = _dyld_get_image_name(i)
   if let fieldmd = getSectionInfo("__swift3_fieldmd", header) {
-     let assocty = getSectionInfo("__swift3_assocty", header)
-     let builtin = getSectionInfo("__swift3_builtin", header)
-     let typeref = getSectionInfo("__swift3_typeref", header)
-     let reflstr = getSectionInfo("__swift3_reflstr", header)
+      let assocty = getSectionInfo("__swift3_assocty", header)
+      let builtin = getSectionInfo("__swift3_builtin", header)
+      let capture = getSectionInfo("__swift3_capture", header)
+      let typeref = getSectionInfo("__swift3_typeref", header)
+      let reflstr = getSectionInfo("__swift3_reflstr", header)
       return ReflectionInfo(imageName: String(validatingUTF8: imageName)!,
                             fieldmd: fieldmd,
                             assocty: assocty,
                             builtin: builtin,
+                            capture: capture,
                             typeref: typeref,
                             reflstr: reflstr)
   }

tools/swift-reflection-dump/swift-reflection-dump.cpp

@@ -113,6 +113,8 @@ static ReflectionInfo findReflectionInfo(const ObjectFile *objectFile) {
       objectFile, {"__swift3_assocty", ".swift3_assocty"});
   auto builtinTypeSection = findReflectionSection<BuiltinTypeSection>(
       objectFile, {"__swift3_builtin", ".swift3_builtin"});
+  auto captureSection = findReflectionSection<CaptureSection>(
+      objectFile, {"__swift3_capture", ".swift3_capture"});
   auto typeRefSection = findReflectionSection<GenericSection>(
       objectFile, {"__swift3_typeref", ".swift3_typeref"});
   auto reflectionStringsSection = findReflectionSection<GenericSection>(
@@ -122,6 +124,7 @@ static ReflectionInfo findReflectionInfo(const ObjectFile *objectFile) {
     fieldSection,
     associatedTypeSection,
     builtinTypeSection,
+    captureSection,
     typeRefSection,
     reflectionStringsSection,
   };

tools/swift-reflection-test/swift-reflection-test.c

@@ -43,6 +43,7 @@ typedef struct RemoteReflectionInfo {
   RemoteSection fieldmd;
   RemoteSection assocty;
   RemoteSection builtin;
+  RemoteSection capture;
   RemoteSection typeref;
   RemoteSection reflstr;
   uintptr_t StartAddress;
@@ -91,25 +92,27 @@ uintptr_t getEndAddress(const RemoteSection Sections[], size_t Count) {
 RemoteReflectionInfo makeRemoteReflectionInfo(RemoteSection fieldmd,
                                               RemoteSection assocty,
                                               RemoteSection builtin,
+                                              RemoteSection capture,
                                               RemoteSection typeref,
                                               RemoteSection reflstr) {
   RemoteReflectionInfo Info = {
     fieldmd,
     assocty,
     builtin,
+    capture,
     typeref,
     reflstr,
     0,
     0
   };
 
-  const RemoteSection Sections[5] = {
-    fieldmd, assocty, builtin, typeref, reflstr
+  const RemoteSection Sections[6] = {
+    fieldmd, assocty, builtin, capture, typeref, reflstr
   };
 
-  Info.StartAddress = getStartAddress(Sections, 5);
+  Info.StartAddress = getStartAddress(Sections, 6);
 
-  uintptr_t EndAddress = getEndAddress(Sections, 5);
+  uintptr_t EndAddress = getEndAddress(Sections, 6);
   Info.TotalSize = EndAddress - Info.StartAddress;
 
   return Info;
@@ -256,6 +259,7 @@ PipeMemoryReader_receiveReflectionInfo(SwiftReflectionContextRef RC,
       makeRemoteSection(Reader),
       makeRemoteSection(Reader),
       makeRemoteSection(Reader),
+      makeRemoteSection(Reader),
       makeRemoteSection(Reader));
   }
 
@@ -277,6 +281,7 @@ PipeMemoryReader_receiveReflectionInfo(SwiftReflectionContextRef RC,
       makeLocalSection(Buffer, RemoteInfo.fieldmd, RemoteInfo),
       makeLocalSection(Buffer, RemoteInfo.assocty, RemoteInfo),
       makeLocalSection(Buffer, RemoteInfo.builtin, RemoteInfo),
+      makeLocalSection(Buffer, RemoteInfo.capture, RemoteInfo),
       makeLocalSection(Buffer, RemoteInfo.typeref, RemoteInfo),
       makeLocalSection(Buffer, RemoteInfo.reflstr, RemoteInfo)
     };