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 #include "llvm/CodeGen/Passes.h"
  16 #include "llvm/ADT/DenseSet.h"
  17 #include "llvm/ADT/SetVector.h"
  18 #include "llvm/ADT/SmallSet.h"
  19 #include "llvm/ADT/Statistic.h"
  20 #include "llvm/CodeGen/MachineBranchProbabilityInfo.h"
  21 #include "llvm/CodeGen/MachineFunctionPass.h"
  22 #include "llvm/CodeGen/MachineInstrBuilder.h"
  23 #include "llvm/CodeGen/MachineModuleInfo.h"
  24 #include "llvm/CodeGen/MachineRegisterInfo.h"
  25 #include "llvm/CodeGen/MachineSSAUpdater.h"
  26 #include "llvm/CodeGen/RegisterScavenging.h"
  27 #include "llvm/IR/Function.h"
  28 #include "llvm/Support/CommandLine.h"
  29 #include "llvm/Support/Debug.h"
  30 #include "llvm/Support/ErrorHandling.h"
  31 #include "llvm/Support/raw_ostream.h"
  32 #include "llvm/Target/TargetInstrInfo.h"
  33 #include "llvm/Target/TargetRegisterInfo.h"
  34 #include "llvm/Target/TargetSubtargetInfo.h"
  35 using namespace llvm;
  36
  37 #define DEBUG_TYPE "tailduplication"
  38
  39 STATISTIC(NumTails     , "Number of tails duplicated");
  40 STATISTIC(NumTailDups  , "Number of tail duplicated blocks");
  41 STATISTIC(NumInstrDups , "Additional instructions due to tail duplication");
  42 STATISTIC(NumDeadBlocks, "Number of dead blocks removed");
  43 STATISTIC(NumAddedPHIs , "Number of phis added");
  44
  45 // Heuristic for tail duplication.
  46 static cl::opt<unsigned>
  47 TailDuplicateSize("tail-dup-size",
  48                   cl::desc("Maximum instructions to consider tail duplicating"),
  49                   cl::init(2), cl::Hidden);
  50
  51 static cl::opt<bool>
  52 TailDupVerify("tail-dup-verify",
  53               cl::desc("Verify sanity of PHI instructions during taildup"),
  54               cl::init(false), cl::Hidden);
  55
  56 static cl::opt<unsigned>
  57 TailDupLimit("tail-dup-limit", cl::init(~0U), cl::Hidden);
  58
  59 typedef std::vector<std::pair<MachineBasicBlock*,unsigned> > AvailableValsTy;
  60
  61 namespace {
  62   /// TailDuplicatePass - Perform tail duplication.
  63   class TailDuplicatePass : public MachineFunctionPass {
  64     const TargetInstrInfo *TII;
  65     const TargetRegisterInfo *TRI;
  66     const MachineBranchProbabilityInfo *MBPI;
  67     MachineModuleInfo *MMI;
  68     MachineRegisterInfo *MRI;
  69     std::unique_ptr<RegScavenger> RS;
  70     bool PreRegAlloc;
  71
  72     // SSAUpdateVRs - A list of virtual registers for which to update SSA form.
  73     SmallVector<unsigned, 16> SSAUpdateVRs;
  74
  75     // SSAUpdateVals - For each virtual register in SSAUpdateVals keep a list of
  76     // source virtual registers.
  77     DenseMap<unsigned, AvailableValsTy> SSAUpdateVals;
  78
  79   public:
  80     static char ID;
  81     explicit TailDuplicatePass() :
  82       MachineFunctionPass(ID), PreRegAlloc(false) {}
  83
  84     bool runOnMachineFunction(MachineFunction &MF) override;
  85
  86     void getAnalysisUsage(AnalysisUsage &AU) const override;
  87
  88   private:
  89     void AddSSAUpdateEntry(unsigned OrigReg, unsigned NewReg,
  90                            MachineBasicBlock *BB);
  91     void ProcessPHI(MachineInstr *MI, MachineBasicBlock *TailBB,
  92                     MachineBasicBlock *PredBB,
  93                     DenseMap<unsigned, unsigned> &LocalVRMap,
  94                     SmallVectorImpl<std::pair<unsigned,unsigned> > &Copies,
  95                     const DenseSet<unsigned> &UsedByPhi,
  96                     bool Remove);
  97     void DuplicateInstruction(MachineInstr *MI,
  98                               MachineBasicBlock *TailBB,
  99                               MachineBasicBlock *PredBB,
 100                               MachineFunction &MF,
 101                               DenseMap<unsigned, unsigned> &LocalVRMap,
 102                               const DenseSet<unsigned> &UsedByPhi);
 103     void UpdateSuccessorsPHIs(MachineBasicBlock *FromBB, bool isDead,
 104                               SmallVectorImpl<MachineBasicBlock *> &TDBBs,
 105                               SmallSetVector<MachineBasicBlock*, 8> &Succs);
 106     bool TailDuplicateBlocks(MachineFunction &MF);
 107     bool shouldTailDuplicate(const MachineFunction &MF,
 108                              bool IsSimple, MachineBasicBlock &TailBB);
 109     bool isSimpleBB(MachineBasicBlock *TailBB);
 110     bool canCompletelyDuplicateBB(MachineBasicBlock &BB);
 111     bool duplicateSimpleBB(MachineBasicBlock *TailBB,
 112                            SmallVectorImpl<MachineBasicBlock *> &TDBBs,
 113                            const DenseSet<unsigned> &RegsUsedByPhi,
 114                            SmallVectorImpl<MachineInstr *> &Copies);
 115     bool TailDuplicate(MachineBasicBlock *TailBB,
 116                        bool IsSimple,
 117                        MachineFunction &MF,
 118                        SmallVectorImpl<MachineBasicBlock *> &TDBBs,
 119                        SmallVectorImpl<MachineInstr *> &Copies);
 120     bool TailDuplicateAndUpdate(MachineBasicBlock *MBB,
 121                                 bool IsSimple,
 122                                 MachineFunction &MF);
 123
 124     void RemoveDeadBlock(MachineBasicBlock *MBB);
 125   };
 126
 127   char TailDuplicatePass::ID = 0;
 128 }
 129
 130 char &llvm::TailDuplicateID = TailDuplicatePass::ID;
 131
 132 INITIALIZE_PASS(TailDuplicatePass, "tailduplication", "Tail Duplication",
 133                 false, false)
 134
 135 bool TailDuplicatePass::runOnMachineFunction(MachineFunction &MF) {
 136   if (skipOptnoneFunction(*MF.getFunction()))
 137     return false;
 138
 139   TII = MF.getSubtarget().getInstrInfo();
 140   TRI = MF.getSubtarget().getRegisterInfo();
 141   MRI = &MF.getRegInfo();
 142   MMI = getAnalysisIfAvailable<MachineModuleInfo>();
 143   MBPI = &getAnalysis<MachineBranchProbabilityInfo>();
 144
 145   PreRegAlloc = MRI->isSSA();
 146   RS.reset();
 147   if (MRI->tracksLiveness() && TRI->trackLivenessAfterRegAlloc(MF))
 148     RS.reset(new RegScavenger());
 149
 150   bool MadeChange = false;
 151   while (TailDuplicateBlocks(MF))
 152     MadeChange = true;
 153
 154   return MadeChange;
 155 }
 156
 157 void TailDuplicatePass::getAnalysisUsage(AnalysisUsage &AU) const {
 158   AU.addRequired<MachineBranchProbabilityInfo>();
 159   MachineFunctionPass::getAnalysisUsage(AU);
 160 }
 161
 162 static void VerifyPHIs(MachineFunction &MF, bool CheckExtra) {
 163   for (MachineFunction::iterator I = ++MF.begin(), E = MF.end(); I != E; ++I) {
 164     MachineBasicBlock *MBB = I;
 165     SmallSetVector<MachineBasicBlock*, 8> Preds(MBB->pred_begin(),
 166                                                 MBB->pred_end());
 167     MachineBasicBlock::iterator MI = MBB->begin();
 168     while (MI != MBB->end()) {
 169       if (!MI->isPHI())
 170         break;
 171       for (SmallSetVector<MachineBasicBlock *, 8>::iterator PI = Preds.begin(),
 172              PE = Preds.end(); PI != PE; ++PI) {
 173         MachineBasicBlock *PredBB = *PI;
 174         bool Found = false;
 175         for (unsigned i = 1, e = MI->getNumOperands(); i != e; i += 2) {
 176           MachineBasicBlock *PHIBB = MI->getOperand(i+1).getMBB();
 177           if (PHIBB == PredBB) {
 178             Found = true;
 179             break;
 180           }
 181         }
 182         if (!Found) {
 183           dbgs() << "Malformed PHI in BB#" << MBB->getNumber() << ": " << *MI;
 184           dbgs() << "  missing input from predecessor BB#"
 185                  << PredBB->getNumber() << '\n';
 186           llvm_unreachable(nullptr);
 187         }
 188       }
 189
 190       for (unsigned i = 1, e = MI->getNumOperands(); i != e; i += 2) {
 191         MachineBasicBlock *PHIBB = MI->getOperand(i+1).getMBB();
 192         if (CheckExtra && !Preds.count(PHIBB)) {
 193           dbgs() << "Warning: malformed PHI in BB#" << MBB->getNumber()
 194                  << ": " << *MI;
 195           dbgs() << "  extra input from predecessor BB#"
 196                  << PHIBB->getNumber() << '\n';
 197           llvm_unreachable(nullptr);
 198         }
 199         if (PHIBB->getNumber() < 0) {
 200           dbgs() << "Malformed PHI in BB#" << MBB->getNumber() << ": " << *MI;
 201           dbgs() << "  non-existing BB#" << PHIBB->getNumber() << '\n';
 202           llvm_unreachable(nullptr);
 203         }
 204       }
 205       ++MI;
 206     }
 207   }
 208 }
 209
 210 /// TailDuplicateAndUpdate - Tail duplicate the block and cleanup.
 211 bool
 212 TailDuplicatePass::TailDuplicateAndUpdate(MachineBasicBlock *MBB,
 213                                           bool IsSimple,
 214                                           MachineFunction &MF) {
 215   // Save the successors list.
 216   SmallSetVector<MachineBasicBlock*, 8> Succs(MBB->succ_begin(),
 217                                               MBB->succ_end());
 218
 219   SmallVector<MachineBasicBlock*, 8> TDBBs;
 220   SmallVector<MachineInstr*, 16> Copies;
 221   if (!TailDuplicate(MBB, IsSimple, MF, TDBBs, Copies))
 222     return false;
 223
 224   ++NumTails;
 225
 226   SmallVector<MachineInstr*, 8> NewPHIs;
 227   MachineSSAUpdater SSAUpdate(MF, &NewPHIs);
 228
 229   // TailBB's immediate successors are now successors of those predecessors
 230   // which duplicated TailBB. Add the predecessors as sources to the PHI
 231   // instructions.
 232   bool isDead = MBB->pred_empty() && !MBB->hasAddressTaken();
 233   if (PreRegAlloc)
 234     UpdateSuccessorsPHIs(MBB, isDead, TDBBs, Succs);
 235
 236   // If it is dead, remove it.
 237   if (isDead) {
 238     NumInstrDups -= MBB->size();
 239     RemoveDeadBlock(MBB);
 240     ++NumDeadBlocks;
 241   }
 242
 243   // Update SSA form.
 244   if (!SSAUpdateVRs.empty()) {
 245     for (unsigned i = 0, e = SSAUpdateVRs.size(); i != e; ++i) {
 246       unsigned VReg = SSAUpdateVRs[i];
 247       SSAUpdate.Initialize(VReg);
 248
 249       // If the original definition is still around, add it as an available
 250       // value.
 251       MachineInstr *DefMI = MRI->getVRegDef(VReg);
 252       MachineBasicBlock *DefBB = nullptr;
 253       if (DefMI) {
 254         DefBB = DefMI->getParent();
 255         SSAUpdate.AddAvailableValue(DefBB, VReg);
 256       }
 257
 258       // Add the new vregs as available values.
 259       DenseMap<unsigned, AvailableValsTy>::iterator LI =
 260         SSAUpdateVals.find(VReg);
 261       for (unsigned j = 0, ee = LI->second.size(); j != ee; ++j) {
 262         MachineBasicBlock *SrcBB = LI->second[j].first;
 263         unsigned SrcReg = LI->second[j].second;
 264         SSAUpdate.AddAvailableValue(SrcBB, SrcReg);
 265       }
 266
 267       // Rewrite uses that are outside of the original def's block.
 268       MachineRegisterInfo::use_iterator UI = MRI->use_begin(VReg);
 269       while (UI != MRI->use_end()) {
 270         MachineOperand &UseMO = *UI;
 271         MachineInstr *UseMI = UseMO.getParent();
 272         ++UI;
 273         if (UseMI->isDebugValue()) {
 274           // SSAUpdate can replace the use with an undef. That creates
 275           // a debug instruction that is a kill.
 276           // FIXME: Should it SSAUpdate job to delete debug instructions
 277           // instead of replacing the use with undef?
 278           UseMI->eraseFromParent();
 279           continue;
 280         }
 281         if (UseMI->getParent() == DefBB && !UseMI->isPHI())
 282           continue;
 283         SSAUpdate.RewriteUse(UseMO);
 284       }
 285     }
 286
 287     SSAUpdateVRs.clear();
 288     SSAUpdateVals.clear();
 289   }
 290
 291   // Eliminate some of the copies inserted by tail duplication to maintain
 292   // SSA form.
 293   for (unsigned i = 0, e = Copies.size(); i != e; ++i) {
 294     MachineInstr *Copy = Copies[i];
 295     if (!Copy->isCopy())
 296       continue;
 297     unsigned Dst = Copy->getOperand(0).getReg();
 298     unsigned Src = Copy->getOperand(1).getReg();
 299     if (MRI->hasOneNonDBGUse(Src) &&
 300         MRI->constrainRegClass(Src, MRI->getRegClass(Dst))) {
 301       // Copy is the only use. Do trivial copy propagation here.
 302       MRI->replaceRegWith(Dst, Src);
 303       Copy->eraseFromParent();
 304     }
 305   }
 306
 307   if (NewPHIs.size())
 308     NumAddedPHIs += NewPHIs.size();
 309
 310   return true;
 311 }
 312
 313 /// TailDuplicateBlocks - Look for small blocks that are unconditionally
 314 /// branched to and do not fall through. Tail-duplicate their instructions
 315 /// into their predecessors to eliminate (dynamic) branches.
 316 bool TailDuplicatePass::TailDuplicateBlocks(MachineFunction &MF) {
 317   bool MadeChange = false;
 318
 319   if (PreRegAlloc && TailDupVerify) {
 320     DEBUG(dbgs() << "\n*** Before tail-duplicating\n");
 321     VerifyPHIs(MF, true);
 322   }
 323
 324   for (MachineFunction::iterator I = ++MF.begin(), E = MF.end(); I != E; ) {
 325     MachineBasicBlock *MBB = I++;
 326
 327     if (NumTails == TailDupLimit)
 328       break;
 329
 330     bool IsSimple = isSimpleBB(MBB);
 331
 332     if (!shouldTailDuplicate(MF, IsSimple, *MBB))
 333       continue;
 334
 335     MadeChange |= TailDuplicateAndUpdate(MBB, IsSimple, MF);
 336   }
 337
 338   if (PreRegAlloc && TailDupVerify)
 339     VerifyPHIs(MF, false);
 340
 341   return MadeChange;
 342 }
 343
 344 static bool isDefLiveOut(unsigned Reg, MachineBasicBlock *BB,
 345                          const MachineRegisterInfo *MRI) {
 346   for (MachineInstr &UseMI : MRI->use_instructions(Reg)) {
 347     if (UseMI.isDebugValue())
 348       continue;
 349     if (UseMI.getParent() != BB)
 350       return true;
 351   }
 352   return false;
 353 }
 354
 355 static unsigned getPHISrcRegOpIdx(MachineInstr *MI, MachineBasicBlock *SrcBB) {
 356   for (unsigned i = 1, e = MI->getNumOperands(); i != e; i += 2)
 357     if (MI->getOperand(i+1).getMBB() == SrcBB)
 358       return i;
 359   return 0;
 360 }
 361
 362
 363 // Remember which registers are used by phis in this block. This is
 364 // used to determine which registers are liveout while modifying the
 365 // block (which is why we need to copy the information).
 366 static void getRegsUsedByPHIs(const MachineBasicBlock &BB,
 367                               DenseSet<unsigned> *UsedByPhi) {
 368   for (const auto &MI : BB) {
 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       for (MachineBasicBlock::livein_iterator I = TailBB->livein_begin(),
 803              E = TailBB->livein_end(); I != E; ++I) {
 804         if (!RS->isRegUsed(*I, false))
 805           // If a register is previously livein to the tail but it's not live
 806           // at the end of predecessor BB, then it should be added to its
 807           // livein list.
 808           PredBB->addLiveIn(*I);
 809       }
 810     }
 811
 812     // Clone the contents of TailBB into PredBB.
 813     DenseMap<unsigned, unsigned> LocalVRMap;
 814     SmallVector<std::pair<unsigned,unsigned>, 4> CopyInfos;
 815     // Use instr_iterator here to properly handle bundles, e.g.
 816     // ARM Thumb2 IT block.
 817     MachineBasicBlock::instr_iterator I = TailBB->instr_begin();
 818     while (I != TailBB->instr_end()) {
 819       MachineInstr *MI = &*I;
 820       ++I;
 821       if (MI->isPHI()) {
 822         // Replace the uses of the def of the PHI with the register coming
 823         // from PredBB.
 824         ProcessPHI(MI, TailBB, PredBB, LocalVRMap, CopyInfos, UsedByPhi, true);
 825       } else {
 826         // Replace def of virtual registers with new registers, and update
 827         // uses with PHI source register or the new registers.
 828         DuplicateInstruction(MI, TailBB, PredBB, MF, LocalVRMap, UsedByPhi);
 829       }
 830     }
 831     MachineBasicBlock::iterator Loc = PredBB->getFirstTerminator();
 832     for (unsigned i = 0, e = CopyInfos.size(); i != e; ++i) {
 833       Copies.push_back(BuildMI(*PredBB, Loc, DebugLoc(),
 834                                TII->get(TargetOpcode::COPY),
 835                                CopyInfos[i].first).addReg(CopyInfos[i].second));
 836     }
 837
 838     // Simplify
 839     TII->AnalyzeBranch(*PredBB, PredTBB, PredFBB, PredCond, true);
 840
 841     NumInstrDups += TailBB->size() - 1; // subtract one for removed branch
 842
 843     // Update the CFG.
 844     PredBB->removeSuccessor(PredBB->succ_begin());
 845     assert(PredBB->succ_empty() &&
 846            "TailDuplicate called on block with multiple successors!");
 847     for (MachineBasicBlock::succ_iterator I = TailBB->succ_begin(),
 848            E = TailBB->succ_end(); I != E; ++I)
 849       PredBB->addSuccessor(*I, MBPI->getEdgeWeight(TailBB, I));
 850
 851     Changed = true;
 852     ++NumTailDups;
 853   }
 854
 855   // If TailBB was duplicated into all its predecessors except for the prior
 856   // block, which falls through unconditionally, move the contents of this
 857   // block into the prior block.
 858   MachineBasicBlock *PrevBB = std::prev(MachineFunction::iterator(TailBB));
 859   MachineBasicBlock *PriorTBB = nullptr, *PriorFBB = nullptr;
 860   SmallVector<MachineOperand, 4> PriorCond;
 861   // This has to check PrevBB->succ_size() because EH edges are ignored by
 862   // AnalyzeBranch.
 863   if (PrevBB->succ_size() == 1 &&
 864       !TII->AnalyzeBranch(*PrevBB, PriorTBB, PriorFBB, PriorCond, true) &&
 865       PriorCond.empty() && !PriorTBB && TailBB->pred_size() == 1 &&
 866       !TailBB->hasAddressTaken()) {
 867     DEBUG(dbgs() << "\nMerging into block: " << *PrevBB
 868           << "From MBB: " << *TailBB);
 869     if (PreRegAlloc) {
 870       DenseMap<unsigned, unsigned> LocalVRMap;
 871       SmallVector<std::pair<unsigned,unsigned>, 4> CopyInfos;
 872       MachineBasicBlock::iterator I = TailBB->begin();
 873       // Process PHI instructions first.
 874       while (I != TailBB->end() && I->isPHI()) {
 875         // Replace the uses of the def of the PHI with the register coming
 876         // from PredBB.
 877         MachineInstr *MI = &*I++;
 878         ProcessPHI(MI, TailBB, PrevBB, LocalVRMap, CopyInfos, UsedByPhi, true);
 879         if (MI->getParent())
 880           MI->eraseFromParent();
 881       }
 882
 883       // Now copy the non-PHI instructions.
 884       while (I != TailBB->end()) {
 885         // Replace def of virtual registers with new registers, and update
 886         // uses with PHI source register or the new registers.
 887         MachineInstr *MI = &*I++;
 888         assert(!MI->isBundle() && "Not expecting bundles before regalloc!");
 889         DuplicateInstruction(MI, TailBB, PrevBB, MF, LocalVRMap, UsedByPhi);
 890         MI->eraseFromParent();
 891       }
 892       MachineBasicBlock::iterator Loc = PrevBB->getFirstTerminator();
 893       for (unsigned i = 0, e = CopyInfos.size(); i != e; ++i) {
 894         Copies.push_back(BuildMI(*PrevBB, Loc, DebugLoc(),
 895                                  TII->get(TargetOpcode::COPY),
 896                                  CopyInfos[i].first)
 897                            .addReg(CopyInfos[i].second));
 898       }
 899     } else {
 900       // No PHIs to worry about, just splice the instructions over.
 901       PrevBB->splice(PrevBB->end(), TailBB, TailBB->begin(), TailBB->end());
 902     }
 903     PrevBB->removeSuccessor(PrevBB->succ_begin());
 904     assert(PrevBB->succ_empty());
 905     PrevBB->transferSuccessors(TailBB);
 906     TDBBs.push_back(PrevBB);
 907     Changed = true;
 908   }
 909
 910   // If this is after register allocation, there are no phis to fix.
 911   if (!PreRegAlloc)
 912     return Changed;
 913
 914   // If we made no changes so far, we are safe.
 915   if (!Changed)
 916     return Changed;
 917
 918
 919   // Handle the nasty case in that we duplicated a block that is part of a loop
 920   // into some but not all of its predecessors. For example:
 921   //    1 -> 2 <-> 3                 |
 922   //          \                      |
 923   //           \---> rest            |
 924   // if we duplicate 2 into 1 but not into 3, we end up with
 925   // 12 -> 3 <-> 2 -> rest           |
 926   //   \             /               |
 927   //    \----->-----/                |
 928   // If there was a "var = phi(1, 3)" in 2, it has to be ultimately replaced
 929   // with a phi in 3 (which now dominates 2).
 930   // What we do here is introduce a copy in 3 of the register defined by the
 931   // phi, just like when we are duplicating 2 into 3, but we don't copy any
 932   // real instructions or remove the 3 -> 2 edge from the phi in 2.
 933   for (SmallSetVector<MachineBasicBlock *, 8>::iterator PI = Preds.begin(),
 934        PE = Preds.end(); PI != PE; ++PI) {
 935     MachineBasicBlock *PredBB = *PI;
 936     if (std::find(TDBBs.begin(), TDBBs.end(), PredBB) != TDBBs.end())
 937       continue;
 938
 939     // EH edges
 940     if (PredBB->succ_size() != 1)
 941       continue;
 942
 943     DenseMap<unsigned, unsigned> LocalVRMap;
 944     SmallVector<std::pair<unsigned,unsigned>, 4> CopyInfos;
 945     MachineBasicBlock::iterator I = TailBB->begin();
 946     // Process PHI instructions first.
 947     while (I != TailBB->end() && I->isPHI()) {
 948       // Replace the uses of the def of the PHI with the register coming
 949       // from PredBB.
 950       MachineInstr *MI = &*I++;
 951       ProcessPHI(MI, TailBB, PredBB, LocalVRMap, CopyInfos, UsedByPhi, false);
 952     }
 953     MachineBasicBlock::iterator Loc = PredBB->getFirstTerminator();
 954     for (unsigned i = 0, e = CopyInfos.size(); i != e; ++i) {
 955       Copies.push_back(BuildMI(*PredBB, Loc, DebugLoc(),
 956                                TII->get(TargetOpcode::COPY),
 957                                CopyInfos[i].first).addReg(CopyInfos[i].second));
 958     }
 959   }
 960
 961   return Changed;
 962 }
 963
 964 /// RemoveDeadBlock - Remove the specified dead machine basic block from the
 965 /// function, updating the CFG.
 966 void TailDuplicatePass::RemoveDeadBlock(MachineBasicBlock *MBB) {
 967   assert(MBB->pred_empty() && "MBB must be dead!");
 968   DEBUG(dbgs() << "\nRemoving MBB: " << *MBB);
 969
 970   // Remove all successors.
 971   while (!MBB->succ_empty())
 972     MBB->removeSuccessor(MBB->succ_end()-1);
 973
 974   // Remove the block.
 975   MBB->eraseFromParent();
 976 }