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"
13 #include "src/mc/mc_config.hpp"
14 #include "src/mc/mc_mmu.hpp"
15 #include "src/mc/mc_private.hpp"
16 #include "src/mc/sosp/mc_snapshot.hpp"
18 /**************** Class BOOST_tests *************************/
19 using simgrid::mc::RegionSnapshot;
20 class snap_test_helper {
22 static void init_memory(void* mem, size_t size);
23 static void Init(bool sparse_ckpt);
28 RegionSnapshot region0;
29 RegionSnapshot region;
31 static prologue_return prologue(int n); // common to the below 5 fxs
32 static void read_whole_region();
33 static void read_region_parts();
34 static void compare_whole_region();
35 static void compare_region_parts();
36 static void read_pointer();
40 delete mc_model_checker;
41 mc_model_checker = nullptr;
44 static bool sparse_checkpoint;
45 static std::unique_ptr<simgrid::mc::RemoteClient> process;
48 // static member variables init.
49 bool snap_test_helper::sparse_checkpoint = 0;
50 std::unique_ptr<simgrid::mc::RemoteClient> snap_test_helper::process = nullptr;
52 void snap_test_helper::init_memory(void* mem, size_t size)
54 char* dest = (char*)mem;
55 for (size_t i = 0; i < size; ++i) {
56 dest[i] = rand() & 255;
60 void snap_test_helper::Init(bool sparse_ckpt)
62 _sg_mc_sparse_checkpoint = sparse_ckpt;
63 REQUIRE(xbt_pagesize == getpagesize());
64 REQUIRE(1 << xbt_pagebits == xbt_pagesize);
66 process = std::unique_ptr<simgrid::mc::RemoteClient>(new simgrid::mc::RemoteClient(getpid(), -1));
68 mc_model_checker = new ::simgrid::mc::ModelChecker(std::move(process));
71 snap_test_helper::prologue_return snap_test_helper::prologue(int n)
73 // Store region page(s):
74 size_t byte_size = n * xbt_pagesize;
75 void* source = mmap(nullptr, byte_size, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
76 INFO("Could not allocate source memory")
77 REQUIRE(source != MAP_FAILED);
79 // Init memory and take snapshots:
80 init_memory(source, byte_size);
81 simgrid::mc::RegionSnapshot region0 =
82 simgrid::mc::sparse_region(simgrid::mc::RegionType::Unknown, source, source, byte_size);
83 for (int i = 0; i < n; i += 2) {
84 init_memory((char*)source + i * xbt_pagesize, xbt_pagesize);
86 simgrid::mc::RegionSnapshot region =
87 simgrid::mc::sparse_region(simgrid::mc::RegionType::Unknown, source, source, byte_size);
89 void* destination = mmap(nullptr, byte_size, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
90 INFO("Could not allocate destination memory");
91 REQUIRE(source != MAP_FAILED);
93 return {.size = byte_size,
96 .region0 = std::move(region0),
97 .region = std::move(region)};
100 void snap_test_helper::read_whole_region()
102 for (int n = 1; n != 32; ++n) {
104 prologue_return ret = prologue(n);
105 const void* read = MC_region_read(&(ret.region), ret.dstn, ret.src, ret.size);
106 INFO("Mismatch in MC_region_read()");
107 REQUIRE(not memcmp(ret.src, read, ret.size));
109 munmap(ret.dstn, ret.size);
110 munmap(ret.src, ret.size);
114 void snap_test_helper::read_region_parts()
116 for (int n = 1; n != 32; ++n) {
118 prologue_return ret = prologue(n);
120 for (int j = 0; j != 100; ++j) {
121 size_t offset = rand() % ret.size;
122 size_t size = rand() % (ret.size - offset);
123 const void* read = MC_region_read(&(ret.region), ret.dstn, (const char*)ret.src + offset, size);
124 INFO("Mismatch in MC_region_read()");
125 REQUIRE(not memcmp((char*)ret.src + offset, read, size));
127 munmap(ret.dstn, ret.size);
128 munmap(ret.src, ret.size);
132 void snap_test_helper::compare_whole_region()
134 for (int n = 1; n != 32; ++n) {
136 prologue_return ret = prologue(n);
138 INFO("Unexpected match in MC_snapshot_region_memcmp() with previous snapshot");
139 REQUIRE(MC_snapshot_region_memcmp(ret.src, &(ret.region0), ret.src, &(ret.region), ret.size));
141 munmap(ret.dstn, ret.size);
142 munmap(ret.src, ret.size);
146 void snap_test_helper::compare_region_parts()
148 for (int n = 1; n != 32; ++n) {
150 prologue_return ret = prologue(n);
152 for (int j = 0; j != 100; ++j) {
153 size_t offset = rand() % ret.size;
154 size_t size = rand() % (ret.size - offset);
156 INFO("Mismatch in MC_snapshot_region_memcmp()");
157 REQUIRE(not MC_snapshot_region_memcmp((char*)ret.src + offset, &(ret.region), (char*)ret.src + offset,
158 &(ret.region), size));
160 munmap(ret.dstn, ret.size);
161 munmap(ret.src, ret.size);
165 void snap_test_helper::read_pointer()
168 prologue_return ret = prologue(1);
169 memcpy(ret.src, &mc_model_checker, sizeof(void*));
170 simgrid::mc::RegionSnapshot region2 =
171 simgrid::mc::sparse_region(simgrid::mc::RegionType::Unknown, ret.src, ret.src, ret.size);
172 INFO("Mismtach in MC_region_read_pointer()");
173 REQUIRE(MC_region_read_pointer(®ion2, ret.src) == mc_model_checker);
175 munmap(ret.dstn, ret.size);
176 munmap(ret.src, ret.size);
179 /*************** End: class snap_test_helper *****************************/
181 TEST_CASE("MC::Snapshot: A copy/snapshot of a given memory region", "MC::Snapshot")
183 auto sparse = GENERATE(false, true);
186 INFO("Sparse snapshot (using pages)");
188 INFO("Flat snapshot (no pages)");
191 snap_test_helper::Init(sparse);
193 INFO("Read whole region");
194 snap_test_helper::read_whole_region();
196 INFO("Read region parts");
197 snap_test_helper::read_region_parts();
199 INFO("Compare whole region");
200 snap_test_helper::compare_whole_region();
202 INFO("Compare region parts");
203 snap_test_helper::compare_region_parts();
205 INFO("Read pointer");
206 snap_test_helper::read_pointer();
208 snap_test_helper::cleanup();