| // 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 composite SPIR-V instructions. |
| |
| #include "source/val/validate.h" |
| |
| #include "source/diagnostic.h" |
| #include "source/opcode.h" |
| #include "source/spirv_target_env.h" |
| #include "source/val/instruction.h" |
| #include "source/val/validation_state.h" |
| |
| namespace spvtools { |
| namespace val { |
| namespace { |
| |
| // Returns the type of the value accessed by OpCompositeExtract or |
| // OpCompositeInsert instruction. The function traverses the hierarchy of |
| // nested data structures (structs, arrays, vectors, matrices) as directed by |
| // the sequence of indices in the instruction. May return error if traversal |
| // fails (encountered non-composite, out of bounds, nesting too deep). |
| // Returns the type of Composite operand if the instruction has no indices. |
| spv_result_t GetExtractInsertValueType(ValidationState_t& _, |
| const Instruction* inst, |
| uint32_t* member_type) { |
| const SpvOp opcode = inst->opcode(); |
| assert(opcode == SpvOpCompositeExtract || opcode == SpvOpCompositeInsert); |
| uint32_t word_index = opcode == SpvOpCompositeExtract ? 4 : 5; |
| const uint32_t num_words = static_cast<uint32_t>(inst->words().size()); |
| const uint32_t composite_id_index = word_index - 1; |
| |
| const uint32_t num_indices = num_words - word_index; |
| const uint32_t kCompositeExtractInsertMaxNumIndices = 255; |
| if (num_indices > kCompositeExtractInsertMaxNumIndices) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "The number of indexes in Op" << spvOpcodeString(opcode) |
| << " may not exceed " << kCompositeExtractInsertMaxNumIndices |
| << ". Found " << num_indices << " indexes."; |
| } |
| |
| *member_type = _.GetTypeId(inst->word(composite_id_index)); |
| if (*member_type == 0) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Expected Composite to be an object of composite type"; |
| } |
| |
| for (; word_index < num_words; ++word_index) { |
| const uint32_t component_index = inst->word(word_index); |
| const Instruction* const type_inst = _.FindDef(*member_type); |
| assert(type_inst); |
| switch (type_inst->opcode()) { |
| case SpvOpTypeVector: { |
| *member_type = type_inst->word(2); |
| const uint32_t vector_size = type_inst->word(3); |
| if (component_index >= vector_size) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Vector access is out of bounds, vector size is " |
| << vector_size << ", but access index is " << component_index; |
| } |
| break; |
| } |
| case SpvOpTypeMatrix: { |
| *member_type = type_inst->word(2); |
| const uint32_t num_cols = type_inst->word(3); |
| if (component_index >= num_cols) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Matrix access is out of bounds, matrix has " << num_cols |
| << " columns, but access index is " << component_index; |
| } |
| break; |
| } |
| case SpvOpTypeArray: { |
| uint64_t array_size = 0; |
| auto size = _.FindDef(type_inst->word(3)); |
| *member_type = type_inst->word(2); |
| if (spvOpcodeIsSpecConstant(size->opcode())) { |
| // Cannot verify against the size of this array. |
| break; |
| } |
| |
| if (!_.GetConstantValUint64(type_inst->word(3), &array_size)) { |
| assert(0 && "Array type definition is corrupt"); |
| } |
| if (component_index >= array_size) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Array access is out of bounds, array size is " |
| << array_size << ", but access index is " << component_index; |
| } |
| break; |
| } |
| case SpvOpTypeRuntimeArray: { |
| *member_type = type_inst->word(2); |
| // Array size is unknown. |
| break; |
| } |
| case SpvOpTypeStruct: { |
| const size_t num_struct_members = type_inst->words().size() - 2; |
| if (component_index >= num_struct_members) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Index is out of bounds, can not find index " |
| << component_index << " in the structure <id> '" |
| << type_inst->id() << "'. This structure has " |
| << num_struct_members << " members. Largest valid index is " |
| << num_struct_members - 1 << "."; |
| } |
| *member_type = type_inst->word(component_index + 2); |
| break; |
| } |
| default: |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Reached non-composite type while indexes still remain to " |
| "be traversed."; |
| } |
| } |
| |
| return SPV_SUCCESS; |
| } |
| |
| spv_result_t ValidateVectorExtractDynamic(ValidationState_t& _, |
| const Instruction* inst) { |
| const uint32_t result_type = inst->type_id(); |
| const SpvOp result_opcode = _.GetIdOpcode(result_type); |
| if (!spvOpcodeIsScalarType(result_opcode)) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Expected Result Type to be a scalar type"; |
| } |
| |
| const uint32_t vector_type = _.GetOperandTypeId(inst, 2); |
| const SpvOp vector_opcode = _.GetIdOpcode(vector_type); |
| if (vector_opcode != SpvOpTypeVector) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Expected Vector type to be OpTypeVector"; |
| } |
| |
| if (_.GetComponentType(vector_type) != result_type) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Expected Vector component type to be equal to Result Type"; |
| } |
| |
| const auto index = _.FindDef(inst->GetOperandAs<uint32_t>(3)); |
| if (!index || index->type_id() == 0 || !_.IsIntScalarType(index->type_id())) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Expected Index to be int scalar"; |
| } |
| return SPV_SUCCESS; |
| } |
| |
| spv_result_t ValidateVectorInsertDyanmic(ValidationState_t& _, |
| const Instruction* inst) { |
| const uint32_t result_type = inst->type_id(); |
| const SpvOp result_opcode = _.GetIdOpcode(result_type); |
| if (result_opcode != SpvOpTypeVector) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Expected Result Type to be OpTypeVector"; |
| } |
| |
| const uint32_t vector_type = _.GetOperandTypeId(inst, 2); |
| if (vector_type != result_type) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Expected Vector type to be equal to Result Type"; |
| } |
| |
| const uint32_t component_type = _.GetOperandTypeId(inst, 3); |
| if (_.GetComponentType(result_type) != component_type) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Expected Component type to be equal to Result Type " |
| << "component type"; |
| } |
| |
| const uint32_t index_type = _.GetOperandTypeId(inst, 4); |
| if (!_.IsIntScalarType(index_type)) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Expected Index to be int scalar"; |
| } |
| return SPV_SUCCESS; |
| } |
| |
| spv_result_t ValidateCompositeConstruct(ValidationState_t& _, |
| const Instruction* inst) { |
| const uint32_t num_operands = static_cast<uint32_t>(inst->operands().size()); |
| const uint32_t result_type = inst->type_id(); |
| const SpvOp result_opcode = _.GetIdOpcode(result_type); |
| switch (result_opcode) { |
| case SpvOpTypeVector: { |
| const uint32_t num_result_components = _.GetDimension(result_type); |
| const uint32_t result_component_type = _.GetComponentType(result_type); |
| uint32_t given_component_count = 0; |
| |
| if (num_operands <= 3) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Expected number of constituents to be at least 2"; |
| } |
| |
| for (uint32_t operand_index = 2; operand_index < num_operands; |
| ++operand_index) { |
| const uint32_t operand_type = _.GetOperandTypeId(inst, operand_index); |
| if (operand_type == result_component_type) { |
| ++given_component_count; |
| } else { |
| if (_.GetIdOpcode(operand_type) != SpvOpTypeVector || |
| _.GetComponentType(operand_type) != result_component_type) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Expected Constituents to be scalars or vectors of" |
| << " the same type as Result Type components"; |
| } |
| |
| given_component_count += _.GetDimension(operand_type); |
| } |
| } |
| |
| if (num_result_components != given_component_count) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Expected total number of given components to be equal " |
| << "to the size of Result Type vector"; |
| } |
| |
| break; |
| } |
| case SpvOpTypeMatrix: { |
| uint32_t result_num_rows = 0; |
| uint32_t result_num_cols = 0; |
| uint32_t result_col_type = 0; |
| uint32_t result_component_type = 0; |
| if (!_.GetMatrixTypeInfo(result_type, &result_num_rows, &result_num_cols, |
| &result_col_type, &result_component_type)) { |
| assert(0); |
| } |
| |
| if (result_num_cols + 2 != num_operands) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Expected total number of Constituents to be equal " |
| << "to the number of columns of Result Type matrix"; |
| } |
| |
| for (uint32_t operand_index = 2; operand_index < num_operands; |
| ++operand_index) { |
| const uint32_t operand_type = _.GetOperandTypeId(inst, operand_index); |
| if (operand_type != result_col_type) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Expected Constituent type to be equal to the column " |
| << "type Result Type matrix"; |
| } |
| } |
| |
| break; |
| } |
| case SpvOpTypeArray: { |
| const Instruction* const array_inst = _.FindDef(result_type); |
| assert(array_inst); |
| assert(array_inst->opcode() == SpvOpTypeArray); |
| |
| auto size = _.FindDef(array_inst->word(3)); |
| if (spvOpcodeIsSpecConstant(size->opcode())) { |
| // Cannot verify against the size of this array. |
| break; |
| } |
| |
| uint64_t array_size = 0; |
| if (!_.GetConstantValUint64(array_inst->word(3), &array_size)) { |
| assert(0 && "Array type definition is corrupt"); |
| } |
| |
| if (array_size + 2 != num_operands) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Expected total number of Constituents to be equal " |
| << "to the number of elements of Result Type array"; |
| } |
| |
| const uint32_t result_component_type = array_inst->word(2); |
| for (uint32_t operand_index = 2; operand_index < num_operands; |
| ++operand_index) { |
| const uint32_t operand_type = _.GetOperandTypeId(inst, operand_index); |
| if (operand_type != result_component_type) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Expected Constituent type to be equal to the column " |
| << "type Result Type array"; |
| } |
| } |
| |
| break; |
| } |
| case SpvOpTypeStruct: { |
| const Instruction* const struct_inst = _.FindDef(result_type); |
| assert(struct_inst); |
| assert(struct_inst->opcode() == SpvOpTypeStruct); |
| |
| if (struct_inst->operands().size() + 1 != num_operands) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Expected total number of Constituents to be equal " |
| << "to the number of members of Result Type struct"; |
| } |
| |
| for (uint32_t operand_index = 2; operand_index < num_operands; |
| ++operand_index) { |
| const uint32_t operand_type = _.GetOperandTypeId(inst, operand_index); |
| const uint32_t member_type = struct_inst->word(operand_index); |
| if (operand_type != member_type) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Expected Constituent type to be equal to the " |
| << "corresponding member type of Result Type struct"; |
| } |
| } |
| |
| break; |
| } |
| default: { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Expected Result Type to be a composite type"; |
| } |
| } |
| return SPV_SUCCESS; |
| } |
| |
| spv_result_t ValidateCompositeExtract(ValidationState_t& _, |
| const Instruction* inst) { |
| uint32_t member_type = 0; |
| if (spv_result_t error = GetExtractInsertValueType(_, inst, &member_type)) { |
| return error; |
| } |
| |
| const uint32_t result_type = inst->type_id(); |
| if (result_type != member_type) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Result type (Op" << spvOpcodeString(_.GetIdOpcode(result_type)) |
| << ") does not match the type that results from indexing into " |
| "the composite (Op" |
| << spvOpcodeString(_.GetIdOpcode(member_type)) << ")."; |
| } |
| return SPV_SUCCESS; |
| } |
| |
| spv_result_t ValidateCompositeInsert(ValidationState_t& _, |
| const Instruction* inst) { |
| const SpvOp opcode = inst->opcode(); |
| const uint32_t object_type = _.GetOperandTypeId(inst, 2); |
| const uint32_t composite_type = _.GetOperandTypeId(inst, 3); |
| const uint32_t result_type = inst->type_id(); |
| if (result_type != composite_type) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "The Result Type must be the same as Composite type in Op" |
| << spvOpcodeString(opcode) << " yielding Result Id " << result_type |
| << "."; |
| } |
| |
| uint32_t member_type = 0; |
| if (spv_result_t error = GetExtractInsertValueType(_, inst, &member_type)) { |
| return error; |
| } |
| |
| if (object_type != member_type) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "The Object type (Op" |
| << spvOpcodeString(_.GetIdOpcode(object_type)) |
| << ") does not match the type that results from indexing into the " |
| "Composite (Op" |
| << spvOpcodeString(_.GetIdOpcode(member_type)) << ")."; |
| } |
| return SPV_SUCCESS; |
| } |
| |
| spv_result_t ValidateCopyObject(ValidationState_t& _, const Instruction* inst) { |
| const uint32_t result_type = inst->type_id(); |
| const uint32_t operand_type = _.GetOperandTypeId(inst, 2); |
| if (operand_type != result_type) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Expected Result Type and Operand type to be the same"; |
| } |
| return SPV_SUCCESS; |
| } |
| |
| spv_result_t ValidateTranspose(ValidationState_t& _, const Instruction* inst) { |
| uint32_t result_num_rows = 0; |
| uint32_t result_num_cols = 0; |
| uint32_t result_col_type = 0; |
| uint32_t result_component_type = 0; |
| const uint32_t result_type = inst->type_id(); |
| if (!_.GetMatrixTypeInfo(result_type, &result_num_rows, &result_num_cols, |
| &result_col_type, &result_component_type)) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Expected Result Type to be a matrix type"; |
| } |
| |
| const uint32_t matrix_type = _.GetOperandTypeId(inst, 2); |
| uint32_t matrix_num_rows = 0; |
| uint32_t matrix_num_cols = 0; |
| uint32_t matrix_col_type = 0; |
| uint32_t matrix_component_type = 0; |
| if (!_.GetMatrixTypeInfo(matrix_type, &matrix_num_rows, &matrix_num_cols, |
| &matrix_col_type, &matrix_component_type)) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Expected Matrix to be of type OpTypeMatrix"; |
| } |
| |
| if (result_component_type != matrix_component_type) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Expected component types of Matrix and Result Type to be " |
| << "identical"; |
| } |
| |
| if (result_num_rows != matrix_num_cols || |
| result_num_cols != matrix_num_rows) { |
| return _.diag(SPV_ERROR_INVALID_DATA, inst) |
| << "Expected number of columns and the column size of Matrix " |
| << "to be the reverse of those of Result Type"; |
| } |
| return SPV_SUCCESS; |
| } |
| |
| spv_result_t ValidateVectorShuffle(ValidationState_t& _, |
| const Instruction* inst) { |
| auto resultType = _.FindDef(inst->type_id()); |
| if (!resultType || resultType->opcode() != SpvOpTypeVector) { |
| return _.diag(SPV_ERROR_INVALID_ID, inst) |
| << "The Result Type of OpVectorShuffle must be" |
| << " OpTypeVector. Found Op" |
| << spvOpcodeString(static_cast<SpvOp>(resultType->opcode())) << "."; |
| } |
| |
| // The number of components in Result Type must be the same as the number of |
| // Component operands. |
| auto componentCount = inst->operands().size() - 4; |
| auto resultVectorDimension = resultType->GetOperandAs<uint32_t>(2); |
| if (componentCount != resultVectorDimension) { |
| return _.diag(SPV_ERROR_INVALID_ID, inst) |
| << "OpVectorShuffle component literals count does not match " |
| "Result Type <id> '" |
| << _.getIdName(resultType->id()) << "'s vector component count."; |
| } |
| |
| // Vector 1 and Vector 2 must both have vector types, with the same Component |
| // Type as Result Type. |
| auto vector1Object = _.FindDef(inst->GetOperandAs<uint32_t>(2)); |
| auto vector1Type = _.FindDef(vector1Object->type_id()); |
| auto vector2Object = _.FindDef(inst->GetOperandAs<uint32_t>(3)); |
| auto vector2Type = _.FindDef(vector2Object->type_id()); |
| if (!vector1Type || vector1Type->opcode() != SpvOpTypeVector) { |
| return _.diag(SPV_ERROR_INVALID_ID, inst) |
| << "The type of Vector 1 must be OpTypeVector."; |
| } |
| if (!vector2Type || vector2Type->opcode() != SpvOpTypeVector) { |
| return _.diag(SPV_ERROR_INVALID_ID, inst) |
| << "The type of Vector 2 must be OpTypeVector."; |
| } |
| |
| auto resultComponentType = resultType->GetOperandAs<uint32_t>(1); |
| if (vector1Type->GetOperandAs<uint32_t>(1) != resultComponentType) { |
| return _.diag(SPV_ERROR_INVALID_ID, inst) |
| << "The Component Type of Vector 1 must be the same as ResultType."; |
| } |
| if (vector2Type->GetOperandAs<uint32_t>(1) != resultComponentType) { |
| return _.diag(SPV_ERROR_INVALID_ID, inst) |
| << "The Component Type of Vector 2 must be the same as ResultType."; |
| } |
| |
| // All Component literals must either be FFFFFFFF or in [0, N - 1]. |
| // For WebGPU specifically, Component literals cannot be FFFFFFFF. |
| auto vector1ComponentCount = vector1Type->GetOperandAs<uint32_t>(2); |
| auto vector2ComponentCount = vector2Type->GetOperandAs<uint32_t>(2); |
| auto N = vector1ComponentCount + vector2ComponentCount; |
| auto firstLiteralIndex = 4; |
| const auto is_webgpu_env = spvIsWebGPUEnv(_.context()->target_env); |
| for (size_t i = firstLiteralIndex; i < inst->operands().size(); ++i) { |
| auto literal = inst->GetOperandAs<uint32_t>(i); |
| if (literal != 0xFFFFFFFF && literal >= N) { |
| return _.diag(SPV_ERROR_INVALID_ID, inst) |
| << "Component index " << literal << " is out of bounds for " |
| << "combined (Vector1 + Vector2) size of " << N << "."; |
| } |
| |
| if (is_webgpu_env && literal == 0xFFFFFFFF) { |
| return _.diag(SPV_ERROR_INVALID_ID, inst) |
| << "Component literal at operand " << i - firstLiteralIndex |
| << " cannot be 0xFFFFFFFF in WebGPU execution environment."; |
| } |
| } |
| |
| return SPV_SUCCESS; |
| } |
| |
| } // anonymous namespace |
| |
| // Validates correctness of composite instructions. |
| spv_result_t CompositesPass(ValidationState_t& _, const Instruction* inst) { |
| switch (inst->opcode()) { |
| case SpvOpVectorExtractDynamic: |
| return ValidateVectorExtractDynamic(_, inst); |
| case SpvOpVectorInsertDynamic: |
| return ValidateVectorInsertDyanmic(_, inst); |
| case SpvOpVectorShuffle: |
| return ValidateVectorShuffle(_, inst); |
| case SpvOpCompositeConstruct: |
| return ValidateCompositeConstruct(_, inst); |
| case SpvOpCompositeExtract: |
| return ValidateCompositeExtract(_, inst); |
| case SpvOpCompositeInsert: |
| return ValidateCompositeInsert(_, inst); |
| case SpvOpCopyObject: |
| return ValidateCopyObject(_, inst); |
| case SpvOpTranspose: |
| return ValidateTranspose(_, inst); |
| default: |
| break; |
| } |
| |
| return SPV_SUCCESS; |
| } |
| |
| } // namespace val |
| } // namespace spvtools |
