1 /* Copyright (c) 2007-2015. The SimGrid Team.
2 * All rights reserved. */
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. */
7 #ifndef SIMGRID_MC_REGION_SNAPSHOT_HPP
8 #define SIMGRID_MC_REGION_SNAPSHOT_HPP
15 #include "src/mc/PageStore.hpp"
16 #include "src/mc/AddressSpace.hpp"
17 #include "src/mc/ChunkedData.hpp"
22 enum class RegionType {
28 // TODO, use Boost.Variant instead of this
29 enum class StorageType {
46 data_deleter() : type_(Free) {}
47 data_deleter(Type type, std::size_t size) : type_(type), size_(size) {}
48 void operator()(void* p) const;
51 typedef std::unique_ptr<char[], data_deleter> unique_data_ptr;
53 /** A copy/snapshot of a given memory region
55 * Different types of region snapshot storage types exist:
57 * * flat/dense snapshots are a simple copy of the region;
59 * * sparse/per-page snapshots are snaapshots which shared
62 * * privatized (SMPI global variable privatisation).
64 * This is handled with a variant based approch:
66 * * `storage_type` identified the type of storage;
68 * * an anonymous enum is used to distinguish the relevant types for
71 class RegionSnapshot {
73 static const RegionType UnknownRegion = RegionType::Unknown;
74 static const RegionType HeapRegion = RegionType::Heap;
75 static const RegionType DataRegion = RegionType::Data;
77 typedef unique_data_ptr flat_data_ptr;
79 RegionType region_type_;
80 StorageType storage_type_;
81 simgrid::mc::ObjectInformation* object_info_;
83 /** @brief Virtual address of the region in the simulated process */
86 /** @brief Size of the data region in bytes */
89 /** @brief Permanent virtual address of the region
91 * This is usually the same address as the simuilated process address.
92 * However, when using SMPI privatization of global variables,
93 * each SMPI process has its own set of global variables stored
94 * at a different virtual address. The scheduler maps those region
95 * on the region of the global variables.
98 void *permanent_addr_;
100 flat_data_ptr flat_data_;
101 ChunkedData page_numbers_;
102 std::vector<RegionSnapshot> privatized_regions_;
105 region_type_(UnknownRegion),
106 storage_type_(StorageType::NoData),
107 object_info_(nullptr),
108 start_addr_(nullptr),
110 permanent_addr_(nullptr)
112 RegionSnapshot(RegionType type, void *start_addr, void* permanent_addr, size_t size) :
114 storage_type_(StorageType::NoData),
115 object_info_(nullptr),
116 start_addr_(start_addr),
118 permanent_addr_(permanent_addr)
121 RegionSnapshot(RegionSnapshot const&) = default;
122 RegionSnapshot& operator=(RegionSnapshot const&) = default;
123 RegionSnapshot(RegionSnapshot&& that)
125 region_type_ = that.region_type_;
126 storage_type_ = that.storage_type_;
127 object_info_ = that.object_info_;
128 start_addr_ = that.start_addr_;
130 permanent_addr_ = that.permanent_addr_;
131 flat_data_ = std::move(that.flat_data_);
132 page_numbers_ = std::move(that.page_numbers_);
133 privatized_regions_ = std::move(that.privatized_regions_);
136 RegionSnapshot& operator=(RegionSnapshot&& that)
138 region_type_ = that.region_type_;
139 storage_type_ = that.storage_type_;
140 object_info_ = that.object_info_;
141 start_addr_ = that.start_addr_;
143 permanent_addr_ = that.permanent_addr_;
144 flat_data_ = std::move(that.flat_data_);
145 page_numbers_ = std::move(that.page_numbers_);
146 privatized_regions_ = std::move(that.privatized_regions_);
155 region_type_ = UnknownRegion;
156 storage_type_ = StorageType::NoData;
157 privatized_regions_.clear();
158 page_numbers_.clear();
160 object_info_ = nullptr;
161 start_addr_ = nullptr;
163 permanent_addr_ = nullptr;
168 storage_type_ = StorageType::NoData;
170 page_numbers_.clear();
171 privatized_regions_.clear();
174 void flat_data(flat_data_ptr data)
176 storage_type_ = StorageType::Flat;
177 flat_data_ = std::move(data);
178 page_numbers_.clear();
179 privatized_regions_.clear();
181 const char* flat_data() const { return flat_data_.get(); }
183 void page_data(ChunkedData page_data)
185 storage_type_ = StorageType::Chunked;
187 page_numbers_ = std::move(page_data);
188 privatized_regions_.clear();
190 ChunkedData const& page_data() const { return page_numbers_; }
192 void privatized_data(std::vector<RegionSnapshot> data)
194 storage_type_ = StorageType::Privatized;
196 page_numbers_.clear();
197 privatized_regions_ = std::move(data);
199 std::vector<RegionSnapshot> const& privatized_data() const
201 return privatized_regions_;
203 std::vector<RegionSnapshot>& privatized_data()
205 return privatized_regions_;
208 simgrid::mc::ObjectInformation* object_info() const { return object_info_; }
209 void object_info(simgrid::mc::ObjectInformation* info) { object_info_ = info; }
213 remote_ptr<void> start() const { return remote(start_addr_); }
214 remote_ptr<void> end() const { return remote((char*)start_addr_ + size_); }
215 remote_ptr<void> permanent_address() const { return remote(permanent_addr_); }
216 std::size_t size() const { return size_; }
217 StorageType storage_type() const { return storage_type_; }
218 RegionType region_type() const { return region_type_; }
220 bool contain(remote_ptr<void> p) const
222 return p >= start() && p < end();
226 RegionSnapshot privatized_region(
227 RegionType type, void *start_addr, void* data_addr, std::size_t size);
228 RegionSnapshot dense_region(
229 RegionType type, void *start_addr, void* data_addr, std::size_t size);
230 simgrid::mc::RegionSnapshot sparse_region(
231 RegionType type, void *start_addr, void* data_addr, std::size_t size,
232 RegionSnapshot const* ref_region);
233 simgrid::mc::RegionSnapshot region(
234 RegionType type, void *start_addr, void* data_addr, std::size_t size,
235 RegionSnapshot const* ref_region);
240 typedef class simgrid::mc::RegionSnapshot s_mc_mem_region_t, *mc_mem_region_t;