1#ifndef BENCHMARK_MUTEX_H_
2#define BENCHMARK_MUTEX_H_
4#include <condition_variable>
11#if defined(HAVE_THREAD_SAFETY_ATTRIBUTES)
12#define THREAD_ANNOTATION_ATTRIBUTE_(x) __attribute__((x))
14#define THREAD_ANNOTATION_ATTRIBUTE_(x)
17#define CAPABILITY(x) THREAD_ANNOTATION_ATTRIBUTE_(capability(x))
19#define SCOPED_CAPABILITY THREAD_ANNOTATION_ATTRIBUTE_(scoped_lockable)
21#define GUARDED_BY(x) THREAD_ANNOTATION_ATTRIBUTE_(guarded_by(x))
23#define PT_GUARDED_BY(x) THREAD_ANNOTATION_ATTRIBUTE_(pt_guarded_by(x))
25#define ACQUIRED_BEFORE(...) \
26 THREAD_ANNOTATION_ATTRIBUTE_(acquired_before(__VA_ARGS__))
28#define ACQUIRED_AFTER(...) \
29 THREAD_ANNOTATION_ATTRIBUTE_(acquired_after(__VA_ARGS__))
31#define REQUIRES(...) \
32 THREAD_ANNOTATION_ATTRIBUTE_(requires_capability(__VA_ARGS__))
34#define REQUIRES_SHARED(...) \
35 THREAD_ANNOTATION_ATTRIBUTE_(requires_shared_capability(__VA_ARGS__))
38 THREAD_ANNOTATION_ATTRIBUTE_(acquire_capability(__VA_ARGS__))
40#define ACQUIRE_SHARED(...) \
41 THREAD_ANNOTATION_ATTRIBUTE_(acquire_shared_capability(__VA_ARGS__))
44 THREAD_ANNOTATION_ATTRIBUTE_(release_capability(__VA_ARGS__))
46#define RELEASE_SHARED(...) \
47 THREAD_ANNOTATION_ATTRIBUTE_(release_shared_capability(__VA_ARGS__))
49#define TRY_ACQUIRE(...) \
50 THREAD_ANNOTATION_ATTRIBUTE_(try_acquire_capability(__VA_ARGS__))
52#define TRY_ACQUIRE_SHARED(...) \
53 THREAD_ANNOTATION_ATTRIBUTE_(try_acquire_shared_capability(__VA_ARGS__))
55#define EXCLUDES(...) THREAD_ANNOTATION_ATTRIBUTE_(locks_excluded(__VA_ARGS__))
57#define ASSERT_CAPABILITY(x) THREAD_ANNOTATION_ATTRIBUTE_(assert_capability(x))
59#define ASSERT_SHARED_CAPABILITY(x) \
60 THREAD_ANNOTATION_ATTRIBUTE_(assert_shared_capability(x))
62#define RETURN_CAPABILITY(x) THREAD_ANNOTATION_ATTRIBUTE_(lock_returned(x))
64#define NO_THREAD_SAFETY_ANALYSIS \
65 THREAD_ANNOTATION_ATTRIBUTE_(no_thread_safety_analysis)
69typedef std::condition_variable Condition;
75class CAPABILITY("mutex") Mutex {
79 void lock() ACQUIRE() { mut_.lock(); }
80 void unlock() RELEASE() { mut_.unlock(); }
81 std::mutex& native_handle() {
return mut_; }
88 typedef std::unique_lock<std::mutex> MutexLockImp;
91 MutexLock(Mutex& m) ACQUIRE(m) : ml_(m.native_handle()) {}
93 MutexLockImp& native_handle() {
return ml_; }
101 Barrier(
int num_threads) : running_threads_(num_threads) {}
104 bool wait() EXCLUDES(lock_) {
105 bool last_thread =
false;
108 last_thread = createBarrier(ml);
110 if (last_thread) phase_condition_.notify_all();
114 void removeThread() EXCLUDES(lock_) {
117 if (entered_ != 0) phase_condition_.notify_all();
122 Condition phase_condition_;
123 int running_threads_;
126 int phase_number_ = 0;
132 bool createBarrier(
MutexLock& ml) REQUIRES(lock_) {
133 BM_CHECK_LT(entered_, running_threads_);
135 if (entered_ < running_threads_) {
137 int phase_number_cp = phase_number_;
138 auto cb = [
this, phase_number_cp]() {
139 return this->phase_number_ > phase_number_cp ||
140 entered_ == running_threads_;
142 phase_condition_.wait(ml.native_handle(), cb);
143 if (phase_number_ > phase_number_cp)
return false;