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
|
/*
* Copyright (C) 2024 Apple 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:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. 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.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS 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 APPLE INC. OR ITS 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.
*/
#include "config.h"
#include "ResourceMonitorChecker.h"
#include "Logging.h"
#include "ResourceMonitor.h"
#include <wtf/CryptographicallyRandomNumber.h>
#include <wtf/Seconds.h>
#include <wtf/StdLibExtras.h>
#if ENABLE(CONTENT_EXTENSIONS)
#define RESOURCEMONITOR_RELEASE_LOG(fmt, ...) RELEASE_LOG(ResourceMonitoring, "ResourceMonitorChecker::" fmt, ##__VA_ARGS__)
namespace WebCore {
ResourceMonitorChecker& ResourceMonitorChecker::singleton()
{
static MainThreadNeverDestroyed<ResourceMonitorChecker> globalChecker;
return globalChecker;
}
ResourceMonitorChecker::ResourceMonitorChecker()
: m_workQueue { WorkQueue::create("ResourceMonitorChecker Work Queue"_s) }
{
protectedWorkQueue()->dispatchAfter(ruleListPreparationTimeout, [this] mutable {
if (m_ruleList)
return;
RESOURCEMONITOR_RELEASE_LOG("Did not receive rule list in time, using default eligibility");
m_ruleListIsPreparing = false;
finishPendingQueries([](const auto&) {
return defaultEligibility;
});
});
}
ResourceMonitorChecker::~ResourceMonitorChecker()
{
finishPendingQueries([](const auto&) {
return defaultEligibility;
});
}
void ResourceMonitorChecker::checkEligibility(ContentExtensions::ResourceLoadInfo&& info, CompletionHandler<void(Eligibility)>&& completionHandler)
{
ASSERT(isMainThread());
protectedWorkQueue()->dispatch([this, info = crossThreadCopy(WTFMove(info)), completionHandler = WTFMove(completionHandler)] mutable {
if (!m_ruleList && m_ruleListIsPreparing) {
m_pendingQueries.append(std::make_pair(WTFMove(info), WTFMove(completionHandler)));
return;
}
Eligibility eligibility = m_ruleList ? checkEligibility(info) : defaultEligibility;
callOnMainRunLoop([eligibility, completionHandler = WTFMove(completionHandler)] mutable {
completionHandler(eligibility);
});
});
}
ResourceMonitorChecker::Eligibility ResourceMonitorChecker::checkEligibility(const ContentExtensions::ResourceLoadInfo& info)
{
ASSERT(m_ruleList);
auto matched = m_ruleList->processContentRuleListsForResourceMonitoring(info.resourceURL, info.mainDocumentURL, info.frameURL, info.type);
RESOURCEMONITOR_RELEASE_LOG("The url is %" PUBLIC_LOG_STRING ": %" SENSITIVE_LOG_STRING " (%" PUBLIC_LOG_STRING ")", (matched ? "eligible" : "not eligible"), info.resourceURL.string().utf8().data(), ContentExtensions::resourceTypeToString(info.type).characters());
return matched ? Eligibility::Eligible : Eligibility::NotEligible;
}
void ResourceMonitorChecker::setContentRuleList(ContentExtensions::ContentExtensionsBackend&& backend)
{
ASSERT(isMainThread());
protectedWorkQueue()->dispatch([this, backend = crossThreadCopy(WTFMove(backend))] mutable {
m_ruleList = makeUnique<ContentExtensions::ContentExtensionsBackend>(WTFMove(backend));
m_ruleListIsPreparing = false;
RESOURCEMONITOR_RELEASE_LOG("Content rule list is set");
if (!m_pendingQueries.isEmpty()) {
finishPendingQueries([this](const auto& info) {
return checkEligibility(info); }
);
}
});
}
void ResourceMonitorChecker::finishPendingQueries(Function<Eligibility(const ContentExtensions::ResourceLoadInfo&)> checker)
{
RESOURCEMONITOR_RELEASE_LOG("Finish pending queries: count %lu", m_pendingQueries.size());
for (auto& pair : m_pendingQueries) {
auto& [info, completionHandler] = pair;
Eligibility eligibility = checker(info);
callOnMainRunLoop([eligibility, completionHandler = WTFMove(completionHandler)] mutable {
completionHandler(eligibility);
});
}
m_pendingQueries.clear();
}
void ResourceMonitorChecker::registerResourceMonitor(ResourceMonitor& resourceMonitor)
{
m_resourceMonitors.add(resourceMonitor);
}
void ResourceMonitorChecker::unregisterResourceMonitor(ResourceMonitor& resourceMonitor)
{
m_resourceMonitors.remove(resourceMonitor);
}
size_t ResourceMonitorChecker::networkUsageThreshold() const
{
return m_networkUsageThreshold;
}
size_t ResourceMonitorChecker::networkUsageThresholdWithNoise() const
{
return static_cast<size_t>(m_networkUsageThreshold * (1 + m_networkUsageThresholdRandomness * cryptographicallyRandomUnitInterval()));
}
void ResourceMonitorChecker::setNetworkUsageThreshold(size_t threshold, double randomness)
{
if (m_networkUsageThreshold == threshold && m_networkUsageThresholdRandomness == randomness)
return;
RESOURCEMONITOR_RELEASE_LOG("Update network usage threshold: threshold=%zu, randomness=%.3f", threshold, randomness);
m_networkUsageThreshold = threshold;
m_networkUsageThresholdRandomness = randomness;
m_resourceMonitors.forEach([this](auto& resourceMonitor) {
resourceMonitor.updateNetworkUsageThreshold(networkUsageThresholdWithNoise());
});
}
} // namespace WebCore
#undef RESOURCEMONITOR_RELEASE_LOG
#endif
|
