Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
xbt_swag: remove duplicated code.
[simgrid.git] / src / include / xbt / xbt_os_thread.h
index 0796566..61d4912 100644 (file)
@@ -1,8 +1,7 @@
-/* $Id$ */
-
 /* xbt/xbt_thread.h -- Thread portability layer                             */
 
-/* Copyright (c) 2007 Martin Quinson. All rights reserved.                  */
+/* Copyright (c) 2007, 2009, 2010. 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. */
@@ -11,7 +10,8 @@
 #ifndef _XBT_OS_THREAD_H
 #define _XBT_OS_THREAD_H
 
-#include "xbt/misc.h" /* SG_BEGIN_DECL */
+#include "gras_config.h"
+#include "xbt/misc.h"           /* SG_BEGIN_DECL */
 #include "xbt/function_types.h"
 
 SG_BEGIN_DECL()
@@ -24,39 +24,91 @@ SG_BEGIN_DECL()
  * 
  *  @{
  */
-
   /** \brief Thread data type (opaque structure) */
-  typedef struct xbt_os_thread_       *xbt_os_thread_t;
-
-  XBT_PUBLIC(xbt_os_thread_t) xbt_os_thread_create(pvoid_f_pvoid_t start_routine,void* param);
-  XBT_PUBLIC(void) xbt_os_thread_exit(int *retcode);
-  XBT_PUBLIC(xbt_os_thread_t) xbt_os_thread_self(void);
+typedef struct xbt_os_thread_ *xbt_os_thread_t;
+
+#ifdef HAVE_PTHREAD_H
+#include <pthread.h>
+typedef pthread_key_t xbt_os_thread_key_t;
+#elif defined(_XBT_WIN32)
+#include <WinDef.h>
+typedef DWORD xbt_os_thread_key_t;
+#endif
+
+/* Calls pthread_atfork() if present, and else does nothing.
+ * The only known user of this wrapper is mmalloc_preinit().
+ */
+XBT_PUBLIC(int) xbt_os_thread_atfork(void (*prepare)(void),
+                                     void (*parent)(void),
+                                     void (*child)(void));
+
+
+XBT_PUBLIC(xbt_os_thread_t) xbt_os_thread_create(const char *name,
+                                                 pvoid_f_pvoid_t start_routine,
+                                                 void *param,
+                                                 void *data);
+
+XBT_PUBLIC(void) xbt_os_thread_exit(int *retcode);
+XBT_PUBLIC(void) xbt_os_thread_detach(xbt_os_thread_t thread);
+XBT_PUBLIC(xbt_os_thread_t) xbt_os_thread_self(void);
+XBT_PUBLIC(const char *) xbt_os_thread_self_name(void);
+XBT_PUBLIC(const char *) xbt_os_thread_name(xbt_os_thread_t);
+XBT_PUBLIC(void) xbt_os_thread_set_extra_data(void *data);
+XBT_PUBLIC(void *) xbt_os_thread_get_extra_data(void);
+XBT_PUBLIC(void) xbt_os_thread_key_create(xbt_os_thread_key_t* key);
+XBT_PUBLIC(void) xbt_os_thread_set_specific(xbt_os_thread_key_t key, void* value);
+XBT_PUBLIC(void*) xbt_os_thread_get_specific(xbt_os_thread_key_t key);
   /* xbt_os_thread_join frees the joined thread (ie the XBT wrapper around it, the OS frees the rest) */
-  XBT_PUBLIC(void) xbt_os_thread_join(xbt_os_thread_t thread,void ** thread_return);
-  XBT_PUBLIC(void) xbt_os_thread_yield(void);
+XBT_PUBLIC(void) xbt_os_thread_join(xbt_os_thread_t thread,
+                                    void **thread_return);
+XBT_PUBLIC(void) xbt_os_thread_yield(void);
+XBT_PUBLIC(void) xbt_os_thread_cancel(xbt_os_thread_t thread);
+XBT_PUBLIC(void *) xbt_os_thread_getparam(void);
 
 
   /** \brief Thread mutex data type (opaque structure) */
-  typedef struct xbt_os_mutex_ *xbt_os_mutex_t;
+typedef struct xbt_os_mutex_ *xbt_os_mutex_t;
+
+XBT_PUBLIC(xbt_os_mutex_t) xbt_os_mutex_init(void);
+XBT_PUBLIC(void) xbt_os_mutex_acquire(xbt_os_mutex_t mutex);
+XBT_PUBLIC(void) xbt_os_mutex_timedacquire(xbt_os_mutex_t mutex,
+                                           double delay);
+XBT_PUBLIC(void) xbt_os_mutex_release(xbt_os_mutex_t mutex);
+XBT_PUBLIC(void) xbt_os_mutex_destroy(xbt_os_mutex_t mutex);
 
-  XBT_PUBLIC(xbt_os_mutex_t) xbt_os_mutex_init(void);
-  XBT_PUBLIC(void)           xbt_os_mutex_lock(xbt_os_mutex_t mutex);
-  XBT_PUBLIC(void)           xbt_os_mutex_unlock(xbt_os_mutex_t mutex);
-  XBT_PUBLIC(void)           xbt_os_mutex_destroy(xbt_os_mutex_t mutex);
+/** \brief Thread reentrant mutex data type (opaque structure) */
+typedef struct xbt_os_rmutex_ *xbt_os_rmutex_t;
+
+XBT_PUBLIC(xbt_os_rmutex_t) xbt_os_rmutex_init(void);
+XBT_PUBLIC(void) xbt_os_rmutex_acquire(xbt_os_rmutex_t rmutex);
+XBT_PUBLIC(void) xbt_os_rmutex_release(xbt_os_rmutex_t rmutex);
+XBT_PUBLIC(void) xbt_os_rmutex_destroy(xbt_os_rmutex_t rmutex);
 
 
   /** \brief Thread condition data type (opaque structure) */
-  typedef struct xbt_os_cond_  *xbt_os_cond_t;
+typedef struct xbt_os_cond_ *xbt_os_cond_t;
+
+XBT_PUBLIC(xbt_os_cond_t) xbt_os_cond_init(void);
+XBT_PUBLIC(void) xbt_os_cond_wait(xbt_os_cond_t cond,
+                                  xbt_os_mutex_t mutex);
+XBT_PUBLIC(void) xbt_os_cond_timedwait(xbt_os_cond_t cond,
+                                       xbt_os_mutex_t mutex, double delay);
+XBT_PUBLIC(void) xbt_os_cond_signal(xbt_os_cond_t cond);
+XBT_PUBLIC(void) xbt_os_cond_broadcast(xbt_os_cond_t cond);
+XBT_PUBLIC(void) xbt_os_cond_destroy(xbt_os_cond_t cond);
+
+   /** \brief Semaphore data type (opaque structure) */
+typedef struct xbt_os_sem_ *xbt_os_sem_t;
+
+XBT_PUBLIC(xbt_os_sem_t) xbt_os_sem_init(unsigned int value);
+XBT_PUBLIC(void) xbt_os_sem_acquire(xbt_os_sem_t sem);
+XBT_PUBLIC(void) xbt_os_sem_timedacquire(xbt_os_sem_t sem, double timeout);
+XBT_PUBLIC(void) xbt_os_sem_release(xbt_os_sem_t sem);
+XBT_PUBLIC(void) xbt_os_sem_destroy(xbt_os_sem_t sem);
+XBT_PUBLIC(void) xbt_os_sem_get_value(xbt_os_sem_t sem, int *svalue);
 
-  XBT_PUBLIC(xbt_os_cond_t) xbt_os_cond_init(void);
-  XBT_PUBLIC(void)          xbt_os_cond_wait(xbt_os_cond_t cond,
-                                            xbt_os_mutex_t mutex);
-  XBT_PUBLIC(void)          xbt_os_cond_signal(xbt_os_cond_t cond);
-  XBT_PUBLIC(void)          xbt_os_cond_broadcast(xbt_os_cond_t cond);
-  XBT_PUBLIC(void)          xbt_os_cond_destroy(xbt_os_cond_t cond);
 
 /** @} */
 
 SG_END_DECL()
-
-#endif /* _XBT_OS_THREAD_H */
+#endif                          /* _XBT_OS_THREAD_H */