Logo AND Algorithmique Numérique Distribuée

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