Logo AND Algorithmique Numérique Distribuée

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