content/browser/renderer_host/render_process_host_impl.h

   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_BROWSER_RENDERER_HOST_BROWSER_RENDER_PROCESS_HOST_IMPL_H_
   6 #define CONTENT_BROWSER_RENDERER_HOST_BROWSER_RENDER_PROCESS_HOST_IMPL_H_
   7
   8 #include <map>
   9 #include <queue>
  10 #include <string>
  11
  12 #include "base/memory/scoped_ptr.h"
  13 #include "base/observer_list.h"
  14 #include "base/process/process.h"
  15 #include "base/timer/timer.h"
  16 #include "content/browser/child_process_launcher.h"
  17 #include "content/browser/geolocation/geolocation_dispatcher_host.h"
  18 #include "content/browser/power_monitor_message_broadcaster.h"
  19 #include "content/common/content_export.h"
  20 #include "content/public/browser/global_request_id.h"
  21 #include "content/public/browser/gpu_data_manager_observer.h"
  22 #include "content/public/browser/render_process_host.h"
  23 #include "ipc/ipc_channel_proxy.h"
  24 #include "ipc/ipc_platform_file.h"
  25 #include "ui/surface/transport_dib.h"
  26
  27 class CommandLine;
  28 struct ViewHostMsg_CompositorSurfaceBuffersSwapped_Params;
  29
  30 namespace base {
  31 class MessageLoop;
  32 }
  33
  34 namespace gfx {
  35 class Size;
  36 }
  37
  38 namespace content {
  39 class AudioRendererHost;
  40 class BrowserDemuxerAndroid;
  41 class GeolocationDispatcherHost;
  42 class GpuMessageFilter;
  43 class MessagePortMessageFilter;
  44 class PeerConnectionTrackerHost;
  45 class RendererMainThread;
  46 class RenderWidgetHelper;
  47 class RenderWidgetHost;
  48 class RenderWidgetHostImpl;
  49 class RenderWidgetHostViewFrameSubscriber;
  50 class StoragePartition;
  51 class StoragePartitionImpl;
  52
  53 // Implements a concrete RenderProcessHost for the browser process for talking
  54 // to actual renderer processes (as opposed to mocks).
  55 //
  56 // Represents the browser side of the browser <--> renderer communication
  57 // channel. There will be one RenderProcessHost per renderer process.
  58 //
  59 // This object is refcounted so that it can release its resources when all
  60 // hosts using it go away.
  61 //
  62 // This object communicates back and forth with the RenderProcess object
  63 // running in the renderer process. Each RenderProcessHost and RenderProcess
  64 // keeps a list of RenderView (renderer) and WebContentsImpl (browser) which
  65 // are correlated with IDs. This way, the Views and the corresponding ViewHosts
  66 // communicate through the two process objects.
  67 //
  68 // A RenderProcessHost is also associated with one and only one
  69 // StoragePartition.  This allows us to implement strong storage isolation
  70 // because all the IPCs from the RenderViews (renderer) will only ever be able
  71 // to access the partition they are assigned to.
  72 class CONTENT_EXPORT RenderProcessHostImpl
  73     : public RenderProcessHost,
  74       public ChildProcessLauncher::Client,
  75       public GpuDataManagerObserver {
  76  public:
  77   RenderProcessHostImpl(BrowserContext* browser_context,
  78                         StoragePartitionImpl* storage_partition_impl,
  79                         bool supports_browser_plugin,
  80                         bool is_guest);
  81   virtual ~RenderProcessHostImpl();
  82
  83   // RenderProcessHost implementation (public portion).
  84   virtual void EnableSendQueue() OVERRIDE;
  85   virtual bool Init() OVERRIDE;
  86   virtual int GetNextRoutingID() OVERRIDE;
  87   virtual void AddRoute(int32 routing_id, IPC::Listener* listener) OVERRIDE;
  88   virtual void RemoveRoute(int32 routing_id) OVERRIDE;
  89   virtual void AddObserver(RenderProcessHostObserver* observer) OVERRIDE;
  90   virtual void RemoveObserver(RenderProcessHostObserver* observer) OVERRIDE;
  91   virtual bool WaitForBackingStoreMsg(int render_widget_id,
  92                                       const base::TimeDelta& max_delay,
  93                                       IPC::Message* msg) OVERRIDE;
  94   virtual void ReceivedBadMessage() OVERRIDE;
  95   virtual void WidgetRestored() OVERRIDE;
  96   virtual void WidgetHidden() OVERRIDE;
  97   virtual int VisibleWidgetCount() const OVERRIDE;
  98   virtual bool IsGuest() const OVERRIDE;
  99   virtual StoragePartition* GetStoragePartition() const OVERRIDE;
 100   virtual bool FastShutdownIfPossible() OVERRIDE;
 101   virtual void DumpHandles() OVERRIDE;
 102   virtual base::ProcessHandle GetHandle() const OVERRIDE;
 103   virtual TransportDIB* GetTransportDIB(TransportDIB::Id dib_id) OVERRIDE;
 104   virtual TransportDIB* MapTransportDIB(TransportDIB::Id dib_id) OVERRIDE;
 105   virtual BrowserContext* GetBrowserContext() const OVERRIDE;
 106   virtual bool InSameStoragePartition(
 107       StoragePartition* partition) const OVERRIDE;
 108   virtual int GetID() const OVERRIDE;
 109   virtual bool HasConnection() const OVERRIDE;
 110   virtual void SetIgnoreInputEvents(bool ignore_input_events) OVERRIDE;
 111   virtual bool IgnoreInputEvents() const OVERRIDE;
 112   virtual void Cleanup() OVERRIDE;
 113   virtual void AddPendingView() OVERRIDE;
 114   virtual void RemovePendingView() OVERRIDE;
 115   virtual void SetSuddenTerminationAllowed(bool enabled) OVERRIDE;
 116   virtual bool SuddenTerminationAllowed() const OVERRIDE;
 117   virtual IPC::ChannelProxy* GetChannel() OVERRIDE;
 118   virtual void AddFilter(BrowserMessageFilter* filter) OVERRIDE;
 119   virtual bool FastShutdownForPageCount(size_t count) OVERRIDE;
 120   virtual bool FastShutdownStarted() const OVERRIDE;
 121   virtual base::TimeDelta GetChildProcessIdleTime() const OVERRIDE;
 122   virtual void SurfaceUpdated(int32 surface_id) OVERRIDE;
 123   virtual void ResumeRequestsForView(int route_id) OVERRIDE;
 124   virtual void FilterURL(bool empty_allowed, GURL* url) OVERRIDE;
 125 #if defined(ENABLE_WEBRTC)
 126   virtual void EnableAecDump(const base::FilePath& file) OVERRIDE;
 127   virtual void DisableAecDump() OVERRIDE;
 128 #endif
 129
 130   // IPC::Sender via RenderProcessHost.
 131   virtual bool Send(IPC::Message* msg) OVERRIDE;
 132
 133   // IPC::Listener via RenderProcessHost.
 134   virtual bool OnMessageReceived(const IPC::Message& msg) OVERRIDE;
 135   virtual void OnChannelConnected(int32 peer_pid) OVERRIDE;
 136   virtual void OnChannelError() OVERRIDE;
 137
 138   // ChildProcessLauncher::Client implementation.
 139   virtual void OnProcessLaunched() OVERRIDE;
 140
 141   scoped_refptr<AudioRendererHost> audio_renderer_host() const;
 142
 143   // Tells the ResourceDispatcherHost to resume a deferred navigation without
 144   // transferring it to a new renderer process.
 145   void ResumeDeferredNavigation(const GlobalRequestID& request_id);
 146
 147   // Call this function when it is evident that the child process is actively
 148   // performing some operation, for example if we just received an IPC message.
 149   void mark_child_process_activity_time() {
 150     child_process_activity_time_ = base::TimeTicks::Now();
 151   }
 152
 153   // Returns the current number of active views in this process.  Excludes
 154   // any RenderViewHosts that are swapped out.
 155   int GetActiveViewCount();
 156
 157   // Start and end frame subscription for a specific renderer.
 158   // This API only supports subscription to accelerated composited frames.
 159   void BeginFrameSubscription(
 160       int route_id,
 161       scoped_ptr<RenderWidgetHostViewFrameSubscriber> subscriber);
 162   void EndFrameSubscription(int route_id);
 163
 164   scoped_refptr<GeolocationDispatcherHost>
 165       geolocation_dispatcher_host() const {
 166     return make_scoped_refptr(geolocation_dispatcher_host_);
 167   }
 168
 169   // Register/unregister the host identified by the host id in the global host
 170   // list.
 171   static void RegisterHost(int host_id, RenderProcessHost* host);
 172   static void UnregisterHost(int host_id);
 173
 174   // Implementation of FilterURL below that can be shared with the mock class.
 175   static void FilterURL(RenderProcessHost* rph, bool empty_allowed, GURL* url);
 176
 177   // Returns true if |host| is suitable for launching a new view with |site_url|
 178   // in the given |browser_context|.
 179   static bool IsSuitableHost(RenderProcessHost* host,
 180                              BrowserContext* browser_context,
 181                              const GURL& site_url);
 182
 183   // Returns an existing RenderProcessHost for |url| in |browser_context|,
 184   // if one exists.  Otherwise a new RenderProcessHost should be created and
 185   // registered using RegisterProcessHostForSite().
 186   // This should only be used for process-per-site mode, which can be enabled
 187   // globally with a command line flag or per-site, as determined by
 188   // SiteInstanceImpl::ShouldUseProcessPerSite.
 189   static RenderProcessHost* GetProcessHostForSite(
 190       BrowserContext* browser_context,
 191       const GURL& url);
 192
 193   // Registers the given |process| to be used for any instance of |url|
 194   // within |browser_context|.
 195   // This should only be used for process-per-site mode, which can be enabled
 196   // globally with a command line flag or per-site, as determined by
 197   // SiteInstanceImpl::ShouldUseProcessPerSite.
 198   static void RegisterProcessHostForSite(
 199       BrowserContext* browser_context,
 200       RenderProcessHost* process,
 201       const GURL& url);
 202
 203   static base::MessageLoop* GetInProcessRendererThreadForTesting();
 204
 205   // This forces a renderer that is running "in process" to shut down.
 206   static void ShutDownInProcessRenderer();
 207
 208 #if defined(OS_ANDROID)
 209   const scoped_refptr<BrowserDemuxerAndroid>& browser_demuxer_android() {
 210     return browser_demuxer_android_;
 211   }
 212 #endif
 213
 214   MessagePortMessageFilter* message_port_message_filter() const {
 215     return message_port_message_filter_;
 216   }
 217
 218   void SetIsGuestForTesting(bool is_guest) {
 219     is_guest_ = is_guest;
 220   }
 221
 222  protected:
 223   // A proxy for our IPC::Channel that lives on the IO thread (see
 224   // browser_process.h)
 225   scoped_ptr<IPC::ChannelProxy> channel_;
 226
 227   // True if fast shutdown has been performed on this RPH.
 228   bool fast_shutdown_started_;
 229
 230   // True if we've posted a DeleteTask and will be deleted soon.
 231   bool deleting_soon_;
 232
 233 #ifndef NDEBUG
 234   // True if this object has deleted itself.
 235   bool is_self_deleted_;
 236 #endif
 237
 238   // The count of currently swapped out but pending RenderViews.  We have
 239   // started to swap these in, so the renderer process should not exit if
 240   // this count is non-zero.
 241   int32 pending_views_;
 242
 243  private:
 244   friend class VisitRelayingRenderProcessHost;
 245
 246   // Creates and adds the IO thread message filters.
 247   void CreateMessageFilters();
 248
 249   // Control message handlers.
 250   void OnShutdownRequest();
 251   void OnDumpHandlesDone();
 252   void SuddenTerminationChanged(bool enabled);
 253   void OnUserMetricsRecordAction(const std::string& action);
 254   void OnSavedPageAsMHTML(int job_id, int64 mhtml_file_size);
 255
 256   // CompositorSurfaceBuffersSwapped handler when there's no RWH.
 257   void OnCompositorSurfaceBuffersSwappedNoHost(
 258       const ViewHostMsg_CompositorSurfaceBuffersSwapped_Params& params);
 259
 260   // Generates a command line to be used to spawn a renderer and appends the
 261   // results to |*command_line|.
 262   void AppendRendererCommandLine(CommandLine* command_line) const;
 263
 264   // Copies applicable command line switches from the given |browser_cmd| line
 265   // flags to the output |renderer_cmd| line flags. Not all switches will be
 266   // copied over.
 267   void PropagateBrowserCommandLineToRenderer(const CommandLine& browser_cmd,
 268                                              CommandLine* renderer_cmd) const;
 269
 270   // Callers can reduce the RenderProcess' priority.
 271   void SetBackgrounded(bool backgrounded);
 272
 273   // Handle termination of our process.
 274   void ProcessDied(bool already_dead);
 275
 276   virtual void OnGpuSwitching() OVERRIDE;
 277
 278 #if defined(ENABLE_WEBRTC)
 279   // Sends |file_for_transit| to the render process.
 280   void SendAecDumpFileToRenderer(IPC::PlatformFileForTransit file_for_transit);
 281   void SendDisableAecDumpToRenderer();
 282 #endif
 283
 284   // The registered IPC listener objects. When this list is empty, we should
 285   // delete ourselves.
 286   IDMap<IPC::Listener> listeners_;
 287
 288   // The count of currently visible widgets.  Since the host can be a container
 289   // for multiple widgets, it uses this count to determine when it should be
 290   // backgrounded.
 291   int32 visible_widgets_;
 292
 293   // Does this process have backgrounded priority.
 294   bool backgrounded_;
 295
 296   // Used to allow a RenderWidgetHost to intercept various messages on the
 297   // IO thread.
 298   scoped_refptr<RenderWidgetHelper> widget_helper_;
 299
 300   // The filter for GPU-related messages coming from the renderer.
 301   // Thread safety note: this field is to be accessed from the UI thread.
 302   // We don't keep a reference to it, to avoid it being destroyed on the UI
 303   // thread, but we clear this field when we clear channel_. When channel_ goes
 304   // away, it posts a task to the IO thread to destroy it there, so we know that
 305   // it's valid if non-NULL.
 306   GpuMessageFilter* gpu_message_filter_;
 307
 308   // The filter for MessagePort messages coming from the renderer.
 309   scoped_refptr<MessagePortMessageFilter> message_port_message_filter_;
 310
 311   // A map of transport DIB ids to cached TransportDIBs
 312   std::map<TransportDIB::Id, TransportDIB*> cached_dibs_;
 313
 314   enum {
 315     // This is the maximum size of |cached_dibs_|
 316     MAX_MAPPED_TRANSPORT_DIBS = 3,
 317   };
 318
 319   void ClearTransportDIBCache();
 320   // This is used to clear our cache five seconds after the last use.
 321   base::DelayTimer<RenderProcessHostImpl> cached_dibs_cleaner_;
 322
 323   // Used in single-process mode.
 324   scoped_ptr<base::Thread> in_process_renderer_;
 325
 326   // True after Init() has been called. We can't just check channel_ because we
 327   // also reset that in the case of process termination.
 328   bool is_initialized_;
 329
 330   // Used to launch and terminate the process without blocking the UI thread.
 331   scoped_ptr<ChildProcessLauncher> child_process_launcher_;
 332
 333   // Messages we queue while waiting for the process handle.  We queue them here
 334   // instead of in the channel so that we ensure they're sent after init related
 335   // messages that are sent once the process handle is available.  This is
 336   // because the queued messages may have dependencies on the init messages.
 337   std::queue<IPC::Message*> queued_messages_;
 338
 339   // The globally-unique identifier for this RPH.
 340   int id_;
 341
 342   BrowserContext* browser_context_;
 343
 344   // Owned by |browser_context_|.
 345   StoragePartitionImpl* storage_partition_impl_;
 346
 347   // The observers watching our lifetime.
 348   ObserverList<RenderProcessHostObserver> observers_;
 349
 350   // True if the process can be shut down suddenly.  If this is true, then we're
 351   // sure that all the RenderViews in the process can be shutdown suddenly.  If
 352   // it's false, then specific RenderViews might still be allowed to be shutdown
 353   // suddenly by checking their SuddenTerminationAllowed() flag.  This can occur
 354   // if one WebContents has an unload event listener but another WebContents in
 355   // the same process doesn't.
 356   bool sudden_termination_allowed_;
 357
 358   // Set to true if we shouldn't send input events.  We actually do the
 359   // filtering for this at the render widget level.
 360   bool ignore_input_events_;
 361
 362   // Records the last time we regarded the child process active.
 363   base::TimeTicks child_process_activity_time_;
 364
 365   // Indicates whether this is a RenderProcessHost that has permission to embed
 366   // Browser Plugins.
 367   bool supports_browser_plugin_;
 368
 369   // Indicates whether this is a RenderProcessHost of a Browser Plugin guest
 370   // renderer.
 371   bool is_guest_;
 372
 373   // Forwards messages between WebRTCInternals in the browser process
 374   // and PeerConnectionTracker in the renderer process.
 375   scoped_refptr<PeerConnectionTrackerHost> peer_connection_tracker_host_;
 376
 377   // Prevents the class from being added as a GpuDataManagerImpl observer more
 378   // than once.
 379   bool gpu_observer_registered_;
 380
 381   // Forwards power state messages to the renderer process.
 382   PowerMonitorMessageBroadcaster power_monitor_broadcaster_;
 383
 384   scoped_refptr<AudioRendererHost> audio_renderer_host_;
 385
 386 #if defined(OS_ANDROID)
 387   scoped_refptr<BrowserDemuxerAndroid> browser_demuxer_android_;
 388 #endif
 389
 390   // Message filter for geolocation messages.
 391   GeolocationDispatcherHost* geolocation_dispatcher_host_;
 392
 393   // Lives on the browser's ChildThread.
 394   base::WeakPtrFactory<RenderProcessHostImpl> weak_factory_;
 395
 396   DISALLOW_COPY_AND_ASSIGN(RenderProcessHostImpl);
 397 };
 398
 399 }  // namespace content
 400
 401 #endif  // CONTENT_BROWSER_RENDERER_HOST_BROWSER_RENDER_PROCESS_HOST_IMPL_H_