telemetry: Rename mean_scroll_update_latency metric
[chromium-blink-merge.git] / content / browser / child_process_launcher.cc
blobac237c365065ee412c0dfb768cf02bd6058d51a8
1 // Copyright 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.
5 #include "content/browser/child_process_launcher.h"
7 #include "base/bind.h"
8 #include "base/command_line.h"
9 #include "base/files/file_util.h"
10 #include "base/i18n/icu_util.h"
11 #include "base/logging.h"
12 #include "base/memory/scoped_ptr.h"
13 #include "base/metrics/histogram.h"
14 #include "base/process/process.h"
15 #include "base/profiler/scoped_tracker.h"
16 #include "base/synchronization/lock.h"
17 #include "base/threading/thread.h"
18 #include "content/public/browser/content_browser_client.h"
19 #include "content/public/common/content_descriptors.h"
20 #include "content/public/common/content_switches.h"
21 #include "content/public/common/result_codes.h"
22 #include "content/public/common/sandboxed_process_launcher_delegate.h"
24 #if defined(OS_WIN)
25 #include "base/files/file_path.h"
26 #include "content/common/sandbox_win.h"
27 #include "content/public/common/sandbox_init.h"
28 #elif defined(OS_MACOSX)
29 #include "content/browser/bootstrap_sandbox_mac.h"
30 #include "content/browser/browser_io_surface_manager_mac.h"
31 #include "content/browser/mach_broker_mac.h"
32 #include "sandbox/mac/bootstrap_sandbox.h"
33 #include "sandbox/mac/pre_exec_delegate.h"
34 #elif defined(OS_ANDROID)
35 #include "base/android/jni_android.h"
36 #include "content/browser/android/child_process_launcher_android.h"
37 #elif defined(OS_POSIX)
38 #include "base/memory/singleton.h"
39 #include "content/browser/renderer_host/render_sandbox_host_linux.h"
40 #include "content/browser/zygote_host/zygote_host_impl_linux.h"
41 #include "content/common/child_process_sandbox_support_impl_linux.h"
42 #endif
44 #if defined(OS_POSIX)
45 #include "base/posix/global_descriptors.h"
46 #include "content/browser/file_descriptor_info_impl.h"
47 #include "gin/v8_initializer.h"
48 #endif
50 namespace content {
52 namespace {
54 typedef base::Callback<void(bool,
55 #if defined(OS_ANDROID)
56 base::ScopedFD,
57 #endif
58 base::Process)> NotifyCallback;
60 void RecordHistogramsOnLauncherThread(base::TimeDelta launch_time) {
61 DCHECK_CURRENTLY_ON(BrowserThread::PROCESS_LAUNCHER);
62 // Log the launch time, separating out the first one (which will likely be
63 // slower due to the rest of the browser initializing at the same time).
64 static bool done_first_launch = false;
65 if (done_first_launch) {
66 UMA_HISTOGRAM_TIMES("MPArch.ChildProcessLaunchSubsequent", launch_time);
67 } else {
68 UMA_HISTOGRAM_TIMES("MPArch.ChildProcessLaunchFirst", launch_time);
69 done_first_launch = true;
73 #if defined(OS_ANDROID)
74 // TODO(sievers): Remove this by defining better what happens on what
75 // thread in the corresponding Java code.
76 void OnChildProcessStartedAndroid(const NotifyCallback& callback,
77 BrowserThread::ID client_thread_id,
78 const base::TimeTicks begin_launch_time,
79 base::ScopedFD ipcfd,
80 base::ProcessHandle handle) {
81 // This can be called on the launcher thread or UI thread.
82 base::TimeDelta launch_time = base::TimeTicks::Now() - begin_launch_time;
83 BrowserThread::PostTask(
84 BrowserThread::PROCESS_LAUNCHER, FROM_HERE,
85 base::Bind(&RecordHistogramsOnLauncherThread, launch_time));
87 base::Closure callback_on_client_thread(
88 base::Bind(callback, false, base::Passed(&ipcfd),
89 base::Passed(base::Process(handle))));
90 if (BrowserThread::CurrentlyOn(client_thread_id)) {
91 callback_on_client_thread.Run();
92 } else {
93 BrowserThread::PostTask(
94 client_thread_id, FROM_HERE, callback_on_client_thread);
97 #endif
99 void LaunchOnLauncherThread(const NotifyCallback& callback,
100 BrowserThread::ID client_thread_id,
101 int child_process_id,
102 SandboxedProcessLauncherDelegate* delegate,
103 #if defined(OS_ANDROID)
104 base::ScopedFD ipcfd,
105 #endif
106 base::CommandLine* cmd_line) {
107 DCHECK_CURRENTLY_ON(BrowserThread::PROCESS_LAUNCHER);
108 scoped_ptr<SandboxedProcessLauncherDelegate> delegate_deleter(delegate);
109 #if defined(OS_WIN)
110 bool use_zygote = false;
111 bool launch_elevated = delegate->ShouldLaunchElevated();
112 #elif defined(OS_MACOSX)
113 bool use_zygote = false;
114 base::EnvironmentMap env = delegate->GetEnvironment();
115 base::ScopedFD ipcfd = delegate->TakeIpcFd();
116 #elif defined(OS_POSIX) && !defined(OS_ANDROID)
117 bool use_zygote = delegate->ShouldUseZygote();
118 base::EnvironmentMap env = delegate->GetEnvironment();
119 base::ScopedFD ipcfd = delegate->TakeIpcFd();
120 #endif
121 scoped_ptr<base::CommandLine> cmd_line_deleter(cmd_line);
122 base::TimeTicks begin_launch_time = base::TimeTicks::Now();
124 base::Process process;
125 #if defined(OS_WIN)
126 if (launch_elevated) {
127 base::LaunchOptions options;
128 options.start_hidden = true;
129 process = base::LaunchElevatedProcess(*cmd_line, options);
130 } else {
131 process = StartSandboxedProcess(delegate, cmd_line);
133 #elif defined(OS_POSIX)
134 std::string process_type =
135 cmd_line->GetSwitchValueASCII(switches::kProcessType);
136 scoped_ptr<FileDescriptorInfo> files_to_register(
137 FileDescriptorInfoImpl::Create());
139 #if defined(OS_ANDROID)
140 files_to_register->Share(kPrimaryIPCChannel, ipcfd.get());
141 #else
142 files_to_register->Transfer(kPrimaryIPCChannel, ipcfd.Pass());
143 #endif
144 #endif
146 #if defined(OS_POSIX) && !defined(OS_MACOSX)
147 std::map<int, base::MemoryMappedFile::Region> regions;
148 GetContentClient()->browser()->GetAdditionalMappedFilesForChildProcess(
149 *cmd_line, child_process_id, files_to_register.get()
150 #if defined(OS_ANDROID)
151 , &regions
152 #endif
154 #if defined(V8_USE_EXTERNAL_STARTUP_DATA)
155 base::PlatformFile natives_pf =
156 gin::V8Initializer::GetOpenNativesFileForChildProcesses(
157 &regions[kV8NativesDataDescriptor]);
158 DCHECK_GE(natives_pf, 0);
159 files_to_register->Share(kV8NativesDataDescriptor, natives_pf);
161 base::MemoryMappedFile::Region snapshot_region;
162 base::PlatformFile snapshot_pf =
163 gin::V8Initializer::GetOpenSnapshotFileForChildProcesses(
164 &snapshot_region);
165 // Failure to load the V8 snapshot is not necessarily an error. V8 can start
166 // up (slower) without the snapshot.
167 if (snapshot_pf != -1) {
168 files_to_register->Share(kV8SnapshotDataDescriptor, snapshot_pf);
169 regions.insert(std::make_pair(kV8SnapshotDataDescriptor, snapshot_region));
172 if (process_type != switches::kZygoteProcess) {
173 cmd_line->AppendSwitch(::switches::kV8NativesPassedByFD);
174 if (snapshot_pf != -1) {
175 cmd_line->AppendSwitch(::switches::kV8SnapshotPassedByFD);
178 #endif // defined(V8_USE_EXTERNAL_STARTUP_DATA)
179 #endif // defined(OS_POSIX) && !defined(OS_MACOSX)
181 #if defined(OS_ANDROID)
182 files_to_register->Share(
183 kAndroidICUDataDescriptor,
184 base::i18n::GetIcuDataFileHandle(&regions[kAndroidICUDataDescriptor]));
186 // Android WebView runs in single process, ensure that we never get here
187 // when running in single process mode.
188 CHECK(!cmd_line->HasSwitch(switches::kSingleProcess));
190 StartChildProcess(
191 cmd_line->argv(), child_process_id, files_to_register.Pass(), regions,
192 base::Bind(&OnChildProcessStartedAndroid, callback, client_thread_id,
193 begin_launch_time, base::Passed(&ipcfd)));
195 #elif defined(OS_POSIX)
196 // We need to close the client end of the IPC channel to reliably detect
197 // child termination.
199 #if !defined(OS_MACOSX)
200 if (use_zygote) {
201 base::ProcessHandle handle = ZygoteHostImpl::GetInstance()->ForkRequest(
202 cmd_line->argv(), files_to_register.Pass(), process_type);
203 process = base::Process(handle);
204 } else
205 // Fall through to the normal posix case below when we're not zygoting.
206 #endif // !defined(OS_MACOSX)
208 // Convert FD mapping to FileHandleMappingVector
209 base::FileHandleMappingVector fds_to_map =
210 files_to_register->GetMappingWithIDAdjustment(
211 base::GlobalDescriptors::kBaseDescriptor);
213 #if !defined(OS_MACOSX)
214 if (process_type == switches::kRendererProcess) {
215 const int sandbox_fd =
216 RenderSandboxHostLinux::GetInstance()->GetRendererSocket();
217 fds_to_map.push_back(std::make_pair(
218 sandbox_fd,
219 GetSandboxFD()));
221 #endif // defined(OS_MACOSX)
223 // Actually launch the app.
224 base::LaunchOptions options;
225 options.environ = env;
226 options.fds_to_remap = &fds_to_map;
228 #if defined(OS_MACOSX)
229 // Hold the MachBroker lock for the duration of LaunchProcess. The child
230 // will send its task port to the parent almost immediately after startup.
231 // The Mach message will be delivered to the parent, but updating the
232 // record of the launch will wait until after the placeholder PID is
233 // inserted below. This ensures that while the child process may send its
234 // port to the parent prior to the parent leaving LaunchProcess, the
235 // order in which the record in MachBroker is updated is correct.
236 MachBroker* broker = MachBroker::GetInstance();
237 broker->GetLock().Acquire();
239 // Make sure the MachBroker is running, and inform it to expect a
240 // check-in from the new process.
241 broker->EnsureRunning();
243 // Make sure the IOSurfaceManager service is running.
244 BrowserIOSurfaceManager::GetInstance()->EnsureRunning();
246 const int bootstrap_sandbox_policy = delegate->GetSandboxType();
247 scoped_ptr<sandbox::PreExecDelegate> pre_exec_delegate;
248 if (ShouldEnableBootstrapSandbox() &&
249 bootstrap_sandbox_policy != SANDBOX_TYPE_INVALID) {
250 pre_exec_delegate =
251 GetBootstrapSandbox()->NewClient(bootstrap_sandbox_policy).Pass();
253 options.pre_exec_delegate = pre_exec_delegate.get();
254 #endif // defined(OS_MACOSX)
256 process = base::LaunchProcess(*cmd_line, options);
258 #if defined(OS_MACOSX)
259 if (process.IsValid()) {
260 broker->AddPlaceholderForPid(process.Pid(), child_process_id);
261 } else {
262 if (pre_exec_delegate) {
263 GetBootstrapSandbox()->RevokeToken(
264 pre_exec_delegate->sandbox_token());
268 // After updating the broker, release the lock and let the child's
269 // messasge be processed on the broker's thread.
270 broker->GetLock().Release();
271 #endif // defined(OS_MACOSX)
273 #endif // else defined(OS_POSIX)
274 #if !defined(OS_ANDROID)
275 if (process.IsValid()) {
276 RecordHistogramsOnLauncherThread(base::TimeTicks::Now() -
277 begin_launch_time);
279 BrowserThread::PostTask(client_thread_id, FROM_HERE,
280 base::Bind(callback,
281 use_zygote,
282 base::Passed(&process)));
283 #endif // !defined(OS_ANDROID)
286 void TerminateOnLauncherThread(bool zygote, base::Process process) {
287 DCHECK_CURRENTLY_ON(BrowserThread::PROCESS_LAUNCHER);
288 #if defined(OS_ANDROID)
289 VLOG(1) << "ChromeProcess: Stopping process with handle "
290 << process.Handle();
291 StopChildProcess(process.Handle());
292 #else
293 // Client has gone away, so just kill the process. Using exit code 0
294 // means that UMA won't treat this as a crash.
295 process.Terminate(RESULT_CODE_NORMAL_EXIT, false);
296 // On POSIX, we must additionally reap the child.
297 #if defined(OS_POSIX)
298 #if !defined(OS_MACOSX)
299 if (zygote) {
300 // If the renderer was created via a zygote, we have to proxy the reaping
301 // through the zygote process.
302 ZygoteHostImpl::GetInstance()->EnsureProcessTerminated(process.Handle());
303 } else
304 #endif // !OS_MACOSX
305 base::EnsureProcessTerminated(process.Pass());
306 #endif // OS_POSIX
307 #endif // defined(OS_ANDROID)
310 void SetProcessBackgroundedOnLauncherThread(base::Process process,
311 bool background) {
312 DCHECK_CURRENTLY_ON(BrowserThread::PROCESS_LAUNCHER);
313 #if defined(OS_MACOSX)
314 MachBroker* broker = MachBroker::GetInstance();
315 mach_port_t task_port = broker->TaskForPid(process.Pid());
316 if (task_port != TASK_NULL) {
317 process.SetProcessBackgrounded(task_port, background);
319 #else
320 process.SetProcessBackgrounded(background);
321 #endif // defined(OS_MACOSX)
322 #if defined(OS_ANDROID)
323 SetChildProcessInForeground(process.Handle(), !background);
324 #endif
327 } // anonymous namespace
329 ChildProcessLauncher::ChildProcessLauncher(
330 SandboxedProcessLauncherDelegate* delegate,
331 base::CommandLine* cmd_line,
332 int child_process_id,
333 Client* client,
334 bool terminate_on_shutdown)
335 : client_(client),
336 termination_status_(base::TERMINATION_STATUS_NORMAL_TERMINATION),
337 exit_code_(RESULT_CODE_NORMAL_EXIT),
338 zygote_(false),
339 starting_(true),
340 #if defined(ADDRESS_SANITIZER) || defined(LEAK_SANITIZER) || \
341 defined(MEMORY_SANITIZER) || defined(THREAD_SANITIZER) || \
342 defined(UNDEFINED_SANITIZER)
343 terminate_child_on_shutdown_(false),
344 #else
345 terminate_child_on_shutdown_(terminate_on_shutdown),
346 #endif
347 weak_factory_(this) {
348 DCHECK(CalledOnValidThread());
349 CHECK(BrowserThread::GetCurrentThreadIdentifier(&client_thread_id_));
350 Launch(delegate, cmd_line, child_process_id);
353 ChildProcessLauncher::~ChildProcessLauncher() {
354 DCHECK(CalledOnValidThread());
355 if (process_.IsValid() && terminate_child_on_shutdown_) {
356 // On Posix, EnsureProcessTerminated can lead to 2 seconds of sleep! So
357 // don't this on the UI/IO threads.
358 BrowserThread::PostTask(BrowserThread::PROCESS_LAUNCHER, FROM_HERE,
359 base::Bind(&TerminateOnLauncherThread, zygote_,
360 base::Passed(&process_)));
364 void ChildProcessLauncher::Launch(
365 SandboxedProcessLauncherDelegate* delegate,
366 base::CommandLine* cmd_line,
367 int child_process_id) {
368 DCHECK(CalledOnValidThread());
370 #if defined(OS_ANDROID)
371 // Android only supports renderer, sandboxed utility and gpu.
372 std::string process_type =
373 cmd_line->GetSwitchValueASCII(switches::kProcessType);
374 CHECK(process_type == switches::kGpuProcess ||
375 process_type == switches::kRendererProcess ||
376 #if defined(ENABLE_PLUGINS)
377 process_type == switches::kPpapiPluginProcess ||
378 #endif
379 process_type == switches::kUtilityProcess)
380 << "Unsupported process type: " << process_type;
382 // Non-sandboxed utility or renderer process are currently not supported.
383 DCHECK(process_type == switches::kGpuProcess ||
384 !cmd_line->HasSwitch(switches::kNoSandbox));
386 // We need to close the client end of the IPC channel to reliably detect
387 // child termination. We will close this fd after we create the child
388 // process which is asynchronous on Android.
389 base::ScopedFD ipcfd(delegate->TakeIpcFd().release());
390 #endif
391 NotifyCallback reply_callback(base::Bind(&ChildProcessLauncher::DidLaunch,
392 weak_factory_.GetWeakPtr(),
393 terminate_child_on_shutdown_));
394 BrowserThread::PostTask(
395 BrowserThread::PROCESS_LAUNCHER, FROM_HERE,
396 base::Bind(&LaunchOnLauncherThread, reply_callback, client_thread_id_,
397 child_process_id, delegate,
398 #if defined(OS_ANDROID)
399 base::Passed(&ipcfd),
400 #endif
401 cmd_line));
404 void ChildProcessLauncher::UpdateTerminationStatus(bool known_dead) {
405 DCHECK(CalledOnValidThread());
406 #if defined(OS_POSIX) && !defined(OS_MACOSX) && !defined(OS_ANDROID)
407 if (zygote_) {
408 termination_status_ = ZygoteHostImpl::GetInstance()->
409 GetTerminationStatus(process_.Handle(), known_dead, &exit_code_);
410 } else if (known_dead) {
411 termination_status_ =
412 base::GetKnownDeadTerminationStatus(process_.Handle(), &exit_code_);
413 } else {
414 #elif defined(OS_MACOSX)
415 if (known_dead) {
416 termination_status_ =
417 base::GetKnownDeadTerminationStatus(process_.Handle(), &exit_code_);
418 } else {
419 #elif defined(OS_ANDROID)
420 if (IsChildProcessOomProtected(process_.Handle())) {
421 termination_status_ = base::TERMINATION_STATUS_OOM_PROTECTED;
422 } else {
423 #else
425 #endif
426 termination_status_ =
427 base::GetTerminationStatus(process_.Handle(), &exit_code_);
431 void ChildProcessLauncher::SetProcessBackgrounded(bool background) {
432 DCHECK(CalledOnValidThread());
433 base::Process to_pass = process_.Duplicate();
434 BrowserThread::PostTask(BrowserThread::PROCESS_LAUNCHER, FROM_HERE,
435 base::Bind(&SetProcessBackgroundedOnLauncherThread,
436 base::Passed(&to_pass), background));
439 void ChildProcessLauncher::DidLaunch(
440 base::WeakPtr<ChildProcessLauncher> instance,
441 bool terminate_on_shutdown,
442 bool zygote,
443 #if defined(OS_ANDROID)
444 base::ScopedFD ipcfd,
445 #endif
446 base::Process process) {
447 if (!process.IsValid())
448 LOG(ERROR) << "Failed to launch child process";
450 // TODO(erikchen): Remove ScopedTracker below once http://crbug.com/465841
451 // is fixed.
452 tracked_objects::ScopedTracker tracking_profile1(
453 FROM_HERE_WITH_EXPLICIT_FUNCTION(
454 "465841 ChildProcessLauncher::Context::Notify::Start"));
456 if (instance.get()) {
457 instance->Notify(zygote,
458 #if defined(OS_ANDROID)
459 ipcfd.Pass(),
460 #endif
461 process.Pass());
462 } else {
463 // TODO(erikchen): Remove ScopedTracker below once http://crbug.com/465841
464 // is fixed.
465 tracked_objects::ScopedTracker tracking_profile4(
466 FROM_HERE_WITH_EXPLICIT_FUNCTION(
467 "465841 ChildProcessLauncher::Context::Notify::ProcessTerminate"));
468 if (process.IsValid() && terminate_on_shutdown) {
469 // On Posix, EnsureProcessTerminated can lead to 2 seconds of sleep! So
470 // don't this on the UI/IO threads.
471 BrowserThread::PostTask(BrowserThread::PROCESS_LAUNCHER, FROM_HERE,
472 base::Bind(&TerminateOnLauncherThread, zygote,
473 base::Passed(&process)));
478 void ChildProcessLauncher::Notify(
479 bool zygote,
480 #if defined(OS_ANDROID)
481 base::ScopedFD ipcfd,
482 #endif
483 base::Process process) {
484 DCHECK(CalledOnValidThread());
485 starting_ = false;
486 process_ = process.Pass();
488 #if defined(OS_POSIX) && !defined(OS_MACOSX) && !defined(OS_ANDROID)
489 zygote_ = zygote;
490 #endif
491 if (process_.IsValid()) {
492 // TODO(erikchen): Remove ScopedTracker below once http://crbug.com/465841
493 // is fixed.
494 tracked_objects::ScopedTracker tracking_profile2(
495 FROM_HERE_WITH_EXPLICIT_FUNCTION(
496 "465841 ChildProcessLauncher::Context::Notify::ProcessLaunched"));
497 client_->OnProcessLaunched();
498 } else {
499 // TODO(erikchen): Remove ScopedTracker below once http://crbug.com/465841
500 // is fixed.
501 tracked_objects::ScopedTracker tracking_profile3(
502 FROM_HERE_WITH_EXPLICIT_FUNCTION(
503 "465841 ChildProcessLauncher::Context::Notify::ProcessFailed"));
504 termination_status_ = base::TERMINATION_STATUS_LAUNCH_FAILED;
505 client_->OnProcessLaunchFailed();
509 bool ChildProcessLauncher::IsStarting() {
510 // TODO(crbug.com/469248): This fails in some tests.
511 // DCHECK(CalledOnValidThread());
512 return starting_;
515 const base::Process& ChildProcessLauncher::GetProcess() const {
516 // TODO(crbug.com/469248): This fails in some tests.
517 // DCHECK(CalledOnValidThread());
518 return process_;
521 base::TerminationStatus ChildProcessLauncher::GetChildTerminationStatus(
522 bool known_dead,
523 int* exit_code) {
524 DCHECK(CalledOnValidThread());
525 if (!process_.IsValid()) {
526 // Process is already gone, so return the cached termination status.
527 if (exit_code)
528 *exit_code = exit_code_;
529 return termination_status_;
532 UpdateTerminationStatus(known_dead);
533 if (exit_code)
534 *exit_code = exit_code_;
536 // POSIX: If the process crashed, then the kernel closed the socket
537 // for it and so the child has already died by the time we get
538 // here. Since GetTerminationStatus called waitpid with WNOHANG,
539 // it'll reap the process. However, if GetTerminationStatus didn't
540 // reap the child (because it was still running), we'll need to
541 // Terminate via ProcessWatcher. So we can't close the handle here.
542 if (termination_status_ != base::TERMINATION_STATUS_STILL_RUNNING)
543 process_.Close();
545 return termination_status_;
548 ChildProcessLauncher::Client* ChildProcessLauncher::ReplaceClientForTest(
549 Client* client) {
550 Client* ret = client_;
551 client_ = client;
552 return ret;
555 } // namespace content