1 /* Copyright (c) 2007, 2009-2017. 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' dict ---- -.
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' dict |
19 * | | ---------------------- |
20 * | `-- | <addr of mmap #1> |<-'
21 * | .-- | <addr of mmap #2> |<-.
22 * | | ---------------------- |
28 * | shared_metadata_t / | |
29 * | ----------------- | | |
30 * | | size of mmap | --| | |
32 * ----------------- | | |
39 #include "private.hpp"
40 #include "smpi/smpi_shared_malloc.hpp"
44 #include <sys/types.h>
54 #define MAP_ANONYMOUS MAP_ANON
58 #define MAP_POPULATE 0
61 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_shared, smpi, "Logging specific to SMPI (shared memory macros)");
63 #define PTR_STRLEN (2 + 2 * sizeof(void*) + 1)
66 /** Some location in the source code
68 * This information is used by SMPI_SHARED_MALLOC to allocate some shared memory for all simulated processes.
71 class smpi_source_location {
73 smpi_source_location(const char* filename, int line)
74 : filename(xbt_strdup(filename)), filename_length(strlen(filename)), line(line)
78 /** Pointer to a static string containing the file name */
79 char* filename = nullptr;
80 int filename_length = 0;
83 bool operator==(smpi_source_location const& that) const
85 return filename_length == that.filename_length && line == that.line &&
86 std::memcmp(filename, that.filename, filename_length) == 0;
88 bool operator!=(smpi_source_location const& that) const { return !(*this == that); }
94 template <> class hash<smpi_source_location> {
96 typedef smpi_source_location argument_type;
97 typedef std::size_t result_type;
98 result_type operator()(smpi_source_location const& loc) const
100 return xbt_str_hash_ext(loc.filename, loc.filename_length) ^
101 xbt_str_hash_ext((const char*)&loc.line, sizeof(loc.line));
113 std::unordered_map<smpi_source_location, shared_data_t> allocs;
114 typedef std::unordered_map<smpi_source_location, shared_data_t>::value_type shared_data_key_type;
118 std::vector<std::pair<size_t, size_t>> private_blocks;
119 shared_data_key_type* data;
122 std::map<void*, shared_metadata_t> allocs_metadata;
123 xbt_dict_t calls = nullptr; /* Allocated on first use */
125 static int smpi_shared_malloc_bogusfile = -1;
126 static unsigned long smpi_shared_malloc_blocksize = 1UL << 20;
131 void smpi_shared_destroy()
134 allocs_metadata.clear();
135 xbt_dict_free(&calls);
138 static size_t shm_size(int fd) {
141 if(fstat(fd, &st) < 0) {
142 xbt_die("Could not stat fd %d: %s", fd, strerror(errno));
144 return static_cast<size_t>(st.st_size);
148 static void* shm_map(int fd, size_t size, shared_data_key_type* data) {
149 char loc[PTR_STRLEN];
150 shared_metadata_t meta;
152 if(size > shm_size(fd) && (ftruncate(fd, static_cast<off_t>(size)) < 0)) {
153 xbt_die("Could not truncate fd %d to %zu: %s", fd, size, strerror(errno));
156 void* mem = mmap(nullptr, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
157 if(mem == MAP_FAILED) {
159 "Failed to map fd %d with size %zu: %s\n"
160 "If you are running a lot of ranks, you may be exceeding the amount of mappings allowed per process.\n"
161 "On Linux systems, change this value with sudo sysctl -w vm.max_map_count=newvalue (default value: 65536)\n"
162 "Please see http://simgrid.gforge.inria.fr/simgrid/latest/doc/html/options.html#options_virt for more info.",
163 fd, size, strerror(errno));
165 snprintf(loc, PTR_STRLEN, "%p", mem);
168 allocs_metadata[mem] = meta;
169 XBT_DEBUG("MMAP %zu to %p", size, mem);
173 static void *smpi_shared_malloc_local(size_t size, const char *file, int line)
176 smpi_source_location loc(file, line);
177 auto res = allocs.insert(std::make_pair(loc, shared_data_t()));
178 auto data = res.first;
180 // The insertion did not take place.
181 // Generate a shared memory name from the address of the shared_data:
182 char shmname[32]; // cannot be longer than PSHMNAMLEN = 31 on Mac OS X (shm_open raises ENAMETOOLONG otherwise)
183 snprintf(shmname, 31, "/shmalloc%p", &*data);
184 int fd = shm_open(shmname, O_RDWR | O_CREAT | O_EXCL, S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
187 xbt_die("Please cleanup /dev/shm/%s", shmname);
189 xbt_die("An unhandled error occurred while opening %s. shm_open: %s", shmname, strerror(errno));
191 data->second.fd = fd;
192 data->second.count = 1;
193 mem = shm_map(fd, size, &*data);
194 if (shm_unlink(shmname) < 0) {
195 XBT_WARN("Could not early unlink %s. shm_unlink: %s", shmname, strerror(errno));
197 XBT_DEBUG("Mapping %s at %p through %d", shmname, mem, fd);
199 mem = shm_map(data->second.fd, size, &*data);
200 data->second.count++;
202 XBT_DEBUG("Shared malloc %zu in %p (metadata at %p)", size, mem, &*data);
206 // Align functions, from http://stackoverflow.com/questions/4840410/how-to-align-a-pointer-in-c
207 #define PAGE_SIZE 0x1000
208 #define ALIGN_UP(n, align) (((n) + (align)-1) & -(align))
209 #define ALIGN_DOWN(n, align) ((n) & -(align))
211 void* smpi_shared_malloc_partial(size_t size, size_t* shared_block_offsets, int nb_shared_blocks)
214 xbt_assert(smpi_shared_malloc_blocksize % PAGE_SIZE == 0, "The block size of shared malloc should be a multiple of the page size.");
215 /* First reserve memory area */
216 mem = mmap(NULL, size, PROT_READ | PROT_WRITE, MAP_ANONYMOUS | MAP_PRIVATE, -1, 0);
218 xbt_assert(mem != MAP_FAILED, "Failed to allocate %zuMiB of memory. Run \"sysctl vm.overcommit_memory=1\" as root "
219 "to allow big allocations.\n",
222 /* Create bogus file if not done already */
223 if (smpi_shared_malloc_bogusfile == -1) {
224 /* Create a fd to a new file on disk, make it smpi_shared_malloc_blocksize big, and unlink it.
225 * It still exists in memory but not in the file system (thus it cannot be leaked). */
226 smpi_shared_malloc_blocksize = static_cast<unsigned long>(xbt_cfg_get_double("smpi/shared-malloc-blocksize"));
227 XBT_DEBUG("global shared allocation. Blocksize %lu", smpi_shared_malloc_blocksize);
228 char* name = xbt_strdup("/tmp/simgrid-shmalloc-XXXXXX");
229 smpi_shared_malloc_bogusfile = mkstemp(name);
232 char* dumb = (char*)calloc(1, smpi_shared_malloc_blocksize);
233 ssize_t err = write(smpi_shared_malloc_bogusfile, dumb, smpi_shared_malloc_blocksize);
235 xbt_die("Could not write bogus file for shared malloc");
239 /* Map the bogus file in place of the anonymous memory */
240 for(int i_block = 0; i_block < nb_shared_blocks; i_block ++) {
241 size_t start_offset = shared_block_offsets[2*i_block];
242 size_t stop_offset = shared_block_offsets[2*i_block+1];
243 xbt_assert(start_offset < stop_offset, "start_offset (%zu) should be lower than stop offset (%zu)", start_offset, stop_offset);
244 xbt_assert(stop_offset <= size, "stop_offset (%zu) should be lower than size (%zu)", stop_offset, size);
245 if(i_block < nb_shared_blocks-1)
246 xbt_assert(stop_offset < shared_block_offsets[2*i_block+2],
247 "stop_offset (%zu) should be lower than its successor start offset (%zu)", stop_offset, shared_block_offsets[2*i_block+2]);
248 size_t start_block_offset = ALIGN_UP(start_offset, smpi_shared_malloc_blocksize);
249 size_t stop_block_offset = ALIGN_DOWN(stop_offset, smpi_shared_malloc_blocksize);
251 for (i = start_block_offset / smpi_shared_malloc_blocksize; i < stop_block_offset / smpi_shared_malloc_blocksize; i++) {
252 void* pos = (void*)((unsigned long)mem + i * smpi_shared_malloc_blocksize);
253 void* res = mmap(pos, smpi_shared_malloc_blocksize, PROT_READ | PROT_WRITE, MAP_FIXED | MAP_SHARED | MAP_POPULATE,
254 smpi_shared_malloc_bogusfile, 0);
255 xbt_assert(res == pos, "Could not map folded virtual memory (%s). Do you perhaps need to increase the "
256 "size of the mapped file using --cfg=smpi/shared-malloc-blocksize=newvalue (default 1048576) ?"
257 "You can also try using the sysctl vm.max_map_count",
260 size_t low_page_start_offset = ALIGN_UP(start_offset, PAGE_SIZE);
261 size_t low_page_stop_offset = start_block_offset < ALIGN_DOWN(stop_offset, PAGE_SIZE) ? start_block_offset : ALIGN_DOWN(stop_offset, PAGE_SIZE);
262 if(low_page_start_offset < low_page_stop_offset) {
263 void* pos = (void*)((unsigned long)mem + low_page_start_offset);
264 void* res = mmap(pos, low_page_stop_offset-low_page_start_offset, PROT_READ | PROT_WRITE, MAP_FIXED | MAP_SHARED | MAP_POPULATE,
265 smpi_shared_malloc_bogusfile, 0);
266 xbt_assert(res == pos, "Could not map folded virtual memory (%s). Do you perhaps need to increase the "
267 "size of the mapped file using --cfg=smpi/shared-malloc-blocksize=newvalue (default 1048576) ?"
268 "You can also try using the sysctl vm.max_map_count",
271 if(low_page_stop_offset <= stop_block_offset) {
272 size_t high_page_stop_offset = stop_offset == size ? size : ALIGN_DOWN(stop_offset, PAGE_SIZE);
273 if(high_page_stop_offset > stop_block_offset) {
274 void* pos = (void*)((unsigned long)mem + stop_block_offset);
275 void* res = mmap(pos, high_page_stop_offset-stop_block_offset, PROT_READ | PROT_WRITE, MAP_FIXED | MAP_SHARED | MAP_POPULATE,
276 smpi_shared_malloc_bogusfile, 0);
277 xbt_assert(res == pos, "Could not map folded virtual memory (%s). Do you perhaps need to increase the "
278 "size of the mapped file using --cfg=smpi/shared-malloc-blocksize=newvalue (default 1048576) ?"
279 "You can also try using the sysctl vm.max_map_count",
285 shared_metadata_t newmeta;
286 //register metadata for memcpy avoidance
287 shared_data_key_type* data = (shared_data_key_type*)xbt_malloc(sizeof(shared_data_key_type));
288 data->second.fd = -1;
289 data->second.count = 1;
292 if(shared_block_offsets[0] > 0) {
293 newmeta.private_blocks.push_back(std::make_pair(0, shared_block_offsets[0]));
296 for(i_block = 0; i_block < nb_shared_blocks-1; i_block ++) {
297 newmeta.private_blocks.push_back(std::make_pair(shared_block_offsets[2*i_block+1], shared_block_offsets[2*i_block+2]));
299 if(shared_block_offsets[2*i_block+1] < size) {
300 newmeta.private_blocks.push_back(std::make_pair(shared_block_offsets[2*i_block+1], size));
302 allocs_metadata[mem] = newmeta;
308 * When nb_shared_blocks == -1, default behavior of smpi_shared_malloc: everything is shared.
309 * Otherwise, only the blocks described by shared_block_offsets are shared.
310 * This array contains the offsets (in bytes) of the block to share.
311 * Even indices are the start offsets (included), odd indices are the stop offsets (excluded).
312 * For instance, if shared_block_offsets == {27, 42}, then the elements mem[27], mem[28], ..., mem[41] are shared. The others are not.
314 static void *smpi_shared_malloc_global(size_t size, const char *file, int line, size_t *shared_block_offsets=NULL, int nb_shared_blocks=-1) {
315 size_t tmp_shared_block_offsets[2];
316 if(nb_shared_blocks == -1) {
317 nb_shared_blocks = 1;
318 shared_block_offsets = tmp_shared_block_offsets;
319 shared_block_offsets[0] = 0;
320 shared_block_offsets[1] = size;
322 return smpi_shared_malloc_partial(size, shared_block_offsets, nb_shared_blocks);
325 void *smpi_shared_malloc(size_t size, const char *file, int line) {
327 if (size > 0 && smpi_cfg_shared_malloc == shmalloc_local) {
328 mem = smpi_shared_malloc_local(size, file, line);
329 } else if (smpi_cfg_shared_malloc == shmalloc_global) {
330 mem = smpi_shared_malloc_global(size, file, line);
332 mem = xbt_malloc(size);
333 XBT_DEBUG("Classic malloc %zu in %p", size, mem);
338 int smpi_is_shared(void* ptr, std::vector<std::pair<size_t, size_t>> &private_blocks, size_t *offset){
339 private_blocks.clear(); // being paranoid
340 if (allocs_metadata.empty())
342 if ( smpi_cfg_shared_malloc == shmalloc_local || smpi_cfg_shared_malloc == shmalloc_global) {
343 auto low = allocs_metadata.lower_bound(ptr);
344 if (low->first==ptr) {
345 private_blocks = low->second.private_blocks;
349 if (low == allocs_metadata.begin())
352 if (ptr < (char*)low->first + low->second.size) {
353 xbt_assert(ptr > (char*)low->first, "Oops, there seems to be a bug in the shared memory metadata.");
354 *offset = ((uint8_t*)ptr) - ((uint8_t*) low->first);
355 private_blocks = low->second.private_blocks;
364 std::vector<std::pair<size_t, size_t>> shift_and_frame_private_blocks(const std::vector<std::pair<size_t, size_t>> vec, size_t offset, size_t buff_size) {
365 std::vector<std::pair<size_t, size_t>> result;
366 for(auto block: vec) {
367 auto new_block = std::make_pair(std::min(std::max((size_t)0, block.first-offset), buff_size),
368 std::min(std::max((size_t)0, block.second-offset), buff_size));
369 if(new_block.second > 0 && new_block.first < buff_size)
370 result.push_back(new_block);
375 std::vector<std::pair<size_t, size_t>> merge_private_blocks(std::vector<std::pair<size_t, size_t>> src, std::vector<std::pair<size_t, size_t>> dst) {
376 std::vector<std::pair<size_t, size_t>> result;
377 unsigned i_src=0, i_dst=0;
378 while(i_src < src.size() && i_dst < dst.size()) {
379 std::pair<size_t, size_t> block;
380 if(src[i_src].second <= dst[i_dst].first) {
383 else if(dst[i_dst].second <= src[i_src].first) {
386 else { // src.second > dst.first && dst.second > src.first → the blocks are overlapping
387 block = std::make_pair(std::max(src[i_src].first, dst[i_dst].first),
388 std::min(src[i_src].second, dst[i_dst].second));
389 result.push_back(block);
390 if(src[i_src].second < dst[i_dst].second)
399 void smpi_shared_free(void *ptr)
401 if (smpi_cfg_shared_malloc == shmalloc_local) {
402 char loc[PTR_STRLEN];
403 snprintf(loc, PTR_STRLEN, "%p", ptr);
404 auto meta = allocs_metadata.find(ptr);
405 if (meta == allocs_metadata.end()) {
406 XBT_WARN("Cannot free: %p was not shared-allocated by SMPI - maybe its size was 0?", ptr);
409 shared_data_t* data = &meta->second.data->second;
410 if (munmap(ptr, meta->second.size) < 0) {
411 XBT_WARN("Unmapping of fd %d failed: %s", data->fd, strerror(errno));
414 if (data->count <= 0) {
416 allocs.erase(allocs.find(meta->second.data->first));
417 allocs_metadata.erase(ptr);
418 XBT_DEBUG("Shared free - with removal - of %p", ptr);
420 XBT_DEBUG("Shared free - no removal - of %p, count = %d", ptr, data->count);
423 } else if (smpi_cfg_shared_malloc == shmalloc_global) {
424 auto meta = allocs_metadata.find(ptr);
425 if (meta != allocs_metadata.end()){
426 meta->second.data->second.count--;
427 if(meta->second.data->second.count==0)
428 xbt_free(meta->second.data);
431 munmap(ptr, meta->second.size);
433 XBT_DEBUG("Classic free of %p", ptr);
439 int smpi_shared_known_call(const char* func, const char* input)
441 char* loc = bprintf("%s:%s", func, input);
444 if (calls==nullptr) {
445 calls = xbt_dict_new_homogeneous(nullptr);
448 xbt_dict_get(calls, loc); /* Succeed or throw */
454 if (ex.category != not_found_error)
464 void* smpi_shared_get_call(const char* func, const char* input) {
465 char* loc = bprintf("%s:%s", func, input);
467 if (calls == nullptr)
468 calls = xbt_dict_new_homogeneous(nullptr);
469 void* data = xbt_dict_get(calls, loc);
474 void* smpi_shared_set_call(const char* func, const char* input, void* data) {
475 char* loc = bprintf("%s:%s", func, input);
477 if (calls == nullptr)
478 calls = xbt_dict_new_homogeneous(nullptr);
479 xbt_dict_set(calls, loc, data, nullptr);