Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of scm.gforge.inria.fr:/gitroot/simgrid/simgrid
[simgrid.git] / src / xbt / xbt_os_thread.c
index b97d90e..4914b24 100644 (file)
@@ -1,28 +1,36 @@
 /* xbt_os_thread -- portability layer over the pthread API                  */
 /* Used in RL to get win/lin portability, and in SG when CONTEXT_THREAD     */
-/* in SG, when using CONTEXT_UCONTEXT, xbt_os_thread_stub is used instead   */
+/* in SG, when using HAVE_UCONTEXT_CONTEXTS, xbt_os_thread_stub is used instead   */
 
-/* Copyright (c) 2007-2014. The SimGrid Team.
+/* Copyright (c) 2007-2015. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
-#include "internal_config.h"
+#if defined(WIN32)
+#elif defined(__MACH__) && defined(__APPLE__)
+#include <stdint.h>
+#include <sys/types.h>
+#include <sys/sysctl.h>
+#else
+#include <unistd.h>
+#endif
+
+#include "src/internal_config.h"
 #include "xbt/sysdep.h"
 #include "xbt/ex.h"
-#include "xbt/ex_interface.h"   /* We play crude games with exceptions */
-#include "portable.h"
+#include "src/xbt/ex_interface.h"   /* We play crude games with exceptions */
+#include "src/portable.h"
 #include "xbt/xbt_os_time.h"    /* Portable time facilities */
 #include "xbt/xbt_os_thread.h"  /* This module */
-#include "xbt_modinter.h"       /* Initialization/finalization of this module */
+#include "src/xbt_modinter.h"       /* Initialization/finalization of this module */
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_sync_os, xbt,
                                 "Synchronization mechanism (OS-level)");
 
 /* ********************************* PTHREAD IMPLEMENTATION ************************************ */
-#ifdef HAVE_PTHREAD_H
-
+#include <pthread.h>
 #include <limits.h>
 #include <semaphore.h>
 
@@ -31,13 +39,6 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_sync_os, xbt,
 #include <sched.h>
 #endif
 
-#ifdef HAVE_MUTEX_TIMEDLOCK
-/* redefine the function header since we fail to get this from system headers on amd (at least) */
-int pthread_mutex_timedlock(pthread_mutex_t * mutex,
-                            const struct timespec *abs_timeout);
-#endif
-
-
 /* use named sempahore when sem_init() does not work */
 #ifndef HAVE_SEM_INIT
 static int next_sem_ID = 0;
@@ -100,15 +101,18 @@ void xbt_os_thread_mod_preinit(void)
            "pthread_key_create failed for xbt_self_thread_key");
   
   main_thread = xbt_new(s_xbt_os_thread_t, 1);
+  main_thread->name = NULL;
+  main_thread->detached = 0;
   main_thread->name = (char *) "main";
-  main_thread->start_routine = NULL;
   main_thread->param = NULL;
+  main_thread->start_routine = NULL;
   main_thread->running_ctx = xbt_new(xbt_running_ctx_t, 1);
+  main_thread->extra_data = NULL;
   XBT_RUNNING_CTX_INITIALIZE(main_thread->running_ctx);
 
   if ((errcode = pthread_setspecific(xbt_self_thread_key, main_thread)))
     THROWF(system_error, errcode,
-           "pthread_setspecific failed for xbt_self_thread_key");
+           "Impossible to set the SimGrid identity descriptor to the main thread (pthread_setspecific failed)");
   
   __xbt_running_ctx_fetch = _os_thread_get_running_ctx;
   __xbt_ex_terminate = _os_thread_ex_terminate;
@@ -288,14 +292,10 @@ void xbt_os_thread_exit(int *retval)
 
 xbt_os_thread_t xbt_os_thread_self(void)
 {
-  xbt_os_thread_t res;
-
   if (!thread_mod_inited)
     return NULL;
 
-  res = pthread_getspecific(xbt_self_thread_key);
-
-  return res;
+  return pthread_getspecific(xbt_self_thread_key);
 }
 
 void xbt_os_thread_key_create(xbt_os_thread_key_t* key) {
@@ -577,7 +577,7 @@ xbt_os_sem_t xbt_os_sem_init(unsigned int value)
     res->name[13] = '\0';
     res->ps = sem_open(res->name, O_CREAT, 0644, value);
   }
