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