| // Copyright (c) 2018 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/reduce/reducer.h" |
| |
| #include <unordered_map> |
| |
| #include "source/opt/build_module.h" |
| #include "source/reduce/operand_to_const_reduction_opportunity_finder.h" |
| #include "source/reduce/remove_unused_instruction_reduction_opportunity_finder.h" |
| #include "test/reduce/reduce_test_util.h" |
| |
| namespace spvtools { |
| namespace reduce { |
| namespace { |
| |
| const spv_target_env kEnv = SPV_ENV_UNIVERSAL_1_3; |
| const MessageConsumer kMessageConsumer = NopDiagnostic; |
| |
| // This changes its mind each time IsInteresting is invoked as to whether the |
| // binary is interesting, until some limit is reached after which the binary is |
| // always deemed interesting. This is useful to test that reduction passes |
| // interleave in interesting ways for a while, and then always succeed after |
| // some point; the latter is important to end up with a predictable final |
| // reduced binary for tests. |
| class PingPongInteresting { |
| public: |
| explicit PingPongInteresting(uint32_t always_interesting_after) |
| : is_interesting_(true), |
| always_interesting_after_(always_interesting_after), |
| count_(0) {} |
| |
| bool IsInteresting() { |
| bool result; |
| if (count_ > always_interesting_after_) { |
| result = true; |
| } else { |
| result = is_interesting_; |
| is_interesting_ = !is_interesting_; |
| } |
| count_++; |
| return result; |
| } |
| |
| private: |
| bool is_interesting_; |
| const uint32_t always_interesting_after_; |
| uint32_t count_; |
| }; |
| |
| TEST(ReducerTest, ExprToConstantAndRemoveUnreferenced) { |
| // Check that ExprToConstant and RemoveUnreferenced work together; once some |
| // ID uses have been changed to constants, those IDs can be removed. |
| std::string original = R"( |
| OpCapability Shader |
| %1 = OpExtInstImport "GLSL.std.450" |
| OpMemoryModel Logical GLSL450 |
| OpEntryPoint Fragment %4 "main" %60 |
| OpExecutionMode %4 OriginUpperLeft |
| OpSource ESSL 310 |
| OpName %4 "main" |
| OpName %16 "buf2" |
| OpMemberName %16 0 "i" |
| OpName %18 "" |
| OpName %25 "buf1" |
| OpMemberName %25 0 "f" |
| OpName %27 "" |
| OpName %60 "_GLF_color" |
| OpMemberDecorate %16 0 Offset 0 |
| OpDecorate %16 Block |
| OpDecorate %18 DescriptorSet 0 |
| OpDecorate %18 Binding 2 |
| OpMemberDecorate %25 0 Offset 0 |
| OpDecorate %25 Block |
| OpDecorate %27 DescriptorSet 0 |
| OpDecorate %27 Binding 1 |
| OpDecorate %60 Location 0 |
| %2 = OpTypeVoid |
| %3 = OpTypeFunction %2 |
| %6 = OpTypeInt 32 1 |
| %9 = OpConstant %6 0 |
| %16 = OpTypeStruct %6 |
| %17 = OpTypePointer Uniform %16 |
| %18 = OpVariable %17 Uniform |
| %19 = OpTypePointer Uniform %6 |
| %22 = OpTypeBool |
| %100 = OpConstantTrue %22 |
| %24 = OpTypeFloat 32 |
| %25 = OpTypeStruct %24 |
| %26 = OpTypePointer Uniform %25 |
| %27 = OpVariable %26 Uniform |
| %28 = OpTypePointer Uniform %24 |
| %31 = OpConstant %24 2 |
| %56 = OpConstant %6 1 |
| %58 = OpTypeVector %24 4 |
| %59 = OpTypePointer Output %58 |
| %60 = OpVariable %59 Output |
| %72 = OpUndef %24 |
| %74 = OpUndef %6 |
| %4 = OpFunction %2 None %3 |
| %5 = OpLabel |
| OpBranch %10 |
| %10 = OpLabel |
| %73 = OpPhi %6 %74 %5 %77 %34 |
| %71 = OpPhi %24 %72 %5 %76 %34 |
| %70 = OpPhi %6 %9 %5 %57 %34 |
| %20 = OpAccessChain %19 %18 %9 |
| %21 = OpLoad %6 %20 |
| %23 = OpSLessThan %22 %70 %21 |
| OpLoopMerge %12 %34 None |
| OpBranchConditional %23 %11 %12 |
| %11 = OpLabel |
| %29 = OpAccessChain %28 %27 %9 |
| %30 = OpLoad %24 %29 |
| %32 = OpFOrdGreaterThan %22 %30 %31 |
| OpSelectionMerge %90 None |
| OpBranchConditional %32 %33 %46 |
| %33 = OpLabel |
| %40 = OpFAdd %24 %71 %30 |
| %45 = OpISub %6 %73 %21 |
| OpBranch %90 |
| %46 = OpLabel |
| %50 = OpFMul %24 %71 %30 |
| %54 = OpSDiv %6 %73 %21 |
| OpBranch %90 |
| %90 = OpLabel |
| %77 = OpPhi %6 %45 %33 %54 %46 |
| %76 = OpPhi %24 %40 %33 %50 %46 |
| OpBranch %34 |
| %34 = OpLabel |
| %57 = OpIAdd %6 %70 %56 |
| OpBranch %10 |
| %12 = OpLabel |
| %61 = OpAccessChain %28 %27 %9 |
| %62 = OpLoad %24 %61 |
| %66 = OpConvertSToF %24 %21 |
| %68 = OpConvertSToF %24 %73 |
| %69 = OpCompositeConstruct %58 %62 %71 %66 %68 |
| OpStore %60 %69 |
| OpReturn |
| OpFunctionEnd |
| )"; |
| |
| std::string expected = R"( |
| OpCapability Shader |
| %1 = OpExtInstImport "GLSL.std.450" |
| OpMemoryModel Logical GLSL450 |
| OpEntryPoint Fragment %4 "main" |
| OpExecutionMode %4 OriginUpperLeft |
| %2 = OpTypeVoid |
| %3 = OpTypeFunction %2 |
| %6 = OpTypeInt 32 1 |
| %9 = OpConstant %6 0 |
| %22 = OpTypeBool |
| %100 = OpConstantTrue %22 |
| %24 = OpTypeFloat 32 |
| %31 = OpConstant %24 2 |
| %56 = OpConstant %6 1 |
| %72 = OpUndef %24 |
| %74 = OpUndef %6 |
| %4 = OpFunction %2 None %3 |
| %5 = OpLabel |
| OpBranch %10 |
| %10 = OpLabel |
| OpLoopMerge %12 %34 None |
| OpBranchConditional %100 %11 %12 |
| %11 = OpLabel |
| OpSelectionMerge %90 None |
| OpBranchConditional %100 %33 %46 |
| %33 = OpLabel |
| OpBranch %90 |
| %46 = OpLabel |
| OpBranch %90 |
| %90 = OpLabel |
| OpBranch %34 |
| %34 = OpLabel |
| OpBranch %10 |
| %12 = OpLabel |
| OpReturn |
| OpFunctionEnd |
| )"; |
| |
| Reducer reducer(kEnv); |
| PingPongInteresting ping_pong_interesting(10); |
| reducer.SetMessageConsumer(kMessageConsumer); |
| reducer.SetInterestingnessFunction( |
| [&ping_pong_interesting](const std::vector<uint32_t>&, uint32_t) -> bool { |
| return ping_pong_interesting.IsInteresting(); |
| }); |
| reducer.AddReductionPass( |
| MakeUnique<RemoveUnusedInstructionReductionOpportunityFinder>(false)); |
| reducer.AddReductionPass( |
| MakeUnique<OperandToConstReductionOpportunityFinder>()); |
| |
| std::vector<uint32_t> binary_in; |
| SpirvTools t(kEnv); |
| |
| ASSERT_TRUE(t.Assemble(original, &binary_in, kReduceAssembleOption)); |
| std::vector<uint32_t> binary_out; |
| spvtools::ReducerOptions reducer_options; |
| reducer_options.set_step_limit(500); |
| reducer_options.set_fail_on_validation_error(true); |
| spvtools::ValidatorOptions validator_options; |
| |
| Reducer::ReductionResultStatus status = reducer.Run( |
| std::move(binary_in), &binary_out, reducer_options, validator_options); |
| |
| ASSERT_EQ(status, Reducer::ReductionResultStatus::kComplete); |
| |
| CheckEqual(kEnv, expected, binary_out); |
| } |
| |
| bool InterestingWhileOpcodeExists(const std::vector<uint32_t>& binary, |
| spv::Op opcode, uint32_t count, bool dump) { |
| if (dump) { |
| std::stringstream ss; |
| ss << "temp_" << count << ".spv"; |
| DumpShader(binary, ss.str().c_str()); |
| } |
| |
| std::unique_ptr<opt::IRContext> context = |
| BuildModule(kEnv, kMessageConsumer, binary.data(), binary.size()); |
| assert(context); |
| bool interesting = false; |
| for (auto& function : *context->module()) { |
| context->cfg()->ForEachBlockInPostOrder( |
| &*function.begin(), |
| [opcode, &interesting](opt::BasicBlock* block) -> void { |
| for (auto& inst : *block) { |
| if (inst.opcode() == spv::Op(opcode)) { |
| interesting = true; |
| break; |
| } |
| } |
| }); |
| if (interesting) { |
| break; |
| } |
| } |
| return interesting; |
| } |
| |
| bool InterestingWhileIMulReachable(const std::vector<uint32_t>& binary, |
| uint32_t count) { |
| return InterestingWhileOpcodeExists(binary, spv::Op::OpIMul, count, false); |
| } |
| |
| bool InterestingWhileSDivReachable(const std::vector<uint32_t>& binary, |
| uint32_t count) { |
| return InterestingWhileOpcodeExists(binary, spv::Op::OpSDiv, count, false); |
| } |
| |
| // The shader below was derived from the following GLSL, and optimized. |
| // #version 310 es |
| // precision highp float; |
| // layout(location = 0) out vec4 _GLF_color; |
| // int foo() { |
| // int x = 1; |
| // int y; |
| // x = y / x; // SDiv |
| // return x; |
| // } |
| // void main() { |
| // int c; |
| // while (bool(c)) { |
| // do { |
| // if (bool(c)) { |
| // if (bool(c)) { |
| // ++c; |
| // } else { |
| // _GLF_color.x = float(c*c); // IMul |
| // } |
| // return; |
| // } |
| // } while(bool(foo())); |
| // return; |
| // } |
| // } |
| const std::string kShaderWithLoopsDivAndMul = R"( |
| OpCapability Shader |
| %1 = OpExtInstImport "GLSL.std.450" |
| OpMemoryModel Logical GLSL450 |
| OpEntryPoint Fragment %4 "main" %49 |
| OpExecutionMode %4 OriginUpperLeft |
| OpSource ESSL 310 |
| OpName %4 "main" |
| OpName %49 "_GLF_color" |
| OpDecorate %49 Location 0 |
| OpDecorate %52 RelaxedPrecision |
| OpDecorate %77 RelaxedPrecision |
| %2 = OpTypeVoid |
| %3 = OpTypeFunction %2 |
| %6 = OpTypeInt 32 1 |
| %12 = OpConstant %6 1 |
| %27 = OpTypeBool |
| %28 = OpTypeInt 32 0 |
| %29 = OpConstant %28 0 |
| %46 = OpTypeFloat 32 |
| %47 = OpTypeVector %46 4 |
| %48 = OpTypePointer Output %47 |
| %49 = OpVariable %48 Output |
| %54 = OpTypePointer Output %46 |
| %64 = OpConstantFalse %27 |
| %67 = OpConstantTrue %27 |
| %81 = OpUndef %6 |
| %4 = OpFunction %2 None %3 |
| %5 = OpLabel |
| OpBranch %61 |
| %61 = OpLabel |
| OpLoopMerge %60 %63 None |
| OpBranch %20 |
| %20 = OpLabel |
| %30 = OpINotEqual %27 %81 %29 |
| OpLoopMerge %22 %23 None |
| OpBranchConditional %30 %21 %22 |
| %21 = OpLabel |
| OpBranch %31 |
| %31 = OpLabel |
| OpLoopMerge %33 %38 None |
| OpBranch %32 |
| %32 = OpLabel |
| OpBranchConditional %30 %37 %38 |
| %37 = OpLabel |
| OpSelectionMerge %42 None |
| OpBranchConditional %30 %41 %45 |
| %41 = OpLabel |
| OpBranch %42 |
| %45 = OpLabel |
| %52 = OpIMul %6 %81 %81 |
| %53 = OpConvertSToF %46 %52 |
| %55 = OpAccessChain %54 %49 %29 |
| OpStore %55 %53 |
| OpBranch %42 |
| %42 = OpLabel |
| OpBranch %33 |
| %38 = OpLabel |
| %77 = OpSDiv %6 %81 %12 |
| %58 = OpINotEqual %27 %77 %29 |
| OpBranchConditional %58 %31 %33 |
| %33 = OpLabel |
| %86 = OpPhi %27 %67 %42 %64 %38 |
| OpSelectionMerge %68 None |
| OpBranchConditional %86 %22 %68 |
| %68 = OpLabel |
| OpBranch %22 |
| %23 = OpLabel |
| OpBranch %20 |
| %22 = OpLabel |
| %90 = OpPhi %27 %64 %20 %86 %33 %67 %68 |
| OpSelectionMerge %70 None |
| OpBranchConditional %90 %60 %70 |
| %70 = OpLabel |
| OpBranch %60 |
| %63 = OpLabel |
| OpBranch %61 |
| %60 = OpLabel |
| OpReturn |
| OpFunctionEnd |
| )"; |
| |
| // The shader below comes from the following GLSL. |
| // #version 320 es |
| // |
| // int baz(int x) { |
| // int y = x + 1; |
| // y = y + 2; |
| // if (y > 0) { |
| // return x; |
| // } |
| // return x + 1; |
| // } |
| // |
| // int bar(int a) { |
| // if (a == 3) { |
| // return baz(2*a); |
| // } |
| // a = a + 1; |
| // for (int i = 0; i < 10; i++) { |
| // a += baz(a); |
| // } |
| // return a; |
| // } |
| // |
| // void main() { |
| // int x; |
| // x = 3; |
| // x += 1; |
| // x += bar(x); |
| // x += baz(x); |
| // } |
| const std::string kShaderWithMultipleFunctions = R"( |
| OpCapability Shader |
| %1 = OpExtInstImport "GLSL.std.450" |
| OpMemoryModel Logical GLSL450 |
| OpEntryPoint Fragment %4 "main" |
| OpExecutionMode %4 OriginUpperLeft |
| OpSource ESSL 320 |
| %2 = OpTypeVoid |
| %3 = OpTypeFunction %2 |
| %6 = OpTypeInt 32 1 |
| %7 = OpTypePointer Function %6 |
| %8 = OpTypeFunction %6 %7 |
| %17 = OpConstant %6 1 |
| %20 = OpConstant %6 2 |
| %23 = OpConstant %6 0 |
| %24 = OpTypeBool |
| %35 = OpConstant %6 3 |
| %53 = OpConstant %6 10 |
| %4 = OpFunction %2 None %3 |
| %5 = OpLabel |
| %65 = OpVariable %7 Function |
| %68 = OpVariable %7 Function |
| %73 = OpVariable %7 Function |
| OpStore %65 %35 |
| %66 = OpLoad %6 %65 |
| %67 = OpIAdd %6 %66 %17 |
| OpStore %65 %67 |
| %69 = OpLoad %6 %65 |
| OpStore %68 %69 |
| %70 = OpFunctionCall %6 %13 %68 |
| %71 = OpLoad %6 %65 |
| %72 = OpIAdd %6 %71 %70 |
| OpStore %65 %72 |
| %74 = OpLoad %6 %65 |
| OpStore %73 %74 |
| %75 = OpFunctionCall %6 %10 %73 |
| %76 = OpLoad %6 %65 |
| %77 = OpIAdd %6 %76 %75 |
| OpStore %65 %77 |
| OpReturn |
| OpFunctionEnd |
| %10 = OpFunction %6 None %8 |
| %9 = OpFunctionParameter %7 |
| %11 = OpLabel |
| %15 = OpVariable %7 Function |
| %16 = OpLoad %6 %9 |
| %18 = OpIAdd %6 %16 %17 |
| OpStore %15 %18 |
| %19 = OpLoad %6 %15 |
| %21 = OpIAdd %6 %19 %20 |
| OpStore %15 %21 |
| %22 = OpLoad %6 %15 |
| %25 = OpSGreaterThan %24 %22 %23 |
| OpSelectionMerge %27 None |
| OpBranchConditional %25 %26 %27 |
| %26 = OpLabel |
| %28 = OpLoad %6 %9 |
| OpReturnValue %28 |
| %27 = OpLabel |
| %30 = OpLoad %6 %9 |
| %31 = OpIAdd %6 %30 %17 |
| OpReturnValue %31 |
| OpFunctionEnd |
| %13 = OpFunction %6 None %8 |
| %12 = OpFunctionParameter %7 |
| %14 = OpLabel |
| %41 = OpVariable %7 Function |
| %46 = OpVariable %7 Function |
| %55 = OpVariable %7 Function |
| %34 = OpLoad %6 %12 |
| %36 = OpIEqual %24 %34 %35 |
| OpSelectionMerge %38 None |
| OpBranchConditional %36 %37 %38 |
| %37 = OpLabel |
| %39 = OpLoad %6 %12 |
| %40 = OpIMul %6 %20 %39 |
| OpStore %41 %40 |
| %42 = OpFunctionCall %6 %10 %41 |
| OpReturnValue %42 |
| %38 = OpLabel |
| %44 = OpLoad %6 %12 |
| %45 = OpIAdd %6 %44 %17 |
| OpStore %12 %45 |
| OpStore %46 %23 |
| OpBranch %47 |
| %47 = OpLabel |
| OpLoopMerge %49 %50 None |
| OpBranch %51 |
| %51 = OpLabel |
| %52 = OpLoad %6 %46 |
| %54 = OpSLessThan %24 %52 %53 |
| OpBranchConditional %54 %48 %49 |
| %48 = OpLabel |
| %56 = OpLoad %6 %12 |
| OpStore %55 %56 |
| %57 = OpFunctionCall %6 %10 %55 |
| %58 = OpLoad %6 %12 |
| %59 = OpIAdd %6 %58 %57 |
| OpStore %12 %59 |
| OpBranch %50 |
| %50 = OpLabel |
| %60 = OpLoad %6 %46 |
| %61 = OpIAdd %6 %60 %17 |
| OpStore %46 %61 |
| OpBranch %47 |
| %49 = OpLabel |
| %62 = OpLoad %6 %12 |
| OpReturnValue %62 |
| OpFunctionEnd |
| )"; |
| |
| TEST(ReducerTest, ShaderReduceWhileMulReachable) { |
| Reducer reducer(kEnv); |
| |
| reducer.SetInterestingnessFunction(InterestingWhileIMulReachable); |
| reducer.AddDefaultReductionPasses(); |
| reducer.SetMessageConsumer(kMessageConsumer); |
| |
| std::vector<uint32_t> binary_in; |
| SpirvTools t(kEnv); |
| |
| ASSERT_TRUE( |
| t.Assemble(kShaderWithLoopsDivAndMul, &binary_in, kReduceAssembleOption)); |
| std::vector<uint32_t> binary_out; |
| spvtools::ReducerOptions reducer_options; |
| reducer_options.set_step_limit(500); |
| reducer_options.set_fail_on_validation_error(true); |
| spvtools::ValidatorOptions validator_options; |
| |
| Reducer::ReductionResultStatus status = reducer.Run( |
| std::move(binary_in), &binary_out, reducer_options, validator_options); |
| |
| ASSERT_EQ(status, Reducer::ReductionResultStatus::kComplete); |
| } |
| |
| TEST(ReducerTest, ShaderReduceWhileDivReachable) { |
| Reducer reducer(kEnv); |
| |
| reducer.SetInterestingnessFunction(InterestingWhileSDivReachable); |
| reducer.AddDefaultReductionPasses(); |
| reducer.SetMessageConsumer(kMessageConsumer); |
| |
| std::vector<uint32_t> binary_in; |
| SpirvTools t(kEnv); |
| |
| ASSERT_TRUE( |
| t.Assemble(kShaderWithLoopsDivAndMul, &binary_in, kReduceAssembleOption)); |
| std::vector<uint32_t> binary_out; |
| spvtools::ReducerOptions reducer_options; |
| reducer_options.set_step_limit(500); |
| reducer_options.set_fail_on_validation_error(true); |
| spvtools::ValidatorOptions validator_options; |
| |
| Reducer::ReductionResultStatus status = reducer.Run( |
| std::move(binary_in), &binary_out, reducer_options, validator_options); |
| |
| ASSERT_EQ(status, Reducer::ReductionResultStatus::kComplete); |
| } |
| |
| // Computes an instruction count for each function in the module represented by |
| // |binary|. |
| std::unordered_map<uint32_t, uint32_t> GetFunctionInstructionCount( |
| const std::vector<uint32_t>& binary) { |
| std::unique_ptr<opt::IRContext> context = |
| BuildModule(kEnv, kMessageConsumer, binary.data(), binary.size()); |
| assert(context != nullptr && "Failed to build module."); |
| std::unordered_map<uint32_t, uint32_t> result; |
| for (auto& function : *context->module()) { |
| uint32_t& count = result[function.result_id()] = 0; |
| function.ForEachInst([&count](opt::Instruction*) { count++; }); |
| } |
| return result; |
| } |
| |
| TEST(ReducerTest, SingleFunctionReduction) { |
| Reducer reducer(kEnv); |
| |
| PingPongInteresting ping_pong_interesting(4); |
| reducer.SetInterestingnessFunction( |
| [&ping_pong_interesting](const std::vector<uint32_t>&, uint32_t) -> bool { |
| return ping_pong_interesting.IsInteresting(); |
| }); |
| reducer.AddDefaultReductionPasses(); |
| reducer.SetMessageConsumer(kMessageConsumer); |
| |
| std::vector<uint32_t> binary_in; |
| SpirvTools t(kEnv); |
| |
| ASSERT_TRUE(t.Assemble(kShaderWithMultipleFunctions, &binary_in, |
| kReduceAssembleOption)); |
| |
| auto original_instruction_count = GetFunctionInstructionCount(binary_in); |
| |
| std::vector<uint32_t> binary_out; |
| spvtools::ReducerOptions reducer_options; |
| reducer_options.set_step_limit(500); |
| reducer_options.set_fail_on_validation_error(true); |
| |
| // Instruct the reducer to only target function 13. |
| reducer_options.set_target_function(13); |
| |
| spvtools::ValidatorOptions validator_options; |
| |
| Reducer::ReductionResultStatus status = reducer.Run( |
| std::move(binary_in), &binary_out, reducer_options, validator_options); |
| |
| ASSERT_EQ(status, Reducer::ReductionResultStatus::kComplete); |
| |
| auto final_instruction_count = GetFunctionInstructionCount(binary_out); |
| |
| // Nothing should have been removed from these functions. |
| ASSERT_EQ(original_instruction_count.at(4), final_instruction_count.at(4)); |
| ASSERT_EQ(original_instruction_count.at(10), final_instruction_count.at(10)); |
| |
| // Function 13 should have been reduced to these five instructions: |
| // OpFunction |
| // OpFunctionParameter |
| // OpLabel |
| // OpReturnValue |
| // OpFunctionEnd |
| ASSERT_EQ(5, final_instruction_count.at(13)); |
| } |
| |
| } // namespace |
| } // namespace reduce |
| } // namespace spvtools |