Dawn: Make shader module reflection serializable

This CL make shader module reflection data, i.e. EntryPointMetadataTable
serializable, so we can cache it into on-disk blob cache. With this CL
it is possible to create a shader module with reflection data but
without calling Tint at all.
This CL also make macro DAWN_SERIALIZABLE to generate default equality
comparison for the serializable struct, and also add default equality
comparison operator in necessary structs to achieve that.

Bug: 402772740, 42240459
Change-Id: Icf7b2d3d2e1fa427f2bd9e1db4f6410ff842c08c
Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/241494
Reviewed-by: Geoff Lang <geofflang@chromium.org>
Commit-Queue: Zhaoming Jiang <zhaoming.jiang@microsoft.com>

Author: jiangzhaoming

src/dawn/native/BindGroupLayoutInternal.cpp

@@ -379,12 +379,11 @@ BindingInfo CreateSampledTextureBindingForExternalTexture(BindingNumber binding,
     return {
         .binding = binding,
         .visibility = visibility,
-        .bindingLayout =
-            TextureBindingInfo{
-                .sampleType = wgpu::TextureSampleType::Float,
-                .viewDimension = wgpu::TextureViewDimension::e2D,
-                .multisampled = false,
-            },
+        .bindingLayout = TextureBindingInfo{{
+            .sampleType = wgpu::TextureSampleType::Float,
+            .viewDimension = wgpu::TextureViewDimension::e2D,
+            .multisampled = false,
+        }},
     };
 }
 
@@ -393,12 +392,11 @@ BindingInfo CreateUniformBindingForExternalTexture(BindingNumber binding,
     return {
         .binding = binding,
         .visibility = visibility,
-        .bindingLayout =
-            BufferBindingInfo{
-                .type = wgpu::BufferBindingType::Uniform,
-                .minBindingSize = 0,
-                .hasDynamicOffset = false,
-            },
+        .bindingLayout = BufferBindingInfo{{
+            .type = wgpu::BufferBindingType::Uniform,
+            .minBindingSize = 0,
+            .hasDynamicOffset = false,
+        }},
     };
 }
 
