Add SwapPromise support to LayerTreeHost and LayerTreeImpl

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"
 #include "cc/animation/timing_function.h"
+#include "cc/base/swap_promise.h"
 #include "cc/debug/frame_rate_counter.h"
 #include "cc/layers/content_layer.h"
 #include "cc/layers/content_layer_client.h"
 #include "cc/layers/io_surface_layer.h"
 #include "cc/layers/layer_impl.h"
 #include "cc/layers/painted_scrollbar_layer.h"
 #include "cc/layers/picture_layer.h"
 #include "cc/layers/solid_color_layer.h"
 #include "cc/layers/video_layer.h"
 #include "cc/output/begin_frame_args.h"
@@ skipping 5186 matching lines @@
   size_t first_output_surface_memory_limit_;
   size_t second_output_surface_memory_limit_;
   FakeContentLayerClient client_;
   scoped_refptr<FakeContentLayer> root_;
 };
 
 // No output to copy for delegated renderers.
 SINGLE_AND_MULTI_THREAD_TEST_F(
     LayerTreeHostTestSetMemoryPolicyOnLostOutputSurface);
 
+struct SwapPromiseResult {
+  bool did_swap_called;
+  bool did_not_swap_called;
+  bool dtor_called;
+  SwapPromise::DidNotSwapReason reason;
+};
+
+class TestSwapPromise : public SwapPromise {
+ public:
+  explicit TestSwapPromise(SwapPromiseResult* result)
+      : SwapPromise(SWAP_PROMISE_UNKNOWN),
+        result_(result) {
+  }
+
+  virtual ~TestSwapPromise() {
+    result_->dtor_called = true;
+  }
+
+  virtual void DidSwap() OVERRIDE {
+    EXPECT_FALSE(result_->did_swap_called);
+    EXPECT_FALSE(result_->did_not_swap_called);
+    result_->did_swap_called = true;
+  }
+
+  virtual void DidNotSwap(DidNotSwapReason reason) {
+    EXPECT_FALSE(result_->did_swap_called);
+    EXPECT_FALSE(result_->did_not_swap_called);
+    result_->did_not_swap_called = true;
+    result_->reason = reason;
+  }
+
+ private:
+  // Not owned.
+  SwapPromiseResult* result_;
+};
+
+class LayerTreeHostTestBreakSwapPromise
+    : public LayerTreeHostTest {
+ protected:
+  LayerTreeHostTestBreakSwapPromise()
+      : commit_count_(0), commit_complete_count_(0) {
+    memset(&swap_promise_result_, 0, sizeof(swap_promise_result_));

[danakj, 2013/11/13 23:22:09]

Make a constructor on SwapPromiseResult instead of needing to memset() elsewhere

[Yufeng Shen (Slow to review), 2013/11/14 22:09:55]

Done.

+  }
+
+  virtual void InitializeSettings(LayerTreeSettings* settings) OVERRIDE {
+    settings->begin_impl_frame_scheduling_enabled = true;

[danakj, 2013/11/13 23:22:09]

Why is this needed?

[Yufeng Shen (Slow to review), 2013/11/14 22:09:55]

removed.

+  }
+
+  virtual void WillBeginMainFrame() OVERRIDE {
+    layer_tree_host()->QueueSwapPromise(
+        new TestSwapPromise(&swap_promise_result_[commit_count_]));
+  }
+
+  virtual void BeginTest() OVERRIDE { PostSetNeedsCommitToMainThread(); }
+
+  virtual void DidCommit() OVERRIDE {
+    commit_count_++;

[danakj, 2013/11/13 23:22:09]

You can use layer_tree_host()->source_frame_number() instead of tracking that
again here as commit_count_

[Yufeng Shen (Slow to review), 2013/11/14 22:09:55]

I think here what we want is that after we have tried twice BeginMainFrame, we
want schedule a third commit that will finish.

Notice that even though we aborted the second commit, DidCommit()
was still called, so we have the right number commit_count_ = 2,
while source frame number remains 1 after the second commit aborts,
so we can't tell from it how many commits we have tried.

+    if (commit_count_ == 2) {
+      // This commit will finish.
+      layer_tree_host()->SetNeedsCommit();
+    }
+  }
+
+  virtual void CommitCompleteOnThread(LayerTreeHostImpl* host_impl) OVERRIDE {
+    commit_complete_count_++;
+    if (commit_complete_count_ == 1) {
+      // This commit will be aborted.

[danakj, 2013/11/13 23:22:09]

I think that a better way to make an aborted commit would be to SetNeedsUpdate()
on the layer tree host with no invalidations on the layers.

[Yufeng Shen (Slow to review), 2013/11/14 22:09:55]

Done.

+      host_impl->SetNeedsCommit();
+    } else {
+      EndTest();
+    }
+  }
+
+  virtual void AfterTest() OVERRIDE {
+    // 3 commits are scheduled. 2 completes. 1 is aborted.
+    EXPECT_EQ(commit_count_, 3);
+    EXPECT_EQ(commit_complete_count_, 2);
+
+    // The first commit completes and causes swap buffer wihch finishes

[danakj, 2013/11/13 23:22:09]

which

[Yufeng Shen (Slow to review), 2013/11/14 22:09:55]

Done.

+    // the promise.
+    EXPECT_TRUE(swap_promise_result_[0].did_swap_called);
+    EXPECT_FALSE(swap_promise_result_[0].did_not_swap_called);
+    EXPECT_TRUE(swap_promise_result_[0].dtor_called);
+
+    // The second commit aborts.
+    EXPECT_FALSE(swap_promise_result_[1].did_swap_called);
+    EXPECT_TRUE(swap_promise_result_[1].did_not_swap_called);
+    EXPECT_EQ(SwapPromise::COMMIT_FAILS, swap_promise_result_[1].reason);
+    EXPECT_TRUE(swap_promise_result_[1].dtor_called);
+
+    // The last commit completes but it does not cause swap buffer because
+    // there is no damage in the frame data.
+    EXPECT_FALSE(swap_promise_result_[2].did_swap_called);
+    EXPECT_TRUE(swap_promise_result_[2].did_not_swap_called);
+    EXPECT_EQ(SwapPromise::SWAP_FAILS, swap_promise_result_[2].reason);
+    EXPECT_TRUE(swap_promise_result_[2].dtor_called);
+  }
+
+  int commit_count_;
+  int commit_complete_count_;
+  SwapPromiseResult swap_promise_result_[3];
+};
+
+MULTI_THREAD_TEST_F(LayerTreeHostTestBreakSwapPromise);
+
 }  // namespace cc