cc: Move ownership of surfaces to SurfaceManager

cc/surfaces/surface_manager.h

 // 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.
 
 #ifndef CC_SURFACES_SURFACE_MANAGER_H_
 #define CC_SURFACES_SURFACE_MANAGER_H_
 
 #include <stdint.h>
 
-#include <list>
 #include <memory>
 #include <unordered_map>
 #include <unordered_set>
 #include <vector>
 
+#include "base/containers/flat_map.h"
 #include "base/containers/flat_set.h"
 #include "base/logging.h"
 #include "base/macros.h"
 #include "base/memory/weak_ptr.h"
 #include "base/observer_list.h"
 #include "base/threading/thread_checker.h"
 #include "cc/surfaces/frame_sink_id.h"
 #include "cc/surfaces/frame_sink_manager.h"
 #include "cc/surfaces/surface_dependency_tracker.h"
 #include "cc/surfaces/surface_id.h"
@@ skipping 34 matching lines @@
 #if DCHECK_IS_ON()
   // Returns a string representation of all reachable surface references.
   std::string SurfaceReferencesToString();
 #endif
 
   void SetDependencyTracker(SurfaceDependencyTracker* dependency_tracker);
   SurfaceDependencyTracker* dependency_tracker() { return dependency_tracker_; }
 
   void RequestSurfaceResolution(Surface* pending_surface);
 
-  std::unique_ptr<Surface> CreateSurface(
+  // Creates a Surface for the given CompositorFrameSinkSupport. The surface
+  // will be destroyed when DestroySurface is called, all of its destruction
+  // dependencies are satisfied, and it is not reachable from the root surface.
+  Surface* CreateSurface(
       base::WeakPtr<CompositorFrameSinkSupport> compositor_frame_sink_support,
       const SurfaceInfo& surface_info);
 
   // Destroy the Surface once a set of sequence numbers has been satisfied.
-  void DestroySurface(std::unique_ptr<Surface> surface);
+  void DestroySurface(const SurfaceId& surface_id);
 
   // Called when a surface has been added to the aggregated CompositorFrame
   // and will notify observers with SurfaceObserver::OnSurfaceWillDraw.
   void SurfaceWillDraw(const SurfaceId& surface_id);
 
   Surface* GetSurfaceForId(const SurfaceId& surface_id);
 
   void AddObserver(SurfaceObserver* obs) { observer_list_.AddObserver(obs); }
 
   void RemoveObserver(SurfaceObserver* obs) {
@@ skipping 118 matching lines @@
       const SurfaceId& surface_id) const;
 
   scoped_refptr<SurfaceReferenceFactory> reference_factory() {
     return reference_factory_;
   }
 
   bool using_surface_references() const {
     return lifetime_type_ == LifetimeType::REFERENCES;
   }
 
+  // Returns true if |surface_id| is in the garbage collector's queue.
+  bool IsMarkedForDestruction(const SurfaceId& surface_id);

[danakj, 2017/06/21 21:24:09]

Do we want this to be part of the public API for production?

[Saman Sami, 2017/06/26 20:44:05]

I made it private.

+
  private:
   friend class test::SurfaceSynchronizationTest;
   friend class SurfaceManagerRefTest;
 
   using SurfaceIdSet = std::unordered_set<SurfaceId, SurfaceIdHash>;
 
   struct SurfaceReferenceInfo {
     SurfaceReferenceInfo();
     ~SurfaceReferenceInfo();
 
@@ skipping 30 matching lines @@
 
   // Adds a temporary reference to |surface_id|. The reference will not have an
   // owner initially.
   void AddTemporaryReference(const SurfaceId& surface_id);
 
   // Removes temporary reference to |surface_id|. If |remove_range| is true then
   // all temporary references to surfaces with the same FrameSinkId as
   // |surface_id| that were added before |surface_id| will also be removed.
   void RemoveTemporaryReference(const SurfaceId& surface_id, bool remove_range);
 
-  // Called when a surface is destroyed and it needs to be removed from the
-  // surface map.
-  void UnregisterSurface(const SurfaceId& surface_id);
+  // Removes the surface from the surface map and destroys it.
+  void DestroySurfaceInternal(const SurfaceId& surface_id);
 
 #if DCHECK_IS_ON()
   // Recursively prints surface references starting at |surface_id| to |str|.
   void SurfaceReferencesToStringImpl(const SurfaceId& surface_id,
                                      std::string indent,
                                      std::stringstream* str);
 #endif
 
   // Use reference or sequence based lifetime management.
   LifetimeType lifetime_type_;
 
   FrameSinkManager framesink_manager_;
 
-  using SurfaceMap = std::unordered_map<SurfaceId, Surface*, SurfaceIdHash>;
+  using SurfaceMap = base::flat_map<SurfaceId, std::unique_ptr<Surface>>;
   SurfaceMap surface_map_;
   base::ObserverList<SurfaceObserver> observer_list_;
   base::ThreadChecker thread_checker_;
 
-  // List of surfaces to be destroyed, along with what sequences they're still
-  // waiting on.
-  using SurfaceDestroyList = std::list<std::unique_ptr<Surface>>;
-  SurfaceDestroyList surfaces_to_destroy_;
+  base::flat_set<SurfaceId> surfaces_to_destroy_;
 
   // Set of SurfaceSequences that have been satisfied by a frame but not yet
   // waited on.
   std::unordered_set<SurfaceSequence, SurfaceSequenceHash> satisfied_sequences_;
 
   // Root SurfaceId that references display root surfaces. There is no Surface
   // with this id, it's for bookkeeping purposes only.
   const SurfaceId root_surface_id_;
 
   // Always empty set that is returned when there is no entry in |references_|
@@ skipping 31 matching lines @@
   SurfaceDependencyTracker* dependency_tracker_ = nullptr;
 
   base::WeakPtrFactory<SurfaceManager> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(SurfaceManager);
 };
 
 }  // namespace cc
 
 #endif  // CC_SURFACES_SURFACE_MANAGER_H_