content/plugin/plugin_channel.cc

   1 // Copyright (c) 2012 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/plugin/plugin_channel.h"
   6
   7 #include "base/bind.h"
   8 #include "base/command_line.h"
   9 #include "base/process/process_handle.h"
  10 #include "base/strings/string_util.h"
  11 #include "base/synchronization/lock.h"
  12 #include "base/synchronization/waitable_event.h"
  13 #include "build/build_config.h"
  14 #include "content/child/child_process.h"
  15 #include "content/child/npapi/plugin_instance.h"
  16 #include "content/child/npapi/webplugin_delegate_impl.h"
  17 #include "content/child/plugin_messages.h"
  18 #include "content/common/plugin_process_messages.h"
  19 #include "content/plugin/plugin_thread.h"
  20 #include "content/plugin/webplugin_delegate_stub.h"
  21 #include "content/plugin/webplugin_proxy.h"
  22 #include "content/public/common/content_switches.h"
  23 #include "ipc/message_filter.h"
  24 #include "third_party/WebKit/public/web/WebBindings.h"
  25
  26 #if defined(OS_POSIX)
  27 #include "ipc/ipc_channel_posix.h"
  28 #endif
  29
  30 using blink::WebBindings;
  31
  32 namespace content {
  33
  34 namespace {
  35
  36 // How long we wait before releasing the plugin process.
  37 const int kPluginReleaseTimeMinutes = 5;
  38
  39 }  // namespace
  40
  41 // If a sync call to the renderer results in a modal dialog, we need to have a
  42 // way to know so that we can run a nested message loop to simulate what would
  43 // happen in a single process browser and avoid deadlock.
  44 class PluginChannel::MessageFilter : public IPC::MessageFilter {
  45  public:
  46   MessageFilter() : sender_(NULL) { }
  47
  48   base::WaitableEvent* GetModalDialogEvent(int render_view_id) {
  49     base::AutoLock auto_lock(modal_dialog_event_map_lock_);
  50     if (!modal_dialog_event_map_.count(render_view_id)) {
  51       NOTREACHED();
  52       return NULL;
  53     }
  54
  55     return modal_dialog_event_map_[render_view_id].event;
  56   }
  57
  58   // Decrement the ref count associated with the modal dialog event for the
  59   // given tab.
  60   void ReleaseModalDialogEvent(int render_view_id) {
  61     base::AutoLock auto_lock(modal_dialog_event_map_lock_);
  62     if (!modal_dialog_event_map_.count(render_view_id)) {
  63       NOTREACHED();
  64       return;
  65     }
  66
  67     if (--(modal_dialog_event_map_[render_view_id].refcount))
  68       return;
  69
  70     // Delete the event when the stack unwinds as it could be in use now.
  71     base::MessageLoop::current()->DeleteSoon(
  72         FROM_HERE, modal_dialog_event_map_[render_view_id].event);
  73     modal_dialog_event_map_.erase(render_view_id);
  74   }
  75
  76   bool Send(IPC::Message* message) {
  77     // Need this function for the IPC_MESSAGE_HANDLER_DELAY_REPLY macro.
  78     return sender_->Send(message);
  79   }
  80
  81   // IPC::MessageFilter:
  82   void OnFilterAdded(IPC::Sender* sender) override { sender_ = sender; }
  83
  84   bool OnMessageReceived(const IPC::Message& message) override {
  85     IPC_BEGIN_MESSAGE_MAP(PluginChannel::MessageFilter, message)
  86       IPC_MESSAGE_HANDLER_DELAY_REPLY(PluginMsg_Init, OnInit)
  87       IPC_MESSAGE_HANDLER(PluginMsg_SignalModalDialogEvent,
  88                           OnSignalModalDialogEvent)
  89       IPC_MESSAGE_HANDLER(PluginMsg_ResetModalDialogEvent,
  90                           OnResetModalDialogEvent)
  91     IPC_END_MESSAGE_MAP()
  92     return message.type() == PluginMsg_SignalModalDialogEvent::ID ||
  93            message.type() == PluginMsg_ResetModalDialogEvent::ID;
  94   }
  95
  96  protected:
  97   ~MessageFilter() override {
  98     // Clean up in case of renderer crash.
  99     for (ModalDialogEventMap::iterator i = modal_dialog_event_map_.begin();
 100         i != modal_dialog_event_map_.end(); ++i) {
 101       delete i->second.event;
 102     }
 103   }
 104
 105  private:
 106   void OnInit(const PluginMsg_Init_Params& params, IPC::Message* reply_msg) {
 107     base::AutoLock auto_lock(modal_dialog_event_map_lock_);
 108     if (modal_dialog_event_map_.count(params.host_render_view_routing_id)) {
 109       modal_dialog_event_map_[params.host_render_view_routing_id].refcount++;
 110       return;
 111     }
 112
 113     WaitableEventWrapper wrapper;
 114     wrapper.event = new base::WaitableEvent(true, false);
 115     wrapper.refcount = 1;
 116     modal_dialog_event_map_[params.host_render_view_routing_id] = wrapper;
 117   }
 118
 119   void OnSignalModalDialogEvent(int render_view_id) {
 120     base::AutoLock auto_lock(modal_dialog_event_map_lock_);
 121     if (modal_dialog_event_map_.count(render_view_id))
 122       modal_dialog_event_map_[render_view_id].event->Signal();
 123   }
 124
 125   void OnResetModalDialogEvent(int render_view_id) {
 126     base::AutoLock auto_lock(modal_dialog_event_map_lock_);
 127     if (modal_dialog_event_map_.count(render_view_id))
 128       modal_dialog_event_map_[render_view_id].event->Reset();
 129   }
 130
 131   struct WaitableEventWrapper {
 132     base::WaitableEvent* event;
 133     int refcount;  // There could be multiple plugin instances per tab.
 134   };
 135   typedef std::map<int, WaitableEventWrapper> ModalDialogEventMap;
 136   ModalDialogEventMap modal_dialog_event_map_;
 137   base::Lock modal_dialog_event_map_lock_;
 138
 139   IPC::Sender* sender_;
 140 };
 141
 142 PluginChannel* PluginChannel::GetPluginChannel(
 143     int renderer_id, base::MessageLoopProxy* ipc_message_loop) {
 144   // Map renderer ID to a (single) channel to that process.
 145   std::string channel_key = base::StringPrintf(
 146       "%d.r%d", base::GetCurrentProcId(), renderer_id);
 147
 148   PluginChannel* channel =
 149       static_cast<PluginChannel*>(NPChannelBase::GetChannel(
 150           channel_key,
 151           IPC::Channel::MODE_SERVER,
 152           ClassFactory,
 153           ipc_message_loop,
 154           false,
 155           ChildProcess::current()->GetShutDownEvent()));
 156
 157   if (channel)
 158     channel->renderer_id_ = renderer_id;
 159
 160   return channel;
 161 }
 162
 163 // static
 164 void PluginChannel::NotifyRenderersOfPendingShutdown() {
 165   Broadcast(new PluginHostMsg_PluginShuttingDown());
 166 }
 167
 168 bool PluginChannel::Send(IPC::Message* msg) {
 169   in_send_++;
 170   if (log_messages_) {
 171     VLOG(1) << "sending message @" << msg << " on channel @" << this
 172             << " with type " << msg->type();
 173   }
 174   bool result = NPChannelBase::Send(msg);
 175   in_send_--;
 176   return result;
 177 }
 178
 179 bool PluginChannel::OnMessageReceived(const IPC::Message& msg) {
 180   if (log_messages_) {
 181     VLOG(1) << "received message @" << &msg << " on channel @" << this
 182             << " with type " << msg.type();
 183   }
 184   return NPChannelBase::OnMessageReceived(msg);
 185 }
 186
 187 void PluginChannel::OnChannelError() {
 188   NPChannelBase::OnChannelError();
 189   CleanUp();
 190 }
 191
 192 int PluginChannel::GenerateRouteID() {
 193   static int last_id = 0;
 194   return ++last_id;
 195 }
 196
 197 base::WaitableEvent* PluginChannel::GetModalDialogEvent(int render_view_id) {
 198   return filter_->GetModalDialogEvent(render_view_id);
 199 }
 200
 201 PluginChannel::~PluginChannel() {
 202   PluginThread::current()->Send(new PluginProcessHostMsg_ChannelDestroyed(
 203       renderer_id_));
 204   process_ref_.ReleaseWithDelay(
 205       base::TimeDelta::FromMinutes(kPluginReleaseTimeMinutes));
 206 }
 207
 208 void PluginChannel::CleanUp() {
 209   // We need to clean up the stubs so that they call NPPDestroy.  This will
 210   // also lead to them releasing their reference on this object so that it can
 211   // be deleted.
 212   for (size_t i = 0; i < plugin_stubs_.size(); ++i)
 213     RemoveRoute(plugin_stubs_[i]->instance_id());
 214
 215   // Need to addref this object temporarily because otherwise removing the last
 216   // stub will cause the destructor of this object to be called, however at
 217   // that point plugin_stubs_ will have one element and its destructor will be
 218   // called twice.
 219   scoped_refptr<PluginChannel> me(this);
 220
 221   while (!plugin_stubs_.empty()) {
 222     // Separate vector::erase and ~WebPluginDelegateStub.
 223     // See https://code.google.com/p/chromium/issues/detail?id=314088
 224     scoped_refptr<WebPluginDelegateStub> stub = plugin_stubs_[0];
 225     plugin_stubs_.erase(plugin_stubs_.begin());
 226   }
 227 }
 228
 229 bool PluginChannel::Init(base::MessageLoopProxy* ipc_message_loop,
 230                          bool create_pipe_now,
 231                          base::WaitableEvent* shutdown_event) {
 232   if (!NPChannelBase::Init(ipc_message_loop, create_pipe_now, shutdown_event))
 233     return false;
 234
 235   channel_->AddFilter(filter_.get());
 236   return true;
 237 }
 238
 239 PluginChannel::PluginChannel()
 240     : renderer_id_(-1),
 241       in_send_(0),
 242       incognito_(false),
 243       filter_(new MessageFilter()),
 244       npp_(new struct _NPP) {
 245   set_send_unblocking_only_during_unblock_dispatch();
 246   const CommandLine* command_line = CommandLine::ForCurrentProcess();
 247   log_messages_ = command_line->HasSwitch(switches::kLogPluginMessages);
 248
 249   // Register |npp_| as the default owner for any object we receive via IPC,
 250   // and register it with WebBindings as a valid owner.
 251   SetDefaultNPObjectOwner(npp_.get());
 252   WebBindings::registerObjectOwner(npp_.get());
 253 }
 254
 255 bool PluginChannel::OnControlMessageReceived(const IPC::Message& msg) {
 256   bool handled = true;
 257   IPC_BEGIN_MESSAGE_MAP(PluginChannel, msg)
 258     IPC_MESSAGE_HANDLER(PluginMsg_CreateInstance, OnCreateInstance)
 259     IPC_MESSAGE_HANDLER_DELAY_REPLY(PluginMsg_DestroyInstance,
 260                                     OnDestroyInstance)
 261     IPC_MESSAGE_HANDLER(PluginMsg_GenerateRouteID, OnGenerateRouteID)
 262     IPC_MESSAGE_HANDLER(PluginProcessMsg_ClearSiteData, OnClearSiteData)
 263     IPC_MESSAGE_HANDLER(PluginHostMsg_DidAbortLoading, OnDidAbortLoading)
 264     IPC_MESSAGE_UNHANDLED(handled = false)
 265   IPC_END_MESSAGE_MAP()
 266   DCHECK(handled);
 267   return handled;
 268 }
 269
 270 void PluginChannel::OnCreateInstance(const std::string& mime_type,
 271                                      int* instance_id) {
 272   *instance_id = GenerateRouteID();
 273   scoped_refptr<WebPluginDelegateStub> stub(new WebPluginDelegateStub(
 274       mime_type, *instance_id, this));
 275   AddRoute(*instance_id, stub.get(), NULL);
 276   plugin_stubs_.push_back(stub);
 277 }
 278
 279 void PluginChannel::OnDestroyInstance(int instance_id,
 280                                       IPC::Message* reply_msg) {
 281   for (size_t i = 0; i < plugin_stubs_.size(); ++i) {
 282     if (plugin_stubs_[i]->instance_id() == instance_id) {
 283       scoped_refptr<MessageFilter> filter(filter_);
 284       int render_view_id =
 285           plugin_stubs_[i]->webplugin()->host_render_view_routing_id();
 286       // Separate vector::erase and ~WebPluginDelegateStub.
 287       // See https://code.google.com/p/chromium/issues/detail?id=314088
 288       scoped_refptr<WebPluginDelegateStub> stub = plugin_stubs_[i];
 289       plugin_stubs_.erase(plugin_stubs_.begin() + i);
 290       stub = NULL;
 291
 292       Send(reply_msg);
 293       RemoveRoute(instance_id);
 294       // NOTE: *this* might be deleted as a result of calling RemoveRoute.
 295       // Don't release the modal dialog event right away, but do it after the
 296       // stack unwinds since the plugin can be destroyed later if it's in use
 297       // right now.
 298       base::MessageLoop::current()->PostNonNestableTask(
 299           FROM_HERE,
 300           base::Bind(&MessageFilter::ReleaseModalDialogEvent,
 301                      filter.get(),
 302                      render_view_id));
 303       return;
 304     }
 305   }
 306
 307   NOTREACHED() << "Couldn't find WebPluginDelegateStub to destroy";
 308 }
 309
 310 void PluginChannel::OnGenerateRouteID(int* route_id) {
 311   *route_id = GenerateRouteID();
 312 }
 313
 314 void PluginChannel::OnClearSiteData(const std::string& site,
 315                                     uint64 flags,
 316                                     uint64 max_age) {
 317   bool success = false;
 318   CommandLine* command_line = CommandLine::ForCurrentProcess();
 319   base::FilePath path = command_line->GetSwitchValuePath(switches::kPluginPath);
 320   scoped_refptr<PluginLib> plugin_lib(PluginLib::CreatePluginLib(path));
 321   if (plugin_lib.get()) {
 322     NPError err = plugin_lib->NP_Initialize();
 323     if (err == NPERR_NO_ERROR) {
 324       const char* site_str = site.empty() ? NULL : site.c_str();
 325       err = plugin_lib->NP_ClearSiteData(site_str, flags, max_age);
 326       std::string site_name =
 327           site.empty() ? "NULL"
 328                        : base::StringPrintf("\"%s\"", site_str);
 329       VLOG(1) << "NPP_ClearSiteData(" << site_name << ", " << flags << ", "
 330               << max_age << ") returned " << err;
 331       success = (err == NPERR_NO_ERROR);
 332     }
 333   }
 334   Send(new PluginProcessHostMsg_ClearSiteDataResult(success));
 335 }
 336
 337 void PluginChannel::OnDidAbortLoading(int render_view_id) {
 338   for (size_t i = 0; i < plugin_stubs_.size(); ++i) {
 339     if (plugin_stubs_[i]->webplugin()->host_render_view_routing_id() ==
 340             render_view_id) {
 341       plugin_stubs_[i]->delegate()->instance()->CloseStreams();
 342     }
 343   }
 344 }
 345
 346 }  // namespace content