SPIRV-Tools/test/val/val_storage_test.cpp
Steven Perron e935dac9ef
Make pointers to isomorphic type interchangeable with option. (#2570)
* Make pointers to logically matching types interchangeable with option.

DXC will be generating code where the function parameters will be a more
generic type that the actual parameter.  They should be logically
matching and the decorations of the actual parameter must be a superset
of the decorations of the formal parameter.

We want to accept this code with an options so that spirv-opt can then
inline and fix the type mismatch.  We will accept this under a new
options `--before-hlsl-legalization`.

The new option will also imply `relax-logical-pointer` so that HLSL
frontends will need to use just the one more generic option.

Moved the |LogicallyMatches| to the validation state to make it
available in more places.  Also added a parameter to have it check the
decorations.  I did not do a separate function for the decorations
because checking the decorations involves making sure the types
logically match anyway.

Fixes #2535
2019-05-13 13:48:17 -04:00

320 lines
10 KiB
C++

// Copyright (c) 2015-2016 The Khronos Group 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.
// Validation tests for OpVariable storage class
#include <sstream>
#include <string>
#include <tuple>
#include "gmock/gmock.h"
#include "test/val/val_fixtures.h"
namespace spvtools {
namespace val {
namespace {
using ::testing::HasSubstr;
using ::testing::Values;
using ValidateStorage = spvtest::ValidateBase<std::string>;
using ValidateStorageClass =
spvtest::ValidateBase<std::tuple<std::string, bool, bool, std::string>>;
TEST_F(ValidateStorage, FunctionStorageInsideFunction) {
char str[] = R"(
OpCapability Shader
OpCapability Linkage
OpMemoryModel Logical GLSL450
%intt = OpTypeInt 32 1
%voidt = OpTypeVoid
%vfunct = OpTypeFunction %voidt
%ptrt = OpTypePointer Function %intt
%func = OpFunction %voidt None %vfunct
%funcl = OpLabel
%var = OpVariable %ptrt Function
OpReturn
OpFunctionEnd
)";
CompileSuccessfully(str);
ASSERT_EQ(SPV_SUCCESS, ValidateInstructions());
}
TEST_F(ValidateStorage, FunctionStorageOutsideFunction) {
char str[] = R"(
OpCapability Shader
OpCapability Linkage
OpMemoryModel Logical GLSL450
%intt = OpTypeInt 32 1
%voidt = OpTypeVoid
%vfunct = OpTypeFunction %voidt
%ptrt = OpTypePointer Function %intt
%var = OpVariable %ptrt Function
%func = OpFunction %voidt None %vfunct
%funcl = OpLabel
OpReturn
OpFunctionEnd
)";
CompileSuccessfully(str);
ASSERT_EQ(SPV_ERROR_INVALID_LAYOUT, ValidateInstructions());
EXPECT_THAT(getDiagnosticString(),
HasSubstr("Variables can not have a function[7] storage class "
"outside of a function"));
}
TEST_F(ValidateStorage, OtherStorageOutsideFunction) {
char str[] = R"(
OpCapability Shader
OpCapability Kernel
OpCapability AtomicStorage
OpCapability Linkage
OpMemoryModel Logical GLSL450
%intt = OpTypeInt 32 0
%voidt = OpTypeVoid
%vfunct = OpTypeFunction %voidt
%uniconptrt = OpTypePointer UniformConstant %intt
%unicon = OpVariable %uniconptrt UniformConstant
%inputptrt = OpTypePointer Input %intt
%input = OpVariable %inputptrt Input
%unifptrt = OpTypePointer Uniform %intt
%unif = OpVariable %unifptrt Uniform
%outputptrt = OpTypePointer Output %intt
%output = OpVariable %outputptrt Output
%wgroupptrt = OpTypePointer Workgroup %intt
%wgroup = OpVariable %wgroupptrt Workgroup
%xwgrpptrt = OpTypePointer CrossWorkgroup %intt
%xwgrp = OpVariable %xwgrpptrt CrossWorkgroup
%privptrt = OpTypePointer Private %intt
%priv = OpVariable %privptrt Private
%pushcoptrt = OpTypePointer PushConstant %intt
%pushco = OpVariable %pushcoptrt PushConstant
%atomcptrt = OpTypePointer AtomicCounter %intt
%atomct = OpVariable %atomcptrt AtomicCounter
%imageptrt = OpTypePointer Image %intt
%image = OpVariable %imageptrt Image
%func = OpFunction %voidt None %vfunct
%funcl = OpLabel
OpReturn
OpFunctionEnd
)";
CompileSuccessfully(str);
ASSERT_EQ(SPV_SUCCESS, ValidateInstructions());
}
// clang-format off
TEST_P(ValidateStorage, OtherStorageInsideFunction) {
std::stringstream ss;
ss << R"(
OpCapability Shader
OpCapability Kernel
OpCapability AtomicStorage
OpCapability Linkage
OpMemoryModel Logical GLSL450
%intt = OpTypeInt 32 0
%voidt = OpTypeVoid
%vfunct = OpTypeFunction %voidt
%ptrt = OpTypePointer Function %intt
%func = OpFunction %voidt None %vfunct
%funcl = OpLabel
%var = OpVariable %ptrt )" << GetParam() << R"(
OpReturn
OpFunctionEnd
)";
CompileSuccessfully(ss.str());
ASSERT_EQ(SPV_ERROR_INVALID_LAYOUT, ValidateInstructions());
EXPECT_THAT(getDiagnosticString(), HasSubstr(
"Variables must have a function[7] storage class inside of a function"));
}
INSTANTIATE_TEST_SUITE_P(MatrixOp, ValidateStorage,
::testing::Values(
"Input",
"Uniform",
"Output",
"Workgroup",
"CrossWorkgroup",
"Private",
"PushConstant",
"AtomicCounter",
"Image"));
// clang-format on
TEST_F(ValidateStorage, GenericVariableOutsideFunction) {
const auto str = R"(
OpCapability Kernel
OpCapability Linkage
OpMemoryModel Logical OpenCL
%intt = OpTypeInt 32 0
%ptrt = OpTypePointer Function %intt
%var = OpVariable %ptrt Generic
)";
CompileSuccessfully(str);
ASSERT_EQ(SPV_ERROR_INVALID_BINARY, ValidateInstructions());
EXPECT_THAT(getDiagnosticString(),
HasSubstr("OpVariable storage class cannot be Generic"));
}
TEST_F(ValidateStorage, GenericVariableInsideFunction) {
const auto str = R"(
OpCapability Shader
OpCapability Linkage
OpMemoryModel Logical GLSL450
%intt = OpTypeInt 32 1
%voidt = OpTypeVoid
%vfunct = OpTypeFunction %voidt
%ptrt = OpTypePointer Function %intt
%func = OpFunction %voidt None %vfunct
%funcl = OpLabel
%var = OpVariable %ptrt Generic
OpReturn
OpFunctionEnd
)";
CompileSuccessfully(str);
ASSERT_EQ(SPV_ERROR_INVALID_BINARY, ValidateInstructions());
EXPECT_THAT(getDiagnosticString(),
HasSubstr("OpVariable storage class cannot be Generic"));
}
TEST_F(ValidateStorage, RelaxedLogicalPointerFunctionParam) {
const auto str = R"(
OpCapability Shader
OpCapability Linkage
OpMemoryModel Logical GLSL450
%intt = OpTypeInt 32 1
%voidt = OpTypeVoid
%ptrt = OpTypePointer Function %intt
%vfunct = OpTypeFunction %voidt
%vifunct = OpTypeFunction %voidt %ptrt
%wgroupptrt = OpTypePointer Workgroup %intt
%wgroup = OpVariable %wgroupptrt Workgroup
%main = OpFunction %voidt None %vfunct
%mainl = OpLabel
%ret = OpFunctionCall %voidt %func %wgroup
OpReturn
OpFunctionEnd
%func = OpFunction %voidt None %vifunct
%arg = OpFunctionParameter %ptrt
%funcl = OpLabel
OpReturn
OpFunctionEnd
)";
CompileSuccessfully(str);
getValidatorOptions()->before_hlsl_legalization = true;
ASSERT_EQ(SPV_SUCCESS, ValidateInstructions());
}
TEST_F(ValidateStorage, RelaxedLogicalPointerFunctionParamBad) {
const auto str = R"(
OpCapability Shader
OpCapability Linkage
OpMemoryModel Logical GLSL450
%floatt = OpTypeFloat 32
%intt = OpTypeInt 32 1
%voidt = OpTypeVoid
%ptrt = OpTypePointer Function %intt
%vfunct = OpTypeFunction %voidt
%vifunct = OpTypeFunction %voidt %ptrt
%wgroupptrt = OpTypePointer Workgroup %floatt
%wgroup = OpVariable %wgroupptrt Workgroup
%main = OpFunction %voidt None %vfunct
%mainl = OpLabel
%ret = OpFunctionCall %voidt %func %wgroup
OpReturn
OpFunctionEnd
%func = OpFunction %voidt None %vifunct
%arg = OpFunctionParameter %ptrt
%funcl = OpLabel
OpReturn
OpFunctionEnd
)";
CompileSuccessfully(str);
getValidatorOptions()->relax_logical_pointer = true;
ASSERT_EQ(SPV_ERROR_INVALID_ID, ValidateInstructions());
EXPECT_THAT(getDiagnosticString(),
HasSubstr("OpFunctionCall Argument <id> '"));
}
std::string GetVarDeclStr(const std::string& storage_class) {
if (storage_class != "Output" && storage_class != "Private" &&
storage_class != "Function") {
return "%var = OpVariable %ptrt " + storage_class + "\n";
} else {
return "%var = OpVariable %ptrt " + storage_class + " %null\n";
}
}
TEST_P(ValidateStorageClass, WebGPU) {
std::string storage_class = std::get<0>(GetParam());
bool is_local = std::get<1>(GetParam());
bool is_valid = std::get<2>(GetParam());
std::string error = std::get<3>(GetParam());
std::string str = R"(
OpCapability Shader
OpCapability VulkanMemoryModelKHR
OpExtension "SPV_KHR_vulkan_memory_model"
OpMemoryModel Logical VulkanKHR
OpEntryPoint Fragment %func "func"
OpExecutionMode %func OriginUpperLeft
%intt = OpTypeInt 32 1
%voidt = OpTypeVoid
%vfunct = OpTypeFunction %voidt
%null = OpConstantNull %intt
)";
str += "%ptrt = OpTypePointer " + storage_class + " %intt\n";
if (!is_local) str += GetVarDeclStr(storage_class);
str += R"(
%func = OpFunction %voidt None %vfunct
%funcl = OpLabel
)";
if (is_local) str += GetVarDeclStr(storage_class);
str += R"(
OpReturn
OpFunctionEnd
)";
CompileSuccessfully(str, SPV_ENV_WEBGPU_0);
if (is_valid) {
ASSERT_EQ(SPV_SUCCESS, ValidateInstructions(SPV_ENV_WEBGPU_0));
} else {
ASSERT_EQ(SPV_ERROR_INVALID_BINARY, ValidateInstructions(SPV_ENV_WEBGPU_0));
EXPECT_THAT(getDiagnosticString(), HasSubstr(error));
}
}
INSTANTIATE_TEST_SUITE_P(
StorageClass, ValidateStorageClass,
Values(std::make_tuple("UniformConstant", false, true, ""),
std::make_tuple("Uniform", false, true, ""),
std::make_tuple("StorageBuffer", false, true, ""),
std::make_tuple("Input", false, true, ""),
std::make_tuple("Output", false, true, ""),
std::make_tuple("Image", false, true, ""),
std::make_tuple("Workgroup", false, true, ""),
std::make_tuple("Private", false, true, ""),
std::make_tuple("Function", true, true, ""),
std::make_tuple(
"CrossWorkgroup", false, false,
"For WebGPU, OpTypePointer storage class must be one of"),
std::make_tuple(
"PushConstant", false, false,
"For WebGPU, OpTypePointer storage class must be one of")));
} // namespace
} // namespace val
} // namespace spvtools