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   static std::unique_ptr<simgrid::mc::RemoteProcessMemory> memory_;
  20
  21 public:
  22   static void init_memory(void* mem, size_t size);
  23   static void Init();
  24   struct prologue_return {
  25     size_t size;
  26     void* src;
  27     void* dstn;
  28     Region* region0;
  29     Region* region;
  30   };
  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();
  37
  38   static void cleanup() { memory_ = nullptr; }
  39 };
  40
  41 // static member variables init.
  42 simgrid::mc::PageStore snap_test_helper::page_store_(500);
  43 std::unique_ptr<simgrid::mc::RemoteProcessMemory> snap_test_helper::memory_ = nullptr;
  44
  45 void snap_test_helper::init_memory(void* mem, size_t size)
  46 {
  47   auto* dest = static_cast<char*>(mem);
  48   for (size_t i = 0; i < size; ++i) {
  49     dest[i] = simgrid::xbt::random::uniform_int(0, 0xff);
  50   }
  51 }
  52
  53 void snap_test_helper::Init()
  54 {
  55   REQUIRE(xbt_pagesize == getpagesize());
  56   REQUIRE(1 << xbt_pagebits == xbt_pagesize);
  57
  58   memory_ = std::make_unique<simgrid::mc::RemoteProcessMemory>(getpid());
  59   memory_->init(nullptr);
  60 }
  61
  62 snap_test_helper::prologue_return snap_test_helper::prologue(int n)
  63 {
  64   // Store region page(s):
  65   size_t byte_size = n * xbt_pagesize;
  66   void* source     = mmap(nullptr, byte_size, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
  67   INFO("Could not allocate source memory");
  68   REQUIRE(source != MAP_FAILED);
  69
  70   // Init memory and take snapshots:
  71   init_memory(source, byte_size);
  72   auto* region0 =
  73       new simgrid::mc::Region(page_store_, *memory_.get(), simgrid::mc::RegionType::Data, source, byte_size);
  74   for (int i = 0; i < n; i += 2) {
  75     init_memory((char*)source + i * xbt_pagesize, xbt_pagesize);
  76   }
  77   auto* region = new simgrid::mc::Region(page_store_, *memory_.get(), simgrid::mc::RegionType::Data, source, byte_size);
  78
  79   void* destination = mmap(nullptr, byte_size, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
  80   INFO("Could not allocate destination memory");
  81   REQUIRE(destination != MAP_FAILED);
  82
  83   return {.size = byte_size, .src = source, .dstn = destination, .region0 = region0, .region = region};
  84 }
  85
  86 void snap_test_helper::read_whole_region()
  87 {
  88   for (int n = 1; n != 32; ++n) {
  89     prologue_return ret = prologue(n);
  90     const void* read    = ret.region->read(ret.dstn, ret.src, ret.size);
  91     INFO("Mismatch in MC_region_read()");
  92     REQUIRE(not memcmp(ret.src, read, ret.size));
  93
  94     munmap(ret.dstn, ret.size);
  95     munmap(ret.src, ret.size);
  96     delete ret.region0;
  97     delete ret.region;
  98   }
  99 }
 100
 101 void snap_test_helper::read_region_parts()
 102 {
 103   for (int n = 1; n != 32; ++n) {
 104     prologue_return ret = prologue(n);
 105
 106     for (int j = 0; j != 100; ++j) {
 107       size_t offset    = simgrid::xbt::random::uniform_int(0, ret.size - 1);
 108       size_t size      = simgrid::xbt::random::uniform_int(0, ret.size - offset - 1);
 109       const void* read = ret.region->read(ret.dstn, (const char*)ret.src + offset, size);
 110       INFO("Mismatch in MC_region_read()");
 111       REQUIRE(not memcmp((char*)ret.src + offset, read, size));
 112     }
 113     munmap(ret.dstn, ret.size);
 114     munmap(ret.src, ret.size);
 115     delete ret.region0;
 116     delete ret.region;
 117   }
 118 }
 119
 120 void snap_test_helper::compare_whole_region()
 121 {
 122   for (int n = 1; n != 32; ++n) {
 123     prologue_return ret = prologue(n);
 124
 125     INFO("Unexpected match in MC_snapshot_region_memcmp() with previous snapshot");
 126     REQUIRE(MC_snapshot_region_memcmp(ret.src, ret.region0, ret.src, ret.region, ret.size));
 127
 128     munmap(ret.dstn, ret.size);
 129     munmap(ret.src, ret.size);
 130     delete ret.region0;
 131     delete ret.region;
 132   }
 133 }
 134
 135 void snap_test_helper::compare_region_parts()
 136 {
 137   for (int n = 1; n != 32; ++n) {
 138     prologue_return ret = prologue(n);
 139
 140     for (int j = 0; j != 100; ++j) {
 141       size_t offset = simgrid::xbt::random::uniform_int(0, ret.size - 1);
 142       size_t size   = simgrid::xbt::random::uniform_int(0, ret.size - offset - 1);
 143
 144       INFO("Mismatch in MC_snapshot_region_memcmp()");
 145       REQUIRE(not MC_snapshot_region_memcmp((char*)ret.src + offset, ret.region, (char*)ret.src + offset, ret.region,
 146                                             size));
 147     }
 148     munmap(ret.dstn, ret.size);
 149     munmap(ret.src, ret.size);
 150     delete ret.region0;
 151     delete ret.region;
 152   }
 153 }
 154
 155 int some_global_variable  = 42;
 156 void* some_global_pointer = &some_global_variable;
 157 void snap_test_helper::read_pointer()
 158 {
 159   prologue_return ret = prologue(1);
 160   memcpy(ret.src, &some_global_pointer, sizeof(void*));
 161   const simgrid::mc::Region region2(page_store_, *memory_.get(), simgrid::mc::RegionType::Data, ret.src, ret.size);
 162   INFO("Mismtach in MC_region_read_pointer()");
 163   REQUIRE(MC_region_read_pointer(&region2, ret.src) == some_global_pointer);
 164
 165   munmap(ret.dstn, ret.size);
 166   munmap(ret.src, ret.size);
 167   delete ret.region0;
 168   delete ret.region;
 169 }
 170
 171 /*************** End: class snap_test_helper *****************************/
 172
 173 TEST_CASE("MC::Snapshot: A copy/snapshot of a given memory region", "MC::Snapshot")
 174 {
 175   INFO("Sparse snapshot (using pages)");
 176
 177   snap_test_helper::Init();
 178
 179   INFO("Read whole region");
 180   snap_test_helper::read_whole_region();
 181
 182   INFO("Read region parts");
 183   snap_test_helper::read_region_parts();
 184
 185   INFO("Compare whole region");
 186   snap_test_helper::compare_whole_region();
 187
 188   INFO("Compare region parts");
 189   snap_test_helper::compare_region_parts();
 190
 191   INFO("Read pointer");
 192   snap_test_helper::read_pointer();
 193
 194   snap_test_helper::cleanup();
 195 }