content/browser/browser_child_process_host_impl.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/browser/browser_child_process_host_impl.h"
   6
   7 #include "base/base_switches.h"
   8 #include "base/bind.h"
   9 #include "base/command_line.h"
  10 #include "base/debug/dump_without_crashing.h"
  11 #include "base/files/file_path.h"
  12 #include "base/lazy_instance.h"
  13 #include "base/logging.h"
  14 #include "base/metrics/histogram.h"
  15 #include "base/profiler/scoped_tracker.h"
  16 #include "base/stl_util.h"
  17 #include "base/strings/string_util.h"
  18 #include "base/synchronization/waitable_event.h"
  19 #include "content/browser/histogram_message_filter.h"
  20 #include "content/browser/loader/resource_message_filter.h"
  21 #include "content/browser/profiler_message_filter.h"
  22 #include "content/browser/tracing/trace_message_filter.h"
  23 #include "content/common/child_process_host_impl.h"
  24 #include "content/public/browser/browser_child_process_host_delegate.h"
  25 #include "content/public/browser/browser_child_process_observer.h"
  26 #include "content/public/browser/browser_thread.h"
  27 #include "content/public/browser/child_process_data.h"
  28 #include "content/public/browser/content_browser_client.h"
  29 #include "content/public/common/content_switches.h"
  30 #include "content/public/common/process_type.h"
  31 #include "content/public/common/result_codes.h"
  32
  33 #if defined(OS_MACOSX)
  34 #include "content/browser/mach_broker_mac.h"
  35 #endif
  36
  37 namespace content {
  38 namespace {
  39
  40 static base::LazyInstance<BrowserChildProcessHostImpl::BrowserChildProcessList>
  41     g_child_process_list = LAZY_INSTANCE_INITIALIZER;
  42
  43 base::LazyInstance<base::ObserverList<BrowserChildProcessObserver>>
  44     g_observers = LAZY_INSTANCE_INITIALIZER;
  45
  46 void NotifyProcessHostConnected(const ChildProcessData& data) {
  47   FOR_EACH_OBSERVER(BrowserChildProcessObserver, g_observers.Get(),
  48                     BrowserChildProcessHostConnected(data));
  49 }
  50
  51 void NotifyProcessHostDisconnected(const ChildProcessData& data) {
  52   FOR_EACH_OBSERVER(BrowserChildProcessObserver, g_observers.Get(),
  53                     BrowserChildProcessHostDisconnected(data));
  54 }
  55
  56 void NotifyProcessCrashed(const ChildProcessData& data, int exit_code) {
  57   FOR_EACH_OBSERVER(BrowserChildProcessObserver, g_observers.Get(),
  58                     BrowserChildProcessCrashed(data, exit_code));
  59 }
  60
  61 }  // namespace
  62
  63 BrowserChildProcessHost* BrowserChildProcessHost::Create(
  64     content::ProcessType process_type,
  65     BrowserChildProcessHostDelegate* delegate) {
  66   return new BrowserChildProcessHostImpl(process_type, delegate);
  67 }
  68
  69 BrowserChildProcessHost* BrowserChildProcessHost::FromID(int child_process_id) {
  70   DCHECK_CURRENTLY_ON(BrowserThread::IO);
  71   BrowserChildProcessHostImpl::BrowserChildProcessList* process_list =
  72       g_child_process_list.Pointer();
  73   for (BrowserChildProcessHostImpl* host : *process_list) {
  74     if (host->GetData().id == child_process_id)
  75       return host;
  76   }
  77   return nullptr;
  78 }
  79
  80 #if defined(OS_MACOSX)
  81 base::ProcessMetrics::PortProvider* BrowserChildProcessHost::GetPortProvider() {
  82   return MachBroker::GetInstance();
  83 }
  84 #endif
  85
  86 // static
  87 BrowserChildProcessHostImpl::BrowserChildProcessList*
  88     BrowserChildProcessHostImpl::GetIterator() {
  89   return g_child_process_list.Pointer();
  90 }
  91
  92 // static
  93 void BrowserChildProcessHostImpl::AddObserver(
  94     BrowserChildProcessObserver* observer) {
  95   DCHECK_CURRENTLY_ON(BrowserThread::UI);
  96   g_observers.Get().AddObserver(observer);
  97 }
  98
  99 // static
 100 void BrowserChildProcessHostImpl::RemoveObserver(
 101     BrowserChildProcessObserver* observer) {
 102   // TODO(phajdan.jr): Check thread after fixing http://crbug.com/167126.
 103   g_observers.Get().RemoveObserver(observer);
 104 }
 105
 106 BrowserChildProcessHostImpl::BrowserChildProcessHostImpl(
 107     content::ProcessType process_type,
 108     BrowserChildProcessHostDelegate* delegate)
 109     : data_(process_type),
 110       delegate_(delegate),
 111       power_monitor_message_broadcaster_(this) {
 112   data_.id = ChildProcessHostImpl::GenerateChildProcessUniqueId();
 113
 114   child_process_host_.reset(ChildProcessHost::Create(this));
 115   AddFilter(new TraceMessageFilter(data_.id));
 116   AddFilter(new ProfilerMessageFilter(process_type));
 117   AddFilter(new HistogramMessageFilter);
 118
 119   g_child_process_list.Get().push_back(this);
 120   GetContentClient()->browser()->BrowserChildProcessHostCreated(this);
 121
 122   power_monitor_message_broadcaster_.Init();
 123 }
 124
 125 BrowserChildProcessHostImpl::~BrowserChildProcessHostImpl() {
 126   g_child_process_list.Get().remove(this);
 127 }
 128
 129 // static
 130 void BrowserChildProcessHostImpl::TerminateAll() {
 131   DCHECK_CURRENTLY_ON(BrowserThread::IO);
 132   // Make a copy since the BrowserChildProcessHost dtor mutates the original
 133   // list.
 134   BrowserChildProcessList copy = g_child_process_list.Get();
 135   for (BrowserChildProcessList::iterator it = copy.begin();
 136        it != copy.end(); ++it) {
 137     delete (*it)->delegate();  // ~*HostDelegate deletes *HostImpl.
 138   }
 139 }
 140
 141 void BrowserChildProcessHostImpl::Launch(
 142     SandboxedProcessLauncherDelegate* delegate,
 143     base::CommandLine* cmd_line,
 144     bool terminate_on_shutdown) {
 145   DCHECK_CURRENTLY_ON(BrowserThread::IO);
 146
 147   GetContentClient()->browser()->AppendExtraCommandLineSwitches(
 148       cmd_line, data_.id);
 149
 150   const base::CommandLine& browser_command_line =
 151       *base::CommandLine::ForCurrentProcess();
 152   static const char* kForwardSwitches[] = {
 153     switches::kDisableLogging,
 154     switches::kEnableLogging,
 155     switches::kIPCConnectionTimeout,
 156     switches::kLoggingLevel,
 157     switches::kTraceToConsole,
 158     switches::kV,
 159     switches::kVModule,
 160   };
 161   cmd_line->CopySwitchesFrom(browser_command_line, kForwardSwitches,
 162                              arraysize(kForwardSwitches));
 163
 164   child_process_.reset(new ChildProcessLauncher(
 165       delegate,
 166       cmd_line,
 167       data_.id,
 168       this,
 169       terminate_on_shutdown));
 170 }
 171
 172 const ChildProcessData& BrowserChildProcessHostImpl::GetData() const {
 173   DCHECK_CURRENTLY_ON(BrowserThread::IO);
 174   return data_;
 175 }
 176
 177 ChildProcessHost* BrowserChildProcessHostImpl::GetHost() const {
 178   DCHECK_CURRENTLY_ON(BrowserThread::IO);
 179   return child_process_host_.get();
 180 }
 181
 182 const base::Process& BrowserChildProcessHostImpl::GetProcess() const {
 183   DCHECK_CURRENTLY_ON(BrowserThread::IO);
 184   DCHECK(child_process_.get())
 185       << "Requesting a child process handle before launching.";
 186   DCHECK(child_process_->GetProcess().IsValid())
 187       << "Requesting a child process handle before launch has completed OK.";
 188   return child_process_->GetProcess();
 189 }
 190
 191 void BrowserChildProcessHostImpl::SetName(const base::string16& name) {
 192   DCHECK_CURRENTLY_ON(BrowserThread::IO);
 193   data_.name = name;
 194 }
 195
 196 void BrowserChildProcessHostImpl::SetHandle(base::ProcessHandle handle) {
 197   DCHECK_CURRENTLY_ON(BrowserThread::IO);
 198   data_.handle = handle;
 199 }
 200
 201 ServiceRegistry* BrowserChildProcessHostImpl::GetServiceRegistry() {
 202   DCHECK_CURRENTLY_ON(BrowserThread::IO);
 203   return delegate_->GetServiceRegistry();
 204 }
 205
 206 void BrowserChildProcessHostImpl::ForceShutdown() {
 207   DCHECK_CURRENTLY_ON(BrowserThread::IO);
 208   g_child_process_list.Get().remove(this);
 209   child_process_host_->ForceShutdown();
 210 }
 211
 212 void BrowserChildProcessHostImpl::SetBackgrounded(bool backgrounded) {
 213   child_process_->SetProcessBackgrounded(backgrounded);
 214 }
 215
 216 void BrowserChildProcessHostImpl::AddFilter(BrowserMessageFilter* filter) {
 217   child_process_host_->AddFilter(filter->GetFilter());
 218 }
 219
 220 void BrowserChildProcessHostImpl::NotifyProcessInstanceCreated(
 221     const ChildProcessData& data) {
 222   DCHECK_CURRENTLY_ON(BrowserThread::UI);
 223   FOR_EACH_OBSERVER(BrowserChildProcessObserver, g_observers.Get(),
 224                     BrowserChildProcessInstanceCreated(data));
 225 }
 226
 227 void BrowserChildProcessHostImpl::HistogramBadMessageTerminated(
 228     int process_type) {
 229   UMA_HISTOGRAM_ENUMERATION("ChildProcess.BadMessgeTerminated", process_type,
 230                             PROCESS_TYPE_MAX);
 231 }
 232
 233 base::TerminationStatus BrowserChildProcessHostImpl::GetTerminationStatus(
 234     bool known_dead, int* exit_code) {
 235   DCHECK_CURRENTLY_ON(BrowserThread::IO);
 236   if (!child_process_)  // If the delegate doesn't use Launch() helper.
 237     return base::GetTerminationStatus(data_.handle, exit_code);
 238   return child_process_->GetChildTerminationStatus(known_dead,
 239                                                    exit_code);
 240 }
 241
 242 bool BrowserChildProcessHostImpl::OnMessageReceived(
 243     const IPC::Message& message) {
 244   return delegate_->OnMessageReceived(message);
 245 }
 246
 247 void BrowserChildProcessHostImpl::OnChannelConnected(int32 peer_pid) {
 248 #if defined(OS_WIN)
 249   // From this point onward, the exit of the child process is detected by an
 250   // error on the IPC channel.
 251   early_exit_watcher_.StopWatching();
 252 #endif
 253
 254   DCHECK_CURRENTLY_ON(BrowserThread::IO);
 255   BrowserThread::PostTask(BrowserThread::UI, FROM_HERE,
 256                           base::Bind(&NotifyProcessHostConnected, data_));
 257
 258   delegate_->OnChannelConnected(peer_pid);
 259 }
 260
 261 void BrowserChildProcessHostImpl::OnChannelError() {
 262   delegate_->OnChannelError();
 263 }
 264
 265 void BrowserChildProcessHostImpl::OnBadMessageReceived(
 266     const IPC::Message& message) {
 267   HistogramBadMessageTerminated(data_.process_type);
 268   if (base::CommandLine::ForCurrentProcess()->HasSwitch(
 269           switches::kDisableKillAfterBadIPC)) {
 270     return;
 271   }
 272   LOG(ERROR) << "Terminating child process for bad IPC message of type "
 273       << message.type();
 274
 275   // Create a memory dump. This will contain enough stack frames to work out
 276   // what the bad message was.
 277   base::debug::DumpWithoutCrashing();
 278
 279   child_process_->GetProcess().Terminate(RESULT_CODE_KILLED_BAD_MESSAGE, false);
 280 }
 281
 282 bool BrowserChildProcessHostImpl::CanShutdown() {
 283   return delegate_->CanShutdown();
 284 }
 285
 286 void BrowserChildProcessHostImpl::OnChildDisconnected() {
 287   DCHECK_CURRENTLY_ON(BrowserThread::IO);
 288 #if defined(OS_WIN)
 289   // OnChildDisconnected may be called without OnChannelConnected, so stop the
 290   // early exit watcher so GetTerminationStatus can close the process handle.
 291   early_exit_watcher_.StopWatching();
 292 #endif
 293   if (child_process_.get() || data_.handle) {
 294     int exit_code;
 295     base::TerminationStatus status = GetTerminationStatus(
 296         true /* known_dead */, &exit_code);
 297     switch (status) {
 298       case base::TERMINATION_STATUS_PROCESS_CRASHED:
 299       case base::TERMINATION_STATUS_ABNORMAL_TERMINATION: {
 300         delegate_->OnProcessCrashed(exit_code);
 301         BrowserThread::PostTask(
 302             BrowserThread::UI, FROM_HERE,
 303             base::Bind(&NotifyProcessCrashed, data_, exit_code));
 304         UMA_HISTOGRAM_ENUMERATION("ChildProcess.Crashed2",
 305                                   data_.process_type,
 306                                   PROCESS_TYPE_MAX);
 307         break;
 308       }
 309 #if defined(OS_ANDROID)
 310       case base::TERMINATION_STATUS_OOM_PROTECTED:
 311 #endif
 312 #if defined(OS_CHROMEOS)
 313       case base::TERMINATION_STATUS_PROCESS_WAS_KILLED_BY_OOM:
 314 #endif
 315       case base::TERMINATION_STATUS_PROCESS_WAS_KILLED: {
 316         delegate_->OnProcessCrashed(exit_code);
 317         // Report that this child process was killed.
 318         UMA_HISTOGRAM_ENUMERATION("ChildProcess.Killed2",
 319                                   data_.process_type,
 320                                   PROCESS_TYPE_MAX);
 321         break;
 322       }
 323       case base::TERMINATION_STATUS_STILL_RUNNING: {
 324         UMA_HISTOGRAM_ENUMERATION("ChildProcess.DisconnectedAlive2",
 325                                   data_.process_type,
 326                                   PROCESS_TYPE_MAX);
 327       }
 328       default:
 329         break;
 330     }
 331     UMA_HISTOGRAM_ENUMERATION("ChildProcess.Disconnected2",
 332                               data_.process_type,
 333                               PROCESS_TYPE_MAX);
 334 #if defined(OS_CHROMEOS)
 335     if (status == base::TERMINATION_STATUS_PROCESS_WAS_KILLED_BY_OOM) {
 336       UMA_HISTOGRAM_ENUMERATION("ChildProcess.Killed2.OOM",
 337                                 data_.process_type,
 338                                 PROCESS_TYPE_MAX);
 339     }
 340 #endif
 341   }
 342   BrowserThread::PostTask(BrowserThread::UI, FROM_HERE,
 343                           base::Bind(&NotifyProcessHostDisconnected, data_));
 344   delete delegate_;  // Will delete us
 345 }
 346
 347 bool BrowserChildProcessHostImpl::Send(IPC::Message* message) {
 348   return child_process_host_->Send(message);
 349 }
 350
 351 void BrowserChildProcessHostImpl::OnProcessLaunchFailed() {
 352   delegate_->OnProcessLaunchFailed();
 353   delete delegate_;  // Will delete us
 354 }
 355
 356 void BrowserChildProcessHostImpl::OnProcessLaunched() {
 357   // TODO(erikchen): Remove ScopedTracker below once http://crbug.com/465841
 358   // is fixed.
 359   tracked_objects::ScopedTracker tracking_profile(
 360       FROM_HERE_WITH_EXPLICIT_FUNCTION(
 361           "465841 BrowserChildProcessHostImpl::OnProcessLaunched"));
 362   const base::Process& process = child_process_->GetProcess();
 363   DCHECK(process.IsValid());
 364
 365 #if defined(OS_WIN)
 366   // Start a WaitableEventWatcher that will invoke OnProcessExitedEarly if the
 367   // child process exits. This watcher is stopped once the IPC channel is
 368   // connected and the exit of the child process is detecter by an error on the
 369   // IPC channel thereafter.
 370   DCHECK(!early_exit_watcher_.GetWatchedObject());
 371   early_exit_watcher_.StartWatching(process.Handle(), this);
 372 #endif
 373
 374   // TODO(rvargas) crbug.com/417532: Don't store a handle.
 375   data_.handle = process.Handle();
 376   delegate_->OnProcessLaunched();
 377 }
 378
 379 #if defined(OS_WIN)
 380
 381 void BrowserChildProcessHostImpl::OnObjectSignaled(HANDLE object) {
 382   OnChildDisconnected();
 383 }
 384
 385 #endif
 386
 387 }  // namespace content