Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
codacy
[simgrid.git] / src / mc / RegionSnapshot.hpp
index e54516a..52deff2 100644 (file)
@@ -1,5 +1,4 @@
-/* Copyright (c) 2007-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2007-2017. 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. */
 #include <cstddef>
 #include <utility>
 
-#include <xbt/base.h>
+#include <memory>
+#include <vector>
 
-#include "PageStore.hpp"
-#include "AddressSpace.hpp"
+#include "xbt/base.h"
+
+#include "src/mc/AddressSpace.hpp"
+#include "src/mc/ChunkedData.hpp"
+#include "src/mc/PageStore.hpp"
+#include "src/mc/remote/RemotePtr.hpp"
 
 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 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,
-    const size_t* ref_page_numbers, const std::uint64_t* pagemap);
-};
-
 enum class RegionType {
   Unknown = 0,
   Heap = 1,
   Data = 2
 };
 
-// TODO, use Boost.Variant instead of this
 enum class StorageType {
   NoData = 0,
   Flat = 1,
@@ -103,48 +35,85 @@ enum class StorageType {
   Privatized = 3
 };
 
-class data_deleter {
-public:
-  enum Type {
-    Free,
-    Munmap
-  };
+class Buffer {
 private:
-  Type type_;
+  enum class Type {
+    Malloc,
+    Mmap
+  };
+  void* data_ = nullptr;
   std::size_t size_;
+  Type type_ = Type::Malloc;
+private:
+  Buffer(std::size_t size, Type type = Type::Malloc);
+  Buffer(void* data, std::size_t size, Type type = Type::Malloc) :
+    data_(data), size_(size), type_(type) {}
 public:
-  data_deleter() : type_(Free) {}
-  data_deleter(Type type, std::size_t size) : type_(type), size_(size) {}
-  void operator()(void* p) const;
+  Buffer() = default;
+  void clear() noexcept;
+  ~Buffer() noexcept { clear(); }
+
+  static Buffer malloc(std::size_t size)
+  {
+    return Buffer(size, Type::Malloc);
+  }
+  static Buffer mmap(std::size_t size)
+  {
+    return Buffer(size, Type::Mmap);
+  }
+
+  // No copy
+  Buffer(Buffer const& buffer) = delete;
+  Buffer& operator=(Buffer const& buffer) = delete;
+
+  // Move
+  Buffer(Buffer&& that) noexcept
+    : data_(that.data_), size_(that.size_), type_(that.type_)
+  {
+    that.data_ = nullptr;
+    that.size_ = 0;
+    that.type_ = Type::Malloc;
+  }
+  Buffer& operator=(Buffer&& that) noexcept
+  {
+    clear();
+    data_ = that.data_;
+    size_ = that.size_;
+    type_ = that.type_;
+    that.data_ = nullptr;
+    that.size_ = 0;
+    that.type_ = Type::Malloc;
+    return *this;
+  }
+
+  void* get()              { return data_; }
+  const void* get()  const { return data_; }
+  std::size_t size() const { return size_; }
 };
 
-/** @brief Copy/snapshot of a given memory region
+/** 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>
  *
- *  This is handled with a variant based approch:
+ *  * flat/dense snapshots are a simple copy of the region;
  *
- *    * `storage_type` identified the type of storage;
- *    * an anonymous enum is used to distinguish the relevant types for
- *      each type.
+ *  * sparse/per-page snapshots are snaapshots which shared
+ *    identical pages.
+ *
+ *  * privatized (SMPI global variable privatization).
+ *
+ *  This is handled with a variant based approach:
+ *
+ *  * `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;
-  static const StorageType NoData = StorageType::NoData;
-  static const StorageType FlatData = StorageType::Flat;
-  static const StorageType ChunkedData = StorageType::Chunked;
-  static const StorageType PrivatizedData = StorageType::Privatized;
-public:
-  typedef std::unique_ptr<char[], data_deleter> flat_data_ptr;
 private:
   RegionType region_type_;
   StorageType storage_type_;
@@ -154,7 +123,7 @@ private:
   void *start_addr_;
 
   /** @brief Size of the data region in bytes */
-  size_t size_;
+  std::size_t size_;
 
   /** @brief Permanent virtual address of the region
    *
@@ -167,13 +136,13 @@ private:
    * */
   void *permanent_addr_;
 
-  flat_data_ptr flat_data_;
-  PerPageCopy page_numbers_;
+  Buffer flat_data_;
+  ChunkedData page_numbers_;
   std::vector<RegionSnapshot> privatized_regions_;
 public:
   RegionSnapshot() :
     region_type_(UnknownRegion),
-    storage_type_(NoData),
+    storage_type_(StorageType::NoData),
     object_info_(nullptr),
     start_addr_(nullptr),
     size_(0),
@@ -181,26 +150,26 @@ public:
   {}
   RegionSnapshot(RegionType type, void *start_addr, void* permanent_addr, size_t size) :
     region_type_(type),
-    storage_type_(NoData),
+    storage_type_(StorageType::NoData),
     object_info_(nullptr),
     start_addr_(start_addr),
     size_(size),
     permanent_addr_(permanent_addr)
   {}
-  ~RegionSnapshot() {}
+  ~RegionSnapshot()                     = default;
   RegionSnapshot(RegionSnapshot const&) = default;
   RegionSnapshot& operator=(RegionSnapshot const&) = default;
   RegionSnapshot(RegionSnapshot&& that)
+      : region_type_(that.region_type_)
+      , storage_type_(that.storage_type_)
+      , object_info_(that.object_info_)
+      , start_addr_(that.start_addr_)
+      , size_(that.size_)
+      , permanent_addr_(that.permanent_addr_)
+      , flat_data_(std::move(that.flat_data_))
+      , page_numbers_(std::move(that.page_numbers_))
+      , privatized_regions_(std::move(that.privatized_regions_))
   {
-    region_type_ = that.region_type_;
-    storage_type_ = that.storage_type_;
-    object_info_ = that.object_info_;
-    start_addr_ = that.start_addr_;
-    size_ = that.size_;
-    permanent_addr_ = that.permanent_addr_;
-    flat_data_ = std::move(that.flat_data_);
-    page_numbers_ = std::move(that.page_numbers_);
-    privatized_regions_ = std::move(that.privatized_regions_);
     that.clear();
   }
   RegionSnapshot& operator=(RegionSnapshot&& that)
@@ -223,10 +192,10 @@ public:
   void clear()
   {
     region_type_ = UnknownRegion;
-    storage_type_ = NoData;
+    storage_type_ = StorageType::NoData;
     privatized_regions_.clear();
     page_numbers_.clear();
-    flat_data_.reset();
+    flat_data_.clear();
     object_info_ = nullptr;
     start_addr_ = nullptr;
     size_ = 0;
@@ -235,34 +204,35 @@ public:
 
   void clear_data()
   {
-    storage_type_ = NoData;
-    flat_data_.reset();
+    storage_type_ = StorageType::NoData;
+    flat_data_.clear();
     page_numbers_.clear();
     privatized_regions_.clear();
   }
-  
-  void flat_data(flat_data_ptr data)
+
+  void flat_data(Buffer data)
   {
-    storage_type_ = FlatData;
+    storage_type_ = StorageType::Flat;
     flat_data_ = std::move(data);
     page_numbers_.clear();
     privatized_regions_.clear();
   }
-  const char* flat_data() const { return flat_data_.get(); }
+  const Buffer& flat_data() const { return flat_data_; }
+  Buffer& flat_data()             { return flat_data_; }
 
-  void page_data(PerPageCopy page_data)
+  void page_data(ChunkedData page_data)
   {
-    storage_type_ = ChunkedData;
-    flat_data_.reset();
+    storage_type_ = StorageType::Chunked;
+    flat_data_.clear();
     page_numbers_ = std::move(page_data);
     privatized_regions_.clear();
   }
-  PerPageCopy const& page_data() const { return page_numbers_; }
+  ChunkedData const& page_data() const { return page_numbers_; }
 
   void privatized_data(std::vector<RegionSnapshot> data)
   {
-    storage_type_ = PrivatizedData;
-    flat_data_.reset();
+    storage_type_ = StorageType::Privatized;
+    flat_data_.clear();
     page_numbers_.clear();
     privatized_regions_ = std::move(data);
   }
@@ -280,33 +250,32 @@ public:
 
   // 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_); }
+  RemotePtr<void> start() const { return remote(start_addr_); }
+  RemotePtr<void> end() const { return remote((char*)start_addr_ + size_); }
+  RemotePtr<void> permanent_address() const { return remote(permanent_addr_); }
   std::size_t size() const { return size_; }
   StorageType storage_type() const { return storage_type_; }
   RegionType region_type() const { return region_type_; }
 
-  bool contain(remote_ptr<void> p) const
+  bool contain(RemotePtr<void> p) const
   {
     return p >= start() && p < end();
   }
 };
 
 RegionSnapshot privatized_region(
-  RegionType type, void *start_addr, void* data_addr, size_t size);
+    RegionType region_type, void *start_addr, void* permanent_addr,
+    std::size_t size);
 RegionSnapshot dense_region(
-  RegionType type, void *start_addr, void* data_addr, size_t size);
+  RegionType type, void *start_addr, void* data_addr, std::size_t size);
 simgrid::mc::RegionSnapshot sparse_region(
-  RegionType type, void *start_addr, void* data_addr, size_t size,
-  RegionSnapshot const* ref_region);
+  RegionType type, void *start_addr, void* data_addr, std::size_t size);
 simgrid::mc::RegionSnapshot region(
-  RegionType type, void *start_addr, void* data_addr, size_t size,
-  RegionSnapshot const* ref_region);
+  RegionType type, void *start_addr, void* data_addr, std::size_t size);
 
 }
 }
 
-typedef class simgrid::mc::RegionSnapshot s_mc_mem_region_t, *mc_mem_region_t;
-
+typedef class simgrid::mc::RegionSnapshot s_mc_mem_region_t;
+typedef s_mc_mem_region_t* mc_mem_region_t;
 #endif