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