3 /* a fast and simple context switching library */
5 /* Copyright (c) 2004 Arnaud Legrand. */
6 /* Copyright (c) 2004, 2005 Martin Quinson. */
7 /* All rights reserved. */
9 /* This program is free software; you can redistribute it and/or modify it
10 * under the terms of the license (GNU LGPL) which comes with this package. */
13 #include "context_private.h"
15 #include "xbt/dynar.h"
16 #include "gras_config.h"
18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(context, xbt, "Context");
20 #define VOIRP(expr) DEBUG1(" {" #expr " = %p }", expr)
22 static xbt_context_t current_context = NULL;
23 static xbt_context_t init_context = NULL;
24 static xbt_swag_t context_to_destroy = NULL;
25 static xbt_swag_t context_living = NULL;
27 #ifndef USE_PTHREADS /* USE_PTHREADS and USE_CONTEXT are exclusive */
29 /* don't want to play with conditional compilation in automake tonight, sorry.
30 include directly the c file from here when needed. */
31 # include "context_win32.c"
32 # define USE_WIN_CONTEXT
36 static void __xbt_context_yield(xbt_context_t context)
38 xbt_assert0(current_context,"You have to call context_init() first.");
40 DEBUG2("--------- current_context (%p) is yielding to context(%p) ---------",
41 current_context,context);
45 xbt_context_t self = current_context;
46 DEBUG0("**** Locking ****");
47 pthread_mutex_lock(&(context->mutex));
48 DEBUG0("**** Updating current_context ****");
49 current_context = context;
50 DEBUG0("**** Releasing the prisonner ****");
51 pthread_cond_signal(&(context->cond));
52 DEBUG0("**** Going to jail ****");
53 pthread_cond_wait(&(context->cond), &(context->mutex));
54 DEBUG0("**** Unlocking ****");
55 pthread_mutex_unlock(&(context->mutex));
56 DEBUG0("**** Updating current_context ****");
57 current_context = self;
61 VOIRP(current_context->save);
64 if(context) VOIRP(context->save);
69 if(context->save==NULL) {
70 DEBUG0("**** Yielding to somebody else ****");
71 DEBUG2("Saving current_context value (%p) to context(%p)->save",current_context,context);
72 context->save = current_context ;
73 DEBUG1("current_context becomes context(%p) ",context);
74 current_context = context ;
75 DEBUG1("Current position memorized (context->save). Jumping to context (%p)",context);
76 return_value = swapcontext (&(context->save->uc), &(context->uc));
77 xbt_assert0((return_value==0),"Context swapping failure");
78 DEBUG1("I am (%p). Coming back\n",context);
80 xbt_context_t old_context = context->save ;
81 DEBUG0("**** Back ! ****");
82 DEBUG2("Setting current_context (%p) to context(%p)->save",current_context,context);
83 current_context = context->save ;
84 DEBUG1("Setting context(%p)->save to NULL",context);
85 context->save = NULL ;
86 DEBUG2("Current position memorized (%p). Jumping to context (%p)",context,old_context);
87 return_value = swapcontext (&(context->uc), &(old_context->uc));
88 xbt_assert0((return_value==0),"Context swapping failure");
89 DEBUG1("I am (%p). Coming back\n",context);
96 static void xbt_context_destroy(xbt_context_t context)
99 xbt_free(context->thread);
100 pthread_mutex_destroy(&(context->mutex));
101 pthread_cond_destroy(&(context->cond));
103 if(context->exception) free(context->exception);
108 static void __context_exit(xbt_context_t context ,int value)
111 DEBUG0("Freeing arguments");
112 for(i=0;i<context->argc; i++)
113 if(context->argv[i]) free(context->argv[i]);
114 if(context->argv) free(context->argv);
116 if(context->cleanup_func) {
117 DEBUG0("Calling cleanup function");
118 context->cleanup_func(context->cleanup_arg);
121 DEBUG0("Putting context in the to_destroy set");
122 xbt_swag_remove(context, context_living);
123 xbt_swag_insert(context, context_to_destroy);
124 DEBUG0("Context put in the to_destroy set");
128 DEBUG0("**** Locking ****");
129 pthread_mutex_lock(&(context->mutex));
130 DEBUG0("**** Updating current_context ****");
131 current_context = context;
132 DEBUG0("**** Releasing the prisonner ****");
133 pthread_cond_signal(&(context->cond));
134 DEBUG0("**** Unlocking ****");
135 pthread_mutex_unlock(&(context->mutex));
136 DEBUG0("**** Exiting ****");
139 __xbt_context_yield(context);
141 xbt_assert0(0,"You can't be here!");
144 static void *__context_wrapper(void *c)
146 xbt_context_t context = c;
149 DEBUG2("**[%p:%p]** Lock ****",context,(void*)pthread_self());
150 pthread_mutex_lock(&(context->mutex));
151 DEBUG2("**[%p:%p]** Releasing the prisonner ****",context,(void*)pthread_self());
152 pthread_cond_signal(&(context->cond));
153 DEBUG2("**[%p:%p]** Going to Jail ****",context,(void*)pthread_self());
154 pthread_cond_wait(&(context->cond), &(context->mutex));
155 DEBUG2("**[%p:%p]** Unlocking ****",context,(void*)pthread_self());
156 pthread_mutex_unlock(&(context->mutex));
159 if(context->startup_func)
160 context->startup_func(context->startup_arg);
162 DEBUG0("Calling the main function");
164 __context_exit(context, (context->code) (context->argc,context->argv));
168 /* callback: context fetching */
169 static ex_ctx_t *__context_ex_ctx(void)
171 return current_context->exception;
174 /* callback: termination */
175 static void __context_ex_terminate(xbt_ex_t *e)
177 __context_exit(current_context, e->value);
181 * \ingroup XBT_context
184 /** Context module initialization
186 * \warning It has to be called before using any other function of this module.
188 void xbt_context_init(void)
190 if(!current_context) {
191 current_context = init_context = xbt_new0(s_xbt_context_t,1);
192 init_context->exception = xbt_new(ex_ctx_t,1);
193 XBT_CTX_INITIALIZE(init_context->exception);
194 __xbt_ex_ctx = __context_ex_ctx;
195 __xbt_ex_terminate = __context_ex_terminate;
196 context_to_destroy = xbt_swag_new(xbt_swag_offset(*current_context,hookup));
197 context_living = xbt_swag_new(xbt_swag_offset(*current_context,hookup));
198 xbt_swag_insert(init_context, context_living);
202 /** Garbage collection
204 * Should be called some time to time to free the memory allocated for contexts
205 * that have finished executing their main functions.
207 void xbt_context_empty_trash(void)
209 xbt_context_t context=NULL;
211 while((context=xbt_swag_extract(context_to_destroy)))
212 xbt_context_destroy(context);
216 * \param context the context to start
218 * Calling this function prepares \a context to be run. It will
219 however run effectively only when calling #xbt_context_schedule
221 void xbt_context_start(xbt_context_t context)
224 /* Launch the thread */
225 DEBUG1("**[%p]** Locking ****",context);
226 pthread_mutex_lock(&(context->mutex));
227 DEBUG1("**[%p]** Pthread create ****",context);
228 xbt_assert0(!pthread_create(context->thread, NULL, __context_wrapper, context),
229 "Unable to create a thread.");
230 DEBUG2("**[%p]** Pthread created : %p ****",context,(void*)(*(context->thread)));
231 DEBUG1("**[%p]** Going to jail ****",context);
232 pthread_cond_wait(&(context->cond), &(context->mutex));
233 DEBUG1("**[%p]** Unlocking ****",context);
234 pthread_mutex_unlock(&(context->mutex));
236 makecontext (&(context->uc), (void (*) (void)) __context_wrapper,
243 * \param code a main function
244 * \param startup_func a function to call when running the context for
245 * the first time and just before the main function \a code
246 * \param startup_arg the argument passed to the previous function (\a startup_func)
247 * \param cleanup_func a function to call when running the context, just after
248 the termination of the main function \a code
249 * \param cleanup_arg the argument passed to the previous function (\a cleanup_func)
250 * \param argc first argument of function \a code
251 * \param argv seconde argument of function \a code
253 xbt_context_t xbt_context_new(xbt_context_function_t code,
254 void_f_pvoid_t startup_func, void *startup_arg,
255 void_f_pvoid_t cleanup_func, void *cleanup_arg,
256 int argc, char *argv[])
258 xbt_context_t res = NULL;
260 res = xbt_new0(s_xbt_context_t,1);
264 res->thread = xbt_new0(pthread_t,1);
265 xbt_assert0(!pthread_mutex_init(&(res->mutex), NULL), "Mutex initialization error");
266 xbt_assert0(!pthread_cond_init(&(res->cond), NULL), "Condition initialization error");
268 /* FIXME: strerror is not thread safe */
269 xbt_assert2(getcontext(&(res->uc))==0,"Error in context saving: %d (%s)", errno, strerror(errno));
270 res->uc.uc_link = NULL;
271 /* res->uc.uc_link = &(current_context->uc); */
272 /* WARNING : when this context is over, the current_context (i.e. the
273 father), is awaken... Theorically, the wrapper should prevent using
275 # ifndef USE_WIN_CONTEXT
276 res->uc.uc_stack.ss_sp = pth_skaddr_makecontext(res->stack,STACK_SIZE);
277 res->uc.uc_stack.ss_size = pth_sksize_makecontext(res->stack,STACK_SIZE);
278 # endif /* USE_WIN_CONTEXT */
279 #endif /* USE_PTHREADS or not */
282 res->startup_func = startup_func;
283 res->startup_arg = startup_arg;
284 res->cleanup_func = cleanup_func;
285 res->cleanup_arg = cleanup_arg;
286 res->exception = xbt_new(ex_ctx_t,1);
287 XBT_CTX_INITIALIZE(res->exception);
289 xbt_swag_insert(res, context_living);
295 * Calling this function makes the current context yield. The context
296 * that scheduled it returns from xbt_context_schedule as if nothing
299 void xbt_context_yield(void)
301 __xbt_context_yield(current_context);
305 * \param context the winner
307 * Calling this function blocks the current context and schedule \a context.
308 * When \a context will call xbt_context_yield, it will return
309 * to this function as if nothing had happened.
311 void xbt_context_schedule(xbt_context_t context)
313 DEBUG1("Scheduling %p",context);
314 xbt_assert0((current_context==init_context),
315 "You are not supposed to run this function here!");
316 __xbt_context_yield(context);
320 * This function kill all existing context and free all the memory
321 * that has been allocated in this module.
323 void xbt_context_exit(void) {
324 xbt_context_t context=NULL;
326 xbt_context_empty_trash();
327 xbt_swag_free(context_to_destroy);
329 while((context=xbt_swag_extract(context_living)))
330 xbt_context_free(context);
332 xbt_swag_free(context_living);
334 init_context = current_context = NULL ;
338 * \param context poor victim
340 * This function simply kills \a context... scarry isn't it ?
342 void xbt_context_free(xbt_context_t context)
346 xbt_swag_remove(context, context_living);
347 for(i=0;i<context->argc; i++)
348 if(context->argv[i]) free(context->argv[i]);
349 if(context->argv) free(context->argv);
351 if(context->cleanup_func)
352 context->cleanup_func(context->cleanup_arg);
353 xbt_context_destroy(context);