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 #ifndef CONTENT_PUBLIC_BROWSER_RENDER_PROCESS_HOST_H_ 6 #define CONTENT_PUBLIC_BROWSER_RENDER_PROCESS_HOST_H_ 7 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 "content/common/content_export.h" 13 #include "ipc/ipc_channel_proxy.h" 14 #include "ipc/ipc_sender.h" 15 #include "ui/gfx/native_widget_types.h" 16 #include "ui/surface/transport_dib.h" 17 18 class GURL; 19 struct ViewMsg_SwapOut_Params; 20 21 namespace content { 22 class BrowserContext; 23 class RenderWidgetHost; 24 class StoragePartition; 25 } 26 27 namespace base { 28 class TimeDelta; 29 } 30 31 namespace content { 32 33 // Interface that represents the browser side of the browser <-> renderer 34 // communication channel. There will generally be one RenderProcessHost per 35 // renderer process. 36 class CONTENT_EXPORT RenderProcessHost : public IPC::Sender, 37 public IPC::Listener { 38 public: 39 typedef IDMap<RenderProcessHost>::iterator iterator; 40 41 // Details for RENDERER_PROCESS_CLOSED notifications. 42 struct RendererClosedDetails { 43 RendererClosedDetails(base::ProcessHandle handle, 44 base::TerminationStatus status, 45 int exit_code) { 46 this->handle = handle; 47 this->status = status; 48 this->exit_code = exit_code; 49 } 50 base::ProcessHandle handle; 51 base::TerminationStatus status; 52 int exit_code; 53 }; 54 55 virtual ~RenderProcessHost() {} 56 57 // Initialize the new renderer process, returning true on success. This must 58 // be called once before the object can be used, but can be called after 59 // that with no effect. Therefore, if the caller isn't sure about whether 60 // the process has been created, it should just call Init(). 61 virtual bool Init() = 0; 62 63 // Gets the next available routing id. 64 virtual int GetNextRoutingID() = 0; 65 66 // These methods add or remove listener for a specific message routing ID. 67 // Used for refcounting, each holder of this object must AddRoute and 68 // RemoveRoute. This object should be allocated on the heap; when no 69 // listeners own it any more, it will delete itself. 70 virtual void AddRoute(int32 routing_id, IPC::Listener* listener) = 0; 71 virtual void RemoveRoute(int32 routing_id) = 0; 72 73 // Called to wait for the next UpdateRect message for the specified render 74 // widget. Returns true if successful, and the msg out-param will contain a 75 // copy of the received UpdateRect message. 76 virtual bool WaitForBackingStoreMsg(int render_widget_id, 77 const base::TimeDelta& max_delay, 78 IPC::Message* msg) = 0; 79 80 // Called when a received message cannot be decoded. 81 virtual void ReceivedBadMessage() = 0; 82 83 // Track the count of visible widgets. Called by listeners to register and 84 // unregister visibility. 85 virtual void WidgetRestored() = 0; 86 virtual void WidgetHidden() = 0; 87 virtual int VisibleWidgetCount() const = 0; 88 89 // Indicates whether the current RenderProcessHost associated with a guest 90 // renderer process. 91 virtual bool IsGuest() const = 0; 92 93 // Returns the storage partition associated with this process. 94 // 95 // TODO(nasko): Remove this function from the public API once 96 // URLRequestContextGetter's creation is moved into StoragePartition. 97 // http://crbug.com/158595 98 virtual StoragePartition* GetStoragePartition() const = 0; 99 100 // Try to shutdown the associated renderer process as fast as possible. 101 // If this renderer has any RenderViews with unload handlers, then this 102 // function does nothing. The current implementation uses TerminateProcess. 103 // Returns True if it was able to do fast shutdown. 104 virtual bool FastShutdownIfPossible() = 0; 105 106 // Returns true if fast shutdown was started for the renderer. 107 virtual bool FastShutdownStarted() const = 0; 108 109 // Dump the child process' handle table before shutting down. 110 virtual void DumpHandles() = 0; 111 112 // Returns the process object associated with the child process. In certain 113 // tests or single-process mode, this will actually represent the current 114 // process. 115 // 116 // NOTE: this is not necessarily valid immediately after calling Init, as 117 // Init starts the process asynchronously. It's guaranteed to be valid after 118 // the first IPC arrives. 119 virtual base::ProcessHandle GetHandle() const = 0; 120 121 // Transport DIB functions --------------------------------------------------- 122 123 // Return the TransportDIB for the given id. On Linux, this can involve 124 // mapping shared memory. On Mac, the shared memory is created in the browser 125 // process and the cached metadata is returned. On Windows, this involves 126 // duplicating the handle from the remote process. The RenderProcessHost 127 // still owns the returned DIB. 128 virtual TransportDIB* GetTransportDIB(TransportDIB::Id dib_id) = 0; 129 130 // Return the TransportDIB for the given id. In contrast to GetTransportDIB, 131 // the caller owns the resulting TransportDIB. 132 virtual TransportDIB* MapTransportDIB(TransportDIB::Id dib_id) = 0; 133 134 // Returns the user browser context associated with this renderer process. 135 virtual content::BrowserContext* GetBrowserContext() const = 0; 136 137 // Returns whether this process is using the same StoragePartition as 138 // |partition|. 139 virtual bool InSameStoragePartition(StoragePartition* partition) const = 0; 140 141 // Returns the unique ID for this child process. This can be used later in 142 // a call to FromID() to get back to this object (this is used to avoid 143 // sending non-threadsafe pointers to other threads). 144 // 145 // This ID will be unique for all child processes, including workers, plugins, 146 // etc. 147 virtual int GetID() const = 0; 148 149 // Returns true iff channel_ has been set to non-NULL. Use this for checking 150 // if there is connection or not. Virtual for mocking out for tests. 151 virtual bool HasConnection() const = 0; 152 153 // Call this to allow queueing of IPC messages that are sent before the 154 // process is launched. 155 virtual void EnableSendQueue() = 0; 156 157 // Returns the renderer channel. 158 virtual IPC::ChannelProxy* GetChannel() = 0; 159 160 // Try to shutdown the associated render process as fast as possible 161 virtual bool FastShutdownForPageCount(size_t count) = 0; 162 163 // TODO(ananta) 164 // Revisit whether the virtual functions declared from here on need to be 165 // part of the interface. 166 virtual void SetIgnoreInputEvents(bool ignore_input_events) = 0; 167 virtual bool IgnoreInputEvents() const = 0; 168 169 // Schedules the host for deletion and removes it from the all_hosts list. 170 virtual void Cleanup() = 0; 171 172 // Track the count of pending views that are being swapped back in. Called 173 // by listeners to register and unregister pending views to prevent the 174 // process from exiting. 175 virtual void AddPendingView() = 0; 176 virtual void RemovePendingView() = 0; 177 178 // Sets a flag indicating that the process can be abnormally terminated. 179 virtual void SetSuddenTerminationAllowed(bool allowed) = 0; 180 // Returns true if the process can be abnormally terminated. 181 virtual bool SuddenTerminationAllowed() const = 0; 182 183 // Returns how long the child has been idle. The definition of idle 184 // depends on when a derived class calls mark_child_process_activity_time(). 185 // This is a rough indicator and its resolution should not be better than 186 // 10 milliseconds. 187 virtual base::TimeDelta GetChildProcessIdleTime() const = 0; 188 189 // Signals that a compositing surface has been updated after a lost context 190 // event, so that we can process requests from the renderer to create contexts 191 // with that surface. 192 virtual void SurfaceUpdated(int32 surface_id) = 0; 193 194 // Called to resume the requests for a view created through window.open that 195 // were initially blocked. 196 virtual void ResumeRequestsForView(int route_id) = 0; 197 198 // Static management functions ----------------------------------------------- 199 200 // Flag to run the renderer in process. This is primarily 201 // for debugging purposes. When running "in process", the 202 // browser maintains a single RenderProcessHost which communicates 203 // to a RenderProcess which is instantiated in the same process 204 // with the Browser. All IPC between the Browser and the 205 // Renderer is the same, it's just not crossing a process boundary. 206 207 static bool run_renderer_in_process(); 208 209 // This also calls out to ContentBrowserClient::GetApplicationLocale and 210 // modifies the current process' command line. 211 static void SetRunRendererInProcess(bool value); 212 213 // Allows iteration over all the RenderProcessHosts in the browser. Note 214 // that each host may not be active, and therefore may have NULL channels. 215 static iterator AllHostsIterator(); 216 217 // Returns the RenderProcessHost given its ID. Returns NULL if the ID does 218 // not correspond to a live RenderProcessHost. 219 static RenderProcessHost* FromID(int render_process_id); 220 221 // Returns whether the process-per-site model is in use (globally or just for 222 // the current site), in which case we should ensure there is only one 223 // RenderProcessHost per site for the entire browser context. 224 static bool ShouldUseProcessPerSite(content::BrowserContext* browser_context, 225 const GURL& url); 226 227 // Returns true if the caller should attempt to use an existing 228 // RenderProcessHost rather than creating a new one. 229 static bool ShouldTryToUseExistingProcessHost( 230 content::BrowserContext* browser_context, const GURL& site_url); 231 232 // Get an existing RenderProcessHost associated with the given browser 233 // context, if possible. The renderer process is chosen randomly from 234 // suitable renderers that share the same context and type (determined by the 235 // site url). 236 // Returns NULL if no suitable renderer process is available, in which case 237 // the caller is free to create a new renderer. 238 static RenderProcessHost* GetExistingProcessHost( 239 content::BrowserContext* browser_context, const GURL& site_url); 240 241 // Overrides the default heuristic for limiting the max renderer process 242 // count. This is useful for unit testing process limit behaviors. It is 243 // also used to allow a command line parameter to configure the max number of 244 // renderer processes and should only be called once during startup. 245 // A value of zero means to use the default heuristic. 246 static void SetMaxRendererProcessCount(size_t count); 247 248 // Returns the current max number of renderer processes used by the content 249 // module. 250 static size_t GetMaxRendererProcessCount(); 251 }; 252 253 } // namespace content. 254 255 #endif // CONTENT_PUBLIC_BROWSER_RENDER_PROCESS_HOST_H_ 256