blob: d4c56dc2030cf89820ec96845c2bc05991b4ef57 [file] [log] [blame]
Avi Drissman4e1b7bc32022-09-15 14:03:501// Copyright 2013 The Chromium Authors
danakjc492bf82020-09-09 20:02:442// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#ifndef CONTENT_BROWSER_RENDERER_HOST_FRAME_TREE_H_
6#define CONTENT_BROWSER_RENDERER_HOST_FRAME_TREE_H_
7
8#include <stdint.h>
9
10#include <iterator>
11#include <memory>
12#include <string>
13#include <unordered_map>
14
15#include "base/callback.h"
16#include "base/containers/queue.h"
Carlos Caballero101ac26b2021-03-24 11:54:0517#include "base/dcheck_is_on.h"
danakjc492bf82020-09-09 20:02:4418#include "base/gtest_prod_util.h"
Keishi Hattori0e45c022021-11-27 09:25:5219#include "base/memory/raw_ptr.h"
Dave Tapuskad8b0530f2021-10-19 15:12:3120#include "base/memory/safe_ref.h"
21#include "base/memory/weak_ptr.h"
danakjc492bf82020-09-09 20:02:4422#include "content/browser/renderer_host/navigator.h"
23#include "content/browser/renderer_host/navigator_delegate.h"
24#include "content/browser/renderer_host/render_frame_host_manager.h"
25#include "content/common/content_export.h"
26#include "mojo/public/cpp/bindings/pending_receiver.h"
27#include "services/service_manager/public/mojom/interface_provider.mojom.h"
David Bokanc3fb5fa2022-07-04 14:55:3128#include "third_party/blink/public/common/features.h"
Kevin McNee43fe8292021-10-04 22:59:4129#include "third_party/blink/public/common/frame/frame_owner_element_type.h"
Chris Hamilton3ff6ed0e2021-02-19 03:54:0430#include "third_party/blink/public/common/tokens/tokens.h"
danakjc492bf82020-09-09 20:02:4431#include "third_party/blink/public/mojom/frame/frame_owner_properties.mojom-forward.h"
32
33namespace blink {
Lei Zhang4a867672021-07-19 06:30:1434namespace mojom {
35class BrowserInterfaceBroker;
36enum class TreeScopeType;
37} // namespace mojom
38
danakjc492bf82020-09-09 20:02:4439struct FramePolicy;
40} // namespace blink
41
42namespace content {
43
Carlos Caballero40b0efd2021-01-26 11:55:0044class BrowserContext;
Jeremy Roman2d8dfe132021-07-06 20:51:2645class PageDelegate;
Lei Zhang4a867672021-07-19 06:30:1446class PageImpl;
danakjc492bf82020-09-09 20:02:4447class RenderFrameHostDelegate;
48class RenderViewHostDelegate;
49class RenderViewHostImpl;
50class RenderFrameHostManager;
51class RenderWidgetHostDelegate;
Carlos Caballero40b0efd2021-01-26 11:55:0052class SiteInstance;
Sharon Yang57bde122022-03-01 20:01:1253class SiteInstanceGroup;
danakjc492bf82020-09-09 20:02:4454
55// Represents the frame tree for a page. With the exception of the main frame,
56// all FrameTreeNodes will be created/deleted in response to frame attach and
57// detach events in the DOM.
58//
59// The main frame's FrameTreeNode is special in that it is reused. This allows
60// it to serve as an anchor for state that needs to persist across top-level
61// page navigations.
62//
63// TODO(ajwong): Move NavigationController ownership to the main frame
64// FrameTreeNode. Possibly expose access to it from here.
65//
66// This object is only used on the UI thread.
67class CONTENT_EXPORT FrameTree {
68 public:
69 class NodeRange;
70
Alan Zhao8a882d12022-05-18 01:32:1571 class CONTENT_EXPORT NodeIterator {
danakjc492bf82020-09-09 20:02:4472 public:
Alan Zhao8a882d12022-05-18 01:32:1573 using iterator_category = std::forward_iterator_tag;
74 using value_type = FrameTreeNode*;
75 using difference_type = std::ptrdiff_t;
76 using pointer = FrameTreeNode**;
77 using reference = FrameTreeNode*&;
78
danakjc492bf82020-09-09 20:02:4479 NodeIterator(const NodeIterator& other);
80 ~NodeIterator();
81
82 NodeIterator& operator++();
Kevin McNee5f594382021-05-06 23:18:2383 // Advances the iterator and excludes the children of the current node
84 NodeIterator& AdvanceSkippingChildren();
danakjc492bf82020-09-09 20:02:4485
86 bool operator==(const NodeIterator& rhs) const;
87 bool operator!=(const NodeIterator& rhs) const { return !(*this == rhs); }
88
89 FrameTreeNode* operator*() { return current_node_; }
90
91 private:
Jayson Adams4db0bfe22021-07-15 19:24:0792 friend class FrameTreeTest;
danakjc492bf82020-09-09 20:02:4493 friend class NodeRange;
94
Kevin McNee5f594382021-05-06 23:18:2395 NodeIterator(const std::vector<FrameTreeNode*>& starting_nodes,
96 const FrameTreeNode* root_of_subtree_to_skip,
97 bool should_descend_into_inner_trees);
98
99 void AdvanceNode();
danakjc492bf82020-09-09 20:02:44100
Lukasz Anforowicz877e6222021-11-26 00:03:23101 // `current_node_` and `root_of_subtree_to_skip_` are not a raw_ptr<...> for
102 // performance reasons (based on analysis of sampling profiler data and
103 // tab_search:top100:2020).
Keishi Hattori488b7602022-05-02 13:09:31104 RAW_PTR_EXCLUSION FrameTreeNode* current_node_;
105 RAW_PTR_EXCLUSION const FrameTreeNode* const root_of_subtree_to_skip_;
Lukasz Anforowicz877e6222021-11-26 00:03:23106
Kevin McNee5f594382021-05-06 23:18:23107 const bool should_descend_into_inner_trees_;
Jayson Adams4db0bfe22021-07-15 19:24:07108 base::circular_deque<FrameTreeNode*> queue_;
danakjc492bf82020-09-09 20:02:44109 };
110
111 class CONTENT_EXPORT NodeRange {
112 public:
Kevin McNee5f594382021-05-06 23:18:23113 NodeRange(const NodeRange&);
114 ~NodeRange();
115
danakjc492bf82020-09-09 20:02:44116 NodeIterator begin();
117 NodeIterator end();
118
119 private:
120 friend class FrameTree;
121
Kevin McNee5f594382021-05-06 23:18:23122 NodeRange(const std::vector<FrameTreeNode*>& starting_nodes,
123 const FrameTreeNode* root_of_subtree_to_skip,
124 bool should_descend_into_inner_trees);
danakjc492bf82020-09-09 20:02:44125
Kevin McNee5f594382021-05-06 23:18:23126 const std::vector<FrameTreeNode*> starting_nodes_;
Keishi Hattori0e45c022021-11-27 09:25:52127 const raw_ptr<const FrameTreeNode> root_of_subtree_to_skip_;
Kevin McNee5f594382021-05-06 23:18:23128 const bool should_descend_into_inner_trees_;
danakjc492bf82020-09-09 20:02:44129 };
130
Carlos Caballero03262522021-02-05 14:49:58131 class CONTENT_EXPORT Delegate {
132 public:
133 // A RenderFrameHost in the specified |frame_tree_node| started loading a
134 // new document. This corresponds to browser UI starting to show a spinner
135 // or other visual indicator for loading. This method is only invoked if the
Nate Chapin9aabf5f2021-11-12 00:31:19136 // FrameTree hadn't been previously loading. |should_show_loading_ui| will
137 // be true unless the load is a fragment navigation, or triggered by
Carlos Caballero03262522021-02-05 14:49:58138 // history.pushState/replaceState.
139 virtual void DidStartLoading(FrameTreeNode* frame_tree_node,
Nate Chapin9aabf5f2021-11-12 00:31:19140 bool should_show_loading_ui) = 0;
Carlos Caballero03262522021-02-05 14:49:58141
Takashi Toyoshima74090df62021-03-09 14:34:57142 // This is called when all nodes in the FrameTree stopped loading. This
Carlos Caballero03262522021-02-05 14:49:58143 // corresponds to the browser UI stop showing a spinner or other visual
144 // indicator for loading.
145 virtual void DidStopLoading() = 0;
146
Sreeja Kamishettyd64b993d2022-02-14 12:04:42147 // Returns the delegate's top loading tree, which should be used to infer
Yu Gaoc8c18552022-06-22 14:38:45148 // the values of loading-related states. The state of
149 // IsLoadingIncludingInnerFrameTrees() is a WebContents level concept and
150 // LoadingTree would return the frame tree to which loading events should be
151 // directed.
Sreeja Kamishettyd64b993d2022-02-14 12:04:42152 //
153 // TODO(crbug.com/1261928): Remove this method and directly rely on
154 // GetOutermostMainFrame() once portals and guest views are migrated to
155 // MPArch.
156 virtual FrameTree* LoadingTree() = 0;
157
Carlos Caballero6ff6ace2021-02-05 16:53:00158 // Returns true when the active RenderWidgetHostView should be hidden.
159 virtual bool IsHidden() = 0;
Sreeja Kamishettya21b4f62021-06-25 07:48:25160
Sreeja Kamishetty53468972021-07-13 11:53:32161 // Called when current Page of this frame tree changes to `page`.
162 virtual void NotifyPageChanged(PageImpl& page) = 0;
Dominic Farolinoedf44ee2021-07-20 23:50:59163
164 // If the FrameTree using this delegate is an inner/nested FrameTree, then
165 // there may be a FrameTreeNode in the outer FrameTree that is considered
166 // our outer delegate FrameTreeNode. This method returns the outer delegate
167 // FrameTreeNode ID if one exists. If we don't have a an outer delegate
168 // FrameTreeNode, this method returns
169 // FrameTreeNode::kFrameTreeNodeInvalidId.
170 virtual int GetOuterDelegateFrameTreeNodeId() = 0;
Dave Tapuskac8de3b02021-12-03 21:51:01171
172 // Returns if this FrameTree represents a portal.
173 virtual bool IsPortal() = 0;
Carlos Caballero03262522021-02-05 14:49:58174 };
175
Sreeja Kamishetty74bacd522021-03-22 17:04:24176 // Type of FrameTree instance.
177 enum class Type {
178 // This FrameTree is the primary frame tree for the WebContents, whose main
179 // document URL is shown in the Omnibox.
180 kPrimary,
181
182 // This FrameTree is used to prerender a page in the background which is
183 // invisible to the user.
Dominic Farolino4bc10ee2021-08-31 00:37:36184 kPrerender,
185
186 // This FrameTree is used to host the contents of a <fencedframe> element.
187 // Even for <fencedframe>s hosted inside a prerendered page, the FrameTree
188 // associated with the fenced frame will be kFencedFrame, but the
189 // RenderFrameHosts inside of it will have their lifecycle state set to
190 // `RenderFrameHost::LifecycleState::kActive`.
191 //
192 // TODO(crbug.com/1232528, crbug.com/1244274): We should either:
193 // * Fully support nested FrameTrees inside prerendered pages, in which
194 // case all of the RenderFrameHosts inside the nested trees should have
195 // their lifecycle state set to kPrerendering, or...
196 // * Ban nested FrameTrees in prerendered pages, and therefore obsolete the
197 // above paragraph about <fencedframe>s hosted in prerendered pages.
198 kFencedFrame
Sreeja Kamishetty74bacd522021-03-22 17:04:24199 };
Sreeja Kamishetty837a10402021-04-23 12:41:59200
201 // A set of delegates are remembered here so that we can create
202 // RenderFrameHostManagers.
Dave Tapuska144570102022-08-02 19:28:27203 // `dev_tools_frame_token` is the devtools token for the root `FrameTreeNode`
204 // of this new `FrameTree`.
Sreeja Kamishetty837a10402021-04-23 12:41:59205 FrameTree(BrowserContext* browser_context,
206 Delegate* delegate,
207 NavigationControllerDelegate* navigation_controller_delegate,
208 NavigatorDelegate* navigator_delegate,
209 RenderFrameHostDelegate* render_frame_delegate,
210 RenderViewHostDelegate* render_view_delegate,
211 RenderWidgetHostDelegate* render_widget_delegate,
212 RenderFrameHostManager::Delegate* manager_delegate,
Jeremy Roman2d8dfe132021-07-06 20:51:26213 PageDelegate* page_delegate,
Dave Tapuska144570102022-08-02 19:28:27214 Type type,
215 const base::UnguessableToken& devtools_frame_token);
Peter Boström828b9022021-09-21 02:28:43216
217 FrameTree(const FrameTree&) = delete;
218 FrameTree& operator=(const FrameTree&) = delete;
219
Sreeja Kamishetty837a10402021-04-23 12:41:59220 ~FrameTree();
Sreeja Kamishetty74bacd522021-03-22 17:04:24221
Carlos Caballero40b0efd2021-01-26 11:55:00222 // Initializes the main frame for this FrameTree. That is it creates the
Rakina Zata Amniafd3c6582021-11-30 06:19:17223 // initial RenderFrameHost in the root node's RenderFrameHostManager, and also
Rakina Zata Amni2322f4f82022-01-24 13:24:24224 // creates an initial NavigationEntry (if the InitialNavigationEntry feature
Rakina Zata Amni4eb716e2022-04-05 21:32:46225 // is enabled) that potentially inherits `opener_for_origin`'s origin in its
Rakina Zata Amni2322f4f82022-01-24 13:24:24226 // NavigationController. This method will call back into the delegates so it
227 // should only be called once they have completed their initialization. Pass
228 // in frame_policy so that it can be set in the root node's replication_state.
Carlos Caballero40b0efd2021-01-26 11:55:00229 // TODO(carlscab): It would be great if initialization could happened in the
230 // constructor so we do not leave objects in a half initialized state.
231 void Init(SiteInstance* main_frame_site_instance,
232 bool renderer_initiated_creation,
Rakina Zata Amniafd3c6582021-11-30 06:19:17233 const std::string& main_frame_name,
Rakina Zata Amni4eb716e2022-04-05 21:32:46234 RenderFrameHostImpl* opener_for_origin,
Harkiran Bolaria5ce27632022-01-20 15:05:05235 const blink::FramePolicy& frame_policy);
Sreeja Kamishetty837a10402021-04-23 12:41:59236
237 Type type() const { return type_; }
Carlos Caballero40b0efd2021-01-26 11:55:00238
danakjc492bf82020-09-09 20:02:44239 FrameTreeNode* root() const { return root_; }
240
Sreeja Kamishetty74bacd522021-03-22 17:04:24241 bool is_prerendering() const { return type_ == FrameTree::Type::kPrerender; }
Sreeja Kamishetty46f762c2021-02-05 07:52:46242
Sreeja Kamishetty60e47132022-02-08 12:51:53243 // Returns true if this frame tree is a portal.
244 //
245 // TODO(crbug.com/1254770): Once portals are migrated to MPArch, portals will
246 // have their own FrameTree::Type.
247 bool IsPortal();
248
Carlos Caballero03262522021-02-05 14:49:58249 Delegate* delegate() { return delegate_; }
250
Jeremy Roman2d8dfe132021-07-06 20:51:26251 // Delegates for various objects. These can be kept centrally on the
252 // FrameTree because they are expected to be the same for all frames on a
253 // given FrameTree.
danakjc492bf82020-09-09 20:02:44254 RenderFrameHostDelegate* render_frame_delegate() {
255 return render_frame_delegate_;
256 }
257 RenderViewHostDelegate* render_view_delegate() {
258 return render_view_delegate_;
259 }
260 RenderWidgetHostDelegate* render_widget_delegate() {
261 return render_widget_delegate_;
262 }
263 RenderFrameHostManager::Delegate* manager_delegate() {
264 return manager_delegate_;
265 }
Jeremy Roman2d8dfe132021-07-06 20:51:26266 PageDelegate* page_delegate() { return page_delegate_; }
Aaron Colwell78b4bde2021-03-16 16:16:09267
Albert J. Wong1b6dc962021-07-09 18:06:57268 using RenderViewHostMapId = base::IdType32<class RenderViewHostMap>;
Sharon Yangc581a0c2021-11-02 18:09:39269
270 // SiteInstanceGroup IDs are used to look up RenderViewHosts, since there is
271 // one RenderViewHost per SiteInstanceGroup in a given FrameTree.
Aaron Colwell78b4bde2021-03-16 16:16:09272 using RenderViewHostMap = std::unordered_map<RenderViewHostMapId,
273 RenderViewHostImpl*,
274 RenderViewHostMapId::Hasher>;
275 const RenderViewHostMap& render_view_hosts() const {
danakjc492bf82020-09-09 20:02:44276 return render_view_host_map_;
277 }
278
279 // Returns the FrameTreeNode with the given |frame_tree_node_id| if it is part
280 // of this FrameTree.
281 FrameTreeNode* FindByID(int frame_tree_node_id);
282
283 // Returns the FrameTreeNode with the given renderer-specific |routing_id|.
284 FrameTreeNode* FindByRoutingID(int process_id, int routing_id);
285
286 // Returns the first frame in this tree with the given |name|, or the main
287 // frame if |name| is empty.
288 // Note that this does NOT support pseudo-names like _self, _top, and _blank,
289 // nor searching other FrameTrees (unlike blink::WebView::findFrameByName).
290 FrameTreeNode* FindByName(const std::string& name);
291
292 // Returns a range to iterate over all FrameTreeNodes in the frame tree in
293 // breadth-first traversal order.
294 NodeRange Nodes();
295
296 // Returns a range to iterate over all FrameTreeNodes in a subtree of the
297 // frame tree, starting from |subtree_root|.
298 NodeRange SubtreeNodes(FrameTreeNode* subtree_root);
299
Kevin McNee53f0b2d2021-11-02 18:00:45300 // Returns a range to iterate over all FrameTreeNodes in this frame tree, as
301 // well as any FrameTreeNodes of inner frame trees. Note that this includes
302 // inner frame trees of inner WebContents as well.
303 NodeRange NodesIncludingInnerTreeNodes();
304
Kevin McNee5f594382021-05-06 23:18:23305 // Returns a range to iterate over all FrameTreeNodes in a subtree, starting
306 // from, but not including |parent|, as well as any FrameTreeNodes of inner
Kevin McNee53f0b2d2021-11-02 18:00:45307 // frame trees. Note that this includes inner frame trees of inner WebContents
308 // as well.
Kevin McNee5f594382021-05-06 23:18:23309 static NodeRange SubtreeAndInnerTreeNodes(RenderFrameHostImpl* parent);
310
danakjc492bf82020-09-09 20:02:44311 // Adds a new child frame to the frame tree. |process_id| is required to
312 // disambiguate |new_routing_id|, and it must match the process of the
Kevin McNee43fe8292021-10-04 22:59:41313 // |parent| node. Otherwise no child is added and this method returns nullptr.
danakjc492bf82020-09-09 20:02:44314 // |interface_provider_receiver| is the receiver end of the InterfaceProvider
315 // interface through which the child RenderFrame can access Mojo services
316 // exposed by the corresponding RenderFrameHost. The caller takes care of
Antonio Sartoridb967c52021-01-20 09:54:30317 // sending the client end of the interface down to the
318 // RenderFrame. |policy_container_bind_params|, if not null, is used for
319 // binding Blink's policy container to the new RenderFrameHost's
320 // PolicyContainerHost. This is only needed if this frame is the result of the
321 // CreateChildFrame mojo call, which also delivers the
Kevin McNee43fe8292021-10-04 22:59:41322 // |policy_container_bind_params|. |is_dummy_frame_for_inner_tree| is true if
323 // the added frame is only to serve as a placeholder for an inner frame tree
324 // (e.g. fenced frames, portals) and will not have a live RenderFrame of its
325 // own.
danakjc492bf82020-09-09 20:02:44326 FrameTreeNode* AddFrame(
327 RenderFrameHostImpl* parent,
328 int process_id,
329 int new_routing_id,
danakj0bdfacd2021-01-20 19:27:18330 mojo::PendingAssociatedRemote<mojom::Frame> frame_remote,
danakjc492bf82020-09-09 20:02:44331 mojo::PendingReceiver<blink::mojom::BrowserInterfaceBroker>
332 browser_interface_broker_receiver,
Antonio Sartoridb967c52021-01-20 09:54:30333 blink::mojom::PolicyContainerBindParamsPtr policy_container_bind_params,
Dominic Farolino12e06d72022-08-05 02:29:49334 mojo::PendingAssociatedReceiver<blink::mojom::AssociatedInterfaceProvider>
335 associated_interface_provider_receiver,
danakjc492bf82020-09-09 20:02:44336 blink::mojom::TreeScopeType scope,
337 const std::string& frame_name,
338 const std::string& frame_unique_name,
339 bool is_created_by_script,
Chris Hamilton3ff6ed0e2021-02-19 03:54:04340 const blink::LocalFrameToken& frame_token,
danakjc492bf82020-09-09 20:02:44341 const base::UnguessableToken& devtools_frame_token,
Daniel Cheng284c38942022-09-22 23:30:34342 const blink::DocumentToken& document_token,
danakjc492bf82020-09-09 20:02:44343 const blink::FramePolicy& frame_policy,
344 const blink::mojom::FrameOwnerProperties& frame_owner_properties,
345 bool was_discarded,
Kevin McNee43fe8292021-10-04 22:59:41346 blink::FrameOwnerElementType owner_type,
347 bool is_dummy_frame_for_inner_tree);
danakjc492bf82020-09-09 20:02:44348
349 // Removes a frame from the frame tree. |child|, its children, and objects
350 // owned by their RenderFrameHostManagers are immediately deleted. The root
351 // node cannot be removed this way.
352 void RemoveFrame(FrameTreeNode* child);
353
354 // This method walks the entire frame tree and creates a RenderFrameProxyHost
355 // for the given |site_instance| in each node except the |source| one --
356 // the source will have a RenderFrameHost. |source| may be null if there is
357 // no node navigating in this frame tree (such as when this is called
358 // for an opener's frame tree), in which case no nodes are skipped for
Harkiran Bolaria2912a6b32022-02-22 16:43:45359 // RenderFrameProxyHost creation. |source_new_browsing_context_state| is the
360 // BrowsingContextState used by the speculative frame host, which may differ
361 // from the BrowsingContextState in |source| during cross-origin cross-
362 // browsing-instance navigations.
danakjc492bf82020-09-09 20:02:44363 void CreateProxiesForSiteInstance(FrameTreeNode* source,
Harkiran Bolaria2912a6b32022-02-22 16:43:45364 SiteInstance* site_instance,
365 const scoped_refptr<BrowsingContextState>&
366 source_new_browsing_context_state);
danakjc492bf82020-09-09 20:02:44367
368 // Convenience accessor for the main frame's RenderFrameHostImpl.
369 RenderFrameHostImpl* GetMainFrame() const;
370
371 // Returns the focused frame.
372 FrameTreeNode* GetFocusedFrame();
373
Sharon Yangefe52632022-03-08 23:06:06374 // Sets the focused frame to |node|. |source| identifies the
375 // SiteInstanceGroup that initiated this focus change. If this FrameTree has
376 // SiteInstanceGroups other than |source|, those SiteInstanceGroups will be
377 // notified about the new focused frame. Note that |source| may differ from
378 // |node|'s current SiteInstanceGroup (e.g., this happens for cross-process
379 // window.focus() calls).
380 void SetFocusedFrame(FrameTreeNode* node, SiteInstanceGroup* source);
danakjc492bf82020-09-09 20:02:44381
danakjc492bf82020-09-09 20:02:44382 // Creates a RenderViewHostImpl for a given |site_instance| in the tree.
383 //
384 // The RenderFrameHostImpls and the RenderFrameProxyHosts will share ownership
385 // of this object.
386 scoped_refptr<RenderViewHostImpl> CreateRenderViewHost(
387 SiteInstance* site_instance,
388 int32_t main_frame_routing_id,
Harkiran Bolaria57e2b062022-03-14 10:27:58389 bool renderer_initiated_creation,
390 scoped_refptr<BrowsingContextState> main_browsing_context_state);
danakjc492bf82020-09-09 20:02:44391
392 // Returns the existing RenderViewHost for a new RenderFrameHost.
393 // There should always be such a RenderViewHost, because the main frame
394 // RenderFrameHost for each SiteInstance should be created before subframes.
Sharon Yang57bde122022-03-01 20:01:12395 scoped_refptr<RenderViewHostImpl> GetRenderViewHost(SiteInstanceGroup* group);
danakjc492bf82020-09-09 20:02:44396
Sharon Yangc581a0c2021-11-02 18:09:39397 // Returns the ID used for the RenderViewHost associated with
398 // |site_instance_group|.
399 RenderViewHostMapId GetRenderViewHostMapId(
400 SiteInstanceGroup* site_instance_group) const;
Aaron Colwell78b4bde2021-03-16 16:16:09401
danakjc492bf82020-09-09 20:02:44402 // Registers a RenderViewHost so that it can be reused by other frames
Aaron Colwell78b4bde2021-03-16 16:16:09403 // whose SiteInstance maps to the same RenderViewHostMapId.
danakjc492bf82020-09-09 20:02:44404 //
405 // This method does not take ownership of|rvh|.
406 //
407 // NOTE: This method CHECK fails if a RenderViewHost is already registered for
408 // |rvh|'s SiteInstance.
409 //
410 // ALSO NOTE: After calling RegisterRenderViewHost, UnregisterRenderViewHost
411 // *must* be called for |rvh| when it is destroyed or put into the
412 // BackForwardCache, to prevent FrameTree::CreateRenderViewHost from trying to
413 // reuse it.
Aaron Colwell78b4bde2021-03-16 16:16:09414 void RegisterRenderViewHost(RenderViewHostMapId id, RenderViewHostImpl* rvh);
danakjc492bf82020-09-09 20:02:44415
416 // Unregisters the RenderViewHostImpl that's available for reuse for a
Aaron Colwell78b4bde2021-03-16 16:16:09417 // particular RenderViewHostMapId. NOTE: This method CHECK fails if it is
418 // called for a |render_view_host| that is not currently set for reuse.
419 void UnregisterRenderViewHost(RenderViewHostMapId id,
Aaron Colwellc4bd7d62021-01-29 04:23:13420 RenderViewHostImpl* render_view_host);
danakjc492bf82020-09-09 20:02:44421
422 // This is called when the frame is about to be removed and started to run
423 // unload handlers.
424 void FrameUnloading(FrameTreeNode* frame);
425
426 // This is only meant to be called by FrameTreeNode. Triggers calling
427 // the listener installed by SetFrameRemoveListener.
428 void FrameRemoved(FrameTreeNode* frame);
429
Carlos Caballero03262522021-02-05 14:49:58430 void DidStartLoadingNode(FrameTreeNode& node,
Nate Chapin9aabf5f2021-11-12 00:31:19431 bool should_show_loading_ui,
Carlos Caballero03262522021-02-05 14:49:58432 bool was_previously_loading);
433 void DidStopLoadingNode(FrameTreeNode& node);
Carlos Caballero03262522021-02-05 14:49:58434 void DidCancelLoading();
danakjc492bf82020-09-09 20:02:44435
Sreeja Kamishetty0be3b1b2021-08-12 17:04:15436 // Returns this FrameTree's total load progress. If the `root_` FrameTreeNode
437 // is navigating returns `blink::kInitialLoadProgress`.
438 double GetLoadProgress();
danakjc492bf82020-09-09 20:02:44439
Sreeja Kamishetty15f9944a22022-03-10 10:16:08440 // Returns true if at least one of the nodes in this frame tree or nodes in
441 // any inner frame tree of the same WebContents is loading.
Yu Gaoc8c18552022-06-22 14:38:45442 bool IsLoadingIncludingInnerFrameTrees() const;
danakjc492bf82020-09-09 20:02:44443
444 // Set page-level focus in all SiteInstances involved in rendering
445 // this FrameTree, not including the current main frame's
446 // SiteInstance. The focus update will be sent via the main frame's proxies
447 // in those SiteInstances.
448 void ReplicatePageFocus(bool is_focused);
449
450 // Updates page-level focus for this FrameTree in the subframe renderer
Sharon Yangefe52632022-03-08 23:06:06451 // identified by |group|.
452 void SetPageFocus(SiteInstanceGroup* group, bool is_focused);
danakjc492bf82020-09-09 20:02:44453
W. James MacLeanc07dc41b2022-07-25 18:52:16454 // Walks the current frame tree and registers any origins matching
455 // `previously_visited_origin`, either the last committed origin of a
456 // RenderFrameHost or the origin associated with a NavigationRequest that has
457 // been assigned to a SiteInstance, as having the default origin isolation
458 // state. This is only necessary when `previously_visited_origin` is seen with
459 // an OriginAgentCluster header explicitly requesting something other than the
460 // default.
461 void RegisterExistingOriginAsHavingDefaultIsolation(
danakjc492bf82020-09-09 20:02:44462 const url::Origin& previously_visited_origin,
463 NavigationRequest* navigation_request_to_exclude);
464
Carlos Caballero40b0efd2021-01-26 11:55:00465 NavigationControllerImpl& controller() { return navigator_.controller(); }
danakjc492bf82020-09-09 20:02:44466 Navigator& navigator() { return navigator_; }
467
Carlos Caballeroede6f8c2021-01-28 11:01:50468 // Another page accessed the initial empty main document, which means it
469 // is no longer safe to display a pending URL without risking a URL spoof.
470 void DidAccessInitialMainDocument();
471
472 bool has_accessed_initial_main_document() const {
473 return has_accessed_initial_main_document_;
474 }
475
476 void ResetHasAccessedInitialMainDocument() {
477 has_accessed_initial_main_document_ = false;
478 }
479
Carlos Caballero6ff6ace2021-02-05 16:53:00480 bool IsHidden() const { return delegate_->IsHidden(); }
481
Sreeja Kamishettyd64b993d2022-02-14 12:04:42482 // LoadingTree returns the following for different frame trees to direct
483 // loading related events. Please see FrameTree::Delegate::LoadingTree for
484 // more comments.
485 // - For prerender frame tree -> returns the frame tree itself.
486 // - For fenced frame and primary frame tree (including portal) -> returns
487 // the delegate's primary frame tree.
488 FrameTree* LoadingTree();
489
Carlos Caballero03262522021-02-05 14:49:58490 // Stops all ongoing navigations in each of the nodes of this FrameTree.
491 void StopLoading();
492
Carlos Caballero101ac26b2021-03-24 11:54:05493 // Prepares this frame tree for destruction, cleaning up the internal state
494 // and firing the appropriate events like FrameDeleted.
495 // Must be called before FrameTree is destroyed.
496 void Shutdown();
497
Takashi Toyoshimaea534ef22021-07-21 03:27:59498 bool IsBeingDestroyed() const { return is_being_destroyed_; }
499
Dave Tapuskad8b0530f2021-10-19 15:12:31500 base::SafeRef<FrameTree> GetSafeRef();
501
Dave Tapuska54c76a032021-10-27 22:10:42502 // Walks up the FrameTree chain and focuses the FrameTreeNode where
503 // each inner FrameTree is attached.
504 void FocusOuterFrameTrees();
505
David Bokanc3fb5fa2022-07-04 14:55:31506 absl::optional<blink::features::FencedFramesImplementationType>
507 FencedFramesImplementationType() const {
508 return fenced_frames_impl_;
509 }
510
511 bool IsFencedFramesMPArchBased() const {
512 return fenced_frames_impl_.has_value() &&
513 fenced_frames_impl_.value() ==
514 blink::features::FencedFramesImplementationType::kMPArch;
515 }
516 bool IsFencedFramesShadowDOMBased() const {
517 return fenced_frames_impl_.has_value() &&
518 fenced_frames_impl_.value() ==
519 blink::features::FencedFramesImplementationType::kShadowDOM;
520 }
521
danakjc492bf82020-09-09 20:02:44522 private:
523 friend class FrameTreeTest;
524 FRIEND_TEST_ALL_PREFIXES(RenderFrameHostImplBrowserTest, RemoveFocusedFrame);
Sreeja Kamishettyd64b993d2022-02-14 12:04:42525 FRIEND_TEST_ALL_PREFIXES(PortalBrowserTest, NodesForIsLoading);
Xiaochen Zhou6443f752022-08-10 16:40:46526 FRIEND_TEST_ALL_PREFIXES(FencedFrameMPArchBrowserTest, NodesForIsLoading);
Sharon Yang2f3304a2022-05-13 02:24:25527 FRIEND_TEST_ALL_PREFIXES(RenderFrameHostManagerTest,
528 CreateRenderViewAfterProcessKillAndClosedProxy);
danakjc492bf82020-09-09 20:02:44529
530 // Returns a range to iterate over all FrameTreeNodes in the frame tree in
531 // breadth-first traversal order, skipping the subtree rooted at
532 // |node|, but including |node| itself.
533 NodeRange NodesExceptSubtree(FrameTreeNode* node);
534
Sreeja Kamishettyd64b993d2022-02-14 12:04:42535 // Returns all FrameTreeNodes in this frame tree, as well as any
536 // FrameTreeNodes of inner frame trees. Note that this doesn't include inner
537 // frame trees of inner delegates. This is used to find the aggregate
538 // IsLoading value for a frame tree.
539 //
540 // TODO(crbug.com/1261928, crbug.com/1261928): Remove this method and directly
541 // rely on GetOutermostMainFrame() and NodesIncludingInnerTreeNodes() once
542 // portals and guest views are migrated to MPArch.
543 std::vector<FrameTreeNode*> CollectNodesForIsLoading();
544
Keishi Hattori0e45c022021-11-27 09:25:52545 const raw_ptr<Delegate> delegate_;
Carlos Caballero03262522021-02-05 14:49:58546
danakjc492bf82020-09-09 20:02:44547 // These delegates are installed into all the RenderViewHosts and
548 // RenderFrameHosts that we create.
Keishi Hattori0e45c022021-11-27 09:25:52549 raw_ptr<RenderFrameHostDelegate> render_frame_delegate_;
550 raw_ptr<RenderViewHostDelegate> render_view_delegate_;
551 raw_ptr<RenderWidgetHostDelegate> render_widget_delegate_;
552 raw_ptr<RenderFrameHostManager::Delegate> manager_delegate_;
553 raw_ptr<PageDelegate> page_delegate_;
danakjc492bf82020-09-09 20:02:44554
555 // The Navigator object responsible for managing navigations on this frame
Carlos Caballero40b0efd2021-01-26 11:55:00556 // tree. Each FrameTreeNode will default to using it for navigation tasks in
557 // the frame.
danakjc492bf82020-09-09 20:02:44558 Navigator navigator_;
559
Aaron Colwell78b4bde2021-03-16 16:16:09560 // Map of RenderViewHostMapId to RenderViewHost. This allows us to look up the
danakjc492bf82020-09-09 20:02:44561 // RenderViewHost for a given SiteInstance when creating RenderFrameHosts.
562 // Each RenderViewHost maintains a refcount and is deleted when there are no
563 // more RenderFrameHosts or RenderFrameProxyHosts using it.
Aaron Colwell78b4bde2021-03-16 16:16:09564 RenderViewHostMap render_view_host_map_;
danakjc492bf82020-09-09 20:02:44565
Harkiran Bolaria16f2c48d2022-04-22 12:39:57566 // Indicates type of frame tree.
567 const Type type_;
568
danakjc492bf82020-09-09 20:02:44569 // This is an owned ptr to the root FrameTreeNode, which never changes over
570 // the lifetime of the FrameTree. It is not a scoped_ptr because we need the
571 // pointer to remain valid even while the FrameTreeNode is being destroyed,
572 // since it's common for a node to test whether it's the root node.
Kalvin Lee75d70302022-07-20 19:22:03573 //
574 // TODO(crbug.com/1298696): content_browsertests breaks with MTECheckedPtr
575 // enabled. Triage.
576 raw_ptr<FrameTreeNode, DanglingUntriagedDegradeToNoOpWhenMTE> root_;
danakjc492bf82020-09-09 20:02:44577
578 int focused_frame_tree_node_id_;
579
danakjc492bf82020-09-09 20:02:44580 // Overall load progress.
581 double load_progress_;
582
David Bokanc3fb5fa2022-07-04 14:55:31583 absl::optional<blink::features::FencedFramesImplementationType>
584 fenced_frames_impl_;
585
Carlos Caballeroede6f8c2021-01-28 11:01:50586 // Whether the initial empty page has been accessed by another page, making it
587 // unsafe to show the pending URL. Usually false unless another window tries
588 // to modify the blank page. Always false after the first commit.
589 bool has_accessed_initial_main_document_ = false;
590
Takashi Toyoshimaea534ef22021-07-21 03:27:59591 bool is_being_destroyed_ = false;
592
Carlos Caballero101ac26b2021-03-24 11:54:05593#if DCHECK_IS_ON()
594 // Whether Shutdown() was called.
595 bool was_shut_down_ = false;
596#endif
Dave Tapuskad8b0530f2021-10-19 15:12:31597
598 base::WeakPtrFactory<FrameTree> weak_ptr_factory_{this};
danakjc492bf82020-09-09 20:02:44599};
600
601} // namespace content
602
603#endif // CONTENT_BROWSER_RENDERER_HOST_FRAME_TREE_H_