96937925a971455290f492d192323307eb12a7c6
[WebKit-https.git] / Source / WebKit / UIProcess / SuspendedPageProxy.cpp
1 /*
2  * Copyright (C) 2018 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "SuspendedPageProxy.h"
28
29 #include "Logging.h"
30 #include "WebPageMessages.h"
31 #include "WebPageProxy.h"
32 #include "WebPageProxyMessages.h"
33 #include "WebProcessMessages.h"
34 #include "WebProcessPool.h"
35 #include "WebProcessProxy.h"
36 #include <WebCore/URL.h>
37 #include <wtf/DebugUtilities.h>
38
39 using namespace WebCore;
40
41 namespace WebKit {
42
43 #if !LOG_DISABLED
44 static const HashSet<IPC::StringReference>& messageNamesToIgnoreWhileSuspended()
45 {
46     static NeverDestroyed<HashSet<IPC::StringReference>> messageNames;
47     static std::once_flag onceFlag;
48     std::call_once(onceFlag, [] {
49         messageNames.get().add("BackForwardAddItem");
50         messageNames.get().add("ClearAllEditCommands");
51         messageNames.get().add("DidChangeContentSize");
52         messageNames.get().add("DidChangeMainDocument");
53         messageNames.get().add("DidChangeProgress");
54         messageNames.get().add("DidCommitLoadForFrame");
55         messageNames.get().add("DidDestroyNavigation");
56         messageNames.get().add("DidFinishDocumentLoadForFrame");
57         messageNames.get().add("DidFinishProgress");
58         messageNames.get().add("DidFirstLayoutForFrame");
59         messageNames.get().add("DidFirstVisuallyNonEmptyLayoutForFrame");
60         messageNames.get().add("DidNavigateWithNavigationData");
61         messageNames.get().add("DidReachLayoutMilestone");
62         messageNames.get().add("DidRestoreScrollPosition");
63         messageNames.get().add("DidSaveToPageCache");
64         messageNames.get().add("DidStartProgress");
65         messageNames.get().add("DidStartProvisionalLoadForFrame");
66         messageNames.get().add("EditorStateChanged");
67         messageNames.get().add("PageExtendedBackgroundColorDidChange");
68         messageNames.get().add("SetRenderTreeSize");
69         messageNames.get().add("SetStatusText");
70         messageNames.get().add("SetNetworkRequestsInProgress");
71     });
72
73     return messageNames;
74 }
75 #endif
76
77 SuspendedPageProxy::SuspendedPageProxy(WebPageProxy& page, WebProcessProxy& process, WebBackForwardListItem& item)
78     : m_page(page)
79     , m_process(&process)
80     , m_backForwardListItem(item)
81     , m_origin(SecurityOriginData::fromURL({ ParsedURLString, item.url() }))
82 {
83     m_backForwardListItem->setSuspendedPage(this);
84     m_process->processPool().registerSuspendedPageProxy(*this);
85     m_process->send(Messages::WebPage::SetIsSuspended(true), m_page.pageID());
86 }
87
88 SuspendedPageProxy::~SuspendedPageProxy()
89 {
90     if (auto process = makeRefPtr(m_process)) {
91         process->suspendedPageWasDestroyed(*this);
92         process->processPool().unregisterSuspendedPageProxy(*this);
93     }
94
95     m_backForwardListItem->setSuspendedPage(nullptr);
96 }
97
98 void SuspendedPageProxy::webProcessDidClose(WebProcessProxy& process)
99 {
100     ASSERT_UNUSED(process, &process == m_process);
101
102     auto protectedThis = makeRef(*this);
103     m_process->processPool().unregisterSuspendedPageProxy(*this);
104     m_process = nullptr;
105
106     m_page.suspendedPageClosed(*this);
107     m_backForwardListItem->setSuspendedPage(nullptr);
108 }
109
110 void SuspendedPageProxy::destroyWebPageInWebProcess()
111 {
112     m_process->send(Messages::WebPage::Close(), m_page.pageID());
113     m_page.suspendedPageClosed(*this);
114 }
115
116 void SuspendedPageProxy::didFinishLoad()
117 {
118     ASSERT(m_process);
119     LOG(ProcessSwapping, "SuspendedPageProxy %s from process %i finished transition to suspended", loggingString(), m_process->processIdentifier());
120
121     m_finishedSuspending = true;
122
123     m_process->send(Messages::WebProcess::UpdateActivePages(), 0);
124 }
125
126 void SuspendedPageProxy::didReceiveMessage(IPC::Connection&, IPC::Decoder& decoder)
127 {
128     ASSERT(decoder.messageReceiverName() == Messages::WebPageProxy::messageReceiverName());
129
130     if (decoder.messageName() == Messages::WebPageProxy::DidFinishLoadForFrame::name()) {
131         didFinishLoad();
132         return;
133     }
134 #if !LOG_DISABLED
135     if (!messageNamesToIgnoreWhileSuspended().contains(decoder.messageName()))
136         LOG(ProcessSwapping, "SuspendedPageProxy received unexpected WebPageProxy message '%s'", decoder.messageName().toString().data());
137 #endif
138 }
139
140 #if !LOG_DISABLED
141 const char* SuspendedPageProxy::loggingString() const
142 {
143     return debugString("(", String::format("%p", this), " page ID ", String::number(m_page.pageID()), ", m_finishedSuspending ", String::number(m_finishedSuspending), ")");
144 }
145 #endif
146
147 } // namespace WebKit