cc: Add scheduler support for invalidating content on impl thread.

cc/scheduler/scheduler_state_machine.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/scheduler_state_machine.h"
 
 #include "base/format_macros.h"
 #include "base/logging.h"
 #include "base/strings/stringprintf.h"
 #include "base/trace_event/trace_event.h"
@@ skipping 15 matching lines @@
       forced_redraw_state_(FORCED_REDRAW_STATE_IDLE),
       commit_count_(0),
       current_frame_number_(0),
       last_frame_number_submit_performed_(-1),
       last_frame_number_draw_performed_(-1),
       last_frame_number_begin_main_frame_sent_(-1),
       last_frame_number_invalidate_compositor_frame_sink_performed_(-1),
       draw_funnel_(false),
       send_begin_main_frame_funnel_(true),
       invalidate_compositor_frame_sink_funnel_(false),
+      impl_side_invalidation_funnel_(false),
       prepare_tiles_funnel_(0),
       consecutive_checkerboard_animations_(0),
       pending_submit_frames_(0),
       submit_frames_with_current_compositor_frame_sink_(0),
       needs_redraw_(false),
       needs_prepare_tiles_(false),
       needs_begin_main_frame_(false),
       needs_one_begin_impl_frame_(false),
       visible_(false),
       begin_frame_source_paused_(false),
       resourceless_draw_(false),
       can_draw_(false),
       has_pending_tree_(false),
       pending_tree_is_ready_for_activation_(false),
       active_tree_needs_first_draw_(false),
       did_create_and_initialize_first_compositor_frame_sink_(false),
       tree_priority_(NEW_CONTENT_TAKES_PRIORITY),
       scroll_handler_state_(
           ScrollHandlerState::SCROLL_DOES_NOT_AFFECT_SCROLL_HANDLER),
       critical_begin_main_frame_to_activate_is_fast_(true),
       main_thread_missed_last_deadline_(false),
       skip_next_begin_main_frame_to_reduce_latency_(false),
       defer_commits_(false),
       video_needs_begin_frames_(false),
       last_commit_had_no_updates_(false),
       wait_for_ready_to_draw_(false),
       did_draw_in_last_frame_(false),
