OLD | NEW |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 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 | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 // This file declares a HttpTransactionFactory implementation that can be | 5 // This file declares a HttpTransactionFactory implementation that can be |
6 // layered on top of another HttpTransactionFactory to add HTTP caching. The | 6 // layered on top of another HttpTransactionFactory to add HTTP caching. The |
7 // caching logic follows RFC 7234 (any exceptions are called out in the code). | 7 // caching logic follows RFC 7234 (any exceptions are called out in the code). |
8 // | 8 // |
9 // The HttpCache takes a disk_cache::Backend as a parameter, and uses that for | 9 // The HttpCache takes a disk_cache::Backend as a parameter, and uses that for |
10 // the cache storage. | 10 // the cache storage. |
(...skipping 226 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
237 }; | 237 }; |
238 | 238 |
239 class MetadataWriter; | 239 class MetadataWriter; |
240 class QuicServerInfoFactoryAdaptor; | 240 class QuicServerInfoFactoryAdaptor; |
241 class Transaction; | 241 class Transaction; |
242 class WorkItem; | 242 class WorkItem; |
243 friend class Transaction; | 243 friend class Transaction; |
244 friend class ViewCacheHelper; | 244 friend class ViewCacheHelper; |
245 struct PendingOp; // Info for an entry under construction. | 245 struct PendingOp; // Info for an entry under construction. |
246 | 246 |
| 247 // To help with testing. |
| 248 friend class MockHttpCache; |
| 249 |
247 using TransactionList = std::list<Transaction*>; | 250 using TransactionList = std::list<Transaction*>; |
248 using TransactionSet = std::unordered_set<Transaction*>; | 251 using TransactionSet = std::unordered_set<Transaction*>; |
249 typedef std::list<std::unique_ptr<WorkItem>> WorkItemList; | 252 typedef std::list<std::unique_ptr<WorkItem>> WorkItemList; |
250 | 253 |
| 254 // We implement a basic reader/writer lock for the disk cache entry. If there |
| 255 // is a writer, then all transactions must wait to read the body. But the |
| 256 // waiting transactions can start their headers phase in parallel. Headers |
| 257 // phase is allowed for one transaction at a time so that if it doesn't match |
| 258 // the existing headers, remaining transactions do not also try to match the |
| 259 // existing entry in parallel leading to wasted network requests. If the |
| 260 // headers do not match, this entry will be doomed. |
| 261 // |
| 262 // A transaction goes through these state transitions. |
| 263 // |
| 264 // Write mode transactions: |
| 265 // add_to_entry_queue-> headers_transaction -> writer |
| 266 // add_to_entry_queue-> headers_transaction -> done_headers_queue -> readers |
| 267 // (once the data is written to the cache by another writer) |
| 268 // |
| 269 // Read only transactions: |
| 270 // add_to_entry_queue-> headers_transaction -> done_headers_queue -> readers |
| 271 // (once the data is written to the cache by the writer) |
| 272 |
251 struct ActiveEntry { | 273 struct ActiveEntry { |
252 explicit ActiveEntry(disk_cache::Entry* entry); | 274 explicit ActiveEntry(disk_cache::Entry* entry); |
253 ~ActiveEntry(); | 275 ~ActiveEntry(); |
254 size_t EstimateMemoryUsage() const; | 276 size_t EstimateMemoryUsage() const; |
255 | 277 |
256 // Returns true if no transactions are associated with this entry. | 278 // Returns true if no transactions are associated with this entry. |
257 bool HasNoTransactions(); | 279 bool HasNoTransactions(); |
258 | 280 |
259 disk_cache::Entry* disk_entry; | 281 disk_cache::Entry* disk_entry = nullptr; |
260 Transaction* writer; | 282 |
| 283 // Transactions waiting to be added to entry. |
| 284 TransactionList add_to_entry_queue; |
| 285 |
| 286 // Transaction currently in the headers phase, either validating the |
| 287 // response or getting new headers. This can exist simultaneously with |
| 288 // writer or readers while validating existing headers. |
| 289 Transaction* headers_transaction = nullptr; |
| 290 |
| 291 // Transactions that have completed their headers phase and are waiting |
| 292 // to read the response body or write the response body. |
| 293 TransactionList done_headers_queue; |
| 294 |
| 295 // Transaction currently reading from the network and writing to the cache. |
| 296 Transaction* writer = nullptr; |
| 297 |
| 298 // Transactions that can only read from the cache. Only one of writer or |
| 299 // readers can exist at a time. |
261 TransactionSet readers; | 300 TransactionSet readers; |
262 TransactionList pending_queue; | 301 |
263 bool will_process_pending_queue; | 302 // The following variables are true if OnProcessQueuedTransactions is posted |
264 bool doomed; | 303 bool will_process_queued_transactions = false; |
| 304 |
| 305 // True if entry is doomed. |
| 306 bool doomed = false; |
265 }; | 307 }; |
266 | 308 |
267 using ActiveEntriesMap = | 309 using ActiveEntriesMap = |
268 std::unordered_map<std::string, std::unique_ptr<ActiveEntry>>; | 310 std::unordered_map<std::string, std::unique_ptr<ActiveEntry>>; |
269 using PendingOpsMap = std::unordered_map<std::string, PendingOp*>; | 311 using PendingOpsMap = std::unordered_map<std::string, PendingOp*>; |
270 using ActiveEntriesSet = std::map<ActiveEntry*, std::unique_ptr<ActiveEntry>>; | 312 using ActiveEntriesSet = std::map<ActiveEntry*, std::unique_ptr<ActiveEntry>>; |
271 using PlaybackCacheMap = std::unordered_map<std::string, int>; | 313 using PlaybackCacheMap = std::unordered_map<std::string, int>; |
272 | 314 |
273 // Methods ------------------------------------------------------------------ | 315 // Methods ------------------------------------------------------------------ |
274 | 316 |
(...skipping 60 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
335 | 377 |
336 // Creates the disk cache entry associated with |key|, returning an | 378 // Creates the disk cache entry associated with |key|, returning an |
337 // ActiveEntry in |*entry|. |trans| will be notified via its IO callback if | 379 // ActiveEntry in |*entry|. |trans| will be notified via its IO callback if |
338 // this method returns ERR_IO_PENDING. | 380 // this method returns ERR_IO_PENDING. |
339 int CreateEntry(const std::string& key, ActiveEntry** entry, | 381 int CreateEntry(const std::string& key, ActiveEntry** entry, |
340 Transaction* trans); | 382 Transaction* trans); |
341 | 383 |
342 // Destroys an ActiveEntry (active or doomed). | 384 // Destroys an ActiveEntry (active or doomed). |
343 void DestroyEntry(ActiveEntry* entry); | 385 void DestroyEntry(ActiveEntry* entry); |
344 | 386 |
345 // Adds a transaction to an ActiveEntry. If this method returns ERR_IO_PENDING | 387 // Adds a transaction to an ActiveEntry. This method returns ERR_IO_PENDING |
346 // the transaction will be notified about completion via its IO callback. This | 388 // and the transaction will be notified about completion via its IO callback. |
347 // method returns ERR_CACHE_RACE to signal the transaction that it cannot be | 389 // In a failure case, the callback will be invoked with ERR_CACHE_RACE. |
348 // added to the provided entry, and it should retry the process with another | 390 int AddTransactionToEntry(ActiveEntry* entry, Transaction* transaction); |
349 // one (in this case, the entry is no longer valid). | |
350 int AddTransactionToEntry(ActiveEntry* entry, Transaction* trans); | |
351 | 391 |
352 // Called when the transaction has finished working with this entry. |cancel| | 392 // Transaction invokes this when its response headers phase is complete |
353 // is true if the operation was cancelled by the caller instead of running | 393 // If the transaction is responsible for writing the response body, |
354 // to completion. | 394 // it becomes the writer and returns OK. In other cases ERR_IO_PENDING is |
355 void DoneWithEntry(ActiveEntry* entry, Transaction* trans, bool cancel); | 395 // returned and the transaction will be notified about completion via its |
| 396 // IO callback. In a failure case, the callback will be invoked with |
| 397 // ERR_CACHE_RACE. |
| 398 int DoneWithResponseHeaders(ActiveEntry* entry, |
| 399 Transaction* transaction, |
| 400 bool is_partial); |
| 401 |
| 402 // Called when the transaction has finished working with this entry. |
| 403 // |process_cancel| is true if the transaction could have been writing the |
| 404 // response body and was cancelled by the caller instead of running |
| 405 // to completion. This will be confirmed and if true, its impact on queued |
| 406 // transactions will be processed. |
| 407 void DoneWithEntry(ActiveEntry* entry, |
| 408 Transaction* transaction, |
| 409 bool process_cancel, |
| 410 bool is_partial); |
356 | 411 |
357 // Called when the transaction has finished writing to this entry. |success| | 412 // Called when the transaction has finished writing to this entry. |success| |
358 // is false if the cache entry should be deleted. | 413 // is false if the cache entry should be deleted. |
359 void DoneWritingToEntry(ActiveEntry* entry, bool success); | 414 void DoneWritingToEntry(ActiveEntry* entry, |
| 415 bool success, |
| 416 Transaction* transaction); |
360 | 417 |
361 // Called when the transaction has finished reading from this entry. | 418 // Called when the transaction has finished reading from this entry. |
362 void DoneReadingFromEntry(ActiveEntry* entry, Transaction* trans); | 419 void DoneReadingFromEntry(ActiveEntry* entry, Transaction* transaction); |
363 | 420 |
364 // Converts the active writer transaction to a reader so that other | 421 // Removes and returns all queued transactions in |entry| in FIFO order. This |
365 // transactions can start reading from this entry. | 422 // includes transactions that have completed the headers phase and those that |
366 void ConvertWriterToReader(ActiveEntry* entry); | 423 // have not been added to the entry yet in that order. |list| is the output |
| 424 // argument. |
| 425 void RemoveAllQueuedTransactions(ActiveEntry* entry, TransactionList* list); |
| 426 |
| 427 // Processes either writer's failure to write response body or |
| 428 // headers_transactions's failure to write headers. Also invoked when headers |
| 429 // transaction's validation result is not a match. |
| 430 void ProcessEntryFailure(ActiveEntry* entry, Transaction* transaction); |
| 431 |
| 432 // Restarts headers_transaction and done_headers_queue transactions. |
| 433 void RestartHeadersPhaseTransactions(ActiveEntry* entry, |
| 434 Transaction* transaction); |
| 435 |
| 436 // Restarts the headers_transaction by setting its state. Since the |
| 437 // headers_transaction is awaiting an asynchronous operation completion, |
| 438 // it will be restarted when it's IO callback is invoked. |
| 439 void RestartHeadersTransaction(ActiveEntry* entry); |
| 440 |
| 441 // Resumes processing the queued transactions of |entry|. |
| 442 void ProcessQueuedTransactions(ActiveEntry* entry); |
| 443 |
| 444 // Checks if a transaction can be added to the entry. If yes, it will |
| 445 // invoke the IO callback of the transaction. This is a helper function for |
| 446 // OnProcessQueuedTransactions. It will take a transaction from |
| 447 // add_to_entry_queue and make it a headers_transaction, if one doesn't exist |
| 448 // already. |
| 449 void ProcessAddToEntryQueue(ActiveEntry* entry); |
| 450 |
| 451 // Invoked when a transaction that has already completed the response headers |
| 452 // phase can resume reading/writing the response body. It will invoke the IO |
| 453 // callback of the transaction. This is a helper function for |
| 454 // OnProcessQueuedTransactions. |
| 455 void ProcessDoneHeadersQueue(ActiveEntry* entry); |
| 456 |
| 457 // Returns true if this transaction can write headers to the entry. |
| 458 bool CanTransactionWriteResponseHeaders(ActiveEntry* entry, |
| 459 Transaction* transaction, |
| 460 bool is_partial, |
| 461 bool is_match) const; |
| 462 |
| 463 // Returns true if any transactions in the ActiveEntry depend on this |
| 464 // transaction to complete writing to the cache. |
| 465 bool HasDependentTransactions(ActiveEntry* entry, |
| 466 Transaction* transaction, |
| 467 bool is_partial) const; |
| 468 |
| 469 // Returns true if a transaction is currently writing the response body. |
| 470 bool IsWritingInProgress(ActiveEntry* entry) const; |
367 | 471 |
368 // Returns the LoadState of the provided pending transaction. | 472 // Returns the LoadState of the provided pending transaction. |
369 LoadState GetLoadStateForPendingTransaction(const Transaction* trans); | 473 LoadState GetLoadStateForPendingTransaction(const Transaction* trans); |
370 | 474 |
371 // Removes the transaction |trans|, from the pending list of an entry | 475 // Removes the transaction |trans|, from the pending list of an entry |
372 // (PendingOp, active or doomed entry). | 476 // (PendingOp, active or doomed entry). |
373 void RemovePendingTransaction(Transaction* trans); | 477 void RemovePendingTransaction(Transaction* trans); |
374 | 478 |
375 // Removes the transaction |trans|, from the pending list of |entry|. | 479 // Removes the transaction |trans|, from the pending list of |entry|. |
376 bool RemovePendingTransactionFromEntry(ActiveEntry* entry, | 480 bool RemovePendingTransactionFromEntry(ActiveEntry* entry, |
377 Transaction* trans); | 481 Transaction* trans); |
378 | 482 |
379 // Removes the transaction |trans|, from the pending list of |pending_op|. | 483 // Removes the transaction |trans|, from the pending list of |pending_op|. |
380 bool RemovePendingTransactionFromPendingOp(PendingOp* pending_op, | 484 bool RemovePendingTransactionFromPendingOp(PendingOp* pending_op, |
381 Transaction* trans); | 485 Transaction* trans); |
382 // Resumes processing the pending list of |entry|. | |
383 void ProcessPendingQueue(ActiveEntry* entry); | |
384 | 486 |
385 // Events (called via PostTask) --------------------------------------------- | 487 // Events (called via PostTask) --------------------------------------------- |
386 | 488 |
387 void OnProcessPendingQueue(ActiveEntry* entry); | 489 void OnProcessQueuedTransactions(ActiveEntry* entry); |
388 | 490 |
389 // Callbacks ---------------------------------------------------------------- | 491 // Callbacks ---------------------------------------------------------------- |
390 | 492 |
391 // Processes BackendCallback notifications. | 493 // Processes BackendCallback notifications. |
392 void OnIOComplete(int result, PendingOp* entry); | 494 void OnIOComplete(int result, PendingOp* entry); |
393 | 495 |
394 // Helper to conditionally delete |pending_op| if the HttpCache object it | 496 // Helper to conditionally delete |pending_op| if the HttpCache object it |
395 // is meant for has been deleted. | 497 // is meant for has been deleted. |
396 // | 498 // |
397 // TODO(ajwong): The PendingOp lifetime management is very tricky. It might | 499 // TODO(ajwong): The PendingOp lifetime management is very tricky. It might |
(...skipping 37 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
435 std::unique_ptr<base::Clock> clock_; | 537 std::unique_ptr<base::Clock> clock_; |
436 | 538 |
437 base::WeakPtrFactory<HttpCache> weak_factory_; | 539 base::WeakPtrFactory<HttpCache> weak_factory_; |
438 | 540 |
439 DISALLOW_COPY_AND_ASSIGN(HttpCache); | 541 DISALLOW_COPY_AND_ASSIGN(HttpCache); |
440 }; | 542 }; |
441 | 543 |
442 } // namespace net | 544 } // namespace net |
443 | 545 |
444 #endif // NET_HTTP_HTTP_CACHE_H_ | 546 #endif // NET_HTTP_HTTP_CACHE_H_ |
OLD | NEW |