lib/CodeGen/BranchFolding.cpp

   1 //===-- BranchFolding.cpp - Fold machine code branch instructions ---------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source 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 "llvm/CodeGen/Passes.h"
  21 #include "llvm/CodeGen/MachineModuleInfo.h"
  22 #include "llvm/CodeGen/MachineFunctionPass.h"
  23 #include "llvm/CodeGen/MachineJumpTableInfo.h"
  24 #include "llvm/CodeGen/RegisterScavenging.h"
  25 #include "llvm/Target/TargetInstrInfo.h"
  26 #include "llvm/Target/TargetMachine.h"
  27 #include "llvm/Target/MRegisterInfo.h"
  28 #include "llvm/Support/CommandLine.h"
  29 #include "llvm/Support/Debug.h"
  30 #include "llvm/ADT/Statistic.h"
  31 #include "llvm/ADT/STLExtras.h"
  32 #include <algorithm>
  33 using namespace llvm;
  34
  35 STATISTIC(NumDeadBlocks, "Number of dead blocks removed");
  36 STATISTIC(NumBranchOpts, "Number of branches optimized");
  37 STATISTIC(NumTailMerge , "Number of block tails merged");
  38 static cl::opt<bool> EnableTailMerge("enable-tail-merge", cl::Hidden);
  39
  40 namespace {
  41   struct BranchFolder : public MachineFunctionPass {
  42     static char ID;
  43     BranchFolder() : MachineFunctionPass((intptr_t)&ID) {}
  44
  45     virtual bool runOnMachineFunction(MachineFunction &MF);
  46     virtual const char *getPassName() const { return "Control Flow Optimizer"; }
  47     const TargetInstrInfo *TII;
  48     MachineModuleInfo *MMI;
  49     bool MadeChange;
  50   private:
  51     // Tail Merging.
  52     bool TailMergeBlocks(MachineFunction &MF);
  53     bool TryMergeBlocks(MachineBasicBlock* SuccBB,
  54                         MachineBasicBlock* PredBB);
  55     void ReplaceTailWithBranchTo(MachineBasicBlock::iterator OldInst,
  56                                  MachineBasicBlock *NewDest);
  57     MachineBasicBlock *SplitMBBAt(MachineBasicBlock &CurMBB,
  58                                   MachineBasicBlock::iterator BBI1);
  59
  60     std::vector<std::pair<unsigned,MachineBasicBlock*> > MergePotentials;
  61     const MRegisterInfo *RegInfo;
  62     RegScavenger *RS;
  63     // Branch optzn.
  64     bool OptimizeBranches(MachineFunction &MF);
  65     void OptimizeBlock(MachineBasicBlock *MBB);
  66     void RemoveDeadBlock(MachineBasicBlock *MBB);
  67
  68     bool CanFallThrough(MachineBasicBlock *CurBB);
  69     bool CanFallThrough(MachineBasicBlock *CurBB, bool BranchUnAnalyzable,
  70                         MachineBasicBlock *TBB, MachineBasicBlock *FBB,
  71                         const std::vector<MachineOperand> &Cond);
  72   };
  73   char BranchFolder::ID = 0;
  74 }
  75
  76 FunctionPass *llvm::createBranchFoldingPass() { return new BranchFolder(); }
  77
  78 /// RemoveDeadBlock - Remove the specified dead machine basic block from the
  79 /// function, updating the CFG.
  80 void BranchFolder::RemoveDeadBlock(MachineBasicBlock *MBB) {
  81   assert(MBB->pred_empty() && "MBB must be dead!");
  82   DOUT << "\nRemoving MBB: " << *MBB;
  83
  84   MachineFunction *MF = MBB->getParent();
  85   // drop all successors.
  86   while (!MBB->succ_empty())
  87     MBB->removeSuccessor(MBB->succ_end()-1);
  88
  89   // If there is DWARF info to active, check to see if there are any LABEL
  90   // records in the basic block.  If so, unregister them from MachineModuleInfo.
  91   if (MMI && !MBB->empty()) {
  92     for (MachineBasicBlock::iterator I = MBB->begin(), E = MBB->end();
  93          I != E; ++I) {
  94       if ((unsigned)I->getOpcode() == TargetInstrInfo::LABEL) {
  95         // The label ID # is always operand #0, an immediate.
  96         MMI->InvalidateLabel(I->getOperand(0).getImm());
  97       }
  98     }
  99   }
 100
 101   // Remove the block.
 102   MF->getBasicBlockList().erase(MBB);
 103 }
 104
 105 bool BranchFolder::runOnMachineFunction(MachineFunction &MF) {
 106   TII = MF.getTarget().getInstrInfo();
 107   if (!TII) return false;
 108
 109   RegInfo = MF.getTarget().getRegisterInfo();
 110   RS = RegInfo->requiresRegisterScavenging(MF) ? new RegScavenger() : NULL;
 111
 112   MMI = getAnalysisToUpdate<MachineModuleInfo>();
 113
 114   bool EverMadeChange = false;
 115   bool MadeChangeThisIteration = true;
 116   while (MadeChangeThisIteration) {
 117     MadeChangeThisIteration = false;
 118     MadeChangeThisIteration |= TailMergeBlocks(MF);
 119     MadeChangeThisIteration |= OptimizeBranches(MF);
 120     EverMadeChange |= MadeChangeThisIteration;
 121   }
 122
 123   // See if any jump tables have become mergable or dead as the code generator
 124   // did its thing.
 125   MachineJumpTableInfo *JTI = MF.getJumpTableInfo();
 126   const std::vector<MachineJumpTableEntry> &JTs = JTI->getJumpTables();
 127   if (!JTs.empty()) {
 128     // Figure out how these jump tables should be merged.
 129     std::vector<unsigned> JTMapping;
 130     JTMapping.reserve(JTs.size());
 131
 132     // We always keep the 0th jump table.
 133     JTMapping.push_back(0);
 134
 135     // Scan the jump tables, seeing if there are any duplicates.  Note that this
 136     // is N^2, which should be fixed someday.
 137     for (unsigned i = 1, e = JTs.size(); i != e; ++i)
 138       JTMapping.push_back(JTI->getJumpTableIndex(JTs[i].MBBs));
 139
 140     // If a jump table was merge with another one, walk the function rewriting
 141     // references to jump tables to reference the new JT ID's.  Keep track of
 142     // whether we see a jump table idx, if not, we can delete the JT.
 143     std::vector<bool> JTIsLive;
 144     JTIsLive.resize(JTs.size());
 145     for (MachineFunction::iterator BB = MF.begin(), E = MF.end();
 146          BB != E; ++BB) {
 147       for (MachineBasicBlock::iterator I = BB->begin(), E = BB->end();
 148            I != E; ++I)
 149         for (unsigned op = 0, e = I->getNumOperands(); op != e; ++op) {
 150           MachineOperand &Op = I->getOperand(op);
 151           if (!Op.isJumpTableIndex()) continue;
 152           unsigned NewIdx = JTMapping[Op.getJumpTableIndex()];
 153           Op.setJumpTableIndex(NewIdx);
 154
 155           // Remember that this JT is live.
 156           JTIsLive[NewIdx] = true;
 157         }
 158     }
 159
 160     // Finally, remove dead jump tables.  This happens either because the
 161     // indirect jump was unreachable (and thus deleted) or because the jump
 162     // table was merged with some other one.
 163     for (unsigned i = 0, e = JTIsLive.size(); i != e; ++i)
 164       if (!JTIsLive[i]) {
 165         JTI->RemoveJumpTable(i);
 166         EverMadeChange = true;
 167       }
 168   }
 169
 170   delete RS;
 171   return EverMadeChange;
 172 }
 173
 174 //===----------------------------------------------------------------------===//
 175 //  Tail Merging of Blocks
 176 //===----------------------------------------------------------------------===//
 177
 178 /// HashMachineInstr - Compute a hash value for MI and its operands.
 179 static unsigned HashMachineInstr(const MachineInstr *MI) {
 180   unsigned Hash = MI->getOpcode();
 181   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 182     const MachineOperand &Op = MI->getOperand(i);
 183
 184     // Merge in bits from the operand if easy.
 185     unsigned OperandHash = 0;
 186     switch (Op.getType()) {
 187     case MachineOperand::MO_Register:          OperandHash = Op.getReg(); break;
 188     case MachineOperand::MO_Immediate:         OperandHash = Op.getImm(); break;
 189     case MachineOperand::MO_MachineBasicBlock:
 190       OperandHash = Op.getMachineBasicBlock()->getNumber();
 191       break;
 192     case MachineOperand::MO_FrameIndex: OperandHash = Op.getFrameIndex(); break;
 193     case MachineOperand::MO_ConstantPoolIndex:
 194       OperandHash = Op.getConstantPoolIndex();
 195       break;
 196     case MachineOperand::MO_JumpTableIndex:
 197       OperandHash = Op.getJumpTableIndex();
 198       break;
 199     case MachineOperand::MO_GlobalAddress:
 200     case MachineOperand::MO_ExternalSymbol:
 201       // Global address / external symbol are too hard, don't bother, but do
 202       // pull in the offset.
 203       OperandHash = Op.getOffset();
 204       break;
 205     default: break;
 206     }
 207
 208     Hash += ((OperandHash << 3) | Op.getType()) << (i&31);
 209   }
 210   return Hash;
 211 }
 212
 213 /// HashEndOfMBB - Hash the last two instructions in the MBB.  We hash two
 214 /// instructions, because cross-jumping only saves code when at least two
 215 /// instructions are removed (since a branch must be inserted).
 216 static unsigned HashEndOfMBB(const MachineBasicBlock *MBB) {
 217   MachineBasicBlock::const_iterator I = MBB->end();
 218   if (I == MBB->begin())
 219     return 0;   // Empty MBB.
 220
 221   --I;
 222   unsigned Hash = HashMachineInstr(I);
 223
 224   if (I == MBB->begin())
 225     return Hash;   // Single instr MBB.
 226
 227   --I;
 228   // Hash in the second-to-last instruction.
 229   Hash ^= HashMachineInstr(I) << 2;
 230   return Hash;
 231 }
 232
 233 /// ComputeCommonTailLength - Given two machine basic blocks, compute the number
 234 /// of instructions they actually have in common together at their end.  Return
 235 /// iterators for the first shared instruction in each block.
 236 static unsigned ComputeCommonTailLength(MachineBasicBlock *MBB1,
 237                                         MachineBasicBlock *MBB2,
 238                                         MachineBasicBlock::iterator &I1,
 239                                         MachineBasicBlock::iterator &I2) {
 240   I1 = MBB1->end();
 241   I2 = MBB2->end();
 242
 243   unsigned TailLen = 0;
 244   while (I1 != MBB1->begin() && I2 != MBB2->begin()) {
 245     --I1; --I2;
 246     if (!I1->isIdenticalTo(I2)) {
 247       ++I1; ++I2;
 248       break;
 249     }
 250     ++TailLen;
 251   }
 252   return TailLen;
 253 }
 254
 255 /// ReplaceTailWithBranchTo - Delete the instruction OldInst and everything
 256 /// after it, replacing it with an unconditional branch to NewDest.  This
 257 /// returns true if OldInst's block is modified, false if NewDest is modified.
 258 void BranchFolder::ReplaceTailWithBranchTo(MachineBasicBlock::iterator OldInst,
 259                                            MachineBasicBlock *NewDest) {
 260   MachineBasicBlock *OldBB = OldInst->getParent();
 261
 262   // Remove all the old successors of OldBB from the CFG.
 263   while (!OldBB->succ_empty())
 264     OldBB->removeSuccessor(OldBB->succ_begin());
 265
 266   // Remove all the dead instructions from the end of OldBB.
 267   OldBB->erase(OldInst, OldBB->end());
 268
 269   // If OldBB isn't immediately before OldBB, insert a branch to it.
 270   if (++MachineFunction::iterator(OldBB) != MachineFunction::iterator(NewDest))
 271     TII->InsertBranch(*OldBB, NewDest, 0, std::vector<MachineOperand>());
 272   OldBB->addSuccessor(NewDest);
 273   ++NumTailMerge;
 274 }
 275
 276 /// SplitMBBAt - Given a machine basic block and an iterator into it, split the
 277 /// MBB so that the part before the iterator falls into the part starting at the
 278 /// iterator.  This returns the new MBB.
 279 MachineBasicBlock *BranchFolder::SplitMBBAt(MachineBasicBlock &CurMBB,
 280                                             MachineBasicBlock::iterator BBI1) {
 281   // Create the fall-through block.
 282   MachineFunction::iterator MBBI = &CurMBB;
 283   MachineBasicBlock *NewMBB = new MachineBasicBlock(CurMBB.getBasicBlock());
 284   CurMBB.getParent()->getBasicBlockList().insert(++MBBI, NewMBB);
 285
 286   // Move all the successors of this block to the specified block.
 287   while (!CurMBB.succ_empty()) {
 288     MachineBasicBlock *S = *(CurMBB.succ_end()-1);
 289     NewMBB->addSuccessor(S);
 290     CurMBB.removeSuccessor(S);
 291   }
 292
 293   // Add an edge from CurMBB to NewMBB for the fall-through.
 294   CurMBB.addSuccessor(NewMBB);
 295
 296   // Splice the code over.
 297   NewMBB->splice(NewMBB->end(), &CurMBB, BBI1, CurMBB.end());
 298
 299   // For targets that use the register scavenger, we must maintain LiveIns.
 300   if (RS) {
 301     RS->enterBasicBlock(&CurMBB);
 302     if (!CurMBB.empty())
 303       RS->forward(prior(CurMBB.end()));
 304     BitVector RegsLiveAtExit(RegInfo->getNumRegs());
 305     RS->getRegsUsed(RegsLiveAtExit, false);
 306     for (unsigned int i=0, e=RegInfo->getNumRegs(); i!=e; i++)
 307       if (RegsLiveAtExit[i])
 308         NewMBB->addLiveIn(i);
 309   }
 310
 311   return NewMBB;
 312 }
 313
 314 /// EstimateRuntime - Make a rough estimate for how long it will take to run
 315 /// the specified code.
 316 static unsigned EstimateRuntime(MachineBasicBlock::iterator I,
 317                                 MachineBasicBlock::iterator E,
 318                                 const TargetInstrInfo *TII) {
 319   unsigned Time = 0;
 320   for (; I != E; ++I) {
 321     const TargetInstrDescriptor &TID = TII->get(I->getOpcode());
 322     if (TID.Flags & M_CALL_FLAG)
 323       Time += 10;
 324     else if (TID.Flags & (M_LOAD_FLAG|M_STORE_FLAG))
 325       Time += 2;
 326     else
 327       ++Time;
 328   }
 329   return Time;
 330 }
 331
 332 /// ShouldSplitFirstBlock - We need to either split MBB1 at MBB1I or MBB2 at
 333 /// MBB2I and then insert an unconditional branch in the other block.  Determine
 334 /// which is the best to split
 335 static bool ShouldSplitFirstBlock(MachineBasicBlock *MBB1,
 336                                   MachineBasicBlock::iterator MBB1I,
 337                                   MachineBasicBlock *MBB2,
 338                                   MachineBasicBlock::iterator MBB2I,
 339                                   const TargetInstrInfo *TII,
 340                                   MachineBasicBlock *PredBB) {
 341   // If one block is the entry block, split the other one; we can't generate
 342   // a branch to the entry block, as its label is not emitted.
 343   MachineBasicBlock *Entry = MBB1->getParent()->begin();
 344   if (MBB1 == Entry)
 345     return false;
 346   if (MBB2 == Entry)
 347     return true;
 348
 349   // If one block falls through into the common successor, choose that
 350   // one to split; it is one instruction less to do that.
 351   if (PredBB) {
 352     if (MBB1 == PredBB)
 353       return true;
 354     else if (MBB2 == PredBB)
 355       return false;
 356   }
 357   // TODO: if we had some notion of which block was hotter, we could split
 358   // the hot block, so it is the fall-through.  Since we don't have profile info
 359   // make a decision based on which will hurt most to split.
 360   unsigned MBB1Time = EstimateRuntime(MBB1->begin(), MBB1I, TII);
 361   unsigned MBB2Time = EstimateRuntime(MBB2->begin(), MBB2I, TII);
 362
 363   // If the MBB1 prefix takes "less time" to run than the MBB2 prefix, split the
 364   // MBB1 block so it falls through.  This will penalize the MBB2 path, but will
 365   // have a lower overall impact on the program execution.
 366   return MBB1Time < MBB2Time;
 367 }
 368
 369 // CurMBB needs to add an unconditional branch to SuccMBB (we removed these
 370 // branches temporarily for tail merging).  In the case where CurMBB ends
 371 // with a conditional branch to the next block, optimize by reversing the
 372 // test and conditionally branching to SuccMBB instead.
 373
 374 static void FixTail(MachineBasicBlock* CurMBB, MachineBasicBlock *SuccBB,
 375                     const TargetInstrInfo *TII) {
 376   MachineFunction *MF = CurMBB->getParent();
 377   MachineFunction::iterator I = next(MachineFunction::iterator(CurMBB));
 378   MachineBasicBlock *TBB = 0, *FBB = 0;
 379   std::vector<MachineOperand> Cond;
 380   if (I != MF->end() &&
 381       !TII->AnalyzeBranch(*CurMBB, TBB, FBB, Cond)) {
 382     MachineBasicBlock *NextBB = I;
 383     if (TBB == NextBB && Cond.size() && !FBB) {
 384       if (!TII->ReverseBranchCondition(Cond)) {
 385         TII->RemoveBranch(*CurMBB);
 386         TII->InsertBranch(*CurMBB, SuccBB, NULL, Cond);
 387         return;
 388       }
 389     }
 390   }
 391   TII->InsertBranch(*CurMBB, SuccBB, NULL, std::vector<MachineOperand>());
 392 }
 393
 394 // See if any of the blocks in MergePotentials (which all have a common single
 395 // successor, or all have no successor) can be tail-merged.  If there is a
 396 // successor, any blocks in MergePotentials that are not tail-merged and
 397 // are not immediately before Succ must have an unconditional branch to
 398 // Succ added (but the predecessor/successor lists need no adjustment).
 399 // The lone predecessor of Succ that falls through into Succ,
 400 // if any, is given in PredBB.
 401
 402 bool BranchFolder::TryMergeBlocks(MachineBasicBlock *SuccBB,
 403                                   MachineBasicBlock* PredBB) {
 404   MadeChange = false;
 405
 406   // Sort by hash value so that blocks with identical end sequences sort
 407   // together.
 408   std::stable_sort(MergePotentials.begin(), MergePotentials.end());
 409
 410   // Walk through equivalence sets looking for actual exact matches.
 411   while (MergePotentials.size() > 1) {
 412     unsigned CurHash  = (MergePotentials.end()-1)->first;
 413     unsigned PrevHash = (MergePotentials.end()-2)->first;
 414     MachineBasicBlock *CurMBB = (MergePotentials.end()-1)->second;
 415
 416     // If there is nothing that matches the hash of the current basic block,
 417     // give up.
 418     if (CurHash != PrevHash) {
 419       if (SuccBB && CurMBB != PredBB)
 420         FixTail(CurMBB, SuccBB, TII);
 421       MergePotentials.pop_back();
 422       continue;
 423     }
 424
 425     // Determine the actual length of the shared tail between these two basic
 426     // blocks.  Because the hash can have collisions, it's possible that this is
 427     // less than 2.
 428     MachineBasicBlock::iterator BBI1, BBI2;
 429     unsigned CommonTailLen =
 430       ComputeCommonTailLength(CurMBB, (MergePotentials.end()-2)->second,
 431                               BBI1, BBI2);
 432
 433     // If the tails don't have at least two instructions in common, see if there
 434     // is anything else in the equivalence class that does match.
 435     // Since instructions may get combined later (e.g. single stores into
 436     // store multiple) this measure is not particularly accurate.
 437     if (CommonTailLen < 2) {
 438       unsigned FoundMatch = ~0U;
 439       for (int i = MergePotentials.size()-2;
 440            i != -1 && MergePotentials[i].first == CurHash; --i) {
 441         CommonTailLen = ComputeCommonTailLength(CurMBB,
 442                                                 MergePotentials[i].second,
 443                                                 BBI1, BBI2);
 444         if (CommonTailLen >= 2) {
 445           FoundMatch = i;
 446           break;
 447         }
 448       }
 449
 450       // If we didn't find anything that has at least two instructions matching
 451       // this one, bail out.
 452       if (FoundMatch == ~0U) {
 453         // Put the unconditional branch back, if we need one.
 454         if (SuccBB && CurMBB != PredBB)
 455           FixTail(CurMBB, SuccBB, TII);
 456         MergePotentials.pop_back();
 457         continue;
 458       }
 459
 460       // Otherwise, move the matching block to the right position.
 461       std::swap(MergePotentials[FoundMatch], *(MergePotentials.end()-2));
 462     }
 463
 464     MachineBasicBlock *MBB2 = (MergePotentials.end()-2)->second;
 465
 466     // If neither block is the entire common tail, split the tail of one block
 467     // to make it redundant with the other tail.  Also, we cannot jump to the
 468     // entry block, so if one block is the entry block, split the other one.
 469     MachineBasicBlock *Entry = CurMBB->getParent()->begin();
 470     if (CurMBB->begin() == BBI1 && CurMBB != Entry)
 471       ;   // CurMBB is common tail
 472     else if (MBB2->begin() == BBI2 && MBB2 != Entry)
 473       ;   // MBB2 is common tail
 474     else {
 475       if (0) { // Enable this to disable partial tail merges.
 476         MergePotentials.pop_back();
 477         continue;
 478       }
 479
 480       // Decide whether we want to split CurMBB or MBB2.
 481       if (ShouldSplitFirstBlock(CurMBB, BBI1, MBB2, BBI2, TII, PredBB)) {
 482         CurMBB = SplitMBBAt(*CurMBB, BBI1);
 483         BBI1 = CurMBB->begin();
 484         MergePotentials.back().second = CurMBB;
 485       } else {
 486         MBB2 = SplitMBBAt(*MBB2, BBI2);
 487         BBI2 = MBB2->begin();
 488         (MergePotentials.end()-2)->second = MBB2;
 489       }
 490     }
 491
 492     if (MBB2->begin() == BBI2 && MBB2 != Entry) {
 493       // Hack the end off CurMBB, making it jump to MBBI@ instead.
 494       ReplaceTailWithBranchTo(BBI1, MBB2);
 495       // This modifies CurMBB, so remove it from the worklist.
 496       MergePotentials.pop_back();
 497     } else {
 498       assert(CurMBB->begin() == BBI1 && CurMBB != Entry &&
 499              "Didn't split block correctly?");
 500       // Hack the end off MBB2, making it jump to CurMBB instead.
 501       ReplaceTailWithBranchTo(BBI2, CurMBB);
 502       // This modifies MBB2, so remove it from the worklist.
 503       MergePotentials.erase(MergePotentials.end()-2);
 504     }
 505     MadeChange = true;
 506   }
 507   return MadeChange;
 508 }
 509
 510 bool BranchFolder::TailMergeBlocks(MachineFunction &MF) {
 511
 512   if (!EnableTailMerge) return false;
 513
 514   MadeChange = false;
 515
 516   // First find blocks with no successors.
 517   MergePotentials.clear();
 518   for (MachineFunction::iterator I = MF.begin(), E = MF.end(); I != E; ++I) {
 519     if (I->succ_empty())
 520       MergePotentials.push_back(std::make_pair(HashEndOfMBB(I), I));
 521   }
 522   // See if we can do any tail merging on those.
 523   MadeChange |= TryMergeBlocks(NULL, NULL);
 524
 525   // Look at blocks (IBB) with multiple predecessors (PBB).
 526   // We change each predecessor to a canonical form, by
 527   // (1) temporarily removing any unconditional branch from the predecessor
 528   // to IBB, and
 529   // (2) alter conditional branches so they branch to the other block
 530   // not IBB; this may require adding back an unconditional branch to IBB
 531   // later, where there wasn't one coming in.  E.g.
 532   //   Bcc IBB
 533   //   fallthrough to QBB
 534   // here becomes
 535   //   Bncc QBB
 536   // with a conceptual B to IBB after that, which never actually exists.
 537   // With those changes, we see whether the predecessors' tails match,
 538   // and merge them if so.  We change things out of canonical form and
 539   // back to the way they were later in the process.  (OptimizeBranches
 540   // would undo some of this, but we can't use it, because we'd get into
 541   // a compile-time infinite loop repeatedly doing and undoing the same
 542   // transformations.)
 543
 544   for (MachineFunction::iterator I = MF.begin(), E = MF.end(); I != E; ++I) {
 545     if (!I->succ_empty() && I->pred_size() >= 2) {
 546       MachineBasicBlock *IBB = I;
 547       MachineBasicBlock *PredBB = prior(I);
 548       MergePotentials.clear();
 549       for (MachineBasicBlock::pred_iterator P = I->pred_begin(), E2 = I->pred_end();
 550            P != E2; ++P) {
 551         MachineBasicBlock* PBB = *P;
 552         // Skip blocks that loop to themselves, can't tail merge these.
 553         if (PBB==IBB)
 554           continue;
 555         MachineBasicBlock *TBB = 0, *FBB = 0;
 556         std::vector<MachineOperand> Cond;
 557         if (!TII->AnalyzeBranch(*PBB, TBB, FBB, Cond)) {
 558           // Failing case:  IBB is the target of a cbr, and
 559           // we cannot reverse the branch.
 560           std::vector<MachineOperand> NewCond(Cond);
 561           if (Cond.size() && TBB==IBB) {
 562             if (TII->ReverseBranchCondition(NewCond))
 563               continue;
 564             // This is the QBB case described above
 565             if (!FBB)
 566               FBB = next(MachineFunction::iterator(PBB));
 567           }
 568           // Remove the unconditional branch at the end, if any.
 569           if (TBB && (Cond.size()==0 || FBB)) {
 570             TII->RemoveBranch(*PBB);
 571             if (Cond.size())
 572               // reinsert conditional branch only, for now
 573               TII->InsertBranch(*PBB, (TBB==IBB) ? FBB : TBB, 0, NewCond);
 574           }
 575           MergePotentials.push_back(std::make_pair(HashEndOfMBB(PBB), *P));
 576         }
 577       }
 578     if (MergePotentials.size() >= 2)
 579       MadeChange |= TryMergeBlocks(I, PredBB);
 580     // Reinsert an unconditional branch if needed.
 581     // The 1 below can be either an original single predecessor, or a result
 582     // of removing blocks in TryMergeBlocks.
 583     if (MergePotentials.size()==1 &&
 584         (MergePotentials.begin())->second != PredBB)
 585       FixTail((MergePotentials.begin())->second, I, TII);
 586     }
 587   }
 588   return MadeChange;
 589 }
 590
 591 //===----------------------------------------------------------------------===//
 592 //  Branch Optimization
 593 //===----------------------------------------------------------------------===//
 594
 595 bool BranchFolder::OptimizeBranches(MachineFunction &MF) {
 596   MadeChange = false;
 597
 598   // Make sure blocks are numbered in order
 599   MF.RenumberBlocks();
 600
 601   for (MachineFunction::iterator I = ++MF.begin(), E = MF.end(); I != E; ) {
 602     MachineBasicBlock *MBB = I++;
 603     OptimizeBlock(MBB);
 604
 605     // If it is dead, remove it.
 606     if (MBB->pred_empty()) {
 607       RemoveDeadBlock(MBB);
 608       MadeChange = true;
 609       ++NumDeadBlocks;
 610     }
 611   }
 612   return MadeChange;
 613 }
 614
 615
 616 /// CorrectExtraCFGEdges - Various pieces of code can cause excess edges in the
 617 /// CFG to be inserted.  If we have proven that MBB can only branch to DestA and
 618 /// DestB, remove any other MBB successors from the CFG.  DestA and DestB can
 619 /// be null.
 620 static bool CorrectExtraCFGEdges(MachineBasicBlock &MBB,
 621                                  MachineBasicBlock *DestA,
 622                                  MachineBasicBlock *DestB,
 623                                  bool isCond,
 624                                  MachineFunction::iterator FallThru) {
 625   bool MadeChange = false;
 626   bool AddedFallThrough = false;
 627
 628   // If this block ends with a conditional branch that falls through to its
 629   // successor, set DestB as the successor.
 630   if (isCond) {
 631     if (DestB == 0 && FallThru != MBB.getParent()->end()) {
 632       DestB = FallThru;
 633       AddedFallThrough = true;
 634     }
 635   } else {
 636     // If this is an unconditional branch with no explicit dest, it must just be
 637     // a fallthrough into DestB.
 638     if (DestA == 0 && FallThru != MBB.getParent()->end()) {
 639       DestA = FallThru;
 640       AddedFallThrough = true;
 641     }
 642   }
 643
 644   MachineBasicBlock::pred_iterator SI = MBB.succ_begin();
 645   while (SI != MBB.succ_end()) {
 646     if (*SI == DestA) {
 647       DestA = 0;
 648       ++SI;
 649     } else if (*SI == DestB) {
 650       DestB = 0;
 651       ++SI;
 652     } else if ((*SI)->isLandingPad()) {
 653       ++SI;
 654     } else {
 655       // Otherwise, this is a superfluous edge, remove it.
 656       MBB.removeSuccessor(SI);
 657       MadeChange = true;
 658     }
 659   }
 660   if (!AddedFallThrough) {
 661     assert(DestA == 0 && DestB == 0 &&
 662            "MachineCFG is missing edges!");
 663   } else if (isCond) {
 664     assert(DestA == 0 && "MachineCFG is missing edges!");
 665   }
 666   return MadeChange;
 667 }
 668
 669
 670 /// ReplaceUsesOfBlockWith - Given a machine basic block 'BB' that branched to
 671 /// 'Old', change the code and CFG so that it branches to 'New' instead.
 672 static void ReplaceUsesOfBlockWith(MachineBasicBlock *BB,
 673                                    MachineBasicBlock *Old,
 674                                    MachineBasicBlock *New,
 675                                    const TargetInstrInfo *TII) {
 676   assert(Old != New && "Cannot replace self with self!");
 677
 678   MachineBasicBlock::iterator I = BB->end();
 679   while (I != BB->begin()) {
 680     --I;
 681     if (!TII->isTerminatorInstr(I->getOpcode())) break;
 682
 683     // Scan the operands of this machine instruction, replacing any uses of Old
 684     // with New.
 685     for (unsigned i = 0, e = I->getNumOperands(); i != e; ++i)
 686       if (I->getOperand(i).isMachineBasicBlock() &&
 687           I->getOperand(i).getMachineBasicBlock() == Old)
 688         I->getOperand(i).setMachineBasicBlock(New);
 689   }
 690
 691   // Update the successor information.
 692   std::vector<MachineBasicBlock*> Succs(BB->succ_begin(), BB->succ_end());
 693   for (int i = Succs.size()-1; i >= 0; --i)
 694     if (Succs[i] == Old) {
 695       BB->removeSuccessor(Old);
 696       BB->addSuccessor(New);
 697     }
 698 }
 699
 700 /// CanFallThrough - Return true if the specified block (with the specified
 701 /// branch condition) can implicitly transfer control to the block after it by
 702 /// falling off the end of it.  This should return false if it can reach the
 703 /// block after it, but it uses an explicit branch to do so (e.g. a table jump).
 704 ///
 705 /// True is a conservative answer.
 706 ///
 707 bool BranchFolder::CanFallThrough(MachineBasicBlock *CurBB,
 708                                   bool BranchUnAnalyzable,
 709                                   MachineBasicBlock *TBB, MachineBasicBlock *FBB,
 710                                   const std::vector<MachineOperand> &Cond) {
 711   MachineFunction::iterator Fallthrough = CurBB;
 712   ++Fallthrough;
 713   // If FallthroughBlock is off the end of the function, it can't fall through.
 714   if (Fallthrough == CurBB->getParent()->end())
 715     return false;
 716
 717   // If FallthroughBlock isn't a successor of CurBB, no fallthrough is possible.
 718   if (!CurBB->isSuccessor(Fallthrough))
 719     return false;
 720
 721   // If we couldn't analyze the branch, assume it could fall through.
 722   if (BranchUnAnalyzable) return true;
 723
 724   // If there is no branch, control always falls through.
 725   if (TBB == 0) return true;
 726
 727   // If there is some explicit branch to the fallthrough block, it can obviously
 728   // reach, even though the branch should get folded to fall through implicitly.
 729   if (MachineFunction::iterator(TBB) == Fallthrough ||
 730       MachineFunction::iterator(FBB) == Fallthrough)
 731     return true;
 732
 733   // If it's an unconditional branch to some block not the fall through, it
 734   // doesn't fall through.
 735   if (Cond.empty()) return false;
 736
 737   // Otherwise, if it is conditional and has no explicit false block, it falls
 738   // through.
 739   return FBB == 0;
 740 }
 741
 742 /// CanFallThrough - Return true if the specified can implicitly transfer
 743 /// control to the block after it by falling off the end of it.  This should
 744 /// return false if it can reach the block after it, but it uses an explicit
 745 /// branch to do so (e.g. a table jump).
 746 ///
 747 /// True is a conservative answer.
 748 ///
 749 bool BranchFolder::CanFallThrough(MachineBasicBlock *CurBB) {
 750   MachineBasicBlock *TBB = 0, *FBB = 0;
 751   std::vector<MachineOperand> Cond;
 752   bool CurUnAnalyzable = TII->AnalyzeBranch(*CurBB, TBB, FBB, Cond);
 753   return CanFallThrough(CurBB, CurUnAnalyzable, TBB, FBB, Cond);
 754 }
 755
 756 /// IsBetterFallthrough - Return true if it would be clearly better to
 757 /// fall-through to MBB1 than to fall through into MBB2.  This has to return
 758 /// a strict ordering, returning true for both (MBB1,MBB2) and (MBB2,MBB1) will
 759 /// result in infinite loops.
 760 static bool IsBetterFallthrough(MachineBasicBlock *MBB1,
 761                                 MachineBasicBlock *MBB2,
 762                                 const TargetInstrInfo &TII) {
 763   // Right now, we use a simple heuristic.  If MBB2 ends with a call, and
 764   // MBB1 doesn't, we prefer to fall through into MBB1.  This allows us to
 765   // optimize branches that branch to either a return block or an assert block
 766   // into a fallthrough to the return.
 767   if (MBB1->empty() || MBB2->empty()) return false;
 768
 769   MachineInstr *MBB1I = --MBB1->end();
 770   MachineInstr *MBB2I = --MBB2->end();
 771   return TII.isCall(MBB2I->getOpcode()) && !TII.isCall(MBB1I->getOpcode());
 772 }
 773
 774 /// OptimizeBlock - Analyze and optimize control flow related to the specified
 775 /// block.  This is never called on the entry block.
 776 void BranchFolder::OptimizeBlock(MachineBasicBlock *MBB) {
 777   MachineFunction::iterator FallThrough = MBB;
 778   ++FallThrough;
 779
 780   // If this block is empty, make everyone use its fall-through, not the block
 781   // explicitly.
 782   if (MBB->empty()) {
 783     // Dead block?  Leave for cleanup later.
 784     if (MBB->pred_empty()) return;
 785
 786     if (FallThrough == MBB->getParent()->end()) {
 787       // TODO: Simplify preds to not branch here if possible!
 788     } else {
 789       // Rewrite all predecessors of the old block to go to the fallthrough
 790       // instead.
 791       while (!MBB->pred_empty()) {
 792         MachineBasicBlock *Pred = *(MBB->pred_end()-1);
 793         ReplaceUsesOfBlockWith(Pred, MBB, FallThrough, TII);
 794       }
 795
 796       // If MBB was the target of a jump table, update jump tables to go to the
 797       // fallthrough instead.
 798       MBB->getParent()->getJumpTableInfo()->
 799         ReplaceMBBInJumpTables(MBB, FallThrough);
 800       MadeChange = true;
 801     }
 802     return;
 803   }
 804
 805   // Check to see if we can simplify the terminator of the block before this
 806   // one.
 807   MachineBasicBlock &PrevBB = *prior(MachineFunction::iterator(MBB));
 808
 809   MachineBasicBlock *PriorTBB = 0, *PriorFBB = 0;
 810   std::vector<MachineOperand> PriorCond;
 811   bool PriorUnAnalyzable =
 812     TII->AnalyzeBranch(PrevBB, PriorTBB, PriorFBB, PriorCond);
 813   if (!PriorUnAnalyzable) {
 814     // If the CFG for the prior block has extra edges, remove them.
 815     MadeChange |= CorrectExtraCFGEdges(PrevBB, PriorTBB, PriorFBB,
 816                                        !PriorCond.empty(), MBB);
 817
 818     // If the previous branch is conditional and both conditions go to the same
 819     // destination, remove the branch, replacing it with an unconditional one or
 820     // a fall-through.
 821     if (PriorTBB && PriorTBB == PriorFBB) {
 822       TII->RemoveBranch(PrevBB);
 823       PriorCond.clear();
 824       if (PriorTBB != MBB)
 825         TII->InsertBranch(PrevBB, PriorTBB, 0, PriorCond);
 826       MadeChange = true;
 827       ++NumBranchOpts;
 828       return OptimizeBlock(MBB);
 829     }
 830
 831     // If the previous branch *only* branches to *this* block (conditional or
 832     // not) remove the branch.
 833     if (PriorTBB == MBB && PriorFBB == 0) {
 834       TII->RemoveBranch(PrevBB);
 835       MadeChange = true;
 836       ++NumBranchOpts;
 837       return OptimizeBlock(MBB);
 838     }
 839
 840     // If the prior block branches somewhere else on the condition and here if
 841     // the condition is false, remove the uncond second branch.
 842     if (PriorFBB == MBB) {
 843       TII->RemoveBranch(PrevBB);
 844       TII->InsertBranch(PrevBB, PriorTBB, 0, PriorCond);
 845       MadeChange = true;
 846       ++NumBranchOpts;
 847       return OptimizeBlock(MBB);
 848     }
 849
 850     // If the prior block branches here on true and somewhere else on false, and
 851     // if the branch condition is reversible, reverse the branch to create a
 852     // fall-through.
 853     if (PriorTBB == MBB) {
 854       std::vector<MachineOperand> NewPriorCond(PriorCond);
 855       if (!TII->ReverseBranchCondition(NewPriorCond)) {
 856         TII->RemoveBranch(PrevBB);
 857         TII->InsertBranch(PrevBB, PriorFBB, 0, NewPriorCond);
 858         MadeChange = true;
 859         ++NumBranchOpts;
 860         return OptimizeBlock(MBB);
 861       }
 862     }
 863
 864     // If this block doesn't fall through (e.g. it ends with an uncond branch or
 865     // has no successors) and if the pred falls through into this block, and if
 866     // it would otherwise fall through into the block after this, move this
 867     // block to the end of the function.
 868     //
 869     // We consider it more likely that execution will stay in the function (e.g.
 870     // due to loops) than it is to exit it.  This asserts in loops etc, moving
 871     // the assert condition out of the loop body.
 872     if (!PriorCond.empty() && PriorFBB == 0 &&
 873         MachineFunction::iterator(PriorTBB) == FallThrough &&
 874         !CanFallThrough(MBB)) {
 875       bool DoTransform = true;
 876
 877       // We have to be careful that the succs of PredBB aren't both no-successor
 878       // blocks.  If neither have successors and if PredBB is the second from
 879       // last block in the function, we'd just keep swapping the two blocks for
 880       // last.  Only do the swap if one is clearly better to fall through than
 881       // the other.
 882       if (FallThrough == --MBB->getParent()->end() &&
 883           !IsBetterFallthrough(PriorTBB, MBB, *TII))
 884         DoTransform = false;
 885
 886       // We don't want to do this transformation if we have control flow like:
 887       //   br cond BB2
 888       // BB1:
 889       //   ..
 890       //   jmp BBX
 891       // BB2:
 892       //   ..
 893       //   ret
 894       //
 895       // In this case, we could actually be moving the return block *into* a
 896       // loop!
 897       if (DoTransform && !MBB->succ_empty() &&
 898           (!CanFallThrough(PriorTBB) || PriorTBB->empty()))
 899         DoTransform = false;
 900
 901
 902       if (DoTransform) {
 903         // Reverse the branch so we will fall through on the previous true cond.
 904         std::vector<MachineOperand> NewPriorCond(PriorCond);
 905         if (!TII->ReverseBranchCondition(NewPriorCond)) {
 906           DOUT << "\nMoving MBB: " << *MBB;
 907           DOUT << "To make fallthrough to: " << *PriorTBB << "\n";
 908
 909           TII->RemoveBranch(PrevBB);
 910           TII->InsertBranch(PrevBB, MBB, 0, NewPriorCond);
 911
 912           // Move this block to the end of the function.
 913           MBB->moveAfter(--MBB->getParent()->end());
 914           MadeChange = true;
 915           ++NumBranchOpts;
 916           return;
 917         }
 918       }
 919     }
 920   }
 921
 922   // Analyze the branch in the current block.
 923   MachineBasicBlock *CurTBB = 0, *CurFBB = 0;
 924   std::vector<MachineOperand> CurCond;
 925   bool CurUnAnalyzable = TII->AnalyzeBranch(*MBB, CurTBB, CurFBB, CurCond);
 926   if (!CurUnAnalyzable) {
 927     // If the CFG for the prior block has extra edges, remove them.
 928     MadeChange |= CorrectExtraCFGEdges(*MBB, CurTBB, CurFBB,
 929                                        !CurCond.empty(),
 930                                        ++MachineFunction::iterator(MBB));
 931
 932     // If this is a two-way branch, and the FBB branches to this block, reverse
 933     // the condition so the single-basic-block loop is faster.  Instead of:
 934     //    Loop: xxx; jcc Out; jmp Loop
 935     // we want:
 936     //    Loop: xxx; jncc Loop; jmp Out
 937     if (CurTBB && CurFBB && CurFBB == MBB && CurTBB != MBB) {
 938       std::vector<MachineOperand> NewCond(CurCond);
 939       if (!TII->ReverseBranchCondition(NewCond)) {
 940         TII->RemoveBranch(*MBB);
 941         TII->InsertBranch(*MBB, CurFBB, CurTBB, NewCond);
 942         MadeChange = true;
 943         ++NumBranchOpts;
 944         return OptimizeBlock(MBB);
 945       }
 946     }
 947
 948
 949     // If this branch is the only thing in its block, see if we can forward
 950     // other blocks across it.
 951     if (CurTBB && CurCond.empty() && CurFBB == 0 &&
 952         TII->isBranch(MBB->begin()->getOpcode()) && CurTBB != MBB) {
 953       // This block may contain just an unconditional branch.  Because there can
 954       // be 'non-branch terminators' in the block, try removing the branch and
 955       // then seeing if the block is empty.
 956       TII->RemoveBranch(*MBB);
 957
 958       // If this block is just an unconditional branch to CurTBB, we can
 959       // usually completely eliminate the block.  The only case we cannot
 960       // completely eliminate the block is when the block before this one
 961       // falls through into MBB and we can't understand the prior block's branch
 962       // condition.
 963       if (MBB->empty()) {
 964         bool PredHasNoFallThrough = TII->BlockHasNoFallThrough(PrevBB);
 965         if (PredHasNoFallThrough || !PriorUnAnalyzable ||
 966             !PrevBB.isSuccessor(MBB)) {
 967           // If the prior block falls through into us, turn it into an
 968           // explicit branch to us to make updates simpler.
 969           if (!PredHasNoFallThrough && PrevBB.isSuccessor(MBB) &&
 970               PriorTBB != MBB && PriorFBB != MBB) {
 971             if (PriorTBB == 0) {
 972               assert(PriorCond.empty() && PriorFBB == 0 &&
 973                      "Bad branch analysis");
 974               PriorTBB = MBB;
 975             } else {
 976               assert(PriorFBB == 0 && "Machine CFG out of date!");
 977               PriorFBB = MBB;
 978             }
 979             TII->RemoveBranch(PrevBB);
 980             TII->InsertBranch(PrevBB, PriorTBB, PriorFBB, PriorCond);
 981           }
 982
 983           // Iterate through all the predecessors, revectoring each in-turn.
 984           MachineBasicBlock::pred_iterator PI = MBB->pred_begin();
 985           bool DidChange = false;
 986           bool HasBranchToSelf = false;
 987           while (PI != MBB->pred_end()) {
 988             if (*PI == MBB) {
 989               // If this block has an uncond branch to itself, leave it.
 990               ++PI;
 991               HasBranchToSelf = true;
 992             } else {
 993               DidChange = true;
 994               ReplaceUsesOfBlockWith(*PI, MBB, CurTBB, TII);
 995             }
 996           }
 997
 998           // Change any jumptables to go to the new MBB.
 999           MBB->getParent()->getJumpTableInfo()->
1000             ReplaceMBBInJumpTables(MBB, CurTBB);
1001           if (DidChange) {
1002             ++NumBranchOpts;
1003             MadeChange = true;
1004             if (!HasBranchToSelf) return;
1005           }
1006         }
1007       }
1008
1009       // Add the branch back if the block is more than just an uncond branch.
1010       TII->InsertBranch(*MBB, CurTBB, 0, CurCond);
1011     }
1012   }
1013
1014   // If the prior block doesn't fall through into this block, and if this
1015   // block doesn't fall through into some other block, see if we can find a
1016   // place to move this block where a fall-through will happen.
1017   if (!CanFallThrough(&PrevBB, PriorUnAnalyzable,
1018                       PriorTBB, PriorFBB, PriorCond)) {
1019     // Now we know that there was no fall-through into this block, check to
1020     // see if it has a fall-through into its successor.
1021     bool CurFallsThru = CanFallThrough(MBB, CurUnAnalyzable, CurTBB, CurFBB,
1022                                        CurCond);
1023
1024     if (!MBB->isLandingPad()) {
1025       // Check all the predecessors of this block.  If one of them has no fall
1026       // throughs, move this block right after it.
1027       for (MachineBasicBlock::pred_iterator PI = MBB->pred_begin(),
1028            E = MBB->pred_end(); PI != E; ++PI) {
1029         // Analyze the branch at the end of the pred.
1030         MachineBasicBlock *PredBB = *PI;
1031         MachineFunction::iterator PredFallthrough = PredBB; ++PredFallthrough;
1032         if (PredBB != MBB && !CanFallThrough(PredBB)
1033             && (!CurFallsThru || !CurTBB || !CurFBB)
1034             && (!CurFallsThru || MBB->getNumber() >= PredBB->getNumber())) {
1035           // If the current block doesn't fall through, just move it.
1036           // If the current block can fall through and does not end with a
1037           // conditional branch, we need to append an unconditional jump to
1038           // the (current) next block.  To avoid a possible compile-time
1039           // infinite loop, move blocks only backward in this case.
1040           // Also, if there are already 2 branches here, we cannot add a third;
1041           // this means we have the case
1042           // Bcc next
1043           // B elsewhere
1044           // next:
1045           if (CurFallsThru) {
1046             MachineBasicBlock *NextBB = next(MachineFunction::iterator(MBB));
1047             CurCond.clear();
1048             TII->InsertBranch(*MBB, NextBB, 0, CurCond);
1049           }
1050           MBB->moveAfter(PredBB);
1051           MadeChange = true;
1052           return OptimizeBlock(MBB);
1053         }
1054       }
1055     }
1056
1057     if (!CurFallsThru) {
1058       // Check all successors to see if we can move this block before it.
1059       for (MachineBasicBlock::succ_iterator SI = MBB->succ_begin(),
1060            E = MBB->succ_end(); SI != E; ++SI) {
1061         // Analyze the branch at the end of the block before the succ.
1062         MachineBasicBlock *SuccBB = *SI;
1063         MachineFunction::iterator SuccPrev = SuccBB; --SuccPrev;
1064         std::vector<MachineOperand> SuccPrevCond;
1065
1066         // If this block doesn't already fall-through to that successor, and if
1067         // the succ doesn't already have a block that can fall through into it,
1068         // and if the successor isn't an EH destination, we can arrange for the
1069         // fallthrough to happen.
1070         if (SuccBB != MBB && !CanFallThrough(SuccPrev) &&
1071             !SuccBB->isLandingPad()) {
1072           MBB->moveBefore(SuccBB);
1073           MadeChange = true;
1074           return OptimizeBlock(MBB);
1075         }
1076       }
1077
1078       // Okay, there is no really great place to put this block.  If, however,
1079       // the block before this one would be a fall-through if this block were
1080       // removed, move this block to the end of the function.
1081       if (FallThrough != MBB->getParent()->end() &&
1082           PrevBB.isSuccessor(FallThrough)) {
1083         MBB->moveAfter(--MBB->getParent()->end());
1084         MadeChange = true;
1085         return;
1086       }
1087     }
1088   }
1089 }