Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
643eba31e2793c0071cb96321056c1b62260d34e
[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 XBT_PUBLIC(xbt_os_thread_t) xbt_os_thread_create(const char *name,
30                                                  pvoid_f_pvoid_t
31                                                  start_routine,
32                                                  void *param);
33 XBT_PUBLIC(void) xbt_os_thread_exit(int *retcode);
34 XBT_PUBLIC(xbt_os_thread_t) xbt_os_thread_self(void);
35 XBT_PUBLIC(const char *) xbt_os_thread_self_name(void);
36 XBT_PUBLIC(const char *) xbt_os_thread_name(xbt_os_thread_t);
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,
39                                     void **thread_return);
40 XBT_PUBLIC(void) xbt_os_thread_yield(void);
41 XBT_PUBLIC(void) xbt_os_thread_cancel(xbt_os_thread_t thread);
42 XBT_PUBLIC(void *) xbt_os_thread_getparam(void);
43
44
45   /** \brief Thread mutex data type (opaque structure) */
46 typedef struct xbt_os_mutex_ *xbt_os_mutex_t;
47
48 XBT_PUBLIC(xbt_os_mutex_t) xbt_os_mutex_init(void);
49 XBT_PUBLIC(void) xbt_os_mutex_acquire(xbt_os_mutex_t mutex);
50 XBT_PUBLIC(void) xbt_os_mutex_timedacquire(xbt_os_mutex_t mutex,
51                                            double delay);
52 XBT_PUBLIC(void) xbt_os_mutex_release(xbt_os_mutex_t mutex);
53 XBT_PUBLIC(void) xbt_os_mutex_destroy(xbt_os_mutex_t mutex);
54
55
56   /** \brief Thread condition data type (opaque structure) */
57 typedef struct xbt_os_cond_ *xbt_os_cond_t;
58
59 XBT_PUBLIC(xbt_os_cond_t) xbt_os_cond_init(void);
60 XBT_PUBLIC(void) xbt_os_cond_wait(xbt_os_cond_t cond,
61                                   xbt_os_mutex_t mutex);
62 XBT_PUBLIC(void) xbt_os_cond_timedwait(xbt_os_cond_t cond,
63                                        xbt_os_mutex_t mutex, double delay);
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);
67
68    /** \brief Semaphore data type (opaque structure) */
69 typedef struct xbt_os_sem_ *xbt_os_sem_t;
70
71 XBT_PUBLIC(xbt_os_sem_t) xbt_os_sem_init(unsigned int value);
72 XBT_PUBLIC(void) xbt_os_sem_acquire(xbt_os_sem_t sem);
73 XBT_PUBLIC(void) xbt_os_sem_timedacquire(xbt_os_sem_t sem, double timeout);
74 XBT_PUBLIC(void) xbt_os_sem_release(xbt_os_sem_t sem);
75 XBT_PUBLIC(void) xbt_os_sem_destroy(xbt_os_sem_t sem);
76 XBT_PUBLIC(void) xbt_os_sem_get_value(xbt_os_sem_t sem, int *svalue);
77
78
79 /** @} */
80
81 SG_END_DECL()
82 #endif                          /* _XBT_OS_THREAD_H */