test/fuzz/transformation_add_constant_boolean_test.cpp

// Copyright (c) 2019 Google LLC
//
// 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 "source/fuzz/transformation_add_constant_boolean.h"

#include "gtest/gtest.h"
#include "source/fuzz/fuzzer_util.h"
#include "test/fuzz/fuzz_test_util.h"

namespace spvtools {
namespace fuzz {
namespace {

TEST(TransformationAddConstantBooleanTest, NeitherPresentInitiallyAddBoth) {
  std::string shader = R"(
               OpCapability Shader
          %1 = OpExtInstImport "GLSL.std.450"
               OpMemoryModel Logical GLSL450
               OpEntryPoint Fragment %4 "main"
               OpExecutionMode %4 OriginUpperLeft
               OpSource ESSL 310
               OpName %4 "main"
          %2 = OpTypeVoid
          %6 = OpTypeBool
          %3 = OpTypeFunction %2
          %4 = OpFunction %2 None %3
          %5 = OpLabel
               OpReturn
               OpFunctionEnd
  )";

  const auto env = SPV_ENV_UNIVERSAL_1_3;
  const auto consumer = nullptr;
  const auto context = BuildModule(env, consumer, shader, kFuzzAssembleOption);
  spvtools::ValidatorOptions validator_options;
  ASSERT_TRUE(fuzzerutil::IsValidAndWellFormed(context.get(), validator_options,
                                               kConsoleMessageConsumer));

  TransformationContext transformation_context(
      MakeUnique<FactManager>(context.get()), validator_options);
  // True and false can both be added as neither is present.
  ASSERT_TRUE(TransformationAddConstantBoolean(7, true, false)
                  .IsApplicable(context.get(), transformation_context));
  ASSERT_TRUE(TransformationAddConstantBoolean(7, false, false)
                  .IsApplicable(context.get(), transformation_context));

  // Irrelevant true and false can both be added as neither is present.
  ASSERT_TRUE(TransformationAddConstantBoolean(7, true, true)
                  .IsApplicable(context.get(), transformation_context));
  ASSERT_TRUE(TransformationAddConstantBoolean(7, false, true)
                  .IsApplicable(context.get(), transformation_context));

  // Id 5 is already taken.
  ASSERT_FALSE(TransformationAddConstantBoolean(5, true, false)
                   .IsApplicable(context.get(), transformation_context));

  auto add_true = TransformationAddConstantBoolean(7, true, false);
  auto add_false = TransformationAddConstantBoolean(8, false, false);

  ASSERT_TRUE(add_true.IsApplicable(context.get(), transformation_context));
  ASSERT_EQ(nullptr, context->get_def_use_mgr()->GetDef(7));
  ASSERT_EQ(nullptr, context->get_constant_mgr()->FindDeclaredConstant(7));
  ApplyAndCheckFreshIds(add_true, context.get(), &transformation_context);
  ASSERT_EQ(spv::Op::OpConstantTrue,
            context->get_def_use_mgr()->GetDef(7)->opcode());
  ASSERT_TRUE(context->get_constant_mgr()
                  ->FindDeclaredConstant(7)
                  ->AsBoolConstant()
                  ->value());
  ASSERT_TRUE(fuzzerutil::IsValidAndWellFormed(context.get(), validator_options,
                                               kConsoleMessageConsumer));

  // Having added true, we cannot add it again with the same id.
  ASSERT_FALSE(add_true.IsApplicable(context.get(), transformation_context));
  // But we can add it with a different id.
  auto add_true_again = TransformationAddConstantBoolean(100, true, false);
  ASSERT_TRUE(
      add_true_again.IsApplicable(context.get(), transformation_context));
  ApplyAndCheckFreshIds(add_true_again, context.get(), &transformation_context);
  ASSERT_TRUE(fuzzerutil::IsValidAndWellFormed(context.get(), validator_options,
                                               kConsoleMessageConsumer));

  ASSERT_TRUE(add_false.IsApplicable(context.get(), transformation_context));
  ApplyAndCheckFreshIds(add_false, context.get(), &transformation_context);
  ASSERT_TRUE(fuzzerutil::IsValidAndWellFormed(context.get(), validator_options,
                                               kConsoleMessageConsumer));

