Plugin Power Saver: Implement size-based heuristic for peripheral content.

content/renderer/pepper/pepper_plugin_instance_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/renderer/pepper/pepper_plugin_instance_impl.h"
 
 #include "base/bind.h"
 #include "base/callback_helpers.h"
 #include "base/command_line.h"
 #include "base/debug/trace_event.h"
 #include "base/logging.h"
 #include "base/memory/linked_ptr.h"
 #include "base/message_loop/message_loop.h"
 #include "base/stl_util.h"
 #include "base/strings/stringprintf.h"
 #include "base/strings/utf_offset_string_conversions.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/time/time.h"
 #include "cc/base/latency_info_swap_promise.h"
 #include "cc/blink/web_layer_impl.h"
 #include "cc/layers/texture_layer.h"
 #include "cc/trees/layer_tree_host.h"
 #include "content/common/content_constants_internal.h"
+#include "content/common/frame_messages.h"
 #include "content/common/input/web_input_event_traits.h"
 #include "content/public/common/content_constants.h"
 #include "content/public/common/content_switches.h"
 #include "content/public/common/page_zoom.h"
 #include "content/public/renderer/content_renderer_client.h"
 #include "content/renderer/gpu/render_widget_compositor.h"
 #include "content/renderer/pepper/content_decryptor_delegate.h"
 #include "content/renderer/pepper/event_conversion.h"
 #include "content/renderer/pepper/fullscreen_container.h"
 #include "content/renderer/pepper/gfx_conversion.h"
@@ skipping 184 matching lines @@
 #define COMPILE_ASSERT_PRINT_SCALING_MATCHING_ENUM(webkit_name, pp_name)     \
   COMPILE_ASSERT(static_cast<int>(webkit_name) == static_cast<int>(pp_name), \
                  mismatching_enums)
 
 // <embed>/<object> attributes.
 const char kWidth[] = "width";
 const char kHeight[] = "height";
 const char kBorder[] = "border";  // According to w3c, deprecated.
 const char kStyle[] = "style";
 
+// Maximum dimensions plug-in content may have while still being considered

[Lei Zhang, 2014/10/28 02:16:23]

Mention these match Safari's sizes.

[tommycli, 2014/10/28 22:18:07]

Done.

+// peripheral content.
+const int kPeripheralContentMaxWidth = 400;
+const int kPeripheralContentMaxHeight = 300;
+
 COMPILE_ASSERT_MATCHING_ENUM(TypePointer, PP_MOUSECURSOR_TYPE_POINTER);
 COMPILE_ASSERT_MATCHING_ENUM(TypeCross, PP_MOUSECURSOR_TYPE_CROSS);
 COMPILE_ASSERT_MATCHING_ENUM(TypeHand, PP_MOUSECURSOR_TYPE_HAND);
 COMPILE_ASSERT_MATCHING_ENUM(TypeIBeam, PP_MOUSECURSOR_TYPE_IBEAM);
 COMPILE_ASSERT_MATCHING_ENUM(TypeWait, PP_MOUSECURSOR_TYPE_WAIT);
 COMPILE_ASSERT_MATCHING_ENUM(TypeHelp, PP_MOUSECURSOR_TYPE_HELP);
 COMPILE_ASSERT_MATCHING_ENUM(TypeEastResize, PP_MOUSECURSOR_TYPE_EASTRESIZE);
 COMPILE_ASSERT_MATCHING_ENUM(TypeNorthResize, PP_MOUSECURSOR_TYPE_NORTHRESIZE);
 COMPILE_ASSERT_MATCHING_ENUM(TypeNorthEastResize,
                              PP_MOUSECURSOR_TYPE_NORTHEASTRESIZE);
@@ skipping 1807 matching lines @@
     scoped_ptr<cc::SingleReleaseCallback>* release_callback,
     bool use_shared_memory) {
   if (!bound_graphics_2d_platform_)
     return false;
   return bound_graphics_2d_platform_->PrepareTextureMailbox(mailbox,
                                                             release_callback);
 }
 
 void PepperPluginInstanceImpl::OnDestruct() { render_frame_ = NULL; }
 
