include/xbt/synchro_core.h

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