X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/218c42a20c7eaba87e20cfb3eaac5ad8e0d0f739..ff420e1906d916322427488153e45bf82d5c03dd:/src/mc/ChunkedData.hpp

diff --git a/src/mc/ChunkedData.hpp b/src/mc/ChunkedData.hpp
index 0ec1cb2404..52b56c9a55 100644
--- a/src/mc/ChunkedData.hpp
+++ b/src/mc/ChunkedData.hpp
@@ -1,33 +1,43 @@
+/* Copyright (c) 2014-2018. 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_CHUNKED_DATA_HPP
 #define SIMGRID_MC_CHUNKED_DATA_HPP
 
 #include <cstddef>
 #include <cstdint>
 
+#include <utility>
 #include <vector>
 
-#include <mc/mc_forward.hpp>
-#include <mc/AddressSpace.hpp>
-#include <mc/PageStore.hpp>
+#include "src/mc/mc_forward.hpp"
+#include "src/mc/PageStore.hpp"
 
 namespace simgrid {
 namespace mc {
 
+/** A byte-string represented as a sequence of chunks from a PageStore
+ *
+ *  In order to save memory when taking memory snapshots, a given byte-string
+ *  is split in fixed-size chunks. Identical chunks (either from the same
+ *  snapshot or more probably from different snpashots) share the same memory
+ *  storage.
+ *
+ *  Thus a chunked is represented as a sequence of indices of each chunk.
+ */
 class ChunkedData {
-  PageStore* store_;
+  /** This is where we store the chunks */
+  PageStore* store_ = nullptr;
+  /** Indices of the chunks in the `PageStore` */
   std::vector<std::size_t> pagenos_;
 public:
-  ChunkedData() : store_(nullptr) {}
-  ChunkedData(ChunkedData const& that)
-  {
-    store_ = that.store_;
-    pagenos_ = that.pagenos_;
-    for (std::size_t pageno : pagenos_)
-      store_->ref_page(pageno);
-  }
+
+  ChunkedData() = default;
   void clear()
   {
-    for (std::size_t pageno : pagenos_)
+    for (std::size_t const& pageno : pagenos_)
       store_->unref_page(pageno);
     pagenos_.clear();
   }
@@ -36,11 +46,19 @@ public:
     clear();
   }
 
+  // Copy and move
+  ChunkedData(ChunkedData const& that)
+     : store_ (that.store_)
+     , pagenos_(that.pagenos_)
+  {
+    for (std::size_t const& pageno : pagenos_)
+      store_->ref_page(pageno);
+  }
   ChunkedData(ChunkedData&& that)
+     : store_(that.store_)
+     , pagenos_(std::move(that.pagenos_))
   {
-    store_ = that.store_;
     that.store_ = nullptr;
-    pagenos_ = std::move(that.pagenos_);
     that.pagenos_.clear();
   }
   ChunkedData& operator=(ChunkedData const& that)
@@ -48,7 +66,7 @@ public:
     this->clear();
     store_ = that.store_;
     pagenos_ = that.pagenos_;
-    for (std::size_t pageno : pagenos_)
+    for (std::size_t const& pageno : pagenos_)
       store_->ref_page(pageno);
     return *this;
   }
@@ -62,19 +80,23 @@ public:
     return *this;
   }
 
+  /** How many pages are used */
   std::size_t page_count()          const { return pagenos_.size(); }
+
+  /** Get a chunk index */
   std::size_t pageno(std::size_t i) const { return pagenos_[i]; }
+
+  /** Get a view of the chunk indices */
   const std::size_t* pagenos()      const { return pagenos_.data(); }
-  std::size_t*       pagenos()            { return pagenos_.data(); }
 
+  /** Get a a pointer to a chunk */
   const void* page(std::size_t i) const
   {
     return store_->get_page(pagenos_[i]);
   }
 
   ChunkedData(PageStore& store, AddressSpace& as,
-    remote_ptr<void> addr, std::size_t page_count,
-    const std::size_t* ref_page_numbers, const std::uint64_t* pagemap);
+    RemotePtr<void> addr, std::size_t page_count);
 };
 
 }