b04c45040db58a00b1455555d26b4dab62b91217
[WebKit-https.git] / Source / WebKit2 / UIProcess / DrawingAreaProxyImpl.cpp
1 /*
2  * Copyright (C) 2011 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 "DrawingAreaProxyImpl.h"
28
29 #include "DrawingAreaMessages.h"
30 #include "DrawingAreaProxyMessages.h"
31 #include "LayerTreeContext.h"
32 #include "UpdateInfo.h"
33 #include "WebPageGroup.h"
34 #include "WebPageProxy.h"
35 #include "WebPreferences.h"
36 #include "WebProcessProxy.h"
37 #include <WebCore/Region.h>
38
39 using namespace WebCore;
40
41 namespace WebKit {
42
43 DrawingAreaProxyImpl::DrawingAreaProxyImpl(WebPageProxy& webPageProxy)
44     : DrawingAreaProxy(DrawingAreaTypeImpl, webPageProxy)
45     , m_currentBackingStoreStateID(0)
46     , m_nextBackingStoreStateID(0)
47     , m_isWaitingForDidUpdateBackingStoreState(false)
48     , m_hasReceivedFirstUpdate(false)
49     , m_isBackingStoreDiscardable(true)
50     , m_discardBackingStoreTimer(RunLoop::current(), this, &DrawingAreaProxyImpl::discardBackingStore)
51 {
52 }
53
54 DrawingAreaProxyImpl::~DrawingAreaProxyImpl()
55 {
56     // Make sure to exit accelerated compositing mode.
57     if (isInAcceleratedCompositingMode())
58         exitAcceleratedCompositingMode();
59 }
60
61 void DrawingAreaProxyImpl::paint(BackingStore::PlatformGraphicsContext context, const IntRect& rect, Region& unpaintedRegion)
62 {
63     unpaintedRegion = rect;
64
65     if (isInAcceleratedCompositingMode())
66         return;
67
68     ASSERT(m_currentBackingStoreStateID <= m_nextBackingStoreStateID);
69     if (m_currentBackingStoreStateID < m_nextBackingStoreStateID) {
70         // Tell the web process to do a full backing store update now, in case we previously told
71         // it about our next state but didn't request an immediate update.
72         sendUpdateBackingStoreState(RespondImmediately);
73
74         // If we haven't yet received our first bits from the WebProcess then don't paint anything.
75         if (!m_hasReceivedFirstUpdate)
76             return;        
77         
78         if (m_isWaitingForDidUpdateBackingStoreState) {
79             // Wait for a DidUpdateBackingStoreState message that contains the new bits before we paint
80             // what's currently in the backing store.
81             waitForAndDispatchDidUpdateBackingStoreState();
82         }
83
84         // Dispatching DidUpdateBackingStoreState (either beneath sendUpdateBackingStoreState or
85         // beneath waitForAndDispatchDidUpdateBackingStoreState) could destroy our backing store or
86         // change the compositing mode.
87         if (!m_backingStore || isInAcceleratedCompositingMode())
88             return;
89     } else {
90         ASSERT(!m_isWaitingForDidUpdateBackingStoreState);
91         if (!m_backingStore) {
92             // The view has asked us to paint before the web process has painted anything. There's
93             // nothing we can do.
94             return;
95         }
96     }
97
98     m_backingStore->paint(context, rect);
99     unpaintedRegion.subtract(IntRect(IntPoint(), m_backingStore->size()));
100
101     discardBackingStoreSoon();
102 }
103
104 void DrawingAreaProxyImpl::sizeDidChange()
105 {
106     backingStoreStateDidChange(RespondImmediately);
107 }
108
109 void DrawingAreaProxyImpl::deviceScaleFactorDidChange()
110 {
111     backingStoreStateDidChange(RespondImmediately);
112 }
113
114 void DrawingAreaProxyImpl::setBackingStoreIsDiscardable(bool isBackingStoreDiscardable)
115 {
116     if (m_isBackingStoreDiscardable == isBackingStoreDiscardable)
117         return;
118
119     m_isBackingStoreDiscardable = isBackingStoreDiscardable;
120     if (m_isBackingStoreDiscardable)
121         discardBackingStoreSoon();
122     else
123         m_discardBackingStoreTimer.stop();
124 }
125
126 void DrawingAreaProxyImpl::waitForBackingStoreUpdateOnNextPaint()
127 {
128     m_hasReceivedFirstUpdate = true;
129 }
130
131 void DrawingAreaProxyImpl::update(uint64_t backingStoreStateID, const UpdateInfo& updateInfo)
132 {
133     ASSERT_ARG(backingStoreStateID, backingStoreStateID <= m_currentBackingStoreStateID);
134     if (backingStoreStateID < m_currentBackingStoreStateID)
135         return;
136
137     // FIXME: Handle the case where the view is hidden.
138
139     incorporateUpdate(updateInfo);
140     m_webPageProxy.process().send(Messages::DrawingArea::DidUpdate(), m_webPageProxy.pageID());
141 }
142
143 void DrawingAreaProxyImpl::didUpdateBackingStoreState(uint64_t backingStoreStateID, const UpdateInfo& updateInfo, const LayerTreeContext& layerTreeContext)
144 {
145     ASSERT_ARG(backingStoreStateID, backingStoreStateID <= m_nextBackingStoreStateID);
146     ASSERT_ARG(backingStoreStateID, backingStoreStateID > m_currentBackingStoreStateID);
147     m_currentBackingStoreStateID = backingStoreStateID;
148
149     m_isWaitingForDidUpdateBackingStoreState = false;
150
151     // Stop the responsiveness timer that was started in sendUpdateBackingStoreState.
152     m_webPageProxy.process().responsivenessTimer()->stop();
153
154     if (layerTreeContext != m_layerTreeContext) {
155         if (!m_layerTreeContext.isEmpty()) {
156             exitAcceleratedCompositingMode();
157             ASSERT(m_layerTreeContext.isEmpty());
158         }
159
160         if (!layerTreeContext.isEmpty()) {
161             enterAcceleratedCompositingMode(layerTreeContext);
162             ASSERT(layerTreeContext == m_layerTreeContext);
163         }            
164     }
165
166     if (m_nextBackingStoreStateID != m_currentBackingStoreStateID)
167         sendUpdateBackingStoreState(RespondImmediately);
168     else
169         m_hasReceivedFirstUpdate = true;
170
171     if (isInAcceleratedCompositingMode()) {
172         ASSERT(!m_backingStore);
173         return;
174     }
175
176     // If we have a backing store the right size, reuse it.
177     if (m_backingStore && (m_backingStore->size() != updateInfo.viewSize || m_backingStore->deviceScaleFactor() != updateInfo.deviceScaleFactor))
178         m_backingStore = nullptr;
179     incorporateUpdate(updateInfo);
180 }
181
182 void DrawingAreaProxyImpl::enterAcceleratedCompositingMode(uint64_t backingStoreStateID, const LayerTreeContext& layerTreeContext)
183 {
184     ASSERT_ARG(backingStoreStateID, backingStoreStateID <= m_currentBackingStoreStateID);
185     if (backingStoreStateID < m_currentBackingStoreStateID)
186         return;
187
188     enterAcceleratedCompositingMode(layerTreeContext);
189 }
190
191 void DrawingAreaProxyImpl::exitAcceleratedCompositingMode(uint64_t backingStoreStateID, const UpdateInfo& updateInfo)
192 {
193     ASSERT_ARG(backingStoreStateID, backingStoreStateID <= m_currentBackingStoreStateID);
194     if (backingStoreStateID < m_currentBackingStoreStateID)
195         return;
196
197     exitAcceleratedCompositingMode();
198
199     incorporateUpdate(updateInfo);
200 }
201
202 void DrawingAreaProxyImpl::updateAcceleratedCompositingMode(uint64_t backingStoreStateID, const LayerTreeContext& layerTreeContext)
203 {
204     ASSERT_ARG(backingStoreStateID, backingStoreStateID <= m_currentBackingStoreStateID);
205     if (backingStoreStateID < m_currentBackingStoreStateID)
206         return;
207
208     updateAcceleratedCompositingMode(layerTreeContext);
209 }
210
211 void DrawingAreaProxyImpl::incorporateUpdate(const UpdateInfo& updateInfo)
212 {
213     ASSERT(!isInAcceleratedCompositingMode());
214
215     if (updateInfo.updateRectBounds.isEmpty())
216         return;
217
218     if (!m_backingStore)
219         m_backingStore = std::make_unique<BackingStore>(updateInfo.viewSize, updateInfo.deviceScaleFactor, m_webPageProxy);
220
221     m_backingStore->incorporateUpdate(updateInfo);
222
223     bool shouldScroll = !updateInfo.scrollRect.isEmpty();
224
225     if (shouldScroll)
226         m_webPageProxy.scrollView(updateInfo.scrollRect, updateInfo.scrollOffset);
227     
228     if (shouldScroll && !m_webPageProxy.canScrollView())
229         m_webPageProxy.setViewNeedsDisplay(IntRect(IntPoint(), m_webPageProxy.viewSize()));
230     else {
231         for (size_t i = 0; i < updateInfo.updateRects.size(); ++i)
232             m_webPageProxy.setViewNeedsDisplay(updateInfo.updateRects[i]);
233     }
234
235     if (shouldScroll)
236         m_webPageProxy.displayView();
237 }
238
239 void DrawingAreaProxyImpl::backingStoreStateDidChange(RespondImmediatelyOrNot respondImmediatelyOrNot)
240 {
241     ++m_nextBackingStoreStateID;
242     sendUpdateBackingStoreState(respondImmediatelyOrNot);
243 }
244
245 void DrawingAreaProxyImpl::sendUpdateBackingStoreState(RespondImmediatelyOrNot respondImmediatelyOrNot)
246 {
247     ASSERT(m_currentBackingStoreStateID < m_nextBackingStoreStateID);
248
249     if (!m_webPageProxy.isValid())
250         return;
251
252     if (m_isWaitingForDidUpdateBackingStoreState)
253         return;
254
255     if (m_webPageProxy.viewSize().isEmpty() && !m_webPageProxy.useFixedLayout())
256         return;
257
258     m_isWaitingForDidUpdateBackingStoreState = respondImmediatelyOrNot == RespondImmediately;
259
260     m_webPageProxy.process().send(Messages::DrawingArea::UpdateBackingStoreState(m_nextBackingStoreStateID, respondImmediatelyOrNot == RespondImmediately, m_webPageProxy.deviceScaleFactor(), m_size, m_scrollOffset), m_webPageProxy.pageID());
261     m_scrollOffset = IntSize();
262
263     if (m_isWaitingForDidUpdateBackingStoreState) {
264         // Start the responsiveness timer. We will stop it when we hear back from the WebProcess
265         // in didUpdateBackingStoreState.
266         m_webPageProxy.process().responsivenessTimer()->start();
267     }
268
269     if (m_isWaitingForDidUpdateBackingStoreState && !m_layerTreeContext.isEmpty()) {
270         // Wait for the DidUpdateBackingStoreState message. Normally we do this in DrawingAreaProxyImpl::paint, but that
271         // function is never called when in accelerated compositing mode.
272         waitForAndDispatchDidUpdateBackingStoreState();
273     }
274 }
275
276 void DrawingAreaProxyImpl::waitForAndDispatchDidUpdateBackingStoreState()
277 {
278     ASSERT(m_isWaitingForDidUpdateBackingStoreState);
279
280     if (!m_webPageProxy.isValid())
281         return;
282     if (m_webPageProxy.process().state() == WebProcessProxy::State::Launching)
283         return;
284
285     // FIXME: waitForAndDispatchImmediately will always return the oldest DidUpdateBackingStoreState message that
286     // hasn't yet been processed. But it might be better to skip ahead to some other DidUpdateBackingStoreState
287     // message, if multiple DidUpdateBackingStoreState messages are waiting to be processed. For instance, we could
288     // choose the most recent one, or the one that is closest to our current size.
289
290     // The timeout we use when waiting for a DidUpdateBackingStoreState message when we're asked to paint is 500 milliseconds.
291     m_webPageProxy.process().connection()->waitForAndDispatchImmediately<Messages::DrawingAreaProxy::DidUpdateBackingStoreState>(m_webPageProxy.pageID(), std::chrono::milliseconds(500));
292 }
293
294 void DrawingAreaProxyImpl::enterAcceleratedCompositingMode(const LayerTreeContext& layerTreeContext)
295 {
296     ASSERT(!isInAcceleratedCompositingMode());
297
298     m_backingStore = nullptr;
299     m_layerTreeContext = layerTreeContext;
300     m_webPageProxy.enterAcceleratedCompositingMode(layerTreeContext);
301 }
302
303 #if USE(TEXTURE_MAPPER_GL) && PLATFORM(GTK)
304 void DrawingAreaProxyImpl::setNativeSurfaceHandleForCompositing(uint64_t handle)
305 {
306     m_webPageProxy.process().send(Messages::DrawingArea::SetNativeSurfaceHandleForCompositing(handle), m_webPageProxy.pageID());
307 }
308 #endif
309
310 void DrawingAreaProxyImpl::exitAcceleratedCompositingMode()
311 {
312     ASSERT(isInAcceleratedCompositingMode());
313
314     m_layerTreeContext = LayerTreeContext();    
315     m_webPageProxy.exitAcceleratedCompositingMode();
316 }
317
318 void DrawingAreaProxyImpl::updateAcceleratedCompositingMode(const LayerTreeContext& layerTreeContext)
319 {
320     ASSERT(isInAcceleratedCompositingMode());
321
322     m_layerTreeContext = layerTreeContext;
323     m_webPageProxy.updateAcceleratedCompositingMode(layerTreeContext);
324 }
325
326 void DrawingAreaProxyImpl::discardBackingStoreSoon()
327 {
328     if (!m_isBackingStoreDiscardable || m_discardBackingStoreTimer.isActive())
329         return;
330
331     // We'll wait this many seconds after the last paint before throwing away our backing store to save memory.
332     // FIXME: It would be smarter to make this delay based on how expensive painting is. See <http://webkit.org/b/55733>.
333     static const double discardBackingStoreDelay = 2;
334
335     m_discardBackingStoreTimer.startOneShot(discardBackingStoreDelay);
336 }
337
338 void DrawingAreaProxyImpl::discardBackingStore()
339 {
340     m_backingStore = nullptr;
341     backingStoreStateDidChange(DoNotRespondImmediately);
342 }
343
344 } // namespace WebKit