src/mc/sosp/PageStore_test.cpp

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