AMDGPU: Don't handle invalid reg classes in helper functions
[oota-llvm.git] / lib / Target / AMDGPU / SIRegisterInfo.h
1 //===-- SIRegisterInfo.h - SI Register Info Interface ----------*- 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 /// \file
11 /// \brief Interface definition for SIRegisterInfo
12 //
13 //===----------------------------------------------------------------------===//
14
15
16 #ifndef LLVM_LIB_TARGET_R600_SIREGISTERINFO_H
17 #define LLVM_LIB_TARGET_R600_SIREGISTERINFO_H
18
19 #include "AMDGPURegisterInfo.h"
20 #include "AMDGPUSubtarget.h"
21 #include "llvm/Support/Debug.h"
22
23 namespace llvm {
24
25 struct SIRegisterInfo : public AMDGPURegisterInfo {
26 private:
27   void reserveRegisterTuples(BitVector &, unsigned Reg) const;
28
29 public:
30   SIRegisterInfo();
31
32   BitVector getReservedRegs(const MachineFunction &MF) const override;
33
34   unsigned getRegPressureSetLimit(const MachineFunction &MF,
35                                   unsigned Idx) const override;
36
37   bool requiresRegisterScavenging(const MachineFunction &Fn) const override;
38
39   void eliminateFrameIndex(MachineBasicBlock::iterator MI, int SPAdj,
40                            unsigned FIOperandNum,
41                            RegScavenger *RS) const override;
42
43   unsigned getHWRegIndex(unsigned Reg) const override;
44
45   /// \brief Return the 'base' register class for this register.
46   /// e.g. SGPR0 => SReg_32, VGPR => VGPR_32 SGPR0_SGPR1 -> SReg_32, etc.
47   const TargetRegisterClass *getPhysRegClass(unsigned Reg) const;
48
49   /// \returns true if this class contains only SGPR registers
50   bool isSGPRClass(const TargetRegisterClass *RC) const {
51     return !hasVGPRs(RC);
52   }
53
54   /// \returns true if this class ID contains only SGPR registers
55   bool isSGPRClassID(unsigned RCID) const {
56     return isSGPRClass(getRegClass(RCID));
57   }
58
59   /// \returns true if this class contains VGPR registers.
60   bool hasVGPRs(const TargetRegisterClass *RC) const;
61
62   /// \returns A VGPR reg class with the same width as \p SRC
63   const TargetRegisterClass *getEquivalentVGPRClass(
64                                           const TargetRegisterClass *SRC) const;
65
66   /// \returns The register class that is used for a sub-register of \p RC for
67   /// the given \p SubIdx.  If \p SubIdx equals NoSubRegister, \p RC will
68   /// be returned.
69   const TargetRegisterClass *getSubRegClass(const TargetRegisterClass *RC,
70                                             unsigned SubIdx) const;
71
72   bool shouldRewriteCopySrc(const TargetRegisterClass *DefRC,
73                             unsigned DefSubReg,
74                             const TargetRegisterClass *SrcRC,
75                             unsigned SrcSubReg) const override;
76
77   /// \p Channel This is the register channel (e.g. a value from 0-16), not the
78   ///            SubReg index.
79   /// \returns The sub-register of Reg that is in Channel.
80   unsigned getPhysRegSubReg(unsigned Reg, const TargetRegisterClass *SubRC,
81                             unsigned Channel) const;
82
83   /// \returns True if operands defined with this operand type can accept
84   /// a literal constant (i.e. any 32-bit immediate).
85   bool opCanUseLiteralConstant(unsigned OpType) const;
86
87   /// \returns True if operands defined with this operand type can accept
88   /// an inline constant. i.e. An integer value in the range (-16, 64) or
89   /// -4.0f, -2.0f, -1.0f, -0.5f, 0.0f, 0.5f, 1.0f, 2.0f, 4.0f. 
90   bool opCanUseInlineConstant(unsigned OpType) const;
91
92   enum PreloadedValue {
93     TGID_X,
94     TGID_Y,
95     TGID_Z,
96     SCRATCH_WAVE_OFFSET,
97     SCRATCH_PTR,
98     INPUT_PTR,
99     TIDIG_X,
100     TIDIG_Y,
101     TIDIG_Z
102   };
103
104   /// \brief Returns the physical register that \p Value is stored in.
105   unsigned getPreloadedValue(const MachineFunction &MF,
106                              enum PreloadedValue Value) const;
107
108   /// \brief Give the maximum number of VGPRs that can be used by \p WaveCount
109   ///        concurrent waves.
110   unsigned getNumVGPRsAllowed(unsigned WaveCount) const;
111
112   /// \brief Give the maximum number of SGPRs that can be used by \p WaveCount
113   ///        concurrent waves.
114   unsigned getNumSGPRsAllowed(AMDGPUSubtarget::Generation gen,
115                               unsigned WaveCount) const;
116
117   unsigned findUnusedRegister(const MachineRegisterInfo &MRI,
118                               const TargetRegisterClass *RC) const;
119
120 private:
121   void buildScratchLoadStore(MachineBasicBlock::iterator MI,
122                              unsigned LoadStoreOp, unsigned Value,
123                              unsigned ScratchRsrcReg, unsigned ScratchOffset,
124                              int64_t Offset, RegScavenger *RS) const;
125 };
126
127 } // End namespace llvm
128
129 #endif