X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/30f1c8c5e4b8a7b6e593c7bb885ffad766ae6f5d..7938bb9fbff9b2cbada8e410ba196689584180c0:/include/xbt/parmap.h

diff --git a/include/xbt/parmap.h b/include/xbt/parmap.h
index 94125959b4..b53a6b0325 100644
--- a/include/xbt/parmap.h
+++ b/include/xbt/parmap.h
@@ -15,32 +15,43 @@
 
 SG_BEGIN_DECL()
 
-/** @addtogroup XBT_parmap
-  * @brief Parallel map.
+/** \addtogroup XBT_parmap
+  * \brief Parallel map.
   *
-  * A function is applied to the n first elements of a dynar in parallel,
-  * where n is the number of threads. The threads are persistent until the
-  * destruction of the parmap object.
+  * A function is applied to all elements of a dynar in parallel with n worker
+  * threads.
+  * The worker threads are persistent until the destruction of the parmap.
   *
-  * If there are more than n elements in the dynar, the worker threads should
-  * fetch themselves remaining work with xbt_parmap_next() and execute it.
+  * If there are more than n elements in the dynar, the worker threads are
+  * allowed to fetch themselves remaining work with xbt_parmap_next() and
+  * execute it.
   *
-  * @{
+  * \{
   */
-  /** \brief Queue data type (opaque type) */
 
+/** \brief Parallel map data type (opaque type) */
 typedef struct s_xbt_parmap *xbt_parmap_t;
 
-XBT_PUBLIC(xbt_parmap_t) xbt_parmap_new(unsigned int num_workers);
+/**
+ * \brief Synchronization mode of the worker threads of a parmap.
+ */
+typedef enum {
+  XBT_PARMAP_POSIX,          /**< use POSIX synchronization primitives */
+  XBT_PARMAP_FUTEX,          /**< use Linux futex system call */
+  XBT_PARMAP_BUSY_WAIT,      /**< busy waits (no system calls, maximum CPU usage) */
+  XBT_PARMAP_DEFAULT         /**< futex if available, posix otherwise */
+} e_xbt_parmap_mode_t;
+
+XBT_PUBLIC(xbt_parmap_t) xbt_parmap_new(unsigned int num_workers,
+    e_xbt_parmap_mode_t mode);
 XBT_PUBLIC(void) xbt_parmap_destroy(xbt_parmap_t parmap);
 
 XBT_PUBLIC(void) xbt_parmap_apply(xbt_parmap_t parmap,
                                   void_f_pvoid_t fun,
                                   xbt_dynar_t data);
 XBT_PUBLIC(void*) xbt_parmap_next(xbt_parmap_t parmap);
-XBT_PUBLIC(unsigned long) xbt_parmap_get_worker_id(xbt_parmap_t parmap);
 
-/** @} */
+/** \} */
 
 SG_END_DECL()