src/smpi/internals/smpi_shared.cpp

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