src/smpi/internals/smpi_memory.cpp

   1 /* Copyright (c) 2015-2018. 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 #include <cerrno>
   7 #include <climits>
   8 #include <cstdint>
   9 #include <cstdio>
  10 #include <cstdlib>
  11 #include <cstring>
  12 #include <deque>
  13 #include <fcntl.h>
  14 #include <sys/stat.h>
  15 #include <sys/types.h>
  16 #include <vector>
  17
  18 #ifndef WIN32
  19 #include <sys/mman.h>
  20 #include <unistd.h>
  21
  22 #include "src/internal_config.h"
  23 #include "src/xbt/memory_map.hpp"
  24
  25 #include "private.hpp"
  26 #include "smpi_process.hpp"
  27
  28 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_memory, smpi, "Memory layout support for SMPI");
  29
  30 int smpi_loaded_page      = -1;
  31 char* smpi_data_exe_start = nullptr;
  32 int smpi_data_exe_size    = 0;
  33 SmpiPrivStrategies smpi_privatize_global_variables;
  34 static void* smpi_data_exe_copy;
  35
  36 // We keep a copy of all the privatization regions: We can then delete everything easily by iterating over this
  37 // collection and nothing can be leaked. We could also iterate over all actors but we would have to be diligent when two
  38 // actors use the same privatization region (so, smart pointers would have to be used etc.)
  39 // Use a std::deque so that pointers remain valid after push_back().
  40 static std::deque<s_smpi_privatization_region_t> smpi_privatization_regions;
  41
  42 static const int PROT_RWX = (PROT_READ | PROT_WRITE | PROT_EXEC);
  43 static const int PROT_RW  = (PROT_READ | PROT_WRITE );
  44 XBT_ATTRIB_UNUSED static const int PROT_RX  = (PROT_READ | PROT_EXEC );
  45
  46 void smpi_get_executable_global_size()
  47 {
  48   char buffer[PATH_MAX];
  49   char* full_name = realpath(xbt_binary_name, buffer);
  50   if (full_name == nullptr)
  51     xbt_die("Could not resolve binary file name");
  52
  53   std::vector<simgrid::xbt::VmMap> map = simgrid::xbt::get_memory_map(getpid());
  54   for (auto i = map.begin(); i != map.end() ; ++i) {
  55     // TODO, In practice, this implementation would not detect a completely
  56     // anonymous data segment. This does not happen in practice, however.
  57
  58     // File backed RW entry:
  59     if (i->pathname == full_name && (i->prot & PROT_RWX) == PROT_RW) {
  60       smpi_data_exe_start = (char*)i->start_addr;
  61       smpi_data_exe_size  = i->end_addr - i->start_addr;
  62       ++i;
  63       /* Here we are making the assumption that a suitable empty region
  64          following the rw- area is the end of the data segment. It would
  65          be better to check with the size of the data segment. */
  66       if (i != map.end() && i->pathname.empty() && (i->prot & PROT_RWX) == PROT_RW &&
  67           (char*)i->start_addr == smpi_data_exe_start + smpi_data_exe_size) {
  68         smpi_data_exe_size = (char*)i->end_addr - smpi_data_exe_start;
  69       }
  70       return;
  71     }
  72   }
  73   xbt_die("Did not find my data segment.");
  74 }
  75 #endif
  76
  77 #if HAVE_SANITIZE_ADDRESS
  78 #include <sanitizer/asan_interface.h>
  79 static void* asan_safe_memcpy(void* dest, void* src, size_t n)
  80 {
  81   char* psrc  = static_cast<char*>(src);
  82   char* pdest = static_cast<char*>(dest);
  83   for (size_t i = 0; i < n;) {
  84     while (i < n && __asan_address_is_poisoned(psrc + i))
  85       ++i;
  86     if (i < n) {
  87       char* p  = static_cast<char*>(__asan_region_is_poisoned(psrc + i, n - i));
  88       size_t j = p ? (p - psrc) : n;
  89       memcpy(pdest + i, psrc + i, j - i);
  90       i = j;
  91     }
  92   }
  93   return dest;
  94 }
  95 #else
  96 #define asan_safe_memcpy(dest, src, n) memcpy(dest, src, n)
  97 #endif
  98
  99 /** Map a given SMPI privatization segment (make a SMPI process active) */
 100 void smpi_switch_data_segment(simgrid::s4u::ActorPtr actor)
 101 {
 102   if (smpi_loaded_page == actor->getPid()) // no need to switch, we've already loaded the one we want
 103     return;
 104
 105   // So the job:
 106   smpi_really_switch_data_segment(actor);
 107 }
 108
 109 /** Map a given SMPI privatization segment (make a SMPI process active)  even if SMPI thinks it is already active
 110  *
 111  *  When doing a state restoration, the state of the restored variables  might not be consistent with the state of the
 112  *  virtual memory. In this case, we to change the data segment.
 113  */
 114 void smpi_really_switch_data_segment(simgrid::s4u::ActorPtr actor)
 115 {
 116   if (smpi_data_exe_size == 0) // no need to switch
 117     return;
 118
 119 #if HAVE_PRIVATIZATION
 120   // FIXME, cross-process support (mmap across process when necessary)
 121   XBT_DEBUG("Switching data frame to the one of process %ld", actor->getPid());
 122   simgrid::smpi::Process* process = smpi_process_remote(actor);
 123   int current                     = process->privatized_region()->file_descriptor;
 124   void* tmp =
 125       mmap(TOPAGE(smpi_data_exe_start), smpi_data_exe_size, PROT_READ | PROT_WRITE, MAP_FIXED | MAP_SHARED, current, 0);
 126   if (tmp != TOPAGE(smpi_data_exe_start))
 127     xbt_die("Couldn't map the new region (errno %d): %s", errno, strerror(errno));
 128   smpi_loaded_page = actor->getPid();
 129 #endif
 130 }
 131
 132 int smpi_is_privatization_file(char* file)
 133 {
 134   const std::string buffer_path("/dev/shm/my-buffer-");
 135   return buffer_path.compare(0, std::string::npos, file, buffer_path.length()) == 0;
 136 }
 137
 138 /**
 139  * @brief Makes a backup of the segment in memory that stores the global variables of a process.
 140  *        This backup is then used to initialize the global variables for every single
 141  *        process that is added, regardless of the progress of the simulation.
 142  */
 143 void smpi_backup_global_memory_segment()
 144 {
 145 #if HAVE_PRIVATIZATION
 146   smpi_get_executable_global_size();
 147
 148   XBT_DEBUG("bss+data segment found : size %d starting at %p", smpi_data_exe_size, smpi_data_exe_start);
 149
 150   if (smpi_data_exe_size == 0) { // no need to do anything as global variables don't exist
 151     smpi_privatize_global_variables = SmpiPrivStrategies::None;
 152     return;
 153   }
 154
 155   smpi_data_exe_copy = ::operator new(smpi_data_exe_size);
 156   // Make a copy of the data segment. This clean copy is retained over the whole runtime
 157   // of the simulation and can be used to initialize a dynamically added, new process.
 158   asan_safe_memcpy(smpi_data_exe_copy, TOPAGE(smpi_data_exe_start), smpi_data_exe_size);
 159 #else /* ! HAVE_PRIVATIZATION */
 160   smpi_privatize_global_variables = SmpiPrivStrategies::None;
 161   xbt_die("You are trying to use privatization on a system that does not support it. Don't.");
 162   return;
 163 #endif
 164 }
 165
 166 // Initializes the memory mapping for a single process and returns the privatization region
 167 smpi_privatization_region_t smpi_init_global_memory_segment_process()
 168 {
 169   int file_descriptor;
 170   void* address = nullptr;
 171   char path[24];
 172   int status;
 173
 174   do {
 175     snprintf(path, sizeof(path), "/smpi-buffer-%06x", rand() % 0xffffffU);
 176     file_descriptor = shm_open(path, O_RDWR | O_CREAT | O_EXCL, S_IRUSR | S_IWUSR);
 177   } while (file_descriptor == -1 && errno == EEXIST);
 178   if (file_descriptor < 0) {
 179     if (errno == EMFILE) {
 180       xbt_die("Impossible to create temporary file for memory mapping: %s\n\
 181 The open() system call failed with the EMFILE error code (too many files). \n\n\
 182 This means that you reached the system limits concerning the amount of files per process. \
 183 This is not a surprise if you are trying to virtualize many processes on top of SMPI. \
 184 Don't panic -- you should simply increase your system limits and try again. \n\n\
 185 First, check what your limits are:\n\
 186   cat /proc/sys/fs/file-max # Gives you the system-wide limit\n\
 187   ulimit -Hn                # Gives you the per process hard limit\n\
 188   ulimit -Sn                # Gives you the per process soft limit\n\
 189   cat /proc/self/limits     # Displays any per-process limitation (including the one given above)\n\n\
 190 If one of these values is less than the amount of MPI processes that you try to run, then you got the explanation of this error. \
 191 Ask the Internet about tutorials on how to increase the files limit such as: https://rtcamp.com/tutorials/linux/increase-open-files-limit/",
 192               strerror(errno));
 193     }
 194     xbt_die("Impossible to create temporary file for memory mapping: %s", strerror(errno));
 195   }
 196
 197   status = ftruncate(file_descriptor, smpi_data_exe_size);
 198   if (status)
 199     xbt_die("Impossible to set the size of the temporary file for memory mapping");
 200
 201   /* Ask for a free region */
 202   address = mmap(nullptr, smpi_data_exe_size, PROT_READ | PROT_WRITE, MAP_SHARED, file_descriptor, 0);
 203   if (address == MAP_FAILED)
 204     xbt_die("Couldn't find a free region for memory mapping");
 205
 206   status = shm_unlink(path);
 207   if (status)
 208     xbt_die("Impossible to unlink temporary file for memory mapping");
 209
 210   // initialize the values
 211   asan_safe_memcpy(address, smpi_data_exe_copy, smpi_data_exe_size);
 212
 213   // store the address of the mapping for further switches
 214   smpi_privatization_regions.emplace_back(s_smpi_privatization_region_t{address, file_descriptor});
 215
 216   return &smpi_privatization_regions.back();
 217 }
 218
 219 void smpi_destroy_global_memory_segments(){
 220   if (smpi_data_exe_size == 0) // no need to switch
 221     return;
 222 #if HAVE_PRIVATIZATION
 223   for (auto const& region : smpi_privatization_regions) {
 224     if (munmap(region.address, smpi_data_exe_size) < 0)
 225       XBT_WARN("Unmapping of fd %d failed: %s", region.file_descriptor, strerror(errno));
 226     close(region.file_descriptor);
 227   }
 228   smpi_privatization_regions.clear();
 229   ::operator delete(smpi_data_exe_copy);
 230 #endif
 231 }
 232
 233 static int sendbuffer_size = 0;
 234 static char* sendbuffer    = nullptr;
 235 static int recvbuffer_size = 0;
 236 static char* recvbuffer    = nullptr;
 237
 238 //allocate a single buffer for all sends, growing it if needed
 239 void* smpi_get_tmp_sendbuffer(int size)
 240 {
 241   if (not smpi_process()->replaying())
 242     return xbt_malloc(size);
 243   if (sendbuffer_size<size){
 244     sendbuffer=static_cast<char*>(xbt_realloc(sendbuffer,size));
 245     sendbuffer_size=size;
 246   }
 247   return sendbuffer;
 248 }
 249
 250 //allocate a single buffer for all recv
 251 void* smpi_get_tmp_recvbuffer(int size){
 252   if (not smpi_process()->replaying())
 253     return xbt_malloc(size);
 254   if (recvbuffer_size<size){
 255     recvbuffer=static_cast<char*>(xbt_realloc(recvbuffer,size));
 256     recvbuffer_size=size;
 257   }
 258   return recvbuffer;
 259 }
 260
 261 void smpi_free_tmp_buffer(void* buf){
 262   if (not smpi_process()->replaying())
 263     xbt_free(buf);
 264 }
 265
 266 void smpi_free_replay_tmp_buffers(){
 267   xbt_free(sendbuffer);
 268   xbt_free(recvbuffer);
 269 }