Initial check in of register scavenger. Its only current functionality is tracking...
[oota-llvm.git] / include / llvm / CodeGen / RegisterScavenging.h
1 //===-- RegisterScavenging.h - Machine register scavenging ------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
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.
7 //
8 //===----------------------------------------------------------------------===//
9 //
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
13 // to spill slots.
14 //
15 //===----------------------------------------------------------------------===//
16
17 #ifndef LLVM_CODEGEN_REGISTER_SCAVENGING_H
18 #define LLVM_CODEGEN_REGISTER_SCAVENGING_H
19
20 #include "llvm/CodeGen/MachineBasicBlock.h"
21 #include "llvm/ADT/BitVector.h"
22
23 namespace llvm {
24
25 class TargetRegisterClass;
26
27 class RegScavenger {
28   MachineBasicBlock *MBB;
29   MachineBasicBlock::iterator MBBI;
30   unsigned NumPhysRegs;
31
32   /// RegStates - The current state of all the physical registers immediately
33   /// before MBBI. One bit per physical register. If bit is set that means it's
34   /// available, unset means the register is currently being used.
35   BitVector RegStates;
36
37 public:
38   RegScavenger(MachineBasicBlock *mbb);
39
40   /// forward / backward - Move the internal MBB iterator and update register
41   /// states.
42   void forward();
43   void backward();
44
45   /// isReserved - Returns true if a register is reserved. It is never "unused".
46   bool isReserved(unsigned Reg) const { return ReservedRegs[Reg]; }
47
48   /// isUsed / isUsed - Test if a register is currently being used.
49   ///
50   bool isUsed(unsigned Reg) const   { return !RegStates[Reg]; }
51   bool isUnused(unsigned Reg) const { return RegStates[Reg]; }
52
53   /// setUsed / setUnused - Mark the state of one or a number of registers.
54   ///
55   void setUsed(unsigned Reg)     { RegStates.reset(Reg); }
56   void setUsed(BitVector Regs)   { RegStates &= ~Regs; }
57   void setUnused(unsigned Reg)   { RegStates.set(Reg); }
58   void setUnused(BitVector Regs) { RegStates |= Regs; }
59
60   /// FindUnusedReg - Find a unused register of the specified register class.
61   /// Exclude callee saved registers if directed. It return 0 is none is found.
62   unsigned FindUnusedReg(const TargetRegisterClass *RegClass,
63                          bool ExCalleeSaved = false) const;
64
65 private:
66   /// CalleeSavedrRegs - A bitvector of callee saved registers for the target.
67   BitVector CalleeSavedRegs;
68
69   /// ReservedRegs - A bitvector of reserved registers.
70   BitVector ReservedRegs;
71 };
72  
73 } // End llvm namespace
74
75 #endif