Logo AND Algorithmique Numérique Distribuée

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