1 /* xbt/xbt_thread.h -- Thread portability layer */
3 /* Copyright (c) 2007, 2009, 2010. The SimGrid Team.
4 * All rights reserved. */
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. */
10 #ifndef _XBT_OS_THREAD_H
11 #define _XBT_OS_THREAD_H
13 #include "gras_config.h"
14 #include "xbt/misc.h" /* SG_BEGIN_DECL */
15 #include "xbt/function_types.h"
19 /** @addtogroup XBT_thread
20 * @brief Thread portability layer
22 * This section describes the thread portability layer. It defines types and
23 * functions very close to the pthread API, but it's portable to windows too.
27 /** \brief Thread data type (opaque structure) */
28 typedef struct xbt_os_thread_ *xbt_os_thread_t;
32 typedef pthread_key_t xbt_os_thread_key_t;
33 #elif defined(_XBT_WIN32)
35 typedef DWORD xbt_os_thread_key_t;
38 /* Calls pthread_atfork() if present, and else does nothing.
39 * The only known user of this wrapper is mmalloc_preinit().
41 XBT_PUBLIC(int) xbt_os_thread_atfork(void (*prepare)(void),
46 XBT_PUBLIC(xbt_os_thread_t) xbt_os_thread_create(const char *name,
47 pvoid_f_pvoid_t start_routine,
51 XBT_PUBLIC(void) xbt_os_thread_exit(int *retcode);
52 XBT_PUBLIC(void) xbt_os_thread_detach(xbt_os_thread_t thread);
53 XBT_PUBLIC(xbt_os_thread_t) xbt_os_thread_self(void);
54 XBT_PUBLIC(const char *) xbt_os_thread_self_name(void);
55 XBT_PUBLIC(const char *) xbt_os_thread_name(xbt_os_thread_t);
56 XBT_PUBLIC(void) xbt_os_thread_set_extra_data(void *data);
57 XBT_PUBLIC(void *) xbt_os_thread_get_extra_data(void);
58 XBT_PUBLIC(void) xbt_os_thread_key_create(xbt_os_thread_key_t* key);
59 XBT_PUBLIC(void) xbt_os_thread_set_specific(xbt_os_thread_key_t key, void* value);
60 XBT_PUBLIC(void*) xbt_os_thread_get_specific(xbt_os_thread_key_t key);
61 /* xbt_os_thread_join frees the joined thread (ie the XBT wrapper around it, the OS frees the rest) */
62 XBT_PUBLIC(void) xbt_os_thread_join(xbt_os_thread_t thread,
63 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_getparam(void);
69 /** \brief Thread mutex data type (opaque structure) */
70 typedef struct xbt_os_mutex_ *xbt_os_mutex_t;
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,
76 XBT_PUBLIC(void) xbt_os_mutex_release(xbt_os_mutex_t mutex);
77 XBT_PUBLIC(void) xbt_os_mutex_destroy(xbt_os_mutex_t mutex);
79 /** \brief Thread reentrant mutex data type (opaque structure) */
80 typedef struct xbt_os_rmutex_ *xbt_os_rmutex_t;
82 XBT_PUBLIC(xbt_os_rmutex_t) xbt_os_rmutex_init(void);
83 XBT_PUBLIC(void) xbt_os_rmutex_acquire(xbt_os_rmutex_t rmutex);
84 XBT_PUBLIC(void) xbt_os_rmutex_release(xbt_os_rmutex_t rmutex);
85 XBT_PUBLIC(void) xbt_os_rmutex_destroy(xbt_os_rmutex_t rmutex);
88 /** \brief Thread condition data type (opaque structure) */
89 typedef struct xbt_os_cond_ *xbt_os_cond_t;
91 XBT_PUBLIC(xbt_os_cond_t) xbt_os_cond_init(void);
92 XBT_PUBLIC(void) xbt_os_cond_wait(xbt_os_cond_t cond,
93 xbt_os_mutex_t mutex);
94 XBT_PUBLIC(void) xbt_os_cond_timedwait(xbt_os_cond_t cond,
95 xbt_os_mutex_t mutex, double delay);
96 XBT_PUBLIC(void) xbt_os_cond_signal(xbt_os_cond_t cond);
97 XBT_PUBLIC(void) xbt_os_cond_broadcast(xbt_os_cond_t cond);
98 XBT_PUBLIC(void) xbt_os_cond_destroy(xbt_os_cond_t cond);
100 /** \brief Semaphore data type (opaque structure) */
101 typedef struct xbt_os_sem_ *xbt_os_sem_t;
103 XBT_PUBLIC(xbt_os_sem_t) xbt_os_sem_init(unsigned int value);
104 XBT_PUBLIC(void) xbt_os_sem_acquire(xbt_os_sem_t sem);
105 XBT_PUBLIC(void) xbt_os_sem_timedacquire(xbt_os_sem_t sem, double timeout);
106 XBT_PUBLIC(void) xbt_os_sem_release(xbt_os_sem_t sem);
107 XBT_PUBLIC(void) xbt_os_sem_destroy(xbt_os_sem_t sem);
108 XBT_PUBLIC(void) xbt_os_sem_get_value(xbt_os_sem_t sem, int *svalue);
114 #endif /* _XBT_OS_THREAD_H */