src/mc/sosp/Snapshot_test.cpp

   1 /* Copyright (c) 2014-2020. 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/include/catch.hpp"
   7 #include "src/mc/mc_config.hpp"
   8 #include "src/mc/sosp/Snapshot.hpp"
   9
  10 #include <cstddef>
  11 #include <random>
  12 #include <sys/mman.h>
  13
  14 /**************** Class BOOST_tests *************************/
  15 using simgrid::mc::Region;
  16 class snap_test_helper {
  17 public:
  18   static void init_memory(void* mem, size_t size);
  19   static void Init();
  20   typedef struct {
  21     size_t size;
  22     void* src;
  23     void* dstn;
  24     Region* region0;
  25     Region* region;
  26   } prologue_return;
  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();
  33
  34   static void cleanup()
  35   {
  36     delete mc_model_checker;
  37     mc_model_checker = nullptr;
  38   }
  39
  40   static std::default_random_engine rnd_engine;
  41   static std::unique_ptr<simgrid::mc::RemoteClient> process;
  42 };
  43
  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;
  47
  48 void snap_test_helper::init_memory(void* mem, size_t size)
  49 {
  50   char* dest = (char*)mem;
  51   for (size_t i = 0; i < size; ++i) {
  52     dest[i] = rnd_engine() & 255;
  53   }
  54 }
  55
  56 void snap_test_helper::Init()
  57 {
  58   REQUIRE(xbt_pagesize == getpagesize());
  59   REQUIRE(1 << xbt_pagebits == xbt_pagesize);
  60
  61   process.reset(new simgrid::mc::RemoteClient(getpid(), -1));
  62   process->init();
  63   mc_model_checker = new ::simgrid::mc::ModelChecker(std::move(process));
  64 }
  65
  66 snap_test_helper::prologue_return snap_test_helper::prologue(int n)
  67 {
  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);
  73
  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);
  79   }
  80   simgrid::mc::Region* region = new simgrid::mc::Region(simgrid::mc::RegionType::Data, source, byte_size);
  81
  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);
  85
  86   return {.size    = byte_size,
  87           .src     = source,
  88           .dstn    = destination,
  89           .region0 = std::move(region0),
  90           .region  = std::move(region)};
  91 }
  92
  93 void snap_test_helper::read_whole_region()
  94 {
  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));
 100
 101     munmap(ret.dstn, ret.size);
 102     munmap(ret.src, ret.size);
 103     delete ret.region0;
 104     delete ret.region;
 105   }
 106 }
 107
 108 void snap_test_helper::read_region_parts()
 109 {
 110   for (int n = 1; n != 32; ++n) {
 111     prologue_return ret = prologue(n);
 112
 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));
 119     }
 120     munmap(ret.dstn, ret.size);
 121     munmap(ret.src, ret.size);
 122     delete ret.region0;
 123     delete ret.region;
 124   }
 125 }
 126
 127 void snap_test_helper::compare_whole_region()
 128 {
 129   for (int n = 1; n != 32; ++n) {
 130     prologue_return ret = prologue(n);
 131
 132     INFO("Unexpected match in MC_snapshot_region_memcmp() with previous snapshot");
 133     REQUIRE(MC_snapshot_region_memcmp(ret.src, ret.region0, ret.src, ret.region, ret.size));
 134
 135     munmap(ret.dstn, ret.size);
 136     munmap(ret.src, ret.size);
 137     delete ret.region0;
 138     delete ret.region;
 139   }
 140 }
 141
 142 void snap_test_helper::compare_region_parts()
 143 {
 144   for (int n = 1; n != 32; ++n) {
 145     prologue_return ret = prologue(n);
 146
 147     for (int j = 0; j != 100; ++j) {
 148       size_t offset = rnd_engine() % ret.size;
 149       size_t size   = rnd_engine() % (ret.size - offset);
 150
 151       INFO("Mismatch in MC_snapshot_region_memcmp()");
 152       REQUIRE(not MC_snapshot_region_memcmp((char*)ret.src + offset, ret.region, (char*)ret.src + offset, ret.region,
 153                                             size));
 154     }
 155     munmap(ret.dstn, ret.size);
 156     munmap(ret.src, ret.size);
 157     delete ret.region0;
 158     delete ret.region;
 159   }
 160 }
 161
 162 void snap_test_helper::read_pointer()
 163 {
 164   prologue_return ret = prologue(1);
 165   memcpy(ret.src, &mc_model_checker, sizeof(void*));
 166   const simgrid::mc::Region* region2 = new simgrid::mc::Region(simgrid::mc::RegionType::Data, ret.src, ret.size);
 167   INFO("Mismtach in MC_region_read_pointer()");
 168   REQUIRE(MC_region_read_pointer(region2, ret.src) == mc_model_checker);
 169
 170   munmap(ret.dstn, ret.size);
 171   munmap(ret.src, ret.size);
 172   delete ret.region0;
 173   delete ret.region;
 174   delete region2;
 175 }
 176
 177 /*************** End: class snap_test_helper *****************************/
 178
 179 TEST_CASE("MC::Snapshot: A copy/snapshot of a given memory region", "MC::Snapshot")
 180 {
 181   INFO("Sparse snapshot (using pages)");
 182
 183   snap_test_helper::Init();
 184
 185   INFO("Read whole region");
 186   snap_test_helper::read_whole_region();
 187
 188   INFO("Read region parts");
 189   snap_test_helper::read_region_parts();
 190
 191   INFO("Compare whole region");
 192   snap_test_helper::compare_whole_region();
 193
 194   INFO("Compare region parts");
 195   snap_test_helper::compare_region_parts();
 196
 197   INFO("Read pointer");
 198   snap_test_helper::read_pointer();
 199
 200   snap_test_helper::cleanup();
 201 }