+bool PepperPluginInstanceImpl::OnMessageReceived(const IPC::Message& message) {
+  // We set "handled" to false here, because we want this broadcast message to

[Lei Zhang, 2014/10/28 02:16:23]

Do you want to coordinate this at the PluginModule level instead? It can
consolidate the results from all the PepperPluginInstances and send one bulk
IPC.

[tommycli, 2014/10/28 22:18:07]

Done. I made a PluginPowerSaverHelper class to consolidate.

+  // be processed by every PepperPluginInstanceImpl, and not swallowed.
+  bool handled = false;

[tommycli, 2014/10/27 23:35:53]

I set (handled = false) to make sure every instance of this class processes this
message. This seems a bit hacky...

Alternatively, I could create a 'hub' class to receive and then forward the
message to all these instances, but it would be more SLOC.

[groby-ooo-7-16, 2014/10/28 00:39:12]

You don't need this - as is, the code will _always_ return false, so you can
skip handled completely.

+  IPC_BEGIN_MESSAGE_MAP(PepperPluginInstanceImpl, message)
+    IPC_MESSAGE_HANDLER(FrameMsg_PluginContentOriginWhitelisted,
+                        OnPluginContentOriginWhitelisted)
+    IPC_MESSAGE_UNHANDLED(handled = false)
+  IPC_END_MESSAGE_MAP()
+  return handled;
+}
+
 void PepperPluginInstanceImpl::AddLatencyInfo(
     const std::vector<ui::LatencyInfo>& latency_info) {
   if (render_frame_ && render_frame_->GetRenderWidget()) {
     RenderWidgetCompositor* compositor =
         render_frame_->GetRenderWidget()->compositor();
     if (compositor) {
       for (size_t i = 0; i < latency_info.size(); i++) {
         scoped_ptr<cc::SwapPromise> swap_promise(
             new cc::LatencyInfoSwapPromise(latency_info[i]));
         compositor->QueueSwapPromise(swap_promise.Pass());
@@ skipping 1223 matching lines @@
   } else {
     // Running out-of-process. Initiate an IPC call to notify the plugin
     // process.
     ppapi::proxy::HostDispatcher* dispatcher =
         ppapi::proxy::HostDispatcher::GetForInstance(pp_instance());
     dispatcher->Send(new PpapiMsg_PPPInstance_HandleDocumentLoad(
         ppapi::API_ID_PPP_INSTANCE, pp_instance(), pending_host_id, data));
   }
 }
 
-bool PepperPluginInstanceImpl::IsPeripheralContent() const {
+bool PepperPluginInstanceImpl::IsPeripheralContent() {
   if (module_->name() != kFlashPluginName)
     return false;
 
-  // Peripheral plugin content is defined to be peripheral when the plugin
-  // content's origin differs from the top level frame's origin. For example:
-  //  - Peripheral:      a.com -> b.com/plugin.swf
-  //  - Peripheral:      a.com -> b.com/iframe.html -> b.com/plugin.swf
-  //  - NOT peripheral:  a.com -> b.com/iframe-to-a.html -> a.com/plugin.swf
+  // Plugin content is defined to be cross-origin when the plugin source's
+  // origin differs from the top level frame's origin. For example:
+  //  - Cross-origin:  a.com -> b.com/plugin.swf
+  //  - Cross-origin:  a.com -> b.com/iframe.html -> b.com/plugin.swf
+  //  - Same-origin:   a.com -> b.com/iframe-to-a.html -> a.com/plugin.swf
 
   // TODO(alexmos): Update this to use the origin of the RemoteFrame when 426512
   // is fixed. For now, case 3 in the comment above doesn't work in
   // --site-per-process mode.
   WebFrame* main_frame = render_frame_->GetWebFrame()->view()->mainFrame();
   if (main_frame->isWebRemoteFrame())
      return true;
 
+  // All same-origin plugin content is essential.
   GURL main_frame_url = main_frame->document().url();

[Lei Zhang, 2014/10/28 02:16:23]

nit: replace |main_frame_url| with |main_frame_origin| ?

[tommycli, 2014/10/28 22:18:07]

Done.

-  return plugin_url_.GetOrigin() != main_frame_url.GetOrigin();
+  GURL plugin_origin = plugin_url_.GetOrigin();
+  if (plugin_origin == main_frame_url.GetOrigin())
+    return false;
+
+  // Cross-origin plugin content is peripheral if smaller than a maximum size.
+  blink::WebRect bounds = container()->element().boundsInViewportSpace();
+  bool content_is_large = bounds.width < kPeripheralContentMaxWidth ||

[Lei Zhang, 2014/10/28 02:16:23]

Shouldn't the variable be named "content_is_small" ? As such, the logic below is
reversed.

[tommycli, 2014/10/28 22:18:07]

Done.

+      bounds.height < kPeripheralContentMaxHeight;
+
+  if (content_is_large) {
+    // Large cross-origin plugin content should temporarily whitelist all
+    // content from that origin for that top level frame. This whitelist is
+    // cleared when this render frame is destroyed.
+    Send(new FrameHostMsg_PluginContentOriginAllowed(

[Lei Zhang, 2014/10/28 02:16:23]

It's weird that an IsFoo() method has side effects.

[tommycli, 2014/10/28 22:18:07]

Done.

+        render_frame()->GetRoutingID(),
+        plugin_origin));
+  } else {
+    Send(new FrameHostMsg_PluginContentMarkedPeripheral(
+        render_frame()->GetRoutingID(),
+        plugin_origin));
+  }
+
+  return content_is_large;
 }
 
 void PepperPluginInstanceImpl::SetPluginThrottled(bool throttled) {
   // Do not throttle if we've already disabled power saver.
   if (!power_saver_enabled_ && throttled)
     return;
 
   plugin_throttled_ = throttled;
   SendDidChangeView();
 }
 
+void PepperPluginInstanceImpl::OnPluginContentOriginWhitelisted(
+    const GURL& content_origin) {
+  if (content_origin == plugin_url_.GetOrigin()) {
+    power_saver_enabled_ = false;
+    SetPluginThrottled(false);

[groby-ooo-7-16, 2014/10/28 00:39:12]

Why not just SetPluginThrottled(false)?

[tommycli, 2014/10/28 22:18:07]

power_saver_enabled_ needs to be set to false, so it knows to ignore throttle
callbacks that are already in the message loop (from simple timer in our case)

+  }
+}
+
 }  // namespace content