-      did_submit_in_last_frame_(false) {}
+      did_submit_in_last_frame_(false),
+      needs_impl_side_invalidation_(false),
+      previous_pending_tree_was_impl_side_(false),
+      current_pending_tree_is_impl_side_(false) {}
 
 const char* SchedulerStateMachine::CompositorFrameSinkStateToString(
     CompositorFrameSinkState state) {
   switch (state) {
     case COMPOSITOR_FRAME_SINK_NONE:
       return "COMPOSITOR_FRAME_SINK_NONE";
     case COMPOSITOR_FRAME_SINK_ACTIVE:
       return "COMPOSITOR_FRAME_SINK_ACTIVE";
     case COMPOSITOR_FRAME_SINK_CREATING:
       return "COMPOSITOR_FRAME_SINK_CREATING";
@@ skipping 96 matching lines @@
     case ACTION_DRAW_FORCED:
       return "ACTION_DRAW_FORCED";
     case ACTION_DRAW_ABORT:
       return "ACTION_DRAW_ABORT";
     case ACTION_BEGIN_COMPOSITOR_FRAME_SINK_CREATION:
       return "ACTION_BEGIN_COMPOSITOR_FRAME_SINK_CREATION";
     case ACTION_PREPARE_TILES:
       return "ACTION_PREPARE_TILES";
     case ACTION_INVALIDATE_COMPOSITOR_FRAME_SINK:
       return "ACTION_INVALIDATE_COMPOSITOR_FRAME_SINK";
+    case ACTION_PERFORM_IMPL_SIDE_INVALIDATION:
+      return "ACTION_PERFORM_IMPL_SIDE_INVALIDATION";
   }
   NOTREACHED();
   return "???";
 }
 
 std::unique_ptr<base::trace_event::ConvertableToTraceFormat>
 SchedulerStateMachine::AsValue() const {
   std::unique_ptr<base::trace_event::TracedValue> state(
       new base::trace_event::TracedValue());
   AsValueInto(state.get());
@@ skipping 23 matching lines @@
   state->SetInteger("last_frame_number_draw_performed",
                     last_frame_number_draw_performed_);
   state->SetInteger("last_frame_number_begin_main_frame_sent",
                     last_frame_number_begin_main_frame_sent_);
   state->SetBoolean("funnel: draw_funnel", draw_funnel_);
   state->SetBoolean("funnel: send_begin_main_frame_funnel",
                     send_begin_main_frame_funnel_);
   state->SetInteger("funnel: prepare_tiles_funnel", prepare_tiles_funnel_);
   state->SetBoolean("funnel: invalidate_compositor_frame_sink_funnel",
                     invalidate_compositor_frame_sink_funnel_);
+  state->SetBoolean("funnel: impl_side_invalidation_funnel",
+                    impl_side_invalidation_funnel_);
   state->SetInteger("consecutive_checkerboard_animations",
                     consecutive_checkerboard_animations_);
   state->SetInteger("pending_submit_frames_", pending_submit_frames_);
   state->SetInteger("submit_frames_with_current_compositor_frame_sink",
                     submit_frames_with_current_compositor_frame_sink_);
   state->SetBoolean("needs_redraw", needs_redraw_);
   state->SetBoolean("needs_prepare_tiles", needs_prepare_tiles_);
   state->SetBoolean("needs_begin_main_frame", needs_begin_main_frame_);
   state->SetBoolean("needs_one_begin_impl_frame", needs_one_begin_impl_frame_);
   state->SetBoolean("visible", visible_);
@@ skipping 15 matching lines @@
                     critical_begin_main_frame_to_activate_is_fast_);
   state->SetBoolean("main_thread_missed_last_deadline",
                     main_thread_missed_last_deadline_);
   state->SetBoolean("skip_next_begin_main_frame_to_reduce_latency",
                     skip_next_begin_main_frame_to_reduce_latency_);
   state->SetBoolean("video_needs_begin_frames", video_needs_begin_frames_);
   state->SetBoolean("defer_commits", defer_commits_);
   state->SetBoolean("last_commit_had_no_updates", last_commit_had_no_updates_);
   state->SetBoolean("did_draw_in_last_frame", did_draw_in_last_frame_);
   state->SetBoolean("did_submit_in_last_frame", did_submit_in_last_frame_);
