src/smpi/internals/smpi_shared.cpp

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