1 /* Copyright (c) 2014-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 #include "src/include/catch.hpp"
7 #include "src/mc/mc_config.hpp"
8 #include "src/mc/sosp/Snapshot.hpp"
14 /**************** Class BOOST_tests *************************/
15 using simgrid::mc::Region;
16 class snap_test_helper {
18 static void init_memory(void* mem, size_t size);
27 static prologue_return prologue(int n); // common to the below 5 fxs
28 static void read_whole_region();
29 static void read_region_parts();
30 static void compare_whole_region();
31 static void compare_region_parts();
32 static void read_pointer();
36 delete mc_model_checker;
37 mc_model_checker = nullptr;
40 static std::default_random_engine rnd_engine;
41 static std::unique_ptr<simgrid::mc::RemoteClient> process;
44 // static member variables init.
45 std::default_random_engine snap_test_helper::rnd_engine;
46 std::unique_ptr<simgrid::mc::RemoteClient> snap_test_helper::process = nullptr;
48 void snap_test_helper::init_memory(void* mem, size_t size)
50 char* dest = (char*)mem;
51 for (size_t i = 0; i < size; ++i) {
52 dest[i] = rnd_engine() & 255;
56 void snap_test_helper::Init()
58 REQUIRE(xbt_pagesize == getpagesize());
59 REQUIRE(1 << xbt_pagebits == xbt_pagesize);
61 process.reset(new simgrid::mc::RemoteClient(getpid(), -1));
63 mc_model_checker = new ::simgrid::mc::ModelChecker(std::move(process));
66 snap_test_helper::prologue_return snap_test_helper::prologue(int n)
68 // Store region page(s):
69 size_t byte_size = n * xbt_pagesize;
70 void* source = mmap(nullptr, byte_size, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
71 INFO("Could not allocate source memory")
72 REQUIRE(source != MAP_FAILED);
74 // Init memory and take snapshots:
75 init_memory(source, byte_size);
76 simgrid::mc::Region* region0 = new simgrid::mc::Region(simgrid::mc::RegionType::Data, source, byte_size);
77 for (int i = 0; i < n; i += 2) {
78 init_memory((char*)source + i * xbt_pagesize, xbt_pagesize);
80 simgrid::mc::Region* region = new simgrid::mc::Region(simgrid::mc::RegionType::Data, source, byte_size);
82 void* destination = mmap(nullptr, byte_size, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
83 INFO("Could not allocate destination memory");
84 REQUIRE(source != MAP_FAILED);
86 return {.size = byte_size,
89 .region0 = std::move(region0),
90 .region = std::move(region)};
93 void snap_test_helper::read_whole_region()
95 for (int n = 1; n != 32; ++n) {
96 prologue_return ret = prologue(n);
97 const void* read = ret.region->read(ret.dstn, ret.src, ret.size);
98 INFO("Mismatch in MC_region_read()");
99 REQUIRE(not memcmp(ret.src, read, ret.size));
101 munmap(ret.dstn, ret.size);
102 munmap(ret.src, ret.size);
108 void snap_test_helper::read_region_parts()
110 for (int n = 1; n != 32; ++n) {
111 prologue_return ret = prologue(n);
113 for (int j = 0; j != 100; ++j) {
114 size_t offset = rnd_engine() % ret.size;
115 size_t size = rnd_engine() % (ret.size - offset);
116 const void* read = ret.region->read(ret.dstn, (const char*)ret.src + offset, size);
117 INFO("Mismatch in MC_region_read()");
118 REQUIRE(not memcmp((char*)ret.src + offset, read, size));
120 munmap(ret.dstn, ret.size);
121 munmap(ret.src, ret.size);
127 void snap_test_helper::compare_whole_region()
129 for (int n = 1; n != 32; ++n) {
131 prologue_return ret = prologue(n);
133 INFO("Unexpected match in MC_snapshot_region_memcmp() with previous snapshot");
134 REQUIRE(MC_snapshot_region_memcmp(ret.src, ret.region0, ret.src, ret.region, ret.size));
136 munmap(ret.dstn, ret.size);
137 munmap(ret.src, ret.size);
143 void snap_test_helper::compare_region_parts()
145 for (int n = 1; n != 32; ++n) {
146 prologue_return ret = prologue(n);
148 for (int j = 0; j != 100; ++j) {
149 size_t offset = rnd_engine() % ret.size;
150 size_t size = rnd_engine() % (ret.size - offset);
152 INFO("Mismatch in MC_snapshot_region_memcmp()");
153 REQUIRE(not MC_snapshot_region_memcmp((char*)ret.src + offset, ret.region, (char*)ret.src + offset, ret.region,
156 munmap(ret.dstn, ret.size);
157 munmap(ret.src, ret.size);
163 void snap_test_helper::read_pointer()
165 prologue_return ret = prologue(1);
166 memcpy(ret.src, &mc_model_checker, sizeof(void*));
167 const simgrid::mc::Region* region2 = new simgrid::mc::Region(simgrid::mc::RegionType::Data, ret.src, ret.size);
168 INFO("Mismtach in MC_region_read_pointer()");
169 REQUIRE(MC_region_read_pointer(region2, ret.src) == mc_model_checker);
171 munmap(ret.dstn, ret.size);
172 munmap(ret.src, ret.size);
178 /*************** End: class snap_test_helper *****************************/
180 TEST_CASE("MC::Snapshot: A copy/snapshot of a given memory region", "MC::Snapshot")
182 INFO("Sparse snapshot (using pages)");
184 snap_test_helper::Init();
186 INFO("Read whole region");
187 snap_test_helper::read_whole_region();
189 INFO("Read region parts");
190 snap_test_helper::read_region_parts();
192 INFO("Compare whole region");
193 snap_test_helper::compare_whole_region();
195 INFO("Compare region parts");
196 snap_test_helper::compare_region_parts();
198 INFO("Read pointer");
199 snap_test_helper::read_pointer();
201 snap_test_helper::cleanup();