+  state->SetBoolean("needs_impl_side_invalidation",
+                    needs_impl_side_invalidation_);
   state->EndDictionary();
 }
 
 bool SchedulerStateMachine::PendingDrawsShouldBeAborted() const {
   // Normally when |visible_| is false or |begin_frame_source_paused_| is true,
   // pending activations will be forced and draws will be aborted. However,
   // when the embedder is Android WebView, software draws could be scheduled by
   // the Android OS at any time and draws should not be aborted in this case.
   bool is_compositor_frame_sink_lost =
       (compositor_frame_sink_state_ == COMPOSITOR_FRAME_SINK_NONE);
@@ skipping 244 matching lines @@
   // and then periodically after that. Use a funnel to make sure we average
   // one PrepareTiles per BeginImplFrame in the long run.
   if (prepare_tiles_funnel_ > 0)
     return false;
 
   // Limiting to once per-frame is not enough, since we only want to
   // prepare tiles _after_ draws.
   if (begin_impl_frame_state_ != BEGIN_IMPL_FRAME_STATE_INSIDE_DEADLINE)
     return false;
 
+  // If an impl-side invalidation request is pending and we are inside the
+  // deadline, then performing these invalidations will also do PrepareTiles.
+  if (needs_impl_side_invalidation_)

[sunnyps, 2017/02/23 00:33:21]

Impl side invalidation will happen before prepare tiles. The invalidation will
do a prepare tiles and fill the prepare tiles funnel. So this should be a
DCHECK.

[Khushal, 2017/02/23 01:25:43]

Done.

[sunnyps, 2017/02/23 01:34:12]

nit: Try moving this DCHECK to WillPrepareTiles. This may not be possible as
WillPrepareTiles is called from outside the scheduler too.

[Khushal, 2017/02/23 07:42:37]

Actually on second look, I don't think this logic/DCHECK is correct. We could
have a case where commit happens, but it doesn't necessarily run a PrepareTiles
(so the |prepare_tiles_funnel_| is empty). It still fills the
|impl_side_invalidation_funnel_| so if we get an impl side invalidation request
after this, it will stay till the next frame. Now something could still request
a PrepareTiles still in the same frame, so we have
|needs_impl_side_invalidation_| and |needs_prepare_tiles_|, but PrepareTiles can
run this frame but the invalidation can not.

There is also the case where calling ShouldPerformImplSideInvalidation requests
another invalidation but running it doesn't do PrepareTiles.

I think having the test to ensure we call ShouldPerformImplSideInvalidation
before ShouldPrepareTiles is enough. We don't need anything else here. Does that
sound right?

+    return false;
+
   return needs_prepare_tiles_;
 }
 
 bool SchedulerStateMachine::ShouldInvalidateCompositorFrameSink() const {
   // Do not invalidate too many times in a frame.
   if (invalidate_compositor_frame_sink_funnel_)
     return false;
 
   // Only the synchronous compositor requires invalidations.
   if (!settings_.using_synchronous_renderer_compositor)
@@ skipping 15 matching lines @@
   if (ShouldCommit())
     return ACTION_COMMIT;
   if (ShouldDraw()) {
     if (PendingDrawsShouldBeAborted())
       return ACTION_DRAW_ABORT;
     else if (forced_redraw_state_ == FORCED_REDRAW_STATE_WAITING_FOR_DRAW)
       return ACTION_DRAW_FORCED;
     else
       return ACTION_DRAW_IF_POSSIBLE;
   }
+  if (ShouldPerformImplSideInvalidation())
+    return ACTION_PERFORM_IMPL_SIDE_INVALIDATION;
   if (ShouldPrepareTiles())
     return ACTION_PREPARE_TILES;
   if (ShouldSendBeginMainFrame())
     return ACTION_SEND_BEGIN_MAIN_FRAME;
   if (ShouldInvalidateCompositorFrameSink())
     return ACTION_INVALIDATE_COMPOSITOR_FRAME_SINK;
   if (ShouldBeginCompositorFrameSinkCreation())
     return ACTION_BEGIN_COMPOSITOR_FRAME_SINK_CREATION;
   return ACTION_NONE;
 }
 
