Keeping track of descendants that draw content instead of recalcualting

cc/trees/layer_tree_host_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/trees/layer_tree_host.h"
 
 #include <algorithm>
 
 #include "base/auto_reset.h"
 #include "base/synchronization/lock.h"
@@ skipping 2958 matching lines @@
     if (persist_needs_push_properties_)
       needs_push_properties_ = true;
   }
 
   virtual scoped_ptr<LayerImpl> CreateLayerImpl(LayerTreeImpl* tree_impl)
       OVERRIDE {
     return PushPropertiesCountingLayerImpl::Create(tree_impl, id()).
         PassAs<LayerImpl>();
   }
 
+  void SetDrawsContent(bool draws_content) {
+    UpdateDrawsContent(draws_content);
+  }
+
   size_t push_properties_count() const { return push_properties_count_; }
   void reset_push_properties_count() { push_properties_count_ = 0; }
 
   void set_persist_needs_push_properties(bool persist) {
     persist_needs_push_properties_ = persist;
   }
 
  private:
   PushPropertiesCountingLayer()
       : push_properties_count_(0), persist_needs_push_properties_(false) {
     SetBounds(gfx::Size(1, 1));
     SetIsDrawable(true);

[danakj, 2014/07/17 17:21:26]

What if we don't set this to true. How many of these tests don't need to be
changed? Or can we not set it true only for some tests and leave them unchanged
by this CL then?

[awoloszyn, 2014/07/17 20:45:00]

Very good call. We actually don't have to change any of the tests if we don't
set that to true. This actually makes me wonder why that was set to true in the
first place, but that's fairly irrelevant. I have reverted this file, except for
the new tests that I added, and have removed the SetIsDrawable.
On 2014/07/17 17:21:26, danakj wrote:

   }
   virtual ~PushPropertiesCountingLayer() {}
 
   size_t push_properties_count_;
   bool persist_needs_push_properties_;
 };
 
 class LayerTreeHostTestLayersPushProperties : public LayerTreeHostTest {
  protected:
   virtual void BeginTest() OVERRIDE {
@@ skipping 95 matching lines @@
         ++expected_push_properties_child_;
         ++expected_push_properties_grandchild_;
         ++expected_push_properties_child2_;
         break;
       case 5:
         layer_tree_host()->SetNeedsCommit();
         // No layers need commit.
         break;
       case 6:
         child_->RemoveFromParent();
         // No layers need commit.

[danakj, 2014/07/17 17:21:25]

Update comment explaining why this happens now

[awoloszyn, 2014/07/17 20:45:00]

Done.

+        ++expected_push_properties_root_;
         break;
       case 7:
         root_->AddChild(child_);
         // Layers added to the tree get committed.

[danakj, 2014/07/17 17:21:26]

update comment

[awoloszyn, 2014/07/17 20:45:01]

Done.

         ++expected_push_properties_child_;
         ++expected_push_properties_grandchild_;
+        ++expected_push_properties_root_;
         break;
       case 8:
+        ++expected_push_properties_root_;

[danakj, 2014/07/17 17:21:26]

move below the comment and update it to reflect why this happens

[awoloszyn, 2014/07/17 20:45:00]

Done.

+        ++expected_push_properties_child_;
         grandchild_->RemoveFromParent();
         // No layers need commit.
         break;
       case 9:
         child_->AddChild(grandchild_);
         // Layers added to the tree get committed.

[danakj, 2014/07/17 17:21:26]

update comment

[awoloszyn, 2014/07/17 20:45:01]

Done.

         ++expected_push_properties_grandchild_;
+        ++expected_push_properties_root_;
+        ++expected_push_properties_child_;
         break;
       case 10:
         layer_tree_host()->SetViewportSize(gfx::Size(20, 20));
         // No layers need commit.
         break;
       case 11:
         layer_tree_host()->SetPageScaleFactorAndLimits(1.f, 0.8f, 1.1f);
         // No layers need commit.
         break;
       case 12:
         child_->SetPosition(gfx::Point(1, 1));
         // The modified layer needs commit
         ++expected_push_properties_child_;
         break;
       case 13:
         child2_->SetPosition(gfx::Point(1, 1));
         // The modified layer needs commit
         ++expected_push_properties_child2_;
         break;
       case 14:
         child_->RemoveFromParent();
         root_->AddChild(child_);
         // Layers added to the tree get committed.

[danakj, 2014/07/17 17:21:26]

update comment

[awoloszyn, 2014/07/17 20:45:00]

Done.

         ++expected_push_properties_child_;
         ++expected_push_properties_grandchild_;
+        ++expected_push_properties_root_;
         break;
       case 15:
         grandchild_->SetPosition(gfx::Point(1, 1));
         // The modified layer needs commit
         ++expected_push_properties_grandchild_;
         break;
       case 16:
         // SetNeedsDisplay does not always set needs commit (so call it
         // explicitly), but is a property change.
         child_->SetNeedsDisplay();
@@ skipping 92 matching lines @@
         expected_push_properties_child_impl_ =
             expected_push_properties_child2_impl_;
         expected_push_properties_child2_impl_ = 0;
         // grandchild_impl becomes grandchild2_impl.
         expected_push_properties_grandchild_impl_ =
             expected_push_properties_grandchild2_impl_;
         expected_push_properties_grandchild2_impl_ = 0;
 
         // grandchild_impl is now the leaf that always pushes. It is pushed.
         ++expected_push_properties_grandchild_impl_;
+        ++expected_push_properties_root_impl_;

[danakj, 2014/07/17 17:21:25]

explain this one in comment too

[awoloszyn, 2014/07/17 20:45:00]

Done.

         break;
       case 7:
         // The leaf that always pushes is pushed.
         ++expected_push_properties_grandchild_impl_;
 
         // Child is added back. New layers are initialized.
         ++expected_push_properties_grandchild2_impl_;
         ++expected_push_properties_child2_impl_;
+        ++expected_push_properties_root_impl_;

[danakj, 2014/07/17 17:21:26]

explain with commetn

[awoloszyn, 2014/07/17 20:45:00]

Done.

         break;
       case 8:
         // Leaf is removed.
         expected_push_properties_grandchild2_impl_ = 0;
 
         // Always pushing.
         ++expected_push_properties_grandchild_impl_;
+        ++expected_push_properties_child2_impl_;

[danakj, 2014/07/17 17:21:26]

explain with comment

[awoloszyn, 2014/07/17 20:45:01]

Done.

+        ++expected_push_properties_root_impl_;
         break;
       case 9:
         // Leaf is added back
         ++expected_push_properties_grandchild2_impl_;
 
         // The leaf that always pushes is pushed.
         ++expected_push_properties_grandchild_impl_;
+        ++expected_push_properties_root_impl_;

[danakj, 2014/07/17 17:21:26]

explain with comment

[awoloszyn, 2014/07/17 20:45:00]

Done.

+        ++expected_push_properties_child2_impl_;
         break;
       case 10:
         // The leaf that always pushes is pushed.
         ++expected_push_properties_grandchild_impl_;
         break;
       case 11:
         // The leaf that always pushes is pushed.
         ++expected_push_properties_grandchild_impl_;
         break;
       case 12:
@@ skipping 14 matching lines @@
         // Second child is removed from tree. Don't discard counts because
         // they are added back before commit.
 
         // The leaf that always pushes is pushed.
         ++expected_push_properties_grandchild_impl_;
 
         // Second child added back.
         ++expected_push_properties_child2_impl_;
         ++expected_push_properties_grandchild2_impl_;
 
+        ++expected_push_properties_root_impl_;
         break;
       case 15:
         // The position of this child was changed.
         ++expected_push_properties_grandchild2_impl_;
 
         // The leaf that always pushes is pushed.
         ++expected_push_properties_grandchild_impl_;
         break;
       case 16:
         // Second child is invalidated with SetNeedsDisplay
@@ skipping 112 matching lines @@
   }
 
   virtual void AfterTest() OVERRIDE {}
 
   scoped_refptr<Layer> root_;
   scoped_refptr<FakePaintedScrollbarLayer> scrollbar_layer_;
 };
 
 MULTI_THREAD_TEST_F(LayerTreeHostTestPropertyChangesDuringUpdateArePushed);
 
