PlzNavigate: implement RequestNavigation in the no live renderer case

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 "base/basictypes.h"
 #include "base/logging.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/weak_ptr.h"
 #include "content/browser/renderer_host/render_view_host_delegate.h"
 #include "content/browser/site_instance_impl.h"
 #include "content/common/content_export.h"
 #include "content/public/browser/global_request_id.h"
 #include "content/public/browser/notification_observer.h"
 #include "content/public/browser/notification_registrar.h"
 #include "content/public/common/referrer.h"
 
 struct FrameHostMsg_BeginNavigation_Params;
+struct FrameMsg_Navigate_Params;
 
 namespace content {
 class BrowserContext;
 class CrossProcessFrameConnector;
 class CrossSiteTransferringRequest;
 class InterstitialPageImpl;
 class FrameTreeNode;
 class NavigationControllerImpl;
 class NavigationEntry;
 class NavigationEntryImpl;
 class NavigationRequest;
 class RenderFrameHost;
 class RenderFrameHostDelegate;
 class RenderFrameHostImpl;
 class RenderFrameHostManagerTest;
 class RenderFrameProxyHost;
 class RenderViewHost;
 class RenderViewHostImpl;
 class RenderWidgetHostDelegate;
 class RenderWidgetHostView;
 class TestWebContents;
 class WebUIImpl;
+struct NavigationBeforeCommitInfo;
 
 // Manages RenderFrameHosts for a FrameTreeNode.  This class acts as a state
 // machine to make cross-process navigations in a frame possible.
 class CONTENT_EXPORT RenderFrameHostManager : public NotificationObserver {
  public:
   // Functions implemented by our owner that we need.
   //
   // TODO(brettw) Clean this up! These are all the functions in WebContentsImpl
   // that are required to run this class. The design should probably be better
   // such that these are more clear.
   //
   // There is additional complexity that some of the functions we need in
   // WebContentsImpl are inherited and non-virtual. These are named with
   // "RenderManager" so that the duplicate implementation of them will be clear.
+  //
+  // Functions and parameters whose description are prefixed by PlzNavigate are
+  // part of a navigation refactoring project, currently behind the
+  // enable-browser-side-navigation flag. The idea is to move the logic behind
+  // driving navigations from the renderer to the browser.
   class CONTENT_EXPORT Delegate {
    public:
     // Initializes the given renderer if necessary and creates the view ID
     // corresponding to this view host. If this method is not called and the
     // process is not shared, then the WebContentsImpl will act as though the
     // renderer is not running (i.e., it will render "sad tab"). This method is
     // automatically called from LoadURL. |for_main_frame| indicates whether
     // this RenderViewHost is used to render a top-level frame, so the
     // appropriate RenderWidgetHostView type is used.
     virtual bool CreateRenderViewForRenderManager(
@@ skipping 113 matching lines @@
   // Sets the pending Web UI for the pending navigation, ensuring that the
   // bindings are appropriate for the given NavigationEntry.
   void SetPendingWebUI(const NavigationEntryImpl& entry);
 
   // Called when we want to instruct the renderer to navigate to the given
   // navigation entry. It may create a new RenderFrameHost or re-use an existing
   // one. The RenderFrameHost to navigate will be returned. Returns NULL if one
   // could not be created.
   RenderFrameHostImpl* Navigate(const NavigationEntryImpl& entry);
 
+  // PlzNavigate: sends a RequestNavigation IPC to the renderer to ask it to
+  // navigate. If no live renderer is present, then the navigation request will
+  // be sent directly to the ResourceDispatcherHost.
+  bool RequestNavigation(const NavigationEntryImpl& entry,
+                         const FrameMsg_Navigate_Params& navigate_params);
+
   // Instructs the various live views to stop. Called when the user directed the
   // page to stop loading.
   void Stop();
 
   // Notifies the regular and pending RenderViewHosts that a load is or is not
   // happening. Even though the message is only for one of them, we don't know
   // which one so we tell both.
   void SetIsLoading(bool is_loading);
 
   // Whether to close the tab or not when there is a hang during an unload
@@ skipping 39 matching lines @@
   void SwappedOut(RenderFrameHostImpl* render_frame_host);
 
   // Called when a renderer's frame navigates.
   void DidNavigateFrame(RenderFrameHostImpl* render_frame_host);
 
   // Called when a renderer sets its opener to null.
   void DidDisownOpener(RenderViewHost* render_view_host);
 
   // Helper method to create and initialize a RenderFrameHost.  If |swapped_out|
   // is true, it will be initially placed on the swapped out hosts list.
+  // Else if |is_speculative| is true, then it will used as a speculatively
+  // spawned renderer in the PlzNavigate navigation refactoring project.
   // Otherwise, it will be used for a pending cross-site navigation.
   // Returns the routing id of the *view* associated with the frame.
   int CreateRenderFrame(SiteInstance* instance,
                         int opener_route_id,
                         bool swapped_out,
-                        bool hidden);
+                        bool hidden,
+                        bool is_speculative);
 
   // Sets the passed passed interstitial as the currently showing interstitial.
   // |interstitial_page| should be non NULL (use the remove_interstitial_page
   // method to unset the interstitial) and no interstitial page should be set
   // when there is already a non NULL interstitial page set.
   void set_interstitial_page(InterstitialPageImpl* interstitial_page) {
     DCHECK(!interstitial_page_ && interstitial_page);
     interstitial_page_ = interstitial_page;
   }
 
@@ skipping 30 matching lines @@
   void SwapOutOldPage();
 
   // Deletes a RenderFrameHost that was pending shutdown.
   void ClearPendingShutdownRFHForSiteInstance(int32 site_instance_id,
                                               RenderFrameHostImpl* rfh);
 
   // Deletes any proxy hosts associated with this node. Used during destruction
   // of WebContentsImpl.
   void ResetProxyHosts();
 
-  // Used to start a navigation, part of browser-side navigation project.
+  // PlzNavigate: Used to start a navigation.
   void OnBeginNavigation(const FrameHostMsg_BeginNavigation_Params& params);
 
+  // PlzNavigate: Used to signal the commit of a navigation request.
+  void CommitNavigation(const NavigationBeforeCommitInfo& info);
+
  private:
   friend class RenderFrameHostManagerTest;
   friend class TestWebContents;
 
   // Tracks information about a navigation while a cross-process transition is
   // in progress, in case we need to transfer it to a new RenderFrameHost.
   // When a request is being transferred, deleting the PendingNavigationParams,
   // and thus |cross_site_transferring_request|, will cancel the request being
   // transferred, unless its ReleaseRequest method has been called.
   struct PendingNavigationParams {
@@ skipping 60 matching lines @@
   bool ShouldSwapBrowsingInstancesForNavigation(
       const NavigationEntry* current_entry,
       const NavigationEntryImpl* new_entry) const;
 
   // Returns true if it is safe to reuse the current WebUI when navigating from
   // |current_entry| to |new_entry|.
   bool ShouldReuseWebUI(
       const NavigationEntry* current_entry,
       const NavigationEntryImpl* new_entry) const;
 
-  // Returns an appropriate SiteInstance object for the given NavigationEntry,
-  // possibly reusing the current SiteInstance.  If --process-per-tab is used,
-  // this is only called when ShouldSwapBrowsingInstancesForNavigation returns
-  // true.
+  // Returns the SiteInstance to use for the navigation.
+  SiteInstance* GetSiteInstanceForNavigation(const NavigationEntryImpl& entry);
+
+  // Helper function that returns an appropriate SiteInstance object for the
+  // given NavigationEntry, possibly reusing the current SiteInstance.  If
+  // --process-per-tab is used, this is only called when
+  // ShouldSwapBrowsingInstancesForNavigation returns true. Caller should use
+  // GetSiteInstanceForNavigation.
   SiteInstance* GetSiteInstanceForEntry(
       const NavigationEntryImpl& entry,
       SiteInstance* current_instance,
       bool force_browsing_instance_swap);
 
+  // Creates a new RenderFrameHostImpl for the |new_instance| while respecting
+  // the opener route if needed and stores it in pending_render_frame_host_.
+  // Also returns a pointer to the newly created RFH.
+  // PlzNavigate: If |is_speculative| is true, then the newly created RFH will
+  // be stored in speculative_render_frame_host_.
+  RenderFrameHostImpl* CreateRenderFrameHostForNewSiteInstance(
+      SiteInstance* old_instance,
+      SiteInstance* new_instance,
+      bool is_speculative);
+
   // Creates a RenderFrameHost and corresponding RenderViewHost if necessary.
   scoped_ptr<RenderFrameHostImpl> CreateRenderFrameHost(SiteInstance* instance,
                                                         int view_routing_id,
                                                         int frame_routing_id,
                                                         bool swapped_out,
                                                         bool hidden);
 
   // Sets up the necessary state for a new RenderViewHost with the given opener,
   // if necessary.  It creates a RenderFrameProxy in the target renderer process
   // with the given |proxy_routing_id|, which is used to route IPC messages when
   // in swapped out state.  Returns early if the RenderViewHost has already been
   // initialized for another RenderFrameHost.
   // TODO(creis): opener_route_id is currently for the RenderViewHost but should
   // be for the RenderFrame, since frames can have openers.
   bool InitRenderView(RenderViewHost* render_view_host,
                       int opener_route_id,
                       int proxy_routing_id,
                       bool for_main_frame);
 
+  // Initializes |dest_render_frame_host| and |render_frame_host_| if necessary
+  // before navigating.
+  bool InitRenderFrameHostsBeforeNavigation(
+      RenderFrameHostImpl* dest_render_frame_host);
+
   // Sets the pending RenderFrameHost/WebUI to be the active one. Note that this
   // doesn't require the pending render_frame_host_ pointer to be non-NULL,
   // since there could be Web UI switching as well. Call this for every commit.
   void CommitPending();
 
   // Shutdown all RenderFrameHosts in a SiteInstance. This is called to shutdown
   // frames when all the frames in a SiteInstance are confirmed to be swapped
   // out.
   void ShutdownRenderFrameHostsInSiteInstance(int32 site_instance_id);
 
@@ skipping 40 matching lines @@
   // A RenderFrameHost used to load a cross-site page. This remains hidden
   // while a cross-site request is pending until it calls DidNavigate. It may
   // have an associated Web UI, in which case the Web UI pointer will be non-
   // NULL.
   //
   // The |pending_web_ui_| may be non-NULL even when the
   // |pending_render_frame_host_| is NULL. This will happen when we're
   // transitioning between two Web UI pages: the RFH won't be swapped, so the
   // pending pointer will be unused, but there will be a pending Web UI
   // associated with the navigation.
+  //
+  // PlzNavigate: The pending_render_frame_host_ mechanism will not exist
+  // anymore. Instead the speculative_render_frame_host_ may be used.
   scoped_ptr<RenderFrameHostImpl> pending_render_frame_host_;
 
   // Tracks information about any current pending cross-process navigation.
   scoped_ptr<PendingNavigationParams> pending_nav_params_;
 
   // Tracks information about any navigation paused after receiving response
   // headers.
   scoped_ptr<GlobalRequestID> response_started_id_;
 
+  // PlzNavigate: A RenderFrameHost speculatively created when receiving a
+  // navigation request. It should be used or deleted when the current
+  // navigation request commits.
+  scoped_ptr<RenderFrameHostImpl> speculative_render_frame_host_;

[Charlie Reis, 2014/08/05 23:59:52]

I'm having trouble distinguishing this from pending_render_frame_host_.  We
should emphasize that it's purely an optimization and doesn't need to exist.

Actually, I do wonder if it would be better to add it in a later CL.  That would
make the important parts of this CL easier to follow and make it clear to others
that the later CL is just about optimization and not something necessary for
functionality.

+
   // If either of these is non-NULL, the pending navigation is to a chrome:
   // page. The scoped_ptr is used if pending_web_ui_ != web_ui_, the WeakPtr is
   // used for when they reference the same object. If either is non-NULL, the
   // other should be NULL.
   scoped_ptr<WebUIImpl> pending_web_ui_;
   base::WeakPtr<WebUIImpl> pending_and_current_web_ui_;
 
   // A map of site instance ID to RenderFrameProxyHosts.
   typedef base::hash_map<int32, RenderFrameProxyHost*> RenderFrameProxyHostMap;
   RenderFrameProxyHostMap proxy_hosts_;
 
   // A map of RenderFrameHosts pending shutdown.
   typedef base::hash_map<int32, linked_ptr<RenderFrameHostImpl> >
       RFHPendingDeleteMap;
   RFHPendingDeleteMap pending_delete_hosts_;
 
   // The intersitial page currently shown if any, not own by this class
   // (the InterstitialPage is self-owned, it deletes itself when hidden).
   InterstitialPageImpl* interstitial_page_;
 
   NotificationRegistrar registrar_;
 
-  // Owns a navigation request that originated in that frame until it commits.
+  // PlzNavigate: Owns a navigation request that originated in that frame until
+  // it commits.
   scoped_ptr<NavigationRequest> navigation_request_;
 
   base::WeakPtrFactory<RenderFrameHostManager> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(RenderFrameHostManager);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_FRAME_HOST_RENDER_FRAME_HOST_MANAGER_H_