-  if ((res->ps == (sem_t *) SEM_FAILED))
+  if (res->ps == (sem_t *) SEM_FAILED)
     THROWF(system_error, errno, "sem_open() failed: %s", strerror(errno));
 
   /* Remove the name from the semaphore namespace: we never join on it */
@@ -697,558 +697,6 @@ void xbt_os_sem_get_value(xbt_os_sem_t sem, int *svalue)
            strerror(errno));
 }
 
-/* ********************************* WINDOWS IMPLEMENTATION ************************************ */
-
-#elif defined(_XBT_WIN32)
-
-#include <math.h>
-
-typedef struct xbt_os_thread_ {
-  char *name;
-  HANDLE handle;                /* the win thread handle        */
-  unsigned long id;             /* the win thread id            */
-  pvoid_f_pvoid_t start_routine;
-  void *param;
-  void *extra_data;
-} s_xbt_os_thread_t;
-
-/* so we can specify the size of the stack of the threads */
-#ifndef STACK_SIZE_PARAM_IS_A_RESERVATION
-#define STACK_SIZE_PARAM_IS_A_RESERVATION 0x00010000
-#endif
-
-/* the default size of the stack of the threads (in bytes)*/
-#define XBT_DEFAULT_THREAD_STACK_SIZE  4096
-static int stack_size=0;
-/* key to the TLS containing the xbt_os_thread_t structure */
-static unsigned long xbt_self_thread_key;
-
-void xbt_os_thread_mod_preinit(void)
-{
-  xbt_self_thread_key = TlsAlloc();
-}
-
-void xbt_os_thread_mod_postexit(void)
-{
-
-  if (!TlsFree(xbt_self_thread_key))
-    THROWF(system_error, (int) GetLastError(),
-           "TlsFree() failed to cleanup the thread submodule");
-}
-
-int xbt_os_thread_atfork(void (*prepare)(void),
-                         void (*parent)(void), void (*child)(void))
-{
-  return 0;
-}
-
-static DWORD WINAPI wrapper_start_routine(void *s)
-{
-  xbt_os_thread_t t = (xbt_os_thread_t) s;
-  DWORD *rv;
-
-  if (!TlsSetValue(xbt_self_thread_key, t))
-    THROWF(system_error, (int) GetLastError(),
-           "TlsSetValue of data describing the created thread failed");
-
-  rv = (DWORD *) ((t->start_routine) (t->param));
-
-  return rv ? *rv : 0;
-
-}
-
-
-xbt_os_thread_t xbt_os_thread_create(const char *name,
-                                     pvoid_f_pvoid_t start_routine,
-                                     void *param,
-                                     void *extra_data)
-{
-
-  xbt_os_thread_t t = xbt_new(s_xbt_os_thread_t, 1);
-
-  t->name = xbt_strdup(name);
-  t->start_routine = start_routine;
-  t->param = param;
-  t->extra_data = extra_data;
-  t->handle = CreateThread(NULL, stack_size==0 ? XBT_DEFAULT_THREAD_STACK_SIZE : stack_size,
-                           (LPTHREAD_START_ROUTINE) wrapper_start_routine,
-                           t, STACK_SIZE_PARAM_IS_A_RESERVATION, &(t->id));
-
-  if (!t->handle) {
-    xbt_free(t);
-    THROWF(system_error, (int) GetLastError(), "CreateThread failed");
-  }
-
-  return t;
-}
-
-void xbt_os_thread_setstacksize(int size)
-{
-  stack_size = size;
-}
-
-void xbt_os_thread_setguardsize(int size)
-{
-  XBT_WARN("xbt_os_thread_setguardsize is not implemented (%d)", size);
-}
-
-const char *xbt_os_thread_name(xbt_os_thread_t t)
-{
-  return t->name;
-}
-
-const char *xbt_os_thread_self_name(void)
-{
-  xbt_os_thread_t t = xbt_os_thread_self();
-  return t ? t->name : "main";
-}
-
-void xbt_os_thread_join(xbt_os_thread_t thread, void **thread_return)
-{
-
-  if (WAIT_OBJECT_0 != WaitForSingleObject(thread->handle, INFINITE))
-    THROWF(system_error, (int) GetLastError(),
-           "WaitForSingleObject failed");
-
-  if (thread_return) {
-
-    if (!GetExitCodeThread(thread->handle, (DWORD *) (*thread_return)))
-      THROWF(system_error, (int) GetLastError(),
-             "GetExitCodeThread failed");
-  }
-
-  CloseHandle(thread->handle);
-
-  free(thread->name);
-
-  free(thread);
-}
-
-void xbt_os_thread_exit(int *retval)
-{
-  if (retval)
-    ExitThread(*retval);
-  else
-    ExitThread(0);
-}
-
-void xbt_os_thread_key_create(xbt_os_thread_key_t* key) {
-
-  *key = TlsAlloc();
-}
-
-void xbt_os_thread_set_specific(xbt_os_thread_key_t key, void* value) {
-
-  if (!TlsSetValue(key, value))
-    THROWF(system_error, (int) GetLastError(), "TlsSetValue() failed");
-}
-
-void* xbt_os_thread_get_specific(xbt_os_thread_key_t key) {
-  return TlsGetValue(key);
-}
-
-void xbt_os_thread_detach(xbt_os_thread_t thread)
-{
-  THROW_UNIMPLEMENTED;
-}
-
-
-xbt_os_thread_t xbt_os_thread_self(void)
-{
-  return TlsGetValue(xbt_self_thread_key);
-}
-
-void *xbt_os_thread_getparam(void)
-{
-  xbt_os_thread_t t = xbt_os_thread_self();
-  return t->param;
-}
-
-
-void xbt_os_thread_yield(void)
-{
-  Sleep(0);
-}
-
-void xbt_os_thread_cancel(xbt_os_thread_t t)
-{
-  if (!TerminateThread(t->handle, 0))
-    THROWF(system_error, (int) GetLastError(), "TerminateThread failed");
-}
-
-/****** mutex related functions ******/
-typedef struct xbt_os_mutex_ {
-  /* KEEP IT IN SYNC WITH xbt_thread.c */
-  CRITICAL_SECTION lock;
-} s_xbt_os_mutex_t;
-
-xbt_os_mutex_t xbt_os_mutex_init(void)
-{
-  xbt_os_mutex_t res = xbt_new(s_xbt_os_mutex_t, 1);
-
-  /* initialize the critical section object */
-  InitializeCriticalSection(&(res->lock));
-
-  return res;
-}
-
-void xbt_os_mutex_acquire(xbt_os_mutex_t mutex)
-{
-  EnterCriticalSection(&mutex->lock);
-}
-
-void xbt_os_mutex_timedacquire(xbt_os_mutex_t mutex, double delay)
-{
-  THROW_UNIMPLEMENTED;
-}
-
-void xbt_os_mutex_release(xbt_os_mutex_t mutex)
-{
-
-  LeaveCriticalSection(&mutex->lock);
-
-}
-
-void xbt_os_mutex_destroy(xbt_os_mutex_t mutex)
-{
-
-  if (!mutex)
-    return;
-
-  DeleteCriticalSection(&mutex->lock);
-  free(mutex);
-}
-
-/***** condition related functions *****/
-enum {                          /* KEEP IT IN SYNC WITH xbt_thread.c */
-  SIGNAL = 0,
-  BROADCAST = 1,
-  MAX_EVENTS = 2
-};
-
-typedef struct xbt_os_cond_ {
-  /* KEEP IT IN SYNC WITH xbt_thread.c */
-  HANDLE events[MAX_EVENTS];
-
-  unsigned int waiters_count;   /* the number of waiters                        */
-  CRITICAL_SECTION waiters_count_lock;  /* protect access to waiters_count  */
-} s_xbt_os_cond_t;
-
-xbt_os_cond_t xbt_os_cond_init(void)
-{
-
-  xbt_os_cond_t res = xbt_new0(s_xbt_os_cond_t, 1);
-
-  memset(&res->waiters_count_lock, 0, sizeof(CRITICAL_SECTION));
-
-  /* initialize the critical section object */
-  InitializeCriticalSection(&res->waiters_count_lock);
-
-  res->waiters_count = 0;
-
-  /* Create an auto-reset event */
-  res->events[SIGNAL] = CreateEvent(NULL, FALSE, FALSE, NULL);
-
-  if (!res->events[SIGNAL]) {
-    DeleteCriticalSection(&res->waiters_count_lock);
-    free(res);
-    THROWF(system_error, 0, "CreateEvent failed for the signals");
-  }
-
-  /* Create a manual-reset event. */
-  res->events[BROADCAST] = CreateEvent(NULL, TRUE, FALSE, NULL);
-
-  if (!res->events[BROADCAST]) {
-
-    DeleteCriticalSection(&res->waiters_count_lock);
-    CloseHandle(res->events[SIGNAL]);
-    free(res);
-    THROWF(system_error, 0, "CreateEvent failed for the broadcasts");
-  }
-
-  return res;
-}
-
-void xbt_os_cond_wait(xbt_os_cond_t cond, xbt_os_mutex_t mutex)
-{
-
-  unsigned long wait_result;
-  int is_last_waiter;
-
-  /* lock the threads counter and increment it */
-  EnterCriticalSection(&cond->waiters_count_lock);
-  cond->waiters_count++;
-  LeaveCriticalSection(&cond->waiters_count_lock);
-
-  /* unlock the mutex associate with the condition */
-  LeaveCriticalSection(&mutex->lock);
-
-  /* wait for a signal (broadcast or no) */
-  wait_result = WaitForMultipleObjects(2, cond->events, FALSE, INFINITE);
-
-  if (wait_result == WAIT_FAILED)
-    THROWF(system_error, 0,
-           "WaitForMultipleObjects failed, so we cannot wait on the condition");
-
-  /* we have a signal lock the condition */
-  EnterCriticalSection(&cond->waiters_count_lock);
-  cond->waiters_count--;
-
-  /* it's the last waiter or it's a broadcast ? */
-  is_last_waiter = ((wait_result == WAIT_OBJECT_0 + BROADCAST - 1)
-                    && (cond->waiters_count == 0));
-
-  LeaveCriticalSection(&cond->waiters_count_lock);
-
-  /* yes it's the last waiter or it's a broadcast
-   * only reset the manual event (the automatic event is reset in the WaitForMultipleObjects() function
-   * by the system.
-   */
-  if (is_last_waiter)
-    if (!ResetEvent(cond->events[BROADCAST]))
-      THROWF(system_error, 0, "ResetEvent failed");
-
-  /* relock the mutex associated with the condition in accordance with the posix thread specification */
-  EnterCriticalSection(&mutex->lock);
-}
-
-void xbt_os_cond_timedwait(xbt_os_cond_t cond, xbt_os_mutex_t mutex,
-                           double delay)
-{
-
-  unsigned long wait_result = WAIT_TIMEOUT;
-  int is_last_waiter;
-  unsigned long end = (unsigned long) (delay * 1000);
-
-
-  if (delay < 0) {
-    xbt_os_cond_wait(cond, mutex);
-  } else {
-    XBT_DEBUG("xbt_cond_timedwait(%p,%p,%lu)", &(cond->events),
-           &(mutex->lock), end);
-
-    /* lock the threads counter and increment it */
-    EnterCriticalSection(&cond->waiters_count_lock);
-    cond->waiters_count++;
-    LeaveCriticalSection(&cond->waiters_count_lock);
-
-    /* unlock the mutex associate with the condition */
-    LeaveCriticalSection(&mutex->lock);
-    /* wait for a signal (broadcast or no) */
-
-    wait_result = WaitForMultipleObjects(2, cond->events, FALSE, end);
-
-    switch (wait_result) {
-    case WAIT_TIMEOUT:
-      THROWF(timeout_error, GetLastError(),
-             "condition %p (mutex %p) wasn't signaled before timeout (%f)",
-             cond, mutex, delay);
-    case WAIT_FAILED:
-      THROWF(system_error, GetLastError(),
-             "WaitForMultipleObjects failed, so we cannot wait on the condition");
-    }
-
-    /* we have a signal lock the condition */
-    EnterCriticalSection(&cond->waiters_count_lock);
-    cond->waiters_count--;
-
-    /* it's the last waiter or it's a broadcast ? */
-    is_last_waiter = ((wait_result == WAIT_OBJECT_0 + BROADCAST - 1)
-                      && (cond->waiters_count == 0));
-
-    LeaveCriticalSection(&cond->waiters_count_lock);
-
-    /* yes it's the last waiter or it's a broadcast
-     * only reset the manual event (the automatic event is reset in the WaitForMultipleObjects() function
-     * by the system.
-     */
-    if (is_last_waiter)
-      if (!ResetEvent(cond->events[BROADCAST]))
-        THROWF(system_error, 0, "ResetEvent failed");
-
-    /* relock the mutex associated with the condition in accordance with the posix thread specification */
-    EnterCriticalSection(&mutex->lock);
-  }
-  /*THROW_UNIMPLEMENTED; */
-}
-
-void xbt_os_cond_signal(xbt_os_cond_t cond)
-{
-  int have_waiters;
-
-  EnterCriticalSection(&cond->waiters_count_lock);
-  have_waiters = cond->waiters_count > 0;
-  LeaveCriticalSection(&cond->waiters_count_lock);
-
-  if (have_waiters)
-    if (!SetEvent(cond->events[SIGNAL]))
-      THROWF(system_error, 0, "SetEvent failed");
-
-  xbt_os_thread_yield();
-}
-
-void xbt_os_cond_broadcast(xbt_os_cond_t cond)
-{
-  int have_waiters;
-
-  EnterCriticalSection(&cond->waiters_count_lock);
-  have_waiters = cond->waiters_count > 0;
-  LeaveCriticalSection(&cond->waiters_count_lock);
-
-  if (have_waiters)
-    SetEvent(cond->events[BROADCAST]);
-}
-
-void xbt_os_cond_destroy(xbt_os_cond_t cond)
-{
-  int error = 0;
-
-  if (!cond)
-    return;
-
-  if (!CloseHandle(cond->events[SIGNAL]))
-    error = 1;
-
-  if (!CloseHandle(cond->events[BROADCAST]))
-    error = 1;
-
-  DeleteCriticalSection(&cond->waiters_count_lock);
-
-  xbt_free(cond);
-
-  if (error)
-    THROWF(system_error, 0, "Error while destroying the condition");
-}
-
-typedef struct xbt_os_sem_ {
-  HANDLE h;
-  unsigned int value;
-  CRITICAL_SECTION value_lock;  /* protect access to value of the semaphore  */
-} s_xbt_os_sem_t;
-
-#ifndef INT_MAX
-# define INT_MAX 32767          /* let's be safe by underestimating this value: this is for 16bits only */
-#endif
-
-xbt_os_sem_t xbt_os_sem_init(unsigned int value)
-{
-  xbt_os_sem_t res;
-
-  if (value > INT_MAX)
-    THROWF(arg_error, value,
-           "Semaphore initial value too big: %ud cannot be stored as a signed int",
-           value);
-
-  res = (xbt_os_sem_t) xbt_new0(s_xbt_os_sem_t, 1);
-
-  if (!(res->h = CreateSemaphore(NULL, value, (long) INT_MAX, NULL))) {
-    THROWF(system_error, GetLastError(), "CreateSemaphore() failed: %s",
-           strerror(GetLastError()));
-    return NULL;
-  }
-
-  res->value = value;
-
-  InitializeCriticalSection(&(res->value_lock));
-
-  return res;
-}
-
-void xbt_os_sem_acquire(xbt_os_sem_t sem)
-{
-  if (!sem)
-    THROWF(arg_error, EINVAL, "Cannot acquire the NULL semaphore");
-
-  /* wait failure */
-  if (WAIT_OBJECT_0 != WaitForSingleObject(sem->h, INFINITE))
-    THROWF(system_error, GetLastError(),
-           "WaitForSingleObject() failed: %s", strerror(GetLastError()));
-  EnterCriticalSection(&(sem->value_lock));
-  sem->value--;
-  LeaveCriticalSection(&(sem->value_lock));
-}
-
-void xbt_os_sem_timedacquire(xbt_os_sem_t sem, double timeout)
-{
-  long seconds;
-  long milliseconds;
-  double end = timeout + xbt_os_time();
-
-  if (!sem)
-    THROWF(arg_error, EINVAL, "Cannot acquire the NULL semaphore");
-
-  if (timeout < 0) {
-    xbt_os_sem_acquire(sem);
-  } else {                      /* timeout can be zero <-> try acquire ) */
-
-
-    seconds = (long) floor(end);
-    milliseconds = (long) ((end - seconds) * 1000);
-    milliseconds += (seconds * 1000);
-
-    switch (WaitForSingleObject(sem->h, milliseconds)) {
-    case WAIT_OBJECT_0:
-      EnterCriticalSection(&(sem->value_lock));
-      sem->value--;
-      LeaveCriticalSection(&(sem->value_lock));
-      return;
-
-    case WAIT_TIMEOUT:
-      THROWF(timeout_error, GetLastError(),
-             "semaphore %p wasn't signaled before timeout (%f)", sem,
-             timeout);
-      return;
-
-    default:
-      THROWF(system_error, GetLastError(),
-             "WaitForSingleObject(%p,%f) failed: %s", sem, timeout,
-             strerror(GetLastError()));
-    }
-  }
-}
-
-void xbt_os_sem_release(xbt_os_sem_t sem)
-{
-  if (!sem)
-    THROWF(arg_error, EINVAL, "Cannot release the NULL semaphore");
-
-  if (!ReleaseSemaphore(sem->h, 1, NULL))
-    THROWF(system_error, GetLastError(), "ReleaseSemaphore() failed: %s",
-           strerror(GetLastError()));
-  EnterCriticalSection(&(sem->value_lock));
-  sem->value++;
-  LeaveCriticalSection(&(sem->value_lock));
-}
-
-void xbt_os_sem_destroy(xbt_os_sem_t sem)
-{
-  if (!sem)
-    THROWF(arg_error, EINVAL, "Cannot destroy the NULL semaphore");
-
-  if (!CloseHandle(sem->h))
-    THROWF(system_error, GetLastError(), "CloseHandle() failed: %s",
-           strerror(GetLastError()));
-
-  DeleteCriticalSection(&(sem->value_lock));
-
-  xbt_free(sem);
-
-}
-
-void xbt_os_sem_get_value(xbt_os_sem_t sem, int *svalue)
-{
-  if (!sem)
-    THROWF(arg_error, EINVAL,
-           "Cannot get the value of the NULL semaphore");
-
-  EnterCriticalSection(&(sem->value_lock));
-  *svalue = sem->value;
-  LeaveCriticalSection(&(sem->value_lock));
-}
-
-
-#endif
-
 
 /** @brief Returns the amount of cores on the current host */
 int xbt_os_get_numcores(void) {
@@ -1256,7 +704,7 @@ int xbt_os_get_numcores(void) {
     SYSTEM_INFO sysinfo;
     GetSystemInfo(&sysinfo);
     return sysinfo.dwNumberOfProcessors;
-#elif MACOS
+#elif defined(__APPLE__) && defined(__MACH__)
     int nm[2];
     size_t len = 4;
     uint32_t count;
@@ -1290,8 +738,11 @@ void xbt_os_thread_set_extra_data(void *data)
 
 void *xbt_os_thread_get_extra_data(void)
 {
-  xbt_os_thread_t self = xbt_os_thread_self();
-  return self? self->extra_data : NULL;
+  xbt_os_thread_t thread = xbt_os_thread_self();
+  if (thread)
+    return xbt_os_thread_self()->extra_data;
+  else
+    return NULL;
 }
 
 xbt_os_rmutex_t xbt_os_rmutex_init(void)