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.
5 #ifndef CONTENT_PUBLIC_BROWSER_RENDER_PROCESS_HOST_H_
6 #define CONTENT_PUBLIC_BROWSER_RENDER_PROCESS_HOST_H_
8 #include "base/basictypes.h"
9 #include "base/id_map.h"
10 #include "base/process/kill.h"
11 #include "base/process/process_handle.h"
12 #include "base/supports_user_data.h"
13 #include "content/common/content_export.h"
14 #include "ipc/ipc_channel_proxy.h"
15 #include "ipc/ipc_sender.h"
16 #include "ui/gfx/native_widget_types.h"
19 struct ViewMsg_SwapOut_Params;
27 class BrowserMessageFilter;
28 class RenderProcessHostObserver;
29 class RenderWidgetHost;
30 class StoragePartition;
31 struct GlobalRequestID;
33 // Interface that represents the browser side of the browser <-> renderer
34 // communication channel. There will generally be one RenderProcessHost per
36 class CONTENT_EXPORT RenderProcessHost : public IPC::Sender,
38 public base::SupportsUserData {
40 typedef IDMap<RenderProcessHost>::iterator iterator;
42 // Details for RENDERER_PROCESS_CLOSED notifications.
43 struct RendererClosedDetails {
44 RendererClosedDetails(base::ProcessHandle handle,
45 base::TerminationStatus status,
47 this->handle = handle;
48 this->status = status;
49 this->exit_code = exit_code;
51 base::ProcessHandle handle;
52 base::TerminationStatus status;
56 // General functions ---------------------------------------------------------
58 virtual ~RenderProcessHost() {}
60 // Initialize the new renderer process, returning true on success. This must
61 // be called once before the object can be used, but can be called after
62 // that with no effect. Therefore, if the caller isn't sure about whether
63 // the process has been created, it should just call Init().
64 virtual bool Init() = 0;
66 // Gets the next available routing id.
67 virtual int GetNextRoutingID() = 0;
69 // These methods add or remove listener for a specific message routing ID.
70 // Used for refcounting, each holder of this object must AddRoute and
71 // RemoveRoute. This object should be allocated on the heap; when no
72 // listeners own it any more, it will delete itself.
73 virtual void AddRoute(int32 routing_id, IPC::Listener* listener) = 0;
74 virtual void RemoveRoute(int32 routing_id) = 0;
76 // Add and remove observers for lifecycle events. The order in which
77 // notifications are sent to observers is undefined. Observers must be sure to
78 // remove the observer before they go away.
79 virtual void AddObserver(RenderProcessHostObserver* observer) = 0;
80 virtual void RemoveObserver(RenderProcessHostObserver* observer) = 0;
82 // Called to wait for the next UpdateRect message for the specified render
83 // widget. Returns true if successful, and the msg out-param will contain a
84 // copy of the received UpdateRect message.
85 virtual bool WaitForBackingStoreMsg(int render_widget_id,
86 const base::TimeDelta& max_delay,
87 IPC::Message* msg) = 0;
89 // Called when a received message cannot be decoded.
90 virtual void ReceivedBadMessage() = 0;
92 // Track the count of visible widgets. Called by listeners to register and
93 // unregister visibility.
94 virtual void WidgetRestored() = 0;
95 virtual void WidgetHidden() = 0;
96 virtual int VisibleWidgetCount() const = 0;
98 // Indicates whether the current RenderProcessHost associated with a guest
100 virtual bool IsGuest() const = 0;
102 // Returns the storage partition associated with this process.
104 // TODO(nasko): Remove this function from the public API once
105 // URLRequestContextGetter's creation is moved into StoragePartition.
106 // http://crbug.com/158595
107 virtual StoragePartition* GetStoragePartition() const = 0;
109 // Try to shutdown the associated renderer process as fast as possible.
110 // If this renderer has any RenderViews with unload handlers, then this
111 // function does nothing. The current implementation uses TerminateProcess.
112 // Returns True if it was able to do fast shutdown.
113 virtual bool FastShutdownIfPossible() = 0;
115 // Returns true if fast shutdown was started for the renderer.
116 virtual bool FastShutdownStarted() const = 0;
118 // Dump the child process' handle table before shutting down.
119 virtual void DumpHandles() = 0;
121 // Returns the process object associated with the child process. In certain
122 // tests or single-process mode, this will actually represent the current
125 // NOTE: this is not necessarily valid immediately after calling Init, as
126 // Init starts the process asynchronously. It's guaranteed to be valid after
127 // the first IPC arrives.
128 virtual base::ProcessHandle GetHandle() const = 0;
130 // Returns the user browser context associated with this renderer process.
131 virtual content::BrowserContext* GetBrowserContext() const = 0;
133 // Returns whether this process is using the same StoragePartition as
135 virtual bool InSameStoragePartition(StoragePartition* partition) const = 0;
137 // Returns the unique ID for this child process host. This can be used later
138 // in a call to FromID() to get back to this object (this is used to avoid
139 // sending non-threadsafe pointers to other threads).
141 // This ID will be unique across all child process hosts, including workers,
144 // This will never return ChildProcessHost::kInvalidUniqueID.
145 virtual int GetID() const = 0;
147 // Returns true iff channel_ has been set to non-NULL. Use this for checking
148 // if there is connection or not. Virtual for mocking out for tests.
149 virtual bool HasConnection() const = 0;
151 // Call this to allow queueing of IPC messages that are sent before the
152 // process is launched.
153 virtual void EnableSendQueue() = 0;
155 // Returns the renderer channel.
156 virtual IPC::ChannelProxy* GetChannel() = 0;
158 // Adds a message filter to the IPC channel.
159 virtual void AddFilter(BrowserMessageFilter* filter) = 0;
161 // Try to shutdown the associated render process as fast as possible
162 virtual bool FastShutdownForPageCount(size_t count) = 0;
165 // Revisit whether the virtual functions declared from here on need to be
166 // part of the interface.
167 virtual void SetIgnoreInputEvents(bool ignore_input_events) = 0;
168 virtual bool IgnoreInputEvents() const = 0;
170 // Schedules the host for deletion and removes it from the all_hosts list.
171 virtual void Cleanup() = 0;
173 // Track the count of pending views that are being swapped back in. Called
174 // by listeners to register and unregister pending views to prevent the
175 // process from exiting.
176 virtual void AddPendingView() = 0;
177 virtual void RemovePendingView() = 0;
179 // Sets a flag indicating that the process can be abnormally terminated.
180 virtual void SetSuddenTerminationAllowed(bool allowed) = 0;
181 // Returns true if the process can be abnormally terminated.
182 virtual bool SuddenTerminationAllowed() const = 0;
184 // Returns how long the child has been idle. The definition of idle
185 // depends on when a derived class calls mark_child_process_activity_time().
186 // This is a rough indicator and its resolution should not be better than
188 virtual base::TimeDelta GetChildProcessIdleTime() const = 0;
190 // Called to resume the requests for a view created through window.open that
191 // were initially blocked.
192 virtual void ResumeRequestsForView(int route_id) = 0;
194 // Checks that the given renderer can request |url|, if not it sets it to
196 // |empty_allowed| must be set to false for navigations for security reasons.
197 virtual void FilterURL(bool empty_allowed, GURL* url) = 0;
199 #if defined(ENABLE_WEBRTC)
200 virtual void EnableAecDump(const base::FilePath& file) = 0;
201 virtual void DisableAecDump() = 0;
203 // When set, |callback| receives log messages regarding, for example, media
204 // devices (webcams, mics, etc) that were initially requested in the render
205 // process associated with this RenderProcessHost.
206 virtual void SetWebRtcLogMessageCallback(
207 base::Callback<void(const std::string&)> callback) = 0;
210 // Tells the ResourceDispatcherHost to resume a deferred navigation without
211 // transferring it to a new renderer process.
212 virtual void ResumeDeferredNavigation(const GlobalRequestID& request_id) = 0;
214 // Notifies the renderer that the timezone configuration of the system might
216 virtual void NotifyTimezoneChange() = 0;
218 // Static management functions -----------------------------------------------
220 // Flag to run the renderer in process. This is primarily
221 // for debugging purposes. When running "in process", the
222 // browser maintains a single RenderProcessHost which communicates
223 // to a RenderProcess which is instantiated in the same process
224 // with the Browser. All IPC between the Browser and the
225 // Renderer is the same, it's just not crossing a process boundary.
227 static bool run_renderer_in_process();
229 // This also calls out to ContentBrowserClient::GetApplicationLocale and
230 // modifies the current process' command line.
231 static void SetRunRendererInProcess(bool value);
233 // Allows iteration over all the RenderProcessHosts in the browser. Note
234 // that each host may not be active, and therefore may have NULL channels.
235 static iterator AllHostsIterator();
237 // Returns the RenderProcessHost given its ID. Returns NULL if the ID does
238 // not correspond to a live RenderProcessHost.
239 static RenderProcessHost* FromID(int render_process_id);
241 // Returns whether the process-per-site model is in use (globally or just for
242 // the current site), in which case we should ensure there is only one
243 // RenderProcessHost per site for the entire browser context.
244 static bool ShouldUseProcessPerSite(content::BrowserContext* browser_context,
247 // Returns true if the caller should attempt to use an existing
248 // RenderProcessHost rather than creating a new one.
249 static bool ShouldTryToUseExistingProcessHost(
250 content::BrowserContext* browser_context, const GURL& site_url);
252 // Get an existing RenderProcessHost associated with the given browser
253 // context, if possible. The renderer process is chosen randomly from
254 // suitable renderers that share the same context and type (determined by the
256 // Returns NULL if no suitable renderer process is available, in which case
257 // the caller is free to create a new renderer.
258 static RenderProcessHost* GetExistingProcessHost(
259 content::BrowserContext* browser_context, const GURL& site_url);
261 // Overrides the default heuristic for limiting the max renderer process
262 // count. This is useful for unit testing process limit behaviors. It is
263 // also used to allow a command line parameter to configure the max number of
264 // renderer processes and should only be called once during startup.
265 // A value of zero means to use the default heuristic.
266 static void SetMaxRendererProcessCount(size_t count);
268 // Returns the current max number of renderer processes used by the content
270 static size_t GetMaxRendererProcessCount();
273 } // namespace content.
275 #endif // CONTENT_PUBLIC_BROWSER_RENDER_PROCESS_HOST_H_