blob: e24fded2225f1c1918f454017566717e20484eab [file] [log] [blame]
/*
* Copyright (C) 2007, 2018 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. ``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
* 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 "ProgressTracker.h"
#include "DocumentLoader.h"
#include "Frame.h"
#include "FrameLoader.h"
#include "FrameLoaderStateMachine.h"
#include "FrameLoaderClient.h"
#include "InspectorInstrumentation.h"
#include "Logging.h"
#include "ProgressTrackerClient.h"
#include "ResourceResponse.h"
#include <wtf/text/CString.h>
#define RELEASE_LOG_IF_ALLOWED(fmt, ...) RELEASE_LOG_IF(isAlwaysOnLoggingAllowed(), Network, "%p - ProgressTracker::" fmt, this, ##__VA_ARGS__)
namespace WebCore {
// Always start progress at initialProgressValue. This helps provide feedback as
// soon as a load starts.
static const double initialProgressValue = 0.1;
// Similarly, always leave space at the end. This helps show the user that we're not done
// until we're done.
static const double finalProgressValue = 0.9; // 1.0 - initialProgressValue
static const int progressItemDefaultEstimatedLength = 1024 * 16;
// Check if the load is progressing this often.
static const Seconds progressHeartbeatInterval { 100_ms };
// How many heartbeats must pass without progress before deciding the load is currently stalled.
static const unsigned loadStalledHeartbeatCount = 4;
// How many bytes are required between heartbeats to consider it progress.
static const unsigned minumumBytesPerHeartbeatForProgress = 1024;
static const Seconds progressNotificationTimeInterval { 200_ms };
struct ProgressItem {
WTF_MAKE_NONCOPYABLE(ProgressItem); WTF_MAKE_FAST_ALLOCATED;
public:
explicit ProgressItem(long long length)
: bytesReceived(0)
, estimatedLength(length)
{
}
long long bytesReceived;
long long estimatedLength;
};
unsigned long ProgressTracker::s_uniqueIdentifier = 0;
ProgressTracker::ProgressTracker(UniqueRef<ProgressTrackerClient>&& client)
: m_client(WTFMove(client))
, m_progressHeartbeatTimer(*this, &ProgressTracker::progressHeartbeatTimerFired)
{
}
ProgressTracker::~ProgressTracker() = default;
double ProgressTracker::estimatedProgress() const
{
return m_progressValue;
}
void ProgressTracker::reset()
{
m_progressItems.clear();
m_totalPageAndResourceBytesToLoad = 0;
m_totalBytesReceived = 0;
m_totalBytesReceivedBeforePreviousHeartbeat = 0;
m_lastNotifiedProgressValue = 0;
m_progressValue = 0;
m_lastNotifiedProgressTime = MonotonicTime();
m_finalProgressChangedSent = false;
m_numProgressTrackedFrames = 0;
m_originatingProgressFrame = nullptr;
m_heartbeatsWithNoProgress = 0;
m_progressHeartbeatTimer.stop();
}
void ProgressTracker::progressStarted(Frame& frame)
{
LOG(Progress, "Progress started (%p) - frame %p(\"%s\"), value %f, tracked frames %d, originating frame %p", this, &frame, frame.tree().uniqueName().string().utf8().data(), m_progressValue, m_numProgressTrackedFrames, m_originatingProgressFrame.get());
m_client->willChangeEstimatedProgress();
if (!m_numProgressTrackedFrames || m_originatingProgressFrame == &frame) {
reset();
m_progressValue = initialProgressValue;
m_originatingProgressFrame = &frame;
m_progressHeartbeatTimer.startRepeating(progressHeartbeatInterval);
m_originatingProgressFrame->loader().loadProgressingStatusChanged();
bool isMainFrame = !m_originatingProgressFrame->tree().parent();
auto elapsedTimeSinceMainLoadComplete = MonotonicTime::now() - m_mainLoadCompletionTime;
static const auto subframePartOfMainLoadThreshold = 1_s;
m_isMainLoad = isMainFrame || elapsedTimeSinceMainLoadComplete < subframePartOfMainLoadThreshold;
m_client->progressStarted(*m_originatingProgressFrame);
}
m_numProgressTrackedFrames++;
RELEASE_LOG_IF_ALLOWED("progressStarted: frame %p, value %f, tracked frames %d, originating frame %p, isMainLoad %d", &frame, m_progressValue, m_numProgressTrackedFrames, m_originatingProgressFrame.get(), m_isMainLoad);
m_client->didChangeEstimatedProgress();
InspectorInstrumentation::frameStartedLoading(frame);
}
void ProgressTracker::progressCompleted(Frame& frame)
{
LOG(Progress, "Progress completed (%p) - frame %p(\"%s\"), value %f, tracked frames %d, originating frame %p", this, &frame, frame.tree().uniqueName().string().utf8().data(), m_progressValue, m_numProgressTrackedFrames, m_originatingProgressFrame.get());
RELEASE_LOG_IF_ALLOWED("progressCompleted: frame %p, value %f, tracked frames %d, originating frame %p, isMainLoad %d", &frame, m_progressValue, m_numProgressTrackedFrames, m_originatingProgressFrame.get(), m_isMainLoad);
if (m_numProgressTrackedFrames <= 0)
return;
m_client->willChangeEstimatedProgress();
m_numProgressTrackedFrames--;
if (!m_numProgressTrackedFrames || m_originatingProgressFrame == &frame)
finalProgressComplete();
m_client->didChangeEstimatedProgress();
}
void ProgressTracker::finalProgressComplete()
{
LOG(Progress, "Final progress complete (%p)", this);
RELEASE_LOG_IF_ALLOWED("finalProgressComplete: value %f, tracked frames %d, originating frame %p, isMainLoad %d, isMainLoadProgressing %d", m_progressValue, m_numProgressTrackedFrames, m_originatingProgressFrame.get(), m_isMainLoad, isMainLoadProgressing());
auto frame = WTFMove(m_originatingProgressFrame);
// Before resetting progress value be sure to send client a least one notification
// with final progress value.
if (!m_finalProgressChangedSent) {
m_progressValue = 1;
m_client->progressEstimateChanged(*frame);
}
reset();
if (m_isMainLoad)
m_mainLoadCompletionTime = MonotonicTime::now();
frame->loader().client().setMainFrameDocumentReady(true);
m_client->progressFinished(*frame);
frame->loader().loadProgressingStatusChanged();
InspectorInstrumentation::frameStoppedLoading(*frame);
}
void ProgressTracker::incrementProgress(unsigned long identifier, const ResourceResponse& response)
{
LOG(Progress, "Progress incremented (%p) - value %f, tracked frames %d, originating frame %p", this, m_progressValue, m_numProgressTrackedFrames, m_originatingProgressFrame.get());
if (m_numProgressTrackedFrames <= 0)
return;
long long estimatedLength = response.expectedContentLength();
if (estimatedLength < 0)
estimatedLength = progressItemDefaultEstimatedLength;
m_totalPageAndResourceBytesToLoad += estimatedLength;
auto& item = m_progressItems.add(identifier, nullptr).iterator->value;
if (!item) {
item = makeUnique<ProgressItem>(estimatedLength);
return;
}
item->bytesReceived = 0;
item->estimatedLength = estimatedLength;
}
void ProgressTracker::incrementProgress(unsigned long identifier, unsigned bytesReceived)
{
ProgressItem* item = m_progressItems.get(identifier);
// FIXME: Can this ever happen?
if (!item)
return;
RefPtr<Frame> frame = m_originatingProgressFrame;
m_client->willChangeEstimatedProgress();
double increment, percentOfRemainingBytes;
long long remainingBytes, estimatedBytesForPendingRequests;
item->bytesReceived += bytesReceived;
if (item->bytesReceived > item->estimatedLength) {
m_totalPageAndResourceBytesToLoad += ((item->bytesReceived * 2) - item->estimatedLength);
item->estimatedLength = item->bytesReceived * 2;
}
int numPendingOrLoadingRequests = frame->loader().numPendingOrLoadingRequests(true);
estimatedBytesForPendingRequests = static_cast<long long>(progressItemDefaultEstimatedLength) * numPendingOrLoadingRequests;
remainingBytes = ((m_totalPageAndResourceBytesToLoad + estimatedBytesForPendingRequests) - m_totalBytesReceived);
if (remainingBytes > 0) // Prevent divide by 0.
percentOfRemainingBytes = (double)bytesReceived / (double)remainingBytes;
else
percentOfRemainingBytes = 1.0;
// For documents that use WebCore's layout system, treat first layout as the half-way point.
// FIXME: The hasHTMLView function is a sort of roundabout way of asking "do you use WebCore's layout system".
bool useClampedMaxProgress = frame->loader().client().hasHTMLView()
&& !frame->loader().stateMachine().firstLayoutDone();
double maxProgressValue = useClampedMaxProgress ? 0.5 : finalProgressValue;
increment = (maxProgressValue - m_progressValue) * percentOfRemainingBytes;
m_progressValue += increment;
m_progressValue = std::min(m_progressValue, maxProgressValue);
ASSERT(m_progressValue >= initialProgressValue);
m_totalBytesReceived += bytesReceived;
auto now = MonotonicTime::now();
auto notifiedProgressTimeDelta = now - m_lastNotifiedProgressTime;
LOG(Progress, "Progress incremented (%p) - value %f, tracked frames %d", this, m_progressValue, m_numProgressTrackedFrames);
if ((notifiedProgressTimeDelta >= progressNotificationTimeInterval || m_progressValue == 1) && m_numProgressTrackedFrames > 0) {
if (!m_finalProgressChangedSent) {
if (m_progressValue == 1)
m_finalProgressChangedSent = true;
m_client->progressEstimateChanged(*frame);
m_lastNotifiedProgressValue = m_progressValue;
m_lastNotifiedProgressTime = now;
}
}
m_client->didChangeEstimatedProgress();
}
void ProgressTracker::completeProgress(unsigned long identifier)
{
auto it = m_progressItems.find(identifier);
// This can happen if a load fails without receiving any response data.
if (it == m_progressItems.end())
return;
ProgressItem& item = *it->value;
// Adjust the total expected bytes to account for any overage/underage.
long long delta = item.bytesReceived - item.estimatedLength;
m_totalPageAndResourceBytesToLoad += delta;
m_progressItems.remove(it);
}
unsigned long ProgressTracker::createUniqueIdentifier()
{
return ++s_uniqueIdentifier;
}
bool ProgressTracker::isMainLoadProgressing() const
{
if (!m_originatingProgressFrame)
return false;
if (!m_isMainLoad)
return false;
return m_progressValue && m_progressValue < finalProgressValue && m_heartbeatsWithNoProgress < loadStalledHeartbeatCount;
}
void ProgressTracker::progressHeartbeatTimerFired()
{
if (m_totalBytesReceived < m_totalBytesReceivedBeforePreviousHeartbeat + minumumBytesPerHeartbeatForProgress)
++m_heartbeatsWithNoProgress;
else
m_heartbeatsWithNoProgress = 0;
m_totalBytesReceivedBeforePreviousHeartbeat = m_totalBytesReceived;
if (m_originatingProgressFrame)
m_originatingProgressFrame->loader().loadProgressingStatusChanged();
if (m_progressValue >= finalProgressValue)
m_progressHeartbeatTimer.stop();
}
bool ProgressTracker::isAlwaysOnLoggingAllowed() const
{
if (!m_originatingProgressFrame)
return false;
return m_originatingProgressFrame->isAlwaysOnLoggingAllowed();
}
}