src/simix/smx_context.c

   1 /* a fast and simple context switching library                              */
   2
   3 /* Copyright (c) 2009, 2010. 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 "private.h"
  13 #include "simix/context.h"
  14 #include "gras_config.h"
  15
  16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_context, simix,
  17                                 "Context switching mecanism");
  18
  19 char* smx_context_factory_name = NULL; /* factory name specified by --cfg=contexts/factory:value */
  20 smx_ctx_factory_initializer_t smx_factory_initializer_to_use = NULL;
  21 int smx_context_stack_size = 128 * 1024;
  22
  23 #ifdef CONTEXT_THREADS
  24 __thread smx_context_t smx_current_context;
  25 #else
  26 smx_context_t smx_current_context;
  27 #endif
  28
  29 static int smx_parallel_contexts = 1;
  30 static int smx_parallel_threshold = 20;
  31
  32 /**
  33  * This function is called by SIMIX_global_init() to initialize the context module.
  34  */
  35 void SIMIX_context_mod_init(void)
  36 {
  37   if (!simix_global->context_factory) {
  38     /* select the context factory to use to create the contexts */
  39     if (smx_factory_initializer_to_use) {
  40       (*smx_factory_initializer_to_use)(&(simix_global->context_factory));
  41     }
  42     else { /* use the factory specified by --cfg=contexts/factory:value */
  43       if (smx_context_factory_name == NULL || !strcmp(smx_context_factory_name, "ucontext")) {
  44         /* use ucontext */
  45         SIMIX_ctx_sysv_factory_init(&simix_global->context_factory);
  46       }
  47       else if (!strcmp(smx_context_factory_name, "thread")) {
  48         /* use os threads (either pthreads or windows ones) */
  49         SIMIX_ctx_thread_factory_init(&simix_global->context_factory);
  50       }
  51       else if (!strcmp(smx_context_factory_name, "raw")) {
  52         /* use raw contexts */
  53         SIMIX_ctx_raw_factory_init(&simix_global->context_factory);
  54       }
  55       else {
  56         xbt_die("Invalid context factory specified");
  57       }
  58     }
  59   }
  60 }
  61
  62 /**
  63  * This function is call by SIMIX_clean() to finalize the context module.
  64  */
  65 void SIMIX_context_mod_exit(void)
  66 {
  67   if (simix_global->context_factory) {
  68     smx_pfn_context_factory_finalize_t finalize_factory;
  69
  70     /* finalize the context factory */
  71     finalize_factory = simix_global->context_factory->finalize;
  72     (*finalize_factory) (&simix_global->context_factory);
  73   }
  74   xbt_dict_remove((xbt_dict_t) _surf_cfg_set,"contexts/factory");
  75 }
  76
  77 /**
  78  * \brief Sets the number of parallel threads to use
  79  * for the user contexts.
  80  *
  81  * This function should be called before initializing SIMIX.
  82  * A value of 1 means no parallelism.
  83  * If the value is greater than 1, the thread support must be enabled.
  84  *
  85  * \param nb_threads the number of threads to use
  86  */
  87 XBT_INLINE void SIMIX_context_set_nthreads(int nb_threads) {
  88
  89   xbt_assert1(nb_threads > 0, "Invalid number of parallel threads: %d", nb_threads);
  90   smx_parallel_contexts = nb_threads;
  91 }
  92
  93 /**
  94  * \brief Returns the number of parallel threads used
  95  * for the user contexts.
  96  * \return the number of threads (1 means no parallelism)
  97  */
  98 XBT_INLINE int SIMIX_context_get_nthreads(void) {
  99   return smx_parallel_contexts;
 100 }
 101
 102 /**
 103  * \brief Returns whether some parallel threads are used
 104  * for the user contexts.
 105  * \return 1 if parallelism is used
 106  */
 107 XBT_INLINE int SIMIX_context_is_parallel(void) {
 108   return smx_parallel_contexts > 1;
 109 }
 110
 111 /**
 112  * \brief Sets the threshold above which user processes are run in parallel.
 113  *
 114  * If the number of threads is set to 1, there is no parallelism and this
 115  * threshold has no effect.
 116  *
 117  * \param threshold when the number of user processes ready to run is above
 118  * this threshold, they are run in parallel
 119  */
 120 XBT_INLINE void SIMIX_context_set_parallel_threshold(int threshold) {
 121   smx_parallel_threshold = threshold;
 122 }
 123
 124 /**
 125  * \brief Returns the threshold above which user processes are run in parallel.
 126  *
 127  * If the number of threads is set to 1, there is no parallelism and this
 128  * threshold has no effect.
 129  *
 130  * \return when the number of user processes ready to run is above
 131  * this threshold, they are run in parallel
 132  */
 133 XBT_INLINE int SIMIX_context_get_parallel_threshold(void) {
 134   return smx_parallel_threshold;
 135 }
 136