StarPU Handbook
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
starpu_thread.h
Go to the documentation of this file.
1 /* StarPU --- Runtime system for heterogeneous multicore architectures.
2  *
3  * Copyright (C) 2010, 2012-2014 Université de Bordeaux
4  * Copyright (C) 2010, 2011, 2012, 2013, 2014 Centre National de la Recherche Scientifique
5  *
6  * StarPU is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU Lesser General Public License as published by
8  * the Free Software Foundation; either version 2.1 of the License, or (at
9  * your option) any later version.
10  *
11  * StarPU is distributed in the hope that it will be useful, but
12  * WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
14  *
15  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
16  */
17 
18 #ifndef __STARPU_THREAD_H__
19 #define __STARPU_THREAD_H__
20 
21 #ifdef __cplusplus
22 extern "C"
23 {
24 #endif
25 
26 #include <starpu_config.h>
27 #include <starpu_util.h>
28 #ifdef STARPU_SIMGRID
29 #include <xbt/synchro_core.h>
30 #include <msg/msg.h>
31 #elif !defined(_MSC_VER) || defined(BUILDING_STARPU)
32 #include <pthread.h>
33 #endif
34 #include <stdint.h>
35 
36 /*
37  * Encapsulation of the pthread_create function.
38  */
39 
40 #ifdef STARPU_SIMGRID
41 
42 typedef msg_process_t starpu_pthread_t;
43 typedef int starpu_pthread_attr_t;
44 
45 int starpu_pthread_create_on(char *name, starpu_pthread_t *thread, const starpu_pthread_attr_t *attr, void *(*start_routine) (void *), void *arg, int where);
46 int starpu_pthread_create(starpu_pthread_t *thread, const starpu_pthread_attr_t *attr, void *(*start_routine) (void *), void *arg);
47 int starpu_pthread_join(starpu_pthread_t thread, void **retval);
48 int starpu_pthread_exit(void *retval);
49 int starpu_pthread_attr_init(starpu_pthread_attr_t *attr);
50 int starpu_pthread_attr_destroy(starpu_pthread_attr_t *attr);
51 int starpu_pthread_attr_setdetachstate(starpu_pthread_attr_t *attr, int detachstate);
52 
53 #elif !defined(_MSC_VER) || defined(BUILDING_STARPU) /* STARPU_SIMGRID */
54 
55 typedef pthread_t starpu_pthread_t;
56 typedef pthread_attr_t starpu_pthread_attr_t;
57 
58 #define starpu_pthread_create pthread_create
59 #define starpu_pthread_create_on(name, thread, attr, routine, arg, where) starpu_pthread_create(thread, attr, routine, arg)
60 #define starpu_pthread_join pthread_join
61 #define starpu_pthread_exit pthread_exit
62 #define starpu_pthread_attr_init pthread_attr_init
63 #define starpu_pthread_attr_destroy pthread_attr_destroy
64 #define starpu_pthread_attr_setdetachstate pthread_attr_setdetachstate
65 
66 #endif /* STARPU_SIMGRID, _MSC_VER */
67 
68 /*
69  * Encapsulation of the pthread_mutex_* functions.
70  */
71 
72 #ifdef STARPU_SIMGRID
73 typedef xbt_mutex_t starpu_pthread_mutex_t;
74 typedef int starpu_pthread_mutexattr_t;
75 
76 #define STARPU_PTHREAD_MUTEX_INITIALIZER NULL
77 
78 int starpu_pthread_mutex_init(starpu_pthread_mutex_t *mutex, const starpu_pthread_mutexattr_t *mutexattr);
79 int starpu_pthread_mutex_destroy(starpu_pthread_mutex_t *mutex);
80 int starpu_pthread_mutex_lock(starpu_pthread_mutex_t *mutex);
81 int starpu_pthread_mutex_unlock(starpu_pthread_mutex_t *mutex);
82 int starpu_pthread_mutex_trylock(starpu_pthread_mutex_t *mutex);
83 int starpu_pthread_mutexattr_gettype(const starpu_pthread_mutexattr_t *attr, int *type);
84 int starpu_pthread_mutexattr_settype(starpu_pthread_mutexattr_t *attr, int type);
85 int starpu_pthread_mutexattr_destroy(starpu_pthread_mutexattr_t *attr);
86 int starpu_pthread_mutexattr_init(starpu_pthread_mutexattr_t *attr);
87 
88 #elif !defined(_MSC_VER) || defined(BUILDING_STARPU) /* !STARPU_SIMGRID */
89 
90 typedef pthread_mutex_t starpu_pthread_mutex_t;
91 typedef pthread_mutexattr_t starpu_pthread_mutexattr_t;
92 
93 #define starpu_pthread_mutex_init pthread_mutex_init
94 #define starpu_pthread_mutex_destroy pthread_mutex_destroy
95 #define starpu_pthread_mutexattr_gettype pthread_mutexattr_gettype
96 #define starpu_pthread_mutexattr_settype pthread_mutexattr_settype
97 #define starpu_pthread_mutexattr_destroy pthread_mutexattr_destroy
98 #define starpu_pthread_mutexattr_init pthread_mutexattr_init
99 
100 int starpu_pthread_mutex_lock(starpu_pthread_mutex_t *mutex);
101 int starpu_pthread_mutex_unlock(starpu_pthread_mutex_t *mutex);
102 int starpu_pthread_mutex_trylock(starpu_pthread_mutex_t *mutex);
103 
104 #define STARPU_PTHREAD_MUTEX_INITIALIZER PTHREAD_MUTEX_INITIALIZER
105 
106 #endif /* STARPU_SIMGRID, _MSC_VER */
107 
108 /*
109  * Encapsulation of the pthread_key_* functions.
110  */
111 #ifdef STARPU_SIMGRID
112 
113 typedef int starpu_pthread_key_t;
114 int starpu_pthread_key_create(starpu_pthread_key_t *key, void (*destr_function) (void *));
115 int starpu_pthread_key_delete(starpu_pthread_key_t key);
116 int starpu_pthread_setspecific(starpu_pthread_key_t key, const void *pointer);
117 void *starpu_pthread_getspecific(starpu_pthread_key_t key);
118 
119 #elif !defined(_MSC_VER) || defined(BUILDING_STARPU) /* !STARPU_SIMGRID */
120 
121 typedef pthread_key_t starpu_pthread_key_t;
122 
123 #define starpu_pthread_key_create pthread_key_create
124 #define starpu_pthread_key_delete pthread_key_delete
125 #define starpu_pthread_setspecific pthread_setspecific
126 #define starpu_pthread_getspecific pthread_getspecific
127 
128 #endif /* STARPU_SIMGRID, _MSC_VER */
129 
130 /*
131  * Encapsulation of the pthread_cond_* functions.
132  */
133 
134 #ifdef STARPU_SIMGRID
135 
136 typedef xbt_cond_t starpu_pthread_cond_t;
137 typedef int starpu_pthread_condattr_t;
138 #define STARPU_PTHREAD_COND_INITIALIZER NULL
139 
140 int starpu_pthread_cond_init(starpu_pthread_cond_t *cond, starpu_pthread_condattr_t *cond_attr);
141 int starpu_pthread_cond_signal(starpu_pthread_cond_t *cond);
142 int starpu_pthread_cond_broadcast(starpu_pthread_cond_t *cond);
143 int starpu_pthread_cond_wait(starpu_pthread_cond_t *cond, starpu_pthread_mutex_t *mutex);
144 int starpu_pthread_cond_timedwait(starpu_pthread_cond_t *cond, starpu_pthread_mutex_t *mutex, const struct timespec *abstime);
145 int starpu_pthread_cond_destroy(starpu_pthread_cond_t *cond);
146 
147 #elif !defined(_MSC_VER) || defined(BUILDING_STARPU) /* !STARPU_SIMGRID */
148 
149 typedef pthread_cond_t starpu_pthread_cond_t;
150 typedef pthread_condattr_t starpu_pthread_condattr_t;
151 #define STARPU_PTHREAD_COND_INITIALIZER PTHREAD_COND_INITIALIZER
152 
153 #define starpu_pthread_cond_init pthread_cond_init
154 #define starpu_pthread_cond_signal pthread_cond_signal
155 #define starpu_pthread_cond_broadcast pthread_cond_broadcast
156 
157 int starpu_pthread_cond_wait(starpu_pthread_cond_t *cond, starpu_pthread_mutex_t *mutex);
158 
159 #define starpu_pthread_cond_timedwait pthread_cond_timedwait
160 #define starpu_pthread_cond_destroy pthread_cond_destroy
161 
162 #endif /* STARPU_SIMGRID, _MSC_VER */
163 
164 /*
165  * Encapsulation of the pthread_rwlock_* functions.
166  */
167 
168 #ifdef STARPU_SIMGRID
169 
170 typedef xbt_mutex_t starpu_pthread_rwlock_t;
171 typedef int starpu_pthread_rwlockattr_t;
172 
173 int starpu_pthread_rwlock_init(starpu_pthread_rwlock_t *rwlock, const starpu_pthread_rwlockattr_t *attr);
174 int starpu_pthread_rwlock_destroy(starpu_pthread_rwlock_t *rwlock);
175 int starpu_pthread_rwlock_rdlock(starpu_pthread_rwlock_t *rwlock);
176 int starpu_pthread_rwlock_tryrdlock(starpu_pthread_rwlock_t *rwlock);
177 int starpu_pthread_rwlock_wrlock(starpu_pthread_rwlock_t *rwlock);
178 int starpu_pthread_rwlock_trywrlock(starpu_pthread_rwlock_t *rwlock);
179 int starpu_pthread_rwlock_unlock(starpu_pthread_rwlock_t *rwlock);
180 
181 #elif !defined(_MSC_VER) || defined(BUILDING_STARPU) /* !STARPU_SIMGRID */
182 
183 typedef pthread_rwlock_t starpu_pthread_rwlock_t;
184 typedef pthread_rwlockattr_t starpu_pthread_rwlockattr_t;
185 
186 #define starpu_pthread_rwlock_init pthread_rwlock_init
187 #define starpu_pthread_rwlock_destroy pthread_rwlock_destroy
188 
189 int starpu_pthread_rwlock_rdlock(starpu_pthread_rwlock_t *rwlock);
190 int starpu_pthread_rwlock_tryrdlock(starpu_pthread_rwlock_t *rwlock);
191 int starpu_pthread_rwlock_wrlock(starpu_pthread_rwlock_t *rwlock);
192 int starpu_pthread_rwlock_trywrlock(starpu_pthread_rwlock_t *rwlock);
193 int starpu_pthread_rwlock_unlock(starpu_pthread_rwlock_t *rwlock);
194 
195 #endif /* STARPU_SIMGRID, _MSC_VER */
196 
197 /*
198  * Encapsulation of the pthread_barrier_* functions.
199  */
200 
201 #if defined(STARPU_SIMGRID) || (!defined(STARPU_HAVE_PTHREAD_BARRIER) && (!defined(_MSC_VER) || defined(BUILDING_STARPU)))
202 
203 #if defined(STARPU_SIMGRID) && defined(STARPU_SIMGRID_HAVE_XBT_BARRIER_INIT)
204 typedef xbt_bar_t starpu_pthread_barrier_t;
205 typedef int starpu_pthread_barrierattr_t;
206 #define STARPU_PTHREAD_BARRIER_SERIAL_THREAD XBT_BARRIER_SERIAL_PROCESS
207 #else
208 typedef struct {
209  starpu_pthread_mutex_t mutex;
210  starpu_pthread_cond_t cond;
211  unsigned count;
212  unsigned done;
213 } starpu_pthread_barrier_t;
214 typedef int starpu_pthread_barrierattr_t;
215 #define STARPU_PTHREAD_BARRIER_SERIAL_THREAD -1
216 #endif
217 
218 int starpu_pthread_barrier_init(starpu_pthread_barrier_t *barrier, const starpu_pthread_barrierattr_t *attr, unsigned count);
219 int starpu_pthread_barrier_destroy(starpu_pthread_barrier_t *barrier);
220 int starpu_pthread_barrier_wait(starpu_pthread_barrier_t *barrier);
221 
222 #elif !defined(_MSC_VER) /* STARPU_SIMGRID, !STARPU_HAVE_PTHREAD_BARRIER */
223 
224 typedef pthread_barrier_t starpu_pthread_barrier_t;
225 typedef pthread_barrierattr_t starpu_pthread_barrierattr_t;
226 
227 #define starpu_pthread_barrier_init pthread_barrier_init
228 #define starpu_pthread_barrier_destroy pthread_barrier_destroy
229 
230 int starpu_pthread_barrier_wait(starpu_pthread_barrier_t *barrier);
231 #define STARPU_PTHREAD_BARRIER_SERIAL_THREAD PTHREAD_BARRIER_SERIAL_THREAD
232 
233 #endif /* STARPU_SIMGRID, !STARPU_HAVE_PTHREAD_BARRIER, _MSC_VER */
234 
235 /*
236  * Encapsulation of the pthread_spin_* functions.
237  */
238 
239 #if defined(STARPU_SIMGRID) || (defined(STARPU_LINUX_SYS) && defined(STARPU_HAVE_XCHG)) || !defined(STARPU_HAVE_PTHREAD_SPIN_LOCK)
240 
241 typedef struct
242 {
243 #ifdef STARPU_SIMGRID
244  int taken;
245 #elif defined(STARPU_LINUX_SYS) && defined(STARPU_HAVE_XCHG)
246  unsigned taken STARPU_ATTRIBUTE_ALIGNED(16);
247 #else /* we only have a trivial implementation yet ! */
248  uint32_t taken STARPU_ATTRIBUTE_ALIGNED(16);
249 #endif
251 
257 
258 #elif !defined(_MSC_VER) /* !( defined(STARPU_SIMGRID) || !defined(STARPU_HAVE_PTHREAD_SPIN_LOCK)) */
259 
260 typedef pthread_spinlock_t starpu_pthread_spinlock_t;
261 #define starpu_pthread_spin_init pthread_spin_init
262 #define starpu_pthread_spin_destroy pthread_spin_destroy
263 #define starpu_pthread_spin_lock pthread_spin_lock
264 #define starpu_pthread_spin_trylock pthread_spin_trylock
265 #define starpu_pthread_spin_unlock pthread_spin_unlock
266 
267 #endif /* !( defined(STARPU_SIMGRID) || !defined(STARPU_HAVE_PTHREAD_SPIN_LOCK)) */
268 
269 /*
270  * Other needed pthread definitions
271  */
272 
273 #if defined(_MSC_VER) && !defined(BUILDING_STARPU)
274 typedef void* starpu_pthread_rwlock_t;
275 typedef void* starpu_pthread_mutex_t;
276 typedef void* starpu_pthread_cond_t;
277 typedef void* starpu_pthread_barrier_t;
278 #endif /* _MSC_VER */
279 
280 #ifdef __cplusplus
281 }
282 #endif
283 
284 #endif /* __STARPU_THREAD_H__ */
285 
286 
int starpu_pthread_spin_trylock(starpu_pthread_spinlock_t *lock)
int starpu_pthread_barrier_wait(starpu_pthread_barrier_t *barrier)
#define STARPU_ATTRIBUTE_ALIGNED(size)
Definition: starpu_util.h:57
int starpu_pthread_mutexattr_destroy(starpu_pthread_mutexattr_t *attr)
int starpu_pthread_spin_unlock(starpu_pthread_spinlock_t *lock)
int starpu_pthread_mutex_unlock(starpu_pthread_mutex_t *mutex)
void * starpu_pthread_getspecific(starpu_pthread_key_t key)
int starpu_pthread_spin_lock(starpu_pthread_spinlock_t *lock)
int starpu_pthread_rwlock_rdlock(starpu_pthread_rwlock_t *rwlock)
int starpu_pthread_barrier_destroy(starpu_pthread_barrier_t *barrier)
int starpu_pthread_attr_destroy(starpu_pthread_attr_t *attr)
int starpu_pthread_cond_timedwait(starpu_pthread_cond_t *cond, starpu_pthread_mutex_t *mutex, const struct timespec *abstime)
int starpu_pthread_mutexattr_init(starpu_pthread_mutexattr_t *attr)
int starpu_pthread_cond_wait(starpu_pthread_cond_t *cond, starpu_pthread_mutex_t *mutex)
int starpu_pthread_setspecific(starpu_pthread_key_t key, const void *pointer)
int starpu_pthread_rwlock_wrlock(starpu_pthread_rwlock_t *rwlock)
int starpu_pthread_rwlock_unlock(starpu_pthread_rwlock_t *rwlock)
int starpu_pthread_spin_init(starpu_pthread_spinlock_t *lock, int pshared)
int starpu_pthread_barrier_init(starpu_pthread_barrier_t *barrier, const starpu_pthread_barrierattr_t *attr, unsigned count)
int starpu_pthread_mutex_destroy(starpu_pthread_mutex_t *mutex)
int starpu_pthread_mutexattr_gettype(const starpu_pthread_mutexattr_t *attr, int *type)
Definition: starpu_thread.h:241
int starpu_pthread_cond_broadcast(starpu_pthread_cond_t *cond)
Definition: starpu_thread.h:208
int starpu_pthread_mutexattr_settype(starpu_pthread_mutexattr_t *attr, int type)
int starpu_pthread_join(starpu_pthread_t thread, void **retval)
int starpu_pthread_mutex_init(starpu_pthread_mutex_t *mutex, const starpu_pthread_mutexattr_t *mutexattr)
int starpu_pthread_key_delete(starpu_pthread_key_t key)
int starpu_pthread_rwlock_trywrlock(starpu_pthread_rwlock_t *rwlock)
int starpu_pthread_rwlock_init(starpu_pthread_rwlock_t *rwlock, const starpu_pthread_rwlockattr_t *attr)
int starpu_pthread_cond_destroy(starpu_pthread_cond_t *cond)
int starpu_pthread_cond_init(starpu_pthread_cond_t *cond, starpu_pthread_condattr_t *cond_attr)
int starpu_pthread_create(starpu_pthread_t *thread, const starpu_pthread_attr_t *attr, void *(*start_routine)(void *), void *arg)
int starpu_pthread_attr_init(starpu_pthread_attr_t *attr)
int starpu_pthread_attr_setdetachstate(starpu_pthread_attr_t *attr, int detachstate)
int starpu_pthread_rwlock_tryrdlock(starpu_pthread_rwlock_t *rwlock)
int starpu_pthread_mutex_lock(starpu_pthread_mutex_t *mutex)
int starpu_pthread_exit(void *retval)
int starpu_pthread_spin_destroy(starpu_pthread_spinlock_t *lock)
const char * name
Definition: starpu_task.h:125
int starpu_pthread_mutex_trylock(starpu_pthread_mutex_t *mutex)
int starpu_pthread_key_create(starpu_pthread_key_t *key, void(*destr_function)(void *))
int starpu_pthread_cond_signal(starpu_pthread_cond_t *cond)
int starpu_pthread_rwlock_destroy(starpu_pthread_rwlock_t *rwlock)