Add GrBackendMutableState object to handle shared texture state.

This is will be the main struct used to synchronize changes of certain
texture/image between clients and Skia. With this change we
implement support for the Vulkan shared state as POC.

Bug: skia:10254
Change-Id: I10543357635c347838b193874e4da4496a0dcf06
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/292311
Commit-Queue: Greg Daniel <[email protected]>
Reviewed-by: Brian Salomon <[email protected]>

Author: egdaniel

gn/gpu.gni

@@ -11,6 +11,7 @@ skia_gpu_sources = [
   "$_include/gpu/GrBackendDrawableInfo.h",
   "$_include/gpu/GrBackendSemaphore.h",
   "$_include/gpu/GrBackendSurface.h",
+  "$_include/gpu/GrBackendSurfaceMutableState.h",
   "$_include/gpu/GrConfig.h",
   "$_include/gpu/GrContext.h",
   "$_include/gpu/GrContextOptions.h",
@@ -35,6 +36,7 @@ skia_gpu_sources = [
   "$_src/gpu/GrAuditTrail.h",
   "$_src/gpu/GrAutoLocaleSetter.h",
   "$_src/gpu/GrBackendSurface.cpp",
+  "$_src/gpu/GrBackendSurfaceMutableStateImpl.h",
   "$_src/gpu/GrBackendTextureImageGenerator.cpp",
   "$_src/gpu/GrBackendTextureImageGenerator.h",
   "$_src/gpu/GrBaseContextPriv.h",

gn/tests.gni

@@ -17,6 +17,7 @@ tests_sources = [
   "$_tests/AsADashTest.cpp",
   "$_tests/BRDTest.cpp",
   "$_tests/BackendAllocationTest.cpp",
+  "$_tests/BackendSurfaceMutableStateTest.cpp",
   "$_tests/BadIcoTest.cpp",
   "$_tests/BitSetTest.cpp",
   "$_tests/BitmapCopyTest.cpp",

include/gpu/GrBackendSurface.h

@@ -8,6 +8,7 @@
 #ifndef GrBackendSurface_DEFINED
 #define GrBackendSurface_DEFINED
 
+#include "include/gpu/GrBackendSurfaceMutableState.h"
 #include "include/gpu/GrTypes.h"
 #include "include/gpu/gl/GrGLTypes.h"
 #include "include/gpu/mock/GrMockTypes.h"
@@ -19,6 +20,7 @@
 #include "include/gpu/dawn/GrDawnTypes.h"
 #endif
 
+class GrBackendSurfaceMutableStateImpl;
 class GrVkImageLayout;
 class GrGLTextureParameters;
 
@@ -224,17 +226,19 @@ class SK_API GrBackendFormat {
 class SK_API GrBackendTexture {
 public:
     // Creates an invalid backend texture.
-    GrBackendTexture() : fIsValid(false) {}
+    GrBackendTexture();
 
     // The GrGLTextureInfo must have a valid fFormat.
     GrBackendTexture(int width,
                      int height,
                      GrMipMapped,
                      const GrGLTextureInfo& glInfo);
 
+#ifdef SK_VULKAN
     GrBackendTexture(int width,
                      int height,
                      const GrVkImageInfo& vkInfo);
+#endif
 
 #ifdef SK_METAL
     GrBackendTexture(int width,
@@ -286,6 +290,7 @@ class SK_API GrBackendTexture {
     bool getDawnTextureInfo(GrDawnTextureInfo*) const;
 #endif
 
+#ifdef SK_VULKAN
     // If the backend API is Vulkan, copies a snapshot of the GrVkImageInfo struct into the passed
     // in pointer and returns true. This snapshot will set the fImageLayout to the current layout
     // state. Otherwise returns false if the backend API is not Vulkan.
@@ -294,6 +299,7 @@ class SK_API GrBackendTexture {
     // Anytime the client changes the VkImageLayout of the VkImage captured by this
     // GrBackendTexture, they must call this function to notify Skia of the changed layout.
     void setVkImageLayout(VkImageLayout);
+#endif
 
 #ifdef SK_METAL
     // If the backend API is Metal, copies a snapshot of the GrMtlTextureInfo struct into the passed
@@ -319,6 +325,13 @@ class SK_API GrBackendTexture {
     // in pointer and returns true. Otherwise returns false if the backend API is not Mock.
     bool getMockTextureInfo(GrMockTextureInfo*) const;
 
+    // If the client changes any of the mutable backend of the GrBackendTexture they should call
+    // this function to inform Skia that those values have changed. The backend API specific state
+    // that can be set from this function are:
+    //
+    // Vulkan: VkImageLayout and QueueFamilyIndex
+    void setMutableState(const GrBackendSurfaceMutableState&);
+
     // Returns true if we are working with protected content.
     bool isProtected() const;
 
@@ -333,6 +346,8 @@ class SK_API GrBackendTexture {
 #endif
 
 private:
+    friend class GrVkGpu;  // for getMutableState
+    sk_sp<GrBackendSurfaceMutableStateImpl> getMutableState() const;
 
 #ifdef SK_GL
     friend class GrGLTexture;
@@ -347,12 +362,10 @@ class SK_API GrBackendTexture {
 
 #ifdef SK_VULKAN
     friend class GrVkTexture;
-    friend class GrVkGpu;    // for getGrVkImageLayout
     GrBackendTexture(int width,
                      int height,
                      const GrVkImageInfo& vkInfo,
-                     sk_sp<GrVkImageLayout> layout);
-    sk_sp<GrVkImageLayout> getGrVkImageLayout() const;
+                     sk_sp<GrBackendSurfaceMutableStateImpl> mutableState);
 #endif
 
 #ifdef SK_DIRECT3D
@@ -390,12 +403,14 @@ class SK_API GrBackendTexture {
 #ifdef SK_DAWN
     GrDawnTextureInfo fDawnInfo;
 #endif
+
+    sk_sp<GrBackendSurfaceMutableStateImpl> fMutableState;
 };
 
 class SK_API GrBackendRenderTarget {
 public:
     // Creates an invalid backend texture.
-    GrBackendRenderTarget() : fIsValid(false) {}
+    GrBackendRenderTarget();
 
     // The GrGLTextureInfo must have a valid fFormat.
     GrBackendRenderTarget(int width,
@@ -412,13 +427,15 @@ class SK_API GrBackendRenderTarget {
                           const GrDawnRenderTargetInfo& dawnInfo);
 #endif
 
+#ifdef SK_VULKAN
     /** Deprecated, use version that does not take stencil bits. */
     GrBackendRenderTarget(int width,
                           int height,
                           int sampleCnt,
                           int stencilBits,
                           const GrVkImageInfo& vkInfo);
     GrBackendRenderTarget(int width, int height, int sampleCnt, const GrVkImageInfo& vkInfo);
+#endif
 
 #ifdef SK_METAL
     GrBackendRenderTarget(int width,
@@ -463,6 +480,7 @@ class SK_API GrBackendRenderTarget {
     bool getDawnRenderTargetInfo(GrDawnRenderTargetInfo*) const;
 #endif
 
+#ifdef SK_VULKAN
     // If the backend API is Vulkan, copies a snapshot of the GrVkImageInfo struct into the passed
     // in pointer and returns true. This snapshot will set the fImageLayout to the current layout
     // state. Otherwise returns false if the backend API is not Vulkan.
@@ -471,6 +489,7 @@ class SK_API GrBackendRenderTarget {
     // Anytime the client changes the VkImageLayout of the VkImage captured by this
     // GrBackendRenderTarget, they must call this function to notify Skia of the changed layout.
     void setVkImageLayout(VkImageLayout);
+#endif
 
 #ifdef SK_METAL
     // If the backend API is Metal, copies a snapshot of the GrMtlTextureInfo struct into the passed
@@ -495,6 +514,13 @@ class SK_API GrBackendRenderTarget {
     // in pointer and returns true. Otherwise returns false if the backend API is not Mock.
     bool getMockRenderTargetInfo(GrMockRenderTargetInfo*) const;
 
+    // If the client changes any of the mutable backend of the GrBackendTexture they should call
+    // this function to inform Skia that those values have changed. The backend API specific state
+    // that can be set from this function are:
+    //
+    // Vulkan: VkImageLayout and QueueFamilyIndex
+    void setMutableState(const GrBackendSurfaceMutableState&);
+
     // Returns true if we are working with protected content.
     bool isProtected() const;
 
@@ -507,12 +533,15 @@ class SK_API GrBackendRenderTarget {
 #endif
 
 private:
-    friend class GrVkGpu; // for getGrVkImageLayout
-    sk_sp<GrVkImageLayout> getGrVkImageLayout() const;
+    friend class GrVkGpu; // for getMutableState
+    sk_sp<GrBackendSurfaceMutableStateImpl> getMutableState() const;
 
+#ifdef SK_VULKAN
     friend class GrVkRenderTarget;
     GrBackendRenderTarget(int width, int height, int sampleCnt, const GrVkImageInfo& vkInfo,
-                          sk_sp<GrVkImageLayout> layout);
+                          sk_sp<GrBackendSurfaceMutableStateImpl> mutableState);
+#endif
+
 #ifdef SK_DIRECT3D
     friend class GrD3DGpu;
     friend class GrD3DRenderTarget;
@@ -550,6 +579,7 @@ class SK_API GrBackendRenderTarget {
 #ifdef SK_DAWN
     GrDawnRenderTargetInfo  fDawnInfo;
 #endif
+    sk_sp<GrBackendSurfaceMutableStateImpl> fMutableState;
 };
 
 #endif

include/gpu/GrBackendSurfaceMutableState.h

@@ -0,0 +1,65 @@
+/*
+ * Copyright 2020 Google LLC
+ *
+ * Use of this source code is governed by a BSD-style license that can be
+ * found in the LICENSE file.
+ */
+
+#ifndef GrBackendSurfaceMutableState_DEFINED
+#define GrBackendSurfaceMutableState_DEFINED
+
+#include "include/gpu/GrTypes.h"
+
+#ifdef SK_VULKAN
+#include "include/private/GrVkTypesPriv.h"
+#endif
+
+/**
+ * Since Skia and clients can both modify gpu textures and their connected state, Skia needs a way
+ * for clients to inform us if they have modifiend any of this state. In order to not need setters
+ * for every single API and state, we use this class to be a generic wrapper around all the mutable
+ * state. This class is used for calls that inform Skia of these texture/image state changes by the
+ * client as well as for requesting state changes to be done by Skia. The backend specific state
+ * that is wrapped by this class are:
+ *
+ * Vulkan: VkImageLayout and QueueFamilyIndex
+ */
+class GrBackendSurfaceMutableState {
+public:
+#ifdef SK_VULKAN
+    GrBackendSurfaceMutableState(VkImageLayout layout, uint32_t queueFamilyIndex)
+            : fVkState(layout, queueFamilyIndex)
+            , fBackend(GrBackend::kVulkan) {}
+#endif
+
+    GrBackendSurfaceMutableState& operator=(const GrBackendSurfaceMutableState& that) {
+        switch (fBackend) {
+            case GrBackend::kVulkan:
+#ifdef SK_VULKAN
+                SkASSERT(that.fBackend == GrBackend::kVulkan);
+                fVkState = that.fVkState;
+#endif
+                break;
+
+            default:
+                (void)that;
+                SkUNREACHABLE;
+        }
+        fBackend = that.fBackend;
+        return *this;
+    }
+
+private:
+    friend class GrBackendSurfaceMutableStateImpl;
+
+    union {
+        char fDummy;
+#ifdef SK_VULKAN
+        GrVkSharedImageInfo fVkState;
+#endif
+    };
+
+    GrBackend fBackend;
+};
+
+#endif

include/gpu/vk/GrVkTypes.h

@@ -190,14 +190,14 @@ struct GrVkImageInfo {
             , fProtected(isProtected)
             , fYcbcrConversionInfo(ycbcrConversionInfo) {}
 
-    GrVkImageInfo(const GrVkImageInfo& info, VkImageLayout layout)
+    GrVkImageInfo(const GrVkImageInfo& info, VkImageLayout layout, uint32_t familyQueueIndex)
             : fImage(info.fImage)
             , fAlloc(info.fAlloc)
             , fImageTiling(info.fImageTiling)
             , fImageLayout(layout)
             , fFormat(info.fFormat)
             , fLevelCount(info.fLevelCount)
-            , fCurrentQueueFamily(info.fCurrentQueueFamily)
+            , fCurrentQueueFamily(familyQueueIndex)
             , fProtected(info.fProtected)
             , fYcbcrConversionInfo(info.fYcbcrConversionInfo) {}
 

include/private/GrVkTypesPriv.h

@@ -11,7 +11,7 @@
 #include "include/core/SkRefCnt.h"
 #include "include/gpu/vk/GrVkTypes.h"
 
-class GrVkImageLayout;
+class GrBackendSurfaceMutableStateImpl;
 
 // This struct is to used to store the the actual information about the vulkan backend image on the
 // GrBackendTexture and GrBackendRenderTarget. When a client calls getVkImageInfo on a
@@ -20,8 +20,7 @@ class GrVkImageLayout;
 // current VkImageLayout which can be shared with an internal GrVkImage so that layout updates can
 // be seen by all users of the image.
 struct GrVkBackendSurfaceInfo {
-    GrVkBackendSurfaceInfo(GrVkImageInfo info, GrVkImageLayout* layout)
-            : fImageInfo(info), fLayout(layout) {}
+    GrVkBackendSurfaceInfo(GrVkImageInfo info) : fImageInfo(info) {}
 
     void cleanup();
 
@@ -31,11 +30,7 @@ struct GrVkBackendSurfaceInfo {
     // attempt to unref the old fLayout on this object.
     void assign(const GrVkBackendSurfaceInfo&, bool isValid);
 
-    void setImageLayout(VkImageLayout layout);
-
-    sk_sp<GrVkImageLayout> getGrVkImageLayout() const;
-
-    GrVkImageInfo snapImageInfo() const;
+    GrVkImageInfo snapImageInfo(const GrBackendSurfaceMutableStateImpl*) const;
 
     bool isProtected() const { return fImageInfo.fProtected == GrProtected::kYes; }
 #if GR_TEST_UTILS
@@ -44,7 +39,44 @@ struct GrVkBackendSurfaceInfo {
 
 private:
     GrVkImageInfo    fImageInfo;
-    GrVkImageLayout* fLayout;
+};
+
+class GrVkSharedImageInfo {
+public:
+    GrVkSharedImageInfo(VkImageLayout layout, uint32_t queueFamilyIndex)
+            : fLayout(layout)
+            , fQueueFamilyIndex(queueFamilyIndex) {}
+
+    GrVkSharedImageInfo& operator=(const GrVkSharedImageInfo& that) {
+        fLayout = that.getImageLayout();
+        fQueueFamilyIndex = that.getQueueFamilyIndex();
+        return *this;
+    }
+
+
+     void setImageLayout(VkImageLayout layout) {
+        // Defaulting to use std::memory_order_seq_cst
+        fLayout.store(layout);
+    }
+
+    VkImageLayout getImageLayout() const {
+        // Defaulting to use std::memory_order_seq_cst
+        return fLayout.load();
+    }
+
+    void setQueueFamilyIndex(uint32_t queueFamilyIndex) {
+        // Defaulting to use std::memory_order_seq_cst
+        fQueueFamilyIndex.store(queueFamilyIndex);
+    }
+
+    uint32_t getQueueFamilyIndex() const {
+        // Defaulting to use std::memory_order_seq_cst
+        return fQueueFamilyIndex.load();
+    }
+
+private:
+    std::atomic<VkImageLayout> fLayout;
+    std::atomic<uint32_t> fQueueFamilyIndex;
 };
 
 #endif