@@ -414,7 +412,7 @@ BindingInfo ConvertToBindingInfoNoArray(const UnpackedPtr<BindGroupLayoutEntry>&
     } else if (binding->texture.sampleType != wgpu::TextureSampleType::BindingNotUsed) {
         auto textureBindingInfo = TextureBindingInfo::From(binding->texture);
         if (binding->texture.viewDimension == kInternalInputAttachmentDim) {
-            bindingInfo.bindingLayout = InputAttachmentBindingInfo{textureBindingInfo.sampleType};
+            bindingInfo.bindingLayout = InputAttachmentBindingInfo{{textureBindingInfo.sampleType}};
         } else {
             bindingInfo.bindingLayout = textureBindingInfo;
         }

src/dawn/native/BindingInfo.cpp

@@ -302,23 +302,23 @@ MaybeError ValidateBindingCounts(const CombinedLimits& limits,
 // static
 BufferBindingInfo BufferBindingInfo::From(const BufferBindingLayout& layout) {
     BufferBindingLayout defaultedLayout = layout.WithTrivialFrontendDefaults();
-    return {
+    return {{
         .type = defaultedLayout.type,
         .minBindingSize = defaultedLayout.minBindingSize,
         .hasDynamicOffset = defaultedLayout.hasDynamicOffset,
-    };
+    }};
 }
 
 // TextureBindingInfo
 
 // static
 TextureBindingInfo TextureBindingInfo::From(const TextureBindingLayout& layout) {
     TextureBindingLayout defaultedLayout = layout.WithTrivialFrontendDefaults();
-    return {
+    return {{
         .sampleType = defaultedLayout.sampleType,
         .viewDimension = defaultedLayout.viewDimension,
         .multisampled = defaultedLayout.multisampled,
-    };
+    }};
 }
 
 // StorageTextureBindingInfo
@@ -327,21 +327,21 @@ TextureBindingInfo TextureBindingInfo::From(const TextureBindingLayout& layout)
 StorageTextureBindingInfo StorageTextureBindingInfo::From(
     const StorageTextureBindingLayout& layout) {
     StorageTextureBindingLayout defaultedLayout = layout.WithTrivialFrontendDefaults();
-    return {
+    return {{
         .format = defaultedLayout.format,
         .viewDimension = defaultedLayout.viewDimension,
         .access = defaultedLayout.access,
-    };
+    }};
 }
 
 // SamplerBindingInfo
 
 // static
 SamplerBindingInfo SamplerBindingInfo::From(const SamplerBindingLayout& layout) {
     SamplerBindingLayout defaultedLayout = layout.WithTrivialFrontendDefaults();
-    return {
+    return {{
         .type = defaultedLayout.type,
-    };
+    }};
 }
 
 // SamplerBindingInfo

src/dawn/native/BindingInfo.h

@@ -39,6 +39,7 @@
 #include "dawn/native/Format.h"
 #include "dawn/native/IntegerTypes.h"
 #include "dawn/native/PerStage.h"
+#include "dawn/native/Serializable.h"
 
 #include "dawn/native/dawn_platform.h"
 
@@ -69,51 +70,57 @@ enum class BindingInfoType {
 };
 
 // A mirror of wgpu::BufferBindingLayout for use inside dawn::native.
-struct BufferBindingInfo {
+#define BUFFER_BINDING_INFO_MEMBER(X)                           \
+    X(wgpu::BufferBindingType, type)                            \
+    X(uint64_t, minBindingSize)                                 \
+    /* hasDynamicOffset is always false in shader reflection */ \
+    X(bool, hasDynamicOffset)
+DAWN_SERIALIZABLE(struct, BufferBindingInfo, BUFFER_BINDING_INFO_MEMBER) {
     static BufferBindingInfo From(const BufferBindingLayout& layout);
-
-    wgpu::BufferBindingType type;
-    uint64_t minBindingSize;
-
-    // Always false in shader reflection.
-    bool hasDynamicOffset = false;
-
-    bool operator==(const BufferBindingInfo& other) const = default;
 };
+#undef BUFFER_BINDING_INFO_MEMBER
 
 // A mirror of wgpu::TextureBindingLayout for use inside dawn::native.
-struct TextureBindingInfo {
+#define TEXTURE_BINDING_INFO_MEMBER(X)                                                       \
+    /* For shader reflection UnfilterableFloat is never used and the sample type is Float */ \
+    /* for any texture_Nd<f32>.                                                           */ \
+    X(wgpu::TextureSampleType, sampleType)                                                   \
+    X(wgpu::TextureViewDimension, viewDimension)                                             \
+    X(bool, multisampled)
+DAWN_SERIALIZABLE(struct, TextureBindingInfo, TEXTURE_BINDING_INFO_MEMBER) {
     static TextureBindingInfo From(const TextureBindingLayout& layout);
-
-    // For shader reflection UnfilterableFloat is never used and the sample type is Float for any
-    // texture_Nd<f32>.
-    wgpu::TextureSampleType sampleType;
-    wgpu::TextureViewDimension viewDimension;
-    bool multisampled;
-
-    bool operator==(const TextureBindingInfo& other) const = default;
 };
+#undef TEXTURE_BINDING_INFO_MEMBER
 
 // A mirror of wgpu::StorageTextureBindingLayout for use inside dawn::native.
-struct StorageTextureBindingInfo {
+#define STORAGE_TEXTURE_BINDING_INFO_MEMBER(X)   \
+    X(wgpu::TextureFormat, format)               \
+    X(wgpu::TextureViewDimension, viewDimension) \
+    X(wgpu::StorageTextureAccess, access)
+DAWN_SERIALIZABLE(struct, StorageTextureBindingInfo, STORAGE_TEXTURE_BINDING_INFO_MEMBER) {
     static StorageTextureBindingInfo From(const StorageTextureBindingLayout& layout);
-
-    wgpu::TextureFormat format;
-    wgpu::TextureViewDimension viewDimension;
-    wgpu::StorageTextureAccess access;
-
-    bool operator==(const StorageTextureBindingInfo& other) const = default;
 };
+#undef STORAGE_TEXTURE_BINDING_INFO_MEMBER
 
 // A mirror of wgpu::SamplerBindingLayout for use inside dawn::native.
-struct SamplerBindingInfo {
+#define SAMPLER_BINDING_INFO_MEMBER(X)                                               \
+    /* For shader reflection NonFiltering is never used and Filtering is used for */ \
+    /* any `sampler`.                                                             */ \
+    X(wgpu::SamplerBindingType, type)
+DAWN_SERIALIZABLE(struct, SamplerBindingInfo, SAMPLER_BINDING_INFO_MEMBER) {
     static SamplerBindingInfo From(const SamplerBindingLayout& layout);
+};
+#undef SAMPLER_BINDING_INFO_MEMBER
 
-    // For shader reflection NonFiltering is never used and Filtering is used for any `sampler`.
-    wgpu::SamplerBindingType type;
+// A mirror of wgpu::ExternalTextureBindingLayout for use inside dawn::native.
+#define EXTERNAL_TEXTURE_BINDING_INFO_MEMBER(X)  // ExternalTextureBindingInfo has no member
+DAWN_SERIALIZABLE(struct, ExternalTextureBindingInfo, EXTERNAL_TEXTURE_BINDING_INFO_MEMBER){};
+#undef EXTERNAL_TEXTURE_BINDING_INFO_MEMBER
 
-    bool operator==(const SamplerBindingInfo& other) const = default;
-};
+// Internal to vulkan only.
+#define INPUT_ATTACHMENT_BINDING_INFO_MEMBER(X) X(wgpu::TextureSampleType, sampleType)
+DAWN_SERIALIZABLE(struct, InputAttachmentBindingInfo, INPUT_ATTACHMENT_BINDING_INFO_MEMBER){};
+#undef INPUT_ATTACHMENT_BINDING_INFO_MEMBER
 
 // A mirror of wgpu::StaticSamplerBindingLayout for use inside dawn::native.
 struct StaticSamplerBindingInfo {
@@ -130,18 +137,6 @@ struct StaticSamplerBindingInfo {
     bool operator==(const StaticSamplerBindingInfo& other) const = default;
 };
 
-// A mirror of wgpu::ExternalTextureBindingLayout for use inside dawn::native.
-struct ExternalTextureBindingInfo {
-    bool operator==(const ExternalTextureBindingInfo& other) const = default;
-};
-
-// Internal to vulkan only.
-struct InputAttachmentBindingInfo {
-    wgpu::TextureSampleType sampleType;
-
-    bool operator==(const InputAttachmentBindingInfo& other) const = default;
-};
-
 struct BindingInfo {
     BindingNumber binding;
     wgpu::ShaderStage visibility;
@@ -165,12 +160,11 @@ struct BindingInfo {
 BindingInfoType GetBindingInfoType(const BindingInfo& bindingInfo);
 
 // Match tint::BindingPoint, can convert to/from tint::BindingPoint using ToTint and FromTint.
-struct BindingSlot {
-    BindGroupIndex group;
-    BindingNumber binding;
-
-    constexpr bool operator==(const BindingSlot& rhs) const = default;
-};
+#define BINDING_SLOT_MEMBER(X) \
+    X(BindGroupIndex, group)   \
+    X(BindingNumber, binding)
+DAWN_SERIALIZABLE(struct, BindingSlot, BINDING_SLOT_MEMBER){};
+#undef BINDING_SLOT_MEMBER
 
 struct PerStageBindingCounts {
     uint32_t sampledTextureCount;

src/dawn/native/Blob.cpp

@@ -97,6 +97,13 @@ size_t Blob::Size() const {
     return mSize;
 }
 
+bool Blob::operator==(const Blob& other) const {
+    if (other.Size() != Size()) {
+        return false;
+    }
+    return 0 == memcmp(Data(), other.Data(), Size());
+}
+
 template <>
 void stream::Stream<Blob>::Write(stream::Sink* s, const Blob& b) {
     size_t size = b.Size();

src/dawn/native/Blob.h

@@ -61,6 +61,8 @@ class Blob {
     uint8_t* Data();
     size_t Size() const;
 
+    bool operator==(const Blob& other) const;
+
   private:
     // The constructor should be responsible to take ownership of |data| and releases ownership by
     // calling |deleter|. The deleter function is called at ~Blob() and during std::move.

src/dawn/native/CacheKey.h

@@ -54,6 +54,10 @@ class CacheKey : public stream::ByteVectorSink {
         // stream::StreamIn<T>.
         friend constexpr void StreamIn(stream::Sink*, const UnsafeUnkeyedValue&) {}
 
+        // Enabling DAWN_SERIALIZABLE classes with UnsafeUnkeyedValue member to use default equality
+        // operator. Equality comparison always returns true for the same type UnsafeUnkeyedValues.
+        bool operator==(const UnsafeUnkeyedValue<T>& other) const { return true; }
+
       private:
         T mValue;
     };

src/dawn/native/Limits.h

@@ -85,6 +85,7 @@ CombinedLimits ApplyLimitTiers(const CombinedLimits& limits);
 struct LimitsForCompilationRequest {
     static LimitsForCompilationRequest Create(const Limits& limits);
     DAWN_VISITABLE_MEMBERS(LIMITS_FOR_COMPILATION_REQUEST_MEMBERS)
+    bool operator==(const LimitsForCompilationRequest& other) const = default;
 };
 
 // Enforce restriction for limit values, including:

src/dawn/native/Serializable.h

@@ -67,8 +67,8 @@ class Serializable {
 
 // Helper macro to define a struct or class along with VisitAll methods to call
 // a functor on all members. Derives from Visitable which provides
-// implementations of StreamIn/StreamOut/FromBlob/ToBlob.
-// Example usage:
+// implementations of StreamIn/StreamOut/FromBlob/ToBlob, and provides a default equality
+// comparison. Example usage:
 //   #define MEMBERS(X) \
 //       X(int, a)              \
 //       X(float, b)            \
@@ -78,10 +78,11 @@ class Serializable {
 //      void SomeAdditionalMethod();
 //   };
 //   #undef MEMBERS
-#define DAWN_SERIALIZABLE(qualifier, Name, MEMBERS) \
-    struct Name##__Contents {                       \
-        DAWN_VISITABLE_MEMBERS(MEMBERS)             \
-    };                                              \
+#define DAWN_SERIALIZABLE(qualifier, Name, MEMBERS)                     \
+    struct Name##__Contents {                                           \
+        DAWN_VISITABLE_MEMBERS(MEMBERS)                                 \
+        bool operator==(const Name##__Contents& other) const = default; \
+    };                                                                  \
     qualifier Name : Name##__Contents, public ::dawn::native::Serializable<Name>
 
 #endif  // SRC_DAWN_NATIVE_SERIALIZABLE_H_

src/dawn/native/ShaderModule.cpp

@@ -320,6 +320,10 @@ ResultOrError<InterpolationSampling> TintInterpolationSamplingToInterpolationSam
     DAWN_UNREACHABLE();
 }
 
+EntryPointMetadata::OverrideId FromTintOverrideId(tint::OverrideId id) {
+    return EntryPointMetadata::OverrideId{{id.value}};
+}
+
 EntryPointMetadata::Override::Type FromTintOverrideType(tint::inspector::Override::Type type) {
     switch (type) {
         case tint::inspector::Override::Type::kBool:
@@ -677,8 +681,8 @@ ResultOrError<std::unique_ptr<EntryPointMetadata>> ReflectEntryPointUsingTint(
     if (!entryPoint.overrides.empty()) {
         for (auto& c : entryPoint.overrides) {
             auto id = name2Id.at(c.name);
-            EntryPointMetadata::Override override = {id, FromTintOverrideType(c.type),
-                                                     c.is_initialized};
+            EntryPointMetadata::Override override = {
+                {FromTintOverrideId(id), FromTintOverrideType(c.type), c.is_initialized}};
 
             std::string identifier = c.is_id_specified ? std::to_string(override.id.value) : c.name;
             metadata->overrides[identifier] = override;
@@ -705,8 +709,9 @@ ResultOrError<std::unique_ptr<EntryPointMetadata>> ReflectEntryPointUsingTint(
         }
 
         auto id = name2Id.at(o.name);
-        EntryPointMetadata::Override override = {id, FromTintOverrideType(o.type), o.is_initialized,
-                                                 /* isUsed */ false};
+        EntryPointMetadata::Override override = {{FromTintOverrideId(id),
+                                                  FromTintOverrideType(o.type), o.is_initialized,
+                                                  /* isUsed */ false}};
         metadata->overrides[identifier] = override;
     }