blob: faf4d9515af43cddf4b9d1df3f8854875cd7c5e2 [file] [log] [blame]
Chris Lattner21ab22e2004-07-31 10:01:27 +00001//===-- BranchFolding.cpp - Fold machine code branch instructions ---------===//
Misha Brukmanedf128a2005-04-21 22:36:52 +00002//
Chris Lattner21ab22e2004-07-31 10:01:27 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanedf128a2005-04-21 22:36:52 +00007//
Chris Lattner21ab22e2004-07-31 10:01:27 +00008//===----------------------------------------------------------------------===//
9//
10// This pass forwards branches to unconditional branches to make them branch
11// directly to the target block. This pass often results in dead MBB's, which
12// it then removes.
13//
14// Note that this pass must be run after register allocation, it cannot handle
15// SSA form.
16//
17//===----------------------------------------------------------------------===//
18
Chris Lattnerf10a56a2006-11-18 21:56:39 +000019#define DEBUG_TYPE "branchfolding"
Evan Cheng030a0a02009-09-04 07:47:40 +000020#include "BranchFolding.h"
Bob Wilson2c04dae2009-10-28 22:10:20 +000021#include "llvm/Function.h"
Chris Lattner21ab22e2004-07-31 10:01:27 +000022#include "llvm/CodeGen/Passes.h"
Jim Laskey44c3b9f2007-01-26 21:22:28 +000023#include "llvm/CodeGen/MachineModuleInfo.h"
Chris Lattner21ab22e2004-07-31 10:01:27 +000024#include "llvm/CodeGen/MachineFunctionPass.h"
Chris Lattnerc50ffcb2006-10-17 17:13:52 +000025#include "llvm/CodeGen/MachineJumpTableInfo.h"
Dale Johannesen69cb9b72007-03-20 21:35:06 +000026#include "llvm/CodeGen/RegisterScavenging.h"
Chris Lattner21ab22e2004-07-31 10:01:27 +000027#include "llvm/Target/TargetInstrInfo.h"
28#include "llvm/Target/TargetMachine.h"
Dan Gohman6f0d0242008-02-10 18:45:23 +000029#include "llvm/Target/TargetRegisterInfo.h"
Chris Lattner12143052006-10-21 00:47:49 +000030#include "llvm/Support/CommandLine.h"
Chris Lattnerf10a56a2006-11-18 21:56:39 +000031#include "llvm/Support/Debug.h"
Torok Edwinc25e7582009-07-11 20:10:48 +000032#include "llvm/Support/ErrorHandling.h"
Bill Wendling3403bcd2009-08-22 20:03:00 +000033#include "llvm/Support/raw_ostream.h"
Evan Cheng80b09fe2008-04-10 02:32:10 +000034#include "llvm/ADT/SmallSet.h"
Dan Gohman2210c0b2009-11-11 19:48:59 +000035#include "llvm/ADT/SetVector.h"
Chris Lattner12143052006-10-21 00:47:49 +000036#include "llvm/ADT/Statistic.h"
Reid Spencer551ccae2004-09-01 22:55:40 +000037#include "llvm/ADT/STLExtras.h"
Jeff Cohend41b30d2006-11-05 19:31:28 +000038#include <algorithm>
Chris Lattner21ab22e2004-07-31 10:01:27 +000039using namespace llvm;
40
Chris Lattnercd3245a2006-12-19 22:41:21 +000041STATISTIC(NumDeadBlocks, "Number of dead blocks removed");
42STATISTIC(NumBranchOpts, "Number of branches optimized");
43STATISTIC(NumTailMerge , "Number of block tails merged");
Bob Wilson7cd5d3e2009-11-18 19:29:37 +000044
Dan Gohman4e3f1252009-11-11 18:38:14 +000045static cl::opt<cl::boolOrDefault> FlagEnableTailMerge("enable-tail-merge",
Dale Johannesen81da02b2007-05-22 17:14:46 +000046 cl::init(cl::BOU_UNSET), cl::Hidden);
Bob Wilson7cd5d3e2009-11-18 19:29:37 +000047
Dan Gohman844731a2008-05-13 00:00:25 +000048// Throttle for huge numbers of predecessors (compile speed problems)
49static cl::opt<unsigned>
Dan Gohman4e3f1252009-11-11 18:38:14 +000050TailMergeThreshold("tail-merge-threshold",
Dan Gohman844731a2008-05-13 00:00:25 +000051 cl::desc("Max number of predecessors to consider tail merging"),
Dale Johannesen622addb2008-10-27 02:10:21 +000052 cl::init(150), cl::Hidden);
Dale Johannesen1a90a5a2007-06-08 01:08:52 +000053
Dan Gohman2210c0b2009-11-11 19:48:59 +000054// Heuristic for tail merging (and, inversely, tail duplication).
55// TODO: This should be replaced with a target query.
56static cl::opt<unsigned>
Bob Wilson3cbc3122009-11-16 17:56:13 +000057TailMergeSize("tail-merge-size",
Dan Gohman2210c0b2009-11-11 19:48:59 +000058 cl::desc("Min number of instructions to consider tail merging"),
59 cl::init(3), cl::Hidden);
Devang Patel794fd752007-05-01 21:15:47 +000060
Dan Gohman72b29902009-11-12 01:59:26 +000061namespace {
62 /// BranchFolderPass - Wrap branch folder in a machine function pass.
63 class BranchFolderPass : public MachineFunctionPass,
64 public BranchFolder {
65 public:
66 static char ID;
67 explicit BranchFolderPass(bool defaultEnableTailMerge)
68 : MachineFunctionPass(&ID), BranchFolder(defaultEnableTailMerge) {}
69
70 virtual bool runOnMachineFunction(MachineFunction &MF);
71 virtual const char *getPassName() const { return "Control Flow Optimizer"; }
72 };
73}
74
Evan Cheng030a0a02009-09-04 07:47:40 +000075char BranchFolderPass::ID = 0;
Chris Lattner21ab22e2004-07-31 10:01:27 +000076
Dan Gohman7cc253e2009-11-11 19:56:05 +000077FunctionPass *llvm::createBranchFoldingPass(bool DefaultEnableTailMerge) {
Bob Wilsona5971032009-10-28 20:46:46 +000078 return new BranchFolderPass(DefaultEnableTailMerge);
Evan Cheng030a0a02009-09-04 07:47:40 +000079}
80
81bool BranchFolderPass::runOnMachineFunction(MachineFunction &MF) {
82 return OptimizeFunction(MF,
83 MF.getTarget().getInstrInfo(),
84 MF.getTarget().getRegisterInfo(),
85 getAnalysisIfAvailable<MachineModuleInfo>());
86}
87
88
Bob Wilsona5971032009-10-28 20:46:46 +000089BranchFolder::BranchFolder(bool defaultEnableTailMerge) {
Evan Cheng030a0a02009-09-04 07:47:40 +000090 switch (FlagEnableTailMerge) {
91 case cl::BOU_UNSET: EnableTailMerge = defaultEnableTailMerge; break;
92 case cl::BOU_TRUE: EnableTailMerge = true; break;
93 case cl::BOU_FALSE: EnableTailMerge = false; break;
94 }
Evan Chengb3c27422009-09-03 23:54:22 +000095}
Chris Lattner21ab22e2004-07-31 10:01:27 +000096
Chris Lattnerc50ffcb2006-10-17 17:13:52 +000097/// RemoveDeadBlock - Remove the specified dead machine basic block from the
98/// function, updating the CFG.
Chris Lattner683747a2006-10-17 23:17:27 +000099void BranchFolder::RemoveDeadBlock(MachineBasicBlock *MBB) {
Jim Laskey033c9712007-02-22 16:39:03 +0000100 assert(MBB->pred_empty() && "MBB must be dead!");
David Greene465e2b92009-12-24 00:34:21 +0000101 DEBUG(dbgs() << "\nRemoving MBB: " << *MBB);
Dan Gohman4e3f1252009-11-11 18:38:14 +0000102
Chris Lattnerc50ffcb2006-10-17 17:13:52 +0000103 MachineFunction *MF = MBB->getParent();
104 // drop all successors.
105 while (!MBB->succ_empty())
106 MBB->removeSuccessor(MBB->succ_end()-1);
Dan Gohman4e3f1252009-11-11 18:38:14 +0000107
Duncan Sands68d4d1d2008-07-29 20:56:02 +0000108 // If there are any labels in the basic block, unregister them from
109 // MachineModuleInfo.
Jim Laskey44c3b9f2007-01-26 21:22:28 +0000110 if (MMI && !MBB->empty()) {
Chris Lattner683747a2006-10-17 23:17:27 +0000111 for (MachineBasicBlock::iterator I = MBB->begin(), E = MBB->end();
112 I != E; ++I) {
Duncan Sands68d4d1d2008-07-29 20:56:02 +0000113 if (I->isLabel())
Chris Lattner683747a2006-10-17 23:17:27 +0000114 // The label ID # is always operand #0, an immediate.
Jim Laskey44c3b9f2007-01-26 21:22:28 +0000115 MMI->InvalidateLabel(I->getOperand(0).getImm());
Chris Lattner683747a2006-10-17 23:17:27 +0000116 }
117 }
Dan Gohman4e3f1252009-11-11 18:38:14 +0000118
Chris Lattnerc50ffcb2006-10-17 17:13:52 +0000119 // Remove the block.
Dan Gohman8e5f2c62008-07-07 23:14:23 +0000120 MF->erase(MBB);
Chris Lattnerc50ffcb2006-10-17 17:13:52 +0000121}
122
Evan Cheng80b09fe2008-04-10 02:32:10 +0000123/// OptimizeImpDefsBlock - If a basic block is just a bunch of implicit_def
124/// followed by terminators, and if the implicitly defined registers are not
125/// used by the terminators, remove those implicit_def's. e.g.
126/// BB1:
127/// r0 = implicit_def
128/// r1 = implicit_def
129/// br
130/// This block can be optimized away later if the implicit instructions are
131/// removed.
132bool BranchFolder::OptimizeImpDefsBlock(MachineBasicBlock *MBB) {
133 SmallSet<unsigned, 4> ImpDefRegs;
134 MachineBasicBlock::iterator I = MBB->begin();
135 while (I != MBB->end()) {
Chris Lattner518bb532010-02-09 19:54:29 +0000136 if (!I->isImplicitDef())
Evan Cheng80b09fe2008-04-10 02:32:10 +0000137 break;
138 unsigned Reg = I->getOperand(0).getReg();
139 ImpDefRegs.insert(Reg);
Evan Cheng030a0a02009-09-04 07:47:40 +0000140 for (const unsigned *SubRegs = TRI->getSubRegisters(Reg);
Evan Cheng80b09fe2008-04-10 02:32:10 +0000141 unsigned SubReg = *SubRegs; ++SubRegs)
142 ImpDefRegs.insert(SubReg);
143 ++I;
144 }
145 if (ImpDefRegs.empty())
146 return false;
147
148 MachineBasicBlock::iterator FirstTerm = I;
149 while (I != MBB->end()) {
150 if (!TII->isUnpredicatedTerminator(I))
151 return false;
152 // See if it uses any of the implicitly defined registers.
153 for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
154 MachineOperand &MO = I->getOperand(i);
Dan Gohmand735b802008-10-03 15:45:36 +0000155 if (!MO.isReg() || !MO.isUse())
Evan Cheng80b09fe2008-04-10 02:32:10 +0000156 continue;
157 unsigned Reg = MO.getReg();
158 if (ImpDefRegs.count(Reg))
159 return false;
160 }
161 ++I;
162 }
163
164 I = MBB->begin();
165 while (I != FirstTerm) {
166 MachineInstr *ImpDefMI = &*I;
167 ++I;
168 MBB->erase(ImpDefMI);
169 }
170
171 return true;
172}
173
Evan Cheng030a0a02009-09-04 07:47:40 +0000174/// OptimizeFunction - Perhaps branch folding, tail merging and other
175/// CFG optimizations on the given function.
176bool BranchFolder::OptimizeFunction(MachineFunction &MF,
177 const TargetInstrInfo *tii,
178 const TargetRegisterInfo *tri,
179 MachineModuleInfo *mmi) {
180 if (!tii) return false;
Chris Lattner7821a8a2006-10-14 00:21:48 +0000181
Evan Cheng030a0a02009-09-04 07:47:40 +0000182 TII = tii;
183 TRI = tri;
184 MMI = mmi;
185
186 RS = TRI->requiresRegisterScavenging(MF) ? new RegScavenger() : NULL;
Evan Cheng80b09fe2008-04-10 02:32:10 +0000187
Dale Johannesen14ba0cc2007-05-15 21:19:17 +0000188 // Fix CFG. The later algorithms expect it to be right.
Evan Cheng030a0a02009-09-04 07:47:40 +0000189 bool MadeChange = false;
Dale Johannesen14ba0cc2007-05-15 21:19:17 +0000190 for (MachineFunction::iterator I = MF.begin(), E = MF.end(); I != E; I++) {
191 MachineBasicBlock *MBB = I, *TBB = 0, *FBB = 0;
Owen Anderson44eb65c2008-08-14 22:49:33 +0000192 SmallVector<MachineOperand, 4> Cond;
Evan Chengdc54d312009-02-09 07:14:22 +0000193 if (!TII->AnalyzeBranch(*MBB, TBB, FBB, Cond, true))
Evan Cheng030a0a02009-09-04 07:47:40 +0000194 MadeChange |= MBB->CorrectExtraCFGEdges(TBB, FBB, !Cond.empty());
195 MadeChange |= OptimizeImpDefsBlock(MBB);
Dale Johannesen14ba0cc2007-05-15 21:19:17 +0000196 }
197
Chris Lattner12143052006-10-21 00:47:49 +0000198 bool MadeChangeThisIteration = true;
199 while (MadeChangeThisIteration) {
200 MadeChangeThisIteration = false;
201 MadeChangeThisIteration |= TailMergeBlocks(MF);
202 MadeChangeThisIteration |= OptimizeBranches(MF);
Evan Cheng030a0a02009-09-04 07:47:40 +0000203 MadeChange |= MadeChangeThisIteration;
Chris Lattner21ab22e2004-07-31 10:01:27 +0000204 }
205
Chris Lattner6acfe122006-10-28 18:34:47 +0000206 // See if any jump tables have become mergable or dead as the code generator
207 // did its thing.
208 MachineJumpTableInfo *JTI = MF.getJumpTableInfo();
Chris Lattner071c62f2010-01-25 23:26:13 +0000209 if (JTI == 0) {
210 delete RS;
211 return MadeChange;
212 }
213
Chris Lattner6acfe122006-10-28 18:34:47 +0000214 const std::vector<MachineJumpTableEntry> &JTs = JTI->getJumpTables();
Chris Lattner071c62f2010-01-25 23:26:13 +0000215 // Figure out how these jump tables should be merged.
216 std::vector<unsigned> JTMapping;
217 JTMapping.reserve(JTs.size());
Dan Gohman4e3f1252009-11-11 18:38:14 +0000218
Chris Lattner071c62f2010-01-25 23:26:13 +0000219 // We always keep the 0th jump table.
220 JTMapping.push_back(0);
Chris Lattner6acfe122006-10-28 18:34:47 +0000221
Chris Lattner071c62f2010-01-25 23:26:13 +0000222 // Scan the jump tables, seeing if there are any duplicates. Note that this
223 // is N^2, which should be fixed someday.
224 for (unsigned i = 1, e = JTs.size(); i != e; ++i) {
225 if (JTs[i].MBBs.empty())
226 JTMapping.push_back(i);
227 else
228 JTMapping.push_back(JTI->getJumpTableIndex(JTs[i].MBBs));
229 }
Dan Gohman4e3f1252009-11-11 18:38:14 +0000230
Chris Lattner071c62f2010-01-25 23:26:13 +0000231 // If a jump table was merge with another one, walk the function rewriting
232 // references to jump tables to reference the new JT ID's. Keep track of
233 // whether we see a jump table idx, if not, we can delete the JT.
234 BitVector JTIsLive(JTs.size());
235 for (MachineFunction::iterator BB = MF.begin(), E = MF.end();
236 BB != E; ++BB) {
237 for (MachineBasicBlock::iterator I = BB->begin(), E = BB->end();
238 I != E; ++I)
239 for (unsigned op = 0, e = I->getNumOperands(); op != e; ++op) {
240 MachineOperand &Op = I->getOperand(op);
241 if (!Op.isJTI()) continue;
242 unsigned NewIdx = JTMapping[Op.getIndex()];
243 Op.setIndex(NewIdx);
Chris Lattner6acfe122006-10-28 18:34:47 +0000244
Chris Lattner071c62f2010-01-25 23:26:13 +0000245 // Remember that this JT is live.
246 JTIsLive.set(NewIdx);
Chris Lattner6acfe122006-10-28 18:34:47 +0000247 }
248 }
Evan Cheng030a0a02009-09-04 07:47:40 +0000249
Chris Lattner071c62f2010-01-25 23:26:13 +0000250 // Finally, remove dead jump tables. This happens either because the
251 // indirect jump was unreachable (and thus deleted) or because the jump
252 // table was merged with some other one.
253 for (unsigned i = 0, e = JTIsLive.size(); i != e; ++i)
254 if (!JTIsLive.test(i)) {
255 JTI->RemoveJumpTable(i);
256 MadeChange = true;
257 }
258
Dale Johannesen69cb9b72007-03-20 21:35:06 +0000259 delete RS;
Evan Cheng030a0a02009-09-04 07:47:40 +0000260 return MadeChange;
Chris Lattner21ab22e2004-07-31 10:01:27 +0000261}
262
Chris Lattner12143052006-10-21 00:47:49 +0000263//===----------------------------------------------------------------------===//
264// Tail Merging of Blocks
265//===----------------------------------------------------------------------===//
266
267/// HashMachineInstr - Compute a hash value for MI and its operands.
268static unsigned HashMachineInstr(const MachineInstr *MI) {
269 unsigned Hash = MI->getOpcode();
270 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
271 const MachineOperand &Op = MI->getOperand(i);
Dan Gohman4e3f1252009-11-11 18:38:14 +0000272
Chris Lattner12143052006-10-21 00:47:49 +0000273 // Merge in bits from the operand if easy.
274 unsigned OperandHash = 0;
275 switch (Op.getType()) {
276 case MachineOperand::MO_Register: OperandHash = Op.getReg(); break;
277 case MachineOperand::MO_Immediate: OperandHash = Op.getImm(); break;
278 case MachineOperand::MO_MachineBasicBlock:
Chris Lattner8aa797a2007-12-30 23:10:15 +0000279 OperandHash = Op.getMBB()->getNumber();
Chris Lattner12143052006-10-21 00:47:49 +0000280 break;
Chris Lattner8aa797a2007-12-30 23:10:15 +0000281 case MachineOperand::MO_FrameIndex:
Chris Lattner12143052006-10-21 00:47:49 +0000282 case MachineOperand::MO_ConstantPoolIndex:
Chris Lattner12143052006-10-21 00:47:49 +0000283 case MachineOperand::MO_JumpTableIndex:
Chris Lattner8aa797a2007-12-30 23:10:15 +0000284 OperandHash = Op.getIndex();
Chris Lattner12143052006-10-21 00:47:49 +0000285 break;
286 case MachineOperand::MO_GlobalAddress:
287 case MachineOperand::MO_ExternalSymbol:
288 // Global address / external symbol are too hard, don't bother, but do
289 // pull in the offset.
290 OperandHash = Op.getOffset();
291 break;
292 default: break;
293 }
Dan Gohman4e3f1252009-11-11 18:38:14 +0000294
Chris Lattner12143052006-10-21 00:47:49 +0000295 Hash += ((OperandHash << 3) | Op.getType()) << (i&31);
296 }
297 return Hash;
298}
299
Dale Johannesen7aea8322007-05-23 21:07:20 +0000300/// HashEndOfMBB - Hash the last few instructions in the MBB. For blocks
Dan Gohman4e3f1252009-11-11 18:38:14 +0000301/// with no successors, we hash two instructions, because cross-jumping
302/// only saves code when at least two instructions are removed (since a
Dale Johannesen7aea8322007-05-23 21:07:20 +0000303/// branch must be inserted). For blocks with a successor, one of the
304/// two blocks to be tail-merged will end with a branch already, so
305/// it gains to cross-jump even for one instruction.
Dale Johannesen7aea8322007-05-23 21:07:20 +0000306static unsigned HashEndOfMBB(const MachineBasicBlock *MBB,
307 unsigned minCommonTailLength) {
Chris Lattner12143052006-10-21 00:47:49 +0000308 MachineBasicBlock::const_iterator I = MBB->end();
309 if (I == MBB->begin())
310 return 0; // Empty MBB.
Dan Gohman4e3f1252009-11-11 18:38:14 +0000311
Chris Lattner12143052006-10-21 00:47:49 +0000312 --I;
313 unsigned Hash = HashMachineInstr(I);
Dan Gohman4e3f1252009-11-11 18:38:14 +0000314
Dale Johannesen7aea8322007-05-23 21:07:20 +0000315 if (I == MBB->begin() || minCommonTailLength == 1)
Chris Lattner12143052006-10-21 00:47:49 +0000316 return Hash; // Single instr MBB.
Dan Gohman4e3f1252009-11-11 18:38:14 +0000317
Chris Lattner12143052006-10-21 00:47:49 +0000318 --I;
319 // Hash in the second-to-last instruction.
320 Hash ^= HashMachineInstr(I) << 2;
321 return Hash;
322}
323
324/// ComputeCommonTailLength - Given two machine basic blocks, compute the number
325/// of instructions they actually have in common together at their end. Return
326/// iterators for the first shared instruction in each block.
327static unsigned ComputeCommonTailLength(MachineBasicBlock *MBB1,
328 MachineBasicBlock *MBB2,
329 MachineBasicBlock::iterator &I1,
330 MachineBasicBlock::iterator &I2) {
331 I1 = MBB1->end();
332 I2 = MBB2->end();
Dan Gohman4e3f1252009-11-11 18:38:14 +0000333
Chris Lattner12143052006-10-21 00:47:49 +0000334 unsigned TailLen = 0;
335 while (I1 != MBB1->begin() && I2 != MBB2->begin()) {
336 --I1; --I2;
Dan Gohman4e3f1252009-11-11 18:38:14 +0000337 if (!I1->isIdenticalTo(I2) ||
Bill Wendlingda6efc52007-10-25 19:49:32 +0000338 // FIXME: This check is dubious. It's used to get around a problem where
Bill Wendling0713a222007-10-25 18:23:45 +0000339 // people incorrectly expect inline asm directives to remain in the same
340 // relative order. This is untenable because normal compiler
341 // optimizations (like this one) may reorder and/or merge these
342 // directives.
Chris Lattner518bb532010-02-09 19:54:29 +0000343 I1->isInlineAsm()) {
Chris Lattner12143052006-10-21 00:47:49 +0000344 ++I1; ++I2;
345 break;
346 }
347 ++TailLen;
348 }
349 return TailLen;
350}
351
352/// ReplaceTailWithBranchTo - Delete the instruction OldInst and everything
Chris Lattner386e2902006-10-21 05:08:28 +0000353/// after it, replacing it with an unconditional branch to NewDest. This
354/// returns true if OldInst's block is modified, false if NewDest is modified.
Chris Lattner12143052006-10-21 00:47:49 +0000355void BranchFolder::ReplaceTailWithBranchTo(MachineBasicBlock::iterator OldInst,
356 MachineBasicBlock *NewDest) {
357 MachineBasicBlock *OldBB = OldInst->getParent();
Dan Gohman4e3f1252009-11-11 18:38:14 +0000358
Chris Lattner12143052006-10-21 00:47:49 +0000359 // Remove all the old successors of OldBB from the CFG.
360 while (!OldBB->succ_empty())
361 OldBB->removeSuccessor(OldBB->succ_begin());
Dan Gohman4e3f1252009-11-11 18:38:14 +0000362
Chris Lattner12143052006-10-21 00:47:49 +0000363 // Remove all the dead instructions from the end of OldBB.
364 OldBB->erase(OldInst, OldBB->end());
365
Chris Lattner386e2902006-10-21 05:08:28 +0000366 // If OldBB isn't immediately before OldBB, insert a branch to it.
367 if (++MachineFunction::iterator(OldBB) != MachineFunction::iterator(NewDest))
Dan Gohman1501cdb2008-08-22 16:07:55 +0000368 TII->InsertBranch(*OldBB, NewDest, 0, SmallVector<MachineOperand, 0>());
Chris Lattner12143052006-10-21 00:47:49 +0000369 OldBB->addSuccessor(NewDest);
370 ++NumTailMerge;
371}
372
Chris Lattner1d08d832006-11-01 01:16:12 +0000373/// SplitMBBAt - Given a machine basic block and an iterator into it, split the
374/// MBB so that the part before the iterator falls into the part starting at the
375/// iterator. This returns the new MBB.
376MachineBasicBlock *BranchFolder::SplitMBBAt(MachineBasicBlock &CurMBB,
377 MachineBasicBlock::iterator BBI1) {
Dan Gohman8e5f2c62008-07-07 23:14:23 +0000378 MachineFunction &MF = *CurMBB.getParent();
379
Chris Lattner1d08d832006-11-01 01:16:12 +0000380 // Create the fall-through block.
381 MachineFunction::iterator MBBI = &CurMBB;
Dan Gohman8e5f2c62008-07-07 23:14:23 +0000382 MachineBasicBlock *NewMBB =MF.CreateMachineBasicBlock(CurMBB.getBasicBlock());
383 CurMBB.getParent()->insert(++MBBI, NewMBB);
Chris Lattner1d08d832006-11-01 01:16:12 +0000384
385 // Move all the successors of this block to the specified block.
Dan Gohman04478e52008-06-19 17:22:29 +0000386 NewMBB->transferSuccessors(&CurMBB);
Dan Gohman4e3f1252009-11-11 18:38:14 +0000387
Chris Lattner1d08d832006-11-01 01:16:12 +0000388 // Add an edge from CurMBB to NewMBB for the fall-through.
389 CurMBB.addSuccessor(NewMBB);
Dan Gohman4e3f1252009-11-11 18:38:14 +0000390
Chris Lattner1d08d832006-11-01 01:16:12 +0000391 // Splice the code over.
392 NewMBB->splice(NewMBB->end(), &CurMBB, BBI1, CurMBB.end());
Dale Johannesen69cb9b72007-03-20 21:35:06 +0000393
394 // For targets that use the register scavenger, we must maintain LiveIns.
395 if (RS) {
396 RS->enterBasicBlock(&CurMBB);
397 if (!CurMBB.empty())
398 RS->forward(prior(CurMBB.end()));
Evan Cheng030a0a02009-09-04 07:47:40 +0000399 BitVector RegsLiveAtExit(TRI->getNumRegs());
Dale Johannesen69cb9b72007-03-20 21:35:06 +0000400 RS->getRegsUsed(RegsLiveAtExit, false);
Dan Gohman8520149d2009-11-12 01:51:28 +0000401 for (unsigned int i = 0, e = TRI->getNumRegs(); i != e; i++)
Dale Johannesen69cb9b72007-03-20 21:35:06 +0000402 if (RegsLiveAtExit[i])
403 NewMBB->addLiveIn(i);
404 }
405
Chris Lattner1d08d832006-11-01 01:16:12 +0000406 return NewMBB;
407}
408
Chris Lattnerd4bf3c22006-11-01 19:36:29 +0000409/// EstimateRuntime - Make a rough estimate for how long it will take to run
410/// the specified code.
411static unsigned EstimateRuntime(MachineBasicBlock::iterator I,
Chris Lattner69244302008-01-07 01:56:04 +0000412 MachineBasicBlock::iterator E) {
Chris Lattnerd4bf3c22006-11-01 19:36:29 +0000413 unsigned Time = 0;
414 for (; I != E; ++I) {
Chris Lattner749c6f62008-01-07 07:27:27 +0000415 const TargetInstrDesc &TID = I->getDesc();
416 if (TID.isCall())
Chris Lattnerd4bf3c22006-11-01 19:36:29 +0000417 Time += 10;
Dan Gohman41474ba2008-12-03 02:30:17 +0000418 else if (TID.mayLoad() || TID.mayStore())
Chris Lattnerd4bf3c22006-11-01 19:36:29 +0000419 Time += 2;
420 else
421 ++Time;
422 }
423 return Time;
424}
425
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000426// CurMBB needs to add an unconditional branch to SuccMBB (we removed these
427// branches temporarily for tail merging). In the case where CurMBB ends
428// with a conditional branch to the next block, optimize by reversing the
429// test and conditionally branching to SuccMBB instead.
Bob Wilsond34f5d92009-11-16 18:08:46 +0000430static void FixTail(MachineBasicBlock *CurMBB, MachineBasicBlock *SuccBB,
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000431 const TargetInstrInfo *TII) {
432 MachineFunction *MF = CurMBB->getParent();
Chris Lattner7896c9f2009-12-03 00:50:42 +0000433 MachineFunction::iterator I = llvm::next(MachineFunction::iterator(CurMBB));
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000434 MachineBasicBlock *TBB = 0, *FBB = 0;
Owen Anderson44eb65c2008-08-14 22:49:33 +0000435 SmallVector<MachineOperand, 4> Cond;
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000436 if (I != MF->end() &&
Evan Chengdc54d312009-02-09 07:14:22 +0000437 !TII->AnalyzeBranch(*CurMBB, TBB, FBB, Cond, true)) {
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000438 MachineBasicBlock *NextBB = I;
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000439 if (TBB == NextBB && !Cond.empty() && !FBB) {
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000440 if (!TII->ReverseBranchCondition(Cond)) {
441 TII->RemoveBranch(*CurMBB);
442 TII->InsertBranch(*CurMBB, SuccBB, NULL, Cond);
443 return;
444 }
445 }
446 }
Dan Gohman1501cdb2008-08-22 16:07:55 +0000447 TII->InsertBranch(*CurMBB, SuccBB, NULL, SmallVector<MachineOperand, 0>());
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000448}
449
Dan Gohmanffe644e2009-11-11 21:57:02 +0000450bool
451BranchFolder::MergePotentialsElt::operator<(const MergePotentialsElt &o) const {
452 if (getHash() < o.getHash())
453 return true;
454 else if (getHash() > o.getHash())
455 return false;
456 else if (getBlock()->getNumber() < o.getBlock()->getNumber())
457 return true;
458 else if (getBlock()->getNumber() > o.getBlock()->getNumber())
459 return false;
460 else {
461 // _GLIBCXX_DEBUG checks strict weak ordering, which involves comparing
462 // an object with itself.
Duncan Sands97b4ac82007-07-11 08:47:55 +0000463#ifndef _GLIBCXX_DEBUG
Dan Gohmanffe644e2009-11-11 21:57:02 +0000464 llvm_unreachable("Predecessor appears twice");
David Greene67fcdf72007-07-10 22:00:30 +0000465#endif
Dan Gohmanffe644e2009-11-11 21:57:02 +0000466 return false;
467 }
Dale Johannesen95ef4062007-05-29 23:47:50 +0000468}
469
Dan Gohman2210c0b2009-11-11 19:48:59 +0000470/// CountTerminators - Count the number of terminators in the given
471/// block and set I to the position of the first non-terminator, if there
472/// is one, or MBB->end() otherwise.
473static unsigned CountTerminators(MachineBasicBlock *MBB,
474 MachineBasicBlock::iterator &I) {
475 I = MBB->end();
476 unsigned NumTerms = 0;
477 for (;;) {
478 if (I == MBB->begin()) {
479 I = MBB->end();
480 break;
481 }
482 --I;
483 if (!I->getDesc().isTerminator()) break;
484 ++NumTerms;
485 }
486 return NumTerms;
487}
488
Bob Wilson7b888b82009-10-29 18:40:06 +0000489/// ProfitableToMerge - Check if two machine basic blocks have a common tail
490/// and decide if it would be profitable to merge those tails. Return the
491/// length of the common tail and iterators to the first common instruction
492/// in each block.
493static bool ProfitableToMerge(MachineBasicBlock *MBB1,
494 MachineBasicBlock *MBB2,
495 unsigned minCommonTailLength,
496 unsigned &CommonTailLen,
497 MachineBasicBlock::iterator &I1,
Dan Gohman2210c0b2009-11-11 19:48:59 +0000498 MachineBasicBlock::iterator &I2,
499 MachineBasicBlock *SuccBB,
500 MachineBasicBlock *PredBB) {
Bob Wilson7b888b82009-10-29 18:40:06 +0000501 CommonTailLen = ComputeCommonTailLength(MBB1, MBB2, I1, I2);
502 MachineFunction *MF = MBB1->getParent();
503
Bob Wilson7b888b82009-10-29 18:40:06 +0000504 if (CommonTailLen == 0)
505 return false;
506
Dan Gohman2210c0b2009-11-11 19:48:59 +0000507 // It's almost always profitable to merge any number of non-terminator
508 // instructions with the block that falls through into the common successor.
509 if (MBB1 == PredBB || MBB2 == PredBB) {
510 MachineBasicBlock::iterator I;
511 unsigned NumTerms = CountTerminators(MBB1 == PredBB ? MBB2 : MBB1, I);
512 if (CommonTailLen > NumTerms)
513 return true;
514 }
515
Dan Gohmanad6af452009-11-12 00:39:10 +0000516 // If one of the blocks can be completely merged and happens to be in
517 // a position where the other could fall through into it, merge any number
518 // of instructions, because it can be done without a branch.
519 // TODO: If the blocks are not adjacent, move one of them so that they are?
520 if (MBB1->isLayoutSuccessor(MBB2) && I2 == MBB2->begin())
521 return true;
522 if (MBB2->isLayoutSuccessor(MBB1) && I1 == MBB1->begin())
523 return true;
524
Dan Gohman2210c0b2009-11-11 19:48:59 +0000525 // If both blocks have an unconditional branch temporarily stripped out,
Dan Gohmanc4c550c2009-11-13 21:02:15 +0000526 // count that as an additional common instruction for the following
527 // heuristics.
528 unsigned EffectiveTailLen = CommonTailLen;
Bob Wilson3cbc3122009-11-16 17:56:13 +0000529 if (SuccBB && MBB1 != PredBB && MBB2 != PredBB &&
Dan Gohman2210c0b2009-11-11 19:48:59 +0000530 !MBB1->back().getDesc().isBarrier() &&
531 !MBB2->back().getDesc().isBarrier())
Dan Gohmanc4c550c2009-11-13 21:02:15 +0000532 ++EffectiveTailLen;
Dan Gohman2210c0b2009-11-11 19:48:59 +0000533
534 // Check if the common tail is long enough to be worthwhile.
Dan Gohmanc4c550c2009-11-13 21:02:15 +0000535 if (EffectiveTailLen >= minCommonTailLength)
Dan Gohman2210c0b2009-11-11 19:48:59 +0000536 return true;
537
Dan Gohmanc4c550c2009-11-13 21:02:15 +0000538 // If we are optimizing for code size, 2 instructions in common is enough if
539 // we don't have to split a block. At worst we will be introducing 1 new
540 // branch instruction, which is likely to be smaller than the 2
541 // instructions that would be deleted in the merge.
542 if (EffectiveTailLen >= 2 &&
543 MF->getFunction()->hasFnAttr(Attribute::OptimizeForSize) &&
Bob Wilson7b888b82009-10-29 18:40:06 +0000544 (I1 == MBB1->begin() || I2 == MBB2->begin()))
545 return true;
546
547 return false;
548}
549
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000550/// ComputeSameTails - Look through all the blocks in MergePotentials that have
Dan Gohman4e3f1252009-11-11 18:38:14 +0000551/// hash CurHash (guaranteed to match the last element). Build the vector
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000552/// SameTails of all those that have the (same) largest number of instructions
553/// in common of any pair of these blocks. SameTails entries contain an
Dan Gohman4e3f1252009-11-11 18:38:14 +0000554/// iterator into MergePotentials (from which the MachineBasicBlock can be
555/// found) and a MachineBasicBlock::iterator into that MBB indicating the
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000556/// instruction where the matching code sequence begins.
557/// Order of elements in SameTails is the reverse of the order in which
558/// those blocks appear in MergePotentials (where they are not necessarily
559/// consecutive).
Dan Gohman4e3f1252009-11-11 18:38:14 +0000560unsigned BranchFolder::ComputeSameTails(unsigned CurHash,
Dan Gohman2210c0b2009-11-11 19:48:59 +0000561 unsigned minCommonTailLength,
562 MachineBasicBlock *SuccBB,
563 MachineBasicBlock *PredBB) {
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000564 unsigned maxCommonTailLength = 0U;
565 SameTails.clear();
566 MachineBasicBlock::iterator TrialBBI1, TrialBBI2;
567 MPIterator HighestMPIter = prior(MergePotentials.end());
568 for (MPIterator CurMPIter = prior(MergePotentials.end()),
Dan Gohman4e3f1252009-11-11 18:38:14 +0000569 B = MergePotentials.begin();
Dan Gohman8520149d2009-11-12 01:51:28 +0000570 CurMPIter != B && CurMPIter->getHash() == CurHash;
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000571 --CurMPIter) {
Dan Gohmanffe644e2009-11-11 21:57:02 +0000572 for (MPIterator I = prior(CurMPIter); I->getHash() == CurHash ; --I) {
Bob Wilson7b888b82009-10-29 18:40:06 +0000573 unsigned CommonTailLen;
Dan Gohmanffe644e2009-11-11 21:57:02 +0000574 if (ProfitableToMerge(CurMPIter->getBlock(), I->getBlock(),
575 minCommonTailLength,
Dan Gohman2210c0b2009-11-11 19:48:59 +0000576 CommonTailLen, TrialBBI1, TrialBBI2,
577 SuccBB, PredBB)) {
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000578 if (CommonTailLen > maxCommonTailLength) {
579 SameTails.clear();
580 maxCommonTailLength = CommonTailLen;
581 HighestMPIter = CurMPIter;
Dan Gohmanffe644e2009-11-11 21:57:02 +0000582 SameTails.push_back(SameTailElt(CurMPIter, TrialBBI1));
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000583 }
584 if (HighestMPIter == CurMPIter &&
585 CommonTailLen == maxCommonTailLength)
Dan Gohmanffe644e2009-11-11 21:57:02 +0000586 SameTails.push_back(SameTailElt(I, TrialBBI2));
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000587 }
Dan Gohman4e3f1252009-11-11 18:38:14 +0000588 if (I == B)
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000589 break;
590 }
591 }
592 return maxCommonTailLength;
593}
594
595/// RemoveBlocksWithHash - Remove all blocks with hash CurHash from
596/// MergePotentials, restoring branches at ends of blocks as appropriate.
Dan Gohman4e3f1252009-11-11 18:38:14 +0000597void BranchFolder::RemoveBlocksWithHash(unsigned CurHash,
Bob Wilsond34f5d92009-11-16 18:08:46 +0000598 MachineBasicBlock *SuccBB,
599 MachineBasicBlock *PredBB) {
Dale Johannesen679860e2008-05-23 17:19:02 +0000600 MPIterator CurMPIter, B;
Dan Gohman4e3f1252009-11-11 18:38:14 +0000601 for (CurMPIter = prior(MergePotentials.end()), B = MergePotentials.begin();
Dan Gohmanffe644e2009-11-11 21:57:02 +0000602 CurMPIter->getHash() == CurHash;
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000603 --CurMPIter) {
604 // Put the unconditional branch back, if we need one.
Dan Gohmanffe644e2009-11-11 21:57:02 +0000605 MachineBasicBlock *CurMBB = CurMPIter->getBlock();
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000606 if (SuccBB && CurMBB != PredBB)
607 FixTail(CurMBB, SuccBB, TII);
Dan Gohman4e3f1252009-11-11 18:38:14 +0000608 if (CurMPIter == B)
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000609 break;
610 }
Dan Gohmanffe644e2009-11-11 21:57:02 +0000611 if (CurMPIter->getHash() != CurHash)
Dale Johannesen679860e2008-05-23 17:19:02 +0000612 CurMPIter++;
613 MergePotentials.erase(CurMPIter, MergePotentials.end());
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000614}
615
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000616/// CreateCommonTailOnlyBlock - None of the blocks to be tail-merged consist
617/// only of the common tail. Create a block that does by splitting one.
618unsigned BranchFolder::CreateCommonTailOnlyBlock(MachineBasicBlock *&PredBB,
619 unsigned maxCommonTailLength) {
Dan Gohman8520149d2009-11-12 01:51:28 +0000620 unsigned commonTailIndex = 0;
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000621 unsigned TimeEstimate = ~0U;
Dan Gohman8520149d2009-11-12 01:51:28 +0000622 for (unsigned i = 0, e = SameTails.size(); i != e; ++i) {
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000623 // Use PredBB if possible; that doesn't require a new branch.
Dan Gohmanffe644e2009-11-11 21:57:02 +0000624 if (SameTails[i].getBlock() == PredBB) {
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000625 commonTailIndex = i;
626 break;
627 }
628 // Otherwise, make a (fairly bogus) choice based on estimate of
629 // how long it will take the various blocks to execute.
Dan Gohmanffe644e2009-11-11 21:57:02 +0000630 unsigned t = EstimateRuntime(SameTails[i].getBlock()->begin(),
631 SameTails[i].getTailStartPos());
Dan Gohman4e3f1252009-11-11 18:38:14 +0000632 if (t <= TimeEstimate) {
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000633 TimeEstimate = t;
634 commonTailIndex = i;
635 }
636 }
637
Dan Gohmanffe644e2009-11-11 21:57:02 +0000638 MachineBasicBlock::iterator BBI =
639 SameTails[commonTailIndex].getTailStartPos();
640 MachineBasicBlock *MBB = SameTails[commonTailIndex].getBlock();
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000641
David Greene465e2b92009-12-24 00:34:21 +0000642 DEBUG(dbgs() << "\nSplitting BB#" << MBB->getNumber() << ", size "
Bill Wendling3403bcd2009-08-22 20:03:00 +0000643 << maxCommonTailLength);
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000644
645 MachineBasicBlock *newMBB = SplitMBBAt(*MBB, BBI);
Dan Gohmanffe644e2009-11-11 21:57:02 +0000646 SameTails[commonTailIndex].setBlock(newMBB);
647 SameTails[commonTailIndex].setTailStartPos(newMBB->begin());
Dan Gohman4e3f1252009-11-11 18:38:14 +0000648
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000649 // If we split PredBB, newMBB is the new predecessor.
Dan Gohman4e3f1252009-11-11 18:38:14 +0000650 if (PredBB == MBB)
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000651 PredBB = newMBB;
652
653 return commonTailIndex;
654}
655
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000656// See if any of the blocks in MergePotentials (which all have a common single
657// successor, or all have no successor) can be tail-merged. If there is a
658// successor, any blocks in MergePotentials that are not tail-merged and
659// are not immediately before Succ must have an unconditional branch to
Dan Gohman4e3f1252009-11-11 18:38:14 +0000660// Succ added (but the predecessor/successor lists need no adjustment).
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000661// The lone predecessor of Succ that falls through into Succ,
662// if any, is given in PredBB.
663
Dan Gohman2210c0b2009-11-11 19:48:59 +0000664bool BranchFolder::TryTailMergeBlocks(MachineBasicBlock *SuccBB,
Bob Wilsond34f5d92009-11-16 18:08:46 +0000665 MachineBasicBlock *PredBB) {
Evan Cheng030a0a02009-09-04 07:47:40 +0000666 bool MadeChange = false;
667
Dan Gohman2210c0b2009-11-11 19:48:59 +0000668 // Except for the special cases below, tail-merge if there are at least
669 // this many instructions in common.
670 unsigned minCommonTailLength = TailMergeSize;
Dan Gohman4e3f1252009-11-11 18:38:14 +0000671
David Greene465e2b92009-12-24 00:34:21 +0000672 DEBUG(dbgs() << "\nTryTailMergeBlocks: ";
Dan Gohman2210c0b2009-11-11 19:48:59 +0000673 for (unsigned i = 0, e = MergePotentials.size(); i != e; ++i)
David Greene465e2b92009-12-24 00:34:21 +0000674 dbgs() << "BB#" << MergePotentials[i].getBlock()->getNumber()
Dan Gohman2210c0b2009-11-11 19:48:59 +0000675 << (i == e-1 ? "" : ", ");
David Greene465e2b92009-12-24 00:34:21 +0000676 dbgs() << "\n";
Dan Gohman2210c0b2009-11-11 19:48:59 +0000677 if (SuccBB) {
David Greene465e2b92009-12-24 00:34:21 +0000678 dbgs() << " with successor BB#" << SuccBB->getNumber() << '\n';
Dan Gohman2210c0b2009-11-11 19:48:59 +0000679 if (PredBB)
David Greene465e2b92009-12-24 00:34:21 +0000680 dbgs() << " which has fall-through from BB#"
Dan Gohman2210c0b2009-11-11 19:48:59 +0000681 << PredBB->getNumber() << "\n";
682 }
David Greene465e2b92009-12-24 00:34:21 +0000683 dbgs() << "Looking for common tails of at least "
Dan Gohman2210c0b2009-11-11 19:48:59 +0000684 << minCommonTailLength << " instruction"
685 << (minCommonTailLength == 1 ? "" : "s") << '\n';
686 );
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000687
Chris Lattner12143052006-10-21 00:47:49 +0000688 // Sort by hash value so that blocks with identical end sequences sort
689 // together.
Dan Gohmanffe644e2009-11-11 21:57:02 +0000690 std::stable_sort(MergePotentials.begin(), MergePotentials.end());
Chris Lattner12143052006-10-21 00:47:49 +0000691
692 // Walk through equivalence sets looking for actual exact matches.
693 while (MergePotentials.size() > 1) {
Dan Gohmanffe644e2009-11-11 21:57:02 +0000694 unsigned CurHash = MergePotentials.back().getHash();
Dan Gohman4e3f1252009-11-11 18:38:14 +0000695
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000696 // Build SameTails, identifying the set of blocks with this hash code
697 // and with the maximum number of instructions in common.
Dan Gohman4e3f1252009-11-11 18:38:14 +0000698 unsigned maxCommonTailLength = ComputeSameTails(CurHash,
Dan Gohman2210c0b2009-11-11 19:48:59 +0000699 minCommonTailLength,
700 SuccBB, PredBB);
Dale Johannesen7aea8322007-05-23 21:07:20 +0000701
Dan Gohman4e3f1252009-11-11 18:38:14 +0000702 // If we didn't find any pair that has at least minCommonTailLength
Dale Johannesen6ae83fa2008-05-09 21:24:35 +0000703 // instructions in common, remove all blocks with this hash code and retry.
704 if (SameTails.empty()) {
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000705 RemoveBlocksWithHash(CurHash, SuccBB, PredBB);
Dale Johannesen7aea8322007-05-23 21:07:20 +0000706 continue;
Chris Lattner12143052006-10-21 00:47:49 +0000707 }
Chris Lattner1d08d832006-11-01 01:16:12 +0000708
Dale Johannesen6ae83fa2008-05-09 21:24:35 +0000709 // If one of the blocks is the entire common tail (and not the entry
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000710 // block, which we can't jump to), we can treat all blocks with this same
711 // tail at once. Use PredBB if that is one of the possibilities, as that
712 // will not introduce any extra branches.
Dan Gohmanffe644e2009-11-11 21:57:02 +0000713 MachineBasicBlock *EntryBB = MergePotentials.begin()->getBlock()->
714 getParent()->begin();
715 unsigned commonTailIndex = SameTails.size();
Dan Gohmanad6af452009-11-12 00:39:10 +0000716 // If there are two blocks, check to see if one can be made to fall through
717 // into the other.
718 if (SameTails.size() == 2 &&
719 SameTails[0].getBlock()->isLayoutSuccessor(SameTails[1].getBlock()) &&
720 SameTails[1].tailIsWholeBlock())
721 commonTailIndex = 1;
722 else if (SameTails.size() == 2 &&
723 SameTails[1].getBlock()->isLayoutSuccessor(
724 SameTails[0].getBlock()) &&
725 SameTails[0].tailIsWholeBlock())
726 commonTailIndex = 0;
727 else {
728 // Otherwise just pick one, favoring the fall-through predecessor if
729 // there is one.
730 for (unsigned i = 0, e = SameTails.size(); i != e; ++i) {
731 MachineBasicBlock *MBB = SameTails[i].getBlock();
732 if (MBB == EntryBB && SameTails[i].tailIsWholeBlock())
733 continue;
734 if (MBB == PredBB) {
735 commonTailIndex = i;
736 break;
737 }
738 if (SameTails[i].tailIsWholeBlock())
739 commonTailIndex = i;
Dale Johannesen6ae83fa2008-05-09 21:24:35 +0000740 }
Dale Johannesen6ae83fa2008-05-09 21:24:35 +0000741 }
Dale Johannesena5a21172007-06-01 23:02:45 +0000742
Dan Gohman2210c0b2009-11-11 19:48:59 +0000743 if (commonTailIndex == SameTails.size() ||
Dan Gohmanffe644e2009-11-11 21:57:02 +0000744 (SameTails[commonTailIndex].getBlock() == PredBB &&
745 !SameTails[commonTailIndex].tailIsWholeBlock())) {
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000746 // None of the blocks consist entirely of the common tail.
747 // Split a block so that one does.
Dan Gohman2210c0b2009-11-11 19:48:59 +0000748 commonTailIndex = CreateCommonTailOnlyBlock(PredBB, maxCommonTailLength);
Chris Lattner1d08d832006-11-01 01:16:12 +0000749 }
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000750
Dan Gohmanffe644e2009-11-11 21:57:02 +0000751 MachineBasicBlock *MBB = SameTails[commonTailIndex].getBlock();
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000752 // MBB is common tail. Adjust all other BB's to jump to this one.
753 // Traversal must be forwards so erases work.
David Greene465e2b92009-12-24 00:34:21 +0000754 DEBUG(dbgs() << "\nUsing common tail in BB#" << MBB->getNumber()
Dan Gohman2210c0b2009-11-11 19:48:59 +0000755 << " for ");
756 for (unsigned int i=0, e = SameTails.size(); i != e; ++i) {
Dan Gohman4e3f1252009-11-11 18:38:14 +0000757 if (commonTailIndex == i)
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000758 continue;
David Greene465e2b92009-12-24 00:34:21 +0000759 DEBUG(dbgs() << "BB#" << SameTails[i].getBlock()->getNumber()
Dan Gohman2210c0b2009-11-11 19:48:59 +0000760 << (i == e-1 ? "" : ", "));
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000761 // Hack the end off BB i, making it jump to BB commonTailIndex instead.
Dan Gohmanffe644e2009-11-11 21:57:02 +0000762 ReplaceTailWithBranchTo(SameTails[i].getTailStartPos(), MBB);
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000763 // BB i is no longer a predecessor of SuccBB; remove it from the worklist.
Dan Gohmanffe644e2009-11-11 21:57:02 +0000764 MergePotentials.erase(SameTails[i].getMPIter());
Chris Lattner12143052006-10-21 00:47:49 +0000765 }
David Greene465e2b92009-12-24 00:34:21 +0000766 DEBUG(dbgs() << "\n");
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000767 // We leave commonTailIndex in the worklist in case there are other blocks
768 // that match it with a smaller number of instructions.
Chris Lattner1d08d832006-11-01 01:16:12 +0000769 MadeChange = true;
Chris Lattner12143052006-10-21 00:47:49 +0000770 }
Chris Lattner12143052006-10-21 00:47:49 +0000771 return MadeChange;
772}
773
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000774bool BranchFolder::TailMergeBlocks(MachineFunction &MF) {
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000775
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000776 if (!EnableTailMerge) return false;
Dan Gohman4e3f1252009-11-11 18:38:14 +0000777
Evan Cheng030a0a02009-09-04 07:47:40 +0000778 bool MadeChange = false;
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000779
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000780 // First find blocks with no successors.
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000781 MergePotentials.clear();
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000782 for (MachineFunction::iterator I = MF.begin(), E = MF.end(); I != E; ++I) {
783 if (I->succ_empty())
Dan Gohmanffe644e2009-11-11 21:57:02 +0000784 MergePotentials.push_back(MergePotentialsElt(HashEndOfMBB(I, 2U), I));
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000785 }
Dan Gohman4e3f1252009-11-11 18:38:14 +0000786
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000787 // See if we can do any tail merging on those.
Dale Johannesen6ae83fa2008-05-09 21:24:35 +0000788 if (MergePotentials.size() < TailMergeThreshold &&
789 MergePotentials.size() >= 2)
Dan Gohman2210c0b2009-11-11 19:48:59 +0000790 MadeChange |= TryTailMergeBlocks(NULL, NULL);
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000791
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000792 // Look at blocks (IBB) with multiple predecessors (PBB).
793 // We change each predecessor to a canonical form, by
794 // (1) temporarily removing any unconditional branch from the predecessor
795 // to IBB, and
796 // (2) alter conditional branches so they branch to the other block
Dan Gohman4e3f1252009-11-11 18:38:14 +0000797 // not IBB; this may require adding back an unconditional branch to IBB
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000798 // later, where there wasn't one coming in. E.g.
799 // Bcc IBB
800 // fallthrough to QBB
801 // here becomes
802 // Bncc QBB
803 // with a conceptual B to IBB after that, which never actually exists.
804 // With those changes, we see whether the predecessors' tails match,
805 // and merge them if so. We change things out of canonical form and
806 // back to the way they were later in the process. (OptimizeBranches
807 // would undo some of this, but we can't use it, because we'd get into
808 // a compile-time infinite loop repeatedly doing and undoing the same
809 // transformations.)
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000810
Chris Lattner7896c9f2009-12-03 00:50:42 +0000811 for (MachineFunction::iterator I = llvm::next(MF.begin()), E = MF.end();
Dan Gohman2210c0b2009-11-11 19:48:59 +0000812 I != E; ++I) {
Dale Johannesen62bc8a42008-07-01 21:50:14 +0000813 if (I->pred_size() >= 2 && I->pred_size() < TailMergeThreshold) {
Dan Gohmanda658222009-08-18 15:18:18 +0000814 SmallPtrSet<MachineBasicBlock *, 8> UniquePreds;
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000815 MachineBasicBlock *IBB = I;
816 MachineBasicBlock *PredBB = prior(I);
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000817 MergePotentials.clear();
Dan Gohman4e3f1252009-11-11 18:38:14 +0000818 for (MachineBasicBlock::pred_iterator P = I->pred_begin(),
Dale Johannesen1a90a5a2007-06-08 01:08:52 +0000819 E2 = I->pred_end();
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000820 P != E2; ++P) {
Bob Wilsond34f5d92009-11-16 18:08:46 +0000821 MachineBasicBlock *PBB = *P;
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000822 // Skip blocks that loop to themselves, can't tail merge these.
Dan Gohman4e3f1252009-11-11 18:38:14 +0000823 if (PBB == IBB)
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000824 continue;
Dan Gohmanda658222009-08-18 15:18:18 +0000825 // Visit each predecessor only once.
826 if (!UniquePreds.insert(PBB))
827 continue;
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000828 MachineBasicBlock *TBB = 0, *FBB = 0;
Owen Anderson44eb65c2008-08-14 22:49:33 +0000829 SmallVector<MachineOperand, 4> Cond;
Evan Chengdc54d312009-02-09 07:14:22 +0000830 if (!TII->AnalyzeBranch(*PBB, TBB, FBB, Cond, true)) {
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000831 // Failing case: IBB is the target of a cbr, and
832 // we cannot reverse the branch.
Owen Anderson44eb65c2008-08-14 22:49:33 +0000833 SmallVector<MachineOperand, 4> NewCond(Cond);
Dan Gohman4e3f1252009-11-11 18:38:14 +0000834 if (!Cond.empty() && TBB == IBB) {
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000835 if (TII->ReverseBranchCondition(NewCond))
836 continue;
837 // This is the QBB case described above
838 if (!FBB)
Chris Lattner7896c9f2009-12-03 00:50:42 +0000839 FBB = llvm::next(MachineFunction::iterator(PBB));
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000840 }
Dale Johannesenfe7e3972007-06-04 23:52:54 +0000841 // Failing case: the only way IBB can be reached from PBB is via
842 // exception handling. Happens for landing pads. Would be nice
843 // to have a bit in the edge so we didn't have to do all this.
844 if (IBB->isLandingPad()) {
845 MachineFunction::iterator IP = PBB; IP++;
Bob Wilsond34f5d92009-11-16 18:08:46 +0000846 MachineBasicBlock *PredNextBB = NULL;
Dan Gohman8520149d2009-11-12 01:51:28 +0000847 if (IP != MF.end())
Dale Johannesenfe7e3972007-06-04 23:52:54 +0000848 PredNextBB = IP;
Dan Gohman4e3f1252009-11-11 18:38:14 +0000849 if (TBB == NULL) {
Dan Gohman8520149d2009-11-12 01:51:28 +0000850 if (IBB != PredNextBB) // fallthrough
Dale Johannesenfe7e3972007-06-04 23:52:54 +0000851 continue;
852 } else if (FBB) {
Dan Gohman8520149d2009-11-12 01:51:28 +0000853 if (TBB != IBB && FBB != IBB) // cbr then ubr
Dale Johannesenfe7e3972007-06-04 23:52:54 +0000854 continue;
Dan Gohman30359592008-01-29 13:02:09 +0000855 } else if (Cond.empty()) {
Dan Gohman8520149d2009-11-12 01:51:28 +0000856 if (TBB != IBB) // ubr
Dale Johannesenfe7e3972007-06-04 23:52:54 +0000857 continue;
858 } else {
Dan Gohman8520149d2009-11-12 01:51:28 +0000859 if (TBB != IBB && IBB != PredNextBB) // cbr
Dale Johannesenfe7e3972007-06-04 23:52:54 +0000860 continue;
861 }
862 }
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000863 // Remove the unconditional branch at the end, if any.
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000864 if (TBB && (Cond.empty() || FBB)) {
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000865 TII->RemoveBranch(*PBB);
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000866 if (!Cond.empty())
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000867 // reinsert conditional branch only, for now
Dan Gohman4e3f1252009-11-11 18:38:14 +0000868 TII->InsertBranch(*PBB, (TBB == IBB) ? FBB : TBB, 0, NewCond);
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000869 }
Dan Gohmanffe644e2009-11-11 21:57:02 +0000870 MergePotentials.push_back(MergePotentialsElt(HashEndOfMBB(PBB, 1U),
871 *P));
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000872 }
873 }
Dan Gohmancdc06ba2009-11-11 18:42:28 +0000874 if (MergePotentials.size() >= 2)
Dan Gohman2210c0b2009-11-11 19:48:59 +0000875 MadeChange |= TryTailMergeBlocks(IBB, PredBB);
Dan Gohmancdc06ba2009-11-11 18:42:28 +0000876 // Reinsert an unconditional branch if needed.
Dan Gohman2210c0b2009-11-11 19:48:59 +0000877 // The 1 below can occur as a result of removing blocks in TryTailMergeBlocks.
878 PredBB = prior(I); // this may have been changed in TryTailMergeBlocks
Dan Gohmancdc06ba2009-11-11 18:42:28 +0000879 if (MergePotentials.size() == 1 &&
Dan Gohmanffe644e2009-11-11 21:57:02 +0000880 MergePotentials.begin()->getBlock() != PredBB)
881 FixTail(MergePotentials.begin()->getBlock(), IBB, TII);
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000882 }
883 }
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000884 return MadeChange;
885}
Chris Lattner12143052006-10-21 00:47:49 +0000886
887//===----------------------------------------------------------------------===//
888// Branch Optimization
889//===----------------------------------------------------------------------===//
890
891bool BranchFolder::OptimizeBranches(MachineFunction &MF) {
Evan Cheng030a0a02009-09-04 07:47:40 +0000892 bool MadeChange = false;
Dan Gohman4e3f1252009-11-11 18:38:14 +0000893
Dale Johannesen6b896ce2007-02-17 00:44:34 +0000894 // Make sure blocks are numbered in order
895 MF.RenumberBlocks();
896
Chris Lattner12143052006-10-21 00:47:49 +0000897 for (MachineFunction::iterator I = ++MF.begin(), E = MF.end(); I != E; ) {
898 MachineBasicBlock *MBB = I++;
Evan Cheng030a0a02009-09-04 07:47:40 +0000899 MadeChange |= OptimizeBlock(MBB);
Dan Gohman4e3f1252009-11-11 18:38:14 +0000900
Chris Lattner12143052006-10-21 00:47:49 +0000901 // If it is dead, remove it.
Jim Laskey033c9712007-02-22 16:39:03 +0000902 if (MBB->pred_empty()) {
Chris Lattner12143052006-10-21 00:47:49 +0000903 RemoveDeadBlock(MBB);
904 MadeChange = true;
905 ++NumDeadBlocks;
906 }
907 }
908 return MadeChange;
909}
910
911
Chris Lattnera7bef4a2006-11-18 20:47:54 +0000912/// IsBetterFallthrough - Return true if it would be clearly better to
913/// fall-through to MBB1 than to fall through into MBB2. This has to return
914/// a strict ordering, returning true for both (MBB1,MBB2) and (MBB2,MBB1) will
915/// result in infinite loops.
Dan Gohman4e3f1252009-11-11 18:38:14 +0000916static bool IsBetterFallthrough(MachineBasicBlock *MBB1,
Chris Lattner69244302008-01-07 01:56:04 +0000917 MachineBasicBlock *MBB2) {
Chris Lattner154e1042006-11-18 21:30:35 +0000918 // Right now, we use a simple heuristic. If MBB2 ends with a call, and
919 // MBB1 doesn't, we prefer to fall through into MBB1. This allows us to
Chris Lattnera7bef4a2006-11-18 20:47:54 +0000920 // optimize branches that branch to either a return block or an assert block
921 // into a fallthrough to the return.
922 if (MBB1->empty() || MBB2->empty()) return false;
Dan Gohman4e3f1252009-11-11 18:38:14 +0000923
Christopher Lamb11a4f642007-12-10 07:24:06 +0000924 // If there is a clear successor ordering we make sure that one block
925 // will fall through to the next
926 if (MBB1->isSuccessor(MBB2)) return true;
927 if (MBB2->isSuccessor(MBB1)) return false;
Chris Lattnera7bef4a2006-11-18 20:47:54 +0000928
929 MachineInstr *MBB1I = --MBB1->end();
930 MachineInstr *MBB2I = --MBB2->end();
Chris Lattner749c6f62008-01-07 07:27:27 +0000931 return MBB2I->getDesc().isCall() && !MBB1I->getDesc().isCall();
Chris Lattnera7bef4a2006-11-18 20:47:54 +0000932}
933
Chris Lattner7821a8a2006-10-14 00:21:48 +0000934/// OptimizeBlock - Analyze and optimize control flow related to the specified
935/// block. This is never called on the entry block.
Evan Cheng030a0a02009-09-04 07:47:40 +0000936bool BranchFolder::OptimizeBlock(MachineBasicBlock *MBB) {
937 bool MadeChange = false;
Dan Gohmand1944982009-11-11 18:18:34 +0000938 MachineFunction &MF = *MBB->getParent();
Dan Gohman2210c0b2009-11-11 19:48:59 +0000939ReoptimizeBlock:
Evan Cheng030a0a02009-09-04 07:47:40 +0000940
Chris Lattner7d097842006-10-24 01:12:32 +0000941 MachineFunction::iterator FallThrough = MBB;
942 ++FallThrough;
Dan Gohman4e3f1252009-11-11 18:38:14 +0000943
Chris Lattnereb15eee2006-10-13 20:43:10 +0000944 // If this block is empty, make everyone use its fall-through, not the block
Dale Johannesena52dd152007-05-31 21:54:00 +0000945 // explicitly. Landing pads should not do this since the landing-pad table
Dan Gohmanab918102009-10-30 02:13:27 +0000946 // points to this block. Blocks with their addresses taken shouldn't be
947 // optimized away.
948 if (MBB->empty() && !MBB->isLandingPad() && !MBB->hasAddressTaken()) {
Chris Lattner386e2902006-10-21 05:08:28 +0000949 // Dead block? Leave for cleanup later.
Evan Cheng030a0a02009-09-04 07:47:40 +0000950 if (MBB->pred_empty()) return MadeChange;
Dan Gohman4e3f1252009-11-11 18:38:14 +0000951
Dan Gohmand1944982009-11-11 18:18:34 +0000952 if (FallThrough == MF.end()) {
Chris Lattnerc50ffcb2006-10-17 17:13:52 +0000953 // TODO: Simplify preds to not branch here if possible!
954 } else {
955 // Rewrite all predecessors of the old block to go to the fallthrough
956 // instead.
Jim Laskey033c9712007-02-22 16:39:03 +0000957 while (!MBB->pred_empty()) {
Chris Lattner7821a8a2006-10-14 00:21:48 +0000958 MachineBasicBlock *Pred = *(MBB->pred_end()-1);
Evan Cheng0370fad2007-06-04 06:44:01 +0000959 Pred->ReplaceUsesOfBlockWith(MBB, FallThrough);
Chris Lattner7821a8a2006-10-14 00:21:48 +0000960 }
Chris Lattnerc50ffcb2006-10-17 17:13:52 +0000961 // If MBB was the target of a jump table, update jump tables to go to the
962 // fallthrough instead.
Chris Lattner071c62f2010-01-25 23:26:13 +0000963 if (MachineJumpTableInfo *MJTI = MF.getJumpTableInfo())
964 MJTI->ReplaceMBBInJumpTables(MBB, FallThrough);
Chris Lattner7821a8a2006-10-14 00:21:48 +0000965 MadeChange = true;
Chris Lattner21ab22e2004-07-31 10:01:27 +0000966 }
Evan Cheng030a0a02009-09-04 07:47:40 +0000967 return MadeChange;
Chris Lattner21ab22e2004-07-31 10:01:27 +0000968 }
969
Chris Lattner7821a8a2006-10-14 00:21:48 +0000970 // Check to see if we can simplify the terminator of the block before this
971 // one.
Chris Lattner7d097842006-10-24 01:12:32 +0000972 MachineBasicBlock &PrevBB = *prior(MachineFunction::iterator(MBB));
Chris Lattnerffddf6b2006-10-17 18:16:40 +0000973
Chris Lattner7821a8a2006-10-14 00:21:48 +0000974 MachineBasicBlock *PriorTBB = 0, *PriorFBB = 0;
Owen Anderson44eb65c2008-08-14 22:49:33 +0000975 SmallVector<MachineOperand, 4> PriorCond;
Chris Lattner6b0e3f82006-10-29 21:05:41 +0000976 bool PriorUnAnalyzable =
Evan Chengdc54d312009-02-09 07:14:22 +0000977 TII->AnalyzeBranch(PrevBB, PriorTBB, PriorFBB, PriorCond, true);
Chris Lattner386e2902006-10-21 05:08:28 +0000978 if (!PriorUnAnalyzable) {
979 // If the CFG for the prior block has extra edges, remove them.
Evan Cheng2bdb7d02007-06-18 22:43:58 +0000980 MadeChange |= PrevBB.CorrectExtraCFGEdges(PriorTBB, PriorFBB,
981 !PriorCond.empty());
Dan Gohman4e3f1252009-11-11 18:38:14 +0000982
Chris Lattner7821a8a2006-10-14 00:21:48 +0000983 // If the previous branch is conditional and both conditions go to the same
Chris Lattner2d47bd92006-10-21 05:43:30 +0000984 // destination, remove the branch, replacing it with an unconditional one or
985 // a fall-through.
Chris Lattner7821a8a2006-10-14 00:21:48 +0000986 if (PriorTBB && PriorTBB == PriorFBB) {
Chris Lattner386e2902006-10-21 05:08:28 +0000987 TII->RemoveBranch(PrevBB);
Dan Gohman4e3f1252009-11-11 18:38:14 +0000988 PriorCond.clear();
Chris Lattner7d097842006-10-24 01:12:32 +0000989 if (PriorTBB != MBB)
Chris Lattner386e2902006-10-21 05:08:28 +0000990 TII->InsertBranch(PrevBB, PriorTBB, 0, PriorCond);
Chris Lattner7821a8a2006-10-14 00:21:48 +0000991 MadeChange = true;
Chris Lattner12143052006-10-21 00:47:49 +0000992 ++NumBranchOpts;
Dan Gohman2210c0b2009-11-11 19:48:59 +0000993 goto ReoptimizeBlock;
Chris Lattner7821a8a2006-10-14 00:21:48 +0000994 }
Dan Gohman4e3f1252009-11-11 18:38:14 +0000995
Dan Gohman2210c0b2009-11-11 19:48:59 +0000996 // If the previous block unconditionally falls through to this block and
997 // this block has no other predecessors, move the contents of this block
998 // into the prior block. This doesn't usually happen when SimplifyCFG
Bob Wilson465c8252009-11-17 17:40:31 +0000999 // has been used, but it can happen if tail merging splits a fall-through
1000 // predecessor of a block.
Dan Gohman2210c0b2009-11-11 19:48:59 +00001001 // This has to check PrevBB->succ_size() because EH edges are ignored by
1002 // AnalyzeBranch.
1003 if (PriorCond.empty() && !PriorTBB && MBB->pred_size() == 1 &&
1004 PrevBB.succ_size() == 1 &&
1005 !MBB->hasAddressTaken()) {
David Greene465e2b92009-12-24 00:34:21 +00001006 DEBUG(dbgs() << "\nMerging into block: " << PrevBB
Dan Gohman2210c0b2009-11-11 19:48:59 +00001007 << "From MBB: " << *MBB);
1008 PrevBB.splice(PrevBB.end(), MBB, MBB->begin(), MBB->end());
1009 PrevBB.removeSuccessor(PrevBB.succ_begin());;
1010 assert(PrevBB.succ_empty());
1011 PrevBB.transferSuccessors(MBB);
1012 MadeChange = true;
1013 return MadeChange;
1014 }
Bob Wilson3cbc3122009-11-16 17:56:13 +00001015
Chris Lattner7821a8a2006-10-14 00:21:48 +00001016 // If the previous branch *only* branches to *this* block (conditional or
1017 // not) remove the branch.
Chris Lattner7d097842006-10-24 01:12:32 +00001018 if (PriorTBB == MBB && PriorFBB == 0) {
Chris Lattner386e2902006-10-21 05:08:28 +00001019 TII->RemoveBranch(PrevBB);
Chris Lattner7821a8a2006-10-14 00:21:48 +00001020 MadeChange = true;
Chris Lattner12143052006-10-21 00:47:49 +00001021 ++NumBranchOpts;
Dan Gohman2210c0b2009-11-11 19:48:59 +00001022 goto ReoptimizeBlock;
Chris Lattner7821a8a2006-10-14 00:21:48 +00001023 }
Dan Gohman4e3f1252009-11-11 18:38:14 +00001024
Chris Lattner2d47bd92006-10-21 05:43:30 +00001025 // If the prior block branches somewhere else on the condition and here if
1026 // the condition is false, remove the uncond second branch.
Chris Lattner7d097842006-10-24 01:12:32 +00001027 if (PriorFBB == MBB) {
Chris Lattner2d47bd92006-10-21 05:43:30 +00001028 TII->RemoveBranch(PrevBB);
1029 TII->InsertBranch(PrevBB, PriorTBB, 0, PriorCond);
1030 MadeChange = true;
1031 ++NumBranchOpts;
Dan Gohman2210c0b2009-11-11 19:48:59 +00001032 goto ReoptimizeBlock;
Chris Lattner2d47bd92006-10-21 05:43:30 +00001033 }
Dan Gohman4e3f1252009-11-11 18:38:14 +00001034
Chris Lattnera2d79952006-10-21 05:54:00 +00001035 // If the prior block branches here on true and somewhere else on false, and
1036 // if the branch condition is reversible, reverse the branch to create a
1037 // fall-through.
Chris Lattner7d097842006-10-24 01:12:32 +00001038 if (PriorTBB == MBB) {
Owen Anderson44eb65c2008-08-14 22:49:33 +00001039 SmallVector<MachineOperand, 4> NewPriorCond(PriorCond);
Chris Lattnera2d79952006-10-21 05:54:00 +00001040 if (!TII->ReverseBranchCondition(NewPriorCond)) {
1041 TII->RemoveBranch(PrevBB);
1042 TII->InsertBranch(PrevBB, PriorFBB, 0, NewPriorCond);
1043 MadeChange = true;
1044 ++NumBranchOpts;
Dan Gohman2210c0b2009-11-11 19:48:59 +00001045 goto ReoptimizeBlock;
Chris Lattnera2d79952006-10-21 05:54:00 +00001046 }
1047 }
Dan Gohman4e3f1252009-11-11 18:38:14 +00001048
Dan Gohman6d312682009-10-22 00:03:58 +00001049 // If this block has no successors (e.g. it is a return block or ends with
1050 // a call to a no-return function like abort or __cxa_throw) and if the pred
1051 // falls through into this block, and if it would otherwise fall through
1052 // into the block after this, move this block to the end of the function.
Chris Lattner154e1042006-11-18 21:30:35 +00001053 //
Chris Lattnera7bef4a2006-11-18 20:47:54 +00001054 // We consider it more likely that execution will stay in the function (e.g.
1055 // due to loops) than it is to exit it. This asserts in loops etc, moving
1056 // the assert condition out of the loop body.
Dan Gohman6d312682009-10-22 00:03:58 +00001057 if (MBB->succ_empty() && !PriorCond.empty() && PriorFBB == 0 &&
Chris Lattner154e1042006-11-18 21:30:35 +00001058 MachineFunction::iterator(PriorTBB) == FallThrough &&
Bob Wilson15acadd2009-11-26 00:32:21 +00001059 !MBB->canFallThrough()) {
Chris Lattnerf10a56a2006-11-18 21:56:39 +00001060 bool DoTransform = true;
Dan Gohman4e3f1252009-11-11 18:38:14 +00001061
Chris Lattnera7bef4a2006-11-18 20:47:54 +00001062 // We have to be careful that the succs of PredBB aren't both no-successor
1063 // blocks. If neither have successors and if PredBB is the second from
1064 // last block in the function, we'd just keep swapping the two blocks for
1065 // last. Only do the swap if one is clearly better to fall through than
1066 // the other.
Dan Gohmand1944982009-11-11 18:18:34 +00001067 if (FallThrough == --MF.end() &&
Chris Lattner69244302008-01-07 01:56:04 +00001068 !IsBetterFallthrough(PriorTBB, MBB))
Chris Lattnerf10a56a2006-11-18 21:56:39 +00001069 DoTransform = false;
1070
1071 // We don't want to do this transformation if we have control flow like:
1072 // br cond BB2
1073 // BB1:
1074 // ..
1075 // jmp BBX
1076 // BB2:
1077 // ..
1078 // ret
1079 //
1080 // In this case, we could actually be moving the return block *into* a
1081 // loop!
Chris Lattner4b105912006-11-18 22:25:39 +00001082 if (DoTransform && !MBB->succ_empty() &&
Bob Wilson15acadd2009-11-26 00:32:21 +00001083 (!PriorTBB->canFallThrough() || PriorTBB->empty()))
Chris Lattnerf10a56a2006-11-18 21:56:39 +00001084 DoTransform = false;
Dan Gohman4e3f1252009-11-11 18:38:14 +00001085
1086
Chris Lattnerf10a56a2006-11-18 21:56:39 +00001087 if (DoTransform) {
Chris Lattnera7bef4a2006-11-18 20:47:54 +00001088 // Reverse the branch so we will fall through on the previous true cond.
Owen Anderson44eb65c2008-08-14 22:49:33 +00001089 SmallVector<MachineOperand, 4> NewPriorCond(PriorCond);
Chris Lattnera7bef4a2006-11-18 20:47:54 +00001090 if (!TII->ReverseBranchCondition(NewPriorCond)) {
David Greene465e2b92009-12-24 00:34:21 +00001091 DEBUG(dbgs() << "\nMoving MBB: " << *MBB
Bill Wendling3403bcd2009-08-22 20:03:00 +00001092 << "To make fallthrough to: " << *PriorTBB << "\n");
Dan Gohman4e3f1252009-11-11 18:38:14 +00001093
Chris Lattnera7bef4a2006-11-18 20:47:54 +00001094 TII->RemoveBranch(PrevBB);
1095 TII->InsertBranch(PrevBB, MBB, 0, NewPriorCond);
1096
1097 // Move this block to the end of the function.
Dan Gohmand1944982009-11-11 18:18:34 +00001098 MBB->moveAfter(--MF.end());
Chris Lattnera7bef4a2006-11-18 20:47:54 +00001099 MadeChange = true;
1100 ++NumBranchOpts;
Evan Cheng030a0a02009-09-04 07:47:40 +00001101 return MadeChange;
Chris Lattnera7bef4a2006-11-18 20:47:54 +00001102 }
1103 }
1104 }
Chris Lattner7821a8a2006-10-14 00:21:48 +00001105 }
Dan Gohman4e3f1252009-11-11 18:38:14 +00001106
Chris Lattner386e2902006-10-21 05:08:28 +00001107 // Analyze the branch in the current block.
1108 MachineBasicBlock *CurTBB = 0, *CurFBB = 0;
Owen Anderson44eb65c2008-08-14 22:49:33 +00001109 SmallVector<MachineOperand, 4> CurCond;
Evan Chengdc54d312009-02-09 07:14:22 +00001110 bool CurUnAnalyzable= TII->AnalyzeBranch(*MBB, CurTBB, CurFBB, CurCond, true);
Chris Lattner6b0e3f82006-10-29 21:05:41 +00001111 if (!CurUnAnalyzable) {
Chris Lattner386e2902006-10-21 05:08:28 +00001112 // If the CFG for the prior block has extra edges, remove them.
Evan Cheng2bdb7d02007-06-18 22:43:58 +00001113 MadeChange |= MBB->CorrectExtraCFGEdges(CurTBB, CurFBB, !CurCond.empty());
Chris Lattnereb15eee2006-10-13 20:43:10 +00001114
Dan Gohman4e3f1252009-11-11 18:38:14 +00001115 // If this is a two-way branch, and the FBB branches to this block, reverse
Chris Lattner5d056952006-11-08 01:03:21 +00001116 // the condition so the single-basic-block loop is faster. Instead of:
1117 // Loop: xxx; jcc Out; jmp Loop
1118 // we want:
1119 // Loop: xxx; jncc Loop; jmp Out
1120 if (CurTBB && CurFBB && CurFBB == MBB && CurTBB != MBB) {
Owen Anderson44eb65c2008-08-14 22:49:33 +00001121 SmallVector<MachineOperand, 4> NewCond(CurCond);
Chris Lattner5d056952006-11-08 01:03:21 +00001122 if (!TII->ReverseBranchCondition(NewCond)) {
1123 TII->RemoveBranch(*MBB);
1124 TII->InsertBranch(*MBB, CurFBB, CurTBB, NewCond);
1125 MadeChange = true;
1126 ++NumBranchOpts;
Dan Gohman2210c0b2009-11-11 19:48:59 +00001127 goto ReoptimizeBlock;
Chris Lattner5d056952006-11-08 01:03:21 +00001128 }
1129 }
Dan Gohman4e3f1252009-11-11 18:38:14 +00001130
Chris Lattner386e2902006-10-21 05:08:28 +00001131 // If this branch is the only thing in its block, see if we can forward
1132 // other blocks across it.
Dan Gohman4e3f1252009-11-11 18:38:14 +00001133 if (CurTBB && CurCond.empty() && CurFBB == 0 &&
Bob Wilson888acc32009-11-03 23:44:31 +00001134 MBB->begin()->getDesc().isBranch() && CurTBB != MBB &&
1135 !MBB->hasAddressTaken()) {
Chris Lattner386e2902006-10-21 05:08:28 +00001136 // This block may contain just an unconditional branch. Because there can
1137 // be 'non-branch terminators' in the block, try removing the branch and
1138 // then seeing if the block is empty.
1139 TII->RemoveBranch(*MBB);
1140
1141 // If this block is just an unconditional branch to CurTBB, we can
1142 // usually completely eliminate the block. The only case we cannot
1143 // completely eliminate the block is when the block before this one
1144 // falls through into MBB and we can't understand the prior block's branch
1145 // condition.
Chris Lattnercf420cc2006-10-28 17:32:47 +00001146 if (MBB->empty()) {
Dan Gohman864e2ef2009-12-05 00:44:40 +00001147 bool PredHasNoFallThrough = !PrevBB.canFallThrough();
Chris Lattnercf420cc2006-10-28 17:32:47 +00001148 if (PredHasNoFallThrough || !PriorUnAnalyzable ||
1149 !PrevBB.isSuccessor(MBB)) {
1150 // If the prior block falls through into us, turn it into an
1151 // explicit branch to us to make updates simpler.
Dan Gohman4e3f1252009-11-11 18:38:14 +00001152 if (!PredHasNoFallThrough && PrevBB.isSuccessor(MBB) &&
Chris Lattnercf420cc2006-10-28 17:32:47 +00001153 PriorTBB != MBB && PriorFBB != MBB) {
1154 if (PriorTBB == 0) {
Chris Lattner6acfe122006-10-28 18:34:47 +00001155 assert(PriorCond.empty() && PriorFBB == 0 &&
1156 "Bad branch analysis");
Chris Lattnercf420cc2006-10-28 17:32:47 +00001157 PriorTBB = MBB;
1158 } else {
1159 assert(PriorFBB == 0 && "Machine CFG out of date!");
1160 PriorFBB = MBB;
1161 }
1162 TII->RemoveBranch(PrevBB);
1163 TII->InsertBranch(PrevBB, PriorTBB, PriorFBB, PriorCond);
Chris Lattner386e2902006-10-21 05:08:28 +00001164 }
Chris Lattner386e2902006-10-21 05:08:28 +00001165
Chris Lattnercf420cc2006-10-28 17:32:47 +00001166 // Iterate through all the predecessors, revectoring each in-turn.
David Greene8a46d342007-06-29 02:45:24 +00001167 size_t PI = 0;
Chris Lattnercf420cc2006-10-28 17:32:47 +00001168 bool DidChange = false;
1169 bool HasBranchToSelf = false;
David Greene8a46d342007-06-29 02:45:24 +00001170 while(PI != MBB->pred_size()) {
1171 MachineBasicBlock *PMBB = *(MBB->pred_begin() + PI);
1172 if (PMBB == MBB) {
Chris Lattnercf420cc2006-10-28 17:32:47 +00001173 // If this block has an uncond branch to itself, leave it.
1174 ++PI;
1175 HasBranchToSelf = true;
1176 } else {
1177 DidChange = true;
David Greene8a46d342007-06-29 02:45:24 +00001178 PMBB->ReplaceUsesOfBlockWith(MBB, CurTBB);
Dale Johannesenbf06f6a2009-05-11 21:54:13 +00001179 // If this change resulted in PMBB ending in a conditional
1180 // branch where both conditions go to the same destination,
1181 // change this to an unconditional branch (and fix the CFG).
1182 MachineBasicBlock *NewCurTBB = 0, *NewCurFBB = 0;
1183 SmallVector<MachineOperand, 4> NewCurCond;
1184 bool NewCurUnAnalyzable = TII->AnalyzeBranch(*PMBB, NewCurTBB,
1185 NewCurFBB, NewCurCond, true);
1186 if (!NewCurUnAnalyzable && NewCurTBB && NewCurTBB == NewCurFBB) {
1187 TII->RemoveBranch(*PMBB);
Dan Gohman4e3f1252009-11-11 18:38:14 +00001188 NewCurCond.clear();
Dale Johannesenbf06f6a2009-05-11 21:54:13 +00001189 TII->InsertBranch(*PMBB, NewCurTBB, 0, NewCurCond);
1190 MadeChange = true;
1191 ++NumBranchOpts;
Dan Gohman2210c0b2009-11-11 19:48:59 +00001192 PMBB->CorrectExtraCFGEdges(NewCurTBB, 0, false);
Dale Johannesenbf06f6a2009-05-11 21:54:13 +00001193 }
Chris Lattnercf420cc2006-10-28 17:32:47 +00001194 }
Chris Lattner4bc135e2006-10-21 06:11:43 +00001195 }
Chris Lattner386e2902006-10-21 05:08:28 +00001196
Chris Lattnercf420cc2006-10-28 17:32:47 +00001197 // Change any jumptables to go to the new MBB.
Chris Lattner071c62f2010-01-25 23:26:13 +00001198 if (MachineJumpTableInfo *MJTI = MF.getJumpTableInfo())
1199 MJTI->ReplaceMBBInJumpTables(MBB, CurTBB);
Chris Lattnercf420cc2006-10-28 17:32:47 +00001200 if (DidChange) {
1201 ++NumBranchOpts;
1202 MadeChange = true;
Evan Cheng030a0a02009-09-04 07:47:40 +00001203 if (!HasBranchToSelf) return MadeChange;
Chris Lattnercf420cc2006-10-28 17:32:47 +00001204 }
Chris Lattner4bc135e2006-10-21 06:11:43 +00001205 }
Chris Lattnereb15eee2006-10-13 20:43:10 +00001206 }
Dan Gohman4e3f1252009-11-11 18:38:14 +00001207
Chris Lattner386e2902006-10-21 05:08:28 +00001208 // Add the branch back if the block is more than just an uncond branch.
1209 TII->InsertBranch(*MBB, CurTBB, 0, CurCond);
Chris Lattner21ab22e2004-07-31 10:01:27 +00001210 }
Chris Lattner6b0e3f82006-10-29 21:05:41 +00001211 }
1212
Bill Wendling43cf6c32009-12-15 00:39:24 +00001213 // If the prior block doesn't fall through into this block, and if this
1214 // block doesn't fall through into some other block, see if we can find a
1215 // place to move this block where a fall-through will happen.
1216 if (!PrevBB.canFallThrough()) {
1217
Bob Wilson56ea69c2009-11-17 17:06:18 +00001218 // Now we know that there was no fall-through into this block, check to
1219 // see if it has a fall-through into its successor.
Bob Wilson15acadd2009-11-26 00:32:21 +00001220 bool CurFallsThru = MBB->canFallThrough();
Bob Wilson56ea69c2009-11-17 17:06:18 +00001221
Jim Laskey02b3f5e2007-02-21 22:42:20 +00001222 if (!MBB->isLandingPad()) {
1223 // Check all the predecessors of this block. If one of them has no fall
1224 // throughs, move this block right after it.
1225 for (MachineBasicBlock::pred_iterator PI = MBB->pred_begin(),
1226 E = MBB->pred_end(); PI != E; ++PI) {
1227 // Analyze the branch at the end of the pred.
1228 MachineBasicBlock *PredBB = *PI;
Bill Wendling43cf6c32009-12-15 00:39:24 +00001229 MachineFunction::iterator PredFallthrough = PredBB; ++PredFallthrough;
Bill Wendling408e9d12009-12-16 00:00:18 +00001230 MachineBasicBlock *PredTBB = 0, *PredFBB = 0;
Dan Gohman2210c0b2009-11-11 19:48:59 +00001231 SmallVector<MachineOperand, 4> PredCond;
Bill Wendling43cf6c32009-12-15 00:39:24 +00001232 if (PredBB != MBB && !PredBB->canFallThrough() &&
1233 !TII->AnalyzeBranch(*PredBB, PredTBB, PredFBB, PredCond, true)
Dale Johannesen76b38fc2007-05-10 01:01:49 +00001234 && (!CurFallsThru || !CurTBB || !CurFBB)
Jim Laskey02b3f5e2007-02-21 22:42:20 +00001235 && (!CurFallsThru || MBB->getNumber() >= PredBB->getNumber())) {
Bill Wendling43cf6c32009-12-15 00:39:24 +00001236 // If the current block doesn't fall through, just move it.
1237 // If the current block can fall through and does not end with a
1238 // conditional branch, we need to append an unconditional jump to
1239 // the (current) next block. To avoid a possible compile-time
1240 // infinite loop, move blocks only backward in this case.
1241 // Also, if there are already 2 branches here, we cannot add a third;
1242 // this means we have the case
1243 // Bcc next
1244 // B elsewhere
1245 // next:
Jim Laskey02b3f5e2007-02-21 22:42:20 +00001246 if (CurFallsThru) {
Bill Wendling43cf6c32009-12-15 00:39:24 +00001247 MachineBasicBlock *NextBB = llvm::next(MachineFunction::iterator(MBB));
Jim Laskey02b3f5e2007-02-21 22:42:20 +00001248 CurCond.clear();
1249 TII->InsertBranch(*MBB, NextBB, 0, CurCond);
1250 }
1251 MBB->moveAfter(PredBB);
1252 MadeChange = true;
Dan Gohman2210c0b2009-11-11 19:48:59 +00001253 goto ReoptimizeBlock;
Chris Lattner7d097842006-10-24 01:12:32 +00001254 }
1255 }
Dale Johannesen6b896ce2007-02-17 00:44:34 +00001256 }
Dan Gohman4e3f1252009-11-11 18:38:14 +00001257
Dale Johannesen6b896ce2007-02-17 00:44:34 +00001258 if (!CurFallsThru) {
Chris Lattner6b0e3f82006-10-29 21:05:41 +00001259 // Check all successors to see if we can move this block before it.
1260 for (MachineBasicBlock::succ_iterator SI = MBB->succ_begin(),
1261 E = MBB->succ_end(); SI != E; ++SI) {
1262 // Analyze the branch at the end of the block before the succ.
1263 MachineBasicBlock *SuccBB = *SI;
1264 MachineFunction::iterator SuccPrev = SuccBB; --SuccPrev;
Dan Gohman4e3f1252009-11-11 18:38:14 +00001265
Chris Lattner77edc4b2007-04-30 23:35:00 +00001266 // If this block doesn't already fall-through to that successor, and if
1267 // the succ doesn't already have a block that can fall through into it,
1268 // and if the successor isn't an EH destination, we can arrange for the
1269 // fallthrough to happen.
Dan Gohman2210c0b2009-11-11 19:48:59 +00001270 if (SuccBB != MBB && &*SuccPrev != MBB &&
Bob Wilson15acadd2009-11-26 00:32:21 +00001271 !SuccPrev->canFallThrough() && !CurUnAnalyzable &&
Chris Lattner77edc4b2007-04-30 23:35:00 +00001272 !SuccBB->isLandingPad()) {
Chris Lattner6b0e3f82006-10-29 21:05:41 +00001273 MBB->moveBefore(SuccBB);
1274 MadeChange = true;
Dan Gohman2210c0b2009-11-11 19:48:59 +00001275 goto ReoptimizeBlock;
Chris Lattner6b0e3f82006-10-29 21:05:41 +00001276 }
1277 }
Dan Gohman4e3f1252009-11-11 18:38:14 +00001278
Chris Lattner6b0e3f82006-10-29 21:05:41 +00001279 // Okay, there is no really great place to put this block. If, however,
1280 // the block before this one would be a fall-through if this block were
1281 // removed, move this block to the end of the function.
Bill Wendlingfe586b32009-12-16 00:01:27 +00001282 MachineBasicBlock *PrevTBB = 0, *PrevFBB = 0;
Dan Gohman2210c0b2009-11-11 19:48:59 +00001283 SmallVector<MachineOperand, 4> PrevCond;
Dan Gohmand1944982009-11-11 18:18:34 +00001284 if (FallThrough != MF.end() &&
Dan Gohman2210c0b2009-11-11 19:48:59 +00001285 !TII->AnalyzeBranch(PrevBB, PrevTBB, PrevFBB, PrevCond, true) &&
Chris Lattner6b0e3f82006-10-29 21:05:41 +00001286 PrevBB.isSuccessor(FallThrough)) {
Dan Gohmand1944982009-11-11 18:18:34 +00001287 MBB->moveAfter(--MF.end());
Chris Lattner6b0e3f82006-10-29 21:05:41 +00001288 MadeChange = true;
Evan Cheng030a0a02009-09-04 07:47:40 +00001289 return MadeChange;
Chris Lattner6b0e3f82006-10-29 21:05:41 +00001290 }
Chris Lattner7d097842006-10-24 01:12:32 +00001291 }
Chris Lattner21ab22e2004-07-31 10:01:27 +00001292 }
Evan Cheng030a0a02009-09-04 07:47:40 +00001293
1294 return MadeChange;
Chris Lattner21ab22e2004-07-31 10:01:27 +00001295}