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/Function.h"
  22 #include "llvm/CodeGen/Passes.h"
  23 #include "llvm/CodeGen/MachineModuleInfo.h"
  24 #include "llvm/CodeGen/MachineFunctionPass.h"
  25 #include "llvm/CodeGen/MachineJumpTableInfo.h"
  26 #include "llvm/CodeGen/RegisterScavenging.h"
  27 #include "llvm/Target/TargetInstrInfo.h"
  28 #include "llvm/Target/TargetMachine.h"
  29 #include "llvm/Target/TargetRegisterInfo.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/ADT/SmallSet.h"
  35 #include "llvm/ADT/SetVector.h"
  36 #include "llvm/ADT/Statistic.h"
  37 #include "llvm/ADT/STLExtras.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
  45 static cl::opt<cl::boolOrDefault> FlagEnableTailMerge("enable-tail-merge",
  46                               cl::init(cl::BOU_UNSET), cl::Hidden);
  47
  48 // Throttle for huge numbers of predecessors (compile speed problems)
  49 static cl::opt<unsigned>
  50 TailMergeThreshold("tail-merge-threshold",
  51           cl::desc("Max number of predecessors to consider tail merging"),
  52           cl::init(150), cl::Hidden);
  53
  54 // Heuristic for tail merging (and, inversely, tail duplication).
  55 // TODO: This should be replaced with a target query.
  56 static cl::opt<unsigned>
  57 TailMergeSize("tail-merge-size",
  58           cl::desc("Min number of instructions to consider tail merging"),
  59                               cl::init(3), cl::Hidden);
  60
  61 namespace {
  62   /// BranchFolderPass - Wrap branch folder in a machine function pass.
  63   class BranchFolderPass : public MachineFunctionPass,
  64                            public BranchFolder {
  65   public:
  66     static char ID;
  67     explicit BranchFolderPass(bool defaultEnableTailMerge)
  68       : MachineFunctionPass(&ID), BranchFolder(defaultEnableTailMerge) {}
  69
  70     virtual bool runOnMachineFunction(MachineFunction &MF);
  71     virtual const char *getPassName() const { return "Control Flow Optimizer"; }
  72   };
  73 }
  74
  75 char BranchFolderPass::ID = 0;
  76
  77 FunctionPass *llvm::createBranchFoldingPass(bool DefaultEnableTailMerge) {
  78   return new BranchFolderPass(DefaultEnableTailMerge);
  79 }
  80
  81 bool BranchFolderPass::runOnMachineFunction(MachineFunction &MF) {
  82   return OptimizeFunction(MF,
  83                           MF.getTarget().getInstrInfo(),
  84                           MF.getTarget().getRegisterInfo(),
  85                           getAnalysisIfAvailable<MachineModuleInfo>());
  86 }
  87
  88
  89 BranchFolder::BranchFolder(bool defaultEnableTailMerge) {
  90   switch (FlagEnableTailMerge) {
  91   case cl::BOU_UNSET: EnableTailMerge = defaultEnableTailMerge; break;
  92   case cl::BOU_TRUE: EnableTailMerge = true; break;
  93   case cl::BOU_FALSE: EnableTailMerge = false; break;
  94   }
  95 }
  96
  97 /// RemoveDeadBlock - Remove the specified dead machine basic block from the
  98 /// function, updating the CFG.
  99 void BranchFolder::RemoveDeadBlock(MachineBasicBlock *MBB) {
 100   assert(MBB->pred_empty() && "MBB must be dead!");
 101   DEBUG(dbgs() << "\nRemoving MBB: " << *MBB);
 102
 103   MachineFunction *MF = MBB->getParent();
 104   // drop all successors.
 105   while (!MBB->succ_empty())
 106     MBB->removeSuccessor(MBB->succ_end()-1);
 107
 108   // If there are any labels in the basic block, unregister them from
 109   // MachineModuleInfo.
 110   if (MMI && !MBB->empty()) {
 111     for (MachineBasicBlock::iterator I = MBB->begin(), E = MBB->end();
 112          I != E; ++I) {
 113       if (I->isLabel())
 114         // The label ID # is always operand #0, an immediate.
 115         MMI->InvalidateLabel(I->getOperand(0).getImm());
 116     }
 117   }
 118
 119   // Remove the block.
 120   MF->erase(MBB);
 121 }
 122
 123 /// OptimizeImpDefsBlock - If a basic block is just a bunch of implicit_def
 124 /// followed by terminators, and if the implicitly defined registers are not
 125 /// used by the terminators, remove those implicit_def's. e.g.
 126 /// BB1:
 127 ///   r0 = implicit_def
 128 ///   r1 = implicit_def
 129 ///   br
 130 /// This block can be optimized away later if the implicit instructions are
 131 /// removed.
 132 bool BranchFolder::OptimizeImpDefsBlock(MachineBasicBlock *MBB) {
 133   SmallSet<unsigned, 4> ImpDefRegs;
 134   MachineBasicBlock::iterator I = MBB->begin();
 135   while (I != MBB->end()) {
 136     if (!I->isImplicitDef())
 137       break;
 138     unsigned Reg = I->getOperand(0).getReg();
 139     ImpDefRegs.insert(Reg);
 140     for (const unsigned *SubRegs = TRI->getSubRegisters(Reg);
 141          unsigned SubReg = *SubRegs; ++SubRegs)
 142       ImpDefRegs.insert(SubReg);
 143     ++I;
 144   }
 145   if (ImpDefRegs.empty())
 146     return false;
 147
 148   MachineBasicBlock::iterator FirstTerm = I;
 149   while (I != MBB->end()) {
 150     if (!TII->isUnpredicatedTerminator(I))
 151       return false;
 152     // See if it uses any of the implicitly defined registers.
 153     for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i) {
 154       MachineOperand &MO = I->getOperand(i);
 155       if (!MO.isReg() || !MO.isUse())
 156         continue;
 157       unsigned Reg = MO.getReg();
 158       if (ImpDefRegs.count(Reg))
 159         return false;
 160     }
 161     ++I;
 162   }
 163
 164   I = MBB->begin();
 165   while (I != FirstTerm) {
 166     MachineInstr *ImpDefMI = &*I;
 167     ++I;
 168     MBB->erase(ImpDefMI);
 169   }
 170
 171   return true;
 172 }
 173
 174 /// OptimizeFunction - Perhaps branch folding, tail merging and other
 175 /// CFG optimizations on the given function.
 176 bool BranchFolder::OptimizeFunction(MachineFunction &MF,
 177                                     const TargetInstrInfo *tii,
 178                                     const TargetRegisterInfo *tri,
 179                                     MachineModuleInfo *mmi) {
 180   if (!tii) return false;
 181
 182   TII = tii;
 183   TRI = tri;
 184   MMI = mmi;
 185
 186   RS = TRI->requiresRegisterScavenging(MF) ? new RegScavenger() : NULL;
 187
 188   // Fix CFG.  The later algorithms expect it to be right.
 189   bool MadeChange = false;
 190   for (MachineFunction::iterator I = MF.begin(), E = MF.end(); I != E; I++) {
 191     MachineBasicBlock *MBB = I, *TBB = 0, *FBB = 0;
 192     SmallVector<MachineOperand, 4> Cond;
 193     if (!TII->AnalyzeBranch(*MBB, TBB, FBB, Cond, true))
 194       MadeChange |= MBB->CorrectExtraCFGEdges(TBB, FBB, !Cond.empty());
 195     MadeChange |= OptimizeImpDefsBlock(MBB);
 196   }
 197
 198   bool MadeChangeThisIteration = true;
 199   while (MadeChangeThisIteration) {
 200     MadeChangeThisIteration = false;
 201     MadeChangeThisIteration |= TailMergeBlocks(MF);
 202     MadeChangeThisIteration |= OptimizeBranches(MF);
 203     MadeChange |= MadeChangeThisIteration;
 204   }
 205
 206   // See if any jump tables have become mergable or dead as the code generator
 207   // did its thing.
 208   MachineJumpTableInfo *JTI = MF.getJumpTableInfo();
 209   if (JTI == 0) {
 210     delete RS;
 211     return MadeChange;
 212   }
 213
 214   const std::vector<MachineJumpTableEntry> &JTs = JTI->getJumpTables();
 215   // Figure out how these jump tables should be merged.
 216   std::vector<unsigned> JTMapping;
 217   JTMapping.reserve(JTs.size());
 218
 219   // We always keep the 0th jump table.
 220   JTMapping.push_back(0);
 221
 222   // Scan the jump tables, seeing if there are any duplicates.  Note that this
 223   // is N^2, which should be fixed someday.
 224   for (unsigned i = 1, e = JTs.size(); i != e; ++i) {
 225     if (JTs[i].MBBs.empty())
 226       JTMapping.push_back(i);
 227     else
 228       JTMapping.push_back(JTI->getJumpTableIndex(JTs[i].MBBs));
 229   }
 230
 231   // If a jump table was merge with another one, walk the function rewriting
 232   // references to jump tables to reference the new JT ID's.  Keep track of
 233   // whether we see a jump table idx, if not, we can delete the JT.
 234   BitVector JTIsLive(JTs.size());
 235   for (MachineFunction::iterator BB = MF.begin(), E = MF.end();
 236        BB != E; ++BB) {
 237     for (MachineBasicBlock::iterator I = BB->begin(), E = BB->end();
 238          I != E; ++I)
 239       for (unsigned op = 0, e = I->getNumOperands(); op != e; ++op) {
 240         MachineOperand &Op = I->getOperand(op);
 241         if (!Op.isJTI()) continue;
 242         unsigned NewIdx = JTMapping[Op.getIndex()];
 243         Op.setIndex(NewIdx);
 244
 245         // Remember that this JT is live.
 246         JTIsLive.set(NewIdx);
 247       }
 248   }
 249
 250   // Finally, remove dead jump tables.  This happens either because the
 251   // indirect jump was unreachable (and thus deleted) or because the jump
 252   // table was merged with some other one.
 253   for (unsigned i = 0, e = JTIsLive.size(); i != e; ++i)
 254     if (!JTIsLive.test(i)) {
 255       JTI->RemoveJumpTable(i);
 256       MadeChange = true;
 257     }
 258
 259   delete RS;
 260   return MadeChange;
 261 }
 262
 263 //===----------------------------------------------------------------------===//
 264 //  Tail Merging of Blocks
 265 //===----------------------------------------------------------------------===//
 266
 267 /// HashMachineInstr - Compute a hash value for MI and its operands.
 268 static unsigned HashMachineInstr(const MachineInstr *MI) {
 269   unsigned Hash = MI->getOpcode();
 270   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 271     const MachineOperand &Op = MI->getOperand(i);
 272
 273     // Merge in bits from the operand if easy.
 274     unsigned OperandHash = 0;
 275     switch (Op.getType()) {
 276     case MachineOperand::MO_Register:          OperandHash = Op.getReg(); break;
 277     case MachineOperand::MO_Immediate:         OperandHash = Op.getImm(); break;
 278     case MachineOperand::MO_MachineBasicBlock:
 279       OperandHash = Op.getMBB()->getNumber();
 280       break;
 281     case MachineOperand::MO_FrameIndex:
 282     case MachineOperand::MO_ConstantPoolIndex:
 283     case MachineOperand::MO_JumpTableIndex:
 284       OperandHash = Op.getIndex();
 285       break;
 286     case MachineOperand::MO_GlobalAddress:
 287     case MachineOperand::MO_ExternalSymbol:
 288       // Global address / external symbol are too hard, don't bother, but do
 289       // pull in the offset.
 290       OperandHash = Op.getOffset();
 291       break;
 292     default: break;
 293     }
 294
 295     Hash += ((OperandHash << 3) | Op.getType()) << (i&31);
 296   }
 297   return Hash;
 298 }
 299
 300 /// HashEndOfMBB - Hash the last few instructions in the MBB.  For blocks
 301 /// with no successors, we hash two instructions, because cross-jumping
 302 /// only saves code when at least two instructions are removed (since a
 303 /// branch must be inserted).  For blocks with a successor, one of the
 304 /// two blocks to be tail-merged will end with a branch already, so
 305 /// it gains to cross-jump even for one instruction.
 306 static unsigned HashEndOfMBB(const MachineBasicBlock *MBB,
 307                              unsigned minCommonTailLength) {
 308   MachineBasicBlock::const_iterator I = MBB->end();
 309   if (I == MBB->begin())
 310     return 0;   // Empty MBB.
 311
 312   --I;
 313   // Skip debug info so it will not affect codegen.
 314   while (I->isDebugValue()) {
 315     if (I==MBB->begin())
 316       return 0;      // MBB empty except for debug info.
 317     --I;
 318   }
 319   unsigned Hash = HashMachineInstr(I);
 320
 321   if (I == MBB->begin() || minCommonTailLength == 1)
 322     return Hash;   // Single instr MBB.
 323
 324   --I;
 325   while (I->isDebugValue()) {
 326     if (I==MBB->begin())
 327       return Hash;      // MBB with single non-debug instr.
 328     --I;
 329   }
 330   // Hash in the second-to-last instruction.
 331   Hash ^= HashMachineInstr(I) << 2;
 332   return Hash;
 333 }
 334
 335 /// ComputeCommonTailLength - Given two machine basic blocks, compute the number
 336 /// of instructions they actually have in common together at their end.  Return
 337 /// iterators for the first shared instruction in each block.
 338 static unsigned ComputeCommonTailLength(MachineBasicBlock *MBB1,
 339                                         MachineBasicBlock *MBB2,
 340                                         MachineBasicBlock::iterator &I1,
 341                                         MachineBasicBlock::iterator &I2) {
 342   I1 = MBB1->end();
 343   I2 = MBB2->end();
 344
 345   unsigned TailLen = 0;
 346   while (I1 != MBB1->begin() && I2 != MBB2->begin()) {
 347     --I1; --I2;
 348     // Skip debugging pseudos; necessary to avoid changing the code.
 349     while (I1->isDebugValue()) {
 350       if (I1==MBB1->begin())
 351         return TailLen;
 352       --I1;
 353     }
 354     while (I2->isDebugValue()) {
 355       if (I2==MBB2->begin())
 356         return TailLen;
 357       --I2;
 358     }
 359     if (!I1->isIdenticalTo(I2) ||
 360         // FIXME: This check is dubious. It's used to get around a problem where
 361         // people incorrectly expect inline asm directives to remain in the same
 362         // relative order. This is untenable because normal compiler
 363         // optimizations (like this one) may reorder and/or merge these
 364         // directives.
 365         I1->isInlineAsm()) {
 366       ++I1; ++I2;
 367       break;
 368     }
 369     ++TailLen;
 370   }
 371   return TailLen;
 372 }
 373
 374 /// ReplaceTailWithBranchTo - Delete the instruction OldInst and everything
 375 /// after it, replacing it with an unconditional branch to NewDest.  This
 376 /// returns true if OldInst's block is modified, false if NewDest is modified.
 377 void BranchFolder::ReplaceTailWithBranchTo(MachineBasicBlock::iterator OldInst,
 378                                            MachineBasicBlock *NewDest) {
 379   MachineBasicBlock *OldBB = OldInst->getParent();
 380
 381   // Remove all the old successors of OldBB from the CFG.
 382   while (!OldBB->succ_empty())
 383     OldBB->removeSuccessor(OldBB->succ_begin());
 384
 385   // Remove all the dead instructions from the end of OldBB.
 386   OldBB->erase(OldInst, OldBB->end());
 387
 388   // If OldBB isn't immediately before OldBB, insert a branch to it.
 389   if (++MachineFunction::iterator(OldBB) != MachineFunction::iterator(NewDest))
 390     TII->InsertBranch(*OldBB, NewDest, 0, SmallVector<MachineOperand, 0>());
 391   OldBB->addSuccessor(NewDest);
 392   ++NumTailMerge;
 393 }
 394
 395 /// SplitMBBAt - Given a machine basic block and an iterator into it, split the
 396 /// MBB so that the part before the iterator falls into the part starting at the
 397 /// iterator.  This returns the new MBB.
 398 MachineBasicBlock *BranchFolder::SplitMBBAt(MachineBasicBlock &CurMBB,
 399                                             MachineBasicBlock::iterator BBI1) {
 400   MachineFunction &MF = *CurMBB.getParent();
 401
 402   // Create the fall-through block.
 403   MachineFunction::iterator MBBI = &CurMBB;
 404   MachineBasicBlock *NewMBB =MF.CreateMachineBasicBlock(CurMBB.getBasicBlock());
 405   CurMBB.getParent()->insert(++MBBI, NewMBB);
 406
 407   // Move all the successors of this block to the specified block.
 408   NewMBB->transferSuccessors(&CurMBB);
 409
 410   // Add an edge from CurMBB to NewMBB for the fall-through.
 411   CurMBB.addSuccessor(NewMBB);
 412
 413   // Splice the code over.
 414   NewMBB->splice(NewMBB->end(), &CurMBB, BBI1, CurMBB.end());
 415
 416   // For targets that use the register scavenger, we must maintain LiveIns.
 417   if (RS) {
 418     RS->enterBasicBlock(&CurMBB);
 419     if (!CurMBB.empty())
 420       RS->forward(prior(CurMBB.end()));
 421     BitVector RegsLiveAtExit(TRI->getNumRegs());
 422     RS->getRegsUsed(RegsLiveAtExit, false);
 423     for (unsigned int i = 0, e = TRI->getNumRegs(); i != e; i++)
 424       if (RegsLiveAtExit[i])
 425         NewMBB->addLiveIn(i);
 426   }
 427
 428   return NewMBB;
 429 }
 430
 431 /// EstimateRuntime - Make a rough estimate for how long it will take to run
 432 /// the specified code.
 433 static unsigned EstimateRuntime(MachineBasicBlock::iterator I,
 434                                 MachineBasicBlock::iterator E) {
 435   unsigned Time = 0;
 436   for (; I != E; ++I) {
 437     if (I->isDebugValue())
 438       continue;
 439     const TargetInstrDesc &TID = I->getDesc();
 440     if (TID.isCall())
 441       Time += 10;
 442     else if (TID.mayLoad() || TID.mayStore())
 443       Time += 2;
 444     else
 445       ++Time;
 446   }
 447   return Time;
 448 }
 449
 450 // CurMBB needs to add an unconditional branch to SuccMBB (we removed these
 451 // branches temporarily for tail merging).  In the case where CurMBB ends
 452 // with a conditional branch to the next block, optimize by reversing the
 453 // test and conditionally branching to SuccMBB instead.
 454 static void FixTail(MachineBasicBlock *CurMBB, MachineBasicBlock *SuccBB,
 455                     const TargetInstrInfo *TII) {
 456   MachineFunction *MF = CurMBB->getParent();
 457   MachineFunction::iterator I = llvm::next(MachineFunction::iterator(CurMBB));
 458   MachineBasicBlock *TBB = 0, *FBB = 0;
 459   SmallVector<MachineOperand, 4> Cond;
 460   if (I != MF->end() &&
 461       !TII->AnalyzeBranch(*CurMBB, TBB, FBB, Cond, true)) {
 462     MachineBasicBlock *NextBB = I;
 463     if (TBB == NextBB && !Cond.empty() && !FBB) {
 464       if (!TII->ReverseBranchCondition(Cond)) {
 465         TII->RemoveBranch(*CurMBB);
 466         TII->InsertBranch(*CurMBB, SuccBB, NULL, Cond);
 467         return;
 468       }
 469     }
 470   }
 471   TII->InsertBranch(*CurMBB, SuccBB, NULL, SmallVector<MachineOperand, 0>());
 472 }
 473
 474 bool
 475 BranchFolder::MergePotentialsElt::operator<(const MergePotentialsElt &o) const {
 476   if (getHash() < o.getHash())
 477     return true;
 478    else if (getHash() > o.getHash())
 479     return false;
 480   else if (getBlock()->getNumber() < o.getBlock()->getNumber())
 481     return true;
 482   else if (getBlock()->getNumber() > o.getBlock()->getNumber())
 483     return false;
 484   else {
 485     // _GLIBCXX_DEBUG checks strict weak ordering, which involves comparing
 486     // an object with itself.
 487 #ifndef _GLIBCXX_DEBUG
 488     llvm_unreachable("Predecessor appears twice");
 489 #endif
 490     return false;
 491   }
 492 }
 493
 494 /// CountTerminators - Count the number of terminators in the given
 495 /// block and set I to the position of the first non-terminator, if there
 496 /// is one, or MBB->end() otherwise.
 497 static unsigned CountTerminators(MachineBasicBlock *MBB,
 498                                  MachineBasicBlock::iterator &I) {
 499   I = MBB->end();
 500   unsigned NumTerms = 0;
 501   for (;;) {
 502     if (I == MBB->begin()) {
 503       I = MBB->end();
 504       break;
 505     }
 506     --I;
 507     if (!I->getDesc().isTerminator()) break;
 508     ++NumTerms;
 509   }
 510   return NumTerms;
 511 }
 512
 513 /// ProfitableToMerge - Check if two machine basic blocks have a common tail
 514 /// and decide if it would be profitable to merge those tails.  Return the
 515 /// length of the common tail and iterators to the first common instruction
 516 /// in each block.
 517 static bool ProfitableToMerge(MachineBasicBlock *MBB1,
 518                               MachineBasicBlock *MBB2,
 519                               unsigned minCommonTailLength,
 520                               unsigned &CommonTailLen,
 521                               MachineBasicBlock::iterator &I1,
 522                               MachineBasicBlock::iterator &I2,
 523                               MachineBasicBlock *SuccBB,
 524                               MachineBasicBlock *PredBB) {
 525   CommonTailLen = ComputeCommonTailLength(MBB1, MBB2, I1, I2);
 526   MachineFunction *MF = MBB1->getParent();
 527
 528   if (CommonTailLen == 0)
 529     return false;
 530
 531   // It's almost always profitable to merge any number of non-terminator
 532   // instructions with the block that falls through into the common successor.
 533   if (MBB1 == PredBB || MBB2 == PredBB) {
 534     MachineBasicBlock::iterator I;
 535     unsigned NumTerms = CountTerminators(MBB1 == PredBB ? MBB2 : MBB1, I);
 536     if (CommonTailLen > NumTerms)
 537       return true;
 538   }
 539
 540   // If one of the blocks can be completely merged and happens to be in
 541   // a position where the other could fall through into it, merge any number
 542   // of instructions, because it can be done without a branch.
 543   // TODO: If the blocks are not adjacent, move one of them so that they are?
 544   if (MBB1->isLayoutSuccessor(MBB2) && I2 == MBB2->begin())
 545     return true;
 546   if (MBB2->isLayoutSuccessor(MBB1) && I1 == MBB1->begin())
 547     return true;
 548
 549   // If both blocks have an unconditional branch temporarily stripped out,
 550   // count that as an additional common instruction for the following
 551   // heuristics.
 552   unsigned EffectiveTailLen = CommonTailLen;
 553   if (SuccBB && MBB1 != PredBB && MBB2 != PredBB &&
 554       !MBB1->back().getDesc().isBarrier() &&
 555       !MBB2->back().getDesc().isBarrier())
 556     ++EffectiveTailLen;
 557
 558   // Check if the common tail is long enough to be worthwhile.
 559   if (EffectiveTailLen >= minCommonTailLength)
 560     return true;
 561
 562   // If we are optimizing for code size, 2 instructions in common is enough if
 563   // we don't have to split a block.  At worst we will be introducing 1 new
 564   // branch instruction, which is likely to be smaller than the 2
 565   // instructions that would be deleted in the merge.
 566   if (EffectiveTailLen >= 2 &&
 567       MF->getFunction()->hasFnAttr(Attribute::OptimizeForSize) &&
 568       (I1 == MBB1->begin() || I2 == MBB2->begin()))
 569     return true;
 570
 571   return false;
 572 }
 573
 574 /// ComputeSameTails - Look through all the blocks in MergePotentials that have
 575 /// hash CurHash (guaranteed to match the last element).  Build the vector
 576 /// SameTails of all those that have the (same) largest number of instructions
 577 /// in common of any pair of these blocks.  SameTails entries contain an
 578 /// iterator into MergePotentials (from which the MachineBasicBlock can be
 579 /// found) and a MachineBasicBlock::iterator into that MBB indicating the
 580 /// instruction where the matching code sequence begins.
 581 /// Order of elements in SameTails is the reverse of the order in which
 582 /// those blocks appear in MergePotentials (where they are not necessarily
 583 /// consecutive).
 584 unsigned BranchFolder::ComputeSameTails(unsigned CurHash,
 585                                         unsigned minCommonTailLength,
 586                                         MachineBasicBlock *SuccBB,
 587                                         MachineBasicBlock *PredBB) {
 588   unsigned maxCommonTailLength = 0U;
 589   SameTails.clear();
 590   MachineBasicBlock::iterator TrialBBI1, TrialBBI2;
 591   MPIterator HighestMPIter = prior(MergePotentials.end());
 592   for (MPIterator CurMPIter = prior(MergePotentials.end()),
 593                   B = MergePotentials.begin();
 594        CurMPIter != B && CurMPIter->getHash() == CurHash;
 595        --CurMPIter) {
 596     for (MPIterator I = prior(CurMPIter); I->getHash() == CurHash ; --I) {
 597       unsigned CommonTailLen;
 598       if (ProfitableToMerge(CurMPIter->getBlock(), I->getBlock(),
 599                             minCommonTailLength,
 600                             CommonTailLen, TrialBBI1, TrialBBI2,
 601                             SuccBB, PredBB)) {
 602         if (CommonTailLen > maxCommonTailLength) {
 603           SameTails.clear();
 604           maxCommonTailLength = CommonTailLen;
 605           HighestMPIter = CurMPIter;
 606           SameTails.push_back(SameTailElt(CurMPIter, TrialBBI1));
 607         }
 608         if (HighestMPIter == CurMPIter &&
 609             CommonTailLen == maxCommonTailLength)
 610           SameTails.push_back(SameTailElt(I, TrialBBI2));
 611       }
 612       if (I == B)
 613         break;
 614     }
 615   }
 616   return maxCommonTailLength;
 617 }
 618
 619 /// RemoveBlocksWithHash - Remove all blocks with hash CurHash from
 620 /// MergePotentials, restoring branches at ends of blocks as appropriate.
 621 void BranchFolder::RemoveBlocksWithHash(unsigned CurHash,
 622                                         MachineBasicBlock *SuccBB,
 623                                         MachineBasicBlock *PredBB) {
 624   MPIterator CurMPIter, B;
 625   for (CurMPIter = prior(MergePotentials.end()), B = MergePotentials.begin();
 626        CurMPIter->getHash() == CurHash;
 627        --CurMPIter) {
 628     // Put the unconditional branch back, if we need one.
 629     MachineBasicBlock *CurMBB = CurMPIter->getBlock();
 630     if (SuccBB && CurMBB != PredBB)
 631       FixTail(CurMBB, SuccBB, TII);
 632     if (CurMPIter == B)
 633       break;
 634   }
 635   if (CurMPIter->getHash() != CurHash)
 636     CurMPIter++;
 637   MergePotentials.erase(CurMPIter, MergePotentials.end());
 638 }
 639
 640 /// CreateCommonTailOnlyBlock - None of the blocks to be tail-merged consist
 641 /// only of the common tail.  Create a block that does by splitting one.
 642 unsigned BranchFolder::CreateCommonTailOnlyBlock(MachineBasicBlock *&PredBB,
 643                                              unsigned maxCommonTailLength) {
 644   unsigned commonTailIndex = 0;
 645   unsigned TimeEstimate = ~0U;
 646   for (unsigned i = 0, e = SameTails.size(); i != e; ++i) {
 647     // Use PredBB if possible; that doesn't require a new branch.
 648     if (SameTails[i].getBlock() == PredBB) {
 649       commonTailIndex = i;
 650       break;
 651     }
 652     // Otherwise, make a (fairly bogus) choice based on estimate of
 653     // how long it will take the various blocks to execute.
 654     unsigned t = EstimateRuntime(SameTails[i].getBlock()->begin(),
 655                                  SameTails[i].getTailStartPos());
 656     if (t <= TimeEstimate) {
 657       TimeEstimate = t;
 658       commonTailIndex = i;
 659     }
 660   }
 661
 662   MachineBasicBlock::iterator BBI =
 663     SameTails[commonTailIndex].getTailStartPos();
 664   MachineBasicBlock *MBB = SameTails[commonTailIndex].getBlock();
 665
 666   // If the common tail includes any debug info we will take it pretty
 667   // randomly from one of the inputs.  Might be better to remove it?
 668   DEBUG(dbgs() << "\nSplitting BB#" << MBB->getNumber() << ", size "
 669                << maxCommonTailLength);
 670
 671   MachineBasicBlock *newMBB = SplitMBBAt(*MBB, BBI);
 672   SameTails[commonTailIndex].setBlock(newMBB);
 673   SameTails[commonTailIndex].setTailStartPos(newMBB->begin());
 674
 675   // If we split PredBB, newMBB is the new predecessor.
 676   if (PredBB == MBB)
 677     PredBB = newMBB;
 678
 679   return commonTailIndex;
 680 }
 681
 682 // See if any of the blocks in MergePotentials (which all have a common single
 683 // successor, or all have no successor) can be tail-merged.  If there is a
 684 // successor, any blocks in MergePotentials that are not tail-merged and
 685 // are not immediately before Succ must have an unconditional branch to
 686 // Succ added (but the predecessor/successor lists need no adjustment).
 687 // The lone predecessor of Succ that falls through into Succ,
 688 // if any, is given in PredBB.
 689
 690 bool BranchFolder::TryTailMergeBlocks(MachineBasicBlock *SuccBB,
 691                                       MachineBasicBlock *PredBB) {
 692   bool MadeChange = false;
 693
 694   // Except for the special cases below, tail-merge if there are at least
 695   // this many instructions in common.
 696   unsigned minCommonTailLength = TailMergeSize;
 697
 698   DEBUG(dbgs() << "\nTryTailMergeBlocks: ";
 699         for (unsigned i = 0, e = MergePotentials.size(); i != e; ++i)
 700           dbgs() << "BB#" << MergePotentials[i].getBlock()->getNumber()
 701                  << (i == e-1 ? "" : ", ");
 702         dbgs() << "\n";
 703         if (SuccBB) {
 704           dbgs() << "  with successor BB#" << SuccBB->getNumber() << '\n';
 705           if (PredBB)
 706             dbgs() << "  which has fall-through from BB#"
 707                    << PredBB->getNumber() << "\n";
 708         }
 709         dbgs() << "Looking for common tails of at least "
 710                << minCommonTailLength << " instruction"
 711                << (minCommonTailLength == 1 ? "" : "s") << '\n';
 712        );
 713
 714   // Sort by hash value so that blocks with identical end sequences sort
 715   // together.
 716   std::stable_sort(MergePotentials.begin(), MergePotentials.end());
 717
 718   // Walk through equivalence sets looking for actual exact matches.
 719   while (MergePotentials.size() > 1) {
 720     unsigned CurHash = MergePotentials.back().getHash();
 721
 722     // Build SameTails, identifying the set of blocks with this hash code
 723     // and with the maximum number of instructions in common.
 724     unsigned maxCommonTailLength = ComputeSameTails(CurHash,
 725                                                     minCommonTailLength,
 726                                                     SuccBB, PredBB);
 727
 728     // If we didn't find any pair that has at least minCommonTailLength
 729     // instructions in common, remove all blocks with this hash code and retry.
 730     if (SameTails.empty()) {
 731       RemoveBlocksWithHash(CurHash, SuccBB, PredBB);
 732       continue;
 733     }
 734
 735     // If one of the blocks is the entire common tail (and not the entry
 736     // block, which we can't jump to), we can treat all blocks with this same
 737     // tail at once.  Use PredBB if that is one of the possibilities, as that
 738     // will not introduce any extra branches.
 739     MachineBasicBlock *EntryBB = MergePotentials.begin()->getBlock()->
 740                                  getParent()->begin();
 741     unsigned commonTailIndex = SameTails.size();
 742     // If there are two blocks, check to see if one can be made to fall through
 743     // into the other.
 744     if (SameTails.size() == 2 &&
 745         SameTails[0].getBlock()->isLayoutSuccessor(SameTails[1].getBlock()) &&
 746         SameTails[1].tailIsWholeBlock())
 747       commonTailIndex = 1;
 748     else if (SameTails.size() == 2 &&
 749              SameTails[1].getBlock()->isLayoutSuccessor(
 750                                                      SameTails[0].getBlock()) &&
 751              SameTails[0].tailIsWholeBlock())
 752       commonTailIndex = 0;
 753     else {
 754       // Otherwise just pick one, favoring the fall-through predecessor if
 755       // there is one.
 756       for (unsigned i = 0, e = SameTails.size(); i != e; ++i) {
 757         MachineBasicBlock *MBB = SameTails[i].getBlock();
 758         if (MBB == EntryBB && SameTails[i].tailIsWholeBlock())
 759           continue;
 760         if (MBB == PredBB) {
 761           commonTailIndex = i;
 762           break;
 763         }
 764         if (SameTails[i].tailIsWholeBlock())
 765           commonTailIndex = i;
 766       }
 767     }
 768
 769     if (commonTailIndex == SameTails.size() ||
 770         (SameTails[commonTailIndex].getBlock() == PredBB &&
 771          !SameTails[commonTailIndex].tailIsWholeBlock())) {
 772       // None of the blocks consist entirely of the common tail.
 773       // Split a block so that one does.
 774       commonTailIndex = CreateCommonTailOnlyBlock(PredBB, maxCommonTailLength);
 775     }
 776
 777     MachineBasicBlock *MBB = SameTails[commonTailIndex].getBlock();
 778     // MBB is common tail.  Adjust all other BB's to jump to this one.
 779     // Traversal must be forwards so erases work.
 780     DEBUG(dbgs() << "\nUsing common tail in BB#" << MBB->getNumber()
 781                  << " for ");
 782     for (unsigned int i=0, e = SameTails.size(); i != e; ++i) {
 783       if (commonTailIndex == i)
 784         continue;
 785       DEBUG(dbgs() << "BB#" << SameTails[i].getBlock()->getNumber()
 786                    << (i == e-1 ? "" : ", "));
 787       // Hack the end off BB i, making it jump to BB commonTailIndex instead.
 788       ReplaceTailWithBranchTo(SameTails[i].getTailStartPos(), MBB);
 789       // BB i is no longer a predecessor of SuccBB; remove it from the worklist.
 790       MergePotentials.erase(SameTails[i].getMPIter());
 791     }
 792     DEBUG(dbgs() << "\n");
 793     // We leave commonTailIndex in the worklist in case there are other blocks
 794     // that match it with a smaller number of instructions.
 795     MadeChange = true;
 796   }
 797   return MadeChange;
 798 }
 799
 800 bool BranchFolder::TailMergeBlocks(MachineFunction &MF) {
 801
 802   if (!EnableTailMerge) return false;
 803
 804   bool MadeChange = false;
 805
 806   // First find blocks with no successors.
 807   MergePotentials.clear();
 808   for (MachineFunction::iterator I = MF.begin(), E = MF.end(); I != E; ++I) {
 809     if (I->succ_empty())
 810       MergePotentials.push_back(MergePotentialsElt(HashEndOfMBB(I, 2U), I));
 811   }
 812
 813   // See if we can do any tail merging on those.
 814   if (MergePotentials.size() < TailMergeThreshold &&
 815       MergePotentials.size() >= 2)
 816     MadeChange |= TryTailMergeBlocks(NULL, NULL);
 817
 818   // Look at blocks (IBB) with multiple predecessors (PBB).
 819   // We change each predecessor to a canonical form, by
 820   // (1) temporarily removing any unconditional branch from the predecessor
 821   // to IBB, and
 822   // (2) alter conditional branches so they branch to the other block
 823   // not IBB; this may require adding back an unconditional branch to IBB
 824   // later, where there wasn't one coming in.  E.g.
 825   //   Bcc IBB
 826   //   fallthrough to QBB
 827   // here becomes
 828   //   Bncc QBB
 829   // with a conceptual B to IBB after that, which never actually exists.
 830   // With those changes, we see whether the predecessors' tails match,
 831   // and merge them if so.  We change things out of canonical form and
 832   // back to the way they were later in the process.  (OptimizeBranches
 833   // would undo some of this, but we can't use it, because we'd get into
 834   // a compile-time infinite loop repeatedly doing and undoing the same
 835   // transformations.)
 836
 837   for (MachineFunction::iterator I = llvm::next(MF.begin()), E = MF.end();
 838        I != E; ++I) {
 839     if (I->pred_size() >= 2 && I->pred_size() < TailMergeThreshold) {
 840       SmallPtrSet<MachineBasicBlock *, 8> UniquePreds;
 841       MachineBasicBlock *IBB = I;
 842       MachineBasicBlock *PredBB = prior(I);
 843       MergePotentials.clear();
 844       for (MachineBasicBlock::pred_iterator P = I->pred_begin(),
 845                                             E2 = I->pred_end();
 846            P != E2; ++P) {
 847         MachineBasicBlock *PBB = *P;
 848         // Skip blocks that loop to themselves, can't tail merge these.
 849         if (PBB == IBB)
 850           continue;
 851         // Visit each predecessor only once.
 852         if (!UniquePreds.insert(PBB))
 853           continue;
 854         MachineBasicBlock *TBB = 0, *FBB = 0;
 855         SmallVector<MachineOperand, 4> Cond;
 856         if (!TII->AnalyzeBranch(*PBB, TBB, FBB, Cond, true)) {
 857           // Failing case:  IBB is the target of a cbr, and
 858           // we cannot reverse the branch.
 859           SmallVector<MachineOperand, 4> NewCond(Cond);
 860           if (!Cond.empty() && TBB == IBB) {
 861             if (TII->ReverseBranchCondition(NewCond))
 862               continue;
 863             // This is the QBB case described above
 864             if (!FBB)
 865               FBB = llvm::next(MachineFunction::iterator(PBB));
 866           }
 867           // Failing case:  the only way IBB can be reached from PBB is via
 868           // exception handling.  Happens for landing pads.  Would be nice
 869           // to have a bit in the edge so we didn't have to do all this.
 870           if (IBB->isLandingPad()) {
 871             MachineFunction::iterator IP = PBB;  IP++;
 872             MachineBasicBlock *PredNextBB = NULL;
 873             if (IP != MF.end())
 874               PredNextBB = IP;
 875             if (TBB == NULL) {
 876               if (IBB != PredNextBB)      // fallthrough
 877                 continue;
 878             } else if (FBB) {
 879               if (TBB != IBB && FBB != IBB)   // cbr then ubr
 880                 continue;
 881             } else if (Cond.empty()) {
 882               if (TBB != IBB)               // ubr
 883                 continue;
 884             } else {
 885               if (TBB != IBB && IBB != PredNextBB)  // cbr
 886                 continue;
 887             }
 888           }
 889           // Remove the unconditional branch at the end, if any.
 890           if (TBB && (Cond.empty() || FBB)) {
 891             TII->RemoveBranch(*PBB);
 892             if (!Cond.empty())
 893               // reinsert conditional branch only, for now
 894               TII->InsertBranch(*PBB, (TBB == IBB) ? FBB : TBB, 0, NewCond);
 895           }
 896           MergePotentials.push_back(MergePotentialsElt(HashEndOfMBB(PBB, 1U),
 897                                                        *P));
 898         }
 899       }
 900       if (MergePotentials.size() >= 2)
 901         MadeChange |= TryTailMergeBlocks(IBB, PredBB);
 902       // Reinsert an unconditional branch if needed.
 903       // The 1 below can occur as a result of removing blocks in TryTailMergeBlocks.
 904       PredBB = prior(I);      // this may have been changed in TryTailMergeBlocks
 905       if (MergePotentials.size() == 1 &&
 906           MergePotentials.begin()->getBlock() != PredBB)
 907         FixTail(MergePotentials.begin()->getBlock(), IBB, TII);
 908     }
 909   }
 910   return MadeChange;
 911 }
 912
 913 //===----------------------------------------------------------------------===//
 914 //  Branch Optimization
 915 //===----------------------------------------------------------------------===//
 916
 917 bool BranchFolder::OptimizeBranches(MachineFunction &MF) {
 918   bool MadeChange = false;
 919
 920   // Make sure blocks are numbered in order
 921   MF.RenumberBlocks();
 922
 923   for (MachineFunction::iterator I = ++MF.begin(), E = MF.end(); I != E; ) {
 924     MachineBasicBlock *MBB = I++;
 925     MadeChange |= OptimizeBlock(MBB);
 926
 927     // If it is dead, remove it.
 928     if (MBB->pred_empty()) {
 929       RemoveDeadBlock(MBB);
 930       MadeChange = true;
 931       ++NumDeadBlocks;
 932     }
 933   }
 934   return MadeChange;
 935 }
 936
 937
 938 /// IsBetterFallthrough - Return true if it would be clearly better to
 939 /// fall-through to MBB1 than to fall through into MBB2.  This has to return
 940 /// a strict ordering, returning true for both (MBB1,MBB2) and (MBB2,MBB1) will
 941 /// result in infinite loops.
 942 static bool IsBetterFallthrough(MachineBasicBlock *MBB1,
 943                                 MachineBasicBlock *MBB2) {
 944   // Right now, we use a simple heuristic.  If MBB2 ends with a call, and
 945   // MBB1 doesn't, we prefer to fall through into MBB1.  This allows us to
 946   // optimize branches that branch to either a return block or an assert block
 947   // into a fallthrough to the return.
 948   if (MBB1->empty() || MBB2->empty()) return false;
 949
 950   // If there is a clear successor ordering we make sure that one block
 951   // will fall through to the next
 952   if (MBB1->isSuccessor(MBB2)) return true;
 953   if (MBB2->isSuccessor(MBB1)) return false;
 954
 955   MachineInstr *MBB1I = --MBB1->end();
 956   MachineInstr *MBB2I = --MBB2->end();
 957   return MBB2I->getDesc().isCall() && !MBB1I->getDesc().isCall();
 958 }
 959
 960 /// OptimizeBlock - Analyze and optimize control flow related to the specified
 961 /// block.  This is never called on the entry block.
 962 bool BranchFolder::OptimizeBlock(MachineBasicBlock *MBB) {
 963   bool MadeChange = false;
 964   MachineFunction &MF = *MBB->getParent();
 965 ReoptimizeBlock:
 966
 967   MachineFunction::iterator FallThrough = MBB;
 968   ++FallThrough;
 969
 970   // If this block is empty, make everyone use its fall-through, not the block
 971   // explicitly.  Landing pads should not do this since the landing-pad table
 972   // points to this block.  Blocks with their addresses taken shouldn't be
 973   // optimized away.
 974   if (MBB->empty() && !MBB->isLandingPad() && !MBB->hasAddressTaken()) {
 975     // Dead block?  Leave for cleanup later.
 976     if (MBB->pred_empty()) return MadeChange;
 977
 978     if (FallThrough == MF.end()) {
 979       // TODO: Simplify preds to not branch here if possible!
 980     } else {
 981       // Rewrite all predecessors of the old block to go to the fallthrough
 982       // instead.
 983       while (!MBB->pred_empty()) {
 984         MachineBasicBlock *Pred = *(MBB->pred_end()-1);
 985         Pred->ReplaceUsesOfBlockWith(MBB, FallThrough);
 986       }
 987       // If MBB was the target of a jump table, update jump tables to go to the
 988       // fallthrough instead.
 989       if (MachineJumpTableInfo *MJTI = MF.getJumpTableInfo())
 990         MJTI->ReplaceMBBInJumpTables(MBB, FallThrough);
 991       MadeChange = true;
 992     }
 993     return MadeChange;
 994   }
 995
 996   // Check to see if we can simplify the terminator of the block before this
 997   // one.
 998   MachineBasicBlock &PrevBB = *prior(MachineFunction::iterator(MBB));
 999
1000   MachineBasicBlock *PriorTBB = 0, *PriorFBB = 0;
1001   SmallVector<MachineOperand, 4> PriorCond;
1002   bool PriorUnAnalyzable =
1003     TII->AnalyzeBranch(PrevBB, PriorTBB, PriorFBB, PriorCond, true);
1004   if (!PriorUnAnalyzable) {
1005     // If the CFG for the prior block has extra edges, remove them.
1006     MadeChange |= PrevBB.CorrectExtraCFGEdges(PriorTBB, PriorFBB,
1007                                               !PriorCond.empty());
1008
1009     // If the previous branch is conditional and both conditions go to the same
1010     // destination, remove the branch, replacing it with an unconditional one or
1011     // a fall-through.
1012     if (PriorTBB && PriorTBB == PriorFBB) {
1013       TII->RemoveBranch(PrevBB);
1014       PriorCond.clear();
1015       if (PriorTBB != MBB)
1016         TII->InsertBranch(PrevBB, PriorTBB, 0, PriorCond);
1017       MadeChange = true;
1018       ++NumBranchOpts;
1019       goto ReoptimizeBlock;
1020     }
1021
1022     // If the previous block unconditionally falls through to this block and
1023     // this block has no other predecessors, move the contents of this block
1024     // into the prior block. This doesn't usually happen when SimplifyCFG
1025     // has been used, but it can happen if tail merging splits a fall-through
1026     // predecessor of a block.
1027     // This has to check PrevBB->succ_size() because EH edges are ignored by
1028     // AnalyzeBranch.
1029     if (PriorCond.empty() && !PriorTBB && MBB->pred_size() == 1 &&
1030         PrevBB.succ_size() == 1 &&
1031         !MBB->hasAddressTaken()) {
1032       DEBUG(dbgs() << "\nMerging into block: " << PrevBB
1033                    << "From MBB: " << *MBB);
1034       PrevBB.splice(PrevBB.end(), MBB, MBB->begin(), MBB->end());
1035       PrevBB.removeSuccessor(PrevBB.succ_begin());;
1036       assert(PrevBB.succ_empty());
1037       PrevBB.transferSuccessors(MBB);
1038       MadeChange = true;
1039       return MadeChange;
1040     }
1041
1042     // If the previous branch *only* branches to *this* block (conditional or
1043     // not) remove the branch.
1044     if (PriorTBB == MBB && PriorFBB == 0) {
1045       TII->RemoveBranch(PrevBB);
1046       MadeChange = true;
1047       ++NumBranchOpts;
1048       goto ReoptimizeBlock;
1049     }
1050
1051     // If the prior block branches somewhere else on the condition and here if
1052     // the condition is false, remove the uncond second branch.
1053     if (PriorFBB == MBB) {
1054       TII->RemoveBranch(PrevBB);
1055       TII->InsertBranch(PrevBB, PriorTBB, 0, PriorCond);
1056       MadeChange = true;
1057       ++NumBranchOpts;
1058       goto ReoptimizeBlock;
1059     }
1060
1061     // If the prior block branches here on true and somewhere else on false, and
1062     // if the branch condition is reversible, reverse the branch to create a
1063     // fall-through.
1064     if (PriorTBB == MBB) {
1065       SmallVector<MachineOperand, 4> NewPriorCond(PriorCond);
1066       if (!TII->ReverseBranchCondition(NewPriorCond)) {
1067         TII->RemoveBranch(PrevBB);
1068         TII->InsertBranch(PrevBB, PriorFBB, 0, NewPriorCond);
1069         MadeChange = true;
1070         ++NumBranchOpts;
1071         goto ReoptimizeBlock;
1072       }
1073     }
1074
1075     // If this block has no successors (e.g. it is a return block or ends with
1076     // a call to a no-return function like abort or __cxa_throw) and if the pred
1077     // falls through into this block, and if it would otherwise fall through
1078     // into the block after this, move this block to the end of the function.
1079     //
1080     // We consider it more likely that execution will stay in the function (e.g.
1081     // due to loops) than it is to exit it.  This asserts in loops etc, moving
1082     // the assert condition out of the loop body.
1083     if (MBB->succ_empty() && !PriorCond.empty() && PriorFBB == 0 &&
1084         MachineFunction::iterator(PriorTBB) == FallThrough &&
1085         !MBB->canFallThrough()) {
1086       bool DoTransform = true;
1087
1088       // We have to be careful that the succs of PredBB aren't both no-successor
1089       // blocks.  If neither have successors and if PredBB is the second from
1090       // last block in the function, we'd just keep swapping the two blocks for
1091       // last.  Only do the swap if one is clearly better to fall through than
1092       // the other.
1093       if (FallThrough == --MF.end() &&
1094           !IsBetterFallthrough(PriorTBB, MBB))
1095         DoTransform = false;
1096
1097       // We don't want to do this transformation if we have control flow like:
1098       //   br cond BB2
1099       // BB1:
1100       //   ..
1101       //   jmp BBX
1102       // BB2:
1103       //   ..
1104       //   ret
1105       //
1106       // In this case, we could actually be moving the return block *into* a
1107       // loop!
1108       if (DoTransform && !MBB->succ_empty() &&
1109           (!PriorTBB->canFallThrough() || PriorTBB->empty()))
1110         DoTransform = false;
1111
1112
1113       if (DoTransform) {
1114         // Reverse the branch so we will fall through on the previous true cond.
1115         SmallVector<MachineOperand, 4> NewPriorCond(PriorCond);
1116         if (!TII->ReverseBranchCondition(NewPriorCond)) {
1117           DEBUG(dbgs() << "\nMoving MBB: " << *MBB
1118                        << "To make fallthrough to: " << *PriorTBB << "\n");
1119
1120           TII->RemoveBranch(PrevBB);
1121           TII->InsertBranch(PrevBB, MBB, 0, NewPriorCond);
1122
1123           // Move this block to the end of the function.
1124           MBB->moveAfter(--MF.end());
1125           MadeChange = true;
1126           ++NumBranchOpts;
1127           return MadeChange;
1128         }
1129       }
1130     }
1131   }
1132
1133   // Analyze the branch in the current block.
1134   MachineBasicBlock *CurTBB = 0, *CurFBB = 0;
1135   SmallVector<MachineOperand, 4> CurCond;
1136   bool CurUnAnalyzable= TII->AnalyzeBranch(*MBB, CurTBB, CurFBB, CurCond, true);
1137   if (!CurUnAnalyzable) {
1138     // If the CFG for the prior block has extra edges, remove them.
1139     MadeChange |= MBB->CorrectExtraCFGEdges(CurTBB, CurFBB, !CurCond.empty());
1140
1141     // If this is a two-way branch, and the FBB branches to this block, reverse
1142     // the condition so the single-basic-block loop is faster.  Instead of:
1143     //    Loop: xxx; jcc Out; jmp Loop
1144     // we want:
1145     //    Loop: xxx; jncc Loop; jmp Out
1146     if (CurTBB && CurFBB && CurFBB == MBB && CurTBB != MBB) {
1147       SmallVector<MachineOperand, 4> NewCond(CurCond);
1148       if (!TII->ReverseBranchCondition(NewCond)) {
1149         TII->RemoveBranch(*MBB);
1150         TII->InsertBranch(*MBB, CurFBB, CurTBB, NewCond);
1151         MadeChange = true;
1152         ++NumBranchOpts;
1153         goto ReoptimizeBlock;
1154       }
1155     }
1156
1157     // If this branch is the only thing in its block, see if we can forward
1158     // other blocks across it.
1159     if (CurTBB && CurCond.empty() && CurFBB == 0 &&
1160         MBB->begin()->getDesc().isBranch() && CurTBB != MBB &&
1161         !MBB->hasAddressTaken()) {
1162       // This block may contain just an unconditional branch.  Because there can
1163       // be 'non-branch terminators' in the block, try removing the branch and
1164       // then seeing if the block is empty.
1165       TII->RemoveBranch(*MBB);
1166
1167       // If this block is just an unconditional branch to CurTBB, we can
1168       // usually completely eliminate the block.  The only case we cannot
1169       // completely eliminate the block is when the block before this one
1170       // falls through into MBB and we can't understand the prior block's branch
1171       // condition.
1172       if (MBB->empty()) {
1173         bool PredHasNoFallThrough = !PrevBB.canFallThrough();
1174         if (PredHasNoFallThrough || !PriorUnAnalyzable ||
1175             !PrevBB.isSuccessor(MBB)) {
1176           // If the prior block falls through into us, turn it into an
1177           // explicit branch to us to make updates simpler.
1178           if (!PredHasNoFallThrough && PrevBB.isSuccessor(MBB) &&
1179               PriorTBB != MBB && PriorFBB != MBB) {
1180             if (PriorTBB == 0) {
1181               assert(PriorCond.empty() && PriorFBB == 0 &&
1182                      "Bad branch analysis");
1183               PriorTBB = MBB;
1184             } else {
1185               assert(PriorFBB == 0 && "Machine CFG out of date!");
1186               PriorFBB = MBB;
1187             }
1188             TII->RemoveBranch(PrevBB);
1189             TII->InsertBranch(PrevBB, PriorTBB, PriorFBB, PriorCond);
1190           }
1191
1192           // Iterate through all the predecessors, revectoring each in-turn.
1193           size_t PI = 0;
1194           bool DidChange = false;
1195           bool HasBranchToSelf = false;
1196           while(PI != MBB->pred_size()) {
1197             MachineBasicBlock *PMBB = *(MBB->pred_begin() + PI);
1198             if (PMBB == MBB) {
1199               // If this block has an uncond branch to itself, leave it.
1200               ++PI;
1201               HasBranchToSelf = true;
1202             } else {
1203               DidChange = true;
1204               PMBB->ReplaceUsesOfBlockWith(MBB, CurTBB);
1205               // If this change resulted in PMBB ending in a conditional
1206               // branch where both conditions go to the same destination,
1207               // change this to an unconditional branch (and fix the CFG).
1208               MachineBasicBlock *NewCurTBB = 0, *NewCurFBB = 0;
1209               SmallVector<MachineOperand, 4> NewCurCond;
1210               bool NewCurUnAnalyzable = TII->AnalyzeBranch(*PMBB, NewCurTBB,
1211                       NewCurFBB, NewCurCond, true);
1212               if (!NewCurUnAnalyzable && NewCurTBB && NewCurTBB == NewCurFBB) {
1213                 TII->RemoveBranch(*PMBB);
1214                 NewCurCond.clear();
1215                 TII->InsertBranch(*PMBB, NewCurTBB, 0, NewCurCond);
1216                 MadeChange = true;
1217                 ++NumBranchOpts;
1218                 PMBB->CorrectExtraCFGEdges(NewCurTBB, 0, false);
1219               }
1220             }
1221           }
1222
1223           // Change any jumptables to go to the new MBB.
1224           if (MachineJumpTableInfo *MJTI = MF.getJumpTableInfo())
1225             MJTI->ReplaceMBBInJumpTables(MBB, CurTBB);
1226           if (DidChange) {
1227             ++NumBranchOpts;
1228             MadeChange = true;
1229             if (!HasBranchToSelf) return MadeChange;
1230           }
1231         }
1232       }
1233
1234       // Add the branch back if the block is more than just an uncond branch.
1235       TII->InsertBranch(*MBB, CurTBB, 0, CurCond);
1236     }
1237   }
1238
1239   // If the prior block doesn't fall through into this block, and if this
1240   // block doesn't fall through into some other block, see if we can find a
1241   // place to move this block where a fall-through will happen.
1242   if (!PrevBB.canFallThrough()) {
1243
1244     // Now we know that there was no fall-through into this block, check to
1245     // see if it has a fall-through into its successor.
1246     bool CurFallsThru = MBB->canFallThrough();
1247
1248     if (!MBB->isLandingPad()) {
1249       // Check all the predecessors of this block.  If one of them has no fall
1250       // throughs, move this block right after it.
1251       for (MachineBasicBlock::pred_iterator PI = MBB->pred_begin(),
1252            E = MBB->pred_end(); PI != E; ++PI) {
1253         // Analyze the branch at the end of the pred.
1254         MachineBasicBlock *PredBB = *PI;
1255         MachineFunction::iterator PredFallthrough = PredBB; ++PredFallthrough;
1256         MachineBasicBlock *PredTBB = 0, *PredFBB = 0;
1257         SmallVector<MachineOperand, 4> PredCond;
1258         if (PredBB != MBB && !PredBB->canFallThrough() &&
1259             !TII->AnalyzeBranch(*PredBB, PredTBB, PredFBB, PredCond, true)
1260             && (!CurFallsThru || !CurTBB || !CurFBB)
1261             && (!CurFallsThru || MBB->getNumber() >= PredBB->getNumber())) {
1262           // If the current block doesn't fall through, just move it.
1263           // If the current block can fall through and does not end with a
1264           // conditional branch, we need to append an unconditional jump to
1265           // the (current) next block.  To avoid a possible compile-time
1266           // infinite loop, move blocks only backward in this case.
1267           // Also, if there are already 2 branches here, we cannot add a third;
1268           // this means we have the case
1269           // Bcc next
1270           // B elsewhere
1271           // next:
1272           if (CurFallsThru) {
1273             MachineBasicBlock *NextBB = llvm::next(MachineFunction::iterator(MBB));
1274             CurCond.clear();
1275             TII->InsertBranch(*MBB, NextBB, 0, CurCond);
1276           }
1277           MBB->moveAfter(PredBB);
1278           MadeChange = true;
1279           goto ReoptimizeBlock;
1280         }
1281       }
1282     }
1283
1284     if (!CurFallsThru) {
1285       // Check all successors to see if we can move this block before it.
1286       for (MachineBasicBlock::succ_iterator SI = MBB->succ_begin(),
1287            E = MBB->succ_end(); SI != E; ++SI) {
1288         // Analyze the branch at the end of the block before the succ.
1289         MachineBasicBlock *SuccBB = *SI;
1290         MachineFunction::iterator SuccPrev = SuccBB; --SuccPrev;
1291
1292         // If this block doesn't already fall-through to that successor, and if
1293         // the succ doesn't already have a block that can fall through into it,
1294         // and if the successor isn't an EH destination, we can arrange for the
1295         // fallthrough to happen.
1296         if (SuccBB != MBB && &*SuccPrev != MBB &&
1297             !SuccPrev->canFallThrough() && !CurUnAnalyzable &&
1298             !SuccBB->isLandingPad()) {
1299           MBB->moveBefore(SuccBB);
1300           MadeChange = true;
1301           goto ReoptimizeBlock;
1302         }
1303       }
1304
1305       // Okay, there is no really great place to put this block.  If, however,
1306       // the block before this one would be a fall-through if this block were
1307       // removed, move this block to the end of the function.
1308       MachineBasicBlock *PrevTBB = 0, *PrevFBB = 0;
1309       SmallVector<MachineOperand, 4> PrevCond;
1310       if (FallThrough != MF.end() &&
1311           !TII->AnalyzeBranch(PrevBB, PrevTBB, PrevFBB, PrevCond, true) &&
1312           PrevBB.isSuccessor(FallThrough)) {
1313         MBB->moveAfter(--MF.end());
1314         MadeChange = true;
1315         return MadeChange;
1316       }
1317     }
1318   }
1319
1320   return MadeChange;
1321 }