Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of scm.gforge.inria.fr:/gitroot/simgrid/simgrid
[simgrid.git] / src / simix / smx_context.cpp
1 /* a fast and simple context switching library                              */
2
3 /* Copyright (c) 2009-2015. The SimGrid Team.
4  * All rights reserved.                                                     */
5
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. */
8
9 #include "src/portable.h"
10 #include "xbt/log.h"
11 #include "xbt/swag.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"
18
19
20 #ifdef _WIN32
21 #include <windows.h>
22 #include <malloc.h>
23 #else
24 #include <sys/mman.h>
25 #endif
26
27 #ifdef __MINGW32__ 
28 #define _aligned_malloc __mingw_aligned_malloc 
29 #define _aligned_free  __mingw_aligned_free 
30 #endif //MINGW
31
32 #ifdef HAVE_VALGRIND_H
33 # include <valgrind/valgrind.h>
34 #endif
35
36 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_context, simix, "Context switching mechanism");
37
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;
45 #else
46 static xbt_os_thread_key_t smx_current_context_key = 0;
47 #endif
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;
52
53 /** 
54  * This function is called by SIMIX_global_init() to initialize the context module.
55  */
56 void SIMIX_context_mod_init(void)
57 {
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);
62 #endif
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();
71 #else
72       if (0);
73 #endif
74 #ifdef HAVE_UCONTEXT_CONTEXTS
75       else if (!strcmp(smx_context_factory_name, "ucontext"))
76         simix_global->context_factory = simgrid::simix::sysv_factory();
77 #endif
78 #ifdef HAVE_RAW_CONTEXTS
79       else if (!strcmp(smx_context_factory_name, "raw"))
80         simix_global->context_factory = simgrid::simix::raw_factory();
81 #endif
82 #ifdef HAVE_BOOST_CONTEXTS
83       else if (!strcmp(smx_context_factory_name, "boost"))
84         simix_global->context_factory = simgrid::simix::boost_factory();
85 #endif
86       else {
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");
90 #else
91         XBT_ERROR("  (raw contexts were disabled at compilation time on this machine -- check configure logs for details)");
92 #endif
93 #ifdef HAVE_UCONTEXT_CONTEXTS
94         XBT_ERROR("  ucontext: classical system V contexts (implemented with makecontext, swapcontext and friends)");
95 #else
96         XBT_ERROR("  (ucontext was disabled at compilation time on this machine -- check configure logs for details)");
97 #endif
98 #ifdef HAVE_BOOST_CONTEXTS
99         XBT_ERROR("  boost: this uses the boost libraries context implementation");
100 #else
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?)");
102 #endif
103         XBT_ERROR("  thread: slow portability layer using pthreads as provided by gcc");
104         xbt_die("Please use a valid factory.");
105       }
106     }
107   }
108 }
109
110 /**
111  * This function is called by SIMIX_clean() to finalize the context module.
112  */
113 void SIMIX_context_mod_exit(void)
114 {
115   delete simix_global->context_factory;
116   simix_global->context_factory = nullptr;
117 }
118
119 void *SIMIX_context_stack_new(void)
120 {
121   void *stack;
122
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. */
126
127   if (smx_context_guard_size > 0 && !MC_is_active()) {
128
129 #if !defined(PTH_STACKGROWTH) || (PTH_STACKGROWTH != -1)
130     static int warned_once = 0;
131     if (!warned_once) {
132       XBT_WARN("Stack overflow protection is known to be broken on your system.  Either stack grows upwards, or it was not even tested properly.");
133       warned_once = 1;
134     }
135 #endif
136
137     size_t size = smx_context_stack_size + smx_context_guard_size;
138 #ifdef HAVE_MC
139     /* Cannot use posix_memalign when HAVE_MC. Align stack by hand, and save the
140      * pointer returned by xbt_malloc0. */
141     char *alloc = (char*)xbt_malloc0(size + xbt_pagesize);
142     stack = alloc - ((uintptr_t)alloc & (xbt_pagesize - 1)) + xbt_pagesize;
143     *((void **)stack - 1) = alloc;
144 #elif !defined(_WIN32)
145     if (posix_memalign(&stack, xbt_pagesize, size) != 0)
146       xbt_die("Failed to allocate stack.");
147 #else
148     stack = _aligned_malloc(size, xbt_pagesize);
149 #endif
150
151 #ifndef _WIN32
152     if (mprotect(stack, smx_context_guard_size, PROT_NONE) == -1) {
153       xbt_die("Failed to protect stack: %s", strerror(errno));
154       /* This is fatal. We are going to fail at some point when
155          we tryi reusing this. */
156     }
157 #endif
158     stack = (char *)stack + smx_context_guard_size;
159   } else {
160     stack = xbt_malloc0(smx_context_stack_size);
161   }
162
163 #ifdef HAVE_VALGRIND_H
164   unsigned int valgrind_stack_id = VALGRIND_STACK_REGISTER(stack, (char *)stack + smx_context_stack_size);
165   memcpy((char *)stack + smx_context_usable_stack_size, &valgrind_stack_id, sizeof valgrind_stack_id);
166 #endif
167
168   return stack;
169 }
170
171 void SIMIX_context_stack_delete(void *stack)
172 {
173   if (!stack)
174     return;
175
176 #ifdef HAVE_VALGRIND_H
177   unsigned int valgrind_stack_id;
178   memcpy(&valgrind_stack_id, (char *)stack + smx_context_usable_stack_size, sizeof valgrind_stack_id);
179   VALGRIND_STACK_DEREGISTER(valgrind_stack_id);
180 #endif
181
182 #ifndef _WIN32
183   if (smx_context_guard_size > 0 && !MC_is_active()) {
184     stack = (char *)stack - smx_context_guard_size;
185     if (mprotect(stack, smx_context_guard_size, PROT_READ | PROT_WRITE) == -1) {
186       XBT_WARN("Failed to remove page protection: %s", strerror(errno));
187       /* try to pursue anyway */
188     }
189 #ifdef HAVE_MC
190     /* Retrieve the saved pointer.  See SIMIX_context_stack_new above. */
191     stack = *((void **)stack - 1);
192 #endif
193   }
194 #endif /* not windows */
195
196   xbt_free(stack);
197 }
198
199 /** @brief Returns whether some parallel threads are used for the user contexts. */
200 int SIMIX_context_is_parallel(void) {
201   return smx_parallel_contexts > 1;
202 }
203
204 /**
205  * \brief Returns the number of parallel threads used
206  * for the user contexts.
207  * \return the number of threads (1 means no parallelism)
208  */
209 int SIMIX_context_get_nthreads(void) {
210   return smx_parallel_contexts;
211 }
212
213 /**
214  * \brief Sets the number of parallel threads to use
215  * for the user contexts.
216  *
217  * This function should be called before initializing SIMIX.
218  * A value of 1 means no parallelism (1 thread only).
219  * If the value is greater than 1, the thread support must be enabled.
220  *
221  * \param nb_threads the number of threads to use
222  */
223 void SIMIX_context_set_nthreads(int nb_threads) {
224   if (nb_threads<=0) {  
225      nb_threads = xbt_os_get_numcores();
226      XBT_INFO("Auto-setting contexts/nthreads to %d",nb_threads);
227   }   
228 #ifndef HAVE_THREAD_CONTEXTS
229   xbt_assert(nb_threads == 1, "Parallel runs are impossible when the pthreads are missing.");
230 #endif
231   smx_parallel_contexts = nb_threads;
232 }
233
234 /**
235  * \brief Returns the threshold above which user processes are run in parallel.
236  *
237  * If the number of threads is set to 1, there is no parallelism and this
238  * threshold has no effect.
239  *
240  * \return when the number of user processes ready to run is above
241  * this threshold, they are run in parallel
242  */
243 int SIMIX_context_get_parallel_threshold(void) {
244   return smx_parallel_threshold;
245 }
246
247 /**
248  * \brief Sets the threshold above which user processes are run in parallel.
249  *
250  * If the number of threads is set to 1, there is no parallelism and this
251  * threshold has no effect.
252  *
253  * \param threshold when the number of user processes ready to run is above
254  * this threshold, they are run in parallel
255  */
256 void SIMIX_context_set_parallel_threshold(int threshold) {
257   smx_parallel_threshold = threshold;
258 }
259
260 /**
261  * \brief Returns the synchronization mode used when processes are run in
262  * parallel.
263  * \return how threads are synchronized if processes are run in parallel
264  */
265 e_xbt_parmap_mode_t SIMIX_context_get_parallel_mode(void) {
266   return smx_parallel_synchronization_mode;
267 }
268
269 /**
270  * \brief Sets the synchronization mode to use when processes are run in
271  * parallel.
272  * \param mode how to synchronize threads if processes are run in parallel
273  */
274 void SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode) {
275   smx_parallel_synchronization_mode = mode;
276 }
277
278 /**
279  * \brief Returns the current context of this thread.
280  * \return the current context of this thread
281  */
282 smx_context_t SIMIX_context_get_current(void)
283 {
284   if (SIMIX_context_is_parallel()) {
285 #ifdef HAVE_THREAD_LOCAL_STORAGE
286     return smx_current_context_parallel;
287 #else
288     return xbt_os_thread_get_specific(smx_current_context_key);
289 #endif
290   }
291   else {
292     return smx_current_context_serial;
293   }
294 }
295
296 /**
297  * \brief Sets the current context of this thread.
298  * \param context the context to set
299  */
300 void SIMIX_context_set_current(smx_context_t context)
301 {
302   if (SIMIX_context_is_parallel()) {
303 #ifdef HAVE_THREAD_LOCAL_STORAGE
304     smx_current_context_parallel = context;
305 #else
306     xbt_os_thread_set_specific(smx_current_context_key, context);
307 #endif
308   }
309   else {
310     smx_current_context_serial = context;
311   }
312 }