Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] C++ify RegionType, StorageType enums
[simgrid.git] / src / mc / mc_snapshot.h
index 9204ea6..ee42ed6 100644 (file)
 #include "mc_mmalloc.h"
 #include "mc/AddressSpace.hpp"
 #include "mc_unw.h"
+#include "RegionSnapshot.hpp"
 
 SG_BEGIN_DECL()
 
 // ***** Snapshot region
 
-typedef enum e_mc_region_type_t {
-  MC_REGION_TYPE_UNKNOWN = 0,
-  MC_REGION_TYPE_HEAP = 1,
-  MC_REGION_TYPE_DATA = 2
-} mc_region_type_t;
-
-// TODO, use OO instead of this
-typedef enum e_mc_region_storage_type_t {
-  MC_REGION_STORAGE_TYPE_NONE = 0,
-  MC_REGION_STORAGE_TYPE_FLAT = 1,
-  MC_REGION_STORAGE_TYPE_CHUNKED = 2,
-  MC_REGION_STORAGE_TYPE_PRIVATIZED = 3
-} mc_region_storage_type_t;
-
-namespace simgrid {
-namespace mc {
-
-class PerPageCopy {
-  PageStore* store_;
-  std::vector<std::size_t> pagenos_;
-public:
-  PerPageCopy() : store_(nullptr) {}
-  PerPageCopy(PerPageCopy const& that)
-  {
-    store_ = that.store_;
-    pagenos_ = that.pagenos_;
-    for (std::size_t pageno : pagenos_)
-      store_->ref_page(pageno);
-  }
-  void clear()
-  {
-    for (std::size_t pageno : pagenos_)
-      store_->unref_page(pageno);
-    pagenos_.clear();
-  }
-  ~PerPageCopy() {
-    clear();
-  }
-
-  PerPageCopy(PerPageCopy&& that)
-  {
-    store_ = that.store_;
-    that.store_ = nullptr;
-    pagenos_ = std::move(that.pagenos_);
-    that.pagenos_.clear();
-  }
-  PerPageCopy& operator=(PerPageCopy const& that)
-  {
-    this->clear();
-    store_ = that.store_;
-    pagenos_ = that.pagenos_;
-    for (std::size_t pageno : pagenos_)
-      store_->ref_page(pageno);
-    return *this;
-  }
-  PerPageCopy& operator=(PerPageCopy && that)
-  {
-    this->clear();
-    store_ = that.store_;
-    that.store_ = nullptr;
-    pagenos_ = std::move(that.pagenos_);
-    that.pagenos_.clear();
-    return *this;
-  }
-
-  std::size_t page_count() const
-  {
-    return pagenos_.size();
-  }
-
-  std::size_t pageno(std::size_t i) const
-  {
-    return pagenos_[i];
-  }
-
-  const void* page(std::size_t i) const
-  {
-    return store_->get_page(pagenos_[i]);
-  }
-
-  PerPageCopy(PageStore& store, AddressSpace& as,
-    remote_ptr<void> addr, std::size_t page_count);
-};
-
-/** @brief Copy/snapshot of a given memory region
- *
- *  Different types of region snapshot storage types exist:
- *  <ul>
- *    <li>flat/dense snapshots are a simple copy of the region;</li>
- *    <li>sparse/per-page snapshots are snaapshots which shared
- *    identical pages.</li>
- *    <li>privatized (SMPI global variable privatisation).
- *  </ul>
- *
- *  This is handled with a variant based approch:
- *
- *    * `storage_type` identified the type of storage;
- *    * an anonymous enum is used to distinguish the relevant types for
- *      each type.
- */
-class RegionSnapshot {
-private:
-  mc_region_type_t region_type_;
-  mc_region_storage_type_t storage_type_;
-  mc_object_info_t object_info_;
-
-  /** @brief  Virtual address of the region in the simulated process */
-  void *start_addr_;
-
-  /** @brief Size of the data region in bytes */
-  size_t size_;
-
-  /** @brief Permanent virtual address of the region
-   *
-   * This is usually the same address as the simuilated process address.
-   * However, when using SMPI privatization of global variables,
-   * each SMPI process has its own set of global variables stored
-   * at a different virtual address. The scheduler maps those region
-   * on the region of the global variables.
-   *
-   * */
-  void *permanent_addr_;
-
-  std::vector<char> flat_data_;
-  PerPageCopy page_numbers_;
-  std::vector<std::unique_ptr<RegionSnapshot>> privatized_regions_;
-public:
-  RegionSnapshot() :
-    region_type_(MC_REGION_TYPE_UNKNOWN),
-    storage_type_(MC_REGION_STORAGE_TYPE_NONE),
-    object_info_(nullptr),
-    start_addr_(nullptr),
-    size_(0),
-    permanent_addr_(nullptr)
-  {}
-  RegionSnapshot(mc_region_type_t type, void *start_addr, void* permanent_addr, size_t size) :
-    region_type_(type),
-    storage_type_(MC_REGION_STORAGE_TYPE_NONE),
-    object_info_(nullptr),
-    start_addr_(start_addr),
-    size_(size),
-    permanent_addr_(permanent_addr)
-  {}
-  ~RegionSnapshot();
-  RegionSnapshot(RegionSnapshot const&) = delete;
-  RegionSnapshot& operator=(RegionSnapshot const&) = delete;
-
-  // Data
-
-  void clear_data()
-  {
-    storage_type_ = MC_REGION_STORAGE_TYPE_NONE;
-    flat_data_.clear();
-    page_numbers_.clear();
-    privatized_regions_.clear();
-  }
-  
-  void flat_data(std::vector<char> data)
-  {
-    storage_type_ = MC_REGION_STORAGE_TYPE_FLAT;
-    flat_data_ = std::move(data);
-    page_numbers_.clear();
-    privatized_regions_.clear();
-  }
-  std::vector<char> const& flat_data() const { return flat_data_; }
-
-  void page_data(PerPageCopy page_data)
-  {
-    storage_type_ = MC_REGION_STORAGE_TYPE_CHUNKED;
-    flat_data_.clear();
-    page_numbers_ = std::move(page_data);
-    privatized_regions_.clear();
-  }
-  PerPageCopy const& page_data() const { return page_numbers_; }
-
-  void privatized_data(std::vector<std::unique_ptr<RegionSnapshot>> data)
-  {
-    storage_type_ = MC_REGION_STORAGE_TYPE_PRIVATIZED;
-    flat_data_.clear();
-    page_numbers_.clear();
-    privatized_regions_ = std::move(data);
-  }
-  std::vector<std::unique_ptr<RegionSnapshot>> const& privatized_data() const
-  {
-    return privatized_regions_;
-  }
-
-  mc_object_info_t object_info() const { return object_info_; }
-  void object_info(mc_object_info_t info) { object_info_ = info; }
-
-  // Other getters
-
-  remote_ptr<void> start() const { return remote(start_addr_); }
-  remote_ptr<void> end() const { return remote((char*)start_addr_ + size_); }
-  remote_ptr<void> permanent_address() const { return remote(permanent_addr_); }
-  std::size_t size() const { return size_; }
-  mc_region_storage_type_t storage_type() const { return storage_type_; }
-  mc_region_type_t region_type() const { return region_type_; }
-
-  bool contain(remote_ptr<void> p) const
-  {
-    return p >= start() && p < end();
-  }
-};
-
-}
-}
-
-typedef class simgrid::mc::RegionSnapshot s_mc_mem_region_t, *mc_mem_region_t;
-
-MC_SHOULD_BE_INTERNAL mc_mem_region_t mc_region_new_sparse(
-  mc_region_type_t type, void *start_addr, void* data_addr, size_t size);
 XBT_INTERNAL void mc_region_restore_sparse(mc_process_t process, mc_mem_region_t reg);
 
 static inline  __attribute__ ((always_inline))
