1 //===-- llvm/CodeGen/LiveVariables.h - Live Variable Analysis ---*- C++ -*-===//
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 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
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.
27 //===----------------------------------------------------------------------===//
29 #ifndef LLVM_CODEGEN_LIVEVARIABLES_H
30 #define LLVM_CODEGEN_LIVEVARIABLES_H
32 #include "llvm/CodeGen/MachineFunctionPass.h"
33 #include "llvm/ADT/BitVector.h"
41 class LiveVariables : public MachineFunctionPass {
43 /// VarInfo - This represents the regions where a virtual register is live in
44 /// the program. We represent this with three different pieces of
45 /// information: the instruction that uniquely defines the value, the set of
46 /// blocks the instruction is live into and live out of, and the set of
47 /// non-phi instructions that are the last users of the value.
49 /// In the common case where a value is defined and killed in the same block,
50 /// DefInst is the defining inst, there is one killing instruction, and
51 /// AliveBlocks is empty.
53 /// Otherwise, the value is live out of the block. If the value is live
54 /// across any blocks, these blocks are listed in AliveBlocks. Blocks where
55 /// the liveness range ends are not included in AliveBlocks, instead being
56 /// captured by the Kills set. In these blocks, the value is live into the
57 /// block (unless the value is defined and killed in the same block) and lives
58 /// until the specified instruction. Note that there cannot ever be a value
59 /// whose Kills set contains two instructions from the same basic block.
61 /// PHI nodes complicate things a bit. If a PHI node is the last user of a
62 /// value in one of its predecessor blocks, it is not listed in the kills set,
63 /// but does include the predecessor block in the AliveBlocks set (unless that
64 /// block also defines the value). This leads to the (perfectly sensical)
65 /// situation where a value is defined in a block, and the last use is a phi
66 /// node in the successor. In this case, DefInst will be the defining
67 /// instruction, AliveBlocks is empty (the value is not live across any
68 /// blocks) and Kills is empty (phi nodes are not included). This is sensical
69 /// because the value must be live to the end of the block, but is not live in
70 /// any successor blocks.
72 /// DefInst - The machine instruction that defines this register.
74 MachineInstr *DefInst;
76 /// AliveBlocks - Set of blocks of which this value is alive completely
77 /// through. This is a bit set which uses the basic block number as an
80 BitVector AliveBlocks;
82 /// UsedBlocks - Set of blocks of which this value is actually used. This
83 /// is a bit set which uses the basic block number as an index.
86 /// Kills - List of MachineInstruction's which are the last use of this
87 /// virtual register (kill it) in their basic block.
89 std::vector<MachineInstr*> Kills;
91 VarInfo() : DefInst(0) {}
93 /// removeKill - Delete a kill corresponding to the specified
94 /// machine instruction. Returns true if there was a kill
95 /// corresponding to this instruction, false otherwise.
96 bool removeKill(MachineInstr *MI) {
97 for (std::vector<MachineInstr*>::iterator i = Kills.begin(),
98 e = Kills.end(); i != e; ++i)
110 /// VirtRegInfo - This list is a mapping from virtual register number to
111 /// variable information. FirstVirtualRegister is subtracted from the virtual
112 /// register number before indexing into this list.
114 std::vector<VarInfo> VirtRegInfo;
116 /// ReservedRegisters - This vector keeps track of which registers
117 /// are reserved register which are not allocatable by the target machine.
118 /// We can not track liveness for values that are in this set.
120 BitVector ReservedRegisters;
122 private: // Intermediate data structures
125 const MRegisterInfo *RegInfo;
127 MachineInstr **PhysRegInfo;
130 typedef std::map<const MachineBasicBlock*,
131 std::vector<unsigned> > PHIVarInfoMap;
133 PHIVarInfoMap PHIVarInfo;
136 /// addRegisterKilled - We have determined MI kills a register. Look for the
137 /// operand that uses it and mark it as IsKill.
138 void addRegisterKilled(unsigned IncomingReg, MachineInstr *MI);
140 /// addRegisterDead - We have determined MI defined a register without a use.
141 /// Look for the operand that defines it and mark it as IsDead.
142 void addRegisterDead(unsigned IncomingReg, MachineInstr *MI);
144 void HandlePhysRegUse(unsigned Reg, MachineInstr *MI);
145 void HandlePhysRegDef(unsigned Reg, MachineInstr *MI);
147 /// analyzePHINodes - Gather information about the PHI nodes in here. In
148 /// particular, we want to map the variable information of a virtual
149 /// register which is used in a PHI node. We map that to the BB the vreg
151 void analyzePHINodes(const MachineFunction& Fn);
154 virtual bool runOnMachineFunction(MachineFunction &MF);
156 /// KillsRegister - Return true if the specified instruction kills the
157 /// specified register.
158 bool KillsRegister(MachineInstr *MI, unsigned Reg) const;
160 /// RegisterDefIsDead - Return true if the specified instruction defines the
161 /// specified register, but that definition is dead.
162 bool RegisterDefIsDead(MachineInstr *MI, unsigned Reg) const;
164 /// ModifiesRegister - Return true if the specified instruction modifies the
165 /// specified register.
166 bool ModifiesRegister(MachineInstr *MI, unsigned Reg) const;
168 //===--------------------------------------------------------------------===//
169 // API to update live variable information
171 /// instructionChanged - When the address of an instruction changes, this
172 /// method should be called so that live variables can update its internal
173 /// data structures. This removes the records for OldMI, transfering them to
174 /// the records for NewMI.
175 void instructionChanged(MachineInstr *OldMI, MachineInstr *NewMI);
177 /// addVirtualRegisterKilled - Add information about the fact that the
178 /// specified register is killed after being used by the specified
181 void addVirtualRegisterKilled(unsigned IncomingReg, MachineInstr *MI) {
182 addRegisterKilled(IncomingReg, MI);
183 getVarInfo(IncomingReg).Kills.push_back(MI);
186 /// removeVirtualRegisterKilled - Remove the specified virtual
187 /// register from the live variable information. Returns true if the
188 /// variable was marked as killed by the specified instruction,
190 bool removeVirtualRegisterKilled(unsigned reg,
191 MachineBasicBlock *MBB,
193 if (!getVarInfo(reg).removeKill(MI))
196 bool Removed = false;
197 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
198 MachineOperand &MO = MI->getOperand(i);
199 if (MO.isReg() && MO.isUse() && MO.getReg() == reg) {
206 assert(Removed && "Register is not used by this instruction!");
210 /// removeVirtualRegistersKilled - Remove all killed info for the specified
212 void removeVirtualRegistersKilled(MachineInstr *MI);
214 /// addVirtualRegisterDead - Add information about the fact that the specified
215 /// register is dead after being used by the specified instruction.
217 void addVirtualRegisterDead(unsigned IncomingReg, MachineInstr *MI) {
218 addRegisterDead(IncomingReg, MI);
219 getVarInfo(IncomingReg).Kills.push_back(MI);
222 /// removeVirtualRegisterDead - Remove the specified virtual
223 /// register from the live variable information. Returns true if the
224 /// variable was marked dead at the specified instruction, false
226 bool removeVirtualRegisterDead(unsigned reg,
227 MachineBasicBlock *MBB,
229 if (!getVarInfo(reg).removeKill(MI))
232 bool Removed = false;
233 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
234 MachineOperand &MO = MI->getOperand(i);
235 if (MO.isReg() && MO.isDef() && MO.getReg() == reg) {
241 assert(Removed && "Register is not defined by this instruction!");
245 /// removeVirtualRegistersDead - Remove all of the dead registers for the
246 /// specified instruction from the live variable information.
247 void removeVirtualRegistersDead(MachineInstr *MI);
249 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
250 AU.setPreservesAll();
253 virtual void releaseMemory() {
257 /// getVarInfo - Return the VarInfo structure for the specified VIRTUAL
259 VarInfo &getVarInfo(unsigned RegIdx);
261 void MarkVirtRegAliveInBlock(VarInfo &VRInfo, MachineBasicBlock *BB);
262 void HandleVirtRegUse(VarInfo &VRInfo, MachineBasicBlock *MBB,
266 } // End llvm namespace