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/simix/smx_private.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 /**
  57  * This function is called by SIMIX_global_init() to initialize the context module.
  58  */
  59 void SIMIX_context_mod_init()
  60 {
  61   xbt_assert(not simix_global->has_context_factory());
  62
  63 #if HAVE_SMPI && (defined(__APPLE__) || defined(__NetBSD__))
  64   smpi_init_options_internal(false);
  65   std::string priv = simgrid::config::get_value<std::string>("smpi/privatization");
  66   if (context_factory_name == "thread" && (priv == "dlopen" || priv == "yes" || priv == "default" || priv == "1")) {
  67     XBT_WARN("dlopen+thread broken on Apple and BSD. Switching to raw contexts.");
  68     context_factory_name = "raw";
  69   }
  70 #endif
  71
  72 #if HAVE_SMPI && defined(__FreeBSD__)
  73   smpi_init_options_internal(false);
  74   if (context_factory_name == "thread" && simgrid::config::get_value<std::string>("smpi/privatization") != "no") {
  75     XBT_WARN("mmap broken on FreeBSD, but dlopen+thread broken too. Switching to dlopen+raw contexts.");
  76     context_factory_name = "raw";
  77   }
  78 #endif
  79
  80   /* select the context factory to use to create the contexts */
  81   if (simgrid::kernel::context::factory_initializer != nullptr) { // Give Java a chance to hijack the factory mechanism
  82     simix_global->set_context_factory(simgrid::kernel::context::factory_initializer());
  83     return;
  84   }
  85   /* use the factory specified by --cfg=contexts/factory:value */
  86   for (auto const& factory : context_factories)
  87     if (context_factory_name == factory.first) {
  88       simix_global->set_context_factory(factory.second());
  89       break;
  90     }
  91
  92   if (not simix_global->has_context_factory()) {
  93     XBT_ERROR("Invalid context factory specified. Valid factories on this machine:");
  94 #if HAVE_RAW_CONTEXTS
  95     XBT_ERROR("  raw: high performance context factory implemented specifically for SimGrid");
  96 #else
  97     XBT_ERROR("  (raw contexts were disabled at compilation time on this machine -- check configure logs for details)");
  98 #endif
  99 #if HAVE_UCONTEXT_CONTEXTS
 100     XBT_ERROR("  ucontext: classical system V contexts (implemented with makecontext, swapcontext and friends)");
 101 #else
 102     XBT_ERROR("  (ucontext was disabled at compilation time on this machine -- check configure logs for details)");
 103 #endif
 104 #if HAVE_BOOST_CONTEXTS
 105     XBT_ERROR("  boost: this uses the boost libraries context implementation");
 106 #else
 107     XBT_ERROR("  (boost was disabled at compilation time on this machine -- check configure logs for details. Did you install the libboost-context-dev package?)");
 108 #endif
 109     XBT_ERROR("  thread: slow portability layer using pthreads as provided by gcc");
 110     xbt_die("Please use a valid factory.");
 111   }
 112 }
 113
 114 /** @brief Returns whether some parallel threads are used for the user contexts. */
 115 int SIMIX_context_is_parallel() {
 116   return smx_parallel_contexts > 1;
 117 }
 118
 119 /**
 120  * @brief Returns the number of parallel threads used for the user contexts.
 121  * @return the number of threads (1 means no parallelism)
 122  */
 123 int SIMIX_context_get_nthreads() {
 124   return smx_parallel_contexts;
 125 }
 126
 127 /**
 128  * @brief Sets the number of parallel threads to use
 129  * for the user contexts.
 130  *
 131  * This function should be called before initializing SIMIX.
 132  * A value of 1 means no parallelism (1 thread only).
 133  * If the value is greater than 1, the thread support must be enabled.
 134  *
 135  * @param nb_threads the number of threads to use
 136  */
 137 void SIMIX_context_set_nthreads(int nb_threads) {
 138   if (nb_threads<=0) {
 139     nb_threads = std::thread::hardware_concurrency();
 140     XBT_INFO("Auto-setting contexts/nthreads to %d", nb_threads);
 141   }
 142   smx_parallel_contexts = nb_threads;
 143 }
 144
 145 /**
 146  * @brief Returns the synchronization mode used when processes are run in
 147  * parallel.
 148  * @return how threads are synchronized if processes are run in parallel
 149  */
 150 e_xbt_parmap_mode_t SIMIX_context_get_parallel_mode() {
 151   return smx_parallel_synchronization_mode;
 152 }
 153
 154 /**
 155  * @brief Sets the synchronization mode to use when processes are run in
 156  * parallel.
 157  * @param mode how to synchronize threads if processes are run in parallel
 158  */
 159 void SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode) {
 160   smx_parallel_synchronization_mode = mode;
 161 }