1 //===-- PhiElimination.cpp - Eliminate PHI nodes by inserting copies ------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // 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 #define DEBUG_TYPE "phielim"
17 #include "llvm/CodeGen/Passes.h"
18 #include "PHIEliminationUtils.h"
19 #include "llvm/ADT/STLExtras.h"
20 #include "llvm/ADT/SmallPtrSet.h"
21 #include "llvm/ADT/Statistic.h"
22 #include "llvm/CodeGen/LiveVariables.h"
23 #include "llvm/CodeGen/MachineDominators.h"
24 #include "llvm/CodeGen/MachineInstr.h"
25 #include "llvm/CodeGen/MachineInstrBuilder.h"
26 #include "llvm/CodeGen/MachineLoopInfo.h"
27 #include "llvm/CodeGen/MachineRegisterInfo.h"
28 #include "llvm/IR/Function.h"
29 #include "llvm/Support/CommandLine.h"
30 #include "llvm/Support/Compiler.h"
31 #include "llvm/Support/Debug.h"
32 #include "llvm/Target/TargetInstrInfo.h"
33 #include "llvm/Target/TargetMachine.h"
38 DisableEdgeSplitting("disable-phi-elim-edge-splitting", cl::init(false),
39 cl::Hidden, cl::desc("Disable critical edge splitting "
40 "during PHI elimination"));
43 class PHIElimination : public MachineFunctionPass {
44 MachineRegisterInfo *MRI; // Machine register information
48 static char ID; // Pass identification, replacement for typeid
49 PHIElimination() : MachineFunctionPass(ID) {
50 initializePHIEliminationPass(*PassRegistry::getPassRegistry());
53 virtual bool runOnMachineFunction(MachineFunction &Fn);
54 virtual void getAnalysisUsage(AnalysisUsage &AU) const;
57 /// EliminatePHINodes - Eliminate phi nodes by inserting copy instructions
58 /// in predecessor basic blocks.
60 bool EliminatePHINodes(MachineFunction &MF, MachineBasicBlock &MBB);
61 void LowerAtomicPHINode(MachineBasicBlock &MBB,
62 MachineBasicBlock::iterator AfterPHIsIt);
64 /// analyzePHINodes - Gather information about the PHI nodes in
65 /// here. In particular, we want to map the number of uses of a virtual
66 /// register which is used in a PHI node. We map that to the BB the
67 /// vreg is coming from. This is used later to determine when the vreg
68 /// is killed in the BB.
70 void analyzePHINodes(const MachineFunction& Fn);
72 /// Split critical edges where necessary for good coalescer performance.
73 bool SplitPHIEdges(MachineFunction &MF, MachineBasicBlock &MBB,
74 MachineLoopInfo *MLI);
76 typedef std::pair<unsigned, unsigned> BBVRegPair;
77 typedef DenseMap<BBVRegPair, unsigned> VRegPHIUse;
79 VRegPHIUse VRegPHIUseCount;
81 // Defs of PHI sources which are implicit_def.
82 SmallPtrSet<MachineInstr*, 4> ImpDefs;
84 // Map reusable lowered PHI node -> incoming join register.
85 typedef DenseMap<MachineInstr*, unsigned,
86 MachineInstrExpressionTrait> LoweredPHIMap;
87 LoweredPHIMap LoweredPHIs;
91 STATISTIC(NumAtomic, "Number of atomic phis lowered");
92 STATISTIC(NumCriticalEdgesSplit, "Number of critical edges split");
93 STATISTIC(NumReused, "Number of reused lowered phis");
95 char PHIElimination::ID = 0;
96 char& llvm::PHIEliminationID = PHIElimination::ID;
98 INITIALIZE_PASS_BEGIN(PHIElimination, "phi-node-elimination",
99 "Eliminate PHI nodes for register allocation",
101 INITIALIZE_PASS_DEPENDENCY(LiveVariables)
102 INITIALIZE_PASS_END(PHIElimination, "phi-node-elimination",
103 "Eliminate PHI nodes for register allocation", false, false)
105 void PHIElimination::getAnalysisUsage(AnalysisUsage &AU) const {
106 AU.addPreserved<LiveVariables>();
107 AU.addPreserved<MachineDominatorTree>();
108 AU.addPreserved<MachineLoopInfo>();
109 MachineFunctionPass::getAnalysisUsage(AU);
112 bool PHIElimination::runOnMachineFunction(MachineFunction &MF) {
113 MRI = &MF.getRegInfo();
114 LV = getAnalysisIfAvailable<LiveVariables>();
116 bool Changed = false;
118 // This pass takes the function out of SSA form.
121 // Split critical edges to help the coalescer
122 if (!DisableEdgeSplitting && LV) {
123 MachineLoopInfo *MLI = getAnalysisIfAvailable<MachineLoopInfo>();
124 for (MachineFunction::iterator I = MF.begin(), E = MF.end(); I != E; ++I)
125 Changed |= SplitPHIEdges(MF, *I, MLI);
128 // Populate VRegPHIUseCount
131 // Eliminate PHI instructions by inserting copies into predecessor blocks.
132 for (MachineFunction::iterator I = MF.begin(), E = MF.end(); I != E; ++I)
133 Changed |= EliminatePHINodes(MF, *I);
135 // Remove dead IMPLICIT_DEF instructions.
136 for (SmallPtrSet<MachineInstr*, 4>::iterator I = ImpDefs.begin(),
137 E = ImpDefs.end(); I != E; ++I) {
138 MachineInstr *DefMI = *I;
139 unsigned DefReg = DefMI->getOperand(0).getReg();
140 if (MRI->use_nodbg_empty(DefReg))
141 DefMI->eraseFromParent();
144 // Clean up the lowered PHI instructions.
145 for (LoweredPHIMap::iterator I = LoweredPHIs.begin(), E = LoweredPHIs.end();
147 MF.DeleteMachineInstr(I->first);
151 VRegPHIUseCount.clear();
156 /// EliminatePHINodes - Eliminate phi nodes by inserting copy instructions in
157 /// predecessor basic blocks.
159 bool PHIElimination::EliminatePHINodes(MachineFunction &MF,
160 MachineBasicBlock &MBB) {
161 if (MBB.empty() || !MBB.front().isPHI())
162 return false; // Quick exit for basic blocks without PHIs.
164 // Get an iterator to the first instruction after the last PHI node (this may
165 // also be the end of the basic block).
166 MachineBasicBlock::iterator AfterPHIsIt = MBB.SkipPHIsAndLabels(MBB.begin());
168 while (MBB.front().isPHI())
169 LowerAtomicPHINode(MBB, AfterPHIsIt);
174 /// isImplicitlyDefined - Return true if all defs of VirtReg are implicit-defs.
175 /// This includes registers with no defs.
176 static bool isImplicitlyDefined(unsigned VirtReg,
177 const MachineRegisterInfo *MRI) {
178 for (MachineRegisterInfo::def_iterator DI = MRI->def_begin(VirtReg),
179 DE = MRI->def_end(); DI != DE; ++DI)
180 if (!DI->isImplicitDef())
185 /// isSourceDefinedByImplicitDef - Return true if all sources of the phi node
186 /// are implicit_def's.
187 static bool isSourceDefinedByImplicitDef(const MachineInstr *MPhi,
188 const MachineRegisterInfo *MRI) {
189 for (unsigned i = 1; i != MPhi->getNumOperands(); i += 2)
190 if (!isImplicitlyDefined(MPhi->getOperand(i).getReg(), MRI))
196 /// LowerAtomicPHINode - Lower the PHI node at the top of the specified block,
197 /// under the assumption that it needs to be lowered in a way that supports
198 /// atomic execution of PHIs. This lowering method is always correct all of the
201 void PHIElimination::LowerAtomicPHINode(
202 MachineBasicBlock &MBB,
203 MachineBasicBlock::iterator AfterPHIsIt) {
205 // Unlink the PHI node from the basic block, but don't delete the PHI yet.
206 MachineInstr *MPhi = MBB.remove(MBB.begin());
208 unsigned NumSrcs = (MPhi->getNumOperands() - 1) / 2;
209 unsigned DestReg = MPhi->getOperand(0).getReg();
210 assert(MPhi->getOperand(0).getSubReg() == 0 && "Can't handle sub-reg PHIs");
211 bool isDead = MPhi->getOperand(0).isDead();
213 // Create a new register for the incoming PHI arguments.
214 MachineFunction &MF = *MBB.getParent();
215 unsigned IncomingReg = 0;
216 bool reusedIncoming = false; // Is IncomingReg reused from an earlier PHI?
218 // Insert a register to register copy at the top of the current block (but
219 // after any remaining phi nodes) which copies the new incoming register
220 // into the phi node destination.
221 const TargetInstrInfo *TII = MF.getTarget().getInstrInfo();
222 if (isSourceDefinedByImplicitDef(MPhi, MRI))
223 // If all sources of a PHI node are implicit_def, just emit an
224 // implicit_def instead of a copy.
225 BuildMI(MBB, AfterPHIsIt, MPhi->getDebugLoc(),
226 TII->get(TargetOpcode::IMPLICIT_DEF), DestReg);
228 // Can we reuse an earlier PHI node? This only happens for critical edges,
229 // typically those created by tail duplication.
230 unsigned &entry = LoweredPHIs[MPhi];
232 // An identical PHI node was already lowered. Reuse the incoming register.
234 reusedIncoming = true;
236 DEBUG(dbgs() << "Reusing " << PrintReg(IncomingReg) << " for " << *MPhi);
238 const TargetRegisterClass *RC = MF.getRegInfo().getRegClass(DestReg);
239 entry = IncomingReg = MF.getRegInfo().createVirtualRegister(RC);
241 BuildMI(MBB, AfterPHIsIt, MPhi->getDebugLoc(),
242 TII->get(TargetOpcode::COPY), DestReg)
243 .addReg(IncomingReg);
246 // Update live variable information if there is any.
248 MachineInstr *PHICopy = prior(AfterPHIsIt);
251 LiveVariables::VarInfo &VI = LV->getVarInfo(IncomingReg);
253 // Increment use count of the newly created virtual register.
254 LV->setPHIJoin(IncomingReg);
256 // When we are reusing the incoming register, it may already have been
257 // killed in this block. The old kill will also have been inserted at
258 // AfterPHIsIt, so it appears before the current PHICopy.
260 if (MachineInstr *OldKill = VI.findKill(&MBB)) {
261 DEBUG(dbgs() << "Remove old kill from " << *OldKill);
262 LV->removeVirtualRegisterKilled(IncomingReg, OldKill);
266 // Add information to LiveVariables to know that the incoming value is
267 // killed. Note that because the value is defined in several places (once
268 // each for each incoming block), the "def" block and instruction fields
269 // for the VarInfo is not filled in.
270 LV->addVirtualRegisterKilled(IncomingReg, PHICopy);
273 // Since we are going to be deleting the PHI node, if it is the last use of
274 // any registers, or if the value itself is dead, we need to move this
275 // information over to the new copy we just inserted.
276 LV->removeVirtualRegistersKilled(MPhi);
278 // If the result is dead, update LV.
280 LV->addVirtualRegisterDead(DestReg, PHICopy);
281 LV->removeVirtualRegisterDead(DestReg, MPhi);
285 // Adjust the VRegPHIUseCount map to account for the removal of this PHI node.
286 for (unsigned i = 1; i != MPhi->getNumOperands(); i += 2)
287 --VRegPHIUseCount[BBVRegPair(MPhi->getOperand(i+1).getMBB()->getNumber(),
288 MPhi->getOperand(i).getReg())];
290 // Now loop over all of the incoming arguments, changing them to copy into the
291 // IncomingReg register in the corresponding predecessor basic block.
292 SmallPtrSet<MachineBasicBlock*, 8> MBBsInsertedInto;
293 for (int i = NumSrcs - 1; i >= 0; --i) {
294 unsigned SrcReg = MPhi->getOperand(i*2+1).getReg();
295 unsigned SrcSubReg = MPhi->getOperand(i*2+1).getSubReg();
296 bool SrcUndef = MPhi->getOperand(i*2+1).isUndef() ||
297 isImplicitlyDefined(SrcReg, MRI);
298 assert(TargetRegisterInfo::isVirtualRegister(SrcReg) &&
299 "Machine PHI Operands must all be virtual registers!");
301 // Get the MachineBasicBlock equivalent of the BasicBlock that is the source
303 MachineBasicBlock &opBlock = *MPhi->getOperand(i*2+2).getMBB();
305 // Check to make sure we haven't already emitted the copy for this block.
306 // This can happen because PHI nodes may have multiple entries for the same
308 if (!MBBsInsertedInto.insert(&opBlock))
309 continue; // If the copy has already been emitted, we're done.
311 // Find a safe location to insert the copy, this may be the first terminator
312 // in the block (or end()).
313 MachineBasicBlock::iterator InsertPos =
314 findPHICopyInsertPoint(&opBlock, &MBB, SrcReg);
317 if (!reusedIncoming && IncomingReg) {
319 // The source register is undefined, so there is no need for a real
320 // COPY, but we still need to ensure joint dominance by defs.
321 // Insert an IMPLICIT_DEF instruction.
322 BuildMI(opBlock, InsertPos, MPhi->getDebugLoc(),
323 TII->get(TargetOpcode::IMPLICIT_DEF), IncomingReg);
325 // Clean up the old implicit-def, if there even was one.
326 if (MachineInstr *DefMI = MRI->getVRegDef(SrcReg))
327 if (DefMI->isImplicitDef())
328 ImpDefs.insert(DefMI);
330 BuildMI(opBlock, InsertPos, MPhi->getDebugLoc(),
331 TII->get(TargetOpcode::COPY), IncomingReg)
332 .addReg(SrcReg, 0, SrcSubReg);
336 // Now update live variable information if we have it. Otherwise we're done
337 if (SrcUndef || !LV) continue;
339 // We want to be able to insert a kill of the register if this PHI (aka, the
340 // copy we just inserted) is the last use of the source value. Live
341 // variable analysis conservatively handles this by saying that the value is
342 // live until the end of the block the PHI entry lives in. If the value
343 // really is dead at the PHI copy, there will be no successor blocks which
344 // have the value live-in.
346 // Also check to see if this register is in use by another PHI node which
347 // has not yet been eliminated. If so, it will be killed at an appropriate
350 // Is it used by any PHI instructions in this block?
351 bool ValueIsUsed = VRegPHIUseCount[BBVRegPair(opBlock.getNumber(), SrcReg)];
353 // Okay, if we now know that the value is not live out of the block, we can
354 // add a kill marker in this block saying that it kills the incoming value!
355 if (!ValueIsUsed && !LV->isLiveOut(SrcReg, opBlock)) {
356 // In our final twist, we have to decide which instruction kills the
357 // register. In most cases this is the copy, however, terminator
358 // instructions at the end of the block may also use the value. In this
359 // case, we should mark the last such terminator as being the killing
360 // block, not the copy.
361 MachineBasicBlock::iterator KillInst = opBlock.end();
362 MachineBasicBlock::iterator FirstTerm = opBlock.getFirstTerminator();
363 for (MachineBasicBlock::iterator Term = FirstTerm;
364 Term != opBlock.end(); ++Term) {
365 if (Term->readsRegister(SrcReg))
369 if (KillInst == opBlock.end()) {
370 // No terminator uses the register.
372 if (reusedIncoming || !IncomingReg) {
373 // We may have to rewind a bit if we didn't insert a copy this time.
374 KillInst = FirstTerm;
375 while (KillInst != opBlock.begin()) {
377 if (KillInst->isDebugValue())
379 if (KillInst->readsRegister(SrcReg))
383 // We just inserted this copy.
384 KillInst = prior(InsertPos);
387 assert(KillInst->readsRegister(SrcReg) && "Cannot find kill instruction");
389 // Finally, mark it killed.
390 LV->addVirtualRegisterKilled(SrcReg, KillInst);
392 // This vreg no longer lives all of the way through opBlock.
393 unsigned opBlockNum = opBlock.getNumber();
394 LV->getVarInfo(SrcReg).AliveBlocks.reset(opBlockNum);
398 // Really delete the PHI instruction now, if it is not in the LoweredPHIs map.
399 if (reusedIncoming || !IncomingReg)
400 MF.DeleteMachineInstr(MPhi);
403 /// analyzePHINodes - Gather information about the PHI nodes in here. In
404 /// particular, we want to map the number of uses of a virtual register which is
405 /// used in a PHI node. We map that to the BB the vreg is coming from. This is
406 /// used later to determine when the vreg is killed in the BB.
408 void PHIElimination::analyzePHINodes(const MachineFunction& MF) {
409 for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
411 for (MachineBasicBlock::const_iterator BBI = I->begin(), BBE = I->end();
412 BBI != BBE && BBI->isPHI(); ++BBI)
413 for (unsigned i = 1, e = BBI->getNumOperands(); i != e; i += 2)
414 ++VRegPHIUseCount[BBVRegPair(BBI->getOperand(i+1).getMBB()->getNumber(),
415 BBI->getOperand(i).getReg())];
418 bool PHIElimination::SplitPHIEdges(MachineFunction &MF,
419 MachineBasicBlock &MBB,
420 MachineLoopInfo *MLI) {
421 if (MBB.empty() || !MBB.front().isPHI() || MBB.isLandingPad())
422 return false; // Quick exit for basic blocks without PHIs.
424 const MachineLoop *CurLoop = MLI ? MLI->getLoopFor(&MBB) : 0;
425 bool IsLoopHeader = CurLoop && &MBB == CurLoop->getHeader();
427 bool Changed = false;
428 for (MachineBasicBlock::iterator BBI = MBB.begin(), BBE = MBB.end();
429 BBI != BBE && BBI->isPHI(); ++BBI) {
430 for (unsigned i = 1, e = BBI->getNumOperands(); i != e; i += 2) {
431 unsigned Reg = BBI->getOperand(i).getReg();
432 MachineBasicBlock *PreMBB = BBI->getOperand(i+1).getMBB();
433 // Is there a critical edge from PreMBB to MBB?
434 if (PreMBB->succ_size() == 1)
437 // Avoid splitting backedges of loops. It would introduce small
438 // out-of-line blocks into the loop which is very bad for code placement.
441 const MachineLoop *PreLoop = MLI ? MLI->getLoopFor(PreMBB) : 0;
442 if (IsLoopHeader && PreLoop == CurLoop)
445 // LV doesn't consider a phi use live-out, so isLiveOut only returns true
446 // when the source register is live-out for some other reason than a phi
447 // use. That means the copy we will insert in PreMBB won't be a kill, and
448 // there is a risk it may not be coalesced away.
450 // If the copy would be a kill, there is no need to split the edge.
451 if (!LV->isLiveOut(Reg, *PreMBB))
454 DEBUG(dbgs() << PrintReg(Reg) << " live-out before critical edge BB#"
455 << PreMBB->getNumber() << " -> BB#" << MBB.getNumber()
458 // If Reg is not live-in to MBB, it means it must be live-in to some
459 // other PreMBB successor, and we can avoid the interference by splitting
462 // If Reg *is* live-in to MBB, the interference is inevitable and a copy
463 // is likely to be left after coalescing. If we are looking at a loop
464 // exiting edge, split it so we won't insert code in the loop, otherwise
466 bool ShouldSplit = !LV->isLiveIn(Reg, MBB);
468 // Check for a loop exiting edge.
469 if (!ShouldSplit && CurLoop != PreLoop) {
471 dbgs() << "Split wouldn't help, maybe avoid loop copies?\n";
472 if (PreLoop) dbgs() << "PreLoop: " << *PreLoop;
473 if (CurLoop) dbgs() << "CurLoop: " << *CurLoop;
475 // This edge could be entering a loop, exiting a loop, or it could be
476 // both: Jumping directly form one loop to the header of a sibling
478 // Split unless this edge is entering CurLoop from an outer loop.
479 ShouldSplit = PreLoop && !PreLoop->contains(CurLoop);
483 if (!PreMBB->SplitCriticalEdge(&MBB, this)) {
484 DEBUG(dbgs() << "Failed to split ciritcal edge.\n");
488 ++NumCriticalEdgesSplit;