3 /* xbt_os_thread -- portability layer over the pthread API */
4 /* Used in RL to get win/lin portability, and in SG when CONTEXT_THREAD */
5 /* in SG, when using CONTEXT_UCONTEXT, xbt_os_thread_stub is used instead */
7 /* Copyright 2006,2007 Malek Cherier, Martin Quinson
8 * All right reserved. */
10 /* This program is free software; you can redistribute it and/or modify it
11 * under the terms of the license (GNU LGPL) which comes with this package. */
13 #include "xbt/sysdep.h"
15 #include "xbt/ex_interface.h" /* We play crude games with exceptions */
17 #include "xbt/xbt_os_time.h" /* Portable time facilities */
18 #include "xbt/xbt_os_thread.h" /* This module */
19 #include "xbt_modinter.h" /* Initialization/finalization of this module */
21 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_sync_os,xbt,"Synchronization mechanism (OS-level)");
23 /* ********************************* PTHREAD IMPLEMENTATION ************************************ */
28 typedef struct xbt_os_thread_ {
32 pvoid_f_pvoid_t *start_routine;
35 static xbt_os_thread_t main_thread = NULL;
37 /* thread-specific data containing the xbt_os_thread_t structure */
38 static pthread_key_t xbt_self_thread_key;
39 static int thread_mod_inited = 0;
41 /* frees the xbt_os_thread_t corresponding to the current thread */
42 static void xbt_os_thread_free_thread_data(void*d){
46 /* callback: context fetching */
47 static ex_ctx_t *_os_thread_ex_ctx(void) {
48 return xbt_os_thread_self()->exception;
51 /* callback: termination */
52 static void _os_thread_ex_terminate(xbt_ex_t * e) {
56 /* FIXME: there should be a configuration variable to choose to kill everyone or only this one */
59 void xbt_os_thread_mod_init(void) {
62 if (thread_mod_inited)
65 if ((errcode=pthread_key_create(&xbt_self_thread_key, NULL)))
66 THROW0(system_error,errcode,"pthread_key_create failed for xbt_self_thread_key");
68 main_thread=xbt_new(s_xbt_os_thread_t,1);
69 main_thread->name = (char*)"main";
70 main_thread->start_routine = NULL;
71 main_thread->param = NULL;
72 main_thread->exception = xbt_new(ex_ctx_t, 1);
73 XBT_CTX_INITIALIZE(main_thread->exception);
75 __xbt_ex_ctx = _os_thread_ex_ctx;
76 __xbt_ex_terminate = _os_thread_ex_terminate;
78 thread_mod_inited = 1;
80 void xbt_os_thread_mod_exit(void) {
81 /* FIXME: don't try to free our key on shutdown.
82 Valgrind detects no leak if we don't, and whine if we try to */
85 // if ((errcode=pthread_key_delete(xbt_self_thread_key)))
86 // THROW0(system_error,errcode,"pthread_key_delete failed for xbt_self_thread_key");
89 static void * wrapper_start_routine(void *s) {
90 xbt_os_thread_t t = s;
93 if ((errcode=pthread_setspecific(xbt_self_thread_key,t)))
94 THROW0(system_error,errcode,
95 "pthread_setspecific failed for xbt_self_thread_key");
96 return t->start_routine(t->param);
98 xbt_os_thread_t xbt_os_thread_create(const char*name,
99 pvoid_f_pvoid_t start_routine,
103 xbt_os_thread_t res_thread=xbt_new(s_xbt_os_thread_t,1);
104 res_thread->name = xbt_strdup(name);
105 res_thread->start_routine = start_routine;
106 res_thread->param = param;
107 res_thread->exception = xbt_new(ex_ctx_t, 1);
108 XBT_CTX_INITIALIZE(res_thread->exception);
110 if ((errcode = pthread_create(&(res_thread->t), NULL,
111 wrapper_start_routine, res_thread)))
112 THROW1(system_error,errcode,
113 "pthread_create failed: %s",strerror(errcode));
118 const char* xbt_os_thread_name(xbt_os_thread_t t) {
122 const char* xbt_os_thread_self_name(void) {
123 xbt_os_thread_t self = xbt_os_thread_self();
124 return self?self->name:"main";
127 xbt_os_thread_join(xbt_os_thread_t thread,void ** thread_return) {
131 if ((errcode = pthread_join(thread->t,thread_return)))
132 THROW1(system_error,errcode, "pthread_join failed: %s",
134 if (thread->exception)
135 free(thread->exception);
137 if (thread == main_thread) /* just killed main thread */
143 void xbt_os_thread_exit(int *retval) {
144 pthread_exit(retval);
147 xbt_os_thread_t xbt_os_thread_self(void) {
150 if (!thread_mod_inited)
153 res = pthread_getspecific(xbt_self_thread_key);
161 void xbt_os_thread_yield(void) {
164 void xbt_os_thread_cancel(xbt_os_thread_t t) {
165 pthread_cancel(t->t);
167 /****** mutex related functions ******/
168 typedef struct xbt_os_mutex_ {
169 /* KEEP IT IN SYNC WITH xbt_thread.c */
173 xbt_os_mutex_t xbt_os_mutex_init(void) {
174 xbt_os_mutex_t res = xbt_new(s_xbt_os_mutex_t,1);
177 if ((errcode = pthread_mutex_init(&(res->m),NULL)))
178 THROW1(system_error,errcode,"pthread_mutex_init() failed: %s",
184 void xbt_os_mutex_lock(xbt_os_mutex_t mutex) {
187 if ((errcode=pthread_mutex_lock(&(mutex->m))))
188 THROW2(system_error,errcode,"pthread_mutex_lock(%p) failed: %s",
189 mutex, strerror(errcode));
192 void xbt_os_mutex_unlock(xbt_os_mutex_t mutex) {
195 if ((errcode=pthread_mutex_unlock(&(mutex->m))))
196 THROW2(system_error,errcode,"pthread_mutex_unlock(%p) failed: %s",
197 mutex, strerror(errcode));
200 void xbt_os_mutex_destroy(xbt_os_mutex_t mutex) {
205 if ((errcode=pthread_mutex_destroy(&(mutex->m))))
206 THROW2(system_error,errcode,"pthread_mutex_destroy(%p) failed: %s",
207 mutex, strerror(errcode));
211 /***** condition related functions *****/
212 typedef struct xbt_os_cond_ {
213 /* KEEP IT IN SYNC WITH xbt_thread.c */
217 xbt_os_cond_t xbt_os_cond_init(void) {
218 xbt_os_cond_t res = xbt_new(s_xbt_os_cond_t,1);
220 if ((errcode=pthread_cond_init(&(res->c),NULL)))
221 THROW1(system_error,errcode,"pthread_cond_init() failed: %s",
227 void xbt_os_cond_wait(xbt_os_cond_t cond, xbt_os_mutex_t mutex) {
229 if ((errcode=pthread_cond_wait(&(cond->c),&(mutex->m))))
230 THROW3(system_error,errcode,"pthread_cond_wait(%p,%p) failed: %s",
231 cond,mutex, strerror(errcode));
236 void xbt_os_cond_timedwait(xbt_os_cond_t cond, xbt_os_mutex_t mutex, double delay) {
238 struct timespec ts_end;
239 double end = delay + xbt_os_time();
242 xbt_os_cond_wait(cond,mutex);
244 ts_end.tv_sec = (time_t) floor(end);
245 ts_end.tv_nsec = (long) ( ( end - ts_end.tv_sec) * 1000000000);
246 DEBUG3("pthread_cond_timedwait(%p,%p,%p)",&(cond->c),&(mutex->m), &ts_end);
247 switch ( (errcode=pthread_cond_timedwait(&(cond->c),&(mutex->m), &ts_end)) ) {
251 THROW3(timeout_error,errcode,"condition %p (mutex %p) wasn't signaled before timeout (%f)",
254 THROW4(system_error,errcode,"pthread_cond_timedwait(%p,%p,%f) failed: %s",
255 cond,mutex, delay, strerror(errcode));
260 void xbt_os_cond_signal(xbt_os_cond_t cond) {
262 if ((errcode=pthread_cond_signal(&(cond->c))))
263 THROW2(system_error,errcode,"pthread_cond_signal(%p) failed: %s",
264 cond, strerror(errcode));
267 void xbt_os_cond_broadcast(xbt_os_cond_t cond){
269 if ((errcode=pthread_cond_broadcast(&(cond->c))))
270 THROW2(system_error,errcode,"pthread_cond_broadcast(%p) failed: %s",
271 cond, strerror(errcode));
273 void xbt_os_cond_destroy(xbt_os_cond_t cond){
278 if ((errcode=pthread_cond_destroy(&(cond->c))))
279 THROW2(system_error,errcode,"pthread_cond_destroy(%p) failed: %s",
280 cond, strerror(errcode));
284 void *xbt_os_thread_getparam(void) {
285 xbt_os_thread_t t = xbt_os_thread_self();
286 return t?t->param:NULL;
289 /* ********************************* WINDOWS IMPLEMENTATION ************************************ */
293 typedef struct xbt_os_thread_ {
295 HANDLE handle; /* the win thread handle */
296 unsigned long id; /* the win thread id */
297 pvoid_f_pvoid_t *start_routine;
299 } s_xbt_os_thread_t ;
301 /* key to the TLS containing the xbt_os_thread_t structure */
302 static unsigned long xbt_self_thread_key;
304 void xbt_os_thread_mod_init(void) {
305 xbt_self_thread_key = TlsAlloc();
307 void xbt_os_thread_mod_exit(void) {
309 if (!TlsFree(xbt_self_thread_key))
310 THROW0(system_error,(int)GetLastError(),"TlsFree() failed to cleanup the thread submodule");
313 static DWORD WINAPI wrapper_start_routine(void *s) {
314 xbt_os_thread_t t = (xbt_os_thread_t)s;
316 if(!TlsSetValue(xbt_self_thread_key,t))
317 THROW0(system_error,(int)GetLastError(),"TlsSetValue of data describing the created thread failed");
319 return (DWORD)t->start_routine(t->param);
323 xbt_os_thread_t xbt_os_thread_create(const char *name,pvoid_f_pvoid_t start_routine,
326 xbt_os_thread_t t = xbt_new(s_xbt_os_thread_t,1);
328 t->name = xbt_strdup(name);
329 t->start_routine = start_routine ;
332 t->handle = CreateThread(NULL,0,
333 (LPTHREAD_START_ROUTINE)wrapper_start_routine,
338 THROW0(system_error,(int)GetLastError(),"CreateThread failed");
344 const char* xbt_os_thread_name(xbt_os_thread_t t) {
348 const char* xbt_os_thread_self_name(void) {
349 xbt_os_thread_t t = xbt_os_thread_self();
350 return t?t->name:"main";
354 xbt_os_thread_join(xbt_os_thread_t thread,void ** thread_return) {
356 if(WAIT_OBJECT_0 != WaitForSingleObject(thread->handle,INFINITE))
357 THROW0(system_error,(int)GetLastError(), "WaitForSingleObject failed");
361 if(!GetExitCodeThread(thread->handle,(DWORD*)(*thread_return)))
362 THROW0(system_error,(int)GetLastError(), "GetExitCodeThread failed");
365 CloseHandle(thread->handle);
370 void xbt_os_thread_exit(int *retval) {
377 xbt_os_thread_t xbt_os_thread_self(void) {
378 return TlsGetValue(xbt_self_thread_key);
381 void *xbt_os_thread_getparam(void) {
382 xbt_os_thread_t t = xbt_os_thread_self();
387 void xbt_os_thread_yield(void) {
390 void xbt_os_thread_cancel(xbt_os_thread_t t) {
394 /****** mutex related functions ******/
395 typedef struct xbt_os_mutex_ {
396 /* KEEP IT IN SYNC WITH xbt_thread.c */
397 CRITICAL_SECTION lock;
400 xbt_os_mutex_t xbt_os_mutex_init(void) {
401 xbt_os_mutex_t res = xbt_new(s_xbt_os_mutex_t,1);
403 /* initialize the critical section object */
404 InitializeCriticalSection(&(res->lock));
409 void xbt_os_mutex_lock(xbt_os_mutex_t mutex) {
411 EnterCriticalSection(& mutex->lock);
414 void xbt_os_mutex_unlock(xbt_os_mutex_t mutex) {
416 LeaveCriticalSection (& mutex->lock);
420 void xbt_os_mutex_destroy(xbt_os_mutex_t mutex) {
424 DeleteCriticalSection(& mutex->lock);
428 /***** condition related functions *****/
429 enum { /* KEEP IT IN SYNC WITH xbt_thread.c */
435 typedef struct xbt_os_cond_ {
436 /* KEEP IT IN SYNC WITH xbt_thread.c */
437 HANDLE events[MAX_EVENTS];
439 unsigned int waiters_count; /* the number of waiters */
440 CRITICAL_SECTION waiters_count_lock; /* protect access to waiters_count */
443 xbt_os_cond_t xbt_os_cond_init(void) {
445 xbt_os_cond_t res = xbt_new0(s_xbt_os_cond_t,1);
447 memset(& res->waiters_count_lock,0,sizeof(CRITICAL_SECTION));
449 /* initialize the critical section object */
450 InitializeCriticalSection(& res->waiters_count_lock);
452 res->waiters_count = 0;
454 /* Create an auto-reset event */
455 res->events[SIGNAL] = CreateEvent (NULL, FALSE, FALSE, NULL);
457 if(!res->events[SIGNAL]){
458 DeleteCriticalSection(& res->waiters_count_lock);
460 THROW0(system_error,0,"CreateEvent failed for the signals");
463 /* Create a manual-reset event. */
464 res->events[BROADCAST] = CreateEvent (NULL, TRUE, FALSE,NULL);
466 if(!res->events[BROADCAST]){
468 DeleteCriticalSection(& res->waiters_count_lock);
469 CloseHandle(res->events[SIGNAL]);
471 THROW0(system_error,0,"CreateEvent failed for the broadcasts");
477 void xbt_os_cond_wait(xbt_os_cond_t cond, xbt_os_mutex_t mutex) {
479 unsigned long wait_result;
482 /* lock the threads counter and increment it */
483 EnterCriticalSection (& cond->waiters_count_lock);
484 cond->waiters_count++;
485 LeaveCriticalSection (& cond->waiters_count_lock);
487 /* unlock the mutex associate with the condition */
488 LeaveCriticalSection (& mutex->lock);
490 /* wait for a signal (broadcast or no) */
491 wait_result = WaitForMultipleObjects (2, cond->events, FALSE, INFINITE);
493 if(wait_result == WAIT_FAILED)
494 THROW0(system_error,0,"WaitForMultipleObjects failed, so we cannot wait on the condition");
496 /* we have a signal lock the condition */
497 EnterCriticalSection (& cond->waiters_count_lock);
498 cond->waiters_count--;
500 /* it's the last waiter or it's a broadcast ? */
501 is_last_waiter = ((wait_result == WAIT_OBJECT_0 + BROADCAST - 1) && (cond->waiters_count == 0));
503 LeaveCriticalSection (& cond->waiters_count_lock);
505 /* yes it's the last waiter or it's a broadcast
506 * only reset the manual event (the automatic event is reset in the WaitForMultipleObjects() function
510 if(!ResetEvent (cond->events[BROADCAST]))
511 THROW0(system_error,0,"ResetEvent failed");
513 /* relock the mutex associated with the condition in accordance with the posix thread specification */
514 EnterCriticalSection (& mutex->lock);
516 void xbt_os_cond_timedwait(xbt_os_cond_t cond, xbt_os_mutex_t mutex, double delay) {
520 void xbt_os_cond_signal(xbt_os_cond_t cond) {
523 EnterCriticalSection (& cond->waiters_count_lock);
524 have_waiters = cond->waiters_count > 0;
525 LeaveCriticalSection (& cond->waiters_count_lock);
528 if(!SetEvent(cond->events[SIGNAL]))
529 THROW0(system_error,0,"SetEvent failed");
531 xbt_os_thread_yield();
534 void xbt_os_cond_broadcast(xbt_os_cond_t cond){
537 EnterCriticalSection (& cond->waiters_count_lock);
538 have_waiters = cond->waiters_count > 0;
539 LeaveCriticalSection (& cond->waiters_count_lock);
542 SetEvent(cond->events[BROADCAST]);
545 void xbt_os_cond_destroy(xbt_os_cond_t cond){
550 if(!CloseHandle(cond->events[SIGNAL]))
553 if(!CloseHandle(cond->events[BROADCAST]))
556 DeleteCriticalSection(& cond->waiters_count_lock);
561 THROW0(system_error,0,"Error while destroying the condition");