try to bind worker threads to cores when possible

[simgrid.git] / include / xbt / xbt_os_thread.h

diff --git a/include/xbt/xbt_os_thread.h b/include/xbt/xbt_os_thread.h
index 3c336cb..3d95429 100644 (file)
--- a/include/xbt/xbt_os_thread.h
+++ b/include/xbt/xbt_os_thread.h
@@ -17,45 +17,37 @@ SG_BEGIN_DECL()
 /** @addtogroup XBT_thread
  *  @brief Thread portability layer
  * 
 /** @addtogroup XBT_thread
  *  @brief Thread portability layer
  * 

- *  This section describes the thread portability layer. It defines types and 
- *  functions very close to the pthread API, but it's portable to windows too.
+ *  This section describes the thread portability layer. It defines types and functions very close to the pthread API,
+ *  but it's portable to windows too.

  * 
  *  @{
  */
   /** \brief Thread data type (opaque structure) */
 typedef struct xbt_os_thread_ *xbt_os_thread_t;
 
  * 
  *  @{
  */
   /** \brief Thread data type (opaque structure) */
 typedef struct xbt_os_thread_ *xbt_os_thread_t;
 

-

 #ifdef _XBT_WIN32 /* defined if this is a windows system, 32bits or 64bits) */
 #include <windows.h>
 #ifdef _XBT_WIN32 /* defined if this is a windows system, 32bits or 64bits) */
 #include <windows.h>

-typedef DWORD xbt_os_thread_key_t;
-#else /* assume that every non-windows system is POSIX-compatible */
+#endif

 
 #include <pthread.h>
 typedef pthread_key_t xbt_os_thread_key_t;
 
 #include <pthread.h>
 typedef pthread_key_t xbt_os_thread_key_t;

-#endif
-

 /** Calls pthread_atfork() if present, and raise an exception otherwise.
  *
  * The only known user of this wrapper is mmalloc_preinit(), but it is absolutely mandatory there:
  * when used with tesh, mmalloc *must* be mutex protected and resistant to forks.
  * This functionality is the only way to get it working (by ensuring that the mutex is consistently released on forks)
  */
 /** Calls pthread_atfork() if present, and raise an exception otherwise.
  *
  * The only known user of this wrapper is mmalloc_preinit(), but it is absolutely mandatory there:
  * when used with tesh, mmalloc *must* be mutex protected and resistant to forks.
  * This functionality is the only way to get it working (by ensuring that the mutex is consistently released on forks)
  */

-XBT_PUBLIC(int) xbt_os_thread_atfork(void (*prepare)(void),
-                                     void (*parent)(void),
-                                     void (*child)(void));
+XBT_PUBLIC(int) xbt_os_thread_atfork(void (*prepare)(void), void (*parent)(void), void (*child)(void));

 
 XBT_PUBLIC(int) xbt_os_get_numcores(void);
 
 
 XBT_PUBLIC(int) xbt_os_get_numcores(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(xbt_os_thread_t) xbt_os_thread_create(const char *name, pvoid_f_pvoid_t start_routine, void *param, void *data);

 
 

-//#define CORE_BINDING  //Uncomment this to enable binding of threads to physical cores. Only Linux.
-#ifdef CORE_BINDING
-XBT_PUBLIC(int) xbt_os_thread_bind(xbt_os_thread_t thread, int cpu);
-#endif
+/** Bind the thread to the given core, if possible.
+ *
+ * If pthread_setaffinity_np is not usable on that (non-gnu) platform, this function does nothing.
+ */
+XBT_PUBLIC(int) xbt_os_thread_bind(xbt_os_thread_t thread, int core);

 
 XBT_PUBLIC(void) xbt_os_thread_exit(int *retcode);
 XBT_PUBLIC(void) xbt_os_thread_detach(xbt_os_thread_t thread);
 
 XBT_PUBLIC(void) xbt_os_thread_exit(int *retcode);
 XBT_PUBLIC(void) xbt_os_thread_detach(xbt_os_thread_t thread);


@@ -68,11 +60,9 @@ 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_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_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_yield(void);
 XBT_PUBLIC(void) xbt_os_thread_cancel(xbt_os_thread_t thread);

-XBT_PUBLIC(void *) xbt_os_thread_getparam(void);

 XBT_PUBLIC(void) xbt_os_thread_setstacksize(int stack_size);
 XBT_PUBLIC(void) xbt_os_thread_setguardsize(int guard_size);
 
 XBT_PUBLIC(void) xbt_os_thread_setstacksize(int stack_size);
 XBT_PUBLIC(void) xbt_os_thread_setguardsize(int guard_size);
 


@@ -81,8 +71,7 @@ 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(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_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(void) xbt_os_mutex_release(xbt_os_mutex_t mutex);
 XBT_PUBLIC(void) xbt_os_mutex_destroy(xbt_os_mutex_t mutex);
 


@@ -94,20 +83,17 @@ 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);
 
 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) */
+/** \brief Thread condition data type (opaque structure) */

 typedef struct xbt_os_cond_ *xbt_os_cond_t;
 
 XBT_PUBLIC(xbt_os_cond_t) xbt_os_cond_init(void);
 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_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);
 
 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) */
+/** \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);
 typedef struct xbt_os_sem_ *xbt_os_sem_t;
 
 XBT_PUBLIC(xbt_os_sem_t) xbt_os_sem_init(unsigned int value);


@@ -117,7 +103,6 @@ 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(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);
 

-

 /** @} */
 
 SG_END_DECL()
 /** @} */
 
 SG_END_DECL()