Reflection: Consolidate some code for passing around reflection sections

I'm about to add a new section, and I'd like to update as few
places as possible.

Author: slavapestov

include/swift/Reflection/TypeRefBuilder.h

@@ -71,7 +71,6 @@ using BuiltinTypeSection = ReflectionSection<BuiltinTypeDescriptorIterator>;
 using GenericSection = ReflectionSection<const void *>;
 
 struct ReflectionInfo {
-  std::string ImageName;
   FieldSection fieldmd;
   AssociatedTypeSection assocty;
   BuiltinTypeSection builtin;

include/swift/SwiftRemoteMirror/SwiftRemoteMirror.h

@@ -51,12 +51,7 @@ swift_reflection_destroyReflectionContext(SwiftReflectionContextRef Context);
 /// Add reflection sections for a loaded Swift image.
 void
 swift_reflection_addReflectionInfo(SwiftReflectionContextRef ContextRef,
-                                   const char *ImageName,
-                                   swift_reflection_section_t fieldmd,
-                                   swift_reflection_section_t builtin,
-                                   swift_reflection_section_t assocty,
-                                   swift_reflection_section_t typeref,
-                                   swift_reflection_section_t reflstr);
+                                   swift_reflection_info_t Info);
 
 
 /// Returns a boolean indicating if the isa mask was successfully

include/swift/SwiftRemoteMirror/SwiftRemoteMirrorTypes.h

