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)#ifndef CONTENT_PUBLIC_BROWSER_BROWSER_CHILD_PROCESS_HOST_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CONTENT_PUBLIC_BROWSER_BROWSER_CHILD_PROCESS_HOST_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 858537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles)#include "base/environment.h" 958e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch#include "base/process/kill.h" 1058e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch#include "base/process/process_handle.h" 1158e6fbe4ee35d65e14b626c557d37565bf8ad179Ben Murdoch#include "base/process/process_metrics.h" 127d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles)#include "base/strings/string16.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "build/build_config.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/common/content_export.h" 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/public/common/process_type.h" 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ipc/ipc_sender.h" 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 182a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)namespace base { 19a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)class CommandLine; 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class FilePath; 212a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)} 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace content { 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class BrowserChildProcessHostDelegate; 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class ChildProcessHost; 272a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class SandboxedProcessLauncherDelegate; 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct ChildProcessData; 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This represents child processes of the browser process, i.e. plugins. They 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// will get terminated at browser shutdown. 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class CONTENT_EXPORT BrowserChildProcessHost : public IPC::Sender { 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Used to create a child process host. The delegate must outlive this object. 352a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // |process_type| needs to be either an enum value from ProcessType or an 362a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // embedder-defined value. 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static BrowserChildProcessHost* Create( 382a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) int process_type, 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BrowserChildProcessHostDelegate* delegate); 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~BrowserChildProcessHost() {} 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Derived classes call this to launch the child process asynchronously. 442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Takes ownership of |cmd_line| and |delegate|. 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void Launch( 462a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) SandboxedProcessLauncherDelegate* delegate, 47a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) base::CommandLine* cmd_line) = 0; 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual const ChildProcessData& GetData() const = 0; 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the ChildProcessHost object used by this object. 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ChildProcessHost* GetHost() const = 0; 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the termination status of a child. |exit_code| is the 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // status returned when the process exited (for posix, as returned 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // from waitpid(), for Windows, as returned from 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // GetExitCodeProcess()). |exit_code| may be NULL. 58424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) // |known_dead| indicates that the child is already dead. On Linux, this 59424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) // information is necessary to retrieve accurate information. See 60424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) // ChildProcessLauncher::GetChildTerminationStatus() for more details. 61424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) virtual base::TerminationStatus GetTerminationStatus( 62424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) bool known_dead, int* exit_code) = 0; 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sets the user-visible name of the process. 65a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) virtual void SetName(const base::string16& name) = 0; 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Set the handle of the process. BrowserChildProcessHost will do this when 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the Launch method is used to start the process. However if the owner 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // of this object doesn't call Launch and starts the process in another way, 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // they need to call this method so that the process handle is associated with 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // this object. 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void SetHandle(base::ProcessHandle handle) = 0; 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(OS_MACOSX) && !defined(OS_IOS) 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns a PortProvider used to get process metrics for child processes. 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static base::ProcessMetrics::PortProvider* GetPortProvider(); 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; // namespace content 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // CONTENT_PUBLIC_BROWSER_BROWSER_CHILD_PROCESS_HOST_H_ 83