src/xbt/xbt_os_thread.c

   1 /* $Id$ */
   2
   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   */
   6
   7 /* Copyright 2006,2007 Malek Cherier, Martin Quinson
   8  * All right reserved.                                                      */
   9
  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. */
  12
  13 #include "xbt/sysdep.h"
  14 #include "xbt/ex.h"
  15 #include "xbt/ex_interface.h" /* We play crude games with exceptions */
  16 #include "portable.h"
  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 */
  20
  21 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_sync_os,xbt,"Synchronization mechanism (OS-level)");
  22
  23 /* ********************************* PTHREAD IMPLEMENTATION ************************************ */
  24 #ifdef HAVE_PTHREAD_H
  25 #include <pthread.h>
  26
  27
  28 typedef struct xbt_os_thread_ {
  29    pthread_t t;
  30    char *name;
  31    void *param;
  32    pvoid_f_pvoid_t *start_routine;
  33    ex_ctx_t *exception;
  34 } s_xbt_os_thread_t ;
  35 static xbt_os_thread_t main_thread = NULL;
  36
  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;
  40
  41 /* frees the xbt_os_thread_t corresponding to the current thread */
  42 static void xbt_os_thread_free_thread_data(void*d){
  43    free(d);
  44 }
  45
  46 /* callback: context fetching */
  47 static ex_ctx_t *_os_thread_ex_ctx(void) {
  48   return xbt_os_thread_self()->exception;
  49 }
  50
  51 /* callback: termination */
  52 static void _os_thread_ex_terminate(xbt_ex_t * e) {
  53   xbt_ex_display(e);
  54
  55   abort();
  56   /* FIXME: there should be a configuration variable to choose to kill everyone or only this one */
  57 }
  58
  59 void xbt_os_thread_mod_init(void) {
  60    int errcode;
  61
  62    if (thread_mod_inited)
  63      return;
  64
  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");
  67
  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);
  74
  75    __xbt_ex_ctx = _os_thread_ex_ctx;
  76    __xbt_ex_terminate = _os_thread_ex_terminate;
  77
  78    thread_mod_inited = 1;
  79 }
  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 */
  83 //   int errcode;
  84
  85 //   if ((errcode=pthread_key_delete(xbt_self_thread_key)))
  86 //     THROW0(system_error,errcode,"pthread_key_delete failed for xbt_self_thread_key");
  87 }
  88
  89 static void * wrapper_start_routine(void *s) {
  90   xbt_os_thread_t t = s;
  91   int errcode;
  92
  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);
  97 }
  98 xbt_os_thread_t xbt_os_thread_create(const char*name,
  99                                      pvoid_f_pvoid_t start_routine,
 100                                      void* param)  {
 101    int errcode;
 102
 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);
 109
 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));
 114
 115    return res_thread;
 116 }
 117
 118 const char* xbt_os_thread_name(xbt_os_thread_t t) {
 119    return t->name;
 120 }
 121
 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";
 125 }
 126 void
 127 xbt_os_thread_join(xbt_os_thread_t thread,void ** thread_return) {
 128
 129   int errcode;
 130
 131   if ((errcode = pthread_join(thread->t,thread_return)))
 132     THROW1(system_error,errcode, "pthread_join failed: %s",
 133            strerror(errcode));
 134    if (thread->exception)
 135      free(thread->exception);
 136
 137    if (thread == main_thread) /* just killed main thread */
 138      main_thread = NULL;
 139
 140    free(thread);
 141 }
 142
 143 void xbt_os_thread_exit(int *retval) {
 144    pthread_exit(retval);
 145 }
 146
 147 xbt_os_thread_t xbt_os_thread_self(void) {
 148   xbt_os_thread_t res;
 149
 150   if (!thread_mod_inited)
 151     return NULL;
 152
 153   res = pthread_getspecific(xbt_self_thread_key);
 154   if (!res)
 155     res = main_thread;
 156
 157   return res;
 158 }
 159
 160 #include <sched.h>
 161 void xbt_os_thread_yield(void) {
 162    sched_yield();
 163 }
 164 void xbt_os_thread_cancel(xbt_os_thread_t t) {
 165    pthread_cancel(t->t);
 166 }
 167 /****** mutex related functions ******/
 168 typedef struct xbt_os_mutex_ {
 169   /* KEEP IT IN SYNC WITH xbt_thread.c */
 170    pthread_mutex_t m;
 171 } s_xbt_os_mutex_t;
 172
 173 xbt_os_mutex_t xbt_os_mutex_init(void) {
 174    xbt_os_mutex_t res = xbt_new(s_xbt_os_mutex_t,1);
 175    int errcode;
 176
 177    if ((errcode = pthread_mutex_init(&(res->m),NULL)))
 178      THROW1(system_error,errcode,"pthread_mutex_init() failed: %s",
 179             strerror(errcode));
 180
 181    return res;
 182 }
 183
 184 void xbt_os_mutex_lock(xbt_os_mutex_t mutex) {
 185    int errcode;
 186
 187    if ((errcode=pthread_mutex_lock(&(mutex->m))))
 188      THROW2(system_error,errcode,"pthread_mutex_lock(%p) failed: %s",
 189             mutex, strerror(errcode));
 190 }
 191
 192 void xbt_os_mutex_unlock(xbt_os_mutex_t mutex) {
 193    int errcode;
 194
 195    if ((errcode=pthread_mutex_unlock(&(mutex->m))))
 196      THROW2(system_error,errcode,"pthread_mutex_unlock(%p) failed: %s",
 197             mutex, strerror(errcode));
 198 }
 199
 200 void xbt_os_mutex_destroy(xbt_os_mutex_t mutex) {
 201    int errcode;
 202
 203    if (!mutex) return;
 204
 205    if ((errcode=pthread_mutex_destroy(&(mutex->m))))
 206      THROW2(system_error,errcode,"pthread_mutex_destroy(%p) failed: %s",
 207             mutex, strerror(errcode));
 208    free(mutex);
 209 }
 210
 211 /***** condition related functions *****/
 212 typedef struct xbt_os_cond_ {
 213   /* KEEP IT IN SYNC WITH xbt_thread.c */
 214    pthread_cond_t c;
 215 } s_xbt_os_cond_t;
 216
 217 xbt_os_cond_t xbt_os_cond_init(void) {
 218    xbt_os_cond_t res = xbt_new(s_xbt_os_cond_t,1);
 219    int errcode;
 220    if ((errcode=pthread_cond_init(&(res->c),NULL)))
 221      THROW1(system_error,errcode,"pthread_cond_init() failed: %s",
 222             strerror(errcode));
 223
 224    return res;
 225 }
 226
 227 void xbt_os_cond_wait(xbt_os_cond_t cond, xbt_os_mutex_t mutex) {
 228    int errcode;
 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));
 232 }
 233
 234 #include <time.h>
 235 #include <math.h>
 236 void xbt_os_cond_timedwait(xbt_os_cond_t cond, xbt_os_mutex_t mutex, double delay) {
 237    int errcode;
 238    struct timespec ts_end;
 239    double end = delay + xbt_os_time();
 240    ts_end.tv_sec = (time_t) floor(end);
 241    ts_end.tv_nsec = (long)  ( ( end - ts_end.tv_sec) * 1000000000);
 242    DEBUG3("pthread_cond_timedwait(%p,%p,%p)",&(cond->c),&(mutex->m), &ts_end);
 243    switch ( (errcode=pthread_cond_timedwait(&(cond->c),&(mutex->m), &ts_end)) ) {
 244     case ETIMEDOUT:
 245      THROW3(timeout_error,errcode,"condition %p (mutex %p) wasn't signaled before timeout (%f)",
 246             cond,mutex, delay);
 247     default:
 248      THROW4(system_error,errcode,"pthread_cond_timedwait(%p,%p,%f) failed: %s",
 249             cond,mutex, delay, strerror(errcode));
 250    }
 251 }
 252
 253 void xbt_os_cond_signal(xbt_os_cond_t cond) {
 254    int errcode;
 255    if ((errcode=pthread_cond_signal(&(cond->c))))
 256      THROW2(system_error,errcode,"pthread_cond_signal(%p) failed: %s",
 257             cond, strerror(errcode));
 258 }
 259
 260 void xbt_os_cond_broadcast(xbt_os_cond_t cond){
 261    int errcode;
 262    if ((errcode=pthread_cond_broadcast(&(cond->c))))
 263      THROW2(system_error,errcode,"pthread_cond_broadcast(%p) failed: %s",
 264             cond, strerror(errcode));
 265 }
 266 void xbt_os_cond_destroy(xbt_os_cond_t cond){
 267    int errcode;
 268
 269    if (!cond) return;
 270
 271    if ((errcode=pthread_cond_destroy(&(cond->c))))
 272      THROW2(system_error,errcode,"pthread_cond_destroy(%p) failed: %s",
 273             cond, strerror(errcode));
 274    free(cond);
 275 }
 276
 277 void *xbt_os_thread_getparam(void) {
 278    xbt_os_thread_t t = xbt_os_thread_self();
 279    return t?t->param:NULL;
 280 }
 281
 282 /* ********************************* WINDOWS IMPLEMENTATION ************************************ */
 283
 284 #elif defined(WIN32)
 285
 286 typedef struct xbt_os_thread_ {
 287   char *name;
 288   HANDLE handle;                  /* the win thread handle        */
 289   unsigned long id;               /* the win thread id            */
 290   pvoid_f_pvoid_t *start_routine;
 291   void* param;
 292 } s_xbt_os_thread_t ;
 293
 294 /* key to the TLS containing the xbt_os_thread_t structure */
 295 static unsigned long xbt_self_thread_key;
 296
 297 void xbt_os_thread_mod_init(void) {
 298    xbt_self_thread_key = TlsAlloc();
 299 }
 300 void xbt_os_thread_mod_exit(void) {
 301
 302    if (!TlsFree(xbt_self_thread_key))
 303      THROW0(system_error,(int)GetLastError(),"TlsFree() failed to cleanup the thread submodule");
 304 }
 305
 306 static DWORD WINAPI  wrapper_start_routine(void *s) {
 307   xbt_os_thread_t t = (xbt_os_thread_t)s;
 308
 309     if(!TlsSetValue(xbt_self_thread_key,t))
 310      THROW0(system_error,(int)GetLastError(),"TlsSetValue of data describing the created thread failed");
 311
 312    return (DWORD)t->start_routine(t->param);
 313 }
 314
 315
 316 xbt_os_thread_t xbt_os_thread_create(const char *name,pvoid_f_pvoid_t start_routine,
 317                                void* param)  {
 318
 319    xbt_os_thread_t t = xbt_new(s_xbt_os_thread_t,1);
 320
 321    t->name = xbt_strdup(name);
 322    t->start_routine = start_routine ;
 323    t->param = param;
 324
 325    t->handle = CreateThread(NULL,0,
 326                             (LPTHREAD_START_ROUTINE)wrapper_start_routine,
 327                             t,0,&(t->id));
 328
 329    if(!t->handle) {
 330      xbt_free(t);
 331      THROW0(system_error,(int)GetLastError(),"CreateThread failed");
 332    }
 333
 334    return t;
 335 }
 336
 337 const char* xbt_os_thread_name(xbt_os_thread_t t) {
 338    return t->name;
 339 }
 340
 341 const char* xbt_os_thread_self_name(void) {
 342    xbt_os_thread_t t = xbt_os_thread_self();
 343    return t?t->name:"main";
 344 }
 345
 346 void
 347 xbt_os_thread_join(xbt_os_thread_t thread,void ** thread_return) {
 348
 349         if(WAIT_OBJECT_0 != WaitForSingleObject(thread->handle,INFINITE))
 350                 THROW0(system_error,(int)GetLastError(), "WaitForSingleObject failed");
 351
 352         if(thread_return){
 353
 354                 if(!GetExitCodeThread(thread->handle,(DWORD*)(*thread_return)))
 355                         THROW0(system_error,(int)GetLastError(), "GetExitCodeThread failed");
 356         }
 357
 358         CloseHandle(thread->handle);
 359         free(thread->name);
 360         free(thread);
 361 }
 362
 363 void xbt_os_thread_exit(int *retval) {
 364    if(retval)
 365         ExitThread(*retval);
 366    else
 367         ExitThread(0);
 368 }
 369
 370 xbt_os_thread_t xbt_os_thread_self(void) {
 371    return TlsGetValue(xbt_self_thread_key);
 372 }
 373
 374 void *xbt_os_thread_getparam(void) {
 375    xbt_os_thread_t t = xbt_os_thread_self();
 376    return t->param;
 377 }
 378
 379
 380 void xbt_os_thread_yield(void) {
 381     Sleep(0);
 382 }
 383 void xbt_os_thread_cancel(xbt_os_thread_t t) {
 384    THROW_UNIMPLEMENTED;
 385 }
 386
 387 /****** mutex related functions ******/
 388 typedef struct xbt_os_mutex_ {
 389   /* KEEP IT IN SYNC WITH xbt_thread.c */
 390    CRITICAL_SECTION lock;
 391 } s_xbt_os_mutex_t;
 392
 393 xbt_os_mutex_t xbt_os_mutex_init(void) {
 394    xbt_os_mutex_t res = xbt_new(s_xbt_os_mutex_t,1);
 395
 396    /* initialize the critical section object */
 397    InitializeCriticalSection(&(res->lock));
 398
 399    return res;
 400 }
 401
 402 void xbt_os_mutex_lock(xbt_os_mutex_t mutex) {
 403
 404    EnterCriticalSection(& mutex->lock);
 405 }
 406
 407 void xbt_os_mutex_unlock(xbt_os_mutex_t mutex) {
 408
 409    LeaveCriticalSection (& mutex->lock);
 410
 411 }
 412
 413 void xbt_os_mutex_destroy(xbt_os_mutex_t mutex) {
 414
 415    if (!mutex) return;
 416
 417    DeleteCriticalSection(& mutex->lock);
 418    free(mutex);
 419 }
 420
 421 /***** condition related functions *****/
 422  enum { /* KEEP IT IN SYNC WITH xbt_thread.c */
 423     SIGNAL = 0,
 424     BROADCAST = 1,
 425     MAX_EVENTS = 2
 426  };
 427
 428 typedef struct xbt_os_cond_ {
 429   /* KEEP IT IN SYNC WITH xbt_thread.c */
 430    HANDLE events[MAX_EVENTS];
 431
 432    unsigned int waiters_count;           /* the number of waiters                        */
 433    CRITICAL_SECTION waiters_count_lock;  /* protect access to waiters_count  */
 434 } s_xbt_os_cond_t;
 435
 436 xbt_os_cond_t xbt_os_cond_init(void) {
 437
 438    xbt_os_cond_t res = xbt_new0(s_xbt_os_cond_t,1);
 439
 440    memset(& res->waiters_count_lock,0,sizeof(CRITICAL_SECTION));
 441
 442    /* initialize the critical section object */
 443    InitializeCriticalSection(& res->waiters_count_lock);
 444
 445    res->waiters_count = 0;
 446
 447    /* Create an auto-reset event */
 448    res->events[SIGNAL] = CreateEvent (NULL, FALSE, FALSE, NULL);
 449
 450    if(!res->events[SIGNAL]){
 451       DeleteCriticalSection(& res->waiters_count_lock);
 452       free(res);
 453       THROW0(system_error,0,"CreateEvent failed for the signals");
 454    }
 455
 456    /* Create a manual-reset event. */
 457    res->events[BROADCAST] = CreateEvent (NULL, TRUE, FALSE,NULL);
 458
 459    if(!res->events[BROADCAST]){
 460
 461       DeleteCriticalSection(& res->waiters_count_lock);
 462       CloseHandle(res->events[SIGNAL]);
 463       free(res);
 464       THROW0(system_error,0,"CreateEvent failed for the broadcasts");
 465    }
 466
 467    return res;
 468 }
 469
 470 void xbt_os_cond_wait(xbt_os_cond_t cond, xbt_os_mutex_t mutex) {
 471
 472    unsigned long wait_result;
 473    int is_last_waiter;
 474
 475    /* lock the threads counter and increment it */
 476    EnterCriticalSection (& cond->waiters_count_lock);
 477    cond->waiters_count++;
 478    LeaveCriticalSection (& cond->waiters_count_lock);
 479
 480    /* unlock the mutex associate with the condition */
 481    LeaveCriticalSection (& mutex->lock);
 482
 483    /* wait for a signal (broadcast or no) */
 484    wait_result = WaitForMultipleObjects (2, cond->events, FALSE, INFINITE);
 485
 486    if(wait_result == WAIT_FAILED)
 487      THROW0(system_error,0,"WaitForMultipleObjects failed, so we cannot wait on the condition");
 488
 489    /* we have a signal lock the condition */
 490    EnterCriticalSection (& cond->waiters_count_lock);
 491    cond->waiters_count--;
 492
 493    /* it's the last waiter or it's a broadcast ? */
 494    is_last_waiter = ((wait_result == WAIT_OBJECT_0 + BROADCAST - 1) && (cond->waiters_count == 0));
 495
 496    LeaveCriticalSection (& cond->waiters_count_lock);
 497
 498    /* yes it's the last waiter or it's a broadcast
 499     * only reset the manual event (the automatic event is reset in the WaitForMultipleObjects() function
 500     * by the system.
 501     */
 502    if (is_last_waiter)
 503       if(!ResetEvent (cond->events[BROADCAST]))
 504         THROW0(system_error,0,"ResetEvent failed");
 505
 506    /* relock the mutex associated with the condition in accordance with the posix thread specification */
 507    EnterCriticalSection (& mutex->lock);
 508 }
 509 void xbt_os_cond_timedwait(xbt_os_cond_t cond, xbt_os_mutex_t mutex, double delay) {
 510    THROW_UNIMPLEMENTED;
 511 }
 512
 513 void xbt_os_cond_signal(xbt_os_cond_t cond) {
 514    int have_waiters;
 515
 516    EnterCriticalSection (& cond->waiters_count_lock);
 517    have_waiters = cond->waiters_count > 0;
 518    LeaveCriticalSection (& cond->waiters_count_lock);
 519
 520    if (have_waiters)
 521      if(!SetEvent(cond->events[SIGNAL]))
 522        THROW0(system_error,0,"SetEvent failed");
 523
 524    xbt_os_thread_yield();
 525 }
 526
 527 void xbt_os_cond_broadcast(xbt_os_cond_t cond){
 528    int have_waiters;
 529
 530    EnterCriticalSection (& cond->waiters_count_lock);
 531    have_waiters = cond->waiters_count > 0;
 532    LeaveCriticalSection (& cond->waiters_count_lock);
 533
 534    if (have_waiters)
 535      SetEvent(cond->events[BROADCAST]);
 536 }
 537
 538 void xbt_os_cond_destroy(xbt_os_cond_t cond){
 539    int error = 0;
 540
 541    if (!cond) return;
 542
 543    if(!CloseHandle(cond->events[SIGNAL]))
 544      error = 1;
 545
 546    if(!CloseHandle(cond->events[BROADCAST]))
 547      error = 1;
 548
 549    DeleteCriticalSection(& cond->waiters_count_lock);
 550
 551    xbt_free(cond);
 552
 553    if (error)
 554      THROW0(system_error,0,"Error while destroying the condition");
 555 }
 556
 557 #endif