include/xbt/synchro_core.h

   1 /* xbt/synchro_core.h -- Simulated synchronization                          */
   2
   3 /* Copyright (c) 2009-2016. The SimGrid Team.                               */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 /* splited away from synchro.h since we are used by dynar.h, and synchro.h uses dynar */
   9
  10
  11 #ifndef _XBT_THREAD_H
  12 #define _XBT_THREAD_H
  13
  14 #include <simgrid/simix.h>
  15
  16 #include "xbt/misc.h"           /* SG_BEGIN_DECL */
  17 #include "xbt/function_types.h"
  18
  19 SG_BEGIN_DECL()
  20
  21 /** @addtogroup XBT_synchro
  22  *  @brief XBT synchronization tools
  23  *
  24  *  This section describes the simulated synchronization mechanisms,
  25  *  that you can use in your simulation without deadlocks. See @ref
  26  *  faq_MIA_thread_synchronization for details.
  27  *
  28  *  @{
  29  */
  30
  31 /** @brief Thread mutex data type (opaque object)
  32  *  @hideinitializer
  33  */
  34 typedef struct s_smx_mutex_ *xbt_mutex_t;
  35
  36 /** @brief Creates a new mutex variable */
  37 XBT_PUBLIC(xbt_mutex_t) xbt_mutex_init(void);
  38
  39 /** @brief Blocks onto the given mutex variable */
  40 XBT_PUBLIC(void) xbt_mutex_acquire(xbt_mutex_t mutex);
  41
  42 /** @brief Tries to block onto the given mutex variable
  43  * Tries to lock a mutex, return 1 if the mutex is unlocked, else 0.
  44  * This function does not block and wait for the mutex to be unlocked.
  45  * \param mutex The mutex
  46  * \return 1 - mutex free, 0 - mutex used
  47  */
  48 XBT_PUBLIC(int) xbt_mutex_try_acquire(xbt_mutex_t mutex);
  49
  50 /** @brief Releases the given mutex variable */
  51 XBT_PUBLIC(void) xbt_mutex_release(xbt_mutex_t mutex);
  52
  53 /** @brief Destroyes the given mutex variable */
  54 XBT_PUBLIC(void) xbt_mutex_destroy(xbt_mutex_t mutex);
  55
  56
  57 /** @brief Thread condition data type (opaque object)
  58  *  @hideinitializer
  59  */
  60 typedef struct s_smx_cond_ *xbt_cond_t;
  61
  62 /** @brief Creates a condition variable */
  63 XBT_PUBLIC(xbt_cond_t) xbt_cond_init(void);
  64
  65 /** @brief Blocks onto the given condition variable */
  66 XBT_PUBLIC(void) xbt_cond_wait(xbt_cond_t cond, xbt_mutex_t mutex);
  67 /** @brief Blocks onto the given condition variable, but only for the given amount of time. a timeout exception is
  68  *   raised if it was impossible to acquire it in the given time frame */
  69 XBT_PUBLIC(void) xbt_cond_timedwait(xbt_cond_t cond, xbt_mutex_t mutex, double delay);
  70 /** @brief Signals the given mutex variable */
  71 XBT_PUBLIC(void) xbt_cond_signal(xbt_cond_t cond);
  72 /** @brief Broadcasts the given mutex variable */
  73 XBT_PUBLIC(void) xbt_cond_broadcast(xbt_cond_t cond);
  74 /** @brief Destroys the given mutex variable */
  75 XBT_PUBLIC(void) xbt_cond_destroy(xbt_cond_t cond);
  76
  77 #define XBT_BARRIER_SERIAL_PROCESS -1
  78 typedef struct s_xbt_bar_ *xbt_bar_t;
  79 XBT_PUBLIC(xbt_bar_t) xbt_barrier_init( unsigned int count);
  80 XBT_PUBLIC(void) xbt_barrier_destroy(xbt_bar_t bar);
  81 XBT_PUBLIC(int) xbt_barrier_wait(xbt_bar_t bar);
  82
  83 /** @} */
  84
  85 SG_END_DECL()
  86 #endif                          /* _XBT_THREAD_H */