1 /* Copyright (c) 2007-2019. 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
9 #include "src/mc/ModelChecker.hpp"
10 #include "src/mc/inspect/mc_unw.hpp"
11 #include "src/mc/remote/RemoteClient.hpp"
12 #include "src/mc/sosp/RegionSnapshot.hpp"
14 // ***** Snapshot region
16 static XBT_ALWAYS_INLINE void* mc_translate_address_region_chunked(uintptr_t addr, simgrid::mc::RegionSnapshot* region)
18 auto split = simgrid::mc::mmu::split(addr - region->start().address());
19 auto pageno = split.first;
20 auto offset = split.second;
21 const void* snapshot_page = region->page_data().page(pageno);
22 return (char*)snapshot_page + offset;
25 static XBT_ALWAYS_INLINE void* mc_translate_address_region(uintptr_t addr, simgrid::mc::RegionSnapshot* region,
28 switch (region->storage_type()) {
29 case simgrid::mc::StorageType::Flat: {
30 uintptr_t offset = (uintptr_t)addr - (uintptr_t)region->start().address();
31 return (void*)((uintptr_t)region->flat_data().get() + offset);
33 case simgrid::mc::StorageType::Chunked:
34 return mc_translate_address_region_chunked(addr, region);
35 case simgrid::mc::StorageType::Privatized: {
36 xbt_assert(process_index >= 0, "Missing process index for privatized region");
37 xbt_assert((size_t)process_index < region->privatized_data().size(), "Out of range process index");
38 simgrid::mc::RegionSnapshot* subregion = region->privatized_data()[process_index].get();
39 return mc_translate_address_region(addr, subregion, process_index);
41 default: // includes StorageType::NoData
42 xbt_die("Storage type not supported");
50 * Some parts of the snapshot are ignored by zeroing them out: the real
51 * values is stored here.
53 struct s_mc_snapshot_ignored_data_t {
55 std::vector<char> data;
58 /** Information about a given stack frame */
59 struct s_mc_stack_frame_t {
60 /** Instruction pointer */
64 unw_word_t frame_base;
65 simgrid::mc::Frame* frame;
66 std::string frame_name;
67 unw_cursor_t unw_cursor;
69 typedef s_mc_stack_frame_t* mc_stack_frame_t;
71 struct s_local_variable_t {
72 simgrid::mc::Frame* subprogram;
75 simgrid::mc::Type* type;
78 typedef s_local_variable_t* local_variable_t;
80 struct XBT_PRIVATE s_mc_snapshot_stack_t {
81 std::vector<s_local_variable_t> local_variables;
82 simgrid::mc::UnwindContext context;
83 std::vector<s_mc_stack_frame_t> stack_frames;
86 typedef s_mc_snapshot_stack_t* mc_snapshot_stack_t;
91 class XBT_PRIVATE Snapshot final : public AddressSpace {
93 Snapshot(int num_state, RemoteClient* process = &mc_model_checker->process());
94 ~Snapshot() = default;
97 void add_region(RegionType type, ObjectInformation* object_info, void* start_addr, void* permanent_addr,
101 const void* read_bytes(void* buffer, std::size_t size, RemotePtr<void> address, int process_index = ProcessIndexAny,
102 ReadOptions options = ReadOptions::none()) const override;
103 RegionSnapshot* get_region(const void* addr, int process_index) const;
104 RegionSnapshot* get_region(const void* addr, int process_index, RegionSnapshot* hinted_region) const;
108 std::size_t heap_bytes_used_;
109 std::vector<std::unique_ptr<RegionSnapshot>> snapshot_regions_;
110 std::set<pid_t> enabled_processes_;
111 int privatization_index_;
112 std::vector<std::size_t> stack_sizes_;
113 std::vector<s_mc_snapshot_stack_t> stacks_;
114 std::vector<simgrid::mc::IgnoredHeapRegion> to_ignore_;
115 std::uint64_t hash_ = 0;
116 std::vector<s_mc_snapshot_ignored_data_t> ignored_data_;
119 } // namespace simgrid
121 static const void* mc_snapshot_get_heap_end(simgrid::mc::Snapshot* snapshot);
126 XBT_PRIVATE std::shared_ptr<Snapshot> take_snapshot(int num_state);
127 XBT_PRIVATE void restore_snapshot(std::shared_ptr<Snapshot> snapshot);
129 } // namespace simgrid
131 const void* MC_region_read_fragmented(simgrid::mc::RegionSnapshot* region, void* target, const void* addr,
134 int MC_snapshot_region_memcmp(const void* addr1, simgrid::mc::RegionSnapshot* region1, const void* addr2,
135 simgrid::mc::RegionSnapshot* region2, std::size_t size);
137 static XBT_ALWAYS_INLINE const void* mc_snapshot_get_heap_end(simgrid::mc::Snapshot* snapshot)
139 if (snapshot == nullptr)
140 xbt_die("snapshot is nullptr");
141 return mc_model_checker->process().get_heap()->breakval;
144 /** @brief Read memory from a snapshot region
146 * @param addr Process (non-snapshot) address of the data
147 * @param region Snapshot memory region where the data is located
148 * @param target Buffer to store the value
149 * @param size Size of the data to read in bytes
150 * @return Pointer where the data is located (target buffer of original location)
152 static XBT_ALWAYS_INLINE const void* MC_region_read(simgrid::mc::RegionSnapshot* region, void* target, const void* addr,
157 std::uintptr_t offset = (std::uintptr_t)addr - (std::uintptr_t)region->start().address();
159 xbt_assert(region->contain(simgrid::mc::remote(addr)), "Trying to read out of the region boundary.");
161 switch (region->storage_type()) {
162 case simgrid::mc::StorageType::Flat:
163 return (char*)region->flat_data().get() + offset;
165 case simgrid::mc::StorageType::Chunked: {
166 // Last byte of the region:
167 void* end = (char*)addr + size - 1;
168 if (simgrid::mc::mmu::same_chunk((std::uintptr_t)addr, (std::uintptr_t)end)) {
169 // The memory is contained in a single page:
170 return mc_translate_address_region_chunked((uintptr_t)addr, region);
172 // Otherwise, the memory spans several pages:
173 return MC_region_read_fragmented(region, target, addr, size);
177 // includes StorageType::NoData and StorageType::Privatized (we currently do not pass the process_index to this
178 // function so we assume that the privatized region has been resolved in the callers)
179 xbt_die("Storage type not supported");
183 static XBT_ALWAYS_INLINE void* MC_region_read_pointer(simgrid::mc::RegionSnapshot* region, const void* addr)
186 return *(void**)MC_region_read(region, &res, addr, sizeof(void*));