mc: move some files related to ELF, DWARF or unwind reading into their own directory

[simgrid.git] / src / mc / AddressSpace.hpp

diff --git a/src/mc/AddressSpace.hpp b/src/mc/AddressSpace.hpp
index 7c75d44..a7658e6 100644 (file)
--- a/src/mc/AddressSpace.hpp
+++ b/src/mc/AddressSpace.hpp
@@ -1,5 +1,4 @@
-/* Copyright (c) 2008-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2008-2019. The SimGrid Team. All rights reserved.          */

 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */


@@ -7,128 +6,25 @@
 #ifndef SIMGRID_MC_ADDRESS_SPACE_H
 #define SIMGRID_MC_ADDRESS_SPACE_H
 
 #ifndef SIMGRID_MC_ADDRESS_SPACE_H
 #define SIMGRID_MC_ADDRESS_SPACE_H
 

-#include <cstddef>
-#include <cstdint>
-#include <type_traits>
-
-#include <xbt/misc.h>
-

 #include "src/mc/mc_forward.hpp"
 #include "src/mc/mc_forward.hpp"

+#include "src/mc/remote/RemotePtr.hpp"

 
 namespace simgrid {
 namespace mc {
 
 
 namespace simgrid {
 namespace mc {
 

-/** Pointer to a remote address-space (process, snapshot)
- *
- *  With this we can clearly identify the expected type of an address in the
- *  remote process while avoiding to use native local pointers.
- *
- *  Some operators (+/-) assume use the size of the underlying element. This
- *  only works if the target applications is using the same target: it won't
- *  work for example, when inspecting a 32 bit application from a 64 bit
- *  model-checker.
- */
-template<class T> class remote_ptr {
-  std::uint64_t address_;
-public:
-  remote_ptr() : address_(0) {}
-  remote_ptr(std::uint64_t address) : address_(address) {}
-  remote_ptr(T* address) : address_((std::uintptr_t)address) {}
-  std::uint64_t address() const { return address_; }
-
-  operator bool() const
-  {
-    return address_;
-  }
-  bool operator!() const
-  {
-    return !address_;
-  }
-  operator remote_ptr<void>() const
-  {
-    return remote_ptr<void>(address_);
-  }
-  remote_ptr<T> operator+(std::uint64_t n) const
-  {
-    return remote_ptr<T>(address_ + n * sizeof(T));
-  }
-  remote_ptr<T> operator-(std::uint64_t n) const
-  {
-    return remote_ptr<T>(address_ - n * sizeof(T));
-  }
-  remote_ptr<T>& operator+=(std::uint64_t n)
-  {
-    address_ += n * sizeof(T);
-    return *this;
-  }
-  remote_ptr<T>& operator-=(std::uint64_t n)
-  {
-    address_ -= n * sizeof(T);
-    return *this;
-  }
-};
-
-template<class X, class Y>
-bool operator<(remote_ptr<X> const& x, remote_ptr<Y> const& y)
-{
-  return x.address() < y.address();
-}
-
-template<class X, class Y>
-bool operator>(remote_ptr<X> const& x, remote_ptr<Y> const& y)
-{
-  return x.address() > y.address();
-}
-
-template<class X, class Y>
-bool operator>=(remote_ptr<X> const& x, remote_ptr<Y> const& y)
-{
-  return x.address() >= y.address();
-}
-
-template<class X, class Y>
-bool operator<=(remote_ptr<X> const& x, remote_ptr<Y> const& y)
-{
-  return x.address() <= y.address();
-}
-
-template<class X, class Y>
-bool operator==(remote_ptr<X> const& x, remote_ptr<Y> const& y)
-{
-  return x.address() == y.address();
-}
-
-template<class X, class Y>
-bool operator!=(remote_ptr<X> const& x, remote_ptr<Y> const& y)
-{
-  return x.address() != y.address();
-}
-
-template<class T> inline
-remote_ptr<T> remote(T *p)
-{
-  return remote_ptr<T>(p);
-}
-
-template<class T=void> inline
-remote_ptr<T> remote(uint64_t p)
-{
-  return remote_ptr<T>(p);
-}
-
-/** Process index used when no process is available
+/** Process index used when no process is available (SMPI privatization)

  *
  *

- *  The expected behaviour is that if a process index is needed it will fail.
+ *  The expected behavior is that if a process index is needed it will fail.

  * */
 const int ProcessIndexMissing = -1;
 
  * */
 const int ProcessIndexMissing = -1;
 

-/** Process index used when we don't care about the process index
+/** Process index used when we don't care about the process index (SMPI privatization)

  * */
 const int ProcessIndexDisabled = -2;
 
  * */
 const int ProcessIndexDisabled = -2;
 

-/** Constant used when any process will do.
+/** Constant used when any process will do (SMPI privatization)

  *
  *

- *  This is is index of the first process.
+ *  Note: This is is index of the first process.

  */
 const int ProcessIndexAny = 0;
 
  */
 const int ProcessIndexAny = 0;
 


@@ -144,7 +40,7 @@ class ReadOptions {
 public:
   constexpr ReadOptions() : value_(0) {}
 
 public:
   constexpr ReadOptions() : value_(0) {}
 

-  constexpr operator bool() const { return value_ != 0; }
+  explicit constexpr operator bool() const { return value_ != 0; }

   constexpr bool operator!() const { return value_ == 0; }
 
   constexpr ReadOptions operator|(ReadOptions const& that) const
   constexpr bool operator!() const { return value_ == 0; }
 
   constexpr ReadOptions operator|(ReadOptions const& that) const


@@ -196,43 +92,71 @@ public:
  *  * the current state of an existing process;
  *
  *  * a snapshot.
  *  * the current state of an existing process;
  *
  *  * a snapshot.

+ *
+ *  In order to support SMPI privatization, the can read the memory from the
+ *  context of a given SMPI process: if specified, the code reads data from the
+ *  correct SMPI privatization VMA.

  */
 class AddressSpace {
 private:
  */
 class AddressSpace {
 private:

-  Process* process_;
+  RemoteClient* process_;
+

 public:
 public:

-  AddressSpace(Process* process) : process_(process) {}
-  virtual ~AddressSpace();
+  explicit AddressSpace(RemoteClient* process) : process_(process) {}
+  virtual ~AddressSpace() = default;

 
 

-  simgrid::mc::Process* process() const { return process_; }
+  /** The process of this address space
+   *
+   *  This is where we can get debug informations, memory layout, etc.
+   */
+  simgrid::mc::RemoteClient* process() const { return process_; }

 
   /** Read data from the address space
    *
    *  @param buffer        target buffer for the data
 
   /** Read data from the address space
    *
    *  @param buffer        target buffer for the data

-   *  @param size          number of bytes
+   *  @param size          number of bytes to read

    *  @param address       remote source address of the data
    *  @param process_index which process (used for SMPI privatization)
    *  @param options
    */
   virtual const void* read_bytes(void* buffer, std::size_t size,
    *  @param address       remote source address of the data
    *  @param process_index which process (used for SMPI privatization)
    *  @param options
    */
   virtual const void* read_bytes(void* buffer, std::size_t size,

-    remote_ptr<void> address, int process_index = ProcessIndexAny,
+    RemotePtr<void> address, int process_index = ProcessIndexAny,

     ReadOptions options = ReadOptions::none()) const = 0;
 
   /** Read a given data structure from the address space */
   template<class T> inline
     ReadOptions options = ReadOptions::none()) const = 0;
 
   /** Read a given data structure from the address space */
   template<class T> inline

-  void read(T *buffer, remote_ptr<T> ptr, int process_index = ProcessIndexAny)
+  void read(T *buffer, RemotePtr<T> ptr, int process_index = ProcessIndexAny) const

   {
     this->read_bytes(buffer, sizeof(T), ptr, process_index);
   }
 
   {
     this->read_bytes(buffer, sizeof(T), ptr, process_index);
   }
 

-  /** Read a given data structure from the address space */

   template<class T> inline
   template<class T> inline

-  T read(remote_ptr<T> ptr, int process_index = ProcessIndexMissing)
+  void read(Remote<T>& buffer, RemotePtr<T> ptr, int process_index = ProcessIndexAny) const
+  {
+    this->read_bytes(buffer.getBuffer(), sizeof(T), ptr, process_index);
+  }
+
+  /** Read a given data structure from the addres space
+   *
+   *  This version returns by value.
+   */
+  template<class T> inline
+  Remote<T> read(RemotePtr<T> ptr, int process_index = ProcessIndexMissing) const

   {
   {

-    static_assert(std::is_trivial<T>::value, "Cannot read a non-trivial type");
-    T res;
-    return *(T*)this->read_bytes(&res, sizeof(T), ptr, process_index);
+    Remote<T> res;
+    this->read_bytes(&res, sizeof(T), ptr, process_index);
+    return res;

   }
   }

+
+  /** Read a string of known size */
+  std::string read_string(RemotePtr<char> address, std::size_t len) const
+  {
+    std::string res;
+    res.resize(len);
+    this->read_bytes(&res[0], len, address);
+    return res;
+  }
+

 };
 
 }
 };
 
 }