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/CodeGen/Passes.h"
  17 #include "llvm/ADT/DenseSet.h"
  18 #include "llvm/ADT/SetVector.h"
  19 #include "llvm/ADT/SmallSet.h"
  20 #include "llvm/ADT/Statistic.h"
  21 #include "llvm/CodeGen/MachineBranchProbabilityInfo.h"
  22 #include "llvm/CodeGen/MachineFunctionPass.h"
  23 #include "llvm/CodeGen/MachineInstrBuilder.h"
  24 #include "llvm/CodeGen/MachineModuleInfo.h"
  25 #include "llvm/CodeGen/MachineRegisterInfo.h"
  26 #include "llvm/CodeGen/MachineSSAUpdater.h"
  27 #include "llvm/CodeGen/RegisterScavenging.h"
  28 #include "llvm/IR/Function.h"
  29 #include "llvm/Support/CommandLine.h"
  30 #include "llvm/Support/Debug.h"
  31 #include "llvm/Support/ErrorHandling.h"
  32 #include "llvm/Support/raw_ostream.h"
  33 #include "llvm/Target/TargetInstrInfo.h"
  34 #include "llvm/Target/TargetRegisterInfo.h"
  35 using namespace llvm;
  36
  37 STATISTIC(NumTails     , "Number of tails duplicated");
  38 STATISTIC(NumTailDups  , "Number of tail duplicated blocks");
  39 STATISTIC(NumInstrDups , "Additional instructions due to tail duplication");
  40 STATISTIC(NumDeadBlocks, "Number of dead blocks removed");
  41 STATISTIC(NumAddedPHIs , "Number of phis added");
  42
  43 // Heuristic for tail duplication.
  44 static cl::opt<unsigned>
  45 TailDuplicateSize("tail-dup-size",
  46                   cl::desc("Maximum instructions to consider tail duplicating"),
  47                   cl::init(2), cl::Hidden);
  48
  49 static cl::opt<bool>
  50 TailDupVerify("tail-dup-verify",
  51               cl::desc("Verify sanity of PHI instructions during taildup"),
  52               cl::init(false), cl::Hidden);
  53
  54 static cl::opt<unsigned>
  55 TailDupLimit("tail-dup-limit", cl::init(~0U), cl::Hidden);
  56
  57 typedef std::vector<std::pair<MachineBasicBlock*,unsigned> > AvailableValsTy;
  58
  59 namespace {
  60   /// TailDuplicatePass - Perform tail duplication.
  61   class TailDuplicatePass : public MachineFunctionPass {
  62     const TargetInstrInfo *TII;
  63     const TargetRegisterInfo *TRI;
  64     const MachineBranchProbabilityInfo *MBPI;
  65     MachineModuleInfo *MMI;
  66     MachineRegisterInfo *MRI;
  67     std::unique_ptr<RegScavenger> RS;
  68     bool PreRegAlloc;
  69
  70     // SSAUpdateVRs - A list of virtual registers for which to update SSA form.
  71     SmallVector<unsigned, 16> SSAUpdateVRs;
  72
  73     // SSAUpdateVals - For each virtual register in SSAUpdateVals keep a list of
  74     // source virtual registers.
  75     DenseMap<unsigned, AvailableValsTy> SSAUpdateVals;
  76
  77   public:
  78     static char ID;
  79     explicit TailDuplicatePass() :
  80       MachineFunctionPass(ID), PreRegAlloc(false) {}
  81
  82     bool runOnMachineFunction(MachineFunction &MF) override;
  83
  84     void getAnalysisUsage(AnalysisUsage &AU) const override;
  85
  86   private:
  87     void AddSSAUpdateEntry(unsigned OrigReg, unsigned NewReg,
  88                            MachineBasicBlock *BB);
  89     void ProcessPHI(MachineInstr *MI, MachineBasicBlock *TailBB,
  90                     MachineBasicBlock *PredBB,
  91                     DenseMap<unsigned, unsigned> &LocalVRMap,
  92                     SmallVectorImpl<std::pair<unsigned,unsigned> > &Copies,
  93                     const DenseSet<unsigned> &UsedByPhi,
  94                     bool Remove);
  95     void DuplicateInstruction(MachineInstr *MI,
  96                               MachineBasicBlock *TailBB,
  97                               MachineBasicBlock *PredBB,
  98                               MachineFunction &MF,
  99                               DenseMap<unsigned, unsigned> &LocalVRMap,
 100                               const DenseSet<unsigned> &UsedByPhi);
 101     void UpdateSuccessorsPHIs(MachineBasicBlock *FromBB, bool isDead,
 102                               SmallVectorImpl<MachineBasicBlock *> &TDBBs,
 103                               SmallSetVector<MachineBasicBlock*, 8> &Succs);
 104     bool TailDuplicateBlocks(MachineFunction &MF);
 105     bool shouldTailDuplicate(const MachineFunction &MF,
 106                              bool IsSimple, MachineBasicBlock &TailBB);
 107     bool isSimpleBB(MachineBasicBlock *TailBB);
 108     bool canCompletelyDuplicateBB(MachineBasicBlock &BB);
 109     bool duplicateSimpleBB(MachineBasicBlock *TailBB,
 110                            SmallVectorImpl<MachineBasicBlock *> &TDBBs,
 111                            const DenseSet<unsigned> &RegsUsedByPhi,
 112                            SmallVectorImpl<MachineInstr *> &Copies);
 113     bool TailDuplicate(MachineBasicBlock *TailBB,
 114                        bool IsSimple,
 115                        MachineFunction &MF,
 116                        SmallVectorImpl<MachineBasicBlock *> &TDBBs,
 117                        SmallVectorImpl<MachineInstr *> &Copies);
 118     bool TailDuplicateAndUpdate(MachineBasicBlock *MBB,
 119                                 bool IsSimple,
 120                                 MachineFunction &MF);
 121
 122     void RemoveDeadBlock(MachineBasicBlock *MBB);
 123   };
 124
 125   char TailDuplicatePass::ID = 0;
 126 }
 127
 128 char &llvm::TailDuplicateID = TailDuplicatePass::ID;
 129
 130 INITIALIZE_PASS(TailDuplicatePass, "tailduplication", "Tail Duplication",
 131                 false, false)
 132
 133 bool TailDuplicatePass::runOnMachineFunction(MachineFunction &MF) {
 134   if (skipOptnoneFunction(*MF.getFunction()))
 135     return false;
 136
 137   TII = MF.getTarget().getInstrInfo();
 138   TRI = MF.getTarget().getRegisterInfo();
 139   MRI = &MF.getRegInfo();
 140   MMI = getAnalysisIfAvailable<MachineModuleInfo>();
 141   MBPI = &getAnalysis<MachineBranchProbabilityInfo>();
 142
 143   PreRegAlloc = MRI->isSSA();
 144   RS.reset();
 145   if (MRI->tracksLiveness() && TRI->trackLivenessAfterRegAlloc(MF))
 146     RS.reset(new RegScavenger());
 147
 148   bool MadeChange = false;
 149   while (TailDuplicateBlocks(MF))
 150     MadeChange = true;
 151
 152   return MadeChange;
 153 }
 154
 155 void TailDuplicatePass::getAnalysisUsage(AnalysisUsage &AU) const {
 156   AU.addRequired<MachineBranchProbabilityInfo>();
 157   MachineFunctionPass::getAnalysisUsage(AU);
 158 }
 159
 160 static void VerifyPHIs(MachineFunction &MF, bool CheckExtra) {
 161   for (MachineFunction::iterator I = ++MF.begin(), E = MF.end(); I != E; ++I) {
 162     MachineBasicBlock *MBB = I;
 163     SmallSetVector<MachineBasicBlock*, 8> Preds(MBB->pred_begin(),
 164                                                 MBB->pred_end());
 165     MachineBasicBlock::iterator MI = MBB->begin();
 166     while (MI != MBB->end()) {
 167       if (!MI->isPHI())
 168         break;
 169       for (SmallSetVector<MachineBasicBlock *, 8>::iterator PI = Preds.begin(),
 170              PE = Preds.end(); PI != PE; ++PI) {
 171         MachineBasicBlock *PredBB = *PI;
 172         bool Found = false;
 173         for (unsigned i = 1, e = MI->getNumOperands(); i != e; i += 2) {
 174           MachineBasicBlock *PHIBB = MI->getOperand(i+1).getMBB();
 175           if (PHIBB == PredBB) {
 176             Found = true;
 177             break;
 178           }
 179         }
 180         if (!Found) {
 181           dbgs() << "Malformed PHI in BB#" << MBB->getNumber() << ": " << *MI;
 182           dbgs() << "  missing input from predecessor BB#"
 183                  << PredBB->getNumber() << '\n';
 184           llvm_unreachable(nullptr);
 185         }
 186       }
 187
 188       for (unsigned i = 1, e = MI->getNumOperands(); i != e; i += 2) {
 189         MachineBasicBlock *PHIBB = MI->getOperand(i+1).getMBB();
 190         if (CheckExtra && !Preds.count(PHIBB)) {
 191           dbgs() << "Warning: malformed PHI in BB#" << MBB->getNumber()
 192                  << ": " << *MI;
 193           dbgs() << "  extra input from predecessor BB#"
 194                  << PHIBB->getNumber() << '\n';
 195           llvm_unreachable(nullptr);
 196         }
 197         if (PHIBB->getNumber() < 0) {
 198           dbgs() << "Malformed PHI in BB#" << MBB->getNumber() << ": " << *MI;
 199           dbgs() << "  non-existing BB#" << PHIBB->getNumber() << '\n';
 200           llvm_unreachable(nullptr);
 201         }
 202       }
 203       ++MI;
 204     }
 205   }
 206 }
 207
 208 /// TailDuplicateAndUpdate - Tail duplicate the block and cleanup.
 209 bool
 210 TailDuplicatePass::TailDuplicateAndUpdate(MachineBasicBlock *MBB,
 211                                           bool IsSimple,
 212                                           MachineFunction &MF) {
 213   // Save the successors list.
 214   SmallSetVector<MachineBasicBlock*, 8> Succs(MBB->succ_begin(),
 215                                               MBB->succ_end());
 216
 217   SmallVector<MachineBasicBlock*, 8> TDBBs;
 218   SmallVector<MachineInstr*, 16> Copies;
 219   if (!TailDuplicate(MBB, IsSimple, MF, TDBBs, Copies))
 220     return false;
 221
 222   ++NumTails;
 223
 224   SmallVector<MachineInstr*, 8> NewPHIs;
 225   MachineSSAUpdater SSAUpdate(MF, &NewPHIs);
 226
 227   // TailBB's immediate successors are now successors of those predecessors
 228   // which duplicated TailBB. Add the predecessors as sources to the PHI
 229   // instructions.
 230   bool isDead = MBB->pred_empty() && !MBB->hasAddressTaken();
 231   if (PreRegAlloc)
 232     UpdateSuccessorsPHIs(MBB, isDead, TDBBs, Succs);
 233
 234   // If it is dead, remove it.
 235   if (isDead) {
 236     NumInstrDups -= MBB->size();
 237     RemoveDeadBlock(MBB);
 238     ++NumDeadBlocks;
 239   }
 240
 241   // Update SSA form.
 242   if (!SSAUpdateVRs.empty()) {
 243     for (unsigned i = 0, e = SSAUpdateVRs.size(); i != e; ++i) {
 244       unsigned VReg = SSAUpdateVRs[i];
 245       SSAUpdate.Initialize(VReg);
 246
 247       // If the original definition is still around, add it as an available
 248       // value.
 249       MachineInstr *DefMI = MRI->getVRegDef(VReg);
 250       MachineBasicBlock *DefBB = nullptr;
 251       if (DefMI) {
 252         DefBB = DefMI->getParent();
 253         SSAUpdate.AddAvailableValue(DefBB, VReg);
 254       }
 255
 256       // Add the new vregs as available values.
 257       DenseMap<unsigned, AvailableValsTy>::iterator LI =
 258         SSAUpdateVals.find(VReg);
 259       for (unsigned j = 0, ee = LI->second.size(); j != ee; ++j) {
 260         MachineBasicBlock *SrcBB = LI->second[j].first;
 261         unsigned SrcReg = LI->second[j].second;
 262         SSAUpdate.AddAvailableValue(SrcBB, SrcReg);
 263       }
 264
 265       // Rewrite uses that are outside of the original def's block.
 266       MachineRegisterInfo::use_iterator UI = MRI->use_begin(VReg);
 267       while (UI != MRI->use_end()) {
 268         MachineOperand &UseMO = *UI;
 269         MachineInstr *UseMI = UseMO.getParent();
 270         ++UI;
 271         if (UseMI->isDebugValue()) {
 272           // SSAUpdate can replace the use with an undef. That creates
 273           // a debug instruction that is a kill.
 274           // FIXME: Should it SSAUpdate job to delete debug instructions
 275           // instead of replacing the use with undef?
 276           UseMI->eraseFromParent();
 277           continue;
 278         }
 279         if (UseMI->getParent() == DefBB && !UseMI->isPHI())
 280           continue;
 281         SSAUpdate.RewriteUse(UseMO);
 282       }
 283     }
 284
 285     SSAUpdateVRs.clear();
 286     SSAUpdateVals.clear();
 287   }
 288
 289   // Eliminate some of the copies inserted by tail duplication to maintain
 290   // SSA form.
 291   for (unsigned i = 0, e = Copies.size(); i != e; ++i) {
 292     MachineInstr *Copy = Copies[i];
 293     if (!Copy->isCopy())
 294       continue;
 295     unsigned Dst = Copy->getOperand(0).getReg();
 296     unsigned Src = Copy->getOperand(1).getReg();
 297     if (MRI->hasOneNonDBGUse(Src) &&
 298         MRI->constrainRegClass(Src, MRI->getRegClass(Dst))) {
 299       // Copy is the only use. Do trivial copy propagation here.
 300       MRI->replaceRegWith(Dst, Src);
 301       Copy->eraseFromParent();
 302     }
 303   }
 304
 305   if (NewPHIs.size())
 306     NumAddedPHIs += NewPHIs.size();
 307
 308   return true;
 309 }
 310
 311 /// TailDuplicateBlocks - Look for small blocks that are unconditionally
 312 /// branched to and do not fall through. Tail-duplicate their instructions
 313 /// into their predecessors to eliminate (dynamic) branches.
 314 bool TailDuplicatePass::TailDuplicateBlocks(MachineFunction &MF) {
 315   bool MadeChange = false;
 316
 317   if (PreRegAlloc && TailDupVerify) {
 318     DEBUG(dbgs() << "\n*** Before tail-duplicating\n");
 319     VerifyPHIs(MF, true);
 320   }
 321
 322   for (MachineFunction::iterator I = ++MF.begin(), E = MF.end(); I != E; ) {
 323     MachineBasicBlock *MBB = I++;
 324
 325     if (NumTails == TailDupLimit)
 326       break;
 327
 328     bool IsSimple = isSimpleBB(MBB);
 329
 330     if (!shouldTailDuplicate(MF, IsSimple, *MBB))
 331       continue;
 332
 333     MadeChange |= TailDuplicateAndUpdate(MBB, IsSimple, MF);
 334   }
 335
 336   if (PreRegAlloc && TailDupVerify)
 337     VerifyPHIs(MF, false);
 338
 339   return MadeChange;
 340 }
 341
 342 static bool isDefLiveOut(unsigned Reg, MachineBasicBlock *BB,
 343                          const MachineRegisterInfo *MRI) {
 344   for (MachineInstr &UseMI : MRI->use_instructions(Reg)) {
 345     if (UseMI.isDebugValue())
 346       continue;
 347     if (UseMI.getParent() != BB)
 348       return true;
 349   }
 350   return false;
 351 }
 352
 353 static unsigned getPHISrcRegOpIdx(MachineInstr *MI, MachineBasicBlock *SrcBB) {
 354   for (unsigned i = 1, e = MI->getNumOperands(); i != e; i += 2)
 355     if (MI->getOperand(i+1).getMBB() == SrcBB)
 356       return i;
 357   return 0;
 358 }
 359
 360
 361 // Remember which registers are used by phis in this block. This is
 362 // used to determine which registers are liveout while modifying the
 363 // block (which is why we need to copy the information).
 364 static void getRegsUsedByPHIs(const MachineBasicBlock &BB,
 365                               DenseSet<unsigned> *UsedByPhi) {
 366   for(MachineBasicBlock::const_iterator I = BB.begin(), E = BB.end();
 367       I != E; ++I) {
 368     const MachineInstr &MI = *I;
 369     if (!MI.isPHI())
 370       break;
 371     for (unsigned i = 1, e = MI.getNumOperands(); i != e; i += 2) {
 372       unsigned SrcReg = MI.getOperand(i).getReg();
 373       UsedByPhi->insert(SrcReg);
 374     }
 375   }
 376 }
 377
 378 /// AddSSAUpdateEntry - Add a definition and source virtual registers pair for
 379 /// SSA update.
 380 void TailDuplicatePass::AddSSAUpdateEntry(unsigned OrigReg, unsigned NewReg,
 381                                           MachineBasicBlock *BB) {
 382   DenseMap<unsigned, AvailableValsTy>::iterator LI= SSAUpdateVals.find(OrigReg);
 383   if (LI != SSAUpdateVals.end())
 384     LI->second.push_back(std::make_pair(BB, NewReg));
 385   else {
 386     AvailableValsTy Vals;
 387     Vals.push_back(std::make_pair(BB, NewReg));
 388     SSAUpdateVals.insert(std::make_pair(OrigReg, Vals));
 389     SSAUpdateVRs.push_back(OrigReg);
 390   }
 391 }
 392
 393 /// ProcessPHI - Process PHI node in TailBB by turning it into a copy in PredBB.
 394 /// Remember the source register that's contributed by PredBB and update SSA
 395 /// update map.
 396 void TailDuplicatePass::ProcessPHI(
 397     MachineInstr *MI, MachineBasicBlock *TailBB, MachineBasicBlock *PredBB,
 398     DenseMap<unsigned, unsigned> &LocalVRMap,
 399     SmallVectorImpl<std::pair<unsigned, unsigned> > &Copies,
 400     const DenseSet<unsigned> &RegsUsedByPhi, bool Remove) {
 401   unsigned DefReg = MI->getOperand(0).getReg();
 402   unsigned SrcOpIdx = getPHISrcRegOpIdx(MI, PredBB);
 403   assert(SrcOpIdx && "Unable to find matching PHI source?");
 404   unsigned SrcReg = MI->getOperand(SrcOpIdx).getReg();
 405   const TargetRegisterClass *RC = MRI->getRegClass(DefReg);
 406   LocalVRMap.insert(std::make_pair(DefReg, SrcReg));
 407
 408   // Insert a copy from source to the end of the block. The def register is the
 409   // available value liveout of the block.
 410   unsigned NewDef = MRI->createVirtualRegister(RC);
 411   Copies.push_back(std::make_pair(NewDef, SrcReg));
 412   if (isDefLiveOut(DefReg, TailBB, MRI) || RegsUsedByPhi.count(DefReg))
 413     AddSSAUpdateEntry(DefReg, NewDef, PredBB);
 414
 415   if (!Remove)
 416     return;
 417
 418   // Remove PredBB from the PHI node.
 419   MI->RemoveOperand(SrcOpIdx+1);
 420   MI->RemoveOperand(SrcOpIdx);
 421   if (MI->getNumOperands() == 1)
 422     MI->eraseFromParent();
 423 }
 424
 425 /// DuplicateInstruction - Duplicate a TailBB instruction to PredBB and update
 426 /// the source operands due to earlier PHI translation.
 427 void TailDuplicatePass::DuplicateInstruction(MachineInstr *MI,
 428                                      MachineBasicBlock *TailBB,
 429                                      MachineBasicBlock *PredBB,
 430                                      MachineFunction &MF,
 431                                      DenseMap<unsigned, unsigned> &LocalVRMap,
 432                                      const DenseSet<unsigned> &UsedByPhi) {
 433   MachineInstr *NewMI = TII->duplicate(MI, MF);
 434   for (unsigned i = 0, e = NewMI->getNumOperands(); i != e; ++i) {
 435     MachineOperand &MO = NewMI->getOperand(i);
 436     if (!MO.isReg())
 437       continue;
 438     unsigned Reg = MO.getReg();
 439     if (!TargetRegisterInfo::isVirtualRegister(Reg))
 440       continue;
 441     if (MO.isDef()) {
 442       const TargetRegisterClass *RC = MRI->getRegClass(Reg);
 443       unsigned NewReg = MRI->createVirtualRegister(RC);
 444       MO.setReg(NewReg);
 445       LocalVRMap.insert(std::make_pair(Reg, NewReg));
 446       if (isDefLiveOut(Reg, TailBB, MRI) || UsedByPhi.count(Reg))
 447         AddSSAUpdateEntry(Reg, NewReg, PredBB);
 448     } else {
 449       DenseMap<unsigned, unsigned>::iterator VI = LocalVRMap.find(Reg);
 450       if (VI != LocalVRMap.end()) {
 451         MO.setReg(VI->second);
 452         MRI->constrainRegClass(VI->second, MRI->getRegClass(Reg));
 453       }
 454     }
 455   }
 456   PredBB->insert(PredBB->instr_end(), NewMI);
 457 }
 458
 459 /// UpdateSuccessorsPHIs - After FromBB is tail duplicated into its predecessor
 460 /// blocks, the successors have gained new predecessors. Update the PHI
 461 /// instructions in them accordingly.
 462 void
 463 TailDuplicatePass::UpdateSuccessorsPHIs(MachineBasicBlock *FromBB, bool isDead,
 464                                   SmallVectorImpl<MachineBasicBlock *> &TDBBs,
 465                                   SmallSetVector<MachineBasicBlock*,8> &Succs) {
 466   for (SmallSetVector<MachineBasicBlock*, 8>::iterator SI = Succs.begin(),
 467          SE = Succs.end(); SI != SE; ++SI) {
 468     MachineBasicBlock *SuccBB = *SI;
 469     for (MachineBasicBlock::iterator II = SuccBB->begin(), EE = SuccBB->end();
 470          II != EE; ++II) {
 471       if (!II->isPHI())
 472         break;
 473       MachineInstrBuilder MIB(*FromBB->getParent(), II);
 474       unsigned Idx = 0;
 475       for (unsigned i = 1, e = II->getNumOperands(); i != e; i += 2) {
 476         MachineOperand &MO = II->getOperand(i+1);
 477         if (MO.getMBB() == FromBB) {
 478           Idx = i;
 479           break;
 480         }
 481       }
 482
 483       assert(Idx != 0);
 484       MachineOperand &MO0 = II->getOperand(Idx);
 485       unsigned Reg = MO0.getReg();
 486       if (isDead) {
 487         // Folded into the previous BB.
 488         // There could be duplicate phi source entries. FIXME: Should sdisel
 489         // or earlier pass fixed this?
 490         for (unsigned i = II->getNumOperands()-2; i != Idx; i -= 2) {
 491           MachineOperand &MO = II->getOperand(i+1);
 492           if (MO.getMBB() == FromBB) {
 493             II->RemoveOperand(i+1);
 494             II->RemoveOperand(i);
 495           }
 496         }
 497       } else
 498         Idx = 0;
 499
 500       // If Idx is set, the operands at Idx and Idx+1 must be removed.
 501       // We reuse the location to avoid expensive RemoveOperand calls.
 502
 503       DenseMap<unsigned,AvailableValsTy>::iterator LI=SSAUpdateVals.find(Reg);
 504       if (LI != SSAUpdateVals.end()) {
 505         // This register is defined in the tail block.
 506         for (unsigned j = 0, ee = LI->second.size(); j != ee; ++j) {
 507           MachineBasicBlock *SrcBB = LI->second[j].first;
 508           // If we didn't duplicate a bb into a particular predecessor, we
 509           // might still have added an entry to SSAUpdateVals to correcly
 510           // recompute SSA. If that case, avoid adding a dummy extra argument
 511           // this PHI.
 512           if (!SrcBB->isSuccessor(SuccBB))
 513             continue;
 514
 515           unsigned SrcReg = LI->second[j].second;
 516           if (Idx != 0) {
 517             II->getOperand(Idx).setReg(SrcReg);
 518             II->getOperand(Idx+1).setMBB(SrcBB);
 519             Idx = 0;
 520           } else {
 521             MIB.addReg(SrcReg).addMBB(SrcBB);
 522           }
 523         }
 524       } else {
 525         // Live in tail block, must also be live in predecessors.
 526         for (unsigned j = 0, ee = TDBBs.size(); j != ee; ++j) {
 527           MachineBasicBlock *SrcBB = TDBBs[j];
 528           if (Idx != 0) {
 529             II->getOperand(Idx).setReg(Reg);
 530             II->getOperand(Idx+1).setMBB(SrcBB);
 531             Idx = 0;
 532           } else {
 533             MIB.addReg(Reg).addMBB(SrcBB);
 534           }
 535         }
 536       }
 537       if (Idx != 0) {
 538         II->RemoveOperand(Idx+1);
 539         II->RemoveOperand(Idx);
 540       }
 541     }
 542   }
 543 }
 544
 545 /// shouldTailDuplicate - Determine if it is profitable to duplicate this block.
 546 bool
 547 TailDuplicatePass::shouldTailDuplicate(const MachineFunction &MF,
 548                                        bool IsSimple,
 549                                        MachineBasicBlock &TailBB) {
 550   // Only duplicate blocks that end with unconditional branches.
 551   if (TailBB.canFallThrough())
 552     return false;
 553
 554   // Don't try to tail-duplicate single-block loops.
 555   if (TailBB.isSuccessor(&TailBB))
 556     return false;
 557
 558   // Set the limit on the cost to duplicate. When optimizing for size,
 559   // duplicate only one, because one branch instruction can be eliminated to
 560   // compensate for the duplication.
 561   unsigned MaxDuplicateCount;
 562   if (TailDuplicateSize.getNumOccurrences() == 0 &&
 563       MF.getFunction()->getAttributes().
 564         hasAttribute(AttributeSet::FunctionIndex, Attribute::OptimizeForSize))
 565     MaxDuplicateCount = 1;
 566   else
 567     MaxDuplicateCount = TailDuplicateSize;
 568
 569   // If the target has hardware branch prediction that can handle indirect
 570   // branches, duplicating them can often make them predictable when there
 571   // are common paths through the code.  The limit needs to be high enough
 572   // to allow undoing the effects of tail merging and other optimizations
 573   // that rearrange the predecessors of the indirect branch.
 574
 575   bool HasIndirectbr = false;
 576   if (!TailBB.empty())
 577     HasIndirectbr = TailBB.back().isIndirectBranch();
 578
 579   if (HasIndirectbr && PreRegAlloc)
 580     MaxDuplicateCount = 20;
 581
 582   // Check the instructions in the block to determine whether tail-duplication
 583   // is invalid or unlikely to be profitable.
 584   unsigned InstrCount = 0;
 585   for (MachineBasicBlock::iterator I = TailBB.begin(); I != TailBB.end(); ++I) {
 586     // Non-duplicable things shouldn't be tail-duplicated.
 587     if (I->isNotDuplicable())
 588       return false;
 589
 590     // Do not duplicate 'return' instructions if this is a pre-regalloc run.
 591     // A return may expand into a lot more instructions (e.g. reload of callee
 592     // saved registers) after PEI.
 593     if (PreRegAlloc && I->isReturn())
 594       return false;
 595
 596     // Avoid duplicating calls before register allocation. Calls presents a
 597     // barrier to register allocation so duplicating them may end up increasing
 598     // spills.
 599     if (PreRegAlloc && I->isCall())
 600       return false;
 601
 602     if (!I->isPHI() && !I->isDebugValue())
 603       InstrCount += 1;
 604
 605     if (InstrCount > MaxDuplicateCount)
 606       return false;
 607   }
 608
 609   if (HasIndirectbr && PreRegAlloc)
 610     return true;
 611
 612   if (IsSimple)
 613     return true;
 614
 615   if (!PreRegAlloc)
 616     return true;
 617
 618   return canCompletelyDuplicateBB(TailBB);
 619 }
 620
 621 /// isSimpleBB - True if this BB has only one unconditional jump.
 622 bool
 623 TailDuplicatePass::isSimpleBB(MachineBasicBlock *TailBB) {
 624   if (TailBB->succ_size() != 1)
 625     return false;
 626   if (TailBB->pred_empty())
 627     return false;
 628   MachineBasicBlock::iterator I = TailBB->begin();
 629   MachineBasicBlock::iterator E = TailBB->end();
 630   while (I != E && I->isDebugValue())
 631     ++I;
 632   if (I == E)
 633     return true;
 634   return I->isUnconditionalBranch();
 635 }
 636
 637 static bool
 638 bothUsedInPHI(const MachineBasicBlock &A,
 639               SmallPtrSet<MachineBasicBlock*, 8> SuccsB) {
 640   for (MachineBasicBlock::const_succ_iterator SI = A.succ_begin(),
 641          SE = A.succ_end(); SI != SE; ++SI) {
 642     MachineBasicBlock *BB = *SI;
 643     if (SuccsB.count(BB) && !BB->empty() && BB->begin()->isPHI())
 644       return true;
 645   }
 646
 647   return false;
 648 }
 649
 650 bool
 651 TailDuplicatePass::canCompletelyDuplicateBB(MachineBasicBlock &BB) {
 652   for (MachineBasicBlock::pred_iterator PI = BB.pred_begin(),
 653        PE = BB.pred_end(); PI != PE; ++PI) {
 654     MachineBasicBlock *PredBB = *PI;
 655
 656     if (PredBB->succ_size() > 1)
 657       return false;
 658
 659     MachineBasicBlock *PredTBB = nullptr, *PredFBB = nullptr;
 660     SmallVector<MachineOperand, 4> PredCond;
 661     if (TII->AnalyzeBranch(*PredBB, PredTBB, PredFBB, PredCond, true))
 662       return false;
 663
 664     if (!PredCond.empty())
 665       return false;
 666   }
 667   return true;
 668 }
 669
 670 bool
 671 TailDuplicatePass::duplicateSimpleBB(MachineBasicBlock *TailBB,
 672                                     SmallVectorImpl<MachineBasicBlock *> &TDBBs,
 673                                     const DenseSet<unsigned> &UsedByPhi,
 674                                     SmallVectorImpl<MachineInstr *> &Copies) {
 675   SmallPtrSet<MachineBasicBlock*, 8> Succs(TailBB->succ_begin(),
 676                                            TailBB->succ_end());
 677   SmallVector<MachineBasicBlock*, 8> Preds(TailBB->pred_begin(),
 678                                            TailBB->pred_end());
 679   bool Changed = false;
 680   for (SmallSetVector<MachineBasicBlock *, 8>::iterator PI = Preds.begin(),
 681        PE = Preds.end(); PI != PE; ++PI) {
 682     MachineBasicBlock *PredBB = *PI;
 683
 684     if (PredBB->getLandingPadSuccessor())
 685       continue;
 686
 687     if (bothUsedInPHI(*PredBB, Succs))
 688       continue;
 689
 690     MachineBasicBlock *PredTBB = nullptr, *PredFBB = nullptr;
 691     SmallVector<MachineOperand, 4> PredCond;
 692     if (TII->AnalyzeBranch(*PredBB, PredTBB, PredFBB, PredCond, true))
 693       continue;
 694
 695     Changed = true;
 696     DEBUG(dbgs() << "\nTail-duplicating into PredBB: " << *PredBB
 697                  << "From simple Succ: " << *TailBB);
 698
 699     MachineBasicBlock *NewTarget = *TailBB->succ_begin();
 700     MachineBasicBlock *NextBB = std::next(MachineFunction::iterator(PredBB));
 701
 702     // Make PredFBB explicit.
 703     if (PredCond.empty())
 704       PredFBB = PredTBB;
 705
 706     // Make fall through explicit.
 707     if (!PredTBB)
 708       PredTBB = NextBB;
 709     if (!PredFBB)
 710       PredFBB = NextBB;
 711
 712     // Redirect
 713     if (PredFBB == TailBB)
 714       PredFBB = NewTarget;
 715     if (PredTBB == TailBB)
 716       PredTBB = NewTarget;
 717
 718     // Make the branch unconditional if possible
 719     if (PredTBB == PredFBB) {
 720       PredCond.clear();
 721       PredFBB = nullptr;
 722     }
 723
 724     // Avoid adding fall through branches.
 725     if (PredFBB == NextBB)
 726       PredFBB = nullptr;
 727     if (PredTBB == NextBB && PredFBB == nullptr)
 728       PredTBB = nullptr;
 729
 730     TII->RemoveBranch(*PredBB);
 731
 732     if (PredTBB)
 733       TII->InsertBranch(*PredBB, PredTBB, PredFBB, PredCond, DebugLoc());
 734
 735     uint32_t Weight = MBPI->getEdgeWeight(PredBB, TailBB);
 736     PredBB->removeSuccessor(TailBB);
 737     unsigned NumSuccessors = PredBB->succ_size();
 738     assert(NumSuccessors <= 1);
 739     if (NumSuccessors == 0 || *PredBB->succ_begin() != NewTarget)
 740       PredBB->addSuccessor(NewTarget, Weight);
 741
 742     TDBBs.push_back(PredBB);
 743   }
 744   return Changed;
 745 }
 746
 747 /// TailDuplicate - If it is profitable, duplicate TailBB's contents in each
 748 /// of its predecessors.
 749 bool
 750 TailDuplicatePass::TailDuplicate(MachineBasicBlock *TailBB,
 751                                  bool IsSimple,
 752                                  MachineFunction &MF,
 753                                  SmallVectorImpl<MachineBasicBlock *> &TDBBs,
 754                                  SmallVectorImpl<MachineInstr *> &Copies) {
 755   DEBUG(dbgs() << "\n*** Tail-duplicating BB#" << TailBB->getNumber() << '\n');
 756
 757   DenseSet<unsigned> UsedByPhi;
 758   getRegsUsedByPHIs(*TailBB, &UsedByPhi);
 759
 760   if (IsSimple)
 761     return duplicateSimpleBB(TailBB, TDBBs, UsedByPhi, Copies);
 762
 763   // Iterate through all the unique predecessors and tail-duplicate this
 764   // block into them, if possible. Copying the list ahead of time also
 765   // avoids trouble with the predecessor list reallocating.
 766   bool Changed = false;
 767   SmallSetVector<MachineBasicBlock*, 8> Preds(TailBB->pred_begin(),
 768                                               TailBB->pred_end());
 769   for (SmallSetVector<MachineBasicBlock *, 8>::iterator PI = Preds.begin(),
 770        PE = Preds.end(); PI != PE; ++PI) {
 771     MachineBasicBlock *PredBB = *PI;
 772
 773     assert(TailBB != PredBB &&
 774            "Single-block loop should have been rejected earlier!");
 775     // EH edges are ignored by AnalyzeBranch.
 776     if (PredBB->succ_size() > 1)
 777       continue;
 778
 779     MachineBasicBlock *PredTBB, *PredFBB;
 780     SmallVector<MachineOperand, 4> PredCond;
 781     if (TII->AnalyzeBranch(*PredBB, PredTBB, PredFBB, PredCond, true))
 782       continue;
 783     if (!PredCond.empty())
 784       continue;
 785     // Don't duplicate into a fall-through predecessor (at least for now).
 786     if (PredBB->isLayoutSuccessor(TailBB) && PredBB->canFallThrough())
 787       continue;
 788
 789     DEBUG(dbgs() << "\nTail-duplicating into PredBB: " << *PredBB
 790                  << "From Succ: " << *TailBB);
 791
 792     TDBBs.push_back(PredBB);
 793
 794     // Remove PredBB's unconditional branch.
 795     TII->RemoveBranch(*PredBB);
 796
 797     if (RS && !TailBB->livein_empty()) {
 798       // Update PredBB livein.
 799       RS->enterBasicBlock(PredBB);
 800       if (!PredBB->empty())
 801         RS->forward(std::prev(PredBB->end()));
 802       BitVector RegsLiveAtExit(TRI->getNumRegs());
 803       RS->getRegsUsed(RegsLiveAtExit, false);
 804       for (MachineBasicBlock::livein_iterator I = TailBB->livein_begin(),
 805              E = TailBB->livein_end(); I != E; ++I) {
 806         if (!RegsLiveAtExit[*I])
 807           // If a register is previously livein to the tail but it's not live
 808           // at the end of predecessor BB, then it should be added to its
 809           // livein list.
 810           PredBB->addLiveIn(*I);
 811       }
 812     }
 813
 814     // Clone the contents of TailBB into PredBB.
 815     DenseMap<unsigned, unsigned> LocalVRMap;
 816     SmallVector<std::pair<unsigned,unsigned>, 4> CopyInfos;
 817     // Use instr_iterator here to properly handle bundles, e.g.
 818     // ARM Thumb2 IT block.
 819     MachineBasicBlock::instr_iterator I = TailBB->instr_begin();
 820     while (I != TailBB->instr_end()) {
 821       MachineInstr *MI = &*I;
 822       ++I;
 823       if (MI->isPHI()) {
 824         // Replace the uses of the def of the PHI with the register coming
 825         // from PredBB.
 826         ProcessPHI(MI, TailBB, PredBB, LocalVRMap, CopyInfos, UsedByPhi, true);
 827       } else {
 828         // Replace def of virtual registers with new registers, and update
 829         // uses with PHI source register or the new registers.
 830         DuplicateInstruction(MI, TailBB, PredBB, MF, LocalVRMap, UsedByPhi);
 831       }
 832     }
 833     MachineBasicBlock::iterator Loc = PredBB->getFirstTerminator();
 834     for (unsigned i = 0, e = CopyInfos.size(); i != e; ++i) {
 835       Copies.push_back(BuildMI(*PredBB, Loc, DebugLoc(),
 836                                TII->get(TargetOpcode::COPY),
 837                                CopyInfos[i].first).addReg(CopyInfos[i].second));
 838     }
 839
 840     // Simplify
 841     TII->AnalyzeBranch(*PredBB, PredTBB, PredFBB, PredCond, true);
 842
 843     NumInstrDups += TailBB->size() - 1; // subtract one for removed branch
 844
 845     // Update the CFG.
 846     PredBB->removeSuccessor(PredBB->succ_begin());
 847     assert(PredBB->succ_empty() &&
 848            "TailDuplicate called on block with multiple successors!");
 849     for (MachineBasicBlock::succ_iterator I = TailBB->succ_begin(),
 850            E = TailBB->succ_end(); I != E; ++I)
 851       PredBB->addSuccessor(*I, MBPI->getEdgeWeight(TailBB, I));
 852
 853     Changed = true;
 854     ++NumTailDups;
 855   }
 856
 857   // If TailBB was duplicated into all its predecessors except for the prior
 858   // block, which falls through unconditionally, move the contents of this
 859   // block into the prior block.
 860   MachineBasicBlock *PrevBB = std::prev(MachineFunction::iterator(TailBB));
 861   MachineBasicBlock *PriorTBB = nullptr, *PriorFBB = nullptr;
 862   SmallVector<MachineOperand, 4> PriorCond;
 863   // This has to check PrevBB->succ_size() because EH edges are ignored by
 864   // AnalyzeBranch.
 865   if (PrevBB->succ_size() == 1 &&
 866       !TII->AnalyzeBranch(*PrevBB, PriorTBB, PriorFBB, PriorCond, true) &&
 867       PriorCond.empty() && !PriorTBB && TailBB->pred_size() == 1 &&
 868       !TailBB->hasAddressTaken()) {
 869     DEBUG(dbgs() << "\nMerging into block: " << *PrevBB
 870           << "From MBB: " << *TailBB);
 871     if (PreRegAlloc) {
 872       DenseMap<unsigned, unsigned> LocalVRMap;
 873       SmallVector<std::pair<unsigned,unsigned>, 4> CopyInfos;
 874       MachineBasicBlock::iterator I = TailBB->begin();
 875       // Process PHI instructions first.
 876       while (I != TailBB->end() && I->isPHI()) {
 877         // Replace the uses of the def of the PHI with the register coming
 878         // from PredBB.
 879         MachineInstr *MI = &*I++;
 880         ProcessPHI(MI, TailBB, PrevBB, LocalVRMap, CopyInfos, UsedByPhi, true);
 881         if (MI->getParent())
 882           MI->eraseFromParent();
 883       }
 884
 885       // Now copy the non-PHI instructions.
 886       while (I != TailBB->end()) {
 887         // Replace def of virtual registers with new registers, and update
 888         // uses with PHI source register or the new registers.
 889         MachineInstr *MI = &*I++;
 890         assert(!MI->isBundle() && "Not expecting bundles before regalloc!");
 891         DuplicateInstruction(MI, TailBB, PrevBB, MF, LocalVRMap, UsedByPhi);
 892         MI->eraseFromParent();
 893       }
 894       MachineBasicBlock::iterator Loc = PrevBB->getFirstTerminator();
 895       for (unsigned i = 0, e = CopyInfos.size(); i != e; ++i) {
 896         Copies.push_back(BuildMI(*PrevBB, Loc, DebugLoc(),
 897                                  TII->get(TargetOpcode::COPY),
 898                                  CopyInfos[i].first)
 899                            .addReg(CopyInfos[i].second));
 900       }
 901     } else {
 902       // No PHIs to worry about, just splice the instructions over.
 903       PrevBB->splice(PrevBB->end(), TailBB, TailBB->begin(), TailBB->end());
 904     }
 905     PrevBB->removeSuccessor(PrevBB->succ_begin());
 906     assert(PrevBB->succ_empty());
 907     PrevBB->transferSuccessors(TailBB);
 908     TDBBs.push_back(PrevBB);
 909     Changed = true;
 910   }
 911
 912   // If this is after register allocation, there are no phis to fix.
 913   if (!PreRegAlloc)
 914     return Changed;
 915
 916   // If we made no changes so far, we are safe.
 917   if (!Changed)
 918     return Changed;
 919
 920
 921   // Handle the nasty case in that we duplicated a block that is part of a loop
 922   // into some but not all of its predecessors. For example:
 923   //    1 -> 2 <-> 3                 |
 924   //          \                      |
 925   //           \---> rest            |
 926   // if we duplicate 2 into 1 but not into 3, we end up with
 927   // 12 -> 3 <-> 2 -> rest           |
 928   //   \             /               |
 929   //    \----->-----/                |
 930   // If there was a "var = phi(1, 3)" in 2, it has to be ultimately replaced
 931   // with a phi in 3 (which now dominates 2).
 932   // What we do here is introduce a copy in 3 of the register defined by the
 933   // phi, just like when we are duplicating 2 into 3, but we don't copy any
 934   // real instructions or remove the 3 -> 2 edge from the phi in 2.
 935   for (SmallSetVector<MachineBasicBlock *, 8>::iterator PI = Preds.begin(),
 936        PE = Preds.end(); PI != PE; ++PI) {
 937     MachineBasicBlock *PredBB = *PI;
 938     if (std::find(TDBBs.begin(), TDBBs.end(), PredBB) != TDBBs.end())
 939       continue;
 940
 941     // EH edges
 942     if (PredBB->succ_size() != 1)
 943       continue;
 944
 945     DenseMap<unsigned, unsigned> LocalVRMap;
 946     SmallVector<std::pair<unsigned,unsigned>, 4> CopyInfos;
 947     MachineBasicBlock::iterator I = TailBB->begin();
 948     // Process PHI instructions first.
 949     while (I != TailBB->end() && I->isPHI()) {
 950       // Replace the uses of the def of the PHI with the register coming
 951       // from PredBB.
 952       MachineInstr *MI = &*I++;
 953       ProcessPHI(MI, TailBB, PredBB, LocalVRMap, CopyInfos, UsedByPhi, false);
 954     }
 955     MachineBasicBlock::iterator Loc = PredBB->getFirstTerminator();
 956     for (unsigned i = 0, e = CopyInfos.size(); i != e; ++i) {
 957       Copies.push_back(BuildMI(*PredBB, Loc, DebugLoc(),
 958                                TII->get(TargetOpcode::COPY),
 959                                CopyInfos[i].first).addReg(CopyInfos[i].second));
 960     }
 961   }
 962
 963   return Changed;
 964 }
 965
 966 /// RemoveDeadBlock - Remove the specified dead machine basic block from the
 967 /// function, updating the CFG.
 968 void TailDuplicatePass::RemoveDeadBlock(MachineBasicBlock *MBB) {
 969   assert(MBB->pred_empty() && "MBB must be dead!");
 970   DEBUG(dbgs() << "\nRemoving MBB: " << *MBB);
 971
 972   // Remove all successors.
 973   while (!MBB->succ_empty())
 974     MBB->removeSuccessor(MBB->succ_end()-1);
 975
 976   // Remove the block.
 977   MBB->eraseFromParent();
 978 }