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 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 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(context, xbt, "Context");
  18
  19 #define WARNING(format, ...) (fprintf(stderr, "[%s , %s : %d] ", __FILE__, __FUNCTION__, __LINE__),\
  20                               fprintf(stderr, format, ## __VA_ARGS__), \
  21                               fprintf(stderr, "\n"))
  22 #define VOIRP(expr) WARNING("  {" #expr " = %p }", expr)
  23
  24 #ifndef HAVE_UCONTEXT_H
  25 /* don't want to play with conditional compilation in automake tonight, sorry.
  26    include directly the c file from here when needed. */
  27 # include "context_win32.c"
  28 #endif
  29
  30 static xbt_context_t current_context = NULL;
  31 static xbt_context_t init_context = NULL;
  32 static xbt_swag_t context_to_destroy = NULL;
  33 static xbt_swag_t context_living = NULL;
  34
  35 static void __xbt_context_yield(xbt_context_t context)
  36 {
  37   int return_value = 0;
  38
  39   xbt_assert0(current_context,"You have to call context_init() first.");
  40
  41 /*   WARNING("--------- current_context (%p) is yielding to context(%p) ---------",current_context,context); */
  42 /*   VOIRP(current_context); */
  43 /*   if(current_context) VOIRP(current_context->save); */
  44 /*   VOIRP(context); */
  45 /*   if(context) VOIRP(context->save); */
  46
  47   if (context) {
  48     if(context->save==NULL) {
  49 /*       WARNING("**** Yielding to somebody else ****"); */
  50 /*       WARNING("Saving current_context value (%p) to context(%p)->save",current_context,context); */
  51       context->save = current_context ;
  52 /*       WARNING("current_context becomes  context(%p) ",context); */
  53       current_context = context ;
  54 /*       WARNING("Current position memorized (context->save). Jumping to context (%p)",context); */
  55       return_value = swapcontext (&(context->save->uc), &(context->uc));
  56       xbt_assert0((return_value==0),"Context swapping failure");
  57 /*       WARNING("I am (%p). Coming back\n",context); */
  58     } else {
  59       xbt_context_t old_context = context->save ;
  60 /*       WARNING("**** Back ! ****"); */
  61 /*       WARNING("Setting current_context (%p) to context(%p)->save",current_context,context); */
  62       current_context = context->save ;
  63 /*       WARNING("Setting context(%p)->save to NULL",context); */
  64       context->save = NULL ;
  65 /*       WARNING("Current position memorized (%p). Jumping to context (%p)",context,old_context); */
  66       return_value = swapcontext (&(context->uc), &(old_context->uc));
  67       xbt_assert0((return_value==0),"Context swapping failure");
  68 /*       WARNING("I am (%p). Coming back\n",context); */
  69     }
  70   }
  71
  72   return;
  73 }
  74
  75 static void xbt_context_destroy(xbt_context_t context)
  76 {
  77   xbt_free(context);
  78
  79   return;
  80 }
  81
  82 void xbt_context_init(void)
  83 {
  84   if(!current_context) {
  85     current_context = init_context = xbt_new0(s_xbt_context_t,1);
  86     context_to_destroy = xbt_swag_new(xbt_swag_offset(*current_context,hookup));
  87     context_living = xbt_swag_new(xbt_swag_offset(*current_context,hookup));
  88     xbt_swag_insert(init_context, context_living);
  89   }
  90 }
  91
  92 void xbt_context_empty_trash(void)
  93 {
  94   xbt_context_t context=NULL;
  95
  96   while((context=xbt_swag_extract(context_to_destroy)))
  97     xbt_context_destroy(context);
  98 }
  99
 100 static void *__context_wrapper(void *c)
 101 {
 102   xbt_context_t context = c;
 103   int i;
 104
 105 /*   msg_global->current_process = process; */
 106
 107   /*  WARNING("Calling the main function"); */
 108   /*   xbt_context_yield(context); */
 109   (context->code) (context->argc,context->argv);
 110
 111   for(i=0;i<context->argc; i++)
 112     if(context->argv[i]) xbt_free(context->argv[i]);
 113   if(context->argv) xbt_free(context->argv);
 114
 115   xbt_swag_remove(context, context_living);
 116   xbt_swag_insert(context, context_to_destroy);
 117
 118   __xbt_context_yield(context);
 119
 120   return NULL;
 121 }
 122
 123 void xbt_context_start(xbt_context_t context)
 124 {
 125 /*   xbt_fifo_insert(msg_global->process, process); */
 126 /*   xbt_fifo_insert(msg_global->process_to_run, process); */
 127
 128   makecontext (&(context->uc), (void (*) (void)) __context_wrapper,
 129                1, context);
 130   return;
 131 }
 132
 133 xbt_context_t xbt_context_new(xbt_context_function_t code,
 134                          int argc, char *argv[])
 135 {
 136   xbt_context_t res = NULL;
 137
 138   res = xbt_new0(s_xbt_context_t,1);
 139
 140   xbt_assert0(getcontext(&(res->uc))==0,"Error in context saving.");
 141
 142   res->code = code;
 143   res->uc.uc_link = NULL;
 144 /*   res->uc.uc_link = &(current_context->uc); */
 145   /* WARNING : when this context is over, the current_context (i.e. the
 146      father), is awaken... Theorically, the wrapper should prevent using
 147      this feature. */
 148   res->uc.uc_stack.ss_sp = res->stack;
 149   res->uc.uc_stack.ss_size = STACK_SIZE;
 150
 151   xbt_swag_insert(res, context_living);
 152
 153   return res;
 154 }
 155
 156
 157 void xbt_context_yield(void)
 158 {
 159   __xbt_context_yield(current_context);
 160 }
 161
 162 void xbt_context_schedule(xbt_context_t context)
 163 {
 164   xbt_assert0((current_context==init_context),
 165               "You are not supposed to run this function here!");
 166   __xbt_context_yield(context);
 167 }
 168
 169 void xbt_context_exit(void) {
 170   xbt_context_t context=NULL;
 171
 172   xbt_context_empty_trash();
 173   xbt_swag_free(context_to_destroy);
 174
 175   while((context=xbt_swag_extract(context_living)))
 176     xbt_context_destroy(context);
 177
 178   xbt_swag_free(context_living);
 179
 180   init_context = current_context = NULL ;
 181 }