Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Cleanup: shuffle the functions to get them in a somehow logical order
authormquinson <mquinson@48e7efb5-ca39-0410-a469-dd3cf9ba447f>
Thu, 20 Sep 2007 10:13:26 +0000 (10:13 +0000)
committermquinson <mquinson@48e7efb5-ca39-0410-a469-dd3cf9ba447f>
Thu, 20 Sep 2007 10:13:26 +0000 (10:13 +0000)
git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk@4645 48e7efb5-ca39-0410-a469-dd3cf9ba447f

src/xbt/context.c

index 859ebd0..b5fb219 100644 (file)
@@ -29,199 +29,13 @@ static xbt_os_mutex_t creation_mutex;
 static xbt_os_cond_t creation_cond;
 #endif
 
-static void __context_exit(xbt_context_t context, int value);
-static void __xbt_context_yield(xbt_context_t context)
-{
-  xbt_assert0(current_context, "You have to call context_init() first.");
-
-  DEBUG2
-      ("--------- current_context (%p) is yielding to context(%p) ---------",
-       current_context, context);
-
-#ifdef CONTEXT_THREADS
-  if (context) {
-    xbt_context_t self = current_context;
-    DEBUG2("[%p] **** Locking ctx %p ****", self, context);
-    xbt_os_mutex_lock(context->mutex);
-    DEBUG1("[%p] **** Updating current_context ****", self);
-    current_context = context;
-    DEBUG1("[%p] **** Releasing the prisonner ****", self);
-    xbt_os_cond_signal(context->cond);
-    DEBUG3("[%p] **** Going to jail on individual %p/%p ****", self,
-          context->cond, context->mutex);
-    xbt_os_cond_wait(context->cond, context->mutex);
-    DEBUG2("[%p] **** Unlocking individual %p ****", self, context->mutex);
-    xbt_os_mutex_unlock(context->mutex);
-    DEBUG1("[%p] **** Updating current_context ****", self);
-    current_context = self;
-  }
-#else                          /* use SUSv2 contexts */
-  VOIRP(current_context);
-  if (current_context)
-    VOIRP(current_context->save);
-
-  VOIRP(context);
-
-  if (context)
-    VOIRP(context->save);
-
-  if (context) {
-
-    int return_value = 0;
-
-    if (context->save == NULL) {
-
-      DEBUG1("[%p] **** Yielding to somebody else ****", current_context);
-      DEBUG2("Saving current_context value (%p) to context(%p)->save",
-            current_context, context);
-      context->save = current_context;
-      DEBUG1("current_context becomes  context(%p) ", context);
-      current_context = context;
-      DEBUG1
-         ("Current position memorized (context->save). Jumping to context (%p)",
-          context);
-      return_value = swapcontext(&(context->save->uc), &(context->uc));
-      xbt_assert0((return_value == 0), "Context swapping failure");
-      DEBUG1("I am (%p). Coming back\n", context);
-    } else {
-      xbt_context_t old_context = context->save;
-      DEBUG1("[%p] **** Back ! ****", context);
-      DEBUG2("Setting current_context (%p) to context(%p)->save",
-            current_context, context);
-      current_context = context->save;
-      DEBUG1("Setting context(%p)->save to NULL", context);
-      context->save = NULL;
-      DEBUG2("Current position memorized (%p). Jumping to context (%p)",
-            context, old_context);
-      return_value = swapcontext(&(context->uc), &(old_context->uc));
-      xbt_assert0((return_value == 0), "Context swapping failure");
-      DEBUG1("I am (%p). Coming back\n", context);
-
-    }
-  }
-#endif
-  if (current_context->iwannadie)
-    __context_exit(current_context, 1);
-
-  return;
-}
-
-static void xbt_context_free(xbt_context_t context)
-{
-  if (!context)
-    return;
-  DEBUG1("Freeing %p", context);
-  free(context->name);
-#ifdef CONTEXT_THREADS
-  /*DEBUG1("\t joining %p",(void *)context->thread->t); */
-  DEBUG1("\t joining %p", (void *) context->thread);
-
-  xbt_os_thread_join(context->thread, NULL);
-
-  DEBUG1("\t mutex_destroy %p", (void *) context->mutex);
-  xbt_os_mutex_destroy(context->mutex);
-  DEBUG1("\t cond_destroy %p", (void *) context->cond);
-  xbt_os_cond_destroy(context->cond);
-
-  context->thread = NULL;
-  context->mutex = NULL;
-  context->cond = NULL;
-#else
-  if (context->exception)
-    free(context->exception);
-#endif
-   
-  free(context);
-  return;
-}
-
-static void __context_exit(xbt_context_t context, int value)
-{
-  int i;
-
-  DEBUG1("--------- %p is exiting ---------", context);
-
-  DEBUG0("Calling cleanup functions");
-  if (context->cleanup_func) {
-    DEBUG0("Calling cleanup function");
-    context->cleanup_func(context->cleanup_arg);
-  }
-
-  DEBUG0("Freeing arguments");
-  for (i = 0; i < context->argc; i++)
-    if (context->argv[i])
-      free(context->argv[i]);
-
-  if (context->argv)
-    free(context->argv);
-
-  DEBUG0("Putting context in the to_destroy set");
-  xbt_swag_remove(context, context_living);
-  xbt_swag_insert(context, context_to_destroy);
-  DEBUG0("Context put in the to_destroy set");
-
-  DEBUG0("Yielding");
-
-#ifdef CONTEXT_THREADS
-  DEBUG2("[%p] **** Locking %p ****", context, context->mutex);
-  xbt_os_mutex_lock(context->mutex);
-/*     DEBUG1("[%p] **** Updating current_context ****"); */
-/*     current_context = context; */
-  DEBUG1("[%p] **** Releasing the prisonner ****", context);
-  xbt_os_cond_signal(context->cond);
-  DEBUG2("[%p] **** Unlocking individual %p ****", context,
-        context->mutex);
-  xbt_os_mutex_unlock(context->mutex);
-  DEBUG1("[%p] **** Exiting ****", context);
-  xbt_os_thread_exit(NULL);    // We should provide return value in case other wants it
-#else
-  __xbt_context_yield(context);
-#endif
-  xbt_assert0(0, "You can't be here!");
-}
-
-static void *__context_wrapper(void *c)
-{
-  xbt_context_t context = current_context;
-
-#ifdef CONTEXT_THREADS
-  context = (xbt_context_t) c;
-  context->thread = xbt_os_thread_self();
-
-  DEBUG3("**[ctx:%p;self:%p]** Lock creation_mutex %p ****", context,
-        (void *) xbt_os_thread_self(), creation_mutex);
-  xbt_os_mutex_lock(creation_mutex);
-  xbt_os_mutex_lock(context->mutex);
-
-  DEBUG4
-      ("**[ctx:%p;self:%p]** Releasing the creator (creation_cond %p,%p) ****",
-       context, (void *) xbt_os_thread_self(), creation_cond,
-       creation_mutex);
-  xbt_os_cond_signal(creation_cond);
-  xbt_os_mutex_unlock(creation_mutex);
-
-  DEBUG4("**[ctx:%p;self:%p]** Going to Jail on lock %p and cond %p ****",
-        context, (void *) xbt_os_thread_self(), context->mutex,
-        context->cond);
-  xbt_os_cond_wait(context->cond, context->mutex);
-
-  DEBUG3("**[ctx:%p;self:%p]** Unlocking individual %p ****",
-        context, (void *) xbt_os_thread_self(), context->mutex);
-  xbt_os_mutex_unlock(context->mutex);
-
-#endif
-
-  if (context->startup_func)
-    context->startup_func(context->startup_arg);
-
-  DEBUG0("Calling the main function");
-
-  __context_exit(context, (context->code) (context->argc, context->argv));
-  return NULL;
-}
 
