Chris Lattner | b3b6007 | 2008-04-20 20:35:01 +0000 | [diff] [blame] | 1 | //===- JumpThreading.cpp - Thread control through conditional blocks ------===// |
| 2 | // |
| 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
| 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
| 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
| 9 | // |
Chris Lattner | 2115722 | 2008-04-20 21:13:06 +0000 | [diff] [blame] | 10 | // This file implements the Jump Threading pass. |
Chris Lattner | b3b6007 | 2008-04-20 20:35:01 +0000 | [diff] [blame] | 11 | // |
| 12 | //===----------------------------------------------------------------------===// |
| 13 | |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 14 | #include "llvm/Transforms/Scalar/JumpThreading.h" |
Chandler Carruth | ed0881b | 2012-12-03 16:50:05 +0000 | [diff] [blame] | 15 | #include "llvm/ADT/DenseMap.h" |
| 16 | #include "llvm/ADT/DenseSet.h" |
Eugene Zelenko | 8002c50 | 2017-09-13 21:43:53 +0000 | [diff] [blame] | 17 | #include "llvm/ADT/Optional.h" |
Chandler Carruth | ed0881b | 2012-12-03 16:50:05 +0000 | [diff] [blame] | 18 | #include "llvm/ADT/STLExtras.h" |
Eugene Zelenko | 8002c50 | 2017-09-13 21:43:53 +0000 | [diff] [blame] | 19 | #include "llvm/ADT/SmallPtrSet.h" |
| 20 | #include "llvm/ADT/SmallVector.h" |
Chandler Carruth | ed0881b | 2012-12-03 16:50:05 +0000 | [diff] [blame] | 21 | #include "llvm/ADT/Statistic.h" |
Jun Bum Lim | ac17087 | 2017-03-08 15:22:30 +0000 | [diff] [blame] | 22 | #include "llvm/Analysis/AliasAnalysis.h" |
Eugene Zelenko | 8002c50 | 2017-09-13 21:43:53 +0000 | [diff] [blame] | 23 | #include "llvm/Analysis/BlockFrequencyInfo.h" |
| 24 | #include "llvm/Analysis/BranchProbabilityInfo.h" |
Chandler Carruth | 6bda14b | 2017-06-06 11:49:48 +0000 | [diff] [blame] | 25 | #include "llvm/Analysis/CFG.h" |
Owen Anderson | 92651ec | 2011-04-14 21:35:50 +0000 | [diff] [blame] | 26 | #include "llvm/Analysis/ConstantFolding.h" |
Chandler Carruth | 6bda14b | 2017-06-06 11:49:48 +0000 | [diff] [blame] | 27 | #include "llvm/Analysis/GlobalsModRef.h" |
Chris Lattner | 800aad3 | 2009-11-09 23:00:14 +0000 | [diff] [blame] | 28 | #include "llvm/Analysis/InstructionSimplify.h" |
Eugene Zelenko | 8002c50 | 2017-09-13 21:43:53 +0000 | [diff] [blame] | 29 | #include "llvm/Analysis/LazyValueInfo.h" |
Dan Gohman | 826bdf8 | 2010-05-28 16:19:17 +0000 | [diff] [blame] | 30 | #include "llvm/Analysis/Loads.h" |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 31 | #include "llvm/Analysis/LoopInfo.h" |
Eugene Zelenko | 8002c50 | 2017-09-13 21:43:53 +0000 | [diff] [blame] | 32 | #include "llvm/Analysis/TargetLibraryInfo.h" |
David Blaikie | 31b98d2 | 2018-06-04 21:23:21 +0000 | [diff] [blame^] | 33 | #include "llvm/Transforms/Utils/Local.h" |
Sanjoy Das | 13e63a2 | 2015-10-28 21:27:08 +0000 | [diff] [blame] | 34 | #include "llvm/Analysis/ValueTracking.h" |
Eugene Zelenko | 8002c50 | 2017-09-13 21:43:53 +0000 | [diff] [blame] | 35 | #include "llvm/IR/BasicBlock.h" |
| 36 | #include "llvm/IR/CFG.h" |
| 37 | #include "llvm/IR/Constant.h" |
Craig Topper | 2c20c42 | 2017-06-23 05:41:35 +0000 | [diff] [blame] | 38 | #include "llvm/IR/ConstantRange.h" |
Eugene Zelenko | 8002c50 | 2017-09-13 21:43:53 +0000 | [diff] [blame] | 39 | #include "llvm/IR/Constants.h" |
Chandler Carruth | 9fb823b | 2013-01-02 11:36:10 +0000 | [diff] [blame] | 40 | #include "llvm/IR/DataLayout.h" |
Eugene Zelenko | 8002c50 | 2017-09-13 21:43:53 +0000 | [diff] [blame] | 41 | #include "llvm/IR/Dominators.h" |
| 42 | #include "llvm/IR/Function.h" |
| 43 | #include "llvm/IR/InstrTypes.h" |
| 44 | #include "llvm/IR/Instruction.h" |
| 45 | #include "llvm/IR/Instructions.h" |
Chandler Carruth | 9fb823b | 2013-01-02 11:36:10 +0000 | [diff] [blame] | 46 | #include "llvm/IR/IntrinsicInst.h" |
Eugene Zelenko | 8002c50 | 2017-09-13 21:43:53 +0000 | [diff] [blame] | 47 | #include "llvm/IR/Intrinsics.h" |
Chandler Carruth | 9fb823b | 2013-01-02 11:36:10 +0000 | [diff] [blame] | 48 | #include "llvm/IR/LLVMContext.h" |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 49 | #include "llvm/IR/MDBuilder.h" |
Hal Finkel | cc39b67 | 2014-07-24 12:16:19 +0000 | [diff] [blame] | 50 | #include "llvm/IR/Metadata.h" |
Eugene Zelenko | 8002c50 | 2017-09-13 21:43:53 +0000 | [diff] [blame] | 51 | #include "llvm/IR/Module.h" |
| 52 | #include "llvm/IR/PassManager.h" |
Sanjoy Das | 8b859c2 | 2017-02-17 04:21:14 +0000 | [diff] [blame] | 53 | #include "llvm/IR/PatternMatch.h" |
Eugene Zelenko | 8002c50 | 2017-09-13 21:43:53 +0000 | [diff] [blame] | 54 | #include "llvm/IR/Type.h" |
| 55 | #include "llvm/IR/Use.h" |
| 56 | #include "llvm/IR/User.h" |
| 57 | #include "llvm/IR/Value.h" |
Chandler Carruth | ed0881b | 2012-12-03 16:50:05 +0000 | [diff] [blame] | 58 | #include "llvm/Pass.h" |
Eugene Zelenko | 8002c50 | 2017-09-13 21:43:53 +0000 | [diff] [blame] | 59 | #include "llvm/Support/BlockFrequency.h" |
| 60 | #include "llvm/Support/BranchProbability.h" |
| 61 | #include "llvm/Support/Casting.h" |
Chris Lattner | b3b6007 | 2008-04-20 20:35:01 +0000 | [diff] [blame] | 62 | #include "llvm/Support/CommandLine.h" |
Chris Lattner | 2115722 | 2008-04-20 21:13:06 +0000 | [diff] [blame] | 63 | #include "llvm/Support/Debug.h" |
Daniel Dunbar | 9813b0b | 2009-07-26 07:49:05 +0000 | [diff] [blame] | 64 | #include "llvm/Support/raw_ostream.h" |
Chandler Carruth | 6bda14b | 2017-06-06 11:49:48 +0000 | [diff] [blame] | 65 | #include "llvm/Transforms/Scalar.h" |
Chandler Carruth | ed0881b | 2012-12-03 16:50:05 +0000 | [diff] [blame] | 66 | #include "llvm/Transforms/Utils/BasicBlockUtils.h" |
Sanjoy Das | 8b859c2 | 2017-02-17 04:21:14 +0000 | [diff] [blame] | 67 | #include "llvm/Transforms/Utils/Cloning.h" |
Chandler Carruth | ed0881b | 2012-12-03 16:50:05 +0000 | [diff] [blame] | 68 | #include "llvm/Transforms/Utils/SSAUpdater.h" |
Michael Zolotukhin | a41660d | 2018-05-12 01:52:36 +0000 | [diff] [blame] | 69 | #include "llvm/Transforms/Utils/SSAUpdaterBulk.h" |
Eugene Zelenko | 8002c50 | 2017-09-13 21:43:53 +0000 | [diff] [blame] | 70 | #include "llvm/Transforms/Utils/ValueMapper.h" |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 71 | #include <algorithm> |
Eugene Zelenko | 8002c50 | 2017-09-13 21:43:53 +0000 | [diff] [blame] | 72 | #include <cassert> |
| 73 | #include <cstddef> |
| 74 | #include <cstdint> |
| 75 | #include <iterator> |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 76 | #include <memory> |
Eugene Zelenko | 8002c50 | 2017-09-13 21:43:53 +0000 | [diff] [blame] | 77 | #include <utility> |
| 78 | |
Chris Lattner | b3b6007 | 2008-04-20 20:35:01 +0000 | [diff] [blame] | 79 | using namespace llvm; |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 80 | using namespace jumpthreading; |
Chris Lattner | b3b6007 | 2008-04-20 20:35:01 +0000 | [diff] [blame] | 81 | |
Chandler Carruth | 964daaa | 2014-04-22 02:55:47 +0000 | [diff] [blame] | 82 | #define DEBUG_TYPE "jump-threading" |
| 83 | |
Chris Lattner | ff1c6e3 | 2008-04-20 22:39:42 +0000 | [diff] [blame] | 84 | STATISTIC(NumThreads, "Number of jumps threaded"); |
| 85 | STATISTIC(NumFolds, "Number of terminators folded"); |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 86 | STATISTIC(NumDupes, "Number of branch blocks duplicated to eliminate phi"); |
Chris Lattner | b3b6007 | 2008-04-20 20:35:01 +0000 | [diff] [blame] | 87 | |
Chris Lattner | 2115722 | 2008-04-20 21:13:06 +0000 | [diff] [blame] | 88 | static cl::opt<unsigned> |
Michael Liao | d120916 | 2014-09-24 04:59:06 +0000 | [diff] [blame] | 89 | BBDuplicateThreshold("jump-threading-threshold", |
Chris Lattner | 2115722 | 2008-04-20 21:13:06 +0000 | [diff] [blame] | 90 | cl::desc("Max block size to duplicate for jump threading"), |
| 91 | cl::init(6), cl::Hidden); |
| 92 | |
Sanjoy Das | 13e63a2 | 2015-10-28 21:27:08 +0000 | [diff] [blame] | 93 | static cl::opt<unsigned> |
| 94 | ImplicationSearchThreshold( |
| 95 | "jump-threading-implication-search-threshold", |
| 96 | cl::desc("The number of predecessors to search for a stronger " |
| 97 | "condition to use to thread over a weaker condition"), |
| 98 | cl::init(3), cl::Hidden); |
| 99 | |
Davide Italiano | 01cb947 | 2017-07-28 02:57:43 +0000 | [diff] [blame] | 100 | static cl::opt<bool> PrintLVIAfterJumpThreading( |
| 101 | "print-lvi-after-jump-threading", |
| 102 | cl::desc("Print the LazyValueInfo cache after JumpThreading"), cl::init(false), |
| 103 | cl::Hidden); |
| 104 | |
Chris Lattner | b3b6007 | 2008-04-20 20:35:01 +0000 | [diff] [blame] | 105 | namespace { |
Eugene Zelenko | 8002c50 | 2017-09-13 21:43:53 +0000 | [diff] [blame] | 106 | |
Chris Lattner | e7f0afe | 2008-05-09 04:43:13 +0000 | [diff] [blame] | 107 | /// This pass performs 'jump threading', which looks at blocks that have |
| 108 | /// multiple predecessors and multiple successors. If one or more of the |
| 109 | /// predecessors of the block can be proven to always jump to one of the |
| 110 | /// successors, we forward the edge from the predecessor to the successor by |
| 111 | /// duplicating the contents of this block. |
| 112 | /// |
| 113 | /// An example of when this can occur is code like this: |
| 114 | /// |
| 115 | /// if () { ... |
| 116 | /// X = 4; |
| 117 | /// } |
| 118 | /// if (X < 3) { |
| 119 | /// |
| 120 | /// In this case, the unconditional branch at the end of the first if can be |
| 121 | /// revectored to the false side of the second if. |
Chris Lattner | 2dd09db | 2009-09-02 06:11:42 +0000 | [diff] [blame] | 122 | class JumpThreading : public FunctionPass { |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 123 | JumpThreadingPass Impl; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 124 | |
Chris Lattner | b3b6007 | 2008-04-20 20:35:01 +0000 | [diff] [blame] | 125 | public: |
| 126 | static char ID; // Pass identification |
Eugene Zelenko | 8002c50 | 2017-09-13 21:43:53 +0000 | [diff] [blame] | 127 | |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 128 | JumpThreading(int T = -1) : FunctionPass(ID), Impl(T) { |
Owen Anderson | 6c18d1a | 2010-10-19 17:21:58 +0000 | [diff] [blame] | 129 | initializeJumpThreadingPass(*PassRegistry::getPassRegistry()); |
| 130 | } |
Chris Lattner | b3b6007 | 2008-04-20 20:35:01 +0000 | [diff] [blame] | 131 | |
Craig Topper | 3e4c697 | 2014-03-05 09:10:37 +0000 | [diff] [blame] | 132 | bool runOnFunction(Function &F) override; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 133 | |
Craig Topper | 3e4c697 | 2014-03-05 09:10:37 +0000 | [diff] [blame] | 134 | void getAnalysisUsage(AnalysisUsage &AU) const override { |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 135 | AU.addRequired<DominatorTreeWrapperPass>(); |
| 136 | AU.addPreserved<DominatorTreeWrapperPass>(); |
Jun Bum Lim | ac17087 | 2017-03-08 15:22:30 +0000 | [diff] [blame] | 137 | AU.addRequired<AAResultsWrapperPass>(); |
Sean Silva | 687019f | 2016-06-13 22:01:25 +0000 | [diff] [blame] | 138 | AU.addRequired<LazyValueInfoWrapperPass>(); |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 139 | AU.addPreserved<LazyValueInfoWrapperPass>(); |
James Molloy | efbba72 | 2015-09-10 10:22:12 +0000 | [diff] [blame] | 140 | AU.addPreserved<GlobalsAAWrapperPass>(); |
Chandler Carruth | b98f63d | 2015-01-15 10:41:28 +0000 | [diff] [blame] | 141 | AU.addRequired<TargetLibraryInfoWrapperPass>(); |
Chris Lattner | fde1f8d | 2009-11-11 02:08:33 +0000 | [diff] [blame] | 142 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 143 | |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 144 | void releaseMemory() override { Impl.releaseMemory(); } |
Chris Lattner | b3b6007 | 2008-04-20 20:35:01 +0000 | [diff] [blame] | 145 | }; |
Eugene Zelenko | 8002c50 | 2017-09-13 21:43:53 +0000 | [diff] [blame] | 146 | |
| 147 | } // end anonymous namespace |
Chris Lattner | b3b6007 | 2008-04-20 20:35:01 +0000 | [diff] [blame] | 148 | |
Dan Gohman | d78c400 | 2008-05-13 00:00:25 +0000 | [diff] [blame] | 149 | char JumpThreading::ID = 0; |
Eugene Zelenko | 8002c50 | 2017-09-13 21:43:53 +0000 | [diff] [blame] | 150 | |
Owen Anderson | 8ac477f | 2010-10-12 19:48:12 +0000 | [diff] [blame] | 151 | INITIALIZE_PASS_BEGIN(JumpThreading, "jump-threading", |
| 152 | "Jump Threading", false, false) |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 153 | INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass) |
Sean Silva | 687019f | 2016-06-13 22:01:25 +0000 | [diff] [blame] | 154 | INITIALIZE_PASS_DEPENDENCY(LazyValueInfoWrapperPass) |
Chandler Carruth | b98f63d | 2015-01-15 10:41:28 +0000 | [diff] [blame] | 155 | INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfoWrapperPass) |
Jun Bum Lim | ac17087 | 2017-03-08 15:22:30 +0000 | [diff] [blame] | 156 | INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass) |
Owen Anderson | 8ac477f | 2010-10-12 19:48:12 +0000 | [diff] [blame] | 157 | INITIALIZE_PASS_END(JumpThreading, "jump-threading", |
Owen Anderson | df7a4f2 | 2010-10-07 22:25:06 +0000 | [diff] [blame] | 158 | "Jump Threading", false, false) |
Dan Gohman | d78c400 | 2008-05-13 00:00:25 +0000 | [diff] [blame] | 159 | |
Chris Lattner | b3b6007 | 2008-04-20 20:35:01 +0000 | [diff] [blame] | 160 | // Public interface to the Jump Threading pass |
Eugene Zelenko | 8002c50 | 2017-09-13 21:43:53 +0000 | [diff] [blame] | 161 | FunctionPass *llvm::createJumpThreadingPass(int Threshold) { |
| 162 | return new JumpThreading(Threshold); |
| 163 | } |
Chris Lattner | b3b6007 | 2008-04-20 20:35:01 +0000 | [diff] [blame] | 164 | |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 165 | JumpThreadingPass::JumpThreadingPass(int T) { |
| 166 | BBDupThreshold = (T == -1) ? BBDuplicateThreshold : unsigned(T); |
| 167 | } |
| 168 | |
Xinliang David Li | 66531dd | 2017-08-24 22:54:01 +0000 | [diff] [blame] | 169 | // Update branch probability information according to conditional |
| 170 | // branch probablity. This is usually made possible for cloned branches |
| 171 | // in inline instances by the context specific profile in the caller. |
| 172 | // For instance, |
| 173 | // |
| 174 | // [Block PredBB] |
| 175 | // [Branch PredBr] |
| 176 | // if (t) { |
| 177 | // Block A; |
| 178 | // } else { |
| 179 | // Block B; |
| 180 | // } |
| 181 | // |
| 182 | // [Block BB] |
| 183 | // cond = PN([true, %A], [..., %B]); // PHI node |
| 184 | // [Branch CondBr] |
| 185 | // if (cond) { |
| 186 | // ... // P(cond == true) = 1% |
| 187 | // } |
| 188 | // |
| 189 | // Here we know that when block A is taken, cond must be true, which means |
| 190 | // P(cond == true | A) = 1 |
| 191 | // |
| 192 | // Given that P(cond == true) = P(cond == true | A) * P(A) + |
| 193 | // P(cond == true | B) * P(B) |
Brian M. Rzycki | 0eae123 | 2017-12-08 19:36:32 +0000 | [diff] [blame] | 194 | // we get: |
Xinliang David Li | 66531dd | 2017-08-24 22:54:01 +0000 | [diff] [blame] | 195 | // P(cond == true ) = P(A) + P(cond == true | B) * P(B) |
| 196 | // |
| 197 | // which gives us: |
Xinliang David Li | a531f18 | 2017-11-06 21:57:51 +0000 | [diff] [blame] | 198 | // P(A) is less than P(cond == true), i.e. |
Xinliang David Li | 66531dd | 2017-08-24 22:54:01 +0000 | [diff] [blame] | 199 | // P(t == true) <= P(cond == true) |
| 200 | // |
Brian M. Rzycki | 0eae123 | 2017-12-08 19:36:32 +0000 | [diff] [blame] | 201 | // In other words, if we know P(cond == true) is unlikely, we know |
Xinliang David Li | a531f18 | 2017-11-06 21:57:51 +0000 | [diff] [blame] | 202 | // that P(t == true) is also unlikely. |
| 203 | // |
Xinliang David Li | 66531dd | 2017-08-24 22:54:01 +0000 | [diff] [blame] | 204 | static void updatePredecessorProfileMetadata(PHINode *PN, BasicBlock *BB) { |
| 205 | BranchInst *CondBr = dyn_cast<BranchInst>(BB->getTerminator()); |
| 206 | if (!CondBr) |
| 207 | return; |
| 208 | |
| 209 | BranchProbability BP; |
| 210 | uint64_t TrueWeight, FalseWeight; |
| 211 | if (!CondBr->extractProfMetadata(TrueWeight, FalseWeight)) |
| 212 | return; |
| 213 | |
| 214 | // Returns the outgoing edge of the dominating predecessor block |
| 215 | // that leads to the PhiNode's incoming block: |
| 216 | auto GetPredOutEdge = |
| 217 | [](BasicBlock *IncomingBB, |
| 218 | BasicBlock *PhiBB) -> std::pair<BasicBlock *, BasicBlock *> { |
| 219 | auto *PredBB = IncomingBB; |
| 220 | auto *SuccBB = PhiBB; |
Eugene Zelenko | 8002c50 | 2017-09-13 21:43:53 +0000 | [diff] [blame] | 221 | while (true) { |
Xinliang David Li | 66531dd | 2017-08-24 22:54:01 +0000 | [diff] [blame] | 222 | BranchInst *PredBr = dyn_cast<BranchInst>(PredBB->getTerminator()); |
| 223 | if (PredBr && PredBr->isConditional()) |
| 224 | return {PredBB, SuccBB}; |
| 225 | auto *SinglePredBB = PredBB->getSinglePredecessor(); |
| 226 | if (!SinglePredBB) |
| 227 | return {nullptr, nullptr}; |
| 228 | SuccBB = PredBB; |
| 229 | PredBB = SinglePredBB; |
| 230 | } |
| 231 | }; |
| 232 | |
| 233 | for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) { |
| 234 | Value *PhiOpnd = PN->getIncomingValue(i); |
| 235 | ConstantInt *CI = dyn_cast<ConstantInt>(PhiOpnd); |
| 236 | |
| 237 | if (!CI || !CI->getType()->isIntegerTy(1)) |
| 238 | continue; |
| 239 | |
| 240 | BP = (CI->isOne() ? BranchProbability::getBranchProbability( |
| 241 | TrueWeight, TrueWeight + FalseWeight) |
| 242 | : BranchProbability::getBranchProbability( |
| 243 | FalseWeight, TrueWeight + FalseWeight)); |
| 244 | |
| 245 | auto PredOutEdge = GetPredOutEdge(PN->getIncomingBlock(i), BB); |
| 246 | if (!PredOutEdge.first) |
| 247 | return; |
| 248 | |
| 249 | BasicBlock *PredBB = PredOutEdge.first; |
| 250 | BranchInst *PredBr = cast<BranchInst>(PredBB->getTerminator()); |
| 251 | |
| 252 | uint64_t PredTrueWeight, PredFalseWeight; |
| 253 | // FIXME: We currently only set the profile data when it is missing. |
| 254 | // With PGO, this can be used to refine even existing profile data with |
| 255 | // context information. This needs to be done after more performance |
| 256 | // testing. |
| 257 | if (PredBr->extractProfMetadata(PredTrueWeight, PredFalseWeight)) |
| 258 | continue; |
| 259 | |
| 260 | // We can not infer anything useful when BP >= 50%, because BP is the |
| 261 | // upper bound probability value. |
| 262 | if (BP >= BranchProbability(50, 100)) |
| 263 | continue; |
| 264 | |
| 265 | SmallVector<uint32_t, 2> Weights; |
| 266 | if (PredBr->getSuccessor(0) == PredOutEdge.second) { |
| 267 | Weights.push_back(BP.getNumerator()); |
| 268 | Weights.push_back(BP.getCompl().getNumerator()); |
| 269 | } else { |
| 270 | Weights.push_back(BP.getCompl().getNumerator()); |
| 271 | Weights.push_back(BP.getNumerator()); |
| 272 | } |
| 273 | PredBr->setMetadata(LLVMContext::MD_prof, |
| 274 | MDBuilder(PredBr->getParent()->getContext()) |
| 275 | .createBranchWeights(Weights)); |
| 276 | } |
| 277 | } |
| 278 | |
| 279 | /// runOnFunction - Toplevel algorithm. |
Chris Lattner | b3b6007 | 2008-04-20 20:35:01 +0000 | [diff] [blame] | 280 | bool JumpThreading::runOnFunction(Function &F) { |
Andrew Kaylor | aa641a5 | 2016-04-22 22:06:11 +0000 | [diff] [blame] | 281 | if (skipFunction(F)) |
Paul Robinson | af4e64d | 2014-02-06 00:07:05 +0000 | [diff] [blame] | 282 | return false; |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 283 | auto TLI = &getAnalysis<TargetLibraryInfoWrapperPass>().getTLI(); |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 284 | // Get DT analysis before LVI. When LVI is initialized it conditionally adds |
| 285 | // DT if it's available. |
| 286 | auto DT = &getAnalysis<DominatorTreeWrapperPass>().getDomTree(); |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 287 | auto LVI = &getAnalysis<LazyValueInfoWrapperPass>().getLVI(); |
Jun Bum Lim | ac17087 | 2017-03-08 15:22:30 +0000 | [diff] [blame] | 288 | auto AA = &getAnalysis<AAResultsWrapperPass>().getAAResults(); |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 289 | DeferredDominance DDT(*DT); |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 290 | std::unique_ptr<BlockFrequencyInfo> BFI; |
| 291 | std::unique_ptr<BranchProbabilityInfo> BPI; |
Easwaran Raman | a17f220 | 2017-12-22 01:33:52 +0000 | [diff] [blame] | 292 | bool HasProfileData = F.hasProfileData(); |
Sean Silva | f81328d | 2016-06-13 22:52:52 +0000 | [diff] [blame] | 293 | if (HasProfileData) { |
Sean Silva | 7d5a57c | 2016-06-14 00:26:31 +0000 | [diff] [blame] | 294 | LoopInfo LI{DominatorTree(F)}; |
John Brawn | da4a68a | 2017-06-08 09:44:40 +0000 | [diff] [blame] | 295 | BPI.reset(new BranchProbabilityInfo(F, LI, TLI)); |
Sean Silva | 7d5a57c | 2016-06-14 00:26:31 +0000 | [diff] [blame] | 296 | BFI.reset(new BlockFrequencyInfo(F, *BPI, LI)); |
Sean Silva | f81328d | 2016-06-13 22:52:52 +0000 | [diff] [blame] | 297 | } |
Jun Bum Lim | ac17087 | 2017-03-08 15:22:30 +0000 | [diff] [blame] | 298 | |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 299 | bool Changed = Impl.runImpl(F, TLI, LVI, AA, &DDT, HasProfileData, |
| 300 | std::move(BFI), std::move(BPI)); |
Davide Italiano | 01cb947 | 2017-07-28 02:57:43 +0000 | [diff] [blame] | 301 | if (PrintLVIAfterJumpThreading) { |
| 302 | dbgs() << "LVI for function '" << F.getName() << "':\n"; |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 303 | LVI->printLVI(F, *DT, dbgs()); |
Davide Italiano | 01cb947 | 2017-07-28 02:57:43 +0000 | [diff] [blame] | 304 | } |
| 305 | return Changed; |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 306 | } |
| 307 | |
| 308 | PreservedAnalyses JumpThreadingPass::run(Function &F, |
Sean Silva | 36e0d01 | 2016-08-09 00:28:15 +0000 | [diff] [blame] | 309 | FunctionAnalysisManager &AM) { |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 310 | auto &TLI = AM.getResult<TargetLibraryAnalysis>(F); |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 311 | // Get DT analysis before LVI. When LVI is initialized it conditionally adds |
| 312 | // DT if it's available. |
| 313 | auto &DT = AM.getResult<DominatorTreeAnalysis>(F); |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 314 | auto &LVI = AM.getResult<LazyValueAnalysis>(F); |
Jun Bum Lim | ac17087 | 2017-03-08 15:22:30 +0000 | [diff] [blame] | 315 | auto &AA = AM.getResult<AAManager>(F); |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 316 | DeferredDominance DDT(DT); |
Jun Bum Lim | ac17087 | 2017-03-08 15:22:30 +0000 | [diff] [blame] | 317 | |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 318 | std::unique_ptr<BlockFrequencyInfo> BFI; |
| 319 | std::unique_ptr<BranchProbabilityInfo> BPI; |
Easwaran Raman | a17f220 | 2017-12-22 01:33:52 +0000 | [diff] [blame] | 320 | if (F.hasProfileData()) { |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 321 | LoopInfo LI{DominatorTree(F)}; |
John Brawn | da4a68a | 2017-06-08 09:44:40 +0000 | [diff] [blame] | 322 | BPI.reset(new BranchProbabilityInfo(F, LI, &TLI)); |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 323 | BFI.reset(new BlockFrequencyInfo(F, *BPI, LI)); |
| 324 | } |
Jun Bum Lim | ac17087 | 2017-03-08 15:22:30 +0000 | [diff] [blame] | 325 | |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 326 | bool Changed = runImpl(F, &TLI, &LVI, &AA, &DDT, HasProfileData, |
| 327 | std::move(BFI), std::move(BPI)); |
Sean Silva | f50d4b6 | 2016-07-06 19:05:41 +0000 | [diff] [blame] | 328 | |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 329 | if (!Changed) |
| 330 | return PreservedAnalyses::all(); |
| 331 | PreservedAnalyses PA; |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 332 | PA.preserve<GlobalsAA>(); |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 333 | PA.preserve<DominatorTreeAnalysis>(); |
| 334 | PA.preserve<LazyValueAnalysis>(); |
Sean Silva | f2db01c | 2016-07-02 16:16:44 +0000 | [diff] [blame] | 335 | return PA; |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 336 | } |
| 337 | |
| 338 | bool JumpThreadingPass::runImpl(Function &F, TargetLibraryInfo *TLI_, |
Jun Bum Lim | ac17087 | 2017-03-08 15:22:30 +0000 | [diff] [blame] | 339 | LazyValueInfo *LVI_, AliasAnalysis *AA_, |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 340 | DeferredDominance *DDT_, bool HasProfileData_, |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 341 | std::unique_ptr<BlockFrequencyInfo> BFI_, |
| 342 | std::unique_ptr<BranchProbabilityInfo> BPI_) { |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 343 | LLVM_DEBUG(dbgs() << "Jump threading on function '" << F.getName() << "'\n"); |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 344 | TLI = TLI_; |
| 345 | LVI = LVI_; |
Jun Bum Lim | ac17087 | 2017-03-08 15:22:30 +0000 | [diff] [blame] | 346 | AA = AA_; |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 347 | DDT = DDT_; |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 348 | BFI.reset(); |
| 349 | BPI.reset(); |
| 350 | // When profile data is available, we need to update edge weights after |
| 351 | // successful jump threading, which requires both BPI and BFI being available. |
| 352 | HasProfileData = HasProfileData_; |
Sanjoy Das | 8b859c2 | 2017-02-17 04:21:14 +0000 | [diff] [blame] | 353 | auto *GuardDecl = F.getParent()->getFunction( |
| 354 | Intrinsic::getName(Intrinsic::experimental_guard)); |
| 355 | HasGuards = GuardDecl && !GuardDecl->use_empty(); |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 356 | if (HasProfileData) { |
| 357 | BPI = std::move(BPI_); |
| 358 | BFI = std::move(BFI_); |
| 359 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 360 | |
Brian M. Rzycki | f65ddc5 | 2018-03-16 15:13:47 +0000 | [diff] [blame] | 361 | // JumpThreading must not processes blocks unreachable from entry. It's a |
| 362 | // waste of compute time and can potentially lead to hangs. |
| 363 | SmallPtrSet<BasicBlock *, 16> Unreachable; |
| 364 | DominatorTree &DT = DDT->flush(); |
| 365 | for (auto &BB : F) |
| 366 | if (!DT.isReachableFromEntry(&BB)) |
| 367 | Unreachable.insert(&BB); |
Daniel Jasper | 0a51ec2 | 2017-09-30 11:57:19 +0000 | [diff] [blame] | 368 | |
Chris Lattner | d579cb1 | 2009-05-04 02:28:08 +0000 | [diff] [blame] | 369 | FindLoopHeaders(F); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 370 | |
Brian M. Rzycki | f65ddc5 | 2018-03-16 15:13:47 +0000 | [diff] [blame] | 371 | bool EverChanged = false; |
David Majnemer | d9833ea | 2016-01-10 07:13:04 +0000 | [diff] [blame] | 372 | bool Changed; |
Benjamin Kramer | 76e2766 | 2010-01-07 13:50:07 +0000 | [diff] [blame] | 373 | do { |
| 374 | Changed = false; |
Brian M. Rzycki | f65ddc5 | 2018-03-16 15:13:47 +0000 | [diff] [blame] | 375 | for (auto &BB : F) { |
| 376 | if (Unreachable.count(&BB)) |
| 377 | continue; |
| 378 | while (ProcessBlock(&BB)) // Thread all of the branches we can over BB. |
Chris Lattner | ff1c6e3 | 2008-04-20 22:39:42 +0000 | [diff] [blame] | 379 | Changed = true; |
Brian M. Rzycki | f65ddc5 | 2018-03-16 15:13:47 +0000 | [diff] [blame] | 380 | // Stop processing BB if it's the entry or is now deleted. The following |
| 381 | // routines attempt to eliminate BB and locating a suitable replacement |
| 382 | // for the entry is non-trivial. |
| 383 | if (&BB == &F.getEntryBlock() || DDT->pendingDeletedBB(&BB)) |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 384 | continue; |
| 385 | |
Brian M. Rzycki | f65ddc5 | 2018-03-16 15:13:47 +0000 | [diff] [blame] | 386 | if (pred_empty(&BB)) { |
| 387 | // When ProcessBlock makes BB unreachable it doesn't bother to fix up |
| 388 | // the instructions in it. We must remove BB to prevent invalid IR. |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 389 | LLVM_DEBUG(dbgs() << " JT: Deleting dead block '" << BB.getName() |
| 390 | << "' with terminator: " << *BB.getTerminator() |
| 391 | << '\n'); |
Brian M. Rzycki | f65ddc5 | 2018-03-16 15:13:47 +0000 | [diff] [blame] | 392 | LoopHeaders.erase(&BB); |
| 393 | LVI->eraseBlock(&BB); |
| 394 | DeleteDeadBlock(&BB, DDT); |
Chris Lattner | 595c727 | 2008-12-03 07:48:08 +0000 | [diff] [blame] | 395 | Changed = true; |
Chris Lattner | 73a5862 | 2010-12-13 02:38:13 +0000 | [diff] [blame] | 396 | continue; |
| 397 | } |
Owen Anderson | 92651ec | 2011-04-14 21:35:50 +0000 | [diff] [blame] | 398 | |
Brian M. Rzycki | f65ddc5 | 2018-03-16 15:13:47 +0000 | [diff] [blame] | 399 | // ProcessBlock doesn't thread BBs with unconditional TIs. However, if BB |
| 400 | // is "almost empty", we attempt to merge BB with its sole successor. |
| 401 | auto *BI = dyn_cast<BranchInst>(BB.getTerminator()); |
Chris Lattner | 73a5862 | 2010-12-13 02:38:13 +0000 | [diff] [blame] | 402 | if (BI && BI->isUnconditional() && |
Brian M. Rzycki | f65ddc5 | 2018-03-16 15:13:47 +0000 | [diff] [blame] | 403 | // The terminator must be the only non-phi instruction in BB. |
| 404 | BB.getFirstNonPHIOrDbg()->isTerminator() && |
| 405 | // Don't alter Loop headers and latches to ensure another pass can |
| 406 | // detect and transform nested loops later. |
| 407 | !LoopHeaders.count(&BB) && !LoopHeaders.count(BI->getSuccessor(0)) && |
| 408 | TryToSimplifyUncondBranchFromEmptyBlock(&BB, DDT)) { |
| 409 | // BB is valid for cleanup here because we passed in DDT. F remains |
| 410 | // BB's parent until a DDT->flush() event. |
| 411 | LVI->eraseBlock(&BB); |
| 412 | Changed = true; |
Chris Lattner | 595c727 | 2008-12-03 07:48:08 +0000 | [diff] [blame] | 413 | } |
| 414 | } |
Chris Lattner | ff1c6e3 | 2008-04-20 22:39:42 +0000 | [diff] [blame] | 415 | EverChanged |= Changed; |
Benjamin Kramer | 76e2766 | 2010-01-07 13:50:07 +0000 | [diff] [blame] | 416 | } while (Changed); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 417 | |
Chris Lattner | d579cb1 | 2009-05-04 02:28:08 +0000 | [diff] [blame] | 418 | LoopHeaders.clear(); |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 419 | DDT->flush(); |
Brian M. Rzycki | f1a7df5 | 2018-02-16 16:35:17 +0000 | [diff] [blame] | 420 | LVI->enableDT(); |
Chris Lattner | ff1c6e3 | 2008-04-20 22:39:42 +0000 | [diff] [blame] | 421 | return EverChanged; |
Chris Lattner | b3b6007 | 2008-04-20 20:35:01 +0000 | [diff] [blame] | 422 | } |
Chris Lattner | 2115722 | 2008-04-20 21:13:06 +0000 | [diff] [blame] | 423 | |
Anna Thomas | c07d554 | 2017-05-23 13:36:25 +0000 | [diff] [blame] | 424 | // Replace uses of Cond with ToVal when safe to do so. If all uses are |
| 425 | // replaced, we can remove Cond. We cannot blindly replace all uses of Cond |
| 426 | // because we may incorrectly replace uses when guards/assumes are uses of |
| 427 | // of `Cond` and we used the guards/assume to reason about the `Cond` value |
| 428 | // at the end of block. RAUW unconditionally replaces all uses |
| 429 | // including the guards/assumes themselves and the uses before the |
| 430 | // guard/assume. |
| 431 | static void ReplaceFoldableUses(Instruction *Cond, Value *ToVal) { |
| 432 | assert(Cond->getType() == ToVal->getType()); |
| 433 | auto *BB = Cond->getParent(); |
| 434 | // We can unconditionally replace all uses in non-local blocks (i.e. uses |
| 435 | // strictly dominated by BB), since LVI information is true from the |
| 436 | // terminator of BB. |
| 437 | replaceNonLocalUsesWith(Cond, ToVal); |
| 438 | for (Instruction &I : reverse(*BB)) { |
| 439 | // Reached the Cond whose uses we are trying to replace, so there are no |
| 440 | // more uses. |
| 441 | if (&I == Cond) |
| 442 | break; |
| 443 | // We only replace uses in instructions that are guaranteed to reach the end |
| 444 | // of BB, where we know Cond is ToVal. |
| 445 | if (!isGuaranteedToTransferExecutionToSuccessor(&I)) |
| 446 | break; |
| 447 | I.replaceUsesOfWith(Cond, ToVal); |
| 448 | } |
| 449 | if (Cond->use_empty() && !Cond->mayHaveSideEffects()) |
| 450 | Cond->eraseFromParent(); |
| 451 | } |
| 452 | |
Sanjoy Das | 8b859c2 | 2017-02-17 04:21:14 +0000 | [diff] [blame] | 453 | /// Return the cost of duplicating a piece of this block from first non-phi |
| 454 | /// and before StopAt instruction to thread across it. Stop scanning the block |
| 455 | /// when exceeding the threshold. If duplication is impossible, returns ~0U. |
| 456 | static unsigned getJumpThreadDuplicationCost(BasicBlock *BB, |
| 457 | Instruction *StopAt, |
Nadav Rotem | 2349531 | 2012-12-03 17:34:44 +0000 | [diff] [blame] | 458 | unsigned Threshold) { |
Sanjoy Das | 8b859c2 | 2017-02-17 04:21:14 +0000 | [diff] [blame] | 459 | assert(StopAt->getParent() == BB && "Not an instruction from proper BB?"); |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 460 | /// Ignore PHI nodes, these will be flattened when duplication happens. |
Duncan P. N. Exon Smith | 3a9c9e3 | 2015-10-13 18:26:00 +0000 | [diff] [blame] | 461 | BasicBlock::const_iterator I(BB->getFirstNonPHI()); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 462 | |
Chris Lattner | 3a2ae90 | 2009-11-11 00:21:58 +0000 | [diff] [blame] | 463 | // FIXME: THREADING will delete values that are just used to compute the |
| 464 | // branch, so they shouldn't count against the duplication cost. |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 465 | |
Geoff Berry | 43dc285 | 2015-12-29 18:10:16 +0000 | [diff] [blame] | 466 | unsigned Bonus = 0; |
Sanjoy Das | 8b859c2 | 2017-02-17 04:21:14 +0000 | [diff] [blame] | 467 | if (BB->getTerminator() == StopAt) { |
| 468 | // Threading through a switch statement is particularly profitable. If this |
| 469 | // block ends in a switch, decrease its cost to make it more likely to |
| 470 | // happen. |
| 471 | if (isa<SwitchInst>(StopAt)) |
| 472 | Bonus = 6; |
Geoff Berry | 43dc285 | 2015-12-29 18:10:16 +0000 | [diff] [blame] | 473 | |
Sanjoy Das | 8b859c2 | 2017-02-17 04:21:14 +0000 | [diff] [blame] | 474 | // The same holds for indirect branches, but slightly more so. |
| 475 | if (isa<IndirectBrInst>(StopAt)) |
| 476 | Bonus = 8; |
| 477 | } |
Geoff Berry | 43dc285 | 2015-12-29 18:10:16 +0000 | [diff] [blame] | 478 | |
| 479 | // Bump the threshold up so the early exit from the loop doesn't skip the |
| 480 | // terminator-based Size adjustment at the end. |
| 481 | Threshold += Bonus; |
| 482 | |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 483 | // Sum up the cost of each instruction until we get to the terminator. Don't |
| 484 | // include the terminator because the copy won't include it. |
| 485 | unsigned Size = 0; |
Sanjoy Das | 8b859c2 | 2017-02-17 04:21:14 +0000 | [diff] [blame] | 486 | for (; &*I != StopAt; ++I) { |
Nadav Rotem | 2349531 | 2012-12-03 17:34:44 +0000 | [diff] [blame] | 487 | |
| 488 | // Stop scanning the block if we've reached the threshold. |
| 489 | if (Size > Threshold) |
| 490 | return Size; |
| 491 | |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 492 | // Debugger intrinsics don't incur code size. |
| 493 | if (isa<DbgInfoIntrinsic>(I)) continue; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 494 | |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 495 | // If this is a pointer->pointer bitcast, it is free. |
Duncan Sands | 19d0b47 | 2010-02-16 11:11:14 +0000 | [diff] [blame] | 496 | if (isa<BitCastInst>(I) && I->getType()->isPointerTy()) |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 497 | continue; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 498 | |
David Majnemer | b611e3f | 2015-08-14 05:09:07 +0000 | [diff] [blame] | 499 | // Bail out if this instruction gives back a token type, it is not possible |
David L Kreitzer | da700ce | 2015-09-16 13:27:30 +0000 | [diff] [blame] | 500 | // to duplicate it if it is used outside this BB. |
David Majnemer | b611e3f | 2015-08-14 05:09:07 +0000 | [diff] [blame] | 501 | if (I->getType()->isTokenTy() && I->isUsedOutsideOfBlock(BB)) |
| 502 | return ~0U; |
| 503 | |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 504 | // All other instructions count for at least one unit. |
| 505 | ++Size; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 506 | |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 507 | // Calls are more expensive. If they are non-intrinsic calls, we model them |
| 508 | // as having cost of 4. If they are a non-vector intrinsic, we model them |
| 509 | // as having cost of 2 total, and if they are a vector intrinsic, we model |
| 510 | // them as having cost 1. |
| 511 | if (const CallInst *CI = dyn_cast<CallInst>(I)) { |
Jingyue Wu | e84f671 | 2015-08-31 06:10:27 +0000 | [diff] [blame] | 512 | if (CI->cannotDuplicate() || CI->isConvergent()) |
James Molloy | 4f6fb95 | 2012-12-20 16:04:27 +0000 | [diff] [blame] | 513 | // Blocks with NoDuplicate are modelled as having infinite cost, so they |
| 514 | // are never duplicated. |
| 515 | return ~0U; |
| 516 | else if (!isa<IntrinsicInst>(CI)) |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 517 | Size += 3; |
Duncan Sands | 19d0b47 | 2010-02-16 11:11:14 +0000 | [diff] [blame] | 518 | else if (!CI->getType()->isVectorTy()) |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 519 | Size += 1; |
| 520 | } |
| 521 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 522 | |
Geoff Berry | 43dc285 | 2015-12-29 18:10:16 +0000 | [diff] [blame] | 523 | return Size > Bonus ? Size - Bonus : 0; |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 524 | } |
| 525 | |
Chris Lattner | fa552d7 | 2009-05-04 16:29:24 +0000 | [diff] [blame] | 526 | /// FindLoopHeaders - We do not want jump threading to turn proper loop |
Chris Lattner | d579cb1 | 2009-05-04 02:28:08 +0000 | [diff] [blame] | 527 | /// structures into irreducible loops. Doing this breaks up the loop nesting |
| 528 | /// hierarchy and pessimizes later transformations. To prevent this from |
| 529 | /// happening, we first have to find the loop headers. Here we approximate this |
| 530 | /// by finding targets of backedges in the CFG. |
| 531 | /// |
| 532 | /// Note that there definitely are cases when we want to allow threading of |
| 533 | /// edges across a loop header. For example, threading a jump from outside the |
| 534 | /// loop (the preheader) to an exit block of the loop is definitely profitable. |
| 535 | /// It is also almost always profitable to thread backedges from within the loop |
| 536 | /// to exit blocks, and is often profitable to thread backedges to other blocks |
| 537 | /// within the loop (forming a nested loop). This simple analysis is not rich |
| 538 | /// enough to track all of these properties and keep it up-to-date as the CFG |
| 539 | /// mutates, so we don't allow any of these transformations. |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 540 | void JumpThreadingPass::FindLoopHeaders(Function &F) { |
Chris Lattner | d579cb1 | 2009-05-04 02:28:08 +0000 | [diff] [blame] | 541 | SmallVector<std::pair<const BasicBlock*,const BasicBlock*>, 32> Edges; |
| 542 | FindFunctionBackedges(F, Edges); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 543 | |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 544 | for (const auto &Edge : Edges) |
| 545 | LoopHeaders.insert(Edge.second); |
Chris Lattner | d579cb1 | 2009-05-04 02:28:08 +0000 | [diff] [blame] | 546 | } |
| 547 | |
Frits van Bommel | 7624486 | 2010-12-05 19:06:41 +0000 | [diff] [blame] | 548 | /// getKnownConstant - Helper method to determine if we can thread over a |
| 549 | /// terminator with the given value as its condition, and if so what value to |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 550 | /// use for that. What kind of value this is depends on whether we want an |
| 551 | /// integer or a block address, but an undef is always accepted. |
Frits van Bommel | 7624486 | 2010-12-05 19:06:41 +0000 | [diff] [blame] | 552 | /// Returns null if Val is null or not an appropriate constant. |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 553 | static Constant *getKnownConstant(Value *Val, ConstantPreference Preference) { |
Frits van Bommel | 7624486 | 2010-12-05 19:06:41 +0000 | [diff] [blame] | 554 | if (!Val) |
Craig Topper | f40110f | 2014-04-25 05:29:35 +0000 | [diff] [blame] | 555 | return nullptr; |
Frits van Bommel | 7624486 | 2010-12-05 19:06:41 +0000 | [diff] [blame] | 556 | |
| 557 | // Undef is "known" enough. |
| 558 | if (UndefValue *U = dyn_cast<UndefValue>(Val)) |
| 559 | return U; |
| 560 | |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 561 | if (Preference == WantBlockAddress) |
| 562 | return dyn_cast<BlockAddress>(Val->stripPointerCasts()); |
| 563 | |
Frits van Bommel | 7624486 | 2010-12-05 19:06:41 +0000 | [diff] [blame] | 564 | return dyn_cast<ConstantInt>(Val); |
| 565 | } |
| 566 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 567 | /// ComputeValueKnownInPredecessors - Given a basic block BB and a value V, see |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 568 | /// if we can infer that the value is a known ConstantInt/BlockAddress or undef |
| 569 | /// in any of our predecessors. If so, return the known list of value and pred |
| 570 | /// BB in the result vector. |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 571 | /// |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 572 | /// This returns true if there were any known values. |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 573 | bool JumpThreadingPass::ComputeValueKnownInPredecessors( |
| 574 | Value *V, BasicBlock *BB, PredValueInfo &Result, |
| 575 | ConstantPreference Preference, Instruction *CxtI) { |
Owen Anderson | 6fdcb172 | 2010-08-31 19:24:27 +0000 | [diff] [blame] | 576 | // This method walks up use-def chains recursively. Because of this, we could |
| 577 | // get into an infinite loop going around loops in the use-def chain. To |
| 578 | // prevent this, keep track of what (value, block) pairs we've already visited |
| 579 | // and terminate the search if we loop back to them |
Owen Anderson | 3997a07 | 2010-08-31 07:36:34 +0000 | [diff] [blame] | 580 | if (!RecursionSet.insert(std::make_pair(V, BB)).second) |
| 581 | return false; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 582 | |
Owen Anderson | 6fdcb172 | 2010-08-31 19:24:27 +0000 | [diff] [blame] | 583 | // An RAII help to remove this pair from the recursion set once the recursion |
| 584 | // stack pops back out again. |
| 585 | RecursionSetRemover remover(RecursionSet, std::make_pair(V, BB)); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 586 | |
Frits van Bommel | 7624486 | 2010-12-05 19:06:41 +0000 | [diff] [blame] | 587 | // If V is a constant, then it is known in all predecessors. |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 588 | if (Constant *KC = getKnownConstant(V, Preference)) { |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 589 | for (BasicBlock *Pred : predecessors(BB)) |
| 590 | Result.push_back(std::make_pair(KC, Pred)); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 591 | |
Haicheng Wu | b35f772 | 2016-02-08 17:00:39 +0000 | [diff] [blame] | 592 | return !Result.empty(); |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 593 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 594 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 595 | // If V is a non-instruction value, or an instruction in a different block, |
| 596 | // then it can't be derived from a PHI. |
Haicheng Wu | 64d9d7c | 2016-03-15 23:38:47 +0000 | [diff] [blame] | 597 | Instruction *I = dyn_cast<Instruction>(V); |
Craig Topper | f40110f | 2014-04-25 05:29:35 +0000 | [diff] [blame] | 598 | if (!I || I->getParent() != BB) { |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 599 | |
Chris Lattner | fde1f8d | 2009-11-11 02:08:33 +0000 | [diff] [blame] | 600 | // Okay, if this is a live-in value, see if it has a known value at the end |
| 601 | // of any of our predecessors. |
| 602 | // |
| 603 | // FIXME: This should be an edge property, not a block end property. |
| 604 | /// TODO: Per PR2563, we could infer value range information about a |
| 605 | /// predecessor based on its terminator. |
| 606 | // |
Owen Anderson | d361aac | 2010-09-14 20:57:41 +0000 | [diff] [blame] | 607 | // FIXME: change this to use the more-rich 'getPredicateOnEdge' method if |
| 608 | // "I" is a non-local compare-with-a-constant instruction. This would be |
| 609 | // able to handle value inequalities better, for example if the compare is |
| 610 | // "X < 4" and "X < 3" is known true but "X < 4" itself is not available. |
| 611 | // Perhaps getConstantOnEdge should be smart enough to do this? |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 612 | |
Brian M. Rzycki | f1a7df5 | 2018-02-16 16:35:17 +0000 | [diff] [blame] | 613 | if (DDT->pending()) |
| 614 | LVI->disableDT(); |
| 615 | else |
| 616 | LVI->enableDT(); |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 617 | for (BasicBlock *P : predecessors(BB)) { |
Owen Anderson | d361aac | 2010-09-14 20:57:41 +0000 | [diff] [blame] | 618 | // If the value is known by LazyValueInfo to be a constant in a |
| 619 | // predecessor, use that information to try to thread this block. |
Hal Finkel | 7e18449 | 2014-09-07 20:29:59 +0000 | [diff] [blame] | 620 | Constant *PredCst = LVI->getConstantOnEdge(V, P, BB, CxtI); |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 621 | if (Constant *KC = getKnownConstant(PredCst, Preference)) |
Frits van Bommel | 7624486 | 2010-12-05 19:06:41 +0000 | [diff] [blame] | 622 | Result.push_back(std::make_pair(KC, P)); |
Owen Anderson | d361aac | 2010-09-14 20:57:41 +0000 | [diff] [blame] | 623 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 624 | |
Owen Anderson | d361aac | 2010-09-14 20:57:41 +0000 | [diff] [blame] | 625 | return !Result.empty(); |
Chris Lattner | fde1f8d | 2009-11-11 02:08:33 +0000 | [diff] [blame] | 626 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 627 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 628 | /// If I is a PHI node, then we know the incoming values for any constants. |
| 629 | if (PHINode *PN = dyn_cast<PHINode>(I)) { |
Brian M. Rzycki | f1a7df5 | 2018-02-16 16:35:17 +0000 | [diff] [blame] | 630 | if (DDT->pending()) |
| 631 | LVI->disableDT(); |
| 632 | else |
| 633 | LVI->enableDT(); |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 634 | for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) { |
| 635 | Value *InVal = PN->getIncomingValue(i); |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 636 | if (Constant *KC = getKnownConstant(InVal, Preference)) { |
Frits van Bommel | 7624486 | 2010-12-05 19:06:41 +0000 | [diff] [blame] | 637 | Result.push_back(std::make_pair(KC, PN->getIncomingBlock(i))); |
Owen Anderson | d361aac | 2010-09-14 20:57:41 +0000 | [diff] [blame] | 638 | } else { |
Owen Anderson | bd2ecc7 | 2010-08-26 17:40:24 +0000 | [diff] [blame] | 639 | Constant *CI = LVI->getConstantOnEdge(InVal, |
Hal Finkel | 7e18449 | 2014-09-07 20:29:59 +0000 | [diff] [blame] | 640 | PN->getIncomingBlock(i), |
| 641 | BB, CxtI); |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 642 | if (Constant *KC = getKnownConstant(CI, Preference)) |
| 643 | Result.push_back(std::make_pair(KC, PN->getIncomingBlock(i))); |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 644 | } |
| 645 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 646 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 647 | return !Result.empty(); |
| 648 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 649 | |
Haicheng Wu | 7873857 | 2016-03-16 04:52:52 +0000 | [diff] [blame] | 650 | // Handle Cast instructions. Only see through Cast when the source operand is |
Chad Rosier | 95d9ccb | 2018-03-09 16:43:46 +0000 | [diff] [blame] | 651 | // PHI or Cmp to save the compilation time. |
Haicheng Wu | 7873857 | 2016-03-16 04:52:52 +0000 | [diff] [blame] | 652 | if (CastInst *CI = dyn_cast<CastInst>(I)) { |
| 653 | Value *Source = CI->getOperand(0); |
Haicheng Wu | 7873857 | 2016-03-16 04:52:52 +0000 | [diff] [blame] | 654 | if (!isa<PHINode>(Source) && !isa<CmpInst>(Source)) |
| 655 | return false; |
| 656 | ComputeValueKnownInPredecessors(Source, BB, Result, Preference, CxtI); |
| 657 | if (Result.empty()) |
| 658 | return false; |
| 659 | |
| 660 | // Convert the known values. |
| 661 | for (auto &R : Result) |
| 662 | R.first = ConstantExpr::getCast(CI->getOpcode(), R.first, CI->getType()); |
| 663 | |
| 664 | return true; |
| 665 | } |
| 666 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 667 | // Handle some boolean conditions. |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 668 | if (I->getType()->getPrimitiveSizeInBits() == 1) { |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 669 | assert(Preference == WantInteger && "One-bit non-integer type?"); |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 670 | // X | true -> true |
| 671 | // X & false -> false |
| 672 | if (I->getOpcode() == Instruction::Or || |
| 673 | I->getOpcode() == Instruction::And) { |
Craig Topper | 91259e2 | 2017-10-16 21:54:13 +0000 | [diff] [blame] | 674 | PredValueInfoTy LHSVals, RHSVals; |
| 675 | |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 676 | ComputeValueKnownInPredecessors(I->getOperand(0), BB, LHSVals, |
Haicheng Wu | 64d9d7c | 2016-03-15 23:38:47 +0000 | [diff] [blame] | 677 | WantInteger, CxtI); |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 678 | ComputeValueKnownInPredecessors(I->getOperand(1), BB, RHSVals, |
Haicheng Wu | 64d9d7c | 2016-03-15 23:38:47 +0000 | [diff] [blame] | 679 | WantInteger, CxtI); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 680 | |
Owen Anderson | 6fdcb172 | 2010-08-31 19:24:27 +0000 | [diff] [blame] | 681 | if (LHSVals.empty() && RHSVals.empty()) |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 682 | return false; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 683 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 684 | ConstantInt *InterestingVal; |
| 685 | if (I->getOpcode() == Instruction::Or) |
| 686 | InterestingVal = ConstantInt::getTrue(I->getContext()); |
| 687 | else |
| 688 | InterestingVal = ConstantInt::getFalse(I->getContext()); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 689 | |
Chris Lattner | 3c60302 | 2010-08-18 03:14:36 +0000 | [diff] [blame] | 690 | SmallPtrSet<BasicBlock*, 4> LHSKnownBBs; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 691 | |
Chris Lattner | d924f63 | 2010-02-11 04:40:44 +0000 | [diff] [blame] | 692 | // Scan for the sentinel. If we find an undef, force it to the |
| 693 | // interesting value: x|undef -> true and x&undef -> false. |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 694 | for (const auto &LHSVal : LHSVals) |
| 695 | if (LHSVal.first == InterestingVal || isa<UndefValue>(LHSVal.first)) { |
| 696 | Result.emplace_back(InterestingVal, LHSVal.second); |
| 697 | LHSKnownBBs.insert(LHSVal.second); |
Chris Lattner | d924f63 | 2010-02-11 04:40:44 +0000 | [diff] [blame] | 698 | } |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 699 | for (const auto &RHSVal : RHSVals) |
| 700 | if (RHSVal.first == InterestingVal || isa<UndefValue>(RHSVal.first)) { |
Chris Lattner | bbc25ff | 2010-07-12 00:47:34 +0000 | [diff] [blame] | 701 | // If we already inferred a value for this block on the LHS, don't |
| 702 | // re-add it. |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 703 | if (!LHSKnownBBs.count(RHSVal.second)) |
| 704 | Result.emplace_back(InterestingVal, RHSVal.second); |
Chris Lattner | d924f63 | 2010-02-11 04:40:44 +0000 | [diff] [blame] | 705 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 706 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 707 | return !Result.empty(); |
| 708 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 709 | |
Chris Lattner | 9518fbb | 2009-11-10 22:39:16 +0000 | [diff] [blame] | 710 | // Handle the NOT form of XOR. |
| 711 | if (I->getOpcode() == Instruction::Xor && |
| 712 | isa<ConstantInt>(I->getOperand(1)) && |
| 713 | cast<ConstantInt>(I->getOperand(1))->isOne()) { |
Haicheng Wu | 64d9d7c | 2016-03-15 23:38:47 +0000 | [diff] [blame] | 714 | ComputeValueKnownInPredecessors(I->getOperand(0), BB, Result, |
| 715 | WantInteger, CxtI); |
Owen Anderson | 6fdcb172 | 2010-08-31 19:24:27 +0000 | [diff] [blame] | 716 | if (Result.empty()) |
Chris Lattner | 9518fbb | 2009-11-10 22:39:16 +0000 | [diff] [blame] | 717 | return false; |
| 718 | |
| 719 | // Invert the known values. |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 720 | for (auto &R : Result) |
| 721 | R.first = ConstantExpr::getNot(R.first); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 722 | |
Chris Lattner | 9518fbb | 2009-11-10 22:39:16 +0000 | [diff] [blame] | 723 | return true; |
| 724 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 725 | |
Owen Anderson | bd2ecc7 | 2010-08-26 17:40:24 +0000 | [diff] [blame] | 726 | // Try to simplify some other binary operator values. |
| 727 | } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(I)) { |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 728 | assert(Preference != WantBlockAddress |
| 729 | && "A binary operator creating a block address?"); |
Owen Anderson | 3c84ecb | 2010-08-31 20:26:04 +0000 | [diff] [blame] | 730 | if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->getOperand(1))) { |
Frits van Bommel | 7624486 | 2010-12-05 19:06:41 +0000 | [diff] [blame] | 731 | PredValueInfoTy LHSVals; |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 732 | ComputeValueKnownInPredecessors(BO->getOperand(0), BB, LHSVals, |
Haicheng Wu | 64d9d7c | 2016-03-15 23:38:47 +0000 | [diff] [blame] | 733 | WantInteger, CxtI); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 734 | |
Owen Anderson | 3997a07 | 2010-08-31 07:36:34 +0000 | [diff] [blame] | 735 | // Try to use constant folding to simplify the binary operator. |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 736 | for (const auto &LHSVal : LHSVals) { |
| 737 | Constant *V = LHSVal.first; |
Owen Anderson | 3c84ecb | 2010-08-31 20:26:04 +0000 | [diff] [blame] | 738 | Constant *Folded = ConstantExpr::get(BO->getOpcode(), V, CI); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 739 | |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 740 | if (Constant *KC = getKnownConstant(Folded, WantInteger)) |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 741 | Result.push_back(std::make_pair(KC, LHSVal.second)); |
Owen Anderson | 3997a07 | 2010-08-31 07:36:34 +0000 | [diff] [blame] | 742 | } |
Owen Anderson | bd2ecc7 | 2010-08-26 17:40:24 +0000 | [diff] [blame] | 743 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 744 | |
Owen Anderson | 3997a07 | 2010-08-31 07:36:34 +0000 | [diff] [blame] | 745 | return !Result.empty(); |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 746 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 747 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 748 | // Handle compare with phi operand, where the PHI is defined in this block. |
| 749 | if (CmpInst *Cmp = dyn_cast<CmpInst>(I)) { |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 750 | assert(Preference == WantInteger && "Compares only produce integers"); |
Craig Topper | 7927996 | 2017-06-23 05:41:32 +0000 | [diff] [blame] | 751 | Type *CmpType = Cmp->getType(); |
| 752 | Value *CmpLHS = Cmp->getOperand(0); |
| 753 | Value *CmpRHS = Cmp->getOperand(1); |
| 754 | CmpInst::Predicate Pred = Cmp->getPredicate(); |
| 755 | |
| 756 | PHINode *PN = dyn_cast<PHINode>(CmpLHS); |
Wei Mi | eec5ba9 | 2018-05-01 14:47:24 +0000 | [diff] [blame] | 757 | if (!PN) |
| 758 | PN = dyn_cast<PHINode>(CmpRHS); |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 759 | if (PN && PN->getParent() == BB) { |
Mehdi Amini | a28d91d | 2015-03-10 02:37:25 +0000 | [diff] [blame] | 760 | const DataLayout &DL = PN->getModule()->getDataLayout(); |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 761 | // We can do this simplification if any comparisons fold to true or false. |
| 762 | // See if any do. |
Brian M. Rzycki | f1a7df5 | 2018-02-16 16:35:17 +0000 | [diff] [blame] | 763 | if (DDT->pending()) |
| 764 | LVI->disableDT(); |
| 765 | else |
| 766 | LVI->enableDT(); |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 767 | for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) { |
| 768 | BasicBlock *PredBB = PN->getIncomingBlock(i); |
Wei Mi | eec5ba9 | 2018-05-01 14:47:24 +0000 | [diff] [blame] | 769 | Value *LHS, *RHS; |
| 770 | if (PN == CmpLHS) { |
| 771 | LHS = PN->getIncomingValue(i); |
| 772 | RHS = CmpRHS->DoPHITranslation(BB, PredBB); |
| 773 | } else { |
| 774 | LHS = CmpLHS->DoPHITranslation(BB, PredBB); |
| 775 | RHS = PN->getIncomingValue(i); |
| 776 | } |
Craig Topper | 7927996 | 2017-06-23 05:41:32 +0000 | [diff] [blame] | 777 | Value *Res = SimplifyCmpInst(Pred, LHS, RHS, {DL}); |
Craig Topper | f40110f | 2014-04-25 05:29:35 +0000 | [diff] [blame] | 778 | if (!Res) { |
Owen Anderson | d361aac | 2010-09-14 20:57:41 +0000 | [diff] [blame] | 779 | if (!isa<Constant>(RHS)) |
Chris Lattner | 5f6b8b2 | 2009-11-12 05:24:05 +0000 | [diff] [blame] | 780 | continue; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 781 | |
Wei Mi | eec5ba9 | 2018-05-01 14:47:24 +0000 | [diff] [blame] | 782 | // getPredicateOnEdge call will make no sense if LHS is defined in BB. |
| 783 | auto LHSInst = dyn_cast<Instruction>(LHS); |
| 784 | if (LHSInst && LHSInst->getParent() == BB) |
| 785 | continue; |
| 786 | |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 787 | LazyValueInfo::Tristate |
Craig Topper | 7927996 | 2017-06-23 05:41:32 +0000 | [diff] [blame] | 788 | ResT = LVI->getPredicateOnEdge(Pred, LHS, |
Hal Finkel | 7e18449 | 2014-09-07 20:29:59 +0000 | [diff] [blame] | 789 | cast<Constant>(RHS), PredBB, BB, |
| 790 | CxtI ? CxtI : Cmp); |
Chris Lattner | 5f6b8b2 | 2009-11-12 05:24:05 +0000 | [diff] [blame] | 791 | if (ResT == LazyValueInfo::Unknown) |
| 792 | continue; |
| 793 | Res = ConstantInt::get(Type::getInt1Ty(LHS->getContext()), ResT); |
| 794 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 795 | |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 796 | if (Constant *KC = getKnownConstant(Res, WantInteger)) |
| 797 | Result.push_back(std::make_pair(KC, PredBB)); |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 798 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 799 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 800 | return !Result.empty(); |
| 801 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 802 | |
Chris Lattner | 6714669 | 2009-11-11 22:31:38 +0000 | [diff] [blame] | 803 | // If comparing a live-in value against a constant, see if we know the |
| 804 | // live-in value on any predecessors. |
Craig Topper | 7927996 | 2017-06-23 05:41:32 +0000 | [diff] [blame] | 805 | if (isa<Constant>(CmpRHS) && !CmpType->isVectorTy()) { |
| 806 | Constant *CmpConst = cast<Constant>(CmpRHS); |
Craig Topper | 930689a | 2017-05-04 21:45:45 +0000 | [diff] [blame] | 807 | |
Craig Topper | 7927996 | 2017-06-23 05:41:32 +0000 | [diff] [blame] | 808 | if (!isa<Instruction>(CmpLHS) || |
| 809 | cast<Instruction>(CmpLHS)->getParent() != BB) { |
Brian M. Rzycki | f1a7df5 | 2018-02-16 16:35:17 +0000 | [diff] [blame] | 810 | if (DDT->pending()) |
| 811 | LVI->disableDT(); |
| 812 | else |
| 813 | LVI->enableDT(); |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 814 | for (BasicBlock *P : predecessors(BB)) { |
Owen Anderson | bd2ecc7 | 2010-08-26 17:40:24 +0000 | [diff] [blame] | 815 | // If the value is known by LazyValueInfo to be a constant in a |
| 816 | // predecessor, use that information to try to thread this block. |
| 817 | LazyValueInfo::Tristate Res = |
Craig Topper | 7927996 | 2017-06-23 05:41:32 +0000 | [diff] [blame] | 818 | LVI->getPredicateOnEdge(Pred, CmpLHS, |
Craig Topper | 930689a | 2017-05-04 21:45:45 +0000 | [diff] [blame] | 819 | CmpConst, P, BB, CxtI ? CxtI : Cmp); |
Owen Anderson | bd2ecc7 | 2010-08-26 17:40:24 +0000 | [diff] [blame] | 820 | if (Res == LazyValueInfo::Unknown) |
| 821 | continue; |
Chris Lattner | c893c4ed | 2009-11-12 04:37:50 +0000 | [diff] [blame] | 822 | |
Craig Topper | 7927996 | 2017-06-23 05:41:32 +0000 | [diff] [blame] | 823 | Constant *ResC = ConstantInt::get(CmpType, Res); |
Frits van Bommel | 7624486 | 2010-12-05 19:06:41 +0000 | [diff] [blame] | 824 | Result.push_back(std::make_pair(ResC, P)); |
Owen Anderson | bd2ecc7 | 2010-08-26 17:40:24 +0000 | [diff] [blame] | 825 | } |
| 826 | |
| 827 | return !Result.empty(); |
Chris Lattner | 6714669 | 2009-11-11 22:31:38 +0000 | [diff] [blame] | 828 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 829 | |
Craig Topper | 2c20c42 | 2017-06-23 05:41:35 +0000 | [diff] [blame] | 830 | // InstCombine can fold some forms of constant range checks into |
| 831 | // (icmp (add (x, C1)), C2). See if we have we have such a thing with |
| 832 | // x as a live-in. |
| 833 | { |
| 834 | using namespace PatternMatch; |
Eugene Zelenko | 8002c50 | 2017-09-13 21:43:53 +0000 | [diff] [blame] | 835 | |
Craig Topper | 2c20c42 | 2017-06-23 05:41:35 +0000 | [diff] [blame] | 836 | Value *AddLHS; |
| 837 | ConstantInt *AddConst; |
| 838 | if (isa<ConstantInt>(CmpConst) && |
| 839 | match(CmpLHS, m_Add(m_Value(AddLHS), m_ConstantInt(AddConst)))) { |
| 840 | if (!isa<Instruction>(AddLHS) || |
| 841 | cast<Instruction>(AddLHS)->getParent() != BB) { |
Brian M. Rzycki | f1a7df5 | 2018-02-16 16:35:17 +0000 | [diff] [blame] | 842 | if (DDT->pending()) |
| 843 | LVI->disableDT(); |
| 844 | else |
| 845 | LVI->enableDT(); |
Craig Topper | 2c20c42 | 2017-06-23 05:41:35 +0000 | [diff] [blame] | 846 | for (BasicBlock *P : predecessors(BB)) { |
| 847 | // If the value is known by LazyValueInfo to be a ConstantRange in |
| 848 | // a predecessor, use that information to try to thread this |
| 849 | // block. |
| 850 | ConstantRange CR = LVI->getConstantRangeOnEdge( |
| 851 | AddLHS, P, BB, CxtI ? CxtI : cast<Instruction>(CmpLHS)); |
| 852 | // Propagate the range through the addition. |
| 853 | CR = CR.add(AddConst->getValue()); |
| 854 | |
| 855 | // Get the range where the compare returns true. |
| 856 | ConstantRange CmpRange = ConstantRange::makeExactICmpRegion( |
| 857 | Pred, cast<ConstantInt>(CmpConst)->getValue()); |
| 858 | |
| 859 | Constant *ResC; |
| 860 | if (CmpRange.contains(CR)) |
| 861 | ResC = ConstantInt::getTrue(CmpType); |
| 862 | else if (CmpRange.inverse().contains(CR)) |
| 863 | ResC = ConstantInt::getFalse(CmpType); |
| 864 | else |
| 865 | continue; |
| 866 | |
| 867 | Result.push_back(std::make_pair(ResC, P)); |
| 868 | } |
| 869 | |
| 870 | return !Result.empty(); |
| 871 | } |
| 872 | } |
| 873 | } |
| 874 | |
Owen Anderson | 3997a07 | 2010-08-31 07:36:34 +0000 | [diff] [blame] | 875 | // Try to find a constant value for the LHS of a comparison, |
Owen Anderson | bd2ecc7 | 2010-08-26 17:40:24 +0000 | [diff] [blame] | 876 | // and evaluate it statically if we can. |
Craig Topper | 930689a | 2017-05-04 21:45:45 +0000 | [diff] [blame] | 877 | PredValueInfoTy LHSVals; |
| 878 | ComputeValueKnownInPredecessors(I->getOperand(0), BB, LHSVals, |
| 879 | WantInteger, CxtI); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 880 | |
Craig Topper | 930689a | 2017-05-04 21:45:45 +0000 | [diff] [blame] | 881 | for (const auto &LHSVal : LHSVals) { |
| 882 | Constant *V = LHSVal.first; |
Craig Topper | 7927996 | 2017-06-23 05:41:32 +0000 | [diff] [blame] | 883 | Constant *Folded = ConstantExpr::getCompare(Pred, V, CmpConst); |
Craig Topper | 930689a | 2017-05-04 21:45:45 +0000 | [diff] [blame] | 884 | if (Constant *KC = getKnownConstant(Folded, WantInteger)) |
| 885 | Result.push_back(std::make_pair(KC, LHSVal.second)); |
Owen Anderson | bd2ecc7 | 2010-08-26 17:40:24 +0000 | [diff] [blame] | 886 | } |
Craig Topper | 930689a | 2017-05-04 21:45:45 +0000 | [diff] [blame] | 887 | |
| 888 | return !Result.empty(); |
Chris Lattner | 6714669 | 2009-11-11 22:31:38 +0000 | [diff] [blame] | 889 | } |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 890 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 891 | |
Frits van Bommel | 3d18034 | 2010-12-15 09:51:20 +0000 | [diff] [blame] | 892 | if (SelectInst *SI = dyn_cast<SelectInst>(I)) { |
| 893 | // Handle select instructions where at least one operand is a known constant |
| 894 | // and we can figure out the condition value for any predecessor block. |
| 895 | Constant *TrueVal = getKnownConstant(SI->getTrueValue(), Preference); |
| 896 | Constant *FalseVal = getKnownConstant(SI->getFalseValue(), Preference); |
| 897 | PredValueInfoTy Conds; |
| 898 | if ((TrueVal || FalseVal) && |
| 899 | ComputeValueKnownInPredecessors(SI->getCondition(), BB, Conds, |
Haicheng Wu | 64d9d7c | 2016-03-15 23:38:47 +0000 | [diff] [blame] | 900 | WantInteger, CxtI)) { |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 901 | for (auto &C : Conds) { |
| 902 | Constant *Cond = C.first; |
Frits van Bommel | 3d18034 | 2010-12-15 09:51:20 +0000 | [diff] [blame] | 903 | |
| 904 | // Figure out what value to use for the condition. |
| 905 | bool KnownCond; |
| 906 | if (ConstantInt *CI = dyn_cast<ConstantInt>(Cond)) { |
| 907 | // A known boolean. |
| 908 | KnownCond = CI->isOne(); |
| 909 | } else { |
| 910 | assert(isa<UndefValue>(Cond) && "Unexpected condition value"); |
| 911 | // Either operand will do, so be sure to pick the one that's a known |
| 912 | // constant. |
| 913 | // FIXME: Do this more cleverly if both values are known constants? |
Craig Topper | f40110f | 2014-04-25 05:29:35 +0000 | [diff] [blame] | 914 | KnownCond = (TrueVal != nullptr); |
Frits van Bommel | 3d18034 | 2010-12-15 09:51:20 +0000 | [diff] [blame] | 915 | } |
| 916 | |
| 917 | // See if the select has a known constant value for this predecessor. |
| 918 | if (Constant *Val = KnownCond ? TrueVal : FalseVal) |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 919 | Result.push_back(std::make_pair(Val, C.second)); |
Frits van Bommel | 3d18034 | 2010-12-15 09:51:20 +0000 | [diff] [blame] | 920 | } |
| 921 | |
| 922 | return !Result.empty(); |
| 923 | } |
| 924 | } |
| 925 | |
Owen Anderson | d361aac | 2010-09-14 20:57:41 +0000 | [diff] [blame] | 926 | // If all else fails, see if LVI can figure out a constant value for us. |
Brian M. Rzycki | f1a7df5 | 2018-02-16 16:35:17 +0000 | [diff] [blame] | 927 | if (DDT->pending()) |
| 928 | LVI->disableDT(); |
| 929 | else |
| 930 | LVI->enableDT(); |
Hal Finkel | 7e18449 | 2014-09-07 20:29:59 +0000 | [diff] [blame] | 931 | Constant *CI = LVI->getConstant(V, BB, CxtI); |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 932 | if (Constant *KC = getKnownConstant(CI, Preference)) { |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 933 | for (BasicBlock *Pred : predecessors(BB)) |
| 934 | Result.push_back(std::make_pair(KC, Pred)); |
Owen Anderson | bd2ecc7 | 2010-08-26 17:40:24 +0000 | [diff] [blame] | 935 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 936 | |
Owen Anderson | d361aac | 2010-09-14 20:57:41 +0000 | [diff] [blame] | 937 | return !Result.empty(); |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 938 | } |
| 939 | |
Chris Lattner | f99a74e | 2009-10-11 04:18:15 +0000 | [diff] [blame] | 940 | /// GetBestDestForBranchOnUndef - If we determine that the specified block ends |
| 941 | /// in an undefined jump, decide which block is best to revector to. |
| 942 | /// |
| 943 | /// Since we can pick an arbitrary destination, we pick the successor with the |
| 944 | /// fewest predecessors. This should reduce the in-degree of the others. |
Chris Lattner | f99a74e | 2009-10-11 04:18:15 +0000 | [diff] [blame] | 945 | static unsigned GetBestDestForJumpOnUndef(BasicBlock *BB) { |
| 946 | TerminatorInst *BBTerm = BB->getTerminator(); |
| 947 | unsigned MinSucc = 0; |
| 948 | BasicBlock *TestBB = BBTerm->getSuccessor(MinSucc); |
| 949 | // Compute the successor with the minimum number of predecessors. |
Vedant Kumar | e0b5f86 | 2018-05-10 23:01:54 +0000 | [diff] [blame] | 950 | unsigned MinNumPreds = pred_size(TestBB); |
Chris Lattner | f99a74e | 2009-10-11 04:18:15 +0000 | [diff] [blame] | 951 | for (unsigned i = 1, e = BBTerm->getNumSuccessors(); i != e; ++i) { |
| 952 | TestBB = BBTerm->getSuccessor(i); |
Vedant Kumar | e0b5f86 | 2018-05-10 23:01:54 +0000 | [diff] [blame] | 953 | unsigned NumPreds = pred_size(TestBB); |
Jakub Staszak | 423651e | 2011-06-27 21:51:12 +0000 | [diff] [blame] | 954 | if (NumPreds < MinNumPreds) { |
Chris Lattner | f99a74e | 2009-10-11 04:18:15 +0000 | [diff] [blame] | 955 | MinSucc = i; |
Jakub Staszak | 423651e | 2011-06-27 21:51:12 +0000 | [diff] [blame] | 956 | MinNumPreds = NumPreds; |
| 957 | } |
Chris Lattner | f99a74e | 2009-10-11 04:18:15 +0000 | [diff] [blame] | 958 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 959 | |
Chris Lattner | f99a74e | 2009-10-11 04:18:15 +0000 | [diff] [blame] | 960 | return MinSucc; |
| 961 | } |
| 962 | |
Chris Lattner | 1a924e7 | 2011-02-18 04:43:06 +0000 | [diff] [blame] | 963 | static bool hasAddressTakenAndUsed(BasicBlock *BB) { |
| 964 | if (!BB->hasAddressTaken()) return false; |
Owen Anderson | 92651ec | 2011-04-14 21:35:50 +0000 | [diff] [blame] | 965 | |
Chris Lattner | 1a924e7 | 2011-02-18 04:43:06 +0000 | [diff] [blame] | 966 | // If the block has its address taken, it may be a tree of dead constants |
| 967 | // hanging off of it. These shouldn't keep the block alive. |
| 968 | BlockAddress *BA = BlockAddress::get(BB); |
| 969 | BA->removeDeadConstantUsers(); |
| 970 | return !BA->use_empty(); |
| 971 | } |
| 972 | |
Chris Lattner | 240051a | 2008-11-27 07:20:04 +0000 | [diff] [blame] | 973 | /// ProcessBlock - If there are any predecessors whose control can be threaded |
Chris Lattner | 2115722 | 2008-04-20 21:13:06 +0000 | [diff] [blame] | 974 | /// through to a successor, transform them now. |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 975 | bool JumpThreadingPass::ProcessBlock(BasicBlock *BB) { |
Chris Lattner | de5ab486 | 2010-01-23 18:56:07 +0000 | [diff] [blame] | 976 | // If the block is trivially dead, just return and let the caller nuke it. |
| 977 | // This simplifies other transformations. |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 978 | if (DDT->pendingDeletedBB(BB) || |
| 979 | (pred_empty(BB) && BB != &BB->getParent()->getEntryBlock())) |
Chris Lattner | de5ab486 | 2010-01-23 18:56:07 +0000 | [diff] [blame] | 980 | return false; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 981 | |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 982 | // If this block has a single predecessor, and if that pred has a single |
| 983 | // successor, merge the blocks. This encourages recursive jump threading |
| 984 | // because now the condition in this block can be threaded through |
| 985 | // predecessors of our predecessor block. |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 986 | if (BasicBlock *SinglePred = BB->getSinglePredecessor()) { |
David Majnemer | 654e130 | 2015-07-31 17:58:14 +0000 | [diff] [blame] | 987 | const TerminatorInst *TI = SinglePred->getTerminator(); |
| 988 | if (!TI->isExceptional() && TI->getNumSuccessors() == 1 && |
Chris Lattner | 1a924e7 | 2011-02-18 04:43:06 +0000 | [diff] [blame] | 989 | SinglePred != BB && !hasAddressTakenAndUsed(BB)) { |
Chris Lattner | d579cb1 | 2009-05-04 02:28:08 +0000 | [diff] [blame] | 990 | // If SinglePred was a loop header, BB becomes one. |
| 991 | if (LoopHeaders.erase(SinglePred)) |
| 992 | LoopHeaders.insert(BB); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 993 | |
Igor Laevsky | 87f0d0e | 2016-06-16 16:25:53 +0000 | [diff] [blame] | 994 | LVI->eraseBlock(SinglePred); |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 995 | MergeBasicBlockIntoOnlyPred(BB, nullptr, DDT); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 996 | |
Anna Thomas | 7949f45 | 2017-06-19 15:23:33 +0000 | [diff] [blame] | 997 | // Now that BB is merged into SinglePred (i.e. SinglePred Code followed by |
| 998 | // BB code within one basic block `BB`), we need to invalidate the LVI |
| 999 | // information associated with BB, because the LVI information need not be |
| 1000 | // true for all of BB after the merge. For example, |
| 1001 | // Before the merge, LVI info and code is as follows: |
| 1002 | // SinglePred: <LVI info1 for %p val> |
| 1003 | // %y = use of %p |
| 1004 | // call @exit() // need not transfer execution to successor. |
| 1005 | // assume(%p) // from this point on %p is true |
| 1006 | // br label %BB |
| 1007 | // BB: <LVI info2 for %p val, i.e. %p is true> |
| 1008 | // %x = use of %p |
| 1009 | // br label exit |
| 1010 | // |
| 1011 | // Note that this LVI info for blocks BB and SinglPred is correct for %p |
| 1012 | // (info2 and info1 respectively). After the merge and the deletion of the |
| 1013 | // LVI info1 for SinglePred. We have the following code: |
| 1014 | // BB: <LVI info2 for %p val> |
| 1015 | // %y = use of %p |
| 1016 | // call @exit() |
| 1017 | // assume(%p) |
| 1018 | // %x = use of %p <-- LVI info2 is correct from here onwards. |
| 1019 | // br label exit |
| 1020 | // LVI info2 for BB is incorrect at the beginning of BB. |
| 1021 | |
| 1022 | // Invalidate LVI information for BB if the LVI is not provably true for |
| 1023 | // all of BB. |
Philip Reames | fbffd12 | 2018-03-08 21:25:30 +0000 | [diff] [blame] | 1024 | if (!isGuaranteedToTransferExecutionToSuccessor(BB)) |
Anna Thomas | 7949f45 | 2017-06-19 15:23:33 +0000 | [diff] [blame] | 1025 | LVI->eraseBlock(BB); |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1026 | return true; |
| 1027 | } |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1028 | } |
| 1029 | |
Haicheng Wu | a6a3279 | 2016-01-08 19:39:39 +0000 | [diff] [blame] | 1030 | if (TryToUnfoldSelectInCurrBB(BB)) |
| 1031 | return true; |
| 1032 | |
Sanjoy Das | 8b859c2 | 2017-02-17 04:21:14 +0000 | [diff] [blame] | 1033 | // Look if we can propagate guards to predecessors. |
| 1034 | if (HasGuards && ProcessGuards(BB)) |
| 1035 | return true; |
| 1036 | |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 1037 | // What kind of constant we're looking for. |
| 1038 | ConstantPreference Preference = WantInteger; |
| 1039 | |
| 1040 | // Look to see if the terminator is a conditional branch, switch or indirect |
| 1041 | // branch, if not we can't thread it. |
Chris Lattner | 2115722 | 2008-04-20 21:13:06 +0000 | [diff] [blame] | 1042 | Value *Condition; |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 1043 | Instruction *Terminator = BB->getTerminator(); |
| 1044 | if (BranchInst *BI = dyn_cast<BranchInst>(Terminator)) { |
Chris Lattner | ff1c6e3 | 2008-04-20 22:39:42 +0000 | [diff] [blame] | 1045 | // Can't thread an unconditional jump. |
| 1046 | if (BI->isUnconditional()) return false; |
Chris Lattner | 2115722 | 2008-04-20 21:13:06 +0000 | [diff] [blame] | 1047 | Condition = BI->getCondition(); |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 1048 | } else if (SwitchInst *SI = dyn_cast<SwitchInst>(Terminator)) { |
Chris Lattner | 2115722 | 2008-04-20 21:13:06 +0000 | [diff] [blame] | 1049 | Condition = SI->getCondition(); |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 1050 | } else if (IndirectBrInst *IB = dyn_cast<IndirectBrInst>(Terminator)) { |
Richard Osborne | 0ab2b0d | 2012-07-20 10:36:17 +0000 | [diff] [blame] | 1051 | // Can't thread indirect branch with no successors. |
| 1052 | if (IB->getNumSuccessors() == 0) return false; |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 1053 | Condition = IB->getAddress()->stripPointerCasts(); |
| 1054 | Preference = WantBlockAddress; |
| 1055 | } else { |
Chris Lattner | 2115722 | 2008-04-20 21:13:06 +0000 | [diff] [blame] | 1056 | return false; // Must be an invoke. |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 1057 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1058 | |
Owen Anderson | 92651ec | 2011-04-14 21:35:50 +0000 | [diff] [blame] | 1059 | // Run constant folding to see if we can reduce the condition to a simple |
| 1060 | // constant. |
| 1061 | if (Instruction *I = dyn_cast<Instruction>(Condition)) { |
Mehdi Amini | a28d91d | 2015-03-10 02:37:25 +0000 | [diff] [blame] | 1062 | Value *SimpleVal = |
| 1063 | ConstantFoldInstruction(I, BB->getModule()->getDataLayout(), TLI); |
Owen Anderson | 92651ec | 2011-04-14 21:35:50 +0000 | [diff] [blame] | 1064 | if (SimpleVal) { |
| 1065 | I->replaceAllUsesWith(SimpleVal); |
David Majnemer | 522a911 | 2016-07-22 04:54:44 +0000 | [diff] [blame] | 1066 | if (isInstructionTriviallyDead(I, TLI)) |
| 1067 | I->eraseFromParent(); |
Owen Anderson | 92651ec | 2011-04-14 21:35:50 +0000 | [diff] [blame] | 1068 | Condition = SimpleVal; |
| 1069 | } |
| 1070 | } |
| 1071 | |
Chris Lattner | 595c727 | 2008-12-03 07:48:08 +0000 | [diff] [blame] | 1072 | // If the terminator is branching on an undef, we can pick any of the |
Chris Lattner | f99a74e | 2009-10-11 04:18:15 +0000 | [diff] [blame] | 1073 | // successors to branch to. Let GetBestDestForJumpOnUndef decide. |
Chris Lattner | 595c727 | 2008-12-03 07:48:08 +0000 | [diff] [blame] | 1074 | if (isa<UndefValue>(Condition)) { |
Chris Lattner | f99a74e | 2009-10-11 04:18:15 +0000 | [diff] [blame] | 1075 | unsigned BestSucc = GetBestDestForJumpOnUndef(BB); |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 1076 | std::vector<DominatorTree::UpdateType> Updates; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1077 | |
Chris Lattner | 595c727 | 2008-12-03 07:48:08 +0000 | [diff] [blame] | 1078 | // Fold the branch/switch. |
Chris Lattner | f99a74e | 2009-10-11 04:18:15 +0000 | [diff] [blame] | 1079 | TerminatorInst *BBTerm = BB->getTerminator(); |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 1080 | Updates.reserve(BBTerm->getNumSuccessors()); |
Chris Lattner | 595c727 | 2008-12-03 07:48:08 +0000 | [diff] [blame] | 1081 | for (unsigned i = 0, e = BBTerm->getNumSuccessors(); i != e; ++i) { |
Chris Lattner | f99a74e | 2009-10-11 04:18:15 +0000 | [diff] [blame] | 1082 | if (i == BestSucc) continue; |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 1083 | BasicBlock *Succ = BBTerm->getSuccessor(i); |
| 1084 | Succ->removePredecessor(BB, true); |
| 1085 | Updates.push_back({DominatorTree::Delete, BB, Succ}); |
Chris Lattner | 595c727 | 2008-12-03 07:48:08 +0000 | [diff] [blame] | 1086 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1087 | |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 1088 | LLVM_DEBUG(dbgs() << " In block '" << BB->getName() |
| 1089 | << "' folding undef terminator: " << *BBTerm << '\n'); |
Chris Lattner | f99a74e | 2009-10-11 04:18:15 +0000 | [diff] [blame] | 1090 | BranchInst::Create(BBTerm->getSuccessor(BestSucc), BBTerm); |
Chris Lattner | 595c727 | 2008-12-03 07:48:08 +0000 | [diff] [blame] | 1091 | BBTerm->eraseFromParent(); |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 1092 | DDT->applyUpdates(Updates); |
Chris Lattner | 595c727 | 2008-12-03 07:48:08 +0000 | [diff] [blame] | 1093 | return true; |
| 1094 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1095 | |
Frits van Bommel | 7624486 | 2010-12-05 19:06:41 +0000 | [diff] [blame] | 1096 | // If the terminator of this block is branching on a constant, simplify the |
| 1097 | // terminator to an unconditional branch. This can occur due to threading in |
| 1098 | // other blocks. |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 1099 | if (getKnownConstant(Condition, Preference)) { |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 1100 | LLVM_DEBUG(dbgs() << " In block '" << BB->getName() |
| 1101 | << "' folding terminator: " << *BB->getTerminator() |
| 1102 | << '\n'); |
Frits van Bommel | 7624486 | 2010-12-05 19:06:41 +0000 | [diff] [blame] | 1103 | ++NumFolds; |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 1104 | ConstantFoldTerminator(BB, true, nullptr, DDT); |
Frits van Bommel | 7624486 | 2010-12-05 19:06:41 +0000 | [diff] [blame] | 1105 | return true; |
| 1106 | } |
| 1107 | |
Chris Lattner | 595c727 | 2008-12-03 07:48:08 +0000 | [diff] [blame] | 1108 | Instruction *CondInst = dyn_cast<Instruction>(Condition); |
| 1109 | |
Chris Lattner | 595c727 | 2008-12-03 07:48:08 +0000 | [diff] [blame] | 1110 | // All the rest of our checks depend on the condition being an instruction. |
Craig Topper | f40110f | 2014-04-25 05:29:35 +0000 | [diff] [blame] | 1111 | if (!CondInst) { |
Chris Lattner | ba45616 | 2009-11-12 01:41:34 +0000 | [diff] [blame] | 1112 | // FIXME: Unify this with code below. |
Hal Finkel | 7e18449 | 2014-09-07 20:29:59 +0000 | [diff] [blame] | 1113 | if (ProcessThreadableEdges(Condition, BB, Preference, Terminator)) |
Chris Lattner | ba45616 | 2009-11-12 01:41:34 +0000 | [diff] [blame] | 1114 | return true; |
Chris Lattner | 595c727 | 2008-12-03 07:48:08 +0000 | [diff] [blame] | 1115 | return false; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1116 | } |
| 1117 | |
Nick Lewycky | 77585a2 | 2009-06-19 04:56:29 +0000 | [diff] [blame] | 1118 | if (CmpInst *CondCmp = dyn_cast<CmpInst>(CondInst)) { |
Philip Reames | 66ab0f0 | 2015-06-16 00:49:59 +0000 | [diff] [blame] | 1119 | // If we're branching on a conditional, LVI might be able to determine |
Eric Christopher | 572e03a | 2015-06-19 01:53:21 +0000 | [diff] [blame] | 1120 | // it's value at the branch instruction. We only handle comparisons |
Philip Reames | 66ab0f0 | 2015-06-16 00:49:59 +0000 | [diff] [blame] | 1121 | // against a constant at this time. |
Larisse Voufo | 532bf71 | 2015-09-18 19:14:35 +0000 | [diff] [blame] | 1122 | // TODO: This should be extended to handle switches as well. |
Owen Anderson | 6ebbd92 | 2010-08-27 17:12:29 +0000 | [diff] [blame] | 1123 | BranchInst *CondBr = dyn_cast<BranchInst>(BB->getTerminator()); |
| 1124 | Constant *CondConst = dyn_cast<Constant>(CondCmp->getOperand(1)); |
Xin Tong | ac2b576 | 2017-03-07 18:59:09 +0000 | [diff] [blame] | 1125 | if (CondBr && CondConst) { |
| 1126 | // We should have returned as soon as we turn a conditional branch to |
| 1127 | // unconditional. Because its no longer interesting as far as jump |
| 1128 | // threading is concerned. |
| 1129 | assert(CondBr->isConditional() && "Threading on unconditional terminator"); |
| 1130 | |
Brian M. Rzycki | f1a7df5 | 2018-02-16 16:35:17 +0000 | [diff] [blame] | 1131 | if (DDT->pending()) |
| 1132 | LVI->disableDT(); |
| 1133 | else |
| 1134 | LVI->enableDT(); |
Hal Finkel | 7e18449 | 2014-09-07 20:29:59 +0000 | [diff] [blame] | 1135 | LazyValueInfo::Tristate Ret = |
| 1136 | LVI->getPredicateAt(CondCmp->getPredicate(), CondCmp->getOperand(0), |
Philip Reames | 66ab0f0 | 2015-06-16 00:49:59 +0000 | [diff] [blame] | 1137 | CondConst, CondBr); |
Hal Finkel | 7e18449 | 2014-09-07 20:29:59 +0000 | [diff] [blame] | 1138 | if (Ret != LazyValueInfo::Unknown) { |
| 1139 | unsigned ToRemove = Ret == LazyValueInfo::True ? 1 : 0; |
| 1140 | unsigned ToKeep = Ret == LazyValueInfo::True ? 0 : 1; |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 1141 | BasicBlock *ToRemoveSucc = CondBr->getSuccessor(ToRemove); |
| 1142 | ToRemoveSucc->removePredecessor(BB, true); |
Hal Finkel | 7e18449 | 2014-09-07 20:29:59 +0000 | [diff] [blame] | 1143 | BranchInst::Create(CondBr->getSuccessor(ToKeep), CondBr); |
| 1144 | CondBr->eraseFromParent(); |
Philip Reames | 66ab0f0 | 2015-06-16 00:49:59 +0000 | [diff] [blame] | 1145 | if (CondCmp->use_empty()) |
| 1146 | CondCmp->eraseFromParent(); |
Anna Thomas | c07d554 | 2017-05-23 13:36:25 +0000 | [diff] [blame] | 1147 | // We can safely replace *some* uses of the CondInst if it has |
Anna Thomas | 7bca591 | 2017-05-18 13:12:18 +0000 | [diff] [blame] | 1148 | // exactly one value as returned by LVI. RAUW is incorrect in the |
| 1149 | // presence of guards and assumes, that have the `Cond` as the use. This |
| 1150 | // is because we use the guards/assume to reason about the `Cond` value |
| 1151 | // at the end of block, but RAUW unconditionally replaces all uses |
| 1152 | // including the guards/assumes themselves and the uses before the |
| 1153 | // guard/assume. |
Anna Thomas | c07d554 | 2017-05-23 13:36:25 +0000 | [diff] [blame] | 1154 | else if (CondCmp->getParent() == BB) { |
| 1155 | auto *CI = Ret == LazyValueInfo::True ? |
| 1156 | ConstantInt::getTrue(CondCmp->getType()) : |
| 1157 | ConstantInt::getFalse(CondCmp->getType()); |
| 1158 | ReplaceFoldableUses(CondCmp, CI); |
| 1159 | } |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 1160 | DDT->deleteEdge(BB, ToRemoveSucc); |
Hal Finkel | 7e18449 | 2014-09-07 20:29:59 +0000 | [diff] [blame] | 1161 | return true; |
| 1162 | } |
Benjamin Kramer | 6a4976d | 2013-08-07 10:29:38 +0000 | [diff] [blame] | 1163 | |
Xin Tong | ac2b576 | 2017-03-07 18:59:09 +0000 | [diff] [blame] | 1164 | // We did not manage to simplify this branch, try to see whether |
| 1165 | // CondCmp depends on a known phi-select pattern. |
| 1166 | if (TryToUnfoldSelect(CondCmp, BB)) |
| 1167 | return true; |
| 1168 | } |
Nick Lewycky | 77585a2 | 2009-06-19 04:56:29 +0000 | [diff] [blame] | 1169 | } |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1170 | |
| 1171 | // Check for some cases that are worth simplifying. Right now we want to look |
| 1172 | // for loads that are used by a switch or by the condition for the branch. If |
| 1173 | // we see one, check to see if it's partially redundant. If so, insert a PHI |
| 1174 | // which can then be used to thread the values. |
Chris Lattner | 595c727 | 2008-12-03 07:48:08 +0000 | [diff] [blame] | 1175 | Value *SimplifyValue = CondInst; |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1176 | if (CmpInst *CondCmp = dyn_cast<CmpInst>(SimplifyValue)) |
| 1177 | if (isa<Constant>(CondCmp->getOperand(1))) |
| 1178 | SimplifyValue = CondCmp->getOperand(0); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1179 | |
Chris Lattner | 9d9812a | 2009-11-15 19:58:31 +0000 | [diff] [blame] | 1180 | // TODO: There are other places where load PRE would be profitable, such as |
| 1181 | // more complex comparisons. |
Brian M. Rzycki | 994e889 | 2018-01-29 21:29:44 +0000 | [diff] [blame] | 1182 | if (LoadInst *LoadI = dyn_cast<LoadInst>(SimplifyValue)) |
| 1183 | if (SimplifyPartiallyRedundantLoad(LoadI)) |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1184 | return true; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1185 | |
Xinliang David Li | 66531dd | 2017-08-24 22:54:01 +0000 | [diff] [blame] | 1186 | // Before threading, try to propagate profile data backwards: |
| 1187 | if (PHINode *PN = dyn_cast<PHINode>(CondInst)) |
| 1188 | if (PN->getParent() == BB && isa<BranchInst>(BB->getTerminator())) |
| 1189 | updatePredecessorProfileMetadata(PN, BB); |
| 1190 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1191 | // Handle a variety of cases where we are branching on something derived from |
| 1192 | // a PHI node in the current block. If we can prove that any predecessors |
| 1193 | // compute a predictable value based on a PHI node, thread those predecessors. |
Hal Finkel | 7e18449 | 2014-09-07 20:29:59 +0000 | [diff] [blame] | 1194 | if (ProcessThreadableEdges(CondInst, BB, Preference, Terminator)) |
Chris Lattner | fde1f8d | 2009-11-11 02:08:33 +0000 | [diff] [blame] | 1195 | return true; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1196 | |
Chris Lattner | 6a19ed0 | 2010-01-11 23:41:09 +0000 | [diff] [blame] | 1197 | // If this is an otherwise-unfoldable branch on a phi node in the current |
| 1198 | // block, see if we can simplify. |
| 1199 | if (PHINode *PN = dyn_cast<PHINode>(CondInst)) |
| 1200 | if (PN->getParent() == BB && isa<BranchInst>(BB->getTerminator())) |
| 1201 | return ProcessBranchOnPHI(PN); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1202 | |
Chris Lattner | eb73bdb | 2010-01-12 02:07:17 +0000 | [diff] [blame] | 1203 | // If this is an otherwise-unfoldable branch on a XOR, see if we can simplify. |
| 1204 | if (CondInst->getOpcode() == Instruction::Xor && |
| 1205 | CondInst->getParent() == BB && isa<BranchInst>(BB->getTerminator())) |
| 1206 | return ProcessBranchOnXOR(cast<BinaryOperator>(CondInst)); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1207 | |
Sanjoy Das | 13e63a2 | 2015-10-28 21:27:08 +0000 | [diff] [blame] | 1208 | // Search for a stronger dominating condition that can be used to simplify a |
| 1209 | // conditional branch leaving BB. |
| 1210 | if (ProcessImpliedCondition(BB)) |
| 1211 | return true; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1212 | |
Sanjoy Das | 13e63a2 | 2015-10-28 21:27:08 +0000 | [diff] [blame] | 1213 | return false; |
| 1214 | } |
| 1215 | |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 1216 | bool JumpThreadingPass::ProcessImpliedCondition(BasicBlock *BB) { |
Sanjoy Das | 13e63a2 | 2015-10-28 21:27:08 +0000 | [diff] [blame] | 1217 | auto *BI = dyn_cast<BranchInst>(BB->getTerminator()); |
| 1218 | if (!BI || !BI->isConditional()) |
| 1219 | return false; |
| 1220 | |
| 1221 | Value *Cond = BI->getCondition(); |
| 1222 | BasicBlock *CurrentBB = BB; |
| 1223 | BasicBlock *CurrentPred = BB->getSinglePredecessor(); |
| 1224 | unsigned Iter = 0; |
| 1225 | |
Sanjoy Das | 55ea67c | 2015-11-06 19:01:08 +0000 | [diff] [blame] | 1226 | auto &DL = BB->getModule()->getDataLayout(); |
| 1227 | |
Sanjoy Das | 13e63a2 | 2015-10-28 21:27:08 +0000 | [diff] [blame] | 1228 | while (CurrentPred && Iter++ < ImplicationSearchThreshold) { |
| 1229 | auto *PBI = dyn_cast<BranchInst>(CurrentPred->getTerminator()); |
Chad Rosier | e2cbd13 | 2016-04-25 17:23:36 +0000 | [diff] [blame] | 1230 | if (!PBI || !PBI->isConditional()) |
| 1231 | return false; |
| 1232 | if (PBI->getSuccessor(0) != CurrentBB && PBI->getSuccessor(1) != CurrentBB) |
Sanjoy Das | 13e63a2 | 2015-10-28 21:27:08 +0000 | [diff] [blame] | 1233 | return false; |
| 1234 | |
Chad Rosier | dfd1de6 | 2017-08-01 20:18:54 +0000 | [diff] [blame] | 1235 | bool CondIsTrue = PBI->getSuccessor(0) == CurrentBB; |
Chad Rosier | 41dd31f | 2016-04-20 19:15:26 +0000 | [diff] [blame] | 1236 | Optional<bool> Implication = |
Chad Rosier | dfd1de6 | 2017-08-01 20:18:54 +0000 | [diff] [blame] | 1237 | isImpliedCondition(PBI->getCondition(), Cond, DL, CondIsTrue); |
Chad Rosier | 41dd31f | 2016-04-20 19:15:26 +0000 | [diff] [blame] | 1238 | if (Implication) { |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 1239 | BasicBlock *KeepSucc = BI->getSuccessor(*Implication ? 0 : 1); |
| 1240 | BasicBlock *RemoveSucc = BI->getSuccessor(*Implication ? 1 : 0); |
| 1241 | RemoveSucc->removePredecessor(BB); |
| 1242 | BranchInst::Create(KeepSucc, BI); |
Sanjoy Das | 13e63a2 | 2015-10-28 21:27:08 +0000 | [diff] [blame] | 1243 | BI->eraseFromParent(); |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 1244 | DDT->deleteEdge(BB, RemoveSucc); |
Sanjoy Das | 13e63a2 | 2015-10-28 21:27:08 +0000 | [diff] [blame] | 1245 | return true; |
| 1246 | } |
| 1247 | CurrentBB = CurrentPred; |
| 1248 | CurrentPred = CurrentBB->getSinglePredecessor(); |
| 1249 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1250 | |
Chris Lattner | e369c35 | 2008-04-22 06:36:15 +0000 | [diff] [blame] | 1251 | return false; |
| 1252 | } |
| 1253 | |
Xin Tong | d67fb1b | 2017-03-19 15:30:53 +0000 | [diff] [blame] | 1254 | /// Return true if Op is an instruction defined in the given block. |
| 1255 | static bool isOpDefinedInBlock(Value *Op, BasicBlock *BB) { |
| 1256 | if (Instruction *OpInst = dyn_cast<Instruction>(Op)) |
| 1257 | if (OpInst->getParent() == BB) |
| 1258 | return true; |
| 1259 | return false; |
| 1260 | } |
| 1261 | |
Brian M. Rzycki | 994e889 | 2018-01-29 21:29:44 +0000 | [diff] [blame] | 1262 | /// SimplifyPartiallyRedundantLoad - If LoadI is an obviously partially |
| 1263 | /// redundant load instruction, eliminate it by replacing it with a PHI node. |
| 1264 | /// This is an important optimization that encourages jump threading, and needs |
| 1265 | /// to be run interlaced with other jump threading tasks. |
| 1266 | bool JumpThreadingPass::SimplifyPartiallyRedundantLoad(LoadInst *LoadI) { |
Sanjoy Das | 13623ad | 2016-07-14 19:21:15 +0000 | [diff] [blame] | 1267 | // Don't hack volatile and ordered loads. |
Brian M. Rzycki | 994e889 | 2018-01-29 21:29:44 +0000 | [diff] [blame] | 1268 | if (!LoadI->isUnordered()) return false; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1269 | |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1270 | // If the load is defined in a block with exactly one predecessor, it can't be |
| 1271 | // partially redundant. |
Brian M. Rzycki | 994e889 | 2018-01-29 21:29:44 +0000 | [diff] [blame] | 1272 | BasicBlock *LoadBB = LoadI->getParent(); |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1273 | if (LoadBB->getSinglePredecessor()) |
| 1274 | return false; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1275 | |
David Majnemer | eb518bd | 2015-08-04 08:21:40 +0000 | [diff] [blame] | 1276 | // If the load is defined in an EH pad, it can't be partially redundant, |
| 1277 | // because the edges between the invoke and the EH pad cannot have other |
Bill Wendling | 90dd90a | 2013-10-21 04:09:17 +0000 | [diff] [blame] | 1278 | // instructions between them. |
David Majnemer | eb518bd | 2015-08-04 08:21:40 +0000 | [diff] [blame] | 1279 | if (LoadBB->isEHPad()) |
Bill Wendling | 90dd90a | 2013-10-21 04:09:17 +0000 | [diff] [blame] | 1280 | return false; |
| 1281 | |
Brian M. Rzycki | 994e889 | 2018-01-29 21:29:44 +0000 | [diff] [blame] | 1282 | Value *LoadedPtr = LoadI->getOperand(0); |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1283 | |
Xin Tong | d67fb1b | 2017-03-19 15:30:53 +0000 | [diff] [blame] | 1284 | // If the loaded operand is defined in the LoadBB and its not a phi, |
| 1285 | // it can't be available in predecessors. |
| 1286 | if (isOpDefinedInBlock(LoadedPtr, LoadBB) && !isa<PHINode>(LoadedPtr)) |
| 1287 | return false; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1288 | |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1289 | // Scan a few instructions up from the load, to see if it is obviously live at |
| 1290 | // the entry to its block. |
Brian M. Rzycki | 994e889 | 2018-01-29 21:29:44 +0000 | [diff] [blame] | 1291 | BasicBlock::iterator BBIt(LoadI); |
Eli Friedman | 02419a9 | 2016-08-08 04:10:22 +0000 | [diff] [blame] | 1292 | bool IsLoadCSE; |
Jun Bum Lim | ac17087 | 2017-03-08 15:22:30 +0000 | [diff] [blame] | 1293 | if (Value *AvailableVal = FindAvailableLoadedValue( |
Brian M. Rzycki | 994e889 | 2018-01-29 21:29:44 +0000 | [diff] [blame] | 1294 | LoadI, LoadBB, BBIt, DefMaxInstsToScan, AA, &IsLoadCSE)) { |
David L Kreitzer | da700ce | 2015-09-16 13:27:30 +0000 | [diff] [blame] | 1295 | // If the value of the load is locally available within the block, just use |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1296 | // it. This frequently occurs for reg2mem'd allocas. |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1297 | |
Eli Friedman | 02419a9 | 2016-08-08 04:10:22 +0000 | [diff] [blame] | 1298 | if (IsLoadCSE) { |
Brian M. Rzycki | 994e889 | 2018-01-29 21:29:44 +0000 | [diff] [blame] | 1299 | LoadInst *NLoadI = cast<LoadInst>(AvailableVal); |
| 1300 | combineMetadataForCSE(NLoadI, LoadI); |
Eli Friedman | 02419a9 | 2016-08-08 04:10:22 +0000 | [diff] [blame] | 1301 | }; |
| 1302 | |
Chris Lattner | 482eb70 | 2009-01-09 06:08:12 +0000 | [diff] [blame] | 1303 | // If the returned value is the load itself, replace with an undef. This can |
| 1304 | // only happen in dead loops. |
Brian M. Rzycki | 994e889 | 2018-01-29 21:29:44 +0000 | [diff] [blame] | 1305 | if (AvailableVal == LoadI) |
| 1306 | AvailableVal = UndefValue::get(LoadI->getType()); |
| 1307 | if (AvailableVal->getType() != LoadI->getType()) |
| 1308 | AvailableVal = CastInst::CreateBitOrPointerCast( |
| 1309 | AvailableVal, LoadI->getType(), "", LoadI); |
| 1310 | LoadI->replaceAllUsesWith(AvailableVal); |
| 1311 | LoadI->eraseFromParent(); |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1312 | return true; |
| 1313 | } |
| 1314 | |
| 1315 | // Otherwise, if we scanned the whole block and got to the top of the block, |
| 1316 | // we know the block is locally transparent to the load. If not, something |
| 1317 | // might clobber its value. |
| 1318 | if (BBIt != LoadBB->begin()) |
| 1319 | return false; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1320 | |
Hal Finkel | cc39b67 | 2014-07-24 12:16:19 +0000 | [diff] [blame] | 1321 | // If all of the loads and stores that feed the value have the same AA tags, |
| 1322 | // then we can propagate them onto any newly inserted loads. |
| 1323 | AAMDNodes AATags; |
Brian M. Rzycki | 994e889 | 2018-01-29 21:29:44 +0000 | [diff] [blame] | 1324 | LoadI->getAAMetadata(AATags); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1325 | |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1326 | SmallPtrSet<BasicBlock*, 8> PredsScanned; |
Eugene Zelenko | 8002c50 | 2017-09-13 21:43:53 +0000 | [diff] [blame] | 1327 | |
| 1328 | using AvailablePredsTy = SmallVector<std::pair<BasicBlock *, Value *>, 8>; |
| 1329 | |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1330 | AvailablePredsTy AvailablePreds; |
Craig Topper | f40110f | 2014-04-25 05:29:35 +0000 | [diff] [blame] | 1331 | BasicBlock *OneUnavailablePred = nullptr; |
Eli Friedman | 02419a9 | 2016-08-08 04:10:22 +0000 | [diff] [blame] | 1332 | SmallVector<LoadInst*, 8> CSELoads; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1333 | |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1334 | // If we got here, the loaded value is transparent through to the start of the |
| 1335 | // block. Check to see if it is available in any of the predecessor blocks. |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 1336 | for (BasicBlock *PredBB : predecessors(LoadBB)) { |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1337 | // If we already scanned this predecessor, skip it. |
David Blaikie | 70573dc | 2014-11-19 07:49:26 +0000 | [diff] [blame] | 1338 | if (!PredsScanned.insert(PredBB).second) |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1339 | continue; |
| 1340 | |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1341 | BBIt = PredBB->end(); |
Jun Bum Lim | 180bc5a | 2017-02-02 15:12:34 +0000 | [diff] [blame] | 1342 | unsigned NumScanedInst = 0; |
Xin Tong | d67fb1b | 2017-03-19 15:30:53 +0000 | [diff] [blame] | 1343 | Value *PredAvailable = nullptr; |
| 1344 | // NOTE: We don't CSE load that is volatile or anything stronger than |
| 1345 | // unordered, that should have been checked when we entered the function. |
Brian M. Rzycki | 994e889 | 2018-01-29 21:29:44 +0000 | [diff] [blame] | 1346 | assert(LoadI->isUnordered() && |
| 1347 | "Attempting to CSE volatile or atomic loads"); |
Xin Tong | d67fb1b | 2017-03-19 15:30:53 +0000 | [diff] [blame] | 1348 | // If this is a load on a phi pointer, phi-translate it and search |
| 1349 | // for available load/store to the pointer in predecessors. |
| 1350 | Value *Ptr = LoadedPtr->DoPHITranslation(LoadBB, PredBB); |
| 1351 | PredAvailable = FindAvailablePtrLoadStore( |
Brian M. Rzycki | 994e889 | 2018-01-29 21:29:44 +0000 | [diff] [blame] | 1352 | Ptr, LoadI->getType(), LoadI->isAtomic(), PredBB, BBIt, |
| 1353 | DefMaxInstsToScan, AA, &IsLoadCSE, &NumScanedInst); |
Jun Bum Lim | 180bc5a | 2017-02-02 15:12:34 +0000 | [diff] [blame] | 1354 | |
Xin Tong | d67fb1b | 2017-03-19 15:30:53 +0000 | [diff] [blame] | 1355 | // If PredBB has a single predecessor, continue scanning through the |
| 1356 | // single precessor. |
Jun Bum Lim | 180bc5a | 2017-02-02 15:12:34 +0000 | [diff] [blame] | 1357 | BasicBlock *SinglePredBB = PredBB; |
| 1358 | while (!PredAvailable && SinglePredBB && BBIt == SinglePredBB->begin() && |
| 1359 | NumScanedInst < DefMaxInstsToScan) { |
| 1360 | SinglePredBB = SinglePredBB->getSinglePredecessor(); |
| 1361 | if (SinglePredBB) { |
| 1362 | BBIt = SinglePredBB->end(); |
Xin Tong | d67fb1b | 2017-03-19 15:30:53 +0000 | [diff] [blame] | 1363 | PredAvailable = FindAvailablePtrLoadStore( |
Brian M. Rzycki | 994e889 | 2018-01-29 21:29:44 +0000 | [diff] [blame] | 1364 | Ptr, LoadI->getType(), LoadI->isAtomic(), SinglePredBB, BBIt, |
Xin Tong | bcb17ec | 2017-03-19 15:41:46 +0000 | [diff] [blame] | 1365 | (DefMaxInstsToScan - NumScanedInst), AA, &IsLoadCSE, |
Xin Tong | d67fb1b | 2017-03-19 15:30:53 +0000 | [diff] [blame] | 1366 | &NumScanedInst); |
Jun Bum Lim | 180bc5a | 2017-02-02 15:12:34 +0000 | [diff] [blame] | 1367 | } |
| 1368 | } |
| 1369 | |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1370 | if (!PredAvailable) { |
| 1371 | OneUnavailablePred = PredBB; |
| 1372 | continue; |
| 1373 | } |
Nadav Rotem | 465834c | 2012-07-24 10:51:42 +0000 | [diff] [blame] | 1374 | |
Eli Friedman | 02419a9 | 2016-08-08 04:10:22 +0000 | [diff] [blame] | 1375 | if (IsLoadCSE) |
| 1376 | CSELoads.push_back(cast<LoadInst>(PredAvailable)); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1377 | |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1378 | // If so, this load is partially redundant. Remember this info so that we |
| 1379 | // can create a PHI node. |
| 1380 | AvailablePreds.push_back(std::make_pair(PredBB, PredAvailable)); |
| 1381 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1382 | |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1383 | // If the loaded value isn't available in any predecessor, it isn't partially |
| 1384 | // redundant. |
| 1385 | if (AvailablePreds.empty()) return false; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1386 | |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1387 | // Okay, the loaded value is available in at least one (and maybe all!) |
| 1388 | // predecessors. If the value is unavailable in more than one unique |
| 1389 | // predecessor, we want to insert a merge block for those common predecessors. |
| 1390 | // This ensures that we only have to insert one reload, thus not increasing |
| 1391 | // code size. |
Craig Topper | f40110f | 2014-04-25 05:29:35 +0000 | [diff] [blame] | 1392 | BasicBlock *UnavailablePred = nullptr; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1393 | |
Max Kazantsev | fd95ee0 | 2017-12-19 09:10:21 +0000 | [diff] [blame] | 1394 | // If the value is unavailable in one of predecessors, we will end up |
| 1395 | // inserting a new instruction into them. It is only valid if all the |
Brian M. Rzycki | 994e889 | 2018-01-29 21:29:44 +0000 | [diff] [blame] | 1396 | // instructions before LoadI are guaranteed to pass execution to its |
| 1397 | // successor, or if LoadI is safe to speculate. |
Max Kazantsev | fd95ee0 | 2017-12-19 09:10:21 +0000 | [diff] [blame] | 1398 | // TODO: If this logic becomes more complex, and we will perform PRE insertion |
| 1399 | // farther than to a predecessor, we need to reuse the code from GVN's PRE. |
| 1400 | // It requires domination tree analysis, so for this simple case it is an |
| 1401 | // overkill. |
| 1402 | if (PredsScanned.size() != AvailablePreds.size() && |
Brian M. Rzycki | 994e889 | 2018-01-29 21:29:44 +0000 | [diff] [blame] | 1403 | !isSafeToSpeculativelyExecute(LoadI)) |
| 1404 | for (auto I = LoadBB->begin(); &*I != LoadI; ++I) |
Max Kazantsev | fd95ee0 | 2017-12-19 09:10:21 +0000 | [diff] [blame] | 1405 | if (!isGuaranteedToTransferExecutionToSuccessor(&*I)) |
| 1406 | return false; |
| 1407 | |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1408 | // If there is exactly one predecessor where the value is unavailable, the |
| 1409 | // already computed 'OneUnavailablePred' block is it. If it ends in an |
| 1410 | // unconditional branch, we know that it isn't a critical edge. |
| 1411 | if (PredsScanned.size() == AvailablePreds.size()+1 && |
| 1412 | OneUnavailablePred->getTerminator()->getNumSuccessors() == 1) { |
| 1413 | UnavailablePred = OneUnavailablePred; |
| 1414 | } else if (PredsScanned.size() != AvailablePreds.size()) { |
| 1415 | // Otherwise, we had multiple unavailable predecessors or we had a critical |
| 1416 | // edge from the one. |
| 1417 | SmallVector<BasicBlock*, 8> PredsToSplit; |
| 1418 | SmallPtrSet<BasicBlock*, 8> AvailablePredSet; |
| 1419 | |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 1420 | for (const auto &AvailablePred : AvailablePreds) |
| 1421 | AvailablePredSet.insert(AvailablePred.first); |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1422 | |
| 1423 | // Add all the unavailable predecessors to the PredsToSplit list. |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 1424 | for (BasicBlock *P : predecessors(LoadBB)) { |
Chris Lattner | 329ea06 | 2010-06-14 19:45:43 +0000 | [diff] [blame] | 1425 | // If the predecessor is an indirect goto, we can't split the edge. |
Gabor Greif | a5fa885 | 2010-07-12 14:10:24 +0000 | [diff] [blame] | 1426 | if (isa<IndirectBrInst>(P->getTerminator())) |
Chris Lattner | 329ea06 | 2010-06-14 19:45:43 +0000 | [diff] [blame] | 1427 | return false; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1428 | |
Gabor Greif | a5fa885 | 2010-07-12 14:10:24 +0000 | [diff] [blame] | 1429 | if (!AvailablePredSet.count(P)) |
| 1430 | PredsToSplit.push_back(P); |
Chris Lattner | 329ea06 | 2010-06-14 19:45:43 +0000 | [diff] [blame] | 1431 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1432 | |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1433 | // Split them out to their own block. |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 1434 | UnavailablePred = SplitBlockPreds(LoadBB, PredsToSplit, "thread-pre-split"); |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1435 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1436 | |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1437 | // If the value isn't available in all predecessors, then there will be |
| 1438 | // exactly one where it isn't available. Insert a load on that edge and add |
| 1439 | // it to the AvailablePreds list. |
| 1440 | if (UnavailablePred) { |
| 1441 | assert(UnavailablePred->getTerminator()->getNumSuccessors() == 1 && |
| 1442 | "Can't handle critical edge here!"); |
Brian M. Rzycki | 994e889 | 2018-01-29 21:29:44 +0000 | [diff] [blame] | 1443 | LoadInst *NewVal = |
| 1444 | new LoadInst(LoadedPtr->DoPHITranslation(LoadBB, UnavailablePred), |
| 1445 | LoadI->getName() + ".pr", false, LoadI->getAlignment(), |
| 1446 | LoadI->getOrdering(), LoadI->getSyncScopeID(), |
| 1447 | UnavailablePred->getTerminator()); |
| 1448 | NewVal->setDebugLoc(LoadI->getDebugLoc()); |
Hal Finkel | cc39b67 | 2014-07-24 12:16:19 +0000 | [diff] [blame] | 1449 | if (AATags) |
| 1450 | NewVal->setAAMetadata(AATags); |
Nadav Rotem | 465834c | 2012-07-24 10:51:42 +0000 | [diff] [blame] | 1451 | |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1452 | AvailablePreds.push_back(std::make_pair(UnavailablePred, NewVal)); |
| 1453 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1454 | |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1455 | // Now we know that each predecessor of this block has a value in |
| 1456 | // AvailablePreds, sort them for efficient access as we're walking the preds. |
Chris Lattner | 2b07d3c | 2008-12-01 06:52:57 +0000 | [diff] [blame] | 1457 | array_pod_sort(AvailablePreds.begin(), AvailablePreds.end()); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1458 | |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1459 | // Create a PHI node at the start of the block for the PRE'd load value. |
Jay Foad | e0938d8 | 2011-03-30 11:19:20 +0000 | [diff] [blame] | 1460 | pred_iterator PB = pred_begin(LoadBB), PE = pred_end(LoadBB); |
Brian M. Rzycki | 994e889 | 2018-01-29 21:29:44 +0000 | [diff] [blame] | 1461 | PHINode *PN = PHINode::Create(LoadI->getType(), std::distance(PB, PE), "", |
Duncan P. N. Exon Smith | 3a9c9e3 | 2015-10-13 18:26:00 +0000 | [diff] [blame] | 1462 | &LoadBB->front()); |
Brian M. Rzycki | 994e889 | 2018-01-29 21:29:44 +0000 | [diff] [blame] | 1463 | PN->takeName(LoadI); |
| 1464 | PN->setDebugLoc(LoadI->getDebugLoc()); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1465 | |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1466 | // Insert new entries into the PHI for each predecessor. A single block may |
| 1467 | // have multiple entries here. |
Jay Foad | e0938d8 | 2011-03-30 11:19:20 +0000 | [diff] [blame] | 1468 | for (pred_iterator PI = PB; PI != PE; ++PI) { |
Gabor Greif | a5fa885 | 2010-07-12 14:10:24 +0000 | [diff] [blame] | 1469 | BasicBlock *P = *PI; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1470 | AvailablePredsTy::iterator I = |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1471 | std::lower_bound(AvailablePreds.begin(), AvailablePreds.end(), |
Craig Topper | f40110f | 2014-04-25 05:29:35 +0000 | [diff] [blame] | 1472 | std::make_pair(P, (Value*)nullptr)); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1473 | |
Gabor Greif | a5fa885 | 2010-07-12 14:10:24 +0000 | [diff] [blame] | 1474 | assert(I != AvailablePreds.end() && I->first == P && |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1475 | "Didn't find entry for predecessor!"); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1476 | |
Chandler Carruth | eeec35a | 2014-10-20 00:24:14 +0000 | [diff] [blame] | 1477 | // If we have an available predecessor but it requires casting, insert the |
Chandler Carruth | 6665d62 | 2014-10-20 05:34:36 +0000 | [diff] [blame] | 1478 | // cast in the predecessor and use the cast. Note that we have to update the |
| 1479 | // AvailablePreds vector as we go so that all of the PHI entries for this |
| 1480 | // predecessor use the same bitcast. |
| 1481 | Value *&PredV = I->second; |
Brian M. Rzycki | 994e889 | 2018-01-29 21:29:44 +0000 | [diff] [blame] | 1482 | if (PredV->getType() != LoadI->getType()) |
| 1483 | PredV = CastInst::CreateBitOrPointerCast(PredV, LoadI->getType(), "", |
Chandler Carruth | 1a3c2c4 | 2014-11-25 08:20:27 +0000 | [diff] [blame] | 1484 | P->getTerminator()); |
Chandler Carruth | eeec35a | 2014-10-20 00:24:14 +0000 | [diff] [blame] | 1485 | |
| 1486 | PN->addIncoming(PredV, I->first); |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1487 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1488 | |
Brian M. Rzycki | 994e889 | 2018-01-29 21:29:44 +0000 | [diff] [blame] | 1489 | for (LoadInst *PredLoadI : CSELoads) { |
| 1490 | combineMetadataForCSE(PredLoadI, LoadI); |
Eli Friedman | 02419a9 | 2016-08-08 04:10:22 +0000 | [diff] [blame] | 1491 | } |
| 1492 | |
Brian M. Rzycki | 994e889 | 2018-01-29 21:29:44 +0000 | [diff] [blame] | 1493 | LoadI->replaceAllUsesWith(PN); |
| 1494 | LoadI->eraseFromParent(); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1495 | |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1496 | return true; |
| 1497 | } |
| 1498 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1499 | /// FindMostPopularDest - The specified list contains multiple possible |
| 1500 | /// threadable destinations. Pick the one that occurs the most frequently in |
| 1501 | /// the list. |
| 1502 | static BasicBlock * |
| 1503 | FindMostPopularDest(BasicBlock *BB, |
Eugene Zelenko | 8002c50 | 2017-09-13 21:43:53 +0000 | [diff] [blame] | 1504 | const SmallVectorImpl<std::pair<BasicBlock *, |
| 1505 | BasicBlock *>> &PredToDestList) { |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1506 | assert(!PredToDestList.empty()); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1507 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1508 | // Determine popularity. If there are multiple possible destinations, we |
| 1509 | // explicitly choose to ignore 'undef' destinations. We prefer to thread |
| 1510 | // blocks with known and real destinations to threading undef. We'll handle |
| 1511 | // them later if interesting. |
| 1512 | DenseMap<BasicBlock*, unsigned> DestPopularity; |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 1513 | for (const auto &PredToDest : PredToDestList) |
| 1514 | if (PredToDest.second) |
| 1515 | DestPopularity[PredToDest.second]++; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1516 | |
Haicheng Wu | c7cc879 | 2018-03-29 16:01:26 +0000 | [diff] [blame] | 1517 | if (DestPopularity.empty()) |
| 1518 | return nullptr; |
| 1519 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1520 | // Find the most popular dest. |
| 1521 | DenseMap<BasicBlock*, unsigned>::iterator DPI = DestPopularity.begin(); |
| 1522 | BasicBlock *MostPopularDest = DPI->first; |
| 1523 | unsigned Popularity = DPI->second; |
| 1524 | SmallVector<BasicBlock*, 4> SamePopularity; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1525 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1526 | for (++DPI; DPI != DestPopularity.end(); ++DPI) { |
| 1527 | // If the popularity of this entry isn't higher than the popularity we've |
| 1528 | // seen so far, ignore it. |
| 1529 | if (DPI->second < Popularity) |
| 1530 | ; // ignore. |
| 1531 | else if (DPI->second == Popularity) { |
| 1532 | // If it is the same as what we've seen so far, keep track of it. |
| 1533 | SamePopularity.push_back(DPI->first); |
| 1534 | } else { |
| 1535 | // If it is more popular, remember it. |
| 1536 | SamePopularity.clear(); |
| 1537 | MostPopularDest = DPI->first; |
| 1538 | Popularity = DPI->second; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1539 | } |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1540 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1541 | |
Frits van Bommel | 9bbe849 | 2010-12-16 12:16:00 +0000 | [diff] [blame] | 1542 | // Okay, now we know the most popular destination. If there is more than one |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1543 | // destination, we need to determine one. This is arbitrary, but we need |
| 1544 | // to make a deterministic decision. Pick the first one that appears in the |
| 1545 | // successor list. |
| 1546 | if (!SamePopularity.empty()) { |
| 1547 | SamePopularity.push_back(MostPopularDest); |
| 1548 | TerminatorInst *TI = BB->getTerminator(); |
| 1549 | for (unsigned i = 0; ; ++i) { |
| 1550 | assert(i != TI->getNumSuccessors() && "Didn't find any successor!"); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1551 | |
David Majnemer | 0d955d0 | 2016-08-11 22:21:41 +0000 | [diff] [blame] | 1552 | if (!is_contained(SamePopularity, TI->getSuccessor(i))) |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1553 | continue; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1554 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1555 | MostPopularDest = TI->getSuccessor(i); |
| 1556 | break; |
| 1557 | } |
| 1558 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1559 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1560 | // Okay, we have finally picked the most popular destination. |
| 1561 | return MostPopularDest; |
| 1562 | } |
| 1563 | |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 1564 | bool JumpThreadingPass::ProcessThreadableEdges(Value *Cond, BasicBlock *BB, |
| 1565 | ConstantPreference Preference, |
| 1566 | Instruction *CxtI) { |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1567 | // If threading this would thread across a loop header, don't even try to |
| 1568 | // thread the edge. |
| 1569 | if (LoopHeaders.count(BB)) |
| 1570 | return false; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1571 | |
Frits van Bommel | 7624486 | 2010-12-05 19:06:41 +0000 | [diff] [blame] | 1572 | PredValueInfoTy PredValues; |
Haicheng Wu | 64d9d7c | 2016-03-15 23:38:47 +0000 | [diff] [blame] | 1573 | if (!ComputeValueKnownInPredecessors(Cond, BB, PredValues, Preference, CxtI)) |
| 1574 | return false; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1575 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1576 | assert(!PredValues.empty() && |
| 1577 | "ComputeValueKnownInPredecessors returned true with no values"); |
| 1578 | |
Craig Topper | c9a4c62 | 2018-05-31 18:08:11 +0000 | [diff] [blame] | 1579 | LLVM_DEBUG(dbgs() << "IN BB: " << *BB; |
| 1580 | for (const auto &PredValue : PredValues) { |
| 1581 | dbgs() << " BB '" << BB->getName() |
| 1582 | << "': FOUND condition = " << *PredValue.first |
| 1583 | << " for pred '" << PredValue.second->getName() << "'.\n"; |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 1584 | }); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1585 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1586 | // Decide what we want to thread through. Convert our list of known values to |
| 1587 | // a list of known destinations for each pred. This also discards duplicate |
| 1588 | // predecessors and keeps track of the undefined inputs (which are represented |
Chris Lattner | ea465e2 | 2009-11-09 00:41:49 +0000 | [diff] [blame] | 1589 | // as a null dest in the PredToDestList). |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1590 | SmallPtrSet<BasicBlock*, 16> SeenPreds; |
| 1591 | SmallVector<std::pair<BasicBlock*, BasicBlock*>, 16> PredToDestList; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1592 | |
Craig Topper | f40110f | 2014-04-25 05:29:35 +0000 | [diff] [blame] | 1593 | BasicBlock *OnlyDest = nullptr; |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1594 | BasicBlock *MultipleDestSentinel = (BasicBlock*)(intptr_t)~0ULL; |
Xin Tong | 21f8ac2 | 2017-05-01 15:34:17 +0000 | [diff] [blame] | 1595 | Constant *OnlyVal = nullptr; |
| 1596 | Constant *MultipleVal = (Constant *)(intptr_t)~0ULL; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1597 | |
Xin Tong | a4b9b9f | 2017-05-01 17:15:37 +0000 | [diff] [blame] | 1598 | unsigned PredWithKnownDest = 0; |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 1599 | for (const auto &PredValue : PredValues) { |
| 1600 | BasicBlock *Pred = PredValue.second; |
David Blaikie | 70573dc | 2014-11-19 07:49:26 +0000 | [diff] [blame] | 1601 | if (!SeenPreds.insert(Pred).second) |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1602 | continue; // Duplicate predecessor entry. |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1603 | |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 1604 | Constant *Val = PredValue.first; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1605 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1606 | BasicBlock *DestBB; |
Frits van Bommel | 7624486 | 2010-12-05 19:06:41 +0000 | [diff] [blame] | 1607 | if (isa<UndefValue>(Val)) |
Craig Topper | f40110f | 2014-04-25 05:29:35 +0000 | [diff] [blame] | 1608 | DestBB = nullptr; |
Xin Tong | 99dce42 | 2017-05-01 16:19:59 +0000 | [diff] [blame] | 1609 | else if (BranchInst *BI = dyn_cast<BranchInst>(BB->getTerminator())) { |
| 1610 | assert(isa<ConstantInt>(Val) && "Expecting a constant integer"); |
Frits van Bommel | 7624486 | 2010-12-05 19:06:41 +0000 | [diff] [blame] | 1611 | DestBB = BI->getSuccessor(cast<ConstantInt>(Val)->isZero()); |
Xin Tong | 99dce42 | 2017-05-01 16:19:59 +0000 | [diff] [blame] | 1612 | } else if (SwitchInst *SI = dyn_cast<SwitchInst>(BB->getTerminator())) { |
| 1613 | assert(isa<ConstantInt>(Val) && "Expecting a constant integer"); |
Chandler Carruth | 927d8e6 | 2017-04-12 07:27:28 +0000 | [diff] [blame] | 1614 | DestBB = SI->findCaseValue(cast<ConstantInt>(Val))->getCaseSuccessor(); |
Stepan Dyatkovskiy | 513aaa5 | 2012-02-01 07:49:51 +0000 | [diff] [blame] | 1615 | } else { |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 1616 | assert(isa<IndirectBrInst>(BB->getTerminator()) |
| 1617 | && "Unexpected terminator"); |
Xin Tong | 99dce42 | 2017-05-01 16:19:59 +0000 | [diff] [blame] | 1618 | assert(isa<BlockAddress>(Val) && "Expecting a constant blockaddress"); |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 1619 | DestBB = cast<BlockAddress>(Val)->getBasicBlock(); |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1620 | } |
| 1621 | |
| 1622 | // If we have exactly one destination, remember it for efficiency below. |
Xin Tong | 21f8ac2 | 2017-05-01 15:34:17 +0000 | [diff] [blame] | 1623 | if (PredToDestList.empty()) { |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1624 | OnlyDest = DestBB; |
Xin Tong | 21f8ac2 | 2017-05-01 15:34:17 +0000 | [diff] [blame] | 1625 | OnlyVal = Val; |
| 1626 | } else { |
| 1627 | if (OnlyDest != DestBB) |
| 1628 | OnlyDest = MultipleDestSentinel; |
| 1629 | // It possible we have same destination, but different value, e.g. default |
| 1630 | // case in switchinst. |
| 1631 | if (Val != OnlyVal) |
| 1632 | OnlyVal = MultipleVal; |
| 1633 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1634 | |
Xin Tong | a4b9b9f | 2017-05-01 17:15:37 +0000 | [diff] [blame] | 1635 | // We know where this predecessor is going. |
| 1636 | ++PredWithKnownDest; |
| 1637 | |
| 1638 | // If the predecessor ends with an indirect goto, we can't change its |
| 1639 | // destination. |
| 1640 | if (isa<IndirectBrInst>(Pred->getTerminator())) |
| 1641 | continue; |
| 1642 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1643 | PredToDestList.push_back(std::make_pair(Pred, DestBB)); |
| 1644 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1645 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1646 | // If all edges were unthreadable, we fail. |
| 1647 | if (PredToDestList.empty()) |
Haicheng Wu | 64d9d7c | 2016-03-15 23:38:47 +0000 | [diff] [blame] | 1648 | return false; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1649 | |
Xin Tong | f98602a | 2017-04-23 20:56:29 +0000 | [diff] [blame] | 1650 | // If all the predecessors go to a single known successor, we want to fold, |
| 1651 | // not thread. By doing so, we do not need to duplicate the current block and |
| 1652 | // also miss potential opportunities in case we dont/cant duplicate. |
| 1653 | if (OnlyDest && OnlyDest != MultipleDestSentinel) { |
Vedant Kumar | e0b5f86 | 2018-05-10 23:01:54 +0000 | [diff] [blame] | 1654 | if (PredWithKnownDest == (size_t)pred_size(BB)) { |
Xin Tong | f98602a | 2017-04-23 20:56:29 +0000 | [diff] [blame] | 1655 | bool SeenFirstBranchToOnlyDest = false; |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 1656 | std::vector <DominatorTree::UpdateType> Updates; |
| 1657 | Updates.reserve(BB->getTerminator()->getNumSuccessors() - 1); |
Xin Tong | f98602a | 2017-04-23 20:56:29 +0000 | [diff] [blame] | 1658 | for (BasicBlock *SuccBB : successors(BB)) { |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 1659 | if (SuccBB == OnlyDest && !SeenFirstBranchToOnlyDest) { |
Xin Tong | f98602a | 2017-04-23 20:56:29 +0000 | [diff] [blame] | 1660 | SeenFirstBranchToOnlyDest = true; // Don't modify the first branch. |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 1661 | } else { |
Xin Tong | f98602a | 2017-04-23 20:56:29 +0000 | [diff] [blame] | 1662 | SuccBB->removePredecessor(BB, true); // This is unreachable successor. |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 1663 | Updates.push_back({DominatorTree::Delete, BB, SuccBB}); |
| 1664 | } |
Xin Tong | f98602a | 2017-04-23 20:56:29 +0000 | [diff] [blame] | 1665 | } |
| 1666 | |
| 1667 | // Finally update the terminator. |
| 1668 | TerminatorInst *Term = BB->getTerminator(); |
| 1669 | BranchInst::Create(OnlyDest, Term); |
| 1670 | Term->eraseFromParent(); |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 1671 | DDT->applyUpdates(Updates); |
Xin Tong | f98602a | 2017-04-23 20:56:29 +0000 | [diff] [blame] | 1672 | |
| 1673 | // If the condition is now dead due to the removal of the old terminator, |
| 1674 | // erase it. |
Xin Tong | 21f8ac2 | 2017-05-01 15:34:17 +0000 | [diff] [blame] | 1675 | if (auto *CondInst = dyn_cast<Instruction>(Cond)) { |
| 1676 | if (CondInst->use_empty() && !CondInst->mayHaveSideEffects()) |
| 1677 | CondInst->eraseFromParent(); |
Anna Thomas | c07d554 | 2017-05-23 13:36:25 +0000 | [diff] [blame] | 1678 | // We can safely replace *some* uses of the CondInst if it has |
Anna Thomas | 7bca591 | 2017-05-18 13:12:18 +0000 | [diff] [blame] | 1679 | // exactly one value as returned by LVI. RAUW is incorrect in the |
| 1680 | // presence of guards and assumes, that have the `Cond` as the use. This |
| 1681 | // is because we use the guards/assume to reason about the `Cond` value |
| 1682 | // at the end of block, but RAUW unconditionally replaces all uses |
| 1683 | // including the guards/assumes themselves and the uses before the |
| 1684 | // guard/assume. |
Anna Thomas | c07d554 | 2017-05-23 13:36:25 +0000 | [diff] [blame] | 1685 | else if (OnlyVal && OnlyVal != MultipleVal && |
| 1686 | CondInst->getParent() == BB) |
| 1687 | ReplaceFoldableUses(CondInst, OnlyVal); |
Xin Tong | 21f8ac2 | 2017-05-01 15:34:17 +0000 | [diff] [blame] | 1688 | } |
Xin Tong | f98602a | 2017-04-23 20:56:29 +0000 | [diff] [blame] | 1689 | return true; |
| 1690 | } |
| 1691 | } |
| 1692 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1693 | // Determine which is the most common successor. If we have many inputs and |
| 1694 | // this block is a switch, we want to start by threading the batch that goes |
| 1695 | // to the most popular destination first. If we only know about one |
| 1696 | // threadable destination (the common case) we can avoid this. |
| 1697 | BasicBlock *MostPopularDest = OnlyDest; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1698 | |
Haicheng Wu | c7cc879 | 2018-03-29 16:01:26 +0000 | [diff] [blame] | 1699 | if (MostPopularDest == MultipleDestSentinel) { |
| 1700 | // Remove any loop headers from the Dest list, ThreadEdge conservatively |
| 1701 | // won't process them, but we might have other destination that are eligible |
| 1702 | // and we still want to process. |
| 1703 | erase_if(PredToDestList, |
| 1704 | [&](const std::pair<BasicBlock *, BasicBlock *> &PredToDest) { |
| 1705 | return LoopHeaders.count(PredToDest.second) != 0; |
| 1706 | }); |
| 1707 | |
| 1708 | if (PredToDestList.empty()) |
| 1709 | return false; |
| 1710 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1711 | MostPopularDest = FindMostPopularDest(BB, PredToDestList); |
Haicheng Wu | c7cc879 | 2018-03-29 16:01:26 +0000 | [diff] [blame] | 1712 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1713 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1714 | // Now that we know what the most popular destination is, factor all |
| 1715 | // predecessors that will jump to it into a single predecessor. |
| 1716 | SmallVector<BasicBlock*, 16> PredsToFactor; |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 1717 | for (const auto &PredToDest : PredToDestList) |
| 1718 | if (PredToDest.second == MostPopularDest) { |
| 1719 | BasicBlock *Pred = PredToDest.first; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1720 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1721 | // This predecessor may be a switch or something else that has multiple |
| 1722 | // edges to the block. Factor each of these edges by listing them |
| 1723 | // according to # occurrences in PredsToFactor. |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 1724 | for (BasicBlock *Succ : successors(Pred)) |
| 1725 | if (Succ == BB) |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1726 | PredsToFactor.push_back(Pred); |
| 1727 | } |
| 1728 | |
| 1729 | // If the threadable edges are branching on an undefined value, we get to pick |
| 1730 | // the destination that these predecessors should get to. |
Craig Topper | f40110f | 2014-04-25 05:29:35 +0000 | [diff] [blame] | 1731 | if (!MostPopularDest) |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1732 | MostPopularDest = BB->getTerminator()-> |
| 1733 | getSuccessor(GetBestDestForJumpOnUndef(BB)); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1734 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1735 | // Ok, try to thread it! |
Haicheng Wu | 64d9d7c | 2016-03-15 23:38:47 +0000 | [diff] [blame] | 1736 | return ThreadEdge(BB, PredsToFactor, MostPopularDest); |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1737 | } |
Chris Lattner | 98d89d1 | 2008-11-27 05:07:53 +0000 | [diff] [blame] | 1738 | |
Chris Lattner | 6a19ed0 | 2010-01-11 23:41:09 +0000 | [diff] [blame] | 1739 | /// ProcessBranchOnPHI - We have an otherwise unthreadable conditional branch on |
| 1740 | /// a PHI node in the current block. See if there are any simplifications we |
| 1741 | /// can do based on inputs to the phi node. |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 1742 | bool JumpThreadingPass::ProcessBranchOnPHI(PHINode *PN) { |
Chris Lattner | 6ce85e8 | 2009-10-11 04:40:21 +0000 | [diff] [blame] | 1743 | BasicBlock *BB = PN->getParent(); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1744 | |
Chris Lattner | eb73bdb | 2010-01-12 02:07:17 +0000 | [diff] [blame] | 1745 | // TODO: We could make use of this to do it once for blocks with common PHI |
| 1746 | // values. |
| 1747 | SmallVector<BasicBlock*, 1> PredBBs; |
| 1748 | PredBBs.resize(1); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1749 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1750 | // If any of the predecessor blocks end in an unconditional branch, we can |
Chris Lattner | 6a19ed0 | 2010-01-11 23:41:09 +0000 | [diff] [blame] | 1751 | // *duplicate* the conditional branch into that block in order to further |
| 1752 | // encourage jump threading and to eliminate cases where we have branch on a |
| 1753 | // phi of an icmp (branch on icmp is much better). |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 1754 | for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) { |
| 1755 | BasicBlock *PredBB = PN->getIncomingBlock(i); |
| 1756 | if (BranchInst *PredBr = dyn_cast<BranchInst>(PredBB->getTerminator())) |
Chris Lattner | eb73bdb | 2010-01-12 02:07:17 +0000 | [diff] [blame] | 1757 | if (PredBr->isUnconditional()) { |
| 1758 | PredBBs[0] = PredBB; |
| 1759 | // Try to duplicate BB into PredBB. |
| 1760 | if (DuplicateCondBranchOnPHIIntoPred(BB, PredBBs)) |
| 1761 | return true; |
| 1762 | } |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 1763 | } |
| 1764 | |
Chris Lattner | 6ce85e8 | 2009-10-11 04:40:21 +0000 | [diff] [blame] | 1765 | return false; |
Chris Lattner | ff1c6e3 | 2008-04-20 22:39:42 +0000 | [diff] [blame] | 1766 | } |
| 1767 | |
Chris Lattner | eb73bdb | 2010-01-12 02:07:17 +0000 | [diff] [blame] | 1768 | /// ProcessBranchOnXOR - We have an otherwise unthreadable conditional branch on |
| 1769 | /// a xor instruction in the current block. See if there are any |
| 1770 | /// simplifications we can do based on inputs to the xor. |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 1771 | bool JumpThreadingPass::ProcessBranchOnXOR(BinaryOperator *BO) { |
Chris Lattner | eb73bdb | 2010-01-12 02:07:17 +0000 | [diff] [blame] | 1772 | BasicBlock *BB = BO->getParent(); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1773 | |
Chris Lattner | eb73bdb | 2010-01-12 02:07:17 +0000 | [diff] [blame] | 1774 | // If either the LHS or RHS of the xor is a constant, don't do this |
| 1775 | // optimization. |
| 1776 | if (isa<ConstantInt>(BO->getOperand(0)) || |
| 1777 | isa<ConstantInt>(BO->getOperand(1))) |
| 1778 | return false; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1779 | |
Chris Lattner | ba2d0b8 | 2010-01-23 19:16:25 +0000 | [diff] [blame] | 1780 | // If the first instruction in BB isn't a phi, we won't be able to infer |
| 1781 | // anything special about any particular predecessor. |
| 1782 | if (!isa<PHINode>(BB->front())) |
| 1783 | return false; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1784 | |
Hans Wennborg | b4d2678 | 2016-10-03 18:18:04 +0000 | [diff] [blame] | 1785 | // If this BB is a landing pad, we won't be able to split the edge into it. |
| 1786 | if (BB->isEHPad()) |
| 1787 | return false; |
| 1788 | |
Chris Lattner | eb73bdb | 2010-01-12 02:07:17 +0000 | [diff] [blame] | 1789 | // If we have a xor as the branch input to this block, and we know that the |
| 1790 | // LHS or RHS of the xor in any predecessor is true/false, then we can clone |
| 1791 | // the condition into the predecessor and fix that value to true, saving some |
| 1792 | // logical ops on that path and encouraging other paths to simplify. |
| 1793 | // |
| 1794 | // This copies something like this: |
| 1795 | // |
| 1796 | // BB: |
| 1797 | // %X = phi i1 [1], [%X'] |
| 1798 | // %Y = icmp eq i32 %A, %B |
| 1799 | // %Z = xor i1 %X, %Y |
| 1800 | // br i1 %Z, ... |
| 1801 | // |
| 1802 | // Into: |
| 1803 | // BB': |
| 1804 | // %Y = icmp ne i32 %A, %B |
David L Kreitzer | da700ce | 2015-09-16 13:27:30 +0000 | [diff] [blame] | 1805 | // br i1 %Y, ... |
Chris Lattner | eb73bdb | 2010-01-12 02:07:17 +0000 | [diff] [blame] | 1806 | |
Frits van Bommel | 7624486 | 2010-12-05 19:06:41 +0000 | [diff] [blame] | 1807 | PredValueInfoTy XorOpValues; |
Chris Lattner | eb73bdb | 2010-01-12 02:07:17 +0000 | [diff] [blame] | 1808 | bool isLHS = true; |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 1809 | if (!ComputeValueKnownInPredecessors(BO->getOperand(0), BB, XorOpValues, |
Haicheng Wu | 64d9d7c | 2016-03-15 23:38:47 +0000 | [diff] [blame] | 1810 | WantInteger, BO)) { |
Chris Lattner | eb73bdb | 2010-01-12 02:07:17 +0000 | [diff] [blame] | 1811 | assert(XorOpValues.empty()); |
Frits van Bommel | d9df6ea | 2010-12-06 23:36:56 +0000 | [diff] [blame] | 1812 | if (!ComputeValueKnownInPredecessors(BO->getOperand(1), BB, XorOpValues, |
Haicheng Wu | 64d9d7c | 2016-03-15 23:38:47 +0000 | [diff] [blame] | 1813 | WantInteger, BO)) |
| 1814 | return false; |
Chris Lattner | eb73bdb | 2010-01-12 02:07:17 +0000 | [diff] [blame] | 1815 | isLHS = false; |
| 1816 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1817 | |
Chris Lattner | eb73bdb | 2010-01-12 02:07:17 +0000 | [diff] [blame] | 1818 | assert(!XorOpValues.empty() && |
| 1819 | "ComputeValueKnownInPredecessors returned true with no values"); |
| 1820 | |
| 1821 | // Scan the information to see which is most popular: true or false. The |
| 1822 | // predecessors can be of the set true, false, or undef. |
| 1823 | unsigned NumTrue = 0, NumFalse = 0; |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 1824 | for (const auto &XorOpValue : XorOpValues) { |
| 1825 | if (isa<UndefValue>(XorOpValue.first)) |
Frits van Bommel | 7624486 | 2010-12-05 19:06:41 +0000 | [diff] [blame] | 1826 | // Ignore undefs for the count. |
| 1827 | continue; |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 1828 | if (cast<ConstantInt>(XorOpValue.first)->isZero()) |
Chris Lattner | eb73bdb | 2010-01-12 02:07:17 +0000 | [diff] [blame] | 1829 | ++NumFalse; |
| 1830 | else |
| 1831 | ++NumTrue; |
| 1832 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1833 | |
Chris Lattner | eb73bdb | 2010-01-12 02:07:17 +0000 | [diff] [blame] | 1834 | // Determine which value to split on, true, false, or undef if neither. |
Craig Topper | f40110f | 2014-04-25 05:29:35 +0000 | [diff] [blame] | 1835 | ConstantInt *SplitVal = nullptr; |
Chris Lattner | eb73bdb | 2010-01-12 02:07:17 +0000 | [diff] [blame] | 1836 | if (NumTrue > NumFalse) |
| 1837 | SplitVal = ConstantInt::getTrue(BB->getContext()); |
| 1838 | else if (NumTrue != 0 || NumFalse != 0) |
| 1839 | SplitVal = ConstantInt::getFalse(BB->getContext()); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1840 | |
Chris Lattner | eb73bdb | 2010-01-12 02:07:17 +0000 | [diff] [blame] | 1841 | // Collect all of the blocks that this can be folded into so that we can |
| 1842 | // factor this once and clone it once. |
| 1843 | SmallVector<BasicBlock*, 8> BlocksToFoldInto; |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 1844 | for (const auto &XorOpValue : XorOpValues) { |
| 1845 | if (XorOpValue.first != SplitVal && !isa<UndefValue>(XorOpValue.first)) |
Frits van Bommel | 7624486 | 2010-12-05 19:06:41 +0000 | [diff] [blame] | 1846 | continue; |
Chris Lattner | eb73bdb | 2010-01-12 02:07:17 +0000 | [diff] [blame] | 1847 | |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 1848 | BlocksToFoldInto.push_back(XorOpValue.second); |
Chris Lattner | eb73bdb | 2010-01-12 02:07:17 +0000 | [diff] [blame] | 1849 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1850 | |
Chris Lattner | ba2d0b8 | 2010-01-23 19:16:25 +0000 | [diff] [blame] | 1851 | // If we inferred a value for all of the predecessors, then duplication won't |
| 1852 | // help us. However, we can just replace the LHS or RHS with the constant. |
| 1853 | if (BlocksToFoldInto.size() == |
| 1854 | cast<PHINode>(BB->front()).getNumIncomingValues()) { |
Craig Topper | f40110f | 2014-04-25 05:29:35 +0000 | [diff] [blame] | 1855 | if (!SplitVal) { |
Chris Lattner | ba2d0b8 | 2010-01-23 19:16:25 +0000 | [diff] [blame] | 1856 | // If all preds provide undef, just nuke the xor, because it is undef too. |
| 1857 | BO->replaceAllUsesWith(UndefValue::get(BO->getType())); |
| 1858 | BO->eraseFromParent(); |
| 1859 | } else if (SplitVal->isZero()) { |
| 1860 | // If all preds provide 0, replace the xor with the other input. |
| 1861 | BO->replaceAllUsesWith(BO->getOperand(isLHS)); |
| 1862 | BO->eraseFromParent(); |
| 1863 | } else { |
| 1864 | // If all preds provide 1, set the computed value to 1. |
| 1865 | BO->setOperand(!isLHS, SplitVal); |
| 1866 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1867 | |
Chris Lattner | ba2d0b8 | 2010-01-23 19:16:25 +0000 | [diff] [blame] | 1868 | return true; |
| 1869 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1870 | |
Chris Lattner | eb73bdb | 2010-01-12 02:07:17 +0000 | [diff] [blame] | 1871 | // Try to duplicate BB into PredBB. |
Haicheng Wu | 64d9d7c | 2016-03-15 23:38:47 +0000 | [diff] [blame] | 1872 | return DuplicateCondBranchOnPHIIntoPred(BB, BlocksToFoldInto); |
Chris Lattner | eb73bdb | 2010-01-12 02:07:17 +0000 | [diff] [blame] | 1873 | } |
| 1874 | |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 1875 | /// AddPHINodeEntriesForMappedBlock - We're adding 'NewPred' as a new |
| 1876 | /// predecessor to the PHIBB block. If it has PHI nodes, add entries for |
| 1877 | /// NewPred using the entries from OldPred (suitably mapped). |
| 1878 | static void AddPHINodeEntriesForMappedBlock(BasicBlock *PHIBB, |
| 1879 | BasicBlock *OldPred, |
| 1880 | BasicBlock *NewPred, |
| 1881 | DenseMap<Instruction*, Value*> &ValueMap) { |
Benjamin Kramer | c7fc81e | 2017-12-30 15:27:33 +0000 | [diff] [blame] | 1882 | for (PHINode &PN : PHIBB->phis()) { |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 1883 | // Ok, we have a PHI node. Figure out what the incoming value was for the |
| 1884 | // DestBlock. |
Benjamin Kramer | c7fc81e | 2017-12-30 15:27:33 +0000 | [diff] [blame] | 1885 | Value *IV = PN.getIncomingValueForBlock(OldPred); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1886 | |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 1887 | // Remap the value if necessary. |
| 1888 | if (Instruction *Inst = dyn_cast<Instruction>(IV)) { |
| 1889 | DenseMap<Instruction*, Value*>::iterator I = ValueMap.find(Inst); |
| 1890 | if (I != ValueMap.end()) |
| 1891 | IV = I->second; |
| 1892 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1893 | |
Benjamin Kramer | c7fc81e | 2017-12-30 15:27:33 +0000 | [diff] [blame] | 1894 | PN.addIncoming(IV, NewPred); |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 1895 | } |
| 1896 | } |
Chris Lattner | 3df4c15 | 2008-04-22 07:05:46 +0000 | [diff] [blame] | 1897 | |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1898 | /// ThreadEdge - We have decided that it is safe and profitable to factor the |
| 1899 | /// blocks in PredBBs to one predecessor, then thread an edge from it to SuccBB |
| 1900 | /// across BB. Transform the IR to reflect this change. |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 1901 | bool JumpThreadingPass::ThreadEdge(BasicBlock *BB, |
| 1902 | const SmallVectorImpl<BasicBlock *> &PredBBs, |
| 1903 | BasicBlock *SuccBB) { |
Chris Lattner | d579cb1 | 2009-05-04 02:28:08 +0000 | [diff] [blame] | 1904 | // If threading to the same block as we come from, we would infinite loop. |
| 1905 | if (SuccBB == BB) { |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 1906 | LLVM_DEBUG(dbgs() << " Not threading across BB '" << BB->getName() |
| 1907 | << "' - would thread to self!\n"); |
Chris Lattner | d579cb1 | 2009-05-04 02:28:08 +0000 | [diff] [blame] | 1908 | return false; |
| 1909 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1910 | |
Chris Lattner | d579cb1 | 2009-05-04 02:28:08 +0000 | [diff] [blame] | 1911 | // If threading this would thread across a loop header, don't thread the edge. |
| 1912 | // See the comments above FindLoopHeaders for justifications and caveats. |
Krzysztof Parzyszek | 1dc3137 | 2017-09-06 19:36:58 +0000 | [diff] [blame] | 1913 | if (LoopHeaders.count(BB) || LoopHeaders.count(SuccBB)) { |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 1914 | LLVM_DEBUG({ |
Krzysztof Parzyszek | 1dc3137 | 2017-09-06 19:36:58 +0000 | [diff] [blame] | 1915 | bool BBIsHeader = LoopHeaders.count(BB); |
| 1916 | bool SuccIsHeader = LoopHeaders.count(SuccBB); |
| 1917 | dbgs() << " Not threading across " |
| 1918 | << (BBIsHeader ? "loop header BB '" : "block BB '") << BB->getName() |
| 1919 | << "' to dest " << (SuccIsHeader ? "loop header BB '" : "block BB '") |
| 1920 | << SuccBB->getName() << "' - it might create an irreducible loop!\n"; |
| 1921 | }); |
Chris Lattner | d579cb1 | 2009-05-04 02:28:08 +0000 | [diff] [blame] | 1922 | return false; |
| 1923 | } |
| 1924 | |
Sanjoy Das | 8b859c2 | 2017-02-17 04:21:14 +0000 | [diff] [blame] | 1925 | unsigned JumpThreadCost = |
| 1926 | getJumpThreadDuplicationCost(BB, BB->getTerminator(), BBDupThreshold); |
Michael Liao | d120916 | 2014-09-24 04:59:06 +0000 | [diff] [blame] | 1927 | if (JumpThreadCost > BBDupThreshold) { |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 1928 | LLVM_DEBUG(dbgs() << " Not threading BB '" << BB->getName() |
| 1929 | << "' - Cost is too high: " << JumpThreadCost << "\n"); |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 1930 | return false; |
| 1931 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1932 | |
David L Kreitzer | da700ce | 2015-09-16 13:27:30 +0000 | [diff] [blame] | 1933 | // And finally, do it! Start by factoring the predecessors if needed. |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1934 | BasicBlock *PredBB; |
| 1935 | if (PredBBs.size() == 1) |
| 1936 | PredBB = PredBBs[0]; |
| 1937 | else { |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 1938 | LLVM_DEBUG(dbgs() << " Factoring out " << PredBBs.size() |
| 1939 | << " common predecessors.\n"); |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 1940 | PredBB = SplitBlockPreds(BB, PredBBs, ".thr_comm"); |
Chris Lattner | 5ff7f56 | 2009-11-07 08:05:03 +0000 | [diff] [blame] | 1941 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1942 | |
Chris Lattner | d579cb1 | 2009-05-04 02:28:08 +0000 | [diff] [blame] | 1943 | // And finally, do it! |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 1944 | LLVM_DEBUG(dbgs() << " Threading edge from '" << PredBB->getName() |
| 1945 | << "' to '" << SuccBB->getName() |
| 1946 | << "' with cost: " << JumpThreadCost |
| 1947 | << ", across block:\n " << *BB << "\n"); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1948 | |
Brian M. Rzycki | f1a7df5 | 2018-02-16 16:35:17 +0000 | [diff] [blame] | 1949 | if (DDT->pending()) |
| 1950 | LVI->disableDT(); |
| 1951 | else |
| 1952 | LVI->enableDT(); |
Owen Anderson | d361aac | 2010-09-14 20:57:41 +0000 | [diff] [blame] | 1953 | LVI->threadEdge(PredBB, BB, SuccBB); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1954 | |
Chris Lattner | ff1c6e3 | 2008-04-20 22:39:42 +0000 | [diff] [blame] | 1955 | // We are going to have to map operands from the original BB block to the new |
| 1956 | // copy of the block 'NewBB'. If there are PHI nodes in BB, evaluate them to |
| 1957 | // account for entry from PredBB. |
| 1958 | DenseMap<Instruction*, Value*> ValueMapping; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1959 | |
| 1960 | BasicBlock *NewBB = BasicBlock::Create(BB->getContext(), |
| 1961 | BB->getName()+".thread", |
Owen Anderson | 55f1c09 | 2009-08-13 21:58:54 +0000 | [diff] [blame] | 1962 | BB->getParent(), BB); |
Chris Lattner | ff1c6e3 | 2008-04-20 22:39:42 +0000 | [diff] [blame] | 1963 | NewBB->moveAfter(PredBB); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1964 | |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 1965 | // Set the block frequency of NewBB. |
| 1966 | if (HasProfileData) { |
| 1967 | auto NewBBFreq = |
| 1968 | BFI->getBlockFreq(PredBB) * BPI->getEdgeProbability(PredBB, BB); |
| 1969 | BFI->setBlockFreq(NewBB, NewBBFreq.getFrequency()); |
| 1970 | } |
| 1971 | |
Chris Lattner | ff1c6e3 | 2008-04-20 22:39:42 +0000 | [diff] [blame] | 1972 | BasicBlock::iterator BI = BB->begin(); |
| 1973 | for (; PHINode *PN = dyn_cast<PHINode>(BI); ++BI) |
| 1974 | ValueMapping[PN] = PN->getIncomingValueForBlock(PredBB); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1975 | |
Chris Lattner | ff1c6e3 | 2008-04-20 22:39:42 +0000 | [diff] [blame] | 1976 | // Clone the non-phi instructions of BB into NewBB, keeping track of the |
| 1977 | // mapping and using it to remap operands in the cloned instructions. |
| 1978 | for (; !isa<TerminatorInst>(BI); ++BI) { |
Nick Lewycky | 42fb745 | 2009-09-27 07:38:41 +0000 | [diff] [blame] | 1979 | Instruction *New = BI->clone(); |
Daniel Dunbar | 6115b39 | 2009-07-26 09:48:23 +0000 | [diff] [blame] | 1980 | New->setName(BI->getName()); |
Chris Lattner | ff1c6e3 | 2008-04-20 22:39:42 +0000 | [diff] [blame] | 1981 | NewBB->getInstList().push_back(New); |
Duncan P. N. Exon Smith | 3a9c9e3 | 2015-10-13 18:26:00 +0000 | [diff] [blame] | 1982 | ValueMapping[&*BI] = New; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1983 | |
Chris Lattner | ff1c6e3 | 2008-04-20 22:39:42 +0000 | [diff] [blame] | 1984 | // Remap operands to patch up intra-block references. |
| 1985 | for (unsigned i = 0, e = New->getNumOperands(); i != e; ++i) |
Dan Gohman | 43f33dd | 2009-07-02 00:17:47 +0000 | [diff] [blame] | 1986 | if (Instruction *Inst = dyn_cast<Instruction>(New->getOperand(i))) { |
| 1987 | DenseMap<Instruction*, Value*>::iterator I = ValueMapping.find(Inst); |
| 1988 | if (I != ValueMapping.end()) |
| 1989 | New->setOperand(i, I->second); |
| 1990 | } |
Chris Lattner | ff1c6e3 | 2008-04-20 22:39:42 +0000 | [diff] [blame] | 1991 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1992 | |
Chris Lattner | ff1c6e3 | 2008-04-20 22:39:42 +0000 | [diff] [blame] | 1993 | // We didn't copy the terminator from BB over to NewBB, because there is now |
| 1994 | // an unconditional jump to SuccBB. Insert the unconditional jump. |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 1995 | BranchInst *NewBI = BranchInst::Create(SuccBB, NewBB); |
Devang Patel | 306f8db | 2011-05-04 22:48:19 +0000 | [diff] [blame] | 1996 | NewBI->setDebugLoc(BB->getTerminator()->getDebugLoc()); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 1997 | |
Chris Lattner | ff1c6e3 | 2008-04-20 22:39:42 +0000 | [diff] [blame] | 1998 | // Check to see if SuccBB has PHI nodes. If so, we need to add entries to the |
| 1999 | // PHI nodes for NewBB now. |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 2000 | AddPHINodeEntriesForMappedBlock(SuccBB, BB, NewBB, ValueMapping); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 2001 | |
Michael Zolotukhin | a41660d | 2018-05-12 01:52:36 +0000 | [diff] [blame] | 2002 | // Update the terminator of PredBB to jump to NewBB instead of BB. This |
| 2003 | // eliminates predecessors from BB, which requires us to simplify any PHI |
| 2004 | // nodes in BB. |
| 2005 | TerminatorInst *PredTerm = PredBB->getTerminator(); |
| 2006 | for (unsigned i = 0, e = PredTerm->getNumSuccessors(); i != e; ++i) |
| 2007 | if (PredTerm->getSuccessor(i) == BB) { |
| 2008 | BB->removePredecessor(PredBB, true); |
| 2009 | PredTerm->setSuccessor(i, NewBB); |
| 2010 | } |
| 2011 | |
Chris Lattner | 8409507 | 2009-10-10 09:05:58 +0000 | [diff] [blame] | 2012 | // If there were values defined in BB that are used outside the block, then we |
| 2013 | // now have to update all uses of the value to use either the original value, |
| 2014 | // the cloned value, or some PHI derived value. This can require arbitrary |
| 2015 | // PHI insertion, of which we are prepared to do, clean these up now. |
Michael Zolotukhin | a41660d | 2018-05-12 01:52:36 +0000 | [diff] [blame] | 2016 | SSAUpdaterBulk SSAUpdate; |
| 2017 | |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 2018 | for (Instruction &I : *BB) { |
Michael Zolotukhin | a41660d | 2018-05-12 01:52:36 +0000 | [diff] [blame] | 2019 | SmallVector<Use*, 16> UsesToRename; |
| 2020 | |
Chris Lattner | 8409507 | 2009-10-10 09:05:58 +0000 | [diff] [blame] | 2021 | // Scan all uses of this instruction to see if it is used outside of its |
Michael Zolotukhin | a41660d | 2018-05-12 01:52:36 +0000 | [diff] [blame] | 2022 | // block, and if so, record them in UsesToRename. Also, skip phi operands |
| 2023 | // from PredBB - we'll remove them anyway. |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 2024 | for (Use &U : I.uses()) { |
Chandler Carruth | cdf4788 | 2014-03-09 03:16:01 +0000 | [diff] [blame] | 2025 | Instruction *User = cast<Instruction>(U.getUser()); |
Chris Lattner | 8409507 | 2009-10-10 09:05:58 +0000 | [diff] [blame] | 2026 | if (PHINode *UserPN = dyn_cast<PHINode>(User)) { |
Michael Zolotukhin | a41660d | 2018-05-12 01:52:36 +0000 | [diff] [blame] | 2027 | if (UserPN->getIncomingBlock(U) == BB || |
| 2028 | UserPN->getIncomingBlock(U) == PredBB) |
Chris Lattner | 8409507 | 2009-10-10 09:05:58 +0000 | [diff] [blame] | 2029 | continue; |
| 2030 | } else if (User->getParent() == BB) |
| 2031 | continue; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 2032 | |
Chandler Carruth | cdf4788 | 2014-03-09 03:16:01 +0000 | [diff] [blame] | 2033 | UsesToRename.push_back(&U); |
Chris Lattner | 8409507 | 2009-10-10 09:05:58 +0000 | [diff] [blame] | 2034 | } |
Daniel Jasper | 0a51ec2 | 2017-09-30 11:57:19 +0000 | [diff] [blame] | 2035 | |
Chris Lattner | 8409507 | 2009-10-10 09:05:58 +0000 | [diff] [blame] | 2036 | // If there are no uses outside the block, we're done with this instruction. |
| 2037 | if (UsesToRename.empty()) |
| 2038 | continue; |
Michael Zolotukhin | a41660d | 2018-05-12 01:52:36 +0000 | [diff] [blame] | 2039 | unsigned VarNum = SSAUpdate.AddVariable(I.getName(), I.getType()); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 2040 | |
Michael Zolotukhin | a41660d | 2018-05-12 01:52:36 +0000 | [diff] [blame] | 2041 | // We found a use of I outside of BB - we need to rename all uses of I that |
| 2042 | // are outside its block to be uses of the appropriate PHI node etc. |
| 2043 | SSAUpdate.AddAvailableValue(VarNum, BB, &I); |
| 2044 | SSAUpdate.AddAvailableValue(VarNum, NewBB, ValueMapping[&I]); |
| 2045 | for (auto *U : UsesToRename) |
| 2046 | SSAUpdate.AddUse(VarNum, U); |
Chris Lattner | 8409507 | 2009-10-10 09:05:58 +0000 | [diff] [blame] | 2047 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 2048 | |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 2049 | DDT->applyUpdates({{DominatorTree::Insert, NewBB, SuccBB}, |
| 2050 | {DominatorTree::Insert, PredBB, NewBB}, |
| 2051 | {DominatorTree::Delete, PredBB, BB}}); |
| 2052 | |
Michael Zolotukhin | a41660d | 2018-05-12 01:52:36 +0000 | [diff] [blame] | 2053 | // Apply all updates we queued with DDT and get the updated Dominator Tree. |
| 2054 | DominatorTree *DT = &DDT->flush(); |
| 2055 | SSAUpdate.RewriteAllUses(DT); |
| 2056 | |
Chris Lattner | 88a1f02 | 2008-12-01 04:48:07 +0000 | [diff] [blame] | 2057 | // At this point, the IR is fully up to date and consistent. Do a quick scan |
| 2058 | // over the new instructions and zap any that are constants or dead. This |
| 2059 | // frequently happens because of phi translation. |
Mehdi Amini | a28d91d | 2015-03-10 02:37:25 +0000 | [diff] [blame] | 2060 | SimplifyInstructionsInBlock(NewBB, TLI); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 2061 | |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 2062 | // Update the edge weight from BB to SuccBB, which should be less than before. |
| 2063 | UpdateBlockFreqAndEdgeWeight(PredBB, BB, NewBB, SuccBB); |
| 2064 | |
Chris Lattner | d579cb1 | 2009-05-04 02:28:08 +0000 | [diff] [blame] | 2065 | // Threaded an edge! |
| 2066 | ++NumThreads; |
| 2067 | return true; |
Chris Lattner | 2115722 | 2008-04-20 21:13:06 +0000 | [diff] [blame] | 2068 | } |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 2069 | |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 2070 | /// Create a new basic block that will be the predecessor of BB and successor of |
Simon Pilgrim | 7d18a70 | 2016-11-20 13:19:49 +0000 | [diff] [blame] | 2071 | /// all blocks in Preds. When profile data is available, update the frequency of |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 2072 | /// this new block. |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 2073 | BasicBlock *JumpThreadingPass::SplitBlockPreds(BasicBlock *BB, |
| 2074 | ArrayRef<BasicBlock *> Preds, |
| 2075 | const char *Suffix) { |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 2076 | SmallVector<BasicBlock *, 2> NewBBs; |
| 2077 | |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 2078 | // Collect the frequencies of all predecessors of BB, which will be used to |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 2079 | // update the edge weight of the result of splitting predecessors. |
| 2080 | DenseMap<BasicBlock *, BlockFrequency> FreqMap; |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 2081 | if (HasProfileData) |
| 2082 | for (auto Pred : Preds) |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 2083 | FreqMap.insert(std::make_pair( |
| 2084 | Pred, BFI->getBlockFreq(Pred) * BPI->getEdgeProbability(Pred, BB))); |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 2085 | |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 2086 | // In the case when BB is a LandingPad block we create 2 new predecessors |
| 2087 | // instead of just one. |
| 2088 | if (BB->isLandingPad()) { |
| 2089 | std::string NewName = std::string(Suffix) + ".split-lp"; |
| 2090 | SplitLandingPadPredecessors(BB, Preds, Suffix, NewName.c_str(), NewBBs); |
| 2091 | } else { |
| 2092 | NewBBs.push_back(SplitBlockPredecessors(BB, Preds, Suffix)); |
| 2093 | } |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 2094 | |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 2095 | std::vector<DominatorTree::UpdateType> Updates; |
| 2096 | Updates.reserve((2 * Preds.size()) + NewBBs.size()); |
| 2097 | for (auto NewBB : NewBBs) { |
| 2098 | BlockFrequency NewBBFreq(0); |
| 2099 | Updates.push_back({DominatorTree::Insert, NewBB, BB}); |
| 2100 | for (auto Pred : predecessors(NewBB)) { |
| 2101 | Updates.push_back({DominatorTree::Delete, Pred, BB}); |
| 2102 | Updates.push_back({DominatorTree::Insert, Pred, NewBB}); |
| 2103 | if (HasProfileData) // Update frequencies between Pred -> NewBB. |
| 2104 | NewBBFreq += FreqMap.lookup(Pred); |
| 2105 | } |
| 2106 | if (HasProfileData) // Apply the summed frequency to NewBB. |
| 2107 | BFI->setBlockFreq(NewBB, NewBBFreq.getFrequency()); |
| 2108 | } |
| 2109 | |
| 2110 | DDT->applyUpdates(Updates); |
| 2111 | return NewBBs[0]; |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 2112 | } |
| 2113 | |
Adam Nemet | c520822 | 2016-09-06 16:08:33 +0000 | [diff] [blame] | 2114 | bool JumpThreadingPass::doesBlockHaveProfileData(BasicBlock *BB) { |
| 2115 | const TerminatorInst *TI = BB->getTerminator(); |
| 2116 | assert(TI->getNumSuccessors() > 1 && "not a split"); |
| 2117 | |
| 2118 | MDNode *WeightsNode = TI->getMetadata(LLVMContext::MD_prof); |
| 2119 | if (!WeightsNode) |
| 2120 | return false; |
| 2121 | |
| 2122 | MDString *MDName = cast<MDString>(WeightsNode->getOperand(0)); |
| 2123 | if (MDName->getString() != "branch_weights") |
| 2124 | return false; |
| 2125 | |
| 2126 | // Ensure there are weights for all of the successors. Note that the first |
| 2127 | // operand to the metadata node is a name, not a weight. |
| 2128 | return WeightsNode->getNumOperands() == TI->getNumSuccessors() + 1; |
| 2129 | } |
| 2130 | |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 2131 | /// Update the block frequency of BB and branch weight and the metadata on the |
| 2132 | /// edge BB->SuccBB. This is done by scaling the weight of BB->SuccBB by 1 - |
| 2133 | /// Freq(PredBB->BB) / Freq(BB->SuccBB). |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 2134 | void JumpThreadingPass::UpdateBlockFreqAndEdgeWeight(BasicBlock *PredBB, |
| 2135 | BasicBlock *BB, |
| 2136 | BasicBlock *NewBB, |
| 2137 | BasicBlock *SuccBB) { |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 2138 | if (!HasProfileData) |
| 2139 | return; |
| 2140 | |
| 2141 | assert(BFI && BPI && "BFI & BPI should have been created here"); |
| 2142 | |
| 2143 | // As the edge from PredBB to BB is deleted, we have to update the block |
| 2144 | // frequency of BB. |
| 2145 | auto BBOrigFreq = BFI->getBlockFreq(BB); |
| 2146 | auto NewBBFreq = BFI->getBlockFreq(NewBB); |
| 2147 | auto BB2SuccBBFreq = BBOrigFreq * BPI->getEdgeProbability(BB, SuccBB); |
| 2148 | auto BBNewFreq = BBOrigFreq - NewBBFreq; |
| 2149 | BFI->setBlockFreq(BB, BBNewFreq.getFrequency()); |
| 2150 | |
| 2151 | // Collect updated outgoing edges' frequencies from BB and use them to update |
Cong Hou | e93b8e1 | 2015-12-22 18:56:14 +0000 | [diff] [blame] | 2152 | // edge probabilities. |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 2153 | SmallVector<uint64_t, 4> BBSuccFreq; |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 2154 | for (BasicBlock *Succ : successors(BB)) { |
| 2155 | auto SuccFreq = (Succ == SuccBB) |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 2156 | ? BB2SuccBBFreq - NewBBFreq |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 2157 | : BBOrigFreq * BPI->getEdgeProbability(BB, Succ); |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 2158 | BBSuccFreq.push_back(SuccFreq.getFrequency()); |
| 2159 | } |
| 2160 | |
Cong Hou | e93b8e1 | 2015-12-22 18:56:14 +0000 | [diff] [blame] | 2161 | uint64_t MaxBBSuccFreq = |
| 2162 | *std::max_element(BBSuccFreq.begin(), BBSuccFreq.end()); |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 2163 | |
Cong Hou | 6a2c71a | 2015-12-22 23:45:55 +0000 | [diff] [blame] | 2164 | SmallVector<BranchProbability, 4> BBSuccProbs; |
| 2165 | if (MaxBBSuccFreq == 0) |
| 2166 | BBSuccProbs.assign(BBSuccFreq.size(), |
| 2167 | {1, static_cast<unsigned>(BBSuccFreq.size())}); |
| 2168 | else { |
| 2169 | for (uint64_t Freq : BBSuccFreq) |
| 2170 | BBSuccProbs.push_back( |
| 2171 | BranchProbability::getBranchProbability(Freq, MaxBBSuccFreq)); |
| 2172 | // Normalize edge probabilities so that they sum up to one. |
| 2173 | BranchProbability::normalizeProbabilities(BBSuccProbs.begin(), |
| 2174 | BBSuccProbs.end()); |
| 2175 | } |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 2176 | |
Cong Hou | e93b8e1 | 2015-12-22 18:56:14 +0000 | [diff] [blame] | 2177 | // Update edge probabilities in BPI. |
| 2178 | for (int I = 0, E = BBSuccProbs.size(); I < E; I++) |
| 2179 | BPI->setEdgeProbability(BB, I, BBSuccProbs[I]); |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 2180 | |
Adam Nemet | c520822 | 2016-09-06 16:08:33 +0000 | [diff] [blame] | 2181 | // Update the profile metadata as well. |
| 2182 | // |
| 2183 | // Don't do this if the profile of the transformed blocks was statically |
| 2184 | // estimated. (This could occur despite the function having an entry |
| 2185 | // frequency in completely cold parts of the CFG.) |
| 2186 | // |
| 2187 | // In this case we don't want to suggest to subsequent passes that the |
| 2188 | // calculated weights are fully consistent. Consider this graph: |
| 2189 | // |
| 2190 | // check_1 |
| 2191 | // 50% / | |
| 2192 | // eq_1 | 50% |
| 2193 | // \ | |
| 2194 | // check_2 |
| 2195 | // 50% / | |
| 2196 | // eq_2 | 50% |
| 2197 | // \ | |
| 2198 | // check_3 |
| 2199 | // 50% / | |
| 2200 | // eq_3 | 50% |
| 2201 | // \ | |
| 2202 | // |
| 2203 | // Assuming the blocks check_* all compare the same value against 1, 2 and 3, |
| 2204 | // the overall probabilities are inconsistent; the total probability that the |
| 2205 | // value is either 1, 2 or 3 is 150%. |
| 2206 | // |
| 2207 | // As a consequence if we thread eq_1 -> check_2 to check_3, check_2->check_3 |
| 2208 | // becomes 0%. This is even worse if the edge whose probability becomes 0% is |
| 2209 | // the loop exit edge. Then based solely on static estimation we would assume |
| 2210 | // the loop was extremely hot. |
| 2211 | // |
| 2212 | // FIXME this locally as well so that BPI and BFI are consistent as well. We |
| 2213 | // shouldn't make edges extremely likely or unlikely based solely on static |
| 2214 | // estimation. |
| 2215 | if (BBSuccProbs.size() >= 2 && doesBlockHaveProfileData(BB)) { |
Cong Hou | e93b8e1 | 2015-12-22 18:56:14 +0000 | [diff] [blame] | 2216 | SmallVector<uint32_t, 4> Weights; |
| 2217 | for (auto Prob : BBSuccProbs) |
| 2218 | Weights.push_back(Prob.getNumerator()); |
| 2219 | |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 2220 | auto TI = BB->getTerminator(); |
| 2221 | TI->setMetadata( |
| 2222 | LLVMContext::MD_prof, |
| 2223 | MDBuilder(TI->getParent()->getContext()).createBranchWeights(Weights)); |
| 2224 | } |
| 2225 | } |
| 2226 | |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 2227 | /// DuplicateCondBranchOnPHIIntoPred - PredBB contains an unconditional branch |
| 2228 | /// to BB which contains an i1 PHI node and a conditional branch on that PHI. |
| 2229 | /// If we can duplicate the contents of BB up into PredBB do so now, this |
| 2230 | /// improves the odds that the branch will be on an analyzable instruction like |
| 2231 | /// a compare. |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 2232 | bool JumpThreadingPass::DuplicateCondBranchOnPHIIntoPred( |
| 2233 | BasicBlock *BB, const SmallVectorImpl<BasicBlock *> &PredBBs) { |
Chris Lattner | eb73bdb | 2010-01-12 02:07:17 +0000 | [diff] [blame] | 2234 | assert(!PredBBs.empty() && "Can't handle an empty set"); |
| 2235 | |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 2236 | // If BB is a loop header, then duplicating this block outside the loop would |
| 2237 | // cause us to transform this into an irreducible loop, don't do this. |
| 2238 | // See the comments above FindLoopHeaders for justifications and caveats. |
| 2239 | if (LoopHeaders.count(BB)) { |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 2240 | LLVM_DEBUG(dbgs() << " Not duplicating loop header '" << BB->getName() |
| 2241 | << "' into predecessor block '" << PredBBs[0]->getName() |
| 2242 | << "' - it might create an irreducible loop!\n"); |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 2243 | return false; |
| 2244 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 2245 | |
Sanjoy Das | 8b859c2 | 2017-02-17 04:21:14 +0000 | [diff] [blame] | 2246 | unsigned DuplicationCost = |
| 2247 | getJumpThreadDuplicationCost(BB, BB->getTerminator(), BBDupThreshold); |
Michael Liao | d120916 | 2014-09-24 04:59:06 +0000 | [diff] [blame] | 2248 | if (DuplicationCost > BBDupThreshold) { |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 2249 | LLVM_DEBUG(dbgs() << " Not duplicating BB '" << BB->getName() |
| 2250 | << "' - Cost is too high: " << DuplicationCost << "\n"); |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 2251 | return false; |
| 2252 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 2253 | |
David L Kreitzer | da700ce | 2015-09-16 13:27:30 +0000 | [diff] [blame] | 2254 | // And finally, do it! Start by factoring the predecessors if needed. |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 2255 | std::vector<DominatorTree::UpdateType> Updates; |
Chris Lattner | eb73bdb | 2010-01-12 02:07:17 +0000 | [diff] [blame] | 2256 | BasicBlock *PredBB; |
| 2257 | if (PredBBs.size() == 1) |
| 2258 | PredBB = PredBBs[0]; |
| 2259 | else { |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 2260 | LLVM_DEBUG(dbgs() << " Factoring out " << PredBBs.size() |
| 2261 | << " common predecessors.\n"); |
Manman Ren | 72d44b1 | 2015-10-15 14:59:40 +0000 | [diff] [blame] | 2262 | PredBB = SplitBlockPreds(BB, PredBBs, ".thr_comm"); |
Chris Lattner | eb73bdb | 2010-01-12 02:07:17 +0000 | [diff] [blame] | 2263 | } |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 2264 | Updates.push_back({DominatorTree::Delete, PredBB, BB}); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 2265 | |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 2266 | // Okay, we decided to do this! Clone all the instructions in BB onto the end |
| 2267 | // of PredBB. |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 2268 | LLVM_DEBUG(dbgs() << " Duplicating block '" << BB->getName() |
| 2269 | << "' into end of '" << PredBB->getName() |
| 2270 | << "' to eliminate branch on phi. Cost: " |
| 2271 | << DuplicationCost << " block is:" << *BB << "\n"); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 2272 | |
Chris Lattner | eb73bdb | 2010-01-12 02:07:17 +0000 | [diff] [blame] | 2273 | // Unless PredBB ends with an unconditional branch, split the edge so that we |
| 2274 | // can just clone the bits from BB into the end of the new PredBB. |
Chris Lattner | 29b15c5 | 2010-01-23 19:21:31 +0000 | [diff] [blame] | 2275 | BranchInst *OldPredBranch = dyn_cast<BranchInst>(PredBB->getTerminator()); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 2276 | |
Craig Topper | f40110f | 2014-04-25 05:29:35 +0000 | [diff] [blame] | 2277 | if (!OldPredBranch || !OldPredBranch->isUnconditional()) { |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 2278 | BasicBlock *OldPredBB = PredBB; |
| 2279 | PredBB = SplitEdge(OldPredBB, BB); |
| 2280 | Updates.push_back({DominatorTree::Insert, OldPredBB, PredBB}); |
| 2281 | Updates.push_back({DominatorTree::Insert, PredBB, BB}); |
| 2282 | Updates.push_back({DominatorTree::Delete, OldPredBB, BB}); |
Chris Lattner | eb73bdb | 2010-01-12 02:07:17 +0000 | [diff] [blame] | 2283 | OldPredBranch = cast<BranchInst>(PredBB->getTerminator()); |
| 2284 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 2285 | |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 2286 | // We are going to have to map operands from the original BB block into the |
| 2287 | // PredBB block. Evaluate PHI nodes in BB. |
| 2288 | DenseMap<Instruction*, Value*> ValueMapping; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 2289 | |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 2290 | BasicBlock::iterator BI = BB->begin(); |
| 2291 | for (; PHINode *PN = dyn_cast<PHINode>(BI); ++BI) |
| 2292 | ValueMapping[PN] = PN->getIncomingValueForBlock(PredBB); |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 2293 | // Clone the non-phi instructions of BB into PredBB, keeping track of the |
| 2294 | // mapping and using it to remap operands in the cloned instructions. |
| 2295 | for (; BI != BB->end(); ++BI) { |
| 2296 | Instruction *New = BI->clone(); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 2297 | |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 2298 | // Remap operands to patch up intra-block references. |
| 2299 | for (unsigned i = 0, e = New->getNumOperands(); i != e; ++i) |
| 2300 | if (Instruction *Inst = dyn_cast<Instruction>(New->getOperand(i))) { |
| 2301 | DenseMap<Instruction*, Value*>::iterator I = ValueMapping.find(Inst); |
| 2302 | if (I != ValueMapping.end()) |
| 2303 | New->setOperand(i, I->second); |
| 2304 | } |
Chris Lattner | 573da8a | 2010-01-12 20:41:47 +0000 | [diff] [blame] | 2305 | |
| 2306 | // If this instruction can be simplified after the operands are updated, |
| 2307 | // just use the simplified value instead. This frequently happens due to |
| 2308 | // phi translation. |
Daniel Berlin | 4d0fe64 | 2017-04-28 19:55:38 +0000 | [diff] [blame] | 2309 | if (Value *IV = SimplifyInstruction( |
| 2310 | New, |
| 2311 | {BB->getModule()->getDataLayout(), TLI, nullptr, nullptr, New})) { |
Duncan P. N. Exon Smith | 3a9c9e3 | 2015-10-13 18:26:00 +0000 | [diff] [blame] | 2312 | ValueMapping[&*BI] = IV; |
David Majnemer | b8da3a2 | 2016-06-25 00:04:10 +0000 | [diff] [blame] | 2313 | if (!New->mayHaveSideEffects()) { |
Reid Kleckner | 96ab872 | 2017-05-18 17:24:10 +0000 | [diff] [blame] | 2314 | New->deleteValue(); |
David Majnemer | b8da3a2 | 2016-06-25 00:04:10 +0000 | [diff] [blame] | 2315 | New = nullptr; |
| 2316 | } |
Chris Lattner | 573da8a | 2010-01-12 20:41:47 +0000 | [diff] [blame] | 2317 | } else { |
David Majnemer | b8da3a2 | 2016-06-25 00:04:10 +0000 | [diff] [blame] | 2318 | ValueMapping[&*BI] = New; |
| 2319 | } |
| 2320 | if (New) { |
Chris Lattner | 573da8a | 2010-01-12 20:41:47 +0000 | [diff] [blame] | 2321 | // Otherwise, insert the new instruction into the block. |
| 2322 | New->setName(BI->getName()); |
Duncan P. N. Exon Smith | 3a9c9e3 | 2015-10-13 18:26:00 +0000 | [diff] [blame] | 2323 | PredBB->getInstList().insert(OldPredBranch->getIterator(), New); |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 2324 | // Update Dominance from simplified New instruction operands. |
| 2325 | for (unsigned i = 0, e = New->getNumOperands(); i != e; ++i) |
| 2326 | if (BasicBlock *SuccBB = dyn_cast<BasicBlock>(New->getOperand(i))) |
| 2327 | Updates.push_back({DominatorTree::Insert, PredBB, SuccBB}); |
Chris Lattner | 573da8a | 2010-01-12 20:41:47 +0000 | [diff] [blame] | 2328 | } |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 2329 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 2330 | |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 2331 | // Check to see if the targets of the branch had PHI nodes. If so, we need to |
| 2332 | // add entries to the PHI nodes for branch from PredBB now. |
| 2333 | BranchInst *BBBranch = cast<BranchInst>(BB->getTerminator()); |
| 2334 | AddPHINodeEntriesForMappedBlock(BBBranch->getSuccessor(0), BB, PredBB, |
| 2335 | ValueMapping); |
| 2336 | AddPHINodeEntriesForMappedBlock(BBBranch->getSuccessor(1), BB, PredBB, |
| 2337 | ValueMapping); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 2338 | |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 2339 | // If there were values defined in BB that are used outside the block, then we |
| 2340 | // now have to update all uses of the value to use either the original value, |
| 2341 | // the cloned value, or some PHI derived value. This can require arbitrary |
| 2342 | // PHI insertion, of which we are prepared to do, clean these up now. |
| 2343 | SSAUpdater SSAUpdate; |
| 2344 | SmallVector<Use*, 16> UsesToRename; |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 2345 | for (Instruction &I : *BB) { |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 2346 | // Scan all uses of this instruction to see if it is used outside of its |
| 2347 | // block, and if so, record them in UsesToRename. |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 2348 | for (Use &U : I.uses()) { |
Chandler Carruth | cdf4788 | 2014-03-09 03:16:01 +0000 | [diff] [blame] | 2349 | Instruction *User = cast<Instruction>(U.getUser()); |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 2350 | if (PHINode *UserPN = dyn_cast<PHINode>(User)) { |
Chandler Carruth | cdf4788 | 2014-03-09 03:16:01 +0000 | [diff] [blame] | 2351 | if (UserPN->getIncomingBlock(U) == BB) |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 2352 | continue; |
| 2353 | } else if (User->getParent() == BB) |
| 2354 | continue; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 2355 | |
Chandler Carruth | cdf4788 | 2014-03-09 03:16:01 +0000 | [diff] [blame] | 2356 | UsesToRename.push_back(&U); |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 2357 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 2358 | |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 2359 | // If there are no uses outside the block, we're done with this instruction. |
| 2360 | if (UsesToRename.empty()) |
| 2361 | continue; |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 2362 | |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 2363 | LLVM_DEBUG(dbgs() << "JT: Renaming non-local uses of: " << I << "\n"); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 2364 | |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 2365 | // We found a use of I outside of BB. Rename all uses of I that are outside |
| 2366 | // its block to be uses of the appropriate PHI node etc. See ValuesInBlocks |
| 2367 | // with the two values we know. |
Benjamin Kramer | 543762d | 2016-01-09 18:43:01 +0000 | [diff] [blame] | 2368 | SSAUpdate.Initialize(I.getType(), I.getName()); |
| 2369 | SSAUpdate.AddAvailableValue(BB, &I); |
| 2370 | SSAUpdate.AddAvailableValue(PredBB, ValueMapping[&I]); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 2371 | |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 2372 | while (!UsesToRename.empty()) |
| 2373 | SSAUpdate.RewriteUse(*UsesToRename.pop_back_val()); |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 2374 | LLVM_DEBUG(dbgs() << "\n"); |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 2375 | } |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 2376 | |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 2377 | // PredBB no longer jumps to BB, remove entries in the PHI node for the edge |
| 2378 | // that we nuked. |
Owen Anderson | 99c985c | 2010-09-29 20:34:41 +0000 | [diff] [blame] | 2379 | BB->removePredecessor(PredBB, true); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 2380 | |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 2381 | // Remove the unconditional branch at the end of the PredBB block. |
| 2382 | OldPredBranch->eraseFromParent(); |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 2383 | DDT->applyUpdates(Updates); |
Frits van Bommel | 5e75ef4 | 2010-12-05 19:02:47 +0000 | [diff] [blame] | 2384 | |
Chris Lattner | 97b1405 | 2009-10-11 07:24:57 +0000 | [diff] [blame] | 2385 | ++NumDupes; |
| 2386 | return true; |
| 2387 | } |
Benjamin Kramer | 6a4976d | 2013-08-07 10:29:38 +0000 | [diff] [blame] | 2388 | |
| 2389 | /// TryToUnfoldSelect - Look for blocks of the form |
| 2390 | /// bb1: |
| 2391 | /// %a = select |
Xin Tong | 3ca169f | 2017-02-26 19:08:44 +0000 | [diff] [blame] | 2392 | /// br bb2 |
Benjamin Kramer | 6a4976d | 2013-08-07 10:29:38 +0000 | [diff] [blame] | 2393 | /// |
| 2394 | /// bb2: |
Xin Tong | 3ca169f | 2017-02-26 19:08:44 +0000 | [diff] [blame] | 2395 | /// %p = phi [%a, %bb1] ... |
Benjamin Kramer | 6a4976d | 2013-08-07 10:29:38 +0000 | [diff] [blame] | 2396 | /// %c = icmp %p |
| 2397 | /// br i1 %c |
| 2398 | /// |
| 2399 | /// And expand the select into a branch structure if one of its arms allows %c |
| 2400 | /// to be folded. This later enables threading from bb1 over bb2. |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 2401 | bool JumpThreadingPass::TryToUnfoldSelect(CmpInst *CondCmp, BasicBlock *BB) { |
Benjamin Kramer | 6a4976d | 2013-08-07 10:29:38 +0000 | [diff] [blame] | 2402 | BranchInst *CondBr = dyn_cast<BranchInst>(BB->getTerminator()); |
| 2403 | PHINode *CondLHS = dyn_cast<PHINode>(CondCmp->getOperand(0)); |
| 2404 | Constant *CondRHS = cast<Constant>(CondCmp->getOperand(1)); |
| 2405 | |
| 2406 | if (!CondBr || !CondBr->isConditional() || !CondLHS || |
| 2407 | CondLHS->getParent() != BB) |
| 2408 | return false; |
| 2409 | |
| 2410 | for (unsigned I = 0, E = CondLHS->getNumIncomingValues(); I != E; ++I) { |
| 2411 | BasicBlock *Pred = CondLHS->getIncomingBlock(I); |
| 2412 | SelectInst *SI = dyn_cast<SelectInst>(CondLHS->getIncomingValue(I)); |
| 2413 | |
| 2414 | // Look if one of the incoming values is a select in the corresponding |
| 2415 | // predecessor. |
| 2416 | if (!SI || SI->getParent() != Pred || !SI->hasOneUse()) |
| 2417 | continue; |
| 2418 | |
| 2419 | BranchInst *PredTerm = dyn_cast<BranchInst>(Pred->getTerminator()); |
| 2420 | if (!PredTerm || !PredTerm->isUnconditional()) |
| 2421 | continue; |
| 2422 | |
| 2423 | // Now check if one of the select values would allow us to constant fold the |
| 2424 | // terminator in BB. We don't do the transform if both sides fold, those |
| 2425 | // cases will be threaded in any case. |
Brian M. Rzycki | f1a7df5 | 2018-02-16 16:35:17 +0000 | [diff] [blame] | 2426 | if (DDT->pending()) |
| 2427 | LVI->disableDT(); |
| 2428 | else |
| 2429 | LVI->enableDT(); |
Benjamin Kramer | 6a4976d | 2013-08-07 10:29:38 +0000 | [diff] [blame] | 2430 | LazyValueInfo::Tristate LHSFolds = |
| 2431 | LVI->getPredicateOnEdge(CondCmp->getPredicate(), SI->getOperand(1), |
Hal Finkel | 7e18449 | 2014-09-07 20:29:59 +0000 | [diff] [blame] | 2432 | CondRHS, Pred, BB, CondCmp); |
Benjamin Kramer | 6a4976d | 2013-08-07 10:29:38 +0000 | [diff] [blame] | 2433 | LazyValueInfo::Tristate RHSFolds = |
| 2434 | LVI->getPredicateOnEdge(CondCmp->getPredicate(), SI->getOperand(2), |
Hal Finkel | 7e18449 | 2014-09-07 20:29:59 +0000 | [diff] [blame] | 2435 | CondRHS, Pred, BB, CondCmp); |
Benjamin Kramer | 6a4976d | 2013-08-07 10:29:38 +0000 | [diff] [blame] | 2436 | if ((LHSFolds != LazyValueInfo::Unknown || |
| 2437 | RHSFolds != LazyValueInfo::Unknown) && |
| 2438 | LHSFolds != RHSFolds) { |
| 2439 | // Expand the select. |
| 2440 | // |
| 2441 | // Pred -- |
| 2442 | // | v |
| 2443 | // | NewBB |
| 2444 | // | | |
| 2445 | // |----- |
| 2446 | // v |
| 2447 | // BB |
| 2448 | BasicBlock *NewBB = BasicBlock::Create(BB->getContext(), "select.unfold", |
| 2449 | BB->getParent(), BB); |
| 2450 | // Move the unconditional branch to NewBB. |
| 2451 | PredTerm->removeFromParent(); |
| 2452 | NewBB->getInstList().insert(NewBB->end(), PredTerm); |
| 2453 | // Create a conditional branch and update PHI nodes. |
| 2454 | BranchInst::Create(NewBB, BB, SI->getCondition(), Pred); |
| 2455 | CondLHS->setIncomingValue(I, SI->getFalseValue()); |
| 2456 | CondLHS->addIncoming(SI->getTrueValue(), NewBB); |
| 2457 | // The select is now dead. |
| 2458 | SI->eraseFromParent(); |
| 2459 | |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 2460 | DDT->applyUpdates({{DominatorTree::Insert, NewBB, BB}, |
| 2461 | {DominatorTree::Insert, Pred, NewBB}}); |
Benjamin Kramer | 6a4976d | 2013-08-07 10:29:38 +0000 | [diff] [blame] | 2462 | // Update any other PHI nodes in BB. |
| 2463 | for (BasicBlock::iterator BI = BB->begin(); |
| 2464 | PHINode *Phi = dyn_cast<PHINode>(BI); ++BI) |
| 2465 | if (Phi != CondLHS) |
| 2466 | Phi->addIncoming(Phi->getIncomingValueForBlock(Pred), NewBB); |
| 2467 | return true; |
| 2468 | } |
| 2469 | } |
| 2470 | return false; |
| 2471 | } |
Haicheng Wu | a6a3279 | 2016-01-08 19:39:39 +0000 | [diff] [blame] | 2472 | |
Haicheng Wu | 476adcc | 2017-07-14 19:16:47 +0000 | [diff] [blame] | 2473 | /// TryToUnfoldSelectInCurrBB - Look for PHI/Select or PHI/CMP/Select in the |
| 2474 | /// same BB in the form |
Haicheng Wu | a6a3279 | 2016-01-08 19:39:39 +0000 | [diff] [blame] | 2475 | /// bb: |
| 2476 | /// %p = phi [false, %bb1], [true, %bb2], [false, %bb3], [true, %bb4], ... |
Haicheng Wu | 476adcc | 2017-07-14 19:16:47 +0000 | [diff] [blame] | 2477 | /// %s = select %p, trueval, falseval |
Haicheng Wu | a6a3279 | 2016-01-08 19:39:39 +0000 | [diff] [blame] | 2478 | /// |
Haicheng Wu | 476adcc | 2017-07-14 19:16:47 +0000 | [diff] [blame] | 2479 | /// or |
| 2480 | /// |
| 2481 | /// bb: |
| 2482 | /// %p = phi [0, %bb1], [1, %bb2], [0, %bb3], [1, %bb4], ... |
| 2483 | /// %c = cmp %p, 0 |
| 2484 | /// %s = select %c, trueval, falseval |
Eugene Zelenko | 8002c50 | 2017-09-13 21:43:53 +0000 | [diff] [blame] | 2485 | /// |
Pablo Barrio | 4f80c93 | 2016-11-15 15:42:23 +0000 | [diff] [blame] | 2486 | /// And expand the select into a branch structure. This later enables |
Haicheng Wu | a6a3279 | 2016-01-08 19:39:39 +0000 | [diff] [blame] | 2487 | /// jump-threading over bb in this pass. |
| 2488 | /// |
Pablo Barrio | 4f80c93 | 2016-11-15 15:42:23 +0000 | [diff] [blame] | 2489 | /// Using the similar approach of SimplifyCFG::FoldCondBranchOnPHI(), unfold |
| 2490 | /// select if the associated PHI has at least one constant. If the unfolded |
| 2491 | /// select is not jump-threaded, it will be folded again in the later |
| 2492 | /// optimizations. |
Sean Silva | 46590d5 | 2016-06-14 00:51:09 +0000 | [diff] [blame] | 2493 | bool JumpThreadingPass::TryToUnfoldSelectInCurrBB(BasicBlock *BB) { |
Haicheng Wu | a6a3279 | 2016-01-08 19:39:39 +0000 | [diff] [blame] | 2494 | // If threading this would thread across a loop header, don't thread the edge. |
| 2495 | // See the comments above FindLoopHeaders for justifications and caveats. |
| 2496 | if (LoopHeaders.count(BB)) |
| 2497 | return false; |
| 2498 | |
Pablo Barrio | 4f80c93 | 2016-11-15 15:42:23 +0000 | [diff] [blame] | 2499 | for (BasicBlock::iterator BI = BB->begin(); |
| 2500 | PHINode *PN = dyn_cast<PHINode>(BI); ++BI) { |
Haicheng Wu | 476adcc | 2017-07-14 19:16:47 +0000 | [diff] [blame] | 2501 | // Look for a Phi having at least one constant incoming value. |
| 2502 | if (llvm::all_of(PN->incoming_values(), |
| 2503 | [](Value *V) { return !isa<ConstantInt>(V); })) |
Nico Weber | b38d341 | 2016-10-24 14:52:04 +0000 | [diff] [blame] | 2504 | continue; |
Pablo Barrio | 4f80c93 | 2016-11-15 15:42:23 +0000 | [diff] [blame] | 2505 | |
Haicheng Wu | 476adcc | 2017-07-14 19:16:47 +0000 | [diff] [blame] | 2506 | auto isUnfoldCandidate = [BB](SelectInst *SI, Value *V) { |
| 2507 | // Check if SI is in BB and use V as condition. |
| 2508 | if (SI->getParent() != BB) |
Pablo Barrio | 4f80c93 | 2016-11-15 15:42:23 +0000 | [diff] [blame] | 2509 | return false; |
Haicheng Wu | 476adcc | 2017-07-14 19:16:47 +0000 | [diff] [blame] | 2510 | Value *Cond = SI->getCondition(); |
| 2511 | return (Cond && Cond == V && Cond->getType()->isIntegerTy(1)); |
| 2512 | }; |
| 2513 | |
| 2514 | SelectInst *SI = nullptr; |
| 2515 | for (Use &U : PN->uses()) { |
| 2516 | if (ICmpInst *Cmp = dyn_cast<ICmpInst>(U.getUser())) { |
| 2517 | // Look for a ICmp in BB that compares PN with a constant and is the |
| 2518 | // condition of a Select. |
| 2519 | if (Cmp->getParent() == BB && Cmp->hasOneUse() && |
| 2520 | isa<ConstantInt>(Cmp->getOperand(1 - U.getOperandNo()))) |
| 2521 | if (SelectInst *SelectI = dyn_cast<SelectInst>(Cmp->user_back())) |
| 2522 | if (isUnfoldCandidate(SelectI, Cmp->use_begin()->get())) { |
| 2523 | SI = SelectI; |
| 2524 | break; |
| 2525 | } |
| 2526 | } else if (SelectInst *SelectI = dyn_cast<SelectInst>(U.getUser())) { |
| 2527 | // Look for a Select in BB that uses PN as condtion. |
| 2528 | if (isUnfoldCandidate(SelectI, U.get())) { |
| 2529 | SI = SelectI; |
| 2530 | break; |
| 2531 | } |
| 2532 | } |
Haicheng Wu | a6a3279 | 2016-01-08 19:39:39 +0000 | [diff] [blame] | 2533 | } |
| 2534 | |
Haicheng Wu | 476adcc | 2017-07-14 19:16:47 +0000 | [diff] [blame] | 2535 | if (!SI) |
| 2536 | continue; |
| 2537 | // Expand the select. |
| 2538 | TerminatorInst *Term = |
Daniel Jasper | 0a51ec2 | 2017-09-30 11:57:19 +0000 | [diff] [blame] | 2539 | SplitBlockAndInsertIfThen(SI->getCondition(), SI, false); |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 2540 | BasicBlock *SplitBB = SI->getParent(); |
| 2541 | BasicBlock *NewBB = Term->getParent(); |
Haicheng Wu | 476adcc | 2017-07-14 19:16:47 +0000 | [diff] [blame] | 2542 | PHINode *NewPN = PHINode::Create(SI->getType(), 2, "", SI); |
| 2543 | NewPN->addIncoming(SI->getTrueValue(), Term->getParent()); |
| 2544 | NewPN->addIncoming(SI->getFalseValue(), BB); |
| 2545 | SI->replaceAllUsesWith(NewPN); |
| 2546 | SI->eraseFromParent(); |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 2547 | // NewBB and SplitBB are newly created blocks which require insertion. |
| 2548 | std::vector<DominatorTree::UpdateType> Updates; |
| 2549 | Updates.reserve((2 * SplitBB->getTerminator()->getNumSuccessors()) + 3); |
| 2550 | Updates.push_back({DominatorTree::Insert, BB, SplitBB}); |
| 2551 | Updates.push_back({DominatorTree::Insert, BB, NewBB}); |
| 2552 | Updates.push_back({DominatorTree::Insert, NewBB, SplitBB}); |
| 2553 | // BB's successors were moved to SplitBB, update DDT accordingly. |
| 2554 | for (auto *Succ : successors(SplitBB)) { |
| 2555 | Updates.push_back({DominatorTree::Delete, BB, Succ}); |
| 2556 | Updates.push_back({DominatorTree::Insert, SplitBB, Succ}); |
| 2557 | } |
| 2558 | DDT->applyUpdates(Updates); |
Haicheng Wu | 476adcc | 2017-07-14 19:16:47 +0000 | [diff] [blame] | 2559 | return true; |
Haicheng Wu | a6a3279 | 2016-01-08 19:39:39 +0000 | [diff] [blame] | 2560 | } |
Pablo Barrio | 4f80c93 | 2016-11-15 15:42:23 +0000 | [diff] [blame] | 2561 | return false; |
Haicheng Wu | a6a3279 | 2016-01-08 19:39:39 +0000 | [diff] [blame] | 2562 | } |
Sanjoy Das | 8b859c2 | 2017-02-17 04:21:14 +0000 | [diff] [blame] | 2563 | |
| 2564 | /// Try to propagate a guard from the current BB into one of its predecessors |
| 2565 | /// in case if another branch of execution implies that the condition of this |
| 2566 | /// guard is always true. Currently we only process the simplest case that |
| 2567 | /// looks like: |
| 2568 | /// |
| 2569 | /// Start: |
| 2570 | /// %cond = ... |
| 2571 | /// br i1 %cond, label %T1, label %F1 |
| 2572 | /// T1: |
| 2573 | /// br label %Merge |
| 2574 | /// F1: |
| 2575 | /// br label %Merge |
| 2576 | /// Merge: |
| 2577 | /// %condGuard = ... |
| 2578 | /// call void(i1, ...) @llvm.experimental.guard( i1 %condGuard )[ "deopt"() ] |
| 2579 | /// |
| 2580 | /// And cond either implies condGuard or !condGuard. In this case all the |
| 2581 | /// instructions before the guard can be duplicated in both branches, and the |
| 2582 | /// guard is then threaded to one of them. |
| 2583 | bool JumpThreadingPass::ProcessGuards(BasicBlock *BB) { |
| 2584 | using namespace PatternMatch; |
Eugene Zelenko | 8002c50 | 2017-09-13 21:43:53 +0000 | [diff] [blame] | 2585 | |
Sanjoy Das | 8b859c2 | 2017-02-17 04:21:14 +0000 | [diff] [blame] | 2586 | // We only want to deal with two predecessors. |
| 2587 | BasicBlock *Pred1, *Pred2; |
| 2588 | auto PI = pred_begin(BB), PE = pred_end(BB); |
| 2589 | if (PI == PE) |
| 2590 | return false; |
| 2591 | Pred1 = *PI++; |
| 2592 | if (PI == PE) |
| 2593 | return false; |
| 2594 | Pred2 = *PI++; |
| 2595 | if (PI != PE) |
| 2596 | return false; |
| 2597 | if (Pred1 == Pred2) |
| 2598 | return false; |
| 2599 | |
| 2600 | // Try to thread one of the guards of the block. |
| 2601 | // TODO: Look up deeper than to immediate predecessor? |
| 2602 | auto *Parent = Pred1->getSinglePredecessor(); |
| 2603 | if (!Parent || Parent != Pred2->getSinglePredecessor()) |
| 2604 | return false; |
| 2605 | |
| 2606 | if (auto *BI = dyn_cast<BranchInst>(Parent->getTerminator())) |
| 2607 | for (auto &I : *BB) |
| 2608 | if (match(&I, m_Intrinsic<Intrinsic::experimental_guard>())) |
| 2609 | if (ThreadGuard(BB, cast<IntrinsicInst>(&I), BI)) |
| 2610 | return true; |
| 2611 | |
| 2612 | return false; |
| 2613 | } |
| 2614 | |
| 2615 | /// Try to propagate the guard from BB which is the lower block of a diamond |
| 2616 | /// to one of its branches, in case if diamond's condition implies guard's |
| 2617 | /// condition. |
| 2618 | bool JumpThreadingPass::ThreadGuard(BasicBlock *BB, IntrinsicInst *Guard, |
| 2619 | BranchInst *BI) { |
| 2620 | assert(BI->getNumSuccessors() == 2 && "Wrong number of successors?"); |
| 2621 | assert(BI->isConditional() && "Unconditional branch has 2 successors?"); |
| 2622 | Value *GuardCond = Guard->getArgOperand(0); |
| 2623 | Value *BranchCond = BI->getCondition(); |
| 2624 | BasicBlock *TrueDest = BI->getSuccessor(0); |
| 2625 | BasicBlock *FalseDest = BI->getSuccessor(1); |
| 2626 | |
| 2627 | auto &DL = BB->getModule()->getDataLayout(); |
| 2628 | bool TrueDestIsSafe = false; |
| 2629 | bool FalseDestIsSafe = false; |
| 2630 | |
| 2631 | // True dest is safe if BranchCond => GuardCond. |
| 2632 | auto Impl = isImpliedCondition(BranchCond, GuardCond, DL); |
| 2633 | if (Impl && *Impl) |
| 2634 | TrueDestIsSafe = true; |
| 2635 | else { |
| 2636 | // False dest is safe if !BranchCond => GuardCond. |
Chad Rosier | dfd1de6 | 2017-08-01 20:18:54 +0000 | [diff] [blame] | 2637 | Impl = isImpliedCondition(BranchCond, GuardCond, DL, /* LHSIsTrue */ false); |
Sanjoy Das | 8b859c2 | 2017-02-17 04:21:14 +0000 | [diff] [blame] | 2638 | if (Impl && *Impl) |
| 2639 | FalseDestIsSafe = true; |
| 2640 | } |
| 2641 | |
| 2642 | if (!TrueDestIsSafe && !FalseDestIsSafe) |
| 2643 | return false; |
| 2644 | |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 2645 | BasicBlock *PredUnguardedBlock = TrueDestIsSafe ? TrueDest : FalseDest; |
| 2646 | BasicBlock *PredGuardedBlock = FalseDestIsSafe ? TrueDest : FalseDest; |
Sanjoy Das | 8b859c2 | 2017-02-17 04:21:14 +0000 | [diff] [blame] | 2647 | |
| 2648 | ValueToValueMapTy UnguardedMapping, GuardedMapping; |
| 2649 | Instruction *AfterGuard = Guard->getNextNode(); |
| 2650 | unsigned Cost = getJumpThreadDuplicationCost(BB, AfterGuard, BBDupThreshold); |
| 2651 | if (Cost > BBDupThreshold) |
| 2652 | return false; |
| 2653 | // Duplicate all instructions before the guard and the guard itself to the |
| 2654 | // branch where implication is not proved. |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 2655 | BasicBlock *GuardedBlock = DuplicateInstructionsInSplitBetween( |
| 2656 | BB, PredGuardedBlock, AfterGuard, GuardedMapping); |
Sanjoy Das | 8b859c2 | 2017-02-17 04:21:14 +0000 | [diff] [blame] | 2657 | assert(GuardedBlock && "Could not create the guarded block?"); |
| 2658 | // Duplicate all instructions before the guard in the unguarded branch. |
| 2659 | // Since we have successfully duplicated the guarded block and this block |
| 2660 | // has fewer instructions, we expect it to succeed. |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 2661 | BasicBlock *UnguardedBlock = DuplicateInstructionsInSplitBetween( |
| 2662 | BB, PredUnguardedBlock, Guard, UnguardedMapping); |
Sanjoy Das | 8b859c2 | 2017-02-17 04:21:14 +0000 | [diff] [blame] | 2663 | assert(UnguardedBlock && "Could not create the unguarded block?"); |
Nicola Zaghen | d34e60c | 2018-05-14 12:53:11 +0000 | [diff] [blame] | 2664 | LLVM_DEBUG(dbgs() << "Moved guard " << *Guard << " to block " |
| 2665 | << GuardedBlock->getName() << "\n"); |
Brian M. Rzycki | 9b7ae23 | 2018-01-12 21:06:48 +0000 | [diff] [blame] | 2666 | // DuplicateInstructionsInSplitBetween inserts a new block "BB.split" between |
| 2667 | // PredBB and BB. We need to perform two inserts and one delete for each of |
| 2668 | // the above calls to update Dominators. |
| 2669 | DDT->applyUpdates( |
| 2670 | {// Guarded block split. |
| 2671 | {DominatorTree::Delete, PredGuardedBlock, BB}, |
| 2672 | {DominatorTree::Insert, PredGuardedBlock, GuardedBlock}, |
| 2673 | {DominatorTree::Insert, GuardedBlock, BB}, |
| 2674 | // Unguarded block split. |
| 2675 | {DominatorTree::Delete, PredUnguardedBlock, BB}, |
| 2676 | {DominatorTree::Insert, PredUnguardedBlock, UnguardedBlock}, |
| 2677 | {DominatorTree::Insert, UnguardedBlock, BB}}); |
Sanjoy Das | 8b859c2 | 2017-02-17 04:21:14 +0000 | [diff] [blame] | 2678 | // Some instructions before the guard may still have uses. For them, we need |
| 2679 | // to create Phi nodes merging their copies in both guarded and unguarded |
| 2680 | // branches. Those instructions that have no uses can be just removed. |
| 2681 | SmallVector<Instruction *, 4> ToRemove; |
| 2682 | for (auto BI = BB->begin(); &*BI != AfterGuard; ++BI) |
| 2683 | if (!isa<PHINode>(&*BI)) |
| 2684 | ToRemove.push_back(&*BI); |
| 2685 | |
| 2686 | Instruction *InsertionPoint = &*BB->getFirstInsertionPt(); |
| 2687 | assert(InsertionPoint && "Empty block?"); |
| 2688 | // Substitute with Phis & remove. |
| 2689 | for (auto *Inst : reverse(ToRemove)) { |
| 2690 | if (!Inst->use_empty()) { |
| 2691 | PHINode *NewPN = PHINode::Create(Inst->getType(), 2); |
| 2692 | NewPN->addIncoming(UnguardedMapping[Inst], UnguardedBlock); |
| 2693 | NewPN->addIncoming(GuardedMapping[Inst], GuardedBlock); |
| 2694 | NewPN->insertBefore(InsertionPoint); |
| 2695 | Inst->replaceAllUsesWith(NewPN); |
| 2696 | } |
| 2697 | Inst->eraseFromParent(); |
| 2698 | } |
| 2699 | return true; |
| 2700 | } |