More verbose messages on errors

[simgrid.git] / src / xbt / context.c

diff --git a/src/xbt/context.c b/src/xbt/context.c
index 685e230..bfaac45 100644 (file)
--- a/src/xbt/context.c
+++ b/src/xbt/context.c
@@ -79,6 +79,14 @@ static void xbt_context_destroy(xbt_context_t context)
   return;
 }
 
+/** \name Functions 
+ *  \ingroup XBT_context
+ */
+/*@{*/
+/** Context module initialization
+ *
+ * \warning It has to be called before using any other function of this module.
+ */
 void xbt_context_init(void)
 {
   if(!current_context) {
@@ -89,6 +97,11 @@ void xbt_context_init(void)
   }
 }
 
+/** Garbage collection
+ *
+ * Should be called some time to time to free the memory allocated for contexts
+ * that have finished executing their main functions.
+ */
 void xbt_context_empty_trash(void)
 {
   xbt_context_t context=NULL;
@@ -104,6 +117,9 @@ static void *__context_wrapper(void *c)
 
 /*   msg_global->current_process = process; */
 
+  if(context->startup_func)
+    context->startup_func(context->startup_arg);
+
   /*  WARNING("Calling the main function"); */
   /*   xbt_context_yield(context); */
   (context->code) (context->argc,context->argv);
@@ -112,14 +128,23 @@ static void *__context_wrapper(void *c)
     if(context->argv[i]) xbt_free(context->argv[i]);
   if(context->argv) xbt_free(context->argv);
 
+  if(context->cleanup_func)
+    context->cleanup_func(context->cleanup_arg);
+
   xbt_swag_remove(context, context_living);
   xbt_swag_insert(context, context_to_destroy);
 
   __xbt_context_yield(context);
-
+  xbt_assert0(0,"You're cannot be here!");
   return NULL;
 }
 
+/** 
+ * \param context the context to start
+ * 
+ * Calling this function prepares \a context to be run. It will 
+   however run effectively only when calling #xbt_context_schedule
+ */
 void xbt_context_start(xbt_context_t context) 
 {
 /*   xbt_fifo_insert(msg_global->process, process); */
@@ -130,14 +155,28 @@ void xbt_context_start(xbt_context_t context)
   return;
 }
 
-xbt_context_t xbt_context_new(xbt_context_function_t code,
-                        int argc, char *argv[])
+/** 
+ * \param code a main function
+ * \param startup_func a function to call when running the context for
+ *      the first time and just before the main function \a code
+ * \param startup_arg the argument passed to the previous function (\a startup_func)
+ * \param cleanup_func a function to call when running the context, just after 
+        the termination of the main function \a code
+ * \param cleanup_arg the argument passed to the previous function (\a cleanup_func)
+ * \param argc first argument of function \a code
+ * \param argv seconde argument of function \a code
+ */
+xbt_context_t xbt_context_new(xbt_context_function_t code, 
+                             void_f_pvoid_t startup_func, void *startup_arg,
+                             void_f_pvoid_t cleanup_func, void *cleanup_arg,
+                             int argc, char *argv[])
 {
   xbt_context_t res = NULL;
 
   res = xbt_new0(s_xbt_context_t,1);
 
-  xbt_assert0(getcontext(&(res->uc))==0,"Error in context saving.");
+  /* FIXME: strerror is not thread safe */
+  xbt_assert2(getcontext(&(res->uc))==0,"Error in context saving: %d (%s)", errno, strerror(errno));
 
   res->code = code;
   res->uc.uc_link = NULL;
@@ -149,6 +188,10 @@ xbt_context_t xbt_context_new(xbt_context_function_t code,
      this feature. */
   res->uc.uc_stack.ss_sp = res->stack;
   res->uc.uc_stack.ss_size = STACK_SIZE;
+  res->startup_func = startup_func;
+  res->startup_arg = startup_arg;
+  res->cleanup_func = cleanup_func;
+  res->cleanup_arg = cleanup_arg;
 
   xbt_swag_insert(res, context_living);
 
@@ -156,11 +199,24 @@ xbt_context_t xbt_context_new(xbt_context_function_t code,
 }
 
 
+/** 
+ * Calling this function makes the current context yield. The context
+ * that scheduled it returns from xbt_context_schedule as if nothing
+ * had happened.
+ */
 void xbt_context_yield(void)
 {
   __xbt_context_yield(current_context);
 }
 
+
+/** 
+ * \param context the winner
+ *
+ * Calling this function blocks the current context and schedule \a context.  
+ * When \a context will call xbt_context_yield, it will return
+ * to this function as if nothing had happened.
+ */
 void xbt_context_schedule(xbt_context_t context)
 {
   xbt_assert0((current_context==init_context),
@@ -168,6 +224,10 @@ void xbt_context_schedule(xbt_context_t context)
   __xbt_context_yield(context);
 }
 
+/** 
+ * This function kill all existing context and free all the memory
+ * that has been allocated in this module.
+ */
 void xbt_context_exit(void) {
   xbt_context_t context=NULL;
 
@@ -175,9 +235,31 @@ void xbt_context_exit(void) {
   xbt_swag_free(context_to_destroy);
 
   while((context=xbt_swag_extract(context_living)))
-    xbt_context_destroy(context);
+    xbt_context_free(context);
 
   xbt_swag_free(context_living);
 
   init_context = current_context = NULL ;
 }
+
+/** 
+ * \param context poor victim
+ *
+ * This function simply kills \a context... scarry isn't it ?
+ */
+void xbt_context_free(xbt_context_t context)
+{
+  int i ;
+
+  xbt_swag_remove(context, context_living);  
+  for(i=0;i<context->argc; i++) 
+    if(context->argv[i]) xbt_free(context->argv[i]);
+  if(context->argv) xbt_free(context->argv);
+  
+  if(context->cleanup_func)
+    context->cleanup_func(context->cleanup_arg);
+  xbt_context_destroy(context);
+
+  return;
+}
+/*@}*/