src/mc/mc_page_store.cpp

   1 /* Copyright (c) 2014. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #include <unistd.h>
   8 #include <string.h> // memcpy, memcp
   9
  10 #include <boost/foreach.hpp>
  11
  12 #include <xbt.h>
  13
  14 #include "mc_page_store.h"
  15
  16 #include "mc_mmu.h"
  17
  18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_page_snapshot, mc,
  19                                 "Logging specific to mc_page_snapshot");
  20
  21 extern "C" {
  22
  23 static void mc_read_pagemap(uint64_t* pagemap, size_t page_start, size_t page_count);
  24
  25 }
  26
  27 // ***** Utility:
  28
  29 /** @brief Compte a hash for the given memory page
  30  *
  31  *  The page is used before inserting the page in the page store
  32  *  in order to find duplicate of this pae in the page store.
  33  *
  34  *  @param data Memory page
  35  *  @return hash off the page
  36  */
  37 static inline  __attribute__ ((always_inline))
  38 uint64_t mc_hash_page(const void* data)
  39 {
  40   const uint64_t* values = (const uint64_t*) data;
  41   size_t n = xbt_pagesize / sizeof(uint64_t);
  42
  43   // This djb2:
  44   uint64_t hash = 5381;
  45   for (size_t i=0; i!=n; ++i) {
  46     hash = ((hash << 5) + hash) + values[i];
  47   }
  48   return hash;
  49 }
  50
  51 // ***** snapshot_page_manager
  52
  53 s_mc_pages_store::s_mc_pages_store(size_t size) :
  54   memory_(NULL), capacity_(0), top_index_(0)
  55 {
  56   // Using mmap in order to be able to expand the region
  57   // by relocating it somewhere else in the virtual memory
  58   // space:
  59   void * memory = ::mmap(NULL, size << xbt_pagebits, PROT_READ|PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS|MAP_POPULATE, -1, 0);
  60   if (memory==MAP_FAILED) {
  61     xbt_die("Could not mmap initial snapshot pages.");
  62   }
  63
  64   this->top_index_ = 0;
  65   this->capacity_ = size;
  66   this->memory_ = memory;
  67   this->page_counts_.resize(size);
  68 }
  69
  70 s_mc_pages_store::~s_mc_pages_store()
  71 {
  72   ::munmap(this->memory_, this->capacity_ << xbt_pagebits);
  73 }
  74
  75 void s_mc_pages_store::resize(size_t size)
  76 {
  77   size_t old_bytesize = this->capacity_ << xbt_pagebits;
  78   size_t new_bytesize = size << xbt_pagebits;
  79
  80   // Expand the memory region by moving it into another
  81   // virtual memory address if necessary:
  82   void* new_memory = mremap(this->memory_, old_bytesize, new_bytesize, MREMAP_MAYMOVE);
  83   if (new_memory == MAP_FAILED) {
  84     xbt_die("Could not mremap snapshot pages.");
  85   }
  86
  87   this->capacity_ = size;
  88   this->memory_ = new_memory;
  89   this->page_counts_.resize(size, 0);
  90 }
  91
  92 /** Allocate a free page
  93  *
  94  *  @return index of the free page
  95  */
  96 size_t s_mc_pages_store::alloc_page()
  97 {
  98   if (this->free_pages_.empty()) {
  99
 100     // Expand the region:
 101     if (this->top_index_ == this->capacity_) {
 102       // All the pages are allocated, we need add more pages:
 103       this->resize(2 * this->capacity_);
 104     }
 105
 106     // Use a page from the top:
 107     return this->top_index_++;
 108
 109   } else {
 110
 111     // Use a page from free_pages_ (inside of the region):
 112     size_t res = this->free_pages_[this->free_pages_.size() - 1];
 113     this->free_pages_.pop_back();
 114     return res;
 115
 116   }
 117 }
 118
 119 void s_mc_pages_store::remove_page(size_t pageno)
 120 {
 121   this->free_pages_.push_back(pageno);
 122   void* page = mc_page_from_number(this->memory_, pageno);
 123   uint64_t hash = mc_hash_page(page);
 124   this->hash_index_[hash].erase(pageno);
 125 }
 126
 127 /** Store a page in memory */
 128 size_t s_mc_pages_store::store_page(void* page)
 129 {
 130   xbt_assert(mc_page_offset(page)==0, "Not at the beginning of a page");
 131   xbt_assert(top_index_ <= this->capacity_, "top_index is not consistent");
 132
 133   // First, we check if a page with the same content is already in the page
 134   // store:
 135   //  1. compute the hash of the page;
 136   //  2. find pages with the same hash using `hash_index_`;
 137   //  3. find a page with the same content.
 138   uint64_t hash = mc_hash_page(page);
 139   page_set_type& page_set = this->hash_index_[hash];
 140   BOOST_FOREACH (size_t pageno, page_set) {
 141     const void* snapshot_page = this->get_page(pageno);
 142     if (memcmp(page, snapshot_page, xbt_pagesize) == 0) {
 143
 144       // If a page with the same content is already in the page store it is
 145       // reused and its reference count is incremented.
 146       page_counts_[pageno]++;
 147       return pageno;
 148
 149     }
 150   }
 151
 152   // Otherwise, a new page is allocated in the page store and the content
 153   // of the page is `memcpy()`-ed to this new page.
 154   size_t pageno = alloc_page();
 155   void* snapshot_page = (void*) this->get_page(pageno);
 156   memcpy(snapshot_page, page, xbt_pagesize);
 157   page_set.insert(pageno);
 158   page_counts_[pageno]++;
 159   return pageno;
 160 }
 161
 162 // ***** Main C API
 163
 164 extern "C" {
 165
 166 mc_pages_store_t mc_pages_store_new()
 167 {
 168   return new s_mc_pages_store_t(500);
 169 }
 170
 171 }