Change the RemoteMirror API to have extensible data layout callback (#15291)

* Change the RemoteMirror API to have extensible data layout callback

* Use DLQ_Get prefix on DataLayoutQueryType enum values

* Simplify MemoryReaderImpl and synthesize minimalDataLayoutQueryFunction

include/swift/Remote/CMemoryReader.h

@@ -21,6 +21,17 @@
 #include "swift/SwiftRemoteMirror/MemoryReaderInterface.h"
 #include "swift/Remote/MemoryReader.h"
 
+struct MemoryReaderImpl {
+  // Opaque pointer passed to all the callback functions.
+  void *reader_context;
+
+  QueryDataLayoutFunction queryDataLayout;
+  FreeBytesFunction free;
+  ReadBytesFunction readBytes;
+  GetStringLengthFunction getStringLength;
+  GetSymbolAddressFunction getSymbolAddress;
+};
+
 namespace swift {
 namespace remote {
 
@@ -31,19 +42,15 @@ class CMemoryReader final : public MemoryReader {
 
 public:
   CMemoryReader(MemoryReaderImpl Impl) : Impl(Impl) {
-    assert(this->Impl.getPointerSize && "No getPointerSize implementation");
+    assert(this->Impl.queryDataLayout && "No queryDataLayout implementation");
     assert(this->Impl.getStringLength && "No stringLength implementation");
     assert(this->Impl.readBytes && "No readBytes implementation");
-    assert(this->Impl.getPointerSize(this->Impl.reader_context) != 0 &&
-           "Invalid target pointer size");
   }
 
-  uint8_t getPointerSize() override {
+  bool queryDataLayout(DataLayoutQueryType type, void *inBuffer,
-    return Impl.getPointerSize(Impl.reader_context);
+                       void *outBuffer) override {
-  }
+    return Impl.queryDataLayout(Impl.reader_context, type, inBuffer,
-
+                                outBuffer) != 0;
-  uint8_t getSizeSize() override {
-    return Impl.getSizeSize(Impl.reader_context);
   }
 
   RemoteAddress getSymbolAddress(const std::string &name) override {

include/swift/Remote/InProcessMemoryReader.h

@@ -27,12 +27,22 @@ namespace remote {
 /// An implementation of MemoryReader which simply reads from the current
 /// address space.
 class InProcessMemoryReader final : public MemoryReader {
-  uint8_t getPointerSize() override {
+  bool queryDataLayout(DataLayoutQueryType type, void *inBuffer,
-    return sizeof(uintptr_t);
+                       void *outBuffer) override {
+    switch (type) {
+      case DLQ_GetPointerSize: {
+        auto result = static_cast<uint8_t *>(outBuffer);
+        *result = sizeof(void *);
+        return true;
+      }
+      case DLQ_GetSizeSize: {
+        auto result = static_cast<uint8_t *>(outBuffer);
+        *result = sizeof(size_t);
+        return true;
+      }
     }
 
-  uint8_t getSizeSize() override {
+    return false;
-    return sizeof(size_t);
   }
 
   RemoteAddress getSymbolAddress(const std::string &name) override;

include/swift/Remote/MemoryReader.h

@@ -19,6 +19,7 @@
 #define SWIFT_REMOTE_MEMORYREADER_H
 
 #include "swift/Remote/RemoteAddress.h"
+#include "swift/SwiftRemoteMirror/MemoryReaderInterface.h"
 
 #include <cstring>
 #include <functional>
@@ -38,11 +39,8 @@ public:
   /// A convenient name for the return type from readBytes.
   using ReadBytesResult = std::unique_ptr<const void, std::function<void(const void *)>>;
 
-  /// Return the size of an ordinary pointer in the remote process, in bytes.
+  virtual bool queryDataLayout(DataLayoutQueryType type, void *inBuffer,
-  virtual uint8_t getPointerSize() = 0;
+                               void *outBuffer) = 0;
-
-  /// Return the size of size_t in the remote process, in bytes.
-  virtual uint8_t getSizeSize() = 0;
 
   /// Look up the given public symbol name in the remote process.
   virtual RemoteAddress getSymbolAddress(const std::string &name) = 0;

include/swift/SwiftRemoteMirror/MemoryReaderInterface.h

@@ -32,36 +32,17 @@ extern "C" {
 // in the system library, so we use 'swift_addr_t'.
 typedef uint64_t swift_addr_t;
 
-typedef void (*FreeBytesFunction)(void *reader_context, const void *bytes, void *context);
+/// The following callbacks provide "reader_context", which is an opaque context
-
+/// provided in swift_reflection_createReflectionContext.
-typedef uint8_t (*PointerSizeFunction)(void *reader_context);
-typedef uint8_t (*SizeSizeFunction)(void *reader_context);
-typedef const void *(*ReadBytesFunction)(void *reader_context, swift_addr_t address,
-                                         uint64_t size,
-                                         void **outFreeContext);
-typedef uint64_t (*GetStringLengthFunction)(void *reader_context,
-                                            swift_addr_t address);
-typedef swift_addr_t (*GetSymbolAddressFunction)(void *reader_context,
-                                                 const char *name,
-                                                 uint64_t name_length);
-
-typedef struct MemoryReaderImpl {
-  /// An opaque context that the implementor can specify to
-  /// be passed to each of the APIs below.
-  void *reader_context;
-
-  /// Get the size in bytes of the target's pointer type.
-  PointerSizeFunction getPointerSize;
-
-  /// Get the size in bytes of the target's size type.
-  SizeSizeFunction getSizeSize;
 
 /// Free memory returned from readBytes. May be NULL if memory never needs to be freed.
-  FreeBytesFunction free;
+typedef void (*FreeBytesFunction)(void *reader_context, const void *bytes, void *context);
 
-  // FIXME: -Wdocumentation complains about \param and \returns on function pointers.
+/// Get the size in bytes of the target's pointer type.
-#pragma clang diagnostic push
+typedef uint8_t (*PointerSizeFunction)(void *reader_context);
-#pragma clang diagnostic ignored "-Wdocumentation"
+
+/// Get the size in bytes of the target's size type.
+typedef uint8_t (*SizeSizeFunction)(void *reader_context);
 
 /// Read a sequence of bytes at an address in the target.
 ///
@@ -72,7 +53,9 @@ typedef struct MemoryReaderImpl {
 /// \returns A pointer to the requested memory, or NULL if the memory could not be read.
 ///          The caller must invoke the free function on the returned pointer once it's
 ///          done using the memory.
-  ReadBytesFunction readBytes;
+typedef const void *(*ReadBytesFunction)(void *reader_context, swift_addr_t address,
+                                         uint64_t size,
+                                         void **outFreeContext);
 
 /// Get the string length at the given address.
 ///
@@ -82,16 +65,37 @@ typedef struct MemoryReaderImpl {
 ///
 /// \param address the address in the target address space
 /// \returns The length of the string or 0 if the scan was unsuccessful.
-  GetStringLengthFunction getStringLength;
+typedef uint64_t (*GetStringLengthFunction)(void *reader_context,
+                                            swift_addr_t address);
 
 /// Get the address of a symbol in the target address space.
 ///
 /// \returns true if the lookup was successful.
-  GetSymbolAddressFunction getSymbolAddress;
+typedef swift_addr_t (*GetSymbolAddressFunction)(void *reader_context,
+                                                 const char *name,
+                                                 uint64_t name_length);
 
-#pragma clang diagnostic pop
+typedef enum {
+  /// The query should ignore inBuffer, and treat outBuffer as uint8_t* which
+  /// should be populated with the size of an ordinary pointer in the remote
+  /// process, in bytes.
+  DLQ_GetPointerSize,
 
-} MemoryReaderImpl;
+  /// The query should ignore inBuffer, and treat outBuffer as uint8_t* which
+  /// should be populated with the size of size_t in the remote process, in
+  /// bytes.
+  DLQ_GetSizeSize,
+} DataLayoutQueryType;
+
+/// Data layout query function, which returns answers based on query types (from
+/// the DataLayoutQueryType enum). The meaning of the input and output buffer
+/// is defined by the type of the query. Unknown requests should be handled by
+/// returning 0.
+///
+/// \returns 0 on error, non-zero on success.
+typedef int (*QueryDataLayoutFunction)(void *reader_context,
+                                       DataLayoutQueryType type, void *inBuffer,
+                                       void *outBuffer);
 
 #ifdef __cplusplus
 } // extern "C"

include/swift/SwiftRemoteMirror/SwiftRemoteMirror.h

@@ -51,6 +51,16 @@ swift_reflection_createReflectionContext(void *ReaderContext,
                                          GetStringLengthFunction GetStringLength,
                                          GetSymbolAddressFunction GetSymbolAddress);
 
+/// \returns An opaque reflection context.
+SWIFT_REMOTE_MIRROR_LINKAGE
+SwiftReflectionContextRef
+swift_reflection_createReflectionContextWithDataLayout(void *ReaderContext,
+                                     QueryDataLayoutFunction DataLayout,
+                                     FreeBytesFunction Free,
+                                     ReadBytesFunction ReadBytes,
+                                     GetStringLengthFunction GetStringLength,
+                                     GetSymbolAddressFunction GetSymbolAddress);
+
 /// Destroys an opaque reflection context.
 SWIFT_REMOTE_MIRROR_LINKAGE
 void

stdlib/public/SwiftRemoteMirror/SwiftRemoteMirror.cpp

@@ -50,6 +50,18 @@ swift_reflection_getSupportedMetadataVersion() {
   return SWIFT_REFLECTION_METADATA_VERSION;
 }
 
+template <uint8_t WordSize>
+static int minimalDataLayoutQueryFunction(void *ReaderContext,
+                                          DataLayoutQueryType type,
+                                          void *inBuffer, void *outBuffer) {
+  if (type == DLQ_GetPointerSize || type == DLQ_GetSizeSize) {
+    auto result = static_cast<uint8_t *>(outBuffer);
+    *result = WordSize;
+    return 1;
+  }
+  return 0;
+}
+
 SwiftReflectionContextRef
 swift_reflection_createReflectionContext(void *ReaderContext,
                                          uint8_t PointerSize,
@@ -61,13 +73,30 @@ swift_reflection_createReflectionContext(void *ReaderContext,
   assert(PointerSize == sizeof(uintptr_t) &&
          "We currently only support the pointer size this file was compiled with.");
 
-  auto GetSize = PointerSize == 4
+  auto *DataLayout = PointerSize == 4 ? minimalDataLayoutQueryFunction<4>
-    ? [](void *){ return (uint8_t)4; }
+                                      : minimalDataLayoutQueryFunction<8>;
-    : [](void *){ return (uint8_t)8; };
   MemoryReaderImpl ReaderImpl {
     ReaderContext,
-    GetSize,
+    DataLayout,
-    GetSize,
+    Free,
+    ReadBytes,
+    GetStringLength,
+    GetSymbolAddress
+  };
+
+  return new SwiftReflectionContext(ReaderImpl);
+}
+
+SwiftReflectionContextRef
+swift_reflection_createReflectionContextWithDataLayout(void *ReaderContext,
+                                    QueryDataLayoutFunction DataLayout,
+                                    FreeBytesFunction Free,
+                                    ReadBytesFunction ReadBytes,
+                                    GetStringLengthFunction GetStringLength,
+                                    GetSymbolAddressFunction GetSymbolAddress) {
+  MemoryReaderImpl ReaderImpl {
+    ReaderContext,
+    DataLayout,
     Free,
     ReadBytes,
     GetStringLength,

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

@@ -161,12 +161,24 @@ public:
   {
   }
 
-  uint8_t getPointerSize() override {
+  bool queryDataLayout(DataLayoutQueryType type, void *inBuffer,
-    return sizeof(uintptr_t);
+                       void *outBuffer) override {
+    switch (type) {
+      case DLQ_GetPointerSize: {
+        auto result = static_cast<uint8_t *>(outBuffer);
+        *result = sizeof(void *);
+        return true;
       }
-  uint8_t getSizeSize() override {
+      case DLQ_GetSizeSize: {
-    return sizeof(size_t);
+        auto result = static_cast<uint8_t *>(outBuffer);
+        *result = sizeof(size_t);
+        return true;
       }
+    }
+
+    return false;
+  }
+
   RemoteAddress getSymbolAddress(const std::string &name) override {
     for (auto &object : ObjectFiles) {
       for (auto &symbol : object->symbols()) {

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

@@ -178,6 +178,25 @@ void PipeMemoryReader_collectBytesFromPipe(const PipeMemoryReader *Reader,
   }
 }
 
+static int PipeMemoryReader_queryDataLayout(void *Context,
+                                             DataLayoutQueryType type,
+                                             void *inBuffer, void *outBuffer) {
+  switch (type) {
+    case DLQ_GetPointerSize: {
+      uint8_t *result = (uint8_t *)outBuffer;
+      *result = sizeof(void *);
+      return 1;
+    }
+    case DLQ_GetSizeSize: {
+      uint8_t *result = (uint8_t *)outBuffer;
+      *result = sizeof(size_t);
+      return 1;
+    }
+  }
+
+  return 0;
+}
+
 static void PipeMemoryReader_freeBytes(void *reader_context, const void *bytes,
                                        void *context) {
   free((void *)bytes);
@@ -438,11 +457,10 @@ int doDumpHeapInstance(const char *BinaryFilename) {
     default: { // Parent
       close(PipeMemoryReader_getChildReadFD(&Pipe));
       close(PipeMemoryReader_getChildWriteFD(&Pipe));
-      SwiftReflectionContextRef RC = swift_reflection_createReflectionContext(
+      SwiftReflectionContextRef RC =
-        (void*)&Pipe,
+          swift_reflection_createReflectionContextWithDataLayout(
-        sizeof(void *),
+              (void *)&Pipe, PipeMemoryReader_queryDataLayout,
-        PipeMemoryReader_freeBytes,
+              PipeMemoryReader_freeBytes, PipeMemoryReader_readBytes,
-        PipeMemoryReader_readBytes,
               PipeMemoryReader_getStringLength,
               PipeMemoryReader_getSymbolAddress);