Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
thread_local is part of C++11, nowadays
[simgrid.git] / src / simix / smx_context.cpp
index b947a6b..4fb8c47 100644 (file)
@@ -1,7 +1,6 @@
 /* a fast and simple context switching library                              */
 
-/* Copyright (c) 2009-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2009-2018. The SimGrid Team. All rights reserved.          */
 
 /* 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 <xbt/range.hpp>
 #include <xbt/sysdep.h>
 
+#include "simgrid/modelchecker.h"
+#include "simgrid/sg_config.hpp"
+#include "smx_private.hpp"
 #include "src/internal_config.h"
 #include "xbt/log.h"
-#include "xbt/swag.h"
 #include "xbt/xbt_os_thread.h"
-#include "smx_private.h"
-#include "simgrid/sg_config.h"
-#include "src/internal_config.h"
-#include "simgrid/modelchecker.h"
-
 
 #ifdef _WIN32
 #include <windows.h>
 #include <sys/mman.h>
 #endif
 
-#ifdef __MINGW32__ 
-#define _aligned_malloc __mingw_aligned_malloc 
-#define _aligned_free  __mingw_aligned_free 
-#endif //MINGW
+#ifdef __MINGW32__
+#define _aligned_malloc __mingw_aligned_malloc
+#define _aligned_free  __mingw_aligned_free
+#endif /*MINGW*/
 
 #if HAVE_VALGRIND_H
 # include <valgrind/valgrind.h>
@@ -80,15 +76,11 @@ static simgrid::config::Flag<std::string> context_factory_name(
   (std::string("Possible values: ")+contexts_list()).c_str(),
   context_factories[0].first);
 
-int smx_context_stack_size;
+unsigned smx_context_stack_size;
 int smx_context_stack_size_was_set = 0;
-int smx_context_guard_size;
+unsigned smx_context_guard_size;
 int smx_context_guard_size_was_set = 0;
-#if HAVE_THREAD_LOCAL_STORAGE
-static XBT_THREAD_LOCAL smx_context_t smx_current_context_parallel;
-#else
-static xbt_os_thread_key_t smx_current_context_key = 0;
-#endif
+static thread_local smx_context_t smx_current_context_parallel;
 static smx_context_t smx_current_context_serial;
 static int smx_parallel_contexts = 1;
 static int smx_parallel_threshold = 2;
