src/simix/smx_context.c

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