content/child/resource_dispatcher.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 // See http://dev.chromium.org/developers/design-documents/multi-process-resource-loading
   6
   7 #ifndef CONTENT_CHILD_RESOURCE_DISPATCHER_H_
   8 #define CONTENT_CHILD_RESOURCE_DISPATCHER_H_
   9
  10 #include <deque>
  11 #include <string>
  12
  13 #include "base/containers/hash_tables.h"
  14 #include "base/memory/linked_ptr.h"
  15 #include "base/memory/shared_memory.h"
  16 #include "base/memory/weak_ptr.h"
  17 #include "base/time/time.h"
  18 #include "content/common/content_export.h"
  19 #include "ipc/ipc_listener.h"
  20 #include "ipc/ipc_sender.h"
  21 #include "net/base/request_priority.h"
  22 #include "webkit/common/resource_type.h"
  23
  24 struct ResourceMsg_RequestCompleteData;
  25
  26 namespace webkit_glue {
  27 class ResourceLoaderBridge;
  28 struct ResourceResponseInfo;
  29 }
  30
  31 namespace content {
  32 class RequestPeer;
  33 class ResourceDispatcherDelegate;
  34 struct RequestInfo;
  35 struct ResourceResponseHead;
  36 struct SiteIsolationResponseMetaData;
  37
  38 // This class serves as a communication interface between the
  39 // ResourceDispatcherHost in the browser process and the ResourceLoaderBridge in
  40 // the child process.  It can be used from any child process.
  41 class CONTENT_EXPORT ResourceDispatcher : public IPC::Listener {
  42  public:
  43   explicit ResourceDispatcher(IPC::Sender* sender);
  44   virtual ~ResourceDispatcher();
  45
  46   // IPC::Listener implementation.
  47   virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE;
  48
  49   // Creates a ResourceLoaderBridge for this type of dispatcher, this is so
  50   // this can be tested regardless of the ResourceLoaderBridge::Create
  51   // implementation.
  52   webkit_glue::ResourceLoaderBridge* CreateBridge(
  53       const RequestInfo& request_info);
  54
  55   // Adds a request from the pending_requests_ list, returning the new
  56   // requests' ID
  57   int AddPendingRequest(RequestPeer* callback,
  58                         ResourceType::Type resource_type,
  59                         int origin_pid,
  60                         const GURL& frame_origin,
  61                         const GURL& request_url);
  62
  63   // Removes a request from the pending_requests_ list, returning true if the
  64   // request was found and removed.
  65   bool RemovePendingRequest(int request_id);
  66
  67   // Cancels a request in the pending_requests_ list.
  68   void CancelPendingRequest(int request_id);
  69
  70   IPC::Sender* message_sender() const {
  71     return message_sender_;
  72   }
  73
  74   // Toggles the is_deferred attribute for the specified request.
  75   void SetDefersLoading(int request_id, bool value);
  76
  77   // Indicates the priority of the specified request changed.
  78   void DidChangePriority(int routing_id, int request_id,
  79                          net::RequestPriority new_priority,
  80                          int intra_priority_value);
  81
  82   // This does not take ownership of the delegate. It is expected that the
  83   // delegate have a longer lifetime than the ResourceDispatcher.
  84   void set_delegate(ResourceDispatcherDelegate* delegate) {
  85     delegate_ = delegate;
  86   }
  87
  88   // Remembers IO thread timestamp for next resource message.
  89   void set_io_timestamp(base::TimeTicks io_timestamp) {
  90     io_timestamp_ = io_timestamp;
  91   }
  92
  93  private:
  94   friend class ResourceDispatcherTest;
  95
  96   typedef std::deque<IPC::Message*> MessageQueue;
  97   struct PendingRequestInfo {
  98     PendingRequestInfo();
  99
 100     PendingRequestInfo(RequestPeer* peer,
 101                        ResourceType::Type resource_type,
 102                        int origin_pid,
 103                        const GURL& frame_origin,
 104                        const GURL& request_url);
 105
 106     ~PendingRequestInfo();
 107
 108     RequestPeer* peer;
 109     ResourceType::Type resource_type;
 110     // The PID of the original process which issued this request. This gets
 111     // non-zero only for a request proxied by another renderer, particularly
 112     // requests from plugins.
 113     int origin_pid;
 114     MessageQueue deferred_message_queue;
 115     bool is_deferred;
 116     // Original requested url.
 117     GURL url;
 118     // The security origin of the frame that initiates this request.
 119     GURL frame_origin;
 120     // The url of the latest response even in case of redirection.
 121     GURL response_url;
 122     linked_ptr<IPC::Message> pending_redirect_message;
 123     base::TimeTicks request_start;
 124     base::TimeTicks response_start;
 125     base::TimeTicks completion_time;
 126     linked_ptr<base::SharedMemory> buffer;
 127     linked_ptr<SiteIsolationResponseMetaData> site_isolation_metadata;
 128     bool blocked_response;
 129     int buffer_size;
 130   };
 131   typedef base::hash_map<int, PendingRequestInfo> PendingRequestList;
 132
 133   // Helper to lookup the info based on the request_id.
 134   // May return NULL if the request as been canceled from the client side.
 135   PendingRequestInfo* GetPendingRequestInfo(int request_id);
 136
 137   // Follows redirect, if any, for the given request.
 138   void FollowPendingRedirect(int request_id, PendingRequestInfo& request_info);
 139
 140   // Message response handlers, called by the message handler for this process.
 141   void OnUploadProgress(
 142       int request_id,
 143       int64 position,
 144       int64 size);
 145   void OnReceivedResponse(int request_id, const ResourceResponseHead&);
 146   void OnReceivedCachedMetadata(int request_id, const std::vector<char>& data);
 147   void OnReceivedRedirect(
 148       int request_id,
 149       const GURL& new_url,
 150       const ResourceResponseHead& response_head);
 151   void OnSetDataBuffer(
 152       int request_id,
 153       base::SharedMemoryHandle shm_handle,
 154       int shm_size,
 155       base::ProcessId renderer_pid);
 156   void OnReceivedData(
 157       int request_id,
 158       int data_offset,
 159       int data_length,
 160       int encoded_data_length);
 161   void OnDownloadedData(
 162       int request_id,
 163       int data_len,
 164       int encoded_data_length);
 165   void OnRequestComplete(
 166       int request_id,
 167       const ResourceMsg_RequestCompleteData &request_complete_data);
 168
 169   // Dispatch the message to one of the message response handlers.
 170   void DispatchMessage(const IPC::Message& message);
 171
 172   // Dispatch any deferred messages for the given request, provided it is not
 173   // again in the deferred state.
 174   void FlushDeferredMessages(int request_id);
 175
 176   void ToResourceResponseInfo(
 177       const PendingRequestInfo& request_info,
 178       const ResourceResponseHead& browser_info,
 179       webkit_glue::ResourceResponseInfo* renderer_info) const;
 180
 181   base::TimeTicks ToRendererCompletionTime(
 182       const PendingRequestInfo& request_info,
 183       const base::TimeTicks& browser_completion_time) const;
 184
 185   // Returns timestamp provided by IO thread. If no timestamp is supplied,
 186   // then current time is returned. Saved timestamp is reset, so following
 187   // invocations will return current time until set_io_timestamp is called.
 188   base::TimeTicks ConsumeIOTimestamp();
 189
 190   // Returns true if the message passed in is a resource related message.
 191   static bool IsResourceDispatcherMessage(const IPC::Message& message);
 192
 193   // ViewHostMsg_Resource_DataReceived is not POD, it has a shared memory
 194   // handle in it that we should cleanup it up nicely. This method accepts any
 195   // message and determine whether the message is
 196   // ViewHostMsg_Resource_DataReceived and clean up the shared memory handle.
 197   static void ReleaseResourcesInDataMessage(const IPC::Message& message);
 198
 199   // Iterate through a message queue and clean up the messages by calling
 200   // ReleaseResourcesInDataMessage and removing them from the queue. Intended
 201   // for use on deferred message queues that are no longer needed.
 202   static void ReleaseResourcesInMessageQueue(MessageQueue* queue);
 203
 204   IPC::Sender* message_sender_;
 205
 206   // All pending requests issued to the host
 207   PendingRequestList pending_requests_;
 208
 209   base::WeakPtrFactory<ResourceDispatcher> weak_factory_;
 210
 211   ResourceDispatcherDelegate* delegate_;
 212
 213   // IO thread timestamp for ongoing IPC message.
 214   base::TimeTicks io_timestamp_;
 215
 216   DISALLOW_COPY_AND_ASSIGN(ResourceDispatcher);
 217 };
 218
 219 }  // namespace content
 220
 221 #endif  // CONTENT_CHILD_RESOURCE_DISPATCHER_H_