mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
90f1523c4c
Memory readers on the C-side of the API may actually have an object- oriented design, so they may want to pass an instance to revive when callbacks make it to the other side of the API boundary.
88 lines
3.0 KiB
C++
88 lines
3.0 KiB
C++
//===--- MemoryReaderInterface.h - Public reader interface ------*- C++ -*-===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2016 Apple Inc. and the Swift project authors
|
|
// Licensed under Apache License v2.0 with Runtime Library Exception
|
|
//
|
|
// See http://swift.org/LICENSE.txt for license information
|
|
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
///
|
|
/// \file
|
|
/// This header declares the MemoryReader interface struct, which is a
|
|
/// a collection of function pointers to provide reading memory from external
|
|
/// processes.
|
|
///
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_REFLECTION_MEMORYREADERINTERFACE_H
|
|
#define SWIFT_REFLECTION_MEMORYREADERINTERFACE_H
|
|
|
|
#include <stdint.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
typedef uint64_t addr_t;
|
|
|
|
typedef uint8_t (*PointerSizeFunction)(void *reader_context);
|
|
typedef uint8_t (*SizeSizeFunction)(void * reader_context);
|
|
typedef bool (*ReadBytesFunction)(void * reader_context, addr_t address,
|
|
uint8_t *dest, uint64_t size);
|
|
typedef uint64_t (*GetStringLengthFunction)(void * reader_context,
|
|
addr_t address);
|
|
typedef 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;
|
|
|
|
// 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 dest the caller-owned buffer into which to store the string
|
|
/// \param size the number of bytes to read
|
|
/// \returns true if the read was successful
|
|
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;
|
|
|
|
#ifdef __cplusplus
|
|
} // extern "C"
|
|
#endif
|
|
|
|
#endif //SWIFT_REFLECTION_MEMORYREADERINTERFACE_H
|