Moving temporary reference logic to SurfaceManager

cc/surfaces/surface_manager_ref_unittest.cc

 // Copyright 2016 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 <stddef.h>
 
 #include <unordered_map>
 #include <vector>
 
 #include "base/memory/ptr_util.h"
 #include "cc/surfaces/surface.h"
 #include "cc/surfaces/surface_factory.h"
 #include "cc/surfaces/surface_factory_client.h"
 #include "cc/surfaces/surface_id.h"
 #include "cc/surfaces/surface_manager.h"
 #include "cc/surfaces/surface_sequence_generator.h"
+#include "testing/gmock/include/gmock/gmock.h"
 #include "testing/gtest/include/gtest/gtest.h"
+
+using testing::ElementsAre;
+using testing::UnorderedElementsAre;
+
 namespace cc {
+
 namespace {
 
 constexpr FrameSinkId kFrameSink1(1, 0);
 constexpr FrameSinkId kFrameSink2(2, 0);
 constexpr FrameSinkId kFrameSink3(3, 0);
 const LocalFrameId kLocalFrame1(1, base::UnguessableToken::Create());
 const LocalFrameId kLocalFrame2(2, base::UnguessableToken::Create());
 
 class StubSurfaceFactoryClient : public SurfaceFactoryClient {
  public:
   void ReturnResources(const ReturnedResourceArray& resources) override {}
   void SetBeginFrameSource(BeginFrameSource* begin_frame_source) override {}
 };
 
+}  // namespace
+
 // Tests for reference tracking in SurfaceManager.
 class SurfaceManagerRefTest : public testing::Test {
  public:
   SurfaceManager& manager() { return *manager_; }
 
   // Creates a new Surface with the provided SurfaceId. Will first create the
   // SurfaceFactory for |frame_sink_id| if necessary.
   SurfaceId CreateSurface(const FrameSinkId& frame_sink_id,
                           const LocalFrameId& local_frame_id) {
     GetFactory(frame_sink_id)
         .SubmitCompositorFrame(local_frame_id, CompositorFrame(),
                                SurfaceFactory::DrawCallback());
     return SurfaceId(frame_sink_id, local_frame_id);
   }
 
+  SurfaceId CreateSurface(uint32_t client_id,
+                          uint32_t sink_id,
+                          uint32_t local_id) {
+    return CreateSurface(
+        FrameSinkId(client_id, sink_id),
+        LocalFrameId(local_id, base::UnguessableToken::Deserialize(0, 1u)));
+  }
+
   // Destroy Surface with |surface_id|.
   void DestroySurface(const SurfaceId& surface_id) {
     GetFactory(surface_id.frame_sink_id()).EvictSurface();
   }
 
  protected:
   SurfaceFactory& GetFactory(const FrameSinkId& frame_sink_id) {
     auto& factory_ptr = factories_[frame_sink_id];
     if (!factory_ptr)
       factory_ptr = base::MakeUnique<SurfaceFactory>(frame_sink_id,
                                                      manager_.get(), &client_);
     return *factory_ptr;
   }
 
   // testing::Test:
   void SetUp() override {
     // Start each test with a fresh SurfaceManager instance.
-    manager_ = base::MakeUnique<SurfaceManager>();
+    manager_ = base::MakeUnique<SurfaceManager>(
+        SurfaceManager::LifetimeType::REFERENCES);
   }
   void TearDown() override {
     for (auto& factory : factories_)
       factory.second->EvictSurface();
     factories_.clear();
     manager_.reset();
   }
 
+  // Returns all the references from the given surface id.
+  SurfaceManager::SurfaceIdSet GetReferencesFor(const SurfaceId& surface_id) {
+    return manager().parent_to_child_refs_[surface_id];
+  }
+
+  SurfaceManager::SurfaceIdSet GetRootReferences() {
+    return GetReferencesFor(manager().GetRootSurfaceId());
+  }
+
+  // Returns all the temporary references for the given frame sink id.
+  std::vector<LocalFrameId> GetTempReferencesFor(

[danakj, 2017/01/17 21:56:42]

nit: I would maybe name these methods Get*ReferencesFrom() instead of __For() as
they are finding references from the input parent to the children (in my mind..
maybe u disagree)

[Saman Sami, 2017/01/18 18:03:36]

For temp references, the name is correct, but GetReferencesFor should be
renamed.

+      const FrameSinkId& frame_sink_id) {
+    return manager().temp_references_[frame_sink_id];
+  }
+
+  // Temporary references are stored as a map in SurfaceManager. This method
+  // converts the map to a vector.
+  std::vector<SurfaceId> GetAllTempReferences() {
+    std::vector<SurfaceId> temp_references;
+    for (auto& map_entry : manager().temp_references_)

[danakj, 2017/01/17 21:56:42]

this for loop has a body larger than a single line so needs {}

[Saman Sami, 2017/01/18 18:03:36]

Done.

+      for (auto local_frame_id : map_entry.second)
+        temp_references.push_back(SurfaceId(map_entry.first, local_frame_id));
+    return temp_references;
+  }
+
   std::unordered_map<FrameSinkId,
                      std::unique_ptr<SurfaceFactory>,
                      FrameSinkIdHash>
       factories_;
   std::unique_ptr<SurfaceManager> manager_;
   StubSurfaceFactoryClient client_;
 };
 
-}  // namespace
-
 TEST_F(SurfaceManagerRefTest, AddReference) {
   SurfaceId id1 = CreateSurface(kFrameSink1, kLocalFrame1);
   manager().AddSurfaceReference(manager().GetRootSurfaceId(), id1);
 
   EXPECT_EQ(manager().GetSurfaceReferenceCount(id1), 1u);
   EXPECT_EQ(manager().GetReferencedSurfaceCount(id1), 0u);
 }
 
 TEST_F(SurfaceManagerRefTest, AddRemoveReference) {
   SurfaceId id1 = CreateSurface(kFrameSink1, kLocalFrame1);
@@ skipping 120 matching lines @@
 
   manager().RemoveSurfaceReference(manager().GetRootSurfaceId(), id1);
 
   // Removing the reference from the root to id1 should allow all three surfaces
   // to be deleted during GC.
   EXPECT_EQ(manager().GetSurfaceForId(id1), nullptr);
   EXPECT_EQ(manager().GetSurfaceForId(id2), nullptr);
   EXPECT_EQ(manager().GetSurfaceForId(id3), nullptr);
 }
 
