Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
try to disable mmap priv on ancient Mac systems
[simgrid.git] / src / smpi / internals / smpi_global.cpp
index 6596885..7544bbd 100644 (file)
@@ -3,7 +3,7 @@
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#include "SmpiHost.hpp"
+#include "smpi_host.hpp"
 #include "mc/mc.h"
 #include "simgrid/s4u/Engine.hpp"
 #include "smpi_coll.hpp"
 #include <fcntl.h>
 #include <fstream>
 
+#if not defined(__APPLE__)
+#include <link.h>
+#endif
+
+#if defined(__APPLE__)
+# include <AvailabilityMacros.h>
+# ifndef MAC_OS_X_VERSION_10_12
+#   define MAC_OS_X_VERSION_10_12 101200
+# endif
+# define HAVE_WORKING_MMAP (MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_X_VERSION_10_12)
+#elif defined(__FreeBSD__)
+# define HAVE_WORKING_MMAP 0
+#else
+# define HAVE_WORKING_MMAP 1
+#endif
+
 #if HAVE_SENDFILE
 #include <sys/sendfile.h>
 #endif
@@ -53,6 +69,7 @@ static int smpi_exit_status = 0;
 int smpi_universe_size = 0;
 extern double smpi_total_benched_time;
 xbt_os_timer_t global_timer;
