SPIRV-Tools/source/opt/folding_rules.h
dan sinclair eda2cfbe12
Cleanup includes. (#1795)
This Cl cleans up the include paths to be relative to the top level
directory. Various include-what-you-use fixes have been added.
2018-08-03 15:06:09 -04:00

80 lines
2.7 KiB
C++

// Copyright (c) 2018 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_OPT_FOLDING_RULES_H_
#define SOURCE_OPT_FOLDING_RULES_H_
#include <cstdint>
#include <unordered_map>
#include <vector>
#include "source/opt/constants.h"
namespace spvtools {
namespace opt {
// Folding Rules:
//
// The folding mechanism is built around the concept of a |FoldingRule|. A
// folding rule is a function that implements a method of simplifying an
// instruction.
//
// The inputs to a folding rule are:
// |inst| - the instruction to be simplified.
// |constants| - if an in-operands is an id of a constant, then the
// corresponding value in |constants| contains that
// constant value. Otherwise, the corresponding entry in
// |constants| is |nullptr|.
//
// A folding rule returns true if |inst| can be simplified using this rule. If
// the instruction can be simplified, then |inst| is changed to the simplified
// instruction. Otherwise, |inst| remains the same.
//
// See folding_rules.cpp for examples on how to write a folding rule. It is
// important to note that if |inst| can be folded to the result of an
// instruction that feed it, then |inst| should be changed to an OpCopyObject
// that copies that id.
//
// Be sure to add new folding rules to the table of folding rules in the
// constructor for FoldingRules. The new rule should be added to the list for
// every opcode that it applies to. Note that earlier rules in the list are
// given priority. That is, if an earlier rule is able to fold an instruction,
// the later rules will not be attempted.
using FoldingRule = std::function<bool(
IRContext* context, Instruction* inst,
const std::vector<const analysis::Constant*>& constants)>;
class FoldingRules {
public:
FoldingRules();
const std::vector<FoldingRule>& GetRulesForOpcode(SpvOp opcode) const {
auto it = rules_.find(opcode);
if (it != rules_.end()) {
return it->second;
}
return empty_vector_;
}
private:
std::unordered_map<uint32_t, std::vector<FoldingRule>> rules_;
std::vector<FoldingRule> empty_vector_;
};
} // namespace opt
} // namespace spvtools
#endif // SOURCE_OPT_FOLDING_RULES_H_