-TEST_F(SurfaceManagerRefTest, CheckGCWithSequences) {
-  SurfaceId id1 = CreateSurface(kFrameSink1, kLocalFrame1);
-  SurfaceId id2 = CreateSurface(kFrameSink2, kLocalFrame1);
-
-  manager().AddSurfaceReference(manager().GetRootSurfaceId(), id1);
-  manager().AddSurfaceReference(id1, id2);
-
-  SurfaceId id3 = CreateSurface(kFrameSink3, kLocalFrame1);
-  Surface* surface3 = manager().GetSurfaceForId(id3);
-
-  // Add destruction dependency from |id2| to |id3|.
-  manager().RegisterFrameSinkId(kFrameSink2);
-  SurfaceSequence sequence(kFrameSink2, 1u);
-  surface3->AddDestructionDependency(sequence);
-  EXPECT_EQ(surface3->GetDestructionDependencyCount(), 1u);
-
-  // Surface for |id3| isn't delete yet because it has a valid destruction
-  // dependency from |kFrameSink2|.
-  DestroySurface(id3);
-  EXPECT_NE(manager().GetSurfaceForId(id3), nullptr);
-
-  // Surface for |id2| isn't deleted because it has a reference.
-  DestroySurface(id2);
-  EXPECT_NE(manager().GetSurfaceForId(id2), nullptr);
-
-  // Satisfy destruction dependency on |id3| and delete during GC.
-  manager().SatisfySequence(sequence);
-  EXPECT_EQ(manager().GetSurfaceForId(id3), nullptr);
-
-  // Remove ref on |id2| and delete during GC.
-  manager().RemoveSurfaceReference(id1, id2);
-  EXPECT_EQ(manager().GetSurfaceForId(id2), nullptr);
-}
-
 TEST_F(SurfaceManagerRefTest, TryAddReferenceToBadSurface) {
   // Not creating an accompanying Surface and SurfaceFactory.
   SurfaceId id(FrameSinkId(100u, 200u),
                LocalFrameId(1u, base::UnguessableToken::Create()));
 
   // Adding reference from root to the Surface should do nothing because
   // SurfaceManager doesn't know Surface for |id| exists.
   manager().AddSurfaceReference(manager().GetRootSurfaceId(), id);
   EXPECT_EQ(manager().GetSurfaceReferenceCount(id), 0u);
 }
 
 TEST_F(SurfaceManagerRefTest, TryDoubleAddReference) {
   SurfaceId id1 = CreateSurface(kFrameSink1, kLocalFrame1);
   SurfaceId id2 = CreateSurface(kFrameSink2, kLocalFrame1);
 
   manager().AddSurfaceReference(manager().GetRootSurfaceId(), id1);
   manager().AddSurfaceReference(id1, id2);
   EXPECT_EQ(manager().GetSurfaceReferenceCount(id2), 1u);
   EXPECT_EQ(manager().GetReferencedSurfaceCount(id1), 1u);
 
   // The second request should be ignored without crashing.
   manager().AddSurfaceReference(id1, id2);
   EXPECT_EQ(manager().GetSurfaceReferenceCount(id2), 1u);
   EXPECT_EQ(manager().GetReferencedSurfaceCount(id1), 1u);
 }
 
 TEST_F(SurfaceManagerRefTest, TryAddSelfReference) {
   SurfaceId id1 = CreateSurface(kFrameSink1, kLocalFrame1);
 
+  // A temporary reference must exist to id1.
+  EXPECT_EQ(manager().GetSurfaceReferenceCount(id1), 1u);
+
+  // Add a self reference.

[kylechar, 2017/01/18 15:36:44]

// Try to add a self reference, this should fail.

[danakj, 2017/01/18 16:31:32]

Ah ok ya this would help :)

