1 /* xbt/xbt_os_thread.h -- Thread portability layer */
3 /* Copyright (c) 2007-2018. The SimGrid Team. All rights reserved. */
5 /* This program is free software; you can redistribute it and/or modify it
6 * under the terms of the license (GNU LGPL) which comes with this package. */
8 #ifndef XBT_OS_THREAD_H
9 #define XBT_OS_THREAD_H
12 #include <xbt/function_types.h>
18 typedef pthread_key_t xbt_os_thread_key_t;
20 /** @addtogroup XBT_thread
21 * @brief Thread portability layer
23 * This section describes the thread portability layer. It defines types and functions very close to the pthread API,
24 * but it's portable to windows too.
29 XBT_PUBLIC int xbt_os_get_numcores(void);
31 /** \brief Thread data type (opaque structure) */
32 typedef struct xbt_os_thread_ *xbt_os_thread_t;
33 XBT_PUBLIC xbt_os_thread_t xbt_os_thread_create(const char* name, pvoid_f_pvoid_t start_routine, void* param,
35 XBT_PUBLIC void xbt_os_thread_exit(int* retcode);
37 XBT_PUBLIC xbt_os_thread_t xbt_os_thread_self(void);
38 XBT_PUBLIC const char* xbt_os_thread_self_name(void);
39 XBT_PUBLIC void xbt_os_thread_set_extra_data(void* data);
40 XBT_PUBLIC void* xbt_os_thread_get_extra_data(void);
41 XBT_PUBLIC void xbt_os_thread_key_create(xbt_os_thread_key_t* key);
42 XBT_PUBLIC void xbt_os_thread_key_destroy(xbt_os_thread_key_t key);
43 XBT_PUBLIC void xbt_os_thread_set_specific(xbt_os_thread_key_t key, void* value);
44 XBT_PUBLIC void* xbt_os_thread_get_specific(xbt_os_thread_key_t key);
45 /* xbt_os_thread_join frees the joined thread (ie the XBT wrapper around it, the OS frees the rest) */
46 XBT_PUBLIC void xbt_os_thread_join(xbt_os_thread_t thread, void** thread_return);
47 XBT_PUBLIC void xbt_os_thread_yield(void);
48 XBT_PUBLIC void xbt_os_thread_setstacksize(int stack_size);
49 XBT_PUBLIC void xbt_os_thread_setguardsize(int guard_size);
50 XBT_PUBLIC int xbt_os_thread_bind(xbt_os_thread_t thread, int core);
51 XBT_PUBLIC int xbt_os_thread_atfork(void (*prepare)(void), void (*parent)(void), void (*child)(void));
53 /** \brief Thread mutex data type (opaque structure) */
54 typedef struct xbt_os_mutex_ *xbt_os_mutex_t;
55 XBT_PUBLIC xbt_os_mutex_t xbt_os_mutex_init(void);
56 XBT_PUBLIC void xbt_os_mutex_acquire(xbt_os_mutex_t mutex);
57 XBT_PUBLIC void xbt_os_mutex_release(xbt_os_mutex_t mutex);
58 XBT_PUBLIC void xbt_os_mutex_destroy(xbt_os_mutex_t mutex);
60 /** \brief Thread condition data type (opaque structure) */
61 typedef struct xbt_os_cond_ *xbt_os_cond_t;
62 XBT_PUBLIC xbt_os_cond_t xbt_os_cond_init(void);
63 XBT_PUBLIC void xbt_os_cond_wait(xbt_os_cond_t cond, xbt_os_mutex_t mutex);
64 XBT_PUBLIC void xbt_os_cond_signal(xbt_os_cond_t cond);
65 XBT_PUBLIC void xbt_os_cond_broadcast(xbt_os_cond_t cond);
66 XBT_PUBLIC void xbt_os_cond_destroy(xbt_os_cond_t cond);
68 /** \brief Semaphore data type (opaque structure) */
69 typedef struct xbt_os_sem_ *xbt_os_sem_t;
70 XBT_PUBLIC xbt_os_sem_t xbt_os_sem_init(unsigned int value);
71 XBT_PUBLIC void xbt_os_sem_acquire(xbt_os_sem_t sem);
72 XBT_PUBLIC void xbt_os_sem_release(xbt_os_sem_t sem);
73 XBT_PUBLIC void xbt_os_sem_destroy(xbt_os_sem_t sem);
78 #endif /* XBT_OS_THREAD_H */