blob: 6c8e09141bd71d666f71328ccb8df6568f997318 [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!");
Bill Wendling3403bcd2009-08-22 20:03:00 +0000101 DEBUG(errs() << "\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()) {
136 if (I->getOpcode() != TargetInstrInfo::IMPLICIT_DEF)
137 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();
209 const std::vector<MachineJumpTableEntry> &JTs = JTI->getJumpTables();
210 if (!JTs.empty()) {
211 // Figure out how these jump tables should be merged.
212 std::vector<unsigned> JTMapping;
213 JTMapping.reserve(JTs.size());
Dan Gohman4e3f1252009-11-11 18:38:14 +0000214
Chris Lattner6acfe122006-10-28 18:34:47 +0000215 // We always keep the 0th jump table.
216 JTMapping.push_back(0);
217
218 // Scan the jump tables, seeing if there are any duplicates. Note that this
219 // is N^2, which should be fixed someday.
Evan Cheng030a0a02009-09-04 07:47:40 +0000220 for (unsigned i = 1, e = JTs.size(); i != e; ++i) {
221 if (JTs[i].MBBs.empty())
222 JTMapping.push_back(i);
223 else
224 JTMapping.push_back(JTI->getJumpTableIndex(JTs[i].MBBs));
225 }
Dan Gohman4e3f1252009-11-11 18:38:14 +0000226
Chris Lattner6acfe122006-10-28 18:34:47 +0000227 // If a jump table was merge with another one, walk the function rewriting
228 // references to jump tables to reference the new JT ID's. Keep track of
229 // whether we see a jump table idx, if not, we can delete the JT.
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000230 BitVector JTIsLive(JTs.size());
Chris Lattner6acfe122006-10-28 18:34:47 +0000231 for (MachineFunction::iterator BB = MF.begin(), E = MF.end();
232 BB != E; ++BB) {
233 for (MachineBasicBlock::iterator I = BB->begin(), E = BB->end();
234 I != E; ++I)
235 for (unsigned op = 0, e = I->getNumOperands(); op != e; ++op) {
236 MachineOperand &Op = I->getOperand(op);
Dan Gohmand735b802008-10-03 15:45:36 +0000237 if (!Op.isJTI()) continue;
Chris Lattner8aa797a2007-12-30 23:10:15 +0000238 unsigned NewIdx = JTMapping[Op.getIndex()];
239 Op.setIndex(NewIdx);
Chris Lattner6acfe122006-10-28 18:34:47 +0000240
241 // Remember that this JT is live.
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000242 JTIsLive.set(NewIdx);
Chris Lattner6acfe122006-10-28 18:34:47 +0000243 }
244 }
Dan Gohman4e3f1252009-11-11 18:38:14 +0000245
Chris Lattner6acfe122006-10-28 18:34:47 +0000246 // Finally, remove dead jump tables. This happens either because the
247 // indirect jump was unreachable (and thus deleted) or because the jump
248 // table was merged with some other one.
249 for (unsigned i = 0, e = JTIsLive.size(); i != e; ++i)
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000250 if (!JTIsLive.test(i)) {
Chris Lattner6acfe122006-10-28 18:34:47 +0000251 JTI->RemoveJumpTable(i);
Evan Cheng030a0a02009-09-04 07:47:40 +0000252 MadeChange = true;
Chris Lattner6acfe122006-10-28 18:34:47 +0000253 }
254 }
Evan Cheng030a0a02009-09-04 07:47:40 +0000255
Dale Johannesen69cb9b72007-03-20 21:35:06 +0000256 delete RS;
Evan Cheng030a0a02009-09-04 07:47:40 +0000257 return MadeChange;
Chris Lattner21ab22e2004-07-31 10:01:27 +0000258}
259
Chris Lattner12143052006-10-21 00:47:49 +0000260//===----------------------------------------------------------------------===//
261// Tail Merging of Blocks
262//===----------------------------------------------------------------------===//
263
264/// HashMachineInstr - Compute a hash value for MI and its operands.
265static unsigned HashMachineInstr(const MachineInstr *MI) {
266 unsigned Hash = MI->getOpcode();
267 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
268 const MachineOperand &Op = MI->getOperand(i);
Dan Gohman4e3f1252009-11-11 18:38:14 +0000269
Chris Lattner12143052006-10-21 00:47:49 +0000270 // Merge in bits from the operand if easy.
271 unsigned OperandHash = 0;
272 switch (Op.getType()) {
273 case MachineOperand::MO_Register: OperandHash = Op.getReg(); break;
274 case MachineOperand::MO_Immediate: OperandHash = Op.getImm(); break;
275 case MachineOperand::MO_MachineBasicBlock:
Chris Lattner8aa797a2007-12-30 23:10:15 +0000276 OperandHash = Op.getMBB()->getNumber();
Chris Lattner12143052006-10-21 00:47:49 +0000277 break;
Chris Lattner8aa797a2007-12-30 23:10:15 +0000278 case MachineOperand::MO_FrameIndex:
Chris Lattner12143052006-10-21 00:47:49 +0000279 case MachineOperand::MO_ConstantPoolIndex:
Chris Lattner12143052006-10-21 00:47:49 +0000280 case MachineOperand::MO_JumpTableIndex:
Chris Lattner8aa797a2007-12-30 23:10:15 +0000281 OperandHash = Op.getIndex();
Chris Lattner12143052006-10-21 00:47:49 +0000282 break;
283 case MachineOperand::MO_GlobalAddress:
284 case MachineOperand::MO_ExternalSymbol:
285 // Global address / external symbol are too hard, don't bother, but do
286 // pull in the offset.
287 OperandHash = Op.getOffset();
288 break;
289 default: break;
290 }
Dan Gohman4e3f1252009-11-11 18:38:14 +0000291
Chris Lattner12143052006-10-21 00:47:49 +0000292 Hash += ((OperandHash << 3) | Op.getType()) << (i&31);
293 }
294 return Hash;
295}
296
Dale Johannesen7aea8322007-05-23 21:07:20 +0000297/// HashEndOfMBB - Hash the last few instructions in the MBB. For blocks
Dan Gohman4e3f1252009-11-11 18:38:14 +0000298/// with no successors, we hash two instructions, because cross-jumping
299/// only saves code when at least two instructions are removed (since a
Dale Johannesen7aea8322007-05-23 21:07:20 +0000300/// branch must be inserted). For blocks with a successor, one of the
301/// two blocks to be tail-merged will end with a branch already, so
302/// it gains to cross-jump even for one instruction.
Dale Johannesen7aea8322007-05-23 21:07:20 +0000303static unsigned HashEndOfMBB(const MachineBasicBlock *MBB,
304 unsigned minCommonTailLength) {
Chris Lattner12143052006-10-21 00:47:49 +0000305 MachineBasicBlock::const_iterator I = MBB->end();
306 if (I == MBB->begin())
307 return 0; // Empty MBB.
Dan Gohman4e3f1252009-11-11 18:38:14 +0000308
Chris Lattner12143052006-10-21 00:47:49 +0000309 --I;
310 unsigned Hash = HashMachineInstr(I);
Dan Gohman4e3f1252009-11-11 18:38:14 +0000311
Dale Johannesen7aea8322007-05-23 21:07:20 +0000312 if (I == MBB->begin() || minCommonTailLength == 1)
Chris Lattner12143052006-10-21 00:47:49 +0000313 return Hash; // Single instr MBB.
Dan Gohman4e3f1252009-11-11 18:38:14 +0000314
Chris Lattner12143052006-10-21 00:47:49 +0000315 --I;
316 // Hash in the second-to-last instruction.
317 Hash ^= HashMachineInstr(I) << 2;
318 return Hash;
319}
320
321/// ComputeCommonTailLength - Given two machine basic blocks, compute the number
322/// of instructions they actually have in common together at their end. Return
323/// iterators for the first shared instruction in each block.
324static unsigned ComputeCommonTailLength(MachineBasicBlock *MBB1,
325 MachineBasicBlock *MBB2,
326 MachineBasicBlock::iterator &I1,
327 MachineBasicBlock::iterator &I2) {
328 I1 = MBB1->end();
329 I2 = MBB2->end();
Dan Gohman4e3f1252009-11-11 18:38:14 +0000330
Chris Lattner12143052006-10-21 00:47:49 +0000331 unsigned TailLen = 0;
332 while (I1 != MBB1->begin() && I2 != MBB2->begin()) {
333 --I1; --I2;
Dan Gohman4e3f1252009-11-11 18:38:14 +0000334 if (!I1->isIdenticalTo(I2) ||
Bill Wendlingda6efc52007-10-25 19:49:32 +0000335 // FIXME: This check is dubious. It's used to get around a problem where
Bill Wendling0713a222007-10-25 18:23:45 +0000336 // people incorrectly expect inline asm directives to remain in the same
337 // relative order. This is untenable because normal compiler
338 // optimizations (like this one) may reorder and/or merge these
339 // directives.
Bill Wendling80629c82007-10-19 21:09:55 +0000340 I1->getOpcode() == TargetInstrInfo::INLINEASM) {
Chris Lattner12143052006-10-21 00:47:49 +0000341 ++I1; ++I2;
342 break;
343 }
344 ++TailLen;
345 }
346 return TailLen;
347}
348
349/// ReplaceTailWithBranchTo - Delete the instruction OldInst and everything
Chris Lattner386e2902006-10-21 05:08:28 +0000350/// after it, replacing it with an unconditional branch to NewDest. This
351/// returns true if OldInst's block is modified, false if NewDest is modified.
Chris Lattner12143052006-10-21 00:47:49 +0000352void BranchFolder::ReplaceTailWithBranchTo(MachineBasicBlock::iterator OldInst,
353 MachineBasicBlock *NewDest) {
354 MachineBasicBlock *OldBB = OldInst->getParent();
Dan Gohman4e3f1252009-11-11 18:38:14 +0000355
Chris Lattner12143052006-10-21 00:47:49 +0000356 // Remove all the old successors of OldBB from the CFG.
357 while (!OldBB->succ_empty())
358 OldBB->removeSuccessor(OldBB->succ_begin());
Dan Gohman4e3f1252009-11-11 18:38:14 +0000359
Chris Lattner12143052006-10-21 00:47:49 +0000360 // Remove all the dead instructions from the end of OldBB.
361 OldBB->erase(OldInst, OldBB->end());
362
Chris Lattner386e2902006-10-21 05:08:28 +0000363 // If OldBB isn't immediately before OldBB, insert a branch to it.
364 if (++MachineFunction::iterator(OldBB) != MachineFunction::iterator(NewDest))
Dan Gohman1501cdb2008-08-22 16:07:55 +0000365 TII->InsertBranch(*OldBB, NewDest, 0, SmallVector<MachineOperand, 0>());
Chris Lattner12143052006-10-21 00:47:49 +0000366 OldBB->addSuccessor(NewDest);
367 ++NumTailMerge;
368}
369
Chris Lattner1d08d832006-11-01 01:16:12 +0000370/// SplitMBBAt - Given a machine basic block and an iterator into it, split the
371/// MBB so that the part before the iterator falls into the part starting at the
372/// iterator. This returns the new MBB.
373MachineBasicBlock *BranchFolder::SplitMBBAt(MachineBasicBlock &CurMBB,
374 MachineBasicBlock::iterator BBI1) {
Dan Gohman8e5f2c62008-07-07 23:14:23 +0000375 MachineFunction &MF = *CurMBB.getParent();
376
Chris Lattner1d08d832006-11-01 01:16:12 +0000377 // Create the fall-through block.
378 MachineFunction::iterator MBBI = &CurMBB;
Dan Gohman8e5f2c62008-07-07 23:14:23 +0000379 MachineBasicBlock *NewMBB =MF.CreateMachineBasicBlock(CurMBB.getBasicBlock());
380 CurMBB.getParent()->insert(++MBBI, NewMBB);
Chris Lattner1d08d832006-11-01 01:16:12 +0000381
382 // Move all the successors of this block to the specified block.
Dan Gohman04478e52008-06-19 17:22:29 +0000383 NewMBB->transferSuccessors(&CurMBB);
Dan Gohman4e3f1252009-11-11 18:38:14 +0000384
Chris Lattner1d08d832006-11-01 01:16:12 +0000385 // Add an edge from CurMBB to NewMBB for the fall-through.
386 CurMBB.addSuccessor(NewMBB);
Dan Gohman4e3f1252009-11-11 18:38:14 +0000387
Chris Lattner1d08d832006-11-01 01:16:12 +0000388 // Splice the code over.
389 NewMBB->splice(NewMBB->end(), &CurMBB, BBI1, CurMBB.end());
Dale Johannesen69cb9b72007-03-20 21:35:06 +0000390
391 // For targets that use the register scavenger, we must maintain LiveIns.
392 if (RS) {
393 RS->enterBasicBlock(&CurMBB);
394 if (!CurMBB.empty())
395 RS->forward(prior(CurMBB.end()));
Evan Cheng030a0a02009-09-04 07:47:40 +0000396 BitVector RegsLiveAtExit(TRI->getNumRegs());
Dale Johannesen69cb9b72007-03-20 21:35:06 +0000397 RS->getRegsUsed(RegsLiveAtExit, false);
Dan Gohman8520149d2009-11-12 01:51:28 +0000398 for (unsigned int i = 0, e = TRI->getNumRegs(); i != e; i++)
Dale Johannesen69cb9b72007-03-20 21:35:06 +0000399 if (RegsLiveAtExit[i])
400 NewMBB->addLiveIn(i);
401 }
402
Chris Lattner1d08d832006-11-01 01:16:12 +0000403 return NewMBB;
404}
405
Chris Lattnerd4bf3c22006-11-01 19:36:29 +0000406/// EstimateRuntime - Make a rough estimate for how long it will take to run
407/// the specified code.
408static unsigned EstimateRuntime(MachineBasicBlock::iterator I,
Chris Lattner69244302008-01-07 01:56:04 +0000409 MachineBasicBlock::iterator E) {
Chris Lattnerd4bf3c22006-11-01 19:36:29 +0000410 unsigned Time = 0;
411 for (; I != E; ++I) {
Chris Lattner749c6f62008-01-07 07:27:27 +0000412 const TargetInstrDesc &TID = I->getDesc();
413 if (TID.isCall())
Chris Lattnerd4bf3c22006-11-01 19:36:29 +0000414 Time += 10;
Dan Gohman41474ba2008-12-03 02:30:17 +0000415 else if (TID.mayLoad() || TID.mayStore())
Chris Lattnerd4bf3c22006-11-01 19:36:29 +0000416 Time += 2;
417 else
418 ++Time;
419 }
420 return Time;
421}
422
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000423// CurMBB needs to add an unconditional branch to SuccMBB (we removed these
424// branches temporarily for tail merging). In the case where CurMBB ends
425// with a conditional branch to the next block, optimize by reversing the
426// test and conditionally branching to SuccMBB instead.
Bob Wilsond34f5d92009-11-16 18:08:46 +0000427static void FixTail(MachineBasicBlock *CurMBB, MachineBasicBlock *SuccBB,
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000428 const TargetInstrInfo *TII) {
429 MachineFunction *MF = CurMBB->getParent();
Chris Lattner7896c9f2009-12-03 00:50:42 +0000430 MachineFunction::iterator I = llvm::next(MachineFunction::iterator(CurMBB));
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000431 MachineBasicBlock *TBB = 0, *FBB = 0;
Owen Anderson44eb65c2008-08-14 22:49:33 +0000432 SmallVector<MachineOperand, 4> Cond;
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000433 if (I != MF->end() &&
Evan Chengdc54d312009-02-09 07:14:22 +0000434 !TII->AnalyzeBranch(*CurMBB, TBB, FBB, Cond, true)) {
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000435 MachineBasicBlock *NextBB = I;
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000436 if (TBB == NextBB && !Cond.empty() && !FBB) {
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000437 if (!TII->ReverseBranchCondition(Cond)) {
438 TII->RemoveBranch(*CurMBB);
439 TII->InsertBranch(*CurMBB, SuccBB, NULL, Cond);
440 return;
441 }
442 }
443 }
Dan Gohman1501cdb2008-08-22 16:07:55 +0000444 TII->InsertBranch(*CurMBB, SuccBB, NULL, SmallVector<MachineOperand, 0>());
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000445}
446
Dan Gohmanffe644e2009-11-11 21:57:02 +0000447bool
448BranchFolder::MergePotentialsElt::operator<(const MergePotentialsElt &o) const {
449 if (getHash() < o.getHash())
450 return true;
451 else if (getHash() > o.getHash())
452 return false;
453 else if (getBlock()->getNumber() < o.getBlock()->getNumber())
454 return true;
455 else if (getBlock()->getNumber() > o.getBlock()->getNumber())
456 return false;
457 else {
458 // _GLIBCXX_DEBUG checks strict weak ordering, which involves comparing
459 // an object with itself.
Duncan Sands97b4ac82007-07-11 08:47:55 +0000460#ifndef _GLIBCXX_DEBUG
Dan Gohmanffe644e2009-11-11 21:57:02 +0000461 llvm_unreachable("Predecessor appears twice");
David Greene67fcdf72007-07-10 22:00:30 +0000462#endif
Dan Gohmanffe644e2009-11-11 21:57:02 +0000463 return false;
464 }
Dale Johannesen95ef4062007-05-29 23:47:50 +0000465}
466
Dan Gohman2210c0b2009-11-11 19:48:59 +0000467/// CountTerminators - Count the number of terminators in the given
468/// block and set I to the position of the first non-terminator, if there
469/// is one, or MBB->end() otherwise.
470static unsigned CountTerminators(MachineBasicBlock *MBB,
471 MachineBasicBlock::iterator &I) {
472 I = MBB->end();
473 unsigned NumTerms = 0;
474 for (;;) {
475 if (I == MBB->begin()) {
476 I = MBB->end();
477 break;
478 }
479 --I;
480 if (!I->getDesc().isTerminator()) break;
481 ++NumTerms;
482 }
483 return NumTerms;
484}
485
Bob Wilson7b888b82009-10-29 18:40:06 +0000486/// ProfitableToMerge - Check if two machine basic blocks have a common tail
487/// and decide if it would be profitable to merge those tails. Return the
488/// length of the common tail and iterators to the first common instruction
489/// in each block.
490static bool ProfitableToMerge(MachineBasicBlock *MBB1,
491 MachineBasicBlock *MBB2,
492 unsigned minCommonTailLength,
493 unsigned &CommonTailLen,
494 MachineBasicBlock::iterator &I1,
Dan Gohman2210c0b2009-11-11 19:48:59 +0000495 MachineBasicBlock::iterator &I2,
496 MachineBasicBlock *SuccBB,
497 MachineBasicBlock *PredBB) {
Bob Wilson7b888b82009-10-29 18:40:06 +0000498 CommonTailLen = ComputeCommonTailLength(MBB1, MBB2, I1, I2);
499 MachineFunction *MF = MBB1->getParent();
500
Bob Wilson7b888b82009-10-29 18:40:06 +0000501 if (CommonTailLen == 0)
502 return false;
503
Dan Gohman2210c0b2009-11-11 19:48:59 +0000504 // It's almost always profitable to merge any number of non-terminator
505 // instructions with the block that falls through into the common successor.
506 if (MBB1 == PredBB || MBB2 == PredBB) {
507 MachineBasicBlock::iterator I;
508 unsigned NumTerms = CountTerminators(MBB1 == PredBB ? MBB2 : MBB1, I);
509 if (CommonTailLen > NumTerms)
510 return true;
511 }
512
Dan Gohmanad6af452009-11-12 00:39:10 +0000513 // If one of the blocks can be completely merged and happens to be in
514 // a position where the other could fall through into it, merge any number
515 // of instructions, because it can be done without a branch.
516 // TODO: If the blocks are not adjacent, move one of them so that they are?
517 if (MBB1->isLayoutSuccessor(MBB2) && I2 == MBB2->begin())
518 return true;
519 if (MBB2->isLayoutSuccessor(MBB1) && I1 == MBB1->begin())
520 return true;
521
Dan Gohman2210c0b2009-11-11 19:48:59 +0000522 // If both blocks have an unconditional branch temporarily stripped out,
Dan Gohmanc4c550c2009-11-13 21:02:15 +0000523 // count that as an additional common instruction for the following
524 // heuristics.
525 unsigned EffectiveTailLen = CommonTailLen;
Bob Wilson3cbc3122009-11-16 17:56:13 +0000526 if (SuccBB && MBB1 != PredBB && MBB2 != PredBB &&
Dan Gohman2210c0b2009-11-11 19:48:59 +0000527 !MBB1->back().getDesc().isBarrier() &&
528 !MBB2->back().getDesc().isBarrier())
Dan Gohmanc4c550c2009-11-13 21:02:15 +0000529 ++EffectiveTailLen;
Dan Gohman2210c0b2009-11-11 19:48:59 +0000530
531 // Check if the common tail is long enough to be worthwhile.
Dan Gohmanc4c550c2009-11-13 21:02:15 +0000532 if (EffectiveTailLen >= minCommonTailLength)
Dan Gohman2210c0b2009-11-11 19:48:59 +0000533 return true;
534
Dan Gohmanc4c550c2009-11-13 21:02:15 +0000535 // If we are optimizing for code size, 2 instructions in common is enough if
536 // we don't have to split a block. At worst we will be introducing 1 new
537 // branch instruction, which is likely to be smaller than the 2
538 // instructions that would be deleted in the merge.
539 if (EffectiveTailLen >= 2 &&
540 MF->getFunction()->hasFnAttr(Attribute::OptimizeForSize) &&
Bob Wilson7b888b82009-10-29 18:40:06 +0000541 (I1 == MBB1->begin() || I2 == MBB2->begin()))
542 return true;
543
544 return false;
545}
546
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000547/// ComputeSameTails - Look through all the blocks in MergePotentials that have
Dan Gohman4e3f1252009-11-11 18:38:14 +0000548/// hash CurHash (guaranteed to match the last element). Build the vector
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000549/// SameTails of all those that have the (same) largest number of instructions
550/// in common of any pair of these blocks. SameTails entries contain an
Dan Gohman4e3f1252009-11-11 18:38:14 +0000551/// iterator into MergePotentials (from which the MachineBasicBlock can be
552/// found) and a MachineBasicBlock::iterator into that MBB indicating the
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000553/// instruction where the matching code sequence begins.
554/// Order of elements in SameTails is the reverse of the order in which
555/// those blocks appear in MergePotentials (where they are not necessarily
556/// consecutive).
Dan Gohman4e3f1252009-11-11 18:38:14 +0000557unsigned BranchFolder::ComputeSameTails(unsigned CurHash,
Dan Gohman2210c0b2009-11-11 19:48:59 +0000558 unsigned minCommonTailLength,
559 MachineBasicBlock *SuccBB,
560 MachineBasicBlock *PredBB) {
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000561 unsigned maxCommonTailLength = 0U;
562 SameTails.clear();
563 MachineBasicBlock::iterator TrialBBI1, TrialBBI2;
564 MPIterator HighestMPIter = prior(MergePotentials.end());
565 for (MPIterator CurMPIter = prior(MergePotentials.end()),
Dan Gohman4e3f1252009-11-11 18:38:14 +0000566 B = MergePotentials.begin();
Dan Gohman8520149d2009-11-12 01:51:28 +0000567 CurMPIter != B && CurMPIter->getHash() == CurHash;
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000568 --CurMPIter) {
Dan Gohmanffe644e2009-11-11 21:57:02 +0000569 for (MPIterator I = prior(CurMPIter); I->getHash() == CurHash ; --I) {
Bob Wilson7b888b82009-10-29 18:40:06 +0000570 unsigned CommonTailLen;
Dan Gohmanffe644e2009-11-11 21:57:02 +0000571 if (ProfitableToMerge(CurMPIter->getBlock(), I->getBlock(),
572 minCommonTailLength,
Dan Gohman2210c0b2009-11-11 19:48:59 +0000573 CommonTailLen, TrialBBI1, TrialBBI2,
574 SuccBB, PredBB)) {
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000575 if (CommonTailLen > maxCommonTailLength) {
576 SameTails.clear();
577 maxCommonTailLength = CommonTailLen;
578 HighestMPIter = CurMPIter;
Dan Gohmanffe644e2009-11-11 21:57:02 +0000579 SameTails.push_back(SameTailElt(CurMPIter, TrialBBI1));
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000580 }
581 if (HighestMPIter == CurMPIter &&
582 CommonTailLen == maxCommonTailLength)
Dan Gohmanffe644e2009-11-11 21:57:02 +0000583 SameTails.push_back(SameTailElt(I, TrialBBI2));
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000584 }
Dan Gohman4e3f1252009-11-11 18:38:14 +0000585 if (I == B)
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000586 break;
587 }
588 }
589 return maxCommonTailLength;
590}
591
592/// RemoveBlocksWithHash - Remove all blocks with hash CurHash from
593/// MergePotentials, restoring branches at ends of blocks as appropriate.
Dan Gohman4e3f1252009-11-11 18:38:14 +0000594void BranchFolder::RemoveBlocksWithHash(unsigned CurHash,
Bob Wilsond34f5d92009-11-16 18:08:46 +0000595 MachineBasicBlock *SuccBB,
596 MachineBasicBlock *PredBB) {
Dale Johannesen679860e2008-05-23 17:19:02 +0000597 MPIterator CurMPIter, B;
Dan Gohman4e3f1252009-11-11 18:38:14 +0000598 for (CurMPIter = prior(MergePotentials.end()), B = MergePotentials.begin();
Dan Gohmanffe644e2009-11-11 21:57:02 +0000599 CurMPIter->getHash() == CurHash;
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000600 --CurMPIter) {
601 // Put the unconditional branch back, if we need one.
Dan Gohmanffe644e2009-11-11 21:57:02 +0000602 MachineBasicBlock *CurMBB = CurMPIter->getBlock();
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000603 if (SuccBB && CurMBB != PredBB)
604 FixTail(CurMBB, SuccBB, TII);
Dan Gohman4e3f1252009-11-11 18:38:14 +0000605 if (CurMPIter == B)
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000606 break;
607 }
Dan Gohmanffe644e2009-11-11 21:57:02 +0000608 if (CurMPIter->getHash() != CurHash)
Dale Johannesen679860e2008-05-23 17:19:02 +0000609 CurMPIter++;
610 MergePotentials.erase(CurMPIter, MergePotentials.end());
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000611}
612
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000613/// CreateCommonTailOnlyBlock - None of the blocks to be tail-merged consist
614/// only of the common tail. Create a block that does by splitting one.
615unsigned BranchFolder::CreateCommonTailOnlyBlock(MachineBasicBlock *&PredBB,
616 unsigned maxCommonTailLength) {
Dan Gohman8520149d2009-11-12 01:51:28 +0000617 unsigned commonTailIndex = 0;
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000618 unsigned TimeEstimate = ~0U;
Dan Gohman8520149d2009-11-12 01:51:28 +0000619 for (unsigned i = 0, e = SameTails.size(); i != e; ++i) {
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000620 // Use PredBB if possible; that doesn't require a new branch.
Dan Gohmanffe644e2009-11-11 21:57:02 +0000621 if (SameTails[i].getBlock() == PredBB) {
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000622 commonTailIndex = i;
623 break;
624 }
625 // Otherwise, make a (fairly bogus) choice based on estimate of
626 // how long it will take the various blocks to execute.
Dan Gohmanffe644e2009-11-11 21:57:02 +0000627 unsigned t = EstimateRuntime(SameTails[i].getBlock()->begin(),
628 SameTails[i].getTailStartPos());
Dan Gohman4e3f1252009-11-11 18:38:14 +0000629 if (t <= TimeEstimate) {
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000630 TimeEstimate = t;
631 commonTailIndex = i;
632 }
633 }
634
Dan Gohmanffe644e2009-11-11 21:57:02 +0000635 MachineBasicBlock::iterator BBI =
636 SameTails[commonTailIndex].getTailStartPos();
637 MachineBasicBlock *MBB = SameTails[commonTailIndex].getBlock();
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000638
Dan Gohmana127edc2009-11-11 18:23:17 +0000639 DEBUG(errs() << "\nSplitting BB#" << MBB->getNumber() << ", size "
Bill Wendling3403bcd2009-08-22 20:03:00 +0000640 << maxCommonTailLength);
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000641
642 MachineBasicBlock *newMBB = SplitMBBAt(*MBB, BBI);
Dan Gohmanffe644e2009-11-11 21:57:02 +0000643 SameTails[commonTailIndex].setBlock(newMBB);
644 SameTails[commonTailIndex].setTailStartPos(newMBB->begin());
Dan Gohman4e3f1252009-11-11 18:38:14 +0000645
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000646 // If we split PredBB, newMBB is the new predecessor.
Dan Gohman4e3f1252009-11-11 18:38:14 +0000647 if (PredBB == MBB)
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000648 PredBB = newMBB;
649
650 return commonTailIndex;
651}
652
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000653// See if any of the blocks in MergePotentials (which all have a common single
654// successor, or all have no successor) can be tail-merged. If there is a
655// successor, any blocks in MergePotentials that are not tail-merged and
656// are not immediately before Succ must have an unconditional branch to
Dan Gohman4e3f1252009-11-11 18:38:14 +0000657// Succ added (but the predecessor/successor lists need no adjustment).
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000658// The lone predecessor of Succ that falls through into Succ,
659// if any, is given in PredBB.
660
Dan Gohman2210c0b2009-11-11 19:48:59 +0000661bool BranchFolder::TryTailMergeBlocks(MachineBasicBlock *SuccBB,
Bob Wilsond34f5d92009-11-16 18:08:46 +0000662 MachineBasicBlock *PredBB) {
Evan Cheng030a0a02009-09-04 07:47:40 +0000663 bool MadeChange = false;
664
Dan Gohman2210c0b2009-11-11 19:48:59 +0000665 // Except for the special cases below, tail-merge if there are at least
666 // this many instructions in common.
667 unsigned minCommonTailLength = TailMergeSize;
Dan Gohman4e3f1252009-11-11 18:38:14 +0000668
Dan Gohman2210c0b2009-11-11 19:48:59 +0000669 DEBUG(errs() << "\nTryTailMergeBlocks: ";
670 for (unsigned i = 0, e = MergePotentials.size(); i != e; ++i)
Dan Gohmanffe644e2009-11-11 21:57:02 +0000671 errs() << "BB#" << MergePotentials[i].getBlock()->getNumber()
Dan Gohman2210c0b2009-11-11 19:48:59 +0000672 << (i == e-1 ? "" : ", ");
673 errs() << "\n";
674 if (SuccBB) {
675 errs() << " with successor BB#" << SuccBB->getNumber() << '\n';
676 if (PredBB)
677 errs() << " which has fall-through from BB#"
678 << PredBB->getNumber() << "\n";
679 }
680 errs() << "Looking for common tails of at least "
681 << minCommonTailLength << " instruction"
682 << (minCommonTailLength == 1 ? "" : "s") << '\n';
683 );
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000684
Chris Lattner12143052006-10-21 00:47:49 +0000685 // Sort by hash value so that blocks with identical end sequences sort
686 // together.
Dan Gohmanffe644e2009-11-11 21:57:02 +0000687 std::stable_sort(MergePotentials.begin(), MergePotentials.end());
Chris Lattner12143052006-10-21 00:47:49 +0000688
689 // Walk through equivalence sets looking for actual exact matches.
690 while (MergePotentials.size() > 1) {
Dan Gohmanffe644e2009-11-11 21:57:02 +0000691 unsigned CurHash = MergePotentials.back().getHash();
Dan Gohman4e3f1252009-11-11 18:38:14 +0000692
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000693 // Build SameTails, identifying the set of blocks with this hash code
694 // and with the maximum number of instructions in common.
Dan Gohman4e3f1252009-11-11 18:38:14 +0000695 unsigned maxCommonTailLength = ComputeSameTails(CurHash,
Dan Gohman2210c0b2009-11-11 19:48:59 +0000696 minCommonTailLength,
697 SuccBB, PredBB);
Dale Johannesen7aea8322007-05-23 21:07:20 +0000698
Dan Gohman4e3f1252009-11-11 18:38:14 +0000699 // If we didn't find any pair that has at least minCommonTailLength
Dale Johannesen6ae83fa2008-05-09 21:24:35 +0000700 // instructions in common, remove all blocks with this hash code and retry.
701 if (SameTails.empty()) {
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000702 RemoveBlocksWithHash(CurHash, SuccBB, PredBB);
Dale Johannesen7aea8322007-05-23 21:07:20 +0000703 continue;
Chris Lattner12143052006-10-21 00:47:49 +0000704 }
Chris Lattner1d08d832006-11-01 01:16:12 +0000705
Dale Johannesen6ae83fa2008-05-09 21:24:35 +0000706 // If one of the blocks is the entire common tail (and not the entry
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000707 // block, which we can't jump to), we can treat all blocks with this same
708 // tail at once. Use PredBB if that is one of the possibilities, as that
709 // will not introduce any extra branches.
Dan Gohmanffe644e2009-11-11 21:57:02 +0000710 MachineBasicBlock *EntryBB = MergePotentials.begin()->getBlock()->
711 getParent()->begin();
712 unsigned commonTailIndex = SameTails.size();
Dan Gohmanad6af452009-11-12 00:39:10 +0000713 // If there are two blocks, check to see if one can be made to fall through
714 // into the other.
715 if (SameTails.size() == 2 &&
716 SameTails[0].getBlock()->isLayoutSuccessor(SameTails[1].getBlock()) &&
717 SameTails[1].tailIsWholeBlock())
718 commonTailIndex = 1;
719 else if (SameTails.size() == 2 &&
720 SameTails[1].getBlock()->isLayoutSuccessor(
721 SameTails[0].getBlock()) &&
722 SameTails[0].tailIsWholeBlock())
723 commonTailIndex = 0;
724 else {
725 // Otherwise just pick one, favoring the fall-through predecessor if
726 // there is one.
727 for (unsigned i = 0, e = SameTails.size(); i != e; ++i) {
728 MachineBasicBlock *MBB = SameTails[i].getBlock();
729 if (MBB == EntryBB && SameTails[i].tailIsWholeBlock())
730 continue;
731 if (MBB == PredBB) {
732 commonTailIndex = i;
733 break;
734 }
735 if (SameTails[i].tailIsWholeBlock())
736 commonTailIndex = i;
Dale Johannesen6ae83fa2008-05-09 21:24:35 +0000737 }
Dale Johannesen6ae83fa2008-05-09 21:24:35 +0000738 }
Dale Johannesena5a21172007-06-01 23:02:45 +0000739
Dan Gohman2210c0b2009-11-11 19:48:59 +0000740 if (commonTailIndex == SameTails.size() ||
Dan Gohmanffe644e2009-11-11 21:57:02 +0000741 (SameTails[commonTailIndex].getBlock() == PredBB &&
742 !SameTails[commonTailIndex].tailIsWholeBlock())) {
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000743 // None of the blocks consist entirely of the common tail.
744 // Split a block so that one does.
Dan Gohman2210c0b2009-11-11 19:48:59 +0000745 commonTailIndex = CreateCommonTailOnlyBlock(PredBB, maxCommonTailLength);
Chris Lattner1d08d832006-11-01 01:16:12 +0000746 }
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000747
Dan Gohmanffe644e2009-11-11 21:57:02 +0000748 MachineBasicBlock *MBB = SameTails[commonTailIndex].getBlock();
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000749 // MBB is common tail. Adjust all other BB's to jump to this one.
750 // Traversal must be forwards so erases work.
Dan Gohman2210c0b2009-11-11 19:48:59 +0000751 DEBUG(errs() << "\nUsing common tail in BB#" << MBB->getNumber()
752 << " for ");
753 for (unsigned int i=0, e = SameTails.size(); i != e; ++i) {
Dan Gohman4e3f1252009-11-11 18:38:14 +0000754 if (commonTailIndex == i)
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000755 continue;
Dan Gohmanffe644e2009-11-11 21:57:02 +0000756 DEBUG(errs() << "BB#" << SameTails[i].getBlock()->getNumber()
Dan Gohman2210c0b2009-11-11 19:48:59 +0000757 << (i == e-1 ? "" : ", "));
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000758 // Hack the end off BB i, making it jump to BB commonTailIndex instead.
Dan Gohmanffe644e2009-11-11 21:57:02 +0000759 ReplaceTailWithBranchTo(SameTails[i].getTailStartPos(), MBB);
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000760 // BB i is no longer a predecessor of SuccBB; remove it from the worklist.
Dan Gohmanffe644e2009-11-11 21:57:02 +0000761 MergePotentials.erase(SameTails[i].getMPIter());
Chris Lattner12143052006-10-21 00:47:49 +0000762 }
Bill Wendling3403bcd2009-08-22 20:03:00 +0000763 DEBUG(errs() << "\n");
Dale Johannesen51b2b9e2008-05-12 20:33:57 +0000764 // We leave commonTailIndex in the worklist in case there are other blocks
765 // that match it with a smaller number of instructions.
Chris Lattner1d08d832006-11-01 01:16:12 +0000766 MadeChange = true;
Chris Lattner12143052006-10-21 00:47:49 +0000767 }
Chris Lattner12143052006-10-21 00:47:49 +0000768 return MadeChange;
769}
770
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000771bool BranchFolder::TailMergeBlocks(MachineFunction &MF) {
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000772
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000773 if (!EnableTailMerge) return false;
Dan Gohman4e3f1252009-11-11 18:38:14 +0000774
Evan Cheng030a0a02009-09-04 07:47:40 +0000775 bool MadeChange = false;
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000776
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000777 // First find blocks with no successors.
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000778 MergePotentials.clear();
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000779 for (MachineFunction::iterator I = MF.begin(), E = MF.end(); I != E; ++I) {
780 if (I->succ_empty())
Dan Gohmanffe644e2009-11-11 21:57:02 +0000781 MergePotentials.push_back(MergePotentialsElt(HashEndOfMBB(I, 2U), I));
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000782 }
Dan Gohman4e3f1252009-11-11 18:38:14 +0000783
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000784 // See if we can do any tail merging on those.
Dale Johannesen6ae83fa2008-05-09 21:24:35 +0000785 if (MergePotentials.size() < TailMergeThreshold &&
786 MergePotentials.size() >= 2)
Dan Gohman2210c0b2009-11-11 19:48:59 +0000787 MadeChange |= TryTailMergeBlocks(NULL, NULL);
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000788
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000789 // Look at blocks (IBB) with multiple predecessors (PBB).
790 // We change each predecessor to a canonical form, by
791 // (1) temporarily removing any unconditional branch from the predecessor
792 // to IBB, and
793 // (2) alter conditional branches so they branch to the other block
Dan Gohman4e3f1252009-11-11 18:38:14 +0000794 // not IBB; this may require adding back an unconditional branch to IBB
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000795 // later, where there wasn't one coming in. E.g.
796 // Bcc IBB
797 // fallthrough to QBB
798 // here becomes
799 // Bncc QBB
800 // with a conceptual B to IBB after that, which never actually exists.
801 // With those changes, we see whether the predecessors' tails match,
802 // and merge them if so. We change things out of canonical form and
803 // back to the way they were later in the process. (OptimizeBranches
804 // would undo some of this, but we can't use it, because we'd get into
805 // a compile-time infinite loop repeatedly doing and undoing the same
806 // transformations.)
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000807
Chris Lattner7896c9f2009-12-03 00:50:42 +0000808 for (MachineFunction::iterator I = llvm::next(MF.begin()), E = MF.end();
Dan Gohman2210c0b2009-11-11 19:48:59 +0000809 I != E; ++I) {
Dale Johannesen62bc8a42008-07-01 21:50:14 +0000810 if (I->pred_size() >= 2 && I->pred_size() < TailMergeThreshold) {
Dan Gohmanda658222009-08-18 15:18:18 +0000811 SmallPtrSet<MachineBasicBlock *, 8> UniquePreds;
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000812 MachineBasicBlock *IBB = I;
813 MachineBasicBlock *PredBB = prior(I);
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000814 MergePotentials.clear();
Dan Gohman4e3f1252009-11-11 18:38:14 +0000815 for (MachineBasicBlock::pred_iterator P = I->pred_begin(),
Dale Johannesen1a90a5a2007-06-08 01:08:52 +0000816 E2 = I->pred_end();
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000817 P != E2; ++P) {
Bob Wilsond34f5d92009-11-16 18:08:46 +0000818 MachineBasicBlock *PBB = *P;
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000819 // Skip blocks that loop to themselves, can't tail merge these.
Dan Gohman4e3f1252009-11-11 18:38:14 +0000820 if (PBB == IBB)
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000821 continue;
Dan Gohmanda658222009-08-18 15:18:18 +0000822 // Visit each predecessor only once.
823 if (!UniquePreds.insert(PBB))
824 continue;
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000825 MachineBasicBlock *TBB = 0, *FBB = 0;
Owen Anderson44eb65c2008-08-14 22:49:33 +0000826 SmallVector<MachineOperand, 4> Cond;
Evan Chengdc54d312009-02-09 07:14:22 +0000827 if (!TII->AnalyzeBranch(*PBB, TBB, FBB, Cond, true)) {
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000828 // Failing case: IBB is the target of a cbr, and
829 // we cannot reverse the branch.
Owen Anderson44eb65c2008-08-14 22:49:33 +0000830 SmallVector<MachineOperand, 4> NewCond(Cond);
Dan Gohman4e3f1252009-11-11 18:38:14 +0000831 if (!Cond.empty() && TBB == IBB) {
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000832 if (TII->ReverseBranchCondition(NewCond))
833 continue;
834 // This is the QBB case described above
835 if (!FBB)
Chris Lattner7896c9f2009-12-03 00:50:42 +0000836 FBB = llvm::next(MachineFunction::iterator(PBB));
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000837 }
Dale Johannesenfe7e3972007-06-04 23:52:54 +0000838 // Failing case: the only way IBB can be reached from PBB is via
839 // exception handling. Happens for landing pads. Would be nice
840 // to have a bit in the edge so we didn't have to do all this.
841 if (IBB->isLandingPad()) {
842 MachineFunction::iterator IP = PBB; IP++;
Bob Wilsond34f5d92009-11-16 18:08:46 +0000843 MachineBasicBlock *PredNextBB = NULL;
Dan Gohman8520149d2009-11-12 01:51:28 +0000844 if (IP != MF.end())
Dale Johannesenfe7e3972007-06-04 23:52:54 +0000845 PredNextBB = IP;
Dan Gohman4e3f1252009-11-11 18:38:14 +0000846 if (TBB == NULL) {
Dan Gohman8520149d2009-11-12 01:51:28 +0000847 if (IBB != PredNextBB) // fallthrough
Dale Johannesenfe7e3972007-06-04 23:52:54 +0000848 continue;
849 } else if (FBB) {
Dan Gohman8520149d2009-11-12 01:51:28 +0000850 if (TBB != IBB && FBB != IBB) // cbr then ubr
Dale Johannesenfe7e3972007-06-04 23:52:54 +0000851 continue;
Dan Gohman30359592008-01-29 13:02:09 +0000852 } else if (Cond.empty()) {
Dan Gohman8520149d2009-11-12 01:51:28 +0000853 if (TBB != IBB) // ubr
Dale Johannesenfe7e3972007-06-04 23:52:54 +0000854 continue;
855 } else {
Dan Gohman8520149d2009-11-12 01:51:28 +0000856 if (TBB != IBB && IBB != PredNextBB) // cbr
Dale Johannesenfe7e3972007-06-04 23:52:54 +0000857 continue;
858 }
859 }
Dale Johannesen76b38fc2007-05-10 01:01:49 +0000860 // Remove the unconditional branch at the end, if any.
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000861 if (TBB && (Cond.empty() || FBB)) {
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000862 TII->RemoveBranch(*PBB);
Dale Johannesen6b8583c2008-05-09 23:28:24 +0000863 if (!Cond.empty())
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000864 // reinsert conditional branch only, for now
Dan Gohman4e3f1252009-11-11 18:38:14 +0000865 TII->InsertBranch(*PBB, (TBB == IBB) ? FBB : TBB, 0, NewCond);
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000866 }
Dan Gohmanffe644e2009-11-11 21:57:02 +0000867 MergePotentials.push_back(MergePotentialsElt(HashEndOfMBB(PBB, 1U),
868 *P));
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000869 }
870 }
Dan Gohmancdc06ba2009-11-11 18:42:28 +0000871 if (MergePotentials.size() >= 2)
Dan Gohman2210c0b2009-11-11 19:48:59 +0000872 MadeChange |= TryTailMergeBlocks(IBB, PredBB);
Dan Gohmancdc06ba2009-11-11 18:42:28 +0000873 // Reinsert an unconditional branch if needed.
Dan Gohman2210c0b2009-11-11 19:48:59 +0000874 // The 1 below can occur as a result of removing blocks in TryTailMergeBlocks.
875 PredBB = prior(I); // this may have been changed in TryTailMergeBlocks
Dan Gohmancdc06ba2009-11-11 18:42:28 +0000876 if (MergePotentials.size() == 1 &&
Dan Gohmanffe644e2009-11-11 21:57:02 +0000877 MergePotentials.begin()->getBlock() != PredBB)
878 FixTail(MergePotentials.begin()->getBlock(), IBB, TII);
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000879 }
880 }
Dale Johannesen7d33b4c2007-05-07 20:57:21 +0000881 return MadeChange;
882}
Chris Lattner12143052006-10-21 00:47:49 +0000883
884//===----------------------------------------------------------------------===//
885// Branch Optimization
886//===----------------------------------------------------------------------===//
887
888bool BranchFolder::OptimizeBranches(MachineFunction &MF) {
Evan Cheng030a0a02009-09-04 07:47:40 +0000889 bool MadeChange = false;
Dan Gohman4e3f1252009-11-11 18:38:14 +0000890
Dale Johannesen6b896ce2007-02-17 00:44:34 +0000891 // Make sure blocks are numbered in order
892 MF.RenumberBlocks();
893
Chris Lattner12143052006-10-21 00:47:49 +0000894 for (MachineFunction::iterator I = ++MF.begin(), E = MF.end(); I != E; ) {
895 MachineBasicBlock *MBB = I++;
Evan Cheng030a0a02009-09-04 07:47:40 +0000896 MadeChange |= OptimizeBlock(MBB);
Dan Gohman4e3f1252009-11-11 18:38:14 +0000897
Chris Lattner12143052006-10-21 00:47:49 +0000898 // If it is dead, remove it.
Jim Laskey033c9712007-02-22 16:39:03 +0000899 if (MBB->pred_empty()) {
Chris Lattner12143052006-10-21 00:47:49 +0000900 RemoveDeadBlock(MBB);
901 MadeChange = true;
902 ++NumDeadBlocks;
903 }
904 }
905 return MadeChange;
906}
907
908
Chris Lattnera7bef4a2006-11-18 20:47:54 +0000909/// IsBetterFallthrough - Return true if it would be clearly better to
910/// fall-through to MBB1 than to fall through into MBB2. This has to return
911/// a strict ordering, returning true for both (MBB1,MBB2) and (MBB2,MBB1) will
912/// result in infinite loops.
Dan Gohman4e3f1252009-11-11 18:38:14 +0000913static bool IsBetterFallthrough(MachineBasicBlock *MBB1,
Chris Lattner69244302008-01-07 01:56:04 +0000914 MachineBasicBlock *MBB2) {
Chris Lattner154e1042006-11-18 21:30:35 +0000915 // Right now, we use a simple heuristic. If MBB2 ends with a call, and
916 // MBB1 doesn't, we prefer to fall through into MBB1. This allows us to
Chris Lattnera7bef4a2006-11-18 20:47:54 +0000917 // optimize branches that branch to either a return block or an assert block
918 // into a fallthrough to the return.
919 if (MBB1->empty() || MBB2->empty()) return false;
Dan Gohman4e3f1252009-11-11 18:38:14 +0000920
Christopher Lamb11a4f642007-12-10 07:24:06 +0000921 // If there is a clear successor ordering we make sure that one block
922 // will fall through to the next
923 if (MBB1->isSuccessor(MBB2)) return true;
924 if (MBB2->isSuccessor(MBB1)) return false;
Chris Lattnera7bef4a2006-11-18 20:47:54 +0000925
926 MachineInstr *MBB1I = --MBB1->end();
927 MachineInstr *MBB2I = --MBB2->end();
Chris Lattner749c6f62008-01-07 07:27:27 +0000928 return MBB2I->getDesc().isCall() && !MBB1I->getDesc().isCall();
Chris Lattnera7bef4a2006-11-18 20:47:54 +0000929}
930
Chris Lattner7821a8a2006-10-14 00:21:48 +0000931/// OptimizeBlock - Analyze and optimize control flow related to the specified
932/// block. This is never called on the entry block.
Evan Cheng030a0a02009-09-04 07:47:40 +0000933bool BranchFolder::OptimizeBlock(MachineBasicBlock *MBB) {
934 bool MadeChange = false;
Dan Gohmand1944982009-11-11 18:18:34 +0000935 MachineFunction &MF = *MBB->getParent();
Dan Gohman2210c0b2009-11-11 19:48:59 +0000936ReoptimizeBlock:
Evan Cheng030a0a02009-09-04 07:47:40 +0000937
Chris Lattner7d097842006-10-24 01:12:32 +0000938 MachineFunction::iterator FallThrough = MBB;
939 ++FallThrough;
Dan Gohman4e3f1252009-11-11 18:38:14 +0000940
Chris Lattnereb15eee2006-10-13 20:43:10 +0000941 // If this block is empty, make everyone use its fall-through, not the block
Dale Johannesena52dd152007-05-31 21:54:00 +0000942 // explicitly. Landing pads should not do this since the landing-pad table
Dan Gohmanab918102009-10-30 02:13:27 +0000943 // points to this block. Blocks with their addresses taken shouldn't be
944 // optimized away.
945 if (MBB->empty() && !MBB->isLandingPad() && !MBB->hasAddressTaken()) {
Chris Lattner386e2902006-10-21 05:08:28 +0000946 // Dead block? Leave for cleanup later.
Evan Cheng030a0a02009-09-04 07:47:40 +0000947 if (MBB->pred_empty()) return MadeChange;
Dan Gohman4e3f1252009-11-11 18:38:14 +0000948
Dan Gohmand1944982009-11-11 18:18:34 +0000949 if (FallThrough == MF.end()) {
Chris Lattnerc50ffcb2006-10-17 17:13:52 +0000950 // TODO: Simplify preds to not branch here if possible!
951 } else {
952 // Rewrite all predecessors of the old block to go to the fallthrough
953 // instead.
Jim Laskey033c9712007-02-22 16:39:03 +0000954 while (!MBB->pred_empty()) {
Chris Lattner7821a8a2006-10-14 00:21:48 +0000955 MachineBasicBlock *Pred = *(MBB->pred_end()-1);
Evan Cheng0370fad2007-06-04 06:44:01 +0000956 Pred->ReplaceUsesOfBlockWith(MBB, FallThrough);
Chris Lattner7821a8a2006-10-14 00:21:48 +0000957 }
Chris Lattnerc50ffcb2006-10-17 17:13:52 +0000958 // If MBB was the target of a jump table, update jump tables to go to the
959 // fallthrough instead.
Dan Gohmand1944982009-11-11 18:18:34 +0000960 MF.getJumpTableInfo()->ReplaceMBBInJumpTables(MBB, FallThrough);
Chris Lattner7821a8a2006-10-14 00:21:48 +0000961 MadeChange = true;
Chris Lattner21ab22e2004-07-31 10:01:27 +0000962 }
Evan Cheng030a0a02009-09-04 07:47:40 +0000963 return MadeChange;
Chris Lattner21ab22e2004-07-31 10:01:27 +0000964 }
965
Chris Lattner7821a8a2006-10-14 00:21:48 +0000966 // Check to see if we can simplify the terminator of the block before this
967 // one.
Chris Lattner7d097842006-10-24 01:12:32 +0000968 MachineBasicBlock &PrevBB = *prior(MachineFunction::iterator(MBB));
Chris Lattnerffddf6b2006-10-17 18:16:40 +0000969
Chris Lattner7821a8a2006-10-14 00:21:48 +0000970 MachineBasicBlock *PriorTBB = 0, *PriorFBB = 0;
Owen Anderson44eb65c2008-08-14 22:49:33 +0000971 SmallVector<MachineOperand, 4> PriorCond;
Chris Lattner6b0e3f82006-10-29 21:05:41 +0000972 bool PriorUnAnalyzable =
Evan Chengdc54d312009-02-09 07:14:22 +0000973 TII->AnalyzeBranch(PrevBB, PriorTBB, PriorFBB, PriorCond, true);
Chris Lattner386e2902006-10-21 05:08:28 +0000974 if (!PriorUnAnalyzable) {
975 // If the CFG for the prior block has extra edges, remove them.
Evan Cheng2bdb7d02007-06-18 22:43:58 +0000976 MadeChange |= PrevBB.CorrectExtraCFGEdges(PriorTBB, PriorFBB,
977 !PriorCond.empty());
Dan Gohman4e3f1252009-11-11 18:38:14 +0000978
Chris Lattner7821a8a2006-10-14 00:21:48 +0000979 // If the previous branch is conditional and both conditions go to the same
Chris Lattner2d47bd92006-10-21 05:43:30 +0000980 // destination, remove the branch, replacing it with an unconditional one or
981 // a fall-through.
Chris Lattner7821a8a2006-10-14 00:21:48 +0000982 if (PriorTBB && PriorTBB == PriorFBB) {
Chris Lattner386e2902006-10-21 05:08:28 +0000983 TII->RemoveBranch(PrevBB);
Dan Gohman4e3f1252009-11-11 18:38:14 +0000984 PriorCond.clear();
Chris Lattner7d097842006-10-24 01:12:32 +0000985 if (PriorTBB != MBB)
Chris Lattner386e2902006-10-21 05:08:28 +0000986 TII->InsertBranch(PrevBB, PriorTBB, 0, PriorCond);
Chris Lattner7821a8a2006-10-14 00:21:48 +0000987 MadeChange = true;
Chris Lattner12143052006-10-21 00:47:49 +0000988 ++NumBranchOpts;
Dan Gohman2210c0b2009-11-11 19:48:59 +0000989 goto ReoptimizeBlock;
Chris Lattner7821a8a2006-10-14 00:21:48 +0000990 }
Dan Gohman4e3f1252009-11-11 18:38:14 +0000991
Dan Gohman2210c0b2009-11-11 19:48:59 +0000992 // If the previous block unconditionally falls through to this block and
993 // this block has no other predecessors, move the contents of this block
994 // into the prior block. This doesn't usually happen when SimplifyCFG
Bob Wilson465c8252009-11-17 17:40:31 +0000995 // has been used, but it can happen if tail merging splits a fall-through
996 // predecessor of a block.
Dan Gohman2210c0b2009-11-11 19:48:59 +0000997 // This has to check PrevBB->succ_size() because EH edges are ignored by
998 // AnalyzeBranch.
999 if (PriorCond.empty() && !PriorTBB && MBB->pred_size() == 1 &&
1000 PrevBB.succ_size() == 1 &&
1001 !MBB->hasAddressTaken()) {
1002 DEBUG(errs() << "\nMerging into block: " << PrevBB
1003 << "From MBB: " << *MBB);
1004 PrevBB.splice(PrevBB.end(), MBB, MBB->begin(), MBB->end());
1005 PrevBB.removeSuccessor(PrevBB.succ_begin());;
1006 assert(PrevBB.succ_empty());
1007 PrevBB.transferSuccessors(MBB);
1008 MadeChange = true;
1009 return MadeChange;
1010 }
Bob Wilson3cbc3122009-11-16 17:56:13 +00001011
Chris Lattner7821a8a2006-10-14 00:21:48 +00001012 // If the previous branch *only* branches to *this* block (conditional or
1013 // not) remove the branch.
Chris Lattner7d097842006-10-24 01:12:32 +00001014 if (PriorTBB == MBB && PriorFBB == 0) {
Chris Lattner386e2902006-10-21 05:08:28 +00001015 TII->RemoveBranch(PrevBB);
Chris Lattner7821a8a2006-10-14 00:21:48 +00001016 MadeChange = true;
Chris Lattner12143052006-10-21 00:47:49 +00001017 ++NumBranchOpts;
Dan Gohman2210c0b2009-11-11 19:48:59 +00001018 goto ReoptimizeBlock;
Chris Lattner7821a8a2006-10-14 00:21:48 +00001019 }
Dan Gohman4e3f1252009-11-11 18:38:14 +00001020
Chris Lattner2d47bd92006-10-21 05:43:30 +00001021 // If the prior block branches somewhere else on the condition and here if
1022 // the condition is false, remove the uncond second branch.
Chris Lattner7d097842006-10-24 01:12:32 +00001023 if (PriorFBB == MBB) {
Chris Lattner2d47bd92006-10-21 05:43:30 +00001024 TII->RemoveBranch(PrevBB);
1025 TII->InsertBranch(PrevBB, PriorTBB, 0, PriorCond);
1026 MadeChange = true;
1027 ++NumBranchOpts;
Dan Gohman2210c0b2009-11-11 19:48:59 +00001028 goto ReoptimizeBlock;
Chris Lattner2d47bd92006-10-21 05:43:30 +00001029 }
Dan Gohman4e3f1252009-11-11 18:38:14 +00001030
Chris Lattnera2d79952006-10-21 05:54:00 +00001031 // If the prior block branches here on true and somewhere else on false, and
1032 // if the branch condition is reversible, reverse the branch to create a
1033 // fall-through.
Chris Lattner7d097842006-10-24 01:12:32 +00001034 if (PriorTBB == MBB) {
Owen Anderson44eb65c2008-08-14 22:49:33 +00001035 SmallVector<MachineOperand, 4> NewPriorCond(PriorCond);
Chris Lattnera2d79952006-10-21 05:54:00 +00001036 if (!TII->ReverseBranchCondition(NewPriorCond)) {
1037 TII->RemoveBranch(PrevBB);
1038 TII->InsertBranch(PrevBB, PriorFBB, 0, NewPriorCond);
1039 MadeChange = true;
1040 ++NumBranchOpts;
Dan Gohman2210c0b2009-11-11 19:48:59 +00001041 goto ReoptimizeBlock;
Chris Lattnera2d79952006-10-21 05:54:00 +00001042 }
1043 }
Dan Gohman4e3f1252009-11-11 18:38:14 +00001044
Dan Gohman6d312682009-10-22 00:03:58 +00001045 // If this block has no successors (e.g. it is a return block or ends with
1046 // a call to a no-return function like abort or __cxa_throw) and if the pred
1047 // falls through into this block, and if it would otherwise fall through
1048 // into the block after this, move this block to the end of the function.
Chris Lattner154e1042006-11-18 21:30:35 +00001049 //
Chris Lattnera7bef4a2006-11-18 20:47:54 +00001050 // We consider it more likely that execution will stay in the function (e.g.
1051 // due to loops) than it is to exit it. This asserts in loops etc, moving
1052 // the assert condition out of the loop body.
Dan Gohman6d312682009-10-22 00:03:58 +00001053 if (MBB->succ_empty() && !PriorCond.empty() && PriorFBB == 0 &&
Chris Lattner154e1042006-11-18 21:30:35 +00001054 MachineFunction::iterator(PriorTBB) == FallThrough &&
Bob Wilson15acadd2009-11-26 00:32:21 +00001055 !MBB->canFallThrough()) {
Chris Lattnerf10a56a2006-11-18 21:56:39 +00001056 bool DoTransform = true;
Dan Gohman4e3f1252009-11-11 18:38:14 +00001057
Chris Lattnera7bef4a2006-11-18 20:47:54 +00001058 // We have to be careful that the succs of PredBB aren't both no-successor
1059 // blocks. If neither have successors and if PredBB is the second from
1060 // last block in the function, we'd just keep swapping the two blocks for
1061 // last. Only do the swap if one is clearly better to fall through than
1062 // the other.
Dan Gohmand1944982009-11-11 18:18:34 +00001063 if (FallThrough == --MF.end() &&
Chris Lattner69244302008-01-07 01:56:04 +00001064 !IsBetterFallthrough(PriorTBB, MBB))
Chris Lattnerf10a56a2006-11-18 21:56:39 +00001065 DoTransform = false;
1066
1067 // We don't want to do this transformation if we have control flow like:
1068 // br cond BB2
1069 // BB1:
1070 // ..
1071 // jmp BBX
1072 // BB2:
1073 // ..
1074 // ret
1075 //
1076 // In this case, we could actually be moving the return block *into* a
1077 // loop!
Chris Lattner4b105912006-11-18 22:25:39 +00001078 if (DoTransform && !MBB->succ_empty() &&
Bob Wilson15acadd2009-11-26 00:32:21 +00001079 (!PriorTBB->canFallThrough() || PriorTBB->empty()))
Chris Lattnerf10a56a2006-11-18 21:56:39 +00001080 DoTransform = false;
Dan Gohman4e3f1252009-11-11 18:38:14 +00001081
1082
Chris Lattnerf10a56a2006-11-18 21:56:39 +00001083 if (DoTransform) {
Chris Lattnera7bef4a2006-11-18 20:47:54 +00001084 // Reverse the branch so we will fall through on the previous true cond.
Owen Anderson44eb65c2008-08-14 22:49:33 +00001085 SmallVector<MachineOperand, 4> NewPriorCond(PriorCond);
Chris Lattnera7bef4a2006-11-18 20:47:54 +00001086 if (!TII->ReverseBranchCondition(NewPriorCond)) {
Bill Wendling3403bcd2009-08-22 20:03:00 +00001087 DEBUG(errs() << "\nMoving MBB: " << *MBB
1088 << "To make fallthrough to: " << *PriorTBB << "\n");
Dan Gohman4e3f1252009-11-11 18:38:14 +00001089
Chris Lattnera7bef4a2006-11-18 20:47:54 +00001090 TII->RemoveBranch(PrevBB);
1091 TII->InsertBranch(PrevBB, MBB, 0, NewPriorCond);
1092
1093 // Move this block to the end of the function.
Dan Gohmand1944982009-11-11 18:18:34 +00001094 MBB->moveAfter(--MF.end());
Chris Lattnera7bef4a2006-11-18 20:47:54 +00001095 MadeChange = true;
1096 ++NumBranchOpts;
Evan Cheng030a0a02009-09-04 07:47:40 +00001097 return MadeChange;
Chris Lattnera7bef4a2006-11-18 20:47:54 +00001098 }
1099 }
1100 }
Chris Lattner7821a8a2006-10-14 00:21:48 +00001101 }
Dan Gohman4e3f1252009-11-11 18:38:14 +00001102
Chris Lattner386e2902006-10-21 05:08:28 +00001103 // Analyze the branch in the current block.
1104 MachineBasicBlock *CurTBB = 0, *CurFBB = 0;
Owen Anderson44eb65c2008-08-14 22:49:33 +00001105 SmallVector<MachineOperand, 4> CurCond;
Evan Chengdc54d312009-02-09 07:14:22 +00001106 bool CurUnAnalyzable= TII->AnalyzeBranch(*MBB, CurTBB, CurFBB, CurCond, true);
Chris Lattner6b0e3f82006-10-29 21:05:41 +00001107 if (!CurUnAnalyzable) {
Chris Lattner386e2902006-10-21 05:08:28 +00001108 // If the CFG for the prior block has extra edges, remove them.
Evan Cheng2bdb7d02007-06-18 22:43:58 +00001109 MadeChange |= MBB->CorrectExtraCFGEdges(CurTBB, CurFBB, !CurCond.empty());
Chris Lattnereb15eee2006-10-13 20:43:10 +00001110
Dan Gohman4e3f1252009-11-11 18:38:14 +00001111 // If this is a two-way branch, and the FBB branches to this block, reverse
Chris Lattner5d056952006-11-08 01:03:21 +00001112 // the condition so the single-basic-block loop is faster. Instead of:
1113 // Loop: xxx; jcc Out; jmp Loop
1114 // we want:
1115 // Loop: xxx; jncc Loop; jmp Out
1116 if (CurTBB && CurFBB && CurFBB == MBB && CurTBB != MBB) {
Owen Anderson44eb65c2008-08-14 22:49:33 +00001117 SmallVector<MachineOperand, 4> NewCond(CurCond);
Chris Lattner5d056952006-11-08 01:03:21 +00001118 if (!TII->ReverseBranchCondition(NewCond)) {
1119 TII->RemoveBranch(*MBB);
1120 TII->InsertBranch(*MBB, CurFBB, CurTBB, NewCond);
1121 MadeChange = true;
1122 ++NumBranchOpts;
Dan Gohman2210c0b2009-11-11 19:48:59 +00001123 goto ReoptimizeBlock;
Chris Lattner5d056952006-11-08 01:03:21 +00001124 }
1125 }
Dan Gohman4e3f1252009-11-11 18:38:14 +00001126
Chris Lattner386e2902006-10-21 05:08:28 +00001127 // If this branch is the only thing in its block, see if we can forward
1128 // other blocks across it.
Dan Gohman4e3f1252009-11-11 18:38:14 +00001129 if (CurTBB && CurCond.empty() && CurFBB == 0 &&
Bob Wilson888acc32009-11-03 23:44:31 +00001130 MBB->begin()->getDesc().isBranch() && CurTBB != MBB &&
1131 !MBB->hasAddressTaken()) {
Chris Lattner386e2902006-10-21 05:08:28 +00001132 // This block may contain just an unconditional branch. Because there can
1133 // be 'non-branch terminators' in the block, try removing the branch and
1134 // then seeing if the block is empty.
1135 TII->RemoveBranch(*MBB);
1136
1137 // If this block is just an unconditional branch to CurTBB, we can
1138 // usually completely eliminate the block. The only case we cannot
1139 // completely eliminate the block is when the block before this one
1140 // falls through into MBB and we can't understand the prior block's branch
1141 // condition.
Chris Lattnercf420cc2006-10-28 17:32:47 +00001142 if (MBB->empty()) {
Dan Gohman864e2ef2009-12-05 00:44:40 +00001143 bool PredHasNoFallThrough = !PrevBB.canFallThrough();
Chris Lattnercf420cc2006-10-28 17:32:47 +00001144 if (PredHasNoFallThrough || !PriorUnAnalyzable ||
1145 !PrevBB.isSuccessor(MBB)) {
1146 // If the prior block falls through into us, turn it into an
1147 // explicit branch to us to make updates simpler.
Dan Gohman4e3f1252009-11-11 18:38:14 +00001148 if (!PredHasNoFallThrough && PrevBB.isSuccessor(MBB) &&
Chris Lattnercf420cc2006-10-28 17:32:47 +00001149 PriorTBB != MBB && PriorFBB != MBB) {
1150 if (PriorTBB == 0) {
Chris Lattner6acfe122006-10-28 18:34:47 +00001151 assert(PriorCond.empty() && PriorFBB == 0 &&
1152 "Bad branch analysis");
Chris Lattnercf420cc2006-10-28 17:32:47 +00001153 PriorTBB = MBB;
1154 } else {
1155 assert(PriorFBB == 0 && "Machine CFG out of date!");
1156 PriorFBB = MBB;
1157 }
1158 TII->RemoveBranch(PrevBB);
1159 TII->InsertBranch(PrevBB, PriorTBB, PriorFBB, PriorCond);
Chris Lattner386e2902006-10-21 05:08:28 +00001160 }
Chris Lattner386e2902006-10-21 05:08:28 +00001161
Chris Lattnercf420cc2006-10-28 17:32:47 +00001162 // Iterate through all the predecessors, revectoring each in-turn.
David Greene8a46d342007-06-29 02:45:24 +00001163 size_t PI = 0;
Chris Lattnercf420cc2006-10-28 17:32:47 +00001164 bool DidChange = false;
1165 bool HasBranchToSelf = false;
David Greene8a46d342007-06-29 02:45:24 +00001166 while(PI != MBB->pred_size()) {
1167 MachineBasicBlock *PMBB = *(MBB->pred_begin() + PI);
1168 if (PMBB == MBB) {
Chris Lattnercf420cc2006-10-28 17:32:47 +00001169 // If this block has an uncond branch to itself, leave it.
1170 ++PI;
1171 HasBranchToSelf = true;
1172 } else {
1173 DidChange = true;
David Greene8a46d342007-06-29 02:45:24 +00001174 PMBB->ReplaceUsesOfBlockWith(MBB, CurTBB);
Dale Johannesenbf06f6a2009-05-11 21:54:13 +00001175 // If this change resulted in PMBB ending in a conditional
1176 // branch where both conditions go to the same destination,
1177 // change this to an unconditional branch (and fix the CFG).
1178 MachineBasicBlock *NewCurTBB = 0, *NewCurFBB = 0;
1179 SmallVector<MachineOperand, 4> NewCurCond;
1180 bool NewCurUnAnalyzable = TII->AnalyzeBranch(*PMBB, NewCurTBB,
1181 NewCurFBB, NewCurCond, true);
1182 if (!NewCurUnAnalyzable && NewCurTBB && NewCurTBB == NewCurFBB) {
1183 TII->RemoveBranch(*PMBB);
Dan Gohman4e3f1252009-11-11 18:38:14 +00001184 NewCurCond.clear();
Dale Johannesenbf06f6a2009-05-11 21:54:13 +00001185 TII->InsertBranch(*PMBB, NewCurTBB, 0, NewCurCond);
1186 MadeChange = true;
1187 ++NumBranchOpts;
Dan Gohman2210c0b2009-11-11 19:48:59 +00001188 PMBB->CorrectExtraCFGEdges(NewCurTBB, 0, false);
Dale Johannesenbf06f6a2009-05-11 21:54:13 +00001189 }
Chris Lattnercf420cc2006-10-28 17:32:47 +00001190 }
Chris Lattner4bc135e2006-10-21 06:11:43 +00001191 }
Chris Lattner386e2902006-10-21 05:08:28 +00001192
Chris Lattnercf420cc2006-10-28 17:32:47 +00001193 // Change any jumptables to go to the new MBB.
Dan Gohmand1944982009-11-11 18:18:34 +00001194 MF.getJumpTableInfo()->ReplaceMBBInJumpTables(MBB, CurTBB);
Chris Lattnercf420cc2006-10-28 17:32:47 +00001195 if (DidChange) {
1196 ++NumBranchOpts;
1197 MadeChange = true;
Evan Cheng030a0a02009-09-04 07:47:40 +00001198 if (!HasBranchToSelf) return MadeChange;
Chris Lattnercf420cc2006-10-28 17:32:47 +00001199 }
Chris Lattner4bc135e2006-10-21 06:11:43 +00001200 }
Chris Lattnereb15eee2006-10-13 20:43:10 +00001201 }
Dan Gohman4e3f1252009-11-11 18:38:14 +00001202
Chris Lattner386e2902006-10-21 05:08:28 +00001203 // Add the branch back if the block is more than just an uncond branch.
1204 TII->InsertBranch(*MBB, CurTBB, 0, CurCond);
Chris Lattner21ab22e2004-07-31 10:01:27 +00001205 }
Chris Lattner6b0e3f82006-10-29 21:05:41 +00001206 }
1207
Bill Wendling43cf6c32009-12-15 00:39:24 +00001208 // If the prior block doesn't fall through into this block, and if this
1209 // block doesn't fall through into some other block, see if we can find a
1210 // place to move this block where a fall-through will happen.
1211 if (!PrevBB.canFallThrough()) {
1212
Bob Wilson56ea69c2009-11-17 17:06:18 +00001213 // Now we know that there was no fall-through into this block, check to
1214 // see if it has a fall-through into its successor.
Bob Wilson15acadd2009-11-26 00:32:21 +00001215 bool CurFallsThru = MBB->canFallThrough();
Bob Wilson56ea69c2009-11-17 17:06:18 +00001216
Jim Laskey02b3f5e2007-02-21 22:42:20 +00001217 if (!MBB->isLandingPad()) {
1218 // Check all the predecessors of this block. If one of them has no fall
1219 // throughs, move this block right after it.
1220 for (MachineBasicBlock::pred_iterator PI = MBB->pred_begin(),
1221 E = MBB->pred_end(); PI != E; ++PI) {
1222 // Analyze the branch at the end of the pred.
1223 MachineBasicBlock *PredBB = *PI;
Bill Wendling43cf6c32009-12-15 00:39:24 +00001224 MachineFunction::iterator PredFallthrough = PredBB; ++PredFallthrough;
Bill Wendling408e9d12009-12-16 00:00:18 +00001225 MachineBasicBlock *PredTBB = 0, *PredFBB = 0;
Dan Gohman2210c0b2009-11-11 19:48:59 +00001226 SmallVector<MachineOperand, 4> PredCond;
Bill Wendling43cf6c32009-12-15 00:39:24 +00001227 if (PredBB != MBB && !PredBB->canFallThrough() &&
1228 !TII->AnalyzeBranch(*PredBB, PredTBB, PredFBB, PredCond, true)
Dale Johannesen76b38fc2007-05-10 01:01:49 +00001229 && (!CurFallsThru || !CurTBB || !CurFBB)
Jim Laskey02b3f5e2007-02-21 22:42:20 +00001230 && (!CurFallsThru || MBB->getNumber() >= PredBB->getNumber())) {
Bill Wendling43cf6c32009-12-15 00:39:24 +00001231 // If the current block doesn't fall through, just move it.
1232 // If the current block can fall through and does not end with a
1233 // conditional branch, we need to append an unconditional jump to
1234 // the (current) next block. To avoid a possible compile-time
1235 // infinite loop, move blocks only backward in this case.
1236 // Also, if there are already 2 branches here, we cannot add a third;
1237 // this means we have the case
1238 // Bcc next
1239 // B elsewhere
1240 // next:
Jim Laskey02b3f5e2007-02-21 22:42:20 +00001241 if (CurFallsThru) {
Bill Wendling43cf6c32009-12-15 00:39:24 +00001242 MachineBasicBlock *NextBB = llvm::next(MachineFunction::iterator(MBB));
Jim Laskey02b3f5e2007-02-21 22:42:20 +00001243 CurCond.clear();
1244 TII->InsertBranch(*MBB, NextBB, 0, CurCond);
1245 }
1246 MBB->moveAfter(PredBB);
1247 MadeChange = true;
Dan Gohman2210c0b2009-11-11 19:48:59 +00001248 goto ReoptimizeBlock;
Chris Lattner7d097842006-10-24 01:12:32 +00001249 }
1250 }
Dale Johannesen6b896ce2007-02-17 00:44:34 +00001251 }
Dan Gohman4e3f1252009-11-11 18:38:14 +00001252
Dale Johannesen6b896ce2007-02-17 00:44:34 +00001253 if (!CurFallsThru) {
Chris Lattner6b0e3f82006-10-29 21:05:41 +00001254 // Check all successors to see if we can move this block before it.
1255 for (MachineBasicBlock::succ_iterator SI = MBB->succ_begin(),
1256 E = MBB->succ_end(); SI != E; ++SI) {
1257 // Analyze the branch at the end of the block before the succ.
1258 MachineBasicBlock *SuccBB = *SI;
1259 MachineFunction::iterator SuccPrev = SuccBB; --SuccPrev;
Dan Gohman4e3f1252009-11-11 18:38:14 +00001260
Chris Lattner77edc4b2007-04-30 23:35:00 +00001261 // If this block doesn't already fall-through to that successor, and if
1262 // the succ doesn't already have a block that can fall through into it,
1263 // and if the successor isn't an EH destination, we can arrange for the
1264 // fallthrough to happen.
Dan Gohman2210c0b2009-11-11 19:48:59 +00001265 if (SuccBB != MBB && &*SuccPrev != MBB &&
Bob Wilson15acadd2009-11-26 00:32:21 +00001266 !SuccPrev->canFallThrough() && !CurUnAnalyzable &&
Chris Lattner77edc4b2007-04-30 23:35:00 +00001267 !SuccBB->isLandingPad()) {
Chris Lattner6b0e3f82006-10-29 21:05:41 +00001268 MBB->moveBefore(SuccBB);
1269 MadeChange = true;
Dan Gohman2210c0b2009-11-11 19:48:59 +00001270 goto ReoptimizeBlock;
Chris Lattner6b0e3f82006-10-29 21:05:41 +00001271 }
1272 }
Dan Gohman4e3f1252009-11-11 18:38:14 +00001273
Chris Lattner6b0e3f82006-10-29 21:05:41 +00001274 // Okay, there is no really great place to put this block. If, however,
1275 // the block before this one would be a fall-through if this block were
1276 // removed, move this block to the end of the function.
Dan Gohman2210c0b2009-11-11 19:48:59 +00001277 MachineBasicBlock *PrevTBB, *PrevFBB;
1278 SmallVector<MachineOperand, 4> PrevCond;
Dan Gohmand1944982009-11-11 18:18:34 +00001279 if (FallThrough != MF.end() &&
Dan Gohman2210c0b2009-11-11 19:48:59 +00001280 !TII->AnalyzeBranch(PrevBB, PrevTBB, PrevFBB, PrevCond, true) &&
Chris Lattner6b0e3f82006-10-29 21:05:41 +00001281 PrevBB.isSuccessor(FallThrough)) {
Dan Gohmand1944982009-11-11 18:18:34 +00001282 MBB->moveAfter(--MF.end());
Chris Lattner6b0e3f82006-10-29 21:05:41 +00001283 MadeChange = true;
Evan Cheng030a0a02009-09-04 07:47:40 +00001284 return MadeChange;
Chris Lattner6b0e3f82006-10-29 21:05:41 +00001285 }
Chris Lattner7d097842006-10-24 01:12:32 +00001286 }
Chris Lattner21ab22e2004-07-31 10:01:27 +00001287 }
Evan Cheng030a0a02009-09-04 07:47:40 +00001288
1289 return MadeChange;
Chris Lattner21ab22e2004-07-31 10:01:27 +00001290}