lib/CodeGen/PHIElimination.cpp

   1 //===-- PhiElimination.cpp - Eliminate PHI nodes by inserting copies ------===//
   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 eliminates machine instruction PHI nodes by inserting copy
  11 // instructions.  This destroys SSA information, but is the desired input for
  12 // some register allocators.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #define DEBUG_TYPE "phielim"
  17 #include "PHIElimination.h"
  18 #include "llvm/BasicBlock.h"
  19 #include "llvm/Instructions.h"
  20 #include "llvm/CodeGen/LiveVariables.h"
  21 #include "llvm/CodeGen/Passes.h"
  22 #include "llvm/CodeGen/MachineFunctionPass.h"
  23 #include "llvm/CodeGen/MachineInstr.h"
  24 #include "llvm/CodeGen/MachineInstrBuilder.h"
  25 #include "llvm/CodeGen/MachineRegisterInfo.h"
  26 #include "llvm/Target/TargetMachine.h"
  27 #include "llvm/ADT/SmallPtrSet.h"
  28 #include "llvm/ADT/STLExtras.h"
  29 #include "llvm/ADT/Statistic.h"
  30 #include "llvm/Support/Compiler.h"
  31 #include <algorithm>
  32 #include <map>
  33 using namespace llvm;
  34
  35 STATISTIC(NumAtomic, "Number of atomic phis lowered");
  36
  37 char PHIElimination::ID = 0;
  38 static RegisterPass<PHIElimination>
  39 X("phi-node-elimination", "Eliminate PHI nodes for register allocation");
  40
  41 const PassInfo *const llvm::PHIEliminationID = &X;
  42
  43 void llvm::PHIElimination::getAnalysisUsage(AnalysisUsage &AU) const {
  44   AU.setPreservesCFG();
  45   AU.addPreserved<LiveVariables>();
  46   AU.addPreservedID(MachineLoopInfoID);
  47   AU.addPreservedID(MachineDominatorsID);
  48   MachineFunctionPass::getAnalysisUsage(AU);
  49 }
  50
  51 bool llvm::PHIElimination::runOnMachineFunction(MachineFunction &Fn) {
  52   MRI = &Fn.getRegInfo();
  53
  54   PHIDefs.clear();
  55   PHIKills.clear();
  56   analyzePHINodes(Fn);
  57
  58   bool Changed = false;
  59
  60   // Eliminate PHI instructions by inserting copies into predecessor blocks.
  61   for (MachineFunction::iterator I = Fn.begin(), E = Fn.end(); I != E; ++I)
  62     Changed |= EliminatePHINodes(Fn, *I);
  63
  64   // Remove dead IMPLICIT_DEF instructions.
  65   for (SmallPtrSet<MachineInstr*,4>::iterator I = ImpDefs.begin(),
  66          E = ImpDefs.end(); I != E; ++I) {
  67     MachineInstr *DefMI = *I;
  68     unsigned DefReg = DefMI->getOperand(0).getReg();
  69     if (MRI->use_empty(DefReg))
  70       DefMI->eraseFromParent();
  71   }
  72
  73   ImpDefs.clear();
  74   VRegPHIUseCount.clear();
  75   return Changed;
  76 }
  77
  78
  79 /// EliminatePHINodes - Eliminate phi nodes by inserting copy instructions in
  80 /// predecessor basic blocks.
  81 ///
  82 bool llvm::PHIElimination::EliminatePHINodes(MachineFunction &MF,
  83                                              MachineBasicBlock &MBB) {
  84   if (MBB.empty() || MBB.front().getOpcode() != TargetInstrInfo::PHI)
  85     return false;   // Quick exit for basic blocks without PHIs.
  86
  87   // Get an iterator to the first instruction after the last PHI node (this may
  88   // also be the end of the basic block).
  89   MachineBasicBlock::iterator AfterPHIsIt = SkipPHIsAndLabels(MBB, MBB.begin());
  90
  91   while (MBB.front().getOpcode() == TargetInstrInfo::PHI)
  92     LowerAtomicPHINode(MBB, AfterPHIsIt);
  93
  94   return true;
  95 }
  96
  97 /// isSourceDefinedByImplicitDef - Return true if all sources of the phi node
  98 /// are implicit_def's.
  99 static bool isSourceDefinedByImplicitDef(const MachineInstr *MPhi,
 100                                          const MachineRegisterInfo *MRI) {
 101   for (unsigned i = 1; i != MPhi->getNumOperands(); i += 2) {
 102     unsigned SrcReg = MPhi->getOperand(i).getReg();
 103     const MachineInstr *DefMI = MRI->getVRegDef(SrcReg);
 104     if (!DefMI || DefMI->getOpcode() != TargetInstrInfo::IMPLICIT_DEF)
 105       return false;
 106   }
 107   return true;
 108 }
 109
 110 // FindCopyInsertPoint - Find a safe place in MBB to insert a copy from SrcReg.
 111 // This needs to be after any def or uses of SrcReg, but before any subsequent
 112 // point where control flow might jump out of the basic block.
 113 MachineBasicBlock::iterator
 114 llvm::PHIElimination::FindCopyInsertPoint(MachineBasicBlock &MBB,
 115                                           unsigned SrcReg) {
 116   // Handle the trivial case trivially.
 117   if (MBB.empty())
 118     return MBB.begin();
 119
 120   // If this basic block does not contain an invoke, then control flow always
 121   // reaches the end of it, so place the copy there.  The logic below works in
 122   // this case too, but is more expensive.
 123   if (!isa<InvokeInst>(MBB.getBasicBlock()->getTerminator()))
 124     return MBB.getFirstTerminator();
 125
 126   // Discover any definition/uses in this basic block.
 127   SmallPtrSet<MachineInstr*, 8> DefUsesInMBB;
 128   for (MachineRegisterInfo::reg_iterator RI = MRI->reg_begin(SrcReg),
 129        RE = MRI->reg_end(); RI != RE; ++RI) {
 130     MachineInstr *DefUseMI = &*RI;
 131     if (DefUseMI->getParent() == &MBB)
 132       DefUsesInMBB.insert(DefUseMI);
 133   }
 134
 135   MachineBasicBlock::iterator InsertPoint;
 136   if (DefUsesInMBB.empty()) {
 137     // No def/uses.  Insert the copy at the start of the basic block.
 138     InsertPoint = MBB.begin();
 139   } else if (DefUsesInMBB.size() == 1) {
 140     // Insert the copy immediately after the definition/use.
 141     InsertPoint = *DefUsesInMBB.begin();
 142     ++InsertPoint;
 143   } else {
 144     // Insert the copy immediately after the last definition/use.
 145     InsertPoint = MBB.end();
 146     while (!DefUsesInMBB.count(&*--InsertPoint)) {}
 147     ++InsertPoint;
 148   }
 149
 150   // Make sure the copy goes after any phi nodes however.
 151   return SkipPHIsAndLabels(MBB, InsertPoint);
 152 }
 153
 154 /// LowerAtomicPHINode - Lower the PHI node at the top of the specified block,
 155 /// under the assuption that it needs to be lowered in a way that supports
 156 /// atomic execution of PHIs.  This lowering method is always correct all of the
 157 /// time.
 158 ///
 159 void llvm::PHIElimination::LowerAtomicPHINode(
 160                                       MachineBasicBlock &MBB,
 161                                       MachineBasicBlock::iterator AfterPHIsIt) {
 162   // Unlink the PHI node from the basic block, but don't delete the PHI yet.
 163   MachineInstr *MPhi = MBB.remove(MBB.begin());
 164
 165   unsigned NumSrcs = (MPhi->getNumOperands() - 1) / 2;
 166   unsigned DestReg = MPhi->getOperand(0).getReg();
 167   bool isDead = MPhi->getOperand(0).isDead();
 168
 169   // Create a new register for the incoming PHI arguments.
 170   MachineFunction &MF = *MBB.getParent();
 171   const TargetRegisterClass *RC = MF.getRegInfo().getRegClass(DestReg);
 172   unsigned IncomingReg = 0;
 173
 174   // Insert a register to register copy at the top of the current block (but
 175   // after any remaining phi nodes) which copies the new incoming register
 176   // into the phi node destination.
 177   const TargetInstrInfo *TII = MF.getTarget().getInstrInfo();
 178   if (isSourceDefinedByImplicitDef(MPhi, MRI))
 179     // If all sources of a PHI node are implicit_def, just emit an
 180     // implicit_def instead of a copy.
 181     BuildMI(MBB, AfterPHIsIt, MPhi->getDebugLoc(),
 182             TII->get(TargetInstrInfo::IMPLICIT_DEF), DestReg);
 183   else {
 184     IncomingReg = MF.getRegInfo().createVirtualRegister(RC);
 185     TII->copyRegToReg(MBB, AfterPHIsIt, DestReg, IncomingReg, RC, RC);
 186   }
 187
 188   // Record PHI def.
 189   assert(!hasPHIDef(DestReg) && "Vreg has multiple phi-defs?");
 190   PHIDefs[DestReg] = &MBB;
 191
 192   // Update live variable information if there is any.
 193   LiveVariables *LV = getAnalysisIfAvailable<LiveVariables>();
 194   if (LV) {
 195     MachineInstr *PHICopy = prior(AfterPHIsIt);
 196
 197     if (IncomingReg) {
 198       // Increment use count of the newly created virtual register.
 199       LV->getVarInfo(IncomingReg).NumUses++;
 200
 201       // Add information to LiveVariables to know that the incoming value is
 202       // killed.  Note that because the value is defined in several places (once
 203       // each for each incoming block), the "def" block and instruction fields
 204       // for the VarInfo is not filled in.
 205       LV->addVirtualRegisterKilled(IncomingReg, PHICopy);
 206     }
 207
 208     // Since we are going to be deleting the PHI node, if it is the last use of
 209     // any registers, or if the value itself is dead, we need to move this
 210     // information over to the new copy we just inserted.
 211     LV->removeVirtualRegistersKilled(MPhi);
 212
 213     // If the result is dead, update LV.
 214     if (isDead) {
 215       LV->addVirtualRegisterDead(DestReg, PHICopy);
 216       LV->removeVirtualRegisterDead(DestReg, MPhi);
 217     }
 218   }
 219
 220   // Adjust the VRegPHIUseCount map to account for the removal of this PHI node.
 221   for (unsigned i = 1; i != MPhi->getNumOperands(); i += 2)
 222     --VRegPHIUseCount[BBVRegPair(MPhi->getOperand(i + 1).getMBB(),
 223                                  MPhi->getOperand(i).getReg())];
 224
 225   // Now loop over all of the incoming arguments, changing them to copy into the
 226   // IncomingReg register in the corresponding predecessor basic block.
 227   SmallPtrSet<MachineBasicBlock*, 8> MBBsInsertedInto;
 228   for (int i = NumSrcs - 1; i >= 0; --i) {
 229     unsigned SrcReg = MPhi->getOperand(i*2+1).getReg();
 230     assert(TargetRegisterInfo::isVirtualRegister(SrcReg) &&
 231            "Machine PHI Operands must all be virtual registers!");
 232
 233     // Get the MachineBasicBlock equivalent of the BasicBlock that is the source
 234     // path the PHI.
 235     MachineBasicBlock &opBlock = *MPhi->getOperand(i*2+2).getMBB();
 236
 237     // Record the kill.
 238     PHIKills[SrcReg].insert(&opBlock);
 239
 240     // If source is defined by an implicit def, there is no need to insert a
 241     // copy.
 242     MachineInstr *DefMI = MRI->getVRegDef(SrcReg);
 243     if (DefMI->getOpcode() == TargetInstrInfo::IMPLICIT_DEF) {
 244       ImpDefs.insert(DefMI);
 245       continue;
 246     }
 247
 248     // Check to make sure we haven't already emitted the copy for this block.
 249     // This can happen because PHI nodes may have multiple entries for the same
 250     // basic block.
 251     if (!MBBsInsertedInto.insert(&opBlock))
 252       continue;  // If the copy has already been emitted, we're done.
 253
 254     // Find a safe location to insert the copy, this may be the first terminator
 255     // in the block (or end()).
 256     MachineBasicBlock::iterator InsertPos = FindCopyInsertPoint(opBlock, SrcReg);
 257
 258     // Insert the copy.
 259     TII->copyRegToReg(opBlock, InsertPos, IncomingReg, SrcReg, RC, RC);
 260
 261     // Now update live variable information if we have it.  Otherwise we're done
 262     if (!LV) continue;
 263
 264     // We want to be able to insert a kill of the register if this PHI (aka, the
 265     // copy we just inserted) is the last use of the source value.  Live
 266     // variable analysis conservatively handles this by saying that the value is
 267     // live until the end of the block the PHI entry lives in.  If the value
 268     // really is dead at the PHI copy, there will be no successor blocks which
 269     // have the value live-in.
 270
 271     // Also check to see if this register is in use by another PHI node which
 272     // has not yet been eliminated.  If so, it will be killed at an appropriate
 273     // point later.
 274
 275     // Is it used by any PHI instructions in this block?
 276     bool ValueIsUsed = VRegPHIUseCount[BBVRegPair(&opBlock, SrcReg)] != 0;
 277
 278     // Okay, if we now know that the value is not live out of the block, we can
 279     // add a kill marker in this block saying that it kills the incoming value!
 280     if (!ValueIsUsed && !isLiveOut(SrcReg, opBlock, *LV)) {
 281       // In our final twist, we have to decide which instruction kills the
 282       // register.  In most cases this is the copy, however, the first
 283       // terminator instruction at the end of the block may also use the value.
 284       // In this case, we should mark *it* as being the killing block, not the
 285       // copy.
 286       MachineBasicBlock::iterator KillInst = prior(InsertPos);
 287       MachineBasicBlock::iterator Term = opBlock.getFirstTerminator();
 288       if (Term != opBlock.end()) {
 289         if (Term->readsRegister(SrcReg))
 290           KillInst = Term;
 291
 292         // Check that no other terminators use values.
 293 #ifndef NDEBUG
 294         for (MachineBasicBlock::iterator TI = next(Term); TI != opBlock.end();
 295              ++TI) {
 296           assert(!TI->readsRegister(SrcReg) &&
 297                  "Terminator instructions cannot use virtual registers unless"
 298                  "they are the first terminator in a block!");
 299         }
 300 #endif
 301       }
 302
 303       // Finally, mark it killed.
 304       LV->addVirtualRegisterKilled(SrcReg, KillInst);
 305
 306       // This vreg no longer lives all of the way through opBlock.
 307       unsigned opBlockNum = opBlock.getNumber();
 308       LV->getVarInfo(SrcReg).AliveBlocks.reset(opBlockNum);
 309     }
 310   }
 311
 312   // Really delete the PHI instruction now!
 313   MF.DeleteMachineInstr(MPhi);
 314   ++NumAtomic;
 315 }
 316
 317 /// analyzePHINodes - Gather information about the PHI nodes in here. In
 318 /// particular, we want to map the number of uses of a virtual register which is
 319 /// used in a PHI node. We map that to the BB the vreg is coming from. This is
 320 /// used later to determine when the vreg is killed in the BB.
 321 ///
 322 void llvm::PHIElimination::analyzePHINodes(const MachineFunction& Fn) {
 323   for (MachineFunction::const_iterator I = Fn.begin(), E = Fn.end();
 324        I != E; ++I)
 325     for (MachineBasicBlock::const_iterator BBI = I->begin(), BBE = I->end();
 326          BBI != BBE && BBI->getOpcode() == TargetInstrInfo::PHI; ++BBI)
 327       for (unsigned i = 1, e = BBI->getNumOperands(); i != e; i += 2)
 328         ++VRegPHIUseCount[BBVRegPair(BBI->getOperand(i + 1).getMBB(),
 329                                      BBI->getOperand(i).getReg())];
 330 }
 331
 332 bool llvm::PHIElimination::isLiveOut(unsigned Reg, const MachineBasicBlock &MBB,
 333                                      LiveVariables &LV) {
 334   LiveVariables::VarInfo &InRegVI = LV.getVarInfo(Reg);
 335
 336   // Loop over all of the successors of the basic block, checking to see if
 337   // the value is either live in the block, or if it is killed in the block.
 338   std::vector<MachineBasicBlock*> OpSuccBlocks;
 339
 340   // Otherwise, scan successors, including the BB the PHI node lives in.
 341   for (MachineBasicBlock::const_succ_iterator SI = MBB.succ_begin(),
 342          E = MBB.succ_end(); SI != E; ++SI) {
 343     MachineBasicBlock *SuccMBB = *SI;
 344
 345     // Is it alive in this successor?
 346     unsigned SuccIdx = SuccMBB->getNumber();
 347     if (InRegVI.AliveBlocks.test(SuccIdx))
 348       return true;
 349     OpSuccBlocks.push_back(SuccMBB);
 350   }
 351
 352   // Check to see if this value is live because there is a use in a successor
 353   // that kills it.
 354   switch (OpSuccBlocks.size()) {
 355   case 1: {
 356     MachineBasicBlock *SuccMBB = OpSuccBlocks[0];
 357     for (unsigned i = 0, e = InRegVI.Kills.size(); i != e; ++i)
 358       if (InRegVI.Kills[i]->getParent() == SuccMBB)
 359         return true;
 360     break;
 361   }
 362   case 2: {
 363     MachineBasicBlock *SuccMBB1 = OpSuccBlocks[0], *SuccMBB2 = OpSuccBlocks[1];
 364     for (unsigned i = 0, e = InRegVI.Kills.size(); i != e; ++i)
 365       if (InRegVI.Kills[i]->getParent() == SuccMBB1 ||
 366           InRegVI.Kills[i]->getParent() == SuccMBB2)
 367         return true;
 368     break;
 369   }
 370   default:
 371     std::sort(OpSuccBlocks.begin(), OpSuccBlocks.end());
 372     for (unsigned i = 0, e = InRegVI.Kills.size(); i != e; ++i)
 373       if (std::binary_search(OpSuccBlocks.begin(), OpSuccBlocks.end(),
 374                              InRegVI.Kills[i]->getParent()))
 375         return true;
 376   }
 377   return false;
 378 }