cc: Unify context losing machinery

cc/layer_tree_host_unittest_context.cc

 // Copyright 2012 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/layer_tree_host.h"
 
 #include "base/basictypes.h"
 #include "cc/content_layer.h"
 #include "cc/delegated_renderer_layer.h"
 #include "cc/delegated_renderer_layer_impl.h"
@@ skipping 27 matching lines @@
 namespace cc {
 namespace {
 
 // These tests deal with losing the 3d graphics context.
 class LayerTreeHostContextTest : public ThreadedTest {
  public:
   LayerTreeHostContextTest()
       : ThreadedTest(),
         context3d_(NULL),
         times_to_fail_create_(0),
-        times_to_create_and_lose_(0),
+        times_to_fail_initialize_(0),
+        times_to_lose_on_create_(0),
         times_to_lose_during_commit_(0),
-        times_to_repeat_loss_(0),
-        times_to_fail_recreate_(0) {
+        times_to_lose_during_draw_(0),
+        times_to_fail_recreate_(0),
+        times_to_fail_reinitialize_(0),
+        times_to_lose_on_recreate_(0) {
     media::InitializeMediaLibraryForTesting();
   }
 
   void LoseContext() {
     context3d_->loseContextCHROMIUM();
     context3d_ = NULL;
   }
 
   virtual scoped_ptr<FakeWebGraphicsContext3D> CreateContext3d() {
     return FakeWebGraphicsContext3D::Create();
   }
 
   virtual scoped_ptr<OutputSurface> createOutputSurface() OVERRIDE {
     if (times_to_fail_create_) {
       --times_to_fail_create_;
       return scoped_ptr<OutputSurface>();
     }
 
     scoped_ptr<FakeWebGraphicsContext3D> context3d = CreateContext3d();
     context3d_ = context3d.get();
 
-    if (times_to_create_and_lose_) {
-      --times_to_create_and_lose_;
+    if (times_to_fail_initialize_) {
+      --times_to_fail_initialize_;
       // Make the context get lost during reinitialization.
       // The number of times MakeCurrent succeeds is not important, and
       // can be changed if needed to make this pass with future changes.
       context3d_->set_times_make_current_succeeds(2);
+    } else if (times_to_lose_on_create_) {
+      --times_to_lose_on_create_;
+      LoseContext();
     }
 
     return FakeOutputSurface::Create3d(
         context3d.PassAs<WebGraphicsContext3D>()).PassAs<OutputSurface>();
   }
 
+    virtual bool prepareToDrawOnThread(
+        LayerTreeHostImpl*, LayerTreeHostImpl::FrameData&, bool result)
+        OVERRIDE {
+      EXPECT_TRUE(result);
+      if (!times_to_lose_during_draw_)
+        return result;
+
+      --times_to_lose_during_draw_;
+      if (context3d_)
+        context3d_->set_times_make_current_succeeds(0);
+      return result;
+    }
+
   virtual void commitCompleteOnThread(LayerTreeHostImpl *host_impl) OVERRIDE {
     if (!times_to_lose_during_commit_)
       return;
     --times_to_lose_during_commit_;
     LoseContext();
 
-    times_to_create_and_lose_ = times_to_repeat_loss_;
-    times_to_repeat_loss_ = 0;
     times_to_fail_create_ = times_to_fail_recreate_;
     times_to_fail_recreate_ = 0;
+    times_to_fail_initialize_ = times_to_fail_reinitialize_;
+    times_to_fail_reinitialize_ = 0;
+    times_to_lose_on_create_ = times_to_lose_on_recreate_;
+    times_to_lose_on_recreate_ = 0;
   }
 
  protected:
   FakeWebGraphicsContext3D* context3d_;
   int times_to_fail_create_;
-  int times_to_create_and_lose_;
+  int times_to_fail_initialize_;
+  int times_to_lose_on_create_;
   int times_to_lose_during_commit_;
-  int times_to_repeat_loss_;
+  int times_to_lose_during_draw_;
+  int times_to_fail_reinitialize_;
   int times_to_fail_recreate_;
+  int times_to_lose_on_recreate_;
 };
 
 class LayerTreeHostContextTestLostContextSucceeds :
       public LayerTreeHostContextTest {
  public:
   LayerTreeHostContextTestLostContextSucceeds()
       : LayerTreeHostContextTest(),
         test_case_(0),
-        num_losses_(0) {
+        num_losses_(0),
+        recovered_context_(true) {
   }
 
   virtual void beginTest() OVERRIDE {
     postSetNeedsCommitToMainThread();
   }
 
   virtual void didRecreateOutputSurface(bool succeeded) OVERRIDE {
     EXPECT_TRUE(succeeded);
     ++num_losses_;
+    recovered_context_ = true;
   }
 
   virtual void afterTest() OVERRIDE {
-    EXPECT_EQ(3, test_case_);
-    EXPECT_EQ(3, num_losses_);
-  }
-
-  bool SourceFrameHasContextLoss(int source_frame) const {
-    return source_frame % 2 == 1;
+    EXPECT_EQ(8, test_case_);
+    EXPECT_EQ(6 + 10 + 10, num_losses_);
   }
 
   virtual void didCommitAndDrawFrame() OVERRIDE {
     // If the last frame had a context loss, then we'll commit again to
     // recover.
-    if (SourceFrameHasContextLoss(m_layerTreeHost->commitNumber()) - 1)
+    if (!recovered_context_)
+      return;
+    if (times_to_lose_during_commit_)
+      return;
+    if (times_to_lose_during_draw_)
       return;
 
+    recovered_context_ = false;
     if (NextTestCase())
-      m_layerTreeHost->setNeedsCommit();
+      InvalidateAndSetNeedsCommit();
     else
       endTest();
   }
 
+  virtual void InvalidateAndSetNeedsCommit() {
+    m_layerTreeHost->setNeedsCommit();
+  }
+
   bool NextTestCase() {
     static const TestCase kTests[] = {
       // Losing the context and failing to recreate it (or losing it again
       // immediately) a small number of times should succeed.
       { 1, // times_to_lose_during_commit
-        0, // times_to_repeat_loss
+        0, // times_to_lose_during_draw
+        3, // times_to_fail_reinitialize
         0, // times_to_fail_recreate
+        0, // times_to_lose_on_recreate
       },
-      { 1,
-        3, // times_to_repeat_loss
+      { 0, // times_to_lose_during_commit
+        1, // times_to_lose_during_draw
+        3, // times_to_fail_reinitialize
         0, // times_to_fail_recreate
+        0, // times_to_lose_on_recreate
       },
-      { 1,
-        0, // times_to_repeat_loss
+      { 1, // times_to_lose_during_commit
+        0, // times_to_lose_during_draw
+        0, // times_to_fail_reinitialize
         3, // times_to_fail_recreate
+        0, // times_to_lose_on_recreate
+      },
+      { 0, // times_to_lose_during_commit
+        1, // times_to_lose_during_draw
+        0, // times_to_fail_reinitialize
+        3, // times_to_fail_recreate
+        0, // times_to_lose_on_recreate
+      },
+      { 1, // times_to_lose_during_commit
+        0, // times_to_lose_during_draw
+        0, // times_to_fail_reinitialize
+        0, // times_to_fail_recreate
+        3, // times_to_lose_on_recreate
+      },
+      { 0, // times_to_lose_during_commit
+        1, // times_to_lose_during_draw
+        0, // times_to_fail_reinitialize
+        0, // times_to_fail_recreate
+        3, // times_to_lose_on_recreate
+      },
+      // Losing the context and recreating it any number of times should
+      // succeed.
+      { 10, // times_to_lose_during_commit
+        0, // times_to_lose_during_draw
+        0, // times_to_fail_reinitialize
+        0, // times_to_fail_recreate
+        0, // times_to_lose_on_recreate
+      },
+      { 0, // times_to_lose_during_commit
+        10, // times_to_lose_during_draw
+        0, // times_to_fail_reinitialize
+        0, // times_to_fail_recreate
+        0, // times_to_lose_on_recreate
       },
     };
 
     if (test_case_ >= arraysize(kTests))
       return false;
 
     times_to_lose_during_commit_ =
         kTests[test_case_].times_to_lose_during_commit;
-    times_to_repeat_loss_ = kTests[test_case_].times_to_repeat_loss;
+    times_to_lose_during_draw_ =
+        kTests[test_case_].times_to_lose_during_draw;
+    times_to_fail_reinitialize_ = kTests[test_case_].times_to_fail_reinitialize;
     times_to_fail_recreate_ = kTests[test_case_].times_to_fail_recreate;
+    times_to_lose_on_recreate_ = kTests[test_case_].times_to_lose_on_recreate;
     ++test_case_;
     return true;
   }
 
   struct TestCase {
     int times_to_lose_during_commit;
-    int times_to_repeat_loss;
+    int times_to_lose_during_draw;
+    int times_to_fail_reinitialize;
     int times_to_fail_recreate;
+    int times_to_lose_on_recreate;
   };
 
  private:
   size_t test_case_;
   int num_losses_;
+  bool recovered_context_;
 };
 
 SINGLE_AND_MULTI_THREAD_TEST_F(LayerTreeHostContextTestLostContextSucceeds)
 
 class LayerTreeHostContextTestLostContextSucceedsWithContent :
     public LayerTreeHostContextTestLostContextSucceeds {
  public:
 
   LayerTreeHostContextTestLostContextSucceedsWithContent()
       : LayerTreeHostContextTestLostContextSucceeds() {
   }
 
   virtual void setupTree() OVERRIDE {
-    scoped_refptr<Layer> root_ = Layer::create();
+    root_ = Layer::create();
     root_->setBounds(gfx::Size(10, 10));
     root_->setAnchorPoint(gfx::PointF());
     root_->setIsDrawable(true);
 
-    scoped_refptr<FakeContentLayer> content_ =
-        FakeContentLayer::Create(&client_);
+    content_ = FakeContentLayer::Create(&client_);
     content_->setBounds(gfx::Size(10, 10));
     content_->setAnchorPoint(gfx::PointF());
     content_->setIsDrawable(true);
-    if (use_surface_)
+    if (use_surface_) {
+      // TODO(danakj): Give the surface a filter to test more code when we can
+      // do so without crashing in the shared context creation.
       content_->setForceRenderSurface(true);
+    }
+
     root_->addChild(content_);
 
     m_layerTreeHost->setRootLayer(root_);
     LayerTreeHostContextTest::setupTree();
   }
 
+  virtual void InvalidateAndSetNeedsCommit() OVERRIDE {
+    // Invalidate the render surface so we don't try to use a cached copy of the
+    // surface.  We want to make sure to test the drawing paths for drawing to
+    // a child surface.
+    content_->setNeedsDisplay();
+    LayerTreeHostContextTestLostContextSucceeds::InvalidateAndSetNeedsCommit();
+  }
+
   virtual void drawLayersOnThread(LayerTreeHostImpl* host_impl) {
     FakeContentLayerImpl* content_impl = static_cast<FakeContentLayerImpl*>(
         host_impl->rootLayer()->children()[0]);
     // Even though the context was lost, we should have a resource. The
     // FakeWebGraphicsContext3D ensures that this resource is created with
     // the active context.
     EXPECT_TRUE(content_impl->HaveResourceForTileAt(0, 0));
   }
 
  protected:
@@ skipping 62 matching lines @@
     EXPECT_FALSE(host_impl->renderer());
     EXPECT_FALSE(host_impl->resourceProvider());
   }
 
   virtual void afterTest() OVERRIDE {}
 
  private:
   int num_commits_;
 };
 
-TEST_F(LayerTreeHostContextTestLostContextFails, RepeatLoss100_SingleThread) {
-  times_to_repeat_loss_ = 100;
+TEST_F(LayerTreeHostContextTestLostContextFails, FailReinitialize100_SingleThread) {
+  times_to_fail_reinitialize_ = 100;
   times_to_fail_recreate_ = 0;
+  times_to_lose_on_recreate_ = 0;
   runTest(false);
 }
 
-TEST_F(LayerTreeHostContextTestLostContextFails, RepeatLoss100_MultiThread) {
-  times_to_repeat_loss_ = 100;
+TEST_F(LayerTreeHostContextTestLostContextFails, FailReinitialize100_MultiThread) {
+  times_to_fail_reinitialize_ = 100;
   times_to_fail_recreate_ = 0;
+  times_to_lose_on_recreate_ = 0;
   runTest(true);
 }
 
 TEST_F(LayerTreeHostContextTestLostContextFails, FailRecreate100_SingleThread) {
-  times_to_repeat_loss_ = 0;
+  times_to_fail_reinitialize_ = 0;
   times_to_fail_recreate_ = 100;
+  times_to_lose_on_recreate_ = 0;
   runTest(false);
 }
 
 TEST_F(LayerTreeHostContextTestLostContextFails, FailRecreate100_MultiThread) {
-  times_to_repeat_loss_ = 0;
+  times_to_fail_reinitialize_ = 0;
   times_to_fail_recreate_ = 100;
+  times_to_lose_on_recreate_ = 0;
   runTest(true);
 }
 
+TEST_F(LayerTreeHostContextTestLostContextFails, LoseOnRecreate100_SingleThread) {
+  times_to_fail_reinitialize_ = 0;
+  times_to_fail_recreate_ = 0;
+  times_to_lose_on_recreate_ = 100;
+  runTest(false);
+}
+
+TEST_F(LayerTreeHostContextTestLostContextFails, LoseOnRecreate100_MultiThread) {
+  times_to_fail_reinitialize_ = 0;
+  times_to_fail_recreate_ = 0;
+  times_to_lose_on_recreate_ = 100;
+  runTest(true);
+}
+
 class LayerTreeHostContextTestFinishAllRenderingAfterLoss :
       public LayerTreeHostContextTest {
  public:
   virtual void beginTest() OVERRIDE {
     // Lose the context until the compositor gives up on it.
     times_to_lose_during_commit_ = 1;
-    times_to_repeat_loss_ = 10;
+    times_to_fail_reinitialize_ = 10;
     postSetNeedsCommitToMainThread();
   }
 
   virtual void didRecreateOutputSurface(bool succeeded) OVERRIDE {
     EXPECT_FALSE(succeeded);
     m_layerTreeHost->finishAllRendering();
     endTest();
   }
 
   virtual void afterTest() OVERRIDE {}
@@ skipping 197 matching lines @@
         // Lose the context and struggle to recreate it.
         LoseContext();
         times_to_fail_create_ = 1;
         break;
       case 2:
         EXPECT_EQ(1u, root->lost_output_surface_count());
         EXPECT_EQ(1u, child->lost_output_surface_count());
         EXPECT_EQ(1u, grandchild->lost_output_surface_count());
         // Lose the context and again during recreate.
         LoseContext();
-        times_to_create_and_lose_ = 1;
+        times_to_lose_on_create_ = 1;
         break;
       case 3:
         EXPECT_EQ(3u, root->lost_output_surface_count());
         EXPECT_EQ(3u, child->lost_output_surface_count());
         EXPECT_EQ(3u, grandchild->lost_output_surface_count());
+        // Lose the context and again during reinitialization.
+        LoseContext();
+        times_to_fail_initialize_ = 1;
+        break;
+      case 4:
+        EXPECT_EQ(5u, root->lost_output_surface_count());
+        EXPECT_EQ(5u, child->lost_output_surface_count());
+        EXPECT_EQ(5u, grandchild->lost_output_surface_count());
         endTest();
         break;
       default:
         NOTREACHED();
     }
   }
 
   virtual void afterTest() OVERRIDE {}
 
  private:
@@ skipping 296 matching lines @@
   }
 
  private:
   FakeContentLayerClient client_;
 };
 
 MULTI_THREAD_TEST_F(LayerTreeHostContextTestImplSidePainting)
 
 }  // namespace
 }  // namespace cc