Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
4f65ca70cbbb26191b7859dedf4a36aad5807114
[simgrid.git] / src / simix / smx_context.cpp
1 /* a fast and simple context switching library                              */
2
3 /* Copyright (c) 2009-2018. 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 "simgrid/modelchecker.h"
9 #include "src/internal_config.h"
10 #include "src/simix/smx_private.hpp"
11 #include "xbt/config.hpp"
12
13 #include <thread>
14
15 #ifdef _WIN32
16 #include <windows.h>
17 #include <malloc.h>
18 #else
19 #include <sys/mman.h>
20 #endif
21
22 #ifdef __MINGW32__
23 #define _aligned_malloc __mingw_aligned_malloc
24 #define _aligned_free  __mingw_aligned_free
25 #endif /*MINGW*/
26
27 #if HAVE_VALGRIND_H
28 # include <valgrind/valgrind.h>
29 #endif
30
31 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_context, simix, "Context switching mechanism");
32
33 static std::pair<const char*, simgrid::kernel::context::ContextFactoryInitializer> context_factories[] = {
34 #if HAVE_RAW_CONTEXTS
35   { "raw", &simgrid::kernel::context::raw_factory },
36 #endif
37 #if HAVE_UCONTEXT_CONTEXTS
38   { "ucontext", &simgrid::kernel::context::sysv_factory },
39 #endif
40 #if HAVE_BOOST_CONTEXTS
41   { "boost", &simgrid::kernel::context::boost_factory },
42 #endif
43   { "thread", &simgrid::kernel::context::thread_factory },
44 };
45
46 static_assert(sizeof(context_factories) != 0, "No context factories are enabled for this build");
47
48 // Create the list of possible contexts:
49 static inline
50 std::string contexts_list()
51 {
52   std::string res;
53   const std::size_t n = sizeof(context_factories) / sizeof(context_factories[0]);
54   for (std::size_t i = 1; i != n; ++i) {
55     res += ", ";
56     res += context_factories[i].first;
57   }
58   return res;
59 }
60
61 static simgrid::config::Flag<std::string> context_factory_name(
62   "contexts/factory",
63   (std::string("Possible values: ")+contexts_list()).c_str(),
64   context_factories[0].first);
65
66 unsigned smx_context_stack_size;
67 int smx_context_stack_size_was_set = 0;
68 unsigned smx_context_guard_size;
69 int smx_context_guard_size_was_set = 0;
70 static thread_local smx_context_t smx_current_context;
71 static int smx_parallel_contexts = 1;
72 static int smx_parallel_threshold = 2;
73 static e_xbt_parmap_mode_t smx_parallel_synchronization_mode = XBT_PARMAP_DEFAULT;
74
75 /**
76  * This function is called by SIMIX_global_init() to initialize the context module.
77  */
78 void SIMIX_context_mod_init()
79 {
80   xbt_assert(simix_global->context_factory == nullptr);
81
82   smx_context_stack_size_was_set = not simgrid::config::is_default("contexts/stack-size");
83   smx_context_guard_size_was_set = not simgrid::config::is_default("contexts/guard-size");
84
85 #if HAVE_SMPI && (defined(__APPLE__) || defined(__NetBSD__))
86   std::string priv = simgrid::config::get_value<std::string>("smpi/privatization");
87   if (context_factory_name == "thread" && (priv == "dlopen" || priv == "yes" || priv == "default" || priv == "1")) {
88     XBT_WARN("dlopen+thread broken on Apple and BSD. Switching to raw contexts.");
89     context_factory_name = "raw";
90   }
91 #endif
92
93 #if HAVE_SMPI && defined(__FreeBSD__)
94   if (context_factory_name == "thread" && simgrid::config::get_value<std::string>("smpi/privatization") != "no") {
95     XBT_WARN("mmap broken on FreeBSD, but dlopen+thread broken too. Switching to dlopen+raw contexts.");
96     context_factory_name = "raw";
97   }
98 #endif
99
100   /* select the context factory to use to create the contexts */
101   if (simgrid::kernel::context::factory_initializer != nullptr) { // Give Java a chance to hijack the factory mechanism
102     simix_global->context_factory = simgrid::kernel::context::factory_initializer();
103     return;
104   }
105   /* use the factory specified by --cfg=contexts/factory:value */
106   for (auto const& factory : context_factories)
107     if (context_factory_name == factory.first) {
108       simix_global->context_factory = factory.second();
109       break;
110     }
111
112   if (simix_global->context_factory == nullptr) {
113     XBT_ERROR("Invalid context factory specified. Valid factories on this machine:");
114 #if HAVE_RAW_CONTEXTS
115     XBT_ERROR("  raw: high performance context factory implemented specifically for SimGrid");
116 #else
117     XBT_ERROR("  (raw contexts were disabled at compilation time on this machine -- check configure logs for details)");
118 #endif
119 #if HAVE_UCONTEXT_CONTEXTS
120     XBT_ERROR("  ucontext: classical system V contexts (implemented with makecontext, swapcontext and friends)");
121 #else
122     XBT_ERROR("  (ucontext was disabled at compilation time on this machine -- check configure logs for details)");
123 #endif
124 #if HAVE_BOOST_CONTEXTS
125     XBT_ERROR("  boost: this uses the boost libraries context implementation");
126 #else
127     XBT_ERROR("  (boost was disabled at compilation time on this machine -- check configure logs for details. Did you install the libboost-context-dev package?)");
128 #endif
129     XBT_ERROR("  thread: slow portability layer using pthreads as provided by gcc");
130     xbt_die("Please use a valid factory.");
131   }
132 }
133
134 /**
135  * This function is called by SIMIX_clean() to finalize the context module.
136  */
137 void SIMIX_context_mod_exit()
138 {
139   delete simix_global->context_factory;
140   simix_global->context_factory = nullptr;
141 }
142
143 void *SIMIX_context_stack_new()
144 {
145   void *stack;
146
147   if (smx_context_guard_size > 0 && not MC_is_active()) {
148
149 #if !defined(PTH_STACKGROWTH) || (PTH_STACKGROWTH != -1)
150     xbt_die("Stack overflow protection is known to be broken on your system: you stacks grow upwards (or detection is "
151             "broken). "
152             "Please disable stack guards with --cfg=contexts:guard-size:0");
153     /* Current code for stack overflow protection assumes that stacks are growing downward (PTH_STACKGROWTH == -1).
154      * Protected pages need to be put after the stack when PTH_STACKGROWTH == 1. */
155 #endif
156
157     size_t size = smx_context_stack_size + smx_context_guard_size;
158 #if SIMGRID_HAVE_MC
159     /* Cannot use posix_memalign when SIMGRID_HAVE_MC. Align stack by hand, and save the
160      * pointer returned by xbt_malloc0. */
161     char *alloc = (char*)xbt_malloc0(size + xbt_pagesize);
162     stack = alloc - ((uintptr_t)alloc & (xbt_pagesize - 1)) + xbt_pagesize;
163     *((void **)stack - 1) = alloc;
164 #elif !defined(_WIN32)
165     if (posix_memalign(&stack, xbt_pagesize, size) != 0)
166       xbt_die("Failed to allocate stack.");
167 #else
168     stack = _aligned_malloc(size, xbt_pagesize);
169 #endif
170
171 #ifndef _WIN32
172     if (mprotect(stack, smx_context_guard_size, PROT_NONE) == -1) {
173       xbt_die(
174           "Failed to protect stack: %s.\n"
175           "If you are running a lot of actors, you may be exceeding the amount of mappings allowed per process.\n"
176           "On Linux systems, change this value with sudo sysctl -w vm.max_map_count=newvalue (default value: 65536)\n"
177           "Please see http://simgrid.gforge.inria.fr/simgrid/latest/doc/html/options.html#options_virt for more info.",
178           strerror(errno));
179       /* This is fatal. We are going to fail at some point when we try reusing this. */
180     }
181 #endif
182     stack = (char *)stack + smx_context_guard_size;
183   } else {
184     stack = xbt_malloc0(smx_context_stack_size);
185   }
186
187 #if HAVE_VALGRIND_H
188   unsigned int valgrind_stack_id = VALGRIND_STACK_REGISTER(stack, (char *)stack + smx_context_stack_size);
189   memcpy((char *)stack + smx_context_usable_stack_size, &valgrind_stack_id, sizeof valgrind_stack_id);
190 #endif
191
192   return stack;
193 }
194
195 void SIMIX_context_stack_delete(void *stack)
196 {
197   if (not stack)
198     return;
199
200 #if HAVE_VALGRIND_H
201   unsigned int valgrind_stack_id;
202   memcpy(&valgrind_stack_id, (char *)stack + smx_context_usable_stack_size, sizeof valgrind_stack_id);
203   VALGRIND_STACK_DEREGISTER(valgrind_stack_id);
204 #endif
205
206 #ifndef _WIN32
207   if (smx_context_guard_size > 0 && not MC_is_active()) {
208     stack = (char *)stack - smx_context_guard_size;
209     if (mprotect(stack, smx_context_guard_size, PROT_READ | PROT_WRITE) == -1) {
210       XBT_WARN("Failed to remove page protection: %s", strerror(errno));
211       /* try to pursue anyway */
212     }
213 #if SIMGRID_HAVE_MC
214     /* Retrieve the saved pointer.  See SIMIX_context_stack_new above. */
215     stack = *((void **)stack - 1);
216 #endif
217   }
218 #endif /* not windows */
219
220   xbt_free(stack);
221 }
222
223 /** @brief Returns whether some parallel threads are used for the user contexts. */
224 int SIMIX_context_is_parallel() {
225   return smx_parallel_contexts > 1;
226 }
227
228 /**
229  * @brief Returns the number of parallel threads used for the user contexts.
230  * @return the number of threads (1 means no parallelism)
231  */
232 int SIMIX_context_get_nthreads() {
233   return smx_parallel_contexts;
234 }
235
236 /**
237  * @brief Sets the number of parallel threads to use
238  * for the user contexts.
239  *
240  * This function should be called before initializing SIMIX.
241  * A value of 1 means no parallelism (1 thread only).
242  * If the value is greater than 1, the thread support must be enabled.
243  *
244  * @param nb_threads the number of threads to use
245  */
246 void SIMIX_context_set_nthreads(int nb_threads) {
247   if (nb_threads<=0) {
248     nb_threads = std::thread::hardware_concurrency();
249     XBT_INFO("Auto-setting contexts/nthreads to %d", nb_threads);
250   }
251   smx_parallel_contexts = nb_threads;
252 }
253
254 /**
255  * @brief Returns the threshold above which user processes are run in parallel.
256  *
257  * If the number of threads is set to 1, there is no parallelism and this
258  * threshold has no effect.
259  *
260  * @return when the number of user processes ready to run is above
261  * this threshold, they are run in parallel
262  */
263 int SIMIX_context_get_parallel_threshold() {
264   return smx_parallel_threshold;
265 }
266
267 /**
268  * @brief Sets the threshold above which user processes are run in parallel.
269  *
270  * If the number of threads is set to 1, there is no parallelism and this
271  * threshold has no effect.
272  *
273  * @param threshold when the number of user processes ready to run is above
274  * this threshold, they are run in parallel
275  */
276 void SIMIX_context_set_parallel_threshold(int threshold) {
277   smx_parallel_threshold = threshold;
278 }
279
280 /**
281  * @brief Returns the synchronization mode used when processes are run in
282  * parallel.
283  * @return how threads are synchronized if processes are run in parallel
284  */
285 e_xbt_parmap_mode_t SIMIX_context_get_parallel_mode() {
286   return smx_parallel_synchronization_mode;
287 }
288
289 /**
290  * @brief Sets the synchronization mode to use when processes are run in
291  * parallel.
292  * @param mode how to synchronize threads if processes are run in parallel
293  */
294 void SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode) {
295   smx_parallel_synchronization_mode = mode;
296 }
297
298 /**
299  * @brief Returns the current context of this thread.
300  * @return the current context of this thread
301  */
302 smx_context_t SIMIX_context_get_current()
303 {
304   return smx_current_context;
305 }
306
307 /**
308  * @brief Sets the current context of this thread.
309  * @param context the context to set
310  */
311 void SIMIX_context_set_current(smx_context_t context)
312 {
313   smx_current_context = context;
314 }