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
   8 #include <cstdlib>
   9 #include <cstring>
  10 #include <random>
  11
  12 #include <sys/mman.h>
  13
  14 #include "src/mc/mc_config.hpp"
  15 #include "src/mc/mc_mmu.hpp"
  16 #include "src/mc/mc_private.hpp"
  17 #include "src/mc/sosp/mc_snapshot.hpp"
  18
  19 /**************** Class BOOST_tests *************************/
  20 using simgrid::mc::RegionSnapshot;
  21 class snap_test_helper {
  22 public:
  23   static void init_memory(void* mem, size_t size);
  24   static void Init(bool sparse_ckpt);
  25   typedef struct {
  26     size_t size;
  27     void* src;
  28     void* dstn;
  29     RegionSnapshot* region0;
  30     RegionSnapshot* region;
  31   } prologue_return;
  32   static prologue_return prologue(int n); // common to the below 5 fxs
  33   static void read_whole_region();
  34   static void read_region_parts();
  35   static void compare_whole_region();
  36   static void compare_region_parts();
  37   static void read_pointer();
  38
  39   static void cleanup()
  40   {
  41     delete mc_model_checker;
  42     mc_model_checker = nullptr;
  43   }
  44
  45   static std::default_random_engine rnd_engine;
  46   static bool sparse_checkpoint;
  47   static std::unique_ptr<simgrid::mc::RemoteClient> process;
  48 };
  49
  50 // static member variables init.
  51 std::default_random_engine snap_test_helper::rnd_engine;
  52 bool snap_test_helper::sparse_checkpoint                             = 0;
  53 std::unique_ptr<simgrid::mc::RemoteClient> snap_test_helper::process = nullptr;
  54
  55 void snap_test_helper::init_memory(void* mem, size_t size)
  56 {
  57   char* dest = (char*)mem;
  58   for (size_t i = 0; i < size; ++i) {
  59     dest[i] = rnd_engine() & 255;
  60   }
  61 }
  62
  63 void snap_test_helper::Init(bool sparse_ckpt)
  64 {
  65   _sg_mc_sparse_checkpoint = sparse_ckpt;
  66   REQUIRE(xbt_pagesize == getpagesize());
  67   REQUIRE(1 << xbt_pagebits == xbt_pagesize);
  68
  69   process.reset(new simgrid::mc::RemoteClient(getpid(), -1));
  70   process->init();
  71   mc_model_checker = new ::simgrid::mc::ModelChecker(std::move(process));
  72 }
  73
  74 snap_test_helper::prologue_return snap_test_helper::prologue(int n)
  75 {
  76   // Store region page(s):
  77   size_t byte_size = n * xbt_pagesize;
  78   void* source     = mmap(nullptr, byte_size, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
  79   INFO("Could not allocate source memory")
  80   REQUIRE(source != MAP_FAILED);
  81
  82   // Init memory and take snapshots:
  83   init_memory(source, byte_size);
  84   simgrid::mc::RegionSnapshot* region0 =
  85       new simgrid::mc::RegionSparse(simgrid::mc::RegionType::Unknown, source, source, byte_size);
  86   for (int i = 0; i < n; i += 2) {
  87     init_memory((char*)source + i * xbt_pagesize, xbt_pagesize);
  88   }
  89   simgrid::mc::RegionSnapshot* region =
  90       new simgrid::mc::RegionSparse(simgrid::mc::RegionType::Unknown, source, source, byte_size);
  91
  92   void* destination = mmap(nullptr, byte_size, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
  93   INFO("Could not allocate destination memory");
  94   REQUIRE(source != MAP_FAILED);
  95
  96   return {.size    = byte_size,
  97           .src     = source,
  98           .dstn    = destination,
  99           .region0 = std::move(region0),
 100           .region  = std::move(region)};
 101 }
 102
 103 void snap_test_helper::read_whole_region()
 104 {
 105   for (int n = 1; n != 32; ++n) {
 106
 107     prologue_return ret = prologue(n);
 108     const void* read    = MC_region_read(ret.region, ret.dstn, ret.src, ret.size);
 109     INFO("Mismatch in MC_region_read()");
 110     REQUIRE(not memcmp(ret.src, read, ret.size));
 111
 112     munmap(ret.dstn, ret.size);
 113     munmap(ret.src, ret.size);
 114     delete ret.region0;
 115     delete ret.region;
 116   }
 117 }
 118
 119 void snap_test_helper::read_region_parts()
 120 {
 121   for (int n = 1; n != 32; ++n) {
 122
 123     prologue_return ret = prologue(n);
 124
 125     for (int j = 0; j != 100; ++j) {
 126       size_t offset    = rnd_engine() % ret.size;
 127       size_t size      = rnd_engine() % (ret.size - offset);
 128       const void* read = MC_region_read(ret.region, ret.dstn, (const char*)ret.src + offset, size);
 129       INFO("Mismatch in MC_region_read()");
 130       REQUIRE(not memcmp((char*)ret.src + offset, read, 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_whole_region()
 140 {
 141   for (int n = 1; n != 32; ++n) {
 142
 143     prologue_return ret = prologue(n);
 144
 145     INFO("Unexpected match in MC_snapshot_region_memcmp() with previous snapshot");
 146     REQUIRE(MC_snapshot_region_memcmp(ret.src, ret.region0, ret.src, ret.region, ret.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 void snap_test_helper::compare_region_parts()
 156 {
 157   for (int n = 1; n != 32; ++n) {
 158
 159     prologue_return ret = prologue(n);
 160
 161     for (int j = 0; j != 100; ++j) {
 162       size_t offset = rnd_engine() % ret.size;
 163       size_t size   = rnd_engine() % (ret.size - offset);
 164
 165       INFO("Mismatch in MC_snapshot_region_memcmp()");
 166       REQUIRE(not MC_snapshot_region_memcmp((char*)ret.src + offset, ret.region, (char*)ret.src + offset, ret.region,
 167                                             size));
 168     }
 169     munmap(ret.dstn, ret.size);
 170     munmap(ret.src, ret.size);
 171     delete ret.region0;
 172     delete ret.region;
 173   }
 174 }
 175
 176 void snap_test_helper::read_pointer()
 177 {
 178
 179   prologue_return ret = prologue(1);
 180   memcpy(ret.src, &mc_model_checker, sizeof(void*));
 181   simgrid::mc::RegionSnapshot* region2 =
 182       new simgrid::mc::RegionSparse(simgrid::mc::RegionType::Unknown, ret.src, ret.src, ret.size);
 183   INFO("Mismtach in MC_region_read_pointer()");
 184   REQUIRE(MC_region_read_pointer(region2, ret.src) == mc_model_checker);
 185
 186   munmap(ret.dstn, ret.size);
 187   munmap(ret.src, ret.size);
 188   delete ret.region0;
 189   delete ret.region;
 190   delete region2;
 191 }
 192
 193 /*************** End: class snap_test_helper *****************************/
 194
 195 TEST_CASE("MC::Snapshot: A copy/snapshot of a given memory region", "MC::Snapshot")
 196 {
 197   auto sparse = GENERATE(false, true);
 198
 199   if (sparse) {
 200     INFO("Sparse snapshot (using pages)");
 201   } else {
 202     INFO("Flat snapshot (no pages)");
 203   }
 204
 205   snap_test_helper::Init(sparse);
 206
 207   INFO("Read whole region");
 208   snap_test_helper::read_whole_region();
 209
 210   INFO("Read region parts");
 211   snap_test_helper::read_region_parts();
 212
 213   INFO("Compare whole region");
 214   snap_test_helper::compare_whole_region();
 215
 216   INFO("Compare region parts");
 217   snap_test_helper::compare_region_parts();
 218
 219   INFO("Read pointer");
 220   snap_test_helper::read_pointer();
 221
 222   snap_test_helper::cleanup();
 223 }