SuspendedPageProxy.cpp [plain text]
#include "config.h"
#include "SuspendedPageProxy.h"
#include "DrawingAreaProxy.h"
#include "Logging.h"
#include "WebPageMessages.h"
#include "WebPageProxy.h"
#include "WebPageProxyMessages.h"
#include "WebProcessMessages.h"
#include "WebProcessPool.h"
#include "WebProcessProxy.h"
#include <wtf/DebugUtilities.h>
#include <wtf/URL.h>
namespace WebKit {
using namespace WebCore;
static const Seconds suspensionTimeout { 10_s };
#if !LOG_DISABLED
static const HashSet<IPC::StringReference>& messageNamesToIgnoreWhileSuspended()
{
static NeverDestroyed<HashSet<IPC::StringReference>> messageNames;
static std::once_flag onceFlag;
std::call_once(onceFlag, [] {
messageNames.get().add("BackForwardAddItem");
messageNames.get().add("ClearAllEditCommands");
messageNames.get().add("DidChangeContentSize");
messageNames.get().add("DidChangeMainDocument");
messageNames.get().add("DidChangeProgress");
messageNames.get().add("DidCommitLoadForFrame");
messageNames.get().add("DidDestroyNavigation");
messageNames.get().add("DidFinishDocumentLoadForFrame");
messageNames.get().add("DidFinishProgress");
messageNames.get().add("DidCompletePageTransition");
messageNames.get().add("DidFirstLayoutForFrame");
messageNames.get().add("DidFirstVisuallyNonEmptyLayoutForFrame");
messageNames.get().add("DidNavigateWithNavigationData");
messageNames.get().add("DidReachLayoutMilestone");
messageNames.get().add("DidRestoreScrollPosition");
messageNames.get().add("DidSaveToPageCache");
messageNames.get().add("DidStartProgress");
messageNames.get().add("DidStartProvisionalLoadForFrame");
messageNames.get().add("EditorStateChanged");
messageNames.get().add("PageExtendedBackgroundColorDidChange");
messageNames.get().add("SetRenderTreeSize");
messageNames.get().add("SetStatusText");
messageNames.get().add("SetNetworkRequestsInProgress");
});
return messageNames;
}
#endif
SuspendedPageProxy::SuspendedPageProxy(WebPageProxy& page, Ref<WebProcessProxy>&& process, WebBackForwardListItem& item, uint64_t mainFrameID)
: m_page(page)
, m_process(WTFMove(process))
, m_mainFrameID(mainFrameID)
, m_registrableDomain(toRegistrableDomain(URL(URL(), item.url())))
, m_suspensionTimeoutTimer(RunLoop::main(), this, &SuspendedPageProxy::suspensionTimedOut)
#if PLATFORM(IOS_FAMILY)
, m_suspensionToken(m_process->throttler().backgroundActivityToken())
#endif
{
item.setSuspendedPage(this);
m_process->addMessageReceiver(Messages::WebPageProxy::messageReceiverName(), m_page.pageID(), *this);
m_suspensionTimeoutTimer.startOneShot(suspensionTimeout);
m_process->send(Messages::WebPage::SetIsSuspended(true), m_page.pageID());
}
SuspendedPageProxy::~SuspendedPageProxy()
{
if (m_readyToUnsuspendHandler) {
RunLoop::main().dispatch([readyToUnsuspendHandler = WTFMove(m_readyToUnsuspendHandler)]() mutable {
readyToUnsuspendHandler(nullptr);
});
}
if (m_suspensionState == SuspensionState::Resumed)
return;
close();
if (m_suspensionState == SuspensionState::Suspending)
m_process->removeMessageReceiver(Messages::WebPageProxy::messageReceiverName(), m_page.pageID());
RunLoop::main().dispatch([process = m_process.copyRef()] {
process->maybeShutDown();
});
}
void SuspendedPageProxy::waitUntilReadyToUnsuspend(CompletionHandler<void(SuspendedPageProxy*)>&& completionHandler)
{
if (m_readyToUnsuspendHandler)
m_readyToUnsuspendHandler(nullptr);
switch (m_suspensionState) {
case SuspensionState::Suspending:
m_readyToUnsuspendHandler = WTFMove(completionHandler);
break;
case SuspensionState::FailedToSuspend:
case SuspensionState::Suspended:
completionHandler(this);
break;
case SuspensionState::Resumed:
ASSERT_NOT_REACHED();
completionHandler(nullptr);
break;
}
}
void SuspendedPageProxy::unsuspend()
{
ASSERT(m_suspensionState == SuspensionState::Suspended);
m_suspensionState = SuspensionState::Resumed;
m_process->send(Messages::WebPage::SetIsSuspended(false), m_page.pageID());
}
void SuspendedPageProxy::close()
{
ASSERT(m_suspensionState != SuspensionState::Resumed);
if (m_isClosed)
return;
m_isClosed = true;
m_process->send(Messages::WebPage::Close(), m_page.pageID());
}
void SuspendedPageProxy::didProcessRequestToSuspend(SuspensionState newSuspensionState)
{
LOG(ProcessSwapping, "SuspendedPageProxy %s from process %i finished transition to suspended", loggingString(), m_process->processIdentifier());
ASSERT(m_suspensionState == SuspensionState::Suspending);
ASSERT(newSuspensionState == SuspensionState::Suspended || newSuspensionState == SuspensionState::FailedToSuspend);
m_suspensionState = newSuspensionState;
m_suspensionTimeoutTimer.stop();
#if PLATFORM(IOS_FAMILY)
m_suspensionToken = nullptr;
#endif
m_process->removeMessageReceiver(Messages::WebPageProxy::messageReceiverName(), m_page.pageID());
bool shouldDelayClosingOnFailure = false;
#if PLATFORM(MAC)
shouldDelayClosingOnFailure = m_page.drawingArea() && m_page.drawingArea()->type() == DrawingAreaTypeTiledCoreAnimation;
#endif
if (m_suspensionState == SuspensionState::FailedToSuspend && !shouldDelayClosingOnFailure)
close();
if (m_readyToUnsuspendHandler)
m_readyToUnsuspendHandler(this);
}
void SuspendedPageProxy::suspensionTimedOut()
{
RELEASE_LOG_ERROR(ProcessSwapping, "%p - SuspendedPageProxy::suspensionTimedOut() destroying the suspended page because it failed to suspend in time", this);
m_process->processPool().removeSuspendedPage(*this); }
void SuspendedPageProxy::didReceiveMessage(IPC::Connection&, IPC::Decoder& decoder)
{
ASSERT(decoder.messageReceiverName() == Messages::WebPageProxy::messageReceiverName());
if (decoder.messageName() == Messages::WebPageProxy::DidSuspendAfterProcessSwap::name()) {
didProcessRequestToSuspend(SuspensionState::Suspended);
return;
}
if (decoder.messageName() == Messages::WebPageProxy::DidFailToSuspendAfterProcessSwap::name()) {
didProcessRequestToSuspend(SuspensionState::FailedToSuspend);
return;
}
#if !LOG_DISABLED
if (!messageNamesToIgnoreWhileSuspended().contains(decoder.messageName()))
LOG(ProcessSwapping, "SuspendedPageProxy received unexpected WebPageProxy message '%s'", decoder.messageName().toString().data());
#endif
}
void SuspendedPageProxy::didReceiveSyncMessage(IPC::Connection&, IPC::Decoder&, std::unique_ptr<IPC::Encoder>&)
{
}
#if !LOG_DISABLED
const char* SuspendedPageProxy::loggingString() const
{
return debugString("(", String::format("%p", this), " page ID ", String::number(m_page.pageID()), ", m_suspensionState ", String::number(static_cast<unsigned>(m_suspensionState)), ")");
}
#endif
}