blob: 37e2ee1fae16f463fe3400c05350e53afd1a0de3 [file] [log] [blame]
Chris Lattnerbc40e892003-01-13 20:01:16 +00001//===-- PhiElimination.cpp - Eliminate PHI nodes by inserting copies ------===//
Misha Brukmanedf128a2005-04-21 22:36:52 +00002//
John Criswellb576c942003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanedf128a2005-04-21 22:36:52 +00007//
John Criswellb576c942003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattnerbc40e892003-01-13 20:01:16 +00009//
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
Chris Lattnercd3245a2006-12-19 22:41:21 +000016#define DEBUG_TYPE "phielim"
Chris Lattner0742b592004-02-23 18:38:20 +000017#include "llvm/CodeGen/Passes.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000018#include "PHIEliminationUtils.h"
19#include "llvm/ADT/STLExtras.h"
20#include "llvm/ADT/SmallPtrSet.h"
21#include "llvm/ADT/Statistic.h"
Cameron Zwarichb7cfac32013-02-10 06:42:36 +000022#include "llvm/CodeGen/LiveIntervalAnalysis.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000023#include "llvm/CodeGen/LiveVariables.h"
Jakob Stoklund Olesen9aebb612009-11-14 00:38:06 +000024#include "llvm/CodeGen/MachineDominators.h"
Chris Lattnerbc40e892003-01-13 20:01:16 +000025#include "llvm/CodeGen/MachineInstr.h"
Evan Chengf870fbc2008-04-11 17:54:45 +000026#include "llvm/CodeGen/MachineInstrBuilder.h"
Evan Cheng97b9b972010-08-17 01:20:36 +000027#include "llvm/CodeGen/MachineLoopInfo.h"
Chris Lattner84bc5422007-12-31 04:13:23 +000028#include "llvm/CodeGen/MachineRegisterInfo.h"
Chandler Carruth0b8c9a82013-01-02 11:36:10 +000029#include "llvm/IR/Function.h"
Cameron Zwarich6a951ac2011-03-10 05:59:17 +000030#include "llvm/Support/CommandLine.h"
Chris Lattnera4f0b3a2006-08-27 12:54:02 +000031#include "llvm/Support/Compiler.h"
Jakob Stoklund Olesenf235f132009-11-10 22:01:05 +000032#include "llvm/Support/Debug.h"
Chandler Carruthd04a8d42012-12-03 16:50:05 +000033#include "llvm/Target/TargetInstrInfo.h"
34#include "llvm/Target/TargetMachine.h"
Chris Lattner6db07562005-10-03 07:22:07 +000035#include <algorithm>
Chris Lattner0742b592004-02-23 18:38:20 +000036using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000037
Cameron Zwarich6a951ac2011-03-10 05:59:17 +000038static cl::opt<bool>
39DisableEdgeSplitting("disable-phi-elim-edge-splitting", cl::init(false),
40 cl::Hidden, cl::desc("Disable critical edge splitting "
41 "during PHI elimination"));
42
Cameron Zwarich5758a712013-02-12 03:49:25 +000043static cl::opt<bool>
44SplitAllCriticalEdges("phi-elim-split-all-critical-edges", cl::init(false),
45 cl::Hidden, cl::desc("Split all critical edges during "
46 "PHI elimination"));
47
Cameron Zwarich0a3fdd62010-12-05 21:39:42 +000048namespace {
49 class PHIElimination : public MachineFunctionPass {
50 MachineRegisterInfo *MRI; // Machine register information
Cameron Zwarichfe0fd352013-02-10 06:42:30 +000051 LiveVariables *LV;
Cameron Zwarichb7cfac32013-02-10 06:42:36 +000052 LiveIntervals *LIS;
Cameron Zwarich0a3fdd62010-12-05 21:39:42 +000053
54 public:
55 static char ID; // Pass identification, replacement for typeid
56 PHIElimination() : MachineFunctionPass(ID) {
57 initializePHIEliminationPass(*PassRegistry::getPassRegistry());
58 }
59
60 virtual bool runOnMachineFunction(MachineFunction &Fn);
61 virtual void getAnalysisUsage(AnalysisUsage &AU) const;
62
63 private:
64 /// EliminatePHINodes - Eliminate phi nodes by inserting copy instructions
65 /// in predecessor basic blocks.
66 ///
67 bool EliminatePHINodes(MachineFunction &MF, MachineBasicBlock &MBB);
Cameron Zwarich02513c02013-02-10 06:42:32 +000068 void LowerPHINode(MachineBasicBlock &MBB,
69 MachineBasicBlock::iterator AfterPHIsIt);
Cameron Zwarich0a3fdd62010-12-05 21:39:42 +000070
71 /// analyzePHINodes - Gather information about the PHI nodes in
72 /// here. In particular, we want to map the number of uses of a virtual
73 /// register which is used in a PHI node. We map that to the BB the
74 /// vreg is coming from. This is used later to determine when the vreg
75 /// is killed in the BB.
76 ///
77 void analyzePHINodes(const MachineFunction& Fn);
78
79 /// Split critical edges where necessary for good coalescer performance.
80 bool SplitPHIEdges(MachineFunction &MF, MachineBasicBlock &MBB,
Cameron Zwarichfe0fd352013-02-10 06:42:30 +000081 MachineLoopInfo *MLI);
Cameron Zwarich0a3fdd62010-12-05 21:39:42 +000082
Cameron Zwarich36f54482013-02-10 23:29:49 +000083 // These functions are temporary abstractions around LiveVariables and
84 // LiveIntervals, so they can go away when LiveVariables does.
85 bool isLiveIn(unsigned Reg, MachineBasicBlock *MBB);
86 bool isLiveOutPastPHIs(unsigned Reg, MachineBasicBlock *MBB);
87
Cameron Zwarich0a3fdd62010-12-05 21:39:42 +000088 typedef std::pair<unsigned, unsigned> BBVRegPair;
89 typedef DenseMap<BBVRegPair, unsigned> VRegPHIUse;
90
91 VRegPHIUse VRegPHIUseCount;
92
93 // Defs of PHI sources which are implicit_def.
94 SmallPtrSet<MachineInstr*, 4> ImpDefs;
95
96 // Map reusable lowered PHI node -> incoming join register.
97 typedef DenseMap<MachineInstr*, unsigned,
98 MachineInstrExpressionTrait> LoweredPHIMap;
99 LoweredPHIMap LoweredPHIs;
100 };
101}
102
Cameron Zwarich02513c02013-02-10 06:42:32 +0000103STATISTIC(NumLowered, "Number of phis lowered");
Cameron Zwarich117be032011-02-14 02:09:11 +0000104STATISTIC(NumCriticalEdgesSplit, "Number of critical edges split");
Jakob Stoklund Olesen74215fc2009-12-16 18:55:53 +0000105STATISTIC(NumReused, "Number of reused lowered phis");
Jakob Stoklund Olesenf235f132009-11-10 22:01:05 +0000106
Lang Hamesfae02a22009-07-21 23:47:33 +0000107char PHIElimination::ID = 0;
Cameron Zwarich0a3fdd62010-12-05 21:39:42 +0000108char& llvm::PHIEliminationID = PHIElimination::ID;
Chris Lattnerbc40e892003-01-13 20:01:16 +0000109
Andrew Trick8dd26252012-02-10 04:10:36 +0000110INITIALIZE_PASS_BEGIN(PHIElimination, "phi-node-elimination",
111 "Eliminate PHI nodes for register allocation",
112 false, false)
113INITIALIZE_PASS_DEPENDENCY(LiveVariables)
114INITIALIZE_PASS_END(PHIElimination, "phi-node-elimination",
115 "Eliminate PHI nodes for register allocation", false, false)
116
Cameron Zwarich0a3fdd62010-12-05 21:39:42 +0000117void PHIElimination::getAnalysisUsage(AnalysisUsage &AU) const {
Dan Gohman845012e2009-07-31 23:37:33 +0000118 AU.addPreserved<LiveVariables>();
Cameron Zwarich4f659ec2013-02-20 06:46:28 +0000119 AU.addPreserved<SlotIndexes>();
Cameron Zwarichb7cfac32013-02-10 06:42:36 +0000120 AU.addPreserved<LiveIntervals>();
Jakob Stoklund Olesen9aebb612009-11-14 00:38:06 +0000121 AU.addPreserved<MachineDominatorTree>();
Evan Cheng148341c2010-08-17 21:00:37 +0000122 AU.addPreserved<MachineLoopInfo>();
Dan Gohman845012e2009-07-31 23:37:33 +0000123 MachineFunctionPass::getAnalysisUsage(AU);
124}
Lang Hamesfae02a22009-07-21 23:47:33 +0000125
Cameron Zwarich0a3fdd62010-12-05 21:39:42 +0000126bool PHIElimination::runOnMachineFunction(MachineFunction &MF) {
Evan Cheng28428cd2010-05-04 17:12:26 +0000127 MRI = &MF.getRegInfo();
Cameron Zwarichfe0fd352013-02-10 06:42:30 +0000128 LV = getAnalysisIfAvailable<LiveVariables>();
Cameron Zwarichb7cfac32013-02-10 06:42:36 +0000129 LIS = getAnalysisIfAvailable<LiveIntervals>();
Evan Cheng576a2702008-04-03 16:38:20 +0000130
Evan Cheng576a2702008-04-03 16:38:20 +0000131 bool Changed = false;
132
Jakob Stoklund Olesen73e7dce2011-07-29 22:51:22 +0000133 // This pass takes the function out of SSA form.
134 MRI->leaveSSA();
135
Cameron Zwarichb7cfac32013-02-10 06:42:36 +0000136 // Split critical edges to help the coalescer. This does not yet support
137 // updating LiveIntervals, so we disable it.
Cameron Zwarich8597c142013-02-11 09:24:47 +0000138 if (!DisableEdgeSplitting && (LV || LIS)) {
Cameron Zwarichfe0fd352013-02-10 06:42:30 +0000139 MachineLoopInfo *MLI = getAnalysisIfAvailable<MachineLoopInfo>();
140 for (MachineFunction::iterator I = MF.begin(), E = MF.end(); I != E; ++I)
141 Changed |= SplitPHIEdges(MF, *I, MLI);
Evan Cheng148341c2010-08-17 21:00:37 +0000142 }
Jakob Stoklund Olesen3e204752009-11-11 19:31:31 +0000143
144 // Populate VRegPHIUseCount
Evan Cheng28428cd2010-05-04 17:12:26 +0000145 analyzePHINodes(MF);
Jakob Stoklund Olesen3e204752009-11-11 19:31:31 +0000146
Evan Cheng576a2702008-04-03 16:38:20 +0000147 // Eliminate PHI instructions by inserting copies into predecessor blocks.
Evan Cheng28428cd2010-05-04 17:12:26 +0000148 for (MachineFunction::iterator I = MF.begin(), E = MF.end(); I != E; ++I)
149 Changed |= EliminatePHINodes(MF, *I);
Evan Cheng576a2702008-04-03 16:38:20 +0000150
151 // Remove dead IMPLICIT_DEF instructions.
Bill Wendling3de82492009-12-17 23:42:32 +0000152 for (SmallPtrSet<MachineInstr*, 4>::iterator I = ImpDefs.begin(),
Evan Cheng576a2702008-04-03 16:38:20 +0000153 E = ImpDefs.end(); I != E; ++I) {
154 MachineInstr *DefMI = *I;
155 unsigned DefReg = DefMI->getOperand(0).getReg();
Cameron Zwarichb7cfac32013-02-10 06:42:36 +0000156 if (MRI->use_nodbg_empty(DefReg)) {
157 if (LIS)
158 LIS->RemoveMachineInstrFromMaps(DefMI);
Evan Cheng576a2702008-04-03 16:38:20 +0000159 DefMI->eraseFromParent();
Cameron Zwarichb7cfac32013-02-10 06:42:36 +0000160 }
Evan Cheng576a2702008-04-03 16:38:20 +0000161 }
162
Jakob Stoklund Olesen74215fc2009-12-16 18:55:53 +0000163 // Clean up the lowered PHI instructions.
164 for (LoweredPHIMap::iterator I = LoweredPHIs.begin(), E = LoweredPHIs.end();
Cameron Zwarichb7cfac32013-02-10 06:42:36 +0000165 I != E; ++I) {
Cameron Zwarich8d491342013-02-12 05:48:56 +0000166 if (LIS)
167 LIS->RemoveMachineInstrFromMaps(I->first);
Evan Cheng28428cd2010-05-04 17:12:26 +0000168 MF.DeleteMachineInstr(I->first);
Cameron Zwarichb7cfac32013-02-10 06:42:36 +0000169 }
Jakob Stoklund Olesen74215fc2009-12-16 18:55:53 +0000170
Bill Wendling3de82492009-12-17 23:42:32 +0000171 LoweredPHIs.clear();
Evan Cheng576a2702008-04-03 16:38:20 +0000172 ImpDefs.clear();
173 VRegPHIUseCount.clear();
Evan Cheng28428cd2010-05-04 17:12:26 +0000174
Cameron Zwarichb7cfac32013-02-10 06:42:36 +0000175 if (LIS)
176 MF.verify(this, "After PHI elimination");
177
Evan Cheng576a2702008-04-03 16:38:20 +0000178 return Changed;
179}
180
Chris Lattnerbc40e892003-01-13 20:01:16 +0000181/// EliminatePHINodes - Eliminate phi nodes by inserting copy instructions in
182/// predecessor basic blocks.
183///
Cameron Zwarich0a3fdd62010-12-05 21:39:42 +0000184bool PHIElimination::EliminatePHINodes(MachineFunction &MF,
Lang Hamesfae02a22009-07-21 23:47:33 +0000185 MachineBasicBlock &MBB) {
Chris Lattner518bb532010-02-09 19:54:29 +0000186 if (MBB.empty() || !MBB.front().isPHI())
Chris Lattner53a79aa2005-10-03 04:47:08 +0000187 return false; // Quick exit for basic blocks without PHIs.
Chris Lattnerbc40e892003-01-13 20:01:16 +0000188
Chris Lattner791f8962004-05-10 18:47:18 +0000189 // Get an iterator to the first instruction after the last PHI node (this may
Chris Lattner53a79aa2005-10-03 04:47:08 +0000190 // also be the end of the basic block).
Cameron Zwarich2a794292010-12-04 20:40:15 +0000191 MachineBasicBlock::iterator AfterPHIsIt = MBB.SkipPHIsAndLabels(MBB.begin());
Chris Lattner791f8962004-05-10 18:47:18 +0000192
Chris Lattner518bb532010-02-09 19:54:29 +0000193 while (MBB.front().isPHI())
Cameron Zwarich02513c02013-02-10 06:42:32 +0000194 LowerPHINode(MBB, AfterPHIsIt);
Bill Wendlingca756d22006-09-28 07:10:24 +0000195
Chris Lattner53a79aa2005-10-03 04:47:08 +0000196 return true;
197}
Misha Brukmanedf128a2005-04-21 22:36:52 +0000198
Jakob Stoklund Olesen52137502012-06-25 03:36:12 +0000199/// isImplicitlyDefined - Return true if all defs of VirtReg are implicit-defs.
200/// This includes registers with no defs.
201static bool isImplicitlyDefined(unsigned VirtReg,
202 const MachineRegisterInfo *MRI) {
203 for (MachineRegisterInfo::def_iterator DI = MRI->def_begin(VirtReg),
204 DE = MRI->def_end(); DI != DE; ++DI)
205 if (!DI->isImplicitDef())
206 return false;
207 return true;
208}
209
Evan Cheng1b38ec82008-06-19 01:21:26 +0000210/// isSourceDefinedByImplicitDef - Return true if all sources of the phi node
211/// are implicit_def's.
Bill Wendlingae94dda2008-05-12 22:15:05 +0000212static bool isSourceDefinedByImplicitDef(const MachineInstr *MPhi,
Evan Cheng1b38ec82008-06-19 01:21:26 +0000213 const MachineRegisterInfo *MRI) {
Jakob Stoklund Olesen52137502012-06-25 03:36:12 +0000214 for (unsigned i = 1; i != MPhi->getNumOperands(); i += 2)
215 if (!isImplicitlyDefined(MPhi->getOperand(i).getReg(), MRI))
Evan Chengb3e0a6d2008-05-10 00:17:50 +0000216 return false;
Evan Chengb3e0a6d2008-05-10 00:17:50 +0000217 return true;
Evan Chengf870fbc2008-04-11 17:54:45 +0000218}
219
Evan Chengfc0b80d2009-03-13 22:59:14 +0000220
Cameron Zwarich02513c02013-02-10 06:42:32 +0000221/// LowerPHINode - Lower the PHI node at the top of the specified block,
Jakob Stoklund Olesene35e3c32009-11-10 22:00:56 +0000222///
Cameron Zwarich02513c02013-02-10 06:42:32 +0000223void PHIElimination::LowerPHINode(MachineBasicBlock &MBB,
224 MachineBasicBlock::iterator AfterPHIsIt) {
225 ++NumLowered;
Chris Lattner53a79aa2005-10-03 04:47:08 +0000226 // Unlink the PHI node from the basic block, but don't delete the PHI yet.
227 MachineInstr *MPhi = MBB.remove(MBB.begin());
Chris Lattnerbc40e892003-01-13 20:01:16 +0000228
Evan Chengf870fbc2008-04-11 17:54:45 +0000229 unsigned NumSrcs = (MPhi->getNumOperands() - 1) / 2;
Chris Lattner53a79aa2005-10-03 04:47:08 +0000230 unsigned DestReg = MPhi->getOperand(0).getReg();
Jakob Stoklund Olesen9ac24882010-08-18 16:09:47 +0000231 assert(MPhi->getOperand(0).getSubReg() == 0 && "Can't handle sub-reg PHIs");
Evan Cheng9f1c8312008-07-03 09:09:37 +0000232 bool isDead = MPhi->getOperand(0).isDead();
Misha Brukmanedf128a2005-04-21 22:36:52 +0000233
Bill Wendlingca756d22006-09-28 07:10:24 +0000234 // Create a new register for the incoming PHI arguments.
Chris Lattner53a79aa2005-10-03 04:47:08 +0000235 MachineFunction &MF = *MBB.getParent();
Evan Cheng9f1c8312008-07-03 09:09:37 +0000236 unsigned IncomingReg = 0;
Jakob Stoklund Olesen74215fc2009-12-16 18:55:53 +0000237 bool reusedIncoming = false; // Is IncomingReg reused from an earlier PHI?
Chris Lattnerbc40e892003-01-13 20:01:16 +0000238
Bill Wendlingae94dda2008-05-12 22:15:05 +0000239 // Insert a register to register copy at the top of the current block (but
Chris Lattner53a79aa2005-10-03 04:47:08 +0000240 // after any remaining phi nodes) which copies the new incoming register
241 // into the phi node destination.
Owen Andersond10fd972007-12-31 06:32:00 +0000242 const TargetInstrInfo *TII = MF.getTarget().getInstrInfo();
Evan Chengb3e0a6d2008-05-10 00:17:50 +0000243 if (isSourceDefinedByImplicitDef(MPhi, MRI))
Evan Cheng9f1c8312008-07-03 09:09:37 +0000244 // If all sources of a PHI node are implicit_def, just emit an
245 // implicit_def instead of a copy.
Bill Wendlingd62e06c2009-02-03 02:29:34 +0000246 BuildMI(MBB, AfterPHIsIt, MPhi->getDebugLoc(),
Chris Lattner518bb532010-02-09 19:54:29 +0000247 TII->get(TargetOpcode::IMPLICIT_DEF), DestReg);
Evan Cheng9f1c8312008-07-03 09:09:37 +0000248 else {
Jakob Stoklund Olesen74215fc2009-12-16 18:55:53 +0000249 // Can we reuse an earlier PHI node? This only happens for critical edges,
250 // typically those created by tail duplication.
251 unsigned &entry = LoweredPHIs[MPhi];
252 if (entry) {
253 // An identical PHI node was already lowered. Reuse the incoming register.
254 IncomingReg = entry;
255 reusedIncoming = true;
256 ++NumReused;
Jakob Stoklund Olesen43142682011-01-09 03:05:53 +0000257 DEBUG(dbgs() << "Reusing " << PrintReg(IncomingReg) << " for " << *MPhi);
Jakob Stoklund Olesen74215fc2009-12-16 18:55:53 +0000258 } else {
Jakob Stoklund Olesen92c1f722010-07-10 19:08:25 +0000259 const TargetRegisterClass *RC = MF.getRegInfo().getRegClass(DestReg);
Jakob Stoklund Olesen74215fc2009-12-16 18:55:53 +0000260 entry = IncomingReg = MF.getRegInfo().createVirtualRegister(RC);
261 }
Jakob Stoklund Olesen92c1f722010-07-10 19:08:25 +0000262 BuildMI(MBB, AfterPHIsIt, MPhi->getDebugLoc(),
263 TII->get(TargetOpcode::COPY), DestReg)
264 .addReg(IncomingReg);
Evan Cheng9f1c8312008-07-03 09:09:37 +0000265 }
Chris Lattner53a79aa2005-10-03 04:47:08 +0000266
Bill Wendlingae94dda2008-05-12 22:15:05 +0000267 // Update live variable information if there is any.
Chris Lattner53a79aa2005-10-03 04:47:08 +0000268 if (LV) {
269 MachineInstr *PHICopy = prior(AfterPHIsIt);
270
Evan Cheng9f1c8312008-07-03 09:09:37 +0000271 if (IncomingReg) {
Jakob Stoklund Olesen74215fc2009-12-16 18:55:53 +0000272 LiveVariables::VarInfo &VI = LV->getVarInfo(IncomingReg);
273
Evan Cheng9f1c8312008-07-03 09:09:37 +0000274 // Increment use count of the newly created virtual register.
Jakob Stoklund Olesendcfe5f32010-02-23 22:43:58 +0000275 LV->setPHIJoin(IncomingReg);
Jakob Stoklund Olesen74215fc2009-12-16 18:55:53 +0000276
277 // When we are reusing the incoming register, it may already have been
278 // killed in this block. The old kill will also have been inserted at
279 // AfterPHIsIt, so it appears before the current PHICopy.
280 if (reusedIncoming)
281 if (MachineInstr *OldKill = VI.findKill(&MBB)) {
David Greenef7882972010-01-05 01:24:24 +0000282 DEBUG(dbgs() << "Remove old kill from " << *OldKill);
Jakob Stoklund Olesen74215fc2009-12-16 18:55:53 +0000283 LV->removeVirtualRegisterKilled(IncomingReg, OldKill);
284 DEBUG(MBB.dump());
285 }
Evan Cheng3fefc182007-04-18 00:36:11 +0000286
Evan Cheng9f1c8312008-07-03 09:09:37 +0000287 // Add information to LiveVariables to know that the incoming value is
288 // killed. Note that because the value is defined in several places (once
289 // each for each incoming block), the "def" block and instruction fields
290 // for the VarInfo is not filled in.
291 LV->addVirtualRegisterKilled(IncomingReg, PHICopy);
Evan Cheng9f1c8312008-07-03 09:09:37 +0000292 }
Misha Brukmanedf128a2005-04-21 22:36:52 +0000293
Bill Wendlingae94dda2008-05-12 22:15:05 +0000294 // Since we are going to be deleting the PHI node, if it is the last use of
295 // any registers, or if the value itself is dead, we need to move this
Chris Lattner53a79aa2005-10-03 04:47:08 +0000296 // information over to the new copy we just inserted.
Chris Lattner53a79aa2005-10-03 04:47:08 +0000297 LV->removeVirtualRegistersKilled(MPhi);
Chris Lattnerbc40e892003-01-13 20:01:16 +0000298
Chris Lattner6db07562005-10-03 07:22:07 +0000299 // If the result is dead, update LV.
Evan Cheng9f1c8312008-07-03 09:09:37 +0000300 if (isDead) {
Chris Lattner6db07562005-10-03 07:22:07 +0000301 LV->addVirtualRegisterDead(DestReg, PHICopy);
Evan Cheng9f1c8312008-07-03 09:09:37 +0000302 LV->removeVirtualRegisterDead(DestReg, MPhi);
Chris Lattner53a79aa2005-10-03 04:47:08 +0000303 }
304 }
Chris Lattnerbc40e892003-01-13 20:01:16 +0000305
Cameron Zwarichb7cfac32013-02-10 06:42:36 +0000306 // Update LiveIntervals for the new copy or implicit def.
307 if (LIS) {
308 MachineInstr *NewInstr = prior(AfterPHIsIt);
309 LIS->InsertMachineInstrInMaps(NewInstr);
310
311 SlotIndex MBBStartIndex = LIS->getMBBStartIdx(&MBB);
312 SlotIndex DestCopyIndex = LIS->getInstructionIndex(NewInstr);
313 if (IncomingReg) {
314 // Add the region from the beginning of MBB to the copy instruction to
315 // IncomingReg's live interval.
316 LiveInterval &IncomingLI = LIS->getOrCreateInterval(IncomingReg);
317 VNInfo *IncomingVNI = IncomingLI.getVNInfoAt(MBBStartIndex);
318 if (!IncomingVNI)
319 IncomingVNI = IncomingLI.getNextValue(MBBStartIndex,
320 LIS->getVNInfoAllocator());
321 IncomingLI.addRange(LiveRange(MBBStartIndex,
322 DestCopyIndex.getRegSlot(),
323 IncomingVNI));
324 }
325
326 LiveInterval &DestLI = LIS->getOrCreateInterval(DestReg);
327 if (NewInstr->getOperand(0).isDead()) {
328 // A dead PHI's live range begins and ends at the start of the MBB, but
329 // the lowered copy, which will still be dead, needs to begin and end at
330 // the copy instruction.
331 VNInfo *OrigDestVNI = DestLI.getVNInfoAt(MBBStartIndex);
332 assert(OrigDestVNI && "PHI destination should be live at block entry.");
333 DestLI.removeRange(MBBStartIndex, MBBStartIndex.getDeadSlot());
334 DestLI.createDeadDef(DestCopyIndex.getRegSlot(),
335 LIS->getVNInfoAllocator());
336 DestLI.removeValNo(OrigDestVNI);
337 } else {
338 // Otherwise, remove the region from the beginning of MBB to the copy
339 // instruction from DestReg's live interval.
340 DestLI.removeRange(MBBStartIndex, DestCopyIndex.getRegSlot());
341 VNInfo *DestVNI = DestLI.getVNInfoAt(DestCopyIndex.getRegSlot());
342 assert(DestVNI && "PHI destination should be live at its definition.");
343 DestVNI->def = DestCopyIndex.getRegSlot();
344 }
345 }
346
Bill Wendlingae94dda2008-05-12 22:15:05 +0000347 // Adjust the VRegPHIUseCount map to account for the removal of this PHI node.
Chris Lattner53a79aa2005-10-03 04:47:08 +0000348 for (unsigned i = 1; i != MPhi->getNumOperands(); i += 2)
Jakob Stoklund Olesen74215fc2009-12-16 18:55:53 +0000349 --VRegPHIUseCount[BBVRegPair(MPhi->getOperand(i+1).getMBB()->getNumber(),
Chris Lattner8aa797a2007-12-30 23:10:15 +0000350 MPhi->getOperand(i).getReg())];
Chris Lattner572c7702003-05-12 14:28:28 +0000351
Bill Wendlingae94dda2008-05-12 22:15:05 +0000352 // Now loop over all of the incoming arguments, changing them to copy into the
353 // IncomingReg register in the corresponding predecessor basic block.
Evan Cheng576a2702008-04-03 16:38:20 +0000354 SmallPtrSet<MachineBasicBlock*, 8> MBBsInsertedInto;
Evan Chengf870fbc2008-04-11 17:54:45 +0000355 for (int i = NumSrcs - 1; i >= 0; --i) {
356 unsigned SrcReg = MPhi->getOperand(i*2+1).getReg();
Jakob Stoklund Olesen9ac24882010-08-18 16:09:47 +0000357 unsigned SrcSubReg = MPhi->getOperand(i*2+1).getSubReg();
Jakob Stoklund Olesen52137502012-06-25 03:36:12 +0000358 bool SrcUndef = MPhi->getOperand(i*2+1).isUndef() ||
359 isImplicitlyDefined(SrcReg, MRI);
Dan Gohman6f0d0242008-02-10 18:45:23 +0000360 assert(TargetRegisterInfo::isVirtualRegister(SrcReg) &&
Chris Lattner6db07562005-10-03 07:22:07 +0000361 "Machine PHI Operands must all be virtual registers!");
Chris Lattner53a79aa2005-10-03 04:47:08 +0000362
Lang Hames287b8b02009-07-23 04:34:03 +0000363 // Get the MachineBasicBlock equivalent of the BasicBlock that is the source
364 // path the PHI.
365 MachineBasicBlock &opBlock = *MPhi->getOperand(i*2+2).getMBB();
366
Chris Lattner53a79aa2005-10-03 04:47:08 +0000367 // Check to make sure we haven't already emitted the copy for this block.
Bill Wendlingae94dda2008-05-12 22:15:05 +0000368 // This can happen because PHI nodes may have multiple entries for the same
369 // basic block.
Evan Cheng576a2702008-04-03 16:38:20 +0000370 if (!MBBsInsertedInto.insert(&opBlock))
Chris Lattner6db07562005-10-03 07:22:07 +0000371 continue; // If the copy has already been emitted, we're done.
Jakob Stoklund Olesene35e3c32009-11-10 22:00:56 +0000372
Bill Wendlingae94dda2008-05-12 22:15:05 +0000373 // Find a safe location to insert the copy, this may be the first terminator
374 // in the block (or end()).
Jakob Stoklund Olesen12222872009-11-13 21:56:15 +0000375 MachineBasicBlock::iterator InsertPos =
Cameron Zwaricha4746852010-12-05 19:51:05 +0000376 findPHICopyInsertPoint(&opBlock, &MBB, SrcReg);
Evan Chengfc0b80d2009-03-13 22:59:14 +0000377
Chris Lattner6db07562005-10-03 07:22:07 +0000378 // Insert the copy.
Cameron Zwarichb7cfac32013-02-10 06:42:36 +0000379 MachineInstr *NewSrcInstr = 0;
Jakob Stoklund Olesen52137502012-06-25 03:36:12 +0000380 if (!reusedIncoming && IncomingReg) {
381 if (SrcUndef) {
382 // The source register is undefined, so there is no need for a real
383 // COPY, but we still need to ensure joint dominance by defs.
384 // Insert an IMPLICIT_DEF instruction.
Cameron Zwarichb7cfac32013-02-10 06:42:36 +0000385 NewSrcInstr = BuildMI(opBlock, InsertPos, MPhi->getDebugLoc(),
386 TII->get(TargetOpcode::IMPLICIT_DEF),
387 IncomingReg);
Jakob Stoklund Olesen52137502012-06-25 03:36:12 +0000388
389 // Clean up the old implicit-def, if there even was one.
390 if (MachineInstr *DefMI = MRI->getVRegDef(SrcReg))
391 if (DefMI->isImplicitDef())
392 ImpDefs.insert(DefMI);
393 } else {
Cameron Zwarichb7cfac32013-02-10 06:42:36 +0000394 NewSrcInstr = BuildMI(opBlock, InsertPos, MPhi->getDebugLoc(),
395 TII->get(TargetOpcode::COPY), IncomingReg)
396 .addReg(SrcReg, 0, SrcSubReg);
Jakob Stoklund Olesen52137502012-06-25 03:36:12 +0000397 }
398 }
Chris Lattner53a79aa2005-10-03 04:47:08 +0000399
Cameron Zwarichb7cfac32013-02-10 06:42:36 +0000400 // We only need to update the LiveVariables kill of SrcReg if this was the
401 // last PHI use of SrcReg to be lowered on this CFG edge and it is not live
402 // out of the predecessor. We can also ignore undef sources.
403 if (LV && !SrcUndef &&
404 !VRegPHIUseCount[BBVRegPair(opBlock.getNumber(), SrcReg)] &&
405 !LV->isLiveOut(SrcReg, opBlock)) {
406 // We want to be able to insert a kill of the register if this PHI (aka,
407 // the copy we just inserted) is the last use of the source value. Live
408 // variable analysis conservatively handles this by saying that the value
409 // is live until the end of the block the PHI entry lives in. If the value
410 // really is dead at the PHI copy, there will be no successor blocks which
411 // have the value live-in.
Jakob Stoklund Olesene35e3c32009-11-10 22:00:56 +0000412
Cameron Zwarichb7cfac32013-02-10 06:42:36 +0000413 // Okay, if we now know that the value is not live out of the block, we
414 // can add a kill marker in this block saying that it kills the incoming
415 // value!
Chris Lattner6db07562005-10-03 07:22:07 +0000416
Chris Lattner2adfa7e2006-01-04 07:12:21 +0000417 // In our final twist, we have to decide which instruction kills the
Jakob Stoklund Olesen9e51b142012-07-04 19:52:05 +0000418 // register. In most cases this is the copy, however, terminator
419 // instructions at the end of the block may also use the value. In this
420 // case, we should mark the last such terminator as being the killing
421 // block, not the copy.
422 MachineBasicBlock::iterator KillInst = opBlock.end();
423 MachineBasicBlock::iterator FirstTerm = opBlock.getFirstTerminator();
424 for (MachineBasicBlock::iterator Term = FirstTerm;
425 Term != opBlock.end(); ++Term) {
426 if (Term->readsRegister(SrcReg))
427 KillInst = Term;
428 }
Jakob Stoklund Olesene35e3c32009-11-10 22:00:56 +0000429
Jakob Stoklund Olesen9e51b142012-07-04 19:52:05 +0000430 if (KillInst == opBlock.end()) {
431 // No terminator uses the register.
432
433 if (reusedIncoming || !IncomingReg) {
434 // We may have to rewind a bit if we didn't insert a copy this time.
435 KillInst = FirstTerm;
436 while (KillInst != opBlock.begin()) {
437 --KillInst;
438 if (KillInst->isDebugValue())
439 continue;
440 if (KillInst->readsRegister(SrcReg))
441 break;
442 }
443 } else {
444 // We just inserted this copy.
445 KillInst = prior(InsertPos);
Chris Lattner2adfa7e2006-01-04 07:12:21 +0000446 }
Chris Lattner2adfa7e2006-01-04 07:12:21 +0000447 }
Jakob Stoklund Olesen74215fc2009-12-16 18:55:53 +0000448 assert(KillInst->readsRegister(SrcReg) && "Cannot find kill instruction");
Jakob Stoklund Olesene35e3c32009-11-10 22:00:56 +0000449
Chris Lattner2adfa7e2006-01-04 07:12:21 +0000450 // Finally, mark it killed.
451 LV->addVirtualRegisterKilled(SrcReg, KillInst);
Chris Lattner6db07562005-10-03 07:22:07 +0000452
453 // This vreg no longer lives all of the way through opBlock.
454 unsigned opBlockNum = opBlock.getNumber();
Jakob Stoklund Olesene35e3c32009-11-10 22:00:56 +0000455 LV->getVarInfo(SrcReg).AliveBlocks.reset(opBlockNum);
Chris Lattnerbc40e892003-01-13 20:01:16 +0000456 }
Cameron Zwarichb7cfac32013-02-10 06:42:36 +0000457
458 if (LIS) {
459 if (NewSrcInstr) {
460 LIS->InsertMachineInstrInMaps(NewSrcInstr);
461 LIS->addLiveRangeToEndOfBlock(IncomingReg, NewSrcInstr);
462 }
463
464 if (!SrcUndef &&
465 !VRegPHIUseCount[BBVRegPair(opBlock.getNumber(), SrcReg)]) {
466 LiveInterval &SrcLI = LIS->getInterval(SrcReg);
467
468 bool isLiveOut = false;
469 for (MachineBasicBlock::succ_iterator SI = opBlock.succ_begin(),
470 SE = opBlock.succ_end(); SI != SE; ++SI) {
Cameron Zwarich4930e722013-02-12 05:48:58 +0000471 SlotIndex startIdx = LIS->getMBBStartIdx(*SI);
472 VNInfo *VNI = SrcLI.getVNInfoAt(startIdx);
473
474 // Definitions by other PHIs are not truly live-in for our purposes.
475 if (VNI && VNI->def != startIdx) {
Cameron Zwarichb7cfac32013-02-10 06:42:36 +0000476 isLiveOut = true;
477 break;
478 }
479 }
480
481 if (!isLiveOut) {
482 MachineBasicBlock::iterator KillInst = opBlock.end();
483 MachineBasicBlock::iterator FirstTerm = opBlock.getFirstTerminator();
484 for (MachineBasicBlock::iterator Term = FirstTerm;
485 Term != opBlock.end(); ++Term) {
486 if (Term->readsRegister(SrcReg))
487 KillInst = Term;
488 }
489
490 if (KillInst == opBlock.end()) {
491 // No terminator uses the register.
492
493 if (reusedIncoming || !IncomingReg) {
494 // We may have to rewind a bit if we didn't just insert a copy.
495 KillInst = FirstTerm;
496 while (KillInst != opBlock.begin()) {
497 --KillInst;
498 if (KillInst->isDebugValue())
499 continue;
500 if (KillInst->readsRegister(SrcReg))
501 break;
502 }
503 } else {
504 // We just inserted this copy.
505 KillInst = prior(InsertPos);
506 }
507 }
508 assert(KillInst->readsRegister(SrcReg) &&
509 "Cannot find kill instruction");
510
511 SlotIndex LastUseIndex = LIS->getInstructionIndex(KillInst);
512 SrcLI.removeRange(LastUseIndex.getRegSlot(),
513 LIS->getMBBEndIdx(&opBlock));
514 }
515 }
516 }
Chris Lattnerbc40e892003-01-13 20:01:16 +0000517 }
Jakob Stoklund Olesene35e3c32009-11-10 22:00:56 +0000518
Jakob Stoklund Olesen74215fc2009-12-16 18:55:53 +0000519 // Really delete the PHI instruction now, if it is not in the LoweredPHIs map.
Cameron Zwarichb7cfac32013-02-10 06:42:36 +0000520 if (reusedIncoming || !IncomingReg) {
521 if (LIS)
522 LIS->RemoveMachineInstrFromMaps(MPhi);
Jakob Stoklund Olesen74215fc2009-12-16 18:55:53 +0000523 MF.DeleteMachineInstr(MPhi);
Cameron Zwarichb7cfac32013-02-10 06:42:36 +0000524 }
Chris Lattnerbc40e892003-01-13 20:01:16 +0000525}
Bill Wendlingca756d22006-09-28 07:10:24 +0000526
527/// analyzePHINodes - Gather information about the PHI nodes in here. In
528/// particular, we want to map the number of uses of a virtual register which is
529/// used in a PHI node. We map that to the BB the vreg is coming from. This is
530/// used later to determine when the vreg is killed in the BB.
531///
Cameron Zwarich0a3fdd62010-12-05 21:39:42 +0000532void PHIElimination::analyzePHINodes(const MachineFunction& MF) {
Evan Cheng28428cd2010-05-04 17:12:26 +0000533 for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
Bill Wendlingca756d22006-09-28 07:10:24 +0000534 I != E; ++I)
535 for (MachineBasicBlock::const_iterator BBI = I->begin(), BBE = I->end();
Chris Lattner518bb532010-02-09 19:54:29 +0000536 BBI != BBE && BBI->isPHI(); ++BBI)
Bill Wendlingca756d22006-09-28 07:10:24 +0000537 for (unsigned i = 1, e = BBI->getNumOperands(); i != e; i += 2)
Jakob Stoklund Olesen74215fc2009-12-16 18:55:53 +0000538 ++VRegPHIUseCount[BBVRegPair(BBI->getOperand(i+1).getMBB()->getNumber(),
Chris Lattner8aa797a2007-12-30 23:10:15 +0000539 BBI->getOperand(i).getReg())];
Bill Wendlingca756d22006-09-28 07:10:24 +0000540}
Jakob Stoklund Olesene35e3c32009-11-10 22:00:56 +0000541
Cameron Zwarich0a3fdd62010-12-05 21:39:42 +0000542bool PHIElimination::SplitPHIEdges(MachineFunction &MF,
Cameron Zwarich61a73342011-02-17 06:13:46 +0000543 MachineBasicBlock &MBB,
Cameron Zwarich61a73342011-02-17 06:13:46 +0000544 MachineLoopInfo *MLI) {
Chris Lattner518bb532010-02-09 19:54:29 +0000545 if (MBB.empty() || !MBB.front().isPHI() || MBB.isLandingPad())
Jakob Stoklund Olesen3e204752009-11-11 19:31:31 +0000546 return false; // Quick exit for basic blocks without PHIs.
Jakob Stoklund Olesen0257dd32009-11-18 18:01:35 +0000547
Jakob Stoklund Olesenc321a202012-07-20 20:49:53 +0000548 const MachineLoop *CurLoop = MLI ? MLI->getLoopFor(&MBB) : 0;
549 bool IsLoopHeader = CurLoop && &MBB == CurLoop->getHeader();
550
Evan Cheng97b9b972010-08-17 01:20:36 +0000551 bool Changed = false;
Evan Cheng7c2a4a32011-12-06 22:12:01 +0000552 for (MachineBasicBlock::iterator BBI = MBB.begin(), BBE = MBB.end();
Chris Lattner518bb532010-02-09 19:54:29 +0000553 BBI != BBE && BBI->isPHI(); ++BBI) {
Jakob Stoklund Olesenf235f132009-11-10 22:01:05 +0000554 for (unsigned i = 1, e = BBI->getNumOperands(); i != e; i += 2) {
555 unsigned Reg = BBI->getOperand(i).getReg();
556 MachineBasicBlock *PreMBB = BBI->getOperand(i+1).getMBB();
Jakob Stoklund Olesenc321a202012-07-20 20:49:53 +0000557 // Is there a critical edge from PreMBB to MBB?
558 if (PreMBB->succ_size() == 1)
559 continue;
560
Evan Chenge0083842010-08-17 17:43:50 +0000561 // Avoid splitting backedges of loops. It would introduce small
562 // out-of-line blocks into the loop which is very bad for code placement.
Cameron Zwarich5758a712013-02-12 03:49:25 +0000563 if (PreMBB == &MBB && !SplitAllCriticalEdges)
Jakob Stoklund Olesenc321a202012-07-20 20:49:53 +0000564 continue;
565 const MachineLoop *PreLoop = MLI ? MLI->getLoopFor(PreMBB) : 0;
Cameron Zwarich5758a712013-02-12 03:49:25 +0000566 if (IsLoopHeader && PreLoop == CurLoop && !SplitAllCriticalEdges)
Jakob Stoklund Olesenc321a202012-07-20 20:49:53 +0000567 continue;
568
569 // LV doesn't consider a phi use live-out, so isLiveOut only returns true
570 // when the source register is live-out for some other reason than a phi
571 // use. That means the copy we will insert in PreMBB won't be a kill, and
572 // there is a risk it may not be coalesced away.
573 //
574 // If the copy would be a kill, there is no need to split the edge.
Cameron Zwarich5758a712013-02-12 03:49:25 +0000575 if (!isLiveOutPastPHIs(Reg, PreMBB) && !SplitAllCriticalEdges)
Jakob Stoklund Olesenc321a202012-07-20 20:49:53 +0000576 continue;
577
578 DEBUG(dbgs() << PrintReg(Reg) << " live-out before critical edge BB#"
579 << PreMBB->getNumber() << " -> BB#" << MBB.getNumber()
580 << ": " << *BBI);
581
582 // If Reg is not live-in to MBB, it means it must be live-in to some
583 // other PreMBB successor, and we can avoid the interference by splitting
584 // the edge.
585 //
586 // If Reg *is* live-in to MBB, the interference is inevitable and a copy
587 // is likely to be left after coalescing. If we are looking at a loop
588 // exiting edge, split it so we won't insert code in the loop, otherwise
589 // don't bother.
Cameron Zwarich5758a712013-02-12 03:49:25 +0000590 bool ShouldSplit = !isLiveIn(Reg, &MBB) || SplitAllCriticalEdges;
Jakob Stoklund Olesenc321a202012-07-20 20:49:53 +0000591
592 // Check for a loop exiting edge.
593 if (!ShouldSplit && CurLoop != PreLoop) {
594 DEBUG({
595 dbgs() << "Split wouldn't help, maybe avoid loop copies?\n";
596 if (PreLoop) dbgs() << "PreLoop: " << *PreLoop;
597 if (CurLoop) dbgs() << "CurLoop: " << *CurLoop;
598 });
599 // This edge could be entering a loop, exiting a loop, or it could be
600 // both: Jumping directly form one loop to the header of a sibling
601 // loop.
602 // Split unless this edge is entering CurLoop from an outer loop.
603 ShouldSplit = PreLoop && !PreLoop->contains(CurLoop);
Evan Chenge0083842010-08-17 17:43:50 +0000604 }
Jakob Stoklund Olesenc321a202012-07-20 20:49:53 +0000605 if (!ShouldSplit)
606 continue;
607 if (!PreMBB->SplitCriticalEdge(&MBB, this)) {
608 DEBUG(dbgs() << "Failed to split ciritcal edge.\n");
609 continue;
610 }
611 Changed = true;
612 ++NumCriticalEdgesSplit;
Jakob Stoklund Olesenf235f132009-11-10 22:01:05 +0000613 }
614 }
Cameron Zwarich688521c2011-02-17 06:13:43 +0000615 return Changed;
Jakob Stoklund Olesenf235f132009-11-10 22:01:05 +0000616}
Cameron Zwarich36f54482013-02-10 23:29:49 +0000617
618bool PHIElimination::isLiveIn(unsigned Reg, MachineBasicBlock *MBB) {
619 assert((LV || LIS) &&
620 "isLiveIn() requires either LiveVariables or LiveIntervals");
621 if (LIS)
622 return LIS->isLiveInToMBB(LIS->getInterval(Reg), MBB);
623 else
624 return LV->isLiveIn(Reg, *MBB);
625}
626
627bool PHIElimination::isLiveOutPastPHIs(unsigned Reg, MachineBasicBlock *MBB) {
628 assert((LV || LIS) &&
629 "isLiveOutPastPHIs() requires either LiveVariables or LiveIntervals");
630 // LiveVariables considers uses in PHIs to be in the predecessor basic block,
631 // so that a register used only in a PHI is not live out of the block. In
632 // contrast, LiveIntervals considers uses in PHIs to be on the edge rather than
633 // in the predecessor basic block, so that a register used only in a PHI is live
634 // out of the block.
635 if (LIS) {
636 const LiveInterval &LI = LIS->getInterval(Reg);
637 for (MachineBasicBlock::succ_iterator SI = MBB->succ_begin(),
638 SE = MBB->succ_end(); SI != SE; ++SI) {
639 if (LI.liveAt(LIS->getMBBStartIdx(*SI)))
640 return true;
641 }
642 return false;
643 } else {
644 return LV->isLiveOut(Reg, *MBB);
645 }
646}