1 /* Copyright (c) 2014-2022. 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 #include "src/include/catch.hpp"
7 #include "src/mc/mc_config.hpp"
8 #include "src/mc/sosp/Snapshot.hpp"
13 #include <xbt/random.hpp>
15 /**************** Class BOOST_tests *************************/
16 using simgrid::mc::Region;
17 class snap_test_helper {
19 static void init_memory(void* mem, size_t size);
21 struct prologue_return {
28 static prologue_return prologue(int n); // common to the below 5 fxs
29 static void read_whole_region();
30 static void read_region_parts();
31 static void compare_whole_region();
32 static void compare_region_parts();
33 static void read_pointer();
37 delete mc_model_checker;
38 mc_model_checker = nullptr;
41 static std::unique_ptr<simgrid::mc::RemoteProcess> process;
44 // static member variables init.
45 std::unique_ptr<simgrid::mc::RemoteProcess> snap_test_helper::process = nullptr;
47 void snap_test_helper::init_memory(void* mem, size_t size)
49 auto* dest = static_cast<char*>(mem);
50 for (size_t i = 0; i < size; ++i) {
51 dest[i] = simgrid::xbt::random::uniform_int(0, 0xff);
55 void snap_test_helper::Init()
57 REQUIRE(xbt_pagesize == getpagesize());
58 REQUIRE(1 << xbt_pagebits == xbt_pagesize);
60 process = std::make_unique<simgrid::mc::RemoteProcess>(getpid());
61 process->init(nullptr, nullptr, nullptr, nullptr);
62 mc_model_checker = new ::simgrid::mc::ModelChecker(std::move(process), -1);
65 snap_test_helper::prologue_return snap_test_helper::prologue(int n)
67 // Store region page(s):
68 size_t byte_size = n * xbt_pagesize;
69 void* source = mmap(nullptr, byte_size, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
70 INFO("Could not allocate source memory");
71 REQUIRE(source != MAP_FAILED);
73 // Init memory and take snapshots:
74 init_memory(source, byte_size);
75 auto* region0 = new simgrid::mc::Region(simgrid::mc::RegionType::Data, source, byte_size);
76 for (int i = 0; i < n; i += 2) {
77 init_memory((char*)source + i * xbt_pagesize, xbt_pagesize);
79 auto* region = new simgrid::mc::Region(simgrid::mc::RegionType::Data, source, byte_size);
81 void* destination = mmap(nullptr, byte_size, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
82 INFO("Could not allocate destination memory");
83 REQUIRE(destination != MAP_FAILED);
85 return {.size = byte_size, .src = source, .dstn = destination, .region0 = region0, .region = region};
88 void snap_test_helper::read_whole_region()
90 for (int n = 1; n != 32; ++n) {
91 prologue_return ret = prologue(n);
92 const void* read = ret.region->read(ret.dstn, ret.src, ret.size);
93 INFO("Mismatch in MC_region_read()");
94 REQUIRE(not memcmp(ret.src, read, ret.size));
96 munmap(ret.dstn, ret.size);
97 munmap(ret.src, ret.size);
103 void snap_test_helper::read_region_parts()
105 for (int n = 1; n != 32; ++n) {
106 prologue_return ret = prologue(n);
108 for (int j = 0; j != 100; ++j) {
109 size_t offset = simgrid::xbt::random::uniform_int(0, ret.size - 1);
110 size_t size = simgrid::xbt::random::uniform_int(0, ret.size - offset - 1);
111 const void* read = ret.region->read(ret.dstn, (const char*)ret.src + offset, size);
112 INFO("Mismatch in MC_region_read()");
113 REQUIRE(not memcmp((char*)ret.src + offset, read, size));
115 munmap(ret.dstn, ret.size);
116 munmap(ret.src, ret.size);
122 void snap_test_helper::compare_whole_region()
124 for (int n = 1; n != 32; ++n) {
125 prologue_return ret = prologue(n);
127 INFO("Unexpected match in MC_snapshot_region_memcmp() with previous snapshot");
128 REQUIRE(MC_snapshot_region_memcmp(ret.src, ret.region0, ret.src, ret.region, ret.size));
130 munmap(ret.dstn, ret.size);
131 munmap(ret.src, ret.size);
137 void snap_test_helper::compare_region_parts()
139 for (int n = 1; n != 32; ++n) {
140 prologue_return ret = prologue(n);
142 for (int j = 0; j != 100; ++j) {
143 size_t offset = simgrid::xbt::random::uniform_int(0, ret.size - 1);
144 size_t size = simgrid::xbt::random::uniform_int(0, ret.size - offset - 1);
146 INFO("Mismatch in MC_snapshot_region_memcmp()");
147 REQUIRE(not MC_snapshot_region_memcmp((char*)ret.src + offset, ret.region, (char*)ret.src + offset, ret.region,
150 munmap(ret.dstn, ret.size);
151 munmap(ret.src, ret.size);
157 void snap_test_helper::read_pointer()
159 prologue_return ret = prologue(1);
160 memcpy(ret.src, &mc_model_checker, sizeof(void*));
161 const simgrid::mc::Region region2(simgrid::mc::RegionType::Data, ret.src, ret.size);
162 INFO("Mismtach in MC_region_read_pointer()");
163 REQUIRE(MC_region_read_pointer(®ion2, ret.src) == mc_model_checker);
165 munmap(ret.dstn, ret.size);
166 munmap(ret.src, ret.size);
171 /*************** End: class snap_test_helper *****************************/
173 TEST_CASE("MC::Snapshot: A copy/snapshot of a given memory region", "MC::Snapshot")
175 INFO("Sparse snapshot (using pages)");
177 snap_test_helper::Init();
179 INFO("Read whole region");
180 snap_test_helper::read_whole_region();
182 INFO("Read region parts");
183 snap_test_helper::read_region_parts();
185 INFO("Compare whole region");
186 snap_test_helper::compare_whole_region();
188 INFO("Compare region parts");
189 snap_test_helper::compare_region_parts();
191 INFO("Read pointer");
192 snap_test_helper::read_pointer();
194 snap_test_helper::cleanup();