StarPU Handbook
starpu_thread.h
Go to the documentation of this file.
1 /* StarPU --- Runtime system for heterogeneous multicore architectures.
2  *
3  * Copyright (C) 2010, 2012-2015 Université de Bordeaux
4  * Copyright (C) 2010, 2011, 2012, 2013, 2014 CNRS
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 #ifdef STARPU_HAVE_SIMGRID_MSG_H
31 #include <simgrid/msg.h>
32 #else
33 #include <msg/msg.h>
34 #endif
35 #elif !defined(_MSC_VER) || defined(BUILDING_STARPU)
36 #include <pthread.h>
37 #endif
38 #include <stdint.h>
39 
40 /*
41  * Encapsulation of the pthread_create function.
42  */
43 
44 #ifdef STARPU_SIMGRID
45 
46 typedef msg_process_t starpu_pthread_t;
47 typedef int starpu_pthread_attr_t;
48 
49 int starpu_pthread_create_on(char *name, starpu_pthread_t *thread, const starpu_pthread_attr_t *attr, void *(*start_routine) (void *), void *arg, msg_host_t host);
50 int starpu_pthread_create(starpu_pthread_t *thread, const starpu_pthread_attr_t *attr, void *(*start_routine) (void *), void *arg);
51 int starpu_pthread_join(starpu_pthread_t thread, void **retval);
52 int starpu_pthread_exit(void *retval) STARPU_ATTRIBUTE_NORETURN;
53 int starpu_pthread_attr_init(starpu_pthread_attr_t *attr);
54 int starpu_pthread_attr_destroy(starpu_pthread_attr_t *attr);
55 int starpu_pthread_attr_setdetachstate(starpu_pthread_attr_t *attr, int detachstate);
56 
57 #elif !defined(_MSC_VER) || defined(BUILDING_STARPU) /* STARPU_SIMGRID */
58 
59 typedef pthread_t starpu_pthread_t;
60 typedef pthread_attr_t starpu_pthread_attr_t;
61 
62 #define starpu_pthread_create pthread_create
63 #define starpu_pthread_create_on(name, thread, attr, routine, arg, where) starpu_pthread_create(thread, attr, routine, arg)
64 #define starpu_pthread_join pthread_join
65 #define starpu_pthread_exit pthread_exit
66 #define starpu_pthread_attr_init pthread_attr_init
67 #define starpu_pthread_attr_destroy pthread_attr_destroy
68 #define starpu_pthread_attr_setdetachstate pthread_attr_setdetachstate
69 
70 #endif /* STARPU_SIMGRID, _MSC_VER */
71 
72 /*
73  * Encapsulation of the pthread_mutex_* functions.
74  */
75 
76 #ifdef STARPU_SIMGRID
77 typedef xbt_mutex_t starpu_pthread_mutex_t;
78 typedef int starpu_pthread_mutexattr_t;
79 
80 #define STARPU_PTHREAD_MUTEX_INITIALIZER NULL
81 
82 int starpu_pthread_mutex_init(starpu_pthread_mutex_t *mutex, const starpu_pthread_mutexattr_t *mutexattr);
83 int starpu_pthread_mutex_destroy(starpu_pthread_mutex_t *mutex);
84 int starpu_pthread_mutex_lock(starpu_pthread_mutex_t *mutex);
85 int starpu_pthread_mutex_unlock(starpu_pthread_mutex_t *mutex);
86 int starpu_pthread_mutex_trylock(starpu_pthread_mutex_t *mutex);
87 int starpu_pthread_mutexattr_gettype(const starpu_pthread_mutexattr_t *attr, int *type);
88 int starpu_pthread_mutexattr_settype(starpu_pthread_mutexattr_t *attr, int type);
89 int starpu_pthread_mutexattr_destroy(starpu_pthread_mutexattr_t *attr);
90 int starpu_pthread_mutexattr_init(starpu_pthread_mutexattr_t *attr);
91 
92 #elif !defined(_MSC_VER) || defined(BUILDING_STARPU) /* !STARPU_SIMGRID */
93 
94 typedef pthread_mutex_t starpu_pthread_mutex_t;
95 typedef pthread_mutexattr_t starpu_pthread_mutexattr_t;
96 
97 #define starpu_pthread_mutex_init pthread_mutex_init
98 #define starpu_pthread_mutex_destroy pthread_mutex_destroy
99 #define starpu_pthread_mutexattr_gettype pthread_mutexattr_gettype
100 #define starpu_pthread_mutexattr_settype pthread_mutexattr_settype
101 #define starpu_pthread_mutexattr_destroy pthread_mutexattr_destroy
102 #define starpu_pthread_mutexattr_init pthread_mutexattr_init
103 
104 int starpu_pthread_mutex_lock(starpu_pthread_mutex_t *mutex);
105 int starpu_pthread_mutex_unlock(starpu_pthread_mutex_t *mutex);
106 int starpu_pthread_mutex_trylock(starpu_pthread_mutex_t *mutex);
107 
108 #define STARPU_PTHREAD_MUTEX_INITIALIZER PTHREAD_MUTEX_INITIALIZER
109 
110 #endif /* STARPU_SIMGRID, _MSC_VER */
111 
112 /*
113  * Encapsulation of the pthread_key_* functions.
114  */
115 #ifdef STARPU_SIMGRID
116 
117 typedef int starpu_pthread_key_t;
118 int starpu_pthread_key_create(starpu_pthread_key_t *key, void (*destr_function) (void *));
119 int starpu_pthread_key_delete(starpu_pthread_key_t key);
120 int starpu_pthread_setspecific(starpu_pthread_key_t key, const void *pointer);
121 void *starpu_pthread_getspecific(starpu_pthread_key_t key);
122 
123 #elif !defined(_MSC_VER) || defined(BUILDING_STARPU) /* !STARPU_SIMGRID */
124 
125 typedef pthread_key_t starpu_pthread_key_t;
126 
127 #define starpu_pthread_key_create pthread_key_create
128 #define starpu_pthread_key_delete pthread_key_delete
129 #define starpu_pthread_setspecific pthread_setspecific
130 #define starpu_pthread_getspecific pthread_getspecific
131 
132 #endif /* STARPU_SIMGRID, _MSC_VER */
133 
134 /*
135  * Encapsulation of the pthread_cond_* functions.
136  */
137 
138 #ifdef STARPU_SIMGRID
139 
140 typedef xbt_cond_t starpu_pthread_cond_t;
141 typedef int starpu_pthread_condattr_t;
142 #define STARPU_PTHREAD_COND_INITIALIZER NULL
143 
144 int starpu_pthread_cond_init(starpu_pthread_cond_t *cond, starpu_pthread_condattr_t *cond_attr);
145 int starpu_pthread_cond_signal(starpu_pthread_cond_t *cond);
146 int starpu_pthread_cond_broadcast(starpu_pthread_cond_t *cond);
147 int starpu_pthread_cond_wait(starpu_pthread_cond_t *cond, starpu_pthread_mutex_t *mutex);
148 int starpu_pthread_cond_timedwait(starpu_pthread_cond_t *cond, starpu_pthread_mutex_t *mutex, const struct timespec *abstime);
149 int starpu_pthread_cond_destroy(starpu_pthread_cond_t *cond);
150 
151 #elif !defined(_MSC_VER) || defined(BUILDING_STARPU) /* !STARPU_SIMGRID */
152 
153 typedef pthread_cond_t starpu_pthread_cond_t;
154 typedef pthread_condattr_t starpu_pthread_condattr_t;
155 #define STARPU_PTHREAD_COND_INITIALIZER PTHREAD_COND_INITIALIZER
156 
157 #define starpu_pthread_cond_init pthread_cond_init
158 #define starpu_pthread_cond_signal pthread_cond_signal
159 #define starpu_pthread_cond_broadcast pthread_cond_broadcast
160 
161 int starpu_pthread_cond_wait(starpu_pthread_cond_t *cond, starpu_pthread_mutex_t *mutex);
162 
163 #define starpu_pthread_cond_timedwait pthread_cond_timedwait
164 #define starpu_pthread_cond_destroy pthread_cond_destroy
165 
166 #endif /* STARPU_SIMGRID, _MSC_VER */
167 
168 /*
169  * Encapsulation of the pthread_rwlock_* functions.
170  */
171 
172 #ifdef STARPU_SIMGRID
173 
174 typedef xbt_mutex_t starpu_pthread_rwlock_t;
175 typedef int starpu_pthread_rwlockattr_t;
176 
177 int starpu_pthread_rwlock_init(starpu_pthread_rwlock_t *rwlock, const starpu_pthread_rwlockattr_t *attr);
178 int starpu_pthread_rwlock_destroy(starpu_pthread_rwlock_t *rwlock);
179 int starpu_pthread_rwlock_rdlock(starpu_pthread_rwlock_t *rwlock);
180 int starpu_pthread_rwlock_tryrdlock(starpu_pthread_rwlock_t *rwlock);
181 int starpu_pthread_rwlock_wrlock(starpu_pthread_rwlock_t *rwlock);
182 int starpu_pthread_rwlock_trywrlock(starpu_pthread_rwlock_t *rwlock);
183 int starpu_pthread_rwlock_unlock(starpu_pthread_rwlock_t *rwlock);
184 
185 #elif !defined(_MSC_VER) || defined(BUILDING_STARPU) /* !STARPU_SIMGRID */
186 
187 typedef pthread_rwlock_t starpu_pthread_rwlock_t;
188 typedef pthread_rwlockattr_t starpu_pthread_rwlockattr_t;
189 
190 #define starpu_pthread_rwlock_init pthread_rwlock_init
191 #define starpu_pthread_rwlock_destroy pthread_rwlock_destroy
192 
193 int starpu_pthread_rwlock_rdlock(starpu_pthread_rwlock_t *rwlock);
194 int starpu_pthread_rwlock_tryrdlock(starpu_pthread_rwlock_t *rwlock);
195 int starpu_pthread_rwlock_wrlock(starpu_pthread_rwlock_t *rwlock);
196 int starpu_pthread_rwlock_trywrlock(starpu_pthread_rwlock_t *rwlock);
197 int starpu_pthread_rwlock_unlock(starpu_pthread_rwlock_t *rwlock);
198 
199 #endif /* STARPU_SIMGRID, _MSC_VER */
200 
201 /*
202  * Encapsulation of the pthread_barrier_* functions.
203  */
204 
205 #if defined(STARPU_SIMGRID) || (!defined(STARPU_HAVE_PTHREAD_BARRIER) && (!defined(_MSC_VER) || defined(BUILDING_STARPU)))
206 
207 #if defined(STARPU_SIMGRID) && defined(STARPU_SIMGRID_HAVE_XBT_BARRIER_INIT)
208 typedef xbt_bar_t starpu_pthread_barrier_t;
209 typedef int starpu_pthread_barrierattr_t;
210 #define STARPU_PTHREAD_BARRIER_SERIAL_THREAD XBT_BARRIER_SERIAL_PROCESS
211 #else
212 typedef struct {
213  starpu_pthread_mutex_t mutex;
214  starpu_pthread_cond_t cond;
215  starpu_pthread_cond_t cond_destroy;
216  unsigned count;
217  unsigned done;
218  unsigned busy;
219 } starpu_pthread_barrier_t;
220 typedef int starpu_pthread_barrierattr_t;
221 #define STARPU_PTHREAD_BARRIER_SERIAL_THREAD -1
222 #endif
223 
224 int starpu_pthread_barrier_init(starpu_pthread_barrier_t *barrier, const starpu_pthread_barrierattr_t *attr, unsigned count);
225 int starpu_pthread_barrier_destroy(starpu_pthread_barrier_t *barrier);
226 int starpu_pthread_barrier_wait(starpu_pthread_barrier_t *barrier);
227 
228 #elif !defined(_MSC_VER) /* STARPU_SIMGRID, !STARPU_HAVE_PTHREAD_BARRIER */
229 
230 typedef pthread_barrier_t starpu_pthread_barrier_t;
231 typedef pthread_barrierattr_t starpu_pthread_barrierattr_t;
232 
233 #define starpu_pthread_barrier_init pthread_barrier_init
234 #define starpu_pthread_barrier_destroy pthread_barrier_destroy
235 
236 int starpu_pthread_barrier_wait(starpu_pthread_barrier_t *barrier);
237 #define STARPU_PTHREAD_BARRIER_SERIAL_THREAD PTHREAD_BARRIER_SERIAL_THREAD
238 
239 #endif /* STARPU_SIMGRID, !STARPU_HAVE_PTHREAD_BARRIER, _MSC_VER */
240 
241 /*
242  * Encapsulation of the pthread_spin_* functions.
243  */
244 
245 #if defined(STARPU_SIMGRID) || (defined(STARPU_LINUX_SYS) && defined(STARPU_HAVE_XCHG)) || !defined(STARPU_HAVE_PTHREAD_SPIN_LOCK)
246 
247 typedef struct
248 {
249 #ifdef STARPU_SIMGRID
250  int taken;
251 #elif defined(STARPU_LINUX_SYS) && defined(STARPU_HAVE_XCHG)
252  unsigned taken STARPU_ATTRIBUTE_ALIGNED(16);
253 #else /* we only have a trivial implementation yet ! */
254  uint32_t taken STARPU_ATTRIBUTE_ALIGNED(16);
255 #endif
257 
263 
264 #elif !defined(_MSC_VER) /* !( defined(STARPU_SIMGRID) || !defined(STARPU_HAVE_PTHREAD_SPIN_LOCK)) */
265 
266 typedef pthread_spinlock_t starpu_pthread_spinlock_t;
267 #define starpu_pthread_spin_init pthread_spin_init
268 #define starpu_pthread_spin_destroy pthread_spin_destroy
269 #define starpu_pthread_spin_lock pthread_spin_lock
270 #define starpu_pthread_spin_trylock pthread_spin_trylock
271 #define starpu_pthread_spin_unlock pthread_spin_unlock
272 
273 #endif /* !( defined(STARPU_SIMGRID) || !defined(STARPU_HAVE_PTHREAD_SPIN_LOCK)) */
274 
275 /*
276  * Other needed pthread definitions
277  */
278 
279 #if defined(_MSC_VER) && !defined(BUILDING_STARPU)
280 typedef void* starpu_pthread_rwlock_t;
281 typedef void* starpu_pthread_mutex_t;
282 typedef void* starpu_pthread_cond_t;
283 typedef void* starpu_pthread_barrier_t;
284 #endif /* _MSC_VER */
285 
286 #ifdef __cplusplus
287 }
288 #endif
289 
290 #endif /* __STARPU_THREAD_H__ */
291 
292 
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:59
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_exit(void *retval) STARPU_ATTRIBUTE_NORETURN
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:247
int starpu_pthread_cond_broadcast(starpu_pthread_cond_t *cond)
Definition: starpu_thread.h:212
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_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)