src/simix/smx_context.cpp

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