lib/CodeGen/BranchFolding.cpp

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