gecko-dev/xpcom/threads/RecursiveMutex.h
Nathan Froyd e3ebda1914 Bug 1223932 - delete guard object uses from the tree; r=jwalden
CLOSED TREE

We don't need these macros anymore, for two reasons:

1. We have static analysis to provide the same sort of checks via `MOZ_RAII`
   and friends.
2. clang now warns for the "temporary that should have been a declaration" case.

The extra requirements on class construction also show up during debug tests
as performance problems.

This change was automated by using the following sed script:

```
# Remove declarations in classes.
/MOZ_DECL_USE_GUARD_OBJECT_NOTIFIER/d
/MOZ_GUARD_OBJECT_NOTIFIER_INIT/d

# Remove individual macros, carefully.
{
  # We don't have to worry about substrings here because the closing
  # parenthesis "anchors" the match.
  s/MOZ_GUARD_OBJECT_NOTIFIER_PARAM)/)/g;
  s/MOZ_GUARD_OBJECT_NOTIFIER_PARAM_TO_PARENT)/)/g;
  s/MOZ_GUARD_OBJECT_NOTIFIER_PARAM_IN_IMPL)/)/g;
  s/MOZ_GUARD_OBJECT_NOTIFIER_ONLY_PARAM_IN_IMPL)/)/g;

  # Remove the longer identifier first.
  s/MOZ_GUARD_OBJECT_NOTIFIER_ONLY_PARAM_TO_PARENT//g;
  s/MOZ_GUARD_OBJECT_NOTIFIER_ONLY_PARAM//g;
}

# Remove the actual include.
\@# *include "mozilla/GuardObjects.h"@d
```

and running:

```
find . -name \*.cpp -o -name \*.h | grep -v 'GuardObjects.h' |xargs sed -i -f script 2>/dev/null
mach clang-format
```

Differential Revision: https://phabricator.services.mozilla.com/D85168
2020-07-30 14:22:38 +00:00

113 lines
2.9 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/. */
// A lock that can be acquired multiple times on the same thread.
#ifndef mozilla_RecursiveMutex_h
#define mozilla_RecursiveMutex_h
#include "mozilla/BlockingResourceBase.h"
#ifndef XP_WIN
# include <pthread.h>
#endif
namespace mozilla {
class RecursiveMutex : public BlockingResourceBase {
public:
explicit RecursiveMutex(const char* aName);
~RecursiveMutex();
#ifdef DEBUG
void Lock();
void Unlock();
#else
void Lock() { LockInternal(); }
void Unlock() { UnlockInternal(); }
#endif
#ifdef DEBUG
/**
* AssertCurrentThreadIn
**/
void AssertCurrentThreadIn();
/**
* AssertNotCurrentThreadIn
**/
void AssertNotCurrentThreadIn() {
// Not currently implemented. See bug 476536 for discussion.
}
#else
void AssertCurrentThreadIn() {}
void AssertNotCurrentThreadIn() {}
#endif
private:
RecursiveMutex() = delete;
RecursiveMutex(const RecursiveMutex&) = delete;
RecursiveMutex& operator=(const RecursiveMutex&) = delete;
void LockInternal();
void UnlockInternal();
#ifdef DEBUG
PRThread* mOwningThread;
size_t mEntryCount;
#endif
#if !defined(XP_WIN)
pthread_mutex_t mMutex;
#else
// We eschew including windows.h and using CRITICAL_SECTION here so that files
// including us don't also pull in windows.h. Just use a type that's big
// enough for CRITICAL_SECTION, and we'll fix it up later.
void* mMutex[6];
#endif
};
class MOZ_RAII RecursiveMutexAutoLock {
public:
explicit RecursiveMutexAutoLock(RecursiveMutex& aRecursiveMutex)
: mRecursiveMutex(&aRecursiveMutex) {
NS_ASSERTION(mRecursiveMutex, "null mutex");
mRecursiveMutex->Lock();
}
~RecursiveMutexAutoLock(void) { mRecursiveMutex->Unlock(); }
private:
RecursiveMutexAutoLock() = delete;
RecursiveMutexAutoLock(const RecursiveMutexAutoLock&) = delete;
RecursiveMutexAutoLock& operator=(const RecursiveMutexAutoLock&) = delete;
static void* operator new(size_t) noexcept(true);
mozilla::RecursiveMutex* mRecursiveMutex;
};
class MOZ_RAII RecursiveMutexAutoUnlock {
public:
explicit RecursiveMutexAutoUnlock(RecursiveMutex& aRecursiveMutex)
: mRecursiveMutex(&aRecursiveMutex) {
NS_ASSERTION(mRecursiveMutex, "null mutex");
mRecursiveMutex->Unlock();
}
~RecursiveMutexAutoUnlock(void) { mRecursiveMutex->Lock(); }
private:
RecursiveMutexAutoUnlock() = delete;
RecursiveMutexAutoUnlock(const RecursiveMutexAutoUnlock&) = delete;
RecursiveMutexAutoUnlock& operator=(const RecursiveMutexAutoUnlock&) = delete;
static void* operator new(size_t) noexcept(true);
mozilla::RecursiveMutex* mRecursiveMutex;
};
} // namespace mozilla
#endif // mozilla_RecursiveMutex_h