src/mc/sosp/PageStore_test.cpp

   1 /* Copyright (c) 2015-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 <cstdint>
   9 #include <cstring>
  10 #include <iostream>
  11
  12 #include <sys/mman.h>
  13 #include <unistd.h>
  14
  15 #include <memory>
  16
  17 #include "src/mc/sosp/PageStore.hpp"
  18
  19 using simgrid::mc::PageStore;
  20
  21 /***********************************/
  22 // a class to hold the variable used in the test cases
  23 class helper_tests {
  24 public:
  25   static std::size_t pagesize;
  26   static std::unique_ptr<PageStore> store;
  27   static void* data;
  28   static size_t pageno[4];
  29   static int value;
  30
  31   // member functions used by the test suite(s)
  32   static void Init();
  33   static void store_page_once();
  34   static void store_same_page();
  35   static void store_new_page();
  36   static void unref_pages();
  37   static void reallocate_page();
  38
  39   static void new_content(void* buf, std::size_t size);
  40 };
  41
  42 // static member datat initialization
  43 std::size_t helper_tests::pagesize             = 0;
  44 std::unique_ptr<PageStore> helper_tests::store = nullptr;
  45 void* helper_tests::data                       = nullptr;
  46 size_t helper_tests::pageno[4]                 = {0, 0, 0, 0};
  47 int helper_tests::value                        = 0;
  48
  49 void helper_tests::Init()
  50 {
  51   pagesize = (size_t)getpagesize();
  52   store.reset(new simgrid::mc::PageStore(50));
  53   data     = mmap(nullptr, getpagesize(), PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
  54   REQUIRE(store->size() == 0);
  55 }
  56
  57 void helper_tests::store_page_once()
  58 {
  59   new_content(data, pagesize);
  60   pageno[0] = store->store_page(data);
  61   REQUIRE(store->get_ref(pageno[0]) == 1);
  62   const void* copy = store->get_page(pageno[0]);
  63   REQUIRE(::memcmp(data, copy, pagesize) == 0); // The page data should be the same
  64   REQUIRE(store->size() == 1);
  65 }
  66
  67 void helper_tests::store_same_page()
  68 {
  69   pageno[1] = store->store_page(data);
  70   REQUIRE(pageno[0] == pageno[1]); // Page should be the same
  71   REQUIRE(store->get_ref(pageno[0]) == 2);
  72   REQUIRE(store->size() == 1);
  73 }
  74
  75 void helper_tests::store_new_page()
  76 {
  77   new_content(data, pagesize);
  78   pageno[2] = store->store_page(data);
  79   REQUIRE(pageno[0] != pageno[2]); // The new page should be different
  80   REQUIRE(store->size() == 2);
  81 }
  82
  83 void helper_tests::unref_pages()
  84 {
  85   store->unref_page(pageno[0]);
  86   REQUIRE(store->get_ref(pageno[0]) == 1);
  87   REQUIRE(store->size() == 2);
  88
  89   store->unref_page(pageno[1]);
  90   REQUIRE(store->size() == 1);
  91 }
  92
  93 void helper_tests::reallocate_page()
  94 {
  95   new_content(data, pagesize);
  96   pageno[3] = store->store_page(data);
  97   REQUIRE(pageno[0] == pageno[3]); // The old page should be reused
  98   REQUIRE(store->get_ref(pageno[3]) == 1);
  99   REQUIRE(store->size() == 2);
 100 }
 101
 102 void helper_tests::new_content(void* buf, std::size_t size)
 103 {
 104   value++;
 105   ::memset(buf, value, size);
 106 }
 107
 108 TEST_CASE("MC page store, used during checkpoint", "MC::PageStore")
 109 {
 110   helper_tests::Init();
 111   INFO("Store page once");
 112   helper_tests::store_page_once();
 113
 114   INFO("Store the same page");
 115   helper_tests::store_same_page();
 116
 117   INFO("Store a new page");
 118   helper_tests::store_new_page();
 119
 120   INFO("Unref pages");
 121   helper_tests::unref_pages();
 122
 123   INFO("Reallocate pages");
 124   helper_tests::reallocate_page();
 125 }