+/********************/
+/* Module init/exit */
+/********************/
 #ifndef CONTEXT_THREADS
-/* callback: context fetching (used only with ucontext, os_thread deal with it for us otherwise) */
+/* callback: context fetching (used only with ucontext, os_thread deal with it
+                               for us otherwise) */
 static ex_ctx_t *_context_ex_ctx(void) {
   return current_context->exception;
 }
@@ -268,55 +82,38 @@ 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.
+/** 
+ * This function kill all existing context and free all the memory
+ * that has been allocated in this module.
  */
-void xbt_context_empty_trash(void)
+void xbt_context_exit(void)
 {
   xbt_context_t context = NULL;
-  DEBUG1("Emptying trashbin (%d contexts to free)",
-        xbt_swag_size(context_to_destroy));
-  while ((context = xbt_swag_extract(context_to_destroy)))
-    xbt_context_free(context);
-}
 
-/** 
- * \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_context_empty_trash();
+  while ((context = xbt_swag_extract(context_living))) {
+    if (context != init_context) {
+      xbt_context_kill(context);
+    }
+  }
 #ifdef CONTEXT_THREADS
-  /* Launch the thread */
-   
-  DEBUG3("**[ctx:%p;self:%p]** Locking creation_mutex %p ****", context,
-        xbt_os_thread_self(), creation_mutex);
-  xbt_os_mutex_lock(creation_mutex);
+  xbt_os_mutex_destroy(creation_mutex);
+  xbt_os_cond_destroy(creation_cond);
+#else   
+  free(init_context->exception);
+#endif
+  free(init_context);
+  init_context = current_context = NULL;
 
