Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
1ba5158936ec6f563fa98d5999dd045522156d40
[simgrid.git] / src / smpi / internals / smpi_shared.cpp
1 /* Copyright (c) 2007-2019. 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 /* Shared allocations are handled through shared memory segments.
7  * Associated data and metadata are used as follows:
8  *
9  *                                                                    mmap #1
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  *                    --------------------    |   ^                           |
17  *                                            |   |                           |
18  *                                            |   |   `allocs_metadata' map   |
19  *                                            |   |   ----------------------  |
20  *                                            |   `-- | <addr of mmap #1>  |<-'
21  *                                            |   .-- | <addr of mmap #2>  |<-.
22  *                                            |   |   ----------------------  |
23  *                                            |   |                           |
24  *                                            |   |                           |
25  *                                            |   |                           |
26  *                                            |   |                   mmap #2 |
27  *                                            |   v                     ---- -'
28  *                                            |   shared_metadata_t   / |  |
29  *                                            |   -----------------   | |  |
30  *                                            |   | size of mmap  | --| |  |
31  *                                            `-- | data          |   | |  |
32  *                                                -----------------   | |  |
33  *                                                                    \ |  |
34  *                                                                      ----
35  */
36 #include <map>
37 #include <cstring>
38
39 #include "private.hpp"
40 #include "xbt/config.hpp"
41
42 #include <cerrno>
43
44 #include <sys/types.h>
45 #ifndef WIN32
46 #include <sys/mman.h>
47 #endif
48 #include <cstdio>
49 #include <fcntl.h>
50 #include <sys/stat.h>
51
52 #ifndef MAP_ANONYMOUS
53 #define MAP_ANONYMOUS MAP_ANON
54 #endif
55
56 #ifndef MAP_POPULATE
57 #define MAP_POPULATE 0
58 #endif
59
60 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_shared, smpi, "Logging specific to SMPI (shared memory macros)");
61
62 namespace{
63 /** Some location in the source code
64  *
65  *  This information is used by SMPI_SHARED_MALLOC to allocate  some shared memory for all simulated processes.
66  */
67
68 class smpi_source_location : public std::string {
69 public:
70   smpi_source_location() = default;
71   smpi_source_location(const char* filename, int line) : std::string(std::string(filename) + ":" + std::to_string(line))
72   {
73   }
74 };
75
76 struct shared_data_t {
77   int fd    = -1;
78   int count = 0;
79 };
80
81 std::unordered_map<smpi_source_location, shared_data_t, std::hash<std::string>> allocs;
82 typedef decltype(allocs)::value_type shared_data_key_type;
83
84 struct shared_metadata_t {
85   size_t size;
86   size_t allocated_size;
87   void *allocated_ptr;
88   std::vector<std::pair<size_t, size_t>> private_blocks;
89   shared_data_key_type* data;
90 };
91
92 std::map<const void*, shared_metadata_t> allocs_metadata;
93 std::map<std::string, void*> calls;
94
95 #ifndef WIN32
96 static int smpi_shared_malloc_bogusfile           = -1;
97 static int smpi_shared_malloc_bogusfile_huge_page  = -1;
98 static unsigned long smpi_shared_malloc_blocksize = 1UL << 20;
99 #endif
100 }
101
102
103 void smpi_shared_destroy()
104 {
105   allocs.clear();
106   allocs_metadata.clear();
107   calls.clear();
108 }
109
110 static size_t shm_size(int fd) {
111   struct stat st;
112
113   if(fstat(fd, &st) < 0) {
114     xbt_die("Could not stat fd %d: %s", fd, strerror(errno));
115   }
116   return static_cast<size_t>(st.st_size);
117 }
118
119 #ifndef WIN32
120 static void* shm_map(int fd, size_t size, shared_data_key_type* data) {
121   shared_metadata_t meta;
122
123   if(size > shm_size(fd) && (ftruncate(fd, static_cast<off_t>(size)) < 0)) {
124     xbt_die("Could not truncate fd %d to %zu: %s", fd, size, strerror(errno));
125   }
126
127   void* mem = mmap(nullptr, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
128   if(mem == MAP_FAILED) {
129     xbt_die("Failed to map fd %d with size %zu: %s\n"
130             "If you are running a lot of ranks, you may be exceeding the amount of mappings allowed per process.\n"
131             "On Linux systems, change this value with sudo sysctl -w vm.max_map_count=newvalue (default value: 65536)\n"
132             "Please see "
133             "https://simgrid.org/doc/latest/Configuring_SimGrid.html#configuring-the-user-code-virtualization for more "
134             "information.",
135             fd, size, strerror(errno));
136   }
137   meta.size = size;
138   meta.data = data;
139   meta.allocated_ptr   = mem;
140   meta.allocated_size  = size;
141   allocs_metadata[mem] = meta;
142   XBT_DEBUG("MMAP %zu to %p", size, mem);
143   return mem;
144 }
145
146 static void *smpi_shared_malloc_local(size_t size, const char *file, int line)
147 {
148   void* mem;
149   smpi_source_location loc(file, line);
150   auto res = allocs.insert(std::make_pair(loc, shared_data_t()));
151   auto data = res.first;
152   if (res.second) {
153     // The new element was inserted.
154     // Generate a shared memory name from the address of the shared_data:
155     char shmname[32]; // cannot be longer than PSHMNAMLEN = 31 on macOS (shm_open raises ENAMETOOLONG otherwise)
156     snprintf(shmname, 31, "/shmalloc%p", &*data);
157     int fd = shm_open(shmname, O_RDWR | O_CREAT | O_EXCL, S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
158     if (fd < 0) {
159       if (errno == EEXIST)
160         xbt_die("Please cleanup /dev/shm/%s", shmname);
161       else
162         xbt_die("An unhandled error occurred while opening %s. shm_open: %s", shmname, strerror(errno));
163     }
164     data->second.fd = fd;
165     data->second.count = 1;
166     mem = shm_map(fd, size, &*data);
167     if (shm_unlink(shmname) < 0) {
168       XBT_WARN("Could not early unlink %s. shm_unlink: %s", shmname, strerror(errno));
169     }
170     XBT_DEBUG("Mapping %s at %p through %d", shmname, mem, fd);
171   } else {
172     mem = shm_map(data->second.fd, size, &*data);
173     data->second.count++;
174   }
175   XBT_DEBUG("Shared malloc %zu in %p (metadata at %p)", size, mem, &*data);
176   return mem;
177 }
178
179 // Align functions, from http://stackoverflow.com/questions/4840410/how-to-align-a-pointer-in-c
180 #define ALIGN_UP(n, align) (((n) + (align)-1) & -(align))
181 #define ALIGN_DOWN(n, align) ((n) & -(align))
182
183 constexpr unsigned PAGE_SIZE      = 0x1000;
184 constexpr unsigned HUGE_PAGE_SIZE = 1U << 21;
185
186 /* Similar to smpi_shared_malloc, but only sharing the blocks described by shared_block_offsets.
187  * This array contains the offsets (in bytes) of the block to share.
188  * Even indices are the start offsets (included), odd indices are the stop offsets (excluded).
189  * For instance, if shared_block_offsets == {27, 42}, then the elements mem[27], mem[28], ..., mem[41] are shared.
190  * The others are not.
191  */
192
193 void* smpi_shared_malloc_partial(size_t size, size_t* shared_block_offsets, int nb_shared_blocks)
194 {
195   std::string huge_page_mount_point = simgrid::config::get_value<std::string>("smpi/shared-malloc-hugepage");
196   bool use_huge_page                = not huge_page_mount_point.empty();
197 #ifndef MAP_HUGETLB /* If the system header don't define that mmap flag */
198   xbt_assert(not use_huge_page,
199              "Huge pages are not available on your system, you cannot use the smpi/shared-malloc-hugepage option.");
200 #endif
201   smpi_shared_malloc_blocksize =
202       static_cast<unsigned long>(simgrid::config::get_value<double>("smpi/shared-malloc-blocksize"));
203   void* mem;
204   size_t allocated_size;
205   if(use_huge_page) {
206     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.");
207     allocated_size = size + 2*smpi_shared_malloc_blocksize;
208   }
209   else {
210     xbt_assert(smpi_shared_malloc_blocksize % PAGE_SIZE == 0, "the block size of shared malloc should be a multiple of the page size.");
211     allocated_size = size;
212   }
213
214
215   /* First reserve memory area */
216   void* allocated_ptr = mmap(NULL, allocated_size, PROT_READ | PROT_WRITE, MAP_ANONYMOUS | MAP_PRIVATE, -1, 0);
217
218   xbt_assert(allocated_ptr != MAP_FAILED, "Failed to allocate %zuMiB of memory. Run \"sysctl vm.overcommit_memory=1\" as root "
219                                 "to allow big allocations.\n",
220              size >> 20);
221   if(use_huge_page)
222     mem = (void*)ALIGN_UP((int64_t)allocated_ptr, HUGE_PAGE_SIZE);
223   else
224     mem = allocated_ptr;
225
226   XBT_DEBUG("global shared allocation. Blocksize %lu", smpi_shared_malloc_blocksize);
227   /* Create a fd to a new file on disk, make it smpi_shared_malloc_blocksize big, and unlink it.
228    * It still exists in memory but not in the file system (thus it cannot be leaked). */
229   /* Create bogus file if not done already
230    * We need two different bogusfiles:
231    *    smpi_shared_malloc_bogusfile_huge_page is used for calls to mmap *with* MAP_HUGETLB,
232    *    smpi_shared_malloc_bogusfile is used for calls to mmap *without* MAP_HUGETLB.
233    * We cannot use a same file for the two type of calls, since the first one needs to be
234    * opened in a hugetlbfs mount point whereas the second needs to be a "classical" file. */
235   if(use_huge_page && smpi_shared_malloc_bogusfile_huge_page == -1) {
236     std::string huge_page_filename         = huge_page_mount_point + "/simgrid-shmalloc-XXXXXX";
237     smpi_shared_malloc_bogusfile_huge_page = mkstemp((char*)huge_page_filename.c_str());
238     XBT_DEBUG("bogusfile_huge_page: %s\n", huge_page_filename.c_str());
239     unlink(huge_page_filename.c_str());
240   }
241   if(smpi_shared_malloc_bogusfile == -1) {
242     char name[]                  = "/tmp/simgrid-shmalloc-XXXXXX";
243     smpi_shared_malloc_bogusfile = mkstemp(name);
244     XBT_DEBUG("bogusfile         : %s\n", name);
245     unlink(name);
246     char* dumb  = new char[smpi_shared_malloc_blocksize](); // zero initialized
247     ssize_t err = write(smpi_shared_malloc_bogusfile, dumb, smpi_shared_malloc_blocksize);
248     if(err<0)
249       xbt_die("Could not write bogus file for shared malloc");
250     delete[] dumb;
251   }
252
253   int mmap_base_flag = MAP_FIXED | MAP_SHARED | MAP_POPULATE;
254   int mmap_flag = mmap_base_flag;
255   int huge_fd = use_huge_page ? smpi_shared_malloc_bogusfile_huge_page : smpi_shared_malloc_bogusfile;
256 #ifdef MAP_HUGETLB
257   if(use_huge_page)
258     mmap_flag |= MAP_HUGETLB;
259 #endif
260
261   XBT_DEBUG("global shared allocation, begin mmap");
262
263   /* Map the bogus file in place of the anonymous memory */
264   for(int i_block = 0; i_block < nb_shared_blocks; i_block ++) {
265     XBT_DEBUG("\tglobal shared allocation, mmap block %d/%d", i_block+1, nb_shared_blocks);
266     size_t start_offset = shared_block_offsets[2*i_block];
267     size_t stop_offset = shared_block_offsets[2*i_block+1];
268     xbt_assert(start_offset < stop_offset, "start_offset (%zu) should be lower than stop offset (%zu)", start_offset, stop_offset);
269     xbt_assert(stop_offset <= size,         "stop_offset (%zu) should be lower than size (%zu)", stop_offset, size);
270     if(i_block < nb_shared_blocks-1)
271       xbt_assert(stop_offset < shared_block_offsets[2*i_block+2],
272               "stop_offset (%zu) should be lower than its successor start offset (%zu)", stop_offset, shared_block_offsets[2*i_block+2]);
273     size_t start_block_offset = ALIGN_UP((int64_t)start_offset, smpi_shared_malloc_blocksize);
274     size_t stop_block_offset = ALIGN_DOWN((int64_t)stop_offset, smpi_shared_malloc_blocksize);
275     for (size_t offset = start_block_offset; offset < stop_block_offset; offset += smpi_shared_malloc_blocksize) {
276       XBT_DEBUG("\t\tglobal shared allocation, mmap block offset %zx", offset);
277       void* pos = (void*)((unsigned long)mem + offset);
278       void* res = mmap(pos, smpi_shared_malloc_blocksize, PROT_READ | PROT_WRITE, mmap_flag,
279                        huge_fd, 0);
280       xbt_assert(res == pos, "Could not map folded virtual memory (%s). Do you perhaps need to increase the "
281                              "size of the mapped file using --cfg=smpi/shared-malloc-blocksize:newvalue (default 1048576) ? "
282                              "You can also try using  the sysctl vm.max_map_count. "
283                              "If you are using huge pages, check that you have at least one huge page (/proc/sys/vm/nr_hugepages) "
284                              "and that the directory you are passing is mounted correctly (mount /path/to/huge -t hugetlbfs -o rw,mode=0777).",
285                  strerror(errno));
286     }
287     size_t low_page_start_offset = ALIGN_UP((int64_t)start_offset, PAGE_SIZE);
288     size_t low_page_stop_offset = (int64_t)start_block_offset < ALIGN_DOWN((int64_t)stop_offset, PAGE_SIZE) ? start_block_offset : ALIGN_DOWN((int64_t)stop_offset, (int64_t)PAGE_SIZE);
289     if(low_page_start_offset < low_page_stop_offset) {
290       XBT_DEBUG("\t\tglobal shared allocation, mmap block start");
291       void* pos = (void*)((unsigned long)mem + low_page_start_offset);
292       void* res = mmap(pos, low_page_stop_offset-low_page_start_offset, PROT_READ | PROT_WRITE, mmap_base_flag, // not a full huge page
293                        smpi_shared_malloc_bogusfile, 0);
294       xbt_assert(res == pos, "Could not map folded virtual memory (%s). Do you perhaps need to increase the "
295                              "size of the mapped file using --cfg=smpi/shared-malloc-blocksize:newvalue (default 1048576) ?"
296                              "You can also try using  the sysctl vm.max_map_count",
297                  strerror(errno));
298     }
299     if(low_page_stop_offset <= stop_block_offset) {
300       XBT_DEBUG("\t\tglobal shared allocation, mmap block stop");
301       size_t high_page_stop_offset = stop_offset == size ? size : ALIGN_DOWN((int64_t)stop_offset, PAGE_SIZE);
302       if(high_page_stop_offset > stop_block_offset) {
303         void* pos = (void*)((unsigned long)mem + stop_block_offset);
304         void* res = mmap(pos, high_page_stop_offset-stop_block_offset, PROT_READ | PROT_WRITE, mmap_base_flag, // not a full huge page
305                          smpi_shared_malloc_bogusfile, 0);
306         xbt_assert(res == pos, "Could not map folded virtual memory (%s). Do you perhaps need to increase the "
307                                "size of the mapped file using --cfg=smpi/shared-malloc-blocksize:newvalue (default 1048576) ?"
308                                "You can also try using  the sysctl vm.max_map_count",
309                    strerror(errno));
310       }
311     }
312   }
313
314   shared_metadata_t newmeta;
315   //register metadata for memcpy avoidance
316   shared_data_key_type* data = new shared_data_key_type;
317   data->second.fd = -1;
318   data->second.count = 1;
319   newmeta.size = size;
320   newmeta.data = data;
321   newmeta.allocated_ptr = allocated_ptr;
322   newmeta.allocated_size = allocated_size;
323   if(shared_block_offsets[0] > 0) {
324     newmeta.private_blocks.push_back(std::make_pair(0, shared_block_offsets[0]));
325   }
326   int i_block;
327   for(i_block = 0; i_block < nb_shared_blocks-1; i_block ++) {
328     newmeta.private_blocks.push_back(std::make_pair(shared_block_offsets[2*i_block+1], shared_block_offsets[2*i_block+2]));
329   }
330   if(shared_block_offsets[2*i_block+1] < size) {
331     newmeta.private_blocks.push_back(std::make_pair(shared_block_offsets[2*i_block+1], size));
332   }
333   allocs_metadata[mem] = newmeta;
334
335   XBT_DEBUG("global shared allocation, allocated_ptr %p - %p", allocated_ptr, (void*)(((uint64_t)allocated_ptr)+allocated_size));
336   XBT_DEBUG("global shared allocation, returned_ptr  %p - %p", mem, (void*)(((uint64_t)mem)+size));
337
338   return mem;
339 }
340
341
342 void *smpi_shared_malloc_intercept(size_t size, const char *file, int line) {
343   if( smpi_cfg_auto_shared_malloc_thresh() == 0 || size < smpi_cfg_auto_shared_malloc_thresh())
344     return ::operator new(size);
345   else
346     return smpi_shared_malloc(size, file, line);
347 }
348
349 void* smpi_shared_calloc_intercept(size_t num_elm, size_t elem_size, const char* file, int line){
350   if( smpi_cfg_auto_shared_malloc_thresh() == 0 || elem_size*num_elm < smpi_cfg_auto_shared_malloc_thresh()){
351     void* ptr = ::operator new(elem_size*num_elm);
352     memset(ptr, 0, elem_size*num_elm);
353     return ptr;
354   } else
355     return smpi_shared_malloc(elem_size*num_elm, file, line);
356
357 }
358
359 void *smpi_shared_malloc(size_t size, const char *file, int line) {
360   if (size > 0 && smpi_cfg_shared_malloc() == SharedMallocType::LOCAL) {
361     return smpi_shared_malloc_local(size, file, line);
362   } else if (smpi_cfg_shared_malloc() == SharedMallocType::GLOBAL) {
363     int nb_shared_blocks = 1;
364     size_t shared_block_offsets[2] = {0, size};
365     return smpi_shared_malloc_partial(size, shared_block_offsets, nb_shared_blocks);
366   }
367   XBT_DEBUG("Classic allocation of %zu bytes", size);
368   return ::operator new(size);
369 }
370
371 int smpi_is_shared(const void* ptr, std::vector<std::pair<size_t, size_t>> &private_blocks, size_t *offset){
372   private_blocks.clear(); // being paranoid
373   if (allocs_metadata.empty())
374     return 0;
375   if (smpi_cfg_shared_malloc() == SharedMallocType::LOCAL || smpi_cfg_shared_malloc() == SharedMallocType::GLOBAL) {
376     auto low = allocs_metadata.lower_bound(ptr);
377     if (low != allocs_metadata.end() && low->first == ptr) {
378       private_blocks = low->second.private_blocks;
379       *offset = 0;
380       return 1;
381     }
382     if (low == allocs_metadata.begin())
383       return 0;
384     low --;
385     if (ptr < (char*)low->first + low->second.size) {
386       xbt_assert(ptr > (char*)low->first, "Oops, there seems to be a bug in the shared memory metadata.");
387       *offset = ((uint8_t*)ptr) - ((uint8_t*) low->first);
388       private_blocks = low->second.private_blocks;
389       return 1;
390     }
391     return 0;
392   } else {
393     return 0;
394   }
395 }
396
397 std::vector<std::pair<size_t, size_t>> shift_and_frame_private_blocks(const std::vector<std::pair<size_t, size_t>>& vec,
398                                                                       size_t offset, size_t buff_size)
399 {
400   std::vector<std::pair<size_t, size_t>> result;
401   for (auto const& block : vec) {
402     auto new_block = std::make_pair(std::min(std::max((size_t)0, block.first - offset), buff_size),
403                                     std::min(std::max((size_t)0, block.second - offset), buff_size));
404     if (new_block.second > 0 && new_block.first < buff_size)
405       result.push_back(new_block);
406   }
407   return result;
408 }
409
410 std::vector<std::pair<size_t, size_t>> merge_private_blocks(const std::vector<std::pair<size_t, size_t>>& src,
411                                                             const std::vector<std::pair<size_t, size_t>>& dst)
412 {
413   std::vector<std::pair<size_t, size_t>> result;
414   unsigned i_src = 0;
415   unsigned i_dst = 0;
416   while(i_src < src.size() && i_dst < dst.size()) {
417     std::pair<size_t, size_t> block;
418     if(src[i_src].second <= dst[i_dst].first) {
419         i_src++;
420     }
421     else if(dst[i_dst].second <= src[i_src].first) {
422         i_dst++;
423     }
424     else { // src.second > dst.first && dst.second > src.first → the blocks are overlapping
425       block = std::make_pair(std::max(src[i_src].first, dst[i_dst].first),
426                              std::min(src[i_src].second, dst[i_dst].second));
427       result.push_back(block);
428       if(src[i_src].second < dst[i_dst].second)
429           i_src ++;
430       else
431           i_dst ++;
432     }
433   }
434   return result;
435 }
436
437 void smpi_shared_free(void *ptr)
438 {
439   if (smpi_cfg_shared_malloc() == SharedMallocType::LOCAL) {
440     auto meta = allocs_metadata.find(ptr);
441     if (meta == allocs_metadata.end()) {
442       ::operator delete(ptr);
443       return;
444     }
445     shared_data_t* data = &meta->second.data->second;
446     if (munmap(meta->second.allocated_ptr, meta->second.allocated_size) < 0) {
447       XBT_WARN("Unmapping of fd %d failed: %s", data->fd, strerror(errno));
448     }
449     data->count--;
450     if (data->count <= 0) {
451       close(data->fd);
452       allocs.erase(allocs.find(meta->second.data->first));
453       allocs_metadata.erase(ptr);
454       XBT_DEBUG("Shared free - Local - with removal - of %p", ptr);
455     } else {
456       XBT_DEBUG("Shared free - Local - no removal - of %p, count = %d", ptr, data->count);
457     }
458
459   } else if (smpi_cfg_shared_malloc() == SharedMallocType::GLOBAL) {
460     auto meta = allocs_metadata.find(ptr);
461     if (meta != allocs_metadata.end()){
462       meta->second.data->second.count--;
463       XBT_DEBUG("Shared free - Global - of %p", ptr);
464       munmap(ptr, meta->second.size);
465       if(meta->second.data->second.count==0){
466         delete meta->second.data;
467         allocs_metadata.erase(ptr);
468       }
469     }else{
470       ::operator delete(ptr);
471       return;
472     }
473
474   } else {
475     XBT_DEBUG("Classic deallocation of %p", ptr);
476     ::operator delete(ptr);
477   }
478 }
479 #endif
480
481 int smpi_shared_known_call(const char* func, const char* input)
482 {
483   std::string loc = std::string(func) + ":" + input;
484   return calls.find(loc) != calls.end();
485 }
486
487 void* smpi_shared_get_call(const char* func, const char* input) {
488   std::string loc = std::string(func) + ":" + input;
489
490   return calls.at(loc);
491 }
492
493 void* smpi_shared_set_call(const char* func, const char* input, void* data) {
494   std::string loc = std::string(func) + ":" + input;
495   calls[loc]      = data;
496   return data;
497 }