tommycli@chromium.org | 623e16c | 2013-07-31 04:26:40 +0900 | [diff] [blame] | 1 | // Copyright 2013 The Chromium Authors. All rights reserved. |
akalin@chromium.org | 4fb2deb | 2012-12-28 04:58:00 +0900 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
avi | a6a6a68 | 2015-12-27 07:15:14 +0900 | [diff] [blame] | 5 | #include <stddef.h> |
| 6 | |
dcheng | cc8e4d8 | 2016-04-05 06:25:51 +0900 | [diff] [blame] | 7 | #include <memory> |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 8 | #include <string> |
danakj | 800d2ea | 2015-11-25 14:29:58 +0900 | [diff] [blame] | 9 | |
tommycli@chromium.org | 623e16c | 2013-07-31 04:26:40 +0900 | [diff] [blame] | 10 | #include "base/bind.h" |
| 11 | #include "base/bind_helpers.h" |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 12 | #include "base/callback_forward.h" |
avi | a6a6a68 | 2015-12-27 07:15:14 +0900 | [diff] [blame] | 13 | #include "base/macros.h" |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 14 | #include "base/message_loop/message_loop.h" |
| 15 | #include "base/sequence_checker_impl.h" |
| 16 | #include "base/sequence_token.h" |
skyostil | 97aefe1 | 2015-05-01 04:06:15 +0900 | [diff] [blame] | 17 | #include "base/single_thread_task_runner.h" |
tommycli@chromium.org | 623e16c | 2013-07-31 04:26:40 +0900 | [diff] [blame] | 18 | #include "base/test/sequenced_worker_pool_owner.h" |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 19 | #include "base/threading/simple_thread.h" |
dewittj@chromium.org | fadd934 | 2013-07-27 02:10:02 +0900 | [diff] [blame] | 20 | #include "testing/gtest/include/gtest/gtest.h" |
tommycli@chromium.org | 755085a | 2013-07-26 23:23:56 +0900 | [diff] [blame] | 21 | |
akalin@chromium.org | 4fb2deb | 2012-12-28 04:58:00 +0900 | [diff] [blame] | 22 | namespace base { |
| 23 | |
| 24 | namespace { |
| 25 | |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 26 | constexpr size_t kNumWorkerThreads = 3; |
tommycli@chromium.org | 623e16c | 2013-07-31 04:26:40 +0900 | [diff] [blame] | 27 | |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 28 | // Runs a callback on another thread. |
| 29 | class RunCallbackThread : public SimpleThread { |
tommycli@chromium.org | 623e16c | 2013-07-31 04:26:40 +0900 | [diff] [blame] | 30 | public: |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 31 | explicit RunCallbackThread(const Closure& callback) |
| 32 | : SimpleThread("RunCallbackThread"), callback_(callback) { |
| 33 | Start(); |
| 34 | Join(); |
tommycli@chromium.org | 623e16c | 2013-07-31 04:26:40 +0900 | [diff] [blame] | 35 | } |
| 36 | |
| 37 | private: |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 38 | // SimpleThread: |
| 39 | void Run() override { callback_.Run(); } |
tommycli@chromium.org | 623e16c | 2013-07-31 04:26:40 +0900 | [diff] [blame] | 40 | |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 41 | const Closure callback_; |
| 42 | |
| 43 | DISALLOW_COPY_AND_ASSIGN(RunCallbackThread); |
tommycli@chromium.org | 623e16c | 2013-07-31 04:26:40 +0900 | [diff] [blame] | 44 | }; |
| 45 | |
| 46 | class SequenceCheckerTest : public testing::Test { |
tommycli@chromium.org | 623e16c | 2013-07-31 04:26:40 +0900 | [diff] [blame] | 47 | protected: |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 48 | SequenceCheckerTest() : pool_owner_(kNumWorkerThreads, "test") {} |
tommycli@chromium.org | 623e16c | 2013-07-31 04:26:40 +0900 | [diff] [blame] | 49 | |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 50 | void PostToSequencedWorkerPool(const Closure& callback, |
| 51 | const std::string& token_name) { |
| 52 | pool_owner_.pool()->PostNamedSequencedWorkerTask(token_name, FROM_HERE, |
| 53 | callback); |
tommycli@chromium.org | 623e16c | 2013-07-31 04:26:40 +0900 | [diff] [blame] | 54 | } |
| 55 | |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 56 | void FlushSequencedWorkerPoolForTesting() { |
| 57 | pool_owner_.pool()->FlushForTesting(); |
tommycli@chromium.org | 623e16c | 2013-07-31 04:26:40 +0900 | [diff] [blame] | 58 | } |
| 59 | |
tommycli@chromium.org | 623e16c | 2013-07-31 04:26:40 +0900 | [diff] [blame] | 60 | private: |
| 61 | MessageLoop message_loop_; // Needed by SequencedWorkerPool to function. |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 62 | SequencedWorkerPoolOwner pool_owner_; |
| 63 | |
| 64 | DISALLOW_COPY_AND_ASSIGN(SequenceCheckerTest); |
tommycli@chromium.org | 623e16c | 2013-07-31 04:26:40 +0900 | [diff] [blame] | 65 | }; |
| 66 | |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 67 | void ExpectCalledOnValidSequence(SequenceCheckerImpl* sequence_checker) { |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 68 | ASSERT_TRUE(sequence_checker); |
tommycli@chromium.org | 623e16c | 2013-07-31 04:26:40 +0900 | [diff] [blame] | 69 | |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 70 | // This should bind |sequence_checker| to the current sequence if it wasn't |
| 71 | // already bound to a sequence. |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 72 | EXPECT_TRUE(sequence_checker->CalledOnValidSequence()); |
tommycli@chromium.org | 623e16c | 2013-07-31 04:26:40 +0900 | [diff] [blame] | 73 | |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 74 | // Since |sequence_checker| is now bound to the current sequence, another call |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 75 | // to CalledOnValidSequence() should return true. |
| 76 | EXPECT_TRUE(sequence_checker->CalledOnValidSequence()); |
akalin@chromium.org | 4fb2deb | 2012-12-28 04:58:00 +0900 | [diff] [blame] | 77 | } |
| 78 | |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 79 | void ExpectCalledOnValidSequenceWithSequenceToken( |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 80 | SequenceCheckerImpl* sequence_checker, |
| 81 | SequenceToken sequence_token) { |
| 82 | ScopedSetSequenceTokenForCurrentThread |
| 83 | scoped_set_sequence_token_for_current_thread(sequence_token); |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 84 | ExpectCalledOnValidSequence(sequence_checker); |
tommycli@chromium.org | 623e16c | 2013-07-31 04:26:40 +0900 | [diff] [blame] | 85 | } |
| 86 | |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 87 | void ExpectNotCalledOnValidSequence(SequenceCheckerImpl* sequence_checker) { |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 88 | ASSERT_TRUE(sequence_checker); |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 89 | EXPECT_FALSE(sequence_checker->CalledOnValidSequence()); |
tommycli@chromium.org | 623e16c | 2013-07-31 04:26:40 +0900 | [diff] [blame] | 90 | } |
| 91 | |
akalin@chromium.org | 4fb2deb | 2012-12-28 04:58:00 +0900 | [diff] [blame] | 92 | } // namespace |
| 93 | |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 94 | TEST_F(SequenceCheckerTest, CallsAllowedOnSameThreadNoSequenceToken) { |
| 95 | SequenceCheckerImpl sequence_checker; |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 96 | EXPECT_TRUE(sequence_checker.CalledOnValidSequence()); |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 97 | } |
tommycli@chromium.org | 623e16c | 2013-07-31 04:26:40 +0900 | [diff] [blame] | 98 | |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 99 | TEST_F(SequenceCheckerTest, CallsAllowedOnSameThreadSameSequenceToken) { |
| 100 | ScopedSetSequenceTokenForCurrentThread |
| 101 | scoped_set_sequence_token_for_current_thread(SequenceToken::Create()); |
| 102 | SequenceCheckerImpl sequence_checker; |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 103 | EXPECT_TRUE(sequence_checker.CalledOnValidSequence()); |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 104 | } |
| 105 | |
| 106 | TEST_F(SequenceCheckerTest, CallsDisallowedOnDifferentThreadsNoSequenceToken) { |
| 107 | SequenceCheckerImpl sequence_checker; |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 108 | RunCallbackThread thread( |
| 109 | Bind(&ExpectNotCalledOnValidSequence, Unretained(&sequence_checker))); |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 110 | } |
| 111 | |
| 112 | TEST_F(SequenceCheckerTest, CallsAllowedOnDifferentThreadsSameSequenceToken) { |
| 113 | const SequenceToken sequence_token(SequenceToken::Create()); |
| 114 | |
| 115 | ScopedSetSequenceTokenForCurrentThread |
| 116 | scoped_set_sequence_token_for_current_thread(sequence_token); |
| 117 | SequenceCheckerImpl sequence_checker; |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 118 | EXPECT_TRUE(sequence_checker.CalledOnValidSequence()); |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 119 | |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 120 | RunCallbackThread thread(Bind(&ExpectCalledOnValidSequenceWithSequenceToken, |
| 121 | Unretained(&sequence_checker), sequence_token)); |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 122 | } |
| 123 | |
| 124 | TEST_F(SequenceCheckerTest, CallsDisallowedOnSameThreadDifferentSequenceToken) { |
| 125 | std::unique_ptr<SequenceCheckerImpl> sequence_checker; |
| 126 | |
| 127 | { |
| 128 | ScopedSetSequenceTokenForCurrentThread |
| 129 | scoped_set_sequence_token_for_current_thread(SequenceToken::Create()); |
| 130 | sequence_checker.reset(new SequenceCheckerImpl); |
| 131 | } |
| 132 | |
| 133 | { |
| 134 | // Different SequenceToken. |
| 135 | ScopedSetSequenceTokenForCurrentThread |
| 136 | scoped_set_sequence_token_for_current_thread(SequenceToken::Create()); |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 137 | EXPECT_FALSE(sequence_checker->CalledOnValidSequence()); |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 138 | } |
| 139 | |
| 140 | // No SequenceToken. |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 141 | EXPECT_FALSE(sequence_checker->CalledOnValidSequence()); |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 142 | } |
| 143 | |
| 144 | TEST_F(SequenceCheckerTest, DetachFromSequence) { |
| 145 | std::unique_ptr<SequenceCheckerImpl> sequence_checker; |
| 146 | |
| 147 | { |
| 148 | ScopedSetSequenceTokenForCurrentThread |
| 149 | scoped_set_sequence_token_for_current_thread(SequenceToken::Create()); |
| 150 | sequence_checker.reset(new SequenceCheckerImpl); |
| 151 | } |
| 152 | |
| 153 | sequence_checker->DetachFromSequence(); |
| 154 | |
| 155 | { |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 156 | // Verify that CalledOnValidSequence() returns true when called with |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 157 | // a different sequence token after a call to DetachFromSequence(). |
| 158 | ScopedSetSequenceTokenForCurrentThread |
| 159 | scoped_set_sequence_token_for_current_thread(SequenceToken::Create()); |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 160 | EXPECT_TRUE(sequence_checker->CalledOnValidSequence()); |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 161 | } |
| 162 | } |
| 163 | |
| 164 | TEST_F(SequenceCheckerTest, DetachFromSequenceNoSequenceToken) { |
| 165 | SequenceCheckerImpl sequence_checker; |
| 166 | sequence_checker.DetachFromSequence(); |
| 167 | |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 168 | // Verify that CalledOnValidSequence() returns true when called on a |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 169 | // different thread after a call to DetachFromSequence(). |
| 170 | RunCallbackThread thread( |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 171 | Bind(&ExpectCalledOnValidSequence, Unretained(&sequence_checker))); |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 172 | |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 173 | EXPECT_FALSE(sequence_checker.CalledOnValidSequence()); |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 174 | } |
| 175 | |
| 176 | TEST_F(SequenceCheckerTest, SequencedWorkerPool_SameSequenceTokenValid) { |
| 177 | SequenceCheckerImpl sequence_checker; |
| 178 | sequence_checker.DetachFromSequence(); |
| 179 | |
| 180 | PostToSequencedWorkerPool( |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 181 | Bind(&ExpectCalledOnValidSequence, Unretained(&sequence_checker)), "A"); |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 182 | PostToSequencedWorkerPool( |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 183 | Bind(&ExpectCalledOnValidSequence, Unretained(&sequence_checker)), "A"); |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 184 | FlushSequencedWorkerPoolForTesting(); |
| 185 | } |
| 186 | |
| 187 | TEST_F(SequenceCheckerTest, SequencedWorkerPool_DetachSequenceTokenValid) { |
| 188 | SequenceCheckerImpl sequence_checker; |
| 189 | sequence_checker.DetachFromSequence(); |
| 190 | |
| 191 | PostToSequencedWorkerPool( |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 192 | Bind(&ExpectCalledOnValidSequence, Unretained(&sequence_checker)), "A"); |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 193 | PostToSequencedWorkerPool( |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 194 | Bind(&ExpectCalledOnValidSequence, Unretained(&sequence_checker)), "A"); |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 195 | FlushSequencedWorkerPoolForTesting(); |
| 196 | |
| 197 | sequence_checker.DetachFromSequence(); |
| 198 | |
| 199 | PostToSequencedWorkerPool( |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 200 | Bind(&ExpectCalledOnValidSequence, Unretained(&sequence_checker)), "B"); |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 201 | PostToSequencedWorkerPool( |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 202 | Bind(&ExpectCalledOnValidSequence, Unretained(&sequence_checker)), "B"); |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 203 | FlushSequencedWorkerPoolForTesting(); |
| 204 | } |
| 205 | |
| 206 | TEST_F(SequenceCheckerTest, |
| 207 | SequencedWorkerPool_DifferentSequenceTokensInvalid) { |
| 208 | SequenceCheckerImpl sequence_checker; |
| 209 | sequence_checker.DetachFromSequence(); |
| 210 | |
| 211 | PostToSequencedWorkerPool( |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 212 | Bind(&ExpectCalledOnValidSequence, Unretained(&sequence_checker)), "A"); |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 213 | PostToSequencedWorkerPool( |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 214 | Bind(&ExpectCalledOnValidSequence, Unretained(&sequence_checker)), "A"); |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 215 | FlushSequencedWorkerPoolForTesting(); |
| 216 | |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 217 | PostToSequencedWorkerPool( |
| 218 | Bind(&ExpectNotCalledOnValidSequence, Unretained(&sequence_checker)), |
| 219 | "B"); |
| 220 | PostToSequencedWorkerPool( |
| 221 | Bind(&ExpectNotCalledOnValidSequence, Unretained(&sequence_checker)), |
| 222 | "B"); |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 223 | FlushSequencedWorkerPoolForTesting(); |
| 224 | } |
| 225 | |
| 226 | TEST_F(SequenceCheckerTest, |
| 227 | SequencedWorkerPool_WorkerPoolAndSimpleThreadInvalid) { |
| 228 | SequenceCheckerImpl sequence_checker; |
| 229 | sequence_checker.DetachFromSequence(); |
| 230 | |
| 231 | PostToSequencedWorkerPool( |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 232 | Bind(&ExpectCalledOnValidSequence, Unretained(&sequence_checker)), "A"); |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 233 | PostToSequencedWorkerPool( |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 234 | Bind(&ExpectCalledOnValidSequence, Unretained(&sequence_checker)), "A"); |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 235 | FlushSequencedWorkerPoolForTesting(); |
| 236 | |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 237 | EXPECT_FALSE(sequence_checker.CalledOnValidSequence()); |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 238 | } |
| 239 | |
| 240 | TEST_F(SequenceCheckerTest, |
| 241 | SequencedWorkerPool_TwoDifferentWorkerPoolsInvalid) { |
| 242 | SequenceCheckerImpl sequence_checker; |
| 243 | sequence_checker.DetachFromSequence(); |
| 244 | |
| 245 | PostToSequencedWorkerPool( |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 246 | Bind(&ExpectCalledOnValidSequence, Unretained(&sequence_checker)), "A"); |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 247 | PostToSequencedWorkerPool( |
fdoray | e4a5827 | 2016-07-29 11:30:16 +0900 | [diff] [blame] | 248 | Bind(&ExpectCalledOnValidSequence, Unretained(&sequence_checker)), "A"); |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 249 | FlushSequencedWorkerPoolForTesting(); |
| 250 | |
| 251 | SequencedWorkerPoolOwner second_pool_owner(kNumWorkerThreads, "test2"); |
| 252 | second_pool_owner.pool()->PostNamedSequencedWorkerTask( |
tzik | 6bdbeb2 | 2017-04-12 00:00:44 +0900 | [diff] [blame] | 253 | "A", FROM_HERE, |
| 254 | base::BindOnce(&ExpectNotCalledOnValidSequence, |
| 255 | base::Unretained(&sequence_checker))); |
fdoray | 4bcf108 | 2016-07-27 07:28:45 +0900 | [diff] [blame] | 256 | second_pool_owner.pool()->FlushForTesting(); |
| 257 | } |
| 258 | |
| 259 | } // namespace base |