+bool SchedulerStateMachine::ShouldPerformImplSideInvalidation() const {
+  if (!needs_impl_side_invalidation_)
+    return false;
+
+  if (!CouldCreatePendingTree())
+    return false;
+
+  // If the main thread is ready to commit, the impl-side invalidations will be
+  // merged with the incoming main frame.
+  if (begin_main_frame_state_ == BEGIN_MAIN_FRAME_STATE_READY_TO_COMMIT)
+    return false;
+
+  // Don't invalidate too many times in the same frame.
+  if (impl_side_invalidation_funnel_)
+    return false;
+
+  // If invalidations go to the active tree and we are waiting for the previous
+  // frame to be drawn, submitted and acked.
+  if (settings_.commit_to_active_tree &&
+      (active_tree_needs_first_draw_ || IsDrawThrottled())) {
+    return false;
+  }
+
+  // If we are inside the deadline and an impl-side invalidation request is
+  // still pending, do it now. We restrict performing impl-side invalidations
+  // until the deadline to give the main thread a chance to respond to a sent
+  // BeginMainFrame. If the main thread responds with a commit, we know the
+  // invalidations will have been merged with the main frame.
+  // If the commit was aborted, or the main thread fails to respond within the
+  // deadline, then we create a pending tree for impl-side invalidations now.
+  // This also checks to make sure that the |prepare_tiles_funnel_| is not full,
+  // since impl-side invalidations will cause a PrepareTiles.
+  if (begin_impl_frame_state_ == BEGIN_IMPL_FRAME_STATE_INSIDE_DEADLINE &&
+      prepare_tiles_funnel_ == 0)

[sunnyps, 2017/02/23 00:33:21]

nit: braces

[Khushal, 2017/02/23 01:25:43]

Done.

+    return true;
+
+  // Wait till the deadline to perform impl-side invalidations.
+  return false;
+}
+
+void SchedulerStateMachine::WillPerformImplSideInvalidation() {
+  current_pending_tree_is_impl_side_ = true;
+  WillPerformImplSideInvalidationInternal();
+}
+
+void SchedulerStateMachine::WillPerformImplSideInvalidationInternal() {
+  DCHECK(needs_impl_side_invalidation_);
+  DCHECK(!has_pending_tree_);
+
+  needs_impl_side_invalidation_ = false;
+  has_pending_tree_ = true;

[sunnyps, 2017/02/23 00:33:21]

For invalidating active tree (commit_to_active_tree_ = true), the scheduler must
be sent the activation signal (like in commit) or has_pending_tree_ must be
false.

[Khushal, 2017/02/23 01:25:43]

Yup, sending the activation signal will happen in SingleThreadProxy. That's in
my next patch that glues together the scheduler and LTHI changes. It
synchronously notifies ready to activate right after invalidating.

+  impl_side_invalidation_funnel_ = true;
+}
+
+bool SchedulerStateMachine::CouldCreatePendingTree() const {
+  // Can't create a new pending tree till the current one is activated.
+  if (has_pending_tree_)
+    return false;
+
+  // Can't make frames while we're invisible.
+  if (!visible_)
+    return false;
+
+  // If the BeginFrameSource is paused, we will not be able to make any impl
+  // frames.
+  if (begin_frame_source_paused_)
+    return false;
+
+  // Don't create a pending tree till a frame sink is initialized.
+  if (!HasInitializedCompositorFrameSink())
+    return false;
+
+  return true;
+}
+
 void SchedulerStateMachine::WillSendBeginMainFrame() {
   DCHECK(!has_pending_tree_ || settings_.main_frame_before_activation_enabled);
   DCHECK(visible_);
   DCHECK(!begin_frame_source_paused_);
   DCHECK(!send_begin_main_frame_funnel_);
   begin_main_frame_state_ = BEGIN_MAIN_FRAME_STATE_SENT;
   needs_begin_main_frame_ = false;
   send_begin_main_frame_funnel_ = true;
   last_frame_number_begin_main_frame_sent_ = current_frame_number_;
 }
 
 void SchedulerStateMachine::WillCommit(bool commit_has_no_updates) {
   DCHECK(!has_pending_tree_ ||
          (settings_.main_frame_before_activation_enabled &&
           commit_has_no_updates));
   commit_count_++;
   last_commit_had_no_updates_ = commit_has_no_updates;
   begin_main_frame_state_ = BEGIN_MAIN_FRAME_STATE_IDLE;
 
   if (!commit_has_no_updates) {
+    // If there was a commit, the impl-side invalidations will be merged with
+    // it. We always fill the impl-side invalidation funnel here, even if no
+    // request was currently pending, to defer creating another pending tree and
+    // performing PrepareTiles until the next frame, in case the invalidation
+    // request is received after the commit.
+    if (needs_impl_side_invalidation_)
+      WillPerformImplSideInvalidationInternal();
+    impl_side_invalidation_funnel_ = true;
+
     // Pending tree only exists if commit had updates.
     has_pending_tree_ = true;
     pending_tree_is_ready_for_activation_ = false;
     wait_for_ready_to_draw_ = settings_.commit_to_active_tree;
   }
 
   // Update state related to forced draws.
   if (forced_redraw_state_ == FORCED_REDRAW_STATE_WAITING_FOR_COMMIT) {
     forced_redraw_state_ = has_pending_tree_
                                ? FORCED_REDRAW_STATE_WAITING_FOR_ACTIVATION
@@ skipping 14 matching lines @@
       COMPOSITOR_FRAME_SINK_WAITING_FOR_FIRST_ACTIVATION)
     compositor_frame_sink_state_ = COMPOSITOR_FRAME_SINK_ACTIVE;
 
   if (forced_redraw_state_ == FORCED_REDRAW_STATE_WAITING_FOR_ACTIVATION)
     forced_redraw_state_ = FORCED_REDRAW_STATE_WAITING_FOR_DRAW;
 
   has_pending_tree_ = false;
   pending_tree_is_ready_for_activation_ = false;
   active_tree_needs_first_draw_ = true;
   needs_redraw_ = true;
+
+  previous_pending_tree_was_impl_side_ = current_pending_tree_is_impl_side_;
+  current_pending_tree_is_impl_side_ = false;
 }
 
 void SchedulerStateMachine::WillDrawInternal() {
   // If a new active tree is pending after the one we are about to draw,
   // the main thread is in a high latency mode.
   // main_thread_missed_last_deadline_ is here in addition to
   // OnBeginImplFrameIdle for cases where the scheduler aborts draws outside
   // of the deadline.
   main_thread_missed_last_deadline_ = CommitPending() || has_pending_tree_;
 
@@ skipping 50 matching lines @@
 
 void SchedulerStateMachine::WillDraw() {
   DCHECK(!draw_funnel_);
   WillDrawInternal();
 }
 
 void SchedulerStateMachine::DidDraw(DrawResult draw_result) {
   DidDrawInternal(draw_result);
 }
 
+void SchedulerStateMachine::SetNeedsImplSideInvalidation() {
+  needs_impl_side_invalidation_ = true;
+}
+
 void SchedulerStateMachine::AbortDraw() {
   // Pretend like the draw was successful.
   // Note: We may abort at any time and cannot DCHECK that
   // we haven't drawn in or swapped in the last frame here.
   WillDrawInternal();
   DidDrawInternal(DRAW_ABORTED_DRAINING_PIPELINE);
 }
 
 void SchedulerStateMachine::WillPrepareTiles() {
   needs_prepare_tiles_ = false;
@@ skipping 58 matching lines @@
 
 // These are the cases where we require a BeginFrame message to make progress
 // on requested actions.
 bool SchedulerStateMachine::BeginFrameRequiredForAction() const {
   // The forced draw respects our normal draw scheduling, so we need to
   // request a BeginImplFrame for it.
   if (forced_redraw_state_ == FORCED_REDRAW_STATE_WAITING_FOR_DRAW)
     return true;
 
   return needs_redraw_ || needs_one_begin_impl_frame_ ||
-         (needs_begin_main_frame_ && !defer_commits_);
+         (needs_begin_main_frame_ && !defer_commits_) ||
+         needs_impl_side_invalidation_;
 }
 
 // These are cases where we are very likely want a BeginFrame message in the
 // near future. Proactively requesting the BeginImplFrame helps hide the round
 // trip latency of the SetNeedsBeginFrame request that has to go to the
 // Browser.
 // This includes things like drawing soon, but might not actually have a new
 // frame to draw when we receive the next BeginImplFrame.
 bool SchedulerStateMachine::ProactiveBeginFrameWanted() const {
   // Do not be proactive when invisible.
@@ skipping 39 matching lines @@
   current_frame_number_++;
 
   last_commit_had_no_updates_ = false;
   did_draw_in_last_frame_ = false;
   did_submit_in_last_frame_ = false;
   needs_one_begin_impl_frame_ = false;
 
   // Clear funnels for any actions we perform during the frame.
   send_begin_main_frame_funnel_ = false;
   invalidate_compositor_frame_sink_funnel_ = false;
+  impl_side_invalidation_funnel_ = false;
 
   // "Drain" the PrepareTiles funnel.
   if (prepare_tiles_funnel_ > 0)
     prepare_tiles_funnel_--;
 }
 
 void SchedulerStateMachine::OnBeginImplFrameDeadline() {
   begin_impl_frame_state_ = BEGIN_IMPL_FRAME_STATE_INSIDE_DEADLINE;
 
   // Clear funnels for any actions we perform during the deadline.
@@ skipping 263 matching lines @@
     case COMPOSITOR_FRAME_SINK_ACTIVE:
     case COMPOSITOR_FRAME_SINK_WAITING_FOR_FIRST_COMMIT:
     case COMPOSITOR_FRAME_SINK_WAITING_FOR_FIRST_ACTIVATION:
       return true;
   }
   NOTREACHED();
   return false;
 }
 
 }  // namespace cc