|
Packit |
8dc392 |
///////////////////////////////////////////////////////////////////////////
|
|
Packit |
8dc392 |
//
|
|
Packit |
8dc392 |
// Copyright (c) 2005-2012, Industrial Light & Magic, a division of Lucas
|
|
Packit |
8dc392 |
// Digital Ltd. LLC
|
|
Packit |
8dc392 |
//
|
|
Packit |
8dc392 |
// All rights reserved.
|
|
Packit |
8dc392 |
//
|
|
Packit |
8dc392 |
// Redistribution and use in source and binary forms, with or without
|
|
Packit |
8dc392 |
// modification, are permitted provided that the following conditions are
|
|
Packit |
8dc392 |
// met:
|
|
Packit |
8dc392 |
// * Redistributions of source code must retain the above copyright
|
|
Packit |
8dc392 |
// notice, this list of conditions and the following disclaimer.
|
|
Packit |
8dc392 |
// * Redistributions in binary form must reproduce the above
|
|
Packit |
8dc392 |
// copyright notice, this list of conditions and the following disclaimer
|
|
Packit |
8dc392 |
// in the documentation and/or other materials provided with the
|
|
Packit |
8dc392 |
// distribution.
|
|
Packit |
8dc392 |
// * Neither the name of Industrial Light & Magic nor the names of
|
|
Packit |
8dc392 |
// its contributors may be used to endorse or promote products derived
|
|
Packit |
8dc392 |
// from this software without specific prior written permission.
|
|
Packit |
8dc392 |
//
|
|
Packit |
8dc392 |
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
Packit |
8dc392 |
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
Packit |
8dc392 |
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
Packit |
8dc392 |
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
Packit |
8dc392 |
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
Packit |
8dc392 |
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
Packit |
8dc392 |
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
Packit |
8dc392 |
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
Packit |
8dc392 |
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
Packit |
8dc392 |
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
Packit |
8dc392 |
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
Packit |
8dc392 |
//
|
|
Packit |
8dc392 |
///////////////////////////////////////////////////////////////////////////
|
|
Packit |
8dc392 |
|
|
Packit |
8dc392 |
#ifndef INCLUDED_ILM_THREAD_MUTEX_H
|
|
Packit |
8dc392 |
#define INCLUDED_ILM_THREAD_MUTEX_H
|
|
Packit |
8dc392 |
|
|
Packit |
8dc392 |
//-----------------------------------------------------------------------------
|
|
Packit |
8dc392 |
//
|
|
Packit |
8dc392 |
// class Mutex, class Lock
|
|
Packit |
8dc392 |
//
|
|
Packit |
8dc392 |
// Class Mutex is a wrapper for a system-dependent mutual exclusion
|
|
Packit |
8dc392 |
// mechanism. Actual locking and unlocking of a Mutex object must
|
|
Packit |
8dc392 |
// be performed using an instance of a Lock (defined below).
|
|
Packit |
8dc392 |
//
|
|
Packit |
8dc392 |
// Class lock provides safe locking and unlocking of mutexes even in
|
|
Packit |
8dc392 |
// the presence of C++ exceptions. Constructing a Lock object locks
|
|
Packit |
8dc392 |
// the mutex; destroying the Lock unlocks the mutex.
|
|
Packit |
8dc392 |
//
|
|
Packit |
8dc392 |
// Lock objects are not themselves thread-safe. You should never
|
|
Packit |
8dc392 |
// share a Lock object among multiple threads.
|
|
Packit |
8dc392 |
//
|
|
Packit |
8dc392 |
// Typical usage:
|
|
Packit |
8dc392 |
//
|
|
Packit |
8dc392 |
// Mutex mtx; // Create a Mutex object that is visible
|
|
Packit |
8dc392 |
// //to multiple threads
|
|
Packit |
8dc392 |
//
|
|
Packit |
8dc392 |
// ... // create some threads
|
|
Packit |
8dc392 |
//
|
|
Packit |
8dc392 |
// // Then, within each thread, construct a critical section like so:
|
|
Packit |
8dc392 |
//
|
|
Packit |
8dc392 |
// {
|
|
Packit |
8dc392 |
// Lock lock (mtx); // Lock constructor locks the mutex
|
|
Packit |
8dc392 |
// ... // do some computation on shared data
|
|
Packit |
8dc392 |
// } // leaving the block unlocks the mutex
|
|
Packit |
8dc392 |
//
|
|
Packit |
8dc392 |
//-----------------------------------------------------------------------------
|
|
Packit |
8dc392 |
|
|
Packit |
8dc392 |
#include "IlmThreadExport.h"
|
|
Packit |
8dc392 |
#include "IlmBaseConfig.h"
|
|
Packit |
8dc392 |
#include "IlmThreadNamespace.h"
|
|
Packit |
8dc392 |
|
|
Packit |
8dc392 |
#if defined _WIN32 || defined _WIN64
|
|
Packit |
8dc392 |
#ifdef NOMINMAX
|
|
Packit |
8dc392 |
#undef NOMINMAX
|
|
Packit |
8dc392 |
#endif
|
|
Packit |
8dc392 |
#define NOMINMAX
|
|
Packit |
8dc392 |
#include <windows.h>
|
|
Packit |
8dc392 |
#elif HAVE_PTHREAD
|
|
Packit |
8dc392 |
#include <pthread.h>
|
|
Packit |
8dc392 |
#endif
|
|
Packit |
8dc392 |
|
|
Packit |
8dc392 |
ILMTHREAD_INTERNAL_NAMESPACE_HEADER_ENTER
|
|
Packit |
8dc392 |
|
|
Packit |
8dc392 |
class Lock;
|
|
Packit |
8dc392 |
|
|
Packit |
8dc392 |
|
|
Packit |
8dc392 |
class ILMTHREAD_EXPORT Mutex
|
|
Packit |
8dc392 |
{
|
|
Packit |
8dc392 |
public:
|
|
Packit |
8dc392 |
|
|
Packit |
8dc392 |
Mutex ();
|
|
Packit |
8dc392 |
virtual ~Mutex ();
|
|
Packit |
8dc392 |
|
|
Packit |
8dc392 |
private:
|
|
Packit |
8dc392 |
|
|
Packit |
8dc392 |
void lock () const;
|
|
Packit |
8dc392 |
void unlock () const;
|
|
Packit |
8dc392 |
|
|
Packit |
8dc392 |
#if defined _WIN32 || defined _WIN64
|
|
Packit |
8dc392 |
mutable CRITICAL_SECTION _mutex;
|
|
Packit |
8dc392 |
#elif HAVE_PTHREAD
|
|
Packit |
8dc392 |
mutable pthread_mutex_t _mutex;
|
|
Packit |
8dc392 |
#endif
|
|
Packit |
8dc392 |
|
|
Packit |
8dc392 |
void operator = (const Mutex& M); // not implemented
|
|
Packit |
8dc392 |
Mutex (const Mutex& M); // not implemented
|
|
Packit |
8dc392 |
|
|
Packit |
8dc392 |
friend class Lock;
|
|
Packit |
8dc392 |
};
|
|
Packit |
8dc392 |
|
|
Packit |
8dc392 |
|
|
Packit |
8dc392 |
class ILMTHREAD_EXPORT Lock
|
|
Packit |
8dc392 |
{
|
|
Packit |
8dc392 |
public:
|
|
Packit |
8dc392 |
|
|
Packit |
8dc392 |
Lock (const Mutex& m, bool autoLock = true):
|
|
Packit |
8dc392 |
_mutex (m),
|
|
Packit |
8dc392 |
_locked (false)
|
|
Packit |
8dc392 |
{
|
|
Packit |
8dc392 |
if (autoLock)
|
|
Packit |
8dc392 |
{
|
|
Packit |
8dc392 |
_mutex.lock();
|
|
Packit |
8dc392 |
_locked = true;
|
|
Packit |
8dc392 |
}
|
|
Packit |
8dc392 |
}
|
|
Packit |
8dc392 |
|
|
Packit |
8dc392 |
~Lock ()
|
|
Packit |
8dc392 |
{
|
|
Packit |
8dc392 |
if (_locked)
|
|
Packit |
8dc392 |
_mutex.unlock();
|
|
Packit |
8dc392 |
}
|
|
Packit |
8dc392 |
|
|
Packit |
8dc392 |
void acquire ()
|
|
Packit |
8dc392 |
{
|
|
Packit |
8dc392 |
_mutex.lock();
|
|
Packit |
8dc392 |
_locked = true;
|
|
Packit |
8dc392 |
}
|
|
Packit |
8dc392 |
|
|
Packit |
8dc392 |
void release ()
|
|
Packit |
8dc392 |
{
|
|
Packit |
8dc392 |
_mutex.unlock();
|
|
Packit |
8dc392 |
_locked = false;
|
|
Packit |
8dc392 |
}
|
|
Packit |
8dc392 |
|
|
Packit |
8dc392 |
bool locked ()
|
|
Packit |
8dc392 |
{
|
|
Packit |
8dc392 |
return _locked;
|
|
Packit |
8dc392 |
}
|
|
Packit |
8dc392 |
|
|
Packit |
8dc392 |
private:
|
|
Packit |
8dc392 |
|
|
Packit |
8dc392 |
const Mutex & _mutex;
|
|
Packit |
8dc392 |
bool _locked;
|
|
Packit |
8dc392 |
};
|
|
Packit |
8dc392 |
|
|
Packit |
8dc392 |
|
|
Packit |
8dc392 |
ILMTHREAD_INTERNAL_NAMESPACE_HEADER_EXIT
|
|
Packit |
8dc392 |
|
|
Packit |
8dc392 |
#endif // INCLUDED_ILM_THREAD_MUTEX_H
|