cc:: Add remote mode to the compositor

cc/test/layer_tree_test.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/test/layer_tree_test.h"
 
 #include "base/command_line.h"
 #include "base/location.h"
 #include "base/single_thread_task_runner.h"
 #include "base/thread_task_runner_handle.h"
 #include "cc/animation/animation.h"
 #include "cc/animation/animation_host.h"
 #include "cc/animation/animation_registrar.h"
 #include "cc/animation/layer_animation_controller.h"
 #include "cc/animation/timing_function.h"
 #include "cc/base/switches.h"
 #include "cc/input/input_handler.h"
 #include "cc/layers/layer.h"
 #include "cc/layers/layer_impl.h"
 #include "cc/test/animation_test_common.h"
 #include "cc/test/begin_frame_args_test.h"
 #include "cc/test/fake_external_begin_frame_source.h"
 #include "cc/test/fake_layer_tree_host_client.h"
 #include "cc/test/fake_output_surface.h"
+#include "cc/test/remote_channel_impl_for_test.h"
 #include "cc/test/test_context_provider.h"
 #include "cc/test/test_gpu_memory_buffer_manager.h"
 #include "cc/test/test_shared_bitmap_manager.h"
 #include "cc/test/test_task_graph_runner.h"
+#include "cc/test/threaded_channel_for_test.h"
 #include "cc/trees/layer_tree_host_client.h"
 #include "cc/trees/layer_tree_host_impl.h"
 #include "cc/trees/layer_tree_host_single_thread_client.h"
 #include "cc/trees/layer_tree_impl.h"
 #include "cc/trees/proxy_impl.h"
 #include "cc/trees/proxy_main.h"
+#include "cc/trees/remote_channel_host.h"
+#include "cc/trees/remote_channel_host_client.h"
 #include "cc/trees/single_thread_proxy.h"
 #include "cc/trees/threaded_channel.h"
 #include "testing/gmock/include/gmock/gmock.h"
 #include "ui/gfx/geometry/size_conversions.h"
 
 namespace cc {
 
 void CreateVirtualViewportLayers(Layer* root_layer,
                                  scoped_refptr<Layer> outer_scroll_layer,
                                  const gfx::Size& inner_bounds,
@@ skipping 290 matching lines @@
     LayerTreeHostImpl::NotifyTileStateChanged(tile);
     test_hooks_->NotifyTileStateChangedOnThread(this, tile);
   }
 
  private:
   TestHooks* test_hooks_;
   bool block_notify_ready_to_activate_for_testing_;
   bool notify_ready_to_activate_was_blocked_;
 };
 
+// Implementation of RemoteChannelHostClient for tests.
+class RemoteChannelHostClientForTesting : public RemoteChannelHostClient {
+ public:
+  static scoped_ptr<RemoteChannelHostClientForTesting> Create(
+      TestHooks* test_hooks) {
+    return make_scoped_ptr(new RemoteChannelHostClientForTesting(test_hooks));
+  }
+
+  void OverrideLayerTreeSettings(LayerTreeSettings* settings) override {
+    test_hooks_->OverrideLayerTreeSettings(settings);
+  }
+
+  void DidShutdown() override { test_hooks_->DidShutdown(); }
+
+ private:
+  explicit RemoteChannelHostClientForTesting(TestHooks* test_hooks)
+      : test_hooks_(test_hooks) {}
+
+  TestHooks* test_hooks_;
+};
+
 // Implementation of LayerTreeHost callback interface.
 class LayerTreeHostClientForTesting : public LayerTreeHostClient,
                                       public LayerTreeHostSingleThreadClient {
  public:
   static scoped_ptr<LayerTreeHostClientForTesting> Create(
       TestHooks* test_hooks) {
     return make_scoped_ptr(new LayerTreeHostClientForTesting(test_hooks));
   }
   ~LayerTreeHostClientForTesting() override {}
 
@@ skipping 59 matching lines @@
       scoped_ptr<FrameTimingTracker::MainFrameTimingSet> main_frame_events)
       override {}
 
  private:
   explicit LayerTreeHostClientForTesting(TestHooks* test_hooks)
       : test_hooks_(test_hooks) {}
 
   TestHooks* test_hooks_;
 };
 
