lib/CodeGen/StrongPHIElimination.cpp

   1 //===- StrongPhiElimination.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, using an intelligent copy-folding technique based on
  12 // dominator information.  This is technique is derived from:
  13 //
  14 //    Budimlic, et al. Fast copy coalescing and live-range identification.
  15 //    In Proceedings of the ACM SIGPLAN 2002 Conference on Programming Language
  16 //    Design and Implementation (Berlin, Germany, June 17 - 19, 2002).
  17 //    PLDI '02. ACM, New York, NY, 25-32.
  18 //    DOI= http://doi.acm.org/10.1145/512529.512534
  19 //
  20 //===----------------------------------------------------------------------===//
  21
  22 #define DEBUG_TYPE "strongphielim"
  23 #include "llvm/CodeGen/Passes.h"
  24 #include "llvm/CodeGen/LiveIntervalAnalysis.h"
  25 #include "llvm/CodeGen/MachineDominators.h"
  26 #include "llvm/CodeGen/MachineFunctionPass.h"
  27 #include "llvm/CodeGen/MachineInstr.h"
  28 #include "llvm/CodeGen/MachineLoopInfo.h"
  29 #include "llvm/CodeGen/MachineRegisterInfo.h"
  30 #include "llvm/Target/TargetInstrInfo.h"
  31 #include "llvm/Target/TargetMachine.h"
  32 #include "llvm/ADT/DepthFirstIterator.h"
  33 #include "llvm/ADT/Statistic.h"
  34 #include "llvm/Support/Compiler.h"
  35 using namespace llvm;
  36
  37
  38 namespace {
  39   struct VISIBILITY_HIDDEN StrongPHIElimination : public MachineFunctionPass {
  40     static char ID; // Pass identification, replacement for typeid
  41     StrongPHIElimination() : MachineFunctionPass((intptr_t)&ID) {}
  42
  43     // Waiting stores, for each MBB, the set of copies that need to
  44     // be inserted into that MBB
  45     DenseMap<MachineBasicBlock*,
  46              std::map<unsigned, unsigned> > Waiting;
  47
  48     // Stacks holds the renaming stack for each register
  49     std::map<unsigned, std::vector<unsigned> > Stacks;
  50
  51     // Registers in UsedByAnother are PHI nodes that are themselves
  52     // used as operands to another another PHI node
  53     std::set<unsigned> UsedByAnother;
  54
  55     // RenameSets are the sets of operands (and their VNInfo IDs) to a PHI
  56     // (the defining instruction of the key) that can be renamed without copies.
  57     std::map<unsigned, std::map<unsigned, unsigned> > RenameSets;
  58
  59     // PhiValueNumber holds the ID numbers of the VNs for each phi that we're
  60     // eliminating, indexed by the register defined by that phi.
  61     std::map<unsigned, unsigned> PhiValueNumber;
  62
  63     // Store the DFS-in number of each block
  64     DenseMap<MachineBasicBlock*, unsigned> preorder;
  65
  66     // Store the DFS-out number of each block
  67     DenseMap<MachineBasicBlock*, unsigned> maxpreorder;
  68
  69     bool runOnMachineFunction(MachineFunction &Fn);
  70
  71     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  72       AU.addRequired<MachineDominatorTree>();
  73       AU.addRequired<LiveIntervals>();
  74
  75       // TODO: Actually make this true.
  76       AU.addPreserved<LiveIntervals>();
  77       MachineFunctionPass::getAnalysisUsage(AU);
  78     }
  79
  80     virtual void releaseMemory() {
  81       preorder.clear();
  82       maxpreorder.clear();
  83
  84       Waiting.clear();
  85       Stacks.clear();
  86       UsedByAnother.clear();
  87       RenameSets.clear();
  88     }
  89
  90   private:
  91
  92     /// DomForestNode - Represents a node in the "dominator forest".  This is
  93     /// a forest in which the nodes represent registers and the edges
  94     /// represent a dominance relation in the block defining those registers.
  95     struct DomForestNode {
  96     private:
  97       // Store references to our children
  98       std::vector<DomForestNode*> children;
  99       // The register we represent
 100       unsigned reg;
 101
 102       // Add another node as our child
 103       void addChild(DomForestNode* DFN) { children.push_back(DFN); }
 104
 105     public:
 106       typedef std::vector<DomForestNode*>::iterator iterator;
 107
 108       // Create a DomForestNode by providing the register it represents, and
 109       // the node to be its parent.  The virtual root node has register 0
 110       // and a null parent.
 111       DomForestNode(unsigned r, DomForestNode* parent) : reg(r) {
 112         if (parent)
 113           parent->addChild(this);
 114       }
 115
 116       ~DomForestNode() {
 117         for (iterator I = begin(), E = end(); I != E; ++I)
 118           delete *I;
 119       }
 120
 121       /// getReg - Return the regiser that this node represents
 122       inline unsigned getReg() { return reg; }
 123
 124       // Provide iterator access to our children
 125       inline DomForestNode::iterator begin() { return children.begin(); }
 126       inline DomForestNode::iterator end() { return children.end(); }
 127     };
 128
 129     void computeDFS(MachineFunction& MF);
 130     void processBlock(MachineBasicBlock* MBB);
 131
 132     std::vector<DomForestNode*> computeDomForest(std::map<unsigned, unsigned>& instrs,
 133                                                  MachineRegisterInfo& MRI);
 134     void processPHIUnion(MachineInstr* Inst,
 135                          std::map<unsigned, unsigned>& PHIUnion,
 136                          std::vector<StrongPHIElimination::DomForestNode*>& DF,
 137                          std::vector<std::pair<unsigned, unsigned> >& locals);
 138     void ScheduleCopies(MachineBasicBlock* MBB, std::set<unsigned>& pushed);
 139     void InsertCopies(MachineBasicBlock* MBB,
 140                       SmallPtrSet<MachineBasicBlock*, 16>& v);
 141     void mergeLiveIntervals(unsigned primary, unsigned secondary, unsigned VN);
 142   };
 143
 144   char StrongPHIElimination::ID = 0;
 145   RegisterPass<StrongPHIElimination> X("strong-phi-node-elimination",
 146                   "Eliminate PHI nodes for register allocation, intelligently");
 147 }
 148
 149 const PassInfo *llvm::StrongPHIEliminationID = X.getPassInfo();
 150
 151 /// computeDFS - Computes the DFS-in and DFS-out numbers of the dominator tree
 152 /// of the given MachineFunction.  These numbers are then used in other parts
 153 /// of the PHI elimination process.
 154 void StrongPHIElimination::computeDFS(MachineFunction& MF) {
 155   SmallPtrSet<MachineDomTreeNode*, 8> frontier;
 156   SmallPtrSet<MachineDomTreeNode*, 8> visited;
 157
 158   unsigned time = 0;
 159
 160   MachineDominatorTree& DT = getAnalysis<MachineDominatorTree>();
 161
 162   MachineDomTreeNode* node = DT.getRootNode();
 163
 164   std::vector<MachineDomTreeNode*> worklist;
 165   worklist.push_back(node);
 166
 167   while (!worklist.empty()) {
 168     MachineDomTreeNode* currNode = worklist.back();
 169
 170     if (!frontier.count(currNode)) {
 171       frontier.insert(currNode);
 172       ++time;
 173       preorder.insert(std::make_pair(currNode->getBlock(), time));
 174     }
 175
 176     bool inserted = false;
 177     for (MachineDomTreeNode::iterator I = node->begin(), E = node->end();
 178          I != E; ++I)
 179       if (!frontier.count(*I) && !visited.count(*I)) {
 180         worklist.push_back(*I);
 181         inserted = true;
 182         break;
 183       }
 184
 185     if (!inserted) {
 186       frontier.erase(currNode);
 187       visited.insert(currNode);
 188       maxpreorder.insert(std::make_pair(currNode->getBlock(), time));
 189
 190       worklist.pop_back();
 191     }
 192   }
 193 }
 194
 195 /// PreorderSorter - a helper class that is used to sort registers
 196 /// according to the preorder number of their defining blocks
 197 class PreorderSorter {
 198 private:
 199   DenseMap<MachineBasicBlock*, unsigned>& preorder;
 200   MachineRegisterInfo& MRI;
 201
 202 public:
 203   PreorderSorter(DenseMap<MachineBasicBlock*, unsigned>& p,
 204                 MachineRegisterInfo& M) : preorder(p), MRI(M) { }
 205
 206   bool operator()(unsigned A, unsigned B) {
 207     if (A == B)
 208       return false;
 209
 210     MachineBasicBlock* ABlock = MRI.getVRegDef(A)->getParent();
 211     MachineBasicBlock* BBlock = MRI.getVRegDef(B)->getParent();
 212
 213     if (preorder[ABlock] < preorder[BBlock])
 214       return true;
 215     else if (preorder[ABlock] > preorder[BBlock])
 216       return false;
 217
 218     return false;
 219   }
 220 };
 221
 222 /// computeDomForest - compute the subforest of the DomTree corresponding
 223 /// to the defining blocks of the registers in question
 224 std::vector<StrongPHIElimination::DomForestNode*>
 225 StrongPHIElimination::computeDomForest(std::map<unsigned, unsigned>& regs,
 226                                        MachineRegisterInfo& MRI) {
 227   // Begin by creating a virtual root node, since the actual results
 228   // may well be a forest.  Assume this node has maximum DFS-out number.
 229   DomForestNode* VirtualRoot = new DomForestNode(0, 0);
 230   maxpreorder.insert(std::make_pair((MachineBasicBlock*)0, ~0UL));
 231
 232   // Populate a worklist with the registers
 233   std::vector<unsigned> worklist;
 234   worklist.reserve(regs.size());
 235   for (std::map<unsigned, unsigned>::iterator I = regs.begin(), E = regs.end();
 236        I != E; ++I)
 237     worklist.push_back(I->first);
 238
 239   // Sort the registers by the DFS-in number of their defining block
 240   PreorderSorter PS(preorder, MRI);
 241   std::sort(worklist.begin(), worklist.end(), PS);
 242
 243   // Create a "current parent" stack, and put the virtual root on top of it
 244   DomForestNode* CurrentParent = VirtualRoot;
 245   std::vector<DomForestNode*> stack;
 246   stack.push_back(VirtualRoot);
 247
 248   // Iterate over all the registers in the previously computed order
 249   for (std::vector<unsigned>::iterator I = worklist.begin(), E = worklist.end();
 250        I != E; ++I) {
 251     unsigned pre = preorder[MRI.getVRegDef(*I)->getParent()];
 252     MachineBasicBlock* parentBlock = CurrentParent->getReg() ?
 253                  MRI.getVRegDef(CurrentParent->getReg())->getParent() :
 254                  0;
 255
 256     // If the DFS-in number of the register is greater than the DFS-out number
 257     // of the current parent, repeatedly pop the parent stack until it isn't.
 258     while (pre > maxpreorder[parentBlock]) {
 259       stack.pop_back();
 260       CurrentParent = stack.back();
 261
 262       parentBlock = CurrentParent->getReg() ?
 263                    MRI.getVRegDef(CurrentParent->getReg())->getParent() :
 264                    0;
 265     }
 266
 267     // Now that we've found the appropriate parent, create a DomForestNode for
 268     // this register and attach it to the forest
 269     DomForestNode* child = new DomForestNode(*I, CurrentParent);
 270
 271     // Push this new node on the "current parent" stack
 272     stack.push_back(child);
 273     CurrentParent = child;
 274   }
 275
 276   // Return a vector containing the children of the virtual root node
 277   std::vector<DomForestNode*> ret;
 278   ret.insert(ret.end(), VirtualRoot->begin(), VirtualRoot->end());
 279   return ret;
 280 }
 281
 282 /// isLiveIn - helper method that determines, from a regno, if a register
 283 /// is live into a block
 284 static bool isLiveIn(unsigned r, MachineBasicBlock* MBB,
 285                      LiveIntervals& LI) {
 286   LiveInterval& I = LI.getOrCreateInterval(r);
 287   unsigned idx = LI.getMBBStartIdx(MBB);
 288   return I.liveBeforeAndAt(idx);
 289 }
 290
 291 /// isLiveOut - help method that determines, from a regno, if a register is
 292 /// live out of a block.
 293 static bool isLiveOut(unsigned r, MachineBasicBlock* MBB,
 294                       LiveIntervals& LI) {
 295   for (MachineBasicBlock::succ_iterator PI = MBB->succ_begin(),
 296        E = MBB->succ_end(); PI != E; ++PI) {
 297     if (isLiveIn(r, *PI, LI))
 298       return true;
 299   }
 300
 301   return false;
 302 }
 303
 304 /// interferes - checks for local interferences by scanning a block.  The only
 305 /// trick parameter is 'mode' which tells it the relationship of the two
 306 /// registers. 0 - defined in the same block, 1 - first properly dominates
 307 /// second, 2 - second properly dominates first
 308 static bool interferes(unsigned a, unsigned b, MachineBasicBlock* scan,
 309                        LiveIntervals& LV, unsigned mode) {
 310   MachineInstr* def = 0;
 311   MachineInstr* kill = 0;
 312
 313   // The code is still in SSA form at this point, so there is only one
 314   // definition per VReg.  Thus we can safely use MRI->getVRegDef().
 315   const MachineRegisterInfo* MRI = &scan->getParent()->getRegInfo();
 316
 317   bool interference = false;
 318
 319   // Wallk the block, checking for interferences
 320   for (MachineBasicBlock::iterator MBI = scan->begin(), MBE = scan->end();
 321        MBI != MBE; ++MBI) {
 322     MachineInstr* curr = MBI;
 323
 324     // Same defining block...
 325     if (mode == 0) {
 326       if (curr == MRI->getVRegDef(a)) {
 327         // If we find our first definition, save it
 328         if (!def) {
 329           def = curr;
 330         // If there's already an unkilled definition, then
 331         // this is an interference
 332         } else if (!kill) {
 333           interference = true;
 334           break;
 335         // If there's a definition followed by a KillInst, then
 336         // they can't interfere
 337         } else {
 338           interference = false;
 339           break;
 340         }
 341       // Symmetric with the above
 342       } else if (curr == MRI->getVRegDef(b)) {
 343         if (!def) {
 344           def = curr;
 345         } else if (!kill) {
 346           interference = true;
 347           break;
 348         } else {
 349           interference = false;
 350           break;
 351         }
 352       // Store KillInsts if they match up with the definition
 353       } else if (curr->killsRegister(a)) {
 354         if (def == MRI->getVRegDef(a)) {
 355           kill = curr;
 356         } else if (curr->killsRegister(b)) {
 357           if (def == MRI->getVRegDef(b)) {
 358             kill = curr;
 359           }
 360         }
 361       }
 362     // First properly dominates second...
 363     } else if (mode == 1) {
 364       if (curr == MRI->getVRegDef(b)) {
 365         // Definition of second without kill of first is an interference
 366         if (!kill) {
 367           interference = true;
 368           break;
 369         // Definition after a kill is a non-interference
 370         } else {
 371           interference = false;
 372           break;
 373         }
 374       // Save KillInsts of First
 375       } else if (curr->killsRegister(a)) {
 376         kill = curr;
 377       }
 378     // Symmetric with the above
 379     } else if (mode == 2) {
 380       if (curr == MRI->getVRegDef(a)) {
 381         if (!kill) {
 382           interference = true;
 383           break;
 384         } else {
 385           interference = false;
 386           break;
 387         }
 388       } else if (curr->killsRegister(b)) {
 389         kill = curr;
 390       }
 391     }
 392   }
 393
 394   return interference;
 395 }
 396
 397 /// processBlock - Determine how to break up PHIs in the current block.  Each
 398 /// PHI is broken up by some combination of renaming its operands and inserting
 399 /// copies.  This method is responsible for determining which operands receive
 400 /// which treatment.
 401 void StrongPHIElimination::processBlock(MachineBasicBlock* MBB) {
 402   LiveIntervals& LI = getAnalysis<LiveIntervals>();
 403   MachineRegisterInfo& MRI = MBB->getParent()->getRegInfo();
 404
 405   // Holds names that have been added to a set in any PHI within this block
 406   // before the current one.
 407   std::set<unsigned> ProcessedNames;
 408
 409   MachineBasicBlock::iterator FirstNonPHI = MBB->begin();
 410   while (FirstNonPHI->getOpcode() == TargetInstrInfo::PHI) FirstNonPHI++;
 411
 412   // Iterate over all the PHI nodes in this block
 413   MachineBasicBlock::iterator P = MBB->begin();
 414   while (P != FirstNonPHI && P->getOpcode() == TargetInstrInfo::PHI) {
 415     unsigned DestReg = P->getOperand(0).getReg();
 416
 417     // Don't both doing PHI elimination for dead PHI's.
 418     if (P->registerDefIsDead(DestReg)) {
 419       ++P;
 420       continue;
 421     }
 422
 423     LiveInterval& PI = LI.getOrCreateInterval(DestReg);
 424     unsigned pIdx = LI.getInstructionIndex(FirstNonPHI);
 425     VNInfo* PVN = PI.getLiveRangeContaining(pIdx)->valno;
 426     PhiValueNumber.insert(std::make_pair(DestReg, PVN->id));
 427
 428     // PHIUnion is the set of incoming registers to the PHI node that
 429     // are going to be renames rather than having copies inserted.  This set
 430     // is refinded over the course of this function.  UnionedBlocks is the set
 431     // of corresponding MBBs.
 432     std::map<unsigned, unsigned> PHIUnion;
 433     SmallPtrSet<MachineBasicBlock*, 8> UnionedBlocks;
 434
 435     // Iterate over the operands of the PHI node
 436     for (int i = P->getNumOperands() - 1; i >= 2; i-=2) {
 437       unsigned SrcReg = P->getOperand(i-1).getReg();
 438
 439       // Check for trivial interferences via liveness information, allowing us
 440       // to avoid extra work later.  Any registers that interfere cannot both
 441       // be in the renaming set, so choose one and add copies for it instead.
 442       // The conditions are:
 443       //   1) if the operand is live into the PHI node's block OR
 444       //   2) if the PHI node is live out of the operand's defining block OR
 445       //   3) if the operand is itself a PHI node and the original PHI is
 446       //      live into the operand's defining block OR
 447       //   4) if the operand is already being renamed for another PHI node
 448       //      in this block OR
 449       //   5) if any two operands are defined in the same block, insert copies
 450       //      for one of them
 451       if (isLiveIn(SrcReg, P->getParent(), LI) ||
 452           isLiveOut(P->getOperand(0).getReg(),
 453                     MRI.getVRegDef(SrcReg)->getParent(), LI) ||
 454           ( MRI.getVRegDef(SrcReg)->getOpcode() == TargetInstrInfo::PHI &&
 455             isLiveIn(P->getOperand(0).getReg(),
 456                      MRI.getVRegDef(SrcReg)->getParent(), LI) ) ||
 457           ProcessedNames.count(SrcReg) ||
 458           UnionedBlocks.count(MRI.getVRegDef(SrcReg)->getParent())) {
 459
 460         // Add a copy for the selected register
 461         MachineBasicBlock* From = P->getOperand(i).getMBB();
 462         Waiting[From].insert(std::make_pair(SrcReg, DestReg));
 463         UsedByAnother.insert(SrcReg);
 464       } else {
 465         // Otherwise, add it to the renaming set
 466         LiveInterval& I = LI.getOrCreateInterval(SrcReg);
 467         unsigned idx = LI.getMBBEndIdx(P->getOperand(i).getMBB());
 468         VNInfo* VN = I.getLiveRangeContaining(idx)->valno;
 469
 470         assert(VN && "No VNInfo for register?");
 471
 472         PHIUnion.insert(std::make_pair(SrcReg, VN->id));
 473         UnionedBlocks.insert(MRI.getVRegDef(SrcReg)->getParent());
 474       }
 475     }
 476
 477     // Compute the dominator forest for the renaming set.  This is a forest
 478     // where the nodes are the registers and the edges represent dominance
 479     // relations between the defining blocks of the registers
 480     std::vector<StrongPHIElimination::DomForestNode*> DF =
 481                                                 computeDomForest(PHIUnion, MRI);
 482
 483     // Walk DomForest to resolve interferences at an inter-block level.  This
 484     // will remove registers from the renaming set (and insert copies for them)
 485     // if interferences are found.
 486     std::vector<std::pair<unsigned, unsigned> > localInterferences;
 487     processPHIUnion(P, PHIUnion, DF, localInterferences);
 488
 489     // The dominator forest walk may have returned some register pairs whose
 490     // interference cannot be determines from dominator analysis.  We now
 491     // examine these pairs for local interferences.
 492     for (std::vector<std::pair<unsigned, unsigned> >::iterator I =
 493         localInterferences.begin(), E = localInterferences.end(); I != E; ++I) {
 494       std::pair<unsigned, unsigned> p = *I;
 495
 496       MachineDominatorTree& MDT = getAnalysis<MachineDominatorTree>();
 497
 498       // Determine the block we need to scan and the relationship between
 499       // the two registers
 500       MachineBasicBlock* scan = 0;
 501       unsigned mode = 0;
 502       if (MRI.getVRegDef(p.first)->getParent() ==
 503           MRI.getVRegDef(p.second)->getParent()) {
 504         scan = MRI.getVRegDef(p.first)->getParent();
 505         mode = 0; // Same block
 506       } else if (MDT.dominates(MRI.getVRegDef(p.first)->getParent(),
 507                                MRI.getVRegDef(p.second)->getParent())) {
 508         scan = MRI.getVRegDef(p.second)->getParent();
 509         mode = 1; // First dominates second
 510       } else {
 511         scan = MRI.getVRegDef(p.first)->getParent();
 512         mode = 2; // Second dominates first
 513       }
 514
 515       // If there's an interference, we need to insert  copies
 516       if (interferes(p.first, p.second, scan, LI, mode)) {
 517         // Insert copies for First
 518         for (int i = P->getNumOperands() - 1; i >= 2; i-=2) {
 519           if (P->getOperand(i-1).getReg() == p.first) {
 520             unsigned SrcReg = p.first;
 521             MachineBasicBlock* From = P->getOperand(i).getMBB();
 522
 523             Waiting[From].insert(std::make_pair(SrcReg,
 524                                                 P->getOperand(0).getReg()));
 525             UsedByAnother.insert(SrcReg);
 526
 527             PHIUnion.erase(SrcReg);
 528           }
 529         }
 530       }
 531     }
 532
 533     // Add the renaming set for this PHI node to our overal renaming information
 534     RenameSets.insert(std::make_pair(P->getOperand(0).getReg(), PHIUnion));
 535
 536     // Remember which registers are already renamed, so that we don't try to
 537     // rename them for another PHI node in this block
 538     for (std::map<unsigned, unsigned>::iterator I = PHIUnion.begin(),
 539          E = PHIUnion.end(); I != E; ++I)
 540       ProcessedNames.insert(I->first);
 541
 542     ++P;
 543   }
 544 }
 545
 546 /// processPHIUnion - Take a set of candidate registers to be coalesced when
 547 /// decomposing the PHI instruction.  Use the DominanceForest to remove the ones
 548 /// that are known to interfere, and flag others that need to be checked for
 549 /// local interferences.
 550 void StrongPHIElimination::processPHIUnion(MachineInstr* Inst,
 551                                         std::map<unsigned, unsigned>& PHIUnion,
 552                         std::vector<StrongPHIElimination::DomForestNode*>& DF,
 553                         std::vector<std::pair<unsigned, unsigned> >& locals) {
 554
 555   std::vector<DomForestNode*> worklist(DF.begin(), DF.end());
 556   SmallPtrSet<DomForestNode*, 4> visited;
 557
 558   // Code is still in SSA form, so we can use MRI::getVRegDef()
 559   MachineRegisterInfo& MRI = Inst->getParent()->getParent()->getRegInfo();
 560
 561   LiveIntervals& LI = getAnalysis<LiveIntervals>();
 562   unsigned DestReg = Inst->getOperand(0).getReg();
 563
 564   // DF walk on the DomForest
 565   while (!worklist.empty()) {
 566     DomForestNode* DFNode = worklist.back();
 567
 568     visited.insert(DFNode);
 569
 570     bool inserted = false;
 571     for (DomForestNode::iterator CI = DFNode->begin(), CE = DFNode->end();
 572          CI != CE; ++CI) {
 573       DomForestNode* child = *CI;
 574
 575       // If the current node is live-out of the defining block of one of its
 576       // children, insert a copy for it.  NOTE: The paper actually calls for
 577       // a more elaborate heuristic for determining whether to insert copies
 578       // for the child or the parent.  In the interest of simplicity, we're
 579       // just always choosing the parent.
 580       if (isLiveOut(DFNode->getReg(),
 581           MRI.getVRegDef(child->getReg())->getParent(), LI)) {
 582         // Insert copies for parent
 583         for (int i = Inst->getNumOperands() - 1; i >= 2; i-=2) {
 584           if (Inst->getOperand(i-1).getReg() == DFNode->getReg()) {
 585             unsigned SrcReg = DFNode->getReg();
 586             MachineBasicBlock* From = Inst->getOperand(i).getMBB();
 587
 588             Waiting[From].insert(std::make_pair(SrcReg, DestReg));
 589             UsedByAnother.insert(SrcReg);
 590
 591             PHIUnion.erase(SrcReg);
 592           }
 593         }
 594
 595       // If a node is live-in to the defining block of one of its children, but
 596       // not live-out, then we need to scan that block for local interferences.
 597       } else if (isLiveIn(DFNode->getReg(),
 598                           MRI.getVRegDef(child->getReg())->getParent(), LI) ||
 599                  MRI.getVRegDef(DFNode->getReg())->getParent() ==
 600                                  MRI.getVRegDef(child->getReg())->getParent()) {
 601         // Add (p, c) to possible local interferences
 602         locals.push_back(std::make_pair(DFNode->getReg(), child->getReg()));
 603       }
 604
 605       if (!visited.count(child)) {
 606         worklist.push_back(child);
 607         inserted = true;
 608       }
 609     }
 610
 611     if (!inserted) worklist.pop_back();
 612   }
 613 }
 614
 615 /// ScheduleCopies - Insert copies into predecessor blocks, scheduling
 616 /// them properly so as to avoid the 'lost copy' and the 'virtual swap'
 617 /// problems.
 618 ///
 619 /// Based on "Practical Improvements to the Construction and Destruction
 620 /// of Static Single Assignment Form" by Briggs, et al.
 621 void StrongPHIElimination::ScheduleCopies(MachineBasicBlock* MBB,
 622                                           std::set<unsigned>& pushed) {
 623   // FIXME: This function needs to update LiveVariables
 624   std::map<unsigned, unsigned>& copy_set= Waiting[MBB];
 625
 626   std::map<unsigned, unsigned> worklist;
 627   std::map<unsigned, unsigned> map;
 628
 629   // Setup worklist of initial copies
 630   for (std::map<unsigned, unsigned>::iterator I = copy_set.begin(),
 631        E = copy_set.end(); I != E; ) {
 632     map.insert(std::make_pair(I->first, I->first));
 633     map.insert(std::make_pair(I->second, I->second));
 634
 635     if (!UsedByAnother.count(I->first)) {
 636       worklist.insert(*I);
 637
 638       // Avoid iterator invalidation
 639       unsigned first = I->first;
 640       ++I;
 641       copy_set.erase(first);
 642     } else {
 643       ++I;
 644     }
 645   }
 646
 647   LiveIntervals& LI = getAnalysis<LiveIntervals>();
 648   MachineFunction* MF = MBB->getParent();
 649   MachineRegisterInfo& MRI = MF->getRegInfo();
 650   const TargetInstrInfo *TII = MF->getTarget().getInstrInfo();
 651
 652   // Iterate over the worklist, inserting copies
 653   while (!worklist.empty() || !copy_set.empty()) {
 654     while (!worklist.empty()) {
 655       std::pair<unsigned, unsigned> curr = *worklist.begin();
 656       worklist.erase(curr.first);
 657
 658       const TargetRegisterClass *RC = MF->getRegInfo().getRegClass(curr.first);
 659
 660       if (isLiveOut(curr.second, MBB, LI)) {
 661         // Create a temporary
 662         unsigned t = MF->getRegInfo().createVirtualRegister(RC);
 663
 664         // Insert copy from curr.second to a temporary at
 665         // the Phi defining curr.second
 666         MachineBasicBlock::iterator PI = MRI.getVRegDef(curr.second);
 667         TII->copyRegToReg(*PI->getParent(), PI, t,
 668                           curr.second, RC, RC);
 669
 670         // Push temporary on Stacks
 671         Stacks[curr.second].push_back(t);
 672
 673         // Insert curr.second in pushed
 674         pushed.insert(curr.second);
 675       }
 676
 677       // Insert copy from map[curr.first] to curr.second
 678       TII->copyRegToReg(*MBB, MBB->getFirstTerminator(), curr.second,
 679                         map[curr.first], RC, RC);
 680       map[curr.first] = curr.second;
 681
 682       // If curr.first is a destination in copy_set...
 683       for (std::map<unsigned, unsigned>::iterator I = copy_set.begin(),
 684            E = copy_set.end(); I != E; )
 685         if (curr.first == I->second) {
 686           std::pair<unsigned, unsigned> temp = *I;
 687
 688           // Avoid iterator invalidation
 689           ++I;
 690           copy_set.erase(temp.first);
 691           worklist.insert(temp);
 692
 693           break;
 694         } else {
 695           ++I;
 696         }
 697     }
 698
 699     if (!copy_set.empty()) {
 700       std::pair<unsigned, unsigned> curr = *copy_set.begin();
 701       copy_set.erase(curr.first);
 702
 703       const TargetRegisterClass *RC = MF->getRegInfo().getRegClass(curr.first);
 704
 705       // Insert a copy from dest to a new temporary t at the end of b
 706       unsigned t = MF->getRegInfo().createVirtualRegister(RC);
 707       TII->copyRegToReg(*MBB, MBB->getFirstTerminator(), t,
 708                         curr.second, RC, RC);
 709       map[curr.second] = t;
 710
 711       worklist.insert(curr);
 712     }
 713   }
 714 }
 715
 716 /// InsertCopies - insert copies into MBB and all of its successors
 717 void StrongPHIElimination::InsertCopies(MachineBasicBlock* MBB,
 718                                  SmallPtrSet<MachineBasicBlock*, 16>& visited) {
 719   visited.insert(MBB);
 720
 721   std::set<unsigned> pushed;
 722
 723   // Rewrite register uses from Stacks
 724   for (MachineBasicBlock::iterator I = MBB->begin(), E = MBB->end();
 725       I != E; ++I)
 726     for (unsigned i = 0; i < I->getNumOperands(); ++i)
 727       if (I->getOperand(i).isRegister() &&
 728           Stacks[I->getOperand(i).getReg()].size()) {
 729         I->getOperand(i).setReg(Stacks[I->getOperand(i).getReg()].back());
 730       }
 731
 732   // Schedule the copies for this block
 733   ScheduleCopies(MBB, pushed);
 734
 735   // Recur to our successors
 736   for (GraphTraits<MachineBasicBlock*>::ChildIteratorType I =
 737        GraphTraits<MachineBasicBlock*>::child_begin(MBB), E =
 738        GraphTraits<MachineBasicBlock*>::child_end(MBB); I != E; ++I)
 739     if (!visited.count(*I))
 740       InsertCopies(*I, visited);
 741
 742   // As we exit this block, pop the names we pushed while processing it
 743   for (std::set<unsigned>::iterator I = pushed.begin(),
 744        E = pushed.end(); I != E; ++I)
 745     Stacks[*I].pop_back();
 746 }
 747
 748 /// ComputeUltimateVN - Assuming we are going to join two live intervals,
 749 /// compute what the resultant value numbers for each value in the input two
 750 /// ranges will be.  This is complicated by copies between the two which can
 751 /// and will commonly cause multiple value numbers to be merged into one.
 752 ///
 753 /// VN is the value number that we're trying to resolve.  InstDefiningValue
 754 /// keeps track of the new InstDefiningValue assignment for the result
 755 /// LiveInterval.  ThisFromOther/OtherFromThis are sets that keep track of
 756 /// whether a value in this or other is a copy from the opposite set.
 757 /// ThisValNoAssignments/OtherValNoAssignments keep track of value #'s that have
 758 /// already been assigned.
 759 ///
 760 /// ThisFromOther[x] - If x is defined as a copy from the other interval, this
 761 /// contains the value number the copy is from.
 762 ///
 763 static unsigned ComputeUltimateVN(VNInfo *VNI,
 764                                   SmallVector<VNInfo*, 16> &NewVNInfo,
 765                                   DenseMap<VNInfo*, VNInfo*> &ThisFromOther,
 766                                   DenseMap<VNInfo*, VNInfo*> &OtherFromThis,
 767                                   SmallVector<int, 16> &ThisValNoAssignments,
 768                                   SmallVector<int, 16> &OtherValNoAssignments) {
 769   unsigned VN = VNI->id;
 770
 771   // If the VN has already been computed, just return it.
 772   if (ThisValNoAssignments[VN] >= 0)
 773     return ThisValNoAssignments[VN];
 774 //  assert(ThisValNoAssignments[VN] != -2 && "Cyclic case?");
 775
 776   // If this val is not a copy from the other val, then it must be a new value
 777   // number in the destination.
 778   DenseMap<VNInfo*, VNInfo*>::iterator I = ThisFromOther.find(VNI);
 779   if (I == ThisFromOther.end()) {
 780     NewVNInfo.push_back(VNI);
 781     return ThisValNoAssignments[VN] = NewVNInfo.size()-1;
 782   }
 783   VNInfo *OtherValNo = I->second;
 784
 785   // Otherwise, this *is* a copy from the RHS.  If the other side has already
 786   // been computed, return it.
 787   if (OtherValNoAssignments[OtherValNo->id] >= 0)
 788     return ThisValNoAssignments[VN] = OtherValNoAssignments[OtherValNo->id];
 789
 790   // Mark this value number as currently being computed, then ask what the
 791   // ultimate value # of the other value is.
 792   ThisValNoAssignments[VN] = -2;
 793   unsigned UltimateVN =
 794     ComputeUltimateVN(OtherValNo, NewVNInfo, OtherFromThis, ThisFromOther,
 795                       OtherValNoAssignments, ThisValNoAssignments);
 796   return ThisValNoAssignments[VN] = UltimateVN;
 797 }
 798
 799 void StrongPHIElimination::mergeLiveIntervals(unsigned primary,
 800                                               unsigned secondary,
 801                                               unsigned secondaryVN) {
 802
 803   LiveIntervals& LI = getAnalysis<LiveIntervals>();
 804   LiveInterval& LHS = LI.getOrCreateInterval(primary);
 805   LiveInterval& RHS = LI.getOrCreateInterval(secondary);
 806
 807   // Compute the final value assignment, assuming that the live ranges can be
 808   // coalesced.
 809   SmallVector<int, 16> LHSValNoAssignments;
 810   SmallVector<int, 16> RHSValNoAssignments;
 811   DenseMap<VNInfo*, VNInfo*> LHSValsDefinedFromRHS;
 812   DenseMap<VNInfo*, VNInfo*> RHSValsDefinedFromLHS;
 813   SmallVector<VNInfo*, 16> NewVNInfo;
 814
 815   LHSValNoAssignments.resize(LHS.getNumValNums(), -1);
 816   RHSValNoAssignments.resize(RHS.getNumValNums(), -1);
 817   NewVNInfo.reserve(LHS.getNumValNums() + RHS.getNumValNums());
 818
 819   for (LiveInterval::vni_iterator I = LHS.vni_begin(), E = LHS.vni_end();
 820        I != E; ++I) {
 821     VNInfo *VNI = *I;
 822     unsigned VN = VNI->id;
 823     if (LHSValNoAssignments[VN] >= 0 || VNI->def == ~1U)
 824       continue;
 825     ComputeUltimateVN(VNI, NewVNInfo,
 826                       LHSValsDefinedFromRHS, RHSValsDefinedFromLHS,
 827                       LHSValNoAssignments, RHSValNoAssignments);
 828   }
 829
 830   for (LiveInterval::vni_iterator I = RHS.vni_begin(), E = RHS.vni_end();
 831        I != E; ++I) {
 832     VNInfo *VNI = *I;
 833     unsigned VN = VNI->id;
 834     if (RHSValNoAssignments[VN] >= 0 || VNI->def == ~1U)
 835       continue;
 836     // If this value number isn't a copy from the LHS, it's a new number.
 837     if (RHSValsDefinedFromLHS.find(VNI) == RHSValsDefinedFromLHS.end()) {
 838       NewVNInfo.push_back(VNI);
 839       RHSValNoAssignments[VN] = NewVNInfo.size()-1;
 840       continue;
 841     }
 842
 843     ComputeUltimateVN(VNI, NewVNInfo,
 844                       RHSValsDefinedFromLHS, LHSValsDefinedFromRHS,
 845                       RHSValNoAssignments, LHSValNoAssignments);
 846   }
 847
 848   // Update kill info. Some live ranges are extended due to copy coalescing.
 849   for (DenseMap<VNInfo*, VNInfo*>::iterator I = LHSValsDefinedFromRHS.begin(),
 850          E = LHSValsDefinedFromRHS.end(); I != E; ++I) {
 851     VNInfo *VNI = I->first;
 852     unsigned LHSValID = LHSValNoAssignments[VNI->id];
 853     LiveInterval::removeKill(NewVNInfo[LHSValID], VNI->def);
 854     NewVNInfo[LHSValID]->hasPHIKill |= VNI->hasPHIKill;
 855     RHS.addKills(NewVNInfo[LHSValID], VNI->kills);
 856   }
 857
 858   // Update kill info. Some live ranges are extended due to copy coalescing.
 859   for (DenseMap<VNInfo*, VNInfo*>::iterator I = RHSValsDefinedFromLHS.begin(),
 860          E = RHSValsDefinedFromLHS.end(); I != E; ++I) {
 861     VNInfo *VNI = I->first;
 862     unsigned RHSValID = RHSValNoAssignments[VNI->id];
 863     LiveInterval::removeKill(NewVNInfo[RHSValID], VNI->def);
 864     NewVNInfo[RHSValID]->hasPHIKill |= VNI->hasPHIKill;
 865     LHS.addKills(NewVNInfo[RHSValID], VNI->kills);
 866   }
 867
 868   // Use the VNInfo we collected earlier to ensure that the phi copy is
 869   // merged correctly.
 870   // FIXME: This is not working correctly yet.
 871   // RHSValNoAssignments[secondaryVN] = primaryVN;
 872
 873   // If we get here, we know that we can coalesce the live ranges.  Ask the
 874   // intervals to coalesce themselves now.
 875
 876   LHS.join(RHS, &LHSValNoAssignments[0], &RHSValNoAssignments[0], NewVNInfo);
 877   LI.removeInterval(secondary);
 878 }
 879
 880 bool StrongPHIElimination::runOnMachineFunction(MachineFunction &Fn) {
 881   // Compute DFS numbers of each block
 882   computeDFS(Fn);
 883
 884   // Determine which phi node operands need copies
 885   for (MachineFunction::iterator I = Fn.begin(), E = Fn.end(); I != E; ++I)
 886     if (!I->empty() &&
 887         I->begin()->getOpcode() == TargetInstrInfo::PHI)
 888       processBlock(I);
 889
 890   // Insert copies
 891   // FIXME: This process should probably preserve LiveVariables
 892   SmallPtrSet<MachineBasicBlock*, 16> visited;
 893   InsertCopies(Fn.begin(), visited);
 894
 895   // Perform renaming
 896   typedef std::map<unsigned, std::map<unsigned, unsigned> > RenameSetType;
 897   for (RenameSetType::iterator I = RenameSets.begin(), E = RenameSets.end();
 898        I != E; ++I)
 899     for (std::map<unsigned, unsigned>::iterator SI = I->second.begin(),
 900          SE = I->second.end(); SI != SE; ++SI) {
 901       mergeLiveIntervals(I->first, SI->first, SI->second);
 902       Fn.getRegInfo().replaceRegWith(SI->first, I->first);
 903     }
 904
 905   // FIXME: Insert last-minute copies
 906
 907   // Remove PHIs
 908   std::vector<MachineInstr*> phis;
 909   for (MachineFunction::iterator I = Fn.begin(), E = Fn.end(); I != E; ++I) {
 910     for (MachineBasicBlock::iterator BI = I->begin(), BE = I->end();
 911          BI != BE; ++BI)
 912       if (BI->getOpcode() == TargetInstrInfo::PHI)
 913         phis.push_back(BI);
 914   }
 915
 916   LiveIntervals& LI = getAnalysis<LiveIntervals>();
 917
 918   for (std::vector<MachineInstr*>::iterator I = phis.begin(), E = phis.end();
 919        I != E; ++I) {
 920     // If this is a dead PHI node, then remove it from LiveIntervals.
 921     unsigned DestReg = (*I)->getOperand(0).getReg();
 922     if ((*I)->registerDefIsDead(DestReg)) {
 923       LiveInterval& PI = LI.getInterval(DestReg);
 924
 925       if (PI.containsOneValue()) {
 926         LI.removeInterval(DestReg);
 927       } else {
 928         MachineBasicBlock::iterator PIter = *I;
 929         while (PIter->getOpcode() == TargetInstrInfo::PHI) ++PIter;
 930         unsigned idx = LI.getInstructionIndex(PIter);
 931
 932         PI.removeRange(*PI.getLiveRangeContaining(idx), true);
 933       }
 934     }
 935
 936     LI.RemoveMachineInstrFromMaps(*I);
 937     (*I)->eraseFromParent();
 938   }
 939
 940   return false;
 941 }