WebGL: Don't destroy mailbox textures in the destructor until they're released.

Source/platform/graphics/gpu/DrawingBuffer.cpp

 /*
  * Copyright (c) 2010, 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:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 24 matching lines @@
 #include <algorithm>
 #include "platform/TraceEvent.h"
 #include "platform/graphics/GraphicsLayer.h"
 #include "platform/graphics/gpu/Extensions3DUtil.h"
 #include "public/platform/Platform.h"
 #include "public/platform/WebCompositorSupport.h"
 #include "public/platform/WebExternalBitmap.h"
 #include "public/platform/WebExternalTextureLayer.h"
 #include "public/platform/WebGraphicsContext3D.h"
 #include "public/platform/WebGraphicsContext3DProvider.h"
+#ifndef NDEBUG
+#include "wtf/RefCountedLeakCounter.h"
+#endif
 
 using namespace std;
 
 namespace WebCore {
 
+namespace {
 // Global resource ceiling (expressed in terms of pixels) for DrawingBuffer creation and resize.
 // When this limit is set, DrawingBuffer::create() and DrawingBuffer::reset() calls that would
 // exceed the global cap will instead clear the buffer.
-static const int s_maximumResourceUsePixels = 16 * 1024 * 1024;
-static int s_currentResourceUsePixels = 0;
-static const float s_resourceAdjustedRatio = 0.5;
+const int s_maximumResourceUsePixels = 16 * 1024 * 1024;
+int s_currentResourceUsePixels = 0;
+const float s_resourceAdjustedRatio = 0.5;
 
-static const bool s_allowContextEvictionOnCreate = true;
-static const int s_maxScaleAttempts = 3;
+const bool s_allowContextEvictionOnCreate = true;
+const int s_maxScaleAttempts = 3;
+
+DEFINE_DEBUG_ONLY_GLOBAL(WTF::RefCountedLeakCounter, drawingBufferCounter, ("DrawingBuffer"));
 
 class ScopedTextureUnit0BindingRestorer {
 public:
     ScopedTextureUnit0BindingRestorer(blink::WebGraphicsContext3D* context, GLenum activeTextureUnit, Platform3DObject textureUnitZeroId)
         : m_context(context)
         , m_oldActiveTextureUnit(activeTextureUnit)
         , m_oldTextureUnitZeroId(textureUnitZeroId)
     {
         m_context->activeTexture(GL_TEXTURE0);
     }
     ~ScopedTextureUnit0BindingRestorer()
     {
         m_context->bindTexture(GL_TEXTURE_2D, m_oldTextureUnitZeroId);
         m_context->activeTexture(m_oldActiveTextureUnit);
     }
 
 private:
     blink::WebGraphicsContext3D* m_context;
     GLenum m_oldActiveTextureUnit;
     Platform3DObject m_oldTextureUnitZeroId;
 };
+} // namespace
 
 PassRefPtr<DrawingBuffer> DrawingBuffer::create(PassOwnPtr<blink::WebGraphicsContext3D> context, const IntSize& size, PreserveDrawingBuffer preserve, PassRefPtr<ContextEvictionManager> contextEvictionManager)
 {
     ASSERT(context);
     Extensions3DUtil extensionsUtil(context.get());
     bool multisampleSupported = extensionsUtil.supportsExtension("GL_CHROMIUM_framebuffer_multisample")
         && extensionsUtil.supportsExtension("GL_OES_rgb8_rgba8");
     if (multisampleSupported) {
         extensionsUtil.ensureExtensionEnabled("GL_CHROMIUM_framebuffer_multisample");
         extensionsUtil.ensureExtensionEnabled("GL_OES_rgb8_rgba8");
     }
     bool packedDepthStencilSupported = extensionsUtil.supportsExtension("GL_OES_packed_depth_stencil");
     if (packedDepthStencilSupported)
         extensionsUtil.ensureExtensionEnabled("GL_OES_packed_depth_stencil");
 
     RefPtr<DrawingBuffer> drawingBuffer = adoptRef(new DrawingBuffer(context, multisampleSupported, packedDepthStencilSupported, preserve, contextEvictionManager));
-    if (!drawingBuffer->initialize(size))
+    if (!drawingBuffer->initialize(size)) {
+        drawingBuffer->beginDestruction();
         return PassRefPtr<DrawingBuffer>();
+    }
     return drawingBuffer.release();
 }
 
 DrawingBuffer::DrawingBuffer(PassOwnPtr<blink::WebGraphicsContext3D> context,
     bool multisampleExtensionSupported,
     bool packedDepthStencilExtensionSupported,
     PreserveDrawingBuffer preserve,
     PassRefPtr<ContextEvictionManager> contextEvictionManager)
     : m_preserveDrawingBuffer(preserve)
     , m_scissorEnabled(false)
@@ skipping 15 matching lines @@
     , m_contentsChanged(true)
     , m_contentsChangeCommitted(false)
     , m_layerComposited(false)
     , m_multisampleMode(None)
     , m_internalColorFormat(0)
     , m_colorFormat(0)
     , m_internalRenderbufferFormat(0)
     , m_maxTextureSize(0)
     , m_sampleCount(0)
     , m_packAlignment(4)
+    , m_destructionInProgress(false)
     , m_contextEvictionManager(contextEvictionManager)
 {
     // Used by browser tests to detect the use of a DrawingBuffer.
     TRACE_EVENT_INSTANT0("test_gpu", "DrawingBufferCreation");
+#ifndef NDEBUG
+    drawingBufferCounter.increment();
+#endif
 }
 
 DrawingBuffer::~DrawingBuffer()
 {
-    releaseResources();
+    ASSERT(m_destructionInProgress);
+    ASSERT(m_textureMailboxes.isEmpty());
+    m_context.clear();
+    m_layer.clear();
+#ifndef NDEBUG
+    drawingBufferCounter.decrement();
+#endif
 }
 
 void DrawingBuffer::markContentsChanged()
 {
     m_contentsChanged = true;
     m_contentsChangeCommitted = false;
     m_layerComposited = false;
 }
 
 bool DrawingBuffer::layerComposited() const
 {
     return m_layerComposited;
 }
 
 void DrawingBuffer::markLayerComposited()
 {
     m_layerComposited = true;
 }
 
 blink::WebGraphicsContext3D* DrawingBuffer::context()
 {
     return m_context.get();
 }
 
 bool DrawingBuffer::prepareMailbox(blink::WebExternalTextureMailbox* outMailbox, blink::WebExternalBitmap* bitmap)
 {
+    // prepareMailbox() is always called after layout.
+    ASSERT(!m_destructionInProgress);
+
     if (!m_contentsChanged)
         return false;
 
     m_context->makeContextCurrent();
 
     // Resolve the multisampled buffer into m_colorBuffer texture.
     if (m_multisampleMode != None)
         commit();
 
     if (bitmap) {
@@ skipping 44 matching lines @@
         restoreFramebufferBinding();
 
     m_contentsChanged = false;
 
     m_context->bindTexture(GL_TEXTURE_2D, frontColorBufferMailbox->textureId);
     m_context->produceTextureCHROMIUM(GL_TEXTURE_2D, frontColorBufferMailbox->mailbox.name);
     m_context->flush();
     frontColorBufferMailbox->mailbox.syncPoint = m_context->insertSyncPoint();
     markLayerComposited();
 
+    // set m_parentDrawingBuffer to make sure 'this' stays alive as long as it has live mailboxes
+    ASSERT(!frontColorBufferMailbox->m_parentDrawingBuffer);
+    frontColorBufferMailbox->m_parentDrawingBuffer = this;
     *outMailbox = frontColorBufferMailbox->mailbox;
     m_frontColorBuffer = frontColorBufferMailbox->textureId;
     return true;
 }
 
 void DrawingBuffer::mailboxReleased(const blink::WebExternalTextureMailbox& mailbox)
 {
+    if (m_destructionInProgress) {
+        mailboxReleasedInDestructionInProgress(mailbox);
+        return;
+    }
+
     for (size_t i = 0; i < m_textureMailboxes.size(); i++) {
         RefPtr<MailboxInfo> mailboxInfo = m_textureMailboxes[i];
         if (!memcmp(mailboxInfo->mailbox.name, mailbox.name, sizeof(mailbox.name))) {
             mailboxInfo->mailbox.syncPoint = mailbox.syncPoint;
+            ASSERT(mailboxInfo->m_parentDrawingBuffer.get() == this);
+            mailboxInfo->m_parentDrawingBuffer.clear();
             m_recycledMailboxes.prepend(mailboxInfo.release());
             return;
         }
     }
     ASSERT_NOT_REACHED();
 }
 
+void DrawingBuffer::mailboxReleasedInDestructionInProgress(const blink::WebExternalTextureMailbox& mailbox)
+{
+    ASSERT(!m_textureMailboxes.isEmpty());
+    for (size_t i = 0; i < m_textureMailboxes.size(); i++) {
+        RefPtr<MailboxInfo> mailboxInfo = m_textureMailboxes[i];
+        if (!memcmp(mailboxInfo->mailbox.name, mailbox.name, sizeof(mailboxInfo->mailbox.name))) {
+            m_context->makeContextCurrent();
+            m_context->deleteTexture(mailboxInfo->textureId);
+            m_textureMailboxes.remove(i);
+            ASSERT(mailboxInfo->m_parentDrawingBuffer.get() == this);
+            mailboxInfo->m_parentDrawingBuffer.clear();
+            return;
+        }
+    }
+    ASSERT_NOT_REACHED();
+}
+
 PassRefPtr<DrawingBuffer::MailboxInfo> DrawingBuffer::recycledMailbox()
 {
     if (m_recycledMailboxes.isEmpty())
         return PassRefPtr<MailboxInfo>();
 
     RefPtr<MailboxInfo> mailboxInfo = m_recycledMailboxes.last().release();
     m_recycledMailboxes.removeLast();
 
     if (mailboxInfo->mailbox.syncPoint) {
         m_context->waitSyncPoint(mailboxInfo->mailbox.syncPoint);
@@ skipping 206 matching lines @@
 }
 
 void DrawingBuffer::clearPlatformLayer()
 {
     if (m_layer)
         m_layer->clearTexture();
 
     m_context->flush();
 }
 
-void DrawingBuffer::releaseResources()
+void DrawingBuffer::beginDestruction()
 {
+    ASSERT(!m_destructionInProgress);
+    m_destructionInProgress = true;
+
     m_context->makeContextCurrent();
 
     clearPlatformLayer();
 
-    for (size_t i = 0; i < m_textureMailboxes.size(); i++)
-        m_context->deleteTexture(m_textureMailboxes[i]->textureId);
+    for (size_t i = 0; i < m_recycledMailboxes.size(); i++) {
+        m_context->deleteTexture(m_recycledMailboxes[i]->textureId);
+
+        for (size_t j = 0; j < m_textureMailboxes.size(); j++) {
+            RefPtr<MailboxInfo> mailboxInfo = m_textureMailboxes[j];
+            if (mailboxInfo->textureId == m_recycledMailboxes[i]->textureId) {
+                ASSERT(!memcmp(mailboxInfo->mailbox.name, m_recycledMailboxes[i]->mailbox.name, sizeof(mailboxInfo->mailbox.name)));
+                m_textureMailboxes.remove(j);

[Justin Novosad, 2014/04/09 15:34:35]

I think this is unnecessary complexity. Wouldn't it be sufficient to just have
m_textureMailboxes.clear() in the destructor?  Deleting just the textures as
they are released is good enough IMHO. You could remove the entire inner for
loop here, and avoid O(N^2)

[dshwang, 2014/04/09 18:05:50]

Thank you for review.

As you mentioned, "nested for" is not actually needed. I did it to clarify code
flow.
For example,
1. if m_textureMailboxes.isEmpty(), this method deletes m_context and m_layer
although the destructor can delete them.
2. the destructor ensures ASSERT(m_textureMailboxes.isEmpty());

m_textureMailboxes.size() is usually 3 and m_recycledMailboxes.size() is 1 or 2.
So I think 6 loop is not very heavy.

[Ken Russell (switch to Gerrit), 2014/04/15 02:24:02]

I think keeping this code is a good idea only to enable the assertion in the
destructor. Otherwise the state management of the m_parentDrawingBuffer pointer
in the m_recycledMailboxes and m_textureMailboxes vectors, especially while
destruction is in progress, is really confusing.

+                break;
+            }
+        }
+    }
 
     if (m_multisampleFBO)
         m_context->deleteFramebuffer(m_multisampleFBO);
 
     if (m_fbo)
         m_context->deleteFramebuffer(m_fbo);
 
     if (m_multisampleColorBuffer)
         m_context->deleteRenderbuffer(m_multisampleColorBuffer);
 
     if (m_depthStencilBuffer)
         m_context->deleteRenderbuffer(m_depthStencilBuffer);
 
     if (m_depthBuffer)
         m_context->deleteRenderbuffer(m_depthBuffer);
 
     if (m_stencilBuffer)
         m_context->deleteRenderbuffer(m_stencilBuffer);
 
     if (m_colorBuffer)
         m_context->deleteTexture(m_colorBuffer);
 
-    m_context.clear();
-
     setSize(IntSize());
 
     m_colorBuffer = 0;
     m_frontColorBuffer = 0;
     m_multisampleColorBuffer = 0;
     m_depthStencilBuffer = 0;
     m_depthBuffer = 0;
     m_stencilBuffer = 0;
     m_multisampleFBO = 0;
     m_fbo = 0;
     m_contextEvictionManager.clear();
 
     m_recycledMailboxes.clear();
-    m_textureMailboxes.clear();
 
-    if (m_layer) {
+    if (m_layer)
         GraphicsLayer::unregisterContentsLayer(m_layer->layer());
+
+    if (m_textureMailboxes.isEmpty()) {
+        m_context.clear();
         m_layer.clear();

[Ken Russell (switch to Gerrit), 2014/04/15 02:24:02]

This eager clearing of m_context and m_layer adds complexity. It isn't done in
releaseMailbox, above. Please remove this block and let the destructor take care
of clearing out the context and layer.

     }
 }
 
 unsigned DrawingBuffer::createColorTexture(const IntSize& size)
 {
     unsigned offscreenColorTexture = m_context->createTexture();
     if (!offscreenColorTexture)
         return 0;
 
     m_context->bindTexture(GL_TEXTURE_2D, offscreenColorTexture);
@@ skipping 393 matching lines @@
     }
 }
 
 void DrawingBuffer::texImage2DResourceSafe(GLenum target, GLint level, GLenum internalformat, GLsizei width, GLsizei height, GLint border, GLenum format, GLenum type, GLint unpackAlignment)
 {
     ASSERT(unpackAlignment == 1 || unpackAlignment == 2 || unpackAlignment == 4 || unpackAlignment == 8);
     m_context->texImage2D(target, level, internalformat, width, height, border, format, type, 0);
 }
 
 } // namespace WebCore