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