AuroraMiddleware/SPIRV-Tools
1
0
Fork 0
mirror of https://github.com/KhronosGroup/SPIRV-Tools synced 2024-11-27 05:40:06 +00:00
Code Issues Packages Projects Releases Wiki Activity
cd68f2b176
SPIRV-Tools/source/validate_image.cpp
Andrey Tuganov bdc78377bc Added Vulkan-specifc checks to image validation 
Implemented Vulkan-specific rules:
- OpTypeImage must declare a scalar 32-bit float or 32-bit integer type
for the “Sampled Type”.
- OpSampledImage must only consume an “Image” operand whose type has its
“Sampled” operand set to 1.
2018-01-24 14:05:42 -08:00

1680 lines
59 KiB
C++
Raw Blame History

// 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.
// Validates correctness of image instructions.
#include "validate.h"
#include "diagnostic.h"
#include "opcode.h"
#include "spirv_target_env.h"
#include "val/instruction.h"
#include "val/validation_state.h"
namespace libspirv {
namespace {
// Performs compile time check that all SpvImageOperandsXXX cases are handled in
// this module. If SpvImageOperandsXXX list changes, this function will fail the
// build.
// For all other purposes this is a dummy function.
bool CheckAllImageOperandsHandled() {
SpvImageOperandsMask enum_val = SpvImageOperandsBiasMask;
// Some improvised code to prevent the compiler from considering enum_val
// constant and optimizing the switch away.
uint32_t stack_var = 0;
if (reinterpret_cast<uintptr_t>(&stack_var) % 256)
enum_val = SpvImageOperandsLodMask;
switch (enum_val) {
// Please update the validation rules in this module if you are changing
// the list of image operands, and add new enum values to this switch.
case SpvImageOperandsMaskNone:
return false;
case SpvImageOperandsBiasMask:
case SpvImageOperandsLodMask:
case SpvImageOperandsGradMask:
case SpvImageOperandsConstOffsetMask:
case SpvImageOperandsOffsetMask:
case SpvImageOperandsConstOffsetsMask:
case SpvImageOperandsSampleMask:
case SpvImageOperandsMinLodMask:
return true;
}
return false;
}
// Returns number of '1' bits in a word.
uint32_t CountSetBits(uint32_t word) {
uint32_t count = 0;
while (word) {
word &= word - 1;
++count;
}
return count;
}
// Used by GetImageTypeInfo. See OpTypeImage spec for more information.
struct ImageTypeInfo {
uint32_t sampled_type = 0;
SpvDim dim = SpvDimMax;
uint32_t depth = 0;
uint32_t arrayed = 0;
uint32_t multisampled = 0;
uint32_t sampled = 0;
SpvImageFormat format = SpvImageFormatMax;
SpvAccessQualifier access_qualifier = SpvAccessQualifierMax;
};
// Provides information on image type. |id| should be object of either
// OpTypeImage or OpTypeSampledImage type. Returns false in case of failure
// (not a valid id, failed to parse the instruction, etc).
bool GetImageTypeInfo(const ValidationState_t& _, uint32_t id,
ImageTypeInfo* info) {
if (!id || !info) return false;
const Instruction* inst = _.FindDef(id);
assert(inst);
if (inst->opcode() == SpvOpTypeSampledImage) {
inst = _.FindDef(inst->word(2));
assert(inst);
}
if (inst->opcode() != SpvOpTypeImage) return false;
const size_t num_words = inst->words().size();
if (num_words != 9 && num_words != 10) return false;
info->sampled_type = inst->word(2);
info->dim = static_cast<SpvDim>(inst->word(3));
info->depth = inst->word(4);
info->arrayed = inst->word(5);
info->multisampled = inst->word(6);
info->sampled = inst->word(7);
info->format = static_cast<SpvImageFormat>(inst->word(8));
info->access_qualifier = num_words < 10
? SpvAccessQualifierMax
: static_cast<SpvAccessQualifier>(inst->word(9));
return true;
}
bool IsImplicitLod(SpvOp opcode) {
switch (opcode) {
case SpvOpImageSampleImplicitLod:
case SpvOpImageSampleDrefImplicitLod:
case SpvOpImageSampleProjImplicitLod:
case SpvOpImageSampleProjDrefImplicitLod:
case SpvOpImageSparseSampleImplicitLod:
case SpvOpImageSparseSampleDrefImplicitLod:
case SpvOpImageSparseSampleProjImplicitLod:
case SpvOpImageSparseSampleProjDrefImplicitLod:
return true;
default:
break;
};
return false;
}
bool IsExplicitLod(SpvOp opcode) {
switch (opcode) {
case SpvOpImageSampleExplicitLod:
case SpvOpImageSampleDrefExplicitLod:
case SpvOpImageSampleProjExplicitLod:
case SpvOpImageSampleProjDrefExplicitLod:
case SpvOpImageSparseSampleExplicitLod:
case SpvOpImageSparseSampleDrefExplicitLod:
case SpvOpImageSparseSampleProjExplicitLod:
case SpvOpImageSparseSampleProjDrefExplicitLod:
return true;
default:
break;
};
return false;
}
// Returns true if the opcode is a Image instruction which applies
// homogenous projection to the coordinates.
bool IsProj(SpvOp opcode) {
switch (opcode) {
case SpvOpImageSampleProjImplicitLod:
case SpvOpImageSampleProjDrefImplicitLod:
case SpvOpImageSparseSampleProjImplicitLod:
case SpvOpImageSparseSampleProjDrefImplicitLod:
case SpvOpImageSampleProjExplicitLod:
case SpvOpImageSampleProjDrefExplicitLod:
case SpvOpImageSparseSampleProjExplicitLod:
case SpvOpImageSparseSampleProjDrefExplicitLod:
return true;
default:
break;
};
return false;
}
// Returns the number of components in a coordinate used to access a texel in
// a single plane of an image with the given parameters.
uint32_t GetPlaneCoordSize(const ImageTypeInfo& info) {
uint32_t plane_size = 0;
// If this switch breaks your build, please add new values below.
switch (info.dim) {
case SpvDim1D:
case SpvDimBuffer:
plane_size = 1;
break;
case SpvDim2D:
case SpvDimRect:
case SpvDimSubpassData:
plane_size = 2;
break;
case SpvDim3D:
case SpvDimCube:
// For Cube direction vector is used instead of UV.
plane_size = 3;
break;
case SpvDimMax:
assert(0);
break;
}
return plane_size;
}
// Returns minimal number of coordinates based on image dim, arrayed and whether
// the instruction uses projection coordinates.
uint32_t GetMinCoordSize(SpvOp opcode, const ImageTypeInfo& info) {
if (info.dim == SpvDimCube &&
(opcode == SpvOpImageRead || opcode == SpvOpImageWrite ||
opcode == SpvOpImageSparseRead)) {
// These opcodes use UV for Cube, not direction vector.
return 3;
}
return GetPlaneCoordSize(info) + info.arrayed + (IsProj(opcode) ? 1 : 0);
}
// Checks ImageOperand bitfield and respective operands.
spv_result_t ValidateImageOperands(ValidationState_t& _,
const spv_parsed_instruction_t& inst,
const ImageTypeInfo& info, uint32_t mask,
uint32_t word_index) {
static const bool kAllImageOperandsHandled = CheckAllImageOperandsHandled();
(void)kAllImageOperandsHandled;
const SpvOp opcode = static_cast<SpvOp>(inst.opcode);
const uint32_t num_words = inst.num_words;
uint32_t expected_num_image_operand_words = CountSetBits(mask);
if (mask & SpvImageOperandsGradMask) {
// Grad uses two words.
++expected_num_image_operand_words;
}
if (expected_num_image_operand_words != num_words - word_index) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Number of image operand ids doesn't correspond to the bit mask: "
<< spvOpcodeString(opcode);
}
if (CountSetBits(mask & (SpvImageOperandsOffsetMask |
SpvImageOperandsConstOffsetMask |
SpvImageOperandsConstOffsetsMask)) > 1) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image Operands Offset, ConstOffset, ConstOffsets cannot be used "
<< "together: " << spvOpcodeString(opcode);
};
const bool is_implicit_lod = IsImplicitLod(opcode);
const bool is_explicit_lod = IsExplicitLod(opcode);
// The checks should be done in the order of definition of OperandImage.
if (mask & SpvImageOperandsBiasMask) {
if (!is_implicit_lod) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image Operand Bias can only be used with ImplicitLod opcodes: "
<< spvOpcodeString(opcode);
};
const uint32_t type_id = _.GetTypeId(inst.words[word_index++]);
if (!_.IsFloatScalarType(type_id)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image Operand Bias to be float scalar: "
<< spvOpcodeString(opcode);
}
if (info.dim != SpvDim1D && info.dim != SpvDim2D && info.dim != SpvDim3D &&
info.dim != SpvDimCube) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image Operand Bias requires 'Dim' parameter to be 1D, 2D, 3D "
"or "
<< "Cube: " << spvOpcodeString(opcode);
}
if (info.multisampled != 0) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image Operand Bias requires 'MS' parameter to be 0: "
<< spvOpcodeString(opcode);
}
}
if (mask & SpvImageOperandsLodMask) {
if (!is_explicit_lod && opcode != SpvOpImageFetch &&
opcode != SpvOpImageSparseFetch) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image Operand Lod can only be used with ExplicitLod opcodes "
<< "and OpImageFetch: " << spvOpcodeString(opcode);
};
if (mask & SpvImageOperandsGradMask) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image Operand bits Lod and Grad cannot be set at the same "
"time: "
<< spvOpcodeString(opcode);
}
const uint32_t type_id = _.GetTypeId(inst.words[word_index++]);
if (is_explicit_lod) {
if (!_.IsFloatScalarType(type_id)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image Operand Lod to be float scalar when used "
<< "with ExplicitLod: " << spvOpcodeString(opcode);
}
} else {
if (!_.IsIntScalarType(type_id)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image Operand Lod to be int scalar when used with "
<< "OpImageFetch";
}
}
if (info.dim != SpvDim1D && info.dim != SpvDim2D && info.dim != SpvDim3D &&
info.dim != SpvDimCube) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image Operand Lod requires 'Dim' parameter to be 1D, 2D, 3D "
"or "
<< "Cube: " << spvOpcodeString(opcode);
}
if (info.multisampled != 0) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image Operand Lod requires 'MS' parameter to be 0: "
<< spvOpcodeString(opcode);
}
}
if (mask & SpvImageOperandsGradMask) {
if (!is_explicit_lod) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image Operand Grad can only be used with ExplicitLod opcodes: "
<< spvOpcodeString(opcode);
};
const uint32_t dx_type_id = _.GetTypeId(inst.words[word_index++]);
const uint32_t dy_type_id = _.GetTypeId(inst.words[word_index++]);
if (!_.IsFloatScalarOrVectorType(dx_type_id) ||
!_.IsFloatScalarOrVectorType(dy_type_id)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected both Image Operand Grad ids to be float scalars or "
<< "vectors: " << spvOpcodeString(opcode);
}
const uint32_t plane_size = GetPlaneCoordSize(info);
const uint32_t dx_size = _.GetDimension(dx_type_id);
const uint32_t dy_size = _.GetDimension(dy_type_id);
if (plane_size != dx_size) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image Operand Grad dx to have " << plane_size
<< " components, but given " << dx_size << ": "
<< spvOpcodeString(opcode);
}
if (plane_size != dy_size) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image Operand Grad dy to have " << plane_size
<< " components, but given " << dy_size << ": "
<< spvOpcodeString(opcode);
}
if (info.multisampled != 0) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image Operand Grad requires 'MS' parameter to be 0: "
<< spvOpcodeString(opcode);
}
}
if (mask & SpvImageOperandsConstOffsetMask) {
if (info.dim == SpvDimCube) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image Operand ConstOffset cannot be used with Cube Image "
"'Dim': "
<< spvOpcodeString(opcode);
}
const uint32_t id = inst.words[word_index++];
const uint32_t type_id = _.GetTypeId(id);
if (!_.IsIntScalarOrVectorType(type_id)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image Operand ConstOffset to be int scalar or "
<< "vector: " << spvOpcodeString(opcode);
}
if (!spvOpcodeIsConstant(_.GetIdOpcode(id))) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image Operand ConstOffset to be a const object: "
<< spvOpcodeString(opcode);
}
const uint32_t plane_size = GetPlaneCoordSize(info);
const uint32_t offset_size = _.GetDimension(type_id);
if (plane_size != offset_size) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image Operand ConstOffset to have " << plane_size
<< " components, but given " << offset_size << ": "
<< spvOpcodeString(opcode);
}
}
if (mask & SpvImageOperandsOffsetMask) {
if (info.dim == SpvDimCube) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image Operand Offset cannot be used with Cube Image 'Dim': "
<< spvOpcodeString(opcode);
}
const uint32_t id = inst.words[word_index++];
const uint32_t type_id = _.GetTypeId(id);
if (!_.IsIntScalarOrVectorType(type_id)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image Operand Offset to be int scalar or "
<< "vector: " << spvOpcodeString(opcode);
}
const uint32_t plane_size = GetPlaneCoordSize(info);
const uint32_t offset_size = _.GetDimension(type_id);
if (plane_size != offset_size) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image Operand Offset to have " << plane_size
<< " components, but given " << offset_size << ": "
<< spvOpcodeString(opcode);
}
}
if (mask & SpvImageOperandsConstOffsetsMask) {
if (opcode != SpvOpImageGather && opcode != SpvOpImageDrefGather &&
opcode != SpvOpImageSparseGather &&
opcode != SpvOpImageSparseDrefGather) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image Operand ConstOffsets can only be used with "
"OpImageGather "
<< "and OpImageDrefGather: " << spvOpcodeString(opcode);
}
if (info.dim == SpvDimCube) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image Operand ConstOffsets cannot be used with Cube Image "
"'Dim': "
<< spvOpcodeString(opcode);
}
const uint32_t id = inst.words[word_index++];
const uint32_t type_id = _.GetTypeId(id);
const Instruction* type_inst = _.FindDef(type_id);
assert(type_inst);
if (type_inst->opcode() != SpvOpTypeArray) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image Operand ConstOffsets to be an array of size 4: "
<< spvOpcodeString(opcode);
}
uint64_t array_size = 0;
if (!_.GetConstantValUint64(type_inst->word(3), &array_size)) {
assert(0 && "Array type definition is corrupt");
}
if (array_size != 4) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image Operand ConstOffsets to be an array of size 4: "
<< spvOpcodeString(opcode);
}
const uint32_t component_type = type_inst->word(2);
if (!_.IsIntVectorType(component_type) ||
_.GetDimension(component_type) != 2) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image Operand ConstOffsets array componenets to be "
"int "
<< "vectors of size 2: " << spvOpcodeString(opcode);
}
if (!spvOpcodeIsConstant(_.GetIdOpcode(id))) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image Operand ConstOffsets to be a const object: "
<< spvOpcodeString(opcode);
}
}
if (mask & SpvImageOperandsSampleMask) {
if (opcode != SpvOpImageFetch && opcode != SpvOpImageRead &&
opcode != SpvOpImageWrite && opcode != SpvOpImageSparseFetch &&
opcode != SpvOpImageSparseRead) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image Operand Sample can only be used with OpImageFetch, "
<< "OpImageRead, OpImageWrite, OpImageSparseFetch and "
<< "OpImageSparseRead: " << spvOpcodeString(opcode);
}
if (info.multisampled == 0) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image Operand Sample requires non-zero 'MS' parameter: "
<< spvOpcodeString(opcode);
}
const uint32_t type_id = _.GetTypeId(inst.words[word_index++]);
if (!_.IsIntScalarType(type_id)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image Operand Sample to be int scalar: "
<< spvOpcodeString(opcode);
}
}
if (mask & SpvImageOperandsMinLodMask) {
if (!is_implicit_lod && !(mask & SpvImageOperandsGradMask)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image Operand MinLod can only be used with ImplicitLod "
<< "opcodes or together with Image Operand Grad: "
<< spvOpcodeString(opcode);
};
const uint32_t type_id = _.GetTypeId(inst.words[word_index++]);
if (!_.IsFloatScalarType(type_id)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image Operand MinLod to be float scalar: "
<< spvOpcodeString(opcode);
}
if (info.dim != SpvDim1D && info.dim != SpvDim2D && info.dim != SpvDim3D &&
info.dim != SpvDimCube) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image Operand MinLod requires 'Dim' parameter to be 1D, 2D, "
"3D "
<< "or Cube: " << spvOpcodeString(opcode);
}
if (info.multisampled != 0) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image Operand MinLod requires 'MS' parameter to be 0: "
<< spvOpcodeString(opcode);
}
}
return SPV_SUCCESS;
}
// Checks some of the validation rules which are common to multiple opcodes.
spv_result_t ValidateImageCommon(ValidationState_t& _,
const spv_parsed_instruction_t& inst,
const ImageTypeInfo& info) {
const SpvOp opcode = static_cast<SpvOp>(inst.opcode);
if (IsProj(opcode)) {
if (info.dim != SpvDim1D && info.dim != SpvDim2D && info.dim != SpvDim3D &&
info.dim != SpvDimRect) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image 'Dim' parameter to be 1D, 2D, 3D or Rect: "
<< spvOpcodeString(opcode);
}
if (info.multisampled != 0) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image Image 'MS' parameter to be 0: "
<< spvOpcodeString(opcode);
}
if (info.arrayed != 0) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image Image 'arrayed' parameter to be 0: "
<< spvOpcodeString(opcode);
}
}
if (opcode == SpvOpImageRead || opcode == SpvOpImageSparseRead ||
opcode == SpvOpImageWrite) {
if (info.sampled == 0) {
} else if (info.sampled == 2) {
if (info.dim == SpvDim1D && !_.HasCapability(SpvCapabilityImage1D)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Capability Image1D is required to access storage image: "
<< spvOpcodeString(opcode);
} else if (info.dim == SpvDimRect &&
!_.HasCapability(SpvCapabilityImageRect)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Capability ImageRect is required to access storage image: "
<< spvOpcodeString(opcode);
} else if (info.dim == SpvDimBuffer &&
!_.HasCapability(SpvCapabilityImageBuffer)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Capability ImageBuffer is required to access storage image: "
<< spvOpcodeString(opcode);
} else if (info.dim == SpvDimCube && info.arrayed == 1 &&
!_.HasCapability(SpvCapabilityImageCubeArray)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Capability ImageCubeArray is required to access storage "
<< "image: " << spvOpcodeString(opcode);
}
if (info.multisampled == 1 &&
!_.HasCapability(SpvCapabilityImageMSArray)) {
#if 0
// TODO(atgoo@github.com) The description of this rule in the spec
// is unclear and Glslang doesn't declare ImageMSArray. Need to clarify
// and reenable.
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Capability ImageMSArray is required to access storage "
<< "image: " << spvOpcodeString(opcode);
#endif
}
} else {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image 'Sampled' parameter to be 0 or 2: "
<< spvOpcodeString(opcode);
}
}
return SPV_SUCCESS;
}
// Returns true if opcode is *ImageSparse*, false otherwise.
bool IsSparse(SpvOp opcode) {
switch (opcode) {
case SpvOpImageSparseSampleImplicitLod:
case SpvOpImageSparseSampleExplicitLod:
case SpvOpImageSparseSampleDrefImplicitLod:
case SpvOpImageSparseSampleDrefExplicitLod:
case SpvOpImageSparseSampleProjImplicitLod:
case SpvOpImageSparseSampleProjExplicitLod:
case SpvOpImageSparseSampleProjDrefImplicitLod:
case SpvOpImageSparseSampleProjDrefExplicitLod:
case SpvOpImageSparseFetch:
case SpvOpImageSparseGather:
case SpvOpImageSparseDrefGather:
case SpvOpImageSparseTexelsResident:
case SpvOpImageSparseRead: {
return true;
}
default: { return false; }
}
return false;
}
// Checks sparse image opcode result type and returns the second struct member.
// Returns inst.type_id for non-sparse image opcodes.
// Not valid for sparse image opcodes which do not return a struct.
spv_result_t GetActualResultType(ValidationState_t& _,
const spv_parsed_instruction_t& inst,
uint32_t* actual_result_type) {
const SpvOp opcode = static_cast<SpvOp>(inst.opcode);
if (IsSparse(opcode)) {
const Instruction* const type_inst = _.FindDef(inst.type_id);
assert(type_inst);
if (!type_inst || type_inst->opcode() != SpvOpTypeStruct) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< spvOpcodeString(opcode)
<< ": expected Result Type to be OpTypeStruct";
}
if (type_inst->words().size() != 4 ||
!_.IsIntScalarType(type_inst->word(2))) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< spvOpcodeString(opcode)
<< ": expected Result Type to be a struct containing an int "
"scalar "
<< "and a texel";
}
*actual_result_type = type_inst->word(3);
} else {
*actual_result_type = inst.type_id;
}
return SPV_SUCCESS;
}
// Returns a string describing actual result type of an opcode.
// Not valid for sparse image opcodes which do not return a struct.
const char* GetActualResultTypeStr(SpvOp opcode) {
if (IsSparse(opcode)) return "Result Type's second member";
return "Result Type";
}
} // namespace
// Validates correctness of image instructions.
spv_result_t ImagePass(ValidationState_t& _,
const spv_parsed_instruction_t* inst) {
const SpvOp opcode = static_cast<SpvOp>(inst->opcode);
const uint32_t result_type = inst->type_id;
if (IsImplicitLod(opcode)) {
_.current_function().RegisterExecutionModelLimitation(
SpvExecutionModelFragment,
"ImplicitLod instructions require Fragment execution model");
}
switch (opcode) {
case SpvOpTypeImage: {
assert(result_type == 0);
ImageTypeInfo info;
if (!GetImageTypeInfo(_, inst->words[1], &info)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "OpTypeImage: corrupt definition";
}
if (spvIsVulkanEnv(_.context()->target_env)) {
if ((!_.IsFloatScalarType(info.sampled_type) &&
!_.IsIntScalarType(info.sampled_type)) ||
32 != _.GetBitWidth(info.sampled_type)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< spvOpcodeString(opcode)
<< ": expected Sampled Type to be a 32-bit int or float "
"scalar type for Vulkan environment";
}
} else {
const SpvOp sampled_type_opcode = _.GetIdOpcode(info.sampled_type);
if (sampled_type_opcode != SpvOpTypeVoid &&
sampled_type_opcode != SpvOpTypeInt &&
sampled_type_opcode != SpvOpTypeFloat) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< spvOpcodeString(opcode)
<< ": expected Sampled Type to be either void or numerical "
<< "scalar type";
}
}
// Dim is checked elsewhere.
if (info.depth > 2) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< spvOpcodeString(opcode) << ": invalid Depth " << info.depth
<< " (must be 0, 1 or 2)";
}
if (info.arrayed > 1) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< spvOpcodeString(opcode) << ": invalid Arrayed "
<< info.arrayed << " (must be 0 or 1)";
}
if (info.multisampled > 1) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< spvOpcodeString(opcode) << ": invalid MS "
<< info.multisampled << " (must be 0 or 1)";
}
if (info.sampled > 2) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< spvOpcodeString(opcode) << ": invalid Sampled "
<< info.sampled << " (must be 0, 1 or 2)";
}
if (info.dim == SpvDimSubpassData) {
if (info.sampled != 2) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< spvOpcodeString(opcode)
<< ": Dim SubpassData requires Sampled to be 2";
}
if (info.format != SpvImageFormatUnknown) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< spvOpcodeString(opcode)
<< ": Dim SubpassData requires format Unknown";
}
}
// Format and Access Qualifier are checked elsewhere.
break;
}
case SpvOpTypeSampledImage: {
const uint32_t image_type = inst->words[2];
if (_.GetIdOpcode(image_type) != SpvOpTypeImage) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< spvOpcodeString(opcode)
<< ": expected Image to be of type OpTypeImage";
}
break;
}
case SpvOpSampledImage: {
if (_.GetIdOpcode(result_type) != SpvOpTypeSampledImage) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Result Type to be OpTypeSampledImage: "
<< spvOpcodeString(opcode);
}
const uint32_t image_type = _.GetOperandTypeId(inst, 2);
if (_.GetIdOpcode(image_type) != SpvOpTypeImage) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image to be of type OpTypeImage: "
<< spvOpcodeString(opcode);
}
ImageTypeInfo info;
if (!GetImageTypeInfo(_, image_type, &info)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Corrupt image type definition";
}
// TODO(atgoo@github.com) Check compatibility of result type and received
// image.
if (spvIsVulkanEnv(_.context()->target_env)) {
if (info.sampled != 1) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image 'Sampled' parameter to be 1 for Vulkan "
"environment: "
<< spvOpcodeString(opcode);
}
} else {
if (info.sampled != 0 && info.sampled != 1) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image 'Sampled' parameter to be 0 or 1: "
<< spvOpcodeString(opcode);
}
}
if (info.dim == SpvDimSubpassData) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image 'Dim' parameter to be not SubpassData: "
<< spvOpcodeString(opcode);
}
if (_.GetIdOpcode(_.GetOperandTypeId(inst, 3)) != SpvOpTypeSampler) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Sampler to be of type OpTypeSampler: "
<< spvOpcodeString(opcode);
}
break;
}
case SpvOpImageSampleImplicitLod:
case SpvOpImageSampleExplicitLod:
case SpvOpImageSampleProjImplicitLod:
case SpvOpImageSampleProjExplicitLod:
case SpvOpImageSparseSampleImplicitLod:
case SpvOpImageSparseSampleExplicitLod: {
uint32_t actual_result_type = 0;
if (spv_result_t error =
GetActualResultType(_, *inst, &actual_result_type)) {
return error;
}
if (!_.IsIntVectorType(actual_result_type) &&
!_.IsFloatVectorType(actual_result_type)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected " << GetActualResultTypeStr(opcode)
<< " to be int or float vector type: "
<< spvOpcodeString(opcode);
}
if (_.GetDimension(actual_result_type) != 4) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected " << GetActualResultTypeStr(opcode)
<< " to have 4 components: " << spvOpcodeString(opcode);
}
const uint32_t image_type = _.GetOperandTypeId(inst, 2);
if (_.GetIdOpcode(image_type) != SpvOpTypeSampledImage) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Sampled Image to be of type OpTypeSampledImage: "
<< spvOpcodeString(opcode);
}
ImageTypeInfo info;
if (!GetImageTypeInfo(_, image_type, &info)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Corrupt image type definition";
}
if (spv_result_t result = ValidateImageCommon(_, *inst, info))
return result;
if (_.GetIdOpcode(info.sampled_type) != SpvOpTypeVoid) {
const uint32_t texel_component_type =
_.GetComponentType(actual_result_type);
if (texel_component_type != info.sampled_type) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image 'Sampled Type' to be the same as "
<< GetActualResultTypeStr(opcode)
<< " components: " << spvOpcodeString(opcode);
}
}
const uint32_t coord_type = _.GetOperandTypeId(inst, 3);
if ((opcode == SpvOpImageSampleExplicitLod ||
opcode == SpvOpImageSparseSampleExplicitLod) &&
_.HasCapability(SpvCapabilityKernel)) {
if (!_.IsFloatScalarOrVectorType(coord_type) &&
!_.IsIntScalarOrVectorType(coord_type)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Coordinate to be int or float scalar or vector: "
<< spvOpcodeString(opcode);
}
} else {
if (!_.IsFloatScalarOrVectorType(coord_type)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Coordinate to be float scalar or vector: "
<< spvOpcodeString(opcode);
}
}
const uint32_t min_coord_size = GetMinCoordSize(opcode, info);
const uint32_t actual_coord_size = _.GetDimension(coord_type);
if (min_coord_size > actual_coord_size) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Coordinate to have at least " << min_coord_size
<< " components, but given only " << actual_coord_size << ": "
<< spvOpcodeString(opcode);
}
if (inst->num_words <= 5) {
assert(IsImplicitLod(opcode));
break;
}
const uint32_t mask = inst->words[5];
if (spv_result_t result =
ValidateImageOperands(_, *inst, info, mask, /* word_index = */ 6))
return result;
break;
}
case SpvOpImageSampleDrefImplicitLod:
case SpvOpImageSampleDrefExplicitLod:
case SpvOpImageSampleProjDrefImplicitLod:
case SpvOpImageSampleProjDrefExplicitLod:
case SpvOpImageSparseSampleDrefImplicitLod:
case SpvOpImageSparseSampleDrefExplicitLod: {
uint32_t actual_result_type = 0;
if (spv_result_t error =
GetActualResultType(_, *inst, &actual_result_type)) {
return error;
}
if (!_.IsIntScalarType(actual_result_type) &&
!_.IsFloatScalarType(actual_result_type)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected " << GetActualResultTypeStr(opcode)
<< " to be int or float scalar type: "
<< spvOpcodeString(opcode);
}
const uint32_t image_type = _.GetOperandTypeId(inst, 2);
if (_.GetIdOpcode(image_type) != SpvOpTypeSampledImage) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Sampled Image to be of type OpTypeSampledImage: "
<< spvOpcodeString(opcode);
}
ImageTypeInfo info;
if (!GetImageTypeInfo(_, image_type, &info)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Corrupt image type definition";
}
if (spv_result_t result = ValidateImageCommon(_, *inst, info))
return result;
if (actual_result_type != info.sampled_type) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image 'Sampled Type' to be the same as "
<< GetActualResultTypeStr(opcode) << ": "
<< spvOpcodeString(opcode);
}
const uint32_t coord_type = _.GetOperandTypeId(inst, 3);
if (!_.IsFloatScalarOrVectorType(coord_type)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Coordinate to be float scalar or vector: "
<< spvOpcodeString(opcode);
}
const uint32_t min_coord_size = GetMinCoordSize(opcode, info);
const uint32_t actual_coord_size = _.GetDimension(coord_type);
if (min_coord_size > actual_coord_size) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Coordinate to have at least " << min_coord_size
<< " components, but given only " << actual_coord_size << ": "
<< spvOpcodeString(opcode);
}
const uint32_t dref_type = _.GetOperandTypeId(inst, 4);
if (!_.IsFloatScalarType(dref_type) || _.GetBitWidth(dref_type) != 32) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< spvOpcodeString(opcode)
<< ": Expected Dref to be of 32-bit float type";
}
if (inst->num_words <= 6) {
assert(IsImplicitLod(opcode));
break;
}
const uint32_t mask = inst->words[6];
if (spv_result_t result =
ValidateImageOperands(_, *inst, info, mask, /* word_index = */ 7))
return result;
break;
}
case SpvOpImageFetch:
case SpvOpImageSparseFetch: {
uint32_t actual_result_type = 0;
if (spv_result_t error =
GetActualResultType(_, *inst, &actual_result_type)) {
return error;
}
if (!_.IsIntVectorType(actual_result_type) &&
!_.IsFloatVectorType(actual_result_type)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected " << GetActualResultTypeStr(opcode)
<< " to be int or float vector type: "
<< spvOpcodeString(opcode);
}
if (_.GetDimension(actual_result_type) != 4) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected " << GetActualResultTypeStr(opcode)
<< " to have 4 components: " << spvOpcodeString(opcode);
}
const uint32_t image_type = _.GetOperandTypeId(inst, 2);
if (_.GetIdOpcode(image_type) != SpvOpTypeImage) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image to be of type OpTypeImage: "
<< spvOpcodeString(opcode);
}
ImageTypeInfo info;
if (!GetImageTypeInfo(_, image_type, &info)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Corrupt image type definition";
}
if (_.GetIdOpcode(info.sampled_type) != SpvOpTypeVoid) {
const uint32_t result_component_type =
_.GetComponentType(actual_result_type);
if (result_component_type != info.sampled_type) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image 'Sampled Type' to be the same as "
<< GetActualResultTypeStr(opcode)
<< " components: " << spvOpcodeString(opcode);
}
}
if (info.dim == SpvDimCube) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image 'Dim' cannot be Cube: " << spvOpcodeString(opcode);
}
if (info.sampled != 1) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image 'Sampled' parameter to be 1: "
<< spvOpcodeString(opcode);
}
const uint32_t coord_type = _.GetOperandTypeId(inst, 3);
if (!_.IsIntScalarOrVectorType(coord_type)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Coordinate to be int scalar or vector: "
<< spvOpcodeString(opcode);
}
const uint32_t min_coord_size = GetMinCoordSize(opcode, info);
const uint32_t actual_coord_size = _.GetDimension(coord_type);
if (min_coord_size > actual_coord_size) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Coordinate to have at least " << min_coord_size
<< " components, but given only " << actual_coord_size << ": "
<< spvOpcodeString(opcode);
}
if (inst->num_words <= 5) break;
const uint32_t mask = inst->words[5];
if (spv_result_t result =
ValidateImageOperands(_, *inst, info, mask, /* word_index = */ 6))
return result;
break;
}
case SpvOpImageGather:
case SpvOpImageDrefGather:
case SpvOpImageSparseGather:
case SpvOpImageSparseDrefGather: {
uint32_t actual_result_type = 0;
if (spv_result_t error =
GetActualResultType(_, *inst, &actual_result_type)) {
return error;
}
if (!_.IsIntVectorType(actual_result_type) &&
!_.IsFloatVectorType(actual_result_type)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected " << GetActualResultTypeStr(opcode)
<< " to be int or float vector type: "
<< spvOpcodeString(opcode);
}
if (_.GetDimension(actual_result_type) != 4) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected " << GetActualResultTypeStr(opcode)
<< " to have 4 components: " << spvOpcodeString(opcode);
}
const uint32_t image_type = _.GetOperandTypeId(inst, 2);
if (_.GetIdOpcode(image_type) != SpvOpTypeSampledImage) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Sampled Image to be of type OpTypeSampledImage: "
<< spvOpcodeString(opcode);
}
ImageTypeInfo info;
if (!GetImageTypeInfo(_, image_type, &info)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Corrupt image type definition";
}
if (opcode == SpvOpImageDrefGather ||
opcode == SpvOpImageSparseDrefGather ||
_.GetIdOpcode(info.sampled_type) != SpvOpTypeVoid) {
const uint32_t result_component_type =
_.GetComponentType(actual_result_type);
if (result_component_type != info.sampled_type) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image 'Sampled Type' to be the same as "
<< GetActualResultTypeStr(opcode)
<< " components: " << spvOpcodeString(opcode);
}
}
if (info.dim != SpvDim2D && info.dim != SpvDimCube &&
info.dim != SpvDimRect) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image 'Dim' cannot be Cube: "
<< spvOpcodeString(opcode);
}
const uint32_t coord_type = _.GetOperandTypeId(inst, 3);
if (!_.IsFloatScalarOrVectorType(coord_type)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Coordinate to be float scalar or vector: "
<< spvOpcodeString(opcode);
}
const uint32_t min_coord_size = GetMinCoordSize(opcode, info);
const uint32_t actual_coord_size = _.GetDimension(coord_type);
if (min_coord_size > actual_coord_size) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Coordinate to have at least " << min_coord_size
<< " components, but given only " << actual_coord_size << ": "
<< spvOpcodeString(opcode);
}
if (opcode == SpvOpImageGather || opcode == SpvOpImageSparseGather) {
const uint32_t component_index_type = _.GetOperandTypeId(inst, 4);
if (!_.IsIntScalarType(component_index_type) ||
_.GetBitWidth(component_index_type) != 32) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Component to be 32-bit int scalar: "
<< spvOpcodeString(opcode);
}
} else {
assert(opcode == SpvOpImageDrefGather ||
opcode == SpvOpImageSparseDrefGather);
const uint32_t dref_type = _.GetOperandTypeId(inst, 4);
if (!_.IsFloatScalarType(dref_type) || _.GetBitWidth(dref_type) != 32) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< spvOpcodeString(opcode)
<< ": Expected Dref to be of 32-bit float type";
}
}
if (inst->num_words <= 6) break;
const uint32_t mask = inst->words[6];
if (spv_result_t result =
ValidateImageOperands(_, *inst, info, mask, /* word_index = */ 7))
return result;
break;
}
case SpvOpImageRead:
case SpvOpImageSparseRead: {
uint32_t actual_result_type = 0;
if (spv_result_t error =
GetActualResultType(_, *inst, &actual_result_type)) {
return error;
}
if (!_.IsIntScalarOrVectorType(actual_result_type) &&
!_.IsFloatScalarOrVectorType(actual_result_type)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected " << GetActualResultTypeStr(opcode)
<< " to be int or float scalar or vector type: "
<< spvOpcodeString(opcode);
}
#if 0
// TODO(atgoo@github.com) Disabled until the spec is clarified.
if (_.GetDimension(actual_result_type) != 4) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected " << GetActualResultTypeStr(opcode)
<< " to have 4 components: " << spvOpcodeString(opcode);
}
#endif
const uint32_t image_type = _.GetOperandTypeId(inst, 2);
if (_.GetIdOpcode(image_type) != SpvOpTypeImage) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image to be of type OpTypeImage: "
<< spvOpcodeString(opcode);
}
ImageTypeInfo info;
if (!GetImageTypeInfo(_, image_type, &info)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Corrupt image type definition";
}
if (info.dim == SpvDimSubpassData) {
if (opcode == SpvOpImageSparseRead) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image Dim SubpassData cannot be used with "
<< spvOpcodeString(opcode);
}
_.current_function().RegisterExecutionModelLimitation(
SpvExecutionModelFragment,
std::string("Dim SubpassData requires Fragment execution model: ") +
spvOpcodeString(opcode));
}
if (_.GetIdOpcode(info.sampled_type) != SpvOpTypeVoid) {
const uint32_t result_component_type =
_.GetComponentType(actual_result_type);
if (result_component_type != info.sampled_type) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image 'Sampled Type' to be the same as "
<< GetActualResultTypeStr(opcode)
<< " components: " << spvOpcodeString(opcode);
}
}
if (spv_result_t result = ValidateImageCommon(_, *inst, info))
return result;
const uint32_t coord_type = _.GetOperandTypeId(inst, 3);
if (!_.IsIntScalarOrVectorType(coord_type)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Coordinate to be int scalar or vector: "
<< spvOpcodeString(opcode);
}
const uint32_t min_coord_size = GetMinCoordSize(opcode, info);
const uint32_t actual_coord_size = _.GetDimension(coord_type);
if (min_coord_size > actual_coord_size) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Coordinate to have at least " << min_coord_size
<< " components, but given only " << actual_coord_size << ": "
<< spvOpcodeString(opcode);
}
if (info.format == SpvImageFormatUnknown &&
info.dim != SpvDimSubpassData &&
!_.HasCapability(SpvCapabilityStorageImageReadWithoutFormat)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Capability StorageImageReadWithoutFormat is required to "
<< "read storage image: " << spvOpcodeString(opcode);
}
if (inst->num_words <= 5) break;
const uint32_t mask = inst->words[5];
if (spv_result_t result =
ValidateImageOperands(_, *inst, info, mask, /* word_index = */ 6))
return result;
break;
}
case SpvOpImageWrite: {
const uint32_t image_type = _.GetOperandTypeId(inst, 0);
if (_.GetIdOpcode(image_type) != SpvOpTypeImage) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image to be of type OpTypeImage: "
<< spvOpcodeString(opcode);
}
ImageTypeInfo info;
if (!GetImageTypeInfo(_, image_type, &info)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Corrupt image type definition";
}
if (info.dim == SpvDimSubpassData) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image 'Dim' cannot be SubpassData: "
<< spvOpcodeString(opcode);
}
if (spv_result_t result = ValidateImageCommon(_, *inst, info))
return result;
const uint32_t coord_type = _.GetOperandTypeId(inst, 1);
if (!_.IsIntScalarOrVectorType(coord_type)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Coordinate to be int scalar or vector: "
<< spvOpcodeString(opcode);
}
const uint32_t min_coord_size = GetMinCoordSize(opcode, info);
const uint32_t actual_coord_size = _.GetDimension(coord_type);
if (min_coord_size > actual_coord_size) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Coordinate to have at least " << min_coord_size
<< " components, but given only " << actual_coord_size << ": "
<< spvOpcodeString(opcode);
}
// TODO(atgoo@github.com) The spec doesn't explicitely say what the type
// of texel should be.
const uint32_t texel_type = _.GetOperandTypeId(inst, 2);
if (!_.IsIntScalarOrVectorType(texel_type) &&
!_.IsFloatScalarOrVectorType(texel_type)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Texel to be int or float vector or scalar: "
<< spvOpcodeString(opcode);
}
#if 0
// TODO: See above.
if (_.GetDimension(texel_type) != 4) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Texel to have 4 components: "
<< spvOpcodeString(opcode);
}
#endif
if (_.GetIdOpcode(info.sampled_type) != SpvOpTypeVoid) {
const uint32_t texel_component_type = _.GetComponentType(texel_type);
if (texel_component_type != info.sampled_type) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image 'Sampled Type' to be the same as Texel "
<< "components: " << spvOpcodeString(opcode);
}
}
if (info.format == SpvImageFormatUnknown &&
info.dim != SpvDimSubpassData &&
!_.HasCapability(SpvCapabilityStorageImageWriteWithoutFormat)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Capability StorageImageWriteWithoutFormat is required to "
"write "
<< "to storage image: " << spvOpcodeString(opcode);
}
if (inst->num_words <= 4) break;
const uint32_t mask = inst->words[4];
if (spv_result_t result =
ValidateImageOperands(_, *inst, info, mask, /* word_index = */ 5))
return result;
break;
}
case SpvOpImage: {
if (_.GetIdOpcode(result_type) != SpvOpTypeImage) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Result Type to be OpTypeImage: "
<< spvOpcodeString(opcode);
}
const uint32_t sampled_image_type = _.GetOperandTypeId(inst, 2);
const Instruction* sampled_image_type_inst =
_.FindDef(sampled_image_type);
assert(sampled_image_type_inst);
if (sampled_image_type_inst->opcode() != SpvOpTypeSampledImage) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Sample Image to be of type OpTypeSampleImage: "
<< spvOpcodeString(opcode);
}
if (sampled_image_type_inst->word(2) != result_type) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Sample Image image type to be equal to Result "
"Type: "
<< spvOpcodeString(opcode);
}
break;
}
case SpvOpImageQueryFormat:
case SpvOpImageQueryOrder: {
if (!_.IsIntScalarType(result_type)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Result Type to be int scalar type: "
<< spvOpcodeString(opcode);
}
if (_.GetIdOpcode(_.GetOperandTypeId(inst, 2)) != SpvOpTypeImage) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected operand to be of type OpTypeImage: "
<< spvOpcodeString(opcode);
}
break;
}
case SpvOpImageQuerySizeLod: {
if (!_.IsIntScalarOrVectorType(result_type)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Result Type to be int scalar or vector type: "
<< spvOpcodeString(opcode);
}
const uint32_t image_type = _.GetOperandTypeId(inst, 2);
if (_.GetIdOpcode(image_type) != SpvOpTypeImage) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image to be of type OpTypeImage: "
<< spvOpcodeString(opcode);
}
ImageTypeInfo info;
if (!GetImageTypeInfo(_, image_type, &info)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Corrupt image type definition";
}
uint32_t expected_num_components = info.arrayed;
switch (info.dim) {
case SpvDim1D:
expected_num_components += 1;
break;
case SpvDim2D:
case SpvDimCube:
expected_num_components += 2;
break;
case SpvDim3D:
expected_num_components += 3;
break;
default:
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image 'Dim' must be 1D, 2D, 3D or Cube: "
<< spvOpcodeString(opcode);
};
if (info.multisampled != 0) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image 'MS' must be 0: " << spvOpcodeString(opcode);
}
uint32_t result_num_components = _.GetDimension(result_type);
if (result_num_components != expected_num_components) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Result Type has " << result_num_components << " components, "
<< "but " << expected_num_components
<< " expected: " << spvOpcodeString(opcode);
}
const uint32_t lod_type = _.GetOperandTypeId(inst, 3);
if (!_.IsIntScalarType(lod_type)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Level of Detail to be int scalar: "
<< spvOpcodeString(opcode);
}
break;
}
case SpvOpImageQuerySize: {
if (!_.IsIntScalarOrVectorType(result_type)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Result Type to be int scalar or vector type: "
<< spvOpcodeString(opcode);
}
const uint32_t image_type = _.GetOperandTypeId(inst, 2);
if (_.GetIdOpcode(image_type) != SpvOpTypeImage) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image to be of type OpTypeImage: "
<< spvOpcodeString(opcode);
}
#if 0
// TODO(atgoo@github.com) The spec doesn't whitelist all Dims supported by
// GLSL. Need to verify if there is an error and reenable.
ImageTypeInfo info;
if (!GetImageTypeInfo(_, image_type, &info)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Corrupt image type definition";
}
uint32_t expected_num_components = info.arrayed;
switch (info.dim) {
case SpvDimBuffer:
expected_num_components += 1;
break;
case SpvDim2D:
if (info.multisampled != 1 && info.sampled != 0 &&
info.sampled != 2) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected either 'MS'=1 or 'Sampled'=0 or 'Sampled'=2 "
<< "for 2D dim: " << spvOpcodeString(opcode);
}
case SpvDimRect:
expected_num_components += 2;
break;
case SpvDim3D:
expected_num_components += 3;
if (info.sampled != 0 &&
info.sampled != 2) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected either 'Sampled'=0 or 'Sampled'=2 "
<< "for 3D dim: " << spvOpcodeString(opcode);
}
break;
default:
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image 'Dim' must be Buffer, 2D, 3D or Rect: "
<< spvOpcodeString(opcode);
};
if (info.multisampled != 0) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image 'MS' must be 0: " << spvOpcodeString(opcode);
}
uint32_t result_num_components = _.GetDimension(result_type);
if (result_num_components != expected_num_components) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Result Type has " << result_num_components << " components, "
<< "but " << expected_num_components << " expected: "
<< spvOpcodeString(opcode);
}
#endif
break;
}
case SpvOpImageQueryLod: {
_.current_function().RegisterExecutionModelLimitation(
SpvExecutionModelFragment,
"OpImageQueryLod requires Fragment execution model");
if (!_.IsFloatVectorType(result_type)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Result Type to be float vector type: "
<< spvOpcodeString(opcode);
}
if (_.GetDimension(result_type) != 2) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Result Type to have 2 components: "
<< spvOpcodeString(opcode);
}
const uint32_t image_type = _.GetOperandTypeId(inst, 2);
if (_.GetIdOpcode(image_type) != SpvOpTypeSampledImage) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image operand to be of type OpTypeSampledImage: "
<< spvOpcodeString(opcode);
}
ImageTypeInfo info;
if (!GetImageTypeInfo(_, image_type, &info)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Corrupt image type definition";
}
if (info.dim != SpvDim1D && info.dim != SpvDim2D &&
info.dim != SpvDim3D && info.dim != SpvDimCube) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image 'Dim' must be 1D, 2D, 3D or Cube: "
<< spvOpcodeString(opcode);
}
const uint32_t coord_type = _.GetOperandTypeId(inst, 3);
if (_.HasCapability(SpvCapabilityKernel)) {
if (!_.IsFloatScalarOrVectorType(coord_type) &&
!_.IsIntScalarOrVectorType(coord_type)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Coordinate to be int or float scalar or vector: "
<< spvOpcodeString(opcode);
}
} else {
if (!_.IsFloatScalarOrVectorType(coord_type)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Coordinate to be float scalar or vector: "
<< spvOpcodeString(opcode);
}
}
const uint32_t min_coord_size = GetPlaneCoordSize(info);
const uint32_t actual_coord_size = _.GetDimension(coord_type);
if (min_coord_size > actual_coord_size) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Coordinate to have at least " << min_coord_size
<< " components, but given only " << actual_coord_size << ": "
<< spvOpcodeString(opcode);
}
break;
}
case SpvOpImageQueryLevels:
case SpvOpImageQuerySamples: {
if (!_.IsIntScalarType(result_type)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Result Type to be int scalar type: "
<< spvOpcodeString(opcode);
}
const uint32_t image_type = _.GetOperandTypeId(inst, 2);
if (_.GetIdOpcode(image_type) != SpvOpTypeImage) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Expected Image to be of type OpTypeImage: "
<< spvOpcodeString(opcode);
}
ImageTypeInfo info;
if (!GetImageTypeInfo(_, image_type, &info)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Corrupt image type definition";
}
if (opcode == SpvOpImageQueryLevels) {
if (info.dim != SpvDim1D && info.dim != SpvDim2D &&
info.dim != SpvDim3D && info.dim != SpvDimCube) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image 'Dim' must be 1D, 2D, 3D or Cube: "
<< spvOpcodeString(opcode);
}
} else {
assert(opcode == SpvOpImageQuerySamples);
if (info.dim != SpvDim2D) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image 'Dim' must be 2D: " << spvOpcodeString(opcode);
}
if (info.multisampled != 1) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< "Image 'MS' must be 1: " << spvOpcodeString(opcode);
}
}
break;
}
case SpvOpImageSparseSampleProjImplicitLod:
case SpvOpImageSparseSampleProjExplicitLod:
case SpvOpImageSparseSampleProjDrefImplicitLod:
case SpvOpImageSparseSampleProjDrefExplicitLod: {
return _.diag(SPV_ERROR_INVALID_DATA)
<< spvOpcodeString(opcode)
<< ": instruction reserved for future use, "
<< "use of this instruction is invalid";
}
case SpvOpImageSparseTexelsResident: {
if (!_.IsBoolScalarType(result_type)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< spvOpcodeString(opcode)
<< ": expected Result Type to be bool scalar type";
}
const uint32_t resident_code_type = _.GetOperandTypeId(inst, 2);
if (!_.IsIntScalarType(resident_code_type)) {
return _.diag(SPV_ERROR_INVALID_DATA)
<< spvOpcodeString(opcode)
<< ": expected Resident Code to be int scalar";
}
break;
}
default:
break;
}
return SPV_SUCCESS;
}
} // namespace libspirv
Reference in New Issue View Git Blame Copy Permalink