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:
/*
* This file is part of the Omni C++ framework
*
* Copyright (c) 2016, Zeriph Enterprises, LLC
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* - Neither the name of Zeriph, Zeriph Enterprises, LLC, nor the names
* of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* 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/mutex.hpp>
// DEV_NOTE: reason for the #def calls for mutex lock/unlock/etc. is to avoid extra function calls to omni::sync::mutex_init/lock/etc.
// which are just function wrappers for the #def values
#if defined(OMNI_MUTEX_OWNER)
#define OMNI_MOLIST_FW , m_owner()
#if defined(OMNI_OS_WIN)
#define OMNI_MOCALL_FW ::GetCurrentThreadId()
#else
#define OMNI_MOCALL_FW ::pthread_self()
#endif
#if defined(OMNI_THROW)
#define OMNI_MOERR_FW throw omni::mutex_owning_thread_exception();
#else
#if defined(OMNI_TERMINATE)
#define OMNI_MOERR_FW OMNI_TERMINATE
#else
#define OMNI_MOERR_FW
#endif
#endif
#define OMNI_MOCHK_FW if (this->m_owner != OMNI_MOCALL_FW) { OMNI_MOERR_FW }
#define OMNI_MOGET_FW this->m_owner = OMNI_MOCALL_FW;
#else
#define OMNI_MOLIST_FW
#define OMNI_MOCHK_FW
#define OMNI_MOGET_FW
#endif
#if defined OMNI_SAFE_MUTEX
#define OMNI_SAFE_XMTX_FW , m_imtx()
#define OMNI_SAFE_XALOCK_FW omni::sync::scoped_lock<omni::sync::mutex_t> amtimtx(&this->m_imtx);
#define OMNI_SAFE_XINIT_FW omni::sync::mutex_init(this->m_imtx);
#define OMNI_SAFE_XLOCK_FW omni::sync::mutex_lock(this->m_imtx);
#define OMNI_SAFE_XUNLOCK_FW omni::sync::mutex_unlock(this->m_imtx);
#define OMNI_SAFE_XDTOR_FW omni::sync::mutex_destroy(this->m_imtx);
#else
#define OMNI_SAFE_XMTX_FW
#define OMNI_SAFE_XALOCK_FW
#define OMNI_SAFE_XINIT_FW
#define OMNI_SAFE_XLOCK_FW
#define OMNI_SAFE_XUNLOCK_FW
#define OMNI_SAFE_XDTOR_FW
#endif
omni::sync::mutex::mutex() :
OMNI_CTOR_FW(omni::sync::mutex)
m_lokd(0), m_mtx()
OMNI_SAFE_XMTX_FW
OMNI_MOLIST_FW
{
OMNI_SAFE_XINIT_FW
omni::sync::mutex_init(this->m_mtx);
OMNI_D5_FW("created");
}
omni::sync::mutex::mutex(bool initialy_owned) :
OMNI_CTOR_FW(omni::sync::mutex)
m_lokd(0), m_mtx()
OMNI_SAFE_XMTX_FW
OMNI_MOLIST_FW
{
OMNI_SAFE_XINIT_FW
omni::sync::mutex_init(this->m_mtx);
OMNI_D5_FW("created");
if (initialy_owned) { this->lock(); }
}
omni::sync::mutex::~mutex()
{
OMNI_DTOR_FW
if (this->locked()) {
/* DEV_NOTE: the sync objects (mutex/semaphore/etc.) will not unlock on destruction
since that would assume the user wants this. If they want an 'auto' mutex, they can
use the omni::sync::auto_lock */
OMNI_TERMINATE_FW("mutex is locked on destruction")
}
OMNI_TRY_FW
omni::sync::mutex_destroy(this->m_mtx);
OMNI_CATCH_FW
OMNI_SAFE_XDTOR_FW
OMNI_D5_FW("destroyed");
}
const omni::sync::mutex_t omni::sync::mutex::handle() const
{
OMNI_SAFE_XALOCK_FW
return this->m_mtx;
}
bool omni::sync::mutex::locked() const
{
OMNI_SAFE_XALOCK_FW
return (this->m_lokd > 0);
}
void omni::sync::mutex::lock()
{
OMNI_D4_FW("retrieving lock");
omni::sync::mutex_lock(this->m_mtx);
OMNI_SAFE_XLOCK_FW
OMNI_MOGET_FW
++this->m_lokd;
OMNI_SAFE_XUNLOCK_FW
OMNI_D4_FW("lock acquired");
}
bool omni::sync::mutex::lock(std::size_t timeout_ms)
{
if (timeout_ms == 0) { return this->trylock(); }
omni::chrono::tick_t start = omni::chrono::monotonic_tick();
while (omni::chrono::elapsed_ms(start) <= timeout_ms) {
if (this->trylock()) { return true; }
}
return false;
}
void omni::sync::mutex::unlock()
{
OMNI_SAFE_XALOCK_FW
// 'undefined' behaviour if 'unlock' on 'non-locked' system mutex
if (this->m_lokd > 0) {
// 'undefined' if 'unlock' not from owning thread
OMNI_MOCHK_FW
OMNI_D4_FW("unlocking");
omni::sync::mutex_unlock(this->m_mtx);
--this->m_lokd;
OMNI_D4_FW("unlocked");
} else {
OMNI_ERR_FW("mutex object is not locked", omni::mutex_unlock_exception())
}
}
bool omni::sync::mutex::trylock()
{
if (omni::sync::mutex_trylock(this->m_mtx)) {
OMNI_SAFE_XALOCK_FW
OMNI_MOGET_FW
++this->m_lokd;
return true;
}
return false;
}
bool omni::sync::mutex::operator==(const omni::sync::mutex &o) const
{
if (this == &o) { return true; }
OMNI_SAFE_XALOCK_FW
return (&this->m_mtx == &o.m_mtx &&
this->m_lokd == o.m_lokd)
OMNI_EQUAL_FW(o);
}
bool omni::sync::mutex::operator!=(const omni::sync::mutex &o) const
{
return !(*this == o);
}