blob: 93fd5fb34fd9e54e11b17dd1d29fa52f9f8dcc23 [file] [log] [blame]
Avi Drissmane4622aa2022-09-08 20:36:061// Copyright 2016 The Chromium Authors
fdoraya4f28ec2016-06-10 00:08:582// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#include "base/run_loop.h"
6
jdoerrie9d7236f62019-03-05 13:00:237#include <functional>
David Bienvenu5f4d4f02020-09-27 16:55:038#include <memory>
Gabriel Charettee2b632b2017-08-02 03:52:169#include <utility>
10
fdoraya4f28ec2016-06-10 00:08:5811#include "base/bind.h"
danakjdb9ae7942020-11-11 16:01:3512#include "base/callback_helpers.h"
Brett Wilsona62d9c02017-09-20 20:53:2013#include "base/containers/queue.h"
fdoraya4f28ec2016-06-10 00:08:5814#include "base/location.h"
Gabriel Charettee2b632b2017-08-02 03:52:1615#include "base/memory/ptr_util.h"
16#include "base/memory/ref_counted.h"
Gabriel Charettee2b632b2017-08-02 03:52:1617#include "base/synchronization/lock.h"
gabcf5e4ce2017-05-19 22:56:5718#include "base/synchronization/waitable_event.h"
Sean Maher7d0e8052022-12-09 01:46:3219#include "base/task/sequenced_task_runner.h"
Patrick Monette643cdf62021-10-15 19:13:4220#include "base/task/single_thread_task_runner.h"
Guido Urdanetaef4e91942020-11-09 15:06:2421#include "base/test/bind.h"
Gabriel Charettee2b632b2017-08-02 03:52:1622#include "base/test/gtest_util.h"
Wez9d5dd282020-02-10 17:21:2223#include "base/test/scoped_run_loop_timeout.h"
Gabriel Charettec7108742019-08-23 03:31:4024#include "base/test/task_environment.h"
Gabriel Charette3ff403e2017-08-07 04:22:4825#include "base/test/test_timeouts.h"
Gabriel Charettee2b632b2017-08-02 03:52:1626#include "base/threading/platform_thread.h"
27#include "base/threading/thread.h"
28#include "base/threading/thread_checker_impl.h"
Gabriel Charettee2b632b2017-08-02 03:52:1629#include "build/build_config.h"
gab7af9dc02017-05-05 13:38:5430#include "testing/gmock/include/gmock/gmock.h"
fdoraya4f28ec2016-06-10 00:08:5831#include "testing/gtest/include/gtest/gtest.h"
32
33namespace base {
34
35namespace {
36
37void QuitWhenIdleTask(RunLoop* run_loop, int* counter) {
38 run_loop->QuitWhenIdle();
39 ++(*counter);
40}
41
fdoraya4f28ec2016-06-10 00:08:5842void RunNestedLoopTask(int* counter) {
Gabriel Charette3ff403e2017-08-07 04:22:4843 RunLoop nested_run_loop(RunLoop::Type::kNestableTasksAllowed);
fdoraya4f28ec2016-06-10 00:08:5844
45 // This task should quit |nested_run_loop| but not the main RunLoop.
Sean Maher7d0e8052022-12-09 01:46:3246 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
tzik92b7a422017-04-11 15:00:4447 FROM_HERE, BindOnce(&QuitWhenIdleTask, Unretained(&nested_run_loop),
48 Unretained(counter)));
fdoraya4f28ec2016-06-10 00:08:5849
Sean Maher7d0e8052022-12-09 01:46:3250 SingleThreadTaskRunner::GetCurrentDefault()->PostDelayedTask(
Peter Kasting53fd6ee2021-10-05 20:40:4851 FROM_HERE, MakeExpectedNotRunClosure(FROM_HERE), Days(1));
fdoraya4f28ec2016-06-10 00:08:5852
fdoraya4f28ec2016-06-10 00:08:5853 nested_run_loop.Run();
54
55 ++(*counter);
56}
57
Gabriel Charettee2b632b2017-08-02 03:52:1658// A simple SingleThreadTaskRunner that just queues undelayed tasks (and ignores
59// delayed tasks). Tasks can then be processed one by one by ProcessTask() which
60// will return true if it processed a task and false otherwise.
61class SimpleSingleThreadTaskRunner : public SingleThreadTaskRunner {
62 public:
63 SimpleSingleThreadTaskRunner() = default;
David Bienvenu5f4d4f02020-09-27 16:55:0364 SimpleSingleThreadTaskRunner(const SimpleSingleThreadTaskRunner&) = delete;
65 SimpleSingleThreadTaskRunner& operator=(const SimpleSingleThreadTaskRunner&) =
66 delete;
fdoraya4f28ec2016-06-10 00:08:5867
Brett Wilson8e88b312017-09-12 05:22:1668 bool PostDelayedTask(const Location& from_here,
Gabriel Charettee2b632b2017-08-02 03:52:1669 OnceClosure task,
70 base::TimeDelta delay) override {
Xiaohan Wangabff0302021-10-27 00:42:5771 if (delay.is_positive())
Gabriel Charettee2b632b2017-08-02 03:52:1672 return false;
73 AutoLock auto_lock(tasks_lock_);
74 pending_tasks_.push(std::move(task));
75 return true;
76 }
77
Brett Wilson8e88b312017-09-12 05:22:1678 bool PostNonNestableDelayedTask(const Location& from_here,
Gabriel Charettee2b632b2017-08-02 03:52:1679 OnceClosure task,
80 base::TimeDelta delay) override {
81 return PostDelayedTask(from_here, std::move(task), delay);
82 }
83
84 bool RunsTasksInCurrentSequence() const override {
85 return origin_thread_checker_.CalledOnValidThread();
86 }
87
Gabriel Charette1ef212b2017-12-03 12:47:2188 bool ProcessSingleTask() {
Gabriel Charettee2b632b2017-08-02 03:52:1689 OnceClosure task;
90 {
91 AutoLock auto_lock(tasks_lock_);
92 if (pending_tasks_.empty())
93 return false;
94 task = std::move(pending_tasks_.front());
95 pending_tasks_.pop();
96 }
97 // It's important to Run() after pop() and outside the lock as |task| may
Gabriel Charette1ef212b2017-12-03 12:47:2198 // run a nested loop which will re-enter ProcessSingleTask().
Gabriel Charettee2b632b2017-08-02 03:52:1699 std::move(task).Run();
100 return true;
101 }
102
103 private:
104 ~SimpleSingleThreadTaskRunner() override = default;
105
106 Lock tasks_lock_;
Brett Wilsona62d9c02017-09-20 20:53:20107 base::queue<OnceClosure> pending_tasks_;
Gabriel Charettee2b632b2017-08-02 03:52:16108
109 // RunLoop relies on RunsTasksInCurrentSequence() signal. Use a
110 // ThreadCheckerImpl to be able to reliably provide that signal even in
111 // non-dcheck builds.
112 ThreadCheckerImpl origin_thread_checker_;
Gabriel Charettee2b632b2017-08-02 03:52:16113};
114
Gabriel Charette1ef212b2017-12-03 12:47:21115// The basis of all TestDelegates, allows safely injecting a OnceClosure to be
116// run in the next idle phase of this delegate's Run() implementation. This can
117// be used to have code run on a thread that is otherwise livelocked in an idle
118// phase (sometimes a simple PostTask() won't do it -- e.g. when processing
119// application tasks is disallowed).
120class InjectableTestDelegate : public RunLoop::Delegate {
Gabriel Charettee2b632b2017-08-02 03:52:16121 public:
Gabriel Charette1ef212b2017-12-03 12:47:21122 void InjectClosureOnDelegate(OnceClosure closure) {
123 AutoLock auto_lock(closure_lock_);
124 closure_ = std::move(closure);
125 }
Gabriel Charettee2b632b2017-08-02 03:52:16126
Gabriel Charette1ef212b2017-12-03 12:47:21127 bool RunInjectedClosure() {
128 AutoLock auto_lock(closure_lock_);
129 if (closure_.is_null())
130 return false;
131 std::move(closure_).Run();
132 return true;
133 }
134
135 private:
136 Lock closure_lock_;
137 OnceClosure closure_;
138};
139
140// A simple test RunLoop::Delegate to exercise Runloop logic independent of any
141// other base constructs. BindToCurrentThread() must be called before this
142// TestBoundDelegate is operational.
143class TestBoundDelegate final : public InjectableTestDelegate {
144 public:
145 TestBoundDelegate() = default;
146
147 // Makes this TestBoundDelegate become the RunLoop::Delegate and
Sean Maher70f2942932023-01-04 22:15:06148 // SingleThreadTaskRunner::CurrentDefaultHandle for this thread.
Gabriel Charettee2b632b2017-08-02 03:52:16149 void BindToCurrentThread() {
150 thread_task_runner_handle_ =
Sean Maher9d43acc2022-12-01 17:42:01151 std::make_unique<SingleThreadTaskRunner::CurrentDefaultHandle>(
152 simple_task_runner_);
Gabriel Charettea3ec9612017-12-14 17:22:40153 RunLoop::RegisterDelegateForCurrentThread(this);
Gabriel Charettee2b632b2017-08-02 03:52:16154 }
155
156 private:
Alex Clarke9752bbf2019-04-01 10:41:20157 void Run(bool application_tasks_allowed, TimeDelta timeout) override {
Gabriel Charette3ff403e2017-08-07 04:22:48158 if (nested_run_allowing_tasks_incoming_) {
Gabriel Charette1ef212b2017-12-03 12:47:21159 EXPECT_TRUE(RunLoop::IsNestedOnCurrentThread());
Gabriel Charetteb030a4a2017-10-26 01:04:40160 EXPECT_TRUE(application_tasks_allowed);
Gabriel Charette1ef212b2017-12-03 12:47:21161 } else if (RunLoop::IsNestedOnCurrentThread()) {
Gabriel Charetteb030a4a2017-10-26 01:04:40162 EXPECT_FALSE(application_tasks_allowed);
Gabriel Charette3ff403e2017-08-07 04:22:48163 }
164 nested_run_allowing_tasks_incoming_ = false;
165
Gabriel Charettee2b632b2017-08-02 03:52:16166 while (!should_quit_) {
Gabriel Charette1ef212b2017-12-03 12:47:21167 if (application_tasks_allowed && simple_task_runner_->ProcessSingleTask())
Gabriel Charettee2b632b2017-08-02 03:52:16168 continue;
169
Gabriel Charettea3ec9612017-12-14 17:22:40170 if (ShouldQuitWhenIdle())
Gabriel Charettee2b632b2017-08-02 03:52:16171 break;
172
Gabriel Charette1ef212b2017-12-03 12:47:21173 if (RunInjectedClosure())
174 continue;
Gabriel Charette3ff403e2017-08-07 04:22:48175
Gabriel Charettee2b632b2017-08-02 03:52:16176 PlatformThread::YieldCurrentThread();
177 }
178 should_quit_ = false;
179 }
180
181 void Quit() override { should_quit_ = true; }
182
Gabriel Charette3ff403e2017-08-07 04:22:48183 void EnsureWorkScheduled() override {
184 nested_run_allowing_tasks_incoming_ = true;
185 }
186
187 // True if the next invocation of Run() is expected to be from a
188 // kNestableTasksAllowed RunLoop.
189 bool nested_run_allowing_tasks_incoming_ = false;
190
Gabriel Charettee2b632b2017-08-02 03:52:16191 scoped_refptr<SimpleSingleThreadTaskRunner> simple_task_runner_ =
192 MakeRefCounted<SimpleSingleThreadTaskRunner>();
Gabriel Charette1ef212b2017-12-03 12:47:21193
Sean Maher9d43acc2022-12-01 17:42:01194 std::unique_ptr<SingleThreadTaskRunner::CurrentDefaultHandle>
195 thread_task_runner_handle_;
Gabriel Charettee2b632b2017-08-02 03:52:16196
197 bool should_quit_ = false;
Gabriel Charette1ef212b2017-12-03 12:47:21198};
199
Gabriel Charettee2b632b2017-08-02 03:52:16200enum class RunLoopTestType {
Gabriel Charette694c3c332019-08-19 14:53:05201 // Runs all RunLoopTests under a TaskEnvironment to make sure real world
Gabriel Charettee2b632b2017-08-02 03:52:16202 // scenarios work.
203 kRealEnvironment,
204
205 // Runs all RunLoopTests under a test RunLoop::Delegate to make sure the
206 // delegate interface fully works standalone.
207 kTestDelegate,
208};
209
210// The task environment for the RunLoopTest of a given type. A separate class
211// so it can be instantiated on the stack in the RunLoopTest fixture.
212class RunLoopTestEnvironment {
213 public:
David Bienvenu5f4d4f02020-09-27 16:55:03214 explicit RunLoopTestEnvironment(RunLoopTestType type) {
Gabriel Charettee2b632b2017-08-02 03:52:16215 switch (type) {
Gabriel Charette1ef212b2017-12-03 12:47:21216 case RunLoopTestType::kRealEnvironment: {
Gabriel Charette694c3c332019-08-19 14:53:05217 task_environment_ = std::make_unique<test::TaskEnvironment>();
Gabriel Charettee2b632b2017-08-02 03:52:16218 break;
Gabriel Charette1ef212b2017-12-03 12:47:21219 }
220 case RunLoopTestType::kTestDelegate: {
221 auto test_delegate = std::make_unique<TestBoundDelegate>();
222 test_delegate->BindToCurrentThread();
223 test_delegate_ = std::move(test_delegate);
Gabriel Charettee2b632b2017-08-02 03:52:16224 break;
Gabriel Charette1ef212b2017-12-03 12:47:21225 }
Gabriel Charettee2b632b2017-08-02 03:52:16226 }
227 }
228
229 private:
Gabriel Charette50518fc2018-05-22 17:53:22230 // Instantiates one or the other based on the RunLoopTestType.
Gabriel Charette694c3c332019-08-19 14:53:05231 std::unique_ptr<test::TaskEnvironment> task_environment_;
Gabriel Charette1ef212b2017-12-03 12:47:21232 std::unique_ptr<InjectableTestDelegate> test_delegate_;
Gabriel Charettee2b632b2017-08-02 03:52:16233};
234
235class RunLoopTest : public testing::TestWithParam<RunLoopTestType> {
David Bienvenu5f4d4f02020-09-27 16:55:03236 public:
237 RunLoopTest(const RunLoopTest&) = delete;
238 RunLoopTest& operator=(const RunLoopTest&) = delete;
239
Gabriel Charettee2b632b2017-08-02 03:52:16240 protected:
241 RunLoopTest() : test_environment_(GetParam()) {}
242
243 RunLoopTestEnvironment test_environment_;
fdoraya4f28ec2016-06-10 00:08:58244 RunLoop run_loop_;
fdoraya4f28ec2016-06-10 00:08:58245};
246
247} // namespace
248
Gabriel Charettee2b632b2017-08-02 03:52:16249TEST_P(RunLoopTest, QuitWhenIdle) {
Wezbbffcc52019-02-21 02:01:20250 int counter = 0;
Sean Maher7d0e8052022-12-09 01:46:32251 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
tzik92b7a422017-04-11 15:00:44252 FROM_HERE, BindOnce(&QuitWhenIdleTask, Unretained(&run_loop_),
Wezbbffcc52019-02-21 02:01:20253 Unretained(&counter)));
Sean Maher7d0e8052022-12-09 01:46:32254 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
255 FROM_HERE, MakeExpectedRunClosure(FROM_HERE));
256 SingleThreadTaskRunner::GetCurrentDefault()->PostDelayedTask(
Peter Kasting53fd6ee2021-10-05 20:40:48257 FROM_HERE, MakeExpectedNotRunClosure(FROM_HERE), Days(1));
fdoraya4f28ec2016-06-10 00:08:58258
259 run_loop_.Run();
Wezbbffcc52019-02-21 02:01:20260 EXPECT_EQ(1, counter);
fdoraya4f28ec2016-06-10 00:08:58261}
262
Gabriel Charettee2b632b2017-08-02 03:52:16263TEST_P(RunLoopTest, QuitWhenIdleNestedLoop) {
Wezbbffcc52019-02-21 02:01:20264 int counter = 0;
Sean Maher7d0e8052022-12-09 01:46:32265 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
Wezbbffcc52019-02-21 02:01:20266 FROM_HERE, BindOnce(&RunNestedLoopTask, Unretained(&counter)));
Sean Maher7d0e8052022-12-09 01:46:32267 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
tzik92b7a422017-04-11 15:00:44268 FROM_HERE, BindOnce(&QuitWhenIdleTask, Unretained(&run_loop_),
Wezbbffcc52019-02-21 02:01:20269 Unretained(&counter)));
Sean Maher7d0e8052022-12-09 01:46:32270 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
271 FROM_HERE, MakeExpectedRunClosure(FROM_HERE));
272 SingleThreadTaskRunner::GetCurrentDefault()->PostDelayedTask(
Peter Kasting53fd6ee2021-10-05 20:40:48273 FROM_HERE, MakeExpectedNotRunClosure(FROM_HERE), Days(1));
fdoraya4f28ec2016-06-10 00:08:58274
275 run_loop_.Run();
Wezbbffcc52019-02-21 02:01:20276 EXPECT_EQ(3, counter);
fdoraya4f28ec2016-06-10 00:08:58277}
278
Gabriel Charettee2b632b2017-08-02 03:52:16279TEST_P(RunLoopTest, QuitWhenIdleClosure) {
Sean Maher7d0e8052022-12-09 01:46:32280 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
281 FROM_HERE, run_loop_.QuitWhenIdleClosure());
282 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
283 FROM_HERE, MakeExpectedRunClosure(FROM_HERE));
284 SingleThreadTaskRunner::GetCurrentDefault()->PostDelayedTask(
Peter Kasting53fd6ee2021-10-05 20:40:48285 FROM_HERE, MakeExpectedNotRunClosure(FROM_HERE), Days(1));
fdoraya3658602016-06-10 18:23:15286
287 run_loop_.Run();
fdoraya3658602016-06-10 18:23:15288}
289
290// Verify that the QuitWhenIdleClosure() can run after the RunLoop has been
291// deleted. It should have no effect.
Gabriel Charettee2b632b2017-08-02 03:52:16292TEST_P(RunLoopTest, QuitWhenIdleClosureAfterRunLoopScope) {
kylechar650caf02019-07-17 03:25:41293 RepeatingClosure quit_when_idle_closure;
fdoraya3658602016-06-10 18:23:15294 {
295 RunLoop run_loop;
296 quit_when_idle_closure = run_loop.QuitWhenIdleClosure();
297 run_loop.RunUntilIdle();
298 }
299 quit_when_idle_closure.Run();
300}
301
gabcf5e4ce2017-05-19 22:56:57302// Verify that Quit can be executed from another sequence.
Gabriel Charettee2b632b2017-08-02 03:52:16303TEST_P(RunLoopTest, QuitFromOtherSequence) {
304 Thread other_thread("test");
305 other_thread.Start();
gabcf5e4ce2017-05-19 22:56:57306 scoped_refptr<SequencedTaskRunner> other_sequence =
Gabriel Charettee2b632b2017-08-02 03:52:16307 other_thread.task_runner();
gabcf5e4ce2017-05-19 22:56:57308
309 // Always expected to run before asynchronous Quit() kicks in.
Sean Maher7d0e8052022-12-09 01:46:32310 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
311 FROM_HERE, MakeExpectedRunClosure(FROM_HERE));
gabcf5e4ce2017-05-19 22:56:57312
313 WaitableEvent loop_was_quit(WaitableEvent::ResetPolicy::MANUAL,
314 WaitableEvent::InitialState::NOT_SIGNALED);
315 other_sequence->PostTask(
316 FROM_HERE, base::BindOnce([](RunLoop* run_loop) { run_loop->Quit(); },
317 Unretained(&run_loop_)));
318 other_sequence->PostTask(
319 FROM_HERE,
320 base::BindOnce(&WaitableEvent::Signal, base::Unretained(&loop_was_quit)));
321
322 // Anything that's posted after the Quit closure was posted back to this
323 // sequence shouldn't get a chance to run.
324 loop_was_quit.Wait();
Sean Maher7d0e8052022-12-09 01:46:32325 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
326 FROM_HERE, MakeExpectedNotRunClosure(FROM_HERE));
gabcf5e4ce2017-05-19 22:56:57327
328 run_loop_.Run();
gabcf5e4ce2017-05-19 22:56:57329}
330
331// Verify that QuitClosure can be executed from another sequence.
Gabriel Charettee2b632b2017-08-02 03:52:16332TEST_P(RunLoopTest, QuitFromOtherSequenceWithClosure) {
333 Thread other_thread("test");
334 other_thread.Start();
gabcf5e4ce2017-05-19 22:56:57335 scoped_refptr<SequencedTaskRunner> other_sequence =
Gabriel Charettee2b632b2017-08-02 03:52:16336 other_thread.task_runner();
gabcf5e4ce2017-05-19 22:56:57337
338 // Always expected to run before asynchronous Quit() kicks in.
Sean Maher7d0e8052022-12-09 01:46:32339 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
340 FROM_HERE, MakeExpectedRunClosure(FROM_HERE));
gabcf5e4ce2017-05-19 22:56:57341
342 WaitableEvent loop_was_quit(WaitableEvent::ResetPolicy::MANUAL,
343 WaitableEvent::InitialState::NOT_SIGNALED);
344 other_sequence->PostTask(FROM_HERE, run_loop_.QuitClosure());
345 other_sequence->PostTask(
346 FROM_HERE,
347 base::BindOnce(&WaitableEvent::Signal, base::Unretained(&loop_was_quit)));
348
349 // Anything that's posted after the Quit closure was posted back to this
350 // sequence shouldn't get a chance to run.
351 loop_was_quit.Wait();
Sean Maher7d0e8052022-12-09 01:46:32352 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
353 FROM_HERE, MakeExpectedNotRunClosure(FROM_HERE));
gabcf5e4ce2017-05-19 22:56:57354
355 run_loop_.Run();
gabcf5e4ce2017-05-19 22:56:57356}
357
358// Verify that Quit can be executed from another sequence even when the
359// Quit is racing with Run() -- i.e. forgo the WaitableEvent used above.
Gabriel Charettee2b632b2017-08-02 03:52:16360TEST_P(RunLoopTest, QuitFromOtherSequenceRacy) {
361 Thread other_thread("test");
362 other_thread.Start();
gabcf5e4ce2017-05-19 22:56:57363 scoped_refptr<SequencedTaskRunner> other_sequence =
Gabriel Charettee2b632b2017-08-02 03:52:16364 other_thread.task_runner();
gabcf5e4ce2017-05-19 22:56:57365
366 // Always expected to run before asynchronous Quit() kicks in.
Sean Maher7d0e8052022-12-09 01:46:32367 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
368 FROM_HERE, MakeExpectedRunClosure(FROM_HERE));
gabcf5e4ce2017-05-19 22:56:57369
Wezbbffcc52019-02-21 02:01:20370 other_sequence->PostTask(FROM_HERE, run_loop_.QuitClosure());
gabcf5e4ce2017-05-19 22:56:57371
372 run_loop_.Run();
gabcf5e4ce2017-05-19 22:56:57373}
374
375// Verify that QuitClosure can be executed from another sequence even when the
376// Quit is racing with Run() -- i.e. forgo the WaitableEvent used above.
Gabriel Charettee2b632b2017-08-02 03:52:16377TEST_P(RunLoopTest, QuitFromOtherSequenceRacyWithClosure) {
378 Thread other_thread("test");
379 other_thread.Start();
gabcf5e4ce2017-05-19 22:56:57380 scoped_refptr<SequencedTaskRunner> other_sequence =
Gabriel Charettee2b632b2017-08-02 03:52:16381 other_thread.task_runner();
gabcf5e4ce2017-05-19 22:56:57382
383 // Always expected to run before asynchronous Quit() kicks in.
Sean Maher7d0e8052022-12-09 01:46:32384 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
385 FROM_HERE, MakeExpectedRunClosure(FROM_HERE));
gabcf5e4ce2017-05-19 22:56:57386
387 other_sequence->PostTask(FROM_HERE, run_loop_.QuitClosure());
388
389 run_loop_.Run();
gabcf5e4ce2017-05-19 22:56:57390}
391
392// Verify that QuitWhenIdle can be executed from another sequence.
Gabriel Charettee2b632b2017-08-02 03:52:16393TEST_P(RunLoopTest, QuitWhenIdleFromOtherSequence) {
394 Thread other_thread("test");
395 other_thread.Start();
gabcf5e4ce2017-05-19 22:56:57396 scoped_refptr<SequencedTaskRunner> other_sequence =
Gabriel Charettee2b632b2017-08-02 03:52:16397 other_thread.task_runner();
gabcf5e4ce2017-05-19 22:56:57398
Sean Maher7d0e8052022-12-09 01:46:32399 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
400 FROM_HERE, MakeExpectedRunClosure(FROM_HERE));
gabcf5e4ce2017-05-19 22:56:57401
402 other_sequence->PostTask(
403 FROM_HERE,
404 base::BindOnce([](RunLoop* run_loop) { run_loop->QuitWhenIdle(); },
405 Unretained(&run_loop_)));
406
Sean Maher7d0e8052022-12-09 01:46:32407 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
408 FROM_HERE, MakeExpectedRunClosure(FROM_HERE));
gabcf5e4ce2017-05-19 22:56:57409
410 run_loop_.Run();
411
412 // Regardless of the outcome of the race this thread shouldn't have been idle
Wezbbffcc52019-02-21 02:01:20413 // until both tasks posted to this sequence have run.
gabcf5e4ce2017-05-19 22:56:57414}
415
416// Verify that QuitWhenIdleClosure can be executed from another sequence.
Gabriel Charettee2b632b2017-08-02 03:52:16417TEST_P(RunLoopTest, QuitWhenIdleFromOtherSequenceWithClosure) {
418 Thread other_thread("test");
419 other_thread.Start();
gabcf5e4ce2017-05-19 22:56:57420 scoped_refptr<SequencedTaskRunner> other_sequence =
Gabriel Charettee2b632b2017-08-02 03:52:16421 other_thread.task_runner();
gabcf5e4ce2017-05-19 22:56:57422
Sean Maher7d0e8052022-12-09 01:46:32423 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
424 FROM_HERE, MakeExpectedRunClosure(FROM_HERE));
gabcf5e4ce2017-05-19 22:56:57425
426 other_sequence->PostTask(FROM_HERE, run_loop_.QuitWhenIdleClosure());
427
Sean Maher7d0e8052022-12-09 01:46:32428 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
429 FROM_HERE, MakeExpectedRunClosure(FROM_HERE));
gabcf5e4ce2017-05-19 22:56:57430
431 run_loop_.Run();
432
433 // Regardless of the outcome of the race this thread shouldn't have been idle
Wezbbffcc52019-02-21 02:01:20434 // until the both tasks posted to this sequence have run.
gabcf5e4ce2017-05-19 22:56:57435}
436
Gabriel Charettee2b632b2017-08-02 03:52:16437TEST_P(RunLoopTest, IsRunningOnCurrentThread) {
gab7af9dc02017-05-05 13:38:54438 EXPECT_FALSE(RunLoop::IsRunningOnCurrentThread());
Sean Maher7d0e8052022-12-09 01:46:32439 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
gab7af9dc02017-05-05 13:38:54440 FROM_HERE,
tzik0c100dc2017-06-26 06:13:17441 BindOnce([]() { EXPECT_TRUE(RunLoop::IsRunningOnCurrentThread()); }));
Sean Maher7d0e8052022-12-09 01:46:32442 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
443 FROM_HERE, run_loop_.QuitClosure());
gab7af9dc02017-05-05 13:38:54444 run_loop_.Run();
445}
446
Gabriel Charettee2b632b2017-08-02 03:52:16447TEST_P(RunLoopTest, IsNestedOnCurrentThread) {
gab7af9dc02017-05-05 13:38:54448 EXPECT_FALSE(RunLoop::IsNestedOnCurrentThread());
449
Sean Maher7d0e8052022-12-09 01:46:32450 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
tzik0c100dc2017-06-26 06:13:17451 FROM_HERE, BindOnce([]() {
gab7af9dc02017-05-05 13:38:54452 EXPECT_FALSE(RunLoop::IsNestedOnCurrentThread());
453
Gabriel Charette3ff403e2017-08-07 04:22:48454 RunLoop nested_run_loop(RunLoop::Type::kNestableTasksAllowed);
gab7af9dc02017-05-05 13:38:54455
Sean Maher7d0e8052022-12-09 01:46:32456 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
tzik0c100dc2017-06-26 06:13:17457 FROM_HERE, BindOnce([]() {
458 EXPECT_TRUE(RunLoop::IsNestedOnCurrentThread());
459 }));
Sean Maher7d0e8052022-12-09 01:46:32460 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
461 FROM_HERE, nested_run_loop.QuitClosure());
gab7af9dc02017-05-05 13:38:54462
463 EXPECT_FALSE(RunLoop::IsNestedOnCurrentThread());
gab7af9dc02017-05-05 13:38:54464 nested_run_loop.Run();
465 EXPECT_FALSE(RunLoop::IsNestedOnCurrentThread());
466 }));
467
Sean Maher7d0e8052022-12-09 01:46:32468 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
469 FROM_HERE, run_loop_.QuitClosure());
gab7af9dc02017-05-05 13:38:54470 run_loop_.Run();
471}
472
Gabriel Charette2a53350172021-05-06 20:22:55473TEST_P(RunLoopTest, CannotRunMoreThanOnce) {
Sean Maher7d0e8052022-12-09 01:46:32474 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
475 FROM_HERE, run_loop_.QuitClosure());
Gabriel Charette2a53350172021-05-06 20:22:55476 run_loop_.Run();
477 EXPECT_DCHECK_DEATH({ run_loop_.Run(); });
478}
479
480TEST_P(RunLoopTest, CanRunUntilIdleMoreThanOnce) {
Sean Maher7d0e8052022-12-09 01:46:32481 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(FROM_HERE, DoNothing());
Gabriel Charette2a53350172021-05-06 20:22:55482 run_loop_.RunUntilIdle();
483
Sean Maher7d0e8052022-12-09 01:46:32484 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(FROM_HERE, DoNothing());
Gabriel Charette2a53350172021-05-06 20:22:55485 run_loop_.RunUntilIdle();
486 run_loop_.RunUntilIdle();
487}
488
489TEST_P(RunLoopTest, CanRunUntilIdleThenRunIfNotQuit) {
Sean Maher7d0e8052022-12-09 01:46:32490 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(FROM_HERE, DoNothing());
Gabriel Charette2a53350172021-05-06 20:22:55491 run_loop_.RunUntilIdle();
492
Sean Maher7d0e8052022-12-09 01:46:32493 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
494 FROM_HERE, run_loop_.QuitClosure());
Gabriel Charette2a53350172021-05-06 20:22:55495 run_loop_.Run();
496}
497
498TEST_P(RunLoopTest, CannotRunUntilIdleThenRunIfQuit) {
Sean Maher7d0e8052022-12-09 01:46:32499 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
500 FROM_HERE, run_loop_.QuitClosure());
Gabriel Charette2a53350172021-05-06 20:22:55501 run_loop_.RunUntilIdle();
502
Sean Maher7d0e8052022-12-09 01:46:32503 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(FROM_HERE, DoNothing());
Gabriel Charette2a53350172021-05-06 20:22:55504 EXPECT_DCHECK_DEATH({ run_loop_.Run(); });
505}
506
507TEST_P(RunLoopTest, CannotRunAgainIfQuitWhenIdle) {
Sean Maher7d0e8052022-12-09 01:46:32508 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
509 FROM_HERE, run_loop_.QuitWhenIdleClosure());
Gabriel Charette2a53350172021-05-06 20:22:55510 run_loop_.RunUntilIdle();
511
512 EXPECT_DCHECK_DEATH({ run_loop_.RunUntilIdle(); });
513}
514
Francois Doray80bdddf2018-01-04 16:17:32515namespace {
516
gab7af9dc02017-05-05 13:38:54517class MockNestingObserver : public RunLoop::NestingObserver {
518 public:
519 MockNestingObserver() = default;
David Bienvenu5f4d4f02020-09-27 16:55:03520 MockNestingObserver(const MockNestingObserver&) = delete;
521 MockNestingObserver& operator=(const MockNestingObserver&) = delete;
gab7af9dc02017-05-05 13:38:54522
523 // RunLoop::NestingObserver:
524 MOCK_METHOD0(OnBeginNestedRunLoop, void());
Francois Doray80bdddf2018-01-04 16:17:32525 MOCK_METHOD0(OnExitNestedRunLoop, void());
gab7af9dc02017-05-05 13:38:54526};
527
Francois Doray80bdddf2018-01-04 16:17:32528class MockTask {
529 public:
530 MockTask() = default;
David Bienvenu5f4d4f02020-09-27 16:55:03531 MockTask(const MockTask&) = delete;
532 MockTask& operator=(const MockTask&) = delete;
Francois Doray80bdddf2018-01-04 16:17:32533
David Bienvenu5f4d4f02020-09-27 16:55:03534 MOCK_METHOD0(Task, void());
Francois Doray80bdddf2018-01-04 16:17:32535};
536
537} // namespace
538
Gabriel Charettee2b632b2017-08-02 03:52:16539TEST_P(RunLoopTest, NestingObservers) {
gab7af9dc02017-05-05 13:38:54540 testing::StrictMock<MockNestingObserver> nesting_observer;
Francois Doray80bdddf2018-01-04 16:17:32541 testing::StrictMock<MockTask> mock_task_a;
542 testing::StrictMock<MockTask> mock_task_b;
gab7af9dc02017-05-05 13:38:54543
544 RunLoop::AddNestingObserverOnCurrentThread(&nesting_observer);
545
kylechar01598d72019-05-21 18:35:31546 const RepeatingClosure run_nested_loop = BindRepeating([]() {
Gabriel Charette3ff403e2017-08-07 04:22:48547 RunLoop nested_run_loop(RunLoop::Type::kNestableTasksAllowed);
Sean Maher7d0e8052022-12-09 01:46:32548 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
549 FROM_HERE, nested_run_loop.QuitClosure());
gab7af9dc02017-05-05 13:38:54550 nested_run_loop.Run();
551 });
552
Francois Doray80bdddf2018-01-04 16:17:32553 // Generate a stack of nested RunLoops. OnBeginNestedRunLoop() is expected
554 // when beginning each nesting depth and OnExitNestedRunLoop() is expected
Gabriel Charetted8839442018-03-15 18:56:22555 // when exiting each nesting depth. Each one of these tasks is ahead of the
556 // QuitClosures as those are only posted at the end of the queue when
557 // |run_nested_loop| is executed.
Sean Maher7d0e8052022-12-09 01:46:32558 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(FROM_HERE,
559 run_nested_loop);
560 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
Francois Doray80bdddf2018-01-04 16:17:32561 FROM_HERE,
562 base::BindOnce(&MockTask::Task, base::Unretained(&mock_task_a)));
Sean Maher7d0e8052022-12-09 01:46:32563 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(FROM_HERE,
564 run_nested_loop);
565 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
Francois Doray80bdddf2018-01-04 16:17:32566 FROM_HERE,
567 base::BindOnce(&MockTask::Task, base::Unretained(&mock_task_b)));
gab7af9dc02017-05-05 13:38:54568
Francois Doray80bdddf2018-01-04 16:17:32569 {
570 testing::InSequence in_sequence;
571 EXPECT_CALL(nesting_observer, OnBeginNestedRunLoop());
572 EXPECT_CALL(mock_task_a, Task());
573 EXPECT_CALL(nesting_observer, OnBeginNestedRunLoop());
574 EXPECT_CALL(mock_task_b, Task());
575 EXPECT_CALL(nesting_observer, OnExitNestedRunLoop()).Times(2);
576 }
577 run_loop_.RunUntilIdle();
gab7af9dc02017-05-05 13:38:54578
579 RunLoop::RemoveNestingObserverOnCurrentThread(&nesting_observer);
580}
581
Minoru Chikamune76ba6822021-01-12 10:39:51582TEST_P(RunLoopTest, DisallowRunning) {
Hans Wennborg9b292ba2022-02-15 16:01:29583 ScopedDisallowRunningRunLoop disallow_running;
Gabriel Charettef3fd8f02018-05-22 15:31:48584 EXPECT_DCHECK_DEATH({ run_loop_.RunUntilIdle(); });
Gabriel Charettea44975052017-08-21 23:14:04585}
586
Minoru Chikamune76ba6822021-01-12 10:39:51587TEST_P(RunLoopTest, ExpiredDisallowRunning) {
Hans Wennborg9b292ba2022-02-15 16:01:29588 { ScopedDisallowRunningRunLoop disallow_running; }
Gabriel Charettea44975052017-08-21 23:14:04589 // Running should be fine after |disallow_running| goes out of scope.
590 run_loop_.RunUntilIdle();
591}
592
Victor Costan033b9ac2019-01-29 00:52:16593INSTANTIATE_TEST_SUITE_P(Real,
594 RunLoopTest,
595 testing::Values(RunLoopTestType::kRealEnvironment));
596INSTANTIATE_TEST_SUITE_P(Mock,
597 RunLoopTest,
598 testing::Values(RunLoopTestType::kTestDelegate));
Gabriel Charettee2b632b2017-08-02 03:52:16599
600TEST(RunLoopDeathTest, MustRegisterBeforeInstantiating) {
Gabriel Charette1ef212b2017-12-03 12:47:21601 TestBoundDelegate unbound_test_delegate_;
Sean Maher70f2942932023-01-04 22:15:06602 // RunLoop::RunLoop() should CHECK fetching the
603 // SingleThreadTaskRunner::CurrentDefaultHandle.
Wez39ee6102018-04-14 21:33:59604 EXPECT_DEATH_IF_SUPPORTED({ RunLoop(); }, "");
Gabriel Charettee2b632b2017-08-02 03:52:16605}
606
Gabriel Charette3ff403e2017-08-07 04:22:48607TEST(RunLoopDelegateTest, NestableTasksDontRunInDefaultNestedLoops) {
Gabriel Charette1ef212b2017-12-03 12:47:21608 TestBoundDelegate test_delegate;
Gabriel Charette3ff403e2017-08-07 04:22:48609 test_delegate.BindToCurrentThread();
610
611 base::Thread other_thread("test");
612 other_thread.Start();
613
614 RunLoop main_loop;
615 // A nested run loop which isn't kNestableTasksAllowed.
616 RunLoop nested_run_loop(RunLoop::Type::kDefault);
617
618 bool nested_run_loop_ended = false;
619
620 // The first task on the main loop will result in a nested run loop. Since
621 // it's not kNestableTasksAllowed, no further task should be processed until
622 // it's quit.
Sean Maher7d0e8052022-12-09 01:46:32623 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
Gabriel Charette3ff403e2017-08-07 04:22:48624 FROM_HERE,
625 BindOnce([](RunLoop* nested_run_loop) { nested_run_loop->Run(); },
626 Unretained(&nested_run_loop)));
627
628 // Post a task that will fail if it runs inside the nested run loop.
Sean Maher7d0e8052022-12-09 01:46:32629 SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
jdoerrie9d7236f62019-03-05 13:00:23630 FROM_HERE,
631 BindOnce(
632 [](const bool& nested_run_loop_ended,
633 OnceClosure continuation_callback) {
634 EXPECT_TRUE(nested_run_loop_ended);
635 EXPECT_FALSE(RunLoop::IsNestedOnCurrentThread());
636 std::move(continuation_callback).Run();
637 },
638 std::cref(nested_run_loop_ended), main_loop.QuitClosure()));
Gabriel Charette3ff403e2017-08-07 04:22:48639
640 // Post a task flipping the boolean bit for extra verification right before
641 // quitting |nested_run_loop|.
642 other_thread.task_runner()->PostDelayedTask(
643 FROM_HERE,
644 BindOnce(
645 [](bool* nested_run_loop_ended) {
646 EXPECT_FALSE(*nested_run_loop_ended);
647 *nested_run_loop_ended = true;
648 },
649 Unretained(&nested_run_loop_ended)),
650 TestTimeouts::tiny_timeout());
651 // Post an async delayed task to exit the run loop when idle. This confirms
652 // that (1) the test task only ran in the main loop after the nested loop
653 // exited and (2) the nested run loop actually considers itself idle while
654 // spinning. Note: The quit closure needs to be injected directly on the
655 // delegate as invoking QuitWhenIdle() off-thread results in a thread bounce
656 // which will not processed because of the very logic under test (nestable
657 // tasks don't run in |nested_run_loop|).
658 other_thread.task_runner()->PostDelayedTask(
659 FROM_HERE,
660 BindOnce(
Gabriel Charette1ef212b2017-12-03 12:47:21661 [](TestBoundDelegate* test_delegate, OnceClosure injected_closure) {
662 test_delegate->InjectClosureOnDelegate(std::move(injected_closure));
Gabriel Charette3ff403e2017-08-07 04:22:48663 },
664 Unretained(&test_delegate), nested_run_loop.QuitWhenIdleClosure()),
665 TestTimeouts::tiny_timeout());
666
667 main_loop.Run();
668}
669
fdoraya4f28ec2016-06-10 00:08:58670} // namespace base