This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
SDL_syscond.c
1
2
/*
SDL - Simple DirectMedia Layer
3
Copyright (C) 1997-2006 Sam Lantinga
4
5
This library is free software; you can redistribute it and/or
6
modify it under the terms of the GNU Lesser General Public
7
License as published by the Free Software Foundation; either
8
version 2.1 of the License, or (at your option) any later version.
9
10
11
12
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13
Lesser General Public License for more details.
15
16
17
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
19
20
21
Sam Lantinga
slouken@libsdl.org
*/
22
#include "SDL_config.h"
23
24
25
26
27
28
29
30
31
32
33
/* An implementation of condition variables using semaphores and mutexes */
/*
This implementation borrows heavily from the BeOS condition variable
implementation, written by Christopher Tate and Owen Smith. Thanks!
*/
#include "SDL_thread.h"
struct SDL_cond
{
34
35
36
37
38
SDL_mutex *lock;
int waiting;
int signals;
SDL_sem *wait_sem;
SDL_sem *wait_done;
39
40
41
};
/* Create a condition variable */
42
DECLSPEC SDL_cond *SDLCALL
43
SDL_CreateCond(void)
44
{
45
46
SDL_cond *cond;
47
cond = (SDL_cond *) SDL_malloc(sizeof(SDL_cond));
49
50
51
cond->lock = SDL_CreateMutex();
cond->wait_sem = SDL_CreateSemaphore(0);
cond->wait_done = SDL_CreateSemaphore(0);
52
53
cond->waiting = cond->signals = 0;
if (!cond->lock || !cond->wait_sem || !cond->wait_done) {
54
SDL_DestroyCond(cond);
55
56
57
cond = NULL;
}
} else {
58
SDL_OutOfMemory();
59
60
}
return (cond);
61
62
63
}
/* Destroy a condition variable */
64
DECLSPEC void SDLCALL
65
SDL_DestroyCond(SDL_cond * cond)
66
{
67
68
if (cond) {
if (cond->wait_sem) {
69
SDL_DestroySemaphore(cond->wait_sem);
70
71
}
if (cond->wait_done) {
72
SDL_DestroySemaphore(cond->wait_done);
73
74
}
if (cond->lock) {
75
SDL_DestroyMutex(cond->lock);
77
SDL_free(cond);
79
80
81
}
/* Restart one of the threads that are waiting on the condition variable */
82
DECLSPEC int SDLCALL
83
SDL_CondSignal(SDL_cond * cond)
84
{
86
SDL_SetError("Passed a NULL condition variable");
87
88
89
90
91
92
return -1;
}
/* If there are waiting threads not already signalled, then
signal the condition and wait for the thread to respond.
*/
93
SDL_LockMutex(cond->lock);
94
95
if (cond->waiting > cond->signals) {
++cond->signals;
96
97
98
SDL_SemPost(cond->wait_sem);
SDL_UnlockMutex(cond->lock);
SDL_SemWait(cond->wait_done);
100
SDL_UnlockMutex(cond->lock);
101
102
103
}
return 0;
104
105
106
}
/* Restart all threads that are waiting on the condition variable */
107
DECLSPEC int SDLCALL
108
SDL_CondBroadcast(SDL_cond * cond)
109
{
111
SDL_SetError("Passed a NULL condition variable");
112
113
114
115
116
117
return -1;
}
/* If there are waiting threads not already signalled, then
signal the condition and wait for the thread to respond.
*/
118
SDL_LockMutex(cond->lock);
119
120
121
122
123
124
if (cond->waiting > cond->signals) {
int i, num_waiting;
num_waiting = (cond->waiting - cond->signals);
cond->signals = cond->waiting;
for (i = 0; i < num_waiting; ++i) {
125
SDL_SemPost(cond->wait_sem);
126
127
128
129
}
/* Now all released threads are blocked here, waiting for us.
Collect them all (and win fabulous prizes!) :-)
*/
130
SDL_UnlockMutex(cond->lock);
131
for (i = 0; i < num_waiting; ++i) {
132
SDL_SemWait(cond->wait_done);
135
SDL_UnlockMutex(cond->lock);
136
137
138
}
return 0;
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
}
/* Wait on the condition variable for at most 'ms' milliseconds.
The mutex must be locked before entering this function!
The mutex is unlocked during the wait, and locked again after the wait.
Typical use:
Thread A:
SDL_LockMutex(lock);
while ( ! condition ) {
SDL_CondWait(cond);
}
SDL_UnlockMutex(lock);
Thread B:
SDL_LockMutex(lock);
...
condition = true;
...
SDL_UnlockMutex(lock);
*/
161
DECLSPEC int SDLCALL
162
SDL_CondWaitTimeout(SDL_cond * cond, SDL_mutex * mutex, Uint32 ms)
163
{
164
165
166
int retval;
if (!cond) {
167
SDL_SetError("Passed a NULL condition variable");
168
169
170
171
172
173
174
return -1;
}
/* Obtain the protection mutex, and increment the number of waiters.
This allows the signal mechanism to only perform a signal if there
are waiting threads.
*/
175
SDL_LockMutex(cond->lock);
176
++cond->waiting;
177
SDL_UnlockMutex(cond->lock);
178
179
/* Unlock the mutex, as is required by condition variable semantics */
180
SDL_UnlockMutex(mutex);
181
182
183
/* Wait for a signal */
if (ms == SDL_MUTEX_MAXWAIT) {
184
retval = SDL_SemWait(cond->wait_sem);
186
retval = SDL_SemWaitTimeout(cond->wait_sem, ms);
187
188
189
190
191
192
193
194
}
/* Let the signaler know we have completed the wait, otherwise
the signaler can race ahead and get the condition semaphore
if we are stopped between the mutex unlock and semaphore wait,
giving a deadlock. See the following URL for details:
http://www-classic.be.com/aboutbe/benewsletter/volume_III/Issue40.html
*/
195
SDL_LockMutex(cond->lock);
196
197
198
if (cond->signals > 0) {
/* If we timed out, we need to eat a condition signal */
if (retval > 0) {
199
SDL_SemWait(cond->wait_sem);
200
201
}
/* We always notify the signal thread that we are done */
202
SDL_SemPost(cond->wait_done);
203
204
205
206
207
/* Signal handshake complete */
--cond->signals;
}
--cond->waiting;
208
SDL_UnlockMutex(cond->lock);
209
210
/* Lock the mutex, as is required by condition variable semantics */
211
SDL_LockMutex(mutex);
212
213
return retval;
214
215
216
}
/* Wait on the condition variable forever */
217
DECLSPEC int SDLCALL
218
SDL_CondWait(SDL_cond * cond, SDL_mutex * mutex)
219
{
220
return SDL_CondWaitTimeout(cond, mutex, SDL_MUTEX_MAXWAIT);
221
}
222
223
/* vi: set ts=4 sw=4 expandtab: */