1 //===-- BranchFolding.cpp - Fold machine code branch instructions ---------===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
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. It also must handle virtual registers for targets that emit virtual
16 // ISA (e.g. NVPTX).
17 //
18 //===----------------------------------------------------------------------===//
19
20 #include "BranchFolding.h"
21 #include "llvm/ADT/STLExtras.h"
22 #include "llvm/ADT/SmallSet.h"
23 #include "llvm/ADT/Statistic.h"
24 #include "llvm/CodeGen/Analysis.h"
25 #include "llvm/CodeGen/MachineBlockFrequencyInfo.h"
26 #include "llvm/CodeGen/MachineBranchProbabilityInfo.h"
27 #include "llvm/CodeGen/MachineFunctionPass.h"
28 #include "llvm/CodeGen/MachineJumpTableInfo.h"
29 #include "llvm/CodeGen/MachineMemOperand.h"
30 #include "llvm/CodeGen/MachineModuleInfo.h"
31 #include "llvm/CodeGen/MachineRegisterInfo.h"
32 #include "llvm/CodeGen/Passes.h"
33 #include "llvm/CodeGen/RegisterScavenging.h"
34 #include "llvm/IR/Function.h"
35 #include "llvm/Support/CommandLine.h"
36 #include "llvm/Support/Debug.h"
37 #include "llvm/Support/ErrorHandling.h"
38 #include "llvm/Support/raw_ostream.h"
39 #include "llvm/Target/TargetInstrInfo.h"
40 #include "llvm/Target/TargetRegisterInfo.h"
41 #include "llvm/Target/TargetSubtargetInfo.h"
42 #include <algorithm>
43 using namespace llvm;
44
45 #define DEBUG_TYPE "branchfolding"
46
47 STATISTIC(NumDeadBlocks, "Number of dead blocks removed");
48 STATISTIC(NumBranchOpts, "Number of branches optimized");
49 STATISTIC(NumTailMerge , "Number of block tails merged");
50 STATISTIC(NumHoist , "Number of times common instructions are hoisted");
51
52 static cl::opt<cl::boolOrDefault> FlagEnableTailMerge("enable-tail-merge",
53 cl::init(cl::BOU_UNSET), cl::Hidden);
54
55 // Throttle for huge numbers of predecessors (compile speed problems)
56 static cl::opt<unsigned>
57 TailMergeThreshold("tail-merge-threshold",
58 cl::desc("Max number of predecessors to consider tail merging"),
59 cl::init(150), cl::Hidden);
60
61 // Heuristic for tail merging (and, inversely, tail duplication).
62 // TODO: This should be replaced with a target query.
63 static cl::opt<unsigned>
64 TailMergeSize("tail-merge-size",
65 cl::desc("Min number of instructions to consider tail merging"),
66 cl::init(3), cl::Hidden);
67
68 namespace {
69 /// BranchFolderPass - Wrap branch folder in a machine function pass.
70 class BranchFolderPass : public MachineFunctionPass {
71 public:
72 static char ID;
BranchFolderPass()73 explicit BranchFolderPass(): MachineFunctionPass(ID) {}
74
75 bool runOnMachineFunction(MachineFunction &MF) override;
76
getAnalysisUsage(AnalysisUsage & AU) const77 void getAnalysisUsage(AnalysisUsage &AU) const override {
78 AU.addRequired<MachineBlockFrequencyInfo>();
79 AU.addRequired<MachineBranchProbabilityInfo>();
80 AU.addRequired<TargetPassConfig>();
81 MachineFunctionPass::getAnalysisUsage(AU);
82 }
83 };
84 }
85
86 char BranchFolderPass::ID = 0;
87 char &llvm::BranchFolderPassID = BranchFolderPass::ID;
88
89 INITIALIZE_PASS(BranchFolderPass, "branch-folder",
90 "Control Flow Optimizer", false, false)
91
runOnMachineFunction(MachineFunction & MF)92 bool BranchFolderPass::runOnMachineFunction(MachineFunction &MF) {
93 if (skipOptnoneFunction(*MF.getFunction()))
94 return false;
95
96 TargetPassConfig *PassConfig = &getAnalysis<TargetPassConfig>();
97 // TailMerge can create jump into if branches that make CFG irreducible for
98 // HW that requires structurized CFG.
99 bool EnableTailMerge = !MF.getTarget().requiresStructuredCFG() &&
100 PassConfig->getEnableTailMerge();
101 BranchFolder Folder(EnableTailMerge, /*CommonHoist=*/true,
102 getAnalysis<MachineBlockFrequencyInfo>(),
103 getAnalysis<MachineBranchProbabilityInfo>());
104 return Folder.OptimizeFunction(MF, MF.getSubtarget().getInstrInfo(),
105 MF.getSubtarget().getRegisterInfo(),
106 getAnalysisIfAvailable<MachineModuleInfo>());
107 }
108
BranchFolder(bool defaultEnableTailMerge,bool CommonHoist,const MachineBlockFrequencyInfo & FreqInfo,const MachineBranchProbabilityInfo & ProbInfo)109 BranchFolder::BranchFolder(bool defaultEnableTailMerge, bool CommonHoist,
110 const MachineBlockFrequencyInfo &FreqInfo,
111 const MachineBranchProbabilityInfo &ProbInfo)
112 : EnableHoistCommonCode(CommonHoist), MBBFreqInfo(FreqInfo),
113 MBPI(ProbInfo) {
114 switch (FlagEnableTailMerge) {
115 case cl::BOU_UNSET: EnableTailMerge = defaultEnableTailMerge; break;
116 case cl::BOU_TRUE: EnableTailMerge = true; break;
117 case cl::BOU_FALSE: EnableTailMerge = false; break;
118 }
119 }
120
121 /// RemoveDeadBlock - Remove the specified dead machine basic block from the
122 /// function, updating the CFG.
RemoveDeadBlock(MachineBasicBlock * MBB)123 void BranchFolder::RemoveDeadBlock(MachineBasicBlock *MBB) {
124 assert(MBB->pred_empty() && "MBB must be dead!");
125 DEBUG(dbgs() << "\nRemoving MBB: " << *MBB);
126
127 MachineFunction *MF = MBB->getParent();
128 // drop all successors.
129 while (!MBB->succ_empty())
130 MBB->removeSuccessor(MBB->succ_end()-1);
131
132 // Avoid matching if this pointer gets reused.
133 TriedMerging.erase(MBB);
134
135 // Remove the block.
136 MF->erase(MBB);
137 FuncletMembership.erase(MBB);
138 }
139
140 /// OptimizeImpDefsBlock - If a basic block is just a bunch of implicit_def
141 /// followed by terminators, and if the implicitly defined registers are not
142 /// used by the terminators, remove those implicit_def's. e.g.
143 /// BB1:
144 /// r0 = implicit_def
145 /// r1 = implicit_def
146 /// br
147 /// This block can be optimized away later if the implicit instructions are
148 /// removed.
OptimizeImpDefsBlock(MachineBasicBlock * MBB)149 bool BranchFolder::OptimizeImpDefsBlock(MachineBasicBlock *MBB) {
150 SmallSet<unsigned, 4> ImpDefRegs;
151 MachineBasicBlock::iterator I = MBB->begin();
152 while (I != MBB->end()) {
153 if (!I->isImplicitDef())
154 break;
155 unsigned Reg = I->getOperand(0).getReg();
156 if (TargetRegisterInfo::isPhysicalRegister(Reg)) {
157 for (MCSubRegIterator SubRegs(Reg, TRI, /*IncludeSelf=*/true);
158 SubRegs.isValid(); ++SubRegs)
159 ImpDefRegs.insert(*SubRegs);
160 } else {
161 ImpDefRegs.insert(Reg);
162 }
163 ++I;
164 }
165 if (ImpDefRegs.empty())
166 return false;
167
168 MachineBasicBlock::iterator FirstTerm = I;
169 while (I != MBB->end()) {
170 if (!TII->isUnpredicatedTerminator(I))
171 return false;
172 // See if it uses any of the implicitly defined registers.
173 for (const MachineOperand &MO : I->operands()) {
174 if (!MO.isReg() || !MO.isUse())
175 continue;
176 unsigned Reg = MO.getReg();
177 if (ImpDefRegs.count(Reg))
178 return false;
179 }
180 ++I;
181 }
182
183 I = MBB->begin();
184 while (I != FirstTerm) {
185 MachineInstr *ImpDefMI = &*I;
186 ++I;
187 MBB->erase(ImpDefMI);
188 }
189
190 return true;
191 }
192
193 /// OptimizeFunction - Perhaps branch folding, tail merging and other
194 /// CFG optimizations on the given function.
OptimizeFunction(MachineFunction & MF,const TargetInstrInfo * tii,const TargetRegisterInfo * tri,MachineModuleInfo * mmi)195 bool BranchFolder::OptimizeFunction(MachineFunction &MF,
196 const TargetInstrInfo *tii,
197 const TargetRegisterInfo *tri,
198 MachineModuleInfo *mmi) {
199 if (!tii) return false;
200
201 TriedMerging.clear();
202
203 TII = tii;
204 TRI = tri;
205 MMI = mmi;
206 RS = nullptr;
207
208 // Use a RegScavenger to help update liveness when required.
209 MachineRegisterInfo &MRI = MF.getRegInfo();
210 if (MRI.tracksLiveness() && TRI->trackLivenessAfterRegAlloc(MF))
211 RS = new RegScavenger();
212 else
213 MRI.invalidateLiveness();
214
215 // Fix CFG. The later algorithms expect it to be right.
216 bool MadeChange = false;
217 for (MachineBasicBlock &MBB : MF) {
218 MachineBasicBlock *TBB = nullptr, *FBB = nullptr;
219 SmallVector<MachineOperand, 4> Cond;
220 if (!TII->AnalyzeBranch(MBB, TBB, FBB, Cond, true))
221 MadeChange |= MBB.CorrectExtraCFGEdges(TBB, FBB, !Cond.empty());
222 MadeChange |= OptimizeImpDefsBlock(&MBB);
223 }
224
225 // Recalculate funclet membership.
226 FuncletMembership = getFuncletMembership(MF);
227
228 bool MadeChangeThisIteration = true;
229 while (MadeChangeThisIteration) {
230 MadeChangeThisIteration = TailMergeBlocks(MF);
231 MadeChangeThisIteration |= OptimizeBranches(MF);
232 if (EnableHoistCommonCode)
233 MadeChangeThisIteration |= HoistCommonCode(MF);
234 MadeChange |= MadeChangeThisIteration;
235 }
236
237 // See if any jump tables have become dead as the code generator
238 // did its thing.
239 MachineJumpTableInfo *JTI = MF.getJumpTableInfo();
240 if (!JTI) {
241 delete RS;
242 return MadeChange;
243 }
244
245 // Walk the function to find jump tables that are live.
246 BitVector JTIsLive(JTI->getJumpTables().size());
247 for (const MachineBasicBlock &BB : MF) {
248 for (const MachineInstr &I : BB)
249 for (const MachineOperand &Op : I.operands()) {
250 if (!Op.isJTI()) continue;
251
252 // Remember that this JT is live.
253 JTIsLive.set(Op.getIndex());
254 }
255 }
256
257 // Finally, remove dead jump tables. This happens when the
258 // indirect jump was unreachable (and thus deleted).
259 for (unsigned i = 0, e = JTIsLive.size(); i != e; ++i)
260 if (!JTIsLive.test(i)) {
261 JTI->RemoveJumpTable(i);
262 MadeChange = true;
263 }
264
265 delete RS;
266 return MadeChange;
267 }
268
269 //===----------------------------------------------------------------------===//
270 // Tail Merging of Blocks
271 //===----------------------------------------------------------------------===//
272
273 /// HashMachineInstr - Compute a hash value for MI and its operands.
HashMachineInstr(const MachineInstr * MI)274 static unsigned HashMachineInstr(const MachineInstr *MI) {
275 unsigned Hash = MI->getOpcode();
276 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
277 const MachineOperand &Op = MI->getOperand(i);
278
279 // Merge in bits from the operand if easy. We can't use MachineOperand's
280 // hash_code here because it's not deterministic and we sort by hash value
281 // later.
282 unsigned OperandHash = 0;
283 switch (Op.getType()) {
284 case MachineOperand::MO_Register:
285 OperandHash = Op.getReg();
286 break;
287 case MachineOperand::MO_Immediate:
288 OperandHash = Op.getImm();
289 break;
290 case MachineOperand::MO_MachineBasicBlock:
291 OperandHash = Op.getMBB()->getNumber();
292 break;
293 case MachineOperand::MO_FrameIndex:
294 case MachineOperand::MO_ConstantPoolIndex:
295 case MachineOperand::MO_JumpTableIndex:
296 OperandHash = Op.getIndex();
297 break;
298 case MachineOperand::MO_GlobalAddress:
299 case MachineOperand::MO_ExternalSymbol:
300 // Global address / external symbol are too hard, don't bother, but do
301 // pull in the offset.
302 OperandHash = Op.getOffset();
303 break;
304 default:
305 break;
306 }
307
308 Hash += ((OperandHash << 3) | Op.getType()) << (i & 31);
309 }
310 return Hash;
311 }
312
313 /// HashEndOfMBB - Hash the last instruction in the MBB.
HashEndOfMBB(const MachineBasicBlock * MBB)314 static unsigned HashEndOfMBB(const MachineBasicBlock *MBB) {
315 MachineBasicBlock::const_iterator I = MBB->getLastNonDebugInstr();
316 if (I == MBB->end())
317 return 0;
318
319 return HashMachineInstr(I);
320 }
321
322 /// ComputeCommonTailLength - Given two machine basic blocks, compute the number
323 /// of instructions they actually have in common together at their end. Return
324 /// iterators for the first shared instruction in each block.
ComputeCommonTailLength(MachineBasicBlock * MBB1,MachineBasicBlock * MBB2,MachineBasicBlock::iterator & I1,MachineBasicBlock::iterator & I2)325 static unsigned ComputeCommonTailLength(MachineBasicBlock *MBB1,
326 MachineBasicBlock *MBB2,
327 MachineBasicBlock::iterator &I1,
328 MachineBasicBlock::iterator &I2) {
329 I1 = MBB1->end();
330 I2 = MBB2->end();
331
332 unsigned TailLen = 0;
333 while (I1 != MBB1->begin() && I2 != MBB2->begin()) {
334 --I1; --I2;
335 // Skip debugging pseudos; necessary to avoid changing the code.
336 while (I1->isDebugValue()) {
337 if (I1==MBB1->begin()) {
338 while (I2->isDebugValue()) {
339 if (I2==MBB2->begin())
340 // I1==DBG at begin; I2==DBG at begin
341 return TailLen;
342 --I2;
343 }
344 ++I2;
345 // I1==DBG at begin; I2==non-DBG, or first of DBGs not at begin
346 return TailLen;
347 }
348 --I1;
349 }
350 // I1==first (untested) non-DBG preceding known match
351 while (I2->isDebugValue()) {
352 if (I2==MBB2->begin()) {
353 ++I1;
354 // I1==non-DBG, or first of DBGs not at begin; I2==DBG at begin
355 return TailLen;
356 }
357 --I2;
358 }
359 // I1, I2==first (untested) non-DBGs preceding known match
360 if (!I1->isIdenticalTo(I2) ||
361 // FIXME: This check is dubious. It's used to get around a problem where
362 // people incorrectly expect inline asm directives to remain in the same
363 // relative order. This is untenable because normal compiler
364 // optimizations (like this one) may reorder and/or merge these
365 // directives.
366 I1->isInlineAsm()) {
367 ++I1; ++I2;
368 break;
369 }
370 ++TailLen;
371 }
372 // Back past possible debugging pseudos at beginning of block. This matters
373 // when one block differs from the other only by whether debugging pseudos
374 // are present at the beginning. (This way, the various checks later for
375 // I1==MBB1->begin() work as expected.)
376 if (I1 == MBB1->begin() && I2 != MBB2->begin()) {
377 --I2;
378 while (I2->isDebugValue()) {
379 if (I2 == MBB2->begin())
380 return TailLen;
381 --I2;
382 }
383 ++I2;
384 }
385 if (I2 == MBB2->begin() && I1 != MBB1->begin()) {
386 --I1;
387 while (I1->isDebugValue()) {
388 if (I1 == MBB1->begin())
389 return TailLen;
390 --I1;
391 }
392 ++I1;
393 }
394 return TailLen;
395 }
396
MaintainLiveIns(MachineBasicBlock * CurMBB,MachineBasicBlock * NewMBB)397 void BranchFolder::MaintainLiveIns(MachineBasicBlock *CurMBB,
398 MachineBasicBlock *NewMBB) {
399 if (RS) {
400 RS->enterBasicBlock(CurMBB);
401 if (!CurMBB->empty())
402 RS->forward(std::prev(CurMBB->end()));
403 for (unsigned int i = 1, e = TRI->getNumRegs(); i != e; i++)
404 if (RS->isRegUsed(i, false))
405 NewMBB->addLiveIn(i);
406 }
407 }
408
409 /// ReplaceTailWithBranchTo - Delete the instruction OldInst and everything
410 /// after it, replacing it with an unconditional branch to NewDest.
ReplaceTailWithBranchTo(MachineBasicBlock::iterator OldInst,MachineBasicBlock * NewDest)411 void BranchFolder::ReplaceTailWithBranchTo(MachineBasicBlock::iterator OldInst,
412 MachineBasicBlock *NewDest) {
413 MachineBasicBlock *CurMBB = OldInst->getParent();
414
415 TII->ReplaceTailWithBranchTo(OldInst, NewDest);
416
417 // For targets that use the register scavenger, we must maintain LiveIns.
418 MaintainLiveIns(CurMBB, NewDest);
419
420 ++NumTailMerge;
421 }
422
423 /// SplitMBBAt - Given a machine basic block and an iterator into it, split the
424 /// MBB so that the part before the iterator falls into the part starting at the
425 /// iterator. This returns the new MBB.
SplitMBBAt(MachineBasicBlock & CurMBB,MachineBasicBlock::iterator BBI1,const BasicBlock * BB)426 MachineBasicBlock *BranchFolder::SplitMBBAt(MachineBasicBlock &CurMBB,
427 MachineBasicBlock::iterator BBI1,
428 const BasicBlock *BB) {
429 if (!TII->isLegalToSplitMBBAt(CurMBB, BBI1))
430 return nullptr;
431
432 MachineFunction &MF = *CurMBB.getParent();
433
434 // Create the fall-through block.
435 MachineFunction::iterator MBBI = CurMBB.getIterator();
436 MachineBasicBlock *NewMBB =MF.CreateMachineBasicBlock(BB);
437 CurMBB.getParent()->insert(++MBBI, NewMBB);
438
439 // Move all the successors of this block to the specified block.
440 NewMBB->transferSuccessors(&CurMBB);
441
442 // Add an edge from CurMBB to NewMBB for the fall-through.
443 CurMBB.addSuccessor(NewMBB);
444
445 // Splice the code over.
446 NewMBB->splice(NewMBB->end(), &CurMBB, BBI1, CurMBB.end());
447
448 // NewMBB inherits CurMBB's block frequency.
449 MBBFreqInfo.setBlockFreq(NewMBB, MBBFreqInfo.getBlockFreq(&CurMBB));
450
451 // For targets that use the register scavenger, we must maintain LiveIns.
452 MaintainLiveIns(&CurMBB, NewMBB);
453
454 // Add the new block to the funclet.
455 const auto &FuncletI = FuncletMembership.find(&CurMBB);
456 if (FuncletI != FuncletMembership.end())
457 FuncletMembership[NewMBB] = FuncletI->second;
458
459 return NewMBB;
460 }
461
462 /// EstimateRuntime - Make a rough estimate for how long it will take to run
463 /// the specified code.
EstimateRuntime(MachineBasicBlock::iterator I,MachineBasicBlock::iterator E)464 static unsigned EstimateRuntime(MachineBasicBlock::iterator I,
465 MachineBasicBlock::iterator E) {
466 unsigned Time = 0;
467 for (; I != E; ++I) {
468 if (I->isDebugValue())
469 continue;
470 if (I->isCall())
471 Time += 10;
472 else if (I->mayLoad() || I->mayStore())
473 Time += 2;
474 else
475 ++Time;
476 }
477 return Time;
478 }
479
480 // CurMBB needs to add an unconditional branch to SuccMBB (we removed these
481 // branches temporarily for tail merging). In the case where CurMBB ends
482 // with a conditional branch to the next block, optimize by reversing the
483 // test and conditionally branching to SuccMBB instead.
FixTail(MachineBasicBlock * CurMBB,MachineBasicBlock * SuccBB,const TargetInstrInfo * TII)484 static void FixTail(MachineBasicBlock *CurMBB, MachineBasicBlock *SuccBB,
485 const TargetInstrInfo *TII) {
486 MachineFunction *MF = CurMBB->getParent();
487 MachineFunction::iterator I = std::next(MachineFunction::iterator(CurMBB));
488 MachineBasicBlock *TBB = nullptr, *FBB = nullptr;
489 SmallVector<MachineOperand, 4> Cond;
490 DebugLoc dl; // FIXME: this is nowhere
491 if (I != MF->end() &&
492 !TII->AnalyzeBranch(*CurMBB, TBB, FBB, Cond, true)) {
493 MachineBasicBlock *NextBB = &*I;
494 if (TBB == NextBB && !Cond.empty() && !FBB) {
495 if (!TII->ReverseBranchCondition(Cond)) {
496 TII->RemoveBranch(*CurMBB);
497 TII->InsertBranch(*CurMBB, SuccBB, nullptr, Cond, dl);
498 return;
499 }
500 }
501 }
502 TII->InsertBranch(*CurMBB, SuccBB, nullptr,
503 SmallVector<MachineOperand, 0>(), dl);
504 }
505
506 bool
operator <(const MergePotentialsElt & o) const507 BranchFolder::MergePotentialsElt::operator<(const MergePotentialsElt &o) const {
508 if (getHash() < o.getHash())
509 return true;
510 if (getHash() > o.getHash())
511 return false;
512 if (getBlock()->getNumber() < o.getBlock()->getNumber())
513 return true;
514 if (getBlock()->getNumber() > o.getBlock()->getNumber())
515 return false;
516 // _GLIBCXX_DEBUG checks strict weak ordering, which involves comparing
517 // an object with itself.
518 #ifndef _GLIBCXX_DEBUG
519 llvm_unreachable("Predecessor appears twice");
520 #else
521 return false;
522 #endif
523 }
524
525 BlockFrequency
getBlockFreq(const MachineBasicBlock * MBB) const526 BranchFolder::MBFIWrapper::getBlockFreq(const MachineBasicBlock *MBB) const {
527 auto I = MergedBBFreq.find(MBB);
528
529 if (I != MergedBBFreq.end())
530 return I->second;
531
532 return MBFI.getBlockFreq(MBB);
533 }
534
setBlockFreq(const MachineBasicBlock * MBB,BlockFrequency F)535 void BranchFolder::MBFIWrapper::setBlockFreq(const MachineBasicBlock *MBB,
536 BlockFrequency F) {
537 MergedBBFreq[MBB] = F;
538 }
539
540 /// CountTerminators - Count the number of terminators in the given
541 /// block and set I to the position of the first non-terminator, if there
542 /// is one, or MBB->end() otherwise.
CountTerminators(MachineBasicBlock * MBB,MachineBasicBlock::iterator & I)543 static unsigned CountTerminators(MachineBasicBlock *MBB,
544 MachineBasicBlock::iterator &I) {
545 I = MBB->end();
546 unsigned NumTerms = 0;
547 for (;;) {
548 if (I == MBB->begin()) {
549 I = MBB->end();
550 break;
551 }
552 --I;
553 if (!I->isTerminator()) break;
554 ++NumTerms;
555 }
556 return NumTerms;
557 }
558
559 /// ProfitableToMerge - Check if two machine basic blocks have a common tail
560 /// and decide if it would be profitable to merge those tails. Return the
561 /// length of the common tail and iterators to the first common instruction
562 /// in each block.
563 static bool
ProfitableToMerge(MachineBasicBlock * MBB1,MachineBasicBlock * MBB2,unsigned minCommonTailLength,unsigned & CommonTailLen,MachineBasicBlock::iterator & I1,MachineBasicBlock::iterator & I2,MachineBasicBlock * SuccBB,MachineBasicBlock * PredBB,DenseMap<const MachineBasicBlock *,int> & FuncletMembership)564 ProfitableToMerge(MachineBasicBlock *MBB1, MachineBasicBlock *MBB2,
565 unsigned minCommonTailLength, unsigned &CommonTailLen,
566 MachineBasicBlock::iterator &I1,
567 MachineBasicBlock::iterator &I2, MachineBasicBlock *SuccBB,
568 MachineBasicBlock *PredBB,
569 DenseMap<const MachineBasicBlock *, int> &FuncletMembership) {
570 // It is never profitable to tail-merge blocks from two different funclets.
571 if (!FuncletMembership.empty()) {
572 auto Funclet1 = FuncletMembership.find(MBB1);
573 assert(Funclet1 != FuncletMembership.end());
574 auto Funclet2 = FuncletMembership.find(MBB2);
575 assert(Funclet2 != FuncletMembership.end());
576 if (Funclet1->second != Funclet2->second)
577 return false;
578 }
579
580 CommonTailLen = ComputeCommonTailLength(MBB1, MBB2, I1, I2);
581 if (CommonTailLen == 0)
582 return false;
583 DEBUG(dbgs() << "Common tail length of BB#" << MBB1->getNumber()
584 << " and BB#" << MBB2->getNumber() << " is " << CommonTailLen
585 << '\n');
586
587 // It's almost always profitable to merge any number of non-terminator
588 // instructions with the block that falls through into the common successor.
589 if (MBB1 == PredBB || MBB2 == PredBB) {
590 MachineBasicBlock::iterator I;
591 unsigned NumTerms = CountTerminators(MBB1 == PredBB ? MBB2 : MBB1, I);
592 if (CommonTailLen > NumTerms)
593 return true;
594 }
595
596 // If one of the blocks can be completely merged and happens to be in
597 // a position where the other could fall through into it, merge any number
598 // of instructions, because it can be done without a branch.
599 // TODO: If the blocks are not adjacent, move one of them so that they are?
600 if (MBB1->isLayoutSuccessor(MBB2) && I2 == MBB2->begin())
601 return true;
602 if (MBB2->isLayoutSuccessor(MBB1) && I1 == MBB1->begin())
603 return true;
604
605 // If both blocks have an unconditional branch temporarily stripped out,
606 // count that as an additional common instruction for the following
607 // heuristics.
608 unsigned EffectiveTailLen = CommonTailLen;
609 if (SuccBB && MBB1 != PredBB && MBB2 != PredBB &&
610 !MBB1->back().isBarrier() &&
611 !MBB2->back().isBarrier())
612 ++EffectiveTailLen;
613
614 // Check if the common tail is long enough to be worthwhile.
615 if (EffectiveTailLen >= minCommonTailLength)
616 return true;
617
618 // If we are optimizing for code size, 2 instructions in common is enough if
619 // we don't have to split a block. At worst we will be introducing 1 new
620 // branch instruction, which is likely to be smaller than the 2
621 // instructions that would be deleted in the merge.
622 MachineFunction *MF = MBB1->getParent();
623 return EffectiveTailLen >= 2 && MF->getFunction()->optForSize() &&
624 (I1 == MBB1->begin() || I2 == MBB2->begin());
625 }
626
627 /// ComputeSameTails - Look through all the blocks in MergePotentials that have
628 /// hash CurHash (guaranteed to match the last element). Build the vector
629 /// SameTails of all those that have the (same) largest number of instructions
630 /// in common of any pair of these blocks. SameTails entries contain an
631 /// iterator into MergePotentials (from which the MachineBasicBlock can be
632 /// found) and a MachineBasicBlock::iterator into that MBB indicating the
633 /// instruction where the matching code sequence begins.
634 /// Order of elements in SameTails is the reverse of the order in which
635 /// those blocks appear in MergePotentials (where they are not necessarily
636 /// consecutive).
ComputeSameTails(unsigned CurHash,unsigned minCommonTailLength,MachineBasicBlock * SuccBB,MachineBasicBlock * PredBB)637 unsigned BranchFolder::ComputeSameTails(unsigned CurHash,
638 unsigned minCommonTailLength,
639 MachineBasicBlock *SuccBB,
640 MachineBasicBlock *PredBB) {
641 unsigned maxCommonTailLength = 0U;
642 SameTails.clear();
643 MachineBasicBlock::iterator TrialBBI1, TrialBBI2;
644 MPIterator HighestMPIter = std::prev(MergePotentials.end());
645 for (MPIterator CurMPIter = std::prev(MergePotentials.end()),
646 B = MergePotentials.begin();
647 CurMPIter != B && CurMPIter->getHash() == CurHash; --CurMPIter) {
648 for (MPIterator I = std::prev(CurMPIter); I->getHash() == CurHash; --I) {
649 unsigned CommonTailLen;
650 if (ProfitableToMerge(CurMPIter->getBlock(), I->getBlock(),
651 minCommonTailLength,
652 CommonTailLen, TrialBBI1, TrialBBI2,
653 SuccBB, PredBB,
654 FuncletMembership)) {
655 if (CommonTailLen > maxCommonTailLength) {
656 SameTails.clear();
657 maxCommonTailLength = CommonTailLen;
658 HighestMPIter = CurMPIter;
659 SameTails.push_back(SameTailElt(CurMPIter, TrialBBI1));
660 }
661 if (HighestMPIter == CurMPIter &&
662 CommonTailLen == maxCommonTailLength)
663 SameTails.push_back(SameTailElt(I, TrialBBI2));
664 }
665 if (I == B)
666 break;
667 }
668 }
669 return maxCommonTailLength;
670 }
671
672 /// RemoveBlocksWithHash - Remove all blocks with hash CurHash from
673 /// MergePotentials, restoring branches at ends of blocks as appropriate.
RemoveBlocksWithHash(unsigned CurHash,MachineBasicBlock * SuccBB,MachineBasicBlock * PredBB)674 void BranchFolder::RemoveBlocksWithHash(unsigned CurHash,
675 MachineBasicBlock *SuccBB,
676 MachineBasicBlock *PredBB) {
677 MPIterator CurMPIter, B;
678 for (CurMPIter = std::prev(MergePotentials.end()),
679 B = MergePotentials.begin();
680 CurMPIter->getHash() == CurHash; --CurMPIter) {
681 // Put the unconditional branch back, if we need one.
682 MachineBasicBlock *CurMBB = CurMPIter->getBlock();
683 if (SuccBB && CurMBB != PredBB)
684 FixTail(CurMBB, SuccBB, TII);
685 if (CurMPIter == B)
686 break;
687 }
688 if (CurMPIter->getHash() != CurHash)
689 CurMPIter++;
690 MergePotentials.erase(CurMPIter, MergePotentials.end());
691 }
692
693 /// CreateCommonTailOnlyBlock - None of the blocks to be tail-merged consist
694 /// only of the common tail. Create a block that does by splitting one.
CreateCommonTailOnlyBlock(MachineBasicBlock * & PredBB,MachineBasicBlock * SuccBB,unsigned maxCommonTailLength,unsigned & commonTailIndex)695 bool BranchFolder::CreateCommonTailOnlyBlock(MachineBasicBlock *&PredBB,
696 MachineBasicBlock *SuccBB,
697 unsigned maxCommonTailLength,
698 unsigned &commonTailIndex) {
699 commonTailIndex = 0;
700 unsigned TimeEstimate = ~0U;
701 for (unsigned i = 0, e = SameTails.size(); i != e; ++i) {
702 // Use PredBB if possible; that doesn't require a new branch.
703 if (SameTails[i].getBlock() == PredBB) {
704 commonTailIndex = i;
705 break;
706 }
707 // Otherwise, make a (fairly bogus) choice based on estimate of
708 // how long it will take the various blocks to execute.
709 unsigned t = EstimateRuntime(SameTails[i].getBlock()->begin(),
710 SameTails[i].getTailStartPos());
711 if (t <= TimeEstimate) {
712 TimeEstimate = t;
713 commonTailIndex = i;
714 }
715 }
716
717 MachineBasicBlock::iterator BBI =
718 SameTails[commonTailIndex].getTailStartPos();
719 MachineBasicBlock *MBB = SameTails[commonTailIndex].getBlock();
720
721 // If the common tail includes any debug info we will take it pretty
722 // randomly from one of the inputs. Might be better to remove it?
723 DEBUG(dbgs() << "\nSplitting BB#" << MBB->getNumber() << ", size "
724 << maxCommonTailLength);
725
726 // If the split block unconditionally falls-thru to SuccBB, it will be
727 // merged. In control flow terms it should then take SuccBB's name. e.g. If
728 // SuccBB is an inner loop, the common tail is still part of the inner loop.
729 const BasicBlock *BB = (SuccBB && MBB->succ_size() == 1) ?
730 SuccBB->getBasicBlock() : MBB->getBasicBlock();
731 MachineBasicBlock *newMBB = SplitMBBAt(*MBB, BBI, BB);
732 if (!newMBB) {
733 DEBUG(dbgs() << "... failed!");
734 return false;
735 }
736
737 SameTails[commonTailIndex].setBlock(newMBB);
738 SameTails[commonTailIndex].setTailStartPos(newMBB->begin());
739
740 // If we split PredBB, newMBB is the new predecessor.
741 if (PredBB == MBB)
742 PredBB = newMBB;
743
744 return true;
745 }
746
hasIdenticalMMOs(const MachineInstr * MI1,const MachineInstr * MI2)747 static bool hasIdenticalMMOs(const MachineInstr *MI1, const MachineInstr *MI2) {
748 auto I1 = MI1->memoperands_begin(), E1 = MI1->memoperands_end();
749 auto I2 = MI2->memoperands_begin(), E2 = MI2->memoperands_end();
750 if ((E1 - I1) != (E2 - I2))
751 return false;
752 for (; I1 != E1; ++I1, ++I2) {
753 if (**I1 != **I2)
754 return false;
755 }
756 return true;
757 }
758
759 static void
removeMMOsFromMemoryOperations(MachineBasicBlock::iterator MBBIStartPos,MachineBasicBlock & MBBCommon)760 removeMMOsFromMemoryOperations(MachineBasicBlock::iterator MBBIStartPos,
761 MachineBasicBlock &MBBCommon) {
762 // Remove MMOs from memory operations in the common block
763 // when they do not match the ones from the block being tail-merged.
764 // This ensures later passes conservatively compute dependencies.
765 MachineBasicBlock *MBB = MBBIStartPos->getParent();
766 // Note CommonTailLen does not necessarily matches the size of
767 // the common BB nor all its instructions because of debug
768 // instructions differences.
769 unsigned CommonTailLen = 0;
770 for (auto E = MBB->end(); MBBIStartPos != E; ++MBBIStartPos)
771 ++CommonTailLen;
772
773 MachineBasicBlock::reverse_iterator MBBI = MBB->rbegin();
774 MachineBasicBlock::reverse_iterator MBBIE = MBB->rend();
775 MachineBasicBlock::reverse_iterator MBBICommon = MBBCommon.rbegin();
776 MachineBasicBlock::reverse_iterator MBBIECommon = MBBCommon.rend();
777
778 while (CommonTailLen--) {
779 assert(MBBI != MBBIE && "Reached BB end within common tail length!");
780 (void)MBBIE;
781
782 if (MBBI->isDebugValue()) {
783 ++MBBI;
784 continue;
785 }
786
787 while ((MBBICommon != MBBIECommon) && MBBICommon->isDebugValue())
788 ++MBBICommon;
789
790 assert(MBBICommon != MBBIECommon &&
791 "Reached BB end within common tail length!");
792 assert(MBBICommon->isIdenticalTo(&*MBBI) && "Expected matching MIIs!");
793
794 if (MBBICommon->mayLoad() || MBBICommon->mayStore())
795 if (!hasIdenticalMMOs(&*MBBI, &*MBBICommon))
796 MBBICommon->clearMemRefs();
797
798 ++MBBI;
799 ++MBBICommon;
800 }
801 }
802
803 // See if any of the blocks in MergePotentials (which all have a common single
804 // successor, or all have no successor) can be tail-merged. If there is a
805 // successor, any blocks in MergePotentials that are not tail-merged and
806 // are not immediately before Succ must have an unconditional branch to
807 // Succ added (but the predecessor/successor lists need no adjustment).
808 // The lone predecessor of Succ that falls through into Succ,
809 // if any, is given in PredBB.
810
TryTailMergeBlocks(MachineBasicBlock * SuccBB,MachineBasicBlock * PredBB)811 bool BranchFolder::TryTailMergeBlocks(MachineBasicBlock *SuccBB,
812 MachineBasicBlock *PredBB) {
813 bool MadeChange = false;
814
815 // Except for the special cases below, tail-merge if there are at least
816 // this many instructions in common.
817 unsigned minCommonTailLength = TailMergeSize;
818
819 DEBUG(dbgs() << "\nTryTailMergeBlocks: ";
820 for (unsigned i = 0, e = MergePotentials.size(); i != e; ++i)
821 dbgs() << "BB#" << MergePotentials[i].getBlock()->getNumber()
822 << (i == e-1 ? "" : ", ");
823 dbgs() << "\n";
824 if (SuccBB) {
825 dbgs() << " with successor BB#" << SuccBB->getNumber() << '\n';
826 if (PredBB)
827 dbgs() << " which has fall-through from BB#"
828 << PredBB->getNumber() << "\n";
829 }
830 dbgs() << "Looking for common tails of at least "
831 << minCommonTailLength << " instruction"
832 << (minCommonTailLength == 1 ? "" : "s") << '\n';
833 );
834
835 // Sort by hash value so that blocks with identical end sequences sort
836 // together.
837 array_pod_sort(MergePotentials.begin(), MergePotentials.end());
838
839 // Walk through equivalence sets looking for actual exact matches.
840 while (MergePotentials.size() > 1) {
841 unsigned CurHash = MergePotentials.back().getHash();
842
843 // Build SameTails, identifying the set of blocks with this hash code
844 // and with the maximum number of instructions in common.
845 unsigned maxCommonTailLength = ComputeSameTails(CurHash,
846 minCommonTailLength,
847 SuccBB, PredBB);
848
849 // If we didn't find any pair that has at least minCommonTailLength
850 // instructions in common, remove all blocks with this hash code and retry.
851 if (SameTails.empty()) {
852 RemoveBlocksWithHash(CurHash, SuccBB, PredBB);
853 continue;
854 }
855
856 // If one of the blocks is the entire common tail (and not the entry
857 // block, which we can't jump to), we can treat all blocks with this same
858 // tail at once. Use PredBB if that is one of the possibilities, as that
859 // will not introduce any extra branches.
860 MachineBasicBlock *EntryBB =
861 &MergePotentials.front().getBlock()->getParent()->front();
862 unsigned commonTailIndex = SameTails.size();
863 // If there are two blocks, check to see if one can be made to fall through
864 // into the other.
865 if (SameTails.size() == 2 &&
866 SameTails[0].getBlock()->isLayoutSuccessor(SameTails[1].getBlock()) &&
867 SameTails[1].tailIsWholeBlock())
868 commonTailIndex = 1;
869 else if (SameTails.size() == 2 &&
870 SameTails[1].getBlock()->isLayoutSuccessor(
871 SameTails[0].getBlock()) &&
872 SameTails[0].tailIsWholeBlock())
873 commonTailIndex = 0;
874 else {
875 // Otherwise just pick one, favoring the fall-through predecessor if
876 // there is one.
877 for (unsigned i = 0, e = SameTails.size(); i != e; ++i) {
878 MachineBasicBlock *MBB = SameTails[i].getBlock();
879 if (MBB == EntryBB && SameTails[i].tailIsWholeBlock())
880 continue;
881 if (MBB == PredBB) {
882 commonTailIndex = i;
883 break;
884 }
885 if (SameTails[i].tailIsWholeBlock())
886 commonTailIndex = i;
887 }
888 }
889
890 if (commonTailIndex == SameTails.size() ||
891 (SameTails[commonTailIndex].getBlock() == PredBB &&
892 !SameTails[commonTailIndex].tailIsWholeBlock())) {
893 // None of the blocks consist entirely of the common tail.
894 // Split a block so that one does.
895 if (!CreateCommonTailOnlyBlock(PredBB, SuccBB,
896 maxCommonTailLength, commonTailIndex)) {
897 RemoveBlocksWithHash(CurHash, SuccBB, PredBB);
898 continue;
899 }
900 }
901
902 MachineBasicBlock *MBB = SameTails[commonTailIndex].getBlock();
903
904 // Recompute commont tail MBB's edge weights and block frequency.
905 setCommonTailEdgeWeights(*MBB);
906
907 // MBB is common tail. Adjust all other BB's to jump to this one.
908 // Traversal must be forwards so erases work.
909 DEBUG(dbgs() << "\nUsing common tail in BB#" << MBB->getNumber()
910 << " for ");
911 for (unsigned int i=0, e = SameTails.size(); i != e; ++i) {
912 if (commonTailIndex == i)
913 continue;
914 DEBUG(dbgs() << "BB#" << SameTails[i].getBlock()->getNumber()
915 << (i == e-1 ? "" : ", "));
916 // Remove MMOs from memory operations as needed.
917 removeMMOsFromMemoryOperations(SameTails[i].getTailStartPos(), *MBB);
918 // Hack the end off BB i, making it jump to BB commonTailIndex instead.
919 ReplaceTailWithBranchTo(SameTails[i].getTailStartPos(), MBB);
920 // BB i is no longer a predecessor of SuccBB; remove it from the worklist.
921 MergePotentials.erase(SameTails[i].getMPIter());
922 }
923 DEBUG(dbgs() << "\n");
924 // We leave commonTailIndex in the worklist in case there are other blocks
925 // that match it with a smaller number of instructions.
926 MadeChange = true;
927 }
928 return MadeChange;
929 }
930
TailMergeBlocks(MachineFunction & MF)931 bool BranchFolder::TailMergeBlocks(MachineFunction &MF) {
932 bool MadeChange = false;
933 if (!EnableTailMerge) return MadeChange;
934
935 // First find blocks with no successors.
936 MergePotentials.clear();
937 for (MachineBasicBlock &MBB : MF) {
938 if (MergePotentials.size() == TailMergeThreshold)
939 break;
940 if (!TriedMerging.count(&MBB) && MBB.succ_empty())
941 MergePotentials.push_back(MergePotentialsElt(HashEndOfMBB(&MBB), &MBB));
942 }
943
944 // If this is a large problem, avoid visiting the same basic blocks
945 // multiple times.
946 if (MergePotentials.size() == TailMergeThreshold)
947 for (unsigned i = 0, e = MergePotentials.size(); i != e; ++i)
948 TriedMerging.insert(MergePotentials[i].getBlock());
949
950 // See if we can do any tail merging on those.
951 if (MergePotentials.size() >= 2)
952 MadeChange |= TryTailMergeBlocks(nullptr, nullptr);
953
954 // Look at blocks (IBB) with multiple predecessors (PBB).
955 // We change each predecessor to a canonical form, by
956 // (1) temporarily removing any unconditional branch from the predecessor
957 // to IBB, and
958 // (2) alter conditional branches so they branch to the other block
959 // not IBB; this may require adding back an unconditional branch to IBB
960 // later, where there wasn't one coming in. E.g.
961 // Bcc IBB
962 // fallthrough to QBB
963 // here becomes
964 // Bncc QBB
965 // with a conceptual B to IBB after that, which never actually exists.
966 // With those changes, we see whether the predecessors' tails match,
967 // and merge them if so. We change things out of canonical form and
968 // back to the way they were later in the process. (OptimizeBranches
969 // would undo some of this, but we can't use it, because we'd get into
970 // a compile-time infinite loop repeatedly doing and undoing the same
971 // transformations.)
972
973 for (MachineFunction::iterator I = std::next(MF.begin()), E = MF.end();
974 I != E; ++I) {
975 if (I->pred_size() < 2) continue;
976 SmallPtrSet<MachineBasicBlock *, 8> UniquePreds;
977 MachineBasicBlock *IBB = &*I;
978 MachineBasicBlock *PredBB = &*std::prev(I);
979 MergePotentials.clear();
980 for (MachineBasicBlock *PBB : I->predecessors()) {
981 if (MergePotentials.size() == TailMergeThreshold)
982 break;
983
984 if (TriedMerging.count(PBB))
985 continue;
986
987 // Skip blocks that loop to themselves, can't tail merge these.
988 if (PBB == IBB)
989 continue;
990
991 // Visit each predecessor only once.
992 if (!UniquePreds.insert(PBB).second)
993 continue;
994
995 // Skip blocks which may jump to a landing pad. Can't tail merge these.
996 if (PBB->hasEHPadSuccessor())
997 continue;
998
999 MachineBasicBlock *TBB = nullptr, *FBB = nullptr;
1000 SmallVector<MachineOperand, 4> Cond;
1001 if (!TII->AnalyzeBranch(*PBB, TBB, FBB, Cond, true)) {
1002 // Failing case: IBB is the target of a cbr, and we cannot reverse the
1003 // branch.
1004 SmallVector<MachineOperand, 4> NewCond(Cond);
1005 if (!Cond.empty() && TBB == IBB) {
1006 if (TII->ReverseBranchCondition(NewCond))
1007 continue;
1008 // This is the QBB case described above
1009 if (!FBB) {
1010 auto Next = ++PBB->getIterator();
1011 if (Next != MF.end())
1012 FBB = &*Next;
1013 }
1014 }
1015
1016 // Failing case: the only way IBB can be reached from PBB is via
1017 // exception handling. Happens for landing pads. Would be nice to have
1018 // a bit in the edge so we didn't have to do all this.
1019 if (IBB->isEHPad()) {
1020 MachineFunction::iterator IP = ++PBB->getIterator();
1021 MachineBasicBlock *PredNextBB = nullptr;
1022 if (IP != MF.end())
1023 PredNextBB = &*IP;
1024 if (!TBB) {
1025 if (IBB != PredNextBB) // fallthrough
1026 continue;
1027 } else if (FBB) {
1028 if (TBB != IBB && FBB != IBB) // cbr then ubr
1029 continue;
1030 } else if (Cond.empty()) {
1031 if (TBB != IBB) // ubr
1032 continue;
1033 } else {
1034 if (TBB != IBB && IBB != PredNextBB) // cbr
1035 continue;
1036 }
1037 }
1038
1039 // Remove the unconditional branch at the end, if any.
1040 if (TBB && (Cond.empty() || FBB)) {
1041 DebugLoc dl; // FIXME: this is nowhere
1042 TII->RemoveBranch(*PBB);
1043 if (!Cond.empty())
1044 // reinsert conditional branch only, for now
1045 TII->InsertBranch(*PBB, (TBB == IBB) ? FBB : TBB, nullptr,
1046 NewCond, dl);
1047 }
1048
1049 MergePotentials.push_back(MergePotentialsElt(HashEndOfMBB(PBB), PBB));
1050 }
1051 }
1052
1053 // If this is a large problem, avoid visiting the same basic blocks multiple
1054 // times.
1055 if (MergePotentials.size() == TailMergeThreshold)
1056 for (unsigned i = 0, e = MergePotentials.size(); i != e; ++i)
1057 TriedMerging.insert(MergePotentials[i].getBlock());
1058
1059 if (MergePotentials.size() >= 2)
1060 MadeChange |= TryTailMergeBlocks(IBB, PredBB);
1061
1062 // Reinsert an unconditional branch if needed. The 1 below can occur as a
1063 // result of removing blocks in TryTailMergeBlocks.
1064 PredBB = &*std::prev(I); // this may have been changed in TryTailMergeBlocks
1065 if (MergePotentials.size() == 1 &&
1066 MergePotentials.begin()->getBlock() != PredBB)
1067 FixTail(MergePotentials.begin()->getBlock(), IBB, TII);
1068 }
1069
1070 return MadeChange;
1071 }
1072
setCommonTailEdgeWeights(MachineBasicBlock & TailMBB)1073 void BranchFolder::setCommonTailEdgeWeights(MachineBasicBlock &TailMBB) {
1074 SmallVector<BlockFrequency, 2> EdgeFreqLs(TailMBB.succ_size());
1075 BlockFrequency AccumulatedMBBFreq;
1076
1077 // Aggregate edge frequency of successor edge j:
1078 // edgeFreq(j) = sum (freq(bb) * edgeProb(bb, j)),
1079 // where bb is a basic block that is in SameTails.
1080 for (const auto &Src : SameTails) {
1081 const MachineBasicBlock *SrcMBB = Src.getBlock();
1082 BlockFrequency BlockFreq = MBBFreqInfo.getBlockFreq(SrcMBB);
1083 AccumulatedMBBFreq += BlockFreq;
1084
1085 // It is not necessary to recompute edge weights if TailBB has less than two
1086 // successors.
1087 if (TailMBB.succ_size() <= 1)
1088 continue;
1089
1090 auto EdgeFreq = EdgeFreqLs.begin();
1091
1092 for (auto SuccI = TailMBB.succ_begin(), SuccE = TailMBB.succ_end();
1093 SuccI != SuccE; ++SuccI, ++EdgeFreq)
1094 *EdgeFreq += BlockFreq * MBPI.getEdgeProbability(SrcMBB, *SuccI);
1095 }
1096
1097 MBBFreqInfo.setBlockFreq(&TailMBB, AccumulatedMBBFreq);
1098
1099 if (TailMBB.succ_size() <= 1)
1100 return;
1101
1102 auto SumEdgeFreq =
1103 std::accumulate(EdgeFreqLs.begin(), EdgeFreqLs.end(), BlockFrequency(0))
1104 .getFrequency();
1105 auto EdgeFreq = EdgeFreqLs.begin();
1106
1107 if (SumEdgeFreq > 0) {
1108 for (auto SuccI = TailMBB.succ_begin(), SuccE = TailMBB.succ_end();
1109 SuccI != SuccE; ++SuccI, ++EdgeFreq) {
1110 auto Prob = BranchProbability::getBranchProbability(
1111 EdgeFreq->getFrequency(), SumEdgeFreq);
1112 TailMBB.setSuccProbability(SuccI, Prob);
1113 }
1114 }
1115 }
1116
1117 //===----------------------------------------------------------------------===//
1118 // Branch Optimization
1119 //===----------------------------------------------------------------------===//
1120
OptimizeBranches(MachineFunction & MF)1121 bool BranchFolder::OptimizeBranches(MachineFunction &MF) {
1122 bool MadeChange = false;
1123
1124 // Make sure blocks are numbered in order
1125 MF.RenumberBlocks();
1126 // Renumbering blocks alters funclet membership, recalculate it.
1127 FuncletMembership = getFuncletMembership(MF);
1128
1129 for (MachineFunction::iterator I = std::next(MF.begin()), E = MF.end();
1130 I != E; ) {
1131 MachineBasicBlock *MBB = &*I++;
1132 MadeChange |= OptimizeBlock(MBB);
1133
1134 // If it is dead, remove it.
1135 if (MBB->pred_empty()) {
1136 RemoveDeadBlock(MBB);
1137 MadeChange = true;
1138 ++NumDeadBlocks;
1139 }
1140 }
1141
1142 return MadeChange;
1143 }
1144
1145 // Blocks should be considered empty if they contain only debug info;
1146 // else the debug info would affect codegen.
IsEmptyBlock(MachineBasicBlock * MBB)1147 static bool IsEmptyBlock(MachineBasicBlock *MBB) {
1148 return MBB->getFirstNonDebugInstr() == MBB->end();
1149 }
1150
1151 // Blocks with only debug info and branches should be considered the same
1152 // as blocks with only branches.
IsBranchOnlyBlock(MachineBasicBlock * MBB)1153 static bool IsBranchOnlyBlock(MachineBasicBlock *MBB) {
1154 MachineBasicBlock::iterator I = MBB->getFirstNonDebugInstr();
1155 assert(I != MBB->end() && "empty block!");
1156 return I->isBranch();
1157 }
1158
1159 /// IsBetterFallthrough - Return true if it would be clearly better to
1160 /// fall-through to MBB1 than to fall through into MBB2. This has to return
1161 /// a strict ordering, returning true for both (MBB1,MBB2) and (MBB2,MBB1) will
1162 /// result in infinite loops.
IsBetterFallthrough(MachineBasicBlock * MBB1,MachineBasicBlock * MBB2)1163 static bool IsBetterFallthrough(MachineBasicBlock *MBB1,
1164 MachineBasicBlock *MBB2) {
1165 // Right now, we use a simple heuristic. If MBB2 ends with a call, and
1166 // MBB1 doesn't, we prefer to fall through into MBB1. This allows us to
1167 // optimize branches that branch to either a return block or an assert block
1168 // into a fallthrough to the return.
1169 MachineBasicBlock::iterator MBB1I = MBB1->getLastNonDebugInstr();
1170 MachineBasicBlock::iterator MBB2I = MBB2->getLastNonDebugInstr();
1171 if (MBB1I == MBB1->end() || MBB2I == MBB2->end())
1172 return false;
1173
1174 // If there is a clear successor ordering we make sure that one block
1175 // will fall through to the next
1176 if (MBB1->isSuccessor(MBB2)) return true;
1177 if (MBB2->isSuccessor(MBB1)) return false;
1178
1179 return MBB2I->isCall() && !MBB1I->isCall();
1180 }
1181
1182 /// getBranchDebugLoc - Find and return, if any, the DebugLoc of the branch
1183 /// instructions on the block.
getBranchDebugLoc(MachineBasicBlock & MBB)1184 static DebugLoc getBranchDebugLoc(MachineBasicBlock &MBB) {
1185 MachineBasicBlock::iterator I = MBB.getLastNonDebugInstr();
1186 if (I != MBB.end() && I->isBranch())
1187 return I->getDebugLoc();
1188 return DebugLoc();
1189 }
1190
1191 /// OptimizeBlock - Analyze and optimize control flow related to the specified
1192 /// block. This is never called on the entry block.
OptimizeBlock(MachineBasicBlock * MBB)1193 bool BranchFolder::OptimizeBlock(MachineBasicBlock *MBB) {
1194 bool MadeChange = false;
1195 MachineFunction &MF = *MBB->getParent();
1196 ReoptimizeBlock:
1197
1198 MachineFunction::iterator FallThrough = MBB->getIterator();
1199 ++FallThrough;
1200
1201 // Make sure MBB and FallThrough belong to the same funclet.
1202 bool SameFunclet = true;
1203 if (!FuncletMembership.empty() && FallThrough != MF.end()) {
1204 auto MBBFunclet = FuncletMembership.find(MBB);
1205 assert(MBBFunclet != FuncletMembership.end());
1206 auto FallThroughFunclet = FuncletMembership.find(&*FallThrough);
1207 assert(FallThroughFunclet != FuncletMembership.end());
1208 SameFunclet = MBBFunclet->second == FallThroughFunclet->second;
1209 }
1210
1211 // If this block is empty, make everyone use its fall-through, not the block
1212 // explicitly. Landing pads should not do this since the landing-pad table
1213 // points to this block. Blocks with their addresses taken shouldn't be
1214 // optimized away.
1215 if (IsEmptyBlock(MBB) && !MBB->isEHPad() && !MBB->hasAddressTaken() &&
1216 SameFunclet) {
1217 // Dead block? Leave for cleanup later.
1218 if (MBB->pred_empty()) return MadeChange;
1219
1220 if (FallThrough == MF.end()) {
1221 // TODO: Simplify preds to not branch here if possible!
1222 } else if (FallThrough->isEHPad()) {
1223 // Don't rewrite to a landing pad fallthough. That could lead to the case
1224 // where a BB jumps to more than one landing pad.
1225 // TODO: Is it ever worth rewriting predecessors which don't already
1226 // jump to a landing pad, and so can safely jump to the fallthrough?
1227 } else {
1228 // Rewrite all predecessors of the old block to go to the fallthrough
1229 // instead.
1230 while (!MBB->pred_empty()) {
1231 MachineBasicBlock *Pred = *(MBB->pred_end()-1);
1232 Pred->ReplaceUsesOfBlockWith(MBB, &*FallThrough);
1233 }
1234 // If MBB was the target of a jump table, update jump tables to go to the
1235 // fallthrough instead.
1236 if (MachineJumpTableInfo *MJTI = MF.getJumpTableInfo())
1237 MJTI->ReplaceMBBInJumpTables(MBB, &*FallThrough);
1238 MadeChange = true;
1239 }
1240 return MadeChange;
1241 }
1242
1243 // Check to see if we can simplify the terminator of the block before this
1244 // one.
1245 MachineBasicBlock &PrevBB = *std::prev(MachineFunction::iterator(MBB));
1246
1247 MachineBasicBlock *PriorTBB = nullptr, *PriorFBB = nullptr;
1248 SmallVector<MachineOperand, 4> PriorCond;
1249 bool PriorUnAnalyzable =
1250 TII->AnalyzeBranch(PrevBB, PriorTBB, PriorFBB, PriorCond, true);
1251 if (!PriorUnAnalyzable) {
1252 // If the CFG for the prior block has extra edges, remove them.
1253 MadeChange |= PrevBB.CorrectExtraCFGEdges(PriorTBB, PriorFBB,
1254 !PriorCond.empty());
1255
1256 // If the previous branch is conditional and both conditions go to the same
1257 // destination, remove the branch, replacing it with an unconditional one or
1258 // a fall-through.
1259 if (PriorTBB && PriorTBB == PriorFBB) {
1260 DebugLoc dl = getBranchDebugLoc(PrevBB);
1261 TII->RemoveBranch(PrevBB);
1262 PriorCond.clear();
1263 if (PriorTBB != MBB)
1264 TII->InsertBranch(PrevBB, PriorTBB, nullptr, PriorCond, dl);
1265 MadeChange = true;
1266 ++NumBranchOpts;
1267 goto ReoptimizeBlock;
1268 }
1269
1270 // If the previous block unconditionally falls through to this block and
1271 // this block has no other predecessors, move the contents of this block
1272 // into the prior block. This doesn't usually happen when SimplifyCFG
1273 // has been used, but it can happen if tail merging splits a fall-through
1274 // predecessor of a block.
1275 // This has to check PrevBB->succ_size() because EH edges are ignored by
1276 // AnalyzeBranch.
1277 if (PriorCond.empty() && !PriorTBB && MBB->pred_size() == 1 &&
1278 PrevBB.succ_size() == 1 &&
1279 !MBB->hasAddressTaken() && !MBB->isEHPad()) {
1280 DEBUG(dbgs() << "\nMerging into block: " << PrevBB
1281 << "From MBB: " << *MBB);
1282 // Remove redundant DBG_VALUEs first.
1283 if (PrevBB.begin() != PrevBB.end()) {
1284 MachineBasicBlock::iterator PrevBBIter = PrevBB.end();
1285 --PrevBBIter;
1286 MachineBasicBlock::iterator MBBIter = MBB->begin();
1287 // Check if DBG_VALUE at the end of PrevBB is identical to the
1288 // DBG_VALUE at the beginning of MBB.
1289 while (PrevBBIter != PrevBB.begin() && MBBIter != MBB->end()
1290 && PrevBBIter->isDebugValue() && MBBIter->isDebugValue()) {
1291 if (!MBBIter->isIdenticalTo(PrevBBIter))
1292 break;
1293 MachineInstr *DuplicateDbg = MBBIter;
1294 ++MBBIter; -- PrevBBIter;
1295 DuplicateDbg->eraseFromParent();
1296 }
1297 }
1298 PrevBB.splice(PrevBB.end(), MBB, MBB->begin(), MBB->end());
1299 PrevBB.removeSuccessor(PrevBB.succ_begin());
1300 assert(PrevBB.succ_empty());
1301 PrevBB.transferSuccessors(MBB);
1302 MadeChange = true;
1303 return MadeChange;
1304 }
1305
1306 // If the previous branch *only* branches to *this* block (conditional or
1307 // not) remove the branch.
1308 if (PriorTBB == MBB && !PriorFBB) {
1309 TII->RemoveBranch(PrevBB);
1310 MadeChange = true;
1311 ++NumBranchOpts;
1312 goto ReoptimizeBlock;
1313 }
1314
1315 // If the prior block branches somewhere else on the condition and here if
1316 // the condition is false, remove the uncond second branch.
1317 if (PriorFBB == MBB) {
1318 DebugLoc dl = getBranchDebugLoc(PrevBB);
1319 TII->RemoveBranch(PrevBB);
1320 TII->InsertBranch(PrevBB, PriorTBB, nullptr, PriorCond, dl);
1321 MadeChange = true;
1322 ++NumBranchOpts;
1323 goto ReoptimizeBlock;
1324 }
1325
1326 // If the prior block branches here on true and somewhere else on false, and
1327 // if the branch condition is reversible, reverse the branch to create a
1328 // fall-through.
1329 if (PriorTBB == MBB) {
1330 SmallVector<MachineOperand, 4> NewPriorCond(PriorCond);
1331 if (!TII->ReverseBranchCondition(NewPriorCond)) {
1332 DebugLoc dl = getBranchDebugLoc(PrevBB);
1333 TII->RemoveBranch(PrevBB);
1334 TII->InsertBranch(PrevBB, PriorFBB, nullptr, NewPriorCond, dl);
1335 MadeChange = true;
1336 ++NumBranchOpts;
1337 goto ReoptimizeBlock;
1338 }
1339 }
1340
1341 // If this block has no successors (e.g. it is a return block or ends with
1342 // a call to a no-return function like abort or __cxa_throw) and if the pred
1343 // falls through into this block, and if it would otherwise fall through
1344 // into the block after this, move this block to the end of the function.
1345 //
1346 // We consider it more likely that execution will stay in the function (e.g.
1347 // due to loops) than it is to exit it. This asserts in loops etc, moving
1348 // the assert condition out of the loop body.
1349 if (MBB->succ_empty() && !PriorCond.empty() && !PriorFBB &&
1350 MachineFunction::iterator(PriorTBB) == FallThrough &&
1351 !MBB->canFallThrough()) {
1352 bool DoTransform = true;
1353
1354 // We have to be careful that the succs of PredBB aren't both no-successor
1355 // blocks. If neither have successors and if PredBB is the second from
1356 // last block in the function, we'd just keep swapping the two blocks for
1357 // last. Only do the swap if one is clearly better to fall through than
1358 // the other.
1359 if (FallThrough == --MF.end() &&
1360 !IsBetterFallthrough(PriorTBB, MBB))
1361 DoTransform = false;
1362
1363 if (DoTransform) {
1364 // Reverse the branch so we will fall through on the previous true cond.
1365 SmallVector<MachineOperand, 4> NewPriorCond(PriorCond);
1366 if (!TII->ReverseBranchCondition(NewPriorCond)) {
1367 DEBUG(dbgs() << "\nMoving MBB: " << *MBB
1368 << "To make fallthrough to: " << *PriorTBB << "\n");
1369
1370 DebugLoc dl = getBranchDebugLoc(PrevBB);
1371 TII->RemoveBranch(PrevBB);
1372 TII->InsertBranch(PrevBB, MBB, nullptr, NewPriorCond, dl);
1373
1374 // Move this block to the end of the function.
1375 MBB->moveAfter(&MF.back());
1376 MadeChange = true;
1377 ++NumBranchOpts;
1378 return MadeChange;
1379 }
1380 }
1381 }
1382 }
1383
1384 // Analyze the branch in the current block.
1385 MachineBasicBlock *CurTBB = nullptr, *CurFBB = nullptr;
1386 SmallVector<MachineOperand, 4> CurCond;
1387 bool CurUnAnalyzable= TII->AnalyzeBranch(*MBB, CurTBB, CurFBB, CurCond, true);
1388 if (!CurUnAnalyzable) {
1389 // If the CFG for the prior block has extra edges, remove them.
1390 MadeChange |= MBB->CorrectExtraCFGEdges(CurTBB, CurFBB, !CurCond.empty());
1391
1392 // If this is a two-way branch, and the FBB branches to this block, reverse
1393 // the condition so the single-basic-block loop is faster. Instead of:
1394 // Loop: xxx; jcc Out; jmp Loop
1395 // we want:
1396 // Loop: xxx; jncc Loop; jmp Out
1397 if (CurTBB && CurFBB && CurFBB == MBB && CurTBB != MBB) {
1398 SmallVector<MachineOperand, 4> NewCond(CurCond);
1399 if (!TII->ReverseBranchCondition(NewCond)) {
1400 DebugLoc dl = getBranchDebugLoc(*MBB);
1401 TII->RemoveBranch(*MBB);
1402 TII->InsertBranch(*MBB, CurFBB, CurTBB, NewCond, dl);
1403 MadeChange = true;
1404 ++NumBranchOpts;
1405 goto ReoptimizeBlock;
1406 }
1407 }
1408
1409 // If this branch is the only thing in its block, see if we can forward
1410 // other blocks across it.
1411 if (CurTBB && CurCond.empty() && !CurFBB &&
1412 IsBranchOnlyBlock(MBB) && CurTBB != MBB &&
1413 !MBB->hasAddressTaken() && !MBB->isEHPad()) {
1414 DebugLoc dl = getBranchDebugLoc(*MBB);
1415 // This block may contain just an unconditional branch. Because there can
1416 // be 'non-branch terminators' in the block, try removing the branch and
1417 // then seeing if the block is empty.
1418 TII->RemoveBranch(*MBB);
1419 // If the only things remaining in the block are debug info, remove these
1420 // as well, so this will behave the same as an empty block in non-debug
1421 // mode.
1422 if (IsEmptyBlock(MBB)) {
1423 // Make the block empty, losing the debug info (we could probably
1424 // improve this in some cases.)
1425 MBB->erase(MBB->begin(), MBB->end());
1426 }
1427 // If this block is just an unconditional branch to CurTBB, we can
1428 // usually completely eliminate the block. The only case we cannot
1429 // completely eliminate the block is when the block before this one
1430 // falls through into MBB and we can't understand the prior block's branch
1431 // condition.
1432 if (MBB->empty()) {
1433 bool PredHasNoFallThrough = !PrevBB.canFallThrough();
1434 if (PredHasNoFallThrough || !PriorUnAnalyzable ||
1435 !PrevBB.isSuccessor(MBB)) {
1436 // If the prior block falls through into us, turn it into an
1437 // explicit branch to us to make updates simpler.
1438 if (!PredHasNoFallThrough && PrevBB.isSuccessor(MBB) &&
1439 PriorTBB != MBB && PriorFBB != MBB) {
1440 if (!PriorTBB) {
1441 assert(PriorCond.empty() && !PriorFBB &&
1442 "Bad branch analysis");
1443 PriorTBB = MBB;
1444 } else {
1445 assert(!PriorFBB && "Machine CFG out of date!");
1446 PriorFBB = MBB;
1447 }
1448 DebugLoc pdl = getBranchDebugLoc(PrevBB);
1449 TII->RemoveBranch(PrevBB);
1450 TII->InsertBranch(PrevBB, PriorTBB, PriorFBB, PriorCond, pdl);
1451 }
1452
1453 // Iterate through all the predecessors, revectoring each in-turn.
1454 size_t PI = 0;
1455 bool DidChange = false;
1456 bool HasBranchToSelf = false;
1457 while(PI != MBB->pred_size()) {
1458 MachineBasicBlock *PMBB = *(MBB->pred_begin() + PI);
1459 if (PMBB == MBB) {
1460 // If this block has an uncond branch to itself, leave it.
1461 ++PI;
1462 HasBranchToSelf = true;
1463 } else {
1464 DidChange = true;
1465 PMBB->ReplaceUsesOfBlockWith(MBB, CurTBB);
1466 // If this change resulted in PMBB ending in a conditional
1467 // branch where both conditions go to the same destination,
1468 // change this to an unconditional branch (and fix the CFG).
1469 MachineBasicBlock *NewCurTBB = nullptr, *NewCurFBB = nullptr;
1470 SmallVector<MachineOperand, 4> NewCurCond;
1471 bool NewCurUnAnalyzable = TII->AnalyzeBranch(*PMBB, NewCurTBB,
1472 NewCurFBB, NewCurCond, true);
1473 if (!NewCurUnAnalyzable && NewCurTBB && NewCurTBB == NewCurFBB) {
1474 DebugLoc pdl = getBranchDebugLoc(*PMBB);
1475 TII->RemoveBranch(*PMBB);
1476 NewCurCond.clear();
1477 TII->InsertBranch(*PMBB, NewCurTBB, nullptr, NewCurCond, pdl);
1478 MadeChange = true;
1479 ++NumBranchOpts;
1480 PMBB->CorrectExtraCFGEdges(NewCurTBB, nullptr, false);
1481 }
1482 }
1483 }
1484
1485 // Change any jumptables to go to the new MBB.
1486 if (MachineJumpTableInfo *MJTI = MF.getJumpTableInfo())
1487 MJTI->ReplaceMBBInJumpTables(MBB, CurTBB);
1488 if (DidChange) {
1489 ++NumBranchOpts;
1490 MadeChange = true;
1491 if (!HasBranchToSelf) return MadeChange;
1492 }
1493 }
1494 }
1495
1496 // Add the branch back if the block is more than just an uncond branch.
1497 TII->InsertBranch(*MBB, CurTBB, nullptr, CurCond, dl);
1498 }
1499 }
1500
1501 // If the prior block doesn't fall through into this block, and if this
1502 // block doesn't fall through into some other block, see if we can find a
1503 // place to move this block where a fall-through will happen.
1504 if (!PrevBB.canFallThrough()) {
1505
1506 // Now we know that there was no fall-through into this block, check to
1507 // see if it has a fall-through into its successor.
1508 bool CurFallsThru = MBB->canFallThrough();
1509
1510 if (!MBB->isEHPad()) {
1511 // Check all the predecessors of this block. If one of them has no fall
1512 // throughs, move this block right after it.
1513 for (MachineBasicBlock *PredBB : MBB->predecessors()) {
1514 // Analyze the branch at the end of the pred.
1515 MachineBasicBlock *PredTBB = nullptr, *PredFBB = nullptr;
1516 SmallVector<MachineOperand, 4> PredCond;
1517 if (PredBB != MBB && !PredBB->canFallThrough() &&
1518 !TII->AnalyzeBranch(*PredBB, PredTBB, PredFBB, PredCond, true)
1519 && (!CurFallsThru || !CurTBB || !CurFBB)
1520 && (!CurFallsThru || MBB->getNumber() >= PredBB->getNumber())) {
1521 // If the current block doesn't fall through, just move it.
1522 // If the current block can fall through and does not end with a
1523 // conditional branch, we need to append an unconditional jump to
1524 // the (current) next block. To avoid a possible compile-time
1525 // infinite loop, move blocks only backward in this case.
1526 // Also, if there are already 2 branches here, we cannot add a third;
1527 // this means we have the case
1528 // Bcc next
1529 // B elsewhere
1530 // next:
1531 if (CurFallsThru) {
1532 MachineBasicBlock *NextBB = &*std::next(MBB->getIterator());
1533 CurCond.clear();
1534 TII->InsertBranch(*MBB, NextBB, nullptr, CurCond, DebugLoc());
1535 }
1536 MBB->moveAfter(PredBB);
1537 MadeChange = true;
1538 goto ReoptimizeBlock;
1539 }
1540 }
1541 }
1542
1543 if (!CurFallsThru) {
1544 // Check all successors to see if we can move this block before it.
1545 for (MachineBasicBlock *SuccBB : MBB->successors()) {
1546 // Analyze the branch at the end of the block before the succ.
1547 MachineFunction::iterator SuccPrev = --SuccBB->getIterator();
1548
1549 // If this block doesn't already fall-through to that successor, and if
1550 // the succ doesn't already have a block that can fall through into it,
1551 // and if the successor isn't an EH destination, we can arrange for the
1552 // fallthrough to happen.
1553 if (SuccBB != MBB && &*SuccPrev != MBB &&
1554 !SuccPrev->canFallThrough() && !CurUnAnalyzable &&
1555 !SuccBB->isEHPad()) {
1556 MBB->moveBefore(SuccBB);
1557 MadeChange = true;
1558 goto ReoptimizeBlock;
1559 }
1560 }
1561
1562 // Okay, there is no really great place to put this block. If, however,
1563 // the block before this one would be a fall-through if this block were
1564 // removed, move this block to the end of the function.
1565 MachineBasicBlock *PrevTBB = nullptr, *PrevFBB = nullptr;
1566 SmallVector<MachineOperand, 4> PrevCond;
1567 // We're looking for cases where PrevBB could possibly fall through to
1568 // FallThrough, but if FallThrough is an EH pad that wouldn't be useful
1569 // so here we skip over any EH pads so we might have a chance to find
1570 // a branch target from PrevBB.
1571 while (FallThrough != MF.end() && FallThrough->isEHPad())
1572 ++FallThrough;
1573 // Now check to see if the current block is sitting between PrevBB and
1574 // a block to which it could fall through.
1575 if (FallThrough != MF.end() &&
1576 !TII->AnalyzeBranch(PrevBB, PrevTBB, PrevFBB, PrevCond, true) &&
1577 PrevBB.isSuccessor(&*FallThrough)) {
1578 MBB->moveAfter(&MF.back());
1579 MadeChange = true;
1580 return MadeChange;
1581 }
1582 }
1583 }
1584
1585 return MadeChange;
1586 }
1587
1588 //===----------------------------------------------------------------------===//
1589 // Hoist Common Code
1590 //===----------------------------------------------------------------------===//
1591
1592 /// HoistCommonCode - Hoist common instruction sequences at the start of basic
1593 /// blocks to their common predecessor.
HoistCommonCode(MachineFunction & MF)1594 bool BranchFolder::HoistCommonCode(MachineFunction &MF) {
1595 bool MadeChange = false;
1596 for (MachineFunction::iterator I = MF.begin(), E = MF.end(); I != E; ) {
1597 MachineBasicBlock *MBB = &*I++;
1598 MadeChange |= HoistCommonCodeInSuccs(MBB);
1599 }
1600
1601 return MadeChange;
1602 }
1603
1604 /// findFalseBlock - BB has a fallthrough. Find its 'false' successor given
1605 /// its 'true' successor.
findFalseBlock(MachineBasicBlock * BB,MachineBasicBlock * TrueBB)1606 static MachineBasicBlock *findFalseBlock(MachineBasicBlock *BB,
1607 MachineBasicBlock *TrueBB) {
1608 for (MachineBasicBlock *SuccBB : BB->successors())
1609 if (SuccBB != TrueBB)
1610 return SuccBB;
1611 return nullptr;
1612 }
1613
1614 template <class Container>
addRegAndItsAliases(unsigned Reg,const TargetRegisterInfo * TRI,Container & Set)1615 static void addRegAndItsAliases(unsigned Reg, const TargetRegisterInfo *TRI,
1616 Container &Set) {
1617 if (TargetRegisterInfo::isPhysicalRegister(Reg)) {
1618 for (MCRegAliasIterator AI(Reg, TRI, true); AI.isValid(); ++AI)
1619 Set.insert(*AI);
1620 } else {
1621 Set.insert(Reg);
1622 }
1623 }
1624
1625 /// findHoistingInsertPosAndDeps - Find the location to move common instructions
1626 /// in successors to. The location is usually just before the terminator,
1627 /// however if the terminator is a conditional branch and its previous
1628 /// instruction is the flag setting instruction, the previous instruction is
1629 /// the preferred location. This function also gathers uses and defs of the
1630 /// instructions from the insertion point to the end of the block. The data is
1631 /// used by HoistCommonCodeInSuccs to ensure safety.
1632 static
findHoistingInsertPosAndDeps(MachineBasicBlock * MBB,const TargetInstrInfo * TII,const TargetRegisterInfo * TRI,SmallSet<unsigned,4> & Uses,SmallSet<unsigned,4> & Defs)1633 MachineBasicBlock::iterator findHoistingInsertPosAndDeps(MachineBasicBlock *MBB,
1634 const TargetInstrInfo *TII,
1635 const TargetRegisterInfo *TRI,
1636 SmallSet<unsigned,4> &Uses,
1637 SmallSet<unsigned,4> &Defs) {
1638 MachineBasicBlock::iterator Loc = MBB->getFirstTerminator();
1639 if (!TII->isUnpredicatedTerminator(Loc))
1640 return MBB->end();
1641
1642 for (const MachineOperand &MO : Loc->operands()) {
1643 if (!MO.isReg())
1644 continue;
1645 unsigned Reg = MO.getReg();
1646 if (!Reg)
1647 continue;
1648 if (MO.isUse()) {
1649 addRegAndItsAliases(Reg, TRI, Uses);
1650 } else {
1651 if (!MO.isDead())
1652 // Don't try to hoist code in the rare case the terminator defines a
1653 // register that is later used.
1654 return MBB->end();
1655
1656 // If the terminator defines a register, make sure we don't hoist
1657 // the instruction whose def might be clobbered by the terminator.
1658 addRegAndItsAliases(Reg, TRI, Defs);
1659 }
1660 }
1661
1662 if (Uses.empty())
1663 return Loc;
1664 if (Loc == MBB->begin())
1665 return MBB->end();
1666
1667 // The terminator is probably a conditional branch, try not to separate the
1668 // branch from condition setting instruction.
1669 MachineBasicBlock::iterator PI = Loc;
1670 --PI;
1671 while (PI != MBB->begin() && PI->isDebugValue())
1672 --PI;
1673
1674 bool IsDef = false;
1675 for (const MachineOperand &MO : PI->operands()) {
1676 // If PI has a regmask operand, it is probably a call. Separate away.
1677 if (MO.isRegMask())
1678 return Loc;
1679 if (!MO.isReg() || MO.isUse())
1680 continue;
1681 unsigned Reg = MO.getReg();
1682 if (!Reg)
1683 continue;
1684 if (Uses.count(Reg)) {
1685 IsDef = true;
1686 break;
1687 }
1688 }
1689 if (!IsDef)
1690 // The condition setting instruction is not just before the conditional
1691 // branch.
1692 return Loc;
1693
1694 // Be conservative, don't insert instruction above something that may have
1695 // side-effects. And since it's potentially bad to separate flag setting
1696 // instruction from the conditional branch, just abort the optimization
1697 // completely.
1698 // Also avoid moving code above predicated instruction since it's hard to
1699 // reason about register liveness with predicated instruction.
1700 bool DontMoveAcrossStore = true;
1701 if (!PI->isSafeToMove(nullptr, DontMoveAcrossStore) || TII->isPredicated(PI))
1702 return MBB->end();
1703
1704
1705 // Find out what registers are live. Note this routine is ignoring other live
1706 // registers which are only used by instructions in successor blocks.
1707 for (const MachineOperand &MO : PI->operands()) {
1708 if (!MO.isReg())
1709 continue;
1710 unsigned Reg = MO.getReg();
1711 if (!Reg)
1712 continue;
1713 if (MO.isUse()) {
1714 addRegAndItsAliases(Reg, TRI, Uses);
1715 } else {
1716 if (Uses.erase(Reg)) {
1717 if (TargetRegisterInfo::isPhysicalRegister(Reg)) {
1718 for (MCSubRegIterator SubRegs(Reg, TRI); SubRegs.isValid(); ++SubRegs)
1719 Uses.erase(*SubRegs); // Use sub-registers to be conservative
1720 }
1721 }
1722 addRegAndItsAliases(Reg, TRI, Defs);
1723 }
1724 }
1725
1726 return PI;
1727 }
1728
1729 /// HoistCommonCodeInSuccs - If the successors of MBB has common instruction
1730 /// sequence at the start of the function, move the instructions before MBB
1731 /// terminator if it's legal.
HoistCommonCodeInSuccs(MachineBasicBlock * MBB)1732 bool BranchFolder::HoistCommonCodeInSuccs(MachineBasicBlock *MBB) {
1733 MachineBasicBlock *TBB = nullptr, *FBB = nullptr;
1734 SmallVector<MachineOperand, 4> Cond;
1735 if (TII->AnalyzeBranch(*MBB, TBB, FBB, Cond, true) || !TBB || Cond.empty())
1736 return false;
1737
1738 if (!FBB) FBB = findFalseBlock(MBB, TBB);
1739 if (!FBB)
1740 // Malformed bcc? True and false blocks are the same?
1741 return false;
1742
1743 // Restrict the optimization to cases where MBB is the only predecessor,
1744 // it is an obvious win.
1745 if (TBB->pred_size() > 1 || FBB->pred_size() > 1)
1746 return false;
1747
1748 // Find a suitable position to hoist the common instructions to. Also figure
1749 // out which registers are used or defined by instructions from the insertion
1750 // point to the end of the block.
1751 SmallSet<unsigned, 4> Uses, Defs;
1752 MachineBasicBlock::iterator Loc =
1753 findHoistingInsertPosAndDeps(MBB, TII, TRI, Uses, Defs);
1754 if (Loc == MBB->end())
1755 return false;
1756
1757 bool HasDups = false;
1758 SmallVector<unsigned, 4> LocalDefs;
1759 SmallSet<unsigned, 4> LocalDefsSet;
1760 MachineBasicBlock::iterator TIB = TBB->begin();
1761 MachineBasicBlock::iterator FIB = FBB->begin();
1762 MachineBasicBlock::iterator TIE = TBB->end();
1763 MachineBasicBlock::iterator FIE = FBB->end();
1764 while (TIB != TIE && FIB != FIE) {
1765 // Skip dbg_value instructions. These do not count.
1766 if (TIB->isDebugValue()) {
1767 while (TIB != TIE && TIB->isDebugValue())
1768 ++TIB;
1769 if (TIB == TIE)
1770 break;
1771 }
1772 if (FIB->isDebugValue()) {
1773 while (FIB != FIE && FIB->isDebugValue())
1774 ++FIB;
1775 if (FIB == FIE)
1776 break;
1777 }
1778 if (!TIB->isIdenticalTo(FIB, MachineInstr::CheckKillDead))
1779 break;
1780
1781 if (TII->isPredicated(TIB))
1782 // Hard to reason about register liveness with predicated instruction.
1783 break;
1784
1785 bool IsSafe = true;
1786 for (MachineOperand &MO : TIB->operands()) {
1787 // Don't attempt to hoist instructions with register masks.
1788 if (MO.isRegMask()) {
1789 IsSafe = false;
1790 break;
1791 }
1792 if (!MO.isReg())
1793 continue;
1794 unsigned Reg = MO.getReg();
1795 if (!Reg)
1796 continue;
1797 if (MO.isDef()) {
1798 if (Uses.count(Reg)) {
1799 // Avoid clobbering a register that's used by the instruction at
1800 // the point of insertion.
1801 IsSafe = false;
1802 break;
1803 }
1804
1805 if (Defs.count(Reg) && !MO.isDead()) {
1806 // Don't hoist the instruction if the def would be clobber by the
1807 // instruction at the point insertion. FIXME: This is overly
1808 // conservative. It should be possible to hoist the instructions
1809 // in BB2 in the following example:
1810 // BB1:
1811 // r1, eflag = op1 r2, r3
1812 // brcc eflag
1813 //
1814 // BB2:
1815 // r1 = op2, ...
1816 // = op3, r1<kill>
1817 IsSafe = false;
1818 break;
1819 }
1820 } else if (!LocalDefsSet.count(Reg)) {
1821 if (Defs.count(Reg)) {
1822 // Use is defined by the instruction at the point of insertion.
1823 IsSafe = false;
1824 break;
1825 }
1826
1827 if (MO.isKill() && Uses.count(Reg))
1828 // Kills a register that's read by the instruction at the point of
1829 // insertion. Remove the kill marker.
1830 MO.setIsKill(false);
1831 }
1832 }
1833 if (!IsSafe)
1834 break;
1835
1836 bool DontMoveAcrossStore = true;
1837 if (!TIB->isSafeToMove(nullptr, DontMoveAcrossStore))
1838 break;
1839
1840 // Remove kills from LocalDefsSet, these registers had short live ranges.
1841 for (const MachineOperand &MO : TIB->operands()) {
1842 if (!MO.isReg() || !MO.isUse() || !MO.isKill())
1843 continue;
1844 unsigned Reg = MO.getReg();
1845 if (!Reg || !LocalDefsSet.count(Reg))
1846 continue;
1847 if (TargetRegisterInfo::isPhysicalRegister(Reg)) {
1848 for (MCRegAliasIterator AI(Reg, TRI, true); AI.isValid(); ++AI)
1849 LocalDefsSet.erase(*AI);
1850 } else {
1851 LocalDefsSet.erase(Reg);
1852 }
1853 }
1854
1855 // Track local defs so we can update liveins.
1856 for (const MachineOperand &MO : TIB->operands()) {
1857 if (!MO.isReg() || !MO.isDef() || MO.isDead())
1858 continue;
1859 unsigned Reg = MO.getReg();
1860 if (!Reg)
1861 continue;
1862 LocalDefs.push_back(Reg);
1863 addRegAndItsAliases(Reg, TRI, LocalDefsSet);
1864 }
1865
1866 HasDups = true;
1867 ++TIB;
1868 ++FIB;
1869 }
1870
1871 if (!HasDups)
1872 return false;
1873
1874 MBB->splice(Loc, TBB, TBB->begin(), TIB);
1875 FBB->erase(FBB->begin(), FIB);
1876
1877 // Update livein's.
1878 for (unsigned i = 0, e = LocalDefs.size(); i != e; ++i) {
1879 unsigned Def = LocalDefs[i];
1880 if (LocalDefsSet.count(Def)) {
1881 TBB->addLiveIn(Def);
1882 FBB->addLiveIn(Def);
1883 }
1884 }
1885
1886 ++NumHoist;
1887 return true;
1888 }
1889