Use message passing for BeginFrameAndCommitState and clean up forced commit logic

cc/scheduler_state_machine_unittest.cc

 // Copyright 2011 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "cc/scheduler_state_machine.h"
 
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace cc {
 namespace {
 
 const SchedulerStateMachine::CommitState allCommitStates[] = {
     SchedulerStateMachine::COMMIT_STATE_IDLE,
     SchedulerStateMachine::COMMIT_STATE_FRAME_IN_PROGRESS,
     SchedulerStateMachine::COMMIT_STATE_READY_TO_COMMIT,
     SchedulerStateMachine::COMMIT_STATE_WAITING_FOR_FIRST_DRAW
 };
 
 // Exposes the protected state fields of the SchedulerStateMachine for testing
 class StateMachine : public SchedulerStateMachine {
 public:
     void setCommitState(CommitState cs) { m_commitState = cs; }
     CommitState commitState() const { return  m_commitState; }
 
-    void setNeedsCommit(bool b) { m_needsCommit = b; }
     bool needsCommit() const { return m_needsCommit; }
 
-    void setNeedsForcedCommit(bool b) { m_needsForcedCommit = b; }
-    bool needsForcedCommit() const { return m_needsForcedCommit; }
-
     void setNeedsRedraw(bool b) { m_needsRedraw = b; }
     bool needsRedraw() const { return m_needsRedraw; }
 
     void setNeedsForcedRedraw(bool b) { m_needsForcedRedraw = b; }
     bool needsForcedRedraw() const { return m_needsForcedRedraw; }
 
     bool canDraw() const { return m_canDraw; }
     bool insideVSync() const { return m_insideVSync; }
     bool visible() const { return m_visible; }
 };
 
 TEST(SchedulerStateMachineTest, TestNextActionBeginsFrameIfNeeded)
 {
     // If no commit needed, do nothing
     {
         StateMachine state;
         state.setCommitState(SchedulerStateMachine::COMMIT_STATE_IDLE);
         state.setCanBeginFrame(true);
         state.setNeedsRedraw(false);
-        state.setNeedsCommit(false);
         state.setVisible(true);
 
         EXPECT_FALSE(state.vsyncCallbackNeeded());
 
         state.didLeaveVSync();
         EXPECT_EQ(SchedulerStateMachine::ACTION_NONE, state.nextAction());
         EXPECT_FALSE(state.vsyncCallbackNeeded());
         state.didEnterVSync();
         EXPECT_EQ(SchedulerStateMachine::ACTION_NONE, state.nextAction());
     }
 
     // If commit requested but canBeginFrame is still false, do nothing.
     {
         StateMachine state;
         state.setCommitState(SchedulerStateMachine::COMMIT_STATE_IDLE);
         state.setNeedsRedraw(false);
-        state.setNeedsCommit(false);
         state.setVisible(true);
 
         EXPECT_FALSE(state.vsyncCallbackNeeded());
 
         state.didLeaveVSync();
         EXPECT_EQ(SchedulerStateMachine::ACTION_NONE, state.nextAction());
         EXPECT_FALSE(state.vsyncCallbackNeeded());
         state.didEnterVSync();
         EXPECT_EQ(SchedulerStateMachine::ACTION_NONE, state.nextAction());
     }
 
 
     // If commit requested, begin a frame
     {
         StateMachine state;
         state.setCommitState(SchedulerStateMachine::COMMIT_STATE_IDLE);
         state.setCanBeginFrame(true);
         state.setNeedsRedraw(false);
-        state.setNeedsCommit(true);
         state.setVisible(true);
         EXPECT_FALSE(state.vsyncCallbackNeeded());
     }
 
     // Begin the frame, make sure needsCommit and commitState update correctly.
     {
         StateMachine state;
         state.setCanBeginFrame(true);
         state.setVisible(true);
         state.updateState(SchedulerStateMachine::ACTION_BEGIN_FRAME);
@@ skipping 262 matching lines @@
             StateMachine state;
             state.setCommitState(allCommitStates[i]);
             bool visible = j;
             if (!visible) {
                 state.didEnterVSync();
                 state.setVisible(false);
             } else
                 state.setVisible(true);
 
             // Case 1: needsCommit=false
-            state.setNeedsCommit(false);
             EXPECT_NE(SchedulerStateMachine::ACTION_DRAW_IF_POSSIBLE, state.nextAction());
 
             // Case 2: needsCommit=true
-            state.setNeedsCommit(true);
+            state.setNeedsCommit();
             EXPECT_NE(SchedulerStateMachine::ACTION_DRAW_IF_POSSIBLE, state.nextAction());
         }
     }
 
     // When on vsync, or not on vsync but needsForcedRedraw set, should always draw except if you're ready to commit, in which case commit.
     for (size_t i = 0; i < numCommitStates; ++i) {
         for (unsigned j = 0; j < 2; ++j) {
             StateMachine state;
             state.setCanDraw(true);
             state.setCommitState(allCommitStates[i]);
             bool forcedDraw = j;
             if (!forcedDraw) {
                 state.didEnterVSync();
                 state.setNeedsRedraw(true);
                 state.setVisible(true);
             } else
                 state.setNeedsForcedRedraw(true);
 
             SchedulerStateMachine::Action expectedAction;
             if (allCommitStates[i] != SchedulerStateMachine::COMMIT_STATE_READY_TO_COMMIT)
                 expectedAction = forcedDraw ? SchedulerStateMachine::ACTION_DRAW_FORCED : SchedulerStateMachine::ACTION_DRAW_IF_POSSIBLE;
             else
                 expectedAction = SchedulerStateMachine::ACTION_COMMIT;
 
             // Case 1: needsCommit=false.
-            state.setNeedsCommit(false);
             EXPECT_TRUE(state.vsyncCallbackNeeded());
             EXPECT_EQ(expectedAction, state.nextAction());
 
             // Case 2: needsCommit=true.
-            state.setNeedsCommit(true);
+            state.setNeedsCommit();
             EXPECT_TRUE(state.vsyncCallbackNeeded());
             EXPECT_EQ(expectedAction, state.nextAction());
         }
     }
 }
 
 TEST(SchedulerStateMachineTest, TestNoCommitStatesRedrawWhenInvisible)
 {
     size_t numCommitStates = sizeof(allCommitStates) / sizeof(SchedulerStateMachine::CommitState);
     for (size_t i = 0; i < numCommitStates; ++i) {
         // There shouldn't be any drawing regardless of vsync.
         for (unsigned j = 0; j < 2; ++j) {
             StateMachine state;
             state.setCommitState(allCommitStates[i]);
             state.setVisible(false);
             state.setNeedsRedraw(true);
             state.setNeedsForcedRedraw(false);
             if (j == 1)
                 state.didEnterVSync();
 
             // Case 1: needsCommit=false.
-            state.setNeedsCommit(false);
             EXPECT_NE(SchedulerStateMachine::ACTION_DRAW_IF_POSSIBLE, state.nextAction());
 
             // Case 2: needsCommit=true.
-            state.setNeedsCommit(true);
+            state.setNeedsCommit();
             EXPECT_NE(SchedulerStateMachine::ACTION_DRAW_IF_POSSIBLE, state.nextAction());
         }
     }
 }
 
 TEST(SchedulerStateMachineTest, TestCanRedraw_StopsDraw)
 {
     size_t numCommitStates = sizeof(allCommitStates) / sizeof(SchedulerStateMachine::CommitState);
     for (size_t i = 0; i < numCommitStates; ++i) {
         // There shouldn't be any drawing regardless of vsync.
@@ skipping 10 matching lines @@
             EXPECT_NE(SchedulerStateMachine::ACTION_DRAW_IF_POSSIBLE, state.nextAction());
         }
     }
 }
 
 TEST(SchedulerStateMachineTest, TestCanRedrawWithWaitingForFirstDrawMakesProgress)
 {
     StateMachine state;
     state.setCommitState(SchedulerStateMachine::COMMIT_STATE_WAITING_FOR_FIRST_DRAW);
     state.setCanBeginFrame(true);
-    state.setNeedsCommit(true);
+    state.setNeedsCommit();
     state.setNeedsRedraw(true);
     state.setVisible(true);
     state.setCanDraw(false);
     EXPECT_EQ(SchedulerStateMachine::ACTION_BEGIN_FRAME, state.nextAction());
 }
 
 TEST(SchedulerStateMachineTest, TestSetNeedsCommitIsNotLost)
 {
     StateMachine state;
     state.setCanBeginFrame(true);
-    state.setNeedsCommit(true);
+    state.setNeedsCommit();
     state.setVisible(true);
     state.setCanDraw(true);
 
     // Begin the frame.
     EXPECT_EQ(SchedulerStateMachine::ACTION_BEGIN_FRAME, state.nextAction());
     state.updateState(state.nextAction());
     EXPECT_EQ(SchedulerStateMachine::COMMIT_STATE_FRAME_IN_PROGRESS, state.commitState());
 
     // Now, while the frame is in progress, set another commit.
-    state.setNeedsCommit(true);
+    state.setNeedsCommit();
     EXPECT_TRUE(state.needsCommit());
 
     // Let the frame finish.
     state.beginFrameComplete();
     EXPECT_EQ(SchedulerStateMachine::COMMIT_STATE_READY_TO_COMMIT, state.commitState());
 
     // Expect to commit regardless of vsync state.
     state.didLeaveVSync();
     EXPECT_EQ(SchedulerStateMachine::ACTION_COMMIT, state.nextAction());
     state.didEnterVSync();
@@ skipping 12 matching lines @@
 }
 
 TEST(SchedulerStateMachineTest, TestFullCycle)
 {
     StateMachine state;
     state.setCanBeginFrame(true);
     state.setVisible(true);
     state.setCanDraw(true);
 
     // Start clean and set commit.
-    state.setNeedsCommit(true);
+    state.setNeedsCommit();
     EXPECT_EQ(SchedulerStateMachine::ACTION_BEGIN_FRAME, state.nextAction());
 
     // Begin the frame.
     state.updateState(SchedulerStateMachine::ACTION_BEGIN_FRAME);
     EXPECT_EQ(SchedulerStateMachine::COMMIT_STATE_FRAME_IN_PROGRESS, state.commitState());
     EXPECT_FALSE(state.needsCommit());
     EXPECT_EQ(SchedulerStateMachine::ACTION_NONE, state.nextAction());
 
     // Tell the scheduler the frame finished.
     state.beginFrameComplete();
@@ skipping 22 matching lines @@
 }
 
 TEST(SchedulerStateMachineTest, TestFullCycleWithCommitRequestInbetween)
 {
     StateMachine state;
     state.setCanBeginFrame(true);
     state.setVisible(true);
     state.setCanDraw(true);
 
     // Start clean and set commit.
-    state.setNeedsCommit(true);
+    state.setNeedsCommit();
     EXPECT_EQ(SchedulerStateMachine::ACTION_BEGIN_FRAME, state.nextAction());
 
     // Begin the frame.
     state.updateState(SchedulerStateMachine::ACTION_BEGIN_FRAME);
     EXPECT_EQ(SchedulerStateMachine::COMMIT_STATE_FRAME_IN_PROGRESS, state.commitState());
     EXPECT_FALSE(state.needsCommit());
     EXPECT_EQ(SchedulerStateMachine::ACTION_NONE, state.nextAction());
 
     // Request another commit while the commit is in flight.
-    state.setNeedsCommit(true);
+    state.setNeedsCommit();
     EXPECT_EQ(SchedulerStateMachine::ACTION_NONE, state.nextAction());
 
     // Tell the scheduler the frame finished.
     state.beginFrameComplete();
     EXPECT_EQ(SchedulerStateMachine::COMMIT_STATE_READY_TO_COMMIT, state.commitState());
     EXPECT_EQ(SchedulerStateMachine::ACTION_COMMIT, state.nextAction());
 
     // Commit.
     state.updateState(SchedulerStateMachine::ACTION_COMMIT);
     EXPECT_EQ(SchedulerStateMachine::COMMIT_STATE_WAITING_FOR_FIRST_DRAW, state.commitState());
@@ skipping 11 matching lines @@
 
     // Should be synchronized, no draw needed, no action needed.
     EXPECT_EQ(SchedulerStateMachine::COMMIT_STATE_IDLE, state.commitState());
     EXPECT_FALSE(state.needsRedraw());
     EXPECT_EQ(SchedulerStateMachine::ACTION_BEGIN_FRAME, state.nextAction());
 }
 
 TEST(SchedulerStateMachineTest, TestRequestCommitInvisible)
 {
     StateMachine state;
-    state.setNeedsCommit(true);
+    state.setNeedsCommit();
     EXPECT_EQ(SchedulerStateMachine::ACTION_NONE, state.nextAction());
 }
 
 TEST(SchedulerStateMachineTest, TestGoesInvisibleBeforeBeginFrameCompletes)
 {
     StateMachine state;
     state.setCanBeginFrame(true);
     state.setVisible(true);
     state.setCanDraw(true);
 
     // Start clean and set commit.
-    state.setNeedsCommit(true);
+    state.setNeedsCommit();
     EXPECT_EQ(SchedulerStateMachine::ACTION_BEGIN_FRAME, state.nextAction());
 
     // Begin the frame while visible.
     state.updateState(SchedulerStateMachine::ACTION_BEGIN_FRAME);
     EXPECT_EQ(SchedulerStateMachine::COMMIT_STATE_FRAME_IN_PROGRESS, state.commitState());
     EXPECT_FALSE(state.needsCommit());
     EXPECT_EQ(SchedulerStateMachine::ACTION_NONE, state.nextAction());
 
     // Become invisible and abort the beginFrame.
     state.setVisible(false);
@@ skipping 49 matching lines @@
 
     state.didLoseContext();
 
     EXPECT_EQ(SchedulerStateMachine::ACTION_BEGIN_CONTEXT_RECREATION, state.nextAction());
     state.updateState(state.nextAction());
 
     // Once context recreation begins, nothing should happen.
     EXPECT_EQ(SchedulerStateMachine::ACTION_NONE, state.nextAction());
 
     // While context is recreating, commits shouldn't begin.
-    state.setNeedsCommit(true);
+    state.setNeedsCommit();
     EXPECT_EQ(SchedulerStateMachine::ACTION_NONE, state.nextAction());
 
     // Recreate the context
     state.didRecreateContext();
 
     // When the context is recreated, we should begin a commit
     EXPECT_EQ(SchedulerStateMachine::ACTION_BEGIN_FRAME, state.nextAction());
     state.updateState(state.nextAction());
 
     // Once the context is recreated, whether we draw should be based on
     // setCanDraw.
     state.setNeedsRedraw(true);
     state.didEnterVSync();
     EXPECT_EQ(SchedulerStateMachine::ACTION_DRAW_IF_POSSIBLE, state.nextAction());
     state.setCanDraw(false);
     EXPECT_EQ(SchedulerStateMachine::ACTION_NONE, state.nextAction());
     state.setCanDraw(true);
     state.didLeaveVSync();
 }
 
 TEST(SchedulerStateMachineTest, TestContextLostWhileCommitInProgress)
 {
     StateMachine state;
     state.setCanBeginFrame(true);
     state.setVisible(true);
     state.setCanDraw(true);
 
     // Get a commit in flight.
-    state.setNeedsCommit(true);
+    state.setNeedsCommit();
     EXPECT_EQ(SchedulerStateMachine::ACTION_BEGIN_FRAME, state.nextAction());
     state.updateState(state.nextAction());
 
     // Set damage and expect a draw.
     state.setNeedsRedraw(true);
     state.didEnterVSync();
     EXPECT_EQ(SchedulerStateMachine::ACTION_DRAW_IF_POSSIBLE, state.nextAction());
     state.updateState(state.nextAction());
     state.didLeaveVSync();
 
@@ skipping 22 matching lines @@
 }
 
 TEST(SchedulerStateMachineTest, TestContextLostWhileCommitInProgressAndAnotherCommitRequested)
 {
     StateMachine state;
     state.setCanBeginFrame(true);
     state.setVisible(true);
     state.setCanDraw(true);
 
     // Get a commit in flight.
-    state.setNeedsCommit(true);
+    state.setNeedsCommit();
     EXPECT_EQ(SchedulerStateMachine::ACTION_BEGIN_FRAME, state.nextAction());
     state.updateState(state.nextAction());
 
     // Set damage and expect a draw.
     state.setNeedsRedraw(true);
     state.didEnterVSync();
     EXPECT_EQ(SchedulerStateMachine::ACTION_DRAW_IF_POSSIBLE, state.nextAction());
     state.updateState(state.nextAction());
     state.didLeaveVSync();
 
     // Cause a lost context while the begin frame is in flight.
     state.didLoseContext();
 
     // Ask for another draw and also set needs commit. Expect nothing happens.
     state.setNeedsRedraw(true);
-    state.setNeedsCommit(true);
+    state.setNeedsCommit();
     EXPECT_EQ(SchedulerStateMachine::ACTION_NONE, state.nextAction());
 
     // Finish the frame, and commit.
     state.beginFrameComplete();
     EXPECT_EQ(SchedulerStateMachine::ACTION_COMMIT, state.nextAction());
     state.updateState(state.nextAction());
 
     EXPECT_EQ(SchedulerStateMachine::COMMIT_STATE_WAITING_FOR_FIRST_DRAW, state.commitState());
 
     EXPECT_EQ(SchedulerStateMachine::ACTION_DRAW_IF_POSSIBLE, state.nextAction());
@@ skipping 34 matching lines @@
     state.didEnterVSync();
     EXPECT_EQ(SchedulerStateMachine::ACTION_DRAW_FORCED, state.nextAction());
     state.didLeaveVSync();
 }
 
 TEST(SchedulerStateMachineTest, TestBeginFrameWhenInvisibleAndForceCommit)
 {
     StateMachine state;
     state.setCanBeginFrame(true);
     state.setVisible(false);
-    state.setNeedsCommit(true);
-    state.setNeedsForcedCommit(true);
+    state.setNeedsCommit();
+    state.setNeedsForcedCommit();
     EXPECT_EQ(SchedulerStateMachine::ACTION_BEGIN_FRAME, state.nextAction());
 }
 
 TEST(SchedulerStateMachineTest, TestBeginFrameWhenCanBeginFrameFalseAndForceCommit)
 {
     StateMachine state;
     state.setVisible(true);
     state.setCanDraw(true);
-    state.setNeedsCommit(true);
-    state.setNeedsForcedCommit(true);
+    state.setNeedsCommit();
+    state.setNeedsForcedCommit();
     EXPECT_EQ(SchedulerStateMachine::ACTION_BEGIN_FRAME, state.nextAction());
 }
 
 TEST(SchedulerStateMachineTest, TestBeginFrameWhenCommitInProgress)
 {
     StateMachine state;
     state.setCanBeginFrame(true);
     state.setVisible(false);
     state.setCommitState(SchedulerStateMachine::COMMIT_STATE_FRAME_IN_PROGRESS);
-    state.setNeedsCommit(true);
-    state.setNeedsForcedCommit(true);
+    state.setNeedsCommit();
+    state.setNeedsForcedCommit();
 
     state.beginFrameComplete();
     EXPECT_EQ(SchedulerStateMachine::ACTION_COMMIT, state.nextAction());
     state.updateState(state.nextAction());
 
     EXPECT_EQ(SchedulerStateMachine::COMMIT_STATE_WAITING_FOR_FIRST_DRAW, state.commitState());
 
     EXPECT_EQ(SchedulerStateMachine::ACTION_BEGIN_FRAME, state.nextAction());
 }
 
 TEST(SchedulerStateMachineTest, TestBeginFrameWhenContextLost)
 {
     StateMachine state;
     state.setCanBeginFrame(true);
     state.setVisible(true);
     state.setCanDraw(true);
-    state.setNeedsCommit(true);
-    state.setNeedsForcedCommit(true);
+    state.setNeedsCommit();
+    state.setNeedsForcedCommit();
     state.didLoseContext();
     EXPECT_EQ(SchedulerStateMachine::ACTION_BEGIN_FRAME, state.nextAction());
 }
 
