Vulkan: Add plumbing to render pass when ImageHelper gets deleted

ImageHelper object is not refcounted and garbage collected and
endRenderPass call is deferred until next render pass starts. This
caused a situation that an ImageHelper object gets deleted while still
referenced in the open render pass. This CL make sure that we call into
all shared context's open renderpass when an image goes away so that
they can take appropriate action for this.

Bug: b/169618408
Change-Id: I5075e805980084db82ca3e699462272eee5d2d59
Reviewed-on: https://chromium-review.googlesource.com/c/angle/angle/+/2443571
Reviewed-by: Jamie Madill <jmadill@chromium.org>
Reviewed-by: Tim Van Patten <timvp@google.com>
Commit-Queue: Charlie Lao <cclao@google.com>

Author: cclao

src/libANGLE/renderer/vulkan/ContextVk.cpp

@@ -773,6 +773,9 @@ ContextVk::~ContextVk() = default;
 
 void ContextVk::onDestroy(const gl::Context *context)
 {
+    // Remove context from the share group
+    mShareGroupVk->getShareContextSet()->erase(this);
+
     // This will not destroy any resources. It will release them to be collected after finish.
     mIncompleteTextures.onDestroy(context);
 
@@ -974,6 +977,9 @@ angle::Result ContextVk::initialize()
     mStagingBuffer.init(mRenderer, kStagingBufferUsageFlags, stagingBufferAlignment,
                         kStagingBufferSize, true);
 
+    // Add context into the share group
+    mShareGroupVk->getShareContextSet()->insert(this);
+
     return angle::Result::Continue;
 }
 

src/libANGLE/renderer/vulkan/ContextVk.h

@@ -553,6 +553,14 @@ class ContextVk : public ContextImpl, public vk::Context
                                         vk::AliasingMode::Allowed, image);
     }
 
