3b39264ed077d82262612d1d9a6ac91fd10ef67c
[WebKit-https.git] / Source / WebKitLegacy / WebCoreSupport / WebResourceLoadScheduler.cpp
1 /*
2     Copyright (C) 1998 Lars Knoll (knoll@mpi-hd.mpg.de)
3     Copyright (C) 2001 Dirk Mueller (mueller@kde.org)
4     Copyright (C) 2002 Waldo Bastian (bastian@kde.org)
5     Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
6     Copyright (C) 2004-2008, 2015 Apple Inc. All rights reserved.
7     Copyright (C) 2010 Google Inc. All rights reserved.
8
9     This library is free software; you can redistribute it and/or
10     modify it under the terms of the GNU Library General Public
11     License as published by the Free Software Foundation; either
12     version 2 of the License, or (at your option) any later version.
13
14     This library is distributed in the hope that it will be useful,
15     but WITHOUT ANY WARRANTY; without even the implied warranty of
16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17     Library General Public License for more details.
18
19     You should have received a copy of the GNU Library General Public License
20     along with this library; see the file COPYING.LIB.  If not, write to
21     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
22     Boston, MA 02110-1301, USA.
23  */
24
25 #include "WebResourceLoadScheduler.h"
26
27 #include <WebCore/Document.h>
28 #include <WebCore/DocumentLoader.h>
29 #include <WebCore/FetchOptions.h>
30 #include <WebCore/Frame.h>
31 #include <WebCore/FrameLoader.h>
32 #include <WebCore/NetscapePlugInStreamLoader.h>
33 #include <WebCore/PingHandle.h>
34 #include <WebCore/PlatformStrategies.h>
35 #include <WebCore/ResourceHandle.h>
36 #include <WebCore/ResourceRequest.h>
37 #include <WebCore/SubresourceLoader.h>
38 #include <WebCore/URL.h>
39 #include <wtf/MainThread.h>
40 #include <wtf/SetForScope.h>
41 #include <wtf/text/CString.h>
42
43 #if PLATFORM(IOS)
44 #include <WebCore/RuntimeApplicationChecks.h>
45 #endif
46
47 // Match the parallel connection count used by the networking layer.
48 static unsigned maxRequestsInFlightPerHost;
49 #if !PLATFORM(IOS)
50 static const unsigned maxRequestsInFlightForNonHTTPProtocols = 20;
51 #else
52 // Limiting this seems to regress performance in some local cases so let's just make it large.
53 static const unsigned maxRequestsInFlightForNonHTTPProtocols = 10000;
54 #endif
55
56 using namespace WebCore;
57
58 WebResourceLoadScheduler& webResourceLoadScheduler()
59 {
60     return static_cast<WebResourceLoadScheduler&>(*platformStrategies()->loaderStrategy());
61 }
62
63 WebResourceLoadScheduler::HostInformation* WebResourceLoadScheduler::hostForURL(const URL& url, CreateHostPolicy createHostPolicy)
64 {
65     if (!url.protocolIsInHTTPFamily())
66         return m_nonHTTPProtocolHost;
67
68     m_hosts.checkConsistency();
69     String hostName = url.host();
70     HostInformation* host = m_hosts.get(hostName);
71     if (!host && createHostPolicy == CreateIfNotFound) {
72         host = new HostInformation(hostName, maxRequestsInFlightPerHost);
73         m_hosts.add(hostName, host);
74     }
75     return host;
76 }
77
78 WebResourceLoadScheduler::WebResourceLoadScheduler()
79     : m_nonHTTPProtocolHost(new HostInformation(String(), maxRequestsInFlightForNonHTTPProtocols))
80     , m_requestTimer(*this, &WebResourceLoadScheduler::requestTimerFired)
81     , m_suspendPendingRequestsCount(0)
82     , m_isSerialLoadingEnabled(false)
83 {
84     maxRequestsInFlightPerHost = initializeMaximumHTTPConnectionCountPerHost();
85 }
86
87 WebResourceLoadScheduler::~WebResourceLoadScheduler()
88 {
89 }
90
91 RefPtr<SubresourceLoader> WebResourceLoadScheduler::loadResource(Frame& frame, CachedResource& resource, const ResourceRequest& request, const ResourceLoaderOptions& options)
92 {
93     RefPtr<SubresourceLoader> loader = SubresourceLoader::create(frame, resource, request, options);
94     if (loader)
95         scheduleLoad(loader.get());
96 #if PLATFORM(IOS)
97     // Since we defer loader initialization until scheduling on iOS, the frame
98     // load delegate that would be called in SubresourceLoader::create() on
99     // other ports might be called in scheduleLoad() instead. Our contract to
100     // callers of this method is that a null loader is returned if the load was
101     // cancelled by a frame load delegate.
102     if (!loader || loader->reachedTerminalState())
103         return nullptr;
104 #endif
105     return loader;
106 }
107
108 void WebResourceLoadScheduler::loadResourceSynchronously(NetworkingContext* context, unsigned long, const ResourceRequest& request, StoredCredentialsPolicy storedCredentialsPolicy, ClientCredentialPolicy, ResourceError& error, ResourceResponse& response, Vector<char>& data)
109 {
110     ResourceHandle::loadResourceSynchronously(context, request, storedCredentialsPolicy, error, response, data);
111 }
112
113 RefPtr<NetscapePlugInStreamLoader> WebResourceLoadScheduler::schedulePluginStreamLoad(Frame& frame, NetscapePlugInStreamLoaderClient& client, const ResourceRequest& request)
114 {
115     RefPtr<NetscapePlugInStreamLoader> loader = NetscapePlugInStreamLoader::create(frame, client, request);
116     if (loader)
117         scheduleLoad(loader.get());
118     return loader;
119 }
120
121 void WebResourceLoadScheduler::scheduleLoad(ResourceLoader* resourceLoader)
122 {
123     ASSERT(resourceLoader);
124
125 #if PLATFORM(IOS)
126     // If there's a web archive resource for this URL, we don't need to schedule the load since it will never touch the network.
127     if (!isSuspendingPendingRequests() && resourceLoader->documentLoader()->archiveResourceForURL(resourceLoader->iOSOriginalRequest().url())) {
128         resourceLoader->startLoading();
129         return;
130     }
131 #else
132     if (resourceLoader->documentLoader()->archiveResourceForURL(resourceLoader->request().url())) {
133         resourceLoader->start();
134         return;
135     }
136 #endif
137
138 #if PLATFORM(IOS)
139     HostInformation* host = hostForURL(resourceLoader->iOSOriginalRequest().url(), CreateIfNotFound);
140 #else
141     HostInformation* host = hostForURL(resourceLoader->url(), CreateIfNotFound);
142 #endif
143
144     ResourceLoadPriority priority = resourceLoader->request().priority();
145
146     bool hadRequests = host->hasRequests();
147     host->schedule(resourceLoader, priority);
148
149 #if PLATFORM(COCOA) || USE(CFURLCONNECTION)
150     if (ResourceRequest::resourcePrioritiesEnabled() && !isSuspendingPendingRequests()) {
151         // Serve all requests at once to keep the pipeline full at the network layer.
152         // FIXME: Does this code do anything useful, given that we also set maxRequestsInFlightPerHost to effectively unlimited on these platforms?
153         servePendingRequests(host, ResourceLoadPriority::VeryLow);
154         return;
155     }
156 #endif
157
158 #if PLATFORM(IOS)
159     if ((priority > ResourceLoadPriority::Low || !resourceLoader->iOSOriginalRequest().url().protocolIsInHTTPFamily() || (priority == ResourceLoadPriority::Low && !hadRequests)) && !isSuspendingPendingRequests()) {
160         // Try to request important resources immediately.
161         servePendingRequests(host, priority);
162         return;
163     }
164 #else
165     if (priority > ResourceLoadPriority::Low || !resourceLoader->url().protocolIsInHTTPFamily() || (priority == ResourceLoadPriority::Low && !hadRequests)) {
166         // Try to request important resources immediately.
167         servePendingRequests(host, priority);
168         return;
169     }
170 #endif
171
172     // Handle asynchronously so early low priority requests don't
173     // get scheduled before later high priority ones.
174     scheduleServePendingRequests();
175 }
176
177 void WebResourceLoadScheduler::remove(ResourceLoader* resourceLoader)
178 {
179     ASSERT(resourceLoader);
180
181     HostInformation* host = hostForURL(resourceLoader->url());
182     if (host)
183         host->remove(resourceLoader);
184 #if PLATFORM(IOS)
185     // ResourceLoader::url() doesn't start returning the correct value until the load starts. If we get canceled before that, we need to look for originalRequest url instead.
186     // FIXME: ResourceLoader::url() should be made to return a sensible value at all times.
187     if (!resourceLoader->iOSOriginalRequest().isNull()) {
188         HostInformation* originalHost = hostForURL(resourceLoader->iOSOriginalRequest().url());
189         if (originalHost && originalHost != host)
190             originalHost->remove(resourceLoader);
191     }
192 #endif
193     scheduleServePendingRequests();
194 }
195
196 void WebResourceLoadScheduler::setDefersLoading(ResourceLoader*, bool)
197 {
198 }
199
200 void WebResourceLoadScheduler::crossOriginRedirectReceived(ResourceLoader* resourceLoader, const URL& redirectURL)
201 {
202     HostInformation* oldHost = hostForURL(resourceLoader->url());
203     ASSERT(oldHost);
204     if (!oldHost)
205         return;
206
207     HostInformation* newHost = hostForURL(redirectURL, CreateIfNotFound);
208
209     if (oldHost->name() == newHost->name())
210         return;
211
212     newHost->addLoadInProgress(resourceLoader);
213     oldHost->remove(resourceLoader);
214 }
215
216 void WebResourceLoadScheduler::servePendingRequests(ResourceLoadPriority minimumPriority)
217 {
218     if (isSuspendingPendingRequests())
219         return;
220
221     m_requestTimer.stop();
222     
223     servePendingRequests(m_nonHTTPProtocolHost, minimumPriority);
224
225     for (auto* host : copyToVector(m_hosts.values())) {
226         if (host->hasRequests())
227             servePendingRequests(host, minimumPriority);
228         else
229             delete m_hosts.take(host->name());
230     }
231 }
232
233 void WebResourceLoadScheduler::servePendingRequests(HostInformation* host, ResourceLoadPriority minimumPriority)
234 {
235     auto priority = ResourceLoadPriority::Highest;
236     while (true) {
237         auto& requestsPending = host->requestsPending(priority);
238         while (!requestsPending.isEmpty()) {
239             RefPtr<ResourceLoader> resourceLoader = requestsPending.first();
240
241             // For named hosts - which are only http(s) hosts - we should always enforce the connection limit.
242             // For non-named hosts - everything but http(s) - we should only enforce the limit if the document isn't done parsing 
243             // and we don't know all stylesheets yet.
244             Document* document = resourceLoader->frameLoader() ? resourceLoader->frameLoader()->frame().document() : 0;
245             bool shouldLimitRequests = !host->name().isNull() || (document && (document->parsing() || !document->haveStylesheetsLoaded()));
246             if (shouldLimitRequests && host->limitRequests(priority))
247                 return;
248
249             requestsPending.removeFirst();
250             host->addLoadInProgress(resourceLoader.get());
251 #if PLATFORM(IOS)
252             if (!IOSApplication::isWebProcess()) {
253                 resourceLoader->startLoading();
254                 return;
255             }
256 #endif
257             resourceLoader->start();
258         }
259         if (priority == minimumPriority)
260             return;
261         --priority;
262     }
263 }
264
265 void WebResourceLoadScheduler::suspendPendingRequests()
266 {
267     ++m_suspendPendingRequestsCount;
268 }
269
270 void WebResourceLoadScheduler::resumePendingRequests()
271 {
272     ASSERT(m_suspendPendingRequestsCount);
273     --m_suspendPendingRequestsCount;
274     if (m_suspendPendingRequestsCount)
275         return;
276     if (!m_hosts.isEmpty() || m_nonHTTPProtocolHost->hasRequests())
277         scheduleServePendingRequests();
278 }
279     
280 void WebResourceLoadScheduler::scheduleServePendingRequests()
281 {
282     if (!m_requestTimer.isActive())
283         m_requestTimer.startOneShot(0_s);
284 }
285
286 void WebResourceLoadScheduler::requestTimerFired()
287 {
288     servePendingRequests();
289 }
290
291 WebResourceLoadScheduler::HostInformation::HostInformation(const String& name, unsigned maxRequestsInFlight)
292     : m_name(name)
293     , m_maxRequestsInFlight(maxRequestsInFlight)
294 {
295 }
296
297 WebResourceLoadScheduler::HostInformation::~HostInformation()
298 {
299     ASSERT(!hasRequests());
300 }
301
302 unsigned WebResourceLoadScheduler::HostInformation::priorityToIndex(ResourceLoadPriority priority)
303 {
304     switch (priority) {
305     case ResourceLoadPriority::VeryLow:
306         return 0;
307     case ResourceLoadPriority::Low:
308         return 1;
309     case ResourceLoadPriority::Medium:
310         return 2;
311     case ResourceLoadPriority::High:
312         return 3;
313     case ResourceLoadPriority::VeryHigh:
314         return 4;
315     }
316     ASSERT_NOT_REACHED();
317     return 0;
318 }
319
320 void WebResourceLoadScheduler::HostInformation::schedule(ResourceLoader* resourceLoader, ResourceLoadPriority priority)
321 {
322     m_requestsPending[priorityToIndex(priority)].append(resourceLoader);
323 }
324     
325 void WebResourceLoadScheduler::HostInformation::addLoadInProgress(ResourceLoader* resourceLoader)
326 {
327     m_requestsLoading.add(resourceLoader);
328 }
329     
330 void WebResourceLoadScheduler::HostInformation::remove(ResourceLoader* resourceLoader)
331 {
332     if (m_requestsLoading.remove(resourceLoader))
333         return;
334     
335     for (auto& requestQueue : m_requestsPending) {
336         for (auto it = requestQueue.begin(), end = requestQueue.end(); it != end; ++it) {
337             if (*it == resourceLoader) {
338                 requestQueue.remove(it);
339                 return;
340             }
341         }
342     }
343 }
344
345 bool WebResourceLoadScheduler::HostInformation::hasRequests() const
346 {
347     if (!m_requestsLoading.isEmpty())
348         return true;
349     for (auto& requestQueue : m_requestsPending) {
350         if (!requestQueue.isEmpty())
351             return true;
352     }
353     return false;
354 }
355
356 bool WebResourceLoadScheduler::HostInformation::limitRequests(ResourceLoadPriority priority) const 
357 {
358     if (priority == ResourceLoadPriority::VeryLow && !m_requestsLoading.isEmpty())
359         return true;
360     return m_requestsLoading.size() >= (webResourceLoadScheduler().isSerialLoadingEnabled() ? 1 : m_maxRequestsInFlight);
361 }
362
363 void WebResourceLoadScheduler::startPingLoad(Frame& frame, ResourceRequest& request, const HTTPHeaderMap&, const FetchOptions& options, PingLoadCompletionHandler&& completionHandler)
364 {
365     // PingHandle manages its own lifetime, deleting itself when its purpose has been fulfilled.
366     new PingHandle(frame.loader().networkingContext(), request, options.credentials != FetchOptions::Credentials::Omit, options.redirect == FetchOptions::Redirect::Follow, WTFMove(completionHandler));
367 }
368
369 void WebResourceLoadScheduler::preconnectTo(NetworkingContext&, const URL&, StoredCredentialsPolicy, PreconnectCompletionHandler&&)
370 {
371 }
372