  // Having added false, we cannot add it again with the same id.
  ASSERT_FALSE(add_false.IsApplicable(context.get(), transformation_context));
  // But we can add it with a different id.
  auto add_false_again = TransformationAddConstantBoolean(101, false, false);
  ASSERT_TRUE(
      add_false_again.IsApplicable(context.get(), transformation_context));
  ApplyAndCheckFreshIds(add_false_again, context.get(),
                        &transformation_context);
  ASSERT_TRUE(fuzzerutil::IsValidAndWellFormed(context.get(), validator_options,
                                               kConsoleMessageConsumer));

  // We can create an irrelevant OpConstantTrue.
  TransformationAddConstantBoolean irrelevant_true(102, true, true);
  ASSERT_TRUE(
      irrelevant_true.IsApplicable(context.get(), transformation_context));
  ApplyAndCheckFreshIds(irrelevant_true, context.get(),
                        &transformation_context);
  ASSERT_TRUE(fuzzerutil::IsValidAndWellFormed(context.get(), validator_options,
                                               kConsoleMessageConsumer));

  // We can create an irrelevant OpConstantFalse.
  TransformationAddConstantBoolean irrelevant_false(103, false, true);
  ASSERT_TRUE(
      irrelevant_false.IsApplicable(context.get(), transformation_context));
  ApplyAndCheckFreshIds(irrelevant_false, context.get(),
                        &transformation_context);
  ASSERT_TRUE(fuzzerutil::IsValidAndWellFormed(context.get(), validator_options,
                                               kConsoleMessageConsumer));

  ASSERT_FALSE(transformation_context.GetFactManager()->IdIsIrrelevant(100));
  ASSERT_FALSE(transformation_context.GetFactManager()->IdIsIrrelevant(101));
  ASSERT_TRUE(transformation_context.GetFactManager()->IdIsIrrelevant(102));
  ASSERT_TRUE(transformation_context.GetFactManager()->IdIsIrrelevant(103));

  std::string after_transformation = R"(
               OpCapability Shader
          %1 = OpExtInstImport "GLSL.std.450"
               OpMemoryModel Logical GLSL450
               OpEntryPoint Fragment %4 "main"
               OpExecutionMode %4 OriginUpperLeft
               OpSource ESSL 310
               OpName %4 "main"
          %2 = OpTypeVoid
          %6 = OpTypeBool
          %3 = OpTypeFunction %2
          %7 = OpConstantTrue %6
        %100 = OpConstantTrue %6
          %8 = OpConstantFalse %6
        %101 = OpConstantFalse %6
        %102 = OpConstantTrue %6
        %103 = OpConstantFalse %6
          %4 = OpFunction %2 None %3
          %5 = OpLabel
               OpReturn
               OpFunctionEnd
  )";

  ASSERT_TRUE(IsEqual(env, after_transformation, context.get()));
}

TEST(TransformationAddConstantBooleanTest, NoOpTypeBoolPresent) {
  std::string shader = R"(
               OpCapability Shader
          %1 = OpExtInstImport "GLSL.std.450"
               OpMemoryModel Logical GLSL450
               OpEntryPoint Fragment %4 "main"
               OpExecutionMode %4 OriginUpperLeft
               OpSource ESSL 310
               OpName %4 "main"
          %2 = OpTypeVoid
          %3 = OpTypeFunction %2
          %4 = OpFunction %2 None %3
          %5 = OpLabel
               OpReturn
               OpFunctionEnd
  )";

  const auto env = SPV_ENV_UNIVERSAL_1_3;
  const auto consumer = nullptr;
  const auto context = BuildModule(env, consumer, shader, kFuzzAssembleOption);
  spvtools::ValidatorOptions validator_options;
  ASSERT_TRUE(fuzzerutil::IsValidAndWellFormed(context.get(), validator_options,
                                               kConsoleMessageConsumer));
  TransformationContext transformation_context(
      MakeUnique<FactManager>(context.get()), validator_options);
  // Neither true nor false can be added as OpTypeBool is not present.
  ASSERT_FALSE(TransformationAddConstantBoolean(6, true, false)
                   .IsApplicable(context.get(), transformation_context));
  ASSERT_FALSE(TransformationAddConstantBoolean(6, false, false)
                   .IsApplicable(context.get(), transformation_context));

  // This does not depend on whether the constant is relevant or not.
  ASSERT_FALSE(TransformationAddConstantBoolean(6, true, true)
                   .IsApplicable(context.get(), transformation_context));
  ASSERT_FALSE(TransformationAddConstantBoolean(6, false, true)
                   .IsApplicable(context.get(), transformation_context));
}

}  // namespace
}  // namespace fuzz
}  // namespace spvtools