| // Copyright 2018 The Dawn Authors |
| // |
| // Licensed under the Apache License, Version 2.0 (the "License"); |
| // you may not use this file except in compliance with the License. |
| // You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, software |
| // distributed under the License is distributed on an "AS IS" BASIS, |
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| // See the License for the specific language governing permissions and |
| // limitations under the License. |
| |
| #include <sstream> |
| #include <string> |
| #include <vector> |
| |
| #include "dawn/common/Constants.h" |
| #include "dawn/native/ShaderModule.h" |
| #include "dawn/tests/unittests/validation/ValidationTest.h" |
| #include "dawn/utils/ComboRenderPipelineDescriptor.h" |
| #include "dawn/utils/WGPUHelpers.h" |
| |
| namespace dawn { |
| namespace { |
| |
| class ShaderModuleValidationTest : public ValidationTest {}; |
| |
| #if TINT_BUILD_SPV_READER |
| // Test case with a simpler shader that should successfully be created |
| TEST_F(ShaderModuleValidationTest, CreationSuccess) { |
| const char* shader = R"( |
| OpCapability Shader |
| %1 = OpExtInstImport "GLSL.std.450" |
| OpMemoryModel Logical GLSL450 |
| OpEntryPoint Fragment %main "main" %fragColor |
| OpExecutionMode %main OriginUpperLeft |
| OpSource GLSL 450 |
| OpSourceExtension "GL_GOOGLE_cpp_style_line_directive" |
| OpSourceExtension "GL_GOOGLE_include_directive" |
| OpName %main "main" |
| OpName %fragColor "fragColor" |
| OpDecorate %fragColor Location 0 |
| %void = OpTypeVoid |
| %3 = OpTypeFunction %void |
| %float = OpTypeFloat 32 |
| %v4float = OpTypeVector %float 4 |
| %_ptr_Output_v4float = OpTypePointer Output %v4float |
| %fragColor = OpVariable %_ptr_Output_v4float Output |
| %float_1 = OpConstant %float 1 |
| %float_0 = OpConstant %float 0 |
| %12 = OpConstantComposite %v4float %float_1 %float_0 %float_0 %float_1 |
| %main = OpFunction %void None %3 |
| %5 = OpLabel |
| OpStore %fragColor %12 |
| OpReturn |
| OpFunctionEnd)"; |
| |
| utils::CreateShaderModuleFromASM(device, shader); |
| } |
| |
| // Test that it is not allowed to use combined texture and sampler. |
| TEST_F(ShaderModuleValidationTest, CombinedTextureAndSampler) { |
| // SPIR-V ASM produced by glslang for the following fragment shader: |
| // |
| // #version 450 |
| // layout(set = 0, binding = 0) uniform sampler2D tex; |
| // void main () {} |
| // |
| // Note that the following defines an interface combined texture/sampler which is not allowed |
| // in Dawn / WebGPU. |
| // |
| // %8 = OpTypeSampledImage %7 |
| // %_ptr_UniformConstant_8 = OpTypePointer UniformConstant %8 |
| // %tex = OpVariable %_ptr_UniformConstant_8 UniformConstant |
| const char* shader = R"( |
| OpCapability Shader |
| %1 = OpExtInstImport "GLSL.std.450" |
| OpMemoryModel Logical GLSL450 |
| OpEntryPoint Fragment %main "main" |
| OpExecutionMode %main OriginUpperLeft |
| OpSource GLSL 450 |
| OpName %main "main" |
| OpName %tex "tex" |
| OpDecorate %tex DescriptorSet 0 |
| OpDecorate %tex Binding 0 |
| %void = OpTypeVoid |
| %3 = OpTypeFunction %void |
| %float = OpTypeFloat 32 |
| %7 = OpTypeImage %float 2D 0 0 0 1 Unknown |
| %8 = OpTypeSampledImage %7 |
| %_ptr_UniformConstant_8 = OpTypePointer UniformConstant %8 |
| %tex = OpVariable %_ptr_UniformConstant_8 UniformConstant |
| %main = OpFunction %void None %3 |
| %5 = OpLabel |
| OpReturn |
| OpFunctionEnd |
| )"; |
| |
| ASSERT_DEVICE_ERROR(utils::CreateShaderModuleFromASM(device, shader)); |
| } |
| |
| // Test that it is not allowed to declare a multisampled-array interface texture. |
| // TODO(enga): Also test multisampled cube, cube array, and 3D. These have no GLSL keywords. |
| TEST_F(ShaderModuleValidationTest, MultisampledArrayTexture) { |
| // SPIR-V ASM produced by glslang for the following fragment shader: |
| // |
| // #version 450 |
| // layout(set=0, binding=0) uniform texture2DMSArray tex; |
| // void main () {}} |
| // |
| // Note that the following defines an interface array multisampled texture which is not allowed |
| // in Dawn / WebGPU. |
| // |
| // %7 = OpTypeImage %float 2D 0 1 1 1 Unknown |
| // %_ptr_UniformConstant_7 = OpTypePointer UniformConstant %7 |
| // %tex = OpVariable %_ptr_UniformConstant_7 UniformConstant |
| const char* shader = R"( |
| OpCapability Shader |
| %1 = OpExtInstImport "GLSL.std.450" |
| OpMemoryModel Logical GLSL450 |
| OpEntryPoint Fragment %main "main" |
| OpExecutionMode %main OriginUpperLeft |
| OpSource GLSL 450 |
| OpName %main "main" |
| OpName %tex "tex" |
| OpDecorate %tex DescriptorSet 0 |
| OpDecorate %tex Binding 0 |
| %void = OpTypeVoid |
| %3 = OpTypeFunction %void |
| %float = OpTypeFloat 32 |
| %7 = OpTypeImage %float 2D 0 1 1 1 Unknown |
| %_ptr_UniformConstant_7 = OpTypePointer UniformConstant %7 |
| %tex = OpVariable %_ptr_UniformConstant_7 UniformConstant |
| %main = OpFunction %void None %3 |
| %5 = OpLabel |
| OpReturn |
| OpFunctionEnd |
| )"; |
| |
| ASSERT_DEVICE_ERROR(utils::CreateShaderModuleFromASM(device, shader)); |
| } |
| |
| const char* kShaderWithNonUniformDerivative = R"( |
| OpCapability Shader |
| OpMemoryModel Logical GLSL450 |
| OpEntryPoint Fragment %foo "foo" %x |
| OpExecutionMode %foo OriginUpperLeft |
| OpDecorate %x Location 0 |
| %float = OpTypeFloat 32 |
| %_ptr_Input_float = OpTypePointer Input %float |
| %x = OpVariable %_ptr_Input_float Input |
| %void = OpTypeVoid |
| %float_0 = OpConstantNull %float |
| %bool = OpTypeBool |
| %func_type = OpTypeFunction %void |
| %foo = OpFunction %void None %func_type |
| %foo_start = OpLabel |
| %x_value = OpLoad %float %x |
| %condition = OpFOrdGreaterThan %bool %x_value %float_0 |
| OpSelectionMerge %merge None |
| OpBranchConditional %condition %true_branch %merge |
| %true_branch = OpLabel |
| %result = OpDPdx %float %x_value |
| OpBranch %merge |
| %merge = OpLabel |
| OpReturn |
| OpFunctionEnd)"; |
| |
| // Test that creating a module with a SPIR-V shader that has a uniformity violation fails when no |
| // SPIR-V options descriptor is used. |
| TEST_F(ShaderModuleValidationTest, NonUniformDerivatives_NoOptions) { |
| ASSERT_DEVICE_ERROR(utils::CreateShaderModuleFromASM(device, kShaderWithNonUniformDerivative)); |
| } |
| |
| // Test that creating a module with a SPIR-V shader that has a uniformity violation fails when |
| // passing a SPIR-V options descriptor with the `allowNonUniformDerivatives` flag set to `false`. |
| TEST_F(ShaderModuleValidationTest, NonUniformDerivatives_FlagSetToFalse) { |
| wgpu::DawnShaderModuleSPIRVOptionsDescriptor spirv_options_desc = {}; |
| spirv_options_desc.allowNonUniformDerivatives = false; |
| ASSERT_DEVICE_ERROR(utils::CreateShaderModuleFromASM(device, kShaderWithNonUniformDerivative, |
| &spirv_options_desc)); |
| } |
| |
| // Test that creating a module with a SPIR-V shader that has a uniformity violation succeeds when |
| // passing a SPIR-V options descriptor with the `allowNonUniformDerivatives` flag set to `true`. |
| TEST_F(ShaderModuleValidationTest, NonUniformDerivatives_FlagSetToTrue) { |
| wgpu::DawnShaderModuleSPIRVOptionsDescriptor spirv_options_desc = {}; |
| spirv_options_desc.allowNonUniformDerivatives = true; |
| utils::CreateShaderModuleFromASM(device, kShaderWithNonUniformDerivative, &spirv_options_desc); |
| } |
| |
| #endif // TINT_BUILD_SPV_READER |
| |
| // Test that it is invalid to create a shader module with no chained descriptor. (It must be |
| // WGSL or SPIRV, not empty) |
| TEST_F(ShaderModuleValidationTest, NoChainedDescriptor) { |
| wgpu::ShaderModuleDescriptor desc = {}; |
| ASSERT_DEVICE_ERROR(device.CreateShaderModule(&desc)); |
| } |
| |
| // Test that it is invalid to create a shader module that uses both the WGSL descriptor and the |
| // SPIRV descriptor. |
| TEST_F(ShaderModuleValidationTest, MultipleChainedDescriptor_WgslAndSpirv) { |
| uint32_t code = 42; |
| wgpu::ShaderModuleDescriptor desc = {}; |
| wgpu::ShaderModuleSPIRVDescriptor spirv_desc = {}; |
| spirv_desc.code = &code; |
| spirv_desc.codeSize = 1; |
| wgpu::ShaderModuleWGSLDescriptor wgsl_desc = {}; |
| wgsl_desc.code = ""; |
| wgsl_desc.nextInChain = &spirv_desc; |
| desc.nextInChain = &wgsl_desc; |
| ASSERT_DEVICE_ERROR(device.CreateShaderModule(&desc)); |
| } |
| |
| // Test that it is invalid to create a shader module that uses both the WGSL descriptor and the |
| // Dawn SPIRV options descriptor. |
| TEST_F(ShaderModuleValidationTest, MultipleChainedDescriptor_WgslAndDawnSpirvOptions) { |
| wgpu::ShaderModuleDescriptor desc = {}; |
| wgpu::DawnShaderModuleSPIRVOptionsDescriptor spirv_options_desc = {}; |
| wgpu::ShaderModuleWGSLDescriptor wgsl_desc = {}; |
| wgsl_desc.nextInChain = &spirv_options_desc; |
| wgsl_desc.code = ""; |
| desc.nextInChain = &wgsl_desc; |
| ASSERT_DEVICE_ERROR(device.CreateShaderModule(&desc)); |
| } |
| |
| // Test that it is invalid to create a shader module that only uses the Dawn SPIRV options |
| // descriptor without the SPIRV descriptor. |
| TEST_F(ShaderModuleValidationTest, OnlySpirvOptionsDescriptor) { |
| wgpu::ShaderModuleDescriptor desc = {}; |
| wgpu::DawnShaderModuleSPIRVOptionsDescriptor spirv_options_desc = {}; |
| desc.nextInChain = &spirv_options_desc; |
| ASSERT_DEVICE_ERROR(device.CreateShaderModule(&desc)); |
| } |
| |
| // Tests that shader module compilation messages can be queried. |
| TEST_F(ShaderModuleValidationTest, GetCompilationMessages) { |
| // This test works assuming ShaderModule is backed by a native::ShaderModuleBase, which |
| // is not the case on the wire. |
| DAWN_SKIP_TEST_IF(UsesWire()); |
| |
| wgpu::ShaderModule shaderModule = utils::CreateShaderModule(device, R"( |
| @fragment fn main() -> @location(0) vec4f { |
| return vec4f(0.0, 1.0, 0.0, 1.0); |
| })"); |
| |
| native::ShaderModuleBase* shaderModuleBase = native::FromAPI(shaderModule.Get()); |
| native::OwnedCompilationMessages* messages = shaderModuleBase->GetCompilationMessages(); |
| messages->ClearMessages(); |
| messages->AddMessage("Info Message"); |
| messages->AddMessage("Warning Message", wgpu::CompilationMessageType::Warning); |
| messages->AddMessage("Error Message", wgpu::CompilationMessageType::Error, 3, 4); |
| messages->AddMessage("Complete Message", wgpu::CompilationMessageType::Info, 3, 4, 5, 6); |
| |
| auto callback = [](WGPUCompilationInfoRequestStatus status, const WGPUCompilationInfo* info, |
| void* userdata) { |
| ASSERT_EQ(WGPUCompilationInfoRequestStatus_Success, status); |
| ASSERT_NE(nullptr, info); |
| ASSERT_EQ(4u, info->messageCount); |
| |
| const WGPUCompilationMessage* message = &info->messages[0]; |
| ASSERT_STREQ("Info Message", message->message); |
| ASSERT_EQ(WGPUCompilationMessageType_Info, message->type); |
| ASSERT_EQ(0u, message->lineNum); |
| ASSERT_EQ(0u, message->linePos); |
| |
| message = &info->messages[1]; |
| ASSERT_STREQ("Warning Message", message->message); |
| ASSERT_EQ(WGPUCompilationMessageType_Warning, message->type); |
| ASSERT_EQ(0u, message->lineNum); |
| ASSERT_EQ(0u, message->linePos); |
| |
| message = &info->messages[2]; |
| ASSERT_STREQ("Error Message", message->message); |
| ASSERT_EQ(WGPUCompilationMessageType_Error, message->type); |
| ASSERT_EQ(3u, message->lineNum); |
| ASSERT_EQ(4u, message->linePos); |
| |
| message = &info->messages[3]; |
| ASSERT_STREQ("Complete Message", message->message); |
| ASSERT_EQ(WGPUCompilationMessageType_Info, message->type); |
| ASSERT_EQ(3u, message->lineNum); |
| ASSERT_EQ(4u, message->linePos); |
| ASSERT_EQ(5u, message->offset); |
| ASSERT_EQ(6u, message->length); |
| }; |
| |
| shaderModule.GetCompilationInfo(callback, nullptr); |
| } |
| |
| // Validate the maximum location of effective inter-stage variables cannot be greater than 14 |
| // (kMaxInterStageShaderComponents / 4 - 1). |
| TEST_F(ShaderModuleValidationTest, MaximumShaderIOLocations) { |
| auto CheckTestPipeline = [&](bool success, uint32_t maximumOutputLocation, |
| wgpu::ShaderStage failingShaderStage) { |
| // Build the ShaderIO struct containing variables up to maximumOutputLocation. |
| std::ostringstream stream; |
| stream << "struct ShaderIO {" << std::endl; |
| for (uint32_t location = 1; location <= maximumOutputLocation; ++location) { |
| stream << "@location(" << location << ") var" << location << ": f32," << std::endl; |
| } |
| |
| if (failingShaderStage == wgpu::ShaderStage::Vertex) { |
| stream << " @builtin(position) pos: vec4f,"; |
| } |
| stream << "}\n"; |
| |
| std::string ioStruct = stream.str(); |
| |
| // Build the test pipeline. Note that it's not possible with just ASSERT_DEVICE_ERROR |
| // whether it is the vertex or fragment shader that fails. So instead we will look for the |
| // string "failingVertex" or "failingFragment" in the error message. |
| utils::ComboRenderPipelineDescriptor pDesc; |
| pDesc.cTargets[0].format = wgpu::TextureFormat::RGBA8Unorm; |
| |
| const char* errorMatcher = nullptr; |
| switch (failingShaderStage) { |
| case wgpu::ShaderStage::Vertex: { |
| errorMatcher = "failingVertex"; |
| pDesc.vertex.entryPoint = "failingVertex"; |
| pDesc.vertex.module = utils::CreateShaderModule(device, (ioStruct + R"( |
| @vertex fn failingVertex() -> ShaderIO { |
| var shaderIO : ShaderIO; |
| shaderIO.pos = vec4f(0.0, 0.0, 0.0, 1.0); |
| return shaderIO; |
| } |
| )") |
| .c_str()); |
| pDesc.cFragment.module = utils::CreateShaderModule(device, R"( |
| @fragment fn main() -> @location(0) vec4f { |
| return vec4f(0.0); |
| } |
| )"); |
| break; |
| } |
| |
| case wgpu::ShaderStage::Fragment: { |
| errorMatcher = "failingFragment"; |
| pDesc.cFragment.entryPoint = "failingFragment"; |
| pDesc.cFragment.module = utils::CreateShaderModule(device, (ioStruct + R"( |
| @fragment fn failingFragment(io : ShaderIO) -> @location(0) vec4f { |
| return vec4f(0.0); |
| } |
| )") |
| .c_str()); |
| pDesc.vertex.module = utils::CreateShaderModule(device, R"( |
| @vertex fn main() -> @builtin(position) vec4f { |
| return vec4f(0.0); |
| } |
| )"); |
| break; |
| } |
| |
| default: |
| DAWN_UNREACHABLE(); |
| } |
| |
| if (success) { |
| if (failingShaderStage == wgpu::ShaderStage::Vertex) { |
| // It is allowed that fragment inputs are a subset of the vertex output variables. |
| device.CreateRenderPipeline(&pDesc); |
| } else { |
| ASSERT_DEVICE_ERROR(device.CreateRenderPipeline(&pDesc), |
| testing::HasSubstr("The fragment input at location")); |
| } |
| } else { |
| ASSERT_DEVICE_ERROR(device.CreateRenderPipeline(&pDesc), |
| testing::HasSubstr(errorMatcher)); |
| } |
| }; |
| |
| // It is allowed to create a shader module with the maximum active vertex output location == |
| // (kMaxInterStageShaderVariables - 1); |
| CheckTestPipeline(true, kMaxInterStageShaderVariables - 1, wgpu::ShaderStage::Vertex); |
| |
| // It isn't allowed to create a shader module with the maximum active vertex output location == |
| // kMaxInterStageShaderVariables; |
| CheckTestPipeline(false, kMaxInterStageShaderVariables, wgpu::ShaderStage::Vertex); |
| |
| // It is allowed to create a shader module with the maximum active fragment input location == |
| // (kMaxInterStageShaderVariables - 1); |
| CheckTestPipeline(true, kMaxInterStageShaderVariables - 1, wgpu::ShaderStage::Fragment); |
| |
| // It isn't allowed to create a shader module with the maximum active vertex output location == |
| // kMaxInterStageShaderVariables; |
| CheckTestPipeline(false, kMaxInterStageShaderVariables, wgpu::ShaderStage::Fragment); |
| } |
| |
| // Validate the maximum number of total inter-stage user-defined variable component count and |
| // built-in variables cannot exceed kMaxInterStageShaderComponents. |
| TEST_F(ShaderModuleValidationTest, MaximumInterStageShaderComponents) { |
| auto CheckTestPipeline = [&](bool success, |
| uint32_t totalUserDefinedInterStageShaderComponentCount, |
| wgpu::ShaderStage failingShaderStage, |
| const char* extraBuiltInDeclarations = "", |
| bool usePointListAsPrimitiveType = false) { |
| // Build the ShaderIO struct containing totalUserDefinedInterStageShaderComponentCount |
| // components. Components are added in two parts, a bunch of vec4s, then one additional |
| // variable for the remaining components. |
| std::ostringstream stream; |
| stream << "struct ShaderIO {" << std::endl << extraBuiltInDeclarations << std::endl; |
| uint32_t vec4InputLocations = totalUserDefinedInterStageShaderComponentCount / 4; |
| |
| for (uint32_t location = 0; location < vec4InputLocations; ++location) { |
| stream << "@location(" << location << ") var" << location << ": vec4f," << std::endl; |
| } |
| |
| uint32_t lastComponentCount = totalUserDefinedInterStageShaderComponentCount % 4; |
| if (lastComponentCount > 0) { |
| stream << "@location(" << vec4InputLocations << ") var" << vec4InputLocations << ": "; |
| if (lastComponentCount == 1) { |
| stream << "f32,"; |
| } else { |
| stream << " vec" << lastComponentCount << "<f32>,"; |
| } |
| stream << std::endl; |
| } |
| |
| if (failingShaderStage == wgpu::ShaderStage::Vertex) { |
| stream << " @builtin(position) pos: vec4f,"; |
| } |
| stream << "}\n"; |
| |
| std::string ioStruct = stream.str(); |
| |
| // Build the test pipeline. Note that it's not possible with just ASSERT_DEVICE_ERROR |
| // whether it is the vertex or fragment shader that fails. So instead we will look for the |
| // string "failingVertex" or "failingFragment" in the error message. |
| utils::ComboRenderPipelineDescriptor pDesc; |
| pDesc.cTargets[0].format = wgpu::TextureFormat::RGBA8Unorm; |
| if (usePointListAsPrimitiveType) { |
| pDesc.primitive.topology = wgpu::PrimitiveTopology::PointList; |
| } else { |
| pDesc.primitive.topology = wgpu::PrimitiveTopology::TriangleList; |
| } |
| |
| const char* errorMatcher = nullptr; |
| switch (failingShaderStage) { |
| case wgpu::ShaderStage::Vertex: { |
| if (usePointListAsPrimitiveType) { |
| errorMatcher = "PointList"; |
| } else { |
| errorMatcher = "failingVertex"; |
| } |
| pDesc.vertex.entryPoint = "failingVertex"; |
| pDesc.vertex.module = utils::CreateShaderModule(device, (ioStruct + R"( |
| @vertex fn failingVertex() -> ShaderIO { |
| var shaderIO : ShaderIO; |
| shaderIO.pos = vec4f(0.0, 0.0, 0.0, 1.0); |
| return shaderIO; |
| } |
| )") |
| .c_str()); |
| pDesc.cFragment.module = utils::CreateShaderModule(device, R"( |
| @fragment fn main() -> @location(0) vec4f { |
| return vec4f(0.0); |
| } |
| )"); |
| break; |
| } |
| |
| case wgpu::ShaderStage::Fragment: { |
| errorMatcher = "failingFragment"; |
| pDesc.cFragment.entryPoint = "failingFragment"; |
| pDesc.cFragment.module = utils::CreateShaderModule(device, (ioStruct + R"( |
| @fragment fn failingFragment(io : ShaderIO) -> @location(0) vec4f { |
| return vec4f(0.0); |
| } |
| )") |
| .c_str()); |
| pDesc.vertex.module = utils::CreateShaderModule(device, R"( |
| @vertex fn main() -> @builtin(position) vec4f { |
| return vec4f(0.0); |
| } |
| )"); |
| break; |
| } |
| |
| default: |
| DAWN_UNREACHABLE(); |
| } |
| |
| if (success) { |
| if (failingShaderStage == wgpu::ShaderStage::Vertex) { |
| // It is allowed that fragment inputs are a subset of the vertex output variables. |
| device.CreateRenderPipeline(&pDesc); |
| } else { |
| ASSERT_DEVICE_ERROR(device.CreateRenderPipeline(&pDesc), |
| testing::HasSubstr("The fragment input at location")); |
| } |
| } else { |
| ASSERT_DEVICE_ERROR(device.CreateRenderPipeline(&pDesc), |
| testing::HasSubstr(errorMatcher)); |
| } |
| }; |
| |
| // Verify when there is no input builtin variable in a fragment shader, the total user-defined |
| // input component count must be less than kMaxInterStageShaderComponents. |
| { |
| CheckTestPipeline(true, kMaxInterStageShaderComponents, wgpu::ShaderStage::Fragment); |
| CheckTestPipeline(false, kMaxInterStageShaderComponents + 1, wgpu::ShaderStage::Fragment); |
| } |
| |
| // Verify the total user-defined vertex output component count must be less than |
| // kMaxInterStageShaderComponents. |
| { |
| CheckTestPipeline(true, kMaxInterStageShaderComponents, wgpu::ShaderStage::Vertex); |
| CheckTestPipeline(false, kMaxInterStageShaderComponents + 1, wgpu::ShaderStage::Vertex); |
| } |
| |
| // Verify the total user-defined vertex output component count must be less than |
| // (kMaxInterStageShaderComponents - 1) when the primitive topology is PointList. |
| { |
| constexpr bool kUsePointListAsPrimitiveTopology = true; |
| const char* kExtraBuiltins = ""; |
| CheckTestPipeline(true, kMaxInterStageShaderComponents - 1, wgpu::ShaderStage::Vertex, |
| kExtraBuiltins, kUsePointListAsPrimitiveTopology); |
| CheckTestPipeline(false, kMaxInterStageShaderComponents, wgpu::ShaderStage::Vertex, |
| kExtraBuiltins, kUsePointListAsPrimitiveTopology); |
| } |
| |
| // @builtin(position) in fragment shaders shouldn't be counted into the maximum inter-stage |
| // component count. |
| { |
| CheckTestPipeline(true, kMaxInterStageShaderComponents, wgpu::ShaderStage::Fragment, |
| "@builtin(position) fragCoord : vec4f,"); |
| } |
| |
| // @builtin(front_facing) should be counted into the maximum inter-stage component count. |
| { |
| CheckTestPipeline(true, kMaxInterStageShaderComponents - 1, wgpu::ShaderStage::Fragment, |
| "@builtin(front_facing) frontFacing : bool,"); |
| CheckTestPipeline(false, kMaxInterStageShaderComponents, wgpu::ShaderStage::Fragment, |
| "@builtin(front_facing) frontFacing : bool,"); |
| } |
| |
| // @builtin(sample_index) should be counted into the maximum inter-stage component count. |
| { |
| CheckTestPipeline(true, kMaxInterStageShaderComponents - 1, wgpu::ShaderStage::Fragment, |
| "@builtin(sample_index) sampleIndex : u32,"); |
| CheckTestPipeline(false, kMaxInterStageShaderComponents, wgpu::ShaderStage::Fragment, |
| "@builtin(sample_index) sampleIndex : u32,"); |
| } |
| |
| // @builtin(sample_mask) should be counted into the maximum inter-stage component count. |
| { |
| CheckTestPipeline(true, kMaxInterStageShaderComponents - 1, wgpu::ShaderStage::Fragment, |
| "@builtin(sample_mask) sampleMask : u32,"); |
| CheckTestPipeline(false, kMaxInterStageShaderComponents, wgpu::ShaderStage::Fragment, |
| "@builtin(sample_mask) sampleMask : u32,"); |
| } |
| } |
| |
| // Test that numeric ID must be unique |
| TEST_F(ShaderModuleValidationTest, OverridableConstantsNumericIDConflicts) { |
| ASSERT_DEVICE_ERROR(utils::CreateShaderModule(device, R"( |
| @id(1234) override c0: u32; |
| @id(1234) override c1: u32; |
| |
| struct Buf { |
| data : array<u32, 2> |
| } |
| |
| @group(0) @binding(0) var<storage, read_write> buf : Buf; |
| |
| @compute @workgroup_size(1) fn main() { |
| // make sure the overridable constants are not optimized out |
| buf.data[0] = c0; |
| buf.data[1] = c1; |
| })")); |
| } |
| |
| // Test that @binding must be less then kMaxBindingsPerBindGroup |
| TEST_F(ShaderModuleValidationTest, MaxBindingNumber) { |
| static_assert(kMaxBindingsPerBindGroup == 1000); |
| |
| wgpu::ComputePipelineDescriptor desc; |
| desc.compute.entryPoint = "main"; |
| |
| // kMaxBindingsPerBindGroup-1 is valid. |
| desc.compute.module = utils::CreateShaderModule(device, R"( |
| @group(0) @binding(999) var s : sampler; |
| @compute @workgroup_size(1) fn main() { |
| _ = s; |
| } |
| )"); |
| device.CreateComputePipeline(&desc); |
| |
| // kMaxBindingsPerBindGroup is an error |
| desc.compute.module = utils::CreateShaderModule(device, R"( |
| @group(0) @binding(1000) var s : sampler; |
| @compute @workgroup_size(1) fn main() { |
| _ = s; |
| } |
| )"); |
| ASSERT_DEVICE_ERROR(device.CreateComputePipeline(&desc)); |
| } |
| |
| // Test that missing decorations on shader IO or bindings causes a validation error. |
| TEST_F(ShaderModuleValidationTest, MissingDecorations) { |
| // Vertex input. |
| utils::CreateShaderModule(device, R"( |
| @vertex fn main(@location(0) a : vec4f) -> @builtin(position) vec4f { |
| return vec4(1.0); |
| } |
| )"); |
| ASSERT_DEVICE_ERROR(utils::CreateShaderModule(device, R"( |
| @vertex fn main(a : vec4f) -> @builtin(position) vec4f { |
| return vec4(1.0); |
| } |
| )")); |
| |
| // Vertex output |
| utils::CreateShaderModule(device, R"( |
| struct Output { |
| @builtin(position) pos : vec4f, |
| @location(0) a : f32, |
| } |
| @vertex fn main() -> Output { |
| var output : Output; |
| return output; |
| } |
| )"); |
| ASSERT_DEVICE_ERROR(utils::CreateShaderModule(device, R"( |
| struct Output { |
| @builtin(position) pos : vec4f, |
| a : f32, |
| } |
| @vertex fn main() -> Output { |
| var output : Output; |
| return output; |
| } |
| )")); |
| |
| // Fragment input |
| utils::CreateShaderModule(device, R"( |
| @fragment fn main(@location(0) a : vec4f) -> @location(0) f32 { |
| return 1.0; |
| } |
| )"); |
| ASSERT_DEVICE_ERROR(utils::CreateShaderModule(device, R"( |
| @fragment fn main(a : vec4f) -> @location(0) f32 { |
| return 1.0; |
| } |
| )")); |
| |
| // Fragment input |
| utils::CreateShaderModule(device, R"( |
| @fragment fn main() -> @location(0) f32 { |
| return 1.0; |
| } |
| )"); |
| ASSERT_DEVICE_ERROR(utils::CreateShaderModule(device, R"( |
| @fragment fn main() -> f32 { |
| return 1.0; |
| } |
| )")); |
| |
| // Binding decorations |
| utils::CreateShaderModule(device, R"( |
| @group(0) @binding(0) var s : sampler; |
| @fragment fn main() -> @location(0) f32 { |
| _ = s; |
| return 1.0; |
| } |
| )"); |
| ASSERT_DEVICE_ERROR(utils::CreateShaderModule(device, R"( |
| @binding(0) var s : sampler; |
| @fragment fn main() -> @location(0) f32 { |
| _ = s; |
| return 1.0; |
| } |
| )")); |
| ASSERT_DEVICE_ERROR(utils::CreateShaderModule(device, R"( |
| @group(0) var s : sampler; |
| @fragment fn main() -> @location(0) f32 { |
| _ = s; |
| return 1.0; |
| } |
| )")); |
| } |
| |
| // Test creating an error shader module with device.CreateErrorShaderModule() |
| TEST_F(ShaderModuleValidationTest, CreateErrorShaderModule) { |
| wgpu::ShaderModuleWGSLDescriptor wgslDesc = {}; |
| wgpu::ShaderModuleDescriptor descriptor = {}; |
| descriptor.nextInChain = &wgslDesc; |
| wgslDesc.code = "@compute @workgroup_size(1) fn main() {}"; |
| |
| wgpu::ShaderModule errorShaderModule; |
| ASSERT_DEVICE_ERROR(errorShaderModule = device.CreateErrorShaderModule( |
| &descriptor, "Shader compilation error")); |
| |
| auto callback = [](WGPUCompilationInfoRequestStatus status, const WGPUCompilationInfo* info, |
| void* userdata) { |
| ASSERT_EQ(WGPUCompilationInfoRequestStatus_Success, status); |
| ASSERT_NE(nullptr, info); |
| ASSERT_EQ(1u, info->messageCount); |
| |
| const WGPUCompilationMessage* message = &info->messages[0]; |
| ASSERT_STREQ("Shader compilation error", message->message); |
| ASSERT_EQ(WGPUCompilationMessageType_Error, message->type); |
| ASSERT_EQ(0u, message->lineNum); |
| ASSERT_EQ(0u, message->linePos); |
| }; |
| |
| errorShaderModule.GetCompilationInfo(callback, nullptr); |
| |
| FlushWire(); |
| } |
| |
| class ShaderModuleExtensionValidationTestBase : public ValidationTest { |
| protected: |
| // Skip tests if using Wire, because some features are not supported by the wire and cause the |
| // device creation failed. |
| void SetUp() override { |
| DAWN_SKIP_TEST_IF(UsesWire()); |
| ValidationTest::SetUp(); |
| } |
| |
| // Create testing adapter with the AllowUnsafeAPIs toggle explicitly enabled or disabled, |
| // overriding the instance's toggle. |
| void CreateTestAdapterWithUnsafeAPIToggle(wgpu::Instance instance, |
| wgpu::RequestAdapterOptions options, |
| bool allowUnsafeAPIs) { |
| wgpu::DawnTogglesDescriptor deviceTogglesDesc{}; |
| options.nextInChain = &deviceTogglesDesc; |
| const char* toggle = "allow_unsafe_apis"; |
| // Explicitly enable or disable the AllowUnsafeAPIs toggle. |
| if (allowUnsafeAPIs) { |
| deviceTogglesDesc.enabledToggles = &toggle; |
| deviceTogglesDesc.enabledToggleCount = 1; |
| } else { |
| deviceTogglesDesc.disabledToggles = &toggle; |
| deviceTogglesDesc.disabledToggleCount = 1; |
| } |
| |
| instance.RequestAdapter( |
| &options, |
| [](WGPURequestAdapterStatus, WGPUAdapter cAdapter, const char*, void* userdata) { |
| *static_cast<wgpu::Adapter*>(userdata) = wgpu::Adapter::Acquire(cAdapter); |
| }, |
| &adapter); |
| FlushWire(); |
| } |
| |
| // Create the device with none or all valid features required. |
| WGPUDevice CreateTestDeviceWithAllFeatures(native::Adapter dawnAdapter, |
| wgpu::DeviceDescriptor descriptor, |
| bool requireAllFeatures) { |
| std::vector<wgpu::FeatureName> requiredFeatures; |
| |
| if (requireAllFeatures) { |
| // Require all features that the adapter supports. |
| WGPUAdapter adapter = dawnAdapter.Get(); |
| const size_t adapterSupportedFeaturesCount = |
| wgpuAdapterEnumerateFeatures(adapter, nullptr); |
| requiredFeatures.resize(adapterSupportedFeaturesCount); |
| wgpuAdapterEnumerateFeatures( |
| adapter, reinterpret_cast<WGPUFeatureName*>(requiredFeatures.data())); |
| } |
| |
| descriptor.requiredFeatures = requiredFeatures.data(); |
| descriptor.requiredFeatureCount = requiredFeatures.size(); |
| |
| return dawnAdapter.CreateDevice(&descriptor); |
| } |
| }; |
| |
| struct WGSLExtensionInfo { |
| const char* WGSLName; |
| // Is this WGSL extension experimental, i.e. guarded by AllowUnsafeAPIs toggle |
| bool isExperimental; |
| // The WebGPU feature that required to enable this extension, set to nullptr if no feature |
| // required. |
| const char* RequiredFeatureName; |
| }; |
| |
| constexpr struct WGSLExtensionInfo kExtensions[] = { |
| {"f16", true, "shader-f16"}, |
| {"chromium_experimental_dp4a", true, "chromium-experimental-dp4a"}, |
| {"chromium_experimental_subgroups", true, "chromium-experimental-subgroups"}, |
| {"chromium_disable_uniformity_analysis", true, nullptr}, |
| {"chromium_internal_dual_source_blending", true, "dual-source-blending"}, |
| |
| // Currently the following WGSL extensions are not enabled under any situation. |
| /* |
| {"chromium_experimental_full_ptr_parameters", true, nullptr}, |
| {"chromium_experimental_push_constant", true, nullptr}, |
| {"chromium_internal_relaxed_uniform_layout", true, nullptr}, |
| */ |
| }; |
| |
| // Test validating WGSL extension on safe device with no feature required. |
| class ShaderModuleExtensionValidationTestSafeNoFeature |
| : public ShaderModuleExtensionValidationTestBase { |
| protected: |
| void CreateTestAdapter(wgpu::Instance instance, wgpu::RequestAdapterOptions options) override { |
| // Create a safe adapter |
| CreateTestAdapterWithUnsafeAPIToggle(instance, options, false); |
| } |
| WGPUDevice CreateTestDevice(native::Adapter dawnAdapter, |
| wgpu::DeviceDescriptor descriptor) override { |
| // Create a device requiring no features |
| return CreateTestDeviceWithAllFeatures(dawnAdapter, descriptor, false); |
| } |
| }; |
| |
| TEST_F(ShaderModuleExtensionValidationTestSafeNoFeature, |
| OnlyStableExtensionsRequiringNoFeatureAllowed) { |
| for (auto& extension : kExtensions) { |
| std::string wgsl = std::string("enable ") + extension.WGSLName + R"(; |
| |
| @compute @workgroup_size(1) fn main() {})"; |
| |
| // On a safe device with no feature required, only stable extensions requiring no features |
| // are allowed. |
| if (!extension.isExperimental && !extension.RequiredFeatureName) { |
| utils::CreateShaderModule(device, wgsl.c_str()); |
| } else { |
| ASSERT_DEVICE_ERROR(utils::CreateShaderModule(device, wgsl.c_str())); |
| } |
| } |
| } |
| |
| // Test validating WGSL extension on unsafe device with no feature required. |
| class ShaderModuleExtensionValidationTestUnsafeNoFeature |
| : public ShaderModuleExtensionValidationTestBase { |
| protected: |
| void CreateTestAdapter(wgpu::Instance instance, wgpu::RequestAdapterOptions options) override { |
| // Create an unsafe adapter |
| CreateTestAdapterWithUnsafeAPIToggle(instance, options, true); |
| } |
| WGPUDevice CreateTestDevice(native::Adapter dawnAdapter, |
| wgpu::DeviceDescriptor descriptor) override { |
| // Create a device requiring no features |
| return CreateTestDeviceWithAllFeatures(dawnAdapter, descriptor, false); |
| } |
| }; |
| |
| TEST_F(ShaderModuleExtensionValidationTestUnsafeNoFeature, |
| OnlyExtensionsRequiringNoFeatureAllowed) { |
| for (auto& extension : kExtensions) { |
| std::string wgsl = std::string("enable ") + extension.WGSLName + R"(; |
| |
| @compute @workgroup_size(1) fn main() {})"; |
| |
| // On an unsafe device with no feature required, only extensions requiring no features are |
| // allowed. |
| if (!extension.RequiredFeatureName) { |
| utils::CreateShaderModule(device, wgsl.c_str()); |
| } else { |
| ASSERT_DEVICE_ERROR(utils::CreateShaderModule(device, wgsl.c_str())); |
| } |
| } |
| } |
| |
| // Test validating WGSL extension on safe device with all features required. |
| class ShaderModuleExtensionValidationTestSafeAllFeatures |
| : public ShaderModuleExtensionValidationTestBase { |
| protected: |
| void CreateTestAdapter(wgpu::Instance instance, wgpu::RequestAdapterOptions options) override { |
| // Create a safe adapter |
| CreateTestAdapterWithUnsafeAPIToggle(instance, options, false); |
| } |
| WGPUDevice CreateTestDevice(native::Adapter dawnAdapter, |
| wgpu::DeviceDescriptor descriptor) override { |
| // Create a device requiring all features |
| return CreateTestDeviceWithAllFeatures(dawnAdapter, descriptor, true); |
| } |
| }; |
| |
| TEST_F(ShaderModuleExtensionValidationTestSafeAllFeatures, OnlyStableExtensionsAllowed) { |
| for (auto& extension : kExtensions) { |
| std::string wgsl = std::string("enable ") + extension.WGSLName + R"(; |
| |
| @compute @workgroup_size(1) fn main() {})"; |
| |
| // On a safe device with all feature required, only stable extensions are allowed. |
| if (!extension.isExperimental) { |
| utils::CreateShaderModule(device, wgsl.c_str()); |
| } else { |
| ASSERT_DEVICE_ERROR(utils::CreateShaderModule(device, wgsl.c_str())); |
| } |
| } |
| } |
| |
| // Test validating WGSL extension on unsafe device with all features required. |
| class ShaderModuleExtensionValidationTestUnsafeAllFeatures |
| : public ShaderModuleExtensionValidationTestBase { |
| protected: |
| void CreateTestAdapter(wgpu::Instance instance, wgpu::RequestAdapterOptions options) override { |
| // Create an unsafe adapter |
| CreateTestAdapterWithUnsafeAPIToggle(instance, options, true); |
| } |
| WGPUDevice CreateTestDevice(native::Adapter dawnAdapter, |
| wgpu::DeviceDescriptor descriptor) override { |
| // Create a device requiring all features |
| return CreateTestDeviceWithAllFeatures(dawnAdapter, descriptor, true); |
| } |
| }; |
| |
| TEST_F(ShaderModuleExtensionValidationTestUnsafeAllFeatures, AllExtensionsAllowed) { |
| for (auto& extension : kExtensions) { |
| std::string wgsl = std::string("enable ") + extension.WGSLName + R"(; |
| |
| @compute @workgroup_size(1) fn main() {})"; |
| |
| // On an unsafe device with all feature required, all extensions are allowed. |
| utils::CreateShaderModule(device, wgsl.c_str()); |
| } |
| } |
| |
| } // anonymous namespace |
| } // namespace dawn |
