henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2011 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 | |
jbauch | 1286d0e | 2016-04-26 10:13:22 | [diff] [blame] | 11 | #include <memory> |
| 12 | |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 13 | #include "webrtc/base/common.h" |
| 14 | #include "webrtc/base/gunit.h" |
skvlad | b94713a | 2016-10-05 22:58:12 | [diff] [blame] | 15 | #include "webrtc/base/event.h" |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 16 | #include "webrtc/base/messagehandler.h" |
| 17 | #include "webrtc/base/messagequeue.h" |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 18 | #include "webrtc/base/sharedexclusivelock.h" |
| 19 | #include "webrtc/base/thread.h" |
| 20 | #include "webrtc/base/timeutils.h" |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 21 | |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 22 | namespace rtc { |
| 23 | |
Peter Boström | 07e22e6 | 2015-10-07 10:23:21 | [diff] [blame] | 24 | static const uint32_t kMsgRead = 0; |
| 25 | static const uint32_t kMsgWrite = 0; |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 26 | static const int kNoWaitThresholdInMs = 10; |
| 27 | static const int kWaitThresholdInMs = 80; |
| 28 | static const int kProcessTimeInMs = 100; |
| 29 | static const int kProcessTimeoutInMs = 5000; |
| 30 | |
| 31 | class SharedExclusiveTask : public MessageHandler { |
| 32 | public: |
| 33 | SharedExclusiveTask(SharedExclusiveLock* shared_exclusive_lock, |
| 34 | int* value, |
skvlad | b94713a | 2016-10-05 22:58:12 | [diff] [blame] | 35 | Event* done) |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 36 | : shared_exclusive_lock_(shared_exclusive_lock), |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 37 | value_(value), |
| 38 | done_(done) { |
| 39 | worker_thread_.reset(new Thread()); |
| 40 | worker_thread_->Start(); |
| 41 | } |
| 42 | |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 43 | protected: |
jbauch | 1286d0e | 2016-04-26 10:13:22 | [diff] [blame] | 44 | std::unique_ptr<Thread> worker_thread_; |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 45 | SharedExclusiveLock* shared_exclusive_lock_; |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 46 | int* value_; |
skvlad | b94713a | 2016-10-05 22:58:12 | [diff] [blame] | 47 | Event* done_; |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 48 | }; |
| 49 | |
| 50 | class ReadTask : public SharedExclusiveTask { |
| 51 | public: |
skvlad | b94713a | 2016-10-05 22:58:12 | [diff] [blame] | 52 | ReadTask(SharedExclusiveLock* shared_exclusive_lock, int* value, Event* done) |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 53 | : SharedExclusiveTask(shared_exclusive_lock, value, done) { |
| 54 | } |
| 55 | |
| 56 | void PostRead(int* value) { |
Taylor Brandstetter | c0bec8f | 2016-06-10 21:17:27 | [diff] [blame] | 57 | worker_thread_->Post(RTC_FROM_HERE, this, kMsgRead, |
| 58 | new TypedMessageData<int*>(value)); |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 59 | } |
| 60 | |
| 61 | private: |
| 62 | virtual void OnMessage(Message* message) { |
| 63 | ASSERT(rtc::Thread::Current() == worker_thread_.get()); |
| 64 | ASSERT(message != NULL); |
| 65 | ASSERT(message->message_id == kMsgRead); |
| 66 | |
| 67 | TypedMessageData<int*>* message_data = |
| 68 | static_cast<TypedMessageData<int*>*>(message->pdata); |
| 69 | |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 70 | { |
| 71 | SharedScope ss(shared_exclusive_lock_); |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 72 | *message_data->data() = *value_; |
skvlad | b94713a | 2016-10-05 22:58:12 | [diff] [blame] | 73 | done_->Set(); |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 74 | } |
| 75 | delete message->pdata; |
| 76 | message->pdata = NULL; |
| 77 | } |
| 78 | }; |
| 79 | |
| 80 | class WriteTask : public SharedExclusiveTask { |
| 81 | public: |
skvlad | b94713a | 2016-10-05 22:58:12 | [diff] [blame] | 82 | WriteTask(SharedExclusiveLock* shared_exclusive_lock, int* value, Event* done) |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 83 | : SharedExclusiveTask(shared_exclusive_lock, value, done) { |
| 84 | } |
| 85 | |
| 86 | void PostWrite(int value) { |
Taylor Brandstetter | c0bec8f | 2016-06-10 21:17:27 | [diff] [blame] | 87 | worker_thread_->Post(RTC_FROM_HERE, this, kMsgWrite, |
| 88 | new TypedMessageData<int>(value)); |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 89 | } |
| 90 | |
| 91 | private: |
| 92 | virtual void OnMessage(Message* message) { |
| 93 | ASSERT(rtc::Thread::Current() == worker_thread_.get()); |
| 94 | ASSERT(message != NULL); |
| 95 | ASSERT(message->message_id == kMsgWrite); |
| 96 | |
| 97 | TypedMessageData<int>* message_data = |
| 98 | static_cast<TypedMessageData<int>*>(message->pdata); |
| 99 | |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 100 | { |
| 101 | ExclusiveScope es(shared_exclusive_lock_); |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 102 | *value_ = message_data->data(); |
skvlad | b94713a | 2016-10-05 22:58:12 | [diff] [blame] | 103 | done_->Set(); |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 104 | } |
| 105 | delete message->pdata; |
| 106 | message->pdata = NULL; |
| 107 | } |
| 108 | }; |
| 109 | |
| 110 | // Unit test for SharedExclusiveLock. |
| 111 | class SharedExclusiveLockTest |
| 112 | : public testing::Test { |
| 113 | public: |
| 114 | SharedExclusiveLockTest() : value_(0) { |
| 115 | } |
| 116 | |
| 117 | virtual void SetUp() { |
| 118 | shared_exclusive_lock_.reset(new SharedExclusiveLock()); |
| 119 | } |
| 120 | |
| 121 | protected: |
jbauch | 1286d0e | 2016-04-26 10:13:22 | [diff] [blame] | 122 | std::unique_ptr<SharedExclusiveLock> shared_exclusive_lock_; |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 123 | int value_; |
| 124 | }; |
| 125 | |
henrike@webrtc.org | d0892c4 | 2014-10-09 22:08:15 | [diff] [blame] | 126 | TEST_F(SharedExclusiveLockTest, TestSharedShared) { |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 127 | int value0, value1; |
skvlad | b94713a | 2016-10-05 22:58:12 | [diff] [blame] | 128 | Event done0(false, false), done1(false, false); |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 129 | ReadTask reader0(shared_exclusive_lock_.get(), &value_, &done0); |
| 130 | ReadTask reader1(shared_exclusive_lock_.get(), &value_, &done1); |
| 131 | |
| 132 | // Test shared locks can be shared without waiting. |
| 133 | { |
| 134 | SharedScope ss(shared_exclusive_lock_.get()); |
| 135 | value_ = 1; |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 136 | reader0.PostRead(&value0); |
| 137 | reader1.PostRead(&value1); |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 138 | |
skvlad | b94713a | 2016-10-05 22:58:12 | [diff] [blame] | 139 | EXPECT_TRUE(done0.Wait(kProcessTimeoutInMs)); |
| 140 | EXPECT_TRUE(done1.Wait(kProcessTimeoutInMs)); |
| 141 | EXPECT_EQ(1, value0); |
| 142 | EXPECT_EQ(1, value1); |
| 143 | } |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 144 | } |
| 145 | |
skvlad | b94713a | 2016-10-05 22:58:12 | [diff] [blame] | 146 | TEST_F(SharedExclusiveLockTest, TestSharedExclusive) { |
| 147 | Event done(false, false); |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 148 | WriteTask writer(shared_exclusive_lock_.get(), &value_, &done); |
| 149 | |
| 150 | // Test exclusive lock needs to wait for shared lock. |
| 151 | { |
| 152 | SharedScope ss(shared_exclusive_lock_.get()); |
| 153 | value_ = 1; |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 154 | writer.PostWrite(2); |
skvlad | b94713a | 2016-10-05 22:58:12 | [diff] [blame] | 155 | EXPECT_FALSE(done.Wait(kProcessTimeInMs)); |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 156 | } |
skvlad | b94713a | 2016-10-05 22:58:12 | [diff] [blame] | 157 | EXPECT_TRUE(done.Wait(kProcessTimeoutInMs)); |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 158 | EXPECT_EQ(2, value_); |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 159 | } |
| 160 | |
henrike@webrtc.org | d0892c4 | 2014-10-09 22:08:15 | [diff] [blame] | 161 | TEST_F(SharedExclusiveLockTest, TestExclusiveShared) { |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 162 | int value; |
skvlad | b94713a | 2016-10-05 22:58:12 | [diff] [blame] | 163 | Event done(false, false); |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 164 | ReadTask reader(shared_exclusive_lock_.get(), &value_, &done); |
| 165 | |
| 166 | // Test shared lock needs to wait for exclusive lock. |
| 167 | { |
| 168 | ExclusiveScope es(shared_exclusive_lock_.get()); |
| 169 | value_ = 1; |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 170 | reader.PostRead(&value); |
skvlad | b94713a | 2016-10-05 22:58:12 | [diff] [blame] | 171 | EXPECT_FALSE(done.Wait(kProcessTimeInMs)); |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 172 | value_ = 2; |
| 173 | } |
| 174 | |
skvlad | b94713a | 2016-10-05 22:58:12 | [diff] [blame] | 175 | EXPECT_TRUE(done.Wait(kProcessTimeoutInMs)); |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 176 | EXPECT_EQ(2, value); |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 177 | } |
| 178 | |
skvlad | b94713a | 2016-10-05 22:58:12 | [diff] [blame] | 179 | TEST_F(SharedExclusiveLockTest, TestExclusiveExclusive) { |
| 180 | Event done(false, false); |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 181 | WriteTask writer(shared_exclusive_lock_.get(), &value_, &done); |
| 182 | |
| 183 | // Test exclusive lock needs to wait for exclusive lock. |
| 184 | { |
| 185 | ExclusiveScope es(shared_exclusive_lock_.get()); |
skvlad | b94713a | 2016-10-05 22:58:12 | [diff] [blame] | 186 | // Start the writer task only after holding the lock, to ensure it need |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 187 | value_ = 1; |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 188 | writer.PostWrite(2); |
skvlad | b94713a | 2016-10-05 22:58:12 | [diff] [blame] | 189 | EXPECT_FALSE(done.Wait(kProcessTimeInMs)); |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 190 | EXPECT_EQ(1, value_); |
| 191 | } |
| 192 | |
skvlad | b94713a | 2016-10-05 22:58:12 | [diff] [blame] | 193 | EXPECT_TRUE(done.Wait(kProcessTimeoutInMs)); |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 194 | EXPECT_EQ(2, value_); |
henrike@webrtc.org | 47be73b | 2014-05-13 18:00:26 | [diff] [blame] | 195 | } |
| 196 | |
| 197 | } // namespace rtc |