X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/0f5e8daaa6e9f74521068aa75837200bcd182ea6..1f606358fff6ef994cd58570e7c77ee6259d6a4e:/include/xbt/synchro_core.h

diff --git a/include/xbt/synchro_core.h b/include/xbt/synchro_core.h
index 5a270d3f71..9f94e82b3c 100644
--- a/include/xbt/synchro_core.h
+++ b/include/xbt/synchro_core.h
@@ -1,13 +1,13 @@
-/* xbt/synchro.h -- Synchronization tools                                   */
+/* xbt/synchro_core.h -- Synchronization tools                              */
 /* Usable in simulator, (or in real life when mixing with GRAS)             */
 
-/* Copyright (c) 2009, 2010. The SimGrid Team.
+/* Copyright (c) 2009-2014. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-/* splited away from synchro.h since we areused by dynar.h, and synchro.h uses dynar */
+/* splited away from synchro.h since we are used by dynar.h, and synchro.h uses dynar */
 
 
 #ifndef _XBT_THREAD_H
@@ -21,54 +21,65 @@ SG_BEGIN_DECL()
 /** @addtogroup XBT_synchro
  *  @brief XBT synchronization tools
  * 
- *  This section describes the XBT synchronization tools. It defines types and 
- *  functions very close to the pthread API, but widly usable. When used from 
- *  the simulator, you will lock simulated processes as expected. When used 
- *  from GRAS programs compiled for in-situ execution, you have synchronization 
- *  mecanism portable to windows and UNIX. Nice, isn't it?
+ *  This section describes the XBT synchronization tools.
+ *  This is a portability layer (for windows and UNIX) of a pthread-like API. Nice, isn't it?
  * 
  *  @{
  */
-  /** \brief Thread data type (opaque structure) */
-typedef struct s_xbt_thread_ *xbt_thread_t;
-
-XBT_PUBLIC(xbt_thread_t) xbt_thread_create(const char *name,
-                                           void_f_pvoid_t start_routine,
-                                           void *param, int joinable);
-XBT_PUBLIC(xbt_thread_t) xbt_thread_self(void);
-XBT_PUBLIC(const char *) xbt_thread_name(xbt_thread_t t);
-XBT_PUBLIC(const char *) xbt_thread_self_name(void);
-  /* xbt_thread_join frees the joined thread (ie the XBT wrapper around it, the OS frees the rest) */
-XBT_PUBLIC(void) xbt_thread_join(xbt_thread_t thread);
-  /* Ends the life of the poor victim (not always working if it's computing, but working if it's blocked in the OS) */
-XBT_PUBLIC(void) xbt_thread_cancel(xbt_thread_t thread);
-  /* suicide */
-XBT_PUBLIC(void) xbt_thread_exit(void);
-  /* current thread pass control to any possible thread wanting it */
-XBT_PUBLIC(void) xbt_thread_yield(void);
-
-
-  /** \brief Thread mutex data type (opaque structure) */
+
+
+/** @brief Thread mutex data type (opaque object)
+ *  @hideinitializer
+ */
 typedef struct s_xbt_mutex_ *xbt_mutex_t;
 
+/** @brief Creates a new mutex variable */
 XBT_PUBLIC(xbt_mutex_t) xbt_mutex_init(void);
+
+/** @brief Blocks onto the given mutex variable */
 XBT_PUBLIC(void) xbt_mutex_acquire(xbt_mutex_t mutex);
+
+/** @brief Tries to block onto the given mutex variable 
+ * Tries to lock a mutex, return 1 if the mutex is unlocked, else 0.
+ * This function does not block and wait for the mutex to be unlocked.
+ * \param mutex The mutex
+ * \return 1 - mutex free, 0 - mutex used
+ */
+XBT_PUBLIC(int) xbt_mutex_try_acquire(xbt_mutex_t mutex);
+
+/** @brief Releases the given mutex variable */
 XBT_PUBLIC(void) xbt_mutex_release(xbt_mutex_t mutex);
-XBT_PUBLIC(void) xbt_mutex_timedacquire(xbt_mutex_t mutex, double delay);
+
+/** @brief Destroyes the given mutex variable */
 XBT_PUBLIC(void) xbt_mutex_destroy(xbt_mutex_t mutex);
 
 
-  /** \brief Thread condition data type (opaque structure) */
+/** @brief Thread condition data type (opaque object)
+ *  @hideinitializer
+ */
 typedef struct s_xbt_cond_ *xbt_cond_t;
 
+/** @brief Creates a condition variable */
 XBT_PUBLIC(xbt_cond_t) xbt_cond_init(void);
+
+/** @brief Blocks onto the given condition variable */
 XBT_PUBLIC(void) xbt_cond_wait(xbt_cond_t cond, xbt_mutex_t mutex);
-XBT_PUBLIC(void) xbt_cond_timedwait(xbt_cond_t cond,
-                                    xbt_mutex_t mutex, double delay);
+/** @brief Blocks onto the given condition variable, but only for the given amount of time. a timeout exception is
+ *   raised if it was impossible to acquire it in the given time frame */
+XBT_PUBLIC(void) xbt_cond_timedwait(xbt_cond_t cond, xbt_mutex_t mutex, double delay);
+/** @brief Signals the given mutex variable */
 XBT_PUBLIC(void) xbt_cond_signal(xbt_cond_t cond);
+/** @brief Broadcasts the given mutex variable */
 XBT_PUBLIC(void) xbt_cond_broadcast(xbt_cond_t cond);
+/** @brief Destroys the given mutex variable */
 XBT_PUBLIC(void) xbt_cond_destroy(xbt_cond_t cond);
 
+#define XBT_BARRIER_SERIAL_PROCESS -1
+typedef struct s_xbt_bar_ *xbt_bar_t;
+XBT_PUBLIC(xbt_bar_t) xbt_barrier_init( unsigned int count);
+XBT_PUBLIC(void) xbt_barrier_destroy(xbt_bar_t bar);
+XBT_PUBLIC(int) xbt_barrier_wait(xbt_bar_t bar);
+
 /** @} */
 
 SG_END_DECL()