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 #if 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 #include <windows.h>
  30 #elif defined(__MACH__) && defined(__APPLE__)
  31 #include <stdint.h>
  32 #include <sys/types.h>
  33 #include <sys/sysctl.h>
  34 #else
  35 #include <unistd.h>
  36 #endif
  37
  38 #include "xbt/sysdep.h"
  39 #include "xbt/ex.h"
  40 #include "src/xbt/ex_interface.h"  /* We play crude games with exceptions */
  41 #include "src/internal_config.h"
  42 #include "xbt/xbt_os_time.h"       /* Portable time facilities */
  43 #include "xbt/xbt_os_thread.h"     /* This module */
  44 #include "src/xbt_modinter.h"      /* Initialization/finalization of this module */
  45
  46 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_sync_os, xbt, "Synchronization mechanism (OS-level)");
  47
  48 /* use named sempahore when sem_init() does not work */
  49 #if !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 #if !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 #if !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 /** Calls pthread_atfork() if present, and raise an exception otherwise.
 154  *
 155  * The only known user of this wrapper is mmalloc_preinit(), but it is absolutely mandatory there:
 156  * when used with tesh, mmalloc *must* be mutex protected and resistant to forks.
 157  * This functionality is the only way to get it working (by ensuring that the mutex is consistently released on forks)
 158  */
 159
 160 /* this function is critical to tesh+mmalloc, don't mess with it */
 161 int xbt_os_thread_atfork(void (*prepare)(void), void (*parent)(void), void (*child)(void))
 162 {
 163   return pthread_atfork(prepare, parent, child);
 164 }
 165
 166 static void *wrapper_start_routine(void *s)
 167 {
 168   xbt_os_thread_t t = s;
 169
 170   int errcode = pthread_setspecific(xbt_self_thread_key, t);
 171   xbt_assert(errcode == 0, "pthread_setspecific failed for xbt_self_thread_key");
 172
 173   void *res = t->start_routine(t->param);
 174   if (t->detached)
 175     xbt_os_thread_free_thread_data(t);
 176   return res;
 177 }
 178
 179 xbt_os_thread_t xbt_os_thread_create(const char *name,  pvoid_f_pvoid_t start_routine, void *param, void *extra_data)
 180 {
 181   xbt_os_thread_t res_thread = xbt_new(s_xbt_os_thread_t, 1);
 182   res_thread->detached = 0;
 183   res_thread->name = xbt_strdup(name);
 184   res_thread->start_routine = start_routine;
 185   res_thread->param = param;
 186   res_thread->running_ctx = xbt_new(xbt_running_ctx_t, 1);
 187   XBT_RUNNING_CTX_INITIALIZE(res_thread->running_ctx);
 188   res_thread->extra_data = extra_data;
 189
 190   int errcode = pthread_create(&(res_thread->t), &thread_attr, wrapper_start_routine, res_thread);
 191   xbt_assert(errcode == 0, "pthread_create failed: %s", strerror(errcode));
 192
 193   return res_thread;
 194 }
 195
 196 /** Bind the thread to the given core, if possible.
 197  *
 198  * If pthread_setaffinity_np is not usable on that (non-gnu) platform, this function does nothing.
 199  */
 200 int xbt_os_thread_bind(xbt_os_thread_t thread, int cpu){
 201   int errcode = 0;
 202 #if HAVE_PTHREAD_SETAFFINITY
 203   pthread_t pthread = thread->t;
 204   cpu_set_t cpuset;
 205   CPU_ZERO(&cpuset);
 206   CPU_SET(cpu, &cpuset);
 207   errcode = pthread_setaffinity_np(pthread, sizeof(cpu_set_t), &cpuset);
 208 #endif
 209   return errcode;
 210 }
 211
 212 void xbt_os_thread_setstacksize(int stack_size)
 213 {
 214   size_t alignment[] = {
 215     xbt_pagesize,
 216 #ifdef PTHREAD_STACK_MIN
 217     PTHREAD_STACK_MIN,
 218 #endif
 219     0
 220   };
 221
 222   xbt_assert(stack_size >= 0, "stack size %d is negative, maybe it exceeds MAX_INT?", stack_size);
 223
 224   size_t sz = stack_size;
 225   int res = pthread_attr_setstacksize(&thread_attr, sz);
 226
 227   for (int i = 0; res == EINVAL && alignment[i] > 0; i++) {
 228     /* Invalid size, try again with next multiple of alignment[i]. */
 229     size_t rem = sz % alignment[i];
 230     if (rem != 0 || sz == 0) {
 231       size_t sz2 = sz - rem + alignment[i];
 232       XBT_DEBUG("pthread_attr_setstacksize failed for %zd, try again with %zd", sz, sz2);
 233       sz = sz2;
 234       res = pthread_attr_setstacksize(&thread_attr, sz);
 235     }
 236   }
 237
 238   if (res == EINVAL)
 239     XBT_WARN("invalid stack size (maybe too big): %zd", sz);
 240   else if (res != 0)
 241     XBT_WARN("unknown error %d in pthread stacksize setting: %zd", res, sz);
 242 }
 243
 244 void xbt_os_thread_setguardsize(int guard_size)
 245 {
 246 #ifdef WIN32
 247   THROW_UNIMPLEMENTED; //pthread_attr_setguardsize is not implemented in pthread.h on windows
 248 #else
 249   size_t sz = guard_size;
 250   int res = pthread_attr_setguardsize(&thread_attr, sz);
 251   if (res)
 252     XBT_WARN("pthread_attr_setguardsize failed (%d) for size: %zd", res, sz);
 253 #endif
 254 }
 255
 256 const char *xbt_os_thread_self_name(void)
 257 {
 258   xbt_os_thread_t me = xbt_os_thread_self();
 259   return me ? me->name : "main";
 260 }
 261
 262 void xbt_os_thread_join(xbt_os_thread_t thread, void **thread_return)
 263 {
 264   int errcode = pthread_join(thread->t, thread_return);
 265
 266   xbt_assert(errcode==0, "pthread_join failed: %s", strerror(errcode));
 267   xbt_os_thread_free_thread_data(thread);
 268 }
 269
 270 void xbt_os_thread_exit(int *retval)
 271 {
 272   pthread_exit(retval);
 273 }
 274
 275 xbt_os_thread_t xbt_os_thread_self(void)
 276 {
 277   if (!thread_mod_inited)
 278     return NULL;
 279
 280   return pthread_getspecific(xbt_self_thread_key);
 281 }
 282
 283 void xbt_os_thread_key_create(xbt_os_thread_key_t* key)
 284 {
 285   int errcode = pthread_key_create(key, NULL);
 286   xbt_assert(errcode==0 , "pthread_key_create failed");
 287 }
 288
 289 void xbt_os_thread_set_specific(xbt_os_thread_key_t key, void* value)
 290 {
 291   int errcode = pthread_setspecific(key, value);
 292   xbt_assert(errcode==0, "pthread_setspecific failed");
 293 }
 294
 295 void* xbt_os_thread_get_specific(xbt_os_thread_key_t key)
 296 {
 297   return pthread_getspecific(key);
 298 }
 299
 300 void xbt_os_thread_detach(xbt_os_thread_t thread)
 301 {
 302   thread->detached = 1;
 303   pthread_detach(thread->t);
 304 }
 305
 306 #include <sched.h>
 307 void xbt_os_thread_yield(void)
 308 {
 309   sched_yield();
 310 }
 311
 312 void xbt_os_thread_cancel(xbt_os_thread_t t)
 313 {
 314   pthread_cancel(t->t);
 315 }
 316
 317 /****** mutex related functions ******/
 318 typedef struct xbt_os_mutex_ {
 319   pthread_mutex_t m;
 320 } s_xbt_os_mutex_t;
 321
 322 #include <time.h>
 323 #include <math.h>
 324
 325 xbt_os_mutex_t xbt_os_mutex_init(void)
 326 {
 327   pthread_mutexattr_t Attr;
 328   pthread_mutexattr_init(&Attr);
 329   pthread_mutexattr_settype(&Attr, PTHREAD_MUTEX_RECURSIVE);
 330
 331   xbt_os_mutex_t res = xbt_new(s_xbt_os_mutex_t, 1);
 332   int errcode = pthread_mutex_init(&(res->m), &Attr);
 333   xbt_assert(errcode==0, "pthread_mutex_init() failed: %s", strerror(errcode));
 334
 335   return res;
 336 }
 337
 338 void xbt_os_mutex_acquire(xbt_os_mutex_t mutex)
 339 {
 340   int errcode = pthread_mutex_lock(&(mutex->m));
 341   xbt_assert(errcode==0, "pthread_mutex_lock(%p) failed: %s", mutex, strerror(errcode));
 342 }
 343
 344 void xbt_os_mutex_release(xbt_os_mutex_t mutex)
 345 {
 346   int errcode = pthread_mutex_unlock(&(mutex->m));
 347   xbt_assert(errcode==0, "pthread_mutex_unlock(%p) failed: %s", mutex, strerror(errcode));
 348 }
 349
 350 void xbt_os_mutex_destroy(xbt_os_mutex_t mutex)
 351 {
 352   if (!mutex)
 353     return;
 354
 355   int errcode = pthread_mutex_destroy(&(mutex->m));
 356   xbt_assert(errcode == 0, "pthread_mutex_destroy(%p) failed: %s", mutex, strerror(errcode));
 357   free(mutex);
 358 }
 359
 360 /***** condition related functions *****/
 361 typedef struct xbt_os_cond_ {
 362   pthread_cond_t c;
 363 } s_xbt_os_cond_t;
 364
 365 xbt_os_cond_t xbt_os_cond_init(void)
 366 {
 367   xbt_os_cond_t res = xbt_new(s_xbt_os_cond_t, 1);
 368   int errcode = pthread_cond_init(&(res->c), NULL);
 369   xbt_assert(errcode==0, "pthread_cond_init() failed: %s", strerror(errcode));
 370   return res;
 371 }
 372
 373 void xbt_os_cond_wait(xbt_os_cond_t cond, xbt_os_mutex_t mutex)
 374 {
 375   int errcode = pthread_cond_wait(&(cond->c), &(mutex->m));
 376   xbt_assert(errcode==0, "pthread_cond_wait(%p,%p) failed: %s", cond, mutex, strerror(errcode));
 377 }
 378
 379 void xbt_os_cond_signal(xbt_os_cond_t cond)
 380 {
 381   int errcode = pthread_cond_signal(&(cond->c));
 382   xbt_assert(errcode==0, "pthread_cond_signal(%p) failed: %s", cond, strerror(errcode));
 383 }
 384
 385 void xbt_os_cond_broadcast(xbt_os_cond_t cond)
 386 {
 387   int errcode = pthread_cond_broadcast(&(cond->c));
 388   xbt_assert(errcode==0, "pthread_cond_broadcast(%p) failed: %s", cond, strerror(errcode));
 389 }
 390
 391 void xbt_os_cond_destroy(xbt_os_cond_t cond)
 392 {
 393   if (!cond)
 394     return;
 395
 396   int errcode = pthread_cond_destroy(&(cond->c));
 397   xbt_assert(errcode==0, "pthread_cond_destroy(%p) failed: %s", cond, strerror(errcode));
 398   free(cond);
 399 }
 400
 401 typedef struct xbt_os_sem_ {
 402 #if !HAVE_SEM_INIT
 403   char *name;
 404 #endif
 405   sem_t s;
 406   sem_t *ps;
 407 } s_xbt_os_sem_t;
 408
 409 #ifndef SEM_FAILED
 410 #define SEM_FAILED (-1)
 411 #endif
 412
 413 xbt_os_sem_t xbt_os_sem_init(unsigned int value)
 414 {
 415   xbt_os_sem_t res = xbt_new(s_xbt_os_sem_t, 1);
 416
 417   /* On some systems (MAC OS X), only the stub of sem_init is to be found.
 418    * Any attempt to use it leads to ENOSYS (function not implemented).
 419    * If such a prehistoric system is detected, do the job with sem_open instead
 420    */
 421 #if HAVE_SEM_INIT
 422   if (sem_init(&(res->s), 0, value) != 0)
 423     THROWF(system_error, errno, "sem_init() failed: %s", strerror(errno));
 424   res->ps = &(res->s);
 425
 426 #else                           /* damn, no sem_init(). Reimplement it */
 427
 428   xbt_os_mutex_acquire(next_sem_ID_lock);
 429   res->name = bprintf("/%d", ++next_sem_ID);
 430   xbt_os_mutex_release(next_sem_ID_lock);
 431
 432   res->ps = sem_open(res->name, O_CREAT, 0644, value);
 433   if ((res->ps == (sem_t *) SEM_FAILED) && (errno == ENAMETOOLONG)) {
 434     /* Old darwins only allow 13 chars. Did you create *that* amount of semaphores? */
 435     res->name[13] = '\0';
 436     res->ps = sem_open(res->name, O_CREAT, 0644, value);
 437   }
 438   if (res->ps == (sem_t *) SEM_FAILED)
 439     THROWF(system_error, errno, "sem_open() failed: %s", strerror(errno));
 440
 441   /* Remove the name from the semaphore namespace: we never join on it */
 442   if (sem_unlink(res->name) < 0)
 443     THROWF(system_error, errno, "sem_unlink() failed: %s",
 444            strerror(errno));
 445
 446 #endif
 447
 448   return res;
 449 }
 450
 451 void xbt_os_sem_acquire(xbt_os_sem_t sem)
 452 {
 453   if (sem_wait(sem->ps) < 0)
 454     THROWF(system_error, errno, "sem_wait() failed: %s", strerror(errno));
 455 }
 456
 457 void xbt_os_sem_release(xbt_os_sem_t sem)
 458 {
 459   if (sem_post(sem->ps) < 0)
 460     THROWF(system_error, errno, "sem_post() failed: %s", strerror(errno));
 461 }
 462
 463 void xbt_os_sem_destroy(xbt_os_sem_t sem)
 464 {
 465 #if HAVE_SEM_INIT
 466   if (sem_destroy(sem->ps) < 0)
 467     THROWF(system_error, errno, "sem_destroy() failed: %s", strerror(errno));
 468 #else
 469   if (sem_close(sem->ps) < 0)
 470     THROWF(system_error, errno, "sem_close() failed: %s", strerror(errno));
 471   xbt_free(sem->name);
 472 #endif
 473   xbt_free(sem);
 474 }
 475
 476 void xbt_os_sem_get_value(xbt_os_sem_t sem, int *svalue)
 477 {
 478   if (sem_getvalue(&(sem->s), svalue) < 0)
 479     THROWF(system_error, errno, "sem_getvalue() failed: %s",
 480            strerror(errno));
 481 }
 482
 483 /** @brief Returns the amount of cores on the current host */
 484 int xbt_os_get_numcores(void) {
 485 #ifdef WIN32
 486     SYSTEM_INFO sysinfo;
 487     GetSystemInfo(&sysinfo);
 488     return sysinfo.dwNumberOfProcessors;
 489 #elif defined(__APPLE__) && defined(__MACH__)
 490     int nm[2];
 491     size_t len = 4;
 492     uint32_t count;
 493
 494     nm[0] = CTL_HW; nm[1] = HW_AVAILCPU;
 495     sysctl(nm, 2, &count, &len, NULL, 0);
 496
 497     if(count < 1) {
 498         nm[1] = HW_NCPU;
 499         sysctl(nm, 2, &count, &len, NULL, 0);
 500         if(count < 1) { count = 1; }
 501     }
 502     return count;
 503 #else
 504     return sysconf(_SC_NPROCESSORS_ONLN);
 505 #endif
 506 }
 507
 508 void xbt_os_thread_set_extra_data(void *data)
 509 {
 510   xbt_os_thread_self()->extra_data = data;
 511 }
 512
 513 void *xbt_os_thread_get_extra_data(void)
 514 {
 515   xbt_os_thread_t thread = xbt_os_thread_self();
 516   return thread ? thread->extra_data : NULL;
 517 }