Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
try to bind worker threads to cores when possible
[simgrid.git] / include / xbt / xbt_os_thread.h
1 /* xbt/xbt_os_thread.h -- Thread portability layer                          */
2
3 /* Copyright (c) 2007-2015. The SimGrid Team.
4  * All rights reserved.                                                     */
5
6 /* This program is free software; you can redistribute it and/or modify it
7  * under the terms of the license (GNU LGPL) which comes with this package. */
8
9 #ifndef _XBT_OS_THREAD_H
10 #define _XBT_OS_THREAD_H
11
12 #include "simgrid_config.h" /* Windows or Posix */
13 #include "xbt/function_types.h"
14
15 SG_BEGIN_DECL()
16
17 /** @addtogroup XBT_thread
18  *  @brief Thread portability layer
19  * 
20  *  This section describes the thread portability layer. It defines types and functions very close to the pthread API,
21  *  but it's portable to windows too.
22  * 
23  *  @{
24  */
25   /** \brief Thread data type (opaque structure) */
26 typedef struct xbt_os_thread_ *xbt_os_thread_t;
27
28 #ifdef _XBT_WIN32 /* defined if this is a windows system, 32bits or 64bits) */
29 #include <windows.h>
30 #endif
31
32 #include <pthread.h>
33 typedef pthread_key_t xbt_os_thread_key_t;
34 /** Calls pthread_atfork() if present, and raise an exception otherwise.
35  *
36  * The only known user of this wrapper is mmalloc_preinit(), but it is absolutely mandatory there:
37  * when used with tesh, mmalloc *must* be mutex protected and resistant to forks.
38  * This functionality is the only way to get it working (by ensuring that the mutex is consistently released on forks)
39  */
40 XBT_PUBLIC(int) xbt_os_thread_atfork(void (*prepare)(void), void (*parent)(void), void (*child)(void));
41
42 XBT_PUBLIC(int) xbt_os_get_numcores(void);
43
44 XBT_PUBLIC(xbt_os_thread_t) xbt_os_thread_create(const char *name, pvoid_f_pvoid_t start_routine, void *param, void *data);
45
46 /** Bind the thread to the given core, if possible.
47  *
48  * If pthread_setaffinity_np is not usable on that (non-gnu) platform, this function does nothing.
49  */
50 XBT_PUBLIC(int) xbt_os_thread_bind(xbt_os_thread_t thread, int core);
51
52 XBT_PUBLIC(void) xbt_os_thread_exit(int *retcode);
53 XBT_PUBLIC(void) xbt_os_thread_detach(xbt_os_thread_t thread);
54 XBT_PUBLIC(xbt_os_thread_t) xbt_os_thread_self(void);
55 XBT_PUBLIC(const char *) xbt_os_thread_self_name(void);
56 XBT_PUBLIC(const char *) xbt_os_thread_name(xbt_os_thread_t);
57 XBT_PUBLIC(void) xbt_os_thread_set_extra_data(void *data);
58 XBT_PUBLIC(void *) xbt_os_thread_get_extra_data(void);
59 XBT_PUBLIC(void) xbt_os_thread_key_create(xbt_os_thread_key_t* key);
60 XBT_PUBLIC(void) xbt_os_thread_set_specific(xbt_os_thread_key_t key, void* value);
61 XBT_PUBLIC(void*) xbt_os_thread_get_specific(xbt_os_thread_key_t key);
62   /* xbt_os_thread_join frees the joined thread (ie the XBT wrapper around it, the OS frees the rest) */
63 XBT_PUBLIC(void) xbt_os_thread_join(xbt_os_thread_t thread, void **thread_return);
64 XBT_PUBLIC(void) xbt_os_thread_yield(void);
65 XBT_PUBLIC(void) xbt_os_thread_cancel(xbt_os_thread_t thread);
66 XBT_PUBLIC(void) xbt_os_thread_setstacksize(int stack_size);
67 XBT_PUBLIC(void) xbt_os_thread_setguardsize(int guard_size);
68
69   /** \brief Thread mutex data type (opaque structure) */
70 typedef struct xbt_os_mutex_ *xbt_os_mutex_t;
71
72 XBT_PUBLIC(xbt_os_mutex_t) xbt_os_mutex_init(void);
73 XBT_PUBLIC(void) xbt_os_mutex_acquire(xbt_os_mutex_t mutex);
74 XBT_PUBLIC(void) xbt_os_mutex_timedacquire(xbt_os_mutex_t mutex, double delay);
75 XBT_PUBLIC(void) xbt_os_mutex_release(xbt_os_mutex_t mutex);
76 XBT_PUBLIC(void) xbt_os_mutex_destroy(xbt_os_mutex_t mutex);
77
78 /** \brief Thread reentrant mutex data type (opaque structure) */
79 typedef struct xbt_os_rmutex_ *xbt_os_rmutex_t;
80
81 XBT_PUBLIC(xbt_os_rmutex_t) xbt_os_rmutex_init(void);
82 XBT_PUBLIC(void) xbt_os_rmutex_acquire(xbt_os_rmutex_t rmutex);
83 XBT_PUBLIC(void) xbt_os_rmutex_release(xbt_os_rmutex_t rmutex);
84 XBT_PUBLIC(void) xbt_os_rmutex_destroy(xbt_os_rmutex_t rmutex);
85
86 /** \brief Thread condition data type (opaque structure) */
87 typedef struct xbt_os_cond_ *xbt_os_cond_t;
88
89 XBT_PUBLIC(xbt_os_cond_t) xbt_os_cond_init(void);
90 XBT_PUBLIC(void) xbt_os_cond_wait(xbt_os_cond_t cond, xbt_os_mutex_t mutex);
91 XBT_PUBLIC(void) xbt_os_cond_timedwait(xbt_os_cond_t cond, xbt_os_mutex_t mutex, double delay);
92 XBT_PUBLIC(void) xbt_os_cond_signal(xbt_os_cond_t cond);
93 XBT_PUBLIC(void) xbt_os_cond_broadcast(xbt_os_cond_t cond);
94 XBT_PUBLIC(void) xbt_os_cond_destroy(xbt_os_cond_t cond);
95
96 /** \brief Semaphore data type (opaque structure) */
97 typedef struct xbt_os_sem_ *xbt_os_sem_t;
98
99 XBT_PUBLIC(xbt_os_sem_t) xbt_os_sem_init(unsigned int value);
100 XBT_PUBLIC(void) xbt_os_sem_acquire(xbt_os_sem_t sem);
101 XBT_PUBLIC(void) xbt_os_sem_timedacquire(xbt_os_sem_t sem, double timeout);
102 XBT_PUBLIC(void) xbt_os_sem_release(xbt_os_sem_t sem);
103 XBT_PUBLIC(void) xbt_os_sem_destroy(xbt_os_sem_t sem);
104 XBT_PUBLIC(void) xbt_os_sem_get_value(xbt_os_sem_t sem, int *svalue);
105
106 /** @} */
107
108 SG_END_DECL()
109 #endif                          /* _XBT_OS_THREAD_H */