+class LayerTreeHostTestSetDrawableCausesCommit : public LayerTreeHostTest {
+ protected:
+  virtual void BeginTest() OVERRIDE { PostSetNeedsCommitToMainThread(); }
+
+  virtual void SetupTree() OVERRIDE {
+    root_ = PushPropertiesCountingLayer::Create();
+    child_ = PushPropertiesCountingLayer::Create();
+    root_->AddChild(child_);
+
+    layer_tree_host()->SetRootLayer(root_);
+    LayerTreeHostTest::SetupTree();
+  }
+
+  virtual void DidCommitAndDrawFrame() OVERRIDE {
+    switch (layer_tree_host()->source_frame_number()) {
+      case 0:
+        break;
+      case 1: {
+        // During update, the ignore_set_needs_commit_ bit is set to true to
+        // avoid causing a second commit to be scheduled. If a property change
+        // is made during this, however, it needs to be pushed in the upcoming
+        // commit.
+        EXPECT_FALSE(root_->needs_push_properties());
+        EXPECT_FALSE(child_->needs_push_properties());
+        EXPECT_EQ(1, root_->NumDescendantsThatDrawContent());
+        root_->reset_push_properties_count();
+        child_->reset_push_properties_count();
+        child_->SetDrawsContent(false);
+        EXPECT_EQ(0, root_->NumDescendantsThatDrawContent());
+        EXPECT_EQ(0u, root_->push_properties_count());
+        EXPECT_EQ(0u, child_->push_properties_count());
+        EXPECT_TRUE(root_->needs_push_properties());
+        EXPECT_TRUE(child_->needs_push_properties());
+        break;
+      }
+      case 2:
+        EXPECT_EQ(1u, root_->push_properties_count());
+        EXPECT_EQ(1u, child_->push_properties_count());
+        EXPECT_FALSE(root_->needs_push_properties());
+        EXPECT_FALSE(child_->needs_push_properties());
+        EndTest();
+        break;
+    }
+  }
+
+  virtual void AfterTest() OVERRIDE {}
+
+  scoped_refptr<PushPropertiesCountingLayer> root_;
+  scoped_refptr<PushPropertiesCountingLayer> child_;
+};
+
+MULTI_THREAD_TEST_F(LayerTreeHostTestSetDrawableCausesCommit);
+
 class LayerTreeHostTestCasePushPropertiesThreeGrandChildren
     : public LayerTreeHostTest {
  protected:
   virtual void BeginTest() OVERRIDE {
     expected_push_properties_root_ = 0;
     expected_push_properties_child_ = 0;
     expected_push_properties_grandchild1_ = 0;
     expected_push_properties_grandchild2_ = 0;
     expected_push_properties_grandchild3_ = 0;
     PostSetNeedsCommitToMainThread();
@@ skipping 87 matching lines @@
         EXPECT_FALSE(grandchild1_->needs_push_properties());
         EXPECT_FALSE(grandchild1_->descendant_needs_push_properties());
         EXPECT_FALSE(grandchild2_->needs_push_properties());
         EXPECT_FALSE(grandchild2_->descendant_needs_push_properties());
         EXPECT_FALSE(grandchild3_->needs_push_properties());
         EXPECT_FALSE(grandchild3_->descendant_needs_push_properties());
 
         grandchild1_->RemoveFromParent();
         grandchild1_->SetPosition(gfx::Point(1, 1));
 
-        EXPECT_FALSE(root_->needs_push_properties());
-        EXPECT_FALSE(root_->descendant_needs_push_properties());
-        EXPECT_FALSE(child_->needs_push_properties());
+        EXPECT_TRUE(root_->needs_push_properties());
+        EXPECT_TRUE(root_->descendant_needs_push_properties());
+        EXPECT_TRUE(child_->needs_push_properties());
         EXPECT_FALSE(child_->descendant_needs_push_properties());
         EXPECT_FALSE(grandchild2_->needs_push_properties());
         EXPECT_FALSE(grandchild2_->descendant_needs_push_properties());
         EXPECT_FALSE(grandchild3_->needs_push_properties());
         EXPECT_FALSE(grandchild3_->descendant_needs_push_properties());
 
         child_->AddChild(grandchild1_);
 
-        EXPECT_FALSE(root_->needs_push_properties());
+        EXPECT_TRUE(root_->needs_push_properties());
         EXPECT_TRUE(root_->descendant_needs_push_properties());
-        EXPECT_FALSE(child_->needs_push_properties());
+        EXPECT_TRUE(child_->needs_push_properties());
         EXPECT_TRUE(child_->descendant_needs_push_properties());
         EXPECT_TRUE(grandchild1_->needs_push_properties());
         EXPECT_FALSE(grandchild1_->descendant_needs_push_properties());
         EXPECT_FALSE(grandchild2_->needs_push_properties());
         EXPECT_FALSE(grandchild2_->descendant_needs_push_properties());
         EXPECT_FALSE(grandchild3_->needs_push_properties());
         EXPECT_FALSE(grandchild3_->descendant_needs_push_properties());
 
         grandchild2_->SetPosition(gfx::Point(1, 1));
 
-        EXPECT_FALSE(root_->needs_push_properties());
+        EXPECT_TRUE(root_->needs_push_properties());
         EXPECT_TRUE(root_->descendant_needs_push_properties());
-        EXPECT_FALSE(child_->needs_push_properties());
+        EXPECT_TRUE(child_->needs_push_properties());
         EXPECT_TRUE(child_->descendant_needs_push_properties());
         EXPECT_TRUE(grandchild1_->needs_push_properties());
         EXPECT_FALSE(grandchild1_->descendant_needs_push_properties());
         EXPECT_TRUE(grandchild2_->needs_push_properties());
         EXPECT_FALSE(grandchild2_->descendant_needs_push_properties());
         EXPECT_FALSE(grandchild3_->needs_push_properties());
         EXPECT_FALSE(grandchild3_->descendant_needs_push_properties());
 
         // grandchild2_ will still need a push properties.
         grandchild1_->RemoveFromParent();
 
-        EXPECT_FALSE(root_->needs_push_properties());
+        EXPECT_TRUE(root_->needs_push_properties());
         EXPECT_TRUE(root_->descendant_needs_push_properties());
-        EXPECT_FALSE(child_->needs_push_properties());
+        EXPECT_TRUE(child_->needs_push_properties());
         EXPECT_TRUE(child_->descendant_needs_push_properties());
 
         // grandchild3_ does not need a push properties, so recursing should
         // no longer be needed.
         grandchild2_->RemoveFromParent();
 
-        EXPECT_FALSE(root_->needs_push_properties());
-        EXPECT_FALSE(root_->descendant_needs_push_properties());
-        EXPECT_FALSE(child_->needs_push_properties());
+        EXPECT_TRUE(root_->needs_push_properties());
+        EXPECT_TRUE(root_->descendant_needs_push_properties());
+        EXPECT_TRUE(child_->needs_push_properties());
         EXPECT_FALSE(child_->descendant_needs_push_properties());
         EndTest();
         break;
     }
   }
 };
 
 MULTI_THREAD_TEST_F(LayerTreeHostTestPushPropertiesRemovingChildStopsRecursion);
 
 class LayerTreeHostTestPushPropertiesRemovingChildStopsRecursionWithPersistence
