thread_checker_unittest.cc 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353
  1. // Copyright (c) 2012 The Chromium Authors. All rights reserved.
  2. // Use of this source code is governed by a BSD-style license that can be
  3. // found in the LICENSE file.
  4. #include "base/threading/thread_checker.h"
  5. #include <memory>
  6. #include "base/bind.h"
  7. #include "base/callback_helpers.h"
  8. #include "base/memory/ref_counted.h"
  9. #include "base/sequence_token.h"
  10. #include "base/test/bind.h"
  11. #include "base/test/gtest_util.h"
  12. #include "base/test/test_simple_task_runner.h"
  13. #include "base/threading/simple_thread.h"
  14. #include "base/threading/thread_local.h"
  15. #include "base/threading/thread_task_runner_handle.h"
  16. #include "testing/gtest/include/gtest/gtest.h"
  17. namespace base {
  18. namespace {
  19. // A thread that runs a callback.
  20. class RunCallbackThread : public SimpleThread {
  21. public:
  22. explicit RunCallbackThread(OnceClosure callback)
  23. : SimpleThread("RunCallbackThread"), callback_(std::move(callback)) {}
  24. RunCallbackThread(const RunCallbackThread&) = delete;
  25. RunCallbackThread& operator=(const RunCallbackThread&) = delete;
  26. private:
  27. // SimpleThread:
  28. void Run() override { std::move(callback_).Run(); }
  29. OnceClosure callback_;
  30. };
  31. // Runs a callback on a new thread synchronously.
  32. void RunCallbackOnNewThreadSynchronously(OnceClosure callback) {
  33. RunCallbackThread run_callback_thread(std::move(callback));
  34. run_callback_thread.Start();
  35. run_callback_thread.Join();
  36. }
  37. void ExpectCalledOnValidThread(ThreadCheckerImpl* thread_checker) {
  38. ASSERT_TRUE(thread_checker);
  39. // This should bind |thread_checker| to the current thread if it wasn't
  40. // already bound to a thread.
  41. EXPECT_TRUE(thread_checker->CalledOnValidThread());
  42. // Since |thread_checker| is now bound to the current thread, another call to
  43. // CalledOnValidThread() should return true.
  44. EXPECT_TRUE(thread_checker->CalledOnValidThread());
  45. }
  46. void ExpectNotCalledOnValidThread(ThreadCheckerImpl* thread_checker) {
  47. ASSERT_TRUE(thread_checker);
  48. EXPECT_FALSE(thread_checker->CalledOnValidThread());
  49. }
  50. void ExpectNotCalledOnValidThreadWithSequenceTokenAndThreadTaskRunnerHandle(
  51. ThreadCheckerImpl* thread_checker,
  52. SequenceToken sequence_token) {
  53. ThreadTaskRunnerHandle thread_task_runner_handle(
  54. MakeRefCounted<TestSimpleTaskRunner>());
  55. ScopedSetSequenceTokenForCurrentThread
  56. scoped_set_sequence_token_for_current_thread(sequence_token);
  57. ExpectNotCalledOnValidThread(thread_checker);
  58. }
  59. } // namespace
  60. TEST(ThreadCheckerTest, AllowedSameThreadNoSequenceToken) {
  61. ThreadCheckerImpl thread_checker;
  62. EXPECT_TRUE(thread_checker.CalledOnValidThread());
  63. }
  64. TEST(ThreadCheckerTest,
  65. AllowedSameThreadAndSequenceDifferentTasksWithThreadTaskRunnerHandle) {
  66. ThreadTaskRunnerHandle thread_task_runner_handle(
  67. MakeRefCounted<TestSimpleTaskRunner>());
  68. std::unique_ptr<ThreadCheckerImpl> thread_checker;
  69. const SequenceToken sequence_token = SequenceToken::Create();
  70. {
  71. ScopedSetSequenceTokenForCurrentThread
  72. scoped_set_sequence_token_for_current_thread(sequence_token);
  73. thread_checker = std::make_unique<ThreadCheckerImpl>();
  74. }
  75. {
  76. ScopedSetSequenceTokenForCurrentThread
  77. scoped_set_sequence_token_for_current_thread(sequence_token);
  78. EXPECT_TRUE(thread_checker->CalledOnValidThread());
  79. }
  80. }
  81. TEST(ThreadCheckerTest,
  82. AllowedSameThreadSequenceAndTaskNoThreadTaskRunnerHandle) {
  83. ScopedSetSequenceTokenForCurrentThread
  84. scoped_set_sequence_token_for_current_thread(SequenceToken::Create());
  85. ThreadCheckerImpl thread_checker;
  86. EXPECT_TRUE(thread_checker.CalledOnValidThread());
  87. }
  88. TEST(ThreadCheckerTest,
  89. DisallowedSameThreadAndSequenceDifferentTasksNoThreadTaskRunnerHandle) {
  90. std::unique_ptr<ThreadCheckerImpl> thread_checker;
  91. {
  92. ScopedSetSequenceTokenForCurrentThread
  93. scoped_set_sequence_token_for_current_thread(SequenceToken::Create());
  94. thread_checker = std::make_unique<ThreadCheckerImpl>();
  95. }
  96. {
  97. ScopedSetSequenceTokenForCurrentThread
  98. scoped_set_sequence_token_for_current_thread(SequenceToken::Create());
  99. EXPECT_FALSE(thread_checker->CalledOnValidThread());
  100. }
  101. }
  102. TEST(ThreadCheckerTest, DisallowedDifferentThreadsNoSequenceToken) {
  103. ThreadCheckerImpl thread_checker;
  104. RunCallbackOnNewThreadSynchronously(
  105. BindOnce(&ExpectNotCalledOnValidThread, Unretained(&thread_checker)));
  106. }
  107. TEST(ThreadCheckerTest, DisallowedDifferentThreadsSameSequence) {
  108. ThreadTaskRunnerHandle thread_task_runner_handle(
  109. MakeRefCounted<TestSimpleTaskRunner>());
  110. const SequenceToken sequence_token(SequenceToken::Create());
  111. ScopedSetSequenceTokenForCurrentThread
  112. scoped_set_sequence_token_for_current_thread(sequence_token);
  113. ThreadCheckerImpl thread_checker;
  114. EXPECT_TRUE(thread_checker.CalledOnValidThread());
  115. RunCallbackOnNewThreadSynchronously(BindOnce(
  116. &ExpectNotCalledOnValidThreadWithSequenceTokenAndThreadTaskRunnerHandle,
  117. Unretained(&thread_checker), sequence_token));
  118. }
  119. TEST(ThreadCheckerTest, DisallowedSameThreadDifferentSequence) {
  120. std::unique_ptr<ThreadCheckerImpl> thread_checker;
  121. ThreadTaskRunnerHandle thread_task_runner_handle(
  122. MakeRefCounted<TestSimpleTaskRunner>());
  123. {
  124. ScopedSetSequenceTokenForCurrentThread
  125. scoped_set_sequence_token_for_current_thread(SequenceToken::Create());
  126. thread_checker = std::make_unique<ThreadCheckerImpl>();
  127. }
  128. {
  129. // Different SequenceToken.
  130. ScopedSetSequenceTokenForCurrentThread
  131. scoped_set_sequence_token_for_current_thread(SequenceToken::Create());
  132. EXPECT_FALSE(thread_checker->CalledOnValidThread());
  133. }
  134. // No SequenceToken.
  135. EXPECT_FALSE(thread_checker->CalledOnValidThread());
  136. }
  137. TEST(ThreadCheckerTest, DetachFromThread) {
  138. ThreadCheckerImpl thread_checker;
  139. thread_checker.DetachFromThread();
  140. // Verify that CalledOnValidThread() returns true when called on a different
  141. // thread after a call to DetachFromThread().
  142. RunCallbackOnNewThreadSynchronously(
  143. BindOnce(&ExpectCalledOnValidThread, Unretained(&thread_checker)));
  144. EXPECT_FALSE(thread_checker.CalledOnValidThread());
  145. }
  146. TEST(ThreadCheckerTest, DetachFromThreadWithSequenceToken) {
  147. ThreadTaskRunnerHandle thread_task_runner_handle(
  148. MakeRefCounted<TestSimpleTaskRunner>());
  149. ScopedSetSequenceTokenForCurrentThread
  150. scoped_set_sequence_token_for_current_thread(SequenceToken::Create());
  151. ThreadCheckerImpl thread_checker;
  152. thread_checker.DetachFromThread();
  153. // Verify that CalledOnValidThread() returns true when called on a different
  154. // thread after a call to DetachFromThread().
  155. RunCallbackOnNewThreadSynchronously(
  156. BindOnce(&ExpectCalledOnValidThread, Unretained(&thread_checker)));
  157. EXPECT_FALSE(thread_checker.CalledOnValidThread());
  158. }
  159. // Owns a ThreadCheckerImpl and asserts that CalledOnValidThread() is valid
  160. // in ~ThreadCheckerOwner.
  161. class ThreadCheckerOwner {
  162. public:
  163. explicit ThreadCheckerOwner(bool detach_from_thread) {
  164. if (detach_from_thread)
  165. checker_.DetachFromThread();
  166. }
  167. ThreadCheckerOwner(const ThreadCheckerOwner&) = delete;
  168. ThreadCheckerOwner& operator=(const ThreadCheckerOwner&) = delete;
  169. ~ThreadCheckerOwner() { EXPECT_TRUE(checker_.CalledOnValidThread()); }
  170. private:
  171. ThreadCheckerImpl checker_;
  172. };
  173. // Verifies ThreadCheckerImpl::CalledOnValidThread() returns true if called
  174. // during thread destruction.
  175. TEST(ThreadCheckerTest, CalledOnValidThreadFromThreadDestruction) {
  176. ThreadLocalOwnedPointer<ThreadCheckerOwner> thread_local_owner;
  177. RunCallbackOnNewThreadSynchronously(BindLambdaForTesting([&]() {
  178. thread_local_owner.Set(std::make_unique<ThreadCheckerOwner>(false));
  179. }));
  180. }
  181. // Variant of CalledOnValidThreadFromThreadDestruction that calls
  182. // ThreadCheckerImpl::DetachFromThread().
  183. TEST(ThreadCheckerTest, CalledOnValidThreadFromThreadDestructionDetached) {
  184. ThreadLocalOwnedPointer<ThreadCheckerOwner> thread_local_owner;
  185. RunCallbackOnNewThreadSynchronously(BindLambdaForTesting([&]() {
  186. thread_local_owner.Set(std::make_unique<ThreadCheckerOwner>(true));
  187. }));
  188. }
  189. TEST(ThreadCheckerTest, Move) {
  190. ThreadCheckerImpl initial;
  191. EXPECT_TRUE(initial.CalledOnValidThread());
  192. ThreadCheckerImpl move_constructed(std::move(initial));
  193. EXPECT_TRUE(move_constructed.CalledOnValidThread());
  194. ThreadCheckerImpl move_assigned;
  195. move_assigned = std::move(move_constructed);
  196. EXPECT_TRUE(move_assigned.CalledOnValidThread());
  197. // The two ThreadCheckerImpls moved from should be able to rebind to another
  198. // thread.
  199. RunCallbackOnNewThreadSynchronously(
  200. BindOnce(&ExpectCalledOnValidThread, Unretained(&initial)));
  201. RunCallbackOnNewThreadSynchronously(
  202. BindOnce(&ExpectCalledOnValidThread, Unretained(&move_constructed)));
  203. // But the latest one shouldn't be able to run on another thread.
  204. RunCallbackOnNewThreadSynchronously(
  205. BindOnce(&ExpectNotCalledOnValidThread, Unretained(&move_assigned)));
  206. EXPECT_TRUE(move_assigned.CalledOnValidThread());
  207. }
  208. TEST(ThreadCheckerTest, MoveAssignIntoDetached) {
  209. ThreadCheckerImpl initial;
  210. ThreadCheckerImpl move_assigned;
  211. move_assigned.DetachFromThread();
  212. move_assigned = std::move(initial);
  213. // |initial| is detached after move.
  214. RunCallbackOnNewThreadSynchronously(
  215. BindOnce(&ExpectCalledOnValidThread, Unretained(&initial)));
  216. // |move_assigned| should be associated with the main thread.
  217. RunCallbackOnNewThreadSynchronously(
  218. BindOnce(&ExpectNotCalledOnValidThread, Unretained(&move_assigned)));
  219. EXPECT_TRUE(move_assigned.CalledOnValidThread());
  220. }
  221. TEST(ThreadCheckerTest, MoveFromDetachedRebinds) {
  222. ThreadCheckerImpl initial;
  223. initial.DetachFromThread();
  224. ThreadCheckerImpl moved_into(std::move(initial));
  225. // |initial| is still detached after move.
  226. RunCallbackOnNewThreadSynchronously(
  227. BindOnce(&ExpectCalledOnValidThread, Unretained(&initial)));
  228. // |moved_into| is bound to the current thread as part of the move.
  229. RunCallbackOnNewThreadSynchronously(
  230. BindOnce(&ExpectNotCalledOnValidThread, Unretained(&moved_into)));
  231. EXPECT_TRUE(moved_into.CalledOnValidThread());
  232. }
  233. TEST(ThreadCheckerTest, MoveOffThreadBanned) {
  234. testing::GTEST_FLAG(death_test_style) = "threadsafe";
  235. ThreadCheckerImpl other_thread;
  236. other_thread.DetachFromThread();
  237. RunCallbackOnNewThreadSynchronously(
  238. BindOnce(&ExpectCalledOnValidThread, Unretained(&other_thread)));
  239. EXPECT_DCHECK_DEATH(ThreadCheckerImpl main_thread(std::move(other_thread)));
  240. }
  241. namespace {
  242. // This fixture is a helper for unit testing the thread checker macros as it is
  243. // not possible to inline ExpectDeathOnOtherThread() and
  244. // ExpectNoDeathOnOtherThreadAfterDetach() as lambdas since binding
  245. // |Unretained(&my_sequence_checker)| wouldn't compile on non-dcheck builds
  246. // where it won't be defined.
  247. class ThreadCheckerMacroTest : public testing::Test {
  248. public:
  249. ThreadCheckerMacroTest() = default;
  250. ThreadCheckerMacroTest(const ThreadCheckerMacroTest&) = delete;
  251. ThreadCheckerMacroTest& operator=(const ThreadCheckerMacroTest&) = delete;
  252. void ExpectDeathOnOtherThread() {
  253. #if DCHECK_IS_ON()
  254. EXPECT_DCHECK_DEATH({ DCHECK_CALLED_ON_VALID_THREAD(thread_checker_); });
  255. #else
  256. // Happily no-ops on non-dcheck builds.
  257. DCHECK_CALLED_ON_VALID_THREAD(thread_checker_);
  258. #endif
  259. }
  260. void ExpectNoDeathOnOtherThreadAfterDetach() {
  261. DCHECK_CALLED_ON_VALID_THREAD(thread_checker_);
  262. }
  263. protected:
  264. THREAD_CHECKER(thread_checker_);
  265. };
  266. } // namespace
  267. TEST_F(ThreadCheckerMacroTest, Macros) {
  268. testing::GTEST_FLAG(death_test_style) = "threadsafe";
  269. THREAD_CHECKER(my_thread_checker);
  270. RunCallbackOnNewThreadSynchronously(BindOnce(
  271. &ThreadCheckerMacroTest::ExpectDeathOnOtherThread, Unretained(this)));
  272. DETACH_FROM_THREAD(thread_checker_);
  273. RunCallbackOnNewThreadSynchronously(
  274. BindOnce(&ThreadCheckerMacroTest::ExpectNoDeathOnOtherThreadAfterDetach,
  275. Unretained(this)));
  276. }
  277. } // namespace base