perkj | 9c16fe8 | 2016-07-12 15:04:07 -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 | */ |
kwiberg | ac9f876 | 2016-09-30 22:29:43 -0700 | [diff] [blame] | 10 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 11 | #include "rtc_base/sequenced_task_checker.h" |
Tommi | 10b40ce | 2018-02-19 13:34:00 +0100 | [diff] [blame] | 12 | |
Yves Gerey | 3e70781 | 2018-11-28 16:47:49 +0100 | [diff] [blame] | 13 | #include <memory> |
| 14 | #include <utility> |
| 15 | |
Danil Chapovalov | 2214b91 | 2019-03-25 15:13:59 +0100 | [diff] [blame] | 16 | #include "absl/memory/memory.h" |
| 17 | #include "api/function_view.h" |
Yves Gerey | 2e00abc | 2018-10-05 15:39:24 +0200 | [diff] [blame] | 18 | #include "rtc_base/event.h" |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 19 | #include "rtc_base/platform_thread.h" |
Danil Chapovalov | 2214b91 | 2019-03-25 15:13:59 +0100 | [diff] [blame] | 20 | #include "rtc_base/task_queue_for_test.h" |
Tommi | 10b40ce | 2018-02-19 13:34:00 +0100 | [diff] [blame] | 21 | #include "rtc_base/thread_checker.h" |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 22 | #include "test/gtest.h" |
perkj | 9c16fe8 | 2016-07-12 15:04:07 -0700 | [diff] [blame] | 23 | |
| 24 | namespace rtc { |
perkj | 9c16fe8 | 2016-07-12 15:04:07 -0700 | [diff] [blame] | 25 | namespace { |
Tommi | 10b40ce | 2018-02-19 13:34:00 +0100 | [diff] [blame] | 26 | |
Danil Chapovalov | 2214b91 | 2019-03-25 15:13:59 +0100 | [diff] [blame] | 27 | using ::webrtc::TaskQueueForTest; |
| 28 | |
Tommi | 10b40ce | 2018-02-19 13:34:00 +0100 | [diff] [blame] | 29 | // This class is dead code, but its purpose is to make sure that |
| 30 | // SequencedTaskChecker is compatible with the RTC_GUARDED_BY and RTC_RUN_ON |
| 31 | // attributes that are checked at compile-time. |
| 32 | class CompileTimeTestForGuardedBy { |
| 33 | public: |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 34 | int CalledOnSequence() RTC_RUN_ON(sequence_checker_) { return guarded_; } |
Tommi | 10b40ce | 2018-02-19 13:34:00 +0100 | [diff] [blame] | 35 | |
| 36 | void CallMeFromSequence() { |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 37 | RTC_DCHECK_RUN_ON(&sequence_checker_) << "Should be called on sequence"; |
Danil Chapovalov | 2214b91 | 2019-03-25 15:13:59 +0100 | [diff] [blame] | 38 | guarded_ = 41; |
Tommi | 10b40ce | 2018-02-19 13:34:00 +0100 | [diff] [blame] | 39 | } |
| 40 | |
| 41 | private: |
| 42 | int guarded_ RTC_GUARDED_BY(sequence_checker_); |
Danil Chapovalov | 2214b91 | 2019-03-25 15:13:59 +0100 | [diff] [blame] | 43 | SequencedTaskChecker sequence_checker_; |
Tommi | 10b40ce | 2018-02-19 13:34:00 +0100 | [diff] [blame] | 44 | }; |
| 45 | |
Danil Chapovalov | 2214b91 | 2019-03-25 15:13:59 +0100 | [diff] [blame] | 46 | void RunOnDifferentThread(FunctionView<void()> run) { |
| 47 | struct Object { |
| 48 | static void Run(void* obj) { |
| 49 | auto* me = static_cast<Object*>(obj); |
| 50 | me->run(); |
| 51 | me->thread_has_run_event.Set(); |
| 52 | } |
perkj | 9c16fe8 | 2016-07-12 15:04:07 -0700 | [diff] [blame] | 53 | |
Danil Chapovalov | 2214b91 | 2019-03-25 15:13:59 +0100 | [diff] [blame] | 54 | FunctionView<void()> run; |
| 55 | Event thread_has_run_event; |
| 56 | } object{run}; |
perkj | 9c16fe8 | 2016-07-12 15:04:07 -0700 | [diff] [blame] | 57 | |
Danil Chapovalov | 2214b91 | 2019-03-25 15:13:59 +0100 | [diff] [blame] | 58 | PlatformThread thread(&Object::Run, &object, "thread"); |
| 59 | thread.Start(); |
| 60 | EXPECT_TRUE(object.thread_has_run_event.Wait(1000)); |
| 61 | thread.Stop(); |
perkj | 9c16fe8 | 2016-07-12 15:04:07 -0700 | [diff] [blame] | 62 | } |
| 63 | |
perkj | 9c16fe8 | 2016-07-12 15:04:07 -0700 | [diff] [blame] | 64 | } // namespace |
| 65 | |
| 66 | TEST(SequencedTaskCheckerTest, CallsAllowedOnSameThread) { |
Danil Chapovalov | 2214b91 | 2019-03-25 15:13:59 +0100 | [diff] [blame] | 67 | SequencedTaskChecker sequenced_task_checker; |
| 68 | EXPECT_TRUE(sequenced_task_checker.CalledSequentially()); |
perkj | 9c16fe8 | 2016-07-12 15:04:07 -0700 | [diff] [blame] | 69 | } |
| 70 | |
| 71 | TEST(SequencedTaskCheckerTest, DestructorAllowedOnDifferentThread) { |
Danil Chapovalov | 2214b91 | 2019-03-25 15:13:59 +0100 | [diff] [blame] | 72 | auto sequenced_task_checker = absl::make_unique<SequencedTaskChecker>(); |
| 73 | RunOnDifferentThread([&] { |
| 74 | // Verify that the destructor doesn't assert when called on a different |
| 75 | // thread. |
| 76 | sequenced_task_checker.reset(); |
| 77 | }); |
perkj | 9c16fe8 | 2016-07-12 15:04:07 -0700 | [diff] [blame] | 78 | } |
| 79 | |
| 80 | TEST(SequencedTaskCheckerTest, DetachFromThread) { |
Danil Chapovalov | 2214b91 | 2019-03-25 15:13:59 +0100 | [diff] [blame] | 81 | SequencedTaskChecker sequenced_task_checker; |
| 82 | sequenced_task_checker.Detach(); |
| 83 | RunOnDifferentThread( |
| 84 | [&] { EXPECT_TRUE(sequenced_task_checker.CalledSequentially()); }); |
perkj | 9c16fe8 | 2016-07-12 15:04:07 -0700 | [diff] [blame] | 85 | } |
| 86 | |
| 87 | TEST(SequencedTaskCheckerTest, DetachFromThreadAndUseOnTaskQueue) { |
Danil Chapovalov | 2214b91 | 2019-03-25 15:13:59 +0100 | [diff] [blame] | 88 | SequencedTaskChecker sequenced_task_checker; |
| 89 | sequenced_task_checker.Detach(); |
| 90 | TaskQueueForTest queue; |
| 91 | queue.SendTask( |
| 92 | [&] { EXPECT_TRUE(sequenced_task_checker.CalledSequentially()); }); |
perkj | 9c16fe8 | 2016-07-12 15:04:07 -0700 | [diff] [blame] | 93 | } |
| 94 | |
| 95 | TEST(SequencedTaskCheckerTest, DetachFromTaskQueueAndUseOnThread) { |
Danil Chapovalov | 2214b91 | 2019-03-25 15:13:59 +0100 | [diff] [blame] | 96 | TaskQueueForTest queue; |
| 97 | queue.SendTask([] { |
| 98 | SequencedTaskChecker sequenced_task_checker; |
| 99 | sequenced_task_checker.Detach(); |
| 100 | RunOnDifferentThread( |
| 101 | [&] { EXPECT_TRUE(sequenced_task_checker.CalledSequentially()); }); |
perkj | 9c16fe8 | 2016-07-12 15:04:07 -0700 | [diff] [blame] | 102 | }); |
perkj | 9c16fe8 | 2016-07-12 15:04:07 -0700 | [diff] [blame] | 103 | } |
| 104 | |
perkj | 9c16fe8 | 2016-07-12 15:04:07 -0700 | [diff] [blame] | 105 | TEST(SequencedTaskCheckerTest, MethodNotAllowedOnDifferentThreadInDebug) { |
Danil Chapovalov | 2214b91 | 2019-03-25 15:13:59 +0100 | [diff] [blame] | 106 | SequencedTaskChecker sequenced_task_checker; |
| 107 | RunOnDifferentThread([&] { |
| 108 | EXPECT_EQ(sequenced_task_checker.CalledSequentially(), !RTC_DCHECK_IS_ON); |
| 109 | }); |
perkj | 9c16fe8 | 2016-07-12 15:04:07 -0700 | [diff] [blame] | 110 | } |
perkj | 9c16fe8 | 2016-07-12 15:04:07 -0700 | [diff] [blame] | 111 | |
perkj | 9c16fe8 | 2016-07-12 15:04:07 -0700 | [diff] [blame] | 112 | TEST(SequencedTaskCheckerTest, MethodNotAllowedOnDifferentTaskQueueInDebug) { |
Danil Chapovalov | 2214b91 | 2019-03-25 15:13:59 +0100 | [diff] [blame] | 113 | SequencedTaskChecker sequenced_task_checker; |
| 114 | TaskQueueForTest queue; |
| 115 | queue.SendTask([&] { |
| 116 | EXPECT_EQ(sequenced_task_checker.CalledSequentially(), !RTC_DCHECK_IS_ON); |
| 117 | }); |
perkj | 9c16fe8 | 2016-07-12 15:04:07 -0700 | [diff] [blame] | 118 | } |
perkj | 9c16fe8 | 2016-07-12 15:04:07 -0700 | [diff] [blame] | 119 | |
perkj | 9c16fe8 | 2016-07-12 15:04:07 -0700 | [diff] [blame] | 120 | TEST(SequencedTaskCheckerTest, DetachFromTaskQueueInDebug) { |
Danil Chapovalov | 2214b91 | 2019-03-25 15:13:59 +0100 | [diff] [blame] | 121 | SequencedTaskChecker sequenced_task_checker; |
| 122 | sequenced_task_checker.Detach(); |
| 123 | |
| 124 | TaskQueueForTest queue1; |
| 125 | queue1.SendTask( |
| 126 | [&] { EXPECT_TRUE(sequenced_task_checker.CalledSequentially()); }); |
| 127 | |
| 128 | // CalledSequentially should return false in debug builds after moving to |
| 129 | // another task queue. |
| 130 | TaskQueueForTest queue2; |
| 131 | queue2.SendTask([&] { |
| 132 | EXPECT_EQ(sequenced_task_checker.CalledSequentially(), !RTC_DCHECK_IS_ON); |
| 133 | }); |
perkj | 9c16fe8 | 2016-07-12 15:04:07 -0700 | [diff] [blame] | 134 | } |
perkj | 9c16fe8 | 2016-07-12 15:04:07 -0700 | [diff] [blame] | 135 | |
| 136 | class TestAnnotations { |
| 137 | public: |
| 138 | TestAnnotations() : test_var_(false) {} |
| 139 | |
| 140 | void ModifyTestVar() { |
| 141 | RTC_DCHECK_CALLED_SEQUENTIALLY(&checker_); |
| 142 | test_var_ = true; |
| 143 | } |
| 144 | |
| 145 | private: |
danilchap | 3c6abd2 | 2017-09-06 05:46:29 -0700 | [diff] [blame] | 146 | bool test_var_ RTC_GUARDED_BY(&checker_); |
perkj | 9c16fe8 | 2016-07-12 15:04:07 -0700 | [diff] [blame] | 147 | SequencedTaskChecker checker_; |
| 148 | }; |
| 149 | |
| 150 | TEST(SequencedTaskCheckerTest, TestAnnotations) { |
| 151 | TestAnnotations annotations; |
| 152 | annotations.ModifyTestVar(); |
| 153 | } |
| 154 | |
| 155 | #if GTEST_HAS_DEATH_TEST && !defined(WEBRTC_ANDROID) |
| 156 | |
| 157 | void TestAnnotationsOnWrongQueue() { |
| 158 | TestAnnotations annotations; |
Danil Chapovalov | 2214b91 | 2019-03-25 15:13:59 +0100 | [diff] [blame] | 159 | TaskQueueForTest queue; |
| 160 | queue.SendTask([&] { annotations.ModifyTestVar(); }); |
perkj | 9c16fe8 | 2016-07-12 15:04:07 -0700 | [diff] [blame] | 161 | } |
| 162 | |
| 163 | #if RTC_DCHECK_IS_ON |
| 164 | TEST(SequencedTaskCheckerTest, TestAnnotationsOnWrongQueueDebug) { |
| 165 | ASSERT_DEATH({ TestAnnotationsOnWrongQueue(); }, ""); |
| 166 | } |
| 167 | #else |
| 168 | TEST(SequencedTaskCheckerTest, TestAnnotationsOnWrongQueueRelease) { |
| 169 | TestAnnotationsOnWrongQueue(); |
| 170 | } |
| 171 | #endif |
| 172 | #endif // GTEST_HAS_DEATH_TEST |
| 173 | } // namespace rtc |