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