001:
002:
003:
004:
005:
006:
007:
008:
009:
010:
011:
012:
013:
014:
015:
016:
017:
018:
019:
020:
021:
022:
023:
024:
025:
026:
027:
028:
029:
030:
031:
032:
033:
034:
035:
036:
037:
038:
039:
040:
041:
042:
043:
044:
045:
046:
047:
048:
049:
050:
051:
052:
053:
054:
055:
056:
057:
058:
059:
060:
061:
062:
063:
064:
065:
066:
067:
068:
069:
070:
071:
072:
073:
074:
075:
076:
077:
078:
079:
080:
081:
082:
083:
084:
085:
086:
087:
088:
089:
090:
091:
092:
093:
094:
095:
096:
097:
098:
099:
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:
216:
217:
218:
219:
220:
221:
222:
223:
224:
225:
226:
227:
228:
229:
230:
231:
232:
233:
234:
235:
236:
237:
238:
239:
240:
241:
242:
243:
244:
245:
246:
247:
248:
249:
250:
251:
252:
253:
254:
255:
256:
257:
258:
259:
260:
261:
262:
263:
264:
265:
266:
267:
268:
269:
270:
271:
272:
273:
274:
275:
276:
277:
278:
279:
280:
281:
282:
283:
284:
285:
286:
287:
288:
289:
290:
291:
292:
293:
294:
295:
296:
297:
298:
299:
300:
301:
302:
303:
304:
305:
306:
307:
308:
309:
310:
311:
312:
313:
314:
315:
316:
317:
318:
319:
320:
321:
322:
323:
324:
325:
326:
327:
328:
329:
330:
331:
/*
* Copyright (c), Zeriph Enterprises
* All rights reserved.
*
* Contributor(s):
* Zechariah Perez, omni (at) zeriph (dot) com
*
* THIS SOFTWARE IS PROVIDED BY ZERIPH AND CONTRIBUTORS "AS IS" AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL ZERIPH AND CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include <omni/sync/conditional.hpp>
#include <omni/sync/scoped_lock.hpp>
#include <omni/system.hpp> // OMNI_GLE_PRNT
#include <omni/exception.hpp>
#include <omni/sync/this_thread.hpp>
omni::sync::conditional::conditional() :
OMNI_CTOR_FW(omni::sync::conditional)
m_signal(),
m_wait(),
m_waitreq(0),
m_signaled(0)
{
this->_init();
}
omni::sync::conditional::conditional(bool initially_signaled) :
OMNI_CTOR_FW(omni::sync::conditional)
m_signal(),
m_wait(),
m_waitreq(0),
m_signaled(0)
{
this->_init();
if (initially_signaled) { this->signal(); }
}
omni::sync::conditional::~conditional() OMNI_DTOR_THROWS
{
OMNI_TRY_FW
OMNI_DTOR_FW
omni::sync::mutex_lock(this->m_wait);
bool await = this->m_waitreq > 0;
omni::sync::mutex_unlock(this->m_wait);
if (await) {
OMNI_ERR_FW("the conditional has active waits on call to dispose", omni::exceptions::active_wait_exception())
}
#if defined(OMNI_OS_WIN)
#if defined(OMNI_WIN_USE_EVENT_CONDITIONAL)
::CloseHandle(this->m_signal);
this->m_signal = 0;
#endif
#else
int ret = ::pthread_cond_destroy(&this->m_signal);
if (ret != 0) {
OMNI_ERRV_FW("An error occurred destroying the conditional: ", ret, omni::exceptions::conditional_exception(ret))
}
#endif
omni::sync::mutex_destroy(this->m_wait);
OMNI_CATCH_FW
}
void omni::sync::conditional::broadcast()
{
#if defined(OMNI_OS_WIN)
#if defined(OMNI_WIN_USE_EVENT_CONDITIONAL)
omni::sync::mutex_lock(this->m_wait);
uint32_t wreq = this->m_waitreq+1;
this->m_signaled = 1;
while (--wreq > 0) {
if (::SetEvent(this->m_signal) == 0) {
omni::sync::mutex_unlock(this->m_wait);
OMNI_ERRV_RET_FW("An error occurred on the conditional: ", OMNI_GLE, omni::exceptions::conditional_exception(OMNI_GLE))
}
omni::sync::mutex_unlock(this->m_wait);
omni::sync::yield_thread();
omni::sync::mutex_lock(this->m_wait);
}
omni::sync::mutex_unlock(this->m_wait);
#else
omni::sync::mutex_lock(this->m_wait);
this->m_signaled = 1;
::WakeAllConditionVariable(&this->m_signal);
omni::sync::mutex_unlock(this->m_wait);
#endif
#else
omni::sync::mutex_lock(this->m_wait);
this->m_signaled = 1;
int ret = ::pthread_cond_broadcast(&this->m_signal);
omni::sync::mutex_unlock(this->m_wait);
if (ret != 0) {
OMNI_ERRV_FW("An error occurred on the conditional: ", ret, omni::exceptions::conditional_exception(ret))
}
#endif
}
void omni::sync::conditional::reset()
{
omni::sync::mutex_lock(this->m_wait);
this->m_signaled = 0;
#if defined(OMNI_WIN_USE_EVENT_CONDITIONAL)
::ResetEvent(this->m_signal);
#endif
omni::sync::mutex_unlock(this->m_wait);
}
void omni::sync::conditional::signal()
{
#if defined(OMNI_OS_WIN)
#if defined(OMNI_WIN_USE_EVENT_CONDITIONAL)
omni::sync::mutex_lock(this->m_wait);
this->m_signaled = 1;
if (::SetEvent(this->m_signal) == 0) {
omni::sync::mutex_unlock(this->m_wait);
OMNI_ERRV_RET_FW("An error occurred on the conditional: ", OMNI_GLE, omni::exceptions::conditional_exception(OMNI_GLE))
}
omni::sync::mutex_unlock(this->m_wait);
#else
omni::sync::mutex_lock(this->m_wait);
this->m_signaled = 1;
::WakeConditionVariable(&this->m_signal);
omni::sync::mutex_unlock(this->m_wait);
#endif
#else
omni::sync::mutex_lock(this->m_wait);
this->m_signaled = 1;
int ret = ::pthread_cond_signal(&this->m_signal);
omni::sync::mutex_unlock(this->m_wait);
if (ret != 0) {
OMNI_ERRV_FW("An error occurred on the conditional: ", ret, omni::exceptions::conditional_exception(ret))
}
#endif
}
bool omni::sync::conditional::wait()
{
omni::sync::mutex_lock(this->m_wait);
if (this->m_signaled == 1) {
omni::sync::mutex_unlock(this->m_wait);
return false;
}
++this->m_waitreq;
omni::sync::mutex_unlock(this->m_wait);
#if defined(OMNI_OS_WIN)
#if defined(OMNI_WIN_USE_EVENT_CONDITIONAL)
switch (::WaitForSingleObject(this->m_signal, INFINITE)) {
case WAIT_OBJECT_0: { // 0x00000000L
omni::sync::mutex_lock(this->m_wait);
if (this->m_signaled == 1) { --this->m_waitreq; }
omni::sync::mutex_unlock(this->m_wait);
return true;
} break;
#if defined(OMNI_DBG_L3)
case WAIT_FAILED: OMNI_DV3_FW("a system error occurred on the conditional object: ", OMNI_GLE_PRNT); break;
OMNI_DSW_FW(WAIT_ABANDONED); // 0x00000080L
OMNI_DSW_FW(WAIT_TIMEOUT); // 0x00000102L
#endif
default: break;
}
#else
DWORD ret = 0;
while (!this->signaled()) {
omni::sync::scoped_lock<omni::sync::mutex_t> mlock(&this->m_wait);
if (!::SleepConditionVariableCS(&this->m_signal, &this->m_wait, INFINITE)) {
#if defined(OMNI_DBG_L3)
OMNI_DV3_FW("a system error occurred on the conditional object: ", OMNI_GLE);
#endif
}
// spurious wake up?
if (this->m_signaled == 0) { continue; }
--this->m_waitreq;
return true;
}
#endif
#else
int ret = 0;
while (!this->signaled()) {
omni::sync::scoped_lock<omni::sync::mutex_t> mlock(&this->m_wait);
ret = ::pthread_cond_wait(&this->m_signal, &this->m_wait);
if (ret == 0) {
// spurious wake up?
if (this->m_signaled == 0) { continue; }
--this->m_waitreq;
return true;
}
#if defined(OMNI_DBG_L3)
else { OMNI_DV3_FW("a system error occurred on the conditional object: ", ret); }
#endif
}
#endif
omni::sync::mutex_lock(this->m_wait);
--this->m_waitreq;
omni::sync::mutex_unlock(this->m_wait);
return false;
}
bool omni::sync::conditional::wait(uint32_t timeout_ms)
{
omni::sync::mutex_lock(this->m_wait);
if (this->m_signaled == 1) {
omni::sync::mutex_unlock(this->m_wait);
return false;
}
++this->m_waitreq;
omni::sync::mutex_unlock(this->m_wait);
#if defined(OMNI_OS_WIN)
#if defined(OMNI_WIN_USE_EVENT_CONDITIONAL)
switch (::WaitForSingleObject(this->m_signal, timeout_ms)) {
case WAIT_OBJECT_0: { // 0x00000000L
omni::sync::mutex_lock(this->m_wait);
if (this->m_signaled == 1) { --this->m_waitreq; }
omni::sync::mutex_unlock(this->m_wait);
return true;
} break;
#if defined(OMNI_DBG_L3)
case WAIT_FAILED: OMNI_DBGEV("a system error occurred on the conditional object: ", OMNI_GLE_PRNT); break;
OMNI_DSW_FW(WAIT_ABANDONED); // 0x00000080L
OMNI_DSW_FW(WAIT_TIMEOUT); // 0x00000102L
#endif
default: break;
}
#else
DWORD ret = 0;
while (!this->signaled()) {
omni::sync::scoped_lock<omni::sync::mutex_t> mlock(&this->m_wait);
if (!::SleepConditionVariableCS(&this->m_signal, &this->m_wait, timeout_ms)) {
ret = OMNI_GLE;
if (ret == ERROR_TIMEOUT) { // time out while waiting
--this->m_waitreq;
return false;
}
#if defined(OMNI_DBG_L3)
else { OMNI_DV3_FW("a system error occurred on the conditional object: ", ret); }
#endif
}
// spurious wake up?
if (this->m_signaled == 0) { continue; }
--this->m_waitreq;
return true;
}
#endif
#else
int ret = 0;
struct timespec tm;
#if defined(OMNI_OS_APPLE)
struct timeval atv;
if (::gettimeofday(&atv, NULL) != 0) {
OMNI_ERRV_RETV_FW("An error occurred getting the clock time: ", errno, omni::exceptions::clock_exception(errno), false)
}
tm.tv_sec = atv.tv_sec;
tm.tv_nsec = atv.tv_usec * 1000;
#else
if (::clock_gettime(CLOCK_REALTIME, &tm) != 0) {
OMNI_ERRV_RETV_FW("An error occurred getting the clock time: ", errno, omni::exceptions::clock_exception(errno), false)
}
#endif
if (timeout_ms > 0) {
if (timeout_ms >= 1000) { tm.tv_sec += (timeout_ms / 1000); }
tm.tv_nsec += ((timeout_ms % 1000) * 1000);
}
while (!this->signaled()) {
omni::sync::scoped_lock<omni::sync::mutex_t> mlock(&this->m_wait);
ret = ::pthread_cond_timedwait(&this->m_signal, &this->m_wait, &tm);
if (ret == 0) {
// spurious wake up?
if (this->m_signaled == 0) { continue; }
--this->m_waitreq;
return true;
} else if (ret == ETIMEDOUT) { // time out while waiting
--this->m_waitreq;
return false;
}
#if defined(OMNI_DBG_L3)
else { OMNI_DV3_FW("a system error occurred on the conditional object: ", ret); }
#endif
}
#endif
omni::sync::mutex_lock(this->m_wait);
--this->m_waitreq;
omni::sync::mutex_unlock(this->m_wait);
return false;
}
bool omni::sync::conditional::operator==(const omni::sync::conditional& o)
{
if (this == &o) { return true; }
omni::sync::scoped_lock<omni::sync::mutex_t> mlock(&this->m_wait);
omni::sync::scoped_lock<omni::sync::mutex_t> mlock2(&o.m_wait);
return (this->m_signaled == o.m_signaled &&
&this->m_signal == &o.m_signal &&
this->m_waitreq == o.m_waitreq)
OMNI_EQUAL_FW(o);
}
bool omni::sync::conditional::operator!=(const omni::sync::conditional& o)
{
return !(*this == o);
}
///////// start private methods /////////
void omni::sync::conditional::_init()
{
omni::sync::mutex_init(this->m_wait);
#if defined(OMNI_OS_WIN)
#if defined(OMNI_WIN_USE_EVENT_CONDITIONAL)
// NULL security attributes, auto-reset event, initially non-signalled, no name
this->m_signal = ::CreateEvent(NULL, FALSE, FALSE, NULL);
// auto-reset == FALSE gives the same functionality as a pthread_cond_t
if (this->m_signal == NULL) {
OMNI_ERRV_FW("The event could not be created: ", OMNI_GLE, omni::exceptions::conditional_exception(OMNI_GLE))
}
#else
::InitializeConditionVariable(&this->m_signal);
#endif
#else
int ret = ::pthread_cond_init(&this->m_signal, NULL);
if (ret != 0) {
OMNI_ERRV_FW("The event could not be created: ", ret, omni::exceptions::conditional_exception(ret))
}
#endif
}