[mc] Avoid extra memory allocation and fix off-by-one buffer overflow

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

diff --git a/src/mc/AddressSpace.hpp b/src/mc/AddressSpace.hpp
index 0ff146a..1fd9e49 100644 (file)
--- a/src/mc/AddressSpace.hpp
+++ b/src/mc/AddressSpace.hpp
@@ -7,29 +7,34 @@
 #ifndef SIMGRID_MC_ADDRESS_SPACE_H
 #define SIMGRID_MC_ADDRESS_SPACE_H
 
+#include <cassert>
 #include <cstddef>
 #include <cstdint>
+#include <cstring>
 #include <type_traits>
 
+#include <string>
+#include <vector>
+
 #include "src/mc/mc_forward.hpp"
-#include "src/mc/remote_ptr.hpp"
+#include "src/mc/RemotePtr.hpp"
 
 namespace simgrid {
 namespace mc {
 
-/** 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;
 
-/** 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;
 
-/** 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;
 
@@ -97,6 +102,10 @@ public:
  *  * 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:
@@ -105,35 +114,58 @@ public:
   AddressSpace(Process* process) : process_(process) {}
   virtual ~AddressSpace();
 
+  /** The process of this addres space
+   *
+   *  This is where we can get debug informations, memory layout, etc.
+   */
   simgrid::mc::Process* process() const { return process_; }
 
   /** 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,
-    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
-  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);
   }
 
-  /** Read a given data structure from the address space */
   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
   {
-    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);
+    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
+  {
+    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;
+  }
+
 };
 
 }