1 /* xbt/synchro.h -- Simulated synchronization */
3 /* Copyright (c) 2009-2018. The SimGrid Team. */
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. */
11 #include "simgrid/forward.h"
12 #include <xbt/function_types.h>
13 #include <xbt/misc.h> /* SG_BEGIN_DECL */
17 /** @addtogroup XBT_synchro
18 * @brief XBT synchronization tools
20 * This section describes the simulated synchronization mechanisms,
21 * that you can use in your simulation without deadlocks. See @ref
22 * faq_MIA_thread_synchronization for details.
27 /** @brief Thread mutex data type (opaque object)
30 typedef struct s_smx_mutex_* xbt_mutex_t;
32 /** @brief Creates a new mutex variable */
33 XBT_PUBLIC xbt_mutex_t xbt_mutex_init(void);
35 /** @brief Blocks onto the given mutex variable */
36 XBT_PUBLIC void xbt_mutex_acquire(xbt_mutex_t mutex);
38 /** @brief Tries to block onto the given mutex variable
39 * Tries to lock a mutex, return 1 if the mutex is unlocked, else 0.
40 * This function does not block and wait for the mutex to be unlocked.
41 * @param mutex The mutex
42 * @return 1 - mutex free, 0 - mutex used
44 XBT_PUBLIC int xbt_mutex_try_acquire(xbt_mutex_t mutex);
46 /** @brief Releases the given mutex variable */
47 XBT_PUBLIC void xbt_mutex_release(xbt_mutex_t mutex);
49 /** @brief Destroyes the given mutex variable */
50 XBT_PUBLIC void xbt_mutex_destroy(xbt_mutex_t mutex);
52 /** @brief Thread condition data type (opaque object)
56 typedef simgrid::kernel::activity::ConditionVariableImpl* xbt_cond_t;
58 typedef struct s_smx_cond_* xbt_cond_t;
61 /** @brief Creates a condition variable */
62 XBT_PUBLIC xbt_cond_t xbt_cond_init(void);
64 /** @brief Blocks onto the given condition variable */
65 XBT_PUBLIC void xbt_cond_wait(xbt_cond_t cond, xbt_mutex_t mutex);
66 /** @brief Blocks onto the given condition variable, but only for the given amount of time.
67 * @return 0 on success, 1 on timeout */
68 XBT_PUBLIC int xbt_cond_timedwait(xbt_cond_t cond, xbt_mutex_t mutex, double delay);
69 /** @brief Signals the given mutex variable */
70 XBT_PUBLIC void xbt_cond_signal(xbt_cond_t cond);
71 /** @brief Broadcasts the given mutex variable */
72 XBT_PUBLIC void xbt_cond_broadcast(xbt_cond_t cond);
73 /** @brief Destroys the given mutex variable */
74 XBT_PUBLIC void xbt_cond_destroy(xbt_cond_t cond);
79 #endif /* _XBT_THREAD_H */