src/simix/smx_context.cpp

   1 /* a fast and simple context switching library                              */
   2
   3 /* Copyright (c) 2009-2019. The SimGrid Team. All rights reserved.          */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 #include "src/internal_config.h"
   9 #include "src/simix/smx_private.hpp"
  10 #include "xbt/config.hpp"
  11
  12 #include <thread>
  13
  14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_context, simix, "Context switching mechanism");
  15
  16 static std::pair<const char*, simgrid::kernel::context::ContextFactoryInitializer> context_factories[] = {
  17 #if HAVE_RAW_CONTEXTS
  18   { "raw", &simgrid::kernel::context::raw_factory },
  19 #endif
  20 #if HAVE_UCONTEXT_CONTEXTS
  21   { "ucontext", &simgrid::kernel::context::sysv_factory },
  22 #endif
  23 #if HAVE_BOOST_CONTEXTS
  24   { "boost", &simgrid::kernel::context::boost_factory },
  25 #endif
  26   { "thread", &simgrid::kernel::context::thread_factory },
  27 };
  28
  29 static_assert(sizeof(context_factories) != 0, "No context factories are enabled for this build");
  30
  31 // Create the list of possible contexts:
  32 static inline
  33 std::string contexts_list()
  34 {
  35   std::string res;
  36   const std::size_t n = sizeof(context_factories) / sizeof(context_factories[0]);
  37   for (std::size_t i = 1; i != n; ++i) {
  38     res += ", ";
  39     res += context_factories[i].first;
  40   }
  41   return res;
  42 }
  43
  44 static simgrid::config::Flag<std::string> context_factory_name(
  45   "contexts/factory",
  46   (std::string("Possible values: ")+contexts_list()).c_str(),
  47   context_factories[0].first);
  48
  49 unsigned smx_context_stack_size;
  50 unsigned smx_context_guard_size;
  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()
  59 {
  60   xbt_assert(simix_global->context_factory == nullptr);
  61
  62 #if HAVE_SMPI && (defined(__APPLE__) || defined(__NetBSD__))
  63   std::string priv = simgrid::config::get_value<std::string>("smpi/privatization");
  64   if (context_factory_name == "thread" && (priv == "dlopen" || priv == "yes" || priv == "default" || priv == "1")) {
  65     XBT_WARN("dlopen+thread broken on Apple and BSD. Switching to raw contexts.");
  66     context_factory_name = "raw";
  67   }
  68 #endif
  69
  70 #if HAVE_SMPI && defined(__FreeBSD__)
  71   if (context_factory_name == "thread" && simgrid::config::get_value<std::string>("smpi/privatization") != "no") {
  72     XBT_WARN("mmap broken on FreeBSD, but dlopen+thread broken too. Switching to dlopen+raw contexts.");
  73     context_factory_name = "raw";
  74   }
  75 #endif
  76
  77   /* select the context factory to use to create the contexts */
  78   if (simgrid::kernel::context::factory_initializer != nullptr) { // Give Java a chance to hijack the factory mechanism
  79     simix_global->context_factory = simgrid::kernel::context::factory_initializer();
  80     return;
  81   }
  82   /* use the factory specified by --cfg=contexts/factory:value */
  83   for (auto const& factory : context_factories)
  84     if (context_factory_name == factory.first) {
  85       simix_global->context_factory = factory.second();
  86       break;
  87     }
  88
  89   if (simix_global->context_factory == nullptr) {
  90     XBT_ERROR("Invalid context factory specified. Valid factories on this machine:");
  91 #if HAVE_RAW_CONTEXTS
  92     XBT_ERROR("  raw: high performance context factory implemented specifically for SimGrid");
  93 #else
  94     XBT_ERROR("  (raw contexts were disabled at compilation time on this machine -- check configure logs for details)");
  95 #endif
  96 #if HAVE_UCONTEXT_CONTEXTS
  97     XBT_ERROR("  ucontext: classical system V contexts (implemented with makecontext, swapcontext and friends)");
  98 #else
  99     XBT_ERROR("  (ucontext was disabled at compilation time on this machine -- check configure logs for details)");
 100 #endif
 101 #if HAVE_BOOST_CONTEXTS
 102     XBT_ERROR("  boost: this uses the boost libraries context implementation");
 103 #else
 104     XBT_ERROR("  (boost was disabled at compilation time on this machine -- check configure logs for details. Did you install the libboost-context-dev package?)");
 105 #endif
 106     XBT_ERROR("  thread: slow portability layer using pthreads as provided by gcc");
 107     xbt_die("Please use a valid factory.");
 108   }
 109 }
 110
 111 /**
 112  * This function is called by SIMIX_clean() to finalize the context module.
 113  */
 114 void SIMIX_context_mod_exit()
 115 {
 116   delete simix_global->context_factory;
 117   simix_global->context_factory = nullptr;
 118 }
 119
 120 /** @brief Returns whether some parallel threads are used for the user contexts. */
 121 int SIMIX_context_is_parallel() {
 122   return smx_parallel_contexts > 1;
 123 }
 124
 125 /**
 126  * @brief Returns the number of parallel threads used for the user contexts.
 127  * @return the number of threads (1 means no parallelism)
 128  */
 129 int SIMIX_context_get_nthreads() {
 130   return smx_parallel_contexts;
 131 }
 132
 133 /**
 134  * @brief Sets the number of parallel threads to use
 135  * for the user contexts.
 136  *
 137  * This function should be called before initializing SIMIX.
 138  * A value of 1 means no parallelism (1 thread only).
 139  * If the value is greater than 1, the thread support must be enabled.
 140  *
 141  * @param nb_threads the number of threads to use
 142  */
 143 void SIMIX_context_set_nthreads(int nb_threads) {
 144   if (nb_threads<=0) {
 145     nb_threads = std::thread::hardware_concurrency();
 146     XBT_INFO("Auto-setting contexts/nthreads to %d", nb_threads);
 147   }
 148   smx_parallel_contexts = nb_threads;
 149 }
 150
 151 /**
 152  * @brief Returns the threshold above which user processes are run in parallel.
 153  *
 154  * If the number of threads is set to 1, there is no parallelism and this
 155  * threshold has no effect.
 156  *
 157  * @return when the number of user processes ready to run is above
 158  * this threshold, they are run in parallel
 159  */
 160 int SIMIX_context_get_parallel_threshold() {
 161   return smx_parallel_threshold;
 162 }
 163
 164 /**
 165  * @brief Sets the threshold above which user processes are run in parallel.
 166  *
 167  * If the number of threads is set to 1, there is no parallelism and this
 168  * threshold has no effect.
 169  *
 170  * @param threshold when the number of user processes ready to run is above
 171  * this threshold, they are run in parallel
 172  */
 173 void SIMIX_context_set_parallel_threshold(int threshold) {
 174   smx_parallel_threshold = threshold;
 175 }
 176
 177 /**
 178  * @brief Returns the synchronization mode used when processes are run in
 179  * parallel.
 180  * @return how threads are synchronized if processes are run in parallel
 181  */
 182 e_xbt_parmap_mode_t SIMIX_context_get_parallel_mode() {
 183   return smx_parallel_synchronization_mode;
 184 }
 185
 186 /**
 187  * @brief Sets the synchronization mode to use when processes are run in
 188  * parallel.
 189  * @param mode how to synchronize threads if processes are run in parallel
 190  */
 191 void SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode) {
 192   smx_parallel_synchronization_mode = mode;
 193 }