1 /* a fast and simple context switching library */
3 /* Copyright (c) 2009-2015. The SimGrid Team.
4 * All rights reserved. */
6 /* This program is free software; you can redistribute it and/or modify it
7 * under the terms of the license (GNU LGPL) which comes with this package. */
9 #include "src/portable.h"
12 #include "xbt/xbt_os_thread.h"
13 #include "smx_private.h"
14 #include "smx_private.hpp"
15 #include "simgrid/sg_config.h"
16 #include "src/internal_config.h"
17 #include "simgrid/modelchecker.h"
28 #define _aligned_malloc __mingw_aligned_malloc
29 #define _aligned_free __mingw_aligned_free
32 #ifdef HAVE_VALGRIND_VALGRIND_H
33 # include <valgrind/valgrind.h>
36 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_context, simix, "Context switching mechanism");
38 char* smx_context_factory_name = NULL; /* factory name specified by --cfg=contexts/factory:value */
39 int smx_context_stack_size;
40 int smx_context_stack_size_was_set = 0;
41 int smx_context_guard_size;
42 int smx_context_guard_size_was_set = 0;
43 #ifdef HAVE_THREAD_LOCAL_STORAGE
44 static XBT_THREAD_LOCAL smx_context_t smx_current_context_parallel;
46 static xbt_os_thread_key_t smx_current_context_key = 0;
48 static smx_context_t smx_current_context_serial;
49 static int smx_parallel_contexts = 1;
50 static int smx_parallel_threshold = 2;
51 static e_xbt_parmap_mode_t smx_parallel_synchronization_mode = XBT_PARMAP_DEFAULT;
54 * This function is called by SIMIX_global_init() to initialize the context module.
56 void SIMIX_context_mod_init(void)
58 #if defined(HAVE_THREAD_CONTEXTS) && !defined(HAVE_THREAD_LOCAL_STORAGE)
59 /* the __thread storage class is not available on this platform:
60 * use getspecific/setspecific instead to store the current context in each thread */
61 xbt_os_thread_key_create(&smx_current_context_key);
63 if (!simix_global->context_factory) {
64 /* select the context factory to use to create the contexts */
65 if (simgrid::simix::factory_initializer)
66 simix_global->context_factory = simgrid::simix::factory_initializer();
67 else { /* use the factory specified by --cfg=contexts/factory:value */
68 #if defined(HAVE_THREAD_CONTEXTS)
69 if (!strcmp(smx_context_factory_name, "thread"))
70 simix_global->context_factory = simgrid::simix::thread_factory();
74 #ifdef HAVE_UCONTEXT_CONTEXTS
75 else if (!strcmp(smx_context_factory_name, "ucontext"))
76 simix_global->context_factory = simgrid::simix::sysv_factory();
78 #ifdef HAVE_RAW_CONTEXTS
79 else if (!strcmp(smx_context_factory_name, "raw"))
80 simix_global->context_factory = simgrid::simix::raw_factory();
82 #ifdef HAVE_BOOST_CONTEXTS
83 else if (!strcmp(smx_context_factory_name, "boost"))
84 simix_global->context_factory = simgrid::simix::boost_factory();
87 XBT_ERROR("Invalid context factory specified. Valid factories on this machine:");
88 #ifdef HAVE_RAW_CONTEXTS
89 XBT_ERROR(" raw: high performance context factory implemented specifically for SimGrid");
91 XBT_ERROR(" (raw contexts were disabled at compilation time on this machine -- check configure logs for details)");
93 #ifdef HAVE_UCONTEXT_CONTEXTS
94 XBT_ERROR(" ucontext: classical system V contexts (implemented with makecontext, swapcontext and friends)");
96 XBT_ERROR(" (ucontext was disabled at compilation time on this machine -- check configure logs for details)");
98 #ifdef HAVE_BOOST_CONTEXTS
99 XBT_ERROR(" boost: this uses the boost libraries context implementation");
101 XBT_ERROR(" (boost was disabled at compilation time on this machine -- check configure logs for details. Did you install the libboost-context-dev package?)");
103 XBT_ERROR(" thread: slow portability layer using pthreads as provided by gcc");
104 xbt_die("Please use a valid factory.");
111 * This function is called by SIMIX_clean() to finalize the context module.
113 void SIMIX_context_mod_exit(void)
115 delete simix_global->context_factory;
116 simix_global->context_factory = nullptr;
119 void *SIMIX_context_stack_new(void)
123 /* FIXME: current code for stack overflow protection assumes that stacks are
124 * growing downward (PTH_STACKGROWTH == -1). Protected pages need to be put
125 * after the stack when PTH_STACKGROWTH == 1. */
127 if (smx_context_guard_size > 0 && !MC_is_active()) {
129 #if !defined(PTH_STACKGROWTH) || (PTH_STACKGROWTH != -1)
130 static int warned_once = 0;
132 XBT_WARN("Stack overflow protection is known to be broken on your system. Either you're on Windows or PTH_STACKGROWTH != -1 (current value is %d).",
138 size_t size = smx_context_stack_size + smx_context_guard_size;
140 /* Cannot use posix_memalign when HAVE_MC. Align stack by hand, and save the
141 * pointer returned by xbt_malloc0. */
142 char *alloc = (char*)xbt_malloc0(size + xbt_pagesize);
143 stack = alloc - ((uintptr_t)alloc & (xbt_pagesize - 1)) + xbt_pagesize;
144 *((void **)stack - 1) = alloc;
145 #elif !defined(_WIN32)
146 if (posix_memalign(&stack, xbt_pagesize, size) != 0)
147 xbt_die("Failed to allocate stack.");
149 stack = _aligned_malloc(size, xbt_pagesize);
153 if (mprotect(stack, smx_context_guard_size, PROT_NONE) == -1) {
154 xbt_die("Failed to protect stack: %s", strerror(errno));
155 /* This is fatal. We are going to fail at some point when
156 we tryi reusing this. */
159 stack = (char *)stack + smx_context_guard_size;
161 stack = xbt_malloc0(smx_context_stack_size);
164 #ifdef HAVE_VALGRIND_VALGRIND_H
165 unsigned int valgrind_stack_id = VALGRIND_STACK_REGISTER(stack, (char *)stack + smx_context_stack_size);
166 memcpy((char *)stack + smx_context_usable_stack_size, &valgrind_stack_id, sizeof valgrind_stack_id);
172 void SIMIX_context_stack_delete(void *stack)
177 #ifdef HAVE_VALGRIND_VALGRIND_H
178 unsigned int valgrind_stack_id;
179 memcpy(&valgrind_stack_id, (char *)stack + smx_context_usable_stack_size, sizeof valgrind_stack_id);
180 VALGRIND_STACK_DEREGISTER(valgrind_stack_id);
184 if (smx_context_guard_size > 0 && !MC_is_active()) {
185 stack = (char *)stack - smx_context_guard_size;
186 if (mprotect(stack, smx_context_guard_size, PROT_READ | PROT_WRITE) == -1) {
187 XBT_WARN("Failed to remove page protection: %s", strerror(errno));
188 /* try to pursue anyway */
191 /* Retrieve the saved pointer. See SIMIX_context_stack_new above. */
192 stack = *((void **)stack - 1);
195 #endif /* not windows */
200 /** @brief Returns whether some parallel threads are used for the user contexts. */
201 int SIMIX_context_is_parallel(void) {
202 return smx_parallel_contexts > 1;
206 * \brief Returns the number of parallel threads used
207 * for the user contexts.
208 * \return the number of threads (1 means no parallelism)
210 int SIMIX_context_get_nthreads(void) {
211 return smx_parallel_contexts;
215 * \brief Sets the number of parallel threads to use
216 * for the user contexts.
218 * This function should be called before initializing SIMIX.
219 * A value of 1 means no parallelism (1 thread only).
220 * If the value is greater than 1, the thread support must be enabled.
222 * \param nb_threads the number of threads to use
224 void SIMIX_context_set_nthreads(int nb_threads) {
226 nb_threads = xbt_os_get_numcores();
227 XBT_INFO("Auto-setting contexts/nthreads to %d",nb_threads);
229 #ifndef HAVE_THREAD_CONTEXTS
230 xbt_assert(nb_threads == 1, "Parallel runs are impossible when the pthreads are missing.");
232 smx_parallel_contexts = nb_threads;
236 * \brief Returns the threshold above which user processes are run in parallel.
238 * If the number of threads is set to 1, there is no parallelism and this
239 * threshold has no effect.
241 * \return when the number of user processes ready to run is above
242 * this threshold, they are run in parallel
244 int SIMIX_context_get_parallel_threshold(void) {
245 return smx_parallel_threshold;
249 * \brief Sets the threshold above which user processes are run in parallel.
251 * If the number of threads is set to 1, there is no parallelism and this
252 * threshold has no effect.
254 * \param threshold when the number of user processes ready to run is above
255 * this threshold, they are run in parallel
257 void SIMIX_context_set_parallel_threshold(int threshold) {
258 smx_parallel_threshold = threshold;
262 * \brief Returns the synchronization mode used when processes are run in
264 * \return how threads are synchronized if processes are run in parallel
266 e_xbt_parmap_mode_t SIMIX_context_get_parallel_mode(void) {
267 return smx_parallel_synchronization_mode;
271 * \brief Sets the synchronization mode to use when processes are run in
273 * \param mode how to synchronize threads if processes are run in parallel
275 void SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode) {
276 smx_parallel_synchronization_mode = mode;
280 * \brief Returns the current context of this thread.
281 * \return the current context of this thread
283 smx_context_t SIMIX_context_get_current(void)
285 if (SIMIX_context_is_parallel()) {
286 #ifdef HAVE_THREAD_LOCAL_STORAGE
287 return smx_current_context_parallel;
289 return xbt_os_thread_get_specific(smx_current_context_key);
293 return smx_current_context_serial;
298 * \brief Sets the current context of this thread.
299 * \param context the context to set
301 void SIMIX_context_set_current(smx_context_t context)
303 if (SIMIX_context_is_parallel()) {
304 #ifdef HAVE_THREAD_LOCAL_STORAGE
305 smx_current_context_parallel = context;
307 xbt_os_thread_set_specific(smx_current_context_key, context);
311 smx_current_context_serial = context;