1 /* xbt/synchro.h -- Simulated synchronization */
3 /* Copyright (c) 2009-2019. 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)
31 typedef simgrid::kernel::activity::MutexImpl* xbt_mutex_t;
33 typedef struct s_smx_mutex_* xbt_mutex_t;
36 /** @brief Creates a new mutex variable */
37 XBT_ATTRIB_DEPRECATED_v328("Please use sg_mutex_init") XBT_PUBLIC xbt_mutex_t xbt_mutex_init(void);
39 /** @brief Blocks onto the given mutex variable */
40 XBT_ATTRIB_DEPRECATED_v328("Please use sg_mutex_lock") XBT_PUBLIC void xbt_mutex_acquire(xbt_mutex_t mutex);
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
48 XBT_ATTRIB_DEPRECATED_v328("Please use sg_mutex_try_lock") XBT_PUBLIC int xbt_mutex_try_acquire(xbt_mutex_t mutex);
50 /** @brief Releases the given mutex variable */
51 XBT_ATTRIB_DEPRECATED_v328("Please use sg_mutex_unlock") XBT_PUBLIC void xbt_mutex_release(xbt_mutex_t mutex);
53 /** @brief Destroys the given mutex variable */
54 XBT_ATTRIB_DEPRECATED_v328("Please use sg_mutex_destroy") XBT_PUBLIC void xbt_mutex_destroy(xbt_mutex_t mutex);
56 /** @brief Thread condition data type (opaque object)
60 typedef simgrid::kernel::activity::ConditionVariableImpl* xbt_cond_t;
62 typedef struct s_smx_cond_* xbt_cond_t;
65 /** @brief Creates a condition variable */
66 XBT_ATTRIB_DEPRECATED_v328("Please use sg_cond_init") XBT_PUBLIC xbt_cond_t xbt_cond_init(void);
68 /** @brief Blocks onto the given condition variable */
69 XBT_ATTRIB_DEPRECATED_v328("Please use sg_cond_wait") XBT_PUBLIC void xbt_cond_wait(xbt_cond_t cond, xbt_mutex_t mutex);
70 /** @brief Blocks onto the given condition variable, but only for the given amount of time.
71 * @return 0 on success, 1 on timeout */
72 XBT_ATTRIB_DEPRECATED_v328("Please use sg_cond_wait_for") XBT_PUBLIC
73 int xbt_cond_timedwait(xbt_cond_t cond, xbt_mutex_t mutex, double delay);
74 /** @brief Signals the given mutex variable */
75 XBT_ATTRIB_DEPRECATED_v328("Please use sg_cond_notify_one") XBT_PUBLIC void xbt_cond_signal(xbt_cond_t cond);
76 /** @brief Broadcasts the given mutex variable */
77 XBT_ATTRIB_DEPRECATED_v328("Please use sg_cond_notify_all") XBT_PUBLIC void xbt_cond_broadcast(xbt_cond_t cond);
78 /** @brief Destroys the given mutex variable */
79 XBT_ATTRIB_DEPRECATED_v328("Please use sg_cond_destroy") XBT_PUBLIC void xbt_cond_destroy(xbt_cond_t cond);
84 #endif /* _XBT_THREAD_H */