blob: 805f4cdcfcc6f421aa002087421e55911c61e59e [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
Chris Lattnerb3b60072008-04-20 20:35:01 +000014#include "llvm/Transforms/Scalar.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000015#include "llvm/ADT/DenseMap.h"
16#include "llvm/ADT/DenseSet.h"
17#include "llvm/ADT/STLExtras.h"
18#include "llvm/ADT/SmallPtrSet.h"
19#include "llvm/ADT/SmallSet.h"
20#include "llvm/ADT/Statistic.h"
James Molloyefbba722015-09-10 10:22:12 +000021#include "llvm/Analysis/GlobalsModRef.h"
Nick Lewycky0b682452013-07-27 01:24:00 +000022#include "llvm/Analysis/CFG.h"
Manman Ren72d44b12015-10-15 14:59:40 +000023#include "llvm/Analysis/BlockFrequencyInfo.h"
24#include "llvm/Analysis/BlockFrequencyInfoImpl.h"
25#include "llvm/Analysis/BranchProbabilityInfo.h"
Owen Anderson92651ec2011-04-14 21:35:50 +000026#include "llvm/Analysis/ConstantFolding.h"
Chris Lattner800aad32009-11-09 23:00:14 +000027#include "llvm/Analysis/InstructionSimplify.h"
Chris Lattnerfde1f8d2009-11-11 02:08:33 +000028#include "llvm/Analysis/LazyValueInfo.h"
Dan Gohman826bdf82010-05-28 16:19:17 +000029#include "llvm/Analysis/Loads.h"
Manman Ren72d44b12015-10-15 14:59:40 +000030#include "llvm/Analysis/LoopInfo.h"
Benjamin Kramer799003b2015-03-23 19:32:43 +000031#include "llvm/Analysis/TargetLibraryInfo.h"
Chandler Carruth9fb823b2013-01-02 11:36:10 +000032#include "llvm/IR/DataLayout.h"
33#include "llvm/IR/IntrinsicInst.h"
34#include "llvm/IR/LLVMContext.h"
Manman Ren72d44b12015-10-15 14:59:40 +000035#include "llvm/IR/MDBuilder.h"
Hal Finkelcc39b672014-07-24 12:16:19 +000036#include "llvm/IR/Metadata.h"
Chandler Carruth4220e9c2014-03-04 11:17:44 +000037#include "llvm/IR/ValueHandle.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000038#include "llvm/Pass.h"
Chris Lattnerb3b60072008-04-20 20:35:01 +000039#include "llvm/Support/CommandLine.h"
Chris Lattner21157222008-04-20 21:13:06 +000040#include "llvm/Support/Debug.h"
Daniel Dunbar9813b0b2009-07-26 07:49:05 +000041#include "llvm/Support/raw_ostream.h"
Chandler Carruthed0881b2012-12-03 16:50:05 +000042#include "llvm/Transforms/Utils/BasicBlockUtils.h"
43#include "llvm/Transforms/Utils/Local.h"
44#include "llvm/Transforms/Utils/SSAUpdater.h"
Manman Ren72d44b12015-10-15 14:59:40 +000045#include <algorithm>
46#include <memory>
Chris Lattnerb3b60072008-04-20 20:35:01 +000047using namespace llvm;
48
Chandler Carruth964daaa2014-04-22 02:55:47 +000049#define DEBUG_TYPE "jump-threading"
50
Chris Lattnerff1c6e32008-04-20 22:39:42 +000051STATISTIC(NumThreads, "Number of jumps threaded");
52STATISTIC(NumFolds, "Number of terminators folded");
Chris Lattner97b14052009-10-11 07:24:57 +000053STATISTIC(NumDupes, "Number of branch blocks duplicated to eliminate phi");
Chris Lattnerb3b60072008-04-20 20:35:01 +000054
Chris Lattner21157222008-04-20 21:13:06 +000055static cl::opt<unsigned>
Michael Liaod1209162014-09-24 04:59:06 +000056BBDuplicateThreshold("jump-threading-threshold",
Chris Lattner21157222008-04-20 21:13:06 +000057 cl::desc("Max block size to duplicate for jump threading"),
58 cl::init(6), cl::Hidden);
59
Chris Lattnerb3b60072008-04-20 20:35:01 +000060namespace {
Frits van Bommel76244862010-12-05 19:06:41 +000061 // These are at global scope so static functions can use them too.
62 typedef SmallVectorImpl<std::pair<Constant*, BasicBlock*> > PredValueInfo;
63 typedef SmallVector<std::pair<Constant*, BasicBlock*>, 8> PredValueInfoTy;
64
Frits van Bommeld9df6ea2010-12-06 23:36:56 +000065 // This is used to keep track of what kind of constant we're currently hoping
66 // to find.
67 enum ConstantPreference {
68 WantInteger,
69 WantBlockAddress
70 };
71
Chris Lattnere7f0afe2008-05-09 04:43:13 +000072 /// This pass performs 'jump threading', which looks at blocks that have
73 /// multiple predecessors and multiple successors. If one or more of the
74 /// predecessors of the block can be proven to always jump to one of the
75 /// successors, we forward the edge from the predecessor to the successor by
76 /// duplicating the contents of this block.
77 ///
78 /// An example of when this can occur is code like this:
79 ///
80 /// if () { ...
81 /// X = 4;
82 /// }
83 /// if (X < 3) {
84 ///
85 /// In this case, the unconditional branch at the end of the first if can be
86 /// revectored to the false side of the second if.
87 ///
Chris Lattner2dd09db2009-09-02 06:11:42 +000088 class JumpThreading : public FunctionPass {
Chad Rosier43a33062011-12-02 01:26:24 +000089 TargetLibraryInfo *TLI;
Chris Lattnerfde1f8d2009-11-11 02:08:33 +000090 LazyValueInfo *LVI;
Manman Ren72d44b12015-10-15 14:59:40 +000091 std::unique_ptr<BlockFrequencyInfo> BFI;
92 std::unique_ptr<BranchProbabilityInfo> BPI;
93 bool HasProfileData;
Chris Lattnerd579cb12009-05-04 02:28:08 +000094#ifdef NDEBUG
95 SmallPtrSet<BasicBlock*, 16> LoopHeaders;
96#else
97 SmallSet<AssertingVH<BasicBlock>, 16> LoopHeaders;
98#endif
Owen Anderson3997a072010-08-31 07:36:34 +000099 DenseSet<std::pair<Value*, BasicBlock*> > RecursionSet;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000100
Michael Liaod1209162014-09-24 04:59:06 +0000101 unsigned BBDupThreshold;
102
Owen Anderson6fdcb1722010-08-31 19:24:27 +0000103 // RAII helper for updating the recursion stack.
104 struct RecursionSetRemover {
105 DenseSet<std::pair<Value*, BasicBlock*> > &TheSet;
106 std::pair<Value*, BasicBlock*> ThePair;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000107
Owen Anderson6fdcb1722010-08-31 19:24:27 +0000108 RecursionSetRemover(DenseSet<std::pair<Value*, BasicBlock*> > &S,
109 std::pair<Value*, BasicBlock*> P)
110 : TheSet(S), ThePair(P) { }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000111
Owen Anderson6fdcb1722010-08-31 19:24:27 +0000112 ~RecursionSetRemover() {
113 TheSet.erase(ThePair);
114 }
115 };
Chris Lattnerb3b60072008-04-20 20:35:01 +0000116 public:
117 static char ID; // Pass identification
Michael Liaod1209162014-09-24 04:59:06 +0000118 JumpThreading(int T = -1) : FunctionPass(ID) {
119 BBDupThreshold = (T == -1) ? BBDuplicateThreshold : unsigned(T);
Owen Anderson6c18d1a2010-10-19 17:21:58 +0000120 initializeJumpThreadingPass(*PassRegistry::getPassRegistry());
121 }
Chris Lattnerb3b60072008-04-20 20:35:01 +0000122
Craig Topper3e4c6972014-03-05 09:10:37 +0000123 bool runOnFunction(Function &F) override;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000124
Craig Topper3e4c6972014-03-05 09:10:37 +0000125 void getAnalysisUsage(AnalysisUsage &AU) const override {
Owen Andersond361aac2010-09-14 20:57:41 +0000126 AU.addRequired<LazyValueInfo>();
127 AU.addPreserved<LazyValueInfo>();
James Molloyefbba722015-09-10 10:22:12 +0000128 AU.addPreserved<GlobalsAAWrapperPass>();
Chandler Carruthb98f63d2015-01-15 10:41:28 +0000129 AU.addRequired<TargetLibraryInfoWrapperPass>();
Chris Lattnerfde1f8d2009-11-11 02:08:33 +0000130 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000131
Manman Ren72d44b12015-10-15 14:59:40 +0000132 void releaseMemory() override {
133 BFI.reset();
134 BPI.reset();
135 }
136
Chris Lattnerfde1f8d2009-11-11 02:08:33 +0000137 void FindLoopHeaders(Function &F);
Chris Lattner240051a2008-11-27 07:20:04 +0000138 bool ProcessBlock(BasicBlock *BB);
Chris Lattner5ff7f562009-11-07 08:05:03 +0000139 bool ThreadEdge(BasicBlock *BB, const SmallVectorImpl<BasicBlock*> &PredBBs,
140 BasicBlock *SuccBB);
Chris Lattner97b14052009-10-11 07:24:57 +0000141 bool DuplicateCondBranchOnPHIIntoPred(BasicBlock *BB,
Chris Lattnereb73bdb2010-01-12 02:07:17 +0000142 const SmallVectorImpl<BasicBlock *> &PredBBs);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000143
Chris Lattner5ff7f562009-11-07 08:05:03 +0000144 bool ComputeValueKnownInPredecessors(Value *V, BasicBlock *BB,
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000145 PredValueInfo &Result,
Hal Finkel7e184492014-09-07 20:29:59 +0000146 ConstantPreference Preference,
147 Instruction *CxtI = nullptr);
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000148 bool ProcessThreadableEdges(Value *Cond, BasicBlock *BB,
Hal Finkel7e184492014-09-07 20:29:59 +0000149 ConstantPreference Preference,
150 Instruction *CxtI = nullptr);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000151
Chris Lattner6a19ed02010-01-11 23:41:09 +0000152 bool ProcessBranchOnPHI(PHINode *PN);
Chris Lattnereb73bdb2010-01-12 02:07:17 +0000153 bool ProcessBranchOnXOR(BinaryOperator *BO);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000154
Chris Lattner98d89d12008-11-27 05:07:53 +0000155 bool SimplifyPartiallyRedundantLoad(LoadInst *LI);
Benjamin Kramer6a4976d2013-08-07 10:29:38 +0000156 bool TryToUnfoldSelect(CmpInst *CondCmp, BasicBlock *BB);
Manman Ren72d44b12015-10-15 14:59:40 +0000157
158 private:
159 BasicBlock *SplitBlockPreds(BasicBlock *BB, ArrayRef<BasicBlock *> Preds,
160 const char *Suffix);
161 void UpdateBlockFreqAndEdgeWeight(BasicBlock *PredBB, BasicBlock *BB,
162 BasicBlock *NewBB, BasicBlock *SuccBB);
Chris Lattnerb3b60072008-04-20 20:35:01 +0000163 };
Alexander Kornienkof00654e2015-06-23 09:49:53 +0000164}
Chris Lattnerb3b60072008-04-20 20:35:01 +0000165
Dan Gohmand78c4002008-05-13 00:00:25 +0000166char JumpThreading::ID = 0;
Owen Anderson8ac477f2010-10-12 19:48:12 +0000167INITIALIZE_PASS_BEGIN(JumpThreading, "jump-threading",
168 "Jump Threading", false, false)
169INITIALIZE_PASS_DEPENDENCY(LazyValueInfo)
Chandler Carruthb98f63d2015-01-15 10:41:28 +0000170INITIALIZE_PASS_DEPENDENCY(TargetLibraryInfoWrapperPass)
Owen Anderson8ac477f2010-10-12 19:48:12 +0000171INITIALIZE_PASS_END(JumpThreading, "jump-threading",
Owen Andersondf7a4f22010-10-07 22:25:06 +0000172 "Jump Threading", false, false)
Dan Gohmand78c4002008-05-13 00:00:25 +0000173
Chris Lattnerb3b60072008-04-20 20:35:01 +0000174// Public interface to the Jump Threading pass
Michael Liaod1209162014-09-24 04:59:06 +0000175FunctionPass *llvm::createJumpThreadingPass(int Threshold) { return new JumpThreading(Threshold); }
Chris Lattnerb3b60072008-04-20 20:35:01 +0000176
177/// runOnFunction - Top level algorithm.
178///
179bool JumpThreading::runOnFunction(Function &F) {
Paul Robinsonaf4e64d2014-02-06 00:07:05 +0000180 if (skipOptnoneFunction(F))
181 return false;
182
David Greene1efdb452010-01-05 01:27:19 +0000183 DEBUG(dbgs() << "Jump threading on function '" << F.getName() << "'\n");
Chandler Carruthb98f63d2015-01-15 10:41:28 +0000184 TLI = &getAnalysis<TargetLibraryInfoWrapperPass>().getTLI();
Owen Andersond361aac2010-09-14 20:57:41 +0000185 LVI = &getAnalysis<LazyValueInfo>();
Manman Ren72d44b12015-10-15 14:59:40 +0000186 BFI.reset();
187 BPI.reset();
188 // When profile data is available, we need to update edge weights after
189 // successful jump threading, which requires both BPI and BFI being available.
190 HasProfileData = F.getEntryCount().hasValue();
191 if (HasProfileData) {
192 LoopInfo LI{DominatorTree(F)};
193 BPI.reset(new BranchProbabilityInfo(F, LI));
194 BFI.reset(new BlockFrequencyInfo(F, *BPI, LI));
195 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000196
Dinesh Dwivedi8bb5fb02014-06-19 14:11:53 +0000197 // Remove unreachable blocks from function as they may result in infinite
198 // loop. We do threading if we found something profitable. Jump threading a
199 // branch can create other opportunities. If these opportunities form a cycle
David L Kreitzerda700ce2015-09-16 13:27:30 +0000200 // i.e. if any jump threading is undoing previous threading in the path, then
Dinesh Dwivedi8bb5fb02014-06-19 14:11:53 +0000201 // we will loop forever. We take care of this issue by not jump threading for
202 // back edges. This works for normal cases but not for unreachable blocks as
203 // they may have cycle with no back edge.
Dinesh Dwivedi657105e2014-06-17 14:34:19 +0000204 removeUnreachableBlocks(F);
205
Chris Lattnerd579cb12009-05-04 02:28:08 +0000206 FindLoopHeaders(F);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000207
Benjamin Kramer76e27662010-01-07 13:50:07 +0000208 bool Changed, EverChanged = false;
209 do {
210 Changed = false;
Chris Lattner595c7272008-12-03 07:48:08 +0000211 for (Function::iterator I = F.begin(), E = F.end(); I != E;) {
Duncan P. N. Exon Smith3a9c9e32015-10-13 18:26:00 +0000212 BasicBlock *BB = &*I;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000213 // Thread all of the branches we can over this block.
Chris Lattner595c7272008-12-03 07:48:08 +0000214 while (ProcessBlock(BB))
Chris Lattnerff1c6e32008-04-20 22:39:42 +0000215 Changed = true;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000216
Chris Lattner595c7272008-12-03 07:48:08 +0000217 ++I;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000218
Chris Lattner595c7272008-12-03 07:48:08 +0000219 // If the block is trivially dead, zap it. This eliminates the successor
220 // edges which simplifies the CFG.
Ramkumar Ramachandra40c3e032015-01-13 03:46:47 +0000221 if (pred_empty(BB) &&
Chris Lattnere5983702008-12-08 22:44:07 +0000222 BB != &BB->getParent()->getEntryBlock()) {
David Greene1efdb452010-01-05 01:27:19 +0000223 DEBUG(dbgs() << " JT: Deleting dead block '" << BB->getName()
Chris Lattner97b14052009-10-11 07:24:57 +0000224 << "' with terminator: " << *BB->getTerminator() << '\n');
Chris Lattnerd579cb12009-05-04 02:28:08 +0000225 LoopHeaders.erase(BB);
Owen Andersond361aac2010-09-14 20:57:41 +0000226 LVI->eraseBlock(BB);
Chris Lattnerfa552d72009-05-04 16:29:24 +0000227 DeleteDeadBlock(BB);
Chris Lattner595c7272008-12-03 07:48:08 +0000228 Changed = true;
Chris Lattner73a58622010-12-13 02:38:13 +0000229 continue;
230 }
Owen Anderson92651ec2011-04-14 21:35:50 +0000231
Chris Lattner73a58622010-12-13 02:38:13 +0000232 BranchInst *BI = dyn_cast<BranchInst>(BB->getTerminator());
Owen Anderson92651ec2011-04-14 21:35:50 +0000233
Chris Lattner73a58622010-12-13 02:38:13 +0000234 // Can't thread an unconditional jump, but if the block is "almost
235 // empty", we can replace uses of it with uses of the successor and make
236 // this dead.
237 if (BI && BI->isUnconditional() &&
238 BB != &BB->getParent()->getEntryBlock() &&
Chris Lattner80e7e5a2009-11-10 21:40:01 +0000239 // If the terminator is the only non-phi instruction, try to nuke it.
Chris Lattner73a58622010-12-13 02:38:13 +0000240 BB->getFirstNonPHIOrDbg()->isTerminator()) {
241 // Since TryToSimplifyUncondBranchFromEmptyBlock may delete the
242 // block, we have to make sure it isn't in the LoopHeaders set. We
243 // reinsert afterward if needed.
244 bool ErasedFromLoopHeaders = LoopHeaders.erase(BB);
245 BasicBlock *Succ = BI->getSuccessor(0);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000246
Chris Lattner73a58622010-12-13 02:38:13 +0000247 // FIXME: It is always conservatively correct to drop the info
248 // for a block even if it doesn't get erased. This isn't totally
249 // awesome, but it allows us to use AssertingVH to prevent nasty
250 // dangling pointer issues within LazyValueInfo.
251 LVI->eraseBlock(BB);
252 if (TryToSimplifyUncondBranchFromEmptyBlock(BB)) {
253 Changed = true;
254 // If we deleted BB and BB was the header of a loop, then the
255 // successor is now the header of the loop.
256 BB = Succ;
Chris Lattner80e7e5a2009-11-10 21:40:01 +0000257 }
Chris Lattner73a58622010-12-13 02:38:13 +0000258
259 if (ErasedFromLoopHeaders)
260 LoopHeaders.insert(BB);
Chris Lattner595c7272008-12-03 07:48:08 +0000261 }
262 }
Chris Lattnerff1c6e32008-04-20 22:39:42 +0000263 EverChanged |= Changed;
Benjamin Kramer76e27662010-01-07 13:50:07 +0000264 } while (Changed);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000265
Chris Lattnerd579cb12009-05-04 02:28:08 +0000266 LoopHeaders.clear();
Chris Lattnerff1c6e32008-04-20 22:39:42 +0000267 return EverChanged;
Chris Lattnerb3b60072008-04-20 20:35:01 +0000268}
Chris Lattner21157222008-04-20 21:13:06 +0000269
Chris Lattner97b14052009-10-11 07:24:57 +0000270/// getJumpThreadDuplicationCost - Return the cost of duplicating this block to
Nadav Rotem23495312012-12-03 17:34:44 +0000271/// thread across it. Stop scanning the block when passing the threshold.
272static unsigned getJumpThreadDuplicationCost(const BasicBlock *BB,
273 unsigned Threshold) {
Chris Lattner97b14052009-10-11 07:24:57 +0000274 /// Ignore PHI nodes, these will be flattened when duplication happens.
Duncan P. N. Exon Smith3a9c9e32015-10-13 18:26:00 +0000275 BasicBlock::const_iterator I(BB->getFirstNonPHI());
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000276
Chris Lattner3a2ae902009-11-11 00:21:58 +0000277 // FIXME: THREADING will delete values that are just used to compute the
278 // branch, so they shouldn't count against the duplication cost.
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000279
Chris Lattner97b14052009-10-11 07:24:57 +0000280 // Sum up the cost of each instruction until we get to the terminator. Don't
281 // include the terminator because the copy won't include it.
282 unsigned Size = 0;
283 for (; !isa<TerminatorInst>(I); ++I) {
Nadav Rotem23495312012-12-03 17:34:44 +0000284
285 // Stop scanning the block if we've reached the threshold.
286 if (Size > Threshold)
287 return Size;
288
Chris Lattner97b14052009-10-11 07:24:57 +0000289 // Debugger intrinsics don't incur code size.
290 if (isa<DbgInfoIntrinsic>(I)) continue;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000291
Chris Lattner97b14052009-10-11 07:24:57 +0000292 // If this is a pointer->pointer bitcast, it is free.
Duncan Sands19d0b472010-02-16 11:11:14 +0000293 if (isa<BitCastInst>(I) && I->getType()->isPointerTy())
Chris Lattner97b14052009-10-11 07:24:57 +0000294 continue;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000295
David Majnemerb611e3f2015-08-14 05:09:07 +0000296 // Bail out if this instruction gives back a token type, it is not possible
David L Kreitzerda700ce2015-09-16 13:27:30 +0000297 // to duplicate it if it is used outside this BB.
David Majnemerb611e3f2015-08-14 05:09:07 +0000298 if (I->getType()->isTokenTy() && I->isUsedOutsideOfBlock(BB))
299 return ~0U;
300
Chris Lattner97b14052009-10-11 07:24:57 +0000301 // All other instructions count for at least one unit.
302 ++Size;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000303
Chris Lattner97b14052009-10-11 07:24:57 +0000304 // Calls are more expensive. If they are non-intrinsic calls, we model them
305 // as having cost of 4. If they are a non-vector intrinsic, we model them
306 // as having cost of 2 total, and if they are a vector intrinsic, we model
307 // them as having cost 1.
308 if (const CallInst *CI = dyn_cast<CallInst>(I)) {
Jingyue Wue84f6712015-08-31 06:10:27 +0000309 if (CI->cannotDuplicate() || CI->isConvergent())
James Molloy4f6fb952012-12-20 16:04:27 +0000310 // Blocks with NoDuplicate are modelled as having infinite cost, so they
311 // are never duplicated.
312 return ~0U;
313 else if (!isa<IntrinsicInst>(CI))
Chris Lattner97b14052009-10-11 07:24:57 +0000314 Size += 3;
Duncan Sands19d0b472010-02-16 11:11:14 +0000315 else if (!CI->getType()->isVectorTy())
Chris Lattner97b14052009-10-11 07:24:57 +0000316 Size += 1;
317 }
318 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000319
Chris Lattner97b14052009-10-11 07:24:57 +0000320 // Threading through a switch statement is particularly profitable. If this
321 // block ends in a switch, decrease its cost to make it more likely to happen.
322 if (isa<SwitchInst>(I))
323 Size = Size > 6 ? Size-6 : 0;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000324
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000325 // The same holds for indirect branches, but slightly more so.
326 if (isa<IndirectBrInst>(I))
327 Size = Size > 8 ? Size-8 : 0;
328
Chris Lattner97b14052009-10-11 07:24:57 +0000329 return Size;
330}
331
Chris Lattnerfa552d72009-05-04 16:29:24 +0000332/// FindLoopHeaders - We do not want jump threading to turn proper loop
Chris Lattnerd579cb12009-05-04 02:28:08 +0000333/// structures into irreducible loops. Doing this breaks up the loop nesting
334/// hierarchy and pessimizes later transformations. To prevent this from
335/// happening, we first have to find the loop headers. Here we approximate this
336/// by finding targets of backedges in the CFG.
337///
338/// Note that there definitely are cases when we want to allow threading of
339/// edges across a loop header. For example, threading a jump from outside the
340/// loop (the preheader) to an exit block of the loop is definitely profitable.
341/// It is also almost always profitable to thread backedges from within the loop
342/// to exit blocks, and is often profitable to thread backedges to other blocks
343/// within the loop (forming a nested loop). This simple analysis is not rich
344/// enough to track all of these properties and keep it up-to-date as the CFG
345/// mutates, so we don't allow any of these transformations.
346///
347void JumpThreading::FindLoopHeaders(Function &F) {
348 SmallVector<std::pair<const BasicBlock*,const BasicBlock*>, 32> Edges;
349 FindFunctionBackedges(F, Edges);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000350
Chris Lattnerd579cb12009-05-04 02:28:08 +0000351 for (unsigned i = 0, e = Edges.size(); i != e; ++i)
352 LoopHeaders.insert(const_cast<BasicBlock*>(Edges[i].second));
353}
354
Frits van Bommel76244862010-12-05 19:06:41 +0000355/// getKnownConstant - Helper method to determine if we can thread over a
356/// terminator with the given value as its condition, and if so what value to
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000357/// use for that. What kind of value this is depends on whether we want an
358/// integer or a block address, but an undef is always accepted.
Frits van Bommel76244862010-12-05 19:06:41 +0000359/// Returns null if Val is null or not an appropriate constant.
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000360static Constant *getKnownConstant(Value *Val, ConstantPreference Preference) {
Frits van Bommel76244862010-12-05 19:06:41 +0000361 if (!Val)
Craig Topperf40110f2014-04-25 05:29:35 +0000362 return nullptr;
Frits van Bommel76244862010-12-05 19:06:41 +0000363
364 // Undef is "known" enough.
365 if (UndefValue *U = dyn_cast<UndefValue>(Val))
366 return U;
367
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000368 if (Preference == WantBlockAddress)
369 return dyn_cast<BlockAddress>(Val->stripPointerCasts());
370
Frits van Bommel76244862010-12-05 19:06:41 +0000371 return dyn_cast<ConstantInt>(Val);
372}
373
Chris Lattner5ff7f562009-11-07 08:05:03 +0000374/// ComputeValueKnownInPredecessors - Given a basic block BB and a value V, see
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000375/// if we can infer that the value is a known ConstantInt/BlockAddress or undef
376/// in any of our predecessors. If so, return the known list of value and pred
377/// BB in the result vector.
Chris Lattner5ff7f562009-11-07 08:05:03 +0000378///
Chris Lattner5ff7f562009-11-07 08:05:03 +0000379/// This returns true if there were any known values.
380///
Chris Lattner5ff7f562009-11-07 08:05:03 +0000381bool JumpThreading::
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000382ComputeValueKnownInPredecessors(Value *V, BasicBlock *BB, PredValueInfo &Result,
Hal Finkel7e184492014-09-07 20:29:59 +0000383 ConstantPreference Preference,
384 Instruction *CxtI) {
Owen Anderson6fdcb1722010-08-31 19:24:27 +0000385 // This method walks up use-def chains recursively. Because of this, we could
386 // get into an infinite loop going around loops in the use-def chain. To
387 // prevent this, keep track of what (value, block) pairs we've already visited
388 // and terminate the search if we loop back to them
Owen Anderson3997a072010-08-31 07:36:34 +0000389 if (!RecursionSet.insert(std::make_pair(V, BB)).second)
390 return false;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000391
Owen Anderson6fdcb1722010-08-31 19:24:27 +0000392 // An RAII help to remove this pair from the recursion set once the recursion
393 // stack pops back out again.
394 RecursionSetRemover remover(RecursionSet, std::make_pair(V, BB));
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000395
Frits van Bommel76244862010-12-05 19:06:41 +0000396 // If V is a constant, then it is known in all predecessors.
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000397 if (Constant *KC = getKnownConstant(V, Preference)) {
Duncan P. N. Exon Smith6c990152014-07-21 17:06:51 +0000398 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
399 Result.push_back(std::make_pair(KC, *PI));
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000400
Chris Lattner5ff7f562009-11-07 08:05:03 +0000401 return true;
402 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000403
Chris Lattner5ff7f562009-11-07 08:05:03 +0000404 // If V is a non-instruction value, or an instruction in a different block,
405 // then it can't be derived from a PHI.
406 Instruction *I = dyn_cast<Instruction>(V);
Craig Topperf40110f2014-04-25 05:29:35 +0000407 if (!I || I->getParent() != BB) {
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000408
Chris Lattnerfde1f8d2009-11-11 02:08:33 +0000409 // Okay, if this is a live-in value, see if it has a known value at the end
410 // of any of our predecessors.
411 //
412 // FIXME: This should be an edge property, not a block end property.
413 /// TODO: Per PR2563, we could infer value range information about a
414 /// predecessor based on its terminator.
415 //
Owen Andersond361aac2010-09-14 20:57:41 +0000416 // FIXME: change this to use the more-rich 'getPredicateOnEdge' method if
417 // "I" is a non-local compare-with-a-constant instruction. This would be
418 // able to handle value inequalities better, for example if the compare is
419 // "X < 4" and "X < 3" is known true but "X < 4" itself is not available.
420 // Perhaps getConstantOnEdge should be smart enough to do this?
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000421
Duncan P. N. Exon Smith6c990152014-07-21 17:06:51 +0000422 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
423 BasicBlock *P = *PI;
Owen Andersond361aac2010-09-14 20:57:41 +0000424 // If the value is known by LazyValueInfo to be a constant in a
425 // predecessor, use that information to try to thread this block.
Hal Finkel7e184492014-09-07 20:29:59 +0000426 Constant *PredCst = LVI->getConstantOnEdge(V, P, BB, CxtI);
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000427 if (Constant *KC = getKnownConstant(PredCst, Preference))
Frits van Bommel76244862010-12-05 19:06:41 +0000428 Result.push_back(std::make_pair(KC, P));
Owen Andersond361aac2010-09-14 20:57:41 +0000429 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000430
Owen Andersond361aac2010-09-14 20:57:41 +0000431 return !Result.empty();
Chris Lattnerfde1f8d2009-11-11 02:08:33 +0000432 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000433
Chris Lattner5ff7f562009-11-07 08:05:03 +0000434 /// If I is a PHI node, then we know the incoming values for any constants.
435 if (PHINode *PN = dyn_cast<PHINode>(I)) {
436 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
437 Value *InVal = PN->getIncomingValue(i);
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000438 if (Constant *KC = getKnownConstant(InVal, Preference)) {
Frits van Bommel76244862010-12-05 19:06:41 +0000439 Result.push_back(std::make_pair(KC, PN->getIncomingBlock(i)));
Owen Andersond361aac2010-09-14 20:57:41 +0000440 } else {
Owen Andersonbd2ecc72010-08-26 17:40:24 +0000441 Constant *CI = LVI->getConstantOnEdge(InVal,
Hal Finkel7e184492014-09-07 20:29:59 +0000442 PN->getIncomingBlock(i),
443 BB, CxtI);
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000444 if (Constant *KC = getKnownConstant(CI, Preference))
445 Result.push_back(std::make_pair(KC, PN->getIncomingBlock(i)));
Chris Lattner5ff7f562009-11-07 08:05:03 +0000446 }
447 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000448
Chris Lattner5ff7f562009-11-07 08:05:03 +0000449 return !Result.empty();
450 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000451
Frits van Bommel76244862010-12-05 19:06:41 +0000452 PredValueInfoTy LHSVals, RHSVals;
Chris Lattner5ff7f562009-11-07 08:05:03 +0000453
454 // Handle some boolean conditions.
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000455 if (I->getType()->getPrimitiveSizeInBits() == 1) {
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000456 assert(Preference == WantInteger && "One-bit non-integer type?");
Chris Lattner5ff7f562009-11-07 08:05:03 +0000457 // X | true -> true
458 // X & false -> false
459 if (I->getOpcode() == Instruction::Or ||
460 I->getOpcode() == Instruction::And) {
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000461 ComputeValueKnownInPredecessors(I->getOperand(0), BB, LHSVals,
Hal Finkel7e184492014-09-07 20:29:59 +0000462 WantInteger, CxtI);
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000463 ComputeValueKnownInPredecessors(I->getOperand(1), BB, RHSVals,
Hal Finkel7e184492014-09-07 20:29:59 +0000464 WantInteger, CxtI);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000465
Owen Anderson6fdcb1722010-08-31 19:24:27 +0000466 if (LHSVals.empty() && RHSVals.empty())
Chris Lattner5ff7f562009-11-07 08:05:03 +0000467 return false;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000468
Chris Lattner5ff7f562009-11-07 08:05:03 +0000469 ConstantInt *InterestingVal;
470 if (I->getOpcode() == Instruction::Or)
471 InterestingVal = ConstantInt::getTrue(I->getContext());
472 else
473 InterestingVal = ConstantInt::getFalse(I->getContext());
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000474
Chris Lattner3c603022010-08-18 03:14:36 +0000475 SmallPtrSet<BasicBlock*, 4> LHSKnownBBs;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000476
Chris Lattnerd924f632010-02-11 04:40:44 +0000477 // Scan for the sentinel. If we find an undef, force it to the
478 // interesting value: x|undef -> true and x&undef -> false.
Chris Lattner5ff7f562009-11-07 08:05:03 +0000479 for (unsigned i = 0, e = LHSVals.size(); i != e; ++i)
Frits van Bommel76244862010-12-05 19:06:41 +0000480 if (LHSVals[i].first == InterestingVal ||
481 isa<UndefValue>(LHSVals[i].first)) {
Chris Lattner5ff7f562009-11-07 08:05:03 +0000482 Result.push_back(LHSVals[i]);
Chris Lattnerd924f632010-02-11 04:40:44 +0000483 Result.back().first = InterestingVal;
Chris Lattner3c603022010-08-18 03:14:36 +0000484 LHSKnownBBs.insert(LHSVals[i].second);
Chris Lattnerd924f632010-02-11 04:40:44 +0000485 }
Chris Lattner5ff7f562009-11-07 08:05:03 +0000486 for (unsigned i = 0, e = RHSVals.size(); i != e; ++i)
Frits van Bommel76244862010-12-05 19:06:41 +0000487 if (RHSVals[i].first == InterestingVal ||
488 isa<UndefValue>(RHSVals[i].first)) {
Chris Lattnerbbc25ff2010-07-12 00:47:34 +0000489 // If we already inferred a value for this block on the LHS, don't
490 // re-add it.
Chris Lattner3c603022010-08-18 03:14:36 +0000491 if (!LHSKnownBBs.count(RHSVals[i].second)) {
Chris Lattnerbbc25ff2010-07-12 00:47:34 +0000492 Result.push_back(RHSVals[i]);
493 Result.back().first = InterestingVal;
494 }
Chris Lattnerd924f632010-02-11 04:40:44 +0000495 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000496
Chris Lattner5ff7f562009-11-07 08:05:03 +0000497 return !Result.empty();
498 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000499
Chris Lattner9518fbb2009-11-10 22:39:16 +0000500 // Handle the NOT form of XOR.
501 if (I->getOpcode() == Instruction::Xor &&
502 isa<ConstantInt>(I->getOperand(1)) &&
503 cast<ConstantInt>(I->getOperand(1))->isOne()) {
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000504 ComputeValueKnownInPredecessors(I->getOperand(0), BB, Result,
Hal Finkel7e184492014-09-07 20:29:59 +0000505 WantInteger, CxtI);
Owen Anderson6fdcb1722010-08-31 19:24:27 +0000506 if (Result.empty())
Chris Lattner9518fbb2009-11-10 22:39:16 +0000507 return false;
508
509 // Invert the known values.
510 for (unsigned i = 0, e = Result.size(); i != e; ++i)
Frits van Bommel76244862010-12-05 19:06:41 +0000511 Result[i].first = ConstantExpr::getNot(Result[i].first);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000512
Chris Lattner9518fbb2009-11-10 22:39:16 +0000513 return true;
514 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000515
Owen Andersonbd2ecc72010-08-26 17:40:24 +0000516 // Try to simplify some other binary operator values.
517 } else if (BinaryOperator *BO = dyn_cast<BinaryOperator>(I)) {
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000518 assert(Preference != WantBlockAddress
519 && "A binary operator creating a block address?");
Owen Anderson3c84ecb2010-08-31 20:26:04 +0000520 if (ConstantInt *CI = dyn_cast<ConstantInt>(BO->getOperand(1))) {
Frits van Bommel76244862010-12-05 19:06:41 +0000521 PredValueInfoTy LHSVals;
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000522 ComputeValueKnownInPredecessors(BO->getOperand(0), BB, LHSVals,
Hal Finkel7e184492014-09-07 20:29:59 +0000523 WantInteger, CxtI);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000524
Owen Anderson3997a072010-08-31 07:36:34 +0000525 // Try to use constant folding to simplify the binary operator.
526 for (unsigned i = 0, e = LHSVals.size(); i != e; ++i) {
Chris Lattner05ef3612010-09-05 20:03:09 +0000527 Constant *V = LHSVals[i].first;
Owen Anderson3c84ecb2010-08-31 20:26:04 +0000528 Constant *Folded = ConstantExpr::get(BO->getOpcode(), V, CI);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000529
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000530 if (Constant *KC = getKnownConstant(Folded, WantInteger))
531 Result.push_back(std::make_pair(KC, LHSVals[i].second));
Owen Anderson3997a072010-08-31 07:36:34 +0000532 }
Owen Andersonbd2ecc72010-08-26 17:40:24 +0000533 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000534
Owen Anderson3997a072010-08-31 07:36:34 +0000535 return !Result.empty();
Chris Lattner5ff7f562009-11-07 08:05:03 +0000536 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000537
Chris Lattner5ff7f562009-11-07 08:05:03 +0000538 // Handle compare with phi operand, where the PHI is defined in this block.
539 if (CmpInst *Cmp = dyn_cast<CmpInst>(I)) {
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000540 assert(Preference == WantInteger && "Compares only produce integers");
Chris Lattner5ff7f562009-11-07 08:05:03 +0000541 PHINode *PN = dyn_cast<PHINode>(Cmp->getOperand(0));
542 if (PN && PN->getParent() == BB) {
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000543 const DataLayout &DL = PN->getModule()->getDataLayout();
Chris Lattner5ff7f562009-11-07 08:05:03 +0000544 // We can do this simplification if any comparisons fold to true or false.
545 // See if any do.
546 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
547 BasicBlock *PredBB = PN->getIncomingBlock(i);
548 Value *LHS = PN->getIncomingValue(i);
549 Value *RHS = Cmp->getOperand(1)->DoPHITranslation(BB, PredBB);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000550
Rafael Espindola37dc9e12014-02-21 00:06:31 +0000551 Value *Res = SimplifyCmpInst(Cmp->getPredicate(), LHS, RHS, DL);
Craig Topperf40110f2014-04-25 05:29:35 +0000552 if (!Res) {
Owen Andersond361aac2010-09-14 20:57:41 +0000553 if (!isa<Constant>(RHS))
Chris Lattner5f6b8b22009-11-12 05:24:05 +0000554 continue;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000555
556 LazyValueInfo::Tristate
Chris Lattner5f6b8b22009-11-12 05:24:05 +0000557 ResT = LVI->getPredicateOnEdge(Cmp->getPredicate(), LHS,
Hal Finkel7e184492014-09-07 20:29:59 +0000558 cast<Constant>(RHS), PredBB, BB,
559 CxtI ? CxtI : Cmp);
Chris Lattner5f6b8b22009-11-12 05:24:05 +0000560 if (ResT == LazyValueInfo::Unknown)
561 continue;
562 Res = ConstantInt::get(Type::getInt1Ty(LHS->getContext()), ResT);
563 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000564
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000565 if (Constant *KC = getKnownConstant(Res, WantInteger))
566 Result.push_back(std::make_pair(KC, PredBB));
Chris Lattner5ff7f562009-11-07 08:05:03 +0000567 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000568
Chris Lattner5ff7f562009-11-07 08:05:03 +0000569 return !Result.empty();
570 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000571
Chris Lattner67146692009-11-11 22:31:38 +0000572 // If comparing a live-in value against a constant, see if we know the
573 // live-in value on any predecessors.
Owen Andersond361aac2010-09-14 20:57:41 +0000574 if (isa<Constant>(Cmp->getOperand(1)) && Cmp->getType()->isIntegerTy()) {
Owen Andersonbd2ecc72010-08-26 17:40:24 +0000575 if (!isa<Instruction>(Cmp->getOperand(0)) ||
Owen Andersonc910acb2010-08-30 23:22:36 +0000576 cast<Instruction>(Cmp->getOperand(0))->getParent() != BB) {
Owen Andersonbd2ecc72010-08-26 17:40:24 +0000577 Constant *RHSCst = cast<Constant>(Cmp->getOperand(1));
Gabor Greifa5fa8852010-07-12 14:10:24 +0000578
Duncan P. N. Exon Smith6c990152014-07-21 17:06:51 +0000579 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB);PI != E; ++PI){
580 BasicBlock *P = *PI;
Owen Andersonbd2ecc72010-08-26 17:40:24 +0000581 // If the value is known by LazyValueInfo to be a constant in a
582 // predecessor, use that information to try to thread this block.
583 LazyValueInfo::Tristate Res =
584 LVI->getPredicateOnEdge(Cmp->getPredicate(), Cmp->getOperand(0),
Hal Finkel7e184492014-09-07 20:29:59 +0000585 RHSCst, P, BB, CxtI ? CxtI : Cmp);
Owen Andersonbd2ecc72010-08-26 17:40:24 +0000586 if (Res == LazyValueInfo::Unknown)
587 continue;
Chris Lattnerc893c4ed2009-11-12 04:37:50 +0000588
Owen Andersonbd2ecc72010-08-26 17:40:24 +0000589 Constant *ResC = ConstantInt::get(Cmp->getType(), Res);
Frits van Bommel76244862010-12-05 19:06:41 +0000590 Result.push_back(std::make_pair(ResC, P));
Owen Andersonbd2ecc72010-08-26 17:40:24 +0000591 }
592
593 return !Result.empty();
Chris Lattner67146692009-11-11 22:31:38 +0000594 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000595
Owen Anderson3997a072010-08-31 07:36:34 +0000596 // Try to find a constant value for the LHS of a comparison,
Owen Andersonbd2ecc72010-08-26 17:40:24 +0000597 // and evaluate it statically if we can.
Owen Andersonc910acb2010-08-30 23:22:36 +0000598 if (Constant *CmpConst = dyn_cast<Constant>(Cmp->getOperand(1))) {
Frits van Bommel76244862010-12-05 19:06:41 +0000599 PredValueInfoTy LHSVals;
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000600 ComputeValueKnownInPredecessors(I->getOperand(0), BB, LHSVals,
Hal Finkel7e184492014-09-07 20:29:59 +0000601 WantInteger, CxtI);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000602
Owen Andersonbd2ecc72010-08-26 17:40:24 +0000603 for (unsigned i = 0, e = LHSVals.size(); i != e; ++i) {
Chris Lattner05ef3612010-09-05 20:03:09 +0000604 Constant *V = LHSVals[i].first;
Owen Anderson3c84ecb2010-08-31 20:26:04 +0000605 Constant *Folded = ConstantExpr::getCompare(Cmp->getPredicate(),
606 V, CmpConst);
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000607 if (Constant *KC = getKnownConstant(Folded, WantInteger))
608 Result.push_back(std::make_pair(KC, LHSVals[i].second));
Owen Andersonbd2ecc72010-08-26 17:40:24 +0000609 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000610
Owen Andersonbd2ecc72010-08-26 17:40:24 +0000611 return !Result.empty();
612 }
Chris Lattner67146692009-11-11 22:31:38 +0000613 }
Chris Lattner5ff7f562009-11-07 08:05:03 +0000614 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000615
Frits van Bommel3d180342010-12-15 09:51:20 +0000616 if (SelectInst *SI = dyn_cast<SelectInst>(I)) {
617 // Handle select instructions where at least one operand is a known constant
618 // and we can figure out the condition value for any predecessor block.
619 Constant *TrueVal = getKnownConstant(SI->getTrueValue(), Preference);
620 Constant *FalseVal = getKnownConstant(SI->getFalseValue(), Preference);
621 PredValueInfoTy Conds;
622 if ((TrueVal || FalseVal) &&
623 ComputeValueKnownInPredecessors(SI->getCondition(), BB, Conds,
Hal Finkel7e184492014-09-07 20:29:59 +0000624 WantInteger, CxtI)) {
Frits van Bommel3d180342010-12-15 09:51:20 +0000625 for (unsigned i = 0, e = Conds.size(); i != e; ++i) {
626 Constant *Cond = Conds[i].first;
627
628 // Figure out what value to use for the condition.
629 bool KnownCond;
630 if (ConstantInt *CI = dyn_cast<ConstantInt>(Cond)) {
631 // A known boolean.
632 KnownCond = CI->isOne();
633 } else {
634 assert(isa<UndefValue>(Cond) && "Unexpected condition value");
635 // Either operand will do, so be sure to pick the one that's a known
636 // constant.
637 // FIXME: Do this more cleverly if both values are known constants?
Craig Topperf40110f2014-04-25 05:29:35 +0000638 KnownCond = (TrueVal != nullptr);
Frits van Bommel3d180342010-12-15 09:51:20 +0000639 }
640
641 // See if the select has a known constant value for this predecessor.
642 if (Constant *Val = KnownCond ? TrueVal : FalseVal)
643 Result.push_back(std::make_pair(Val, Conds[i].second));
644 }
645
646 return !Result.empty();
647 }
648 }
649
Owen Andersond361aac2010-09-14 20:57:41 +0000650 // If all else fails, see if LVI can figure out a constant value for us.
Hal Finkel7e184492014-09-07 20:29:59 +0000651 Constant *CI = LVI->getConstant(V, BB, CxtI);
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000652 if (Constant *KC = getKnownConstant(CI, Preference)) {
Duncan P. N. Exon Smith6c990152014-07-21 17:06:51 +0000653 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
654 Result.push_back(std::make_pair(KC, *PI));
Owen Andersonbd2ecc72010-08-26 17:40:24 +0000655 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000656
Owen Andersond361aac2010-09-14 20:57:41 +0000657 return !Result.empty();
Chris Lattner5ff7f562009-11-07 08:05:03 +0000658}
659
660
Chris Lattner3df4c152008-04-22 07:05:46 +0000661
Chris Lattnerf99a74e2009-10-11 04:18:15 +0000662/// GetBestDestForBranchOnUndef - If we determine that the specified block ends
663/// in an undefined jump, decide which block is best to revector to.
664///
665/// Since we can pick an arbitrary destination, we pick the successor with the
666/// fewest predecessors. This should reduce the in-degree of the others.
667///
668static unsigned GetBestDestForJumpOnUndef(BasicBlock *BB) {
669 TerminatorInst *BBTerm = BB->getTerminator();
670 unsigned MinSucc = 0;
671 BasicBlock *TestBB = BBTerm->getSuccessor(MinSucc);
672 // Compute the successor with the minimum number of predecessors.
673 unsigned MinNumPreds = std::distance(pred_begin(TestBB), pred_end(TestBB));
674 for (unsigned i = 1, e = BBTerm->getNumSuccessors(); i != e; ++i) {
675 TestBB = BBTerm->getSuccessor(i);
676 unsigned NumPreds = std::distance(pred_begin(TestBB), pred_end(TestBB));
Jakub Staszak423651e2011-06-27 21:51:12 +0000677 if (NumPreds < MinNumPreds) {
Chris Lattnerf99a74e2009-10-11 04:18:15 +0000678 MinSucc = i;
Jakub Staszak423651e2011-06-27 21:51:12 +0000679 MinNumPreds = NumPreds;
680 }
Chris Lattnerf99a74e2009-10-11 04:18:15 +0000681 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000682
Chris Lattnerf99a74e2009-10-11 04:18:15 +0000683 return MinSucc;
684}
685
Chris Lattner1a924e72011-02-18 04:43:06 +0000686static bool hasAddressTakenAndUsed(BasicBlock *BB) {
687 if (!BB->hasAddressTaken()) return false;
Owen Anderson92651ec2011-04-14 21:35:50 +0000688
Chris Lattner1a924e72011-02-18 04:43:06 +0000689 // If the block has its address taken, it may be a tree of dead constants
690 // hanging off of it. These shouldn't keep the block alive.
691 BlockAddress *BA = BlockAddress::get(BB);
692 BA->removeDeadConstantUsers();
693 return !BA->use_empty();
694}
695
Chris Lattner240051a2008-11-27 07:20:04 +0000696/// ProcessBlock - If there are any predecessors whose control can be threaded
Chris Lattner21157222008-04-20 21:13:06 +0000697/// through to a successor, transform them now.
Chris Lattner240051a2008-11-27 07:20:04 +0000698bool JumpThreading::ProcessBlock(BasicBlock *BB) {
Chris Lattnerde5ab4862010-01-23 18:56:07 +0000699 // If the block is trivially dead, just return and let the caller nuke it.
700 // This simplifies other transformations.
Ramkumar Ramachandra40c3e032015-01-13 03:46:47 +0000701 if (pred_empty(BB) &&
Chris Lattnerde5ab4862010-01-23 18:56:07 +0000702 BB != &BB->getParent()->getEntryBlock())
703 return false;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000704
Chris Lattner98d89d12008-11-27 05:07:53 +0000705 // If this block has a single predecessor, and if that pred has a single
706 // successor, merge the blocks. This encourages recursive jump threading
707 // because now the condition in this block can be threaded through
708 // predecessors of our predecessor block.
Chris Lattner5ff7f562009-11-07 08:05:03 +0000709 if (BasicBlock *SinglePred = BB->getSinglePredecessor()) {
David Majnemer654e1302015-07-31 17:58:14 +0000710 const TerminatorInst *TI = SinglePred->getTerminator();
711 if (!TI->isExceptional() && TI->getNumSuccessors() == 1 &&
Chris Lattner1a924e72011-02-18 04:43:06 +0000712 SinglePred != BB && !hasAddressTakenAndUsed(BB)) {
Chris Lattnerd579cb12009-05-04 02:28:08 +0000713 // If SinglePred was a loop header, BB becomes one.
714 if (LoopHeaders.erase(SinglePred))
715 LoopHeaders.insert(BB);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000716
Owen Andersond361aac2010-09-14 20:57:41 +0000717 LVI->eraseBlock(SinglePred);
Chris Lattner98d89d12008-11-27 05:07:53 +0000718 MergeBasicBlockIntoOnlyPred(BB);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000719
Chris Lattner98d89d12008-11-27 05:07:53 +0000720 return true;
721 }
Chris Lattner5ff7f562009-11-07 08:05:03 +0000722 }
723
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000724 // What kind of constant we're looking for.
725 ConstantPreference Preference = WantInteger;
726
727 // Look to see if the terminator is a conditional branch, switch or indirect
728 // branch, if not we can't thread it.
Chris Lattner21157222008-04-20 21:13:06 +0000729 Value *Condition;
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000730 Instruction *Terminator = BB->getTerminator();
731 if (BranchInst *BI = dyn_cast<BranchInst>(Terminator)) {
Chris Lattnerff1c6e32008-04-20 22:39:42 +0000732 // Can't thread an unconditional jump.
733 if (BI->isUnconditional()) return false;
Chris Lattner21157222008-04-20 21:13:06 +0000734 Condition = BI->getCondition();
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000735 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(Terminator)) {
Chris Lattner21157222008-04-20 21:13:06 +0000736 Condition = SI->getCondition();
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000737 } else if (IndirectBrInst *IB = dyn_cast<IndirectBrInst>(Terminator)) {
Richard Osborne0ab2b0d2012-07-20 10:36:17 +0000738 // Can't thread indirect branch with no successors.
739 if (IB->getNumSuccessors() == 0) return false;
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000740 Condition = IB->getAddress()->stripPointerCasts();
741 Preference = WantBlockAddress;
742 } else {
Chris Lattner21157222008-04-20 21:13:06 +0000743 return false; // Must be an invoke.
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000744 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000745
Owen Anderson92651ec2011-04-14 21:35:50 +0000746 // Run constant folding to see if we can reduce the condition to a simple
747 // constant.
748 if (Instruction *I = dyn_cast<Instruction>(Condition)) {
Mehdi Aminia28d91d2015-03-10 02:37:25 +0000749 Value *SimpleVal =
750 ConstantFoldInstruction(I, BB->getModule()->getDataLayout(), TLI);
Owen Anderson92651ec2011-04-14 21:35:50 +0000751 if (SimpleVal) {
752 I->replaceAllUsesWith(SimpleVal);
753 I->eraseFromParent();
754 Condition = SimpleVal;
755 }
756 }
757
Chris Lattner595c7272008-12-03 07:48:08 +0000758 // If the terminator is branching on an undef, we can pick any of the
Chris Lattnerf99a74e2009-10-11 04:18:15 +0000759 // successors to branch to. Let GetBestDestForJumpOnUndef decide.
Chris Lattner595c7272008-12-03 07:48:08 +0000760 if (isa<UndefValue>(Condition)) {
Chris Lattnerf99a74e2009-10-11 04:18:15 +0000761 unsigned BestSucc = GetBestDestForJumpOnUndef(BB);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000762
Chris Lattner595c7272008-12-03 07:48:08 +0000763 // Fold the branch/switch.
Chris Lattnerf99a74e2009-10-11 04:18:15 +0000764 TerminatorInst *BBTerm = BB->getTerminator();
Chris Lattner595c7272008-12-03 07:48:08 +0000765 for (unsigned i = 0, e = BBTerm->getNumSuccessors(); i != e; ++i) {
Chris Lattnerf99a74e2009-10-11 04:18:15 +0000766 if (i == BestSucc) continue;
Owen Anderson99c985c2010-09-29 20:34:41 +0000767 BBTerm->getSuccessor(i)->removePredecessor(BB, true);
Chris Lattner595c7272008-12-03 07:48:08 +0000768 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000769
David Greene1efdb452010-01-05 01:27:19 +0000770 DEBUG(dbgs() << " In block '" << BB->getName()
Chris Lattner97b14052009-10-11 07:24:57 +0000771 << "' folding undef terminator: " << *BBTerm << '\n');
Chris Lattnerf99a74e2009-10-11 04:18:15 +0000772 BranchInst::Create(BBTerm->getSuccessor(BestSucc), BBTerm);
Chris Lattner595c7272008-12-03 07:48:08 +0000773 BBTerm->eraseFromParent();
774 return true;
775 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000776
Frits van Bommel76244862010-12-05 19:06:41 +0000777 // If the terminator of this block is branching on a constant, simplify the
778 // terminator to an unconditional branch. This can occur due to threading in
779 // other blocks.
Frits van Bommeld9df6ea2010-12-06 23:36:56 +0000780 if (getKnownConstant(Condition, Preference)) {
Frits van Bommel76244862010-12-05 19:06:41 +0000781 DEBUG(dbgs() << " In block '" << BB->getName()
782 << "' folding terminator: " << *BB->getTerminator() << '\n');
783 ++NumFolds;
Frits van Bommelad964552011-05-22 16:24:18 +0000784 ConstantFoldTerminator(BB, true);
Frits van Bommel76244862010-12-05 19:06:41 +0000785 return true;
786 }
787
Chris Lattner595c7272008-12-03 07:48:08 +0000788 Instruction *CondInst = dyn_cast<Instruction>(Condition);
789
Chris Lattner595c7272008-12-03 07:48:08 +0000790 // All the rest of our checks depend on the condition being an instruction.
Craig Topperf40110f2014-04-25 05:29:35 +0000791 if (!CondInst) {
Chris Lattnerba456162009-11-12 01:41:34 +0000792 // FIXME: Unify this with code below.
Hal Finkel7e184492014-09-07 20:29:59 +0000793 if (ProcessThreadableEdges(Condition, BB, Preference, Terminator))
Chris Lattnerba456162009-11-12 01:41:34 +0000794 return true;
Chris Lattner595c7272008-12-03 07:48:08 +0000795 return false;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000796 }
797
798
Nick Lewycky77585a22009-06-19 04:56:29 +0000799 if (CmpInst *CondCmp = dyn_cast<CmpInst>(CondInst)) {
Philip Reames66ab0f02015-06-16 00:49:59 +0000800 // If we're branching on a conditional, LVI might be able to determine
Eric Christopher572e03a2015-06-19 01:53:21 +0000801 // it's value at the branch instruction. We only handle comparisons
Philip Reames66ab0f02015-06-16 00:49:59 +0000802 // against a constant at this time.
Larisse Voufo532bf712015-09-18 19:14:35 +0000803 // TODO: This should be extended to handle switches as well.
Owen Anderson6ebbd922010-08-27 17:12:29 +0000804 BranchInst *CondBr = dyn_cast<BranchInst>(BB->getTerminator());
805 Constant *CondConst = dyn_cast<Constant>(CondCmp->getOperand(1));
Philip Reames66ab0f02015-06-16 00:49:59 +0000806 if (CondBr && CondConst && CondBr->isConditional()) {
Hal Finkel7e184492014-09-07 20:29:59 +0000807 LazyValueInfo::Tristate Ret =
808 LVI->getPredicateAt(CondCmp->getPredicate(), CondCmp->getOperand(0),
Philip Reames66ab0f02015-06-16 00:49:59 +0000809 CondConst, CondBr);
Hal Finkel7e184492014-09-07 20:29:59 +0000810 if (Ret != LazyValueInfo::Unknown) {
811 unsigned ToRemove = Ret == LazyValueInfo::True ? 1 : 0;
812 unsigned ToKeep = Ret == LazyValueInfo::True ? 0 : 1;
813 CondBr->getSuccessor(ToRemove)->removePredecessor(BB, true);
814 BranchInst::Create(CondBr->getSuccessor(ToKeep), CondBr);
815 CondBr->eraseFromParent();
Philip Reames66ab0f02015-06-16 00:49:59 +0000816 if (CondCmp->use_empty())
817 CondCmp->eraseFromParent();
818 else if (CondCmp->getParent() == BB) {
819 // If the fact we just learned is true for all uses of the
820 // condition, replace it with a constant value
821 auto *CI = Ret == LazyValueInfo::True ?
822 ConstantInt::getTrue(CondCmp->getType()) :
823 ConstantInt::getFalse(CondCmp->getType());
824 CondCmp->replaceAllUsesWith(CI);
825 CondCmp->eraseFromParent();
826 }
Hal Finkel7e184492014-09-07 20:29:59 +0000827 return true;
828 }
Owen Anderson6ebbd922010-08-27 17:12:29 +0000829 }
Benjamin Kramer6a4976d2013-08-07 10:29:38 +0000830
831 if (CondBr && CondConst && TryToUnfoldSelect(CondCmp, BB))
832 return true;
Nick Lewycky77585a22009-06-19 04:56:29 +0000833 }
Chris Lattner98d89d12008-11-27 05:07:53 +0000834
835 // Check for some cases that are worth simplifying. Right now we want to look
836 // for loads that are used by a switch or by the condition for the branch. If
837 // we see one, check to see if it's partially redundant. If so, insert a PHI
838 // which can then be used to thread the values.
839 //
Chris Lattner595c7272008-12-03 07:48:08 +0000840 Value *SimplifyValue = CondInst;
Chris Lattner98d89d12008-11-27 05:07:53 +0000841 if (CmpInst *CondCmp = dyn_cast<CmpInst>(SimplifyValue))
842 if (isa<Constant>(CondCmp->getOperand(1)))
843 SimplifyValue = CondCmp->getOperand(0);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000844
Chris Lattner9d9812a2009-11-15 19:58:31 +0000845 // TODO: There are other places where load PRE would be profitable, such as
846 // more complex comparisons.
Chris Lattner98d89d12008-11-27 05:07:53 +0000847 if (LoadInst *LI = dyn_cast<LoadInst>(SimplifyValue))
848 if (SimplifyPartiallyRedundantLoad(LI))
849 return true;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000850
851
Chris Lattner5ff7f562009-11-07 08:05:03 +0000852 // Handle a variety of cases where we are branching on something derived from
853 // a PHI node in the current block. If we can prove that any predecessors
854 // compute a predictable value based on a PHI node, thread those predecessors.
855 //
Hal Finkel7e184492014-09-07 20:29:59 +0000856 if (ProcessThreadableEdges(CondInst, BB, Preference, Terminator))
Chris Lattnerfde1f8d2009-11-11 02:08:33 +0000857 return true;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000858
Chris Lattner6a19ed02010-01-11 23:41:09 +0000859 // If this is an otherwise-unfoldable branch on a phi node in the current
860 // block, see if we can simplify.
861 if (PHINode *PN = dyn_cast<PHINode>(CondInst))
862 if (PN->getParent() == BB && isa<BranchInst>(BB->getTerminator()))
863 return ProcessBranchOnPHI(PN);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000864
865
Chris Lattnereb73bdb2010-01-12 02:07:17 +0000866 // If this is an otherwise-unfoldable branch on a XOR, see if we can simplify.
867 if (CondInst->getOpcode() == Instruction::Xor &&
868 CondInst->getParent() == BB && isa<BranchInst>(BB->getTerminator()))
869 return ProcessBranchOnXOR(cast<BinaryOperator>(CondInst));
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000870
871
Chris Lattner98d89d12008-11-27 05:07:53 +0000872 // TODO: If we have: "br (X > 0)" and we have a predecessor where we know
Chris Lattner6a19ed02010-01-11 23:41:09 +0000873 // "(X == 4)", thread through this block.
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000874
Chris Lattnere369c352008-04-22 06:36:15 +0000875 return false;
876}
877
Chris Lattner98d89d12008-11-27 05:07:53 +0000878/// SimplifyPartiallyRedundantLoad - If LI is an obviously partially redundant
879/// load instruction, eliminate it by replacing it with a PHI node. This is an
880/// important optimization that encourages jump threading, and needs to be run
881/// interlaced with other jump threading tasks.
882bool JumpThreading::SimplifyPartiallyRedundantLoad(LoadInst *LI) {
Eli Friedman7c5dc122011-09-12 20:23:13 +0000883 // Don't hack volatile/atomic loads.
884 if (!LI->isSimple()) return false;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000885
Chris Lattner98d89d12008-11-27 05:07:53 +0000886 // If the load is defined in a block with exactly one predecessor, it can't be
887 // partially redundant.
888 BasicBlock *LoadBB = LI->getParent();
889 if (LoadBB->getSinglePredecessor())
890 return false;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000891
David Majnemereb518bd2015-08-04 08:21:40 +0000892 // If the load is defined in an EH pad, it can't be partially redundant,
893 // because the edges between the invoke and the EH pad cannot have other
Bill Wendling90dd90a2013-10-21 04:09:17 +0000894 // instructions between them.
David Majnemereb518bd2015-08-04 08:21:40 +0000895 if (LoadBB->isEHPad())
Bill Wendling90dd90a2013-10-21 04:09:17 +0000896 return false;
897
Chris Lattner98d89d12008-11-27 05:07:53 +0000898 Value *LoadedPtr = LI->getOperand(0);
899
900 // If the loaded operand is defined in the LoadBB, it can't be available.
Chris Lattner9d9812a2009-11-15 19:58:31 +0000901 // TODO: Could do simple PHI translation, that would be fun :)
Chris Lattner98d89d12008-11-27 05:07:53 +0000902 if (Instruction *PtrOp = dyn_cast<Instruction>(LoadedPtr))
903 if (PtrOp->getParent() == LoadBB)
904 return false;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000905
Chris Lattner98d89d12008-11-27 05:07:53 +0000906 // Scan a few instructions up from the load, to see if it is obviously live at
907 // the entry to its block.
Duncan P. N. Exon Smith3a9c9e32015-10-13 18:26:00 +0000908 BasicBlock::iterator BBIt(LI);
Chris Lattner98d89d12008-11-27 05:07:53 +0000909
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000910 if (Value *AvailableVal =
Larisse Voufo532bf712015-09-18 19:14:35 +0000911 FindAvailableLoadedValue(LoadedPtr, LoadBB, BBIt, DefMaxInstsToScan)) {
David L Kreitzerda700ce2015-09-16 13:27:30 +0000912 // If the value of the load is locally available within the block, just use
Chris Lattner98d89d12008-11-27 05:07:53 +0000913 // it. This frequently occurs for reg2mem'd allocas.
914 //cerr << "LOAD ELIMINATED:\n" << *BBIt << *LI << "\n";
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000915
Chris Lattner482eb702009-01-09 06:08:12 +0000916 // If the returned value is the load itself, replace with an undef. This can
917 // only happen in dead loops.
Owen Andersonb292b8c2009-07-30 23:03:37 +0000918 if (AvailableVal == LI) AvailableVal = UndefValue::get(LI->getType());
Chandler Carrutheeec35a2014-10-20 00:24:14 +0000919 if (AvailableVal->getType() != LI->getType())
Chandler Carruth1a3c2c42014-11-25 08:20:27 +0000920 AvailableVal =
921 CastInst::CreateBitOrPointerCast(AvailableVal, LI->getType(), "", LI);
Chris Lattner98d89d12008-11-27 05:07:53 +0000922 LI->replaceAllUsesWith(AvailableVal);
923 LI->eraseFromParent();
924 return true;
925 }
926
927 // Otherwise, if we scanned the whole block and got to the top of the block,
928 // we know the block is locally transparent to the load. If not, something
929 // might clobber its value.
930 if (BBIt != LoadBB->begin())
931 return false;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000932
Hal Finkelcc39b672014-07-24 12:16:19 +0000933 // If all of the loads and stores that feed the value have the same AA tags,
934 // then we can propagate them onto any newly inserted loads.
935 AAMDNodes AATags;
936 LI->getAAMetadata(AATags);
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000937
Chris Lattner98d89d12008-11-27 05:07:53 +0000938 SmallPtrSet<BasicBlock*, 8> PredsScanned;
939 typedef SmallVector<std::pair<BasicBlock*, Value*>, 8> AvailablePredsTy;
940 AvailablePredsTy AvailablePreds;
Craig Topperf40110f2014-04-25 05:29:35 +0000941 BasicBlock *OneUnavailablePred = nullptr;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000942
Chris Lattner98d89d12008-11-27 05:07:53 +0000943 // If we got here, the loaded value is transparent through to the start of the
944 // block. Check to see if it is available in any of the predecessor blocks.
Duncan P. N. Exon Smith6c990152014-07-21 17:06:51 +0000945 for (pred_iterator PI = pred_begin(LoadBB), PE = pred_end(LoadBB);
946 PI != PE; ++PI) {
947 BasicBlock *PredBB = *PI;
948
Chris Lattner98d89d12008-11-27 05:07:53 +0000949 // If we already scanned this predecessor, skip it.
David Blaikie70573dc2014-11-19 07:49:26 +0000950 if (!PredsScanned.insert(PredBB).second)
Chris Lattner98d89d12008-11-27 05:07:53 +0000951 continue;
952
953 // Scan the predecessor to see if the value is available in the pred.
954 BBIt = PredBB->end();
Hal Finkelcc39b672014-07-24 12:16:19 +0000955 AAMDNodes ThisAATags;
Larisse Voufo532bf712015-09-18 19:14:35 +0000956 Value *PredAvailable = FindAvailableLoadedValue(LoadedPtr, PredBB, BBIt,
957 DefMaxInstsToScan,
Hal Finkelcc39b672014-07-24 12:16:19 +0000958 nullptr, &ThisAATags);
Chris Lattner98d89d12008-11-27 05:07:53 +0000959 if (!PredAvailable) {
960 OneUnavailablePred = PredBB;
961 continue;
962 }
Nadav Rotem465834c2012-07-24 10:51:42 +0000963
Hal Finkelcc39b672014-07-24 12:16:19 +0000964 // If AA tags disagree or are not present, forget about them.
965 if (AATags != ThisAATags) AATags = AAMDNodes();
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000966
Chris Lattner98d89d12008-11-27 05:07:53 +0000967 // If so, this load is partially redundant. Remember this info so that we
968 // can create a PHI node.
969 AvailablePreds.push_back(std::make_pair(PredBB, PredAvailable));
970 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000971
Chris Lattner98d89d12008-11-27 05:07:53 +0000972 // If the loaded value isn't available in any predecessor, it isn't partially
973 // redundant.
974 if (AvailablePreds.empty()) return false;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000975
Chris Lattner98d89d12008-11-27 05:07:53 +0000976 // Okay, the loaded value is available in at least one (and maybe all!)
977 // predecessors. If the value is unavailable in more than one unique
978 // predecessor, we want to insert a merge block for those common predecessors.
979 // This ensures that we only have to insert one reload, thus not increasing
980 // code size.
Craig Topperf40110f2014-04-25 05:29:35 +0000981 BasicBlock *UnavailablePred = nullptr;
Frits van Bommel5e75ef42010-12-05 19:02:47 +0000982
Chris Lattner98d89d12008-11-27 05:07:53 +0000983 // If there is exactly one predecessor where the value is unavailable, the
984 // already computed 'OneUnavailablePred' block is it. If it ends in an
985 // unconditional branch, we know that it isn't a critical edge.
986 if (PredsScanned.size() == AvailablePreds.size()+1 &&
987 OneUnavailablePred->getTerminator()->getNumSuccessors() == 1) {
988 UnavailablePred = OneUnavailablePred;
989 } else if (PredsScanned.size() != AvailablePreds.size()) {
990 // Otherwise, we had multiple unavailable predecessors or we had a critical
991 // edge from the one.
992 SmallVector<BasicBlock*, 8> PredsToSplit;
993 SmallPtrSet<BasicBlock*, 8> AvailablePredSet;
994
995 for (unsigned i = 0, e = AvailablePreds.size(); i != e; ++i)
996 AvailablePredSet.insert(AvailablePreds[i].first);
997
998 // Add all the unavailable predecessors to the PredsToSplit list.
Duncan P. N. Exon Smith6c990152014-07-21 17:06:51 +0000999 for (pred_iterator PI = pred_begin(LoadBB), PE = pred_end(LoadBB);
1000 PI != PE; ++PI) {
1001 BasicBlock *P = *PI;
Chris Lattner329ea062010-06-14 19:45:43 +00001002 // If the predecessor is an indirect goto, we can't split the edge.
Gabor Greifa5fa8852010-07-12 14:10:24 +00001003 if (isa<IndirectBrInst>(P->getTerminator()))
Chris Lattner329ea062010-06-14 19:45:43 +00001004 return false;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001005
Gabor Greifa5fa8852010-07-12 14:10:24 +00001006 if (!AvailablePredSet.count(P))
1007 PredsToSplit.push_back(P);
Chris Lattner329ea062010-06-14 19:45:43 +00001008 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001009
Chris Lattner98d89d12008-11-27 05:07:53 +00001010 // Split them out to their own block.
Manman Ren72d44b12015-10-15 14:59:40 +00001011 UnavailablePred = SplitBlockPreds(LoadBB, PredsToSplit, "thread-pre-split");
Chris Lattner98d89d12008-11-27 05:07:53 +00001012 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001013
Chris Lattner98d89d12008-11-27 05:07:53 +00001014 // If the value isn't available in all predecessors, then there will be
1015 // exactly one where it isn't available. Insert a load on that edge and add
1016 // it to the AvailablePreds list.
1017 if (UnavailablePred) {
1018 assert(UnavailablePred->getTerminator()->getNumSuccessors() == 1 &&
1019 "Can't handle critical edge here!");
Devang Patel306f8db2011-05-04 22:48:19 +00001020 LoadInst *NewVal = new LoadInst(LoadedPtr, LI->getName()+".pr", false,
Chris Lattner9d9812a2009-11-15 19:58:31 +00001021 LI->getAlignment(),
Chris Lattner98d89d12008-11-27 05:07:53 +00001022 UnavailablePred->getTerminator());
Devang Patel306f8db2011-05-04 22:48:19 +00001023 NewVal->setDebugLoc(LI->getDebugLoc());
Hal Finkelcc39b672014-07-24 12:16:19 +00001024 if (AATags)
1025 NewVal->setAAMetadata(AATags);
Nadav Rotem465834c2012-07-24 10:51:42 +00001026
Chris Lattner98d89d12008-11-27 05:07:53 +00001027 AvailablePreds.push_back(std::make_pair(UnavailablePred, NewVal));
1028 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001029
Chris Lattner98d89d12008-11-27 05:07:53 +00001030 // Now we know that each predecessor of this block has a value in
1031 // AvailablePreds, sort them for efficient access as we're walking the preds.
Chris Lattner2b07d3c2008-12-01 06:52:57 +00001032 array_pod_sort(AvailablePreds.begin(), AvailablePreds.end());
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001033
Chris Lattner98d89d12008-11-27 05:07:53 +00001034 // Create a PHI node at the start of the block for the PRE'd load value.
Jay Foade0938d82011-03-30 11:19:20 +00001035 pred_iterator PB = pred_begin(LoadBB), PE = pred_end(LoadBB);
Jay Foad52131342011-03-30 11:28:46 +00001036 PHINode *PN = PHINode::Create(LI->getType(), std::distance(PB, PE), "",
Duncan P. N. Exon Smith3a9c9e32015-10-13 18:26:00 +00001037 &LoadBB->front());
Chris Lattner98d89d12008-11-27 05:07:53 +00001038 PN->takeName(LI);
Devang Patel306f8db2011-05-04 22:48:19 +00001039 PN->setDebugLoc(LI->getDebugLoc());
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001040
Chris Lattner98d89d12008-11-27 05:07:53 +00001041 // Insert new entries into the PHI for each predecessor. A single block may
1042 // have multiple entries here.
Jay Foade0938d82011-03-30 11:19:20 +00001043 for (pred_iterator PI = PB; PI != PE; ++PI) {
Gabor Greifa5fa8852010-07-12 14:10:24 +00001044 BasicBlock *P = *PI;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001045 AvailablePredsTy::iterator I =
Chris Lattner98d89d12008-11-27 05:07:53 +00001046 std::lower_bound(AvailablePreds.begin(), AvailablePreds.end(),
Craig Topperf40110f2014-04-25 05:29:35 +00001047 std::make_pair(P, (Value*)nullptr));
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001048
Gabor Greifa5fa8852010-07-12 14:10:24 +00001049 assert(I != AvailablePreds.end() && I->first == P &&
Chris Lattner98d89d12008-11-27 05:07:53 +00001050 "Didn't find entry for predecessor!");
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001051
Chandler Carrutheeec35a2014-10-20 00:24:14 +00001052 // If we have an available predecessor but it requires casting, insert the
Chandler Carruth6665d622014-10-20 05:34:36 +00001053 // cast in the predecessor and use the cast. Note that we have to update the
1054 // AvailablePreds vector as we go so that all of the PHI entries for this
1055 // predecessor use the same bitcast.
1056 Value *&PredV = I->second;
Chandler Carrutheeec35a2014-10-20 00:24:14 +00001057 if (PredV->getType() != LI->getType())
Chandler Carruth1a3c2c42014-11-25 08:20:27 +00001058 PredV = CastInst::CreateBitOrPointerCast(PredV, LI->getType(), "",
1059 P->getTerminator());
Chandler Carrutheeec35a2014-10-20 00:24:14 +00001060
1061 PN->addIncoming(PredV, I->first);
Chris Lattner98d89d12008-11-27 05:07:53 +00001062 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001063
Chris Lattner98d89d12008-11-27 05:07:53 +00001064 //cerr << "PRE: " << *LI << *PN << "\n";
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001065
Chris Lattner98d89d12008-11-27 05:07:53 +00001066 LI->replaceAllUsesWith(PN);
1067 LI->eraseFromParent();
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001068
Chris Lattner98d89d12008-11-27 05:07:53 +00001069 return true;
1070}
1071
Chris Lattner5ff7f562009-11-07 08:05:03 +00001072/// FindMostPopularDest - The specified list contains multiple possible
1073/// threadable destinations. Pick the one that occurs the most frequently in
1074/// the list.
1075static BasicBlock *
1076FindMostPopularDest(BasicBlock *BB,
1077 const SmallVectorImpl<std::pair<BasicBlock*,
1078 BasicBlock*> > &PredToDestList) {
1079 assert(!PredToDestList.empty());
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001080
Chris Lattner5ff7f562009-11-07 08:05:03 +00001081 // Determine popularity. If there are multiple possible destinations, we
1082 // explicitly choose to ignore 'undef' destinations. We prefer to thread
1083 // blocks with known and real destinations to threading undef. We'll handle
1084 // them later if interesting.
1085 DenseMap<BasicBlock*, unsigned> DestPopularity;
1086 for (unsigned i = 0, e = PredToDestList.size(); i != e; ++i)
1087 if (PredToDestList[i].second)
1088 DestPopularity[PredToDestList[i].second]++;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001089
Chris Lattner5ff7f562009-11-07 08:05:03 +00001090 // Find the most popular dest.
1091 DenseMap<BasicBlock*, unsigned>::iterator DPI = DestPopularity.begin();
1092 BasicBlock *MostPopularDest = DPI->first;
1093 unsigned Popularity = DPI->second;
1094 SmallVector<BasicBlock*, 4> SamePopularity;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001095
Chris Lattner5ff7f562009-11-07 08:05:03 +00001096 for (++DPI; DPI != DestPopularity.end(); ++DPI) {
1097 // If the popularity of this entry isn't higher than the popularity we've
1098 // seen so far, ignore it.
1099 if (DPI->second < Popularity)
1100 ; // ignore.
1101 else if (DPI->second == Popularity) {
1102 // If it is the same as what we've seen so far, keep track of it.
1103 SamePopularity.push_back(DPI->first);
1104 } else {
1105 // If it is more popular, remember it.
1106 SamePopularity.clear();
1107 MostPopularDest = DPI->first;
1108 Popularity = DPI->second;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001109 }
Chris Lattner5ff7f562009-11-07 08:05:03 +00001110 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001111
Frits van Bommel9bbe8492010-12-16 12:16:00 +00001112 // Okay, now we know the most popular destination. If there is more than one
Chris Lattner5ff7f562009-11-07 08:05:03 +00001113 // destination, we need to determine one. This is arbitrary, but we need
1114 // to make a deterministic decision. Pick the first one that appears in the
1115 // successor list.
1116 if (!SamePopularity.empty()) {
1117 SamePopularity.push_back(MostPopularDest);
1118 TerminatorInst *TI = BB->getTerminator();
1119 for (unsigned i = 0; ; ++i) {
1120 assert(i != TI->getNumSuccessors() && "Didn't find any successor!");
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001121
Chris Lattner5ff7f562009-11-07 08:05:03 +00001122 if (std::find(SamePopularity.begin(), SamePopularity.end(),
1123 TI->getSuccessor(i)) == SamePopularity.end())
1124 continue;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001125
Chris Lattner5ff7f562009-11-07 08:05:03 +00001126 MostPopularDest = TI->getSuccessor(i);
1127 break;
1128 }
1129 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001130
Chris Lattner5ff7f562009-11-07 08:05:03 +00001131 // Okay, we have finally picked the most popular destination.
1132 return MostPopularDest;
1133}
1134
Frits van Bommeld9df6ea2010-12-06 23:36:56 +00001135bool JumpThreading::ProcessThreadableEdges(Value *Cond, BasicBlock *BB,
Hal Finkel7e184492014-09-07 20:29:59 +00001136 ConstantPreference Preference,
1137 Instruction *CxtI) {
Chris Lattner5ff7f562009-11-07 08:05:03 +00001138 // If threading this would thread across a loop header, don't even try to
1139 // thread the edge.
1140 if (LoopHeaders.count(BB))
1141 return false;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001142
Frits van Bommel76244862010-12-05 19:06:41 +00001143 PredValueInfoTy PredValues;
Hal Finkel7e184492014-09-07 20:29:59 +00001144 if (!ComputeValueKnownInPredecessors(Cond, BB, PredValues, Preference, CxtI))
Chris Lattner5ff7f562009-11-07 08:05:03 +00001145 return false;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001146
Chris Lattner5ff7f562009-11-07 08:05:03 +00001147 assert(!PredValues.empty() &&
1148 "ComputeValueKnownInPredecessors returned true with no values");
1149
David Greene1efdb452010-01-05 01:27:19 +00001150 DEBUG(dbgs() << "IN BB: " << *BB;
Chris Lattner5ff7f562009-11-07 08:05:03 +00001151 for (unsigned i = 0, e = PredValues.size(); i != e; ++i) {
Frits van Bommel76244862010-12-05 19:06:41 +00001152 dbgs() << " BB '" << BB->getName() << "': FOUND condition = "
1153 << *PredValues[i].first
1154 << " for pred '" << PredValues[i].second->getName() << "'.\n";
Chris Lattner5ff7f562009-11-07 08:05:03 +00001155 });
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001156
Chris Lattner5ff7f562009-11-07 08:05:03 +00001157 // Decide what we want to thread through. Convert our list of known values to
1158 // a list of known destinations for each pred. This also discards duplicate
1159 // predecessors and keeps track of the undefined inputs (which are represented
Chris Lattnerea465e22009-11-09 00:41:49 +00001160 // as a null dest in the PredToDestList).
Chris Lattner5ff7f562009-11-07 08:05:03 +00001161 SmallPtrSet<BasicBlock*, 16> SeenPreds;
1162 SmallVector<std::pair<BasicBlock*, BasicBlock*>, 16> PredToDestList;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001163
Craig Topperf40110f2014-04-25 05:29:35 +00001164 BasicBlock *OnlyDest = nullptr;
Chris Lattner5ff7f562009-11-07 08:05:03 +00001165 BasicBlock *MultipleDestSentinel = (BasicBlock*)(intptr_t)~0ULL;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001166
Chris Lattner5ff7f562009-11-07 08:05:03 +00001167 for (unsigned i = 0, e = PredValues.size(); i != e; ++i) {
1168 BasicBlock *Pred = PredValues[i].second;
David Blaikie70573dc2014-11-19 07:49:26 +00001169 if (!SeenPreds.insert(Pred).second)
Chris Lattner5ff7f562009-11-07 08:05:03 +00001170 continue; // Duplicate predecessor entry.
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001171
Chris Lattner5ff7f562009-11-07 08:05:03 +00001172 // If the predecessor ends with an indirect goto, we can't change its
1173 // destination.
1174 if (isa<IndirectBrInst>(Pred->getTerminator()))
1175 continue;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001176
Frits van Bommel76244862010-12-05 19:06:41 +00001177 Constant *Val = PredValues[i].first;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001178
Chris Lattner5ff7f562009-11-07 08:05:03 +00001179 BasicBlock *DestBB;
Frits van Bommel76244862010-12-05 19:06:41 +00001180 if (isa<UndefValue>(Val))
Craig Topperf40110f2014-04-25 05:29:35 +00001181 DestBB = nullptr;
Chris Lattner5ff7f562009-11-07 08:05:03 +00001182 else if (BranchInst *BI = dyn_cast<BranchInst>(BB->getTerminator()))
Frits van Bommel76244862010-12-05 19:06:41 +00001183 DestBB = BI->getSuccessor(cast<ConstantInt>(Val)->isZero());
Stepan Dyatkovskiy513aaa52012-02-01 07:49:51 +00001184 else if (SwitchInst *SI = dyn_cast<SwitchInst>(BB->getTerminator())) {
Stepan Dyatkovskiy5b648af2012-03-08 07:06:20 +00001185 DestBB = SI->findCaseValue(cast<ConstantInt>(Val)).getCaseSuccessor();
Stepan Dyatkovskiy513aaa52012-02-01 07:49:51 +00001186 } else {
Frits van Bommeld9df6ea2010-12-06 23:36:56 +00001187 assert(isa<IndirectBrInst>(BB->getTerminator())
1188 && "Unexpected terminator");
1189 DestBB = cast<BlockAddress>(Val)->getBasicBlock();
Chris Lattner5ff7f562009-11-07 08:05:03 +00001190 }
1191
1192 // If we have exactly one destination, remember it for efficiency below.
Frits van Bommel9bbe8492010-12-16 12:16:00 +00001193 if (PredToDestList.empty())
Chris Lattner5ff7f562009-11-07 08:05:03 +00001194 OnlyDest = DestBB;
1195 else if (OnlyDest != DestBB)
1196 OnlyDest = MultipleDestSentinel;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001197
Chris Lattner5ff7f562009-11-07 08:05:03 +00001198 PredToDestList.push_back(std::make_pair(Pred, DestBB));
1199 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001200
Chris Lattner5ff7f562009-11-07 08:05:03 +00001201 // If all edges were unthreadable, we fail.
1202 if (PredToDestList.empty())
1203 return false;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001204
Chris Lattner5ff7f562009-11-07 08:05:03 +00001205 // Determine which is the most common successor. If we have many inputs and
1206 // this block is a switch, we want to start by threading the batch that goes
1207 // to the most popular destination first. If we only know about one
1208 // threadable destination (the common case) we can avoid this.
1209 BasicBlock *MostPopularDest = OnlyDest;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001210
Chris Lattner5ff7f562009-11-07 08:05:03 +00001211 if (MostPopularDest == MultipleDestSentinel)
1212 MostPopularDest = FindMostPopularDest(BB, PredToDestList);
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001213
Chris Lattner5ff7f562009-11-07 08:05:03 +00001214 // Now that we know what the most popular destination is, factor all
1215 // predecessors that will jump to it into a single predecessor.
1216 SmallVector<BasicBlock*, 16> PredsToFactor;
1217 for (unsigned i = 0, e = PredToDestList.size(); i != e; ++i)
1218 if (PredToDestList[i].second == MostPopularDest) {
1219 BasicBlock *Pred = PredToDestList[i].first;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001220
Chris Lattner5ff7f562009-11-07 08:05:03 +00001221 // This predecessor may be a switch or something else that has multiple
1222 // edges to the block. Factor each of these edges by listing them
1223 // according to # occurrences in PredsToFactor.
1224 TerminatorInst *PredTI = Pred->getTerminator();
1225 for (unsigned i = 0, e = PredTI->getNumSuccessors(); i != e; ++i)
1226 if (PredTI->getSuccessor(i) == BB)
1227 PredsToFactor.push_back(Pred);
1228 }
1229
1230 // If the threadable edges are branching on an undefined value, we get to pick
1231 // the destination that these predecessors should get to.
Craig Topperf40110f2014-04-25 05:29:35 +00001232 if (!MostPopularDest)
Chris Lattner5ff7f562009-11-07 08:05:03 +00001233 MostPopularDest = BB->getTerminator()->
1234 getSuccessor(GetBestDestForJumpOnUndef(BB));
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001235
Chris Lattner5ff7f562009-11-07 08:05:03 +00001236 // Ok, try to thread it!
1237 return ThreadEdge(BB, PredsToFactor, MostPopularDest);
1238}
Chris Lattner98d89d12008-11-27 05:07:53 +00001239
Chris Lattner6a19ed02010-01-11 23:41:09 +00001240/// ProcessBranchOnPHI - We have an otherwise unthreadable conditional branch on
1241/// a PHI node in the current block. See if there are any simplifications we
1242/// can do based on inputs to the phi node.
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001243///
Chris Lattner6a19ed02010-01-11 23:41:09 +00001244bool JumpThreading::ProcessBranchOnPHI(PHINode *PN) {
Chris Lattner6ce85e82009-10-11 04:40:21 +00001245 BasicBlock *BB = PN->getParent();
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001246
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001247 // TODO: We could make use of this to do it once for blocks with common PHI
1248 // values.
1249 SmallVector<BasicBlock*, 1> PredBBs;
1250 PredBBs.resize(1);
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001251
Chris Lattner5ff7f562009-11-07 08:05:03 +00001252 // If any of the predecessor blocks end in an unconditional branch, we can
Chris Lattner6a19ed02010-01-11 23:41:09 +00001253 // *duplicate* the conditional branch into that block in order to further
1254 // encourage jump threading and to eliminate cases where we have branch on a
1255 // phi of an icmp (branch on icmp is much better).
Chris Lattner97b14052009-10-11 07:24:57 +00001256 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
1257 BasicBlock *PredBB = PN->getIncomingBlock(i);
1258 if (BranchInst *PredBr = dyn_cast<BranchInst>(PredBB->getTerminator()))
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001259 if (PredBr->isUnconditional()) {
1260 PredBBs[0] = PredBB;
1261 // Try to duplicate BB into PredBB.
1262 if (DuplicateCondBranchOnPHIIntoPred(BB, PredBBs))
1263 return true;
1264 }
Chris Lattner97b14052009-10-11 07:24:57 +00001265 }
1266
Chris Lattner6ce85e82009-10-11 04:40:21 +00001267 return false;
Chris Lattnerff1c6e32008-04-20 22:39:42 +00001268}
1269
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001270/// ProcessBranchOnXOR - We have an otherwise unthreadable conditional branch on
1271/// a xor instruction in the current block. See if there are any
1272/// simplifications we can do based on inputs to the xor.
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001273///
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001274bool JumpThreading::ProcessBranchOnXOR(BinaryOperator *BO) {
1275 BasicBlock *BB = BO->getParent();
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001276
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001277 // If either the LHS or RHS of the xor is a constant, don't do this
1278 // optimization.
1279 if (isa<ConstantInt>(BO->getOperand(0)) ||
1280 isa<ConstantInt>(BO->getOperand(1)))
1281 return false;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001282
Chris Lattnerba2d0b82010-01-23 19:16:25 +00001283 // If the first instruction in BB isn't a phi, we won't be able to infer
1284 // anything special about any particular predecessor.
1285 if (!isa<PHINode>(BB->front()))
1286 return false;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001287
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001288 // If we have a xor as the branch input to this block, and we know that the
1289 // LHS or RHS of the xor in any predecessor is true/false, then we can clone
1290 // the condition into the predecessor and fix that value to true, saving some
1291 // logical ops on that path and encouraging other paths to simplify.
1292 //
1293 // This copies something like this:
1294 //
1295 // BB:
1296 // %X = phi i1 [1], [%X']
1297 // %Y = icmp eq i32 %A, %B
1298 // %Z = xor i1 %X, %Y
1299 // br i1 %Z, ...
1300 //
1301 // Into:
1302 // BB':
1303 // %Y = icmp ne i32 %A, %B
David L Kreitzerda700ce2015-09-16 13:27:30 +00001304 // br i1 %Y, ...
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001305
Frits van Bommel76244862010-12-05 19:06:41 +00001306 PredValueInfoTy XorOpValues;
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001307 bool isLHS = true;
Frits van Bommeld9df6ea2010-12-06 23:36:56 +00001308 if (!ComputeValueKnownInPredecessors(BO->getOperand(0), BB, XorOpValues,
Hal Finkel7e184492014-09-07 20:29:59 +00001309 WantInteger, BO)) {
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001310 assert(XorOpValues.empty());
Frits van Bommeld9df6ea2010-12-06 23:36:56 +00001311 if (!ComputeValueKnownInPredecessors(BO->getOperand(1), BB, XorOpValues,
Hal Finkel7e184492014-09-07 20:29:59 +00001312 WantInteger, BO))
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001313 return false;
1314 isLHS = false;
1315 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001316
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001317 assert(!XorOpValues.empty() &&
1318 "ComputeValueKnownInPredecessors returned true with no values");
1319
1320 // Scan the information to see which is most popular: true or false. The
1321 // predecessors can be of the set true, false, or undef.
1322 unsigned NumTrue = 0, NumFalse = 0;
1323 for (unsigned i = 0, e = XorOpValues.size(); i != e; ++i) {
Frits van Bommel76244862010-12-05 19:06:41 +00001324 if (isa<UndefValue>(XorOpValues[i].first))
1325 // Ignore undefs for the count.
1326 continue;
1327 if (cast<ConstantInt>(XorOpValues[i].first)->isZero())
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001328 ++NumFalse;
1329 else
1330 ++NumTrue;
1331 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001332
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001333 // Determine which value to split on, true, false, or undef if neither.
Craig Topperf40110f2014-04-25 05:29:35 +00001334 ConstantInt *SplitVal = nullptr;
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001335 if (NumTrue > NumFalse)
1336 SplitVal = ConstantInt::getTrue(BB->getContext());
1337 else if (NumTrue != 0 || NumFalse != 0)
1338 SplitVal = ConstantInt::getFalse(BB->getContext());
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001339
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001340 // Collect all of the blocks that this can be folded into so that we can
1341 // factor this once and clone it once.
1342 SmallVector<BasicBlock*, 8> BlocksToFoldInto;
1343 for (unsigned i = 0, e = XorOpValues.size(); i != e; ++i) {
Frits van Bommel76244862010-12-05 19:06:41 +00001344 if (XorOpValues[i].first != SplitVal &&
1345 !isa<UndefValue>(XorOpValues[i].first))
1346 continue;
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001347
1348 BlocksToFoldInto.push_back(XorOpValues[i].second);
1349 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001350
Chris Lattnerba2d0b82010-01-23 19:16:25 +00001351 // If we inferred a value for all of the predecessors, then duplication won't
1352 // help us. However, we can just replace the LHS or RHS with the constant.
1353 if (BlocksToFoldInto.size() ==
1354 cast<PHINode>(BB->front()).getNumIncomingValues()) {
Craig Topperf40110f2014-04-25 05:29:35 +00001355 if (!SplitVal) {
Chris Lattnerba2d0b82010-01-23 19:16:25 +00001356 // If all preds provide undef, just nuke the xor, because it is undef too.
1357 BO->replaceAllUsesWith(UndefValue::get(BO->getType()));
1358 BO->eraseFromParent();
1359 } else if (SplitVal->isZero()) {
1360 // If all preds provide 0, replace the xor with the other input.
1361 BO->replaceAllUsesWith(BO->getOperand(isLHS));
1362 BO->eraseFromParent();
1363 } else {
1364 // If all preds provide 1, set the computed value to 1.
1365 BO->setOperand(!isLHS, SplitVal);
1366 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001367
Chris Lattnerba2d0b82010-01-23 19:16:25 +00001368 return true;
1369 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001370
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001371 // Try to duplicate BB into PredBB.
Chris Lattneraf7855d2010-01-12 02:07:50 +00001372 return DuplicateCondBranchOnPHIIntoPred(BB, BlocksToFoldInto);
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001373}
1374
1375
Chris Lattner97b14052009-10-11 07:24:57 +00001376/// AddPHINodeEntriesForMappedBlock - We're adding 'NewPred' as a new
1377/// predecessor to the PHIBB block. If it has PHI nodes, add entries for
1378/// NewPred using the entries from OldPred (suitably mapped).
1379static void AddPHINodeEntriesForMappedBlock(BasicBlock *PHIBB,
1380 BasicBlock *OldPred,
1381 BasicBlock *NewPred,
1382 DenseMap<Instruction*, Value*> &ValueMap) {
1383 for (BasicBlock::iterator PNI = PHIBB->begin();
1384 PHINode *PN = dyn_cast<PHINode>(PNI); ++PNI) {
1385 // Ok, we have a PHI node. Figure out what the incoming value was for the
1386 // DestBlock.
1387 Value *IV = PN->getIncomingValueForBlock(OldPred);
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001388
Chris Lattner97b14052009-10-11 07:24:57 +00001389 // Remap the value if necessary.
1390 if (Instruction *Inst = dyn_cast<Instruction>(IV)) {
1391 DenseMap<Instruction*, Value*>::iterator I = ValueMap.find(Inst);
1392 if (I != ValueMap.end())
1393 IV = I->second;
1394 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001395
Chris Lattner97b14052009-10-11 07:24:57 +00001396 PN->addIncoming(IV, NewPred);
1397 }
1398}
Chris Lattner3df4c152008-04-22 07:05:46 +00001399
Chris Lattner5ff7f562009-11-07 08:05:03 +00001400/// ThreadEdge - We have decided that it is safe and profitable to factor the
1401/// blocks in PredBBs to one predecessor, then thread an edge from it to SuccBB
1402/// across BB. Transform the IR to reflect this change.
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001403bool JumpThreading::ThreadEdge(BasicBlock *BB,
1404 const SmallVectorImpl<BasicBlock*> &PredBBs,
Chris Lattnerf466bc82009-10-11 04:33:43 +00001405 BasicBlock *SuccBB) {
Chris Lattnerd579cb12009-05-04 02:28:08 +00001406 // If threading to the same block as we come from, we would infinite loop.
1407 if (SuccBB == BB) {
David Greene1efdb452010-01-05 01:27:19 +00001408 DEBUG(dbgs() << " Not threading across BB '" << BB->getName()
Daniel Dunbar9813b0b2009-07-26 07:49:05 +00001409 << "' - would thread to self!\n");
Chris Lattnerd579cb12009-05-04 02:28:08 +00001410 return false;
1411 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001412
Chris Lattnerd579cb12009-05-04 02:28:08 +00001413 // If threading this would thread across a loop header, don't thread the edge.
1414 // See the comments above FindLoopHeaders for justifications and caveats.
1415 if (LoopHeaders.count(BB)) {
David Greene1efdb452010-01-05 01:27:19 +00001416 DEBUG(dbgs() << " Not threading across loop header BB '" << BB->getName()
Daniel Dunbar9813b0b2009-07-26 07:49:05 +00001417 << "' to dest BB '" << SuccBB->getName()
1418 << "' - it might create an irreducible loop!\n");
Chris Lattnerd579cb12009-05-04 02:28:08 +00001419 return false;
1420 }
1421
Michael Liaod1209162014-09-24 04:59:06 +00001422 unsigned JumpThreadCost = getJumpThreadDuplicationCost(BB, BBDupThreshold);
1423 if (JumpThreadCost > BBDupThreshold) {
David Greene1efdb452010-01-05 01:27:19 +00001424 DEBUG(dbgs() << " Not threading BB '" << BB->getName()
Chris Lattner97b14052009-10-11 07:24:57 +00001425 << "' - Cost is too high: " << JumpThreadCost << "\n");
1426 return false;
1427 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001428
David L Kreitzerda700ce2015-09-16 13:27:30 +00001429 // And finally, do it! Start by factoring the predecessors if needed.
Chris Lattner5ff7f562009-11-07 08:05:03 +00001430 BasicBlock *PredBB;
1431 if (PredBBs.size() == 1)
1432 PredBB = PredBBs[0];
1433 else {
David Greene1efdb452010-01-05 01:27:19 +00001434 DEBUG(dbgs() << " Factoring out " << PredBBs.size()
Chris Lattner5ff7f562009-11-07 08:05:03 +00001435 << " common predecessors.\n");
Manman Ren72d44b12015-10-15 14:59:40 +00001436 PredBB = SplitBlockPreds(BB, PredBBs, ".thr_comm");
Chris Lattner5ff7f562009-11-07 08:05:03 +00001437 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001438
Chris Lattnerd579cb12009-05-04 02:28:08 +00001439 // And finally, do it!
David Greene1efdb452010-01-05 01:27:19 +00001440 DEBUG(dbgs() << " Threading edge from '" << PredBB->getName() << "' to '"
Daniel Dunbar6115b392009-07-26 09:48:23 +00001441 << SuccBB->getName() << "' with cost: " << JumpThreadCost
Daniel Dunbar9813b0b2009-07-26 07:49:05 +00001442 << ", across block:\n "
1443 << *BB << "\n");
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001444
Owen Andersond361aac2010-09-14 20:57:41 +00001445 LVI->threadEdge(PredBB, BB, SuccBB);
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001446
Chris Lattnerff1c6e32008-04-20 22:39:42 +00001447 // We are going to have to map operands from the original BB block to the new
1448 // copy of the block 'NewBB'. If there are PHI nodes in BB, evaluate them to
1449 // account for entry from PredBB.
1450 DenseMap<Instruction*, Value*> ValueMapping;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001451
1452 BasicBlock *NewBB = BasicBlock::Create(BB->getContext(),
1453 BB->getName()+".thread",
Owen Anderson55f1c092009-08-13 21:58:54 +00001454 BB->getParent(), BB);
Chris Lattnerff1c6e32008-04-20 22:39:42 +00001455 NewBB->moveAfter(PredBB);
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001456
Manman Ren72d44b12015-10-15 14:59:40 +00001457 // Set the block frequency of NewBB.
1458 if (HasProfileData) {
1459 auto NewBBFreq =
1460 BFI->getBlockFreq(PredBB) * BPI->getEdgeProbability(PredBB, BB);
1461 BFI->setBlockFreq(NewBB, NewBBFreq.getFrequency());
1462 }
1463
Chris Lattnerff1c6e32008-04-20 22:39:42 +00001464 BasicBlock::iterator BI = BB->begin();
1465 for (; PHINode *PN = dyn_cast<PHINode>(BI); ++BI)
1466 ValueMapping[PN] = PN->getIncomingValueForBlock(PredBB);
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001467
Chris Lattnerff1c6e32008-04-20 22:39:42 +00001468 // Clone the non-phi instructions of BB into NewBB, keeping track of the
1469 // mapping and using it to remap operands in the cloned instructions.
1470 for (; !isa<TerminatorInst>(BI); ++BI) {
Nick Lewycky42fb7452009-09-27 07:38:41 +00001471 Instruction *New = BI->clone();
Daniel Dunbar6115b392009-07-26 09:48:23 +00001472 New->setName(BI->getName());
Chris Lattnerff1c6e32008-04-20 22:39:42 +00001473 NewBB->getInstList().push_back(New);
Duncan P. N. Exon Smith3a9c9e32015-10-13 18:26:00 +00001474 ValueMapping[&*BI] = New;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001475
Chris Lattnerff1c6e32008-04-20 22:39:42 +00001476 // Remap operands to patch up intra-block references.
1477 for (unsigned i = 0, e = New->getNumOperands(); i != e; ++i)
Dan Gohman43f33dd2009-07-02 00:17:47 +00001478 if (Instruction *Inst = dyn_cast<Instruction>(New->getOperand(i))) {
1479 DenseMap<Instruction*, Value*>::iterator I = ValueMapping.find(Inst);
1480 if (I != ValueMapping.end())
1481 New->setOperand(i, I->second);
1482 }
Chris Lattnerff1c6e32008-04-20 22:39:42 +00001483 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001484
Chris Lattnerff1c6e32008-04-20 22:39:42 +00001485 // We didn't copy the terminator from BB over to NewBB, because there is now
1486 // an unconditional jump to SuccBB. Insert the unconditional jump.
Manman Ren72d44b12015-10-15 14:59:40 +00001487 BranchInst *NewBI = BranchInst::Create(SuccBB, NewBB);
Devang Patel306f8db2011-05-04 22:48:19 +00001488 NewBI->setDebugLoc(BB->getTerminator()->getDebugLoc());
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001489
Chris Lattnerff1c6e32008-04-20 22:39:42 +00001490 // Check to see if SuccBB has PHI nodes. If so, we need to add entries to the
1491 // PHI nodes for NewBB now.
Chris Lattner97b14052009-10-11 07:24:57 +00001492 AddPHINodeEntriesForMappedBlock(SuccBB, BB, NewBB, ValueMapping);
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001493
Chris Lattner84095072009-10-10 09:05:58 +00001494 // If there were values defined in BB that are used outside the block, then we
1495 // now have to update all uses of the value to use either the original value,
1496 // the cloned value, or some PHI derived value. This can require arbitrary
1497 // PHI insertion, of which we are prepared to do, clean these up now.
1498 SSAUpdater SSAUpdate;
1499 SmallVector<Use*, 16> UsesToRename;
1500 for (BasicBlock::iterator I = BB->begin(); I != BB->end(); ++I) {
1501 // Scan all uses of this instruction to see if it is used outside of its
1502 // block, and if so, record them in UsesToRename.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001503 for (Use &U : I->uses()) {
1504 Instruction *User = cast<Instruction>(U.getUser());
Chris Lattner84095072009-10-10 09:05:58 +00001505 if (PHINode *UserPN = dyn_cast<PHINode>(User)) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00001506 if (UserPN->getIncomingBlock(U) == BB)
Chris Lattner84095072009-10-10 09:05:58 +00001507 continue;
1508 } else if (User->getParent() == BB)
1509 continue;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001510
Chandler Carruthcdf47882014-03-09 03:16:01 +00001511 UsesToRename.push_back(&U);
Chris Lattner84095072009-10-10 09:05:58 +00001512 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001513
Chris Lattner84095072009-10-10 09:05:58 +00001514 // If there are no uses outside the block, we're done with this instruction.
1515 if (UsesToRename.empty())
1516 continue;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001517
David Greene1efdb452010-01-05 01:27:19 +00001518 DEBUG(dbgs() << "JT: Renaming non-local uses of: " << *I << "\n");
Chris Lattner84095072009-10-10 09:05:58 +00001519
1520 // We found a use of I outside of BB. Rename all uses of I that are outside
1521 // its block to be uses of the appropriate PHI node etc. See ValuesInBlocks
1522 // with the two values we know.
Duncan Sands67781492010-09-02 08:14:03 +00001523 SSAUpdate.Initialize(I->getType(), I->getName());
Duncan P. N. Exon Smith3a9c9e32015-10-13 18:26:00 +00001524 SSAUpdate.AddAvailableValue(BB, &*I);
1525 SSAUpdate.AddAvailableValue(NewBB, ValueMapping[&*I]);
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001526
Chris Lattner84095072009-10-10 09:05:58 +00001527 while (!UsesToRename.empty())
1528 SSAUpdate.RewriteUse(*UsesToRename.pop_back_val());
David Greene1efdb452010-01-05 01:27:19 +00001529 DEBUG(dbgs() << "\n");
Chris Lattner84095072009-10-10 09:05:58 +00001530 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001531
1532
Chris Lattner88a1f022008-12-01 04:48:07 +00001533 // Ok, NewBB is good to go. Update the terminator of PredBB to jump to
Chris Lattnerff1c6e32008-04-20 22:39:42 +00001534 // NewBB instead of BB. This eliminates predecessors from BB, which requires
1535 // us to simplify any PHI nodes in BB.
1536 TerminatorInst *PredTerm = PredBB->getTerminator();
1537 for (unsigned i = 0, e = PredTerm->getNumSuccessors(); i != e; ++i)
1538 if (PredTerm->getSuccessor(i) == BB) {
Owen Anderson99c985c2010-09-29 20:34:41 +00001539 BB->removePredecessor(PredBB, true);
Chris Lattnerff1c6e32008-04-20 22:39:42 +00001540 PredTerm->setSuccessor(i, NewBB);
1541 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001542
Chris Lattner88a1f022008-12-01 04:48:07 +00001543 // At this point, the IR is fully up to date and consistent. Do a quick scan
1544 // over the new instructions and zap any that are constants or dead. This
1545 // frequently happens because of phi translation.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001546 SimplifyInstructionsInBlock(NewBB, TLI);
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001547
Manman Ren72d44b12015-10-15 14:59:40 +00001548 // Update the edge weight from BB to SuccBB, which should be less than before.
1549 UpdateBlockFreqAndEdgeWeight(PredBB, BB, NewBB, SuccBB);
1550
Chris Lattnerd579cb12009-05-04 02:28:08 +00001551 // Threaded an edge!
1552 ++NumThreads;
1553 return true;
Chris Lattner21157222008-04-20 21:13:06 +00001554}
Chris Lattner97b14052009-10-11 07:24:57 +00001555
Manman Ren72d44b12015-10-15 14:59:40 +00001556/// Create a new basic block that will be the predecessor of BB and successor of
1557/// all blocks in Preds. When profile data is availble, update the frequency of
1558/// this new block.
1559BasicBlock *JumpThreading::SplitBlockPreds(BasicBlock *BB,
1560 ArrayRef<BasicBlock *> Preds,
1561 const char *Suffix) {
1562 // Collect the frequencies of all predecessors of BB, which will be used to
1563 // update the edge weight on BB->SuccBB.
1564 BlockFrequency PredBBFreq(0);
1565 if (HasProfileData)
1566 for (auto Pred : Preds)
1567 PredBBFreq += BFI->getBlockFreq(Pred) * BPI->getEdgeProbability(Pred, BB);
1568
1569 BasicBlock *PredBB = SplitBlockPredecessors(BB, Preds, Suffix);
1570
1571 // Set the block frequency of the newly created PredBB, which is the sum of
1572 // frequencies of Preds.
1573 if (HasProfileData)
1574 BFI->setBlockFreq(PredBB, PredBBFreq.getFrequency());
1575 return PredBB;
1576}
1577
1578/// Update the block frequency of BB and branch weight and the metadata on the
1579/// edge BB->SuccBB. This is done by scaling the weight of BB->SuccBB by 1 -
1580/// Freq(PredBB->BB) / Freq(BB->SuccBB).
1581void JumpThreading::UpdateBlockFreqAndEdgeWeight(BasicBlock *PredBB,
1582 BasicBlock *BB,
1583 BasicBlock *NewBB,
1584 BasicBlock *SuccBB) {
1585 if (!HasProfileData)
1586 return;
1587
1588 assert(BFI && BPI && "BFI & BPI should have been created here");
1589
1590 // As the edge from PredBB to BB is deleted, we have to update the block
1591 // frequency of BB.
1592 auto BBOrigFreq = BFI->getBlockFreq(BB);
1593 auto NewBBFreq = BFI->getBlockFreq(NewBB);
1594 auto BB2SuccBBFreq = BBOrigFreq * BPI->getEdgeProbability(BB, SuccBB);
1595 auto BBNewFreq = BBOrigFreq - NewBBFreq;
1596 BFI->setBlockFreq(BB, BBNewFreq.getFrequency());
1597
1598 // Collect updated outgoing edges' frequencies from BB and use them to update
1599 // edge weights.
1600 SmallVector<uint64_t, 4> BBSuccFreq;
1601 for (auto I = succ_begin(BB), E = succ_end(BB); I != E; ++I) {
1602 auto SuccFreq = (*I == SuccBB)
1603 ? BB2SuccBBFreq - NewBBFreq
1604 : BBOrigFreq * BPI->getEdgeProbability(BB, *I);
1605 BBSuccFreq.push_back(SuccFreq.getFrequency());
1606 }
1607
1608 // Normalize edge weights in Weights64 so that the sum of them can fit in
1609 BranchProbability::normalizeEdgeWeights(BBSuccFreq.begin(), BBSuccFreq.end());
1610
1611 SmallVector<uint32_t, 4> Weights;
1612 for (auto Freq : BBSuccFreq)
1613 Weights.push_back(static_cast<uint32_t>(Freq));
1614
1615 // Update edge weights in BPI.
1616 for (int I = 0, E = Weights.size(); I < E; I++)
1617 BPI->setEdgeWeight(BB, I, Weights[I]);
1618
1619 if (Weights.size() >= 2) {
1620 auto TI = BB->getTerminator();
1621 TI->setMetadata(
1622 LLVMContext::MD_prof,
1623 MDBuilder(TI->getParent()->getContext()).createBranchWeights(Weights));
1624 }
1625}
1626
Chris Lattner97b14052009-10-11 07:24:57 +00001627/// DuplicateCondBranchOnPHIIntoPred - PredBB contains an unconditional branch
1628/// to BB which contains an i1 PHI node and a conditional branch on that PHI.
1629/// If we can duplicate the contents of BB up into PredBB do so now, this
1630/// improves the odds that the branch will be on an analyzable instruction like
1631/// a compare.
1632bool JumpThreading::DuplicateCondBranchOnPHIIntoPred(BasicBlock *BB,
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001633 const SmallVectorImpl<BasicBlock *> &PredBBs) {
1634 assert(!PredBBs.empty() && "Can't handle an empty set");
1635
Chris Lattner97b14052009-10-11 07:24:57 +00001636 // If BB is a loop header, then duplicating this block outside the loop would
1637 // cause us to transform this into an irreducible loop, don't do this.
1638 // See the comments above FindLoopHeaders for justifications and caveats.
1639 if (LoopHeaders.count(BB)) {
David Greene1efdb452010-01-05 01:27:19 +00001640 DEBUG(dbgs() << " Not duplicating loop header '" << BB->getName()
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001641 << "' into predecessor block '" << PredBBs[0]->getName()
Chris Lattner97b14052009-10-11 07:24:57 +00001642 << "' - it might create an irreducible loop!\n");
1643 return false;
1644 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001645
Michael Liaod1209162014-09-24 04:59:06 +00001646 unsigned DuplicationCost = getJumpThreadDuplicationCost(BB, BBDupThreshold);
1647 if (DuplicationCost > BBDupThreshold) {
David Greene1efdb452010-01-05 01:27:19 +00001648 DEBUG(dbgs() << " Not duplicating BB '" << BB->getName()
Chris Lattner97b14052009-10-11 07:24:57 +00001649 << "' - Cost is too high: " << DuplicationCost << "\n");
1650 return false;
1651 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001652
David L Kreitzerda700ce2015-09-16 13:27:30 +00001653 // And finally, do it! Start by factoring the predecessors if needed.
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001654 BasicBlock *PredBB;
1655 if (PredBBs.size() == 1)
1656 PredBB = PredBBs[0];
1657 else {
1658 DEBUG(dbgs() << " Factoring out " << PredBBs.size()
1659 << " common predecessors.\n");
Manman Ren72d44b12015-10-15 14:59:40 +00001660 PredBB = SplitBlockPreds(BB, PredBBs, ".thr_comm");
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001661 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001662
Chris Lattner97b14052009-10-11 07:24:57 +00001663 // Okay, we decided to do this! Clone all the instructions in BB onto the end
1664 // of PredBB.
David Greene1efdb452010-01-05 01:27:19 +00001665 DEBUG(dbgs() << " Duplicating block '" << BB->getName() << "' into end of '"
Chris Lattner97b14052009-10-11 07:24:57 +00001666 << PredBB->getName() << "' to eliminate branch on phi. Cost: "
1667 << DuplicationCost << " block is:" << *BB << "\n");
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001668
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001669 // Unless PredBB ends with an unconditional branch, split the edge so that we
1670 // can just clone the bits from BB into the end of the new PredBB.
Chris Lattner29b15c52010-01-23 19:21:31 +00001671 BranchInst *OldPredBranch = dyn_cast<BranchInst>(PredBB->getTerminator());
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001672
Craig Topperf40110f2014-04-25 05:29:35 +00001673 if (!OldPredBranch || !OldPredBranch->isUnconditional()) {
Chandler Carruthd4500562015-01-19 12:36:53 +00001674 PredBB = SplitEdge(PredBB, BB);
Chris Lattnereb73bdb2010-01-12 02:07:17 +00001675 OldPredBranch = cast<BranchInst>(PredBB->getTerminator());
1676 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001677
Chris Lattner97b14052009-10-11 07:24:57 +00001678 // We are going to have to map operands from the original BB block into the
1679 // PredBB block. Evaluate PHI nodes in BB.
1680 DenseMap<Instruction*, Value*> ValueMapping;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001681
Chris Lattner97b14052009-10-11 07:24:57 +00001682 BasicBlock::iterator BI = BB->begin();
1683 for (; PHINode *PN = dyn_cast<PHINode>(BI); ++BI)
1684 ValueMapping[PN] = PN->getIncomingValueForBlock(PredBB);
Chris Lattner97b14052009-10-11 07:24:57 +00001685 // Clone the non-phi instructions of BB into PredBB, keeping track of the
1686 // mapping and using it to remap operands in the cloned instructions.
1687 for (; BI != BB->end(); ++BI) {
1688 Instruction *New = BI->clone();
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001689
Chris Lattner97b14052009-10-11 07:24:57 +00001690 // Remap operands to patch up intra-block references.
1691 for (unsigned i = 0, e = New->getNumOperands(); i != e; ++i)
1692 if (Instruction *Inst = dyn_cast<Instruction>(New->getOperand(i))) {
1693 DenseMap<Instruction*, Value*>::iterator I = ValueMapping.find(Inst);
1694 if (I != ValueMapping.end())
1695 New->setOperand(i, I->second);
1696 }
Chris Lattner573da8a2010-01-12 20:41:47 +00001697
1698 // If this instruction can be simplified after the operands are updated,
1699 // just use the simplified value instead. This frequently happens due to
1700 // phi translation.
Mehdi Aminia28d91d2015-03-10 02:37:25 +00001701 if (Value *IV =
1702 SimplifyInstruction(New, BB->getModule()->getDataLayout())) {
Chris Lattner573da8a2010-01-12 20:41:47 +00001703 delete New;
Duncan P. N. Exon Smith3a9c9e32015-10-13 18:26:00 +00001704 ValueMapping[&*BI] = IV;
Chris Lattner573da8a2010-01-12 20:41:47 +00001705 } else {
1706 // Otherwise, insert the new instruction into the block.
1707 New->setName(BI->getName());
Duncan P. N. Exon Smith3a9c9e32015-10-13 18:26:00 +00001708 PredBB->getInstList().insert(OldPredBranch->getIterator(), New);
1709 ValueMapping[&*BI] = New;
Chris Lattner573da8a2010-01-12 20:41:47 +00001710 }
Chris Lattner97b14052009-10-11 07:24:57 +00001711 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001712
Chris Lattner97b14052009-10-11 07:24:57 +00001713 // Check to see if the targets of the branch had PHI nodes. If so, we need to
1714 // add entries to the PHI nodes for branch from PredBB now.
1715 BranchInst *BBBranch = cast<BranchInst>(BB->getTerminator());
1716 AddPHINodeEntriesForMappedBlock(BBBranch->getSuccessor(0), BB, PredBB,
1717 ValueMapping);
1718 AddPHINodeEntriesForMappedBlock(BBBranch->getSuccessor(1), BB, PredBB,
1719 ValueMapping);
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001720
Chris Lattner97b14052009-10-11 07:24:57 +00001721 // If there were values defined in BB that are used outside the block, then we
1722 // now have to update all uses of the value to use either the original value,
1723 // the cloned value, or some PHI derived value. This can require arbitrary
1724 // PHI insertion, of which we are prepared to do, clean these up now.
1725 SSAUpdater SSAUpdate;
1726 SmallVector<Use*, 16> UsesToRename;
1727 for (BasicBlock::iterator I = BB->begin(); I != BB->end(); ++I) {
1728 // Scan all uses of this instruction to see if it is used outside of its
1729 // block, and if so, record them in UsesToRename.
Chandler Carruthcdf47882014-03-09 03:16:01 +00001730 for (Use &U : I->uses()) {
1731 Instruction *User = cast<Instruction>(U.getUser());
Chris Lattner97b14052009-10-11 07:24:57 +00001732 if (PHINode *UserPN = dyn_cast<PHINode>(User)) {
Chandler Carruthcdf47882014-03-09 03:16:01 +00001733 if (UserPN->getIncomingBlock(U) == BB)
Chris Lattner97b14052009-10-11 07:24:57 +00001734 continue;
1735 } else if (User->getParent() == BB)
1736 continue;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001737
Chandler Carruthcdf47882014-03-09 03:16:01 +00001738 UsesToRename.push_back(&U);
Chris Lattner97b14052009-10-11 07:24:57 +00001739 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001740
Chris Lattner97b14052009-10-11 07:24:57 +00001741 // If there are no uses outside the block, we're done with this instruction.
1742 if (UsesToRename.empty())
1743 continue;
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001744
David Greene1efdb452010-01-05 01:27:19 +00001745 DEBUG(dbgs() << "JT: Renaming non-local uses of: " << *I << "\n");
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001746
Chris Lattner97b14052009-10-11 07:24:57 +00001747 // We found a use of I outside of BB. Rename all uses of I that are outside
1748 // its block to be uses of the appropriate PHI node etc. See ValuesInBlocks
1749 // with the two values we know.
Duncan Sands67781492010-09-02 08:14:03 +00001750 SSAUpdate.Initialize(I->getType(), I->getName());
Duncan P. N. Exon Smith3a9c9e32015-10-13 18:26:00 +00001751 SSAUpdate.AddAvailableValue(BB, &*I);
1752 SSAUpdate.AddAvailableValue(PredBB, ValueMapping[&*I]);
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001753
Chris Lattner97b14052009-10-11 07:24:57 +00001754 while (!UsesToRename.empty())
1755 SSAUpdate.RewriteUse(*UsesToRename.pop_back_val());
David Greene1efdb452010-01-05 01:27:19 +00001756 DEBUG(dbgs() << "\n");
Chris Lattner97b14052009-10-11 07:24:57 +00001757 }
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001758
Chris Lattner97b14052009-10-11 07:24:57 +00001759 // PredBB no longer jumps to BB, remove entries in the PHI node for the edge
1760 // that we nuked.
Owen Anderson99c985c2010-09-29 20:34:41 +00001761 BB->removePredecessor(PredBB, true);
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001762
Chris Lattner97b14052009-10-11 07:24:57 +00001763 // Remove the unconditional branch at the end of the PredBB block.
1764 OldPredBranch->eraseFromParent();
Frits van Bommel5e75ef42010-12-05 19:02:47 +00001765
Chris Lattner97b14052009-10-11 07:24:57 +00001766 ++NumDupes;
1767 return true;
1768}
Benjamin Kramer6a4976d2013-08-07 10:29:38 +00001769
1770/// TryToUnfoldSelect - Look for blocks of the form
1771/// bb1:
1772/// %a = select
1773/// br bb
1774///
1775/// bb2:
1776/// %p = phi [%a, %bb] ...
1777/// %c = icmp %p
1778/// br i1 %c
1779///
1780/// And expand the select into a branch structure if one of its arms allows %c
1781/// to be folded. This later enables threading from bb1 over bb2.
1782bool JumpThreading::TryToUnfoldSelect(CmpInst *CondCmp, BasicBlock *BB) {
1783 BranchInst *CondBr = dyn_cast<BranchInst>(BB->getTerminator());
1784 PHINode *CondLHS = dyn_cast<PHINode>(CondCmp->getOperand(0));
1785 Constant *CondRHS = cast<Constant>(CondCmp->getOperand(1));
1786
1787 if (!CondBr || !CondBr->isConditional() || !CondLHS ||
1788 CondLHS->getParent() != BB)
1789 return false;
1790
1791 for (unsigned I = 0, E = CondLHS->getNumIncomingValues(); I != E; ++I) {
1792 BasicBlock *Pred = CondLHS->getIncomingBlock(I);
1793 SelectInst *SI = dyn_cast<SelectInst>(CondLHS->getIncomingValue(I));
1794
1795 // Look if one of the incoming values is a select in the corresponding
1796 // predecessor.
1797 if (!SI || SI->getParent() != Pred || !SI->hasOneUse())
1798 continue;
1799
1800 BranchInst *PredTerm = dyn_cast<BranchInst>(Pred->getTerminator());
1801 if (!PredTerm || !PredTerm->isUnconditional())
1802 continue;
1803
1804 // Now check if one of the select values would allow us to constant fold the
1805 // terminator in BB. We don't do the transform if both sides fold, those
1806 // cases will be threaded in any case.
1807 LazyValueInfo::Tristate LHSFolds =
1808 LVI->getPredicateOnEdge(CondCmp->getPredicate(), SI->getOperand(1),
Hal Finkel7e184492014-09-07 20:29:59 +00001809 CondRHS, Pred, BB, CondCmp);
Benjamin Kramer6a4976d2013-08-07 10:29:38 +00001810 LazyValueInfo::Tristate RHSFolds =
1811 LVI->getPredicateOnEdge(CondCmp->getPredicate(), SI->getOperand(2),
Hal Finkel7e184492014-09-07 20:29:59 +00001812 CondRHS, Pred, BB, CondCmp);
Benjamin Kramer6a4976d2013-08-07 10:29:38 +00001813 if ((LHSFolds != LazyValueInfo::Unknown ||
1814 RHSFolds != LazyValueInfo::Unknown) &&
1815 LHSFolds != RHSFolds) {
1816 // Expand the select.
1817 //
1818 // Pred --
1819 // | v
1820 // | NewBB
1821 // | |
1822 // |-----
1823 // v
1824 // BB
1825 BasicBlock *NewBB = BasicBlock::Create(BB->getContext(), "select.unfold",
1826 BB->getParent(), BB);
1827 // Move the unconditional branch to NewBB.
1828 PredTerm->removeFromParent();
1829 NewBB->getInstList().insert(NewBB->end(), PredTerm);
1830 // Create a conditional branch and update PHI nodes.
1831 BranchInst::Create(NewBB, BB, SI->getCondition(), Pred);
1832 CondLHS->setIncomingValue(I, SI->getFalseValue());
1833 CondLHS->addIncoming(SI->getTrueValue(), NewBB);
1834 // The select is now dead.
1835 SI->eraseFromParent();
1836
1837 // Update any other PHI nodes in BB.
1838 for (BasicBlock::iterator BI = BB->begin();
1839 PHINode *Phi = dyn_cast<PHINode>(BI); ++BI)
1840 if (Phi != CondLHS)
1841 Phi->addIncoming(Phi->getIncomingValueForBlock(Pred), NewBB);
1842 return true;
1843 }
1844 }
1845 return false;
1846}