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