SPIRV-Tools/source/fuzz/fuzzer_pass_construct_composites.h
Alastair Donaldson 5910bb8e94
spirv-fuzz: add transformation and pass to construct composites (#2941)
Adds a fuzzer pass and transformation to create a composite (array,
matrix, struct or vector) from available constituent components, and
inform the fact manager that each component of the new composite is
synonymous with the id that was used to construct it. This allows the
"replace id with synonym" pass to then replace uses of said ids with
uses of elements extracted from the composite.

Fixes #2858.
2019-10-08 14:04:10 +01:00

80 lines
3.1 KiB
C++

// Copyright (c) 2019 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_FUZZER_PASS_CONSTRUCT_COMPOSITES_H_
#define SOURCE_FUZZ_FUZZER_PASS_CONSTRUCT_COMPOSITES_H_
#include "source/fuzz/fuzzer_pass.h"
#include <map>
#include <vector>
namespace spvtools {
namespace fuzz {
// A fuzzer pass for constructing composite objects from smaller objects.
class FuzzerPassConstructComposites : public FuzzerPass {
public:
FuzzerPassConstructComposites(
opt::IRContext* ir_context, FactManager* fact_manager,
FuzzerContext* fuzzer_context,
protobufs::TransformationSequence* transformations);
~FuzzerPassConstructComposites();
void Apply() override;
private:
// Used to map a type id to relevant instructions whose result type matches
// the type id.
typedef std::map<uint32_t, std::vector<opt::Instruction*>>
TypeIdToInstructions;
// Considers all instructions that are available at |inst| - instructions
// whose results could be packed into a composite - and updates
// |type_id_to_available_instructions| so that each such instruction is
// associated with its the id of its result type.
void RecordAvailableInstruction(
opt::Instruction* inst,
TypeIdToInstructions* type_id_to_available_instructions);
// Attempts to find suitable instruction result ids from the values of
// |type_id_to_available_instructions| that would allow a composite of type
// |array_type| to be constructed. Returns said ids if they can be found.
// Returns |nullptr| otherwise.
std::unique_ptr<std::vector<uint32_t>> TryConstructingArrayComposite(
const opt::analysis::Array& array_type,
const TypeIdToInstructions& type_id_to_available_instructions);
// Similar to TryConstructingArrayComposite, but for matrices.
std::unique_ptr<std::vector<uint32_t>> TryConstructingMatrixComposite(
const opt::analysis::Matrix& matrix_type,
const TypeIdToInstructions& type_id_to_available_instructions);
// Similar to TryConstructingArrayComposite, but for structs.
std::unique_ptr<std::vector<uint32_t>> TryConstructingStructComposite(
const opt::analysis::Struct& struct_type,
const TypeIdToInstructions& type_id_to_available_instructions);
// Similar to TryConstructingArrayComposite, but for vectors.
std::unique_ptr<std::vector<uint32_t>> TryConstructingVectorComposite(
const opt::analysis::Vector& vector_type,
const TypeIdToInstructions& type_id_to_available_instructions);
};
} // namespace fuzz
} // namespace spvtools
#endif // SOURCE_FUZZ_FUZZER_PASS_CONSTRUCT_COMPOSITES_H_