1 /* Copyright (c) 2007-2017. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #ifndef SIMGRID_MC_REGION_SNAPSHOT_HPP
7 #define SIMGRID_MC_REGION_SNAPSHOT_HPP
17 #include "src/mc/AddressSpace.hpp"
18 #include "src/mc/ChunkedData.hpp"
19 #include "src/mc/PageStore.hpp"
20 #include "src/mc/remote/RemotePtr.hpp"
25 enum class RegionType {
31 enum class StorageType {
44 void* data_ = nullptr;
46 Type type_ = Type::Malloc;
48 Buffer(std::size_t size, Type type = Type::Malloc);
49 Buffer(void* data, std::size_t size, Type type = Type::Malloc) :
50 data_(data), size_(size), type_(type) {}
53 void clear() noexcept;
54 ~Buffer() noexcept { clear(); }
56 static Buffer malloc(std::size_t size)
58 return Buffer(size, Type::Malloc);
60 static Buffer mmap(std::size_t size)
62 return Buffer(size, Type::Mmap);
66 Buffer(Buffer const& buffer) = delete;
67 Buffer& operator=(Buffer const& buffer) = delete;
70 Buffer(Buffer&& that) noexcept
71 : data_(that.data_), size_(that.size_), type_(that.type_)
75 that.type_ = Type::Malloc;
77 Buffer& operator=(Buffer&& that) noexcept
85 that.type_ = Type::Malloc;
89 void* get() { return data_; }
90 const void* get() const { return data_; }
91 std::size_t size() const { return size_; }
94 /** A copy/snapshot of a given memory region
96 * Different types of region snapshot storage types exist:
98 * * flat/dense snapshots are a simple copy of the region;
100 * * sparse/per-page snapshots are snaapshots which shared
103 * * privatized (SMPI global variable privatization).
105 * This is handled with a variant based approach:
107 * * `storage_type` identified the type of storage;
109 * * an anonymous enum is used to distinguish the relevant types for
112 class RegionSnapshot {
114 static const RegionType UnknownRegion = RegionType::Unknown;
115 static const RegionType HeapRegion = RegionType::Heap;
116 static const RegionType DataRegion = RegionType::Data;
118 RegionType region_type_;
119 StorageType storage_type_;
120 simgrid::mc::ObjectInformation* object_info_;
122 /** @brief Virtual address of the region in the simulated process */
125 /** @brief Size of the data region in bytes */
128 /** @brief Permanent virtual address of the region
130 * This is usually the same address as the simuilated process address.
131 * However, when using SMPI privatization of global variables,
132 * each SMPI process has its own set of global variables stored
133 * at a different virtual address. The scheduler maps those region
134 * on the region of the global variables.
137 void *permanent_addr_;
140 ChunkedData page_numbers_;
141 std::vector<RegionSnapshot> privatized_regions_;
144 region_type_(UnknownRegion),
145 storage_type_(StorageType::NoData),
146 object_info_(nullptr),
147 start_addr_(nullptr),
149 permanent_addr_(nullptr)
151 RegionSnapshot(RegionType type, void *start_addr, void* permanent_addr, size_t size) :
153 storage_type_(StorageType::NoData),
154 object_info_(nullptr),
155 start_addr_(start_addr),
157 permanent_addr_(permanent_addr)
159 ~RegionSnapshot() = default;
160 RegionSnapshot(RegionSnapshot const&) = default;
161 RegionSnapshot& operator=(RegionSnapshot const&) = default;
162 RegionSnapshot(RegionSnapshot&& that)
163 : region_type_(that.region_type_)
164 , storage_type_(that.storage_type_)
165 , object_info_(that.object_info_)
166 , start_addr_(that.start_addr_)
168 , permanent_addr_(that.permanent_addr_)
169 , flat_data_(std::move(that.flat_data_))
170 , page_numbers_(std::move(that.page_numbers_))
171 , privatized_regions_(std::move(that.privatized_regions_))
175 RegionSnapshot& operator=(RegionSnapshot&& that)
177 region_type_ = that.region_type_;
178 storage_type_ = that.storage_type_;
179 object_info_ = that.object_info_;
180 start_addr_ = that.start_addr_;
182 permanent_addr_ = that.permanent_addr_;
183 flat_data_ = std::move(that.flat_data_);
184 page_numbers_ = std::move(that.page_numbers_);
185 privatized_regions_ = std::move(that.privatized_regions_);
194 region_type_ = UnknownRegion;
195 storage_type_ = StorageType::NoData;
196 privatized_regions_.clear();
197 page_numbers_.clear();
199 object_info_ = nullptr;
200 start_addr_ = nullptr;
202 permanent_addr_ = nullptr;
207 storage_type_ = StorageType::NoData;
209 page_numbers_.clear();
210 privatized_regions_.clear();
213 void flat_data(Buffer data)
215 storage_type_ = StorageType::Flat;
216 flat_data_ = std::move(data);
217 page_numbers_.clear();
218 privatized_regions_.clear();
220 const Buffer& flat_data() const { return flat_data_; }
221 Buffer& flat_data() { return flat_data_; }
223 void page_data(ChunkedData page_data)
225 storage_type_ = StorageType::Chunked;
227 page_numbers_ = std::move(page_data);
228 privatized_regions_.clear();
230 ChunkedData const& page_data() const { return page_numbers_; }
232 void privatized_data(std::vector<RegionSnapshot> data)
234 storage_type_ = StorageType::Privatized;
236 page_numbers_.clear();
237 privatized_regions_ = std::move(data);
239 std::vector<RegionSnapshot> const& privatized_data() const
241 return privatized_regions_;
243 std::vector<RegionSnapshot>& privatized_data()
245 return privatized_regions_;
248 simgrid::mc::ObjectInformation* object_info() const { return object_info_; }
249 void object_info(simgrid::mc::ObjectInformation* info) { object_info_ = info; }
253 RemotePtr<void> start() const { return remote(start_addr_); }
254 RemotePtr<void> end() const { return remote((char*)start_addr_ + size_); }
255 RemotePtr<void> permanent_address() const { return remote(permanent_addr_); }
256 std::size_t size() const { return size_; }
257 StorageType storage_type() const { return storage_type_; }
258 RegionType region_type() const { return region_type_; }
260 bool contain(RemotePtr<void> p) const
262 return p >= start() && p < end();
266 RegionSnapshot privatized_region(
267 RegionType region_type, void *start_addr, void* permanent_addr,
269 RegionSnapshot dense_region(
270 RegionType type, void *start_addr, void* data_addr, std::size_t size);
271 simgrid::mc::RegionSnapshot sparse_region(
272 RegionType type, void *start_addr, void* data_addr, std::size_t size);
273 simgrid::mc::RegionSnapshot region(
274 RegionType type, void *start_addr, void* data_addr, std::size_t size);
279 typedef simgrid::mc::RegionSnapshot s_mc_mem_region_t;
280 typedef s_mc_mem_region_t* mc_mem_region_t;