blob: c1b652abbff6089d23d96a649dcaae9038e0d208 [file] [log] [blame]
Chris Lattnerb3b60072008-04-20 20:35:01 +00001//===- 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 Lattner21157222008-04-20 21:13:06 +000010// This file implements the Jump Threading pass.
Chris Lattnerb3b60072008-04-20 20:35:01 +000011//
12//===----------------------------------------------------------------------===//
13
Sean Silva46590d52016-06-14 00:51:09 +000014#include "llvm/Transforms/Scalar/JumpThreading.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000015#include "llvm/ADT/DenseMap.h"
16#include "llvm/ADT/DenseSet.h"
Eugene Zelenko8002c502017-09-13 21:43:53 +000017#include "llvm/ADT/Optional.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000018#include "llvm/ADT/STLExtras.h"
Eugene Zelenko8002c502017-09-13 21:43:53 +000019#include "llvm/ADT/SmallPtrSet.h"
20#include "llvm/ADT/SmallVector.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000021#include "llvm/ADT/Statistic.h"
Jun Bum Limac170872017-03-08 15:22:30 +000022#include "llvm/Analysis/AliasAnalysis.h"
Eugene Zelenko8002c502017-09-13 21:43:53 +000023#include "llvm/Analysis/BlockFrequencyInfo.h"
24#include "llvm/Analysis/BranchProbabilityInfo.h"
Chandler Carruth6bda14b2017-06-06 11:49:48 +000025#include "llvm/Analysis/CFG.h"
Owen Anderson92651ec2011-04-14 21:35:50 +000026#include "llvm/Analysis/ConstantFolding.h"
Chandler Carruth6bda14b2017-06-06 11:49:48 +000027#include "llvm/Analysis/GlobalsModRef.h"
Chris Lattner800aad32009-11-09 23:00:14 +000028#include "llvm/Analysis/InstructionSimplify.h"
Eugene Zelenko8002c502017-09-13 21:43:53 +000029#include "llvm/Analysis/LazyValueInfo.h"
Dan Gohman826bdf82010-05-28 16:19:17 +000030#include "llvm/Analysis/Loads.h"
Manman Ren72d44b12015-10-15 14:59:40 +000031#include "llvm/Analysis/LoopInfo.h"
Eugene Zelenko8002c502017-09-13 21:43:53 +000032#include "llvm/Analysis/TargetLibraryInfo.h"
David Blaikie31b98d22018-06-04 21:23:21 +000033#include "llvm/Transforms/Utils/Local.h"
Sanjoy Das13e63a22015-10-28 21:27:08 +000034#include "llvm/Analysis/ValueTracking.h"
Eugene Zelenko8002c502017-09-13 21:43:53 +000035#include "llvm/IR/BasicBlock.h"
36#include "llvm/IR/CFG.h"
37#include "llvm/IR/Constant.h"
Craig Topper2c20c422017-06-23 05:41:35 +000038#include "llvm/IR/ConstantRange.h"
Eugene Zelenko8002c502017-09-13 21:43:53 +000039#include "llvm/IR/Constants.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000040#include "llvm/IR/DataLayout.h"
Eugene Zelenko8002c502017-09-13 21:43:53 +000041#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 Carruth9fb823b2013-01-02 11:36:10 +000046#include "llvm/IR/IntrinsicInst.h"
Eugene Zelenko8002c502017-09-13 21:43:53 +000047#include "llvm/IR/Intrinsics.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000048#include "llvm/IR/LLVMContext.h"
Manman Ren72d44b12015-10-15 14:59:40 +000049#include "llvm/IR/MDBuilder.h"
Hal Finkelcc39b672014-07-24 12:16:19 +000050#include "llvm/IR/Metadata.h"
Eugene Zelenko8002c502017-09-13 21:43:53 +000051#include "llvm/IR/Module.h"
52#include "llvm/IR/PassManager.h"
Sanjoy Das8b859c22017-02-17 04:21:14 +000053#include "llvm/IR/PatternMatch.h"
Eugene Zelenko8002c502017-09-13 21:43:53 +000054#include "llvm/IR/Type.h"
55#include "llvm/IR/Use.h"
56#include "llvm/IR/User.h"
57#include "llvm/IR/Value.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000058#include "llvm/Pass.h"
Eugene Zelenko8002c502017-09-13 21:43:53 +000059#include "llvm/Support/BlockFrequency.h"
60#include "llvm/Support/BranchProbability.h"
61#include "llvm/Support/Casting.h"
Chris Lattnerb3b60072008-04-20 20:35:01 +000062#include "llvm/Support/CommandLine.h"
Chris Lattner21157222008-04-20 21:13:06 +000063#include "llvm/Support/Debug.h"
Daniel Dunbar9813b0b2009-07-26 07:49:05 +000064#include "llvm/Support/raw_ostream.h"
Chandler Carruth6bda14b2017-06-06 11:49:48 +000065#include "llvm/Transforms/Scalar.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000066#include "llvm/Transforms/Utils/BasicBlockUtils.h"
Sanjoy Das8b859c22017-02-17 04:21:14 +000067#include "llvm/Transforms/Utils/Cloning.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000068#include "llvm/Transforms/Utils/SSAUpdater.h"
Michael Zolotukhina41660d2018-05-12 01:52:36 +000069#include "llvm/Transforms/Utils/SSAUpdaterBulk.h"
Eugene Zelenko8002c502017-09-13 21:43:53 +000070#include "llvm/Transforms/Utils/ValueMapper.h"
Manman Ren72d44b12015-10-15 14:59:40 +000071#include <algorithm>
Eugene Zelenko8002c502017-09-13 21:43:53 +000072#include <cassert>
73#include <cstddef>
74#include <cstdint>
75#include <iterator>
Manman Ren72d44b12015-10-15 14:59:40 +000076#include <memory>
Eugene Zelenko8002c502017-09-13 21:43:53 +000077#include <utility>
78
Chris Lattnerb3b60072008-04-20 20:35:01 +000079using namespace llvm;
Sean Silva46590d52016-06-14 00:51:09 +000080using namespace jumpthreading;
Chris Lattnerb3b60072008-04-20 20:35:01 +000081
Chandler Carruth964daaa2014-04-22 02:55:47 +000082#define DEBUG_TYPE "jump-threading"
83
Chris Lattnerff1c6e32008-04-20 22:39:42 +000084STATISTIC(NumThreads, "Number of jumps threaded");
85STATISTIC(NumFolds, "Number of terminators folded");
Chris Lattner97b14052009-10-11 07:24:57 +000086STATISTIC(NumDupes, "Number of branch blocks duplicated to eliminate phi");
Chris Lattnerb3b60072008-04-20 20:35:01 +000087
Chris Lattner21157222008-04-20 21:13:06 +000088static cl::opt<unsigned>
Michael Liaod1209162014-09-24 04:59:06 +000089BBDuplicateThreshold("jump-threading-threshold",
Chris Lattner21157222008-04-20 21:13:06 +000090 cl::desc("Max block size to duplicate for jump threading"),
91 cl::init(6), cl::Hidden);
92
Sanjoy Das13e63a22015-10-28 21:27:08 +000093static cl::opt<unsigned>
94ImplicationSearchThreshold(
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 Italiano01cb9472017-07-28 02:57:43 +0000100static 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 Lattnerb3b60072008-04-20 20:35:01 +0000105namespace {
Eugene Zelenko8002c502017-09-13 21:43:53 +0000106
Chris Lattnere7f0afe2008-05-09 04:43:13 +0000107 /// 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 Lattner2dd09db2009-09-02 06:11:42 +0000122 class JumpThreading : public FunctionPass {
Sean Silva46590d52016-06-14 00:51:09 +0000123 JumpThreadingPass Impl;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000124
Chris Lattnerb3b60072008-04-20 20:35:01 +0000125 public:
126 static char ID; // Pass identification
Eugene Zelenko8002c502017-09-13 21:43:53 +0000127
Sean Silva46590d52016-06-14 00:51:09 +0000128 JumpThreading(int T = -1) : FunctionPass(ID), Impl(T) {
Owen Anderson6c18d1a2010-10-19 17:21:58 +0000129 initializeJumpThreadingPass(*PassRegistry::getPassRegistry());
130 }
Chris Lattnerb3b60072008-04-20 20:35:01 +0000131
Craig Topper3e4c6972014-03-05 09:10:37 +0000132 bool runOnFunction(Function &F) override;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000133
Craig Topper3e4c6972014-03-05 09:10:37 +0000134 void getAnalysisUsage(AnalysisUsage &AU) const override {
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +0000135 AU.addRequired<DominatorTreeWrapperPass>();
136 AU.addPreserved<DominatorTreeWrapperPass>();
Jun Bum Limac170872017-03-08 15:22:30 +0000137 AU.addRequired<AAResultsWrapperPass>();
Sean Silva687019f2016-06-13 22:01:25 +0000138 AU.addRequired<LazyValueInfoWrapperPass>();
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +0000139 AU.addPreserved<LazyValueInfoWrapperPass>();
James Molloyefbba722015-09-10 10:22:12 +0000140 AU.addPreserved<GlobalsAAWrapperPass>();
Chandler Carruthb98f63d2015-01-15 10:41:28 +0000141 AU.addRequired<TargetLibraryInfoWrapperPass>();
Chris Lattnerfde1f8d2009-11-11 02:08:33 +0000142 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000143
Sean Silva46590d52016-06-14 00:51:09 +0000144 void releaseMemory() override { Impl.releaseMemory(); }
Chris Lattnerb3b60072008-04-20 20:35:01 +0000145 };
Eugene Zelenko8002c502017-09-13 21:43:53 +0000146
147} // end anonymous namespace
Chris Lattnerb3b60072008-04-20 20:35:01 +0000148
Dan Gohmand78c4002008-05-13 00:00:25 +0000149char JumpThreading::ID = 0;
Eugene Zelenko8002c502017-09-13 21:43:53 +0000150
Owen Anderson8ac477f2010-10-12 19:48:12 +0000151INITIALIZE_PASS_BEGIN(JumpThreading, "jump-threading",
152 "Jump Threading", false, false)
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +0000153INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
Sean Silva687019f2016-06-13 22:01:25 +0000154INITIALIZE_PASS_DEPENDENCY(LazyValueInfoWrapperPass)
Chandler Carruthb98f63d2015-01-15 10:41:28 +0000155INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfoWrapperPass)
Jun Bum Limac170872017-03-08 15:22:30 +0000156INITIALIZE_PASS_DEPENDENCY(AAResultsWrapperPass)
Owen Anderson8ac477f2010-10-12 19:48:12 +0000157INITIALIZE_PASS_END(JumpThreading, "jump-threading",
Owen Andersondf7a4f22010-10-07 22:25:06 +0000158 "Jump Threading", false, false)
Dan Gohmand78c4002008-05-13 00:00:25 +0000159
Chris Lattnerb3b60072008-04-20 20:35:01 +0000160// Public interface to the Jump Threading pass
Eugene Zelenko8002c502017-09-13 21:43:53 +0000161FunctionPass *llvm::createJumpThreadingPass(int Threshold) {
162 return new JumpThreading(Threshold);
163}
Chris Lattnerb3b60072008-04-20 20:35:01 +0000164
Sean Silva46590d52016-06-14 00:51:09 +0000165JumpThreadingPass::JumpThreadingPass(int T) {
166 BBDupThreshold = (T == -1) ? BBDuplicateThreshold : unsigned(T);
167}
168
Xinliang David Li66531dd2017-08-24 22:54:01 +0000169// 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. Rzycki0eae1232017-12-08 19:36:32 +0000194// we get:
Xinliang David Li66531dd2017-08-24 22:54:01 +0000195// P(cond == true ) = P(A) + P(cond == true | B) * P(B)
196//
197// which gives us:
Xinliang David Lia531f182017-11-06 21:57:51 +0000198// P(A) is less than P(cond == true), i.e.
Xinliang David Li66531dd2017-08-24 22:54:01 +0000199// P(t == true) <= P(cond == true)
200//
Brian M. Rzycki0eae1232017-12-08 19:36:32 +0000201// In other words, if we know P(cond == true) is unlikely, we know
Xinliang David Lia531f182017-11-06 21:57:51 +0000202// that P(t == true) is also unlikely.
203//
Xinliang David Li66531dd2017-08-24 22:54:01 +0000204static 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 Zelenko8002c502017-09-13 21:43:53 +0000221 while (true) {
Xinliang David Li66531dd2017-08-24 22:54:01 +0000222 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 Lattnerb3b60072008-04-20 20:35:01 +0000280bool JumpThreading::runOnFunction(Function &F) {
Andrew Kayloraa641a52016-04-22 22:06:11 +0000281 if (skipFunction(F))
Paul Robinsonaf4e64d2014-02-06 00:07:05 +0000282 return false;
Sean Silva46590d52016-06-14 00:51:09 +0000283 auto TLI = &getAnalysis<TargetLibraryInfoWrapperPass>().getTLI();
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +0000284 // 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 Silva46590d52016-06-14 00:51:09 +0000287 auto LVI = &getAnalysis<LazyValueInfoWrapperPass>().getLVI();
Jun Bum Limac170872017-03-08 15:22:30 +0000288 auto AA = &getAnalysis<AAResultsWrapperPass>().getAAResults();
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +0000289 DeferredDominance DDT(*DT);
Sean Silva46590d52016-06-14 00:51:09 +0000290 std::unique_ptr<BlockFrequencyInfo> BFI;
291 std::unique_ptr<BranchProbabilityInfo> BPI;
Easwaran Ramana17f2202017-12-22 01:33:52 +0000292 bool HasProfileData = F.hasProfileData();
Sean Silvaf81328d2016-06-13 22:52:52 +0000293 if (HasProfileData) {
Sean Silva7d5a57c2016-06-14 00:26:31 +0000294 LoopInfo LI{DominatorTree(F)};
John Brawnda4a68a2017-06-08 09:44:40 +0000295 BPI.reset(new BranchProbabilityInfo(F, LI, TLI));
Sean Silva7d5a57c2016-06-14 00:26:31 +0000296 BFI.reset(new BlockFrequencyInfo(F, *BPI, LI));
Sean Silvaf81328d2016-06-13 22:52:52 +0000297 }
Jun Bum Limac170872017-03-08 15:22:30 +0000298
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +0000299 bool Changed = Impl.runImpl(F, TLI, LVI, AA, &DDT, HasProfileData,
300 std::move(BFI), std::move(BPI));
Davide Italiano01cb9472017-07-28 02:57:43 +0000301 if (PrintLVIAfterJumpThreading) {
302 dbgs() << "LVI for function '" << F.getName() << "':\n";
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +0000303 LVI->printLVI(F, *DT, dbgs());
Davide Italiano01cb9472017-07-28 02:57:43 +0000304 }
305 return Changed;
Sean Silva46590d52016-06-14 00:51:09 +0000306}
307
308PreservedAnalyses JumpThreadingPass::run(Function &F,
Sean Silva36e0d012016-08-09 00:28:15 +0000309 FunctionAnalysisManager &AM) {
Sean Silva46590d52016-06-14 00:51:09 +0000310 auto &TLI = AM.getResult<TargetLibraryAnalysis>(F);
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +0000311 // 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 Silva46590d52016-06-14 00:51:09 +0000314 auto &LVI = AM.getResult<LazyValueAnalysis>(F);
Jun Bum Limac170872017-03-08 15:22:30 +0000315 auto &AA = AM.getResult<AAManager>(F);
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +0000316 DeferredDominance DDT(DT);
Jun Bum Limac170872017-03-08 15:22:30 +0000317
Sean Silva46590d52016-06-14 00:51:09 +0000318 std::unique_ptr<BlockFrequencyInfo> BFI;
319 std::unique_ptr<BranchProbabilityInfo> BPI;
Easwaran Ramana17f2202017-12-22 01:33:52 +0000320 if (F.hasProfileData()) {
Sean Silva46590d52016-06-14 00:51:09 +0000321 LoopInfo LI{DominatorTree(F)};
John Brawnda4a68a2017-06-08 09:44:40 +0000322 BPI.reset(new BranchProbabilityInfo(F, LI, &TLI));
Sean Silva46590d52016-06-14 00:51:09 +0000323 BFI.reset(new BlockFrequencyInfo(F, *BPI, LI));
324 }
Jun Bum Limac170872017-03-08 15:22:30 +0000325
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +0000326 bool Changed = runImpl(F, &TLI, &LVI, &AA, &DDT, HasProfileData,
327 std::move(BFI), std::move(BPI));
Sean Silvaf50d4b62016-07-06 19:05:41 +0000328
Sean Silva46590d52016-06-14 00:51:09 +0000329 if (!Changed)
330 return PreservedAnalyses::all();
331 PreservedAnalyses PA;
Sean Silva46590d52016-06-14 00:51:09 +0000332 PA.preserve<GlobalsAA>();
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +0000333 PA.preserve<DominatorTreeAnalysis>();
334 PA.preserve<LazyValueAnalysis>();
Sean Silvaf2db01c2016-07-02 16:16:44 +0000335 return PA;
Sean Silva46590d52016-06-14 00:51:09 +0000336}
337
338bool JumpThreadingPass::runImpl(Function &F, TargetLibraryInfo *TLI_,
Jun Bum Limac170872017-03-08 15:22:30 +0000339 LazyValueInfo *LVI_, AliasAnalysis *AA_,
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +0000340 DeferredDominance *DDT_, bool HasProfileData_,
Sean Silva46590d52016-06-14 00:51:09 +0000341 std::unique_ptr<BlockFrequencyInfo> BFI_,
342 std::unique_ptr<BranchProbabilityInfo> BPI_) {
Nicola Zaghend34e60c2018-05-14 12:53:11 +0000343 LLVM_DEBUG(dbgs() << "Jump threading on function '" << F.getName() << "'\n");
Sean Silva46590d52016-06-14 00:51:09 +0000344 TLI = TLI_;
345 LVI = LVI_;
Jun Bum Limac170872017-03-08 15:22:30 +0000346 AA = AA_;
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +0000347 DDT = DDT_;
Sean Silva46590d52016-06-14 00:51:09 +0000348 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 Das8b859c22017-02-17 04:21:14 +0000353 auto *GuardDecl = F.getParent()->getFunction(
354 Intrinsic::getName(Intrinsic::experimental_guard));
355 HasGuards = GuardDecl && !GuardDecl->use_empty();
Sean Silva46590d52016-06-14 00:51:09 +0000356 if (HasProfileData) {
357 BPI = std::move(BPI_);
358 BFI = std::move(BFI_);
359 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000360
Brian M. Rzyckif65ddc52018-03-16 15:13:47 +0000361 // 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 Jasper0a51ec22017-09-30 11:57:19 +0000368
Chris Lattnerd579cb12009-05-04 02:28:08 +0000369 FindLoopHeaders(F);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000370
Brian M. Rzyckif65ddc52018-03-16 15:13:47 +0000371 bool EverChanged = false;
David Majnemerd9833ea2016-01-10 07:13:04 +0000372 bool Changed;
Benjamin Kramer76e27662010-01-07 13:50:07 +0000373 do {
374 Changed = false;
Brian M. Rzyckif65ddc52018-03-16 15:13:47 +0000375 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 Lattnerff1c6e32008-04-20 22:39:42 +0000379 Changed = true;
Brian M. Rzyckif65ddc52018-03-16 15:13:47 +0000380 // 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. Rzycki9b7ae232018-01-12 21:06:48 +0000384 continue;
385
Brian M. Rzyckif65ddc52018-03-16 15:13:47 +0000386 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 Zaghend34e60c2018-05-14 12:53:11 +0000389 LLVM_DEBUG(dbgs() << " JT: Deleting dead block '" << BB.getName()
390 << "' with terminator: " << *BB.getTerminator()
391 << '\n');
Brian M. Rzyckif65ddc52018-03-16 15:13:47 +0000392 LoopHeaders.erase(&BB);
393 LVI->eraseBlock(&BB);
394 DeleteDeadBlock(&BB, DDT);
Chris Lattner595c7272008-12-03 07:48:08 +0000395 Changed = true;
Chris Lattner73a58622010-12-13 02:38:13 +0000396 continue;
397 }
Owen Anderson92651ec2011-04-14 21:35:50 +0000398
Brian M. Rzyckif65ddc52018-03-16 15:13:47 +0000399 // 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 Lattner73a58622010-12-13 02:38:13 +0000402 if (BI && BI->isUnconditional() &&
Brian M. Rzyckif65ddc52018-03-16 15:13:47 +0000403 // 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 Lattner595c7272008-12-03 07:48:08 +0000413 }
414 }
Chris Lattnerff1c6e32008-04-20 22:39:42 +0000415 EverChanged |= Changed;
Benjamin Kramer76e27662010-01-07 13:50:07 +0000416 } while (Changed);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000417
Chris Lattnerd579cb12009-05-04 02:28:08 +0000418 LoopHeaders.clear();
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +0000419 DDT->flush();
Brian M. Rzyckif1a7df52018-02-16 16:35:17 +0000420 LVI->enableDT();
Chris Lattnerff1c6e32008-04-20 22:39:42 +0000421 return EverChanged;
Chris Lattnerb3b60072008-04-20 20:35:01 +0000422}
Chris Lattner21157222008-04-20 21:13:06 +0000423
Anna Thomasc07d5542017-05-23 13:36:25 +0000424// 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.
431static 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 Das8b859c22017-02-17 04:21:14 +0000453/// 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.
456static unsigned getJumpThreadDuplicationCost(BasicBlock *BB,
457 Instruction *StopAt,
Nadav Rotem23495312012-12-03 17:34:44 +0000458 unsigned Threshold) {
Sanjoy Das8b859c22017-02-17 04:21:14 +0000459 assert(StopAt->getParent() == BB && "Not an instruction from proper BB?");
Chris Lattner97b14052009-10-11 07:24:57 +0000460 /// Ignore PHI nodes, these will be flattened when duplication happens.
Duncan P. N. Exon Smith3a9c9e32015-10-13 18:26:00 +0000461 BasicBlock::const_iterator I(BB->getFirstNonPHI());
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000462
Chris Lattner3a2ae902009-11-11 00:21:58 +0000463 // 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 Bommel5e75ef42010-12-05 19:02:47 +0000465
Geoff Berry43dc2852015-12-29 18:10:16 +0000466 unsigned Bonus = 0;
Sanjoy Das8b859c22017-02-17 04:21:14 +0000467 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 Berry43dc2852015-12-29 18:10:16 +0000473
Sanjoy Das8b859c22017-02-17 04:21:14 +0000474 // The same holds for indirect branches, but slightly more so.
475 if (isa<IndirectBrInst>(StopAt))
476 Bonus = 8;
477 }
Geoff Berry43dc2852015-12-29 18:10:16 +0000478
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 Lattner97b14052009-10-11 07:24:57 +0000483 // 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 Das8b859c22017-02-17 04:21:14 +0000486 for (; &*I != StopAt; ++I) {
Nadav Rotem23495312012-12-03 17:34:44 +0000487
488 // Stop scanning the block if we've reached the threshold.
489 if (Size > Threshold)
490 return Size;
491
Chris Lattner97b14052009-10-11 07:24:57 +0000492 // Debugger intrinsics don't incur code size.
493 if (isa<DbgInfoIntrinsic>(I)) continue;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000494
Chris Lattner97b14052009-10-11 07:24:57 +0000495 // If this is a pointer->pointer bitcast, it is free.
Duncan Sands19d0b472010-02-16 11:11:14 +0000496 if (isa<BitCastInst>(I) && I->getType()->isPointerTy())
Chris Lattner97b14052009-10-11 07:24:57 +0000497 continue;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000498
David Majnemerb611e3f2015-08-14 05:09:07 +0000499 // Bail out if this instruction gives back a token type, it is not possible
David L Kreitzerda700ce2015-09-16 13:27:30 +0000500 // to duplicate it if it is used outside this BB.
David Majnemerb611e3f2015-08-14 05:09:07 +0000501 if (I->getType()->isTokenTy() && I->isUsedOutsideOfBlock(BB))
502 return ~0U;
503
Chris Lattner97b14052009-10-11 07:24:57 +0000504 // All other instructions count for at least one unit.
505 ++Size;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000506
Chris Lattner97b14052009-10-11 07:24:57 +0000507 // 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 Wue84f6712015-08-31 06:10:27 +0000512 if (CI->cannotDuplicate() || CI->isConvergent())
James Molloy4f6fb952012-12-20 16:04:27 +0000513 // 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 Lattner97b14052009-10-11 07:24:57 +0000517 Size += 3;
Duncan Sands19d0b472010-02-16 11:11:14 +0000518 else if (!CI->getType()->isVectorTy())
Chris Lattner97b14052009-10-11 07:24:57 +0000519 Size += 1;
520 }
521 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000522
Geoff Berry43dc2852015-12-29 18:10:16 +0000523 return Size > Bonus ? Size - Bonus : 0;
Chris Lattner97b14052009-10-11 07:24:57 +0000524}
525
Chris Lattnerfa552d72009-05-04 16:29:24 +0000526/// FindLoopHeaders - We do not want jump threading to turn proper loop
Chris Lattnerd579cb12009-05-04 02:28:08 +0000527/// 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 Silva46590d52016-06-14 00:51:09 +0000540void JumpThreadingPass::FindLoopHeaders(Function &F) {
Chris Lattnerd579cb12009-05-04 02:28:08 +0000541 SmallVector<std::pair<const BasicBlock*,const BasicBlock*>, 32> Edges;
542 FindFunctionBackedges(F, Edges);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000543
Benjamin Kramer543762d2016-01-09 18:43:01 +0000544 for (const auto &Edge : Edges)
545 LoopHeaders.insert(Edge.second);
Chris Lattnerd579cb12009-05-04 02:28:08 +0000546}
547
Frits van Bommel76244862010-12-05 19:06:41 +0000548/// 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 Bommeld9df6ea2010-12-06 23:36:56 +0000550/// 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 Bommel76244862010-12-05 19:06:41 +0000552/// Returns null if Val is null or not an appropriate constant.
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000553static Constant *getKnownConstant(Value *Val, ConstantPreference Preference) {
Frits van Bommel76244862010-12-05 19:06:41 +0000554 if (!Val)
Craig Topperf40110f2014-04-25 05:29:35 +0000555 return nullptr;
Frits van Bommel76244862010-12-05 19:06:41 +0000556
557 // Undef is "known" enough.
558 if (UndefValue *U = dyn_cast<UndefValue>(Val))
559 return U;
560
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000561 if (Preference == WantBlockAddress)
562 return dyn_cast<BlockAddress>(Val->stripPointerCasts());
563
Frits van Bommel76244862010-12-05 19:06:41 +0000564 return dyn_cast<ConstantInt>(Val);
565}
566
Chris Lattner5ff7f562009-11-07 08:05:03 +0000567/// ComputeValueKnownInPredecessors - Given a basic block BB and a value V, see
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000568/// 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 Lattner5ff7f562009-11-07 08:05:03 +0000571///
Chris Lattner5ff7f562009-11-07 08:05:03 +0000572/// This returns true if there were any known values.
Sean Silva46590d52016-06-14 00:51:09 +0000573bool JumpThreadingPass::ComputeValueKnownInPredecessors(
574 Value *V, BasicBlock *BB, PredValueInfo &Result,
575 ConstantPreference Preference, Instruction *CxtI) {
Owen Anderson6fdcb1722010-08-31 19:24:27 +0000576 // 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 Anderson3997a072010-08-31 07:36:34 +0000580 if (!RecursionSet.insert(std::make_pair(V, BB)).second)
581 return false;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000582
Owen Anderson6fdcb1722010-08-31 19:24:27 +0000583 // 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 Bommel5e75ef42010-12-05 19:02:47 +0000586
Frits van Bommel76244862010-12-05 19:06:41 +0000587 // If V is a constant, then it is known in all predecessors.
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000588 if (Constant *KC = getKnownConstant(V, Preference)) {
Benjamin Kramer543762d2016-01-09 18:43:01 +0000589 for (BasicBlock *Pred : predecessors(BB))
590 Result.push_back(std::make_pair(KC, Pred));
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000591
Haicheng Wub35f7722016-02-08 17:00:39 +0000592 return !Result.empty();
Chris Lattner5ff7f562009-11-07 08:05:03 +0000593 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000594
Chris Lattner5ff7f562009-11-07 08:05:03 +0000595 // 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 Wu64d9d7c2016-03-15 23:38:47 +0000597 Instruction *I = dyn_cast<Instruction>(V);
Craig Topperf40110f2014-04-25 05:29:35 +0000598 if (!I || I->getParent() != BB) {
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000599
Chris Lattnerfde1f8d2009-11-11 02:08:33 +0000600 // 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 Andersond361aac2010-09-14 20:57:41 +0000607 // 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 Bommel5e75ef42010-12-05 19:02:47 +0000612
Brian M. Rzyckif1a7df52018-02-16 16:35:17 +0000613 if (DDT->pending())
614 LVI->disableDT();
615 else
616 LVI->enableDT();
Benjamin Kramer543762d2016-01-09 18:43:01 +0000617 for (BasicBlock *P : predecessors(BB)) {
Owen Andersond361aac2010-09-14 20:57:41 +0000618 // 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 Finkel7e184492014-09-07 20:29:59 +0000620 Constant *PredCst = LVI->getConstantOnEdge(V, P, BB, CxtI);
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000621 if (Constant *KC = getKnownConstant(PredCst, Preference))
Frits van Bommel76244862010-12-05 19:06:41 +0000622 Result.push_back(std::make_pair(KC, P));
Owen Andersond361aac2010-09-14 20:57:41 +0000623 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000624
Owen Andersond361aac2010-09-14 20:57:41 +0000625 return !Result.empty();
Chris Lattnerfde1f8d2009-11-11 02:08:33 +0000626 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000627
Chris Lattner5ff7f562009-11-07 08:05:03 +0000628 /// 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. Rzyckif1a7df52018-02-16 16:35:17 +0000630 if (DDT->pending())
631 LVI->disableDT();
632 else
633 LVI->enableDT();
Chris Lattner5ff7f562009-11-07 08:05:03 +0000634 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
635 Value *InVal = PN->getIncomingValue(i);
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000636 if (Constant *KC = getKnownConstant(InVal, Preference)) {
Frits van Bommel76244862010-12-05 19:06:41 +0000637 Result.push_back(std::make_pair(KC, PN->getIncomingBlock(i)));
Owen Andersond361aac2010-09-14 20:57:41 +0000638 } else {
Owen Andersonbd2ecc72010-08-26 17:40:24 +0000639 Constant *CI = LVI->getConstantOnEdge(InVal,
Hal Finkel7e184492014-09-07 20:29:59 +0000640 PN->getIncomingBlock(i),
641 BB, CxtI);
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000642 if (Constant *KC = getKnownConstant(CI, Preference))
643 Result.push_back(std::make_pair(KC, PN->getIncomingBlock(i)));
Chris Lattner5ff7f562009-11-07 08:05:03 +0000644 }
645 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000646
Chris Lattner5ff7f562009-11-07 08:05:03 +0000647 return !Result.empty();
648 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000649
Haicheng Wu78738572016-03-16 04:52:52 +0000650 // Handle Cast instructions. Only see through Cast when the source operand is
Chad Rosier95d9ccb2018-03-09 16:43:46 +0000651 // PHI or Cmp to save the compilation time.
Haicheng Wu78738572016-03-16 04:52:52 +0000652 if (CastInst *CI = dyn_cast<CastInst>(I)) {
653 Value *Source = CI->getOperand(0);
Haicheng Wu78738572016-03-16 04:52:52 +0000654 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 Lattner5ff7f562009-11-07 08:05:03 +0000667 // Handle some boolean conditions.
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000668 if (I->getType()->getPrimitiveSizeInBits() == 1) {
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000669 assert(Preference == WantInteger && "One-bit non-integer type?");
Chris Lattner5ff7f562009-11-07 08:05:03 +0000670 // X | true -> true
671 // X & false -> false
672 if (I->getOpcode() == Instruction::Or ||
673 I->getOpcode() == Instruction::And) {
Craig Topper91259e22017-10-16 21:54:13 +0000674 PredValueInfoTy LHSVals, RHSVals;
675
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000676 ComputeValueKnownInPredecessors(I->getOperand(0), BB, LHSVals,
Haicheng Wu64d9d7c2016-03-15 23:38:47 +0000677 WantInteger, CxtI);
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000678 ComputeValueKnownInPredecessors(I->getOperand(1), BB, RHSVals,
Haicheng Wu64d9d7c2016-03-15 23:38:47 +0000679 WantInteger, CxtI);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000680
Owen Anderson6fdcb1722010-08-31 19:24:27 +0000681 if (LHSVals.empty() && RHSVals.empty())
Chris Lattner5ff7f562009-11-07 08:05:03 +0000682 return false;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000683
Chris Lattner5ff7f562009-11-07 08:05:03 +0000684 ConstantInt *InterestingVal;
685 if (I->getOpcode() == Instruction::Or)
686 InterestingVal = ConstantInt::getTrue(I->getContext());
687 else
688 InterestingVal = ConstantInt::getFalse(I->getContext());
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000689
Chris Lattner3c603022010-08-18 03:14:36 +0000690 SmallPtrSet<BasicBlock*, 4> LHSKnownBBs;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000691
Chris Lattnerd924f632010-02-11 04:40:44 +0000692 // Scan for the sentinel. If we find an undef, force it to the
693 // interesting value: x|undef -> true and x&undef -> false.
Benjamin Kramer543762d2016-01-09 18:43:01 +0000694 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 Lattnerd924f632010-02-11 04:40:44 +0000698 }
Benjamin Kramer543762d2016-01-09 18:43:01 +0000699 for (const auto &RHSVal : RHSVals)
700 if (RHSVal.first == InterestingVal || isa<UndefValue>(RHSVal.first)) {
Chris Lattnerbbc25ff2010-07-12 00:47:34 +0000701 // If we already inferred a value for this block on the LHS, don't
702 // re-add it.
Benjamin Kramer543762d2016-01-09 18:43:01 +0000703 if (!LHSKnownBBs.count(RHSVal.second))
704 Result.emplace_back(InterestingVal, RHSVal.second);
Chris Lattnerd924f632010-02-11 04:40:44 +0000705 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000706
Chris Lattner5ff7f562009-11-07 08:05:03 +0000707 return !Result.empty();
708 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000709
Chris Lattner9518fbb2009-11-10 22:39:16 +0000710 // 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 Wu64d9d7c2016-03-15 23:38:47 +0000714 ComputeValueKnownInPredecessors(I->getOperand(0), BB, Result,
715 WantInteger, CxtI);
Owen Anderson6fdcb1722010-08-31 19:24:27 +0000716 if (Result.empty())
Chris Lattner9518fbb2009-11-10 22:39:16 +0000717 return false;
718
719 // Invert the known values.
Benjamin Kramer543762d2016-01-09 18:43:01 +0000720 for (auto &R : Result)
721 R.first = ConstantExpr::getNot(R.first);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000722
Chris Lattner9518fbb2009-11-10 22:39:16 +0000723 return true;
724 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000725
Owen Andersonbd2ecc72010-08-26 17:40:24 +0000726 // Try to simplify some other binary operator values.
727 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(I)) {
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000728 assert(Preference != WantBlockAddress
729 && "A binary operator creating a block address?");
Owen Anderson3c84ecb2010-08-31 20:26:04 +0000730 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->getOperand(1))) {
Frits van Bommel76244862010-12-05 19:06:41 +0000731 PredValueInfoTy LHSVals;
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000732 ComputeValueKnownInPredecessors(BO->getOperand(0), BB, LHSVals,
Haicheng Wu64d9d7c2016-03-15 23:38:47 +0000733 WantInteger, CxtI);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000734
Owen Anderson3997a072010-08-31 07:36:34 +0000735 // Try to use constant folding to simplify the binary operator.
Benjamin Kramer543762d2016-01-09 18:43:01 +0000736 for (const auto &LHSVal : LHSVals) {
737 Constant *V = LHSVal.first;
Owen Anderson3c84ecb2010-08-31 20:26:04 +0000738 Constant *Folded = ConstantExpr::get(BO->getOpcode(), V, CI);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000739
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000740 if (Constant *KC = getKnownConstant(Folded, WantInteger))
Benjamin Kramer543762d2016-01-09 18:43:01 +0000741 Result.push_back(std::make_pair(KC, LHSVal.second));
Owen Anderson3997a072010-08-31 07:36:34 +0000742 }
Owen Andersonbd2ecc72010-08-26 17:40:24 +0000743 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000744
Owen Anderson3997a072010-08-31 07:36:34 +0000745 return !Result.empty();
Chris Lattner5ff7f562009-11-07 08:05:03 +0000746 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000747
Chris Lattner5ff7f562009-11-07 08:05:03 +0000748 // Handle compare with phi operand, where the PHI is defined in this block.
749 if (CmpInst *Cmp = dyn_cast<CmpInst>(I)) {
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000750 assert(Preference == WantInteger && "Compares only produce integers");
Craig Topper79279962017-06-23 05:41:32 +0000751 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 Mieec5ba92018-05-01 14:47:24 +0000757 if (!PN)
758 PN = dyn_cast<PHINode>(CmpRHS);
Chris Lattner5ff7f562009-11-07 08:05:03 +0000759 if (PN && PN->getParent() == BB) {
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000760 const DataLayout &DL = PN->getModule()->getDataLayout();
Chris Lattner5ff7f562009-11-07 08:05:03 +0000761 // We can do this simplification if any comparisons fold to true or false.
762 // See if any do.
Brian M. Rzyckif1a7df52018-02-16 16:35:17 +0000763 if (DDT->pending())
764 LVI->disableDT();
765 else
766 LVI->enableDT();
Chris Lattner5ff7f562009-11-07 08:05:03 +0000767 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
768 BasicBlock *PredBB = PN->getIncomingBlock(i);
Wei Mieec5ba92018-05-01 14:47:24 +0000769 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 Topper79279962017-06-23 05:41:32 +0000777 Value *Res = SimplifyCmpInst(Pred, LHS, RHS, {DL});
Craig Topperf40110f2014-04-25 05:29:35 +0000778 if (!Res) {
Owen Andersond361aac2010-09-14 20:57:41 +0000779 if (!isa<Constant>(RHS))
Chris Lattner5f6b8b22009-11-12 05:24:05 +0000780 continue;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000781
Wei Mieec5ba92018-05-01 14:47:24 +0000782 // 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 Bommel5e75ef42010-12-05 19:02:47 +0000787 LazyValueInfo::Tristate
Craig Topper79279962017-06-23 05:41:32 +0000788 ResT = LVI->getPredicateOnEdge(Pred, LHS,
Hal Finkel7e184492014-09-07 20:29:59 +0000789 cast<Constant>(RHS), PredBB, BB,
790 CxtI ? CxtI : Cmp);
Chris Lattner5f6b8b22009-11-12 05:24:05 +0000791 if (ResT == LazyValueInfo::Unknown)
792 continue;
793 Res = ConstantInt::get(Type::getInt1Ty(LHS->getContext()), ResT);
794 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000795
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000796 if (Constant *KC = getKnownConstant(Res, WantInteger))
797 Result.push_back(std::make_pair(KC, PredBB));
Chris Lattner5ff7f562009-11-07 08:05:03 +0000798 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000799
Chris Lattner5ff7f562009-11-07 08:05:03 +0000800 return !Result.empty();
801 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000802
Chris Lattner67146692009-11-11 22:31:38 +0000803 // If comparing a live-in value against a constant, see if we know the
804 // live-in value on any predecessors.
Craig Topper79279962017-06-23 05:41:32 +0000805 if (isa<Constant>(CmpRHS) && !CmpType->isVectorTy()) {
806 Constant *CmpConst = cast<Constant>(CmpRHS);
Craig Topper930689a2017-05-04 21:45:45 +0000807
Craig Topper79279962017-06-23 05:41:32 +0000808 if (!isa<Instruction>(CmpLHS) ||
809 cast<Instruction>(CmpLHS)->getParent() != BB) {
Brian M. Rzyckif1a7df52018-02-16 16:35:17 +0000810 if (DDT->pending())
811 LVI->disableDT();
812 else
813 LVI->enableDT();
Benjamin Kramer543762d2016-01-09 18:43:01 +0000814 for (BasicBlock *P : predecessors(BB)) {
Owen Andersonbd2ecc72010-08-26 17:40:24 +0000815 // 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 Topper79279962017-06-23 05:41:32 +0000818 LVI->getPredicateOnEdge(Pred, CmpLHS,
Craig Topper930689a2017-05-04 21:45:45 +0000819 CmpConst, P, BB, CxtI ? CxtI : Cmp);
Owen Andersonbd2ecc72010-08-26 17:40:24 +0000820 if (Res == LazyValueInfo::Unknown)
821 continue;
Chris Lattnerc893c4ed2009-11-12 04:37:50 +0000822
Craig Topper79279962017-06-23 05:41:32 +0000823 Constant *ResC = ConstantInt::get(CmpType, Res);
Frits van Bommel76244862010-12-05 19:06:41 +0000824 Result.push_back(std::make_pair(ResC, P));
Owen Andersonbd2ecc72010-08-26 17:40:24 +0000825 }
826
827 return !Result.empty();
Chris Lattner67146692009-11-11 22:31:38 +0000828 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000829
Craig Topper2c20c422017-06-23 05:41:35 +0000830 // 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 Zelenko8002c502017-09-13 21:43:53 +0000835
Craig Topper2c20c422017-06-23 05:41:35 +0000836 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. Rzyckif1a7df52018-02-16 16:35:17 +0000842 if (DDT->pending())
843 LVI->disableDT();
844 else
845 LVI->enableDT();
Craig Topper2c20c422017-06-23 05:41:35 +0000846 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 Anderson3997a072010-08-31 07:36:34 +0000875 // Try to find a constant value for the LHS of a comparison,
Owen Andersonbd2ecc72010-08-26 17:40:24 +0000876 // and evaluate it statically if we can.
Craig Topper930689a2017-05-04 21:45:45 +0000877 PredValueInfoTy LHSVals;
878 ComputeValueKnownInPredecessors(I->getOperand(0), BB, LHSVals,
879 WantInteger, CxtI);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000880
Craig Topper930689a2017-05-04 21:45:45 +0000881 for (const auto &LHSVal : LHSVals) {
882 Constant *V = LHSVal.first;
Craig Topper79279962017-06-23 05:41:32 +0000883 Constant *Folded = ConstantExpr::getCompare(Pred, V, CmpConst);
Craig Topper930689a2017-05-04 21:45:45 +0000884 if (Constant *KC = getKnownConstant(Folded, WantInteger))
885 Result.push_back(std::make_pair(KC, LHSVal.second));
Owen Andersonbd2ecc72010-08-26 17:40:24 +0000886 }
Craig Topper930689a2017-05-04 21:45:45 +0000887
888 return !Result.empty();
Chris Lattner67146692009-11-11 22:31:38 +0000889 }
Chris Lattner5ff7f562009-11-07 08:05:03 +0000890 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000891
Frits van Bommel3d180342010-12-15 09:51:20 +0000892 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 Wu64d9d7c2016-03-15 23:38:47 +0000900 WantInteger, CxtI)) {
Benjamin Kramer543762d2016-01-09 18:43:01 +0000901 for (auto &C : Conds) {
902 Constant *Cond = C.first;
Frits van Bommel3d180342010-12-15 09:51:20 +0000903
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 Topperf40110f2014-04-25 05:29:35 +0000914 KnownCond = (TrueVal != nullptr);
Frits van Bommel3d180342010-12-15 09:51:20 +0000915 }
916
917 // See if the select has a known constant value for this predecessor.
918 if (Constant *Val = KnownCond ? TrueVal : FalseVal)
Benjamin Kramer543762d2016-01-09 18:43:01 +0000919 Result.push_back(std::make_pair(Val, C.second));
Frits van Bommel3d180342010-12-15 09:51:20 +0000920 }
921
922 return !Result.empty();
923 }
924 }
925
Owen Andersond361aac2010-09-14 20:57:41 +0000926 // If all else fails, see if LVI can figure out a constant value for us.
Brian M. Rzyckif1a7df52018-02-16 16:35:17 +0000927 if (DDT->pending())
928 LVI->disableDT();
929 else
930 LVI->enableDT();
Hal Finkel7e184492014-09-07 20:29:59 +0000931 Constant *CI = LVI->getConstant(V, BB, CxtI);
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000932 if (Constant *KC = getKnownConstant(CI, Preference)) {
Benjamin Kramer543762d2016-01-09 18:43:01 +0000933 for (BasicBlock *Pred : predecessors(BB))
934 Result.push_back(std::make_pair(KC, Pred));
Owen Andersonbd2ecc72010-08-26 17:40:24 +0000935 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000936
Owen Andersond361aac2010-09-14 20:57:41 +0000937 return !Result.empty();
Chris Lattner5ff7f562009-11-07 08:05:03 +0000938}
939
Chris Lattnerf99a74e2009-10-11 04:18:15 +0000940/// 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 Lattnerf99a74e2009-10-11 04:18:15 +0000945static 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 Kumare0b5f862018-05-10 23:01:54 +0000950 unsigned MinNumPreds = pred_size(TestBB);
Chris Lattnerf99a74e2009-10-11 04:18:15 +0000951 for (unsigned i = 1, e = BBTerm->getNumSuccessors(); i != e; ++i) {
952 TestBB = BBTerm->getSuccessor(i);
Vedant Kumare0b5f862018-05-10 23:01:54 +0000953 unsigned NumPreds = pred_size(TestBB);
Jakub Staszak423651e2011-06-27 21:51:12 +0000954 if (NumPreds < MinNumPreds) {
Chris Lattnerf99a74e2009-10-11 04:18:15 +0000955 MinSucc = i;
Jakub Staszak423651e2011-06-27 21:51:12 +0000956 MinNumPreds = NumPreds;
957 }
Chris Lattnerf99a74e2009-10-11 04:18:15 +0000958 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000959
Chris Lattnerf99a74e2009-10-11 04:18:15 +0000960 return MinSucc;
961}
962
Chris Lattner1a924e72011-02-18 04:43:06 +0000963static bool hasAddressTakenAndUsed(BasicBlock *BB) {
964 if (!BB->hasAddressTaken()) return false;
Owen Anderson92651ec2011-04-14 21:35:50 +0000965
Chris Lattner1a924e72011-02-18 04:43:06 +0000966 // 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 Lattner240051a2008-11-27 07:20:04 +0000973/// ProcessBlock - If there are any predecessors whose control can be threaded
Chris Lattner21157222008-04-20 21:13:06 +0000974/// through to a successor, transform them now.
Sean Silva46590d52016-06-14 00:51:09 +0000975bool JumpThreadingPass::ProcessBlock(BasicBlock *BB) {
Chris Lattnerde5ab4862010-01-23 18:56:07 +0000976 // If the block is trivially dead, just return and let the caller nuke it.
977 // This simplifies other transformations.
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +0000978 if (DDT->pendingDeletedBB(BB) ||
979 (pred_empty(BB) && BB != &BB->getParent()->getEntryBlock()))
Chris Lattnerde5ab4862010-01-23 18:56:07 +0000980 return false;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000981
Chris Lattner98d89d12008-11-27 05:07:53 +0000982 // 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 Lattner5ff7f562009-11-07 08:05:03 +0000986 if (BasicBlock *SinglePred = BB->getSinglePredecessor()) {
David Majnemer654e1302015-07-31 17:58:14 +0000987 const TerminatorInst *TI = SinglePred->getTerminator();
988 if (!TI->isExceptional() && TI->getNumSuccessors() == 1 &&
Chris Lattner1a924e72011-02-18 04:43:06 +0000989 SinglePred != BB && !hasAddressTakenAndUsed(BB)) {
Chris Lattnerd579cb12009-05-04 02:28:08 +0000990 // If SinglePred was a loop header, BB becomes one.
991 if (LoopHeaders.erase(SinglePred))
992 LoopHeaders.insert(BB);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000993
Igor Laevsky87f0d0e2016-06-16 16:25:53 +0000994 LVI->eraseBlock(SinglePred);
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +0000995 MergeBasicBlockIntoOnlyPred(BB, nullptr, DDT);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000996
Anna Thomas7949f452017-06-19 15:23:33 +0000997 // 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 Reamesfbffd122018-03-08 21:25:30 +00001024 if (!isGuaranteedToTransferExecutionToSuccessor(BB))
Anna Thomas7949f452017-06-19 15:23:33 +00001025 LVI->eraseBlock(BB);
Chris Lattner98d89d12008-11-27 05:07:53 +00001026 return true;
1027 }
Chris Lattner5ff7f562009-11-07 08:05:03 +00001028 }
1029
Haicheng Wua6a32792016-01-08 19:39:39 +00001030 if (TryToUnfoldSelectInCurrBB(BB))
1031 return true;
1032
Sanjoy Das8b859c22017-02-17 04:21:14 +00001033 // Look if we can propagate guards to predecessors.
1034 if (HasGuards && ProcessGuards(BB))
1035 return true;
1036
Frits van Bommeld9df6ea2010-12-06 23:36:56 +00001037 // 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 Lattner21157222008-04-20 21:13:06 +00001042 Value *Condition;
Frits van Bommeld9df6ea2010-12-06 23:36:56 +00001043 Instruction *Terminator = BB->getTerminator();
1044 if (BranchInst *BI = dyn_cast<BranchInst>(Terminator)) {
Chris Lattnerff1c6e32008-04-20 22:39:42 +00001045 // Can't thread an unconditional jump.
1046 if (BI->isUnconditional()) return false;
Chris Lattner21157222008-04-20 21:13:06 +00001047 Condition = BI->getCondition();
Frits van Bommeld9df6ea2010-12-06 23:36:56 +00001048 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(Terminator)) {
Chris Lattner21157222008-04-20 21:13:06 +00001049 Condition = SI->getCondition();
Frits van Bommeld9df6ea2010-12-06 23:36:56 +00001050 } else if (IndirectBrInst *IB = dyn_cast<IndirectBrInst>(Terminator)) {
Richard Osborne0ab2b0d2012-07-20 10:36:17 +00001051 // Can't thread indirect branch with no successors.
1052 if (IB->getNumSuccessors() == 0) return false;
Frits van Bommeld9df6ea2010-12-06 23:36:56 +00001053 Condition = IB->getAddress()->stripPointerCasts();
1054 Preference = WantBlockAddress;
1055 } else {
Chris Lattner21157222008-04-20 21:13:06 +00001056 return false; // Must be an invoke.
Frits van Bommeld9df6ea2010-12-06 23:36:56 +00001057 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001058
Owen Anderson92651ec2011-04-14 21:35:50 +00001059 // 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 Aminia28d91d2015-03-10 02:37:25 +00001062 Value *SimpleVal =
1063 ConstantFoldInstruction(I, BB->getModule()->getDataLayout(), TLI);
Owen Anderson92651ec2011-04-14 21:35:50 +00001064 if (SimpleVal) {
1065 I->replaceAllUsesWith(SimpleVal);
David Majnemer522a9112016-07-22 04:54:44 +00001066 if (isInstructionTriviallyDead(I, TLI))
1067 I->eraseFromParent();
Owen Anderson92651ec2011-04-14 21:35:50 +00001068 Condition = SimpleVal;
1069 }
1070 }
1071
Chris Lattner595c7272008-12-03 07:48:08 +00001072 // If the terminator is branching on an undef, we can pick any of the
Chris Lattnerf99a74e2009-10-11 04:18:15 +00001073 // successors to branch to. Let GetBestDestForJumpOnUndef decide.
Chris Lattner595c7272008-12-03 07:48:08 +00001074 if (isa<UndefValue>(Condition)) {
Chris Lattnerf99a74e2009-10-11 04:18:15 +00001075 unsigned BestSucc = GetBestDestForJumpOnUndef(BB);
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00001076 std::vector<DominatorTree::UpdateType> Updates;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001077
Chris Lattner595c7272008-12-03 07:48:08 +00001078 // Fold the branch/switch.
Chris Lattnerf99a74e2009-10-11 04:18:15 +00001079 TerminatorInst *BBTerm = BB->getTerminator();
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00001080 Updates.reserve(BBTerm->getNumSuccessors());
Chris Lattner595c7272008-12-03 07:48:08 +00001081 for (unsigned i = 0, e = BBTerm->getNumSuccessors(); i != e; ++i) {
Chris Lattnerf99a74e2009-10-11 04:18:15 +00001082 if (i == BestSucc) continue;
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00001083 BasicBlock *Succ = BBTerm->getSuccessor(i);
1084 Succ->removePredecessor(BB, true);
1085 Updates.push_back({DominatorTree::Delete, BB, Succ});
Chris Lattner595c7272008-12-03 07:48:08 +00001086 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001087
Nicola Zaghend34e60c2018-05-14 12:53:11 +00001088 LLVM_DEBUG(dbgs() << " In block '" << BB->getName()
1089 << "' folding undef terminator: " << *BBTerm << '\n');
Chris Lattnerf99a74e2009-10-11 04:18:15 +00001090 BranchInst::Create(BBTerm->getSuccessor(BestSucc), BBTerm);
Chris Lattner595c7272008-12-03 07:48:08 +00001091 BBTerm->eraseFromParent();
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00001092 DDT->applyUpdates(Updates);
Chris Lattner595c7272008-12-03 07:48:08 +00001093 return true;
1094 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001095
Frits van Bommel76244862010-12-05 19:06:41 +00001096 // 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 Bommeld9df6ea2010-12-06 23:36:56 +00001099 if (getKnownConstant(Condition, Preference)) {
Nicola Zaghend34e60c2018-05-14 12:53:11 +00001100 LLVM_DEBUG(dbgs() << " In block '" << BB->getName()
1101 << "' folding terminator: " << *BB->getTerminator()
1102 << '\n');
Frits van Bommel76244862010-12-05 19:06:41 +00001103 ++NumFolds;
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00001104 ConstantFoldTerminator(BB, true, nullptr, DDT);
Frits van Bommel76244862010-12-05 19:06:41 +00001105 return true;
1106 }
1107
Chris Lattner595c7272008-12-03 07:48:08 +00001108 Instruction *CondInst = dyn_cast<Instruction>(Condition);
1109
Chris Lattner595c7272008-12-03 07:48:08 +00001110 // All the rest of our checks depend on the condition being an instruction.
Craig Topperf40110f2014-04-25 05:29:35 +00001111 if (!CondInst) {
Chris Lattnerba456162009-11-12 01:41:34 +00001112 // FIXME: Unify this with code below.
Hal Finkel7e184492014-09-07 20:29:59 +00001113 if (ProcessThreadableEdges(Condition, BB, Preference, Terminator))
Chris Lattnerba456162009-11-12 01:41:34 +00001114 return true;
Chris Lattner595c7272008-12-03 07:48:08 +00001115 return false;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001116 }
1117
Nick Lewycky77585a22009-06-19 04:56:29 +00001118 if (CmpInst *CondCmp = dyn_cast<CmpInst>(CondInst)) {
Philip Reames66ab0f02015-06-16 00:49:59 +00001119 // If we're branching on a conditional, LVI might be able to determine
Eric Christopher572e03a2015-06-19 01:53:21 +00001120 // it's value at the branch instruction. We only handle comparisons
Philip Reames66ab0f02015-06-16 00:49:59 +00001121 // against a constant at this time.
Larisse Voufo532bf712015-09-18 19:14:35 +00001122 // TODO: This should be extended to handle switches as well.
Owen Anderson6ebbd922010-08-27 17:12:29 +00001123 BranchInst *CondBr = dyn_cast<BranchInst>(BB->getTerminator());
1124 Constant *CondConst = dyn_cast<Constant>(CondCmp->getOperand(1));
Xin Tongac2b5762017-03-07 18:59:09 +00001125 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. Rzyckif1a7df52018-02-16 16:35:17 +00001131 if (DDT->pending())
1132 LVI->disableDT();
1133 else
1134 LVI->enableDT();
Hal Finkel7e184492014-09-07 20:29:59 +00001135 LazyValueInfo::Tristate Ret =
1136 LVI->getPredicateAt(CondCmp->getPredicate(), CondCmp->getOperand(0),
Philip Reames66ab0f02015-06-16 00:49:59 +00001137 CondConst, CondBr);
Hal Finkel7e184492014-09-07 20:29:59 +00001138 if (Ret != LazyValueInfo::Unknown) {
1139 unsigned ToRemove = Ret == LazyValueInfo::True ? 1 : 0;
1140 unsigned ToKeep = Ret == LazyValueInfo::True ? 0 : 1;
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00001141 BasicBlock *ToRemoveSucc = CondBr->getSuccessor(ToRemove);
1142 ToRemoveSucc->removePredecessor(BB, true);
Hal Finkel7e184492014-09-07 20:29:59 +00001143 BranchInst::Create(CondBr->getSuccessor(ToKeep), CondBr);
1144 CondBr->eraseFromParent();
Philip Reames66ab0f02015-06-16 00:49:59 +00001145 if (CondCmp->use_empty())
1146 CondCmp->eraseFromParent();
Anna Thomasc07d5542017-05-23 13:36:25 +00001147 // We can safely replace *some* uses of the CondInst if it has
Anna Thomas7bca5912017-05-18 13:12:18 +00001148 // 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 Thomasc07d5542017-05-23 13:36:25 +00001154 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. Rzycki9b7ae232018-01-12 21:06:48 +00001160 DDT->deleteEdge(BB, ToRemoveSucc);
Hal Finkel7e184492014-09-07 20:29:59 +00001161 return true;
1162 }
Benjamin Kramer6a4976d2013-08-07 10:29:38 +00001163
Xin Tongac2b5762017-03-07 18:59:09 +00001164 // 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 Lewycky77585a22009-06-19 04:56:29 +00001169 }
Chris Lattner98d89d12008-11-27 05:07:53 +00001170
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 Lattner595c7272008-12-03 07:48:08 +00001175 Value *SimplifyValue = CondInst;
Chris Lattner98d89d12008-11-27 05:07:53 +00001176 if (CmpInst *CondCmp = dyn_cast<CmpInst>(SimplifyValue))
1177 if (isa<Constant>(CondCmp->getOperand(1)))
1178 SimplifyValue = CondCmp->getOperand(0);
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001179
Chris Lattner9d9812a2009-11-15 19:58:31 +00001180 // TODO: There are other places where load PRE would be profitable, such as
1181 // more complex comparisons.
Brian M. Rzycki994e8892018-01-29 21:29:44 +00001182 if (LoadInst *LoadI = dyn_cast<LoadInst>(SimplifyValue))
1183 if (SimplifyPartiallyRedundantLoad(LoadI))
Chris Lattner98d89d12008-11-27 05:07:53 +00001184 return true;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001185
Xinliang David Li66531dd2017-08-24 22:54:01 +00001186 // 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 Lattner5ff7f562009-11-07 08:05:03 +00001191 // 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 Finkel7e184492014-09-07 20:29:59 +00001194 if (ProcessThreadableEdges(CondInst, BB, Preference, Terminator))
Chris Lattnerfde1f8d2009-11-11 02:08:33 +00001195 return true;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001196
Chris Lattner6a19ed02010-01-11 23:41:09 +00001197 // 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 Bommel5e75ef42010-12-05 19:02:47 +00001202
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001203 // 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 Bommel5e75ef42010-12-05 19:02:47 +00001207
Sanjoy Das13e63a22015-10-28 21:27:08 +00001208 // 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 Bommel5e75ef42010-12-05 19:02:47 +00001212
Sanjoy Das13e63a22015-10-28 21:27:08 +00001213 return false;
1214}
1215
Sean Silva46590d52016-06-14 00:51:09 +00001216bool JumpThreadingPass::ProcessImpliedCondition(BasicBlock *BB) {
Sanjoy Das13e63a22015-10-28 21:27:08 +00001217 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 Das55ea67c2015-11-06 19:01:08 +00001226 auto &DL = BB->getModule()->getDataLayout();
1227
Sanjoy Das13e63a22015-10-28 21:27:08 +00001228 while (CurrentPred && Iter++ < ImplicationSearchThreshold) {
1229 auto *PBI = dyn_cast<BranchInst>(CurrentPred->getTerminator());
Chad Rosiere2cbd132016-04-25 17:23:36 +00001230 if (!PBI || !PBI->isConditional())
1231 return false;
1232 if (PBI->getSuccessor(0) != CurrentBB && PBI->getSuccessor(1) != CurrentBB)
Sanjoy Das13e63a22015-10-28 21:27:08 +00001233 return false;
1234
Chad Rosierdfd1de62017-08-01 20:18:54 +00001235 bool CondIsTrue = PBI->getSuccessor(0) == CurrentBB;
Chad Rosier41dd31f2016-04-20 19:15:26 +00001236 Optional<bool> Implication =
Chad Rosierdfd1de62017-08-01 20:18:54 +00001237 isImpliedCondition(PBI->getCondition(), Cond, DL, CondIsTrue);
Chad Rosier41dd31f2016-04-20 19:15:26 +00001238 if (Implication) {
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00001239 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 Das13e63a22015-10-28 21:27:08 +00001243 BI->eraseFromParent();
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00001244 DDT->deleteEdge(BB, RemoveSucc);
Sanjoy Das13e63a22015-10-28 21:27:08 +00001245 return true;
1246 }
1247 CurrentBB = CurrentPred;
1248 CurrentPred = CurrentBB->getSinglePredecessor();
1249 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001250
Chris Lattnere369c352008-04-22 06:36:15 +00001251 return false;
1252}
1253
Xin Tongd67fb1b2017-03-19 15:30:53 +00001254/// Return true if Op is an instruction defined in the given block.
1255static 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. Rzycki994e8892018-01-29 21:29:44 +00001262/// 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.
1266bool JumpThreadingPass::SimplifyPartiallyRedundantLoad(LoadInst *LoadI) {
Sanjoy Das13623ad2016-07-14 19:21:15 +00001267 // Don't hack volatile and ordered loads.
Brian M. Rzycki994e8892018-01-29 21:29:44 +00001268 if (!LoadI->isUnordered()) return false;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001269
Chris Lattner98d89d12008-11-27 05:07:53 +00001270 // If the load is defined in a block with exactly one predecessor, it can't be
1271 // partially redundant.
Brian M. Rzycki994e8892018-01-29 21:29:44 +00001272 BasicBlock *LoadBB = LoadI->getParent();
Chris Lattner98d89d12008-11-27 05:07:53 +00001273 if (LoadBB->getSinglePredecessor())
1274 return false;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001275
David Majnemereb518bd2015-08-04 08:21:40 +00001276 // 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 Wendling90dd90a2013-10-21 04:09:17 +00001278 // instructions between them.
David Majnemereb518bd2015-08-04 08:21:40 +00001279 if (LoadBB->isEHPad())
Bill Wendling90dd90a2013-10-21 04:09:17 +00001280 return false;
1281
Brian M. Rzycki994e8892018-01-29 21:29:44 +00001282 Value *LoadedPtr = LoadI->getOperand(0);
Chris Lattner98d89d12008-11-27 05:07:53 +00001283
Xin Tongd67fb1b2017-03-19 15:30:53 +00001284 // 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 Bommel5e75ef42010-12-05 19:02:47 +00001288
Chris Lattner98d89d12008-11-27 05:07:53 +00001289 // Scan a few instructions up from the load, to see if it is obviously live at
1290 // the entry to its block.
Brian M. Rzycki994e8892018-01-29 21:29:44 +00001291 BasicBlock::iterator BBIt(LoadI);
Eli Friedman02419a92016-08-08 04:10:22 +00001292 bool IsLoadCSE;
Jun Bum Limac170872017-03-08 15:22:30 +00001293 if (Value *AvailableVal = FindAvailableLoadedValue(
Brian M. Rzycki994e8892018-01-29 21:29:44 +00001294 LoadI, LoadBB, BBIt, DefMaxInstsToScan, AA, &IsLoadCSE)) {
David L Kreitzerda700ce2015-09-16 13:27:30 +00001295 // If the value of the load is locally available within the block, just use
Chris Lattner98d89d12008-11-27 05:07:53 +00001296 // it. This frequently occurs for reg2mem'd allocas.
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001297
Eli Friedman02419a92016-08-08 04:10:22 +00001298 if (IsLoadCSE) {
Brian M. Rzycki994e8892018-01-29 21:29:44 +00001299 LoadInst *NLoadI = cast<LoadInst>(AvailableVal);
1300 combineMetadataForCSE(NLoadI, LoadI);
Eli Friedman02419a92016-08-08 04:10:22 +00001301 };
1302
Chris Lattner482eb702009-01-09 06:08:12 +00001303 // If the returned value is the load itself, replace with an undef. This can
1304 // only happen in dead loops.
Brian M. Rzycki994e8892018-01-29 21:29:44 +00001305 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 Lattner98d89d12008-11-27 05:07:53 +00001312 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 Bommel5e75ef42010-12-05 19:02:47 +00001320
Hal Finkelcc39b672014-07-24 12:16:19 +00001321 // 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. Rzycki994e8892018-01-29 21:29:44 +00001324 LoadI->getAAMetadata(AATags);
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001325
Chris Lattner98d89d12008-11-27 05:07:53 +00001326 SmallPtrSet<BasicBlock*, 8> PredsScanned;
Eugene Zelenko8002c502017-09-13 21:43:53 +00001327
1328 using AvailablePredsTy = SmallVector<std::pair<BasicBlock *, Value *>, 8>;
1329
Chris Lattner98d89d12008-11-27 05:07:53 +00001330 AvailablePredsTy AvailablePreds;
Craig Topperf40110f2014-04-25 05:29:35 +00001331 BasicBlock *OneUnavailablePred = nullptr;
Eli Friedman02419a92016-08-08 04:10:22 +00001332 SmallVector<LoadInst*, 8> CSELoads;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001333
Chris Lattner98d89d12008-11-27 05:07:53 +00001334 // 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 Kramer543762d2016-01-09 18:43:01 +00001336 for (BasicBlock *PredBB : predecessors(LoadBB)) {
Chris Lattner98d89d12008-11-27 05:07:53 +00001337 // If we already scanned this predecessor, skip it.
David Blaikie70573dc2014-11-19 07:49:26 +00001338 if (!PredsScanned.insert(PredBB).second)
Chris Lattner98d89d12008-11-27 05:07:53 +00001339 continue;
1340
Chris Lattner98d89d12008-11-27 05:07:53 +00001341 BBIt = PredBB->end();
Jun Bum Lim180bc5a2017-02-02 15:12:34 +00001342 unsigned NumScanedInst = 0;
Xin Tongd67fb1b2017-03-19 15:30:53 +00001343 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. Rzycki994e8892018-01-29 21:29:44 +00001346 assert(LoadI->isUnordered() &&
1347 "Attempting to CSE volatile or atomic loads");
Xin Tongd67fb1b2017-03-19 15:30:53 +00001348 // 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. Rzycki994e8892018-01-29 21:29:44 +00001352 Ptr, LoadI->getType(), LoadI->isAtomic(), PredBB, BBIt,
1353 DefMaxInstsToScan, AA, &IsLoadCSE, &NumScanedInst);
Jun Bum Lim180bc5a2017-02-02 15:12:34 +00001354
Xin Tongd67fb1b2017-03-19 15:30:53 +00001355 // If PredBB has a single predecessor, continue scanning through the
1356 // single precessor.
Jun Bum Lim180bc5a2017-02-02 15:12:34 +00001357 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 Tongd67fb1b2017-03-19 15:30:53 +00001363 PredAvailable = FindAvailablePtrLoadStore(
Brian M. Rzycki994e8892018-01-29 21:29:44 +00001364 Ptr, LoadI->getType(), LoadI->isAtomic(), SinglePredBB, BBIt,
Xin Tongbcb17ec2017-03-19 15:41:46 +00001365 (DefMaxInstsToScan - NumScanedInst), AA, &IsLoadCSE,
Xin Tongd67fb1b2017-03-19 15:30:53 +00001366 &NumScanedInst);
Jun Bum Lim180bc5a2017-02-02 15:12:34 +00001367 }
1368 }
1369
Chris Lattner98d89d12008-11-27 05:07:53 +00001370 if (!PredAvailable) {
1371 OneUnavailablePred = PredBB;
1372 continue;
1373 }
Nadav Rotem465834c2012-07-24 10:51:42 +00001374
Eli Friedman02419a92016-08-08 04:10:22 +00001375 if (IsLoadCSE)
1376 CSELoads.push_back(cast<LoadInst>(PredAvailable));
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001377
Chris Lattner98d89d12008-11-27 05:07:53 +00001378 // 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 Bommel5e75ef42010-12-05 19:02:47 +00001382
Chris Lattner98d89d12008-11-27 05:07:53 +00001383 // If the loaded value isn't available in any predecessor, it isn't partially
1384 // redundant.
1385 if (AvailablePreds.empty()) return false;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001386
Chris Lattner98d89d12008-11-27 05:07:53 +00001387 // 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 Topperf40110f2014-04-25 05:29:35 +00001392 BasicBlock *UnavailablePred = nullptr;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001393
Max Kazantsevfd95ee02017-12-19 09:10:21 +00001394 // 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. Rzycki994e8892018-01-29 21:29:44 +00001396 // instructions before LoadI are guaranteed to pass execution to its
1397 // successor, or if LoadI is safe to speculate.
Max Kazantsevfd95ee02017-12-19 09:10:21 +00001398 // 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. Rzycki994e8892018-01-29 21:29:44 +00001403 !isSafeToSpeculativelyExecute(LoadI))
1404 for (auto I = LoadBB->begin(); &*I != LoadI; ++I)
Max Kazantsevfd95ee02017-12-19 09:10:21 +00001405 if (!isGuaranteedToTransferExecutionToSuccessor(&*I))
1406 return false;
1407
Chris Lattner98d89d12008-11-27 05:07:53 +00001408 // 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 Kramer543762d2016-01-09 18:43:01 +00001420 for (const auto &AvailablePred : AvailablePreds)
1421 AvailablePredSet.insert(AvailablePred.first);
Chris Lattner98d89d12008-11-27 05:07:53 +00001422
1423 // Add all the unavailable predecessors to the PredsToSplit list.
Benjamin Kramer543762d2016-01-09 18:43:01 +00001424 for (BasicBlock *P : predecessors(LoadBB)) {
Chris Lattner329ea062010-06-14 19:45:43 +00001425 // If the predecessor is an indirect goto, we can't split the edge.
Gabor Greifa5fa8852010-07-12 14:10:24 +00001426 if (isa<IndirectBrInst>(P->getTerminator()))
Chris Lattner329ea062010-06-14 19:45:43 +00001427 return false;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001428
Gabor Greifa5fa8852010-07-12 14:10:24 +00001429 if (!AvailablePredSet.count(P))
1430 PredsToSplit.push_back(P);
Chris Lattner329ea062010-06-14 19:45:43 +00001431 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001432
Chris Lattner98d89d12008-11-27 05:07:53 +00001433 // Split them out to their own block.
Manman Ren72d44b12015-10-15 14:59:40 +00001434 UnavailablePred = SplitBlockPreds(LoadBB, PredsToSplit, "thread-pre-split");
Chris Lattner98d89d12008-11-27 05:07:53 +00001435 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001436
Chris Lattner98d89d12008-11-27 05:07:53 +00001437 // 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. Rzycki994e8892018-01-29 21:29:44 +00001443 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 Finkelcc39b672014-07-24 12:16:19 +00001449 if (AATags)
1450 NewVal->setAAMetadata(AATags);
Nadav Rotem465834c2012-07-24 10:51:42 +00001451
Chris Lattner98d89d12008-11-27 05:07:53 +00001452 AvailablePreds.push_back(std::make_pair(UnavailablePred, NewVal));
1453 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001454
Chris Lattner98d89d12008-11-27 05:07:53 +00001455 // 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 Lattner2b07d3c2008-12-01 06:52:57 +00001457 array_pod_sort(AvailablePreds.begin(), AvailablePreds.end());
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001458
Chris Lattner98d89d12008-11-27 05:07:53 +00001459 // Create a PHI node at the start of the block for the PRE'd load value.
Jay Foade0938d82011-03-30 11:19:20 +00001460 pred_iterator PB = pred_begin(LoadBB), PE = pred_end(LoadBB);
Brian M. Rzycki994e8892018-01-29 21:29:44 +00001461 PHINode *PN = PHINode::Create(LoadI->getType(), std::distance(PB, PE), "",
Duncan P. N. Exon Smith3a9c9e32015-10-13 18:26:00 +00001462 &LoadBB->front());
Brian M. Rzycki994e8892018-01-29 21:29:44 +00001463 PN->takeName(LoadI);
1464 PN->setDebugLoc(LoadI->getDebugLoc());
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001465
Chris Lattner98d89d12008-11-27 05:07:53 +00001466 // Insert new entries into the PHI for each predecessor. A single block may
1467 // have multiple entries here.
Jay Foade0938d82011-03-30 11:19:20 +00001468 for (pred_iterator PI = PB; PI != PE; ++PI) {
Gabor Greifa5fa8852010-07-12 14:10:24 +00001469 BasicBlock *P = *PI;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001470 AvailablePredsTy::iterator I =
Chris Lattner98d89d12008-11-27 05:07:53 +00001471 std::lower_bound(AvailablePreds.begin(), AvailablePreds.end(),
Craig Topperf40110f2014-04-25 05:29:35 +00001472 std::make_pair(P, (Value*)nullptr));
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001473
Gabor Greifa5fa8852010-07-12 14:10:24 +00001474 assert(I != AvailablePreds.end() && I->first == P &&
Chris Lattner98d89d12008-11-27 05:07:53 +00001475 "Didn't find entry for predecessor!");
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001476
Chandler Carrutheeec35a2014-10-20 00:24:14 +00001477 // If we have an available predecessor but it requires casting, insert the
Chandler Carruth6665d622014-10-20 05:34:36 +00001478 // 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. Rzycki994e8892018-01-29 21:29:44 +00001482 if (PredV->getType() != LoadI->getType())
1483 PredV = CastInst::CreateBitOrPointerCast(PredV, LoadI->getType(), "",
Chandler Carruth1a3c2c42014-11-25 08:20:27 +00001484 P->getTerminator());
Chandler Carrutheeec35a2014-10-20 00:24:14 +00001485
1486 PN->addIncoming(PredV, I->first);
Chris Lattner98d89d12008-11-27 05:07:53 +00001487 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001488
Brian M. Rzycki994e8892018-01-29 21:29:44 +00001489 for (LoadInst *PredLoadI : CSELoads) {
1490 combineMetadataForCSE(PredLoadI, LoadI);
Eli Friedman02419a92016-08-08 04:10:22 +00001491 }
1492
Brian M. Rzycki994e8892018-01-29 21:29:44 +00001493 LoadI->replaceAllUsesWith(PN);
1494 LoadI->eraseFromParent();
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001495
Chris Lattner98d89d12008-11-27 05:07:53 +00001496 return true;
1497}
1498
Chris Lattner5ff7f562009-11-07 08:05:03 +00001499/// FindMostPopularDest - The specified list contains multiple possible
1500/// threadable destinations. Pick the one that occurs the most frequently in
1501/// the list.
1502static BasicBlock *
1503FindMostPopularDest(BasicBlock *BB,
Eugene Zelenko8002c502017-09-13 21:43:53 +00001504 const SmallVectorImpl<std::pair<BasicBlock *,
1505 BasicBlock *>> &PredToDestList) {
Chris Lattner5ff7f562009-11-07 08:05:03 +00001506 assert(!PredToDestList.empty());
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001507
Chris Lattner5ff7f562009-11-07 08:05:03 +00001508 // 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 Kramer543762d2016-01-09 18:43:01 +00001513 for (const auto &PredToDest : PredToDestList)
1514 if (PredToDest.second)
1515 DestPopularity[PredToDest.second]++;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001516
Haicheng Wuc7cc8792018-03-29 16:01:26 +00001517 if (DestPopularity.empty())
1518 return nullptr;
1519
Chris Lattner5ff7f562009-11-07 08:05:03 +00001520 // 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 Bommel5e75ef42010-12-05 19:02:47 +00001525
Chris Lattner5ff7f562009-11-07 08:05:03 +00001526 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 Bommel5e75ef42010-12-05 19:02:47 +00001539 }
Chris Lattner5ff7f562009-11-07 08:05:03 +00001540 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001541
Frits van Bommel9bbe8492010-12-16 12:16:00 +00001542 // Okay, now we know the most popular destination. If there is more than one
Chris Lattner5ff7f562009-11-07 08:05:03 +00001543 // 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 Bommel5e75ef42010-12-05 19:02:47 +00001551
David Majnemer0d955d02016-08-11 22:21:41 +00001552 if (!is_contained(SamePopularity, TI->getSuccessor(i)))
Chris Lattner5ff7f562009-11-07 08:05:03 +00001553 continue;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001554
Chris Lattner5ff7f562009-11-07 08:05:03 +00001555 MostPopularDest = TI->getSuccessor(i);
1556 break;
1557 }
1558 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001559
Chris Lattner5ff7f562009-11-07 08:05:03 +00001560 // Okay, we have finally picked the most popular destination.
1561 return MostPopularDest;
1562}
1563
Sean Silva46590d52016-06-14 00:51:09 +00001564bool JumpThreadingPass::ProcessThreadableEdges(Value *Cond, BasicBlock *BB,
1565 ConstantPreference Preference,
1566 Instruction *CxtI) {
Chris Lattner5ff7f562009-11-07 08:05:03 +00001567 // 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 Bommel5e75ef42010-12-05 19:02:47 +00001571
Frits van Bommel76244862010-12-05 19:06:41 +00001572 PredValueInfoTy PredValues;
Haicheng Wu64d9d7c2016-03-15 23:38:47 +00001573 if (!ComputeValueKnownInPredecessors(Cond, BB, PredValues, Preference, CxtI))
1574 return false;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001575
Chris Lattner5ff7f562009-11-07 08:05:03 +00001576 assert(!PredValues.empty() &&
1577 "ComputeValueKnownInPredecessors returned true with no values");
1578
Craig Topperc9a4c622018-05-31 18:08:11 +00001579 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 Zaghend34e60c2018-05-14 12:53:11 +00001584 });
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001585
Chris Lattner5ff7f562009-11-07 08:05:03 +00001586 // 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 Lattnerea465e22009-11-09 00:41:49 +00001589 // as a null dest in the PredToDestList).
Chris Lattner5ff7f562009-11-07 08:05:03 +00001590 SmallPtrSet<BasicBlock*, 16> SeenPreds;
1591 SmallVector<std::pair<BasicBlock*, BasicBlock*>, 16> PredToDestList;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001592
Craig Topperf40110f2014-04-25 05:29:35 +00001593 BasicBlock *OnlyDest = nullptr;
Chris Lattner5ff7f562009-11-07 08:05:03 +00001594 BasicBlock *MultipleDestSentinel = (BasicBlock*)(intptr_t)~0ULL;
Xin Tong21f8ac22017-05-01 15:34:17 +00001595 Constant *OnlyVal = nullptr;
1596 Constant *MultipleVal = (Constant *)(intptr_t)~0ULL;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001597
Xin Tonga4b9b9f2017-05-01 17:15:37 +00001598 unsigned PredWithKnownDest = 0;
Benjamin Kramer543762d2016-01-09 18:43:01 +00001599 for (const auto &PredValue : PredValues) {
1600 BasicBlock *Pred = PredValue.second;
David Blaikie70573dc2014-11-19 07:49:26 +00001601 if (!SeenPreds.insert(Pred).second)
Chris Lattner5ff7f562009-11-07 08:05:03 +00001602 continue; // Duplicate predecessor entry.
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001603
Benjamin Kramer543762d2016-01-09 18:43:01 +00001604 Constant *Val = PredValue.first;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001605
Chris Lattner5ff7f562009-11-07 08:05:03 +00001606 BasicBlock *DestBB;
Frits van Bommel76244862010-12-05 19:06:41 +00001607 if (isa<UndefValue>(Val))
Craig Topperf40110f2014-04-25 05:29:35 +00001608 DestBB = nullptr;
Xin Tong99dce422017-05-01 16:19:59 +00001609 else if (BranchInst *BI = dyn_cast<BranchInst>(BB->getTerminator())) {
1610 assert(isa<ConstantInt>(Val) && "Expecting a constant integer");
Frits van Bommel76244862010-12-05 19:06:41 +00001611 DestBB = BI->getSuccessor(cast<ConstantInt>(Val)->isZero());
Xin Tong99dce422017-05-01 16:19:59 +00001612 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(BB->getTerminator())) {
1613 assert(isa<ConstantInt>(Val) && "Expecting a constant integer");
Chandler Carruth927d8e62017-04-12 07:27:28 +00001614 DestBB = SI->findCaseValue(cast<ConstantInt>(Val))->getCaseSuccessor();
Stepan Dyatkovskiy513aaa52012-02-01 07:49:51 +00001615 } else {
Frits van Bommeld9df6ea2010-12-06 23:36:56 +00001616 assert(isa<IndirectBrInst>(BB->getTerminator())
1617 && "Unexpected terminator");
Xin Tong99dce422017-05-01 16:19:59 +00001618 assert(isa<BlockAddress>(Val) && "Expecting a constant blockaddress");
Frits van Bommeld9df6ea2010-12-06 23:36:56 +00001619 DestBB = cast<BlockAddress>(Val)->getBasicBlock();
Chris Lattner5ff7f562009-11-07 08:05:03 +00001620 }
1621
1622 // If we have exactly one destination, remember it for efficiency below.
Xin Tong21f8ac22017-05-01 15:34:17 +00001623 if (PredToDestList.empty()) {
Chris Lattner5ff7f562009-11-07 08:05:03 +00001624 OnlyDest = DestBB;
Xin Tong21f8ac22017-05-01 15:34:17 +00001625 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 Bommel5e75ef42010-12-05 19:02:47 +00001634
Xin Tonga4b9b9f2017-05-01 17:15:37 +00001635 // 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 Lattner5ff7f562009-11-07 08:05:03 +00001643 PredToDestList.push_back(std::make_pair(Pred, DestBB));
1644 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001645
Chris Lattner5ff7f562009-11-07 08:05:03 +00001646 // If all edges were unthreadable, we fail.
1647 if (PredToDestList.empty())
Haicheng Wu64d9d7c2016-03-15 23:38:47 +00001648 return false;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001649
Xin Tongf98602a2017-04-23 20:56:29 +00001650 // 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 Kumare0b5f862018-05-10 23:01:54 +00001654 if (PredWithKnownDest == (size_t)pred_size(BB)) {
Xin Tongf98602a2017-04-23 20:56:29 +00001655 bool SeenFirstBranchToOnlyDest = false;
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00001656 std::vector <DominatorTree::UpdateType> Updates;
1657 Updates.reserve(BB->getTerminator()->getNumSuccessors() - 1);
Xin Tongf98602a2017-04-23 20:56:29 +00001658 for (BasicBlock *SuccBB : successors(BB)) {
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00001659 if (SuccBB == OnlyDest && !SeenFirstBranchToOnlyDest) {
Xin Tongf98602a2017-04-23 20:56:29 +00001660 SeenFirstBranchToOnlyDest = true; // Don't modify the first branch.
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00001661 } else {
Xin Tongf98602a2017-04-23 20:56:29 +00001662 SuccBB->removePredecessor(BB, true); // This is unreachable successor.
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00001663 Updates.push_back({DominatorTree::Delete, BB, SuccBB});
1664 }
Xin Tongf98602a2017-04-23 20:56:29 +00001665 }
1666
1667 // Finally update the terminator.
1668 TerminatorInst *Term = BB->getTerminator();
1669 BranchInst::Create(OnlyDest, Term);
1670 Term->eraseFromParent();
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00001671 DDT->applyUpdates(Updates);
Xin Tongf98602a2017-04-23 20:56:29 +00001672
1673 // If the condition is now dead due to the removal of the old terminator,
1674 // erase it.
Xin Tong21f8ac22017-05-01 15:34:17 +00001675 if (auto *CondInst = dyn_cast<Instruction>(Cond)) {
1676 if (CondInst->use_empty() && !CondInst->mayHaveSideEffects())
1677 CondInst->eraseFromParent();
Anna Thomasc07d5542017-05-23 13:36:25 +00001678 // We can safely replace *some* uses of the CondInst if it has
Anna Thomas7bca5912017-05-18 13:12:18 +00001679 // 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 Thomasc07d5542017-05-23 13:36:25 +00001685 else if (OnlyVal && OnlyVal != MultipleVal &&
1686 CondInst->getParent() == BB)
1687 ReplaceFoldableUses(CondInst, OnlyVal);
Xin Tong21f8ac22017-05-01 15:34:17 +00001688 }
Xin Tongf98602a2017-04-23 20:56:29 +00001689 return true;
1690 }
1691 }
1692
Chris Lattner5ff7f562009-11-07 08:05:03 +00001693 // 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 Bommel5e75ef42010-12-05 19:02:47 +00001698
Haicheng Wuc7cc8792018-03-29 16:01:26 +00001699 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 Lattner5ff7f562009-11-07 08:05:03 +00001711 MostPopularDest = FindMostPopularDest(BB, PredToDestList);
Haicheng Wuc7cc8792018-03-29 16:01:26 +00001712 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001713
Chris Lattner5ff7f562009-11-07 08:05:03 +00001714 // 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 Kramer543762d2016-01-09 18:43:01 +00001717 for (const auto &PredToDest : PredToDestList)
1718 if (PredToDest.second == MostPopularDest) {
1719 BasicBlock *Pred = PredToDest.first;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001720
Chris Lattner5ff7f562009-11-07 08:05:03 +00001721 // 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 Kramer543762d2016-01-09 18:43:01 +00001724 for (BasicBlock *Succ : successors(Pred))
1725 if (Succ == BB)
Chris Lattner5ff7f562009-11-07 08:05:03 +00001726 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 Topperf40110f2014-04-25 05:29:35 +00001731 if (!MostPopularDest)
Chris Lattner5ff7f562009-11-07 08:05:03 +00001732 MostPopularDest = BB->getTerminator()->
1733 getSuccessor(GetBestDestForJumpOnUndef(BB));
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001734
Chris Lattner5ff7f562009-11-07 08:05:03 +00001735 // Ok, try to thread it!
Haicheng Wu64d9d7c2016-03-15 23:38:47 +00001736 return ThreadEdge(BB, PredsToFactor, MostPopularDest);
Chris Lattner5ff7f562009-11-07 08:05:03 +00001737}
Chris Lattner98d89d12008-11-27 05:07:53 +00001738
Chris Lattner6a19ed02010-01-11 23:41:09 +00001739/// 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 Silva46590d52016-06-14 00:51:09 +00001742bool JumpThreadingPass::ProcessBranchOnPHI(PHINode *PN) {
Chris Lattner6ce85e82009-10-11 04:40:21 +00001743 BasicBlock *BB = PN->getParent();
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001744
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001745 // 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 Bommel5e75ef42010-12-05 19:02:47 +00001749
Chris Lattner5ff7f562009-11-07 08:05:03 +00001750 // If any of the predecessor blocks end in an unconditional branch, we can
Chris Lattner6a19ed02010-01-11 23:41:09 +00001751 // *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 Lattner97b14052009-10-11 07:24:57 +00001754 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 Lattnereb73bdb2010-01-12 02:07:17 +00001757 if (PredBr->isUnconditional()) {
1758 PredBBs[0] = PredBB;
1759 // Try to duplicate BB into PredBB.
1760 if (DuplicateCondBranchOnPHIIntoPred(BB, PredBBs))
1761 return true;
1762 }
Chris Lattner97b14052009-10-11 07:24:57 +00001763 }
1764
Chris Lattner6ce85e82009-10-11 04:40:21 +00001765 return false;
Chris Lattnerff1c6e32008-04-20 22:39:42 +00001766}
1767
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001768/// 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 Silva46590d52016-06-14 00:51:09 +00001771bool JumpThreadingPass::ProcessBranchOnXOR(BinaryOperator *BO) {
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001772 BasicBlock *BB = BO->getParent();
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001773
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001774 // 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 Bommel5e75ef42010-12-05 19:02:47 +00001779
Chris Lattnerba2d0b82010-01-23 19:16:25 +00001780 // 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 Bommel5e75ef42010-12-05 19:02:47 +00001784
Hans Wennborgb4d26782016-10-03 18:18:04 +00001785 // 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 Lattnereb73bdb2010-01-12 02:07:17 +00001789 // 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 Kreitzerda700ce2015-09-16 13:27:30 +00001805 // br i1 %Y, ...
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001806
Frits van Bommel76244862010-12-05 19:06:41 +00001807 PredValueInfoTy XorOpValues;
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001808 bool isLHS = true;
Frits van Bommeld9df6ea2010-12-06 23:36:56 +00001809 if (!ComputeValueKnownInPredecessors(BO->getOperand(0), BB, XorOpValues,
Haicheng Wu64d9d7c2016-03-15 23:38:47 +00001810 WantInteger, BO)) {
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001811 assert(XorOpValues.empty());
Frits van Bommeld9df6ea2010-12-06 23:36:56 +00001812 if (!ComputeValueKnownInPredecessors(BO->getOperand(1), BB, XorOpValues,
Haicheng Wu64d9d7c2016-03-15 23:38:47 +00001813 WantInteger, BO))
1814 return false;
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001815 isLHS = false;
1816 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001817
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001818 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 Kramer543762d2016-01-09 18:43:01 +00001824 for (const auto &XorOpValue : XorOpValues) {
1825 if (isa<UndefValue>(XorOpValue.first))
Frits van Bommel76244862010-12-05 19:06:41 +00001826 // Ignore undefs for the count.
1827 continue;
Benjamin Kramer543762d2016-01-09 18:43:01 +00001828 if (cast<ConstantInt>(XorOpValue.first)->isZero())
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001829 ++NumFalse;
1830 else
1831 ++NumTrue;
1832 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001833
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001834 // Determine which value to split on, true, false, or undef if neither.
Craig Topperf40110f2014-04-25 05:29:35 +00001835 ConstantInt *SplitVal = nullptr;
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001836 if (NumTrue > NumFalse)
1837 SplitVal = ConstantInt::getTrue(BB->getContext());
1838 else if (NumTrue != 0 || NumFalse != 0)
1839 SplitVal = ConstantInt::getFalse(BB->getContext());
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001840
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001841 // 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 Kramer543762d2016-01-09 18:43:01 +00001844 for (const auto &XorOpValue : XorOpValues) {
1845 if (XorOpValue.first != SplitVal && !isa<UndefValue>(XorOpValue.first))
Frits van Bommel76244862010-12-05 19:06:41 +00001846 continue;
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001847
Benjamin Kramer543762d2016-01-09 18:43:01 +00001848 BlocksToFoldInto.push_back(XorOpValue.second);
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001849 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001850
Chris Lattnerba2d0b82010-01-23 19:16:25 +00001851 // 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 Topperf40110f2014-04-25 05:29:35 +00001855 if (!SplitVal) {
Chris Lattnerba2d0b82010-01-23 19:16:25 +00001856 // 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 Bommel5e75ef42010-12-05 19:02:47 +00001867
Chris Lattnerba2d0b82010-01-23 19:16:25 +00001868 return true;
1869 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001870
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001871 // Try to duplicate BB into PredBB.
Haicheng Wu64d9d7c2016-03-15 23:38:47 +00001872 return DuplicateCondBranchOnPHIIntoPred(BB, BlocksToFoldInto);
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001873}
1874
Chris Lattner97b14052009-10-11 07:24:57 +00001875/// 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).
1878static void AddPHINodeEntriesForMappedBlock(BasicBlock *PHIBB,
1879 BasicBlock *OldPred,
1880 BasicBlock *NewPred,
1881 DenseMap<Instruction*, Value*> &ValueMap) {
Benjamin Kramerc7fc81e2017-12-30 15:27:33 +00001882 for (PHINode &PN : PHIBB->phis()) {
Chris Lattner97b14052009-10-11 07:24:57 +00001883 // Ok, we have a PHI node. Figure out what the incoming value was for the
1884 // DestBlock.
Benjamin Kramerc7fc81e2017-12-30 15:27:33 +00001885 Value *IV = PN.getIncomingValueForBlock(OldPred);
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001886
Chris Lattner97b14052009-10-11 07:24:57 +00001887 // 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 Bommel5e75ef42010-12-05 19:02:47 +00001893
Benjamin Kramerc7fc81e2017-12-30 15:27:33 +00001894 PN.addIncoming(IV, NewPred);
Chris Lattner97b14052009-10-11 07:24:57 +00001895 }
1896}
Chris Lattner3df4c152008-04-22 07:05:46 +00001897
Chris Lattner5ff7f562009-11-07 08:05:03 +00001898/// 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 Silva46590d52016-06-14 00:51:09 +00001901bool JumpThreadingPass::ThreadEdge(BasicBlock *BB,
1902 const SmallVectorImpl<BasicBlock *> &PredBBs,
1903 BasicBlock *SuccBB) {
Chris Lattnerd579cb12009-05-04 02:28:08 +00001904 // If threading to the same block as we come from, we would infinite loop.
1905 if (SuccBB == BB) {
Nicola Zaghend34e60c2018-05-14 12:53:11 +00001906 LLVM_DEBUG(dbgs() << " Not threading across BB '" << BB->getName()
1907 << "' - would thread to self!\n");
Chris Lattnerd579cb12009-05-04 02:28:08 +00001908 return false;
1909 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001910
Chris Lattnerd579cb12009-05-04 02:28:08 +00001911 // 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 Parzyszek1dc31372017-09-06 19:36:58 +00001913 if (LoopHeaders.count(BB) || LoopHeaders.count(SuccBB)) {
Nicola Zaghend34e60c2018-05-14 12:53:11 +00001914 LLVM_DEBUG({
Krzysztof Parzyszek1dc31372017-09-06 19:36:58 +00001915 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 Lattnerd579cb12009-05-04 02:28:08 +00001922 return false;
1923 }
1924
Sanjoy Das8b859c22017-02-17 04:21:14 +00001925 unsigned JumpThreadCost =
1926 getJumpThreadDuplicationCost(BB, BB->getTerminator(), BBDupThreshold);
Michael Liaod1209162014-09-24 04:59:06 +00001927 if (JumpThreadCost > BBDupThreshold) {
Nicola Zaghend34e60c2018-05-14 12:53:11 +00001928 LLVM_DEBUG(dbgs() << " Not threading BB '" << BB->getName()
1929 << "' - Cost is too high: " << JumpThreadCost << "\n");
Chris Lattner97b14052009-10-11 07:24:57 +00001930 return false;
1931 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001932
David L Kreitzerda700ce2015-09-16 13:27:30 +00001933 // And finally, do it! Start by factoring the predecessors if needed.
Chris Lattner5ff7f562009-11-07 08:05:03 +00001934 BasicBlock *PredBB;
1935 if (PredBBs.size() == 1)
1936 PredBB = PredBBs[0];
1937 else {
Nicola Zaghend34e60c2018-05-14 12:53:11 +00001938 LLVM_DEBUG(dbgs() << " Factoring out " << PredBBs.size()
1939 << " common predecessors.\n");
Manman Ren72d44b12015-10-15 14:59:40 +00001940 PredBB = SplitBlockPreds(BB, PredBBs, ".thr_comm");
Chris Lattner5ff7f562009-11-07 08:05:03 +00001941 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001942
Chris Lattnerd579cb12009-05-04 02:28:08 +00001943 // And finally, do it!
Nicola Zaghend34e60c2018-05-14 12:53:11 +00001944 LLVM_DEBUG(dbgs() << " Threading edge from '" << PredBB->getName()
1945 << "' to '" << SuccBB->getName()
1946 << "' with cost: " << JumpThreadCost
1947 << ", across block:\n " << *BB << "\n");
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001948
Brian M. Rzyckif1a7df52018-02-16 16:35:17 +00001949 if (DDT->pending())
1950 LVI->disableDT();
1951 else
1952 LVI->enableDT();
Owen Andersond361aac2010-09-14 20:57:41 +00001953 LVI->threadEdge(PredBB, BB, SuccBB);
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001954
Chris Lattnerff1c6e32008-04-20 22:39:42 +00001955 // 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 Bommel5e75ef42010-12-05 19:02:47 +00001959
1960 BasicBlock *NewBB = BasicBlock::Create(BB->getContext(),
1961 BB->getName()+".thread",
Owen Anderson55f1c092009-08-13 21:58:54 +00001962 BB->getParent(), BB);
Chris Lattnerff1c6e32008-04-20 22:39:42 +00001963 NewBB->moveAfter(PredBB);
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001964
Manman Ren72d44b12015-10-15 14:59:40 +00001965 // 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 Lattnerff1c6e32008-04-20 22:39:42 +00001972 BasicBlock::iterator BI = BB->begin();
1973 for (; PHINode *PN = dyn_cast<PHINode>(BI); ++BI)
1974 ValueMapping[PN] = PN->getIncomingValueForBlock(PredBB);
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001975
Chris Lattnerff1c6e32008-04-20 22:39:42 +00001976 // 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 Lewycky42fb7452009-09-27 07:38:41 +00001979 Instruction *New = BI->clone();
Daniel Dunbar6115b392009-07-26 09:48:23 +00001980 New->setName(BI->getName());
Chris Lattnerff1c6e32008-04-20 22:39:42 +00001981 NewBB->getInstList().push_back(New);
Duncan P. N. Exon Smith3a9c9e32015-10-13 18:26:00 +00001982 ValueMapping[&*BI] = New;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001983
Chris Lattnerff1c6e32008-04-20 22:39:42 +00001984 // Remap operands to patch up intra-block references.
1985 for (unsigned i = 0, e = New->getNumOperands(); i != e; ++i)
Dan Gohman43f33dd2009-07-02 00:17:47 +00001986 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 Lattnerff1c6e32008-04-20 22:39:42 +00001991 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001992
Chris Lattnerff1c6e32008-04-20 22:39:42 +00001993 // 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 Ren72d44b12015-10-15 14:59:40 +00001995 BranchInst *NewBI = BranchInst::Create(SuccBB, NewBB);
Devang Patel306f8db2011-05-04 22:48:19 +00001996 NewBI->setDebugLoc(BB->getTerminator()->getDebugLoc());
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001997
Chris Lattnerff1c6e32008-04-20 22:39:42 +00001998 // Check to see if SuccBB has PHI nodes. If so, we need to add entries to the
1999 // PHI nodes for NewBB now.
Chris Lattner97b14052009-10-11 07:24:57 +00002000 AddPHINodeEntriesForMappedBlock(SuccBB, BB, NewBB, ValueMapping);
Frits van Bommel5e75ef42010-12-05 19:02:47 +00002001
Michael Zolotukhina41660d2018-05-12 01:52:36 +00002002 // 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 Lattner84095072009-10-10 09:05:58 +00002012 // 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 Zolotukhina41660d2018-05-12 01:52:36 +00002016 SSAUpdaterBulk SSAUpdate;
2017
Benjamin Kramer543762d2016-01-09 18:43:01 +00002018 for (Instruction &I : *BB) {
Michael Zolotukhina41660d2018-05-12 01:52:36 +00002019 SmallVector<Use*, 16> UsesToRename;
2020
Chris Lattner84095072009-10-10 09:05:58 +00002021 // Scan all uses of this instruction to see if it is used outside of its
Michael Zolotukhina41660d2018-05-12 01:52:36 +00002022 // block, and if so, record them in UsesToRename. Also, skip phi operands
2023 // from PredBB - we'll remove them anyway.
Benjamin Kramer543762d2016-01-09 18:43:01 +00002024 for (Use &U : I.uses()) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00002025 Instruction *User = cast<Instruction>(U.getUser());
Chris Lattner84095072009-10-10 09:05:58 +00002026 if (PHINode *UserPN = dyn_cast<PHINode>(User)) {
Michael Zolotukhina41660d2018-05-12 01:52:36 +00002027 if (UserPN->getIncomingBlock(U) == BB ||
2028 UserPN->getIncomingBlock(U) == PredBB)
Chris Lattner84095072009-10-10 09:05:58 +00002029 continue;
2030 } else if (User->getParent() == BB)
2031 continue;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00002032
Chandler Carruthcdf47882014-03-09 03:16:01 +00002033 UsesToRename.push_back(&U);
Chris Lattner84095072009-10-10 09:05:58 +00002034 }
Daniel Jasper0a51ec22017-09-30 11:57:19 +00002035
Chris Lattner84095072009-10-10 09:05:58 +00002036 // If there are no uses outside the block, we're done with this instruction.
2037 if (UsesToRename.empty())
2038 continue;
Michael Zolotukhina41660d2018-05-12 01:52:36 +00002039 unsigned VarNum = SSAUpdate.AddVariable(I.getName(), I.getType());
Frits van Bommel5e75ef42010-12-05 19:02:47 +00002040
Michael Zolotukhina41660d2018-05-12 01:52:36 +00002041 // 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 Lattner84095072009-10-10 09:05:58 +00002047 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00002048
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00002049 DDT->applyUpdates({{DominatorTree::Insert, NewBB, SuccBB},
2050 {DominatorTree::Insert, PredBB, NewBB},
2051 {DominatorTree::Delete, PredBB, BB}});
2052
Michael Zolotukhina41660d2018-05-12 01:52:36 +00002053 // Apply all updates we queued with DDT and get the updated Dominator Tree.
2054 DominatorTree *DT = &DDT->flush();
2055 SSAUpdate.RewriteAllUses(DT);
2056
Chris Lattner88a1f022008-12-01 04:48:07 +00002057 // 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 Aminia28d91d2015-03-10 02:37:25 +00002060 SimplifyInstructionsInBlock(NewBB, TLI);
Frits van Bommel5e75ef42010-12-05 19:02:47 +00002061
Manman Ren72d44b12015-10-15 14:59:40 +00002062 // Update the edge weight from BB to SuccBB, which should be less than before.
2063 UpdateBlockFreqAndEdgeWeight(PredBB, BB, NewBB, SuccBB);
2064
Chris Lattnerd579cb12009-05-04 02:28:08 +00002065 // Threaded an edge!
2066 ++NumThreads;
2067 return true;
Chris Lattner21157222008-04-20 21:13:06 +00002068}
Chris Lattner97b14052009-10-11 07:24:57 +00002069
Manman Ren72d44b12015-10-15 14:59:40 +00002070/// Create a new basic block that will be the predecessor of BB and successor of
Simon Pilgrim7d18a702016-11-20 13:19:49 +00002071/// all blocks in Preds. When profile data is available, update the frequency of
Manman Ren72d44b12015-10-15 14:59:40 +00002072/// this new block.
Sean Silva46590d52016-06-14 00:51:09 +00002073BasicBlock *JumpThreadingPass::SplitBlockPreds(BasicBlock *BB,
2074 ArrayRef<BasicBlock *> Preds,
2075 const char *Suffix) {
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00002076 SmallVector<BasicBlock *, 2> NewBBs;
2077
Manman Ren72d44b12015-10-15 14:59:40 +00002078 // Collect the frequencies of all predecessors of BB, which will be used to
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00002079 // update the edge weight of the result of splitting predecessors.
2080 DenseMap<BasicBlock *, BlockFrequency> FreqMap;
Manman Ren72d44b12015-10-15 14:59:40 +00002081 if (HasProfileData)
2082 for (auto Pred : Preds)
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00002083 FreqMap.insert(std::make_pair(
2084 Pred, BFI->getBlockFreq(Pred) * BPI->getEdgeProbability(Pred, BB)));
Manman Ren72d44b12015-10-15 14:59:40 +00002085
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00002086 // 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 Ren72d44b12015-10-15 14:59:40 +00002094
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00002095 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 Ren72d44b12015-10-15 14:59:40 +00002112}
2113
Adam Nemetc5208222016-09-06 16:08:33 +00002114bool 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 Ren72d44b12015-10-15 14:59:40 +00002131/// 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 Silva46590d52016-06-14 00:51:09 +00002134void JumpThreadingPass::UpdateBlockFreqAndEdgeWeight(BasicBlock *PredBB,
2135 BasicBlock *BB,
2136 BasicBlock *NewBB,
2137 BasicBlock *SuccBB) {
Manman Ren72d44b12015-10-15 14:59:40 +00002138 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 Houe93b8e12015-12-22 18:56:14 +00002152 // edge probabilities.
Manman Ren72d44b12015-10-15 14:59:40 +00002153 SmallVector<uint64_t, 4> BBSuccFreq;
Benjamin Kramer543762d2016-01-09 18:43:01 +00002154 for (BasicBlock *Succ : successors(BB)) {
2155 auto SuccFreq = (Succ == SuccBB)
Manman Ren72d44b12015-10-15 14:59:40 +00002156 ? BB2SuccBBFreq - NewBBFreq
Benjamin Kramer543762d2016-01-09 18:43:01 +00002157 : BBOrigFreq * BPI->getEdgeProbability(BB, Succ);
Manman Ren72d44b12015-10-15 14:59:40 +00002158 BBSuccFreq.push_back(SuccFreq.getFrequency());
2159 }
2160
Cong Houe93b8e12015-12-22 18:56:14 +00002161 uint64_t MaxBBSuccFreq =
2162 *std::max_element(BBSuccFreq.begin(), BBSuccFreq.end());
Manman Ren72d44b12015-10-15 14:59:40 +00002163
Cong Hou6a2c71a2015-12-22 23:45:55 +00002164 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 Ren72d44b12015-10-15 14:59:40 +00002176
Cong Houe93b8e12015-12-22 18:56:14 +00002177 // Update edge probabilities in BPI.
2178 for (int I = 0, E = BBSuccProbs.size(); I < E; I++)
2179 BPI->setEdgeProbability(BB, I, BBSuccProbs[I]);
Manman Ren72d44b12015-10-15 14:59:40 +00002180
Adam Nemetc5208222016-09-06 16:08:33 +00002181 // 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 Houe93b8e12015-12-22 18:56:14 +00002216 SmallVector<uint32_t, 4> Weights;
2217 for (auto Prob : BBSuccProbs)
2218 Weights.push_back(Prob.getNumerator());
2219
Manman Ren72d44b12015-10-15 14:59:40 +00002220 auto TI = BB->getTerminator();
2221 TI->setMetadata(
2222 LLVMContext::MD_prof,
2223 MDBuilder(TI->getParent()->getContext()).createBranchWeights(Weights));
2224 }
2225}
2226
Chris Lattner97b14052009-10-11 07:24:57 +00002227/// 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 Silva46590d52016-06-14 00:51:09 +00002232bool JumpThreadingPass::DuplicateCondBranchOnPHIIntoPred(
2233 BasicBlock *BB, const SmallVectorImpl<BasicBlock *> &PredBBs) {
Chris Lattnereb73bdb2010-01-12 02:07:17 +00002234 assert(!PredBBs.empty() && "Can't handle an empty set");
2235
Chris Lattner97b14052009-10-11 07:24:57 +00002236 // 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 Zaghend34e60c2018-05-14 12:53:11 +00002240 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 Lattner97b14052009-10-11 07:24:57 +00002243 return false;
2244 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00002245
Sanjoy Das8b859c22017-02-17 04:21:14 +00002246 unsigned DuplicationCost =
2247 getJumpThreadDuplicationCost(BB, BB->getTerminator(), BBDupThreshold);
Michael Liaod1209162014-09-24 04:59:06 +00002248 if (DuplicationCost > BBDupThreshold) {
Nicola Zaghend34e60c2018-05-14 12:53:11 +00002249 LLVM_DEBUG(dbgs() << " Not duplicating BB '" << BB->getName()
2250 << "' - Cost is too high: " << DuplicationCost << "\n");
Chris Lattner97b14052009-10-11 07:24:57 +00002251 return false;
2252 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00002253
David L Kreitzerda700ce2015-09-16 13:27:30 +00002254 // And finally, do it! Start by factoring the predecessors if needed.
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00002255 std::vector<DominatorTree::UpdateType> Updates;
Chris Lattnereb73bdb2010-01-12 02:07:17 +00002256 BasicBlock *PredBB;
2257 if (PredBBs.size() == 1)
2258 PredBB = PredBBs[0];
2259 else {
Nicola Zaghend34e60c2018-05-14 12:53:11 +00002260 LLVM_DEBUG(dbgs() << " Factoring out " << PredBBs.size()
2261 << " common predecessors.\n");
Manman Ren72d44b12015-10-15 14:59:40 +00002262 PredBB = SplitBlockPreds(BB, PredBBs, ".thr_comm");
Chris Lattnereb73bdb2010-01-12 02:07:17 +00002263 }
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00002264 Updates.push_back({DominatorTree::Delete, PredBB, BB});
Frits van Bommel5e75ef42010-12-05 19:02:47 +00002265
Chris Lattner97b14052009-10-11 07:24:57 +00002266 // Okay, we decided to do this! Clone all the instructions in BB onto the end
2267 // of PredBB.
Nicola Zaghend34e60c2018-05-14 12:53:11 +00002268 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 Bommel5e75ef42010-12-05 19:02:47 +00002272
Chris Lattnereb73bdb2010-01-12 02:07:17 +00002273 // 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 Lattner29b15c52010-01-23 19:21:31 +00002275 BranchInst *OldPredBranch = dyn_cast<BranchInst>(PredBB->getTerminator());
Frits van Bommel5e75ef42010-12-05 19:02:47 +00002276
Craig Topperf40110f2014-04-25 05:29:35 +00002277 if (!OldPredBranch || !OldPredBranch->isUnconditional()) {
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00002278 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 Lattnereb73bdb2010-01-12 02:07:17 +00002283 OldPredBranch = cast<BranchInst>(PredBB->getTerminator());
2284 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00002285
Chris Lattner97b14052009-10-11 07:24:57 +00002286 // 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 Bommel5e75ef42010-12-05 19:02:47 +00002289
Chris Lattner97b14052009-10-11 07:24:57 +00002290 BasicBlock::iterator BI = BB->begin();
2291 for (; PHINode *PN = dyn_cast<PHINode>(BI); ++BI)
2292 ValueMapping[PN] = PN->getIncomingValueForBlock(PredBB);
Chris Lattner97b14052009-10-11 07:24:57 +00002293 // 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 Bommel5e75ef42010-12-05 19:02:47 +00002297
Chris Lattner97b14052009-10-11 07:24:57 +00002298 // 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 Lattner573da8a2010-01-12 20:41:47 +00002305
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 Berlin4d0fe642017-04-28 19:55:38 +00002309 if (Value *IV = SimplifyInstruction(
2310 New,
2311 {BB->getModule()->getDataLayout(), TLI, nullptr, nullptr, New})) {
Duncan P. N. Exon Smith3a9c9e32015-10-13 18:26:00 +00002312 ValueMapping[&*BI] = IV;
David Majnemerb8da3a22016-06-25 00:04:10 +00002313 if (!New->mayHaveSideEffects()) {
Reid Kleckner96ab8722017-05-18 17:24:10 +00002314 New->deleteValue();
David Majnemerb8da3a22016-06-25 00:04:10 +00002315 New = nullptr;
2316 }
Chris Lattner573da8a2010-01-12 20:41:47 +00002317 } else {
David Majnemerb8da3a22016-06-25 00:04:10 +00002318 ValueMapping[&*BI] = New;
2319 }
2320 if (New) {
Chris Lattner573da8a2010-01-12 20:41:47 +00002321 // Otherwise, insert the new instruction into the block.
2322 New->setName(BI->getName());
Duncan P. N. Exon Smith3a9c9e32015-10-13 18:26:00 +00002323 PredBB->getInstList().insert(OldPredBranch->getIterator(), New);
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00002324 // 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 Lattner573da8a2010-01-12 20:41:47 +00002328 }
Chris Lattner97b14052009-10-11 07:24:57 +00002329 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00002330
Chris Lattner97b14052009-10-11 07:24:57 +00002331 // 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 Bommel5e75ef42010-12-05 19:02:47 +00002338
Chris Lattner97b14052009-10-11 07:24:57 +00002339 // 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 Kramer543762d2016-01-09 18:43:01 +00002345 for (Instruction &I : *BB) {
Chris Lattner97b14052009-10-11 07:24:57 +00002346 // 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 Kramer543762d2016-01-09 18:43:01 +00002348 for (Use &U : I.uses()) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00002349 Instruction *User = cast<Instruction>(U.getUser());
Chris Lattner97b14052009-10-11 07:24:57 +00002350 if (PHINode *UserPN = dyn_cast<PHINode>(User)) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00002351 if (UserPN->getIncomingBlock(U) == BB)
Chris Lattner97b14052009-10-11 07:24:57 +00002352 continue;
2353 } else if (User->getParent() == BB)
2354 continue;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00002355
Chandler Carruthcdf47882014-03-09 03:16:01 +00002356 UsesToRename.push_back(&U);
Chris Lattner97b14052009-10-11 07:24:57 +00002357 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00002358
Chris Lattner97b14052009-10-11 07:24:57 +00002359 // If there are no uses outside the block, we're done with this instruction.
2360 if (UsesToRename.empty())
2361 continue;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00002362
Nicola Zaghend34e60c2018-05-14 12:53:11 +00002363 LLVM_DEBUG(dbgs() << "JT: Renaming non-local uses of: " << I << "\n");
Frits van Bommel5e75ef42010-12-05 19:02:47 +00002364
Chris Lattner97b14052009-10-11 07:24:57 +00002365 // 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 Kramer543762d2016-01-09 18:43:01 +00002368 SSAUpdate.Initialize(I.getType(), I.getName());
2369 SSAUpdate.AddAvailableValue(BB, &I);
2370 SSAUpdate.AddAvailableValue(PredBB, ValueMapping[&I]);
Frits van Bommel5e75ef42010-12-05 19:02:47 +00002371
Chris Lattner97b14052009-10-11 07:24:57 +00002372 while (!UsesToRename.empty())
2373 SSAUpdate.RewriteUse(*UsesToRename.pop_back_val());
Nicola Zaghend34e60c2018-05-14 12:53:11 +00002374 LLVM_DEBUG(dbgs() << "\n");
Chris Lattner97b14052009-10-11 07:24:57 +00002375 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00002376
Chris Lattner97b14052009-10-11 07:24:57 +00002377 // PredBB no longer jumps to BB, remove entries in the PHI node for the edge
2378 // that we nuked.
Owen Anderson99c985c2010-09-29 20:34:41 +00002379 BB->removePredecessor(PredBB, true);
Frits van Bommel5e75ef42010-12-05 19:02:47 +00002380
Chris Lattner97b14052009-10-11 07:24:57 +00002381 // Remove the unconditional branch at the end of the PredBB block.
2382 OldPredBranch->eraseFromParent();
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00002383 DDT->applyUpdates(Updates);
Frits van Bommel5e75ef42010-12-05 19:02:47 +00002384
Chris Lattner97b14052009-10-11 07:24:57 +00002385 ++NumDupes;
2386 return true;
2387}
Benjamin Kramer6a4976d2013-08-07 10:29:38 +00002388
2389/// TryToUnfoldSelect - Look for blocks of the form
2390/// bb1:
2391/// %a = select
Xin Tong3ca169f2017-02-26 19:08:44 +00002392/// br bb2
Benjamin Kramer6a4976d2013-08-07 10:29:38 +00002393///
2394/// bb2:
Xin Tong3ca169f2017-02-26 19:08:44 +00002395/// %p = phi [%a, %bb1] ...
Benjamin Kramer6a4976d2013-08-07 10:29:38 +00002396/// %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 Silva46590d52016-06-14 00:51:09 +00002401bool JumpThreadingPass::TryToUnfoldSelect(CmpInst *CondCmp, BasicBlock *BB) {
Benjamin Kramer6a4976d2013-08-07 10:29:38 +00002402 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. Rzyckif1a7df52018-02-16 16:35:17 +00002426 if (DDT->pending())
2427 LVI->disableDT();
2428 else
2429 LVI->enableDT();
Benjamin Kramer6a4976d2013-08-07 10:29:38 +00002430 LazyValueInfo::Tristate LHSFolds =
2431 LVI->getPredicateOnEdge(CondCmp->getPredicate(), SI->getOperand(1),
Hal Finkel7e184492014-09-07 20:29:59 +00002432 CondRHS, Pred, BB, CondCmp);
Benjamin Kramer6a4976d2013-08-07 10:29:38 +00002433 LazyValueInfo::Tristate RHSFolds =
2434 LVI->getPredicateOnEdge(CondCmp->getPredicate(), SI->getOperand(2),
Hal Finkel7e184492014-09-07 20:29:59 +00002435 CondRHS, Pred, BB, CondCmp);
Benjamin Kramer6a4976d2013-08-07 10:29:38 +00002436 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. Rzycki9b7ae232018-01-12 21:06:48 +00002460 DDT->applyUpdates({{DominatorTree::Insert, NewBB, BB},
2461 {DominatorTree::Insert, Pred, NewBB}});
Benjamin Kramer6a4976d2013-08-07 10:29:38 +00002462 // 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 Wua6a32792016-01-08 19:39:39 +00002472
Haicheng Wu476adcc2017-07-14 19:16:47 +00002473/// TryToUnfoldSelectInCurrBB - Look for PHI/Select or PHI/CMP/Select in the
2474/// same BB in the form
Haicheng Wua6a32792016-01-08 19:39:39 +00002475/// bb:
2476/// %p = phi [false, %bb1], [true, %bb2], [false, %bb3], [true, %bb4], ...
Haicheng Wu476adcc2017-07-14 19:16:47 +00002477/// %s = select %p, trueval, falseval
Haicheng Wua6a32792016-01-08 19:39:39 +00002478///
Haicheng Wu476adcc2017-07-14 19:16:47 +00002479/// 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 Zelenko8002c502017-09-13 21:43:53 +00002485///
Pablo Barrio4f80c932016-11-15 15:42:23 +00002486/// And expand the select into a branch structure. This later enables
Haicheng Wua6a32792016-01-08 19:39:39 +00002487/// jump-threading over bb in this pass.
2488///
Pablo Barrio4f80c932016-11-15 15:42:23 +00002489/// 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 Silva46590d52016-06-14 00:51:09 +00002493bool JumpThreadingPass::TryToUnfoldSelectInCurrBB(BasicBlock *BB) {
Haicheng Wua6a32792016-01-08 19:39:39 +00002494 // 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 Barrio4f80c932016-11-15 15:42:23 +00002499 for (BasicBlock::iterator BI = BB->begin();
2500 PHINode *PN = dyn_cast<PHINode>(BI); ++BI) {
Haicheng Wu476adcc2017-07-14 19:16:47 +00002501 // 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 Weberb38d3412016-10-24 14:52:04 +00002504 continue;
Pablo Barrio4f80c932016-11-15 15:42:23 +00002505
Haicheng Wu476adcc2017-07-14 19:16:47 +00002506 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 Barrio4f80c932016-11-15 15:42:23 +00002509 return false;
Haicheng Wu476adcc2017-07-14 19:16:47 +00002510 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 Wua6a32792016-01-08 19:39:39 +00002533 }
2534
Haicheng Wu476adcc2017-07-14 19:16:47 +00002535 if (!SI)
2536 continue;
2537 // Expand the select.
2538 TerminatorInst *Term =
Daniel Jasper0a51ec22017-09-30 11:57:19 +00002539 SplitBlockAndInsertIfThen(SI->getCondition(), SI, false);
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00002540 BasicBlock *SplitBB = SI->getParent();
2541 BasicBlock *NewBB = Term->getParent();
Haicheng Wu476adcc2017-07-14 19:16:47 +00002542 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. Rzycki9b7ae232018-01-12 21:06:48 +00002547 // 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 Wu476adcc2017-07-14 19:16:47 +00002559 return true;
Haicheng Wua6a32792016-01-08 19:39:39 +00002560 }
Pablo Barrio4f80c932016-11-15 15:42:23 +00002561 return false;
Haicheng Wua6a32792016-01-08 19:39:39 +00002562}
Sanjoy Das8b859c22017-02-17 04:21:14 +00002563
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.
2583bool JumpThreadingPass::ProcessGuards(BasicBlock *BB) {
2584 using namespace PatternMatch;
Eugene Zelenko8002c502017-09-13 21:43:53 +00002585
Sanjoy Das8b859c22017-02-17 04:21:14 +00002586 // 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.
2618bool 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 Rosierdfd1de62017-08-01 20:18:54 +00002637 Impl = isImpliedCondition(BranchCond, GuardCond, DL, /* LHSIsTrue */ false);
Sanjoy Das8b859c22017-02-17 04:21:14 +00002638 if (Impl && *Impl)
2639 FalseDestIsSafe = true;
2640 }
2641
2642 if (!TrueDestIsSafe && !FalseDestIsSafe)
2643 return false;
2644
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00002645 BasicBlock *PredUnguardedBlock = TrueDestIsSafe ? TrueDest : FalseDest;
2646 BasicBlock *PredGuardedBlock = FalseDestIsSafe ? TrueDest : FalseDest;
Sanjoy Das8b859c22017-02-17 04:21:14 +00002647
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. Rzycki9b7ae232018-01-12 21:06:48 +00002655 BasicBlock *GuardedBlock = DuplicateInstructionsInSplitBetween(
2656 BB, PredGuardedBlock, AfterGuard, GuardedMapping);
Sanjoy Das8b859c22017-02-17 04:21:14 +00002657 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. Rzycki9b7ae232018-01-12 21:06:48 +00002661 BasicBlock *UnguardedBlock = DuplicateInstructionsInSplitBetween(
2662 BB, PredUnguardedBlock, Guard, UnguardedMapping);
Sanjoy Das8b859c22017-02-17 04:21:14 +00002663 assert(UnguardedBlock && "Could not create the unguarded block?");
Nicola Zaghend34e60c2018-05-14 12:53:11 +00002664 LLVM_DEBUG(dbgs() << "Moved guard " << *Guard << " to block "
2665 << GuardedBlock->getName() << "\n");
Brian M. Rzycki9b7ae232018-01-12 21:06:48 +00002666 // 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 Das8b859c22017-02-17 04:21:14 +00002678 // 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}