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:
332:
333:
334:
335:
336:
337:
338:
339:
340:
341:
342:
343:
344:
345:
346:
347:
348:
349:
350:
351:
352:
353:
354:
355:
356:
357:
358:
359:
360:
361:
362:
363:
364:
365:
366:
367:
368:
369:
370:
371:
372:
373:
374:
375:
376:
377:
378:
379:
380:
381:
382:
383:
384:
385:
386:
387:
388:
389:
390:
391:
392:
393:
394:
395:
396:
397:
398:
399:
400:
401:
402:
403:
404:
405:
406:
407:
408:
409:
410:
411:
412:
413:
414:
415:
416:
417:
418:
419:
/*
* 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.
*/
#if !defined(OMNI_SPIN_HPP)
#define OMNI_SPIN_HPP 1
#include <omni/defs/global.hpp>
// DEV_NOTE: no asm in spin_lock, while 'fast', it introduces other issues on non x86 platforms, asm spin will be in another rev
#include <omni/sync/auto_lock.hpp>
#include <omni/sync/scoped_lock.hpp>
#include <omni/sync/this_thread.hpp>
/* DEV_NOTE: pthread_spin_lock, pthread_spin_unlock, pthread_spin_trylock on some platforms
are not within a global namespace i.e. ::pthread_spin_lock(&lock) will give the error
"expected id-expression before '('", while pthread_spin_lock(&lock) resolves and works */
namespace omni {
namespace sync {
class spin_lock
{
public:
spin_lock() :
OMNI_CTOR_FW(omni::sync::spin_lock)
m_lock(), m_lokd(false)
{
this->_init();
}
explicit spin_lock(bool initialy_owned) :
OMNI_CTOR_FW(omni::sync::spin_lock)
m_lock(), m_lokd(false)
{
this->_init();
if (initialy_owned) { this->lock(); }
}
~spin_lock()
{
OMNI_DTOR_FW
if (this->m_lokd) { this->unlock(); }
#if defined(OMNI_OS_WIN) || defined(OMNI_OS_APPLE)
this->m_lock = 0;
#else
int err = ::pthread_spin_destroy(&this->m_lock);
if (err != 0) {
OMNI_ERRV_FW("An error occurred destroying the spin lock: ", err, omni::exceptions::spin_lock_exception(err))
}
#endif
}
inline bool locked() const
{
return this->m_lokd;
}
void lock()
{
#if defined(OMNI_OS_WIN)
// don't call omni::yield directly, just use the WinAPI
while (::InterlockedExchange(&this->m_lock, 1 ) == 1) { OMNI_THREAD_YIELD(); }
#elif defined(OMNI_OS_APPLE)
#if defined(OMNI_OS_MACOS)
::os_unfair_lock_lock(this->m_lock);
#else
::OSSpinLockLock(&this->m_lock);
#endif
#else
int err = pthread_spin_lock(&this->m_lock);
if (err != 0) {
OMNI_ERRV_FW("An error occurred on the spin lock: ", err, omni::exceptions::spin_lock_exception(err))
}
#endif
this->m_lokd = true;
}
void unlock()
{
#if defined(OMNI_OS_WIN)
::InterlockedExchange(&this->m_lock, 0);
#elif defined(OMNI_OS_APPLE)
#if defined(OMNI_OS_MACOS)
::os_unfair_lock_unlock(this->m_lock);
#else
::OSSpinLockUnlock(&this->m_lock);
#endif
#else
pthread_spin_unlock(&this->m_lock);
#endif
this->m_lokd = false;
}
bool trylock()
{
#if defined(OMNI_OS_WIN)
this->m_lokd = (::InterlockedExchange(&this->m_lock, 1) == 0);
#elif defined(OMNI_OS_APPLE)
#if defined(OMNI_OS_MACOS)
this->m_lokd = ::os_unfair_lock_trylock(this->m_lock);
#else
this->m_lokd = ::OSSpinLockTry(&this->m_lock);
#endif
#else
this->m_lokd = (pthread_spin_trylock(&this->m_lock) == 0);
#endif
return this->m_lokd;
}
bool operator==(const omni::sync::spin_lock& o)
{
if (this == &o) { return true; }
return (this->m_lokd == o.m_lokd &&
&this->m_lock == &o.m_lock)
OMNI_EQUAL_FW(o);
}
bool operator!=(const omni::sync::spin_lock& o)
{
return !(*this == o);
}
OMNI_MEMBERS_FW(omni::sync::spin_lock) // disposing,name,type(),hash()
private:
// defined but not implemented, doesn't make sense to copy
spin_lock(const omni::sync::spin_lock &cp);
omni::sync::spin_lock& operator=(const omni::sync::spin_lock& other);
inline void _init()
{
#if defined(OMNI_OS_WIN) || defined(OMNI_OS_APPLE)
this->m_lock = 0;
#else
int err = ::pthread_spin_init(&this->m_lock, PTHREAD_PROCESS_PRIVATE);
if (err != 0) {
OMNI_ERRV_FW("An error occurred initializing the spin lock: ", err, omni::exceptions::spin_lock_exception(err))
}
#endif
}
omni::sync::spin_lock_t m_lock;
volatile mutable bool m_lokd;
};
class spin_wait
{
public:
spin_wait() :
OMNI_CTOR_FW(omni::sync::spin_wait)
m_sig(false) { }
explicit spin_wait(bool initsig) :
OMNI_CTOR_FW(omni::sync::spin_wait)
m_sig(initsig) { }
~spin_wait()
{
OMNI_DTOR_FW
this->signal();
}
inline void reset()
{
this->m_sig = false;
}
void reset(unsigned long sleep_ms)
{
OMNI_SLEEP_INIT();
this->m_sig = true;
OMNI_SLEEP(sleep_ms);
this->m_sig = false;
}
inline bool signaled() const
{
return this->m_sig;
}
inline void signal()
{
this->m_sig = true;
}
inline void busy_wait() const
{
while (!this->m_sig) {
OMNI_THREAD_YIELD();
}
}
bool busy_wait(unsigned long timeout_ms) const
{
omni::chrono::monotonic::initialize();
omni::chrono::tick_t start = omni::chrono::monotonic_tick();
while (!this->m_sig && (omni::chrono::elapsed_ms(start) <= timeout_ms)) {
OMNI_THREAD_YIELD();
}
// if !this->m_sig, then the timeout failed
return this->m_sig;
}
inline void sleep_wait() const
{
OMNI_SLEEP_INIT();
while (!this->m_sig) {
OMNI_SLEEP1();
}
}
bool sleep_wait(unsigned long timeout_ms) const
{
OMNI_SLEEP_INIT();
#if !defined(OMNI_CHRONO_AUTO_INIT_TICK)
omni::chrono::monotonic::initialize();
#endif
omni::chrono::tick_t start = omni::chrono::monotonic_tick();
while (!this->m_sig && (omni::chrono::elapsed_ms(start) <= timeout_ms)) {
OMNI_SLEEP1();
}
// if !this->m_sig, then the timeout failed
return this->m_sig;
}
bool operator==(const omni::sync::spin_wait &o) const
{
if (this == &o) { return true; }
return (this->m_sig == o.m_sig)
OMNI_EQUAL_FW(o);
}
bool operator!=(const omni::sync::spin_wait &o) const
{
return !(*this == o);
}
OMNI_MEMBERS_FW(omni::sync::spin_wait) // disposing,name,type(),hash()
private:
// defined but not implemented. shouldn't be copied
spin_wait(const omni::sync::spin_wait &cp); // C++1X delete
omni::sync::spin_wait& operator=(const omni::sync::spin_wait &other); // C++1X delete
volatile mutable bool m_sig;
};
class safe_spin_wait
{
public:
safe_spin_wait() :
OMNI_CTOR_FW(omni::sync::safe_spin_wait)
m_mtx(), m_sig(false)
{
omni::sync::mutex_init(this->m_mtx);
}
explicit safe_spin_wait(bool initsig) :
OMNI_CTOR_FW(omni::sync::safe_spin_wait)
m_mtx(), m_sig(initsig)
{
omni::sync::mutex_init(this->m_mtx);
}
~safe_spin_wait()
{
OMNI_DTOR_FW
this->signal();
omni::sync::mutex_destroy(this->m_mtx);
}
void reset()
{
omni::sync::mutex_lock(this->m_mtx);
this->m_sig = false;
omni::sync::mutex_unlock(this->m_mtx);
}
void reset(unsigned long sleep_ms)
{
OMNI_SLEEP_INIT();
omni::sync::mutex_lock(this->m_mtx);
this->m_sig = true;
omni::sync::mutex_unlock(this->m_mtx);
OMNI_SLEEP(sleep_ms);
omni::sync::mutex_lock(this->m_mtx);
this->m_sig = false;
omni::sync::mutex_unlock(this->m_mtx);
}
bool signaled() const
{
omni::sync::scoped_lock<omni::sync::mutex_t> alock(&this->m_mtx);
return this->m_sig;
}
void signal()
{
omni::sync::mutex_lock(this->m_mtx);
this->m_sig = true;
omni::sync::mutex_unlock(this->m_mtx);
}
void busy_wait() const
{
for(;;) {
omni::sync::mutex_lock(this->m_mtx);
if (this->m_sig) {
omni::sync::mutex_unlock(this->m_mtx);
return;
}
omni::sync::mutex_unlock(this->m_mtx);
OMNI_THREAD_YIELD();
}
}
bool busy_wait(unsigned long timeout_ms) const
{
omni::chrono::tick_t start = omni::chrono::monotonic_tick();
while (omni::chrono::elapsed_ms(start) <= timeout_ms) {
omni::sync::mutex_lock(this->m_mtx);
if (this->m_sig) {
omni::sync::mutex_unlock(this->m_mtx);
return true;
}
omni::sync::mutex_unlock(this->m_mtx);
OMNI_THREAD_YIELD();
}
// if !this->m_sig, then the timeout failed
omni::sync::mutex_lock(this->m_mtx);
if (this->m_sig) {
omni::sync::mutex_unlock(this->m_mtx);
return true;
}
omni::sync::mutex_unlock(this->m_mtx);
return false;
}
void sleep_wait() const
{
OMNI_SLEEP_INIT();
for(;;) {
omni::sync::mutex_lock(this->m_mtx);
if (this->m_sig) {
omni::sync::mutex_unlock(this->m_mtx);
return;
}
omni::sync::mutex_unlock(this->m_mtx);
OMNI_SLEEP1();
}
}
bool sleep_wait(unsigned long timeout_ms) const
{
OMNI_SLEEP_INIT();
omni::chrono::tick_t start = omni::chrono::monotonic_tick();
while (omni::chrono::elapsed_ms(start) <= timeout_ms) {
omni::sync::mutex_lock(this->m_mtx);
if (this->m_sig) {
omni::sync::mutex_unlock(this->m_mtx);
return true;
}
omni::sync::mutex_unlock(this->m_mtx);
OMNI_SLEEP1();
}
// if !this->m_sig, then the timeout failed
omni::sync::mutex_lock(this->m_mtx);
if (this->m_sig) {
omni::sync::mutex_unlock(this->m_mtx);
return true;
}
omni::sync::mutex_unlock(this->m_mtx);
return false;
}
bool operator==(const omni::sync::safe_spin_wait &o) const
{
if (this == &o) { return true; }
omni::sync::scoped_lock<omni::sync::mutex_t> alock(&this->m_mtx);
omni::sync::scoped_lock<omni::sync::mutex_t> alock2(&o.m_mtx);
return (this->m_sig == o.m_sig)
OMNI_EQUAL_FW(o);
}
bool operator!=(const omni::sync::safe_spin_wait &o) const
{
return !(*this == o);
}
OMNI_MEMBERS_FW(omni::sync::safe_spin_wait) // disposing,name,type(),hash()
private:
// defined but not implemented. shouldn't be copied
safe_spin_wait(const omni::sync::safe_spin_wait &cp); // C++1X delete
omni::sync::safe_spin_wait& operator=(const omni::sync::safe_spin_wait &other); // C++1X delete
mutable omni::sync::mutex_t m_mtx;
volatile mutable bool m_sig;
};
typedef omni::sync::auto_lock<omni::sync::spin_lock> auto_spin_lock;
typedef omni::sync::scoped_lock<omni::sync::spin_lock> scoped_spin_lock;
}
}
#endif // OMNI_SPIN_HPP