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
|
// Copyright 2017 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "extensions/browser/api/declarative_net_request/ruleset_matcher.h"
#include <iterator>
#include <optional>
#include <utility>
#include "base/check.h"
#include "base/containers/flat_set.h"
#include "base/containers/span.h"
#include "base/memory/ptr_util.h"
#include "base/metrics/histogram_macros.h"
#include "base/time/time.h"
#include "extensions/browser/api/declarative_net_request/constants.h"
#include "extensions/browser/api/declarative_net_request/flat/extension_ruleset_generated.h"
#include "extensions/browser/api/declarative_net_request/request_action.h"
#include "extensions/browser/api/declarative_net_request/rule_counts.h"
#include "extensions/browser/api/declarative_net_request/ruleset_matcher_base.h"
#include "extensions/browser/api/declarative_net_request/utils.h"
#include "extensions/common/api/declarative_net_request/constants.h"
namespace extensions::declarative_net_request {
namespace {
using ExtensionMetadataList =
flatbuffers::Vector<flatbuffers::Offset<flat::UrlRuleMetadata>>;
// These constants specify the number of, the minimum, and the maximum buckets
// for histograms which record the evaluation time for a request against a
// single DNR ruleset.
constexpr int kRequestActionTimeUmaBucketCount = 50;
constexpr base::TimeDelta kRequestActionUmaMinTime = base::Microseconds(1);
constexpr base::TimeDelta kRequestActionUmaMaxTime = base::Seconds(3);
size_t ComputeUnsafeRuleCount(const ExtensionMetadataList* metadata_list) {
size_t unsafe_rule_count = 0;
for (const auto* url_rule_metadata : *metadata_list) {
if (!IsRuleSafe(*url_rule_metadata)) {
unsafe_rule_count++;
}
}
return unsafe_rule_count;
}
bool IsRulesetStatic(const RulesetID& id) {
return id != kDynamicRulesetID && id != kSessionRulesetID;
}
void RecordOnBeforeRequestActionTime(const base::TimeTicks& start_time,
const base::TimeDelta& regex_time,
const base::TimeDelta& total_time,
int rules_count,
int regex_rules_count) {
int percent_taken_by_regex = 0;
// It's possible that the rule evaluation took no measurable time; be sure we
// don't divide by zero.
if (regex_time.is_positive()) {
percent_taken_by_regex =
static_cast<int>((regex_time / total_time) * 100.0);
}
if (regex_rules_count > 0) {
UMA_HISTOGRAM_PERCENTAGE(
"Extensions.DeclarativeNetRequest."
"RegexRulesBeforeRequestEvaluationPercentage",
percent_taken_by_regex);
if (regex_rules_count < 15) {
UMA_HISTOGRAM_CUSTOM_MICROSECONDS_TIMES(
"Extensions.DeclarativeNetRequest.RegexRulesBeforeRequestActionTime."
"LessThan15Rules",
regex_time, kRequestActionUmaMinTime, kRequestActionUmaMaxTime,
kRequestActionTimeUmaBucketCount);
} else if (regex_rules_count < 100) {
UMA_HISTOGRAM_CUSTOM_MICROSECONDS_TIMES(
"Extensions.DeclarativeNetRequest.RegexRulesBeforeRequestActionTime."
"15To100Rules",
regex_time, kRequestActionUmaMinTime, kRequestActionUmaMaxTime,
kRequestActionTimeUmaBucketCount);
} else if (regex_rules_count < 500) {
UMA_HISTOGRAM_CUSTOM_MICROSECONDS_TIMES(
"Extensions.DeclarativeNetRequest.RegexRulesBeforeRequestActionTime."
"100To500Rules",
regex_time, kRequestActionUmaMinTime, kRequestActionUmaMaxTime,
kRequestActionTimeUmaBucketCount);
} else {
UMA_HISTOGRAM_CUSTOM_MICROSECONDS_TIMES(
"Extensions.DeclarativeNetRequest.RegexRulesBeforeRequestActionTime."
"Over500Rules",
regex_time, kRequestActionUmaMinTime, kRequestActionUmaMaxTime,
kRequestActionTimeUmaBucketCount);
}
}
if (rules_count < 1000) {
UMA_HISTOGRAM_CUSTOM_MICROSECONDS_TIMES(
"Extensions.DeclarativeNetRequest."
"RulesetMatchingBeforeRequestActionTime."
"LessThan1000Rules",
total_time, kRequestActionUmaMinTime, kRequestActionUmaMaxTime,
kRequestActionTimeUmaBucketCount);
} else if (rules_count < 10000) {
UMA_HISTOGRAM_CUSTOM_MICROSECONDS_TIMES(
"Extensions.DeclarativeNetRequest."
"RulesetMatchingBeforeRequestActionTime."
"1000To10000Rules",
total_time, kRequestActionUmaMinTime, kRequestActionUmaMaxTime,
kRequestActionTimeUmaBucketCount);
} else if (rules_count < 30000) {
UMA_HISTOGRAM_CUSTOM_MICROSECONDS_TIMES(
"Extensions.DeclarativeNetRequest."
"RulesetMatchingBeforeRequestActionTime."
"10000To30000Rules",
total_time, kRequestActionUmaMinTime, kRequestActionUmaMaxTime,
kRequestActionTimeUmaBucketCount);
} else if (rules_count < 100000) {
UMA_HISTOGRAM_CUSTOM_MICROSECONDS_TIMES(
"Extensions.DeclarativeNetRequest."
"RulesetMatchingBeforeRequestActionTime."
"30000To100000Rules",
total_time, kRequestActionUmaMinTime, kRequestActionUmaMaxTime,
kRequestActionTimeUmaBucketCount);
} else if (rules_count < 300000) {
UMA_HISTOGRAM_CUSTOM_MICROSECONDS_TIMES(
"Extensions.DeclarativeNetRequest."
"RulesetMatchingBeforeRequestActionTime."
"100000To300000Rules",
total_time, kRequestActionUmaMinTime, kRequestActionUmaMaxTime,
kRequestActionTimeUmaBucketCount);
} else {
UMA_HISTOGRAM_CUSTOM_MICROSECONDS_TIMES(
"Extensions.DeclarativeNetRequest."
"RulesetMatchingBeforeRequestActionTime."
"Over300000Rules",
total_time, kRequestActionUmaMinTime, kRequestActionUmaMaxTime,
kRequestActionTimeUmaBucketCount);
}
}
void RecordOnHeadersReceivedActionTime(const base::TimeTicks& start_time,
const base::TimeDelta& regex_time,
const base::TimeDelta& total_time,
int rules_count,
int regex_rules_count) {
int percent_taken_by_regex = 0;
// It's possible that the rule evaluation took no measurable time; be sure we
// don't divide by zero.
if (regex_time.is_positive()) {
percent_taken_by_regex =
static_cast<int>((regex_time / total_time) * 100.0);
}
if (regex_rules_count > 0) {
UMA_HISTOGRAM_PERCENTAGE(
"Extensions.DeclarativeNetRequest."
"RegexRulesHeadersReceivedEvaluationPercentage",
percent_taken_by_regex);
if (regex_rules_count < 15) {
UMA_HISTOGRAM_CUSTOM_MICROSECONDS_TIMES(
"Extensions.DeclarativeNetRequest."
"RegexRulesHeadersReceivedActionTime."
"LessThan15Rules",
regex_time, kRequestActionUmaMinTime, kRequestActionUmaMaxTime,
kRequestActionTimeUmaBucketCount);
} else if (regex_rules_count < 100) {
UMA_HISTOGRAM_CUSTOM_MICROSECONDS_TIMES(
"Extensions.DeclarativeNetRequest."
"RegexRulesHeadersReceivedActionTime."
"15To100Rules",
regex_time, kRequestActionUmaMinTime, kRequestActionUmaMaxTime,
kRequestActionTimeUmaBucketCount);
} else if (regex_rules_count < 500) {
UMA_HISTOGRAM_CUSTOM_MICROSECONDS_TIMES(
"Extensions.DeclarativeNetRequest."
"RegexRulesHeadersReceivedActionTime."
"100To500Rules",
regex_time, kRequestActionUmaMinTime, kRequestActionUmaMaxTime,
kRequestActionTimeUmaBucketCount);
} else {
UMA_HISTOGRAM_CUSTOM_MICROSECONDS_TIMES(
"Extensions.DeclarativeNetRequest."
"RegexRulesHeadersReceivedActionTime."
"Over500Rules",
regex_time, kRequestActionUmaMinTime, kRequestActionUmaMaxTime,
kRequestActionTimeUmaBucketCount);
}
}
if (rules_count < 1000) {
UMA_HISTOGRAM_CUSTOM_MICROSECONDS_TIMES(
"Extensions.DeclarativeNetRequest."
"RulesetMatchingHeadersReceivedActionTime."
"LessThan1000Rules",
total_time, kRequestActionUmaMinTime, kRequestActionUmaMaxTime,
kRequestActionTimeUmaBucketCount);
} else if (rules_count < 10000) {
UMA_HISTOGRAM_CUSTOM_MICROSECONDS_TIMES(
"Extensions.DeclarativeNetRequest."
"RulesetMatchingHeadersReceivedActionTime."
"1000To10000Rules",
total_time, kRequestActionUmaMinTime, kRequestActionUmaMaxTime,
kRequestActionTimeUmaBucketCount);
} else if (rules_count < 30000) {
UMA_HISTOGRAM_CUSTOM_MICROSECONDS_TIMES(
"Extensions.DeclarativeNetRequest."
"RulesetMatchingHeadersReceivedActionTime."
"10000To30000Rules",
total_time, kRequestActionUmaMinTime, kRequestActionUmaMaxTime,
kRequestActionTimeUmaBucketCount);
} else if (rules_count < 100000) {
UMA_HISTOGRAM_CUSTOM_MICROSECONDS_TIMES(
"Extensions.DeclarativeNetRequest."
"RulesetMatchingHeadersReceivedActionTime."
"30000To100000Rules",
total_time, kRequestActionUmaMinTime, kRequestActionUmaMaxTime,
kRequestActionTimeUmaBucketCount);
} else if (rules_count < 300000) {
UMA_HISTOGRAM_CUSTOM_MICROSECONDS_TIMES(
"Extensions.DeclarativeNetRequest."
"RulesetMatchingHeadersReceivedActionTime."
"100000To300000Rules",
total_time, kRequestActionUmaMinTime, kRequestActionUmaMaxTime,
kRequestActionTimeUmaBucketCount);
} else {
UMA_HISTOGRAM_CUSTOM_MICROSECONDS_TIMES(
"Extensions.DeclarativeNetRequest."
"RulesetMatchingHeadersReceivedActionTime."
"Over300000Rules",
total_time, kRequestActionUmaMinTime, kRequestActionUmaMaxTime,
kRequestActionTimeUmaBucketCount);
}
}
} // namespace
RulesetMatcher::RulesetMatcher(std::string ruleset_data,
RulesetID id,
const ExtensionId& extension_id)
: ruleset_data_(std::move(ruleset_data)),
root_(flat::GetExtensionIndexedRuleset(ruleset_data_.data())),
id_(id),
url_matcher_(extension_id,
id,
root_->before_request_index_list(),
root_->headers_received_index_list(),
root_->extension_metadata()),
regex_matcher_(extension_id,
id,
root_->before_request_regex_rules(),
root_->headers_received_regex_rules(),
root_->extension_metadata()) {
if (!IsRulesetStatic(id)) {
unsafe_rule_count_ = ComputeUnsafeRuleCount(root_->extension_metadata());
}
}
RulesetMatcher::~RulesetMatcher() = default;
std::optional<RequestAction> RulesetMatcher::GetAction(
const RequestParams& params,
RulesetMatchingStage stage) const {
base::TimeTicks start_time = base::TimeTicks::Now();
std::optional<RequestAction> regex_result =
regex_matcher_.GetAction(params, stage);
base::TimeDelta regex_time = base::TimeTicks::Now() - start_time;
std::optional<RequestAction> url_pattern_result =
url_matcher_.GetAction(params, stage);
std::optional<RequestAction> final_result = GetMaxPriorityAction(
std::move(url_pattern_result), std::move(regex_result));
base::TimeDelta total_time = base::TimeTicks::Now() - start_time;
int regex_rules_count = GetRegexRulesCount(stage);
int rules_count = GetRulesCount(stage);
switch (stage) {
case RulesetMatchingStage::kOnBeforeRequest:
RecordOnBeforeRequestActionTime(start_time, regex_time, total_time,
rules_count, regex_rules_count);
break;
case RulesetMatchingStage::kOnHeadersReceived:
RecordOnHeadersReceivedActionTime(start_time, regex_time, total_time,
rules_count, regex_rules_count);
break;
}
return final_result;
}
std::vector<RequestAction> RulesetMatcher::GetModifyHeadersActions(
const RequestParams& params,
RulesetMatchingStage stage,
std::optional<uint64_t> min_priority) const {
std::vector<RequestAction> modify_header_actions =
url_matcher_.GetModifyHeadersActions(params, stage, min_priority);
std::vector<RequestAction> regex_modify_header_actions =
regex_matcher_.GetModifyHeadersActions(params, stage, min_priority);
modify_header_actions.insert(
modify_header_actions.end(),
std::make_move_iterator(regex_modify_header_actions.begin()),
std::make_move_iterator(regex_modify_header_actions.end()));
return modify_header_actions;
}
bool RulesetMatcher::IsExtraHeadersMatcher() const {
return url_matcher_.IsExtraHeadersMatcher() ||
regex_matcher_.IsExtraHeadersMatcher();
}
size_t RulesetMatcher::GetRulesCount() const {
return url_matcher_.GetRulesCount() + regex_matcher_.GetRulesCount();
}
std::optional<size_t> RulesetMatcher::GetUnsafeRulesCount() const {
return unsafe_rule_count_;
}
size_t RulesetMatcher::GetRegexRulesCount() const {
return regex_matcher_.GetRulesCount();
}
RuleCounts RulesetMatcher::GetRuleCounts() const {
return RuleCounts(GetRulesCount(), unsafe_rule_count_, GetRegexRulesCount());
}
void RulesetMatcher::OnRenderFrameCreated(content::RenderFrameHost* host) {
url_matcher_.OnRenderFrameCreated(host);
regex_matcher_.OnRenderFrameCreated(host);
}
void RulesetMatcher::OnRenderFrameDeleted(content::RenderFrameHost* host) {
url_matcher_.OnRenderFrameDeleted(host);
regex_matcher_.OnRenderFrameDeleted(host);
}
void RulesetMatcher::OnDidFinishNavigation(
content::NavigationHandle* navigation_handle) {
url_matcher_.OnDidFinishNavigation(navigation_handle);
regex_matcher_.OnDidFinishNavigation(navigation_handle);
}
std::optional<RequestAction>
RulesetMatcher::GetAllowlistedFrameActionForTesting(
content::RenderFrameHost* host) const {
return GetMaxPriorityAction(
url_matcher_.GetAllowlistedFrameActionForTesting(host), // IN-TEST
regex_matcher_.GetAllowlistedFrameActionForTesting(host)); // IN-TEST
}
void RulesetMatcher::SetDisabledRuleIds(base::flat_set<int> disabled_rule_ids) {
url_matcher_.SetDisabledRuleIds(std::move(disabled_rule_ids));
}
const base::flat_set<int>& RulesetMatcher::GetDisabledRuleIdsForTesting()
const {
return url_matcher_.GetDisabledRuleIdsForTesting(); // IN-TEST
}
size_t RulesetMatcher::GetRulesCount(RulesetMatchingStage stage) const {
switch (stage) {
case RulesetMatchingStage::kOnBeforeRequest:
return url_matcher_.GetBeforeRequestRulesCount() +
regex_matcher_.GetBeforeRequestRulesCount();
case RulesetMatchingStage::kOnHeadersReceived:
return url_matcher_.GetHeadersReceivedRulesCount() +
regex_matcher_.GetHeadersReceivedRulesCount();
}
NOTREACHED();
}
size_t RulesetMatcher::GetRegexRulesCount(RulesetMatchingStage stage) const {
switch (stage) {
case RulesetMatchingStage::kOnBeforeRequest:
return regex_matcher_.GetBeforeRequestRulesCount();
case RulesetMatchingStage::kOnHeadersReceived:
return regex_matcher_.GetHeadersReceivedRulesCount();
}
NOTREACHED();
}
} // namespace extensions::declarative_net_request
|
