Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
51fee8ee07905e6ccd021e5b57c1c77e96fa212a
[simgrid.git] / include / xbt / synchro_core.h
1 /* xbt/synchro.h -- Synchronization tools                                   */
2 /* Usable in simulator, (or in real life when mixing with GRAS)             */
3
4 /* Copyright (c) 2009, 2010. The SimGrid Team.
5  * All rights reserved.                                                     */
6
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. */
9
10 /* splited away from synchro.h since we areused by dynar.h, and synchro.h uses dynar */
11
12
13 #ifndef _XBT_THREAD_H
14 #define _XBT_THREAD_H
15
16 #include "xbt/misc.h"           /* SG_BEGIN_DECL */
17 #include "xbt/function_types.h"
18
19 SG_BEGIN_DECL()
20
21 /** @addtogroup XBT_synchro
22  *  @brief XBT synchronization tools
23  * 
24  *  This section describes the XBT synchronization tools. It defines types and 
25  *  functions very close to the pthread API, but widly usable. When used from 
26  *  the simulator, you will lock simulated processes as expected. When used 
27  *  from GRAS programs compiled for in-situ execution, you have synchronization 
28  *  mecanism portable to windows and UNIX. Nice, isn't it?
29  * 
30  *  @{
31  */
32   /** @brief Thread data type (opaque object)
33    *  @hideinitializer
34    */
35 typedef struct s_xbt_thread_ *xbt_thread_t;
36
37 /** @brief Creates a new thread.
38  * 
39  * @param name          the name used in the logs for the newly created thread
40  * @param start_routine function to run
41  * @param param         parameter to pass to the function to run
42  * @param joinable      whether the new thread should be started joinable or detached
43  */
44 XBT_PUBLIC(xbt_thread_t) xbt_thread_create(const char *name,
45                                            void_f_pvoid_t start_routine,
46                                            void *param, int joinable);
47
48 /** @brief Get a reference to the currently running thread */
49 XBT_PUBLIC(xbt_thread_t) xbt_thread_self(void);
50
51 /** @brief Get the name of a given thread */
52 XBT_PUBLIC(const char *) xbt_thread_name(xbt_thread_t t);
53
54 /** @brief Get a reference to the name of the currently running thread */
55 XBT_PUBLIC(const char *) xbt_thread_self_name(void);
56
57 /** @brief Wait for the termination of the given thread, and free it (ie the XBT wrapper around it, the OS frees the rest) */
58 XBT_PUBLIC(void) xbt_thread_join(xbt_thread_t thread);
59
60 /** @brief Ends the life of the poor victim (not always working if it's computing, but working if it's blocked in the OS) */
61 XBT_PUBLIC(void) xbt_thread_cancel(xbt_thread_t thread);
62
63 /** @brief commit suicide */
64 XBT_PUBLIC(void) xbt_thread_exit(void);
65
66 /** @brief the current thread passes control to any possible thread wanting it */
67 XBT_PUBLIC(void) xbt_thread_yield(void);
68
69
70
71 /** @brief Thread mutex data type (opaque object)
72  *  @hideinitializer
73  */
74 typedef struct s_xbt_mutex_ *xbt_mutex_t;
75
76 /** @brief Creates a new mutex variable */
77 XBT_PUBLIC(xbt_mutex_t) xbt_mutex_init(void);
78
79 /** @brief Blocks onto the given mutex variable */
80 XBT_PUBLIC(void) xbt_mutex_acquire(xbt_mutex_t mutex);
81
82 /** @brief Releases the given mutex variable */
83 XBT_PUBLIC(void) xbt_mutex_release(xbt_mutex_t mutex);
84
85 /** @brief Blocks onto the given mutex variable, but only for the given amount of time. a timeout exception is raised if it was impossible to acquire it in the given time frame */
86 XBT_PUBLIC(void) xbt_mutex_timedacquire(xbt_mutex_t mutex, double delay);
87
88 /** @brief Destroyes the given mutex variable */
89 XBT_PUBLIC(void) xbt_mutex_destroy(xbt_mutex_t mutex);
90
91
92 /** @brief Thread condition data type (opaque object)
93  *  @hideinitializer
94  */
95 typedef struct s_xbt_cond_ *xbt_cond_t;
96
97 /** @brief Creates a condition variable */
98 XBT_PUBLIC(xbt_cond_t) xbt_cond_init(void);
99
100 /** @brief Blocks onto the given condition variable */
101 XBT_PUBLIC(void) xbt_cond_wait(xbt_cond_t cond, xbt_mutex_t mutex);
102 /** @brief Blocks onto the given condition variable, but only for the given amount of time. a timeout exception is raised if it was impossible to acquire it in the given time frame */
103 XBT_PUBLIC(void) xbt_cond_timedwait(xbt_cond_t cond,
104                                     xbt_mutex_t mutex, double delay);
105 /** @brief Signals the given mutex variable */
106 XBT_PUBLIC(void) xbt_cond_signal(xbt_cond_t cond);
107 /** @brief Broadcasts the given mutex variable */
108 XBT_PUBLIC(void) xbt_cond_broadcast(xbt_cond_t cond);
109 /** @brief Destroys the given mutex variable */
110 XBT_PUBLIC(void) xbt_cond_destroy(xbt_cond_t cond);
111
112 /** @} */
113
114 SG_END_DECL()
115 #endif                          /* _XBT_THREAD_H */