SPIRV-Tools/source/fuzz/transformation_equation_instruction.h
Alastair Donaldson 044ecc0b2c
spirv-fuzz: Fuzzer pass to add equation instructions (#3202)
This introduces a new fuzzer pass to add instructions to the module
that define equations, and support in the fact manager for recording
equation facts and deducing synonym facts from equation facts.

Initially the only equations that are supported involve OpIAdd,
OpISub, OpSNegate and OpLogicalNot, but there is scope for adding
support for equations over various other operators.
2020-03-04 14:54:08 +00:00

77 lines
3.0 KiB
C++

// Copyright (c) 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef SOURCE_FUZZ_TRANSFORMATION_EQUATION_INSTRUCTION_H_
#define SOURCE_FUZZ_TRANSFORMATION_EQUATION_INSTRUCTION_H_
#include <vector>
#include "source/fuzz/fact_manager.h"
#include "source/fuzz/protobufs/spirvfuzz_protobufs.h"
#include "source/fuzz/transformation.h"
#include "source/opt/ir_context.h"
namespace spvtools {
namespace fuzz {
class TransformationEquationInstruction : public Transformation {
public:
explicit TransformationEquationInstruction(
const protobufs::TransformationEquationInstruction& message);
TransformationEquationInstruction(
uint32_t fresh_id, SpvOp opcode,
const std::vector<uint32_t>& in_operand_id,
const protobufs::InstructionDescriptor& instruction_to_insert_before);
// - |message_.fresh_id| must be fresh.
// - |message_.instruction_to_insert_before| must identify an instruction
// before which an equation instruction can legitimately be inserted.
// - Each id in |message_.in_operand_id| must exist, not be an OpUndef, and
// be available before |message_.instruction_to_insert_before|.
// - |message_.opcode| must be an opcode for which we know how to handle
// equations, the types of the ids in |message_.in_operand_id| must be
// suitable for use with this opcode, and the module must contain an
// appropriate result type id.
bool IsApplicable(opt::IRContext* context,
const FactManager& fact_manager) const override;
// Adds an instruction to the module, right before
// |message_.instruction_to_insert_before|, of the form:
//
// |message_.fresh_id| = |message_.opcode| %type |message_.in_operand_ids|
//
// where %type is a type id that already exists in the module and that is
// compatible with the opcode and input operands.
//
// The fact manager is also updated to inform it of this equation fact.
void Apply(opt::IRContext* context, FactManager* fact_manager) const override;
protobufs::Transformation ToMessage() const override;
private:
// A helper that, in one fell swoop, checks that |message_.opcode| and the ids
// in |message_.in_operand_id| are compatible, and that the module contains
// an appropriate result type id. If all is well, the result type id is
// returned. Otherwise, 0 is returned.
uint32_t MaybeGetResultType(opt::IRContext* context) const;
protobufs::TransformationEquationInstruction message_;
};
} // namespace fuzz
} // namespace spvtools
#endif // SOURCE_FUZZ_TRANSFORMATION_EQUATION_INSTRUCTION_H_