lib/CodeGen/BranchFolding.cpp

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