mirror of
https://github.com/KhronosGroup/SPIRV-Tools
synced 2024-11-23 12:10:06 +00:00
220 lines
8.8 KiB
C++
220 lines
8.8 KiB
C++
// Copyright (c) 2015-2016 The Khronos Group Inc.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
#ifndef LIBSPIRV_VALIDATE_H_
|
|
#define LIBSPIRV_VALIDATE_H_
|
|
|
|
#include <functional>
|
|
#include <utility>
|
|
#include <vector>
|
|
|
|
#include "instruction.h"
|
|
#include "message.h"
|
|
#include "spirv-tools/libspirv.h"
|
|
#include "table.h"
|
|
|
|
namespace libspirv {
|
|
|
|
class ValidationState_t;
|
|
class BasicBlock;
|
|
|
|
/// A function that returns a vector of BasicBlocks given a BasicBlock. Used to
|
|
/// get the successor and predecessor nodes of a CFG block
|
|
using get_blocks_func =
|
|
std::function<const std::vector<BasicBlock*>*(const BasicBlock*)>;
|
|
|
|
/// @brief Performs the Control Flow Graph checks
|
|
///
|
|
/// @param[in] _ the validation state of the module
|
|
///
|
|
/// @return SPV_SUCCESS if no errors are found. SPV_ERROR_INVALID_CFG otherwise
|
|
spv_result_t PerformCfgChecks(ValidationState_t& _);
|
|
|
|
/// @brief Updates the use vectors of all instructions that can be referenced
|
|
///
|
|
/// This function will update the vector which define where an instruction was
|
|
/// referenced in the binary.
|
|
///
|
|
/// @param[in] _ the validation state of the module
|
|
///
|
|
/// @return SPV_SUCCESS if no errors are found.
|
|
spv_result_t UpdateIdUse(ValidationState_t& _);
|
|
|
|
/// @brief This function checks all ID definitions dominate their use in the
|
|
/// CFG.
|
|
///
|
|
/// This function will iterate over all ID definitions that are defined in the
|
|
/// functions of a module and make sure that the definitions appear in a
|
|
/// block that dominates their use.
|
|
///
|
|
/// @param[in] _ the validation state of the module
|
|
///
|
|
/// @return SPV_SUCCESS if no errors are found. SPV_ERROR_INVALID_ID otherwise
|
|
spv_result_t CheckIdDefinitionDominateUse(const ValidationState_t& _);
|
|
|
|
/// @brief Updates the immediate dominator for each of the block edges
|
|
///
|
|
/// Updates the immediate dominator of the blocks for each of the edges
|
|
/// provided by the @p dom_edges parameter
|
|
///
|
|
/// @param[in,out] dom_edges The edges of the dominator tree
|
|
/// @param[in] set_func This function will be called to updated the Immediate
|
|
/// dominator
|
|
void UpdateImmediateDominators(
|
|
const std::vector<std::pair<BasicBlock*, BasicBlock*>>& dom_edges,
|
|
std::function<void(BasicBlock*, BasicBlock*)> set_func);
|
|
|
|
/// @brief Prints all of the dominators of a BasicBlock
|
|
///
|
|
/// @param[in] block The dominators of this block will be printed
|
|
void printDominatorList(BasicBlock& block);
|
|
|
|
/// Performs logical layout validation as described in section 2.4 of the SPIR-V
|
|
/// spec.
|
|
spv_result_t ModuleLayoutPass(ValidationState_t& _,
|
|
const spv_parsed_instruction_t* inst);
|
|
|
|
/// Performs Control Flow Graph validation of a module
|
|
spv_result_t CfgPass(ValidationState_t& _,
|
|
const spv_parsed_instruction_t* inst);
|
|
|
|
/// Performs Id and SSA validation of a module
|
|
spv_result_t IdPass(ValidationState_t& _, const spv_parsed_instruction_t* inst);
|
|
|
|
/// Performs validation of the Data Rules subsection of 2.16.1 Universal
|
|
/// Validation Rules.
|
|
/// TODO(ehsann): add more comments here as more validation code is added.
|
|
spv_result_t DataRulesPass(ValidationState_t& _,
|
|
const spv_parsed_instruction_t* inst);
|
|
|
|
/// Performs instruction validation.
|
|
spv_result_t InstructionPass(ValidationState_t& _,
|
|
const spv_parsed_instruction_t* inst);
|
|
|
|
/// Performs decoration validation.
|
|
spv_result_t ValidateDecorations(ValidationState_t& _);
|
|
|
|
/// Validates that type declarations are unique, unless multiple declarations
|
|
/// of the same data type are allowed by the specification.
|
|
/// (see section 2.8 Types and Variables)
|
|
spv_result_t TypeUniquePass(ValidationState_t& _,
|
|
const spv_parsed_instruction_t* inst);
|
|
|
|
/// Validates correctness of arithmetic instructions.
|
|
spv_result_t ArithmeticsPass(ValidationState_t& _,
|
|
const spv_parsed_instruction_t* inst);
|
|
|
|
/// Validates correctness of composite instructions.
|
|
spv_result_t CompositesPass(ValidationState_t& _,
|
|
const spv_parsed_instruction_t* inst);
|
|
|
|
/// Validates correctness of conversion instructions.
|
|
spv_result_t ConversionPass(ValidationState_t& _,
|
|
const spv_parsed_instruction_t* inst);
|
|
|
|
/// Validates correctness of derivative instructions.
|
|
spv_result_t DerivativesPass(ValidationState_t& _,
|
|
const spv_parsed_instruction_t* inst);
|
|
|
|
/// Validates correctness of logical instructions.
|
|
spv_result_t LogicalsPass(ValidationState_t& _,
|
|
const spv_parsed_instruction_t* inst);
|
|
|
|
/// Validates correctness of bitwise instructions.
|
|
spv_result_t BitwisePass(ValidationState_t& _,
|
|
const spv_parsed_instruction_t* inst);
|
|
|
|
/// Validates correctness of image instructions.
|
|
spv_result_t ImagePass(ValidationState_t& _,
|
|
const spv_parsed_instruction_t* inst);
|
|
|
|
/// Validates correctness of atomic instructions.
|
|
spv_result_t AtomicsPass(ValidationState_t& _,
|
|
const spv_parsed_instruction_t* inst);
|
|
|
|
/// Validates correctness of literal numbers.
|
|
spv_result_t LiteralsPass(ValidationState_t& _,
|
|
const spv_parsed_instruction_t* inst);
|
|
|
|
/// Validates correctness of ExtInst instructions.
|
|
spv_result_t ExtInstPass(ValidationState_t& _,
|
|
const spv_parsed_instruction_t* inst);
|
|
|
|
// Validates that capability declarations use operands allowed in the current
|
|
// context.
|
|
spv_result_t CapabilityPass(ValidationState_t& _,
|
|
const spv_parsed_instruction_t* inst);
|
|
|
|
/// Validates correctness of primitive instructions.
|
|
spv_result_t PrimitivesPass(ValidationState_t& _,
|
|
const spv_parsed_instruction_t* inst);
|
|
|
|
} // namespace libspirv
|
|
|
|
/// @brief Validate the ID usage of the instruction stream
|
|
///
|
|
/// @param[in] pInsts stream of instructions
|
|
/// @param[in] instCount number of instructions
|
|
/// @param[in] opcodeTable table of specified Opcodes
|
|
/// @param[in] operandTable table of specified operands
|
|
/// @param[in] usedefs use-def info from module parsing
|
|
/// @param[in,out] position current position in the stream
|
|
///
|
|
/// @return result code
|
|
spv_result_t spvValidateInstructionIDs(const spv_instruction_t* pInsts,
|
|
const uint64_t instCount,
|
|
const spv_opcode_table opcodeTable,
|
|
const spv_operand_table operandTable,
|
|
const spv_ext_inst_table extInstTable,
|
|
const libspirv::ValidationState_t& state,
|
|
spv_position position);
|
|
|
|
/// @brief Validate the ID's within a SPIR-V binary
|
|
///
|
|
/// @param[in] pInstructions array of instructions
|
|
/// @param[in] count number of elements in instruction array
|
|
/// @param[in] bound the binary header
|
|
/// @param[in] opcodeTable table of specified Opcodes
|
|
/// @param[in] operandTable table of specified operands
|
|
/// @param[in,out] position current word in the binary
|
|
/// @param[in] consumer message consumer callback
|
|
///
|
|
/// @return result code
|
|
spv_result_t spvValidateIDs(const spv_instruction_t* pInstructions,
|
|
const uint64_t count, const uint32_t bound,
|
|
const spv_opcode_table opcodeTable,
|
|
const spv_operand_table operandTable,
|
|
const spv_ext_inst_table extInstTable,
|
|
spv_position position,
|
|
const spvtools::MessageConsumer& consumer);
|
|
|
|
namespace spvtools {
|
|
// Performs validation for the SPIRV-V module binary.
|
|
// The main difference between this API and spvValidateBinary is that the
|
|
// "Validation State" is not destroyed upon function return; it lives on and is
|
|
// pointed to by the vstate unique_ptr.
|
|
spv_result_t ValidateBinaryAndKeepValidationState(
|
|
const spv_const_context context, spv_const_validator_options options,
|
|
const uint32_t* words, const size_t num_words, spv_diagnostic* pDiagnostic,
|
|
std::unique_ptr<libspirv::ValidationState_t>* vstate);
|
|
|
|
// Performs validation for a single instruction and updates given validation
|
|
// state.
|
|
spv_result_t ValidateInstructionAndUpdateValidationState(
|
|
libspirv::ValidationState_t* vstate, const spv_parsed_instruction_t* inst);
|
|
|
|
} // namespace spvtools
|
|
|
|
#endif // LIBSPIRV_VALIDATE_H_
|