Keep NaCl plugins used in app background pages alive when active.

content/browser/renderer_host/pepper/browser_ppapi_host_impl.cc

 // Copyright (c) 2012 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.
 
 #include "content/browser/renderer_host/pepper/browser_ppapi_host_impl.h"
 
 #include "content/browser/renderer_host/pepper/pepper_message_filter.h"
 #include "content/browser/tracing/trace_message_filter.h"
 #include "content/common/pepper_renderer_instance_data.h"
-#include "content/public/browser/render_view_host.h"
 #include "content/public/common/process_type.h"
 #include "ipc/ipc_message_macros.h"
+#include "ppapi/proxy/ppapi_messages.h"
 
 namespace content {
 
 // static
 BrowserPpapiHost* BrowserPpapiHost::CreateExternalPluginProcess(
     IPC::Sender* sender,
     ppapi::PpapiPermissions permissions,
     base::ProcessHandle plugin_child_process,
     IPC::ChannelProxy* channel,
     int render_process_id,
@@ skipping 25 matching lines @@
     bool in_process,
     bool external_plugin)
     : ppapi_host_(new ppapi::host::PpapiHost(sender, permissions)),
       plugin_process_handle_(base::kNullProcessHandle),
       plugin_name_(plugin_name),
       plugin_path_(plugin_path),
       profile_data_directory_(profile_data_directory),
       in_process_(in_process),
       external_plugin_(external_plugin),
       ssl_context_helper_(new SSLContextHelper()) {
-  message_filter_ = new HostMessageFilter(ppapi_host_.get());
+  message_filter_ = new HostMessageFilter(ppapi_host_.get(), this);
   ppapi_host_->AddHostFactoryFilter(scoped_ptr<ppapi::host::HostFactory>(
       new ContentBrowserPepperHostFactory(this)));
 }
 
 BrowserPpapiHostImpl::~BrowserPpapiHostImpl() {
   // Notify the filter so it won't foward messages to us.
   message_filter_->OnHostDestroyed();
 
   // Delete the host explicitly first. This shutdown will destroy the
   // resources, which may want to do cleanup in their destructors and expect
@@ skipping 50 matching lines @@
   return found->second.document_url;
 }
 
 GURL BrowserPpapiHostImpl::GetPluginURLForInstance(PP_Instance instance) {
   InstanceMap::const_iterator found = instance_map_.find(instance);
   if (found == instance_map_.end())
     return GURL();
   return found->second.plugin_url;
 }
 
+void BrowserPpapiHostImpl::SetOnKeepaliveCallback(
+      const BrowserPpapiHost::OnKeepaliveCallback& callback) {
+  on_keepalive_callback_ = callback;
+}
+
 void BrowserPpapiHostImpl::AddInstance(
     PP_Instance instance,
     const PepperRendererInstanceData& instance_data) {
   DCHECK(instance_map_.find(instance) == instance_map_.end());
   instance_map_[instance] = instance_data;
 }
 
 void BrowserPpapiHostImpl::DeleteInstance(PP_Instance instance) {
   InstanceMap::iterator found = instance_map_.find(instance);
   if (found == instance_map_.end()) {
     NOTREACHED();
     return;
   }
   instance_map_.erase(found);
 }
 
+void BrowserPpapiHostImpl::OnKeepalive() {

[yzshen1, 2013/12/13 21:23:15]

I notice you used Keep*a*live in quite some places. I thought they are two words
so we should do Keep*A*live, but maybe you have good reasons?

[scheib, 2013/12/14 00:07:41]

I've moved everything to "keepalive".

Both are used commonly. E.g. a google search for "keep alive" returns a top
result of "Keepalive" and a second result frequently using "Keep-Alive". The
Chromium code base is also split, though I see more "keepalive".

Because this plumbs eventually to
extensions::ProcessManager::IncrementLazyKeepaliveCount I decided to be
consistent with that and use keepalive as one word.

[yzshen1, 2013/12/14 00:36:33]

Sounds good. Thanks!
On 2013/12/14 00:07:41, scheib wrote:

+  // An instance has been active. The on_keepalive_callback_ will be
+  // used to permit the content embedder to handle this, e.g. by shutting down

[yzshen1, 2013/12/13 21:23:15]

It seems we need to update the comment, now that it is called OnKeepalive(),
"shutting down" seems confusing.

[scheib, 2013/12/14 00:07:41]

Done.

+  // processes that have gone idle.
+  //
+  // Currently embedders do not need to distinguish between instances having
+  // different idle state, and thus this implementation handles all instances
+  // for this module together.
+
+  if (on_keepalive_callback_.is_null())
+    return;
+
+  BrowserPpapiHost::OnKeepaliveInstanceData
+      instance_data(instance_map_.size());
+
+  InstanceMap::iterator instance = instance_map_.begin();
+  int i = 0;
+  while (instance != instance_map_.end()) {
+    instance_data[i].render_process_id = instance->second.render_process_id;
+    instance_data[i].render_view_id = instance->second.render_view_id;
+    instance_data[i].document_url = instance->second.document_url;
+    ++instance;
+    ++i;
+  }
+  on_keepalive_callback_.Run(instance_data, profile_data_directory_);
+}
+
+BrowserPpapiHostImpl::HostMessageFilter::HostMessageFilter(
+    ppapi::host::PpapiHost* ppapi_host,
+    BrowserPpapiHostImpl* browser_ppapi_host_impl)
+        : ppapi_host_(ppapi_host),
+          browser_ppapi_host_impl_(browser_ppapi_host_impl)
+{}

[yzshen1, 2013/12/13 21:23:15]

{ should be on the previous line.

[scheib, 2013/12/14 00:07:41]

Done.

+
 bool BrowserPpapiHostImpl::HostMessageFilter::OnMessageReceived(
     const IPC::Message& msg) {
   // Don't forward messages if our owner object has been destroyed.
   if (!ppapi_host_)
     return false;
 
-  /* TODO(brettw) when we add messages, here, the code should look like this:
   bool handled = true;
-  IPC_BEGIN_MESSAGE_MAP(BrowserPpapiHostImpl, msg)
+  IPC_BEGIN_MESSAGE_MAP(BrowserPpapiHostImpl::HostMessageFilter, msg)
     // Add necessary message handlers here.
+    IPC_MESSAGE_HANDLER(PpapiHostMsg_Keepalive, OnKeepalive)
     IPC_MESSAGE_UNHANDLED(handled = ppapi_host_->OnMessageReceived(msg))
   IPC_END_MESSAGE_MAP();
   return handled;
-  */
-  return ppapi_host_->OnMessageReceived(msg);
 }
 
 void BrowserPpapiHostImpl::HostMessageFilter::OnHostDestroyed() {
   DCHECK(ppapi_host_);
   ppapi_host_ = NULL;
+  browser_ppapi_host_impl_ = NULL;
+}
+
+BrowserPpapiHostImpl::HostMessageFilter::~HostMessageFilter()
+{}

[yzshen1, 2013/12/13 21:23:15]

ditto.

[scheib, 2013/12/14 00:07:41]

Done.

+
+void BrowserPpapiHostImpl::HostMessageFilter::OnKeepalive() {
+  if (browser_ppapi_host_impl_)
+    browser_ppapi_host_impl_->OnKeepalive();
 }
 
 }  // namespace content