// Copyright (c) 2018 Google LLC. // Modifications Copyright (C) 2020 Advanced Micro Devices, Inc. All rights // reserved. // // 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 built-in variables. #include <array> #include <functional> #include <list> #include <map> #include <set> #include <sstream> #include <stack> #include <string> #include <vector> #include "source/opcode.h" #include "source/spirv_target_env.h" #include "source/util/bitutils.h" #include "source/val/instruction.h" #include "source/val/validate.h" #include "source/val/validation_state.h" namespace spvtools { namespace val { namespace { // Returns a short textual description of the id defined by the given // instruction. std::string GetIdDesc(const Instruction& inst) { … } // Gets underlying data type which is // - member type if instruction is OpTypeStruct // (member index is taken from decoration). // - data type if id creates a pointer. // - type of the constant if instruction is OpConst or OpSpecConst. // // Fails in any other case. The function is based on built-ins allowed by // the Vulkan spec. // TODO: If non-Vulkan validation rules are added then it might need // to be refactored. spv_result_t GetUnderlyingType(ValidationState_t& _, const Decoration& decoration, const Instruction& inst, uint32_t* underlying_type) { … } // Returns Storage Class used by the instruction if applicable. // Returns spv::StorageClass::Max if not. spv::StorageClass GetStorageClass(const Instruction& inst) { … } VUIDError; const static uint32_t NumVUIDBuiltins = …; BuiltinVUIDMapping; // Many built-ins have the same checks (Storage Class, Type, etc) // This table provides a nice LUT for the VUIDs std::array<BuiltinVUIDMapping, NumVUIDBuiltins> builtinVUIDInfo = …; uint32_t GetVUIDForBuiltin(spv::BuiltIn builtIn, VUIDError type) { … } bool IsExecutionModelValidForRtBuiltIn(spv::BuiltIn builtin, spv::ExecutionModel stage) { … } // Helper class managing validation of built-ins. // TODO: Generic functionality of this class can be moved into // ValidationState_t to be made available to other users. class BuiltInsValidator { … }; void BuiltInsValidator::Update(const Instruction& inst) { … } std::string BuiltInsValidator::GetDefinitionDesc( const Decoration& decoration, const Instruction& inst) const { … } std::string BuiltInsValidator::GetReferenceDesc( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst, spv::ExecutionModel execution_model) const { … } std::string BuiltInsValidator::GetStorageClassDesc( const Instruction& inst) const { … } spv_result_t BuiltInsValidator::ValidateBool( const Decoration& decoration, const Instruction& inst, const std::function<spv_result_t(const std::string& message)>& diag) { … } spv_result_t BuiltInsValidator::ValidateI( const Decoration& decoration, const Instruction& inst, const std::function<spv_result_t(const std::string& message)>& diag) { … } spv_result_t BuiltInsValidator::ValidateI32( const Decoration& decoration, const Instruction& inst, const std::function<spv_result_t(const std::string& message)>& diag) { … } spv_result_t BuiltInsValidator::ValidateOptionalArrayedI32( const Decoration& decoration, const Instruction& inst, const std::function<spv_result_t(const std::string& message)>& diag) { … } spv_result_t BuiltInsValidator::ValidateI32Helper( const Decoration& decoration, const Instruction& inst, const std::function<spv_result_t(const std::string& message)>& diag, uint32_t underlying_type) { … } spv_result_t BuiltInsValidator::ValidateOptionalArrayedF32( const Decoration& decoration, const Instruction& inst, const std::function<spv_result_t(const std::string& message)>& diag) { … } spv_result_t BuiltInsValidator::ValidateF32( const Decoration& decoration, const Instruction& inst, const std::function<spv_result_t(const std::string& message)>& diag) { … } spv_result_t BuiltInsValidator::ValidateF32Helper( const Decoration& decoration, const Instruction& inst, const std::function<spv_result_t(const std::string& message)>& diag, uint32_t underlying_type) { … } spv_result_t BuiltInsValidator::ValidateI32Vec( const Decoration& decoration, const Instruction& inst, uint32_t num_components, const std::function<spv_result_t(const std::string& message)>& diag) { … } spv_result_t BuiltInsValidator::ValidateArrayedI32Vec( const Decoration& decoration, const Instruction& inst, uint32_t num_components, const std::function<spv_result_t(const std::string& message)>& diag) { … } spv_result_t BuiltInsValidator::ValidateOptionalArrayedF32Vec( const Decoration& decoration, const Instruction& inst, uint32_t num_components, const std::function<spv_result_t(const std::string& message)>& diag) { … } spv_result_t BuiltInsValidator::ValidateF32Vec( const Decoration& decoration, const Instruction& inst, uint32_t num_components, const std::function<spv_result_t(const std::string& message)>& diag) { … } spv_result_t BuiltInsValidator::ValidateF32VecHelper( const Decoration& decoration, const Instruction& inst, uint32_t num_components, const std::function<spv_result_t(const std::string& message)>& diag, uint32_t underlying_type) { … } spv_result_t BuiltInsValidator::ValidateI32Arr( const Decoration& decoration, const Instruction& inst, const std::function<spv_result_t(const std::string& message)>& diag) { … } spv_result_t BuiltInsValidator::ValidateF32Arr( const Decoration& decoration, const Instruction& inst, uint32_t num_components, const std::function<spv_result_t(const std::string& message)>& diag) { … } spv_result_t BuiltInsValidator::ValidateOptionalArrayedF32Arr( const Decoration& decoration, const Instruction& inst, uint32_t num_components, const std::function<spv_result_t(const std::string& message)>& diag) { … } spv_result_t BuiltInsValidator::ValidateF32ArrHelper( const Decoration& decoration, const Instruction& inst, uint32_t num_components, const std::function<spv_result_t(const std::string& message)>& diag, uint32_t underlying_type) { … } spv_result_t BuiltInsValidator::ValidateF32Mat( const Decoration& decoration, const Instruction& inst, uint32_t req_num_rows, uint32_t req_num_columns, const std::function<spv_result_t(const std::string& message)>& diag) { … } spv_result_t BuiltInsValidator::ValidateNotCalledWithExecutionModel( int vuid, const char* comment, spv::ExecutionModel execution_model, const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateClipOrCullDistanceAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateClipOrCullDistanceAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateFragCoordAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateFragCoordAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateFragDepthAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateFragDepthAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateFrontFacingAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateFrontFacingAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateHelperInvocationAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateHelperInvocationAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateInvocationIdAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateInvocationIdAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateInstanceIndexAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateInstanceIndexAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidatePatchVerticesAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidatePatchVerticesAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidatePointCoordAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidatePointCoordAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidatePointSizeAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidatePointSizeAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidatePositionAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidatePositionAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidatePrimitiveIdAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidatePrimitiveIdAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateSampleIdAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateSampleIdAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateSampleMaskAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateSampleMaskAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateSamplePositionAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateSamplePositionAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateTessCoordAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateTessCoordAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateTessLevelOuterAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateTessLevelInnerAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateTessLevelAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateVertexIndexAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateVertexIdAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateLocalInvocationIndexAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateLocalInvocationIndexAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction&, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateVertexIndexAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateLayerOrViewportIndexAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateLayerOrViewportIndexAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateFragmentShaderF32Vec3InputAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateFragmentShaderF32Vec3InputAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateComputeShaderI32Vec3InputAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateComputeShaderI32Vec3InputAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateComputeI32InputAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateComputeI32InputAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateI32InputAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateI32Vec4InputAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateWorkgroupSizeAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateWorkgroupSizeAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateBaseInstanceOrVertexAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateBaseInstanceOrVertexAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateDrawIndexAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateDrawIndexAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateViewIndexAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateViewIndexAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateDeviceIndexAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateDeviceIndexAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateFragInvocationCountAtDefinition(const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateFragInvocationCountAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateFragSizeAtDefinition(const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateFragSizeAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateFragStencilRefAtDefinition(const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateFragStencilRefAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateFullyCoveredAtDefinition(const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateFullyCoveredAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateNVSMOrARMCoreBuiltinsAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateNVSMOrARMCoreBuiltinsAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidatePrimitiveShadingRateAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidatePrimitiveShadingRateAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateShadingRateAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateShadingRateAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateRayTracingBuiltinsAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateRayTracingBuiltinsAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateMeshShadingEXTBuiltinsAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateMeshShadingEXTBuiltinsAtReference( const Decoration& decoration, const Instruction& built_in_inst, const Instruction& referenced_inst, const Instruction& referenced_from_inst) { … } spv_result_t BuiltInsValidator::ValidateSingleBuiltInAtDefinition( const Decoration& decoration, const Instruction& inst) { … } spv_result_t BuiltInsValidator::ValidateBuiltInsAtDefinition() { … } spv_result_t BuiltInsValidator::Run() { … } } // namespace // Validates correctness of built-in variables. spv_result_t ValidateBuiltIns(ValidationState_t& _) { … } } // namespace val } // namespace spvtools
Codebase Browser
chromium