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   static std::unique_ptr<simgrid::mc::RemoteProcess> process;
  44 };
  45
  46 // static member variables init.
  47 std::unique_ptr<simgrid::mc::RemoteProcess> snap_test_helper::process = nullptr;
  48 simgrid::mc::PageStore snap_test_helper::page_store_(500);
  49
  50 void snap_test_helper::init_memory(void* mem, size_t size)
  51 {
  52   auto* dest = static_cast<char*>(mem);
  53   for (size_t i = 0; i < size; ++i) {
  54     dest[i] = simgrid::xbt::random::uniform_int(0, 0xff);
  55   }
  56 }
  57
  58 void snap_test_helper::Init()
  59 {
  60   REQUIRE(xbt_pagesize == getpagesize());
  61   REQUIRE(1 << xbt_pagebits == xbt_pagesize);
  62
  63   process = std::make_unique<simgrid::mc::RemoteProcess>(getpid());
  64   process->init(nullptr, nullptr);
  65   mc_model_checker = new ::simgrid::mc::ModelChecker(std::move(process), -1);
  66 }
  67
  68 snap_test_helper::prologue_return snap_test_helper::prologue(int n)
  69 {
  70   // Store region page(s):
  71   size_t byte_size = n * xbt_pagesize;
  72   void* source     = mmap(nullptr, byte_size, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
  73   INFO("Could not allocate source memory");
  74   REQUIRE(source != MAP_FAILED);
  75
  76   // Init memory and take snapshots:
  77   init_memory(source, byte_size);
  78   auto* region0 = new simgrid::mc::Region(page_store_, simgrid::mc::RegionType::Data, source, byte_size);
  79   for (int i = 0; i < n; i += 2) {
  80     init_memory((char*)source + i * xbt_pagesize, xbt_pagesize);
  81   }
  82   auto* region = new simgrid::mc::Region(page_store_, simgrid::mc::RegionType::Data, source, byte_size);
  83
  84   void* destination = mmap(nullptr, byte_size, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
  85   INFO("Could not allocate destination memory");
  86   REQUIRE(destination != MAP_FAILED);
  87
  88   return {.size = byte_size, .src = source, .dstn = destination, .region0 = region0, .region = region};
  89 }
  90
  91 void snap_test_helper::read_whole_region()
  92 {
  93   for (int n = 1; n != 32; ++n) {
  94     prologue_return ret = prologue(n);
  95     const void* read    = ret.region->read(ret.dstn, ret.src, ret.size);
  96     INFO("Mismatch in MC_region_read()");
  97     REQUIRE(not memcmp(ret.src, read, ret.size));
  98
  99     munmap(ret.dstn, ret.size);
 100     munmap(ret.src, ret.size);
 101     delete ret.region0;
 102     delete ret.region;
 103   }
 104 }
 105
 106 void snap_test_helper::read_region_parts()
 107 {
 108   for (int n = 1; n != 32; ++n) {
 109     prologue_return ret = prologue(n);
 110
 111     for (int j = 0; j != 100; ++j) {
 112       size_t offset    = simgrid::xbt::random::uniform_int(0, ret.size - 1);
 113       size_t size      = simgrid::xbt::random::uniform_int(0, ret.size - offset - 1);
 114       const void* read = ret.region->read(ret.dstn, (const char*)ret.src + offset, size);
 115       INFO("Mismatch in MC_region_read()");
 116       REQUIRE(not memcmp((char*)ret.src + offset, read, size));
 117     }
 118     munmap(ret.dstn, ret.size);
 119     munmap(ret.src, ret.size);
 120     delete ret.region0;
 121     delete ret.region;
 122   }
 123 }
 124
 125 void snap_test_helper::compare_whole_region()
 126 {
 127   for (int n = 1; n != 32; ++n) {
 128     prologue_return ret = prologue(n);
 129
 130     INFO("Unexpected match in MC_snapshot_region_memcmp() with previous snapshot");
 131     REQUIRE(MC_snapshot_region_memcmp(ret.src, ret.region0, ret.src, ret.region, ret.size));
 132
 133     munmap(ret.dstn, ret.size);
 134     munmap(ret.src, ret.size);
 135     delete ret.region0;
 136     delete ret.region;
 137   }
 138 }
 139
 140 void snap_test_helper::compare_region_parts()
 141 {
 142   for (int n = 1; n != 32; ++n) {
 143     prologue_return ret = prologue(n);
 144
 145     for (int j = 0; j != 100; ++j) {
 146       size_t offset = simgrid::xbt::random::uniform_int(0, ret.size - 1);
 147       size_t size   = simgrid::xbt::random::uniform_int(0, ret.size - offset - 1);
 148
 149       INFO("Mismatch in MC_snapshot_region_memcmp()");
 150       REQUIRE(not MC_snapshot_region_memcmp((char*)ret.src + offset, ret.region, (char*)ret.src + offset, ret.region,
 151                                             size));
 152     }
 153     munmap(ret.dstn, ret.size);
 154     munmap(ret.src, ret.size);
 155     delete ret.region0;
 156     delete ret.region;
 157   }
 158 }
 159
 160 void snap_test_helper::read_pointer()
 161 {
 162   prologue_return ret = prologue(1);
 163   memcpy(ret.src, &mc_model_checker, sizeof(void*));
 164   const simgrid::mc::Region region2(page_store_, 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 }