src/simix/smx_context.cpp

   1 /* a fast and simple context switching library                              */
   2
   3 /* Copyright (c) 2009-2018. The SimGrid Team. All rights reserved.          */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 #include "simgrid/modelchecker.h"
   9 #include "src/internal_config.h"
  10 #include "src/simix/smx_private.hpp"
  11 #include "xbt/config.hpp"
  12
  13 #include <thread>
  14
  15 #ifdef _WIN32
  16 #include <windows.h>
  17 #include <malloc.h>
  18 #else
  19 #include <sys/mman.h>
  20 #endif
  21
  22 #ifdef __MINGW32__
  23 #define _aligned_malloc __mingw_aligned_malloc
  24 #define _aligned_free  __mingw_aligned_free
  25 #endif /*MINGW*/
  26
  27 #if HAVE_VALGRIND_H
  28 # include <valgrind/valgrind.h>
  29 #endif
  30
  31 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_context, simix, "Context switching mechanism");
  32
  33 static std::pair<const char*, simgrid::kernel::context::ContextFactoryInitializer> context_factories[] = {
  34 #if HAVE_RAW_CONTEXTS
  35   { "raw", &simgrid::kernel::context::raw_factory },
  36 #endif
  37 #if HAVE_UCONTEXT_CONTEXTS
  38   { "ucontext", &simgrid::kernel::context::sysv_factory },
  39 #endif
  40 #if HAVE_BOOST_CONTEXTS
  41   { "boost", &simgrid::kernel::context::boost_factory },
  42 #endif
  43   { "thread", &simgrid::kernel::context::thread_factory },
  44 };
  45
  46 static_assert(sizeof(context_factories) != 0, "No context factories are enabled for this build");
  47
  48 // Create the list of possible contexts:
  49 static inline
  50 std::string contexts_list()
  51 {
  52   std::string res;
  53   const std::size_t n = sizeof(context_factories) / sizeof(context_factories[0]);
  54   for (std::size_t i = 1; i != n; ++i) {
  55     res += ", ";
  56     res += context_factories[i].first;
  57   }
  58   return res;
  59 }
  60
  61 static simgrid::config::Flag<std::string> context_factory_name(
  62   "contexts/factory",
  63   (std::string("Possible values: ")+contexts_list()).c_str(),
  64   context_factories[0].first);
  65
  66 unsigned smx_context_stack_size;
  67 int smx_context_stack_size_was_set = 0;
  68 unsigned smx_context_guard_size;
  69 int smx_context_guard_size_was_set = 0;
  70 static thread_local smx_context_t smx_current_context_parallel;
  71 static smx_context_t smx_current_context_serial;
  72 static int smx_parallel_contexts = 1;
  73 static int smx_parallel_threshold = 2;
  74 static e_xbt_parmap_mode_t smx_parallel_synchronization_mode = XBT_PARMAP_DEFAULT;
  75
  76 /**
  77  * This function is called by SIMIX_global_init() to initialize the context module.
  78  */
  79 void SIMIX_context_mod_init()
  80 {
  81   xbt_assert(simix_global->context_factory == nullptr);
  82
  83   smx_context_stack_size_was_set = not simgrid::config::is_default("contexts/stack-size");
  84   smx_context_guard_size_was_set = not simgrid::config::is_default("contexts/guard-size");
  85
  86 #if HAVE_SMPI && (defined(__APPLE__) || defined(__NetBSD__))
  87   std::string priv = simgrid::config::get_value<std::string>("smpi/privatization");
  88   if (context_factory_name == "thread" && (priv == "dlopen" || priv == "yes" || priv == "default" || priv == "1")) {
  89     XBT_WARN("dlopen+thread broken on Apple and BSD. Switching to raw contexts.");
  90     context_factory_name = "raw";
  91   }
  92 #endif
  93
  94 #if HAVE_SMPI && defined(__FreeBSD__)
  95   if (context_factory_name == "thread" && simgrid::config::get_value<std::string>("smpi/privatization") != "no") {
  96     XBT_WARN("mmap broken on FreeBSD, but dlopen+thread broken too. Switching to dlopen+raw contexts.");
  97     context_factory_name = "raw";
  98   }
  99 #endif
 100
 101   /* select the context factory to use to create the contexts */
 102   if (simgrid::kernel::context::factory_initializer != nullptr) { // Give Java a chance to hijack the factory mechanism
 103     simix_global->context_factory = simgrid::kernel::context::factory_initializer();
 104     return;
 105   }
 106   /* use the factory specified by --cfg=contexts/factory:value */
 107   for (auto const& factory : context_factories)
 108     if (context_factory_name == factory.first) {
 109       simix_global->context_factory = factory.second();
 110       break;
 111     }
 112
 113   if (simix_global->context_factory == nullptr) {
 114     XBT_ERROR("Invalid context factory specified. Valid factories on this machine:");
 115 #if HAVE_RAW_CONTEXTS
 116     XBT_ERROR("  raw: high performance context factory implemented specifically for SimGrid");
 117 #else
 118     XBT_ERROR("  (raw contexts were disabled at compilation time on this machine -- check configure logs for details)");
 119 #endif
 120 #if HAVE_UCONTEXT_CONTEXTS
 121     XBT_ERROR("  ucontext: classical system V contexts (implemented with makecontext, swapcontext and friends)");
 122 #else
 123     XBT_ERROR("  (ucontext was disabled at compilation time on this machine -- check configure logs for details)");
 124 #endif
 125 #if HAVE_BOOST_CONTEXTS
 126     XBT_ERROR("  boost: this uses the boost libraries context implementation");
 127 #else
 128     XBT_ERROR("  (boost was disabled at compilation time on this machine -- check configure logs for details. Did you install the libboost-context-dev package?)");
 129 #endif
 130     XBT_ERROR("  thread: slow portability layer using pthreads as provided by gcc");
 131     xbt_die("Please use a valid factory.");
 132   }
 133 }
 134
 135 /**
 136  * This function is called by SIMIX_clean() to finalize the context module.
 137  */
 138 void SIMIX_context_mod_exit()
 139 {
 140   delete simix_global->context_factory;
 141   simix_global->context_factory = nullptr;
 142 }
 143
 144 void *SIMIX_context_stack_new()
 145 {
 146   void *stack;
 147
 148   if (smx_context_guard_size > 0 && not MC_is_active()) {
 149
 150 #if !defined(PTH_STACKGROWTH) || (PTH_STACKGROWTH != -1)
 151     xbt_die("Stack overflow protection is known to be broken on your system: you stacks grow upwards (or detection is "
 152             "broken). "
 153             "Please disable stack guards with --cfg=contexts:guard-size:0");
 154     /* Current code for stack overflow protection assumes that stacks are growing downward (PTH_STACKGROWTH == -1).
 155      * Protected pages need to be put after the stack when PTH_STACKGROWTH == 1. */
 156 #endif
 157
 158     size_t size = smx_context_stack_size + smx_context_guard_size;
 159 #if SIMGRID_HAVE_MC
 160     /* Cannot use posix_memalign when SIMGRID_HAVE_MC. Align stack by hand, and save the
 161      * pointer returned by xbt_malloc0. */
 162     char *alloc = (char*)xbt_malloc0(size + xbt_pagesize);
 163     stack = alloc - ((uintptr_t)alloc & (xbt_pagesize - 1)) + xbt_pagesize;
 164     *((void **)stack - 1) = alloc;
 165 #elif !defined(_WIN32)
 166     if (posix_memalign(&stack, xbt_pagesize, size) != 0)
 167       xbt_die("Failed to allocate stack.");
 168 #else
 169     stack = _aligned_malloc(size, xbt_pagesize);
 170 #endif
 171
 172 #ifndef _WIN32
 173     if (mprotect(stack, smx_context_guard_size, PROT_NONE) == -1) {
 174       xbt_die(
 175           "Failed to protect stack: %s.\n"
 176           "If you are running a lot of actors, you may be exceeding the amount of mappings allowed per process.\n"
 177           "On Linux systems, change this value with sudo sysctl -w vm.max_map_count=newvalue (default value: 65536)\n"
 178           "Please see http://simgrid.gforge.inria.fr/simgrid/latest/doc/html/options.html#options_virt for more info.",
 179           strerror(errno));
 180       /* This is fatal. We are going to fail at some point when we try reusing this. */
 181     }
 182 #endif
 183     stack = (char *)stack + smx_context_guard_size;
 184   } else {
 185     stack = xbt_malloc0(smx_context_stack_size);
 186   }
 187
 188 #if HAVE_VALGRIND_H
 189   unsigned int valgrind_stack_id = VALGRIND_STACK_REGISTER(stack, (char *)stack + smx_context_stack_size);
 190   memcpy((char *)stack + smx_context_usable_stack_size, &valgrind_stack_id, sizeof valgrind_stack_id);
 191 #endif
 192
 193   return stack;
 194 }
 195
 196 void SIMIX_context_stack_delete(void *stack)
 197 {
 198   if (not stack)
 199     return;
 200
 201 #if HAVE_VALGRIND_H
 202   unsigned int valgrind_stack_id;
 203   memcpy(&valgrind_stack_id, (char *)stack + smx_context_usable_stack_size, sizeof valgrind_stack_id);
 204   VALGRIND_STACK_DEREGISTER(valgrind_stack_id);
 205 #endif
 206
 207 #ifndef _WIN32
 208   if (smx_context_guard_size > 0 && not MC_is_active()) {
 209     stack = (char *)stack - smx_context_guard_size;
 210     if (mprotect(stack, smx_context_guard_size, PROT_READ | PROT_WRITE) == -1) {
 211       XBT_WARN("Failed to remove page protection: %s", strerror(errno));
 212       /* try to pursue anyway */
 213     }
 214 #if SIMGRID_HAVE_MC
 215     /* Retrieve the saved pointer.  See SIMIX_context_stack_new above. */
 216     stack = *((void **)stack - 1);
 217 #endif
 218   }
 219 #endif /* not windows */
 220
 221   xbt_free(stack);
 222 }
 223
 224 /** @brief Returns whether some parallel threads are used for the user contexts. */
 225 int SIMIX_context_is_parallel() {
 226   return smx_parallel_contexts > 1;
 227 }
 228
 229 /**
 230  * @brief Returns the number of parallel threads used for the user contexts.
 231  * @return the number of threads (1 means no parallelism)
 232  */
 233 int SIMIX_context_get_nthreads() {
 234   return smx_parallel_contexts;
 235 }
 236
 237 /**
 238  * @brief Sets the number of parallel threads to use
 239  * for the user contexts.
 240  *
 241  * This function should be called before initializing SIMIX.
 242  * A value of 1 means no parallelism (1 thread only).
 243  * If the value is greater than 1, the thread support must be enabled.
 244  *
 245  * @param nb_threads the number of threads to use
 246  */
 247 void SIMIX_context_set_nthreads(int nb_threads) {
 248   if (nb_threads<=0) {
 249     nb_threads = std::thread::hardware_concurrency();
 250     XBT_INFO("Auto-setting contexts/nthreads to %d", nb_threads);
 251   }
 252   smx_parallel_contexts = nb_threads;
 253 }
 254
 255 /**
 256  * @brief Returns the threshold above which user processes are run in parallel.
 257  *
 258  * If the number of threads is set to 1, there is no parallelism and this
 259  * threshold has no effect.
 260  *
 261  * @return when the number of user processes ready to run is above
 262  * this threshold, they are run in parallel
 263  */
 264 int SIMIX_context_get_parallel_threshold() {
 265   return smx_parallel_threshold;
 266 }
 267
 268 /**
 269  * @brief Sets the threshold above which user processes are run in parallel.
 270  *
 271  * If the number of threads is set to 1, there is no parallelism and this
 272  * threshold has no effect.
 273  *
 274  * @param threshold when the number of user processes ready to run is above
 275  * this threshold, they are run in parallel
 276  */
 277 void SIMIX_context_set_parallel_threshold(int threshold) {
 278   smx_parallel_threshold = threshold;
 279 }
 280
 281 /**
 282  * @brief Returns the synchronization mode used when processes are run in
 283  * parallel.
 284  * @return how threads are synchronized if processes are run in parallel
 285  */
 286 e_xbt_parmap_mode_t SIMIX_context_get_parallel_mode() {
 287   return smx_parallel_synchronization_mode;
 288 }
 289
 290 /**
 291  * @brief Sets the synchronization mode to use when processes are run in
 292  * parallel.
 293  * @param mode how to synchronize threads if processes are run in parallel
 294  */
 295 void SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode) {
 296   smx_parallel_synchronization_mode = mode;
 297 }
 298
 299 /**
 300  * @brief Returns the current context of this thread.
 301  * @return the current context of this thread
 302  */
 303 smx_context_t SIMIX_context_get_current()
 304 {
 305   if (SIMIX_context_is_parallel()) {
 306     return smx_current_context_parallel;
 307   }
 308   else {
 309     return smx_current_context_serial;
 310   }
 311 }
 312
 313 /**
 314  * @brief Sets the current context of this thread.
 315  * @param context the context to set
 316  */
 317 void SIMIX_context_set_current(smx_context_t context)
 318 {
 319   if (SIMIX_context_is_parallel()) {
 320     smx_current_context_parallel = context;
 321   }
 322   else {
 323     smx_current_context_serial = context;
 324   }
 325 }