@@ -26,22 +26,24 @@ extern "C" {
 
 typedef uintptr_t swift_typeref_t;
 
-/// \brief Represents the __swift{n}_reflect section of an image.
-///
-/// If this section is virtually mapped, the following corresponding sections
-/// should also be mapped into the current address space:
-///
-/// __swift{n}_typeref
-/// --swift{n}_reflstr
-///
-/// where {n} is SWIFT_REFLECTION_VERSION_MAJOR.
-typedef struct swift_reflection_section_t {
+/// \brief Represents one of the Swift reflection sections of an image.
+typedef struct swift_reflection_section {
   void *Begin;
   void *End;
 } swift_reflection_section_t;
 
+/// \brief Represents the set of Swift reflection sections of an image.
+/// Not all sections may be present.
+typedef struct swift_reflection_info {
+  swift_reflection_section_t fieldmd;
+  swift_reflection_section_t builtin;
+  swift_reflection_section_t assocty;
+  swift_reflection_section_t typeref;
+  swift_reflection_section_t reflstr;
+} swift_reflection_info_t;
+
 /// The layout kind of a Swift type.
-typedef enum swift_layout_kind_t {
+typedef enum swift_layout_kind {
   // Nothing is known about the size or contents of this value.
   SWIFT_UNKNOWN,
 

stdlib/private/SwiftReflectionTest/SwiftReflectionTest.swift

@@ -171,16 +171,10 @@ internal func sendReflectionInfos() {
 
   var numInfos = infos.count
   debugLog("\(numInfos) reflection info bundles.")
-  sendBytes(from: &numInfos, count: sizeof(UInt.self))
   precondition(numInfos >= 1)
+  sendBytes(from: &numInfos, count: sizeof(UInt.self))
   for info in infos {
     debugLog("Sending info for \(info.imageName)")
-    let imageNameBytes = Array(info.imageName.utf8)
-    var imageNameLength = UInt(imageNameBytes.count)
-    fwrite(&imageNameLength, sizeof(UInt.self), 1, stdout)
-    fflush(stdout)
-    fwrite(imageNameBytes, 1, imageNameBytes.count, stdout)
-    fflush(stdout)
     for section in info {
       sendValue(section?.startAddress)
       sendValue(section?.size ?? 0)

stdlib/public/SwiftRemoteMirror/SwiftRemoteMirror.cpp

@@ -51,22 +51,9 @@ void swift_reflection_destroyReflectionContext(SwiftReflectionContextRef Context
 
 void
 swift_reflection_addReflectionInfo(SwiftReflectionContextRef ContextRef,
-                                   const char *ImageName,
-                                   swift_reflection_section_t fieldmd,
-                                   swift_reflection_section_t assocty,
-                                   swift_reflection_section_t builtin,
-                                   swift_reflection_section_t typeref,
-                                   swift_reflection_section_t reflstr) {
-  ReflectionInfo Info {
-    ImageName,
-    FieldSection(fieldmd.Begin, fieldmd.End),
-    AssociatedTypeSection(assocty.Begin, assocty.End),
-    BuiltinTypeSection(builtin.Begin, builtin.End),
-    GenericSection(typeref.Begin, typeref.End),
-    GenericSection(reflstr.Begin, reflstr.End)
-  };
+                                   swift_reflection_info_t Info) {
   auto Context = reinterpret_cast<NativeReflectionContext *>(ContextRef);
-  Context->addReflectionInfo(Info);
+  Context->addReflectionInfo(*reinterpret_cast<ReflectionInfo *>(&Info));
 }
 
 int

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

@@ -75,9 +75,8 @@ static T unwrap(llvm::ErrorOr<T> value) {
   exit(EXIT_FAILURE);
 }
 
-static llvm::object::SectionRef
-getSectionRef(const ObjectFile *objectFile,
-              ArrayRef<StringRef> anySectionNames) {
+static SectionRef getSectionRef(const ObjectFile *objectFile,
+                                ArrayRef<StringRef> anySectionNames) {
   for (auto section : objectFile->sections()) {
     StringRef sectionName;
     section.getName(sectionName);
@@ -90,25 +89,63 @@ getSectionRef(const ObjectFile *objectFile,
   return SectionRef();
 }
 
+template<typename Section>
+static Section findReflectionSection(const ObjectFile *objectFile,
+                                     ArrayRef<StringRef> anySectionNames) {
+  auto sectionRef = getSectionRef(objectFile, anySectionNames);
+
+  if (sectionRef.getObject() == nullptr)
+    return {nullptr, nullptr};
+
+  StringRef sectionContents;
+  sectionRef.getContents(sectionContents);
+
+  return {
+    reinterpret_cast<const void *>(sectionContents.begin()),
+    reinterpret_cast<const void *>(sectionContents.end())
+  };
+}
+
+static ReflectionInfo findReflectionInfo(const ObjectFile *objectFile) {
+  auto fieldSection = findReflectionSection<FieldSection>(
+      objectFile, {"__swift3_fieldmd", ".swift3_fieldmd"});
+  auto associatedTypeSection = findReflectionSection<AssociatedTypeSection>(
+      objectFile, {"__swift3_assocty", ".swift3_assocty"});
+  auto builtinTypeSection = findReflectionSection<BuiltinTypeSection>(
+      objectFile, {"__swift3_builtin", ".swift3_builtin"});
+  auto typeRefSection = findReflectionSection<GenericSection>(
+      objectFile, {"__swift3_typeref", ".swift3_typeref"});
+  auto reflectionStringsSection = findReflectionSection<GenericSection>(
+      objectFile, {"__swift3_reflstr", ".swift3_reflstr"});
+
+  return {
+    fieldSection,
+    associatedTypeSection,
+    builtinTypeSection,
+    typeRefSection,
+    reflectionStringsSection,
+  };
+}
+
 static int doDumpReflectionSections(ArrayRef<std::string> binaryFilenames,
                                     StringRef arch,
                                     ActionType action,
                                     std::ostream &OS) {
   // Note: binaryOrError and objectOrError own the memory for our ObjectFile;
   // once they go out of scope, we can no longer do anything.
   std::vector<OwningBinary<Binary>> binaryOwners;
-  std::vector<std::unique_ptr<llvm::object::ObjectFile>> objectOwners;
+  std::vector<std::unique_ptr<ObjectFile>> objectOwners;
 
   // Construct the TypeRefBuilder
   TypeRefBuilder builder;
 
   for (auto binaryFilename : binaryFilenames) {
-    auto binaryOwner = unwrap(llvm::object::createBinary(binaryFilename));
-    llvm::object::Binary *binaryFile = binaryOwner.getBinary();
+    auto binaryOwner = unwrap(createBinary(binaryFilename));
+    Binary *binaryFile = binaryOwner.getBinary();
 
     // The object file we are doing lookups in -- either the binary itself, or
     // a particular slice of a universal binary.
-    std::unique_ptr<llvm::object::ObjectFile> objectOwner;
+    std::unique_ptr<ObjectFile> objectOwner;
     const ObjectFile *objectFile;
 
     if (auto o = dyn_cast<ObjectFile>(binaryFile)) {
@@ -119,102 +156,7 @@ static int doDumpReflectionSections(ArrayRef<std::string> binaryFilenames,
       objectFile = objectOwner.get();
     }
 
-    // Field descriptor section
-    auto fieldSectionRef = getSectionRef(objectFile, {
-      "__swift3_fieldmd", ".swift3_fieldmd"
-    });
-
-    if (fieldSectionRef.getObject() == nullptr) {
-      OS << binaryFilename;
-      OS << " doesn't have a field reflection section!\n";
-      return EXIT_FAILURE;
-    }
-
-    StringRef fieldSectionContents;
-    fieldSectionRef.getContents(fieldSectionContents);
-
-    const FieldSection fieldSection {
-      reinterpret_cast<const void *>(fieldSectionContents.begin()),
-      reinterpret_cast<const void *>(fieldSectionContents.end())
-    };
-
-    // Associated type section - optional
-    AssociatedTypeSection associatedTypeSection {nullptr, nullptr};
-
-    auto associatedTypeSectionRef = getSectionRef(objectFile, {
-      "__swift3_assocty", ".swift3_assocty"
-    });
-
-    if (associatedTypeSectionRef.getObject() != nullptr) {
-      StringRef associatedTypeSectionContents;
-      associatedTypeSectionRef.getContents(associatedTypeSectionContents);
-      associatedTypeSection = {
-        reinterpret_cast<const void *>(associatedTypeSectionContents.begin()),
-        reinterpret_cast<const void *>(associatedTypeSectionContents.end()),
-      };
-    }
-
-    // Builtin types section
-    BuiltinTypeSection builtinTypeSection {nullptr, nullptr};
-
-    auto builtinTypeSectionRef = getSectionRef(objectFile, {
-      "__swift3_builtin", ".swift3_builtin"
-    });
-
-    if (builtinTypeSectionRef.getObject() != nullptr) {
-      StringRef builtinTypeSectionContents;
-      builtinTypeSectionRef.getContents(builtinTypeSectionContents);
-
-      builtinTypeSection = {
-        reinterpret_cast<const void *>(builtinTypeSectionContents.begin()),
-        reinterpret_cast<const void *>(builtinTypeSectionContents.end())
-      };
-    }
-
-    // Typeref section
-    auto typeRefSectionRef = getSectionRef(objectFile, {
-      "__swift3_typeref", ".swift3_typeref"
-    });
-
-    if (typeRefSectionRef.getObject() == nullptr) {
-      OS << binaryFilename;
-      OS << " doesn't have an associated typeref section!\n";
-      return EXIT_FAILURE;
-    }
-
-    StringRef typeRefSectionContents;
-    typeRefSectionRef.getContents(typeRefSectionContents);
-
-    const GenericSection typeRefSection {
-      reinterpret_cast<const void *>(typeRefSectionContents.begin()),
-      reinterpret_cast<const void *>(typeRefSectionContents.end())
-    };
-
-    // Reflection strings section - optional
-    GenericSection reflectionStringsSection {nullptr, nullptr};
-
-    auto reflectionStringsSectionRef = getSectionRef(objectFile, {
-      "__swift3_reflstr", ".swift3_reflstr"
-    });
-
-    if (reflectionStringsSectionRef.getObject() != nullptr) {
-      StringRef reflectionStringsSectionContents;
-      reflectionStringsSectionRef.getContents(reflectionStringsSectionContents);
-
-      reflectionStringsSection = {
-        reinterpret_cast<const void *>(reflectionStringsSectionContents.begin()),
-        reinterpret_cast<const void *>(reflectionStringsSectionContents.end())
-      };
-    }
-
-    builder.addReflectionInfo({
-      binaryFilename,
-      fieldSection,
-      associatedTypeSection,
-      builtinTypeSection,
-      typeRefSection,
-      reflectionStringsSection,
-    });
+    builder.addReflectionInfo(findReflectionInfo(objectFile));
 
     // Retain the objects that own section memory
     binaryOwners.push_back(std::move(binaryOwner));

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

@@ -40,7 +40,6 @@ typedef struct PipeMemoryReader {
 } PipeMemoryReader;
 
 typedef struct RemoteReflectionInfo {
-  const char *ImageName;
   RemoteSection fieldmd;
   RemoteSection assocty;
   RemoteSection builtin;
@@ -50,15 +49,6 @@ typedef struct RemoteReflectionInfo {
   size_t TotalSize;
 } RemoteReflectionInfo;
 
-typedef struct LocalReflectionInfo {
-  const char *ImageName;
-  swift_reflection_section_t fieldmd;
-  swift_reflection_section_t assocty;
-  swift_reflection_section_t builtin;
-  swift_reflection_section_t typeref;
-  swift_reflection_section_t reflstr;
-} LocalReflectionInfo;
-
 static void errorAndExit(const char *message) {
   fprintf(stderr, "%s: %s\n", message, strerror(errno));
   abort();
@@ -104,14 +94,12 @@ uintptr_t getEndAddress(const RemoteSection Sections[], size_t Count) {
   return End;
 }
 
-RemoteReflectionInfo makeRemoteReflectionInfo(const char *ImageName,
-                                              RemoteSection fieldmd,
+RemoteReflectionInfo makeRemoteReflectionInfo(RemoteSection fieldmd,
                                               RemoteSection assocty,
                                               RemoteSection builtin,
                                               RemoteSection typeref,
                                               RemoteSection reflstr) {
   RemoteReflectionInfo Info = {
-    ImageName,
     fieldmd,
     assocty,
     builtin,
@@ -240,7 +228,7 @@ PipeMemoryReader createPipeMemoryReader() {
   return Reader;
 }
 
-const LocalReflectionInfo *
+const swift_reflection_info_t *
 PipeMemoryReader_receiveReflectionInfo(const PipeMemoryReader *Reader,
                                        size_t *NumReflectionInfos) {
   int WriteFD = PipeMemoryReader_getParentWriteFD(Reader);
@@ -255,12 +243,6 @@ PipeMemoryReader_receiveReflectionInfo(const PipeMemoryReader *Reader,
   RemoteReflectionInfo *RemoteInfos = (RemoteReflectionInfo*)malloc(Size);
 
   for (size_t i = 0; i < *NumReflectionInfos; ++i) {
-    size_t ImageNameLength;
-    PipeMemoryReader_collectBytesFromPipe(Reader, (uint8_t*)&ImageNameLength,
-                                          sizeof(ImageNameLength));
-    const char *ImageName = (const char *)malloc(ImageNameLength);
-    PipeMemoryReader_collectBytesFromPipe(Reader, (uint8_t*)ImageName,
-                                          ImageNameLength);
     uintptr_t fieldmd_start;
     size_t fieldmd_size;
     uintptr_t assocty_start;
@@ -294,7 +276,6 @@ PipeMemoryReader_receiveReflectionInfo(const PipeMemoryReader *Reader,
                                           sizeof(reflstr_size));
 
     RemoteInfos[i] = makeRemoteReflectionInfo(
-      ImageName,
       makeRemoteSection(fieldmd_start, fieldmd_size),
       makeRemoteSection(assocty_start, assocty_size),
       makeRemoteSection(builtin_start, builtin_size),
@@ -304,8 +285,8 @@ PipeMemoryReader_receiveReflectionInfo(const PipeMemoryReader *Reader,
 
   // Now pull in the remote sections into our address space.
 
-  LocalReflectionInfo *Infos
-    = malloc(sizeof(LocalReflectionInfo) * *NumReflectionInfos);
+  swift_reflection_info_t *Infos
+    = malloc(sizeof(swift_reflection_info_t) * *NumReflectionInfos);
 
   for (size_t i = 0; i < *NumReflectionInfos; ++i) {
     RemoteReflectionInfo RemoteInfo = RemoteInfos[i];
@@ -330,8 +311,7 @@ PipeMemoryReader_receiveReflectionInfo(const PipeMemoryReader *Reader,
     uintptr_t reflstr_base
       = buffer + RemoteInfo.reflstr.StartAddress - RemoteInfo.StartAddress;
 
-    LocalReflectionInfo Info = {
-      RemoteInfo.ImageName,
+    swift_reflection_info_t Info = {
       makeLocalSection(fieldmd_base, RemoteInfo.fieldmd.Size),
       makeLocalSection(assocty_base, RemoteInfo.assocty.Size),
       makeLocalSection(builtin_base, RemoteInfo.builtin.Size),
@@ -392,18 +372,11 @@ int doDumpHeapInstance(const char *BinaryFilename) {
         instance);
 
       size_t NumReflectionInfos = 0;
-      const LocalReflectionInfo *Infos
+      const swift_reflection_info_t *Infos
         = PipeMemoryReader_receiveReflectionInfo(&Pipe, &NumReflectionInfos);
 
-      for (size_t i = 0; i < NumReflectionInfos; ++i) {
-        const LocalReflectionInfo Info = Infos[i];
-        swift_reflection_addReflectionInfo(RC, Info.ImageName,
-                                           Info.fieldmd,
-                                           Info.assocty,
-                                           Info.builtin,
-                                           Info.typeref,
-                                           Info.reflstr);
-      }
+      for (size_t i = 0; i < NumReflectionInfos; ++i)
+        swift_reflection_addReflectionInfo(RC, Infos[i]);
 
       printf("Type reference:\n");