#include "net/http/http_cache.h"
#include <utility>
#include "base/compiler_specific.h"
#include "base/feature_list.h"
#include "base/files/file_util.h"
#include "base/format_macros.h"
#include "base/functional/bind.h"
#include "base/functional/callback.h"
#include "base/functional/callback_helpers.h"
#include "base/location.h"
#include "base/memory/ptr_util.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/ref_counted.h"
#include "base/metrics/field_trial.h"
#include "base/metrics/histogram_macros.h"
#include "base/metrics/histogram_macros_local.h"
#include "base/pickle.h"
#include "base/ranges/algorithm.h"
#include "base/strings/strcat.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/string_util.h"
#include "base/strings/stringprintf.h"
#include "base/task/single_thread_task_runner.h"
#include "base/time/default_clock.h"
#include "build/build_config.h"
#include "http_request_info.h"
#include "net/base/cache_type.h"
#include "net/base/features.h"
#include "net/base/io_buffer.h"
#include "net/base/load_flags.h"
#include "net/base/net_errors.h"
#include "net/base/network_anonymization_key.h"
#include "net/base/network_isolation_key.h"
#include "net/base/upload_data_stream.h"
#include "net/disk_cache/disk_cache.h"
#include "net/http/http_cache_lookup_manager.h"
#include "net/http/http_cache_transaction.h"
#include "net/http/http_cache_writers.h"
#include "net/http/http_network_layer.h"
#include "net/http/http_network_session.h"
#include "net/http/http_request_info.h"
#include "net/http/http_response_headers.h"
#include "net/http/http_response_info.h"
#include "net/http/http_util.h"
#include "net/log/net_log_with_source.h"
#include "net/quic/quic_server_info.h"
#include "third_party/abseil-cpp/absl/types/optional.h"
#if BUILDFLAG(IS_POSIX)
#include <unistd.h>
#endif
namespace net {
namespace {
bool g_init_cache = false;
bool g_enable_split_cache = false;
}
const char HttpCache::kDoubleKeyPrefix[] = "_dk_";
const char HttpCache::kDoubleKeySeparator[] = " ";
const char HttpCache::kSubframeDocumentResourcePrefix[] = "s_";
const char HttpCache::kSingleKeyPrefix[] = "_sk_";
const char HttpCache::kSingleKeySeparator[] = " ";
HttpCache::DefaultBackend::DefaultBackend(
CacheType type,
BackendType backend_type,
scoped_refptr<disk_cache::BackendFileOperationsFactory>
file_operations_factory,
const base::FilePath& path,
int max_bytes,
bool hard_reset)
: type_(type),
backend_type_(backend_type),
file_operations_factory_(std::move(file_operations_factory)),
path_(path),
max_bytes_(max_bytes),
hard_reset_(hard_reset) {}
HttpCache::DefaultBackend::~DefaultBackend() = default;
std::unique_ptr<HttpCache::BackendFactory> HttpCache::DefaultBackend::InMemory(
int max_bytes) {
return std::make_unique<DefaultBackend>(MEMORY_CACHE, CACHE_BACKEND_DEFAULT,
nullptr,
base::FilePath(), max_bytes, false);
}
disk_cache::BackendResult HttpCache::DefaultBackend::CreateBackend(
NetLog* net_log,
base::OnceCallback<void(disk_cache::BackendResult)> callback) {
DCHECK_GE(max_bytes_, 0);
disk_cache::ResetHandling reset_handling =
hard_reset_ ? disk_cache::ResetHandling::kReset
: disk_cache::ResetHandling::kResetOnError;
LOCAL_HISTOGRAM_BOOLEAN("HttpCache.HardReset", hard_reset_);
#if BUILDFLAG(IS_ANDROID)
if (app_status_listener_) {
return disk_cache::CreateCacheBackend(
type_, backend_type_, file_operations_factory_, path_, max_bytes_,
reset_handling, net_log, std::move(callback), app_status_listener_);
}
#endif
return disk_cache::CreateCacheBackend(
type_, backend_type_, file_operations_factory_, path_, max_bytes_,
reset_handling, net_log, std::move(callback));
}
#if BUILDFLAG(IS_ANDROID)
void HttpCache::DefaultBackend::SetAppStatusListener(
base::android::ApplicationStatusListener* app_status_listener) {
app_status_listener_ = app_status_listener;
}
#endif
HttpCache::ActiveEntry::ActiveEntry(disk_cache::Entry* entry, bool opened_in)
: disk_entry(entry), opened(opened_in) {
DCHECK(disk_entry);
}
HttpCache::ActiveEntry::~ActiveEntry() = default;
bool HttpCache::ActiveEntry::HasNoTransactions() {
return (!writers || writers->IsEmpty()) && readers.empty() &&
add_to_entry_queue.empty() && done_headers_queue.empty() &&
!headers_transaction;
}
bool HttpCache::ActiveEntry::SafeToDestroy() {
return HasNoTransactions() && !writers && !will_process_queued_transactions;
}
bool HttpCache::ActiveEntry::TransactionInReaders(
Transaction* transaction) const {
return readers.count(transaction) > 0;
}
struct HttpCache::PendingOp {
PendingOp() = default;
~PendingOp() = default;
raw_ptr<disk_cache::Entry, DanglingUntriaged> entry = nullptr;
bool entry_opened = false;
std::unique_ptr<disk_cache::Backend> backend;
std::unique_ptr<WorkItem> writer;
bool callback_will_delete = false;
WorkItemList pending_queue;
};
class HttpCache::WorkItem {
public:
WorkItem(WorkItemOperation operation,
Transaction* transaction,
ActiveEntry** entry)
: operation_(operation), transaction_(transaction), entry_(entry) {}
WorkItem(WorkItemOperation operation,
Transaction* transaction,
CompletionOnceCallback callback)
: operation_(operation),
transaction_(transaction),
entry_(nullptr),
callback_(std::move(callback)) {}
~WorkItem() = default;
void NotifyTransaction(int result, ActiveEntry* entry) {
if (entry_)
*entry_ = entry;
if (transaction_)
transaction_->io_callback().Run(result);
}
bool DoCallback(int result) {
if (!callback_.is_null()) {
std::move(callback_).Run(result);
return true;
}
return false;
}
WorkItemOperation operation() { return operation_; }
void ClearTransaction() { transaction_ = nullptr; }
void ClearEntry() { entry_ = nullptr; }
void ClearCallback() { callback_.Reset(); }
bool Matches(Transaction* transaction) const {
return transaction == transaction_;
}
bool IsValid() const {
return transaction_ || entry_ || !callback_.is_null();
}
private:
WorkItemOperation operation_;
raw_ptr<Transaction, DanglingUntriaged> transaction_;
raw_ptr<ActiveEntry*, DanglingUntriaged> entry_;
CompletionOnceCallback callback_;
};
HttpCache::HttpCache(std::unique_ptr<HttpTransactionFactory> network_layer,
std::unique_ptr<BackendFactory> backend_factory)
: net_log_(nullptr),
backend_factory_(std::move(backend_factory)),
network_layer_(std::move(network_layer)),
clock_(base::DefaultClock::GetInstance()) {
g_init_cache = true;
HttpNetworkSession* session = network_layer_->GetSession();
if (!session)
return;
net_log_ = session->net_log();
session->SetServerPushDelegate(
std::make_unique<HttpCacheLookupManager>(this));
}
HttpCache::~HttpCache() {
DCHECK_CALLED_ON_VALID_THREAD(thread_checker_);
weak_factory_.InvalidateWeakPtrs();
while (!active_entries_.empty()) {
ActiveEntry* entry = active_entries_.begin()->second.get();
entry->will_process_queued_transactions = false;
entry->add_to_entry_queue.clear();
entry->readers.clear();
entry->done_headers_queue.clear();
entry->headers_transaction = nullptr;
entry->writers.reset();
DeactivateEntry(entry);
}
doomed_entries_.clear();
disk_cache_.reset();
for (auto& pending_it : pending_ops_) {
PendingOp* pending_op = pending_it.second;
pending_op->writer.reset();
bool delete_pending_op = true;
if (building_backend_ && pending_op->callback_will_delete) {
delete_pending_op = false;
}
pending_op->pending_queue.clear();
if (delete_pending_op)
delete pending_op;
}
}
int HttpCache::GetBackend(disk_cache::Backend** backend,
CompletionOnceCallback callback) {
DCHECK(!callback.is_null());
if (disk_cache_.get()) {
*backend = disk_cache_.get();
return OK;
}
int rv =
CreateBackend(base::BindOnce(&HttpCache::ReportGetBackendResult,
GetWeakPtr(), backend, std::move(callback)));
if (rv != net::ERR_IO_PENDING)
*backend = disk_cache_.get();
return rv;
}
void HttpCache::ReportGetBackendResult(disk_cache::Backend** backend,
CompletionOnceCallback callback,
int net_error) {
*backend = disk_cache_.get();
std::move(callback).Run(net_error);
}
disk_cache::Backend* HttpCache::GetCurrentBackend() const {
return disk_cache_.get();
}
bool HttpCache::ParseResponseInfo(const char* data, int len,
HttpResponseInfo* response_info,
bool* response_truncated) {
base::Pickle pickle(data, len);
return response_info->InitFromPickle(pickle, response_truncated);
}
void HttpCache::CloseAllConnections(int net_error,
const char* net_log_reason_utf8) {
HttpNetworkSession* session = GetSession();
if (session)
session->CloseAllConnections(net_error, net_log_reason_utf8);
}
void HttpCache::CloseIdleConnections(const char* net_log_reason_utf8) {
HttpNetworkSession* session = GetSession();
if (session)
session->CloseIdleConnections(net_log_reason_utf8);
}
void HttpCache::OnExternalCacheHit(
const GURL& url,
const std::string& http_method,
const NetworkIsolationKey& network_isolation_key,
bool is_subframe_document_resource,
bool used_credentials) {
if (!disk_cache_.get() || mode_ == DISABLE)
return;
if (IsSplitCacheEnabled() && network_isolation_key.IsTransient())
return;
HttpRequestInfo request_info;
request_info.url = url;
request_info.method = http_method;
request_info.network_isolation_key = network_isolation_key;
request_info.network_anonymization_key =
net::NetworkAnonymizationKey::CreateFromNetworkIsolationKey(
network_isolation_key);
request_info.is_subframe_document_resource = is_subframe_document_resource;
if (base::FeatureList::IsEnabled(features::kSplitCacheByIncludeCredentials)) {
if (!used_credentials)
request_info.load_flags &= LOAD_DO_NOT_SAVE_COOKIES;
else
request_info.load_flags |= ~LOAD_DO_NOT_SAVE_COOKIES;
}
std::string key = *GenerateCacheKeyForRequest(
&request_info, false);
disk_cache_->OnExternalCacheHit(key);
}
int HttpCache::CreateTransaction(
RequestPriority priority,
std::unique_ptr<HttpTransaction>* transaction) {
if (!disk_cache_.get()) {
CreateBackend(CompletionOnceCallback());
}
auto new_transaction =
std::make_unique<HttpCache::Transaction>(priority, this);
if (bypass_lock_for_test_)
new_transaction->BypassLockForTest();
if (bypass_lock_after_headers_for_test_)
new_transaction->BypassLockAfterHeadersForTest();
if (fail_conditionalization_for_test_)
new_transaction->FailConditionalizationForTest();
*transaction = std::move(new_transaction);
return OK;
}
HttpCache* HttpCache::GetCache() {
return this;
}
HttpNetworkSession* HttpCache::GetSession() {
return network_layer_->GetSession();
}
std::unique_ptr<HttpTransactionFactory>
HttpCache::SetHttpNetworkTransactionFactoryForTesting(
std::unique_ptr<HttpTransactionFactory> new_network_layer) {
std::unique_ptr<HttpTransactionFactory> old_network_layer(
std::move(network_layer_));
network_layer_ = std::move(new_network_layer);
return old_network_layer;
}
std::string HttpCache::GetResourceURLFromHttpCacheKey(const std::string& key) {
std::string::size_type pos = 0;
pos = key.find('/', pos) + 1;
pos = key.find('/', pos) + 1;
if (pos == std::string::npos)
return "";
if (pos == key.find(kDoubleKeyPrefix, pos)) {
pos = key.rfind(kDoubleKeySeparator);
DCHECK_NE(pos, std::string::npos);
pos += strlen(kDoubleKeySeparator);
DCHECK_LE(pos, key.size() - 1);
} else if (pos == key.find(kSingleKeyPrefix, pos)) {
pos = key.rfind(kSingleKeySeparator);
DCHECK_NE(pos, std::string::npos);
pos += strlen(kSingleKeySeparator);
DCHECK_LE(pos, key.size() - 1);
}
return key.substr(pos);
}
absl::optional<std::string> HttpCache::GenerateCacheKey(
const GURL& url,
int load_flags,
const NetworkIsolationKey& network_isolation_key,
int64_t upload_data_identifier,
bool is_subframe_document_resource,
bool use_single_keyed_cache,
const std::string& single_key_checksum) {
const char credential_key =
((base::FeatureList::IsEnabled(
features::kSplitCacheByIncludeCredentials) ||
use_single_keyed_cache) &&
(load_flags & LOAD_DO_NOT_SAVE_COOKIES))
? '0'
: '1';
std::string isolation_key;
if (use_single_keyed_cache) {
DCHECK(IsSplitCacheEnabled());
DCHECK(!(load_flags &
(net::LOAD_VALIDATE_CACHE | net::LOAD_BYPASS_CACHE |
net::LOAD_SKIP_CACHE_VALIDATION | net::LOAD_ONLY_FROM_CACHE |
net::LOAD_DISABLE_CACHE | net::LOAD_SKIP_VARY_CHECK)));
isolation_key = base::StrCat(
{kSingleKeyPrefix, single_key_checksum, kSingleKeySeparator});
} else if (IsSplitCacheEnabled()) {
if (network_isolation_key.IsTransient())
return absl::nullopt;
std::string subframe_document_resource_prefix =
is_subframe_document_resource ? kSubframeDocumentResourcePrefix : "";
isolation_key = base::StrCat(
{kDoubleKeyPrefix, subframe_document_resource_prefix,
*network_isolation_key.ToCacheKeyString(), kDoubleKeySeparator});
}
return base::StringPrintf("%c/%" PRId64 "/%s%s", credential_key,
upload_data_identifier, isolation_key.c_str(),
HttpUtil::SpecForRequest(url).c_str());
}
absl::optional<std::string> HttpCache::GenerateCacheKeyForRequest(
const HttpRequestInfo* request,
bool use_single_keyed_cache) {
DCHECK(request);
const int64_t upload_data_identifier =
request->upload_data_stream ? request->upload_data_stream->identifier()
: int64_t(0);
return GenerateCacheKey(
request->url, request->load_flags, request->network_isolation_key,
upload_data_identifier, request->is_subframe_document_resource,
use_single_keyed_cache, request->checksum);
}
void HttpCache::SplitCacheFeatureEnableByDefault() {
CHECK(!g_enable_split_cache && !g_init_cache);
if (!base::FeatureList::GetInstance()->IsFeatureOverridden(
"SplitCacheByNetworkIsolationKey")) {
g_enable_split_cache = true;
}
}
bool HttpCache::IsSplitCacheEnabled() {
return base::FeatureList::IsEnabled(
features::kSplitCacheByNetworkIsolationKey) ||
g_enable_split_cache;
}
void HttpCache::ClearGlobalsForTesting() {
g_init_cache = false;
g_enable_split_cache = false;
}
net::Error HttpCache::CreateAndSetWorkItem(ActiveEntry** entry,
Transaction* transaction,
WorkItemOperation operation,
PendingOp* pending_op) {
auto item = std::make_unique<WorkItem>(operation, transaction, entry);
if (pending_op->writer) {
pending_op->pending_queue.push_back(std::move(item));
return ERR_IO_PENDING;
}
DCHECK(pending_op->pending_queue.empty());
pending_op->writer = std::move(item);
return OK;
}
int HttpCache::CreateBackend(CompletionOnceCallback callback) {
DCHECK(!disk_cache_);
if (!backend_factory_.get())
return ERR_FAILED;
building_backend_ = true;
const bool callback_is_null = callback.is_null();
std::unique_ptr<WorkItem> item = std::make_unique<WorkItem>(
WI_CREATE_BACKEND, nullptr, std::move(callback));
PendingOp* pending_op = GetPendingOp(std::string());
if (pending_op->writer) {
if (!callback_is_null)
pending_op->pending_queue.push_back(std::move(item));
return ERR_IO_PENDING;
}
DCHECK(pending_op->pending_queue.empty());
pending_op->writer = std::move(item);
disk_cache::BackendResult result = backend_factory_->CreateBackend(
net_log_, base::BindOnce(&HttpCache::OnPendingBackendCreationOpComplete,
GetWeakPtr(), pending_op));
if (result.net_error == ERR_IO_PENDING) {
pending_op->callback_will_delete = true;
return result.net_error;
}
pending_op->writer->ClearCallback();
int rv = result.net_error;
OnPendingBackendCreationOpComplete(GetWeakPtr(), pending_op,
std::move(result));
return rv;
}
int HttpCache::GetBackendForTransaction(Transaction* transaction) {
if (disk_cache_.get())
return OK;
if (!building_backend_)
return ERR_FAILED;
std::unique_ptr<WorkItem> item = std::make_unique<WorkItem>(
WI_CREATE_BACKEND, transaction, CompletionOnceCallback());
PendingOp* pending_op = GetPendingOp(std::string());
DCHECK(pending_op->writer);
pending_op->pending_queue.push_back(std::move(item));
return ERR_IO_PENDING;
}
void HttpCache::DoomActiveEntry(const std::string& key) {
auto it = active_entries_.find(key);
if (it == active_entries_.end())
return;
int rv = DoomEntry(key, nullptr);
DCHECK_EQ(OK, rv);
}
int HttpCache::DoomEntry(const std::string& key, Transaction* transaction) {
auto it = active_entries_.find(key);
if (it == active_entries_.end()) {
DCHECK(transaction);
return AsyncDoomEntry(key, transaction);
}
std::unique_ptr<ActiveEntry> entry = std::move(it->second);
active_entries_.erase(it);
ActiveEntry* entry_ptr = entry.get();
DCHECK_EQ(0u, doomed_entries_.count(entry_ptr));
doomed_entries_[entry_ptr] = std::move(entry);
entry_ptr->GetEntry()->Doom();
entry_ptr->doomed = true;
DCHECK(!entry_ptr->SafeToDestroy());
return OK;
}
int HttpCache::AsyncDoomEntry(const std::string& key,
Transaction* transaction) {
PendingOp* pending_op = GetPendingOp(key);
int rv =
CreateAndSetWorkItem(nullptr, transaction, WI_DOOM_ENTRY, pending_op);
if (rv != OK)
return rv;
net::RequestPriority priority =
transaction ? transaction->priority() : net::LOWEST;
rv = disk_cache_->DoomEntry(key, priority,
base::BindOnce(&HttpCache::OnPendingOpComplete,
GetWeakPtr(), pending_op));
if (rv == ERR_IO_PENDING) {
pending_op->callback_will_delete = true;
return rv;
}
pending_op->writer->ClearTransaction();
OnPendingOpComplete(GetWeakPtr(), pending_op, rv);
return rv;
}
void HttpCache::DoomMainEntryForUrl(const GURL& url,
const NetworkIsolationKey& isolation_key,
bool is_subframe_document_resource) {
if (!disk_cache_)
return;
if (IsSplitCacheEnabled() && isolation_key.IsTransient())
return;
HttpRequestInfo temp_info;
temp_info.url = url;
temp_info.method = "GET";
temp_info.network_isolation_key = isolation_key;
temp_info.network_anonymization_key =
net::NetworkAnonymizationKey::CreateFromNetworkIsolationKey(
isolation_key);
temp_info.is_subframe_document_resource = is_subframe_document_resource;
std::string key =
*GenerateCacheKeyForRequest(&temp_info, false);
if (active_entries_.count(key))
DoomEntry(key, nullptr);
else
AsyncDoomEntry(key, nullptr);
}
void HttpCache::FinalizeDoomedEntry(ActiveEntry* entry) {
DCHECK(entry->doomed);
DCHECK(entry->SafeToDestroy());
auto it = doomed_entries_.find(entry);
DCHECK(it != doomed_entries_.end());
doomed_entries_.erase(it);
}
HttpCache::ActiveEntry* HttpCache::FindActiveEntry(const std::string& key) {
auto it = active_entries_.find(key);
return it != active_entries_.end() ? it->second.get() : nullptr;
}
HttpCache::ActiveEntry* HttpCache::ActivateEntry(disk_cache::Entry* disk_entry,
bool opened) {
DCHECK(!FindActiveEntry(disk_entry->GetKey()));
auto entry = std::make_unique<ActiveEntry>(disk_entry, opened);
ActiveEntry* entry_ptr = entry.get();
active_entries_[disk_entry->GetKey()] = std::move(entry);
return entry_ptr;
}
void HttpCache::DeactivateEntry(ActiveEntry* entry) {
DCHECK(!entry->doomed);
DCHECK(entry->SafeToDestroy());
std::string key = entry->GetEntry()->GetKey();
if (key.empty())
return SlowDeactivateEntry(entry);
auto it = active_entries_.find(key);
DCHECK(it != active_entries_.end());
DCHECK(it->second.get() == entry);
active_entries_.erase(it);
}
void HttpCache::SlowDeactivateEntry(ActiveEntry* entry) {
for (auto it = active_entries_.begin(); it != active_entries_.end(); ++it) {
if (it->second.get() == entry) {
active_entries_.erase(it);
break;
}
}
}
HttpCache::PendingOp* HttpCache::GetPendingOp(const std::string& key) {
DCHECK(!FindActiveEntry(key));
auto it = pending_ops_.find(key);
if (it != pending_ops_.end())
return it->second;
PendingOp* operation = new PendingOp();
pending_ops_[key] = operation;
return operation;
}
void HttpCache::DeletePendingOp(PendingOp* pending_op) {
std::string key;
if (pending_op->entry)
key = pending_op->entry->GetKey();
if (!key.empty()) {
auto it = pending_ops_.find(key);
DCHECK(it != pending_ops_.end());
pending_ops_.erase(it);
} else {
for (auto it = pending_ops_.begin(); it != pending_ops_.end(); ++it) {
if (it->second == pending_op) {
pending_ops_.erase(it);
break;
}
}
}
DCHECK(pending_op->pending_queue.empty());
delete pending_op;
}
int HttpCache::OpenOrCreateEntry(const std::string& key,
ActiveEntry** entry,
Transaction* transaction) {
DCHECK(!FindActiveEntry(key));
PendingOp* pending_op = GetPendingOp(key);
int rv = CreateAndSetWorkItem(entry, transaction, WI_OPEN_OR_CREATE_ENTRY,
pending_op);
if (rv != OK)
return rv;
disk_cache::EntryResult entry_result = disk_cache_->OpenOrCreateEntry(
key, transaction->priority(),
base::BindOnce(&HttpCache::OnPendingCreationOpComplete, GetWeakPtr(),
pending_op));
rv = entry_result.net_error();
if (rv == ERR_IO_PENDING) {
pending_op->callback_will_delete = true;
return ERR_IO_PENDING;
}
pending_op->writer->ClearTransaction();
OnPendingCreationOpComplete(GetWeakPtr(), pending_op,
std::move(entry_result));
return rv;
}
int HttpCache::OpenEntry(const std::string& key,
ActiveEntry** entry,
Transaction* transaction) {
DCHECK(!FindActiveEntry(key));
PendingOp* pending_op = GetPendingOp(key);
int rv = CreateAndSetWorkItem(entry, transaction, WI_OPEN_ENTRY, pending_op);
if (rv != OK)
return rv;
disk_cache::EntryResult entry_result = disk_cache_->OpenEntry(
key, transaction->priority(),
base::BindOnce(&HttpCache::OnPendingCreationOpComplete, GetWeakPtr(),
pending_op));
rv = entry_result.net_error();
if (rv == ERR_IO_PENDING) {
pending_op->callback_will_delete = true;
return ERR_IO_PENDING;
}
pending_op->writer->ClearTransaction();
OnPendingCreationOpComplete(GetWeakPtr(), pending_op,
std::move(entry_result));
return rv;
}
int HttpCache::CreateEntry(const std::string& key,
ActiveEntry** entry,
Transaction* transaction) {
if (FindActiveEntry(key)) {
return ERR_CACHE_RACE;
}
PendingOp* pending_op = GetPendingOp(key);
int rv =
CreateAndSetWorkItem(entry, transaction, WI_CREATE_ENTRY, pending_op);
if (rv != OK)
return rv;
disk_cache::EntryResult entry_result = disk_cache_->CreateEntry(
key, transaction->priority(),
base::BindOnce(&HttpCache::OnPendingCreationOpComplete, GetWeakPtr(),
pending_op));
rv = entry_result.net_error();
if (rv == ERR_IO_PENDING) {
pending_op->callback_will_delete = true;
return ERR_IO_PENDING;
}
pending_op->writer->ClearTransaction();
OnPendingCreationOpComplete(GetWeakPtr(), pending_op,
std::move(entry_result));
return rv;
}
void HttpCache::DestroyEntry(ActiveEntry* entry) {
if (entry->doomed) {
FinalizeDoomedEntry(entry);
} else {
DeactivateEntry(entry);
}
}
int HttpCache::AddTransactionToEntry(ActiveEntry* entry,
Transaction* transaction) {
DCHECK(entry);
DCHECK(entry->GetEntry());
entry->add_to_entry_queue.push_back(transaction);
ProcessQueuedTransactions(entry);
return ERR_IO_PENDING;
}
int HttpCache::DoneWithResponseHeaders(ActiveEntry* entry,
Transaction* transaction,
bool is_partial) {
if (entry->writers && entry->writers->HasTransaction(transaction)) {
DCHECK(is_partial && entry->writers->GetTransactionsCount() == 1);
return OK;
}
DCHECK_EQ(entry->headers_transaction, transaction);
entry->headers_transaction = nullptr;
if ((transaction->mode() & Transaction::WRITE) && !entry->writers &&
entry->readers.empty()) {
AddTransactionToWriters(entry, transaction,
CanTransactionJoinExistingWriters(transaction));
ProcessQueuedTransactions(entry);
return OK;
}
entry->done_headers_queue.push_back(transaction);
ProcessQueuedTransactions(entry);
return ERR_IO_PENDING;
}
void HttpCache::DoneWithEntry(ActiveEntry* entry,
Transaction* transaction,
bool entry_is_complete,
bool is_partial) {
bool is_mode_read_only = transaction->mode() == Transaction::READ;
if (!entry_is_complete && !is_mode_read_only && is_partial)
entry->GetEntry()->CancelSparseIO();
auto it = base::ranges::find(entry->done_headers_queue, transaction);
if (it != entry->done_headers_queue.end()) {
entry->done_headers_queue.erase(it);
if (!entry_is_complete && !is_mode_read_only)
ProcessEntryFailure(entry);
return;
}
if (transaction == entry->headers_transaction) {
entry->headers_transaction = nullptr;
if (entry_is_complete || is_mode_read_only) {
ProcessQueuedTransactions(entry);
} else {
ProcessEntryFailure(entry);
}
return;
}
if (entry->writers && entry->writers->HasTransaction(transaction)) {
entry->writers->RemoveTransaction(transaction,
entry_is_complete );
return;
}
DCHECK(!entry->writers);
auto readers_it = entry->readers.find(transaction);
DCHECK(readers_it != entry->readers.end());
entry->readers.erase(readers_it);
ProcessQueuedTransactions(entry);
}
void HttpCache::WritersDoomEntryRestartTransactions(ActiveEntry* entry) {
DCHECK(!entry->writers->IsEmpty());
ProcessEntryFailure(entry);
}
void HttpCache::WritersDoneWritingToEntry(ActiveEntry* entry,
bool success,
bool should_keep_entry,
TransactionSet make_readers) {
DCHECK(entry->writers);
DCHECK(entry->writers->IsEmpty());
DCHECK(success || make_readers.empty());
if (!success && should_keep_entry) {
RestartHeadersPhaseTransactions(entry);
entry->writers.reset();
if (entry->SafeToDestroy()) {
DestroyEntry(entry);
}
return;
}
if (success) {
for (auto* reader : make_readers) {
reader->WriteModeTransactionAboutToBecomeReader();
entry->readers.insert(reader);
}
entry->writers.reset();
ProcessQueuedTransactions(entry);
} else {
entry->writers.reset();
ProcessEntryFailure(entry);
}
}
void HttpCache::DoomEntryValidationNoMatch(ActiveEntry* entry) {
DCHECK(entry->headers_transaction);
entry->headers_transaction = nullptr;
if (entry->SafeToDestroy()) {
entry->GetEntry()->Doom();
DestroyEntry(entry);
return;
}
DoomActiveEntry(entry->GetEntry()->GetKey());
for (auto* transaction : entry->add_to_entry_queue) {
transaction->ResetCachePendingState();
base::SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE,
base::BindOnce(transaction->io_callback(), net::ERR_CACHE_RACE));
}
entry->add_to_entry_queue.clear();
}
void HttpCache::RemoveAllQueuedTransactions(ActiveEntry* entry,
TransactionList* list) {
for (auto* transaction : entry->done_headers_queue)
list->push_back(transaction);
entry->done_headers_queue.clear();
for (auto* pending_transaction : entry->add_to_entry_queue)
list->push_back(pending_transaction);
entry->add_to_entry_queue.clear();
}
void HttpCache::ProcessEntryFailure(ActiveEntry* entry) {
if (entry->headers_transaction)
RestartHeadersTransaction(entry);
TransactionList list;
RemoveAllQueuedTransactions(entry, &list);
if (entry->SafeToDestroy()) {
entry->GetEntry()->Doom();
DestroyEntry(entry);
} else {
DoomActiveEntry(entry->GetEntry()->GetKey());
}
for (auto* queued_transaction : list)
queued_transaction->io_callback().Run(net::ERR_CACHE_RACE);
}
void HttpCache::RestartHeadersPhaseTransactions(ActiveEntry* entry) {
if (entry->headers_transaction)
RestartHeadersTransaction(entry);
auto it = entry->done_headers_queue.begin();
while (it != entry->done_headers_queue.end()) {
Transaction* done_headers_transaction = *it;
it = entry->done_headers_queue.erase(it);
done_headers_transaction->io_callback().Run(net::ERR_CACHE_RACE);
}
}
void HttpCache::RestartHeadersTransaction(ActiveEntry* entry) {
entry->headers_transaction->SetValidatingCannotProceed();
entry->headers_transaction = nullptr;
}
void HttpCache::ProcessQueuedTransactions(ActiveEntry* entry) {
if (entry->will_process_queued_transactions)
return;
entry->will_process_queued_transactions = true;
base::SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE,
base::BindOnce(&HttpCache::OnProcessQueuedTransactions, GetWeakPtr(),
base::UnsafeDanglingUntriaged(entry)));
}
void HttpCache::ProcessAddToEntryQueue(ActiveEntry* entry) {
DCHECK(!entry->add_to_entry_queue.empty());
if (entry->headers_transaction) {
return;
}
Transaction* transaction = entry->add_to_entry_queue.front();
entry->add_to_entry_queue.erase(entry->add_to_entry_queue.begin());
entry->headers_transaction = transaction;
transaction->io_callback().Run(OK);
}
HttpCache::ParallelWritingPattern HttpCache::CanTransactionJoinExistingWriters(
Transaction* transaction) {
if (transaction->method() != "GET")
return PARALLEL_WRITING_NOT_JOIN_METHOD_NOT_GET;
if (transaction->partial())
return PARALLEL_WRITING_NOT_JOIN_RANGE;
if (transaction->mode() == Transaction::READ)
return PARALLEL_WRITING_NOT_JOIN_READ_ONLY;
if (transaction->GetResponseInfo()->headers &&
transaction->GetResponseInfo()->headers->GetContentLength() >
disk_cache_->MaxFileSize())
return PARALLEL_WRITING_NOT_JOIN_TOO_BIG_FOR_CACHE;
return PARALLEL_WRITING_JOIN;
}
void HttpCache::ProcessDoneHeadersQueue(ActiveEntry* entry) {
ParallelWritingPattern writers_pattern;
DCHECK(!entry->writers || entry->writers->CanAddWriters(&writers_pattern));
DCHECK(!entry->done_headers_queue.empty());
Transaction* transaction = entry->done_headers_queue.front();
ParallelWritingPattern parallel_writing_pattern =
CanTransactionJoinExistingWriters(transaction);
if (IsWritingInProgress(entry)) {
if (parallel_writing_pattern != PARALLEL_WRITING_JOIN) {
return;
}
AddTransactionToWriters(entry, transaction, parallel_writing_pattern);
} else {
if (transaction->mode() & Transaction::WRITE) {
if (transaction->partial()) {
if (entry->readers.empty())
AddTransactionToWriters(entry, transaction, parallel_writing_pattern);
else
return;
} else {
transaction->WriteModeTransactionAboutToBecomeReader();
auto return_val = entry->readers.insert(transaction);
DCHECK(return_val.second);
}
} else {
auto return_val = entry->readers.insert(transaction);
DCHECK(return_val.second);
}
}
ProcessQueuedTransactions(entry);
entry->done_headers_queue.erase(entry->done_headers_queue.begin());
transaction->io_callback().Run(OK);
}
void HttpCache::AddTransactionToWriters(
ActiveEntry* entry,
Transaction* transaction,
ParallelWritingPattern parallel_writing_pattern) {
if (!entry->writers) {
entry->writers = std::make_unique<Writers>(this, entry);
} else {
ParallelWritingPattern writers_pattern;
DCHECK(entry->writers->CanAddWriters(&writers_pattern));
DCHECK_EQ(PARALLEL_WRITING_JOIN, writers_pattern);
}
Writers::TransactionInfo info(transaction->partial(),
transaction->is_truncated(),
*(transaction->GetResponseInfo()));
entry->writers->AddTransaction(transaction, parallel_writing_pattern,
transaction->priority(), info);
}
bool HttpCache::CanTransactionWriteResponseHeaders(ActiveEntry* entry,
Transaction* transaction,
bool is_partial,
bool is_match) const {
if (entry->writers && entry->writers->HasTransaction(transaction)) {
DCHECK(is_partial);
return true;
}
if (transaction != entry->headers_transaction)
return false;
if (!(transaction->mode() & Transaction::WRITE))
return false;
if (!is_match) {
return (!entry->writers || entry->writers->IsEmpty()) &&
entry->done_headers_queue.empty() && entry->readers.empty();
}
return true;
}
bool HttpCache::IsWritingInProgress(ActiveEntry* entry) const {
return entry->writers.get();
}
LoadState HttpCache::GetLoadStateForPendingTransaction(
const Transaction* transaction) {
auto i = active_entries_.find(transaction->key());
if (i == active_entries_.end()) {
return LOAD_STATE_WAITING_FOR_CACHE;
}
Writers* writers = i->second->writers.get();
return !writers ? LOAD_STATE_WAITING_FOR_CACHE : writers->GetLoadState();
}
void HttpCache::RemovePendingTransaction(Transaction* transaction) {
auto i = active_entries_.find(transaction->key());
bool found = false;
if (i != active_entries_.end())
found = RemovePendingTransactionFromEntry(i->second.get(), transaction);
if (found)
return;
if (building_backend_) {
auto j = pending_ops_.find(std::string());
if (j != pending_ops_.end())
found = RemovePendingTransactionFromPendingOp(j->second, transaction);
if (found)
return;
}
auto j = pending_ops_.find(transaction->key());
if (j != pending_ops_.end())
found = RemovePendingTransactionFromPendingOp(j->second, transaction);
if (found)
return;
for (auto k = doomed_entries_.begin(); k != doomed_entries_.end() && !found;
++k) {
found = RemovePendingTransactionFromEntry(k->first, transaction);
}
DCHECK(found) << "Pending transaction not found";
}
bool HttpCache::RemovePendingTransactionFromEntry(ActiveEntry* entry,
Transaction* transaction) {
TransactionList& add_to_entry_queue = entry->add_to_entry_queue;
auto j =
find(add_to_entry_queue.begin(), add_to_entry_queue.end(), transaction);
if (j == add_to_entry_queue.end())
return false;
add_to_entry_queue.erase(j);
return true;
}
bool HttpCache::RemovePendingTransactionFromPendingOp(
PendingOp* pending_op,
Transaction* transaction) {
if (pending_op->writer->Matches(transaction)) {
pending_op->writer->ClearTransaction();
pending_op->writer->ClearEntry();
return true;
}
WorkItemList& pending_queue = pending_op->pending_queue;
for (auto it = pending_queue.begin(); it != pending_queue.end(); ++it) {
if ((*it)->Matches(transaction)) {
pending_queue.erase(it);
return true;
}
}
return false;
}
void HttpCache::OnProcessQueuedTransactions(ActiveEntry* entry) {
entry->will_process_queued_transactions = false;
if (entry->SafeToDestroy()) {
DestroyEntry(entry);
return;
}
if (entry->done_headers_queue.empty() && entry->add_to_entry_queue.empty())
return;
if (!entry->done_headers_queue.empty()) {
ParallelWritingPattern unused_reason;
if (!entry->writers || entry->writers->CanAddWriters(&unused_reason)) {
ProcessDoneHeadersQueue(entry);
return;
}
}
if (!entry->add_to_entry_queue.empty())
ProcessAddToEntryQueue(entry);
}
void HttpCache::OnIOComplete(int result, PendingOp* pending_op) {
WorkItemOperation op = pending_op->writer->operation();
if (op == WI_CREATE_BACKEND)
return OnBackendCreated(result, pending_op);
std::unique_ptr<WorkItem> item = std::move(pending_op->writer);
bool try_restart_requests = false;
ActiveEntry* entry = nullptr;
std::string key;
if (result == OK) {
if (op == WI_DOOM_ENTRY) {
try_restart_requests = true;
} else if (item->IsValid()) {
DCHECK(pending_op->entry);
key = pending_op->entry->GetKey();
entry = ActivateEntry(pending_op->entry, pending_op->entry_opened);
} else {
if (!pending_op->entry_opened)
pending_op->entry->Doom();
pending_op->entry->Close();
pending_op->entry = nullptr;
try_restart_requests = true;
}
}
WorkItemList pending_items = std::move(pending_op->pending_queue);
DeletePendingOp(pending_op);
item->NotifyTransaction(result, entry);
while (!pending_items.empty()) {
item = std::move(pending_items.front());
pending_items.pop_front();
if (item->operation() == WI_DOOM_ENTRY) {
try_restart_requests = true;
} else if (result == OK) {
entry = FindActiveEntry(key);
if (!entry)
try_restart_requests = true;
}
if (try_restart_requests) {
item->NotifyTransaction(ERR_CACHE_RACE, nullptr);
continue;
}
if (item->operation() == WI_CREATE_ENTRY) {
if (result == OK) {
item->NotifyTransaction(ERR_CACHE_CREATE_FAILURE, nullptr);
} else {
if (op != WI_CREATE_ENTRY && op != WI_OPEN_OR_CREATE_ENTRY) {
item->NotifyTransaction(ERR_CACHE_RACE, nullptr);
try_restart_requests = true;
} else {
item->NotifyTransaction(result, entry);
}
}
}
else if (item->operation() == WI_OPEN_OR_CREATE_ENTRY) {
if ((op == WI_OPEN_ENTRY || op == WI_CREATE_ENTRY) && result != OK) {
item->NotifyTransaction(ERR_CACHE_RACE, nullptr);
try_restart_requests = true;
} else {
item->NotifyTransaction(result, entry);
}
}
else {
if (op == WI_CREATE_ENTRY && result != OK) {
item->NotifyTransaction(ERR_CACHE_RACE, nullptr);
try_restart_requests = true;
} else {
item->NotifyTransaction(result, entry);
}
}
}
}
void HttpCache::OnPendingOpComplete(base::WeakPtr<HttpCache> cache,
PendingOp* pending_op,
int rv) {
if (cache.get()) {
pending_op->callback_will_delete = false;
cache->OnIOComplete(rv, pending_op);
} else {
delete pending_op;
}
}
void HttpCache::OnPendingCreationOpComplete(base::WeakPtr<HttpCache> cache,
PendingOp* pending_op,
disk_cache::EntryResult result) {
if (!cache.get()) {
delete pending_op;
return;
}
int rv = result.net_error();
pending_op->entry_opened = result.opened();
pending_op->entry = result.ReleaseEntry();
pending_op->callback_will_delete = false;
cache->OnIOComplete(rv, pending_op);
}
void HttpCache::OnPendingBackendCreationOpComplete(
base::WeakPtr<HttpCache> cache,
PendingOp* pending_op,
disk_cache::BackendResult result) {
if (!cache.get()) {
delete pending_op;
return;
}
int rv = result.net_error;
pending_op->backend = std::move(result.backend);
pending_op->callback_will_delete = false;
cache->OnIOComplete(rv, pending_op);
}
void HttpCache::OnBackendCreated(int result, PendingOp* pending_op) {
std::unique_ptr<WorkItem> item = std::move(pending_op->writer);
WorkItemOperation op = item->operation();
DCHECK_EQ(WI_CREATE_BACKEND, op);
if (backend_factory_.get()) {
backend_factory_.reset();
if (result == OK) {
disk_cache_ = std::move(pending_op->backend);
UMA_HISTOGRAM_MEMORY_KB("HttpCache.MaxFileSizeOnInit",
disk_cache_->MaxFileSize() / 1024);
}
}
if (!pending_op->pending_queue.empty()) {
std::unique_ptr<WorkItem> pending_item =
std::move(pending_op->pending_queue.front());
pending_op->pending_queue.pop_front();
DCHECK_EQ(WI_CREATE_BACKEND, pending_item->operation());
pending_op->writer = std::move(pending_item);
base::SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, base::BindOnce(&HttpCache::OnBackendCreated, GetWeakPtr(),
result, pending_op));
} else {
building_backend_ = false;
DeletePendingOp(pending_op);
}
if (!item->DoCallback(result))
item->NotifyTransaction(result, nullptr);
}
}