mirror of
https://github.com/KhronosGroup/SPIRV-Tools
synced 2024-12-01 15:30:06 +00:00
e70b009b0f
Add support for SPV_KHR_non_semantic_info This entails a couple of changes: - Allowing unknown OpExtInstImport that begin with the prefix `NonSemantic.` - Allowing OpExtInst that reference any of those sets to contain unknown ext inst instruction numbers, and assume the format is always a series of IDs as guaranteed by the extension. - Allowing those OpExtInst to appear in the types/variables/constants section. - Not stripping OpString in the --strip-debug pass, since it may be referenced by these non-semantic OpExtInsts. - Stripping them instead in the --strip-reflect pass. * Add adjacency validation of non-semantic OpExtInst - We validate and test that OpExtInst cannot appear before or between OpPhi instructions, or before/between OpFunctionParameter instructions. * Change non-semantic extinst type to single value * Add helper function spvExtInstIsNonSemantic() which will check if the extinst set is non-semantic or not, either the unknown generic value or any future recognised non-semantic set. * Add test of a complex non-semantic extinst * Use DefUseManager in StripDebugInfoPass to strip some OpStrings * Any OpString used by a non-semantic instruction cannot be stripped, all others can so we search for uses to see if each string can be removed. * We only do this if the non-semantic debug info extension is enabled, otherwise all strings can be trivially removed. * Silence -Winconsistent-missing-override in protobufs
233 lines
8.7 KiB
C++
233 lines
8.7 KiB
C++
// Copyright (c) 2016 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 <vector>
|
|
|
|
#include "test/opt/pass_fixture.h"
|
|
#include "test/opt/pass_utils.h"
|
|
|
|
namespace spvtools {
|
|
namespace opt {
|
|
namespace {
|
|
|
|
using StripLineDebugInfoTest = PassTest<::testing::Test>;
|
|
|
|
TEST_F(StripLineDebugInfoTest, LineNoLine) {
|
|
std::vector<const char*> text = {
|
|
// clang-format off
|
|
"OpCapability Shader",
|
|
"%1 = OpExtInstImport \"GLSL.std.450\"",
|
|
"OpMemoryModel Logical GLSL450",
|
|
"OpEntryPoint Vertex %2 \"main\"",
|
|
"%3 = OpString \"minimal.vert\"",
|
|
"OpModuleProcessed \"42\"",
|
|
"OpModuleProcessed \"43\"",
|
|
"OpModuleProcessed \"44\"",
|
|
"OpNoLine",
|
|
"OpLine %3 10 10",
|
|
"%void = OpTypeVoid",
|
|
"OpLine %3 100 100",
|
|
"%5 = OpTypeFunction %void",
|
|
"%2 = OpFunction %void None %5",
|
|
"OpLine %3 1 1",
|
|
"OpNoLine",
|
|
"OpLine %3 2 2",
|
|
"OpLine %3 3 3",
|
|
"%6 = OpLabel",
|
|
"OpLine %3 4 4",
|
|
"OpNoLine",
|
|
"OpReturn",
|
|
"OpLine %3 4 4",
|
|
"OpNoLine",
|
|
"OpFunctionEnd",
|
|
"OpNoLine",
|
|
"OpLine %3 4 5"
|
|
// clang-format on
|
|
};
|
|
SinglePassRunAndCheck<StripDebugInfoPass>(JoinAllInsts(text),
|
|
JoinNonDebugInsts(text),
|
|
/* skip_nop = */ false);
|
|
|
|
// Let's add more debug instruction before the "OpString" instruction.
|
|
const std::vector<const char*> more_text = {
|
|
"OpSourceContinued \"I'm a happy shader! Yay! ;)\"",
|
|
"OpSourceContinued \"wahahaha\"",
|
|
"OpSource ESSL 310",
|
|
"OpSource ESSL 310",
|
|
"OpSourceContinued \"wahahaha\"",
|
|
"OpSourceContinued \"wahahaha\"",
|
|
"OpSourceExtension \"save-the-world-extension\"",
|
|
"OpName %2 \"main\"",
|
|
};
|
|
text.insert(text.begin() + 4, more_text.cbegin(), more_text.cend());
|
|
SinglePassRunAndCheck<StripDebugInfoPass>(JoinAllInsts(text),
|
|
JoinNonDebugInsts(text),
|
|
/* skip_nop = */ false);
|
|
}
|
|
|
|
using StripDebugStringTest = PassTest<::testing::Test>;
|
|
|
|
TEST_F(StripDebugStringTest, OpDecorateRemoved) {
|
|
std::vector<const char*> input{
|
|
// clang-format off
|
|
"OpCapability Shader",
|
|
"%1 = OpExtInstImport \"GLSL.std.450\"",
|
|
"OpMemoryModel Logical GLSL450",
|
|
"OpEntryPoint Vertex %2 \"main\"",
|
|
"%3 = OpString \"minimal.vert\"",
|
|
"OpDecorate %3 Location 1337",
|
|
"%void = OpTypeVoid",
|
|
"%5 = OpTypeFunction %void",
|
|
"%2 = OpFunction %void None %5",
|
|
"%6 = OpLabel",
|
|
"OpReturn",
|
|
"OpFunctionEnd",
|
|
// clang-format on
|
|
};
|
|
std::vector<const char*> output{
|
|
// clang-format off
|
|
"OpCapability Shader",
|
|
"%1 = OpExtInstImport \"GLSL.std.450\"",
|
|
"OpMemoryModel Logical GLSL450",
|
|
"OpEntryPoint Vertex %2 \"main\"",
|
|
"%void = OpTypeVoid",
|
|
"%5 = OpTypeFunction %void",
|
|
"%2 = OpFunction %void None %5",
|
|
"%6 = OpLabel",
|
|
"OpReturn",
|
|
"OpFunctionEnd",
|
|
// clang-format on
|
|
};
|
|
SinglePassRunAndCheck<StripDebugInfoPass>(JoinAllInsts(input),
|
|
JoinAllInsts(output),
|
|
/* skip_nop = */ false,
|
|
/* do_validation */ true);
|
|
}
|
|
|
|
TEST_F(StripDebugStringTest, OpNameRemoved) {
|
|
std::vector<const char*> input{
|
|
// clang-format off
|
|
"OpCapability Shader",
|
|
"%1 = OpExtInstImport \"GLSL.std.450\"",
|
|
"OpMemoryModel Logical GLSL450",
|
|
"OpEntryPoint Vertex %2 \"main\"",
|
|
"%3 = OpString \"minimal.vert\"",
|
|
"OpName %3 \"bob\"",
|
|
"%void = OpTypeVoid",
|
|
"%5 = OpTypeFunction %void",
|
|
"%2 = OpFunction %void None %5",
|
|
"%6 = OpLabel",
|
|
"OpReturn",
|
|
"OpFunctionEnd",
|
|
// clang-format on
|
|
};
|
|
std::vector<const char*> output{
|
|
// clang-format off
|
|
"OpCapability Shader",
|
|
"%1 = OpExtInstImport \"GLSL.std.450\"",
|
|
"OpMemoryModel Logical GLSL450",
|
|
"OpEntryPoint Vertex %2 \"main\"",
|
|
"%void = OpTypeVoid",
|
|
"%5 = OpTypeFunction %void",
|
|
"%2 = OpFunction %void None %5",
|
|
"%6 = OpLabel",
|
|
"OpReturn",
|
|
"OpFunctionEnd",
|
|
// clang-format on
|
|
};
|
|
SinglePassRunAndCheck<StripDebugInfoPass>(JoinAllInsts(input),
|
|
JoinAllInsts(output),
|
|
/* skip_nop = */ false,
|
|
/* do_validation */ true);
|
|
}
|
|
|
|
TEST_F(StripDebugStringTest, OpStringRemovedWithNonSemantic) {
|
|
std::vector<const char*> input{
|
|
// clang-format off
|
|
"OpCapability Shader",
|
|
"OpExtension \"SPV_KHR_non_semantic_info\"",
|
|
"%1 = OpExtInstImport \"NonSemantic.Testing.Set\"",
|
|
"OpMemoryModel Logical GLSL450",
|
|
"OpEntryPoint Vertex %2 \"main\"",
|
|
// this string is not referenced, should be removed fully
|
|
"%3 = OpString \"minimal.vert\"",
|
|
"OpName %3 \"bob\"",
|
|
// this string is referenced and cannot be removed,
|
|
// but the name should be
|
|
"%4 = OpString \"secondary.inc\"",
|
|
"OpName %4 \"sue\"",
|
|
"%void = OpTypeVoid",
|
|
"%6 = OpTypeFunction %void",
|
|
"%2 = OpFunction %void None %6",
|
|
"%7 = OpLabel",
|
|
"%8 = OpExtInst %void %1 5 %4",
|
|
"OpReturn",
|
|
"OpFunctionEnd",
|
|
// clang-format on
|
|
};
|
|
std::vector<const char*> output{
|
|
// clang-format off
|
|
"OpCapability Shader",
|
|
"OpExtension \"SPV_KHR_non_semantic_info\"",
|
|
"%1 = OpExtInstImport \"NonSemantic.Testing.Set\"",
|
|
"OpMemoryModel Logical GLSL450",
|
|
"OpEntryPoint Vertex %2 \"main\"",
|
|
"%4 = OpString \"secondary.inc\"",
|
|
"%void = OpTypeVoid",
|
|
"%6 = OpTypeFunction %void",
|
|
"%2 = OpFunction %void None %6",
|
|
"%7 = OpLabel",
|
|
"%8 = OpExtInst %void %1 5 %4",
|
|
"OpReturn",
|
|
"OpFunctionEnd",
|
|
// clang-format on
|
|
};
|
|
SinglePassRunAndCheck<StripDebugInfoPass>(JoinAllInsts(input),
|
|
JoinAllInsts(output),
|
|
/* skip_nop = */ false,
|
|
/* do_validation */ true);
|
|
}
|
|
|
|
using StripDebugInfoTest = PassTest<::testing::TestWithParam<const char*>>;
|
|
|
|
TEST_P(StripDebugInfoTest, Kind) {
|
|
std::vector<const char*> text = {
|
|
"OpCapability Shader",
|
|
"OpMemoryModel Logical GLSL450",
|
|
GetParam(),
|
|
};
|
|
SinglePassRunAndCheck<StripDebugInfoPass>(JoinAllInsts(text),
|
|
JoinNonDebugInsts(text),
|
|
/* skip_nop = */ false);
|
|
}
|
|
|
|
// Test each possible non-line debug instruction.
|
|
// clang-format off
|
|
INSTANTIATE_TEST_SUITE_P(
|
|
SingleKindDebugInst, StripDebugInfoTest,
|
|
::testing::ValuesIn(std::vector<const char*>({
|
|
"OpSourceContinued \"I'm a happy shader! Yay! ;)\"",
|
|
"OpSource ESSL 310",
|
|
"OpSourceExtension \"save-the-world-extension\"",
|
|
"OpName %main \"main\"",
|
|
"OpMemberName %struct 0 \"field\"",
|
|
"%1 = OpString \"name.vert\"",
|
|
"OpModuleProcessed \"42\"",
|
|
})));
|
|
// clang-format on
|
|
|
|
} // namespace
|
|
} // namespace opt
|
|
} // namespace spvtools
|