Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[SIMIX] Updated error messages for contexts
[simgrid.git] / src / simix / smx_context.c
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 "simgrid/sg_config.h"
15 #include "src/internal_config.h"
16 #include "simgrid/modelchecker.h"
17
18
19 #ifdef _WIN32
20 #include <windows.h>
21 #include <malloc.h>
22 #else
23 #include <sys/mman.h>
24 #endif
25
26 #ifdef __MINGW32__ 
27 #define _aligned_malloc __mingw_aligned_malloc 
28 #define _aligned_free  __mingw_aligned_free 
29 #endif //MINGW
30
31 #ifdef HAVE_VALGRIND_VALGRIND_H
32 # include <valgrind/valgrind.h>
33 #endif
34
35 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_context, simix,
36                                 "Context switching mechanism");
37
38 char* smx_context_factory_name = NULL; /* factory name specified by --cfg=contexts/factory:value */
39 smx_ctx_factory_initializer_t smx_factory_initializer_to_use = NULL;
40 int smx_context_stack_size;
41 int smx_context_stack_size_was_set = 0;
42 int smx_context_guard_size;
43 int smx_context_guard_size_was_set = 0;
44 #ifdef HAVE_THREAD_LOCAL_STORAGE
45 static XBT_THREAD_LOCAL smx_context_t smx_current_context_parallel;
46 #else
47 static xbt_os_thread_key_t smx_current_context_key = 0;
48 #endif
49 static smx_context_t smx_current_context_serial;
50 static int smx_parallel_contexts = 1;
51 static int smx_parallel_threshold = 2;
52 static e_xbt_parmap_mode_t smx_parallel_synchronization_mode = XBT_PARMAP_DEFAULT;
53
54 /** 
55  * This function is called by SIMIX_global_init() to initialize the context module.
56  */
57 void SIMIX_context_mod_init(void)
58 {
59 #if defined(CONTEXT_THREADS) && !defined(HAVE_THREAD_LOCAL_STORAGE)
60   /* the __thread storage class is not available on this platform:
61    * use getspecific/setspecific instead to store the current context in each thread */
62   xbt_os_thread_key_create(&smx_current_context_key);
63 #endif
64   if (!simix_global->context_factory) {
65     /* select the context factory to use to create the contexts */
66     if (smx_factory_initializer_to_use) {
67       smx_factory_initializer_to_use(&simix_global->context_factory);
68     }
69     else { /* use the factory specified by --cfg=contexts/factory:value */
70
71
72       if (!strcmp(smx_context_factory_name, "thread")) {
73         /* use os threads (either pthreads or windows ones) */
74         SIMIX_ctx_thread_factory_init(&simix_global->context_factory);
75       }
76 #ifdef CONTEXT_UCONTEXT
77       else if (!strcmp(smx_context_factory_name, "ucontext")) {
78         /* use ucontext */
79         SIMIX_ctx_sysv_factory_init(&simix_global->context_factory);
80       }
81 #endif
82 #ifdef HAVE_RAWCTX
83       else if (!strcmp(smx_context_factory_name, "raw")) {
84         /* use raw contexts */
85         SIMIX_ctx_raw_factory_init(&simix_global->context_factory);
86       }
87 #endif
88 #ifdef HAVE_BOOST_CONTEXT
89       else if (!strcmp(smx_context_factory_name, "boost")) {
90         /* use Boost.Context */
91         SIMIX_ctx_boost_factory_init(&simix_global->context_factory);
92       }
93 #endif
94       else {
95         XBT_ERROR("Invalid context factory specified. Valid factories on this machine:");
96 #ifdef HAVE_RAWCTX
97         XBT_ERROR("  raw: high performance context factory implemented specifically for SimGrid");
98 #else
99         XBT_ERROR("  (raw contexts were disabled at compilation time on this machine -- check configure logs for details)");
100 #endif
101 #ifdef CONTEXT_UCONTEXT
102         XBT_ERROR("  ucontext: classical system V contexts (implemented with makecontext, swapcontext and friends)");
103 #else
104         XBT_ERROR("  (ucontext was disabled at compilation time on this machine -- check configure logs for details)");
105 #endif
106 #ifdef HAVE_BOOST_CONTEXT
107         XBT_ERROR("  boost: this uses the boost libraries context implementation");
108 #else
109         XBT_ERROR("  (boost was disabled at compilation time on this machine -- check configure logs for details. Did you install the libboost-context-dev package?)");
110 #endif
111         XBT_ERROR("  thread: slow portability layer using system threads (pthreads on UNIX, CreateThread() on windows)");
112         xbt_die("Please use a valid factory.");
113       }
114     }
115   }
116 }
117
118 /**
119  * This function is called by SIMIX_clean() to finalize the context module.
120  */
121 void SIMIX_context_mod_exit(void)
122 {
123   if (simix_global->context_factory) {
124     smx_pfn_context_factory_finalize_t finalize_factory;
125
126     /* finalize the context factory */
127     finalize_factory = simix_global->context_factory->finalize;
128     finalize_factory(&simix_global->context_factory);
129   }
130   xbt_dict_remove((xbt_dict_t) _sg_cfg_set,"contexts/factory");
131 }
132
133 void *SIMIX_context_stack_new(void)
134 {
135   void *stack;
136
137   /* FIXME: current code for stack overflow protection assumes that stacks are
138    * growing downward (PTH_STACKGROWTH == -1).  Protected pages need to be put
139    * after the stack when PTH_STACKGROWTH == 1. */
140
141   if (smx_context_guard_size > 0 && !MC_is_active()) {
142
143 #if defined(_XBT_WIN32) || (PTH_STACKGROWTH != -1)
144     static int warned_once = 0;
145     if (!warned_once) {
146       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).",
147                PTH_STACKGROWTH);
148       warned_once = 1;
149     }
150 #endif
151
152     size_t size = smx_context_stack_size + smx_context_guard_size;
153 #ifdef HAVE_MC
154     /* Cannot use posix_memalign when HAVE_MC. Align stack by hand, and save the
155      * pointer returned by xbt_malloc0. */
156     char *alloc = xbt_malloc0(size + xbt_pagesize);
157     stack = alloc - ((uintptr_t)alloc & (xbt_pagesize - 1)) + xbt_pagesize;
158     *((void **)stack - 1) = alloc;
159 #elif !defined(_XBT_WIN32)
160     if (posix_memalign(&stack, xbt_pagesize, size) != 0)
161       xbt_die("Failed to allocate stack.");
162 #else
163     stack = _aligned_malloc(size, xbt_pagesize);
164 #endif
165
166 #ifndef _XBT_WIN32
167     if (mprotect(stack, smx_context_guard_size, PROT_NONE) == -1) {
168       xbt_die("Failed to protect stack: %s", strerror(errno));
169       /* This is fatal. We are going to fail at some point when
170          we tryi reusing this. */
171     }
172 #endif
173     stack = (char *)stack + smx_context_guard_size;
174   } else {
175     stack = xbt_malloc0(smx_context_stack_size);
176   }
177
178 #ifdef HAVE_VALGRIND_VALGRIND_H
179   unsigned int valgrind_stack_id =
180     VALGRIND_STACK_REGISTER(stack, (char *)stack + smx_context_stack_size);
181   memcpy((char *)stack + smx_context_usable_stack_size, &valgrind_stack_id,
182          sizeof valgrind_stack_id);
183 #endif
184
185   return stack;
186 }
187
188 void SIMIX_context_stack_delete(void *stack)
189 {
190   if (!stack)
191     return;
192
193 #ifdef HAVE_VALGRIND_VALGRIND_H
194   unsigned int valgrind_stack_id;
195   memcpy(&valgrind_stack_id, (char *)stack + smx_context_usable_stack_size,
196          sizeof valgrind_stack_id);
197   VALGRIND_STACK_DEREGISTER(valgrind_stack_id);
198 #endif
199
200 #ifndef WIN32
201   if (smx_context_guard_size > 0 && !MC_is_active()) {
202     stack = (char *)stack - smx_context_guard_size;
203     if (mprotect(stack, smx_context_guard_size,
204                  PROT_READ | PROT_WRITE) == -1) {
205       XBT_WARN("Failed to remove page protection: %s", strerror(errno));
206       /* try to pursue anyway */
207     }
208 #ifdef HAVE_MC
209     /* Retrieve the saved pointer.  See SIMIX_context_stack_new above. */
210     stack = *((void **)stack - 1);
211 #endif
212   }
213 #endif
214
215   xbt_free(stack);
216 }
217
218 /**
219  * \brief Returns whether some parallel threads are used
220  * for the user contexts.
221  * \return 1 if parallelism is used
222  */
223 XBT_INLINE int SIMIX_context_is_parallel(void) {
224   return smx_parallel_contexts > 1;
225 }
226
227 /**
228  * \brief Returns the number of parallel threads used
229  * for the user contexts.
230  * \return the number of threads (1 means no parallelism)
231  */
232 XBT_INLINE int SIMIX_context_get_nthreads(void) {
233   return smx_parallel_contexts;
234 }
235
236 /**
237  * \brief Sets the number of parallel threads to use
238  * for the user contexts.
239  *
240  * This function should be called before initializing SIMIX.
241  * A value of 1 means no parallelism (1 thread only).
242  * If the value is greater than 1, the thread support must be enabled.
243  *
244  * \param nb_threads the number of threads to use
245  */
246 void SIMIX_context_set_nthreads(int nb_threads) {
247   if (nb_threads<=0) {  
248      nb_threads = xbt_os_get_numcores();
249      XBT_INFO("Auto-setting contexts/nthreads to %d",nb_threads);
250   }   
251   
252   if (nb_threads > 1) {
253 #ifndef CONTEXT_THREADS
254     THROWF(arg_error, 0, "The thread factory cannot be run in parallel");
255 #endif
256   }
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 XBT_INLINE int SIMIX_context_get_parallel_threshold(void) {
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 XBT_INLINE 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 XBT_INLINE e_xbt_parmap_mode_t SIMIX_context_get_parallel_mode(void) {
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 XBT_INLINE 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 XBT_INLINE smx_context_t SIMIX_context_get_current(void)
309 {
310   if (SIMIX_context_is_parallel()) {
311 #ifdef HAVE_THREAD_LOCAL_STORAGE
312     return smx_current_context_parallel;
313 #else
314     return xbt_os_thread_get_specific(smx_current_context_key);
315 #endif
316   }
317   else {
318     return smx_current_context_serial;
319   }
320 }
321
322 /**
323  * \brief Sets the current context of this thread.
324  * \param context the context to set
325  */
326 XBT_INLINE void SIMIX_context_set_current(smx_context_t context)
327 {
328   if (SIMIX_context_is_parallel()) {
329 #ifdef HAVE_THREAD_LOCAL_STORAGE
330     smx_current_context_parallel = context;
331 #else
332     xbt_os_thread_set_specific(smx_current_context_key, context);
333 #endif
334   }
335   else {
336     smx_current_context_serial = context;
337   }
338 }