| // Copyright 2024 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/msl/writer/helper_test.h" |
| |
| #include "gmock/gmock.h" |
| |
| namespace tint::msl::writer { |
| namespace { |
| |
| using namespace tint::core::fluent_types; // NOLINT |
| using namespace tint::core::number_suffixes; // NOLINT |
| |
| TEST_F(MslWriterTest, WorkgroupAllocations) { |
| auto* var_a = b.Var("a", ty.ptr<workgroup, i32>()); |
| auto* var_b = b.Var("b", ty.ptr<workgroup, i32>()); |
| mod.root_block->Append(var_a); |
| mod.root_block->Append(var_b); |
| |
| auto* foo = b.ComputeFunction("foo"); |
| b.Append(foo->Block(), [&] { |
| auto* load_a = b.Load(var_a); |
| auto* load_b = b.Load(var_b); |
| b.Store(var_a, b.Add<i32>(load_a, load_b)); |
| b.Return(foo); |
| }); |
| |
| // No allocations, but still needs an entry in the map. |
| auto* bar = b.ComputeFunction("bar"); |
| b.Append(bar->Block(), [&] { b.Return(bar); }); |
| |
| ASSERT_TRUE(Generate()) << err_ << output_.msl; |
| EXPECT_EQ(output_.msl, R"(#include <metal_stdlib> |
| using namespace metal; |
| |
| struct tint_module_vars_struct { |
| threadgroup int* a; |
| threadgroup int* b; |
| }; |
| |
| struct tint_symbol_2 { |
| int tint_symbol; |
| int tint_symbol_1; |
| }; |
| |
| void foo_inner(uint tint_local_index, tint_module_vars_struct tint_module_vars) { |
| if ((tint_local_index < 1u)) { |
| (*tint_module_vars.a) = 0; |
| (*tint_module_vars.b) = 0; |
| } |
| threadgroup_barrier(mem_flags::mem_threadgroup); |
| (*tint_module_vars.a) = as_type<int>((as_type<uint>((*tint_module_vars.a)) + as_type<uint>((*tint_module_vars.b)))); |
| } |
| |
| kernel void bar() { |
| } |
| |
| kernel void foo(uint tint_local_index [[thread_index_in_threadgroup]], threadgroup tint_symbol_2* v [[threadgroup(0)]]) { |
| tint_module_vars_struct const tint_module_vars = tint_module_vars_struct{.a=(&(*v).tint_symbol), .b=(&(*v).tint_symbol_1)}; |
| foo_inner(tint_local_index, tint_module_vars); |
| } |
| )"); |
| ASSERT_EQ(output_.workgroup_info.allocations.size(), 2u); |
| ASSERT_EQ(output_.workgroup_info.allocations.count("foo"), 1u); |
| ASSERT_EQ(output_.workgroup_info.allocations.count("bar"), 1u); |
| EXPECT_THAT(output_.workgroup_info.allocations.at("foo"), testing::ElementsAre(8u)); |
| EXPECT_THAT(output_.workgroup_info.allocations.at("bar"), testing::ElementsAre()); |
| } |
| |
| TEST_F(MslWriterTest, NeedsStorageBufferSizes_False) { |
| auto* var = b.Var("a", ty.ptr<storage, array<u32>>()); |
| var->SetBindingPoint(0, 0); |
| mod.root_block->Append(var); |
| |
| auto* foo = b.ComputeFunction("foo"); |
| b.Append(foo->Block(), [&] { |
| b.Store(b.Access<ptr<storage, u32>>(var, 0_u), 42_u); |
| b.Return(foo); |
| }); |
| |
| Options options; |
| options.array_length_from_uniform.bindpoint_to_size_index[{0u, 0u}] = 0u; |
| options.array_length_from_uniform.ubo_binding = 30u; |
| options.disable_robustness = true; |
| ASSERT_TRUE(Generate(options)) << err_ << output_.msl; |
| EXPECT_EQ(output_.msl, R"(#include <metal_stdlib> |
| using namespace metal; |
| |
| template<typename T, size_t N> |
| struct tint_array { |
| const constant T& operator[](size_t i) const constant { return elements[i]; } |
| device T& operator[](size_t i) device { return elements[i]; } |
| const device T& operator[](size_t i) const device { return elements[i]; } |
| thread T& operator[](size_t i) thread { return elements[i]; } |
| const thread T& operator[](size_t i) const thread { return elements[i]; } |
| threadgroup T& operator[](size_t i) threadgroup { return elements[i]; } |
| const threadgroup T& operator[](size_t i) const threadgroup { return elements[i]; } |
| T elements[N]; |
| }; |
| |
| struct tint_module_vars_struct { |
| device tint_array<uint, 1>* a; |
| }; |
| |
| kernel void foo(device tint_array<uint, 1>* a [[buffer(0)]]) { |
| tint_module_vars_struct const tint_module_vars = tint_module_vars_struct{.a=a}; |
| (*tint_module_vars.a)[0u] = 42u; |
| } |
| )"); |
| EXPECT_FALSE(output_.needs_storage_buffer_sizes); |
| } |
| |
| TEST_F(MslWriterTest, NeedsStorageBufferSizes_True) { |
| auto* var = b.Var("a", ty.ptr<storage, array<u32>>()); |
| var->SetBindingPoint(0, 0); |
| mod.root_block->Append(var); |
| |
| auto* foo = b.ComputeFunction("foo"); |
| b.Append(foo->Block(), [&] { |
| auto* length = b.Call<u32>(core::BuiltinFn::kArrayLength, var); |
| b.Store(b.Access<ptr<storage, u32>>(var, 0_u), length); |
| b.Return(foo); |
| }); |
| |
| Options options; |
| options.array_length_from_uniform.bindpoint_to_size_index[{0u, 0u}] = 0u; |
| options.array_length_from_uniform.ubo_binding = 30u; |
| options.disable_robustness = true; |
| ASSERT_TRUE(Generate(options)) << err_ << output_.msl; |
| EXPECT_EQ(output_.msl, R"(#include <metal_stdlib> |
| using namespace metal; |
| |
| template<typename T, size_t N> |
| struct tint_array { |
| const constant T& operator[](size_t i) const constant { return elements[i]; } |
| device T& operator[](size_t i) device { return elements[i]; } |
| const device T& operator[](size_t i) const device { return elements[i]; } |
| thread T& operator[](size_t i) thread { return elements[i]; } |
| const thread T& operator[](size_t i) const thread { return elements[i]; } |
| threadgroup T& operator[](size_t i) threadgroup { return elements[i]; } |
| const threadgroup T& operator[](size_t i) const threadgroup { return elements[i]; } |
| T elements[N]; |
| }; |
| |
| struct tint_module_vars_struct { |
| device tint_array<uint, 1>* a; |
| const constant tint_array<uint4, 1>* tint_storage_buffer_sizes; |
| }; |
| |
| kernel void foo(device tint_array<uint, 1>* a [[buffer(0)]], const constant tint_array<uint4, 1>* tint_storage_buffer_sizes [[buffer(30)]]) { |
| tint_module_vars_struct const tint_module_vars = tint_module_vars_struct{.a=a, .tint_storage_buffer_sizes=tint_storage_buffer_sizes}; |
| (*tint_module_vars.a)[0u] = ((*tint_module_vars.tint_storage_buffer_sizes)[0u].x / 4u); |
| } |
| )"); |
| EXPECT_TRUE(output_.needs_storage_buffer_sizes); |
| } |
| |
| TEST_F(MslWriterTest, StripAllNames) { |
| auto* str = |
| ty.Struct(mod.symbols.New("MyStruct"), { |
| {mod.symbols.Register("a"), ty.i32()}, |
| {mod.symbols.Register("b"), ty.vec4<i32>()}, |
| }); |
| auto* foo = b.Function("foo", ty.u32()); |
| auto* param = b.FunctionParam("param", ty.u32()); |
| foo->AppendParam(param); |
| b.Append(foo->Block(), [&] { // |
| b.Return(foo, param); |
| }); |
| |
| 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.Let("let", b.Call<u32>(foo, idx)); |
| b.Return(func); |
| }); |
| |
| Options options; |
| options.remapped_entry_point_name = "tint_entry_point"; |
| options.strip_all_names = true; |
| ASSERT_TRUE(Generate(options)) << err_ << output_.msl; |
| EXPECT_EQ(output_.msl, MetalHeader() + R"( |
| struct tint_struct { |
| int tint_member; |
| int4 tint_member_1; |
| }; |
| |
| uint v(uint v_1) { |
| return v_1; |
| } |
| |
| void v_2(uint v_3) { |
| tint_struct v_4 = {}; |
| uint const v_5 = v(v_3); |
| } |
| |
| kernel void tint_entry_point(uint v_7 [[thread_index_in_threadgroup]]) { |
| v_2(v_7); |
| } |
| )"); |
| } |
| |
| TEST_F(MslWriterTest, VertexPulling) { |
| auto* ep = b.Function("main", ty.vec4<f32>(), core::ir::Function::PipelineStage::kVertex); |
| ep->SetReturnBuiltin(core::BuiltinValue::kPosition); |
| auto* attr = b.FunctionParam<vec4<f32>>("attr"); |
| attr->SetLocation(1); |
| ep->SetParams({attr}); |
| b.Append(ep->Block(), [&] { // |
| b.Return(ep, attr); |
| }); |
| |
| VertexPullingConfig vertex_pulling_config; |
| vertex_pulling_config.pulling_group = 4u; |
| vertex_pulling_config.vertex_state = { |
| {{4, VertexStepMode::kVertex, {{VertexFormat::kFloat32, 0, 1}}}}}; |
| ArrayLengthFromUniformOptions array_length_config; |
| array_length_config.ubo_binding = 30u; |
| array_length_config.bindpoint_to_size_index.insert({BindingPoint{0u, 1u}, 0u}); |
| Options options; |
| options.bindings.storage.emplace(BindingPoint{4u, 0u}, tint::msl::writer::binding::Storage{1u}); |
| options.vertex_pulling_config = std::move(vertex_pulling_config); |
| options.array_length_from_uniform = std::move(array_length_config); |
| |
| ASSERT_TRUE(Generate(options)) << err_ << output_.msl; |
| EXPECT_EQ(output_.msl, R"(#include <metal_stdlib> |
| using namespace metal; |
| |
| template<typename T, size_t N> |
| struct tint_array { |
| const constant T& operator[](size_t i) const constant { return elements[i]; } |
| device T& operator[](size_t i) device { return elements[i]; } |
| const device T& operator[](size_t i) const device { return elements[i]; } |
| thread T& operator[](size_t i) thread { return elements[i]; } |
| const thread T& operator[](size_t i) const thread { return elements[i]; } |
| threadgroup T& operator[](size_t i) threadgroup { return elements[i]; } |
| const threadgroup T& operator[](size_t i) const threadgroup { return elements[i]; } |
| T elements[N]; |
| }; |
| |
| struct tint_module_vars_struct { |
| const device tint_array<uint, 1>* tint_vertex_buffer_0; |
| const constant tint_array<uint4, 1>* tint_storage_buffer_sizes; |
| }; |
| |
| struct main_outputs { |
| float4 tint_symbol [[position]]; |
| }; |
| |
| float4 main_inner(uint tint_vertex_index, tint_module_vars_struct tint_module_vars) { |
| return float4(as_type<float>((*tint_module_vars.tint_vertex_buffer_0)[min(tint_vertex_index, (((*tint_module_vars.tint_storage_buffer_sizes)[0u].x / 4u) - 1u))]), 0.0f, 0.0f, 1.0f); |
| } |
| |
| vertex main_outputs v(uint tint_vertex_index [[vertex_id]], const device tint_array<uint, 1>* tint_vertex_buffer_0 [[buffer(1)]], const constant tint_array<uint4, 1>* tint_storage_buffer_sizes [[buffer(30)]]) { |
| tint_module_vars_struct const tint_module_vars = tint_module_vars_struct{.tint_vertex_buffer_0=tint_vertex_buffer_0, .tint_storage_buffer_sizes=tint_storage_buffer_sizes}; |
| main_outputs tint_wrapper_result = {}; |
| tint_wrapper_result.tint_symbol = main_inner(tint_vertex_index, tint_module_vars); |
| return tint_wrapper_result; |
| } |
| )"); |
| } |
| |
| } // namespace |
| } // namespace tint::msl::writer |