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