Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge pull request #302 from mpoquet/rename-s4u-synchro-examples
[simgrid.git] / include / xbt / xbt_os_thread.h
1 /* xbt/xbt_os_thread.h -- Thread portability layer                          */
2
3 /* Copyright (c) 2007-2018. The SimGrid Team. All rights reserved.          */
4
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. */
7
8 #ifndef XBT_OS_THREAD_H
9 #define XBT_OS_THREAD_H
10
11 #include <xbt/base.h>
12 #include <xbt/function_types.h>
13
14 #include <pthread.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 functions very close to the pthread API,
22  *  but it's portable to windows too.
23  *
24  *  @{
25  */
26
27 /** @brief Thread data type (opaque structure) */
28 typedef struct xbt_os_thread_ *xbt_os_thread_t;
29 XBT_PUBLIC xbt_os_thread_t xbt_os_thread_create(const char* name, pvoid_f_pvoid_t start_routine, void* param,
30                                                 void* data);
31 XBT_PUBLIC void xbt_os_thread_exit(int* retcode);
32
33 XBT_PUBLIC xbt_os_thread_t xbt_os_thread_self(void);
34 XBT_PUBLIC const char* xbt_os_thread_self_name(void);
35 XBT_PUBLIC void xbt_os_thread_set_extra_data(void* data);
36 XBT_PUBLIC void* xbt_os_thread_get_extra_data(void);
37 /* xbt_os_thread_join frees the joined thread (ie the XBT wrapper around it, the OS frees the rest) */
38 XBT_PUBLIC void xbt_os_thread_join(xbt_os_thread_t thread, void** thread_return);
39 XBT_PUBLIC void xbt_os_thread_setstacksize(int stack_size);
40 XBT_PUBLIC void xbt_os_thread_setguardsize(int guard_size);
41 XBT_PUBLIC int xbt_os_thread_bind(xbt_os_thread_t thread, int core);
42 XBT_PUBLIC int xbt_os_thread_atfork(void (*prepare)(void), void (*parent)(void), void (*child)(void));
43
44 /** @brief Thread mutex data type (opaque structure) */
45 typedef struct xbt_os_mutex_ *xbt_os_mutex_t;
46 XBT_PUBLIC xbt_os_mutex_t xbt_os_mutex_init(void);
47 XBT_PUBLIC void xbt_os_mutex_acquire(xbt_os_mutex_t mutex);
48 XBT_PUBLIC void xbt_os_mutex_release(xbt_os_mutex_t mutex);
49 XBT_PUBLIC void xbt_os_mutex_destroy(xbt_os_mutex_t mutex);
50
51 /** @brief Semaphore data type (opaque structure) */
52 typedef struct xbt_os_sem_ *xbt_os_sem_t;
53 XBT_PUBLIC xbt_os_sem_t xbt_os_sem_init(unsigned int value);
54 XBT_PUBLIC void xbt_os_sem_acquire(xbt_os_sem_t sem);
55 XBT_PUBLIC void xbt_os_sem_release(xbt_os_sem_t sem);
56 XBT_PUBLIC void xbt_os_sem_destroy(xbt_os_sem_t sem);
57
58 /** @} */
59
60 SG_END_DECL()
61 #endif /* XBT_OS_THREAD_H */