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