Logo AND Algorithmique Numérique Distribuée

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