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