src/simix/smx_context.cpp

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