src/xbt/xbt_os_thread.c

   1 /* xbt_os_thread -- portability layer over the pthread API                  */
   2 /* Used in RL to get win/lin portability, and in SG when CONTEXT_THREAD     */
   3 /* in SG, when using HAVE_UCONTEXT_CONTEXTS, xbt_os_thread_stub is used instead   */
   4
   5 /* Copyright (c) 2007-2015. The SimGrid Team.
   6  * All rights reserved.                                                     */
   7
   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. */
  10
  11 #include "src/internal_config.h"
  12 #ifdef HAVE_PTHREAD_SETAFFINITY
  13 #define _GNU_SOURCE
  14 #include <sched.h>
  15 #endif
  16
  17 #include <pthread.h>
  18
  19 #if defined(__FreeBSD__)
  20 #include "pthread_np.h"
  21 #define cpu_set_t cpuset_t
  22 #endif
  23
  24 #include <limits.h>
  25 #include <semaphore.h>
  26 #include <errno.h>
  27
  28 #if defined(WIN32)
  29 #elif defined(__MACH__) && defined(__APPLE__)
  30 #include <stdint.h>
  31 #include <sys/types.h>
  32 #include <sys/sysctl.h>
  33 #else
  34 #include <unistd.h>
  35 #endif
  36
  37 #include "xbt/sysdep.h"
  38 #include "xbt/ex.h"
  39 #include "src/xbt/ex_interface.h"  /* We play crude games with exceptions */
  40 #include "src/portable.h"
  41 #include "xbt/xbt_os_time.h"       /* Portable time facilities */
  42 #include "xbt/xbt_os_thread.h"     /* This module */
  43 #include "src/xbt_modinter.h"      /* Initialization/finalization of this module */
  44
  45 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_sync_os, xbt, "Synchronization mechanism (OS-level)");
  46
  47
  48 /* use named sempahore when sem_init() does not work */
  49 #ifndef HAVE_SEM_INIT
  50 static int next_sem_ID = 0;
  51 static xbt_os_mutex_t next_sem_ID_lock;
  52 #endif
  53
  54 typedef struct xbt_os_thread_ {
  55   pthread_t t;
  56   int detached;
  57   char *name;
  58   void *param;
  59   pvoid_f_pvoid_t start_routine;
  60   xbt_running_ctx_t *running_ctx;
  61   void *extra_data;
  62 } s_xbt_os_thread_t;
  63 static xbt_os_thread_t main_thread = NULL;
  64
  65 /* thread-specific data containing the xbt_os_thread_t structure */
  66 static pthread_key_t xbt_self_thread_key;
  67 static int thread_mod_inited = 0;
  68
  69 /* defaults attribute for pthreads */
  70 //FIXME: find where to put this
  71 static pthread_attr_t thread_attr;
  72
  73 /* frees the xbt_os_thread_t corresponding to the current thread */
  74 static void xbt_os_thread_free_thread_data(xbt_os_thread_t thread)
  75 {
  76   if (thread == main_thread)    /* just killed main thread */
  77     main_thread = NULL;
  78
  79   free(thread->running_ctx);
  80   free(thread->name);
  81   free(thread);
  82 }
  83
  84 /* callback: context fetching */
  85 static xbt_running_ctx_t *_os_thread_get_running_ctx(void)
  86 {
  87   return xbt_os_thread_self()->running_ctx;
  88 }
  89
  90 /* callback: termination */
  91 static void _os_thread_ex_terminate(xbt_ex_t * e)
  92 {
  93   xbt_ex_display(e);
  94   xbt_abort();
  95   /* FIXME: there should be a configuration variable to choose to kill everyone or only this one */
  96 }
  97
  98 void xbt_os_thread_mod_preinit(void)
  99 {
 100   if (thread_mod_inited)
 101     return;
 102
 103   int errcode = pthread_key_create(&xbt_self_thread_key, NULL);
 104   xbt_assert(errcode == 0, "pthread_key_create failed for xbt_self_thread_key");
 105
 106   main_thread = xbt_new(s_xbt_os_thread_t, 1);
 107   main_thread->name = NULL;
 108   main_thread->detached = 0;
 109   main_thread->name = (char *) "main";
 110   main_thread->param = NULL;
 111   main_thread->start_routine = NULL;
 112   main_thread->running_ctx = xbt_new(xbt_running_ctx_t, 1);
 113   main_thread->extra_data = NULL;
 114   XBT_RUNNING_CTX_INITIALIZE(main_thread->running_ctx);
 115
 116   if ((errcode = pthread_setspecific(xbt_self_thread_key, main_thread)))
 117     THROWF(system_error, errcode,
 118            "Impossible to set the SimGrid identity descriptor to the main thread (pthread_setspecific failed)");
 119
 120   __xbt_running_ctx_fetch = _os_thread_get_running_ctx;
 121   __xbt_ex_terminate = _os_thread_ex_terminate;
 122
 123   pthread_attr_init(&thread_attr);
 124
 125   thread_mod_inited = 1;
 126
 127 #ifndef HAVE_SEM_INIT
 128   next_sem_ID_lock = xbt_os_mutex_init();
 129 #endif
 130 }
 131
 132 void xbt_os_thread_mod_postexit(void)
 133 {
 134   /* FIXME: don't try to free our key on shutdown.
 135      Valgrind detects no leak if we don't, and whine if we try to */
 136   //   int errcode;
 137
 138   //   if ((errcode=pthread_key_delete(xbt_self_thread_key)))
 139   //     THROWF(system_error,errcode,"pthread_key_delete failed for xbt_self_thread_key");
 140   free(main_thread->running_ctx);
 141   free(main_thread);
 142   main_thread = NULL;
 143   thread_mod_inited = 0;
 144 #ifndef HAVE_SEM_INIT
 145   xbt_os_mutex_destroy(next_sem_ID_lock);
 146 #endif
 147
 148   /* Restore the default exception setup */
 149   __xbt_running_ctx_fetch = &__xbt_ex_ctx_default;
 150   __xbt_ex_terminate = &__xbt_ex_terminate_default;
 151 }
 152
 153 /* this function is critical to tesh+mmalloc, don't mess with it */
 154 int xbt_os_thread_atfork(void (*prepare)(void), void (*parent)(void), void (*child)(void))
 155 {
 156   return pthread_atfork(prepare, parent, child);
 157 }
 158
 159 static void *wrapper_start_routine(void *s)
 160 {
 161   xbt_os_thread_t t = s;
 162
 163   int errcode = pthread_setspecific(xbt_self_thread_key, t);
 164   xbt_assert(errcode == 0, "pthread_setspecific failed for xbt_self_thread_key");
 165
 166   void *res = t->start_routine(t->param);
 167   if (t->detached)
 168     xbt_os_thread_free_thread_data(t);
 169   return res;
 170 }
 171
 172
 173 xbt_os_thread_t xbt_os_thread_create(const char *name,  pvoid_f_pvoid_t start_routine, void *param, void *extra_data)
 174 {
 175   xbt_os_thread_t res_thread = xbt_new(s_xbt_os_thread_t, 1);
 176   res_thread->detached = 0;
 177   res_thread->name = xbt_strdup(name);
 178   res_thread->start_routine = start_routine;
 179   res_thread->param = param;
 180   res_thread->running_ctx = xbt_new(xbt_running_ctx_t, 1);
 181   XBT_RUNNING_CTX_INITIALIZE(res_thread->running_ctx);
 182   res_thread->extra_data = extra_data;
 183
 184   int errcode = pthread_create(&(res_thread->t), &thread_attr, wrapper_start_routine, res_thread);
 185   xbt_assert(errcode == 0, "pthread_create failed: %s", strerror(errcode));
 186
 187   return res_thread;
 188 }
 189
 190 int xbt_os_thread_bind(xbt_os_thread_t thread, int cpu){
 191   int errcode = 0;
 192 #ifdef HAVE_PTHREAD_SETAFFINITY
 193   pthread_t pthread = thread->t;
 194   cpu_set_t cpuset;
 195   CPU_ZERO(&cpuset);
 196   CPU_SET(cpu, &cpuset);
 197   errcode = pthread_setaffinity_np(pthread, sizeof(cpu_set_t), &cpuset);
 198 #endif
 199   return errcode;
 200 }
 201
 202 void xbt_os_thread_setstacksize(int stack_size)
 203 {
 204   size_t alignment[] = {
 205     xbt_pagesize,
 206 #ifdef PTHREAD_STACK_MIN
 207     PTHREAD_STACK_MIN,
 208 #endif
 209     0
 210   };
 211
 212   xbt_assert(stack_size >= 0, "stack size %d is negative, maybe it exceeds MAX_INT?", stack_size);
 213
 214   size_t sz = stack_size;
 215   int res = pthread_attr_setstacksize(&thread_attr, sz);
 216
 217   for (int i = 0; res == EINVAL && alignment[i] > 0; i++) {
 218     /* Invalid size, try again with next multiple of alignment[i]. */
 219     size_t rem = sz % alignment[i];
 220     if (rem != 0 || sz == 0) {
 221       size_t sz2 = sz - rem + alignment[i];
 222       XBT_DEBUG("pthread_attr_setstacksize failed for %zd, try again with %zd", sz, sz2);
 223       sz = sz2;
 224       res = pthread_attr_setstacksize(&thread_attr, sz);
 225     }
 226   }
 227
 228   if (res == EINVAL)
 229     XBT_WARN("invalid stack size (maybe too big): %zd", sz);
 230   else if (res != 0)
 231     XBT_WARN("unknown error %d in pthread stacksize setting: %zd", res, sz);
 232 }
 233
 234 void xbt_os_thread_setguardsize(int guard_size)
 235 {
 236 #ifdef WIN32
 237   THROW_UNIMPLEMENTED; //pthread_attr_setguardsize is not implemented in pthread.h on windows
 238 #else
 239   size_t sz = guard_size;
 240   int res = pthread_attr_setguardsize(&thread_attr, sz);
 241   if (res)
 242     XBT_WARN("pthread_attr_setguardsize failed (%d) for size: %zd", res, sz);
 243 #endif
 244 }
 245
 246 const char *xbt_os_thread_name(xbt_os_thread_t t)
 247 {
 248   return t->name;
 249 }
 250
 251 const char *xbt_os_thread_self_name(void)
 252 {
 253   xbt_os_thread_t me = xbt_os_thread_self();
 254   return me ? me->name : "main";
 255 }
 256
 257 void xbt_os_thread_join(xbt_os_thread_t thread, void **thread_return)
 258 {
 259   int errcode = pthread_join(thread->t, thread_return);
 260
 261   xbt_assert(errcode==0, "pthread_join failed: %s", strerror(errcode));
 262   xbt_os_thread_free_thread_data(thread);
 263 }
 264
 265 void xbt_os_thread_exit(int *retval)
 266 {
 267   pthread_exit(retval);
 268 }
 269
 270 xbt_os_thread_t xbt_os_thread_self(void)
 271 {
 272   if (!thread_mod_inited)
 273     return NULL;
 274
 275   return pthread_getspecific(xbt_self_thread_key);
 276 }
 277
 278 void xbt_os_thread_key_create(xbt_os_thread_key_t* key)
 279 {
 280   int errcode = pthread_key_create(key, NULL);
 281   xbt_assert(errcode==0 , "pthread_key_create failed");
 282 }
 283
 284 void xbt_os_thread_set_specific(xbt_os_thread_key_t key, void* value) {
 285
 286   int errcode = pthread_setspecific(key, value);
 287   xbt_assert(errcode==0, "pthread_setspecific failed");
 288 }
 289
 290 void* xbt_os_thread_get_specific(xbt_os_thread_key_t key) {
 291   return pthread_getspecific(key);
 292 }
 293
 294 void xbt_os_thread_detach(xbt_os_thread_t thread)
 295 {
 296   thread->detached = 1;
 297   pthread_detach(thread->t);
 298 }
 299
 300 #include <sched.h>
 301 void xbt_os_thread_yield(void)
 302 {
 303   sched_yield();
 304 }
 305
 306 void xbt_os_thread_cancel(xbt_os_thread_t t)
 307 {
 308   pthread_cancel(t->t);
 309 }
 310
 311 /****** mutex related functions ******/
 312 typedef struct xbt_os_mutex_ {
 313   pthread_mutex_t m;
 314 } s_xbt_os_mutex_t;
 315
 316 #include <time.h>
 317 #include <math.h>
 318
 319 xbt_os_mutex_t xbt_os_mutex_init(void)
 320 {
 321   pthread_mutexattr_t Attr;
 322   pthread_mutexattr_init(&Attr);
 323   pthread_mutexattr_settype(&Attr, PTHREAD_MUTEX_RECURSIVE);
 324
 325   xbt_os_mutex_t res = xbt_new(s_xbt_os_mutex_t, 1);
 326   int errcode = pthread_mutex_init(&(res->m), &Attr);
 327   xbt_assert(errcode==0, "pthread_mutex_init() failed: %s", strerror(errcode));
 328
 329   return res;
 330 }
 331
 332 void xbt_os_mutex_acquire(xbt_os_mutex_t mutex)
 333 {
 334   int errcode = pthread_mutex_lock(&(mutex->m));
 335   xbt_assert(errcode==0, "pthread_mutex_lock(%p) failed: %s", mutex, strerror(errcode));
 336 }
 337
 338 void xbt_os_mutex_release(xbt_os_mutex_t mutex)
 339 {
 340   int errcode = pthread_mutex_unlock(&(mutex->m));
 341   xbt_assert(errcode==0, "pthread_mutex_unlock(%p) failed: %s", mutex, strerror(errcode));
 342 }
 343
 344 void xbt_os_mutex_destroy(xbt_os_mutex_t mutex)
 345 {
 346   if (!mutex)
 347     return;
 348
 349   int errcode = pthread_mutex_destroy(&(mutex->m));
 350   xbt_assert(errcode == 0, "pthread_mutex_destroy(%p) failed: %s", mutex, strerror(errcode));
 351   free(mutex);
 352 }
 353
 354 /***** condition related functions *****/
 355 typedef struct xbt_os_cond_ {
 356   pthread_cond_t c;
 357 } s_xbt_os_cond_t;
 358
 359 xbt_os_cond_t xbt_os_cond_init(void)
 360 {
 361   xbt_os_cond_t res = xbt_new(s_xbt_os_cond_t, 1);
 362   int errcode = pthread_cond_init(&(res->c), NULL);
 363   xbt_assert(errcode==0, "pthread_cond_init() failed: %s", strerror(errcode));
 364   return res;
 365 }
 366
 367 void xbt_os_cond_wait(xbt_os_cond_t cond, xbt_os_mutex_t mutex)
 368 {
 369   int errcode = pthread_cond_wait(&(cond->c), &(mutex->m));
 370   xbt_assert(errcode==0, "pthread_cond_wait(%p,%p) failed: %s", cond, mutex, strerror(errcode));
 371 }
 372
 373
 374 void xbt_os_cond_timedwait(xbt_os_cond_t cond, xbt_os_mutex_t mutex, double delay)
 375 {
 376   int errcode;
 377   struct timespec ts_end;
 378   double end = delay + xbt_os_time();
 379
 380   if (delay < 0) {
 381     xbt_os_cond_wait(cond, mutex);
 382   } else {
 383     ts_end.tv_sec = (time_t) floor(end);
 384     ts_end.tv_nsec = (long) ((end - ts_end.tv_sec) * 1000000000);
 385     XBT_DEBUG("pthread_cond_timedwait(%p,%p,%p)", &(cond->c), &(mutex->m), &ts_end);
 386     switch ((errcode = pthread_cond_timedwait(&(cond->c), &(mutex->m), &ts_end))) {
 387     case 0:
 388       return;
 389     case ETIMEDOUT:
 390       THROWF(timeout_error, errcode,
 391              "condition %p (mutex %p) wasn't signaled before timeout (%f)",
 392              cond, mutex, delay);
 393     default:
 394       THROWF(system_error, errcode, "pthread_cond_timedwait(%p,%p,%f) failed: %s", cond, mutex, delay, strerror(errcode));
 395     }
 396   }
 397 }
 398
 399 void xbt_os_cond_signal(xbt_os_cond_t cond)
 400 {
 401   int errcode = pthread_cond_signal(&(cond->c));
 402   xbt_assert(errcode==0, "pthread_cond_signal(%p) failed: %s", cond, strerror(errcode));
 403 }
 404
 405 void xbt_os_cond_broadcast(xbt_os_cond_t cond)
 406 {
 407   int errcode = pthread_cond_broadcast(&(cond->c));
 408   xbt_assert(errcode==0, "pthread_cond_broadcast(%p) failed: %s", cond, strerror(errcode));
 409 }
 410
 411 void xbt_os_cond_destroy(xbt_os_cond_t cond)
 412 {
 413   if (!cond)
 414     return;
 415
 416   int errcode = pthread_cond_destroy(&(cond->c));
 417   xbt_assert(errcode==0, "pthread_cond_destroy(%p) failed: %s", cond, strerror(errcode));
 418   free(cond);
 419 }
 420
 421 typedef struct xbt_os_sem_ {
 422 #ifndef HAVE_SEM_INIT
 423   char *name;
 424 #endif
 425   sem_t s;
 426   sem_t *ps;
 427 } s_xbt_os_sem_t;
 428
 429 #ifndef SEM_FAILED
 430 #define SEM_FAILED (-1)
 431 #endif
 432
 433 xbt_os_sem_t xbt_os_sem_init(unsigned int value)
 434 {
 435   xbt_os_sem_t res = xbt_new(s_xbt_os_sem_t, 1);
 436
 437   /* On some systems (MAC OS X), only the stub of sem_init is to be found.
 438    * Any attempt to use it leads to ENOSYS (function not implemented).
 439    * If such a prehistoric system is detected, do the job with sem_open instead
 440    */
 441 #ifdef HAVE_SEM_INIT
 442   if (sem_init(&(res->s), 0, value) != 0)
 443     THROWF(system_error, errno, "sem_init() failed: %s", strerror(errno));
 444   res->ps = &(res->s);
 445
 446 #else                           /* damn, no sem_init(). Reimplement it */
 447
 448   xbt_os_mutex_acquire(next_sem_ID_lock);
 449   res->name = bprintf("/%d", ++next_sem_ID);
 450   xbt_os_mutex_release(next_sem_ID_lock);
 451
 452   res->ps = sem_open(res->name, O_CREAT, 0644, value);
 453   if ((res->ps == (sem_t *) SEM_FAILED) && (errno == ENAMETOOLONG)) {
 454     /* Old darwins only allow 13 chars. Did you create *that* amount of semaphores? */
 455     res->name[13] = '\0';
 456     res->ps = sem_open(res->name, O_CREAT, 0644, value);
 457   }
 458   if (res->ps == (sem_t *) SEM_FAILED)
 459     THROWF(system_error, errno, "sem_open() failed: %s", strerror(errno));
 460
 461   /* Remove the name from the semaphore namespace: we never join on it */
 462   if (sem_unlink(res->name) < 0)
 463     THROWF(system_error, errno, "sem_unlink() failed: %s",
 464            strerror(errno));
 465
 466 #endif
 467
 468   return res;
 469 }
 470
 471 void xbt_os_sem_acquire(xbt_os_sem_t sem)
 472 {
 473   if (sem_wait(sem->ps) < 0)
 474     THROWF(system_error, errno, "sem_wait() failed: %s", strerror(errno));
 475 }
 476
 477 void xbt_os_sem_release(xbt_os_sem_t sem)
 478 {
 479   if (sem_post(sem->ps) < 0)
 480     THROWF(system_error, errno, "sem_post() failed: %s", strerror(errno));
 481 }
 482
 483 void xbt_os_sem_destroy(xbt_os_sem_t sem)
 484 {
 485 #ifdef HAVE_SEM_INIT
 486   if (sem_destroy(sem->ps) < 0)
 487     THROWF(system_error, errno, "sem_destroy() failed: %s",
 488            strerror(errno));
 489 #else
 490   if (sem_close(sem->ps) < 0)
 491     THROWF(system_error, errno, "sem_close() failed: %s", strerror(errno));
 492   xbt_free(sem->name);
 493
 494 #endif
 495   xbt_free(sem);
 496 }
 497
 498 void xbt_os_sem_get_value(xbt_os_sem_t sem, int *svalue)
 499 {
 500   if (sem_getvalue(&(sem->s), svalue) < 0)
 501     THROWF(system_error, errno, "sem_getvalue() failed: %s",
 502            strerror(errno));
 503 }
 504
 505
 506 /** @brief Returns the amount of cores on the current host */
 507 int xbt_os_get_numcores(void) {
 508 #ifdef WIN32
 509     SYSTEM_INFO sysinfo;
 510     GetSystemInfo(&sysinfo);
 511     return sysinfo.dwNumberOfProcessors;
 512 #elif defined(__APPLE__) && defined(__MACH__)
 513     int nm[2];
 514     size_t len = 4;
 515     uint32_t count;
 516
 517     nm[0] = CTL_HW; nm[1] = HW_AVAILCPU;
 518     sysctl(nm, 2, &count, &len, NULL, 0);
 519
 520     if(count < 1) {
 521         nm[1] = HW_NCPU;
 522         sysctl(nm, 2, &count, &len, NULL, 0);
 523         if(count < 1) { count = 1; }
 524     }
 525     return count;
 526 #else
 527     return sysconf(_SC_NPROCESSORS_ONLN);
 528 #endif
 529 }
 530
 531 void xbt_os_thread_set_extra_data(void *data)
 532 {
 533   xbt_os_thread_self()->extra_data = data;
 534 }
 535
 536 void *xbt_os_thread_get_extra_data(void)
 537 {
 538   xbt_os_thread_t thread = xbt_os_thread_self();
 539   return thread ? thread->extra_data : NULL;
 540 }