-  DEBUG2("**[ctx:%p;self:%p]** Thread create ****", context,
-        xbt_os_thread_self());
-  context->thread = xbt_os_thread_create(context->name,__context_wrapper, context);
-  DEBUG3("**[ctx:%p;self:%p]** Thread created : %p ****", context,
-        xbt_os_thread_self(), context->thread);
+  xbt_context_empty_trash();
+  xbt_swag_free(context_to_destroy);
+  xbt_swag_free(context_living);
 
-  DEBUG4
-      ("**[ctx:%p;self:%p]** Going to jail on creation_cond/mutex (%p,%p) ****",
-       context, xbt_os_thread_self(), creation_cond, creation_mutex);
-  xbt_os_cond_wait(creation_cond, creation_mutex);
-  DEBUG3("**[ctx:%p;self:%p]** Unlocking creation %p ****", context,
-        xbt_os_thread_self(), creation_mutex);
-  xbt_os_mutex_unlock(creation_mutex);
-#else
-  makecontext(&(context->uc), (void (*)(void)) __context_wrapper, 1,
-             context);
-#endif
-  return;
 }
 
+/*******************************/
+/* Object creation/destruction */
+/*******************************/
 /** 
  * \param code a main function
  * \param startup_func a function to call when running the context for
@@ -374,60 +171,284 @@ xbt_context_t xbt_context_new(const char *name,xbt_main_func_t code,
   return res;
 }
 
-/** 
- * 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.
+static void xbt_context_free(xbt_context_t context) {
+  if (!context)
+    return;
+  DEBUG1("Freeing %p", context);
+  free(context->name);
+#ifdef CONTEXT_THREADS
+  /*DEBUG1("\t joining %p",(void *)context->thread->t); */
+  DEBUG1("\t joining %p", (void *) context->thread);
+
+  xbt_os_thread_join(context->thread, NULL);
+
+  DEBUG1("\t mutex_destroy %p", (void *) context->mutex);
+  xbt_os_mutex_destroy(context->mutex);
+  DEBUG1("\t cond_destroy %p", (void *) context->cond);
+  xbt_os_cond_destroy(context->cond);
+
+  context->thread = NULL;
+  context->mutex = NULL;
+  context->cond = NULL;
+#else
+  if (context->exception)
+    free(context->exception);
+#endif
+   
+  free(context);
+  return;
+}
+
+/************************/
+/* Start/stop a context */
+/************************/
+static void xbt_context_stop(xbt_context_t context, int value);
+
+static void *__context_wrapper(void *c)
+{
+  xbt_context_t context = current_context;
+
+#ifdef CONTEXT_THREADS
+  context = (xbt_context_t) c;
+  context->thread = xbt_os_thread_self();
+
+  DEBUG3("**[ctx:%p;self:%p]** Lock creation_mutex %p ****", context,
+        (void *) xbt_os_thread_self(), creation_mutex);
+  xbt_os_mutex_lock(creation_mutex);
+  xbt_os_mutex_lock(context->mutex);
+
+  DEBUG4
+      ("**[ctx:%p;self:%p]** Releasing the creator (creation_cond %p,%p) ****",
+       context, (void *) xbt_os_thread_self(), creation_cond,
+       creation_mutex);
+  xbt_os_cond_signal(creation_cond);
+  xbt_os_mutex_unlock(creation_mutex);
+
+  DEBUG4("**[ctx:%p;self:%p]** Going to Jail on lock %p and cond %p ****",
+        context, (void *) xbt_os_thread_self(), context->mutex,
+        context->cond);
+  xbt_os_cond_wait(context->cond, context->mutex);
+
+  DEBUG3("**[ctx:%p;self:%p]** Unlocking individual %p ****",
+        context, (void *) xbt_os_thread_self(), context->mutex);
+  xbt_os_mutex_unlock(context->mutex);
+
+#endif
+
+  if (context->startup_func)
+    context->startup_func(context->startup_arg);
+
+  DEBUG0("Calling the main function");
+
+  xbt_context_stop(context, (context->code) (context->argc, context->argv));
+  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_schedule(xbt_context_t context)
+void xbt_context_start(xbt_context_t context)
 {
-  DEBUG1("Scheduling %p", context);
-  xbt_assert0((current_context == init_context),
-             "You are not supposed to run this function here!");
+#ifdef CONTEXT_THREADS
+  /* Launch the thread */
+   
+  DEBUG3("**[ctx:%p;self:%p]** Locking creation_mutex %p ****", context,
+        xbt_os_thread_self(), creation_mutex);
+  xbt_os_mutex_lock(creation_mutex);
+
+  DEBUG2("**[ctx:%p;self:%p]** Thread create ****", context,
+        xbt_os_thread_self());
+  context->thread = xbt_os_thread_create(context->name,__context_wrapper, context);
+  DEBUG3("**[ctx:%p;self:%p]** Thread created : %p ****", context,
+        xbt_os_thread_self(), context->thread);
+
+  DEBUG4
+      ("**[ctx:%p;self:%p]** Going to jail on creation_cond/mutex (%p,%p) ****",
+       context, xbt_os_thread_self(), creation_cond, creation_mutex);
+  xbt_os_cond_wait(creation_cond, creation_mutex);
+  DEBUG3("**[ctx:%p;self:%p]** Unlocking creation %p ****", context,
+        xbt_os_thread_self(), creation_mutex);
+  xbt_os_mutex_unlock(creation_mutex);
+#else
+  makecontext(&(context->uc), (void (*)(void)) __context_wrapper, 1,
+             context);
+#endif
+  return;
+}
+
+static void xbt_context_stop(xbt_context_t context, int value)
+{
+  int i;
+
+  DEBUG1("--------- %p is exiting ---------", context);
+
+  DEBUG0("Calling cleanup functions");
+  if (context->cleanup_func) {
+    DEBUG0("Calling cleanup function");
+    context->cleanup_func(context->cleanup_arg);
+  }
+
+  DEBUG0("Freeing arguments");
+  for (i = 0; i < context->argc; i++)
+    if (context->argv[i])
+      free(context->argv[i]);
+
+  if (context->argv)
+    free(context->argv);
+
+  DEBUG0("Putting context in the to_destroy set");
+  xbt_swag_remove(context, context_living);
+  xbt_swag_insert(context, context_to_destroy);
+  DEBUG0("Context put in the to_destroy set");
+
+  DEBUG0("Yielding");
+
+#ifdef CONTEXT_THREADS
+  DEBUG2("[%p] **** Locking %p ****", context, context->mutex);
+  xbt_os_mutex_lock(context->mutex);
+/*     DEBUG1("[%p] **** Updating current_context ****"); */
+/*     current_context = context; */
+  DEBUG1("[%p] **** Releasing the prisonner ****", context);
+  xbt_os_cond_signal(context->cond);
+  DEBUG2("[%p] **** Unlocking individual %p ****", context,
+        context->mutex);
+  xbt_os_mutex_unlock(context->mutex);
+  DEBUG1("[%p] **** Exiting ****", context);
+  xbt_os_thread_exit(NULL);    // We should provide return value in case other wants it
+#else
   __xbt_context_yield(context);
+#endif
+  xbt_assert0(0, "You can't be here!");
 }
 
-/** 
- * This function kill all existing context and free all the memory
- * that has been allocated in this module.
+
+
+/** 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_exit(void)
+void xbt_context_empty_trash(void)
 {
   xbt_context_t context = NULL;
+  DEBUG1("Emptying trashbin (%d contexts to free)",
+        xbt_swag_size(context_to_destroy));
+  while ((context = xbt_swag_extract(context_to_destroy)))
+    xbt_context_free(context);
+}
+
+/*********************/
+/* context switching */
+/*********************/
+
+static void __xbt_context_yield(xbt_context_t context)
+{
+  xbt_assert0(current_context, "You have to call context_init() first.");
+
+  DEBUG2
+      ("--------- current_context (%p) is yielding to context(%p) ---------",
+       current_context, context);
+
+#ifdef CONTEXT_THREADS
+  if (context) {
+    xbt_context_t self = current_context;
+    DEBUG2("[%p] **** Locking ctx %p ****", self, context);
+    xbt_os_mutex_lock(context->mutex);
+    DEBUG1("[%p] **** Updating current_context ****", self);
+    current_context = context;
+    DEBUG1("[%p] **** Releasing the prisonner ****", self);
+    xbt_os_cond_signal(context->cond);
+    DEBUG3("[%p] **** Going to jail on individual %p/%p ****", self,
+          context->cond, context->mutex);
+    xbt_os_cond_wait(context->cond, context->mutex);
+    DEBUG2("[%p] **** Unlocking individual %p ****", self, context->mutex);
+    xbt_os_mutex_unlock(context->mutex);
+    DEBUG1("[%p] **** Updating current_context ****", self);
+    current_context = self;
+  }
+#else                          /* use SUSv2 contexts */
+  VOIRP(current_context);
+  if (current_context)
+    VOIRP(current_context->save);
+
+  VOIRP(context);
+
+  if (context)
+    VOIRP(context->save);
+
+  if (context) {
+
+    int return_value = 0;
+
+    if (context->save == NULL) {
+
+      DEBUG1("[%p] **** Yielding to somebody else ****", current_context);
+      DEBUG2("Saving current_context value (%p) to context(%p)->save",
+            current_context, context);
+      context->save = current_context;
+      DEBUG1("current_context becomes  context(%p) ", context);
+      current_context = context;
+      DEBUG1
+         ("Current position memorized (context->save). Jumping to context (%p)",
+          context);
+      return_value = swapcontext(&(context->save->uc), &(context->uc));
+      xbt_assert0((return_value == 0), "Context swapping failure");
+      DEBUG1("I am (%p). Coming back\n", context);
+    } else {
+      xbt_context_t old_context = context->save;
+      DEBUG1("[%p] **** Back ! ****", context);
+      DEBUG2("Setting current_context (%p) to context(%p)->save",
+            current_context, context);
+      current_context = context->save;
+      DEBUG1("Setting context(%p)->save to NULL", context);
+      context->save = NULL;
+      DEBUG2("Current position memorized (%p). Jumping to context (%p)",
+            context, old_context);
+      return_value = swapcontext(&(context->uc), &(old_context->uc));
+      xbt_assert0((return_value == 0), "Context swapping failure");
+      DEBUG1("I am (%p). Coming back\n", context);
 
-  xbt_context_empty_trash();
-  while ((context = xbt_swag_extract(context_living))) {
-    if (context != init_context) {
-      xbt_context_kill(context);
     }
   }
-#ifdef CONTEXT_THREADS
-  xbt_os_mutex_destroy(creation_mutex);
-  xbt_os_cond_destroy(creation_cond);
-#else   
-  free(init_context->exception);
 #endif
-  free(init_context);
-  init_context = current_context = NULL;
+  if (current_context->iwannadie)
+    xbt_context_stop(current_context, 1);
+
+  return;
+}
+
 
-  xbt_context_empty_trash();
-  xbt_swag_free(context_to_destroy);
-  xbt_swag_free(context_living);
 
+
+
+/** 
+ * 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)
+{
+  DEBUG1("Scheduling %p", context);
+  xbt_assert0((current_context == init_context),
+             "You are not supposed to run this function here!");
+  __xbt_context_yield(context);
+}
+
+
 /** 
  * \param context poor victim
  *
@@ -445,37 +466,14 @@ void xbt_context_kill(xbt_context_t context)
   return;
 }
 
-/* @} */
-
-/* Stub of the stuff to interact with JAVA threads; not used in native lib */
-void xbt_context_set_jprocess(xbt_context_t context, void *jp)
-{
-}
-void *xbt_context_get_jprocess(xbt_context_t context)
-{
-  return NULL;
-}
+/* Java cruft I'm gonna kill in the next cleanup round */
+void  xbt_context_set_jprocess(xbt_context_t context, void *jp){}
+void* xbt_context_get_jprocess(xbt_context_t context){return NULL;}
+void  xbt_context_set_jmutex(xbt_context_t context,void *jm){}
+void* xbt_context_get_jmutex(xbt_context_t context){return NULL;}
+void  xbt_context_set_jcond(xbt_context_t context,void *jc){}
+void* xbt_context_get_jcond(xbt_context_t context){return NULL;}
+void  xbt_context_set_jenv(xbt_context_t context,void* je){}
+void* xbt_context_get_jenv(xbt_context_t context){return NULL;}
 
-void xbt_context_set_jmutex(xbt_context_t context, void *jm)
-{
-}
-void *xbt_context_get_jmutex(xbt_context_t context)
-{
-  return NULL;
-}
-
-void xbt_context_set_jcond(xbt_context_t context, void *jc)
-{
-}
-void *xbt_context_get_jcond(xbt_context_t context)
-{
-  return NULL;
-}
-
-void xbt_context_set_jenv(xbt_context_t context, void *je)
-{
-}
-void *xbt_context_get_jenv(xbt_context_t context)
-{
-  return NULL;
-}
+/* @} */