lib/CodeGen/BranchFolding.cpp

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