include/xbt/synchro.h

   1 /* xbt/synchro.h -- Simulated synchronization                               */
   2
   3 /* Copyright (c) 2009-2018. 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 #ifndef XBT_THREAD_H
   9 #define XBT_THREAD_H
  10
  11 #include <xbt/function_types.h>
  12 #include <xbt/misc.h> /* SG_BEGIN_DECL */
  13
  14 SG_BEGIN_DECL()
  15
  16 /** @addtogroup XBT_synchro
  17  *  @brief XBT synchronization tools
  18  *
  19  *  This section describes the simulated synchronization mechanisms,
  20  *  that you can use in your simulation without deadlocks. See @ref
  21  *  faq_MIA_thread_synchronization for details.
  22  *
  23  *  @{
  24  */
  25
  26 /** @brief Thread mutex data type (opaque object)
  27  *  @hideinitializer
  28  */
  29 typedef struct s_smx_mutex_* xbt_mutex_t;
  30
  31 /** @brief Creates a new mutex variable */
  32 XBT_PUBLIC xbt_mutex_t xbt_mutex_init(void);
  33
  34 /** @brief Blocks onto the given mutex variable */
  35 XBT_PUBLIC void xbt_mutex_acquire(xbt_mutex_t mutex);
  36
  37 /** @brief Tries to block onto the given mutex variable
  38  * Tries to lock a mutex, return 1 if the mutex is unlocked, else 0.
  39  * This function does not block and wait for the mutex to be unlocked.
  40  * \param mutex The mutex
  41  * \return 1 - mutex free, 0 - mutex used
  42  */
  43 XBT_PUBLIC int xbt_mutex_try_acquire(xbt_mutex_t mutex);
  44
  45 /** @brief Releases the given mutex variable */
  46 XBT_PUBLIC void xbt_mutex_release(xbt_mutex_t mutex);
  47
  48 /** @brief Destroyes the given mutex variable */
  49 XBT_PUBLIC void xbt_mutex_destroy(xbt_mutex_t mutex);
  50
  51 /** @brief Thread condition data type (opaque object)
  52  *  @hideinitializer
  53  */
  54 typedef struct s_smx_cond_* xbt_cond_t;
  55
  56 /** @brief Creates a condition variable */
  57 XBT_PUBLIC xbt_cond_t xbt_cond_init(void);
  58
  59 /** @brief Blocks onto the given condition variable */
  60 XBT_PUBLIC void xbt_cond_wait(xbt_cond_t cond, xbt_mutex_t mutex);
  61 /** @brief Blocks onto the given condition variable, but only for the given amount of time.
  62  *  @return 0 on success, 1 on timeout */
  63 XBT_PUBLIC int xbt_cond_timedwait(xbt_cond_t cond, xbt_mutex_t mutex, double delay);
  64 /** @brief Signals the given mutex variable */
  65 XBT_PUBLIC void xbt_cond_signal(xbt_cond_t cond);
  66 /** @brief Broadcasts the given mutex variable */
  67 XBT_PUBLIC void xbt_cond_broadcast(xbt_cond_t cond);
  68 /** @brief Destroys the given mutex variable */
  69 XBT_PUBLIC void xbt_cond_destroy(xbt_cond_t cond);
  70
  71 /** @} */
  72
  73 SG_END_DECL()
  74 #endif /* _XBT_THREAD_H */