1 //===-- PhiElimination.cpp - Eliminate PHI nodes by inserting copies ------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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.
14 //===----------------------------------------------------------------------===//
16 #include "llvm/CodeGen/Passes.h"
17 #include "llvm/CodeGen/MachineFunctionPass.h"
18 #include "llvm/CodeGen/MachineInstr.h"
19 #include "llvm/CodeGen/SSARegMap.h"
20 #include "llvm/CodeGen/LiveVariables.h"
21 #include "llvm/Target/TargetInstrInfo.h"
22 #include "llvm/Target/TargetMachine.h"
23 #include "llvm/Support/CFG.h"
24 #include "Support/STLExtras.h"
28 struct PNE : public MachineFunctionPass {
29 bool runOnMachineFunction(MachineFunction &Fn) {
32 // Eliminate PHI instructions by inserting copies into predecessor blocks.
34 for (MachineFunction::iterator I = Fn.begin(), E = Fn.end(); I != E; ++I)
35 Changed |= EliminatePHINodes(Fn, *I);
37 //std::cerr << "AFTER PHI NODE ELIM:\n";
42 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
43 AU.addPreserved<LiveVariables>();
44 MachineFunctionPass::getAnalysisUsage(AU);
48 /// EliminatePHINodes - Eliminate phi nodes by inserting copy instructions
49 /// in predecessor basic blocks.
51 bool EliminatePHINodes(MachineFunction &MF, MachineBasicBlock &MBB);
54 RegisterPass<PNE> X("phi-node-elimination",
55 "Eliminate PHI nodes for register allocation");
59 const PassInfo *llvm::PHIEliminationID = X.getPassInfo();
61 /// EliminatePHINodes - Eliminate phi nodes by inserting copy instructions in
62 /// predecessor basic blocks.
64 bool PNE::EliminatePHINodes(MachineFunction &MF, MachineBasicBlock &MBB) {
65 if (MBB.empty() || MBB.front().getOpcode() != TargetInstrInfo::PHI)
66 return false; // Quick exit for normal case...
68 LiveVariables *LV = getAnalysisToUpdate<LiveVariables>();
69 const TargetInstrInfo &MII = MF.getTarget().getInstrInfo();
70 const MRegisterInfo *RegInfo = MF.getTarget().getRegisterInfo();
72 while (MBB.front().getOpcode() == TargetInstrInfo::PHI) {
73 // Unlink the PHI node from the basic block... but don't delete the PHI yet
74 MachineInstr *MI = MBB.remove(MBB.begin());
76 assert(MRegisterInfo::isVirtualRegister(MI->getOperand(0).getReg()) &&
77 "PHI node doesn't write virt reg?");
79 unsigned DestReg = MI->getOperand(0).getReg();
81 // Create a new register for the incoming PHI arguments
82 const TargetRegisterClass *RC = MF.getSSARegMap()->getRegClass(DestReg);
83 unsigned IncomingReg = MF.getSSARegMap()->createVirtualRegister(RC);
85 // Insert a register to register copy in the top of the current block (but
86 // after any remaining phi nodes) which copies the new incoming register
87 // into the phi node destination.
89 MachineBasicBlock::iterator AfterPHIsIt = MBB.begin();
90 while (AfterPHIsIt != MBB.end() &&
91 AfterPHIsIt->getOpcode() == TargetInstrInfo::PHI)
92 ++AfterPHIsIt; // Skip over all of the PHI nodes...
93 RegInfo->copyRegToReg(MBB, AfterPHIsIt, DestReg, IncomingReg, RC);
95 // Update live variable information if there is any...
97 MachineInstr *PHICopy = --AfterPHIsIt;
99 // Add information to LiveVariables to know that the incoming value is
100 // killed. Note that because the value is defined in several places (once
101 // each for each incoming block), the "def" block and instruction fields
102 // for the VarInfo is not filled in.
104 LV->addVirtualRegisterKilled(IncomingReg, &MBB, PHICopy);
106 // Since we are going to be deleting the PHI node, if it is the last use
107 // of any registers, or if the value itself is dead, we need to move this
108 // information over to the new copy we just inserted...
110 std::pair<LiveVariables::killed_iterator, LiveVariables::killed_iterator>
111 RKs = LV->killed_range(MI);
112 std::vector<std::pair<MachineInstr*, unsigned> > Range;
113 if (RKs.first != RKs.second) {
114 // Copy the range into a vector...
115 Range.assign(RKs.first, RKs.second);
117 // Delete the range...
118 LV->removeVirtualRegistersKilled(RKs.first, RKs.second);
120 // Add all of the kills back, which will update the appropriate info...
121 for (unsigned i = 0, e = Range.size(); i != e; ++i)
122 LV->addVirtualRegisterKilled(Range[i].second, &MBB, PHICopy);
125 RKs = LV->dead_range(MI);
126 if (RKs.first != RKs.second) {
128 Range.assign(RKs.first, RKs.second);
129 LV->removeVirtualRegistersDead(RKs.first, RKs.second);
130 for (unsigned i = 0, e = Range.size(); i != e; ++i)
131 LV->addVirtualRegisterDead(Range[i].second, &MBB, PHICopy);
135 // Now loop over all of the incoming arguments, changing them to copy into
136 // the IncomingReg register in the corresponding predecessor basic block.
138 for (int i = MI->getNumOperands() - 1; i >= 2; i-=2) {
139 MachineOperand &opVal = MI->getOperand(i-1);
141 // Get the MachineBasicBlock equivalent of the BasicBlock that is the
142 // source path the PHI.
143 MachineBasicBlock &opBlock = *MI->getOperand(i).getMachineBasicBlock();
145 MachineBasicBlock::iterator I = opBlock.getFirstTerminator();
147 // Check to make sure we haven't already emitted the copy for this block.
148 // This can happen because PHI nodes may have multiple entries for the
149 // same basic block. It doesn't matter which entry we use though, because
150 // all incoming values are guaranteed to be the same for a particular bb.
152 // If we emitted a copy for this basic block already, it will be right
153 // where we want to insert one now. Just check for a definition of the
154 // register we are interested in!
156 bool HaveNotEmitted = true;
158 if (I != opBlock.begin()) {
159 MachineBasicBlock::iterator PrevInst = prior(I);
160 for (unsigned i = 0, e = PrevInst->getNumOperands(); i != e; ++i) {
161 MachineOperand &MO = PrevInst->getOperand(i);
162 if (MO.isRegister() && MO.getReg() == IncomingReg)
164 HaveNotEmitted = false;
170 if (HaveNotEmitted) { // If the copy has not already been emitted, do it.
171 assert(MRegisterInfo::isVirtualRegister(opVal.getReg()) &&
172 "Machine PHI Operands must all be virtual registers!");
173 unsigned SrcReg = opVal.getReg();
174 RegInfo->copyRegToReg(opBlock, I, IncomingReg, SrcReg, RC);
176 // Now update live variable information if we have it.
178 // We want to be able to insert a kill of the register if this PHI
179 // (aka, the copy we just inserted) is the last use of the source
180 // value. Live variable analysis conservatively handles this by
181 // saying that the value is live until the end of the block the PHI
182 // entry lives in. If the value really is dead at the PHI copy, there
183 // will be no successor blocks which have the value live-in.
185 // Check to see if the copy is the last use, and if so, update the
186 // live variables information so that it knows the copy source
187 // instruction kills the incoming value.
189 LiveVariables::VarInfo &InRegVI = LV->getVarInfo(SrcReg);
191 // Loop over all of the successors of the basic block, checking to see
192 // if the value is either live in the block, or if it is killed in the
193 // block. Also check to see if this register is in use by another PHI
194 // node which has not yet been eliminated. If so, it will be killed
195 // at an appropriate point later.
197 bool ValueIsLive = false;
198 const BasicBlock *BB = opBlock.getBasicBlock();
199 for (succ_const_iterator SI = succ_begin(BB), E = succ_end(BB);
200 SI != E && !ValueIsLive; ++SI) {
201 const std::pair<MachineBasicBlock*, unsigned> &
202 SuccInfo = LV->getBasicBlockInfo(*SI);
204 // Is it alive in this successor?
205 unsigned SuccIdx = SuccInfo.second;
206 if (SuccIdx < InRegVI.AliveBlocks.size() &&
207 InRegVI.AliveBlocks[SuccIdx]) {
212 // Is it killed in this successor?
213 MachineBasicBlock *MBB = SuccInfo.first;
214 for (unsigned i = 0, e = InRegVI.Kills.size(); i != e; ++i)
215 if (InRegVI.Kills[i].first == MBB) {
220 // Is it used by any PHI instructions in this block?
221 if (ValueIsLive) break;
223 // Loop over all of the PHIs in this successor, checking to see if
224 // the register is being used...
225 for (MachineBasicBlock::iterator BBI = MBB->begin(), E=MBB->end();
226 BBI != E && BBI->getOpcode() == TargetInstrInfo::PHI;
228 for (unsigned i = 1, e = BBI->getNumOperands(); i < e; i += 2)
229 if (BBI->getOperand(i).getReg() == SrcReg) {
235 // Okay, if we now know that the value is not live out of the block,
236 // we can add a kill marker to the copy we inserted saying that it
237 // kills the incoming value!
240 MachineBasicBlock::iterator Prev = prior(I);
241 LV->addVirtualRegisterKilled(SrcReg, &opBlock, Prev);
247 // really delete the PHI instruction now!