File: client_usage_tracker.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (266 lines) | stat: -rw-r--r-- 9,709 bytes parent folder | download | duplicates (5)
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
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "storage/browser/quota/client_usage_tracker.h"

#include <stdint.h>
#include <iterator>

#include "base/barrier_closure.h"
#include "base/containers/contains.h"
#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "third_party/blink/public/common/storage_key/storage_key.h"

namespace storage {

struct ClientUsageTracker::AccumulateInfo {
  int64_t limited_usage = 0;
  int64_t unlimited_usage = 0;
};

ClientUsageTracker::ClientUsageTracker(
    UsageTracker* tracker,
    mojom::QuotaClient* client,
    scoped_refptr<SpecialStoragePolicy> special_storage_policy)
    : client_(client),
      special_storage_policy_(std::move(special_storage_policy)) {
  DCHECK(client_);
  if (special_storage_policy_.get())
    special_storage_policy_->AddObserver(this);
}

ClientUsageTracker::~ClientUsageTracker() {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  if (special_storage_policy_.get())
    special_storage_policy_->RemoveObserver(this);
}

void ClientUsageTracker::GetBucketsUsage(const std::set<BucketLocator>& buckets,
                                         UsageCallback callback) {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  DCHECK_GT(buckets.size(), 0u);

  auto info = std::make_unique<AccumulateInfo>();
  auto* info_ptr = info.get();
  base::RepeatingClosure barrier = base::BarrierClosure(
      buckets.size(),
      base::BindOnce(&ClientUsageTracker::FinallySendBucketsUsage,
                     weak_factory_.GetWeakPtr(), std::move(callback),
                     std::move(info)));

  for (const auto& bucket : buckets) {
    // Use a cached usage value, if we have one.
    int64_t cached_usage = GetCachedBucketUsage(bucket);
    if (cached_usage != -1) {
      AccumulateBucketsUsage(barrier, bucket, info_ptr, cached_usage);
      continue;
    }

    client_->GetBucketUsage(
        bucket,
        // base::Unretained usage is safe here because barrier holds the
        // std::unque_ptr that keeps AccumulateInfo alive, and the barrier
        // will outlive all the AccumulateClientGlobalUsage closures.
        base::BindOnce(&ClientUsageTracker::AccumulateBucketsUsage,
                       weak_factory_.GetWeakPtr(), barrier, bucket,
                       base::Unretained(info_ptr)));
  }
}

void ClientUsageTracker::UpdateBucketUsageCache(const BucketLocator& bucket,
                                                std::optional<int64_t> delta) {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  if (!IsUsageCacheEnabledForStorageKey(bucket.storage_key)) {
    return;
  }

  auto bucket_it = cached_bucket_usage_.find(bucket);
  if (bucket_it == cached_bucket_usage_.end()) {
    return;
  }

  if (delta.has_value()) {
    // Constrain `delta` to avoid negative usage values.
    // TODO(crbug.com/40408082): At least one storage API sends deltas that
    // result in negative total usage. The line below works around this bug.
    // Fix the bug, and remove the workaround.
    bucket_it->second += std::max(*delta, -bucket_it->second);
  } else {
    cached_bucket_usage_.erase(bucket_it);
  }
}

void ClientUsageTracker::DeleteBucketCache(const BucketLocator& bucket) {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  cached_bucket_usage_.erase(bucket);
}

int64_t ClientUsageTracker::GetCachedUsage() const {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  int64_t usage = 0;
  for (const auto& bucket_and_usage : cached_bucket_usage_)
    usage += bucket_and_usage.second;
  return usage;
}

const ClientUsageTracker::BucketUsageMap&
ClientUsageTracker::GetCachedBucketsUsage() const {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  return cached_bucket_usage_;
}

void ClientUsageTracker::SetUsageCacheEnabled(
    const blink::StorageKey& storage_key,
    bool enabled) {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  if (enabled) {
    non_cached_limited_storage_keys_.erase(storage_key);
    non_cached_unlimited_storage_keys_.erase(storage_key);
    return;
  }

  // Find all buckets for `storage_key` in `cached_bucket_usage_`
  // and remove them from the cache. Erases cached bucket usage while iterating.
  for (auto it = cached_bucket_usage_.cbegin();
       it != cached_bucket_usage_.cend();) {
    if (it->first.storage_key == storage_key) {
      // Calling erase() while iterating is safe because (1) std::map::erase()
      // only invalidates the iterator pointing to the erased element, and (2)
      // `it` is advanced off of the erased element before erase() is called.
      cached_bucket_usage_.erase(it++);
    } else {
      ++it;
    }
  }

  // Add to `non_cached_*_storage_keys_` to exclude `storage_key` from quota
  // restrictions.
  if (IsStorageUnlimited(storage_key)) {
    non_cached_unlimited_storage_keys_.insert(storage_key);
  } else {
    non_cached_limited_storage_keys_.insert(storage_key);
  }
}

bool ClientUsageTracker::IsUsageCacheEnabledForStorageKey(
    const blink::StorageKey& storage_key) const {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  return !base::Contains(non_cached_limited_storage_keys_, storage_key) &&
         !base::Contains(non_cached_unlimited_storage_keys_, storage_key);
}

void ClientUsageTracker::AccumulateBucketsUsage(
    base::OnceClosure barrier_callback,
    const BucketLocator& bucket,
    AccumulateInfo* info,
    int64_t usage) {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  // Defend against confusing inputs from clients.
  // TODO(crbug.com/40213066): Remove this check after fixing QuotaClients.
  if (usage < 0)
    usage = 0;

  if (IsStorageUnlimited(bucket.storage_key)) {
    info->unlimited_usage += usage;
  } else {
    info->limited_usage += usage;
  }

  if (IsUsageCacheEnabledForStorageKey(bucket.storage_key))
    CacheBucketUsage(bucket, usage);
  std::move(barrier_callback).Run();
}

void ClientUsageTracker::FinallySendBucketsUsage(
    UsageCallback callback,
    std::unique_ptr<AccumulateInfo> info) {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  DCHECK_GE(info->limited_usage, 0);
  DCHECK_GE(info->unlimited_usage, 0);

  std::move(callback).Run(info->limited_usage + info->unlimited_usage,
                          info->unlimited_usage);
}

void ClientUsageTracker::CacheBucketUsage(const BucketLocator& bucket,
                                          int64_t new_usage) {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  DCHECK(IsUsageCacheEnabledForStorageKey(bucket.storage_key));
  cached_bucket_usage_[bucket] = new_usage;
}

int64_t ClientUsageTracker::GetCachedBucketUsage(
    const BucketLocator& bucket) const {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  auto bucket_it = cached_bucket_usage_.find(bucket);
  if (bucket_it == cached_bucket_usage_.end())
    return -1;
  return bucket_it->second;
}

void ClientUsageTracker::GetBucketUsage(const BucketLocator& bucket,
                                        UsageCallback callback) {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  client_->GetBucketUsage(
      bucket,
      base::BindOnce(&ClientUsageTracker::DidGetBucketUsage,
                     weak_factory_.GetWeakPtr(), bucket, std::move(callback)));
  return;
}

void ClientUsageTracker::DidGetBucketUsage(const BucketLocator& bucket,
                                           UsageCallback callback,
                                           int64_t usage) {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  if (IsUsageCacheEnabledForStorageKey(bucket.storage_key))
    CacheBucketUsage(bucket, usage);

  int64_t unlimited_usage = IsStorageUnlimited(bucket.storage_key) ? usage : 0;
  std::move(callback).Run(usage, unlimited_usage);
}

void ClientUsageTracker::OnGranted(const url::Origin& origin_url,
                                   int change_flags) {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  // TODO(crbug.com/40184305): Remove this conversion once the storage policy
  // APIs are converted to use StorageKey instead of Origin.
  const blink::StorageKey storage_key =
      blink::StorageKey::CreateFirstParty(origin_url);
  if (change_flags & SpecialStoragePolicy::STORAGE_UNLIMITED) {
    if (non_cached_limited_storage_keys_.erase(storage_key))
      non_cached_unlimited_storage_keys_.insert(storage_key);
  }
}

void ClientUsageTracker::OnRevoked(const url::Origin& origin_url,
                                   int change_flags) {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  // TODO(crbug.com/40184305): Remove this conversion once the storage policy
  // APIs are converted to use StorageKey instead of Origin.
  const blink::StorageKey storage_key =
      blink::StorageKey::CreateFirstParty(origin_url);
  if (change_flags & SpecialStoragePolicy::STORAGE_UNLIMITED) {
    if (non_cached_unlimited_storage_keys_.erase(storage_key))
      non_cached_limited_storage_keys_.insert(storage_key);
  }
}

void ClientUsageTracker::OnCleared() {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  non_cached_limited_storage_keys_.insert(
      std::make_move_iterator(non_cached_unlimited_storage_keys_.begin()),
      std::make_move_iterator(non_cached_unlimited_storage_keys_.end()));
  non_cached_unlimited_storage_keys_.clear();
}

bool ClientUsageTracker::IsStorageUnlimited(
    const blink::StorageKey& storage_key) const {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
  return special_storage_policy_.get() &&
         special_storage_policy_->IsStorageUnlimited(
             storage_key.origin().GetURL());
}

}  // namespace storage