+TEST(SchedulerStateMachineTest, TestImmediateBeginFrame)
+{
+    StateMachine state;
+    state.setCanBeginFrame(true);
+    state.setVisible(true);
+    state.setCanDraw(true);
+
+    // Schedule a forced frame, commit it, draw it.
+    state.setNeedsCommit();
+    state.setNeedsForcedCommit();
+    state.updateState(state.nextAction());
+    state.beginFrameComplete();
+    EXPECT_EQ(SchedulerStateMachine::ACTION_COMMIT, state.nextAction());
+    EXPECT_EQ(SchedulerStateMachine::COMMIT_STATE_READY_TO_COMMIT, state.commitState());
+    state.updateState(state.nextAction());
+
+    state.didEnterVSync();
+    EXPECT_EQ(SchedulerStateMachine::ACTION_DRAW_IF_POSSIBLE, state.nextAction());
+    state.updateState(state.nextAction());
+    state.didDrawIfPossibleCompleted(true);
+   state.didLeaveVSync();
+
+   // Should be waiting for the normal begin frame
+   EXPECT_EQ(SchedulerStateMachine::COMMIT_STATE_FRAME_IN_PROGRESS, state.commitState());
+}
+
+TEST(SchedulerStateMachineTest, TestImmediateBeginFrameDuringCommit)
+{
+   StateMachine state;
+   state.setCanBeginFrame(true);
+   state.setVisible(true);
+   state.setCanDraw(true);
+
+   // Start a normal commit.
+   state.setNeedsCommit();
+   state.updateState(state.nextAction());
+
+   // Schedule a forced frame, commit it, draw it.
+   state.setNeedsCommit();
+   state.setNeedsForcedCommit();
+   state.updateState(state.nextAction());
+   state.beginFrameComplete();
+   EXPECT_EQ(SchedulerStateMachine::ACTION_COMMIT, state.nextAction());
+   EXPECT_EQ(SchedulerStateMachine::COMMIT_STATE_READY_TO_COMMIT, state.commitState());
+   state.updateState(state.nextAction());
+
+   state.didEnterVSync();
+   EXPECT_EQ(SchedulerStateMachine::ACTION_DRAW_IF_POSSIBLE, state.nextAction());
+   state.updateState(state.nextAction());
+   state.didDrawIfPossibleCompleted(true);
+   state.didLeaveVSync();
+
+   // Should be waiting for the normal begin frame
+   EXPECT_EQ(SchedulerStateMachine::COMMIT_STATE_FRAME_IN_PROGRESS, state.commitState()) << state.toString();
+}
+
+TEST(SchedulerStateMachineTest, ImmediateBeginFrameWhileInvisible)
+{
+   StateMachine state;
+   state.setCanBeginFrame(true);
+   state.setVisible(true);
+   state.setCanDraw(true);
+
+   state.setNeedsCommit();
+   state.updateState(state.nextAction());
+
+   state.setNeedsCommit();
+   state.setNeedsForcedCommit();
+   state.updateState(state.nextAction());
+   state.beginFrameComplete();
+
+   EXPECT_EQ(SchedulerStateMachine::ACTION_COMMIT, state.nextAction());
+   EXPECT_EQ(SchedulerStateMachine::COMMIT_STATE_READY_TO_COMMIT, state.commitState());
+   state.updateState(state.nextAction());
+
+   state.didEnterVSync();
+   EXPECT_EQ(SchedulerStateMachine::ACTION_DRAW_IF_POSSIBLE, state.nextAction());
+   state.updateState(state.nextAction());
+   state.didDrawIfPossibleCompleted(true);
+   state.didLeaveVSync();
+
+   // Should be waiting for the normal begin frame
+   EXPECT_EQ(SchedulerStateMachine::COMMIT_STATE_FRAME_IN_PROGRESS, state.commitState()) << state.toString();
+
+
+   // Become invisible and abort the "normal" begin frame.
+   state.setVisible(false);
+   state.beginFrameAborted();
+
+   // Should be back in the idle state, but needing a commit.
+   EXPECT_EQ(SchedulerStateMachine::COMMIT_STATE_IDLE, state.commitState());
+   EXPECT_TRUE(state.needsCommit());
+}
+
 }  // namespace
 }  // namespace cc