Logo AND Algorithmique Numérique Distribuée

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