1 /* xbt/synchro_core.h -- Synchronization tools */
2 /* Usable in simulator, (or in real life when mixing with GRAS) */
4 /* Copyright (c) 2009-2014. The SimGrid Team.
5 * All rights reserved. */
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. */
10 /* splited away from synchro.h since we are used by dynar.h, and synchro.h uses dynar */
16 #include "xbt/misc.h" /* SG_BEGIN_DECL */
17 #include "xbt/function_types.h"
21 /** @addtogroup XBT_synchro
22 * @brief XBT synchronization tools
24 * This section describes the XBT synchronization tools.
25 * This is a portability layer (for windows and UNIX) of a pthread-like API. Nice, isn't it?
31 /** @brief Thread mutex data type (opaque object)
34 typedef struct s_smx_mutex_ *xbt_mutex_t;
36 /** @brief Creates a new mutex variable */
37 XBT_PUBLIC(xbt_mutex_t) xbt_mutex_init(void);
39 /** @brief Blocks onto the given mutex variable */
40 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_PUBLIC(int) xbt_mutex_try_acquire(xbt_mutex_t mutex);
50 /** @brief Releases the given mutex variable */
51 XBT_PUBLIC(void) xbt_mutex_release(xbt_mutex_t mutex);
53 /** @brief Destroyes the given mutex variable */
54 XBT_PUBLIC(void) xbt_mutex_destroy(xbt_mutex_t mutex);
57 /** @brief Thread condition data type (opaque object)
60 typedef struct s_smx_cond_ *xbt_cond_t;
62 /** @brief Creates a condition variable */
63 XBT_PUBLIC(xbt_cond_t) xbt_cond_init(void);
65 /** @brief Blocks onto the given condition variable */
66 XBT_PUBLIC(void) xbt_cond_wait(xbt_cond_t cond, xbt_mutex_t mutex);
67 /** @brief Blocks onto the given condition variable, but only for the given amount of time. a timeout exception is
68 * raised if it was impossible to acquire it in the given time frame */
69 XBT_PUBLIC(void) xbt_cond_timedwait(xbt_cond_t cond, xbt_mutex_t mutex, double delay);
70 /** @brief Signals the given mutex variable */
71 XBT_PUBLIC(void) xbt_cond_signal(xbt_cond_t cond);
72 /** @brief Broadcasts the given mutex variable */
73 XBT_PUBLIC(void) xbt_cond_broadcast(xbt_cond_t cond);
74 /** @brief Destroys the given mutex variable */
75 XBT_PUBLIC(void) xbt_cond_destroy(xbt_cond_t cond);
77 #define XBT_BARRIER_SERIAL_PROCESS -1
78 typedef struct s_xbt_bar_ *xbt_bar_t;
79 XBT_PUBLIC(xbt_bar_t) xbt_barrier_init( unsigned int count);
80 XBT_PUBLIC(void) xbt_barrier_destroy(xbt_bar_t bar);
81 XBT_PUBLIC(int) xbt_barrier_wait(xbt_bar_t bar);
86 #endif /* _XBT_THREAD_H */