[chromium] Don't crash if tile upload happens without painting first
[WebKit-https.git] / Source / WebCore / platform / graphics / chromium / TiledLayerChromium.cpp
1 /*
2  * Copyright (C) 2011 Google 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27
28 #if USE(ACCELERATED_COMPOSITING)
29
30 #include "TiledLayerChromium.h"
31
32 #include "GraphicsContext3D.h"
33 #include "LayerRendererChromium.h"
34 #include "ManagedTexture.h"
35 #include "MathExtras.h"
36 #include "TextStream.h"
37 #include "cc/CCLayerImpl.h"
38 #include "cc/CCTextureUpdater.h"
39 #include "cc/CCTiledLayerImpl.h"
40 #include <wtf/CurrentTime.h>
41
42 // Start tiling when the width and height of a layer are larger than this size.
43 static int maxUntiledSize = 512;
44
45 // When tiling is enabled, use tiles of this dimension squared.
46 static int defaultTileSize = 256;
47
48 using namespace std;
49
50 namespace WebCore {
51
52 class UpdatableTile : public CCLayerTilingData::Tile {
53     WTF_MAKE_NONCOPYABLE(UpdatableTile);
54 public:
55     explicit UpdatableTile(PassOwnPtr<LayerTextureUpdater::Texture> texture) : m_texture(texture) { }
56
57     LayerTextureUpdater::Texture* texture() { return m_texture.get(); }
58     ManagedTexture* managedTexture() { return m_texture->texture(); }
59
60     bool isDirty() const { return !m_dirtyLayerRect.isEmpty(); }
61     void clearDirty() { m_dirtyLayerRect = IntRect(); }
62
63     // Layer-space dirty rectangle that needs to be repainted.
64     IntRect m_dirtyLayerRect;
65     // Content-space rectangle that needs to be updated.
66     IntRect m_updateRect;
67 private:
68     OwnPtr<LayerTextureUpdater::Texture> m_texture;
69 };
70
71 TiledLayerChromium::TiledLayerChromium(CCLayerDelegate* delegate)
72     : LayerChromium(delegate)
73     , m_textureFormat(GraphicsContext3D::INVALID_ENUM)
74     , m_skipsDraw(false)
75     , m_textureOrientation(LayerTextureUpdater::InvalidOrientation)
76     , m_sampledTexelFormat(LayerTextureUpdater::SampledTexelFormatInvalid)
77     , m_tilingOption(AutoTile)
78 {
79 }
80
81 TiledLayerChromium::~TiledLayerChromium()
82 {
83 }
84
85 PassRefPtr<CCLayerImpl> TiledLayerChromium::createCCLayerImpl()
86 {
87     return CCTiledLayerImpl::create(id());
88 }
89
90 void TiledLayerChromium::cleanupResources()
91 {
92     LayerChromium::cleanupResources();
93
94     m_tiler.clear();
95     m_paintRect = IntRect();
96     m_requestedUpdateRect = IntRect();
97 }
98
99 void TiledLayerChromium::updateTileSizeAndTilingOption()
100 {
101     const IntSize tileSize(min(defaultTileSize, contentBounds().width()), min(defaultTileSize, contentBounds().height()));
102
103     // Tile if both dimensions large, or any one dimension large and the other
104     // extends into a second tile. This heuristic allows for long skinny layers
105     // (e.g. scrollbars) that are Nx1 tiles to minimize wasted texture space.
106     const bool anyDimensionLarge = contentBounds().width() > maxUntiledSize || contentBounds().height() > maxUntiledSize;
107     const bool anyDimensionOneTile = contentBounds().width() <= defaultTileSize || contentBounds().height() <= defaultTileSize;
108     const bool autoTiled = anyDimensionLarge && !anyDimensionOneTile;
109
110     bool isTiled;
111     if (m_tilingOption == AlwaysTile)
112         isTiled = true;
113     else if (m_tilingOption == NeverTile)
114         isTiled = false;
115     else
116         isTiled = autoTiled;
117
118     IntSize requestedSize = isTiled ? tileSize : contentBounds();
119     const int maxSize = layerTreeHost()->layerRendererCapabilities().maxTextureSize;
120     IntSize clampedSize = requestedSize.shrunkTo(IntSize(maxSize, maxSize));
121     setTileSize(clampedSize);
122 }
123
124 void TiledLayerChromium::setTileSize(const IntSize& size)
125 {
126     if (m_tiler && m_tileSize == size)
127         return;
128     m_tileSize = size;
129     m_tiler.clear(); // Changing the tile size invalidates all tiles, so we just throw away the tiling data.
130 }
131
132 bool TiledLayerChromium::drawsContent() const
133 {
134     if (!m_delegate)
135         return false;
136
137     if (!m_tiler)
138         return true;
139
140     if (m_tilingOption == NeverTile && m_tiler->numTiles() > 1)
141         return false;
142
143     return !m_skipsDraw;
144 }
145
146 bool TiledLayerChromium::needsContentsScale() const
147 {
148     return true;
149 }
150
151 IntSize TiledLayerChromium::contentBounds() const
152 {
153     return IntSize(lroundf(bounds().width() * contentsScale()), lroundf(bounds().height() * contentsScale()));
154 }
155
156 void TiledLayerChromium::setLayerTreeHost(CCLayerTreeHost* host)
157 {
158     LayerChromium::setLayerTreeHost(host);
159
160     if (m_tiler || !host)
161         return;
162
163     createTextureUpdater(host);
164
165     setTextureFormat(host->layerRendererCapabilities().bestTextureFormat);
166     m_textureOrientation = textureUpdater()->orientation();
167     m_sampledTexelFormat = textureUpdater()->sampledTexelFormat(m_textureFormat);
168 }
169
170 void TiledLayerChromium::createTiler(CCLayerTilingData::BorderTexelOption borderTexelOption)
171 {
172     m_tiler = CCLayerTilingData::create(m_tileSize, borderTexelOption);
173 }
174
175 void TiledLayerChromium::updateCompositorResources(GraphicsContext3D*, CCTextureUpdater& updater)
176 {
177     // If this assert is hit, it means that paintContentsIfDirty hasn't been
178     // called on this layer. Any layer that is updated should be painted first.
179     ASSERT(m_tiler);
180
181     // Painting could cause compositing to get turned off, which may cause the tiler to become invalidated mid-update.
182     if (m_skipsDraw || m_requestedUpdateRect.isEmpty() || !m_tiler || !m_tiler->numTiles())
183         return;
184
185     int left, top, right, bottom;
186     m_tiler->contentRectToTileIndices(m_requestedUpdateRect, left, top, right, bottom);
187     for (int j = top; j <= bottom; ++j) {
188         for (int i = left; i <= right; ++i) {
189             UpdatableTile* tile = tileAt(i, j);
190
191             // Required tiles are created in prepareToUpdate(). A tile should
192             // never be removed between the call to prepareToUpdate() and the
193             // call to updateCompositorResources().
194             if (!tile)
195                 CRASH();
196
197             IntRect sourceRect = tile->m_updateRect;
198             if (tile->m_updateRect.isEmpty())
199                 continue;
200
201             ASSERT(tile->managedTexture()->isReserved());
202             const IntPoint anchor = m_tiler->tileContentRect(tile).location();
203
204             // Calculate tile-space rectangle to upload into.
205             IntRect destRect(IntPoint(sourceRect.x() - anchor.x(), sourceRect.y() - anchor.y()), sourceRect.size());
206             if (destRect.x() < 0)
207                 CRASH();
208             if (destRect.y() < 0)
209                 CRASH();
210
211             // Offset from paint rectangle to this tile's dirty rectangle.
212             IntPoint paintOffset(sourceRect.x() - m_paintRect.x(), sourceRect.y() - m_paintRect.y());
213             if (paintOffset.x() < 0)
214                 CRASH();
215             if (paintOffset.y() < 0)
216                 CRASH();
217             if (paintOffset.x() + destRect.width() > m_paintRect.width())
218                 CRASH();
219             if (paintOffset.y() + destRect.height() > m_paintRect.height())
220                 CRASH();
221
222             updater.append(tile->texture(), sourceRect, destRect);
223         }
224     }
225
226     m_updateRect = FloatRect(m_tiler->contentRectToLayerRect(m_paintRect));
227 }
228
229 void TiledLayerChromium::setTilingOption(TilingOption tilingOption)
230 {
231     if (m_tiler && m_tilingOption == tilingOption)
232         return;
233     m_tilingOption = tilingOption;
234     m_tiler.clear(); // Changing the tiling option invalidates all tiles, so we just throw away the tiling data.
235 }
236
237 void TiledLayerChromium::setIsMask(bool isMask)
238 {
239     setTilingOption(isMask ? NeverTile : AutoTile);
240 }
241
242 void TiledLayerChromium::pushPropertiesTo(CCLayerImpl* layer)
243 {
244     LayerChromium::pushPropertiesTo(layer);
245
246     CCTiledLayerImpl* tiledLayer = static_cast<CCTiledLayerImpl*>(layer);
247     if (!m_tiler) {
248         tiledLayer->setSkipsDraw(true);
249         return;
250     }
251
252     tiledLayer->setSkipsDraw(m_skipsDraw);
253     tiledLayer->setTextureOrientation(m_textureOrientation);
254     tiledLayer->setSampledTexelFormat(m_sampledTexelFormat);
255     tiledLayer->setTilingData(*m_tiler);
256
257     for (CCLayerTilingData::TileMap::const_iterator iter = m_tiler->tiles().begin(); iter != m_tiler->tiles().end(); ++iter) {
258         int i = iter->first.first;
259         int j = iter->first.second;
260         UpdatableTile* tile = static_cast<UpdatableTile*>(iter->second.get());
261         if (!tile->managedTexture()->isValid(m_tiler->tileSize(), m_textureFormat))
262             continue;
263         if (tile->isDirty())
264             continue;
265
266         tiledLayer->syncTextureId(i, j, tile->managedTexture()->textureId());
267     }
268 }
269
270 TextureManager* TiledLayerChromium::textureManager() const
271 {
272     if (!layerTreeHost())
273         return 0;
274     return layerTreeHost()->contentsTextureManager();
275 }
276
277 UpdatableTile* TiledLayerChromium::tileAt(int i, int j) const
278 {
279     return static_cast<UpdatableTile*>(m_tiler->tileAt(i, j));
280 }
281
282 UpdatableTile* TiledLayerChromium::createTile(int i, int j)
283 {
284     RefPtr<UpdatableTile> tile = adoptRef(new UpdatableTile(textureUpdater()->createTexture(textureManager())));
285     m_tiler->addTile(tile, i, j);
286     tile->m_dirtyLayerRect = m_tiler->tileLayerRect(tile.get());
287
288     return tile.get();
289 }
290
291 void TiledLayerChromium::setNeedsDisplayRect(const FloatRect& dirtyRect)
292 {
293     IntRect dirty = enclosingIntRect(dirtyRect);
294     invalidateRect(dirty);
295     LayerChromium::setNeedsDisplayRect(dirtyRect);
296 }
297
298 void TiledLayerChromium::invalidateRect(const IntRect& contentRect)
299 {
300     if (!m_tiler || contentRect.isEmpty() || m_skipsDraw)
301         return;
302
303     // Dirty rects are always in layer space, as the layer could be repositioned
304     // after invalidation.
305     const IntRect layerRect = m_tiler->contentRectToLayerRect(contentRect);
306
307     int left, top, right, bottom;
308     m_tiler->contentRectToTileIndices(contentRect, left, top, right, bottom);
309     for (int j = top; j <= bottom; ++j) {
310         for (int i = left; i <= right; ++i) {
311             UpdatableTile* tile = tileAt(i, j);
312             if (!tile)
313                 continue;
314             IntRect bound = m_tiler->tileLayerRect(tile);
315             bound.intersect(layerRect);
316             tile->m_dirtyLayerRect.unite(bound);
317         }
318     }
319 }
320
321 void TiledLayerChromium::protectVisibleTileTextures()
322 {
323     protectTileTextures(IntRect(IntPoint::zero(), contentBounds()));
324 }
325
326 void TiledLayerChromium::protectTileTextures(const IntRect& contentRect)
327 {
328     if (!m_tiler || contentRect.isEmpty())
329         return;
330
331     int left, top, right, bottom;
332     m_tiler->contentRectToTileIndices(contentRect, left, top, right, bottom);
333
334     for (int j = top; j <= bottom; ++j) {
335         for (int i = left; i <= right; ++i) {
336             UpdatableTile* tile = tileAt(i, j);
337             if (!tile || !tile->managedTexture()->isValid(m_tiler->tileSize(), m_textureFormat))
338                 continue;
339
340             tile->managedTexture()->reserve(m_tiler->tileSize(), m_textureFormat);
341         }
342     }
343 }
344
345 void TiledLayerChromium::prepareToUpdate(const IntRect& contentRect)
346 {
347     if (!m_tiler)
348         createTiler(isNonCompositedContent() ? CCLayerTilingData::NoBorderTexels : CCLayerTilingData::HasBorderTexels);
349
350     ASSERT(m_tiler);
351
352     m_skipsDraw = false;
353
354     // Reset m_updateRect for all tiles.
355     for (CCLayerTilingData::TileMap::const_iterator iter = m_tiler->tiles().begin(); iter != m_tiler->tiles().end(); ++iter) {
356         UpdatableTile* tile = static_cast<UpdatableTile*>(iter->second.get());
357         tile->m_updateRect = IntRect();
358     }
359
360     if (contentRect.isEmpty()) {
361         m_requestedUpdateRect = IntRect();
362         return;
363     }
364
365     m_tiler->growLayerToContain(contentRect);
366
367     if (!m_tiler->numTiles()) {
368         m_requestedUpdateRect = IntRect();
369         return;
370     }
371
372     // Create tiles as needed, expanding a dirty rect to contain all
373     // the dirty regions currently being drawn.
374     IntRect dirtyLayerRect;
375     int left, top, right, bottom;
376     m_tiler->contentRectToTileIndices(contentRect, left, top, right, bottom);
377     for (int j = top; j <= bottom; ++j) {
378         for (int i = left; i <= right; ++i) {
379             UpdatableTile* tile = tileAt(i, j);
380             if (!tile)
381                 tile = createTile(i, j);
382
383             if (!tile->managedTexture()->isValid(m_tiler->tileSize(), m_textureFormat))
384                 tile->m_dirtyLayerRect = m_tiler->tileLayerRect(tile);
385
386             if (!tile->managedTexture()->reserve(m_tiler->tileSize(), m_textureFormat)) {
387                 m_skipsDraw = true;
388                 cleanupResources();
389                 return;
390             }
391
392             dirtyLayerRect.unite(tile->m_dirtyLayerRect);
393         }
394     }
395
396     // Due to borders, when the paint rect is extended to tile boundaries, it
397     // may end up overlapping more tiles than the original content rect. Record
398     // that original rect so we don't upload more tiles than necessary.
399     m_requestedUpdateRect = contentRect;
400
401     m_paintRect = m_tiler->layerRectToContentRect(dirtyLayerRect);
402     if (dirtyLayerRect.isEmpty())
403         return;
404
405     // Calling prepareToUpdate() calls into WebKit to paint, which may have the side
406     // effect of disabling compositing, which causes our reference to the texture updater to be deleted.
407     // However, we can't free the memory backing the GraphicsContext until the paint finishes,
408     // so we grab a local reference here to hold the updater alive until the paint completes.
409     RefPtr<LayerTextureUpdater> protector(textureUpdater());
410     textureUpdater()->prepareToUpdate(m_paintRect, m_tiler->tileSize(), m_tiler->hasBorderTexels(), contentsScale());
411     m_tiler->contentRectToTileIndices(m_requestedUpdateRect, left, top, right, bottom);
412     for (int j = top; j <= bottom; ++j) {
413         for (int i = left; i <= right; ++i) {
414             UpdatableTile* tile = tileAt(i, j);
415
416             // Tiles are created before prepareToUpdate() is called.
417             if (!tile)
418                 CRASH();
419
420             if (!tile->isDirty())
421                 continue;
422
423             // Calculate content-space rectangle to copy from.
424             IntRect sourceRect = m_tiler->tileContentRect(tile);
425             sourceRect.intersect(m_tiler->layerRectToContentRect(tile->m_dirtyLayerRect));
426             // Paint rect not guaranteed to line up on tile boundaries, so
427             // make sure that sourceRect doesn't extend outside of it.
428             sourceRect.intersect(m_paintRect);
429
430             // updateCompositorResources() uses m_updateRect to determine
431             // the tiles to update so we can clear the dirty rectangle here.
432             tile->clearDirty();
433
434             tile->m_updateRect = sourceRect;
435             if (sourceRect.isEmpty())
436                 continue;
437
438             tile->texture()->prepareRect(sourceRect);
439         }
440     }
441 }
442
443 }
444 #endif // USE(ACCELERATED_COMPOSITING)