blob: 139e0291ea7a845dce2e5339e57eb1c4326e3834 [file] [log] [blame]
Chris Lattnercab0b442003-01-13 20:01:16 +00001//===-- LiveVariables.cpp - Live Variable Analysis for Machine Code -------===//
Misha Brukman835702a2005-04-21 22:36:52 +00002//
John Criswell482202a2003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattnerf3ebc3f2007-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 Brukman835702a2005-04-21 22:36:52 +00007//
John Criswell482202a2003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Misha Brukman835702a2005-04-21 22:36:52 +00009//
Chris Lattner5ab42e52003-05-07 20:08:36 +000010// This file implements the LiveVariable analysis pass. For each machine
11// instruction in the function, this pass calculates the set of registers that
12// are immediately dead after the instruction (i.e., the instruction calculates
13// the value, but it is never used) and the set of registers that are used by
14// the instruction, but are never used after the instruction (i.e., they are
15// killed).
16//
17// This class computes live variables using are sparse implementation based on
18// the machine code SSA form. This class computes live variable information for
19// each virtual and _register allocatable_ physical register in a function. It
20// uses the dominance properties of SSA form to efficiently compute live
21// variables for virtual registers, and assumes that physical registers are only
22// live within a single basic block (allowing it to do a single local analysis
23// to resolve physical register lifetimes in each basic block). If a physical
24// register is not register allocatable, it is not tracked. This is useful for
25// things like the stack pointer and condition codes.
26//
Chris Lattnercab0b442003-01-13 20:01:16 +000027//===----------------------------------------------------------------------===//
28
29#include "llvm/CodeGen/LiveVariables.h"
30#include "llvm/CodeGen/MachineInstr.h"
Chris Lattnera10fff52007-12-31 04:13:23 +000031#include "llvm/CodeGen/MachineRegisterInfo.h"
Owen Andersona1022902008-08-04 23:54:43 +000032#include "llvm/CodeGen/Passes.h"
Dan Gohman3a4be0f2008-02-10 18:45:23 +000033#include "llvm/Target/TargetRegisterInfo.h"
Chris Lattnerb4d58d72003-01-14 22:00:31 +000034#include "llvm/Target/TargetInstrInfo.h"
Chris Lattnercab0b442003-01-13 20:01:16 +000035#include "llvm/Target/TargetMachine.h"
Reid Spencer7c16caa2004-09-01 22:55:40 +000036#include "llvm/ADT/DepthFirstIterator.h"
Evan Chenge66f8222007-06-27 05:23:00 +000037#include "llvm/ADT/SmallPtrSet.h"
Owen Anderson413f7d92008-06-27 07:05:59 +000038#include "llvm/ADT/SmallSet.h"
Reid Spencer7c16caa2004-09-01 22:55:40 +000039#include "llvm/ADT/STLExtras.h"
Chris Lattnereeacce52005-08-24 00:09:33 +000040#include <algorithm>
Chris Lattner07708622004-01-30 22:08:53 +000041using namespace llvm;
Brian Gaeke960707c2003-11-11 22:41:34 +000042
Devang Patel8c78a0b2007-05-03 01:11:54 +000043char LiveVariables::ID = 0;
Chris Lattner3c9b2422006-08-27 22:30:17 +000044static RegisterPass<LiveVariables> X("livevars", "Live Variable Analysis");
Chris Lattnercab0b442003-01-13 20:01:16 +000045
Owen Andersona1022902008-08-04 23:54:43 +000046
47void LiveVariables::getAnalysisUsage(AnalysisUsage &AU) const {
48 AU.addRequiredID(UnreachableMachineBlockElimID);
49 AU.setPreservesAll();
Dan Gohman5ea74d52009-07-31 18:16:33 +000050 MachineFunctionPass::getAnalysisUsage(AU);
Owen Andersona1022902008-08-04 23:54:43 +000051}
52
Chris Lattnerbe45b5e2006-01-04 05:40:30 +000053void LiveVariables::VarInfo::dump() const {
Chris Lattnera6f074f2009-08-23 03:41:05 +000054 errs() << " Alive in blocks: ";
Jeffrey Yasskin7d287cb2009-05-26 18:27:15 +000055 for (SparseBitVector<>::iterator I = AliveBlocks.begin(),
56 E = AliveBlocks.end(); I != E; ++I)
Chris Lattnera6f074f2009-08-23 03:41:05 +000057 errs() << *I << ", ";
58 errs() << "\n Killed by:";
Chris Lattnerbe45b5e2006-01-04 05:40:30 +000059 if (Kills.empty())
Chris Lattnera6f074f2009-08-23 03:41:05 +000060 errs() << " No instructions.\n";
Chris Lattnerbe45b5e2006-01-04 05:40:30 +000061 else {
62 for (unsigned i = 0, e = Kills.size(); i != e; ++i)
Chris Lattnera6f074f2009-08-23 03:41:05 +000063 errs() << "\n #" << i << ": " << *Kills[i];
64 errs() << "\n";
Chris Lattnerbe45b5e2006-01-04 05:40:30 +000065 }
66}
67
Bill Wendling59cc1592008-02-20 06:10:21 +000068/// getVarInfo - Get (possibly creating) a VarInfo object for the given vreg.
Chris Lattner584bae42003-05-12 14:24:00 +000069LiveVariables::VarInfo &LiveVariables::getVarInfo(unsigned RegIdx) {
Dan Gohman3a4be0f2008-02-10 18:45:23 +000070 assert(TargetRegisterInfo::isVirtualRegister(RegIdx) &&
Chris Lattner584bae42003-05-12 14:24:00 +000071 "getVarInfo: not a virtual register!");
Dan Gohman3a4be0f2008-02-10 18:45:23 +000072 RegIdx -= TargetRegisterInfo::FirstVirtualRegister;
Chris Lattner584bae42003-05-12 14:24:00 +000073 if (RegIdx >= VirtRegInfo.size()) {
74 if (RegIdx >= 2*VirtRegInfo.size())
75 VirtRegInfo.resize(RegIdx*2);
76 else
77 VirtRegInfo.resize(2*VirtRegInfo.size());
78 }
Jeffrey Yasskin7d287cb2009-05-26 18:27:15 +000079 return VirtRegInfo[RegIdx];
Chris Lattner584bae42003-05-12 14:24:00 +000080}
81
Owen Anderson897aed92008-01-15 22:58:11 +000082void LiveVariables::MarkVirtRegAliveInBlock(VarInfo& VRInfo,
83 MachineBasicBlock *DefBlock,
Evan Cheng9e178722007-05-08 19:00:00 +000084 MachineBasicBlock *MBB,
85 std::vector<MachineBasicBlock*> &WorkList) {
Chris Lattner6c375e42004-07-01 04:29:47 +000086 unsigned BBNum = MBB->getNumber();
Owen Anderson1ba66e02008-01-15 22:02:46 +000087
Chris Lattnercab0b442003-01-13 20:01:16 +000088 // Check to see if this basic block is one of the killing blocks. If so,
Bill Wendling59cc1592008-02-20 06:10:21 +000089 // remove it.
Chris Lattnercab0b442003-01-13 20:01:16 +000090 for (unsigned i = 0, e = VRInfo.Kills.size(); i != e; ++i)
Chris Lattneraef6c2a2004-07-19 07:04:55 +000091 if (VRInfo.Kills[i]->getParent() == MBB) {
Chris Lattnercab0b442003-01-13 20:01:16 +000092 VRInfo.Kills.erase(VRInfo.Kills.begin()+i); // Erase entry
93 break;
94 }
Owen Anderson1ba66e02008-01-15 22:02:46 +000095
Owen Anderson897aed92008-01-15 22:58:11 +000096 if (MBB == DefBlock) return; // Terminate recursion
Chris Lattnercab0b442003-01-13 20:01:16 +000097
Jeffrey Yasskin7d287cb2009-05-26 18:27:15 +000098 if (VRInfo.AliveBlocks.test(BBNum))
Chris Lattnercab0b442003-01-13 20:01:16 +000099 return; // We already know the block is live
100
101 // Mark the variable known alive in this bb
Jeffrey Yasskin7d287cb2009-05-26 18:27:15 +0000102 VRInfo.AliveBlocks.set(BBNum);
Chris Lattnercab0b442003-01-13 20:01:16 +0000103
Evan Cheng9e178722007-05-08 19:00:00 +0000104 for (MachineBasicBlock::const_pred_reverse_iterator PI = MBB->pred_rbegin(),
105 E = MBB->pred_rend(); PI != E; ++PI)
106 WorkList.push_back(*PI);
Chris Lattnercab0b442003-01-13 20:01:16 +0000107}
108
Bill Wendling406fdbd2008-02-20 07:36:31 +0000109void LiveVariables::MarkVirtRegAliveInBlock(VarInfo &VRInfo,
Owen Anderson897aed92008-01-15 22:58:11 +0000110 MachineBasicBlock *DefBlock,
Evan Cheng9e178722007-05-08 19:00:00 +0000111 MachineBasicBlock *MBB) {
112 std::vector<MachineBasicBlock*> WorkList;
Owen Anderson897aed92008-01-15 22:58:11 +0000113 MarkVirtRegAliveInBlock(VRInfo, DefBlock, MBB, WorkList);
Bill Wendling406fdbd2008-02-20 07:36:31 +0000114
Evan Cheng9e178722007-05-08 19:00:00 +0000115 while (!WorkList.empty()) {
116 MachineBasicBlock *Pred = WorkList.back();
117 WorkList.pop_back();
Owen Anderson897aed92008-01-15 22:58:11 +0000118 MarkVirtRegAliveInBlock(VRInfo, DefBlock, Pred, WorkList);
Evan Cheng9e178722007-05-08 19:00:00 +0000119 }
120}
121
Owen Anderson1ba66e02008-01-15 22:02:46 +0000122void LiveVariables::HandleVirtRegUse(unsigned reg, MachineBasicBlock *MBB,
Misha Brukman7d11fbf2004-06-24 21:31:16 +0000123 MachineInstr *MI) {
Evan Chengd8616062008-04-02 18:04:08 +0000124 assert(MRI->getVRegDef(reg) && "Register use before def!");
Alkis Evlogimenos6a099d42004-09-01 22:34:52 +0000125
Owen Anderson9d86ef12007-11-08 01:20:48 +0000126 unsigned BBNum = MBB->getNumber();
127
Owen Anderson1ba66e02008-01-15 22:02:46 +0000128 VarInfo& VRInfo = getVarInfo(reg);
Evan Cheng8387cf12007-04-17 20:22:11 +0000129 VRInfo.NumUses++;
Evan Chengf6f04332007-03-17 09:29:54 +0000130
Bill Wendling59cc1592008-02-20 06:10:21 +0000131 // Check to see if this basic block is already a kill block.
Chris Lattneraef6c2a2004-07-19 07:04:55 +0000132 if (!VRInfo.Kills.empty() && VRInfo.Kills.back()->getParent() == MBB) {
Bill Wendling59cc1592008-02-20 06:10:21 +0000133 // Yes, this register is killed in this basic block already. Increase the
Chris Lattnercab0b442003-01-13 20:01:16 +0000134 // live range by updating the kill instruction.
Chris Lattneraef6c2a2004-07-19 07:04:55 +0000135 VRInfo.Kills.back() = MI;
Chris Lattnercab0b442003-01-13 20:01:16 +0000136 return;
137 }
138
139#ifndef NDEBUG
140 for (unsigned i = 0, e = VRInfo.Kills.size(); i != e; ++i)
Chris Lattneraef6c2a2004-07-19 07:04:55 +0000141 assert(VRInfo.Kills[i]->getParent() != MBB && "entry should be at end!");
Chris Lattnercab0b442003-01-13 20:01:16 +0000142#endif
143
Bill Wendlingc44659b2008-06-23 23:41:14 +0000144 // This situation can occur:
145 //
146 // ,------.
147 // | |
148 // | v
149 // | t2 = phi ... t1 ...
150 // | |
151 // | v
152 // | t1 = ...
153 // | ... = ... t1 ...
154 // | |
155 // `------'
156 //
157 // where there is a use in a PHI node that's a predecessor to the defining
158 // block. We don't want to mark all predecessors as having the value "alive"
159 // in this case.
160 if (MBB == MRI->getVRegDef(reg)->getParent()) return;
Chris Lattnercab0b442003-01-13 20:01:16 +0000161
Bill Wendling59cc1592008-02-20 06:10:21 +0000162 // Add a new kill entry for this basic block. If this virtual register is
163 // already marked as alive in this basic block, that means it is alive in at
164 // least one of the successor blocks, it's not a kill.
Jeffrey Yasskin7d287cb2009-05-26 18:27:15 +0000165 if (!VRInfo.AliveBlocks.test(BBNum))
Evan Chengdf7949a2007-03-09 09:48:56 +0000166 VRInfo.Kills.push_back(MI);
Chris Lattnercab0b442003-01-13 20:01:16 +0000167
Bill Wendling406fdbd2008-02-20 07:36:31 +0000168 // Update all dominating blocks to mark them as "known live".
Chris Lattnerc49a9a52004-05-01 21:24:24 +0000169 for (MachineBasicBlock::const_pred_iterator PI = MBB->pred_begin(),
170 E = MBB->pred_end(); PI != E; ++PI)
Evan Chengd8616062008-04-02 18:04:08 +0000171 MarkVirtRegAliveInBlock(VRInfo, MRI->getVRegDef(reg)->getParent(), *PI);
Chris Lattnercab0b442003-01-13 20:01:16 +0000172}
173
Dan Gohmanae9d9f42008-09-21 21:11:41 +0000174void LiveVariables::HandleVirtRegDef(unsigned Reg, MachineInstr *MI) {
175 VarInfo &VRInfo = getVarInfo(Reg);
176
Jeffrey Yasskin7d287cb2009-05-26 18:27:15 +0000177 if (VRInfo.AliveBlocks.empty())
Dan Gohmanae9d9f42008-09-21 21:11:41 +0000178 // If vr is not alive in any block, then defaults to dead.
179 VRInfo.Kills.push_back(MI);
180}
181
Evan Chenge45b8f82008-04-16 09:46:40 +0000182/// FindLastPartialDef - Return the last partial def of the specified register.
Evan Cheng08d1e412009-09-22 08:34:46 +0000183/// Also returns the sub-registers that're defined by the instruction.
Evan Chenge45b8f82008-04-16 09:46:40 +0000184MachineInstr *LiveVariables::FindLastPartialDef(unsigned Reg,
Evan Cheng08d1e412009-09-22 08:34:46 +0000185 SmallSet<unsigned,4> &PartDefRegs) {
Evan Chenge45b8f82008-04-16 09:46:40 +0000186 unsigned LastDefReg = 0;
187 unsigned LastDefDist = 0;
188 MachineInstr *LastDef = NULL;
189 for (const unsigned *SubRegs = TRI->getSubRegisters(Reg);
190 unsigned SubReg = *SubRegs; ++SubRegs) {
191 MachineInstr *Def = PhysRegDef[SubReg];
192 if (!Def)
193 continue;
194 unsigned Dist = DistanceMap[Def];
195 if (Dist > LastDefDist) {
196 LastDefReg = SubReg;
197 LastDef = Def;
198 LastDefDist = Dist;
199 }
200 }
Evan Cheng08d1e412009-09-22 08:34:46 +0000201
202 if (!LastDef)
203 return 0;
204
205 PartDefRegs.insert(LastDefReg);
206 for (unsigned i = 0, e = LastDef->getNumOperands(); i != e; ++i) {
207 MachineOperand &MO = LastDef->getOperand(i);
208 if (!MO.isReg() || !MO.isDef() || MO.getReg() == 0)
209 continue;
210 unsigned DefReg = MO.getReg();
211 if (TRI->isSubRegister(Reg, DefReg)) {
212 PartDefRegs.insert(DefReg);
213 for (const unsigned *SubRegs = TRI->getSubRegisters(DefReg);
214 unsigned SubReg = *SubRegs; ++SubRegs)
215 PartDefRegs.insert(SubReg);
216 }
217 }
Evan Chenge45b8f82008-04-16 09:46:40 +0000218 return LastDef;
219}
220
Bill Wendlingb9123512008-02-20 09:15:16 +0000221/// HandlePhysRegUse - Turn previous partial def's into read/mod/writes. Add
222/// implicit defs to a machine instruction if there was an earlier def of its
223/// super-register.
Chris Lattnercab0b442003-01-13 20:01:16 +0000224void LiveVariables::HandlePhysRegUse(unsigned Reg, MachineInstr *MI) {
Evan Chenge45b8f82008-04-16 09:46:40 +0000225 // If there was a previous use or a "full" def all is well.
226 if (!PhysRegDef[Reg] && !PhysRegUse[Reg]) {
227 // Otherwise, the last sub-register def implicitly defines this register.
228 // e.g.
229 // AH =
230 // AL = ... <imp-def EAX>, <imp-kill AH>
231 // = AH
232 // ...
233 // = EAX
234 // All of the sub-registers must have been defined before the use of Reg!
Evan Cheng08d1e412009-09-22 08:34:46 +0000235 SmallSet<unsigned, 4> PartDefRegs;
236 MachineInstr *LastPartialDef = FindLastPartialDef(Reg, PartDefRegs);
Evan Chenge45b8f82008-04-16 09:46:40 +0000237 // If LastPartialDef is NULL, it must be using a livein register.
238 if (LastPartialDef) {
239 LastPartialDef->addOperand(MachineOperand::CreateReg(Reg, true/*IsDef*/,
240 true/*IsImp*/));
241 PhysRegDef[Reg] = LastPartialDef;
Owen Anderson14738122008-08-14 23:41:38 +0000242 SmallSet<unsigned, 8> Processed;
Evan Chenge45b8f82008-04-16 09:46:40 +0000243 for (const unsigned *SubRegs = TRI->getSubRegisters(Reg);
244 unsigned SubReg = *SubRegs; ++SubRegs) {
245 if (Processed.count(SubReg))
246 continue;
Evan Cheng08d1e412009-09-22 08:34:46 +0000247 if (PartDefRegs.count(SubReg))
Evan Chenge45b8f82008-04-16 09:46:40 +0000248 continue;
249 // This part of Reg was defined before the last partial def. It's killed
250 // here.
251 LastPartialDef->addOperand(MachineOperand::CreateReg(SubReg,
252 false/*IsDef*/,
253 true/*IsImp*/));
254 PhysRegDef[SubReg] = LastPartialDef;
255 for (const unsigned *SS = TRI->getSubRegisters(SubReg); *SS; ++SS)
256 Processed.insert(*SS);
257 }
258 }
Evan Cheng7818c032007-04-25 07:30:23 +0000259 }
Bill Wendling59cc1592008-02-20 06:10:21 +0000260
Evan Chenge45b8f82008-04-16 09:46:40 +0000261 // Remember this use.
262 PhysRegUse[Reg] = MI;
Evan Cheng63254462008-03-05 00:59:57 +0000263 for (const unsigned *SubRegs = TRI->getSubRegisters(Reg);
Bill Wendling406fdbd2008-02-20 07:36:31 +0000264 unsigned SubReg = *SubRegs; ++SubRegs)
Evan Chenge45b8f82008-04-16 09:46:40 +0000265 PhysRegUse[SubReg] = MI;
Evan Chengd8417d92007-06-26 21:03:35 +0000266}
267
Evan Chengf1e873a2009-01-20 21:25:12 +0000268bool LiveVariables::HandlePhysRegKill(unsigned Reg, MachineInstr *MI) {
Evan Chenga21aac32009-09-24 02:15:22 +0000269 MachineInstr *LastDef = PhysRegDef[Reg];
270 MachineInstr *LastUse = PhysRegUse[Reg];
271 if (!LastDef && !LastUse)
Evan Chenge45b8f82008-04-16 09:46:40 +0000272 return false;
273
Evan Chenga21aac32009-09-24 02:15:22 +0000274 MachineInstr *LastRefOrPartRef = LastUse ? LastUse : LastDef;
Evan Chenge45b8f82008-04-16 09:46:40 +0000275 unsigned LastRefOrPartRefDist = DistanceMap[LastRefOrPartRef];
276 // The whole register is used.
277 // AL =
278 // AH =
279 //
280 // = AX
281 // = AL, AX<imp-use, kill>
282 // AX =
283 //
284 // Or whole register is defined, but not used at all.
285 // AX<dead> =
286 // ...
287 // AX =
288 //
289 // Or whole register is defined, but only partly used.
290 // AX<dead> = AL<imp-def>
291 // = AL<kill>
292 // AX =
Evan Chenga21aac32009-09-24 02:15:22 +0000293 MachineInstr *LastPartDef = 0;
294 unsigned LastPartDefDist = 0;
Owen Anderson14738122008-08-14 23:41:38 +0000295 SmallSet<unsigned, 8> PartUses;
Evan Chenge45b8f82008-04-16 09:46:40 +0000296 for (const unsigned *SubRegs = TRI->getSubRegisters(Reg);
297 unsigned SubReg = *SubRegs; ++SubRegs) {
Evan Chenga21aac32009-09-24 02:15:22 +0000298 MachineInstr *Def = PhysRegDef[SubReg];
299 if (Def && Def != LastDef) {
300 // There was a def of this sub-register in between. This is a partial
301 // def, keep track of the last one.
302 unsigned Dist = DistanceMap[Def];
303 if (Dist > LastPartDefDist) {
304 LastPartDefDist = Dist;
305 LastPartDef = Def;
306 }
307 continue;
308 }
Evan Chenge45b8f82008-04-16 09:46:40 +0000309 if (MachineInstr *Use = PhysRegUse[SubReg]) {
310 PartUses.insert(SubReg);
311 for (const unsigned *SS = TRI->getSubRegisters(SubReg); *SS; ++SS)
312 PartUses.insert(*SS);
313 unsigned Dist = DistanceMap[Use];
314 if (Dist > LastRefOrPartRefDist) {
315 LastRefOrPartRefDist = Dist;
316 LastRefOrPartRef = Use;
Evan Chengd8417d92007-06-26 21:03:35 +0000317 }
Evan Chenge45b8f82008-04-16 09:46:40 +0000318 }
319 }
Evan Chengf1e873a2009-01-20 21:25:12 +0000320
Evan Chenga21aac32009-09-24 02:15:22 +0000321 if (LastRefOrPartRef == PhysRegDef[Reg] && LastRefOrPartRef != MI) {
322 if (LastPartDef)
323 // The last partial def kills the register.
324 LastPartDef->addOperand(MachineOperand::CreateReg(Reg, false/*IsDef*/,
325 true/*IsImp*/, true/*IsKill*/));
326 else
327 // If the last reference is the last def, then it's not used at all.
328 // That is, unless we are currently processing the last reference itself.
329 LastRefOrPartRef->addRegisterDead(Reg, TRI, true);
330 } else if (!PhysRegUse[Reg]) {
331 // Partial uses. Mark register def dead and add implicit def of
332 // sub-registers which are used.
333 // EAX<dead> = op AL<imp-def>
334 // That is, EAX def is dead but AL def extends pass it.
Evan Chenge45b8f82008-04-16 09:46:40 +0000335 PhysRegDef[Reg]->addRegisterDead(Reg, TRI, true);
336 for (const unsigned *SubRegs = TRI->getSubRegisters(Reg);
337 unsigned SubReg = *SubRegs; ++SubRegs) {
Evan Chenga21aac32009-09-24 02:15:22 +0000338 if (!PartUses.count(SubReg))
339 continue;
340 bool NeedDef = true;
341 if (PhysRegDef[Reg] == PhysRegDef[SubReg]) {
342 MachineOperand *MO = PhysRegDef[Reg]->findRegisterDefOperand(SubReg);
343 if (MO) {
344 NeedDef = false;
345 assert(!MO->isDead());
Evan Chengba2410b2009-07-06 21:34:05 +0000346 }
Evan Chenge45b8f82008-04-16 09:46:40 +0000347 }
Evan Chenga21aac32009-09-24 02:15:22 +0000348 if (NeedDef)
349 PhysRegDef[Reg]->addOperand(MachineOperand::CreateReg(SubReg,
350 true/*IsDef*/, true/*IsImp*/));
351 LastRefOrPartRef->addRegisterKilled(SubReg, TRI, true);
352 for (const unsigned *SS = TRI->getSubRegisters(SubReg); *SS; ++SS)
353 PartUses.erase(*SS);
Evan Chenge45b8f82008-04-16 09:46:40 +0000354 }
Evan Chenga21aac32009-09-24 02:15:22 +0000355 } else
Evan Chenge45b8f82008-04-16 09:46:40 +0000356 LastRefOrPartRef->addRegisterKilled(Reg, TRI, true);
357 return true;
358}
359
Evan Cheng262f86e2009-09-23 06:28:31 +0000360void LiveVariables::HandlePhysRegDef(unsigned Reg, MachineInstr *MI,
Evan Chenga21aac32009-09-24 02:15:22 +0000361 SmallVector<unsigned, 4> &Defs) {
Evan Chenge45b8f82008-04-16 09:46:40 +0000362 // What parts of the register are previously defined?
Owen Anderson413f7d92008-06-27 07:05:59 +0000363 SmallSet<unsigned, 32> Live;
Evan Chenge45b8f82008-04-16 09:46:40 +0000364 if (PhysRegDef[Reg] || PhysRegUse[Reg]) {
365 Live.insert(Reg);
366 for (const unsigned *SS = TRI->getSubRegisters(Reg); *SS; ++SS)
367 Live.insert(*SS);
368 } else {
369 for (const unsigned *SubRegs = TRI->getSubRegisters(Reg);
370 unsigned SubReg = *SubRegs; ++SubRegs) {
371 // If a register isn't itself defined, but all parts that make up of it
372 // are defined, then consider it also defined.
373 // e.g.
374 // AL =
375 // AH =
376 // = AX
Evan Chenga21aac32009-09-24 02:15:22 +0000377 if (Live.count(SubReg))
378 continue;
Evan Chenge45b8f82008-04-16 09:46:40 +0000379 if (PhysRegDef[SubReg] || PhysRegUse[SubReg]) {
380 Live.insert(SubReg);
381 for (const unsigned *SS = TRI->getSubRegisters(SubReg); *SS; ++SS)
382 Live.insert(*SS);
383 }
Bill Wendling406fdbd2008-02-20 07:36:31 +0000384 }
Chris Lattnercab0b442003-01-13 20:01:16 +0000385 }
Alkis Evlogimenosebbd66c2004-01-13 06:24:30 +0000386
Evan Chenge45b8f82008-04-16 09:46:40 +0000387 // Start from the largest piece, find the last time any part of the register
388 // is referenced.
Evan Chenga21aac32009-09-24 02:15:22 +0000389 HandlePhysRegKill(Reg, MI);
390 // Only some of the sub-registers are used.
391 for (const unsigned *SubRegs = TRI->getSubRegisters(Reg);
392 unsigned SubReg = *SubRegs; ++SubRegs) {
393 if (!Live.count(SubReg))
394 // Skip if this sub-register isn't defined.
395 continue;
396 HandlePhysRegKill(SubReg, MI);
Evan Cheng7818c032007-04-25 07:30:23 +0000397 }
398
Evan Chenga21aac32009-09-24 02:15:22 +0000399 if (MI)
400 Defs.push_back(Reg); // Remember this def.
Evan Cheng262f86e2009-09-23 06:28:31 +0000401}
402
403void LiveVariables::UpdatePhysRegDefs(MachineInstr *MI,
404 SmallVector<unsigned, 4> &Defs) {
405 while (!Defs.empty()) {
406 unsigned Reg = Defs.back();
407 Defs.pop_back();
Evan Chenge45b8f82008-04-16 09:46:40 +0000408 PhysRegDef[Reg] = MI;
409 PhysRegUse[Reg] = NULL;
Evan Cheng63254462008-03-05 00:59:57 +0000410 for (const unsigned *SubRegs = TRI->getSubRegisters(Reg);
Evan Chengd8417d92007-06-26 21:03:35 +0000411 unsigned SubReg = *SubRegs; ++SubRegs) {
Evan Chenge45b8f82008-04-16 09:46:40 +0000412 PhysRegDef[SubReg] = MI;
413 PhysRegUse[SubReg] = NULL;
Evan Chengd8417d92007-06-26 21:03:35 +0000414 }
Alkis Evlogimenosebbd66c2004-01-13 06:24:30 +0000415 }
Chris Lattnercab0b442003-01-13 20:01:16 +0000416}
417
Evan Cheng262f86e2009-09-23 06:28:31 +0000418namespace {
419 struct RegSorter {
420 const TargetRegisterInfo *TRI;
421
422 RegSorter(const TargetRegisterInfo *tri) : TRI(tri) { }
423 bool operator()(unsigned A, unsigned B) {
424 if (TRI->isSubRegister(A, B))
425 return true;
426 else if (TRI->isSubRegister(B, A))
427 return false;
428 return A < B;
429 }
430 };
431}
432
Evan Chengf6f04332007-03-17 09:29:54 +0000433bool LiveVariables::runOnMachineFunction(MachineFunction &mf) {
434 MF = &mf;
Evan Chengd8616062008-04-02 18:04:08 +0000435 MRI = &mf.getRegInfo();
Evan Cheng63254462008-03-05 00:59:57 +0000436 TRI = MF->getTarget().getRegisterInfo();
Chris Lattner26407382004-02-09 01:35:21 +0000437
Evan Cheng63254462008-03-05 00:59:57 +0000438 ReservedRegisters = TRI->getReservedRegs(mf);
Chris Lattner5ab42e52003-05-07 20:08:36 +0000439
Evan Cheng63254462008-03-05 00:59:57 +0000440 unsigned NumRegs = TRI->getNumRegs();
Evan Chenge45b8f82008-04-16 09:46:40 +0000441 PhysRegDef = new MachineInstr*[NumRegs];
442 PhysRegUse = new MachineInstr*[NumRegs];
Evan Cheng0fbe14a2007-04-25 19:34:00 +0000443 PHIVarInfo = new SmallVector<unsigned, 4>[MF->getNumBlockIDs()];
Evan Chenge45b8f82008-04-16 09:46:40 +0000444 std::fill(PhysRegDef, PhysRegDef + NumRegs, (MachineInstr*)0);
445 std::fill(PhysRegUse, PhysRegUse + NumRegs, (MachineInstr*)0);
Chris Lattnercab0b442003-01-13 20:01:16 +0000446
Bill Wendlingb9123512008-02-20 09:15:16 +0000447 /// Get some space for a respectable number of registers.
Chris Lattnercab0b442003-01-13 20:01:16 +0000448 VirtRegInfo.resize(64);
Chris Lattner4c6ab012005-04-09 15:23:25 +0000449
Evan Chengf6f04332007-03-17 09:29:54 +0000450 analyzePHINodes(mf);
Bill Wendling984f0ce2006-10-03 07:20:20 +0000451
Chris Lattnercab0b442003-01-13 20:01:16 +0000452 // Calculate live variable information in depth first order on the CFG of the
453 // function. This guarantees that we will see the definition of a virtual
454 // register before its uses due to dominance properties of SSA (except for PHI
455 // nodes, which are treated as a special case).
Evan Chengf6f04332007-03-17 09:29:54 +0000456 MachineBasicBlock *Entry = MF->begin();
Evan Chenge66f8222007-06-27 05:23:00 +0000457 SmallPtrSet<MachineBasicBlock*,16> Visited;
Bill Wendlingb9123512008-02-20 09:15:16 +0000458
Evan Chenge66f8222007-06-27 05:23:00 +0000459 for (df_ext_iterator<MachineBasicBlock*, SmallPtrSet<MachineBasicBlock*,16> >
460 DFI = df_ext_begin(Entry, Visited), E = df_ext_end(Entry, Visited);
461 DFI != E; ++DFI) {
Chris Lattnerc49a9a52004-05-01 21:24:24 +0000462 MachineBasicBlock *MBB = *DFI;
Chris Lattnercab0b442003-01-13 20:01:16 +0000463
Evan Chengf7ed82d2007-02-19 21:49:54 +0000464 // Mark live-in registers as live-in.
Evan Cheng262f86e2009-09-23 06:28:31 +0000465 SmallVector<unsigned, 4> Defs;
Evan Chengf7ed82d2007-02-19 21:49:54 +0000466 for (MachineBasicBlock::const_livein_iterator II = MBB->livein_begin(),
Evan Chengb612316f2007-02-13 01:30:55 +0000467 EE = MBB->livein_end(); II != EE; ++II) {
Dan Gohman3a4be0f2008-02-10 18:45:23 +0000468 assert(TargetRegisterInfo::isPhysicalRegister(*II) &&
Evan Chengb612316f2007-02-13 01:30:55 +0000469 "Cannot have a live-in virtual register!");
Evan Chenga21aac32009-09-24 02:15:22 +0000470 HandlePhysRegDef(*II, 0, Defs);
Evan Chengb612316f2007-02-13 01:30:55 +0000471 }
472
Chris Lattnercab0b442003-01-13 20:01:16 +0000473 // Loop over all of the instructions, processing them.
Evan Chengd8616062008-04-02 18:04:08 +0000474 DistanceMap.clear();
475 unsigned Dist = 0;
Chris Lattnercab0b442003-01-13 20:01:16 +0000476 for (MachineBasicBlock::iterator I = MBB->begin(), E = MBB->end();
Misha Brukman7d11fbf2004-06-24 21:31:16 +0000477 I != E; ++I) {
Alkis Evlogimenos80da8652004-02-12 02:27:10 +0000478 MachineInstr *MI = I;
Evan Chengd8616062008-04-02 18:04:08 +0000479 DistanceMap.insert(std::make_pair(MI, Dist++));
Chris Lattnercab0b442003-01-13 20:01:16 +0000480
481 // Process all of the operands of the instruction...
482 unsigned NumOperandsToProcess = MI->getNumOperands();
483
484 // Unless it is a PHI node. In this case, ONLY process the DEF, not any
485 // of the uses. They will be handled in other basic blocks.
Misha Brukman835702a2005-04-21 22:36:52 +0000486 if (MI->getOpcode() == TargetInstrInfo::PHI)
Misha Brukman7d11fbf2004-06-24 21:31:16 +0000487 NumOperandsToProcess = 1;
Chris Lattnercab0b442003-01-13 20:01:16 +0000488
Evan Chenge45b8f82008-04-16 09:46:40 +0000489 SmallVector<unsigned, 4> UseRegs;
490 SmallVector<unsigned, 4> DefRegs;
Chris Lattnercab0b442003-01-13 20:01:16 +0000491 for (unsigned i = 0; i != NumOperandsToProcess; ++i) {
Bill Wendling59cc1592008-02-20 06:10:21 +0000492 const MachineOperand &MO = MI->getOperand(i);
Evan Chengf1e873a2009-01-20 21:25:12 +0000493 if (!MO.isReg() || MO.getReg() == 0)
494 continue;
495 unsigned MOReg = MO.getReg();
496 if (MO.isUse())
497 UseRegs.push_back(MOReg);
498 if (MO.isDef())
499 DefRegs.push_back(MOReg);
Chris Lattnercab0b442003-01-13 20:01:16 +0000500 }
501
Evan Chenge45b8f82008-04-16 09:46:40 +0000502 // Process all uses.
503 for (unsigned i = 0, e = UseRegs.size(); i != e; ++i) {
504 unsigned MOReg = UseRegs[i];
505 if (TargetRegisterInfo::isVirtualRegister(MOReg))
506 HandleVirtRegUse(MOReg, MBB, MI);
Dan Gohmanae9d9f42008-09-21 21:11:41 +0000507 else if (!ReservedRegisters[MOReg])
Evan Chenge45b8f82008-04-16 09:46:40 +0000508 HandlePhysRegUse(MOReg, MI);
509 }
510
Bill Wendlingb9123512008-02-20 09:15:16 +0000511 // Process all defs.
Evan Chenge45b8f82008-04-16 09:46:40 +0000512 for (unsigned i = 0, e = DefRegs.size(); i != e; ++i) {
513 unsigned MOReg = DefRegs[i];
Dan Gohmanae9d9f42008-09-21 21:11:41 +0000514 if (TargetRegisterInfo::isVirtualRegister(MOReg))
515 HandleVirtRegDef(MOReg, MI);
Evan Chenga21aac32009-09-24 02:15:22 +0000516 else if (!ReservedRegisters[MOReg])
517 HandlePhysRegDef(MOReg, MI, Defs);
Chris Lattnercab0b442003-01-13 20:01:16 +0000518 }
Evan Cheng262f86e2009-09-23 06:28:31 +0000519 UpdatePhysRegDefs(MI, Defs);
Chris Lattnercab0b442003-01-13 20:01:16 +0000520 }
521
522 // Handle any virtual assignments from PHI nodes which might be at the
523 // bottom of this basic block. We check all of our successor blocks to see
524 // if they have PHI nodes, and if so, we simulate an assignment at the end
525 // of the current block.
Evan Cheng0fbe14a2007-04-25 19:34:00 +0000526 if (!PHIVarInfo[MBB->getNumber()].empty()) {
527 SmallVector<unsigned, 4>& VarInfoVec = PHIVarInfo[MBB->getNumber()];
Misha Brukman835702a2005-04-21 22:36:52 +0000528
Evan Cheng0fbe14a2007-04-25 19:34:00 +0000529 for (SmallVector<unsigned, 4>::iterator I = VarInfoVec.begin(),
Bill Wendling406fdbd2008-02-20 07:36:31 +0000530 E = VarInfoVec.end(); I != E; ++I)
531 // Mark it alive only in the block we are representing.
Evan Chengd8616062008-04-02 18:04:08 +0000532 MarkVirtRegAliveInBlock(getVarInfo(*I),MRI->getVRegDef(*I)->getParent(),
Owen Anderson897aed92008-01-15 22:58:11 +0000533 MBB);
Chris Lattnercab0b442003-01-13 20:01:16 +0000534 }
Misha Brukman835702a2005-04-21 22:36:52 +0000535
Bill Wendlingb9123512008-02-20 09:15:16 +0000536 // Finally, if the last instruction in the block is a return, make sure to
537 // mark it as using all of the live-out values in the function.
Chris Lattner03ad8852008-01-07 07:27:27 +0000538 if (!MBB->empty() && MBB->back().getDesc().isReturn()) {
Chris Lattner4c6ab012005-04-09 15:23:25 +0000539 MachineInstr *Ret = &MBB->back();
Bill Wendling406fdbd2008-02-20 07:36:31 +0000540
Chris Lattnera10fff52007-12-31 04:13:23 +0000541 for (MachineRegisterInfo::liveout_iterator
542 I = MF->getRegInfo().liveout_begin(),
543 E = MF->getRegInfo().liveout_end(); I != E; ++I) {
Dan Gohman3a4be0f2008-02-10 18:45:23 +0000544 assert(TargetRegisterInfo::isPhysicalRegister(*I) &&
Dan Gohman39b07db2008-06-25 22:14:43 +0000545 "Cannot have a live-out virtual register!");
Chris Lattner4c6ab012005-04-09 15:23:25 +0000546 HandlePhysRegUse(*I, Ret);
Bill Wendling406fdbd2008-02-20 07:36:31 +0000547
Evan Cheng70ec5282006-11-15 20:51:59 +0000548 // Add live-out registers as implicit uses.
Evan Cheng63254462008-03-05 00:59:57 +0000549 if (!Ret->readsRegister(*I))
Chris Lattnere35dfb82007-12-30 00:41:17 +0000550 Ret->addOperand(MachineOperand::CreateReg(*I, false, true));
Chris Lattner4c6ab012005-04-09 15:23:25 +0000551 }
552 }
553
Evan Chenge45b8f82008-04-16 09:46:40 +0000554 // Loop over PhysRegDef / PhysRegUse, killing any registers that are
555 // available at the end of the basic block.
Evan Cheng0fbe14a2007-04-25 19:34:00 +0000556 for (unsigned i = 0; i != NumRegs; ++i)
Evan Chenga21aac32009-09-24 02:15:22 +0000557 if (PhysRegDef[i] || PhysRegUse[i])
558 HandlePhysRegDef(i, 0, Defs);
Evan Cheng7818c032007-04-25 07:30:23 +0000559
Evan Chenge45b8f82008-04-16 09:46:40 +0000560 std::fill(PhysRegDef, PhysRegDef + NumRegs, (MachineInstr*)0);
561 std::fill(PhysRegUse, PhysRegUse + NumRegs, (MachineInstr*)0);
Chris Lattnercab0b442003-01-13 20:01:16 +0000562 }
563
Evan Cheng70ec5282006-11-15 20:51:59 +0000564 // Convert and transfer the dead / killed information we have gathered into
565 // VirtRegInfo onto MI's.
Evan Cheng91b07902007-03-09 06:02:17 +0000566 for (unsigned i = 0, e1 = VirtRegInfo.size(); i != e1; ++i)
Bill Wendling406fdbd2008-02-20 07:36:31 +0000567 for (unsigned j = 0, e2 = VirtRegInfo[i].Kills.size(); j != e2; ++j)
568 if (VirtRegInfo[i].Kills[j] ==
Evan Chengd8616062008-04-02 18:04:08 +0000569 MRI->getVRegDef(i + TargetRegisterInfo::FirstVirtualRegister))
Bill Wendling406fdbd2008-02-20 07:36:31 +0000570 VirtRegInfo[i]
571 .Kills[j]->addRegisterDead(i +
572 TargetRegisterInfo::FirstVirtualRegister,
Evan Cheng63254462008-03-05 00:59:57 +0000573 TRI);
Chris Lattnercab0b442003-01-13 20:01:16 +0000574 else
Bill Wendling406fdbd2008-02-20 07:36:31 +0000575 VirtRegInfo[i]
576 .Kills[j]->addRegisterKilled(i +
577 TargetRegisterInfo::FirstVirtualRegister,
Evan Cheng63254462008-03-05 00:59:57 +0000578 TRI);
Chris Lattner7c77fd52004-07-01 04:24:29 +0000579
Chris Lattnerd47909e2004-07-09 16:44:37 +0000580 // Check to make sure there are no unreachable blocks in the MC CFG for the
581 // function. If so, it is due to a bug in the instruction selector or some
582 // other part of the code generator if this happens.
583#ifndef NDEBUG
Evan Chengf6f04332007-03-17 09:29:54 +0000584 for(MachineFunction::iterator i = MF->begin(), e = MF->end(); i != e; ++i)
Chris Lattnerd47909e2004-07-09 16:44:37 +0000585 assert(Visited.count(&*i) != 0 && "unreachable basic block found");
586#endif
587
Evan Chenge45b8f82008-04-16 09:46:40 +0000588 delete[] PhysRegDef;
589 delete[] PhysRegUse;
Evan Cheng0fbe14a2007-04-25 19:34:00 +0000590 delete[] PHIVarInfo;
591
Chris Lattnercab0b442003-01-13 20:01:16 +0000592 return false;
593}
Chris Lattnerafa9d7e2004-02-19 18:28:02 +0000594
Evan Cheng7a265d82008-07-03 00:07:19 +0000595/// replaceKillInstruction - Update register kill info by replacing a kill
596/// instruction with a new one.
597void LiveVariables::replaceKillInstruction(unsigned Reg, MachineInstr *OldMI,
598 MachineInstr *NewMI) {
599 VarInfo &VI = getVarInfo(Reg);
Evan Cheng9f8b66f2008-07-03 00:28:27 +0000600 std::replace(VI.Kills.begin(), VI.Kills.end(), OldMI, NewMI);
Evan Cheng7a265d82008-07-03 00:07:19 +0000601}
602
Chris Lattnerf8f724a2006-09-03 00:05:09 +0000603/// removeVirtualRegistersKilled - Remove all killed info for the specified
604/// instruction.
605void LiveVariables::removeVirtualRegistersKilled(MachineInstr *MI) {
Evan Cheng70ec5282006-11-15 20:51:59 +0000606 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
607 MachineOperand &MO = MI->getOperand(i);
Dan Gohman0d1e9a82008-10-03 15:45:36 +0000608 if (MO.isReg() && MO.isKill()) {
Chris Lattner60055892007-12-30 21:56:09 +0000609 MO.setIsKill(false);
Evan Cheng70ec5282006-11-15 20:51:59 +0000610 unsigned Reg = MO.getReg();
Dan Gohman3a4be0f2008-02-10 18:45:23 +0000611 if (TargetRegisterInfo::isVirtualRegister(Reg)) {
Evan Cheng70ec5282006-11-15 20:51:59 +0000612 bool removed = getVarInfo(Reg).removeKill(MI);
613 assert(removed && "kill not in register's VarInfo?");
Devang Patelcb181bb2008-11-21 20:00:59 +0000614 removed = true;
Evan Cheng70ec5282006-11-15 20:51:59 +0000615 }
Chris Lattnerf8f724a2006-09-03 00:05:09 +0000616 }
617 }
Chris Lattnerf8f724a2006-09-03 00:05:09 +0000618}
619
Bill Wendling984f0ce2006-10-03 07:20:20 +0000620/// analyzePHINodes - Gather information about the PHI nodes in here. In
Bill Wendlingb9123512008-02-20 09:15:16 +0000621/// particular, we want to map the variable information of a virtual register
622/// which is used in a PHI node. We map that to the BB the vreg is coming from.
Bill Wendling984f0ce2006-10-03 07:20:20 +0000623///
624void LiveVariables::analyzePHINodes(const MachineFunction& Fn) {
625 for (MachineFunction::const_iterator I = Fn.begin(), E = Fn.end();
626 I != E; ++I)
627 for (MachineBasicBlock::const_iterator BBI = I->begin(), BBE = I->end();
628 BBI != BBE && BBI->getOpcode() == TargetInstrInfo::PHI; ++BBI)
629 for (unsigned i = 1, e = BBI->getNumOperands(); i != e; i += 2)
Bill Wendling59cc1592008-02-20 06:10:21 +0000630 PHIVarInfo[BBI->getOperand(i + 1).getMBB()->getNumber()]
631 .push_back(BBI->getOperand(i).getReg());
Bill Wendling984f0ce2006-10-03 07:20:20 +0000632}