+// Injects RemoteChannelImplForTesting.
+class RemoteChannelHostForTesting : public RemoteChannelHost {
+ public:
+  static scoped_ptr<RemoteChannelHostForTesting> Create(
+      TestHooks* test_hooks,
+      RemoteProtoChannel* remote_proto_channel,
+      RemoteChannelHostClient* client,
+      TaskGraphRunner* task_graph_runner,
+      scoped_refptr<base::SingleThreadTaskRunner> main_task_runner,
+      scoped_refptr<base::SingleThreadTaskRunner> impl_task_runner) {
+    return make_scoped_ptr(new RemoteChannelHostForTesting(
+        test_hooks, remote_proto_channel, client, task_graph_runner,
+        main_task_runner, impl_task_runner));
+  }
+
+  RemoteChannelImplForTest* remote_channel_impl_for_test() const {
+    return remote_channel_impl_for_test_;
+  }
+
+ private:
+  RemoteChannelHostForTesting(
+      TestHooks* test_hooks,
+      RemoteProtoChannel* remote_proto_channel,
+      RemoteChannelHostClient* client,
+      TaskGraphRunner* task_graph_runner,
+      scoped_refptr<base::SingleThreadTaskRunner> main_task_runner,
+      scoped_refptr<base::SingleThreadTaskRunner> impl_task_runner)
+      : RemoteChannelHost(remote_proto_channel,
+                          client,
+                          task_graph_runner,
+                          main_task_runner,
+                          impl_task_runner),
+        test_hooks_(test_hooks) {}
+
+  scoped_ptr<RemoteChannelImpl> CreateRemoteChannelImpl(
+      RemoteChannelHost* remote_channel_host,
+      TaskGraphRunner* task_graph_runner,
+      const LayerTreeSettings& settings,
+      scoped_refptr<base::SingleThreadTaskRunner> main_task_runner,
+      scoped_refptr<base::SingleThreadTaskRunner> impl_task_runner) override {
+    scoped_ptr<RemoteChannelImplForTest> channel_impl =
+        RemoteChannelImplForTest::Create(test_hooks_, remote_channel_host,
+                                         task_graph_runner, settings,
+                                         main_task_runner, impl_task_runner);
+    remote_channel_impl_for_test_ = channel_impl.get();
+    return std::move(channel_impl);
+  }
+
+  TestHooks* test_hooks_;
+  RemoteChannelImplForTest* remote_channel_impl_for_test_;
+};
+
 // Adapts LayerTreeHost for test. Injects LayerTreeHostImplForTesting.
 class LayerTreeHostForTesting : public LayerTreeHost {
  public:
   static scoped_ptr<LayerTreeHostForTesting> Create(
       TestHooks* test_hooks,
       CompositorMode mode,
       LayerTreeHostClientForTesting* client,
+      RemoteProtoChannel* remote_proto_channel,
       SharedBitmapManager* shared_bitmap_manager,
       gpu::GpuMemoryBufferManager* gpu_memory_buffer_manager,
       TaskGraphRunner* task_graph_runner,
       const LayerTreeSettings& settings,
       scoped_refptr<base::SingleThreadTaskRunner> main_task_runner,
       scoped_refptr<base::SingleThreadTaskRunner> impl_task_runner,
       scoped_ptr<BeginFrameSource> external_begin_frame_source) {
     LayerTreeHost::InitParams params;
     params.client = client;
     params.shared_bitmap_manager = shared_bitmap_manager;
     params.gpu_memory_buffer_manager = gpu_memory_buffer_manager;
     params.task_graph_runner = task_graph_runner;
     params.settings = &settings;
     scoped_ptr<LayerTreeHostForTesting> layer_tree_host(
         new LayerTreeHostForTesting(test_hooks, &params, mode));
     scoped_ptr<TaskRunnerProvider> task_runner_provider =
         TaskRunnerProvider::Create(main_task_runner, impl_task_runner);
     scoped_ptr<Proxy> proxy;
-    if (mode == CompositorMode::Threaded) {
-      DCHECK(impl_task_runner.get());
-      scoped_ptr<ProxyMain> proxy_main = ProxyMainForTest::CreateThreaded(
-          test_hooks, layer_tree_host.get(), task_runner_provider.get());
-      proxy = std::move(proxy_main);
-    } else {
-      proxy =
-          SingleThreadProxyForTest::Create(test_hooks, layer_tree_host.get(),
-                                           client, task_runner_provider.get());
+    switch (mode) {
+      case CompositorMode::SingleThreaded:
+        proxy = SingleThreadProxyForTest::Create(test_hooks,
+                                                 layer_tree_host.get(), client,
+                                                 task_runner_provider.get());
+        break;
+      case CompositorMode::Threaded:
+        DCHECK(impl_task_runner.get());
+        {
+          scoped_ptr<ProxyMain> proxy_main = ProxyMainForTest::CreateThreaded(
+              test_hooks, layer_tree_host.get(), task_runner_provider.get());
+          proxy = std::move(proxy_main);

[vmpstr, 2016/01/07 19:08:12]

why not just proxy = ProxyMainForTest::CreateThreaded(...)?

[Khushal, 2016/01/08 21:17:19]

I think I was using a temp variable there earlier and the switch statement
didn't like that.
Changed it.

+        }
+        break;
+      case CompositorMode::Remote:
+        DCHECK(!impl_task_runner.get());
+        DCHECK(!external_begin_frame_source);
+        {
+          scoped_ptr<ProxyMain> proxy_main = ProxyMainForTest::CreateRemote(
+              test_hooks, remote_proto_channel, layer_tree_host.get(),
+              task_runner_provider.get());
+          proxy = std::move(proxy_main);

[vmpstr, 2016/01/07 19:08:11]

Same here

[Khushal, 2016/01/08 21:17:19]

Done.

+        }
+        break;
+      default:
+        NOTREACHED();
     }
     layer_tree_host->InitializeForTesting(
         std::move(task_runner_provider), std::move(proxy),
         std::move(external_begin_frame_source));
     return layer_tree_host;
   }
 
   scoped_ptr<LayerTreeHostImpl> CreateLayerTreeHostImpl(
       LayerTreeHostImplClient* host_impl_client) override {
     return LayerTreeHostImplForTesting::Create(
@@ skipping 45 matching lines @@
 
   // Tests should timeout quickly unless --cc-layer-tree-test-no-timeout was
   // specified (for running in a debugger).
   base::CommandLine* command_line = base::CommandLine::ForCurrentProcess();
   if (!command_line->HasSwitch(switches::kCCLayerTreeTestNoTimeout))
     timeout_seconds_ = 5;
 }
 
 LayerTreeTest::~LayerTreeTest() {}
 
+bool LayerTreeTest::IsRemoteTest() const {
+  return mode_ == CompositorMode::Remote;
+}
+
 void LayerTreeTest::EndTest() {
   if (ended_)
     return;
   ended_ = true;
 
   // For the case where we EndTest during BeginTest(), set a flag to indicate
   // that the test should end the second BeginTest regains control.
   if (beginning_) {
     end_when_begin_returns_ = true;
   } else {
@@ skipping 129 matching lines @@
   client_ = LayerTreeHostClientForTesting::Create(this);
 
   scoped_ptr<FakeExternalBeginFrameSource> external_begin_frame_source;
   if (settings_.use_external_begin_frame_source) {
     external_begin_frame_source.reset(new FakeExternalBeginFrameSource(
         settings_.renderer_settings.refresh_rate));
     external_begin_frame_source_ = external_begin_frame_source.get();
   }
 
   DCHECK(!impl_thread_ || impl_thread_->task_runner().get());
-  layer_tree_host_ = LayerTreeHostForTesting::Create(
-      this, mode_, client_.get(), shared_bitmap_manager_.get(),
-      gpu_memory_buffer_manager_.get(), task_graph_runner_.get(), settings_,
-      base::ThreadTaskRunnerHandle::Get(),
-      impl_thread_ ? impl_thread_->task_runner() : NULL,
-      std::move(external_begin_frame_source));
+
+  if (IsRemoteTest()) {
+    // It is important to create the RemoteChannelHost before the LayerTreeHost

[vmpstr, 2016/01/07 19:08:12]

What would be creating remote channel host in non-test? blimp/ code?

[Khushal, 2016/01/08 21:17:19]

As we discussed. I've removed the RemoteChannelHost so we now use the
LayerTreeHost on the client as well.
Its the remote_client_layer_tree_host_ in LayerTreeTest which will be in blimp/
code. Updated this in the comments.

+    // since the main compositor immediately sends an initialization message to
+    // the impl compositor.
+    DCHECK(impl_thread_);
+    remote_channel_host_client_ =
+        RemoteChannelHostClientForTesting::Create(this);
+    remote_channel_host_for_testing_ = RemoteChannelHostForTesting::Create(
+        this, &remote_proto_channel_bridge_.channel_impl,
+        remote_channel_host_client_.get(), task_graph_runner_.get(),
+        base::ThreadTaskRunnerHandle::Get(), impl_thread_->task_runner());
+    DCHECK(remote_proto_channel_bridge_.channel_impl.HasReceiver());
+
+    layer_tree_host_ = LayerTreeHostForTesting::Create(
+        this, mode_, client_.get(), &remote_proto_channel_bridge_.channel_main,
+        nullptr, nullptr, task_graph_runner_.get(), settings_,
+        base::ThreadTaskRunnerHandle::Get(), nullptr,
+        std::move(external_begin_frame_source));
+    DCHECK(remote_proto_channel_bridge_.channel_main.HasReceiver());
+  } else {
+    layer_tree_host_ = LayerTreeHostForTesting::Create(
+        this, mode_, client_.get(), nullptr, shared_bitmap_manager_.get(),
+        gpu_memory_buffer_manager_.get(), task_graph_runner_.get(), settings_,
+        base::ThreadTaskRunnerHandle::Get(),
+        impl_thread_ ? impl_thread_->task_runner() : NULL,
+        std::move(external_begin_frame_source));
+  }
+
   ASSERT_TRUE(layer_tree_host_);
 
   started_ = true;
   beginning_ = true;
   SetupTree();
   WillBeginTest();
   BeginTest();
   beginning_ = false;
   if (end_when_begin_returns_)
     RealEndTest();
@@ skipping 20 matching lines @@
   layer_tree_host_->root_layer()->SetIsDrawable(true);
 }
 
 void LayerTreeTest::Timeout() {
   timed_out_ = true;
   EndTest();
 }
 
 void LayerTreeTest::RealEndTest() {
   // TODO(mithro): Make this method only end when not inside an impl frame.
-  if (layer_tree_host_ && !timed_out_ &&
-      proxy()->MainFrameWillHappenForTesting()) {
+  bool main_frame_will_happen;
+  if (IsRemoteTest()) {
+    main_frame_will_happen =
+        remote_channel_host_for_testing_
+            ? GetRemoteChannelImplForTest()->MainFrameWillHappenForTesting()
+            : false;
+  } else {
+    main_frame_will_happen =
+        layer_tree_host_ ? proxy()->MainFrameWillHappenForTesting() : false;
+  }
+
+  if (main_frame_will_happen && !timed_out_) {
     main_task_runner_->PostTask(
         FROM_HERE,
         base::Bind(&LayerTreeTest::RealEndTest, main_thread_weak_ptr_));
     return;
   }
 
   base::MessageLoop::current()->QuitWhenIdle();
 }
 
 void LayerTreeTest::DispatchAddAnimation(Layer* layer_to_receive_animation,
@@ skipping 65 matching lines @@
     layer_tree_host_->SetNextCommitForcesRedraw();
 }
 
 void LayerTreeTest::DispatchCompositeImmediately() {
   DCHECK(!task_runner_provider() || task_runner_provider()->IsMainThread());
   if (layer_tree_host_)
     layer_tree_host_->Composite(base::TimeTicks::Now());
 }
 
 void LayerTreeTest::RunTest(CompositorMode mode, bool delegating_renderer) {
+  DCHECK(mode != CompositorMode::Deserializable);
   mode_ = mode;
-  if (mode_ == CompositorMode::Threaded) {
+  if (mode_ != CompositorMode::SingleThreaded) {

[vmpstr, 2016/01/07 19:08:12]

I think this should be explicitly mode_ == Threaded || mode_ == Remote.

[Khushal, 2016/01/08 21:17:19]

Done.

     impl_thread_.reset(new base::Thread("Compositor"));
     ASSERT_TRUE(impl_thread_->Start());
   }
 
   main_task_runner_ = base::ThreadTaskRunnerHandle::Get();
 
   shared_bitmap_manager_.reset(new TestSharedBitmapManager);
   gpu_memory_buffer_manager_.reset(new TestGpuMemoryBufferManager);
   task_graph_runner_.reset(new TestTaskGraphRunner);
 
@@ skipping 55 matching lines @@
     return FakeOutputSurface::CreateDelegating3d();
   else
     return FakeOutputSurface::Create3d();
 }
 
 TestWebGraphicsContext3D* LayerTreeTest::TestContext() {
   return static_cast<TestContextProvider*>(output_surface_->context_provider())
       ->TestContext3d();
 }
 
+void LayerTreeTest::DidShutdown() {
+  ReceivedDidShutdown();
+  DestroyRemoteChannelHost();
+}
+
 int LayerTreeTest::LastCommittedSourceFrameNumber(LayerTreeHostImpl* impl)
     const {
   if (impl->pending_tree())
     return impl->pending_tree()->source_frame_number();
   if (impl->active_tree())
     return impl->active_tree()->source_frame_number();
   // Source frames start at 0, so this is invalid.
   return -1;
 }
 
 void LayerTreeTest::DestroyLayerTreeHost() {
   if (layer_tree_host_ && layer_tree_host_->root_layer())
     layer_tree_host_->root_layer()->SetLayerTreeHost(NULL);
   layer_tree_host_ = nullptr;
+
+  DCHECK(!remote_proto_channel_bridge_.channel_main.HasReceiver());
+
+  // Destroying the LayerTreeHost should destroy the RemoteChannelHost.
+  DCHECK(!remote_channel_host_for_testing_);
+}
+
+void LayerTreeTest::DestroyRemoteChannelHost() {
+  DCHECK(IsRemoteTest());
+  DCHECK(remote_channel_host_for_testing_);
+
+  remote_channel_host_for_testing_ = nullptr;
+  DCHECK(!remote_proto_channel_bridge_.channel_impl.HasReceiver());
 }
 
 TaskGraphRunner* LayerTreeTest::task_graph_runner() const {
   return task_graph_runner_.get();
 }
 
 LayerTreeHost* LayerTreeTest::layer_tree_host() {
   // We check for a null task_runner_provider here as we sometimes ask for the
   // layer tree host when the task_runner_provider does not exist, often for
   // checking settings after a test has completed. For example,
   // LTHPixelResourceTest::RunPixelResourceTest. See elsewhere in this file for
   // other examples.
   DCHECK(!task_runner_provider() || task_runner_provider()->IsMainThread() ||
          task_runner_provider()->IsMainThreadBlocked());
   return layer_tree_host_.get();
 }
 
 ProxyMainForTest* LayerTreeTest::GetProxyMainForTest() const {
   DCHECK(HasImplThread());
   return static_cast<ProxyMainForTest*>(proxy());
 }
 
 ProxyImplForTest* LayerTreeTest::GetProxyImplForTest() const {
   DCHECK(HasImplThread());
-  ThreadedChannel* threaded_channel =
-      static_cast<ThreadedChannel*>(GetProxyMainForTest()->channel_main());
-  ProxyImpl* proxy_impl = threaded_channel->GetProxyImplForTesting();
+
+  if (IsRemoteTest()) {
+    return GetRemoteChannelImplForTest()->proxy_impl_for_test();
+  }
+
+  ProxyImplForTest* proxy_impl_for_test =
+      GetThreadedChannelForTest()->proxy_impl_for_test();
 
   // We check for null ProxyImpl since ProxyImpl exists in the ThreadedChannel
   // only after it is initialized.
-  DCHECK(proxy_impl);
-  return static_cast<ProxyImplForTest*>(proxy_impl);
+  DCHECK(proxy_impl_for_test);
+  return proxy_impl_for_test;
+}
+
+ThreadedChannelForTest* LayerTreeTest::GetThreadedChannelForTest() const {
+  DCHECK(mode_ == CompositorMode::Threaded);
+
+  return GetProxyMainForTest()->threaded_channel_for_test();
+}
+
+RemoteChannelImplForTest* LayerTreeTest::GetRemoteChannelImplForTest() const {
+  DCHECK(IsRemoteTest());
+
+  RemoteChannelImplForTest* remote_channel_impl_for_test =
+      remote_channel_host_for_testing_->remote_channel_impl_for_test();
+
+  // We check for null RemoteChannelImpl since it is created only after the
+  // RemoteChannelHost receives the initialization message.
+  DCHECK(remote_channel_impl_for_test);
+  return remote_channel_impl_for_test;
 }
 
 }  // namespace cc