mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2025-04-12 20:48:17 +00:00
0489ce9303
This is a follow-up to r331272. We've been running doxygen with the autobrief option for a couple of years now. This makes the \brief markers into our comments redundant. Since they are a visual distraction and we don't want to encourage more \brief markers in new code either, this patch removes them all. Patch produced by for i in $(git grep -l '\@brief'); do perl -pi -e 's/\@brief //g' $i & done https://reviews.llvm.org/D46290 llvm-svn: 331275
42 lines
1.6 KiB
C++
42 lines
1.6 KiB
C++
//===-- Support/MutexGuard.h - Acquire/Release Mutex In Scope ---*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file defines a guard for a block of code that ensures a Mutex is locked
|
|
// upon construction and released upon destruction.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_SUPPORT_MUTEXGUARD_H
|
|
#define LLVM_SUPPORT_MUTEXGUARD_H
|
|
|
|
#include "llvm/Support/Mutex.h"
|
|
|
|
namespace llvm {
|
|
/// Instances of this class acquire a given Mutex Lock when constructed and
|
|
/// hold that lock until destruction. The intention is to instantiate one of
|
|
/// these on the stack at the top of some scope to be assured that C++
|
|
/// destruction of the object will always release the Mutex and thus avoid
|
|
/// a host of nasty multi-threading problems in the face of exceptions, etc.
|
|
/// Guard a section of code with a Mutex.
|
|
class MutexGuard {
|
|
sys::Mutex &M;
|
|
MutexGuard(const MutexGuard &) = delete;
|
|
void operator=(const MutexGuard &) = delete;
|
|
public:
|
|
MutexGuard(sys::Mutex &m) : M(m) { M.lock(); }
|
|
~MutexGuard() { M.unlock(); }
|
|
/// holds - Returns true if this locker instance holds the specified lock.
|
|
/// This is mostly used in assertions to validate that the correct mutex
|
|
/// is held.
|
|
bool holds(const sys::Mutex& lock) const { return &M == &lock; }
|
|
};
|
|
}
|
|
|
|
#endif // LLVM_SUPPORT_MUTEXGUARD_H
|