Logo AND Algorithmique Numérique Distribuée

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