blob: f2ac3b169e81bca0e60110d8d7c6863bafe37596 [file] [log] [blame]
// Copyright 2020 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/core/fluent_types.h"
#include "src/tint/lang/msl/writer/ast_printer/helper_test.h"
#include "src/tint/lang/wgsl/ast/variable_decl_statement.h"
using namespace tint::core::number_suffixes; // NOLINT
using namespace tint::core::fluent_types; // NOLINT
namespace tint::msl::writer {
namespace {
using MslASTPrinterTest = TestHelper;
TEST_F(MslASTPrinterTest, Emit_Loop) {
auto* body = Block(Break());
auto* continuing = Block();
auto* l = Loop(body, continuing);
Func("F", tint::Empty, ty.void_(), Vector{l}, Vector{Stage(ast::PipelineStage::kFragment)});
ASTPrinter& gen = Build();
ASSERT_TRUE(gen.Generate()) << gen.Diagnostics();
EXPECT_EQ(gen.Result(), R"(#include <metal_stdlib>
using namespace metal;
#define TINT_ISOLATE_UB(VOLATILE_NAME) \
{volatile bool VOLATILE_NAME = false; if (VOLATILE_NAME) break;}
fragment void F() {
while(true) {
TINT_ISOLATE_UB(tint_volatile_false);
break;
}
return;
}
)");
}
TEST_F(MslASTPrinterTest, Emit_LoopWithContinuing) {
Func("a_statement", {}, ty.void_(), tint::Empty);
auto* body = Block(Break());
auto* continuing = Block(CallStmt(Call("a_statement")));
auto* l = Loop(body, continuing);
Func("F", tint::Empty, ty.void_(), Vector{l}, Vector{Stage(ast::PipelineStage::kFragment)});
ASTPrinter& gen = Build();
ASSERT_TRUE(gen.Generate()) << gen.Diagnostics();
EXPECT_EQ(gen.Result(), R"(#include <metal_stdlib>
using namespace metal;
#define TINT_ISOLATE_UB(VOLATILE_NAME) \
{volatile bool VOLATILE_NAME = false; if (VOLATILE_NAME) break;}
void a_statement() {
}
fragment void F() {
while(true) {
TINT_ISOLATE_UB(tint_volatile_false);
break;
{
a_statement();
}
}
return;
}
)");
}
TEST_F(MslASTPrinterTest, Emit_LoopWithContinuing_BreakIf) {
Func("a_statement", {}, ty.void_(), {});
auto* body = Block(Break());
auto* continuing = Block(CallStmt(Call("a_statement")), BreakIf(true));
auto* l = Loop(body, continuing);
Func("F", tint::Empty, ty.void_(), Vector{l}, Vector{Stage(ast::PipelineStage::kFragment)});
ASTPrinter& gen = Build();
ASSERT_TRUE(gen.Generate()) << gen.Diagnostics();
EXPECT_EQ(gen.Result(), R"(#include <metal_stdlib>
using namespace metal;
#define TINT_ISOLATE_UB(VOLATILE_NAME) \
{volatile bool VOLATILE_NAME = false; if (VOLATILE_NAME) break;}
void a_statement() {
}
fragment void F() {
while(true) {
TINT_ISOLATE_UB(tint_volatile_false);
break;
{
a_statement();
if (true) { break; }
}
}
return;
}
)");
}
TEST_F(MslASTPrinterTest, Emit_LoopNestedWithContinuing) {
Func("a_statement", {}, ty.void_(), tint::Empty);
GlobalVar("lhs", ty.f32(), core::AddressSpace::kPrivate);
GlobalVar("rhs", ty.f32(), core::AddressSpace::kPrivate);
auto* body = Block(Break());
auto* continuing = Block(CallStmt(Call("a_statement")));
auto* inner = Loop(body, continuing);
body = Block(inner);
continuing = Block(Assign("lhs", "rhs"), BreakIf(true));
auto* outer = Loop(body, continuing);
Func("F", tint::Empty, ty.void_(), Vector{outer}, Vector{Stage(ast::PipelineStage::kFragment)});
ASTPrinter& gen = Build();
ASSERT_TRUE(gen.EmitStatement(outer)) << gen.Diagnostics();
EXPECT_EQ(gen.Result(), R"(while(true) {
TINT_ISOLATE_UB(tint_volatile_false);
while(true) {
TINT_ISOLATE_UB(tint_volatile_false_1);
break;
{
a_statement();
}
}
{
lhs = rhs;
if (true) { break; }
}
}
)");
}
TEST_F(MslASTPrinterTest, Emit_LoopWithVarUsedInContinuing) {
// loop {
// var lhs : f32 = 2.5;
// var other : f32;
// continuing {
// lhs = rhs
// }
// }
//
GlobalVar("rhs", ty.f32(), core::AddressSpace::kPrivate);
auto* body = Block(Decl(Var("lhs", ty.f32(), Expr(2.5_f))), //
Decl(Var("other", ty.f32())), //
Break());
auto* continuing = Block(Assign("lhs", "rhs"));
auto* outer = Loop(body, continuing);
WrapInFunction(outer);
ASTPrinter& gen = Build();
ASSERT_TRUE(gen.EmitStatement(outer)) << gen.Diagnostics();
EXPECT_EQ(gen.Result(), R"(while(true) {
TINT_ISOLATE_UB(tint_volatile_false);
float lhs = 2.5f;
float other = 0.0f;
break;
{
lhs = rhs;
}
}
)");
}
TEST_F(MslASTPrinterTest, Emit_ForLoop) {
// for(; ; ) {
// return;
// }
auto* f = For(nullptr, nullptr, nullptr, //
Block(Return()));
WrapInFunction(f);
ASTPrinter& gen = Build();
ASSERT_TRUE(gen.EmitStatement(f)) << gen.Diagnostics();
EXPECT_EQ(gen.Result(), R"(for(; ; ) {
TINT_ISOLATE_UB(tint_volatile_false);
return;
}
)");
}
TEST_F(MslASTPrinterTest, Emit_ForLoopWithSimpleInit) {
// for(var i : i32; ; ) {
// return;
// }
auto* f = For(Decl(Var("i", ty.i32())), nullptr, nullptr, //
Block(Return()));
WrapInFunction(f);
ASTPrinter& gen = Build();
ASSERT_TRUE(gen.EmitStatement(f)) << gen.Diagnostics();
EXPECT_EQ(gen.Result(), R"(for(int i = 0; ; ) {
TINT_ISOLATE_UB(tint_volatile_false);
return;
}
)");
}
TEST_F(MslASTPrinterTest, Emit_ForLoopWithMultiStmtInit) {
// fn f(i : i32) {}
//
// var<workgroup> a : atomic<i32>;
// for({f(1i); f(2i);}; ; ) {
// return;
// }
Func("f", Vector{Param("i", ty.i32())}, ty.void_(), tint::Empty);
auto f = [&](auto&& expr) { return CallStmt(Call("f", expr)); };
GlobalVar("a", ty.atomic<i32>(), core::AddressSpace::kWorkgroup);
auto* multi_stmt = Block(f(1_i), f(2_i));
auto* loop = For(multi_stmt, nullptr, nullptr, //
Block(Return()));
WrapInFunction(loop);
ASTPrinter& gen = Build();
ASSERT_TRUE(gen.EmitStatement(loop)) << gen.Diagnostics();
EXPECT_EQ(gen.Result(), R"({
{
f(1);
f(2);
}
for(; ; ) {
TINT_ISOLATE_UB(tint_volatile_false);
return;
}
}
)");
}
TEST_F(MslASTPrinterTest, Emit_ForLoopWithSimpleCond) {
// for(; true; ) {
// return;
// }
auto* f = For(nullptr, true, nullptr, //
Block(Return()));
WrapInFunction(f);
ASTPrinter& gen = Build();
ASSERT_TRUE(gen.EmitStatement(f)) << gen.Diagnostics();
EXPECT_EQ(gen.Result(), R"(for(; true; ) {
TINT_ISOLATE_UB(tint_volatile_false);
return;
}
)");
}
TEST_F(MslASTPrinterTest, Emit_ForLoopWithSimpleCont) {
// for(; ; i = i + 1) {
// return;
// }
auto* v = Decl(Var("i", ty.i32()));
auto* f = For(nullptr, nullptr, Assign("i", Add("i", 1_i)), //
Block(Return()));
WrapInFunction(v, f);
ASTPrinter& gen = Build();
ASSERT_TRUE(gen.EmitStatement(f)) << gen.Diagnostics();
EXPECT_EQ(gen.Result(),
R"(for(; ; i = as_type<int>((as_type<uint>(i) + as_type<uint>(1)))) {
TINT_ISOLATE_UB(tint_volatile_false);
return;
}
)");
}
TEST_F(MslASTPrinterTest, Emit_ForLoopWithMultiStmtCont) {
// fn f(i : i32) {}
//
// var<workgroup> a : atomic<i32>;
// for(; ; { f(1i); f(2i); }) {
// return;
// }
Func("f", Vector{Param("i", ty.i32())}, ty.void_(), tint::Empty);
auto f = [&](auto&& expr) { return CallStmt(Call("f", expr)); };
GlobalVar("a", ty.atomic<i32>(), core::AddressSpace::kWorkgroup);
auto* multi_stmt = Block(f(1_i), f(2_i));
auto* loop = For(nullptr, nullptr, multi_stmt, //
Block(Return()));
WrapInFunction(loop);
ASTPrinter& gen = Build();
ASSERT_TRUE(gen.EmitStatement(loop)) << gen.Diagnostics();
EXPECT_EQ(gen.Result(), R"(while(true) {
TINT_ISOLATE_UB(tint_volatile_false);
return;
{
f(1);
f(2);
}
}
)");
}
TEST_F(MslASTPrinterTest, Emit_ForLoopWithSimpleInitCondCont) {
// for(var i : i32; true; i = i + 1) {
// return;
// }
Func("a_statement", {}, ty.void_(), tint::Empty);
auto* f = For(Decl(Var("i", ty.i32())), true, Assign("i", Add("i", 1_i)),
Block(CallStmt(Call("a_statement"))));
WrapInFunction(f);
ASTPrinter& gen = Build();
ASSERT_TRUE(gen.EmitStatement(f)) << gen.Diagnostics();
EXPECT_EQ(gen.Result(),
R"(for(int i = 0; true; i = as_type<int>((as_type<uint>(i) + as_type<uint>(1)))) {
TINT_ISOLATE_UB(tint_volatile_false);
a_statement();
}
)");
}
TEST_F(MslASTPrinterTest, Emit_ForLoopWithMultiStmtInitCondCont) {
// fn f(i : i32) {}
//
// var<workgroup> a : atomic<i32>;
// for({ f(1i); f(2i); }; true; { f(3i); f(4i); }) {
// return;
// }
Func("f", Vector{Param("i", ty.i32())}, ty.void_(), tint::Empty);
auto f = [&](auto&& expr) { return CallStmt(Call("f", expr)); };
GlobalVar("a", ty.atomic<i32>(), core::AddressSpace::kWorkgroup);
auto* multi_stmt_a = Block(f(1_i), f(2_i));
auto* multi_stmt_b = Block(f(3_i), f(4_i));
auto* loop = For(multi_stmt_a, Expr(true), multi_stmt_b, //
Block(Return()));
WrapInFunction(loop);
ASTPrinter& gen = Build();
ASSERT_TRUE(gen.EmitStatement(loop)) << gen.Diagnostics();
EXPECT_EQ(gen.Result(), R"({
{
f(1);
f(2);
}
while(true) {
TINT_ISOLATE_UB(tint_volatile_false);
if (!(true)) { break; }
return;
{
f(3);
f(4);
}
}
}
)");
}
TEST_F(MslASTPrinterTest, Emit_While) {
// while(true) {
// return;
// }
auto* f = While(Expr(true), Block(Return()));
WrapInFunction(f);
ASTPrinter& gen = Build();
ASSERT_TRUE(gen.EmitStatement(f)) << gen.Diagnostics();
EXPECT_EQ(gen.Result(), R"(while(true) {
TINT_ISOLATE_UB(tint_volatile_false);
return;
}
)");
}
TEST_F(MslASTPrinterTest, Emit_While_WithContinue) {
// while(true) {
// continue;
// }
auto* f = While(Expr(true), Block(Continue()));
WrapInFunction(f);
ASTPrinter& gen = Build();
ASSERT_TRUE(gen.EmitStatement(f)) << gen.Diagnostics();
EXPECT_EQ(gen.Result(), R"(while(true) {
TINT_ISOLATE_UB(tint_volatile_false);
continue;
}
)");
}
TEST_F(MslASTPrinterTest, Emit_WhileWithMultiCond) {
// while(true && false) {
// return;
// }
auto* t = Let("t", Expr(true));
auto* multi_stmt = LogicalAnd(t, false);
// create<ast::BinaryExpression>(core::BinaryOp::kLogicalAnd, Expr(t), Expr(false));
auto* f = While(multi_stmt, Block(Return()));
WrapInFunction(t, f);
ASTPrinter& gen = Build();
ASSERT_TRUE(gen.EmitStatement(f)) << gen.Diagnostics();
EXPECT_EQ(gen.Result(), R"(while((t && false)) {
TINT_ISOLATE_UB(tint_volatile_false);
return;
}
)");
}
} // namespace
} // namespace tint::msl::writer