Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add functions xbt_os_thread_key_create, xbt_os_thread_get/set_specific
[simgrid.git] / src / include / xbt / xbt_os_thread.h
1 /* xbt/xbt_thread.h -- Thread portability layer                             */
2
3 /* Copyright (c) 2007, 2009, 2010. 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
10 #ifndef _XBT_OS_THREAD_H
11 #define _XBT_OS_THREAD_H
12
13 #include "xbt/misc.h"           /* SG_BEGIN_DECL */
14 #include "xbt/function_types.h"
15
16 SG_BEGIN_DECL()
17
18 /** @addtogroup XBT_thread
19  *  @brief Thread portability layer
20  * 
21  *  This section describes the thread portability layer. It defines types and 
22  *  functions very close to the pthread API, but it's portable to windows too.
23  * 
24  *  @{
25  */
26   /** \brief Thread data type (opaque structure) */
27 typedef struct xbt_os_thread_ *xbt_os_thread_t;
28
29 typedef unsigned int xbt_os_thread_key_t;
30
31 /* Calls pthread_atfork() if present, and else does nothing.
32  * The only known user of this wrapper is mmalloc_preinit().
33  */
34 XBT_PUBLIC(int) xbt_os_thread_atfork(void (*prepare)(void),
35                                      void (*parent)(void),
36                                      void (*child)(void));
37
38
39 XBT_PUBLIC(xbt_os_thread_t) xbt_os_thread_create(const char *name,
40                                                  pvoid_f_pvoid_t start_routine,
41                                                  void *param,
42                                                  void *data);
43
44 XBT_PUBLIC(void) xbt_os_thread_exit(int *retcode);
45 XBT_PUBLIC(void) xbt_os_thread_detach(xbt_os_thread_t thread);
46 XBT_PUBLIC(xbt_os_thread_t) xbt_os_thread_self(void);
47 XBT_PUBLIC(const char *) xbt_os_thread_self_name(void);
48 XBT_PUBLIC(const char *) xbt_os_thread_name(xbt_os_thread_t);
49 XBT_PUBLIC(void) xbt_os_thread_set_extra_data(void *data);
50 XBT_PUBLIC(void *) xbt_os_thread_get_extra_data(void);
51 XBT_PUBLIC(void) xbt_os_thread_key_create(xbt_os_thread_key_t* key);
52 XBT_PUBLIC(void) xbt_os_thread_set_specific(xbt_os_thread_key_t key, void* value);
53 XBT_PUBLIC(void*) xbt_os_thread_get_specific(xbt_os_thread_key_t key);
54   /* xbt_os_thread_join frees the joined thread (ie the XBT wrapper around it, the OS frees the rest) */
55 XBT_PUBLIC(void) xbt_os_thread_join(xbt_os_thread_t thread,
56                                     void **thread_return);
57 XBT_PUBLIC(void) xbt_os_thread_yield(void);
58 XBT_PUBLIC(void) xbt_os_thread_cancel(xbt_os_thread_t thread);
59 XBT_PUBLIC(void *) xbt_os_thread_getparam(void);
60
61
62   /** \brief Thread mutex data type (opaque structure) */
63 typedef struct xbt_os_mutex_ *xbt_os_mutex_t;
64
65 XBT_PUBLIC(xbt_os_mutex_t) xbt_os_mutex_init(void);
66 XBT_PUBLIC(void) xbt_os_mutex_acquire(xbt_os_mutex_t mutex);
67 XBT_PUBLIC(void) xbt_os_mutex_timedacquire(xbt_os_mutex_t mutex,
68                                            double delay);
69 XBT_PUBLIC(void) xbt_os_mutex_release(xbt_os_mutex_t mutex);
70 XBT_PUBLIC(void) xbt_os_mutex_destroy(xbt_os_mutex_t mutex);
71
72 /** \brief Thread reentrant mutex data type (opaque structure) */
73 typedef struct xbt_os_rmutex_ *xbt_os_rmutex_t;
74
75 XBT_PUBLIC(xbt_os_rmutex_t) xbt_os_rmutex_init(void);
76 XBT_PUBLIC(void) xbt_os_rmutex_acquire(xbt_os_rmutex_t rmutex);
77 XBT_PUBLIC(void) xbt_os_rmutex_release(xbt_os_rmutex_t rmutex);
78 XBT_PUBLIC(void) xbt_os_rmutex_destroy(xbt_os_rmutex_t rmutex);
79
80
81   /** \brief Thread condition data type (opaque structure) */
82 typedef struct xbt_os_cond_ *xbt_os_cond_t;
83
84 XBT_PUBLIC(xbt_os_cond_t) xbt_os_cond_init(void);
85 XBT_PUBLIC(void) xbt_os_cond_wait(xbt_os_cond_t cond,
86                                   xbt_os_mutex_t mutex);
87 XBT_PUBLIC(void) xbt_os_cond_timedwait(xbt_os_cond_t cond,
88                                        xbt_os_mutex_t mutex, double delay);
89 XBT_PUBLIC(void) xbt_os_cond_signal(xbt_os_cond_t cond);
90 XBT_PUBLIC(void) xbt_os_cond_broadcast(xbt_os_cond_t cond);
91 XBT_PUBLIC(void) xbt_os_cond_destroy(xbt_os_cond_t cond);
92
93    /** \brief Semaphore data type (opaque structure) */
94 typedef struct xbt_os_sem_ *xbt_os_sem_t;
95
96 XBT_PUBLIC(xbt_os_sem_t) xbt_os_sem_init(unsigned int value);
97 XBT_PUBLIC(void) xbt_os_sem_acquire(xbt_os_sem_t sem);
98 XBT_PUBLIC(void) xbt_os_sem_timedacquire(xbt_os_sem_t sem, double timeout);
99 XBT_PUBLIC(void) xbt_os_sem_release(xbt_os_sem_t sem);
100 XBT_PUBLIC(void) xbt_os_sem_destroy(xbt_os_sem_t sem);
101 XBT_PUBLIC(void) xbt_os_sem_get_value(xbt_os_sem_t sem, int *svalue);
102
103
104 /** @} */
105
106 SG_END_DECL()
107 #endif                          /* _XBT_OS_THREAD_H */