15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// See http://dev.chromium.org/developers/design-documents/multi-process-resource-loading 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 7868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)#ifndef CONTENT_CHILD_RESOURCE_DISPATCHER_H_ 8868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)#define CONTENT_CHILD_RESOURCE_DISPATCHER_H_ 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <deque> 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 137d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles)#include "base/containers/hash_tables.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/linked_ptr.h" 157dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch#include "base/memory/shared_memory.h" 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/weak_ptr.h" 17eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#include "base/time/time.h" 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/common/content_export.h" 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ipc/ipc_listener.h" 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ipc/ipc_sender.h" 21ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#include "webkit/child/resource_loader_bridge.h" 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace content { 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class ResourceDispatcherDelegate; 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct ResourceResponseHead; 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This class serves as a communication interface between the 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// ResourceDispatcherHost in the browser process and the ResourceLoaderBridge in 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// the child process. It can be used from any child process. 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class CONTENT_EXPORT ResourceDispatcher : public IPC::Listener { 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) explicit ResourceDispatcher(IPC::Sender* sender); 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~ResourceDispatcher(); 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // IPC::Listener implementation. 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE; 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Creates a ResourceLoaderBridge for this type of dispatcher, this is so 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // this can be tested regardless of the ResourceLoaderBridge::Create 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // implementation. 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) webkit_glue::ResourceLoaderBridge* CreateBridge( 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const webkit_glue::ResourceLoaderBridge::RequestInfo& request_info); 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Adds a request from the pending_requests_ list, returning the new 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // requests' ID 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int AddPendingRequest(webkit_glue::ResourceLoaderBridge::Peer* callback, 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ResourceType::Type resource_type, 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const GURL& request_url); 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Removes a request from the pending_requests_ list, returning true if the 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // request was found and removed. 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool RemovePendingRequest(int request_id); 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Cancels a request in the pending_requests_ list. 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void CancelPendingRequest(int routing_id, int request_id); 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) IPC::Sender* message_sender() const { 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return message_sender_; 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Toggles the is_deferred attribute for the specified request. 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetDefersLoading(int request_id, bool value); 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 642a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Indicates the priority of the specified request changed. 652a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void DidChangePriority(int routing_id, int request_id, 662a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) net::RequestPriority new_priority); 672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This does not take ownership of the delegate. It is expected that the 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // delegate have a longer lifetime than the ResourceDispatcher. 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_delegate(ResourceDispatcherDelegate* delegate) { 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) delegate_ = delegate; 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 74868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) // Remembers IO thread timestamp for next resource message. 75868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) void set_io_timestamp(base::TimeTicks io_timestamp) { 76868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) io_timestamp_ = io_timestamp; 77868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) } 78868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class ResourceDispatcherTest; 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef std::deque<IPC::Message*> MessageQueue; 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct PendingRequestInfo { 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PendingRequestInfo(); 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PendingRequestInfo(webkit_glue::ResourceLoaderBridge::Peer* peer, 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ResourceType::Type resource_type, 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const GURL& request_url); 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ~PendingRequestInfo(); 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) webkit_glue::ResourceLoaderBridge::Peer* peer; 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ResourceType::Type resource_type; 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) MessageQueue deferred_message_queue; 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_deferred; 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) GURL url; 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) linked_ptr<IPC::Message> pending_redirect_message; 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::TimeTicks request_start; 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::TimeTicks response_start; 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::TimeTicks completion_time; 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) linked_ptr<base::SharedMemory> buffer; 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int buffer_size; 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef base::hash_map<int, PendingRequestInfo> PendingRequestList; 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Helper to lookup the info based on the request_id. 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // May return NULL if the request as been canceled from the client side. 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PendingRequestInfo* GetPendingRequestInfo(int request_id); 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Follows redirect, if any, for the given request. 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void FollowPendingRedirect(int request_id, PendingRequestInfo& request_info); 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Message response handlers, called by the message handler for this process. 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnUploadProgress( 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const IPC::Message& message, 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int request_id, 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int64 position, 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int64 size); 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnReceivedResponse(int request_id, const ResourceResponseHead&); 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnReceivedCachedMetadata(int request_id, const std::vector<char>& data); 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnReceivedRedirect( 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const IPC::Message& message, 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int request_id, 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const GURL& new_url, 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const ResourceResponseHead& response_head); 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnSetDataBuffer( 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const IPC::Message& message, 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int request_id, 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::SharedMemoryHandle shm_handle, 1302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) int shm_size, 1312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) base::ProcessId renderer_pid); 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnReceivedData( 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const IPC::Message& message, 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int request_id, 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int data_offset, 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int data_length, 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int encoded_data_length); 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnDownloadedData( 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const IPC::Message& message, 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int request_id, 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int data_len); 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnRequestComplete( 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int request_id, 1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int error_code, 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool was_ignored_by_handler, 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& security_info, 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::TimeTicks& completion_time); 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Dispatch the message to one of the message response handlers. 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void DispatchMessage(const IPC::Message& message); 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Dispatch any deferred messages for the given request, provided it is not 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // again in the deferred state. 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void FlushDeferredMessages(int request_id); 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void ToResourceResponseInfo( 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const PendingRequestInfo& request_info, 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const ResourceResponseHead& browser_info, 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) webkit_glue::ResourceResponseInfo* renderer_info) const; 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::TimeTicks ToRendererCompletionTime( 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const PendingRequestInfo& request_info, 1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::TimeTicks& browser_completion_time) const; 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 165868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) // Returns timestamp provided by IO thread. If no timestamp is supplied, 166868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) // then current time is returned. Saved timestamp is reset, so following 167868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) // invocations will return current time until set_io_timestamp is called. 168868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) base::TimeTicks ConsumeIOTimestamp(); 169868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) 1705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if the message passed in is a resource related message. 1715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool IsResourceDispatcherMessage(const IPC::Message& message); 1725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ViewHostMsg_Resource_DataReceived is not POD, it has a shared memory 1745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // handle in it that we should cleanup it up nicely. This method accepts any 1755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // message and determine whether the message is 1765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ViewHostMsg_Resource_DataReceived and clean up the shared memory handle. 1775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void ReleaseResourcesInDataMessage(const IPC::Message& message); 1785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Iterate through a message queue and clean up the messages by calling 1805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ReleaseResourcesInDataMessage and removing them from the queue. Intended 1815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // for use on deferred message queues that are no longer needed. 1825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void ReleaseResourcesInMessageQueue(MessageQueue* queue); 1835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) IPC::Sender* message_sender_; 1855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // All pending requests issued to the host 1875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PendingRequestList pending_requests_; 1885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::WeakPtrFactory<ResourceDispatcher> weak_factory_; 1905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ResourceDispatcherDelegate* delegate_; 1925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 193868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) // IO thread timestamp for ongoing IPC message. 194868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) base::TimeTicks io_timestamp_; 195868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles) 1965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(ResourceDispatcher); 1975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace content 2005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 201868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)#endif // CONTENT_CHILD_RESOURCE_DISPATCHER_H_ 202