@@ -101,10 +93,22 @@ void SIMIX_context_mod_init()
 {
   xbt_assert(simix_global->context_factory == nullptr);
 
-#if HAVE_THREAD_CONTEXTS && !HAVE_THREAD_LOCAL_STORAGE
-  /* the __thread storage class is not available on this platform:
-   * use getspecific/setspecific instead to store the current context in each thread */
-  xbt_os_thread_key_create(&smx_current_context_key);
+  smx_context_stack_size_was_set = not simgrid::config::is_default("contexts/stack-size");
+  smx_context_guard_size_was_set = not simgrid::config::is_default("contexts/guard-size");
+
+#if HAVE_SMPI && (defined(__APPLE__) || defined(__NetBSD__))
+  std::string priv = simgrid::config::get_value<std::string>("smpi/privatization");
+  if (context_factory_name == "thread" && (priv == "dlopen" || priv == "yes" || priv == "default" || priv == "1")) {
+    XBT_WARN("dlopen+thread broken on Apple and BSD. Switching to raw contexts.");
+    context_factory_name = "raw";
+  }
+#endif
+
+#if HAVE_SMPI && defined(__FreeBSD__)
+  if (context_factory_name == "thread" && simgrid::config::get_value<std::string>("smpi/privatization") != "no") {
+    XBT_WARN("mmap broken on FreeBSD, but dlopen+thread broken too. Switching to dlopen+raw contexts.");
+    context_factory_name = "raw";
+  }
 #endif
 
   /* select the context factory to use to create the contexts */
@@ -154,23 +158,19 @@ void *SIMIX_context_stack_new()
 {
   void *stack;
 
-  /* FIXME: current code for stack overflow protection assumes that stacks are
-   * growing downward (PTH_STACKGROWTH == -1).  Protected pages need to be put
-   * after the stack when PTH_STACKGROWTH == 1. */
-
-  if (smx_context_guard_size > 0 && !MC_is_active()) {
+  if (smx_context_guard_size > 0 && not MC_is_active()) {
 
 #if !defined(PTH_STACKGROWTH) || (PTH_STACKGROWTH != -1)
-    static int warned_once = 0;
-    if (!warned_once) {
-      XBT_WARN("Stack overflow protection is known to be broken on your system.  Either stack grows upwards, or it was not even tested properly.");
-      warned_once = 1;
-    }
+    xbt_die("Stack overflow protection is known to be broken on your system: you stacks grow upwards (or detection is "
+            "broken). "
+            "Please disable stack guards with --cfg=contexts:guard-size:0");
+    /* Current code for stack overflow protection assumes that stacks are growing downward (PTH_STACKGROWTH == -1).
+     * Protected pages need to be put after the stack when PTH_STACKGROWTH == 1. */
 #endif
 
     size_t size = smx_context_stack_size + smx_context_guard_size;
-#if HAVE_MC
-    /* Cannot use posix_memalign when HAVE_MC. Align stack by hand, and save the
+#if SIMGRID_HAVE_MC
+    /* Cannot use posix_memalign when SIMGRID_HAVE_MC. Align stack by hand, and save the
      * pointer returned by xbt_malloc0. */
     char *alloc = (char*)xbt_malloc0(size + xbt_pagesize);
     stack = alloc - ((uintptr_t)alloc & (xbt_pagesize - 1)) + xbt_pagesize;
@@ -184,7 +184,12 @@ void *SIMIX_context_stack_new()
 
 #ifndef _WIN32
     if (mprotect(stack, smx_context_guard_size, PROT_NONE) == -1) {
-      xbt_die("Failed to protect stack %p: %s", stack, strerror(errno));
+      xbt_die(
+          "Failed to protect stack: %s.\n"
+          "If you are running a lot of actors, you may be exceeding the amount of mappings allowed per process.\n"
+          "On Linux systems, change this value with sudo sysctl -w vm.max_map_count=newvalue (default value: 65536)\n"
+          "Please see http://simgrid.gforge.inria.fr/simgrid/latest/doc/html/options.html#options_virt for more info.",
+          strerror(errno));
       /* This is fatal. We are going to fail at some point when we try reusing this. */
     }
 #endif
@@ -203,7 +208,7 @@ void *SIMIX_context_stack_new()
 
 void SIMIX_context_stack_delete(void *stack)
 {
-  if (!stack)
+  if (not stack)
     return;
 
 #if HAVE_VALGRIND_H
@@ -213,13 +218,13 @@ void SIMIX_context_stack_delete(void *stack)
 #endif
 
 #ifndef _WIN32
-  if (smx_context_guard_size > 0 && !MC_is_active()) {
+  if (smx_context_guard_size > 0 && not MC_is_active()) {
     stack = (char *)stack - smx_context_guard_size;
     if (mprotect(stack, smx_context_guard_size, PROT_READ | PROT_WRITE) == -1) {
       XBT_WARN("Failed to remove page protection: %s", strerror(errno));
       /* try to pursue anyway */
     }
-#if HAVE_MC
+#if SIMGRID_HAVE_MC
     /* Retrieve the saved pointer.  See SIMIX_context_stack_new above. */
     stack = *((void **)stack - 1);
 #endif
@@ -236,27 +241,27 @@ int SIMIX_context_is_parallel() {
 
 /**
  * @brief Returns the number of parallel threads used for the user contexts.
- * \return the number of threads (1 means no parallelism)
+ * @return the number of threads (1 means no parallelism)
  */
 int SIMIX_context_get_nthreads() {
   return smx_parallel_contexts;
 }
 
 /**
- * \brief Sets the number of parallel threads to use
+ * @brief Sets the number of parallel threads to use
  * for the user contexts.
  *
  * This function should be called before initializing SIMIX.
  * A value of 1 means no parallelism (1 thread only).
  * If the value is greater than 1, the thread support must be enabled.
  *
- * \param nb_threads the number of threads to use
+ * @param nb_threads the number of threads to use
  */
 void SIMIX_context_set_nthreads(int nb_threads) {
-  if (nb_threads<=0) {  
+  if (nb_threads<=0) {
      nb_threads = xbt_os_get_numcores();
      XBT_INFO("Auto-setting contexts/nthreads to %d",nb_threads);
-  }   
+  }
 #if !HAVE_THREAD_CONTEXTS
   xbt_assert(nb_threads == 1, "Parallel runs are impossible when the pthreads are missing.");
 #endif
@@ -264,12 +269,12 @@ void SIMIX_context_set_nthreads(int nb_threads) {
 }
 
 /**
- * \brief Returns the threshold above which user processes are run in parallel.
+ * @brief Returns the threshold above which user processes are run in parallel.
  *
  * If the number of threads is set to 1, there is no parallelism and this
  * threshold has no effect.
  *
- * \return when the number of user processes ready to run is above
+ * @return when the number of user processes ready to run is above
  * this threshold, they are run in parallel
  */
 int SIMIX_context_get_parallel_threshold() {
@@ -277,12 +282,12 @@ int SIMIX_context_get_parallel_threshold() {
 }
 
 /**
- * \brief Sets the threshold above which user processes are run in parallel.
+ * @brief Sets the threshold above which user processes are run in parallel.
  *
  * If the number of threads is set to 1, there is no parallelism and this
  * threshold has no effect.
  *
- * \param threshold when the number of user processes ready to run is above
+ * @param threshold when the number of user processes ready to run is above
  * this threshold, they are run in parallel
  */
 void SIMIX_context_set_parallel_threshold(int threshold) {
@@ -290,35 +295,31 @@ void SIMIX_context_set_parallel_threshold(int threshold) {
 }
 
 /**
- * \brief Returns the synchronization mode used when processes are run in
+ * @brief Returns the synchronization mode used when processes are run in
  * parallel.
- * \return how threads are synchronized if processes are run in parallel
+ * @return how threads are synchronized if processes are run in parallel
  */
 e_xbt_parmap_mode_t SIMIX_context_get_parallel_mode() {
   return smx_parallel_synchronization_mode;
 }
 
 /**
- * \brief Sets the synchronization mode to use when processes are run in
+ * @brief Sets the synchronization mode to use when processes are run in
  * parallel.
- * \param mode how to synchronize threads if processes are run in parallel
+ * @param mode how to synchronize threads if processes are run in parallel
  */
 void SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode) {
   smx_parallel_synchronization_mode = mode;
 }
 
 /**
- * \brief Returns the current context of this thread.
- * \return the current context of this thread
+ * @brief Returns the current context of this thread.
+ * @return the current context of this thread
  */
 smx_context_t SIMIX_context_get_current()
 {
   if (SIMIX_context_is_parallel()) {
-#if HAVE_THREAD_LOCAL_STORAGE
     return smx_current_context_parallel;
-#else
-    return xbt_os_thread_get_specific(smx_current_context_key);
-#endif
   }
   else {
     return smx_current_context_serial;
@@ -326,17 +327,13 @@ smx_context_t SIMIX_context_get_current()
 }
 
 /**
- * \brief Sets the current context of this thread.
- * \param context the context to set
+ * @brief Sets the current context of this thread.
+ * @param context the context to set
  */
 void SIMIX_context_set_current(smx_context_t context)
 {
   if (SIMIX_context_is_parallel()) {
-#if HAVE_THREAD_LOCAL_STORAGE
     smx_current_context_parallel = context;
-#else
-    xbt_os_thread_set_specific(smx_current_context_key, context);
-#endif
   }
   else {
     smx_current_context_serial = context;