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_SNAPSHOT_H
7 #define SIMGRID_MC_SNAPSHOT_H
17 #include <sys/types.h> // off_t
19 #include <simgrid_config.h>
20 #include "src/xbt/mmalloc/mmprivate.h"
21 #include <xbt/asserts.h>
24 #include "src/mc/mc_forward.hpp"
25 #include "src/mc/ModelChecker.hpp"
26 #include "src/mc/PageStore.hpp"
27 #include "src/mc/AddressSpace.hpp"
28 #include "src/mc/mc_unw.h"
29 #include "src/mc/RegionSnapshot.hpp"
33 // ***** Snapshot region
35 XBT_PRIVATE void mc_region_restore_sparse(simgrid::mc::Process* process, mc_mem_region_t reg);
37 static inline __attribute__((always_inline))
38 void* mc_translate_address_region_chunked(uintptr_t addr, mc_mem_region_t region)
40 auto split = simgrid::mc::mmu::split(addr - region->start().address());
41 auto pageno = split.first;
42 auto offset = split.second;
43 const void* snapshot_page = region->page_data().page(pageno);
44 return (char*) snapshot_page + offset;
47 static inline __attribute__((always_inline))
48 void* mc_translate_address_region(uintptr_t addr, mc_mem_region_t region, int process_index)
50 switch (region->storage_type()) {
51 case simgrid::mc::StorageType::NoData:
53 xbt_die("Storage type not supported");
55 case simgrid::mc::StorageType::Flat:
57 uintptr_t offset = (uintptr_t) addr - (uintptr_t) region->start().address();
58 return (void *) ((uintptr_t) region->flat_data().get() + offset);
61 case simgrid::mc::StorageType::Chunked:
62 return mc_translate_address_region_chunked(addr, region);
64 case simgrid::mc::StorageType::Privatized:
66 xbt_assert(process_index >=0,
67 "Missing process index for privatized region");
68 xbt_assert((size_t) process_index < region->privatized_data().size(),
69 "Out of range process index");
70 simgrid::mc::RegionSnapshot& subregion= region->privatized_data()[process_index];
71 return mc_translate_address_region(addr, &subregion, process_index);
76 XBT_PRIVATE mc_mem_region_t mc_get_snapshot_region(
77 const void* addr, const simgrid::mc::Snapshot *snapshot, int process_index);
85 * Some parts of the snapshot are ignored by zeroing them out: the real
86 * values is stored here.
88 typedef struct s_mc_snapshot_ignored_data {
90 std::vector<char> data;
91 } s_mc_snapshot_ignored_data_t, *mc_snapshot_ignored_data_t;
93 typedef struct s_fd_infos{
96 off_t current_position;
98 }s_fd_infos_t, *fd_infos_t;
100 /** Information about a given stack frame
103 typedef struct s_mc_stack_frame {
104 /** Instruction pointer */
108 unw_word_t frame_base;
109 simgrid::mc::Frame* frame;
110 std::string frame_name;
111 unw_cursor_t unw_cursor;
112 } s_mc_stack_frame_t, *mc_stack_frame_t;
114 typedef struct s_local_variable{
115 simgrid::mc::Frame* subprogram;
118 simgrid::mc::Type* type;
121 } s_local_variable_t, *local_variable_t;
123 typedef struct XBT_PRIVATE s_mc_snapshot_stack {
124 std::vector<s_local_variable> local_variables;
125 simgrid::mc::UnwindContext context;
126 std::vector<s_mc_stack_frame_t> stack_frames;
128 } s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
133 class XBT_PRIVATE Snapshot final : public AddressSpace {
135 Snapshot(Process* process, int num_state);
137 const void* read_bytes(void* buffer, std::size_t size,
138 RemotePtr<void> address, int process_index = ProcessIndexAny,
139 ReadOptions options = ReadOptions::none()) const override;
140 public: // To be private
142 std::size_t heap_bytes_used;
143 std::vector<std::unique_ptr<s_mc_mem_region_t>> snapshot_regions;
144 std::set<pid_t> enabled_processes;
145 int privatization_index;
146 std::vector<std::size_t> stack_sizes;
147 std::vector<s_mc_snapshot_stack_t> stacks;
148 std::vector<simgrid::mc::IgnoredHeapRegion> to_ignore;
150 std::vector<s_mc_snapshot_ignored_data> ignored_data;
151 std::vector<s_fd_infos_t> current_fds;
159 static inline __attribute__ ((always_inline))
160 mc_mem_region_t mc_get_region_hinted(void* addr, simgrid::mc::Snapshot* snapshot, int process_index, mc_mem_region_t region)
162 if (region->contain(simgrid::mc::remote(addr)))
165 return mc_get_snapshot_region(addr, snapshot, process_index);
168 static const void* mc_snapshot_get_heap_end(simgrid::mc::Snapshot* snapshot);
177 XBT_PRIVATE std::shared_ptr<simgrid::mc::Snapshot> take_snapshot(int num_state);
178 XBT_PRIVATE void restore_snapshot(std::shared_ptr<simgrid::mc::Snapshot> snapshot);
187 XBT_PRIVATE void mc_restore_page_snapshot_region(
188 simgrid::mc::Process* process,
189 void* start_addr, simgrid::mc::ChunkedData const& pagenos);
191 const void* MC_region_read_fragmented(
192 mc_mem_region_t region, void* target, const void* addr, std::size_t size);
194 int MC_snapshot_region_memcmp(
195 const void* addr1, mc_mem_region_t region1,
196 const void* addr2, mc_mem_region_t region2, std::size_t size);
197 XBT_PRIVATE int MC_snapshot_memcmp(
198 const void* addr1, simgrid::mc::Snapshot* snapshot1,
199 const void* addr2, simgrid::mc::Snapshot* snapshot2, int process_index, std::size_t size);
201 static inline __attribute__ ((always_inline))
202 const void* mc_snapshot_get_heap_end(simgrid::mc::Snapshot* snapshot)
204 if(snapshot==nullptr)
205 xbt_die("snapshot is nullptr");
206 return mc_model_checker->process().get_heap()->breakval;
209 /** @brief Read memory from a snapshot region
211 * @param addr Process (non-snapshot) address of the data
212 * @param region Snapshot memory region where the data is located
213 * @param target Buffer to store the value
214 * @param size Size of the data to read in bytes
215 * @return Pointer where the data is located (target buffer of original location)
217 static inline __attribute__((always_inline))
218 const void* MC_region_read(
219 mc_mem_region_t region, void* target, const void* addr, std::size_t size)
223 std::uintptr_t offset =
224 (std::uintptr_t) addr - (std::uintptr_t) region->start().address();
226 xbt_assert(region->contain(simgrid::mc::remote(addr)),
227 "Trying to read out of the region boundary.");
229 switch (region->storage_type()) {
230 case simgrid::mc::StorageType::NoData:
232 xbt_die("Storage type not supported");
234 case simgrid::mc::StorageType::Flat:
235 return (char*) region->flat_data().get() + offset;
237 case simgrid::mc::StorageType::Chunked:
239 // Last byte of the region:
240 void* end = (char*) addr + size - 1;
241 if (simgrid::mc::mmu::sameChunk((std::uintptr_t) addr, (std::uintptr_t) end) ) {
242 // The memory is contained in a single page:
243 return mc_translate_address_region_chunked((uintptr_t) addr, region);
245 // The memory spans several pages:
246 return MC_region_read_fragmented(region, target, addr, size);
250 // We currently do not pass the process_index to this function so we assume
251 // that the privatized region has been resolved in the callers:
252 case simgrid::mc::StorageType::Privatized:
253 xbt_die("Storage type not supported");
257 static inline __attribute__ ((always_inline))
258 void* MC_region_read_pointer(mc_mem_region_t region, const void* addr)
261 return *(void**) MC_region_read(region, &res, addr, sizeof(void*));