1 /* Copyright (c) 2007-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. */
6 /* Shared allocations are handled through shared memory segments.
7 * Associated data and metadata are used as follows:
10 * `allocs' map ---- -.
11 * ---------- shared_data_t shared_metadata_t / | | |
12 * .->| <name> | ---> -------------------- <--. ----------------- | | | |
13 * | ---------- | fd of <name> | | | size of mmap | --| | | |
14 * | | count (2) | |-- | data | \ | | |
15 * `----------------- | <name> | | ----------------- ---- |
16 * -------------------- | ^ |
18 * | | `allocs_metadata' map |
19 * | | ---------------------- |
20 * | `-- | <addr of mmap #1> |<-'
21 * | .-- | <addr of mmap #2> |<-.
22 * | | ---------------------- |
28 * | shared_metadata_t / | |
29 * | ----------------- | | |
30 * | | size of mmap | --| | |
32 * ----------------- | | |
40 #include "private.hpp"
41 #include "xbt/config.hpp"
42 #include "xbt/file.hpp"
46 #include <sys/types.h>
51 #include <sys/types.h>
53 #include "smpi_utils.hpp"
55 #define MAP_ANONYMOUS MAP_ANON
59 #define MAP_POPULATE 0
62 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_shared, smpi, "Logging specific to SMPI (shared memory macros)");
65 /** Some location in the source code
67 * This information is used by SMPI_SHARED_MALLOC to allocate some shared memory for all simulated processes.
70 class smpi_source_location : public std::string {
72 smpi_source_location() = default;
73 smpi_source_location(const char* filename, int line) : std::string(std::string(filename) + ":" + std::to_string(line))
78 struct shared_data_t {
83 std::unordered_map<smpi_source_location, shared_data_t, std::hash<std::string>> allocs;
84 using shared_data_key_type = decltype(allocs)::value_type;
86 struct shared_metadata_t {
88 size_t allocated_size;
90 std::vector<std::pair<size_t, size_t>> private_blocks;
91 shared_data_key_type* data;
94 std::map<const void*, shared_metadata_t> allocs_metadata;
95 std::map<std::string, void*, std::less<>> calls;
98 int smpi_shared_malloc_bogusfile = -1;
99 int smpi_shared_malloc_bogusfile_huge_page = -1;
100 unsigned long smpi_shared_malloc_blocksize = 1UL << 20;
104 void smpi_shared_destroy()
107 allocs_metadata.clear();
112 static void* shm_map(int fd, size_t size, shared_data_key_type* data)
114 void* mem = smpi_temp_shm_mmap(fd, size);
115 shared_metadata_t meta;
118 meta.allocated_ptr = mem;
119 meta.allocated_size = size;
120 allocs_metadata[mem] = meta;
121 XBT_DEBUG("MMAP %zu to %p", size, mem);
125 static void *smpi_shared_malloc_local(size_t size, const char *file, int line)
128 smpi_source_location loc(file, line);
129 auto res = allocs.insert(std::make_pair(loc, shared_data_t()));
130 auto data = res.first;
132 // The new element was inserted.
133 int fd = smpi_temp_shm_get();
134 data->second.fd = fd;
135 data->second.count = 1;
136 mem = shm_map(fd, size, &*data);
138 mem = shm_map(data->second.fd, size, &*data);
139 data->second.count++;
141 XBT_DEBUG("Shared malloc %zu in %p through %d (metadata at %p)", size, mem, data->second.fd, &*data);
145 // Align functions, from http://stackoverflow.com/questions/4840410/how-to-align-a-pointer-in-c
146 #define ALIGN_UP(n, align) (((int64_t)(n) + (int64_t)(align) - 1) & -(int64_t)(align))
147 #define ALIGN_DOWN(n, align) ((int64_t)(n) & -(int64_t)(align))
149 constexpr unsigned PAGE_SIZE = 0x1000;
150 constexpr unsigned HUGE_PAGE_SIZE = 1U << 21;
152 /* Similar to smpi_shared_malloc, but only sharing the blocks described by shared_block_offsets.
153 * This array contains the offsets (in bytes) of the block to share.
154 * Even indices are the start offsets (included), odd indices are the stop offsets (excluded).
155 * For instance, if shared_block_offsets == {27, 42}, then the elements mem[27], mem[28], ..., mem[41] are shared.
156 * The others are not.
159 void* smpi_shared_malloc_partial(size_t size, const size_t* shared_block_offsets, int nb_shared_blocks)
161 std::string huge_page_mount_point = simgrid::config::get_value<std::string>("smpi/shared-malloc-hugepage");
162 bool use_huge_page = not huge_page_mount_point.empty();
163 #ifndef MAP_HUGETLB /* If the system header don't define that mmap flag */
164 xbt_assert(not use_huge_page,
165 "Huge pages are not available on your system, you cannot use the smpi/shared-malloc-hugepage option.");
167 smpi_shared_malloc_blocksize =
168 static_cast<unsigned long>(simgrid::config::get_value<double>("smpi/shared-malloc-blocksize"));
170 size_t allocated_size;
172 xbt_assert(smpi_shared_malloc_blocksize == HUGE_PAGE_SIZE, "the block size of shared malloc should be equal to the size of a huge page.");
173 allocated_size = size + 2*smpi_shared_malloc_blocksize;
176 xbt_assert(smpi_shared_malloc_blocksize % PAGE_SIZE == 0, "the block size of shared malloc should be a multiple of the page size.");
177 allocated_size = size;
181 /* First reserve memory area */
182 void* allocated_ptr = mmap(nullptr, allocated_size, PROT_READ | PROT_WRITE, MAP_ANONYMOUS | MAP_PRIVATE, -1, 0);
184 xbt_assert(allocated_ptr != MAP_FAILED, "Failed to allocate %zuMiB of memory. Run \"sysctl vm.overcommit_memory=1\" as root "
185 "to allow big allocations.\n",
188 mem = (void*)ALIGN_UP(allocated_ptr, HUGE_PAGE_SIZE);
192 XBT_DEBUG("global shared allocation. Blocksize %lu", smpi_shared_malloc_blocksize);
193 /* Create a fd to a new file on disk, make it smpi_shared_malloc_blocksize big, and unlink it.
194 * It still exists in memory but not in the file system (thus it cannot be leaked). */
195 /* Create bogus file if not done already
196 * We need two different bogusfiles:
197 * smpi_shared_malloc_bogusfile_huge_page is used for calls to mmap *with* MAP_HUGETLB,
198 * smpi_shared_malloc_bogusfile is used for calls to mmap *without* MAP_HUGETLB.
199 * We cannot use a same file for the two type of calls, since the first one needs to be
200 * opened in a hugetlbfs mount point whereas the second needs to be a "classical" file. */
201 if(use_huge_page && smpi_shared_malloc_bogusfile_huge_page == -1) {
202 std::string huge_page_filename = huge_page_mount_point + "/simgrid-shmalloc-XXXXXX";
203 smpi_shared_malloc_bogusfile_huge_page = mkstemp((char*)huge_page_filename.c_str());
204 XBT_DEBUG("bogusfile_huge_page: %s\n", huge_page_filename.c_str());
205 unlink(huge_page_filename.c_str());
207 if(smpi_shared_malloc_bogusfile == -1) {
208 char name[] = "/tmp/simgrid-shmalloc-XXXXXX";
209 smpi_shared_malloc_bogusfile = mkstemp(name);
210 XBT_DEBUG("bogusfile : %s\n", name);
212 xbt_assert(ftruncate(smpi_shared_malloc_bogusfile, smpi_shared_malloc_blocksize) == 0,
213 "Could not write bogus file for shared malloc");
216 int mmap_base_flag = MAP_FIXED | MAP_SHARED | MAP_POPULATE;
217 int mmap_flag = mmap_base_flag;
218 int huge_fd = use_huge_page ? smpi_shared_malloc_bogusfile_huge_page : smpi_shared_malloc_bogusfile;
221 mmap_flag |= MAP_HUGETLB;
224 XBT_DEBUG("global shared allocation, begin mmap");
226 /* Map the bogus file in place of the anonymous memory */
227 for(int i_block = 0; i_block < nb_shared_blocks; i_block ++) {
228 XBT_DEBUG("\tglobal shared allocation, mmap block %d/%d", i_block+1, nb_shared_blocks);
229 size_t start_offset = shared_block_offsets[2*i_block];
230 size_t stop_offset = shared_block_offsets[2*i_block+1];
231 xbt_assert(start_offset < stop_offset, "start_offset (%zu) should be lower than stop offset (%zu)", start_offset, stop_offset);
232 xbt_assert(stop_offset <= size, "stop_offset (%zu) should be lower than size (%zu)", stop_offset, size);
233 if(i_block < nb_shared_blocks-1)
234 xbt_assert(stop_offset < shared_block_offsets[2*i_block+2],
235 "stop_offset (%zu) should be lower than its successor start offset (%zu)", stop_offset, shared_block_offsets[2*i_block+2]);
236 size_t start_block_offset = ALIGN_UP(start_offset, smpi_shared_malloc_blocksize);
237 size_t stop_block_offset = ALIGN_DOWN(stop_offset, smpi_shared_malloc_blocksize);
238 for (size_t offset = start_block_offset; offset < stop_block_offset; offset += smpi_shared_malloc_blocksize) {
239 XBT_DEBUG("\t\tglobal shared allocation, mmap block offset %zx", offset);
240 void* pos = static_cast<char*>(mem) + offset;
241 const void* res = mmap(pos, smpi_shared_malloc_blocksize, PROT_READ | PROT_WRITE, mmap_flag, huge_fd, 0);
242 xbt_assert(res == pos, "Could not map folded virtual memory (%s). Do you perhaps need to increase the "
243 "size of the mapped file using --cfg=smpi/shared-malloc-blocksize:newvalue (default 1048576) ? "
244 "You can also try using the sysctl vm.max_map_count. "
245 "If you are using huge pages, check that you have at least one huge page (/proc/sys/vm/nr_hugepages) "
246 "and that the directory you are passing is mounted correctly (mount /path/to/huge -t hugetlbfs -o rw,mode=0777).",
249 size_t low_page_start_offset = ALIGN_UP(start_offset, PAGE_SIZE);
250 size_t low_page_stop_offset = (int64_t)start_block_offset < ALIGN_DOWN(stop_offset, PAGE_SIZE) ? start_block_offset : ALIGN_DOWN(stop_offset, PAGE_SIZE);
251 if(low_page_start_offset < low_page_stop_offset) {
252 XBT_DEBUG("\t\tglobal shared allocation, mmap block start");
253 void* pos = static_cast<char*>(mem) + low_page_start_offset;
254 const void* res = mmap(pos, low_page_stop_offset - low_page_start_offset, PROT_READ | PROT_WRITE,
255 mmap_base_flag, // not a full huge page
256 smpi_shared_malloc_bogusfile, 0);
257 xbt_assert(res == pos, "Could not map folded virtual memory (%s). Do you perhaps need to increase the "
258 "size of the mapped file using --cfg=smpi/shared-malloc-blocksize:newvalue (default 1048576) ?"
259 "You can also try using the sysctl vm.max_map_count",
262 if(low_page_stop_offset <= stop_block_offset) {
263 XBT_DEBUG("\t\tglobal shared allocation, mmap block stop");
264 size_t high_page_stop_offset = stop_offset == size ? size : ALIGN_DOWN(stop_offset, PAGE_SIZE);
265 if(high_page_stop_offset > stop_block_offset) {
266 void* pos = static_cast<char*>(mem) + stop_block_offset;
267 const void* res = mmap(pos, high_page_stop_offset - stop_block_offset, PROT_READ | PROT_WRITE,
268 mmap_base_flag, // not a full huge page
269 smpi_shared_malloc_bogusfile, 0);
270 xbt_assert(res == pos, "Could not map folded virtual memory (%s). Do you perhaps need to increase the "
271 "size of the mapped file using --cfg=smpi/shared-malloc-blocksize:newvalue (default 1048576) ?"
272 "You can also try using the sysctl vm.max_map_count",
278 shared_metadata_t newmeta;
279 //register metadata for memcpy avoidance
280 auto* data = new shared_data_key_type;
281 data->second.fd = -1;
282 data->second.count = 1;
285 newmeta.allocated_ptr = allocated_ptr;
286 newmeta.allocated_size = allocated_size;
287 if(shared_block_offsets[0] > 0) {
288 newmeta.private_blocks.emplace_back(0, shared_block_offsets[0]);
291 for(i_block = 0; i_block < nb_shared_blocks-1; i_block ++) {
292 newmeta.private_blocks.emplace_back(shared_block_offsets[2 * i_block + 1], shared_block_offsets[2 * i_block + 2]);
294 if(shared_block_offsets[2*i_block+1] < size) {
295 newmeta.private_blocks.emplace_back(shared_block_offsets[2 * i_block + 1], size);
297 allocs_metadata[mem] = newmeta;
299 XBT_DEBUG("global shared allocation, allocated_ptr %p - %p", allocated_ptr, (void*)(((uint64_t)allocated_ptr)+allocated_size));
300 XBT_DEBUG("global shared allocation, returned_ptr %p - %p", mem, (void*)(((uint64_t)mem)+size));
305 void* smpi_shared_malloc_intercept(size_t size, const char* file, int line)
307 if( smpi_cfg_auto_shared_malloc_thresh() == 0 || size < smpi_cfg_auto_shared_malloc_thresh()){
308 void* ptr = xbt_malloc(size);
309 if(not smpi_cfg_trace_call_use_absolute_path())
310 simgrid::smpi::utils::account_malloc_size(size, simgrid::xbt::Path(file).get_base_name(), line, ptr);
312 simgrid::smpi::utils::account_malloc_size(size, file, line, ptr);
315 simgrid::smpi::utils::account_shared_size(size);
316 return smpi_shared_malloc(size, file, line);
320 void* smpi_shared_calloc_intercept(size_t num_elm, size_t elem_size, const char* file, int line)
322 size_t size = elem_size * num_elm;
323 if (smpi_cfg_auto_shared_malloc_thresh() == 0 || size < smpi_cfg_auto_shared_malloc_thresh()) {
324 void* ptr = xbt_malloc0(size);
325 if(not smpi_cfg_trace_call_use_absolute_path())
326 simgrid::smpi::utils::account_malloc_size(size, simgrid::xbt::Path(file).get_base_name(), line, ptr);
328 simgrid::smpi::utils::account_malloc_size(size, file, line, ptr);
331 simgrid::smpi::utils::account_shared_size(size);
332 return memset(smpi_shared_malloc(size, file, line), 0, size);
336 void* smpi_shared_realloc_intercept(void* data, size_t size, const char* file, int line)
339 smpi_shared_free(data);
343 return smpi_shared_malloc_intercept(size, file, line);
345 auto meta = allocs_metadata.find(data);
346 if (meta == allocs_metadata.end()) {
347 XBT_DEBUG("Classical realloc(%p, %zu)", data, size);
348 return xbt_realloc(data, size);
351 XBT_DEBUG("Shared realloc(%p, %zu) (old size: %zu)", data, size, meta->second.size);
352 void* ptr = smpi_shared_malloc_intercept(size, file, line);
354 memcpy(ptr, data, std::min(size, meta->second.size));
355 smpi_shared_free(data);
360 void* smpi_shared_malloc(size_t size, const char* file, int line)
362 if (size > 0 && smpi_cfg_shared_malloc() == SharedMallocType::LOCAL) {
363 return smpi_shared_malloc_local(size, file, line);
364 } else if (smpi_cfg_shared_malloc() == SharedMallocType::GLOBAL) {
365 int nb_shared_blocks = 1;
366 const std::array<size_t, 2> shared_block_offsets = {{0, size}};
367 return smpi_shared_malloc_partial(size, shared_block_offsets.data(), nb_shared_blocks);
369 XBT_DEBUG("Classic allocation of %zu bytes", size);
370 return xbt_malloc(size);
373 int smpi_is_shared(const void* ptr, std::vector<std::pair<size_t, size_t>> &private_blocks, size_t *offset){
374 private_blocks.clear(); // being paranoid
375 if (allocs_metadata.empty())
377 if (smpi_cfg_shared_malloc() == SharedMallocType::LOCAL || smpi_cfg_shared_malloc() == SharedMallocType::GLOBAL) {
378 auto low = allocs_metadata.lower_bound(ptr);
379 if (low != allocs_metadata.end() && low->first == ptr) {
380 private_blocks = low->second.private_blocks;
384 if (low == allocs_metadata.begin())
387 if (ptr < (char*)low->first + low->second.size) {
388 xbt_assert(ptr > (char*)low->first, "Oops, there seems to be a bug in the shared memory metadata.");
389 *offset = ((uint8_t*)ptr) - ((uint8_t*) low->first);
390 private_blocks = low->second.private_blocks;
399 std::vector<std::pair<size_t, size_t>> shift_and_frame_private_blocks(const std::vector<std::pair<size_t, size_t>>& vec,
400 size_t offset, size_t buff_size)
402 std::vector<std::pair<size_t, size_t>> result;
403 for (auto const& block : vec) {
404 auto new_block = std::make_pair(std::min(std::max((size_t)0, block.first - offset), buff_size),
405 std::min(std::max((size_t)0, block.second - offset), buff_size));
406 if (new_block.second > 0 && new_block.first < buff_size)
407 result.push_back(new_block);
412 std::vector<std::pair<size_t, size_t>> merge_private_blocks(const std::vector<std::pair<size_t, size_t>>& src,
413 const std::vector<std::pair<size_t, size_t>>& dst)
415 std::vector<std::pair<size_t, size_t>> result;
418 while(i_src < src.size() && i_dst < dst.size()) {
419 std::pair<size_t, size_t> block;
420 if(src[i_src].second <= dst[i_dst].first) {
423 else if(dst[i_dst].second <= src[i_src].first) {
426 else { // src.second > dst.first && dst.second > src.first → the blocks are overlapping
427 block = std::make_pair(std::max(src[i_src].first, dst[i_dst].first),
428 std::min(src[i_src].second, dst[i_dst].second));
429 result.push_back(block);
430 if(src[i_src].second < dst[i_dst].second)
439 void smpi_shared_free(void *ptr)
441 simgrid::smpi::utils::account_free(ptr);
442 if (smpi_cfg_shared_malloc() == SharedMallocType::LOCAL) {
443 auto meta = allocs_metadata.find(ptr);
444 if (meta == allocs_metadata.end()) {
448 shared_data_t* data = &meta->second.data->second;
449 if (munmap(meta->second.allocated_ptr, meta->second.allocated_size) < 0) {
450 XBT_WARN("Unmapping of fd %d failed: %s", data->fd, strerror(errno));
453 if (data->count <= 0) {
455 allocs.erase(allocs.find(meta->second.data->first));
456 allocs_metadata.erase(meta);
457 XBT_DEBUG("Shared free - Local - with removal - of %p", ptr);
459 XBT_DEBUG("Shared free - Local - no removal - of %p, count = %d", ptr, data->count);
462 } else if (smpi_cfg_shared_malloc() == SharedMallocType::GLOBAL) {
463 auto meta = allocs_metadata.find(ptr);
464 if (meta != allocs_metadata.end()){
465 meta->second.data->second.count--;
466 XBT_DEBUG("Shared free - Global - of %p", ptr);
467 munmap(ptr, meta->second.size);
468 if(meta->second.data->second.count==0){
469 delete meta->second.data;
470 allocs_metadata.erase(meta);
478 XBT_DEBUG("Classic deallocation of %p", ptr);
484 int smpi_shared_known_call(const char* func, const char* input)
486 std::string loc = std::string(func) + ":" + input;
487 return calls.find(loc) != calls.end();
490 void* smpi_shared_get_call(const char* func, const char* input) {
491 std::string loc = std::string(func) + ":" + input;
493 return calls.at(loc);
496 void* smpi_shared_set_call(const char* func, const char* input, void* data) {
497 std::string loc = std::string(func) + ":" + input;