| // Copyright 2017 The Dawn & Tint Authors |
| // |
| // Redistribution and use in source and binary forms, with or without |
| // modification, are permitted provided that the following conditions are met: |
| // |
| // 1. Redistributions of source code must retain the above copyright notice, this |
| // list of conditions and the following disclaimer. |
| // |
| // 2. Redistributions in binary form must reproduce the above copyright notice, |
| // this list of conditions and the following disclaimer in the documentation |
| // and/or other materials provided with the distribution. |
| // |
| // 3. Neither the name of the copyright holder nor the names of its |
| // contributors may be used to endorse or promote products derived from |
| // this software without specific prior written permission. |
| // |
| // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
| // FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| // DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
| // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
| // CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| // OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| |
| #include "dawn/native/ShaderModule.h" |
| |
| #include <algorithm> |
| #include <limits> |
| #include <set> |
| #include <sstream> |
| #include <utility> |
| |
| #include "dawn/common/Constants.h" |
| #include "dawn/common/MatchVariant.h" |
| #include "dawn/common/Sha3.h" |
| #include "dawn/native/BindGroupLayoutInternal.h" |
| #include "dawn/native/ChainUtils.h" |
| #include "dawn/native/CompilationMessages.h" |
| #include "dawn/native/Device.h" |
| #include "dawn/native/Instance.h" |
| #include "dawn/native/ObjectContentHasher.h" |
| #include "dawn/native/Pipeline.h" |
| #include "dawn/native/PipelineLayout.h" |
| #include "dawn/native/RenderPipeline.h" |
| #include "dawn/native/Sampler.h" |
| #include "dawn/native/ShaderModuleParseRequest.h" |
| #include "dawn/native/TintUtils.h" |
| |
| #ifdef DAWN_ENABLE_SPIRV_VALIDATION |
| #include "dawn/native/SpirvValidation.h" |
| #endif |
| |
| #include "tint/tint.h" |
| |
| namespace dawn::native { |
| |
| namespace { |
| |
| SingleShaderStage TintPipelineStageToShaderStage(tint::inspector::PipelineStage stage) { |
| switch (stage) { |
| case tint::inspector::PipelineStage::kVertex: |
| return SingleShaderStage::Vertex; |
| case tint::inspector::PipelineStage::kFragment: |
| return SingleShaderStage::Fragment; |
| case tint::inspector::PipelineStage::kCompute: |
| return SingleShaderStage::Compute; |
| } |
| DAWN_UNREACHABLE(); |
| } |
| |
| BindingInfoType TintResourceTypeToBindingInfoType( |
| tint::inspector::ResourceBinding::ResourceType type) { |
| switch (type) { |
| case tint::inspector::ResourceBinding::ResourceType::kUniformBuffer: |
| case tint::inspector::ResourceBinding::ResourceType::kStorageBuffer: |
| case tint::inspector::ResourceBinding::ResourceType::kReadOnlyStorageBuffer: |
| return BindingInfoType::Buffer; |
| case tint::inspector::ResourceBinding::ResourceType::kSampler: |
| case tint::inspector::ResourceBinding::ResourceType::kComparisonSampler: |
| return BindingInfoType::Sampler; |
| case tint::inspector::ResourceBinding::ResourceType::kSampledTexture: |
| case tint::inspector::ResourceBinding::ResourceType::kMultisampledTexture: |
| case tint::inspector::ResourceBinding::ResourceType::kDepthTexture: |
| case tint::inspector::ResourceBinding::ResourceType::kDepthMultisampledTexture: |
| return BindingInfoType::Texture; |
| case tint::inspector::ResourceBinding::ResourceType::kWriteOnlyStorageTexture: |
| case tint::inspector::ResourceBinding::ResourceType::kReadOnlyStorageTexture: |
| case tint::inspector::ResourceBinding::ResourceType::kReadWriteStorageTexture: |
| return BindingInfoType::StorageTexture; |
| case tint::inspector::ResourceBinding::ResourceType::kExternalTexture: |
| return BindingInfoType::ExternalTexture; |
| case tint::inspector::ResourceBinding::ResourceType::kInputAttachment: |
| return BindingInfoType::InputAttachment; |
| |
| default: |
| DAWN_UNREACHABLE(); |
| return BindingInfoType::Buffer; |
| } |
| } |
| |
| wgpu::TextureFormat TintImageFormatToTextureFormat( |
| tint::inspector::ResourceBinding::TexelFormat format) { |
| switch (format) { |
| case tint::inspector::ResourceBinding::TexelFormat::kR32Uint: |
| return wgpu::TextureFormat::R32Uint; |
| case tint::inspector::ResourceBinding::TexelFormat::kR32Sint: |
| return wgpu::TextureFormat::R32Sint; |
| case tint::inspector::ResourceBinding::TexelFormat::kR32Float: |
| return wgpu::TextureFormat::R32Float; |
| case tint::inspector::ResourceBinding::TexelFormat::kBgra8Unorm: |
| return wgpu::TextureFormat::BGRA8Unorm; |
| case tint::inspector::ResourceBinding::TexelFormat::kRgba8Unorm: |
| return wgpu::TextureFormat::RGBA8Unorm; |
| case tint::inspector::ResourceBinding::TexelFormat::kRgba8Snorm: |
| return wgpu::TextureFormat::RGBA8Snorm; |
| case tint::inspector::ResourceBinding::TexelFormat::kRgba8Uint: |
| return wgpu::TextureFormat::RGBA8Uint; |
| case tint::inspector::ResourceBinding::TexelFormat::kRgba8Sint: |
| return wgpu::TextureFormat::RGBA8Sint; |
| case tint::inspector::ResourceBinding::TexelFormat::kRg32Uint: |
| return wgpu::TextureFormat::RG32Uint; |
| case tint::inspector::ResourceBinding::TexelFormat::kRg32Sint: |
| return wgpu::TextureFormat::RG32Sint; |
| case tint::inspector::ResourceBinding::TexelFormat::kRg32Float: |
| return wgpu::TextureFormat::RG32Float; |
| case tint::inspector::ResourceBinding::TexelFormat::kRgba16Uint: |
| return wgpu::TextureFormat::RGBA16Uint; |
| case tint::inspector::ResourceBinding::TexelFormat::kRgba16Sint: |
| return wgpu::TextureFormat::RGBA16Sint; |
| case tint::inspector::ResourceBinding::TexelFormat::kRgba16Float: |
| return wgpu::TextureFormat::RGBA16Float; |
| case tint::inspector::ResourceBinding::TexelFormat::kRgba32Uint: |
| return wgpu::TextureFormat::RGBA32Uint; |
| case tint::inspector::ResourceBinding::TexelFormat::kRgba32Sint: |
| return wgpu::TextureFormat::RGBA32Sint; |
| case tint::inspector::ResourceBinding::TexelFormat::kRgba32Float: |
| return wgpu::TextureFormat::RGBA32Float; |
| case tint::inspector::ResourceBinding::TexelFormat::kR8Unorm: |
| return wgpu::TextureFormat::R8Unorm; |
| case tint::inspector::ResourceBinding::TexelFormat::kNone: |
| return wgpu::TextureFormat::Undefined; |
| |
| default: |
| DAWN_UNREACHABLE(); |
| return wgpu::TextureFormat::Undefined; |
| } |
| } |
| |
| wgpu::TextureViewDimension TintTextureDimensionToTextureViewDimension( |
| tint::inspector::ResourceBinding::TextureDimension dim) { |
| switch (dim) { |
| case tint::inspector::ResourceBinding::TextureDimension::k1d: |
| return wgpu::TextureViewDimension::e1D; |
| case tint::inspector::ResourceBinding::TextureDimension::k2d: |
| return wgpu::TextureViewDimension::e2D; |
| case tint::inspector::ResourceBinding::TextureDimension::k2dArray: |
| return wgpu::TextureViewDimension::e2DArray; |
| case tint::inspector::ResourceBinding::TextureDimension::k3d: |
| return wgpu::TextureViewDimension::e3D; |
| case tint::inspector::ResourceBinding::TextureDimension::kCube: |
| return wgpu::TextureViewDimension::Cube; |
| case tint::inspector::ResourceBinding::TextureDimension::kCubeArray: |
| return wgpu::TextureViewDimension::CubeArray; |
| case tint::inspector::ResourceBinding::TextureDimension::kNone: |
| return wgpu::TextureViewDimension::Undefined; |
| } |
| DAWN_UNREACHABLE(); |
| } |
| |
| wgpu::TextureSampleType TintSampledKindToSampleType( |
| tint::inspector::ResourceBinding::SampledKind s) { |
| switch (s) { |
| case tint::inspector::ResourceBinding::SampledKind::kSInt: |
| return wgpu::TextureSampleType::Sint; |
| case tint::inspector::ResourceBinding::SampledKind::kUInt: |
| return wgpu::TextureSampleType::Uint; |
| case tint::inspector::ResourceBinding::SampledKind::kFloat: |
| // Note that Float is compatible with both Float and UnfilterableFloat. |
| return wgpu::TextureSampleType::Float; |
| case tint::inspector::ResourceBinding::SampledKind::kUnknown: |
| return wgpu::TextureSampleType::BindingNotUsed; |
| } |
| DAWN_UNREACHABLE(); |
| } |
| |
| ResultOrError<TextureComponentType> TintComponentTypeToTextureComponentType( |
| tint::inspector::ComponentType type) { |
| switch (type) { |
| case tint::inspector::ComponentType::kF32: |
| case tint::inspector::ComponentType::kF16: |
| return TextureComponentType::Float; |
| case tint::inspector::ComponentType::kI32: |
| return TextureComponentType::Sint; |
| case tint::inspector::ComponentType::kU32: |
| return TextureComponentType::Uint; |
| case tint::inspector::ComponentType::kUnknown: |
| return DAWN_VALIDATION_ERROR("Attempted to convert 'Unknown' component type from Tint"); |
| } |
| DAWN_UNREACHABLE(); |
| } |
| |
| ResultOrError<VertexFormatBaseType> TintComponentTypeToVertexFormatBaseType( |
| tint::inspector::ComponentType type) { |
| switch (type) { |
| case tint::inspector::ComponentType::kF32: |
| case tint::inspector::ComponentType::kF16: |
| return VertexFormatBaseType::Float; |
| case tint::inspector::ComponentType::kI32: |
| return VertexFormatBaseType::Sint; |
| case tint::inspector::ComponentType::kU32: |
| return VertexFormatBaseType::Uint; |
| case tint::inspector::ComponentType::kUnknown: |
| return DAWN_VALIDATION_ERROR("Attempted to convert 'Unknown' component type from Tint"); |
| } |
| DAWN_UNREACHABLE(); |
| } |
| |
| ResultOrError<wgpu::BufferBindingType> TintResourceTypeToBufferBindingType( |
| tint::inspector::ResourceBinding::ResourceType resource_type) { |
| switch (resource_type) { |
| case tint::inspector::ResourceBinding::ResourceType::kUniformBuffer: |
| return wgpu::BufferBindingType::Uniform; |
| case tint::inspector::ResourceBinding::ResourceType::kStorageBuffer: |
| return wgpu::BufferBindingType::Storage; |
| case tint::inspector::ResourceBinding::ResourceType::kReadOnlyStorageBuffer: |
| return wgpu::BufferBindingType::ReadOnlyStorage; |
| default: |
| return DAWN_VALIDATION_ERROR("Attempted to convert non-buffer resource type"); |
| } |
| DAWN_UNREACHABLE(); |
| } |
| |
| ResultOrError<wgpu::StorageTextureAccess> TintResourceTypeToStorageTextureAccess( |
| tint::inspector::ResourceBinding::ResourceType resource_type) { |
| switch (resource_type) { |
| case tint::inspector::ResourceBinding::ResourceType::kWriteOnlyStorageTexture: |
| return wgpu::StorageTextureAccess::WriteOnly; |
| case tint::inspector::ResourceBinding::ResourceType::kReadOnlyStorageTexture: |
| return wgpu::StorageTextureAccess::ReadOnly; |
| case tint::inspector::ResourceBinding::ResourceType::kReadWriteStorageTexture: |
| return wgpu::StorageTextureAccess::ReadWrite; |
| default: |
| return DAWN_VALIDATION_ERROR("Attempted to convert non-storage texture resource type"); |
| } |
| DAWN_UNREACHABLE(); |
| } |
| |
| ResultOrError<InterStageComponentType> TintComponentTypeToInterStageComponentType( |
| tint::inspector::ComponentType type) { |
| switch (type) { |
| case tint::inspector::ComponentType::kF32: |
| return InterStageComponentType::F32; |
| case tint::inspector::ComponentType::kI32: |
| return InterStageComponentType::I32; |
| case tint::inspector::ComponentType::kU32: |
| return InterStageComponentType::U32; |
| case tint::inspector::ComponentType::kF16: |
| return InterStageComponentType::F16; |
| case tint::inspector::ComponentType::kUnknown: |
| return DAWN_VALIDATION_ERROR("Attempted to convert 'Unknown' component type from Tint"); |
| } |
| DAWN_UNREACHABLE(); |
| } |
| |
| ResultOrError<uint32_t> TintCompositionTypeToInterStageComponentCount( |
| tint::inspector::CompositionType type) { |
| switch (type) { |
| case tint::inspector::CompositionType::kScalar: |
| return 1u; |
| case tint::inspector::CompositionType::kVec2: |
| return 2u; |
| case tint::inspector::CompositionType::kVec3: |
| return 3u; |
| case tint::inspector::CompositionType::kVec4: |
| return 4u; |
| case tint::inspector::CompositionType::kUnknown: |
| return DAWN_VALIDATION_ERROR("Attempt to convert 'Unknown' composition type from Tint"); |
| } |
| DAWN_UNREACHABLE(); |
| } |
| |
| ResultOrError<InterpolationType> TintInterpolationTypeToInterpolationType( |
| tint::inspector::InterpolationType type) { |
| switch (type) { |
| case tint::inspector::InterpolationType::kPerspective: |
| return InterpolationType::Perspective; |
| case tint::inspector::InterpolationType::kLinear: |
| return InterpolationType::Linear; |
| case tint::inspector::InterpolationType::kFlat: |
| return InterpolationType::Flat; |
| case tint::inspector::InterpolationType::kUnknown: |
| return DAWN_VALIDATION_ERROR( |
| "Attempted to convert 'Unknown' interpolation type from Tint"); |
| } |
| DAWN_UNREACHABLE(); |
| } |
| |
| ResultOrError<InterpolationSampling> TintInterpolationSamplingToInterpolationSamplingType( |
| tint::inspector::InterpolationSampling type) { |
| switch (type) { |
| case tint::inspector::InterpolationSampling::kNone: |
| return InterpolationSampling::None; |
| case tint::inspector::InterpolationSampling::kCenter: |
| return InterpolationSampling::Center; |
| case tint::inspector::InterpolationSampling::kCentroid: |
| return InterpolationSampling::Centroid; |
| case tint::inspector::InterpolationSampling::kSample: |
| return InterpolationSampling::Sample; |
| case tint::inspector::InterpolationSampling::kFirst: |
| return InterpolationSampling::First; |
| case tint::inspector::InterpolationSampling::kEither: |
| return InterpolationSampling::Either; |
| case tint::inspector::InterpolationSampling::kUnknown: |
| return DAWN_VALIDATION_ERROR( |
| "Attempted to convert 'Unknown' interpolation sampling type from Tint"); |
| } |
| 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: |
| return EntryPointMetadata::Override::Type::Boolean; |
| case tint::inspector::Override::Type::kFloat32: |
| return EntryPointMetadata::Override::Type::Float32; |
| case tint::inspector::Override::Type::kFloat16: |
| return EntryPointMetadata::Override::Type::Float16; |
| case tint::inspector::Override::Type::kInt32: |
| return EntryPointMetadata::Override::Type::Int32; |
| case tint::inspector::Override::Type::kUint32: |
| return EntryPointMetadata::Override::Type::Uint32; |
| } |
| DAWN_UNREACHABLE(); |
| } |
| |
| EntryPointMetadata::TextureMetadataQuery FromTintLevelSampleInfo( |
| tint::inspector::Inspector::LevelSampleInfo info) { |
| EntryPointMetadata::TextureMetadataQuery result; |
| switch (info.type) { |
| case tint::inspector::Inspector::TextureQueryType::kTextureNumLevels: |
| result.type = |
| EntryPointMetadata::TextureMetadataQuery::TextureQueryType::TextureNumLevels; |
| break; |
| case tint::inspector::Inspector::TextureQueryType::kTextureNumSamples: |
| result.type = |
| EntryPointMetadata::TextureMetadataQuery::TextureQueryType::TextureNumSamples; |
| break; |
| default: |
| DAWN_UNREACHABLE(); |
| } |
| result.group = info.group; |
| result.binding = info.binding; |
| return result; |
| } |
| |
| ResultOrError<PixelLocalMemberType> FromTintPixelLocalMemberType( |
| tint::inspector::PixelLocalMemberType type) { |
| switch (type) { |
| case tint::inspector::PixelLocalMemberType::kU32: |
| return PixelLocalMemberType::U32; |
| case tint::inspector::PixelLocalMemberType::kI32: |
| return PixelLocalMemberType::I32; |
| case tint::inspector::PixelLocalMemberType::kF32: |
| return PixelLocalMemberType::F32; |
| case tint::inspector::PixelLocalMemberType::kUnknown: |
| return DAWN_VALIDATION_ERROR( |
| "Attempted to convert 'Unknown' pixel local member type from Tint"); |
| } |
| DAWN_UNREACHABLE(); |
| } |
| |
| // Validation errors, if any, are stored within outputParseResult instead of get returned as |
| // ErrorData. |
| MaybeError ParseWGSL(std::unique_ptr<tint::Source::File> file, |
| const WGSLAllowedFeatures& allowedFeatures, |
| const std::vector<tint::wgsl::Extension>& internalExtensions, |
| ShaderModuleParseResult* outputParseResult) { |
| tint::wgsl::reader::Options options; |
| options.allowed_features = allowedFeatures.ToTint(); |
| options.allowed_features.extensions.insert(internalExtensions.begin(), |
| internalExtensions.end()); |
| tint::Program program = tint::wgsl::reader::Parse(file.get(), options); |
| |
| // Store the compilation messages into outputParseResult. |
| DAWN_TRY(outputParseResult->compilationMessages.AddMessages(program.Diagnostics())); |
| |
| // If WGSL parsing succeed, store the generated Tint program with no validation error. |
| if (program.IsValid()) { |
| outputParseResult->tintProgram = UnsafeUnserializedValue<std::optional<Ref<TintProgram>>>( |
| AcquireRef(new TintProgram(std::move(program), std::move(file)))); |
| DAWN_ASSERT(outputParseResult->HasTintProgram() && !outputParseResult->HasError()); |
| } else { |
| // Otherwise, store the validation error messages to outputParseResult. |
| outputParseResult->SetValidationError( |
| DAWN_VALIDATION_ERROR("Error while parsing WGSL: %s\n", program.Diagnostics().Str())); |
| DAWN_ASSERT(!outputParseResult->HasTintProgram() && outputParseResult->HasError()); |
| } |
| |
| return {}; |
| } |
| |
| #if TINT_BUILD_SPV_READER |
| // Validation errors, if any, are stored within outputParseResult instead of get returned as |
| // ErrorData |
| MaybeError ParseSPIRV(const std::vector<uint32_t>& spirv, |
| const WGSLAllowedFeatures& allowedFeatures, |
| ShaderModuleParseResult* outputParseResult, |
| bool allowNonUniformDerivatives) { |
| tint::spirv::reader::Options options; |
| options.allow_non_uniform_derivatives = allowNonUniformDerivatives; |
| options.allowed_features = allowedFeatures.ToTint(); |
| |
| tint::Program program = tint::spirv::reader::Read(spirv, options); |
| |
| // Store the compilation messages into outputParseResult. |
| DAWN_TRY(outputParseResult->compilationMessages.AddMessages(program.Diagnostics())); |
| |
| // If SpirV parsing succeed, store the generated Tint program with no validation error. |
| if (program.IsValid()) { |
| outputParseResult->tintProgram = UnsafeUnserializedValue<std::optional<Ref<TintProgram>>>( |
| AcquireRef(new TintProgram(std::move(program), nullptr))); |
| DAWN_ASSERT(outputParseResult->HasTintProgram() && !outputParseResult->HasError()); |
| } else { |
| // Otherwise, store the validation error messages to outputParseResult. |
| outputParseResult->SetValidationError( |
| DAWN_VALIDATION_ERROR("Error while parsing SPIR-V: %s\n", program.Diagnostics().Str())); |
| DAWN_ASSERT(!outputParseResult->HasTintProgram() && outputParseResult->HasError()); |
| } |
| |
| return {}; |
| } |
| #endif // TINT_BUILD_SPV_READER |
| |
| std::vector<uint64_t> GetBindGroupMinBufferSizes(const BindingGroupInfoMap& shaderBindings, |
| const BindGroupLayoutInternalBase* layout) { |
| std::vector<uint64_t> requiredBufferSizes(layout->GetUnverifiedBufferCount()); |
| uint32_t packedIdx = 0; |
| |
| for (BindingIndex bindingIndex{0}; bindingIndex < layout->GetBufferCount(); ++bindingIndex) { |
| const BindingInfo& bindingInfo = layout->GetBindingInfo(bindingIndex); |
| const auto* bufferBindingLayout = |
| std::get_if<BufferBindingInfo>(&bindingInfo.bindingLayout); |
| if (bufferBindingLayout == nullptr || bufferBindingLayout->minBindingSize > 0) { |
| // Skip bindings that have minimum buffer size set in the layout |
| continue; |
| } |
| |
| DAWN_ASSERT(packedIdx < requiredBufferSizes.size()); |
| const auto& shaderInfo = shaderBindings.find(bindingInfo.binding); |
| if (shaderInfo != shaderBindings.end()) { |
| auto* shaderBufferInfo = |
| std::get_if<BufferBindingInfo>(&shaderInfo->second.bindingInfo); |
| if (shaderBufferInfo != nullptr) { |
| requiredBufferSizes[packedIdx] = shaderBufferInfo->minBindingSize; |
| } else { |
| requiredBufferSizes[packedIdx] = 0; |
| } |
| } else { |
| // We have to include buffers if they are included in the bind group's |
| // packed vector. We don't actually need to check these at draw time, so |
| // if this is a problem in the future we can optimize it further. |
| requiredBufferSizes[packedIdx] = 0; |
| } |
| ++packedIdx; |
| } |
| |
| return requiredBufferSizes; |
| } |
| |
| bool IsShaderCompatibleWithPipelineLayoutOnStorageTextureAccess( |
| const StorageTextureBindingInfo& pipelineBindingLayout, |
| const StorageTextureBindingInfo& shaderBindingInfo) { |
| return pipelineBindingLayout.access == shaderBindingInfo.access || |
| (pipelineBindingLayout.access == wgpu::StorageTextureAccess::ReadWrite && |
| shaderBindingInfo.access == wgpu::StorageTextureAccess::WriteOnly); |
| } |
| |
| BindingInfoType GetShaderBindingType(const ShaderBindingInfo& shaderInfo) { |
| return MatchVariant( |
| shaderInfo.bindingInfo, [](const BufferBindingInfo&) { return BindingInfoType::Buffer; }, |
| [](const SamplerBindingInfo&) { return BindingInfoType::Sampler; }, |
| [](const TextureBindingInfo&) { return BindingInfoType::Texture; }, |
| [](const StorageTextureBindingInfo&) { return BindingInfoType::StorageTexture; }, |
| [](const ExternalTextureBindingInfo&) { return BindingInfoType::ExternalTexture; }, |
| [](const InputAttachmentBindingInfo&) { return BindingInfoType::InputAttachment; }); |
| } |
| |
| MaybeError ValidateCompatibilityOfSingleBindingWithLayout(const DeviceBase* device, |
| const BindGroupLayoutInternalBase* layout, |
| SingleShaderStage entryPointStage, |
| BindingNumber bindingNumber, |
| const ShaderBindingInfo& shaderInfo) { |
| const BindGroupLayoutInternalBase::BindingMap& layoutBindings = layout->GetBindingMap(); |
| |
| // An external texture binding found in the shader will later be expanded into multiple |
| // bindings at compile time. This expansion will have already happened in the bgl - so |
| // the shader and bgl will always mismatch at this point. Expansion info is contained in |
| // the bgl object, so we can still verify the bgl used to have an external texture in |
| // the slot corresponding to the shader reflection. |
| if (std::holds_alternative<ExternalTextureBindingInfo>(shaderInfo.bindingInfo)) { |
| // If an external texture binding used to exist in the bgl, it will be found as a |
| // key in the ExternalTextureBindingExpansions map. |
| // TODO(dawn:563): Provide info about the binding types. |
| DAWN_INVALID_IF(!layout->GetExternalTextureBindingExpansionMap().contains(bindingNumber), |
| "Binding type in the shader (texture_external) doesn't match the " |
| "type in the layout."); |
| |
| return {}; |
| } |
| |
| const auto& bindingIt = layoutBindings.find(bindingNumber); |
| DAWN_INVALID_IF(bindingIt == layoutBindings.end(), "Binding doesn't exist in %s.", layout); |
| |
| BindingIndex bindingIndex(bindingIt->second); |
| const BindingInfo& layoutInfo = layout->GetBindingInfo(bindingIndex); |
| |
| BindingInfoType bindingLayoutType = GetBindingInfoType(layoutInfo); |
| BindingInfoType shaderBindingType = GetShaderBindingType(shaderInfo); |
| |
| if (bindingLayoutType == BindingInfoType::StaticSampler) { |
| DAWN_INVALID_IF(shaderBindingType != BindingInfoType::Sampler, |
| "Binding type in the shader (%s) doesn't match the required type of %s for " |
| "the %s type in the layout.", |
| shaderBindingType, BindingInfoType::Sampler, bindingLayoutType); |
| return {}; |
| } |
| |
| DAWN_INVALID_IF(bindingLayoutType != shaderBindingType, |
| "Binding type in the shader (%s) doesn't match the type in the layout (%s).", |
| shaderBindingType, bindingLayoutType); |
| |
| ExternalTextureBindingExpansionMap expansions = layout->GetExternalTextureBindingExpansionMap(); |
| DAWN_INVALID_IF(expansions.contains(bindingNumber), |
| "Binding type (buffer vs. texture vs. sampler vs. external) doesn't " |
| "match the type in the layout."); |
| |
| DAWN_INVALID_IF((layoutInfo.visibility & StageBit(entryPointStage)) == 0, |
| "Entry point's stage (%s) is not in the binding visibility in the layout (%s).", |
| StageBit(entryPointStage), layoutInfo.visibility); |
| |
| DAWN_INVALID_IF(layoutInfo.arraySize < shaderInfo.arraySize, |
| "Binding type in the shader is a binding_array with %u elements but the " |
| "layout only provides %u elements", |
| shaderInfo.arraySize, layoutInfo.arraySize); |
| DAWN_INVALID_IF(layoutInfo.indexInArray != BindingIndex(0), |
| "@binding(%u) in the shader is element %u of the layout's binding which is an " |
| "array starting at binding %u.", |
| shaderInfo.binding, layoutInfo.indexInArray, |
| uint32_t(layoutInfo.binding) - uint32_t(layoutInfo.indexInArray)); |
| |
| return MatchVariant( |
| shaderInfo.bindingInfo, |
| [&](const TextureBindingInfo& bindingInfo) -> MaybeError { |
| const TextureBindingInfo& bindingLayout = |
| std::get<TextureBindingInfo>(layoutInfo.bindingLayout); |
| DAWN_INVALID_IF( |
| bindingLayout.multisampled != bindingInfo.multisampled, |
| "Binding multisampled flag (%u) doesn't match the layout's multisampled " |
| "flag (%u)", |
| bindingLayout.multisampled, bindingInfo.multisampled); |
| |
| wgpu::TextureSampleType requiredShaderType = bindingLayout.sampleType; |
| // Both UnfilterableFloat and kInternalResolveAttachmentSampleType are compatible with |
| // texture_Nd<f32> instead of having a specific WGSL type. |
| if (requiredShaderType == kInternalResolveAttachmentSampleType || |
| requiredShaderType == wgpu::TextureSampleType::UnfilterableFloat) { |
| requiredShaderType = wgpu::TextureSampleType::Float; |
| } |
| DAWN_INVALID_IF(bindingInfo.sampleType != requiredShaderType, |
| "The shader's texture sample type (%s) isn't compatible with the " |
| "layout's texture sample type (%s) (it is only compatible with %s for " |
| "the shader texture sample type).", |
| bindingInfo.sampleType, bindingLayout.sampleType, requiredShaderType); |
| |
| DAWN_INVALID_IF( |
| bindingLayout.viewDimension != bindingInfo.viewDimension, |
| "The shader's binding dimension (%s) doesn't match the layout's binding " |
| "dimension (%s).", |
| bindingLayout.viewDimension, bindingInfo.viewDimension); |
| return {}; |
| }, |
| [&](const StorageTextureBindingInfo& bindingInfo) -> MaybeError { |
| const StorageTextureBindingInfo& bindingLayout = |
| std::get<StorageTextureBindingInfo>(layoutInfo.bindingLayout); |
| DAWN_ASSERT(bindingLayout.format != wgpu::TextureFormat::Undefined); |
| DAWN_ASSERT(bindingInfo.format != wgpu::TextureFormat::Undefined); |
| |
| DAWN_INVALID_IF(!IsShaderCompatibleWithPipelineLayoutOnStorageTextureAccess( |
| bindingLayout, bindingInfo), |
| "The layout's binding access (%s) isn't compatible with the shader's " |
| "binding access (%s).", |
| bindingLayout.access, bindingInfo.access); |
| |
| DAWN_INVALID_IF(bindingLayout.format != bindingInfo.format, |
| "The layout's binding format (%s) doesn't match the shader's binding " |
| "format (%s).", |
| bindingLayout.format, bindingInfo.format); |
| |
| DAWN_INVALID_IF(bindingLayout.viewDimension != bindingInfo.viewDimension, |
| "The layout's binding dimension (%s) doesn't match the " |
| "shader's binding dimension (%s).", |
| bindingLayout.viewDimension, bindingInfo.viewDimension); |
| return {}; |
| }, |
| [&](const BufferBindingInfo& bindingInfo) -> MaybeError { |
| const BufferBindingInfo& bindingLayout = |
| std::get<BufferBindingInfo>(layoutInfo.bindingLayout); |
| // Binding mismatch between shader and bind group is invalid. For example, a |
| // writable binding in the shader with a readonly storage buffer in the bind |
| // group layout is invalid. For internal usage with internal shaders, a storage |
| // binding in the shader with an internal storage buffer in the bind group |
| // layout is also valid. |
| bool validBindingConversion = |
| (bindingLayout.type == kInternalStorageBufferBinding && |
| bindingInfo.type == wgpu::BufferBindingType::Storage) || |
| (bindingLayout.type == kInternalReadOnlyStorageBufferBinding && |
| bindingInfo.type == wgpu::BufferBindingType::ReadOnlyStorage); |
| |
| DAWN_INVALID_IF( |
| bindingLayout.type != bindingInfo.type && !validBindingConversion, |
| "The buffer type in the shader (%s) is not compatible with the type in the " |
| "layout (%s).", |
| bindingInfo.type, bindingLayout.type); |
| |
| DAWN_INVALID_IF(bindingLayout.minBindingSize != 0 && |
| bindingInfo.minBindingSize > bindingLayout.minBindingSize, |
| "The shader uses more bytes of the buffer (%u) than the layout's " |
| "minBindingSize (%u).", |
| bindingInfo.minBindingSize, bindingLayout.minBindingSize); |
| return {}; |
| }, |
| [&](const SamplerBindingInfo& bindingInfo) -> MaybeError { |
| const SamplerBindingInfo& bindingLayout = |
| std::get<SamplerBindingInfo>(layoutInfo.bindingLayout); |
| DAWN_INVALID_IF( |
| (bindingLayout.type == wgpu::SamplerBindingType::Comparison) != |
| (bindingInfo.type == wgpu::SamplerBindingType::Comparison), |
| "The sampler type in the shader (comparison: %u) doesn't match the type in " |
| "the layout (comparison: %u).", |
| bindingInfo.type == wgpu::SamplerBindingType::Comparison, |
| bindingLayout.type == wgpu::SamplerBindingType::Comparison); |
| return {}; |
| }, |
| [](const ExternalTextureBindingInfo&) -> MaybeError { |
| DAWN_UNREACHABLE(); |
| return {}; |
| }, |
| [&](const InputAttachmentBindingInfo& bindingInfo) -> MaybeError { |
| // Internal use only, no validation, only assertions. |
| const InputAttachmentBindingInfo& bindingLayout = |
| std::get<InputAttachmentBindingInfo>(layoutInfo.bindingLayout); |
| |
| DAWN_ASSERT(bindingLayout.sampleType == bindingInfo.sampleType); |
| |
| return {}; |
| }); |
| } |
| |
| MaybeError ValidateCompatibilityWithBindGroupLayout(DeviceBase* device, |
| BindGroupIndex group, |
| const EntryPointMetadata& entryPoint, |
| const BindGroupLayoutInternalBase* layout) { |
| // Iterate over all bindings used by this group in the shader, and find the |
| // corresponding binding in the BindGroupLayout, if it exists. |
| for (const auto& [bindingId, bindingInfo] : entryPoint.bindings[group]) { |
| DAWN_TRY_CONTEXT(ValidateCompatibilityOfSingleBindingWithLayout( |
| device, layout, entryPoint.stage, bindingId, bindingInfo), |
| "validating that the entry-point's declaration for @group(%u) " |
| "@binding(%u) matches %s", |
| group, bindingId, layout); |
| } |
| |
| return {}; |
| } |
| |
| ResultOrError<std::unique_ptr<EntryPointMetadata>> ReflectEntryPointUsingTint( |
| const ShaderModuleParseDeviceInfo& deviceInfo, |
| tint::inspector::Inspector* inspector, |
| const tint::inspector::EntryPoint& entryPoint) { |
| std::unique_ptr<EntryPointMetadata> metadata = std::make_unique<EntryPointMetadata>(); |
| |
| // Returns the invalid argument, and if it is true additionally store the formatted |
| // error in metadata.infringedLimits. This is to delay the emission of these validation |
| // errors until the entry point is used. |
| #define DelayedInvalidIf(invalid, ...) \ |
| ([&] { \ |
| if (invalid) { \ |
| metadata->infringedLimitErrors.push_back(absl::StrFormat(__VA_ARGS__)); \ |
| } \ |
| return invalid; \ |
| })() |
| |
| const auto& name2Id = inspector->GetNamedOverrideIds(); |
| if (!entryPoint.overrides.empty()) { |
| for (auto& c : entryPoint.overrides) { |
| auto id = name2Id.at(c.name); |
| 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; |
| |
| if (!c.is_initialized) { |
| auto [_, inserted] = |
| metadata->uninitializedOverrides.emplace(std::move(identifier)); |
| // The insertion should have taken place |
| DAWN_ASSERT(inserted); |
| } else { |
| auto [_, inserted] = metadata->initializedOverrides.emplace(std::move(identifier)); |
| // The insertion should have taken place |
| DAWN_ASSERT(inserted); |
| } |
| } |
| } |
| |
| // Add overrides which are not used by the entry point into the list so we |
| // can validate set constants in the pipeline. |
| for (auto& o : inspector->Overrides()) { |
| std::string identifier = o.is_id_specified ? std::to_string(o.id.value) : o.name; |
| if (metadata->overrides.contains(identifier)) { |
| continue; |
| } |
| |
| auto id = name2Id.at(o.name); |
| EntryPointMetadata::Override override = {{FromTintOverrideId(id), |
| FromTintOverrideType(o.type), o.is_initialized, |
| /* isUsed */ false}}; |
| metadata->overrides[identifier] = override; |
| } |
| |
| metadata->stage = TintPipelineStageToShaderStage(entryPoint.stage); |
| |
| if (metadata->stage == SingleShaderStage::Compute) { |
| metadata->usesNumWorkgroups = entryPoint.num_workgroups_used; |
| } |
| |
| metadata->usesTextureLoadWithDepthTexture = entryPoint.has_texture_load_with_depth_texture; |
| metadata->usesDepthTextureWithNonComparisonSampler = |
| entryPoint.has_depth_texture_with_non_comparison_sampler; |
| |
| const LimitsForShaderModuleParseRequest& limits = deviceInfo.limits; |
| const uint32_t maxVertexAttributes = limits.maxVertexAttributes; |
| const uint32_t maxInterStageShaderVariables = limits.maxInterStageShaderVariables; |
| |
| metadata->usedInterStageVariables.resize(maxInterStageShaderVariables); |
| metadata->interStageVariables.resize(maxInterStageShaderVariables); |
| |
| // Immediate data byte size must be 4-byte aligned. |
| if (entryPoint.immediate_data_size) { |
| DAWN_ASSERT(IsAligned(entryPoint.immediate_data_size, 4u)); |
| metadata->immediateDataRangeByteSize = entryPoint.immediate_data_size; |
| } |
| |
| // Vertex shader specific reflection. |
| if (metadata->stage == SingleShaderStage::Vertex) { |
| // Vertex input reflection. |
| for (const auto& inputVar : entryPoint.input_variables) { |
| uint32_t unsanitizedLocation = inputVar.attributes.location.value(); |
| if (DelayedInvalidIf(unsanitizedLocation >= maxVertexAttributes, |
| "Vertex input variable \"%s\" has a location (%u) that " |
| "exceeds the maximum (%u)", |
| inputVar.name, unsanitizedLocation, maxVertexAttributes)) { |
| continue; |
| } |
| |
| VertexAttributeLocation location(static_cast<uint8_t>(unsanitizedLocation)); |
| DAWN_TRY_ASSIGN(metadata->vertexInputBaseTypes[location], |
| TintComponentTypeToVertexFormatBaseType(inputVar.component_type)); |
| metadata->usedVertexInputs.set(location); |
| } |
| |
| // Vertex output (inter-stage variables) reflection. |
| uint32_t clipDistancesSlots = 0; |
| if (entryPoint.clip_distances_size.has_value()) { |
| clipDistancesSlots = RoundUp(*entryPoint.clip_distances_size, 4) / 4; |
| } |
| uint32_t minInvalidLocation = maxInterStageShaderVariables - clipDistancesSlots; |
| for (const auto& outputVar : entryPoint.output_variables) { |
| EntryPointMetadata::InterStageVariableInfo variable; |
| variable.name = outputVar.variable_name; |
| DAWN_TRY_ASSIGN(variable.baseType, |
| TintComponentTypeToInterStageComponentType(outputVar.component_type)); |
| DAWN_TRY_ASSIGN(variable.componentCount, TintCompositionTypeToInterStageComponentCount( |
| outputVar.composition_type)); |
| DAWN_TRY_ASSIGN(variable.interpolationType, |
| TintInterpolationTypeToInterpolationType(outputVar.interpolation_type)); |
| DAWN_TRY_ASSIGN(variable.interpolationSampling, |
| TintInterpolationSamplingToInterpolationSamplingType( |
| outputVar.interpolation_sampling)); |
| |
| uint32_t location = outputVar.attributes.location.value(); |
| if (location >= minInvalidLocation) { |
| if (clipDistancesSlots > 0) { |
| metadata->infringedLimitErrors.push_back(absl::StrFormat( |
| "Vertex output variable \"%s\" has a location (%u) that " |
| "is too large. It should be less than (%u = %u - %u (clip_distances)).", |
| outputVar.name, location, minInvalidLocation, maxInterStageShaderVariables, |
| clipDistancesSlots)); |
| } else { |
| metadata->infringedLimitErrors.push_back( |
| absl::StrFormat("Vertex output variable \"%s\" has a location (%u) that " |
| "is too large. It should be less than (%u).", |
| outputVar.name, location, minInvalidLocation)); |
| } |
| continue; |
| } |
| |
| metadata->usedInterStageVariables[location] = true; |
| metadata->interStageVariables[location] = variable; |
| } |
| |
| // Other vertex metadata. |
| metadata->totalInterStageShaderVariables = |
| entryPoint.output_variables.size() + clipDistancesSlots; |
| if (metadata->totalInterStageShaderVariables > maxInterStageShaderVariables) { |
| size_t userDefinedOutputVariables = entryPoint.output_variables.size(); |
| |
| std::ostringstream builtinInfo; |
| if (entryPoint.clip_distances_size.has_value()) { |
| builtinInfo << " + " << RoundUp(*entryPoint.clip_distances_size, 4) / 4 |
| << " (clip_distances)"; |
| } |
| |
| metadata->infringedLimitErrors.push_back(absl::StrFormat( |
| "Total vertex output variables count (%u = %u (user-defined)%s) exceeds the " |
| "maximum (%u).", |
| metadata->totalInterStageShaderVariables, userDefinedOutputVariables, |
| builtinInfo.str(), maxInterStageShaderVariables)); |
| } |
| |
| metadata->usesVertexIndex = entryPoint.vertex_index_used; |
| metadata->usesInstanceIndex = entryPoint.instance_index_used; |
| } |
| |
| // Fragment shader specific reflection. |
| if (metadata->stage == SingleShaderStage::Fragment) { |
| // Fragment input (inter-stage variables) reflection. |
| for (const auto& inputVar : entryPoint.input_variables) { |
| // Skip over @color framebuffer fetch, it is handled below. |
| if (!inputVar.attributes.location.has_value()) { |
| DAWN_ASSERT(inputVar.attributes.color.has_value()); |
| continue; |
| } |
| |
| uint32_t location = inputVar.attributes.location.value(); |
| EntryPointMetadata::InterStageVariableInfo variable; |
| variable.name = inputVar.variable_name; |
| DAWN_TRY_ASSIGN(variable.baseType, |
| TintComponentTypeToInterStageComponentType(inputVar.component_type)); |
| DAWN_TRY_ASSIGN(variable.componentCount, TintCompositionTypeToInterStageComponentCount( |
| inputVar.composition_type)); |
| DAWN_TRY_ASSIGN(variable.interpolationType, |
| TintInterpolationTypeToInterpolationType(inputVar.interpolation_type)); |
| DAWN_TRY_ASSIGN(variable.interpolationSampling, |
| TintInterpolationSamplingToInterpolationSamplingType( |
| inputVar.interpolation_sampling)); |
| |
| if (DelayedInvalidIf(location >= maxInterStageShaderVariables, |
| "Fragment input variable \"%s\" has a location (%u) that " |
| "is greater than or equal to (%u).", |
| inputVar.name, location, maxInterStageShaderVariables)) { |
| continue; |
| } |
| |
| metadata->usedInterStageVariables[location] = true; |
| metadata->interStageVariables[location] = variable; |
| } |
| |
| uint32_t totalInterStageShaderVariables = entryPoint.input_variables.size(); |
| |
| // Other fragment metadata |
| metadata->usesSampleMaskOutput = entryPoint.output_sample_mask_used; |
| metadata->usesSampleIndex = entryPoint.sample_index_used; |
| if (entryPoint.front_facing_used || entryPoint.input_sample_mask_used || |
| entryPoint.sample_index_used) { |
| ++totalInterStageShaderVariables; |
| } |
| metadata->usesFragDepth = entryPoint.frag_depth_used; |
| |
| metadata->totalInterStageShaderVariables = totalInterStageShaderVariables; |
| if (metadata->totalInterStageShaderVariables > maxInterStageShaderVariables) { |
| size_t userDefinedInputVariables = entryPoint.input_variables.size(); |
| |
| std::ostringstream builtinInfo; |
| if (metadata->totalInterStageShaderVariables > userDefinedInputVariables) { |
| builtinInfo << " + 1 ("; |
| bool isFirst = true; |
| if (entryPoint.front_facing_used) { |
| builtinInfo << "front_facing"; |
| isFirst = false; |
| } |
| if (entryPoint.input_sample_mask_used) { |
| if (!isFirst) { |
| builtinInfo << "|"; |
| } |
| builtinInfo << "sample_mask"; |
| isFirst = false; |
| } |
| if (entryPoint.sample_index_used) { |
| if (!isFirst) { |
| builtinInfo << "|"; |
| } |
| builtinInfo << "sample_index"; |
| isFirst = false; |
| } |
| } |
| |
| metadata->infringedLimitErrors.push_back(absl::StrFormat( |
| "Total fragment input variables count (%u = %u (user-defined)%s) exceeds the " |
| "maximum (%u).", |
| metadata->totalInterStageShaderVariables, userDefinedInputVariables, |
| builtinInfo.str(), maxInterStageShaderVariables)); |
| } |
| |
| // Fragment output reflection. |
| uint32_t maxColorAttachments = limits.maxColorAttachments; |
| for (const auto& outputVar : entryPoint.output_variables) { |
| EntryPointMetadata::FragmentRenderAttachmentInfo variable; |
| DAWN_TRY_ASSIGN(variable.baseType, |
| TintComponentTypeToTextureComponentType(outputVar.component_type)); |
| DAWN_TRY_ASSIGN(variable.componentCount, TintCompositionTypeToInterStageComponentCount( |
| outputVar.composition_type)); |
| DAWN_ASSERT(variable.componentCount <= 4); |
| |
| uint32_t unsanitizedAttachment = outputVar.attributes.location.value(); |
| if (DelayedInvalidIf(unsanitizedAttachment >= maxColorAttachments, |
| "Fragment output variable \"%s\" has a location (%u) that " |
| "exceeds the maximum (%u).", |
| outputVar.name, unsanitizedAttachment, maxColorAttachments)) { |
| continue; |
| } |
| |
| // Both `@blend_src(0)` and `@blend_src(1)` are related to color attachment 0 and must |
| // have the same type, so we just need to save the type information of `@blend_src(1)` |
| // in `metadata->fragmentOutputVariables[0]` so that when dual source blending is used |
| // `metadata->fragmentOutputVariables[0].blendSrc` is always 1. |
| bool isBlendSrc0 = false; |
| if (outputVar.attributes.blend_src.has_value()) { |
| variable.blendSrc = *outputVar.attributes.blend_src; |
| isBlendSrc0 = variable.blendSrc == 0; |
| } else { |
| variable.blendSrc = 0; |
| } |
| |
| if (!isBlendSrc0) { |
| ColorAttachmentIndex attachment(static_cast<uint8_t>(unsanitizedAttachment)); |
| metadata->fragmentOutputVariables[attachment] = variable; |
| metadata->fragmentOutputMask.set(attachment); |
| } |
| } |
| |
| // Fragment input reflection. |
| for (const auto& inputVar : entryPoint.input_variables) { |
| if (!inputVar.attributes.color.has_value()) { |
| continue; |
| } |
| |
| // Tint should disallow using @color(N) without the respective enable, which is gated |
| // on the extension. |
| DAWN_ASSERT(deviceInfo.features.IsEnabled(Feature::FramebufferFetch)); |
| |
| EntryPointMetadata::FragmentRenderAttachmentInfo variable; |
| DAWN_TRY_ASSIGN(variable.baseType, |
| TintComponentTypeToTextureComponentType(inputVar.component_type)); |
| DAWN_TRY_ASSIGN(variable.componentCount, TintCompositionTypeToInterStageComponentCount( |
| inputVar.composition_type)); |
| DAWN_ASSERT(variable.componentCount <= 4); |
| |
| uint32_t unsanitizedAttachment = inputVar.attributes.color.value(); |
| if (DelayedInvalidIf(unsanitizedAttachment >= maxColorAttachments, |
| "Fragment input variable \"%s\" has a location (%u) that " |
| "exceeds the maximum (%u).", |
| inputVar.name, unsanitizedAttachment, maxColorAttachments)) { |
| continue; |
| } |
| |
| ColorAttachmentIndex attachment(static_cast<uint8_t>(unsanitizedAttachment)); |
| metadata->fragmentInputVariables[attachment] = variable; |
| metadata->fragmentInputMask.set(attachment); |
| } |
| |
| // Fragment PLS reflection. |
| if (!entryPoint.pixel_local_members.empty()) { |
| metadata->usesPixelLocal = true; |
| metadata->pixelLocalBlockSize = |
| kPLSSlotByteSize * entryPoint.pixel_local_members.size(); |
| metadata->pixelLocalMembers.reserve(entryPoint.pixel_local_members.size()); |
| |
| for (auto type : entryPoint.pixel_local_members) { |
| PixelLocalMemberType metadataType; |
| DAWN_TRY_ASSIGN(metadataType, FromTintPixelLocalMemberType(type)); |
| metadata->pixelLocalMembers.push_back(metadataType); |
| } |
| } |
| } |
| |
| // Generic resource binding reflection. |
| for (const tint::inspector::ResourceBinding& resource : |
| inspector->GetResourceBindings(entryPoint.name)) { |
| ShaderBindingInfo info; |
| |
| info.name = resource.variable_name; |
| |
| info.arraySize = BindingIndex(resource.array_size.value_or(1)); |
| DAWN_INVALID_IF(resource.array_size.has_value() && |
| deviceInfo.toggles.Has(Toggle::DisableBindGroupLayoutEntryArraySize), |
| "Use of binding_array is disabled."); |
| DAWN_INVALID_IF( |
| resource.array_size.has_value() && !deviceInfo.toggles.Has(Toggle::AllowUnsafeAPIs), |
| "Use of binding_array is disabled as an unsafe API."); |
| DAWN_INVALID_IF(info.arraySize == BindingIndex(0), "binding_array size is 0."); |
| if (DelayedInvalidIf( |
| info.arraySize >= BindingIndex(kMaxBindingsPerBindGroup), |
| "binding_array size (%u) exceeds the maxBindingsPerBindGroup (%u) - 1.", |
| info.arraySize, kMaxBindingsPerBindGroup)) { |
| continue; |
| } |
| |
| switch (TintResourceTypeToBindingInfoType(resource.resource_type)) { |
| case BindingInfoType::Buffer: { |
| BufferBindingInfo bindingInfo = {}; |
| bindingInfo.minBindingSize = resource.size; |
| DAWN_TRY_ASSIGN(bindingInfo.type, |
| TintResourceTypeToBufferBindingType(resource.resource_type)); |
| info.bindingInfo = bindingInfo; |
| break; |
| } |
| |
| case BindingInfoType::Sampler: { |
| SamplerBindingInfo bindingInfo = {}; |
| switch (resource.resource_type) { |
| case tint::inspector::ResourceBinding::ResourceType::kSampler: |
| bindingInfo.type = wgpu::SamplerBindingType::Filtering; |
| break; |
| case tint::inspector::ResourceBinding::ResourceType::kComparisonSampler: |
| bindingInfo.type = wgpu::SamplerBindingType::Comparison; |
| break; |
| default: |
| DAWN_UNREACHABLE(); |
| } |
| info.bindingInfo = bindingInfo; |
| break; |
| } |
| |
| case BindingInfoType::Texture: { |
| TextureBindingInfo bindingInfo = {}; |
| bindingInfo.viewDimension = |
| TintTextureDimensionToTextureViewDimension(resource.dim); |
| if (resource.resource_type == |
| tint::inspector::ResourceBinding::ResourceType::kDepthTexture || |
| resource.resource_type == |
| tint::inspector::ResourceBinding::ResourceType::kDepthMultisampledTexture) { |
| bindingInfo.sampleType = wgpu::TextureSampleType::Depth; |
| } else { |
| bindingInfo.sampleType = TintSampledKindToSampleType(resource.sampled_kind); |
| } |
| bindingInfo.multisampled = |
| resource.resource_type == |
| tint::inspector::ResourceBinding::ResourceType::kMultisampledTexture || |
| resource.resource_type == |
| tint::inspector::ResourceBinding::ResourceType::kDepthMultisampledTexture; |
| info.bindingInfo = bindingInfo; |
| break; |
| } |
| |
| case BindingInfoType::StorageTexture: { |
| StorageTextureBindingInfo bindingInfo = {}; |
| DAWN_TRY_ASSIGN(bindingInfo.access, |
| TintResourceTypeToStorageTextureAccess(resource.resource_type)); |
| bindingInfo.format = TintImageFormatToTextureFormat(resource.image_format); |
| bindingInfo.viewDimension = |
| TintTextureDimensionToTextureViewDimension(resource.dim); |
| |
| info.bindingInfo = bindingInfo; |
| break; |
| } |
| |
| case BindingInfoType::ExternalTexture: { |
| info.bindingInfo.emplace<ExternalTextureBindingInfo>(); |
| break; |
| } |
| case BindingInfoType::StaticSampler: { |
| return DAWN_VALIDATION_ERROR("Static samplers not supported in WGSL"); |
| } |
| case BindingInfoType::InputAttachment: { |
| InputAttachmentBindingInfo bindingInfo = {}; |
| bindingInfo.sampleType = TintSampledKindToSampleType(resource.sampled_kind); |
| info.bindingInfo = bindingInfo; |
| break; |
| } |
| default: |
| return DAWN_VALIDATION_ERROR("Unknown binding type in Shader"); |
| } |
| |
| BindGroupIndex bindGroupIndex(resource.bind_group); |
| if (DelayedInvalidIf(bindGroupIndex >= kMaxBindGroupsTyped, |
| "The entry-point uses a binding with a group decoration (%u) " |
| "that exceeds maxBindGroups (%u) - 1.", |
| resource.bind_group, kMaxBindGroups)) { |
| continue; |
| } |
| |
| BindingNumber bindingNumber(resource.binding); |
| if (DelayedInvalidIf( |
| bindingNumber >= kMaxBindingsPerBindGroupTyped, |
| "Binding number (%u) exceeds the maxBindingsPerBindGroup limit (%u) - 1.", |
| uint32_t(bindingNumber), kMaxBindingsPerBindGroup)) { |
| continue; |
| } |
| |
| const auto& [binding, inserted] = |
| metadata->bindings[bindGroupIndex].emplace(bindingNumber, info); |
| DAWN_INVALID_IF(!inserted, |
| "Entry-point has a duplicate binding for (group:%u, binding:%u).", |
| resource.binding, resource.bind_group); |
| } |
| |
| // Sampler binding point placeholder for non-sampler texture usage. Make it |
| // ToTint(EntryPointMetadata::nonSamplerBindingPoint), so that we have |
| // FromTint(tintNonSamplerBindingPoint) == EntryPointMetadata::nonSamplerBindingPoint, and we |
| // don't need to explicitly check if a tint BindingPoint is tintNonSamplerBindingPoint when |
| // converting them to BindingSlot. |
| constexpr tint::BindingPoint tintNonSamplerBindingPoint = |
| ToTint(EntryPointMetadata::nonSamplerBindingPoint); |
| static_assert(FromTint(tintNonSamplerBindingPoint) == |
| EntryPointMetadata::nonSamplerBindingPoint); |
| |
| // Reflection of combined sampler and texture uses. |
| const auto samplerAndNonSamplerTextureUses = |
| inspector->GetSamplerAndNonSamplerTextureUses(entryPoint.name, tintNonSamplerBindingPoint); |
| |
| metadata->samplerAndNonSamplerTexturePairs.reserve(samplerAndNonSamplerTextureUses.size()); |
| std::transform(samplerAndNonSamplerTextureUses.cbegin(), samplerAndNonSamplerTextureUses.cend(), |
| std::back_inserter(metadata->samplerAndNonSamplerTexturePairs), |
| [](const tint::inspector::SamplerTexturePair& pair) { |
| EntryPointMetadata::SamplerTexturePair result; |
| // The sampler binding point might be tintNonSamplerBindingPoint for |
| // non-sampler texture usages, and FromTint maps it to |
| // EntryPointMetadata::nonSamplerBindingPoint according to the definition of |
| // tintNonSamplerBindingPoint. |
| result.sampler = FromTint(pair.sampler_binding_point); |
| result.texture = FromTint(pair.texture_binding_point); |
| return result; |
| }); |
| |
| auto textureQueries = inspector->GetTextureQueries(entryPoint.name); |
| metadata->textureQueries.reserve(textureQueries.size()); |
| std::transform(textureQueries.begin(), textureQueries.end(), |
| std::back_inserter(metadata->textureQueries), FromTintLevelSampleInfo); |
| |
| metadata->usesSubgroupMatrix = entryPoint.uses_subgroup_matrix; |
| |
| // Compute the texture+sampler combination count. |
| if (deviceInfo.isCompatibilityMode) { |
| // separate sampled from non-sampled and put sampled in set |
| std::set<tint::BindingPoint> sampledTextures; |
| std::set<tint::BindingPoint> sampledExternalTextures; |
| std::vector<tint::BindingPoint> nonSampled; |
| uint32_t numSamplerTexturePairs = 0; |
| uint32_t numSamplerExternalTexturePairs = 0; |
| |
| for (const auto& pair : samplerAndNonSamplerTextureUses) { |
| const auto& bindingGroupInfoMap = |
| metadata->bindings[BindGroupIndex(pair.texture_binding_point.group)]; |
| const auto it = |
| bindingGroupInfoMap.find(BindingNumber(pair.texture_binding_point.binding)); |
| auto isExternalTexture = |
| std::holds_alternative<ExternalTextureBindingInfo>(it->second.bindingInfo); |
| if (isExternalTexture) { |
| ++numSamplerExternalTexturePairs; |
| sampledExternalTextures.insert(pair.texture_binding_point); |
| } else if (pair.sampler_binding_point == tintNonSamplerBindingPoint) { |
| nonSampled.push_back(pair.texture_binding_point); |
| } else { |
| ++numSamplerTexturePairs; |
| sampledTextures.insert(pair.texture_binding_point); |
| } |
| } |
| |
| // count the number of non-sampled that are not referenced by sampled pairs. |
| auto numNonSampled = |
| std::count_if(nonSampled.begin(), nonSampled.end(), |
| [&](const tint::BindingPoint& nonSampledBindingPoint) { |
| return !sampledTextures.contains(nonSampledBindingPoint); |
| }); |
| metadata->numTextureSamplerCombinations = numSamplerTexturePairs + numNonSampled + |
| numSamplerExternalTexturePairs * 3 + |
| sampledExternalTextures.size(); |
| } |
| |
| #undef DelayedInvalidIf |
| return std::move(metadata); |
| } |
| |
| void ReflectShaderUsingTint(const ShaderModuleParseDeviceInfo& deviceInfo, |
| ShaderModuleParseResult* outputParseResult) { |
| DAWN_ASSERT(outputParseResult->HasTintProgram()); |
| const tint::Program* program = |
| &outputParseResult->tintProgram.UnsafeGetValue().value().Get()->program; |
| DAWN_ASSERT(program && program->IsValid()); |
| |
| tint::inspector::Inspector inspector(*program); |
| |
| std::vector<tint::inspector::EntryPoint> entryPoints = inspector.GetEntryPoints(); |
| if (inspector.has_error()) { |
| outputParseResult->SetValidationError( |
| DAWN_VALIDATION_ERROR("Tint Reflection failure: Inspector: %s\n", inspector.error())); |
| return; |
| } |
| |
| // A ShaderModuleParseResult should get reflected at most once. |
| DAWN_ASSERT(!outputParseResult->metadataTable.has_value()); |
| EntryPointMetadataTable& metadataTable = outputParseResult->metadataTable.emplace(); |
| |
| for (const tint::inspector::EntryPoint& entryPoint : entryPoints) { |
| auto entryPointReflectionResult = |
| ReflectEntryPointUsingTint(deviceInfo, &inspector, entryPoint); |
| // If validation error occurs, store the error into output parse result, drop the incomplete |
| // metadate table, and stop reflection. |
| if (entryPointReflectionResult.IsError()) { |
| auto error = entryPointReflectionResult.AcquireError(); |
| error->AppendContext( |
| absl::StrFormat("processing entry point \"%s\".", entryPoint.name)); |
| // The incomplete metadate table is also dropped in SetValidationError. |
| outputParseResult->SetValidationError(std::move(error)); |
| return; |
| } |
| // Otherwise add the reflection to metadata table. |
| auto reflection = entryPointReflectionResult.AcquireSuccess(); |
| DAWN_ASSERT(!metadataTable.contains(entryPoint.name)); |
| metadataTable.emplace(entryPoint.name, std::move(reflection)); |
| } |
| } |
| } // anonymous namespace |
| |
| ResultOrError<Extent3D> ValidateComputeStageWorkgroupSize( |
| const tint::Program& program, |
| const char* entryPointName, |
| bool usesSubgroupMatrix, |
| uint32_t maxSubgroupSize, |
| const LimitsForCompilationRequest& limits, |
| const LimitsForCompilationRequest& adaterSupportedlimits) { |
| tint::inspector::Inspector inspector(program); |
| |
| // At this point the entry point must exist and must have workgroup size values. |
| tint::inspector::EntryPoint entryPoint = inspector.GetEntryPoint(entryPointName); |
| DAWN_ASSERT(entryPoint.workgroup_size.has_value()); |
| const tint::inspector::WorkgroupSize& workgroup_size = entryPoint.workgroup_size.value(); |
| |
| return ValidateComputeStageWorkgroupSize(workgroup_size.x, workgroup_size.y, workgroup_size.z, |
| entryPoint.workgroup_storage_size, usesSubgroupMatrix, |
| maxSubgroupSize, limits, adaterSupportedlimits); |
| } |
| |
| ResultOrError<Extent3D> ValidateComputeStageWorkgroupSize( |
| uint32_t x, |
| uint32_t y, |
| uint32_t z, |
| size_t workgroupStorageSize, |
| bool usesSubgroupMatrix, |
| uint32_t maxSubgroupSize, |
| const LimitsForCompilationRequest& limits, |
| const LimitsForCompilationRequest& adaterSupportedlimits) { |
| DAWN_INVALID_IF(x < 1 || y < 1 || z < 1, |
| "Entry-point uses workgroup_size(%u, %u, %u) that are below the " |
| "minimum allowed (1, 1, 1).", |
| x, y, z); |
| |
| if (x > limits.maxComputeWorkgroupSizeX || y > limits.maxComputeWorkgroupSizeY || |
| z > limits.maxComputeWorkgroupSizeZ) [[unlikely]] { |
| uint32_t maxComputeWorkgroupSizeXAdapterLimit = |
| adaterSupportedlimits.maxComputeWorkgroupSizeX; |
| uint32_t maxComputeWorkgroupSizeYAdapterLimit = |
| adaterSupportedlimits.maxComputeWorkgroupSizeY; |
| uint32_t maxComputeWorkgroupSizeZAdapterLimit = |
| adaterSupportedlimits.maxComputeWorkgroupSizeZ; |
| std::string increaseLimitAdvice = |
| (x <= maxComputeWorkgroupSizeXAdapterLimit && |
| y <= maxComputeWorkgroupSizeYAdapterLimit && z <= maxComputeWorkgroupSizeZAdapterLimit) |
| ? absl::StrFormat( |
| " This adapter supports higher maxComputeWorkgroupSizeX of %u, " |
| "maxComputeWorkgroupSizeY of %u, and maxComputeWorkgroupSizeZ of %u, which " |
| "can be specified in requiredLimits when calling requestDevice(). Limits " |
| "differ by hardware, so always check the adapter limits prior to requesting " |
| "a higher limit.", |
| maxComputeWorkgroupSizeXAdapterLimit, maxComputeWorkgroupSizeYAdapterLimit, |
| maxComputeWorkgroupSizeZAdapterLimit) |
| : ""; |
| return DAWN_VALIDATION_ERROR( |
| "Entry-point uses workgroup_size(%u, %u, %u) that exceeds the " |
| "maximum allowed (%u, %u, %u).%s", |
| x, y, z, limits.maxComputeWorkgroupSizeX, limits.maxComputeWorkgroupSizeY, |
| limits.maxComputeWorkgroupSizeZ, increaseLimitAdvice); |
| } |
| |
| uint64_t numInvocations = static_cast<uint64_t>(x) * y * z; |
| uint32_t maxComputeInvocationsPerWorkgroup = limits.maxComputeInvocationsPerWorkgroup; |
| DAWN_INVALID_IF(numInvocations > maxComputeInvocationsPerWorkgroup, |
| "The total number of workgroup invocations (%u) exceeds the " |
| "maximum allowed (%u).%s", |
| numInvocations, maxComputeInvocationsPerWorkgroup, |
| DAWN_INCREASE_LIMIT_MESSAGE(adaterSupportedlimits, |
| maxComputeInvocationsPerWorkgroup, numInvocations)); |
| |
| uint32_t maxComputeWorkgroupStorageSize = limits.maxComputeWorkgroupStorageSize; |
| DAWN_INVALID_IF( |
| workgroupStorageSize > maxComputeWorkgroupStorageSize, |
| "The total use of workgroup storage (%u bytes) is larger than " |
| "the maximum allowed (%u bytes).%s", |
| workgroupStorageSize, maxComputeWorkgroupStorageSize, |
| DAWN_INCREASE_LIMIT_MESSAGE(adaterSupportedlimits, maxComputeWorkgroupStorageSize, |
| workgroupStorageSize)); |
| |
| if (usesSubgroupMatrix) { |
| // maxSubgroupSize must have a valid value if usesSubgroupMatrix is true and subgroups |
| // feature is supported. |
| DAWN_ASSERT(maxSubgroupSize > 0); |
| DAWN_INVALID_IF((x % maxSubgroupSize) != 0, |
| "The x-dimension of workgroup_size (%u) must be a multiple of the device " |
| "maxSubgroupSize (%u) when the shader uses a subgroup matrix", |
| x, maxSubgroupSize); |
| } |
| |
| return Extent3D{x, y, z}; |
| } |
| |
| CachedValidationError::CachedValidationError(std::unique_ptr<ErrorData>&& errorData) { |
| DAWN_ASSERT(errorData->GetType() == InternalErrorType::Validation); |
| message = errorData->GetMessage(); |
| contexts = errorData->GetContexts(); |
| DAWN_ASSERT(!message.empty()); |
| } |
| |
| std::unique_ptr<ErrorData> CachedValidationError::ToErrorData() const { |
| DAWN_ASSERT(!message.empty()); |
| auto error = std::make_unique<ErrorData>(InternalErrorType::Validation, message); |
| std::for_each(contexts.begin(), contexts.end(), [&error](auto c) { error->AppendContext(c); }); |
| return error; |
| } |
| |
| bool ShaderModuleParseResult::HasTintProgram() const { |
| return tintProgram.UnsafeGetValue().has_value() && |
| tintProgram.UnsafeGetValue().value() != nullptr; |
| } |
| |
| bool ShaderModuleParseResult::HasError() const { |
| // If cachedValidationError holds error, it must have non-empty error message string. |
| DAWN_ASSERT(!cachedValidationError.has_value() || !cachedValidationError->message.empty()); |
| return cachedValidationError.has_value(); |
| } |
| |
| std::unique_ptr<ErrorData> ShaderModuleParseResult::ToErrorData() const { |
| DAWN_ASSERT(HasError()); |
| return cachedValidationError->ToErrorData(); |
| } |
| |
| void ShaderModuleParseResult::SetValidationError(std::unique_ptr<ErrorData>&& errorData) { |
| DAWN_ASSERT(errorData->GetType() == InternalErrorType::Validation); |
| cachedValidationError = CachedValidationError(std::move(errorData)); |
| // If validation error occurs, clear the Tint program and metadata table. |
| tintProgram.UnsafeGetValue().reset(); |
| metadataTable.reset(); |
| DAWN_ASSERT(HasError()); |
| } |
| |
| void DumpShaderFromDescriptor(LogEmitter* logEmitter, |
| const UnpackedPtr<ShaderModuleDescriptor>& shaderModuleDesc) { |
| #if TINT_BUILD_SPV_READER |
| if ([[maybe_unused]] const auto* spirvDesc = shaderModuleDesc.Get<ShaderSourceSPIRV>()) { |
| // Dump SPIR-V if enabled. |
| #ifdef DAWN_ENABLE_SPIRV_VALIDATION |
| DumpSpirv(logEmitter, spirvDesc->code, spirvDesc->codeSize); |
| #endif // DAWN_ENABLE_SPIRV_VALIDATION |
| return; |
| } |
| #else // TINT_BUILD_SPV_READER |
| // SPIR-V is not enabled, so the descriptor should not contain it. |
| DAWN_ASSERT(shaderModuleDesc.Get<ShaderSourceSPIRV>() == nullptr); |
| #endif // TINT_BUILD_SPV_READER |
| |
| // Dump WGSL. |
| const ShaderSourceWGSL* wgslDesc = shaderModuleDesc.Get<ShaderSourceWGSL>(); |
| DAWN_ASSERT(wgslDesc != nullptr); |
| std::ostringstream dumpedMsg; |
| dumpedMsg << "// Dumped WGSL:\n" << std::string_view(wgslDesc->code) << "\n"; |
| logEmitter->EmitLog(wgpu::LoggingType::Info, dumpedMsg.str().c_str()); |
| } |
| |
| ResultOrError<ShaderModuleParseResult> ParseShaderModule(ShaderModuleParseRequest req) { |
| ShaderModuleParseResult outputParseResult; |
| |
| const ShaderModuleParseDeviceInfo& deviceInfo = req.deviceInfo; |
| |
| #if TINT_BUILD_SPV_READER |
| // Handling SPIR-V if enabled. |
| if (std::holds_alternative<ShaderModuleParseSpirvDescription>(req.shaderDescription)) { |
| // SpirV toggle should have been validated before checking cache. |
| DAWN_ASSERT(!deviceInfo.toggles.Has(Toggle::DisallowSpirv)); |
| |
| ShaderModuleParseSpirvDescription& spirvDesc = |
| std::get<ShaderModuleParseSpirvDescription>(req.shaderDescription); |
| const std::vector<uint32_t>& spirvCode = spirvDesc.spirvCode.UnsafeGetValue(); |
| |
| #ifdef DAWN_ENABLE_SPIRV_VALIDATION |
| MaybeError validationResult = |
| ValidateSpirv(req.logEmitter.UnsafeGetValue(), spirvCode.data(), spirvCode.size()); |
| // If SpirV validation error occurs, store it into outputParseResult and return. |
| if (validationResult.IsError()) { |
| outputParseResult.SetValidationError(validationResult.AcquireError()); |
| } |
| #endif // DAWN_ENABLE_SPIRV_VALIDATION |
| // Try parsing SpirV if no validation error. |
| if (!outputParseResult.HasError()) { |
| DAWN_TRY(ParseSPIRV(spirvCode, deviceInfo.wgslAllowedFeatures, &outputParseResult, |
| spirvDesc.allowNonUniformDerivatives)); |
| } |
| } |
| #else // TINT_BUILD_SPV_READER |
| // SPIR-V is not enabled, so the descriptor should not contain it. |
| DAWN_ASSERT(!std::holds_alternative<ShaderModuleParseSpirvDescription>(req.shaderDescription)); |
| #endif // TINT_BUILD_SPV_READER |
| |
| // Handling WGSL. |
| if (std::holds_alternative<ShaderModuleParseWGSLDescription>(req.shaderDescription)) { |
| ShaderModuleParseWGSLDescription wgslDesc = |
| std::get<ShaderModuleParseWGSLDescription>(req.shaderDescription); |
| const std::vector<tint::wgsl::Extension>& internalExtensions = |
| wgslDesc.internalExtensions.UnsafeGetValue(); |
| const StringView& wgsl = wgslDesc.wgsl.UnsafeGetValue(); |
| auto tintFile = std::make_unique<tint::Source::File>("", wgsl); |
| |
| DAWN_TRY(ParseWGSL(std::move(tintFile), deviceInfo.wgslAllowedFeatures, internalExtensions, |
| &outputParseResult)); |
| } |
| |
| // Generate reflection information if required and parsed succeed. |
| if (outputParseResult.HasTintProgram() && req.needReflection) { |
| ReflectShaderUsingTint(deviceInfo, &outputParseResult); |
| } |
| |
| // Assert everything succeed and we have a Tint program, xor validation error occurs and we only |
| // get error with no Tint program (not generated or get removed). |
| DAWN_ASSERT(outputParseResult.HasTintProgram() != outputParseResult.HasError()); |
| return outputParseResult; |
| } |
| |
| RequiredBufferSizes ComputeRequiredBufferSizesForLayout(const EntryPointMetadata& entryPoint, |
| const PipelineLayoutBase* layout) { |
| RequiredBufferSizes bufferSizes; |
| for (BindGroupIndex group : layout->GetBindGroupLayoutsMask()) { |
| bufferSizes[group] = GetBindGroupMinBufferSizes(entryPoint.bindings[group], |
| layout->GetBindGroupLayout(group)); |
| } |
| |
| return bufferSizes; |
| } |
| |
| MaybeError ValidateCompatibilityWithPipelineLayout(DeviceBase* device, |
| const EntryPointMetadata& entryPoint, |
| const PipelineLayoutBase* layout) { |
| for (BindGroupIndex group : layout->GetBindGroupLayoutsMask()) { |
| DAWN_TRY_CONTEXT(ValidateCompatibilityWithBindGroupLayout( |
| device, group, entryPoint, layout->GetBindGroupLayout(group)), |
| "validating the entry-point's compatibility for group %u with %s", group, |
| layout->GetBindGroupLayout(group)); |
| } |
| |
| for (BindGroupIndex group : ~layout->GetBindGroupLayoutsMask()) { |
| DAWN_INVALID_IF(entryPoint.bindings[group].size() > 0, |
| "The entry-point uses bindings in group %u but %s doesn't have a " |
| "BindGroupLayout for this index", |
| group, layout); |
| } |
| |
| // Validate that filtering samplers are not used with unfilterable textures. |
| for (const auto& pair : entryPoint.samplerAndNonSamplerTexturePairs) { |
| // Skip non-sampler textures. |
| if (pair.sampler == EntryPointMetadata::nonSamplerBindingPoint) { |
| continue; |
| } |
| const BindGroupLayoutInternalBase* samplerBGL = |
| layout->GetBindGroupLayout(pair.sampler.group); |
| const BindingInfo& samplerInfo = |
| samplerBGL->GetBindingInfo(samplerBGL->GetBindingIndex(pair.sampler.binding)); |
| bool samplerIsFiltering = false; |
| if (std::holds_alternative<StaticSamplerBindingInfo>(samplerInfo.bindingLayout)) { |
| const StaticSamplerBindingInfo& samplerLayout = |
| std::get<StaticSamplerBindingInfo>(samplerInfo.bindingLayout); |
| samplerIsFiltering = samplerLayout.sampler->IsFiltering(); |
| } else { |
| const SamplerBindingInfo& samplerLayout = |
| std::get<SamplerBindingInfo>(samplerInfo.bindingLayout); |
| samplerIsFiltering = (samplerLayout.type == wgpu::SamplerBindingType::Filtering); |
| } |
| if (!samplerIsFiltering) { |
| continue; |
| } |
| const BindGroupLayoutInternalBase* textureBGL = |
| layout->GetBindGroupLayout(pair.texture.group); |
| const BindingInfo& textureInfo = |
| textureBGL->GetBindingInfo(textureBGL->GetBindingIndex(pair.texture.binding)); |
| const TextureBindingInfo& sampledTextureBindingInfo = |
| std::get<TextureBindingInfo>(textureInfo.bindingLayout); |
| |
| DAWN_INVALID_IF( |
| sampledTextureBindingInfo.sampleType != wgpu::TextureSampleType::Float && |
| sampledTextureBindingInfo.sampleType != kInternalResolveAttachmentSampleType, |
| "Texture binding (group:%u, binding:%u) is %s but used statically with a sampler " |
| "(group:%u, binding:%u) that's %s", |
| pair.texture.group, pair.texture.binding, sampledTextureBindingInfo.sampleType, |
| pair.sampler.group, pair.sampler.binding, wgpu::SamplerBindingType::Filtering); |
| } |
| |
| // Validate compatibility of the pixel local storage. |
| if (entryPoint.usesPixelLocal) { |
| DAWN_INVALID_IF(!layout->HasPixelLocalStorage(), |
| "The entry-point uses `pixel_local` block but the pipeline layout doesn't " |
| "contain a pixel local storage."); |
| |
| // TODO(dawn:1704): Allow entryPoint.pixelLocalBlockSize < layoutPixelLocalSize. |
| auto layoutStorageAttachments = layout->GetStorageAttachmentSlots(); |
| size_t layoutPixelLocalSize = layoutStorageAttachments.size() * kPLSSlotByteSize; |
| DAWN_INVALID_IF(entryPoint.pixelLocalBlockSize != layoutPixelLocalSize, |
| "The entry-point's pixel local block size (%u) is different from the " |
| "layout's total pixel local size (%u).", |
| entryPoint.pixelLocalBlockSize, layoutPixelLocalSize); |
| |
| for (size_t i = 0; i < entryPoint.pixelLocalMembers.size(); i++) { |
| wgpu::TextureFormat layoutFormat = layoutStorageAttachments[i]; |
| |
| // TODO(dawn:1704): Allow format conversions by injecting them in the shader |
| // automatically. |
| PixelLocalMemberType expectedType; |
| switch (layoutFormat) { |
| case wgpu::TextureFormat::R32Sint: |
| expectedType = PixelLocalMemberType::I32; |
| break; |
| case wgpu::TextureFormat::R32Float: |
| expectedType = PixelLocalMemberType::F32; |
| break; |
| case wgpu::TextureFormat::R32Uint: |
| case wgpu::TextureFormat::Undefined: |
| expectedType = PixelLocalMemberType::U32; |
| break; |
| |
| default: |
| DAWN_UNREACHABLE(); |
| } |
| |
| PixelLocalMemberType entryPointType = entryPoint.pixelLocalMembers[i]; |
| DAWN_INVALID_IF( |
| expectedType != entryPointType, |
| "The `pixel_local` block's member at index %u has a type (%s) that's not " |
| "compatible with the layout's storage format (%s), the expected type is %s.", |
| i, entryPointType, layoutFormat, expectedType); |
| } |
| } else { |
| // TODO(dawn:1704): Allow a fragment entry-point without PLS to be used with a layout that |
| // has PLS. |
| DAWN_INVALID_IF(entryPoint.stage == SingleShaderStage::Fragment && |
| !layout->GetStorageAttachmentSlots().empty(), |
| "The layout contains a (non-empty) pixel local storage but the entry-point " |
| "doesn't use a `pixel local` block."); |
| } |
| |
| // Validate that immediate data used by programmable state are smaller than pipelineLayout |
| // immediate data range bytes. |
| DAWN_INVALID_IF(entryPoint.immediateDataRangeByteSize > layout->GetImmediateDataRangeByteSize(), |
| "The entry-point uses more bytes of immediate data (%u) than the reserved " |
| "amount (%u) in %s.", |
| entryPoint.immediateDataRangeByteSize, layout->GetImmediateDataRangeByteSize(), |
| layout); |
| |
| return {}; |
| } |
| |
| // ShaderModuleBase |
| ShaderModuleBase::ShaderModuleBase(DeviceBase* device, |
| const UnpackedPtr<ShaderModuleDescriptor>& descriptor, |
| std::vector<tint::wgsl::Extension> internalExtensions, |
| ApiObjectBase::UntrackedByDeviceTag tag) |
| : Base(device, descriptor->label), |
| mType(Type::Undefined), |
| mInternalExtensions(std::move(internalExtensions)) { |
| size_t shaderCodeByteSize = 0; |
| uint8_t* shaderCode = nullptr; |
| |
| if (auto* spirvDesc = descriptor.Get<ShaderSourceSPIRV>()) { |
| mType = Type::Spirv; |
| mOriginalSpirv.assign(spirvDesc->code, spirvDesc->code + spirvDesc->codeSize); |
| shaderCodeByteSize = mOriginalSpirv.size() * sizeof(decltype(mOriginalSpirv)::value_type); |
| shaderCode = reinterpret_cast<uint8_t*>(mOriginalSpirv.data()); |
| } else if (auto* wgslDesc = descriptor.Get<ShaderSourceWGSL>()) { |
| mType = Type::Wgsl; |
| mWgsl = std::string(wgslDesc->code); |
| shaderCodeByteSize = mWgsl.size() * sizeof(decltype(mWgsl)::value_type); |
| shaderCode = reinterpret_cast<uint8_t*>(mWgsl.data()); |
| } else { |
| DAWN_ASSERT(false); |
| } |
| |
| if (const auto* compileOptions = descriptor.Get<ShaderModuleCompilationOptions>()) { |
| mStrictMath = compileOptions->strictMath; |
| } |
| |
| ShaderModuleHasher hasher; |
| // Hash the metadata. |
| hasher.Update(mType); |
| // mStrictMath is a std::optional<bool>, and the bool value might not get initialized by default |
| // constructor and thus contains dirty data. |
| bool strictMathAssigned = mStrictMath.has_value(); |
| bool strictMathValue = mStrictMath.value_or(false); |
| hasher.Update(strictMathAssigned); |
| hasher.Update(strictMathValue); |
| // mInternalExtensions is a length-variable vector, so we need to hash its size and its content |
| // if any. |
| hasher.Update(mInternalExtensions.size()); |
| hasher.Update(mInternalExtensions.data(), |
| mInternalExtensions.size() * sizeof(decltype(mInternalExtensions)::value_type)); |
| // Hash the shader code and its size. |
| hasher.Update(shaderCodeByteSize); |
| hasher.Update(shaderCode, shaderCodeByteSize); |
| |
| mHash = hasher.Finalize(); |
| } |
| |
| ShaderModuleBase::ShaderModuleBase(DeviceBase* device, |
| const UnpackedPtr<ShaderModuleDescriptor>& descriptor, |
| std::vector<tint::wgsl::Extension> internalExtensions) |
| : ShaderModuleBase(device, descriptor, std::move(internalExtensions), kUntrackedByDevice) { |
| GetObjectTrackingList()->Track(this); |
| } |
| |
| ShaderModuleBase::ShaderModuleBase(DeviceBase* device, |
| ObjectBase::ErrorTag tag, |
| StringView label, |
| ParsedCompilationMessages&& compilationMessages) |
| : Base(device, tag, label), |
| mType(Type::Undefined), |
| mCompilationMessages( |
| std::make_unique<OwnedCompilationMessages>(std::move(compilationMessages))) {} |
| |
| ShaderModuleBase::~ShaderModuleBase() = default; |
| |
| void ShaderModuleBase::DestroyImpl() { |
| Uncache(); |
| } |
| |
| // static |
| Ref<ShaderModuleBase> ShaderModuleBase::MakeError(DeviceBase* device, |
| StringView label, |
| ParsedCompilationMessages&& compilationMessages) { |
| return AcquireRef( |
| new ShaderModuleBase(device, ObjectBase::kError, label, std::move(compilationMessages))); |
| } |
| |
| ObjectType ShaderModuleBase::GetType() const { |
| return ObjectType::ShaderModule; |
| } |
| |
| bool ShaderModuleBase::HasEntryPoint(absl::string_view entryPoint) const { |
| return mEntryPoints.contains(entryPoint); |
| } |
| |
| ShaderModuleEntryPoint ShaderModuleBase::ReifyEntryPointName(StringView entryPointName, |
| SingleShaderStage stage) const { |
| ShaderModuleEntryPoint entryPoint; |
| if (entryPointName.IsUndefined()) { |
| entryPoint.defaulted = true; |
| entryPoint.name = mDefaultEntryPointNames[stage]; |
| } else { |
| entryPoint.defaulted = false; |
| entryPoint.name = entryPointName; |
| } |
| return entryPoint; |
| } |
| |
| std::optional<bool> ShaderModuleBase::GetStrictMath() const { |
| return mStrictMath; |
| } |
| |
| const EntryPointMetadata& ShaderModuleBase::GetEntryPoint(absl::string_view entryPoint) const { |
| DAWN_ASSERT(HasEntryPoint(entryPoint)); |
| return *mEntryPoints.at(entryPoint); |
| } |
| |
| size_t ShaderModuleBase::ComputeContentHash() { |
| ObjectContentHasher recorder; |
| // Use mHash to represent the source content, which includes shader source and metadata. |
| recorder.Record(mHash); |
| return recorder.GetContentHash(); |
| } |
| |
| bool ShaderModuleBase::EqualityFunc::operator()(const ShaderModuleBase* a, |
| const ShaderModuleBase* b) const { |
| bool membersEq = a->mType == b->mType && a->mOriginalSpirv == b->mOriginalSpirv && |
| a->mWgsl == b->mWgsl && a->mStrictMath == b->mStrictMath; |
| // Assert that the hash is equal if and only if the members are equal. |
| DAWN_ASSERT(membersEq == (a->mHash == b->mHash)); |
| return membersEq; |
| } |
| |
| const ShaderModuleBase::ShaderModuleHash& ShaderModuleBase::GetHash() const { |
| return mHash; |
| } |
| |
| ShaderModuleBase::ScopedUseTintProgram ShaderModuleBase::UseTintProgram() { |
| // Directly return ScopedUseTintProgram to add ref count. If the mTintProgram is valid, |
| // this will prevent it from being released before using. If it is already released, |
| // it will be recreated in the GetTintProgram, right before actually using it. |
| return ScopedUseTintProgram(this); |
| } |
| |
| Ref<TintProgram> ShaderModuleBase::GetTintProgram() { |
| return mTintData.Use([&](auto tintData) { |
| // If the tintProgram is valid, just return it. |
| if (tintData->tintProgram) { |
| return tintData->tintProgram; |
| } |
| // Otherwise, recreate the tintProgram. When the ShaderModuleBase is not referenced |
| // externally, and not used for initializing any pipeline, the mTintProgram will be |
| // released. However the ShaderModuleBase itself may still alive due to being referenced by |
| // some pipelines. In this case, when DeviceBase::APICreateShaderModule() with the same |
| // shader source code, Dawn will look up from the cache and return the same |
| // ShaderModuleBase. In this case, we have to recreate the released mTintProgram for |
| // initializing new pipelines. |
| ShaderModuleDescriptor descriptor; |
| ShaderSourceWGSL wgslDescriptor; |
| ShaderSourceSPIRV spirvDescriptor; |
| |
| switch (mType) { |
| case Type::Spirv: |
| spirvDescriptor.codeSize = mOriginalSpirv.size(); |
| spirvDescriptor.code = mOriginalSpirv.data(); |
| descriptor.nextInChain = &spirvDescriptor; |
| break; |
| case Type::Wgsl: |
| wgslDescriptor.code = std::string_view(mWgsl); |
| descriptor.nextInChain = &wgslDescriptor; |
| break; |
| default: |
| DAWN_UNREACHABLE(); |
| } |
| |
| // Assuming ParseShaderModule will not throw error for regenerating. |
| ShaderModuleParseResult regeneratedParseResult = |
| ParseShaderModule(BuildShaderModuleParseRequest(GetDevice(), mHash, Unpack(&descriptor), |
| mInternalExtensions, |
| /* needReflection */ false)) |
| .AcquireSuccess(); |
| DAWN_ASSERT(regeneratedParseResult.HasTintProgram() && !regeneratedParseResult.HasError()); |
| |
| tintData->tintProgram = |
| std::move(regeneratedParseResult.tintProgram.UnsafeGetValue().value()); |
| tintData->tintProgramRecreateCount++; |
| |
| return tintData->tintProgram; |
| }); |
| } |
| |
| Ref<TintProgram> ShaderModuleBase::GetNullableTintProgramForTesting() const { |
| return mTintData.Use([&](auto tintData) { return tintData->tintProgram; }); |
| } |
| |
| int ShaderModuleBase::GetTintProgramRecreateCountForTesting() const { |
| return mTintData.Use([&](auto tintData) { return tintData->tintProgramRecreateCount; }); |
| } |
| |
| Future ShaderModuleBase::APIGetCompilationInfo( |
| const WGPUCompilationInfoCallbackInfo& callbackInfo) { |
| struct CompilationInfoEvent final : public EventManager::TrackedEvent { |
| WGPUCompilationInfoCallback mCallback; |
| raw_ptr<void> mUserdata1; |
| raw_ptr<void> mUserdata2; |
| // Need to keep a Ref of the compilation messages in case the ShaderModule goes away before |
| // the callback happens. |
| Ref<ShaderModuleBase> mShaderModule; |
| |
| CompilationInfoEvent(const WGPUCompilationInfoCallbackInfo& callbackInfo, |
| Ref<ShaderModuleBase> shaderModule) |
| : TrackedEvent(static_cast<wgpu::CallbackMode>(callbackInfo.mode), |
| TrackedEvent::Completed{}), |
| mCallback(callbackInfo.callback), |
| mUserdata1(callbackInfo.userdata1), |
| mUserdata2(callbackInfo.userdata2), |
| mShaderModule(std::move(shaderModule)) {} |
| |
| ~CompilationInfoEvent() override { EnsureComplete(EventCompletionType::Shutdown); } |
| |
| void Complete(EventCompletionType completionType) override { |
| WGPUCompilationInfoRequestStatus status = |
| WGPUCompilationInfoRequestStatus_CallbackCancelled; |
| const CompilationInfo* compilationInfo = nullptr; |
| if (completionType == EventCompletionType::Ready) { |
| status = WGPUCompilationInfoRequestStatus_Success; |
| compilationInfo = mShaderModule->mCompilationMessages->GetCompilationInfo(); |
| } |
| |
| mCallback(status, ToAPI(compilationInfo), mUserdata1.ExtractAsDangling(), |
| mUserdata2.ExtractAsDangling()); |
| } |
| }; |
| FutureID futureID = GetDevice()->GetInstance()->GetEventManager()->TrackEvent( |
| AcquireRef(new CompilationInfoEvent(callbackInfo, this))); |
| return {futureID}; |
| } |
| |
| const OwnedCompilationMessages* ShaderModuleBase::GetCompilationMessages() const { |
| return mCompilationMessages.get(); |
| } |
| |
| std::string ShaderModuleBase::GetCompilationLog() const { |
| DAWN_ASSERT(mCompilationMessages); |
| if (!mCompilationMessages->HasWarningsOrErrors()) { |
| return ""; |
| } |
| |
| // Emit the formatted Tint errors and warnings. |
| std::ostringstream t; |
| t << absl::StrFormat("Compilation log for %s:\n", this); |
| for (const auto& pMessage : mCompilationMessages->GetFormattedTintMessages()) { |
| t << "\n" << pMessage; |
| } |
| |
| return t.str(); |
| } |
| |
| void ShaderModuleBase::SetCompilationMessagesForTesting( |
| std::unique_ptr<OwnedCompilationMessages>* compilationMessages) { |
| mCompilationMessages = std::move(*compilationMessages); |
| } |
| |
| MaybeError ShaderModuleBase::InitializeBase(ShaderModuleParseResult* parseResult) { |
| DAWN_ASSERT(!parseResult->HasError()); |
| if (parseResult->HasTintProgram()) { |
| mTintData.Use([&](auto tintData) { |
| tintData->tintProgram = std::move(parseResult->tintProgram.UnsafeGetValue().value()); |
| }); |
| } |
| DAWN_ASSERT(parseResult->metadataTable.has_value()); |
| mEntryPoints = std::move(parseResult->metadataTable.value()); |
| |
| for (auto stage : IterateStages(kAllStages)) { |
| mEntryPointCounts[stage] = 0; |
| } |
| for (auto& [name, metadata] : mEntryPoints) { |
| SingleShaderStage stage = metadata->stage; |
| if (mEntryPointCounts[stage] == 0) { |
| mDefaultEntryPointNames[stage] = name; |
| } |
| mEntryPointCounts[stage]++; |
| } |
| |
| // Move the compilation messages if initialized successfully. Compilation messages should be |
| // inject only once for each shader module. |
| DAWN_ASSERT(mCompilationMessages == nullptr); |
| // Move the compilationMessages into the shader module and emit the tint errors and warnings |
| mCompilationMessages = |
| std::make_unique<OwnedCompilationMessages>(std::move(parseResult->compilationMessages)); |
| |
| return {}; |
| } |
| |
| void ShaderModuleBase::WillDropLastExternalRef() { |
| // The last external ref being dropped indicates that the application is not currently using, |
| // and no pending task will use the shader module. In this case we can free the memory for the |
| // parsed module. |
| mTintData.Use([&](auto tintData) { tintData->tintProgram = nullptr; }); |
| } |
| |
| } // namespace dawn::native |
