Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
84bdb797989ca9a646c54c0150395a2f6960eca7
[simgrid.git] / include / xbt / synchro.h
1 /* $Id$ */
2
3 /* xbt/synchro.h -- Synchronization tools                                   */
4 /* Usable in simulator, (or in real life when mixing with GRAS)             */
5
6 /* Copyright (c) 2007 Martin Quinson. All rights reserved.                  */
7
8 /* This program is free software; you can redistribute it and/or modify it
9  * under the terms of the license (GNU LGPL) which comes with this package. */
10
11
12 #ifndef _XBT_THREAD_H
13 #define _XBT_THREAD_H
14
15 #include "xbt/misc.h" /* SG_BEGIN_DECL */
16 #include "xbt/function_types.h"
17
18 SG_BEGIN_DECL()
19
20 /** @addtogroup XBT_synchro
21  *  @brief XBT synchronization tools
22  * 
23  *  This section describes the XBT synchronization tools. It defines types and 
24  *  functions very close to the pthread API, but widly usable. When used from 
25  *  the simulator, you will lock simulated processes as expected. When used 
26  *  from GRAS programs compiled for in-situ execution, you have synchronization 
27  *  mecanism portable to windows and UNIX. Nice, isn't it?
28  * 
29  *  @{
30  */
31
32   /** \brief Thread data type (opaque structure) */
33   typedef struct s_xbt_thread_ *xbt_thread_t;
34
35   XBT_PUBLIC(xbt_thread_t) xbt_thread_create(void_f_pvoid_t start_routine,void* param);
36   XBT_PUBLIC(void) xbt_thread_exit();
37   XBT_PUBLIC(xbt_thread_t) xbt_thread_self(void);
38   /* xbt_thread_join frees the joined thread (ie the XBT wrapper around it, the OS frees the rest) */
39   XBT_PUBLIC(void) xbt_thread_join(xbt_thread_t thread);
40   /* Brutally ends the life of the poor victim */
41   XBT_PUBLIC(void) xbt_thread_destroy(xbt_thread_t thread);
42   /* suicide */
43   XBT_PUBLIC(void) xbt_thread_exit(void);
44   /* current thread pass control to any possible thread wanting it */
45   XBT_PUBLIC(void) xbt_thread_yield(void);
46
47
48   /** \brief Thread mutex data type (opaque structure) */
49   typedef struct s_xbt_mutex_ *xbt_mutex_t;
50
51   XBT_PUBLIC(xbt_mutex_t) xbt_mutex_init(void);
52   XBT_PUBLIC(void)        xbt_mutex_lock(xbt_mutex_t mutex);
53   XBT_PUBLIC(void)        xbt_mutex_unlock(xbt_mutex_t mutex);
54   XBT_PUBLIC(void)        xbt_mutex_destroy(xbt_mutex_t mutex);
55
56
57   /** \brief Thread condition data type (opaque structure) */
58   typedef struct s_xbt_cond_ *xbt_cond_t;
59
60   XBT_PUBLIC(xbt_cond_t) xbt_cond_init(void);
61   XBT_PUBLIC(void)       xbt_cond_wait(xbt_cond_t cond,
62                                        xbt_mutex_t mutex);
63   XBT_PUBLIC(void)       xbt_cond_timedwait(xbt_cond_t cond,
64                                             xbt_mutex_t mutex,
65                                             double delay);
66   XBT_PUBLIC(void)       xbt_cond_signal(xbt_cond_t cond);
67   XBT_PUBLIC(void)       xbt_cond_broadcast(xbt_cond_t cond);
68   XBT_PUBLIC(void)       xbt_cond_destroy(xbt_cond_t cond);
69
70 /** @} */
71
72 SG_END_DECL()
73
74 #endif /* _XBT_THREAD_H */