1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
#pragma once
#include "defs.h"
#include "utils.h"
#include "Func.h"
S_BEGIN_DECLS
#include "config.h"
#if !__STDC_NO_ATOMICS__
#include <stdatomic.h>
#else
#include "external/stdatomic.h"
#endif
#if !__STDC_NO_THREADS__
#include <threads.h>
#else
#include "external/tinycthread.h"
#endif
/**
* @defgroup Threading Threading
* @addtogroup Threading
* @{
*/
/**
* Sleep for a set amount of micro seconds.
*/
S_EXPORTED
void
s_usleep (slong us);
/** @brief
* The status of the thread.
*
* These values are equivalent to the value defined my the threads.h. They are
* offten used as return values for different fuctions.
*/
typedef enum {
S_THREAD_STATUS_SUCCESS = thrd_success, /*< Succes*/
S_THREAD_STATUS_TIMEOUT = thrd_timedout, /*< Timedout*/
S_THREAD_STATUS_ERROR = thrd_error, /*< Error */
S_THREAD_STATUS_BUSY = thrd_busy, /*< Busy */
S_THREAD_STATUS_NO_MEM = thrd_nomem, /*< No memory*/
S_THREAD_STATUS_LAST /*< Not used */
} SThreadStatus;
/**
* @see SThreadStatus
*/
S_UNUSED static
schar * SThreadStatusName[] = {
"Succes",
"Timedout",
"Error",
"Busy",
"No Momory",
"INVALID",
0x0,
0x0
};
/** @brief
* Get the status name.
*
* For use in bindings.
*
* @see SThreadStatus
* @see SThreadStatusName
*/
S_EXPORTED
char *
s_thread_status_get_name (SThreadStatus status);
/**
* The flags used when creating threads.
* These map 1:1 to the C11 flags.
*/
typedef enum {
S_MUTEX_FLAG_PLAIN = mtx_plain, /**< Plain mutex */
S_MUTEX_FLAG_TIMED = mtx_timed, /**< Timed mutex */
S_MUTEX_FLAG_RECURSIVE = mtx_recursive, /**< Recursive mutex */
S_MUTEX_FLAG_LAST
} SMutexFlag;
/**
* @see SMutexFlag
*/
S_UNUSED static
schar * SMutexFlagName[] = {
"Plain",
"Timed",
"Recursive",
"INVALID",
0x0,
0x0
};
/** @brief
* Get the name of the mutex flag.
*
* For use in bindings.
*/
schar *
s_mutex_flag_get_name (SMutexFlag flag);
/* ****************************************************************************
********************************** SMutex ************************************
**************************************************************************** */
/**
* @defgroup SMutex SMutex
* @addtogroup SMutex
* @{
*/
/**
* An SMutex is an opaque data type that handles the platform specifics of the
* Mutex, if it exists. If not we roll our own.
*/
typedef struct SMutex SMutex;
/**
* Create a new SMutex;
*/
S_EXPORTED
SMutex *
s_mutex_new ();
/**
* Free the mutex.
*/
S_EXPORTED
void
s_mutex_free (SMutex * self);
/**
* Lock the mutex.
*
* Returns a key used to unlock the mutex.
*/
S_EXPORTED
SThreadStatus
s_mutex_lock (SMutex * self);
/**
* unlock the mutex.
*
* @param self The mutex to unlock;
* @param key The key used to unlock the mutex.
*/
S_EXPORTED
SThreadStatus
s_mutex_unlock (SMutex * self);
/**
* Check if a mutex is locked.
*
* Note that this operation is non-atomic and may be wrong.
*/
S_EXPORTED
SThreadStatus
s_mutex_check_lock (SMutex * self);
/** @} */
/* ****************************************************************************
********************************** SThread ***********************************
**************************************************************************** */
/**
* @defgroup SThread SThread
* @addtogroup SThread
* @{
*/
/**
* An opaque data type representing a Thread.
*/
typedef struct SThread SThread;
/**
* Creat a now Thread.
*/
S_EXPORTED
SThread *
s_thread_new (RunFunc func);
/**
* Free the thread object.
*/
S_EXPORTED
void
s_thread_free (SThread * self);
/**
* Run the thread.
*/
S_EXPORTED
sboolean
s_thread_run (SThread * self, spointer user_data);
/** @} */
/** @} */
S_END_DECLS
|