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.
 362 void BranchFolder::ReplaceTailWithBranchTo(MachineBasicBlock::iterator OldInst,
 363                                            MachineBasicBlock *NewDest) {
 364   TII->ReplaceTailWithBranchTo(OldInst, NewDest);
 365   ++NumTailMerge;
 366 }
 367
 368 /// SplitMBBAt - Given a machine basic block and an iterator into it, split the
 369 /// MBB so that the part before the iterator falls into the part starting at the
 370 /// iterator.  This returns the new MBB.
 371 MachineBasicBlock *BranchFolder::SplitMBBAt(MachineBasicBlock &CurMBB,
 372                                             MachineBasicBlock::iterator BBI1) {
 373   if (!TII->isLegalToSplitMBBAt(CurMBB, BBI1))
 374     return 0;
 375
 376   MachineFunction &MF = *CurMBB.getParent();
 377
 378   // Create the fall-through block.
 379   MachineFunction::iterator MBBI = &CurMBB;
 380   MachineBasicBlock *NewMBB =MF.CreateMachineBasicBlock(CurMBB.getBasicBlock());
 381   CurMBB.getParent()->insert(++MBBI, NewMBB);
 382
 383   // Move all the successors of this block to the specified block.
 384   NewMBB->transferSuccessors(&CurMBB);
 385
 386   // Add an edge from CurMBB to NewMBB for the fall-through.
 387   CurMBB.addSuccessor(NewMBB);
 388
 389   // Splice the code over.
 390   NewMBB->splice(NewMBB->end(), &CurMBB, BBI1, CurMBB.end());
 391
 392   // For targets that use the register scavenger, we must maintain LiveIns.
 393   if (RS) {
 394     RS->enterBasicBlock(&CurMBB);
 395     if (!CurMBB.empty())
 396       RS->forward(prior(CurMBB.end()));
 397     BitVector RegsLiveAtExit(TRI->getNumRegs());
 398     RS->getRegsUsed(RegsLiveAtExit, false);
 399     for (unsigned int i = 0, e = TRI->getNumRegs(); i != e; i++)
 400       if (RegsLiveAtExit[i])
 401         NewMBB->addLiveIn(i);
 402   }
 403
 404   return NewMBB;
 405 }
 406
 407 /// EstimateRuntime - Make a rough estimate for how long it will take to run
 408 /// the specified code.
 409 static unsigned EstimateRuntime(MachineBasicBlock::iterator I,
 410                                 MachineBasicBlock::iterator E) {
 411   unsigned Time = 0;
 412   for (; I != E; ++I) {
 413     if (I->isDebugValue())
 414       continue;
 415     const TargetInstrDesc &TID = I->getDesc();
 416     if (TID.isCall())
 417       Time += 10;
 418     else if (TID.mayLoad() || TID.mayStore())
 419       Time += 2;
 420     else
 421       ++Time;
 422   }
 423   return Time;
 424 }
 425
 426 // CurMBB needs to add an unconditional branch to SuccMBB (we removed these
 427 // branches temporarily for tail merging).  In the case where CurMBB ends
 428 // with a conditional branch to the next block, optimize by reversing the
 429 // test and conditionally branching to SuccMBB instead.
 430 static void FixTail(MachineBasicBlock *CurMBB, MachineBasicBlock *SuccBB,
 431                     const TargetInstrInfo *TII) {
 432   MachineFunction *MF = CurMBB->getParent();
 433   MachineFunction::iterator I = llvm::next(MachineFunction::iterator(CurMBB));
 434   MachineBasicBlock *TBB = 0, *FBB = 0;
 435   SmallVector<MachineOperand, 4> Cond;
 436   DebugLoc dl;  // FIXME: this is nowhere
 437   if (I != MF->end() &&
 438       !TII->AnalyzeBranch(*CurMBB, TBB, FBB, Cond, true)) {
 439     MachineBasicBlock *NextBB = I;
 440     if (TBB == NextBB && !Cond.empty() && !FBB) {
 441       if (!TII->ReverseBranchCondition(Cond)) {
 442         TII->RemoveBranch(*CurMBB);
 443         TII->InsertBranch(*CurMBB, SuccBB, NULL, Cond, dl);
 444         return;
 445       }
 446     }
 447   }
 448   TII->InsertBranch(*CurMBB, SuccBB, NULL,
 449                     SmallVector<MachineOperand, 0>(), dl);
 450 }
 451
 452 bool
 453 BranchFolder::MergePotentialsElt::operator<(const MergePotentialsElt &o) const {
 454   if (getHash() < o.getHash())
 455     return true;
 456    else if (getHash() > o.getHash())
 457     return false;
 458   else if (getBlock()->getNumber() < o.getBlock()->getNumber())
 459     return true;
 460   else if (getBlock()->getNumber() > o.getBlock()->getNumber())
 461     return false;
 462   else {
 463     // _GLIBCXX_DEBUG checks strict weak ordering, which involves comparing
 464     // an object with itself.
 465 #ifndef _GLIBCXX_DEBUG
 466     llvm_unreachable("Predecessor appears twice");
 467 #endif
 468     return false;
 469   }
 470 }
 471
 472 /// CountTerminators - Count the number of terminators in the given
 473 /// block and set I to the position of the first non-terminator, if there
 474 /// is one, or MBB->end() otherwise.
 475 static unsigned CountTerminators(MachineBasicBlock *MBB,
 476                                  MachineBasicBlock::iterator &I) {
 477   I = MBB->end();
 478   unsigned NumTerms = 0;
 479   for (;;) {
 480     if (I == MBB->begin()) {
 481       I = MBB->end();
 482       break;
 483     }
 484     --I;
 485     if (!I->getDesc().isTerminator()) break;
 486     ++NumTerms;
 487   }
 488   return NumTerms;
 489 }
 490
 491 /// ProfitableToMerge - Check if two machine basic blocks have a common tail
 492 /// and decide if it would be profitable to merge those tails.  Return the
 493 /// length of the common tail and iterators to the first common instruction
 494 /// in each block.
 495 static bool ProfitableToMerge(MachineBasicBlock *MBB1,
 496                               MachineBasicBlock *MBB2,
 497                               unsigned minCommonTailLength,
 498                               unsigned &CommonTailLen,
 499                               MachineBasicBlock::iterator &I1,
 500                               MachineBasicBlock::iterator &I2,
 501                               MachineBasicBlock *SuccBB,
 502                               MachineBasicBlock *PredBB) {
 503   CommonTailLen = ComputeCommonTailLength(MBB1, MBB2, I1, I2);
 504   if (CommonTailLen == 0)
 505     return false;
 506   DEBUG(dbgs() << "Common tail length of BB#" << MBB1->getNumber()
 507                << " and BB#" << MBB2->getNumber() << " is " << CommonTailLen
 508                << '\n');
 509
 510   // It's almost always profitable to merge any number of non-terminator
 511   // instructions with the block that falls through into the common successor.
 512   if (MBB1 == PredBB || MBB2 == PredBB) {
 513     MachineBasicBlock::iterator I;
 514     unsigned NumTerms = CountTerminators(MBB1 == PredBB ? MBB2 : MBB1, I);
 515     if (CommonTailLen > NumTerms)
 516       return true;
 517   }
 518
 519   // If one of the blocks can be completely merged and happens to be in
 520   // a position where the other could fall through into it, merge any number
 521   // of instructions, because it can be done without a branch.
 522   // TODO: If the blocks are not adjacent, move one of them so that they are?
 523   if (MBB1->isLayoutSuccessor(MBB2) && I2 == MBB2->begin())
 524     return true;
 525   if (MBB2->isLayoutSuccessor(MBB1) && I1 == MBB1->begin())
 526     return true;
 527
 528   // If both blocks have an unconditional branch temporarily stripped out,
 529   // count that as an additional common instruction for the following
 530   // heuristics.
 531   unsigned EffectiveTailLen = CommonTailLen;
 532   if (SuccBB && MBB1 != PredBB && MBB2 != PredBB &&
 533       !MBB1->back().getDesc().isBarrier() &&
 534       !MBB2->back().getDesc().isBarrier())
 535     ++EffectiveTailLen;
 536
 537   // Check if the common tail is long enough to be worthwhile.
 538   if (EffectiveTailLen >= minCommonTailLength)
 539     return true;
 540
 541   // If we are optimizing for code size, 2 instructions in common is enough if
 542   // we don't have to split a block.  At worst we will be introducing 1 new
 543   // branch instruction, which is likely to be smaller than the 2
 544   // instructions that would be deleted in the merge.
 545   MachineFunction *MF = MBB1->getParent();
 546   if (EffectiveTailLen >= 2 &&
 547       MF->getFunction()->hasFnAttr(Attribute::OptimizeForSize) &&
 548       (I1 == MBB1->begin() || I2 == MBB2->begin()))
 549     return true;
 550
 551   return false;
 552 }
 553
 554 /// ComputeSameTails - Look through all the blocks in MergePotentials that have
 555 /// hash CurHash (guaranteed to match the last element).  Build the vector
 556 /// SameTails of all those that have the (same) largest number of instructions
 557 /// in common of any pair of these blocks.  SameTails entries contain an
 558 /// iterator into MergePotentials (from which the MachineBasicBlock can be
 559 /// found) and a MachineBasicBlock::iterator into that MBB indicating the
 560 /// instruction where the matching code sequence begins.
 561 /// Order of elements in SameTails is the reverse of the order in which
 562 /// those blocks appear in MergePotentials (where they are not necessarily
 563 /// consecutive).
 564 unsigned BranchFolder::ComputeSameTails(unsigned CurHash,
 565                                         unsigned minCommonTailLength,
 566                                         MachineBasicBlock *SuccBB,
 567                                         MachineBasicBlock *PredBB) {
 568   unsigned maxCommonTailLength = 0U;
 569   SameTails.clear();
 570   MachineBasicBlock::iterator TrialBBI1, TrialBBI2;
 571   MPIterator HighestMPIter = prior(MergePotentials.end());
 572   for (MPIterator CurMPIter = prior(MergePotentials.end()),
 573                   B = MergePotentials.begin();
 574        CurMPIter != B && CurMPIter->getHash() == CurHash;
 575        --CurMPIter) {
 576     for (MPIterator I = prior(CurMPIter); I->getHash() == CurHash ; --I) {
 577       unsigned CommonTailLen;
 578       if (ProfitableToMerge(CurMPIter->getBlock(), I->getBlock(),
 579                             minCommonTailLength,
 580                             CommonTailLen, TrialBBI1, TrialBBI2,
 581                             SuccBB, PredBB)) {
 582         if (CommonTailLen > maxCommonTailLength) {
 583           SameTails.clear();
 584           maxCommonTailLength = CommonTailLen;
 585           HighestMPIter = CurMPIter;
 586           SameTails.push_back(SameTailElt(CurMPIter, TrialBBI1));
 587         }
 588         if (HighestMPIter == CurMPIter &&
 589             CommonTailLen == maxCommonTailLength)
 590           SameTails.push_back(SameTailElt(I, TrialBBI2));
 591       }
 592       if (I == B)
 593         break;
 594     }
 595   }
 596   return maxCommonTailLength;
 597 }
 598
 599 /// RemoveBlocksWithHash - Remove all blocks with hash CurHash from
 600 /// MergePotentials, restoring branches at ends of blocks as appropriate.
 601 void BranchFolder::RemoveBlocksWithHash(unsigned CurHash,
 602                                         MachineBasicBlock *SuccBB,
 603                                         MachineBasicBlock *PredBB) {
 604   MPIterator CurMPIter, B;
 605   for (CurMPIter = prior(MergePotentials.end()), B = MergePotentials.begin();
 606        CurMPIter->getHash() == CurHash;
 607        --CurMPIter) {
 608     // Put the unconditional branch back, if we need one.
 609     MachineBasicBlock *CurMBB = CurMPIter->getBlock();
 610     if (SuccBB && CurMBB != PredBB)
 611       FixTail(CurMBB, SuccBB, TII);
 612     if (CurMPIter == B)
 613       break;
 614   }
 615   if (CurMPIter->getHash() != CurHash)
 616     CurMPIter++;
 617   MergePotentials.erase(CurMPIter, MergePotentials.end());
 618 }
 619
 620 /// CreateCommonTailOnlyBlock - None of the blocks to be tail-merged consist
 621 /// only of the common tail.  Create a block that does by splitting one.
 622 bool BranchFolder::CreateCommonTailOnlyBlock(MachineBasicBlock *&PredBB,
 623                                              unsigned maxCommonTailLength,
 624                                              unsigned &commonTailIndex) {
 625   commonTailIndex = 0;
 626   unsigned TimeEstimate = ~0U;
 627   for (unsigned i = 0, e = SameTails.size(); i != e; ++i) {
 628     // Use PredBB if possible; that doesn't require a new branch.
 629     if (SameTails[i].getBlock() == PredBB) {
 630       commonTailIndex = i;
 631       break;
 632     }
 633     // Otherwise, make a (fairly bogus) choice based on estimate of
 634     // how long it will take the various blocks to execute.
 635     unsigned t = EstimateRuntime(SameTails[i].getBlock()->begin(),
 636                                  SameTails[i].getTailStartPos());
 637     if (t <= TimeEstimate) {
 638       TimeEstimate = t;
 639       commonTailIndex = i;
 640     }
 641   }
 642
 643   MachineBasicBlock::iterator BBI =
 644     SameTails[commonTailIndex].getTailStartPos();
 645   MachineBasicBlock *MBB = SameTails[commonTailIndex].getBlock();
 646
 647   // If the common tail includes any debug info we will take it pretty
 648   // randomly from one of the inputs.  Might be better to remove it?
 649   DEBUG(dbgs() << "\nSplitting BB#" << MBB->getNumber() << ", size "
 650                << maxCommonTailLength);
 651
 652   MachineBasicBlock *newMBB = SplitMBBAt(*MBB, BBI);
 653   if (!newMBB) {
 654     DEBUG(dbgs() << "... failed!");
 655     return false;
 656   }
 657
 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 true;
 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       if (!CreateCommonTailOnlyBlock(PredBB,
 761                                      maxCommonTailLength, commonTailIndex)) {
 762         RemoveBlocksWithHash(CurHash, SuccBB, PredBB);
 763         continue;
 764       }
 765     }
 766
 767     MachineBasicBlock *MBB = SameTails[commonTailIndex].getBlock();
 768     // MBB is common tail.  Adjust all other BB's to jump to this one.
 769     // Traversal must be forwards so erases work.
 770     DEBUG(dbgs() << "\nUsing common tail in BB#" << MBB->getNumber()
 771                  << " for ");
 772     for (unsigned int i=0, e = SameTails.size(); i != e; ++i) {
 773       if (commonTailIndex == i)
 774         continue;
 775       DEBUG(dbgs() << "BB#" << SameTails[i].getBlock()->getNumber()
 776                    << (i == e-1 ? "" : ", "));
 777       // Hack the end off BB i, making it jump to BB commonTailIndex instead.
 778       ReplaceTailWithBranchTo(SameTails[i].getTailStartPos(), MBB);
 779       // BB i is no longer a predecessor of SuccBB; remove it from the worklist.
 780       MergePotentials.erase(SameTails[i].getMPIter());
 781     }
 782     DEBUG(dbgs() << "\n");
 783     // We leave commonTailIndex in the worklist in case there are other blocks
 784     // that match it with a smaller number of instructions.
 785     MadeChange = true;
 786   }
 787   return MadeChange;
 788 }
 789
 790 bool BranchFolder::TailMergeBlocks(MachineFunction &MF) {
 791
 792   if (!EnableTailMerge) return false;
 793
 794   bool MadeChange = false;
 795
 796   // First find blocks with no successors.
 797   MergePotentials.clear();
 798   for (MachineFunction::iterator I = MF.begin(), E = MF.end(); I != E; ++I) {
 799     if (I->succ_empty())
 800       MergePotentials.push_back(MergePotentialsElt(HashEndOfMBB(I), I));
 801   }
 802
 803   // See if we can do any tail merging on those.
 804   if (MergePotentials.size() < TailMergeThreshold &&
 805       MergePotentials.size() >= 2)
 806     MadeChange |= TryTailMergeBlocks(NULL, NULL);
 807
 808   // Look at blocks (IBB) with multiple predecessors (PBB).
 809   // We change each predecessor to a canonical form, by
 810   // (1) temporarily removing any unconditional branch from the predecessor
 811   // to IBB, and
 812   // (2) alter conditional branches so they branch to the other block
 813   // not IBB; this may require adding back an unconditional branch to IBB
 814   // later, where there wasn't one coming in.  E.g.
 815   //   Bcc IBB
 816   //   fallthrough to QBB
 817   // here becomes
 818   //   Bncc QBB
 819   // with a conceptual B to IBB after that, which never actually exists.
 820   // With those changes, we see whether the predecessors' tails match,
 821   // and merge them if so.  We change things out of canonical form and
 822   // back to the way they were later in the process.  (OptimizeBranches
 823   // would undo some of this, but we can't use it, because we'd get into
 824   // a compile-time infinite loop repeatedly doing and undoing the same
 825   // transformations.)
 826
 827   for (MachineFunction::iterator I = llvm::next(MF.begin()), E = MF.end();
 828        I != E; ++I) {
 829     if (I->pred_size() >= 2 && I->pred_size() < TailMergeThreshold) {
 830       SmallPtrSet<MachineBasicBlock *, 8> UniquePreds;
 831       MachineBasicBlock *IBB = I;
 832       MachineBasicBlock *PredBB = prior(I);
 833       MergePotentials.clear();
 834       for (MachineBasicBlock::pred_iterator P = I->pred_begin(),
 835                                             E2 = I->pred_end();
 836            P != E2; ++P) {
 837         MachineBasicBlock *PBB = *P;
 838         // Skip blocks that loop to themselves, can't tail merge these.
 839         if (PBB == IBB)
 840           continue;
 841         // Visit each predecessor only once.
 842         if (!UniquePreds.insert(PBB))
 843           continue;
 844         MachineBasicBlock *TBB = 0, *FBB = 0;
 845         SmallVector<MachineOperand, 4> Cond;
 846         if (!TII->AnalyzeBranch(*PBB, TBB, FBB, Cond, true)) {
 847           // Failing case:  IBB is the target of a cbr, and
 848           // we cannot reverse the branch.
 849           SmallVector<MachineOperand, 4> NewCond(Cond);
 850           if (!Cond.empty() && TBB == IBB) {
 851             if (TII->ReverseBranchCondition(NewCond))
 852               continue;
 853             // This is the QBB case described above
 854             if (!FBB)
 855               FBB = llvm::next(MachineFunction::iterator(PBB));
 856           }
 857           // Failing case:  the only way IBB can be reached from PBB is via
 858           // exception handling.  Happens for landing pads.  Would be nice
 859           // to have a bit in the edge so we didn't have to do all this.
 860           if (IBB->isLandingPad()) {
 861             MachineFunction::iterator IP = PBB;  IP++;
 862             MachineBasicBlock *PredNextBB = NULL;
 863             if (IP != MF.end())
 864               PredNextBB = IP;
 865             if (TBB == NULL) {
 866               if (IBB != PredNextBB)      // fallthrough
 867                 continue;
 868             } else if (FBB) {
 869               if (TBB != IBB && FBB != IBB)   // cbr then ubr
 870                 continue;
 871             } else if (Cond.empty()) {
 872               if (TBB != IBB)               // ubr
 873                 continue;
 874             } else {
 875               if (TBB != IBB && IBB != PredNextBB)  // cbr
 876                 continue;
 877             }
 878           }
 879           // Remove the unconditional branch at the end, if any.
 880           if (TBB && (Cond.empty() || FBB)) {
 881             DebugLoc dl;  // FIXME: this is nowhere
 882             TII->RemoveBranch(*PBB);
 883             if (!Cond.empty())
 884               // reinsert conditional branch only, for now
 885               TII->InsertBranch(*PBB, (TBB == IBB) ? FBB : TBB, 0, NewCond, dl);
 886           }
 887           MergePotentials.push_back(MergePotentialsElt(HashEndOfMBB(PBB), *P));
 888         }
 889       }
 890       if (MergePotentials.size() >= 2)
 891         MadeChange |= TryTailMergeBlocks(IBB, PredBB);
 892       // Reinsert an unconditional branch if needed.
 893       // The 1 below can occur as a result of removing blocks in TryTailMergeBlocks.
 894       PredBB = prior(I);      // this may have been changed in TryTailMergeBlocks
 895       if (MergePotentials.size() == 1 &&
 896           MergePotentials.begin()->getBlock() != PredBB)
 897         FixTail(MergePotentials.begin()->getBlock(), IBB, TII);
 898     }
 899   }
 900   return MadeChange;
 901 }
 902
 903 //===----------------------------------------------------------------------===//
 904 //  Branch Optimization
 905 //===----------------------------------------------------------------------===//
 906
 907 bool BranchFolder::OptimizeBranches(MachineFunction &MF) {
 908   bool MadeChange = false;
 909
 910   // Make sure blocks are numbered in order
 911   MF.RenumberBlocks();
 912
 913   for (MachineFunction::iterator I = ++MF.begin(), E = MF.end(); I != E; ) {
 914     MachineBasicBlock *MBB = I++;
 915     MadeChange |= OptimizeBlock(MBB);
 916
 917     // If it is dead, remove it.
 918     if (MBB->pred_empty()) {
 919       RemoveDeadBlock(MBB);
 920       MadeChange = true;
 921       ++NumDeadBlocks;
 922     }
 923   }
 924   return MadeChange;
 925 }
 926
 927 // Blocks should be considered empty if they contain only debug info;
 928 // else the debug info would affect codegen.
 929 static bool IsEmptyBlock(MachineBasicBlock *MBB) {
 930   if (MBB->empty())
 931     return true;
 932   for (MachineBasicBlock::iterator MBBI = MBB->begin(), MBBE = MBB->end();
 933        MBBI!=MBBE; ++MBBI) {
 934     if (!MBBI->isDebugValue())
 935       return false;
 936   }
 937   return true;
 938 }
 939
 940 // Blocks with only debug info and branches should be considered the same
 941 // as blocks with only branches.
 942 static bool IsBranchOnlyBlock(MachineBasicBlock *MBB) {
 943   MachineBasicBlock::iterator MBBI, MBBE;
 944   for (MBBI = MBB->begin(), MBBE = MBB->end(); MBBI!=MBBE; ++MBBI) {
 945     if (!MBBI->isDebugValue())
 946       break;
 947   }
 948   return (MBBI->getDesc().isBranch());
 949 }
 950
 951 /// IsBetterFallthrough - Return true if it would be clearly better to
 952 /// fall-through to MBB1 than to fall through into MBB2.  This has to return
 953 /// a strict ordering, returning true for both (MBB1,MBB2) and (MBB2,MBB1) will
 954 /// result in infinite loops.
 955 static bool IsBetterFallthrough(MachineBasicBlock *MBB1,
 956                                 MachineBasicBlock *MBB2) {
 957   // Right now, we use a simple heuristic.  If MBB2 ends with a call, and
 958   // MBB1 doesn't, we prefer to fall through into MBB1.  This allows us to
 959   // optimize branches that branch to either a return block or an assert block
 960   // into a fallthrough to the return.
 961   if (IsEmptyBlock(MBB1) || IsEmptyBlock(MBB2)) return false;
 962
 963   // If there is a clear successor ordering we make sure that one block
 964   // will fall through to the next
 965   if (MBB1->isSuccessor(MBB2)) return true;
 966   if (MBB2->isSuccessor(MBB1)) return false;
 967
 968   // Neither block consists entirely of debug info (per IsEmptyBlock check),
 969   // so we needn't test for falling off the beginning here.
 970   MachineBasicBlock::iterator MBB1I = --MBB1->end();
 971   while (MBB1I->isDebugValue())
 972     --MBB1I;
 973   MachineBasicBlock::iterator MBB2I = --MBB2->end();
 974   while (MBB2I->isDebugValue())
 975     --MBB2I;
 976   return MBB2I->getDesc().isCall() && !MBB1I->getDesc().isCall();
 977 }
 978
 979 /// OptimizeBlock - Analyze and optimize control flow related to the specified
 980 /// block.  This is never called on the entry block.
 981 bool BranchFolder::OptimizeBlock(MachineBasicBlock *MBB) {
 982   bool MadeChange = false;
 983   MachineFunction &MF = *MBB->getParent();
 984   DebugLoc dl;  // FIXME: this is nowhere
 985 ReoptimizeBlock:
 986
 987   MachineFunction::iterator FallThrough = MBB;
 988   ++FallThrough;
 989
 990   // If this block is empty, make everyone use its fall-through, not the block
 991   // explicitly.  Landing pads should not do this since the landing-pad table
 992   // points to this block.  Blocks with their addresses taken shouldn't be
 993   // optimized away.
 994   if (IsEmptyBlock(MBB) && !MBB->isLandingPad() && !MBB->hasAddressTaken()) {
 995     // Dead block?  Leave for cleanup later.
 996     if (MBB->pred_empty()) return MadeChange;
 997
 998     if (FallThrough == MF.end()) {
 999       // TODO: Simplify preds to not branch here if possible!
1000     } else {
1001       // Rewrite all predecessors of the old block to go to the fallthrough
1002       // instead.
1003       while (!MBB->pred_empty()) {
1004         MachineBasicBlock *Pred = *(MBB->pred_end()-1);
1005         Pred->ReplaceUsesOfBlockWith(MBB, FallThrough);
1006       }
1007       // If MBB was the target of a jump table, update jump tables to go to the
1008       // fallthrough instead.
1009       if (MachineJumpTableInfo *MJTI = MF.getJumpTableInfo())
1010         MJTI->ReplaceMBBInJumpTables(MBB, FallThrough);
1011       MadeChange = true;
1012     }
1013     return MadeChange;
1014   }
1015
1016   // Check to see if we can simplify the terminator of the block before this
1017   // one.
1018   MachineBasicBlock &PrevBB = *prior(MachineFunction::iterator(MBB));
1019
1020   MachineBasicBlock *PriorTBB = 0, *PriorFBB = 0;
1021   SmallVector<MachineOperand, 4> PriorCond;
1022   bool PriorUnAnalyzable =
1023     TII->AnalyzeBranch(PrevBB, PriorTBB, PriorFBB, PriorCond, true);
1024   if (!PriorUnAnalyzable) {
1025     // If the CFG for the prior block has extra edges, remove them.
1026     MadeChange |= PrevBB.CorrectExtraCFGEdges(PriorTBB, PriorFBB,
1027                                               !PriorCond.empty());
1028
1029     // If the previous branch is conditional and both conditions go to the same
1030     // destination, remove the branch, replacing it with an unconditional one or
1031     // a fall-through.
1032     if (PriorTBB && PriorTBB == PriorFBB) {
1033       TII->RemoveBranch(PrevBB);
1034       PriorCond.clear();
1035       if (PriorTBB != MBB)
1036         TII->InsertBranch(PrevBB, PriorTBB, 0, PriorCond, dl);
1037       MadeChange = true;
1038       ++NumBranchOpts;
1039       goto ReoptimizeBlock;
1040     }
1041
1042     // If the previous block unconditionally falls through to this block and
1043     // this block has no other predecessors, move the contents of this block
1044     // into the prior block. This doesn't usually happen when SimplifyCFG
1045     // has been used, but it can happen if tail merging splits a fall-through
1046     // predecessor of a block.
1047     // This has to check PrevBB->succ_size() because EH edges are ignored by
1048     // AnalyzeBranch.
1049     if (PriorCond.empty() && !PriorTBB && MBB->pred_size() == 1 &&
1050         PrevBB.succ_size() == 1 &&
1051         !MBB->hasAddressTaken()) {
1052       DEBUG(dbgs() << "\nMerging into block: " << PrevBB
1053                    << "From MBB: " << *MBB);
1054       PrevBB.splice(PrevBB.end(), MBB, MBB->begin(), MBB->end());
1055       PrevBB.removeSuccessor(PrevBB.succ_begin());;
1056       assert(PrevBB.succ_empty());
1057       PrevBB.transferSuccessors(MBB);
1058       MadeChange = true;
1059       return MadeChange;
1060     }
1061
1062     // If the previous branch *only* branches to *this* block (conditional or
1063     // not) remove the branch.
1064     if (PriorTBB == MBB && PriorFBB == 0) {
1065       TII->RemoveBranch(PrevBB);
1066       MadeChange = true;
1067       ++NumBranchOpts;
1068       goto ReoptimizeBlock;
1069     }
1070
1071     // If the prior block branches somewhere else on the condition and here if
1072     // the condition is false, remove the uncond second branch.
1073     if (PriorFBB == MBB) {
1074       TII->RemoveBranch(PrevBB);
1075       TII->InsertBranch(PrevBB, PriorTBB, 0, PriorCond, dl);
1076       MadeChange = true;
1077       ++NumBranchOpts;
1078       goto ReoptimizeBlock;
1079     }
1080
1081     // If the prior block branches here on true and somewhere else on false, and
1082     // if the branch condition is reversible, reverse the branch to create a
1083     // fall-through.
1084     if (PriorTBB == MBB) {
1085       SmallVector<MachineOperand, 4> NewPriorCond(PriorCond);
1086       if (!TII->ReverseBranchCondition(NewPriorCond)) {
1087         TII->RemoveBranch(PrevBB);
1088         TII->InsertBranch(PrevBB, PriorFBB, 0, NewPriorCond, dl);
1089         MadeChange = true;
1090         ++NumBranchOpts;
1091         goto ReoptimizeBlock;
1092       }
1093     }
1094
1095     // If this block has no successors (e.g. it is a return block or ends with
1096     // a call to a no-return function like abort or __cxa_throw) and if the pred
1097     // falls through into this block, and if it would otherwise fall through
1098     // into the block after this, move this block to the end of the function.
1099     //
1100     // We consider it more likely that execution will stay in the function (e.g.
1101     // due to loops) than it is to exit it.  This asserts in loops etc, moving
1102     // the assert condition out of the loop body.
1103     if (MBB->succ_empty() && !PriorCond.empty() && PriorFBB == 0 &&
1104         MachineFunction::iterator(PriorTBB) == FallThrough &&
1105         !MBB->canFallThrough()) {
1106       bool DoTransform = true;
1107
1108       // We have to be careful that the succs of PredBB aren't both no-successor
1109       // blocks.  If neither have successors and if PredBB is the second from
1110       // last block in the function, we'd just keep swapping the two blocks for
1111       // last.  Only do the swap if one is clearly better to fall through than
1112       // the other.
1113       if (FallThrough == --MF.end() &&
1114           !IsBetterFallthrough(PriorTBB, MBB))
1115         DoTransform = false;
1116
1117       if (DoTransform) {
1118         // Reverse the branch so we will fall through on the previous true cond.
1119         SmallVector<MachineOperand, 4> NewPriorCond(PriorCond);
1120         if (!TII->ReverseBranchCondition(NewPriorCond)) {
1121           DEBUG(dbgs() << "\nMoving MBB: " << *MBB
1122                        << "To make fallthrough to: " << *PriorTBB << "\n");
1123
1124           TII->RemoveBranch(PrevBB);
1125           TII->InsertBranch(PrevBB, MBB, 0, NewPriorCond, dl);
1126
1127           // Move this block to the end of the function.
1128           MBB->moveAfter(--MF.end());
1129           MadeChange = true;
1130           ++NumBranchOpts;
1131           return MadeChange;
1132         }
1133       }
1134     }
1135   }
1136
1137   // Analyze the branch in the current block.
1138   MachineBasicBlock *CurTBB = 0, *CurFBB = 0;
1139   SmallVector<MachineOperand, 4> CurCond;
1140   bool CurUnAnalyzable= TII->AnalyzeBranch(*MBB, CurTBB, CurFBB, CurCond, true);
1141   if (!CurUnAnalyzable) {
1142     // If the CFG for the prior block has extra edges, remove them.
1143     MadeChange |= MBB->CorrectExtraCFGEdges(CurTBB, CurFBB, !CurCond.empty());
1144
1145     // If this is a two-way branch, and the FBB branches to this block, reverse
1146     // the condition so the single-basic-block loop is faster.  Instead of:
1147     //    Loop: xxx; jcc Out; jmp Loop
1148     // we want:
1149     //    Loop: xxx; jncc Loop; jmp Out
1150     if (CurTBB && CurFBB && CurFBB == MBB && CurTBB != MBB) {
1151       SmallVector<MachineOperand, 4> NewCond(CurCond);
1152       if (!TII->ReverseBranchCondition(NewCond)) {
1153         TII->RemoveBranch(*MBB);
1154         TII->InsertBranch(*MBB, CurFBB, CurTBB, NewCond, dl);
1155         MadeChange = true;
1156         ++NumBranchOpts;
1157         goto ReoptimizeBlock;
1158       }
1159     }
1160
1161     // If this branch is the only thing in its block, see if we can forward
1162     // other blocks across it.
1163     if (CurTBB && CurCond.empty() && CurFBB == 0 &&
1164         IsBranchOnlyBlock(MBB) && CurTBB != MBB &&
1165         !MBB->hasAddressTaken()) {
1166       // This block may contain just an unconditional branch.  Because there can
1167       // be 'non-branch terminators' in the block, try removing the branch and
1168       // then seeing if the block is empty.
1169       TII->RemoveBranch(*MBB);
1170       // If the only things remaining in the block are debug info, remove these
1171       // as well, so this will behave the same as an empty block in non-debug
1172       // mode.
1173       if (!MBB->empty()) {
1174         bool NonDebugInfoFound = false;
1175         for (MachineBasicBlock::iterator I = MBB->begin(), E = MBB->end();
1176              I != E; ++I) {
1177           if (!I->isDebugValue()) {
1178             NonDebugInfoFound = true;
1179             break;
1180           }
1181         }
1182         if (!NonDebugInfoFound)
1183           // Make the block empty, losing the debug info (we could probably
1184           // improve this in some cases.)
1185           MBB->erase(MBB->begin(), MBB->end());
1186       }
1187       // If this block is just an unconditional branch to CurTBB, we can
1188       // usually completely eliminate the block.  The only case we cannot
1189       // completely eliminate the block is when the block before this one
1190       // falls through into MBB and we can't understand the prior block's branch
1191       // condition.
1192       if (MBB->empty()) {
1193         bool PredHasNoFallThrough = !PrevBB.canFallThrough();
1194         if (PredHasNoFallThrough || !PriorUnAnalyzable ||
1195             !PrevBB.isSuccessor(MBB)) {
1196           // If the prior block falls through into us, turn it into an
1197           // explicit branch to us to make updates simpler.
1198           if (!PredHasNoFallThrough && PrevBB.isSuccessor(MBB) &&
1199               PriorTBB != MBB && PriorFBB != MBB) {
1200             if (PriorTBB == 0) {
1201               assert(PriorCond.empty() && PriorFBB == 0 &&
1202                      "Bad branch analysis");
1203               PriorTBB = MBB;
1204             } else {
1205               assert(PriorFBB == 0 && "Machine CFG out of date!");
1206               PriorFBB = MBB;
1207             }
1208             TII->RemoveBranch(PrevBB);
1209             TII->InsertBranch(PrevBB, PriorTBB, PriorFBB, PriorCond, dl);
1210           }
1211
1212           // Iterate through all the predecessors, revectoring each in-turn.
1213           size_t PI = 0;
1214           bool DidChange = false;
1215           bool HasBranchToSelf = false;
1216           while(PI != MBB->pred_size()) {
1217             MachineBasicBlock *PMBB = *(MBB->pred_begin() + PI);
1218             if (PMBB == MBB) {
1219               // If this block has an uncond branch to itself, leave it.
1220               ++PI;
1221               HasBranchToSelf = true;
1222             } else {
1223               DidChange = true;
1224               PMBB->ReplaceUsesOfBlockWith(MBB, CurTBB);
1225               // If this change resulted in PMBB ending in a conditional
1226               // branch where both conditions go to the same destination,
1227               // change this to an unconditional branch (and fix the CFG).
1228               MachineBasicBlock *NewCurTBB = 0, *NewCurFBB = 0;
1229               SmallVector<MachineOperand, 4> NewCurCond;
1230               bool NewCurUnAnalyzable = TII->AnalyzeBranch(*PMBB, NewCurTBB,
1231                       NewCurFBB, NewCurCond, true);
1232               if (!NewCurUnAnalyzable && NewCurTBB && NewCurTBB == NewCurFBB) {
1233                 TII->RemoveBranch(*PMBB);
1234                 NewCurCond.clear();
1235                 TII->InsertBranch(*PMBB, NewCurTBB, 0, NewCurCond, dl);
1236                 MadeChange = true;
1237                 ++NumBranchOpts;
1238                 PMBB->CorrectExtraCFGEdges(NewCurTBB, 0, false);
1239               }
1240             }
1241           }
1242
1243           // Change any jumptables to go to the new MBB.
1244           if (MachineJumpTableInfo *MJTI = MF.getJumpTableInfo())
1245             MJTI->ReplaceMBBInJumpTables(MBB, CurTBB);
1246           if (DidChange) {
1247             ++NumBranchOpts;
1248             MadeChange = true;
1249             if (!HasBranchToSelf) return MadeChange;
1250           }
1251         }
1252       }
1253
1254       // Add the branch back if the block is more than just an uncond branch.
1255       TII->InsertBranch(*MBB, CurTBB, 0, CurCond, dl);
1256     }
1257   }
1258
1259   // If the prior block doesn't fall through into this block, and if this
1260   // block doesn't fall through into some other block, see if we can find a
1261   // place to move this block where a fall-through will happen.
1262   if (!PrevBB.canFallThrough()) {
1263
1264     // Now we know that there was no fall-through into this block, check to
1265     // see if it has a fall-through into its successor.
1266     bool CurFallsThru = MBB->canFallThrough();
1267
1268     if (!MBB->isLandingPad()) {
1269       // Check all the predecessors of this block.  If one of them has no fall
1270       // throughs, move this block right after it.
1271       for (MachineBasicBlock::pred_iterator PI = MBB->pred_begin(),
1272            E = MBB->pred_end(); PI != E; ++PI) {
1273         // Analyze the branch at the end of the pred.
1274         MachineBasicBlock *PredBB = *PI;
1275         MachineFunction::iterator PredFallthrough = PredBB; ++PredFallthrough;
1276         MachineBasicBlock *PredTBB = 0, *PredFBB = 0;
1277         SmallVector<MachineOperand, 4> PredCond;
1278         if (PredBB != MBB && !PredBB->canFallThrough() &&
1279             !TII->AnalyzeBranch(*PredBB, PredTBB, PredFBB, PredCond, true)
1280             && (!CurFallsThru || !CurTBB || !CurFBB)
1281             && (!CurFallsThru || MBB->getNumber() >= PredBB->getNumber())) {
1282           // If the current block doesn't fall through, just move it.
1283           // If the current block can fall through and does not end with a
1284           // conditional branch, we need to append an unconditional jump to
1285           // the (current) next block.  To avoid a possible compile-time
1286           // infinite loop, move blocks only backward in this case.
1287           // Also, if there are already 2 branches here, we cannot add a third;
1288           // this means we have the case
1289           // Bcc next
1290           // B elsewhere
1291           // next:
1292           if (CurFallsThru) {
1293             MachineBasicBlock *NextBB = llvm::next(MachineFunction::iterator(MBB));
1294             CurCond.clear();
1295             TII->InsertBranch(*MBB, NextBB, 0, CurCond, dl);
1296           }
1297           MBB->moveAfter(PredBB);
1298           MadeChange = true;
1299           goto ReoptimizeBlock;
1300         }
1301       }
1302     }
1303
1304     if (!CurFallsThru) {
1305       // Check all successors to see if we can move this block before it.
1306       for (MachineBasicBlock::succ_iterator SI = MBB->succ_begin(),
1307            E = MBB->succ_end(); SI != E; ++SI) {
1308         // Analyze the branch at the end of the block before the succ.
1309         MachineBasicBlock *SuccBB = *SI;
1310         MachineFunction::iterator SuccPrev = SuccBB; --SuccPrev;
1311
1312         // If this block doesn't already fall-through to that successor, and if
1313         // the succ doesn't already have a block that can fall through into it,
1314         // and if the successor isn't an EH destination, we can arrange for the
1315         // fallthrough to happen.
1316         if (SuccBB != MBB && &*SuccPrev != MBB &&
1317             !SuccPrev->canFallThrough() && !CurUnAnalyzable &&
1318             !SuccBB->isLandingPad()) {
1319           MBB->moveBefore(SuccBB);
1320           MadeChange = true;
1321           goto ReoptimizeBlock;
1322         }
1323       }
1324
1325       // Okay, there is no really great place to put this block.  If, however,
1326       // the block before this one would be a fall-through if this block were
1327       // removed, move this block to the end of the function.
1328       MachineBasicBlock *PrevTBB = 0, *PrevFBB = 0;
1329       SmallVector<MachineOperand, 4> PrevCond;
1330       if (FallThrough != MF.end() &&
1331           !TII->AnalyzeBranch(PrevBB, PrevTBB, PrevFBB, PrevCond, true) &&
1332           PrevBB.isSuccessor(FallThrough)) {
1333         MBB->moveAfter(--MF.end());
1334         MadeChange = true;
1335         return MadeChange;
1336       }
1337     }
1338   }
1339
1340   return MadeChange;
1341 }