common/threads.c

   1 /**
   2  * OpenAL cross platform audio library
   3  * Copyright (C) 1999-2007 by authors.
   4  * This library is free software; you can redistribute it and/or
   5  *  modify it under the terms of the GNU Library General Public
   6  *  License as published by the Free Software Foundation; either
   7  *  version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  *  Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  *  License along with this library; if not, write to the
  16  *  Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  *  Boston, MA  02111-1307, USA.
  18  * Or go to http://www.gnu.org/copyleft/lgpl.html
  19  */
  20
  21 #include "config.h"
  22
  23 #include "threads.h"
  24
  25 #include <stdlib.h>
  26 #include <string.h>
  27 #include <errno.h>
  28
  29 #include "uintmap.h"
  30
  31
  32 extern inline althrd_t althrd_current(void);
  33 extern inline int althrd_equal(althrd_t thr0, althrd_t thr1);
  34 extern inline void althrd_exit(int res);
  35 extern inline void althrd_yield(void);
  36
  37 extern inline int almtx_lock(almtx_t *mtx);
  38 extern inline int almtx_unlock(almtx_t *mtx);
  39 extern inline int almtx_trylock(almtx_t *mtx);
  40
  41 extern inline void *altss_get(altss_t tss_id);
  42 extern inline int altss_set(altss_t tss_id, void *val);
  43
  44
  45 #ifndef UNUSED
  46 #if defined(__cplusplus)
  47 #define UNUSED(x)
  48 #elif defined(__GNUC__)
  49 #define UNUSED(x) UNUSED_##x __attribute__((unused))
  50 #elif defined(__LCLINT__)
  51 #define UNUSED(x) /*@unused@*/ x
  52 #else
  53 #define UNUSED(x) x
  54 #endif
  55 #endif
  56
  57
  58 #define THREAD_STACK_SIZE (1*1024*1024) /* 1MB */
  59
  60 #ifdef _WIN32
  61
  62 #define WIN32_LEAN_AND_MEAN
  63 #include <windows.h>
  64 #include <mmsystem.h>
  65
  66
  67 void althrd_setname(althrd_t thr, const char *name)
  68 {
  69 #if defined(_MSC_VER)
  70 #define MS_VC_EXCEPTION 0x406D1388
  71 #pragma pack(push,8)
  72     struct {
  73         DWORD dwType;     // Must be 0x1000.
  74         LPCSTR szName;    // Pointer to name (in user addr space).
  75         DWORD dwThreadID; // Thread ID (-1=caller thread).
  76         DWORD dwFlags;    // Reserved for future use, must be zero.
  77     } info;
  78 #pragma pack(pop)
  79     info.dwType = 0x1000;
  80     info.szName = name;
  81     info.dwThreadID = thr;
  82     info.dwFlags = 0;
  83
  84     __try {
  85         RaiseException(MS_VC_EXCEPTION, 0, sizeof(info)/sizeof(ULONG_PTR), (ULONG_PTR*)&info);
  86     }
  87     __except(EXCEPTION_CONTINUE_EXECUTION) {
  88     }
  89 #undef MS_VC_EXCEPTION
  90 #else
  91     (void)thr;
  92     (void)name;
  93 #endif
  94 }
  95
  96
  97 static UIntMap ThrdIdHandle = UINTMAP_STATIC_INITIALIZE;
  98
  99 static void NTAPI althrd_callback(void* UNUSED(handle), DWORD reason, void* UNUSED(reserved))
 100 {
 101     if(reason == DLL_PROCESS_DETACH)
 102         ResetUIntMap(&ThrdIdHandle);
 103 }
 104 #ifdef _MSC_VER
 105 #pragma section(".CRT$XLC",read)
 106 __declspec(allocate(".CRT$XLC")) PIMAGE_TLS_CALLBACK althrd_callback_ = althrd_callback;
 107 #elif defined(__GNUC__)
 108 PIMAGE_TLS_CALLBACK althrd_callback_ __attribute__((section(".CRT$XLC"))) = althrd_callback;
 109 #else
 110 PIMAGE_TLS_CALLBACK althrd_callback_ = althrd_callback;
 111 #endif
 112
 113
 114 typedef struct thread_cntr {
 115     althrd_start_t func;
 116     void *arg;
 117 } thread_cntr;
 118
 119 static DWORD WINAPI althrd_starter(void *arg)
 120 {
 121     thread_cntr cntr;
 122     memcpy(&cntr, arg, sizeof(cntr));
 123     free(arg);
 124
 125     return (DWORD)((*cntr.func)(cntr.arg));
 126 }
 127
 128
 129 int althrd_create(althrd_t *thr, althrd_start_t func, void *arg)
 130 {
 131     thread_cntr *cntr;
 132     DWORD thrid;
 133     HANDLE hdl;
 134
 135     cntr = malloc(sizeof(*cntr));
 136     if(!cntr) return althrd_nomem;
 137
 138     cntr->func = func;
 139     cntr->arg = arg;
 140
 141     hdl = CreateThread(NULL, THREAD_STACK_SIZE, althrd_starter, cntr, 0, &thrid);
 142     if(!hdl)
 143     {
 144         free(cntr);
 145         return althrd_error;
 146     }
 147     InsertUIntMapEntry(&ThrdIdHandle, thrid, hdl);
 148
 149     *thr = thrid;
 150     return althrd_success;
 151 }
 152
 153 int althrd_detach(althrd_t thr)
 154 {
 155     HANDLE hdl = RemoveUIntMapKey(&ThrdIdHandle, thr);
 156     if(!hdl) return althrd_error;
 157
 158     CloseHandle(hdl);
 159     return althrd_success;
 160 }
 161
 162 int althrd_join(althrd_t thr, int *res)
 163 {
 164     DWORD code;
 165
 166     HANDLE hdl = RemoveUIntMapKey(&ThrdIdHandle, thr);
 167     if(!hdl) return althrd_error;
 168
 169     WaitForSingleObject(hdl, INFINITE);
 170     GetExitCodeThread(hdl, &code);
 171     CloseHandle(hdl);
 172
 173     if(res != NULL)
 174         *res = (int)code;
 175     return althrd_success;
 176 }
 177
 178 int althrd_sleep(const struct timespec *ts, struct timespec* UNUSED(rem))
 179 {
 180     DWORD msec;
 181
 182     if(ts->tv_sec < 0 || ts->tv_sec >= (0x7fffffff / 1000) ||
 183        ts->tv_nsec < 0 || ts->tv_nsec >= 1000000000)
 184         return -2;
 185
 186     msec  = (DWORD)(ts->tv_sec * 1000);
 187     msec += (DWORD)((ts->tv_nsec+999999) / 1000000);
 188     Sleep(msec);
 189
 190     return 0;
 191 }
 192
 193
 194 int almtx_init(almtx_t *mtx, int type)
 195 {
 196     if(!mtx) return althrd_error;
 197     type &= ~(almtx_recursive|almtx_timed);
 198     if(type != almtx_plain)
 199         return althrd_error;
 200
 201     InitializeCriticalSection(mtx);
 202     return althrd_success;
 203 }
 204
 205 void almtx_destroy(almtx_t *mtx)
 206 {
 207     DeleteCriticalSection(mtx);
 208 }
 209
 210 int almtx_timedlock(almtx_t *mtx, const struct timespec *ts)
 211 {
 212     int ret;
 213
 214     if(!mtx || !ts)
 215         return althrd_error;
 216
 217     while((ret=almtx_trylock(mtx)) == althrd_busy)
 218     {
 219         struct timespec now;
 220
 221         if(ts->tv_sec < 0 || ts->tv_nsec < 0 || ts->tv_nsec >= 1000000000 ||
 222            altimespec_get(&now, AL_TIME_UTC) != AL_TIME_UTC)
 223             return althrd_error;
 224         if(now.tv_sec > ts->tv_sec || (now.tv_sec == ts->tv_sec && now.tv_nsec >= ts->tv_nsec))
 225             return althrd_timedout;
 226
 227         althrd_yield();
 228     }
 229
 230     return ret;
 231 }
 232
 233
 234 /* An associative map of uint:void* pairs. The key is the TLS index (given by
 235  * TlsAlloc), and the value is the altss_dtor_t callback. When a thread exits,
 236  * we iterate over the TLS indices for their thread-local value and call the
 237  * destructor function with it if they're both not NULL. To avoid using
 238  * DllMain, a PIMAGE_TLS_CALLBACK function pointer is placed in a ".CRT$XLx"
 239  * section (where x is a character A to Z) which will be called by the CRT.
 240  */
 241 static UIntMap TlsDestructors = UINTMAP_STATIC_INITIALIZE;
 242
 243 static void NTAPI altss_callback(void* UNUSED(handle), DWORD reason, void* UNUSED(reserved))
 244 {
 245     ALsizei i;
 246
 247     if(reason == DLL_PROCESS_DETACH)
 248     {
 249         ResetUIntMap(&TlsDestructors);
 250         return;
 251     }
 252     if(reason != DLL_THREAD_DETACH)
 253         return;
 254
 255     LockUIntMapRead(&TlsDestructors);
 256     for(i = 0;i < TlsDestructors.size;i++)
 257     {
 258         void *ptr = altss_get(TlsDestructors.array[i].key);
 259         altss_dtor_t callback = (altss_dtor_t)TlsDestructors.array[i].value;
 260         if(ptr && callback)
 261             callback(ptr);
 262     }
 263     UnlockUIntMapRead(&TlsDestructors);
 264 }
 265 #ifdef _MSC_VER
 266 #pragma section(".CRT$XLB",read)
 267 __declspec(allocate(".CRT$XLB")) PIMAGE_TLS_CALLBACK altss_callback_ = altss_callback;
 268 #elif defined(__GNUC__)
 269 PIMAGE_TLS_CALLBACK altss_callback_ __attribute__((section(".CRT$XLB"))) = altss_callback;
 270 #else
 271 #warning "No TLS callback support, thread-local contexts may leak references on poorly written applications."
 272 PIMAGE_TLS_CALLBACK altss_callback_ = altss_callback;
 273 #endif
 274
 275 int altss_create(altss_t *tss_id, altss_dtor_t callback)
 276 {
 277     DWORD key = TlsAlloc();
 278     if(key == TLS_OUT_OF_INDEXES)
 279         return althrd_error;
 280
 281     *tss_id = key;
 282     if(callback != NULL)
 283         InsertUIntMapEntry(&TlsDestructors, key, callback);
 284     return althrd_success;
 285 }
 286
 287 void altss_delete(altss_t tss_id)
 288 {
 289     RemoveUIntMapKey(&TlsDestructors, tss_id);
 290     TlsFree(tss_id);
 291 }
 292
 293
 294 int altimespec_get(struct timespec *ts, int base)
 295 {
 296     static_assert(sizeof(FILETIME) == sizeof(ULARGE_INTEGER),
 297                   "Size of FILETIME does not match ULARGE_INTEGER");
 298     if(base == AL_TIME_UTC)
 299     {
 300         union {
 301             FILETIME ftime;
 302             ULARGE_INTEGER ulint;
 303         } systime;
 304         GetSystemTimeAsFileTime(&systime.ftime);
 305         /* FILETIME is in 100-nanosecond units, or 1/10th of a microsecond. */
 306         ts->tv_sec = systime.ulint.QuadPart/10000000;
 307         ts->tv_nsec = (systime.ulint.QuadPart%10000000) * 100;
 308         return base;
 309     }
 310
 311     return 0;
 312 }
 313
 314
 315 void alcall_once(alonce_flag *once, void (*callback)(void))
 316 {
 317     LONG ret;
 318     while((ret=InterlockedExchange(once, 1)) == 1)
 319         althrd_yield();
 320     if(ret == 0)
 321         (*callback)();
 322     InterlockedExchange(once, 2);
 323 }
 324
 325 #else
 326
 327 #include <sys/time.h>
 328 #include <unistd.h>
 329 #include <pthread.h>
 330 #ifdef HAVE_PTHREAD_NP_H
 331 #include <pthread_np.h>
 332 #endif
 333
 334
 335 extern inline int althrd_sleep(const struct timespec *ts, struct timespec *rem);
 336 extern inline void alcall_once(alonce_flag *once, void (*callback)(void));
 337
 338
 339 void althrd_setname(althrd_t thr, const char *name)
 340 {
 341 #if defined(HAVE_PTHREAD_SETNAME_NP)
 342 #if defined(__GNUC__)
 343     pthread_setname_np(thr, name);
 344 #elif defined(__APPLE__)
 345     if(althrd_equal(thr, althrd_current())
 346         pthread_setname_np(name);
 347 #endif
 348 #elif defined(HAVE_PTHREAD_SET_NAME_NP)
 349     pthread_set_name_np(thr, name);
 350 #else
 351     (void)thr;
 352     (void)name;
 353 #endif
 354 }
 355
 356
 357 typedef struct thread_cntr {
 358     althrd_start_t func;
 359     void *arg;
 360 } thread_cntr;
 361
 362 static void *althrd_starter(void *arg)
 363 {
 364     thread_cntr cntr;
 365     memcpy(&cntr, arg, sizeof(cntr));
 366     free(arg);
 367
 368     return (void*)(intptr_t)((*cntr.func)(cntr.arg));
 369 }
 370
 371
 372 int althrd_create(althrd_t *thr, althrd_start_t func, void *arg)
 373 {
 374     thread_cntr *cntr;
 375     pthread_attr_t attr;
 376
 377     cntr = malloc(sizeof(*cntr));
 378     if(!cntr) return althrd_nomem;
 379
 380     if(pthread_attr_init(&attr) != 0)
 381     {
 382         free(cntr);
 383         return althrd_error;
 384     }
 385     if(pthread_attr_setstacksize(&attr, THREAD_STACK_SIZE) != 0)
 386     {
 387         pthread_attr_destroy(&attr);
 388         free(cntr);
 389         return althrd_error;
 390     }
 391
 392     cntr->func = func;
 393     cntr->arg = arg;
 394     if(pthread_create(thr, &attr, althrd_starter, cntr) != 0)
 395     {
 396         pthread_attr_destroy(&attr);
 397         free(cntr);
 398         return althrd_error;
 399     }
 400     pthread_attr_destroy(&attr);
 401
 402     return althrd_success;
 403 }
 404
 405 int althrd_detach(althrd_t thr)
 406 {
 407     if(pthread_detach(thr) != 0)
 408         return althrd_error;
 409     return althrd_success;
 410 }
 411
 412 int althrd_join(althrd_t thr, int *res)
 413 {
 414     void *code;
 415
 416     if(pthread_join(thr, &code) != 0)
 417         return althrd_error;
 418     if(res != NULL)
 419         *res = (int)(intptr_t)code;
 420     return althrd_success;
 421 }
 422
 423
 424 int almtx_init(almtx_t *mtx, int type)
 425 {
 426     int ret;
 427
 428     if(!mtx) return althrd_error;
 429     if((type&~(almtx_recursive|almtx_timed)) != 0)
 430         return althrd_error;
 431
 432     type &= ~almtx_timed;
 433     if(type == almtx_plain)
 434         ret = pthread_mutex_init(mtx, NULL);
 435     else
 436     {
 437         pthread_mutexattr_t attr;
 438
 439         ret = pthread_mutexattr_init(&attr);
 440         if(ret) return althrd_error;
 441
 442         if(type == almtx_recursive)
 443         {
 444             ret = pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_RECURSIVE);
 445 #ifdef HAVE_PTHREAD_MUTEXATTR_SETKIND_NP
 446             if(ret != 0)
 447                 ret = pthread_mutexattr_setkind_np(&attr, PTHREAD_MUTEX_RECURSIVE);
 448 #endif
 449         }
 450         else
 451             ret = 1;
 452         if(ret == 0)
 453             ret = pthread_mutex_init(mtx, &attr);
 454         pthread_mutexattr_destroy(&attr);
 455     }
 456     return ret ? althrd_error : althrd_success;
 457 }
 458
 459 void almtx_destroy(almtx_t *mtx)
 460 {
 461     pthread_mutex_destroy(mtx);
 462 }
 463
 464 int almtx_timedlock(almtx_t *mtx, const struct timespec *ts)
 465 {
 466     int ret;
 467
 468 #ifdef HAVE_PTHREAD_MUTEX_TIMEDLOCK
 469     ret = pthread_mutex_timedlock(mtx, ts);
 470     switch(ret)
 471     {
 472         case 0: return althrd_success;
 473         case ETIMEDOUT: return althrd_timedout;
 474         case EBUSY: return althrd_busy;
 475     }
 476     return althrd_error;
 477 #else
 478     if(!mtx || !ts)
 479         return althrd_error;
 480
 481     while((ret=almtx_trylock(mtx)) == althrd_busy)
 482     {
 483         struct timespec now;
 484
 485         if(ts->tv_sec < 0 || ts->tv_nsec < 0 || ts->tv_nsec >= 1000000000 ||
 486            altimespec_get(&now, AL_TIME_UTC) != AL_TIME_UTC)
 487             return althrd_error;
 488         if(now.tv_sec > ts->tv_sec || (now.tv_sec == ts->tv_sec && now.tv_nsec >= ts->tv_nsec))
 489             return althrd_timedout;
 490
 491         althrd_yield();
 492     }
 493
 494     return ret;
 495 #endif
 496 }
 497
 498 int alcnd_init(alcnd_t *cond)
 499 {
 500     if(pthread_cond_init(cond, NULL) == 0)
 501         return althrd_success;
 502     return althrd_error;
 503 }
 504
 505 int alcnd_signal(alcnd_t *cond)
 506 {
 507     if(pthread_cond_signal(cond) == 0)
 508         return althrd_success;
 509     return althrd_error;
 510 }
 511
 512 int alcnd_broadcast(alcnd_t *cond)
 513 {
 514     if(pthread_cond_broadcast(cond) == 0)
 515         return althrd_success;
 516     return althrd_error;
 517 }
 518
 519 int alcnd_wait(alcnd_t *cond, almtx_t *mtx)
 520 {
 521     if(pthread_cond_wait(cond, mtx) == 0)
 522         return althrd_success;
 523     return althrd_error;
 524 }
 525
 526 int alcnd_timedwait(alcnd_t *cond, almtx_t *mtx, const struct timespec *time_point)
 527 {
 528     if(pthread_cond_timedwait(cond, mtx, time_point) == 0)
 529         return althrd_success;
 530     return althrd_error;
 531 }
 532
 533 void alcnd_destroy(alcnd_t *cond)
 534 {
 535     pthread_cond_destroy(cond);
 536 }
 537
 538
 539 int altss_create(altss_t *tss_id, altss_dtor_t callback)
 540 {
 541     if(pthread_key_create(tss_id, callback) != 0)
 542         return althrd_error;
 543     return althrd_success;
 544 }
 545
 546 void altss_delete(altss_t tss_id)
 547 {
 548     pthread_key_delete(tss_id);
 549 }
 550
 551
 552 int altimespec_get(struct timespec *ts, int base)
 553 {
 554     if(base == AL_TIME_UTC)
 555     {
 556         int ret;
 557 #if _POSIX_TIMERS > 0
 558         ret = clock_gettime(CLOCK_REALTIME, ts);
 559         if(ret == 0) return base;
 560 #else /* _POSIX_TIMERS > 0 */
 561         struct timeval tv;
 562         ret = gettimeofday(&tv, NULL);
 563         if(ret == 0)
 564         {
 565             ts->tv_sec = tv.tv_sec;
 566             ts->tv_nsec = tv.tv_usec * 1000;
 567             return base;
 568         }
 569 #endif
 570     }
 571
 572     return 0;
 573 }
 574
 575 #endif
 576
 577
 578 void al_nssleep(time_t sec, long nsec)
 579 {
 580     struct timespec ts, rem;
 581     ts.tv_sec = sec;
 582     ts.tv_nsec = nsec;
 583
 584     while(althrd_sleep(&ts, &rem) == -1)
 585         ts = rem;
 586 }