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