Plugin Power Saver: Throttled Plugins should block TCPSocket reads.

content/browser/renderer_host/pepper/browser_ppapi_host_impl.h

 // 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.
 
 #ifndef CONTENT_BROWSER_RENDERER_HOST_PEPPER_BROWSER_PPAPI_HOST_IMPL_H_
 #define CONTENT_BROWSER_RENDERER_HOST_PEPPER_BROWSER_PPAPI_HOST_IMPL_H_
 
 #include <map>
 #include <string>
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
 #include "base/files/file_path.h"
+#include "base/memory/linked_ptr.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/weak_ptr.h"
+#include "base/observer_list.h"
 #include "base/process/process.h"
 #include "content/browser/renderer_host/pepper/content_browser_pepper_host_factory.h"
 #include "content/browser/renderer_host/pepper/ssl_context_helper.h"
 #include "content/common/content_export.h"
 #include "content/common/pepper_renderer_instance_data.h"
 #include "content/public/browser/browser_ppapi_host.h"
 #include "content/public/common/process_type.h"
 #include "ipc/message_filter.h"
 #include "ppapi/host/ppapi_host.h"
 
 #if !defined(ENABLE_PLUGINS)
 #error "Plugins should be enabled"
 #endif
 
 namespace content {
 
 class CONTENT_EXPORT BrowserPpapiHostImpl : public BrowserPpapiHost {
  public:
+  class InstanceObserver {
+   public:
+    virtual void OnThrottleStateChanged(bool is_throttled) = 0;

[dmichael (off chromium), 2015/02/18 18:58:09]

Maybe add a note about what this function means and the fact that it's invoked
on the IO thread?

[tommycli, 2015/02/18 19:19:09]

Done. I assume it's okay that it's invoked on IO thread because the message
filter operates on IO thread also right?

[dmichael (off chromium), 2015/02/18 20:31:40]

Right, I just want to make sure it's documented right so the next person that
sees it knows what's going on.

[tommycli, 2015/02/18 21:31:17]

Done.

+  };
+
   // The creator is responsible for calling set_plugin_process as soon as it is
   // known (we start the process asynchronously so it won't be known when this
    // object is created).
   // |external_plugin| signfies that this is a proxy created for an embedder's
   // plugin, i.e. using BrowserPpapiHost::CreateExternalPluginProcess.
   BrowserPpapiHostImpl(IPC::Sender* sender,
                        const ppapi::PpapiPermissions& permissions,
                        const std::string& plugin_name,
                        const base::FilePath& plugin_path,
                        const base::FilePath& profile_data_directory,
@@ skipping 22 matching lines @@
 
   bool external_plugin() const { return external_plugin_; }
 
   // These two functions are notifications that an instance has been created
   // or destroyed. They allow us to maintain a mapping of PP_Instance to data
   // associated with the instance including view IDs in the browser process.
   void AddInstance(PP_Instance instance,
                    const PepperRendererInstanceData& instance_data);
   void DeleteInstance(PP_Instance instance);
 
+  void AddInstanceObserver(PP_Instance instance, InstanceObserver* observer);
+  void RemoveInstanceObserver(PP_Instance instance, InstanceObserver* observer);
+
+  void OnThrottleStateChanged(PP_Instance instance, bool is_throttled);
+  bool IsThrottled(PP_Instance instance) const;
+
   scoped_refptr<IPC::MessageFilter> message_filter() {
     return message_filter_;
   }
 
   const scoped_refptr<SSLContextHelper>& ssl_context_helper() const {
     return ssl_context_helper_;
   }
 
  private:
   friend class BrowserPpapiHostTest;
@@ skipping 15 matching lines @@
     ~HostMessageFilter() override;
 
     void OnKeepalive();
     void OnHostMsgLogInterfaceUsage(int hash) const;
 
     // Non owning pointers cleared in OnHostDestroyed()
     ppapi::host::PpapiHost* ppapi_host_;
     BrowserPpapiHostImpl* browser_ppapi_host_impl_;
   };
 
+  struct InstanceData {
+    InstanceData();
+    ~InstanceData();
+
+    PepperRendererInstanceData renderer_data;
+    bool is_throttled;
+
+    // linked_ptr wrapper required because InstanceData must be copyable to
+    // be stored in an STL container.
+    linked_ptr<ObserverList<InstanceObserver>> observer_list;
+  };
+
   // Reports plugin activity to the callback set with SetOnKeepaliveCallback.
   void OnKeepalive();
 
   scoped_ptr<ppapi::host::PpapiHost> ppapi_host_;
   base::Process plugin_process_;
   std::string plugin_name_;
   base::FilePath plugin_path_;
   base::FilePath profile_data_directory_;
 
   // If true, this refers to a plugin running in the renderer process.
   bool in_process_;
 
   // If true, this is an external plugin, i.e. created by the embedder using
   // BrowserPpapiHost::CreateExternalPluginProcess.
   bool external_plugin_;
 
   scoped_refptr<SSLContextHelper> ssl_context_helper_;
 
-  // Tracks all PP_Instances in this plugin and associated renderer-related
-  // data.
-  typedef std::map<PP_Instance, PepperRendererInstanceData> InstanceMap;
+  // Tracks all PP_Instances in this plugin and associated data.
+  typedef std::map<PP_Instance, InstanceData> InstanceMap;
   InstanceMap instance_map_;
 
   scoped_refptr<HostMessageFilter> message_filter_;
 
   BrowserPpapiHost::OnKeepaliveCallback on_keepalive_callback_;
 
   DISALLOW_COPY_AND_ASSIGN(BrowserPpapiHostImpl);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_RENDERER_HOST_PEPPER_BROWSER_PPAPI_HOST_IMPL_H_