src/simix/smx_context.c

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