src/mc/sosp/Snapshot_test.cpp

   1 /* Copyright (c) 2014-2023. The SimGrid Team. All rights reserved.          */
   2
   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. */
   5
   6 #include "src/3rd-party/catch.hpp"
   7 #include "src/mc/mc_config.hpp"
   8 #include "src/mc/sosp/Snapshot.hpp"
   9
  10 #include <cstddef>
  11 #include <memory>
  12 #include <sys/mman.h>
  13 #include <xbt/random.hpp>
  14
  15 /**************** Class BOOST_tests *************************/
  16 using simgrid::mc::Region;
  17 class snap_test_helper {
  18   static simgrid::mc::PageStore page_store_;
  19
  20 public:
  21   static void init_memory(void* mem, size_t size);
  22   static void Init();
  23   struct prologue_return {
  24     size_t size;
  25     void* src;
  26     void* dstn;
  27     Region* region0;
  28     Region* region;
  29   };
  30   static prologue_return prologue(int n); // common to the below 5 fxs
  31   static void read_whole_region();
  32   static void read_region_parts();
  33   static void compare_whole_region();
  34   static void compare_region_parts();
  35   static void read_pointer();
  36
  37   static void cleanup()
  38   {
  39     delete mc_model_checker;
  40     mc_model_checker = nullptr;
  41   }
  42 };
  43
  44 // static member variables init.
  45 simgrid::mc::PageStore snap_test_helper::page_store_(500);
  46
  47 void snap_test_helper::init_memory(void* mem, size_t size)
  48 {
  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);
  52   }
  53 }
  54
  55 void snap_test_helper::Init()
  56 {
  57   REQUIRE(xbt_pagesize == getpagesize());
  58   REQUIRE(1 << xbt_pagebits == xbt_pagesize);
  59
  60   auto memory = std::make_unique<simgrid::mc::RemoteProcessMemory>(getpid());
  61   memory->init(nullptr);
  62   mc_model_checker = new ::simgrid::mc::ModelChecker(std::move(memory));
  63 }
  64
  65 snap_test_helper::prologue_return snap_test_helper::prologue(int n)
  66 {
  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);
  72
  73   // Init memory and take snapshots:
  74   init_memory(source, byte_size);
  75   auto* region0 = new simgrid::mc::Region(page_store_, mc_model_checker->get_remote_process_memory(),
  76                                           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);
  79   }
  80   auto* region = new simgrid::mc::Region(page_store_, mc_model_checker->get_remote_process_memory(),
  81                                          simgrid::mc::RegionType::Data, source, byte_size);
  82
  83   void* destination = mmap(nullptr, byte_size, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
  84   INFO("Could not allocate destination memory");
  85   REQUIRE(destination != MAP_FAILED);
  86
  87   return {.size = byte_size, .src = source, .dstn = destination, .region0 = region0, .region = region};
  88 }
  89
  90 void snap_test_helper::read_whole_region()
  91 {
  92   for (int n = 1; n != 32; ++n) {
  93     prologue_return ret = prologue(n);
  94     const void* read    = ret.region->read(ret.dstn, ret.src, ret.size);
  95     INFO("Mismatch in MC_region_read()");
  96     REQUIRE(not memcmp(ret.src, read, ret.size));
  97
  98     munmap(ret.dstn, ret.size);
  99     munmap(ret.src, ret.size);
 100     delete ret.region0;
 101     delete ret.region;
 102   }
 103 }
 104
 105 void snap_test_helper::read_region_parts()
 106 {
 107   for (int n = 1; n != 32; ++n) {
 108     prologue_return ret = prologue(n);
 109
 110     for (int j = 0; j != 100; ++j) {
 111       size_t offset    = simgrid::xbt::random::uniform_int(0, ret.size - 1);
 112       size_t size      = simgrid::xbt::random::uniform_int(0, ret.size - offset - 1);
 113       const void* read = ret.region->read(ret.dstn, (const char*)ret.src + offset, size);
 114       INFO("Mismatch in MC_region_read()");
 115       REQUIRE(not memcmp((char*)ret.src + offset, read, size));
 116     }
 117     munmap(ret.dstn, ret.size);
 118     munmap(ret.src, ret.size);
 119     delete ret.region0;
 120     delete ret.region;
 121   }
 122 }
 123
 124 void snap_test_helper::compare_whole_region()
 125 {
 126   for (int n = 1; n != 32; ++n) {
 127     prologue_return ret = prologue(n);
 128
 129     INFO("Unexpected match in MC_snapshot_region_memcmp() with previous snapshot");
 130     REQUIRE(MC_snapshot_region_memcmp(ret.src, ret.region0, ret.src, ret.region, ret.size));
 131
 132     munmap(ret.dstn, ret.size);
 133     munmap(ret.src, ret.size);
 134     delete ret.region0;
 135     delete ret.region;
 136   }
 137 }
 138
 139 void snap_test_helper::compare_region_parts()
 140 {
 141   for (int n = 1; n != 32; ++n) {
 142     prologue_return ret = prologue(n);
 143
 144     for (int j = 0; j != 100; ++j) {
 145       size_t offset = simgrid::xbt::random::uniform_int(0, ret.size - 1);
 146       size_t size   = simgrid::xbt::random::uniform_int(0, ret.size - offset - 1);
 147
 148       INFO("Mismatch in MC_snapshot_region_memcmp()");
 149       REQUIRE(not MC_snapshot_region_memcmp((char*)ret.src + offset, ret.region, (char*)ret.src + offset, ret.region,
 150                                             size));
 151     }
 152     munmap(ret.dstn, ret.size);
 153     munmap(ret.src, ret.size);
 154     delete ret.region0;
 155     delete ret.region;
 156   }
 157 }
 158
 159 void snap_test_helper::read_pointer()
 160 {
 161   prologue_return ret = prologue(1);
 162   memcpy(ret.src, &mc_model_checker, sizeof(void*));
 163   const simgrid::mc::Region region2(page_store_, mc_model_checker->get_remote_process_memory(),
 164                                     simgrid::mc::RegionType::Data, ret.src, ret.size);
 165   INFO("Mismtach in MC_region_read_pointer()");
 166   REQUIRE(MC_region_read_pointer(&region2, ret.src) == mc_model_checker);
 167
 168   munmap(ret.dstn, ret.size);
 169   munmap(ret.src, ret.size);
 170   delete ret.region0;
 171   delete ret.region;
 172 }
 173
 174 /*************** End: class snap_test_helper *****************************/
 175
 176 TEST_CASE("MC::Snapshot: A copy/snapshot of a given memory region", "MC::Snapshot")
 177 {
 178   INFO("Sparse snapshot (using pages)");
 179
 180   snap_test_helper::Init();
 181
 182   INFO("Read whole region");
 183   snap_test_helper::read_whole_region();
 184
 185   INFO("Read region parts");
 186   snap_test_helper::read_region_parts();
 187
 188   INFO("Compare whole region");
 189   snap_test_helper::compare_whole_region();
 190
 191   INFO("Compare region parts");
 192   snap_test_helper::compare_region_parts();
 193
 194   INFO("Read pointer");
 195   snap_test_helper::read_pointer();
 196
 197   snap_test_helper::cleanup();
 198 }