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 <unordered_map>
  37
  38 #include "private.h"
  39 #include "private.hpp"
  40 #include "xbt/dict.h"
  41
  42 #include <sys/types.h>
  43 #ifndef WIN32
  44 #include <sys/mman.h>
  45 #endif
  46 #include <sys/stat.h>
  47 #include <fcntl.h>
  48 #include <string.h>
  49 #include <stdio.h>
  50
  51 #ifndef MAP_ANONYMOUS
  52 #define MAP_ANONYMOUS MAP_ANON
  53 #endif
  54
  55 #ifndef MAP_POPULATE
  56 #define MAP_POPULATE 0
  57 #endif
  58
  59 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_shared, smpi, "Logging specific to SMPI (shared memory macros)");
  60
  61 #define PTR_STRLEN (2 + 2 * sizeof(void*) + 1)
  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 {
  70 public:
  71   smpi_source_location(const char* filename, int line)
  72       : filename(xbt_strdup(filename)), filename_length(strlen(filename)), line(line)
  73   {
  74   }
  75
  76   /** Pointer to a static string containing the file name */
  77   char* filename      = nullptr;
  78   int filename_length = 0;
  79   int line            = 0;
  80
  81   bool operator==(smpi_source_location const& that) const
  82   {
  83     return filename_length == that.filename_length && line == that.line &&
  84            std::memcmp(filename, that.filename, filename_length) == 0;
  85   }
  86   bool operator!=(smpi_source_location const& that) const { return !(*this == that); }
  87 };
  88 }
  89
  90 namespace std {
  91
  92 template <> class hash<smpi_source_location> {
  93 public:
  94   typedef smpi_source_location argument_type;
  95   typedef std::size_t result_type;
  96   result_type operator()(smpi_source_location const& loc) const
  97   {
  98     return xbt_str_hash_ext(loc.filename, loc.filename_length) ^
  99            xbt_str_hash_ext((const char*)&loc.line, sizeof(loc.line));
 100   }
 101 };
 102 }
 103
 104 namespace{
 105
 106 typedef struct {
 107   int fd    = -1;
 108   int count = 0;
 109 } shared_data_t;
 110
 111 std::unordered_map<smpi_source_location, shared_data_t> allocs;
 112 typedef std::unordered_map<smpi_source_location, shared_data_t>::value_type shared_data_key_type;
 113
 114 typedef struct {
 115   size_t size;
 116   shared_data_key_type* data;
 117 } shared_metadata_t;
 118
 119 std::unordered_map<void*, shared_metadata_t> allocs_metadata;
 120 xbt_dict_t calls = nullptr;           /* Allocated on first use */
 121 #ifndef WIN32
 122 static int smpi_shared_malloc_bogusfile           = -1;
 123 static unsigned long smpi_shared_malloc_blocksize = 1UL << 20;
 124 #endif
 125 }
 126
 127
 128 void smpi_shared_destroy()
 129 {
 130   allocs.clear();
 131   allocs_metadata.clear();
 132   xbt_dict_free(&calls);
 133 }
 134
 135 static size_t shm_size(int fd) {
 136   struct stat st;
 137
 138   if(fstat(fd, &st) < 0) {
 139     xbt_die("Could not stat fd %d: %s", fd, strerror(errno));
 140   }
 141   return static_cast<size_t>(st.st_size);
 142 }
 143
 144 #ifndef WIN32
 145 static void* shm_map(int fd, size_t size, shared_data_key_type* data) {
 146   char loc[PTR_STRLEN];
 147   shared_metadata_t meta;
 148
 149   if(size > shm_size(fd) && (ftruncate(fd, static_cast<off_t>(size)) < 0)) {
 150     xbt_die("Could not truncate fd %d to %zu: %s", fd, size, strerror(errno));
 151   }
 152
 153   void* mem = mmap(nullptr, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
 154   if(mem == MAP_FAILED) {
 155     xbt_die(
 156         "Failed to map fd %d with size %zu: %s\n"
 157         "If you are running a lot of ranks, you may be exceeding the amount of mappings allowed per process.\n"
 158         "On Linux systems, change this value with sudo sysctl -w vm.max_map_count=newvalue (default value: 65536)\n"
 159         "Please see http://simgrid.gforge.inria.fr/simgrid/latest/doc/html/options.html#options_virt for more info.",
 160         fd, size, strerror(errno));
 161   }
 162   snprintf(loc, PTR_STRLEN, "%p", mem);
 163   meta.size = size;
 164   meta.data = data;
 165   allocs_metadata[mem] = meta;
 166   XBT_DEBUG("MMAP %zu to %p", size, mem);
 167   return mem;
 168 }
 169
 170 void *smpi_shared_malloc(size_t size, const char *file, int line)
 171 {
 172   void* mem;
 173   if (size > 0 && smpi_cfg_shared_malloc == shmalloc_local) {
 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
 202   } else if (smpi_cfg_shared_malloc == shmalloc_global) {
 203     /* First reserve memory area */
 204     mem = mmap(NULL, size, PROT_READ | PROT_WRITE, MAP_ANONYMOUS | MAP_PRIVATE, -1, 0);
 205
 206     xbt_assert(mem != MAP_FAILED, "Failed to allocate %luMiB of memory. Run \"sysctl vm.overcommit_memory=1\" as root "
 207                                   "to allow big allocations.\n",
 208                (unsigned long)(size >> 20));
 209
 210     /* Create bogus file if not done already */
 211     if (smpi_shared_malloc_bogusfile == -1) {
 212       /* Create a fd to a new file on disk, make it smpi_shared_malloc_blocksize big, and unlink it.
 213        * It still exists in memory but not in the file system (thus it cannot be leaked). */
 214       char* name                   = xbt_strdup("/tmp/simgrid-shmalloc-XXXXXX");
 215       smpi_shared_malloc_bogusfile = mkstemp(name);
 216       unlink(name);
 217       xbt_free(name);
 218       char* dumb = (char*)calloc(1, smpi_shared_malloc_blocksize);
 219       ssize_t err = write(smpi_shared_malloc_bogusfile, dumb, smpi_shared_malloc_blocksize);
 220       if(err<0)
 221         xbt_die("Could not write bogus file for shared malloc");
 222       xbt_free(dumb);
 223     }
 224
 225     /* Map the bogus file in place of the anonymous memory */
 226     unsigned int i;
 227     for (i = 0; i < size / smpi_shared_malloc_blocksize; i++) {
 228       void* pos = (void*)((unsigned long)mem + i * smpi_shared_malloc_blocksize);
 229       void* res = mmap(pos, smpi_shared_malloc_blocksize, PROT_READ | PROT_WRITE, MAP_FIXED | MAP_SHARED | MAP_POPULATE,
 230                        smpi_shared_malloc_bogusfile, 0);
 231       xbt_assert(res == pos, "Could not map folded virtual memory (%s). Do you perhaps need to increase the "
 232                              "STARPU_MALLOC_SIMULATION_FOLD environment variable or the sysctl vm.max_map_count?",
 233                  strerror(errno));
 234     }
 235     if (size % smpi_shared_malloc_blocksize) {
 236       void* pos = (void*)((unsigned long)mem + i * smpi_shared_malloc_blocksize);
 237       void* res = mmap(pos, size % smpi_shared_malloc_blocksize, PROT_READ | PROT_WRITE,
 238                        MAP_FIXED | MAP_SHARED | MAP_POPULATE, smpi_shared_malloc_bogusfile, 0);
 239       xbt_assert(res == pos, "Could not map folded virtual memory (%s). Do you perhaps need to increase the "
 240                              "STARPU_MALLOC_SIMULATION_FOLD environment variable or the sysctl vm.max_map_count?",
 241                  strerror(errno));
 242     }
 243
 244     shared_metadata_t newmeta;
 245     //register metadata for memcpy avoidance
 246     shared_data_key_type* data = (shared_data_key_type*)xbt_malloc(sizeof(shared_data_key_type));
 247     data->second.fd = -1;
 248     data->second.count = 1;
 249     newmeta.size = size;
 250     newmeta.data = data;
 251     allocs_metadata[mem] = newmeta;
 252   } else {
 253     mem = xbt_malloc(size);
 254     XBT_DEBUG("Classic malloc %zu in %p", size, mem);
 255   }
 256
 257   return mem;
 258 }
 259
 260 int smpi_is_shared(void*ptr){
 261   if ( smpi_cfg_shared_malloc == shmalloc_local || smpi_cfg_shared_malloc == shmalloc_global) {
 262     if (allocs_metadata.count(ptr) != 0)
 263      return 1;
 264     for(auto it : allocs_metadata){
 265       if (ptr >= it.first && ptr < (char*)it.first + it.second.size)
 266         return 1;
 267     }
 268       return 0;
 269   } else {
 270     return 0;
 271   }
 272 }
 273
 274 void smpi_shared_free(void *ptr)
 275 {
 276   if (smpi_cfg_shared_malloc == shmalloc_local) {
 277     char loc[PTR_STRLEN];
 278     snprintf(loc, PTR_STRLEN, "%p", ptr);
 279     auto meta = allocs_metadata.find(ptr);
 280     if (meta == allocs_metadata.end()) {
 281       XBT_WARN("Cannot free: %p was not shared-allocated by SMPI - maybe its size was 0?", ptr);
 282       return;
 283     }
 284     shared_data_t* data = &meta->second.data->second;
 285     if (munmap(ptr, meta->second.size) < 0) {
 286       XBT_WARN("Unmapping of fd %d failed: %s", data->fd, strerror(errno));
 287     }
 288     data->count--;
 289     if (data->count <= 0) {
 290       close(data->fd);
 291       allocs.erase(allocs.find(meta->second.data->first));
 292       allocs_metadata.erase(ptr);
 293       XBT_DEBUG("Shared free - with removal - of %p", ptr);
 294     } else {
 295       XBT_DEBUG("Shared free - no removal - of %p, count = %d", ptr, data->count);
 296     }
 297
 298   } else if (smpi_cfg_shared_malloc == shmalloc_global) {
 299     auto meta = allocs_metadata.find(ptr);
 300     if (meta != allocs_metadata.end()){
 301       meta->second.data->second.count--;
 302       if(meta->second.data->second.count==0)
 303         xbt_free(meta->second.data);
 304     }
 305
 306     munmap(ptr, 0); // the POSIX says that I should not give 0 as a length, but it seems to work OK
 307   } else {
 308     XBT_DEBUG("Classic free of %p", ptr);
 309     xbt_free(ptr);
 310   }
 311 }
 312 #endif
 313
 314 int smpi_shared_known_call(const char* func, const char* input)
 315 {
 316   char* loc = bprintf("%s:%s", func, input);
 317   int known = 0;
 318
 319   if (calls==nullptr) {
 320     calls = xbt_dict_new_homogeneous(nullptr);
 321   }
 322   try {
 323     xbt_dict_get(calls, loc); /* Succeed or throw */
 324     known = 1;
 325     xbt_free(loc);
 326   }
 327   catch (xbt_ex& ex) {
 328     xbt_free(loc);
 329     if (ex.category != not_found_error)
 330       throw;
 331   }
 332   catch(...) {
 333     xbt_free(loc);
 334     throw;
 335   }
 336   return known;
 337 }
 338
 339 void* smpi_shared_get_call(const char* func, const char* input) {
 340   char* loc = bprintf("%s:%s", func, input);
 341
 342   if (calls == nullptr)
 343     calls    = xbt_dict_new_homogeneous(nullptr);
 344   void* data = xbt_dict_get(calls, loc);
 345   xbt_free(loc);
 346   return data;
 347 }
 348
 349 void* smpi_shared_set_call(const char* func, const char* input, void* data) {
 350   char* loc = bprintf("%s:%s", func, input);
 351
 352   if (calls == nullptr)
 353     calls = xbt_dict_new_homogeneous(nullptr);
 354   xbt_dict_set(calls, loc, data, nullptr);
 355   xbt_free(loc);
 356   return data;
 357 }
 358