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 0:
 245       return;
 246     case ETIMEDOUT:
 247      THROW3(timeout_error,errcode,"condition %p (mutex %p) wasn't signaled before timeout (%f)",
 248             cond,mutex, delay);
 249     default:
 250      THROW4(system_error,errcode,"pthread_cond_timedwait(%p,%p,%f) failed: %s",
 251             cond,mutex, delay, strerror(errcode));
 252    }
 253 }
 254
 255 void xbt_os_cond_signal(xbt_os_cond_t cond) {
 256    int errcode;
 257    if ((errcode=pthread_cond_signal(&(cond->c))))
 258      THROW2(system_error,errcode,"pthread_cond_signal(%p) failed: %s",
 259             cond, strerror(errcode));
 260 }
 261
 262 void xbt_os_cond_broadcast(xbt_os_cond_t cond){
 263    int errcode;
 264    if ((errcode=pthread_cond_broadcast(&(cond->c))))
 265      THROW2(system_error,errcode,"pthread_cond_broadcast(%p) failed: %s",
 266             cond, strerror(errcode));
 267 }
 268 void xbt_os_cond_destroy(xbt_os_cond_t cond){
 269    int errcode;
 270
 271    if (!cond) return;
 272
 273    if ((errcode=pthread_cond_destroy(&(cond->c))))
 274      THROW2(system_error,errcode,"pthread_cond_destroy(%p) failed: %s",
 275             cond, strerror(errcode));
 276    free(cond);
 277 }
 278
 279 void *xbt_os_thread_getparam(void) {
 280    xbt_os_thread_t t = xbt_os_thread_self();
 281    return t?t->param:NULL;
 282 }
 283
 284 /* ********************************* WINDOWS IMPLEMENTATION ************************************ */
 285
 286 #elif defined(WIN32)
 287
 288 typedef struct xbt_os_thread_ {
 289   char *name;
 290   HANDLE handle;                  /* the win thread handle        */
 291   unsigned long id;               /* the win thread id            */
 292   pvoid_f_pvoid_t *start_routine;
 293   void* param;
 294 } s_xbt_os_thread_t ;
 295
 296 /* key to the TLS containing the xbt_os_thread_t structure */
 297 static unsigned long xbt_self_thread_key;
 298
 299 void xbt_os_thread_mod_init(void) {
 300    xbt_self_thread_key = TlsAlloc();
 301 }
 302 void xbt_os_thread_mod_exit(void) {
 303
 304    if (!TlsFree(xbt_self_thread_key))
 305      THROW0(system_error,(int)GetLastError(),"TlsFree() failed to cleanup the thread submodule");
 306 }
 307
 308 static DWORD WINAPI  wrapper_start_routine(void *s) {
 309   xbt_os_thread_t t = (xbt_os_thread_t)s;
 310
 311     if(!TlsSetValue(xbt_self_thread_key,t))
 312      THROW0(system_error,(int)GetLastError(),"TlsSetValue of data describing the created thread failed");
 313
 314    return (DWORD)t->start_routine(t->param);
 315 }
 316
 317
 318 xbt_os_thread_t xbt_os_thread_create(const char *name,pvoid_f_pvoid_t start_routine,
 319                                void* param)  {
 320
 321    xbt_os_thread_t t = xbt_new(s_xbt_os_thread_t,1);
 322
 323    t->name = xbt_strdup(name);
 324    t->start_routine = start_routine ;
 325    t->param = param;
 326
 327    t->handle = CreateThread(NULL,0,
 328                             (LPTHREAD_START_ROUTINE)wrapper_start_routine,
 329                             t,0,&(t->id));
 330
 331    if(!t->handle) {
 332      xbt_free(t);
 333      THROW0(system_error,(int)GetLastError(),"CreateThread failed");
 334    }
 335
 336    return t;
 337 }
 338
 339 const char* xbt_os_thread_name(xbt_os_thread_t t) {
 340    return t->name;
 341 }
 342
 343 const char* xbt_os_thread_self_name(void) {
 344    xbt_os_thread_t t = xbt_os_thread_self();
 345    return t?t->name:"main";
 346 }
 347
 348 void
 349 xbt_os_thread_join(xbt_os_thread_t thread,void ** thread_return) {
 350
 351         if(WAIT_OBJECT_0 != WaitForSingleObject(thread->handle,INFINITE))
 352                 THROW0(system_error,(int)GetLastError(), "WaitForSingleObject failed");
 353
 354         if(thread_return){
 355
 356                 if(!GetExitCodeThread(thread->handle,(DWORD*)(*thread_return)))
 357                         THROW0(system_error,(int)GetLastError(), "GetExitCodeThread failed");
 358         }
 359
 360         CloseHandle(thread->handle);
 361         free(thread->name);
 362         free(thread);
 363 }
 364
 365 void xbt_os_thread_exit(int *retval) {
 366    if(retval)
 367         ExitThread(*retval);
 368    else
 369         ExitThread(0);
 370 }
 371
 372 xbt_os_thread_t xbt_os_thread_self(void) {
 373    return TlsGetValue(xbt_self_thread_key);
 374 }
 375
 376 void *xbt_os_thread_getparam(void) {
 377    xbt_os_thread_t t = xbt_os_thread_self();
 378    return t->param;
 379 }
 380
 381
 382 void xbt_os_thread_yield(void) {
 383     Sleep(0);
 384 }
 385 void xbt_os_thread_cancel(xbt_os_thread_t t) {
 386    THROW_UNIMPLEMENTED;
 387 }
 388
 389 /****** mutex related functions ******/
 390 typedef struct xbt_os_mutex_ {
 391   /* KEEP IT IN SYNC WITH xbt_thread.c */
 392    CRITICAL_SECTION lock;
 393 } s_xbt_os_mutex_t;
 394
 395 xbt_os_mutex_t xbt_os_mutex_init(void) {
 396    xbt_os_mutex_t res = xbt_new(s_xbt_os_mutex_t,1);
 397
 398    /* initialize the critical section object */
 399    InitializeCriticalSection(&(res->lock));
 400
 401    return res;
 402 }
 403
 404 void xbt_os_mutex_lock(xbt_os_mutex_t mutex) {
 405
 406    EnterCriticalSection(& mutex->lock);
 407 }
 408
 409 void xbt_os_mutex_unlock(xbt_os_mutex_t mutex) {
 410
 411    LeaveCriticalSection (& mutex->lock);
 412
 413 }
 414
 415 void xbt_os_mutex_destroy(xbt_os_mutex_t mutex) {
 416
 417    if (!mutex) return;
 418
 419    DeleteCriticalSection(& mutex->lock);
 420    free(mutex);
 421 }
 422
 423 /***** condition related functions *****/
 424  enum { /* KEEP IT IN SYNC WITH xbt_thread.c */
 425     SIGNAL = 0,
 426     BROADCAST = 1,
 427     MAX_EVENTS = 2
 428  };
 429
 430 typedef struct xbt_os_cond_ {
 431   /* KEEP IT IN SYNC WITH xbt_thread.c */
 432    HANDLE events[MAX_EVENTS];
 433
 434    unsigned int waiters_count;           /* the number of waiters                        */
 435    CRITICAL_SECTION waiters_count_lock;  /* protect access to waiters_count  */
 436 } s_xbt_os_cond_t;
 437
 438 xbt_os_cond_t xbt_os_cond_init(void) {
 439
 440    xbt_os_cond_t res = xbt_new0(s_xbt_os_cond_t,1);
 441
 442    memset(& res->waiters_count_lock,0,sizeof(CRITICAL_SECTION));
 443
 444    /* initialize the critical section object */
 445    InitializeCriticalSection(& res->waiters_count_lock);
 446
 447    res->waiters_count = 0;
 448
 449    /* Create an auto-reset event */
 450    res->events[SIGNAL] = CreateEvent (NULL, FALSE, FALSE, NULL);
 451
 452    if(!res->events[SIGNAL]){
 453       DeleteCriticalSection(& res->waiters_count_lock);
 454       free(res);
 455       THROW0(system_error,0,"CreateEvent failed for the signals");
 456    }
 457
 458    /* Create a manual-reset event. */
 459    res->events[BROADCAST] = CreateEvent (NULL, TRUE, FALSE,NULL);
 460
 461    if(!res->events[BROADCAST]){
 462
 463       DeleteCriticalSection(& res->waiters_count_lock);
 464       CloseHandle(res->events[SIGNAL]);
 465       free(res);
 466       THROW0(system_error,0,"CreateEvent failed for the broadcasts");
 467    }
 468
 469    return res;
 470 }
 471
 472 void xbt_os_cond_wait(xbt_os_cond_t cond, xbt_os_mutex_t mutex) {
 473
 474    unsigned long wait_result;
 475    int is_last_waiter;
 476
 477    /* lock the threads counter and increment it */
 478    EnterCriticalSection (& cond->waiters_count_lock);
 479    cond->waiters_count++;
 480    LeaveCriticalSection (& cond->waiters_count_lock);
 481
 482    /* unlock the mutex associate with the condition */
 483    LeaveCriticalSection (& mutex->lock);
 484
 485    /* wait for a signal (broadcast or no) */
 486    wait_result = WaitForMultipleObjects (2, cond->events, FALSE, INFINITE);
 487
 488    if(wait_result == WAIT_FAILED)
 489      THROW0(system_error,0,"WaitForMultipleObjects failed, so we cannot wait on the condition");
 490
 491    /* we have a signal lock the condition */
 492    EnterCriticalSection (& cond->waiters_count_lock);
 493    cond->waiters_count--;
 494
 495    /* it's the last waiter or it's a broadcast ? */
 496    is_last_waiter = ((wait_result == WAIT_OBJECT_0 + BROADCAST - 1) && (cond->waiters_count == 0));
 497
 498    LeaveCriticalSection (& cond->waiters_count_lock);
 499
 500    /* yes it's the last waiter or it's a broadcast
 501     * only reset the manual event (the automatic event is reset in the WaitForMultipleObjects() function
 502     * by the system.
 503     */
 504    if (is_last_waiter)
 505       if(!ResetEvent (cond->events[BROADCAST]))
 506         THROW0(system_error,0,"ResetEvent failed");
 507
 508    /* relock the mutex associated with the condition in accordance with the posix thread specification */
 509    EnterCriticalSection (& mutex->lock);
 510 }
 511 void xbt_os_cond_timedwait(xbt_os_cond_t cond, xbt_os_mutex_t mutex, double delay) {
 512    THROW_UNIMPLEMENTED;
 513 }
 514
 515 void xbt_os_cond_signal(xbt_os_cond_t cond) {
 516    int have_waiters;
 517
 518    EnterCriticalSection (& cond->waiters_count_lock);
 519    have_waiters = cond->waiters_count > 0;
 520    LeaveCriticalSection (& cond->waiters_count_lock);
 521
 522    if (have_waiters)
 523      if(!SetEvent(cond->events[SIGNAL]))
 524        THROW0(system_error,0,"SetEvent failed");
 525
 526    xbt_os_thread_yield();
 527 }
 528
 529 void xbt_os_cond_broadcast(xbt_os_cond_t cond){
 530    int have_waiters;
 531
 532    EnterCriticalSection (& cond->waiters_count_lock);
 533    have_waiters = cond->waiters_count > 0;
 534    LeaveCriticalSection (& cond->waiters_count_lock);
 535
 536    if (have_waiters)
 537      SetEvent(cond->events[BROADCAST]);
 538 }
 539
 540 void xbt_os_cond_destroy(xbt_os_cond_t cond){
 541    int error = 0;
 542
 543    if (!cond) return;
 544
 545    if(!CloseHandle(cond->events[SIGNAL]))
 546      error = 1;
 547
 548    if(!CloseHandle(cond->events[BROADCAST]))
 549      error = 1;
 550
 551    DeleteCriticalSection(& cond->waiters_count_lock);
 552
 553    xbt_free(cond);
 554
 555    if (error)
 556      THROW0(system_error,0,"Error while destroying the condition");
 557 }
 558
 559 #endif