[WTF] Move currentCPUTime and sleep(Seconds) to CPUTime.h and Seconds.h respectively
[WebKit-https.git] / Source / WebCore / platform / network / DNSResolveQueue.cpp
1 /*
2  * Copyright (C) 2009 Apple Inc. All Rights Reserved.
3  * Copyright (C) 2012 Igalia S.L.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #include "config.h"
28 #include "DNSResolveQueue.h"
29
30 #include <wtf/NeverDestroyed.h>
31
32 namespace WebCore {
33
34 // When resolve queue is empty, we fire async resolution requests immediately (which is important if the prefetch is triggered by hovering).
35 // But during page parsing, we should coalesce identical requests to avoid stressing out the DNS resolver.
36 static const int gNamesToResolveImmediately = 4;
37
38 // Coalesce prefetch requests for this long before sending them out.
39 static const Seconds coalesceDelay { 1_s };
40
41 // Sending many DNS requests at once can overwhelm some gateways. See <rdar://8105550> for specific CFNET issues with CFHost throttling.
42 static const int gMaxSimultaneousRequests = 8;
43
44 // For a page has links to many outside sites, it is likely that the system DNS resolver won't be able to cache them all anyway, and we don't want
45 // to negatively affect other applications' performance by pushing their cached entries out.
46 // If we end up with lots of names to prefetch, some will be dropped.
47 static const int gMaxRequestsToQueue = 64;
48
49 // If there were queued names that couldn't be sent simultaneously, check the state of resolvers after this delay.
50 static const Seconds resolvingRetryDelay { 100_ms };
51
52 DNSResolveQueue& DNSResolveQueue::singleton()
53 {
54     static NeverDestroyed<DNSResolveQueue> queue;
55
56     return queue;
57 }
58
59 DNSResolveQueue::DNSResolveQueue()
60     : m_timer(*this, &DNSResolveQueue::timerFired)
61     , m_requestsInFlight(0)
62     , m_isUsingProxy(true)
63 {
64     // isUsingProxy will return the initial value of m_isUsingProxy at first on
65     // platforms that have an asynchronous implementation of updateIsUsingProxy,
66     // so initialize it to true so we won't prefetch before we know if we are using a proxy.
67 }
68
69 // Don't do DNS prefetch if proxies are involved. For many proxy types, the user agent is never
70 // exposed to the IP address during normal operation. Querying an internal DNS server may not help
71 // performance, as it doesn't necessarily look up the actual external IP. Also, if DNS returns a
72 // fake internal address, local caches may keep it even after re-connecting to another network.
73 bool DNSResolveQueue::isUsingProxy()
74 {
75     MonotonicTime time = MonotonicTime::now();
76     static const Seconds minimumProxyCheckDelay = 5_s;
77     if (time - m_lastProxyEnabledStatusCheckTime > minimumProxyCheckDelay) {
78         m_lastProxyEnabledStatusCheckTime = time;
79         updateIsUsingProxy();
80     }
81     return m_isUsingProxy;
82 }
83
84 void DNSResolveQueue::add(const String& hostname)
85 {
86     // If there are no names queued, and few enough are in flight, resolve immediately (the mouse may be over a link).
87     if (!m_names.size()) {
88         if (isUsingProxy())
89             return;
90         if (++m_requestsInFlight <= gNamesToResolveImmediately) {
91             platformResolve(hostname);
92             return;
93         }
94         --m_requestsInFlight;
95     }
96
97     // It's better to not prefetch some names than to clog the queue.
98     // Dropping the newest names, because on a single page, these are likely to be below oldest ones.
99     if (m_names.size() < gMaxRequestsToQueue) {
100         m_names.add(hostname);
101         if (!m_timer.isActive())
102             m_timer.startOneShot(coalesceDelay);
103     }
104 }
105
106 void DNSResolveQueue::timerFired()
107 {
108     if (isUsingProxy()) {
109         m_names.clear();
110         return;
111     }
112
113     int requestsAllowed = gMaxSimultaneousRequests - m_requestsInFlight;
114
115     for (; !m_names.isEmpty() && requestsAllowed > 0; --requestsAllowed) {
116         ++m_requestsInFlight;
117         HashSet<String>::iterator currentName = m_names.begin();
118         platformResolve(*currentName);
119         m_names.remove(currentName);
120     }
121
122     if (!m_names.isEmpty())
123         m_timer.startOneShot(resolvingRetryDelay);
124 }
125
126 } // namespace WebCore