[Saman Sami, 2017/01/18 18:03:36]

Done.

+  manager().AddSurfaceReference(id1, id1);
+
   // Adding a self reference should be ignored without crashing.
-  manager().AddSurfaceReference(id1, id1);
-  EXPECT_EQ(manager().GetSurfaceReferenceCount(id1), 0u);
   EXPECT_EQ(manager().GetReferencedSurfaceCount(id1), 0u);
+
+  // The temporary reference to id1 must still exist.
+  EXPECT_EQ(manager().GetSurfaceReferenceCount(id1), 1u);

[danakj, 2017/01/17 21:56:42]

I'm struggling with why a temp reference would exist after calling
AddSurfaceReference. Can you explain? I feel like it would "replace" the temp
reference with the real reference, and would drop the reference from
temp_references_, but may be I am misreading?

[kylechar, 2017/01/18 15:36:44]

Adding a reference to itself fails is why.

 }
 
 TEST_F(SurfaceManagerRefTest, TryRemoveBadReference) {
   SurfaceId id1 = CreateSurface(kFrameSink1, kLocalFrame1);
   SurfaceId id2 = CreateSurface(kFrameSink2, kLocalFrame1);
 
   // Removing non-existent reference should be ignored.
   manager().AddSurfaceReference(id1, id2);
   manager().RemoveSurfaceReference(id2, id1);
   EXPECT_EQ(manager().GetReferencedSurfaceCount(id1), 1u);
   EXPECT_EQ(manager().GetSurfaceReferenceCount(id2), 1u);
 }
 
+// Temporary Reference Tests

[danakj, 2017/01/17 21:56:42]

this comment is going to be wrong in no time, i would remove it. if u want to
document it, have it in the test names

[Saman Sami, 2017/01/18 18:03:36]

Done.

+
+TEST_F(SurfaceManagerRefTest, AddSurfaceThenReference) {
+  // Create a new surface.
+  const SurfaceId surface_id = CreateSurface(2, 1, 1);
+
+  // A temporary reference must be added to surface_id.
+  EXPECT_THAT(GetAllTempReferences(), ElementsAre(surface_id));

[danakj, 2017/01/17 21:56:42]

Oh this is some fancy gtesting, cool

+  EXPECT_THAT(GetRootReferences(), ElementsAre(surface_id));
+
+  // Create parent_id and add a real reference from it to surface_id.
+  const SurfaceId parent_id = CreateSurface(1, 1, 1);
+  manager().AddSurfaceReference(parent_id, surface_id);
+
+  // The temporary reference to surface_id should be gone.
+  // The only temporary reference should be to parent_id.
+  // There must be a real reference from parent_id to child_id.
+  EXPECT_THAT(GetAllTempReferences(), ElementsAre(parent_id));
+  EXPECT_THAT(GetRootReferences(), ElementsAre(parent_id));
+  EXPECT_THAT(GetReferencesFor(parent_id), ElementsAre(surface_id));
+}
+
+TEST_F(SurfaceManagerRefTest, AddSurfaceThenRootReference) {
+  // Create a new surface.
+  const SurfaceId surface_id = CreateSurface(1, 1, 1);
+
+  // Temporary reference should be added to surface_id.
+  EXPECT_THAT(GetAllTempReferences(), ElementsAre(surface_id));
+  EXPECT_THAT(GetRootReferences(), ElementsAre(surface_id));
+
+  // Add a real reference from root to surface_id.
+  manager().AddSurfaceReference(manager().GetRootSurfaceId(), surface_id);
+
+  // The temporary reference should be gone.
+  // There should now be a real reference from root to surface_id.
+  EXPECT_TRUE(GetAllTempReferences().empty());
+  EXPECT_THAT(GetRootReferences(), ElementsAre(surface_id));
+}
+
+TEST_F(SurfaceManagerRefTest, AddTwoSurfacesThenOneReference) {
+  // Create two surfaces with different FrameSinkIds.
+  const SurfaceId surface_id1 = CreateSurface(2, 1, 1);
+  const SurfaceId surface_id2 = CreateSurface(3, 1, 1);
+
+  // Temporary reference should be added for both surfaces.
+  EXPECT_THAT(GetAllTempReferences(),
+              UnorderedElementsAre(surface_id1, surface_id2));
+  EXPECT_THAT(GetRootReferences(),
+              UnorderedElementsAre(surface_id1, surface_id2));
+
+  // Create parent_id and add a real reference from it to surface_id1.
+  const SurfaceId parent_id = CreateSurface(1, 1, 1);
+  manager().AddSurfaceReference(parent_id, surface_id1);
+
+  // Real reference must be added to surface_id1 and the temporary reference
+  // to it must be gone.
+  // There should still be a temporary reference left to surface_id2.
+  // A temporary reference to parent_id must be created.
+  EXPECT_THAT(GetAllTempReferences(),
+              UnorderedElementsAre(parent_id, surface_id2));
+  EXPECT_THAT(GetRootReferences(),
+              UnorderedElementsAre(parent_id, surface_id2));
+  EXPECT_THAT(GetReferencesFor(parent_id), ElementsAre(surface_id1));
+}
+
+TEST_F(SurfaceManagerRefTest, AddSurfacesSkipReference) {
+  // Add two surfaces that have the same FrameSinkId. This would happen when a
+  // client submits two CFs before parent submits a new CF.

[danakj, 2017/01/17 21:56:42]

s/CFs/CompositorFrames/. CFs will never be found if we rename and isn't clear to
the reader necessarily.

[Saman Sami, 2017/01/18 18:03:36]

Done.

+  const SurfaceId surface_id1 = CreateSurface(2, 1, 1);
+  const SurfaceId surface_id2 = CreateSurface(2, 1, 2);

[danakj, 2017/01/17 21:56:42]

maybe don't make them sorted by the local id (ie give the 2nd one a lower id, or
test both, perhaps with 3 ids or a 2nd step), cuz the SurfaceManager doesnt
(shouldnt) depend on that right?