@@ skipping 15 matching lines @@
         EXPECT_TRUE(grandchild1_->needs_push_properties());
         EXPECT_FALSE(grandchild1_->descendant_needs_push_properties());
         EXPECT_TRUE(grandchild2_->needs_push_properties());
         EXPECT_FALSE(grandchild2_->descendant_needs_push_properties());
         EXPECT_FALSE(grandchild3_->needs_push_properties());
         EXPECT_FALSE(grandchild3_->descendant_needs_push_properties());
 
         // grandchild2_ will still need a push properties.
         grandchild1_->RemoveFromParent();
 
-        EXPECT_FALSE(root_->needs_push_properties());
+        // We will need push properties because our drawable children changed

[danakj, 2014/07/17 17:21:25]

nit: .

[awoloszyn, 2014/07/17 20:45:00]

Done.

+        EXPECT_TRUE(root_->needs_push_properties());
         EXPECT_TRUE(root_->descendant_needs_push_properties());
-        EXPECT_FALSE(child_->needs_push_properties());
+        EXPECT_TRUE(child_->needs_push_properties());
         EXPECT_TRUE(child_->descendant_needs_push_properties());
 
         // grandchild3_ does not need a push properties, so recursing should
         // no longer be needed.
         grandchild2_->RemoveFromParent();
 
