1 /* Copyright (c) 2015-2022. The SimGrid Team. All rights reserved. */
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. */
8 #define MAP_POPULATE MAP_PREFAULT_READ
11 #include "src/internal_config.h"
13 #include "xbt/sysdep.h"
15 #include "src/include/xxhash.hpp"
16 #include "src/mc/mc_mmu.hpp"
17 #include "src/mc/sosp/PageStore.hpp"
19 #include <cstring> // memcpy, memcmp
25 /** @brief Compute a hash for the given memory page
27 * The page is used before inserting the page in the page store in order to find duplicate of this page in the page
30 * @param data Memory page
31 * @return hash off the page
33 static XBT_ALWAYS_INLINE PageStore::hash_type mc_hash_page(const void* data)
35 return xxh::xxhash<64>(data, xbt_pagesize);
38 // ***** snapshot_page_manager
40 PageStore::PageStore(std::size_t size) : capacity_(size)
42 // Using mmap in order to be able to expand the region by relocating it somewhere else in the virtual memory space:
44 ::mmap(nullptr, size << xbt_pagebits, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS | MAP_POPULATE, -1, 0);
45 xbt_assert(memory != MAP_FAILED, "Could not mmap initial snapshot pages.");
48 this->memory_ = memory;
49 this->page_counts_.resize(size);
52 PageStore::~PageStore()
54 ::munmap(this->memory_, this->capacity_ << xbt_pagebits);
57 void PageStore::resize(std::size_t size)
59 size_t old_bytesize = this->capacity_ << xbt_pagebits;
60 size_t new_bytesize = size << xbt_pagebits;
63 // Expand the memory region by moving it into another
64 // virtual memory address if necessary:
66 new_memory = mremap(this->memory_, old_bytesize, new_bytesize, MREMAP_MAYMOVE);
67 xbt_assert(new_memory != MAP_FAILED, "Could not mremap snapshot pages.");
69 if (new_bytesize > old_bytesize) {
70 // Grow: first try to add new space after current map
71 new_memory = mmap((char*)this->memory_ + old_bytesize, new_bytesize - old_bytesize, PROT_READ | PROT_WRITE,
72 MAP_PRIVATE | MAP_ANONYMOUS | MAP_POPULATE, -1, 0);
73 xbt_assert(new_memory != MAP_FAILED, "Could not mremap snapshot pages.");
74 // Check if expanding worked
75 if (new_memory != (char*)this->memory_ + old_bytesize) {
76 // New memory segment could not be put at the end of this->memory_,
77 // so cancel this one and try to relocate everything and copy data
78 munmap(new_memory, new_bytesize - old_bytesize);
80 mmap(nullptr, new_bytesize, PROT_READ | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS | MAP_POPULATE, -1, 0);
81 xbt_assert(new_memory != MAP_FAILED, "Could not mremap snapshot pages.");
82 memcpy(new_memory, this->memory_, old_bytesize);
83 munmap(this->memory_, old_bytesize);
86 // We don't have functions to shrink a mapping, so leave memory as
88 new_memory = this->memory_;
92 this->capacity_ = size;
93 this->memory_ = new_memory;
94 this->page_counts_.resize(size, 0);
97 /** Allocate a free page
99 * @return index of the free page
101 std::size_t PageStore::alloc_page()
103 if (this->free_pages_.empty()) {
104 // Expand the region:
105 if (this->top_index_ == this->capacity_)
106 // All the pages are allocated, we need add more pages:
107 this->resize(2 * this->capacity_);
109 // Use a page from the top:
110 return this->top_index_++;
112 // Use a page from free_pages_ (inside of the region):
113 size_t res = this->free_pages_[this->free_pages_.size() - 1];
114 this->free_pages_.pop_back();
119 void PageStore::remove_page(std::size_t pageno)
121 this->free_pages_.push_back(pageno);
122 const void* page = this->get_page(pageno);
123 hash_type hash = mc_hash_page(page);
124 this->hash_index_[hash].erase(pageno);
127 /** Store a page in memory */
128 std::size_t PageStore::store_page(const void* page)
130 xbt_assert(top_index_ <= this->capacity_, "top_index is not consistent");
132 // First, we check if a page with the same content is already in the page store:
133 // 1. compute the hash of the page
134 // 2. find pages with the same hash using `hash_index_`
135 // 3. find a page with the same content
136 hash_type hash = mc_hash_page(page);
138 // Try to find a duplicate in set of pages with the same hash:
139 page_set_type& page_set = this->hash_index_[hash];
140 for (size_t const& pageno : page_set) {
141 const void* snapshot_page = this->get_page(pageno);
142 if (memcmp(page, snapshot_page, xbt_pagesize) == 0) {
143 // If a page with the same content is already in the page store it's reused and its refcount is incremented.
144 page_counts_[pageno]++;
149 // Otherwise, a new page is allocated in the page store and the content of the page is `memcpy()`-ed to this new page.
150 std::size_t pageno = alloc_page();
151 xbt_assert(this->page_counts_[pageno] == 0, "Allocated page is already used");
152 void* snapshot_page = this->get_page(pageno);
153 memcpy(snapshot_page, page, xbt_pagesize);
154 page_set.insert(pageno);
155 page_counts_[pageno]++;
160 } // namespace simgrid