PlzNavigate: Avoid duplicate SiteInstance creation during navigation.

content/browser/frame_host/render_frame_host_manager.h

 // Copyright 2013 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 CONTENT_BROWSER_FRAME_HOST_RENDER_FRAME_HOST_MANAGER_H_
 #define CONTENT_BROWSER_FRAME_HOST_RENDER_FRAME_HOST_MANAGER_H_
 
 #include <list>
 
 #include "base/basictypes.h"
@@ skipping 405 matching lines @@
                                    SiteInstance* instance);
 
  private:
   friend class NavigatorTestWithBrowserSideNavigation;
   friend class RenderFrameHostManagerTest;
   friend class TestWebContents;
 
   FRIEND_TEST_ALL_PREFIXES(CrossProcessFrameTreeBrowserTest,
                            CreateCrossProcessSubframeProxies);
 
+  // PlzNavigate
+  enum RenderFrameHostToUse {
+    INVALID,
+    REUSE_CURRENT,
+    NEW_SPECULATIVE,
+    REUSE_SPECULATIVE,
+  };
+
+  // Stores information regarding a SiteInstance targeted at a specific URL. It
+  // can point to an existing one or store the details needed to create a new
+  // one.

[Charlie Reis, 2015/03/31 06:18:19]

Sounds good.  Can you also mention that the purpose of the struct is to allow
checks and comparisons without necessarily creating a new SiteInstance?

[carlosk, 2015/03/31 16:38:19]

Done.

+  struct SiteInstanceDescriptor {
+    explicit SiteInstanceDescriptor(content::SiteInstance* site_instance)
+        : existing_site_instance(site_instance),
+          new_is_related_to_current(false) {}
+
+    SiteInstanceDescriptor(GURL site_url,
+                           bool related_to_current,
+                           BrowserContext* browser_context);
+
+    // Set with an existing SiteInstance to be reused.
+    content::SiteInstance* existing_site_instance;
+    // In case |existing_site_instance| is null, specify a new site URL.

[Charlie Reis, 2015/03/31 06:18:19]

nit: Blank lines between these members.

[carlosk, 2015/03/31 16:38:19]

Done.

+    GURL new_site_url;
+    // In case |existing_site_instance| is null, specify if the new site should
+    // be created in new BrowsingInstance or not.
+    bool new_is_related_to_current;
+  };
+
   // Used with FrameTree::ForEach to erase RenderFrameProxyHosts from a
   // FrameTreeNode's RenderFrameHostManager.
   static bool ClearProxiesInSiteInstance(int32 site_instance_id,
                                          FrameTreeNode* node);
   // Used with FrameTree::ForEach to reset initialized state of
   // RenderFrameProxyHosts from a FrameTreeNode's RenderFrameHostManager.
   static bool ResetProxiesInSiteInstance(int32 site_instance_id,
                                          FrameTreeNode* node);
 
   // Returns whether this tab should transition to a new renderer for
@@ skipping 28 matching lines @@
   // Returns true if it is safe to reuse the current WebUI when navigating from
   // |current_entry| to |new_url|.
   bool ShouldReuseWebUI(
       const NavigationEntry* current_entry,
       const GURL& new_url) const;
 
   // Returns the SiteInstance to use for the navigation.
   SiteInstance* GetSiteInstanceForNavigation(const GURL& dest_url,
                                              SiteInstance* source_instance,
                                              SiteInstance* dest_instance,
+                                             SiteInstance* candidate_instance,
                                              ui::PageTransition transition,
                                              bool dest_is_restore,
                                              bool dest_is_view_source_mode);
 
-  // Returns an appropriate SiteInstance object for the given |dest_url|,
-  // possibly reusing the current SiteInstance.  If --process-per-tab is used,
-  // this is only called when ShouldSwapBrowsingInstancesForNavigation returns
-  // true. |source_instance| is the SiteInstance of the frame that initiated the
-  // navigation. |current_instance| is the SiteInstance of the frame that is
-  // currently navigating. |dest_instance|, is a predetermined SiteInstance
-  // that'll be used if not null.
+  // Returns a descriptor of the appropriate SiteInstance object for the given
+  // |dest_url|, possibly reusing the current, source or destination
+  // SiteInstance.

[Charlie Reis, 2015/03/31 06:18:19]

Also mention that the SiteInstance can be obtained from the descriptor using
ConvertToSiteInstance.

[carlosk, 2015/03/31 16:38:20]

Done.

+  //
+  // |source_instance| is the SiteInstance of the frame that initiated the
+  // navigation. |dest_instance| is a predetermined SiteInstance that will be

[Charlie Reis, 2015/03/31 06:18:19]

Please do not reorder these sentences, so that they continue to match the order
of the source/current/dest parameters.

[carlosk, 2015/03/31 16:38:20]

Reordered them as the original file. 

It made sense before as I had changed the signature to not passing the current
one. Hence the "Internally" that is now removed.

+  // used if not null. Internally, |current_instance| is the SiteInstance of the
+  // frame that is currently navigating.
   // For example, if you have a parent frame A, which has a child frame B, and
   // A is trying to change the src attribute of B, this will cause a navigation
   // where the source SiteInstance is A and B is the current SiteInstance.
+  //
   // This is a helper function for GetSiteInstanceForNavigation.
-  SiteInstance* GetSiteInstanceForURL(const GURL& dest_url,
-                                      SiteInstance* source_instance,
-                                      SiteInstance* current_instance,
-                                      SiteInstance* dest_instance,
-                                      ui::PageTransition transition,
-                                      bool dest_is_restore,
-                                      bool dest_is_view_source_mode,
-                                      bool force_browsing_instance_swap);
+  SiteInstanceDescriptor DetermineSiteInstanceForURL(
+      const GURL& dest_url,
+      SiteInstance* source_instance,
+      SiteInstance* current_instance,
+      SiteInstance* dest_instance,
+      ui::PageTransition transition,
+      bool dest_is_restore,
+      bool dest_is_view_source_mode,
+      bool force_browsing_instance_swap);
+
+  // Converts a SiteInstanceDescriptor to the actual SiteInstance it describes.
+  // If a |candidate_instance| is provided (is not nullptr) and it matches the
+  // description, it is returned verbatim.

[Charlie Reis, 2015/03/31 06:18:19]

s/verbatim/as is/

[carlosk, 2015/03/31 16:38:19]

Done.

+  SiteInstance* ConvertToSiteInstance(const SiteInstanceDescriptor& descriptor,
+                                      SiteInstance* candidate_instance);
 
   // Determines the appropriate url to use as the current url for SiteInstance
   // selection.
   const GURL& GetCurrentURLForSiteInstance(
       SiteInstance* current_instance,
       NavigationEntry* current_entry);
 
   // Creates a new RenderFrameHostImpl for the |new_instance| and assign it to
   // |pending_render_frame_host_| while respecting the opener route if needed
   // and stores it in pending_render_frame_host_.
@@ skipping 196 matching lines @@
   bool should_reuse_web_ui_;
 
   base::WeakPtrFactory<RenderFrameHostManager> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(RenderFrameHostManager);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_FRAME_HOST_RENDER_FRAME_HOST_MANAGER_H_