src/xbt/context.c

   1 /*      $Id$     */
   2
   3 /* a fast and simple context switching library                              */
   4
   5 /* Copyright (c) 2004 Arnaud Legrand.                                       */
   6 /* Copyright (c) 2004, 2005 Martin Quinson.                                 */
   7 /* All rights reserved.                                                     */
   8
   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. */
  11
  12 #include "portable.h"
  13 #include "context_private.h"
  14 #include "xbt/error.h"
  15 #include "xbt/dynar.h"
  16 #include "gras_config.h"
  17
  18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(context, xbt, "Context");
  19
  20 #define VOIRP(expr) DEBUG1("  {" #expr " = %p }", expr)
  21
  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;
  26
  27 #ifndef USE_PTHREADS /* USE_PTHREADS and USE_CONTEXT are exclusive */
  28 # ifndef USE_UCONTEXT
  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
  33 # endif
  34 #endif
  35
  36 static void __xbt_context_yield(xbt_context_t context)
  37 {
  38   int return_value = 0;
  39
  40   xbt_assert0(current_context,"You have to call context_init() first.");
  41
  42   DEBUG2("--------- current_context (%p) is yielding to context(%p) ---------",
  43          current_context,context);
  44
  45 #ifdef USE_PTHREADS
  46   if (context) {
  47     xbt_context_t self = current_context;
  48     DEBUG0("**** Locking ****");
  49     pthread_mutex_lock(&(context->mutex));
  50     DEBUG0("**** Updating current_context ****");
  51     current_context = context;
  52     DEBUG0("**** Releasing the prisonner ****");
  53     pthread_cond_signal(&(context->cond));
  54     DEBUG0("**** Going to jail ****");
  55     pthread_cond_wait(&(context->cond), &(context->mutex));
  56     DEBUG0("**** Unlocking ****");
  57     pthread_mutex_unlock(&(context->mutex));
  58     DEBUG0("**** Updating current_context ****");
  59     current_context = self;
  60   }
  61 #else
  62   if(current_context)
  63     VOIRP(current_context->save);
  64
  65   VOIRP(context);
  66   if(context) VOIRP(context->save);
  67   if (context) {
  68     if(context->save==NULL) {
  69       DEBUG0("**** Yielding to somebody else ****");
  70       DEBUG2("Saving current_context value (%p) to context(%p)->save",current_context,context);
  71       context->save = current_context ;
  72       DEBUG1("current_context becomes  context(%p) ",context);
  73       current_context = context ;
  74       DEBUG1("Current position memorized (context->save). Jumping to context (%p)",context);
  75       return_value = swapcontext (&(context->save->uc), &(context->uc));
  76       xbt_assert0((return_value==0),"Context swapping failure");
  77       DEBUG1("I am (%p). Coming back\n",context);
  78     } else {
  79       xbt_context_t old_context = context->save ;
  80       DEBUG0("**** Back ! ****");
  81       DEBUG2("Setting current_context (%p) to context(%p)->save",current_context,context);
  82       current_context = context->save ;
  83       DEBUG1("Setting context(%p)->save to NULL",context);
  84       context->save = NULL ;
  85       DEBUG2("Current position memorized (%p). Jumping to context (%p)",context,old_context);
  86       return_value = swapcontext (&(context->uc), &(old_context->uc));
  87       xbt_assert0((return_value==0),"Context swapping failure");
  88       DEBUG1("I am (%p). Coming back\n",context);
  89     }
  90   }
  91 #endif
  92   return;
  93 }
  94
  95 static void xbt_context_destroy(xbt_context_t context)
  96 {
  97 #ifdef USE_PTHREADS
  98   xbt_free(context->thread);
  99   pthread_mutex_destroy(&(context->mutex));
 100   pthread_cond_destroy(&(context->cond));
 101 #endif
 102   free(context);
 103   return;
 104 }
 105
 106 static void *__context_wrapper(void *c)
 107 {
 108   xbt_context_t context = c;
 109   int i;
 110
 111 #ifdef USE_PTHREADS
 112   DEBUG0("**** Lock ****");
 113   pthread_mutex_lock(&(context->mutex));
 114   DEBUG0("**** Releasing the prisonner ****");
 115   pthread_cond_signal(&(context->cond));
 116   DEBUG0("**** Going to Jail ****");
 117   pthread_cond_wait(&(context->cond), &(context->mutex));
 118   DEBUG0("**** Unlocking ****");
 119   pthread_mutex_unlock(&(context->mutex));
 120 #endif
 121
 122   if(context->startup_func)
 123     context->startup_func(context->startup_arg);
 124
 125    DEBUG0("Calling the main function");
 126   (context->code) (context->argc,context->argv);
 127
 128   for(i=0;i<context->argc; i++)
 129     if(context->argv[i]) free(context->argv[i]);
 130   if(context->argv) free(context->argv);
 131
 132   if(context->cleanup_func)
 133     context->cleanup_func(context->cleanup_arg);
 134
 135   xbt_swag_remove(context, context_living);
 136   xbt_swag_insert(context, context_to_destroy);
 137
 138   __xbt_context_yield(context);
 139   xbt_assert0(0,"You're cannot be here!");
 140   return NULL;
 141 }
 142
 143 /* callback: context fetching */
 144 static ex_ctx_t *__context_ex_ctx(void)
 145 {
 146   return current_context->exception;
 147 }
 148
 149 /* callback: termination */
 150 static void __context_ex_terminate(xbt_ex_t *e)
 151 {
 152   exit(e->value);
 153 }
 154
 155 /** \name Functions
 156  *  \ingroup XBT_context
 157  */
 158 /* @{ */
 159 /** Context module initialization
 160  *
 161  * \warning It has to be called before using any other function of this module.
 162  */
 163 void xbt_context_init(void)
 164 {
 165   if(!current_context) {
 166     current_context = init_context = xbt_new0(s_xbt_context_t,1);
 167     init_context->exception = xbt_new(ex_ctx_t,1);
 168     XBT_CTX_INITIALIZE(init_context->exception);
 169     __xbt_ex_ctx       = __context_ex_ctx;
 170     __xbt_ex_terminate = __context_ex_terminate;
 171     context_to_destroy = xbt_swag_new(xbt_swag_offset(*current_context,hookup));
 172     context_living = xbt_swag_new(xbt_swag_offset(*current_context,hookup));
 173     xbt_swag_insert(init_context, context_living);
 174   }
 175 }
 176
 177 /** Garbage collection
 178  *
 179  * Should be called some time to time to free the memory allocated for contexts
 180  * that have finished executing their main functions.
 181  */
 182 void xbt_context_empty_trash(void)
 183 {
 184   xbt_context_t context=NULL;
 185
 186   while((context=xbt_swag_extract(context_to_destroy)))
 187     xbt_context_destroy(context);
 188 }
 189
 190 /**
 191  * \param context the context to start
 192  *
 193  * Calling this function prepares \a context to be run. It will
 194    however run effectively only when calling #xbt_context_schedule
 195  */
 196 void xbt_context_start(xbt_context_t context)
 197 {
 198 #ifdef USE_PTHREADS
 199   /* Launch the thread */
 200   DEBUG0("**** Locking ****");
 201   pthread_mutex_lock(&(context->mutex));
 202   DEBUG0("**** Pthread create ****");
 203   xbt_assert0(!pthread_create(context->thread, NULL, __context_wrapper, context),
 204               "Unable to create a thread.");
 205   DEBUG0("**** Going to jail ****");
 206   pthread_cond_wait(&(context->cond), &(context->mutex));
 207   DEBUG0("**** Unlocking ****");
 208   pthread_mutex_unlock(&(context->mutex));
 209 #else
 210   makecontext (&(context->uc), (void (*) (void)) __context_wrapper,
 211                1, context);
 212 #endif
 213   return;
 214 }
 215
 216 /**
 217  * \param code a main function
 218  * \param startup_func a function to call when running the context for
 219  *      the first time and just before the main function \a code
 220  * \param startup_arg the argument passed to the previous function (\a startup_func)
 221  * \param cleanup_func a function to call when running the context, just after
 222         the termination of the main function \a code
 223  * \param cleanup_arg the argument passed to the previous function (\a cleanup_func)
 224  * \param argc first argument of function \a code
 225  * \param argv seconde argument of function \a code
 226  */
 227 xbt_context_t xbt_context_new(xbt_context_function_t code,
 228                               void_f_pvoid_t startup_func, void *startup_arg,
 229                               void_f_pvoid_t cleanup_func, void *cleanup_arg,
 230                               int argc, char *argv[])
 231 {
 232   xbt_context_t res = NULL;
 233
 234   res = xbt_new0(s_xbt_context_t,1);
 235
 236   res->code = code;
 237 #ifdef USE_PTHREADS
 238   res->thread = xbt_new0(pthread_t,1);
 239   xbt_assert0(!pthread_mutex_init(&(res->mutex), NULL), "Mutex initialization error");
 240   xbt_assert0(!pthread_cond_init(&(res->cond), NULL), "Condition initialization error");
 241 #else
 242   /* FIXME: strerror is not thread safe */
 243   xbt_assert2(getcontext(&(res->uc))==0,"Error in context saving: %d (%s)", errno, strerror(errno));
 244   res->uc.uc_link = NULL;
 245   /*   res->uc.uc_link = &(current_context->uc); */
 246   /* WARNING : when this context is over, the current_context (i.e. the
 247      father), is awaken... Theorically, the wrapper should prevent using
 248      this feature. */
 249 # ifndef USE_WIN_CONTEXT
 250   res->uc.uc_stack.ss_sp = pth_skaddr_makecontext(res->stack,STACK_SIZE);
 251   res->uc.uc_stack.ss_size = pth_sksize_makecontext(res->stack,STACK_SIZE);
 252 # endif /* USE_WIN_CONTEXT */
 253 #endif /* USE_PTHREADS or not */
 254   res->argc = argc;
 255   res->argv = argv;
 256   res->startup_func = startup_func;
 257   res->startup_arg = startup_arg;
 258   res->cleanup_func = cleanup_func;
 259   res->cleanup_arg = cleanup_arg;
 260   res->exception = xbt_new(ex_ctx_t,1);
 261   XBT_CTX_INITIALIZE(res->exception);
 262
 263   xbt_swag_insert(res, context_living);
 264
 265   return res;
 266 }
 267
 268 /**
 269  * Calling this function makes the current context yield. The context
 270  * that scheduled it returns from xbt_context_schedule as if nothing
 271  * had happened.
 272  */
 273 void xbt_context_yield(void)
 274 {
 275   __xbt_context_yield(current_context);
 276 }
 277
 278 /**
 279  * \param context the winner
 280  *
 281  * Calling this function blocks the current context and schedule \a context.
 282  * When \a context will call xbt_context_yield, it will return
 283  * to this function as if nothing had happened.
 284  */
 285 void xbt_context_schedule(xbt_context_t context)
 286 {
 287   xbt_assert0((current_context==init_context),
 288               "You are not supposed to run this function here!");
 289   __xbt_context_yield(context);
 290 }
 291
 292 /**
 293  * This function kill all existing context and free all the memory
 294  * that has been allocated in this module.
 295  */
 296 void xbt_context_exit(void) {
 297   xbt_context_t context=NULL;
 298
 299   xbt_context_empty_trash();
 300   xbt_swag_free(context_to_destroy);
 301
 302   while((context=xbt_swag_extract(context_living)))
 303     xbt_context_free(context);
 304
 305   xbt_swag_free(context_living);
 306
 307   init_context = current_context = NULL ;
 308 }
 309
 310 /**
 311  * \param context poor victim
 312  *
 313  * This function simply kills \a context... scarry isn't it ?
 314  */
 315 void xbt_context_free(xbt_context_t context)
 316 {
 317   int i ;
 318
 319   xbt_swag_remove(context, context_living);
 320   for(i=0;i<context->argc; i++)
 321     if(context->argv[i]) free(context->argv[i]);
 322   if(context->argv) free(context->argv);
 323   if(context->exception) free(context->exception);
 324
 325   if(context->cleanup_func)
 326     context->cleanup_func(context->cleanup_arg);
 327   xbt_context_destroy(context);
 328
 329   return;
 330 }
 331 /* @} */