-        EXPECT_FALSE(root_->needs_push_properties());
-        EXPECT_FALSE(root_->descendant_needs_push_properties());
-        EXPECT_FALSE(child_->needs_push_properties());
+        EXPECT_TRUE(root_->needs_push_properties());
+        EXPECT_TRUE(root_->descendant_needs_push_properties());
+        EXPECT_TRUE(child_->needs_push_properties());
         EXPECT_FALSE(child_->descendant_needs_push_properties());
         EndTest();
         break;
     }
   }
 };
 
 MULTI_THREAD_TEST_F(
     LayerTreeHostTestPushPropertiesRemovingChildStopsRecursionWithPersistence);
 
@@ skipping 17 matching lines @@
         EXPECT_FALSE(grandchild2_->descendant_needs_push_properties());
         EXPECT_FALSE(grandchild3_->needs_push_properties());
         EXPECT_FALSE(grandchild3_->descendant_needs_push_properties());
 
         // Change grandchildren while their parent is not in the tree.
         child_->RemoveFromParent();
         grandchild1_->SetPosition(gfx::Point(1, 1));
         grandchild2_->SetPosition(gfx::Point(1, 1));
         root_->AddChild(child_);
 
-        EXPECT_FALSE(root_->needs_push_properties());
+        EXPECT_TRUE(root_->needs_push_properties());
         EXPECT_TRUE(root_->descendant_needs_push_properties());
         EXPECT_TRUE(child_->needs_push_properties());
         EXPECT_TRUE(child_->descendant_needs_push_properties());
         EXPECT_TRUE(grandchild1_->needs_push_properties());
         EXPECT_FALSE(grandchild1_->descendant_needs_push_properties());
         EXPECT_TRUE(grandchild2_->needs_push_properties());
         EXPECT_FALSE(grandchild2_->descendant_needs_push_properties());
         EXPECT_TRUE(grandchild3_->needs_push_properties());
         EXPECT_FALSE(grandchild3_->descendant_needs_push_properties());
 
         grandchild1_->RemoveFromParent();
 
