Remove some unnecessary forward declarations and put a couple more
[oota-llvm.git] / lib / Target / X86 / X86RegisterInfo.h
1 //===-- X86RegisterInfo.h - X86 Register Information Impl -------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file contains the X86 implementation of the TargetRegisterInfo class.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #ifndef LLVM_LIB_TARGET_X86_X86REGISTERINFO_H
15 #define LLVM_LIB_TARGET_X86_X86REGISTERINFO_H
16
17 #include "llvm/Target/TargetRegisterInfo.h"
18
19 #define GET_REGINFO_HEADER
20 #include "X86GenRegisterInfo.inc"
21
22 namespace llvm {
23 class X86Subtarget;
24
25 class X86RegisterInfo final : public X86GenRegisterInfo {
26 public:
27   const X86Subtarget &Subtarget;
28
29 private:
30   /// Is64Bit - Is the target 64-bits.
31   ///
32   bool Is64Bit;
33
34   /// IsWin64 - Is the target on of win64 flavours
35   ///
36   bool IsWin64;
37
38   /// SlotSize - Stack slot size in bytes.
39   ///
40   unsigned SlotSize;
41
42   /// StackPtr - X86 physical register used as stack ptr.
43   ///
44   unsigned StackPtr;
45
46   /// FramePtr - X86 physical register used as frame ptr.
47   ///
48   unsigned FramePtr;
49
50   /// BasePtr - X86 physical register used as a base ptr in complex stack
51   /// frames. I.e., when we need a 3rd base, not just SP and FP, due to
52   /// variable size stack objects.
53   unsigned BasePtr;
54
55 public:
56   X86RegisterInfo(const X86Subtarget &STI);
57
58   // FIXME: This should be tablegen'd like getDwarfRegNum is
59   int getSEHRegNum(unsigned i) const;
60
61   /// Code Generation virtual methods...
62   ///
63   bool trackLivenessAfterRegAlloc(const MachineFunction &MF) const override;
64
65   /// getMatchingSuperRegClass - Return a subclass of the specified register
66   /// class A so that each register in it has a sub-register of the
67   /// specified sub-register index which is in the specified register class B.
68   const TargetRegisterClass *
69   getMatchingSuperRegClass(const TargetRegisterClass *A,
70                            const TargetRegisterClass *B,
71                            unsigned Idx) const override;
72
73   const TargetRegisterClass *
74   getSubClassWithSubReg(const TargetRegisterClass *RC,
75                         unsigned Idx) const override;
76
77   const TargetRegisterClass *
78   getLargestLegalSuperClass(const TargetRegisterClass *RC,
79                             const MachineFunction &MF) const override;
80
81   /// getPointerRegClass - Returns a TargetRegisterClass used for pointer
82   /// values.
83   const TargetRegisterClass *
84   getPointerRegClass(const MachineFunction &MF,
85                      unsigned Kind = 0) const override;
86
87   /// getCrossCopyRegClass - Returns a legal register class to copy a register
88   /// in the specified class to or from. Returns NULL if it is possible to copy
89   /// between a two registers of the specified class.
90   const TargetRegisterClass *
91   getCrossCopyRegClass(const TargetRegisterClass *RC) const override;
92
93   unsigned getRegPressureLimit(const TargetRegisterClass *RC,
94                                MachineFunction &MF) const override;
95
96   /// getCalleeSavedRegs - Return a null-terminated list of all of the
97   /// callee-save registers on this target.
98   const MCPhysReg *
99   getCalleeSavedRegs(const MachineFunction* MF) const override;
100   const uint32_t *getCallPreservedMask(const MachineFunction &MF,
101                                        CallingConv::ID) const override;
102   const uint32_t *getNoPreservedMask() const;
103
104   /// getReservedRegs - Returns a bitset indexed by physical register number
105   /// indicating if a register is a special register that has particular uses and
106   /// should be considered unavailable at all times, e.g. SP, RA. This is used by
107   /// register scavenger to determine what registers are free.
108   BitVector getReservedRegs(const MachineFunction &MF) const override;
109
110   bool hasBasePointer(const MachineFunction &MF) const;
111
112   bool canRealignStack(const MachineFunction &MF) const;
113
114   bool needsStackRealignment(const MachineFunction &MF) const override;
115
116   bool hasReservedSpillSlot(const MachineFunction &MF, unsigned Reg,
117                             int &FrameIdx) const override;
118
119   void eliminateFrameIndex(MachineBasicBlock::iterator MI,
120                            int SPAdj, unsigned FIOperandNum,
121                            RegScavenger *RS = nullptr) const override;
122
123   // Debug information queries.
124   unsigned getFrameRegister(const MachineFunction &MF) const override;
125   unsigned getPtrSizedFrameRegister(const MachineFunction &MF) const;
126   unsigned getStackRegister() const { return StackPtr; }
127   unsigned getBaseRegister() const { return BasePtr; }
128   // FIXME: Move to FrameInfok
129   unsigned getSlotSize() const { return SlotSize; }
130 };
131
132 // getX86SubSuperRegister - X86 utility function. It returns the sub or super
133 // register of a specific X86 register.
134 // e.g. getX86SubSuperRegister(X86::EAX, MVT::i16) return X86:AX
135 unsigned getX86SubSuperRegister(unsigned, MVT::SimpleValueType, bool High=false);
136
137 //get512BitRegister - X86 utility - returns 512-bit super register
138 unsigned get512BitSuperRegister(unsigned Reg);
139
140 } // End llvm namespace
141
142 #endif