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