Allow layers to signal that additional sequences are needed before surface destruction

cc/layers/surface_layer_unittest.cc

Index: cc/layers/surface_layer_unittest.cc
diff --git a/cc/layers/surface_layer_unittest.cc b/cc/layers/surface_layer_unittest.cc
new file mode 100644
index 0000000000000000000000000000000000000000..0e0a7b84eb813fce0213346ebe2447b99615d5ae
--- /dev/null
+++ b/cc/layers/surface_layer_unittest.cc
@@ -0,0 +1,198 @@
+// Copyright 2014 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/layers/surface_layer.h"
+#include "cc/test/fake_impl_proxy.h"
+#include "cc/test/fake_layer_tree_host.h"
+#include "cc/test/fake_layer_tree_host_client.h"
+#include "cc/test/fake_layer_tree_host_impl.h"
+#include "cc/test/fake_output_surface.h"
+#include "cc/test/layer_tree_test.h"
+#include "cc/test/test_shared_bitmap_manager.h"
+#include "cc/trees/layer_tree_host.h"
+#include "testing/gmock/include/gmock/gmock.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+namespace cc {
+namespace {
+
+class SurfaceLayerTest : public testing::Test {
+ public:
+  SurfaceLayerTest()
+      : fake_client_(
+            FakeLayerTreeHostClient(FakeLayerTreeHostClient::DIRECT_3D)) {}
+
+ protected:
+  virtual void SetUp() {
+    layer_tree_host_ = FakeLayerTreeHost::Create(&fake_client_);
+    layer_tree_host_->SetViewportSize(gfx::Size(10, 10));
+  }
+
+  virtual void TearDown() {
+    if (layer_tree_host_) {
+      layer_tree_host_->SetRootLayer(nullptr);
+      layer_tree_host_ = nullptr;
+    }
+  }
+
+  scoped_ptr<FakeLayerTreeHost> layer_tree_host_;
+  FakeLayerTreeHostClient fake_client_;
+  TestSharedBitmapManager shared_bitmap_manager_;
+};
+
+void SatisfyCallback(SurfaceSequence* out, SurfaceSequence in) {
+  *out = in;
+}
+
+// Check that one surface can be referenced by multiple LayerTreeHosts, and
+// each will create its own SurfaceSequence that's satisfied on destruction.
+TEST_F(SurfaceLayerTest, MultipleFramesOneSurface) {
+  SurfaceSequence blank_change;  // Receives sequence if commit doesn't happen.
+  scoped_refptr<SurfaceHolder> holder(new SurfaceHolder(
+      SurfaceId(), base::Bind(&SatisfyCallback, &blank_change)));
+  scoped_refptr<SurfaceLayer> layer(SurfaceLayer::Create());
+  layer->SetSurfaceId(holder);
+  layer_tree_host_->set_surface_id_namespace(1);
+  layer_tree_host_->SetRootLayer(layer);
+
+  scoped_ptr<FakeLayerTreeHost> layer_tree_host2 =
+      FakeLayerTreeHost::Create(&fake_client_);
+  scoped_refptr<SurfaceLayer> layer2(SurfaceLayer::Create());
+  layer2->SetSurfaceId(holder);
+  layer_tree_host2->set_surface_id_namespace(2);
+  layer_tree_host2->SetRootLayer(layer2);
+
+  // Layers haven't been removed, so no sequence should be satisfied.
+  EXPECT_TRUE(blank_change.is_null());
+
+  SurfaceSequence expected1(1u, 1u);
+  SurfaceSequence expected2(2u, 1u);
+
+  layer_tree_host2->SetRootLayer(nullptr);
+  layer_tree_host2.reset();
+
+  // Layer was removed so sequence from second LayerTreeHost should be
+  // satisfied.
+  EXPECT_TRUE(blank_change == expected2);
+
+  // Set of sequences that need to be satisfied should include sequences from
+  // both trees.
+  std::set<SurfaceSequence> finished_sequences;
+  holder->GetSequenceSet(&finished_sequences);
+  ASSERT_EQ(2u, finished_sequences.size());
+  EXPECT_TRUE(finished_sequences.count(expected1));
+  EXPECT_TRUE(finished_sequences.count(expected2));
+
+  layer_tree_host_->SetRootLayer(nullptr);
+  layer_tree_host_.reset();
+
+  // Layer was removed so sequence from first LayerTreeHost should be
+  // satisfied.
+  EXPECT_TRUE(blank_change == expected1);
+
+  // No more SurfaceSequences should have been generated that need to have be
+  // satisfied.
+  finished_sequences.clear();
+  holder->GetSequenceSet(&finished_sequences);
+  EXPECT_EQ(0u, finished_sequences.size());
+}
+
+// Check that removing and adding a layer to the same tree doesn't generate a
+// new SurfaceSequence to be satisfied.
+class SurfaceLayerSingleSwapPromise : public LayerTreeTest {
+ public:
+  SurfaceLayerSingleSwapPromise()
+      : commit_count_(0), sequence_was_satisfied_(false) {}
+
+  void BeginTest() override {
+    layer_tree_host()->set_surface_id_namespace(1);
+    holder_ = new SurfaceHolder(
+        SurfaceId(), base::Bind(&SatisfyCallback, &satisfied_sequence_));
+    layer_ = SurfaceLayer::Create();
+    layer_->SetSurfaceId(holder_);
+
+    // Layer hasn't been added to tree so no SurfaceSequence generated yet.
+    std::set<SurfaceSequence> finished_sequences;
+    holder_->GetSequenceSet(&finished_sequences);
+    EXPECT_EQ(0u, finished_sequences.size());
+
+    layer_tree_host()->SetRootLayer(layer_);
+
+    // Should have SurfaceSequence from first tree.
+    SurfaceSequence expected(1u, 1u);
+    holder_->GetSequenceSet(&finished_sequences);
+    ASSERT_EQ(1u, finished_sequences.size());
+    EXPECT_TRUE(finished_sequences.count(expected));
+
+    gfx::Size bounds(100, 100);
+    layer_tree_host()->SetViewportSize(bounds);
+    PostSetNeedsCommitToMainThread();
+  }
+
+  void DidCommit() override {
+    ++commit_count_;
+    switch (commit_count_) {
+      case 1: {
+        // Remove and add layer to tree and ensure no new SurfaceSequence
+        // needs to be satisfied.
+        layer_tree_host()->SetRootLayer(nullptr);
+        layer_tree_host()->SetRootLayer(layer_);
+        std::set<SurfaceSequence> finished_sequences;
+        holder_->GetSequenceSet(&finished_sequences);
+        EXPECT_EQ(0u, finished_sequences.size());
+        break;
+      }
+      case 2:
+        // Remove SurfaceLayer from tree to cause SwapPromise to be created.
+        blank_layer_ = Layer::Create();
+        blank_layer_->SetIsDrawable(true);
+        blank_layer_->SetBounds(gfx::Size(10, 10));
+        layer_tree_host()->SetRootLayer(blank_layer_);
+        break;
+      case 3:
+        break;
+      default:
+        NOTREACHED();
+        break;
+    }
+  }
+
+  void SwapBuffersOnThread(LayerTreeHostImpl* host_impl, bool result) override {
+    EXPECT_TRUE(result);
+    std::vector<uint32_t>& satisfied =
+        output_surface()->last_sent_frame().metadata.satisfies_sequences;
+    EXPECT_LE(satisfied.size(), 1u);
+    if (satisfied.size() == 1) {
+      // Eventually the one SurfaceSequence should be satisfied, but only
+      // after the layer was removed from the tree, and only once.
+      EXPECT_EQ(1u, satisfied[0]);
+      EXPECT_LE(2, commit_count_);
+      EXPECT_FALSE(sequence_was_satisfied_);
+      sequence_was_satisfied_ = true;
+      EndTest();
+    }
+  }
+
+  void AfterTest() override {
+    std::set<SurfaceSequence> finished_sequences;
+    holder_->GetSequenceSet(&finished_sequences);
+    EXPECT_EQ(0u, finished_sequences.size());
+    // Sequence should have been satisfied through Swap, not with the
+    // callback.
+    EXPECT_TRUE(satisfied_sequence_.is_null());
+  }
+
+ private:
+  int commit_count_;
+  bool sequence_was_satisfied_;
+  scoped_refptr<SurfaceHolder> holder_;
+  scoped_refptr<SurfaceLayer> layer_;
+  scoped_refptr<Layer> blank_layer_;
+  SurfaceSequence satisfied_sequence_;
+};
+
+SINGLE_THREAD_TEST_F(SurfaceLayerSingleSwapPromise);
+
+}  // namespace
+}  // namespace cc