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