Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
model-checker : break forgotten in switch
[simgrid.git] / src / simix / smx_context.c
1 /* a fast and simple context switching library                              */
2
3 /* Copyright (c) 2009 - 2011. 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 "portable.h"
10 #include "xbt/log.h"
11 #include "xbt/swag.h"
12 #include "xbt/xbt_os_thread.h"
13 #include "src/simix/private.h"
14 #include "simix/context.h"
15 #include "gras_config.h"
16
17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_context, simix,
18                                 "Context switching mecanism");
19
20 char* smx_context_factory_name = NULL; /* factory name specified by --cfg=contexts/factory:value */
21 smx_ctx_factory_initializer_t smx_factory_initializer_to_use = NULL;
22 int smx_context_stack_size = 128 * 1024;
23
24 #ifdef HAVE_THREAD_LOCAL_STORAGE
25 static __thread smx_context_t smx_current_context_parallel;
26 #else
27 static xbt_os_thread_key_t smx_current_context_key = 0;
28 #endif
29 static smx_context_t smx_current_context_serial;
30 static int smx_parallel_contexts = 1;
31 static int smx_parallel_threshold = 2;
32
33 /** 
34  * This function is called by SIMIX_global_init() to initialize the context module.
35  */
36 void SIMIX_context_mod_init(void)
37 {
38   if (!simix_global->context_factory) {
39     /* select the context factory to use to create the contexts */
40     if (smx_factory_initializer_to_use) {
41       smx_factory_initializer_to_use(&simix_global->context_factory);
42     }
43     else { /* use the factory specified by --cfg=contexts/factory:value */
44
45     if (smx_context_factory_name == NULL) {
46         /* use the default factory */
47         #ifdef HAVE_RAWCTX
48         SIMIX_ctx_raw_factory_init(&simix_global->context_factory);
49         #elif CONTEXT_UCONTEXT
50                 SIMIX_ctx_sysv_factory_init(&simix_global->context_factory);
51         #else
52                 SIMIX_ctx_thread_factory_init(&simix_global->context_factory);
53         #endif
54     }
55     else if (!strcmp(smx_context_factory_name, "ucontext")) {
56         /* use ucontext */
57 #ifdef CONTEXT_UCONTEXT
58         SIMIX_ctx_sysv_factory_init(&simix_global->context_factory);
59 #else
60         xbt_die("The context factory 'ucontext' unavailable on your system");
61 #endif
62       }
63       else if (!strcmp(smx_context_factory_name, "thread")) {
64         /* use os threads (either pthreads or windows ones) */
65         SIMIX_ctx_thread_factory_init(&simix_global->context_factory);
66       }
67       else if (!strcmp(smx_context_factory_name, "raw")) {
68         /* use raw contexts */
69         SIMIX_ctx_raw_factory_init(&simix_global->context_factory);
70       }
71       else {
72         XBT_ERROR("Invalid context factory specified. Valid factories on this machine:");
73 #ifdef HAVE_RAWCTX
74         XBT_ERROR("  raw: high performance context factory implemented specifically for SimGrid");
75 #else
76         XBT_ERROR("  (raw contextes are disabled at compilation time on this machine -- check configure logs for details)");
77 #endif
78 #ifdef CONTEXT_UCONTEXT
79         XBT_ERROR("  ucontext: classical system V contextes (implemented with makecontext, swapcontext and friends)");
80 #else
81         XBT_ERROR("  (ucontext is disabled at compilation time on this machine -- check configure logs for details)");
82 #endif
83         XBT_ERROR("  thread: slow portability layer using system threads (pthreads on UNIX, CreateThread() on windows)");
84         xbt_die("Please use a valid factory.");
85       }
86     }
87   }
88
89 #if defined(CONTEXT_THREADS) && !defined(HAVE_THREAD_LOCAL_STORAGE)
90   /* the __thread storage class is not available on this platform:
91    * use getspecific/setspecific instead to store the current context in each thread */
92   xbt_os_thread_key_create(&smx_current_context_key);
93 #endif
94 }
95
96 /**
97  * This function is call by SIMIX_clean() to finalize the context module.
98  */
99 void SIMIX_context_mod_exit(void)
100 {
101   if (simix_global->context_factory) {
102     smx_pfn_context_factory_finalize_t finalize_factory;
103
104     /* finalize the context factory */
105     finalize_factory = simix_global->context_factory->finalize;
106     finalize_factory(&simix_global->context_factory);
107   }
108   xbt_dict_remove((xbt_dict_t) _surf_cfg_set,"contexts/factory");
109 }
110
111 /**
112  * \brief Returns whether some parallel threads are used
113  * for the user contexts.
114  * \return 1 if parallelism is used
115  */
116 XBT_INLINE int SIMIX_context_is_parallel(void) {
117   return smx_parallel_contexts > 1;
118 }
119
120 /**
121  * \brief Returns the number of parallel threads used
122  * for the user contexts.
123  * \return the number of threads (1 means no parallelism)
124  */
125 XBT_INLINE int SIMIX_context_get_nthreads(void) {
126   return smx_parallel_contexts;
127 }
128
129 /**
130  * \brief Sets the number of parallel threads to use
131  * for the user contexts.
132  *
133  * This function should be called before initializing SIMIX.
134  * A value of 1 means no parallelism.
135  * If the value is greater than 1, the thread support must be enabled.
136  *
137  * \param nb_threads the number of threads to use
138  */
139 XBT_INLINE void SIMIX_context_set_nthreads(int nb_threads) {
140
141   xbt_assert(nb_threads > 0, "Invalid number of parallel threads: %d", nb_threads);
142
143   if (nb_threads > 1) {
144 #ifndef CONTEXT_THREADS
145     THROWF(arg_error, 0, "The thread factory cannot be run in parallel");
146 #endif
147   }
148
149   smx_parallel_contexts = nb_threads;
150 }
151
152 /**
153  * \brief Returns the threshold above which user processes are run in parallel.
154  *
155  * If the number of threads is set to 1, there is no parallelism and this
156  * threshold has no effect.
157  *
158  * \return when the number of user processes ready to run is above
159  * this threshold, they are run in parallel
160  */
161 XBT_INLINE int SIMIX_context_get_parallel_threshold(void) {
162   return smx_parallel_threshold;
163 }
164
165 /**
166  * \brief Sets the threshold above which user processes are run in parallel.
167  *
168  * If the number of threads is set to 1, there is no parallelism and this
169  * threshold has no effect.
170  *
171  * \param threshold when the number of user processes ready to run is above
172  * this threshold, they are run in parallel
173  */
174 XBT_INLINE void SIMIX_context_set_parallel_threshold(int threshold) {
175   smx_parallel_threshold = threshold;
176 }
177
178 /**
179  * \brief Returns the synchronization mode used when processes are run in
180  * parallel.
181  * \return how threads are synchronized if processes are run in parallel
182  */
183 XBT_INLINE e_xbt_parmap_mode_t SIMIX_context_get_parallel_mode(void) {
184   e_xbt_parmap_mode_t mode = XBT_PARMAP_FUTEX;
185   const char* mode_name = xbt_cfg_get_string(_surf_cfg_set, "contexts/synchro");
186   if (!strcmp(mode_name, "posix")) {
187           mode = XBT_PARMAP_POSIX;
188   }
189   else if (!strcmp(mode_name, "futex")) {
190           mode = XBT_PARMAP_FUTEX;
191   }
192   else if (!strcmp(mode_name, "busy_wait")) {
193           mode = XBT_PARMAP_BUSY_WAIT;
194   }
195   else {
196     XBT_WARN("Command line setting of the parallel synchronization mode should "
197         "be one of \"posix\", \"futex\" or \"busy_wait\"");
198   }
199   return mode;
200 }
201
202 /**
203  * \brief Sets the synchronization mode to use when processes are run in
204  * parallel.
205  * \param mode how to synchronize threads if processes are run in parallel
206  */
207 XBT_INLINE void SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode) {
208   if (mode == XBT_PARMAP_POSIX) {
209           xbt_cfg_set_string(_surf_cfg_set, "contexts/synchro", "posix");
210   }
211   else if (mode == XBT_PARMAP_FUTEX) {
212           xbt_cfg_set_string(_surf_cfg_set, "contexts/synchro", "futex");
213   }
214   else if (XBT_PARMAP_BUSY_WAIT) {
215           xbt_cfg_set_string(_surf_cfg_set, "contexts/synchro", "busy_wait");
216   }
217   else {
218     XBT_WARN("Command line setting of the parallel synchronization mode should "
219         "be one of \"posix\", \"futex\" or \"busy_wait\"");
220   }
221 }
222
223 /**
224  * \brief Returns the current context of this thread.
225  * \return the current context of this thread
226  */
227 XBT_INLINE smx_context_t SIMIX_context_get_current(void)
228 {
229   if (SIMIX_context_is_parallel()) {
230 #ifdef HAVE_THREAD_LOCAL_STORAGE
231     return smx_current_context_parallel;
232 #else
233     return xbt_os_thread_get_specific(smx_current_context_key);
234 #endif
235   }
236   else {
237     return smx_current_context_serial;
238   }
239 }
240
241 /**
242  * \brief Sets the current context of this thread.
243  * \param context the context to set
244  */
245 XBT_INLINE void SIMIX_context_set_current(smx_context_t context)
246 {
247   if (SIMIX_context_is_parallel()) {
248 #ifdef HAVE_THREAD_LOCAL_STORAGE
249     smx_current_context_parallel = context;
250 #else
251     xbt_os_thread_set_specific(smx_current_context_key, context);
252 #endif
253   }
254   else {
255     smx_current_context_serial = context;
256   }
257 }
258