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