SPIRV-Tools/source/opt/ccp_pass.h
Diego Novillo cbd1fa6c42
Simplify logic to decide whether CCP modified the IR (#3997)
Simplify logic to decide whether CCP modified the IR.

The previous attempts at fixing this issue relied on marking the IR
changed only when CCP was able to fold an instruction during
propagation (https://github.com/KhronosGroup/SPIRV-Tools/pull/3799,
https://github.com/KhronosGroup/SPIRV-Tools/pull/3732).

Those fixes missed the case described in
https://github.com/KhronosGroup/SPIRV-Tools/issues/3991.  In this case,
the folder never actually succeeds in folding the instruction, but it
does create constants in the process.

Fixed with this change.
2020-10-28 10:18:34 -04:00

118 lines
4.5 KiB
C++

// Copyright (c) 2017 Google 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 SOURCE_OPT_CCP_PASS_H_
#define SOURCE_OPT_CCP_PASS_H_
#include <memory>
#include <unordered_map>
#include "source/opt/constants.h"
#include "source/opt/function.h"
#include "source/opt/ir_context.h"
#include "source/opt/mem_pass.h"
#include "source/opt/module.h"
#include "source/opt/propagator.h"
namespace spvtools {
namespace opt {
class CCPPass : public MemPass {
public:
CCPPass() = default;
const char* name() const override { return "ccp"; }
Status Process() override;
IRContext::Analysis GetPreservedAnalyses() override {
return IRContext::kAnalysisDefUse |
IRContext::kAnalysisInstrToBlockMapping |
IRContext::kAnalysisDecorations | IRContext::kAnalysisCombinators |
IRContext::kAnalysisCFG | IRContext::kAnalysisDominatorAnalysis |
IRContext::kAnalysisNameMap | IRContext::kAnalysisConstants |
IRContext::kAnalysisTypes;
}
private:
// Initializes the pass.
void Initialize();
// Runs constant propagation on the given function |fp|. Returns true if any
// constants were propagated and the IR modified.
bool PropagateConstants(Function* fp);
// Visits a single instruction |instr|. If the instruction is a conditional
// branch that always jumps to the same basic block, it sets the destination
// block in |dest_bb|.
SSAPropagator::PropStatus VisitInstruction(Instruction* instr,
BasicBlock** dest_bb);
// Visits an OpPhi instruction |phi|. This applies the meet operator for the
// CCP lattice. Essentially, if all the operands in |phi| have the same
// constant value C, the result for |phi| gets assigned the value C.
SSAPropagator::PropStatus VisitPhi(Instruction* phi);
// Visits an SSA assignment instruction |instr|. If the RHS of |instr| folds
// into a constant value C, then the LHS of |instr| is assigned the value C in
// |values_|.
SSAPropagator::PropStatus VisitAssignment(Instruction* instr);
// Visits a branch instruction |instr|. If the branch is conditional
// (OpBranchConditional or OpSwitch), and the value of its selector is known,
// |dest_bb| will be set to the corresponding destination block. Unconditional
// branches always set |dest_bb| to the single destination block.
SSAPropagator::PropStatus VisitBranch(Instruction* instr,
BasicBlock** dest_bb) const;
// Replaces all operands used in |fp| with the corresponding constant values
// in |values_|. Returns true if any operands were replaced, and false
// otherwise.
bool ReplaceValues();
// Marks |instr| as varying by registering a varying value for its result
// into the |values_| table. Returns SSAPropagator::kVarying.
SSAPropagator::PropStatus MarkInstructionVarying(Instruction* instr);
// Returns true if |id| is the special SSA id that corresponds to a varying
// value.
bool IsVaryingValue(uint32_t id) const;
// Constant manager for the parent IR context. Used to record new constants
// generated during propagation.
analysis::ConstantManager* const_mgr_;
// Constant value table. Each entry <id, const_decl_id> in this map
// represents the compile-time constant value for |id| as declared by
// |const_decl_id|. Each |const_decl_id| in this table is an OpConstant
// declaration for the current module.
//
// Additionally, this table keeps track of SSA IDs with varying values. If an
// SSA ID is found to have a varying value, it will have an entry in this
// table that maps to the special SSA id kVaryingSSAId. These values are
// never replaced in the IR, they are used by CCP during propagation.
std::unordered_map<uint32_t, uint32_t> values_;
// Propagator engine used.
std::unique_ptr<SSAPropagator> propagator_;
// Value for the module's ID bound before running CCP. Used to detect whether
// propagation created new instructions.
uint32_t original_id_bound_;
};
} // namespace opt
} // namespace spvtools
#endif // SOURCE_OPT_CCP_PASS_H_