src/validator_control_block_test.cc

// Copyright 2020 The Tint 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 "src/validator_impl.h"

#include "gtest/gtest.h"
#include "spirv/unified1/GLSL.std.450.h"
#include "src/ast/case_statement.h"
#include "src/ast/fallthrough_statement.h"
#include "src/ast/return_statement.h"
#include "src/ast/scalar_constructor_expression.h"
#include "src/ast/sint_literal.h"
#include "src/ast/switch_statement.h"
#include "src/ast/type/alias_type.h"
#include "src/ast/type/f32_type.h"
#include "src/ast/type/i32_type.h"
#include "src/ast/type/u32_type.h"
#include "src/ast/uint_literal.h"
#include "src/ast/variable.h"
#include "src/ast/variable_decl_statement.h"
#include "src/type_determiner.h"
#include "src/validator_test_helper.h"

namespace tint {
namespace {

class ValidateControlBlockTest : public ValidatorTestHelper,
                                 public testing::Test {};

TEST_F(ValidateControlBlockTest, SwitchSelectorExpressionNoneIntegerType_Fail) {
  // var a : f32 = 3.14;
  // switch (a) {
  //   default: {}
  // }
  ast::type::F32Type f32;
  auto var =
      std::make_unique<ast::Variable>("a", ast::StorageClass::kNone, &f32);
  var->set_constructor(std::make_unique<ast::ScalarConstructorExpression>(
      std::make_unique<ast::SintLiteral>(&f32, 3.14f)));

  auto cond = std::make_unique<ast::IdentifierExpression>(Source{12, 34}, "a");
  ast::CaseSelectorList default_csl;
  auto block_default = std::make_unique<ast::BlockStatement>();
  ast::CaseStatementList body;
  body.push_back(std::make_unique<ast::CaseStatement>(
      std::move(default_csl), std::move(block_default)));

  auto block = std::make_unique<ast::BlockStatement>();
  block->append(std::make_unique<ast::VariableDeclStatement>(std::move(var)));
  block->append(
      std::make_unique<ast::SwitchStatement>(std::move(cond), std::move(body)));

  EXPECT_TRUE(td()->DetermineStatements(block.get())) << td()->error();
  EXPECT_FALSE(v()->ValidateStatements(block.get()));
  EXPECT_EQ(v()->error(),
            "12:34: v-switch01: switch statement selector expression must be "
            "of a scalar integer type");
}

TEST_F(ValidateControlBlockTest, SwitchWithoutDefault_Fail) {
  // var a : i32 = 2;
  // switch (a) {
  //   case 1: {}
  // }
  ast::type::I32Type i32;
  auto var =
      std::make_unique<ast::Variable>("a", ast::StorageClass::kNone, &i32);
  var->set_constructor(std::make_unique<ast::ScalarConstructorExpression>(
      std::make_unique<ast::SintLiteral>(&i32, 2)));

  auto cond = std::make_unique<ast::IdentifierExpression>("a");
  ast::CaseSelectorList csl;
  csl.push_back(std::make_unique<ast::SintLiteral>(&i32, 1));
  ast::CaseStatementList body;
  body.push_back(std::make_unique<ast::CaseStatement>(
      std::move(csl), std::make_unique<ast::BlockStatement>()));

  auto block = std::make_unique<ast::BlockStatement>();
  block->append(std::make_unique<ast::VariableDeclStatement>(std::move(var)));
  block->append(std::make_unique<ast::SwitchStatement>(
      Source{12, 34}, std::move(cond), std::move(body)));

  EXPECT_TRUE(td()->DetermineStatements(block.get())) << td()->error();
  EXPECT_FALSE(v()->ValidateStatements(block.get()));
  EXPECT_EQ(v()->error(),
            "12:34: v-0008: switch statement must have exactly one default "
            "clause");
}

TEST_F(ValidateControlBlockTest, SwitchWithTwoDefault_Fail) {
  // var a : i32 = 2;
  // switch (a) {
  //   default: {}
  //   case 1: {}
  //   default: {}
  // }
  ast::type::I32Type i32;
  auto var =
      std::make_unique<ast::Variable>("a", ast::StorageClass::kNone, &i32);
  var->set_constructor(std::make_unique<ast::ScalarConstructorExpression>(
      std::make_unique<ast::SintLiteral>(&i32, 2)));

  ast::CaseStatementList switch_body;
  auto cond = std::make_unique<ast::IdentifierExpression>("a");

  ast::CaseSelectorList default_csl_1;
  auto block_default_1 = std::make_unique<ast::BlockStatement>();
  switch_body.push_back(std::make_unique<ast::CaseStatement>(
      std::move(default_csl_1), std::move(block_default_1)));

  ast::CaseSelectorList csl_case_1;
  csl_case_1.push_back(std::make_unique<ast::SintLiteral>(&i32, 1));
  auto block_case_1 = std::make_unique<ast::BlockStatement>();
  switch_body.push_back(std::make_unique<ast::CaseStatement>(
      std::move(csl_case_1), std::move(block_case_1)));

  ast::CaseSelectorList default_csl_2;
  auto block_default_2 = std::make_unique<ast::BlockStatement>();
  switch_body.push_back(std::make_unique<ast::CaseStatement>(
      std::move(default_csl_2), std::move(block_default_2)));

  auto block = std::make_unique<ast::BlockStatement>();
  block->append(std::make_unique<ast::VariableDeclStatement>(std::move(var)));
  block->append(std::make_unique<ast::SwitchStatement>(
      Source{12, 34}, std::move(cond), std::move(switch_body)));

  EXPECT_TRUE(td()->DetermineStatements(block.get())) << td()->error();
  EXPECT_FALSE(v()->ValidateStatements(block.get()));
  EXPECT_EQ(v()->error(),
            "12:34: v-0008: switch statement must have exactly one default "
            "clause");
}

TEST_F(ValidateControlBlockTest,
       SwitchConditionTypeMustMatchSelectorType2_Fail) {
  // var a : i32 = 2;
  // switch (a) {
  //   case 1: {}
  //   default: {}
  // }
  ast::type::U32Type u32;
  ast::type::I32Type i32;
  auto var =
      std::make_unique<ast::Variable>("a", ast::StorageClass::kNone, &i32);
  var->set_constructor(std::make_unique<ast::ScalarConstructorExpression>(
      std::make_unique<ast::SintLiteral>(&i32, 2)));

  ast::CaseStatementList switch_body;
  auto cond = std::make_unique<ast::IdentifierExpression>("a");

  ast::CaseSelectorList csl;
  csl.push_back(std::make_unique<ast::UintLiteral>(&u32, 1));
  switch_body.push_back(std::make_unique<ast::CaseStatement>(
      Source{12, 34}, std::move(csl), std::make_unique<ast::BlockStatement>()));

  ast::CaseSelectorList default_csl;
  auto block_default = std::make_unique<ast::BlockStatement>();
  switch_body.push_back(std::make_unique<ast::CaseStatement>(
      std::move(default_csl), std::move(block_default)));

  auto block = std::make_unique<ast::BlockStatement>();
  block->append(std::make_unique<ast::VariableDeclStatement>(std::move(var)));
  block->append(std::make_unique<ast::SwitchStatement>(std::move(cond),
                                                       std::move(switch_body)));

  EXPECT_TRUE(td()->DetermineStatements(block.get())) << td()->error();
  EXPECT_FALSE(v()->ValidateStatements(block.get()));
  EXPECT_EQ(v()->error(),
            "12:34: v-switch03: the case selector values must have the same "
            "type as the selector expression.");
}

TEST_F(ValidateControlBlockTest,
       SwitchConditionTypeMustMatchSelectorType_Fail) {
  // var a : u32 = 2;
  // switch (a) {
  //   case -1: {}
  //   default: {}
  // }
  ast::type::U32Type u32;
  ast::type::I32Type i32;
  auto var =
      std::make_unique<ast::Variable>("a", ast::StorageClass::kNone, &u32);
  var->set_constructor(std::make_unique<ast::ScalarConstructorExpression>(
      std::make_unique<ast::UintLiteral>(&u32, 2)));

  ast::CaseStatementList switch_body;
  auto cond = std::make_unique<ast::IdentifierExpression>("a");

  ast::CaseSelectorList csl;
  csl.push_back(std::make_unique<ast::SintLiteral>(&i32, -1));
  switch_body.push_back(std::make_unique<ast::CaseStatement>(
      Source{12, 34}, std::move(csl), std::make_unique<ast::BlockStatement>()));

  ast::CaseSelectorList default_csl;
  auto block_default = std::make_unique<ast::BlockStatement>();
  switch_body.push_back(std::make_unique<ast::CaseStatement>(
      std::move(default_csl), std::move(block_default)));

  auto block = std::make_unique<ast::BlockStatement>();
  block->append(std::make_unique<ast::VariableDeclStatement>(std::move(var)));
  block->append(std::make_unique<ast::SwitchStatement>(std::move(cond),
                                                       std::move(switch_body)));

  EXPECT_TRUE(td()->DetermineStatements(block.get())) << td()->error();
  EXPECT_FALSE(v()->ValidateStatements(block.get()));
  EXPECT_EQ(v()->error(),
            "12:34: v-switch03: the case selector values must have the same "
            "type as the selector expression.");
}

TEST_F(ValidateControlBlockTest, NonUniqueCaseSelectorValueUint_Fail) {
  // var a : u32 = 3;
  // switch (a) {
  //   case 0: {}
  //   case 2, 2: {}
  //   default: {}
  // }
  ast::type::U32Type u32;
  auto var =
      std::make_unique<ast::Variable>("a", ast::StorageClass::kNone, &u32);
  var->set_constructor(std::make_unique<ast::ScalarConstructorExpression>(
      std::make_unique<ast::UintLiteral>(&u32, 3)));

  ast::CaseStatementList switch_body;
  auto cond = std::make_unique<ast::IdentifierExpression>("a");

  ast::CaseSelectorList csl_1;
  csl_1.push_back(std::make_unique<ast::UintLiteral>(&u32, 0));
  switch_body.push_back(std::make_unique<ast::CaseStatement>(
      std::move(csl_1), std::make_unique<ast::BlockStatement>()));

  ast::CaseSelectorList csl_2;
  csl_2.push_back(std::make_unique<ast::UintLiteral>(&u32, 2));
  csl_2.push_back(std::make_unique<ast::UintLiteral>(&u32, 2));
  switch_body.push_back(std::make_unique<ast::CaseStatement>(
      Source{12, 34}, std::move(csl_2),
      std::make_unique<ast::BlockStatement>()));

  ast::CaseSelectorList default_csl;
  auto block_default = std::make_unique<ast::BlockStatement>();
  switch_body.push_back(std::make_unique<ast::CaseStatement>(
      std::move(default_csl), std::move(block_default)));

  auto block = std::make_unique<ast::BlockStatement>();
  block->append(std::make_unique<ast::VariableDeclStatement>(std::move(var)));
  block->append(std::make_unique<ast::SwitchStatement>(std::move(cond),
                                                       std::move(switch_body)));

  EXPECT_TRUE(td()->DetermineStatements(block.get())) << td()->error();
  EXPECT_FALSE(v()->ValidateStatements(block.get()));
  EXPECT_EQ(v()->error(),
            "12:34: v-switch04: a literal value must not appear more than once "
            "in the case selectors for a switch statement: '2'");
}

TEST_F(ValidateControlBlockTest, NonUniqueCaseSelectorValueSint_Fail) {
  // var a : i32 = 2;
  // switch (a) {
  //   case 10: {}
  //   case 0,1,2,10: {}
  //   default: {}
  // }
  ast::type::I32Type i32;
  auto var =
      std::make_unique<ast::Variable>("a", ast::StorageClass::kNone, &i32);
  var->set_constructor(std::make_unique<ast::ScalarConstructorExpression>(
      std::make_unique<ast::SintLiteral>(&i32, 2)));

  ast::CaseStatementList switch_body;
  auto cond = std::make_unique<ast::IdentifierExpression>("a");

  ast::CaseSelectorList csl_1;
  csl_1.push_back(std::make_unique<ast::SintLiteral>(&i32, 10));
  switch_body.push_back(std::make_unique<ast::CaseStatement>(
      std::move(csl_1), std::make_unique<ast::BlockStatement>()));

  ast::CaseSelectorList csl_2;
  csl_2.push_back(std::make_unique<ast::SintLiteral>(&i32, 0));
  csl_2.push_back(std::make_unique<ast::SintLiteral>(&i32, 1));
  csl_2.push_back(std::make_unique<ast::SintLiteral>(&i32, 2));
  csl_2.push_back(std::make_unique<ast::SintLiteral>(&i32, 10));
  switch_body.push_back(std::make_unique<ast::CaseStatement>(
      Source{12, 34}, std::move(csl_2),
      std::make_unique<ast::BlockStatement>()));

  ast::CaseSelectorList default_csl;
  auto block_default = std::make_unique<ast::BlockStatement>();
  switch_body.push_back(std::make_unique<ast::CaseStatement>(
      std::move(default_csl), std::move(block_default)));

  auto block = std::make_unique<ast::BlockStatement>();
  block->append(std::make_unique<ast::VariableDeclStatement>(std::move(var)));
  block->append(std::make_unique<ast::SwitchStatement>(std::move(cond),
                                                       std::move(switch_body)));

  EXPECT_TRUE(td()->DetermineStatements(block.get())) << td()->error();
  EXPECT_FALSE(v()->ValidateStatements(block.get()));
  EXPECT_EQ(
      v()->error(),
      "12:34: v-switch04: a literal value must not appear more than once in "
      "the case selectors for a switch statement: '10'");
}

TEST_F(ValidateControlBlockTest, LastClauseLastStatementIsFallthrough_Fail) {
  // var a : i32 = 2;
  // switch (a) {
  //   default: { fallthrough; }
  // }
  ast::type::I32Type i32;
  auto var =
      std::make_unique<ast::Variable>("a", ast::StorageClass::kNone, &i32);
  var->set_constructor(std::make_unique<ast::ScalarConstructorExpression>(
      std::make_unique<ast::SintLiteral>(&i32, 2)));

  auto cond = std::make_unique<ast::IdentifierExpression>("a");
  ast::CaseSelectorList default_csl;
  auto block_default = std::make_unique<ast::BlockStatement>();
  block_default->append(
      std::make_unique<ast::FallthroughStatement>(Source{12, 34}));
  ast::CaseStatementList body;
  body.push_back(std::make_unique<ast::CaseStatement>(
      std::move(default_csl), std::move(block_default)));

  auto block = std::make_unique<ast::BlockStatement>();
  block->append(std::make_unique<ast::VariableDeclStatement>(std::move(var)));
  block->append(
      std::make_unique<ast::SwitchStatement>(std::move(cond), std::move(body)));

  EXPECT_TRUE(td()->DetermineStatements(block.get())) << td()->error();
  EXPECT_FALSE(v()->ValidateStatements(block.get()));
  EXPECT_EQ(v()->error(),
            "12:34: v-switch05: a fallthrough statement must not appear as the "
            "last statement in last clause of a switch");
}

TEST_F(ValidateControlBlockTest, SwitchCase_Pass) {
  // var a : i32 = 2;
  // switch (a) {
  //   default: {}
  //   case 5: {}
  // }
  ast::type::I32Type i32;
  auto var =
      std::make_unique<ast::Variable>("a", ast::StorageClass::kNone, &i32);
  var->set_constructor(std::make_unique<ast::ScalarConstructorExpression>(
      std::make_unique<ast::SintLiteral>(&i32, 2)));

  auto cond = std::make_unique<ast::IdentifierExpression>("a");
  ast::CaseSelectorList default_csl;
  auto block_default = std::make_unique<ast::BlockStatement>();
  ast::CaseStatementList body;
  body.push_back(std::make_unique<ast::CaseStatement>(
      Source{12, 34}, std::move(default_csl), std::move(block_default)));
  ast::CaseSelectorList case_csl;
  case_csl.push_back(std::make_unique<ast::SintLiteral>(&i32, 5));
  auto block_case = std::make_unique<ast::BlockStatement>();
  body.push_back(std::make_unique<ast::CaseStatement>(std::move(case_csl),
                                                      std::move(block_case)));

  auto block = std::make_unique<ast::BlockStatement>();
  block->append(std::make_unique<ast::VariableDeclStatement>(std::move(var)));
  block->append(
      std::make_unique<ast::SwitchStatement>(std::move(cond), std::move(body)));

  EXPECT_TRUE(td()->DetermineStatements(block.get())) << td()->error();
  EXPECT_TRUE(v()->ValidateStatements(block.get())) << v()->error();
}

TEST_F(ValidateControlBlockTest, SwitchCaseAlias_Pass) {
  // entry_point vertex = main
  // type MyInt = u32;
  // fn main()->void {
  //   var v: MyInt;
  //   switch(v){
  //     default: {}
  //   }
  // }
  ast::type::U32Type u32;
  ast::type::AliasType my_int{"MyInt", &u32};

  auto var =
      std::make_unique<ast::Variable>("a", ast::StorageClass::kNone, &my_int);
  var->set_constructor(std::make_unique<ast::ScalarConstructorExpression>(
      std::make_unique<ast::SintLiteral>(&u32, 2)));

  auto cond = std::make_unique<ast::IdentifierExpression>("a");
  ast::CaseSelectorList default_csl;
  auto block_default = std::make_unique<ast::BlockStatement>();
  ast::CaseStatementList body;
  body.push_back(std::make_unique<ast::CaseStatement>(
      Source{12, 34}, std::move(default_csl), std::move(block_default)));

  auto block = std::make_unique<ast::BlockStatement>();
  block->append(std::make_unique<ast::VariableDeclStatement>(std::move(var)));
  block->append(
      std::make_unique<ast::SwitchStatement>(std::move(cond), std::move(body)));
  block->append(std::make_unique<ast::ReturnStatement>());

  ast::type::VoidType void_type;
  ast::VariableList params;
  auto func =
      std::make_unique<ast::Function>("main", std::move(params), &void_type);
  func->set_body(std::move(block));
  auto entry_point = std::make_unique<ast::EntryPoint>(
      ast::PipelineStage::kVertex, "", "main");
  mod()->AddFunction(std::move(func));
  mod()->AddAliasType(&my_int);
  mod()->AddEntryPoint(std::move(entry_point));

  EXPECT_TRUE(td()->Determine()) << td()->error();
  EXPECT_TRUE(v()->Validate(mod())) << v()->error();
}

}  // namespace
}  // namespace tint