Organize the MemoryReader interface headers to better support

multiple clients.

include/swift/Remote/MemoryReader.h

@@ -0,0 +1,95 @@
+//===- MemoryReader.h - Abstract access to remote memory --------*- 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
+//
+//===----------------------------------------------------------------------===//
+//
+//  This file declares an abstract interface for working with the memory
+//  of a remote process.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef SWIFT_REMOTE_MEMORYREADER_H
+#define SWIFT_REMOTE_MEMORYREADER_H
+
+#include <cstdint>
+#include <string>
+
+namespace swift {
+namespace remote {
+
+/// An abstract address in the remote process's address space.
+class RemoteAddress {
+  uint64_t Data;
+public:
+  explicit RemoteAddress(const void *localPtr)
+    : Data(reinterpret_cast<uintptr_t>(localPtr)) {}
+
+  explicit RemoteAddress(uint64_t addressData) : Data(addressData) {}
+
+  explicit operator bool() const {
+    return Data != 0;
+  }
+
+  template <class T>
+  const T *getLocalPointer() const {
+    return reinterpret_cast<const T*>(static_cast<uintptr_t>(Data));
+  }
+
+  uint64_t getAddressData() const {
+    return Data;
+  }
+};
+
+/// An abstract interface for reading memory.
+///
+/// This abstraction presents memory as if it were a read-only
+/// representation of the address space of a remote process.
+class MemoryReader {
+public:
+  /// 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;
+
+  /// Look up the given public symbol name in the remote process.
+  virtual RemoteAddress getSymbolAddress(const std::string &name) = 0;
+
+  /// Attempts to read 'size' bytes from the given address in the
+  /// remote process.
+  ///
+  /// Returns false if the operation failed.
+  virtual bool readBytes(RemoteAddress address, uint8_t *dest,
+                         uint64_t size) = 0;
+
+  /// Attempts to read a C string from the given address in the remote
+  /// process.
+  ///
+  /// Returns false if the operation failed.
+  virtual bool readString(RemoteAddress address, std::string &dest) = 0;
+
+  /// Attempts to read an integer from the given address in the remote
+  /// process.
+  ///
+  /// Returns false if the operation failed.
+  template <typename IntegerType>
+  bool readInteger(RemoteAddress address, IntegerType *dest) {
+    return readBytes(address, reinterpret_cast<uint8_t*>(dest),
+                     sizeof(IntegerType));
+  }
+
+  virtual ~MemoryReader() = default;
+};
+
+} // end namespace reflection
+} // end namespace swift
+
+#endif // SWIFT_REFLECTION_READER_H
+