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