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_SNAPSHOT_H
8 #define SIMGRID_MC_SNAPSHOT_H
18 #include <sys/types.h> // off_t
20 #include <simgrid_config.h>
21 #include "src/xbt/mmalloc/mmprivate.h"
22 #include <xbt/asserts.h>
25 #include "src/mc/mc_forward.hpp"
26 #include "src/mc/ModelChecker.hpp"
27 #include "src/mc/PageStore.hpp"
28 #include "src/mc/AddressSpace.hpp"
29 #include "src/mc/mc_unw.h"
30 #include "src/mc/RegionSnapshot.hpp"
34 // ***** Snapshot region
36 XBT_PRIVATE void mc_region_restore_sparse(simgrid::mc::Process* process, mc_mem_region_t reg);
38 static inline __attribute__((always_inline))
39 void* mc_translate_address_region_chunked(uintptr_t addr, mc_mem_region_t region)
41 size_t pageno = mc_page_number((void*)region->start().address(), (void*) addr);
42 const void* snapshot_page =
43 region->page_data().page(pageno);
44 return (char*) snapshot_page + mc_page_offset((void*) addr);
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 s_mc_unw_context_t context;
126 std::vector<s_mc_stack_frame_t> stack_frames;
128 } s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
130 typedef struct s_mc_global_t {
131 mc_snapshot_t snapshot;
134 int initial_communications_pattern_done;
135 int recv_deterministic;
136 int send_deterministic;
139 }s_mc_global_t, *mc_global_t;
144 class XBT_PRIVATE Snapshot final : public AddressSpace {
146 Snapshot(Process* process);
148 const void* read_bytes(void* buffer, std::size_t size,
149 RemotePtr<void> address, int process_index = ProcessIndexAny,
150 ReadOptions options = ReadOptions::none()) const override;
151 public: // To be private
153 std::size_t heap_bytes_used;
154 std::vector<std::unique_ptr<s_mc_mem_region_t>> snapshot_regions;
155 std::set<pid_t> enabled_processes;
156 int privatization_index;
157 std::vector<std::size_t> stack_sizes;
158 std::vector<s_mc_snapshot_stack_t> stacks;
159 std::vector<simgrid::mc::IgnoredHeapRegion> to_ignore;
161 std::vector<s_mc_snapshot_ignored_data> ignored_data;
162 std::vector<s_fd_infos_t> current_fds;
170 static inline __attribute__ ((always_inline))
171 mc_mem_region_t mc_get_region_hinted(void* addr, mc_snapshot_t snapshot, int process_index, mc_mem_region_t region)
173 if (region->contain(simgrid::mc::remote(addr)))
176 return mc_get_snapshot_region(addr, snapshot, process_index);
179 static const void* mc_snapshot_get_heap_end(mc_snapshot_t snapshot);
188 XBT_PRIVATE mc_snapshot_t take_snapshot(int num_state);
189 XBT_PRIVATE void restore_snapshot(mc_snapshot_t);
198 XBT_PRIVATE void mc_restore_page_snapshot_region(
199 simgrid::mc::Process* process,
200 void* start_addr, simgrid::mc::ChunkedData const& pagenos);
202 const void* MC_region_read_fragmented(
203 mc_mem_region_t region, void* target, const void* addr, std::size_t size);
205 int MC_snapshot_region_memcmp(
206 const void* addr1, mc_mem_region_t region1,
207 const void* addr2, mc_mem_region_t region2, std::size_t size);
208 XBT_PRIVATE int MC_snapshot_memcmp(
209 const void* addr1, mc_snapshot_t snapshot1,
210 const void* addr2, mc_snapshot_t snapshot2, int process_index, std::size_t size);
212 static inline __attribute__ ((always_inline))
213 const void* mc_snapshot_get_heap_end(mc_snapshot_t snapshot)
216 xbt_die("snapshot is NULL");
217 return mc_model_checker->process().get_heap()->breakval;
220 /** @brief Read memory from a snapshot region
222 * @param addr Process (non-snapshot) address of the data
223 * @param region Snapshot memory region where the data is located
224 * @param target Buffer to store the value
225 * @param size Size of the data to read in bytes
226 * @return Pointer where the data is located (target buffer of original location)
228 static inline __attribute__((always_inline))
229 const void* MC_region_read(
230 mc_mem_region_t region, void* target, const void* addr, std::size_t size)
234 std::uintptr_t offset =
235 (std::uintptr_t) addr - (std::uintptr_t) region->start().address();
237 xbt_assert(region->contain(simgrid::mc::remote(addr)),
238 "Trying to read out of the region boundary.");
240 switch (region->storage_type()) {
241 case simgrid::mc::StorageType::NoData:
243 xbt_die("Storage type not supported");
245 case simgrid::mc::StorageType::Flat:
246 return (char*) region->flat_data().get() + offset;
248 case simgrid::mc::StorageType::Chunked:
250 // Last byte of the region:
251 void* end = (char*) addr + size - 1;
252 if (mc_same_page(addr, end) ) {
253 // The memory is contained in a single page:
254 return mc_translate_address_region_chunked((uintptr_t) addr, region);
256 // The memory spans several pages:
257 return MC_region_read_fragmented(region, target, addr, size);
261 // We currently do not pass the process_index to this function so we assume
262 // that the privatized region has been resolved in the callers:
263 case simgrid::mc::StorageType::Privatized:
264 xbt_die("Storage type not supported");
268 static inline __attribute__ ((always_inline))
269 void* MC_region_read_pointer(mc_mem_region_t region, const void* addr)
272 return *(void**) MC_region_read(region, &res, addr, sizeof(void*));
277 XBT_PRIVATE int init_heap_information(xbt_mheap_t heap1, xbt_mheap_t heap2,
278 std::vector<simgrid::mc::IgnoredHeapRegion>* i1,
279 std::vector<simgrid::mc::IgnoredHeapRegion>* i2);