src/mc/AddressSpace.hpp

   1 /* Copyright (c) 2008-2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #ifndef SIMGRID_MC_ADDRESS_SPACE_H
   8 #define SIMGRID_MC_ADDRESS_SPACE_H
   9
  10 #include <cassert>
  11 #include <cstddef>
  12 #include <cstdint>
  13 #include <cstring>
  14 #include <type_traits>
  15
  16 #include <string>
  17 #include <vector>
  18
  19 #include "src/mc/mc_forward.hpp"
  20 #include "src/mc/remote/RemotePtr.hpp"
  21
  22 namespace simgrid {
  23 namespace mc {
  24
  25 /** Process index used when no process is available (SMPI privatization)
  26  *
  27  *  The expected behavior is that if a process index is needed it will fail.
  28  * */
  29 const int ProcessIndexMissing = -1;
  30
  31 /** Process index used when we don't care about the process index (SMPI privatization)
  32  * */
  33 const int ProcessIndexDisabled = -2;
  34
  35 /** Constant used when any process will do (SMPI privatization)
  36  *
  37  *  Note: This is is index of the first process.
  38  */
  39 const int ProcessIndexAny = 0;
  40
  41 /** Options for read operations
  42  *
  43  *  This is a set of flags managed with bitwise operators. Only the
  44  *  meaningful operations are defined: addition, conversions to/from
  45  *  integers are not allowed.
  46  */
  47 class ReadOptions {
  48   std::uint32_t value_;
  49   constexpr explicit ReadOptions(std::uint32_t value) : value_(value) {}
  50 public:
  51   constexpr ReadOptions() : value_(0) {}
  52
  53   explicit constexpr operator bool() const { return value_ != 0; }
  54   constexpr bool operator!() const { return value_ == 0; }
  55
  56   constexpr ReadOptions operator|(ReadOptions const& that) const
  57   {
  58     return ReadOptions(value_ | that.value_);
  59   }
  60   constexpr ReadOptions operator&(ReadOptions const& that) const
  61   {
  62     return ReadOptions(value_ & that.value_);
  63   }
  64   constexpr ReadOptions operator^(ReadOptions const& that) const
  65   {
  66     return ReadOptions(value_ ^ that.value_);
  67   }
  68   constexpr ReadOptions operator~() const
  69   {
  70     return ReadOptions(~value_);
  71   }
  72
  73   ReadOptions& operator|=(ReadOptions const& that)
  74   {
  75     value_ |= that.value_;
  76     return *this;
  77   }
  78   ReadOptions& operator&=(ReadOptions const& that)
  79   {
  80     value_ &= that.value_;
  81     return *this;
  82   }
  83   ReadOptions& operator^=(ReadOptions const& that)
  84   {
  85     value_ &= that.value_;
  86     return *this;
  87   }
  88
  89   /** Copy the data to the given buffer */
  90   static constexpr ReadOptions none() { return ReadOptions(0); }
  91
  92   /** Allows to return a pointer to another buffer where the data is
  93    *  available instead of copying the data into the buffer
  94    */
  95   static constexpr ReadOptions lazy() { return ReadOptions(1); }
  96 };
  97
  98 /** A given state of a given process (abstract base class)
  99  *
 100  *  Currently, this might either be:
 101  *
 102  *  * the current state of an existing process;
 103  *
 104  *  * a snapshot.
 105  *
 106  *  In order to support SMPI privatization, the can read the memory from the
 107  *  context of a given SMPI process: if specified, the code reads data from the
 108  *  correct SMPI privatization VMA.
 109  */
 110 class AddressSpace {
 111 private:
 112   RemoteClient* process_;
 113
 114 public:
 115   explicit AddressSpace(RemoteClient* process) : process_(process) {}
 116   virtual ~AddressSpace() = default;
 117
 118   /** The process of this address space
 119    *
 120    *  This is where we can get debug informations, memory layout, etc.
 121    */
 122   simgrid::mc::RemoteClient* process() const { return process_; }
 123
 124   /** Read data from the address space
 125    *
 126    *  @param buffer        target buffer for the data
 127    *  @param size          number of bytes to read
 128    *  @param address       remote source address of the data
 129    *  @param process_index which process (used for SMPI privatization)
 130    *  @param options
 131    */
 132   virtual const void* read_bytes(void* buffer, std::size_t size,
 133     RemotePtr<void> address, int process_index = ProcessIndexAny,
 134     ReadOptions options = ReadOptions::none()) const = 0;
 135
 136   /** Read a given data structure from the address space */
 137   template<class T> inline
 138   void read(T *buffer, RemotePtr<T> ptr, int process_index = ProcessIndexAny) const
 139   {
 140     this->read_bytes(buffer, sizeof(T), ptr, process_index);
 141   }
 142
 143   template<class T> inline
 144   void read(Remote<T>& buffer, RemotePtr<T> ptr, int process_index = ProcessIndexAny) const
 145   {
 146     this->read_bytes(buffer.getBuffer(), sizeof(T), ptr, process_index);
 147   }
 148
 149   /** Read a given data structure from the addres space
 150    *
 151    *  This version returns by value.
 152    */
 153   template<class T> inline
 154   Remote<T> read(RemotePtr<T> ptr, int process_index = ProcessIndexMissing) const
 155   {
 156     Remote<T> res;
 157     this->read_bytes(&res, sizeof(T), ptr, process_index);
 158     return res;
 159   }
 160
 161   /** Read a string of known size */
 162   std::string read_string(RemotePtr<char> address, std::size_t len) const
 163   {
 164     std::string res;
 165     res.resize(len);
 166     this->read_bytes(&res[0], len, address);
 167     return res;
 168   }
 169
 170 };
 171
 172 }
 173 }
 174
 175 #endif