1 //===-- RegisterScavenging.h - Machine register scavenging ------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the Evan Cheng and is distributed under the
6 // University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares the machine register scavenger class. It can provide
11 // information such as unused register at any point in a machine basic block.
12 // It also provides a mechanism to make registers availbale by evicting them
15 //===----------------------------------------------------------------------===//
17 #ifndef LLVM_CODEGEN_REGISTER_SCAVENGING_H
18 #define LLVM_CODEGEN_REGISTER_SCAVENGING_H
20 #include "llvm/CodeGen/MachineBasicBlock.h"
21 #include "llvm/ADT/BitVector.h"
26 class TargetInstrInfo;
27 class TargetRegisterClass;
30 MachineBasicBlock *MBB;
31 MachineBasicBlock::iterator MBBI;
34 /// Tracking - True if RegScavenger is currently tracking the liveness of
38 /// ScavengingFrameIndex - Special spill slot used for scavenging a register
39 /// post register allocation.
40 int ScavengingFrameIndex;
42 /// ScavengedReg - If none zero, the specific register is currently being
43 /// scavenged. That is, it is spilled to the special scavenging stack slot.
44 unsigned ScavengedReg;
46 /// ScavengedRC - Register class of the scavenged register.
48 const TargetRegisterClass *ScavengedRC;
50 /// RegsAvailable - The current state of all the physical registers immediately
51 /// before MBBI. One bit per physical register. If bit is set that means it's
52 /// available, unset means the register is currently being used.
53 BitVector RegsAvailable;
57 : MBB(NULL), NumPhysRegs(0), Tracking(false),
58 ScavengingFrameIndex(-1), ScavengedReg(0), ScavengedRC(NULL) {};
60 RegScavenger(MachineBasicBlock *mbb)
61 : MBB(mbb), NumPhysRegs(0), Tracking(false),
62 ScavengingFrameIndex(-1), ScavengedReg(0), ScavengedRC(NULL) {};
64 /// enterBasicBlock - Start tracking liveness from the begin of the specific
66 void enterBasicBlock(MachineBasicBlock *mbb);
68 /// forward / backward - Move the internal MBB iterator and update register
73 /// forward / backward - Move the internal MBB iterator and update register
74 /// states until it has processed the specific iterator.
75 void forward(MachineBasicBlock::iterator I) {
76 while (MBBI != I) forward();
78 void backward(MachineBasicBlock::iterator I) {
79 while (MBBI != I) backward();
82 /// skipTo - Move the internal MBB iterator but do not update register states.
84 void skipTo(MachineBasicBlock::iterator I) { MBBI = I; }
86 /// isReserved - Returns true if a register is reserved. It is never "unused".
87 bool isReserved(unsigned Reg) const { return ReservedRegs[Reg]; }
89 /// isUsed / isUsed - Test if a register is currently being used.
91 bool isUsed(unsigned Reg) const { return !RegsAvailable[Reg]; }
92 bool isUnused(unsigned Reg) const { return RegsAvailable[Reg]; }
94 /// getRegsUsed - return all registers currently in use in used.
95 void getRegsUsed(BitVector &used, bool includeReserved);
97 /// setUsed / setUnused - Mark the state of one or a number of registers.
99 void setUsed(unsigned Reg) { RegsAvailable.reset(Reg); }
100 void setUsed(BitVector Regs) { RegsAvailable &= ~Regs; }
101 void setUnused(unsigned Reg) { RegsAvailable.set(Reg); }
102 void setUnused(BitVector Regs) { RegsAvailable |= Regs; }
104 /// FindUnusedReg - Find a unused register of the specified register class
105 /// from the specified set of registers. It return 0 is none is found.
106 unsigned FindUnusedReg(const TargetRegisterClass *RegClass,
107 const BitVector &Candidates) const;
109 /// FindUnusedReg - Find a unused register of the specified register class.
110 /// Exclude callee saved registers if directed. It return 0 is none is found.
111 unsigned FindUnusedReg(const TargetRegisterClass *RegClass,
112 bool ExCalleeSaved = false) const;
114 /// setScavengingFrameIndex / getScavengingFrameIndex - accessor and setter of
115 /// ScavengingFrameIndex.
116 void setScavengingFrameIndex(int FI) { ScavengingFrameIndex = FI; }
117 int getScavengingFrameIndex() const { return ScavengingFrameIndex; }
119 /// scavengeRegister - Make a register of the specific register class
120 /// available and do the appropriate bookkeeping. SPAdj is the stack
121 /// adjustment due to call frame, it's passed along to eliminateFrameIndex().
122 /// Returns the scavenged register.
123 unsigned scavengeRegister(const TargetRegisterClass *RegClass,
124 MachineBasicBlock::iterator I, int SPAdj);
125 unsigned scavengeRegister(const TargetRegisterClass *RegClass, int SPAdj) {
126 return scavengeRegister(RegClass, MBBI, SPAdj);
130 const MRegisterInfo *RegInfo;
131 const TargetInstrInfo *TII;
133 /// CalleeSavedrRegs - A bitvector of callee saved registers for the target.
135 BitVector CalleeSavedRegs;
137 /// ReservedRegs - A bitvector of reserved registers.
139 BitVector ReservedRegs;
141 /// restoreScavengedReg - Restore scavenged by loading it back from the
142 /// emergency spill slot. Mark it used.
143 void restoreScavengedReg();
146 } // End llvm namespace