Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
mc: move some files related to ELF, DWARF or unwind reading into their own directory
[simgrid.git] / src / mc / AddressSpace.hpp
index 02db2c4..a7658e6 100644 (file)
@@ -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. */
@@ -7,34 +6,25 @@
 #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/RemotePtr.hpp"
+#include "src/mc/remote/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;
 
@@ -50,7 +40,7 @@ class ReadOptions {
 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
@@ -95,51 +85,6 @@ public:
   static constexpr ReadOptions lazy() { return ReadOptions(1); }
 };
 
-/** HACK, A value from another process
- *
- *  This represents a value from another process:
- *
- *  * constructor/destructor are disabled;
- *
- *  * raw memory copy (std::memcpy) is used to copy Remote<T>;
- *
- *  * raw memory comparison is used to compare them;
- *
- *  * when T is a trivial type, Remote is convertible to a T.
- *
- *  We currently only handle the case where the type has the same layout
- *  in the current process and in the target process: we don't handle
- *  cross-architecture (such as 32-bit/64-bit access).
- */
-template<class T>
-union Remote {
-private:
-  T buffer;
-public:
-  Remote() {}
-  ~Remote() {}
-  Remote(Remote const& that)
-  {
-    std::memcpy(&buffer, &that.buffer, sizeof(buffer));
-  }
-  Remote& operator=(Remote const& that)
-  {
-    std::memcpy(&buffer, &that.buffer, sizeof(buffer));
-    return *this;
-  }
-  T*       getBuffer() { return &buffer; }
-  const T* getBuffer() const { return &buffer; }
-  std::size_t getBufferSize() const { return sizeof(T); }
-  operator T() const {
-    static_assert(std::is_trivial<T>::value, "Cannot convert non trivial type");
-    return buffer;
-  }
-  void clear()
-  {
-    std::memset(static_cast<void*>(&buffer), 0, sizeof(T));
-  }
-};
-
 /** A given state of a given process (abstract base class)
  *
  *  Currently, this might either be:
@@ -147,20 +92,29 @@ 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:
-  Process* process_;
+  RemoteClient* process_;
+
 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
-   *  @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
@@ -182,7 +136,10 @@ public:
     this->read_bytes(buffer.getBuffer(), sizeof(T), ptr, process_index);
   }
 
-  /** Read a given data structure from the address space */
+  /** 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
   {
@@ -191,13 +148,13 @@ public:
     return res;
   }
 
+  /** Read a string of known size */
   std::string read_string(RemotePtr<char> address, std::size_t len) const
   {
-    // TODO, use std::vector with .data() in C++17 to avoid useless copies
-    std::vector<char> buffer(len);
-    buffer[len] = '\0';
-    this->read_bytes(buffer.data(), len, address);
-    return std::string(buffer.data(), buffer.size());
+    std::string res;
+    res.resize(len);
+    this->read_bytes(&res[0], len, address);
+    return res;
   }
 
 };