lib/CodeGen/TailDuplication.cpp

   1 //===-- TailDuplication.cpp - Duplicate blocks into predecessors' tails ---===//
   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 duplicates basic blocks ending in unconditional branches into
  11 // the tails of their predecessors.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #define DEBUG_TYPE "tailduplication"
  16 #include "llvm/Function.h"
  17 #include "llvm/CodeGen/Passes.h"
  18 #include "llvm/CodeGen/MachineModuleInfo.h"
  19 #include "llvm/CodeGen/MachineFunctionPass.h"
  20 #include "llvm/CodeGen/MachineInstrBuilder.h"
  21 #include "llvm/CodeGen/MachineRegisterInfo.h"
  22 #include "llvm/CodeGen/MachineSSAUpdater.h"
  23 #include "llvm/Target/TargetInstrInfo.h"
  24 #include "llvm/Support/CommandLine.h"
  25 #include "llvm/Support/Debug.h"
  26 #include "llvm/Support/ErrorHandling.h"
  27 #include "llvm/Support/raw_ostream.h"
  28 #include "llvm/ADT/SmallSet.h"
  29 #include "llvm/ADT/SetVector.h"
  30 #include "llvm/ADT/Statistic.h"
  31 using namespace llvm;
  32
  33 STATISTIC(NumTails     , "Number of tails duplicated");
  34 STATISTIC(NumTailDups  , "Number of tail duplicated blocks");
  35 STATISTIC(NumInstrDups , "Additional instructions due to tail duplication");
  36 STATISTIC(NumDeadBlocks, "Number of dead blocks removed");
  37 STATISTIC(NumAddedPHIs , "Number of phis added");
  38
  39 // Heuristic for tail duplication.
  40 static cl::opt<unsigned>
  41 TailDuplicateSize("tail-dup-size",
  42                   cl::desc("Maximum instructions to consider tail duplicating"),
  43                   cl::init(2), cl::Hidden);
  44
  45 static cl::opt<bool>
  46 TailDupVerify("tail-dup-verify",
  47               cl::desc("Verify sanity of PHI instructions during taildup"),
  48               cl::init(false), cl::Hidden);
  49
  50 static cl::opt<unsigned>
  51 TailDupLimit("tail-dup-limit", cl::init(~0U), cl::Hidden);
  52
  53 typedef std::vector<std::pair<MachineBasicBlock*,unsigned> > AvailableValsTy;
  54
  55 namespace {
  56   /// TailDuplicatePass - Perform tail duplication.
  57   class TailDuplicatePass : public MachineFunctionPass {
  58     bool PreRegAlloc;
  59     const TargetInstrInfo *TII;
  60     MachineModuleInfo *MMI;
  61     MachineRegisterInfo *MRI;
  62
  63     // SSAUpdateVRs - A list of virtual registers for which to update SSA form.
  64     SmallVector<unsigned, 16> SSAUpdateVRs;
  65
  66     // SSAUpdateVals - For each virtual register in SSAUpdateVals keep a list of
  67     // source virtual registers.
  68     DenseMap<unsigned, AvailableValsTy> SSAUpdateVals;
  69
  70   public:
  71     static char ID;
  72     explicit TailDuplicatePass(bool PreRA) :
  73       MachineFunctionPass(ID), PreRegAlloc(PreRA) {}
  74
  75     virtual bool runOnMachineFunction(MachineFunction &MF);
  76     virtual const char *getPassName() const { return "Tail Duplication"; }
  77
  78   private:
  79     void AddSSAUpdateEntry(unsigned OrigReg, unsigned NewReg,
  80                            MachineBasicBlock *BB);
  81     void ProcessPHI(MachineInstr *MI, MachineBasicBlock *TailBB,
  82                     MachineBasicBlock *PredBB,
  83                     DenseMap<unsigned, unsigned> &LocalVRMap,
  84                     SmallVector<std::pair<unsigned,unsigned>, 4> &Copies,
  85                     const DenseSet<unsigned> &UsedByPhi,
  86                     bool Remove);
  87     void DuplicateInstruction(MachineInstr *MI,
  88                               MachineBasicBlock *TailBB,
  89                               MachineBasicBlock *PredBB,
  90                               MachineFunction &MF,
  91                               DenseMap<unsigned, unsigned> &LocalVRMap,
  92                               const DenseSet<unsigned> &UsedByPhi);
  93     void UpdateSuccessorsPHIs(MachineBasicBlock *FromBB, bool isDead,
  94                               SmallVector<MachineBasicBlock*, 8> &TDBBs,
  95                               SmallSetVector<MachineBasicBlock*, 8> &Succs);
  96     bool TailDuplicateBlocks(MachineFunction &MF);
  97     bool shouldTailDuplicate(const MachineFunction &MF,
  98                              MachineBasicBlock &TailBB);
  99     bool TailDuplicate(MachineBasicBlock *TailBB, MachineFunction &MF,
 100                        SmallVector<MachineBasicBlock*, 8> &TDBBs,
 101                        SmallVector<MachineInstr*, 16> &Copies);
 102     void RemoveDeadBlock(MachineBasicBlock *MBB);
 103   };
 104
 105   char TailDuplicatePass::ID = 0;
 106 }
 107
 108 FunctionPass *llvm::createTailDuplicatePass(bool PreRegAlloc) {
 109   return new TailDuplicatePass(PreRegAlloc);
 110 }
 111
 112 bool TailDuplicatePass::runOnMachineFunction(MachineFunction &MF) {
 113   TII = MF.getTarget().getInstrInfo();
 114   MRI = &MF.getRegInfo();
 115   MMI = getAnalysisIfAvailable<MachineModuleInfo>();
 116
 117   bool MadeChange = false;
 118   while (TailDuplicateBlocks(MF))
 119     MadeChange = true;
 120
 121   return MadeChange;
 122 }
 123
 124 static void VerifyPHIs(MachineFunction &MF, bool CheckExtra) {
 125   for (MachineFunction::iterator I = ++MF.begin(), E = MF.end(); I != E; ++I) {
 126     MachineBasicBlock *MBB = I;
 127     SmallSetVector<MachineBasicBlock*, 8> Preds(MBB->pred_begin(),
 128                                                 MBB->pred_end());
 129     MachineBasicBlock::iterator MI = MBB->begin();
 130     while (MI != MBB->end()) {
 131       if (!MI->isPHI())
 132         break;
 133       for (SmallSetVector<MachineBasicBlock *, 8>::iterator PI = Preds.begin(),
 134              PE = Preds.end(); PI != PE; ++PI) {
 135         MachineBasicBlock *PredBB = *PI;
 136         bool Found = false;
 137         for (unsigned i = 1, e = MI->getNumOperands(); i != e; i += 2) {
 138           MachineBasicBlock *PHIBB = MI->getOperand(i+1).getMBB();
 139           if (PHIBB == PredBB) {
 140             Found = true;
 141             break;
 142           }
 143         }
 144         if (!Found) {
 145           dbgs() << "Malformed PHI in BB#" << MBB->getNumber() << ": " << *MI;
 146           dbgs() << "  missing input from predecessor BB#"
 147                  << PredBB->getNumber() << '\n';
 148           llvm_unreachable(0);
 149         }
 150       }
 151
 152       for (unsigned i = 1, e = MI->getNumOperands(); i != e; i += 2) {
 153         MachineBasicBlock *PHIBB = MI->getOperand(i+1).getMBB();
 154         if (CheckExtra && !Preds.count(PHIBB)) {
 155           // This is not a hard error.
 156           dbgs() << "Warning: malformed PHI in BB#" << MBB->getNumber()
 157                  << ": " << *MI;
 158           dbgs() << "  extra input from predecessor BB#"
 159                  << PHIBB->getNumber() << '\n';
 160         }
 161         if (PHIBB->getNumber() < 0) {
 162           dbgs() << "Malformed PHI in BB#" << MBB->getNumber() << ": " << *MI;
 163           dbgs() << "  non-existing BB#" << PHIBB->getNumber() << '\n';
 164           llvm_unreachable(0);
 165         }
 166       }
 167       ++MI;
 168     }
 169   }
 170 }
 171
 172 /// TailDuplicateBlocks - Look for small blocks that are unconditionally
 173 /// branched to and do not fall through. Tail-duplicate their instructions
 174 /// into their predecessors to eliminate (dynamic) branches.
 175 bool TailDuplicatePass::TailDuplicateBlocks(MachineFunction &MF) {
 176   bool MadeChange = false;
 177
 178   if (PreRegAlloc && TailDupVerify) {
 179     DEBUG(dbgs() << "\n*** Before tail-duplicating\n");
 180     VerifyPHIs(MF, true);
 181   }
 182
 183   SmallVector<MachineInstr*, 8> NewPHIs;
 184   MachineSSAUpdater SSAUpdate(MF, &NewPHIs);
 185
 186   for (MachineFunction::iterator I = ++MF.begin(), E = MF.end(); I != E; ) {
 187     MachineBasicBlock *MBB = I++;
 188
 189     if (NumTails == TailDupLimit)
 190       break;
 191
 192     // Save the successors list.
 193     SmallSetVector<MachineBasicBlock*, 8> Succs(MBB->succ_begin(),
 194                                                 MBB->succ_end());
 195
 196     SmallVector<MachineBasicBlock*, 8> TDBBs;
 197     SmallVector<MachineInstr*, 16> Copies;
 198     if (TailDuplicate(MBB, MF, TDBBs, Copies)) {
 199       ++NumTails;
 200
 201       // TailBB's immediate successors are now successors of those predecessors
 202       // which duplicated TailBB. Add the predecessors as sources to the PHI
 203       // instructions.
 204       bool isDead = MBB->pred_empty();
 205       if (PreRegAlloc)
 206         UpdateSuccessorsPHIs(MBB, isDead, TDBBs, Succs);
 207
 208       // If it is dead, remove it.
 209       if (isDead) {
 210         NumInstrDups -= MBB->size();
 211         RemoveDeadBlock(MBB);
 212         ++NumDeadBlocks;
 213       }
 214
 215       // Update SSA form.
 216       if (!SSAUpdateVRs.empty()) {
 217         for (unsigned i = 0, e = SSAUpdateVRs.size(); i != e; ++i) {
 218           unsigned VReg = SSAUpdateVRs[i];
 219           SSAUpdate.Initialize(VReg);
 220
 221           // If the original definition is still around, add it as an available
 222           // value.
 223           MachineInstr *DefMI = MRI->getVRegDef(VReg);
 224           MachineBasicBlock *DefBB = 0;
 225           if (DefMI) {
 226             DefBB = DefMI->getParent();
 227             SSAUpdate.AddAvailableValue(DefBB, VReg);
 228           }
 229
 230           // Add the new vregs as available values.
 231           DenseMap<unsigned, AvailableValsTy>::iterator LI =
 232             SSAUpdateVals.find(VReg);
 233           for (unsigned j = 0, ee = LI->second.size(); j != ee; ++j) {
 234             MachineBasicBlock *SrcBB = LI->second[j].first;
 235             unsigned SrcReg = LI->second[j].second;
 236             SSAUpdate.AddAvailableValue(SrcBB, SrcReg);
 237           }
 238
 239           // Rewrite uses that are outside of the original def's block.
 240           MachineRegisterInfo::use_iterator UI = MRI->use_begin(VReg);
 241           while (UI != MRI->use_end()) {
 242             MachineOperand &UseMO = UI.getOperand();
 243             MachineInstr *UseMI = &*UI;
 244             ++UI;
 245             if (UseMI->getParent() == DefBB && !UseMI->isPHI())
 246               continue;
 247             SSAUpdate.RewriteUse(UseMO);
 248           }
 249         }
 250
 251         SSAUpdateVRs.clear();
 252         SSAUpdateVals.clear();
 253       }
 254
 255       // Eliminate some of the copies inserted by tail duplication to maintain
 256       // SSA form.
 257       for (unsigned i = 0, e = Copies.size(); i != e; ++i) {
 258         MachineInstr *Copy = Copies[i];
 259         if (!Copy->isCopy())
 260           continue;
 261         unsigned Dst = Copy->getOperand(0).getReg();
 262         unsigned Src = Copy->getOperand(1).getReg();
 263         MachineRegisterInfo::use_iterator UI = MRI->use_begin(Src);
 264         if (++UI == MRI->use_end()) {
 265           // Copy is the only use. Do trivial copy propagation here.
 266           MRI->replaceRegWith(Dst, Src);
 267           Copy->eraseFromParent();
 268         }
 269       }
 270
 271       if (PreRegAlloc && TailDupVerify)
 272         VerifyPHIs(MF, false);
 273       MadeChange = true;
 274     }
 275   }
 276   NumAddedPHIs += NewPHIs.size();
 277
 278   return MadeChange;
 279 }
 280
 281 static bool isDefLiveOut(unsigned Reg, MachineBasicBlock *BB,
 282                          const MachineRegisterInfo *MRI) {
 283   for (MachineRegisterInfo::use_iterator UI = MRI->use_begin(Reg),
 284          UE = MRI->use_end(); UI != UE; ++UI) {
 285     MachineInstr *UseMI = &*UI;
 286     if (UseMI->getParent() != BB)
 287       return true;
 288   }
 289   return false;
 290 }
 291
 292 static unsigned getPHISrcRegOpIdx(MachineInstr *MI, MachineBasicBlock *SrcBB) {
 293   for (unsigned i = 1, e = MI->getNumOperands(); i != e; i += 2)
 294     if (MI->getOperand(i+1).getMBB() == SrcBB)
 295       return i;
 296   return 0;
 297 }
 298
 299
 300 // Remember which registers are used by phis in this block. This is
 301 // used to determine which registers are liveout while modifying the
 302 // block (which is why we need to copy the information).
 303 static void getRegsUsedByPHIs(const MachineBasicBlock &BB,
 304                               DenseSet<unsigned> *UsedByPhi) {
 305   for(MachineBasicBlock::const_iterator I = BB.begin(), E = BB.end();
 306       I != E; ++I) {
 307     const MachineInstr &MI = *I;
 308     if (!MI.isPHI())
 309       break;
 310     for (unsigned i = 1, e = MI.getNumOperands(); i != e; i += 2) {
 311       unsigned SrcReg = MI.getOperand(i).getReg();
 312       UsedByPhi->insert(SrcReg);
 313     }
 314   }
 315 }
 316
 317 /// AddSSAUpdateEntry - Add a definition and source virtual registers pair for
 318 /// SSA update.
 319 void TailDuplicatePass::AddSSAUpdateEntry(unsigned OrigReg, unsigned NewReg,
 320                                           MachineBasicBlock *BB) {
 321   DenseMap<unsigned, AvailableValsTy>::iterator LI= SSAUpdateVals.find(OrigReg);
 322   if (LI != SSAUpdateVals.end())
 323     LI->second.push_back(std::make_pair(BB, NewReg));
 324   else {
 325     AvailableValsTy Vals;
 326     Vals.push_back(std::make_pair(BB, NewReg));
 327     SSAUpdateVals.insert(std::make_pair(OrigReg, Vals));
 328     SSAUpdateVRs.push_back(OrigReg);
 329   }
 330 }
 331
 332 /// ProcessPHI - Process PHI node in TailBB by turning it into a copy in PredBB.
 333 /// Remember the source register that's contributed by PredBB and update SSA
 334 /// update map.
 335 void TailDuplicatePass::ProcessPHI(MachineInstr *MI,
 336                                    MachineBasicBlock *TailBB,
 337                                    MachineBasicBlock *PredBB,
 338                                    DenseMap<unsigned, unsigned> &LocalVRMap,
 339                            SmallVector<std::pair<unsigned,unsigned>, 4> &Copies,
 340                                    const DenseSet<unsigned> &RegsUsedByPhi,
 341                                    bool Remove) {
 342   unsigned DefReg = MI->getOperand(0).getReg();
 343   unsigned SrcOpIdx = getPHISrcRegOpIdx(MI, PredBB);
 344   assert(SrcOpIdx && "Unable to find matching PHI source?");
 345   unsigned SrcReg = MI->getOperand(SrcOpIdx).getReg();
 346   const TargetRegisterClass *RC = MRI->getRegClass(DefReg);
 347   LocalVRMap.insert(std::make_pair(DefReg, SrcReg));
 348
 349   // Insert a copy from source to the end of the block. The def register is the
 350   // available value liveout of the block.
 351   unsigned NewDef = MRI->createVirtualRegister(RC);
 352   Copies.push_back(std::make_pair(NewDef, SrcReg));
 353   if (isDefLiveOut(DefReg, TailBB, MRI) || RegsUsedByPhi.count(DefReg))
 354     AddSSAUpdateEntry(DefReg, NewDef, PredBB);
 355
 356   if (!Remove)
 357     return;
 358
 359   // Remove PredBB from the PHI node.
 360   MI->RemoveOperand(SrcOpIdx+1);
 361   MI->RemoveOperand(SrcOpIdx);
 362   if (MI->getNumOperands() == 1)
 363     MI->eraseFromParent();
 364 }
 365
 366 /// DuplicateInstruction - Duplicate a TailBB instruction to PredBB and update
 367 /// the source operands due to earlier PHI translation.
 368 void TailDuplicatePass::DuplicateInstruction(MachineInstr *MI,
 369                                      MachineBasicBlock *TailBB,
 370                                      MachineBasicBlock *PredBB,
 371                                      MachineFunction &MF,
 372                                      DenseMap<unsigned, unsigned> &LocalVRMap,
 373                                      const DenseSet<unsigned> &UsedByPhi) {
 374   MachineInstr *NewMI = TII->duplicate(MI, MF);
 375   for (unsigned i = 0, e = NewMI->getNumOperands(); i != e; ++i) {
 376     MachineOperand &MO = NewMI->getOperand(i);
 377     if (!MO.isReg())
 378       continue;
 379     unsigned Reg = MO.getReg();
 380     if (!TargetRegisterInfo::isVirtualRegister(Reg))
 381       continue;
 382     if (MO.isDef()) {
 383       const TargetRegisterClass *RC = MRI->getRegClass(Reg);
 384       unsigned NewReg = MRI->createVirtualRegister(RC);
 385       MO.setReg(NewReg);
 386       LocalVRMap.insert(std::make_pair(Reg, NewReg));
 387       if (isDefLiveOut(Reg, TailBB, MRI) || UsedByPhi.count(Reg))
 388         AddSSAUpdateEntry(Reg, NewReg, PredBB);
 389     } else {
 390       DenseMap<unsigned, unsigned>::iterator VI = LocalVRMap.find(Reg);
 391       if (VI != LocalVRMap.end())
 392         MO.setReg(VI->second);
 393     }
 394   }
 395   PredBB->insert(PredBB->end(), NewMI);
 396 }
 397
 398 /// UpdateSuccessorsPHIs - After FromBB is tail duplicated into its predecessor
 399 /// blocks, the successors have gained new predecessors. Update the PHI
 400 /// instructions in them accordingly.
 401 void
 402 TailDuplicatePass::UpdateSuccessorsPHIs(MachineBasicBlock *FromBB, bool isDead,
 403                                   SmallVector<MachineBasicBlock*, 8> &TDBBs,
 404                                   SmallSetVector<MachineBasicBlock*,8> &Succs) {
 405   for (SmallSetVector<MachineBasicBlock*, 8>::iterator SI = Succs.begin(),
 406          SE = Succs.end(); SI != SE; ++SI) {
 407     MachineBasicBlock *SuccBB = *SI;
 408     for (MachineBasicBlock::iterator II = SuccBB->begin(), EE = SuccBB->end();
 409          II != EE; ++II) {
 410       if (!II->isPHI())
 411         break;
 412       unsigned Idx = 0;
 413       for (unsigned i = 1, e = II->getNumOperands(); i != e; i += 2) {
 414         MachineOperand &MO = II->getOperand(i+1);
 415         if (MO.getMBB() == FromBB) {
 416           Idx = i;
 417           break;
 418         }
 419       }
 420
 421       assert(Idx != 0);
 422       MachineOperand &MO0 = II->getOperand(Idx);
 423       unsigned Reg = MO0.getReg();
 424       if (isDead) {
 425         // Folded into the previous BB.
 426         // There could be duplicate phi source entries. FIXME: Should sdisel
 427         // or earlier pass fixed this?
 428         for (unsigned i = II->getNumOperands()-2; i != Idx; i -= 2) {
 429           MachineOperand &MO = II->getOperand(i+1);
 430           if (MO.getMBB() == FromBB) {
 431             II->RemoveOperand(i+1);
 432             II->RemoveOperand(i);
 433           }
 434         }
 435       } else
 436         Idx = 0;
 437
 438       // If Idx is set, the operands at Idx and Idx+1 must be removed.
 439       // We reuse the location to avoid expensive RemoveOperand calls.
 440
 441       DenseMap<unsigned,AvailableValsTy>::iterator LI=SSAUpdateVals.find(Reg);
 442       if (LI != SSAUpdateVals.end()) {
 443         // This register is defined in the tail block.
 444         for (unsigned j = 0, ee = LI->second.size(); j != ee; ++j) {
 445           MachineBasicBlock *SrcBB = LI->second[j].first;
 446           unsigned SrcReg = LI->second[j].second;
 447           if (Idx != 0) {
 448             II->getOperand(Idx).setReg(SrcReg);
 449             II->getOperand(Idx+1).setMBB(SrcBB);
 450             Idx = 0;
 451           } else {
 452             II->addOperand(MachineOperand::CreateReg(SrcReg, false));
 453             II->addOperand(MachineOperand::CreateMBB(SrcBB));
 454           }
 455         }
 456       } else {
 457         // Live in tail block, must also be live in predecessors.
 458         for (unsigned j = 0, ee = TDBBs.size(); j != ee; ++j) {
 459           MachineBasicBlock *SrcBB = TDBBs[j];
 460           if (Idx != 0) {
 461             II->getOperand(Idx).setReg(Reg);
 462             II->getOperand(Idx+1).setMBB(SrcBB);
 463             Idx = 0;
 464           } else {
 465             II->addOperand(MachineOperand::CreateReg(Reg, false));
 466             II->addOperand(MachineOperand::CreateMBB(SrcBB));
 467           }
 468         }
 469       }
 470       if (Idx != 0) {
 471         II->RemoveOperand(Idx+1);
 472         II->RemoveOperand(Idx);
 473       }
 474     }
 475   }
 476 }
 477
 478 /// shouldTailDuplicate - Determine if it is profitable to duplicate this block.
 479 bool
 480 TailDuplicatePass::shouldTailDuplicate(const MachineFunction &MF,
 481                                        MachineBasicBlock &TailBB) {
 482   // Only duplicate blocks that end with unconditional branches.
 483   if (TailBB.canFallThrough())
 484     return false;
 485
 486   // Set the limit on the cost to duplicate. When optimizing for size,
 487   // duplicate only one, because one branch instruction can be eliminated to
 488   // compensate for the duplication.
 489   unsigned MaxDuplicateCount;
 490   if (TailDuplicateSize.getNumOccurrences() == 0 &&
 491       MF.getFunction()->hasFnAttr(Attribute::OptimizeForSize))
 492     MaxDuplicateCount = 1;
 493   else
 494     MaxDuplicateCount = TailDuplicateSize;
 495
 496   if (PreRegAlloc) {
 497     if (TailBB.empty())
 498       return false;
 499     const TargetInstrDesc &TID = TailBB.back().getDesc();
 500     // Pre-regalloc tail duplication hurts compile time and doesn't help
 501     // much except for indirect branches.
 502     if (!TID.isIndirectBranch())
 503       return false;
 504     // If the target has hardware branch prediction that can handle indirect
 505     // branches, duplicating them can often make them predictable when there
 506     // are common paths through the code.  The limit needs to be high enough
 507     // to allow undoing the effects of tail merging and other optimizations
 508     // that rearrange the predecessors of the indirect branch.
 509     MaxDuplicateCount = 20;
 510   }
 511
 512   // Don't try to tail-duplicate single-block loops.
 513   if (TailBB.isSuccessor(&TailBB))
 514     return false;
 515
 516   // Check the instructions in the block to determine whether tail-duplication
 517   // is invalid or unlikely to be profitable.
 518   unsigned InstrCount = 0;
 519   bool HasCall = false;
 520   for (MachineBasicBlock::const_iterator I = TailBB.begin(); I != TailBB.end();
 521        ++I) {
 522     // Non-duplicable things shouldn't be tail-duplicated.
 523     if (I->getDesc().isNotDuplicable()) return false;
 524     // Do not duplicate 'return' instructions if this is a pre-regalloc run.
 525     // A return may expand into a lot more instructions (e.g. reload of callee
 526     // saved registers) after PEI.
 527     if (PreRegAlloc && I->getDesc().isReturn()) return false;
 528     // Don't duplicate more than the threshold.
 529     if (InstrCount == MaxDuplicateCount) return false;
 530     // Remember if we saw a call.
 531     if (I->getDesc().isCall()) HasCall = true;
 532     if (!I->isPHI() && !I->isDebugValue())
 533       InstrCount += 1;
 534   }
 535   // Don't tail-duplicate calls before register allocation. Calls presents a
 536   // barrier to register allocation so duplicating them may end up increasing
 537   // spills.
 538   if (InstrCount > 1 && (PreRegAlloc && HasCall))
 539     return false;
 540
 541   return true;
 542 }
 543
 544 /// TailDuplicate - If it is profitable, duplicate TailBB's contents in each
 545 /// of its predecessors.
 546 bool
 547 TailDuplicatePass::TailDuplicate(MachineBasicBlock *TailBB, MachineFunction &MF,
 548                                  SmallVector<MachineBasicBlock*, 8> &TDBBs,
 549                                  SmallVector<MachineInstr*, 16> &Copies) {
 550   if (!shouldTailDuplicate(MF, *TailBB))
 551     return false;
 552
 553   DEBUG(dbgs() << "\n*** Tail-duplicating BB#" << TailBB->getNumber() << '\n');
 554
 555   // Iterate through all the unique predecessors and tail-duplicate this
 556   // block into them, if possible. Copying the list ahead of time also
 557   // avoids trouble with the predecessor list reallocating.
 558   bool Changed = false;
 559   SmallSetVector<MachineBasicBlock*, 8> Preds(TailBB->pred_begin(),
 560                                               TailBB->pred_end());
 561   DenseSet<unsigned> UsedByPhi;
 562   getRegsUsedByPHIs(*TailBB, &UsedByPhi);
 563   for (SmallSetVector<MachineBasicBlock *, 8>::iterator PI = Preds.begin(),
 564        PE = Preds.end(); PI != PE; ++PI) {
 565     MachineBasicBlock *PredBB = *PI;
 566
 567     assert(TailBB != PredBB &&
 568            "Single-block loop should have been rejected earlier!");
 569     if (PredBB->succ_size() > 1) continue;
 570
 571     MachineBasicBlock *PredTBB, *PredFBB;
 572     SmallVector<MachineOperand, 4> PredCond;
 573     // EH edges are ignored by AnalyzeBranch.
 574     if (PredBB->succ_size() != 1)
 575       continue;
 576     if (TII->AnalyzeBranch(*PredBB, PredTBB, PredFBB, PredCond, true))
 577       continue;
 578     if (!PredCond.empty())
 579       continue;
 580     // Don't duplicate into a fall-through predecessor (at least for now).
 581     if (PredBB->isLayoutSuccessor(TailBB) && PredBB->canFallThrough())
 582       continue;
 583
 584     DEBUG(dbgs() << "\nTail-duplicating into PredBB: " << *PredBB
 585                  << "From Succ: " << *TailBB);
 586
 587     TDBBs.push_back(PredBB);
 588
 589     // Remove PredBB's unconditional branch.
 590     TII->RemoveBranch(*PredBB);
 591
 592     // Clone the contents of TailBB into PredBB.
 593     DenseMap<unsigned, unsigned> LocalVRMap;
 594     SmallVector<std::pair<unsigned,unsigned>, 4> CopyInfos;
 595     MachineBasicBlock::iterator I = TailBB->begin();
 596     while (I != TailBB->end()) {
 597       MachineInstr *MI = &*I;
 598       ++I;
 599       if (MI->isPHI()) {
 600         // Replace the uses of the def of the PHI with the register coming
 601         // from PredBB.
 602         ProcessPHI(MI, TailBB, PredBB, LocalVRMap, CopyInfos, UsedByPhi, true);
 603       } else {
 604         // Replace def of virtual registers with new registers, and update
 605         // uses with PHI source register or the new registers.
 606         DuplicateInstruction(MI, TailBB, PredBB, MF, LocalVRMap, UsedByPhi);
 607       }
 608     }
 609     MachineBasicBlock::iterator Loc = PredBB->getFirstTerminator();
 610     for (unsigned i = 0, e = CopyInfos.size(); i != e; ++i) {
 611       Copies.push_back(BuildMI(*PredBB, Loc, DebugLoc(),
 612                                TII->get(TargetOpcode::COPY),
 613                                CopyInfos[i].first).addReg(CopyInfos[i].second));
 614     }
 615     NumInstrDups += TailBB->size() - 1; // subtract one for removed branch
 616
 617     // Update the CFG.
 618     PredBB->removeSuccessor(PredBB->succ_begin());
 619     assert(PredBB->succ_empty() &&
 620            "TailDuplicate called on block with multiple successors!");
 621     for (MachineBasicBlock::succ_iterator I = TailBB->succ_begin(),
 622            E = TailBB->succ_end(); I != E; ++I)
 623       PredBB->addSuccessor(*I);
 624
 625     Changed = true;
 626     ++NumTailDups;
 627   }
 628
 629   // If TailBB was duplicated into all its predecessors except for the prior
 630   // block, which falls through unconditionally, move the contents of this
 631   // block into the prior block.
 632   MachineBasicBlock *PrevBB = prior(MachineFunction::iterator(TailBB));
 633   MachineBasicBlock *PriorTBB = 0, *PriorFBB = 0;
 634   SmallVector<MachineOperand, 4> PriorCond;
 635   // This has to check PrevBB->succ_size() because EH edges are ignored by
 636   // AnalyzeBranch.
 637   if (PrevBB->succ_size() == 1 &&
 638       !TII->AnalyzeBranch(*PrevBB, PriorTBB, PriorFBB, PriorCond, true) &&
 639       PriorCond.empty() && !PriorTBB && TailBB->pred_size() == 1 &&
 640       !TailBB->hasAddressTaken()) {
 641     DEBUG(dbgs() << "\nMerging into block: " << *PrevBB
 642           << "From MBB: " << *TailBB);
 643     if (PreRegAlloc) {
 644       DenseMap<unsigned, unsigned> LocalVRMap;
 645       SmallVector<std::pair<unsigned,unsigned>, 4> CopyInfos;
 646       MachineBasicBlock::iterator I = TailBB->begin();
 647       // Process PHI instructions first.
 648       while (I != TailBB->end() && I->isPHI()) {
 649         // Replace the uses of the def of the PHI with the register coming
 650         // from PredBB.
 651         MachineInstr *MI = &*I++;
 652         ProcessPHI(MI, TailBB, PrevBB, LocalVRMap, CopyInfos, UsedByPhi, true);
 653         if (MI->getParent())
 654           MI->eraseFromParent();
 655       }
 656
 657       // Now copy the non-PHI instructions.
 658       while (I != TailBB->end()) {
 659         // Replace def of virtual registers with new registers, and update
 660         // uses with PHI source register or the new registers.
 661         MachineInstr *MI = &*I++;
 662         DuplicateInstruction(MI, TailBB, PrevBB, MF, LocalVRMap, UsedByPhi);
 663         MI->eraseFromParent();
 664       }
 665       MachineBasicBlock::iterator Loc = PrevBB->getFirstTerminator();
 666       for (unsigned i = 0, e = CopyInfos.size(); i != e; ++i) {
 667         Copies.push_back(BuildMI(*PrevBB, Loc, DebugLoc(),
 668                                  TII->get(TargetOpcode::COPY),
 669                                  CopyInfos[i].first)
 670                            .addReg(CopyInfos[i].second));
 671       }
 672     } else {
 673       // No PHIs to worry about, just splice the instructions over.
 674       PrevBB->splice(PrevBB->end(), TailBB, TailBB->begin(), TailBB->end());
 675     }
 676     PrevBB->removeSuccessor(PrevBB->succ_begin());
 677     assert(PrevBB->succ_empty());
 678     PrevBB->transferSuccessors(TailBB);
 679     TDBBs.push_back(PrevBB);
 680     Changed = true;
 681   }
 682
 683   // If this is after register allocation, there are no phis to fix.
 684   if (!PreRegAlloc)
 685     return Changed;
 686
 687   // If we made no changes so far, we are safe.
 688   if (!Changed)
 689     return Changed;
 690
 691
 692   // Handle the nasty case in that we duplicated a block that is part of a loop
 693   // into some but not all of its predecessors. For example:
 694   //    1 -> 2 <-> 3                 |
 695   //          \                      |
 696   //           \---> rest            |
 697   // if we duplicate 2 into 1 but not into 3, we end up with
 698   // 12 -> 3 <-> 2 -> rest           |
 699   //   \             /               |
 700   //    \----->-----/                |
 701   // If there was a "var = phi(1, 3)" in 2, it has to be ultimately replaced
 702   // with a phi in 3 (which now dominates 2).
 703   // What we do here is introduce a copy in 3 of the register defined by the
 704   // phi, just like when we are duplicating 2 into 3, but we don't copy any
 705   // real instructions or remove the 3 -> 2 edge from the phi in 2.
 706   for (SmallSetVector<MachineBasicBlock *, 8>::iterator PI = Preds.begin(),
 707        PE = Preds.end(); PI != PE; ++PI) {
 708     MachineBasicBlock *PredBB = *PI;
 709     if (std::find(TDBBs.begin(), TDBBs.end(), PredBB) != TDBBs.end())
 710       continue;
 711
 712     // EH edges
 713     if (PredBB->succ_size() != 1)
 714       continue;
 715
 716     DenseMap<unsigned, unsigned> LocalVRMap;
 717     SmallVector<std::pair<unsigned,unsigned>, 4> CopyInfos;
 718     MachineBasicBlock::iterator I = TailBB->begin();
 719     // Process PHI instructions first.
 720     while (I != TailBB->end() && I->isPHI()) {
 721       // Replace the uses of the def of the PHI with the register coming
 722       // from PredBB.
 723       MachineInstr *MI = &*I++;
 724       ProcessPHI(MI, TailBB, PredBB, LocalVRMap, CopyInfos, UsedByPhi, false);
 725     }
 726     MachineBasicBlock::iterator Loc = PredBB->getFirstTerminator();
 727     for (unsigned i = 0, e = CopyInfos.size(); i != e; ++i) {
 728       Copies.push_back(BuildMI(*PredBB, Loc, DebugLoc(),
 729                                TII->get(TargetOpcode::COPY),
 730                                CopyInfos[i].first).addReg(CopyInfos[i].second));
 731     }
 732   }
 733
 734   return Changed;
 735 }
 736
 737 /// RemoveDeadBlock - Remove the specified dead machine basic block from the
 738 /// function, updating the CFG.
 739 void TailDuplicatePass::RemoveDeadBlock(MachineBasicBlock *MBB) {
 740   assert(MBB->pred_empty() && "MBB must be dead!");
 741   DEBUG(dbgs() << "\nRemoving MBB: " << *MBB);
 742
 743   // Remove all successors.
 744   while (!MBB->succ_empty())
 745     MBB->removeSuccessor(MBB->succ_end()-1);
 746
 747   // Remove the block.
 748   MBB->eraseFromParent();
 749 }
 750