Skip to content

GitLab

T
tangled
Commit 69e7ddc5 authored by Gabriel Charette's avatar Gabriel Charette Committed by Commit Bot
Browse files
Options

[base MessageLoopCurrent] Introduce ScopedAllowApplicationTasksInNativeNestedLoop 

As a new name for ScopedNestableTaskAllower. A migration will follow
to move callers either to the new name or to
RunLoop::Type::kNestableTasksAllowed.

R=fdoray@chromium.org

Bug: 781352
Change-Id: I5208655072728b4305e70815ccb933173ff0842e
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2225834
Commit-Queue: Gabriel Charette <gab@chromium.org>
Reviewed-by: default avatarFrançois Doray <fdoray@chromium.org>
Auto-Submit: Gabriel Charette <gab@chromium.org>
Cr-Commit-Position: refs/heads/master@{#775160}
parent 1df887dc
Hide whitespace changes
Inline Side-by-side
Showing with 51 additions and 45 deletions
base/message_loop/message_loop_current.cc
View file @ 69e7ddc5
......@@ -81,15 +81,17 @@ void MessageLoopCurrent::SetAddQueueTimeToTasks(bool enable) {
current_->SetAddQueueTimeToTasks(enable);
}
MessageLoopCurrent::ScopedNestableTaskAllower::ScopedNestableTaskAllower()
MessageLoopCurrent::ScopedAllowApplicationTasksInNativeNestedLoop::
ScopedAllowApplicationTasksInNativeNestedLoop()
: sequence_manager_(GetCurrentSequenceManagerImpl()),
old_state_(sequence_manager_->IsTaskExecutionAllowed()) {
previous_state_(sequence_manager_->IsTaskExecutionAllowed()) {
TRACE_EVENT_BEGIN0("base", "ScopedNestableTaskAllower");
sequence_manager_->SetTaskExecutionAllowed(true);
}
MessageLoopCurrent::ScopedNestableTaskAllower::~ScopedNestableTaskAllower() {
sequence_manager_->SetTaskExecutionAllowed(old_state_);
MessageLoopCurrent::ScopedAllowApplicationTasksInNativeNestedLoop::
~ScopedAllowApplicationTasksInNativeNestedLoop() {
sequence_manager_->SetTaskExecutionAllowed(previous_state_);
TRACE_EVENT_END0("base", "ScopedNestableTaskAllower");
}
......
base/message_loop/message_loop_current.h
View file @ 69e7ddc5
......@@ -134,22 +134,24 @@ class BASE_EXPORT MessageLoopCurrent {
// Otherwise, it will get executed right after task #1 completes at "thread
// message loop level".
//
// Prefer RunLoop::Type::kNestableTasksAllowed when nesting is requested by
// the application.
//
// TODO(https://crbug.com/781352): Remove usage of this class alongside
// RunLoop and rename it to ScopedApplicationTasksAllowedInNativeNestedLoop(?)
// for remaining use cases.
class BASE_EXPORT ScopedNestableTaskAllower {
// Use RunLoop::Type::kNestableTasksAllowed when nesting is triggered by the
// application RunLoop rather than by native code.
class BASE_EXPORT ScopedAllowApplicationTasksInNativeNestedLoop {
public:
ScopedNestableTaskAllower();
~ScopedNestableTaskAllower();
ScopedAllowApplicationTasksInNativeNestedLoop();
~ScopedAllowApplicationTasksInNativeNestedLoop();
private:
sequence_manager::internal::SequenceManagerImpl* const sequence_manager_;
const bool old_state_;
const bool previous_state_;
};
// TODO(https://crbug.com/781352): Remove usage of this old class. Either
// renaming it to ScopedAllowApplicationTasksInNativeNestedLoop when truly
// native or migrating it to RunLoop::Type::kNestableTasksAllowed otherwise.
using ScopedNestableTaskAllower =
ScopedAllowApplicationTasksInNativeNestedLoop;
// Returns true if nestable tasks are allowed on the current loop at this time
// (i.e. if a nested loop would start from the callee's point in the stack,
// would it be allowed to run application tasks).
......
base/message_loop/message_loop_unittest.cc
View file @ 69e7ddc5
......@@ -273,7 +273,8 @@ class MessageLoopTest : public ::testing::Test {};
#if defined(OS_WIN)
void SubPumpFunc(OnceClosure on_done) {
MessageLoopCurrent::ScopedNestableTaskAllower allow_nestable_tasks;
MessageLoopCurrent::ScopedAllowApplicationTasksInNativeNestedLoop
allow_nestable_tasks;
MSG msg;
while (::GetMessage(&msg, NULL, 0, 0)) {
::TranslateMessage(&msg);
......@@ -289,7 +290,8 @@ const wchar_t kMessageBoxTitle[] = L"MessageLoop Unit Test";
// implicit message loops.
void MessageBoxFunc(TaskList* order, int cookie, bool is_reentrant) {
order->RecordStart(MESSAGEBOX, cookie);
Optional<MessageLoopCurrent::ScopedNestableTaskAllower> maybe_allow_nesting;
Optional<MessageLoopCurrent::ScopedAllowApplicationTasksInNativeNestedLoop>
maybe_allow_nesting;
if (is_reentrant)
maybe_allow_nesting.emplace();
::MessageBox(NULL, L"Please wait...", kMessageBoxTitle, MB_OK);
......@@ -955,10 +957,7 @@ namespace {
void FuncThatRuns(TaskList* order, int cookie, RunLoop* run_loop) {
order->RecordStart(RUNS, cookie);
{
MessageLoopCurrent::ScopedNestableTaskAllower allow;
run_loop->Run();
}
run_loop->Run();
order->RecordEnd(RUNS, cookie);
}
......@@ -974,10 +973,11 @@ TEST_P(MessageLoopTypedTest, QuitNow) {
TaskList order;
RunLoop run_loop;
RunLoop nested_run_loop(RunLoop::Type::kNestableTasksAllowed);
ThreadTaskRunnerHandle::Get()->PostTask(
FROM_HERE, BindOnce(&FuncThatRuns, &order, 1, Unretained(&run_loop)));
FROM_HERE,
BindOnce(&FuncThatRuns, &order, 1, Unretained(&nested_run_loop)));
ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE,
BindOnce(&OrderedFunc, &order, 2));
ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE,
......@@ -1009,7 +1009,7 @@ TEST_P(MessageLoopTypedTest, RunLoopQuitTop) {
TaskList order;
RunLoop outer_run_loop;
RunLoop nested_run_loop;
RunLoop nested_run_loop(RunLoop::Type::kNestableTasksAllowed);
ThreadTaskRunnerHandle::Get()->PostTask(
FROM_HERE,
......@@ -1039,7 +1039,7 @@ TEST_P(MessageLoopTypedTest, RunLoopQuitNested) {
TaskList order;
RunLoop outer_run_loop;
RunLoop nested_run_loop;
RunLoop nested_run_loop(RunLoop::Type::kNestableTasksAllowed);
ThreadTaskRunnerHandle::Get()->PostTask(
FROM_HERE,
......@@ -1104,7 +1104,7 @@ TEST_P(MessageLoopTypedTest, RunLoopQuitBogus) {
TaskList order;
RunLoop outer_run_loop;
RunLoop nested_run_loop;
RunLoop nested_run_loop(RunLoop::Type::kNestableTasksAllowed);
RunLoop bogus_run_loop;
ThreadTaskRunnerHandle::Get()->PostTask(
......@@ -1137,10 +1137,10 @@ TEST_P(MessageLoopTypedTest, RunLoopQuitDeep) {
TaskList order;
RunLoop outer_run_loop;
RunLoop nested_loop1;
RunLoop nested_loop2;
RunLoop nested_loop3;
RunLoop nested_loop4;
RunLoop nested_loop1(RunLoop::Type::kNestableTasksAllowed);
RunLoop nested_loop2(RunLoop::Type::kNestableTasksAllowed);
RunLoop nested_loop3(RunLoop::Type::kNestableTasksAllowed);
RunLoop nested_loop4(RunLoop::Type::kNestableTasksAllowed);
ThreadTaskRunnerHandle::Get()->PostTask(
FROM_HERE, BindOnce(&FuncThatRuns, &order, 1, Unretained(&nested_loop1)));
......@@ -1249,10 +1249,11 @@ TEST_P(MessageLoopTypedTest, RunLoopQuitOrderAfter) {
TaskList order;
RunLoop run_loop;
RunLoop nested_run_loop(RunLoop::Type::kNestableTasksAllowed);
ThreadTaskRunnerHandle::Get()->PostTask(
FROM_HERE, BindOnce(&FuncThatRuns, &order, 1, Unretained(&run_loop)));
FROM_HERE,
BindOnce(&FuncThatRuns, &order, 1, Unretained(&nested_run_loop)));
ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE,
BindOnce(&OrderedFunc, &order, 2));
ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE,
......@@ -1260,13 +1261,13 @@ TEST_P(MessageLoopTypedTest, RunLoopQuitOrderAfter) {
ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE,
BindOnce(&OrderedFunc, &order, 3));
ThreadTaskRunnerHandle::Get()->PostTask(
FROM_HERE, run_loop.QuitClosure()); // has no affect
FROM_HERE, nested_run_loop.QuitClosure()); // has no affect
ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE,
BindOnce(&OrderedFunc, &order, 4));
ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE,
BindOnce(&FuncThatQuitsNow));
run_loop.allow_quit_current_deprecated_ = true;
nested_run_loop.allow_quit_current_deprecated_ = true;
RunLoop outer_run_loop;
outer_run_loop.Run();
......@@ -1368,7 +1369,7 @@ TEST_P(MessageLoopTypedTest, NestableTasksAllowedExplicitlyInScope) {
BindOnce(
[](RunLoop* run_loop) {
{
MessageLoopCurrent::ScopedNestableTaskAllower
MessageLoopCurrent::ScopedAllowApplicationTasksInNativeNestedLoop
allow_nestable_tasks;
EXPECT_TRUE(MessageLoopCurrent::Get()->NestableTasksAllowed());
}
......@@ -1572,8 +1573,8 @@ TEST_F(MessageLoopTest, PostImmediateTaskFromSystemPump) {
// work_deduplicator.cc(50): OnWorkStarted
// 2) SubPumpFunc entered:
// message_loop_unittest.cc(278): SubPumpFunc
// 3) ScopedNestableTaskAllower triggers nested ScheduleWork:
// work_deduplicator.cc(34): OnWorkRequested
// 3) ScopedAllowApplicationTasksInNativeNestedLoop triggers nested
// ScheduleWork: work_deduplicator.cc(34): OnWorkRequested
// 4) Nested system loop starts and pumps internal kMsgHaveWork:
// message_loop_unittest.cc(282): SubPumpFunc : Got Message
// message_pump_win.cc(302): HandleWorkMessage
......@@ -1606,9 +1607,9 @@ TEST_F(MessageLoopTest, PostImmediateTaskFromSystemPump) {
// 11) Nested application task completes and SubPumpFunc unwinds:
// work_deduplicator.cc(58): WillCheckForMoreWork
// work_deduplicator.cc(67): DidCheckForMoreWork
// 12) ~ScopedNestableTaskAllower() makes sure WorkDeduplicator knows we're
// back in DoWork() (not relevant in this test but important overall).
// work_deduplicator.cc(50): OnWorkStarted
// 12) ~ScopedAllowApplicationTasksInNativeNestedLoop() makes sure
// WorkDeduplicator knows we're back in DoWork() (not relevant in this test
// but important overall). work_deduplicator.cc(50): OnWorkStarted
// 13) Application task which ran SubPumpFunc completes and test finishes.
// work_deduplicator.cc(67): DidCheckForMoreWork
TEST_F(MessageLoopTest, PostDelayedTaskFromSystemPump) {
......@@ -1672,11 +1673,11 @@ TEST_F(MessageLoopTest, RepostingWmQuitDoesntStarveUpcomingNativeLoop) {
// This test ensures that application tasks are being processed by the native
// subpump despite the kMsgHaveWork event having already been consumed by the
// time the subpump is entered. This is subtly enforced by
// MessageLoopCurrent::ScopedNestableTaskAllower which will ScheduleWork()
// upon construction (and if it's absent, the MessageLoop shouldn't process
// application tasks so kMsgHaveWork is irrelevant).
// Note: This test also fails prior to the fix for https://crbug.com/888559
// (in fact, the last two tasks are sufficient as a regression test), probably
// MessageLoopCurrent::ScopedAllowApplicationTasksInNativeNestedLoop which
// will ScheduleWork() upon construction (and if it's absent, the MessageLoop
// shouldn't process application tasks so kMsgHaveWork is irrelevant). Note:
// This test also fails prior to the fix for https://crbug.com/888559 (in
// fact, the last two tasks are sufficient as a regression test), probably
// because of a dangling kMsgHaveWork recreating the effect from
// MessageLoopTest.NativeMsgProcessingDoesntStealWmQuit.
......@@ -2065,7 +2066,8 @@ LRESULT CALLBACK TestWndProcThunk(HWND hwnd,
case 2:
// Since we're about to enter a modal loop, tell the message loop that we
// intend to nest tasks.
MessageLoopCurrent::ScopedNestableTaskAllower allow_nestable_tasks;
MessageLoopCurrent::ScopedAllowApplicationTasksInNativeNestedLoop
allow_nestable_tasks;
bool did_run = false;
ThreadTaskRunnerHandle::Get()->PostTask(
FROM_HERE, base::BindOnce(&EndTest, &did_run, hwnd));
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment