content/browser/frame_host/frame_tree.cc

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "content/browser/frame_host/frame_tree.h"
   6
   7 #include <queue>
   8
   9 #include "base/bind.h"
  10 #include "base/callback.h"
  11 #include "base/command_line.h"
  12 #include "base/containers/hash_tables.h"
  13 #include "base/lazy_instance.h"
  14 #include "content/browser/frame_host/frame_tree_node.h"
  15 #include "content/browser/frame_host/navigator.h"
  16 #include "content/browser/frame_host/render_frame_host_factory.h"
  17 #include "content/browser/frame_host/render_frame_host_impl.h"
  18 #include "content/browser/frame_host/render_frame_proxy_host.h"
  19 #include "content/browser/renderer_host/render_view_host_factory.h"
  20 #include "content/browser/renderer_host/render_view_host_impl.h"
  21 #include "content/public/common/content_switches.h"
  22 #include "third_party/WebKit/public/web/WebSandboxFlags.h"
  23
  24 namespace content {
  25
  26 namespace {
  27
  28 // Used with FrameTree::ForEach() to search for the FrameTreeNode
  29 // corresponding to |frame_tree_node_id| within a specific FrameTree.
  30 bool FrameTreeNodeForId(int frame_tree_node_id,
  31                         FrameTreeNode** out_node,
  32                         FrameTreeNode* node) {
  33   if (node->frame_tree_node_id() == frame_tree_node_id) {
  34     *out_node = node;
  35     // Terminate iteration once the node has been found.
  36     return false;
  37   }
  38   return true;
  39 }
  40
  41 // Used with FrameTree::ForEach() to search for the FrameTreeNode with the given
  42 // |name| within a specific FrameTree.
  43 bool FrameTreeNodeForName(const std::string& name,
  44                           FrameTreeNode** out_node,
  45                           FrameTreeNode* node) {
  46   if (node->frame_name() == name) {
  47     *out_node = node;
  48     // Terminate iteration once the node has been found.
  49     return false;
  50   }
  51   return true;
  52 }
  53
  54 bool CreateProxyForSiteInstance(const scoped_refptr<SiteInstance>& instance,
  55                                 FrameTreeNode* node) {
  56   // If a new frame is created in the current SiteInstance, other frames in
  57   // that SiteInstance don't need a proxy for the new frame.
  58   SiteInstance* current_instance =
  59       node->render_manager()->current_frame_host()->GetSiteInstance();
  60   if (current_instance != instance.get())
  61     node->render_manager()->CreateRenderFrameProxy(instance.get());
  62   return true;
  63 }
  64
  65 // Helper function used with FrameTree::ForEach() for retrieving the total
  66 // loading progress and number of frames in a frame tree.
  67 bool CollectLoadProgress(double* progress,
  68                          int* frame_count,
  69                          FrameTreeNode* node) {
  70   // Ignore the current frame if it has not started loading.
  71   if (!node->has_started_loading())
  72     return true;
  73
  74   // Collect progress.
  75   *progress += node->loading_progress();
  76   (*frame_count)++;
  77   return true;
  78 }
  79
  80 // Helper function used with FrameTree::ForEach() to reset the load progress.
  81 bool ResetNodeLoadProgress(FrameTreeNode* node) {
  82   node->reset_loading_progress();
  83   return true;
  84 }
  85
  86 // Helper function used with FrameTree::ForEach() to check if at least one of
  87 // the nodes is loading.
  88 bool IsNodeLoading(bool* is_loading, FrameTreeNode* node) {
  89   if (node->IsLoading()) {
  90     // There is at least one node loading, so abort traversal.
  91     *is_loading = true;
  92     return false;
  93   }
  94   return true;
  95 }
  96
  97 }  // namespace
  98
  99 FrameTree::FrameTree(Navigator* navigator,
 100                      RenderFrameHostDelegate* render_frame_delegate,
 101                      RenderViewHostDelegate* render_view_delegate,
 102                      RenderWidgetHostDelegate* render_widget_delegate,
 103                      RenderFrameHostManager::Delegate* manager_delegate)
 104     : render_frame_delegate_(render_frame_delegate),
 105       render_view_delegate_(render_view_delegate),
 106       render_widget_delegate_(render_widget_delegate),
 107       manager_delegate_(manager_delegate),
 108       root_(new FrameTreeNode(this,
 109                               navigator,
 110                               render_frame_delegate,
 111                               render_view_delegate,
 112                               render_widget_delegate,
 113                               manager_delegate,
 114                               // The top-level frame must always be in a
 115                               // document scope.
 116                               blink::WebTreeScopeType::Document,
 117                               std::string(),
 118                               blink::WebSandboxFlags::None)),
 119       focused_frame_tree_node_id_(-1),
 120       load_progress_(0.0) {
 121 }
 122
 123 FrameTree::~FrameTree() {
 124 }
 125
 126 FrameTreeNode* FrameTree::FindByID(int frame_tree_node_id) {
 127   FrameTreeNode* node = nullptr;
 128   ForEach(base::Bind(&FrameTreeNodeForId, frame_tree_node_id, &node));
 129   return node;
 130 }
 131
 132 FrameTreeNode* FrameTree::FindByRoutingID(int process_id, int routing_id) {
 133   RenderFrameHostImpl* render_frame_host =
 134       RenderFrameHostImpl::FromID(process_id, routing_id);
 135   if (render_frame_host) {
 136     FrameTreeNode* result = render_frame_host->frame_tree_node();
 137     if (this == result->frame_tree())
 138       return result;
 139   }
 140
 141   RenderFrameProxyHost* render_frame_proxy_host =
 142       RenderFrameProxyHost::FromID(process_id, routing_id);
 143   if (render_frame_proxy_host) {
 144     FrameTreeNode* result = render_frame_proxy_host->frame_tree_node();
 145     if (this == result->frame_tree())
 146       return result;
 147   }
 148
 149   return nullptr;
 150 }
 151
 152 FrameTreeNode* FrameTree::FindByName(const std::string& name) {
 153   if (name.empty())
 154     return root_.get();
 155
 156   FrameTreeNode* node = nullptr;
 157   ForEach(base::Bind(&FrameTreeNodeForName, name, &node));
 158   return node;
 159 }
 160
 161 void FrameTree::ForEach(
 162     const base::Callback<bool(FrameTreeNode*)>& on_node) const {
 163   ForEach(on_node, nullptr);
 164 }
 165
 166 void FrameTree::ForEach(
 167     const base::Callback<bool(FrameTreeNode*)>& on_node,
 168     FrameTreeNode* skip_this_subtree) const {
 169   std::queue<FrameTreeNode*> queue;
 170   queue.push(root_.get());
 171
 172   while (!queue.empty()) {
 173     FrameTreeNode* node = queue.front();
 174     queue.pop();
 175     if (skip_this_subtree == node)
 176       continue;
 177
 178     if (!on_node.Run(node))
 179       break;
 180
 181     for (size_t i = 0; i < node->child_count(); ++i)
 182       queue.push(node->child_at(i));
 183   }
 184 }
 185
 186 RenderFrameHostImpl* FrameTree::AddFrame(FrameTreeNode* parent,
 187                                          int process_id,
 188                                          int new_routing_id,
 189                                          blink::WebTreeScopeType scope,
 190                                          const std::string& frame_name,
 191                                          blink::WebSandboxFlags sandbox_flags) {
 192   // A child frame always starts with an initial empty document, which means
 193   // it is in the same SiteInstance as the parent frame. Ensure that the process
 194   // which requested a child frame to be added is the same as the process of the
 195   // parent node.
 196   // We return nullptr if this is not the case, which can happen in a race if an
 197   // old RFH sends a CreateChildFrame message as we're swapping to a new RFH.
 198   if (parent->current_frame_host()->GetProcess()->GetID() != process_id)
 199     return nullptr;
 200
 201   scoped_ptr<FrameTreeNode> node(
 202       new FrameTreeNode(this, parent->navigator(), render_frame_delegate_,
 203                         render_view_delegate_, render_widget_delegate_,
 204                         manager_delegate_, scope, frame_name, sandbox_flags));
 205   FrameTreeNode* node_ptr = node.get();
 206   // AddChild is what creates the RenderFrameHost.
 207   parent->AddChild(node.Pass(), process_id, new_routing_id);
 208   return node_ptr->current_frame_host();
 209 }
 210
 211 void FrameTree::RemoveFrame(FrameTreeNode* child) {
 212   FrameTreeNode* parent = child->parent();
 213   if (!parent) {
 214     NOTREACHED() << "Unexpected RemoveFrame call for main frame.";
 215     return;
 216   }
 217
 218   parent->RemoveChild(child);
 219 }
 220
 221 void FrameTree::CreateProxiesForSiteInstance(
 222     FrameTreeNode* source,
 223     SiteInstance* site_instance) {
 224   // Create the swapped out RVH for the new SiteInstance. This will create
 225   // a top-level swapped out RFH as well, which will then be wrapped by a
 226   // RenderFrameProxyHost.
 227   if (!source || !source->IsMainFrame()) {
 228     RenderViewHostImpl* render_view_host = GetRenderViewHost(site_instance);
 229     if (!render_view_host) {
 230       if (RenderFrameHostManager::IsSwappedOutStateForbidden()) {
 231         root()->render_manager()->CreateRenderFrameProxy(site_instance);
 232       } else {
 233         root()->render_manager()->CreateRenderFrame(
 234             site_instance, nullptr, CREATE_RF_SWAPPED_OUT | CREATE_RF_HIDDEN,
 235             nullptr);
 236       }
 237     } else {
 238       root()->render_manager()->EnsureRenderViewInitialized(render_view_host,
 239                                                             site_instance);
 240     }
 241   }
 242
 243   scoped_refptr<SiteInstance> instance(site_instance);
 244
 245   // Proxies are created in the FrameTree in response to a node navigating to a
 246   // new SiteInstance. Since |source|'s navigation will replace the currently
 247   // loaded document, the entire subtree under |source| will be removed.
 248   ForEach(base::Bind(&CreateProxyForSiteInstance, instance), source);
 249 }
 250
 251 RenderFrameHostImpl* FrameTree::GetMainFrame() const {
 252   return root_->current_frame_host();
 253 }
 254
 255 FrameTreeNode* FrameTree::GetFocusedFrame() {
 256   return FindByID(focused_frame_tree_node_id_);
 257 }
 258
 259 void FrameTree::SetFocusedFrame(FrameTreeNode* node) {
 260   focused_frame_tree_node_id_ = node->frame_tree_node_id();
 261 }
 262
 263 void FrameTree::SetFrameRemoveListener(
 264     const base::Callback<void(RenderFrameHost*)>& on_frame_removed) {
 265   on_frame_removed_ = on_frame_removed;
 266 }
 267
 268 RenderViewHostImpl* FrameTree::CreateRenderViewHost(SiteInstance* site_instance,
 269                                                     int routing_id,
 270                                                     int main_frame_routing_id,
 271                                                     bool swapped_out,
 272                                                     bool hidden) {
 273   RenderViewHostMap::iterator iter =
 274       render_view_host_map_.find(site_instance->GetId());
 275   if (iter != render_view_host_map_.end()) {
 276     // If a RenderViewHost's main frame is pending deletion for this
 277     // |site_instance|, put it in the map of RenderViewHosts pending shutdown.
 278     // Otherwise return the existing RenderViewHost for the SiteInstance.
 279     RenderFrameHostImpl* main_frame = static_cast<RenderFrameHostImpl*>(
 280         iter->second->GetMainFrame());
 281     if (main_frame &&
 282         main_frame->frame_tree_node()->render_manager()->IsPendingDeletion(
 283             main_frame)) {
 284       render_view_host_pending_shutdown_map_.insert(
 285           std::pair<int, RenderViewHostImpl*>(site_instance->GetId(),
 286                                               iter->second));
 287       render_view_host_map_.erase(iter);
 288     } else {
 289       return iter->second;
 290     }
 291   }
 292   RenderViewHostImpl* rvh = static_cast<RenderViewHostImpl*>(
 293       RenderViewHostFactory::Create(site_instance,
 294                                     render_view_delegate_,
 295                                     render_widget_delegate_,
 296                                     routing_id,
 297                                     main_frame_routing_id,
 298                                     swapped_out,
 299                                     hidden));
 300
 301   render_view_host_map_[site_instance->GetId()] = rvh;
 302   return rvh;
 303 }
 304
 305 RenderViewHostImpl* FrameTree::GetRenderViewHost(SiteInstance* site_instance) {
 306   RenderViewHostMap::iterator iter =
 307       render_view_host_map_.find(site_instance->GetId());
 308   if (iter == render_view_host_map_.end())
 309     return nullptr;
 310   return iter->second;
 311 }
 312
 313 void FrameTree::AddRenderViewHostRef(RenderViewHostImpl* render_view_host) {
 314   SiteInstance* site_instance = render_view_host->GetSiteInstance();
 315   RenderViewHostMap::iterator iter =
 316       render_view_host_map_.find(site_instance->GetId());
 317   CHECK(iter != render_view_host_map_.end());
 318   CHECK(iter->second == render_view_host);
 319
 320   iter->second->increment_ref_count();
 321 }
 322
 323 void FrameTree::ReleaseRenderViewHostRef(RenderViewHostImpl* render_view_host) {
 324   SiteInstance* site_instance = render_view_host->GetSiteInstance();
 325   int32 site_instance_id = site_instance->GetId();
 326   RenderViewHostMap::iterator iter =
 327       render_view_host_map_.find(site_instance_id);
 328   if (iter != render_view_host_map_.end() && iter->second == render_view_host) {
 329     // Decrement the refcount and shutdown the RenderViewHost if no one else is
 330     // using it.
 331     CHECK_GT(iter->second->ref_count(), 0);
 332     iter->second->decrement_ref_count();
 333     if (iter->second->ref_count() == 0) {
 334       iter->second->Shutdown();
 335       render_view_host_map_.erase(iter);
 336     }
 337   } else {
 338     // The RenderViewHost should be in the list of RenderViewHosts pending
 339     // shutdown.
 340     bool render_view_host_found = false;
 341     std::pair<RenderViewHostMultiMap::iterator,
 342               RenderViewHostMultiMap::iterator> result =
 343         render_view_host_pending_shutdown_map_.equal_range(site_instance_id);
 344     for (RenderViewHostMultiMap::iterator multi_iter = result.first;
 345          multi_iter != result.second;
 346          ++multi_iter) {
 347       if (multi_iter->second != render_view_host)
 348         continue;
 349       render_view_host_found = true;
 350       // Decrement the refcount and shutdown the RenderViewHost if no one else
 351       // is using it.
 352       CHECK_GT(render_view_host->ref_count(), 0);
 353       render_view_host->decrement_ref_count();
 354       if (render_view_host->ref_count() == 0) {
 355         render_view_host->Shutdown();
 356         render_view_host_pending_shutdown_map_.erase(multi_iter);
 357       }
 358       break;
 359     }
 360     CHECK(render_view_host_found);
 361   }
 362 }
 363
 364 void FrameTree::FrameRemoved(FrameTreeNode* frame) {
 365   if (frame->frame_tree_node_id() == focused_frame_tree_node_id_)
 366     focused_frame_tree_node_id_ = -1;
 367
 368   // No notification for the root frame.
 369   if (!frame->parent()) {
 370     CHECK_EQ(frame, root_.get());
 371     return;
 372   }
 373
 374   // Notify observers of the frame removal.
 375   if (!on_frame_removed_.is_null())
 376     on_frame_removed_.Run(frame->current_frame_host());
 377 }
 378
 379 void FrameTree::UpdateLoadProgress() {
 380   double progress = 0.0;
 381   int frame_count = 0;
 382
 383   ForEach(base::Bind(&CollectLoadProgress, &progress, &frame_count));
 384   if (frame_count != 0)
 385     progress /= frame_count;
 386
 387   if (progress <= load_progress_)
 388     return;
 389   load_progress_ = progress;
 390
 391   // Notify the WebContents.
 392   root_->navigator()->GetDelegate()->DidChangeLoadProgress();
 393 }
 394
 395 void FrameTree::ResetLoadProgress() {
 396   ForEach(base::Bind(&ResetNodeLoadProgress));
 397   load_progress_ = 0.0;
 398 }
 399
 400 bool FrameTree::IsLoading() {
 401   bool is_loading = false;
 402   ForEach(base::Bind(&IsNodeLoading, &is_loading));
 403   return is_loading;
 404 }
 405
 406 }  // namespace content