+static std::vector<std::string> privatize_libs_paths;
 /**
  * Setting MPI_COMM_WORLD to MPI_COMM_UNINITIALIZED (it's a variable)
  * is important because the implementation of MPI_Comm checks
@@ -87,7 +104,7 @@ simgrid::smpi::Process* smpi_process()
   ActorPtr me = Actor::self();
   if (me == nullptr) // This happens sometimes (eg, when linking against NS3 because it pulls openMPI...)
     return nullptr;
-  simgrid::msg::ActorExt* msgExt = static_cast<simgrid::msg::ActorExt*>(me->get_impl()->userdata);
+  simgrid::msg::ActorExt* msgExt = static_cast<simgrid::msg::ActorExt*>(me->get_impl()->getUserData());
   return static_cast<simgrid::smpi::Process*>(msgExt->data);
 }
 
@@ -130,13 +147,6 @@ void smpi_comm_set_copy_data_callback(void (*callback) (smx_activity_t, void*, s
   smpi_comm_copy_data_callback = callback;
 }
 
-static void print(std::vector<std::pair<size_t, size_t>> vec) {
-  std::fprintf(stderr, "{");
-  for (auto const& elt : vec) {
-    std::fprintf(stderr, "(0x%zx, 0x%zx),", elt.first, elt.second);
-  }
-  std::fprintf(stderr, "}\n");
-}
 static void memcpy_private(void* dest, const void* src, std::vector<std::pair<size_t, size_t>>& private_blocks)
 {
   for (auto const& block : private_blocks)
@@ -180,7 +190,7 @@ void smpi_comm_copy_buffer_callback(smx_activity_t synchro, void *buff, size_t b
   auto private_blocks = merge_private_blocks(src_private_blocks, dst_private_blocks);
   check_blocks(private_blocks, buff_size);
   void* tmpbuff=buff;
-  if ((smpi_privatize_global_variables == SmpiPrivStrategies::Mmap) &&
+  if ((smpi_privatize_global_variables == SmpiPrivStrategies::MMAP) &&
       (static_cast<char*>(buff) >= smpi_data_exe_start) &&
       (static_cast<char*>(buff) < smpi_data_exe_start + smpi_data_exe_size)) {
     XBT_DEBUG("Privatization : We are copying from a zone inside global memory... Saving data to temp buffer !");
@@ -189,7 +199,7 @@ void smpi_comm_copy_buffer_callback(smx_activity_t synchro, void *buff, size_t b
     memcpy_private(tmpbuff, buff, private_blocks);
   }
 
-  if ((smpi_privatize_global_variables == SmpiPrivStrategies::Mmap) && ((char*)comm->dst_buff >= smpi_data_exe_start) &&
+  if ((smpi_privatize_global_variables == SmpiPrivStrategies::MMAP) && ((char*)comm->dst_buff >= smpi_data_exe_start) &&
       ((char*)comm->dst_buff < smpi_data_exe_start + smpi_data_exe_size)) {
     XBT_DEBUG("Privatization : We are copying to a zone inside global memory - Switch data segment");
     smpi_switch_data_segment(comm->dst_proc->iface());
@@ -349,7 +359,7 @@ void smpi_global_destroy()
     xbt_os_timer_free(global_timer);
   }
 
-  if (smpi_privatize_global_variables == SmpiPrivStrategies::Mmap)
+  if (smpi_privatize_global_variables == SmpiPrivStrategies::MMAP)
     smpi_destroy_global_memory_segments();
   smpi_free_static();
 }
@@ -365,24 +375,24 @@ static void smpi_init_options(){
   xbt_assert(smpi_host_speed >= 0, "You're trying to set the host_speed to a negative value (%f)", smpi_host_speed);
   std::string smpi_privatize_option = simgrid::config::get_value<std::string>("smpi/privatization");
   if (smpi_privatize_option == "no" || smpi_privatize_option == "0")
-    smpi_privatize_global_variables = SmpiPrivStrategies::None;
+    smpi_privatize_global_variables = SmpiPrivStrategies::NONE;
   else if (smpi_privatize_option == "yes" || smpi_privatize_option == "1")
-    smpi_privatize_global_variables = SmpiPrivStrategies::Default;
+    smpi_privatize_global_variables = SmpiPrivStrategies::DEFAULT;
   else if (smpi_privatize_option == "mmap")
-    smpi_privatize_global_variables = SmpiPrivStrategies::Mmap;
+    smpi_privatize_global_variables = SmpiPrivStrategies::MMAP;
   else if (smpi_privatize_option == "dlopen")
-    smpi_privatize_global_variables = SmpiPrivStrategies::Dlopen;
+    smpi_privatize_global_variables = SmpiPrivStrategies::DLOPEN;
   else
     xbt_die("Invalid value for smpi/privatization: '%s'", smpi_privatize_option.c_str());
 
   if (not SMPI_switch_data_segment) {
     XBT_DEBUG("Running without smpi_main(); disable smpi/privatization.");
-    smpi_privatize_global_variables = SmpiPrivStrategies::None;
+    smpi_privatize_global_variables = SmpiPrivStrategies::NONE;
   }
-#if defined(__FreeBSD__)
-  if (smpi_privatize_global_variables == SmpiPrivStrategies::Mmap) {
+#if HAVE_WORKING_MMAP
+  if (smpi_privatize_global_variables == SmpiPrivStrategies::MMAP) {
     XBT_INFO("mmap privatization is broken on FreeBSD, switching to dlopen privatization instead.");
-    smpi_privatize_global_variables = SmpiPrivStrategies::Dlopen;
+    smpi_privatize_global_variables = SmpiPrivStrategies::DLOPEN;
   }
 #endif
 
@@ -391,11 +401,11 @@ static void smpi_init_options(){
 
   std::string val = simgrid::config::get_value<std::string>("smpi/shared-malloc");
   if ((val == "yes") || (val == "1") || (val == "on") || (val == "global")) {
-    smpi_cfg_shared_malloc = shmalloc_global;
+    smpi_cfg_shared_malloc = SharedMallocType::GLOBAL;
   } else if (val == "local") {
-    smpi_cfg_shared_malloc = shmalloc_local;
+    smpi_cfg_shared_malloc = SharedMallocType::LOCAL;
   } else if ((val == "no") || (val == "0") || (val == "off")) {
-    smpi_cfg_shared_malloc = shmalloc_none;
+    smpi_cfg_shared_malloc = SharedMallocType::NONE;
   } else {
     xbt_die("Invalid value '%s' for option smpi/shared-malloc. Possible values: 'on' or 'global', 'local', 'off'",
             val.c_str());
@@ -424,6 +434,7 @@ static int smpi_run_entry_point(smpi_entry_point_type entry_point, std::vector<s
   return 0;
 }
 
+
 // TODO, remove the number of functions involved here
 static smpi_entry_point_type smpi_resolve_function(void* handle)
 {
@@ -444,7 +455,170 @@ static smpi_entry_point_type smpi_resolve_function(void* handle)
   return smpi_entry_point_type();
 }
 
-int smpi_main(const char* executable, int argc, char *argv[])
+static void smpi_copy_file(std::string src, std::string target, off_t fdin_size)
+{
+  int fdin = open(src.c_str(), O_RDONLY);
+  xbt_assert(fdin >= 0, "Cannot read from %s. Please make sure that the file exists and is executable.", src.c_str());
+  int fdout = open(target.c_str(), O_CREAT | O_RDWR, S_IRWXU);
+  xbt_assert(fdout >= 0, "Cannot write into %s", target.c_str());
+
+  XBT_DEBUG("Copy %ld bytes into %s", static_cast<long>(fdin_size), target.c_str());
+#if HAVE_SENDFILE
+  ssize_t sent_size = sendfile(fdout, fdin, NULL, fdin_size);
+  xbt_assert(sent_size == fdin_size, "Error while copying %s: only %zd bytes copied instead of %ld (errno: %d -- %s)",
+             target.c_str(), sent_size, fdin_size, errno, strerror(errno));
+#else
+  const int bufsize = 1024 * 1024 * 4;
+  char buf[bufsize];
+  while (int got = read(fdin, buf, bufsize)) {
+    if (got == -1) {
+      xbt_assert(errno == EINTR, "Cannot read from %s", src.c_str());
+    } else {
+      char* p  = buf;
+      int todo = got;
+      while (int done = write(fdout, p, todo)) {
+        if (done == -1) {
+          xbt_assert(errno == EINTR, "Cannot write into %s", target.c_str());
+        } else {
+          p += done;
+          todo -= done;
+        }
+      }
+    }
+  }
+#endif
+  close(fdin);
+  close(fdout);
+}
+
+#if not defined(__APPLE__)
+static int visit_libs(struct dl_phdr_info* info, size_t, void* data)
+{
+  char* libname = (char*)(data);
+  const char *path = info->dlpi_name;
+  if(strstr(path, libname)){
+    strncpy(libname, path, 512);
+    return 1;
+  }
+  
+  return 0;
+}
+#endif
+
+static void smpi_init_privatization_dlopen(std::string executable)
+{
+  // Prepare the copy of the binary (get its size)
+  struct stat fdin_stat;
+  stat(executable.c_str(), &fdin_stat);
+  off_t fdin_size         = fdin_stat.st_size;
+  static std::size_t rank = 0;
+
+  std::string libnames = simgrid::config::get_value<std::string>("smpi/privatize-libs");
+  if (not libnames.empty()) {
+    // split option
+    std::vector<std::string> privatize_libs;
+    boost::split(privatize_libs, libnames, boost::is_any_of(";"));
+
+    for (auto const& libname : privatize_libs) {
+      // load the library once to add it to the local libs, to get the absolute path
+      void* libhandle = dlopen(libname.c_str(), RTLD_LAZY);
+      // get library name from path
+      char fullpath[512] = {'\0'};
+      strcpy(fullpath, libname.c_str());
+#if not defined(__APPLE__)
+      int ret = dl_iterate_phdr(visit_libs, fullpath);
+      if (ret == 0)
+        xbt_die("Can't find a linked %s - check the setting you gave to smpi/privatize-libs", fullpath);
+      else
+        XBT_DEBUG("Extra lib to privatize found : %s", fullpath);
+#else
+      xbt_die("smpi/privatize-libs is not (yet) compatible with OSX");
+#endif
+      privatize_libs_paths.push_back(fullpath);
+      dlclose(libhandle);
+    }
+  }
+
+  simix_global->default_function = [executable, fdin_size](std::vector<std::string> args) {
+    return std::function<void()>([executable, fdin_size, args] {
+
+      // Copy the dynamic library:
+      std::string target_executable =
+          executable + "_" + std::to_string(getpid()) + "_" + std::to_string(rank) + ".so";
+
+      smpi_copy_file(executable, target_executable, fdin_size);
+      // if smpi/privatize-libs is set, duplicate pointed lib and link each executable copy to a different one.
+      std::string target_lib;
+      for (auto const& libpath : privatize_libs_paths) {
+        // if we were given a full path, strip it
+        size_t index = libpath.find_last_of("/\\");
+        std::string libname;
+        if (index != std::string::npos)
+          libname = libpath.substr(index + 1);
+
+        if (not libname.empty()) {
+          // load the library to add it to the local libs, to get the absolute path
+          struct stat fdin_stat2;
+          stat(libpath.c_str(), &fdin_stat2);
+          off_t fdin_size2 = fdin_stat2.st_size;
+
+          // Copy the dynamic library, the new name must be the same length as the old one
+          // just replace the name with 7 digits for the rank and the rest of the name.
+          unsigned int pad = 7;
+          if (libname.length() < pad)
+            pad = libname.length();
+          target_lib =
+              std::string(pad - std::to_string(rank).length(), '0') + std::to_string(rank) + libname.substr(pad);
+          XBT_DEBUG("copy lib %s to %s, with size %lld", libpath.c_str(), target_lib.c_str(), (long long)fdin_size2);
+          smpi_copy_file(libpath, target_lib, fdin_size2);
+
+          std::string sedcommand = "sed -i -e 's/" + libname + "/" + target_lib + "/g' " + target_executable;
+          int ret                = system(sedcommand.c_str());
+          if (ret != 0)
+            xbt_die("error while applying sed command %s \n", sedcommand.c_str());
+        }
+      }
+
+      rank++;
+      // Load the copy and resolve the entry point:
+      void* handle    = dlopen(target_executable.c_str(), RTLD_LAZY | RTLD_LOCAL | RTLD_DEEPBIND);
+      int saved_errno = errno;
+      if (simgrid::config::get_value<bool>("smpi/keep-temps") == false) {
+        unlink(target_executable.c_str());
+        if (not target_lib.empty())
+          unlink(target_lib.c_str());
+      }
+      if (handle == nullptr)
+        xbt_die("dlopen failed: %s (errno: %d -- %s)", dlerror(), saved_errno, strerror(saved_errno));
+      smpi_entry_point_type entry_point = smpi_resolve_function(handle);
+      if (not entry_point)
+        xbt_die("Could not resolve entry point");
+      smpi_run_entry_point(entry_point, args);
+    });
+  };
+}
+
+static void smpi_init_privatization_no_dlopen(std::string executable)
+{
+  if (smpi_privatize_global_variables == SmpiPrivStrategies::MMAP)
+    smpi_prepare_global_memory_segment();
+  // Load the dynamic library and resolve the entry point:
+  void* handle = dlopen(executable.c_str(), RTLD_LAZY | RTLD_LOCAL);
+  if (handle == nullptr)
+    xbt_die("dlopen failed for %s: %s (errno: %d -- %s)", executable.c_str(), dlerror(), errno, strerror(errno));
+  smpi_entry_point_type entry_point = smpi_resolve_function(handle);
+  if (not entry_point)
+    xbt_die("main not found in %s", executable.c_str());
+  if (smpi_privatize_global_variables == SmpiPrivStrategies::MMAP)
+    smpi_backup_global_memory_segment();
+
+  // Execute the same entry point for each simulated process:
+  simix_global->default_function = [entry_point](std::vector<std::string> args) {
+    return std::function<void()>([entry_point, args] { smpi_run_entry_point(entry_point, args); });
+  };
+}
+
+int smpi_main(const char* executable, int argc, char* argv[])
 {
   srand(SMPI_RAND_SEED);
 
@@ -457,110 +631,25 @@ int smpi_main(const char* executable, int argc, char *argv[])
   TRACE_global_init();
 
   SIMIX_global_init(&argc, argv);
-  MSG_init(&argc,argv);
+  MSG_init(&argc, argv); // FIXME Remove this MSG call. Once it's removed, we can remove the msg header include as well
 
   SMPI_switch_data_segment = &smpi_switch_data_segment;
 
   // TODO This will not be executed in the case where smpi_main is not called,
   // e.g., not for smpi_msg_masterslave. This should be moved to another location
   // that is always called -- maybe close to Actor::onCreation?
-  simgrid::s4u::Host::onCreation.connect([](simgrid::s4u::Host& host) {
-    host.extension_set(new simgrid::smpi::SmpiHost(&host));
-  });
+  simgrid::s4u::Host::on_creation.connect(
+      [](simgrid::s4u::Host& host) { host.extension_set(new simgrid::smpi::Host(&host)); });
 
   // parse the platform file: get the host list
   SIMIX_create_environment(argv[1]);
   SIMIX_comm_set_copy_data_callback(smpi_comm_copy_buffer_callback);
 
   smpi_init_options();
-  if (smpi_privatize_global_variables == SmpiPrivStrategies::Dlopen) {
-
-    std::string executable_copy = executable;
-
-    // Prepare the copy of the binary (get its size)
-    struct stat fdin_stat;
-    stat(executable_copy.c_str(), &fdin_stat);
-    off_t fdin_size = fdin_stat.st_size;
-    static std::size_t rank = 0;
-
-    simix_global->default_function = [executable_copy, fdin_size](std::vector<std::string> args) {
-      return std::function<void()>([executable_copy, fdin_size, args] {
-
-        // Copy the dynamic library:
-        std::string target_executable = executable_copy
-          + "_" + std::to_string(getpid())
-          + "_" + std::to_string(rank++) + ".so";
-
-        int fdin = open(executable_copy.c_str(), O_RDONLY);
-        xbt_assert(fdin >= 0, "Cannot read from %s. Please make sure that the file exists and is executable.",
-                   executable_copy.c_str());
-        int fdout = open(target_executable.c_str(), O_CREAT | O_RDWR, S_IRWXU);
-        xbt_assert(fdout >= 0, "Cannot write into %s", target_executable.c_str());
-
-        XBT_DEBUG("Copy %ld bytes into %s", static_cast<long>(fdin_size), target_executable.c_str());
-#if HAVE_SENDFILE
-        ssize_t sent_size = sendfile(fdout, fdin, NULL, fdin_size);
-        xbt_assert(sent_size == fdin_size,
-                   "Error while copying %s: only %zd bytes copied instead of %ld (errno: %d -- %s)",
-                   target_executable.c_str(), sent_size, fdin_size, errno, strerror(errno));
-#else
-        const int bufsize = 1024 * 1024 * 4;
-        char buf[bufsize];
-        while (int got = read(fdin, buf, bufsize)) {
-          if (got == -1) {
-            xbt_assert(errno == EINTR, "Cannot read from %s", executable_copy.c_str());
-          } else {
-            char* p  = buf;
-            int todo = got;
-            while (int done = write(fdout, p, todo)) {
-              if (done == -1) {
-                xbt_assert(errno == EINTR, "Cannot write into %s", target_executable.c_str());
-              } else {
-                p += done;
-                todo -= done;
-              }
-            }
-          }
-        }
-#endif
-        close(fdin);
-        close(fdout);
-
-        // Load the copy and resolve the entry point:
-        void* handle = dlopen(target_executable.c_str(), RTLD_LAZY | RTLD_LOCAL | RTLD_DEEPBIND);
-        int saved_errno = errno;
-        if (simgrid::config::get_value<bool>("smpi/keep-temps") == false)
-          unlink(target_executable.c_str());
-        if (handle == nullptr)
-          xbt_die("dlopen failed: %s (errno: %d -- %s)", dlerror(), saved_errno, strerror(saved_errno));
-        smpi_entry_point_type entry_point = smpi_resolve_function(handle);
-        if (not entry_point)
-          xbt_die("Could not resolve entry point");
-
-        smpi_run_entry_point(entry_point, args);
-      });
-    };
-  }
-  else {
-    if (smpi_privatize_global_variables == SmpiPrivStrategies::Mmap)
-      smpi_prepare_global_memory_segment();
-    // Load the dynamic library and resolve the entry point:
-    void* handle = dlopen(executable, RTLD_LAZY | RTLD_LOCAL);
-    if (handle == nullptr)
-      xbt_die("dlopen failed for %s: %s (errno: %d -- %s)", executable, dlerror(), errno, strerror(errno));
-    smpi_entry_point_type entry_point = smpi_resolve_function(handle);
-    if (not entry_point)
-      xbt_die("main not found in %s", executable);
-    if (smpi_privatize_global_variables == SmpiPrivStrategies::Mmap)
-      smpi_backup_global_memory_segment();
-
-    // Execute the same entry point for each simulated process:
-    simix_global->default_function = [entry_point](std::vector<std::string> args) {
-      return std::function<void()>([entry_point, args] {
-        smpi_run_entry_point(entry_point, args);
-      });
-    };
-  }
+  if (smpi_privatize_global_variables == SmpiPrivStrategies::DLOPEN)
+    smpi_init_privatization_dlopen(executable);
+  else
+    smpi_init_privatization_no_dlopen(executable);
 
   SMPI_init();
   SIMIX_launch_application(argv[2]);
@@ -595,8 +684,6 @@ int smpi_main(const char* executable, int argc, char *argv[])
   }
   smpi_global_destroy();
 
-  TRACE_end();
-
   return smpi_exit_status;
 }
 
@@ -618,7 +705,7 @@ void SMPI_init(){
   smpi_init_options();
   smpi_global_init();
   smpi_check_options();
-  simgrid::s4u::onSimulationEnd.connect(TRACE_smpi_release);
+  simgrid::s4u::on_simulation_end.connect(TRACE_smpi_release);
 }
 
 void SMPI_finalize(){