gecko-dev/xpcom/threads/Mutex.h
Bill McCloskey 2270017046 Bug 1350432 - Add MutexAutoLock::AssertOwns (r=froydnj)
MozReview-Commit-ID: KQGaHRFDxo4
2017-08-25 10:28:23 -07:00

270 lines
6.4 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_Mutex_h
#define mozilla_Mutex_h
#include "mozilla/BlockingResourceBase.h"
#include "mozilla/GuardObjects.h"
#include "mozilla/PlatformMutex.h"
//
// Provides:
//
// - Mutex, a non-recursive mutex
// - MutexAutoLock, an RAII class for ensuring that Mutexes are properly
// locked and unlocked
// - MutexAutoUnlock, complementary sibling to MutexAutoLock
//
// - OffTheBooksMutex, a non-recursive mutex that doesn't do leak checking
// - OffTheBooksMutexAuto{Lock,Unlock} - Like MutexAuto{Lock,Unlock}, but for
// an OffTheBooksMutex.
//
// Using MutexAutoLock/MutexAutoUnlock etc. is MUCH preferred to making bare
// calls to Lock and Unlock.
//
namespace mozilla {
/**
* OffTheBooksMutex is identical to Mutex, except that OffTheBooksMutex doesn't
* include leak checking. Sometimes you want to intentionally "leak" a mutex
* until shutdown; in these cases, OffTheBooksMutex is for you.
*/
class OffTheBooksMutex : public detail::MutexImpl, BlockingResourceBase
{
public:
/**
* @param aName A name which can reference this lock
* @returns If failure, nullptr
* If success, a valid Mutex* which must be destroyed
* by Mutex::DestroyMutex()
**/
explicit OffTheBooksMutex(const char* aName)
: detail::MutexImpl()
, BlockingResourceBase(aName, eMutex)
#ifdef DEBUG
, mOwningThread(nullptr)
#endif
{
}
~OffTheBooksMutex()
{
#ifdef DEBUG
MOZ_ASSERT(!mOwningThread, "destroying a still-owned lock!");
#endif
}
#ifndef DEBUG
/**
* Lock this mutex.
**/
void Lock() { this->lock(); }
/**
* Unlock this mutex.
**/
void Unlock() { this->unlock(); }
/**
* Assert that the current thread owns this mutex in debug builds.
*
* Does nothing in non-debug builds.
**/
void AssertCurrentThreadOwns() const {}
/**
* Assert that the current thread does not own this mutex.
*
* Note that this function is not implemented for debug builds *and*
* non-debug builds due to difficulties in dealing with memory ordering.
*
* It is therefore mostly useful as documentation.
**/
void AssertNotCurrentThreadOwns() const {}
#else
void Lock();
void Unlock();
void AssertCurrentThreadOwns() const;
void AssertNotCurrentThreadOwns() const
{
// FIXME bug 476536
}
#endif // ifndef DEBUG
private:
OffTheBooksMutex();
OffTheBooksMutex(const OffTheBooksMutex&);
OffTheBooksMutex& operator=(const OffTheBooksMutex&);
friend class CondVar;
#ifdef DEBUG
PRThread* mOwningThread;
#endif
};
/**
* Mutex
* When possible, use MutexAutoLock/MutexAutoUnlock to lock/unlock this
* mutex within a scope, instead of calling Lock/Unlock directly.
*/
class Mutex : public OffTheBooksMutex
{
public:
explicit Mutex(const char* aName)
: OffTheBooksMutex(aName)
{
MOZ_COUNT_CTOR(Mutex);
}
~Mutex()
{
MOZ_COUNT_DTOR(Mutex);
}
private:
Mutex();
Mutex(const Mutex&);
Mutex& operator=(const Mutex&);
};
template<typename T>
class MOZ_RAII BaseAutoUnlock;
/**
* MutexAutoLock
* Acquires the Mutex when it enters scope, and releases it when it leaves
* scope.
*
* MUCH PREFERRED to bare calls to Mutex.Lock and Unlock.
*/
template<typename T>
class MOZ_RAII BaseAutoLock
{
public:
/**
* Constructor
* The constructor aquires the given lock. The destructor
* releases the lock.
*
* @param aLock A valid mozilla::Mutex* returned by
* mozilla::Mutex::NewMutex.
**/
explicit BaseAutoLock(T& aLock MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
: mLock(&aLock)
{
MOZ_GUARD_OBJECT_NOTIFIER_INIT;
NS_ASSERTION(mLock, "null mutex");
mLock->Lock();
}
~BaseAutoLock(void)
{
mLock->Unlock();
}
// Assert that aLock is the mutex passed to the constructor and that the
// current thread owns the mutex. In coding patterns such as:
//
// void LockedMethod(const MutexAutoLock& aProofOfLock)
// {
// aProofOfLock.AssertOwns(mMutex);
// ...
// }
//
// Without this assertion, it could be that mMutex is not actually
// locked. It's possible to have code like:
//
// MutexAutoLock lock(someMutex);
// ...
// MutexAutoUnlock unlock(someMutex);
// ...
// LockedMethod(lock);
//
// and in such a case, simply asserting that the mutex pointers match is not
// sufficient; mutex ownership must be asserted as well.
//
// Note that if you are going to use the coding pattern presented above, you
// should use this method in preference to using AssertCurrentThreadOwns on
// the mutex you expected to be held, since this method provides stronger
// guarantees.
void AssertOwns(const T& aLock) const
{
MOZ_ASSERT(&aLock == mLock);
mLock->AssertCurrentThreadOwns();
}
private:
BaseAutoLock();
BaseAutoLock(BaseAutoLock&);
BaseAutoLock& operator=(BaseAutoLock&);
static void* operator new(size_t) CPP_THROW_NEW;
friend class BaseAutoUnlock<T>;
T* mLock;
MOZ_DECL_USE_GUARD_OBJECT_NOTIFIER
};
typedef BaseAutoLock<Mutex> MutexAutoLock;
typedef BaseAutoLock<OffTheBooksMutex> OffTheBooksMutexAutoLock;
/**
* MutexAutoUnlock
* Releases the Mutex when it enters scope, and re-acquires it when it leaves
* scope.
*
* MUCH PREFERRED to bare calls to Mutex.Unlock and Lock.
*/
template<typename T>
class MOZ_RAII BaseAutoUnlock
{
public:
explicit BaseAutoUnlock(T& aLock MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
: mLock(&aLock)
{
MOZ_GUARD_OBJECT_NOTIFIER_INIT;
NS_ASSERTION(mLock, "null lock");
mLock->Unlock();
}
explicit BaseAutoUnlock(
BaseAutoLock<T>& aAutoLock MOZ_GUARD_OBJECT_NOTIFIER_PARAM)
: mLock(aAutoLock.mLock)
{
MOZ_GUARD_OBJECT_NOTIFIER_INIT;
NS_ASSERTION(mLock, "null lock");
mLock->Unlock();
}
~BaseAutoUnlock()
{
mLock->Lock();
}
private:
BaseAutoUnlock();
BaseAutoUnlock(BaseAutoUnlock&);
BaseAutoUnlock& operator=(BaseAutoUnlock&);
static void* operator new(size_t) CPP_THROW_NEW;
T* mLock;
MOZ_DECL_USE_GUARD_OBJECT_NOTIFIER
};
typedef BaseAutoUnlock<Mutex> MutexAutoUnlock;
typedef BaseAutoUnlock<OffTheBooksMutex> OffTheBooksMutexAutoUnlock;
} // namespace mozilla
#endif // ifndef mozilla_Mutex_h