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#pragma once
27
28#include "Connection.h"
29#include "ProcessThrottler.h"
30#include "WebBackForwardListItem.h"
31#include "WebPageProxyMessages.h"
32#include <wtf/RefCounted.h>
33#include <wtf/WeakPtr.h>
34
35namespace WebKit {
36
37class WebPageProxy;
38class WebProcessProxy;
39
40enum class ShouldDelayClosingUntilEnteringAcceleratedCompositingMode : bool { No, Yes };
41
42class SuspendedPageProxy final: public IPC::MessageReceiver, public CanMakeWeakPtr<SuspendedPageProxy> {
43 WTF_MAKE_FAST_ALLOCATED;
44public:
45 SuspendedPageProxy(WebPageProxy&, Ref<WebProcessProxy>&&, uint64_t mainFrameID, ShouldDelayClosingUntilEnteringAcceleratedCompositingMode);
46 ~SuspendedPageProxy();
47
48 WebPageProxy& page() const { return m_page; }
49 WebProcessProxy& process() { return m_process.get(); }
50 uint64_t mainFrameID() const { return m_mainFrameID; }
51
52 bool pageIsClosedOrClosing() const;
53
54 void waitUntilReadyToUnsuspend(CompletionHandler<void(SuspendedPageProxy*)>&&);
55 void unsuspend();
56
57 void pageEnteredAcceleratedCompositingMode();
58 void closeWithoutFlashing();
59
60#if !LOG_DISABLED
61 const char* loggingString() const;
62#endif
63
64private:
65 enum class SuspensionState : uint8_t { Suspending, FailedToSuspend, Suspended, Resumed };
66 void didProcessRequestToSuspend(SuspensionState);
67 void suspensionTimedOut();
68
69 void close();
70
71 // IPC::MessageReceiver
72 void didReceiveMessage(IPC::Connection&, IPC::Decoder&) final;
73 void didReceiveSyncMessage(IPC::Connection&, IPC::Decoder&, std::unique_ptr<IPC::Encoder>&) final;
74
75 WebPageProxy& m_page;
76 Ref<WebProcessProxy> m_process;
77 uint64_t m_mainFrameID;
78 bool m_isClosed { false };
79 ShouldDelayClosingUntilEnteringAcceleratedCompositingMode m_shouldDelayClosingUntilEnteringAcceleratedCompositingMode { ShouldDelayClosingUntilEnteringAcceleratedCompositingMode::No };
80 bool m_shouldCloseWhenEnteringAcceleratedCompositingMode { false };
81
82 SuspensionState m_suspensionState { SuspensionState::Suspending };
83 CompletionHandler<void(SuspendedPageProxy*)> m_readyToUnsuspendHandler;
84 RunLoop::Timer<SuspendedPageProxy> m_suspensionTimeoutTimer;
85#if PLATFORM(IOS_FAMILY)
86 ProcessThrottler::BackgroundActivityToken m_suspensionToken;
87#endif
88};
89
90} // namespace WebKit
91