src/mc/sosp/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/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
  97     prologue_return ret = prologue(n);
  98     const void* read    = MC_region_read(ret.region, ret.dstn, ret.src, ret.size);
  99     INFO("Mismatch in MC_region_read()");
 100     REQUIRE(not memcmp(ret.src, read, ret.size));
 101
 102     munmap(ret.dstn, ret.size);
 103     munmap(ret.src, ret.size);
 104     delete ret.region0;
 105     delete ret.region;
 106   }
 107 }
 108
 109 void snap_test_helper::read_region_parts()
 110 {
 111   for (int n = 1; n != 32; ++n) {
 112
 113     prologue_return ret = prologue(n);
 114
 115     for (int j = 0; j != 100; ++j) {
 116       size_t offset    = rnd_engine() % ret.size;
 117       size_t size      = rnd_engine() % (ret.size - offset);
 118       const void* read = MC_region_read(ret.region, ret.dstn, (const char*)ret.src + offset, size);
 119       INFO("Mismatch in MC_region_read()");
 120       REQUIRE(not memcmp((char*)ret.src + offset, read, size));
 121     }
 122     munmap(ret.dstn, ret.size);
 123     munmap(ret.src, ret.size);
 124     delete ret.region0;
 125     delete ret.region;
 126   }
 127 }
 128
 129 void snap_test_helper::compare_whole_region()
 130 {
 131   for (int n = 1; n != 32; ++n) {
 132
 133     prologue_return ret = prologue(n);
 134
 135     INFO("Unexpected match in MC_snapshot_region_memcmp() with previous snapshot");
 136     REQUIRE(MC_snapshot_region_memcmp(ret.src, ret.region0, ret.src, ret.region, ret.size));
 137
 138     munmap(ret.dstn, ret.size);
 139     munmap(ret.src, ret.size);
 140     delete ret.region0;
 141     delete ret.region;
 142   }
 143 }
 144
 145 void snap_test_helper::compare_region_parts()
 146 {
 147   for (int n = 1; n != 32; ++n) {
 148
 149     prologue_return ret = prologue(n);
 150
 151     for (int j = 0; j != 100; ++j) {
 152       size_t offset = rnd_engine() % ret.size;
 153       size_t size   = rnd_engine() % (ret.size - offset);
 154
 155       INFO("Mismatch in MC_snapshot_region_memcmp()");
 156       REQUIRE(not MC_snapshot_region_memcmp((char*)ret.src + offset, ret.region, (char*)ret.src + offset, ret.region,
 157                                             size));
 158     }
 159     munmap(ret.dstn, ret.size);
 160     munmap(ret.src, ret.size);
 161     delete ret.region0;
 162     delete ret.region;
 163   }
 164 }
 165
 166 void snap_test_helper::read_pointer()
 167 {
 168
 169   prologue_return ret = prologue(1);
 170   memcpy(ret.src, &mc_model_checker, sizeof(void*));
 171   simgrid::mc::Region* region2 = new simgrid::mc::Region(simgrid::mc::RegionType::Data, ret.src, ret.size);
 172   INFO("Mismtach in MC_region_read_pointer()");
 173   REQUIRE(MC_region_read_pointer(region2, ret.src) == mc_model_checker);
 174
 175   munmap(ret.dstn, ret.size);
 176   munmap(ret.src, ret.size);
 177   delete ret.region0;
 178   delete ret.region;
 179   delete region2;
 180 }
 181
 182 /*************** End: class snap_test_helper *****************************/
 183
 184 TEST_CASE("MC::Snapshot: A copy/snapshot of a given memory region", "MC::Snapshot")
 185 {
 186
 187   INFO("Sparse snapshot (using pages)");
 188
 189   snap_test_helper::Init();
 190
 191   INFO("Read whole region");
 192   snap_test_helper::read_whole_region();
 193
 194   INFO("Read region parts");
 195   snap_test_helper::read_region_parts();
 196
 197   INFO("Compare whole region");
 198   snap_test_helper::compare_whole_region();
 199
 200   INFO("Compare region parts");
 201   snap_test_helper::compare_region_parts();
 202
 203   INFO("Read pointer");
 204   snap_test_helper::read_pointer();
 205
 206   snap_test_helper::cleanup();
 207 }