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 ea260c2..a7658e6 100644 (file)
@@ -1,5 +1,4 @@
-/* Copyright (c) 2008-2014. 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. */
 #ifndef SIMGRID_MC_ADDRESS_SPACE_H
 #define SIMGRID_MC_ADDRESS_SPACE_H
 
-#include <cstdint>
-#include <type_traits>
+#include "src/mc/mc_forward.hpp"
+#include "src/mc/remote/RemotePtr.hpp"
 
-#include <xbt/misc.h>
+namespace simgrid {
+namespace mc {
 
-#include <stdint.h>
+/** Process index used when no process is available (SMPI privatization)
+ *
+ *  The expected behavior is that if a process index is needed it will fail.
+ * */
+const int ProcessIndexMissing = -1;
 
-#include "mc_forward.h"
+/** Process index used when we don't care about the process index (SMPI privatization)
+ * */
+const int ProcessIndexDisabled = -2;
 
-namespace simgrid {
-namespace mc {
+/** Constant used when any process will do (SMPI privatization)
+ *
+ *  Note: This is is index of the first process.
+ */
+const int ProcessIndexAny = 0;
 
-/** Pointer to a remote address-space (process, snapshot)
+/** Options for read operations
  *
- *  With this we can clearly identify the expected type of an address in the
- *  remote process whild avoiding to use native local pointers.
+ *  This is a set of flags managed with bitwise operators. Only the
+ *  meaningful operations are defined: addition, conversions to/from
+ *  integers are not allowed.
  */
-template<class T> class remote_ptr {
-  std::uint64_t address_;
+class ReadOptions {
+  std::uint32_t value_;
+  constexpr explicit ReadOptions(std::uint32_t value) : value_(value) {}
 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
+  constexpr ReadOptions() : value_(0) {}
+
+  explicit constexpr operator bool() const { return value_ != 0; }
+  constexpr bool operator!() const { return value_ == 0; }
+
+  constexpr ReadOptions operator|(ReadOptions const& that) const
   {
-    return address_;
+    return ReadOptions(value_ | that.value_);
   }
-  bool operator!() const
+  constexpr ReadOptions operator&(ReadOptions const& that) const
   {
-    return !address_;
+    return ReadOptions(value_ & that.value_);
   }
-  operator remote_ptr<void>() const
+  constexpr ReadOptions operator^(ReadOptions const& that) const
   {
-    return remote_ptr<void>(address_);
+    return ReadOptions(value_ ^ that.value_);
   }
-  remote_ptr<T> operator+(std::uint64_t n) const
+  constexpr ReadOptions operator~() const
   {
-    return remote_ptr<T>(address_ + n * sizeof(T));
+    return ReadOptions(~value_);
   }
-  remote_ptr<T> operator-(std::uint64_t n) const
+
+  ReadOptions& operator|=(ReadOptions const& that)
   {
-    return remote_ptr<T>(address_ - n * sizeof(T));
+    value_ |= that.value_;
+    return *this;
   }
-  remote_ptr<T>& operator+=(std::uint64_t n) const
+  ReadOptions& operator&=(ReadOptions const& that)
   {
-    address_ += n * sizeof(T);
+    value_ &= that.value_;
     return *this;
   }
-  remote_ptr<T>& operator-=(std::uint64_t n) const
+  ReadOptions& operator^=(ReadOptions const& that)
   {
-    address_ -= n * sizeof(T);
+    value_ &= that.value_;
     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();
-}
+  /** Copy the data to the given buffer */
+  static constexpr ReadOptions none() { return ReadOptions(0); }
 
-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);
-}
+  /** Allows to return a pointer to another buffer where the data is
+   *  available instead of copying the data into the buffer
+   */
+  static constexpr ReadOptions lazy() { return ReadOptions(1); }
+};
 
-/** Process index used when no process is available
+/** A given state of a given process (abstract base class)
  *
- *  The expected behaviour 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
- * */
-const int ProcessIndexDisabled = -2;
-
-/** Constant used when any process will do.
+ *  Currently, this might either be:
+ *
+ *  * the current state of an existing process;
  *
- *  This is is index of the first 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.
  */
-const int ProcessIndexAny = 0;
-
 class AddressSpace {
+private:
+  RemoteClient* process_;
+
 public:
-  enum ReadMode {
-    Normal,
-    /** Allows the `read_bytes` to return a pointer to another buffer
-     *  where the data ins available instead of copying the data into the buffer
-     */
-    Lazy
-  };
-  virtual ~AddressSpace();
+  explicit AddressSpace(RemoteClient* process) : process_(process) {}
+  virtual ~AddressSpace() = default;
+
+  /** 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 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,
-    ReadMode mode = Normal) const = 0;
+    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);
   }
 
   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
+  {
+    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
   {
-    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);
+    std::string res;
+    res.resize(len);
+    this->read_bytes(&res[0], len, address);
+    return res;
   }
+
 };
 
 }