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);
+}
+
 namespace WebCore {
 
-static PassRefPtr<SkSurface> createSkSurface(GraphicsContext3D* context3D, const IntSize& size, int msaaSampleCount)
+static PassRefPtr<SkSurface> createSkSurface(GraphicsContext3D* context3D, const IntSize& size, int msaaSampleCount = 0)
 {
     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;
@@ skipping 15 matching lines @@
 }
 
 Canvas2DLayerBridge::Canvas2DLayerBridge(PassRefPtr<GraphicsContext3D> context, PassOwnPtr<SkDeferredCanvas> canvas, int msaaSampleCount, OpacityMode opacityMode)
     : 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_isHidden(false)
     , m_next(0)
     , m_prev(0)
     , m_lastImageId(0)
+    , m_releasedMailboxInfo(0)
 {
     ASSERT(m_canvas);
     // 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;
+    freeTransientResources();
+    setIsHidden(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();
 }
 
+void Canvas2DLayerBridge::setIsHidden(bool hidden)
+{
+    bool newHiddenValue = hidden || m_destructionInProgress;
+    if (m_isHidden == newHiddenValue)
+        return;
+
+    m_isHidden = newHiddenValue;
+    if (isHidden()) {
+        freeTransientResources();
+    }
+}
+
+void Canvas2DLayerBridge::freeTransientResources()
+{
+    freeReleasedMailbox();
+    flush();
+    freeMemoryIfPossible(MaxSize);

[Stephen White, 2014/01/24 18:52:35]

Nit: Maybe there should just be a freeAllMemoryIfPossible() entry  point? or
freeAllMemory()? I see this problem goes all the way down to  SkBitmapHeap,
though.

Could we just do freeMemoryIfPossible(bytesAllocated()), if that's the same
thing?

+    ASSERT(!hasTransientResources());
+}
+
+bool Canvas2DLayerBridge::hasTransientResources() const
+{
+    return hasReleasedMailbox() || bytesAllocated();
+}
+
 void Canvas2DLayerBridge::limitPendingFrames()
 {
     ASSERT(!m_destructionInProgress);
+    if (isHidden()) {
+        freeTransientResources();
+        return;
+    }
     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();
         }
     }
+    ++m_framesSinceMailboxRelease;
+    if (releasedMailboxHasExpired()) {
+        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();
         }
         return;
     }
     context()->makeContextCurrent();
 }
 
 void Canvas2DLayerBridge::storageAllocatedForRecordingChanged(size_t bytesAllocated)
 {
-    ASSERT(!m_destructionInProgress);
     intptr_t delta = (intptr_t)bytesAllocated - (intptr_t)m_bytesAllocated;
     m_bytesAllocated = bytesAllocated;
-    Canvas2DLayerManager::get().layerAllocatedStorageChanged(this, delta);
+    Canvas2DLayerManager::get().layerTransientResourceAllocationChanged(this, delta);
 }
 
 size_t Canvas2DLayerBridge::storageAllocatedForRecording()
 {
-    ASSERT(!m_destructionInProgress);
     return m_canvas->storageAllocatedForRecording();
 }
 
 void Canvas2DLayerBridge::flushedDrawCommands()
 {
-    ASSERT(!m_destructionInProgress);
     storageAllocatedForRecordingChanged(storageAllocatedForRecording());
     m_framesPending = 0;
 }
 
 void Canvas2DLayerBridge::skippedPendingDrawCommands()
 {
-    ASSERT(!m_destructionInProgress);
     // Stop triggering the rate limiter if SkDeferredCanvas is detecting
     // and optimizing overdraw.
     setRateLimitingEnabled(false);
     flushedDrawCommands();
 }
 
 void Canvas2DLayerBridge::setRateLimitingEnabled(bool enabled)
 {
     ASSERT(!m_destructionInProgress || !enabled);
     if (m_rateLimitingEnabled != enabled) {
         m_rateLimitingEnabled = enabled;
         m_layer->setRateLimitContext(m_rateLimitingEnabled);
     }
 }
 
 size_t Canvas2DLayerBridge::freeMemoryIfPossible(size_t bytesToFree)
 {
-    ASSERT(!m_destructionInProgress);
     size_t bytesFreed = m_canvas->freeMemoryIfPossible(bytesToFree);
+    m_bytesAllocated -= bytesFreed;
     if (bytesFreed)
-        Canvas2DLayerManager::get().layerAllocatedStorageChanged(this, -((intptr_t)bytesFreed));
-    m_bytesAllocated -= bytesFreed;
+        Canvas2DLayerManager::get().layerTransientResourceAllocationChanged(this, -((intptr_t)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();
     }
 }
 
+bool Canvas2DLayerBridge::releasedMailboxHasExpired()
+{
+    return m_releasedMailboxInfo && m_framesSinceMailboxRelease > 2;

[Stephen White, 2014/01/24 18:52:35]

A comment to explain this heuristic might be useful here.

+}
+
+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.
+        if (m_releasedMailboxInfo->m_image) {
+            if (isHidden() || releasedMailboxHasExpired())
+                m_releasedMailboxInfo->m_image->getTexture()->resetFlag(static_cast<GrTextureFlags>(GrTexture::kReturnToCache_FlagBit));
+            m_releasedMailboxInfo->m_image->getTexture()->invalidateCachedState();
+            m_releasedMailboxInfo->m_image.clear();
+        }
+        m_releasedMailboxInfo->m_status = MailboxAvailable;
+        m_releasedMailboxInfo = 0;
+        Canvas2DLayerManager::get().layerTransientResourceAllocationChanged(this);
+    }
+}
+
 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 42 matching lines @@
     if (!isValid())
         return false;
 
     blink::WebGraphicsContext3D* webContext = context();
 
     // 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.
     webContext->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) {
-                webContext->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());
 
     webContext->bindTexture(GL_TEXTURE_2D, mailboxInfo->m_image->getTexture()->getTextureHandle());
     webContext->texParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
     webContext->texParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
     webContext->texParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE);
     webContext->texParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE);
     webContext->produceTextureCHROMIUM(GL_TEXTURE_2D, mailboxInfo->m_mailbox.name);