+    void onImageHelperRelease(const vk::ImageHelper *image)
+    {
+        if (mRenderPassCommands->started())
+        {
+            mRenderPassCommands->onImageHelperRelease(image);
+        }
+    }
+
     vk::CommandBuffer &getOutsideRenderPassCommandBuffer()
     {
         return mOutsideRenderPassCommands->getCommandBuffer();

src/libANGLE/renderer/vulkan/DisplayVk.h

@@ -19,6 +19,8 @@ namespace rx
 {
 class RendererVk;
 
+using ShareContextSet = std::set<ContextVk *>;
+
 class ShareGroupVk : public ShareGroupImpl
 {
   public:
@@ -30,13 +32,17 @@ class ShareGroupVk : public ShareGroupImpl
     // synchronous update to the caches.
     PipelineLayoutCache &getPipelineLayoutCache() { return mPipelineLayoutCache; }
     DescriptorSetLayoutCache &getDescriptorSetLayoutCache() { return mDescriptorSetLayoutCache; }
+    ShareContextSet *getShareContextSet() { return &mShareContextSet; }
 
   private:
     // ANGLE uses a PipelineLayout cache to store compatible pipeline layouts.
     PipelineLayoutCache mPipelineLayoutCache;
 
     // DescriptorSetLayouts are also managed in a cache.
     DescriptorSetLayoutCache mDescriptorSetLayoutCache;
+
+    // The list of contexts within the share group
+    ShareContextSet mShareContextSet;
 };
 
 class DisplayVk : public DisplayImpl, public vk::Context

src/libANGLE/renderer/vulkan/ImageVk.cpp

@@ -34,6 +34,8 @@ void ImageVk::onDestroy(const egl::Display *display)
 
     if (mImage != nullptr && mOwnsImage)
     {
+        // TODO: We need to handle the case that EGLImage used in two context that aren't shared.
+        // https://issuetracker.google.com/169868803
         mImage->releaseImage(renderer);
         mImage->releaseStagingBuffer(renderer);
         SafeDelete(mImage);

src/libANGLE/renderer/vulkan/OverlayVk.cpp

@@ -144,7 +144,7 @@ angle::Result OverlayVk::cullWidgets(ContextVk *contextVk)
     RendererVk *renderer = contextVk->getRenderer();
 
     // Release old culledWidgets image
-    mCulledWidgets.releaseImage(renderer);
+    mCulledWidgets.releaseImageFromShareContexts(renderer, contextVk);
     contextVk->addGarbage(&mCulledWidgetsView);
 
     // Create a buffer to contain coordinates of enabled text and graph widgets.  This buffer will

src/libANGLE/renderer/vulkan/RenderbufferVk.cpp

@@ -227,7 +227,7 @@ void RenderbufferVk::releaseImage(ContextVk *contextVk)
 
     if (mImage && mOwnsImage)
     {
-        mImage->releaseImage(renderer);
+        mImage->releaseImageFromShareContexts(renderer, contextVk);
         mImage->releaseStagingBuffer(renderer);
     }
     else
@@ -240,7 +240,7 @@ void RenderbufferVk::releaseImage(ContextVk *contextVk)
 
     if (mMultisampledImage.valid())
     {
-        mMultisampledImage.releaseImage(renderer);
+        mMultisampledImage.releaseImageFromShareContexts(renderer, contextVk);
     }
     mMultisampledImageViews.release(renderer);
 }

src/libANGLE/renderer/vulkan/SurfaceVk.cpp

@@ -227,6 +227,7 @@ void OffscreenSurfaceVk::AttachmentImage::destroy(const egl::Display *display)
 {
     DisplayVk *displayVk = vk::GetImpl(display);
     RendererVk *renderer = displayVk->getRenderer();
+    // Front end must ensure all usage has been submitted.
     image.releaseImage(renderer);
     image.releaseStagingBuffer(renderer);
     imageViews.release(renderer);
@@ -1065,14 +1066,14 @@ void WindowSurfaceVk::releaseSwapchainImages(ContextVk *contextVk)
 
     if (mDepthStencilImage.valid())
     {
-        mDepthStencilImage.releaseImage(renderer);
+        mDepthStencilImage.releaseImageFromShareContexts(renderer, contextVk);
         mDepthStencilImage.releaseStagingBuffer(renderer);
         mDepthStencilImageViews.release(renderer);
     }
 
     if (mColorImageMS.valid())
     {
-        mColorImageMS.releaseImage(renderer);
+        mColorImageMS.releaseImageFromShareContexts(renderer, contextVk);
         mColorImageMS.releaseStagingBuffer(renderer);
         mColorImageMSViews.release(renderer);
         contextVk->addGarbage(&mFramebufferMS);

src/libANGLE/renderer/vulkan/TextureVk.cpp

@@ -2382,7 +2382,7 @@ void TextureVk::releaseImage(ContextVk *contextVk)
     {
         if (mOwnsImage)
         {
-            mImage->releaseImage(renderer);
+            mImage->releaseImageFromShareContexts(renderer, contextVk);
         }
         else
         {
@@ -2395,7 +2395,7 @@ void TextureVk::releaseImage(ContextVk *contextVk)
     {
         if (image.valid())
         {
-            image.releaseImage(renderer);
+            image.releaseImageFromShareContexts(renderer, contextVk);
         }
     }
 

src/libANGLE/renderer/vulkan/android/HardwareBufferImageSiblingVkAndroid.cpp

@@ -313,6 +313,8 @@ void HardwareBufferImageSiblingVkAndroid::release(RendererVk *renderer)
 {
     if (mImage != nullptr)
     {
+        // TODO: We need to handle the case that EGLImage used in two context that aren't shared.
+        // https://issuetracker.google.com/169868803
         mImage->releaseImage(renderer);
         mImage->releaseStagingBuffer(renderer);
         SafeDelete(mImage);

src/libANGLE/renderer/vulkan/vk_helpers.cpp

@@ -872,6 +872,13 @@ void CommandBufferHelper::executeBarriers(ContextVk *contextVk, PrimaryCommandBu
     mPipelineBarrierMask.reset();
 }
 
+void CommandBufferHelper::onImageHelperRelease(const vk::ImageHelper *image)
+{
+    ASSERT(mIsRenderPassCommandBuffer);
+    // TODO: https://issuetracker.google.com/168953278 We will use this to finalize image layout
+    // transition
+}
+
 void CommandBufferHelper::beginRenderPass(const Framebuffer &framebuffer,
                                           const gl::Rectangle &renderArea,
                                           const RenderPassDesc &renderPassDesc,
@@ -3044,6 +3051,21 @@ void ImageHelper::releaseImage(RendererVk *renderer)
     mImageSerial = kInvalidImageSerial;
 }
 
+void ImageHelper::releaseImageFromShareContexts(RendererVk *renderer, ContextVk *contextVk)
+{
+    if (contextVk && mImageSerial.valid())
+    {
+        ShareContextSet &shareContextSet = *contextVk->getShareGroupVk()->getShareContextSet();
+        for (ContextVk *ctx : shareContextSet)
+        {
+            ctx->onImageHelperRelease(this);
+        }
+    }
+
+    renderer->collectGarbageAndReinit(&mUse, &mImage, &mDeviceMemory);
+    mImageSerial = kInvalidImageSerial;
+}
+
 void ImageHelper::releaseStagingBuffer(RendererVk *renderer)
 {
     // Remove updates that never made it to the texture.
@@ -5311,6 +5333,7 @@ void ImageHelper::SubresourceUpdate::release(RendererVk *renderer)
 {
     if (updateSource == UpdateSource::Image)
     {
+        // Staging images won't be used in render pass attachments.
         image.image->releaseImage(renderer);
         image.image->releaseStagingBuffer(renderer);
         SafeDelete(image.image);