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/internal_config.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 /* use named semaphore when sem_init() does not work */
  48 #if !HAVE_SEM_INIT
  49 static int next_sem_ID = 0;
  50 static xbt_os_mutex_t next_sem_ID_lock;
  51 #endif
  52
  53 typedef struct xbt_os_thread_ {
  54   pthread_t t;
  55   int detached;
  56   char *name;
  57   void *param;
  58   pvoid_f_pvoid_t start_routine;
  59   void *extra_data;
  60 } s_xbt_os_thread_t;
  61 static xbt_os_thread_t main_thread = NULL;
  62
  63 /* thread-specific data containing the xbt_os_thread_t structure */
  64 static pthread_key_t xbt_self_thread_key;
  65 static int thread_mod_inited = 0;
  66
  67 /* defaults attribute for pthreads */
  68 //FIXME: find where to put this
  69 static pthread_attr_t thread_attr;
  70
  71 /* frees the xbt_os_thread_t corresponding to the current thread */
  72 static void xbt_os_thread_free_thread_data(xbt_os_thread_t thread)
  73 {
  74   if (thread == main_thread)    /* just killed main thread */
  75     main_thread = NULL;
  76   free(thread->name);
  77   free(thread);
  78 }
  79
  80 /* callback: termination */
  81 static void _os_thread_ex_terminate(xbt_ex_t * e)
  82 {
  83   xbt_ex_display(e);
  84   xbt_abort();
  85   /* FIXME: there should be a configuration variable to choose to kill everyone or only this one */
  86 }
  87
  88 void xbt_os_thread_mod_preinit(void)
  89 {
  90   if (thread_mod_inited)
  91     return;
  92
  93   int errcode = pthread_key_create(&xbt_self_thread_key, NULL);
  94   xbt_assert(errcode == 0, "pthread_key_create failed for xbt_self_thread_key");
  95
  96   main_thread = xbt_new(s_xbt_os_thread_t, 1);
  97   main_thread->name = NULL;
  98   main_thread->detached = 0;
  99   main_thread->name = xbt_strdup("main");
 100   main_thread->param = NULL;
 101   main_thread->start_routine = NULL;
 102   main_thread->extra_data = NULL;
 103
 104   if ((errcode = pthread_setspecific(xbt_self_thread_key, main_thread)))
 105     THROWF(system_error, errcode,
 106            "Impossible to set the SimGrid identity descriptor to the main thread (pthread_setspecific failed)");
 107
 108   pthread_attr_init(&thread_attr);
 109
 110   thread_mod_inited = 1;
 111
 112 #if !HAVE_SEM_INIT
 113   next_sem_ID_lock = xbt_os_mutex_init();
 114 #endif
 115 }
 116
 117 void xbt_os_thread_mod_postexit(void)
 118 {
 119   /* FIXME: don't try to free our key on shutdown.
 120      Valgrind detects no leak if we don't, and whine if we try to */
 121   //   int errcode;
 122
 123   //   if ((errcode=pthread_key_delete(xbt_self_thread_key)))
 124   //     THROWF(system_error,errcode,"pthread_key_delete failed for xbt_self_thread_key");
 125   free(main_thread->name);
 126   free(main_thread);
 127   main_thread = NULL;
 128   thread_mod_inited = 0;
 129 #if !HAVE_SEM_INIT
 130   xbt_os_mutex_destroy(next_sem_ID_lock);
 131 #endif
 132 }
 133
 134 /** Calls pthread_atfork() if present, and raise an exception otherwise.
 135  *
 136  * The only known user of this wrapper is mmalloc_preinit(), but it is absolutely mandatory there:
 137  * when used with tesh, mmalloc *must* be mutex protected and resistant to forks.
 138  * This functionality is the only way to get it working (by ensuring that the mutex is consistently released on forks)
 139  */
 140
 141 /* this function is critical to tesh+mmalloc, don't mess with it */
 142 int xbt_os_thread_atfork(void (*prepare)(void), void (*parent)(void), void (*child)(void))
 143 {
 144   return pthread_atfork(prepare, parent, child);
 145 }
 146
 147 static void *wrapper_start_routine(void *s)
 148 {
 149   xbt_os_thread_t t = s;
 150
 151   int errcode = pthread_setspecific(xbt_self_thread_key, t);
 152   xbt_assert(errcode == 0, "pthread_setspecific failed for xbt_self_thread_key");
 153
 154   void *res = t->start_routine(t->param);
 155   if (t->detached)
 156     xbt_os_thread_free_thread_data(t);
 157   return res;
 158 }
 159
 160 xbt_os_thread_t xbt_os_thread_create(const char *name,  pvoid_f_pvoid_t start_routine, void *param, void *extra_data)
 161 {
 162   xbt_os_thread_t res_thread = xbt_new(s_xbt_os_thread_t, 1);
 163   res_thread->detached = 0;
 164   res_thread->name = xbt_strdup(name);
 165   res_thread->start_routine = start_routine;
 166   res_thread->param = param;
 167   res_thread->extra_data = extra_data;
 168
 169   int errcode = pthread_create(&(res_thread->t), &thread_attr, wrapper_start_routine, res_thread);
 170   xbt_assert(errcode == 0, "pthread_create failed: %s", strerror(errcode));
 171
 172   return res_thread;
 173 }
 174
 175 /** Bind the thread to the given core, if possible.
 176  *
 177  * If pthread_setaffinity_np is not usable on that (non-gnu) platform, this function does nothing.
 178  */
 179 int xbt_os_thread_bind(xbt_os_thread_t thread, int cpu){
 180   int errcode = 0;
 181 #if HAVE_PTHREAD_SETAFFINITY
 182   pthread_t pthread = thread->t;
 183   cpu_set_t cpuset;
 184   CPU_ZERO(&cpuset);
 185   CPU_SET(cpu, &cpuset);
 186   errcode = pthread_setaffinity_np(pthread, sizeof(cpu_set_t), &cpuset);
 187 #endif
 188   return errcode;
 189 }
 190
 191 void xbt_os_thread_setstacksize(int stack_size)
 192 {
 193   size_t alignment[] = {
 194     xbt_pagesize,
 195 #ifdef PTHREAD_STACK_MIN
 196     PTHREAD_STACK_MIN,
 197 #endif
 198     0
 199   };
 200
 201   xbt_assert(stack_size >= 0, "stack size %d is negative, maybe it exceeds MAX_INT?", stack_size);
 202
 203   size_t sz = stack_size;
 204   int res = pthread_attr_setstacksize(&thread_attr, sz);
 205
 206   for (int i = 0; res == EINVAL && alignment[i] > 0; i++) {
 207     /* Invalid size, try again with next multiple of alignment[i]. */
 208     size_t rem = sz % alignment[i];
 209     if (rem != 0 || sz == 0) {
 210       size_t sz2 = sz - rem + alignment[i];
 211       XBT_DEBUG("pthread_attr_setstacksize failed for %zd, try again with %zd", sz, sz2);
 212       sz = sz2;
 213       res = pthread_attr_setstacksize(&thread_attr, sz);
 214     }
 215   }
 216
 217   if (res == EINVAL)
 218     XBT_WARN("invalid stack size (maybe too big): %zd", sz);
 219   else if (res != 0)
 220     XBT_WARN("unknown error %d in pthread stacksize setting: %zd", res, sz);
 221 }
 222
 223 void xbt_os_thread_setguardsize(int guard_size)
 224 {
 225 #ifdef WIN32
 226   THROW_UNIMPLEMENTED; //pthread_attr_setguardsize is not implemented in pthread.h on windows
 227 #else
 228   size_t sz = guard_size;
 229   int res = pthread_attr_setguardsize(&thread_attr, sz);
 230   if (res)
 231     XBT_WARN("pthread_attr_setguardsize failed (%d) for size: %zd", res, sz);
 232 #endif
 233 }
 234
 235 const char *xbt_os_thread_self_name(void)
 236 {
 237   xbt_os_thread_t me = xbt_os_thread_self();
 238   return me ? (const char *)me->name : "main";
 239 }
 240
 241 void xbt_os_thread_join(xbt_os_thread_t thread, void **thread_return)
 242 {
 243   int errcode = pthread_join(thread->t, thread_return);
 244
 245   xbt_assert(errcode==0, "pthread_join failed: %s", strerror(errcode));
 246   xbt_os_thread_free_thread_data(thread);
 247 }
 248
 249 void xbt_os_thread_exit(int *retval)
 250 {
 251   pthread_exit(retval);
 252 }
 253
 254 xbt_os_thread_t xbt_os_thread_self(void )
 255 {
 256   if (!thread_mod_inited)
 257     return NULL;
 258
 259   return pthread_getspecific(xbt_self_thread_key);
 260 }
 261
 262 void xbt_os_thread_key_create(xbt_os_thread_key_t* key)
 263 {
 264   int errcode = pthread_key_create(key, NULL);
 265   xbt_assert(errcode==0 , "pthread_key_create failed");
 266 }
 267
 268 void xbt_os_thread_set_specific(xbt_os_thread_key_t key, void* value)
 269 {
 270   int errcode = pthread_setspecific(key, value);
 271   xbt_assert(errcode==0, "pthread_setspecific failed");
 272 }
 273
 274 void* xbt_os_thread_get_specific(xbt_os_thread_key_t key)
 275 {
 276   return pthread_getspecific(key);
 277 }
 278
 279 void xbt_os_thread_detach(xbt_os_thread_t thread)
 280 {
 281   thread->detached = 1;
 282   pthread_detach(thread->t);
 283 }
 284
 285 #include <sched.h>
 286 void xbt_os_thread_yield(void)
 287 {
 288   sched_yield();
 289 }
 290
 291 void xbt_os_thread_cancel(xbt_os_thread_t t)
 292 {
 293   pthread_cancel(t->t);
 294 }
 295
 296 /****** mutex related functions ******/
 297 typedef struct xbt_os_mutex_ {
 298   pthread_mutex_t m;
 299 } s_xbt_os_mutex_t;
 300
 301 #include <time.h>
 302 #include <math.h>
 303
 304 xbt_os_mutex_t xbt_os_mutex_init(void)
 305 {
 306   pthread_mutexattr_t Attr;
 307   pthread_mutexattr_init(&Attr);
 308   pthread_mutexattr_settype(&Attr, PTHREAD_MUTEX_RECURSIVE);
 309
 310   xbt_os_mutex_t res = xbt_new(s_xbt_os_mutex_t, 1);
 311   int errcode = pthread_mutex_init(&(res->m), &Attr);
 312   xbt_assert(errcode==0, "pthread_mutex_init() failed: %s", strerror(errcode));
 313
 314   return res;
 315 }
 316
 317 void xbt_os_mutex_acquire(xbt_os_mutex_t mutex)
 318 {
 319   int errcode = pthread_mutex_lock(&(mutex->m));
 320   xbt_assert(errcode==0, "pthread_mutex_lock(%p) failed: %s", mutex, strerror(errcode));
 321 }
 322
 323 void xbt_os_mutex_release(xbt_os_mutex_t mutex)
 324 {
 325   int errcode = pthread_mutex_unlock(&(mutex->m));
 326   xbt_assert(errcode==0, "pthread_mutex_unlock(%p) failed: %s", mutex, strerror(errcode));
 327 }
 328
 329 void xbt_os_mutex_destroy(xbt_os_mutex_t mutex)
 330 {
 331   if (!mutex)
 332     return;
 333
 334   int errcode = pthread_mutex_destroy(&(mutex->m));
 335   xbt_assert(errcode == 0, "pthread_mutex_destroy(%p) failed: %s", mutex, strerror(errcode));
 336   free(mutex);
 337 }
 338
 339 /***** condition related functions *****/
 340 typedef struct xbt_os_cond_ {
 341   pthread_cond_t c;
 342 } s_xbt_os_cond_t;
 343
 344 xbt_os_cond_t xbt_os_cond_init(void)
 345 {
 346   xbt_os_cond_t res = xbt_new(s_xbt_os_cond_t, 1);
 347   int errcode = pthread_cond_init(&(res->c), NULL);
 348   xbt_assert(errcode==0, "pthread_cond_init() failed: %s", strerror(errcode));
 349   return res;
 350 }
 351
 352 void xbt_os_cond_wait(xbt_os_cond_t cond, xbt_os_mutex_t mutex)
 353 {
 354   int errcode = pthread_cond_wait(&(cond->c), &(mutex->m));
 355   xbt_assert(errcode==0, "pthread_cond_wait(%p,%p) failed: %s", cond, mutex, strerror(errcode));
 356 }
 357
 358 void xbt_os_cond_signal(xbt_os_cond_t cond)
 359 {
 360   int errcode = pthread_cond_signal(&(cond->c));
 361   xbt_assert(errcode==0, "pthread_cond_signal(%p) failed: %s", cond, strerror(errcode));
 362 }
 363
 364 void xbt_os_cond_broadcast(xbt_os_cond_t cond)
 365 {
 366   int errcode = pthread_cond_broadcast(&(cond->c));
 367   xbt_assert(errcode==0, "pthread_cond_broadcast(%p) failed: %s", cond, strerror(errcode));
 368 }
 369
 370 void xbt_os_cond_destroy(xbt_os_cond_t cond)
 371 {
 372   if (!cond)
 373     return;
 374
 375   int errcode = pthread_cond_destroy(&(cond->c));
 376   xbt_assert(errcode==0, "pthread_cond_destroy(%p) failed: %s", cond, strerror(errcode));
 377   free(cond);
 378 }
 379
 380 typedef struct xbt_os_sem_ {
 381 #if !HAVE_SEM_INIT
 382   char *name;
 383 #endif
 384   sem_t s;
 385   sem_t *ps;
 386 } s_xbt_os_sem_t;
 387
 388 #ifndef SEM_FAILED
 389 #define SEM_FAILED (-1)
 390 #endif
 391
 392 xbt_os_sem_t xbt_os_sem_init(unsigned int value)
 393 {
 394   xbt_os_sem_t res = xbt_new(s_xbt_os_sem_t, 1);
 395
 396   /* On some systems (MAC OS X), only the stub of sem_init is to be found.
 397    * Any attempt to use it leads to ENOSYS (function not implemented).
 398    * If such a prehistoric system is detected, do the job with sem_open instead
 399    */
 400 #if HAVE_SEM_INIT
 401   if (sem_init(&(res->s), 0, value) != 0)
 402     THROWF(system_error, errno, "sem_init() failed: %s", strerror(errno));
 403   res->ps = &(res->s);
 404
 405 #else                           /* damn, no sem_init(). Reimplement it */
 406
 407   xbt_os_mutex_acquire(next_sem_ID_lock);
 408   res->name = bprintf("/sg-%d", ++next_sem_ID);
 409   xbt_os_mutex_release(next_sem_ID_lock);
 410
 411   sem_unlink(res->name);
 412   res->ps = sem_open(res->name, O_CREAT, 0644, value);
 413   if ((res->ps == (sem_t *) SEM_FAILED) && (errno == ENAMETOOLONG)) {
 414     /* Old darwins only allow 13 chars. Did you create *that* amount of semaphores? */
 415     res->name[13] = '\0';
 416     sem_unlink(res->name);
 417     res->ps = sem_open(res->name, O_CREAT, 0644, value);
 418   }
 419   if (res->ps == (sem_t *) SEM_FAILED)
 420     THROWF(system_error, errno, "sem_open() failed: %s", strerror(errno));
 421
 422   /* Remove the name from the semaphore namespace: we never join on it */
 423   if (sem_unlink(res->name) < 0)
 424     THROWF(system_error, errno, "sem_unlink() failed: %s",
 425            strerror(errno));
 426
 427 #endif
 428
 429   return res;
 430 }
 431
 432 void xbt_os_sem_acquire(xbt_os_sem_t sem)
 433 {
 434   if (sem_wait(sem->ps) < 0)
 435     THROWF(system_error, errno, "sem_wait() failed: %s", strerror(errno));
 436 }
 437
 438 void xbt_os_sem_release(xbt_os_sem_t sem)
 439 {
 440   if (sem_post(sem->ps) < 0)
 441     THROWF(system_error, errno, "sem_post() failed: %s", strerror(errno));
 442 }
 443
 444 void xbt_os_sem_destroy(xbt_os_sem_t sem)
 445 {
 446 #if HAVE_SEM_INIT
 447   if (sem_destroy(sem->ps) < 0)
 448     THROWF(system_error, errno, "sem_destroy() failed: %s", strerror(errno));
 449 #else
 450   if (sem_close(sem->ps) < 0)
 451     THROWF(system_error, errno, "sem_close() failed: %s", strerror(errno));
 452   xbt_free(sem->name);
 453 #endif
 454   xbt_free(sem);
 455 }
 456
 457 /** @brief Returns the amount of cores on the current host */
 458 int xbt_os_get_numcores(void) {
 459 #ifdef WIN32
 460     SYSTEM_INFO sysinfo;
 461     GetSystemInfo(&sysinfo);
 462     return sysinfo.dwNumberOfProcessors;
 463 #elif defined(__APPLE__) && defined(__MACH__)
 464     int nm[2];
 465     size_t len = 4;
 466     uint32_t count;
 467
 468     nm[0] = CTL_HW; nm[1] = HW_AVAILCPU;
 469     sysctl(nm, 2, &count, &len, NULL, 0);
 470
 471     if(count < 1) {
 472         nm[1] = HW_NCPU;
 473         sysctl(nm, 2, &count, &len, NULL, 0);
 474         if(count < 1) { count = 1; }
 475     }
 476     return count;
 477 #else
 478     return sysconf(_SC_NPROCESSORS_ONLN);
 479 #endif
 480 }
 481
 482 void xbt_os_thread_set_extra_data(void *data)
 483 {
 484   xbt_os_thread_self()->extra_data = data;
 485 }
 486
 487 void *xbt_os_thread_get_extra_data(void)
 488 {
 489   xbt_os_thread_t thread = xbt_os_thread_self();
 490   return thread ? thread->extra_data : NULL;
 491 }