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
  17 #ifdef HAVE_VALGRIND_VALGRIND_H
  18 # include <valgrind/valgrind.h>
  19 #endif
  20
  21 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_context, simix,
  22                                 "Context switching mechanism");
  23
  24 char* smx_context_factory_name = NULL; /* factory name specified by --cfg=contexts/factory:value */
  25 smx_ctx_factory_initializer_t smx_factory_initializer_to_use = NULL;
  26 int smx_context_stack_size;
  27 int smx_context_stack_size_was_set = 0;
  28 #ifdef HAVE_THREAD_LOCAL_STORAGE
  29 static __thread smx_context_t smx_current_context_parallel;
  30 #else
  31 static xbt_os_thread_key_t smx_current_context_key = 0;
  32 #endif
  33 static smx_context_t smx_current_context_serial;
  34 static int smx_parallel_contexts = 1;
  35 static int smx_parallel_threshold = 2;
  36 static e_xbt_parmap_mode_t smx_parallel_synchronization_mode = XBT_PARMAP_DEFAULT;
  37
  38 /**
  39  * This function is called by SIMIX_global_init() to initialize the context module.
  40  */
  41 void SIMIX_context_mod_init(void)
  42 {
  43 #if defined(CONTEXT_THREADS) && !defined(HAVE_THREAD_LOCAL_STORAGE)
  44   /* the __thread storage class is not available on this platform:
  45    * use getspecific/setspecific instead to store the current context in each thread */
  46   xbt_os_thread_key_create(&smx_current_context_key);
  47 #endif
  48   if (!simix_global->context_factory) {
  49     /* select the context factory to use to create the contexts */
  50     if (smx_factory_initializer_to_use) {
  51       smx_factory_initializer_to_use(&simix_global->context_factory);
  52     }
  53     else { /* use the factory specified by --cfg=contexts/factory:value */
  54
  55
  56       if (!strcmp(smx_context_factory_name, "thread")) {
  57         /* use os threads (either pthreads or windows ones) */
  58         SIMIX_ctx_thread_factory_init(&simix_global->context_factory);
  59       }
  60 #ifdef CONTEXT_UCONTEXT
  61       else if (!strcmp(smx_context_factory_name, "ucontext")) {
  62         /* use ucontext */
  63         SIMIX_ctx_sysv_factory_init(&simix_global->context_factory);
  64       }
  65 #endif
  66 #ifdef HAVE_RAWCTX
  67       else if (!strcmp(smx_context_factory_name, "raw")) {
  68         /* use raw contexts */
  69         SIMIX_ctx_raw_factory_init(&simix_global->context_factory);
  70       }
  71 #endif
  72       else {
  73         XBT_ERROR("Invalid context factory specified. Valid factories on this machine:");
  74 #ifdef HAVE_RAWCTX
  75         XBT_ERROR("  raw: high performance context factory implemented specifically for SimGrid");
  76 #else
  77         XBT_ERROR("  (raw contexts are disabled at compilation time on this machine -- check configure logs for details)");
  78 #endif
  79 #ifdef CONTEXT_UCONTEXT
  80         XBT_ERROR("  ucontext: classical system V contexts (implemented with makecontext, swapcontext and friends)");
  81 #else
  82         XBT_ERROR("  (ucontext is disabled at compilation time on this machine -- check configure logs for details)");
  83 #endif
  84         XBT_ERROR("  thread: slow portability layer using system threads (pthreads on UNIX, CreateThread() on windows)");
  85         xbt_die("Please use a valid factory.");
  86       }
  87     }
  88   }
  89 }
  90
  91 /**
  92  * This function is called by SIMIX_clean() to finalize the context module.
  93  */
  94 void SIMIX_context_mod_exit(void)
  95 {
  96   if (simix_global->context_factory) {
  97     smx_pfn_context_factory_finalize_t finalize_factory;
  98
  99     /* finalize the context factory */
 100     finalize_factory = simix_global->context_factory->finalize;
 101     finalize_factory(&simix_global->context_factory);
 102   }
 103   xbt_dict_remove((xbt_dict_t) _sg_cfg_set,"contexts/factory");
 104 }
 105
 106 void *SIMIX_context_stack_new(void)
 107 {
 108   void *stack = xbt_malloc0(smx_context_stack_size);
 109
 110 #ifdef HAVE_VALGRIND_VALGRIND_H
 111   unsigned int valgrind_stack_id =
 112     VALGRIND_STACK_REGISTER(stack, (char *)stack + smx_context_stack_size);
 113   memcpy((char *)stack + smx_context_usable_stack_size, &valgrind_stack_id,
 114          sizeof valgrind_stack_id);
 115 #endif
 116
 117   return stack;
 118 }
 119
 120 void SIMIX_context_stack_delete(void *stack)
 121 {
 122   if (!stack)
 123     return;
 124
 125 #ifdef HAVE_VALGRIND_VALGRIND_H
 126   unsigned int valgrind_stack_id;
 127   memcpy(&valgrind_stack_id, (char *)stack + smx_context_usable_stack_size,
 128          sizeof valgrind_stack_id);
 129   VALGRIND_STACK_DEREGISTER(valgrind_stack_id);
 130 #endif
 131
 132   xbt_free(stack);
 133 }
 134
 135 /**
 136  * \brief Returns whether some parallel threads are used
 137  * for the user contexts.
 138  * \return 1 if parallelism is used
 139  */
 140 XBT_INLINE int SIMIX_context_is_parallel(void) {
 141   return smx_parallel_contexts > 1;
 142 }
 143
 144 /**
 145  * \brief Returns the number of parallel threads used
 146  * for the user contexts.
 147  * \return the number of threads (1 means no parallelism)
 148  */
 149 XBT_INLINE int SIMIX_context_get_nthreads(void) {
 150   return smx_parallel_contexts;
 151 }
 152
 153 /**
 154  * \brief Sets the number of parallel threads to use
 155  * for the user contexts.
 156  *
 157  * This function should be called before initializing SIMIX.
 158  * A value of 1 means no parallelism (1 thread only).
 159  * If the value is greater than 1, the thread support must be enabled.
 160  *
 161  * \param nb_threads the number of threads to use
 162  */
 163 void SIMIX_context_set_nthreads(int nb_threads) {
 164   if (nb_threads<=0) {
 165      nb_threads = xbt_os_get_numcores();
 166      XBT_INFO("Auto-setting contexts/nthreads to %d",nb_threads);
 167   }
 168
 169   if (nb_threads > 1) {
 170 #ifndef CONTEXT_THREADS
 171     THROWF(arg_error, 0, "The thread factory cannot be run in parallel");
 172 #endif
 173   }
 174   smx_parallel_contexts = nb_threads;
 175 }
 176
 177 /**
 178  * \brief Returns the threshold above which user processes are run in parallel.
 179  *
 180  * If the number of threads is set to 1, there is no parallelism and this
 181  * threshold has no effect.
 182  *
 183  * \return when the number of user processes ready to run is above
 184  * this threshold, they are run in parallel
 185  */
 186 XBT_INLINE int SIMIX_context_get_parallel_threshold(void) {
 187   return smx_parallel_threshold;
 188 }
 189
 190 /**
 191  * \brief Sets the threshold above which user processes are run in parallel.
 192  *
 193  * If the number of threads is set to 1, there is no parallelism and this
 194  * threshold has no effect.
 195  *
 196  * \param threshold when the number of user processes ready to run is above
 197  * this threshold, they are run in parallel
 198  */
 199 XBT_INLINE void SIMIX_context_set_parallel_threshold(int threshold) {
 200   smx_parallel_threshold = threshold;
 201 }
 202
 203 /**
 204  * \brief Returns the synchronization mode used when processes are run in
 205  * parallel.
 206  * \return how threads are synchronized if processes are run in parallel
 207  */
 208 XBT_INLINE e_xbt_parmap_mode_t SIMIX_context_get_parallel_mode(void) {
 209   return smx_parallel_synchronization_mode;
 210 }
 211
 212 /**
 213  * \brief Sets the synchronization mode to use when processes are run in
 214  * parallel.
 215  * \param mode how to synchronize threads if processes are run in parallel
 216  */
 217 XBT_INLINE void SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode) {
 218   smx_parallel_synchronization_mode = mode;
 219 }
 220
 221 /**
 222  * \brief Returns the current context of this thread.
 223  * \return the current context of this thread
 224  */
 225 XBT_INLINE smx_context_t SIMIX_context_get_current(void)
 226 {
 227   if (SIMIX_context_is_parallel()) {
 228 #ifdef HAVE_THREAD_LOCAL_STORAGE
 229     return smx_current_context_parallel;
 230 #else
 231     return xbt_os_thread_get_specific(smx_current_context_key);
 232 #endif
 233   }
 234   else {
 235     return smx_current_context_serial;
 236   }
 237 }
 238
 239 /**
 240  * \brief Sets the current context of this thread.
 241  * \param context the context to set
 242  */
 243 XBT_INLINE void SIMIX_context_set_current(smx_context_t context)
 244 {
 245   if (SIMIX_context_is_parallel()) {
 246 #ifdef HAVE_THREAD_LOCAL_STORAGE
 247     smx_current_context_parallel = context;
 248 #else
 249     xbt_os_thread_set_specific(smx_current_context_key, context);
 250 #endif
 251   }
 252   else {
 253     smx_current_context_serial = context;
 254   }
 255 }