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   /* FIXME: current code for stack overflow protection assumes that stacks are
 128    * growing downward (PTH_STACKGROWTH == -1).  Protected pages need to be put
 129    * after the stack when PTH_STACKGROWTH == 1. */
 130
 131   if (smx_context_guard_size > 0 && !MC_is_active()) {
 132
 133 #if defined(_XBT_WIN32) || (PTH_STACKGROWTH != -1)
 134     static int warned_once = 0;
 135     if (!warned_once) {
 136       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).",
 137                PTH_STACKGROWTH);
 138       warned_once = 1;
 139     }
 140 #endif
 141
 142     size_t size = smx_context_stack_size + smx_context_guard_size;
 143 #ifdef HAVE_MC
 144     /* Cannot use posix_memalign when HAVE_MC. Align stack by hand, and save the
 145      * pointer returned by xbt_malloc0. */
 146     char *alloc = xbt_malloc0(size + xbt_pagesize);
 147     stack = alloc - ((uintptr_t)alloc & (xbt_pagesize - 1)) + xbt_pagesize;
 148     *((void **)stack - 1) = alloc;
 149 #elif !defined(_XBT_WIN32)
 150     if (posix_memalign(&stack, xbt_pagesize, size) != 0)
 151       xbt_die("Failed to allocate stack.");
 152 #else
 153     stack = _aligned_malloc(size, xbt_pagesize);
 154 #endif
 155
 156 #ifndef _XBT_WIN32
 157     if (mprotect(stack, smx_context_guard_size, PROT_NONE) == -1) {
 158       XBT_WARN("Failed to protect stack: %s", strerror(errno));
 159       /* That's not fatal, pursue anyway. */
 160     }
 161 #endif
 162     stack = (char *)stack + smx_context_guard_size;
 163   } else {
 164     stack = xbt_malloc0(smx_context_stack_size);
 165   }
 166
 167 #ifdef HAVE_VALGRIND_VALGRIND_H
 168   unsigned int valgrind_stack_id =
 169     VALGRIND_STACK_REGISTER(stack, (char *)stack + smx_context_stack_size);
 170   memcpy((char *)stack + smx_context_usable_stack_size, &valgrind_stack_id,
 171          sizeof valgrind_stack_id);
 172 #endif
 173
 174   return stack;
 175 }
 176
 177 void SIMIX_context_stack_delete(void *stack)
 178 {
 179   if (!stack)
 180     return;
 181
 182 #ifdef HAVE_VALGRIND_VALGRIND_H
 183   unsigned int valgrind_stack_id;
 184   memcpy(&valgrind_stack_id, (char *)stack + smx_context_usable_stack_size,
 185          sizeof valgrind_stack_id);
 186   VALGRIND_STACK_DEREGISTER(valgrind_stack_id);
 187 #endif
 188
 189 #ifndef WIN32
 190   if (smx_context_guard_size > 0 && !MC_is_active()) {
 191     stack = (char *)stack - smx_context_guard_size;
 192     if (mprotect(stack, smx_context_guard_size,
 193                  PROT_READ | PROT_WRITE | PROT_EXEC) == -1) {
 194       XBT_WARN("Failed to remove page protection: %s", strerror(errno));
 195       /* try to pursue anyway */
 196     }
 197 #ifdef HAVE_MC
 198     /* Retrieve the saved pointer.  See SIMIX_context_stack_new above. */
 199     stack = *((void **)stack - 1);
 200 #endif
 201   }
 202 #endif
 203
 204   xbt_free(stack);
 205 }
 206
 207 /**
 208  * \brief Returns whether some parallel threads are used
 209  * for the user contexts.
 210  * \return 1 if parallelism is used
 211  */
 212 XBT_INLINE int SIMIX_context_is_parallel(void) {
 213   return smx_parallel_contexts > 1;
 214 }
 215
 216 /**
 217  * \brief Returns the number of parallel threads used
 218  * for the user contexts.
 219  * \return the number of threads (1 means no parallelism)
 220  */
 221 XBT_INLINE int SIMIX_context_get_nthreads(void) {
 222   return smx_parallel_contexts;
 223 }
 224
 225 /**
 226  * \brief Sets the number of parallel threads to use
 227  * for the user contexts.
 228  *
 229  * This function should be called before initializing SIMIX.
 230  * A value of 1 means no parallelism (1 thread only).
 231  * If the value is greater than 1, the thread support must be enabled.
 232  *
 233  * \param nb_threads the number of threads to use
 234  */
 235 void SIMIX_context_set_nthreads(int nb_threads) {
 236   if (nb_threads<=0) {
 237      nb_threads = xbt_os_get_numcores();
 238      XBT_INFO("Auto-setting contexts/nthreads to %d",nb_threads);
 239   }
 240
 241   if (nb_threads > 1) {
 242 #ifndef CONTEXT_THREADS
 243     THROWF(arg_error, 0, "The thread factory cannot be run in parallel");
 244 #endif
 245   }
 246   smx_parallel_contexts = nb_threads;
 247 }
 248
 249 /**
 250  * \brief Returns the threshold above which user processes are run in parallel.
 251  *
 252  * If the number of threads is set to 1, there is no parallelism and this
 253  * threshold has no effect.
 254  *
 255  * \return when the number of user processes ready to run is above
 256  * this threshold, they are run in parallel
 257  */
 258 XBT_INLINE int SIMIX_context_get_parallel_threshold(void) {
 259   return smx_parallel_threshold;
 260 }
 261
 262 /**
 263  * \brief Sets the threshold above which user processes are run in parallel.
 264  *
 265  * If the number of threads is set to 1, there is no parallelism and this
 266  * threshold has no effect.
 267  *
 268  * \param threshold when the number of user processes ready to run is above
 269  * this threshold, they are run in parallel
 270  */
 271 XBT_INLINE void SIMIX_context_set_parallel_threshold(int threshold) {
 272   smx_parallel_threshold = threshold;
 273 }
 274
 275 /**
 276  * \brief Returns the synchronization mode used when processes are run in
 277  * parallel.
 278  * \return how threads are synchronized if processes are run in parallel
 279  */
 280 XBT_INLINE e_xbt_parmap_mode_t SIMIX_context_get_parallel_mode(void) {
 281   return smx_parallel_synchronization_mode;
 282 }
 283
 284 /**
 285  * \brief Sets the synchronization mode to use when processes are run in
 286  * parallel.
 287  * \param mode how to synchronize threads if processes are run in parallel
 288  */
 289 XBT_INLINE void SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode) {
 290   smx_parallel_synchronization_mode = mode;
 291 }
 292
 293 /**
 294  * \brief Returns the current context of this thread.
 295  * \return the current context of this thread
 296  */
 297 XBT_INLINE smx_context_t SIMIX_context_get_current(void)
 298 {
 299   if (SIMIX_context_is_parallel()) {
 300 #ifdef HAVE_THREAD_LOCAL_STORAGE
 301     return smx_current_context_parallel;
 302 #else
 303     return xbt_os_thread_get_specific(smx_current_context_key);
 304 #endif
 305   }
 306   else {
 307     return smx_current_context_serial;
 308   }
 309 }
 310
 311 /**
 312  * \brief Sets the current context of this thread.
 313  * \param context the context to set
 314  */
 315 XBT_INLINE void SIMIX_context_set_current(smx_context_t context)
 316 {
 317   if (SIMIX_context_is_parallel()) {
 318 #ifdef HAVE_THREAD_LOCAL_STORAGE
 319     smx_current_context_parallel = context;
 320 #else
 321     xbt_os_thread_set_specific(smx_current_context_key, context);
 322 #endif
 323   }
 324   else {
 325     smx_current_context_serial = context;
 326   }
 327 }