1 //===-- llvm/CodeGen/MachineRegisterInfo.h ----------------------*- C++ -*-===//
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 file defines the MachineRegisterInfo class.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CODEGEN_MACHINEREGISTERINFO_H
15 #define LLVM_CODEGEN_MACHINEREGISTERINFO_H
17 #include "llvm/Target/TargetRegisterInfo.h"
18 #include "llvm/ADT/BitVector.h"
19 #include "llvm/ADT/iterator.h"
24 /// MachineRegisterInfo - Keep track of information for virtual and physical
25 /// registers, including vreg register classes, use/def chains for registers,
27 class MachineRegisterInfo {
28 /// VRegInfo - Information we keep for each virtual register. The entries in
29 /// this vector are actually converted to vreg numbers by adding the
30 /// TargetRegisterInfo::FirstVirtualRegister delta to their index.
32 /// Each element in this list contains the register class of the vreg and the
33 /// start of the use/def list for the register.
34 std::vector<std::pair<const TargetRegisterClass*, MachineOperand*> > VRegInfo;
36 /// PhysRegUseDefLists - This is an array of the head of the use/def list for
37 /// physical registers.
38 MachineOperand **PhysRegUseDefLists;
40 /// UsedPhysRegs - This is a bit vector that is computed and set by the
41 /// register allocator, and must be kept up to date by passes that run after
42 /// register allocation (though most don't modify this). This is used
43 /// so that the code generator knows which callee save registers to save and
44 /// for other target specific uses.
45 BitVector UsedPhysRegs;
47 /// LiveIns/LiveOuts - Keep track of the physical registers that are
48 /// livein/liveout of the function. Live in values are typically arguments in
49 /// registers, live out values are typically return values in registers.
50 /// LiveIn values are allowed to have virtual registers associated with them,
51 /// stored in the second element.
52 std::vector<std::pair<unsigned, unsigned> > LiveIns;
53 std::vector<unsigned> LiveOuts;
55 MachineRegisterInfo(const MachineRegisterInfo&); // DO NOT IMPLEMENT
56 void operator=(const MachineRegisterInfo&); // DO NOT IMPLEMENT
58 explicit MachineRegisterInfo(const TargetRegisterInfo &TRI);
59 ~MachineRegisterInfo();
61 //===--------------------------------------------------------------------===//
63 //===--------------------------------------------------------------------===//
65 /// reg_begin/reg_end - Provide iteration support to walk over all definitions
66 /// and uses of a register within the MachineFunction that corresponds to this
67 /// MachineRegisterInfo object.
68 template<bool Uses, bool Defs>
69 class defusechain_iterator;
71 /// reg_iterator/reg_begin/reg_end - Walk all defs and uses of the specified
73 typedef defusechain_iterator<true,true> reg_iterator;
74 reg_iterator reg_begin(unsigned RegNo) const {
75 return reg_iterator(getRegUseDefListHead(RegNo));
77 static reg_iterator reg_end() { return reg_iterator(0); }
79 /// def_iterator/def_begin/def_end - Walk all defs of the specified register.
80 typedef defusechain_iterator<false,true> def_iterator;
81 def_iterator def_begin(unsigned RegNo) const {
82 return def_iterator(getRegUseDefListHead(RegNo));
84 static def_iterator def_end() { return def_iterator(0); }
86 /// use_iterator/use_begin/use_end - Walk all uses of the specified register.
87 typedef defusechain_iterator<true,false> use_iterator;
88 use_iterator use_begin(unsigned RegNo) const {
89 return use_iterator(getRegUseDefListHead(RegNo));
91 static use_iterator use_end() { return use_iterator(0); }
93 /// use_empty - Return true if there are no instructions using the specified
95 bool use_empty(unsigned RegNo) const { return use_begin(RegNo) == use_end(); }
98 /// replaceRegWith - Replace all instances of FromReg with ToReg in the
99 /// machine function. This is like llvm-level X->replaceAllUsesWith(Y),
100 /// except that it also changes any definitions of the register as well.
101 void replaceRegWith(unsigned FromReg, unsigned ToReg);
103 /// getRegUseDefListHead - Return the head pointer for the register use/def
104 /// list for the specified virtual or physical register.
105 MachineOperand *&getRegUseDefListHead(unsigned RegNo) {
106 if (RegNo < TargetRegisterInfo::FirstVirtualRegister)
107 return PhysRegUseDefLists[RegNo];
108 RegNo -= TargetRegisterInfo::FirstVirtualRegister;
109 return VRegInfo[RegNo].second;
112 MachineOperand *getRegUseDefListHead(unsigned RegNo) const {
113 if (RegNo < TargetRegisterInfo::FirstVirtualRegister)
114 return PhysRegUseDefLists[RegNo];
115 RegNo -= TargetRegisterInfo::FirstVirtualRegister;
116 return VRegInfo[RegNo].second;
119 /// getVRegDef - Return the machine instr that defines the specified virtual
120 /// register or null if none is found. This assumes that the code is in SSA
121 /// form, so there should only be one definition.
122 MachineInstr *getVRegDef(unsigned Reg) const;
125 void dumpUses(unsigned RegNo) const;
128 //===--------------------------------------------------------------------===//
129 // Virtual Register Info
130 //===--------------------------------------------------------------------===//
132 /// getRegClass - Return the register class of the specified virtual register.
133 const TargetRegisterClass *getRegClass(unsigned Reg) const {
134 Reg -= TargetRegisterInfo::FirstVirtualRegister;
135 assert(Reg < VRegInfo.size() && "Invalid vreg!");
136 return VRegInfo[Reg].first;
139 /// setRegClass - Set the register class of the specified virtual register.
140 void setRegClass(unsigned Reg, const TargetRegisterClass *RC) {
141 Reg -= TargetRegisterInfo::FirstVirtualRegister;
142 assert(Reg < VRegInfo.size() && "Invalid vreg!");
143 VRegInfo[Reg].first = RC;
146 /// createVirtualRegister - Create and return a new virtual register in the
147 /// function with the specified register class.
149 unsigned createVirtualRegister(const TargetRegisterClass *RegClass) {
150 assert(RegClass && "Cannot create register without RegClass!");
151 // Add a reg, but keep track of whether the vector reallocated or not.
152 void *ArrayBase = VRegInfo.empty() ? 0 : &VRegInfo[0];
153 VRegInfo.push_back(std::make_pair(RegClass, (MachineOperand*)0));
155 if (&VRegInfo[0] == ArrayBase || VRegInfo.size() == 1)
156 return getLastVirtReg();
158 // Otherwise, the vector reallocated, handle this now.
159 HandleVRegListReallocation();
160 return getLastVirtReg();
163 /// getLastVirtReg - Return the highest currently assigned virtual register.
165 unsigned getLastVirtReg() const {
166 return (unsigned)VRegInfo.size()+TargetRegisterInfo::FirstVirtualRegister-1;
170 //===--------------------------------------------------------------------===//
171 // Physical Register Use Info
172 //===--------------------------------------------------------------------===//
174 /// isPhysRegUsed - Return true if the specified register is used in this
175 /// function. This only works after register allocation.
176 bool isPhysRegUsed(unsigned Reg) const { return UsedPhysRegs[Reg]; }
178 /// setPhysRegUsed - Mark the specified register used in this function.
179 /// This should only be called during and after register allocation.
180 void setPhysRegUsed(unsigned Reg) { UsedPhysRegs[Reg] = true; }
182 /// setPhysRegUnused - Mark the specified register unused in this function.
183 /// This should only be called during and after register allocation.
184 void setPhysRegUnused(unsigned Reg) { UsedPhysRegs[Reg] = false; }
187 //===--------------------------------------------------------------------===//
188 // LiveIn/LiveOut Management
189 //===--------------------------------------------------------------------===//
191 /// addLiveIn/Out - Add the specified register as a live in/out. Note that it
192 /// is an error to add the same register to the same set more than once.
193 void addLiveIn(unsigned Reg, unsigned vreg = 0) {
194 LiveIns.push_back(std::make_pair(Reg, vreg));
196 void addLiveOut(unsigned Reg) { LiveOuts.push_back(Reg); }
198 // Iteration support for live in/out sets. These sets are kept in sorted
199 // order by their register number.
200 typedef std::vector<std::pair<unsigned,unsigned> >::const_iterator
202 typedef std::vector<unsigned>::const_iterator liveout_iterator;
203 livein_iterator livein_begin() const { return LiveIns.begin(); }
204 livein_iterator livein_end() const { return LiveIns.end(); }
205 bool livein_empty() const { return LiveIns.empty(); }
206 liveout_iterator liveout_begin() const { return LiveOuts.begin(); }
207 liveout_iterator liveout_end() const { return LiveOuts.end(); }
208 bool liveout_empty() const { return LiveOuts.empty(); }
210 void HandleVRegListReallocation();
213 /// defusechain_iterator - This class provides iterator support for machine
214 /// operands in the function that use or define a specific register. If
215 /// ReturnUses is true it returns uses of registers, if ReturnDefs is true it
216 /// returns defs. If neither are true then you are silly and it always
218 template<bool ReturnUses, bool ReturnDefs>
219 class defusechain_iterator
220 : public forward_iterator<MachineInstr, ptrdiff_t> {
222 explicit defusechain_iterator(MachineOperand *op) : Op(op) {
223 // If the first node isn't one we're interested in, advance to one that
224 // we are interested in.
226 if ((!ReturnUses && op->isUse()) ||
227 (!ReturnDefs && op->isDef()))
231 friend class MachineRegisterInfo;
233 typedef forward_iterator<MachineInstr, ptrdiff_t>::reference reference;
234 typedef forward_iterator<MachineInstr, ptrdiff_t>::pointer pointer;
236 defusechain_iterator(const defusechain_iterator &I) : Op(I.Op) {}
237 defusechain_iterator() : Op(0) {}
239 bool operator==(const defusechain_iterator &x) const {
242 bool operator!=(const defusechain_iterator &x) const {
243 return !operator==(x);
246 /// atEnd - return true if this iterator is equal to reg_end() on the value.
247 bool atEnd() const { return Op == 0; }
249 // Iterator traversal: forward iteration only
250 defusechain_iterator &operator++() { // Preincrement
251 assert(Op && "Cannot increment end iterator!");
252 Op = Op->getNextOperandForReg();
254 // If this is an operand we don't care about, skip it.
255 while (Op && ((!ReturnUses && Op->isUse()) ||
256 (!ReturnDefs && Op->isDef())))
257 Op = Op->getNextOperandForReg();
261 defusechain_iterator operator++(int) { // Postincrement
262 defusechain_iterator tmp = *this; ++*this; return tmp;
265 MachineOperand &getOperand() const {
266 assert(Op && "Cannot dereference end iterator!");
270 /// getOperandNo - Return the operand # of this MachineOperand in its
272 unsigned getOperandNo() const {
273 assert(Op && "Cannot dereference end iterator!");
274 return Op - &Op->getParent()->getOperand(0);
277 // Retrieve a reference to the current operand.
278 MachineInstr &operator*() const {
279 assert(Op && "Cannot dereference end iterator!");
280 return *Op->getParent();
283 MachineInstr *operator->() const {
284 assert(Op && "Cannot dereference end iterator!");
285 return Op->getParent();
291 } // End llvm namespace