-        EXPECT_FALSE(root_->needs_push_properties());
+        EXPECT_TRUE(root_->needs_push_properties());
         EXPECT_TRUE(root_->descendant_needs_push_properties());
         EXPECT_TRUE(child_->needs_push_properties());
         EXPECT_TRUE(child_->descendant_needs_push_properties());
 
         grandchild2_->RemoveFromParent();
 
-        EXPECT_FALSE(root_->needs_push_properties());
+        EXPECT_TRUE(root_->needs_push_properties());
         EXPECT_TRUE(root_->descendant_needs_push_properties());
         EXPECT_TRUE(child_->needs_push_properties());
         EXPECT_TRUE(child_->descendant_needs_push_properties());
 
         grandchild3_->RemoveFromParent();
 
-        EXPECT_FALSE(root_->needs_push_properties());
+        EXPECT_TRUE(root_->needs_push_properties());
         EXPECT_TRUE(root_->descendant_needs_push_properties());
         EXPECT_TRUE(child_->needs_push_properties());
         EXPECT_FALSE(child_->descendant_needs_push_properties());
 
         EndTest();
         break;
     }
   }
 };
 
@@ skipping 31 matching lines @@
         EXPECT_TRUE(child_->descendant_needs_push_properties());
         EXPECT_TRUE(grandchild1_->needs_push_properties());
         EXPECT_FALSE(grandchild1_->descendant_needs_push_properties());
         EXPECT_TRUE(grandchild2_->needs_push_properties());
         EXPECT_FALSE(grandchild2_->descendant_needs_push_properties());
         EXPECT_FALSE(grandchild3_->needs_push_properties());
         EXPECT_FALSE(grandchild3_->descendant_needs_push_properties());
 
         grandchild1_->RemoveFromParent();
 
