danilchap | 0140408 | 2016-10-24 06:07:25 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2016 The WebRTC project authors. All Rights Reserved. |
| 3 | * |
| 4 | * Use of this source code is governed by a BSD-style license |
| 5 | * that can be found in the LICENSE file in the root of the source |
| 6 | * tree. An additional intellectual property rights grant can be found |
| 7 | * in the file PATENTS. All contributing project authors may |
| 8 | * be found in the AUTHORS file in the root of the source tree. |
| 9 | */ |
| 10 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 11 | #include "rtc_base/thread_annotations.h" |
Jonas Olsson | a4d8737 | 2019-07-05 19:08:33 +0200 | [diff] [blame] | 12 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 13 | #include "test/gtest.h" |
danilchap | 0140408 | 2016-10-24 06:07:25 -0700 | [diff] [blame] | 14 | |
| 15 | namespace { |
| 16 | |
danilchap | 5301e3c | 2017-09-06 04:10:21 -0700 | [diff] [blame] | 17 | class RTC_LOCKABLE Lock { |
danilchap | 0140408 | 2016-10-24 06:07:25 -0700 | [diff] [blame] | 18 | public: |
danilchap | 5301e3c | 2017-09-06 04:10:21 -0700 | [diff] [blame] | 19 | void EnterWrite() const RTC_EXCLUSIVE_LOCK_FUNCTION() {} |
| 20 | void EnterRead() const RTC_SHARED_LOCK_FUNCTION() {} |
| 21 | bool TryEnterWrite() const RTC_EXCLUSIVE_TRYLOCK_FUNCTION(true) { |
| 22 | return true; |
| 23 | } |
| 24 | bool TryEnterRead() const RTC_SHARED_TRYLOCK_FUNCTION(true) { return true; } |
| 25 | void Leave() const RTC_UNLOCK_FUNCTION() {} |
danilchap | 0140408 | 2016-10-24 06:07:25 -0700 | [diff] [blame] | 26 | }; |
| 27 | |
danilchap | 5301e3c | 2017-09-06 04:10:21 -0700 | [diff] [blame] | 28 | class RTC_SCOPED_LOCKABLE ScopeLock { |
danilchap | 0140408 | 2016-10-24 06:07:25 -0700 | [diff] [blame] | 29 | public: |
danilchap | 5301e3c | 2017-09-06 04:10:21 -0700 | [diff] [blame] | 30 | explicit ScopeLock(const Lock& lock) RTC_EXCLUSIVE_LOCK_FUNCTION(lock) {} |
| 31 | ~ScopeLock() RTC_UNLOCK_FUNCTION() {} |
danilchap | 0140408 | 2016-10-24 06:07:25 -0700 | [diff] [blame] | 32 | }; |
| 33 | |
| 34 | class ThreadSafe { |
| 35 | public: |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 36 | ThreadSafe() { pt_protected_by_lock_ = new int; } |
danilchap | 0140408 | 2016-10-24 06:07:25 -0700 | [diff] [blame] | 37 | |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 38 | ~ThreadSafe() { delete pt_protected_by_lock_; } |
danilchap | 0140408 | 2016-10-24 06:07:25 -0700 | [diff] [blame] | 39 | |
| 40 | void LockInOrder() { |
Danil Chapovalov | 3765199 | 2017-11-01 10:52:09 +0100 | [diff] [blame] | 41 | beforelock_.EnterWrite(); |
danilchap | 0140408 | 2016-10-24 06:07:25 -0700 | [diff] [blame] | 42 | lock_.EnterWrite(); |
| 43 | pt_lock_.EnterWrite(); |
| 44 | |
| 45 | pt_lock_.Leave(); |
| 46 | lock_.Leave(); |
Danil Chapovalov | 3765199 | 2017-11-01 10:52:09 +0100 | [diff] [blame] | 47 | beforelock_.Leave(); |
danilchap | 0140408 | 2016-10-24 06:07:25 -0700 | [diff] [blame] | 48 | } |
| 49 | |
Danil Chapovalov | 3765199 | 2017-11-01 10:52:09 +0100 | [diff] [blame] | 50 | void UnprotectedFunction() RTC_LOCKS_EXCLUDED(lock_, pt_lock_) { |
danilchap | 0140408 | 2016-10-24 06:07:25 -0700 | [diff] [blame] | 51 | // Can access unprotected Value. |
| 52 | unprotected_ = 15; |
| 53 | // Can access pointers themself, but not data they point to. |
| 54 | int* tmp = pt_protected_by_lock_; |
Danil Chapovalov | 3765199 | 2017-11-01 10:52:09 +0100 | [diff] [blame] | 55 | pt_protected_by_lock_ = tmp; |
danilchap | 0140408 | 2016-10-24 06:07:25 -0700 | [diff] [blame] | 56 | } |
| 57 | |
| 58 | void ReadProtected() { |
| 59 | lock_.EnterRead(); |
danilchap | 0140408 | 2016-10-24 06:07:25 -0700 | [diff] [blame] | 60 | unprotected_ = protected_by_lock_; |
| 61 | lock_.Leave(); |
| 62 | |
| 63 | if (pt_lock_.TryEnterRead()) { |
danilchap | 0140408 | 2016-10-24 06:07:25 -0700 | [diff] [blame] | 64 | unprotected_ = *pt_protected_by_lock_; |
| 65 | pt_lock_.Leave(); |
| 66 | } |
danilchap | 0140408 | 2016-10-24 06:07:25 -0700 | [diff] [blame] | 67 | } |
| 68 | |
| 69 | void WriteProtected() { |
| 70 | lock_.EnterWrite(); |
danilchap | 0140408 | 2016-10-24 06:07:25 -0700 | [diff] [blame] | 71 | protected_by_lock_ = unprotected_; |
| 72 | lock_.Leave(); |
| 73 | |
| 74 | if (pt_lock_.TryEnterWrite()) { |
danilchap | 0140408 | 2016-10-24 06:07:25 -0700 | [diff] [blame] | 75 | *pt_protected_by_lock_ = unprotected_; |
| 76 | pt_lock_.Leave(); |
| 77 | } |
danilchap | 0140408 | 2016-10-24 06:07:25 -0700 | [diff] [blame] | 78 | } |
| 79 | |
| 80 | void CallReadProtectedFunction() { |
| 81 | lock_.EnterRead(); |
| 82 | pt_lock_.EnterRead(); |
| 83 | ReadProtectedFunction(); |
| 84 | pt_lock_.Leave(); |
| 85 | lock_.Leave(); |
| 86 | } |
| 87 | |
| 88 | void CallWriteProtectedFunction() { |
| 89 | ScopeLock scope_lock(GetLock()); |
| 90 | ScopeLock pt_scope_lock(pt_lock_); |
| 91 | WriteProtectedFunction(); |
| 92 | } |
| 93 | |
| 94 | private: |
danilchap | 5301e3c | 2017-09-06 04:10:21 -0700 | [diff] [blame] | 95 | void ReadProtectedFunction() RTC_SHARED_LOCKS_REQUIRED(lock_, pt_lock_) { |
danilchap | 0140408 | 2016-10-24 06:07:25 -0700 | [diff] [blame] | 96 | unprotected_ = protected_by_lock_; |
| 97 | unprotected_ = *pt_protected_by_lock_; |
| 98 | } |
| 99 | |
danilchap | 5301e3c | 2017-09-06 04:10:21 -0700 | [diff] [blame] | 100 | void WriteProtectedFunction() RTC_EXCLUSIVE_LOCKS_REQUIRED(lock_, pt_lock_) { |
danilchap | 0140408 | 2016-10-24 06:07:25 -0700 | [diff] [blame] | 101 | int x = protected_by_lock_; |
| 102 | *pt_protected_by_lock_ = x; |
| 103 | protected_by_lock_ = unprotected_; |
| 104 | } |
| 105 | |
danilchap | 5301e3c | 2017-09-06 04:10:21 -0700 | [diff] [blame] | 106 | const Lock& GetLock() RTC_LOCK_RETURNED(lock_) { return lock_; } |
danilchap | 0140408 | 2016-10-24 06:07:25 -0700 | [diff] [blame] | 107 | |
Danil Chapovalov | 3765199 | 2017-11-01 10:52:09 +0100 | [diff] [blame] | 108 | Lock beforelock_ RTC_ACQUIRED_BEFORE(lock_); |
danilchap | 0140408 | 2016-10-24 06:07:25 -0700 | [diff] [blame] | 109 | Lock lock_; |
danilchap | 5301e3c | 2017-09-06 04:10:21 -0700 | [diff] [blame] | 110 | Lock pt_lock_ RTC_ACQUIRED_AFTER(lock_); |
danilchap | 0140408 | 2016-10-24 06:07:25 -0700 | [diff] [blame] | 111 | |
| 112 | int unprotected_ = 0; |
| 113 | |
danilchap | 5301e3c | 2017-09-06 04:10:21 -0700 | [diff] [blame] | 114 | int protected_by_lock_ RTC_GUARDED_BY(lock_) = 0; |
danilchap | 0140408 | 2016-10-24 06:07:25 -0700 | [diff] [blame] | 115 | |
danilchap | 5301e3c | 2017-09-06 04:10:21 -0700 | [diff] [blame] | 116 | int* pt_protected_by_lock_ RTC_PT_GUARDED_BY(pt_lock_); |
danilchap | 0140408 | 2016-10-24 06:07:25 -0700 | [diff] [blame] | 117 | }; |
| 118 | |
| 119 | } // namespace |
| 120 | |
| 121 | TEST(ThreadAnnotationsTest, Test) { |
| 122 | // This test ensure thread annotations doesn't break compilation. |
| 123 | // Thus no run-time expectations. |
| 124 | ThreadSafe t; |
| 125 | t.LockInOrder(); |
| 126 | t.UnprotectedFunction(); |
| 127 | t.ReadProtected(); |
| 128 | t.WriteProtected(); |
| 129 | t.CallReadProtectedFunction(); |
| 130 | t.CallWriteProtectedFunction(); |
| 131 | } |