1 /* Copyright (c) 2007-2018. 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_SNAPSHOT_HPP
7 #define SIMGRID_MC_SNAPSHOT_HPP
14 #include "src/mc/ModelChecker.hpp"
15 #include "src/mc/RegionSnapshot.hpp"
16 #include "src/mc/mc_forward.hpp"
17 #include "src/mc/mc_unw.hpp"
19 // ***** Snapshot region
21 XBT_PRIVATE void mc_region_restore_sparse(simgrid::mc::RemoteClient* process, mc_mem_region_t reg);
23 static XBT_ALWAYS_INLINE void* mc_translate_address_region_chunked(uintptr_t addr, mc_mem_region_t region)
25 auto split = simgrid::mc::mmu::split(addr - region->start().address());
26 auto pageno = split.first;
27 auto offset = split.second;
28 const void* snapshot_page = region->page_data().page(pageno);
29 return (char*)snapshot_page + offset;
32 static XBT_ALWAYS_INLINE void* mc_translate_address_region(uintptr_t addr, mc_mem_region_t region, int process_index)
34 switch (region->storage_type()) {
35 case simgrid::mc::StorageType::Flat: {
36 uintptr_t offset = (uintptr_t)addr - (uintptr_t)region->start().address();
37 return (void*)((uintptr_t)region->flat_data().get() + offset);
39 case simgrid::mc::StorageType::Chunked:
40 return mc_translate_address_region_chunked(addr, region);
41 case simgrid::mc::StorageType::Privatized: {
42 xbt_assert(process_index >= 0, "Missing process index for privatized region");
43 xbt_assert((size_t)process_index < region->privatized_data().size(), "Out of range process index");
44 simgrid::mc::RegionSnapshot& subregion = region->privatized_data()[process_index];
45 return mc_translate_address_region(addr, &subregion, process_index);
47 default: // includes StorageType::NoData
48 xbt_die("Storage type not supported");
52 XBT_PRIVATE mc_mem_region_t mc_get_snapshot_region(const void* addr, const simgrid::mc::Snapshot* snapshot,
59 * Some parts of the snapshot are ignored by zeroing them out: the real
60 * values is stored here.
62 struct s_mc_snapshot_ignored_data_t {
64 std::vector<char> data;
70 off_t current_position;
74 /** Information about a given stack frame */
75 struct s_mc_stack_frame_t {
76 /** Instruction pointer */
80 unw_word_t frame_base;
81 simgrid::mc::Frame* frame;
82 std::string frame_name;
83 unw_cursor_t unw_cursor;
85 typedef s_mc_stack_frame_t* mc_stack_frame_t;
87 struct s_local_variable_t {
88 simgrid::mc::Frame* subprogram;
91 simgrid::mc::Type* type;
95 typedef s_local_variable_t* local_variable_t;
97 struct XBT_PRIVATE s_mc_snapshot_stack_t {
98 std::vector<s_local_variable_t> local_variables;
99 simgrid::mc::UnwindContext context;
100 std::vector<s_mc_stack_frame_t> stack_frames;
103 typedef s_mc_snapshot_stack_t* mc_snapshot_stack_t;
108 class XBT_PRIVATE Snapshot final : public AddressSpace {
110 Snapshot(RemoteClient* process, int num_state);
111 ~Snapshot() = default;
112 const void* read_bytes(void* buffer, std::size_t size, RemotePtr<void> address, int process_index = ProcessIndexAny,
113 ReadOptions options = ReadOptions::none()) const override;
117 std::size_t heap_bytes_used;
118 std::vector<std::unique_ptr<s_mc_mem_region_t>> snapshot_regions;
119 std::set<pid_t> enabled_processes;
120 int privatization_index;
121 std::vector<std::size_t> stack_sizes;
122 std::vector<s_mc_snapshot_stack_t> stacks;
123 std::vector<simgrid::mc::IgnoredHeapRegion> to_ignore;
125 std::vector<s_mc_snapshot_ignored_data_t> ignored_data;
126 std::vector<s_fd_infos_t> current_fds;
131 static XBT_ALWAYS_INLINE mc_mem_region_t mc_get_region_hinted(void* addr, simgrid::mc::Snapshot* snapshot,
132 int process_index, mc_mem_region_t region)
134 if (region->contain(simgrid::mc::remote(addr)))
137 return mc_get_snapshot_region(addr, snapshot, process_index);
140 static const void* mc_snapshot_get_heap_end(simgrid::mc::Snapshot* snapshot);
145 XBT_PRIVATE std::shared_ptr<simgrid::mc::Snapshot> take_snapshot(int num_state);
146 XBT_PRIVATE void restore_snapshot(std::shared_ptr<simgrid::mc::Snapshot> snapshot);
150 XBT_PRIVATE void mc_restore_page_snapshot_region(simgrid::mc::RemoteClient* process, void* start_addr,
151 simgrid::mc::ChunkedData const& pagenos);
153 const void* MC_region_read_fragmented(mc_mem_region_t region, void* target, const void* addr, std::size_t size);
155 int MC_snapshot_region_memcmp(const void* addr1, mc_mem_region_t region1, const void* addr2, mc_mem_region_t region2,
158 static XBT_ALWAYS_INLINE const void* mc_snapshot_get_heap_end(simgrid::mc::Snapshot* snapshot)
160 if (snapshot == nullptr)
161 xbt_die("snapshot is nullptr");
162 return mc_model_checker->process().get_heap()->breakval;
165 /** @brief Read memory from a snapshot region
167 * @param addr Process (non-snapshot) address of the data
168 * @param region Snapshot memory region where the data is located
169 * @param target Buffer to store the value
170 * @param size Size of the data to read in bytes
171 * @return Pointer where the data is located (target buffer of original location)
173 static XBT_ALWAYS_INLINE const void* MC_region_read(mc_mem_region_t region, void* target, const void* addr,
178 std::uintptr_t offset = (std::uintptr_t)addr - (std::uintptr_t)region->start().address();
180 xbt_assert(region->contain(simgrid::mc::remote(addr)), "Trying to read out of the region boundary.");
182 switch (region->storage_type()) {
183 case simgrid::mc::StorageType::Flat:
184 return (char*)region->flat_data().get() + offset;
186 case simgrid::mc::StorageType::Chunked: {
187 // Last byte of the region:
188 void* end = (char*)addr + size - 1;
189 if (simgrid::mc::mmu::sameChunk((std::uintptr_t)addr, (std::uintptr_t)end)) {
190 // The memory is contained in a single page:
191 return mc_translate_address_region_chunked((uintptr_t)addr, region);
193 // Otherwise, the memory spans several pages:
194 return MC_region_read_fragmented(region, target, addr, size);
198 // includes StorageType::NoData and StorageType::Privatized (we currently do not pass the process_index to this
199 // function so we assume that the privatized region has been resolved in the callers)
200 xbt_die("Storage type not supported");
204 static XBT_ALWAYS_INLINE void* MC_region_read_pointer(mc_mem_region_t region, const void* addr)
207 return *(void**)MC_region_read(region, &res, addr, sizeof(void*));