src/mc/sosp/mc_snapshot_test.cpp

   1 /* Copyright (c) 2014-2019. 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/mc_snapshot.hpp"
   9
  10 #include <cstddef>
  11 #include <random>
  12 #include <sys/mman.h>
  13
  14 /**************** Class BOOST_tests *************************/
  15 using simgrid::mc::RegionSnapshot;
  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     RegionSnapshot* region0;
  25     RegionSnapshot* 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::RegionSnapshot* region0 =
  77       new simgrid::mc::RegionSnapshot(simgrid::mc::RegionType::Unknown, source, source, byte_size);
  78   for (int i = 0; i < n; i += 2) {
  79     init_memory((char*)source + i * xbt_pagesize, xbt_pagesize);
  80   }
  81   simgrid::mc::RegionSnapshot* region =
  82       new simgrid::mc::RegionSnapshot(simgrid::mc::RegionType::Unknown, source, 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(source != MAP_FAILED);
  87
  88   return {.size    = byte_size,
  89           .src     = source,
  90           .dstn    = destination,
  91           .region0 = std::move(region0),
  92           .region  = std::move(region)};
  93 }
  94
  95 void snap_test_helper::read_whole_region()
  96 {
  97   for (int n = 1; n != 32; ++n) {
  98
  99     prologue_return ret = prologue(n);
 100     const void* read    = MC_region_read(ret.region, ret.dstn, ret.src, ret.size);
 101     INFO("Mismatch in MC_region_read()");
 102     REQUIRE(not memcmp(ret.src, read, ret.size));
 103
 104     munmap(ret.dstn, ret.size);
 105     munmap(ret.src, ret.size);
 106     delete ret.region0;
 107     delete ret.region;
 108   }
 109 }
 110
 111 void snap_test_helper::read_region_parts()
 112 {
 113   for (int n = 1; n != 32; ++n) {
 114
 115     prologue_return ret = prologue(n);
 116
 117     for (int j = 0; j != 100; ++j) {
 118       size_t offset    = rnd_engine() % ret.size;
 119       size_t size      = rnd_engine() % (ret.size - offset);
 120       const void* read = MC_region_read(ret.region, ret.dstn, (const char*)ret.src + offset, size);
 121       INFO("Mismatch in MC_region_read()");
 122       REQUIRE(not memcmp((char*)ret.src + offset, read, size));
 123     }
 124     munmap(ret.dstn, ret.size);
 125     munmap(ret.src, ret.size);
 126     delete ret.region0;
 127     delete ret.region;
 128   }
 129 }
 130
 131 void snap_test_helper::compare_whole_region()
 132 {
 133   for (int n = 1; n != 32; ++n) {
 134
 135     prologue_return ret = prologue(n);
 136
 137     INFO("Unexpected match in MC_snapshot_region_memcmp() with previous snapshot");
 138     REQUIRE(MC_snapshot_region_memcmp(ret.src, ret.region0, ret.src, ret.region, ret.size));
 139
 140     munmap(ret.dstn, ret.size);
 141     munmap(ret.src, ret.size);
 142     delete ret.region0;
 143     delete ret.region;
 144   }
 145 }
 146
 147 void snap_test_helper::compare_region_parts()
 148 {
 149   for (int n = 1; n != 32; ++n) {
 150
 151     prologue_return ret = prologue(n);
 152
 153     for (int j = 0; j != 100; ++j) {
 154       size_t offset = rnd_engine() % ret.size;
 155       size_t size   = rnd_engine() % (ret.size - offset);
 156
 157       INFO("Mismatch in MC_snapshot_region_memcmp()");
 158       REQUIRE(not MC_snapshot_region_memcmp((char*)ret.src + offset, ret.region, (char*)ret.src + offset, ret.region,
 159                                             size));
 160     }
 161     munmap(ret.dstn, ret.size);
 162     munmap(ret.src, ret.size);
 163     delete ret.region0;
 164     delete ret.region;
 165   }
 166 }
 167
 168 void snap_test_helper::read_pointer()
 169 {
 170
 171   prologue_return ret = prologue(1);
 172   memcpy(ret.src, &mc_model_checker, sizeof(void*));
 173   simgrid::mc::RegionSnapshot* region2 =
 174       new simgrid::mc::RegionSnapshot(simgrid::mc::RegionType::Unknown, ret.src, ret.src, ret.size);
 175   INFO("Mismtach in MC_region_read_pointer()");
 176   REQUIRE(MC_region_read_pointer(region2, ret.src) == mc_model_checker);
 177
 178   munmap(ret.dstn, ret.size);
 179   munmap(ret.src, ret.size);
 180   delete ret.region0;
 181   delete ret.region;
 182   delete region2;
 183 }
 184
 185 /*************** End: class snap_test_helper *****************************/
 186
 187 TEST_CASE("MC::Snapshot: A copy/snapshot of a given memory region", "MC::Snapshot")
 188 {
 189
 190   INFO("Sparse snapshot (using pages)");
 191
 192   snap_test_helper::Init();
 193
 194   INFO("Read whole region");
 195   snap_test_helper::read_whole_region();
 196
 197   INFO("Read region parts");
 198   snap_test_helper::read_region_parts();
 199
 200   INFO("Compare whole region");
 201   snap_test_helper::compare_whole_region();
 202
 203   INFO("Compare region parts");
 204   snap_test_helper::compare_region_parts();
 205
 206   INFO("Read pointer");
 207   snap_test_helper::read_pointer();
 208
 209   snap_test_helper::cleanup();
 210 }