averello/swift-mirror
1
0
Fork 0
mirror of https://github.com/apple/swift.git synced 2025-12-14 20:36:38 +01:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
* Change the RemoteMirror API to have extensible data layout callback

* Use DLQ_Get prefix on DataLayoutQueryType enum values

* Simplify MemoryReaderImpl and synthesize minimalDataLayoutQueryFunction
This commit is contained in:
Kuba (Brecka) Mracek
2018-03-16 14:54:04 -07:00
committed by GitHub
parent 60a6c02328
commit 84e71b8d7a
8 changed files with 170 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
include/swift/Remote/CMemoryReader.h
View File

@@ -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 {
return Impl.getPointerSize(Impl.reader_context);
}
uint8_t getSizeSize() override {
return Impl.getSizeSize(Impl.reader_context);
bool queryDataLayout(DataLayoutQueryType type, void *inBuffer,
void *outBuffer) override {
return Impl.queryDataLayout(Impl.reader_context, type, inBuffer,
outBuffer) != 0;
}
RemoteAddress getSymbolAddress(const std::string &name) override {

20
include/swift/Remote/InProcessMemoryReader.h
View File

@@ -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 {
return sizeof(uintptr_t);
}
bool queryDataLayout(DataLayoutQueryType type, void *inBuffer,
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 sizeof(size_t);
return false;
}
RemoteAddress getSymbolAddress(const std::string &name) override;

8
include/swift/Remote/MemoryReader.h
View File

@@ -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 uint8_t getPointerSize() = 0;
/// Return the size of size_t in the remote process, in bytes.
virtual uint8_t getSizeSize() = 0;
virtual bool queryDataLayout(DataLayoutQueryType type, void *inBuffer,
void *outBuffer) = 0;
/// Look up the given public symbol name in the remote process.
virtual RemoteAddress getSymbolAddress(const std::string &name) = 0;

94
include/swift/SwiftRemoteMirror/MemoryReaderInterface.h
View File

@@ -32,66 +32,70 @@ extern "C" {
// in the system library, so we use 'swift_addr_t'.
typedef uint64_t swift_addr_t;
/// The following callbacks provide "reader_context", which is an opaque context
/// provided in swift_reflection_createReflectionContext.
/// Free memory returned from readBytes. May be NULL if memory never needs to be freed.
typedef void (*FreeBytesFunction)(void *reader_context, const void *bytes, void *context);
/// Get the size in bytes of the target's pointer type.
typedef uint8_t (*PointerSizeFunction)(void *reader_context);
/// 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.
///
/// \param address the address in the target address space
/// \param size the number of bytes to read
/// \param outFreeContext on return, an arbitrary context pointer that the caller will
/// pass to the free function
/// \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.
typedef const void *(*ReadBytesFunction)(void *reader_context, swift_addr_t address,
uint64_t size,
void **outFreeContext);
/// Get the string length at the given address.
///
/// This scan always occurs in a read-only data section. If the scan
/// would go beyond the section boundary, a length of 0 should be
/// returned.
///
/// \param address the address in the target address space
/// \returns The length of the string or 0 if the scan was unsuccessful.
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.
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;
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,
/// Get the size in bytes of the target's pointer type.
PointerSizeFunction getPointerSize;
/// 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;
/// 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;
// FIXME: -Wdocumentation complains about \param and \returns on function pointers.
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdocumentation"
/// Read a sequence of bytes at an address in the target.
///
/// \param address the address in the target address space
/// \param size the number of bytes to read
/// \param outFreeContext on return, an arbitrary context pointer that the caller will
/// pass to the free function
/// \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;
/// Get the string length at the given address.
///
/// This scan always occurs in a read-only data section. If the scan
/// would go beyond the section boundary, a length of 0 should be
/// returned.
///
/// \param address the address in the target address space
/// \returns The length of the string or 0 if the scan was unsuccessful.
GetStringLengthFunction getStringLength;
/// Get the address of a symbol in the target address space.
///
/// \returns true if the lookup was successful.
GetSymbolAddressFunction getSymbolAddress;
#pragma clang diagnostic pop
} MemoryReaderImpl;
/// 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"

10
include/swift/SwiftRemoteMirror/SwiftRemoteMirror.h
View File

@@ -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

41
stdlib/public/SwiftRemoteMirror/SwiftRemoteMirror.cpp
View File

@@ -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,
@@ -60,14 +72,31 @@ swift_reflection_createReflectionContext(void *ReaderContext,
assert((PointerSize == 4 || PointerSize == 8) && "We only support 32-bit and 64-bit.");
assert(PointerSize == sizeof(uintptr_t) &&
"We currently only support the pointer size this file was compiled with.");
auto GetSize = PointerSize == 4
? [](void *){ return (uint8_t)4; }
: [](void *){ return (uint8_t)8; };
auto *DataLayout = PointerSize == 4 ? minimalDataLayoutQueryFunction<4>
: minimalDataLayoutQueryFunction<8>;
MemoryReaderImpl ReaderImpl {
ReaderContext,
GetSize,
GetSize,
DataLayout,
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,

22
tools/swift-reflection-dump/swift-reflection-dump.cpp
View File

@@ -161,12 +161,24 @@ public:
{
}
uint8_t getPointerSize() override {
return sizeof(uintptr_t);
}
uint8_t getSizeSize() override {
return sizeof(size_t);
bool queryDataLayout(DataLayoutQueryType type, void *inBuffer,
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;
}
}
return false;
}
RemoteAddress getSymbolAddress(const std::string &name) override {
for (auto &object : ObjectFiles) {
for (auto &symbol : object->symbols()) {

32
tools/swift-reflection-test/swift-reflection-test.c
View File

@@ -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,13 +457,12 @@ int doDumpHeapInstance(const char *BinaryFilename) {
default: { // Parent
close(PipeMemoryReader_getChildReadFD(&Pipe));
close(PipeMemoryReader_getChildWriteFD(&Pipe));
SwiftReflectionContextRef RC = swift_reflection_createReflectionContext(
(void*)&Pipe,
sizeof(void *),
PipeMemoryReader_freeBytes,
PipeMemoryReader_readBytes,
PipeMemoryReader_getStringLength,
PipeMemoryReader_getSymbolAddress);
SwiftReflectionContextRef RC =
swift_reflection_createReflectionContextWithDataLayout(
(void *)&Pipe, PipeMemoryReader_queryDataLayout,
PipeMemoryReader_freeBytes, PipeMemoryReader_readBytes,
PipeMemoryReader_getStringLength,
PipeMemoryReader_getSymbolAddress);
uint8_t PointerSize = PipeMemoryReader_getPointerSize((void*)&Pipe);
if (PointerSize != sizeof(uintptr_t))