Regression (r244291): Broken API Test AutoLayoutRenderingProgressRelativeOrdering
[WebKit-https.git] / Source / WebKit / UIProcess / mac / TiledCoreAnimationDrawingAreaProxy.mm
1 /*
2  * Copyright (C) 2011-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 #import "config.h"
27 #import "TiledCoreAnimationDrawingAreaProxy.h"
28
29 #if !PLATFORM(IOS_FAMILY)
30
31 #import "ColorSpaceData.h"
32 #import "DrawingAreaMessages.h"
33 #import "DrawingAreaProxyMessages.h"
34 #import "LayerTreeContext.h"
35 #import "WebPageProxy.h"
36 #import "WebProcessProxy.h"
37 #import <pal/spi/cocoa/QuartzCoreSPI.h>
38 #import <wtf/BlockPtr.h>
39 #import <wtf/MachSendRight.h>
40
41 namespace WebKit {
42 using namespace IPC;
43 using namespace WebCore;
44
45 TiledCoreAnimationDrawingAreaProxy::TiledCoreAnimationDrawingAreaProxy(WebPageProxy& webPageProxy, WebProcessProxy& process)
46     : DrawingAreaProxy(DrawingAreaTypeTiledCoreAnimation, webPageProxy, process)
47     , m_isWaitingForDidUpdateGeometry(false)
48 {
49 }
50
51 TiledCoreAnimationDrawingAreaProxy::~TiledCoreAnimationDrawingAreaProxy()
52 {
53     m_callbacks.invalidate(CallbackBase::Error::OwnerWasInvalidated);
54 }
55
56 void TiledCoreAnimationDrawingAreaProxy::deviceScaleFactorDidChange()
57 {
58     send(Messages::DrawingArea::SetDeviceScaleFactor(m_webPageProxy.deviceScaleFactor()));
59 }
60
61 void TiledCoreAnimationDrawingAreaProxy::sizeDidChange()
62 {
63     if (!m_webPageProxy.hasRunningProcess())
64         return;
65
66     // We only want one UpdateGeometry message in flight at once, so if we've already sent one but
67     // haven't yet received the reply we'll just return early here.
68     if (m_isWaitingForDidUpdateGeometry)
69         return;
70
71     sendUpdateGeometry();
72 }
73
74 void TiledCoreAnimationDrawingAreaProxy::colorSpaceDidChange()
75 {
76     send(Messages::DrawingArea::SetColorSpace(m_webPageProxy.colorSpace()));
77 }
78
79 void TiledCoreAnimationDrawingAreaProxy::viewLayoutSizeDidChange()
80 {
81     if (!m_webPageProxy.hasRunningProcess())
82         return;
83
84     // We only want one UpdateGeometry message in flight at once, so if we've already sent one but
85     // haven't yet received the reply we'll just return early here.
86     if (m_isWaitingForDidUpdateGeometry)
87         return;
88
89     sendUpdateGeometry();
90 }
91
92 void TiledCoreAnimationDrawingAreaProxy::enterAcceleratedCompositingMode(uint64_t backingStoreStateID, const LayerTreeContext& layerTreeContext)
93 {
94     m_webPageProxy.enterAcceleratedCompositingMode(layerTreeContext);
95 }
96
97 void TiledCoreAnimationDrawingAreaProxy::exitAcceleratedCompositingMode(uint64_t backingStoreStateID, const UpdateInfo&)
98 {
99     // This should never be called.
100     ASSERT_NOT_REACHED();
101 }
102
103 void TiledCoreAnimationDrawingAreaProxy::updateAcceleratedCompositingMode(uint64_t backingStoreStateID, const LayerTreeContext& layerTreeContext)
104 {
105     m_webPageProxy.updateAcceleratedCompositingMode(layerTreeContext);
106 }
107
108 void TiledCoreAnimationDrawingAreaProxy::didUpdateGeometry()
109 {
110     ASSERT(m_isWaitingForDidUpdateGeometry);
111
112     m_isWaitingForDidUpdateGeometry = false;
113
114     IntSize viewLayoutSize = m_webPageProxy.viewLayoutSize();
115
116     // If the WKView was resized while we were waiting for a DidUpdateGeometry reply from the web process,
117     // we need to resend the new size here.
118     if (m_lastSentSize != m_size || m_lastSentViewLayoutSize != viewLayoutSize)
119         sendUpdateGeometry();
120 }
121
122 void TiledCoreAnimationDrawingAreaProxy::waitForDidUpdateActivityState(ActivityStateChangeID)
123 {
124     Seconds activityStateUpdateTimeout = Seconds::fromMilliseconds(250);
125     process().connection()->waitForAndDispatchImmediately<Messages::WebPageProxy::DidUpdateActivityState>(m_webPageProxy.pageID(), activityStateUpdateTimeout, IPC::WaitForOption::InterruptWaitingIfSyncMessageArrives);
126 }
127
128 void TiledCoreAnimationDrawingAreaProxy::willSendUpdateGeometry()
129 {
130     m_lastSentViewLayoutSize = m_webPageProxy.viewLayoutSize();
131     m_lastSentSize = m_size;
132     m_isWaitingForDidUpdateGeometry = true;
133 }
134
135 MachSendRight TiledCoreAnimationDrawingAreaProxy::createFence()
136 {
137     if (!m_webPageProxy.hasRunningProcess())
138         return MachSendRight();
139
140     RetainPtr<CAContext> rootLayerContext = [m_webPageProxy.acceleratedCompositingRootLayer() context];
141     if (!rootLayerContext)
142         return MachSendRight();
143
144     // Don't fence if we don't have a connection, because the message
145     // will likely get dropped on the floor (if the Web process is terminated)
146     // or queued up until process launch completes, and there's nothing useful
147     // to synchronize in these cases.
148     if (!process().connection())
149         return MachSendRight();
150
151     // Don't fence if we have incoming synchronous messages, because we may not
152     // be able to reply to the message until the fence times out.
153     if (process().connection()->hasIncomingSyncMessage())
154         return MachSendRight();
155
156     MachSendRight fencePort = MachSendRight::adopt([rootLayerContext createFencePort]);
157
158     // Invalidate the fence if a synchronous message arrives while it's installed,
159     // because we won't be able to reply during the fence-wait.
160     uint64_t callbackID = process().connection()->installIncomingSyncMessageCallback([rootLayerContext] {
161         [rootLayerContext invalidateFences];
162     });
163     RefPtr<WebPageProxy> retainedPage = &m_webPageProxy;
164     [CATransaction addCommitHandler:[callbackID, retainedPage] {
165         if (!retainedPage->hasRunningProcess())
166             return;
167         if (Connection* connection = retainedPage->process().connection())
168             connection->uninstallIncomingSyncMessageCallback(callbackID);
169     } forPhase:kCATransactionPhasePostCommit];
170
171     return fencePort;
172 }
173
174 void TiledCoreAnimationDrawingAreaProxy::sendUpdateGeometry()
175 {
176     ASSERT(!m_isWaitingForDidUpdateGeometry);
177
178     willSendUpdateGeometry();
179     send(Messages::DrawingArea::UpdateGeometry(m_size, true /* flushSynchronously */, createFence()));
180 }
181
182 void TiledCoreAnimationDrawingAreaProxy::adjustTransientZoom(double scale, FloatPoint origin)
183 {
184     send(Messages::DrawingArea::AdjustTransientZoom(scale, origin));
185 }
186
187 void TiledCoreAnimationDrawingAreaProxy::commitTransientZoom(double scale, FloatPoint origin)
188 {
189     send(Messages::DrawingArea::CommitTransientZoom(scale, origin));
190 }
191
192 void TiledCoreAnimationDrawingAreaProxy::dispatchAfterEnsuringDrawing(WTF::Function<void (CallbackBase::Error)>&& callback)
193 {
194     if (!m_webPageProxy.hasRunningProcess()) {
195         callback(CallbackBase::Error::OwnerWasInvalidated);
196         return;
197     }
198
199     send(Messages::DrawingArea::AddTransactionCallbackID(m_callbacks.put(WTFMove(callback), nullptr)));
200 }
201
202 void TiledCoreAnimationDrawingAreaProxy::dispatchPresentationCallbacksAfterFlushingLayers(const Vector<CallbackID>& callbackIDs)
203 {
204     for (auto& callbackID : callbackIDs) {
205         if (auto callback = m_callbacks.take<VoidCallback>(callbackID))
206             callback->performCallback();
207     }
208 }
209
210 } // namespace WebKit
211
212 #endif // !PLATFORM(IOS_FAMILY)