X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/6760cb07d6b57be16928d95339d71e57c4e24f36..3297da9f47ce18371941b2b48a2f4018b4793ced:/include/xbt/synchro.h

diff --git a/include/xbt/synchro.h b/include/xbt/synchro.h
index cb7abd099d..a4923d257f 100644
--- a/include/xbt/synchro.h
+++ b/include/xbt/synchro.h
@@ -1,22 +1,79 @@
-/* xbt/synchro.h -- Synchronization tools                                   */
-/* Usable in simulator, (or in real life when mixing with GRAS)             */
+/* xbt/synchro.h -- Simulated synchronization                               */
 
-/* Copyright (c) 2007, 2009, 2010. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2009-2018. The SimGrid Team.                               */
 
 /* 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. */
 
-/* synchro_core.h is splited away since it is used by dynar.h, and we use dynar here */
+#ifndef XBT_THREAD_H
+#define XBT_THREAD_H
+
+#include "simgrid/forward.h"
+#include <xbt/function_types.h>
+#include <xbt/misc.h> /* SG_BEGIN_DECL */
 
-#ifndef SYNCHRO_H_
-#define SYNCHRO_H_
-#include "xbt/misc.h"           /* SG_BEGIN_DECL */
-#include "xbt/dynar.h"
 SG_BEGIN_DECL()
 
-XBT_PUBLIC(void) xbt_dynar_dopar(xbt_dynar_t datas, void_f_int_pvoid_t function);
+/** @addtogroup XBT_synchro
+ *  @brief XBT synchronization tools
+ *
+ *  This section describes the simulated synchronization mechanisms,
+ *  that you can use in your simulation without deadlocks. See @ref
+ *  faq_MIA_thread_synchronization for details.
+ *
+ *  @{
+ */
 
-SG_END_DECL()
+/** @brief Thread mutex data type (opaque object)
+ *  @hideinitializer
+ */
+typedef struct s_smx_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);
 
-#endif /* SYNCHRO_H_ */
+/** @brief Destroyes the given mutex variable */
+XBT_PUBLIC void xbt_mutex_destroy(xbt_mutex_t mutex);
+
+/** @brief Thread condition data type (opaque object)
+ *  @hideinitializer
+ */
+#ifdef __cplusplus
+typedef simgrid::kernel::activity::ConditionVariableImpl* xbt_cond_t;
+#else
+typedef struct s_smx_cond_* xbt_cond_t;
+#endif
+
+/** @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);
+/** @brief Blocks onto the given condition variable, but only for the given amount of time.
+ *  @return 0 on success, 1 on timeout */
+XBT_PUBLIC int 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);
+
+/** @} */
+
+SG_END_DECL()
+#endif /* _XBT_THREAD_H */