Logo AND Algorithmique Numérique Distribuée

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