[mc] Documentation

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

diff --git a/src/mc/RegionSnapshot.hpp b/src/mc/RegionSnapshot.hpp
index e427a29..9b74130 100644 (file)
--- a/src/mc/RegionSnapshot.hpp
+++ b/src/mc/RegionSnapshot.hpp
@@ -12,8 +12,8 @@
 
 #include <xbt/base.h>
 
-#include "PageStore.hpp"
-#include "AddressSpace.hpp"
+#include <mc/PageStore.hpp>
+#include <mc/AddressSpace.hpp>
 
 namespace simgrid {
 namespace mc {
@@ -76,13 +76,17 @@ public:
     return pagenos_[i];
   }
 
+  const std::size_t* pagenos() const { return pagenos_.data(); }
+  std::size_t*       pagenos()       { return pagenos_.data(); }
+
   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);
+    remote_ptr<void> addr, std::size_t page_count,
+    const size_t* ref_page_numbers, const std::uint64_t* pagemap);
 };
 
 enum class RegionType {
@@ -99,23 +103,43 @@ enum class StorageType {
   Privatized = 3
 };
 
-/** @brief Copy/snapshot of a given memory region
+class data_deleter {
+public:
+  enum Type {
+    Free,
+    Munmap
+  };
+private:
+  Type type_;
+  std::size_t size_;
+public:
+  data_deleter() : type_(Free) {}
+  data_deleter(Type type, std::size_t size) : type_(type), size_(size) {}
+  void operator()(void* p) const;
+};
+
+typedef std::unique_ptr<char[], data_deleter> unique_data_ptr;
+
+/** A 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>
+ *
+ *  * flat/dense snapshots are a simple copy of the region;
+ *
+ *  * sparse/per-page snapshots are snaapshots which shared
+ *    identical pages.
+ *
+ *  * privatized (SMPI global variable privatisation).
  *
  *  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.
+ *  * `storage_type` identified the type of storage;
+ *
+ *  * an anonymous enum is used to distinguish the relevant types for
+ *    each type.
  */
 class RegionSnapshot {
+public:
   static const RegionType UnknownRegion = RegionType::Unknown;
   static const RegionType HeapRegion = RegionType::Heap;
   static const RegionType DataRegion = RegionType::Data;
@@ -123,6 +147,8 @@ class RegionSnapshot {
   static const StorageType FlatData = StorageType::Flat;
   static const StorageType ChunkedData = StorageType::Chunked;
   static const StorageType PrivatizedData = StorageType::Privatized;
+public:
+  typedef unique_data_ptr flat_data_ptr;
 private:
   RegionType region_type_;
   StorageType storage_type_;
@@ -145,7 +171,7 @@ private:
    * */
   void *permanent_addr_;
 
-  std::vector<char> flat_data_;
+  flat_data_ptr flat_data_;
   PerPageCopy page_numbers_;
   std::vector<RegionSnapshot> privatized_regions_;
 public:
@@ -204,7 +230,7 @@ public:
     storage_type_ = NoData;
     privatized_regions_.clear();
     page_numbers_.clear();
-    flat_data_.clear();
+    flat_data_.reset();
     object_info_ = nullptr;
     start_addr_ = nullptr;
     size_ = 0;
@@ -214,24 +240,24 @@ public:
   void clear_data()
   {
     storage_type_ = NoData;
-    flat_data_.clear();
+    flat_data_.reset();
     page_numbers_.clear();
     privatized_regions_.clear();
   }
   
-  void flat_data(std::vector<char> data)
+  void flat_data(flat_data_ptr data)
   {
     storage_type_ = FlatData;
     flat_data_ = std::move(data);
     page_numbers_.clear();
     privatized_regions_.clear();
   }
-  std::vector<char> const& flat_data() const { return flat_data_; }
+  const char* flat_data() const { return flat_data_.get(); }
 
   void page_data(PerPageCopy page_data)
   {
     storage_type_ = ChunkedData;
-    flat_data_.clear();
+    flat_data_.reset();
     page_numbers_ = std::move(page_data);
     privatized_regions_.clear();
   }
@@ -240,7 +266,7 @@ public:
   void privatized_data(std::vector<RegionSnapshot> data)
   {
     storage_type_ = PrivatizedData;
-    flat_data_.clear();
+    flat_data_.reset();
     page_numbers_.clear();
     privatized_regions_ = std::move(data);
   }
@@ -276,10 +302,12 @@ RegionSnapshot privatized_region(
 RegionSnapshot dense_region(
   RegionType type, void *start_addr, void* data_addr, size_t size);
 simgrid::mc::RegionSnapshot sparse_region(
-  RegionType type, void *start_addr, void* data_addr, size_t size);
+  RegionType type, void *start_addr, void* data_addr, size_t size,
+  RegionSnapshot const* ref_region);
 simgrid::mc::RegionSnapshot region(
-  RegionType type, void *start_addr, void* data_addr, size_t size);
-  
+  RegionType type, void *start_addr, void* data_addr, size_t size,
+  RegionSnapshot const* ref_region);
+
 }
 }