blob: ecd1471b4e39317b3e1e116e27f078a47c7cede0 [file] [log] [blame]
Chris Lattner466a0492002-05-21 20:50:24 +00001//===- SimplifyCFG.cpp - Code to perform CFG simplification ---------------===//
Misha Brukmanb1c93172005-04-21 23:48:37 +00002//
John Criswell482202a2003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
5// This file was developed by the LLVM research group and is distributed under
6// the University of Illinois Open Source License. See LICENSE.TXT for details.
Misha Brukmanb1c93172005-04-21 23:48:37 +00007//
John Criswell482202a2003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner466a0492002-05-21 20:50:24 +00009//
Chris Lattnera704ac82002-10-08 21:36:33 +000010// Peephole optimize the CFG.
Chris Lattner466a0492002-05-21 20:50:24 +000011//
12//===----------------------------------------------------------------------===//
13
Chris Lattner9734fd02004-06-20 01:13:18 +000014#define DEBUG_TYPE "simplifycfg"
Chris Lattner466a0492002-05-21 20:50:24 +000015#include "llvm/Transforms/Utils/Local.h"
Chris Lattner18d1f192004-02-11 03:36:04 +000016#include "llvm/Constants.h"
17#include "llvm/Instructions.h"
Chris Lattner6f4b45a2004-02-24 05:38:11 +000018#include "llvm/Type.h"
Chris Lattner466a0492002-05-21 20:50:24 +000019#include "llvm/Support/CFG.h"
Reid Spencer7c16caa2004-09-01 22:55:40 +000020#include "llvm/Support/Debug.h"
Chris Lattner748f9032005-09-19 23:49:37 +000021#include "llvm/Transforms/Utils/BasicBlockUtils.h"
Chris Lattner466a0492002-05-21 20:50:24 +000022#include <algorithm>
23#include <functional>
Chris Lattnera2ab4892004-02-24 07:23:58 +000024#include <set>
Chris Lattner5edb2f32004-10-18 04:07:22 +000025#include <map>
Chris Lattner469640e2006-01-22 22:53:01 +000026#include <iostream>
Chris Lattnerdf3c3422004-01-09 06:12:26 +000027using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +000028
Chris Lattner76dc2042005-08-03 00:19:45 +000029/// SafeToMergeTerminators - Return true if it is safe to merge these two
30/// terminator instructions together.
31///
32static bool SafeToMergeTerminators(TerminatorInst *SI1, TerminatorInst *SI2) {
33 if (SI1 == SI2) return false; // Can't merge with self!
34
35 // It is not safe to merge these two switch instructions if they have a common
36 // successor, and if that successor has a PHI node, and if *that* PHI node has
37 // conflicting incoming values from the two switch blocks.
38 BasicBlock *SI1BB = SI1->getParent();
39 BasicBlock *SI2BB = SI2->getParent();
40 std::set<BasicBlock*> SI1Succs(succ_begin(SI1BB), succ_end(SI1BB));
41
42 for (succ_iterator I = succ_begin(SI2BB), E = succ_end(SI2BB); I != E; ++I)
43 if (SI1Succs.count(*I))
44 for (BasicBlock::iterator BBI = (*I)->begin();
45 isa<PHINode>(BBI); ++BBI) {
46 PHINode *PN = cast<PHINode>(BBI);
47 if (PN->getIncomingValueForBlock(SI1BB) !=
48 PN->getIncomingValueForBlock(SI2BB))
49 return false;
50 }
51
52 return true;
53}
54
55/// AddPredecessorToBlock - Update PHI nodes in Succ to indicate that there will
56/// now be entries in it from the 'NewPred' block. The values that will be
57/// flowing into the PHI nodes will be the same as those coming in from
58/// ExistPred, an existing predecessor of Succ.
59static void AddPredecessorToBlock(BasicBlock *Succ, BasicBlock *NewPred,
60 BasicBlock *ExistPred) {
61 assert(std::find(succ_begin(ExistPred), succ_end(ExistPred), Succ) !=
62 succ_end(ExistPred) && "ExistPred is not a predecessor of Succ!");
63 if (!isa<PHINode>(Succ->begin())) return; // Quick exit if nothing to do
64
65 for (BasicBlock::iterator I = Succ->begin(); isa<PHINode>(I); ++I) {
66 PHINode *PN = cast<PHINode>(I);
67 Value *V = PN->getIncomingValueForBlock(ExistPred);
68 PN->addIncoming(V, NewPred);
69 }
70}
71
Chris Lattner982b75c2005-08-03 00:29:26 +000072// CanPropagatePredecessorsForPHIs - Return true if we can fold BB, an
73// almost-empty BB ending in an unconditional branch to Succ, into succ.
Chris Lattner466a0492002-05-21 20:50:24 +000074//
75// Assumption: Succ is the single successor for BB.
76//
Chris Lattner982b75c2005-08-03 00:29:26 +000077static bool CanPropagatePredecessorsForPHIs(BasicBlock *BB, BasicBlock *Succ) {
Chris Lattner466a0492002-05-21 20:50:24 +000078 assert(*succ_begin(BB) == Succ && "Succ is not successor of BB!");
Chris Lattner5325c5f2002-09-24 00:09:26 +000079
Chris Lattner466a0492002-05-21 20:50:24 +000080 // Check to see if one of the predecessors of BB is already a predecessor of
Chris Lattner31116ba2003-03-05 21:01:52 +000081 // Succ. If so, we cannot do the transformation if there are any PHI nodes
82 // with incompatible values coming in from the two edges!
Chris Lattner466a0492002-05-21 20:50:24 +000083 //
Chris Lattner90803692005-08-03 00:38:27 +000084 if (isa<PHINode>(Succ->front())) {
85 std::set<BasicBlock*> BBPreds(pred_begin(BB), pred_end(BB));
Chris Lattner2820b8c2005-12-03 18:25:58 +000086 for (pred_iterator PI = pred_begin(Succ), PE = pred_end(Succ);
Chris Lattner90803692005-08-03 00:38:27 +000087 PI != PE; ++PI)
88 if (std::find(BBPreds.begin(), BBPreds.end(), *PI) != BBPreds.end()) {
89 // Loop over all of the PHI nodes checking to see if there are
90 // incompatible values coming in.
91 for (BasicBlock::iterator I = Succ->begin(); isa<PHINode>(I); ++I) {
92 PHINode *PN = cast<PHINode>(I);
93 // Loop up the entries in the PHI node for BB and for *PI if the
94 // values coming in are non-equal, we cannot merge these two blocks
95 // (instead we should insert a conditional move or something, then
96 // merge the blocks).
97 if (PN->getIncomingValueForBlock(BB) !=
98 PN->getIncomingValueForBlock(*PI))
99 return false; // Values are not equal...
100 }
101 }
102 }
Chris Lattner2dbf1962005-08-03 00:59:12 +0000103
104 // Finally, if BB has PHI nodes that are used by things other than the PHIs in
105 // Succ and Succ has predecessors that are not Succ and not Pred, we cannot
106 // fold these blocks, as we don't know whether BB dominates Succ or not to
107 // update the PHI nodes correctly.
108 if (!isa<PHINode>(BB->begin()) || Succ->getSinglePredecessor()) return true;
Chris Lattner466a0492002-05-21 20:50:24 +0000109
Chris Lattner2dbf1962005-08-03 00:59:12 +0000110 // If the predecessors of Succ are only BB and Succ itself, we can handle this.
111 bool IsSafe = true;
112 for (pred_iterator PI = pred_begin(Succ), E = pred_end(Succ); PI != E; ++PI)
113 if (*PI != Succ && *PI != BB) {
114 IsSafe = false;
115 break;
116 }
117 if (IsSafe) return true;
118
Chris Lattner2820b8c2005-12-03 18:25:58 +0000119 // If the PHI nodes in BB are only used by instructions in Succ, we are ok if
120 // BB and Succ have no common predecessors.
Chris Lattner35515552006-05-14 18:45:44 +0000121 for (BasicBlock::iterator I = BB->begin(); isa<PHINode>(I); ++I) {
Chris Lattner2dbf1962005-08-03 00:59:12 +0000122 PHINode *PN = cast<PHINode>(I);
123 for (Value::use_iterator UI = PN->use_begin(), E = PN->use_end(); UI != E;
124 ++UI)
Chris Lattner2820b8c2005-12-03 18:25:58 +0000125 if (cast<Instruction>(*UI)->getParent() != Succ)
126 return false;
Chris Lattner2dbf1962005-08-03 00:59:12 +0000127 }
128
Chris Lattner2820b8c2005-12-03 18:25:58 +0000129 // Scan the predecessor sets of BB and Succ, making sure there are no common
130 // predecessors. Common predecessors would cause us to build a phi node with
131 // differing incoming values, which is not legal.
132 std::set<BasicBlock*> BBPreds(pred_begin(BB), pred_end(BB));
133 for (pred_iterator PI = pred_begin(Succ), E = pred_end(Succ); PI != E; ++PI)
134 if (BBPreds.count(*PI))
135 return false;
136
137 return true;
Chris Lattner466a0492002-05-21 20:50:24 +0000138}
139
Chris Lattner733d6702005-08-03 00:11:16 +0000140/// TryToSimplifyUncondBranchFromEmptyBlock - BB contains an unconditional
141/// branch to Succ, and contains no instructions other than PHI nodes and the
142/// branch. If possible, eliminate BB.
143static bool TryToSimplifyUncondBranchFromEmptyBlock(BasicBlock *BB,
144 BasicBlock *Succ) {
145 // If our successor has PHI nodes, then we need to update them to include
146 // entries for BB's predecessors, not for BB itself. Be careful though,
147 // if this transformation fails (returns true) then we cannot do this
148 // transformation!
149 //
Chris Lattner982b75c2005-08-03 00:29:26 +0000150 if (!CanPropagatePredecessorsForPHIs(BB, Succ)) return false;
Chris Lattner733d6702005-08-03 00:11:16 +0000151
152 DEBUG(std::cerr << "Killing Trivial BB: \n" << *BB);
153
Chris Lattner982b75c2005-08-03 00:29:26 +0000154 if (isa<PHINode>(Succ->begin())) {
155 // If there is more than one pred of succ, and there are PHI nodes in
156 // the successor, then we need to add incoming edges for the PHI nodes
157 //
158 const std::vector<BasicBlock*> BBPreds(pred_begin(BB), pred_end(BB));
159
160 // Loop over all of the PHI nodes in the successor of BB.
161 for (BasicBlock::iterator I = Succ->begin(); isa<PHINode>(I); ++I) {
162 PHINode *PN = cast<PHINode>(I);
163 Value *OldVal = PN->removeIncomingValue(BB, false);
164 assert(OldVal && "No entry in PHI for Pred BB!");
165
Chris Lattner90803692005-08-03 00:38:27 +0000166 // If this incoming value is one of the PHI nodes in BB, the new entries
167 // in the PHI node are the entries from the old PHI.
Chris Lattner982b75c2005-08-03 00:29:26 +0000168 if (isa<PHINode>(OldVal) && cast<PHINode>(OldVal)->getParent() == BB) {
169 PHINode *OldValPN = cast<PHINode>(OldVal);
170 for (unsigned i = 0, e = OldValPN->getNumIncomingValues(); i != e; ++i)
171 PN->addIncoming(OldValPN->getIncomingValue(i),
172 OldValPN->getIncomingBlock(i));
173 } else {
174 for (std::vector<BasicBlock*>::const_iterator PredI = BBPreds.begin(),
175 End = BBPreds.end(); PredI != End; ++PredI) {
176 // Add an incoming value for each of the new incoming values...
177 PN->addIncoming(OldVal, *PredI);
178 }
179 }
180 }
181 }
182
Chris Lattner733d6702005-08-03 00:11:16 +0000183 if (isa<PHINode>(&BB->front())) {
184 std::vector<BasicBlock*>
185 OldSuccPreds(pred_begin(Succ), pred_end(Succ));
186
187 // Move all PHI nodes in BB to Succ if they are alive, otherwise
188 // delete them.
189 while (PHINode *PN = dyn_cast<PHINode>(&BB->front()))
Chris Lattner90803692005-08-03 00:38:27 +0000190 if (PN->use_empty()) {
191 // Just remove the dead phi. This happens if Succ's PHIs were the only
192 // users of the PHI nodes.
193 PN->eraseFromParent();
Chris Lattner733d6702005-08-03 00:11:16 +0000194 } else {
195 // The instruction is alive, so this means that Succ must have
196 // *ONLY* had BB as a predecessor, and the PHI node is still valid
197 // now. Simply move it into Succ, because we know that BB
198 // strictly dominated Succ.
Chris Lattner1f047fd2005-08-03 00:23:42 +0000199 Succ->getInstList().splice(Succ->begin(),
200 BB->getInstList(), BB->begin());
Chris Lattner733d6702005-08-03 00:11:16 +0000201
202 // We need to add new entries for the PHI node to account for
203 // predecessors of Succ that the PHI node does not take into
204 // account. At this point, since we know that BB dominated succ,
205 // this means that we should any newly added incoming edges should
206 // use the PHI node as the value for these edges, because they are
207 // loop back edges.
208 for (unsigned i = 0, e = OldSuccPreds.size(); i != e; ++i)
209 if (OldSuccPreds[i] != BB)
210 PN->addIncoming(PN, OldSuccPreds[i]);
211 }
212 }
213
214 // Everything that jumped to BB now goes to Succ.
215 std::string OldName = BB->getName();
216 BB->replaceAllUsesWith(Succ);
217 BB->eraseFromParent(); // Delete the old basic block.
218
219 if (!OldName.empty() && !Succ->hasName()) // Transfer name if we can
220 Succ->setName(OldName);
221 return true;
222}
223
Chris Lattner18d1f192004-02-11 03:36:04 +0000224/// GetIfCondition - Given a basic block (BB) with two predecessors (and
225/// presumably PHI nodes in it), check to see if the merge at this block is due
226/// to an "if condition". If so, return the boolean condition that determines
227/// which entry into BB will be taken. Also, return by references the block
228/// that will be entered from if the condition is true, and the block that will
229/// be entered if the condition is false.
Misha Brukmanb1c93172005-04-21 23:48:37 +0000230///
Chris Lattner18d1f192004-02-11 03:36:04 +0000231///
232static Value *GetIfCondition(BasicBlock *BB,
233 BasicBlock *&IfTrue, BasicBlock *&IfFalse) {
234 assert(std::distance(pred_begin(BB), pred_end(BB)) == 2 &&
235 "Function can only handle blocks with 2 predecessors!");
236 BasicBlock *Pred1 = *pred_begin(BB);
237 BasicBlock *Pred2 = *++pred_begin(BB);
238
239 // We can only handle branches. Other control flow will be lowered to
240 // branches if possible anyway.
241 if (!isa<BranchInst>(Pred1->getTerminator()) ||
242 !isa<BranchInst>(Pred2->getTerminator()))
243 return 0;
244 BranchInst *Pred1Br = cast<BranchInst>(Pred1->getTerminator());
245 BranchInst *Pred2Br = cast<BranchInst>(Pred2->getTerminator());
246
247 // Eliminate code duplication by ensuring that Pred1Br is conditional if
248 // either are.
249 if (Pred2Br->isConditional()) {
250 // If both branches are conditional, we don't have an "if statement". In
251 // reality, we could transform this case, but since the condition will be
252 // required anyway, we stand no chance of eliminating it, so the xform is
253 // probably not profitable.
254 if (Pred1Br->isConditional())
255 return 0;
256
257 std::swap(Pred1, Pred2);
258 std::swap(Pred1Br, Pred2Br);
259 }
260
261 if (Pred1Br->isConditional()) {
262 // If we found a conditional branch predecessor, make sure that it branches
263 // to BB and Pred2Br. If it doesn't, this isn't an "if statement".
264 if (Pred1Br->getSuccessor(0) == BB &&
265 Pred1Br->getSuccessor(1) == Pred2) {
266 IfTrue = Pred1;
267 IfFalse = Pred2;
268 } else if (Pred1Br->getSuccessor(0) == Pred2 &&
269 Pred1Br->getSuccessor(1) == BB) {
270 IfTrue = Pred2;
271 IfFalse = Pred1;
272 } else {
273 // We know that one arm of the conditional goes to BB, so the other must
274 // go somewhere unrelated, and this must not be an "if statement".
275 return 0;
276 }
277
278 // The only thing we have to watch out for here is to make sure that Pred2
279 // doesn't have incoming edges from other blocks. If it does, the condition
280 // doesn't dominate BB.
281 if (++pred_begin(Pred2) != pred_end(Pred2))
282 return 0;
283
284 return Pred1Br->getCondition();
285 }
286
287 // Ok, if we got here, both predecessors end with an unconditional branch to
288 // BB. Don't panic! If both blocks only have a single (identical)
289 // predecessor, and THAT is a conditional branch, then we're all ok!
290 if (pred_begin(Pred1) == pred_end(Pred1) ||
291 ++pred_begin(Pred1) != pred_end(Pred1) ||
292 pred_begin(Pred2) == pred_end(Pred2) ||
293 ++pred_begin(Pred2) != pred_end(Pred2) ||
294 *pred_begin(Pred1) != *pred_begin(Pred2))
295 return 0;
296
297 // Otherwise, if this is a conditional branch, then we can use it!
298 BasicBlock *CommonPred = *pred_begin(Pred1);
299 if (BranchInst *BI = dyn_cast<BranchInst>(CommonPred->getTerminator())) {
300 assert(BI->isConditional() && "Two successors but not conditional?");
301 if (BI->getSuccessor(0) == Pred1) {
302 IfTrue = Pred1;
303 IfFalse = Pred2;
304 } else {
305 IfTrue = Pred2;
306 IfFalse = Pred1;
307 }
308 return BI->getCondition();
309 }
310 return 0;
311}
312
313
314// If we have a merge point of an "if condition" as accepted above, return true
315// if the specified value dominates the block. We don't handle the true
316// generality of domination here, just a special case which works well enough
317// for us.
Chris Lattner45c35b12004-10-14 05:13:36 +0000318//
319// If AggressiveInsts is non-null, and if V does not dominate BB, we check to
320// see if V (which must be an instruction) is cheap to compute and is
321// non-trapping. If both are true, the instruction is inserted into the set and
322// true is returned.
323static bool DominatesMergePoint(Value *V, BasicBlock *BB,
324 std::set<Instruction*> *AggressiveInsts) {
Chris Lattner0aa56562004-04-09 22:50:22 +0000325 Instruction *I = dyn_cast<Instruction>(V);
326 if (!I) return true; // Non-instructions all dominate instructions.
327 BasicBlock *PBB = I->getParent();
Chris Lattner18d1f192004-02-11 03:36:04 +0000328
Chris Lattner0ce80cd2005-02-27 06:18:25 +0000329 // We don't want to allow weird loops that might have the "if condition" in
Chris Lattner0aa56562004-04-09 22:50:22 +0000330 // the bottom of this block.
331 if (PBB == BB) return false;
Chris Lattner18d1f192004-02-11 03:36:04 +0000332
Chris Lattner0aa56562004-04-09 22:50:22 +0000333 // If this instruction is defined in a block that contains an unconditional
334 // branch to BB, then it must be in the 'conditional' part of the "if
335 // statement".
336 if (BranchInst *BI = dyn_cast<BranchInst>(PBB->getTerminator()))
337 if (BI->isUnconditional() && BI->getSuccessor(0) == BB) {
Chris Lattner45c35b12004-10-14 05:13:36 +0000338 if (!AggressiveInsts) return false;
Chris Lattner0aa56562004-04-09 22:50:22 +0000339 // Okay, it looks like the instruction IS in the "condition". Check to
340 // see if its a cheap instruction to unconditionally compute, and if it
341 // only uses stuff defined outside of the condition. If so, hoist it out.
342 switch (I->getOpcode()) {
343 default: return false; // Cannot hoist this out safely.
344 case Instruction::Load:
345 // We can hoist loads that are non-volatile and obviously cannot trap.
346 if (cast<LoadInst>(I)->isVolatile())
347 return false;
348 if (!isa<AllocaInst>(I->getOperand(0)) &&
Reid Spenceref784f02004-07-18 00:32:14 +0000349 !isa<Constant>(I->getOperand(0)))
Chris Lattner0aa56562004-04-09 22:50:22 +0000350 return false;
351
352 // Finally, we have to check to make sure there are no instructions
353 // before the load in its basic block, as we are going to hoist the loop
354 // out to its predecessor.
355 if (PBB->begin() != BasicBlock::iterator(I))
356 return false;
357 break;
358 case Instruction::Add:
359 case Instruction::Sub:
360 case Instruction::And:
361 case Instruction::Or:
362 case Instruction::Xor:
363 case Instruction::Shl:
364 case Instruction::Shr:
Chris Lattnerb38b4432005-04-21 05:31:13 +0000365 case Instruction::SetEQ:
366 case Instruction::SetNE:
367 case Instruction::SetLT:
368 case Instruction::SetGT:
369 case Instruction::SetLE:
370 case Instruction::SetGE:
Chris Lattner0aa56562004-04-09 22:50:22 +0000371 break; // These are all cheap and non-trapping instructions.
372 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000373
Chris Lattner0aa56562004-04-09 22:50:22 +0000374 // Okay, we can only really hoist these out if their operands are not
375 // defined in the conditional region.
376 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
Chris Lattner45c35b12004-10-14 05:13:36 +0000377 if (!DominatesMergePoint(I->getOperand(i), BB, 0))
Chris Lattner0aa56562004-04-09 22:50:22 +0000378 return false;
Chris Lattner45c35b12004-10-14 05:13:36 +0000379 // Okay, it's safe to do this! Remember this instruction.
380 AggressiveInsts->insert(I);
Chris Lattner0aa56562004-04-09 22:50:22 +0000381 }
382
Chris Lattner18d1f192004-02-11 03:36:04 +0000383 return true;
384}
Chris Lattner466a0492002-05-21 20:50:24 +0000385
Chris Lattner6f4b45a2004-02-24 05:38:11 +0000386// GatherConstantSetEQs - Given a potentially 'or'd together collection of seteq
387// instructions that compare a value against a constant, return the value being
388// compared, and stick the constant into the Values vector.
Chris Lattnerb2b151d2004-06-19 07:02:14 +0000389static Value *GatherConstantSetEQs(Value *V, std::vector<ConstantInt*> &Values){
Chris Lattner6f4b45a2004-02-24 05:38:11 +0000390 if (Instruction *Inst = dyn_cast<Instruction>(V))
391 if (Inst->getOpcode() == Instruction::SetEQ) {
Chris Lattnerb2b151d2004-06-19 07:02:14 +0000392 if (ConstantInt *C = dyn_cast<ConstantInt>(Inst->getOperand(1))) {
Chris Lattner6f4b45a2004-02-24 05:38:11 +0000393 Values.push_back(C);
394 return Inst->getOperand(0);
Chris Lattnerb2b151d2004-06-19 07:02:14 +0000395 } else if (ConstantInt *C = dyn_cast<ConstantInt>(Inst->getOperand(0))) {
Chris Lattner6f4b45a2004-02-24 05:38:11 +0000396 Values.push_back(C);
397 return Inst->getOperand(1);
398 }
399 } else if (Inst->getOpcode() == Instruction::Or) {
400 if (Value *LHS = GatherConstantSetEQs(Inst->getOperand(0), Values))
401 if (Value *RHS = GatherConstantSetEQs(Inst->getOperand(1), Values))
402 if (LHS == RHS)
403 return LHS;
404 }
405 return 0;
406}
407
408// GatherConstantSetNEs - Given a potentially 'and'd together collection of
409// setne instructions that compare a value against a constant, return the value
410// being compared, and stick the constant into the Values vector.
Chris Lattnerb2b151d2004-06-19 07:02:14 +0000411static Value *GatherConstantSetNEs(Value *V, std::vector<ConstantInt*> &Values){
Chris Lattner6f4b45a2004-02-24 05:38:11 +0000412 if (Instruction *Inst = dyn_cast<Instruction>(V))
413 if (Inst->getOpcode() == Instruction::SetNE) {
Chris Lattnerb2b151d2004-06-19 07:02:14 +0000414 if (ConstantInt *C = dyn_cast<ConstantInt>(Inst->getOperand(1))) {
Chris Lattner6f4b45a2004-02-24 05:38:11 +0000415 Values.push_back(C);
416 return Inst->getOperand(0);
Chris Lattnerb2b151d2004-06-19 07:02:14 +0000417 } else if (ConstantInt *C = dyn_cast<ConstantInt>(Inst->getOperand(0))) {
Chris Lattner6f4b45a2004-02-24 05:38:11 +0000418 Values.push_back(C);
419 return Inst->getOperand(1);
420 }
421 } else if (Inst->getOpcode() == Instruction::Cast) {
422 // Cast of X to bool is really a comparison against zero.
423 assert(Inst->getType() == Type::BoolTy && "Can only handle bool values!");
Chris Lattnerb2b151d2004-06-19 07:02:14 +0000424 Values.push_back(ConstantInt::get(Inst->getOperand(0)->getType(), 0));
Chris Lattner6f4b45a2004-02-24 05:38:11 +0000425 return Inst->getOperand(0);
426 } else if (Inst->getOpcode() == Instruction::And) {
427 if (Value *LHS = GatherConstantSetNEs(Inst->getOperand(0), Values))
428 if (Value *RHS = GatherConstantSetNEs(Inst->getOperand(1), Values))
429 if (LHS == RHS)
430 return LHS;
431 }
432 return 0;
433}
434
435
436
437/// GatherValueComparisons - If the specified Cond is an 'and' or 'or' of a
438/// bunch of comparisons of one value against constants, return the value and
439/// the constants being compared.
440static bool GatherValueComparisons(Instruction *Cond, Value *&CompVal,
Chris Lattnerb2b151d2004-06-19 07:02:14 +0000441 std::vector<ConstantInt*> &Values) {
Chris Lattner6f4b45a2004-02-24 05:38:11 +0000442 if (Cond->getOpcode() == Instruction::Or) {
443 CompVal = GatherConstantSetEQs(Cond, Values);
444
445 // Return true to indicate that the condition is true if the CompVal is
446 // equal to one of the constants.
447 return true;
448 } else if (Cond->getOpcode() == Instruction::And) {
449 CompVal = GatherConstantSetNEs(Cond, Values);
Misha Brukmanb1c93172005-04-21 23:48:37 +0000450
Chris Lattner6f4b45a2004-02-24 05:38:11 +0000451 // Return false to indicate that the condition is false if the CompVal is
452 // equal to one of the constants.
453 return false;
454 }
455 return false;
456}
457
458/// ErasePossiblyDeadInstructionTree - If the specified instruction is dead and
459/// has no side effects, nuke it. If it uses any instructions that become dead
460/// because the instruction is now gone, nuke them too.
461static void ErasePossiblyDeadInstructionTree(Instruction *I) {
462 if (isInstructionTriviallyDead(I)) {
463 std::vector<Value*> Operands(I->op_begin(), I->op_end());
464 I->getParent()->getInstList().erase(I);
465 for (unsigned i = 0, e = Operands.size(); i != e; ++i)
466 if (Instruction *OpI = dyn_cast<Instruction>(Operands[i]))
467 ErasePossiblyDeadInstructionTree(OpI);
468 }
469}
470
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000471// isValueEqualityComparison - Return true if the specified terminator checks to
472// see if a value is equal to constant integer value.
473static Value *isValueEqualityComparison(TerminatorInst *TI) {
Chris Lattnera64923a2004-03-16 19:45:22 +0000474 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
475 // Do not permit merging of large switch instructions into their
476 // predecessors unless there is only one predecessor.
477 if (SI->getNumSuccessors() * std::distance(pred_begin(SI->getParent()),
478 pred_end(SI->getParent())) > 128)
479 return 0;
480
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000481 return SI->getCondition();
Chris Lattnera64923a2004-03-16 19:45:22 +0000482 }
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000483 if (BranchInst *BI = dyn_cast<BranchInst>(TI))
484 if (BI->isConditional() && BI->getCondition()->hasOneUse())
485 if (SetCondInst *SCI = dyn_cast<SetCondInst>(BI->getCondition()))
486 if ((SCI->getOpcode() == Instruction::SetEQ ||
Misha Brukmanb1c93172005-04-21 23:48:37 +0000487 SCI->getOpcode() == Instruction::SetNE) &&
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000488 isa<ConstantInt>(SCI->getOperand(1)))
489 return SCI->getOperand(0);
490 return 0;
491}
492
493// Given a value comparison instruction, decode all of the 'cases' that it
494// represents and return the 'default' block.
495static BasicBlock *
Misha Brukmanb1c93172005-04-21 23:48:37 +0000496GetValueEqualityComparisonCases(TerminatorInst *TI,
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000497 std::vector<std::pair<ConstantInt*,
498 BasicBlock*> > &Cases) {
499 if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
500 Cases.reserve(SI->getNumCases());
501 for (unsigned i = 1, e = SI->getNumCases(); i != e; ++i)
Chris Lattnercc6d75f2005-02-26 18:33:28 +0000502 Cases.push_back(std::make_pair(SI->getCaseValue(i), SI->getSuccessor(i)));
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000503 return SI->getDefaultDest();
504 }
505
506 BranchInst *BI = cast<BranchInst>(TI);
507 SetCondInst *SCI = cast<SetCondInst>(BI->getCondition());
508 Cases.push_back(std::make_pair(cast<ConstantInt>(SCI->getOperand(1)),
509 BI->getSuccessor(SCI->getOpcode() ==
510 Instruction::SetNE)));
511 return BI->getSuccessor(SCI->getOpcode() == Instruction::SetEQ);
512}
513
514
Chris Lattner1cca9592005-02-24 06:17:52 +0000515// EliminateBlockCases - Given an vector of bb/value pairs, remove any entries
516// in the list that match the specified block.
Misha Brukmanb1c93172005-04-21 23:48:37 +0000517static void EliminateBlockCases(BasicBlock *BB,
Chris Lattner1cca9592005-02-24 06:17:52 +0000518 std::vector<std::pair<ConstantInt*, BasicBlock*> > &Cases) {
519 for (unsigned i = 0, e = Cases.size(); i != e; ++i)
520 if (Cases[i].second == BB) {
521 Cases.erase(Cases.begin()+i);
522 --i; --e;
523 }
524}
525
526// ValuesOverlap - Return true if there are any keys in C1 that exist in C2 as
527// well.
528static bool
529ValuesOverlap(std::vector<std::pair<ConstantInt*, BasicBlock*> > &C1,
530 std::vector<std::pair<ConstantInt*, BasicBlock*> > &C2) {
531 std::vector<std::pair<ConstantInt*, BasicBlock*> > *V1 = &C1, *V2 = &C2;
532
533 // Make V1 be smaller than V2.
534 if (V1->size() > V2->size())
535 std::swap(V1, V2);
536
537 if (V1->size() == 0) return false;
538 if (V1->size() == 1) {
539 // Just scan V2.
540 ConstantInt *TheVal = (*V1)[0].first;
541 for (unsigned i = 0, e = V2->size(); i != e; ++i)
542 if (TheVal == (*V2)[i].first)
543 return true;
544 }
545
546 // Otherwise, just sort both lists and compare element by element.
547 std::sort(V1->begin(), V1->end());
548 std::sort(V2->begin(), V2->end());
549 unsigned i1 = 0, i2 = 0, e1 = V1->size(), e2 = V2->size();
550 while (i1 != e1 && i2 != e2) {
551 if ((*V1)[i1].first == (*V2)[i2].first)
552 return true;
553 if ((*V1)[i1].first < (*V2)[i2].first)
554 ++i1;
555 else
556 ++i2;
557 }
558 return false;
559}
560
561// SimplifyEqualityComparisonWithOnlyPredecessor - If TI is known to be a
562// terminator instruction and its block is known to only have a single
563// predecessor block, check to see if that predecessor is also a value
564// comparison with the same value, and if that comparison determines the outcome
565// of this comparison. If so, simplify TI. This does a very limited form of
566// jump threading.
567static bool SimplifyEqualityComparisonWithOnlyPredecessor(TerminatorInst *TI,
568 BasicBlock *Pred) {
569 Value *PredVal = isValueEqualityComparison(Pred->getTerminator());
570 if (!PredVal) return false; // Not a value comparison in predecessor.
571
572 Value *ThisVal = isValueEqualityComparison(TI);
573 assert(ThisVal && "This isn't a value comparison!!");
574 if (ThisVal != PredVal) return false; // Different predicates.
575
576 // Find out information about when control will move from Pred to TI's block.
577 std::vector<std::pair<ConstantInt*, BasicBlock*> > PredCases;
578 BasicBlock *PredDef = GetValueEqualityComparisonCases(Pred->getTerminator(),
579 PredCases);
580 EliminateBlockCases(PredDef, PredCases); // Remove default from cases.
Misha Brukmanb1c93172005-04-21 23:48:37 +0000581
Chris Lattner1cca9592005-02-24 06:17:52 +0000582 // Find information about how control leaves this block.
583 std::vector<std::pair<ConstantInt*, BasicBlock*> > ThisCases;
584 BasicBlock *ThisDef = GetValueEqualityComparisonCases(TI, ThisCases);
585 EliminateBlockCases(ThisDef, ThisCases); // Remove default from cases.
586
587 // If TI's block is the default block from Pred's comparison, potentially
588 // simplify TI based on this knowledge.
589 if (PredDef == TI->getParent()) {
590 // If we are here, we know that the value is none of those cases listed in
591 // PredCases. If there are any cases in ThisCases that are in PredCases, we
592 // can simplify TI.
593 if (ValuesOverlap(PredCases, ThisCases)) {
594 if (BranchInst *BTI = dyn_cast<BranchInst>(TI)) {
595 // Okay, one of the successors of this condbr is dead. Convert it to a
596 // uncond br.
597 assert(ThisCases.size() == 1 && "Branch can only have one case!");
598 Value *Cond = BTI->getCondition();
599 // Insert the new branch.
600 Instruction *NI = new BranchInst(ThisDef, TI);
601
602 // Remove PHI node entries for the dead edge.
603 ThisCases[0].second->removePredecessor(TI->getParent());
604
605 DEBUG(std::cerr << "Threading pred instr: " << *Pred->getTerminator()
606 << "Through successor TI: " << *TI << "Leaving: " << *NI << "\n");
607
608 TI->eraseFromParent(); // Nuke the old one.
609 // If condition is now dead, nuke it.
610 if (Instruction *CondI = dyn_cast<Instruction>(Cond))
611 ErasePossiblyDeadInstructionTree(CondI);
612 return true;
613
614 } else {
615 SwitchInst *SI = cast<SwitchInst>(TI);
616 // Okay, TI has cases that are statically dead, prune them away.
617 std::set<Constant*> DeadCases;
618 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
619 DeadCases.insert(PredCases[i].first);
620
621 DEBUG(std::cerr << "Threading pred instr: " << *Pred->getTerminator()
622 << "Through successor TI: " << *TI);
623
624 for (unsigned i = SI->getNumCases()-1; i != 0; --i)
625 if (DeadCases.count(SI->getCaseValue(i))) {
626 SI->getSuccessor(i)->removePredecessor(TI->getParent());
627 SI->removeCase(i);
628 }
629
630 DEBUG(std::cerr << "Leaving: " << *TI << "\n");
631 return true;
632 }
633 }
634
635 } else {
636 // Otherwise, TI's block must correspond to some matched value. Find out
637 // which value (or set of values) this is.
638 ConstantInt *TIV = 0;
639 BasicBlock *TIBB = TI->getParent();
640 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
641 if (PredCases[i].second == TIBB)
642 if (TIV == 0)
643 TIV = PredCases[i].first;
644 else
645 return false; // Cannot handle multiple values coming to this block.
646 assert(TIV && "No edge from pred to succ?");
647
648 // Okay, we found the one constant that our value can be if we get into TI's
649 // BB. Find out which successor will unconditionally be branched to.
650 BasicBlock *TheRealDest = 0;
651 for (unsigned i = 0, e = ThisCases.size(); i != e; ++i)
652 if (ThisCases[i].first == TIV) {
653 TheRealDest = ThisCases[i].second;
654 break;
655 }
656
657 // If not handled by any explicit cases, it is handled by the default case.
658 if (TheRealDest == 0) TheRealDest = ThisDef;
659
660 // Remove PHI node entries for dead edges.
661 BasicBlock *CheckEdge = TheRealDest;
662 for (succ_iterator SI = succ_begin(TIBB), e = succ_end(TIBB); SI != e; ++SI)
663 if (*SI != CheckEdge)
664 (*SI)->removePredecessor(TIBB);
665 else
666 CheckEdge = 0;
667
668 // Insert the new branch.
669 Instruction *NI = new BranchInst(TheRealDest, TI);
670
671 DEBUG(std::cerr << "Threading pred instr: " << *Pred->getTerminator()
672 << "Through successor TI: " << *TI << "Leaving: " << *NI << "\n");
673 Instruction *Cond = 0;
674 if (BranchInst *BI = dyn_cast<BranchInst>(TI))
675 Cond = dyn_cast<Instruction>(BI->getCondition());
676 TI->eraseFromParent(); // Nuke the old one.
677
678 if (Cond) ErasePossiblyDeadInstructionTree(Cond);
679 return true;
680 }
681 return false;
682}
683
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000684// FoldValueComparisonIntoPredecessors - The specified terminator is a value
685// equality comparison instruction (either a switch or a branch on "X == c").
686// See if any of the predecessors of the terminator block are value comparisons
687// on the same value. If so, and if safe to do so, fold them together.
688static bool FoldValueComparisonIntoPredecessors(TerminatorInst *TI) {
689 BasicBlock *BB = TI->getParent();
690 Value *CV = isValueEqualityComparison(TI); // CondVal
691 assert(CV && "Not a comparison?");
692 bool Changed = false;
693
694 std::vector<BasicBlock*> Preds(pred_begin(BB), pred_end(BB));
695 while (!Preds.empty()) {
696 BasicBlock *Pred = Preds.back();
697 Preds.pop_back();
Misha Brukmanb1c93172005-04-21 23:48:37 +0000698
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000699 // See if the predecessor is a comparison with the same value.
700 TerminatorInst *PTI = Pred->getTerminator();
701 Value *PCV = isValueEqualityComparison(PTI); // PredCondVal
702
703 if (PCV == CV && SafeToMergeTerminators(TI, PTI)) {
704 // Figure out which 'cases' to copy from SI to PSI.
705 std::vector<std::pair<ConstantInt*, BasicBlock*> > BBCases;
706 BasicBlock *BBDefault = GetValueEqualityComparisonCases(TI, BBCases);
707
708 std::vector<std::pair<ConstantInt*, BasicBlock*> > PredCases;
709 BasicBlock *PredDefault = GetValueEqualityComparisonCases(PTI, PredCases);
710
711 // Based on whether the default edge from PTI goes to BB or not, fill in
712 // PredCases and PredDefault with the new switch cases we would like to
713 // build.
714 std::vector<BasicBlock*> NewSuccessors;
715
716 if (PredDefault == BB) {
717 // If this is the default destination from PTI, only the edges in TI
718 // that don't occur in PTI, or that branch to BB will be activated.
719 std::set<ConstantInt*> PTIHandled;
720 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
721 if (PredCases[i].second != BB)
722 PTIHandled.insert(PredCases[i].first);
723 else {
724 // The default destination is BB, we don't need explicit targets.
725 std::swap(PredCases[i], PredCases.back());
726 PredCases.pop_back();
727 --i; --e;
728 }
729
730 // Reconstruct the new switch statement we will be building.
731 if (PredDefault != BBDefault) {
732 PredDefault->removePredecessor(Pred);
733 PredDefault = BBDefault;
734 NewSuccessors.push_back(BBDefault);
735 }
736 for (unsigned i = 0, e = BBCases.size(); i != e; ++i)
737 if (!PTIHandled.count(BBCases[i].first) &&
738 BBCases[i].second != BBDefault) {
739 PredCases.push_back(BBCases[i]);
740 NewSuccessors.push_back(BBCases[i].second);
741 }
742
743 } else {
744 // If this is not the default destination from PSI, only the edges
745 // in SI that occur in PSI with a destination of BB will be
746 // activated.
747 std::set<ConstantInt*> PTIHandled;
748 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
749 if (PredCases[i].second == BB) {
750 PTIHandled.insert(PredCases[i].first);
751 std::swap(PredCases[i], PredCases.back());
752 PredCases.pop_back();
753 --i; --e;
754 }
755
756 // Okay, now we know which constants were sent to BB from the
757 // predecessor. Figure out where they will all go now.
758 for (unsigned i = 0, e = BBCases.size(); i != e; ++i)
759 if (PTIHandled.count(BBCases[i].first)) {
760 // If this is one we are capable of getting...
761 PredCases.push_back(BBCases[i]);
762 NewSuccessors.push_back(BBCases[i].second);
763 PTIHandled.erase(BBCases[i].first);// This constant is taken care of
764 }
765
766 // If there are any constants vectored to BB that TI doesn't handle,
767 // they must go to the default destination of TI.
768 for (std::set<ConstantInt*>::iterator I = PTIHandled.begin(),
769 E = PTIHandled.end(); I != E; ++I) {
770 PredCases.push_back(std::make_pair(*I, BBDefault));
771 NewSuccessors.push_back(BBDefault);
772 }
773 }
774
775 // Okay, at this point, we know which new successor Pred will get. Make
776 // sure we update the number of entries in the PHI nodes for these
777 // successors.
778 for (unsigned i = 0, e = NewSuccessors.size(); i != e; ++i)
779 AddPredecessorToBlock(NewSuccessors[i], Pred, BB);
780
781 // Now that the successors are updated, create the new Switch instruction.
Chris Lattnera35dfce2005-01-29 00:38:26 +0000782 SwitchInst *NewSI = new SwitchInst(CV, PredDefault, PredCases.size(),PTI);
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000783 for (unsigned i = 0, e = PredCases.size(); i != e; ++i)
784 NewSI->addCase(PredCases[i].first, PredCases[i].second);
Chris Lattner3215bb62005-01-01 16:02:12 +0000785
786 Instruction *DeadCond = 0;
787 if (BranchInst *BI = dyn_cast<BranchInst>(PTI))
788 // If PTI is a branch, remember the condition.
789 DeadCond = dyn_cast<Instruction>(BI->getCondition());
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000790 Pred->getInstList().erase(PTI);
791
Chris Lattner3215bb62005-01-01 16:02:12 +0000792 // If the condition is dead now, remove the instruction tree.
793 if (DeadCond) ErasePossiblyDeadInstructionTree(DeadCond);
794
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000795 // Okay, last check. If BB is still a successor of PSI, then we must
796 // have an infinite loop case. If so, add an infinitely looping block
797 // to handle the case to preserve the behavior of the code.
798 BasicBlock *InfLoopBlock = 0;
799 for (unsigned i = 0, e = NewSI->getNumSuccessors(); i != e; ++i)
800 if (NewSI->getSuccessor(i) == BB) {
801 if (InfLoopBlock == 0) {
802 // Insert it at the end of the loop, because it's either code,
803 // or it won't matter if it's hot. :)
804 InfLoopBlock = new BasicBlock("infloop", BB->getParent());
805 new BranchInst(InfLoopBlock, InfLoopBlock);
806 }
807 NewSI->setSuccessor(i, InfLoopBlock);
808 }
Misha Brukmanb1c93172005-04-21 23:48:37 +0000809
Chris Lattnerd3e6ae22004-02-28 21:28:10 +0000810 Changed = true;
811 }
812 }
813 return Changed;
814}
815
Chris Lattnerd683bdd2005-08-03 17:59:45 +0000816/// HoistThenElseCodeToIf - Given a conditional branch that goes to BB1 and
Chris Lattner389cfac2004-11-30 00:29:14 +0000817/// BB2, hoist any common code in the two blocks up into the branch block. The
818/// caller of this function guarantees that BI's block dominates BB1 and BB2.
819static bool HoistThenElseCodeToIf(BranchInst *BI) {
820 // This does very trivial matching, with limited scanning, to find identical
821 // instructions in the two blocks. In particular, we don't want to get into
822 // O(M*N) situations here where M and N are the sizes of BB1 and BB2. As
823 // such, we currently just scan for obviously identical instructions in an
824 // identical order.
825 BasicBlock *BB1 = BI->getSuccessor(0); // The true destination.
826 BasicBlock *BB2 = BI->getSuccessor(1); // The false destination
827
828 Instruction *I1 = BB1->begin(), *I2 = BB2->begin();
Chris Lattnerd683bdd2005-08-03 17:59:45 +0000829 if (I1->getOpcode() != I2->getOpcode() || !I1->isIdenticalTo(I2) ||
830 isa<PHINode>(I1))
Chris Lattner389cfac2004-11-30 00:29:14 +0000831 return false;
832
833 // If we get here, we can hoist at least one instruction.
834 BasicBlock *BIParent = BI->getParent();
Chris Lattner389cfac2004-11-30 00:29:14 +0000835
836 do {
837 // If we are hoisting the terminator instruction, don't move one (making a
838 // broken BB), instead clone it, and remove BI.
839 if (isa<TerminatorInst>(I1))
840 goto HoistTerminator;
Misha Brukmanb1c93172005-04-21 23:48:37 +0000841
Chris Lattner389cfac2004-11-30 00:29:14 +0000842 // For a normal instruction, we just move one to right before the branch,
843 // then replace all uses of the other with the first. Finally, we remove
844 // the now redundant second instruction.
845 BIParent->getInstList().splice(BI, BB1->getInstList(), I1);
846 if (!I2->use_empty())
847 I2->replaceAllUsesWith(I1);
848 BB2->getInstList().erase(I2);
Misha Brukmanb1c93172005-04-21 23:48:37 +0000849
Chris Lattner389cfac2004-11-30 00:29:14 +0000850 I1 = BB1->begin();
851 I2 = BB2->begin();
Chris Lattner389cfac2004-11-30 00:29:14 +0000852 } while (I1->getOpcode() == I2->getOpcode() && I1->isIdenticalTo(I2));
853
854 return true;
855
856HoistTerminator:
857 // Okay, it is safe to hoist the terminator.
858 Instruction *NT = I1->clone();
859 BIParent->getInstList().insert(BI, NT);
860 if (NT->getType() != Type::VoidTy) {
861 I1->replaceAllUsesWith(NT);
862 I2->replaceAllUsesWith(NT);
863 NT->setName(I1->getName());
864 }
865
866 // Hoisting one of the terminators from our successor is a great thing.
867 // Unfortunately, the successors of the if/else blocks may have PHI nodes in
868 // them. If they do, all PHI entries for BB1/BB2 must agree for all PHI
869 // nodes, so we insert select instruction to compute the final result.
870 std::map<std::pair<Value*,Value*>, SelectInst*> InsertedSelects;
871 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI) {
872 PHINode *PN;
873 for (BasicBlock::iterator BBI = SI->begin();
Chris Lattner01944572004-11-30 07:47:34 +0000874 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
Chris Lattner389cfac2004-11-30 00:29:14 +0000875 Value *BB1V = PN->getIncomingValueForBlock(BB1);
876 Value *BB2V = PN->getIncomingValueForBlock(BB2);
877 if (BB1V != BB2V) {
878 // These values do not agree. Insert a select instruction before NT
879 // that determines the right value.
880 SelectInst *&SI = InsertedSelects[std::make_pair(BB1V, BB2V)];
881 if (SI == 0)
882 SI = new SelectInst(BI->getCondition(), BB1V, BB2V,
883 BB1V->getName()+"."+BB2V->getName(), NT);
884 // Make the PHI node use the select for all incoming values for BB1/BB2
885 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
886 if (PN->getIncomingBlock(i) == BB1 || PN->getIncomingBlock(i) == BB2)
887 PN->setIncomingValue(i, SI);
888 }
889 }
890 }
891
892 // Update any PHI nodes in our new successors.
893 for (succ_iterator SI = succ_begin(BB1), E = succ_end(BB1); SI != E; ++SI)
894 AddPredecessorToBlock(*SI, BIParent, BB1);
Misha Brukmanb1c93172005-04-21 23:48:37 +0000895
Chris Lattner389cfac2004-11-30 00:29:14 +0000896 BI->eraseFromParent();
897 return true;
898}
899
Chris Lattnerf0bd8d02005-09-20 00:43:16 +0000900/// BlockIsSimpleEnoughToThreadThrough - Return true if we can thread a branch
901/// across this block.
902static bool BlockIsSimpleEnoughToThreadThrough(BasicBlock *BB) {
903 BranchInst *BI = cast<BranchInst>(BB->getTerminator());
Chris Lattner6c701062005-09-20 01:48:40 +0000904 unsigned Size = 0;
905
Chris Lattnerf0bd8d02005-09-20 00:43:16 +0000906 // If this basic block contains anything other than a PHI (which controls the
907 // branch) and branch itself, bail out. FIXME: improve this in the future.
Chris Lattner6c701062005-09-20 01:48:40 +0000908 for (BasicBlock::iterator BBI = BB->begin(); &*BBI != BI; ++BBI, ++Size) {
909 if (Size > 10) return false; // Don't clone large BB's.
Chris Lattnerf0bd8d02005-09-20 00:43:16 +0000910
Chris Lattner6c701062005-09-20 01:48:40 +0000911 // We can only support instructions that are do not define values that are
912 // live outside of the current basic block.
913 for (Value::use_iterator UI = BBI->use_begin(), E = BBI->use_end();
914 UI != E; ++UI) {
915 Instruction *U = cast<Instruction>(*UI);
916 if (U->getParent() != BB || isa<PHINode>(U)) return false;
917 }
Chris Lattnerf0bd8d02005-09-20 00:43:16 +0000918
919 // Looks ok, continue checking.
920 }
Chris Lattner6c701062005-09-20 01:48:40 +0000921
Chris Lattnerf0bd8d02005-09-20 00:43:16 +0000922 return true;
923}
924
Chris Lattner748f9032005-09-19 23:49:37 +0000925/// FoldCondBranchOnPHI - If we have a conditional branch on a PHI node value
926/// that is defined in the same block as the branch and if any PHI entries are
927/// constants, thread edges corresponding to that entry to be branches to their
928/// ultimate destination.
929static bool FoldCondBranchOnPHI(BranchInst *BI) {
930 BasicBlock *BB = BI->getParent();
931 PHINode *PN = dyn_cast<PHINode>(BI->getCondition());
Chris Lattner049cb442005-09-19 23:57:04 +0000932 // NOTE: we currently cannot transform this case if the PHI node is used
933 // outside of the block.
Chris Lattnerf0bd8d02005-09-20 00:43:16 +0000934 if (!PN || PN->getParent() != BB || !PN->hasOneUse())
935 return false;
Chris Lattner748f9032005-09-19 23:49:37 +0000936
937 // Degenerate case of a single entry PHI.
938 if (PN->getNumIncomingValues() == 1) {
939 if (PN->getIncomingValue(0) != PN)
940 PN->replaceAllUsesWith(PN->getIncomingValue(0));
941 else
942 PN->replaceAllUsesWith(UndefValue::get(PN->getType()));
943 PN->eraseFromParent();
944 return true;
945 }
946
947 // Now we know that this block has multiple preds and two succs.
Chris Lattnerf0bd8d02005-09-20 00:43:16 +0000948 if (!BlockIsSimpleEnoughToThreadThrough(BB)) return false;
Chris Lattner748f9032005-09-19 23:49:37 +0000949
950 // Okay, this is a simple enough basic block. See if any phi values are
951 // constants.
952 for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
953 if (ConstantBool *CB = dyn_cast<ConstantBool>(PN->getIncomingValue(i))) {
954 // Okay, we now know that all edges from PredBB should be revectored to
955 // branch to RealDest.
956 BasicBlock *PredBB = PN->getIncomingBlock(i);
957 BasicBlock *RealDest = BI->getSuccessor(!CB->getValue());
958
Chris Lattner6c701062005-09-20 01:48:40 +0000959 if (RealDest == BB) continue; // Skip self loops.
Chris Lattner748f9032005-09-19 23:49:37 +0000960
Chris Lattner6c701062005-09-20 01:48:40 +0000961 // The dest block might have PHI nodes, other predecessors and other
962 // difficult cases. Instead of being smart about this, just insert a new
963 // block that jumps to the destination block, effectively splitting
964 // the edge we are about to create.
965 BasicBlock *EdgeBB = new BasicBlock(RealDest->getName()+".critedge",
966 RealDest->getParent(), RealDest);
967 new BranchInst(RealDest, EdgeBB);
968 PHINode *PN;
969 for (BasicBlock::iterator BBI = RealDest->begin();
970 (PN = dyn_cast<PHINode>(BBI)); ++BBI) {
971 Value *V = PN->getIncomingValueForBlock(BB);
972 PN->addIncoming(V, EdgeBB);
973 }
974
975 // BB may have instructions that are being threaded over. Clone these
976 // instructions into EdgeBB. We know that there will be no uses of the
977 // cloned instructions outside of EdgeBB.
978 BasicBlock::iterator InsertPt = EdgeBB->begin();
979 std::map<Value*, Value*> TranslateMap; // Track translated values.
980 for (BasicBlock::iterator BBI = BB->begin(); &*BBI != BI; ++BBI) {
981 if (PHINode *PN = dyn_cast<PHINode>(BBI)) {
982 TranslateMap[PN] = PN->getIncomingValueForBlock(PredBB);
983 } else {
984 // Clone the instruction.
985 Instruction *N = BBI->clone();
986 if (BBI->hasName()) N->setName(BBI->getName()+".c");
987
988 // Update operands due to translation.
989 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
990 std::map<Value*, Value*>::iterator PI =
991 TranslateMap.find(N->getOperand(i));
992 if (PI != TranslateMap.end())
993 N->setOperand(i, PI->second);
994 }
995
996 // Check for trivial simplification.
997 if (Constant *C = ConstantFoldInstruction(N)) {
Chris Lattner6c701062005-09-20 01:48:40 +0000998 TranslateMap[BBI] = C;
999 delete N; // Constant folded away, don't need actual inst
1000 } else {
1001 // Insert the new instruction into its new home.
1002 EdgeBB->getInstList().insert(InsertPt, N);
1003 if (!BBI->use_empty())
1004 TranslateMap[BBI] = N;
1005 }
1006 }
1007 }
1008
Chris Lattner748f9032005-09-19 23:49:37 +00001009 // Loop over all of the edges from PredBB to BB, changing them to branch
Chris Lattner6c701062005-09-20 01:48:40 +00001010 // to EdgeBB instead.
Chris Lattner748f9032005-09-19 23:49:37 +00001011 TerminatorInst *PredBBTI = PredBB->getTerminator();
1012 for (unsigned i = 0, e = PredBBTI->getNumSuccessors(); i != e; ++i)
1013 if (PredBBTI->getSuccessor(i) == BB) {
1014 BB->removePredecessor(PredBB);
Chris Lattner6c701062005-09-20 01:48:40 +00001015 PredBBTI->setSuccessor(i, EdgeBB);
Chris Lattner748f9032005-09-19 23:49:37 +00001016 }
1017
Chris Lattner748f9032005-09-19 23:49:37 +00001018 // Recurse, simplifying any other constants.
1019 return FoldCondBranchOnPHI(BI) | true;
1020 }
1021
1022 return false;
1023}
1024
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001025/// FoldTwoEntryPHINode - Given a BB that starts with the specified two-entry
1026/// PHI node, see if we can eliminate it.
1027static bool FoldTwoEntryPHINode(PHINode *PN) {
1028 // Ok, this is a two entry PHI node. Check to see if this is a simple "if
1029 // statement", which has a very simple dominance structure. Basically, we
1030 // are trying to find the condition that is being branched on, which
1031 // subsequently causes this merge to happen. We really want control
1032 // dependence information for this check, but simplifycfg can't keep it up
1033 // to date, and this catches most of the cases we care about anyway.
1034 //
1035 BasicBlock *BB = PN->getParent();
1036 BasicBlock *IfTrue, *IfFalse;
1037 Value *IfCond = GetIfCondition(BB, IfTrue, IfFalse);
1038 if (!IfCond) return false;
1039
1040 DEBUG(std::cerr << "FOUND IF CONDITION! " << *IfCond << " T: "
1041 << IfTrue->getName() << " F: " << IfFalse->getName() << "\n");
1042
1043 // Loop over the PHI's seeing if we can promote them all to select
1044 // instructions. While we are at it, keep track of the instructions
1045 // that need to be moved to the dominating block.
1046 std::set<Instruction*> AggressiveInsts;
1047
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001048 BasicBlock::iterator AfterPHIIt = BB->begin();
1049 while (isa<PHINode>(AfterPHIIt)) {
1050 PHINode *PN = cast<PHINode>(AfterPHIIt++);
1051 if (PN->getIncomingValue(0) == PN->getIncomingValue(1)) {
1052 if (PN->getIncomingValue(0) != PN)
1053 PN->replaceAllUsesWith(PN->getIncomingValue(0));
1054 else
1055 PN->replaceAllUsesWith(UndefValue::get(PN->getType()));
1056 } else if (!DominatesMergePoint(PN->getIncomingValue(0), BB,
1057 &AggressiveInsts) ||
1058 !DominatesMergePoint(PN->getIncomingValue(1), BB,
1059 &AggressiveInsts)) {
Chris Lattner3a978bf2005-09-23 07:23:18 +00001060 return false;
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001061 }
1062 }
1063
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001064 // If we all PHI nodes are promotable, check to make sure that all
1065 // instructions in the predecessor blocks can be promoted as well. If
1066 // not, we won't be able to get rid of the control flow, so it's not
1067 // worth promoting to select instructions.
1068 BasicBlock *DomBlock = 0, *IfBlock1 = 0, *IfBlock2 = 0;
1069 PN = cast<PHINode>(BB->begin());
1070 BasicBlock *Pred = PN->getIncomingBlock(0);
1071 if (cast<BranchInst>(Pred->getTerminator())->isUnconditional()) {
1072 IfBlock1 = Pred;
1073 DomBlock = *pred_begin(Pred);
1074 for (BasicBlock::iterator I = Pred->begin();
1075 !isa<TerminatorInst>(I); ++I)
1076 if (!AggressiveInsts.count(I)) {
1077 // This is not an aggressive instruction that we can promote.
1078 // Because of this, we won't be able to get rid of the control
1079 // flow, so the xform is not worth it.
1080 return false;
1081 }
1082 }
1083
1084 Pred = PN->getIncomingBlock(1);
1085 if (cast<BranchInst>(Pred->getTerminator())->isUnconditional()) {
1086 IfBlock2 = Pred;
1087 DomBlock = *pred_begin(Pred);
1088 for (BasicBlock::iterator I = Pred->begin();
1089 !isa<TerminatorInst>(I); ++I)
1090 if (!AggressiveInsts.count(I)) {
1091 // This is not an aggressive instruction that we can promote.
1092 // Because of this, we won't be able to get rid of the control
1093 // flow, so the xform is not worth it.
1094 return false;
1095 }
1096 }
1097
1098 // If we can still promote the PHI nodes after this gauntlet of tests,
1099 // do all of the PHI's now.
1100
1101 // Move all 'aggressive' instructions, which are defined in the
1102 // conditional parts of the if's up to the dominating block.
1103 if (IfBlock1) {
1104 DomBlock->getInstList().splice(DomBlock->getTerminator(),
1105 IfBlock1->getInstList(),
1106 IfBlock1->begin(),
1107 IfBlock1->getTerminator());
1108 }
1109 if (IfBlock2) {
1110 DomBlock->getInstList().splice(DomBlock->getTerminator(),
1111 IfBlock2->getInstList(),
1112 IfBlock2->begin(),
1113 IfBlock2->getTerminator());
1114 }
1115
1116 while (PHINode *PN = dyn_cast<PHINode>(BB->begin())) {
1117 // Change the PHI node into a select instruction.
1118 Value *TrueVal =
1119 PN->getIncomingValue(PN->getIncomingBlock(0) == IfFalse);
1120 Value *FalseVal =
1121 PN->getIncomingValue(PN->getIncomingBlock(0) == IfTrue);
1122
1123 std::string Name = PN->getName(); PN->setName("");
1124 PN->replaceAllUsesWith(new SelectInst(IfCond, TrueVal, FalseVal,
1125 Name, AfterPHIIt));
1126 BB->getInstList().erase(PN);
1127 }
1128 return true;
1129}
Chris Lattner748f9032005-09-19 23:49:37 +00001130
Chris Lattnerb2b151d2004-06-19 07:02:14 +00001131namespace {
1132 /// ConstantIntOrdering - This class implements a stable ordering of constant
1133 /// integers that does not depend on their address. This is important for
1134 /// applications that sort ConstantInt's to ensure uniqueness.
1135 struct ConstantIntOrdering {
1136 bool operator()(const ConstantInt *LHS, const ConstantInt *RHS) const {
1137 return LHS->getRawValue() < RHS->getRawValue();
1138 }
1139 };
1140}
1141
Chris Lattner466a0492002-05-21 20:50:24 +00001142// SimplifyCFG - This function is used to do simplification of a CFG. For
1143// example, it adjusts branches to branches to eliminate the extra hop, it
1144// eliminates unreachable basic blocks, and does other "peephole" optimization
Chris Lattner31116ba2003-03-05 21:01:52 +00001145// of the CFG. It returns true if a modification was made.
Chris Lattner466a0492002-05-21 20:50:24 +00001146//
1147// WARNING: The entry node of a function may not be simplified.
1148//
Chris Lattnerdf3c3422004-01-09 06:12:26 +00001149bool llvm::SimplifyCFG(BasicBlock *BB) {
Chris Lattner3f5823f2003-08-24 18:36:16 +00001150 bool Changed = false;
Chris Lattner466a0492002-05-21 20:50:24 +00001151 Function *M = BB->getParent();
1152
1153 assert(BB && BB->getParent() && "Block not embedded in function!");
1154 assert(BB->getTerminator() && "Degenerate basic block encountered!");
Chris Lattnerfda72b12002-06-25 16:12:52 +00001155 assert(&BB->getParent()->front() != BB && "Can't Simplify entry block!");
Chris Lattner466a0492002-05-21 20:50:24 +00001156
Chris Lattner466a0492002-05-21 20:50:24 +00001157 // Remove basic blocks that have no predecessors... which are unreachable.
Chris Lattnera2ab4892004-02-24 07:23:58 +00001158 if (pred_begin(BB) == pred_end(BB) ||
1159 *pred_begin(BB) == BB && ++pred_begin(BB) == pred_end(BB)) {
Chris Lattner32c518e2004-07-15 02:06:12 +00001160 DEBUG(std::cerr << "Removing BB: \n" << *BB);
Chris Lattner466a0492002-05-21 20:50:24 +00001161
1162 // Loop through all of our successors and make sure they know that one
1163 // of their predecessors is going away.
Chris Lattner95f16a32005-04-12 18:51:33 +00001164 for (succ_iterator SI = succ_begin(BB), E = succ_end(BB); SI != E; ++SI)
1165 SI->removePredecessor(BB);
Chris Lattner466a0492002-05-21 20:50:24 +00001166
1167 while (!BB->empty()) {
Chris Lattnerfda72b12002-06-25 16:12:52 +00001168 Instruction &I = BB->back();
Chris Lattner466a0492002-05-21 20:50:24 +00001169 // If this instruction is used, replace uses with an arbitrary
Chris Lattnereee90f72005-08-02 23:29:23 +00001170 // value. Because control flow can't get here, we don't care
Misha Brukmanb1c93172005-04-21 23:48:37 +00001171 // what we replace the value with. Note that since this block is
Chris Lattner466a0492002-05-21 20:50:24 +00001172 // unreachable, and all values contained within it must dominate their
1173 // uses, that all uses will eventually be removed.
Misha Brukmanb1c93172005-04-21 23:48:37 +00001174 if (!I.use_empty())
Chris Lattnereee90f72005-08-02 23:29:23 +00001175 // Make all users of this instruction use undef instead
1176 I.replaceAllUsesWith(UndefValue::get(I.getType()));
Misha Brukmanb1c93172005-04-21 23:48:37 +00001177
Chris Lattner466a0492002-05-21 20:50:24 +00001178 // Remove the instruction from the basic block
Chris Lattnerfda72b12002-06-25 16:12:52 +00001179 BB->getInstList().pop_back();
Chris Lattner466a0492002-05-21 20:50:24 +00001180 }
Chris Lattnerfda72b12002-06-25 16:12:52 +00001181 M->getBasicBlockList().erase(BB);
Chris Lattner466a0492002-05-21 20:50:24 +00001182 return true;
1183 }
1184
Chris Lattner031340a2003-08-17 19:41:53 +00001185 // Check to see if we can constant propagate this terminator instruction
1186 // away...
Chris Lattner3f5823f2003-08-24 18:36:16 +00001187 Changed |= ConstantFoldTerminator(BB);
Chris Lattner031340a2003-08-17 19:41:53 +00001188
Chris Lattnere42732e2004-02-16 06:35:48 +00001189 // If this is a returning block with only PHI nodes in it, fold the return
1190 // instruction into any unconditional branch predecessors.
Chris Lattner9f0db322004-04-02 18:13:43 +00001191 //
1192 // If any predecessor is a conditional branch that just selects among
1193 // different return values, fold the replace the branch/return with a select
1194 // and return.
Chris Lattnere42732e2004-02-16 06:35:48 +00001195 if (ReturnInst *RI = dyn_cast<ReturnInst>(BB->getTerminator())) {
1196 BasicBlock::iterator BBI = BB->getTerminator();
1197 if (BBI == BB->begin() || isa<PHINode>(--BBI)) {
Chris Lattner9f0db322004-04-02 18:13:43 +00001198 // Find predecessors that end with branches.
Chris Lattnere42732e2004-02-16 06:35:48 +00001199 std::vector<BasicBlock*> UncondBranchPreds;
Chris Lattner9f0db322004-04-02 18:13:43 +00001200 std::vector<BranchInst*> CondBranchPreds;
Chris Lattnere42732e2004-02-16 06:35:48 +00001201 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI) {
1202 TerminatorInst *PTI = (*PI)->getTerminator();
1203 if (BranchInst *BI = dyn_cast<BranchInst>(PTI))
1204 if (BI->isUnconditional())
1205 UncondBranchPreds.push_back(*PI);
Chris Lattner9f0db322004-04-02 18:13:43 +00001206 else
1207 CondBranchPreds.push_back(BI);
Chris Lattnere42732e2004-02-16 06:35:48 +00001208 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00001209
Chris Lattnere42732e2004-02-16 06:35:48 +00001210 // If we found some, do the transformation!
1211 if (!UncondBranchPreds.empty()) {
1212 while (!UncondBranchPreds.empty()) {
1213 BasicBlock *Pred = UncondBranchPreds.back();
Chris Lattnerc59a3712005-09-23 18:47:20 +00001214 DEBUG(std::cerr << "FOLDING: " << *BB
1215 << "INTO UNCOND BRANCH PRED: " << *Pred);
Chris Lattnere42732e2004-02-16 06:35:48 +00001216 UncondBranchPreds.pop_back();
1217 Instruction *UncondBranch = Pred->getTerminator();
1218 // Clone the return and add it to the end of the predecessor.
1219 Instruction *NewRet = RI->clone();
1220 Pred->getInstList().push_back(NewRet);
1221
1222 // If the return instruction returns a value, and if the value was a
1223 // PHI node in "BB", propagate the right value into the return.
1224 if (NewRet->getNumOperands() == 1)
1225 if (PHINode *PN = dyn_cast<PHINode>(NewRet->getOperand(0)))
1226 if (PN->getParent() == BB)
1227 NewRet->setOperand(0, PN->getIncomingValueForBlock(Pred));
1228 // Update any PHI nodes in the returning block to realize that we no
1229 // longer branch to them.
1230 BB->removePredecessor(Pred);
1231 Pred->getInstList().erase(UncondBranch);
1232 }
1233
1234 // If we eliminated all predecessors of the block, delete the block now.
1235 if (pred_begin(BB) == pred_end(BB))
1236 // We know there are no successors, so just nuke the block.
1237 M->getBasicBlockList().erase(BB);
1238
Chris Lattnere42732e2004-02-16 06:35:48 +00001239 return true;
1240 }
Chris Lattner9f0db322004-04-02 18:13:43 +00001241
1242 // Check out all of the conditional branches going to this return
1243 // instruction. If any of them just select between returns, change the
1244 // branch itself into a select/return pair.
1245 while (!CondBranchPreds.empty()) {
1246 BranchInst *BI = CondBranchPreds.back();
1247 CondBranchPreds.pop_back();
1248 BasicBlock *TrueSucc = BI->getSuccessor(0);
1249 BasicBlock *FalseSucc = BI->getSuccessor(1);
1250 BasicBlock *OtherSucc = TrueSucc == BB ? FalseSucc : TrueSucc;
1251
1252 // Check to see if the non-BB successor is also a return block.
1253 if (isa<ReturnInst>(OtherSucc->getTerminator())) {
1254 // Check to see if there are only PHI instructions in this block.
1255 BasicBlock::iterator OSI = OtherSucc->getTerminator();
1256 if (OSI == OtherSucc->begin() || isa<PHINode>(--OSI)) {
1257 // Okay, we found a branch that is going to two return nodes. If
1258 // there is no return value for this function, just change the
1259 // branch into a return.
1260 if (RI->getNumOperands() == 0) {
1261 TrueSucc->removePredecessor(BI->getParent());
1262 FalseSucc->removePredecessor(BI->getParent());
1263 new ReturnInst(0, BI);
1264 BI->getParent()->getInstList().erase(BI);
1265 return true;
1266 }
1267
1268 // Otherwise, figure out what the true and false return values are
1269 // so we can insert a new select instruction.
1270 Value *TrueValue = TrueSucc->getTerminator()->getOperand(0);
1271 Value *FalseValue = FalseSucc->getTerminator()->getOperand(0);
1272
1273 // Unwrap any PHI nodes in the return blocks.
1274 if (PHINode *TVPN = dyn_cast<PHINode>(TrueValue))
1275 if (TVPN->getParent() == TrueSucc)
1276 TrueValue = TVPN->getIncomingValueForBlock(BI->getParent());
1277 if (PHINode *FVPN = dyn_cast<PHINode>(FalseValue))
1278 if (FVPN->getParent() == FalseSucc)
1279 FalseValue = FVPN->getIncomingValueForBlock(BI->getParent());
1280
Chris Lattnereed034b2004-04-02 18:15:10 +00001281 TrueSucc->removePredecessor(BI->getParent());
1282 FalseSucc->removePredecessor(BI->getParent());
1283
Chris Lattner9f0db322004-04-02 18:13:43 +00001284 // Insert a new select instruction.
Chris Lattner879ce782004-09-29 05:43:32 +00001285 Value *NewRetVal;
1286 Value *BrCond = BI->getCondition();
1287 if (TrueValue != FalseValue)
1288 NewRetVal = new SelectInst(BrCond, TrueValue,
1289 FalseValue, "retval", BI);
1290 else
1291 NewRetVal = TrueValue;
Chris Lattner4c3b2b52005-10-03 23:43:43 +00001292
1293 DEBUG(std::cerr << "\nCHANGING BRANCH TO TWO RETURNS INTO SELECT:"
1294 << "\n " << *BI << "Select = " << *NewRetVal
1295 << "TRUEBLOCK: " << *TrueSucc << "FALSEBLOCK: "<< *FalseSucc);
Chris Lattner879ce782004-09-29 05:43:32 +00001296
Chris Lattner9f0db322004-04-02 18:13:43 +00001297 new ReturnInst(NewRetVal, BI);
Chris Lattner4c3b2b52005-10-03 23:43:43 +00001298 BI->eraseFromParent();
1299 if (Instruction *BrCondI = dyn_cast<Instruction>(BrCond))
1300 if (isInstructionTriviallyDead(BrCondI))
1301 BrCondI->eraseFromParent();
Chris Lattner9f0db322004-04-02 18:13:43 +00001302 return true;
1303 }
1304 }
1305 }
Chris Lattnere42732e2004-02-16 06:35:48 +00001306 }
Chris Lattner3cd98f02004-02-24 05:54:22 +00001307 } else if (UnwindInst *UI = dyn_cast<UnwindInst>(BB->begin())) {
1308 // Check to see if the first instruction in this block is just an unwind.
1309 // If so, replace any invoke instructions which use this as an exception
Chris Lattner5823ac12004-07-20 01:17:38 +00001310 // destination with call instructions, and any unconditional branch
1311 // predecessor with an unwind.
Chris Lattner3cd98f02004-02-24 05:54:22 +00001312 //
1313 std::vector<BasicBlock*> Preds(pred_begin(BB), pred_end(BB));
1314 while (!Preds.empty()) {
1315 BasicBlock *Pred = Preds.back();
Chris Lattner5823ac12004-07-20 01:17:38 +00001316 if (BranchInst *BI = dyn_cast<BranchInst>(Pred->getTerminator())) {
1317 if (BI->isUnconditional()) {
1318 Pred->getInstList().pop_back(); // nuke uncond branch
1319 new UnwindInst(Pred); // Use unwind.
1320 Changed = true;
1321 }
1322 } else if (InvokeInst *II = dyn_cast<InvokeInst>(Pred->getTerminator()))
Chris Lattner3cd98f02004-02-24 05:54:22 +00001323 if (II->getUnwindDest() == BB) {
1324 // Insert a new branch instruction before the invoke, because this
1325 // is now a fall through...
1326 BranchInst *BI = new BranchInst(II->getNormalDest(), II);
1327 Pred->getInstList().remove(II); // Take out of symbol table
Misha Brukmanb1c93172005-04-21 23:48:37 +00001328
Chris Lattner3cd98f02004-02-24 05:54:22 +00001329 // Insert the call now...
1330 std::vector<Value*> Args(II->op_begin()+3, II->op_end());
1331 CallInst *CI = new CallInst(II->getCalledValue(), Args,
1332 II->getName(), BI);
Chris Lattnerbcefcf82005-05-14 12:21:56 +00001333 CI->setCallingConv(II->getCallingConv());
Chris Lattner3cd98f02004-02-24 05:54:22 +00001334 // If the invoke produced a value, the Call now does instead
1335 II->replaceAllUsesWith(CI);
1336 delete II;
1337 Changed = true;
1338 }
Misha Brukmanb1c93172005-04-21 23:48:37 +00001339
Chris Lattner3cd98f02004-02-24 05:54:22 +00001340 Preds.pop_back();
1341 }
Chris Lattner90ea78e2004-02-24 16:09:21 +00001342
1343 // If this block is now dead, remove it.
1344 if (pred_begin(BB) == pred_end(BB)) {
1345 // We know there are no successors, so just nuke the block.
1346 M->getBasicBlockList().erase(BB);
1347 return true;
1348 }
1349
Chris Lattner1cca9592005-02-24 06:17:52 +00001350 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(BB->getTerminator())) {
1351 if (isValueEqualityComparison(SI)) {
1352 // If we only have one predecessor, and if it is a branch on this value,
1353 // see if that predecessor totally determines the outcome of this switch.
1354 if (BasicBlock *OnlyPred = BB->getSinglePredecessor())
1355 if (SimplifyEqualityComparisonWithOnlyPredecessor(SI, OnlyPred))
1356 return SimplifyCFG(BB) || 1;
1357
1358 // If the block only contains the switch, see if we can fold the block
1359 // away into any preds.
1360 if (SI == &BB->front())
1361 if (FoldValueComparisonIntoPredecessors(SI))
1362 return SimplifyCFG(BB) || 1;
1363 }
Chris Lattnerd3e6ae22004-02-28 21:28:10 +00001364 } else if (BranchInst *BI = dyn_cast<BranchInst>(BB->getTerminator())) {
Chris Lattner733d6702005-08-03 00:11:16 +00001365 if (BI->isUnconditional()) {
1366 BasicBlock::iterator BBI = BB->begin(); // Skip over phi nodes...
1367 while (isa<PHINode>(*BBI)) ++BBI;
1368
1369 BasicBlock *Succ = BI->getSuccessor(0);
1370 if (BBI->isTerminator() && // Terminator is the only non-phi instruction!
1371 Succ != BB) // Don't hurt infinite loops!
1372 if (TryToSimplifyUncondBranchFromEmptyBlock(BB, Succ))
1373 return 1;
1374
1375 } else { // Conditional branch
Chris Lattner2e93c422004-05-01 23:35:43 +00001376 if (Value *CompVal = isValueEqualityComparison(BI)) {
Chris Lattner1cca9592005-02-24 06:17:52 +00001377 // If we only have one predecessor, and if it is a branch on this value,
1378 // see if that predecessor totally determines the outcome of this
1379 // switch.
1380 if (BasicBlock *OnlyPred = BB->getSinglePredecessor())
1381 if (SimplifyEqualityComparisonWithOnlyPredecessor(BI, OnlyPred))
1382 return SimplifyCFG(BB) || 1;
1383
Chris Lattner2e93c422004-05-01 23:35:43 +00001384 // This block must be empty, except for the setcond inst, if it exists.
1385 BasicBlock::iterator I = BB->begin();
1386 if (&*I == BI ||
1387 (&*I == cast<Instruction>(BI->getCondition()) &&
1388 &*++I == BI))
1389 if (FoldValueComparisonIntoPredecessors(BI))
1390 return SimplifyCFG(BB) | true;
1391 }
Chris Lattner748f9032005-09-19 23:49:37 +00001392
1393 // If this is a branch on a phi node in the current block, thread control
1394 // through this block if any PHI node entries are constants.
1395 if (PHINode *PN = dyn_cast<PHINode>(BI->getCondition()))
1396 if (PN->getParent() == BI->getParent())
1397 if (FoldCondBranchOnPHI(BI))
1398 return SimplifyCFG(BB) | true;
Chris Lattner2e93c422004-05-01 23:35:43 +00001399
1400 // If this basic block is ONLY a setcc and a branch, and if a predecessor
1401 // branches to us and one of our successors, fold the setcc into the
1402 // predecessor and use logical operations to pick the right destination.
Chris Lattner51a6dbc2004-05-02 05:02:03 +00001403 BasicBlock *TrueDest = BI->getSuccessor(0);
1404 BasicBlock *FalseDest = BI->getSuccessor(1);
Chris Lattnerbe6f0682004-05-02 05:19:36 +00001405 if (BinaryOperator *Cond = dyn_cast<BinaryOperator>(BI->getCondition()))
Chris Lattner2e93c422004-05-01 23:35:43 +00001406 if (Cond->getParent() == BB && &BB->front() == Cond &&
Chris Lattner51a6dbc2004-05-02 05:02:03 +00001407 Cond->getNext() == BI && Cond->hasOneUse() &&
1408 TrueDest != BB && FalseDest != BB)
Chris Lattner2e93c422004-05-01 23:35:43 +00001409 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI!=E; ++PI)
1410 if (BranchInst *PBI = dyn_cast<BranchInst>((*PI)->getTerminator()))
Chris Lattner1e94ed62004-05-02 01:00:44 +00001411 if (PBI->isConditional() && SafeToMergeTerminators(BI, PBI)) {
Chris Lattnerf12c4a32004-06-21 07:19:01 +00001412 BasicBlock *PredBlock = *PI;
Chris Lattner2e93c422004-05-01 23:35:43 +00001413 if (PBI->getSuccessor(0) == FalseDest ||
1414 PBI->getSuccessor(1) == TrueDest) {
1415 // Invert the predecessors condition test (xor it with true),
1416 // which allows us to write this code once.
1417 Value *NewCond =
1418 BinaryOperator::createNot(PBI->getCondition(),
1419 PBI->getCondition()->getName()+".not", PBI);
1420 PBI->setCondition(NewCond);
1421 BasicBlock *OldTrue = PBI->getSuccessor(0);
1422 BasicBlock *OldFalse = PBI->getSuccessor(1);
1423 PBI->setSuccessor(0, OldFalse);
1424 PBI->setSuccessor(1, OldTrue);
1425 }
1426
Chris Lattnerd9566512006-02-18 00:33:17 +00001427 if ((PBI->getSuccessor(0) == TrueDest && FalseDest != BB) ||
1428 (PBI->getSuccessor(1) == FalseDest && TrueDest != BB)) {
Chris Lattnerf12c4a32004-06-21 07:19:01 +00001429 // Clone Cond into the predecessor basic block, and or/and the
Chris Lattner2e93c422004-05-01 23:35:43 +00001430 // two conditions together.
1431 Instruction *New = Cond->clone();
1432 New->setName(Cond->getName());
1433 Cond->setName(Cond->getName()+".old");
Chris Lattnerf12c4a32004-06-21 07:19:01 +00001434 PredBlock->getInstList().insert(PBI, New);
Chris Lattner2e93c422004-05-01 23:35:43 +00001435 Instruction::BinaryOps Opcode =
1436 PBI->getSuccessor(0) == TrueDest ?
1437 Instruction::Or : Instruction::And;
Misha Brukmanb1c93172005-04-21 23:48:37 +00001438 Value *NewCond =
Chris Lattner2e93c422004-05-01 23:35:43 +00001439 BinaryOperator::create(Opcode, PBI->getCondition(),
1440 New, "bothcond", PBI);
1441 PBI->setCondition(NewCond);
1442 if (PBI->getSuccessor(0) == BB) {
Chris Lattnerf12c4a32004-06-21 07:19:01 +00001443 AddPredecessorToBlock(TrueDest, PredBlock, BB);
Chris Lattner2e93c422004-05-01 23:35:43 +00001444 PBI->setSuccessor(0, TrueDest);
1445 }
1446 if (PBI->getSuccessor(1) == BB) {
Chris Lattnerf12c4a32004-06-21 07:19:01 +00001447 AddPredecessorToBlock(FalseDest, PredBlock, BB);
Chris Lattner2e93c422004-05-01 23:35:43 +00001448 PBI->setSuccessor(1, FalseDest);
1449 }
1450 return SimplifyCFG(BB) | 1;
1451 }
1452 }
Chris Lattner2e93c422004-05-01 23:35:43 +00001453
Chris Lattnerc59a3712005-09-23 18:47:20 +00001454 // Scan predessor blocks for conditional branchs.
Chris Lattnerf0bd8d02005-09-20 00:43:16 +00001455 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
1456 if (BranchInst *PBI = dyn_cast<BranchInst>((*PI)->getTerminator()))
Chris Lattnerc59a3712005-09-23 18:47:20 +00001457 if (PBI != BI && PBI->isConditional()) {
1458
1459 // If this block ends with a branch instruction, and if there is a
1460 // predecessor that ends on a branch of the same condition, make this
1461 // conditional branch redundant.
1462 if (PBI->getCondition() == BI->getCondition() &&
1463 PBI->getSuccessor(0) != PBI->getSuccessor(1)) {
1464 // Okay, the outcome of this conditional branch is statically
1465 // knowable. If this block had a single pred, handle specially.
1466 if (BB->getSinglePredecessor()) {
1467 // Turn this into a branch on constant.
1468 bool CondIsTrue = PBI->getSuccessor(0) == BB;
1469 BI->setCondition(ConstantBool::get(CondIsTrue));
1470 return SimplifyCFG(BB); // Nuke the branch on constant.
1471 }
1472
1473 // Otherwise, if there are multiple predecessors, insert a PHI that
1474 // merges in the constant and simplify the block result.
1475 if (BlockIsSimpleEnoughToThreadThrough(BB)) {
1476 PHINode *NewPN = new PHINode(Type::BoolTy,
1477 BI->getCondition()->getName()+".pr",
1478 BB->begin());
1479 for (PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
1480 if ((PBI = dyn_cast<BranchInst>((*PI)->getTerminator())) &&
1481 PBI != BI && PBI->isConditional() &&
1482 PBI->getCondition() == BI->getCondition() &&
1483 PBI->getSuccessor(0) != PBI->getSuccessor(1)) {
1484 bool CondIsTrue = PBI->getSuccessor(0) == BB;
1485 NewPN->addIncoming(ConstantBool::get(CondIsTrue), *PI);
1486 } else {
1487 NewPN->addIncoming(BI->getCondition(), *PI);
1488 }
1489
1490 BI->setCondition(NewPN);
1491 // This will thread the branch.
1492 return SimplifyCFG(BB) | true;
1493 }
Chris Lattnerf0bd8d02005-09-20 00:43:16 +00001494 }
1495
Chris Lattnerc59a3712005-09-23 18:47:20 +00001496 // If this is a conditional branch in an empty block, and if any
1497 // predecessors is a conditional branch to one of our destinations,
1498 // fold the conditions into logical ops and one cond br.
1499 if (&BB->front() == BI) {
1500 int PBIOp, BIOp;
1501 if (PBI->getSuccessor(0) == BI->getSuccessor(0)) {
1502 PBIOp = BIOp = 0;
1503 } else if (PBI->getSuccessor(0) == BI->getSuccessor(1)) {
1504 PBIOp = 0; BIOp = 1;
1505 } else if (PBI->getSuccessor(1) == BI->getSuccessor(0)) {
1506 PBIOp = 1; BIOp = 0;
1507 } else if (PBI->getSuccessor(1) == BI->getSuccessor(1)) {
1508 PBIOp = BIOp = 1;
1509 } else {
1510 PBIOp = BIOp = -1;
1511 }
Chris Lattnerf0bd8d02005-09-20 00:43:16 +00001512
Chris Lattnerd9566512006-02-18 00:33:17 +00001513 // Check to make sure that the other destination of this branch
1514 // isn't BB itself. If so, this is an infinite loop that will
1515 // keep getting unwound.
1516 if (PBIOp != -1 && PBI->getSuccessor(PBIOp) == BB)
1517 PBIOp = BIOp = -1;
1518
Chris Lattnerc59a3712005-09-23 18:47:20 +00001519 // Finally, if everything is ok, fold the branches to logical ops.
1520 if (PBIOp != -1) {
1521 BasicBlock *CommonDest = PBI->getSuccessor(PBIOp);
1522 BasicBlock *OtherDest = BI->getSuccessor(BIOp ^ 1);
1523
1524 DEBUG(std::cerr << "FOLDING BRs:" << *PBI->getParent()
1525 << "AND: " << *BI->getParent());
1526
1527 // BI may have other predecessors. Because of this, we leave
1528 // it alone, but modify PBI.
1529
1530 // Make sure we get to CommonDest on True&True directions.
1531 Value *PBICond = PBI->getCondition();
1532 if (PBIOp)
1533 PBICond = BinaryOperator::createNot(PBICond,
1534 PBICond->getName()+".not",
1535 PBI);
1536 Value *BICond = BI->getCondition();
1537 if (BIOp)
1538 BICond = BinaryOperator::createNot(BICond,
1539 BICond->getName()+".not",
1540 PBI);
1541 // Merge the conditions.
1542 Value *Cond =
1543 BinaryOperator::createOr(PBICond, BICond, "brmerge", PBI);
1544
1545 // Modify PBI to branch on the new condition to the new dests.
1546 PBI->setCondition(Cond);
1547 PBI->setSuccessor(0, CommonDest);
1548 PBI->setSuccessor(1, OtherDest);
1549
1550 // OtherDest may have phi nodes. If so, add an entry from PBI's
1551 // block that are identical to the entries for BI's block.
1552 PHINode *PN;
1553 for (BasicBlock::iterator II = OtherDest->begin();
1554 (PN = dyn_cast<PHINode>(II)); ++II) {
1555 Value *V = PN->getIncomingValueForBlock(BB);
1556 PN->addIncoming(V, PBI->getParent());
1557 }
1558
1559 // We know that the CommonDest already had an edge from PBI to
1560 // it. If it has PHIs though, the PHIs may have different
1561 // entries for BB and PBI's BB. If so, insert a select to make
1562 // them agree.
1563 for (BasicBlock::iterator II = CommonDest->begin();
1564 (PN = dyn_cast<PHINode>(II)); ++II) {
1565 Value * BIV = PN->getIncomingValueForBlock(BB);
1566 unsigned PBBIdx = PN->getBasicBlockIndex(PBI->getParent());
1567 Value *PBIV = PN->getIncomingValue(PBBIdx);
1568 if (BIV != PBIV) {
1569 // Insert a select in PBI to pick the right value.
1570 Value *NV = new SelectInst(PBICond, PBIV, BIV,
1571 PBIV->getName()+".mux", PBI);
1572 PN->setIncomingValue(PBBIdx, NV);
1573 }
1574 }
1575
1576 DEBUG(std::cerr << "INTO: " << *PBI->getParent());
1577
1578 // This basic block is probably dead. We know it has at least
1579 // one fewer predecessor.
1580 return SimplifyCFG(BB) | true;
1581 }
Chris Lattnerf0bd8d02005-09-20 00:43:16 +00001582 }
Chris Lattner88da6f72004-05-01 22:36:37 +00001583 }
Chris Lattnera2ab4892004-02-24 07:23:58 +00001584 }
Chris Lattner5edb2f32004-10-18 04:07:22 +00001585 } else if (isa<UnreachableInst>(BB->getTerminator())) {
1586 // If there are any instructions immediately before the unreachable that can
1587 // be removed, do so.
1588 Instruction *Unreachable = BB->getTerminator();
1589 while (Unreachable != BB->begin()) {
1590 BasicBlock::iterator BBI = Unreachable;
1591 --BBI;
1592 if (isa<CallInst>(BBI)) break;
1593 // Delete this instruction
1594 BB->getInstList().erase(BBI);
1595 Changed = true;
1596 }
1597
1598 // If the unreachable instruction is the first in the block, take a gander
1599 // at all of the predecessors of this instruction, and simplify them.
1600 if (&BB->front() == Unreachable) {
1601 std::vector<BasicBlock*> Preds(pred_begin(BB), pred_end(BB));
1602 for (unsigned i = 0, e = Preds.size(); i != e; ++i) {
1603 TerminatorInst *TI = Preds[i]->getTerminator();
1604
1605 if (BranchInst *BI = dyn_cast<BranchInst>(TI)) {
1606 if (BI->isUnconditional()) {
1607 if (BI->getSuccessor(0) == BB) {
1608 new UnreachableInst(TI);
1609 TI->eraseFromParent();
1610 Changed = true;
1611 }
1612 } else {
1613 if (BI->getSuccessor(0) == BB) {
1614 new BranchInst(BI->getSuccessor(1), BI);
1615 BI->eraseFromParent();
1616 } else if (BI->getSuccessor(1) == BB) {
1617 new BranchInst(BI->getSuccessor(0), BI);
1618 BI->eraseFromParent();
1619 Changed = true;
1620 }
1621 }
1622 } else if (SwitchInst *SI = dyn_cast<SwitchInst>(TI)) {
1623 for (unsigned i = 1, e = SI->getNumCases(); i != e; ++i)
1624 if (SI->getSuccessor(i) == BB) {
Chris Lattner19f9f322005-05-20 22:19:54 +00001625 BB->removePredecessor(SI->getParent());
Chris Lattner5edb2f32004-10-18 04:07:22 +00001626 SI->removeCase(i);
1627 --i; --e;
1628 Changed = true;
1629 }
1630 // If the default value is unreachable, figure out the most popular
1631 // destination and make it the default.
1632 if (SI->getSuccessor(0) == BB) {
1633 std::map<BasicBlock*, unsigned> Popularity;
1634 for (unsigned i = 1, e = SI->getNumCases(); i != e; ++i)
1635 Popularity[SI->getSuccessor(i)]++;
1636
1637 // Find the most popular block.
1638 unsigned MaxPop = 0;
1639 BasicBlock *MaxBlock = 0;
1640 for (std::map<BasicBlock*, unsigned>::iterator
1641 I = Popularity.begin(), E = Popularity.end(); I != E; ++I) {
1642 if (I->second > MaxPop) {
1643 MaxPop = I->second;
1644 MaxBlock = I->first;
1645 }
1646 }
1647 if (MaxBlock) {
1648 // Make this the new default, allowing us to delete any explicit
1649 // edges to it.
1650 SI->setSuccessor(0, MaxBlock);
1651 Changed = true;
1652
Chris Lattner19f9f322005-05-20 22:19:54 +00001653 // If MaxBlock has phinodes in it, remove MaxPop-1 entries from
1654 // it.
1655 if (isa<PHINode>(MaxBlock->begin()))
1656 for (unsigned i = 0; i != MaxPop-1; ++i)
1657 MaxBlock->removePredecessor(SI->getParent());
1658
Chris Lattner5edb2f32004-10-18 04:07:22 +00001659 for (unsigned i = 1, e = SI->getNumCases(); i != e; ++i)
1660 if (SI->getSuccessor(i) == MaxBlock) {
1661 SI->removeCase(i);
1662 --i; --e;
1663 }
1664 }
1665 }
1666 } else if (InvokeInst *II = dyn_cast<InvokeInst>(TI)) {
1667 if (II->getUnwindDest() == BB) {
1668 // Convert the invoke to a call instruction. This would be a good
1669 // place to note that the call does not throw though.
1670 BranchInst *BI = new BranchInst(II->getNormalDest(), II);
1671 II->removeFromParent(); // Take out of symbol table
Misha Brukmanb1c93172005-04-21 23:48:37 +00001672
Chris Lattner5edb2f32004-10-18 04:07:22 +00001673 // Insert the call now...
1674 std::vector<Value*> Args(II->op_begin()+3, II->op_end());
1675 CallInst *CI = new CallInst(II->getCalledValue(), Args,
1676 II->getName(), BI);
Chris Lattnerbcefcf82005-05-14 12:21:56 +00001677 CI->setCallingConv(II->getCallingConv());
Chris Lattner5edb2f32004-10-18 04:07:22 +00001678 // If the invoke produced a value, the Call does now instead.
1679 II->replaceAllUsesWith(CI);
1680 delete II;
1681 Changed = true;
1682 }
1683 }
1684 }
1685
1686 // If this block is now dead, remove it.
1687 if (pred_begin(BB) == pred_end(BB)) {
1688 // We know there are no successors, so just nuke the block.
1689 M->getBasicBlockList().erase(BB);
1690 return true;
1691 }
1692 }
Chris Lattnere42732e2004-02-16 06:35:48 +00001693 }
1694
Chris Lattner466a0492002-05-21 20:50:24 +00001695 // Merge basic blocks into their predecessor if there is only one distinct
1696 // pred, and if there is only one distinct successor of the predecessor, and
1697 // if there are no PHI nodes.
1698 //
Chris Lattner838b8452004-02-11 01:17:07 +00001699 pred_iterator PI(pred_begin(BB)), PE(pred_end(BB));
1700 BasicBlock *OnlyPred = *PI++;
1701 for (; PI != PE; ++PI) // Search all predecessors, see if they are all same
1702 if (*PI != OnlyPred) {
1703 OnlyPred = 0; // There are multiple different predecessors...
1704 break;
1705 }
Chris Lattner88da6f72004-05-01 22:36:37 +00001706
Chris Lattner838b8452004-02-11 01:17:07 +00001707 BasicBlock *OnlySucc = 0;
1708 if (OnlyPred && OnlyPred != BB && // Don't break self loops
1709 OnlyPred->getTerminator()->getOpcode() != Instruction::Invoke) {
1710 // Check to see if there is only one distinct successor...
1711 succ_iterator SI(succ_begin(OnlyPred)), SE(succ_end(OnlyPred));
1712 OnlySucc = BB;
1713 for (; SI != SE; ++SI)
1714 if (*SI != OnlySucc) {
1715 OnlySucc = 0; // There are multiple distinct successors!
Chris Lattner466a0492002-05-21 20:50:24 +00001716 break;
1717 }
Chris Lattner838b8452004-02-11 01:17:07 +00001718 }
1719
1720 if (OnlySucc) {
Chris Lattner32c518e2004-07-15 02:06:12 +00001721 DEBUG(std::cerr << "Merging: " << *BB << "into: " << *OnlyPred);
Chris Lattner838b8452004-02-11 01:17:07 +00001722 TerminatorInst *Term = OnlyPred->getTerminator();
1723
1724 // Resolve any PHI nodes at the start of the block. They are all
1725 // guaranteed to have exactly one entry if they exist, unless there are
1726 // multiple duplicate (but guaranteed to be equal) entries for the
1727 // incoming edges. This occurs when there are multiple edges from
1728 // OnlyPred to OnlySucc.
1729 //
1730 while (PHINode *PN = dyn_cast<PHINode>(&BB->front())) {
1731 PN->replaceAllUsesWith(PN->getIncomingValue(0));
1732 BB->getInstList().pop_front(); // Delete the phi node...
Chris Lattner466a0492002-05-21 20:50:24 +00001733 }
1734
Chris Lattner838b8452004-02-11 01:17:07 +00001735 // Delete the unconditional branch from the predecessor...
1736 OnlyPred->getInstList().pop_back();
Misha Brukmanb1c93172005-04-21 23:48:37 +00001737
Chris Lattner838b8452004-02-11 01:17:07 +00001738 // Move all definitions in the successor to the predecessor...
1739 OnlyPred->getInstList().splice(OnlyPred->end(), BB->getInstList());
Misha Brukmanb1c93172005-04-21 23:48:37 +00001740
Chris Lattner838b8452004-02-11 01:17:07 +00001741 // Make all PHI nodes that referred to BB now refer to Pred as their
1742 // source...
1743 BB->replaceAllUsesWith(OnlyPred);
Chris Lattnerfda72b12002-06-25 16:12:52 +00001744
Chris Lattner838b8452004-02-11 01:17:07 +00001745 std::string OldName = BB->getName();
Chris Lattnerfda72b12002-06-25 16:12:52 +00001746
Misha Brukmanb1c93172005-04-21 23:48:37 +00001747 // Erase basic block from the function...
Chris Lattner838b8452004-02-11 01:17:07 +00001748 M->getBasicBlockList().erase(BB);
Chris Lattnerfda72b12002-06-25 16:12:52 +00001749
Chris Lattner838b8452004-02-11 01:17:07 +00001750 // Inherit predecessors name if it exists...
1751 if (!OldName.empty() && !OnlyPred->hasName())
1752 OnlyPred->setName(OldName);
Misha Brukmanb1c93172005-04-21 23:48:37 +00001753
Chris Lattner838b8452004-02-11 01:17:07 +00001754 return true;
Chris Lattner466a0492002-05-21 20:50:24 +00001755 }
Chris Lattner18d1f192004-02-11 03:36:04 +00001756
Chris Lattner389cfac2004-11-30 00:29:14 +00001757 // Otherwise, if this block only has a single predecessor, and if that block
1758 // is a conditional branch, see if we can hoist any code from this block up
1759 // into our predecessor.
1760 if (OnlyPred)
Chris Lattner4fc998d2004-12-10 17:42:31 +00001761 if (BranchInst *BI = dyn_cast<BranchInst>(OnlyPred->getTerminator()))
1762 if (BI->isConditional()) {
1763 // Get the other block.
1764 BasicBlock *OtherBB = BI->getSuccessor(BI->getSuccessor(0) == BB);
1765 PI = pred_begin(OtherBB);
1766 ++PI;
1767 if (PI == pred_end(OtherBB)) {
1768 // We have a conditional branch to two blocks that are only reachable
1769 // from the condbr. We know that the condbr dominates the two blocks,
1770 // so see if there is any identical code in the "then" and "else"
1771 // blocks. If so, we can hoist it up to the branching block.
1772 Changed |= HoistThenElseCodeToIf(BI);
1773 }
Chris Lattner389cfac2004-11-30 00:29:14 +00001774 }
Chris Lattner389cfac2004-11-30 00:29:14 +00001775
Chris Lattner6f4b45a2004-02-24 05:38:11 +00001776 for (pred_iterator PI = pred_begin(BB), E = pred_end(BB); PI != E; ++PI)
1777 if (BranchInst *BI = dyn_cast<BranchInst>((*PI)->getTerminator()))
1778 // Change br (X == 0 | X == 1), T, F into a switch instruction.
1779 if (BI->isConditional() && isa<Instruction>(BI->getCondition())) {
1780 Instruction *Cond = cast<Instruction>(BI->getCondition());
1781 // If this is a bunch of seteq's or'd together, or if it's a bunch of
1782 // 'setne's and'ed together, collect them.
1783 Value *CompVal = 0;
Chris Lattnerb2b151d2004-06-19 07:02:14 +00001784 std::vector<ConstantInt*> Values;
Chris Lattner6f4b45a2004-02-24 05:38:11 +00001785 bool TrueWhenEqual = GatherValueComparisons(Cond, CompVal, Values);
1786 if (CompVal && CompVal->getType()->isInteger()) {
1787 // There might be duplicate constants in the list, which the switch
1788 // instruction can't handle, remove them now.
Chris Lattnerb2b151d2004-06-19 07:02:14 +00001789 std::sort(Values.begin(), Values.end(), ConstantIntOrdering());
Chris Lattner6f4b45a2004-02-24 05:38:11 +00001790 Values.erase(std::unique(Values.begin(), Values.end()), Values.end());
Misha Brukmanb1c93172005-04-21 23:48:37 +00001791
Chris Lattner6f4b45a2004-02-24 05:38:11 +00001792 // Figure out which block is which destination.
1793 BasicBlock *DefaultBB = BI->getSuccessor(1);
1794 BasicBlock *EdgeBB = BI->getSuccessor(0);
1795 if (!TrueWhenEqual) std::swap(DefaultBB, EdgeBB);
Misha Brukmanb1c93172005-04-21 23:48:37 +00001796
Chris Lattner6f4b45a2004-02-24 05:38:11 +00001797 // Create the new switch instruction now.
Chris Lattnera35dfce2005-01-29 00:38:26 +00001798 SwitchInst *New = new SwitchInst(CompVal, DefaultBB,Values.size(),BI);
Misha Brukmanb1c93172005-04-21 23:48:37 +00001799
Chris Lattner6f4b45a2004-02-24 05:38:11 +00001800 // Add all of the 'cases' to the switch instruction.
1801 for (unsigned i = 0, e = Values.size(); i != e; ++i)
1802 New->addCase(Values[i], EdgeBB);
Misha Brukmanb1c93172005-04-21 23:48:37 +00001803
Chris Lattner6f4b45a2004-02-24 05:38:11 +00001804 // We added edges from PI to the EdgeBB. As such, if there were any
1805 // PHI nodes in EdgeBB, they need entries to be added corresponding to
1806 // the number of edges added.
1807 for (BasicBlock::iterator BBI = EdgeBB->begin();
Reid Spencer66149462004-09-15 17:06:42 +00001808 isa<PHINode>(BBI); ++BBI) {
1809 PHINode *PN = cast<PHINode>(BBI);
Chris Lattner6f4b45a2004-02-24 05:38:11 +00001810 Value *InVal = PN->getIncomingValueForBlock(*PI);
1811 for (unsigned i = 0, e = Values.size()-1; i != e; ++i)
1812 PN->addIncoming(InVal, *PI);
1813 }
1814
1815 // Erase the old branch instruction.
1816 (*PI)->getInstList().erase(BI);
1817
1818 // Erase the potentially condition tree that was used to computed the
1819 // branch condition.
1820 ErasePossiblyDeadInstructionTree(Cond);
1821 return true;
1822 }
1823 }
1824
Chris Lattner18d1f192004-02-11 03:36:04 +00001825 // If there is a trivial two-entry PHI node in this basic block, and we can
1826 // eliminate it, do so now.
1827 if (PHINode *PN = dyn_cast<PHINode>(BB->begin()))
Chris Lattnercc14ebc2005-09-23 06:39:30 +00001828 if (PN->getNumIncomingValues() == 2)
1829 Changed |= FoldTwoEntryPHINode(PN);
Misha Brukmanb1c93172005-04-21 23:48:37 +00001830
Chris Lattner031340a2003-08-17 19:41:53 +00001831 return Changed;
Chris Lattner466a0492002-05-21 20:50:24 +00001832}