[Saman Sami, 2017/01/18 18:03:36]

Done.

+
+  // Temporary references should be added for both surfaces and they should be
+  // stored in the order of creation.
+  EXPECT_THAT(
+      GetTempReferencesFor(surface_id1.frame_sink_id()),
+      ElementsAre(surface_id1.local_frame_id(), surface_id2.local_frame_id()));
+  EXPECT_THAT(GetRootReferences(),
+              UnorderedElementsAre(surface_id1, surface_id2));
+
+  // Create parent_id and add a reference from it to surface_id2 which was

[danakj, 2017/01/17 21:56:42]

use bars for variable names, like |parent_id| and |surface_id2|

[Saman Sami, 2017/01/18 18:03:36]

Done.

+  // created later.
+  const SurfaceId parent_id = CreateSurface(1, 1, 1);
+  manager().AddSurfaceReference(parent_id, surface_id2);
+
+  // The real reference should be added for surface_id2 and the temporary
+  // references to both surface_id1 and surface_id2 should be gone.
+  // There should be a temporary reference to parent_id.
+  EXPECT_THAT(GetAllTempReferences(), ElementsAre(parent_id));
+  EXPECT_THAT(GetRootReferences(), ElementsAre(parent_id));
+  EXPECT_THAT(GetReferencesFor(parent_id), ElementsAre(surface_id2));
+}
+
+TEST_F(SurfaceManagerRefTest, RemoveFirstTempRefOnly) {
+  // Add two surfaces that have the same FrameSinkId. This would happen when a
+  // client submits two CFs before parent submits a new CF.

[danakj, 2017/01/17 21:56:42]

CFs->CompositorFrames

[Saman Sami, 2017/01/18 18:03:36]

Done.

+  const SurfaceId surface_id1 = CreateSurface(2, 1, 1);
+  const SurfaceId surface_id2 = CreateSurface(2, 1, 2);
+
+  // Temporary references should be added for both surfaces and they should be
+  // stored in the order of creation.
+  EXPECT_THAT(
+      GetTempReferencesFor(surface_id1.frame_sink_id()),
+      ElementsAre(surface_id1.local_frame_id(), surface_id2.local_frame_id()));
+  EXPECT_THAT(GetRootReferences(),
+              UnorderedElementsAre(surface_id1, surface_id2));
+
+  // Create parent_id and add a reference from it to surface_id1 which was
+  // created earlier.
+  const SurfaceId parent_id = CreateSurface(1, 1, 1);
+  manager().AddSurfaceReference(parent_id, surface_id1);
+
+  // The real reference should be added for surface_id1 and its temporary
+  // reference should be removed. The temporary reference for surface_id2
+  // should remain. A temporary reference must be added for parent_id.
+  EXPECT_THAT(GetAllTempReferences(),
+              UnorderedElementsAre(parent_id, surface_id2));
+  EXPECT_THAT(GetRootReferences(),
+              UnorderedElementsAre(parent_id, surface_id2));
+  EXPECT_THAT(GetReferencesFor(parent_id), ElementsAre(surface_id1));
+}
+
 }  // namespace cc