content/child/child_thread_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_CHILD_CHILD_THREAD_IMPL_H_
   6 #define CONTENT_CHILD_CHILD_THREAD_IMPL_H_
   7
   8 #include <string>
   9
  10 #include "base/basictypes.h"
  11 #include "base/memory/scoped_ptr.h"
  12 #include "base/memory/shared_memory.h"
  13 #include "base/memory/weak_ptr.h"
  14 #include "base/power_monitor/power_monitor.h"
  15 #include "base/sequenced_task_runner.h"
  16 #include "base/tracked_objects.h"
  17 #include "content/child/mojo/mojo_application.h"
  18 #include "content/common/content_export.h"
  19 #include "content/common/message_router.h"
  20 #include "content/public/child/child_thread.h"
  21 #include "ipc/ipc_message.h"  // For IPC_MESSAGE_LOG_ENABLED.
  22
  23 #if defined(OS_MACOSX) && !defined(OS_IOS)
  24 #include "content/common/mac/io_surface_manager_token.h"
  25 #endif
  26
  27 namespace base {
  28 class MessageLoop;
  29
  30 namespace trace_event {
  31 class TraceMemoryController;
  32 }  // namespace trace_event
  33 }  // namespace base
  34
  35 namespace IPC {
  36 class AttachmentBroker;
  37 class MessageFilter;
  38 class ScopedIPCSupport;
  39 class SyncChannel;
  40 class SyncMessageFilter;
  41 }  // namespace IPC
  42
  43 namespace blink {
  44 class WebFrame;
  45 }  // namespace blink
  46
  47 namespace content {
  48 class ChildMessageFilter;
  49 class ChildDiscardableSharedMemoryManager;
  50 class ChildGpuMemoryBufferManager;
  51 class ChildHistogramMessageFilter;
  52 class ChildResourceMessageFilter;
  53 class ChildSharedBitmapManager;
  54 class FileSystemDispatcher;
  55 class InProcessChildThreadParams;
  56 class NavigatorConnectDispatcher;
  57 class NotificationDispatcher;
  58 class PushDispatcher;
  59 class ServiceWorkerMessageFilter;
  60 class QuotaDispatcher;
  61 class QuotaMessageFilter;
  62 class ResourceDispatcher;
  63 class ThreadSafeSender;
  64 class WebSocketDispatcher;
  65 struct RequestInfo;
  66
  67 // The main thread of a child process derives from this class.
  68 class CONTENT_EXPORT ChildThreadImpl
  69     : public IPC::Listener,
  70       virtual public ChildThread {
  71  public:
  72   struct CONTENT_EXPORT Options;
  73
  74   // Creates the thread.
  75   ChildThreadImpl();
  76   // Allow to be used for single-process mode and for in process gpu mode via
  77   // options.
  78   explicit ChildThreadImpl(const Options& options);
  79   // ChildProcess::main_thread() is reset after Shutdown(), and before the
  80   // destructor, so any subsystem that relies on ChildProcess::main_thread()
  81   // must be terminated before Shutdown returns. In particular, if a subsystem
  82   // has a thread that post tasks to ChildProcess::main_thread(), that thread
  83   // should be joined in Shutdown().
  84   ~ChildThreadImpl() override;
  85   virtual void Shutdown();
  86
  87   // IPC::Sender implementation:
  88   bool Send(IPC::Message* msg) override;
  89
  90   // ChildThread implementation:
  91 #if defined(OS_WIN)
  92   void PreCacheFont(const LOGFONT& log_font) override;
  93   void ReleaseCachedFonts() override;
  94 #endif
  95   IPC::AttachmentBroker* GetAttachmentBroker() override;
  96
  97   IPC::SyncChannel* channel() { return channel_.get(); }
  98
  99   MessageRouter* GetRouter();
 100
 101   // Allocates a block of shared memory of the given size. Returns NULL on
 102   // failure.
 103   // Note: On posix, this requires a sync IPC to the browser process,
 104   // but on windows the child process directly allocates the block.
 105   scoped_ptr<base::SharedMemory> AllocateSharedMemory(size_t buf_size);
 106
 107   // A static variant that can be called on background threads provided
 108   // the |sender| passed in is safe to use on background threads.
 109   static scoped_ptr<base::SharedMemory> AllocateSharedMemory(
 110       size_t buf_size,
 111       IPC::Sender* sender);
 112
 113   ChildSharedBitmapManager* shared_bitmap_manager() const {
 114     return shared_bitmap_manager_.get();
 115   }
 116
 117   ChildGpuMemoryBufferManager* gpu_memory_buffer_manager() const {
 118     return gpu_memory_buffer_manager_.get();
 119   }
 120
 121   ChildDiscardableSharedMemoryManager* discardable_shared_memory_manager()
 122       const {
 123     return discardable_shared_memory_manager_.get();
 124   }
 125
 126   ResourceDispatcher* resource_dispatcher() const {
 127     return resource_dispatcher_.get();
 128   }
 129
 130   WebSocketDispatcher* websocket_dispatcher() const {
 131     return websocket_dispatcher_.get();
 132   }
 133
 134   FileSystemDispatcher* file_system_dispatcher() const {
 135     return file_system_dispatcher_.get();
 136   }
 137
 138   QuotaDispatcher* quota_dispatcher() const {
 139     return quota_dispatcher_.get();
 140   }
 141
 142   NotificationDispatcher* notification_dispatcher() const {
 143     return notification_dispatcher_.get();
 144   }
 145
 146   PushDispatcher* push_dispatcher() const {
 147     return push_dispatcher_.get();
 148   }
 149
 150   IPC::SyncMessageFilter* sync_message_filter() const {
 151     return sync_message_filter_.get();
 152   }
 153
 154   // The getter should only be called on the main thread, however the
 155   // IPC::Sender it returns may be safely called on any thread including
 156   // the main thread.
 157   ThreadSafeSender* thread_safe_sender() const {
 158     return thread_safe_sender_.get();
 159   }
 160
 161   ChildHistogramMessageFilter* child_histogram_message_filter() const {
 162     return histogram_message_filter_.get();
 163   }
 164
 165   ServiceWorkerMessageFilter* service_worker_message_filter() const {
 166     return service_worker_message_filter_.get();
 167   }
 168
 169   QuotaMessageFilter* quota_message_filter() const {
 170     return quota_message_filter_.get();
 171   }
 172
 173   ChildResourceMessageFilter* child_resource_message_filter() const {
 174     return resource_message_filter_.get();
 175   }
 176
 177   base::MessageLoop* message_loop() const { return message_loop_; }
 178
 179   // Returns the one child thread. Can only be called on the main thread.
 180   static ChildThreadImpl* current();
 181
 182 #if defined(OS_ANDROID)
 183   // Called on Android's service thread to shutdown the main thread of this
 184   // process.
 185   static void ShutdownThread();
 186 #endif
 187
 188   ServiceRegistry* service_registry() const {
 189     return mojo_application_->service_registry();
 190   }
 191
 192  protected:
 193   friend class ChildProcess;
 194
 195   // Called when the process refcount is 0.
 196   void OnProcessFinalRelease();
 197
 198   virtual bool OnControlMessageReceived(const IPC::Message& msg);
 199
 200   void set_on_channel_error_called(bool on_channel_error_called) {
 201     on_channel_error_called_ = on_channel_error_called;
 202   }
 203
 204   // IPC::Listener implementation:
 205   bool OnMessageReceived(const IPC::Message& msg) override;
 206   void OnChannelConnected(int32 peer_pid) override;
 207   void OnChannelError() override;
 208
 209   bool IsInBrowserProcess() const;
 210   scoped_refptr<base::SequencedTaskRunner> GetIOTaskRunner();
 211
 212  private:
 213   class ChildThreadMessageRouter : public MessageRouter {
 214    public:
 215     // |sender| must outlive this object.
 216     explicit ChildThreadMessageRouter(IPC::Sender* sender);
 217     bool Send(IPC::Message* msg) override;
 218
 219    private:
 220     IPC::Sender* const sender_;
 221   };
 222
 223   void Init(const Options& options);
 224
 225   // We create the channel first without connecting it so we can add filters
 226   // prior to any messages being received, then connect it afterwards.
 227   void ConnectChannel(bool use_mojo_channel);
 228
 229   // IPC message handlers.
 230   void OnShutdown();
 231   void OnSetProfilerStatus(tracked_objects::ThreadData::Status status);
 232   void OnGetChildProfilerData(int sequence_number, int current_profiling_phase);
 233   void OnProfilingPhaseCompleted(int profiling_phase);
 234   void OnProcessBackgrounded(bool background);
 235 #ifdef IPC_MESSAGE_LOG_ENABLED
 236   void OnSetIPCLoggingEnabled(bool enable);
 237 #endif
 238 #if defined(USE_TCMALLOC)
 239   void OnGetTcmallocStats();
 240 #endif
 241 #if defined(OS_MACOSX) && !defined(OS_IOS)
 242   void OnSetIOSurfaceManagerToken(const IOSurfaceManagerToken& token);
 243 #endif
 244
 245   void EnsureConnected();
 246
 247   scoped_ptr<MojoApplication> mojo_application_;
 248
 249   std::string channel_name_;
 250   scoped_ptr<IPC::SyncChannel> channel_;
 251   scoped_ptr<IPC::AttachmentBroker> attachment_broker_;
 252
 253   // Allows threads other than the main thread to send sync messages.
 254   scoped_refptr<IPC::SyncMessageFilter> sync_message_filter_;
 255
 256   scoped_refptr<ThreadSafeSender> thread_safe_sender_;
 257
 258   // Implements message routing functionality to the consumers of
 259   // ChildThreadImpl.
 260   ChildThreadMessageRouter router_;
 261
 262   // Handles resource loads for this process.
 263   scoped_ptr<ResourceDispatcher> resource_dispatcher_;
 264
 265   scoped_ptr<WebSocketDispatcher> websocket_dispatcher_;
 266
 267   // The OnChannelError() callback was invoked - the channel is dead, don't
 268   // attempt to communicate.
 269   bool on_channel_error_called_;
 270
 271   base::MessageLoop* message_loop_;
 272
 273   scoped_ptr<FileSystemDispatcher> file_system_dispatcher_;
 274
 275   scoped_ptr<QuotaDispatcher> quota_dispatcher_;
 276
 277   scoped_refptr<ChildHistogramMessageFilter> histogram_message_filter_;
 278
 279   scoped_refptr<ChildResourceMessageFilter> resource_message_filter_;
 280
 281   scoped_refptr<ServiceWorkerMessageFilter> service_worker_message_filter_;
 282
 283   scoped_refptr<QuotaMessageFilter> quota_message_filter_;
 284
 285   scoped_refptr<NotificationDispatcher> notification_dispatcher_;
 286
 287   scoped_refptr<PushDispatcher> push_dispatcher_;
 288
 289   scoped_ptr<ChildSharedBitmapManager> shared_bitmap_manager_;
 290
 291   scoped_ptr<ChildGpuMemoryBufferManager> gpu_memory_buffer_manager_;
 292
 293   scoped_ptr<ChildDiscardableSharedMemoryManager>
 294       discardable_shared_memory_manager_;
 295
 296   // Observes the trace event system. When tracing is enabled, optionally
 297   // starts profiling the tcmalloc heap.
 298   scoped_ptr<base::trace_event::TraceMemoryController> trace_memory_controller_;
 299
 300   scoped_ptr<base::PowerMonitor> power_monitor_;
 301
 302   scoped_refptr<ChildMessageFilter> geofencing_message_filter_;
 303   scoped_refptr<ChildMessageFilter> bluetooth_message_filter_;
 304
 305   scoped_refptr<NavigatorConnectDispatcher> navigator_connect_dispatcher_;
 306
 307   scoped_refptr<base::SequencedTaskRunner> browser_process_io_runner_;
 308
 309   base::WeakPtrFactory<ChildThreadImpl> channel_connected_factory_;
 310
 311   DISALLOW_COPY_AND_ASSIGN(ChildThreadImpl);
 312 };
 313
 314 struct ChildThreadImpl::Options {
 315   ~Options();
 316
 317   class Builder;
 318
 319   std::string channel_name;
 320   bool use_mojo_channel;
 321   scoped_refptr<base::SequencedTaskRunner> browser_process_io_runner;
 322   std::vector<IPC::MessageFilter*> startup_filters;
 323
 324  private:
 325   Options();
 326 };
 327
 328 class ChildThreadImpl::Options::Builder {
 329  public:
 330   Builder();
 331
 332   Builder& InBrowserProcess(const InProcessChildThreadParams& params);
 333   Builder& UseMojoChannel(bool use_mojo_channel);
 334   Builder& WithChannelName(const std::string& channel_name);
 335   Builder& AddStartupFilter(IPC::MessageFilter* filter);
 336
 337   Options Build();
 338
 339  private:
 340   struct Options options_;
 341
 342   DISALLOW_COPY_AND_ASSIGN(Builder);
 343 };
 344
 345 }  // namespace content
 346
 347 #endif  // CONTENT_CHILD_CHILD_THREAD_IMPL_H_