Free temporary GPU and memory resources held by inactive or hidden 2D canvases

Source/platform/graphics/Canvas2DLayerBridge.cpp

 /*
  * Copyright (C) 2012 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  * 1.  Redistributions of source code must retain the above copyright
  *     notice, this list of conditions and the following disclaimer.
  * 2.  Redistributions in binary form must reproduce the above copyright
@@ skipping 23 matching lines @@
 #include "platform/graphics/Canvas2DLayerManager.h"
 #include "platform/graphics/GraphicsLayer.h"
 #include "platform/graphics/gpu/SharedGraphicsContext3D.h"
 #include "public/platform/Platform.h"
 #include "public/platform/WebCompositorSupport.h"
 #include "public/platform/WebGraphicsContext3D.h"
 
 using blink::WebExternalTextureLayer;
 using blink::WebGraphicsContext3D;
 
+namespace {
+const size_t MaxSize = ~static_cast<size_t>(0);

[eseidel, 2013/12/19 02:56:32]

std::limits?

+}
+
 namespace WebCore {
 
 static PassRefPtr<SkSurface> createSkSurface(GraphicsContext3D* context3D, const IntSize& size, int msaaSampleCount)
 {
     ASSERT(!context3D->webContext()->isContextLost());
     GrContext* gr = context3D->grContext();
     if (!gr)
         return 0;
     gr->resetContext();
     SkImageInfo info;
     info.fWidth = size.width();
     info.fHeight = size.height();
     info.fColorType = kPMColor_SkColorType;
     info.fAlphaType = kPremul_SkAlphaType;
     return adoptRef(SkSurface::NewRenderTarget(gr, info,  msaaSampleCount));
 }
 
-PassRefPtr<Canvas2DLayerBridge> Canvas2DLayerBridge::create(const IntSize& size, OpacityMode opacityMode, int msaaSampleCount)
+PassRefPtr<Canvas2DLayerBridge> Canvas2DLayerBridge::create(Canvas2DLayerBridgeClient* client, const IntSize& size, OpacityMode opacityMode, int msaaSampleCount)
 {
     TRACE_EVENT_INSTANT0("test_gpu", "Canvas2DLayerBridgeCreation");
     RefPtr<GraphicsContext3D> context = SharedGraphicsContext3D::get();
     RefPtr<SkSurface> surface(createSkSurface(context.get(), size, msaaSampleCount));
     if (!surface)
         return 0;
     RefPtr<Canvas2DLayerBridge> layerBridge;
     OwnPtr<SkDeferredCanvas> canvas = adoptPtr(SkDeferredCanvas::Create(surface.get()));
-    layerBridge = adoptRef(new Canvas2DLayerBridge(context, canvas.release(), msaaSampleCount, opacityMode));
+    layerBridge = adoptRef(new Canvas2DLayerBridge(client, context, canvas.release(), msaaSampleCount, opacityMode));
     return layerBridge.release();
 }
 
-Canvas2DLayerBridge::Canvas2DLayerBridge(PassRefPtr<GraphicsContext3D> context, PassOwnPtr<SkDeferredCanvas> canvas, int msaaSampleCount, OpacityMode opacityMode)
-    : m_canvas(canvas)
+Canvas2DLayerBridge::Canvas2DLayerBridge(Canvas2DLayerBridgeClient* client, PassRefPtr<GraphicsContext3D> context, PassOwnPtr<SkDeferredCanvas> canvas, int msaaSampleCount, OpacityMode opacityMode)
+    : m_client(client)
+    , m_canvas(canvas)
     , m_context(context)
     , m_msaaSampleCount(msaaSampleCount)
     , m_bytesAllocated(0)
     , m_didRecordDrawCommand(false)
     , m_surfaceIsValid(true)
     , m_framesPending(0)
+    , m_framesSinceMailboxRelease(0)
     , m_destructionInProgress(false)
     , m_rateLimitingEnabled(false)
     , m_next(0)
     , m_prev(0)
     , m_lastImageId(0)
+    , m_releasedMailboxInfo(0)
 {
     ASSERT(m_canvas);
+    ASSERT(m_client);
     // Used by browser tests to detect the use of a Canvas2DLayerBridge.
     TRACE_EVENT_INSTANT0("test_gpu", "Canvas2DLayerBridgeCreation");
     m_layer = adoptPtr(blink::Platform::current()->compositorSupport()->createExternalTextureLayer(this));
     m_layer->setOpaque(opacityMode == Opaque);
     m_layer->setBlendBackgroundColor(opacityMode != Opaque);
     GraphicsLayer::registerContentsLayer(m_layer->layer());
     m_layer->setRateLimitContext(m_rateLimitingEnabled);
     m_canvas->setNotificationClient(this);
 }
 
 Canvas2DLayerBridge::~Canvas2DLayerBridge()
 {
     ASSERT(m_destructionInProgress);
     m_layer.clear();
+    freeReleasedMailbox();
+#if !ASSERT_DISABLED
     Vector<MailboxInfo>::iterator mailboxInfo;
     for (mailboxInfo = m_mailboxes.begin(); mailboxInfo < m_mailboxes.end(); mailboxInfo++) {
         ASSERT(mailboxInfo->m_status != MailboxInUse);
-        if (mailboxInfo->m_status == MailboxReleased) {
-            if (mailboxInfo->m_mailbox.syncPoint) {
-                context()->waitSyncPoint(mailboxInfo->m_mailbox.syncPoint);
-                mailboxInfo->m_mailbox.syncPoint = 0;
-            }
-            // Invalidate texture state in case the compositor altered it since the copy-on-write.
-            mailboxInfo->m_image->getTexture()->invalidateCachedState();
-        }
+        ASSERT(mailboxInfo->m_status != MailboxReleased);
     }
+#endif
     m_mailboxes.clear();
 }
 
 void Canvas2DLayerBridge::beginDestruction()
 {
     ASSERT(!m_destructionInProgress);
     m_destructionInProgress = true;
     GraphicsLayer::unregisterContentsLayer(m_layer->layer());
     m_canvas->setNotificationClient(0);
     m_layer->clearTexture();
     Canvas2DLayerManager::get().layerToBeDestroyed(this);
     // Orphaning the layer is required to trigger the recration of a new layer
     // in the case where destruction is caused by a canvas resize. Test:
     // virtual/gpu/fast/canvas/canvas-resize-after-paint-without-layout.html
     m_layer->layer()->removeFromParent();
 }
 
+bool Canvas2DLayerBridge::hidden() const
+{
+    return m_destructionInProgress || m_client->hidden();
+}
+
+void Canvas2DLayerBridge::freeTransientResources()
+{
+    freeReleasedMailbox();
+    flush();
+    freeMemoryIfPossible(MaxSize);
+}
+
+bool Canvas2DLayerBridge::hasTransientResources() const
+{
+    return hasReleasedMailbox() || bytesAllocated();
+}
+
 void Canvas2DLayerBridge::limitPendingFrames()
 {
     ASSERT(!m_destructionInProgress);
     if (m_didRecordDrawCommand) {
         m_framesPending++;
         m_didRecordDrawCommand = false;
         if (m_framesPending > 1) {
             // Turn on the rate limiter if this layer tends to accumulate a
             // non-discardable multi-frame backlog of draw commands.
             setRateLimitingEnabled(true);
         }
         if (m_rateLimitingEnabled) {
             flush();
         }
     }
+    if (m_releasedMailboxInfo && ++m_framesSinceMailboxRelease >= 2) {
+        freeReleasedMailbox();
+    }
 }
 
 void Canvas2DLayerBridge::prepareForDraw()
 {
     ASSERT(!m_destructionInProgress);
     ASSERT(m_layer);
     if (!isValid()) {
         if (m_canvas) {
             // drop pending commands because there is no surface to draw to
             m_canvas->silentFlush();
@@ skipping 50 matching lines @@
         Canvas2DLayerManager::get().layerAllocatedStorageChanged(this, -((intptr_t)bytesFreed));
     m_bytesAllocated -= bytesFreed;
     return bytesFreed;
 }
 
 void Canvas2DLayerBridge::flush()
 {
     ASSERT(!m_destructionInProgress);
     if (m_canvas->hasPendingCommands()) {
         TRACE_EVENT0("cc", "Canvas2DLayerBridge::flush");
+        freeReleasedMailbox(); // To avoid unnecessary triple-buffering
         m_canvas->flush();
     }
 }
 
+void Canvas2DLayerBridge::freeReleasedMailbox()
+{
+    if (m_releasedMailboxInfo) {
+        ASSERT(m_releasedMailboxInfo->m_status == MailboxReleased);
+        if (m_releasedMailboxInfo->m_mailbox.syncPoint) {
+            context()->waitSyncPoint(m_releasedMailboxInfo->m_mailbox.syncPoint);
+            m_releasedMailboxInfo->m_mailbox.syncPoint = 0;
+        }
+        // Invalidate texture state in case the compositor altered it since the copy-on-write.
+        m_releasedMailboxInfo->m_image->getTexture()->invalidateCachedState();
+        m_releasedMailboxInfo->m_image.clear();
+        m_releasedMailboxInfo->m_status = MailboxAvailable;
+        m_releasedMailboxInfo = 0;
+    }
+}
+
 blink::WebGraphicsContext3D* Canvas2DLayerBridge::context()
 {
     // Check on m_layer is necessary because context() may be called during
     // the destruction of m_layer
     if (m_layer) {
         isValid(); // To ensure rate limiter is disabled if context is lost.
     }
     return m_context->webContext();
 }
 
@@ skipping 39 matching lines @@
         m_canvas->silentFlush();
         return false;
     }
     if (!isValid())
         return false;
     // Release to skia textures that were previouosly released by the
     // compositor. We do this before acquiring the next snapshot in
     // order to cap maximum gpu memory consumption.
     m_context->makeContextCurrent();
     flush();
-    Vector<MailboxInfo>::iterator mailboxInfo;
-    for (mailboxInfo = m_mailboxes.begin(); mailboxInfo < m_mailboxes.end(); mailboxInfo++) {
-        if (mailboxInfo->m_status == MailboxReleased) {
-            if (mailboxInfo->m_mailbox.syncPoint) {
-                context()->waitSyncPoint(mailboxInfo->m_mailbox.syncPoint);
-                mailboxInfo->m_mailbox.syncPoint = 0;
-            }
-            // Invalidate texture state in case the compositor altered it since the copy-on-write.
-            mailboxInfo->m_image->getTexture()->invalidateCachedState();
-            mailboxInfo->m_image.reset(0);
-            mailboxInfo->m_status = MailboxAvailable;
-        }
-    }
-    SkAutoTUnref<SkImage> image(m_canvas->newImageSnapshot());
+
+    RefPtr<SkImage> image = adoptRef(m_canvas->newImageSnapshot());
+
     // Early exit if canvas was not drawn to since last prepareMailbox
     if (image->uniqueID() == m_lastImageId)
         return false;
     m_lastImageId = image->uniqueID();
 
-    mailboxInfo = createMailboxInfo();
+    MailboxInfo* mailboxInfo = createMailboxInfo();
     mailboxInfo->m_status = MailboxInUse;
-    mailboxInfo->m_image.swap(&image);
+    mailboxInfo->m_image = image;
+
     // Because of texture sharing with the compositor, we must invalidate
     // the state cached in skia so that the deferred copy on write
     // in SkSurface_Gpu does not make any false assumptions.
     mailboxInfo->m_image->getTexture()->invalidateCachedState();
 
     ASSERT(mailboxInfo->m_mailbox.syncPoint == 0);
     ASSERT(mailboxInfo->m_image.get());
     ASSERT(mailboxInfo->m_image->getTexture());
 
     m_context->bindTexture(GL_TEXTURE_2D, mailboxInfo->m_image->getTexture()->getTextureHandle());
@@ skipping 36 matching lines @@
     // kMaxSwapBuffersPending+1 (in render_widget.h).
     // Because of crbug.com/247874, it needs to be kMaxSwapBuffersPending+2.
     // TODO(piman): fix this.
     ASSERT(m_mailboxes.size() <= 4);
     ASSERT(mailboxInfo < m_mailboxes.end());
     return mailboxInfo;
 }
 
 void Canvas2DLayerBridge::mailboxReleased(const blink::WebExternalTextureMailbox& mailbox)
 {
+    freeReleasedMailbox(); // Never have more than one mailbox in the released state.
     Vector<MailboxInfo>::iterator mailboxInfo;
     for (mailboxInfo = m_mailboxes.begin(); mailboxInfo < m_mailboxes.end(); mailboxInfo++) {
         if (!memcmp(mailboxInfo->m_mailbox.name, mailbox.name, sizeof(mailbox.name))) {
             mailboxInfo->m_mailbox.syncPoint = mailbox.syncPoint;
             ASSERT(mailboxInfo->m_status == MailboxInUse);
             mailboxInfo->m_status = MailboxReleased;
             // Trigger Canvas2DLayerBridge self-destruction if this is the
             // last live mailbox and the layer bridge is not externally
             // referenced.
             ASSERT(mailboxInfo->m_parentLayerBridge.get() == this);
             mailboxInfo->m_parentLayerBridge.clear();
+            m_releasedMailboxInfo = mailboxInfo;
+            m_framesSinceMailboxRelease = 0;
+            if (hidden()) {
+                freeReleasedMailbox();
+            } else {
+                Canvas2DLayerManager::get().setLayerHasFreeableResources(this);
+            }
             return;
         }
     }
 }
 
 blink::WebLayer* Canvas2DLayerBridge::layer() const
 {
     ASSERT(m_layer);
     return m_layer->layer();
 }
@@ skipping 15 matching lines @@
     m_context->flush();
     GrRenderTarget* renderTarget = m_canvas->getTopDevice()->accessRenderTarget();
     if (renderTarget) {
         return renderTarget->asTexture()->getTextureHandle();
     }
     return 0;
 }
 
 Canvas2DLayerBridge::MailboxInfo::MailboxInfo(const MailboxInfo& other) {
     // This copy constructor should only be used for Vector reallocation
-    // Assuming 'other' is to be destroyed, we swap m_image ownership
+    // Assuming 'other' is to be destroyed, we transfer m_image ownership
     // rather than do a refcount dance.
     memcpy(&m_mailbox, &other.m_mailbox, sizeof(m_mailbox));
-    m_image.swap(const_cast<SkAutoTUnref<SkImage>*>(&other.m_image));
+    m_image = const_cast<MailboxInfo*>(&other)->m_image.release();
     m_status = other.m_status;
 }
 
 }