@@ -259,28 +48,27 @@ static inline __attribute__((always_inline))
 void* mc_translate_address_region(uintptr_t addr, mc_mem_region_t region, int process_index)
 {
   switch (region->storage_type()) {
-  case MC_REGION_STORAGE_TYPE_NONE:
+  case simgrid::mc::StorageType::NoData:
   default:
     xbt_die("Storage type not supported");
 
-  case MC_REGION_STORAGE_TYPE_FLAT:
+  case simgrid::mc::StorageType::Flat:
     {
       uintptr_t offset = (uintptr_t) addr - (uintptr_t) region->start().address();
       return (void *) ((uintptr_t) region->flat_data().data() + offset);
     }
 
-  case MC_REGION_STORAGE_TYPE_CHUNKED:
+  case simgrid::mc::StorageType::Chunked:
     return mc_translate_address_region_chunked(addr, region);
 
-  case MC_REGION_STORAGE_TYPE_PRIVATIZED:
+  case simgrid::mc::StorageType::Privatized:
     {
       xbt_assert(process_index >=0,
         "Missing process index for privatized region");
       xbt_assert((size_t) process_index < region->privatized_data().size(),
         "Out of range process index");
-      mc_mem_region_t subregion = region->privatized_data()[process_index].get();
-      xbt_assert(subregion, "Missing memory region for process %i", process_index);
-      return mc_translate_address_region(addr, subregion, process_index);
+      simgrid::mc::RegionSnapshot& subregion= region->privatized_data()[process_index];
+      return mc_translate_address_region(addr, &subregion, process_index);
     }
   }
 }
@@ -429,14 +217,14 @@ const void* MC_region_read(mc_mem_region_t region, void* target, const void* add
     "Trying to read out of the region boundary.");
 
   switch (region->storage_type()) {
-  case MC_REGION_STORAGE_TYPE_NONE:
+  case simgrid::mc::StorageType::NoData:
   default:
     xbt_die("Storage type not supported");
 
-  case MC_REGION_STORAGE_TYPE_FLAT:
+  case simgrid::mc::StorageType::Flat:
     return (char*) region->flat_data().data() + offset;
 
-  case MC_REGION_STORAGE_TYPE_CHUNKED:
+  case simgrid::mc::StorageType::Chunked:
     {
       // Last byte of the region:
       void* end = (char*) addr + size - 1;
@@ -451,7 +239,7 @@ const void* MC_region_read(mc_mem_region_t region, void* target, const void* add
 
   // We currently do not pass the process_index to this function so we assume
   // that the privatized region has been resolved in the callers:
-  case MC_REGION_STORAGE_TYPE_PRIVATIZED:
+  case simgrid::mc::StorageType::Privatized:
     xbt_die("Storage type not supported");
   }
 }