plugin_channel_host.cc revision bb1529ce867d8845a77ec7cdf3e3003ef1771a40
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/renderer/npapi/plugin_channel_host.h" 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/metrics/histogram.h" 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/time/time.h" 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/child/child_process.h" 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/child/npapi/npobject_base.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/child/plugin_messages.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(OS_POSIX) 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ipc/ipc_channel_posix.h" 152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#endif 162a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 17868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)#include "third_party/WebKit/public/web/WebBindings.h" 18868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) 19eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch// TODO(shess): Debugging for http://crbug.com/97285 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 212a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// The hypothesis at #55 requires that RemoveRoute() be called between 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// sending ViewHostMsg_OpenChannelToPlugin to the browser, and calling 232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// GetPluginChannelHost() on the result. This code detects that case 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// and stores the backtrace of the RemoveRoute() in a breakpad key. 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The specific RemoveRoute() is not tracked (there could be multiple, 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// and which is the one can't be known until the open completes), but 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// the backtrace from any such nested call should be sufficient to 282a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// drive a repro. 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(OS_MACOSX) 302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "base/debug/crash_logging.h" 312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "base/debug/stack_trace.h" 322a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "base/strings/sys_string_conversions.h" 332a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 3490dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)namespace { 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 36558790d6acca3451cf3a6b497803a5f07d0bec58Ben Murdoch// Breakpad key for the RemoveRoute() backtrace. 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)const char* kRemoveRouteTraceKey = "remove_route_bt"; 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Breakpad key for the OnChannelError() backtrace. 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)const char* kChannelErrorTraceKey = "channel_error_bt"; 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// GetRemoveTrackingFlag() exposes this so that 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// WebPluginDelegateProxy::Initialize() can do scoped set/reset. When 44eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch// true, RemoveRoute() knows WBDP::Initialize() is on the stack, and 45eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch// records the backtrace. 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)bool remove_tracking = false; 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace content { 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(OS_MACOSX) 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// static 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)bool* PluginChannelHost::GetRemoveTrackingFlag() { 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return &remove_tracking; 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 587dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch#endif 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// static 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PluginChannelHost* PluginChannelHost::GetPluginChannelHost( 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const IPC::ChannelHandle& channel_handle, 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::MessageLoopProxy* ipc_message_loop) { 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PluginChannelHost* result = 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static_cast<PluginChannelHost*>(NPChannelBase::GetChannel( 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) channel_handle, 67c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch IPC::Channel::MODE_CLIENT, 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ClassFactory, 69c5cede9ae108bb15f6b7a8aea21c7e1fefa2834cBen Murdoch ipc_message_loop, 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) true, 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ChildProcess::current()->GetShutDownEvent())); 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return result; 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PluginChannelHost::PluginChannelHost() : expecting_shutdown_(false) { 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PluginChannelHost::~PluginChannelHost() { 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)bool PluginChannelHost::Init(base::MessageLoopProxy* ipc_message_loop, 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool create_pipe_now, 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::WaitableEvent* shutdown_event) { 842a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) return NPChannelBase::Init(ipc_message_loop, create_pipe_now, shutdown_event); 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int PluginChannelHost::GenerateRouteID() { 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int route_id = MSG_ROUTING_NONE; 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Send(new PluginMsg_GenerateRouteID(&route_id)); 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return route_id; 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void PluginChannelHost::AddRoute(int route_id, 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) IPC::Listener* listener, 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) NPObjectBase* npobject) { 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) NPChannelBase::AddRoute(route_id, listener, npobject); 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (!npobject) 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) proxies_[route_id] = listener; 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void PluginChannelHost::RemoveRoute(int route_id) { 1042a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#if defined(OS_MACOSX) 1052a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) if (remove_tracking) { 1062a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) base::debug::StackTrace trace; 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t count = 0; 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const void* const* addresses = trace.Addresses(&count); 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::debug::SetCrashKeyFromAddresses( 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) kRemoveRouteTraceKey, addresses, count); 1112a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 1132a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) proxies_.erase(route_id); 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) NPChannelBase::RemoveRoute(route_id); 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)bool PluginChannelHost::OnControlMessageReceived(const IPC::Message& message) { 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool handled = true; 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) IPC_BEGIN_MESSAGE_MAP(PluginChannelHost, message) 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) IPC_MESSAGE_HANDLER(PluginHostMsg_SetException, OnSetException) 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) IPC_MESSAGE_HANDLER(PluginHostMsg_PluginShuttingDown, OnPluginShuttingDown) 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) IPC_MESSAGE_UNHANDLED(handled = false) 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) IPC_END_MESSAGE_MAP() 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DCHECK(handled); 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return handled; 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void PluginChannelHost::OnSetException(const std::string& message) { 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) WebKit::WebBindings::setException(NULL, message.c_str()); 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void PluginChannelHost::OnPluginShuttingDown() { 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) expecting_shutdown_ = true; 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)bool PluginChannelHost::Send(IPC::Message* msg) { 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (msg->is_sync()) { 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::TimeTicks start_time(base::TimeTicks::Now()); 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool result = NPChannelBase::Send(msg); 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) UMA_HISTOGRAM_TIMES("Plugin.SyncMessageTime", 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::TimeTicks::Now() - start_time); 1435d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) return result; 1445d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) } 1455d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) return NPChannelBase::Send(msg); 1465d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)} 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void PluginChannelHost::OnChannelError() { 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(OS_MACOSX) 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (remove_tracking) { 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::debug::StackTrace trace; 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t count = 0; 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const void* const* addresses = trace.Addresses(&count); 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::debug::SetCrashKeyFromAddresses( 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) kChannelErrorTraceKey, addresses, count); 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) NPChannelBase::OnChannelError(); 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for (ProxyMap::iterator iter = proxies_.begin(); 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) iter != proxies_.end(); iter++) { 1632a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) iter->second->OnChannelError(); 1642a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) } 1652a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1662a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) proxies_.clear(); 1672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)} 1682a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)} // namespace content 1702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)