mirror of
https://github.com/KhronosGroup/SPIRV-Tools
synced 2024-11-23 04:00:05 +00:00
dfcb5a1e10
Introduced abstract class for transformations, and refactored all transformations to inherit from this abstract class.
92 lines
4.2 KiB
C++
92 lines
4.2 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_TRANSFORMATION_H_
|
|
#define SOURCE_FUZZ_TRANSFORMATION_H_
|
|
|
|
#include <memory>
|
|
|
|
#include "source/fuzz/fact_manager.h"
|
|
#include "source/fuzz/protobufs/spirvfuzz_protobufs.h"
|
|
#include "source/opt/ir_context.h"
|
|
|
|
namespace spvtools {
|
|
namespace fuzz {
|
|
|
|
// Rules for transformations
|
|
// -------------------------
|
|
//
|
|
// - Immutability: a transformation must be immutable.
|
|
// - Ability to copy and serialize: to ensure that a copy of a transformation,
|
|
// possibly saved out to disk and read back again, is indistinguishable
|
|
// from the original transformation, thus a transformation must depend
|
|
// only on well-defined pieces of state, such as instruction ids. It must
|
|
// not rely on state such as pointers to instructions and blocks.
|
|
// - Determinism: the effect of a transformation on a module be a deterministic
|
|
// function of the module and the transformation. Any randomization should
|
|
// be applied before creating the transformation, not during its
|
|
// application.
|
|
// - Well-defined and precondition: the 'IsApplicable' method should only
|
|
// return true if the transformation can be cleanly applied to the given
|
|
// module, to mutate it into a valid and semantically-equivalent module, as
|
|
// long as the module is initially valid.
|
|
// - Ability to test precondition on any valid module: 'IsApplicable' should be
|
|
// designed so that it is safe to ask whether a transformation is
|
|
// applicable to an arbitrary valid module. For example, if a
|
|
// transformation involves a block id, 'IsApplicable' should check whether
|
|
// the module indeed has a block with that id, and return false if not. It
|
|
// must not assume that there is such a block.
|
|
// - Documented precondition: while the implementation of 'IsApplicable' should
|
|
// should codify the precondition, the method should be commented in the
|
|
// header file for a transformation with a precise English description of
|
|
// the precondition.
|
|
// - Documented effect: while the implementation of 'Apply' should codify the
|
|
// effect of the transformation, the method should be commented in the
|
|
// header file for a transformation with a precise English description of
|
|
// the effect.
|
|
|
|
class Transformation {
|
|
public:
|
|
// A precondition that determines whether the transformation can be cleanly
|
|
// applied in a semantics-preserving manner to the SPIR-V module given by
|
|
// |context|, in the presence of facts captured by |fact_manager|.
|
|
// Preconditions for individual transformations must be documented in the
|
|
// associated header file using precise English. The fact manager is used to
|
|
// provide access to facts about the module that are known to be true, on
|
|
// which the precondition may depend.
|
|
virtual bool IsApplicable(opt::IRContext* context,
|
|
const FactManager& fact_manager) const = 0;
|
|
|
|
// Requires that IsApplicable(context, fact_manager) holds. Applies the
|
|
// transformation, mutating |context| and possibly updating |fact_manager|
|
|
// with new facts established by the transformation.
|
|
virtual void Apply(opt::IRContext* context,
|
|
FactManager* fact_manager) const = 0;
|
|
|
|
// Turns the transformation into a protobuf message for serialization.
|
|
virtual protobufs::Transformation ToMessage() const = 0;
|
|
|
|
virtual ~Transformation();
|
|
|
|
// Factory method to obtain a transformation object from the protobuf
|
|
// representation of a transformation given by |message|.
|
|
static std::unique_ptr<Transformation> FromMessage(
|
|
const protobufs::Transformation& message);
|
|
};
|
|
|
|
} // namespace fuzz
|
|
} // namespace spvtools
|
|
|
|
#endif // SOURCE_FUZZ_TRANSFORMATION_H_
|