1 //
2 // Copyright 2016 The ANGLE Project Authors. All rights reserved.
3 // Use of this source code is governed by a BSD-style license that can be
4 // found in the LICENSE file.
5 //
6 // ImageVk.cpp:
7 //    Implements the class methods for ImageVk.
8 //
9 
10 #include "libANGLE/renderer/vulkan/ImageVk.h"
11 
12 #include "common/debug.h"
13 #include "libANGLE/Context.h"
14 #include "libANGLE/Display.h"
15 #include "libANGLE/renderer/vulkan/ContextVk.h"
16 #include "libANGLE/renderer/vulkan/DisplayVk.h"
17 #include "libANGLE/renderer/vulkan/RenderbufferVk.h"
18 #include "libANGLE/renderer/vulkan/TextureVk.h"
19 #include "libANGLE/renderer/vulkan/vk_utils.h"
20 
21 namespace rx
22 {
23 
ImageVk(const egl::ImageState & state,const gl::Context * context)24 ImageVk::ImageVk(const egl::ImageState &state, const gl::Context *context)
25     : ImageImpl(state), mImageLevel(0), mOwnsImage(false), mImage(nullptr), mContext(context)
26 {}
27 
~ImageVk()28 ImageVk::~ImageVk() {}
29 
onDestroy(const egl::Display * display)30 void ImageVk::onDestroy(const egl::Display *display)
31 {
32     DisplayVk *displayVk = vk::GetImpl(display);
33     RendererVk *renderer = displayVk->getRenderer();
34 
35     if (mImage != nullptr && mOwnsImage)
36     {
37         // TODO: We need to handle the case that EGLImage used in two context that aren't shared.
38         // https://issuetracker.google.com/169868803
39         mImage->releaseImage(renderer);
40         mImage->releaseStagingBuffer(renderer);
41         SafeDelete(mImage);
42     }
43     else if (egl::IsExternalImageTarget(mState.target))
44     {
45         ASSERT(mState.source != nullptr);
46         ExternalImageSiblingVk *externalImageSibling =
47             GetImplAs<ExternalImageSiblingVk>(GetAs<egl::ExternalImageSibling>(mState.source));
48         externalImageSibling->release(renderer);
49         mImage = nullptr;
50 
51         // This is called as a special case where resources may be allocated by the caller, without
52         // the caller ever issuing a draw command to free them. Specifically, SurfaceFlinger
53         // optimistically allocates EGLImages that it may never draw to.
54         renderer->cleanupCompletedCommandsGarbage();
55     }
56 }
57 
initialize(const egl::Display * display)58 egl::Error ImageVk::initialize(const egl::Display *display)
59 {
60     if (egl::IsTextureTarget(mState.target))
61     {
62         TextureVk *textureVk = GetImplAs<TextureVk>(GetAs<gl::Texture>(mState.source));
63 
64         // Make sure the texture has created its backing storage
65         ASSERT(mContext != nullptr);
66         ContextVk *contextVk = vk::GetImpl(mContext);
67         ANGLE_TRY(ResultToEGL(
68             textureVk->ensureImageInitialized(contextVk, ImageMipLevels::EnabledLevels)));
69 
70         mImage = &textureVk->getImage();
71 
72         // The staging buffer for a texture source should already be initialized
73 
74         mOwnsImage = false;
75 
76         mImageTextureType = mState.imageIndex.getType();
77         mImageLevel       = gl::LevelIndex(mState.imageIndex.getLevelIndex());
78         mImageLayer       = mState.imageIndex.hasLayer() ? mState.imageIndex.getLayerIndex() : 0;
79     }
80     else
81     {
82         RendererVk *renderer = nullptr;
83         if (egl::IsRenderbufferTarget(mState.target))
84         {
85             RenderbufferVk *renderbufferVk =
86                 GetImplAs<RenderbufferVk>(GetAs<gl::Renderbuffer>(mState.source));
87             mImage = renderbufferVk->getImage();
88 
89             ASSERT(mContext != nullptr);
90             renderer = vk::GetImpl(mContext)->getRenderer();
91         }
92         else if (egl::IsExternalImageTarget(mState.target))
93         {
94             const ExternalImageSiblingVk *externalImageSibling =
95                 GetImplAs<ExternalImageSiblingVk>(GetAs<egl::ExternalImageSibling>(mState.source));
96             mImage = externalImageSibling->getImage();
97 
98             ASSERT(mContext == nullptr);
99             renderer = vk::GetImpl(display)->getRenderer();
100         }
101         else
102         {
103             UNREACHABLE();
104             return egl::EglBadAccess();
105         }
106 
107         // start with some reasonable alignment that's safe for the case where intendedFormatID is
108         // FormatID::NONE
109         size_t alignment = mImage->getFormat().getValidImageCopyBufferAlignment();
110 
111         // Make sure a staging buffer is ready to use to upload data
112         mImage->initStagingBuffer(renderer, alignment, vk::kStagingBufferFlags,
113                                   vk::kStagingBufferSize);
114 
115         mOwnsImage = false;
116 
117         mImageTextureType = gl::TextureType::_2D;
118         mImageLevel       = gl::LevelIndex(0);
119         mImageLayer       = 0;
120     }
121 
122     // mContext is no longer needed, make sure it's not used by accident.
123     mContext = nullptr;
124 
125     return egl::NoError();
126 }
127 
orphan(const gl::Context * context,egl::ImageSibling * sibling)128 angle::Result ImageVk::orphan(const gl::Context *context, egl::ImageSibling *sibling)
129 {
130     if (sibling == mState.source)
131     {
132         if (egl::IsTextureTarget(mState.target))
133         {
134             TextureVk *textureVk = GetImplAs<TextureVk>(GetAs<gl::Texture>(mState.source));
135             ASSERT(mImage == &textureVk->getImage());
136             textureVk->releaseOwnershipOfImage(context);
137             mOwnsImage = true;
138         }
139         else if (egl::IsRenderbufferTarget(mState.target))
140         {
141             RenderbufferVk *renderbufferVk =
142                 GetImplAs<RenderbufferVk>(GetAs<gl::Renderbuffer>(mState.source));
143             ASSERT(mImage == renderbufferVk->getImage());
144             renderbufferVk->releaseOwnershipOfImage(context);
145             mOwnsImage = true;
146         }
147         else
148         {
149             ANGLE_VK_UNREACHABLE(vk::GetImpl(context));
150             return angle::Result::Stop;
151         }
152     }
153 
154     // Grab a fence from the releasing context to know when the image is no longer used
155     ASSERT(context != nullptr);
156     ContextVk *contextVk = vk::GetImpl(context);
157 
158     // Flush the context to make sure the fence has been submitted.
159     ANGLE_TRY(contextVk->flushImpl(nullptr));
160 
161     return angle::Result::Continue;
162 }
163 
164 }  // namespace rx
165