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 <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.hpp"
  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 static thread_local smx_context_t smx_current_context_parallel;
  84 static smx_context_t smx_current_context_serial;
  85 static int smx_parallel_contexts = 1;
  86 static int smx_parallel_threshold = 2;
  87 static e_xbt_parmap_mode_t smx_parallel_synchronization_mode = XBT_PARMAP_DEFAULT;
  88
  89 /**
  90  * This function is called by SIMIX_global_init() to initialize the context module.
  91  */
  92 void SIMIX_context_mod_init()
  93 {
  94   xbt_assert(simix_global->context_factory == nullptr);
  95
  96   smx_context_stack_size_was_set = not simgrid::config::is_default("contexts/stack-size");
  97   smx_context_guard_size_was_set = not simgrid::config::is_default("contexts/guard-size");
  98
  99 #if HAVE_SMPI && (defined(__APPLE__) || defined(__NetBSD__))
 100   std::string priv = simgrid::config::get_value<std::string>("smpi/privatization");
 101   if (context_factory_name == "thread" && (priv == "dlopen" || priv == "yes" || priv == "default" || priv == "1")) {
 102     XBT_WARN("dlopen+thread broken on Apple and BSD. Switching to raw contexts.");
 103     context_factory_name = "raw";
 104   }
 105 #endif
 106
 107 #if HAVE_SMPI && defined(__FreeBSD__)
 108   if (context_factory_name == "thread" && simgrid::config::get_value<std::string>("smpi/privatization") != "no") {
 109     XBT_WARN("mmap broken on FreeBSD, but dlopen+thread broken too. Switching to dlopen+raw contexts.");
 110     context_factory_name = "raw";
 111   }
 112 #endif
 113
 114   /* select the context factory to use to create the contexts */
 115   if (simgrid::kernel::context::factory_initializer) { // Give Java a chance to hijack the factory mechanism
 116     simix_global->context_factory = simgrid::kernel::context::factory_initializer();
 117     return;
 118   }
 119   /* use the factory specified by --cfg=contexts/factory:value */
 120   for (auto const& factory : context_factories)
 121     if (context_factory_name == factory.first) {
 122       simix_global->context_factory = factory.second();
 123       break;
 124     }
 125
 126   if (simix_global->context_factory == nullptr) {
 127     XBT_ERROR("Invalid context factory specified. Valid factories on this machine:");
 128 #if HAVE_RAW_CONTEXTS
 129     XBT_ERROR("  raw: high performance context factory implemented specifically for SimGrid");
 130 #else
 131     XBT_ERROR("  (raw contexts were disabled at compilation time on this machine -- check configure logs for details)");
 132 #endif
 133 #if HAVE_UCONTEXT_CONTEXTS
 134     XBT_ERROR("  ucontext: classical system V contexts (implemented with makecontext, swapcontext and friends)");
 135 #else
 136     XBT_ERROR("  (ucontext was disabled at compilation time on this machine -- check configure logs for details)");
 137 #endif
 138 #if HAVE_BOOST_CONTEXTS
 139     XBT_ERROR("  boost: this uses the boost libraries context implementation");
 140 #else
 141     XBT_ERROR("  (boost was disabled at compilation time on this machine -- check configure logs for details. Did you install the libboost-context-dev package?)");
 142 #endif
 143     XBT_ERROR("  thread: slow portability layer using pthreads as provided by gcc");
 144     xbt_die("Please use a valid factory.");
 145   }
 146 }
 147
 148 /**
 149  * This function is called by SIMIX_clean() to finalize the context module.
 150  */
 151 void SIMIX_context_mod_exit()
 152 {
 153   delete simix_global->context_factory;
 154   simix_global->context_factory = nullptr;
 155 }
 156
 157 void *SIMIX_context_stack_new()
 158 {
 159   void *stack;
 160
 161   if (smx_context_guard_size > 0 && not MC_is_active()) {
 162
 163 #if !defined(PTH_STACKGROWTH) || (PTH_STACKGROWTH != -1)
 164     xbt_die("Stack overflow protection is known to be broken on your system: you stacks grow upwards (or detection is "
 165             "broken). "
 166             "Please disable stack guards with --cfg=contexts:guard-size:0");
 167     /* Current code for stack overflow protection assumes that stacks are growing downward (PTH_STACKGROWTH == -1).
 168      * Protected pages need to be put after the stack when PTH_STACKGROWTH == 1. */
 169 #endif
 170
 171     size_t size = smx_context_stack_size + smx_context_guard_size;
 172 #if SIMGRID_HAVE_MC
 173     /* Cannot use posix_memalign when SIMGRID_HAVE_MC. Align stack by hand, and save the
 174      * pointer returned by xbt_malloc0. */
 175     char *alloc = (char*)xbt_malloc0(size + xbt_pagesize);
 176     stack = alloc - ((uintptr_t)alloc & (xbt_pagesize - 1)) + xbt_pagesize;
 177     *((void **)stack - 1) = alloc;
 178 #elif !defined(_WIN32)
 179     if (posix_memalign(&stack, xbt_pagesize, size) != 0)
 180       xbt_die("Failed to allocate stack.");
 181 #else
 182     stack = _aligned_malloc(size, xbt_pagesize);
 183 #endif
 184
 185 #ifndef _WIN32
 186     if (mprotect(stack, smx_context_guard_size, PROT_NONE) == -1) {
 187       xbt_die(
 188           "Failed to protect stack: %s.\n"
 189           "If you are running a lot of actors, you may be exceeding the amount of mappings allowed per process.\n"
 190           "On Linux systems, change this value with sudo sysctl -w vm.max_map_count=newvalue (default value: 65536)\n"
 191           "Please see http://simgrid.gforge.inria.fr/simgrid/latest/doc/html/options.html#options_virt for more info.",
 192           strerror(errno));
 193       /* This is fatal. We are going to fail at some point when we try reusing this. */
 194     }
 195 #endif
 196     stack = (char *)stack + smx_context_guard_size;
 197   } else {
 198     stack = xbt_malloc0(smx_context_stack_size);
 199   }
 200
 201 #if HAVE_VALGRIND_H
 202   unsigned int valgrind_stack_id = VALGRIND_STACK_REGISTER(stack, (char *)stack + smx_context_stack_size);
 203   memcpy((char *)stack + smx_context_usable_stack_size, &valgrind_stack_id, sizeof valgrind_stack_id);
 204 #endif
 205
 206   return stack;
 207 }
 208
 209 void SIMIX_context_stack_delete(void *stack)
 210 {
 211   if (not stack)
 212     return;
 213
 214 #if HAVE_VALGRIND_H
 215   unsigned int valgrind_stack_id;
 216   memcpy(&valgrind_stack_id, (char *)stack + smx_context_usable_stack_size, sizeof valgrind_stack_id);
 217   VALGRIND_STACK_DEREGISTER(valgrind_stack_id);
 218 #endif
 219
 220 #ifndef _WIN32
 221   if (smx_context_guard_size > 0 && not MC_is_active()) {
 222     stack = (char *)stack - smx_context_guard_size;
 223     if (mprotect(stack, smx_context_guard_size, PROT_READ | PROT_WRITE) == -1) {
 224       XBT_WARN("Failed to remove page protection: %s", strerror(errno));
 225       /* try to pursue anyway */
 226     }
 227 #if SIMGRID_HAVE_MC
 228     /* Retrieve the saved pointer.  See SIMIX_context_stack_new above. */
 229     stack = *((void **)stack - 1);
 230 #endif
 231   }
 232 #endif /* not windows */
 233
 234   xbt_free(stack);
 235 }
 236
 237 /** @brief Returns whether some parallel threads are used for the user contexts. */
 238 int SIMIX_context_is_parallel() {
 239   return smx_parallel_contexts > 1;
 240 }
 241
 242 /**
 243  * @brief Returns the number of parallel threads used for the user contexts.
 244  * @return the number of threads (1 means no parallelism)
 245  */
 246 int SIMIX_context_get_nthreads() {
 247   return smx_parallel_contexts;
 248 }
 249
 250 /**
 251  * @brief Sets the number of parallel threads to use
 252  * for the user contexts.
 253  *
 254  * This function should be called before initializing SIMIX.
 255  * A value of 1 means no parallelism (1 thread only).
 256  * If the value is greater than 1, the thread support must be enabled.
 257  *
 258  * @param nb_threads the number of threads to use
 259  */
 260 void SIMIX_context_set_nthreads(int nb_threads) {
 261   if (nb_threads<=0) {
 262      nb_threads = xbt_os_get_numcores();
 263      XBT_INFO("Auto-setting contexts/nthreads to %d",nb_threads);
 264   }
 265 #if !HAVE_THREAD_CONTEXTS
 266   xbt_assert(nb_threads == 1, "Parallel runs are impossible when the pthreads are missing.");
 267 #endif
 268   smx_parallel_contexts = nb_threads;
 269 }
 270
 271 /**
 272  * @brief Returns the threshold above which user processes are run in parallel.
 273  *
 274  * If the number of threads is set to 1, there is no parallelism and this
 275  * threshold has no effect.
 276  *
 277  * @return when the number of user processes ready to run is above
 278  * this threshold, they are run in parallel
 279  */
 280 int SIMIX_context_get_parallel_threshold() {
 281   return smx_parallel_threshold;
 282 }
 283
 284 /**
 285  * @brief Sets the threshold above which user processes are run in parallel.
 286  *
 287  * If the number of threads is set to 1, there is no parallelism and this
 288  * threshold has no effect.
 289  *
 290  * @param threshold when the number of user processes ready to run is above
 291  * this threshold, they are run in parallel
 292  */
 293 void SIMIX_context_set_parallel_threshold(int threshold) {
 294   smx_parallel_threshold = threshold;
 295 }
 296
 297 /**
 298  * @brief Returns the synchronization mode used when processes are run in
 299  * parallel.
 300  * @return how threads are synchronized if processes are run in parallel
 301  */
 302 e_xbt_parmap_mode_t SIMIX_context_get_parallel_mode() {
 303   return smx_parallel_synchronization_mode;
 304 }
 305
 306 /**
 307  * @brief Sets the synchronization mode to use when processes are run in
 308  * parallel.
 309  * @param mode how to synchronize threads if processes are run in parallel
 310  */
 311 void SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode) {
 312   smx_parallel_synchronization_mode = mode;
 313 }
 314
 315 /**
 316  * @brief Returns the current context of this thread.
 317  * @return the current context of this thread
 318  */
 319 smx_context_t SIMIX_context_get_current()
 320 {
 321   if (SIMIX_context_is_parallel()) {
 322     return smx_current_context_parallel;
 323   }
 324   else {
 325     return smx_current_context_serial;
 326   }
 327 }
 328
 329 /**
 330  * @brief Sets the current context of this thread.
 331  * @param context the context to set
 332  */
 333 void SIMIX_context_set_current(smx_context_t context)
 334 {
 335   if (SIMIX_context_is_parallel()) {
 336     smx_current_context_parallel = context;
 337   }
 338   else {
 339     smx_current_context_serial = context;
 340   }
 341 }