-    webContext->flush();
-    mailboxInfo->m_mailbox.syncPoint = webContext->insertSyncPoint();
+    if (!isHidden()) {
+        // With hidden canvases, we release the SkImage immediately because

[Stephen White, 2014/01/24 18:52:35]

I don't understand this comment. This seems to be the !isHidden() case?

[Justin Novosad, 2014/01/27 18:43:26]

Holy s***. This is a major bug. Thanks for spotting it.  The condition is
inverted which inserts a race condition, and fails to fix unwanted
double-buffering under certain conditions.  I fixed this locally, and GPU memory
consumption is even better now!

+        // there is no need for animations to be double buffered.
+        mailboxInfo->m_image.clear();
+    } else {
+        webContext->flush();
+        mailboxInfo->m_mailbox.syncPoint = webContext->insertSyncPoint();
+    }
     webContext->bindTexture(GL_TEXTURE_2D, 0);
     // Because we are changing the texture binding without going through skia,
     // we must dirty the context.
     m_context->grContext()->resetContext(kTextureBinding_GrGLBackendState);
 
     // set m_parentLayerBridge to make sure 'this' stays alive as long as it has
     // live mailboxes
     ASSERT(!mailboxInfo->m_parentLayerBridge);
     mailboxInfo->m_parentLayerBridge = this;
     *outMailbox = mailboxInfo->m_mailbox;
@@ skipping 19 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.
+            m_releasedMailboxInfo = mailboxInfo;
+            m_framesSinceMailboxRelease = 0;
+            if (isHidden()) {
+                freeReleasedMailbox();
+            } else {
+                ASSERT(!m_destructionInProgress);
+                Canvas2DLayerManager::get().layerTransientResourceAllocationChanged(this);
+            }
             ASSERT(mailboxInfo->m_parentLayerBridge.get() == this);
             mailboxInfo->m_parentLayerBridge.clear();
             return;
         }
     }
 }
 
 blink::WebLayer* Canvas2DLayerBridge::layer() const
 {
     ASSERT(m_layer);
@@ skipping 17 matching lines @@
     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;
 }
 
 }