1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
|
// Copyright 2008, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// See http://wiki.corp.google.com/twiki/bin/view/Main/ChromeMultiProcessResourceLoading
#include "chrome/common/resource_dispatcher.h"
#include "base/basictypes.h"
#include "base/shared_memory.h"
#include "base/string_util.h"
#include "chrome/common/render_messages.h"
#include "chrome/common/security_filter_peer.h"
#include "net/base/net_errors.h"
#include "net/base/net_util.h"
#include "webkit/glue/resource_type.h"
#include "webkit/glue/webkit_glue.h"
// Uncomment to enable logging of request traffic
//#define LOG_RESOURCE_REQUESTS
#ifdef LOG_RESOURCE_REQUESTS
# define RESOURCE_LOG(stuff) LOG(INFO) << stuff
#else
# define RESOURCE_LOG(stuff)
#endif
// Each resource request is assigned an ID scoped to this process.
static int MakeRequestID() {
// NOTE: The resource_dispatcher_host also needs probably unique
// request_ids, so they count down from -2 (-1 is a special we're
// screwed value), while the renderer process counts up.
static int next_request_id = 0;
return next_request_id++;
}
// ResourceLoaderBridge implementation ----------------------------------------
namespace webkit_glue {
class IPCResourceLoaderBridge : public ResourceLoaderBridge {
public:
IPCResourceLoaderBridge(ResourceDispatcher* dispatcher,
const std::string& method,
const GURL& url,
const GURL& policy_url,
const GURL& referrer,
const std::string& headers,
int load_flags,
int origin_pid,
ResourceType::Type resource_type,
bool mixed_content,
uint32 request_context);
virtual ~IPCResourceLoaderBridge();
// ResourceLoaderBridge
virtual void AppendDataToUpload(const char* data, int data_len);
virtual void AppendFileRangeToUpload(const std::wstring& path,
uint64 offset, uint64 length);
virtual bool Start(Peer* peer);
virtual void Cancel();
virtual void SetDefersLoading(bool value);
virtual void SyncLoad(SyncLoadResponse* response);
#ifdef LOG_RESOURCE_REQUESTS
const std::string& url() const { return url_; }
#endif
private:
ResourceLoaderBridge::Peer* peer_;
// The resource dispatcher for this loader.
scoped_refptr<ResourceDispatcher> dispatcher_;
// The request to send, created on initialization for modification and
// appending data.
ViewHostMsg_Resource_Request request_;
// ID for the request, valid once Start()ed, -1 if not valid yet.
int request_id_;
#ifdef LOG_RESOURCE_REQUESTS
// indicates the URL of this resource request for help debugging
std::string url_;
#endif
};
IPCResourceLoaderBridge::IPCResourceLoaderBridge(
ResourceDispatcher* dispatcher,
const std::string& method,
const GURL& url,
const GURL& policy_url,
const GURL& referrer,
const std::string& headers,
int load_flags,
int origin_pid,
ResourceType::Type resource_type,
bool mixed_content,
uint32 request_context)
: peer_(NULL),
dispatcher_(dispatcher),
request_id_(-1) {
DCHECK(dispatcher_) << "no resource dispatcher";
request_.method = method;
request_.url = url;
request_.policy_url = policy_url;
request_.referrer = referrer;
request_.headers = headers;
request_.load_flags = load_flags;
request_.origin_pid = origin_pid;
request_.resource_type = resource_type;
request_.mixed_content = mixed_content;
request_.request_context = request_context;
#ifdef LOG_RESOURCE_REQUESTS
url_ = url.possibly_invalid_spec();
#endif
}
IPCResourceLoaderBridge::~IPCResourceLoaderBridge() {
// we remove our hook for the resource dispatcher only when going away, since
// it doesn't keep track of whether we've force terminated the request
if (request_id_ >= 0) {
// this operation may fail, as the dispatcher will have preemptively
// removed us when the renderer sends the ReceivedAllData message.
dispatcher_->RemovePendingRequest(request_id_);
}
}
void IPCResourceLoaderBridge::AppendDataToUpload(const char* data,
int data_len) {
DCHECK(request_id_ == -1) << "request already started";
// don't bother appending empty data segments
if (data_len == 0)
return;
request_.upload_content.push_back(net::UploadData::Element());
request_.upload_content.back().SetToBytes(data, data_len);
}
void IPCResourceLoaderBridge::AppendFileRangeToUpload(
const std::wstring& path, uint64 offset, uint64 length) {
DCHECK(request_id_ == -1) << "request already started";
request_.upload_content.push_back(net::UploadData::Element());
request_.upload_content.back().SetToFilePathRange(path, offset, length);
}
// Writes a footer on the message and sends it
bool IPCResourceLoaderBridge::Start(Peer* peer) {
if (request_id_ != -1) {
NOTREACHED() << "Starting a request twice";
return false;
}
RESOURCE_LOG("Starting request for " << url_);
peer_ = peer;
// generate the request ID, and append it to the message
request_id_ = dispatcher_->AddPendingRequest(peer_, request_.resource_type,
request_.mixed_content);
IPC::Message::Sender* sender = dispatcher_->message_sender();
bool ret = false;
if (sender)
ret = sender->Send(new ViewHostMsg_RequestResource(MSG_ROUTING_NONE,
request_id_,
request_));
return ret;
}
void IPCResourceLoaderBridge::Cancel() {
if (request_id_ < 0) {
NOTREACHED() << "Trying to cancel an unstarted request";
return;
}
RESOURCE_LOG("Canceling request for " << url_);
IPC::Message::Sender* sender = dispatcher_->message_sender();
if (sender)
sender->Send(new ViewHostMsg_CancelRequest(MSG_ROUTING_NONE, request_id_));
// We can't remove the request ID from the resource dispatcher because more
// data might be pending. Sending the cancel message may cause more data
// to be flushed, and will then cause a complete message to be sent.
}
void IPCResourceLoaderBridge::SetDefersLoading(bool value) {
if (request_id_ < 0) {
NOTREACHED() << "Trying to (un)defer an unstarted request";
return;
}
dispatcher_->SetDefersLoading(request_id_, value);
}
void IPCResourceLoaderBridge::SyncLoad(SyncLoadResponse* response) {
if (request_id_ != -1) {
NOTREACHED() << "Starting a request twice";
response->status.set_status(URLRequestStatus::FAILED);
return;
}
RESOURCE_LOG("Making sync request for " << url_);
request_id_ = MakeRequestID();
ViewHostMsg_SyncLoad_Result result;
IPC::Message::Sender* sender = dispatcher_->message_sender();
if (sender) {
IPC::Message* msg = new ViewHostMsg_SyncLoad(MSG_ROUTING_NONE, request_id_,
request_, &result);
if (!sender->Send(msg)) {
response->status.set_status(URLRequestStatus::FAILED);
return;
}
}
response->status = result.status;
response->url = result.final_url;
response->headers = result.headers;
response->mime_type = result.mime_type;
response->charset = result.charset;
response->data.swap(result.data);
}
} // namespace webkit_glue
// ResourceDispatcher ---------------------------------------------------------
ResourceDispatcher::ResourceDispatcher(IPC::Message::Sender* sender)
: message_sender_(sender),
#pragma warning(suppress: 4355)
method_factory_(this) {
}
ResourceDispatcher::~ResourceDispatcher() {
}
// ResourceDispatcher implementation ------------------------------------------
bool ResourceDispatcher::OnMessageReceived(const IPC::Message& message) {
switch (message.type()) {
case ViewMsg_Resource_UploadProgress::ID:
case ViewMsg_Resource_ReceivedResponse::ID:
case ViewMsg_Resource_ReceivedRedirect::ID:
case ViewMsg_Resource_DataReceived::ID:
case ViewMsg_Resource_RequestComplete::ID:
break;
default:
return false;
}
int request_id;
void* iter = NULL;
if (!message.ReadInt(&iter, &request_id)) {
NOTREACHED() << "malformed resource message";
return true;
}
PendingRequestList::iterator it = pending_requests_.find(request_id);
if (it == pending_requests_.end()) {
// This might happen for kill()ed requests on the webkit end, so perhaps it
// shouldn't be a warning...
DLOG(WARNING) << "Got response for a nonexistant or finished request";
return true;
}
PendingRequestInfo& request_info = it->second;
if (request_info.is_deferred) {
request_info.deferred_message_queue.push_back(new IPC::Message(message));
return true;
}
// Make sure any deferred messages are dispatched before we dispatch more.
if (!request_info.deferred_message_queue.empty())
FlushDeferredMessages(request_id);
DispatchMessage(message);
return true;
}
void ResourceDispatcher::OnUploadProgress(
int request_id, int64 position, int64 size) {
PendingRequestList::iterator it = pending_requests_.find(request_id);
if (it == pending_requests_.end()) {
// this might happen for kill()ed requests on the webkit end, so perhaps
// it shouldn't be a warning...
DLOG(WARNING) << "Got upload progress for a nonexistant or "
"finished request";
return;
}
PendingRequestInfo& request_info = it->second;
RESOURCE_LOG("Dispatching upload progress for " <<
request_info.peer->GetURLForDebugging());
request_info.peer->OnUploadProgress(position, size);
// Acknowlegde reciept
IPC::Message::Sender* sender = message_sender();
if (sender)
sender->Send(
new ViewHostMsg_UploadProgress_ACK(MSG_ROUTING_NONE, request_id));
}
void ResourceDispatcher::OnReceivedResponse(
int request_id,
const ViewMsg_Resource_ResponseHead& response_head) {
PendingRequestList::iterator it = pending_requests_.find(request_id);
if (it == pending_requests_.end()) {
// This might happen for kill()ed requests on the webkit end, so perhaps it
// shouldn't be a warning...
DLOG(WARNING) << "Got response for a nonexistant or finished request";
return;
}
PendingRequestInfo& request_info = it->second;
request_info.filter_policy = response_head.filter_policy;
webkit_glue::ResourceLoaderBridge::Peer* peer = request_info.peer;
if (request_info.filter_policy != FilterPolicy::DONT_FILTER) {
// TODO(jcampan): really pass the loader bridge.
webkit_glue::ResourceLoaderBridge::Peer* new_peer =
SecurityFilterPeer::CreateSecurityFilterPeer(
NULL, peer,
request_info.resource_type, response_head.mime_type,
request_info.filter_policy,
net::ERR_INSECURE_RESPONSE);
if (new_peer) {
request_info.peer = new_peer;
peer = new_peer;
}
}
RESOURCE_LOG("Dispatching response for " << peer->GetURLForDebugging());
peer->OnReceivedResponse(response_head);
}
void ResourceDispatcher::OnReceivedData(int request_id,
SharedMemoryHandle shm_handle,
int data_len) {
// Acknowlegde the reception of this data.
IPC::Message::Sender* sender = message_sender();
if (sender)
sender->Send(
new ViewHostMsg_DataReceived_ACK(MSG_ROUTING_NONE, request_id));
DCHECK((shm_handle && data_len > 0) || (!shm_handle && !data_len));
SharedMemory shared_mem(shm_handle, true); // read only
PendingRequestList::iterator it = pending_requests_.find(request_id);
if (it == pending_requests_.end()) {
// this might happen for kill()ed requests on the webkit end, so perhaps
// it shouldn't be a warning...
DLOG(WARNING) << "Got data for a nonexistant or finished request";
return;
}
PendingRequestInfo& request_info = it->second;
if (data_len > 0 && shared_mem.Map(data_len)) {
RESOURCE_LOG("Dispatching " << data_len << " bytes for " <<
request_info.peer->GetURLForDebugging());
const char* data = static_cast<char*>(shared_mem.memory());
request_info.peer->OnReceivedData(data, data_len);
}
}
void ResourceDispatcher::OnReceivedRedirect(int request_id,
const GURL& new_url) {
PendingRequestList::iterator it = pending_requests_.find(request_id);
if (it == pending_requests_.end()) {
// this might happen for kill()ed requests on the webkit end, so perhaps
// it shouldn't be a warning...
DLOG(WARNING) << "Got data for a nonexistant or finished request";
return;
}
PendingRequestInfo& request_info = it->second;
RESOURCE_LOG("Dispatching redirect for " <<
request_info.peer->GetURLForDebugging());
request_info.peer->OnReceivedRedirect(new_url);
}
void ResourceDispatcher::OnRequestComplete(int request_id,
const URLRequestStatus& status) {
PendingRequestList::iterator it = pending_requests_.find(request_id);
if (it == pending_requests_.end()) {
// this might happen for kill()ed requests on the webkit end, so perhaps
// it shouldn't be a warning...
DLOG(WARNING) << "Got 'complete' for a nonexistant or finished request";
return;
}
PendingRequestInfo& request_info = it->second;
webkit_glue::ResourceLoaderBridge::Peer* peer = request_info.peer;
RESOURCE_LOG("Dispatching complete for " <<
request_info.peer->GetURLForDebugging());
if (status.status() == URLRequestStatus::CANCELED &&
status.os_error() != net::ERR_ABORTED) {
// Resource canceled with a specific error are filtered.
SecurityFilterPeer* new_peer =
SecurityFilterPeer::CreateSecurityFilterPeerForDeniedRequest(
request_info.resource_type,
request_info.peer,
status.os_error());
if (new_peer) {
request_info.peer = new_peer;
peer = new_peer;
}
}
// The request ID will be removed from our pending list in the destructor.
// Normally, dispatching this message causes the reference-counted request to
// die immediately.
peer->OnCompletedRequest(status);
webkit_glue::NotifyCacheStats();
}
int ResourceDispatcher::AddPendingRequest(
webkit_glue::ResourceLoaderBridge::Peer* callback,
ResourceType::Type resource_type,
bool mixed_content) {
// Compute a unique request_id for this renderer process.
int id = MakeRequestID();
pending_requests_[id] = PendingRequestInfo(callback, resource_type,
mixed_content);
return id;
}
bool ResourceDispatcher::RemovePendingRequest(int request_id) {
PendingRequestList::iterator it = pending_requests_.find(request_id);
if (it == pending_requests_.end())
return false;
pending_requests_.erase(it);
return true;
}
void ResourceDispatcher::SetDefersLoading(int request_id, bool value) {
PendingRequestList::iterator it = pending_requests_.find(request_id);
if (it == pending_requests_.end()) {
NOTREACHED() << "unknown request";
return;
}
PendingRequestInfo& request_info = it->second;
if (value) {
request_info.is_deferred = value;
} else if (request_info.is_deferred) {
request_info.is_deferred = false;
MessageLoop::current()->PostTask(FROM_HERE,
method_factory_.NewRunnableMethod(
&ResourceDispatcher::FlushDeferredMessages, request_id));
}
}
void ResourceDispatcher::DispatchMessage(const IPC::Message& message) {
IPC_BEGIN_MESSAGE_MAP(ResourceDispatcher, message)
IPC_MESSAGE_HANDLER(ViewMsg_Resource_UploadProgress, OnUploadProgress)
IPC_MESSAGE_HANDLER(ViewMsg_Resource_ReceivedResponse, OnReceivedResponse)
IPC_MESSAGE_HANDLER(ViewMsg_Resource_ReceivedRedirect, OnReceivedRedirect)
IPC_MESSAGE_HANDLER(ViewMsg_Resource_DataReceived, OnReceivedData)
IPC_MESSAGE_HANDLER(ViewMsg_Resource_RequestComplete, OnRequestComplete)
IPC_END_MESSAGE_MAP()
}
void ResourceDispatcher::FlushDeferredMessages(int request_id) {
PendingRequestList::iterator it = pending_requests_.find(request_id);
if (it == pending_requests_.end()) // The request could have become invalid.
return;
PendingRequestInfo& request_info = it->second;
if (request_info.is_deferred)
return;
// Because message handlers could result in request_info being destroyed,
// we need to work with a stack reference to the deferred queue.
MessageQueue q;
q.swap(request_info.deferred_message_queue);
while (!q.empty()) {
IPC::Message* m = q.front();
q.pop_front();
DispatchMessage(*m);
delete m;
}
}
webkit_glue::ResourceLoaderBridge* ResourceDispatcher::CreateBridge(
const std::string& method,
const GURL& url,
const GURL& policy_url,
const GURL& referrer,
const std::string& headers,
int flags,
int origin_pid,
ResourceType::Type resource_type,
bool mixed_content,
uint32 request_context) {
return new webkit_glue::IPCResourceLoaderBridge(this, method, url, policy_url,
referrer, headers, flags,
origin_pid, resource_type,
mixed_content,
request_context);
}
|