SPIRV-Tools/test/opt/private_to_local_test.cpp
Steven Perron b86eb6842b Convert private variables to function scope.
When a private variable is used in a single function, it can be
converted to a function scope variable in that function.  This adds a
pass that does that.  The pass can be enabled using the option
`--private-to-local`.

This transformation allows other transformations to act on these
variables.

Also moved `FindPointerToType` from the inline class to the type manager.
2017-12-19 14:21:04 -05:00

198 lines
7.1 KiB
C++

// Copyright (c) 2017 Google Inc.
//
// 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 "opt/value_number_table.h"
#include "assembly_builder.h"
#include "gmock/gmock.h"
#include "opt/build_module.h"
#include "pass_fixture.h"
#include "pass_utils.h"
namespace {
using namespace spvtools;
using ::testing::HasSubstr;
using ::testing::MatchesRegex;
using PrivateToLocalTest = PassTest<::testing::Test>;
#ifdef SPIRV_EFFCEE
TEST_F(PrivateToLocalTest, ChangeToLocal) {
// Change the private variable to a local, and change the types accordingly.
const std::string text = R"(
OpCapability Shader
%1 = OpExtInstImport "GLSL.std.450"
OpMemoryModel Logical GLSL450
OpEntryPoint Fragment %2 "main"
OpExecutionMode %2 OriginUpperLeft
OpSource GLSL 430
%3 = OpTypeVoid
%4 = OpTypeFunction %3
; CHECK: [[float:%[a-zA-Z_\d]+]] = OpTypeFloat 32
%5 = OpTypeFloat 32
; CHECK: [[newtype:%[a-zA-Z_\d]+]] = OpTypePointer Function [[float]]
%6 = OpTypePointer Private %5
; CHECK-NOT: OpVariable [[.+]] Private
%8 = OpVariable %6 Private
; CHECK: OpFunction
%2 = OpFunction %3 None %4
; CHECK: OpLabel
%7 = OpLabel
; CHECK-NEXT: [[newvar:%[a-zA-Z_\d]+]] = OpVariable [[newtype]] Function
; CHECK: OpLoad [[float]] [[newvar]]
%9 = OpLoad %5 %8
OpReturn
OpFunctionEnd
)";
SinglePassRunAndMatch<opt::PrivateToLocalPass>(text, false);
}
TEST_F(PrivateToLocalTest, ReuseExistingType) {
// Change the private variable to a local, and change the types accordingly.
const std::string text = R"(
OpCapability Shader
%1 = OpExtInstImport "GLSL.std.450"
OpMemoryModel Logical GLSL450
OpEntryPoint Fragment %2 "main"
OpExecutionMode %2 OriginUpperLeft
OpSource GLSL 430
%3 = OpTypeVoid
%4 = OpTypeFunction %3
; CHECK: [[float:%[a-zA-Z_\d]+]] = OpTypeFloat 32
%5 = OpTypeFloat 32
%func_ptr = OpTypePointer Function %5
; CHECK: [[newtype:%[a-zA-Z_\d]+]] = OpTypePointer Function [[float]]
; CHECK-NOT: [[%[a-zA-Z_\d]+]] = OpTypePointer Function [[float]]
%6 = OpTypePointer Private %5
; CHECK-NOT: OpVariable [[.+]] Private
%8 = OpVariable %6 Private
; CHECK: OpFunction
%2 = OpFunction %3 None %4
; CHECK: OpLabel
%7 = OpLabel
; CHECK-NEXT: [[newvar:%[a-zA-Z_\d]+]] = OpVariable [[newtype]] Function
; CHECK: OpLoad [[float]] [[newvar]]
%9 = OpLoad %5 %8
OpReturn
OpFunctionEnd
)";
SinglePassRunAndMatch<opt::PrivateToLocalPass>(text, false);
}
TEST_F(PrivateToLocalTest, UpdateAccessChain) {
// Change the private variable to a local, and change the AccessChain.
const std::string text = R"(
OpCapability Shader
%1 = OpExtInstImport "GLSL.std.450"
OpMemoryModel Logical GLSL450
OpEntryPoint Fragment %2 "main"
OpExecutionMode %2 OriginUpperLeft
OpSource GLSL 430
%uint = OpTypeInt 32 0
%uint_0 = OpConstant %uint 0
%void = OpTypeVoid
%6 = OpTypeFunction %void
; CHECK: [[float:%[a-zA-Z_\d]+]] = OpTypeFloat
%float = OpTypeFloat 32
; CHECK: [[struct:%[a-zA-Z_\d]+]] = OpTypeStruct
%_struct_8 = OpTypeStruct %float
%_ptr_Private_float = OpTypePointer Private %float
; CHECK: [[new_struct_type:%[a-zA-Z_\d]+]] = OpTypePointer Function [[struct]]
; CHECK: [[new_float_type:%[a-zA-Z_\d]+]] = OpTypePointer Function [[float]]
%_ptr_Private__struct_8 = OpTypePointer Private %_struct_8
; CHECK-NOT: OpVariable [[.+]] Private
%11 = OpVariable %_ptr_Private__struct_8 Private
; CHECK: OpFunction
%2 = OpFunction %void None %6
; CHECK: OpLabel
%12 = OpLabel
; CHECK-NEXT: [[newvar:%[a-zA-Z_\d]+]] = OpVariable [[new_struct_type]] Function
; CHECK: [[member:%[a-zA-Z_\d]+]] = OpAccessChain [[new_float_type]] [[newvar]]
%13 = OpAccessChain %_ptr_Private_float %11 %uint_0
; CHECK: OpLoad [[float]] [[member]]
%14 = OpLoad %float %13
OpReturn
OpFunctionEnd
)";
SinglePassRunAndMatch<opt::PrivateToLocalPass>(text, false);
}
TEST_F(PrivateToLocalTest, UsedInTwoFunctions) {
// Should not change because it is used in multiple functions.
const std::string text = R"(
OpCapability Shader
%1 = OpExtInstImport "GLSL.std.450"
OpMemoryModel Logical GLSL450
OpEntryPoint Fragment %2 "main"
OpExecutionMode %2 OriginUpperLeft
OpSource GLSL 430
%3 = OpTypeVoid
%4 = OpTypeFunction %3
%5 = OpTypeFloat 32
%6 = OpTypePointer Private %5
%8 = OpVariable %6 Private
%2 = OpFunction %3 None %4
%7 = OpLabel
%9 = OpLoad %5 %8
OpReturn
OpFunctionEnd
%10 = OpFunction %3 None %4
%11 = OpLabel
%12 = OpLoad %5 %8
OpReturn
OpFunctionEnd
)";
auto result = SinglePassRunAndDisassemble<opt::StrengthReductionPass>(
text, /* skip_nop = */ true, /* do_validation = */ false);
EXPECT_EQ(opt::Pass::Status::SuccessWithoutChange, std::get<1>(result));
}
TEST_F(PrivateToLocalTest, UsedInFunctionCall) {
// Should not change because it is used in a function call. Changing the
// signature of the function would require cloning the function, which is not
// worth it.
const std::string text = R"(
OpCapability Shader
%1 = OpExtInstImport "GLSL.std.450"
OpMemoryModel Logical GLSL450
OpEntryPoint Fragment %2 "main"
OpExecutionMode %2 OriginUpperLeft
OpSource GLSL 430
%void = OpTypeVoid
%4 = OpTypeFunction %void
%float = OpTypeFloat 32
%_ptr_Private_float = OpTypePointer Private %float
%7 = OpTypeFunction %void %_ptr_Private_float
%8 = OpVariable %_ptr_Private_float Private
%2 = OpFunction %void None %4
%9 = OpLabel
%10 = OpFunctionCall %void %11 %8
OpReturn
OpFunctionEnd
%11 = OpFunction %void None %7
%12 = OpFunctionParameter %_ptr_Private_float
%13 = OpLabel
%14 = OpLoad %float %12
OpReturn
OpFunctionEnd
)";
auto result = SinglePassRunAndDisassemble<opt::StrengthReductionPass>(
text, /* skip_nop = */ true, /* do_validation = */ false);
EXPECT_EQ(opt::Pass::Status::SuccessWithoutChange, std::get<1>(result));
}
#endif
} // anonymous namespace