blob: fbe18d14bea9942723024962b4afd606bd4fe1e9 [file] [log] [blame]
// Copyright 2023 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 "src/tint/lang/spirv/writer/common/helper_test.h"
#include "gmock/gmock.h"
namespace tint::spirv::writer {
namespace {
using namespace tint::core::fluent_types; // NOLINT
using namespace tint::core::number_suffixes; // NOLINT
TEST_F(SpirvWriterTest, ModuleHeader) {
ASSERT_TRUE(Generate()) << Error() << output_;
EXPECT_INST("OpCapability Shader");
EXPECT_INST("OpMemoryModel Logical GLSL450");
}
TEST_F(SpirvWriterTest, ModuleHeader_VulkanMemoryModel) {
Options opts;
opts.use_vulkan_memory_model = true;
ASSERT_TRUE(Generate(opts)) << Error() << output_;
EXPECT_INST("OpExtension \"SPV_KHR_vulkan_memory_model\"");
EXPECT_INST("OpCapability VulkanMemoryModel");
EXPECT_INST("OpCapability VulkanMemoryModelDeviceScope");
EXPECT_INST("OpMemoryModel Logical Vulkan");
}
TEST_F(SpirvWriterTest, CanGenerate_SubgroupMatrixRequiresVulkanMemoryModel) {
mod.root_block->Append(b.Var(ty.ptr<private_>(ty.subgroup_matrix_result(ty.f32(), 8, 8))));
Options options;
options.use_vulkan_memory_model = false;
auto result = CanGenerate(mod, options);
ASSERT_NE(result, Success);
EXPECT_THAT(result.Failure().reason,
testing::HasSubstr("using subgroup matrices requires the Vulkan Memory Model"));
}
TEST_F(SpirvWriterTest, Unreachable) {
auto* func = b.Function("foo", ty.void_());
b.Append(func->Block(), [&] {
auto* loop = b.Loop();
b.Append(loop->Body(), [&] {
auto* ifelse = b.If(true);
b.Append(ifelse->True(), [&] { //
b.Continue(loop);
});
b.Append(ifelse->False(), [&] { //
b.Continue(loop);
});
b.Unreachable();
b.Append(loop->Continuing(), [&] { //
b.NextIteration(loop);
});
});
b.Return(func);
});
Options options;
options.disable_robustness = true;
ASSERT_TRUE(Generate(options)) << Error() << output_;
EXPECT_INST(R"(
%foo = OpFunction %void None %3
%4 = OpLabel
OpBranch %7
%7 = OpLabel
OpLoopMerge %8 %6 None
OpBranch %5
%5 = OpLabel
OpSelectionMerge %9 None
OpBranchConditional %true %10 %11
%10 = OpLabel
OpBranch %6
%11 = OpLabel
OpBranch %6
%9 = OpLabel
OpUnreachable
%6 = OpLabel
OpBranch %7
%8 = OpLabel
OpReturn
OpFunctionEnd
)");
}
// Test that we fail gracefully when a function has too many parameters.
// See crbug.com/354748060.
TEST_F(SpirvWriterTest, TooManyFunctionParameters) {
Vector<core::ir::FunctionParam*, 256> params;
for (uint32_t i = 0; i < 256; i++) {
params.Push(b.FunctionParam(ty.i32()));
}
auto* func = b.Function("foo", ty.void_());
func->SetParams(std::move(params));
b.Append(func->Block(), [&] { //
b.Return(func);
});
EXPECT_FALSE(Generate());
EXPECT_THAT(Error(),
testing::HasSubstr(
"Function 'foo' has more than 255 parameters after running Tint transforms"));
}
TEST_F(SpirvWriterTest, EntryPointName_Remapped) {
auto* func = b.ComputeFunction("main");
b.Append(func->Block(), [&] { //
b.Return(func);
});
Options options;
options.remapped_entry_point_name = "my_entry_point";
ASSERT_TRUE(Generate(options)) << Error() << output_;
EXPECT_INST("OpEntryPoint GLCompute %main \"my_entry_point\"");
}
TEST_F(SpirvWriterTest, EntryPointName_NotRemapped) {
auto* func = b.ComputeFunction("main");
b.Append(func->Block(), [&] { //
b.Return(func);
});
Options options;
options.remapped_entry_point_name = "";
ASSERT_TRUE(Generate(options)) << Error() << output_;
EXPECT_INST("OpEntryPoint GLCompute %main \"main\"");
}
TEST_F(SpirvWriterTest, EntryPoint_FunctionVar_Spirv1p3) {
auto* func = b.ComputeFunction("main");
b.Append(func->Block(), [&] { //
b.Var("x", 0_u);
b.Return(func);
});
Options options;
options.remapped_entry_point_name = "";
ASSERT_TRUE(Generate(options)) << Error() << output_;
EXPECT_INST("OpEntryPoint GLCompute %main \"main\"\n");
}
TEST_F(SpirvWriterTest, EntryPoint_FunctionVar_Spirv1p4) {
auto* func = b.ComputeFunction("main");
b.Append(func->Block(), [&] { //
b.Var("x", 0_u);
b.Return(func);
});
Options options;
options.remapped_entry_point_name = "";
options.spirv_version = SpvVersion::kSpv14;
ASSERT_TRUE(Generate(options)) << Error() << output_;
EXPECT_INST("OpEntryPoint GLCompute %main \"main\"\n");
}
TEST_F(SpirvWriterTest, EntryPoint_StorageVar_Spirv1p3) {
auto* v = b.Var("v", core::AddressSpace::kStorage, ty.u32(), core::Access::kReadWrite);
mod.root_block->Append(v);
v->SetBindingPoint(0, 0);
auto* func = b.ComputeFunction("main");
b.Append(func->Block(), [&] { //
b.Load(v);
b.Return(func);
});
Options options;
options.remapped_entry_point_name = "";
ASSERT_TRUE(Generate(options)) << Error() << output_;
EXPECT_INST("OpEntryPoint GLCompute %main \"main\"\n");
}
TEST_F(SpirvWriterTest, EntryPoint_StorageVar_Spirv1p4) {
auto* v = b.Var("v", core::AddressSpace::kStorage, ty.u32(), core::Access::kReadWrite);
mod.root_block->Append(v);
v->SetBindingPoint(0, 0);
auto* func = b.ComputeFunction("main");
b.Append(func->Block(), [&] { //
b.Load(v);
b.Return(func);
});
Options options;
options.remapped_entry_point_name = "";
options.spirv_version = SpvVersion::kSpv14;
ASSERT_TRUE(Generate(options)) << Error() << output_;
EXPECT_INST("OpEntryPoint GLCompute %main \"main\" %1");
}
TEST_F(SpirvWriterTest, EntryPoint_StorageVar_CalledFunction_Spirv1p4) {
auto* v = b.Var("v", core::AddressSpace::kStorage, ty.u32(), core::Access::kReadWrite);
mod.root_block->Append(v);
v->SetBindingPoint(0, 0);
auto* foo = b.Function("foo", ty.void_());
b.Append(foo->Block(), [&] { //
b.Load(v);
b.Return(foo);
});
auto* func = b.ComputeFunction("main");
b.Append(func->Block(), [&] { //
b.Call(foo);
b.Return(func);
});
Options options;
options.remapped_entry_point_name = "";
options.spirv_version = SpvVersion::kSpv14;
ASSERT_TRUE(Generate(options)) << Error() << output_;
EXPECT_INST("OpEntryPoint GLCompute %main \"main\" %1");
}
TEST_F(SpirvWriterTest, Spv14_CopyLogical) {
auto* ssbo = b.Var("ssbo", core::AddressSpace::kStorage, ty.array(ty.u32(), 4, 4),
core::Access::kReadWrite);
mod.root_block->Append(ssbo);
ssbo->SetBindingPoint(0, 0);
auto* wg = b.Var("wg", core::AddressSpace::kWorkgroup, ty.array(ty.u32(), 4, 4),
core::Access::kReadWrite);
mod.root_block->Append(wg);
auto* func = b.ComputeFunction("main");
b.Append(func->Block(), [&] { //
auto* load = b.Load(ssbo);
b.Store(wg, load);
b.Return(func);
});
Options options;
options.remapped_entry_point_name = "";
options.spirv_version = SpvVersion::kSpv14;
ASSERT_TRUE(Generate(options)) << Error() << output_;
EXPECT_INST(R"(
; Annotations
OpDecorate %_arr_uint_uint_4 ArrayStride 4
OpMemberDecorate %ssbo_block_tint_explicit_layout 0 Offset 0
OpDecorate %ssbo_block_tint_explicit_layout Block
OpDecorate %1 DescriptorSet 0
OpDecorate %1 Binding 0
OpDecorate %1 Coherent
)");
EXPECT_INST(R"(
; Types, variables and constants
%uint = OpTypeInt 32 0
%uint_4 = OpConstant %uint 4
%_arr_uint_uint_4 = OpTypeArray %uint %uint_4 ; ArrayStride 4
%ssbo_block_tint_explicit_layout = OpTypeStruct %_arr_uint_uint_4 ; Block
%_ptr_StorageBuffer_ssbo_block_tint_explicit_layout = OpTypePointer StorageBuffer %ssbo_block_tint_explicit_layout
%1 = OpVariable %_ptr_StorageBuffer_ssbo_block_tint_explicit_layout StorageBuffer ; DescriptorSet 0, Binding 0, Coherent
%_arr_uint_uint_4_0 = OpTypeArray %uint %uint_4
%_ptr_Workgroup__arr_uint_uint_4_0 = OpTypePointer Workgroup %_arr_uint_uint_4_0
%wg = OpVariable %_ptr_Workgroup__arr_uint_uint_4_0 Workgroup
)");
EXPECT_INST(R"(
%27 = OpAccessChain %_ptr_StorageBuffer__arr_uint_uint_4 %1 %uint_0
%30 = OpLoad %_arr_uint_uint_4 %27 None
%31 = OpCopyLogical %_arr_uint_uint_4_0 %30
OpStore %wg %31 None
OpReturn
)");
}
TEST_F(SpirvWriterTest, StripAllNames) {
auto* str =
ty.Struct(mod.symbols.New("MyStruct"), {
{mod.symbols.Register("a"), ty.i32()},
{mod.symbols.Register("b"), ty.vec4<i32>()},
});
auto* func = b.ComputeFunction("main");
auto* idx = b.FunctionParam("idx", ty.u32());
idx->SetBuiltin(core::BuiltinValue::kLocalInvocationIndex);
func->AppendParam(idx);
b.Append(func->Block(), [&] { //
auto* var = b.Var("str", ty.ptr<function>(str));
auto* val = b.Load(var);
mod.SetName(val, "val");
auto* a = b.Access<i32>(val, 0_u);
mod.SetName(a, "a");
b.Return(func);
});
Options options;
options.strip_all_names = true;
options.remapped_entry_point_name = "tint_entry_point";
ASSERT_TRUE(Generate(options)) << Error() << output_;
EXPECT_INST(R"(
OpEntryPoint GLCompute %16 "tint_entry_point" %gl_LocalInvocationIndex
OpExecutionMode %16 LocalSize 1 1 1
; Annotations
OpDecorate %gl_LocalInvocationIndex BuiltIn LocalInvocationIndex
; Types, variables and constants
%uint = OpTypeInt 32 0
%_ptr_Input_uint = OpTypePointer Input %uint
%gl_LocalInvocationIndex = OpVariable %_ptr_Input_uint Input ; BuiltIn LocalInvocationIndex
%void = OpTypeVoid
%7 = OpTypeFunction %void %uint
%int = OpTypeInt 32 1
%v4int = OpTypeVector %int 4
%_struct_11 = OpTypeStruct %int %v4int
%_ptr_Function__struct_11 = OpTypePointer Function %_struct_11
%14 = OpConstantNull %_struct_11
%17 = OpTypeFunction %void
; Function 4
%4 = OpFunction %void None %7
%6 = OpFunctionParameter %uint
%8 = OpLabel
%9 = OpVariable %_ptr_Function__struct_11 Function %14
%15 = OpLoad %_struct_11 %9 None
OpReturn
OpFunctionEnd
; Function 16
%16 = OpFunction %void None %17
%18 = OpLabel
%19 = OpLoad %uint %gl_LocalInvocationIndex None
%20 = OpFunctionCall %void %4 %19
OpReturn
OpFunctionEnd
)");
}
} // namespace
} // namespace tint::spirv::writer