src/simix/smx_context.cpp

   1 /* a fast and simple context switching library                              */
   2
   3 /* Copyright (c) 2009-2021. 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/kernel/EngineImpl.hpp"
  10 #include "src/smpi/include/private.hpp"
  11 #include "xbt/config.hpp"
  12
  13 #include <initializer_list>
  14 #include <thread>
  15
  16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_context, simix, "Context switching mechanism");
  17
  18 constexpr std::initializer_list<std::pair<const char*, simgrid::kernel::context::ContextFactoryInitializer>>
  19     context_factories = {
  20 #if HAVE_RAW_CONTEXTS
  21         {"raw", &simgrid::kernel::context::raw_factory},
  22 #endif
  23 #if HAVE_UCONTEXT_CONTEXTS
  24         {"ucontext", &simgrid::kernel::context::sysv_factory},
  25 #endif
  26 #if HAVE_BOOST_CONTEXTS
  27         {"boost", &simgrid::kernel::context::boost_factory},
  28 #endif
  29         {"thread", &simgrid::kernel::context::thread_factory},
  30 };
  31
  32 static_assert(context_factories.size() > 0, "No context factories are enabled for this build");
  33
  34 // Create the list of possible contexts:
  35 static inline
  36 std::string contexts_list()
  37 {
  38   std::string res;
  39   std::string sep = "";
  40   for (auto const& factory : context_factories) {
  41     res += sep + factory.first;
  42     sep = ", ";
  43   }
  44   return res;
  45 }
  46
  47 static simgrid::config::Flag<std::string>
  48     context_factory_name("contexts/factory", (std::string("Possible values: ") + contexts_list()).c_str(),
  49                          context_factories.begin()->first);
  50
  51 unsigned smx_context_stack_size;
  52 unsigned smx_context_guard_size;
  53 static int smx_parallel_contexts = 1;
  54 static e_xbt_parmap_mode_t smx_parallel_synchronization_mode = XBT_PARMAP_DEFAULT;
  55
  56 /** @brief Returns whether some parallel threads are used for the user contexts. */
  57 int SIMIX_context_is_parallel() {
  58   return smx_parallel_contexts > 1;
  59 }
  60
  61 /**
  62  * @brief Returns the number of parallel threads used for the user contexts.
  63  * @return the number of threads (1 means no parallelism)
  64  */
  65 int SIMIX_context_get_nthreads() {
  66   return smx_parallel_contexts;
  67 }
  68
  69 /**
  70  * @brief Sets the number of parallel threads to use
  71  * for the user contexts.
  72  *
  73  * This function should be called before initializing SIMIX.
  74  * A value of 1 means no parallelism (1 thread only).
  75  * If the value is greater than 1, the thread support must be enabled.
  76  *
  77  * @param nb_threads the number of threads to use
  78  */
  79 void SIMIX_context_set_nthreads(int nb_threads) {
  80   if (nb_threads<=0) {
  81     nb_threads = std::thread::hardware_concurrency();
  82     XBT_INFO("Auto-setting contexts/nthreads to %d", nb_threads);
  83   }
  84   smx_parallel_contexts = nb_threads;
  85 }
  86
  87 /**
  88  * @brief Returns the synchronization mode used when processes are run in
  89  * parallel.
  90  * @return how threads are synchronized if processes are run in parallel
  91  */
  92 e_xbt_parmap_mode_t SIMIX_context_get_parallel_mode() {
  93   return smx_parallel_synchronization_mode;
  94 }
  95
  96 /**
  97  * @brief Sets the synchronization mode to use when processes are run in
  98  * parallel.
  99  * @param mode how to synchronize threads if processes are run in parallel
 100  */
 101 void SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode) {
 102   smx_parallel_synchronization_mode = mode;
 103 }
 104
 105 namespace simgrid {
 106 namespace kernel {
 107
 108 void EngineImpl::context_mod_init() const
 109 {
 110   xbt_assert(not instance_->has_context_factory());
 111
 112 #if HAVE_SMPI && (defined(__APPLE__) || defined(__NetBSD__))
 113   smpi_init_options_internal(false);
 114   std::string priv = config::get_value<std::string>("smpi/privatization");
 115   if (context_factory_name == "thread" && (priv == "dlopen" || priv == "yes" || priv == "default" || priv == "1")) {
 116     XBT_WARN("dlopen+thread broken on Apple and BSD. Switching to raw contexts.");
 117     context_factory_name = "raw";
 118   }
 119 #endif
 120
 121 #if HAVE_SMPI && defined(__FreeBSD__)
 122   smpi_init_options_internal(false);
 123   if (context_factory_name == "thread" && config::get_value<std::string>("smpi/privatization") != "no") {
 124     XBT_WARN("mmap broken on FreeBSD, but dlopen+thread broken too. Switching to dlopen+raw contexts.");
 125     context_factory_name = "raw";
 126   }
 127 #endif
 128
 129   /* select the context factory to use to create the contexts */
 130   if (context::factory_initializer != nullptr) { // Give Java a chance to hijack the factory mechanism
 131     instance_->set_context_factory(context::factory_initializer());
 132     return;
 133   }
 134   /* use the factory specified by --cfg=contexts/factory:value */
 135   for (auto const& factory : context_factories)
 136     if (context_factory_name == factory.first) {
 137       instance_->set_context_factory(factory.second());
 138       break;
 139     }
 140
 141   if (not instance_->has_context_factory()) {
 142     XBT_ERROR("Invalid context factory specified. Valid factories on this machine:");
 143 #if HAVE_RAW_CONTEXTS
 144     XBT_ERROR("  raw: high performance context factory implemented specifically for SimGrid");
 145 #else
 146     XBT_ERROR("  (raw contexts were disabled at compilation time on this machine -- check configure logs for details)");
 147 #endif
 148 #if HAVE_UCONTEXT_CONTEXTS
 149     XBT_ERROR("  ucontext: classical system V contexts (implemented with makecontext, swapcontext and friends)");
 150 #else
 151     XBT_ERROR("  (ucontext was disabled at compilation time on this machine -- check configure logs for details)");
 152 #endif
 153 #if HAVE_BOOST_CONTEXTS
 154     XBT_ERROR("  boost: this uses the boost libraries context implementation");
 155 #else
 156     XBT_ERROR("  (boost was disabled at compilation time on this machine -- check configure logs for details. Did you "
 157               "install the libboost-context-dev package?)");
 158 #endif
 159     XBT_ERROR("  thread: slow portability layer using pthreads as provided by gcc");
 160     xbt_die("Please use a valid factory.");
 161   }
 162 }
 163 } // namespace kernel
 164 } // namespace simgrid