3 /* xbt_thread -- portability layer over the pthread API */
5 /* Copyright 2006,2007 Malek Cherier, Martin Quinson
6 * All right reserved. */
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. */
11 #include "xbt/sysdep.h"
14 #include "xbt/xbt_thread.h" /* This module */
15 #include "xbt_modinter.h" /* Initialization/finalization of this module */
19 /* ********************************* PTHREAD IMPLEMENTATION ************************************ */
23 typedef struct xbt_thread_ {
26 pvoid_f_pvoid_t *start_routine;
29 /* thread-specific data containing the xbt_thread_t structure */
30 static pthread_key_t xbt_self_thread_key;
32 /* frees the xbt_thread_t corresponding to the current thread */
33 static void xbt_thread_free_thread_data(void*d){
37 void xbt_thread_mod_init(void) {
40 if ((errcode=pthread_key_create(&xbt_self_thread_key, NULL)))
41 THROW0(system_error,errcode,"pthread_key_create failed for xbt_self_thread_key");
43 void xbt_thread_mod_exit(void) {
44 /* FIXME: don't try to free our key on shutdown. Valgrind detects no leak if we don't, and whine if we try to */
47 // if ((errcode=pthread_key_delete(xbt_self_thread_key)))
48 // THROW0(system_error,errcode,"pthread_key_delete failed for xbt_self_thread_key");
51 static void * wrapper_start_routine(void *s) {
55 if ((errcode=pthread_setspecific(xbt_self_thread_key,t)))
56 THROW0(system_error,errcode,"pthread_setspecific failed for xbt_self_thread_key");
57 return t->start_routine(t->param);
60 xbt_thread_t xbt_thread_create(pvoid_f_pvoid_t start_routine,
64 xbt_thread_t res_thread=xbt_new(s_xbt_thread_t,1);
65 res_thread->start_routine = start_routine;
66 res_thread->param = param;
69 if ((errcode = pthread_create(&(res_thread->t), NULL, wrapper_start_routine, res_thread)))
70 THROW1(system_error,errcode, "pthread_create failed: %s",strerror(errcode));
76 xbt_thread_join(xbt_thread_t thread,void ** thread_return) {
80 if ((errcode = pthread_join(thread->t,thread_return)))
81 THROW1(system_error,errcode, "pthread_join failed: %s",
86 void xbt_thread_exit(int *retval) {
90 xbt_thread_t xbt_thread_self(void) {
91 return pthread_getspecific(xbt_self_thread_key);
95 void xbt_thread_yield(void) {
98 /****** mutex related functions ******/
99 typedef struct xbt_mutex_ {
103 xbt_mutex_t xbt_mutex_init(void) {
104 xbt_mutex_t res = xbt_new(s_xbt_mutex_t,1);
107 if ((errcode = pthread_mutex_init(&(res->m),NULL)))
108 THROW1(system_error,errcode,"pthread_mutex_init() failed: %s",
114 void xbt_mutex_lock(xbt_mutex_t mutex) {
117 if ((errcode=pthread_mutex_lock(&(mutex->m))))
118 THROW2(system_error,errcode,"pthread_mutex_lock(%p) failed: %s",
119 mutex, strerror(errcode));
122 void xbt_mutex_unlock(xbt_mutex_t mutex) {
125 if ((errcode=pthread_mutex_unlock(&(mutex->m))))
126 THROW2(system_error,errcode,"pthread_mutex_unlock(%p) failed: %s",
127 mutex, strerror(errcode));
130 void xbt_mutex_destroy(xbt_mutex_t mutex) {
135 if ((errcode=pthread_mutex_destroy(&(mutex->m))))
136 THROW2(system_error,errcode,"pthread_mutex_destroy(%p) failed: %s",
137 mutex, strerror(errcode));
141 /***** condition related functions *****/
142 typedef struct xbt_thcond_ {
146 xbt_thcond_t xbt_thcond_init(void) {
147 xbt_thcond_t res = xbt_new(s_xbt_thcond_t,1);
149 if ((errcode=pthread_cond_init(&(res->c),NULL)))
150 THROW1(system_error,errcode,"pthread_cond_init() failed: %s",
156 void xbt_thcond_wait(xbt_thcond_t cond, xbt_mutex_t mutex) {
158 if ((errcode=pthread_cond_wait(&(cond->c),&(mutex->m))))
159 THROW3(system_error,errcode,"pthread_cond_wait(%p,%p) failed: %s",
160 cond,mutex, strerror(errcode));
163 void xbt_thcond_signal(xbt_thcond_t cond) {
165 if ((errcode=pthread_cond_signal(&(cond->c))))
166 THROW2(system_error,errcode,"pthread_cond_signal(%p) failed: %s",
167 cond, strerror(errcode));
170 void xbt_thcond_broadcast(xbt_thcond_t cond){
172 if ((errcode=pthread_cond_broadcast(&(cond->c))))
173 THROW2(system_error,errcode,"pthread_cond_broadcast(%p) failed: %s",
174 cond, strerror(errcode));
176 void xbt_thcond_destroy(xbt_thcond_t cond){
181 if ((errcode=pthread_cond_destroy(&(cond->c))))
182 THROW2(system_error,errcode,"pthread_cond_destroy(%p) failed: %s",
183 cond, strerror(errcode));
187 /* ********************************* WINDOWS IMPLEMENTATION ************************************ */
191 typedef struct xbt_thread_ {
192 HANDLE handle; /* the win thread handle */
193 unsigned long id; /* the win thread id */
194 pvoid_f_pvoid_t *start_routine;
198 /* key to the TLS containing the xbt_thread_t structure */
199 static unsigned long xbt_self_thread_key;
201 void xbt_thread_mod_init(void) {
202 xbt_self_thread_key = TlsAlloc();
204 void xbt_thread_mod_exit(void) {
206 if (!TlsFree(xbt_self_thread_key))
207 THROW0(system_error,(int)GetLastError(),"TlsFree() failed to cleanup the thread submodule");
210 static DWORD WINAPI wrapper_start_routine(void *s) {
211 xbt_thread_t t = (xbt_thread_t)s;
213 if(!TlsSetValue(xbt_self_thread_key,t))
214 THROW0(system_error,(int)GetLastError(),"TlsSetValue of data describing the created thread failed");
216 return (DWORD)t->start_routine(t->param);
220 xbt_thread_t xbt_thread_create(pvoid_f_pvoid_t start_routine,
223 xbt_thread_t t = xbt_new(s_xbt_thread_t,1);
225 t->start_routine = start_routine ;
228 t->handle = CreateThread(NULL,0,
229 (LPTHREAD_START_ROUTINE)wrapper_start_routine,
234 THROW0(system_error,(int)GetLastError(),"CreateThread failed");
241 xbt_thread_join(xbt_thread_t thread,void ** thread_return) {
243 if(WAIT_OBJECT_0 != WaitForSingleObject(thread->handle,INFINITE))
244 THROW0(system_error,(int)GetLastError(), "WaitForSingleObject failed");
248 if(!GetExitCodeThread(thread->handle,(DWORD*)(*thread_return)))
249 THROW0(system_error,(int)GetLastError(), "GetExitCodeThread failed");
252 CloseHandle(thread->handle);
256 void xbt_thread_exit(int *retval) {
263 xbt_thread_t xbt_thread_self(void) {
264 return TlsGetValue(xbt_self_thread_key);
267 void xbt_thread_yield(void) {
271 /****** mutex related functions ******/
272 typedef struct xbt_mutex_ {
273 CRITICAL_SECTION lock;
276 xbt_mutex_t xbt_mutex_init(void) {
277 xbt_mutex_t res = xbt_new(s_xbt_mutex_t,1);
279 /* initialize the critical section object */
280 InitializeCriticalSection(&(res->lock));
285 void xbt_mutex_lock(xbt_mutex_t mutex) {
287 EnterCriticalSection(& mutex->lock);
290 void xbt_mutex_unlock(xbt_mutex_t mutex) {
292 LeaveCriticalSection (& mutex->lock);
296 void xbt_mutex_destroy(xbt_mutex_t mutex) {
300 DeleteCriticalSection(& mutex->lock);
304 /***** condition related functions *****/
311 typedef struct xbt_thcond_ {
312 HANDLE events[MAX_EVENTS];
314 unsigned int waiters_count; /* the number of waiters */
315 CRITICAL_SECTION waiters_count_lock; /* protect access to waiters_count */
318 xbt_thcond_t xbt_thcond_init(void) {
320 xbt_thcond_t res = xbt_new0(s_xbt_thcond_t,1);
322 memset(& res->waiters_count_lock,0,sizeof(CRITICAL_SECTION));
324 /* initialize the critical section object */
325 InitializeCriticalSection(& res->waiters_count_lock);
327 res->waiters_count = 0;
329 /* Create an auto-reset event */
330 res->events[SIGNAL] = CreateEvent (NULL, FALSE, FALSE, NULL);
332 if(!res->events[SIGNAL]){
333 DeleteCriticalSection(& res->waiters_count_lock);
335 THROW0(system_error,0,"CreateEvent failed for the signals");
338 /* Create a manual-reset event. */
339 res->events[BROADCAST] = CreateEvent (NULL, TRUE, FALSE,NULL);
341 if(!res->events[BROADCAST]){
343 DeleteCriticalSection(& res->waiters_count_lock);
344 CloseHandle(res->events[SIGNAL]);
346 THROW0(system_error,0,"CreateEvent failed for the broadcasts");
352 void xbt_thcond_wait(xbt_thcond_t cond, xbt_mutex_t mutex) {
354 unsigned long wait_result;
357 /* lock the threads counter and increment it */
358 EnterCriticalSection (& cond->waiters_count_lock);
359 cond->waiters_count++;
360 LeaveCriticalSection (& cond->waiters_count_lock);
362 /* unlock the mutex associate with the condition */
363 LeaveCriticalSection (& mutex->lock);
365 /* wait for a signal (broadcast or no) */
366 wait_result = WaitForMultipleObjects (2, cond->events, FALSE, INFINITE);
368 if(wait_result == WAIT_FAILED)
369 THROW0(system_error,0,"WaitForMultipleObjects failed, so we cannot wait on the condition");
371 /* we have a signal lock the condition */
372 EnterCriticalSection (& cond->waiters_count_lock);
373 cond->waiters_count--;
375 /* it's the last waiter or it's a broadcast ? */
376 is_last_waiter = ((wait_result == WAIT_OBJECT_0 + BROADCAST - 1) && (cond->waiters_count == 0));
378 LeaveCriticalSection (& cond->waiters_count_lock);
380 /* yes it's the last waiter or it's a broadcast
381 * only reset the manual event (the automatic event is reset in the WaitForMultipleObjects() function
385 if(!ResetEvent (cond->events[BROADCAST]))
386 THROW0(system_error,0,"ResetEvent failed");
388 /* relock the mutex associated with the condition in accordance with the posix thread specification */
389 EnterCriticalSection (& mutex->lock);
392 void xbt_thcond_signal(xbt_thcond_t cond) {
395 EnterCriticalSection (& cond->waiters_count_lock);
396 have_waiters = cond->waiters_count > 0;
397 LeaveCriticalSection (& cond->waiters_count_lock);
400 if(!SetEvent(cond->events[SIGNAL]))
401 THROW0(system_error,0,"SetEvent failed");
406 void xbt_thcond_broadcast(xbt_thcond_t cond){
409 EnterCriticalSection (& cond->waiters_count_lock);
410 have_waiters = cond->waiters_count > 0;
411 LeaveCriticalSection (& cond->waiters_count_lock);
414 SetEvent(cond->events[BROADCAST]);
417 void xbt_thcond_destroy(xbt_thcond_t cond){
422 if(!CloseHandle(cond->events[SIGNAL]))
425 if(!CloseHandle(cond->events[BROADCAST]))
428 DeleteCriticalSection(& cond->waiters_count_lock);
433 THROW0(system_error,0,"Error while destroying the condition");