-        EXPECT_FALSE(root_->needs_push_properties());
+        EXPECT_TRUE(root_->needs_push_properties());
         EXPECT_TRUE(root_->descendant_needs_push_properties());
         EXPECT_TRUE(child_->needs_push_properties());
         EXPECT_TRUE(child_->descendant_needs_push_properties());
 
         grandchild2_->RemoveFromParent();
 
-        EXPECT_FALSE(root_->needs_push_properties());
+        EXPECT_TRUE(root_->needs_push_properties());
         EXPECT_TRUE(root_->descendant_needs_push_properties());
         EXPECT_TRUE(child_->needs_push_properties());
         EXPECT_FALSE(child_->descendant_needs_push_properties());
 
         child_->RemoveFromParent();
 
-        EXPECT_FALSE(root_->needs_push_properties());
+        EXPECT_TRUE(root_->needs_push_properties());
         EXPECT_FALSE(root_->descendant_needs_push_properties());
 
         EndTest();
         break;
     }
   }
 };
 
 MULTI_THREAD_TEST_F(
     LayerTreeHostTestPushPropertiesSetPropertyInParentThenChild);
@@ skipping 29 matching lines @@
         EXPECT_TRUE(child_->descendant_needs_push_properties());
         EXPECT_TRUE(grandchild1_->needs_push_properties());
         EXPECT_FALSE(grandchild1_->descendant_needs_push_properties());
         EXPECT_TRUE(grandchild2_->needs_push_properties());
         EXPECT_FALSE(grandchild2_->descendant_needs_push_properties());
         EXPECT_FALSE(grandchild3_->needs_push_properties());
         EXPECT_FALSE(grandchild3_->descendant_needs_push_properties());
 
         grandchild1_->RemoveFromParent();
 
-        EXPECT_FALSE(root_->needs_push_properties());
+        EXPECT_TRUE(root_->needs_push_properties());
         EXPECT_TRUE(root_->descendant_needs_push_properties());
         EXPECT_TRUE(child_->needs_push_properties());
         EXPECT_TRUE(child_->descendant_needs_push_properties());
 
         grandchild2_->RemoveFromParent();
 
-        EXPECT_FALSE(root_->needs_push_properties());
+        EXPECT_TRUE(root_->needs_push_properties());
         EXPECT_TRUE(root_->descendant_needs_push_properties());
         EXPECT_TRUE(child_->needs_push_properties());
         EXPECT_FALSE(child_->descendant_needs_push_properties());
 
         child_->RemoveFromParent();
 
-        EXPECT_FALSE(root_->needs_push_properties());
+        EXPECT_TRUE(root_->needs_push_properties());
         EXPECT_FALSE(root_->descendant_needs_push_properties());
 
         EndTest();
         break;
     }
   }
 };
 
 MULTI_THREAD_TEST_F(
     LayerTreeHostTestPushPropertiesSetPropertyInChildThenParent);
@@ skipping 1043 matching lines @@
   const gfx::Size bounds_;
   FakeContentLayerClient client_;
   scoped_refptr<ContentLayerWithUpdateTracking> content_layer_;
   scoped_refptr<FakePictureLayer> picture_layer_;
   Layer* child_layer_;
 };
 
 MULTI_THREAD_TEST_F(LayerTreeHostTestContinuousPainting);
 
 }  // namespace cc