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