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 auto split = simgrid::mc::mmu::split(addr - region->start().address());
42 auto pageno = split.first;
43 auto offset = split.second;
44 const void* snapshot_page = region->page_data().page(pageno);
45 return (char*) snapshot_page + offset;
48 static inline __attribute__((always_inline))
49 void* mc_translate_address_region(uintptr_t addr, mc_mem_region_t region, int process_index)
51 switch (region->storage_type()) {
52 case simgrid::mc::StorageType::NoData:
54 xbt_die("Storage type not supported");
56 case simgrid::mc::StorageType::Flat:
58 uintptr_t offset = (uintptr_t) addr - (uintptr_t) region->start().address();
59 return (void *) ((uintptr_t) region->flat_data().get() + offset);
62 case simgrid::mc::StorageType::Chunked:
63 return mc_translate_address_region_chunked(addr, region);
65 case simgrid::mc::StorageType::Privatized:
67 xbt_assert(process_index >=0,
68 "Missing process index for privatized region");
69 xbt_assert((size_t) process_index < region->privatized_data().size(),
70 "Out of range process index");
71 simgrid::mc::RegionSnapshot& subregion= region->privatized_data()[process_index];
72 return mc_translate_address_region(addr, &subregion, process_index);
77 XBT_PRIVATE mc_mem_region_t mc_get_snapshot_region(
78 const void* addr, const simgrid::mc::Snapshot *snapshot, int process_index);
86 * Some parts of the snapshot are ignored by zeroing them out: the real
87 * values is stored here.
89 typedef struct s_mc_snapshot_ignored_data {
91 std::vector<char> data;
92 } s_mc_snapshot_ignored_data_t, *mc_snapshot_ignored_data_t;
94 typedef struct s_fd_infos{
97 off_t current_position;
99 }s_fd_infos_t, *fd_infos_t;
101 /** Information about a given stack frame
104 typedef struct s_mc_stack_frame {
105 /** Instruction pointer */
109 unw_word_t frame_base;
110 simgrid::mc::Frame* frame;
111 std::string frame_name;
112 unw_cursor_t unw_cursor;
113 } s_mc_stack_frame_t, *mc_stack_frame_t;
115 typedef struct s_local_variable{
116 simgrid::mc::Frame* subprogram;
119 simgrid::mc::Type* type;
122 } s_local_variable_t, *local_variable_t;
124 typedef struct XBT_PRIVATE s_mc_snapshot_stack {
125 std::vector<s_local_variable> local_variables;
126 simgrid::mc::UnwindContext context;
127 std::vector<s_mc_stack_frame_t> stack_frames;
129 } s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
134 class XBT_PRIVATE Snapshot final : public AddressSpace {
136 Snapshot(Process* process);
138 const void* read_bytes(void* buffer, std::size_t size,
139 RemotePtr<void> address, int process_index = ProcessIndexAny,
140 ReadOptions options = ReadOptions::none()) const override;
141 public: // To be private
143 std::size_t heap_bytes_used;
144 std::vector<std::unique_ptr<s_mc_mem_region_t>> snapshot_regions;
145 std::set<pid_t> enabled_processes;
146 int privatization_index;
147 std::vector<std::size_t> stack_sizes;
148 std::vector<s_mc_snapshot_stack_t> stacks;
149 std::vector<simgrid::mc::IgnoredHeapRegion> to_ignore;
151 std::vector<s_mc_snapshot_ignored_data> ignored_data;
152 std::vector<s_fd_infos_t> current_fds;
160 static inline __attribute__ ((always_inline))
161 mc_mem_region_t mc_get_region_hinted(void* addr, simgrid::mc::Snapshot* snapshot, int process_index, mc_mem_region_t region)
163 if (region->contain(simgrid::mc::remote(addr)))
166 return mc_get_snapshot_region(addr, snapshot, process_index);
169 static const void* mc_snapshot_get_heap_end(simgrid::mc::Snapshot* snapshot);
178 XBT_PRIVATE std::shared_ptr<simgrid::mc::Snapshot> take_snapshot(int num_state);
179 XBT_PRIVATE void restore_snapshot(std::shared_ptr<simgrid::mc::Snapshot> snapshot);
188 XBT_PRIVATE void mc_restore_page_snapshot_region(
189 simgrid::mc::Process* process,
190 void* start_addr, simgrid::mc::ChunkedData const& pagenos);
192 const void* MC_region_read_fragmented(
193 mc_mem_region_t region, void* target, const void* addr, std::size_t size);
195 int MC_snapshot_region_memcmp(
196 const void* addr1, mc_mem_region_t region1,
197 const void* addr2, mc_mem_region_t region2, std::size_t size);
198 XBT_PRIVATE int MC_snapshot_memcmp(
199 const void* addr1, simgrid::mc::Snapshot* snapshot1,
200 const void* addr2, simgrid::mc::Snapshot* snapshot2, int process_index, std::size_t size);
202 static inline __attribute__ ((always_inline))
203 const void* mc_snapshot_get_heap_end(simgrid::mc::Snapshot* snapshot)
205 if(snapshot==nullptr)
206 xbt_die("snapshot is nullptr");
207 return mc_model_checker->process().get_heap()->breakval;
210 /** @brief Read memory from a snapshot region
212 * @param addr Process (non-snapshot) address of the data
213 * @param region Snapshot memory region where the data is located
214 * @param target Buffer to store the value
215 * @param size Size of the data to read in bytes
216 * @return Pointer where the data is located (target buffer of original location)
218 static inline __attribute__((always_inline))
219 const void* MC_region_read(
220 mc_mem_region_t region, void* target, const void* addr, std::size_t size)
224 std::uintptr_t offset =
225 (std::uintptr_t) addr - (std::uintptr_t) region->start().address();
227 xbt_assert(region->contain(simgrid::mc::remote(addr)),
228 "Trying to read out of the region boundary.");
230 switch (region->storage_type()) {
231 case simgrid::mc::StorageType::NoData:
233 xbt_die("Storage type not supported");
235 case simgrid::mc::StorageType::Flat:
236 return (char*) region->flat_data().get() + offset;
238 case simgrid::mc::StorageType::Chunked:
240 // Last byte of the region:
241 void* end = (char*) addr + size - 1;
242 if (simgrid::mc::mmu::sameChunk((std::uintptr_t) addr, (std::uintptr_t) end) ) {
243 // The memory is contained in a single page:
244 return mc_translate_address_region_chunked((uintptr_t) addr, region);
246 // The memory spans several pages:
247 return MC_region_read_fragmented(region, target, addr, size);
251 // We currently do not pass the process_index to this function so we assume
252 // that the privatized region has been resolved in the callers:
253 case simgrid::mc::StorageType::Privatized:
254 xbt_die("Storage type not supported");
258 static inline __attribute__ ((always_inline))
259 void* MC_region_read_pointer(mc_mem_region_t region, const void* addr)
262 return *(void**) MC_region_read(region, &res, addr, sizeof(void*));