content/browser/worker_host/worker_process_host.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_WORKER_HOST_WORKER_PROCESS_HOST_H_
   6 #define CONTENT_BROWSER_WORKER_HOST_WORKER_PROCESS_HOST_H_
   7
   8 #include <list>
   9 #include <string>
  10 #include <utility>
  11
  12 #include "base/basictypes.h"
  13 #include "base/files/file_path.h"
  14 #include "base/memory/scoped_ptr.h"
  15 #include "content/browser/worker_host/worker_document_set.h"
  16 #include "content/browser/worker_host/worker_storage_partition.h"
  17 #include "content/common/content_export.h"
  18 #include "content/public/browser/browser_child_process_host_delegate.h"
  19 #include "content/public/browser/browser_child_process_host_iterator.h"
  20 #include "content/public/common/process_type.h"
  21 #include "ipc/ipc_sender.h"
  22 #include "third_party/WebKit/public/web/WebContentSecurityPolicy.h"
  23 #include "url/gurl.h"
  24 #include "webkit/common/resource_type.h"
  25
  26 struct ResourceHostMsg_Request;
  27
  28 namespace fileapi {
  29 class FileSystemContext;
  30 }  // namespace fileapi
  31
  32 namespace net {
  33 class URLRequestContext;
  34 }
  35
  36 namespace webkit_database {
  37 class DatabaseTracker;
  38 }  // namespace webkit_database
  39
  40 namespace content {
  41 class BrowserChildProcessHostImpl;
  42 class IndexedDBContextImpl;
  43 class ResourceContext;
  44 class SocketStreamDispatcherHost;
  45 class WorkerServiceImpl;
  46
  47 // The WorkerProcessHost is the interface that represents the browser side of
  48 // the browser <-> worker communication channel. There will be one
  49 // WorkerProcessHost per worker process.  Currently each worker runs in its own
  50 // process, but that may change.  However, we do assume (by storing a
  51 // net::URLRequestContext) that a WorkerProcessHost serves a single
  52 // BrowserContext.
  53 class WorkerProcessHost : public BrowserChildProcessHostDelegate,
  54                           public IPC::Sender {
  55  public:
  56   // Contains information about each worker instance, needed to forward messages
  57   // between the renderer and worker processes.
  58   class WorkerInstance {
  59    public:
  60     WorkerInstance(const GURL& url,
  61                    const base::string16& name,
  62                    const base::string16& content_security_policy,
  63                    blink::WebContentSecurityPolicyType security_policy_type,
  64                    int worker_route_id,
  65                    int parent_process_id,
  66                    int64 main_resource_appcache_id,
  67                    ResourceContext* resource_context,
  68                    const WorkerStoragePartition& partition);
  69     // Used for pending instances. Rest of the parameters are ignored.
  70     WorkerInstance(const GURL& url,
  71                    bool shared,
  72                    const base::string16& name,
  73                    ResourceContext* resource_context,
  74                    const WorkerStoragePartition& partition);
  75     ~WorkerInstance();
  76
  77     // Unique identifier for a worker client.
  78     typedef std::pair<WorkerMessageFilter*, int> FilterInfo;
  79
  80     // APIs to manage the filter list for a given instance.
  81     void AddFilter(WorkerMessageFilter* filter, int route_id);
  82     void RemoveFilter(WorkerMessageFilter* filter, int route_id);
  83     void RemoveFilters(WorkerMessageFilter* filter);
  84     bool HasFilter(WorkerMessageFilter* filter, int route_id) const;
  85     bool FrameIsParent(int render_process_id, int render_frame_id) const;
  86     int NumFilters() const { return filters_.size(); }
  87     // Returns the single filter (must only be one).
  88     FilterInfo GetFilter() const;
  89
  90     typedef std::list<FilterInfo> FilterList;
  91     const FilterList& filters() const { return filters_; }
  92
  93     // Checks if this WorkerInstance matches the passed url/name params
  94     // (per the comparison algorithm in the WebWorkers spec). This API only
  95     // applies to shared workers.
  96     bool Matches(
  97         const GURL& url,
  98         const base::string16& name,
  99         const WorkerStoragePartition& partition,
 100         ResourceContext* resource_context) const;
 101
 102     // Shares the passed instance's WorkerDocumentSet with this instance. This
 103     // instance's current WorkerDocumentSet is dereferenced (and freed if this
 104     // is the only reference) as a result.
 105     void ShareDocumentSet(const WorkerInstance& instance) {
 106       worker_document_set_ = instance.worker_document_set_;
 107     };
 108
 109     // Accessors
 110     bool closed() const { return closed_; }
 111     void set_closed(bool closed) { closed_ = closed; }
 112     const GURL& url() const { return url_; }
 113     const base::string16 name() const { return name_; }
 114     const base::string16 content_security_policy() const {
 115         return content_security_policy_;
 116     }
 117     blink::WebContentSecurityPolicyType security_policy_type() const {
 118         return security_policy_type_;
 119     }
 120     int worker_route_id() const { return worker_route_id_; }
 121     int parent_process_id() const { return parent_process_id_; }
 122     int64 main_resource_appcache_id() const {
 123       return main_resource_appcache_id_;
 124     }
 125     WorkerDocumentSet* worker_document_set() const {
 126       return worker_document_set_.get();
 127     }
 128     ResourceContext* resource_context() const {
 129       return resource_context_;
 130     }
 131     const WorkerStoragePartition& partition() const {
 132       return partition_;
 133     }
 134
 135    private:
 136     // Set of all filters (clients) associated with this worker.
 137     GURL url_;
 138     bool closed_;
 139     base::string16 name_;
 140     base::string16 content_security_policy_;
 141     blink::WebContentSecurityPolicyType security_policy_type_;
 142     int worker_route_id_;
 143     int parent_process_id_;
 144     int64 main_resource_appcache_id_;
 145     FilterList filters_;
 146     scoped_refptr<WorkerDocumentSet> worker_document_set_;
 147     ResourceContext* const resource_context_;
 148     WorkerStoragePartition partition_;
 149   };
 150
 151   WorkerProcessHost(ResourceContext* resource_context,
 152                     const WorkerStoragePartition& partition);
 153   virtual ~WorkerProcessHost();
 154
 155   // IPC::Sender implementation:
 156   virtual bool Send(IPC::Message* message) OVERRIDE;
 157
 158   // Starts the process.  Returns true iff it succeeded.
 159   // |render_process_id| is the renderer process responsible for starting this
 160   // worker.
 161   bool Init(int render_process_id);
 162
 163   // Creates a worker object in the process.
 164   void CreateWorker(const WorkerInstance& instance);
 165
 166   // Returns true iff the given message from a renderer process was forwarded to
 167   // the worker.
 168   bool FilterMessage(const IPC::Message& message, WorkerMessageFilter* filter);
 169
 170   void FilterShutdown(WorkerMessageFilter* filter);
 171
 172   // Shuts down any shared workers that are no longer referenced by active
 173   // documents.
 174   void DocumentDetached(WorkerMessageFilter* filter,
 175                         unsigned long long document_id);
 176
 177   // Terminates the given worker, i.e. based on a UI action.
 178   CONTENT_EXPORT void TerminateWorker(int worker_route_id);
 179
 180   // Callers can reduce the WorkerProcess' priority.
 181   void SetBackgrounded(bool backgrounded);
 182
 183   CONTENT_EXPORT const ChildProcessData& GetData();
 184
 185   typedef std::list<WorkerInstance> Instances;
 186   const Instances& instances() const { return instances_; }
 187
 188   ResourceContext* resource_context() const {
 189     return resource_context_;
 190   }
 191
 192   bool process_launched() const { return process_launched_; }
 193
 194  protected:
 195   friend class WorkerServiceImpl;
 196
 197   Instances& mutable_instances() { return instances_; }
 198
 199  private:
 200   // BrowserChildProcessHostDelegate implementation:
 201   virtual void OnProcessLaunched() OVERRIDE;
 202   virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE;
 203
 204   // Creates and adds the message filters.
 205   void CreateMessageFilters(int render_process_id);
 206
 207   void OnWorkerContextClosed(int worker_route_id);
 208   void OnAllowDatabase(int worker_route_id,
 209                        const GURL& url,
 210                        const base::string16& name,
 211                        const base::string16& display_name,
 212                        unsigned long estimated_size,
 213                        bool* result);
 214   void OnAllowFileSystem(int worker_route_id,
 215                          const GURL& url,
 216                          bool* result);
 217   void OnAllowIndexedDB(int worker_route_id,
 218                         const GURL& url,
 219                         const base::string16& name,
 220                         bool* result);
 221   void OnForceKillWorkerProcess();
 222
 223   // Relays a message to the given endpoint.  Takes care of parsing the message
 224   // if it contains a message port and sending it a valid route id.
 225   void RelayMessage(const IPC::Message& message,
 226                     WorkerMessageFilter* filter,
 227                     int route_id);
 228
 229   void ShutdownSocketStreamDispatcherHostIfNecessary();
 230
 231   virtual bool CanShutdown() OVERRIDE;
 232
 233   // Updates the title shown in the task manager.
 234   void UpdateTitle();
 235
 236   // Return a vector of all the render process/render frame  IDs that use the
 237   // given worker.
 238   std::vector<std::pair<int, int> > GetRenderFrameIDsForWorker(int route_id);
 239
 240   // Callbacks for ResourceMessageFilter and SocketStreamDispatcherHost.
 241   void GetContexts(const ResourceHostMsg_Request& request,
 242                    ResourceContext** resource_context,
 243                    net::URLRequestContext** request_context);
 244   net::URLRequestContext* GetRequestContext(ResourceType::Type resource_type);
 245
 246   Instances instances_;
 247
 248   ResourceContext* const resource_context_;
 249   WorkerStoragePartition partition_;
 250
 251   // A reference to the filter associated with this worker process.  We need to
 252   // keep this around since we'll use it when forward messages to the worker
 253   // process.
 254   scoped_refptr<WorkerMessageFilter> worker_message_filter_;
 255
 256   scoped_ptr<BrowserChildProcessHostImpl> process_;
 257   bool process_launched_;
 258
 259   scoped_refptr<SocketStreamDispatcherHost> socket_stream_dispatcher_host_;
 260
 261   DISALLOW_COPY_AND_ASSIGN(WorkerProcessHost);
 262 };
 263
 264 class WorkerProcessHostIterator
 265     : public BrowserChildProcessHostTypeIterator<WorkerProcessHost> {
 266  public:
 267   WorkerProcessHostIterator()
 268       : BrowserChildProcessHostTypeIterator<WorkerProcessHost>(
 269             PROCESS_TYPE_WORKER) {
 270   }
 271 };
 272
 273 }  // namespace content
 274
 275 #endif  // CONTENT_BROWSER_WORKER_HOST_WORKER_PROCESS_HOST_H_