SPIRV-Tools/test/val/val_constants_test.cpp
David Neto 63f57d95d6
Support SPIR-V 1.4 (#2550)
* SPIR-V 1.4 headers, add SPV_ENV_UNIVERSAL_1_4

* Support --target-env spv1.4 in help for command line tools

* Support asm/dis of UniformId decoration

* Validate UniformId decoration

* Fix version check on instructions and operands

Also register decorations used with OpDecorateId

* Extension lists can differ between enums that match

Example: SubgroupMaskEq vs SubgroupMaskEqKHR

* Validate scope value for Uniform decoration, for SPIR-V 1.4

* More unioning of exts

* Preserve grammar order within an enum value

* 1.4: Validate OpSelect over composites

* Tools default to 1.4

* Add asm/dis test for OpCopyLogical

* 1.4: asm/dis tests for PtrEqual, PtrNotEqual, PtrDiff

* Basic asm/Dis test for OpCopyMemory

* Test asm/dis OpCopyMemory with 2-memory access

Add asm/dis tests for OpCopyMemorySized

Requires grammar update to add second optional memory access operand
to OpCopyMemory and OpCopyMemorySized

* Validate one or two memory accesses on OpCopyMemory*

* Check av/vis on CopyMemory source and target memory access

This is a proposed rule. See
https://gitlab.khronos.org/spirv/SPIR-V/issues/413

* Validate operation for OpSpecConstantOp

* Validate NonWritable decoration

Also permit NonWritable on members of UBO and SSBO.

* SPIR-V 1.4: NonWrtiable can decorate Function and Private vars

* Update optimizer CLI tests for SPIR-V 1.4

* Testing tools: Give expected SPIR-V version in message

* SPIR-V 1.4 validation for entry point interfaces

* Allow only unique interfaces
* Allow all global variables
* Check that all statically used global variables are listed
* new tests

* Add validation fixture CompileFailure

* Add 1.4 validation for pointer comparisons

* New tests

* Validate with image operands SignExtend, ZeroExtend

Since we don't actually know the image texel format, we can't fully
validate.  We need more context.

But we can make sure we allow the new image operands in known-good
cases.

* Validate OpCopyLogical

* Recursively checks subtypes
* new tests

* Add SPIR-V 1.4 tests for NoSignedWrap, NoUnsignedWrap

* Allow scalar conditions in 1.4 with OpSelect

* Allows scalar conditions with vector operands
* new tests

* Validate uniform id scope as an execution scope

* Validate the values of memory and execution scopes are valid scope
values
* new test

* Remove SPIR-V 1.4 Vulkan 1.0 environment

* SPIR-V 1.4 requires Vulkan 1.1

* FIX: include string for spvLog

* FIX: validate nonwritable

* FIX: test case suite for member decorate string

* FIX: test case for hlsl functionality1

* Validation test fixture: ease debugging

* Use binary version for SPIR-V 1.4 specific features

* Switch checks based on the SPIR-V version from the target environment
to instead use the version from the binary
* Moved header parsing into the ValidationState_t constructor (where
version based features are set)
* Added new versions of tests that assemble a 1.3 binary and validate a
1.4 environment

* Fix test for update to SPIR-V 1.4 headers

* Fix formatting

* Ext inst lookup: Add Vulkan 1.1 env with SPIR-V 1.4

* Update spirv-val help

* Operand version checks should use module version

Use the module version instead of the target environment version.

* Fix comment about two-access form of OpCopyMemory
2019-05-07 12:27:18 -04:00

373 lines
17 KiB
C++

// 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.
// Test validation of constants.
//
// This file contains newer tests. Older tests may be in other files such as
// val_id_test.cpp.
#include <string>
#include <vector>
#include "gmock/gmock.h"
#include "test/unit_spirv.h"
#include "test/val/val_fixtures.h"
namespace spvtools {
namespace val {
namespace {
using ::testing::Eq;
using ::testing::HasSubstr;
using ::testing::ValuesIn;
using ValidateConstant = spvtest::ValidateBase<bool>;
#define kBasicTypes \
"%bool = OpTypeBool " \
"%uint = OpTypeInt 32 0 " \
"%uint2 = OpTypeVector %uint 2 " \
"%float = OpTypeFloat 32 " \
"%_ptr_uint = OpTypePointer Workgroup %uint " \
"%uint_0 = OpConstantNull %uint " \
"%uint2_0 = OpConstantNull %uint " \
"%float_0 = OpConstantNull %float " \
"%false = OpConstantFalse %bool " \
"%true = OpConstantTrue %bool " \
"%null = OpConstantNull %_ptr_uint "
#define kShaderPreamble \
"OpCapability Shader\n" \
"OpCapability Linkage\n" \
"OpMemoryModel Logical Simple\n"
#define kKernelPreamble \
"OpCapability Kernel\n" \
"OpCapability Linkage\n" \
"OpCapability Addresses\n" \
"OpMemoryModel Physical32 OpenCL\n"
struct ConstantOpCase {
spv_target_env env;
std::string assembly;
bool expect_success;
std::string expect_err;
};
using ValidateConstantOp = spvtest::ValidateBase<ConstantOpCase>;
TEST_P(ValidateConstantOp, Samples) {
const auto env = GetParam().env;
CompileSuccessfully(GetParam().assembly, env);
const auto result = ValidateInstructions(env);
if (GetParam().expect_success) {
EXPECT_EQ(SPV_SUCCESS, result);
EXPECT_THAT(getDiagnosticString(), Eq(""));
} else {
EXPECT_EQ(SPV_ERROR_INVALID_ID, result);
EXPECT_THAT(getDiagnosticString(), HasSubstr(GetParam().expect_err));
}
}
#define GOOD_SHADER_10(STR) \
{ SPV_ENV_UNIVERSAL_1_0, kShaderPreamble kBasicTypes STR, true, "" }
#define GOOD_KERNEL_10(STR) \
{ SPV_ENV_UNIVERSAL_1_0, kKernelPreamble kBasicTypes STR, true, "" }
INSTANTIATE_TEST_SUITE_P(
UniversalInShader, ValidateConstantOp,
ValuesIn(std::vector<ConstantOpCase>{
// TODO(dneto): Conversions must change width.
GOOD_SHADER_10("%v = OpSpecConstantOp %uint SConvert %uint_0"),
GOOD_SHADER_10("%v = OpSpecConstantOp %float FConvert %float_0"),
GOOD_SHADER_10("%v = OpSpecConstantOp %uint SNegate %uint_0"),
GOOD_SHADER_10("%v = OpSpecConstantOp %uint Not %uint_0"),
GOOD_SHADER_10("%v = OpSpecConstantOp %uint IAdd %uint_0 %uint_0"),
GOOD_SHADER_10("%v = OpSpecConstantOp %uint ISub %uint_0 %uint_0"),
GOOD_SHADER_10("%v = OpSpecConstantOp %uint IMul %uint_0 %uint_0"),
GOOD_SHADER_10("%v = OpSpecConstantOp %uint UDiv %uint_0 %uint_0"),
GOOD_SHADER_10("%v = OpSpecConstantOp %uint SDiv %uint_0 %uint_0"),
GOOD_SHADER_10("%v = OpSpecConstantOp %uint UMod %uint_0 %uint_0"),
GOOD_SHADER_10("%v = OpSpecConstantOp %uint SRem %uint_0 %uint_0"),
GOOD_SHADER_10("%v = OpSpecConstantOp %uint SMod %uint_0 %uint_0"),
GOOD_SHADER_10(
"%v = OpSpecConstantOp %uint ShiftRightLogical %uint_0 %uint_0"),
GOOD_SHADER_10(
"%v = OpSpecConstantOp %uint ShiftRightArithmetic %uint_0 %uint_0"),
GOOD_SHADER_10(
"%v = OpSpecConstantOp %uint ShiftLeftLogical %uint_0 %uint_0"),
GOOD_SHADER_10("%v = OpSpecConstantOp %uint BitwiseOr %uint_0 %uint_0"),
GOOD_SHADER_10(
"%v = OpSpecConstantOp %uint BitwiseXor %uint_0 %uint_0"),
GOOD_SHADER_10(
"%v = OpSpecConstantOp %uint2 VectorShuffle %uint2_0 %uint2_0 1 3"),
GOOD_SHADER_10(
"%v = OpSpecConstantOp %uint CompositeExtract %uint2_0 1"),
GOOD_SHADER_10(
"%v = OpSpecConstantOp %uint2 CompositeInsert %uint_0 %uint2_0 1"),
GOOD_SHADER_10("%v = OpSpecConstantOp %bool LogicalOr %true %false"),
GOOD_SHADER_10("%v = OpSpecConstantOp %bool LogicalNot %true"),
GOOD_SHADER_10("%v = OpSpecConstantOp %bool LogicalAnd %true %false"),
GOOD_SHADER_10("%v = OpSpecConstantOp %bool LogicalEqual %true %false"),
GOOD_SHADER_10(
"%v = OpSpecConstantOp %bool LogicalNotEqual %true %false"),
GOOD_SHADER_10(
"%v = OpSpecConstantOp %uint Select %true %uint_0 %uint_0"),
GOOD_SHADER_10("%v = OpSpecConstantOp %bool IEqual %uint_0 %uint_0"),
GOOD_SHADER_10("%v = OpSpecConstantOp %bool INotEqual %uint_0 %uint_0"),
GOOD_SHADER_10("%v = OpSpecConstantOp %bool ULessThan %uint_0 %uint_0"),
GOOD_SHADER_10("%v = OpSpecConstantOp %bool SLessThan %uint_0 %uint_0"),
GOOD_SHADER_10(
"%v = OpSpecConstantOp %bool ULessThanEqual %uint_0 %uint_0"),
GOOD_SHADER_10(
"%v = OpSpecConstantOp %bool SLessThanEqual %uint_0 %uint_0"),
GOOD_SHADER_10(
"%v = OpSpecConstantOp %bool UGreaterThan %uint_0 %uint_0"),
GOOD_SHADER_10(
"%v = OpSpecConstantOp %bool UGreaterThanEqual %uint_0 %uint_0"),
GOOD_SHADER_10(
"%v = OpSpecConstantOp %bool SGreaterThan %uint_0 %uint_0"),
GOOD_SHADER_10(
"%v = OpSpecConstantOp %bool SGreaterThanEqual %uint_0 %uint_0"),
}));
INSTANTIATE_TEST_SUITE_P(
UniversalInKernel, ValidateConstantOp,
ValuesIn(std::vector<ConstantOpCase>{
// TODO(dneto): Conversions must change width.
GOOD_KERNEL_10("%v = OpSpecConstantOp %uint SConvert %uint_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %float FConvert %float_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %uint SNegate %uint_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %uint Not %uint_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %uint IAdd %uint_0 %uint_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %uint ISub %uint_0 %uint_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %uint IMul %uint_0 %uint_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %uint UDiv %uint_0 %uint_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %uint SDiv %uint_0 %uint_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %uint UMod %uint_0 %uint_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %uint SRem %uint_0 %uint_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %uint SMod %uint_0 %uint_0"),
GOOD_KERNEL_10(
"%v = OpSpecConstantOp %uint ShiftRightLogical %uint_0 %uint_0"),
GOOD_KERNEL_10(
"%v = OpSpecConstantOp %uint ShiftRightArithmetic %uint_0 %uint_0"),
GOOD_KERNEL_10(
"%v = OpSpecConstantOp %uint ShiftLeftLogical %uint_0 %uint_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %uint BitwiseOr %uint_0 %uint_0"),
GOOD_KERNEL_10(
"%v = OpSpecConstantOp %uint BitwiseXor %uint_0 %uint_0"),
GOOD_KERNEL_10(
"%v = OpSpecConstantOp %uint2 VectorShuffle %uint2_0 %uint2_0 1 3"),
GOOD_KERNEL_10(
"%v = OpSpecConstantOp %uint CompositeExtract %uint2_0 1"),
GOOD_KERNEL_10(
"%v = OpSpecConstantOp %uint2 CompositeInsert %uint_0 %uint2_0 1"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %bool LogicalOr %true %false"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %bool LogicalNot %true"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %bool LogicalAnd %true %false"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %bool LogicalEqual %true %false"),
GOOD_KERNEL_10(
"%v = OpSpecConstantOp %bool LogicalNotEqual %true %false"),
GOOD_KERNEL_10(
"%v = OpSpecConstantOp %uint Select %true %uint_0 %uint_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %bool IEqual %uint_0 %uint_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %bool INotEqual %uint_0 %uint_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %bool ULessThan %uint_0 %uint_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %bool SLessThan %uint_0 %uint_0"),
GOOD_KERNEL_10(
"%v = OpSpecConstantOp %bool ULessThanEqual %uint_0 %uint_0"),
GOOD_KERNEL_10(
"%v = OpSpecConstantOp %bool SLessThanEqual %uint_0 %uint_0"),
GOOD_KERNEL_10(
"%v = OpSpecConstantOp %bool UGreaterThan %uint_0 %uint_0"),
GOOD_KERNEL_10(
"%v = OpSpecConstantOp %bool UGreaterThanEqual %uint_0 %uint_0"),
GOOD_KERNEL_10(
"%v = OpSpecConstantOp %bool SGreaterThan %uint_0 %uint_0"),
GOOD_KERNEL_10(
"%v = OpSpecConstantOp %bool SGreaterThanEqual %uint_0 %uint_0"),
}));
INSTANTIATE_TEST_SUITE_P(
UConvert, ValidateConstantOp,
ValuesIn(std::vector<ConstantOpCase>{
// TODO(dneto): Conversions must change width.
{SPV_ENV_UNIVERSAL_1_0,
kKernelPreamble kBasicTypes
"%v = OpSpecConstantOp %uint UConvert %uint_0",
true, ""},
{SPV_ENV_UNIVERSAL_1_1,
kKernelPreamble kBasicTypes
"%v = OpSpecConstantOp %uint UConvert %uint_0",
true, ""},
{SPV_ENV_UNIVERSAL_1_3,
kKernelPreamble kBasicTypes
"%v = OpSpecConstantOp %uint UConvert %uint_0",
true, ""},
{SPV_ENV_UNIVERSAL_1_3,
kKernelPreamble kBasicTypes
"%v = OpSpecConstantOp %uint UConvert %uint_0",
true, ""},
{SPV_ENV_UNIVERSAL_1_4,
kKernelPreamble kBasicTypes
"%v = OpSpecConstantOp %uint UConvert %uint_0",
true, ""},
{SPV_ENV_UNIVERSAL_1_0,
kShaderPreamble kBasicTypes
"%v = OpSpecConstantOp %uint UConvert %uint_0",
false,
"Prior to SPIR-V 1.4, specialization constant operation "
"UConvert requires Kernel capability"},
{SPV_ENV_UNIVERSAL_1_1,
kShaderPreamble kBasicTypes
"%v = OpSpecConstantOp %uint UConvert %uint_0",
false,
"Prior to SPIR-V 1.4, specialization constant operation "
"UConvert requires Kernel capability"},
{SPV_ENV_UNIVERSAL_1_3,
kShaderPreamble kBasicTypes
"%v = OpSpecConstantOp %uint UConvert %uint_0",
false,
"Prior to SPIR-V 1.4, specialization constant operation "
"UConvert requires Kernel capability"},
{SPV_ENV_UNIVERSAL_1_3,
kShaderPreamble kBasicTypes
"%v = OpSpecConstantOp %uint UConvert %uint_0",
false,
"Prior to SPIR-V 1.4, specialization constant operation "
"UConvert requires Kernel capability"},
{SPV_ENV_UNIVERSAL_1_4,
kShaderPreamble kBasicTypes
"%v = OpSpecConstantOp %uint UConvert %uint_0",
true, ""},
}));
INSTANTIATE_TEST_SUITE_P(
KernelInKernel, ValidateConstantOp,
ValuesIn(std::vector<ConstantOpCase>{
// TODO(dneto): Conversions must change width.
GOOD_KERNEL_10("%v = OpSpecConstantOp %uint ConvertFToS %float_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %float ConvertSToF %uint_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %uint ConvertFToU %float_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %float ConvertUToF %uint_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %uint UConvert %uint_0"),
GOOD_KERNEL_10(
"%v = OpSpecConstantOp %_ptr_uint GenericCastToPtr %null"),
GOOD_KERNEL_10(
"%v = OpSpecConstantOp %_ptr_uint PtrCastToGeneric %null"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %uint Bitcast %uint_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %float FNegate %float_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %float FAdd %float_0 %float_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %float FSub %float_0 %float_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %float FMul %float_0 %float_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %float FDiv %float_0 %float_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %float FRem %float_0 %float_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %float FMod %float_0 %float_0"),
GOOD_KERNEL_10(
"%v = OpSpecConstantOp %_ptr_uint AccessChain %null %uint_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %_ptr_uint InBoundsAccessChain "
"%null %uint_0"),
GOOD_KERNEL_10(
"%v = OpSpecConstantOp %_ptr_uint PtrAccessChain %null %uint_0"),
GOOD_KERNEL_10("%v = OpSpecConstantOp %_ptr_uint "
"InBoundsPtrAccessChain %null %uint_0"),
}));
#define BAD_SHADER_10(STR, NAME) \
{ \
SPV_ENV_UNIVERSAL_1_0, kShaderPreamble kBasicTypes STR, false, \
"Specialization constant operation " NAME \
" requires Kernel capability" \
}
INSTANTIATE_TEST_SUITE_P(
KernelInShader, ValidateConstantOp,
ValuesIn(std::vector<ConstantOpCase>{
// TODO(dneto): Conversions must change width.
BAD_SHADER_10("%v = OpSpecConstantOp %uint ConvertFToS %float_0",
"ConvertFToS"),
BAD_SHADER_10("%v = OpSpecConstantOp %float ConvertSToF %uint_0",
"ConvertSToF"),
BAD_SHADER_10("%v = OpSpecConstantOp %uint ConvertFToU %float_0",
"ConvertFToU"),
BAD_SHADER_10("%v = OpSpecConstantOp %float ConvertUToF %uint_0",
"ConvertUToF"),
BAD_SHADER_10("%v = OpSpecConstantOp %_ptr_uint GenericCastToPtr %null",
"GenericCastToPtr"),
BAD_SHADER_10("%v = OpSpecConstantOp %_ptr_uint PtrCastToGeneric %null",
"PtrCastToGeneric"),
BAD_SHADER_10("%v = OpSpecConstantOp %uint Bitcast %uint_0", "Bitcast"),
BAD_SHADER_10("%v = OpSpecConstantOp %float FNegate %float_0",
"FNegate"),
BAD_SHADER_10("%v = OpSpecConstantOp %float FAdd %float_0 %float_0",
"FAdd"),
BAD_SHADER_10("%v = OpSpecConstantOp %float FSub %float_0 %float_0",
"FSub"),
BAD_SHADER_10("%v = OpSpecConstantOp %float FMul %float_0 %float_0",
"FMul"),
BAD_SHADER_10("%v = OpSpecConstantOp %float FDiv %float_0 %float_0",
"FDiv"),
BAD_SHADER_10("%v = OpSpecConstantOp %float FRem %float_0 %float_0",
"FRem"),
BAD_SHADER_10("%v = OpSpecConstantOp %float FMod %float_0 %float_0",
"FMod"),
BAD_SHADER_10(
"%v = OpSpecConstantOp %_ptr_uint AccessChain %null %uint_0",
"AccessChain"),
BAD_SHADER_10("%v = OpSpecConstantOp %_ptr_uint InBoundsAccessChain "
"%null %uint_0",
"InBoundsAccessChain"),
BAD_SHADER_10(
"%v = OpSpecConstantOp %_ptr_uint PtrAccessChain %null %uint_0",
"PtrAccessChain"),
BAD_SHADER_10("%v = OpSpecConstantOp %_ptr_uint "
"InBoundsPtrAccessChain %null %uint_0",
"InBoundsPtrAccessChain"),
}));
INSTANTIATE_TEST_SUITE_P(
UConvertInAMD_gpu_shader_int16, ValidateConstantOp,
ValuesIn(std::vector<ConstantOpCase>{
// SPV_AMD_gpu_shader_int16 should enable UConvert for OpSpecConstantOp
// https://github.com/KhronosGroup/glslang/issues/848
{SPV_ENV_UNIVERSAL_1_0,
"OpCapability Shader "
"OpCapability Linkage ; So we don't need to define a function\n"
"OpExtension \"SPV_AMD_gpu_shader_int16\" "
"OpMemoryModel Logical Simple " kBasicTypes
"%v = OpSpecConstantOp %uint UConvert %uint_0",
true, ""},
}));
TEST_F(ValidateConstant, SpecConstantUConvert1p3Binary1p4EnvBad) {
const std::string spirv = R"(
OpCapability Shader
OpCapability Linkage
OpMemoryModel Logical GLSL450
%int = OpTypeInt 32 0
%int0 = OpConstant %int 0
%const = OpSpecConstantOp %int UConvert %int0
)";
CompileSuccessfully(spirv, SPV_ENV_UNIVERSAL_1_3);
EXPECT_EQ(SPV_ERROR_INVALID_ID, ValidateInstructions(SPV_ENV_UNIVERSAL_1_4));
EXPECT_THAT(
getDiagnosticString(),
HasSubstr(
"Prior to SPIR-V 1.4, specialization constant operation UConvert "
"requires Kernel capability or extension SPV_AMD_gpu_shader_int16"));
}
} // namespace
} // namespace val
} // namespace spvtools