blob: 161433bdda7ff9a93f105cbfe109a7ded6badeb2 [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,
Dave Tapuskadda303d2022-10-04 16:56:4897 bool should_descend_into_inner_trees,
98 bool include_delegate_nodes_for_inner_frame_trees);
Kevin McNee5f594382021-05-06 23:18:2399
100 void AdvanceNode();
danakjc492bf82020-09-09 20:02:44101
Lukasz Anforowicz877e6222021-11-26 00:03:23102 // `current_node_` and `root_of_subtree_to_skip_` are not a raw_ptr<...> for
103 // performance reasons (based on analysis of sampling profiler data and
104 // tab_search:top100:2020).
Keishi Hattori488b7602022-05-02 13:09:31105 RAW_PTR_EXCLUSION FrameTreeNode* current_node_;
106 RAW_PTR_EXCLUSION const FrameTreeNode* const root_of_subtree_to_skip_;
Lukasz Anforowicz877e6222021-11-26 00:03:23107
Kevin McNee5f594382021-05-06 23:18:23108 const bool should_descend_into_inner_trees_;
Dave Tapuskadda303d2022-10-04 16:56:48109 const bool include_delegate_nodes_for_inner_frame_trees_;
Jayson Adams4db0bfe22021-07-15 19:24:07110 base::circular_deque<FrameTreeNode*> queue_;
danakjc492bf82020-09-09 20:02:44111 };
112
113 class CONTENT_EXPORT NodeRange {
114 public:
Kevin McNee5f594382021-05-06 23:18:23115 NodeRange(const NodeRange&);
116 ~NodeRange();
117
danakjc492bf82020-09-09 20:02:44118 NodeIterator begin();
119 NodeIterator end();
120
121 private:
122 friend class FrameTree;
123
Kevin McNee5f594382021-05-06 23:18:23124 NodeRange(const std::vector<FrameTreeNode*>& starting_nodes,
125 const FrameTreeNode* root_of_subtree_to_skip,
Dave Tapuskadda303d2022-10-04 16:56:48126 bool should_descend_into_inner_trees,
127 bool include_delegate_nodes_for_inner_frame_trees);
danakjc492bf82020-09-09 20:02:44128
Kevin McNee5f594382021-05-06 23:18:23129 const std::vector<FrameTreeNode*> starting_nodes_;
Keishi Hattori0e45c022021-11-27 09:25:52130 const raw_ptr<const FrameTreeNode> root_of_subtree_to_skip_;
Kevin McNee5f594382021-05-06 23:18:23131 const bool should_descend_into_inner_trees_;
Dave Tapuskadda303d2022-10-04 16:56:48132 const bool include_delegate_nodes_for_inner_frame_trees_;
danakjc492bf82020-09-09 20:02:44133 };
134
Carlos Caballero03262522021-02-05 14:49:58135 class CONTENT_EXPORT Delegate {
136 public:
137 // A RenderFrameHost in the specified |frame_tree_node| started loading a
138 // new document. This corresponds to browser UI starting to show a spinner
139 // or other visual indicator for loading. This method is only invoked if the
Nate Chapin9aabf5f2021-11-12 00:31:19140 // FrameTree hadn't been previously loading. |should_show_loading_ui| will
141 // be true unless the load is a fragment navigation, or triggered by
Carlos Caballero03262522021-02-05 14:49:58142 // history.pushState/replaceState.
143 virtual void DidStartLoading(FrameTreeNode* frame_tree_node,
Nate Chapin9aabf5f2021-11-12 00:31:19144 bool should_show_loading_ui) = 0;
Carlos Caballero03262522021-02-05 14:49:58145
Takashi Toyoshima74090df62021-03-09 14:34:57146 // This is called when all nodes in the FrameTree stopped loading. This
Carlos Caballero03262522021-02-05 14:49:58147 // corresponds to the browser UI stop showing a spinner or other visual
148 // indicator for loading.
149 virtual void DidStopLoading() = 0;
150
Sreeja Kamishettyd64b993d2022-02-14 12:04:42151 // Returns the delegate's top loading tree, which should be used to infer
Yu Gaoc8c18552022-06-22 14:38:45152 // the values of loading-related states. The state of
153 // IsLoadingIncludingInnerFrameTrees() is a WebContents level concept and
154 // LoadingTree would return the frame tree to which loading events should be
155 // directed.
Sreeja Kamishettyd64b993d2022-02-14 12:04:42156 //
157 // TODO(crbug.com/1261928): Remove this method and directly rely on
158 // GetOutermostMainFrame() once portals and guest views are migrated to
159 // MPArch.
160 virtual FrameTree* LoadingTree() = 0;
161
Carlos Caballero6ff6ace2021-02-05 16:53:00162 // Returns true when the active RenderWidgetHostView should be hidden.
163 virtual bool IsHidden() = 0;
Sreeja Kamishettya21b4f62021-06-25 07:48:25164
Sreeja Kamishetty53468972021-07-13 11:53:32165 // Called when current Page of this frame tree changes to `page`.
166 virtual void NotifyPageChanged(PageImpl& page) = 0;
Dominic Farolinoedf44ee2021-07-20 23:50:59167
168 // If the FrameTree using this delegate is an inner/nested FrameTree, then
169 // there may be a FrameTreeNode in the outer FrameTree that is considered
170 // our outer delegate FrameTreeNode. This method returns the outer delegate
171 // FrameTreeNode ID if one exists. If we don't have a an outer delegate
172 // FrameTreeNode, this method returns
173 // FrameTreeNode::kFrameTreeNodeInvalidId.
174 virtual int GetOuterDelegateFrameTreeNodeId() = 0;
Dave Tapuskac8de3b02021-12-03 21:51:01175
176 // Returns if this FrameTree represents a portal.
177 virtual bool IsPortal() = 0;
Carlos Caballero03262522021-02-05 14:49:58178 };
179
Sreeja Kamishetty74bacd522021-03-22 17:04:24180 // Type of FrameTree instance.
181 enum class Type {
182 // This FrameTree is the primary frame tree for the WebContents, whose main
183 // document URL is shown in the Omnibox.
184 kPrimary,
185
186 // This FrameTree is used to prerender a page in the background which is
187 // invisible to the user.
Dominic Farolino4bc10ee2021-08-31 00:37:36188 kPrerender,
189
190 // This FrameTree is used to host the contents of a <fencedframe> element.
191 // Even for <fencedframe>s hosted inside a prerendered page, the FrameTree
192 // associated with the fenced frame will be kFencedFrame, but the
193 // RenderFrameHosts inside of it will have their lifecycle state set to
194 // `RenderFrameHost::LifecycleState::kActive`.
195 //
196 // TODO(crbug.com/1232528, crbug.com/1244274): We should either:
197 // * Fully support nested FrameTrees inside prerendered pages, in which
198 // case all of the RenderFrameHosts inside the nested trees should have
199 // their lifecycle state set to kPrerendering, or...
200 // * Ban nested FrameTrees in prerendered pages, and therefore obsolete the
201 // above paragraph about <fencedframe>s hosted in prerendered pages.
202 kFencedFrame
Sreeja Kamishetty74bacd522021-03-22 17:04:24203 };
Sreeja Kamishetty837a10402021-04-23 12:41:59204
205 // A set of delegates are remembered here so that we can create
206 // RenderFrameHostManagers.
Dave Tapuska144570102022-08-02 19:28:27207 // `dev_tools_frame_token` is the devtools token for the root `FrameTreeNode`
208 // of this new `FrameTree`.
Sreeja Kamishetty837a10402021-04-23 12:41:59209 FrameTree(BrowserContext* browser_context,
210 Delegate* delegate,
211 NavigationControllerDelegate* navigation_controller_delegate,
212 NavigatorDelegate* navigator_delegate,
213 RenderFrameHostDelegate* render_frame_delegate,
214 RenderViewHostDelegate* render_view_delegate,
215 RenderWidgetHostDelegate* render_widget_delegate,
216 RenderFrameHostManager::Delegate* manager_delegate,
Jeremy Roman2d8dfe132021-07-06 20:51:26217 PageDelegate* page_delegate,
Dave Tapuska144570102022-08-02 19:28:27218 Type type,
219 const base::UnguessableToken& devtools_frame_token);
Peter Boström828b9022021-09-21 02:28:43220
221 FrameTree(const FrameTree&) = delete;
222 FrameTree& operator=(const FrameTree&) = delete;
223
Sreeja Kamishetty837a10402021-04-23 12:41:59224 ~FrameTree();
Sreeja Kamishetty74bacd522021-03-22 17:04:24225
Carlos Caballero40b0efd2021-01-26 11:55:00226 // Initializes the main frame for this FrameTree. That is it creates the
Rakina Zata Amniafd3c6582021-11-30 06:19:17227 // initial RenderFrameHost in the root node's RenderFrameHostManager, and also
Rakina Zata Amni2322f4f82022-01-24 13:24:24228 // creates an initial NavigationEntry (if the InitialNavigationEntry feature
Rakina Zata Amni4eb716e2022-04-05 21:32:46229 // is enabled) that potentially inherits `opener_for_origin`'s origin in its
Rakina Zata Amni2322f4f82022-01-24 13:24:24230 // NavigationController. This method will call back into the delegates so it
231 // should only be called once they have completed their initialization. Pass
232 // in frame_policy so that it can be set in the root node's replication_state.
Carlos Caballero40b0efd2021-01-26 11:55:00233 // TODO(carlscab): It would be great if initialization could happened in the
234 // constructor so we do not leave objects in a half initialized state.
235 void Init(SiteInstance* main_frame_site_instance,
236 bool renderer_initiated_creation,
Rakina Zata Amniafd3c6582021-11-30 06:19:17237 const std::string& main_frame_name,
Rakina Zata Amni4eb716e2022-04-05 21:32:46238 RenderFrameHostImpl* opener_for_origin,
Harkiran Bolaria5ce27632022-01-20 15:05:05239 const blink::FramePolicy& frame_policy);
Sreeja Kamishetty837a10402021-04-23 12:41:59240
241 Type type() const { return type_; }
Carlos Caballero40b0efd2021-01-26 11:55:00242
danakjc492bf82020-09-09 20:02:44243 FrameTreeNode* root() const { return root_; }
244
Sreeja Kamishetty74bacd522021-03-22 17:04:24245 bool is_prerendering() const { return type_ == FrameTree::Type::kPrerender; }
Sreeja Kamishetty46f762c2021-02-05 07:52:46246
Sreeja Kamishetty60e47132022-02-08 12:51:53247 // Returns true if this frame tree is a portal.
248 //
249 // TODO(crbug.com/1254770): Once portals are migrated to MPArch, portals will
250 // have their own FrameTree::Type.
251 bool IsPortal();
252
Carlos Caballero03262522021-02-05 14:49:58253 Delegate* delegate() { return delegate_; }
254
Jeremy Roman2d8dfe132021-07-06 20:51:26255 // Delegates for various objects. These can be kept centrally on the
256 // FrameTree because they are expected to be the same for all frames on a
257 // given FrameTree.
danakjc492bf82020-09-09 20:02:44258 RenderFrameHostDelegate* render_frame_delegate() {
259 return render_frame_delegate_;
260 }
261 RenderViewHostDelegate* render_view_delegate() {
262 return render_view_delegate_;
263 }
264 RenderWidgetHostDelegate* render_widget_delegate() {
265 return render_widget_delegate_;
266 }
267 RenderFrameHostManager::Delegate* manager_delegate() {
268 return manager_delegate_;
269 }
Jeremy Roman2d8dfe132021-07-06 20:51:26270 PageDelegate* page_delegate() { return page_delegate_; }
Aaron Colwell78b4bde2021-03-16 16:16:09271
Albert J. Wong1b6dc962021-07-09 18:06:57272 using RenderViewHostMapId = base::IdType32<class RenderViewHostMap>;
Sharon Yangc581a0c2021-11-02 18:09:39273
274 // SiteInstanceGroup IDs are used to look up RenderViewHosts, since there is
275 // one RenderViewHost per SiteInstanceGroup in a given FrameTree.
Aaron Colwell78b4bde2021-03-16 16:16:09276 using RenderViewHostMap = std::unordered_map<RenderViewHostMapId,
277 RenderViewHostImpl*,
278 RenderViewHostMapId::Hasher>;
279 const RenderViewHostMap& render_view_hosts() const {
danakjc492bf82020-09-09 20:02:44280 return render_view_host_map_;
281 }
282
283 // Returns the FrameTreeNode with the given |frame_tree_node_id| if it is part
284 // of this FrameTree.
285 FrameTreeNode* FindByID(int frame_tree_node_id);
286
287 // Returns the FrameTreeNode with the given renderer-specific |routing_id|.
288 FrameTreeNode* FindByRoutingID(int process_id, int routing_id);
289
290 // Returns the first frame in this tree with the given |name|, or the main
291 // frame if |name| is empty.
292 // Note that this does NOT support pseudo-names like _self, _top, and _blank,
293 // nor searching other FrameTrees (unlike blink::WebView::findFrameByName).
294 FrameTreeNode* FindByName(const std::string& name);
295
296 // Returns a range to iterate over all FrameTreeNodes in the frame tree in
297 // breadth-first traversal order.
298 NodeRange Nodes();
299
300 // Returns a range to iterate over all FrameTreeNodes in a subtree of the
301 // frame tree, starting from |subtree_root|.
302 NodeRange SubtreeNodes(FrameTreeNode* subtree_root);
303
Kevin McNee53f0b2d2021-11-02 18:00:45304 // Returns a range to iterate over all FrameTreeNodes in this frame tree, as
305 // well as any FrameTreeNodes of inner frame trees. Note that this includes
306 // inner frame trees of inner WebContents as well.
307 NodeRange NodesIncludingInnerTreeNodes();
308
Kevin McNee5f594382021-05-06 23:18:23309 // Returns a range to iterate over all FrameTreeNodes in a subtree, starting
310 // from, but not including |parent|, as well as any FrameTreeNodes of inner
Kevin McNee53f0b2d2021-11-02 18:00:45311 // frame trees. Note that this includes inner frame trees of inner WebContents
Dave Tapuskadda303d2022-10-04 16:56:48312 // as well. If `include_delegate_nodes_for_inner_frame_trees` is true the
313 // delegate RenderFrameHost owning the inner frame tree will also be returned.
314 static NodeRange SubtreeAndInnerTreeNodes(
315 RenderFrameHostImpl* parent,
316 bool include_delegate_nodes_for_inner_frame_trees = false);
Kevin McNee5f594382021-05-06 23:18:23317
danakjc492bf82020-09-09 20:02:44318 // Adds a new child frame to the frame tree. |process_id| is required to
319 // disambiguate |new_routing_id|, and it must match the process of the
Kevin McNee43fe8292021-10-04 22:59:41320 // |parent| node. Otherwise no child is added and this method returns nullptr.
danakjc492bf82020-09-09 20:02:44321 // |interface_provider_receiver| is the receiver end of the InterfaceProvider
322 // interface through which the child RenderFrame can access Mojo services
323 // exposed by the corresponding RenderFrameHost. The caller takes care of
Antonio Sartoridb967c52021-01-20 09:54:30324 // sending the client end of the interface down to the
325 // RenderFrame. |policy_container_bind_params|, if not null, is used for
326 // binding Blink's policy container to the new RenderFrameHost's
327 // PolicyContainerHost. This is only needed if this frame is the result of the
328 // CreateChildFrame mojo call, which also delivers the
Kevin McNee43fe8292021-10-04 22:59:41329 // |policy_container_bind_params|. |is_dummy_frame_for_inner_tree| is true if
330 // the added frame is only to serve as a placeholder for an inner frame tree
331 // (e.g. fenced frames, portals) and will not have a live RenderFrame of its
332 // own.
danakjc492bf82020-09-09 20:02:44333 FrameTreeNode* AddFrame(
334 RenderFrameHostImpl* parent,
335 int process_id,
336 int new_routing_id,
danakj0bdfacd2021-01-20 19:27:18337 mojo::PendingAssociatedRemote<mojom::Frame> frame_remote,
danakjc492bf82020-09-09 20:02:44338 mojo::PendingReceiver<blink::mojom::BrowserInterfaceBroker>
339 browser_interface_broker_receiver,
Antonio Sartoridb967c52021-01-20 09:54:30340 blink::mojom::PolicyContainerBindParamsPtr policy_container_bind_params,
Dominic Farolino12e06d72022-08-05 02:29:49341 mojo::PendingAssociatedReceiver<blink::mojom::AssociatedInterfaceProvider>
342 associated_interface_provider_receiver,
danakjc492bf82020-09-09 20:02:44343 blink::mojom::TreeScopeType scope,
344 const std::string& frame_name,
345 const std::string& frame_unique_name,
346 bool is_created_by_script,
Chris Hamilton3ff6ed0e2021-02-19 03:54:04347 const blink::LocalFrameToken& frame_token,
danakjc492bf82020-09-09 20:02:44348 const base::UnguessableToken& devtools_frame_token,
Daniel Cheng284c38942022-09-22 23:30:34349 const blink::DocumentToken& document_token,
danakjc492bf82020-09-09 20:02:44350 const blink::FramePolicy& frame_policy,
351 const blink::mojom::FrameOwnerProperties& frame_owner_properties,
352 bool was_discarded,
Kevin McNee43fe8292021-10-04 22:59:41353 blink::FrameOwnerElementType owner_type,
354 bool is_dummy_frame_for_inner_tree);
danakjc492bf82020-09-09 20:02:44355
356 // Removes a frame from the frame tree. |child|, its children, and objects
357 // owned by their RenderFrameHostManagers are immediately deleted. The root
358 // node cannot be removed this way.
359 void RemoveFrame(FrameTreeNode* child);
360
361 // This method walks the entire frame tree and creates a RenderFrameProxyHost
362 // for the given |site_instance| in each node except the |source| one --
363 // the source will have a RenderFrameHost. |source| may be null if there is
364 // no node navigating in this frame tree (such as when this is called
365 // for an opener's frame tree), in which case no nodes are skipped for
Harkiran Bolaria2912a6b32022-02-22 16:43:45366 // RenderFrameProxyHost creation. |source_new_browsing_context_state| is the
367 // BrowsingContextState used by the speculative frame host, which may differ
368 // from the BrowsingContextState in |source| during cross-origin cross-
369 // browsing-instance navigations.
danakjc492bf82020-09-09 20:02:44370 void CreateProxiesForSiteInstance(FrameTreeNode* source,
Harkiran Bolaria2912a6b32022-02-22 16:43:45371 SiteInstance* site_instance,
372 const scoped_refptr<BrowsingContextState>&
373 source_new_browsing_context_state);
danakjc492bf82020-09-09 20:02:44374
375 // Convenience accessor for the main frame's RenderFrameHostImpl.
376 RenderFrameHostImpl* GetMainFrame() const;
377
378 // Returns the focused frame.
379 FrameTreeNode* GetFocusedFrame();
380
Sharon Yangefe52632022-03-08 23:06:06381 // Sets the focused frame to |node|. |source| identifies the
382 // SiteInstanceGroup that initiated this focus change. If this FrameTree has
383 // SiteInstanceGroups other than |source|, those SiteInstanceGroups will be
384 // notified about the new focused frame. Note that |source| may differ from
385 // |node|'s current SiteInstanceGroup (e.g., this happens for cross-process
386 // window.focus() calls).
387 void SetFocusedFrame(FrameTreeNode* node, SiteInstanceGroup* source);
danakjc492bf82020-09-09 20:02:44388
danakjc492bf82020-09-09 20:02:44389 // Creates a RenderViewHostImpl for a given |site_instance| in the tree.
390 //
391 // The RenderFrameHostImpls and the RenderFrameProxyHosts will share ownership
392 // of this object.
393 scoped_refptr<RenderViewHostImpl> CreateRenderViewHost(
394 SiteInstance* site_instance,
395 int32_t main_frame_routing_id,
Harkiran Bolaria57e2b062022-03-14 10:27:58396 bool renderer_initiated_creation,
397 scoped_refptr<BrowsingContextState> main_browsing_context_state);
danakjc492bf82020-09-09 20:02:44398
399 // Returns the existing RenderViewHost for a new RenderFrameHost.
400 // There should always be such a RenderViewHost, because the main frame
401 // RenderFrameHost for each SiteInstance should be created before subframes.
Sharon Yang57bde122022-03-01 20:01:12402 scoped_refptr<RenderViewHostImpl> GetRenderViewHost(SiteInstanceGroup* group);
danakjc492bf82020-09-09 20:02:44403
Sharon Yangc581a0c2021-11-02 18:09:39404 // Returns the ID used for the RenderViewHost associated with
405 // |site_instance_group|.
406 RenderViewHostMapId GetRenderViewHostMapId(
407 SiteInstanceGroup* site_instance_group) const;
Aaron Colwell78b4bde2021-03-16 16:16:09408
danakjc492bf82020-09-09 20:02:44409 // Registers a RenderViewHost so that it can be reused by other frames
Aaron Colwell78b4bde2021-03-16 16:16:09410 // whose SiteInstance maps to the same RenderViewHostMapId.
danakjc492bf82020-09-09 20:02:44411 //
412 // This method does not take ownership of|rvh|.
413 //
414 // NOTE: This method CHECK fails if a RenderViewHost is already registered for
415 // |rvh|'s SiteInstance.
416 //
417 // ALSO NOTE: After calling RegisterRenderViewHost, UnregisterRenderViewHost
418 // *must* be called for |rvh| when it is destroyed or put into the
419 // BackForwardCache, to prevent FrameTree::CreateRenderViewHost from trying to
420 // reuse it.
Aaron Colwell78b4bde2021-03-16 16:16:09421 void RegisterRenderViewHost(RenderViewHostMapId id, RenderViewHostImpl* rvh);
danakjc492bf82020-09-09 20:02:44422
423 // Unregisters the RenderViewHostImpl that's available for reuse for a
Aaron Colwell78b4bde2021-03-16 16:16:09424 // particular RenderViewHostMapId. NOTE: This method CHECK fails if it is
425 // called for a |render_view_host| that is not currently set for reuse.
426 void UnregisterRenderViewHost(RenderViewHostMapId id,
Aaron Colwellc4bd7d62021-01-29 04:23:13427 RenderViewHostImpl* render_view_host);
danakjc492bf82020-09-09 20:02:44428
429 // This is called when the frame is about to be removed and started to run
430 // unload handlers.
431 void FrameUnloading(FrameTreeNode* frame);
432
433 // This is only meant to be called by FrameTreeNode. Triggers calling
434 // the listener installed by SetFrameRemoveListener.
435 void FrameRemoved(FrameTreeNode* frame);
436
Carlos Caballero03262522021-02-05 14:49:58437 void DidStartLoadingNode(FrameTreeNode& node,
Nate Chapin9aabf5f2021-11-12 00:31:19438 bool should_show_loading_ui,
Carlos Caballero03262522021-02-05 14:49:58439 bool was_previously_loading);
440 void DidStopLoadingNode(FrameTreeNode& node);
Carlos Caballero03262522021-02-05 14:49:58441 void DidCancelLoading();
danakjc492bf82020-09-09 20:02:44442
Sreeja Kamishetty0be3b1b2021-08-12 17:04:15443 // Returns this FrameTree's total load progress. If the `root_` FrameTreeNode
444 // is navigating returns `blink::kInitialLoadProgress`.
445 double GetLoadProgress();
danakjc492bf82020-09-09 20:02:44446
Sreeja Kamishetty15f9944a22022-03-10 10:16:08447 // Returns true if at least one of the nodes in this frame tree or nodes in
448 // any inner frame tree of the same WebContents is loading.
Yu Gaoc8c18552022-06-22 14:38:45449 bool IsLoadingIncludingInnerFrameTrees() const;
danakjc492bf82020-09-09 20:02:44450
451 // Set page-level focus in all SiteInstances involved in rendering
452 // this FrameTree, not including the current main frame's
453 // SiteInstance. The focus update will be sent via the main frame's proxies
454 // in those SiteInstances.
455 void ReplicatePageFocus(bool is_focused);
456
457 // Updates page-level focus for this FrameTree in the subframe renderer
Sharon Yangefe52632022-03-08 23:06:06458 // identified by |group|.
459 void SetPageFocus(SiteInstanceGroup* group, bool is_focused);
danakjc492bf82020-09-09 20:02:44460
W. James MacLeanc07dc41b2022-07-25 18:52:16461 // Walks the current frame tree and registers any origins matching
462 // `previously_visited_origin`, either the last committed origin of a
463 // RenderFrameHost or the origin associated with a NavigationRequest that has
464 // been assigned to a SiteInstance, as having the default origin isolation
465 // state. This is only necessary when `previously_visited_origin` is seen with
466 // an OriginAgentCluster header explicitly requesting something other than the
467 // default.
468 void RegisterExistingOriginAsHavingDefaultIsolation(
danakjc492bf82020-09-09 20:02:44469 const url::Origin& previously_visited_origin,
470 NavigationRequest* navigation_request_to_exclude);
471
Carlos Caballero40b0efd2021-01-26 11:55:00472 NavigationControllerImpl& controller() { return navigator_.controller(); }
danakjc492bf82020-09-09 20:02:44473 Navigator& navigator() { return navigator_; }
474
Carlos Caballeroede6f8c2021-01-28 11:01:50475 // Another page accessed the initial empty main document, which means it
476 // is no longer safe to display a pending URL without risking a URL spoof.
477 void DidAccessInitialMainDocument();
478
479 bool has_accessed_initial_main_document() const {
480 return has_accessed_initial_main_document_;
481 }
482
483 void ResetHasAccessedInitialMainDocument() {
484 has_accessed_initial_main_document_ = false;
485 }
486
Carlos Caballero6ff6ace2021-02-05 16:53:00487 bool IsHidden() const { return delegate_->IsHidden(); }
488
Sreeja Kamishettyd64b993d2022-02-14 12:04:42489 // LoadingTree returns the following for different frame trees to direct
490 // loading related events. Please see FrameTree::Delegate::LoadingTree for
491 // more comments.
492 // - For prerender frame tree -> returns the frame tree itself.
493 // - For fenced frame and primary frame tree (including portal) -> returns
494 // the delegate's primary frame tree.
495 FrameTree* LoadingTree();
496
Carlos Caballero03262522021-02-05 14:49:58497 // Stops all ongoing navigations in each of the nodes of this FrameTree.
498 void StopLoading();
499
Carlos Caballero101ac26b2021-03-24 11:54:05500 // Prepares this frame tree for destruction, cleaning up the internal state
501 // and firing the appropriate events like FrameDeleted.
502 // Must be called before FrameTree is destroyed.
503 void Shutdown();
504
Takashi Toyoshimaea534ef22021-07-21 03:27:59505 bool IsBeingDestroyed() const { return is_being_destroyed_; }
506
Dave Tapuskad8b0530f2021-10-19 15:12:31507 base::SafeRef<FrameTree> GetSafeRef();
508
Dave Tapuska54c76a032021-10-27 22:10:42509 // Walks up the FrameTree chain and focuses the FrameTreeNode where
510 // each inner FrameTree is attached.
511 void FocusOuterFrameTrees();
512
David Bokanc3fb5fa2022-07-04 14:55:31513 absl::optional<blink::features::FencedFramesImplementationType>
514 FencedFramesImplementationType() const {
515 return fenced_frames_impl_;
516 }
517
518 bool IsFencedFramesMPArchBased() const {
519 return fenced_frames_impl_.has_value() &&
520 fenced_frames_impl_.value() ==
521 blink::features::FencedFramesImplementationType::kMPArch;
522 }
523 bool IsFencedFramesShadowDOMBased() const {
524 return fenced_frames_impl_.has_value() &&
525 fenced_frames_impl_.value() ==
526 blink::features::FencedFramesImplementationType::kShadowDOM;
527 }
528
danakjc492bf82020-09-09 20:02:44529 private:
530 friend class FrameTreeTest;
531 FRIEND_TEST_ALL_PREFIXES(RenderFrameHostImplBrowserTest, RemoveFocusedFrame);
Sreeja Kamishettyd64b993d2022-02-14 12:04:42532 FRIEND_TEST_ALL_PREFIXES(PortalBrowserTest, NodesForIsLoading);
Xiaochen Zhou6443f752022-08-10 16:40:46533 FRIEND_TEST_ALL_PREFIXES(FencedFrameMPArchBrowserTest, NodesForIsLoading);
Sharon Yang2f3304a2022-05-13 02:24:25534 FRIEND_TEST_ALL_PREFIXES(RenderFrameHostManagerTest,
535 CreateRenderViewAfterProcessKillAndClosedProxy);
danakjc492bf82020-09-09 20:02:44536
537 // Returns a range to iterate over all FrameTreeNodes in the frame tree in
538 // breadth-first traversal order, skipping the subtree rooted at
539 // |node|, but including |node| itself.
540 NodeRange NodesExceptSubtree(FrameTreeNode* node);
541
Sreeja Kamishettyd64b993d2022-02-14 12:04:42542 // Returns all FrameTreeNodes in this frame tree, as well as any
543 // FrameTreeNodes of inner frame trees. Note that this doesn't include inner
544 // frame trees of inner delegates. This is used to find the aggregate
545 // IsLoading value for a frame tree.
546 //
547 // TODO(crbug.com/1261928, crbug.com/1261928): Remove this method and directly
548 // rely on GetOutermostMainFrame() and NodesIncludingInnerTreeNodes() once
549 // portals and guest views are migrated to MPArch.
550 std::vector<FrameTreeNode*> CollectNodesForIsLoading();
551
Keishi Hattori0e45c022021-11-27 09:25:52552 const raw_ptr<Delegate> delegate_;
Carlos Caballero03262522021-02-05 14:49:58553
danakjc492bf82020-09-09 20:02:44554 // These delegates are installed into all the RenderViewHosts and
555 // RenderFrameHosts that we create.
Keishi Hattori0e45c022021-11-27 09:25:52556 raw_ptr<RenderFrameHostDelegate> render_frame_delegate_;
557 raw_ptr<RenderViewHostDelegate> render_view_delegate_;
558 raw_ptr<RenderWidgetHostDelegate> render_widget_delegate_;
559 raw_ptr<RenderFrameHostManager::Delegate> manager_delegate_;
560 raw_ptr<PageDelegate> page_delegate_;
danakjc492bf82020-09-09 20:02:44561
562 // The Navigator object responsible for managing navigations on this frame
Carlos Caballero40b0efd2021-01-26 11:55:00563 // tree. Each FrameTreeNode will default to using it for navigation tasks in
564 // the frame.
danakjc492bf82020-09-09 20:02:44565 Navigator navigator_;
566
Aaron Colwell78b4bde2021-03-16 16:16:09567 // Map of RenderViewHostMapId to RenderViewHost. This allows us to look up the
danakjc492bf82020-09-09 20:02:44568 // RenderViewHost for a given SiteInstance when creating RenderFrameHosts.
569 // Each RenderViewHost maintains a refcount and is deleted when there are no
570 // more RenderFrameHosts or RenderFrameProxyHosts using it.
Aaron Colwell78b4bde2021-03-16 16:16:09571 RenderViewHostMap render_view_host_map_;
danakjc492bf82020-09-09 20:02:44572
Harkiran Bolaria16f2c48d2022-04-22 12:39:57573 // Indicates type of frame tree.
574 const Type type_;
575
danakjc492bf82020-09-09 20:02:44576 // This is an owned ptr to the root FrameTreeNode, which never changes over
577 // the lifetime of the FrameTree. It is not a scoped_ptr because we need the
578 // pointer to remain valid even while the FrameTreeNode is being destroyed,
579 // since it's common for a node to test whether it's the root node.
Kalvin Lee75d70302022-07-20 19:22:03580 //
581 // TODO(crbug.com/1298696): content_browsertests breaks with MTECheckedPtr
582 // enabled. Triage.
583 raw_ptr<FrameTreeNode, DanglingUntriagedDegradeToNoOpWhenMTE> root_;
danakjc492bf82020-09-09 20:02:44584
585 int focused_frame_tree_node_id_;
586
danakjc492bf82020-09-09 20:02:44587 // Overall load progress.
588 double load_progress_;
589
David Bokanc3fb5fa2022-07-04 14:55:31590 absl::optional<blink::features::FencedFramesImplementationType>
591 fenced_frames_impl_;
592
Carlos Caballeroede6f8c2021-01-28 11:01:50593 // Whether the initial empty page has been accessed by another page, making it
594 // unsafe to show the pending URL. Usually false unless another window tries
595 // to modify the blank page. Always false after the first commit.
596 bool has_accessed_initial_main_document_ = false;
597
Takashi Toyoshimaea534ef22021-07-21 03:27:59598 bool is_being_destroyed_ = false;
599
Carlos Caballero101ac26b2021-03-24 11:54:05600#if DCHECK_IS_ON()
601 // Whether Shutdown() was called.
602 bool was_shut_down_ = false;
603#endif
Dave Tapuskad8b0530f2021-10-19 15:12:31604
605 base::WeakPtrFactory<FrameTree> weak_ptr_factory_{this};
danakjc492bf82020-09-09 20:02:44606};
607
608} // namespace content
609
610#endif // CONTENT_BROWSER_RENDERER_HOST_FRAME_TREE_H_